addons/membership/membership.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
   6 #
   7 #    This program is free software: you can redistribute it and/or modify
   8 #    it under the terms of the GNU Affero General Public License as
   9 #    published by the Free Software Foundation, either version 3 of the
  10 #    License, or (at your option) any later version.
  11 #
  12 #    This program is distributed in the hope that it will be useful,
  13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #    GNU Affero General Public License for more details.
  16 #
  17 #    You should have received a copy of the GNU Affero General Public License
  18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 #
  20 ##############################################################################
  21
  22 import time
  23
  24 from osv import fields, osv
  25 from tools import config
  26 import decimal_precision as dp
  27 from tools.translate import _
  28
  29 STATE = [
  30     ('none', 'Non Member'),
  31     ('canceled', 'Cancelled Member'),
  32     ('old', 'Old Member'),
  33     ('waiting', 'Waiting Member'),
  34     ('invoiced', 'Invoiced Member'),
  35     ('free', 'Free Member'),
  36     ('paid', 'Paid Member'),
  37 ]
  38
  39 STATE_PRIOR = {
  40     'none': 0,
  41     'canceled': 1,
  42     'old': 2,
  43     'waiting': 3,
  44     'invoiced': 4,
  45     'free': 6,
  46     'paid': 7
  47 }
  48
  49 class membership_line(osv.osv):
  50     '''Member line'''
  51
  52     def _get_membership_lines(self, cr, uid, ids, context=None):
  53             list_membership_line = []
  54             member_line_obj = self.pool.get('membership.membership_line')
  55             for invoice in self.pool.get('account.invoice').browse(cr, uid, ids, context=context):
  56                 if invoice.invoice_line:
  57                     list_membership_line += member_line_obj.search(cr, uid, [('account_invoice_line', 'in', [ l.id for l in invoice.invoice_line])], context=context)
  58             return list_membership_line
  59
  60     def _check_membership_date(self, cr, uid, ids, context=None):
  61         """Check if membership product is not in the past
  62         @param self: The object pointer
  63         @param cr: the current row, from the database cursor,
  64         @param uid: the current user’s ID for security checks,
  65         @param ids: List of Membership Line IDs
  66         @param context: A standard dictionary for contextual values
  67         """
  68
  69         cr.execute('''
  70          SELECT MIN(ml.date_to - ai.date_invoice)
  71              FROM membership_membership_line ml
  72              JOIN account_invoice_line ail ON (
  73                 ml.account_invoice_line = ail.id
  74                 )
  75             JOIN account_invoice ai ON (
  76             ai.id = ail.invoice_id)
  77             WHERE ml.id IN %s''',(tuple(ids),))
  78         res = cr.fetchall()
  79         for r in res:
  80             if r[0] and r[0] < 0:
  81                 return False
  82         return True
  83
  84     def _state(self, cr, uid, ids, name, args, context=None):
  85         """Compute the state lines
  86         @param self: The object pointer
  87         @param cr: the current row, from the database cursor,
  88         @param uid: the current user’s ID for security checks,
  89         @param ids: List of Membership Line IDs
  90         @param name: Field Name
  91         @param context: A standard dictionary for contextual values
  92         @param return: Dictionary of state Value
  93         """
  94         res = {}
  95         inv_obj = self.pool.get('account.invoice')
  96         for line in self.browse(cr, uid, ids, context=context):
  97             cr.execute('''
  98             SELECT i.state, i.id FROM
  99             account_invoice i
 100             WHERE
 101             i.id = (
 102                 SELECT l.invoice_id FROM
 103                 account_invoice_line l WHERE
 104                 l.id = (
 105                     SELECT  ml.account_invoice_line FROM
 106                     membership_membership_line ml WHERE
 107                     ml.id = %s
 108                     )
 109                 )
 110             ''', (line.id,))
 111             fetched = cr.fetchone()
 112             if not fetched:
 113                 res[line.id] = 'canceled'
 114                 continue
 115             istate = fetched[0]
 116             state = 'none'
 117             if (istate == 'draft') | (istate == 'proforma'):
 118                 state = 'waiting'
 119             elif istate == 'open':
 120                 state = 'invoiced'
 121             elif istate == 'paid':
 122                 state = 'paid'
 123                 inv = inv_obj.browse(cr, uid, fetched[1], context=context)
 124                 for payment in inv.payment_ids:
 125                     if payment.invoice and payment.invoice.type == 'out_refund':
 126                         state = 'canceled'
 127             elif istate == 'cancel':
 128                 state = 'canceled'
 129             res[line.id] = state
 130         return res
 131
 132
 133     _description = __doc__
 134     _name = 'membership.membership_line'
 135     _columns = {
 136         'partner': fields.many2one('res.partner', 'Partner', ondelete='cascade', select=1),
 137         'membership_id': fields.many2one('product.product', string="Membership Product", required=True),
 138         'date_from': fields.date('From', readonly=True),
 139         'date_to': fields.date('To', readonly=True),
 140         'date_cancel': fields.date('Cancel date'),
 141         'date': fields.date('Join Date'),
 142         'member_price':fields.float('Member Price', digits_compute= dp.get_precision('Sale Price'), required=True),
 143         'account_invoice_line': fields.many2one('account.invoice.line', 'Account Invoice line', readonly=True),
 144         'account_invoice_id': fields.related('account_invoice_line', 'invoice_id', type='many2one', relation='account.invoice', string='Invoice', readonly=True),
 145         'state': fields.function(
 146                         _state, method=True,
 147                         string='Membership State', type='selection',
 148                         selection=STATE, store = {
 149                         'account.invoice':(_get_membership_lines, ['state'], 10),
 150                         }),
 151         'company_id': fields.related('account_invoice_line', 'invoice_id', 'company_id', type="many2one", relation="res.company", string="Company", readonly=True, store=True)
 152     }
 153     _rec_name = 'partner'
 154     _order = 'id desc'
 155     _constraints = [
 156         (_check_membership_date, 'Error, this membership product is out of date', [])
 157     ]
 158
 159 membership_line()
 160
 161
 162 class Partner(osv.osv):
 163     '''Partner'''
 164     _inherit = 'res.partner'
 165
 166     def _get_partner_id(self, cr, uid, ids, context=None):
 167         member_line_obj = self.pool.get('membership.membership_line')
 168         res_obj =  self.pool.get('res.partner')
 169         data_inv = member_line_obj.browse(cr, uid, ids, context=context)
 170         list_partner = []
 171         for data in data_inv:
 172             list_partner.append(data.partner.id)
 173         ids2 = list_partner
 174         while ids2:
 175             ids2 = res_obj.search(cr, uid, [('associate_member','in',ids2)], context=context)
 176             list_partner += ids2
 177         return list_partner
 178
 179     def _get_invoice_partner(self, cr, uid, ids, context=None):
 180         inv_obj = self.pool.get('account.invoice')
 181         res_obj = self.pool.get('res.partner')
 182         data_inv = inv_obj.browse(cr, uid, ids, context=context)
 183         list_partner = []
 184         for data in data_inv:
 185             list_partner.append(data.partner_id.id)
 186         ids2 = list_partner
 187         while ids2:
 188             ids2 = res_obj.search(cr, uid, [('associate_member','in',ids2)], context=context)
 189             list_partner += ids2
 190         return list_partner
 191
 192     def _membership_state(self, cr, uid, ids, name, args, context=None):
 193         """This Function return Membership State For Given Partner.
 194         @param self: The object pointer
 195         @param cr: the current row, from the database cursor,
 196         @param uid: the current user’s ID for security checks,
 197         @param ids: List of Partner IDs
 198         @param name: Field Name
 199         @param context: A standard dictionary for contextual values
 200         @param return: Dictionary of Membership state Value
 201         """
 202         res = {}
 203         for id in ids:
 204             res[id] = 'none'
 205         today = time.strftime('%Y-%m-%d')
 206         for id in ids:
 207             partner_data = self.browse(cr, uid, id, context=context)
 208             if partner_data.membership_cancel and today > partner_data.membership_cancel:
 209                 res[id] = 'canceled'
 210                 continue
 211             if partner_data.membership_stop and today > partner_data.membership_stop:
 212                 res[id] = 'old'
 213                 continue
 214             s = 4
 215             if partner_data.member_lines:
 216                 for mline in partner_data.member_lines:
 217                     if mline.date_to >= today:
 218                         if mline.account_invoice_line and mline.account_invoice_line.invoice_id:
 219                             mstate = mline.account_invoice_line.invoice_id.state
 220                             if mstate == 'paid':
 221                                 s = 0
 222                                 inv = mline.account_invoice_line.invoice_id
 223                                 for payment in inv.payment_ids:
 224                                     if payment.invoice.type == 'out_refund':
 225                                         s = 2
 226                                 break
 227                             elif mstate == 'open' and s!=0:
 228                                 s = 1
 229                             elif mstate == 'cancel' and s!=0 and s!=1:
 230                                 s = 2
 231                             elif  (mstate == 'draft' or mstate == 'proforma') and s!=0 and s!=1:
 232                                 s = 3
 233                 if s==4:
 234                     for mline in partner_data.member_lines:
 235                         if mline.date_from < today and mline.date_to < today and mline.date_from<=mline.date_to and (mline.account_invoice_line and mline.account_invoice_line.invoice_id.state) == 'paid':
 236                             s = 5
 237                         else:
 238                             s = 6
 239                 if s==0:
 240                     res[id] = 'paid'
 241                 elif s==1:
 242                     res[id] = 'invoiced'
 243                 elif s==2:
 244                     res[id] = 'canceled'
 245                 elif s==3:
 246                     res[id] = 'waiting'
 247                 elif s==5:
 248                     res[id] = 'old'
 249                 elif s==6:
 250                     res[id] = 'none'
 251             if partner_data.free_member and s!=0:
 252                 res[id] = 'free'
 253             if partner_data.associate_member:
 254                 res_state = self._membership_state(cr, uid, [partner_data.associate_member.id], name, args, context=context)
 255                 res[id] = res_state[partner_data.associate_member.id]
 256         return res
 257
 258     def _membership_date(self, cr, uid, ids, name, args, context=None):
 259         """Return  date of membership"""
 260         name = name[0]
 261         res = {}
 262         member_line_obj = self.pool.get('membership.membership_line')
 263         for partner in self.browse(cr, uid, ids, context=context):
 264             if partner.associate_member:
 265                  partner_id = partner.associate_member.id
 266             else:
 267                  partner_id = partner.id
 268             res[partner.id] = {
 269                  'membership_start': False,
 270                  'membership_stop': False,
 271                  'membership_cancel': False
 272             }
 273             if name == 'membership_start':
 274                 line_id = member_line_obj.search(cr, uid, [('partner', '=', partner_id)],
 275                             limit=1, order='date_from', context=context)
 276                 if line_id:
 277                         res[partner.id]['membership_start'] = member_line_obj.read(cr, uid, line_id[0],
 278                                 ['date_from'], context=context)['date_from']
 279
 280             if name == 'membership_stop':
 281                 line_id1 = member_line_obj.search(cr, uid, [('partner', '=', partner_id)],
 282                             limit=1, order='date_to desc', context=context)
 283                 if line_id1:
 284                       res[partner.id]['membership_stop'] = member_line_obj.read(cr, uid, line_id1[0],
 285                                 ['date_to'], context=context)['date_to']
 286
 287             if name == 'membership_cancel':
 288                 if partner.membership_state == 'canceled':
 289                     line_id2 = member_line_obj.search(cr, uid, [('partner', '=', partner.id)], limit=1, order='date_cancel', context=context)
 290                     if line_id2:
 291                         res[partner.id]['membership_cancel'] = member_line_obj.read(cr, uid, line_id2[0], ['date_cancel'], context=context)['date_cancel']
 292         return res
 293
 294     def _get_partners(self, cr, uid, ids, context=None):
 295         ids2 = ids
 296         while ids2:
 297             ids2 = self.search(cr, uid, [('associate_member','in',ids2)], context=context)
 298             ids += ids2
 299         return ids
 300
 301     def __get_membership_state(self, *args, **kwargs):
 302         return self._membership_state(*args, **kwargs)
 303
 304     _columns = {
 305         'associate_member': fields.many2one('res.partner', 'Associate member'),
 306         'member_lines': fields.one2many('membership.membership_line', 'partner', 'Membership'),
 307         'free_member': fields.boolean('Free member'),
 308         'membership_amount': fields.float(
 309                     'Membership amount', digits=(16, 2),
 310                     help = 'The price negociated by the partner'),
 311         'membership_state': fields.function(
 312                     __get_membership_state, method = True,
 313                     string = 'Current Membership State', type = 'selection',
 314                     selection = STATE,
 315                     store = {
 316                         'account.invoice': (_get_invoice_partner, ['state'], 10),
 317                         'membership.membership_line': (_get_partner_id, ['state'], 10),
 318                         'res.partner': (_get_partners, ['free_member', 'membership_state', 'associate_member'], 10)
 319                     }),
 320         'membership_start': fields.function(
 321                     _membership_date, method = True, multi = 'membeship_start',
 322                     string = 'Start membership date', type = 'date',
 323                     store = {
 324                         'account.invoice': (_get_invoice_partner, ['state'], 10),
 325                         'membership.membership_line': (_get_partner_id, ['state'], 10, ),
 326                         'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['free_member'], 10)
 327                     }),
 328         'membership_stop': fields.function(
 329                     _membership_date, method = True,
 330                     string = 'Stop membership date', type = 'date', multi='membership_stop',
 331                     store = {
 332                         'account.invoice': (_get_invoice_partner, ['state'], 10),
 333                         'membership.membership_line': (_get_partner_id, ['state'], 10),
 334                         'res.partner': (lambda self,cr,uid,ids,c={}:ids, ['free_member'], 10)
 335                     }),
 336         'membership_cancel': fields.function(
 337                     _membership_date, method = True,
 338                     string = 'Cancel membership date', type='date', multi='membership_cancel',
 339                     store = {
 340                         'account.invoice': (_get_invoice_partner, ['state'], 11),
 341                         'membership.membership_line': (_get_partner_id, ['state'], 10),
 342                         'res.partner': (lambda self,cr,uid,ids,c={}:ids, ['free_member'], 10)
 343                     }),
 344     }
 345     _defaults = {
 346         'free_member': False,
 347         'membership_cancel': False,
 348     }
 349
 350     def _check_recursion(self, cr, uid, ids):
 351         """Check  Recursive  for Associated Members.
 352         """
 353         level = 100
 354         while len(ids):
 355             cr.execute('SELECT DISTINCT associate_member FROM res_partner WHERE id IN %s', (tuple(ids),))
 356             ids = filter(None, map(lambda x:x[0], cr.fetchall()))
 357             if not level:
 358                 return False
 359             level -= 1
 360         return True
 361
 362     _constraints = [
 363         (_check_recursion, 'Error ! You can not create recursive associated members.', ['associate_member'])
 364     ]
 365
 366     def copy(self, cr, uid, id, default=None, context=None):
 367         if default is None:
 368             default = {}
 369         if context is None:
 370             context = {}
 371         default = default.copy()
 372         default['member_lines'] = []
 373         return super(Partner, self).copy(cr, uid, id, default, context=context)
 374
 375     def create_membership_invoice(self, cr, uid, ids, product_id=None, datas=None, context=None):
 376         """ Create Customer Invoice of Membership for partners.
 377         @param datas: datas has dictionary value which consist Id of Membership product and Cost Amount of Membership.
 378                       datas = {'membership_product_id': None, 'amount':None}
 379         """
 380         invoice_obj = self.pool.get('account.invoice')
 381         invoice_line_obj = self.pool.get('account.invoice.line')
 382         invoice_tax_obj = self.pool.get('account.invoice.tax')
 383         product_id = product_id or datas.get('membership_product_id',False)
 384         amount = datas.get('amount', 0.0)
 385         if not context:
 386             context={}
 387         invoice_list = []
 388         if type(ids) in (int,long,):
 389             ids = [ids]
 390         for partner in self.browse(cr, uid, ids, context=context):
 391             account_id = partner.property_account_receivable and partner.property_account_receivable.id or False
 392             fpos_id = partner.property_account_position and partner.property_account_position.id or False
 393             addr = self.address_get(cr, uid, [partner.id], ['invoice'])
 394             if partner.free_member:
 395                 raise osv.except_osv(_('Error !'),
 396                         _("Partner is a free Member."))
 397             if not addr.get('invoice', False):
 398                 raise osv.except_osv(_('Error !'),
 399                         _("Partner doesn't have an address to make the invoice."))
 400             quantity = 1
 401             line_value =  {
 402                 'product_id': product_id,
 403             }
 404
 405             line_dict = invoice_line_obj.product_id_change(cr, uid, {},
 406                             product_id, False, quantity, '', 'out_invoice', partner.id, fpos_id, price_unit=amount, context=context)
 407             line_value.update(line_dict['value'])
 408             if line_value.get('invoice_line_tax_id', False):
 409                 tax_tab = [(6, 0, line_value['invoice_line_tax_id'])]
 410                 line_value['invoice_line_tax_id'] = tax_tab
 411
 412             invoice_id = invoice_obj.create(cr, uid, {
 413                 'partner_id': partner.id,
 414                 'address_invoice_id': addr.get('invoice', False),
 415                 'account_id': account_id,
 416                 'fiscal_position': fpos_id or False
 417                 }, context=context)
 418             line_value['invoice_id'] = invoice_id
 419             invoice_line_id = invoice_line_obj.create(cr, uid, line_value, context=context)
 420             invoice_obj.write(cr, uid, invoice_id, {'invoice_line': [(6, 0, [invoice_line_id])]}, context=context)
 421             invoice_list.append(invoice_id)
 422             if line_value['invoice_line_tax_id']:
 423                 tax_value = invoice_tax_obj.compute(cr, uid, invoice_id).values()
 424                 for tax in tax_value:
 425                        invoice_tax_obj.create(cr, uid, tax, context=context)
 426         #recompute the membership_state of those partners
 427         self.pool.get('res.partner').write(cr, uid, ids, {})
 428         return invoice_list
 429
 430 Partner()
 431
 432 class product_template(osv.osv):
 433     _inherit = 'product.template'
 434     _columns = {
 435         'member_price':fields.float('Member Price', digits_compute= dp.get_precision('Sale Price')),
 436     }
 437 product_template()
 438
 439 class Product(osv.osv):
 440
 441     def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
 442         model_obj = self.pool.get('ir.model.data')
 443
 444         if ('product' in context) and (context['product']=='membership_product'):
 445             model_data_ids_form = model_obj.search(cr, user, [('model','=','ir.ui.view'), ('name','in',['membership_products_form', 'membership_products_tree'])], context=context)
 446             resource_id_form = model_obj.read(cr, user, model_data_ids_form, fields=['res_id', 'name'], context=context)
 447             dict_model = {}
 448             for i in resource_id_form:
 449                 dict_model[i['name']] = i['res_id']
 450             if view_type == 'form':
 451                 view_id = dict_model['membership_products_form']
 452             else:
 453                 view_id = dict_model['membership_products_tree']
 454         return super(Product,self).fields_view_get(cr, user, view_id, view_type, context, toolbar, submenu)
 455
 456     '''Product'''
 457     _inherit = 'product.product'
 458     _columns = {
 459         'membership': fields.boolean('Membership', help='Specify if this product is a membership product'),
 460         'membership_date_from': fields.date('Date from', help='Active Membership since this date'),
 461         'membership_date_to': fields.date('Date to', help='Expired date of Membership'),
 462     }
 463
 464     _defaults = {
 465         'membership': False
 466     }
 467 Product()
 468
 469
 470 class Invoice(osv.osv):
 471     '''Invoice'''
 472     _inherit = 'account.invoice'
 473
 474     def action_cancel(self, cr, uid, ids, *args):
 475         '''Create a 'date_cancel' on the membership_line object'''
 476         member_line_obj = self.pool.get('membership.membership_line')
 477         today = time.strftime('%Y-%m-%d')
 478         for invoice in self.browse(cr, uid, ids):
 479             mlines = member_line_obj.search(cr, uid,
 480                     [('account_invoice_line','in',
 481                         [ l.id for l in invoice.invoice_line])])
 482             member_line_obj.write(cr, uid, mlines, {'date_cancel': today})
 483         return super(Invoice, self).action_cancel(cr, uid, ids)
 484 Invoice()
 485
 486 class account_invoice_line(osv.osv):
 487     _inherit='account.invoice.line'
 488
 489     def write(self, cr, uid, ids, vals, context=None):
 490         """Overrides orm write method
 491         """
 492         if not context:
 493             context={}
 494         res = super(account_invoice_line, self).write(cr, uid, ids, vals, context=context)
 495         member_line_obj = self.pool.get('membership.membership_line')
 496         for line in self.browse(cr, uid, ids, context=context):
 497             if line.invoice_id.type == 'out_invoice':
 498                 ml_ids = member_line_obj.search(cr, uid, [('account_invoice_line','=',line.id)], context=context)
 499                 if line.product_id and line.product_id.membership and not ml_ids:
 500                     # Product line has changed to a membership product
 501                     date_from = line.product_id.membership_date_from
 502                     date_to = line.product_id.membership_date_to
 503                     if line.invoice_id.date_invoice > date_from and line.invoice_id.date_invoice < date_to:
 504                         date_from = line.invoice_id.date_invoice
 505                     line_id = member_line_obj.create(cr, uid, {
 506                         'partner': line.invoice_id.partner_id.id,
 507                         'membership_id': line.product_id.id,
 508                         'member_price': line.price_unit,
 509                         'date': time.strftime('%Y-%m-%d'),
 510                         'date_from': date_from,
 511                         'date_to': date_to,
 512                         'account_invoice_line': line.id,
 513                         }, context=context)
 514                 if line.product_id and not line.product_id.membership and ml_ids:
 515                     # Product line has changed to a non membership product
 516                     member_line_obj.unlink(cr, uid, ml_ids, context=context)
 517         return res
 518
 519     def unlink(self, cr, uid, ids, context=None):
 520         """Remove Membership Line Record for Account Invoice Line
 521         """
 522         if not context:
 523             context={}
 524         member_line_obj = self.pool.get('membership.membership_line')
 525         for id in ids:
 526             ml_ids = member_line_obj.search(cr, uid, [('account_invoice_line','=',id)], context=context)
 527             member_line_obj.unlink(cr, uid, ml_ids, context=context)
 528         return super(account_invoice_line, self).unlink(cr, uid, ids, context=context)
 529
 530     def create(self, cr, uid, vals, context=None):
 531         """Overrides orm create method
 532         """
 533         result = super(account_invoice_line, self).create(cr, uid, vals, context=context)
 534         line = self.browse(cr, uid, result, context=context)
 535         member_line_obj = self.pool.get('membership.membership_line')
 536         if line.invoice_id.type == 'out_invoice':
 537             ml_ids = member_line_obj.search(cr, uid, [('account_invoice_line','=',line.id)], context=context)
 538             if line.product_id and line.product_id.membership and not ml_ids:
 539                 # Product line is a membership product
 540                 date_from = line.product_id.membership_date_from
 541                 date_to = line.product_id.membership_date_to
 542                 if line.invoice_id.date_invoice > date_from and line.invoice_id.date_invoice < date_to:
 543                     date_from = line.invoice_id.date_invoice
 544                 line_id = member_line_obj.create(cr, uid, {
 545                             'partner': line.invoice_id.partner_id and line.invoice_id.partner_id.id or False,
 546                             'membership_id': line.product_id.id,
 547                             'member_price': line.price_unit,
 548                             'date': time.strftime('%Y-%m-%d'),
 549                             'date_from': date_from,
 550                             'date_to': date_to,
 551                             'account_invoice_line': line.id,
 552                         }, context=context)
 553         return result
 554
 555 account_invoice_line()
 556 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: