BaobabConduit.py 41.9 KB
Newer Older
Kevin Deldycke's avatar
Kevin Deldycke committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
##############################################################################
#
# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
#                    Kevin Deldycke <kevin@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################

from Products.ERP5SyncML.Conduit.ERP5Conduit import ERP5Conduit
from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions
from Products.ERP5Type.Utils import convertToUpperCase
from Products.CMFCore.utils import getToolByName
from Acquisition import aq_base, aq_inner, aq_chain, aq_acquire
Yoshinori Okuji's avatar
Yoshinori Okuji committed
35
from ZODB.POSException import ConflictError
Kevin Deldycke's avatar
Kevin Deldycke committed
36 37 38 39 40 41 42 43

import datetime

from zLOG import LOG



class BaobabConduit(ERP5Conduit):
44 45 46 47 48 49 50 51 52 53
  """
  A conduit is in charge to read data from a particular structure,
  and then to save this data in another structure.

  In baobab, the data is read from some sql tables and it will stored
  with ERP5 objects. The difficult parts are :
  - for one sql table we have several kind of objects in ERP5
  - for each properties that comes from sql, we have one ore more
    properties in ERP5

Sebastien Robin's avatar
Sebastien Robin committed
54
  Most importants method defined here are :
55 56 57 58 59 60 61 62 63 64
  - constructContent : it is used when a new set of data comes from
                       the sql table, then constructContent must decide
                       wich kind of object must be created in ERP5
  - editDocument : after constructContent, editDocument is called with
                   all properties that comes from the set of data from
                   sql. Each property must be converted to ERP5 property.

  If you need to handle a new property, the most important thing to know
  is what will be the property used in ERP5. Then you have to enter a
  new dictionary in the property_map variable.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

  # New changes on october 2006:
  * on Compte
    - numero become numero_interne
    - add code_pays (ex K)
    - add code etab (code etablissement), ex 0101
    - add code_guichet
    - add numero_compte : international account number
    - add rib : ex 52
    - add code_bic : ex SGBSSND0
    - add overdraft_facility O/N (Yes/No)
    - add swift_registered  O/N (Yes/No)
  * on Client
    - remove code_bic
    - zone_residence is now well completed, we should find country
         information. We should be a corresponding dictionary in order
         to set the right region
82
  """
Kevin Deldycke's avatar
Kevin Deldycke committed
83 84 85 86 87 88 89

  global property_map

  # Declarative security
  security = ClassSecurityInfo()


90
  ### This data structure associate a xml property to an ERP5 object property in certain conditions
91
  property_map = {
Sebastien Robin's avatar
Sebastien Robin committed
92
    # For example, in the sql export, we use for the first name of a person the
93 94
    # property 'nom', in ERP5 we use the property first_name
    'nom':[{
Sebastien Robin's avatar
Sebastien Robin committed
95
          'erp5_property': 'first_name'
96 97
        , 'conditions'   : {'erp5_portal_type':'Person'}
        }
Sebastien Robin's avatar
Sebastien Robin committed
98
      , {
Sebastien Robin's avatar
Sebastien Robin committed
99
         'erp5_property': 'title'
100 101
        , 'conditions'   : {'erp5_portal_type':'Organisation'}
        }],
Sebastien Robin's avatar
Sebastien Robin committed
102
    # For example, in the sql export, we use for the name of an organisation the
103 104
    # property 'nom', in ERP5 we use the property title
    'adresse': [{
Sebastien Robin's avatar
Sebastien Robin committed
105
        'erp5_property': 'default_address_street_address'
Kevin Deldycke's avatar
Kevin Deldycke committed
106 107
      , 'conditions'   : [{'erp5_portal_type':'Organisation'}
                         ,{'erp5_portal_type':'Person'}]
108 109
      }],
    'zone_residence': [{
Sebastien Robin's avatar
Sebastien Robin committed
110
        'erp5_property': 'default_address_region'
Kevin Deldycke's avatar
Kevin Deldycke committed
111 112
      , 'conditions'   : [{'erp5_portal_type':'Organisation'}
                         ,{'erp5_portal_type':'Person'}]
113 114
      }],
    'titre': [{
Sebastien Robin's avatar
Sebastien Robin committed
115
        'erp5_property': 'prefix'
Kevin Deldycke's avatar
Kevin Deldycke committed
116
      , 'conditions'   : {'erp5_portal_type':'Person'}
117 118
      }],
    'telephone': [{
Sebastien Robin's avatar
Sebastien Robin committed
119
        'erp5_property': 'default_telephone_number'
Kevin Deldycke's avatar
Kevin Deldycke committed
120 121
      , 'conditions'   : [{'erp5_portal_type':'Organisation'}
                         ,{'erp5_portal_type':'Person'}]
122 123
      }],
    'telex': [{
Sebastien Robin's avatar
Sebastien Robin committed
124
        'erp5_property': 'default_fax_number'
Kevin Deldycke's avatar
Kevin Deldycke committed
125 126
      , 'conditions'   : [{'erp5_portal_type':'Organisation'}
                         ,{'erp5_portal_type':'Person'}]
127 128
      }],
    'prenom': [{
Sebastien Robin's avatar
Sebastien Robin committed
129
        'erp5_property': 'last_name'
Kevin Deldycke's avatar
Kevin Deldycke committed
130
      , 'conditions'   : {'erp5_portal_type':'Person'}
131 132
      }],
    'date_naissance': [{
Sebastien Robin's avatar
Sebastien Robin committed
133
        'erp5_property': 'birthday'
Kevin Deldycke's avatar
Kevin Deldycke committed
134
      , 'conditions'   : {'erp5_portal_type':'Person'}
135 136
      }],
    'code_bic': [{
Sebastien Robin's avatar
Sebastien Robin committed
137
        'erp5_property': 'bic_code'
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
      , 'conditions'   : {'erp5_portal_type':'Bank Account'}
      }],
    'code_pays': [{
        'erp5_property': 'bank_country_code'
      , 'conditions'   : {'erp5_portal_type':'Bank Account'}
      }],
    'code_etab': [{
        'erp5_property': 'bank_code'
      , 'conditions'   : {'erp5_portal_type':'Bank Account'}
      }],
    'code_guichet': [{
        'erp5_property': 'branch'
      , 'conditions'   : {'erp5_portal_type':'Bank Account'}
      }],
    'numero_compte': [{
        'erp5_property': 'bank_account_number'
      , 'conditions'   : {'erp5_portal_type':'Bank Account'}
      }],
    'rib': [{
        'erp5_property': 'bank_account_key'
      , 'conditions'   : {'erp5_portal_type':'Bank Account'}
      }],
    'numero_interne': [{
        'erp5_property': 'internal_bank_account_number'
      , 'conditions'   : {'erp5_portal_type':'Bank Account'}
163 164
      }],
    'intitule': [{
Sebastien Robin's avatar
Sebastien Robin committed
165
        'erp5_property': 'title'
Kevin Deldycke's avatar
Kevin Deldycke committed
166
      , 'conditions'   : {'erp5_portal_type':'Bank Account'}
167 168
      }],
    'montant_maxi': [{
Sebastien Robin's avatar
Sebastien Robin committed
169
        'erp5_property': 'operation_upper_limit'
Kevin Deldycke's avatar
Kevin Deldycke committed
170
      , 'conditions'   : {'erp5_portal_type':'Agent Privilege'}
171 172
      }],
    'description': [{
Sebastien Robin's avatar
Sebastien Robin committed
173
        'erp5_property': 'description'
Kevin Deldycke's avatar
Kevin Deldycke committed
174
      , 'conditions'   : {'erp5_portal_type':'Agent Privilege'}
175 176
      }],
    'inventory_title': [{
Sebastien Robin's avatar
Sebastien Robin committed
177
        'erp5_property': 'title'
178
      , 'conditions'   : {'erp5_portal_type':'Cash Inventory Group'}
179
      }],
180 181 182 183
    'inventory_date': [{
        'erp5_property': 'start_date'
      , 'conditions'   : {'erp5_portal_type':'Cash Inventory Group'}
      }],
184
    'title': [{
Sebastien Robin's avatar
Sebastien Robin committed
185
        'erp5_property': 'title'
186
      , 'conditions'   : {'erp5_portal_type':'Bank Account Inventory'}
187 188
      }],
    'amount': [{
189
        'erp5_property': 'quantity'
190
      , 'conditions'   : {'erp5_portal_type':'Bank Account Inventory Line'}
191
      }],
Sebastien Robin's avatar
Sebastien Robin committed
192
    'cle': [{
193
        'erp5_property': 'int_index'
Sebastien Robin's avatar
Sebastien Robin committed
194 195
      , 'conditions'   : {'erp5_portal_type':'Bank Account'}
      }],
196
    }
Kevin Deldycke's avatar
Kevin Deldycke committed
197

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
  try:
    from Products.Baobab.Conduit import inventory_code_to_path
    from Products.Baobab.Conduit import vault_code_to_path
    from Products.Baobab.Conduit import variation_translate_dict
  except ImportError:
    inventory_code_to_path = {}
    vault_code_to_path = {}
    variation_translate_dict = {}

  status_code_to_cash_status = {'TVA' : 'valid',
                                'NEE' : 'new_emitted',
                                'NEU' : 'new_not_emitted',
                                'RTC' : 'retired',
                                'ATR' : 'to_sort',
                                'MUT' : 'mutilated',
                                'EAV' : 'to_ventilate',
                                'ANN' : 'cancelled',
                                'MIX' : 'mixed'}
216

Kevin Deldycke's avatar
Kevin Deldycke committed
217 218 219 220 221 222 223
  """
    Methods below are tools to use the property_map.
  """

  security.declarePrivate('buildConditions')
  def buildConditions(self, object):
    """
224 225 226
      Build a condition dictionnary based on the portal type.
      For example it will returns :
      {'erp5_portal_type':'Agent Privilege'}
Kevin Deldycke's avatar
Kevin Deldycke committed
227 228 229 230 231 232 233 234
    """
    dict = {}
    dict['erp5_portal_type'] = object.getPortalType()
    return dict

  security.declarePrivate('findPropertyMapItem')
  def findPropertyMapItem(self, xml_property_name, conditions):
    """
235
      Find the property_map item that match conditions
236 237 238 239
      It will returns for example :
     { 'xml_property' : 'nom'
      , 'erp5_property': 'first_name'
      , 'conditions'   : {'erp5_portal_type':'Person'} }
Kevin Deldycke's avatar
Kevin Deldycke committed
240
    """
Sebastien Robin's avatar
Sebastien Robin committed
241 242 243 244 245 246 247 248 249
    if property_map.has_key(xml_property_name):
      for item in property_map[xml_property_name]:
        c = item['conditions']
        if type(c) == type([]):
          if conditions in c:
            return item
        else:
          if conditions == c:
            return item
Kevin Deldycke's avatar
Kevin Deldycke committed
250 251 252 253 254 255 256
    return None



  security.declareProtected(Permissions.ModifyPortalContent, 'constructContent')
  def constructContent(self, object, object_id, docid, portal_type):
    """
257 258
      This is a redefinition of the original ERP5Conduit.constructContent function to
      create Baobab objects.
259 260

      This method is in charge to create a new object.
Kevin Deldycke's avatar
Kevin Deldycke committed
261
    """
262
    # Register some path in some variables
263 264 265
    erp5_site_path             = object.absolute_url(relative=1)
    person_module_object       = object.person_module
    organisation_module_object = object.organisation_module
266 267 268

    # Modules below are not always required
    #   (it depends of the nature of objects you want to synchronize)
269
    # So if a module to not exist, we set the value to None
270
    try:    cash_inventory_module = object.cash_inventory_module
271
    except AttributeError: cash_inventory_module = None
272
    try:    bank_account_inventory_module = object.bank_account_inventory_module
273
    except AttributeError: bank_account_inventory_module = None
274
    try:    currency_cash_module = object.currency_cash_module
275
    except AttributeError: currency_cash_module  = None
Kevin Deldycke's avatar
Kevin Deldycke committed
276 277 278

    subobject = None

279 280 281
    # Function to search the parent object where the new content must be construct.
    # Given parameter is the special encoded portal type that represent the path to
    #   the wanted destination.
282
    def findObjectFromSpecialPortalType(special_portal_type,object_id=None):
283
      # The first part or portal type, for example "Mandataire"
Kevin Deldycke's avatar
Kevin Deldycke committed
284
      source_portal_type = special_portal_type.split('_')[0]
Sebastien Robin's avatar
Sebastien Robin committed
285
      # The place where we should build,
286 287 288 289
      # [1:] is used to takes the full list except the first element
      # [::-1] is used in order to reverse the order
      # construction_location will be for example 40/Z000900001
      # (person with id 40 and account with id Z000900001
Kevin Deldycke's avatar
Kevin Deldycke committed
290 291
      construction_location = '/'.join(special_portal_type.split('_')[1:][::-1])
      parent_object = None
292
      for search_folder in ('person_module', 'organisation_module'):
293
        # full path : /person_module/40/Z000900001
Kevin Deldycke's avatar
Kevin Deldycke committed
294
        path = '/' + search_folder + '/' + construction_location
295
        parent_object_path = erp5_site_path + path
Kevin Deldycke's avatar
Kevin Deldycke committed
296
        try:
297
          # Get the object with the path
298
          parent_object = object.restrictedTraverse(parent_object_path)
299 300
          if parent_object is not None:
            break
Yoshinori Okuji's avatar
Yoshinori Okuji committed
301 302
        except ConflictError:
          raise
Kevin Deldycke's avatar
Kevin Deldycke committed
303
        except:
304
          LOG( 'BaobabConduit:'
305
             , 0
Kevin Deldycke's avatar
Kevin Deldycke committed
306 307 308 309
             , "expected %s parent object (%s) not found in %s" % ( source_portal_type
                                                                  , construction_location
                                                                  , search_folder
                                                                  )
310
             )
Kevin Deldycke's avatar
Kevin Deldycke committed
311
      if parent_object == None:
312 313
        LOG( 'BaobabConduit:'
           , 100
Kevin Deldycke's avatar
Kevin Deldycke committed
314
           , "expected %s parent object (%s) not found !" % (source_portal_type, construction_location)
315
           )
Kevin Deldycke's avatar
Kevin Deldycke committed
316
      else:
317 318
        LOG( 'BaobabConduit:'
           , 0
Kevin Deldycke's avatar
Kevin Deldycke committed
319
           , "%s parent object found at %s" % (source_portal_type, parent_object_path)
320
           )
Kevin Deldycke's avatar
Kevin Deldycke committed
321 322
      return parent_object

323
    ### handle client objects
Kevin Deldycke's avatar
Kevin Deldycke committed
324
    if portal_type.startswith('Client'):
325
      # This is a person object
Kevin Deldycke's avatar
Kevin Deldycke committed
326
      if portal_type[-3:] == 'PER':
327 328 329
        subobject = person_module_object.newContent( portal_type = 'Person'
                                                   , id          = object_id
                                                   )
Kevin Deldycke's avatar
Kevin Deldycke committed
330
        subobject.setCareerRole('client')
331 332 333 334 335 336
        # We first try to get the organisation corresponding
        organisation_id = 'site_%s' % object_id[:3]
        organisation = person_module_object.portal_catalog(
                                              portal_type='Organisation',
                                              id=organisation_id
                                              )[0].getObject()
337
        subobject._setCareerSubordinationValue(organisation)
338
      else: # This is an organisation object
339 340
        site_value = organisation_module_object.Baobab_getSiteFromCodification(
                                                       object_id[:3])
341
        subobject = organisation_module_object.newContent( portal_type = 'Organisation'
342 343 344
                                                 , id          = object_id
                                                 , site  = site_value.getRelativeUrl()
                                                 )
Kevin Deldycke's avatar
Kevin Deldycke committed
345 346
        subobject.setRole('client')

347
    ### handle bank account objects
Kevin Deldycke's avatar
Kevin Deldycke committed
348 349 350 351
    elif portal_type.startswith('Compte'):
      owner = findObjectFromSpecialPortalType(portal_type)
      if owner == None: return None
      subobject = owner.newContent( portal_type = 'Bank Account'
352 353
                                  , id          = object_id
                                  )
Kevin Deldycke's avatar
Kevin Deldycke committed
354 355 356
      # set the bank account owner as agent with no-limit privileges (only for persons)
      if owner.getPortalType() == 'Person':
        new_agent = subobject.newContent( portal_type = 'Agent'
357 358
                                        , id          = 'owner'
                                        )
Kevin Deldycke's avatar
Kevin Deldycke committed
359 360 361 362 363 364 365 366 367 368 369 370
        new_agent.setAgent(owner.getRelativeUrl())
        privileges = ( 'circularization'
                     , 'cash_out'
                     , 'withdrawal_and_payment'
                     , 'account_document_view'
                     , 'signature'
                     , 'treasury'
                     )
        for privilege in privileges:
          new_priv = new_agent.newContent(portal_type = 'Agent Privilege')
          new_priv.setAgentPrivilege(privilege)

371
    ### handle agent objects
Kevin Deldycke's avatar
Kevin Deldycke committed
372
    elif portal_type.startswith('Mandataire'):
373
      # Get the person or organisation thanks to the portal_type
