"""
The latest version of this package is available at:
<http://github.com/jantman/biweeklybudget>
################################################################################
Copyright 2016 Jason Antman <jason@jasonantman.com> <http://www.jasonantman.com>
This file is part of biweeklybudget, also known as biweeklybudget.
biweeklybudget is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
biweeklybudget is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with biweeklybudget. If not, see <http://www.gnu.org/licenses/>.
The Copyright and Authors attributions contained herein may not be removed or
otherwise altered, except to add the Author attribution of a contributor to
this work. (Additional Terms pursuant to Section 7b of the AGPL v3)
################################################################################
While not legally required, I sincerely request that anyone who finds
bugs please submit them at <https://github.com/jantman/biweeklybudget> or
to me via email, and that you send any contributions or improvements
either as a pull request on GitHub, or to me via email.
################################################################################
AUTHORS:
Jason Antman <jason@jasonantman.com> <http://www.jasonantman.com>
################################################################################
"""
import logging
from flask.views import MethodView
from flask import render_template, jsonify, request
from datatables import DataTable
from copy import copy
from datetime import datetime
from decimal import Decimal
from biweeklybudget.db import db_session
from biweeklybudget.flaskapp.app import app
from biweeklybudget.models.transaction import Transaction
from biweeklybudget.models.budget_transaction import BudgetTransaction
from biweeklybudget.models.account import Account
from biweeklybudget.models.budget_model import Budget
from biweeklybudget.flaskapp.views.searchableajaxview import SearchableAjaxView
from biweeklybudget.flaskapp.views.formhandlerview import FormHandlerView
logger = logging.getLogger(__name__)
[docs]class TransactionsView(MethodView):
[docs] def get(self):
"""
Render the GET /transactions view using the ``transactions.html``
template.
"""
accts = {a.name: a.id for a in db_session.query(Account).all()}
budgets = {}
active_budgets = {}
for b in db_session.query(Budget).all():
if b.is_income:
bname = '%s (income)' % b.name
else:
bname = b.name
budgets[bname] = b.id
if b.is_active:
active_budgets[bname] = b.id
return render_template(
'transactions.html',
accts=accts,
budgets=budgets,
active_budgets=active_budgets
)
[docs]class OneTransactionView(MethodView):
[docs] def get(self, trans_id):
"""
Render the GET /transactions/<int:trans_id> view using the
``transactions.html`` template.
"""
accts = {a.name: a.id for a in db_session.query(Account).all()}
budgets = {}
active_budgets = {}
for b in db_session.query(Budget).all():
if b.is_income:
bname = '%s (income)' % b.name
else:
bname = b.name
budgets[bname] = b.id
if b.is_active:
active_budgets[bname] = b.id
return render_template(
'transactions.html',
accts=accts,
budgets=budgets,
trans_id=trans_id,
active_budgets=active_budgets
)
[docs]class TransactionsAjax(SearchableAjaxView):
"""
Handle GET /ajax/transactions endpoint.
"""
[docs] def _filterhack(self, qs, s, args):
"""
DataTables 1.10.12 has built-in support for filtering based on a value
in a specific column; when this is done, the filter value is set in
``columns[N][search][value]`` where N is the column number. However,
the python datatables package used here only supports the global
``search[value]`` input, not the per-column one.
However, the DataTable search is implemented by passing a callable
to ``table.searchable()`` which takes two arguments, the current Query
that's being built, and the user's ``search[value]`` input; this must
then return a Query object with the search applied.
In python datatables 0.4.9, this code path is triggered on
``if callable(self.search_func) and search.get("value", None):``
As such, we can "trick" the table to use per-column searching (currently
only if global searching is not being used) by examining the per-column
search values in the request, and setting the search function to one
(this method) that uses those values instead of the global
``search[value]``.
:param qs: Query currently being built
:type qs: ``sqlalchemy.orm.query.Query``
:param s: user search value
:type s: str
:param args: args
:type args: dict
:return: Query with searching applied
:rtype: ``sqlalchemy.orm.query.Query``
"""
# Ok, build our filter...
acct_filter = args['columns'][3]['search']['value']
if acct_filter != '' and acct_filter != 'None':
qs = qs.filter(Transaction.account_id == acct_filter)
budg_filter = args['columns'][4]['search']['value']
if budg_filter != '' and budg_filter != 'None':
qs = qs.filter(
Transaction.budget_transactions.any(
BudgetTransaction.budget_id.__eq__(budg_filter)
)
)
# search
if s != '' and s != 'FILTERHACK':
if len(s) < 3:
return qs
s = '%' + s + '%'
qs = qs.filter(Transaction.description.like(s))
return qs
[docs] def get(self):
"""
Render and return JSON response for GET /ajax/ofx
"""
args = request.args.to_dict()
args_dict = self._args_dict(args)
if self._have_column_search(args_dict) and args['search[value]'] == '':
args['search[value]'] = 'FILTERHACK'
table = DataTable(
args, Transaction, db_session.query(Transaction),
[
(
'date',
lambda i: i.date.strftime('%Y-%m-%d')
),
(
'amount',
'actual_amount',
lambda a: float(a.actual_amount)
),
'description',
(
'account',
'account.name',
lambda i: "{} ({})".format(i.name, i.id)
),
(
'scheduled',
'scheduled_trans_id'
),
(
'budgeted_amount'
),
(
'reconcile_id',
'reconcile',
lambda i: None if i.reconcile is None else i.reconcile.id
)
]
)
table.add_data(
acct_id=lambda o: o.account_id,
budgets=lambda o: [
{
'name': bt.budget.name,
'id': bt.budget_id,
'amount': bt.amount,
'is_income': bt.budget.is_income
}
for bt in sorted(
o.budget_transactions, key=lambda x: x.amount,
reverse=True
)
],
id=lambda o: o.id
)
if args['search[value]'] != '':
table.searchable(lambda qs, s: self._filterhack(qs, s, args_dict))
return jsonify(table.json())
[docs]class OneTransactionAjax(MethodView):
"""
Handle GET /ajax/transactions/<int:trans_id> endpoint.
"""
[docs] def get(self, trans_id):
t = db_session.query(Transaction).get(trans_id)
d = copy(t.as_dict)
d['account_name'] = t.account.name
d['budgets'] = [
{
'name': bt.budget.name,
'id': bt.budget_id,
'amount': bt.amount,
'is_income': bt.budget.is_income
}
for bt in sorted(
t.budget_transactions, key=lambda x: x.amount,
reverse=True
)
]
return jsonify(d)
app.add_url_rule(
'/transactions',
view_func=TransactionsView.as_view('transactions_view')
)
app.add_url_rule(
'/transactions/<int:trans_id>',
view_func=OneTransactionView.as_view('one_transaction_view')
)
app.add_url_rule(
'/ajax/transactions',
view_func=TransactionsAjax.as_view('transactions_ajax')
)
app.add_url_rule(
'/ajax/transactions/<int:trans_id>',
view_func=OneTransactionAjax.as_view('one_transaction_ajax')
)
app.add_url_rule(
'/forms/transaction',
view_func=TransactionFormHandler.as_view('transaction_form')
)