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