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 osv import fields, osv
27 from tools.translate import _
30 class hr_timesheet_sheet(osv.osv):
31 _name = "hr_timesheet_sheet.sheet"
32 _inherit = "mail.thread"
33 _table = 'hr_timesheet_sheet_sheet'
35 _description="Timesheet"
37 def _total(self, cr, uid, ids, name, args, context=None):
38 """ Compute the attendances, analytic lines timesheets and differences between them
39 for all the days of a timesheet and the current day
43 for sheet in self.browse(cr, uid, ids, context=context or {}):
44 res.setdefault(sheet.id, {
45 'total_attendance': 0.0,
46 'total_timesheet': 0.0,
47 'total_difference': 0.0,
49 for period in sheet.period_ids:
50 res[sheet.id]['total_attendance'] += period.total_attendance
51 res[sheet.id]['total_timesheet'] += period.total_timesheet
52 res[sheet.id]['total_difference'] += period.total_attendance - period.total_timesheet
55 def check_employee_attendance_state(self, cr, uid, sheet_id, context=None):
56 ids_signin = self.pool.get('hr.attendance').search(cr,uid,[('sheet_id', '=', sheet_id),('action','=','sign_in')])
57 ids_signout = self.pool.get('hr.attendance').search(cr,uid,[('sheet_id', '=', sheet_id),('action','=','sign_out')])
59 if len(ids_signin) != len(ids_signout):
60 raise osv.except_osv(('Warning!'),_('The timesheet cannot be validated as it does not contain an equal number of sign ins and sign outs.'))
63 def copy(self, cr, uid, ids, *args, **argv):
64 raise osv.except_osv(_('Error!'), _('You cannot duplicate a timesheet.'))
66 def create(self, cr, uid, vals, *args, **argv):
67 if 'employee_id' in vals:
68 if not self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).user_id:
69 raise osv.except_osv(_('Error!'), _('In order to create a timesheet for this employee, you must assign it to a user.'))
70 if not self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).product_id:
71 raise osv.except_osv(_('Error!'), _('In order to create a timesheet for this employee, you must link the employee to a product, like \'Consultant\'.'))
72 if not self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).journal_id:
73 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\'.'))
74 return super(hr_timesheet_sheet, self).create(cr, uid, vals, *args, **argv)
76 def write(self, cr, uid, ids, vals, *args, **argv):
77 if 'employee_id' in vals:
78 new_user_id = self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).user_id.id or False
80 raise osv.except_osv(_('Error!'), _('In order to create a timesheet for this employee, you must assign it to a user.'))
81 if not self._sheet_date(cr, uid, ids, forced_user_id=new_user_id):
82 raise osv.except_osv(_('Error!'), _('You cannot have 2 timesheets that overlap!\nYou should use the menu \'My Timesheet\' to avoid this problem.'))
83 if not self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).product_id:
84 raise osv.except_osv(_('Error!'), _('In order to create a timesheet for this employee, you must link the employee to a product.'))
85 if not self.pool.get('hr.employee').browse(cr, uid, vals['employee_id']).journal_id:
86 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\'.'))
87 return super(hr_timesheet_sheet, self).write(cr, uid, ids, vals, *args, **argv)
89 def button_confirm(self, cr, uid, ids, context=None):
90 for sheet in self.browse(cr, uid, ids, context=context):
91 if sheet.employee_id and sheet.employee_id.parent_id and sheet.employee_id.parent_id.user_id:
92 self.message_subscribe_users(cr, uid, [sheet.id], user_ids=[sheet.employee_id.parent_id.user_id.id], context=context)
93 self.check_employee_attendance_state(cr, uid, sheet.id, context=context)
94 di = sheet.user_id.company_id.timesheet_max_difference
95 if (abs(sheet.total_difference) < di) or not di:
96 wf_service = netsvc.LocalService("workflow")
97 wf_service.trg_validate(uid, 'hr_timesheet_sheet.sheet', sheet.id, 'confirm', cr)
99 raise osv.except_osv(_('Warning!'), _('Please verify that the total difference of the sheet is lower than %.2f.') %(di,))
102 def attendance_action_change(self, cr, uid, ids, context=None):
103 hr_employee = self.pool.get('hr.employee')
105 for sheet in self.browse(cr, uid, ids, context=context):
106 if sheet.employee_id.id not in employee_ids: employee_ids.append(sheet.employee_id.id)
107 return hr_employee.attendance_action_change(cr, uid, employee_ids, context=context)
110 'name': fields.char('Note', size=64, select=1,
111 states={'confirm':[('readonly', True)], 'done':[('readonly', True)]}),
112 'employee_id': fields.many2one('hr.employee', 'Employee', required=True),
113 '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)]}),
114 'date_from': fields.date('Date from', required=True, select=1, readonly=True, states={'new':[('readonly', False)]}),
115 'date_to': fields.date('Date to', required=True, select=1, readonly=True, states={'new':[('readonly', False)]}),
116 'timesheet_ids' : fields.one2many('hr.analytic.timesheet', 'sheet_id',
118 readonly=True, states={
119 'draft': [('readonly', False)],
120 'new': [('readonly', False)]}
122 'attendances_ids' : fields.one2many('hr.attendance', 'sheet_id', 'Attendances'),
123 'state' : fields.selection([
126 ('confirm','Waiting Approval'),
127 ('done','Approved')], 'Status', select=True, required=True, readonly=True,
128 help=' * The \'Draft\' status is used when a user is encoding a new and unconfirmed timesheet. \
129 \n* The \'Confirmed\' status is used for to confirm the timesheet by user. \
130 \n* The \'Done\' status is used when users timesheet is accepted by his/her senior.'),
131 'state_attendance' : fields.related('employee_id', 'state', type='selection', selection=[('absent', 'Absent'), ('present', 'Present')], string='Current Status', readonly=True),
132 'total_attendance': fields.function(_total, method=True, string='Total Attendance', multi="_total"),
133 'total_timesheet': fields.function(_total, method=True, string='Total Timesheet', multi="_total"),
134 'total_difference': fields.function(_total, method=True, string='Difference', multi="_total"),
135 'period_ids': fields.one2many('hr_timesheet_sheet.sheet.day', 'sheet_id', 'Period', readonly=True),
136 'account_ids': fields.one2many('hr_timesheet_sheet.sheet.account', 'sheet_id', 'Analytic accounts', readonly=True),
137 'company_id': fields.many2one('res.company', 'Company'),
138 'department_id':fields.many2one('hr.department','Department'),
141 def _default_date_from(self, cr, uid, context=None):
142 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
143 r = user.company_id and user.company_id.timesheet_range or 'month'
145 return time.strftime('%Y-%m-01')
147 return (datetime.today() + relativedelta(weekday=0, days=-6)).strftime('%Y-%m-%d')
149 return time.strftime('%Y-01-01')
150 return time.strftime('%Y-%m-%d')
152 def _default_date_to(self, cr, uid, context=None):
153 user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
154 r = user.company_id and user.company_id.timesheet_range or 'month'
156 return (datetime.today() + relativedelta(months=+1,day=1,days=-1)).strftime('%Y-%m-%d')
158 return (datetime.today() + relativedelta(weekday=6)).strftime('%Y-%m-%d')
160 return time.strftime('%Y-12-31')
161 return time.strftime('%Y-%m-%d')
163 def _default_employee(self, cr, uid, context=None):
164 emp_ids = self.pool.get('hr.employee').search(cr, uid, [('user_id','=',uid)], context=context)
165 return emp_ids and emp_ids[0] or False
168 'date_from' : _default_date_from,
169 'date_to' : _default_date_to,
171 'employee_id': _default_employee,
172 'company_id': lambda self, cr, uid, c: self.pool.get('res.company')._company_default_get(cr, uid, 'hr_timesheet_sheet.sheet', context=c),
173 'user_id': _default_employee
176 def _sheet_date(self, cr, uid, ids, forced_user_id=False, context=None):
177 for sheet in self.browse(cr, uid, ids, context=context):
178 new_user_id = forced_user_id or sheet.user_id and sheet.user_id.id
180 cr.execute('SELECT id \
181 FROM hr_timesheet_sheet_sheet \
182 WHERE (date_from <= %s and %s <= date_to) \
184 AND id <> %s',(sheet.date_to, sheet.date_from, new_user_id, sheet.id))
191 (_sheet_date, 'You cannot have 2 timesheets that overlap!\nPlease use the menu \'My Current Timesheet\' to avoid this problem.', ['date_from','date_to']),
194 def action_set_to_draft(self, cr, uid, ids, *args):
195 self.write(cr, uid, ids, {'state': 'draft'})
196 wf_service = netsvc.LocalService('workflow')
198 wf_service.trg_create(uid, self._name, id, cr)
201 def name_get(self, cr, uid, ids, context=None):
204 if isinstance(ids, (long, int)):
206 return [(r['id'], _('Week ')+datetime.strptime(r['date_from'], '%Y-%m-%d').strftime('%U')) \
207 for r in self.read(cr, uid, ids, ['date_from'],
208 context=context, load='_classic_write')]
210 def unlink(self, cr, uid, ids, context=None):
211 sheets = self.read(cr, uid, ids, ['state','total_attendance'], context=context)
213 if sheet['state'] in ('confirm', 'done'):
214 raise osv.except_osv(_('Invalid Action!'), _('You cannot delete a timesheet which is already confirmed.'))
215 elif sheet['total_attendance'] <> 0.00:
216 raise osv.except_osv(_('Invalid Action!'), _('You cannot delete a timesheet which have attendance entries.'))
217 return super(hr_timesheet_sheet, self).unlink(cr, uid, ids, context=context)
219 def onchange_employee_id(self, cr, uid, ids, employee_id, context=None):
220 department_id = False
222 department_id = self.pool.get('hr.employee').browse(cr, uid, employee_id, context=context).department_id.id
223 return {'value': {'department_id': department_id}}
227 class account_analytic_line(osv.osv):
228 _inherit = "account.analytic.line"
230 def _get_default_date(self, cr, uid, context=None):
233 #get the default date (should be: today)
234 res = super(account_analytic_line, self)._get_default_date(cr, uid, context=context)
235 #if we got the dates from and to from the timesheet and if the default date is in between, we use the default
236 #but if the default isn't included in those dates, we use the date start of the timesheet as default
237 if context.get('timesheet_date_from') and context.get('timesheet_date_to'):
238 if context['timesheet_date_from'] <= res <= context['timesheet_date_to']:
240 return context.get('timesheet_date_from')
241 #if we don't get the dates from the timesheet, we return the default value from super()
245 class hr_timesheet_line(osv.osv):
246 _inherit = "hr.analytic.timesheet"
248 def _sheet(self, cursor, user, ids, name, args, context=None):
249 sheet_obj = self.pool.get('hr_timesheet_sheet.sheet')
250 res = {}.fromkeys(ids, False)
251 for ts_line in self.browse(cursor, user, ids, context=context):
252 sheet_ids = sheet_obj.search(cursor, user,
253 [('date_to', '>=', ts_line.date), ('date_from', '<=', ts_line.date),
254 ('employee_id.user_id', '=', ts_line.user_id.id)],
257 # [0] because only one sheet possible for an employee between 2 dates
258 res[ts_line.id] = sheet_obj.name_get(cursor, user, sheet_ids, context=context)[0]
261 def _get_hr_timesheet_sheet(self, cr, uid, ids, context=None):
263 for ts in self.browse(cr, uid, ids, context=context):
266 FROM hr_analytic_timesheet l
267 INNER JOIN account_analytic_line al
268 ON (l.line_id = al.id)
269 WHERE %(date_to)s >= al.date
270 AND %(date_from)s <= al.date
271 AND %(user_id)s = al.user_id
272 GROUP BY l.id""", {'date_from': ts.date_from,
273 'date_to': ts.date_to,
274 'user_id': ts.employee_id.user_id.id,})
275 ts_line_ids.extend([row[0] for row in cr.fetchall()])
278 def _get_account_analytic_line(self, cr, uid, ids, context=None):
279 ts_line_ids = self.pool.get('hr.analytic.timesheet').search(cr, uid, [('line_id', 'in', ids)])
283 'sheet_id': fields.function(_sheet, string='Sheet',
284 type='many2one', relation='hr_timesheet_sheet.sheet', ondelete="cascade",
286 'hr_timesheet_sheet.sheet': (_get_hr_timesheet_sheet, ['employee_id', 'date_from', 'date_to'], 10),
287 'account.analytic.line': (_get_account_analytic_line, ['user_id', 'date'], 10),
288 'hr.analytic.timesheet': (lambda self,cr,uid,ids,context=None: ids, None, 10),
293 def _check_sheet_state(self, cr, uid, ids, context=None):
296 for timesheet_line in self.browse(cr, uid, ids, context=context):
297 if timesheet_line.sheet_id and timesheet_line.sheet_id.state not in ('draft', 'new'):
302 (_check_sheet_state, 'You cannot modify an entry in a Confirmed/Done timesheet !', ['state']),
305 def unlink(self, cr, uid, ids, *args, **kwargs):
306 if isinstance(ids, (int, long)):
308 self._check(cr, uid, ids)
309 return super(hr_timesheet_line,self).unlink(cr, uid, ids,*args, **kwargs)
311 def _check(self, cr, uid, ids):
312 for att in self.browse(cr, uid, ids):
313 if att.sheet_id and att.sheet_id.state not in ('draft', 'new'):
314 raise osv.except_osv(_('Error!'), _('You cannot modify an entry in a confirmed timesheet.'))
317 def multi_on_change_account_id(self, cr, uid, ids, account_ids, context=None):
318 return dict([(el, self.on_change_account_id(cr, uid, ids, el, context.get('user_id', uid))) for el in account_ids])
323 class hr_attendance(osv.osv):
324 _inherit = "hr.attendance"
326 def _get_default_date(self, cr, uid, context=None):
329 if 'name' in context:
330 return context['name'] + time.strftime(' %H:%M:%S')
331 return time.strftime('%Y-%m-%d %H:%M:%S')
333 def _get_hr_timesheet_sheet(self, cr, uid, ids, context=None):
335 for ts in self.browse(cr, uid, ids, context=context):
339 INNER JOIN hr_employee e
340 INNER JOIN resource_resource r
341 ON (e.resource_id = r.id)
342 ON (a.employee_id = e.id)
343 WHERE %(date_to)s >= date_trunc('day', a.name)
344 AND %(date_from)s <= a.name
345 AND %(user_id)s = r.user_id
346 GROUP BY a.id""", {'date_from': ts.date_from,
347 'date_to': ts.date_to,
348 'user_id': ts.employee_id.user_id.id,})
349 attendance_ids.extend([row[0] for row in cr.fetchall()])
350 return attendance_ids
352 def _sheet(self, cursor, user, ids, name, args, context=None):
353 sheet_obj = self.pool.get('hr_timesheet_sheet.sheet')
354 res = {}.fromkeys(ids, False)
355 for attendance in self.browse(cursor, user, ids, context=context):
356 date_to = datetime.strftime(datetime.strptime(attendance.name[0:10], '%Y-%m-%d'), '%Y-%m-%d %H:%M:%S')
357 sheet_ids = sheet_obj.search(cursor, user,
358 [('date_to', '>=', date_to), ('date_from', '<=', attendance.name),
359 ('employee_id', '=', attendance.employee_id.id)],
362 # [0] because only one sheet possible for an employee between 2 dates
363 res[attendance.id] = sheet_obj.name_get(cursor, user, sheet_ids, context=context)[0]
367 'sheet_id': fields.function(_sheet, string='Sheet',
368 type='many2one', relation='hr_timesheet_sheet.sheet',
370 'hr_timesheet_sheet.sheet': (_get_hr_timesheet_sheet, ['employee_id', 'date_from', 'date_to'], 10),
371 'hr.attendance': (lambda self,cr,uid,ids,context=None: ids, ['employee_id', 'name', 'day'], 10),
376 'name': _get_default_date,
379 def create(self, cr, uid, vals, context=None):
382 if 'sheet_id' in context:
383 ts = self.pool.get('hr_timesheet_sheet.sheet').browse(cr, uid, context['sheet_id'], context=context)
384 if ts.state not in ('draft', 'new'):
385 raise osv.except_osv(_('Error!'), _('You cannot modify an entry in a confirmed timesheet.'))
386 res = super(hr_attendance,self).create(cr, uid, vals, context=context)
387 if 'sheet_id' in context:
388 if context['sheet_id'] != self.browse(cr, uid, res, context=context).sheet_id.id:
389 raise osv.except_osv(_('User Error!'), _('You cannot enter an attendance ' \
390 'date outside the current timesheet dates.'))
393 def unlink(self, cr, uid, ids, *args, **kwargs):
394 if isinstance(ids, (int, long)):
396 self._check(cr, uid, ids)
397 return super(hr_attendance,self).unlink(cr, uid, ids,*args, **kwargs)
399 def write(self, cr, uid, ids, vals, context=None):
402 if isinstance(ids, (int, long)):
404 self._check(cr, uid, ids)
405 res = super(hr_attendance,self).write(cr, uid, ids, vals, context=context)
406 if 'sheet_id' in context:
407 for attendance in self.browse(cr, uid, ids, context=context):
408 if context['sheet_id'] != attendance.sheet_id.id:
409 raise osv.except_osv(_('User Error!'), _('You cannot enter an attendance ' \
410 'date outside the current timesheet dates.'))
413 def _check(self, cr, uid, ids):
414 for att in self.browse(cr, uid, ids):
415 if att.sheet_id and att.sheet_id.state not in ('draft', 'new'):
416 raise osv.except_osv(_('Error!'), _('You cannot modify an entry in a confirmed timesheet'))
421 class hr_timesheet_sheet_sheet_day(osv.osv):
422 _name = "hr_timesheet_sheet.sheet.day"
423 _description = "Timesheets by Period"
427 'name': fields.date('Date', readonly=True),
428 'sheet_id': fields.many2one('hr_timesheet_sheet.sheet', 'Sheet', readonly=True, select="1"),
429 'total_timesheet': fields.float('Total Timesheet', readonly=True),
430 'total_attendance': fields.float('Attendance', readonly=True),
431 'total_difference': fields.float('Difference', readonly=True),
435 cr.execute("""create or replace view hr_timesheet_sheet_sheet_day as
442 cast(round(cast(total_attendance - total_timesheet as Numeric),2) as Double Precision) AS total_difference
449 SUM(total_timesheet) as total_timesheet,
450 CASE WHEN SUM(total_attendance) < 0
451 THEN (SUM(total_attendance) +
452 CASE WHEN current_date <> name
454 ELSE (EXTRACT(hour FROM current_time) * 60) + EXTRACT(minute FROM current_time)
457 ELSE SUM(total_attendance)
458 END /60 as total_attendance
463 l.date::date as name,
465 sum(l.unit_amount) as total_timesheet,
466 0.0 as total_attendance
468 hr_analytic_timesheet hrt
469 left join (account_analytic_line l
470 LEFT JOIN hr_timesheet_sheet_sheet s
471 ON (s.date_to >= l.date
472 AND s.date_from <= l.date
473 AND s.user_id = l.user_id))
474 on (l.id = hrt.line_id)
475 group by l.date::date, s.id
479 a.name::date as name,
481 0.0 as total_timesheet,
482 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
485 LEFT JOIN (hr_timesheet_sheet_sheet s
486 LEFT JOIN resource_resource r
487 LEFT JOIN hr_employee e
488 ON (e.resource_id = r.id)
489 ON (s.user_id = r.user_id))
490 ON (a.employee_id = e.id
491 AND s.date_to >= date_trunc('day',a.name)
492 AND s.date_from <= a.name)
493 WHERE action in ('sign_in', 'sign_out')
494 group by a.name::date, s.id
496 GROUP BY name, sheet_id
499 hr_timesheet_sheet_sheet_day()
502 class hr_timesheet_sheet_sheet_account(osv.osv):
503 _name = "hr_timesheet_sheet.sheet.account"
504 _description = "Timesheets by Period"
508 'name': fields.many2one('account.analytic.account', 'Project / Analytic Account', readonly=True),
509 'sheet_id': fields.many2one('hr_timesheet_sheet.sheet', 'Sheet', readonly=True),
510 'total': fields.float('Total Time', digits=(16,2), readonly=True),
511 'invoice_rate': fields.many2one('hr_timesheet_invoice.factor', 'Invoice rate', readonly=True),
515 cr.execute("""create or replace view hr_timesheet_sheet_sheet_account as (
518 l.account_id as name,
520 sum(l.unit_amount) as total,
521 l.to_invoice as invoice_rate
523 hr_analytic_timesheet hrt
524 left join (account_analytic_line l
525 LEFT JOIN hr_timesheet_sheet_sheet s
526 ON (s.date_to >= l.date
527 AND s.date_from <= l.date
528 AND s.user_id = l.user_id))
529 on (l.id = hrt.line_id)
530 group by l.account_id, s.id, l.to_invoice
533 hr_timesheet_sheet_sheet_account()
537 class res_company(osv.osv):
538 _inherit = 'res.company'
540 'timesheet_range': fields.selection(
541 [('day','Day'),('week','Week'),('month','Month')], 'Timesheet range',
542 help="Periodicity on which you validate your timesheets."),
543 'timesheet_max_difference': fields.float('Timesheet allowed difference(Hours)',
544 help="Allowed difference in hours between the sign in/out and the timesheet " \
545 "computation for one sheet. Set this to 0 if you do not want any control."),
548 'timesheet_range': lambda *args: 'week',
549 'timesheet_max_difference': lambda *args: 0.0
554 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: