addons/crm/crm_segmentation.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,orm
  23
  24 class crm_segmentation(osv.osv):
  25     '''
  26         A segmentation is a tool to automatically assign categories on partners.
  27         These assignations are based on criterions.
  28     '''
  29     _name = "crm.segmentation"
  30     _description = "Partner Segmentation"
  31
  32     _columns = {
  33         'name': fields.char('Name', size=64, required=True, help='The name of the segmentation.'),
  34         'description': fields.text('Description'),
  35         'categ_id': fields.many2one('res.partner.category', 'Partner Category',\
  36                          required=True, help='The partner category that will be \
  37 added to partners that match the segmentation criterions after computation.'),
  38         'exclusif': fields.boolean('Exclusive', help='Check if the category is limited to partners that match the segmentation criterions.\
  39                         \nIf checked, remove the category from partners that doesn\'t match segmentation criterions'),
  40         'state': fields.selection([('not running','Not Running'),\
  41                     ('running','Running')], 'Execution Status', readonly=True),
  42         'partner_id': fields.integer('Max Partner ID processed'),
  43         'segmentation_line': fields.one2many('crm.segmentation.line', \
  44                             'segmentation_id', 'Criteria', required=True),
  45         'sales_purchase_active': fields.boolean('Use The Sales Purchase Rules', help='Check if you want to use this tab as part of the segmentation rule. If not checked, the criteria beneath will be ignored')
  46     }
  47     _defaults = {
  48         'partner_id': lambda *a: 0,
  49         'state': lambda *a: 'not running',
  50     }
  51
  52     def process_continue(self, cr, uid, ids, start=False):
  53
  54         """ @param self: The object pointer
  55             @param cr: the current row, from the database cursor,
  56             @param uid: the current user’s ID for security checks,
  57             @param ids: List of Process continue’s IDs"""
  58
  59         categs = self.read(cr, uid, ids, ['categ_id', 'exclusif', 'partner_id',\
  60                                  'sales_purchase_active', 'profiling_active'])
  61         for categ in categs:
  62             if start:
  63                 if categ['exclusif']:
  64                     cr.execute('delete from res_partner_res_partner_category_rel \
  65                             where category_id=%s', (categ['categ_id'][0],))
  66
  67             id = categ['id']
  68
  69             cr.execute('select id from res_partner order by id ')
  70             partners = [x[0] for x in cr.fetchall()]
  71
  72             if categ['sales_purchase_active']:
  73                 to_remove_list=[]
  74                 cr.execute('select id from crm_segmentation_line where segmentation_id=%s', (id,))
  75                 line_ids = [x[0] for x in cr.fetchall()]
  76
  77                 for pid in partners:
  78                     if (not self.pool.get('crm.segmentation.line').test(cr, uid, line_ids, pid)):
  79                         to_remove_list.append(pid)
  80                 for pid in to_remove_list:
  81                     partners.remove(pid)
  82
  83             for partner_id in partners:
  84                 cr.execute('insert into res_partner_res_partner_category_rel (category_id,partner_id) \
  85                         values (%s,%s)', (categ['categ_id'][0], partner_id))
  86
  87             self.write(cr, uid, [id], {'state':'not running', 'partner_id':0})
  88         return True
  89
  90     def process_stop(self, cr, uid, ids, *args):
  91
  92         """ @param self: The object pointer
  93             @param cr: the current row, from the database cursor,
  94             @param uid: the current user’s ID for security checks,
  95             @param ids: List of Process stop’s IDs"""
  96
  97         return self.write(cr, uid, ids, {'state':'not running', 'partner_id':0})
  98
  99     def process_start(self, cr, uid, ids, *args):
 100
 101         """ @param self: The object pointer
 102             @param cr: the current row, from the database cursor,
 103             @param uid: the current user’s ID for security checks,
 104             @param ids: List of Process start’s IDs """
 105
 106         self.write(cr, uid, ids, {'state':'running', 'partner_id':0})
 107         return self.process_continue(cr, uid, ids, start=True)
 108 crm_segmentation()
 109
 110 class crm_segmentation_line(osv.osv):
 111     """ Segmentation line """
 112     _name = "crm.segmentation.line"
 113     _description = "Segmentation line"
 114
 115     _columns = {
 116         'name': fields.char('Rule Name', size=64, required=True),
 117         'segmentation_id': fields.many2one('crm.segmentation', 'Segmentation'),
 118         'expr_name': fields.selection([('sale','Sale Amount'),
 119                         ('purchase','Purchase Amount')], 'Control Variable', size=64, required=True),
 120         'expr_operator': fields.selection([('<','<'),('=','='),('>','>')], 'Operator', required=True),
 121         'expr_value': fields.float('Value', required=True),
 122         'operator': fields.selection([('and','Mandatory Expression'),\
 123                         ('or','Optional Expression')],'Mandatory / Optional', required=True),
 124     }
 125     _defaults = {
 126         'expr_name': lambda *a: 'sale',
 127         'expr_operator': lambda *a: '>',
 128         'operator': lambda *a: 'and'
 129     }
 130     def test(self, cr, uid, ids, partner_id):
 131
 132         """ @param self: The object pointer
 133             @param cr: the current row, from the database cursor,
 134             @param uid: the current user’s ID for security checks,
 135             @param ids: List of Test’s IDs """
 136
 137         expression = {'<': lambda x,y: x<y, '=':lambda x,y:x==y, '>':lambda x,y:x>y}
 138         ok = False
 139         lst = self.read(cr, uid, ids)
 140         for l in lst:
 141             cr.execute('select * from ir_module_module where name=%s and state=%s', ('account','installed'))
 142             if cr.fetchone():
 143                 if l['expr_name']=='sale':
 144                     cr.execute('SELECT SUM(l.price_unit * l.quantity) ' \
 145                             'FROM account_invoice_line l, account_invoice i ' \
 146                             'WHERE (l.invoice_id = i.id) ' \
 147                                 'AND i.partner_id = %s '\
 148                                 'AND i.type = \'out_invoice\'',
 149                             (partner_id,))
 150                     value = cr.fetchone()[0] or 0.0
 151                     cr.execute('SELECT SUM(l.price_unit * l.quantity) ' \
 152                             'FROM account_invoice_line l, account_invoice i ' \
 153                             'WHERE (l.invoice_id = i.id) ' \
 154                                 'AND i.partner_id = %s '\
 155                                 'AND i.type = \'out_refund\'',
 156                             (partner_id,))
 157                     value -= cr.fetchone()[0] or 0.0
 158                 elif l['expr_name']=='purchase':
 159                     cr.execute('SELECT SUM(l.price_unit * l.quantity) ' \
 160                             'FROM account_invoice_line l, account_invoice i ' \
 161                             'WHERE (l.invoice_id = i.id) ' \
 162                                 'AND i.partner_id = %s '\
 163                                 'AND i.type = \'in_invoice\'',
 164                             (partner_id,))
 165                     value = cr.fetchone()[0] or 0.0
 166                     cr.execute('SELECT SUM(l.price_unit * l.quantity) ' \
 167                             'FROM account_invoice_line l, account_invoice i ' \
 168                             'WHERE (l.invoice_id = i.id) ' \
 169                                 'AND i.partner_id = %s '\
 170                                 'AND i.type = \'in_refund\'',
 171                             (partner_id,))
 172                     value -= cr.fetchone()[0] or 0.0
 173                 res = expression[l['expr_operator']](value, l['expr_value'])
 174                 if (not res) and (l['operator']=='and'):
 175                     return False
 176                 if res:
 177                     return True
 178         return True
 179
 180 crm_segmentation_line()
 181
 182 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 183