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