class Currency(db.Model):
id = db.Column(db.Integer, primary_key=True)
owner_username = db.Column(db.String(50),
db.ForeignKey('user.username', use_alter=True,
onupdate='CASCADE',
ondelete='CASCADE',
name='fk_owner'))
isocode = db.Column(db.String(5), nullable=False)
symbol = db.Column(db.String(5), nullable=False)
name = db.Column(db.String(50), nullable=False)
rate = db.Column(db.Numeric(16, 4))
def __unicode__(self):
return u'Currency name "{0}", isocode "{1}", symbol "{2}", rate "{3}"'.format(
self.name, self.isocode, self.symbol, self.rate
)
def as_dict(self):
info = {
'isocode': self.isocode,
'symbol': self.symbol,
'name': self.name
}
if self.owner_username:
info['owner'] = self.owner_username
if self.rate is not None:
info['rate'] = self.rate
return info
class User(db.Model):
username = db.Column(db.String(50), nullable=False,
unique=True, primary_key=True)
first_name = db.Column(db.String(50), default='',nullable=False)
last_name = db.Column(db.String(50), default='',nullable=False)
passhash = db.Column(db.String(120), nullable=False)
preferred_currency_id = db.Column(db.ForeignKey('currency.id'),
nullable=False)
preferred_currency = db.relationship(
'Currency',
primaryjoin='User.preferred_currency_id==Currency.id'
)
def __unicode__(self):
return u'Username "{0}", first name "{1}", last name "{2}"'.format(
self.username, self.first_name, self.last_name
)
def as_dict(self, own=False):
info = {
'username': self.username,
'first_name': self.first_name,
'last_name': self.last_name
}
if own:
info['preferred_currency'] = self.preferred_currency.isocode
info['emails'] = []
for email in self.emails:
info['emails'].append(email.as_dict())
return info
class UserEmail(db.Model):
id = db.Column(db.Integer, primary_key=True)
user_username = db.Column(db.ForeignKey('user.username',
onupdate='CASCADE',
ondelete='CASCADE'),
nullable=False)
email_address = db.Column(db.String(256), nullable=False)
# Notification is to be used by (an)other process(es), OSPFM itself doesn't
# send notifications. This field make it possible to know which email
# addresses should be used by this/these other process(es).
notification = db.Column(db.Boolean, default=False)
confirmation = db.Column(db.String(16), nullable=False)
__table_args__ = (
UniqueConstraint('user_username', 'email_address',
name='_user_address_uc'),
)
user = db.relationship('User', backref=db.backref('emails'))
def as_dict(self):
return {
'address': self.email_address,
'notification': self.notification,
'confirmed': self.confirmation == 'OK'
}
class Transaction(db.Model):
id = db.Column(db.Integer, primary_key=True)
owner_username = db.Column(db.ForeignKey('user.username',
onupdate='CASCADE',
ondelete='CASCADE'),
nullable=False)
description = db.Column(db.String(200), nullable=False)
original_description = db.Column(db.String(200), nullable=False)
amount = db.Column(db.Numeric(15, 3), nullable=False)
currency_id = db.Column(db.ForeignKey('currency.id', ondelete='CASCADE'),
nullable=False)
date = db.Column(db.Date, nullable=False)
currency = db.relationship('Currency')
def as_dict(self, username):
return {
'id': self.id,
'description': self.description,
'original_description': self.original_description,
'amount': self.amount,
'currency': self.currency.isocode,
'date': self.date.strftime('%Y-%m-%d'),
'accounts': [ta.as_dict(username) \
for ta in self.transaction_accounts],
'categories': [tc.as_dict(username) \
for tc in self.transaction_categories]
}
class UserContact(db.Model):
id = db.Column(db.Integer, primary_key=True)
user_username = db.Column(db.ForeignKey('user.username',
onupdate='CASCADE',
ondelete='CASCADE'),
nullable=False)
contact_username = db.Column(db.ForeignKey('user.username',
onupdate='CASCADE',
ondelete='CASCADE'),
nullable=False)
comment = db.Column(db.String(100), default='', nullable=False)
__table_args__ = (
UniqueConstraint('user_username', 'contact_username',
name='_user_contact_uc'),
)
contact = db.relationship(
'User',
primaryjoin='UserContact.contact_username==User.username'
)
def as_dict(self):
return {
'username': self.contact.username,
'first_name': self.contact.first_name,
'last_name': self.contact.last_name,
'comment': self.comment
}
class Account(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(50), nullable=False)
currency_id = db.Column(db.ForeignKey('currency.id', ondelete='CASCADE'))
start_balance = db.Column(db.Numeric(15, 3), nullable=False)
currency = db.relationship('Currency')
def __unicode__(self):
return u'Account id {0}, name "{1}", currency "{2}", start balance {3}'.format(
self.id, self.name, self.currency.isocode, self.start_balance)
def balance(self, username):
"""
Return a list :
[ <balance in account currency>, <balance in preferred currency> ]
"""
balance = db.session.query(db.func.sum(
TransactionAccount.amount)).filter(
TransactionAccount.account_id == self.id).one()[0]
if balance:
balances = [self.start_balance + balance]
else:
balances = [self.start_balance]
balances.append(
helpers.rate(
username, self.currency.isocode,
coremodels.User.query.options(
db.joinedload(coremodels.User.preferred_currency)).get(
username).preferred_currency.isocode) * balances[0])
return balances
def transactions_count(self):
return db.session.query(
db.func.count(TransactionAccount.transaction_id)).filter(
TransactionAccount.account_id == self.id).one()[0] or 0
def as_dict(self, username, short=False):
if short:
return {
'id': self.id,
'name': self.name,
'currency': self.currency.isocode
}
else:
balances = self.balance(username)
return {
'id': self.id,
'name': self.name,
'currency': self.currency.isocode,
'start_balance': self.start_balance,
'balance': balances[0],
'balance_preferred': balances[1],
'transactions_count': self.transactions_count()
}
class UserPreference(db.Model):
id = db.Column(db.Integer, primary_key=True)
user_username = db.Column(db.ForeignKey('user.username',
onupdate='CASCADE',
ondelete='CASCADE'),
nullable=False)
name = db.Column(db.String(200), nullable=False)
value = db.Column(db.String(2048))
__table_args__ = (
UniqueConstraint('user_username', 'name', name='_user_preference_uc'),
)
def __unicode__(self):
return 'For user {0}, {1} = {2}'.format(
self.user_username, self.name, self.value
)
def as_dict(self):
return {
'name': self.name,
'value': self.value
}
class Category(db.Model):
id = db.Column(db.Integer, primary_key=True)
owner_username = db.Column(db.ForeignKey('user.username',
onupdate='CASCADE',
ondelete='CASCADE'),
nullable=False)
parent_id = db.Column(db.ForeignKey('category.id', ondelete='SET NULL'))
currency_id = db.Column(db.ForeignKey('currency.id', ondelete='CASCADE'))
name = db.Column(db.String(50), nullable=False)
currency = db.relationship('Currency')
children = db.relationship('Category',
order_by='Category.name',
backref=db.backref('parent', remote_side=[id]))
def __unicode__(self):
if self.parent_id:
return u'Category id {0}, name "{1}", parent id {2}'.format(
self.id, self.name, self.parent_id)
else:
return u'Category id {0}, name "{1}"'.format(self.id, self.name)
def balance(self, username):
today = datetime.date.today()
balance = cache.get('categorybalance-{0}'.format(self.id))
if not balance:
balance = {'currency': self.currency.isocode}
balance['year'] = db.session.query(
db.func.sum(TransactionCategory.category_amount)).filter(
db.and_(
TransactionCategory.category_id == self.id,
TransactionCategory.transaction_id == Transaction.id,
Transaction.date.between(
datetime.date(today.year, 1, 1),
datetime.date(today.year, 12, 31)))).one()[0] or 0
if today.month == 12:
lastdayofmonth = datetime.date(today.year, 12, 31)
else:
lastdayofmonth = datetime.date(today.year, today.month+1, 1) -\
datetime.timedelta(1)
balance['month'] = db.session.query(
db.func.sum(TransactionCategory.category_amount)).filter(
db.and_(
TransactionCategory.category_id == self.id,
TransactionCategory.transaction_id == Transaction.id,
Transaction.date.between(
datetime.date(today.year, today.month, 1),
lastdayofmonth))).one()[0] or 0
firstdayofweek = today - datetime.timedelta(today.weekday())
lastdayofweek = today + datetime.timedelta(6 - today.weekday())
balance['week'] = db.session.query(
db.func.sum(TransactionCategory.category_amount)).filter(
db.and_(
TransactionCategory.category_id == self.id,
TransactionCategory.transaction_id == Transaction.id,
Transaction.date.between(firstdayofweek,
lastdayofweek))).one()[0] or 0
balance['7days'] = db.session.query(
db.func.sum(TransactionCategory.category_amount)).filter(
db.and_(
TransactionCategory.category_id == self.id,
TransactionCategory.transaction_id == Transaction.id,
Transaction.date.between(today - datetime.timedelta(6),
today))).one()[0] or 0
balance['30days'] = db.session.query(
db.func.sum(TransactionCategory.category_amount)).filter(
db.and_(
TransactionCategory.category_id == self.id,
TransactionCategory.transaction_id == Transaction.id,
Transaction.date.between(
today - datetime.timedelta(29),
today))).one()[0] or 0
# Cache the balance only for 5 seconds : it helps when listing
# multiple categories by reducing sql requests
cache.set('categorybalance-{0}'.format(self.id), balance, 5)
for child in self.children:
child_balance = child.balance(username)
rate = helpers.rate(username, child_balance['currency'],
self.currency.isocode)
balance['year'] = balance['year'] + child_balance['year'] * rate
balance['month'] = balance['month'] + child_balance['month'] * rate
balance['week'] = balance['week'] + child_balance['week'] * rate
balance['7days'] = balance['7days'] + child_balance['7days'] * rate
balance[
'30days'] = balance['30days'] + child_balance['30days'] * rate
return balance
def all_parents_ids(self):
parents = []
if self.parent_id:
parents.append(self.parent_id)
parents = parents + self.parent.all_parents_ids()
return parents
def contains_category(self, categoryid):
if self.id == categoryid:
return True
if self.children:
for c in self.children:
if c.contains_category(categoryid):
return True
return False
def as_dict(self, username, parent=True, children=True, balance=True):
desc = {
'id': self.id,
'name': self.name,
'currency': self.currency.isocode,
}
if balance:
desc.update(self.balance(username))
if parent and self.parent_id:
desc['parent'] = self.parent_id
if children and self.children:
desc['children'] = [c.as_dict(username, False) \
for c in self.children]
return desc