[IMP]improve code
[odoo/odoo.git] / addons / hr_recruitment / hr_recruitment.py
1 # -*- coding: utf-8 -*-
2 ##############################################################################
3 #
4 #    OpenERP, Open Source Management Solution
5 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
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 from base_status.base_stage import base_stage
23 import time
24 from datetime import datetime, timedelta
25
26 from osv import fields, osv
27 import tools
28 import collections
29 import binascii
30 from tools.translate import _
31
32 AVAILABLE_STATES = [
33     ('draft', 'New'),
34     ('cancel', 'Refused'),
35     ('open', 'In Progress'),
36     ('pending', 'Pending'),
37     ('done', 'Hired')
38 ]
39
40 AVAILABLE_PRIORITIES = [
41     ('', ''),
42     ('5', 'Not Good'),
43     ('4', 'On Average'),
44     ('3', 'Good'),
45     ('2', 'Very Good'),
46     ('1', 'Excellent')
47 ]
48
49 class hr_recruitment_source(osv.osv):
50     """ Sources of HR Recruitment """
51     _name = "hr.recruitment.source"
52     _description = "Source of Applicants"
53     _columns = {
54         'name': fields.char('Source Name', size=64, required=True, translate=True),
55     }
56
57 class hr_recruitment_stage(osv.osv):
58     """ Stage of HR Recruitment """
59     _name = "hr.recruitment.stage"
60     _description = "Stage of Recruitment"
61     _order = 'sequence'
62     _columns = {
63         'name': fields.char('Name', size=64, required=True, translate=True),
64         'sequence': fields.integer('Sequence', help="Gives the sequence order when displaying a list of stages."),
65         'department_id':fields.many2one('hr.department', 'Specific to a Department', help="Stages of the recruitment process may be different per department. If this stage is common to all departments, keep this field empty."),
66         'state': fields.selection(AVAILABLE_STATES, 'State', required=True, help="The related state for the stage. The state of your document will automatically change according to the selected stage. Example, a stage is related to the state 'Close', when your document reach this stage, it will be automatically closed."),
67         'fold': fields.boolean('Hide in views if empty', help="This stage is not visible, for example in status bar or kanban view, when there are no records in that stage to display."),
68         'requirements': fields.text('Requirements'),
69     }
70     _defaults = {
71         'sequence': 1,
72         'state': 'draft',
73         'fold': False,
74     }
75
76 class hr_recruitment_degree(osv.osv):
77     """ Degree of HR Recruitment """
78     _name = "hr.recruitment.degree"
79     _description = "Degree of Recruitment"
80     _columns = {
81         'name': fields.char('Name', size=64, required=True, translate=True),
82         'sequence': fields.integer('Sequence', help="Gives the sequence order when displaying a list of degrees."),
83     }
84     _defaults = {
85         'sequence': 1,
86     }
87     _sql_constraints = [
88         ('name_uniq', 'unique (name)', 'The name of the Degree of Recruitment must be unique!')
89     ]
90
91 class hr_applicant(base_stage, osv.Model):
92     _name = "hr.applicant"
93     _description = "Applicant"
94     _order = "id desc"
95     _inherit = ['ir.needaction_mixin', 'mail.thread']
96     _mail_compose_message = True
97
98     def _get_default_department_id(self, cr, uid, context=None):
99         """ Gives default department by checking if present in the context """
100         return (self._resolve_department_id_from_context(cr, uid, context=context) or False)
101
102     def _get_default_stage_id(self, cr, uid, context=None):
103         """ Gives default stage_id """
104         department_id = self._get_default_department_id(cr, uid, context=context)
105         return self.stage_find(cr, uid, [], department_id, [('state', '=', 'draft')], context=context)
106
107     def _resolve_department_id_from_context(self, cr, uid, context=None):
108         """ Returns ID of department based on the value of 'default_department_id'
109             context key, or None if it cannot be resolved to a single
110             department.
111         """
112         if context is None:
113             context = {}
114         if type(context.get('default_department_id')) in (int, long):
115             return context.get('default_department_id')
116         if isinstance(context.get('default_department_id'), basestring):
117             department_name = context['default_department_id']
118             department_ids = self.pool.get('hr.department').name_search(cr, uid, name=department_name, context=context)
119             if len(department_ids) == 1:
120                 return int(department_ids[0][0])
121         return None
122
123     def _read_group_stage_ids(self, cr, uid, ids, domain, read_group_order=None, access_rights_uid=None, context=None):
124         access_rights_uid = access_rights_uid or uid
125         stage_obj = self.pool.get('hr.recruitment.stage')
126         order = stage_obj._order
127         # lame hack to allow reverting search, should just work in the trivial case
128         if read_group_order == 'stage_id desc':
129             order = "%s desc" % order
130         # retrieve section_id from the context and write the domain
131         # - ('id', 'in', 'ids'): add columns that should be present
132         # - OR ('department_id', '=', False), ('fold', '=', False): add default columns that are not folded
133         # - OR ('department_id', 'in', department_id), ('fold', '=', False) if department_id: add department columns that are not folded
134         department_id = self._resolve_department_id_from_context(cr, uid, context=context)
135         search_domain = []
136         if department_id:
137             search_domain += ['|', '&', ('department_id', '=', department_id), ('fold', '=', False)]
138         search_domain += ['|', ('id', 'in', ids), '&', ('department_id', '=', False), ('fold', '=', False)]
139         stage_ids = stage_obj._search(cr, uid, search_domain, order=order, access_rights_uid=access_rights_uid, context=context)
140         result = stage_obj.name_get(cr, access_rights_uid, stage_ids, context=context)
141         # restore order of the search
142         result.sort(lambda x,y: cmp(stage_ids.index(x[0]), stage_ids.index(y[0])))
143         return result
144
145     def _compute_day(self, cr, uid, ids, fields, args, context=None):
146         """
147         @param cr: the current row, from the database cursor,
148         @param uid: the current user’s ID for security checks,
149         @param ids: List of Openday’s IDs
150         @return: difference between current date and log date
151         @param context: A standard dictionary for contextual values
152         """
153         res = {}
154         for issue in self.browse(cr, uid, ids, context=context):
155             for field in fields:
156                 res[issue.id] = {}
157                 duration = 0
158                 ans = False
159                 hours = 0
160
161                 if field in ['day_open']:
162                     if issue.date_open:
163                         date_create = datetime.strptime(issue.create_date, "%Y-%m-%d %H:%M:%S")
164                         date_open = datetime.strptime(issue.date_open, "%Y-%m-%d %H:%M:%S")
165                         ans = date_open - date_create
166                         date_until = issue.date_open
167
168                 elif field in ['day_close']:
169                     if issue.date_closed:
170                         date_create = datetime.strptime(issue.create_date, "%Y-%m-%d %H:%M:%S")
171                         date_close = datetime.strptime(issue.date_closed, "%Y-%m-%d %H:%M:%S")
172                         date_until = issue.date_closed
173                         ans = date_close - date_create
174                 if ans:
175                     duration = float(ans.days)
176                     res[issue.id][field] = abs(float(duration))
177         return res
178
179     _columns = {
180         'name': fields.char('Subject', size=128, required=True),
181         'active': fields.boolean('Active', help="If the active field is set to false, it will allow you to hide the case without removing it."),
182         'description': fields.text('Description'),
183         'email_from': fields.char('Email', size=128, help="These people will receive email."),
184         'email_cc': fields.text('Watchers Emails', size=252, help="These email addresses will be added to the CC field of all inbound and outbound emails for this record before being sent. Separate multiple email addresses with a comma"),
185         'probability': fields.float('Probability'),
186         'partner_id': fields.many2one('res.partner', 'Contact'),
187         'create_date': fields.datetime('Creation Date', readonly=True, select=True),
188         'write_date': fields.datetime('Update Date', readonly=True),
189         'stage_id': fields.many2one ('hr.recruitment.stage', 'Stage',
190                         domain="['|', ('department_id', '=', department_id), ('department_id', '=', False)]"),
191         'state': fields.related('stage_id', 'state', type="selection", store=True,
192                 selection=AVAILABLE_STATES, string="State", readonly=True,
193                 help='The state is set to \'Draft\', when a case is created.\
194                       If the case is in progress the state is set to \'Open\'.\
195                       When the case is over, the state is set to \'Done\'.\
196                       If the case needs to be reviewed then the state is \
197                       set to \'Pending\'.'),
198         'company_id': fields.many2one('res.company', 'Company'),
199         'user_id': fields.many2one('res.users', 'Responsible'),
200         # Applicant Columns
201         'date_closed': fields.datetime('Closed', readonly=True, select=True),
202         'date_open': fields.datetime('Opened', readonly=True, select=True),
203         'date': fields.datetime('Date'),
204         'date_action': fields.date('Next Action Date'),
205         'title_action': fields.char('Next Action', size=64),
206         'priority': fields.selection(AVAILABLE_PRIORITIES, 'Appreciation'),
207         'job_id': fields.many2one('hr.job', 'Applied Job'),
208         'salary_proposed_extra': fields.char('Proposed Salary Extra', size=100, help="Salary Proposed by the Organisation, extra advantages"),
209         'salary_expected_extra': fields.char('Expected Salary Extra', size=100, help="Salary Expected by Applicant, extra advantages"),
210         'salary_proposed': fields.float('Proposed Salary', help="Salary Proposed by the Organisation"),
211         'salary_expected': fields.float('Expected Salary', help="Salary Expected by Applicant"),
212         'availability': fields.integer('Availability'),
213         'partner_name': fields.char("Applicant's Name", size=64),
214         'partner_phone': fields.char('Phone', size=32),
215         'partner_mobile': fields.char('Mobile', size=32),
216         'type_id': fields.many2one('hr.recruitment.degree', 'Degree'),
217         'department_id': fields.many2one('hr.department', 'Department'),
218         'survey': fields.related('job_id', 'survey_id', type='many2one', relation='survey', string='Survey'),
219         'response': fields.integer("Response"),
220         'reference': fields.char('Referred By', size=128),
221         'source_id': fields.many2one('hr.recruitment.source', 'Source'),
222         'day_open': fields.function(_compute_day, string='Days to Open', \
223                                 multi='day_open', type="float", store=True),
224         'day_close': fields.function(_compute_day, string='Days to Close', \
225                                 multi='day_close', type="float", store=True),
226         'color': fields.integer('Color Index'),
227         'emp_id': fields.many2one('hr.employee', 'employee'),
228         'user_email': fields.related('user_id', 'user_email', type='char', string='User Email', readonly=True),
229     }
230
231     _defaults = {
232         'active': lambda *a: 1,
233         'user_id':  lambda s, cr, uid, c: uid,
234         'email_from': lambda s, cr, uid, c: s._get_default_email(cr, uid, c),
235         'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
236         'department_id': lambda s, cr, uid, c: s._get_default_department_id(cr, uid, c),
237         'priority': lambda *a: '',
238         'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'hr.applicant', context=c),
239         'color': 0,
240     }
241
242     _group_by_full = {
243         'stage_id': _read_group_stage_ids
244     }
245     
246     def onchange_stage_id(self, cr, uid, ids, stage_id, context={}):
247         if context is None:
248             context = {}
249         if not stage_id:
250             return {'value':{}}
251         stage = self.pool.get('hr.recruitment.stage').browse(cr, uid, stage_id, context)
252         if stage.state == 'done':
253             context['onchange'] = True
254             self.case_close_with_emp(cr, uid, ids, context)
255         if stage.state == "draft":
256             return {'value':{'active': True,'date_open': False, 'date_closed': False}}
257         if stage.state == "open":
258             cases = self.browse(cr, uid, ids, context=context)
259             data = {'active': True}
260             for case in cases:
261                 if case.stage_id and case.stage_id.state == 'draft':
262                     data['date_open'] = fields.datetime.now()
263                 if not case.user_id:
264                     data['user_id'] = uid
265             return {'value':data}
266         return {'value':{}}
267
268     def onchange_job(self,cr, uid, ids, job, context=None):
269         result = {}
270
271         if job:
272             job_obj = self.pool.get('hr.job')
273             result['department_id'] = job_obj.browse(cr, uid, job, context=context).department_id.id
274             return {'value': result}
275         return {'value': {'department_id': False}}
276
277     def onchange_department_id(self, cr, uid, ids, department_id=False, context=None):
278         obj_recru_stage = self.pool.get('hr.recruitment.stage')
279         stage_ids = obj_recru_stage.search(cr, uid, ['|',('department_id','=',department_id),('department_id','=',False)], context=context)
280         stage_id = stage_ids and stage_ids[0] or False
281         return {'value': {'stage_id': stage_id}}
282
283     def stage_find(self, cr, uid, cases, section_id, domain=[], order='sequence', context=None):
284         """ Override of the base.stage method
285             Parameter of the stage search taken from the lead:
286             - department_id: if set, stages must belong to this section or
287               be a default case
288         """
289         if isinstance(cases, (int, long)):
290             cases = self.browse(cr, uid, cases, context=context)
291         # collect all section_ids
292         department_ids = []
293         if section_id:
294             department_ids.append(section_id)
295         for case in cases:
296             if case.department_id:
297                 department_ids.append(case.department_id.id)
298         # OR all section_ids and OR with case_default
299         search_domain = []
300         if department_ids:
301             search_domain += ['|', ('department_id', 'in', department_ids)]
302         search_domain.append(('department_id', '=', False))
303         # AND with the domain in parameter
304         search_domain += list(domain)
305         # perform search, return the first found
306         stage_ids = self.pool.get('hr.recruitment.stage').search(cr, uid, search_domain, order=order, context=context)
307         if stage_ids:
308             return stage_ids[0]
309         return False
310
311     def action_makeMeeting(self, cr, uid, ids, context=None):
312         """ This opens Meeting's calendar view to schedule meeting on current applicant
313             @return: Dictionary value for created Meeting view
314         """
315         applicant = self.browse(cr, uid, ids[0], context)
316         category = self.pool.get('ir.model.data').get_object(cr, uid, 'hr_recruitment', 'categ_meet_interview', context)
317         res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
318         res['context'] = {
319             'default_partner_ids': applicant.partner_id and [applicant.partner_id.id] or False,
320             'default_user_id': uid,
321             'default_state': 'open',
322             'default_name': applicant.name,
323             'default_categ_ids': category and [category.id] or False,
324         }
325         return res
326
327     def action_print_survey(self, cr, uid, ids, context=None):
328         """
329         If response is available then print this response otherwise print survey form(print template of the survey).
330
331         @param self: The object pointer
332         @param cr: the current row, from the database cursor,
333         @param uid: the current user’s ID for security checks,
334         @param ids: List of Survey IDs
335         @param context: A standard dictionary for contextual values
336         @return: Dictionary value for print survey form.
337         """
338         if context is None:
339             context = {}
340         record = self.browse(cr, uid, ids, context=context)
341         record = record and record[0]
342         context.update({'survey_id': record.survey.id, 'response_id': [record.response], 'response_no': 0, })
343         value = self.pool.get("survey").action_print_survey(cr, uid, ids, context=context)
344         return value
345
346     def message_new(self, cr, uid, msg, custom_values=None, context=None):
347         """ Overrides mail_thread message_new that is called by the mailgateway
348             through message_process.
349             This override updates the document according to the email.
350         """
351         if custom_values is None: custom_values = {}
352         custom_values.update({
353             'name':  msg.get('subject') or _("No Subject"),
354             'description': msg.get('body_text'),
355             'email_from': msg.get('from'),
356             'email_cc': msg.get('cc'),
357             'user_id': False,
358         })
359         if msg.get('priority'):
360             custom_values['priority'] = msg.get('priority')
361         custom_values.update(self.message_partner_by_email(cr, uid, msg.get('from', False), context=context))
362         return super(hr_applicant,self).message_new(cr, uid, msg, custom_values=custom_values, context=context)
363
364     def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
365         """ Override mail_thread message_update that is called by the mailgateway
366             through message_process.
367             This method updates the document according to the email.
368         """
369         if isinstance(ids, (str, int, long)):
370             ids = [ids]
371         if update_vals is None: vals = {}
372         
373         update_vals.update({
374             'description': msg.get('body'),
375             'email_from': msg.get('from'),
376             'email_cc': msg.get('cc'),
377         })
378         if msg.get('priority'):
379             update_vals['priority'] = msg.get('priority')
380
381         maps = {
382             'cost': 'planned_cost',
383             'revenue': 'planned_revenue',
384             'probability': 'probability',
385         }
386         for line in msg.get('body_text', '').split('\n'):
387             line = line.strip()
388             res = tools.misc.command_re.match(line)
389             if res and maps.get(res.group(1).lower(), False):
390                 key = maps.get(res.group(1).lower())
391                 update_vals[key] = res.group(2).lower()
392
393         return super(hr_applicant, self).message_update(cr, uids, ids, update_vals=update_vals, context=context)
394
395     def create(self, cr, uid, vals, context=None):
396         obj_id = super(hr_applicant, self).create(cr, uid, vals, context=context)
397         self.create_send_note(cr, uid, [obj_id], context=context)
398         return obj_id
399
400     def case_open(self, cr, uid, ids, context=None):
401         """
402             open Request of the applicant for the hr_recruitment
403         """
404         res = super(hr_applicant, self).case_open(cr, uid, ids, context)
405         date = self.read(cr, uid, ids, ['date_open'])[0]
406         if not date['date_open']:
407             self.write(cr, uid, ids, {'date_open': time.strftime('%Y-%m-%d %H:%M:%S'),})
408         return res
409
410     def case_close(self, cr, uid, ids, context=None):
411         res = super(hr_applicant, self).case_close(cr, uid, ids, context)
412         return res
413
414     def case_close_with_emp(self, cr, uid, ids, context=None):
415         if context is None:
416             context = {}
417         hr_employee = self.pool.get('hr.employee')
418         model_data = self.pool.get('ir.model.data')
419         act_window = self.pool.get('ir.actions.act_window')
420         emp_id = False
421         for applicant in self.browse(cr, uid, ids, context=context):
422             address_id = False
423             if applicant.partner_id:
424                 address_id = applicant.partner_id.address_get(['contact'])['contact']
425             if applicant.job_id:
426                 applicant.job_id.write({'no_of_recruitment': applicant.job_id.no_of_recruitment - 1})
427                 emp_id = hr_employee.create(cr,uid,{'name': applicant.partner_name or applicant.name,
428                                                      'job_id': applicant.job_id.id,
429                                                      'address_home_id': address_id,
430                                                      'department_id': applicant.department_id.id
431                                                      })
432                 if context.get('onchange'):
433                     return {'value':{'emp_id': emp_id,'active': True, 'date_closed': fields.datetime.now()}}
434                 else:
435                     self.write(cr, uid, [applicant.id], {'emp_id': emp_id}, context=context)
436                     self.case_close(cr, uid, [applicant.id], context)
437             else:
438                 raise osv.except_osv(_('Warning!'),_('You must define Applied Job for this applicant.'))
439
440         action_model, action_id = model_data.get_object_reference(cr, uid, 'hr', 'open_view_employee_list')
441         dict_act_window = act_window.read(cr, uid, action_id, [])
442         if emp_id:
443             dict_act_window['res_id'] = emp_id
444         dict_act_window['view_mode'] = 'form,tree'
445         return dict_act_window
446
447     def case_cancel(self, cr, uid, ids, context=None):
448         """Overrides cancel for crm_case for setting probability
449         """
450         res = super(hr_applicant, self).case_cancel(cr, uid, ids, context)
451         self.write(cr, uid, ids, {'probability' : 0.0})
452         return res
453
454     def case_pending(self, cr, uid, ids, context=None):
455         """Marks case as pending"""
456         res = super(hr_applicant, self).case_pending(cr, uid, ids, context)
457         self.write(cr, uid, ids, {'probability' : 0.0})
458         return res
459
460     def case_reset(self, cr, uid, ids, context=None):
461         """Resets case as draft
462         """
463         res = super(hr_applicant, self).case_reset(cr, uid, ids, context)
464         self.write(cr, uid, ids, {'date_open': False, 'date_closed': False})
465         return res
466
467     def set_priority(self, cr, uid, ids, priority, *args):
468         """Set applicant priority
469         """
470         return self.write(cr, uid, ids, {'priority' : priority})
471
472     def set_high_priority(self, cr, uid, ids, *args):
473         """Set applicant priority to high
474         """
475         return self.set_priority(cr, uid, ids, '1')
476
477     def set_normal_priority(self, cr, uid, ids, *args):
478         """Set applicant priority to normal
479         """
480         return self.set_priority(cr, uid, ids, '3')
481
482     # -------------------------------------------------------
483     # OpenChatter methods and notifications
484     # -------------------------------------------------------
485
486     def message_get_subscribers(self, cr, uid, ids, context=None):
487         """ Override to add responsible user. """
488         user_ids = super(hr_applicant, self).message_get_subscribers(cr, uid, ids, context=context)
489         for obj in self.browse(cr, uid, ids, context=context):
490             if obj.user_id and not obj.user_id.id in user_ids:
491                 user_ids.append(obj.user_id.id)
492         return user_ids
493
494     def stage_set_send_note(self, cr, uid, ids, stage_id, context=None):
495         """ Override of the (void) default notification method. """
496         if not stage_id: return True
497         stage_name = self.pool.get('hr.recruitment.stage').name_get(cr, uid, [stage_id], context=context)[0][1]
498         return self.message_append_note(cr, uid, ids, body= _("Stage changed to <b>%s</b>.") % (stage_name), context=context)
499
500     def case_get_note_msg_prefix(self, cr, uid, id, context=None):
501                 return 'Applicant'
502
503     def case_open_send_note(self, cr, uid, ids, context=None):
504         message = _("Applicant has been set <b>in progress</b>.")
505         return self.message_append_note(cr, uid, ids, body=message, context=context)
506
507     def case_close_send_note(self, cr, uid, ids, context=None):
508         if context is None:
509             context = {}
510         for applicant in self.browse(cr, uid, ids, context=context):
511             if applicant.emp_id:
512                 message = _("Applicant has been <b>hired</b> and created as an employee.")
513                 self.message_append_note(cr, uid, [applicant.id], body=message, context=context)
514             else:
515                 message = _("Applicant has been <b>hired</b>.")
516                 self.message_append_note(cr, uid, [applicant.id], body=message, context=context)
517         return True
518
519     def case_cancel_send_note(self, cr, uid, ids, context=None):
520         msg = 'Applicant <b>refused</b>.'
521         return self.message_append_note(cr, uid, ids, body=msg, context=context)
522
523     def case_reset_send_note(self,  cr, uid, ids, context=None):
524         message =_("Applicant has been set as <b>new</b>.")
525         return self.message_append_note(cr, uid, ids, body=message, context=context)
526
527     def create_send_note(self, cr, uid, ids, context=None):
528         message = _("Applicant has been <b>created</b>.")
529         return self.message_append_note(cr, uid, ids, body=message, context=context)
530
531
532 class hr_job(osv.osv):
533     _inherit = "hr.job"
534     _name = "hr.job"
535     _columns = {
536         'survey_id': fields.many2one('survey', 'Interview Form', help="Choose an interview form for this job position and you will be able to print/answer this interview from all applicants who apply for this job"),
537     }
538     
539     def action_print_survey(self, cr, uid, ids, context=None):
540         if context is None:
541             context = {}
542         datas = {}
543         record = self.browse(cr, uid, ids, context=context)[0]
544         if record.survey_id:
545             datas['ids'] = [record.survey_id.id]
546         datas['model'] = 'survey.print'
547         context.update({'response_id': [0], 'response_no': 0,})
548         return {
549                 'type': 'ir.actions.report.xml',
550                 'report_name': 'survey.form',
551                 'datas': datas,
552                 'context' : context,
553                 'nodestroy':True,
554             }
555
556 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: