remembership.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    Remembership module for OpenERP, Membership module enhancement and bug fixes
   5 #    Copyright (C) 2012-2013 L'Heureux Cyclage (<http://www.heureux-cyclage.org>)
   6 #
   7 #    This file is a part of Remembership
   8 #
   9 #    Remembership is free software: you can redistribute it and/or modify
  10 #    it under the terms of the GNU General Public License as published by
  11 #    the Free Software Foundation, either version 3 of the License, or
  12 #    (at your option) any later version.
  13 #
  14 #    Remembership is distributed in the hope that it will be useful,
  15 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 #    GNU General Public License for more details.
  18 #
  19 #    You should have received a copy of the GNU General Public License
  20 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 #
  22 ##############################################################################
  23
  24 from openerp.osv import osv
  25 from openerp.osv import fields
  26 import time
  27 from datetime import datetime, date
  28 from dateutil.relativedelta import relativedelta
  29 from openerp.tools.translate import _
  30
  31 STATE = [
  32     ('none', 'Non Member'),
  33     ('canceled', 'Cancelled Member'),
  34     ('old', 'Old Member'),
  35     ('waiting', 'Waiting Member'),
  36     ('invoiced', 'Invoiced Member'),
  37     ('free', 'Free Member'),
  38     ('paid', 'Paid Member'),
  39 ]
  40
  41 class Partner(osv.osv):
  42     _inherit = 'res.partner'
  43
  44     # XXX: copied from openerp/addons/membership/membership.py
  45     def _membership_date(self, cr, uid, ids, name, args, context=None):
  46         """Return  date of membership"""
  47         name = name[0]
  48         res = {}
  49         member_line_obj = self.pool.get('membership.membership_line')
  50         print ("DEV: [remembership] [_membership_date]")
  51         for partner in self.browse(cr, uid, ids, context=context):
  52             # XXX: commented part from openerp/addons/membership/membership.py
  53             #if partner.associate_member:
  54             #     partner_id = partner.associate_member.id
  55             #else:
  56             # NOTE: hmm, ça devrait être toujours partner.id
  57             partner_id = partner.id
  58             res[partner.id] = {
  59                  'membership_start': False,
  60                  'membership_stop': False,
  61                  'membership_cancel': False
  62             }
  63             if name == 'membership_start':
  64                 line_id = member_line_obj.search(cr, uid, [('partner', '=', partner_id),('date_cancel','=',False)],
  65                             limit=1, order='date_from', context=context)
  66                 if line_id:
  67                     res[partner.id]['membership_start'] = member_line_obj.read(cr, uid, line_id[0],
  68                             ['date_from'], context=context)['date_from']
  69                     if partner.associate_member:
  70                         print ("DEV: [_membership_date] [associate] date_from: %s" % str(res[partner.id]['membership_start']))
  71                     else:
  72                         print ("DEV: [_membership_date] date_from: %s" % str(res[partner.id]['membership_start']))
  73
  74             if name == 'membership_stop':
  75                 line_id1 = member_line_obj.search(cr, uid, [('partner', '=', partner_id),('date_cancel','=',False)],
  76                             limit=1, order='date_to desc', context=context)
  77                 if line_id1:
  78                     res[partner.id]['membership_stop'] = member_line_obj.read(cr, uid, line_id1[0],
  79                               ['date_to'], context=context)['date_to']
  80                     if partner.associate_member:
  81                         print ("DEV: [_membership_date] [associate] date_to: %s" % str(res[partner.id]['membership_stop']))
  82                     else:
  83                         print ("DEV: [_membership_date] date_to: %s" % str(res[partner.id]['membership_stop']))
  84
  85             if name == 'membership_cancel':
  86                 if partner.membership_state == 'canceled':
  87                     line_id2 = member_line_obj.search(cr, uid, [('partner', '=', partner.id)], limit=1, order='date_cancel', context=context)
  88                     if line_id2:
  89                         res[partner.id]['membership_cancel'] = member_line_obj.read(cr, uid, line_id2[0], ['date_cancel'], context=context)['date_cancel']
  90         return res
  91     # XXX: copied from openerp/addons/membership/membership.py
  92     def _get_partner_id(self, cr, uid, ids, context=None):
  93         member_line_obj = self.pool.get('membership.membership_line')
  94         res_obj =  self.pool.get('res.partner')
  95         data_inv = member_line_obj.browse(cr, uid, ids, context=context)
  96         list_partner = []
  97         for data in data_inv:
  98             list_partner.append(data.partner.id)
  99         ids2 = list_partner
 100         while ids2:
 101             ids2 = res_obj.search(cr, uid, [('associate_member', 'in', ids2)], context=context)
 102             list_partner += ids2
 103         return list_partner
 104     # XXX: copied from openerp/addons/membership/membership.py
 105     def _get_invoice_partner(self, cr, uid, ids, context=None):
 106         inv_obj = self.pool.get('account.invoice')
 107         res_obj = self.pool.get('res.partner')
 108         data_inv = inv_obj.browse(cr, uid, ids, context=context)
 109         list_partner = []
 110         for data in data_inv:
 111             list_partner.append(data.partner_id.id)
 112         ids2 = list_partner
 113         while ids2:
 114             ids2 = res_obj.search(cr, uid, [('associate_member', 'in', ids2)], context=context)
 115             list_partner += ids2
 116         return list_partner
 117
 118
 119     def __get_membership_state(self, cr, uid, ids, name, args, context=None):
 120         res = super(Partner, self).__get_membership_state(cr, uid, ids, name, args, context)
 121         today = time.strftime('%Y-%m-%d')
 122
 123         # special case when the partner is imported from a file,
 124         # in this case is has a valid membership line but
 125         # no payment information associated to it, consider it valid
 126         for id in ids:
 127             if res[id] == 'none':
 128
 129                 partner_data = self.browse(cr, uid, id, context=context)
 130
 131                 no_payment_info_at_all = True
 132                 valid_line = False
 133
 134                 for mline in partner_data.member_lines:
 135                     if mline.date_to >= today:
 136                         valid_line = True
 137
 138                     if mline.account_invoice_line:
 139                         no_payment_info_at_all = False
 140
 141                 if no_payment_info_at_all and valid_line:
 142                     res[id] = 'paid'
 143
 144         return res
 145
 146
 147     def _get_partners(self, *args, **kwargs):
 148         res = super(Partner, self.pool.get('res.partner'))._get_partners(*args, **kwargs)
 149         return res
 150
 151
 152     _columns = {
 153         'member_ident': fields.char('Member identifier', size=64),
 154         'associate_members': fields.one2many('res.partner', 'associate_member', 'Associate members', help='Members who are associated to this partner.'),
 155         # XXX: copied from openerp/addons/membership/membership.py
 156         'membership_state': fields.function(
 157                     __get_membership_state,
 158                     string = 'Current Membership Status', type = 'selection',
 159                     selection = STATE,
 160                     store = {
 161                         'account.invoice': (_get_invoice_partner, ['state'], 20),
 162                         'membership.membership_line': (_get_partner_id, ['state'], 20),
 163                         'res.partner': (_get_partners, ['free_member', 'membership_state', 'associate_member'], 20)
 164                     }, help="""It indicates the membership state.
 165                     -Non Member: A partner who has not applied for any membership.
 166                     -Cancelled Member: A member who has cancelled his membership.
 167                     -Old Member: A member whose membership date has expired.
 168                     -Waiting Member: A member who has applied for the membership and whose invoice is going to be created.
 169                     -Invoiced Member: A member whose invoice has been created.
 170                     -Paying member: A member who has paid the membership fee."""),
 171         # XXX: copied from openerp/addons/membership/membership.py
 172         'membership_start': fields.function(
 173                     _membership_date, multi = 'membership_start',
 174                     string = 'Membership Start Date', type = 'date',
 175                     store = {
 176                         'account.invoice': (_get_invoice_partner, ['state'], 10),
 177                         'membership.membership_line': (_get_partner_id, ['state'], 10, ),
 178                         'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['free_member'], 10)
 179                     }, help="Date from which membership becomes active."),
 180         # XXX: copied from openerp/addons/membership/membership.py
 181         'membership_stop': fields.function(
 182                     _membership_date,
 183                     string = 'Membership End Date', type='date', multi='membership_stop',
 184                     store = {
 185                         'account.invoice': (_get_invoice_partner, ['state'], 10),
 186                         'membership.membership_line': (_get_partner_id, ['state'], 10),
 187                         'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['free_member'], 10)
 188                     }, help="Date until which membership remains active."),
 189         # XXX: copied from openerp/addons/membership/membership.py
 190         'membership_cancel': fields.function(
 191                     _membership_date,
 192                     string = 'Cancel Membership Date', type='date', multi='membership_cancel',
 193                     store = {
 194                         'account.invoice': (_get_invoice_partner, ['state'], 11),
 195                         'membership.membership_line': (_get_partner_id, ['state'], 10),
 196                         'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['free_member'], 10)
 197                     }, help="Date on which membership has been cancelled"),
 198     }
 199
 200     _sql_constraints = [
 201         ('member_ident_uniq', 'unique(member_ident, company_id)', 'The member identifier must be unique !'),
 202     ]
 203
 204     def create_membership_invoice(self, cr, uid, ids, product_id=None, datas=None, context=None):
 205         # NOTE: use context to supply date_from to account_invoice_line.create
 206         context = context and context.copy() or {}
 207         context.update({'date_from': datas.get('date_from', None)});
 208         # XXX: copied from openerp/addons/membership/membership.py to fix account_invoice_line creation
 209         print ("DEV: [remembership] [partner] [create_membership_invoice] ids=%s" % str(ids))
 210         invoice_obj = self.pool.get('account.invoice')
 211         invoice_line_obj = self.pool.get('account.invoice.line')
 212         invoice_tax_obj = self.pool.get('account.invoice.tax')
 213         product_id = product_id or datas.get('membership_product_id', False)
 214         amount = datas.get('amount', 0.0)
 215         invoice_list = []
 216         if type(ids) in (int, long,):
 217             ids = [ids]
 218         for partner in self.browse(cr, uid, ids, context=context):
 219             print ("DEV: [remembership] [partner] [create_membership_invoice] ids=%s partner=%s" % (str(ids),str(partner.id)))
 220             account_id = partner.property_account_receivable and partner.property_account_receivable.id or False
 221             fpos_id = partner.property_account_position and partner.property_account_position.id or False
 222             addr = self.address_get(cr, uid, [partner.id], ['invoice'])
 223             if partner.free_member:
 224                 raise osv.except_osv(_('Error!'),
 225                         _("Partner is a free Member."))
 226             if not addr.get('invoice', False):
 227                 raise osv.except_osv(_('Error!'),
 228                         _("Partner doesn't have an address to make the invoice."))
 229             quantity = 1
 230             line_value =  {
 231                 'product_id': product_id,
 232             }
 233
 234             print ("DEV: [remembership] [partner] [create_membership_invoice] ids=%s partner=%s [invoice_line_obj] [product_id_change]" % (str(ids),str(partner.id)))
 235             line_dict = invoice_line_obj.product_id_change(cr, uid, {},
 236                             product_id, False, quantity, '', 'out_invoice', partner.id, fpos_id, price_unit=amount, context=context)
 237             line_value.update(line_dict['value'])
 238             line_value['price_unit'] = amount
 239             if line_value.get('invoice_line_tax_id', False):
 240                 tax_tab = [(6, 0, line_value['invoice_line_tax_id'])]
 241                 line_value['invoice_line_tax_id'] = tax_tab
 242
 243             print ("DEV: [remembership] [partner] [create_membership_invoice] ids=%s partner=%s [invoice_obj] [create] account=%s" % (str(ids),str(partner.id),str(account_id)))
 244             # NOTE: let account_invoice_obj.create() call account_invoice_line.create()
 245             #       to have a correct membership_state: becauce now fields.function 'store' watchdogs
 246             #       are triggered after account_invoice_line.create().
 247             invoice_id = invoice_obj.create(cr, uid, {
 248                 'partner_id': partner.id,
 249                 'account_id': account_id,
 250                 'fiscal_position': fpos_id or False,
 251                 'invoice_line':[(0, 0, line_value)]
 252                 }, context=context)
 253             #line_value['invoice_id'] = invoice_id
 254             #print ("DEV: [remembership] [partner] [create_membership_invoice] ids=%s partner=%s [invoice_line_obj] [create]" % (str(ids),str(partner.id)))
 255             #invoice_line_id = invoice_line_obj.create(cr, uid, line_value, context=context)
 256             #invoice_obj.write(cr, uid, invoice_id, {'invoice_line': line_value}, context=context)
 257             print ("DEV: [remembership] [partner] [create_membership_invoice] : invoice_list.append(invoice_id) : pre")
 258             invoice_list.append(invoice_id)
 259             print ("DEV: [remembership] [partner] [create_membership_invoice] : invoice_list.append(invoice_id) : post")
 260             if line_value['invoice_line_tax_id']:
 261                 tax_value = invoice_tax_obj.compute(cr, uid, invoice_id).values()
 262                 for tax in tax_value:
 263                        invoice_tax_obj.create(cr, uid, tax, context=context)
 264         # NOTE: this wasn't working, and is not needed now.
 265         #recompute the membership_state of those partners
 266         #print ("DEV: [remembership] [partner] [create_membership_invoice] ids=%s [recompute states]" % str(ids))
 267         #self.pool.get('res.partner').write(cr, uid, ids, {}, context=context)
 268         print ("DEV: [remembership] [partner] [create_membership_invoice] return=%s" % str(invoice_list))
 269         return invoice_list
 270
 271     def update_membership_status(self, cr, uid):
 272         """Action for updating old members status with scheduled cron job"""
 273         partner_obj = self.pool.get('res.partner')
 274         today = date.today()
 275         ids = partner_obj.search(cr, uid, [('membership_state', '=', 'paid'), ('membership_stop', '<', today)], context=None)
 276         self.write(cr, uid, ids, {'membership_state': 'old'}, context=None)
 277
 278 Partner()
 279
 280
 281 class Product(osv.osv):
 282     _inherit = 'product.product'
 283
 284     _columns = {
 285         'membership_grouped': fields.boolean('Grouped membership product', help='Check if it\'s a grouped membership product.'),
 286         'membership_date2date': fields.boolean('Date to date membership product', required=False, help='Check if it\'s a date to date membership product.'),
 287     }
 288
 289 Product()
 290
 291
 292 class account_invoice_line(osv.osv):
 293     _inherit = 'account.invoice.line'
 294
 295     def write(self, cr, uid, ids, vals, context=None):
 296         member_line_obj = self.pool.get('membership.membership_line')
 297         res = super(account_invoice_line, self).write(cr, uid, ids, vals, context=context)
 298         for line in self.browse(cr, uid, ids, context=context):
 299             if line.invoice_id.type == 'out_invoice':
 300                 ml_ids = member_line_obj.search(cr, uid, [('account_invoice_line', '=', line.id)], context=context)
 301                 if line.product_id and line.product_id.membership:
 302                     member_line_id = member_line_obj.search(cr, uid
 303                       , [('partner'             , '=', line.invoice_id.partner_id.id)
 304                         ,('account_invoice_line', '=', line.id)]
 305                       , limit=1
 306                       , context=context)
 307                     for member_line in member_line_obj.browse(cr, uid, member_line_id, context=context):
 308                       # NOTE: get member_line created in membership.account_invoice_line.create
 309                         date_from = member_line.date_from
 310                         date_to   = member_line.date_to
 311                         if line.product_id.membership_date2date:
 312                             date_from = ('date_from' in context
 313                               and context.get('date_from')
 314                               and datetime.strptime(context('date_from'), "%Y-%m-%d")
 315                               or date.today())
 316                             date_to   = date_from + relativedelta(months=+12, days=-1) # TODO: parameterize this delta?
 317                             date_from = date_from.strftime("%Y-%m-%d")
 318                             date_to   = date_to  .strftime("%Y-%m-%d")
 319                         print ("DEV: [remembership] [account_invoice_line] [write] date_from: %s" % str(date_from))
 320                         print ("DEV: [remembership] [account_invoice_line] [write] date_to  : %s" % str(date_to))
 321                         member_line_obj.write(cr, uid, member_line.id
 322                           , {'date_from': date_from
 323                             ,'date_to'  : date_to
 324                             }
 325                           , context=context)
 326                     if line.product_id.membership_grouped:
 327                         if line.invoice_id.partner_id.associate_members:
 328                             associate_member_line_ids = member_line_obj.search(cr, uid
 329                               , [ ('account_invoice_line', '=', line.id)
 330                                 , ('partner', '!=', line.invoice_id.partner_id.id)
 331                                 ]
 332                               , context=context)
 333                             for associate_member_line in member_line_obj.browse(cr, uid, associate_member_line_ids, context=context):
 334                                 print ("DEV: [remembership] [account_invoice_line] [write] [associate] date_from: %s" % str(date_from))
 335                                 print ("DEV: [remembership] [account_invoice_line] [write] [associate] date_to  : %s" % str(date_to))
 336                                 member_line_obj.write(cr, uid, associate_member_line.id
 337                                   , {'date_from': date_from
 338                                     ,'date_to'  : date_to
 339                                     }
 340                                   , context=context)
 341                         else:
 342                             print("DEV: mettre une contrainte pour l'objet\
 343                                   membership.membership_line interdisant les\
 344                                   adhésions groupées reliées à des partenaires\
 345                                   sans membres associés")
 346                     else:
 347                         associate_member_line_ids = member_line_obj.search(cr, uid
 348                           , [ ('account_invoice_line', '=', line.id)
 349                             , ('partner', '!=', line.invoice_id.partner_id.id)
 350                             ]
 351                           , context=context)
 352                         member_line_obj.unlink(cr, uid, associate_member_line_ids, context=context)
 353                     #Define member ident if it's necessary
 354                     partners = [line.invoice_id.partner_id]
 355                     if line.invoice_id.partner_id.associate_members:
 356                         partners.extend(line.invoice_id.partner_id.associate_members)
 357                     for i in partners:
 358                         if not i.member_ident:
 359                             mbr_id = self.pool.get('ir.sequence').get(cr, uid, 'member_ident')
 360                             self.pool.get('res.partner').write(cr, uid, i.id, {'member_ident': mbr_id})
 361                 if line.product_id and not line.product_id.membership and ml_ids:
 362                     # Product line has changed to a non membership product
 363                     member_line_obj.unlink(cr, uid, ml_ids, context=context)
 364         print ("DEV: [remembership] [account_invoice_line] [write] : return=%s" % str(res))
 365         return res
 366
 367     def create(self, cr, uid, vals, context=None):
 368         member_line_obj = self.pool.get('membership.membership_line')
 369         res = super(account_invoice_line, self).create(cr, uid, vals, context=context)
 370         print ("DEV: [remembership] [account_invoice_line] [create] : begin res=%s" % str(res))
 371         line = self.browse(cr, uid, res, context=context)
 372
 373         if line.invoice_id.type == 'out_invoice' and line.product_id and line.product_id.membership:
 374             member_line_id = member_line_obj.search(cr, uid
 375               , [('partner'             , '=', line.invoice_id.partner_id.id)
 376                 ,('account_invoice_line', '=', line.id)]
 377               , limit=1
 378               , context=context)
 379             for member_line in member_line_obj.browse(cr, uid, member_line_id, context=context):
 380               # NOTE: get member_line created in membership.account_invoice_line.create
 381                 date_from = member_line.date_from
 382                 date_to   = member_line.date_to
 383                 if line.product_id.membership_date2date:
 384                     date_from = ('date_from' in context
 385                       and context.get('date_from')
 386                       and datetime.strptime(context.get('date_from'), "%Y-%m-%d")
 387                       or date.today())
 388                     print("#DEBUG: Date de début - %s" % str(date_from))
 389                     date_to   = date_from + relativedelta(months=+12, days=-1) # TODO: parameterize this delta?
 390                     date_from = date_from.strftime("%Y-%m-%d")
 391                     date_to   = date_to  .strftime("%Y-%m-%d")
 392                 print ("DEV: [remembership] [account_invoice_line] [create] date_from: %s" % str(date_from))
 393                 print ("DEV: [remembership] [account_invoice_line] [create] date_to  : %s" % str(date_to))
 394                 member_line_obj.write(cr, uid, member_line.id
 395                   , {'date_from': date_from
 396                     ,'date_to'  : date_to
 397                     }
 398                   , context=context)
 399             partners = [line.invoice_id.partner_id]
 400             if line.product_id.membership_grouped and line.invoice_id.partner_id.associate_members:
 401                 partners.extend(line.invoice_id.partner_id.associate_members)
 402                 #Adding membership lines just for associate partners
 403                 for associate_member in line.invoice_id.partner_id.associate_members:
 404                     print ("DEV: [remembership] [account_invoice_line] [create] [associate] date_from: %s" % str(date_from))
 405                     print ("DEV: [remembership] [account_invoice_line] [create] [associate] date_to  : %s" % str(date_to))
 406                     member_line_obj.create(cr, uid, {
 407                         'partner': associate_member.id,
 408                         'membership_id': line.product_id.id,
 409                         'member_price': line.price_unit,
 410                         'date': time.strftime('%Y-%m-%d'),
 411                         'date_from': date_from,
 412                         'date_to': date_to,
 413                         'account_invoice_line': line.id,
 414                     }, context=context)
 415             elif line.product_id.membership_grouped and not line.invoice_id.partner_id.associate_members:
 416                 raise osv.except_osv(_('Error!!!'), _('You try to invoice grouped membership product to a partner who hasn\'t associated partners.'))
 417             #Define member ident if it's necessary
 418             for i in partners:
 419                 if not i.member_ident:
 420                     mbr_id = self.pool.get('ir.sequence').get(cr, uid, 'member_ident')
 421                     self.pool.get('res.partner').write(cr, uid, i.id, {'member_ident': mbr_id})
 422         print ("DEV: [remembership] [account_invoice_line] [create] : return=%s" % str(res))
 423         return res
 424
 425 account_invoice_line()
 426 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: