# -*- coding: utf-8 -*- ############################################################################## # # OpenERP, Open Source Management Solution # Copyright (C) 2004-2010 Tiny SPRL (). # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as # published by the Free Software Foundation, either version 3 of the # License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . # ############################################################################## import time import base64 import tools from osv import fields from osv import osv from tools.translate import _ MAX_LEVEL = 15 AVAILABLE_STATES = [ ('draft', 'New'), ('open', 'In Progress'), ('cancel', 'Cancelled'), ('done', 'Closed'), ('pending', 'Pending'), ] AVAILABLE_PRIORITIES = [ ('1', 'Highest'), ('2', 'High'), ('3', 'Normal'), ('4', 'Low'), ('5', 'Lowest'), ] class crm_case_channel(osv.osv): _name = "crm.case.channel" _description = "Channels" _order = 'name' _columns = { 'name': fields.char('Channel Name', size=64, required=True), 'active': fields.boolean('Active'), } _defaults = { 'active': lambda *a: 1, } class crm_case_stage(osv.osv): """ Stage of case """ _name = "crm.case.stage" _description = "Stage of case" _rec_name = 'name' _order = "sequence" _columns = { 'name': fields.char('Stage Name', size=64, required=True, translate=True), 'sequence': fields.integer('Sequence', help="Used to order stages."), 'probability': fields.float('Probability (%)', required=True, help="This percentage depicts the default/average probability of the Case for this stage to be a success"), 'on_change': fields.boolean('Change Probability Automatically', help="Setting this stage will change the probability automatically on the opportunity."), 'requirements': fields.text('Requirements'), 'section_ids':fields.many2many('crm.case.section', 'section_stage_rel', 'stage_id', 'section_id', 'Sections'), '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."), } _defaults = { 'sequence': lambda *args: 1, 'probability': lambda *args: 0.0, } class crm_case_section(osv.osv): """Sales Team""" _name = "crm.case.section" _description = "Sales Teams" _order = "complete_name" def get_full_name(self, cr, uid, ids, field_name, arg, context=None): return dict(self.name_get(cr, uid, ids, context=context)) _columns = { 'name': fields.char('Sales Team', size=64, required=True, translate=True), 'complete_name': fields.function(get_full_name, type='char', size=256, readonly=True, store=True), 'code': fields.char('Code', size=8), 'active': fields.boolean('Active', help="If the active field is set to "\ "true, it will allow you to hide the sales team without removing it."), 'allow_unlink': fields.boolean('Allow Delete', help="Allows to delete non draft cases"), 'change_responsible': fields.boolean('Reassign Escalated', help="When escalating to this team override the saleman with the team leader."), 'user_id': fields.many2one('res.users', 'Team Leader'), 'member_ids':fields.many2many('res.users', 'sale_member_rel', 'section_id', 'member_id', 'Team Members'), '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"), 'parent_id': fields.many2one('crm.case.section', 'Parent Team'), 'child_ids': fields.one2many('crm.case.section', 'parent_id', 'Child Teams'), 'resource_calendar_id': fields.many2one('resource.calendar', "Working Time", help="Used to compute open days"), 'note': fields.text('Description'), 'working_hours': fields.float('Working Hours', digits=(16,2 )), 'stage_ids': fields.many2many('crm.case.stage', 'section_stage_rel', 'section_id', 'stage_id', 'Stages'), } def _get_stage_common(self, cr, uid, context): ids = self.pool.get('crm.case.stage').search(cr, uid, [('case_default','=',1)], context=context) return ids _defaults = { 'active': lambda *a: 1, 'allow_unlink': lambda *a: 1, 'stage_ids': _get_stage_common } _sql_constraints = [ ('code_uniq', 'unique (code)', 'The code of the sales team must be unique !') ] _constraints = [ (osv.osv._check_recursion, 'Error ! You cannot create recursive Sales team.', ['parent_id']) ] def name_get(self, cr, uid, ids, context=None): """Overrides orm name_get method""" if not isinstance(ids, list) : ids = [ids] res = [] if not ids: return res reads = self.read(cr, uid, ids, ['name', 'parent_id'], context) for record in reads: name = record['name'] if record['parent_id']: name = record['parent_id'][1] + ' / ' + name res.append((record['id'], name)) return res class crm_case_categ(osv.osv): """ Category of Case """ _name = "crm.case.categ" _description = "Category of Case" _columns = { 'name': fields.char('Name', size=64, required=True, translate=True), 'section_id': fields.many2one('crm.case.section', 'Sales Team'), 'object_id': fields.many2one('ir.model', 'Object Name'), } def _find_object_id(self, cr, uid, context=None): """Finds id for case object""" object_id = context and context.get('object_id', False) or False ids = self.pool.get('ir.model').search(cr, uid, [('id', '=', object_id)]) return ids and ids[0] or False _defaults = { 'object_id' : _find_object_id } class crm_case_resource_type(osv.osv): """ Resource Type of case """ _name = "crm.case.resource.type" _description = "Campaign" _rec_name = "name" _columns = { 'name': fields.char('Campaign Name', size=64, required=True, translate=True), 'section_id': fields.many2one('crm.case.section', 'Sales Team'), } class crm_base(object): """ Base utility mixin class for crm objects, Object subclassing this should define colums: date_open date_closed user_id partner_id partner_address_id """ def _get_default_partner_address(self, cr, uid, context=None): """Gives id of default address for current user :param context: if portal in context is false return false anyway """ if context is None: context = {} if not context.get('portal'): return False # was user.address_id.id, but address_id has been removed user = self.pool.get('res.users').browse(cr, uid, uid, context=context) if hasattr(user, 'partner_address_id') and user.partner_address_id: return user.partner_address_id return False def _get_default_partner(self, cr, uid, context=None): """Gives id of partner for current user :param context: if portal in context is false return false anyway """ if context is None: context = {} if not context.get('portal', False): return False user = self.pool.get('res.users').browse(cr, uid, uid, context=context) if hasattr(user, 'partner_address_id') and user.partner_address_id: return user.partner_address_id return user.company_id.partner_id.id def _get_default_email(self, cr, uid, context=None): """Gives default email address for current user :param context: if portal in context is false return false anyway """ if not context.get('portal', False): return False user = self.pool.get('res.users').browse(cr, uid, uid, context=context) return user.user_email def _get_default_user(self, cr, uid, context=None): """Gives current user id :param context: if portal in context is false return false anyway """ if context and context.get('portal', False): return False return uid def _get_section(self, cr, uid, context=None): """Gives section id for current User """ user = self.pool.get('res.users').browse(cr, uid, uid, context=context) return user.context_section_id.id or False def onchange_partner_address_id(self, cr, uid, ids, add, email=False): """This function returns value of partner email based on Partner Address :param ids: List of case IDs :param add: Id of Partner's address :param email: Partner's email ID """ data = {'value': {'email_from': False, 'phone':False}} if add: address = self.pool.get('res.partner.address').browse(cr, uid, add) data['value'] = {'email_from': address and address.email or False , 'phone': address and address.phone or False} if 'phone' not in self._columns: del data['value']['phone'] return data def onchange_partner_id(self, cr, uid, ids, part, email=False): """This function returns value of partner address based on partner :param ids: List of case IDs :param part: Partner's id :param email: Partner's email ID """ data={} if part: addr = self.pool.get('res.partner').address_get(cr, uid, [part], ['contact']) data = {'partner_address_id': addr['contact']} data.update(self.onchange_partner_address_id(cr, uid, ids, addr['contact'])['value']) return {'value': data} def case_open(self, cr, uid, ids, *args): """Opens Case :param ids: List of case Ids """ cases = self.browse(cr, uid, ids) for case in cases: data = {'state': 'open', 'active': True} if not case.user_id: data['user_id'] = uid self.write(cr, uid, case.id, data) self._action(cr, uid, cases, 'open') return True def case_close(self, cr, uid, ids, *args): """Closes Case :param ids: List of case Ids """ cases = self.browse(cr, uid, ids) cases[0].state # to fill the browse record cache self.write(cr, uid, ids, {'state': 'done', 'date_closed': time.strftime('%Y-%m-%d %H:%M:%S'), }) # We use the cache of cases to keep the old case state self._action(cr, uid, cases, 'done') return True def case_cancel(self, cr, uid, ids, *args): """Cancels Case :param ids: List of case Ids """ cases = self.browse(cr, uid, ids) cases[0].state # to fill the browse record cache self.write(cr, uid, ids, {'state': 'cancel', 'active': True}) # We use the cache of cases to keep the old case state self._action(cr, uid, cases, 'cancel') return True def case_pending(self, cr, uid, ids, *args): """Marks case as pending :param ids: List of case Ids """ cases = self.browse(cr, uid, ids) cases[0].state # to fill the browse record cache self.write(cr, uid, ids, {'state': 'pending', 'active': True}) self._action(cr, uid, cases, 'pending') return True def case_reset(self, cr, uid, ids, *args): """Resets case as draft :param ids: List of case Ids """ cases = self.browse(cr, uid, ids) cases[0].state # to fill the browse record cache self.write(cr, uid, ids, {'state': 'draft', 'active': True}) self._action(cr, uid, cases, 'draft') return True def _action(self, cr, uid, cases, state_to, scrit=None, context=None): if context is None: context = {} context['state_to'] = state_to rule_obj = self.pool.get('base.action.rule') model_obj = self.pool.get('ir.model') model_ids = model_obj.search(cr, uid, [('model','=',self._name)]) rule_ids = rule_obj.search(cr, uid, [('model_id','=',model_ids[0])]) return rule_obj._action(cr, uid, rule_ids, cases, scrit=scrit, context=context) class crm_case(crm_base): """ A simple python class to be used for common functions Object that inherit from this class should inherit from mailgate.thread And need a stage_id field And object that inherit (orm inheritance) from a class the overwrite copy """ def stage_find(self, cr, uid, section_id, domain=None, order='sequence'): if domain is None: domain = [] domain = list(domain) if section_id: domain.append(('section_ids', '=', section_id)) stage_ids = self.pool.get('crm.case.stage').search(cr, uid, domain, order=order) if stage_ids: return stage_ids[0] return False def stage_set(self, cr, uid, ids, stage_id, context=None): value = {} if hasattr(self,'onchange_stage_id'): value = self.onchange_stage_id(cr, uid, ids, stage_id)['value'] value['stage_id'] = stage_id return self.write(cr, uid, ids, value, context=context) def stage_change(self, cr, uid, ids, op, order, context=None): if context is None: context = {} for case in self.browse(cr, uid, ids, context=context): seq = 0 if case.stage_id: seq = case.stage_id.sequence section_id = None if case.section_id: section_id = case.section_id.id next_stage_id = self.stage_find(cr, uid, section_id, [('sequence',op,seq)],order) if next_stage_id: return self.stage_set(cr, uid, [case.id], next_stage_id, context=context) return False def stage_next(self, cr, uid, ids, context=None): """This function computes next stage for case from its current stage using available stage for that case type """ return self.stage_change(cr, uid, ids, '>','sequence', context) def stage_previous(self, cr, uid, ids, context=None): """This function computes previous stage for case from its current stage using available stage for that case type """ return self.stage_change(cr, uid, ids, '<', 'sequence desc', context) def copy(self, cr, uid, id, default=None, context=None): """Overrides orm copy method to avoid copying messages, as well as date_closed and date_open columns if they exist.""" if default is None: default = {} default.update({ 'message_ids': [], }) if hasattr(self, '_columns'): if self._columns.get('date_closed'): default.update({ 'date_closed': False, }) if self._columns.get('date_open'): default.update({ 'date_open': False }) return super(crm_case, self).copy(cr, uid, id, default, context=context) def case_open(self, cr, uid, ids, *args): """Opens Case""" cases = self.browse(cr, uid, ids) self.message_append(cr, uid, cases, _('Open')) for case in cases: data = {'state': 'open', 'active': True } if not case.user_id: data['user_id'] = uid self.write(cr, uid, case.id, data) self._action(cr, uid, cases, 'open') return True def case_close(self, cr, uid, ids, *args): """Closes Case""" cases = self.browse(cr, uid, ids) cases[0].state # to fill the browse record cache self.message_append(cr, uid, cases, _('Close')) self.write(cr, uid, ids, {'state': 'done', 'date_closed': time.strftime('%Y-%m-%d %H:%M:%S'), }) # # We use the cache of cases to keep the old case state # self._action(cr, uid, cases, 'done') return True def case_escalate(self, cr, uid, ids, *args): """Escalates case to parent level""" cases = self.browse(cr, uid, ids) for case in cases: data = {'active': True} if case.section_id.parent_id: data['section_id'] = case.section_id.parent_id.id if case.section_id.parent_id.change_responsible: if case.section_id.parent_id.user_id: data['user_id'] = case.section_id.parent_id.user_id.id else: raise osv.except_osv(_('Error !'), _('You can not escalate, you are already at the top level regarding your sales-team category.')) self.write(cr, uid, [case.id], data) cases = self.browse(cr, uid, ids) self.message_append(cr, uid, cases, _('Escalate')) self._action(cr, uid, cases, 'escalate') return True def case_cancel(self, cr, uid, ids, *args): """Cancels Case""" cases = self.browse(cr, uid, ids) cases[0].state # to fill the browse record cache self.message_append(cr, uid, cases, _('Cancel')) self.write(cr, uid, ids, {'state': 'cancel', 'active': True}) self._action(cr, uid, cases, 'cancel') for case in cases: message = _("The case '%s' has been cancelled.") % (case.name,) self.log(cr, uid, case.id, message) return True def case_pending(self, cr, uid, ids, *args): """Marks case as pending""" cases = self.browse(cr, uid, ids) cases[0].state # to fill the browse record cache self.message_append(cr, uid, cases, _('Pending')) self.write(cr, uid, ids, {'state': 'pending', 'active': True}) self._action(cr, uid, cases, 'pending') return True def case_reset(self, cr, uid, ids, *args): """Resets case as draft""" state = 'draft' if 'crm.phonecall' in args: state = 'open' cases = self.browse(cr, uid, ids) cases[0].state # to fill the browse record cache self.message_append(cr, uid, cases, _('Draft')) self.write(cr, uid, ids, {'state': state, 'active': True}) self._action(cr, uid, cases, state) return True def remind_partner(self, cr, uid, ids, context=None, attach=False): return self.remind_user(cr, uid, ids, context, attach, destination=False) def remind_user(self, cr, uid, ids, context=None, attach=False, destination=True): mail_message = self.pool.get('mail.message') for case in self.browse(cr, uid, ids, context=context): if not destination and not case.email_from: return False if not case.user_id.user_email: return False if destination and case.section_id.user_id: case_email = case.section_id.user_id.user_email else: case_email = case.user_id.user_email src = case_email dest = case.user_id.user_email or "" body = case.description or "" for message in case.message_ids: if message.email_from: body = message.description break if not destination: src, dest = dest, case.email_from if body and case.user_id.signature: if body: body += '\n\n%s' % (case.user_id.signature) else: body = '\n\n%s' % (case.user_id.signature) body = self.format_body(body) attach_to_send = {} if attach: attach_ids = self.pool.get('ir.attachment').search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', case.id)]) attach_to_send = self.pool.get('ir.attachment').read(cr, uid, attach_ids, ['datas_fname', 'datas']) attach_to_send = dict(map(lambda x: (x['datas_fname'], base64.decodestring(x['datas'])), attach_to_send)) # Send an email subject = "Reminder: [%s] %s" % (str(case.id), case.name, ) mail_message.schedule_with_attach(cr, uid, src, [dest], subject, body, model='crm.case', reply_to=case.section_id.reply_to, res_id=case.id, attachments=attach_to_send, context=context ) return True def _check(self, cr, uid, ids=False, context=None): """Function called by the scheduler to process cases for date actions Only works on not done and cancelled cases """ cr.execute('select * from crm_case \ where (date_action_last<%s or date_action_last is null) \ and (date_action_next<=%s or date_action_next is null) \ and state not in (\'cancel\',\'done\')', (time.strftime("%Y-%m-%d %H:%M:%S"), time.strftime('%Y-%m-%d %H:%M:%S'))) ids2 = map(lambda x: x[0], cr.fetchall() or []) cases = self.browse(cr, uid, ids2, context=context) return self._action(cr, uid, cases, False, context=context) def format_body(self, body): return self.pool.get('base.action.rule').format_body(body) def format_mail(self, obj, body): return self.pool.get('base.action.rule').format_mail(obj, body) def message_thread_followers(self, cr, uid, ids, context=None): res = {} for case in self.browse(cr, uid, ids, context=context): l=[] if case.email_cc: l.append(case.email_cc) if case.user_id and case.user_id.user_email: l.append(case.user_id.user_email) res[case.id] = l return res def _links_get(self, cr, uid, context=None): """Gets links value for reference field""" obj = self.pool.get('res.request.link') ids = obj.search(cr, uid, []) res = obj.read(cr, uid, ids, ['object', 'name'], context) return [(r['object'], r['name']) for r in res] class users(osv.osv): _inherit = 'res.users' _description = "Users" _columns = { 'context_section_id': fields.many2one('crm.case.section', 'Sales Team'), } def create(self, cr, uid, vals, context=None): res = super(users, self).create(cr, uid, vals, context=context) section_obj=self.pool.get('crm.case.section') if vals.get('context_section_id'): section_obj.write(cr, uid, [vals['context_section_id']], {'member_ids':[(4, res)]}, context) return res users() # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: