addons/crm/crm.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-today OpenERP SA (<http://www.openerp.com>)
   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 base64
  23 import time
  24 from lxml import etree
  25 from osv import fields
  26 from osv import osv
  27 import tools
  28 from tools.translate import _
  29
  30 MAX_LEVEL = 15
  31 AVAILABLE_STATES = [
  32     ('draft', 'New'),
  33     ('cancel', 'Cancelled'),
  34     ('open', 'In Progress'),
  35     ('pending', 'Pending'),
  36     ('done', 'Closed')
  37 ]
  38
  39 AVAILABLE_PRIORITIES = [
  40     ('1', 'Highest'),
  41     ('2', 'High'),
  42     ('3', 'Normal'),
  43     ('4', 'Low'),
  44     ('5', 'Lowest'),
  45 ]
  46
  47 class crm_case_channel(osv.osv):
  48     _name = "crm.case.channel"
  49     _description = "Channels"
  50     _order = 'name'
  51     _columns = {
  52         'name': fields.char('Channel Name', size=64, required=True),
  53         'active': fields.boolean('Active'),
  54     }
  55     _defaults = {
  56         'active': lambda *a: 1,
  57     }
  58
  59 class crm_case_stage(osv.osv):
  60     """ Model for case stages. This models the main stages of a document
  61         management flow. Main CRM objects (leads, opportunities, project
  62         issues, ...) will now use only stages, instead of state and stages.
  63         Stages are for example used to display the kanban view of records.
  64     """
  65     _name = "crm.case.stage"
  66     _description = "Stage of case"
  67     _rec_name = 'name'
  68     _order = "sequence"
  69
  70     _columns = {
  71         'name': fields.char('Stage Name', size=64, required=True, translate=True),
  72         'sequence': fields.integer('Sequence', help="Used to order stages. Lower is better."),
  73         'probability': fields.float('Probability (%)', required=True, help="This percentage depicts the default/average probability of the Case for this stage to be a success"),
  74         'on_change': fields.boolean('Change Probability Automatically', help="Setting this stage will change the probability automatically on the opportunity."),
  75         'requirements': fields.text('Requirements'),
  76         'section_ids':fields.many2many('crm.case.section', 'section_stage_rel', 'stage_id', 'section_id', string='Sections',
  77                         help="Link between stages and sales teams. When set, this limitate the current stage to the selected sales teams."),
  78         'state': fields.selection(AVAILABLE_STATES, 'Related Status', required=True,
  79             help="The status of your document will automatically change regarding the selected stage. " \
  80                 "For example, if a stage is related to the status 'Close', when your document reaches this stage, it is automatically closed."),
  81         'case_default': fields.boolean('Common to All Teams',
  82                         help="If you check this field, this stage will be proposed by default on each sales team. It will not assign this stage to existing teams."),
  83         'fold': fields.boolean('Hide in Views when Empty',
  84                         help="This stage is not visible, for example in status bar or kanban view, when there are no records in that stage to display."),
  85         'type': fields.selection([  ('lead','Lead'),
  86                                     ('opportunity', 'Opportunity'),
  87                                     ('both', 'Both')],
  88                                     string='Type', size=16, required=True,
  89                                     help="This field is used to distinguish stages related to Leads from stages related to Opportunities, or to specify stages available for both types."),
  90     }
  91
  92     _defaults = {
  93         'sequence': lambda *args: 1,
  94         'probability': lambda *args: 0.0,
  95         'state': 'open',
  96         'fold': False,
  97         'type': 'both',
  98         'case_default': True,
  99     }
 100
 101 class crm_case_section(osv.osv):
 102     """ Model for sales teams. """
 103     _name = "crm.case.section"
 104     _inherits = {'mail.alias': 'alias_id'}
 105     _inherit = "mail.thread"
 106     _description = "Sales Teams"
 107     _order = "complete_name"
 108
 109     def get_full_name(self, cr, uid, ids, field_name, arg, context=None):
 110         return  dict(self.name_get(cr, uid, ids, context=context))
 111
 112     _columns = {
 113         'name': fields.char('Sales Team', size=64, required=True, translate=True),
 114         'complete_name': fields.function(get_full_name, type='char', size=256, readonly=True, store=True),
 115         'code': fields.char('Code', size=8),
 116         'active': fields.boolean('Active', help="If the active field is set to "\
 117                         "true, it will allow you to hide the sales team without removing it."),
 118         'allow_unlink': fields.boolean('Allow Delete', help="Allows to delete non draft cases"),
 119         'change_responsible': fields.boolean('Reassign Escalated', help="When escalating to this team override the salesman with the team leader."),
 120         'user_id': fields.many2one('res.users', 'Team Leader'),
 121         'member_ids':fields.many2many('res.users', 'sale_member_rel', 'section_id', 'member_id', 'Team Members'),
 122         'reply_to': fields.char('Reply-To', size=64, help="The email address put in the 'Reply-To' of all emails sent by OpenERP about cases in this sales team"),
 123         'parent_id': fields.many2one('crm.case.section', 'Parent Team'),
 124         'child_ids': fields.one2many('crm.case.section', 'parent_id', 'Child Teams'),
 125         'resource_calendar_id': fields.many2one('resource.calendar', "Working Time", help="Used to compute open days"),
 126         'note': fields.text('Description'),
 127         'working_hours': fields.float('Working Hours', digits=(16,2 )),
 128         'stage_ids': fields.many2many('crm.case.stage', 'section_stage_rel', 'section_id', 'stage_id', 'Stages'),
 129         'alias_id': fields.many2one('mail.alias', 'Alias', ondelete="cascade", required=True,
 130                                     help="The email address associated with this team. New emails received will automatically "
 131                                          "create new leads assigned to the team."),
 132     }
 133
 134     def _get_stage_common(self, cr, uid, context):
 135         ids = self.pool.get('crm.case.stage').search(cr, uid, [('case_default','=',1)], context=context)
 136         return ids
 137
 138     _defaults = {
 139         'active': 1,
 140         'allow_unlink': 1,
 141         'stage_ids': _get_stage_common,
 142         'alias_domain': False, # always hide alias during creation
 143     }
 144
 145     _sql_constraints = [
 146         ('code_uniq', 'unique (code)', 'The code of the sales team must be unique !')
 147     ]
 148
 149     _constraints = [
 150         (osv.osv._check_recursion, 'Error ! You cannot create recursive Sales team.', ['parent_id'])
 151     ]
 152
 153     def name_get(self, cr, uid, ids, context=None):
 154         """Overrides orm name_get method"""
 155         if not isinstance(ids, list) :
 156             ids = [ids]
 157         res = []
 158         if not ids:
 159             return res
 160         reads = self.read(cr, uid, ids, ['name', 'parent_id'], context)
 161
 162         for record in reads:
 163             name = record['name']
 164             if record['parent_id']:
 165                 name = record['parent_id'][1] + ' / ' + name
 166             res.append((record['id'], name))
 167         return res
 168
 169     def create(self, cr, uid, vals, context=None):
 170         mail_alias = self.pool.get('mail.alias')
 171         if not vals.get('alias_id'):
 172             vals.pop('alias_name', None) # prevent errors during copy()
 173             alias_id = mail_alias.create_unique_alias(cr, uid,
 174                     {'alias_name': vals['name']},
 175                     model_name="crm.lead",
 176                     context=context)
 177             vals['alias_id'] = alias_id
 178         res = super(crm_case_section, self).create(cr, uid, vals, context)
 179         mail_alias.write(cr, uid, [vals['alias_id']], {'alias_defaults': {'section_id': res, 'type':'lead'}}, context)
 180         return res
 181
 182     def unlink(self, cr, uid, ids, context=None):
 183         # Cascade-delete mail aliases as well, as they should not exist without the sales team.
 184         mail_alias = self.pool.get('mail.alias')
 185         alias_ids = [team.alias_id.id for team in self.browse(cr, uid, ids, context=context) if team.alias_id ]
 186         res = super(crm_case_section, self).unlink(cr, uid, ids, context=context)
 187         mail_alias.unlink(cr, uid, alias_ids, context=context)
 188         return res
 189
 190 class crm_case_categ(osv.osv):
 191     """ Category of Case """
 192     _name = "crm.case.categ"
 193     _description = "Category of Case"
 194     _columns = {
 195         'name': fields.char('Name', size=64, required=True, translate=True),
 196         'section_id': fields.many2one('crm.case.section', 'Sales Team'),
 197         'object_id': fields.many2one('ir.model', 'Object Name'),
 198     }
 199
 200     def _find_object_id(self, cr, uid, context=None):
 201         """Finds id for case object"""
 202         object_id = context and context.get('object_id', False) or False
 203         ids = self.pool.get('ir.model').search(cr, uid, [('id', '=', object_id)])
 204         return ids and ids[0] or False
 205
 206     _defaults = {
 207         'object_id' : _find_object_id
 208     }
 209
 210 class crm_case_resource_type(osv.osv):
 211     """ Resource Type of case """
 212     _name = "crm.case.resource.type"
 213     _description = "Campaign"
 214     _rec_name = "name"
 215     _columns = {
 216         'name': fields.char('Campaign Name', size=64, required=True, translate=True),
 217         'section_id': fields.many2one('crm.case.section', 'Sales Team'),
 218     }
 219
 220 def _links_get(self, cr, uid, context=None):
 221     """Gets links value for reference field"""
 222     obj = self.pool.get('res.request.link')
 223     ids = obj.search(cr, uid, [])
 224     res = obj.read(cr, uid, ids, ['object', 'name'], context)
 225     return [(r['object'], r['name']) for r in res]
 226
 227 class crm_payment_mode(osv.osv):
 228     """ Payment Mode for Fund """
 229     _name = "crm.payment.mode"
 230     _description = "CRM Payment Mode"
 231     _columns = {
 232         'name': fields.char('Name', size=64, required=True),
 233         'section_id': fields.many2one('crm.case.section', 'Sales Team'),
 234     }
 235
 236 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: