addons/event/event.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2010 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 import time
  23 from osv import fields, osv
  24 from tools.translate import _
  25 import decimal_precision as dp
  26 from openerp import SUPERUSER_ID
  27
  28 class event_type(osv.osv):
  29     """ Event Type """
  30     _name = 'event.type'
  31     _description = __doc__
  32     _columns = {
  33         'name': fields.char('Event Type', size=64, required=True),
  34         'default_reply_to': fields.char('Default Reply-To', size=64,help="The email address of the organizer which is put in the 'Reply-To' of all emails sent automatically at event or registrations confirmation. You can also put your email address of your mail gateway if you use one." ),
  35         'default_email_event': fields.many2one('email.template','Event Confirmation Email', help="It will select this default confirmation event mail value when you choose this event"),
  36         'default_email_registration': fields.many2one('email.template','Registration Confirmation Email', help="It will select this default confirmation registration mail value when you choose this event"),
  37         'default_registration_min': fields.integer('Default Minimum Registration', help="It will select this default minimum value when you choose this event"),
  38         'default_registration_max': fields.integer('Default Maximum Registration', help="It will select this default maximum value when you choose this event"),
  39     }
  40     _defaults = {
  41         'default_registration_min': 0,
  42         'default_registration_max':0,
  43         }
  44
  45 event_type()
  46
  47 class event_event(osv.osv):
  48     """Event"""
  49     _name = 'event.event'
  50     _description = __doc__
  51     _order = 'date_begin'
  52     _inherit = ['ir.needaction_mixin','mail.thread']
  53
  54     def name_get(self, cr, uid, ids, context=None):
  55         if not ids:
  56               return []
  57         if not isinstance(ids, list):
  58             ids = [ids]
  59         res = []
  60         for record in self.browse(cr, uid, ids, context=context):
  61             date = record.date_begin.split(" ")[0]
  62             date_end = record.date_end.split(" ")[0]
  63             if date != date_end:
  64                 date += ' - ' + date_end
  65             display_name = record.name + ' (' + date + ')'
  66             res.append((record['id'], display_name))
  67         return res
  68
  69     def create(self, cr, uid, vals, context=None):
  70         obj_id = super(event_event, self).create(cr, uid, vals, context)
  71         self.create_send_note(cr, uid, [obj_id], context=context)
  72         return obj_id
  73
  74     def copy(self, cr, uid, id, default=None, context=None):
  75         """ Reset the state and the registrations while copying an event
  76         """
  77         if not default:
  78             default = {}
  79         default.update({
  80             'state': 'draft',
  81             'registration_ids': False,
  82         })
  83         return super(event_event, self).copy(cr, uid, id, default=default, context=context)
  84
  85     def button_draft(self, cr, uid, ids, context=None):
  86         self.button_draft_send_note(cr, uid, ids, context=context)
  87         return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
  88
  89     def button_cancel(self, cr, uid, ids, context=None):
  90         registration = self.pool.get('event.registration')
  91         reg_ids = registration.search(cr, uid, [('event_id','in',ids)], context=context)
  92         for event_reg in registration.browse(cr,uid,reg_ids,context=context):
  93             if event_reg.state == 'done':
  94                 raise osv.except_osv(_('Error!'),_("You have already set a registration for this event as 'Attended'. Please reset it to draft if you want to cancel this event.") )
  95         registration.write(cr, uid, reg_ids, {'state': 'cancel'}, context=context)
  96         self.button_cancel_send_note(cr, uid, ids, context=context)
  97         return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
  98
  99     def button_done(self, cr, uid, ids, context=None):
 100         self.button_done_send_note(cr, uid, ids, context=context)
 101         return self.write(cr, uid, ids, {'state': 'done'}, context=context)
 102
 103     def check_registration_limits(self, cr, uid, ids, context=None):
 104         register_pool = self.pool.get('event.registration')
 105         for self.event in self.browse(cr, uid, ids, context=context):
 106             total_confirmed = self.event.register_current
 107             if total_confirmed < self.event.register_min or total_confirmed > self.event.register_max and self.event.register_max!=0:
 108                 raise osv.except_osv(_('Error!'),_("The total of confirmed registration for the event '%s' does not meet the expected minimum/maximum. Please reconsider those limits before going further.") % (self.event.name))
 109
 110     def check_registration_limits_before(self, cr, uid, ids, no_of_registration, context=None):
 111         for event in self.browse(cr, uid, ids, context=context):
 112             available_seats = event.register_avail
 113             if available_seats and no_of_registration > available_seats:
 114                  raise osv.except_osv(_('Warning!'),_("Only %d Seats are Available!") % (available_seats))
 115             elif available_seats == 0:
 116                 raise osv.except_osv(_('Warning!'),_("No Tickets Available!"))
 117
 118     def confirm_event(self, cr, uid, ids, context=None):
 119         register_pool = self.pool.get('event.registration')
 120         if self.event.email_confirmation_id:
 121         #send reminder that will confirm the event for all the people that were already confirmed
 122             reg_ids = register_pool.search(cr, uid, [
 123                                ('event_id', '=', self.event.id),
 124                                ('state', 'not in', ['draft', 'cancel'])], context=context)
 125             register_pool.mail_user_confirm(cr, uid, reg_ids)
 126         return self.write(cr, uid, ids, {'state': 'confirm'}, context=context)
 127
 128     def button_confirm(self, cr, uid, ids, context=None):
 129         """ Confirm Event and send confirmation email to all register peoples
 130         """
 131         if isinstance(ids, (int, long)):
 132             ids = [ids]
 133         self.check_registration_limits(cr, uid, ids, context=context)
 134         self.button_confirm_send_note(cr, uid, ids, context=context)
 135         return self.confirm_event(cr, uid, ids, context=context)
 136
 137     def _get_register(self, cr, uid, ids, fields, args, context=None):
 138         """Get Confirm or uncofirm register value.
 139         @param ids: List of Event registration type's id
 140         @param fields: List of function fields(register_current and register_prospect).
 141         @param context: A standard dictionary for contextual values
 142         @return: Dictionary of function fields value.
 143         """
 144         register_pool = self.pool.get('event.registration')
 145         res = {}
 146         for event in self.browse(cr, uid, ids, context=context):
 147             res[event.id] = {}
 148             reg_open = reg_done = reg_draft =0
 149             for registration in event.registration_ids:
 150                 if registration.state == 'open':
 151                     reg_open += registration.nb_register
 152                 elif registration.state == 'done':
 153                     reg_done += registration.nb_register
 154                 elif registration.state == 'draft':
 155                     reg_draft += registration.nb_register
 156             for field in fields:
 157                 number = 0
 158                 if field == 'register_current':
 159                     number = reg_open
 160                 elif field == 'register_attended':
 161                     number = reg_done
 162                 elif field == 'register_prospect':
 163                     number = reg_draft
 164                 elif field == 'register_avail':
 165                     #the number of ticket is unlimited if the event.register_max field is not set.
 166                     #In that cas we arbitrary set it to 9999, it is used in the kanban view to special case the display of the 'subscribe' button
 167                     number = event.register_max - reg_open if event.register_max != 0 else 9999
 168                 res[event.id][field] = number
 169         return res
 170
 171     def _subscribe_fnc(self, cr, uid, ids, fields, args, context=None):
 172         """This functional fields compute if the current user (uid) is already subscribed or not to the event passed in parameter (ids)
 173         """
 174         register_pool = self.pool.get('event.registration')
 175         res = {}
 176         for event in self.browse(cr, uid, ids, context=context):
 177             res[event.id] = False
 178             curr_reg_id = register_pool.search(cr, uid, [('user_id', '=', uid), ('event_id', '=' ,event.id)])
 179             if curr_reg_id:
 180                 for reg in register_pool.browse(cr, uid, curr_reg_id, context=context):
 181                     if reg.state in ('open','done'):
 182                         res[event.id]= True
 183                         continue
 184         return res
 185
 186     _columns = {
 187         'name': fields.char('Name', size=64, required=True, translate=True, readonly=False, states={'done': [('readonly', True)]}),
 188         'user_id': fields.many2one('res.users', 'Responsible User', readonly=False, states={'done': [('readonly', True)]}),
 189         'type': fields.many2one('event.type', 'Type of Event', readonly=False, states={'done': [('readonly', True)]}),
 190         'register_max': fields.integer('Maximum Registrations', help="You can for each event define a maximum registration level. If you have too much registrations you are not able to confirm your event. (put 0 to ignore this rule )", readonly=True, states={'draft': [('readonly', False)]}),
 191         'register_min': fields.integer('Minimum Registrations', help="You can for each event define a minimum registration level. If you do not enough registrations you are not able to confirm your event. (put 0 to ignore this rule )", readonly=True, states={'draft': [('readonly', False)]}),
 192         'register_current': fields.function(_get_register, string='Confirmed Registrations', multi='register_numbers'),
 193         'register_avail': fields.function(_get_register, string='Available Registrations', multi='register_numbers',type='integer'),
 194         'register_prospect': fields.function(_get_register, string='Unconfirmed Registrations', multi='register_numbers'),
 195         'register_attended': fields.function(_get_register, string='# of Participations', multi='register_numbers'),
 196         'registration_ids': fields.one2many('event.registration', 'event_id', 'Registrations', readonly=False, states={'done': [('readonly', True)]}),
 197         'date_begin': fields.datetime('Start Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
 198         'date_end': fields.datetime('End Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
 199         'state': fields.selection([
 200             ('draft', 'Unconfirmed'),
 201             ('cancel', 'Cancelled'),
 202             ('confirm', 'Confirmed'),
 203             ('done', 'Done')],
 204             'Status', readonly=True, required=True,
 205             help='If event is created, the state is \'Draft\'.If event is confirmed for the particular dates the state is set to \'Confirmed\'. If the event is over, the state is set to \'Done\'.If event is cancelled the state is set to \'Cancelled\'.'),
 206         'email_registration_id' : fields.many2one('email.template','Registration Confirmation Email', help='This field contains the template of the mail that will be automatically sent each time a registration for this event is confirmed.'),
 207         'email_confirmation_id' : fields.many2one('email.template','Event Confirmation Email', help="If you set an email template, each participant will receive this email announcing the confirmation of the event."),
 208         'reply_to': fields.char('Reply-To Email', size=64, readonly=False, states={'done': [('readonly', True)]}, help="The email address of the organizer is likely to be put here, with the effect to be in the 'Reply-To' of the mails sent automatically at event or registrations confirmation. You can also put the email address of your mail gateway if you use one."),
 209         'main_speaker_id': fields.many2one('res.partner','Main Speaker', readonly=False, states={'done': [('readonly', True)]}, help="Speaker who will be giving speech at the event."),
 210         'address_id': fields.many2one('res.partner','Location Address', readonly=False, states={'done': [('readonly', True)]}),
 211         'street': fields.related('address_id','street',type='char',string='Street'),
 212         'zip': fields.related('address_id','zip',type='char',string='zip'),
 213         'city': fields.related('address_id','city',type='char',string='city'),
 214         'speaker_confirmed': fields.boolean('Speaker Confirmed', readonly=False, states={'done': [('readonly', True)]}),
 215         'country_id': fields.related('address_id', 'country_id',
 216                     type='many2one', relation='res.country', string='Country', readonly=False, states={'done': [('readonly', True)]}),
 217         'note': fields.text('Description', readonly=False, states={'done': [('readonly', True)]}),
 218         'company_id': fields.many2one('res.company', 'Company', required=False, change_default=True, readonly=False, states={'done': [('readonly', True)]}),
 219         'is_subscribed' : fields.function(_subscribe_fnc, type="boolean", string='Subscribed'),
 220     }
 221     _defaults = {
 222         'state': 'draft',
 223         'company_id': lambda self,cr,uid,c: self.pool.get('res.company')._company_default_get(cr, uid, 'event.event', context=c),
 224         'user_id': lambda obj, cr, uid, context: uid,
 225     }
 226     def subscribe_to_event(self, cr, uid, ids, context=None):
 227         register_pool = self.pool.get('event.registration')
 228         user_pool = self.pool.get('res.users')
 229         num_of_seats = int(context.get('ticket', 1))
 230         self.check_registration_limits_before(cr, uid, ids, num_of_seats, context=context)
 231         user = user_pool.browse(cr, uid, uid, context=context)
 232         curr_reg_ids = register_pool.search(cr, uid, [('user_id', '=', user.id), ('event_id', '=' , ids[0])])
 233         #the subscription is done with SUPERUSER_ID because in case we share the kanban view, we want anyone to be able to subscribe
 234         if not curr_reg_ids:
 235             curr_reg_ids = [register_pool.create(cr, SUPERUSER_ID, {'event_id': ids[0] ,'email': user.email, 'name':user.name, 'user_id': user.id, 'nb_register': num_of_seats})]
 236         else:
 237             register_pool.write(cr, uid, curr_reg_ids, {'nb_register': num_of_seats}, context=context)
 238         return register_pool.confirm_registration(cr, SUPERUSER_ID, curr_reg_ids, context=context)
 239
 240     def unsubscribe_to_event(self, cr, uid, ids, context=None):
 241         register_pool = self.pool.get('event.registration')
 242         #the unsubscription is done with SUPERUSER_ID because in case we share the kanban view, we want anyone to be able to unsubscribe
 243         curr_reg_ids = register_pool.search(cr, SUPERUSER_ID, [('user_id', '=', uid), ('event_id', '=', ids[0])])
 244         return register_pool.button_reg_cancel(cr, SUPERUSER_ID, curr_reg_ids, context=context)
 245
 246     def _check_closing_date(self, cr, uid, ids, context=None):
 247         for event in self.browse(cr, uid, ids, context=context):
 248             if event.date_end < event.date_begin:
 249                 return False
 250         return True
 251
 252     _constraints = [
 253         (_check_closing_date, 'Error ! Closing Date cannot be set before Beginning Date.', ['date_end']),
 254     ]
 255     def onchange_event_type(self, cr, uid, ids, type_event, context=None):
 256         if type_event:
 257             type_info =  self.pool.get('event.type').browse(cr,uid,type_event,context)
 258             dic ={
 259               'reply_to': type_info.default_reply_to,
 260               'email_registration_id': type_info.default_email_registration.id,
 261               'email_confirmation_id': type_info.default_email_event.id,
 262               'register_min': type_info.default_registration_min,
 263               'register_max': type_info.default_registration_max,
 264             }
 265             return {'value': dic}
 266
 267     # ----------------------------------------
 268     # OpenChatter methods and notifications
 269     # ----------------------------------------
 270
 271     def create_send_note(self, cr, uid, ids, context=None):
 272         message = _("Event has been <b>created</b>.")
 273         self.message_append_note(cr, uid, ids, body=message, context=context)
 274         return True
 275
 276     def button_cancel_send_note(self, cr, uid, ids, context=None):
 277         message = _("Event has been <b>cancelled</b>.")
 278         self.message_append_note(cr, uid, ids, body=message, context=context)
 279         return True
 280
 281     def button_draft_send_note(self, cr, uid, ids, context=None):
 282         message = _("Event has been set to <b>draft</b>.")
 283         self.message_append_note(cr, uid, ids, body=message, context=context)
 284         return True
 285
 286     def button_done_send_note(self, cr, uid, ids, context=None):
 287         message = _("Event has been <b>done</b>.")
 288         self.message_append_note(cr, uid, ids, body=message, context=context)
 289         return True
 290
 291     def button_confirm_send_note(self, cr, uid, ids, context=None):
 292         message = _("Event has been <b>confirmed</b>.")
 293         self.message_append_note(cr, uid, ids, body=message, context=context)
 294         return True
 295
 296 event_event()
 297
 298 class event_registration(osv.osv):
 299     """Event Registration"""
 300     _name= 'event.registration'
 301     _description = __doc__
 302     _inherit = ['ir.needaction_mixin','mail.thread']
 303     _columns = {
 304         'id': fields.integer('ID'),
 305         'origin': fields.char('Source', size=124,readonly=True,help="Name of the sale order which create the registration"),
 306         'nb_register': fields.integer('Number of Participants', required=True, readonly=True, states={'draft': [('readonly', False)]}),
 307         'event_id': fields.many2one('event.event', 'Event', required=True, readonly=True, states={'draft': [('readonly', False)]}),
 308         'partner_id': fields.many2one('res.partner', 'Partner', states={'done': [('readonly', True)]}),
 309         'create_date': fields.datetime('Creation Date' , readonly=True),
 310         'date_closed': fields.datetime('Attended Date', readonly=True),
 311         'date_open': fields.datetime('Registration Date', readonly=True),
 312         'reply_to': fields.related('event_id','reply_to',string='Reply-to Email', type='char', size=128, readonly=True,),
 313         'log_ids': fields.one2many('mail.message', 'res_id', 'Logs', domain=[('email_from', '=', False),('model','=',_name)]),
 314         'event_end_date': fields.related('event_id','date_end', type='datetime', string="Event End Date", readonly=True),
 315         'event_begin_date': fields.related('event_id', 'date_begin', type='datetime', string="Event Start Date", readonly=True),
 316         'user_id': fields.many2one('res.users', 'User', states={'done': [('readonly', True)]}),
 317         'company_id': fields.related('event_id', 'company_id', type='many2one', relation='res.company', string='Company', store=True, readonly=True, states={'draft':[('readonly',False)]}),
 318         'state': fields.selection([('draft', 'Unconfirmed'),
 319                                     ('cancel', 'Cancelled'),
 320                                     ('open', 'Confirmed'),
 321                                     ('done', 'Attended')], 'Status',
 322                                     size=16, readonly=True),
 323         'email': fields.char('Email', size=64),
 324         'phone': fields.char('Phone', size=64),
 325         'name': fields.char('Name', size=128, select=True),
 326     }
 327
 328     _defaults = {
 329         'nb_register': 1,
 330         'state': 'draft',
 331     }
 332     _order = 'name, create_date desc'
 333
 334     def do_draft(self, cr, uid, ids, context=None):
 335         self.do_draft_send_note(cr, uid, ids, context=context)
 336         return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
 337
 338     def confirm_registration(self, cr, uid, ids, context=None):
 339         self.message_append(cr, uid, ids,_('State set to open'),body_text= _('Open'))
 340         return self.write(cr, uid, ids, {'state': 'open'}, context=context)
 341
 342     def create(self, cr, uid, vals, context=None):
 343         obj_id = super(event_registration, self).create(cr, uid, vals, context)
 344         self.create_send_note(cr, uid, [obj_id], context=context)
 345         return obj_id
 346
 347     def registration_open(self, cr, uid, ids, context=None):
 348         """ Open Registration
 349         """
 350         event_obj = self.pool.get('event.event')
 351         for register in  self.browse(cr, uid, ids, context=context):
 352             event_id = register.event_id.id
 353             no_of_registration = register.nb_register
 354             event_obj.check_registration_limits_before(cr, uid, [event_id], no_of_registration, context=context)
 355         res = self.confirm_registration(cr, uid, ids, context=context)
 356         self.mail_user(cr, uid, ids, context=context)
 357         return res
 358
 359     def button_reg_close(self, cr, uid, ids, context=None):
 360         """ Close Registration
 361         """
 362         if context is None:
 363             context = {}
 364         today = fields.datetime.now()
 365         for registration in self.browse(cr, uid, ids, context=context):
 366             if today >= registration.event_id.date_begin:
 367                 values = {'state': 'done', 'date_closed': today}
 368                 self.write(cr, uid, ids, values)
 369                 self.message_append(cr, uid, ids, _('State set to Done'), body_text=_('Done'))
 370             else:
 371                 raise osv.except_osv(_('Error!'),_("You must wait for the starting day of the event to do this action.") )
 372         return True
 373
 374     def button_reg_cancel(self, cr, uid, ids, context=None, *args):
 375         self.message_append(cr, uid, ids,_('State set to Cancel'),body_text= _('Cancel'))
 376         return self.write(cr, uid, ids, {'state': 'cancel'})
 377
 378     def mail_user(self, cr, uid, ids, context=None):
 379         """
 380         Send email to user with email_template when registration is done
 381         """
 382         for registration in self.browse(cr, uid, ids, context=context):
 383             if registration.event_id.state == 'confirm' and registration.event_id.email_confirmation_id.id:
 384                 self.mail_user_confirm(cr, uid, ids, context=context)
 385             else:
 386                 template_id = registration.event_id.email_registration_id.id
 387                 if template_id:
 388                     mail_message = self.pool.get('email.template').send_mail(cr,uid,template_id,registration.id)
 389         return True
 390
 391     def mail_user_confirm(self, cr, uid, ids, context=None):
 392         """
 393         Send email to user when the event is confirmed
 394         """
 395         for registration in self.browse(cr, uid, ids, context=context):
 396             template_id = registration.event_id.email_confirmation_id.id
 397             if template_id:
 398                 mail_message = self.pool.get('email.template').send_mail(cr,uid,template_id,registration.id)
 399         return True
 400
 401     def onchange_contact_id(self, cr, uid, ids, contact, partner, context=None):
 402         if not contact:
 403             return {}
 404         addr_obj = self.pool.get('res.partner')
 405         contact_id =  addr_obj.browse(cr, uid, contact, context=context)
 406         return {'value': {
 407             'email':contact_id.email,
 408             'name':contact_id.name,
 409             'phone':contact_id.phone,
 410             }}
 411
 412     def onchange_event(self, cr, uid, ids, event_id, context=None):
 413         """This function returns value of Product Name, Unit Price based on Event.
 414         """
 415         if context is None:
 416             context = {}
 417         if not event_id:
 418             return {}
 419         event_obj = self.pool.get('event.event')
 420         data_event =  event_obj.browse(cr, uid, event_id, context=context)
 421         return {'value':
 422                     {'event_begin_date': data_event.date_begin,
 423                      'event_end_date': data_event.date_end,
 424                      'company_id': data_event.company_id and data_event.company_id.id or False,
 425                     }
 426                }
 427
 428     def onchange_partner_id(self, cr, uid, ids, part, context=None):
 429         res_obj = self.pool.get('res.partner')
 430         data = {}
 431         if not part:
 432             return {'value': data}
 433         addr = res_obj.address_get(cr, uid, [part]).get('default', False)
 434         if addr:
 435             d = self.onchange_contact_id(cr, uid, ids, addr, part, context)
 436             data.update(d['value'])
 437         return {'value': data}
 438
 439     # ----------------------------------------
 440     # OpenChatter methods and notifications
 441     # ----------------------------------------
 442
 443     def create_send_note(self, cr, uid, ids, context=None):
 444         message = _("Registration has been <b>created</b>.")
 445         self.message_append_note(cr, uid, ids, body=message, context=context)
 446         return True
 447
 448     def do_draft_send_note(self, cr, uid, ids, context=None):
 449         message = _("Registration has been set as <b>draft</b>.")
 450         self.message_append_note(cr, uid, ids, body=message, context=context)
 451         return True
 452
 453 event_registration()
 454
 455 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: