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 ##############################################################################
23 from osv import fields, osv
24 from tools.translate import _
25 import decimal_precision as dp
27 class event_type(osv.osv):
30 _description = __doc__
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"),
40 'default_registration_min': 0,
41 'default_registration_max':0,
46 class event_event(osv.osv):
49 _description = __doc__
51 _inherit = ['ir.needaction_mixin','mail.thread']
53 def name_get(self, cr, uid, ids, context=None):
57 for record in self.browse(cr, uid, ids, context=context):
58 date = record.date_begin.split(" ")[0]
59 date_end = record.date_end.split(" ")[0]
61 date += ' - ' + date_end
62 display_name = record.name + ' (' + date + ')'
63 res.append((record['id'], display_name))
66 def create(self, cr, uid, vals, context=None):
67 obj_id = super(event_event, self).create(cr, uid, vals, context)
68 self.create_send_note(cr, uid, [obj_id], context=context)
71 def copy(self, cr, uid, id, default=None, context=None):
72 """ Reset the state and the registrations while copying an event
78 'registration_ids': False,
80 return super(event_event, self).copy(cr, uid, id, default=default, context=context)
82 def button_draft(self, cr, uid, ids, context=None):
83 self.button_draft_send_note(cr, uid, ids, context=context)
84 return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
86 def button_cancel(self, cr, uid, ids, context=None):
87 registration = self.pool.get('event.registration')
88 reg_ids = registration.search(cr, uid, [('event_id','in',ids)], context=context)
89 for event_reg in registration.browse(cr,uid,reg_ids,context=context):
90 if event_reg.state == 'done':
91 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.") )
92 registration.write(cr, uid, reg_ids, {'state': 'cancel'}, context=context)
93 self.button_cancel_send_note(cr, uid, ids, context=context)
94 return self.write(cr, uid, ids, {'state': 'cancel'}, context=context)
96 def button_done(self, cr, uid, ids, context=None):
97 self.button_done_send_note(cr, uid, ids, context=context)
98 return self.write(cr, uid, ids, {'state': 'done'}, context=context)
100 def check_registration_limits(self, cr, uid, ids, context=None):
101 register_pool = self.pool.get('event.registration')
102 for self.event in self.browse(cr, uid, ids, context=context):
103 total_confirmed = self.event.register_current
104 if total_confirmed < self.event.register_min or total_confirmed > self.event.register_max and self.event.register_max!=0:
105 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))
107 def check_registration_limits_before(self, cr, uid, ids, no_of_registration, context=None):
108 for event in self.browse(cr, uid, ids, context=context):
109 available_seats = event.register_avail
110 if available_seats and no_of_registration > available_seats:
111 raise osv.except_osv(_('Warning!'),_("Only %d Seats are Available!") % (available_seats))
112 elif available_seats == 0:
113 raise osv.except_osv(_('Warning!'),_("No Tickets Available!"))
115 def confirm_event(self, cr, uid, ids, context=None):
116 register_pool = self.pool.get('event.registration')
117 if self.event.email_confirmation_id:
118 #send reminder that will confirm the event for all the people that were already confirmed
119 reg_ids = register_pool.search(cr, uid, [
120 ('event_id', '=', self.event.id),
121 ('state', 'not in', ['draft', 'cancel'])], context=context)
122 register_pool.mail_user_confirm(cr, uid, reg_ids)
123 return self.write(cr, uid, ids, {'state': 'confirm'}, context=context)
125 def button_confirm(self, cr, uid, ids, context=None):
126 """ Confirm Event and send confirmation email to all register peoples
128 if isinstance(ids, (int, long)):
130 self.check_registration_limits(cr, uid, ids, context=context)
131 self.button_confirm_send_note(cr, uid, ids, context=context)
132 return self.confirm_event(cr, uid, ids, context=context)
134 def _get_register(self, cr, uid, ids, fields, args, context=None):
135 """Get Confirm or uncofirm register value.
136 @param ids: List of Event registration type's id
137 @param fields: List of function fields(register_current and register_prospect).
138 @param context: A standard dictionary for contextual values
139 @return: Dictionary of function fields value.
141 register_pool = self.pool.get('event.registration')
143 for event in self.browse(cr, uid, ids, context=context):
145 reg_open = reg_done = reg_draft =0
146 for registration in event.registration_ids:
147 if registration.state == 'open':
148 reg_open += registration.nb_register
149 elif registration.state == 'done':
150 reg_done += registration.nb_register
151 elif registration.state == 'draft':
152 reg_draft += registration.nb_register
155 if field == 'register_current':
157 elif field == 'register_attended':
159 elif field == 'register_prospect':
161 elif field == 'register_avail':
162 #the number of ticket is unlimited if the event.register_max field is not set.
163 #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
164 number = event.register_max - reg_open if event.register_max != 0 else 9999
165 res[event.id][field] = number
168 def _subscribe_fnc(self, cr, uid, ids, fields, args, context=None):
169 """This functional fields compute if the current user (uid) is already subscribed or not to the event passed in parameter (ids)
171 register_pool = self.pool.get('event.registration')
173 for event in self.browse(cr, uid, ids, context=context):
174 res[event.id] = False
175 curr_reg_id = register_pool.search(cr, uid, [('user_id', '=', uid), ('event_id', '=' ,event.id)])
177 for reg in register_pool.browse(cr, uid, curr_reg_id, context=context):
178 if reg.state in ('open','done'):
184 'name': fields.char('Name', size=64, required=True, translate=True, readonly=False, states={'done': [('readonly', True)]}),
185 'user_id': fields.many2one('res.users', 'Responsible User', readonly=False, states={'done': [('readonly', True)]}),
186 'type': fields.many2one('event.type', 'Type of Event', readonly=False, states={'done': [('readonly', True)]}),
187 '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)]}),
188 '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)]}),
189 'register_current': fields.function(_get_register, string='Confirmed Registrations', multi='register_numbers'),
190 'register_avail': fields.function(_get_register, string='Available Registrations', multi='register_numbers',type='integer'),
191 'register_prospect': fields.function(_get_register, string='Unconfirmed Registrations', multi='register_numbers'),
192 'register_attended': fields.function(_get_register, string='# of Participations', multi='register_numbers'),
193 'registration_ids': fields.one2many('event.registration', 'event_id', 'Registrations', readonly=False, states={'done': [('readonly', True)]}),
194 'date_begin': fields.datetime('Start Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
195 'date_end': fields.datetime('End Date', required=True, readonly=True, states={'draft': [('readonly', False)]}),
196 'state': fields.selection([
197 ('draft', 'Unconfirmed'),
198 ('cancel', 'Cancelled'),
199 ('confirm', 'Confirmed'),
201 'Status', readonly=True, required=True,
202 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\'.'),
203 '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.'),
204 '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."),
205 '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."),
206 '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."),
207 'address_id': fields.many2one('res.partner','Location Address', readonly=False, states={'done': [('readonly', True)]}),
208 'street': fields.related('address_id','street',type='char',string='Street'),
209 'zip': fields.related('address_id','zip',type='char',string='zip'),
210 'city': fields.related('address_id','city',type='char',string='city'),
211 'speaker_confirmed': fields.boolean('Speaker Confirmed', readonly=False, states={'done': [('readonly', True)]}),
212 'country_id': fields.related('address_id', 'country_id',
213 type='many2one', relation='res.country', string='Country', readonly=False, states={'done': [('readonly', True)]}),
214 'note': fields.text('Description', readonly=False, states={'done': [('readonly', True)]}),
215 'company_id': fields.many2one('res.company', 'Company', required=False, change_default=True, readonly=False, states={'done': [('readonly', True)]}),
216 'is_subscribed' : fields.function(_subscribe_fnc, type="boolean", string='Subscribed'),
220 'company_id': lambda self,cr,uid,c: self.pool.get('res.company')._company_default_get(cr, uid, 'event.event', context=c),
221 'user_id': lambda obj, cr, uid, context: uid,
223 def subscribe_to_event(self, cr, uid, ids, context=None):
224 register_pool = self.pool.get('event.registration')
225 user_pool = self.pool.get('res.users')
226 num_of_seats = int(context.get('ticket', 1))
227 self.check_registration_limits_before(cr, uid, ids, num_of_seats, context=context)
228 user = user_pool.browse(cr, uid, uid, context=context)
229 curr_reg_ids = register_pool.search(cr, uid, [('user_id', '=', user.id), ('event_id', '=' , ids[0])])
230 #the subscription is done with UID = 1 because in case we share the kanban view, we want anyone to be able to subscribe
232 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})]
234 register_pool.write(cr, uid, curr_reg_ids, {'nb_register': num_of_seats}, context=context)
235 return register_pool.confirm_registration(cr, 1, curr_reg_ids, context=context)
237 def unsubscribe_to_event(self, cr, uid, ids, context=None):
238 register_pool = self.pool.get('event.registration')
239 #the unsubscription is done with UID = 1 because in case we share the kanban view, we want anyone to be able to unsubscribe
240 curr_reg_ids = register_pool.search(cr, 1, [('user_id', '=', uid), ('event_id', '=', ids[0])])
241 return register_pool.button_reg_cancel(cr, 1, curr_reg_ids, context=context)
243 def _check_closing_date(self, cr, uid, ids, context=None):
244 for event in self.browse(cr, uid, ids, context=context):
245 if event.date_end < event.date_begin:
250 (_check_closing_date, 'Error ! Closing Date cannot be set before Beginning Date.', ['date_end']),
252 def onchange_event_type(self, cr, uid, ids, type_event, context=None):
254 type_info = self.pool.get('event.type').browse(cr,uid,type_event,context)
256 'reply_to': type_info.default_reply_to,
257 'email_registration_id': type_info.default_email_registration.id,
258 'email_confirmation_id': type_info.default_email_event.id,
259 'register_min': type_info.default_registration_min,
260 'register_max': type_info.default_registration_max,
262 return {'value': dic}
264 # ----------------------------------------
265 # OpenChatter methods and notifications
266 # ----------------------------------------
268 def create_send_note(self, cr, uid, ids, context=None):
269 message = _("Event has been <b>created</b>.")
270 self.message_append_note(cr, uid, ids, body=message, context=context)
273 def button_cancel_send_note(self, cr, uid, ids, context=None):
274 message = _("Event has been <b>cancelled</b>.")
275 self.message_append_note(cr, uid, ids, body=message, context=context)
278 def button_draft_send_note(self, cr, uid, ids, context=None):
279 message = _("Event has been set to <b>draft</b>.")
280 self.message_append_note(cr, uid, ids, body=message, context=context)
283 def button_done_send_note(self, cr, uid, ids, context=None):
284 message = _("Event has been <b>done</b>.")
285 self.message_append_note(cr, uid, ids, body=message, context=context)
288 def button_confirm_send_note(self, cr, uid, ids, context=None):
289 message = _("Event has been <b>confirmed</b>.")
290 self.message_append_note(cr, uid, ids, body=message, context=context)
295 class event_registration(osv.osv):
296 """Event Registration"""
297 _name= 'event.registration'
298 _description = __doc__
299 _inherit = ['ir.needaction_mixin','mail.thread']
301 'id': fields.integer('ID'),
302 'origin': fields.char('Source', size=124,readonly=True,help="Name of the sale order which create the registration"),
303 'nb_register': fields.integer('Number of Participants', required=True, readonly=True, states={'draft': [('readonly', False)]}),
304 'event_id': fields.many2one('event.event', 'Event', required=True, readonly=True, states={'draft': [('readonly', False)]}),
305 'partner_id': fields.many2one('res.partner', 'Partner', states={'done': [('readonly', True)]}),
306 'create_date': fields.datetime('Creation Date' , readonly=True),
307 'date_closed': fields.datetime('Attended Date', readonly=True),
308 'date_open': fields.datetime('Registration Date', readonly=True),
309 'reply_to': fields.related('event_id','reply_to',string='Reply-to Email', type='char', size=128, readonly=True,),
310 'log_ids': fields.one2many('mail.message', 'res_id', 'Logs', domain=[('email_from', '=', False),('model','=',_name)]),
311 'event_end_date': fields.related('event_id','date_end', type='datetime', string="Event End Date", readonly=True),
312 'event_begin_date': fields.related('event_id', 'date_begin', type='datetime', string="Event Start Date", readonly=True),
313 'user_id': fields.many2one('res.users', 'User', states={'done': [('readonly', True)]}),
314 'company_id': fields.related('event_id', 'company_id', type='many2one', relation='res.company', string='Company', store=True, readonly=True, states={'draft':[('readonly',False)]}),
315 'state': fields.selection([('draft', 'Unconfirmed'),
316 ('cancel', 'Cancelled'),
317 ('open', 'Confirmed'),
318 ('done', 'Attended')], 'Status',
319 size=16, readonly=True),
320 'email': fields.char('Email', size=64),
321 'phone': fields.char('Phone', size=64),
322 'name': fields.char('Name', size=128, select=True),
329 _order = 'name, create_date desc'
331 def do_draft(self, cr, uid, ids, context=None):
332 self.do_draft_send_note(cr, uid, ids, context=context)
333 return self.write(cr, uid, ids, {'state': 'draft'}, context=context)
335 def confirm_registration(self, cr, uid, ids, context=None):
336 self.message_append(cr, uid, ids,_('State set to open'),body_text= _('Open'))
337 return self.write(cr, uid, ids, {'state': 'open'}, context=context)
339 def create(self, cr, uid, vals, context=None):
340 obj_id = super(event_registration, self).create(cr, uid, vals, context)
341 self.create_send_note(cr, uid, [obj_id], context=context)
344 def registration_open(self, cr, uid, ids, context=None):
345 """ Open Registration
347 event_obj = self.pool.get('event.event')
348 for register in self.browse(cr, uid, ids, context=context):
349 event_id = register.event_id.id
350 no_of_registration = register.nb_register
351 event_obj.check_registration_limits_before(cr, uid, [event_id], no_of_registration, context=context)
352 res = self.confirm_registration(cr, uid, ids, context=context)
353 self.mail_user(cr, uid, ids, context=context)
356 def button_reg_close(self, cr, uid, ids, context=None):
357 """ Close Registration
361 today = fields.datetime.now()
362 for registration in self.browse(cr, uid, ids, context=context):
363 if today >= registration.event_id.date_begin:
364 values = {'state': 'done', 'date_closed': today}
365 self.write(cr, uid, ids, values)
366 self.message_append(cr, uid, ids, _('State set to Done'), body_text=_('Done'))
368 raise osv.except_osv(_('Error!'),_("You must wait the event starting day to do this action.") )
371 def button_reg_cancel(self, cr, uid, ids, context=None, *args):
372 self.message_append(cr, uid, ids,_('State set to Cancel'),body_text= _('Cancel'))
373 return self.write(cr, uid, ids, {'state': 'cancel'})
375 def mail_user(self, cr, uid, ids, context=None):
377 Send email to user with email_template when registration is done
379 for registration in self.browse(cr, uid, ids, context=context):
380 if registration.event_id.state == 'confirm' and registration.event_id.email_confirmation_id.id:
381 self.mail_user_confirm(cr, uid, ids, context=context)
383 template_id = registration.event_id.email_registration_id.id
385 mail_message = self.pool.get('email.template').send_mail(cr,uid,template_id,registration.id)
388 def mail_user_confirm(self, cr, uid, ids, context=None):
390 Send email to user when the event is confirmed
392 for registration in self.browse(cr, uid, ids, context=context):
393 template_id = registration.event_id.email_confirmation_id.id
395 mail_message = self.pool.get('email.template').send_mail(cr,uid,template_id,registration.id)
398 def onchange_contact_id(self, cr, uid, ids, contact, partner, context=None):
401 addr_obj = self.pool.get('res.partner')
402 contact_id = addr_obj.browse(cr, uid, contact, context=context)
404 'email':contact_id.email,
405 'name':contact_id.name,
406 'phone':contact_id.phone,
409 def onchange_event(self, cr, uid, ids, event_id, context=None):
410 """This function returns value of Product Name, Unit Price based on Event.
416 event_obj = self.pool.get('event.event')
417 data_event = event_obj.browse(cr, uid, event_id, context=context)
419 {'event_begin_date': data_event.date_begin,
420 'event_end_date': data_event.date_end,
421 'company_id': data_event.company_id and data_event.company_id.id or False,
425 def onchange_partner_id(self, cr, uid, ids, part, context=None):
426 res_obj = self.pool.get('res.partner')
429 return {'value': data}
430 addr = res_obj.address_get(cr, uid, [part]).get('default', False)
432 d = self.onchange_contact_id(cr, uid, ids, addr, part, context)
433 data.update(d['value'])
434 return {'value': data}
436 # ----------------------------------------
437 # OpenChatter methods and notifications
438 # ----------------------------------------
440 def create_send_note(self, cr, uid, ids, context=None):
441 message = _("Registration has been <b>created</b>.")
442 self.message_append_note(cr, uid, ids, body=message, context=context)
445 def do_draft_send_note(self, cr, uid, ids, context=None):
446 message = _("Registration has been set as <b>draft</b>.")
447 self.message_append_note(cr, uid, ids, body=message, context=context)
452 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: