[MERGE] trunk-hr_recruitment_10_clicks-psi (usability improvements in hr_recruitment)
[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_job(self,cr, uid, ids, job, context=None):
247         result = {}
248
249         if job:
250             job_obj = self.pool.get('hr.job')
251             result['department_id'] = job_obj.browse(cr, uid, job, context=context).department_id.id
252             return {'value': result}
253         return {'value': {'department_id': False}}
254
255     def onchange_department_id(self, cr, uid, ids, department_id=False, context=None):
256         obj_recru_stage = self.pool.get('hr.recruitment.stage')
257         stage_ids = obj_recru_stage.search(cr, uid, ['|',('department_id','=',department_id),('department_id','=',False)], context=context)
258         stage_id = stage_ids and stage_ids[0] or False
259         return {'value': {'stage_id': stage_id}}
260
261     def stage_find(self, cr, uid, cases, section_id, domain=[], order='sequence', context=None):
262         """ Override of the base.stage method
263             Parameter of the stage search taken from the lead:
264             - department_id: if set, stages must belong to this section or
265               be a default case
266         """
267         if isinstance(cases, (int, long)):
268             cases = self.browse(cr, uid, cases, context=context)
269         # collect all section_ids
270         department_ids = []
271         if section_id:
272             department_ids.append(section_id)
273         for case in cases:
274             if case.department_id:
275                 department_ids.append(case.department_id.id)
276         # OR all section_ids and OR with case_default
277         search_domain = []
278         if department_ids:
279             search_domain += ['|', ('department_id', 'in', department_ids)]
280         search_domain.append(('department_id', '=', False))
281         # AND with the domain in parameter
282         search_domain += list(domain)
283         # perform search, return the first found
284         stage_ids = self.pool.get('hr.recruitment.stage').search(cr, uid, search_domain, order=order, context=context)
285         if stage_ids:
286             return stage_ids[0]
287         return False
288
289     def action_makeMeeting(self, cr, uid, ids, context=None):
290         """ This opens Meeting's calendar view to schedule meeting on current applicant
291             @return: Dictionary value for created Meeting view
292         """
293         applicant = self.browse(cr, uid, ids[0], context)
294         category = self.pool.get('ir.model.data').get_object(cr, uid, 'hr_recruitment', 'categ_meet_interview', context)
295         res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
296         res['context'] = {
297             'default_partner_ids': applicant.partner_id and [applicant.partner_id.id] or False,
298             'default_user_id': uid,
299             'default_state': 'open',
300             'default_name': applicant.name,
301             'default_categ_ids': category and [category.id] or False,
302         }
303         return res
304
305     def action_print_survey(self, cr, uid, ids, context=None):
306         """
307         If response is available then print this response otherwise print survey form(print template of the survey).
308
309         @param self: The object pointer
310         @param cr: the current row, from the database cursor,
311         @param uid: the current user’s ID for security checks,
312         @param ids: List of Survey IDs
313         @param context: A standard dictionary for contextual values
314         @return: Dictionary value for print survey form.
315         """
316         if context is None:
317             context = {}
318         record = self.browse(cr, uid, ids, context=context)
319         record = record and record[0]
320         context.update({'survey_id': record.survey.id, 'response_id': [record.response], 'response_no': 0, })
321         value = self.pool.get("survey").action_print_survey(cr, uid, ids, context=context)
322         return value
323
324     def message_new(self, cr, uid, msg, custom_values=None, context=None):
325         """ Overrides mail_thread message_new that is called by the mailgateway
326             through message_process.
327             This override updates the document according to the email.
328         """
329         if custom_values is None: custom_values = {}
330         custom_values.update({
331             'name':  msg.get('subject') or _("No Subject"),
332             'description': msg.get('body_text'),
333             'email_from': msg.get('from'),
334             'email_cc': msg.get('cc'),
335             'user_id': False,
336         })
337         if msg.get('priority'):
338             custom_values['priority'] = msg.get('priority')
339         custom_values.update(self.message_partner_by_email(cr, uid, msg.get('from', False), context=context))
340         return super(hr_applicant,self).message_new(cr, uid, msg, custom_values=custom_values, context=context)
341
342     def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
343         """ Override mail_thread message_update that is called by the mailgateway
344             through message_process.
345             This method updates the document according to the email.
346         """
347         if isinstance(ids, (str, int, long)):
348             ids = [ids]
349         if update_vals is None: vals = {}
350         
351         update_vals.update({
352             'description': msg.get('body'),
353             'email_from': msg.get('from'),
354             'email_cc': msg.get('cc'),
355         })
356         if msg.get('priority'):
357             update_vals['priority'] = msg.get('priority')
358
359         maps = {
360             'cost': 'planned_cost',
361             'revenue': 'planned_revenue',
362             'probability': 'probability',
363         }
364         for line in msg.get('body_text', '').split('\n'):
365             line = line.strip()
366             res = tools.misc.command_re.match(line)
367             if res and maps.get(res.group(1).lower(), False):
368                 key = maps.get(res.group(1).lower())
369                 update_vals[key] = res.group(2).lower()
370
371         return super(hr_applicant, self).message_update(cr, uids, ids, update_vals=update_vals, context=context)
372
373     def create(self, cr, uid, vals, context=None):
374         obj_id = super(hr_applicant, self).create(cr, uid, vals, context=context)
375         self.create_send_note(cr, uid, [obj_id], context=context)
376         return obj_id
377
378     def case_open(self, cr, uid, ids, context=None):
379         """
380             open Request of the applicant for the hr_recruitment
381         """
382         res = super(hr_applicant, self).case_open(cr, uid, ids, context)
383         date = self.read(cr, uid, ids, ['date_open'])[0]
384         if not date['date_open']:
385             self.write(cr, uid, ids, {'date_open': time.strftime('%Y-%m-%d %H:%M:%S'),})
386         return res
387
388     def case_close(self, cr, uid, ids, context=None):
389         res = super(hr_applicant, self).case_close(cr, uid, ids, context)
390         return res
391
392     def case_close_with_emp(self, cr, uid, ids, context=None):
393         if context is None:
394             context = {}
395         hr_employee = self.pool.get('hr.employee')
396         model_data = self.pool.get('ir.model.data')
397         act_window = self.pool.get('ir.actions.act_window')
398         emp_id = False
399         for applicant in self.browse(cr, uid, ids, context=context):
400             address_id = False
401             if applicant.partner_id:
402                 address_id = applicant.partner_id.address_get(['contact'])['contact']
403             if applicant.job_id:
404                 applicant.job_id.write({'no_of_recruitment': applicant.job_id.no_of_recruitment - 1})
405                 emp_id = hr_employee.create(cr,uid,{'name': applicant.partner_name or applicant.name,
406                                                      'job_id': applicant.job_id.id,
407                                                      'address_home_id': address_id,
408                                                      'department_id': applicant.department_id.id
409                                                      })
410                 self.write(cr, uid, [applicant.id], {'emp_id': emp_id}, context=context)
411                 self.case_close(cr, uid, [applicant.id], context)
412             else:
413                 raise osv.except_osv(_('Warning!'),_('You must define Applied Job for this applicant.'))
414
415         action_model, action_id = model_data.get_object_reference(cr, uid, 'hr', 'open_view_employee_list')
416         dict_act_window = act_window.read(cr, uid, action_id, [])
417         if emp_id:
418             dict_act_window['res_id'] = emp_id
419         dict_act_window['view_mode'] = 'form,tree'
420         return dict_act_window
421
422     def case_cancel(self, cr, uid, ids, context=None):
423         """Overrides cancel for crm_case for setting probability
424         """
425         res = super(hr_applicant, self).case_cancel(cr, uid, ids, context)
426         self.write(cr, uid, ids, {'probability' : 0.0})
427         return res
428
429     def case_pending(self, cr, uid, ids, context=None):
430         """Marks case as pending"""
431         res = super(hr_applicant, self).case_pending(cr, uid, ids, context)
432         self.write(cr, uid, ids, {'probability' : 0.0})
433         return res
434
435     def case_reset(self, cr, uid, ids, context=None):
436         """Resets case as draft
437         """
438         res = super(hr_applicant, self).case_reset(cr, uid, ids, context)
439         self.write(cr, uid, ids, {'date_open': False, 'date_closed': False})
440         return res
441
442     def set_priority(self, cr, uid, ids, priority, *args):
443         """Set applicant priority
444         """
445         return self.write(cr, uid, ids, {'priority' : priority})
446
447     def set_high_priority(self, cr, uid, ids, *args):
448         """Set applicant priority to high
449         """
450         return self.set_priority(cr, uid, ids, '1')
451
452     def set_normal_priority(self, cr, uid, ids, *args):
453         """Set applicant priority to normal
454         """
455         return self.set_priority(cr, uid, ids, '3')
456
457     # -------------------------------------------------------
458     # OpenChatter methods and notifications
459     # -------------------------------------------------------
460
461     def message_get_subscribers(self, cr, uid, ids, context=None):
462         """ Override to add responsible user. """
463         user_ids = super(hr_applicant, self).message_get_subscribers(cr, uid, ids, context=context)
464         for obj in self.browse(cr, uid, ids, context=context):
465             if obj.user_id and not obj.user_id.id in user_ids:
466                 user_ids.append(obj.user_id.id)
467         return user_ids
468
469     def stage_set_send_note(self, cr, uid, ids, stage_id, context=None):
470         """ Override of the (void) default notification method. """
471         if not stage_id: return True
472         stage_name = self.pool.get('hr.recruitment.stage').name_get(cr, uid, [stage_id], context=context)[0][1]
473         return self.message_append_note(cr, uid, ids, body= _("Stage changed to <b>%s</b>.") % (stage_name), context=context)
474
475     def case_get_note_msg_prefix(self, cr, uid, id, context=None):
476                 return 'Applicant'
477
478     def case_open_send_note(self, cr, uid, ids, context=None):
479         message = _("Applicant has been set <b>in progress</b>.")
480         return self.message_append_note(cr, uid, ids, body=message, context=context)
481
482     def case_close_send_note(self, cr, uid, ids, context=None):
483         if context is None:
484             context = {}
485         for applicant in self.browse(cr, uid, ids, context=context):
486             if applicant.emp_id:
487                 message = _("Applicant has been <b>hired</b> and created as an employee.")
488                 self.message_append_note(cr, uid, [applicant.id], body=message, context=context)
489             else:
490                 message = _("Applicant has been <b>hired</b>.")
491                 self.message_append_note(cr, uid, [applicant.id], body=message, context=context)
492         return True
493
494     def case_cancel_send_note(self, cr, uid, ids, context=None):
495         msg = 'Applicant <b>refused</b>.'
496         return self.message_append_note(cr, uid, ids, body=msg, context=context)
497
498     def case_reset_send_note(self,  cr, uid, ids, context=None):
499         message =_("Applicant has been set as <b>new</b>.")
500         return self.message_append_note(cr, uid, ids, body=message, context=context)
501
502     def create_send_note(self, cr, uid, ids, context=None):
503         message = _("Applicant has been <b>created</b>.")
504         return self.message_append_note(cr, uid, ids, body=message, context=context)
505
506
507 class hr_job(osv.osv):
508     _inherit = "hr.job"
509     _name = "hr.job"
510     _columns = {
511         '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"),
512     }
513     
514     def action_print_survey(self, cr, uid, ids, context=None):
515         if context is None:
516             context = {}
517         datas = {}
518         record = self.browse(cr, uid, ids, context=context)[0]
519         if record.survey_id:
520             datas['ids'] = [record.survey_id.id]
521         datas['model'] = 'survey.print'
522         context.update({'response_id': [0], 'response_no': 0,})
523         return {
524                 'type': 'ir.actions.report.xml',
525                 'report_name': 'survey.form',
526                 'datas': datas,
527                 'context' : context,
528                 'nodestroy':True,
529             }
530
531 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: