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