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 ##############################################################################
23 from datetime import datetime, timedelta
24 from dateutil.relativedelta import relativedelta
26 from openerp.osv import fields, osv
27 from openerp.tools.translate import _
29 class hr_timesheet_sheet(osv.osv):
30 _name = "hr_timesheet_sheet.sheet"
31 _inherit = "mail.thread"
32 _table = 'hr_timesheet_sheet_sheet'
34 _description="Timesheet"
36 def _total(self, cr, uid, ids, name, args, context=None):
37 """ Compute the attendances, analytic lines timesheets and differences between them
38 for all the days of a timesheet and the current day
42 for sheet in self.browse(cr, uid, ids, context=context or {}):
43 res.setdefault(sheet.id, {
44 'total_attendance': 0.0,
45 'total_timesheet': 0.0,
46 'total_difference': 0.0,
48 for period in sheet.period_ids:
49 res[sheet.id]['total_attendance'] += period.total_attendance
50 res[sheet.id]['total_timesheet'] += period.total_timesheet
51 res[sheet.id]['total_difference'] += period.total_attendance - period.total_timesheet
54 def check_employee_attendance_state(self, cr, uid, sheet_id, context=None):
55 ids_signin = self.pool.get('hr.attendance').search(cr,uid,[('sheet_id', '=', sheet_id),('action','=','sign_in')])
56 ids_signout = self.pool.get('hr.attendance').search(cr,uid,[('sheet_id', '=', sheet_id),('action','=','sign_out')])
58 if len(ids_signin) != len(ids_signout):
59 raise osv.except_osv(('Warning!'),_('The timesheet cannot be validated as it does not contain an equal number of sign ins and sign outs.'))
62 def copy(self, cr, uid, ids, *args, **argv):
63 raise osv.except_osv(_('Error!'), _('You cannot duplicate a timesheet.'))
65 def create(self, cr, uid, vals, *args, **argv):
66 if 'employee_id' in vals:
67 if not self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).user_id:
68 raise osv.except_osv(_('Error!'), _('In order to create a timesheet for this employee, you must assign it to a user.'))
69 if not self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).product_id:
70 raise osv.except_osv(_('Error!'), _('In order to create a timesheet for this employee, you must link the employee to a product, like \'Consultant\'.'))
71 if not self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).journal_id:
72 raise osv.except_osv(_('Configuration Error!'), _('In order to create a timesheet for this employee, you must assign an analytic journal to the employee, like \'Timesheet Journal\'.'))
73 return super(hr_timesheet_sheet, self).create(cr, uid, vals, *args, **argv)
75 def write(self, cr, uid, ids, vals, *args, **argv):
76 if 'employee_id' in vals:
77 new_user_id = self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).user_id.id or False
79 raise osv.except_osv(_('Error!'), _('In order to create a timesheet for this employee, you must assign it to a user.'))
80 if not self._sheet_date(cr, uid, ids, forced_user_id=new_user_id):
81 raise osv.except_osv(_('Error!'), _('You cannot have 2 timesheets that overlap!\nYou should use the menu \'My Timesheet\' to avoid this problem.'))
82 if not self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).product_id:
83 raise osv.except_osv(_('Error!'), _('In order to create a timesheet for this employee, you must link the employee to a product.'))
84 if not self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).journal_id:
85 raise osv.except_osv(_('Configuration Error!'), _('In order to create a timesheet for this employee, you must assign an analytic journal to the employee, like \'Timesheet Journal\'.'))
86 return super(hr_timesheet_sheet, self).write(cr, uid, ids, vals, *args, **argv)
88 def button_confirm(self, cr, uid, ids, context=None):
89 for sheet in self.browse(cr, uid, ids, context=context):
90 if sheet.employee_id and sheet.employee_id.parent_id and sheet.employee_id.parent_id.user_id:
91 self.message_subscribe_users(cr, uid, [sheet.id], user_ids=[sheet.employee_id.parent_id.user_id.id], context=context)
92 self.check_employee_attendance_state(cr, uid, sheet.id, context=context)
93 di = sheet.user_id.company_id.timesheet_max_difference
94 if (abs(sheet.total_difference) < di) or not di:
95 self.signal_confirm(cr, uid, [sheet.id])
97 raise osv.except_osv(_('Warning!'), _('Please verify that the total difference of the sheet is lower than %.2f.') %(di,))
100 def attendance_action_change(self, cr, uid, ids, context=None):
101 hr_employee = self.pool.get('hr.employee')
103 for sheet in self.browse(cr, uid, ids, context=context):
104 if sheet.employee_id.id not in employee_ids: employee_ids.append(sheet.employee_id.id)
105 return hr_employee.attendance_action_change(cr, uid, employee_ids, context=context)
108 'name': fields.char('Note', size=64, select=1,
109 states={'confirm':[('readonly', True)], 'done':[('readonly', True)]}),
110 'employee_id': fields.many2one('hr.employee', 'Employee', required=True),
111 'user_id': fields.related('employee_id', 'user_id', type="many2one", relation="res.users", store=True, string="User", required=False, readonly=True),#fields.many2one('res.users', 'User', required=True, select=1, states={'confirm':[('readonly', True)], 'done':[('readonly', True)]}),
112 'date_from': fields.date('Date from', required=True, select=1, readonly=True, states={'new':[('readonly', False)]}),
113 'date_to': fields.date('Date to', required=True, select=1, readonly=True, states={'new':[('readonly', False)]}),
114 'timesheet_ids' : fields.one2many('hr.analytic.timesheet', 'sheet_id',
116 readonly=True, states={
117 'draft': [('readonly', False)],
118 'new': [('readonly', False)]}
120 'attendances_ids' : fields.one2many('hr.attendance', 'sheet_id', 'Attendances'),
121 'state' : fields.selection([
124 ('confirm','Waiting Approval'),
125 ('done','Approved')], 'Status', select=True, required=True, readonly=True,
126 help=' * The \'Draft\' status is used when a user is encoding a new and unconfirmed timesheet. \
127 \n* The \'Confirmed\' status is used for to confirm the timesheet by user. \
128 \n* The \'Done\' status is used when users timesheet is accepted by his/her senior.'),
129 'state_attendance' : fields.related('employee_id', 'state', type='selection', selection=[('absent', 'Absent'), ('present', 'Present')], string='Current Status', readonly=True),
130 'total_attendance': fields.function(_total, method=True, string='Total Attendance', multi="_total"),
131 'total_timesheet': fields.function(_total, method=True, string='Total Timesheet', multi="_total"),
132 'total_difference': fields.function(_total, method=True, string='Difference', multi="_total"),
133 'period_ids': fields.one2many('hr_timesheet_sheet.sheet.day', 'sheet_id', 'Period', readonly=True),
134 'account_ids': fields.one2many('hr_timesheet_sheet.sheet.account', 'sheet_id', 'Analytic accounts', readonly=True),
135 'company_id': fields.many2one('res.company', 'Company'),
136 'department_id':fields.many2one('hr.department','Department'),
139 def _default_date_from(self, cr, uid, context=None):
140 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
141 r = user.company_id and user.company_id.timesheet_range or 'month'
143 return time.strftime('%Y-%m-01')
145 return (datetime.today() + relativedelta(weekday=0, days=-6)).strftime('%Y-%m-%d')
147 return time.strftime('%Y-01-01')
148 return time.strftime('%Y-%m-%d')
150 def _default_date_to(self, cr, uid, context=None):
151 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
152 r = user.company_id and user.company_id.timesheet_range or 'month'
154 return (datetime.today() + relativedelta(months=+1,day=1,days=-1)).strftime('%Y-%m-%d')
156 return (datetime.today() + relativedelta(weekday=6)).strftime('%Y-%m-%d')
158 return time.strftime('%Y-12-31')
159 return time.strftime('%Y-%m-%d')
161 def _default_employee(self, cr, uid, context=None):
162 emp_ids = self.pool.get('hr.employee').search(cr, uid, [('user_id','=',uid)], context=context)
163 return emp_ids and emp_ids[0] or False
166 'date_from' : _default_date_from,
167 'date_to' : _default_date_to,
169 'employee_id': _default_employee,
170 'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'hr_timesheet_sheet.sheet', context=c)
173 def _sheet_date(self, cr, uid, ids, forced_user_id=False, context=None):
174 for sheet in self.browse(cr, uid, ids, context=context):
175 new_user_id = forced_user_id or sheet.user_id and sheet.user_id.id
177 cr.execute('SELECT id \
178 FROM hr_timesheet_sheet_sheet \
179 WHERE (date_from <= %s and %s <= date_to) \
181 AND id <> %s',(sheet.date_to, sheet.date_from, new_user_id, sheet.id))
188 (_sheet_date, 'You cannot have 2 timesheets that overlap!\nPlease use the menu \'My Current Timesheet\' to avoid this problem.', ['date_from','date_to']),
191 def action_set_to_draft(self, cr, uid, ids, *args):
192 self.write(cr, uid, ids, {'state': 'draft'})
193 self.create_workflow(cr, uid, ids)
196 def name_get(self, cr, uid, ids, context=None):
199 if isinstance(ids, (long, int)):
201 return [(r['id'], _('Week ')+datetime.strptime(r['date_from'], '%Y-%m-%d').strftime('%U')) \
202 for r in self.read(cr, uid, ids, ['date_from'],
203 context=context, load='_classic_write')]
205 def unlink(self, cr, uid, ids, context=None):
206 sheets = self.read(cr, uid, ids, ['state','total_attendance'], context=context)
208 if sheet['state'] in ('confirm', 'done'):
209 raise osv.except_osv(_('Invalid Action!'), _('You cannot delete a timesheet which is already confirmed.'))
210 elif sheet['total_attendance'] <> 0.00:
211 raise osv.except_osv(_('Invalid Action!'), _('You cannot delete a timesheet which have attendance entries.'))
212 return super(hr_timesheet_sheet, self).unlink(cr, uid, ids, context=context)
214 def onchange_employee_id(self, cr, uid, ids, employee_id, context=None):
215 department_id = False
218 empl_id = self.pool.get('hr.employee').browse(cr, uid, employee_id, context=context)
219 department_id = empl_id.department_id.id
220 user_id = empl_id.user_id.id
221 return {'value': {'department_id': department_id, 'user_id': user_id,}}
223 # ------------------------------------------------
224 # OpenChatter methods and notifications
225 # ------------------------------------------------
227 def _needaction_domain_get(self, cr, uid, context=None):
228 emp_obj = self.pool.get('hr.employee')
229 empids = emp_obj.search(cr, uid, [('parent_id.user_id', '=', uid)], context=context)
232 dom = ['&', ('state', '=', 'confirm'), ('employee_id', 'in', empids)]
236 class account_analytic_line(osv.osv):
237 _inherit = "account.analytic.line"
239 def _get_default_date(self, cr, uid, context=None):
242 #get the default date (should be: today)
243 res = super(account_analytic_line, self)._get_default_date(cr, uid, context=context)
244 #if we got the dates from and to from the timesheet and if the default date is in between, we use the default
245 #but if the default isn't included in those dates, we use the date start of the timesheet as default
246 if context.get('timesheet_date_from') and context.get('timesheet_date_to'):
247 if context['timesheet_date_from'] <= res <= context['timesheet_date_to']:
249 return context.get('timesheet_date_from')
250 #if we don't get the dates from the timesheet, we return the default value from super()
254 class hr_timesheet_line(osv.osv):
255 _inherit = "hr.analytic.timesheet"
257 def _sheet(self, cursor, user, ids, name, args, context=None):
258 sheet_obj = self.pool.get('hr_timesheet_sheet.sheet')
259 res = {}.fromkeys(ids, False)
260 for ts_line in self.browse(cursor, user, ids, context=context):
261 sheet_ids = sheet_obj.search(cursor, user,
262 [('date_to', '>=', ts_line.date), ('date_from', '<=', ts_line.date),
263 ('employee_id.user_id', '=', ts_line.user_id.id)],
266 # [0] because only one sheet possible for an employee between 2 dates
267 res[ts_line.id] = sheet_obj.name_get(cursor, user, sheet_ids, context=context)[0]
270 def _get_hr_timesheet_sheet(self, cr, uid, ids, context=None):
272 for ts in self.browse(cr, uid, ids, context=context):
275 FROM hr_analytic_timesheet l
276 INNER JOIN account_analytic_line al
277 ON (l.line_id = al.id)
278 WHERE %(date_to)s >= al.date
279 AND %(date_from)s <= al.date
280 AND %(user_id)s = al.user_id
281 GROUP BY l.id""", {'date_from': ts.date_from,
282 'date_to': ts.date_to,
283 'user_id': ts.employee_id.user_id.id,})
284 ts_line_ids.extend([row[0] for row in cr.fetchall()])
287 def _get_account_analytic_line(self, cr, uid, ids, context=None):
288 ts_line_ids = self.pool.get('hr.analytic.timesheet').search(cr, uid, [('line_id', 'in', ids)])
292 'sheet_id': fields.function(_sheet, string='Sheet', select="1",
293 type='many2one', relation='hr_timesheet_sheet.sheet', ondelete="cascade",
295 'hr_timesheet_sheet.sheet': (_get_hr_timesheet_sheet, ['employee_id', 'date_from', 'date_to'], 10),
296 'account.analytic.line': (_get_account_analytic_line, ['user_id', 'date'], 10),
297 'hr.analytic.timesheet': (lambda self,cr,uid,ids,context=None: ids, None, 10),
302 def _check_sheet_state(self, cr, uid, ids, context=None):
305 for timesheet_line in self.browse(cr, uid, ids, context=context):
306 if timesheet_line.sheet_id and timesheet_line.sheet_id.state not in ('draft', 'new'):
311 (_check_sheet_state, 'You cannot modify an entry in a Confirmed/Done timesheet !', ['state']),
314 def unlink(self, cr, uid, ids, *args, **kwargs):
315 if isinstance(ids, (int, long)):
317 self._check(cr, uid, ids)
318 return super(hr_timesheet_line,self).unlink(cr, uid, ids,*args, **kwargs)
320 def _check(self, cr, uid, ids):
321 for att in self.browse(cr, uid, ids):
322 if att.sheet_id and att.sheet_id.state not in ('draft', 'new'):
323 raise osv.except_osv(_('Error!'), _('You cannot modify an entry in a confirmed timesheet.'))
326 def multi_on_change_account_id(self, cr, uid, ids, account_ids, context=None):
327 return dict([(el, self.on_change_account_id(cr, uid, ids, el, context.get('user_id', uid))) for el in account_ids])
331 class hr_attendance(osv.osv):
332 _inherit = "hr.attendance"
334 def _get_default_date(self, cr, uid, context=None):
337 if 'name' in context:
338 return context['name'] + time.strftime(' %H:%M:%S')
339 return time.strftime('%Y-%m-%d %H:%M:%S')
341 def _get_hr_timesheet_sheet(self, cr, uid, ids, context=None):
343 for ts in self.browse(cr, uid, ids, context=context):
347 INNER JOIN hr_employee e
348 INNER JOIN resource_resource r
349 ON (e.resource_id = r.id)
350 ON (a.employee_id = e.id)
351 WHERE %(date_to)s >= date_trunc('day', a.name)
352 AND %(date_from)s <= a.name
353 AND %(user_id)s = r.user_id
354 GROUP BY a.id""", {'date_from': ts.date_from,
355 'date_to': ts.date_to,
356 'user_id': ts.employee_id.user_id.id,})
357 attendance_ids.extend([row[0] for row in cr.fetchall()])
358 return attendance_ids
360 def _sheet(self, cursor, user, ids, name, args, context=None):
361 sheet_obj = self.pool.get('hr_timesheet_sheet.sheet')
362 res = {}.fromkeys(ids, False)
363 for attendance in self.browse(cursor, user, ids, context=context):
364 date_to = datetime.strftime(datetime.strptime(attendance.name[0:10], '%Y-%m-%d'), '%Y-%m-%d %H:%M:%S')
365 sheet_ids = sheet_obj.search(cursor, user,
366 [('date_to', '>=', date_to), ('date_from', '<=', attendance.name),
367 ('employee_id', '=', attendance.employee_id.id)],
370 # [0] because only one sheet possible for an employee between 2 dates
371 res[attendance.id] = sheet_obj.name_get(cursor, user, sheet_ids, context=context)[0]
375 'sheet_id': fields.function(_sheet, string='Sheet',
376 type='many2one', relation='hr_timesheet_sheet.sheet',
378 'hr_timesheet_sheet.sheet': (_get_hr_timesheet_sheet, ['employee_id', 'date_from', 'date_to'], 10),
379 'hr.attendance': (lambda self,cr,uid,ids,context=None: ids, ['employee_id', 'name', 'day'], 10),
384 'name': _get_default_date,
387 def create(self, cr, uid, vals, context=None):
390 if 'sheet_id' in context:
391 ts = self.pool.get('hr_timesheet_sheet.sheet').browse(cr, uid, context['sheet_id'], context=context)
392 if ts.state not in ('draft', 'new'):
393 raise osv.except_osv(_('Error!'), _('You cannot modify an entry in a confirmed timesheet.'))
394 res = super(hr_attendance,self).create(cr, uid, vals, context=context)
395 if 'sheet_id' in context:
396 if context['sheet_id'] != self.browse(cr, uid, res, context=context).sheet_id.id:
397 raise osv.except_osv(_('User Error!'), _('You cannot enter an attendance ' \
398 'date outside the current timesheet dates.'))
401 def unlink(self, cr, uid, ids, *args, **kwargs):
402 if isinstance(ids, (int, long)):
404 self._check(cr, uid, ids)
405 return super(hr_attendance,self).unlink(cr, uid, ids,*args, **kwargs)
407 def write(self, cr, uid, ids, vals, context=None):
410 if isinstance(ids, (int, long)):
412 self._check(cr, uid, ids)
413 res = super(hr_attendance,self).write(cr, uid, ids, vals, context=context)
414 if 'sheet_id' in context:
415 for attendance in self.browse(cr, uid, ids, context=context):
416 if context['sheet_id'] != attendance.sheet_id.id:
417 raise osv.except_osv(_('User Error!'), _('You cannot enter an attendance ' \
418 'date outside the current timesheet dates.'))
421 def _check(self, cr, uid, ids):
422 for att in self.browse(cr, uid, ids):
423 if att.sheet_id and att.sheet_id.state not in ('draft', 'new'):
424 raise osv.except_osv(_('Error!'), _('You cannot modify an entry in a confirmed timesheet'))
428 class hr_timesheet_sheet_sheet_day(osv.osv):
429 _name = "hr_timesheet_sheet.sheet.day"
430 _description = "Timesheets by Period"
434 'name': fields.date('Date', readonly=True),
435 'sheet_id': fields.many2one('hr_timesheet_sheet.sheet', 'Sheet', readonly=True, select="1"),
436 'total_timesheet': fields.float('Total Timesheet', readonly=True),
437 'total_attendance': fields.float('Attendance', readonly=True),
438 'total_difference': fields.float('Difference', readonly=True),
442 cr.execute("""create or replace view hr_timesheet_sheet_sheet_day as
449 cast(round(cast(total_attendance - total_timesheet as Numeric),2) as Double Precision) AS total_difference
456 SUM(total_timesheet) as total_timesheet,
457 CASE WHEN SUM(total_attendance) < 0
458 THEN (SUM(total_attendance) +
459 CASE WHEN current_date <> name
461 ELSE (EXTRACT(hour FROM current_time AT TIME ZONE 'UTC') * 60) + EXTRACT(minute FROM current_time AT TIME ZONE 'UTC')
464 ELSE SUM(total_attendance)
465 END /60 as total_attendance
470 l.date::date as name,
472 sum(l.unit_amount) as total_timesheet,
473 0.0 as total_attendance
475 hr_analytic_timesheet hrt
476 JOIN account_analytic_line l ON l.id = hrt.line_id
477 LEFT JOIN hr_timesheet_sheet_sheet s ON s.id = hrt.sheet_id
478 group by l.date::date, s.id
482 a.name::date as name,
484 0.0 as total_timesheet,
485 SUM(((EXTRACT(hour FROM a.name) * 60) + EXTRACT(minute FROM a.name)) * (CASE WHEN a.action = 'sign_in' THEN -1 ELSE 1 END)) as total_attendance
488 LEFT JOIN hr_timesheet_sheet_sheet s
490 WHERE action in ('sign_in', 'sign_out')
491 group by a.name::date, s.id
493 GROUP BY name, sheet_id
498 class hr_timesheet_sheet_sheet_account(osv.osv):
499 _name = "hr_timesheet_sheet.sheet.account"
500 _description = "Timesheets by Period"
504 'name': fields.many2one('account.analytic.account', 'Project / Analytic Account', readonly=True),
505 'sheet_id': fields.many2one('hr_timesheet_sheet.sheet', 'Sheet', readonly=True),
506 'total': fields.float('Total Time', digits=(16,2), readonly=True),
507 'invoice_rate': fields.many2one('hr_timesheet_invoice.factor', 'Invoice rate', readonly=True),
511 cr.execute("""create or replace view hr_timesheet_sheet_sheet_account as (
514 l.account_id as name,
516 sum(l.unit_amount) as total,
517 l.to_invoice as invoice_rate
519 hr_analytic_timesheet hrt
520 left join (account_analytic_line l
521 LEFT JOIN hr_timesheet_sheet_sheet s
522 ON (s.date_to >= l.date
523 AND s.date_from <= l.date
524 AND s.user_id = l.user_id))
525 on (l.id = hrt.line_id)
526 group by l.account_id, s.id, l.to_invoice
532 class res_company(osv.osv):
533 _inherit = 'res.company'
535 'timesheet_range': fields.selection(
536 [('day','Day'),('week','Week'),('month','Month')], 'Timesheet range',
537 help="Periodicity on which you validate your timesheets."),
538 'timesheet_max_difference': fields.float('Timesheet allowed difference(Hours)',
539 help="Allowed difference in hours between the sign in/out and the timesheet " \
540 "computation for one sheet. Set this to 0 if you do not want any control."),
543 'timesheet_range': lambda *args: 'week',
544 'timesheet_max_difference': lambda *args: 0.0
548 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: