addons/document/document_directory.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 base64
  23
  24 from osv import osv, fields
  25 from osv.orm import except_orm
  26 import urlparse
  27
  28 import os
  29 import nodes
  30 from tools.translate import _
  31
  32 class document_directory(osv.osv):
  33     _name = 'document.directory'
  34     _description = 'Directory'
  35     _order = 'name desc'
  36     _columns = {
  37         'name': fields.char('Name', size=64, required=True, select=1),
  38         'write_date': fields.datetime('Date Modified', readonly=True),
  39         'write_uid':  fields.many2one('res.users', 'Last Modification User', readonly=True),
  40         'create_date': fields.datetime('Date Created', readonly=True),
  41         'create_uid':  fields.many2one('res.users', 'Creator', readonly=True),
  42         'domain': fields.char('Domain', size=128, help="Use a domain if you want to apply an automatic filter on visible resources."),
  43         'user_id': fields.many2one('res.users', 'Owner'),
  44         'storage_id': fields.many2one('document.storage', 'Storage'),
  45         'group_ids': fields.many2many('res.groups', 'document_directory_group_rel', 'item_id', 'group_id', 'Groups'),
  46         'parent_id': fields.many2one('document.directory', 'Parent Directory', select=1),
  47         'child_ids': fields.one2many('document.directory', 'parent_id', 'Children'),
  48         'file_ids': fields.one2many('ir.attachment', 'parent_id', 'Files'),
  49         'content_ids': fields.one2many('document.directory.content', 'directory_id', 'Virtual Files'),
  50         'type': fields.selection([
  51             ('directory','Static Directory'),
  52             ('ressource','Folders per resource'),
  53             ],
  54             'Type', required=True, select=1,
  55             help="Defines directory's behaviour."),
  56
  57         'ressource_type_id': fields.many2one('ir.model', 'Resource model',
  58             help="Select an object here and there will be one folder per record of that resource."),
  59         'resource_field': fields.many2one('ir.model.fields', 'Name field', help='Field to be used as name on resource directories. If empty, the "name" will be used.'),
  60         'ressource_parent_type_id': fields.many2one('ir.model', 'Parent Model',
  61             help="If you put an object here, this directory template will appear bellow all of these objects. " \
  62                  "Don't put a parent directory if you select a parent model."),
  63         'ressource_id': fields.integer('Resource ID'),
  64         'ressource_tree': fields.boolean('Tree Structure',
  65             help="Check this if you want to use the same tree structure as the object selected in the system."),
  66         'dctx_ids': fields.one2many('document.directory.dctx', 'dir_id', 'Context fields'),
  67         'company_id': fields.many2one('res.company', 'Company'),
  68     }
  69
  70
  71     def _get_root_directory(self, cr,uid, context=None):
  72         objid=self.pool.get('ir.model.data')
  73         try:
  74             mid = objid._get_id(cr, uid, 'document', 'dir_root')
  75             if not mid:
  76                 return False
  77             root_id = objid.read(cr, uid, mid, ['res_id'])['res_id']
  78             return root_id
  79         except Exception, e:
  80             import netsvc
  81             logger = netsvc.Logger()
  82             logger.notifyChannel("document", netsvc.LOG_WARNING, 'Cannot set directory root:'+ str(e))
  83             return False
  84         return objid.browse(cr, uid, mid, context=context).res_id
  85
  86     def _get_def_storage(self, cr, uid, context=None):
  87         if context and context.has_key('default_parent_id'):
  88                 # Use the same storage as the parent..
  89                 diro = self.browse(cr, uid, context['default_parent_id'])
  90                 if diro.storage_id:
  91                         return diro.storage_id.id
  92         objid=self.pool.get('ir.model.data')
  93         try:
  94                 mid =  objid._get_id(cr, uid, 'document', 'storage_default')
  95                 return objid.browse(cr, uid, mid, context=context).res_id
  96         except Exception:
  97                 return None
  98
  99     _defaults = {
 100         'company_id': lambda s,cr,uid,c: s.pool.get('res.company')._company_default_get(cr, uid, 'document.directory', context=c),
 101         'user_id': lambda self,cr,uid,ctx: uid,
 102         'domain': lambda self,cr,uid,ctx: '[]',
 103         'type': lambda *args: 'directory',
 104         'ressource_id': lambda *a: 0,
 105         'storage_id': _get_def_storage,
 106     }
 107     _sql_constraints = [
 108         ('dirname_uniq', 'unique (name,parent_id,ressource_id,ressource_parent_type_id)', 'The directory name must be unique !'),
 109         ('no_selfparent', 'check(parent_id <> id)', 'Directory cannot be parent of itself!'),
 110         ('dir_parented', 'check(parent_id IS NOT NULL OR storage_id IS NOT NULL)', 'Directory must have a parent or a storage')
 111     ]
 112     def name_get(self, cr, uid, ids, context={}):
 113         res = []
 114         if not self.search(cr,uid,[('id','in',ids)]):
 115             ids = []
 116         for d in self.browse(cr, uid, ids, context=context):
 117             s = ''
 118             d2 = d
 119             while d2 and d2.parent_id:
 120                 s = d2.name + (s and ('/' + s) or '')
 121                 d2 = d2.parent_id
 122             res.append((d.id, s or d.name))
 123         return res
 124
 125     def get_full_path(self, cr, uid, dir_id, context=None):
 126         """ Return the full path to this directory, in a list, root first
 127         """
 128         def _parent(dir_id, path):
 129             parent=self.browse(cr, uid, dir_id)
 130             if parent.parent_id and not parent.ressource_parent_type_id:
 131                 _parent(parent.parent_id.id,path)
 132                 path.append(parent.name)
 133             else:
 134                 path.append(parent.name)
 135                 return path
 136         path = []
 137         _parent(dir_id, path)
 138         return path
 139
 140     def ol_get_resource_path(self, cr, uid, dir_id, res_model, res_id):
 141         # this method will be used in process module
 142         # to be need test and Improvement if resource dir has parent resource (link resource)
 143         path=[]
 144         def _parent(dir_id,path):
 145             parent=self.browse(cr, uid, dir_id)
 146             if parent.parent_id and not parent.ressource_parent_type_id:
 147                 _parent(parent.parent_id.id,path)
 148                 path.append(parent.name)
 149             else:
 150                 path.append(parent.name)
 151                 return path
 152
 153         directory=self.browse(cr,uid,dir_id)
 154         model_ids=self.pool.get('ir.model').search(cr, uid, [('model','=',res_model)])
 155         if directory:
 156             _parent(dir_id,path)
 157             path.append(self.pool.get(directory.ressource_type_id.model).browse(cr, uid, res_id).name)
 158             #user=self.pool.get('res.users').browse(cr,uid,uid)
 159             #return "ftp://%s:%s@localhost:%s/%s/%s"%(user.login,user.password,config.get('ftp_server_port',8021),cr.dbname,'/'.join(path))
 160             # No way we will return the password!
 161             return "ftp://user:pass@host:port/test/this"
 162         return False
 163
 164     def _check_recursion(self, cr, uid, ids):
 165         level = 100
 166         while len(ids):
 167             cr.execute('select distinct parent_id from document_directory where id in ('+','.join(map(str,ids))+')')
 168             ids = filter(None, map(lambda x:x[0], cr.fetchall()))
 169             if not level:
 170                 return False
 171             level -= 1
 172         return True
 173
 174     _constraints = [
 175         (_check_recursion, 'Error! You can not create recursive Directories.', ['parent_id'])
 176     ]
 177     def __init__(self, *args, **kwargs):
 178         res = super(document_directory, self).__init__(*args, **kwargs)
 179         #self._cache = {}
 180
 181     def onchange_content_id(self, cr, uid, ids, ressource_type_id):
 182         return {}
 183
 184     """
 185         PRE:
 186             uri: of the form "Sales Order/SO001"
 187         PORT:
 188             uri
 189             object: the object.directory or object.directory.content
 190             object2: the other object linked (if object.directory.content)
 191     """
 192     def get_object(self, cr, uid, uri, context=None):
 193         """ Return a node object for the given uri.
 194            This fn merely passes the call to node_context
 195         """
 196         if not context:
 197                 context = {}
 198
 199         return nodes.get_node_context(cr, uid, context).get_uri(cr, uri)
 200
 201
 202     def _locate_child(self, cr, uid, root_id, uri,nparent, ncontext):
 203         """ try to locate the node in uri,
 204             Return a tuple (node_dir, remaining_path)
 205         """
 206         return (nodes.node_database(context=ncontext), uri)
 207
 208     def old_code():
 209         if not uri:
 210             return node_database(cr, uid, context=context)
 211         turi = tuple(uri)
 212         node = node_class(cr, uid, '/', False, context=context, type='database')
 213         for path in uri[:]:
 214             if path:
 215                 node = node.child(path)
 216                 if not node:
 217                     return False
 218         oo = node.object and (node.object._name, node.object.id) or False
 219         oo2 = node.object2 and (node.object2._name, node.object2.id) or False
 220         return node
 221
 222     def ol_get_childs(self, cr, uid, uri, context={}):
 223         node = self.get_object(cr, uid, uri, context)
 224         if uri:
 225             children = node.children()
 226         else:
 227             children= [node]
 228         result = map(lambda node: node.path_get(), children)
 229         return result
 230
 231     def copy(self, cr, uid, id, default=None, context=None):
 232         if not default:
 233             default ={}
 234         name = self.read(cr, uid, [id])[0]['name']
 235         default.update({'name': name+ " (copy)"})
 236         return super(document_directory,self).copy(cr, uid, id, default, context)
 237
 238     def _check_duplication(self, cr, uid, vals, ids=[], op='create'):
 239         name=vals.get('name',False)
 240         parent_id=vals.get('parent_id',False)
 241         ressource_parent_type_id=vals.get('ressource_parent_type_id',False)
 242         ressource_id=vals.get('ressource_id',0)
 243         if op=='write':
 244             for directory in self.browse(cr, uid, ids):
 245                 if not name:
 246                     name=directory.name
 247                 if not parent_id:
 248                     parent_id=directory.parent_id and directory.parent_id.id or False
 249                 if not ressource_parent_type_id:
 250                     ressource_parent_type_id=directory.ressource_parent_type_id and directory.ressource_parent_type_id.id or False
 251                 if not ressource_id:
 252                     ressource_id=directory.ressource_id and directory.ressource_id or 0
 253                 res=self.search(cr,uid,[('id','<>',directory.id),('name','=',name),('parent_id','=',parent_id),('ressource_parent_type_id','=',ressource_parent_type_id),('ressource_id','=',ressource_id)])
 254                 if len(res):
 255                     return False
 256         if op=='create':
 257             res=self.search(cr,uid,[('name','=',name),('parent_id','=',parent_id),('ressource_parent_type_id','=',ressource_parent_type_id),('ressource_id','=',ressource_id)])
 258             if len(res):
 259                 return False
 260         return True
 261     def write(self, cr, uid, ids, vals, context=None):
 262         if not self._check_duplication(cr, uid, vals, ids, op='write'):
 263             raise osv.except_osv(_('ValidateError'), _('Directory name must be unique!'))
 264         return super(document_directory,self).write(cr, uid, ids, vals, context=context)
 265
 266     def create(self, cr, uid, vals, context=None):
 267         if not self._check_duplication(cr, uid, vals):
 268             raise osv.except_osv(_('ValidateError'), _('Directory name must be unique!'))
 269         if vals.get('name',False) and (vals.get('name').find('/')+1 or vals.get('name').find('@')+1 or vals.get('name').find('$')+1 or vals.get('name').find('#')+1) :
 270             raise osv.except_osv(_('ValidateError'), _('Directory name contains special characters!'))
 271         return super(document_directory,self).create(cr, uid, vals, context)
 272
 273     # TODO def unlink(...
 274
 275 document_directory()
 276
 277 class document_directory_dctx(osv.osv):
 278     """ In order to evaluate dynamic folders, child items could have a limiting
 279         domain expression. For that, their parents will export a context where useful
 280         information will be passed on.
 281         If you define sth like "s_id" = "this.id" at a folder iterating over sales, its
 282         children could have a domain like [('sale_id', = ,dctx_s_id )]
 283         This system should be used recursively, that is, parent dynamic context will be
 284         appended to all children down the tree.
 285     """
 286     _name = 'document.directory.dctx'
 287     _description = 'Directory Dynamic Context'
 288     _columns = {
 289         'dir_id': fields.many2one('document.directory', 'Directory', required=True),
 290         'field': fields.char('Field', size=20, required=True, select=1, help="The name of the field. Note that the prefix \"dctx_\" will be prepended to what is typed here."),
 291         'expr': fields.char('Expression', size=64, required=True, help="A python expression used to evaluate the field.\n" + \
 292                 "You can use 'dir_id' for current dir, 'res_id', 'res_model' as a reference to the current record, in dynamic folders"),
 293         }
 294
 295 document_directory_dctx()
 296
 297
 298 class document_directory_node(osv.osv):
 299     _inherit = 'process.node'
 300     _columns = {
 301         'directory_id':  fields.many2one('document.directory', 'Document directory', ondelete="set null"),
 302     }
 303 document_directory_node()