[IMP] improved code.
[odoo/odoo.git] / 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, 'State', required=True, help="The related state for the stage. The state of your document will automatically change regarding the selected stage. For example, if a stage is related to the state 'Close', when your document reaches this stage, it will be automatically have the 'closed' state."),
79         'case_default': fields.boolean('Common to All Teams',
80                         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."),
81         'fold': fields.boolean('Hide in Views when Empty',
82                         help="This stage is not visible, for example in status bar or kanban view, when there are no records in that stage to display."),
83         'type': fields.selection([  ('lead','Lead'),
84                                     ('opportunity', 'Opportunity'),
85                                     ('both', 'Both')],
86                                     string='Type', size=16, required=True,
87                                     help="This field is used to distinguish stages related to Leads from stages related to Opportunities, or to specify stages available for both types."),
88     }
89
90     _defaults = {
91         'sequence': lambda *args: 1,
92         'probability': lambda *args: 0.0,
93         'state': 'draft',
94         'fold': False,
95         'type': 'both',
96     }
97
98 class crm_case_section(osv.osv):
99     """ Model for sales teams. """
100     _name = "crm.case.section"
101     _inherits = {'mail.alias': 'alias_id'}
102     _description = "Sales Teams"
103     _order = "complete_name"
104
105     def get_full_name(self, cr, uid, ids, field_name, arg, context=None):
106         return  dict(self.name_get(cr, uid, ids, context=context))
107
108     _columns = {
109         'name': fields.char('Sales Team', size=64, required=True, translate=True),
110         'complete_name': fields.function(get_full_name, type='char', size=256, readonly=True, store=True),
111         'code': fields.char('Code', size=8),
112         'active': fields.boolean('Active', help="If the active field is set to "\
113                         "true, it will allow you to hide the sales team without removing it."),
114         'allow_unlink': fields.boolean('Allow Delete', help="Allows to delete non draft cases"),
115         'change_responsible': fields.boolean('Reassign Escalated', help="When escalating to this team override the saleman with the team leader."),
116         'user_id': fields.many2one('res.users', 'Team Leader'),
117         'member_ids':fields.many2many('res.users', 'sale_member_rel', 'section_id', 'member_id', 'Team Members'),
118         '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"),
119         'parent_id': fields.many2one('crm.case.section', 'Parent Team'),
120         'child_ids': fields.one2many('crm.case.section', 'parent_id', 'Child Teams'),
121         'resource_calendar_id': fields.many2one('resource.calendar', "Working Time", help="Used to compute open days"),
122         'note': fields.text('Description'),
123         'working_hours': fields.float('Working Hours', digits=(16,2 )),
124         'stage_ids': fields.many2many('crm.case.stage', 'section_stage_rel', 'section_id', 'stage_id', 'Stages'),
125         'alias_id': fields.many2one('mail.alias', 'Mail Alias', ondelete="cascade", required=True),
126     }
127     
128     def _get_stage_common(self, cr, uid, context):
129         ids = self.pool.get('crm.case.stage').search(cr, uid, [('case_default','=',1)], context=context)
130         return ids
131
132     _defaults = {
133         'active': lambda *a: 1,
134         'allow_unlink': lambda *a: 1,
135         'stage_ids': _get_stage_common
136     }
137
138     _sql_constraints = [
139         ('code_uniq', 'unique (code)', 'The code of the sales team must be unique !')
140     ]
141
142     _constraints = [
143         (osv.osv._check_recursion, 'Error ! You cannot create recursive Sales team.', ['parent_id'])
144     ]
145
146     def name_get(self, cr, uid, ids, context=None):
147         """Overrides orm name_get method"""
148         if not isinstance(ids, list) :
149             ids = [ids]
150         res = []
151         if not ids:
152             return res
153         reads = self.read(cr, uid, ids, ['name', 'parent_id'], context)
154
155         for record in reads:
156             name = record['name']
157             if record['parent_id']:
158                 name = record['parent_id'][1] + ' / ' + name
159             res.append((record['id'], name))
160         return res
161         
162     def fields_view_get(self, cr, uid, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
163         res = super(crm_case_section,self).fields_view_get(cr, uid, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
164         if view_type == 'form':
165             domain = self.pool.get("ir.config_parameter").get_param(cr, uid, "mail.catchall.domain", context=context)
166             if not domain:
167                 doc = etree.XML(res['arch'])
168                 alias_node = doc.xpath("//field[@name='alias_id']")[0]
169                 parent = alias_node.getparent()
170                 parent.remove(alias_node)
171                 res['arch'] = etree.tostring(doc)
172         return res
173     
174     def create(self, cr, uid, vals, context=None):
175         model_pool = self.pool.get('ir.model.data')
176         alias_pool = self.pool.get('mail.alias')
177         model, res_id = model_pool.get_object_reference( cr, uid, "crm", "model_crm_lead")
178         vals.update({'alias_name': "sales",
179                      'alias_model_id': res_id})
180         name = alias_pool.create_unique_alias(cr, uid, vals, context=context)
181         res = super(crm_case_section, self).create(cr, uid, vals, context)
182         record = self.read(cr, uid, res, context)
183         alias_pool.write(cr, uid, [record['alias_id']],{'alias_defaults':{'section_id':res,'type':'lead'}},context)
184         return res
185
186 class crm_case_categ(osv.osv):
187     """ Category of Case """
188     _name = "crm.case.categ"
189     _description = "Category of Case"
190     _columns = {
191         'name': fields.char('Name', size=64, required=True, translate=True),
192         'section_id': fields.many2one('crm.case.section', 'Sales Team'),
193         'object_id': fields.many2one('ir.model', 'Object Name'),
194     }
195
196     def _find_object_id(self, cr, uid, context=None):
197         """Finds id for case object"""
198         object_id = context and context.get('object_id', False) or False
199         ids = self.pool.get('ir.model').search(cr, uid, [('id', '=', object_id)])
200         return ids and ids[0] or False
201
202     _defaults = {
203         'object_id' : _find_object_id
204     }
205
206 class crm_case_resource_type(osv.osv):
207     """ Resource Type of case """
208     _name = "crm.case.resource.type"
209     _description = "Campaign"
210     _rec_name = "name"
211     _columns = {
212         'name': fields.char('Campaign Name', size=64, required=True, translate=True),
213         'section_id': fields.many2one('crm.case.section', 'Sales Team'),
214     }
215
216
217 def _links_get(self, cr, uid, context=None):
218     """Gets links value for reference field"""
219     obj = self.pool.get('res.request.link')
220     ids = obj.search(cr, uid, [])
221     res = obj.read(cr, uid, ids, ['object', 'name'], context)
222     return [(r['object'], r['name']) for r in res]
223
224 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: