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 from osv import fields, osv
  23 from tools import config
  24 import time
  25
  26 import decimal_precision as dp
  27
  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 #~ REQUETE = '''SELECT partner, state FROM (
  50 #~ SELECT members.partner AS partner,
  51 #~ CASE WHEN MAX(members.state) = 0 THEN 'none'
  52 #~ ELSE CASE WHEN MAX(members.state) = 1 THEN 'canceled'
  53 #~ ELSE CASE WHEN MAX(members.state) = 2 THEN 'old'
  54 #~ ELSE CASE WHEN MAX(members.state) = 3 THEN 'waiting'
  55 #~ ELSE CASE WHEN MAX(members.state) = 4 THEN 'invoiced'
  56 #~ ELSE CASE WHEN MAX(members.state) = 6 THEN 'free'
  57 #~ ELSE CASE WHEN MAX(members.state) = 7 THEN 'paid'
  58 #~ END END END END END END END END
  59     #~ AS state FROM (
  60 #~ SELECT partner,
  61     #~ CASE WHEN MAX(inv_digit.state) = 4 THEN 7
  62     #~ ELSE CASE WHEN MAX(inv_digit.state) = 3 THEN 4
  63     #~ ELSE CASE WHEN MAX(inv_digit.state) = 2 THEN 3
  64     #~ ELSE CASE WHEN MAX(inv_digit.state) = 1 THEN 1
  65 #~ END END END END
  66 #~ AS state
  67 #~ FROM (
  68     #~ SELECT p.id as partner,
  69     #~ CASE WHEN ai.state = 'paid' THEN 4
  70     #~ ELSE CASE WHEN ai.state = 'open' THEN 3
  71     #~ ELSE CASE WHEN ai.state = 'proforma' THEN 2
  72     #~ ELSE CASE WHEN ai.state = 'draft' THEN 2
  73     #~ ELSE CASE WHEN ai.state = 'cancel' THEN 1
  74 #~ END END END END END
  75 #~ AS state
  76 #~ FROM res_partner p
  77 #~ JOIN account_invoice ai ON (
  78     #~ p.id = ai.partner_id
  79 #~ )
  80 #~ JOIN account_invoice_line ail ON (
  81     #~ ail.invoice_id = ai.id
  82 #~ )
  83 #~ JOIN membership_membership_line ml ON (
  84     #~ ml.account_invoice_line  = ail.id
  85 #~ )
  86 #~ WHERE ml.date_from <= '%s'
  87 #~ AND ml.date_to >= '%s'
  88 #~ GROUP BY
  89 #~ p.id,
  90 #~ ai.state
  91     #~ )
  92     #~ AS inv_digit
  93     #~ GROUP by partner
  94 #~ UNION
  95 #~ SELECT p.id AS partner,
  96     #~ CASE WHEN  p.free_member THEN 6
  97     #~ ELSE CASE WHEN p.associate_member IN (
  98         #~ SELECT ai.partner_id FROM account_invoice ai JOIN
  99         #~ account_invoice_line ail ON (ail.invoice_id = ai.id AND ai.state = 'paid')
 100         #~ JOIN membership_membership_line ml ON (ml.account_invoice_line = ail.id)
 101         #~ WHERE ml.date_from <= '%s'
 102         #~ AND ml.date_to >= '%s'
 103     #~ )
 104     #~ THEN 5
 105 #~ END END
 106 #~ AS state
 107 #~ FROM res_partner p
 108 #~ WHERE p.free_member
 109 #~ OR p.associate_member > 0
 110 #~ UNION
 111 #~ SELECT p.id as partner,
 112     #~ MAX(CASE WHEN ai.state = 'paid' THEN 2
 113     #~ ELSE 0
 114     #~ END)
 115 #~ AS state
 116 #~ FROM res_partner p
 117 #~ JOIN account_invoice ai ON (
 118     #~ p.id = ai.partner_id
 119 #~ )
 120 #~ JOIN account_invoice_line ail ON (
 121     #~ ail.invoice_id = ai.id
 122 #~ )
 123 #~ JOIN membership_membership_line ml ON (
 124     #~ ml.account_invoice_line  = ail.id
 125 #~ )
 126 #~ WHERE ml.date_from < '%s'
 127 #~ AND ml.date_to < '%s'
 128 #~ AND ml.date_from <= ml.date_to
 129 #~ GROUP BY
 130 #~ p.id
 131 #~ )
 132 #~ AS members
 133 #~ GROUP BY members.partner
 134 #~ )
 135 #~ AS final
 136 #~ %s
 137 #~ '''
 138
 139 class membership_line(osv.osv):
 140     '''Member line'''
 141
 142     def _check_membership_date(self, cr, uid, ids, context=None):
 143         '''Check if membership product is not in the past'''
 144
 145         cr.execute('''
 146          SELECT MIN(ml.date_to - ai.date_invoice)
 147          FROM membership_membership_line ml
 148          JOIN account_invoice_line ail ON (
 149             ml.account_invoice_line = ail.id
 150             )
 151         JOIN account_invoice ai ON (
 152             ai.id = ail.invoice_id)
 153         WHERE ml.id IN %s''',(tuple(ids),))
 154         res = cr.fetchall()
 155         for r in res:
 156             if r[0] and r[0] < 0:
 157                 return False
 158         return True
 159
 160     def _state(self, cr, uid, ids, name, args, context=None):
 161         '''Compute the state lines'''
 162         res = {}
 163         for line in self.browse(cr, uid, ids):
 164             cr.execute('''
 165             SELECT i.state, i.id FROM
 166             account_invoice i
 167             WHERE
 168             i.id = (
 169                 SELECT l.invoice_id FROM
 170                 account_invoice_line l WHERE
 171                 l.id = (
 172                     SELECT  ml.account_invoice_line FROM
 173                     membership_membership_line ml WHERE
 174                     ml.id = %s
 175                     )
 176                 )
 177             ''', (line.id,))
 178             fetched = cr.fetchone()
 179             if not fetched :
 180                 res[line.id] = 'canceled'
 181                 continue
 182             istate = fetched[0]
 183             state = 'none'
 184             if (istate == 'draft') | (istate == 'proforma'):
 185                 state = 'waiting'
 186             elif istate == 'open':
 187                 state = 'invoiced'
 188             elif istate == 'paid':
 189                 state = 'paid'
 190                 inv = self.pool.get('account.invoice').browse(cr, uid, fetched[1])
 191                 for payment in inv.payment_ids:
 192                     if payment.invoice and payment.invoice.type == 'out_refund':
 193                         state = 'canceled'
 194             elif istate == 'cancel':
 195                 state = 'canceled'
 196             res[line.id] = state
 197         return res
 198
 199
 200     _description = __doc__
 201     _name = 'membership.membership_line'
 202     _columns = {
 203             'partner': fields.many2one('res.partner', 'Partner', ondelete='cascade', select=1),
 204             'date_from': fields.date('From'),
 205             'date_to': fields.date('To'),
 206             'date_cancel' : fields.date('Cancel date'),
 207             'account_invoice_line': fields.many2one('account.invoice.line', 'Account Invoice line'),
 208             'state': fields.function(_state, method=True, string='State', type='selection', selection=STATE),
 209             }
 210     _rec_name = 'partner'
 211     _order = 'id desc'
 212     _constraints = [
 213             (_check_membership_date, 'Error, this membership product is out of date', [])
 214     ]
 215
 216 membership_line()
 217
 218
 219 class Partner(osv.osv):
 220     '''Partner'''
 221     _inherit = 'res.partner'
 222
 223     def _get_partner_id(self, cr, uid, ids, context=None):
 224
 225         data_inv = self.pool.get('membership.membership_line').browse(cr, uid, ids, context)
 226         list_partner = []
 227         for data in data_inv:
 228             list_partner.append(data.partner.id)
 229         ids2 = list_partner
 230         while ids2:
 231             ids2 = self.pool.get('res.partner').search(cr, uid, [('associate_member','in',ids2)], context=context)
 232             list_partner += ids2
 233         return list_partner
 234
 235     def _get_invoice_partner(self, cr, uid, ids, context=None):
 236         data_inv = self.pool.get('account.invoice').browse(cr, uid, ids, context)
 237         list_partner = []
 238         for data in data_inv:
 239             list_partner.append(data.partner_id.id)
 240         ids2 = list_partner
 241         while ids2:
 242             ids2 = self.pool.get('res.partner').search(cr, uid, [('associate_member','in',ids2)], context=context)
 243             list_partner += ids2
 244         return list_partner
 245
 246     def _membership_state(self, cr, uid, ids, name, args, context=None):
 247         res = {}
 248         for id in ids:
 249             res[id] = 'none'
 250         today = time.strftime('%Y-%m-%d')
 251         for id in ids:
 252             partner_data = self.browse(cr,uid,id)
 253             if partner_data.membership_cancel and today > partner_data.membership_cancel:
 254                 res[id] = 'canceled'
 255                 continue
 256             if partner_data.membership_stop and today > partner_data.membership_stop:
 257                 res[id] = 'old'
 258                 continue
 259             s = 4
 260             if partner_data.member_lines:
 261                 for mline in partner_data.member_lines:
 262                     if mline.date_to >= today:
 263                         if mline.account_invoice_line and mline.account_invoice_line.invoice_id:
 264                             mstate = mline.account_invoice_line.invoice_id.state
 265                             if mstate == 'paid':
 266                                 s = 0
 267                                 inv = mline.account_invoice_line.invoice_id
 268                                 for payment in inv.payment_ids:
 269                                     if payment.invoice.type == 'out_refund':
 270                                         s = 2
 271                                 break
 272                             elif mstate == 'open' and s!=0:
 273                                 s = 1
 274                             elif mstate == 'cancel' and s!=0 and s!=1:
 275                                 s = 2
 276                             elif  (mstate == 'draft' or mstate == 'proforma') and s!=0 and s!=1:
 277                                 s = 3
 278                 if s==4:
 279                     for mline in partner_data.member_lines:
 280                         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':
 281                             s = 5
 282                         else:
 283                             s = 6
 284                 if s==0:
 285                     res[id] = 'paid'
 286                 elif s==1:
 287                     res[id] = 'invoiced'
 288                 elif s==2:
 289                     res[id] = 'canceled'
 290                 elif s==3:
 291                     res[id] = 'waiting'
 292                 elif s==5:
 293                     res[id] = 'old'
 294                 elif s==6:
 295                     res[id] = 'none'
 296             if partner_data.free_member and s!=0:
 297                 res[id] = 'free'
 298             if partner_data.associate_member:
 299                 res_state = self._membership_state(cr, uid, [partner_data.associate_member.id], name, args, context)
 300                 res[id] = res_state[partner_data.associate_member.id]
 301         return res
 302
 303     def _membership_date(self, cr, uid, ids, name, args, context=None):
 304
 305         '''Return  date of membership'''
 306
 307         name = name[0]
 308         res = {}
 309         member_line_obj = self.pool.get('membership.membership_line')
 310
 311         for partner in self.browse(cr, uid, ids):
 312
 313             if partner.associate_member:
 314                  partner_id = partner.associate_member.id
 315             else:
 316                  partner_id = partner.id
 317
 318             res[partner.id]={
 319                              'membership_start': False,
 320                              'membership_stop': False,
 321                              'membership_cancel': False
 322                              }
 323
 324             if name == 'membership_start':
 325                 line_id = member_line_obj.search(cr, uid, [('partner', '=', partner_id)],
 326                             limit=1, order='date_from')
 327                 if line_id:
 328                         res[partner.id]['membership_start'] = member_line_obj.read(cr, uid, line_id[0],
 329                                 ['date_from'])['date_from']
 330
 331             if name == 'membership_stop':
 332                 line_id1 = member_line_obj.search(cr, uid, [('partner', '=', partner_id)],
 333                             limit=1, order='date_to desc')
 334                 if line_id1:
 335                       res[partner.id]['membership_stop'] = member_line_obj.read(cr, uid, line_id1[0],
 336                                 ['date_to'])['date_to']
 337             if name == 'membership_cancel':
 338                 if partner.membership_state == 'canceled':
 339                     line_id2 = member_line_obj.search(cr, uid, [('partner', '=', partner.id)],limit=1, order='date_cancel')
 340                     if line_id2:
 341                         res[partner.id]['membership_cancel'] = member_line_obj.read(cr, uid, line_id2[0],['date_cancel'])['date_cancel']
 342
 343         return res
 344
 345     def _get_partners(self, cr, uid, ids, context={}):
 346         ids2 = ids
 347         while ids2:
 348             ids2 = self.search(cr, uid, [('associate_member','in',ids2)], context=context)
 349             ids+=ids2
 350         return ids
 351
 352     def __get_membership_state(self, *args, **kwargs):
 353         return self._membership_state(*args, **kwargs)
 354
 355     _columns = {
 356         'associate_member': fields.many2one('res.partner', 'Associate member'),
 357         'member_lines': fields.one2many('membership.membership_line', 'partner', 'Membership'),
 358         'member': fields.boolean('Member'),
 359         'free_member': fields.boolean('Free member'),
 360         'membership_amount': fields.float(
 361                     'Membership amount', digits=(16, 2),
 362                     help='The price negociated by the partner'),
 363         'membership_state': fields.function(
 364                     __get_membership_state, method = True,
 365                     string = 'Current membership state', type = 'selection',
 366                     selection = STATE ,store = {
 367                         'account.invoice':(_get_invoice_partner,['state'], 10),
 368                         'membership.membership_line':(_get_partner_id,['state'], 10),
 369                         'res.partner':(_get_partners, ['free_member', 'membership_state','associate_member'], 10)
 370                         }
 371                     ),
 372         'membership_start': fields.function(
 373                     _membership_date, method=True, multi='membeship_start',
 374                     string = 'Start membership date', type = 'date',
 375                     store = {
 376                         'account.invoice':(_get_invoice_partner,['state'], 10),
 377                         'membership.membership_line':(_get_partner_id,['state'], 10, ),
 378                         'res.partner':(lambda self,cr,uid,ids,c={}:ids, ['free_member'], 10)
 379                         }
 380                     ),
 381         'membership_stop': fields.function(
 382                     _membership_date, method = True,
 383                     string = 'Stop membership date', type = 'date', multi='membership_stop',
 384                     store = {
 385                         'account.invoice':(_get_invoice_partner,['state'], 10),
 386                         'membership.membership_line':(_get_partner_id,['state'], 10),
 387                         'res.partner':(lambda self,cr,uid,ids,c={}:ids, ['free_member'], 10)
 388                         }
 389                     ),
 390
 391         'membership_cancel': fields.function(
 392                     _membership_date, method = True,
 393                     string = 'Cancel membership date', type='date', multi='membership_cancel',
 394                     store = {
 395                         'account.invoice':(_get_invoice_partner,['state'], 11),
 396                         'membership.membership_line':(_get_partner_id,['state'], 10),
 397                         'res.partner':(lambda self,cr,uid,ids,c={}:ids, ['free_member'], 10)
 398                         }
 399                     ),
 400     }
 401     _defaults = {
 402         'free_member': lambda *a: False,
 403         'membership_cancel' : lambda *d : False,
 404     }
 405
 406     def _check_recursion(self, cr, uid, ids):
 407         level = 100
 408         while len(ids):
 409             cr.execute('select distinct associate_member from res_partner where id IN %s',(tuple(ids),))
 410             ids = filter(None, map(lambda x:x[0], cr.fetchall()))
 411             if not level:
 412                 return False
 413             level -= 1
 414         return True
 415
 416     _constraints = [
 417         (_check_recursion, 'Error ! You can not create recursive associated members.', ['associate_member'])
 418     ]
 419
 420     def copy(self, cr, uid, id, default=None, context=None):
 421         if default is None:
 422             default = {}
 423         if context is None:
 424             context = {}
 425         default = default.copy()
 426         default['member_lines'] = []
 427         return super(Partner, self).copy(cr, uid, id, default, context)
 428
 429 Partner()
 430
 431 class product_template(osv.osv):
 432     _inherit = 'product.template'
 433     _columns = {
 434             'member_price':fields.float('Member Price', digits_compute= dp.get_precision('Sale Price')),
 435             }
 436 product_template()
 437
 438 class Product(osv.osv):
 439
 440     def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
 441         if ('product' in context) and (context['product']=='membership_product'):
 442             model_data_ids_form = self.pool.get('ir.model.data').search(cr,user,[('model','=','ir.ui.view'),('name','in',['membership_products_form','membership_products_tree'])])
 443             resource_id_form = self.pool.get('ir.model.data').read(cr, user, model_data_ids_form, fields=['res_id','name'])
 444             dict_model={}
 445             for i in resource_id_form:
 446                 dict_model[i['name']]=i['res_id']
 447             if view_type=='form':
 448                 view_id = dict_model['membership_products_form']
 449             else:
 450                 view_id = dict_model['membership_products_tree']
 451         return super(Product,self).fields_view_get(cr, user, view_id, view_type, context, toolbar, submenu)
 452
 453     '''Product'''
 454     _inherit = 'product.product'
 455     _columns = {
 456             'membership': fields.boolean('Membership', help='Specify if this product is a membership product'),
 457             'membership_date_from': fields.date('Date from'),
 458             'membership_date_to': fields.date('Date to'),
 459 #           'member_price':fields.float('Member Price'),
 460             }
 461
 462     _defaults = {
 463             'membership': lambda *args: False
 464             }
 465 Product()
 466
 467
 468 class Invoice(osv.osv):
 469     '''Invoice'''
 470
 471     _inherit = 'account.invoice'
 472
 473     def action_cancel(self, cr, uid, ids, context=None):
 474         '''Create a 'date_cancel' on the membership_line object'''
 475         if context is None:
 476             context = {}
 477         member_line_obj = self.pool.get('membership.membership_line')
 478         today = time.strftime('%Y-%m-%d')
 479         for invoice in self.browse(cr, uid, ids):
 480             mlines = member_line_obj.search(cr, uid,
 481                     [('account_invoice_line','in',
 482                         [ l.id for l in invoice.invoice_line])], context)
 483             member_line_obj.write(cr, uid, mlines, {'date_cancel':today}, context)
 484         return super(Invoice, self).action_cancel(cr, uid, ids, context)
 485 Invoice()
 486
 487 class account_invoice_line(osv.osv):
 488     _inherit='account.invoice.line'
 489
 490     def write(self, cr, uid, ids, vals, context=None):
 491         if not context:
 492             context={}
 493         res = super(account_invoice_line, self).write(cr, uid, ids, vals, context=context)
 494         member_line_obj = self.pool.get('membership.membership_line')
 495         for line in self.browse(cr, uid, ids):
 496             if line.invoice_id.type == 'out_invoice':
 497                 ml_ids = member_line_obj.search(cr, uid, [('account_invoice_line','=',line.id)])
 498                 if line.product_id and line.product_id.membership and not ml_ids:
 499                     # Product line has changed to a membership product
 500                     date_from = line.product_id.membership_date_from
 501                     date_to = line.product_id.membership_date_to
 502                     if line.invoice_id.date_invoice > date_from and line.invoice_id.date_invoice < date_to:
 503                         date_from = line.invoice_id.date_invoice
 504                     line_id = member_line_obj.create(cr, uid, {
 505                         'partner': line.invoice_id.partner_id.id,
 506                         'date_from': date_from,
 507                         'date_to': date_to,
 508                         'account_invoice_line': line.id,
 509                         })
 510                 if line.product_id and not line.product_id.membership and ml_ids:
 511                     # Product line has changed to a non membership product
 512                     member_line_obj.unlink(cr, uid, ml_ids, context=context)
 513         return res
 514
 515     def unlink(self, cr, uid, ids, context=None):
 516         if not context:
 517             context={}
 518         member_line_obj = self.pool.get('membership.membership_line')
 519         for id in ids:
 520             ml_ids = member_line_obj.search(cr, uid, [('account_invoice_line','=',id)])
 521             member_line_obj.unlink(cr, uid, ml_ids, context=context)
 522         return super(account_invoice_line, self).unlink(cr, uid, ids, context=context)
 523
 524     def create(self, cr, uid, vals, context={}):
 525         result = super(account_invoice_line, self).create(cr, uid, vals, context)
 526         line = self.browse(cr, uid, result)
 527         if line.invoice_id.type == 'out_invoice':
 528             member_line_obj = self.pool.get('membership.membership_line')
 529             ml_ids = member_line_obj.search(cr, uid, [('account_invoice_line','=',line.id)])
 530             if line.product_id and line.product_id.membership and not ml_ids:
 531                 # Product line is a membership product
 532                 date_from = line.product_id.membership_date_from
 533                 date_to = line.product_id.membership_date_to
 534                 if line.invoice_id.date_invoice > date_from and line.invoice_id.date_invoice < date_to:
 535                     date_from = line.invoice_id.date_invoice
 536                 line_id = member_line_obj.create(cr, uid, {
 537                     'partner': line.invoice_id.partner_id and line.invoice_id.partner_id.id or False,
 538                     'date_from': date_from,
 539                     'date_to': date_to,
 540                     'account_invoice_line': line.id,
 541                     })
 542         return result
 543
 544 account_invoice_line()
 545 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: