home · contact · privacy
Refactor all accounting scripts.
[misc] / ledger.py
index 4a6a071833311493636a7f36b870e32d722dd45d..244a68444c6d60901330cd3df6ff637be24553f6 100755 (executable)
--- a/ledger.py
+++ b/ledger.py
@@ -1,16 +1,94 @@
-from http.server import BaseHTTPRequestHandler, HTTPServer
 import os
-import html
 import jinja2
 import decimal
-import datetime
+from datetime import datetime, timedelta
 from urllib.parse import parse_qs, urlparse
-hostName = "localhost"
-serverPort = 8082
+from plomlib import PlomDB, PlomException, run_server, run_server, PlomServer
 
+server_port = 8082
+db_path = '/home/plom/org/ledger2023.dat'
 
-class HandledException(Exception):
-    pass
+html_head = """
+<style>
+body { color: #000000; }
+table { margin-bottom: 2em; }
+th, td { text-align: left }
+input[type=number] { text-align: right; font-family: monospace; }
+.money { font-family: monospace; text-align: right; }
+.comment { font-style: italic; color: #777777; }
+.meta { font-size: 0.75em; color: #777777; }
+.full_line_comment { display: block; white-space: nowrap; width: 0; }
+</style>
+<body>
+<a href="/">ledger</a>
+<a href="/balance">balance</a>
+<a href="/add_free">add free</a>
+<a href="/add_structured">add structured</a>
+<hr />
+"""
+booking_html = """
+<p id="{{nth}}"><a href="#{{nth}}">{{date}}</a> {{desc}} <span class="comment">{{head_comment|e}}</span><br />
+<span class="meta">[edit: <a href="/add_structured?start={{start}}&end={{end}}">structured</a>
+/ <a href="/add_free?start={{start}}&end={{end}}">free</a>
+| copy:<a href="/copy_structured?start={{start}}&end={{end}}">structured</a>
+/ <a href="/copy_free?start={{start}}&end={{end}}">free</a>
+| move {% if move_up %}<a href="/move_up?start={{start}}&end={{end}}">up</a>{% else %}up{% endif %}/{% if move_down %}<a href="/move_down?start={{start}}&end={{end}}">down</a>{% else %}down{% endif %}
+| <a href="/balance?stop={{nth+1}}">balance after</a>
+]</span>
+<table>
+{% for l in booking_lines %}
+{% if l.acc %}
+<tr><td>{{l.acc|e}}</td><td class="money">{{l.money|e}}</td><td class="comment">{{l.comment|e}}</td></tr>
+{% else %}
+<tr><td><div class="comment full_line_comment">{{l.comment|e}}</div></td></tr>
+{% endif %}
+{% endfor %}
+</table></p>
+"""
+add_form_header = """<form method="POST" action="{{action|e}}">
+<input type="submit" name="check" value="check" />
+<input type="submit" name="revert" value="revert" />
+"""
+add_form_footer = """
+<input type="hidden" name="start" value={{start}} />
+<input type="hidden" name="end" value={{end}} />
+<input type="submit" name="save" value="save!">
+</form>
+"""
+add_free_html = """<br />
+<textarea name="booking" rows=10 cols=80>
+{% for line in lines %}{{ line }}
+{% endfor %}
+</textarea>
+"""
+add_structured_html = """
+<input type="submit" name="add_taxes" value="add taxes" />
+<input type="submit" name="add_taxes2" value="add taxes2" />
+<input type="submit" name="add_sink" value="add sink" />
+<br />
+<input name="date" value="{{date|e}}" size=9 />
+<input name="description" value="{{desc|e}}" list="descriptions" />
+<textarea name="line_0_comment" rows=1 cols=20>{{head_comment|e}}</textarea>
+<input type="submit" name="line_0_add" value="[+]" />
+<br />
+{% for line in booking_lines %}
+<input name="line_{{line.i}}_account" value="{{line.acc|e}}" size=40 list="accounts" />
+<input type="number" name="line_{{line.i}}_amount" step=0.01 value="{{line.amt}}" size=10 />
+<input name="line_{{line.i}}_currency" value="{{line.curr|e}}" size=3 list="currencies" />
+<input type="submit" name="line_{{line.i}}_delete" value="[x]" />
+<input type="submit" name="line_{{line.i}}_delete_after" value="[XX]" />
+<input type="submit" name="line_{{line.i}}_add" value="[+]" />
+<textarea name="line_{{line.i}}_comment" rows=1 cols={% if line.comm_cols %}{{line.comm_cols}}{% else %}20{% endif %}>{{line.comment|e}}</textarea>
+<br />
+{% endfor %}
+{% for name, items in datalist_sets.items() %}
+<datalist id="{{name}}">
+{% for item in items %}
+  <option value="{{item|e}}">{{item|e}}</option>
+{% endfor %}
+</datalist>
+{% endfor %}
+"""
 
 
 def apply_booking_to_account_balances(account_sums, account, currency, amount):
@@ -84,7 +162,7 @@ def parse_lines(lines, validate_bookings=True):
             if inside_booking:
                 # assume we finished a booking, finalize, and commit to DB
                 if len(booking_lines) < 2:
-                    raise HandledException(f"{prefix} booking ends to early")
+                    raise PlomException(f"{prefix} booking ends to early")
                 booking = Booking(date_string, description, booking_lines, start_line, validate_bookings)
                 bookings += [booking]
             # expect new booking to follow so re-zeroall booking data
@@ -108,23 +186,23 @@ def parse_lines(lines, validate_bookings=True):
             toks = non_comment.split(maxsplit=1)
             date_string = toks[0]
             try:
-                datetime.datetime.strptime(date_string, '%Y-%m-%d')
+                datetime.strptime(date_string, '%Y-%m-%d')
             except ValueError:
-                raise HandledException(f"{prefix} bad date string: {date_string}")
+                raise PlomException(f"{prefix} bad date string: {date_string}")
             if last_date > date_string:
-                raise HandledException(f"{prefix} out-of-order-date")
+                raise PlomException(f"{prefix} out-of-order-date")
             last_date = date_string
             try:
                 description = toks[1]
             except IndexError:
-                raise HandledException(f"{prefix} bad description: {description}")
+                raise PlomException(f"{prefix} bad description: {description}")
             inside_booking = True
             booking_lines += [non_comment]
             continue
         # otherwise, read as transfer data
         toks = non_comment.split()  # ignore specification's allowance of single spaces in names
         if len(toks) > 3:
-            raise HandledException(f"{prefix} too many booking line tokens: {toks}")
+            raise PlomException(f"{prefix} too many booking line tokens: {toks}")
         amount, currency = None, None
         account_name = toks[0]
         if account_name[0] == '[' and account_name[-1] == ']':
@@ -140,10 +218,10 @@ def parse_lines(lines, validate_bookings=True):
                 try:
                     amount = decimal.Decimal(toks[2])
                 except decimal.InvalidOperation:
-                    raise HandledException(f"{prefix} no decimal number in: {toks[1:]}")
+                    raise PlomException(f"{prefix} no decimal number in: {toks[1:]}")
             currency = toks[i_currency]
             if currency[0] in decimal_chars:
-                raise HandledException(f"{prefix} currency starts with int, dot, or minus: {currency}")
+                raise PlomException(f"{prefix} currency starts with int, dot, or minus: {currency}")
         elif len(toks) == 2:
             value = toks[1]
             inside_amount = False
@@ -167,25 +245,25 @@ def parse_lines(lines, validate_bookings=True):
                 if inside_amount:
                     if c not in decimal_chars:
                         if len(currency) > 0:
-                            raise HandledException(f"{prefix} amount has non-decimal chars: {value}")
+                            raise PlomException(f"{prefix} amount has non-decimal chars: {value}")
                         inside_currency = True
                         inside_amount = False
                         currency += c
                         continue
                     if c == '-' and len(amount_string) > 1:
-                        raise HandledException(f"{prefix} amount has non-start '-': {value}")
+                        raise PlomException(f"{prefix} amount has non-start '-': {value}")
                     if c == '.':
                         if dots_counted > 1:
-                            raise HandledException(f"{prefix} amount has multiple dots: {value}")
+                            raise PlomException(f"{prefix} amount has multiple dots: {value}")
                         dots_counted += 1
                     amount_string += c
             if len(currency) == 0:
-                raise HandledException(f"{prefix} currency missing: {value}")
+                raise PlomException(f"{prefix} currency missing: {value}")
             if len(amount_string) > 0:
                 amount = decimal.Decimal(amount_string)
         booking_lines += [(account_name, amount, currency)]
     if inside_booking:
-        raise HandledException(f"{prefix} last booking unfinished")
+        raise PlomException(f"{prefix} last booking unfinished")
     return bookings, comments
 
 
@@ -211,7 +289,7 @@ class Booking:
             _, amount, currency = line
             if amount is None:
                 if empty_values > 0:
-                    raise HandledException(f"{prefix} relates more than one empty value of same currency {currency}")
+                    raise PlomException(f"{prefix} relates more than one empty value of same currency {currency}")
                 empty_values += 1
                 continue
             if currency not in sums:
@@ -220,14 +298,14 @@ class Booking:
         if empty_values == 0:
             for k, v in sums.items():
                 if v != 0:
-                    raise HandledException(f"{prefix} does not add up to zero / {k} {v}")
+                    raise PlomException(f"{prefix} does not add up to zero / {k} {v}")
         else:
             sinkable = False
             for k, v in sums.items():
                 if v != 0:
                     sinkable = True
             if not sinkable:
-                raise HandledException(f"{prefix} has empty value that cannot be filled")
+                raise PlomException(f"{prefix} has empty value that cannot be filled")
 
     def parse_booking_lines_to_account_changes(self):
         account_changes = {}
@@ -253,83 +331,25 @@ class Booking:
 
 
 
-class Database:
+class LedgerDB(PlomDB):
 
     def __init__(self):
-        db_name = "_ledger"
-        self.db_file = db_name + ".json"
-        self.lock_file = db_name+ ".lock"
         self.bookings = []
         self.comments = []
         self.real_lines = []
-        if os.path.exists(self.db_file):
-            with open(self.db_file, "r") as f:
-                self.real_lines += [l.rstrip() for l in f.readlines()]
+        super().__init__(db_path)
         ret = parse_lines(self.real_lines)
         self.bookings += ret[0]
         self.comments += ret[1]
 
+    def read_db_file(self, f):
+        self.real_lines += [l.rstrip() for l in f.readlines()]
+
     def get_lines(self, start, end):
         return self.real_lines[start:end]
 
     def write_db(self, text, mode='w'):
-        import shutil
-        if os.path.exists(self.lock_file):
-            raise HandledException('Sorry, lock file!')
-        f = open(self.lock_file, 'w+')
-        f.close()
-
-        # always back up most recent to .bak
-        bakpath = f'{self.db_file}.bak'
-        shutil.copy(self.db_file, bakpath)
-
-        # collect modification times of numbered .bak files
-        bak_prefix = f'{bakpath}.'
-        backup_dates = []
-        i = 0
-        bak_as = f'{bak_prefix}{i}'
-        while os.path.exists(bak_as):
-            mod_time = os.path.getmtime(bak_as)
-            backup_dates += [str(datetime.datetime.fromtimestamp(mod_time))]
-            i += 1
-            bak_as = f'{bak_prefix}{i}'
-
-        # collect what numbered .bak files to save:
-        # shrink datetime string right to left character by character,
-        # on each step add the oldest file whose mtime still fits the pattern
-        # (privilege older files to keep existing longer)
-        to_save = []
-        datetime_len = 19
-        now = str(datetime.datetime.now())[:datetime_len]
-        while datetime_len > 2:
-            # assume backup_dates starts with oldest dates
-            for i, date in enumerate(backup_dates):
-                if date[:datetime_len] == now:
-                    if i not in to_save:
-                        to_save += [i] 
-                        break
-            datetime_len -= 1 
-            now = now[:datetime_len]
-
-        # remove redundant backup files 
-        j = 0
-        for i in to_save:
-            if i != j:
-                source = f'{bak_prefix}{i}'
-                target = f'{bak_prefix}{j}'
-                shutil.move(source, target)
-            j += 1
-        for i in range(j, len(backup_dates)):
-            try:
-                os.remove(f'{bak_prefix}{i}')
-            except FileNotFoundError:
-                pass
-
-        # put second backup copy of current state at end of bak list 
-        shutil.copy(self.db_file, f'{bak_prefix}{j}')
-        with open(self.db_file, mode) as f:
-            f.write(text);
-        os.remove(self.lock_file)
+        self.write_text_to_db(text)
 
     def insert_at_date(self, lines, date):
         start_at = len(self.real_lines)
@@ -493,56 +513,10 @@ class Database:
         return ret
 
 
-class MyServer(BaseHTTPRequestHandler):
-    header = """<html>
-<meta charset="UTF-8">
-<style>
-body { color: #000000; }
-table { margin-bottom: 2em; }
-th, td { text-align: left }
-input[type=number] { text-align: right; font-family: monospace; }
-.money { font-family: monospace; text-align: right; }
-.comment { font-style: italic; color: #777777; }
-.meta { font-size: 0.75em; color: #777777; }
-.full_line_comment { display: block; white-space: nowrap; width: 0; }
-</style>
-<body>
-<a href="/">ledger</a>
-<a href="/balance">balance</a>
-<a href="/add_free">add free</a>
-<a href="/add_structured">add structured</a>
-<hr />
-"""
-    booking_tmpl = jinja2.Template("""
-<p id="{{nth}}"><a href="#{{nth}}">{{date}}</a> {{desc}} <span class="comment">{{head_comment|e}}</span><br />
-<span class="meta">[edit: <a href="/add_structured?start={{start}}&end={{end}}">structured</a>
-/ <a href="/add_free?start={{start}}&end={{end}}">free</a>
-| copy:<a href="/copy_structured?start={{start}}&end={{end}}">structured</a>
-/ <a href="/copy_free?start={{start}}&end={{end}}">free</a>
-| move {% if move_up %}<a href="/move_up?start={{start}}&end={{end}}">up</a>{% else %}up{% endif %}/{% if move_down %}<a href="/move_down?start={{start}}&end={{end}}">down</a>{% else %}down{% endif %}
-| <a href="/balance?stop={{nth+1}}">balance after</a>
-]</span>
-<table>
-{% for l in booking_lines %}
-{% if l.acc %}
-<tr><td>{{l.acc|e}}</td><td class="money">{{l.money|e}}</td><td class="comment">{{l.comment|e}}</td></tr>
-{% else %}
-<tr><td><div class="comment full_line_comment">{{l.comment|e}}</div></td></tr>
-{% endif %}
-{% endfor %}
-</table></p>
-""")
-    add_form_header = """<form method="POST" action="{{action|e}}">
-<input type="submit" name="check" value="check" />
-<input type="submit" name="revert" value="revert" />
-"""
-    add_form_footer = """
-<input type="hidden" name="start" value={{start}} />
-<input type="hidden" name="end" value={{end}} />
-<input type="submit" name="save" value="save!">
-</form>
-"""
-    footer = "</body>\n<html>"
+class LedgerServer(PlomServer):
+
+    def pre_init(self):
+        self.html_head += [html_head]
 
     def do_POST(self):
         try:
@@ -551,7 +525,7 @@ input[type=number] { text-align: right; font-family: monospace; }
             postvars = parse_qs(self.rfile.read(length).decode(), keep_blank_values=1)
             start = int(postvars['start'][0])
             end = int(postvars['end'][0])
-            db = Database()
+            db = LedgerDB()
             add_empty_line = None
             lines = []
             # get inputs
@@ -564,35 +538,34 @@ input[type=number] { text-align: right; font-family: monospace; }
                 _, _ = parse_lines(lines)
             # if saving, process where to and where to redirect after
             if 'save' in postvars.keys():
-                last_date = str(datetime.datetime.now())[:10]
+                last_date = str(datetime.now())[:10]
                 if len(db.bookings) > 0:
                     last_date = db.bookings[-1].date_string
                 target_date = last_date[:] 
                 first_line_tokens = lines[0].split() if len(lines) > 0 else ''
                 first_token = first_line_tokens[0] if len(first_line_tokens) > 0 else ''
                 try:
-                    datetime.datetime.strptime(first_token, '%Y-%m-%d')
+                    datetime.strptime(first_token, '%Y-%m-%d')
                     target_date = first_token
                 except ValueError:
                      pass
                 if start == end == 0:
-                        start = db.insert_at_date(lines, target_date)
-                        nth = db.get_nth_for_booking_of_start_line(start) 
+                    start = db.insert_at_date(lines, target_date)
+                    nth = db.get_nth_for_booking_of_start_line(start) 
                 else:
                     new_start = db.update(start, end, lines, target_date)
                     nth = db.get_nth_for_booking_of_start_line(new_start)
                     if new_start > start: 
                         nth -= 1 
-                redir_url = f'/#{nth}'
-                self.send_code_and_headers(302, [('Location', redir_url)])
+                self.redirect( f'/#{nth}')
             # otherwise just re-build editing form
             else:
                 if '/add_structured' == parsed_url.path: 
                     edit_content = self.add_structured(db, start, end, temp_lines=lines, add_empty_line=add_empty_line)
                 else:
                     edit_content = self.add_free(db, start, end)
-                self.send_HTML(self.header + edit_content + self.footer)
-        except HandledException as e:
+                self.send_HTML(edit_content)
+        except PlomException as e:
             self.fail_400(e)
 
     def do_GET(self):
@@ -601,48 +574,32 @@ input[type=number] { text-align: right; font-family: monospace; }
             params = parse_qs(parsed_url.query)
             start = int(params.get('start', ['0'])[0])
             end = int(params.get('end', ['0'])[0])
-            db = Database()
-            page = self.header
+            db = LedgerDB()
             if parsed_url.path == '/balance':
                 stop = params.get('stop', [None])[0]
-                page += self.balance_as_html(db, stop)
+                page = self.balance_as_html(db, stop)
             elif parsed_url.path == '/add_free':
-                page += self.add_free(db, start, end)
+                page = self.add_free(db, start, end)
             elif parsed_url.path == '/add_structured':
-                page += self.add_structured(db, start, end)
+                page = self.add_structured(db, start, end)
             elif parsed_url.path == '/copy_free':
-                page += self.add_free(db, start, end, copy=True)
+                page = self.add_free(db, start, end, copy=True)
             elif parsed_url.path == '/copy_structured':
-                page += self.add_structured(db, start, end, copy=True)
+                page = self.add_structured(db, start, end, copy=True)
             elif parsed_url.path == '/move_up':
                 nth = self.move_up(db, start, end)
-                self.send_code_and_headers(302, [('Location', f'/#{nth}')])
+                self.redirect(f'/#{nth}')
                 return
             elif parsed_url.path == '/move_down':
                 nth = self.move_down(db, start, end)
-                self.send_code_and_headers(302, [('Location', f'/#{nth}')])
+                self.redirect(f'/#{nth}')
                 return
             else:
-                page += self.ledger_as_html(db)
-            page += self.footer
+                page = self.ledger_as_html(db)
             self.send_HTML(page)
-        except HandledException as e:
+        except PlomException as e:
             self.fail_400(e)
 
-    def fail_400(self, e):
-        page = f'{self.header}ERROR: {e}{self.footer}'
-        self.send_HTML(page, 400)
-
-    def send_HTML(self, html, code=200):
-        self.send_code_and_headers(code, [('Content-type', 'text/html')])
-        self.wfile.write(bytes(html, "utf-8"))
-
-    def send_code_and_headers(self, code, headers=[]):
-        self.send_response(code)
-        for fieldname, content in headers:
-            self.send_header(fieldname, content)
-        self.end_headers()
-
     def booking_lines_from_postvars(self, postvars, db):
         add_empty_line = None
         date = postvars['date'][0]
@@ -685,7 +642,7 @@ input[type=number] { text-align: right; font-family: monospace; }
                 for currency in temp_bookings[0].sink:
                     amount = temp_bookings[0].sink[currency]
                     lines += [f'Assets  {amount:.2f} {currency}']
-            except HandledException:
+            except PlomException:
                 pass
         if 'add_taxes' in postvars.keys():
             lines += db.add_taxes(lines, finish=False)
@@ -719,6 +676,7 @@ input[type=number] { text-align: right; font-family: monospace; }
         return f"<pre>{content}</pre>"
 
     def ledger_as_html(self, db):
+        booking_tmpl = jinja2.Template(booking_html)
         single_c_tmpl = jinja2.Template('<span class="comment">{{c|e}}</span><br />')  ##
         elements_to_write = []
         last_i = i = 0  ##
@@ -740,7 +698,7 @@ input[type=number] { text-align: right; font-family: monospace; }
                  if booking_line[1] is not None:
                      money = f'{booking_line[1]} {booking_line[2]}'
                  booking_lines += [{'acc': booking_line[0], 'money':money, 'comment':comment}]  ##
-            elements_to_write += [self.booking_tmpl.render(
+            elements_to_write += [booking_tmpl.render(
                 nth=nth,
                 start=booking.start_line,
                 end=booking_end,
@@ -754,50 +712,18 @@ input[type=number] { text-align: right; font-family: monospace; }
         return '\n'.join(elements_to_write)
 
     def add_free(self, db, start=0, end=0, copy=False):
-        tmpl = jinja2.Template(self.add_form_header + """<br />
-<textarea name="booking" rows=10 cols=80>
-{% for line in lines %}{{ line }}
-{% endfor %}
-</textarea>
-""" + self.add_form_footer)
+        tmpl = jinja2.Template(add_form_header + add_free_html + add_form_footer) 
         lines = db.get_lines(start, end)
         if copy:
             start = end = 0
         return tmpl.render(action='add_free', start=start, end=end, lines=lines)
 
     def add_structured(self, db, start=0, end=0, copy=False, temp_lines=[], add_empty_line=None):
-        tmpl = jinja2.Template(self.add_form_header + """
-<input type="submit" name="add_taxes" value="add taxes" />
-<input type="submit" name="add_taxes2" value="add taxes2" />
-<input type="submit" name="add_sink" value="add sink" />
-<br />
-<input name="date" value="{{date|e}}" size=9 />
-<input name="description" value="{{desc|e}}" list="descriptions" />
-<textarea name="line_0_comment" rows=1 cols=20>{{head_comment|e}}</textarea>
-<input type="submit" name="line_0_add" value="[+]" />
-<br />
-{% for line in booking_lines %}
-<input name="line_{{line.i}}_account" value="{{line.acc|e}}" size=40 list="accounts" />
-<input type="number" name="line_{{line.i}}_amount" step=0.01 value="{{line.amt}}" size=10 />
-<input name="line_{{line.i}}_currency" value="{{line.curr|e}}" size=3 list="currencies" />
-<input type="submit" name="line_{{line.i}}_delete" value="[x]" />
-<input type="submit" name="line_{{line.i}}_delete_after" value="[XX]" />
-<input type="submit" name="line_{{line.i}}_add" value="[+]" />
-<textarea name="line_{{line.i}}_comment" rows=1 cols={% if line.comm_cols %}{{line.comm_cols}}{% else %}20{% endif %}>{{line.comment|e}}</textarea>
-<br />
-{% endfor %}
-{% for name, items in datalist_sets.items() %}
-<datalist id="{{name}}">
-{% for item in items %}
-  <option value="{{item|e}}">{{item|e}}</option>
-{% endfor %}
-</datalist>
-{% endfor %}
-""" + self.add_form_footer)
+        tmpl = jinja2.Template(add_form_header + add_structured_html + add_form_footer) 
         lines = temp_lines if len(''.join(temp_lines)) > 0 else db.get_lines(start, end)
         bookings, comments = parse_lines(lines, validate_bookings=False)
         if len(bookings) > 1:
-            raise HandledException('can only structurally edit single Booking')
+            raise PlomException('can only structurally edit single Booking')
         if add_empty_line is not None:
             comments = comments[:add_empty_line+1] + [''] + comments[add_empty_line+1:]
             booking = bookings[0]
@@ -811,7 +737,7 @@ input[type=number] { text-align: right; font-family: monospace; }
                 for currency in moneys.keys():
                     datalist_sets['currencies'].add(currency)
         content = ''
-        today = str(datetime.datetime.now())[:10]
+        today = str(datetime.now())[:10]
         booking_lines = []
         if copy:
             start = end = 0
@@ -877,11 +803,4 @@ input[type=number] { text-align: right; font-family: monospace; }
 
 
 if __name__ == "__main__":  
-    webServer = HTTPServer((hostName, serverPort), MyServer)
-    print(f"Server started http://{hostName}:{serverPort}")
-    try:
-        webServer.serve_forever()
-    except KeyboardInterrupt:
-        pass
-    webServer.server_close()
-    print("Server stopped.")
+    run_server(server_port, LedgerServer)