addons/subscription/subscription.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 # TODO:
  23 #   Error treatment: exception, request, ... -> send request to user_id
  24
  25 import time
  26 from openerp.osv import fields,osv
  27 from openerp.tools.translate import _
  28
  29 class subscription_document(osv.osv):
  30     _name = "subscription.document"
  31     _description = "Subscription Document"
  32     _columns = {
  33         'name': fields.char('Name', size=60, required=True),
  34         'active': fields.boolean('Active', help="If the active field is set to False, it will allow you to hide the subscription document without removing it."),
  35         'model': fields.many2one('ir.model', 'Object', required=True),
  36         'field_ids': fields.one2many('subscription.document.fields', 'document_id', 'Fields')
  37     }
  38     _defaults = {
  39         'active' : lambda *a: True,
  40     }
  41 subscription_document()
  42
  43 class subscription_document_fields(osv.osv):
  44     _name = "subscription.document.fields"
  45     _description = "Subscription Document Fields"
  46     _rec_name = 'field'
  47     _columns = {
  48         'field': fields.many2one('ir.model.fields', 'Field', domain="[('model_id', '=', parent.model)]", required=True),
  49         'value': fields.selection([('false','False'),('date','Current Date')], 'Default Value', size=40, help="Default value is considered for field when new document is generated."),
  50         'document_id': fields.many2one('subscription.document', 'Subscription Document', ondelete='cascade'),
  51     }
  52     _defaults = {}
  53 subscription_document_fields()
  54
  55 def _get_document_types(self, cr, uid, context=None):
  56     cr.execute('select m.model, s.name from subscription_document s, ir_model m WHERE s.model = m.id order by s.name')
  57     return cr.fetchall()
  58
  59 class subscription_subscription(osv.osv):
  60     _name = "subscription.subscription"
  61     _description = "Subscription"
  62     _columns = {
  63         'name': fields.char('Name', size=60, required=True),
  64         'active': fields.boolean('Active', help="If the active field is set to False, it will allow you to hide the subscription without removing it."),
  65         'partner_id': fields.many2one('res.partner', 'Partner'),
  66         'notes': fields.text('Notes'),
  67         'user_id': fields.many2one('res.users', 'User', required=True),
  68         'interval_number': fields.integer('Interval Qty'),
  69         'interval_type': fields.selection([('days', 'Days'), ('weeks', 'Weeks'), ('months', 'Months')], 'Interval Unit'),
  70         'exec_init': fields.integer('Number of documents'),
  71         'date_init': fields.datetime('First Date'),
  72         'state': fields.selection([('draft','Draft'),('running','Running'),('done','Done')], 'Status'),
  73         'doc_source': fields.reference('Source Document', required=True, selection=_get_document_types, size=128, help="User can choose the source document on which he wants to create documents"),
  74         'doc_lines': fields.one2many('subscription.subscription.history', 'subscription_id', 'Documents created', readonly=True),
  75         'cron_id': fields.many2one('ir.cron', 'Cron Job', help="Scheduler which runs on subscription", states={'running':[('readonly',True)], 'done':[('readonly',True)]}),
  76         'note': fields.text('Notes', help="Description or Summary of Subscription"),
  77     }
  78     _defaults = {
  79         'date_init': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
  80         'user_id': lambda obj,cr,uid,context: uid,
  81         'active': lambda *a: True,
  82         'interval_number': lambda *a: 1,
  83         'interval_type': lambda *a: 'months',
  84         'doc_source': lambda *a: False,
  85         'state': lambda *a: 'draft'
  86     }
  87
  88     def _auto_end(self, cr, context=None):
  89         super(subscription_subscription, self)._auto_end(cr, context=context)
  90         # drop the FK from subscription to ir.cron, as it would cause deadlocks
  91         # during cron job execution. When model_copy() tries to write() on the subscription,
  92         # it has to wait for an ExclusiveLock on the cron job record, but the latter
  93         # is locked by the cron system for the duration of the job!
  94         # FIXME: the subscription module should be reviewed to simplify the scheduling process
  95         #        and to use a unique cron job for all subscriptions, so that it never needs to
  96         #        be updated during its execution.
  97         cr.execute("ALTER TABLE %s DROP CONSTRAINT %s" % (self._table, '%s_cron_id_fkey' % self._table))
  98
  99     def set_process(self, cr, uid, ids, context=None):
 100         for row in self.read(cr, uid, ids, context=context):
 101             mapping = {'name':'name','interval_number':'interval_number','interval_type':'interval_type','exec_init':'numbercall','date_init':'nextcall'}
 102             res = {'model':'subscription.subscription', 'args': repr([[row['id']]]), 'function':'model_copy', 'priority':6, 'user_id':row['user_id'] and row['user_id'][0]}
 103             for key,value in mapping.items():
 104                 res[value] = row[key]
 105             id = self.pool.get('ir.cron').create(cr, uid, res)
 106             self.write(cr, uid, [row['id']], {'cron_id':id, 'state':'running'})
 107         return True
 108
 109     def model_copy(self, cr, uid, ids, context=None):
 110         for row in self.read(cr, uid, ids, context=context):
 111             if not row.get('cron_id',False):
 112                 continue
 113             cron_ids = [row['cron_id'][0]]
 114             remaining = self.pool.get('ir.cron').read(cr, uid, cron_ids, ['numbercall'])[0]['numbercall']
 115             try:
 116                 (model_name, id) = row['doc_source'].split(',')
 117                 id = int(id)
 118                 model = self.pool.get(model_name)
 119             except:
 120                 raise osv.except_osv(_('Wrong Source Document!'), _('Please provide another source document.\nThis one does not exist!'))
 121
 122             default = {'state':'draft'}
 123             doc_obj = self.pool.get('subscription.document')
 124             document_ids = doc_obj.search(cr, uid, [('model.model','=',model_name)])
 125             doc = doc_obj.browse(cr, uid, document_ids)[0]
 126             for f in doc.field_ids:
 127                 if f.value=='date':
 128                     value = time.strftime('%Y-%m-%d')
 129                 else:
 130                     value = False
 131                 default[f.field.name] = value
 132
 133             state = 'running'
 134
 135             # if there was only one remaining document to generate
 136             # the subscription is over and we mark it as being done
 137             if remaining == 1:
 138                 state = 'done'
 139             id = self.pool.get(model_name).copy(cr, uid, id, default, context)
 140             self.pool.get('subscription.subscription.history').create(cr, uid, {'subscription_id': row['id'], 'date':time.strftime('%Y-%m-%d %H:%M:%S'), 'document_id': model_name+','+str(id)})
 141             self.write(cr, uid, [row['id']], {'state':state})
 142         return True
 143
 144     def unlink(self, cr, uid, ids, context=None):
 145         for record in self.browse(cr, uid, ids, context or {}):
 146             if record.state=="running":
 147                 raise osv.except_osv(_('Error!'),_('You cannot delete an active subscription!'))
 148         return super(subscription_subscription, self).unlink(cr, uid, ids, context)
 149
 150     def set_done(self, cr, uid, ids, context=None):
 151         res = self.read(cr,uid, ids, ['cron_id'])
 152         ids2 = [x['cron_id'][0] for x in res if x['id']]
 153         self.pool.get('ir.cron').write(cr, uid, ids2, {'active':False})
 154         self.write(cr, uid, ids, {'state':'done'})
 155         return True
 156
 157     def set_draft(self, cr, uid, ids, context=None):
 158         self.write(cr, uid, ids, {'state':'draft'})
 159         return True
 160 subscription_subscription()
 161
 162 class subscription_subscription_history(osv.osv):
 163     _name = "subscription.subscription.history"
 164     _description = "Subscription history"
 165     _rec_name = 'date'
 166     _columns = {
 167         'date': fields.datetime('Date'),
 168         'subscription_id': fields.many2one('subscription.subscription', 'Subscription', ondelete='cascade'),
 169         'document_id': fields.reference('Source Document', required=True, selection=_get_document_types, size=128),
 170     }
 171 subscription_subscription_history()
 172
 173
 174 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 175