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