addons/account_analytic_plans/account_analytic_plans.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 import time
  23 from lxml import etree
  24
  25 from osv import fields, osv
  26 import tools
  27 from tools.translate import _
  28
  29 class one2many_mod2(fields.one2many):
  30     def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
  31         if not context:
  32             context = {}
  33         res = {}
  34         for id in ids:
  35             res[id] = []
  36         ids2 = None
  37         if 'journal_id' in context:
  38             journal = obj.pool.get('account.journal').browse(cr, user, context['journal_id'], context=context)
  39             pnum = int(name[7]) -1
  40             plan = journal.plan_id
  41             if plan and len(plan.plan_ids) > pnum:
  42                 acc_id = plan.plan_ids[pnum].root_analytic_id.id
  43                 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id,'in',ids),('analytic_account_id','child_of',[acc_id])], limit=self._limit)
  44         if ids2 is None:
  45             ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id,'in',ids)], limit=self._limit)
  46         for r in obj.pool.get(self._obj)._read_flat(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
  47             res[r[self._fields_id]].append( r['id'] )
  48         return res
  49
  50 class account_analytic_plan(osv.osv):
  51     _name = "account.analytic.plan"
  52     _description = "Analytic Plan"
  53     _columns = {
  54         'name': fields.char('Analytic Plan', size=64, required=True, select=True),
  55         'plan_ids': fields.one2many('account.analytic.plan.line', 'plan_id', 'Analytic Plans'),
  56     }
  57
  58 account_analytic_plan()
  59
  60 class account_analytic_plan_line(osv.osv):
  61     _name = "account.analytic.plan.line"
  62     _description = "Analytic Plan Line"
  63     _order = "sequence, id"
  64     _columns = {
  65         'plan_id': fields.many2one('account.analytic.plan','Analytic Plan'),
  66         'name': fields.char('Plan Name', size=64, required=True, select=True),
  67         'sequence': fields.integer('Sequence'),
  68         'root_analytic_id': fields.many2one('account.analytic.account', 'Root Account', help="Root account of this plan.", required=False),
  69         'min_required': fields.float('Minimum Allowed (%)'),
  70         'max_required': fields.float('Maximum Allowed (%)'),
  71     }
  72     _defaults = {
  73         'min_required': 100.0,
  74         'max_required': 100.0,
  75     }
  76
  77 account_analytic_plan_line()
  78
  79 class account_analytic_plan_instance(osv.osv):
  80     _name = "account.analytic.plan.instance"
  81     _description = "Analytic Plan Instance"
  82     _columns = {
  83         'name': fields.char('Analytic Distribution', size=64),
  84         'code': fields.char('Distribution Code', size=16),
  85         'journal_id': fields.many2one('account.analytic.journal', 'Analytic Journal' ),
  86         'account_ids': fields.one2many('account.analytic.plan.instance.line', 'plan_id', 'Account Id'),
  87         'account1_ids': one2many_mod2('account.analytic.plan.instance.line', 'plan_id', 'Account1 Id'),
  88         'account2_ids': one2many_mod2('account.analytic.plan.instance.line', 'plan_id', 'Account2 Id'),
  89         'account3_ids': one2many_mod2('account.analytic.plan.instance.line', 'plan_id', 'Account3 Id'),
  90         'account4_ids': one2many_mod2('account.analytic.plan.instance.line', 'plan_id', 'Account4 Id'),
  91         'account5_ids': one2many_mod2('account.analytic.plan.instance.line', 'plan_id', 'Account5 Id'),
  92         'account6_ids': one2many_mod2('account.analytic.plan.instance.line', 'plan_id', 'Account6 Id'),
  93         'plan_id': fields.many2one('account.analytic.plan', "Model's Plan"),
  94     }
  95
  96     def search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False):
  97         if context is None:
  98             context = {}
  99         journal_obj = self.pool.get('account.journal')
 100         if context.get('journal_id', False):
 101             journal = journal_obj.browse(cr, user, [context['journal_id']], context=context)[0]
 102             analytic_journal = journal.analytic_journal_id and journal.analytic_journal_id.id or False
 103             args.append('|')
 104             args.append(('journal_id', '=', analytic_journal))
 105             args.append(('journal_id', '=', False))
 106         res = super(account_analytic_plan_instance, self).search(cr, user, args, offset=offset, limit=limit, order=order,
 107                                                                  context=context, count=count)
 108         return res
 109
 110     def copy(self, cr, uid, id, default=None, context=None):
 111         if not default:
 112             default = {}
 113         default.update({'account1_ids':False, 'account2_ids':False, 'account3_ids':False,
 114                 'account4_ids':False, 'account5_ids':False, 'account6_ids':False})
 115         return super(account_analytic_plan_instance, self).copy(cr, uid, id, default, context=context)
 116
 117     def _default_journal(self, cr, uid, context=None):
 118         if not context:
 119             context = {}
 120         journal_obj = self.pool.get('account.journal')
 121         if context.has_key('journal_id') and context['journal_id']:
 122             journal = journal_obj.browse(cr, uid, context['journal_id'], context=context)
 123             if journal.analytic_journal_id:
 124                 return journal.analytic_journal_id.id
 125         return False
 126
 127     _defaults = {
 128         'plan_id': False,
 129         'journal_id': _default_journal,
 130     }
 131     def name_get(self, cr, uid, ids, context=None):
 132         res = []
 133         for inst in self.browse(cr, uid, ids, context=context):
 134             name = inst.name or '/'
 135             if name and inst.code:
 136                 name=name+' ('+inst.code+')'
 137             res.append((inst.id, name))
 138         return res
 139
 140     def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
 141         args = args or []
 142         if name:
 143             ids = self.search(cr, uid, [('code', '=', name)] + args, limit=limit, context=context or {})
 144             if not ids:
 145                 ids = self.search(cr, uid, [('name', operator, name)] + args, limit=limit, context=context or {})
 146         else:
 147             ids = self.search(cr, uid, args, limit=limit, context=context or {})
 148         return self.name_get(cr, uid, ids, context or {})
 149
 150     def fields_view_get(self, cr, uid, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
 151         wiz_id = self.pool.get('ir.actions.act_window').search(cr, uid, [("name","=","analytic.plan.create.model.action")], context=context)
 152         res = super(account_analytic_plan_instance,self).fields_view_get(cr, uid, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
 153         journal_obj = self.pool.get('account.journal')
 154         analytic_plan_obj = self.pool.get('account.analytic.plan')
 155         if (res['type']=='form'):
 156             plan_id = False
 157             if context.get('journal_id', False):
 158                 plan_id = journal_obj.browse(cr, uid, int(context['journal_id']), context=context).plan_id
 159             elif context.get('plan_id', False):
 160                 plan_id = analytic_plan_obj.browse(cr, uid, int(context['plan_id']), context=context)
 161
 162             if plan_id:
 163                 i=1
 164                 res['arch'] = """<form string="%s">
 165     <field name="name"/>
 166     <field name="code"/>
 167     <field name="journal_id"/>
 168     <button name="%d" string="Save This Distribution as a Model" type="action" colspan="2"/>
 169     """% (tools.to_xml(plan_id.name), wiz_id[0])
 170                 for line in plan_id.plan_ids:
 171                     res['arch']+="""
 172                     <field name="account%d_ids" string="%s" colspan="4">
 173                     <tree string="%s" editable="bottom">
 174                         <field name="rate"/>
 175                         <field name="analytic_account_id" domain="[('parent_id','child_of',[%d])]" groups="base.group_extended"/>
 176                     </tree>
 177                 </field>
 178                 <newline/>"""%(i,tools.to_xml(line.name),tools.to_xml(line.name),line.root_analytic_id and line.root_analytic_id.id or 0)
 179                     i+=1
 180                 res['arch'] += "</form>"
 181                 doc = etree.fromstring(res['arch'].encode('utf8'))
 182                 xarch, xfields = self._view_look_dom_arch(cr, uid, doc, view_id, context=context)
 183                 res['arch'] = xarch
 184                 res['fields'] = xfields
 185             return res
 186         else:
 187             return res
 188
 189     def create(self, cr, uid, vals, context=None):
 190         journal_obj = self.pool.get('account.journal')
 191         ana_plan_instance_obj = self.pool.get('account.analytic.plan.instance')
 192         acct_anal_acct = self.pool.get('account.analytic.account')
 193         acct_anal_plan_line_obj = self.pool.get('account.analytic.plan.line')
 194         if context and 'journal_id' in context:
 195             journal = journal_obj.browse(cr, uid, context['journal_id'], context=context)
 196
 197             pids = ana_plan_instance_obj.search(cr, uid, [('name','=',vals['name']), ('code','=',vals['code']), ('plan_id','<>',False)], context=context)
 198             if pids:
 199                 raise osv.except_osv(_('Error'), _('A model having this name and code already exists !'))
 200
 201             res = acct_anal_plan_line_obj.search(cr, uid, [('plan_id','=',journal.plan_id.id)], context=context)
 202             for i in res:
 203                 total_per_plan = 0
 204                 item = acct_anal_plan_line_obj.browse(cr, uid, i, context=context)
 205                 temp_list = ['account1_ids','account2_ids','account3_ids','account4_ids','account5_ids','account6_ids']
 206                 for l in temp_list:
 207                     if vals.has_key(l):
 208                         for tempo in vals[l]:
 209                             if acct_anal_acct.search(cr, uid, [('parent_id', 'child_of', [item.root_analytic_id.id]), ('id', '=', tempo[2]['analytic_account_id'])], context=context):
 210                                 total_per_plan += tempo[2]['rate']
 211                 if total_per_plan < item.min_required or total_per_plan > item.max_required:
 212                     raise osv.except_osv(_('Value Error'),_('The Total Should be Between %s and %s') % (str(item.min_required), str(item.max_required)))
 213
 214         return super(account_analytic_plan_instance, self).create(cr, uid, vals, context=context)
 215
 216     def write(self, cr, uid, ids, vals, context=None, check=True, update_check=True):
 217         this = self.browse(cr, uid, ids[0], context=context)
 218         invoice_line_obj = self.pool.get('account.invoice.line')
 219         if this.plan_id and not vals.has_key('plan_id'):
 220             #this instance is a model, so we have to create a new plan instance instead of modifying it
 221             #copy the existing model
 222             temp_id = self.copy(cr, uid, this.id, None, context=context)
 223             #get the list of the invoice line that were linked to the model
 224             lists = invoice_line_obj.search(cr, uid, [('analytics_id','=',this.id)], context=context)
 225             #make them link to the copy
 226             invoice_line_obj.write(cr, uid, lists, {'analytics_id':temp_id}, context=context)
 227
 228             #and finally modify the old model to be not a model anymore
 229             vals['plan_id'] = False
 230             if not vals.has_key('name'):
 231                 vals['name'] = this.name and (str(this.name)+'*') or "*"
 232             if not vals.has_key('code'):
 233                 vals['code'] = this.code and (str(this.code)+'*') or "*"
 234         return super(account_analytic_plan_instance, self).write(cr, uid, ids, vals, context=context)
 235
 236 account_analytic_plan_instance()
 237
 238 class account_analytic_plan_instance_line(osv.osv):
 239     _name = "account.analytic.plan.instance.line"
 240     _description = "Analytic Instance Line"
 241     _columns = {
 242         'plan_id': fields.many2one('account.analytic.plan.instance', 'Plan Id'),
 243         'analytic_account_id': fields.many2one('account.analytic.account', 'Analytic Account', required=True),
 244         'rate': fields.float('Rate (%)', required=True),
 245     }
 246     _defaults = {
 247         'rate': 100.0
 248     }
 249     def name_get(self, cr, uid, ids, context=None):
 250         if not ids:
 251             return []
 252         reads = self.read(cr, uid, ids, ['analytic_account_id'], context=context)
 253         res = []
 254         for record in reads:
 255             res.append((record['id'], record['analytic_account_id']))
 256         return res
 257
 258 account_analytic_plan_instance_line()
 259
 260 class account_journal(osv.osv):
 261     _inherit = "account.journal"
 262     _name = "account.journal"
 263     _columns = {
 264         'plan_id': fields.many2one('account.analytic.plan', 'Analytic Plans'),
 265     }
 266
 267 account_journal()
 268
 269 class account_invoice_line(osv.osv):
 270     _inherit = "account.invoice.line"
 271     _name = "account.invoice.line"
 272     _columns = {
 273         'analytics_id': fields.many2one('account.analytic.plan.instance', 'Analytic Distribution'),
 274     }
 275
 276     def create(self, cr, uid, vals, context=None):
 277         if 'analytics_id' in vals and isinstance(vals['analytics_id'], tuple):
 278             vals['analytics_id'] = vals['analytics_id'][0]
 279         return super(account_invoice_line, self).create(cr, uid, vals, context=context)
 280
 281     def move_line_get_item(self, cr, uid, line, context=None):
 282         res = super(account_invoice_line, self).move_line_get_item(cr, uid, line, context=context)
 283         res ['analytics_id'] = line.analytics_id and line.analytics_id.id or False
 284         return res
 285
 286     def product_id_change(self, cr, uid, ids, product, uom, qty=0, name='', type='out_invoice', partner_id=False, fposition_id=False, price_unit=False, address_invoice_id=False, currency_id=False, context=None):
 287         res_prod = super(account_invoice_line, self).product_id_change(cr, uid, ids, product, uom, qty, name, type, partner_id, fposition_id, price_unit, address_invoice_id, currency_id, context=context)
 288         rec = self.pool.get('account.analytic.default').account_get(cr, uid, product, partner_id, uid, time.strftime('%Y-%m-%d'), context=context)
 289         if rec and rec.analytics_id:
 290             res_prod['value'].update({'analytics_id': rec.analytics_id.id})
 291         return res_prod
 292
 293 account_invoice_line()
 294
 295 class account_move_line(osv.osv):
 296
 297     _inherit = "account.move.line"
 298     _name = "account.move.line"
 299     _columns = {
 300         'analytics_id':fields.many2one('account.analytic.plan.instance', 'Analytic Distribution'),
 301     }
 302
 303     def _default_get_move_form_hook(self, cursor, user, data):
 304         data = super(account_move_line, self)._default_get_move_form_hook(cursor, user, data)
 305         if data.has_key('analytics_id'):
 306             del(data['analytics_id'])
 307         return data
 308
 309     def create_analytic_lines(self, cr, uid, ids, context=None):
 310         super(account_move_line, self).create_analytic_lines(cr, uid, ids, context=context)
 311         analytic_line_obj = self.pool.get('account.analytic.line')
 312         for line in self.browse(cr, uid, ids, context=context):
 313            if line.analytics_id:
 314                if not line.journal_id.analytic_journal_id:
 315                    raise osv.except_osv(_('No Analytic Journal !'),_("You have to define an analytic journal on the '%s' journal!") % (line.journal_id.name,))
 316
 317                toremove = analytic_line_obj.search(cr, uid, [('move_id','=',line.id)], context=context)
 318                if toremove:
 319                     analytic_line_obj.unlink(cr, uid, toremove, context=context)
 320                for line2 in line.analytics_id.account_ids:
 321                    val = (line.credit or  0.0) - (line.debit or 0.0)
 322                    amt=val * (line2.rate/100)
 323                    al_vals={
 324                        'name': line.name,
 325                        'date': line.date,
 326                        'account_id': line2.analytic_account_id.id,
 327                        'unit_amount': line.quantity,
 328                        'product_id': line.product_id and line.product_id.id or False,
 329                        'product_uom_id': line.product_uom_id and line.product_uom_id.id or False,
 330                        'amount': amt,
 331                        'general_account_id': line.account_id.id,
 332                        'move_id': line.id,
 333                        'journal_id': line.journal_id.analytic_journal_id.id,
 334                        'ref': line.ref,
 335                    }
 336                    analytic_line_obj.create(cr, uid, al_vals, context=context)
 337         return True
 338
 339     def fields_view_get(self, cr, uid, view_id=None, view_type='form', context={}, toolbar=False, submenu=False):
 340         result = super(osv.osv, self).fields_view_get(cr, uid, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
 341         return result
 342
 343 account_move_line()
 344
 345 class account_invoice(osv.osv):
 346     _name = "account.invoice"
 347     _inherit = "account.invoice"
 348
 349     def line_get_convert(self, cr, uid, x, part, date, context=None):
 350         res=super(account_invoice,self).line_get_convert(cr, uid, x, part, date, context=context)
 351         res['analytics_id'] = x.get('analytics_id', False)
 352         return res
 353
 354     def _get_analytic_lines(self, cr, uid, id):
 355         inv = self.browse(cr, uid, [id])[0]
 356         cur_obj = self.pool.get('res.currency')
 357         invoice_line_obj = self.pool.get('account.invoice.line')
 358         acct_ins_obj = self.pool.get('account.analytic.plan.instance')
 359         company_currency = inv.company_id.currency_id.id
 360         if inv.type in ('out_invoice', 'in_refund'):
 361             sign = 1
 362         else:
 363             sign = -1
 364
 365         iml = invoice_line_obj.move_line_get(cr, uid, inv.id)
 366
 367         for il in iml:
 368             if il.get('analytics_id', False):
 369
 370                 if inv.type in ('in_invoice', 'in_refund'):
 371                     ref = inv.reference
 372                 else:
 373                     ref = self._convert_ref(cr, uid, inv.number)
 374                 obj_move_line = acct_ins_obj.browse(cr, uid, il['analytics_id'])
 375                 amount_calc = cur_obj.compute(cr, uid, inv.currency_id.id, company_currency, il['price'], context={'date': inv.date_invoice}) * sign
 376                 qty = il['quantity']
 377                 il['analytic_lines'] = []
 378                 for line2 in obj_move_line.account_ids:
 379                     amt = amount_calc * (line2.rate/100)
 380                     qtty = qty* (line2.rate/100)
 381                     al_vals = {
 382                         'name': il['name'],
 383                         'date': inv['date_invoice'],
 384                         'unit_amount': qtty,
 385                         'product_id': il['product_id'],
 386                         'account_id': line2.analytic_account_id.id,
 387                         'amount': amt,
 388                         'product_uom_id': il['uos_id'],
 389                         'general_account_id': il['account_id'],
 390                         'journal_id': self._get_journal_analytic(cr, uid, inv.type),
 391                         'ref': ref,
 392                     }
 393                     il['analytic_lines'].append((0, 0, al_vals))
 394         return iml
 395
 396 account_invoice()
 397
 398 class account_analytic_plan(osv.osv):
 399     _inherit = "account.analytic.plan"
 400     _columns = {
 401         'default_instance_id': fields.many2one('account.analytic.plan.instance', 'Default Entries'),
 402     }
 403 account_analytic_plan()
 404
 405 class analytic_default(osv.osv):
 406     _inherit = "account.analytic.default"
 407     _columns = {
 408         'analytics_id': fields.many2one('account.analytic.plan.instance', 'Analytic Distribution'),
 409     }
 410
 411 analytic_default()
 412
 413 class sale_order_line(osv.osv):
 414     _inherit = "sale.order.line"
 415
 416     # Method overridden to set the analytic account by default on criterion match
 417     def invoice_line_create(self, cr, uid, ids, context=None):
 418         create_ids = super(sale_order_line,self).invoice_line_create(cr, uid, ids, context=context)
 419         inv_line_obj = self.pool.get('account.invoice.line')
 420         acct_anal_def_obj = self.pool.get('account.analytic.default')
 421         if ids:
 422             sale_line = self.browse(cr, uid, ids[0], context=context)
 423             for line in inv_line_obj.browse(cr, uid, create_ids, context=context):
 424                 rec = acct_anal_def_obj.account_get(cr, uid, line.product_id.id, sale_line.order_id.partner_id.id, uid, time.strftime('%Y-%m-%d'), context)
 425
 426                 if rec:
 427                     inv_line_obj.write(cr, uid, [line.id], {'analytics_id': rec.analytics_id.id}, context=context)
 428         return create_ids
 429
 430 sale_order_line()
 431
 432
 433 class account_bank_statement(osv.osv):
 434     _inherit = "account.bank.statement"
 435     _name = "account.bank.statement"
 436
 437     def create_move_from_st_line(self, cr, uid, st_line_id, company_currency_id, st_line_number, context=None):
 438         account_move_line_pool = self.pool.get('account.move.line')
 439         account_bank_statement_line_pool = self.pool.get('account.bank.statement.line')
 440         st_line = account_bank_statement_line_pool.browse(cr, uid, st_line_id, context)
 441         result = super(account_bank_statement,self).create_move_from_st_line(cr, uid, st_line_id, company_currency_id, st_line_number, context=context)
 442         move = st_line.move_ids and st_line.move_ids[0] or False
 443         if move:
 444             for line in move.line_id:
 445                 account_move_line_pool.write(cr, uid, [line.id], {'analytics_id':st_line.analytics_id.id}, context=context)
 446         return result
 447
 448     def button_confirm_bank(self, cr, uid, ids, context=None):
 449         super(account_bank_statement,self).button_confirm_bank(cr, uid, ids, context=context)
 450         for st in self.browse(cr, uid, ids, context):
 451             for st_line in st.line_ids:
 452                 if st_line.analytics_id:
 453                     if not st.journal_id.analytic_journal_id:
 454                         raise osv.except_osv(_('No Analytic Journal !'),_("You have to define an analytic journal on the '%s' journal!") % (st.journal_id.name,))
 455                 if not st_line.amount:
 456                     continue
 457         return True
 458
 459 account_bank_statement()
 460
 461
 462 class account_bank_statement_line(osv.osv):
 463     _inherit = "account.bank.statement.line"
 464     _name = "account.bank.statement.line"
 465     _columns = {
 466         'analytics_id': fields.many2one('account.analytic.plan.instance', 'Analytic Distribution'),
 467     }
 468 account_bank_statement_line()
 469
 470 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: