2013-02-14 08:20:38 +00:00
# -*- coding: utf-8 -*-
##############################################################################
#
# OpenERP, Open Source Management Solution
2013-02-26 11:34:03 +00:00
# Copyright (C) 2010-Today OpenERP SA (<http://www.openerp.com>)
2013-02-14 08:20:38 +00:00
#
# This program is free software: you can redistribute it and/or modify
2013-02-26 11:34:03 +00:00
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
2013-02-14 08:20:38 +00:00
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2013-02-26 11:34:03 +00:00
# GNU General Public License for more details.
2013-02-14 08:20:38 +00:00
#
2013-02-26 11:34:03 +00:00
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>
2013-02-14 08:20:38 +00:00
#
##############################################################################
from openerp . osv import fields , osv
2013-02-20 12:33:28 +00:00
from openerp . tools . safe_eval import safe_eval
2013-02-15 13:32:34 +00:00
2013-02-28 13:53:29 +00:00
from templates import TemplateHelper
2013-02-26 14:54:59 +00:00
2013-02-28 13:53:29 +00:00
from datetime import date , datetime , timedelta
2013-02-26 14:54:59 +00:00
2013-02-14 17:07:36 +00:00
class gamification_goal_type ( osv . Model ) :
""" Goal type definition
A goal type defining a way to set an objective and evaluate it
Each module wanting to be able to set goals to the users needs to create
a new gamification_goal_type
"""
_name = ' gamification.goal.type '
_description = ' Gamification goal type '
_columns = {
2013-03-01 15:43:36 +00:00
' name ' : fields . char ( ' Type Name ' , required = True , translate = True ) ,
2013-02-15 09:16:38 +00:00
' description ' : fields . text ( ' Description ' ) ,
2013-03-06 14:45:44 +00:00
' unit ' : fields . char ( ' Unit ' , help = " The unit of the target and current values " , translate = True ) ,
2013-02-20 12:33:28 +00:00
' computation_mode ' : fields . selection ( [
( ' sum ' , ' Sum ' ) ,
( ' count ' , ' Count ' ) ,
( ' manually ' , ' Manually ' )
] ,
2013-02-18 13:06:56 +00:00
string = " Mode of Computation " ,
2013-02-15 09:16:38 +00:00
help = """ How is computed the goal value : \n
- ' Sum ' for the total of the values if the ' Evaluated field ' \n
- ' Count ' for the number of entries \n
2013-02-14 17:07:36 +00:00
- ' Manually ' for user defined values """ ,
required = True ) ,
2013-02-18 15:16:07 +00:00
' model_id ' : fields . many2one ( ' ir.model ' ,
2013-02-19 13:23:06 +00:00
string = ' Model ' ,
2013-02-18 15:16:07 +00:00
help = ' The model object for the field to evaluate ' ) ,
' field_id ' : fields . many2one ( ' ir.model.fields ' ,
2013-02-18 13:06:56 +00:00
string = ' Evaluated Field ' ,
2013-02-15 09:16:38 +00:00
help = ' The field containing the value to evaluate ' ) ,
2013-02-18 15:16:07 +00:00
' field_date_id ' : fields . many2one ( ' ir.model.fields ' ,
2013-02-18 13:06:56 +00:00
string = ' Evaluated Date Field ' ,
2013-02-15 09:16:38 +00:00
help = ' The date to use for the time period evaluated ' ) ,
2013-02-18 09:56:44 +00:00
' domain ' : fields . char ( " Domain " ,
help = " Technical filters rules to apply " ,
required = True ) , # how to apply it ?
2013-02-20 12:33:28 +00:00
' condition ' : fields . selection ( [
2013-03-06 14:45:44 +00:00
( ' lower ' , ' <= ' ) ,
( ' higher ' , ' >= ' )
2013-02-20 12:33:28 +00:00
] ,
2013-02-18 13:06:56 +00:00
string = ' Validation Condition ' ,
2013-02-15 09:16:38 +00:00
help = ' A goal is considered as completed when the current value is compared to the value to reach ' ,
required = True ) ,
2013-02-14 17:07:36 +00:00
' sequence ' : fields . integer ( ' Sequence ' ,
2013-02-15 09:16:38 +00:00
help = ' Sequence number for ordering ' ,
2013-02-14 17:07:36 +00:00
required = True ) ,
2013-02-14 08:20:38 +00:00
}
2013-02-14 17:07:36 +00:00
2013-02-15 14:54:15 +00:00
_order = ' sequence '
2013-02-14 17:07:36 +00:00
_defaults = {
2013-02-18 12:44:03 +00:00
' sequence ' : 1 ,
2013-03-06 14:45:44 +00:00
' condition ' : ' higher ' ,
2013-02-15 09:16:38 +00:00
' computation_mode ' : ' manually ' ,
2013-02-18 09:56:44 +00:00
' domain ' : " [] " ,
2013-02-14 08:20:38 +00:00
}
2013-02-20 12:33:28 +00:00
2013-02-14 17:07:36 +00:00
class gamification_goal ( osv . Model ) :
""" Goal instance for a user
2013-02-21 13:50:00 +00:00
An individual goal for a user on a specified time period """
2013-02-14 17:07:36 +00:00
_name = ' gamification.goal '
_description = ' Gamification goal instance '
_inherit = ' mail.thread '
2013-02-15 14:54:15 +00:00
def _get_completeness ( self , cr , uid , ids , field_name , arg , context = None ) :
2013-02-27 10:59:56 +00:00
""" Return the percentage of completeness of the goal, between 0 and 100 """
2013-02-15 14:54:15 +00:00
res = { }
for goal in self . browse ( cr , uid , ids , context ) :
2013-02-27 10:59:56 +00:00
if goal . current > 0 :
res [ goal . id ] = min ( 100 , round ( 100.0 * goal . current / goal . target_goal , 2 ) )
else :
res [ goal . id ] = 0.0
2013-03-07 11:15:57 +00:00
2013-02-15 14:54:15 +00:00
return res
2013-02-20 16:17:55 +00:00
2013-02-20 16:05:17 +00:00
def on_change_type_id ( self , cr , uid , ids , type_id = False , context = None ) :
goal_type = self . pool . get ( ' gamification.goal.type ' )
if not type_id :
return { ' value ' : { ' type_id ' : False } }
goal_type = goal_type . browse ( cr , uid , type_id , context = context )
ret = { ' value ' : { ' computation_mode ' : goal_type . computation_mode } }
return ret
2013-02-15 14:54:15 +00:00
2013-02-14 17:07:36 +00:00
_columns = {
' type_id ' : fields . many2one ( ' gamification.goal.type ' ,
2013-02-18 13:06:56 +00:00
string = ' Goal Type ' ,
2013-02-19 14:37:22 +00:00
required = True ,
ondelete = " cascade " ) ,
2013-02-14 17:07:36 +00:00
' user_id ' : fields . many2one ( ' res.users ' , string = ' User ' , required = True ) ,
2013-02-20 12:33:28 +00:00
' planline_id ' : fields . many2one ( ' gamification.goal.planline ' ,
2013-02-21 12:57:59 +00:00
string = ' Goal Planline ' ,
2013-02-19 14:37:22 +00:00
ondelete = " cascade " ) ,
2013-02-18 13:06:56 +00:00
' start_date ' : fields . date ( ' Start Date ' ) ,
' end_date ' : fields . date ( ' End Date ' ) , # no start and end = always active
' target_goal ' : fields . float ( ' To Reach ' ,
2013-02-14 17:07:36 +00:00
required = True ,
track_visibility = ' always ' ) , # no goal = global index
' current ' : fields . float ( ' Current ' ,
required = True ,
track_visibility = ' always ' ) ,
2013-02-15 14:54:15 +00:00
' completeness ' : fields . function ( _get_completeness ,
type = ' float ' ,
2013-02-20 12:33:28 +00:00
string = ' Completeness ' ) ,
' state ' : fields . selection ( [
2013-02-22 13:40:24 +00:00
( ' draft ' , ' Draft ' ) ,
2013-02-20 12:33:28 +00:00
( ' inprogress ' , ' In progress ' ) ,
( ' inprogress_update ' , ' In progress (to update) ' ) ,
( ' reached ' , ' Reached ' ) ,
( ' failed ' , ' Failed ' ) ,
( ' canceled ' , ' Canceled ' ) ,
] ,
2013-02-15 14:16:51 +00:00
string = ' State ' ,
2013-02-14 17:07:36 +00:00
required = True ,
track_visibility = ' always ' ) ,
2013-02-20 16:05:17 +00:00
' computation_mode ' : fields . related ( ' type_id ' , ' computation_mode ' ,
type = ' char ' ,
string = " Type computation mode " ) ,
' remind_update_delay ' : fields . integer ( ' Remind delay ' ,
help = " The number of days after which the user assigned to a manual goal will be reminded. Never reminded if no value is specified. " ) ,
2013-02-19 16:52:15 +00:00
' last_update ' : fields . date ( ' Last Update ' ,
2013-03-07 09:54:53 +00:00
help = " In case of manual goal, reminders are sent if the goal as not been updated for a while (defined in goal plan). Ignored in case of non-manual goal or goal not linked to a plan. " ) ,
2013-03-07 13:44:47 +00:00
2013-03-07 09:54:53 +00:00
' type_description ' : fields . related ( ' type_id ' , ' description ' ,
type = ' char ' ,
string = ' Type Description ' ) ,
2013-03-07 13:44:47 +00:00
' type_unit ' : fields . related ( ' type_id ' , ' unit ' ,
2013-03-07 09:54:53 +00:00
type = ' char ' ,
string = ' Type Description ' ) ,
2013-03-07 13:44:47 +00:00
' type_condition ' : fields . related ( ' type_id ' , ' condition ' ,
type = ' char ' ,
string = ' Type Condition ' ) ,
2013-02-14 17:07:36 +00:00
}
2013-02-14 08:20:38 +00:00
2013-02-14 17:07:36 +00:00
_defaults = {
' current ' : 0 ,
2013-02-22 13:40:24 +00:00
' state ' : ' draft ' ,
2013-02-18 13:48:03 +00:00
' start_date ' : fields . date . today ,
2013-02-14 17:07:36 +00:00
}
2013-03-07 11:15:57 +00:00
_order = ' last_update desc, end_date, type_id '
2013-02-14 08:20:38 +00:00
2013-02-21 13:50:00 +00:00
2013-02-22 09:56:15 +00:00
def update ( self , cr , uid , ids , context = None ) :
2013-02-20 16:05:17 +00:00
""" Update the goals to recomputes values and change of states
2013-03-01 11:27:20 +00:00
If a manual goal is not updated for enough time , the user will be
reminded to do so ( done only once , in ' inprogress ' state ) .
If a goal reaches the target value , the status is set to reached
2013-02-20 16:05:17 +00:00
If the end date is passed ( at least + 1 day , time not considered ) without
2013-02-22 09:56:15 +00:00
the target value being reached , the goal is set as failed . """
2013-02-27 10:59:56 +00:00
2013-02-20 14:22:48 +00:00
for goal in self . browse ( cr , uid , ids , context = context or { } ) :
2013-03-06 14:45:44 +00:00
if goal . state in ( ' draft ' , ' canceled ' ) :
# skip if goal draft or canceled
2013-02-22 09:47:45 +00:00
continue
2013-03-06 14:45:44 +00:00
if goal . last_update and goal . end_date and goal . last_update > goal . end_date :
# skip if a goal is finished (updated after the goal end date)
2013-02-20 14:22:48 +00:00
continue
2013-02-20 16:17:55 +00:00
if goal . type_id . computation_mode == ' manually ' :
2013-02-22 09:47:45 +00:00
towrite = { ' current ' : goal . current }
2013-02-20 16:17:55 +00:00
# check for remind to update
if goal . remind_update_delay and goal . last_update :
delta_max = timedelta ( days = goal . remind_update_delay )
2013-02-27 10:59:56 +00:00
last_update = datetime . strptime ( goal . last_update , ' % Y- % m- %d ' ) . date ( )
2013-02-27 16:56:00 +00:00
if date . today ( ) - last_update > delta_max and goal . state == ' inprogress ' :
2013-02-20 16:17:55 +00:00
towrite [ ' state ' ] = ' inprogress_update '
2013-02-20 14:22:48 +00:00
2013-02-27 10:59:56 +00:00
# generate a remind report
2013-02-28 13:53:29 +00:00
template_env = TemplateHelper ( )
body_html = template_env . get_template ( ' reminder.mako ' ) . render ( { ' object ' : goal } )
2013-02-28 09:42:00 +00:00
self . message_post ( cr , uid , goal . id ,
2013-02-27 17:04:42 +00:00
body = body_html ,
partner_ids = [ goal . user_id . partner_id . id ] ,
2013-02-28 09:42:00 +00:00
context = context ,
subtype = ' mail.mt_comment ' )
2013-02-27 10:59:56 +00:00
2013-02-20 16:17:55 +00:00
else : # count or sum
2013-02-20 14:22:48 +00:00
obj = self . pool . get ( goal . type_id . model_id . model )
field_date_name = goal . type_id . field_date_id . name
2013-02-22 09:47:45 +00:00
domain = safe_eval ( goal . type_id . domain ,
{ ' user_id ' : goal . user_id . id } )
2013-02-20 14:22:48 +00:00
if goal . start_date :
domain . append ( ( field_date_name , ' >= ' , goal . start_date ) )
if goal . end_date :
domain . append ( ( field_date_name , ' <= ' , goal . end_date ) )
2013-02-20 16:17:55 +00:00
if goal . type_id . computation_mode == ' sum ' :
field_name = goal . type_id . field_id . name
res = obj . read_group ( cr , uid , domain , [ field_name ] ,
[ ' ' ] , context = context )
towrite = { ' current ' : res [ 0 ] [ field_name ] }
else : # computation mode = count
res = obj . search ( cr , uid , domain , context = context )
towrite = { ' current ' : len ( res ) }
2013-03-01 15:43:36 +00:00
2013-02-20 16:17:55 +00:00
# check goal target reached
2013-03-06 14:45:44 +00:00
if ( goal . type_id . condition == ' higher ' \
2013-02-20 16:17:55 +00:00
and towrite [ ' current ' ] > = goal . target_goal ) \
2013-03-06 14:45:44 +00:00
or ( goal . type_id . condition == ' lower ' \
2013-02-20 16:17:55 +00:00
and towrite [ ' current ' ] < = goal . target_goal ) :
2013-02-20 14:22:48 +00:00
towrite [ ' state ' ] = ' reached '
2013-02-20 16:17:55 +00:00
# check goal failure
2013-02-20 16:05:17 +00:00
elif goal . end_date and fields . date . today ( ) > goal . end_date :
2013-02-20 14:22:48 +00:00
towrite [ ' state ' ] = ' failed '
2013-02-20 16:05:17 +00:00
2013-02-20 14:22:48 +00:00
self . write ( cr , uid , [ goal . id ] , towrite , context = context )
return True
2013-02-27 11:12:20 +00:00
def action_start ( self , cr , uid , ids , context = None ) :
2013-03-01 11:27:20 +00:00
""" Mark a goal as started.
This should only be used when creating goals manually ( in draft state ) """
2013-02-27 11:12:20 +00:00
self . write ( cr , uid , ids , { ' state ' : ' inprogress ' } , context = context )
return self . update ( cr , uid , ids , context = context )
2013-02-21 10:46:46 +00:00
2013-02-15 16:02:04 +00:00
def action_reach ( self , cr , uid , ids , context = None ) :
2013-03-01 11:27:20 +00:00
""" Mark a goal as reached.
If the target goal condition is not met , the state will be reset to In
Progress at the next goal update until the end date . """
2013-02-15 16:02:04 +00:00
return self . write ( cr , uid , ids , { ' state ' : ' reached ' } , context = context )
def action_fail ( self , cr , uid , ids , context = None ) :
2013-03-01 11:27:20 +00:00
""" Set the state of the goal to failed.
A failed goal will be ignored in future checks . """
2013-02-15 16:02:04 +00:00
return self . write ( cr , uid , ids , { ' state ' : ' failed ' } , context = context )
def action_cancel ( self , cr , uid , ids , context = None ) :
2013-03-01 11:27:20 +00:00
""" Reset the completion after setting a goal as reached or failed.
This is only the current state , if the date and / or target criterias
match the conditions for a change of state , this will be applied at the
next goal update . """
2013-02-15 16:02:04 +00:00
return self . write ( cr , uid , ids , { ' state ' : ' inprogress ' } , context = context )
2013-02-28 10:14:46 +00:00
def create ( self , cr , uid , vals , context = None ) :
""" Overwrite the create method to add a ' just_created ' field to True """
context = context or { }
context [ ' just_created ' ] = True
return super ( gamification_goal , self ) . create ( cr , uid , vals , context = context )
2013-02-26 15:23:25 +00:00
def write ( self , cr , uid , ids , vals , context = None ) :
2013-03-01 11:27:20 +00:00
""" Overwrite the write method to update the last_update field to today
If the current value is changed and the report frequency is set to On
change , q report is generated """
2013-02-26 15:23:25 +00:00
for goal in self . browse ( cr , uid , ids , vals ) :
2013-02-28 10:14:46 +00:00
vals [ ' last_update ' ] = fields . date . today ( )
2013-02-28 11:28:30 +00:00
if ' current ' in vals :
2013-02-28 10:14:46 +00:00
if ' just_created ' in context :
# new goals should not be reported
continue
if goal . planline_id and goal . planline_id . plan_id . report_message_frequency == ' onchange ' :
2013-02-28 09:22:47 +00:00
plan_obj = self . pool . get ( ' gamification.goal.plan ' )
2013-03-04 11:27:12 +00:00
plan_obj . report_progress ( cr , uid , goal . planline_id . plan_id , users = [ goal . user_id ] , context = context )
2013-02-28 10:14:46 +00:00
return super ( gamification_goal , self ) . write ( cr , uid , ids , vals , context = context )