1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-today OpenERP SA (<http://www.openerp.com>)
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 ##############################################################################
22 from osv import fields
23 from tools.translate import _
25 class base_state(object):
26 """ Base utility mixin class for objects willing to manage their state.
27 Object subclassing this class should define the following colums:
28 - ``date_open`` (datetime field)
29 - ``date_closed`` (datetime field)
30 - ``user_id`` (many2one to res.users)
31 - ``partner_id`` (many2one to res.partner)
32 - ``email_from`` (char field)
33 - ``state`` (selection field)
36 def _get_default_partner(self, cr, uid, context=None):
37 """ Gives id of partner for current user
38 :param context: if portal not in context returns False
42 if not context or not context.get('portal'):
44 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
45 if hasattr(user, 'partner_address_id') and user.partner_address_id:
46 return user.partner_address_id
47 return user.company_id.partner_id.id
49 def _get_default_email(self, cr, uid, context=None):
50 """ Gives default email address for current user
51 :param context: if portal not in context returns False
55 if not context or not context.get('portal'):
57 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
58 return user.user_email
60 def _get_default_user(self, cr, uid, context=None):
61 """ Gives current user id
62 :param context: if portal not in context returns False
66 if not context or not context.get('portal'):
70 def onchange_partner_address_id(self, cr, uid, ids, add, email=False):
71 """ This function returns value of partner email based on Partner Address
72 :param add: Id of Partner's address
73 :param email: Partner's email ID
75 data = {'value': {'email_from': False, 'phone':False}}
77 address = self.pool.get('res.partner').browse(cr, uid, add)
78 data['value'] = {'email_from': address and address.email or False ,
79 'phone': address and address.phone or False}
80 if 'phone' not in self._columns:
81 del data['value']['phone']
84 def onchange_partner_id(self, cr, uid, ids, part, email=False):
85 """ This function returns value of partner address based on partner
86 :param part: Partner's id
87 :param email: Partner's email ID
91 addr = self.pool.get('res.partner').address_get(cr, uid, [part], ['contact'])
92 data.update(self.onchange_partner_address_id(cr, uid, ids, addr['contact'])['value'])
93 return {'value': data}
95 def case_open(self, cr, uid, ids, context=None):
97 cases = self.browse(cr, uid, ids, context=context)
99 values = {'active': True}
100 if case.state == 'draft':
101 values['date_open'] = fields.datetime.now()
103 values['user_id'] = uid
104 self.case_set(cr, uid, [case.id], 'open', values, context=context)
105 self.case_open_send_note(cr, uid, [case.id], context=context)
108 def case_close(self, cr, uid, ids, context=None):
110 self.case_set(cr, uid, ids, 'done', {'date_closed': fields.datetime.now()}, context=context)
111 self.case_close_send_note(cr, uid, ids, context=context)
114 def case_cancel(self, cr, uid, ids, context=None):
116 self.case_set(cr, uid, ids, 'cancel', {'active': True}, context=context)
117 self.case_cancel_send_note(cr, uid, ids, context=context)
120 def case_pending(self, cr, uid, ids, context=None):
121 """ Sets case as pending """
122 self.case_set(cr, uid, ids, 'pending', {'active': True}, context=context)
123 self.case_pending_send_note(cr, uid, ids, context=context)
126 def case_reset(self, cr, uid, ids, context=None):
127 """ Resets case as draft """
128 self.case_set(cr, uid, ids, 'draft', {'active': True}, context=context)
129 self.case_reset_send_note(cr, uid, ids, context=context)
132 def case_set(self, cr, uid, ids, state_name, update_values=None, context=None):
133 """ Generic method for setting case. This methods wraps the update
134 of the record, as well as call to _action and browse_record
135 case setting to fill the cache.
137 :params: state_name: the new value of the state, such as
139 :params: update_values: values that will be added with the state
140 update when writing values to the record.
142 cases = self.browse(cr, uid, ids, context=context)
143 cases[0].state # fill browse record cache, for _action having old and new values
144 if update_values is None:
146 update_values['state'] = state_name
147 self.write(cr, uid, ids, update_values, context=context)
148 self._action(cr, uid, cases, state_name, context=context)
150 def _action(self, cr, uid, cases, state_to, scrit=None, context=None):
153 context['state_to'] = state_to
154 rule_obj = self.pool.get('base.action.rule')
155 model_obj = self.pool.get('ir.model')
156 model_ids = model_obj.search(cr, uid, [('model','=',self._name)])
157 rule_ids = rule_obj.search(cr, uid, [('model_id','=',model_ids[0])])
158 return rule_obj._action(cr, uid, rule_ids, cases, scrit=scrit, context=context)
160 # ******************************
162 # ******************************
164 def case_get_note_msg_prefix(self, cr, uid, id, context=None):
167 def case_open_send_note(self, cr, uid, ids, context=None):
169 msg = _('%s has been <b>opened</b>.') % (self.case_get_note_msg_prefix(cr, uid, id, context=context))
170 self.message_append_note(cr, uid, [id], body=msg, context=context)
173 def case_close_send_note(self, cr, uid, ids, context=None):
175 msg = _('%s has been <b>closed</b>.') % (self.case_get_note_msg_prefix(cr, uid, id, context=context))
176 self.message_append_note(cr, uid, [id], body=msg, context=context)
179 def case_cancel_send_note(self, cr, uid, ids, context=None):
181 msg = _('%s has been <b>canceled</b>.') % (self.case_get_note_msg_prefix(cr, uid, id, context=context))
182 self.message_append_note(cr, uid, [id], body=msg, context=context)
185 def case_pending_send_note(self, cr, uid, ids, context=None):
187 msg = _('%s is now <b>pending</b>.') % (self.case_get_note_msg_prefix(cr, uid, id, context=context))
188 self.message_append_note(cr, uid, [id], body=msg, context=context)
191 def case_reset_send_note(self, cr, uid, ids, context=None):
193 msg = _('%s has been <b>renewed</b>.') % (self.case_get_note_msg_prefix(cr, uid, id, context=context))
194 self.message_append_note(cr, uid, [id], body=msg, context=context)