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