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 datetime import datetime, timedelta
  23 from openerp.osv import fields, osv
  24 from openerp.tools.translate import _
  25 from openerp import SUPERUSER_ID
  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
  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
  56         if isinstance(ids, (long, int)):
  57             ids = [ids]
  58
  59         res = []
  60         for record in self.browse(cr, uid, ids, context=context):
  61             date = record.date_begin.split(" ")[0]
  62             date_end = record.date_end.split(" ")[0]
  63             if date != date_end:
  64                 date += ' - ' + date_end
  65             display_name = record.name + ' (' + date + ')'
  66             res.append((record['id'], display_name))
  67         return res
  68
  69     def copy(self, cr, uid, id, default=None, context=None):
  70         """ Reset the state and the registrations while copying an event
  71         """
  72         if not default:
  73             default = {}
  74         default.update({
  75             'state': 'draft',
  76             'registration_ids': False,
  77         })
  78         return super(event_event, self).copy(cr, uid, id, default=default, context=context)
  79
  80     def button_draft(self, cr, uid, ids, context=None):
  81         return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
  82
  83     def button_cancel(self, cr, uid, ids, context=None):
  84         registration = self.pool.get('event.registration')
  85         reg_ids = registration.search(cr, uid, [('event_id','in',ids)], context=context)
  86         for event_reg in registration.browse(cr,uid,reg_ids,context=context):
  87             if event_reg.state == 'done':
  88                 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.") )
  89         registration.write(cr, uid, reg_ids, {'state': 'cancel'}, context=context)
  90         return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
  91
  92     def button_done(self, cr, uid, ids, context=None):
  93         return self.write(cr, uid, ids, {'state': 'done'}, context=context)
  94
  95     def check_registration_limits(self, cr, uid, ids, context=None):
  96         for self.event in self.browse(cr, uid, ids, context=context):
  97             total_confirmed = self.event.register_current
  98             if total_confirmed < self.event.register_min or total_confirmed > self.event.register_max and self.event.register_max!=0:
  99                 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))
 100
 101     def check_registration_limits_before(self, cr, uid, ids, no_of_registration, context=None):
 102         for event in self.browse(cr, uid, ids, context=context):
 103             available_seats = event.register_avail
 104             if available_seats and no_of_registration > available_seats:
 105                 raise osv.except_osv(_('Warning!'),_("Only %d Seats are Available!") % (available_seats))
 106             elif available_seats == 0:
 107                 raise osv.except_osv(_('Warning!'),_("No Tickets Available!"))
 108
 109     def confirm_event(self, cr, uid, ids, context=None):
 110         register_pool = self.pool.get('event.registration')
 111         if self.event.email_confirmation_id:
 112         #send reminder that will confirm the event for all the people that were already confirmed
 113             reg_ids = register_pool.search(cr, uid, [
 114                                ('event_id', '=', self.event.id),
 115                                ('state', 'not in', ['draft', 'cancel'])], context=context)
 116             register_pool.mail_user_confirm(cr, uid, reg_ids)
 117         return self.write(cr, uid, ids, {'state': 'confirm'}, context=context)
 118
 119     def button_confirm(self, cr, uid, ids, context=None):
 120         """ Confirm Event and send confirmation email to all register peoples
 121         """
 122         if isinstance(ids, (int, long)):
 123             ids = [ids]
 124         self.check_registration_limits(cr, uid, ids, context=context)
 125         return self.confirm_event(cr, uid, ids, context=context)
 126
 127     def _get_register(self, cr, uid, ids, fields, args, context=None):
 128         """Get Confirm or uncofirm register value.
 129         @param ids: List of Event registration type's id
 130         @param fields: List of function fields(register_current and register_prospect).
 131         @param context: A standard dictionary for contextual values
 132         @return: Dictionary of function fields value.
 133         """
 134         res = {}
 135         for event in self.browse(cr, uid, ids, context=context):
 136             res[event.id] = {}
 137             reg_open = reg_done = reg_draft =0
 138             for registration in event.registration_ids:
 139                 if registration.state == 'open':
 140                     reg_open += registration.nb_register
 141                 elif registration.state == 'done':
 142                     reg_done += registration.nb_register
 143                 elif registration.state == 'draft':
 144                     reg_draft += registration.nb_register
 145             for field in fields:
 146                 number = 0
 147                 if field == 'register_current':
 148                     number = reg_open
 149                 elif field == 'register_attended':
 150                     number = reg_done
 151                 elif field == 'register_prospect':
 152                     number = reg_draft
 153                 elif field == 'register_avail':
 154                     #the number of ticket is unlimited if the event.register_max field is not set.
 155                     #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
 156                     number = event.register_max - reg_open if event.register_max != 0 else 9999
 157                 res[event.id][field] = number
 158         return res
 159
 160     def _subscribe_fnc(self, cr, uid, ids, fields, args, context=None):
 161         """This functional fields compute if the current user (uid) is already subscribed or not to the event passed in parameter (ids)
 162         """
 163         register_pool = self.pool.get('event.registration')
 164         res = {}
 165         for event in self.browse(cr, uid, ids, context=context):
 166             res[event.id] = False
 167             curr_reg_id = register_pool.search(cr, uid, [('user_id', '=', uid), ('event_id', '=' ,event.id)])
 168             if curr_reg_id:
 169                 for reg in register_pool.browse(cr, uid, curr_reg_id, context=context):
 170                     if reg.state in ('open','done'):
 171                         res[event.id]= True
 172                         continue
 173         return res
 174
 175     def _get_visibility_selection(self, cr, uid, context=None):
 176         return [('public', 'All Users'),
 177                 ('employees', 'Employees Only')]
 178     # Lambda indirection method to avoid passing a copy of the overridable method when declaring the field
 179     _visibility_selection = lambda self, *args, **kwargs: self._get_visibility_selection(*args, **kwargs)
 180
 181     _columns = {
 182         'name': fields.char('Name', size=64, required=True, translate=True, readonly=False, states={'done': [('readonly', True)]}),
 183         'user_id': fields.many2one('res.users', 'Responsible User', readonly=False, states={'done': [('readonly', True)]}),
 184         'type': fields.many2one('event.type', 'Type of Event', readonly=False, states={'done': [('readonly', True)]}),
 185         '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)]}),
 186         '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)]}),
 187         'register_current': fields.function(_get_register, string='Confirmed Registrations', multi='register_numbers'),
 188         'register_avail': fields.function(_get_register, string='Available Registrations', multi='register_numbers',type='integer'),
 189         'register_prospect': fields.function(_get_register, string='Unconfirmed Registrations', multi='register_numbers'),
 190         'register_attended': fields.function(_get_register, string='# of Participations', multi='register_numbers'),
 191         'registration_ids': fields.one2many('event.registration', 'event_id', 'Registrations', readonly=False, states={'done': [('readonly', True)]}),
 192         'date_begin': fields.datetime('Start Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
 193         'date_end': fields.datetime('End Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
 194         'state': fields.selection([
 195             ('draft', 'Unconfirmed'),
 196             ('cancel', 'Cancelled'),
 197             ('confirm', 'Confirmed'),
 198             ('done', 'Done')],
 199             'Status', readonly=True, required=True,
 200             track_visibility='onchange',
 201             help='If event is created, the status is \'Draft\'.If event is confirmed for the particular dates the status is set to \'Confirmed\'. If the event is over, the status is set to \'Done\'.If event is cancelled the status is set to \'Cancelled\'.'),
 202         '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.'),
 203         '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."),
 204         '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."),
 205         '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."),
 206         'address_id': fields.many2one('res.partner','Location Address', readonly=False, states={'done': [('readonly', True)]}),
 207         'street': fields.related('address_id','street',type='char',string='Street'),
 208         'street2': fields.related('address_id','street2',type='char',string='Street2'),
 209         'state_id': fields.related('address_id','state_id',type='many2one', relation="res.country.state", string='State'),
 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         'visibility': fields.selection(_visibility_selection, 'Privacy / Visibility',
 219             select=True, required=True),
 220     }
 221     _defaults = {
 222         'state': 'draft',
 223         'company_id': lambda self,cr,uid,c: self.pool.get('res.company')._company_default_get(cr, uid, 'event.event', context=c),
 224         'user_id': lambda obj, cr, uid, context: uid,
 225         'visibility': 'employees',
 226     }
 227
 228     def subscribe_to_event(self, cr, uid, ids, context=None):
 229         register_pool = self.pool.get('event.registration')
 230         user_pool = self.pool.get('res.users')
 231         num_of_seats = int(context.get('ticket', 1))
 232         self.check_registration_limits_before(cr, uid, ids, num_of_seats, context=context)
 233         user = user_pool.browse(cr, uid, uid, context=context)
 234         curr_reg_ids = register_pool.search(cr, uid, [('user_id', '=', user.id), ('event_id', '=' , ids[0])])
 235         #the subscription is done with SUPERUSER_ID because in case we share the kanban view, we want anyone to be able to subscribe
 236         if not curr_reg_ids:
 237             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})]
 238         else:
 239             register_pool.write(cr, uid, curr_reg_ids, {'nb_register': num_of_seats}, context=context)
 240         return register_pool.confirm_registration(cr, SUPERUSER_ID, curr_reg_ids, context=context)
 241
 242     def unsubscribe_to_event(self, cr, uid, ids, context=None):
 243         register_pool = self.pool.get('event.registration')
 244         #the unsubscription is done with SUPERUSER_ID because in case we share the kanban view, we want anyone to be able to unsubscribe
 245         curr_reg_ids = register_pool.search(cr, SUPERUSER_ID, [('user_id', '=', uid), ('event_id', '=', ids[0])])
 246         return register_pool.button_reg_cancel(cr, SUPERUSER_ID, curr_reg_ids, context=context)
 247
 248     def _check_closing_date(self, cr, uid, ids, context=None):
 249         for event in self.browse(cr, uid, ids, context=context):
 250             if event.date_end < event.date_begin:
 251                 return False
 252         return True
 253
 254     _constraints = [
 255         (_check_closing_date, 'Error ! Closing Date cannot be set before Beginning Date.', ['date_end']),
 256     ]
 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     def on_change_address_id(self, cr, uid, ids, address_id, context=None):
 271         values = {}
 272         if not address_id:
 273             return values
 274         address = self.pool.get('res.partner').browse(cr, uid, address_id, context=context)
 275         values.update({
 276             'street' : address.street,
 277             'street2' : address.street2,
 278             'city' : address.city,
 279             'country_id' : address.country_id and address.country_id.id or False,
 280             'state_id' : address.state_id and address.state_id.id or False,
 281             'zip' : address.zip,
 282         })
 283         return {'value' : values}
 284
 285     def onchange_start_date(self, cr, uid, ids, date_begin=False, date_end=False, context=None):
 286         res = {'value':{}}
 287         if date_end:
 288             return res
 289         if date_begin and isinstance(date_begin, str):
 290             date_begin = datetime.strptime(date_begin, "%Y-%m-%d %H:%M:%S")
 291             date_end = date_begin + timedelta(hours=1)
 292             res['value'] = {'date_end': date_end.strftime("%Y-%m-%d %H:%M:%S")}
 293         return res
 294
 295
 296 class event_registration(osv.osv):
 297     """Event Registration"""
 298     _name= 'event.registration'
 299     _description = __doc__
 300     _inherit = ['mail.thread', 'ir.needaction_mixin']
 301     _columns = {
 302         'id': fields.integer('ID'),
 303         'origin': fields.char('Source Document', size=124,readonly=True,help="Reference of the sales order which created 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=[('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                                     track_visibility='onchange',
 321                                     size=16, readonly=True),
 322         'email': fields.char('Email', size=64),
 323         'phone': fields.char('Phone', size=64),
 324         'name': fields.char('Name', size=128, select=True),
 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         return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
 334
 335     def confirm_registration(self, cr, uid, ids, context=None):
 336         for reg in self.browse(cr, uid, ids, context=context or {}):
 337             self.pool.get('event.event').message_post(cr, uid, [reg.event_id.id], body=_('New registration confirmed: %s.') % (reg.name or '', ),subtype="event.mt_event_registration", context=context)
 338         return self.write(cr, uid, ids, {'state': 'open'}, context=context)
 339
 340     def registration_open(self, cr, uid, ids, context=None):
 341         """ Open Registration
 342         """
 343         event_obj = self.pool.get('event.event')
 344         for register in  self.browse(cr, uid, ids, context=context):
 345             event_id = register.event_id.id
 346             no_of_registration = register.nb_register
 347             event_obj.check_registration_limits_before(cr, uid, [event_id], no_of_registration, context=context)
 348         res = self.confirm_registration(cr, uid, ids, context=context)
 349         self.mail_user(cr, uid, ids, context=context)
 350         return res
 351
 352     def button_reg_close(self, cr, uid, ids, context=None):
 353         """ Close Registration
 354         """
 355         if context is None:
 356             context = {}
 357         today = fields.datetime.now()
 358         for registration in self.browse(cr, uid, ids, context=context):
 359             if today >= registration.event_id.date_begin:
 360                 values = {'state': 'done', 'date_closed': today}
 361                 self.write(cr, uid, ids, values)
 362             else:
 363                 raise osv.except_osv(_('Error!'), _("You must wait for the starting day of the event to do this action."))
 364         return True
 365
 366     def button_reg_cancel(self, cr, uid, ids, context=None, *args):
 367         return self.write(cr, uid, ids, {'state': 'cancel'})
 368
 369     def mail_user(self, cr, uid, ids, context=None):
 370         """
 371         Send email to user with email_template when registration is done
 372         """
 373         for registration in self.browse(cr, uid, ids, context=context):
 374             if registration.event_id.state == 'confirm' and registration.event_id.email_confirmation_id.id:
 375                 self.mail_user_confirm(cr, uid, ids, context=context)
 376             else:
 377                 template_id = registration.event_id.email_registration_id.id
 378                 if template_id:
 379                     mail_message = self.pool.get('email.template').send_mail(cr,uid,template_id,registration.id)
 380         return True
 381
 382     def mail_user_confirm(self, cr, uid, ids, context=None):
 383         """
 384         Send email to user when the event is confirmed
 385         """
 386         for registration in self.browse(cr, uid, ids, context=context):
 387             template_id = registration.event_id.email_confirmation_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 onchange_contact_id(self, cr, uid, ids, contact, partner, context=None):
 393         if not contact:
 394             return {}
 395         addr_obj = self.pool.get('res.partner')
 396         contact_id =  addr_obj.browse(cr, uid, contact, context=context)
 397         return {'value': {
 398             'email':contact_id.email,
 399             'name':contact_id.name,
 400             'phone':contact_id.phone,
 401             }}
 402
 403     def onchange_partner_id(self, cr, uid, ids, part, context=None):
 404         res_obj = self.pool.get('res.partner')
 405         data = {}
 406         if not part:
 407             return {'value': data}
 408         addr = res_obj.address_get(cr, uid, [part]).get('default', False)
 409         if addr:
 410             d = self.onchange_contact_id(cr, uid, ids, addr, part, context)
 411             data.update(d['value'])
 412         return {'value': data}
 413
 414 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: