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 ##############################################################################
26 from osv import fields
28 from tools.translate import _
33 ('cancel', 'Cancelled'),
34 ('open', 'In Progress'),
35 ('pending', 'Pending'),
39 AVAILABLE_PRIORITIES = [
47 class crm_case_channel(osv.osv):
48 _name = "crm.case.channel"
49 _description = "Channels"
52 'name': fields.char('Channel Name', size=64, required=True),
53 'active': fields.boolean('Active'),
56 'active': lambda *a: 1,
59 class crm_case_stage(osv.osv):
62 _name = "crm.case.stage"
63 _description = "Stage of case"
68 'name': fields.char('Stage Name', size=64, required=True, translate=True),
69 'sequence': fields.integer('Sequence', help="Used to order stages."),
70 'probability': fields.float('Probability (%)', required=True, help="This percentage depicts the default/average probability of the Case for this stage to be a success"),
71 'on_change': fields.boolean('Change Probability Automatically', help="Setting this stage will change the probability automatically on the opportunity."),
72 'requirements': fields.text('Requirements'),
73 'section_ids':fields.many2many('crm.case.section', 'section_stage_rel', 'stage_id', 'section_id', 'Sections'),
74 'case_default': fields.boolean('Common to All Teams', 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."),
78 'sequence': lambda *args: 1,
79 'probability': lambda *args: 0.0,
82 class crm_case_section(osv.osv):
85 _name = "crm.case.section"
86 _description = "Sales Teams"
87 _order = "complete_name"
89 def get_full_name(self, cr, uid, ids, field_name, arg, context=None):
90 return dict(self.name_get(cr, uid, ids, context=context))
93 'name': fields.char('Sales Team', size=64, required=True, translate=True),
94 'complete_name': fields.function(get_full_name, type='char', size=256, readonly=True, store=True),
95 'code': fields.char('Code', size=8),
96 'active': fields.boolean('Active', help="If the active field is set to "\
97 "true, it will allow you to hide the sales team without removing it."),
98 'allow_unlink': fields.boolean('Allow Delete', help="Allows to delete non draft cases"),
99 'change_responsible': fields.boolean('Reassign Escalated', help="When escalating to this team override the saleman with the team leader."),
100 'user_id': fields.many2one('res.users', 'Team Leader'),
101 'member_ids':fields.many2many('res.users', 'sale_member_rel', 'section_id', 'member_id', 'Team Members'),
102 '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"),
103 'parent_id': fields.many2one('crm.case.section', 'Parent Team'),
104 'child_ids': fields.one2many('crm.case.section', 'parent_id', 'Child Teams'),
105 'resource_calendar_id': fields.many2one('resource.calendar', "Working Time", help="Used to compute open days"),
106 'note': fields.text('Description'),
107 'working_hours': fields.float('Working Hours', digits=(16,2 )),
108 'stage_ids': fields.many2many('crm.case.stage', 'section_stage_rel', 'section_id', 'stage_id', 'Stages'),
110 def _get_stage_common(self, cr, uid, context):
111 ids = self.pool.get('crm.case.stage').search(cr, uid, [('case_default','=',1)], context=context)
115 'active': lambda *a: 1,
116 'allow_unlink': lambda *a: 1,
117 'stage_ids': _get_stage_common
121 ('code_uniq', 'unique (code)', 'The code of the sales team must be unique !')
125 (osv.osv._check_recursion, 'Error ! You cannot create recursive Sales team.', ['parent_id'])
128 def name_get(self, cr, uid, ids, context=None):
129 """Overrides orm name_get method"""
130 if not isinstance(ids, list) :
135 reads = self.read(cr, uid, ids, ['name', 'parent_id'], context)
138 name = record['name']
139 if record['parent_id']:
140 name = record['parent_id'][1] + ' / ' + name
141 res.append((record['id'], name))
144 class crm_case_categ(osv.osv):
145 """ Category of Case """
146 _name = "crm.case.categ"
147 _description = "Category of Case"
149 'name': fields.char('Name', size=64, required=True, translate=True),
150 'section_id': fields.many2one('crm.case.section', 'Sales Team'),
151 'object_id': fields.many2one('ir.model', 'Object Name'),
154 def _find_object_id(self, cr, uid, context=None):
155 """Finds id for case object"""
156 object_id = context and context.get('object_id', False) or False
157 ids = self.pool.get('ir.model').search(cr, uid, [('id', '=', object_id)])
158 return ids and ids[0] or False
161 'object_id' : _find_object_id
164 class crm_case_resource_type(osv.osv):
165 """ Resource Type of case """
166 _name = "crm.case.resource.type"
167 _description = "Campaign"
170 'name': fields.char('Campaign Name', size=64, required=True, translate=True),
171 'section_id': fields.many2one('crm.case.section', 'Sales Team'),
174 class crm_base(object):
175 """ Base utility mixin class for crm objects,
176 Object subclassing this should define colums:
182 def _get_default_partner_address(self, cr, uid, context=None):
183 """Gives id of default address for current user
184 :param context: if portal in context is false return false anyway
188 if not context.get('portal'):
190 # was user.address_id.id, but address_id has been removed
191 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
192 if hasattr(user, 'partner_address_id') and user.partner_address_id:
193 return user.partner_address_id
196 def _get_default_partner(self, cr, uid, context=None):
197 """Gives id of partner for current user
198 :param context: if portal in context is false return false anyway
202 if not context.get('portal', False):
204 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
205 if hasattr(user, 'partner_address_id') and user.partner_address_id:
206 return user.partner_address_id
207 return user.company_id.partner_id.id
209 def _get_default_email(self, cr, uid, context=None):
210 """Gives default email address for current user
211 :param context: if portal in context is false return false anyway
213 if not context.get('portal', False):
215 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
216 return user.user_email
218 def _get_default_user(self, cr, uid, context=None):
219 """Gives current user id
220 :param context: if portal in context is false return false anyway
222 if context and context.get('portal', False):
226 def _get_section(self, cr, uid, context=None):
227 """Gives section id for current User
229 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
230 return user.context_section_id.id or False
232 def onchange_partner_address_id(self, cr, uid, ids, add, email=False):
233 """This function returns value of partner email based on Partner Address
234 :param ids: List of case IDs
235 :param add: Id of Partner's address
236 :param email: Partner's email ID
238 data = {'value': {'email_from': False, 'phone':False}}
240 address = self.pool.get('res.partner').browse(cr, uid, add)
241 data['value'] = {'email_from': address and address.email or False ,
242 'phone': address and address.phone or False}
243 if 'phone' not in self._columns:
244 del data['value']['phone']
247 def onchange_partner_id(self, cr, uid, ids, part, email=False):
248 """This function returns value of partner address based on partner
249 :param ids: List of case IDs
250 :param part: Partner's id
251 :param email: Partner's email ID
255 addr = self.pool.get('res.partner').address_get(cr, uid, [part], ['contact'])
256 data.update(self.onchange_partner_address_id(cr, uid, ids, addr['contact'])['value'])
257 return {'value': data}
259 def case_get_note_msg_prefix(self, cr, uid, id, context=None):
262 def case_open_send_note(self, cr, uid, ids, context=None):
264 msg = '%s has been <b>opened</b>.' % (self.case_get_note_msg_prefix(cr, uid, id, context=context))
265 self.message_append_note(cr, uid, [id], body=msg, context=context)
268 def case_close_send_note(self, cr, uid, ids, context=None):
270 msg = '%s has been <b>closed</b>.'% (self.case_get_note_msg_prefix(cr, uid, id, context=context))
271 self.message_append_note(cr, uid, [id], body=msg, context=context)
274 def case_cancel_send_note(self, cr, uid, ids, context=None):
276 msg = '%s has been <b>canceled</b>.' % (self.case_get_note_msg_prefix(cr, uid, id, context=context))
277 self.message_append_note(cr, uid, [id], body=msg, context=context)
280 def case_pending_send_note(self, cr, uid, ids, context=None):
282 msg = '%s is now <b>pending</b>.' % (self.case_get_note_msg_prefix(cr, uid, id, context=context))
283 self.message_append_note(cr, uid, [id], body=msg, context=context)
286 def case_reset_send_note(self, cr, uid, ids, context=None):
288 msg = '%s has been <b>renewed</b>.' % (self.case_get_note_msg_prefix(cr, uid, id, context=context))
289 self.message_append_note(cr, uid, [id], body=msg, context=context)
292 def case_open(self, cr, uid, ids, context=None):
294 :param ids: List of case Ids
296 cases = self.browse(cr, uid, ids)
298 data = {'state': 'open', 'active': True}
300 data['user_id'] = uid
301 self.write(cr, uid, [case.id], data)
302 self.case_open_send_note(cr, uid, ids, context=context)
303 self._action(cr, uid, cases, 'open')
307 def case_close(self, cr, uid, ids, context=None):
309 :param ids: List of case Ids
311 cases = self.browse(cr, uid, ids)
312 cases[0].state # to fill the browse record cache
313 self.write(cr, uid, ids, {'state': 'done', 'date_closed': time.strftime('%Y-%m-%d %H:%M:%S'), })
314 # We use the cache of cases to keep the old case state
315 self.case_close_send_note(cr, uid, ids, context=context)
316 self._action(cr, uid, cases, 'done')
319 def case_cancel(self, cr, uid, ids, context=None):
321 :param ids: List of case Ids
323 cases = self.browse(cr, uid, ids)
324 cases[0].state # to fill the browse record cache
325 self.write(cr, uid, ids, {'state': 'cancel', 'active': True})
326 # We use the cache of cases to keep the old case state
327 self.case_cancel_send_note(cr, uid, ids, context=context)
328 self._action(cr, uid, cases, 'cancel')
331 def case_pending(self, cr, uid, ids, context=None):
332 """Marks case as pending
333 :param ids: List of case Ids
335 cases = self.browse(cr, uid, ids)
336 cases[0].state # to fill the browse record cache
337 self.write(cr, uid, ids, {'state': 'pending', 'active': True})
338 self.case_pending_send_note(cr, uid, ids, context=context)
339 self._action(cr, uid, cases, 'pending')
342 def case_reset(self, cr, uid, ids, context=None):
343 """Resets case as draft
344 :param ids: List of case Ids
346 cases = self.browse(cr, uid, ids)
347 cases[0].state # to fill the browse record cache
348 self.write(cr, uid, ids, {'state': 'draft', 'active': True})
349 self.case_reset_send_note(cr, uid, ids, context=context)
350 self._action(cr, uid, cases, 'draft')
353 def _action(self, cr, uid, cases, state_to, scrit=None, context=None):
356 context['state_to'] = state_to
357 rule_obj = self.pool.get('base.action.rule')
358 model_obj = self.pool.get('ir.model')
359 model_ids = model_obj.search(cr, uid, [('model','=',self._name)])
360 rule_ids = rule_obj.search(cr, uid, [('model_id','=',model_ids[0])])
361 return rule_obj._action(cr, uid, rule_ids, cases, scrit=scrit, context=context)
363 class crm_case(crm_base):
364 """ A simple python class to be used for common functions
365 Object that inherit from this class should inherit from mailgate.thread
366 And need a stage_id field
367 And object that inherit (orm inheritance) from a class the overwrite copy
370 def stage_find(self, cr, uid, section_id, domain=[], order='sequence'):
371 domain = list(domain)
373 domain.append(('section_ids', '=', section_id))
374 stage_ids = self.pool.get('crm.case.stage').search(cr, uid, domain, order=order)
379 def stage_set(self, cr, uid, ids, stage_id, context=None):
381 if hasattr(self,'onchange_stage_id'):
382 value = self.onchange_stage_id(cr, uid, ids, stage_id)['value']
383 value['stage_id'] = stage_id
384 return self.write(cr, uid, ids, value, context=context)
386 def stage_change(self, cr, uid, ids, op, order, context=None):
389 for case in self.browse(cr, uid, ids, context=context):
392 seq = case.stage_id.sequence
395 section_id = case.section_id.id
396 next_stage_id = self.stage_find(cr, uid, section_id, [('sequence',op,seq)],order)
398 return self.stage_set(cr, uid, [case.id], next_stage_id, context=context)
401 def stage_next(self, cr, uid, ids, context=None):
402 """This function computes next stage for case from its current stage
403 using available stage for that case type
405 return self.stage_change(cr, uid, ids, '>','sequence', context)
407 def stage_previous(self, cr, uid, ids, context=None):
408 """This function computes previous stage for case from its current
409 stage using available stage for that case type
411 return self.stage_change(cr, uid, ids, '<', 'sequence desc', context)
413 def copy(self, cr, uid, id, default=None, context=None):
414 """Overrides orm copy method to avoid copying messages,
415 as well as date_closed and date_open columns if they
420 default.update({ 'message_ids': [], })
421 if hasattr(self, '_columns'):
422 if self._columns.get('date_closed'):
423 default.update({ 'date_closed': False, })
424 if self._columns.get('date_open'):
425 default.update({ 'date_open': False })
426 return super(crm_case, self).copy(cr, uid, id, default, context=context)
428 def case_escalate_send_note(self, cr, uid, ids, new_section=None, context=None):
431 msg = '%s has been <b>escalated</b> to <b>%s</b>.' % (self.case_get_note_msg_prefix(cr, uid, id, context=context), new_section.name)
433 msg = '%s has been <b>escalated</b>.' % (self.case_get_note_msg_prefix(cr, uid, id, context=context))
434 self.message_append_note(cr, uid, [id], 'System Notification', msg, context=context)
437 def case_get_note_msg_prefix(self, cr, uid, id, context=None):
440 def case_open(self, cr, uid, ids, context=None):
442 cases = self.browse(cr, uid, ids)
444 data = {'state': 'open', 'active': True }
446 data['user_id'] = uid
447 self.write(cr, uid, [case.id], data)
448 self.case_open_send_note(cr, uid, ids, context=context)
449 self._action(cr, uid, cases, 'open')
452 def case_close(self, cr, uid, ids, context=None):
454 cases = self.browse(cr, uid, ids)
455 cases[0].state # to fill the browse record cache
456 self.write(cr, uid, ids, {'state': 'done',
457 'date_closed': time.strftime('%Y-%m-%d %H:%M:%S'),
460 # We use the cache of cases to keep the old case state
462 self.case_close_send_note(cr, uid, ids, context=context)
463 self._action(cr, uid, cases, 'done')
466 def case_escalate(self, cr, uid, ids, context=None):
467 """Escalates case to parent level"""
468 cases = self.browse(cr, uid, ids)
470 data = {'active': True}
471 if case.section_id.parent_id:
472 data['section_id'] = case.section_id.parent_id.id
473 if case.section_id.parent_id.change_responsible:
474 if case.section_id.parent_id.user_id:
475 data['user_id'] = case.section_id.parent_id.user_id.id
477 raise osv.except_osv(_('Error !'), _('You can not escalate, you are already at the top level regarding your sales-team category.'))
478 self.write(cr, uid, [case.id], data)
479 case.case_escalate_send_note(case.section_id.parent_id)
480 cases = self.browse(cr, uid, ids)
481 self._action(cr, uid, cases, 'escalate')
484 def case_cancel(self, cr, uid, ids, context=None):
486 cases = self.browse(cr, uid, ids)
487 cases[0].state # to fill the browse record cache
488 self.write(cr, uid, ids, {'state': 'cancel',
490 self.case_cancel_send_note(cr, uid, ids, context=context)
491 self._action(cr, uid, cases, 'cancel')
494 def case_pending(self, cr, uid, ids, context=None):
495 """Marks case as pending"""
496 cases = self.browse(cr, uid, ids)
497 cases[0].state # to fill the browse record cache
498 self.write(cr, uid, ids, {'state': 'pending', 'active': True})
499 self.case_pending_send_note(cr, uid, ids, context=context)
500 self._action(cr, uid, cases, 'pending')
503 def case_reset(self, cr, uid, ids, context=None):
504 """Resets case as draft"""
506 cases = self.browse(cr, uid, ids)
507 cases[0].state # to fill the browse record cache
508 self.write(cr, uid, ids, {'state': state, 'active': True})
509 self.case_reset_send_note(cr, uid, ids, context=context)
510 self._action(cr, uid, cases, state)
513 def remind_partner(self, cr, uid, ids, context=None, attach=False):
514 return self.remind_user(cr, uid, ids, context, attach,
517 def remind_user(self, cr, uid, ids, context=None, attach=False, destination=True):
518 mail_message = self.pool.get('mail.message')
519 for case in self.browse(cr, uid, ids, context=context):
520 if not destination and not case.email_from:
522 if not case.user_id.user_email:
524 if destination and case.section_id.user_id:
525 case_email = case.section_id.user_id.user_email
527 case_email = case.user_id.user_email
530 dest = case.user_id.user_email or ""
531 body = case.description or ""
532 for message in case.message_ids:
533 if message.email_from and message.body_text:
534 body = message.body_text
538 src, dest = dest, case.email_from
539 if body and case.user_id.signature:
541 body += '\n\n%s' % (case.user_id.signature)
543 body = '\n\n%s' % (case.user_id.signature)
545 body = self.format_body(body)
550 attach_ids = self.pool.get('ir.attachment').search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', case.id)])
551 attach_to_send = self.pool.get('ir.attachment').read(cr, uid, attach_ids, ['datas_fname', 'datas'])
552 attach_to_send = dict(map(lambda x: (x['datas_fname'], base64.decodestring(x['datas'])), attach_to_send))
555 subject = "Reminder: [%s] %s" % (str(case.id), case.name, )
556 mail_message.schedule_with_attach(cr, uid,
562 reply_to=case.section_id.reply_to,
564 attachments=attach_to_send,
569 def _check(self, cr, uid, ids=False, context=None):
570 """Function called by the scheduler to process cases for date actions
571 Only works on not done and cancelled cases
573 cr.execute('select * from crm_case \
574 where (date_action_last<%s or date_action_last is null) \
575 and (date_action_next<=%s or date_action_next is null) \
576 and state not in (\'cancel\',\'done\')',
577 (time.strftime("%Y-%m-%d %H:%M:%S"),
578 time.strftime('%Y-%m-%d %H:%M:%S')))
580 ids2 = map(lambda x: x[0], cr.fetchall() or [])
581 cases = self.browse(cr, uid, ids2, context=context)
582 return self._action(cr, uid, cases, False, context=context)
584 def format_body(self, body):
585 return self.pool.get('base.action.rule').format_body(body)
587 def format_mail(self, obj, body):
588 return self.pool.get('base.action.rule').format_mail(obj, body)
590 def message_thread_followers(self, cr, uid, ids, context=None):
592 for case in self.browse(cr, uid, ids, context=context):
595 l.append(case.email_cc)
596 if case.user_id and case.user_id.user_email:
597 l.append(case.user_id.user_email)
601 def _links_get(self, cr, uid, context=None):
602 """Gets links value for reference field"""
603 obj = self.pool.get('res.request.link')
604 ids = obj.search(cr, uid, [])
605 res = obj.read(cr, uid, ids, ['object', 'name'], context)
606 return [(r['object'], r['name']) for r in res]
608 class users(osv.osv):
609 _inherit = 'res.users'
610 _description = "Users"
612 'context_section_id': fields.many2one('crm.case.section', 'Sales Team'),
615 def create(self, cr, uid, vals, context=None):
616 res = super(users, self).create(cr, uid, vals, context=context)
617 section_obj=self.pool.get('crm.case.section')
618 if vals.get('context_section_id'):
619 section_obj.write(cr, uid, [vals['context_section_id']], {'member_ids':[(4, res)]}, context)
624 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: