Personal finances application for Emacs
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

223 lines
8.1 KiB

;;; elbank-boobank.el --- Elbank functions for importing from Boobank -*- lexical-binding: t; -*-
;; Copyright (C) 2017-2018 Nicolas Petton
;; Author: Nicolas Petton <>
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <>.
;;; Commentary:
;;; Code:
(require 'seq)
(require 'map)
(require 'json)
(require 'cl-lib)
(require 'subr-x)
(require 'elbank-common)
(defgroup elbank-boobank nil
"Elbank boobank settings."
:group 'elbank)
(defcustom elbank-boobank-executable "boobank"
"Boobank executable."
:type '(file))
(defun elbank-boobank-update (&optional callback)
"Update `elbank-data' from boobank and save it on file.
When CALLBACK is non-nil, evaluate it when data is updated."
(lambda ()
(lambda ()
(when callback (funcall callback)))))))
(defun elbank-boobank--update-accounts (callback)
"Update the accounts data from boobank.
Evaluate CALLBACK when data is updated."
(lambda (accounts)
(map-put elbank-data 'accounts accounts)
(funcall callback))))
(defun elbank-boobank--update-transactions (callback)
"Update the transactions data from boobank.
Evaluate CALLBACK when data is updated."
(lambda (transactions)
(map-put elbank-data 'transactions transactions)
(funcall callback))))
(defun elbank-boobank--fetch-accounts (callback)
"Execute CALLBACK with all fetched accounts from boobank."
(let ((command (format "%s -f json ls 2>/dev/null" (elbank-boobank--find-executable))))
(message "Elbank: fetching accounts...")
(elbank-boobank--shell-command command callback)))
(defun elbank-boobank--fetch-transactions (callback &optional accounts acc)
"Fetch all transactions from all ACCOUNTS and evaluate CALLBACK.
If ACCOUNTS is nil, use all accounts from `elbank-data'.
CALLBACK is called with all fetched transactions.
ACC is used in recursive calls to accumulate fetched transactions."
(let* ((since "1970") ; the current strategy is to always fetch all data. If
; needed, this can be optimized later on.
(accounts (or accounts (map-elt elbank-data 'accounts)))
(account (car accounts))
(id (map-elt account 'id))
;; The backend might not support listing transactions for some
;; accounts, ignore errors.
(command (format "%s -f json history %s %s 2> /dev/null"
(message "Elbank: fetching transactions for account %s..." id)
(lambda (data)
(let* ((transactions (seq-map (lambda (datum)
(elbank-boobank--make-transaction datum account))
(all (seq-concatenate 'list acc transactions)))
(if (cdr accounts)
(elbank-boobank--fetch-transactions callback (cdr accounts) all)
(funcall callback all)))))))
(defun elbank-boobank--make-transaction (data account)
"Return a transaction alist from DATA with its account set to ACCOUNT."
(unless (seq-contains (map-elt elbank-data 'accounts)
(error "Account %s not in the Elbank database" account))
(let ((transaction (map-copy data)))
;; Some banks add a category to transactions, which conflicts with elbank's
;; categories, so put the category in `bank-category' instead.
(map-put transaction 'bank-category (map-elt data 'category))
(map-put transaction 'category nil)
(map-put transaction 'account account)))
(defun elbank-boobank--merge-accounts (accounts)
"Merge ACCOUNTS with existing ones in `elbank-data'.
Data from existing accounts are updated with new data from ACCOUNTS."
(elbank-boobank--update-existing-accounts accounts)
(let ((existing-accounts (map-elt elbank-data 'accounts)))
(let ((new-accounts (elbank-boobank--find-new-accounts accounts)))
(seq-concatenate 'list existing-accounts new-accounts))))
(defun elbank-boobank--find-new-accounts (accounts)
"Return accounts in ACCOUNTS that are not present in `elbank-data'."
(seq-remove (lambda (acc)
(elbank-account-with-id (map-elt acc 'id)))
(defun elbank-boobank--update-existing-accounts (new-accounts)
"Update existing accounts in `elbank-data' with the data from NEW-ACCOUNTS'.
No new account is created, only existing account values are updated."
(seq-do (lambda (new-acc)
(when-let ((acc (elbank-account-with-id (map-elt new-acc 'id))))
(map-apply (lambda (key val)
(map-put acc key val))
(defun elbank-boobank--merge-transactions (transactions)
"Merge the transaction list from `elbank-data' and TRANSACTIONS."
(let* ((existing-transactions (map-elt elbank-data 'transactions))
(new-transactions (elbank-boobank--find-new-transactions transactions)))
(seq-concatenate 'list existing-transactions new-transactions)))
(defun elbank-boobank--find-new-transactions (transactions)
"Return all transactions from TRANSACTIONS not present in `elbank-data'.
When comparing transactions, ignore (manually set) categories."
(apply #'seq-concatenate 'list
(seq-map (lambda (trans)
(let ((n (- (elbank-boobank--count-transactions-like
trans transactions)
trans (elbank-all-transactions t)))))
(when (> n 0)
(let ((result))
(dotimes (_ n)
(setq result (cons trans result)))
(seq-uniq transactions))))
(defun elbank-boobank--count-transactions-like (transaction transactions)
"Return the number of transactions like TRANSACTION in TRANSACTIONS."
(seq-length (elbank-filter-transactions
:raw (map-elt transaction 'raw)
:account (map-elt transaction 'account)
:amount (map-elt transaction 'amount)
:date (map-elt transaction 'date)
:vdate (map-elt transaction 'vdate)
:rdate (map-elt transaction 'rdate)
:label (map-elt transaction 'label))))
(defun elbank-boobank--shell-command (command callback)
"Start a subprocess for COMMAND, and evaluate CALLBACK with its output."
(let ((bufname "*boobank process*"))
(when-let ((buf (get-buffer bufname)))
(with-current-buffer buf
(make-process :name "boobank"
:buffer bufname
:sentinel (lambda (process event)
(if (eq (process-status process) 'exit)
(let ((json-array-type 'list))
(with-current-buffer (process-buffer process)
(goto-char (point-min))
(funcall callback (json-read))))
(error "Boobank fetch failed! %s" event)))
:command (list shell-file-name
(defun elbank-boobank--find-executable ()
"Return the boobank executable.
Signal an error if the boobank executable cannot be found."
(let ((executable (executable-find elbank-boobank-executable)))
(unless executable
(user-error "Cannot find boobank executable (%s) in PATH" elbank-boobank-executable))
(defun elbank-boobank--fetch-then-merge (fetch-fn merge-fn callback)
"Evaluate MERGE-FN with the result of the evaluation of FETCH-FN.
FETCH-FN is an asynchronous function that take a callback
function as argument.
Evaluate CALLBACK with the result of the merge."
(funcall fetch-fn
(lambda (data)
(let ((merged (funcall merge-fn data)))
(funcall callback merged)))))
(provide 'elbank-boobank)
;;; elbank-boobank.el ends here