source: main/waeup.kofa/trunk/src/waeup/kofa/payments/payment.py @ 12972

Last change on this file since 12972 was 12894, checked in by Henrik Bettermann, 9 years ago

More docs.

  • Property svn:keywords set to Id
File size: 3.4 KB
RevLine 
[7195]1## $Id: payment.py 12894 2015-04-30 10:32:04Z henrik $
2##
[6864]3## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
4## This program is free software; you can redistribute it and/or modify
5## it under the terms of the GNU General Public License as published by
6## the Free Software Foundation; either version 2 of the License, or
7## (at your option) any later version.
8##
9## This program is distributed in the hope that it will be useful,
10## but WITHOUT ANY WARRANTY; without even the implied warranty of
11## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12## GNU General Public License for more details.
13##
14## You should have received a copy of the GNU General Public License
15## along with this program; if not, write to the Free Software
16## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17##
18"""
19These are the payment tickets.
20"""
21import grok
[6869]22from datetime import datetime
[6864]23from grok import index
[9505]24from zope.event import notify
[8182]25from zope.component import getUtility
[8429]26from zope.i18n import translate
[8182]27from waeup.kofa.interfaces import IKofaUtils
[8420]28from waeup.kofa.interfaces import MessageFactory as _
[7811]29from waeup.kofa.payments.interfaces import (
[9469]30    IPayment, IOnlinePayment,
[9405]31    payment_states)
[8420]32from waeup.kofa.utils.helpers import attrs_to_fields, get_current_principal
[9769]33from waeup.kofa.utils.logger import Logger
[6864]34
[9769]35class Payment(grok.Container, Logger):
[6864]36    """This is a payment.
37    """
38    grok.implements(IPayment)
39    grok.provides(IPayment)
40    grok.baseclass()
41
[9769]42    logger_name = 'waeup.kofa.${sitename}.payments'
43    logger_filename = 'payments.log'
44    logger_format_str = '"%(asctime)s","%(user)s",%(message)s'
45
[12894]46    #def logger_info(self, comment=None):
47    #    """Get the logger's info method.
48    #    """
49    #    self.logger.info('%s' % comment)
50    #    return
[9769]51
[6864]52    def __init__(self):
53        super(Payment, self).__init__()
[8194]54        self.creation_date = datetime.utcnow()
[6869]55        self.p_id = None
[6864]56        return
57
[6869]58    @property
[10232]59    def p_state_title(self):
[6869]60        return payment_states.getTermByToken(self.p_state).title
61
62    @property
63    def category(self):
[9405]64        utils = getUtility(IKofaUtils)
[10842]65        return utils.PAYMENT_CATEGORIES.get(self.p_category, None)
[6869]66
[9984]67    @property
68    def display_item(self):
[9987]69        kofa_utils = getUtility(IKofaUtils)
70        return kofa_utils.getPaymentItem(self)
[9984]71
[6864]72class OnlinePayment(Payment):
73    """This is an online payment.
74    """
75    grok.implements(IOnlinePayment)
76    grok.provides(IOnlinePayment)
77
78    def __init__(self):
79        super(OnlinePayment, self).__init__()
[6869]80        p_id = None
[6864]81        return
82
[8420]83    def approve(self):
84        "Approve online payment and set to paid."
85        self.r_amount_approved = self.amount_auth
86        self.r_code = u'AP'
87        self.p_state = 'paid'
[8429]88        user = get_current_principal()
[8434]89        if user is None:
90            # in tests
91            usertitle = 'system'
92        else:
[8758]93            usertitle = getattr(user, 'public_name', None)
94            if not usertitle:
95                usertitle = user.title
[8434]96        r_desc = _('Payment approved by ${a}', mapping = {'a': usertitle})
[8429]97        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
98        self.r_desc = translate(r_desc, 'waeup.kofa',
99            target_language=portal_language)
[8420]100        self.payment_date = datetime.utcnow()
[9505]101        # Update catalog
102        notify(grok.ObjectModifiedEvent(self))
[8420]103        return
104
[9984]105OnlinePayment = attrs_to_fields(OnlinePayment, omit=['display_item'])
Note: See TracBrowser for help on using the repository browser.