1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
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.
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.
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/>.
20 ##############################################################################
22 from osv import fields, osv
23 from tools.translate import _
24 from openerp import SUPERUSER_ID
26 class event_type(osv.osv):
29 _description = __doc__
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"),
39 'default_registration_min': 0,
40 'default_registration_max': 0,
45 class event_event(osv.osv):
48 _description = __doc__
50 _inherit = ['mail.thread','ir.needaction_mixin']
52 def name_get(self, cr, uid, ids, context=None):
56 if isinstance(ids, (long, int)):
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]
64 date += ' - ' + date_end
65 display_name = record.name + ' (' + date + ')'
66 res.append((record['id'], display_name))
69 def create(self, cr, uid, vals, context=None):
70 obj_id = super(event_event, self).create(cr, uid, vals, context)
71 self.create_send_note(cr, uid, [obj_id], context=context)
74 def copy(self, cr, uid, id, default=None, context=None):
75 """ Reset the state and the registrations while copying an event
81 'registration_ids': False,
83 return super(event_event, self).copy(cr, uid, id, default=default, context=context)
85 def button_draft(self, cr, uid, ids, context=None):
86 self.button_draft_send_note(cr, uid, ids, context=context)
87 return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
89 def button_cancel(self, cr, uid, ids, context=None):
90 registration = self.pool.get('event.registration')
91 reg_ids = registration.search(cr, uid, [('event_id','in',ids)], context=context)
92 for event_reg in registration.browse(cr,uid,reg_ids,context=context):
93 if event_reg.state == 'done':
94 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.") )
95 registration.write(cr, uid, reg_ids, {'state': 'cancel'}, context=context)
96 self.button_cancel_send_note(cr, uid, ids, context=context)
97 return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
99 def button_done(self, cr, uid, ids, context=None):
100 self.button_done_send_note(cr, uid, ids, context=context)
101 return self.write(cr, uid, ids, {'state': 'done'}, context=context)
103 def check_registration_limits(self, cr, uid, ids, context=None):
104 for self.event in self.browse(cr, uid, ids, context=context):
105 total_confirmed = self.event.register_current
106 if total_confirmed < self.event.register_min or total_confirmed > self.event.register_max and self.event.register_max!=0:
107 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))
109 def check_registration_limits_before(self, cr, uid, ids, no_of_registration, context=None):
110 for event in self.browse(cr, uid, ids, context=context):
111 available_seats = event.register_avail
112 if available_seats and no_of_registration > available_seats:
113 raise osv.except_osv(_('Warning!'),_("Only %d Seats are Available!") % (available_seats))
114 elif available_seats == 0:
115 raise osv.except_osv(_('Warning!'),_("No Tickets Available!"))
117 def confirm_event(self, cr, uid, ids, context=None):
118 register_pool = self.pool.get('event.registration')
119 if self.event.email_confirmation_id:
120 #send reminder that will confirm the event for all the people that were already confirmed
121 reg_ids = register_pool.search(cr, uid, [
122 ('event_id', '=', self.event.id),
123 ('state', 'not in', ['draft', 'cancel'])], context=context)
124 register_pool.mail_user_confirm(cr, uid, reg_ids)
125 return self.write(cr, uid, ids, {'state': 'confirm'}, context=context)
127 def button_confirm(self, cr, uid, ids, context=None):
128 """ Confirm Event and send confirmation email to all register peoples
130 if isinstance(ids, (int, long)):
132 self.check_registration_limits(cr, uid, ids, context=context)
133 self.button_confirm_send_note(cr, uid, ids, context=context)
134 return self.confirm_event(cr, uid, ids, context=context)
136 def _get_register(self, cr, uid, ids, fields, args, context=None):
137 """Get Confirm or uncofirm register value.
138 @param ids: List of Event registration type's id
139 @param fields: List of function fields(register_current and register_prospect).
140 @param context: A standard dictionary for contextual values
141 @return: Dictionary of function fields value.
144 for event in self.browse(cr, uid, ids, context=context):
146 reg_open = reg_done = reg_draft =0
147 for registration in event.registration_ids:
148 if registration.state == 'open':
149 reg_open += registration.nb_register
150 elif registration.state == 'done':
151 reg_done += registration.nb_register
152 elif registration.state == 'draft':
153 reg_draft += registration.nb_register
156 if field == 'register_current':
158 elif field == 'register_attended':
160 elif field == 'register_prospect':
162 elif field == 'register_avail':
163 #the number of ticket is unlimited if the event.register_max field is not set.
164 #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
165 number = event.register_max - reg_open if event.register_max != 0 else 9999
166 res[event.id][field] = number
169 def _subscribe_fnc(self, cr, uid, ids, fields, args, context=None):
170 """This functional fields compute if the current user (uid) is already subscribed or not to the event passed in parameter (ids)
172 register_pool = self.pool.get('event.registration')
174 for event in self.browse(cr, uid, ids, context=context):
175 res[event.id] = False
176 curr_reg_id = register_pool.search(cr, uid, [('user_id', '=', uid), ('event_id', '=' ,event.id)])
178 for reg in register_pool.browse(cr, uid, curr_reg_id, context=context):
179 if reg.state in ('open','done'):
185 'name': fields.char('Name', size=64, required=True, translate=True, readonly=False, states={'done': [('readonly', True)]}),
186 'user_id': fields.many2one('res.users', 'Responsible User', readonly=False, states={'done': [('readonly', True)]}),
187 'type': fields.many2one('event.type', 'Type of Event', readonly=False, states={'done': [('readonly', True)]}),
188 '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)]}),
189 '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)]}),
190 'register_current': fields.function(_get_register, string='Confirmed Registrations', multi='register_numbers'),
191 'register_avail': fields.function(_get_register, string='Available Registrations', multi='register_numbers',type='integer'),
192 'register_prospect': fields.function(_get_register, string='Unconfirmed Registrations', multi='register_numbers'),
193 'register_attended': fields.function(_get_register, string='# of Participations', multi='register_numbers'),
194 'registration_ids': fields.one2many('event.registration', 'event_id', 'Registrations', readonly=False, states={'done': [('readonly', True)]}),
195 'date_begin': fields.datetime('Start Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
196 'date_end': fields.datetime('End Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
197 'state': fields.selection([
198 ('draft', 'Unconfirmed'),
199 ('cancel', 'Cancelled'),
200 ('confirm', 'Confirmed'),
202 'Status', readonly=True, required=True,
203 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\'.'),
204 '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.'),
205 '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."),
206 '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."),
207 '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."),
208 'address_id': fields.many2one('res.partner','Location Address', readonly=False, states={'done': [('readonly', True)]}),
209 'street': fields.related('address_id','street',type='char',string='Street'),
210 'street2': fields.related('address_id','street2',type='char',string='Street2'),
211 'state_id': fields.related('address_id','state_id',type='many2one', relation="res.country.state", string='State'),
212 'zip': fields.related('address_id','zip',type='char',string='zip'),
213 'city': fields.related('address_id','city',type='char',string='city'),
214 'speaker_confirmed': fields.boolean('Speaker Confirmed', readonly=False, states={'done': [('readonly', True)]}),
215 'country_id': fields.related('address_id', 'country_id',
216 type='many2one', relation='res.country', string='Country', readonly=False, states={'done': [('readonly', True)]}),
217 'note': fields.text('Description', readonly=False, states={'done': [('readonly', True)]}),
218 'company_id': fields.many2one('res.company', 'Company', required=False, change_default=True, readonly=False, states={'done': [('readonly', True)]}),
219 'is_subscribed' : fields.function(_subscribe_fnc, type="boolean", string='Subscribed'),
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,
227 def subscribe_to_event(self, cr, uid, ids, context=None):
228 register_pool = self.pool.get('event.registration')
229 user_pool = self.pool.get('res.users')
230 num_of_seats = int(context.get('ticket', 1))
231 self.check_registration_limits_before(cr, uid, ids, num_of_seats, context=context)
232 user = user_pool.browse(cr, uid, uid, context=context)
233 curr_reg_ids = register_pool.search(cr, uid, [('user_id', '=', user.id), ('event_id', '=' , ids[0])])
234 #the subscription is done with SUPERUSER_ID because in case we share the kanban view, we want anyone to be able to subscribe
236 curr_reg_ids = [register_pool.create(cr, SUPERUSER_ID, {'event_id': ids[0] ,'email': user.email, 'name':user.name, 'user_id': user.id, 'nb_register': num_of_seats})]
238 register_pool.write(cr, uid, curr_reg_ids, {'nb_register': num_of_seats}, context=context)
239 return register_pool.confirm_registration(cr, SUPERUSER_ID, curr_reg_ids, context=context)
241 def unsubscribe_to_event(self, cr, uid, ids, context=None):
242 register_pool = self.pool.get('event.registration')
243 #the unsubscription is done with SUPERUSER_ID because in case we share the kanban view, we want anyone to be able to unsubscribe
244 curr_reg_ids = register_pool.search(cr, SUPERUSER_ID, [('user_id', '=', uid), ('event_id', '=', ids[0])])
245 return register_pool.button_reg_cancel(cr, SUPERUSER_ID, curr_reg_ids, context=context)
247 def _check_closing_date(self, cr, uid, ids, context=None):
248 for event in self.browse(cr, uid, ids, context=context):
249 if event.date_end < event.date_begin:
254 (_check_closing_date, 'Error ! Closing Date cannot be set before Beginning Date.', ['date_end']),
257 def onchange_event_type(self, cr, uid, ids, type_event, context=None):
259 type_info = self.pool.get('event.type').browse(cr,uid,type_event,context)
261 'reply_to': type_info.default_reply_to,
262 'email_registration_id': type_info.default_email_registration.id,
263 'email_confirmation_id': type_info.default_email_event.id,
264 'register_min': type_info.default_registration_min,
265 'register_max': type_info.default_registration_max,
267 return {'value': dic}
269 def on_change_address_id(self, cr, uid, ids, address_id, context=None):
275 'country_id' : False,
278 if isinstance(address_id, (long, int)):
279 address = self.pool.get('res.partner').browse(cr, uid, address_id, context=context)
281 'street' : address.street,
282 'street2' : address.street2,
283 'city' : address.city,
284 'country_id' : address.country_id and address.country_id.id,
285 'state_id' : address.state_id and address.state_id.id,
289 return {'value' : values}
292 # ----------------------------------------
293 # OpenChatter methods and notifications
294 # ----------------------------------------
296 def create_send_note(self, cr, uid, ids, context=None):
297 message = _("Event has been <b>created</b>.")
298 self.message_post(cr, uid, ids, body=message, context=context)
301 def button_cancel_send_note(self, cr, uid, ids, context=None):
302 message = _("Event has been <b>cancelled</b>.")
303 self.message_post(cr, uid, ids, body=message, context=context)
306 def button_draft_send_note(self, cr, uid, ids, context=None):
307 message = _("Event has been set to <b>draft</b>.")
308 self.message_post(cr, uid, ids, body=message, context=context)
311 def button_done_send_note(self, cr, uid, ids, context=None):
312 message = _("Event has been <b>done</b>.")
313 self.message_post(cr, uid, ids, body=message, context=context)
316 def button_confirm_send_note(self, cr, uid, ids, context=None):
317 message = _("Event has been <b>confirmed</b>.")
318 self.message_post(cr, uid, ids, body=message, context=context)
323 class event_registration(osv.osv):
324 """Event Registration"""
325 _name= 'event.registration'
326 _description = __doc__
327 _inherit = ['ir.needaction_mixin','mail.thread']
329 'id': fields.integer('ID'),
330 'origin': fields.char('Source', size=124,readonly=True,help="Name of the sale order which create the registration"),
331 'nb_register': fields.integer('Number of Participants', required=True, readonly=True, states={'draft': [('readonly', False)]}),
332 'event_id': fields.many2one('event.event', 'Event', required=True, readonly=True, states={'draft': [('readonly', False)]}),
333 'partner_id': fields.many2one('res.partner', 'Partner', states={'done': [('readonly', True)]}),
334 'create_date': fields.datetime('Creation Date' , readonly=True),
335 'date_closed': fields.datetime('Attended Date', readonly=True),
336 'date_open': fields.datetime('Registration Date', readonly=True),
337 'reply_to': fields.related('event_id','reply_to',string='Reply-to Email', type='char', size=128, readonly=True,),
338 'log_ids': fields.one2many('mail.message', 'res_id', 'Logs', domain=[('email_from', '=', False),('model','=',_name)]),
339 'event_end_date': fields.related('event_id','date_end', type='datetime', string="Event End Date", readonly=True),
340 'event_begin_date': fields.related('event_id', 'date_begin', type='datetime', string="Event Start Date", readonly=True),
341 'user_id': fields.many2one('res.users', 'User', states={'done': [('readonly', True)]}),
342 'company_id': fields.related('event_id', 'company_id', type='many2one', relation='res.company', string='Company', store=True, readonly=True, states={'draft':[('readonly',False)]}),
343 'state': fields.selection([('draft', 'Unconfirmed'),
344 ('cancel', 'Cancelled'),
345 ('open', 'Confirmed'),
346 ('done', 'Attended')], 'Status',
347 size=16, readonly=True),
348 'email': fields.char('Email', size=64),
349 'phone': fields.char('Phone', size=64),
350 'name': fields.char('Name', size=128, select=True),
356 _order = 'name, create_date desc'
358 def do_draft(self, cr, uid, ids, context=None):
359 self.do_draft_send_note(cr, uid, ids, context=context)
360 return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
362 def confirm_registration(self, cr, uid, ids, context=None):
363 for reg in self.browse(cr, uid, ids, context=context or {}):
364 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)
365 self.message_post(cr, uid, ids, body=_('Registration confirmed.'), context=context)
366 return self.write(cr, uid, ids, {'state': 'open'},context=context)
368 def create(self, cr, uid, vals, context=None):
369 obj_id = super(event_registration, self).create(cr, uid, vals, context)
370 self.create_send_note(cr, uid, [obj_id], context=context)
373 def registration_open(self, cr, uid, ids, context=None):
374 """ Open Registration
376 event_obj = self.pool.get('event.event')
377 for register in self.browse(cr, uid, ids, context=context):
378 event_id = register.event_id.id
379 no_of_registration = register.nb_register
380 event_obj.check_registration_limits_before(cr, uid, [event_id], no_of_registration, context=context)
381 res = self.confirm_registration(cr, uid, ids, context=context)
382 self.mail_user(cr, uid, ids, context=context)
385 def button_reg_close(self, cr, uid, ids, context=None):
386 """ Close Registration
390 today = fields.datetime.now()
391 for registration in self.browse(cr, uid, ids, context=context):
392 if today >= registration.event_id.date_begin:
393 values = {'state': 'done', 'date_closed': today}
394 self.write(cr, uid, ids, values)
395 self.message_post(cr, uid, ids, body=_('State set to Done'), context=context)
397 raise osv.except_osv(_('Error!'), _("You must wait for the starting day of the event to do this action."))
400 def button_reg_cancel(self, cr, uid, ids, context=None, *args):
401 self.message_post(cr, uid, ids, body=_('State set to Cancel'), context=context)
402 return self.write(cr, uid, ids, {'state': 'cancel'})
404 def mail_user(self, cr, uid, ids, context=None):
406 Send email to user with email_template when registration is done
408 for registration in self.browse(cr, uid, ids, context=context):
409 if registration.event_id.state == 'confirm' and registration.event_id.email_confirmation_id.id:
410 self.mail_user_confirm(cr, uid, ids, context=context)
412 template_id = registration.event_id.email_registration_id.id
414 mail_message = self.pool.get('email.template').send_mail(cr,uid,template_id,registration.id)
417 def mail_user_confirm(self, cr, uid, ids, context=None):
419 Send email to user when the event is confirmed
421 for registration in self.browse(cr, uid, ids, context=context):
422 template_id = registration.event_id.email_confirmation_id.id
424 mail_message = self.pool.get('email.template').send_mail(cr,uid,template_id,registration.id)
427 def onchange_contact_id(self, cr, uid, ids, contact, partner, context=None):
430 addr_obj = self.pool.get('res.partner')
431 contact_id = addr_obj.browse(cr, uid, contact, context=context)
433 'email':contact_id.email,
434 'name':contact_id.name,
435 'phone':contact_id.phone,
438 def onchange_partner_id(self, cr, uid, ids, part, context=None):
439 res_obj = self.pool.get('res.partner')
442 return {'value': data}
443 addr = res_obj.address_get(cr, uid, [part]).get('default', False)
445 d = self.onchange_contact_id(cr, uid, ids, addr, part, context)
446 data.update(d['value'])
447 return {'value': data}
449 # ----------------------------------------
450 # OpenChatter methods and notifications
451 # ----------------------------------------
453 def create_send_note(self, cr, uid, ids, context=None):
454 message = _("Registration has been <b>created</b>.")
455 self.message_post(cr, uid, ids, body=message, context=context)
458 def do_draft_send_note(self, cr, uid, ids, context=None):
459 message = _("Registration has been set as <b>draft</b>.")
460 self.message_post(cr, uid, ids, body=message, context=context)
465 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: