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 osv import fields,osv
  27 from 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
  42     def write(self, cr, uid, ids, vals, context=None):
  43         if 'model' in vals:
  44             raise osv.except_osv(_('Error !'),_('You cannot modify the Object linked to the Document Type!\nCreate another Document instead !'))
  45         return super(subscription_document, self).write(cr, uid, ids, vals, context=context)
  46
  47 subscription_document()
  48
  49 class subscription_document_fields(osv.osv):
  50     _name = "subscription.document.fields"
  51     _description = "Subscription Document Fields"
  52     _rec_name = 'field'
  53     _columns = {
  54         'field': fields.many2one('ir.model.fields', 'Field', domain="[('model_id', '=', parent.model)]", required=True),
  55         'value': fields.selection([('false','False'),('date','Current Date')], 'Default Value', size=40, help="Default value is considered for field when new document is generated."),
  56         'document_id': fields.many2one('subscription.document', 'Subscription Document', ondelete='cascade'),
  57     }
  58     _defaults = {}
  59 subscription_document_fields()
  60
  61 def _get_document_types(self, cr, uid, context=None):
  62     cr.execute('select m.model, s.name from subscription_document s, ir_model m WHERE s.model = m.id order by s.name')
  63     return cr.fetchall()
  64
  65 class subscription_subscription(osv.osv):
  66     _name = "subscription.subscription"
  67     _description = "Subscription"
  68     _columns = {
  69         'name': fields.char('Name', size=60, required=True),
  70         'active': fields.boolean('Active', help="If the active field is set to False, it will allow you to hide the subscription without removing it."),
  71         'partner_id': fields.many2one('res.partner', 'Partner'),
  72         'notes': fields.text('Notes'),
  73         'user_id': fields.many2one('res.users', 'User', required=True),
  74         'interval_number': fields.integer('Interval Qty'),
  75         'interval_type': fields.selection([('days', 'Days'), ('weeks', 'Weeks'), ('months', 'Months')], 'Interval Unit'),
  76         'exec_init': fields.integer('Number of documents'),
  77         'date_init': fields.datetime('First Date'),
  78         'state': fields.selection([('draft','Draft'),('running','Running'),('done','Done')], 'State'),
  79         '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"),
  80         'doc_lines': fields.one2many('subscription.subscription.history', 'subscription_id', 'Documents created', readonly=True),
  81         'cron_id': fields.many2one('ir.cron', 'Cron Job', help="Scheduler which runs on subscription"),
  82         'note': fields.text('Notes', help="Description or Summary of Subscription"),
  83     }
  84     _defaults = {
  85         'date_init': lambda *a: time.strftime('%Y-%m-%d %H:%M:%S'),
  86         'user_id': lambda obj,cr,uid,context: uid,
  87         'active': lambda *a: True,
  88         'interval_number': lambda *a: 1,
  89         'interval_type': lambda *a: 'months',
  90         'doc_source': lambda *a: False,
  91         'state': lambda *a: 'draft'
  92     }
  93
  94     def set_process(self, cr, uid, ids, context=None):
  95         for row in self.read(cr, uid, ids, context=context):
  96             mapping = {'name':'name','interval_number':'interval_number','interval_type':'interval_type','exec_init':'numbercall','date_init':'nextcall'}
  97             res = {'model':'subscription.subscription', 'args': repr([[row['id']]]), 'function':'model_copy', 'priority':6, 'user_id':row['user_id'] and row['user_id'][0]}
  98             for key,value in mapping.items():
  99                 res[value] = row[key]
 100             id = self.pool.get('ir.cron').create(cr, uid, res)
 101             self.write(cr, uid, [row['id']], {'cron_id':id, 'state':'running'})
 102         return True
 103
 104     def model_copy(self, cr, uid, ids, context=None):
 105         for row in self.read(cr, uid, ids, context=context):
 106             if not row.get('cron_id',False):
 107                 continue
 108             cron_ids = [row['cron_id'][0]]
 109             remaining = self.pool.get('ir.cron').read(cr, uid, cron_ids, ['numbercall'])[0]['numbercall']
 110             try:
 111                 (model_name, id) = row['doc_source'].split(',')
 112                 id = int(id)
 113                 model = self.pool.get(model_name)
 114             except:
 115                 raise osv.except_osv(_('Wrong Source Document !'), _('Please provide another source document.\nThis one does not exist !'))
 116
 117             default = {'state':'draft'}
 118             doc_obj = self.pool.get('subscription.document')
 119             document_ids = doc_obj.search(cr, uid, [('model.model','=',model_name)])
 120             doc = doc_obj.browse(cr, uid, document_ids)[0]
 121             for f in doc.field_ids:
 122                 if f.value=='date':
 123                     value = time.strftime('%Y-%m-%d')
 124                 else:
 125                     value = False
 126                 default[f.field.name] = value
 127
 128             state = 'running'
 129
 130             # if there was only one remaining document to generate
 131             # the subscription is over and we mark it as being done
 132             if remaining == 1:
 133                 state = 'done'
 134             id = self.pool.get(model_name).copy(cr, uid, id, default, context)
 135             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)})
 136             self.write(cr, uid, [row['id']], {'state':state})
 137         return True
 138
 139     def set_done(self, cr, uid, ids, context=None):
 140         res = self.read(cr,uid, ids, ['cron_id'])
 141         ids2 = [x['cron_id'][0] for x in res if x['id']]
 142         self.pool.get('ir.cron').write(cr, uid, ids2, {'active':False})
 143         self.write(cr, uid, ids, {'state':'done'})
 144         return True
 145
 146     def set_draft(self, cr, uid, ids, context=None):
 147         self.write(cr, uid, ids, {'state':'draft'})
 148         return True
 149 subscription_subscription()
 150
 151 class subscription_subscription_history(osv.osv):
 152     _name = "subscription.subscription.history"
 153     _description = "Subscription history"
 154     _rec_name = 'date'
 155     _columns = {
 156         'date': fields.datetime('Date'),
 157         'subscription_id': fields.many2one('subscription.subscription', 'Subscription', ondelete='cascade'),
 158         'document_id': fields.reference('Source Document', required=True, selection=[('account.invoice','Invoice'),('sale.order','Sale Order')], size=128),
 159     }
 160 subscription_subscription_history()
 161
 162
 163 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 164