374
      dest = findObjectFromSpecialPortalType(portal_type,object_id=object_id)
Kevin Deldycke's avatar
Kevin Deldycke committed
375 376
      if dest == None: return None
      subobject = dest.newContent( portal_type = 'Agent'
377 378
                                 , id          = object_id
                                 )
Kevin Deldycke's avatar
Kevin Deldycke committed
379 380 381
      # try to get the agent in the person module
      person = findObjectFromSpecialPortalType('Person_' + object_id)
      if person == None:
382 383 384
        person = person_module_object.newContent( portal_type = 'Person'
                                                , id          = object_id + 'a'
                                                )
Kevin Deldycke's avatar
Kevin Deldycke committed
385 386
      subobject.setAgent(person.getRelativeUrl())

387
    ### handle privilege objects
Kevin Deldycke's avatar
Kevin Deldycke committed
388
    elif portal_type.startswith('Pouvoir'):
389
      # Get the person or organisation thanks to the portal_type
Kevin Deldycke's avatar
Kevin Deldycke committed
390 391 392
      dest = findObjectFromSpecialPortalType(portal_type)
      if dest == None: return None
      subobject = dest.newContent( portal_type = 'Agent Privilege'
393 394 395
                                 , id          = object_id
                                 )

396
    ### handle inventory objects
397 398
    elif portal_type == 'Cash Inventory':
      if cash_inventory_module == None: return None
399
      subobject = cash_inventory_module.newContent( portal_type = 'Cash Inventory Group'
400 401 402
                                                  , id          = object_id
                                                  )

403
    ### handle inventory details objects
404
    elif portal_type == 'Cash Inventory Detail':
405
      if currency_cash_module == None: return None
406
      # get currency and vault informations by analizing the id
407
      id_items = object_id.split('_')
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
      if len(id_items) != 5:
        LOG( 'BaobabConduit:'
           , 100
           , "Cash Inventory Detail object has a wrong id (%s) !" % (object_id)
           )
        return None
      cell_id        = id_items[0]
      agency_code    = id_items[1]
      inventory_code = id_items[2]
      vault_code     = id_items[3]
      currency_id    = id_items[4]
      # get the path to the vault_code
      vault_path = self.getVaultPathFromCodification( object         = object
                                                    , agency_code    = agency_code
                                                    , inventory_code = inventory_code
                                                    , vault_code     = vault_code
424
                                                    , currency_id    = currency_id
425 426 427 428 429 430
                                                    )
      if vault_path in (None, ''):
        LOG( 'BaobabConduit:'
           , 100
           , "can't find a path to the vault '%s/%s/%s' !" % (agency_code, inventory_code, vault_code)
           )
431
        return None
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
      # try to find an existing inventory with the same price currency and vault
      inventory_list = object.contentValues(filter={'portal_type': 'Cash Inventory'})
      new_inventory = None
      for inventory in inventory_list:
        inventory_currency = inventory.getPriceCurrencyId()
        inventory_vault    = inventory.getDestination()
        if inventory_currency not in (None, '') and \
           inventory_vault    not in (None, '') and \
           inventory_currency == currency_id    and \
           inventory_vault    == vault_path     :
          new_inventory = inventory
          LOG( 'BaobabConduit:'
             , 0
             , "previous Cash Inventory found (%s) !" % (repr(new_inventory))
             )
          break
      # no previous inventory found, create one
      if new_inventory == None:
        new_inventory = object.newContent(portal_type = 'Cash Inventory')
Kevin Deldycke's avatar
Kevin Deldycke committed
451
        new_inventory.setPriceCurrency('currency_module/' + currency_id)
452 453 454
        new_inventory.setDestination(vault_path)
      subobject = new_inventory

455 456 457 458 459 460 461 462 463 464 465 466 467
    ### handle bank account inventory objects
    elif portal_type == 'Bank Account Inventory':
      if bank_account_inventory_module == None: return None
      subobject = bank_account_inventory_module.newContent( portal_type = 'Bank Account Inventory'
                                                          , id          = object_id
                                                          )

    ### handle bank account inventory line objects
    elif portal_type == 'Bank Account Inventory Line':
      subobject = object.newContent( portal_type = 'Bank Account Inventory Line'
                                   , id          = object_id
                                   )

468 469
    if subobject.getPortalType() == 'Person':
      subobject.updateLocalRolesOnSecurityGroups()
470 471 472
    return subobject


473

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
  security.declareProtected(Permissions.ModifyPortalContent, 'editDocument')
  def editDocument(self, object=None, **kw):
    """
      This function transfer datas from the dictionary to the baobab document
      object given in parameters.
    """

    if object == None: return

    ### Cash Inventory objects needs two properties to generate the vault path
    if object.getPortalType() == 'Cash Inventory Group':
      vault_path = self.getVaultPathFromCodification( object         = object
                                                    , agency_code    = kw['agency_code']
                                                    , inventory_code = kw['inventory_code']
                                                    )
      object.setDestination(vault_path)

    ### Cash Inventory Detail objects needs all properties to create and update the cell matrix
492
    # This part is only usefull for cash inventory, it is not used for most portal types
493
    if object.getPortalType() == 'Cash Inventory':
494
      # Make sure all variables will be defined
495 496 497 498 499 500 501 502 503 504 505 506
      quantity      = None
      cell_id       = None
      resource_type = None
      base_price    = None
      currency_name = None
      for k,v in kw.items():
        if k == 'quantity'     : quantity      = float(v)
        if k == 'cell_id'      : cell_id       = v
        if k == 'currency_type': resource_type = v
        if k == 'price'        : base_price    = float(v)
        if k == 'currency'     : currency_name = v
      # try to find an existing line with the same resource as the current cell
507 508 509 510 511
      if resource_type in ['BIL']:
        currency_portal_type = 'Banknote'
      elif resource_type in ['MON']:
        currency_portal_type = 'Coin'
      else:
512 513 514 515
        LOG( 'BaobabConduit:'
           , 100
           , "Cash Inventory Detail resource type can't be guess (%s) !" % (resource_type)
           )
516 517 518
        return None
      # get the list of existing currency to find the currency of the line
      line_currency_cash = None
519
      currency_cash_list = object.currency_cash_module.contentValues(filter={'portal_type': currency_portal_type})
520
      for currency_cash in currency_cash_list:
521 522
        # Check the price_currency_id and the base price to make sure
        # we have the right currency
523 524 525 526
        if base_price    not in (None, '')                    and \
           currency_name not in (None, '')                    and \
           currency_cash.getBasePrice()       == base_price   and \
           currency_cash.getPriceCurrencyId() == currency_name:
527 528 529 530 531
          if currency_portal_type == 'Coin' and kw.get('variation', None) == 'ANC' and \
             not currency_cash.getFormer():
            # If we are searching for an 'ANC' variation of a coin, getFormer
            # must be true for the currency cash to match.
            continue
532 533
          line_currency_cash = currency_cash
          break
534 535
      # no currency found
      if line_currency_cash == None:
536 537 538 539
        LOG( 'BaobabConduit:'
           , 100
           , "Currency '%s %s' not found for the Cash Inventory Detail !" % (base_price, currency_name)
           )
540
        return None
541
      # We are looking for an existing line
542 543 544
      inventory_lines = object.contentValues(filter={'portal_type': 'Cash Inventory Line'})
      new_line = None
      for line in inventory_lines:
545 546 547
        # getResourceValue returns the currency_cash, so if it is
        # equivalent to the currency_cash we have found, then we can
        # update the line
548 549 550 551 552
        if line.getResourceValue() == line_currency_cash:
          new_line = line
          break
      # no previous line found, create one
      if new_line == None:
553
        new_line = object.newContent(portal_type = 'Cash Inventory Line')
554 555
        new_line.setResourceValue(line_currency_cash)
        new_line.setPrice(line_currency_cash.getBasePrice())
556
      # get matrix variation values
557
      category_list = []
558
      # This is the 3 variation axes of the matrix
559 560 561 562 563 564 565
      base_cat_map = { 'variation'  : 'variation'
                     , 'letter_code': 'emission_letter'
                     , 'status_code': 'cash_status'
                     }
      for base_key in base_cat_map.keys():
        if base_key in kw.keys() and kw[base_key] not in ('', None):
          if base_key == 'status_code':
566 567
            category = self.status_code_to_cash_status[kw[base_key]]
          elif base_key == 'variation':
568 569
            if currency_portal_type == 'Banknote': # Variation is set only for Banknotes.
              category = self.variation_translate_dict.get(kw[base_key], kw[base_key])
570 571 572 573
          else:
            category = kw[base_key]
        else:
          category = 'not_defined'
574
        # We must have at least a category for each axis
575
        category_list.append(base_cat_map[base_key] + '/' + category)
576 577
      # update the matrix with this cell
      self.updateCashInventoryMatrix( line               = new_line
578 579
                                    , cell_category_list = category_list
                                    , quantity           = quantity
580
                                    , cell_uid           = cell_id
581 582
                                    )

583
    ### Bank Account Inventory Line objects needs two properties to get the right bank account object
584
    # This part is only usefull for bank account inventory line, it is not used for most portal types
585
    if object.getPortalType() == 'Bank Account Inventory Line':
586
      # Make sure variables will be defined
587 588 589 590 591 592 593 594
      currency_id         = None
      bank_account_number = None
      for k,v in kw.items():
        if k == 'currency'      : currency_id         = v
        if k == 'account_number': bank_account_number = v
      # try to find the bank account
      if bank_account_number != None:
        bank_account_object = None
595 596 597 598 599
        # We use here the catalog in order to find very quickly
        # all bank with a particular reference, so most of the time
        # we should get only 1 bank account
        bank_account_list = [x.getObject() for x in object.portal_catalog(
                               portal_type=('Bank Account'),
600
                               )]
601 602
        # Make sure we have found the right bank account
        for bank_account in bank_account_list:
603
           if bank_account.getInternalBankAccountNumber() == bank_account_number:
604 605
             bank_account_object = bank_account
             break
606
        if bank_account_object != None:
607
          # Se the right account on the inventory line
608
          object.setDestinationValue(bank_account_object)
609
          object.setDestinationPaymentValue(bank_account_object)
610 611 612
          if currency_id != None:
            # verify or add the currency
            current_currency_id = bank_account_object.getPriceCurrencyId()
613
            # Make sure that the bank account will have a currency defined
614
            if current_currency_id in (None, ''):
Kevin Deldycke's avatar
Kevin Deldycke committed
615
              bank_account_object.setPriceCurrency('currency_module/' + currency_id)
616 617 618
            elif current_currency_id != currency_id:
              LOG( 'BaobabConduit inconsistency:'
                 , 200
619
                 , 'found bank account has not the expected currency (%s in stead of %s)' % (current_currency_id, currency_id)
620
                 )
621 622 623 624 625
        else:
            LOG( 'BaobabConduit inconsistency:'
               , 200
               , 'no bank account found'
               )
626
            raise KeyError, 'No bank account Found'
627

628 629 630 631 632 633 634 635 636

    """
      Here we use 2 generic way to update object properties :
        1. We try to use the property_map mapping to migrate a value from a property
             to another;
        2. If the latter fail, we try to find a method with a pre-defined name in
             this script to handle the value.
    """

Kevin Deldycke's avatar
Kevin Deldycke committed
637 638 639 640 641 642
    # Set properties of the destination baobab object
    for k,v in kw.items():
      # Try to find a translation rule in the property_map
      cond = self.buildConditions(object)
      map_item = self.findPropertyMapItem(k, cond)

643 644
      ### There is a translation rule, so call the right setProperty() method
      if map_item != None:
645
        # The method id can be for example 'setTitle'
Kevin Deldycke's avatar
Kevin Deldycke committed
646
        method_id = "set" + convertToUpperCase(map_item['erp5_property'])
647 648 649 650
        LOG( 'BaobabConduit:'
           , 0
           , "try to call object method %s on %s" % (repr(method_id), repr(object))
           )
Kevin Deldycke's avatar
Kevin Deldycke committed
651
        if v not in ('', None):
652
           # We look if the method exist
Kevin Deldycke's avatar
Kevin Deldycke committed
653
          if hasattr(object, method_id):
654
            # get the method itself
Kevin Deldycke's avatar
Kevin Deldycke committed
655
            method = getattr(object, method_id)
656
            # This call the method, this exactly the same thing
Sebastien Robin's avatar
Sebastien Robin committed
657
            # as calling directly : object.setTitle(v)
Kevin Deldycke's avatar
Kevin Deldycke committed
658 659
            method(v)
          else:
660 661 662 663 664 665 666
            LOG( 'BaobabConduit:'
               , 100
               , 'property map item don\'t match object properties'
               )

      ### No translation rule found, try to find a hard-coded translation method in the conduit
      else:
667 668 669 670 671 672 673
        # The method is generated with the type of the document and with the
        # name of the property. If the type of the document is 'Client' and the
        # property is nature_economique, then it will try to find a method
        # defined in this conduit 'editClientNatureEconomique'. This is very
        # usefull if we must do some particular conversion or some calculation
        # before editing an object. This is used when there is no simple
        # equivalent between sql table and ERP5.
674
        method_id = "edit%s%s" % (kw['type'].replace(' ', ''), convertToUpperCase(k))
675 676 677 678
        #LOG( 'BaobabConduit:'
        #   , 0
        #   , "try to call conduit method %s on %s" % (repr(method_id), repr(object))
        #   )
679 680
        if v not in ('', None):
          if hasattr(self, method_id):
681
            # get the method itself
682
            method = getattr(self, method_id)
683
            # This call the method, this exactly the same thing
Sebastien Robin's avatar
Sebastien Robin committed
684
            # as calling directly : self.editClientNatureEconomique(object,v)
685
            method(object, v)
686 687 688 689 690
          #else:
          #  LOG( 'BaobabConduit:'
          #     , 100
          #     , "there is no method to handle <%s>%s</%s> data" % (k,repr(v),k)
          #     )
691

Kevin Deldycke's avatar
Kevin Deldycke committed
692

693 694 695
    if object.getPortalType() == 'Bank Account':
      object.portal_workflow.doActionFor(object, 'validate_action', 
                                         wf_id='bank_account_workflow')
Kevin Deldycke's avatar
Kevin Deldycke committed
696 697 698


  """
699 700 701 702
    All functions below are defined to set a document's property to a value
    given in parameters.
    The name of those functions are chosen to help the transfert of datas
    from a given XML format to standard Baobab objects.
Kevin Deldycke's avatar
Kevin Deldycke committed
703 704
  """

705 706
  ### Client-related-properties functions

Kevin Deldycke's avatar
Kevin Deldycke committed
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
  def editClientCategorie(self, document, value):
    if document.getPortalType() == 'Organisation':
      id_table = { 'BIF': 'institution/world/bank'
                 , 'PFR': 'institution/world/institution'
                 , 'ICU': 'institution/local/common'
                 , 'BET': 'institution/local/institution'
                 , 'ETF': 'institution/local/bank'
                 , 'BTR': 'treasury/national'
                 , 'ORP': 'treasury/other'
                 , 'ORI': 'organism/international'
                 , 'ORR': 'organism/local'
                 , 'COR': 'intermediaries'
                 , 'DIV': 'depositories/various'
                 , 'DER': 'depositories/savings'
                 , 'DAU': 'depositories/other'
                 }
723
      #document.setActivity('banking_finance/' + id_table[value])
724
      document.setActivity(value)
Kevin Deldycke's avatar
Kevin Deldycke committed
725
    else:
726
      LOG('BaobabConduit:', 0, 'Person\'s category ignored')
Kevin Deldycke's avatar
Kevin Deldycke committed
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742

  def editClientNatureEconomique(self, document, value):
    if document.getPortalType() == 'Organisation':
      # build the economical class category path
      c = ''
      path = ''
      for i in value[1:]:
        c += i
        if c == '13':
          path += '/S13'
          if value != 'S13':
            path += '/' + value
          break
        path += '/S' + c
      document.setEconomicalClass(path)
    else:
743 744 745 746
      LOG( 'BaobabConduit inconsistency:'
         , 200
         , 'a non-Organisation client can\'t have an economical class'
         )
Kevin Deldycke's avatar
Kevin Deldycke committed
747 748

  def editClientSituationMatrimoniale(self, document, value):
749 750 751 752
    """
    Here we can convert data from sql to data in ERP5 thanks
    to a simple dictionnary: the id_table.
    """
Kevin Deldycke's avatar
Kevin Deldycke committed
753 754 755 756 757 758 759 760
    if document.getPortalType() == 'Person':
      id_table = { 'VEU' : 'widowed'
                 , 'DIV' : 'divorced'
                 , 'MAR' : 'married'
                 , 'CEL' : 'never_married'
                 }
      document.setMaritalStatus(id_table[value])
    else:
761 762 763 764
      LOG( 'BaobabConduit inconsistency:'
         , 200
         , 'a non-Person client can\'t have a marital status'
         )
Kevin Deldycke's avatar
Kevin Deldycke committed
765

Sebastien Robin's avatar
Sebastien Robin committed
766 767
  def editClientCode(self, document, value):
    pass
Sebastien Robin's avatar
Sebastien Robin committed
768 769


Kevin Deldycke's avatar
Kevin Deldycke committed
770 771


772 773
  ### BankAccount-related-properties functions

Kevin Deldycke's avatar
Kevin Deldycke committed
774
  def editCompteDevise(self, document, value):
775
    # Convert compte_devise to price_currency
Kevin Deldycke's avatar
Kevin Deldycke committed
776
    document.setPriceCurrency('currency_module/' + value)
Kevin Deldycke's avatar
Kevin Deldycke committed
777

778 779 780 781 782 783 784 785 786 787 788 789
  def editCompteOverdraftFacility(self, document, value):
    new_value = False
    if value=='O':
      new_value = True
    document.setOverdraftFacility(new_value)

  def editCompteSwiftRegistered(self, document, value):
    new_value = False
    if value=='O':
      new_value = True
    document.setSwiftRegistered(new_value)

Kevin Deldycke's avatar
Kevin Deldycke committed
790
  def editCompteDateOuverture(self, document, value):
791
    # Convert date_ouverture to start_date and stop_date
Kevin Deldycke's avatar
Kevin Deldycke committed
792 793 794 795 796
    if document.getStopDate() in ('', None):
      document.setStopDate(str(datetime.datetime.max))
    document.setStartDate(value)

  def editCompteDateFermeture(self, document, value):
797
    # Convert date_firemeture to start_date and stop_date
Kevin Deldycke's avatar
Kevin Deldycke committed
798 799 800 801
    if document.getStartDate() in ('', None):
      document.setStartDate(str(datetime.datetime.min))
    document.setStopDate(value)

802 803
  ### Agent-related-properties functions

Kevin Deldycke's avatar
Kevin Deldycke committed
804
  def editMandataireNom(self, document, value):
805
    # Convert mandataire_nom to first_name
Kevin Deldycke's avatar
Kevin Deldycke committed
806 807 808
    old_value = document.getAgentValue().getFirstName()
    new_value = value
    if old_value != new_value:
809 810 811 812
      LOG( 'BaobabConduit:'
         , 200
         , 'old value of agent first name (%s) was replaced by a new one (%s)' % (old_value, new_value)
         )
Kevin Deldycke's avatar
Kevin Deldycke committed
813 814 815
      document.getAgentValue().setFirstName(new_value)

  def editMandatairePrenom(self, document, value):
816
    # Convert mandataire_prenom to last_name
Kevin Deldycke's avatar
Kevin Deldycke committed
817 818 819
    old_value = document.getAgentValue().getLastName()
    new_value = value
    if old_value != new_value:
820 821 822 823
      LOG( 'BaobabConduit:'
         , 200
         , 'old value of agent last name (%s) was replaced by a new one (%s)' % (old_value, new_value)
         )
Kevin Deldycke's avatar
Kevin Deldycke committed
824 825 826
      document.getAgentValue().setLastName(new_value)

  def editMandataireService(self, document, value):
827
    # Convert mandataire_service to an assignment
Kevin Deldycke's avatar
Kevin Deldycke committed
828
    assignment = document.getAgentValue().newContent( portal_type = 'Assignment'
829 830
                                                    , id          = 'service'
                                                    )
Kevin Deldycke's avatar
Kevin Deldycke committed
831 832 833 834
    assignment.setGroup(value)
    return

  def editMandataireFonction(self, document, value):
835
    # Convert mandataire_function to a career grade
836
    document.getAgentValue().setCareerGrade(value)
Kevin Deldycke's avatar
Kevin Deldycke committed
837 838 839
    return

  def editMandataireTelephone(self, document, value):
840
    # Convert mandataire_telephone to default_telephone_number
Kevin Deldycke's avatar
Kevin Deldycke committed
841 842 843
    old_value = document.getAgentValue().getDefaultTelephoneNumber()
    new_value = value
    if old_value != new_value:
844 845 846 847
      LOG( 'BaobabConduit:'
         , 200
         , "old value of agent's telephone (%s) was replaced by a new one (%s)" % (old_value, new_value)
         )
Kevin Deldycke's avatar
Kevin Deldycke committed
848 849 850
      document.getAgentValue().setDefaultTelephoneNumber(new_value)

  def editMandataireDateCreation(self, document, value):
851
    # Convert mandataire_date_creation to stop_date and start_date
Kevin Deldycke's avatar
Kevin Deldycke committed
852 853 854 855 856 857
    if document.getStopDate() in ('', None):
      document.setStopDate(str(datetime.datetime.max))
    document.setStartDate(value)



858 859
  ### AgentPrivilege-related-properties functions

Kevin Deldycke's avatar
Kevin Deldycke committed
860
  def editPouvoirCategorie(self, document, value):
861
    # Convert pouvoir_categorie to agent_privilege property
Kevin Deldycke's avatar
Kevin Deldycke committed
862 863 864 865 866 867 868 869 870 871 872
    id_table = { 'COM' : 'clearing'
               , 'CIR' : 'circularization'
               , 'REM' : 'cash_out'
               , 'RET' : 'withdrawal_and_payment'
               , 'RTE' : 'account_document_view'
               , 'SIG' : 'signature'
               , 'TRE' : 'treasury'
               }
    document.setAgentPrivilege(id_table[value])

  def editPouvoirDateDebut(self, document, value):
873
    # Convert pouvoir_date_debut to start_date and stop_date properties
Kevin Deldycke's avatar
Kevin Deldycke committed
874 875 876 877 878
    if document.getStopDate() in ('', None):
      document.setStopDate(str(datetime.datetime.max))
    document.setStartDate(value)

  def editPouvoirDateFin(self, document, value):
879
    # Convert pouvoir_date_fin to start_date and stop_date properties
Kevin Deldycke's avatar
Kevin Deldycke committed
880 881
    if document.getStartDate() in ('', None):
      document.setStartDate(str(datetime.datetime.min))
882 883 884 885
    document.setStopDate(value)



886 887
  ### CashInventory-related-properties functions

888
  def editCashInventoryInventoryDate(self, document, value):
889
    # Convert cash_inventory_inventory_date to stop_date property
890 891 892 893 894 895 896 897 898
    if value in ('', None):
      date = str(datetime.datetime.max)
    else:
      # Convert french date to strandard date
      date_items = value.split('/')
      day   = date_items[0]
      month = date_items[1]
      year  = date_items[2]
      date  = '/'.join([year, month, day])
899 900
    document.setStopDate(date)

901
  def getVaultPathFromCodification( self, object, agency_code=None, inventory_code=None, vault_code=None, currency_id=None):
902
    """
903 904 905 906 907 908
      Recompose category path from agency_code, inventory_code and vault_code.
      agency_code    : site's codification
      inventory_code : relative path common to all vaults for a given
                       inventory
      vault_code     : relative path specific to a given vault in a given
                       inventory
909
    """
910
    if agency_code is None:
911
      return None
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
    portal = object.getPortalObject()
    resolveCategory = portal.portal_categories.resolveCategory
    site_list = portal.Delivery_getVaultItemList(vault_type=('site',),
                                                 strict_membership=1,
                                                 leaf_node=0,
                                                 user_site=0,
                                                 with_base=1)[1:]
    agency_dict = dict([(resolveCategory(path).getCodification(), path) \
                        for (title, path) in site_list])
    agency_path = agency_dict.get(agency_code)
    result_list = []
    if agency_path is not None:
      result_list.append(agency_path)
      inventory_path = self.inventory_code_to_path.get(inventory_code)
      if inventory_path is not None:
        result_list.append(inventory_path)
        vault_path = self.vault_code_to_path.get(vault_code)
        if vault_path is not None:
          result_list.append(vault_path)
        elif vault_code is not None:
          raise ValueError, '%s is not a known vault import codification' % (vault_code, )
      elif inventory_code is not None:
        raise ValueError, '%s is not a known inventory import codification' % (inventory_code, )
    if len(result_list) == 0:
      return None
    return '/'.join(result_list)
     
939
  ### CashInventoryDetail-related-properties functions
940

941
  def updateCashInventoryMatrix(self, line, cell_category_list, quantity, cell_uid):
942
    base_id = 'movement'
943
    base_category_list = [ 'emission_letter'
944
                         , 'variation'
945
                         , 'cash_status'
946
                         ]
947 948 949 950 951 952 953 954 955 956

    old_line_category_list   = line.getVariationCategoryList()
    messy_line_category_list = cell_category_list + old_line_category_list

    sorted_line_base_category_list = []
    sorted_line_category_list = []
    sorted_cell_category_list = []
    sorted_cell_range = []

    # cell_category_list must have the same base category order of cell_range base category
957
    for base_category in base_category_list:
958 959 960 961 962 963 964

      # generate the sorted line categories
      for category in messy_line_category_list:
        if category.startswith(base_category + '/') and category not in sorted_line_category_list:
          sorted_line_category_list.append(category)

      # generate the sorted cell range
965
      base_group = []
966
      for category in messy_line_category_list:
967 968
        if category.startswith(base_category + '/') and category not in base_group:
          base_group.append(category)
969 970
      sorted_cell_range.append(base_group)
      # generate the sorted base category
971
      if len(base_group) > 0:
972 973 974 975 976 977 978 979 980 981 982
        sorted_line_base_category_list.append(base_category)

      # generate the sorted cell variation categories
      for category in cell_category_list:
        if category.startswith(base_category + '/') and category not in sorted_cell_category_list:
          sorted_cell_category_list.append(category)

    # update line variation categories
    line.setVariationBaseCategoryList(sorted_line_base_category_list)
    line.setVariationCategoryList(sorted_line_category_list)
    line.setCellRange(base_id = base_id, *sorted_cell_range)
983 984 985 986
    # create the cell
    kwd = { 'base_id'    : base_id
          , 'portal_type': 'Cash Inventory Cell'
          }
987
    new_cell = line.newCell(*sorted_cell_category_list, **kwd)
988 989 990
    new_cell.edit( mapped_value_property_list         = ('price', 'inventory')
                 , force_update                       = 1
                 , inventory                          = quantity
991 992
                 , membership_criterion_category_list = sorted_cell_category_list
                 , category_list                      = sorted_cell_category_list
993
                 , title                              = cell_uid
994 995 996 997 998 999 1000
                 )



  ### BankAccountInventory-related-properties functions

  def editBankAccountInventoryAgencyCode(self, document, value):
1001
    # Convert bank_account_inventory_agency_code to a destination
1002 1003 1004 1005 1006 1007
    agency_path = self.getVaultPathFromCodification( object      = document
                                                   , agency_code = value
                                                   )
    document.setDestination(agency_path)

  def editBankAccountInventoryDate(self, document, value):
1008
    # Convert bank_account_inventory_date to stop_date property
1009 1010 1011 1012 1013 1014 1015 1016 1017
    if value in ('', None):
      date = str(datetime.datetime.max)
    else:
      # Convert french date to strandard date
      date_items = value.split('/')
      day   = date_items[0]
      month = date_items[1]
      year  = date_items[2]
      date  = '/'.join([year, month, day])
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1018
    document.setStopDate(date)
Sebastien Robin's avatar
Sebastien Robin committed
1019

1020 1021 1022 1023 1024
  def editBankAccountInventoryLineCurrency(self, document, value):
    # Convert bank_account_inventory_date to stop_date property
    resource_url = 'currency_module/%s' % value
    resource_value = document.getPortalObject().restrictedTraverse(resource_url)
    document.setResourceValue(resource_value)
1025 1026 1027 1028 1029 1030 1031

  def newObject(self, object=None, xml=None, simulate=0, reset_local_roles=0):
    """
    define it here in order to make sure to not delete security
    """
    ERP5Conduit.newObject(self, object=object, xml=xml, simulate=simulate,
                          reset_local_roles=reset_local_roles)