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 class event_event(osv.osv):
  45     """Event"""
  46     _name = 'event.event'
  47     _description = __doc__
  48     _order = 'date_begin'
  49     _inherit = ['mail.thread', 'ir.needaction_mixin']
  50
  51     def name_get(self, cr, uid, ids, context=None):
  52         if not ids:
  53             return []
  54
  55         if isinstance(ids, (long, int)):
  56             ids = [ids]
  57
  58         res = []
  59         for record in self.browse(cr, uid, ids, context=context):
  60             date = record.date_begin.split(" ")[0]
  61             date_end = record.date_end.split(" ")[0]
  62             if date != date_end:
  63                 date += ' - ' + date_end
  64             display_name = record.name + ' (' + date + ')'
  65             res.append((record['id'], display_name))
  66         return res
  67
  68     def copy(self, cr, uid, id, default=None, context=None):
  69         """ Reset the state and the registrations while copying an event
  70         """
  71         if not default:
  72             default = {}
  73         default.update({
  74             'state': 'draft',
  75             'registration_ids': False,
  76         })
  77         return super(event_event, self).copy(cr, uid, id, default=default, context=context)
  78
  79     def button_draft(self, cr, uid, ids, context=None):
  80         return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
  81
  82     def button_cancel(self, cr, uid, ids, context=None):
  83         registration = self.pool.get('event.registration')
  84         reg_ids = registration.search(cr, uid, [('event_id','in',ids)], context=context)
  85         for event_reg in registration.browse(cr,uid,reg_ids,context=context):
  86             if event_reg.state == 'done':
  87                 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.") )
  88         registration.write(cr, uid, reg_ids, {'state': 'cancel'}, context=context)
  89         return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
  90
  91     def button_done(self, cr, uid, ids, context=None):
  92         return self.write(cr, uid, ids, {'state': 'done'}, context=context)
  93
  94     def confirm_event(self, cr, uid, ids, context=None):
  95         register_pool = self.pool.get('event.registration')
  96         for event in self.browse(cr, uid, ids, context=context):
  97             if event.email_confirmation_id:
  98             #send reminder that will confirm the event for all the people that were already confirmed
  99                 reg_ids = register_pool.search(cr, uid, [
 100                                    ('event_id', '=', event.id),
 101                                    ('state', 'not in', ['draft', 'cancel'])], context=context)
 102                 register_pool.mail_user_confirm(cr, uid, reg_ids)
 103         return self.write(cr, uid, ids, {'state': 'confirm'}, context=context)
 104
 105     def button_confirm(self, cr, uid, ids, context=None):
 106         """ Confirm Event and send confirmation email to all register peoples
 107         """
 108         return self.confirm_event(cr, uid, isinstance(ids, (int, long)) and [ids] or ids, context=context)
 109
 110     def _get_seats(self, cr, uid, ids, fields, args, context=None):
 111         """Get reserved, available, reserved but unconfirmed and used seats.
 112         @return: Dictionary of function field values.
 113         """
 114         keys = {'draft': 'seats_unconfirmed', 'open':'seats_reserved', 'done': 'seats_used'}
 115         res = {}
 116         for event_id in ids:
 117             res[event_id] = {key:0 for key in keys.values()}
 118         query = "SELECT state, sum(nb_register) FROM event_registration WHERE event_id = %s AND state IN ('draft','open','done') GROUP BY state"
 119         for event in self.pool.get('event.event').browse(cr, uid, ids, context=context):
 120             cr.execute(query, (event.id,))
 121             reg_states = cr.fetchall()
 122             for reg_state in reg_states:
 123                 res[event.id][keys[reg_state[0]]] = reg_state[1]
 124             res[event.id]['seats_available'] = event.seats_max - \
 125                 (res[event.id]['seats_reserved'] + res[event.id]['seats_used']) \
 126                 if event.seats_max > 0 else None
 127         return res
 128
 129     def _get_events_from_registrations(self, cr, uid, ids, context=None):
 130         """Get reserved, available, reserved but unconfirmed and used seats, of the event related to a registration.
 131         @return: Dictionary of function field values.
 132         """
 133         event_ids=set()
 134         for registration in self.browse(cr, uid, ids, context=context):
 135             event_ids.add(registration.event_id.id)
 136         return list(event_ids)
 137
 138     def _subscribe_fnc(self, cr, uid, ids, fields, args, context=None):
 139         """This functional fields compute if the current user (uid) is already subscribed or not to the event passed in parameter (ids)
 140         """
 141         register_pool = self.pool.get('event.registration')
 142         res = {}
 143         for event in self.browse(cr, uid, ids, context=context):
 144             res[event.id] = False
 145             curr_reg_id = register_pool.search(cr, uid, [('user_id', '=', uid), ('event_id', '=' ,event.id)])
 146             if curr_reg_id:
 147                 for reg in register_pool.browse(cr, uid, curr_reg_id, context=context):
 148                     if reg.state in ('open','done'):
 149                         res[event.id]= True
 150                         continue
 151         return res
 152
 153     _columns = {
 154         'name': fields.char('Event Name', size=64, required=True, translate=True, readonly=False, states={'done': [('readonly', True)]}),
 155         'user_id': fields.many2one('res.users', 'Responsible User', readonly=False, states={'done': [('readonly', True)]}),
 156         'type': fields.many2one('event.type', 'Type of Event', readonly=False, states={'done': [('readonly', True)]}),
 157         'seats_max': fields.integer('Maximum Avalaible Seats', oldname='register_max', 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)]}),
 158         'seats_min': fields.integer('Minimum Reserved Seats', oldname='register_min', 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)]}),
 159         'seats_reserved': fields.function(_get_seats, oldname='register_current', string='Reserved Seats', type='integer', multi='seats_reserved',
 160             store={'event.registration': (_get_events_from_registrations, ['state'], 10),
 161                    'event.event': (lambda  self, cr, uid, ids, c = {}: ids, ['seats_max', 'registration_ids'], 20)}),
 162         'seats_available': fields.function(_get_seats, oldname='register_avail', string='Available Seats', type='integer', multi='seats_reserved',
 163             store={'event.registration': (_get_events_from_registrations, ['state'], 10),
 164                    'event.event': (lambda  self, cr, uid, ids, c = {}: ids, ['seats_max', 'registration_ids'], 20)}),
 165         'seats_unconfirmed': fields.function(_get_seats, oldname='register_prospect', string='Unconfirmed Seat Reservations', type='integer', multi='seats_reserved',
 166             store={'event.registration': (_get_events_from_registrations, ['state'], 10),
 167                    'event.event': (lambda  self, cr, uid, ids, c = {}: ids, ['seats_max', 'registration_ids'], 20)}),
 168         'seats_used': fields.function(_get_seats, oldname='register_attended', string='Number of Participations', type='integer', multi='seats_reserved',
 169             store={'event.registration': (_get_events_from_registrations, ['state'], 10),
 170                    'event.event': (lambda  self, cr, uid, ids, c = {}: ids, ['seats_max', 'registration_ids'], 20)}),
 171         'registration_ids': fields.one2many('event.registration', 'event_id', 'Registrations', readonly=False, states={'done': [('readonly', True)]}),
 172         'date_begin': fields.datetime('Start Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
 173         'date_end': fields.datetime('End Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
 174         'state': fields.selection([
 175             ('draft', 'Unconfirmed'),
 176             ('cancel', 'Cancelled'),
 177             ('confirm', 'Confirmed'),
 178             ('done', 'Done')],
 179             'Status', readonly=True, required=True,
 180             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\'.'),
 181         '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.'),
 182         '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."),
 183         '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."),
 184         'address_id': fields.many2one('res.partner','Location', readonly=False, states={'done': [('readonly', True)]}),
 185         'country_id': fields.related('address_id', 'country_id',
 186                     type='many2one', relation='res.country', string='Country', readonly=False, states={'done': [('readonly', True)]}, store=True),
 187         'description': fields.html(
 188             'Description', readonly=False, translate=True,
 189             states={'done': [('readonly', True)]},
 190             oldname='note'),
 191         'company_id': fields.many2one('res.company', 'Company', required=False, change_default=True, readonly=False, states={'done': [('readonly', True)]}),
 192         'is_subscribed' : fields.function(_subscribe_fnc, type="boolean", string='Subscribed'),
 193         'organizer_id': fields.many2one('res.partner', "Organizer"),
 194     }
 195     _defaults = {
 196         'state': 'draft',
 197         'company_id': lambda self,cr,uid,c: self.pool.get('res.company')._company_default_get(cr, uid, 'event.event', context=c),
 198         'user_id': lambda obj, cr, uid, context: uid,
 199         'organizer_id': lambda self, cr, uid, c: self.pool.get('res.users').browse(cr, uid, uid, context=c).company_id.partner_id.id,
 200         'address_id': lambda self, cr, uid, c: self.pool.get('res.users').browse(cr, uid, uid, context=c).company_id.partner_id.id
 201     }
 202
 203     def _check_seats_limit(self, cr, uid, ids, context=None):
 204         for event in self.browse(cr, uid, ids, context=context):
 205             if event.seats_max and event.seats_available < 0:
 206                 return False
 207         return True
 208
 209     _constraints = [
 210         (_check_seats_limit, 'No more available seats.', ['registration_ids','seats_max']),
 211     ]
 212
 213     def subscribe_to_event(self, cr, uid, ids, context=None):
 214         register_pool = self.pool.get('event.registration')
 215         user_pool = self.pool.get('res.users')
 216         num_of_seats = int(context.get('ticket', 1))
 217         user = user_pool.browse(cr, uid, uid, context=context)
 218         curr_reg_ids = register_pool.search(cr, uid, [('user_id', '=', user.id), ('event_id', '=' , ids[0])])
 219         #the subscription is done with SUPERUSER_ID because in case we share the kanban view, we want anyone to be able to subscribe
 220         if not curr_reg_ids:
 221             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})]
 222         else:
 223             register_pool.write(cr, uid, curr_reg_ids, {'nb_register': num_of_seats}, context=context)
 224         return register_pool.confirm_registration(cr, SUPERUSER_ID, curr_reg_ids, context=context)
 225
 226     def unsubscribe_to_event(self, cr, uid, ids, context=None):
 227         register_pool = self.pool.get('event.registration')
 228         #the unsubscription is done with SUPERUSER_ID because in case we share the kanban view, we want anyone to be able to unsubscribe
 229         curr_reg_ids = register_pool.search(cr, SUPERUSER_ID, [('user_id', '=', uid), ('event_id', '=', ids[0])])
 230         return register_pool.button_reg_cancel(cr, SUPERUSER_ID, curr_reg_ids, context=context)
 231
 232     def _check_closing_date(self, cr, uid, ids, context=None):
 233         for event in self.browse(cr, uid, ids, context=context):
 234             if event.date_end < event.date_begin:
 235                 return False
 236         return True
 237
 238     _constraints = [
 239         (_check_closing_date, 'Error ! Closing Date cannot be set before Beginning Date.', ['date_end']),
 240     ]
 241
 242     def onchange_event_type(self, cr, uid, ids, type_event, context=None):
 243         values = {}
 244         if type_event:
 245             type_info =  self.pool.get('event.type').browse(cr,uid,type_event,context)
 246             dic ={
 247               'reply_to': type_info.default_reply_to,
 248               'email_registration_id': type_info.default_email_registration.id,
 249               'email_confirmation_id': type_info.default_email_event.id,
 250               'seats_min': type_info.default_registration_min,
 251               'seats_max': type_info.default_registration_max,
 252             }
 253             values.update(dic)
 254         return values
 255
 256     def onchange_start_date(self, cr, uid, ids, date_begin=False, date_end=False, context=None):
 257         res = {'value':{}}
 258         if date_end:
 259             return res
 260         if date_begin and isinstance(date_begin, str):
 261             date_begin = datetime.strptime(date_begin, "%Y-%m-%d %H:%M:%S")
 262             date_end = date_begin + timedelta(hours=1)
 263             res['value'] = {'date_end': date_end.strftime("%Y-%m-%d %H:%M:%S")}
 264         return res
 265
 266
 267 class event_registration(osv.osv):
 268     """Event Registration"""
 269     _name= 'event.registration'
 270     _description = __doc__
 271     _inherit = ['mail.thread', 'ir.needaction_mixin']
 272     _columns = {
 273         'id': fields.integer('ID'),
 274         'origin': fields.char('Source Document', size=124,readonly=True,help="Reference of the sales order which created the registration"),
 275         'nb_register': fields.integer('Number of Participants', required=True, readonly=True, states={'draft': [('readonly', False)]}),
 276         'event_id': fields.many2one('event.event', 'Event', required=True, readonly=True, states={'draft': [('readonly', False)]}),
 277         'partner_id': fields.many2one('res.partner', 'Partner', states={'done': [('readonly', True)]}),
 278         'create_date': fields.datetime('Creation Date' , readonly=True),
 279         'date_closed': fields.datetime('Attended Date', readonly=True),
 280         'date_open': fields.datetime('Registration Date', readonly=True),
 281         'reply_to': fields.related('event_id','reply_to',string='Reply-to Email', type='char', size=128, readonly=True,),
 282         'log_ids': fields.one2many('mail.message', 'res_id', 'Logs', domain=[('model','=',_name)]),
 283         'event_end_date': fields.related('event_id','date_end', type='datetime', string="Event End Date", readonly=True),
 284         'event_begin_date': fields.related('event_id', 'date_begin', type='datetime', string="Event Start Date", readonly=True),
 285         'user_id': fields.many2one('res.users', 'User', states={'done': [('readonly', True)]}),
 286         'company_id': fields.related('event_id', 'company_id', type='many2one', relation='res.company', string='Company', store=True, readonly=True, states={'draft':[('readonly',False)]}),
 287         'state': fields.selection([('draft', 'Unconfirmed'),
 288                                     ('cancel', 'Cancelled'),
 289                                     ('open', 'Confirmed'),
 290                                     ('done', 'Attended')], 'Status',
 291                                     size=16, readonly=True),
 292         'email': fields.char('Email', size=64),
 293         'phone': fields.char('Phone', size=64),
 294         'name': fields.char('Name', size=128, select=True),
 295     }
 296     _defaults = {
 297         'nb_register': 1,
 298         'state': 'draft',
 299     }
 300     _order = 'name, create_date desc'
 301
 302
 303     def _check_seats_limit(self, cr, uid, ids, context=None):
 304         for registration in self.browse(cr, uid, ids, context=context):
 305             if registration.event_id.seats_max and \
 306                 registration.event_id.seats_available < (registration.state == 'draft' and registration.nb_register or 0):
 307                 return False
 308         return True
 309
 310     _constraints = [
 311         (_check_seats_limit, 'No more available seats.', ['event_id','nb_register','state']),
 312     ]
 313
 314     def do_draft(self, cr, uid, ids, context=None):
 315         return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
 316
 317     def confirm_registration(self, cr, uid, ids, context=None):
 318         for reg in self.browse(cr, uid, ids, context=context or {}):
 319             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)
 320         return self.write(cr, uid, ids, {'state': 'open'}, context=context)
 321
 322     def registration_open(self, cr, uid, ids, context=None):
 323         """ Open Registration
 324         """
 325         res = self.confirm_registration(cr, uid, ids, context=context)
 326         self.mail_user(cr, uid, ids, context=context)
 327         return res
 328
 329     def button_reg_close(self, cr, uid, ids, context=None):
 330         """ Close Registration
 331         """
 332         if context is None:
 333             context = {}
 334         today = fields.datetime.now()
 335         for registration in self.browse(cr, uid, ids, context=context):
 336             if today >= registration.event_id.date_begin:
 337                 values = {'state': 'done', 'date_closed': today}
 338                 self.write(cr, uid, ids, values)
 339             else:
 340                 raise osv.except_osv(_('Error!'), _("You must wait for the starting day of the event to do this action."))
 341         return True
 342
 343     def button_reg_cancel(self, cr, uid, ids, context=None, *args):
 344         return self.write(cr, uid, ids, {'state': 'cancel'})
 345
 346     def mail_user(self, cr, uid, ids, context=None):
 347         """
 348         Send email to user with email_template when registration is done
 349         """
 350         for registration in self.browse(cr, uid, ids, context=context):
 351             if registration.event_id.state == 'confirm' and registration.event_id.email_confirmation_id.id:
 352                 self.mail_user_confirm(cr, uid, ids, context=context)
 353             else:
 354                 template_id = registration.event_id.email_registration_id.id
 355                 if template_id:
 356                     mail_message = self.pool.get('email.template').send_mail(cr,uid,template_id,registration.id)
 357         return True
 358
 359     def mail_user_confirm(self, cr, uid, ids, context=None):
 360         """
 361         Send email to user when the event is confirmed
 362         """
 363         for registration in self.browse(cr, uid, ids, context=context):
 364             template_id = registration.event_id.email_confirmation_id.id
 365             if template_id:
 366                 mail_message = self.pool.get('email.template').send_mail(cr,uid,template_id,registration.id)
 367         return True
 368
 369     def onchange_contact_id(self, cr, uid, ids, contact, partner, context=None):
 370         if not contact:
 371             return {}
 372         addr_obj = self.pool.get('res.partner')
 373         contact_id =  addr_obj.browse(cr, uid, contact, context=context)
 374         return {'value': {
 375             'email':contact_id.email,
 376             'name':contact_id.name,
 377             'phone':contact_id.phone,
 378             }}
 379
 380     def onchange_partner_id(self, cr, uid, ids, part, context=None):
 381         res_obj = self.pool.get('res.partner')
 382         data = {}
 383         if not part:
 384             return {'value': data}
 385         addr = res_obj.address_get(cr, uid, [part]).get('default', False)
 386         if addr:
 387             d = self.onchange_contact_id(cr, uid, ids, addr, part, context)
 388             data.update(d['value'])
 389         return {'value': data}
 390
 391 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: