1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
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.
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.
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/>.
20 ##############################################################################
24 from osv import fields, osv
25 import decimal_precision as dp
26 from tools.translate import _
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'),
48 class membership_line(osv.osv):
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
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
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
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
82 JOIN account_invoice ai ON (
83 ai.id = ail.invoice_id)
84 WHERE ml.id IN %s''', (tuple(ids),))
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
102 inv_obj = self.pool.get('account.invoice')
103 for line in self.browse(cr, uid, ids, context=context):
105 SELECT i.state, i.id FROM
109 SELECT l.invoice_id FROM
110 account_invoice_line l WHERE
112 SELECT ml.account_invoice_line FROM
113 membership_membership_line ml WHERE
118 fetched = cr.fetchone()
120 res[line.id] = 'canceled'
124 if (istate == 'draft') | (istate == 'proforma'):
126 elif istate == 'open':
128 elif istate == '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':
134 elif istate == 'cancel':
140 _description = __doc__
141 _name = 'membership.membership_line'
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('Member Price', digits_compute= dp.get_precision('Sale 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 State', 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 state.
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)
166 _rec_name = 'partner'
169 (_check_membership_date, 'Error, this membership product is out of date', [])
175 class Partner(osv.osv):
177 _inherit = 'res.partner'
179 def _get_partner_id(self, cr, uid, ids, context=None):
180 member_line_obj = self.pool.get('membership.membership_line')
181 res_obj = self.pool.get('res.partner')
182 data_inv = member_line_obj.browse(cr, uid, ids, context=context)
184 for data in data_inv:
185 list_partner.append(data.partner.id)
188 ids2 = res_obj.search(cr, uid, [('associate_member', 'in', ids2)], context=context)
192 def _get_invoice_partner(self, cr, uid, ids, context=None):
193 inv_obj = self.pool.get('account.invoice')
194 res_obj = self.pool.get('res.partner')
195 data_inv = inv_obj.browse(cr, uid, ids, context=context)
197 for data in data_inv:
198 list_partner.append(data.partner_id.id)
201 ids2 = res_obj.search(cr, uid, [('associate_member', 'in', ids2)], context=context)
205 def _membership_state(self, cr, uid, ids, name, args, context=None):
206 """This Function return Membership State For Given Partner.
207 @param self: The object pointer
208 @param cr: the current row, from the database cursor,
209 @param uid: the current user’s ID for security checks,
210 @param ids: List of Partner IDs
211 @param name: Field Name
212 @param context: A standard dictionary for contextual values
213 @param return: Dictionary of Membership state Value
218 today = time.strftime('%Y-%m-%d')
220 partner_data = self.browse(cr, uid, id, context=context)
221 if partner_data.membership_cancel and today > partner_data.membership_cancel:
224 if partner_data.membership_stop and today > partner_data.membership_stop:
228 if partner_data.member_lines:
229 for mline in partner_data.member_lines:
230 if mline.date_to >= today:
231 if mline.account_invoice_line and mline.account_invoice_line.invoice_id:
232 mstate = mline.account_invoice_line.invoice_id.state
235 inv = mline.account_invoice_line.invoice_id
236 for payment in inv.payment_ids:
237 if payment.invoice.type == 'out_refund':
240 elif mstate == 'open' and s!=0:
242 elif mstate == 'cancel' and s!=0 and s!=1:
244 elif (mstate == 'draft' or mstate == 'proforma') and s!=0 and s!=1:
247 for mline in partner_data.member_lines:
248 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':
264 if partner_data.free_member and s!=0:
266 if partner_data.associate_member:
267 res_state = self._membership_state(cr, uid, [partner_data.associate_member.id], name, args, context=context)
268 res[id] = res_state[partner_data.associate_member.id]
271 def _membership_date(self, cr, uid, ids, name, args, context=None):
272 """Return date of membership"""
275 member_line_obj = self.pool.get('membership.membership_line')
276 for partner in self.browse(cr, uid, ids, context=context):
277 if partner.associate_member:
278 partner_id = partner.associate_member.id
280 partner_id = partner.id
282 'membership_start': False,
283 'membership_stop': False,
284 'membership_cancel': False
286 if name == 'membership_start':
287 line_id = member_line_obj.search(cr, uid, [('partner', '=', partner_id),('date_cancel','=',False)],
288 limit=1, order='date_from', context=context)
290 res[partner.id]['membership_start'] = member_line_obj.read(cr, uid, line_id[0],
291 ['date_from'], context=context)['date_from']
293 if name == 'membership_stop':
294 line_id1 = member_line_obj.search(cr, uid, [('partner', '=', partner_id),('date_cancel','=',False)],
295 limit=1, order='date_to desc', context=context)
297 res[partner.id]['membership_stop'] = member_line_obj.read(cr, uid, line_id1[0],
298 ['date_to'], context=context)['date_to']
300 if name == 'membership_cancel':
301 if partner.membership_state == 'canceled':
302 line_id2 = member_line_obj.search(cr, uid, [('partner', '=', partner.id)], limit=1, order='date_cancel', context=context)
304 res[partner.id]['membership_cancel'] = member_line_obj.read(cr, uid, line_id2[0], ['date_cancel'], context=context)['date_cancel']
307 def _get_partners(self, cr, uid, ids, context=None):
310 ids2 = self.search(cr, uid, [('associate_member', 'in', ids2)], context=context)
314 def __get_membership_state(self, *args, **kwargs):
315 return self._membership_state(*args, **kwargs)
318 '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."),
319 'member_lines': fields.one2many('membership.membership_line', 'partner', 'Membership'),
320 'free_member': fields.boolean('Free Member', help = "Select if you want to give membership free of cost."),
321 'membership_amount': fields.float(
322 'Membership Amount', digits=(16, 2),
323 help = 'The price negotiated by the partner'),
324 'membership_state': fields.function(
325 __get_membership_state,
326 string = 'Current Membership State', type = 'selection',
329 'account.invoice': (_get_invoice_partner, ['state'], 10),
330 'membership.membership_line': (_get_partner_id, ['state'], 10),
331 'res.partner': (_get_partners, ['free_member', 'membership_state', 'associate_member'], 10)
332 }, help="""It indicates the membership state.
333 -Non Member: A member who has not applied for any membership.
334 -Cancelled Member: A member who has cancelled his membership.
335 -Old Member: A member whose membership date has expired.
336 -Waiting Member: A member who has applied for the membership and whose invoice is going to be created.
337 -Invoiced Member: A member whose invoice has been created.
338 -Paid Member: A member who has paid the membership amount."""),
339 'membership_start': fields.function(
340 _membership_date, multi = 'membeship_start',
341 string = 'Start Membership Date', type = 'date',
343 'account.invoice': (_get_invoice_partner, ['state'], 10),
344 'membership.membership_line': (_get_partner_id, ['state'], 10, ),
345 'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['free_member'], 10)
346 }, help="Date from which membership becomes active."),
347 'membership_stop': fields.function(
349 string = 'Stop Membership Date', type='date', multi='membership_stop',
351 'account.invoice': (_get_invoice_partner, ['state'], 10),
352 'membership.membership_line': (_get_partner_id, ['state'], 10),
353 'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['free_member'], 10)
354 }, help="Date until which membership remains active."),
355 'membership_cancel': fields.function(
357 string = 'Cancel Membership Date', type='date', multi='membership_cancel',
359 'account.invoice': (_get_invoice_partner, ['state'], 11),
360 'membership.membership_line': (_get_partner_id, ['state'], 10),
361 'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['free_member'], 10)
362 }, help="Date on which membership has been cancelled"),
365 'free_member': False,
366 'membership_cancel': False,
369 def _check_recursion(self, cr, uid, ids, context=None):
370 """Check Recursive for Associated Members.
374 cr.execute('SELECT DISTINCT associate_member FROM res_partner WHERE id IN %s', (tuple(ids),))
375 ids = filter(None, map(lambda x:x[0], cr.fetchall()))
382 (_check_recursion, 'Error ! You cannot create recursive associated members.', ['associate_member'])
385 def copy(self, cr, uid, id, default=None, context=None):
388 default = default.copy()
389 default['member_lines'] = []
390 return super(Partner, self).copy(cr, uid, id, default, context=context)
392 def create_membership_invoice(self, cr, uid, ids, product_id=None, datas=None, context=None):
393 """ Create Customer Invoice of Membership for partners.
394 @param datas: datas has dictionary value which consist Id of Membership product and Cost Amount of Membership.
395 datas = {'membership_product_id': None, 'amount': None}
397 invoice_obj = self.pool.get('account.invoice')
398 invoice_line_obj = self.pool.get('account.invoice.line')
399 invoice_tax_obj = self.pool.get('account.invoice.tax')
400 product_id = product_id or datas.get('membership_product_id', False)
401 amount = datas.get('amount', 0.0)
403 if type(ids) in (int, long,):
405 for partner in self.browse(cr, uid, ids, context=context):
406 account_id = partner.property_account_receivable and partner.property_account_receivable.id or False
407 fpos_id = partner.property_account_position and partner.property_account_position.id or False
408 addr = self.address_get(cr, uid, [partner.id], ['invoice'])
409 if partner.free_member:
410 raise osv.except_osv(_('Error !'),
411 _("Partner is a free Member."))
412 if not addr.get('invoice', False):
413 raise osv.except_osv(_('Error !'),
414 _("Partner doesn't have an address to make the invoice."))
417 'product_id': product_id,
420 line_dict = invoice_line_obj.product_id_change(cr, uid, {},
421 product_id, False, quantity, '', 'out_invoice', partner.id, fpos_id, price_unit=amount, context=context)
422 line_value.update(line_dict['value'])
423 line_value['price_unit'] = amount
424 if line_value.get('invoice_line_tax_id', False):
425 tax_tab = [(6, 0, line_value['invoice_line_tax_id'])]
426 line_value['invoice_line_tax_id'] = tax_tab
428 invoice_id = invoice_obj.create(cr, uid, {
429 'partner_id': partner.id,
430 'account_id': account_id,
431 'fiscal_position': fpos_id or False
433 line_value['invoice_id'] = invoice_id
434 invoice_line_id = invoice_line_obj.create(cr, uid, line_value, context=context)
435 invoice_obj.write(cr, uid, invoice_id, {'invoice_line': [(6, 0, [invoice_line_id])]}, context=context)
436 invoice_list.append(invoice_id)
437 if line_value['invoice_line_tax_id']:
438 tax_value = invoice_tax_obj.compute(cr, uid, invoice_id).values()
439 for tax in tax_value:
440 invoice_tax_obj.create(cr, uid, tax, context=context)
441 #recompute the membership_state of those partners
442 self.pool.get('res.partner').write(cr, uid, ids, {})
447 class product_template(osv.osv):
448 _inherit = 'product.template'
450 'member_price': fields.float('Member Price', digits_compute= dp.get_precision('Sale Price')),
455 class Product(osv.osv):
457 def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
458 model_obj = self.pool.get('ir.model.data')
462 if ('product' in context) and (context['product']=='membership_product'):
463 model_data_ids_form = model_obj.search(cr, user, [('model','=','ir.ui.view'), ('name', 'in', ['membership_products_form', 'membership_products_tree'])], context=context)
464 resource_id_form = model_obj.read(cr, user, model_data_ids_form, fields=['res_id', 'name'], context=context)
466 for i in resource_id_form:
467 dict_model[i['name']] = i['res_id']
468 if view_type == 'form':
469 view_id = dict_model['membership_products_form']
471 view_id = dict_model['membership_products_tree']
472 return super(Product,self).fields_view_get(cr, user, view_id, view_type, context, toolbar, submenu)
475 _inherit = 'product.product'
477 'membership': fields.boolean('Membership', help='Select if a product is a membership product.'),
478 'membership_date_from': fields.date('Date from', help='Date from which membership becomes active.'),
479 'membership_date_to': fields.date('Date to', help='Date until which membership remains active.'),
489 class Invoice(osv.osv):
491 _inherit = 'account.invoice'
493 def action_cancel(self, cr, uid, ids, *args):
494 '''Create a 'date_cancel' on the membership_line object'''
495 member_line_obj = self.pool.get('membership.membership_line')
496 today = time.strftime('%Y-%m-%d')
497 for invoice in self.browse(cr, uid, ids):
498 mlines = member_line_obj.search(cr, uid,
499 [('account_invoice_line', 'in',
500 [l.id for l in invoice.invoice_line])])
501 member_line_obj.write(cr, uid, mlines, {'date_cancel': today})
502 return super(Invoice, self).action_cancel(cr, uid, ids)
506 class account_invoice_line(osv.osv):
507 _inherit='account.invoice.line'
509 def write(self, cr, uid, ids, vals, context=None):
510 """Overrides orm write method
512 member_line_obj = self.pool.get('membership.membership_line')
513 res = super(account_invoice_line, self).write(cr, uid, ids, vals, context=context)
514 for line in self.browse(cr, uid, ids, context=context):
515 if line.invoice_id.type == 'out_invoice':
516 ml_ids = member_line_obj.search(cr, uid, [('account_invoice_line', '=', line.id)], context=context)
517 if line.product_id and line.product_id.membership and not ml_ids:
518 # Product line has changed to a membership product
519 date_from = line.product_id.membership_date_from
520 date_to = line.product_id.membership_date_to
521 if line.invoice_id.date_invoice > date_from and line.invoice_id.date_invoice < date_to:
522 date_from = line.invoice_id.date_invoice
523 member_line_obj.create(cr, uid, {
524 'partner': line.invoice_id.partner_id.id,
525 'membership_id': line.product_id.id,
526 'member_price': line.price_unit,
527 'date': time.strftime('%Y-%m-%d'),
528 'date_from': date_from,
530 'account_invoice_line': line.id,
532 if line.product_id and not line.product_id.membership and ml_ids:
533 # Product line has changed to a non membership product
534 member_line_obj.unlink(cr, uid, ml_ids, context=context)
537 def unlink(self, cr, uid, ids, context=None):
538 """Remove Membership Line Record for Account Invoice Line
540 member_line_obj = self.pool.get('membership.membership_line')
542 ml_ids = member_line_obj.search(cr, uid, [('account_invoice_line', '=', id)], context=context)
543 member_line_obj.unlink(cr, uid, ml_ids, context=context)
544 return super(account_invoice_line, self).unlink(cr, uid, ids, context=context)
546 def create(self, cr, uid, vals, context=None):
547 """Overrides orm create method
549 member_line_obj = self.pool.get('membership.membership_line')
550 result = super(account_invoice_line, self).create(cr, uid, vals, context=context)
551 line = self.browse(cr, uid, result, context=context)
552 if line.invoice_id.type == 'out_invoice':
553 ml_ids = member_line_obj.search(cr, uid, [('account_invoice_line', '=', line.id)], context=context)
554 if line.product_id and line.product_id.membership and not ml_ids:
555 # Product line is a membership product
556 date_from = line.product_id.membership_date_from
557 date_to = line.product_id.membership_date_to
558 if line.invoice_id.date_invoice > date_from and line.invoice_id.date_invoice < date_to:
559 date_from = line.invoice_id.date_invoice
560 member_line_obj.create(cr, uid, {
561 'partner': line.invoice_id.partner_id and line.invoice_id.partner_id.id or False,
562 'membership_id': line.product_id.id,
563 'member_price': line.price_unit,
564 'date': time.strftime('%Y-%m-%d'),
565 'date_from': date_from,
567 'account_invoice_line': line.id,
571 account_invoice_line()
573 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: