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