1 # -*- encoding: utf-8 -*-
4 from tarfile import filemode
16 from service import security
18 #from document.nodes import node_res_dir, node_res_obj
19 from document.nodes import get_node_context
22 def _get_month_name(month):
24 if month==1:return 'Jan'
25 elif month==2:return 'Feb'
26 elif month==3:return 'Mar'
27 elif month==4:return 'Apr'
28 elif month==5:return 'May'
29 elif month==6:return 'Jun'
30 elif month==7:return 'Jul'
31 elif month==8:return 'Aug'
32 elif month==9:return 'Sep'
33 elif month==10:return 'Oct'
34 elif month==11:return 'Nov'
35 elif month==12:return 'Dec'
39 return s.decode('utf-8')
42 return s.decode('latin')
45 return s.encode('ascii')
51 return s.encode('utf-8')
54 return s.encode('latin')
57 return s.decode('ascii')
61 class abstracted_fs(object):
62 """A class used to interact with the file system, providing a high
63 level, cross-platform interface compatible with both Windows and
64 UNIX style filesystems.
66 It provides some utility methods and some wraps around operations
67 involved in file creation and file system operations like moving
68 files or removing directories.
71 - (str) root: the user home directory.
72 - (str) cwd: the current working directory.
73 - (str) rnfr: source file to be renamed.
82 self._log = logging.getLogger('FTP.fs')
86 """Get the list of available databases, with FTPd support
88 s = netsvc.ExportService.getService('db')
89 result = s.exp_list(document=True)
90 self.db_name_list = []
91 for db_name in result:
95 db = pooler.get_db_only(db_name)
97 cr.execute("SELECT 1 FROM pg_class WHERE relkind = 'r' AND relname = 'ir_module_module'")
101 cr.execute("SELECT id FROM ir_module_module WHERE name = 'document_ftp' AND state IN ('installed', 'to upgrade') ")
104 self.db_name_list.append(db_name)
107 self._log.warning('Cannot use db "%s"', db_name)
112 # pooler.close_db(db_name)
113 return self.db_name_list
115 def ftpnorm(self, ftppath):
116 """Normalize a "virtual" ftp pathname (tipically the raw string
119 Pathname returned is relative!.
121 p = os.path.normpath(ftppath)
122 # normalize string in a standard web-path notation having '/'
123 # as separator. xrg: is that really in the spec?
124 p = p.replace("\\", "/")
125 # os.path.normpath supports UNC paths (e.g. "//a/b/c") but we
126 # don't need them. In case we get an UNC path we collapse
127 # redundant separators appearing at the beginning of the string
135 """ return the cwd, decoded in utf"""
136 return _to_decode(self.cwd)
138 def ftp2fs(self, path_orig, data):
139 raise DeprecationWarning()
141 def fs2ftp(self, node):
142 """ Return the string path of a node, in ftp form
146 paths = node.full_path()
147 res = '/' + node.context.dbname + '/' + \
148 _to_decode(os.path.join(*paths))
152 def validpath(self, path):
153 """Check whether the path belongs to user's home directory.
154 Expected argument is a datacr tuple
156 # TODO: are we called for "/" ?
157 return isinstance(path, tuple) and path[1] and True or False
159 # --- Wrapper methods around open() and tempfile.mkstemp
161 def create(self, datacr, objname, mode):
162 """ Create a children file-node under node, open it
163 @return open node_descriptor of the created node
165 objname = _to_unicode(objname)
166 cr , node, rem = datacr
168 child = node.child(cr, objname)
170 if child.type not in ('file','content'):
171 raise OSError(1, 'Operation not permited.')
173 ret = child.open_data(cr, mode)
175 except EnvironmentError:
178 self._log.exception('Cannot locate item %s at node %s', objname, repr(node))
182 child = node.create_child(cr, objname, data=None)
183 return child.open_data(cr, mode)
185 self._log.exception('Cannot create item %s at node %s', objname, repr(node))
186 raise OSError(1, 'Operation not permited.')
188 def open(self, datacr, mode):
189 if not (datacr and datacr[1]):
190 raise OSError(1, 'Operation not permited.')
192 cr, node, rem = datacr
193 res = node.open_data(cr, mode)
196 # ok, but need test more
198 def mkstemp(self, suffix='', prefix='', dir=None, mode='wb'):
199 """A wrap around tempfile.mkstemp creating a file with a unique
200 name. Unlike mkstemp it returns an object with a file-like
203 raise NotImplementedError
205 text = not 'b' in mode
206 # for unique file , maintain version if duplicate file
211 pool = pooler.get_pool(node.context.dbname)
212 object=dir and dir.object or False
213 object2=dir and dir.object2 or False
214 res=pool.get('ir.attachment').search(cr,uid,[('name','like',prefix),('parent_id','=',object and object.type in ('directory','ressource') and object.id or False),('res_id','=',object2 and object2.id or False),('res_model','=',object2 and object2._name or False)])
216 pre = prefix.split('.')
217 prefix=pre[0] + '.v'+str(len(res))+'.'+pre[1]
218 #prefix = prefix + '.'
219 return self.create(dir,suffix+prefix,text)
224 def chdir(self, datacr):
225 if (not datacr) or datacr == (None, None, None):
230 raise OSError(1, 'Operation not permitted')
231 if datacr[1].type not in ('collection','database'):
232 raise OSError(2, 'Path is not a directory')
233 self.cwd = '/'+datacr[1].context.dbname + '/'
234 self.cwd += '/'.join(datacr[1].full_path())
235 self.cwd_node = datacr[1]
238 def mkdir(self, datacr, basename):
239 """Create the specified directory."""
240 cr, node, rem = datacr or (None, None, None)
242 raise OSError(1, 'Operation not permited.')
245 basename =_to_unicode(basename)
246 cdir = node.create_child_collection(cr, basename)
247 self._log.debug("Created child dir: %r", cdir)
250 self._log.exception('Cannot create dir "%s" at node %s', basename, repr(node))
251 raise OSError(1, 'Operation not permited.')
253 def close_cr(self, data):
258 def get_cr(self, pathname):
259 raise DeprecationWarning()
261 def get_crdata(self, line, mode='file'):
262 """ Get database cursor, node and remainder data, for commands
264 This is the helper function that will prepare the arguments for
265 any of the subsequent commands.
266 It returns a tuple in the form of:
267 @code ( cr, node, rem_path=None )
269 @param line An absolute or relative ftp path, as passed to the cmd.
270 @param mode A word describing the mode of operation, so that this
271 function behaves properly in the different commands.
273 path = self.ftpnorm(line)
274 if self.cwd_node is None:
275 if not os.path.isabs(path):
276 path = os.path.join(self.root, path)
278 if path == '/' and mode in ('list', 'cwd'):
279 return (None, None, None )
281 path = _to_unicode(os.path.normpath(path)) # again, for '/db/../ss'
282 if path == '.': path = ''
284 if os.path.isabs(path) and self.cwd_node is not None \
285 and path.startswith(self.cwd):
286 # make relative, so that cwd_node is used again
287 path = path[len(self.cwd):]
288 if path.startswith('/'):
291 p_parts = path.split('/') # hard-code the unix sep here, by spec.
293 assert '..' not in p_parts
296 if mode in ('create',):
297 rem_path = p_parts[-1]
298 p_parts = p_parts[:-1]
300 if os.path.isabs(path):
301 # we have to start from root, again
302 while p_parts[0] == '':
303 p_parts = p_parts[1:]
304 # self._log.debug("Path parts: %r ", p_parts)
306 raise IOError(errno.EPERM, 'Cannot perform operation at root dir')
308 if dbname not in self.db_list():
309 raise IOError(errno.ENOENT,'Invalid database path')
311 db = pooler.get_db(dbname)
313 raise OSError(1, 'Database cannot be used.')
316 uid = security.login(dbname, self.username, self.password)
322 raise OSError(2, 'Authentification Required.')
323 n = get_node_context(cr, uid, {})
324 node = n.get_uri(cr, p_parts[1:])
325 # self._log.debug("get_crdata(abs): %r" % ( (cr, node, rem_path),))
326 return (cr, node, rem_path)
328 # we never reach here if cwd_node is not set
329 if p_parts and p_parts[-1] == '':
330 p_parts = p_parts[:-1]
331 cr, uid = self.get_node_cr_uid(self.cwd_node)
333 node = self.cwd_node.get_uri(cr, p_parts)
336 if node is False and mode not in ('???'):
338 raise IOError(errno.ENOENT, 'Path does not exist')
339 # self._log.debug("get_crdata(rel): %r" % ( (cr, node, rem_path),))
340 return (cr, node, rem_path)
342 def get_node_cr_uid(self, node):
343 """ Get cr, uid, pool from a node
346 db = pooler.get_db(node.context.dbname)
347 return db.cursor(), node.context.uid
349 def get_node_cr(self, node):
350 """ Get the cursor for the database of a node
352 The cursor is the only thing that a node will not store
353 persistenly, so we have to obtain a new one for each call.
355 return self.get_node_cr_uid(node)[0]
357 def listdir(self, datacr):
358 """List the content of a directory."""
359 class false_node(object):
368 def __init__(self, db):
371 if datacr[1] is None:
373 for db in self.db_list():
375 result.append(false_node(db))
376 except osv.except_osv:
379 cr, node, rem = datacr
380 res = node.children(cr)
383 def rmdir(self, datacr):
384 """Remove the specified directory."""
385 cr, node, rem = datacr
387 cr = self.get_node_cr(node)
391 def remove(self, datacr):
393 if datacr[1].type == 'collection':
394 return self.rmdir(datacr)
395 elif datacr[1].type == 'file':
396 return self.rmfile(datacr)
397 raise OSError(1, 'Operation not permited.')
399 def rmfile(self, datacr):
400 """Remove the specified file."""
406 def rename(self, src, datacr):
407 """ Renaming operation, the effect depends on the src:
408 * A file: read, create and remove
409 * A directory: change the parent and reassign childs to ressource
413 nname = _to_unicode(datacr[2])
414 ret = src.move_to(cr, datacr[1], new_name=nname)
415 # API shouldn't wait for us to write the object
416 assert (ret is True) or (ret is False)
418 except Exception,err:
419 self._log.exception('Cannot rename "%s" to "%s" at "%s"', src, dst_basename, dst_basedir)
420 raise OSError(1,'Operation not permited.')
422 def stat(self, node):
423 raise NotImplementedError()
425 # --- Wrapper methods around os.path.*
428 def isfile(self, node):
429 if node and (node.type in ('file','content')):
434 def islink(self, path):
435 """Return True if path is a symbolic link."""
438 def isdir(self, node):
439 """Return True if path is a directory."""
442 if node and (node.type in ('collection','database')):
446 def getsize(self, datacr):
447 """Return the size of the specified file in bytes."""
448 if not (datacr and datacr[1]):
450 if datacr[1].type in ('file', 'content'):
451 return datacr[1].content_length or 0L
455 def getmtime(self, datacr):
456 """Return the last modified time as a number of seconds since
460 if node.write_date or node.create_date:
461 dt = (node.write_date or node.create_date)[:19]
462 result = time.mktime(time.strptime(dt, '%Y-%m-%d %H:%M:%S'))
464 result = time.mktime(time.localtime())
468 def realpath(self, path):
469 """Return the canonical version of path eliminating any
470 symbolic links encountered in the path (if they are
471 supported by the operating system).
476 def lexists(self, path):
477 """Return True if path refers to an existing path, including
478 a broken or circular symbolic link.
480 raise DeprecationWarning()
481 return path and True or False
485 # Ok, can be improved
486 def glob1(self, dirname, pattern):
487 """Return a list of files matching a dirname pattern
490 Unlike glob.glob1 raises exception if os.listdir() fails.
492 names = self.listdir(dirname)
493 if pattern[0] != '.':
494 names = filter(lambda x: x.path[0] != '.', names)
495 return fnmatch.filter(names, pattern)
497 # --- Listing utilities
499 # note: the following operations are no more blocking
501 def get_list_dir(self, datacr):
502 """"Return an iterator object that yields a directory listing
503 in a form suitable for LIST command.
507 elif self.isdir(datacr[1]):
508 listing = self.listdir(datacr)
510 return self.format_list(datacr[0], datacr[1], listing)
511 # if path is a file or a symlink we return information about it
512 elif self.isfile(datacr[1]):
513 par = datacr[1].parent
514 return self.format_list(datacr[0], par, [datacr[1]])
516 def get_stat_dir(self, rawline, datacr):
517 """Return an iterator object that yields a list of files
518 matching a dirname pattern non-recursively in a form
519 suitable for STAT command.
521 - (str) rawline: the raw string passed by client as command
524 ftppath = self.ftpnorm(rawline)
525 if not glob.has_magic(ftppath):
526 return self.get_list_dir(self.ftp2fs(rawline, datacr))
528 basedir, basename = os.path.split(ftppath)
529 if glob.has_magic(basedir):
530 return iter(['Directory recursion not supported.\r\n'])
532 basedir = self.ftp2fs(basedir, datacr)
533 listing = self.glob1(basedir, basename)
536 return self.format_list(basedir, listing)
538 def format_list(self, cr, parent_node, listing, ignore_err=True):
539 """Return an iterator object that yields the entries of given
540 directory emulating the "/bin/ls -lA" UNIX command output.
542 - (str) basedir: the parent directory node. Can be None
543 - (list) listing: a list of nodes
544 - (bool) ignore_err: when False raise exception if os.lstat()
547 On platforms which do not support the pwd and grp modules (such
548 as Windows), ownership is printed as "owner" and "group" as a
549 default, and number of hard links is always "1". On UNIX
550 systems, the actual owner, group, and number of links are
553 This is how output appears to client:
555 -rw-rw-rw- 1 owner group 7045120 Sep 02 3:47 music.mp3
556 drwxrwxrwx 1 owner group 0 Aug 31 18:50 e-books
557 -rw-rw-rw- 1 owner group 380 Sep 02 3:40 module.py
560 perms = filemode(node.unixperms) # permissions
562 size = node.content_length or 0L
565 # stat.st_mtime could fail (-1) if last mtime is too old
566 # in which case we return the local time as last mtime
568 st_mtime = node.write_date or 0.0
569 if isinstance(st_mtime, basestring):
570 st_mtime = time.strptime(st_mtime, '%Y-%m-%d %H:%M:%S')
571 elif isinstance(st_mtime, float):
572 st_mtime = time.localtime(st_mtime)
573 mname=_get_month_name(time.strftime("%m", st_mtime ))
574 mtime = mname+' '+time.strftime("%d %H:%M", st_mtime)
576 mname=_get_month_name(time.strftime("%m"))
577 mtime = mname+' '+time.strftime("%d %H:%M")
579 if isinstance(fpath, (list, tuple)):
581 # formatting is matched with proftpd ls output
582 path=_to_decode(fpath)
583 yield "%s %3s %-8s %-8s %8s %s %s\r\n" %(perms, nlinks, uname, gname,
587 def format_mlsx(self, cr, basedir, listing, perms, facts, ignore_err=True):
588 """Return an iterator object that yields the entries of a given
589 directory or of a single file in a form suitable with MLSD and
592 Every entry includes a list of "facts" referring the listed
593 element. See RFC-3659, chapter 7, to see what every single
596 - (str) basedir: the absolute dirname.
597 - (list) listing: the names of the entries in basedir
598 - (str) perms: the string referencing the user permissions.
599 - (str) facts: the list of "facts" to be returned.
600 - (bool) ignore_err: when False raise exception if os.stat()
603 Note that "facts" returned may change depending on the platform
604 and on what user specified by using the OPTS command.
606 This is how output could appear to the client issuing
609 type=file;size=156;perm=r;modify=20071029155301;unique=801cd2; music.mp3
610 type=dir;size=0;perm=el;modify=20071127230206;unique=801e33; ebooks
611 type=file;size=211;perm=r;modify=20071103093626;unique=801e32; module.py
613 permdir = ''.join([x for x in perms if x not in 'arw'])
614 permfile = ''.join([x for x in perms if x not in 'celmp'])
615 if ('w' in perms) or ('a' in perms) or ('f' in perms):
619 type = size = perm = modify = create = unique = mode = uid = gid = ""
626 perm = 'perm=%s;' %permdir
631 perm = 'perm=%s;' %permfile
633 size = 'size=%s;' % (node.content_length or 0L)
634 # last modification time
635 if 'modify' in facts:
637 st_mtime = node.write_date or 0.0
638 if isinstance(st_mtime, basestring):
639 st_mtime = time.strptime(st_mtime, '%Y-%m-%d %H:%M:%S')
640 elif isinstance(st_mtime, float):
641 st_mtime = time.localtime(st_mtime)
642 modify = 'modify=%s;' %time.strftime("%Y%m%d%H%M%S", st_mtime)
644 # stat.st_mtime could fail (-1) if last mtime is too old
646 if 'create' in facts:
647 # on Windows we can provide also the creation time
649 st_ctime = node.create_date or 0.0
650 if isinstance(st_ctime, basestring):
651 st_ctime = time.strptime(st_ctime, '%Y-%m-%d %H:%M:%S')
652 elif isinstance(st_mtime, float):
653 st_ctime = time.localtime(st_ctime)
654 create = 'create=%s;' %time.strftime("%Y%m%d%H%M%S",st_ctime)
658 if 'unix.mode' in facts:
659 mode = 'unix.mode=%s;' %oct(node.unixperms & 0777)
660 if 'unix.uid' in facts:
661 uid = 'unix.uid=%s;' % node.uuser
662 if 'unix.gid' in facts:
663 gid = 'unix.gid=%s;' % node.ugroup
664 # We provide unique fact (see RFC-3659, chapter 7.5.2) on
665 # posix platforms only; we get it by mixing st_dev and
666 # st_ino values which should be enough for granting an
667 # uniqueness for the file listed.
668 # The same approach is used by pure-ftpd.
669 # Implementors who want to provide unique fact on other
670 # platforms should use some platform-specific method (e.g.
671 # on Windows NTFS filesystems MTF records could be used).
672 # if 'unique' in facts: todo
673 # unique = "unique=%x%x;" %(st.st_dev, st.st_ino)
675 if isinstance (path, (list, tuple)):
677 path=_to_decode(path)
678 yield "%s%s%s%s%s%s%s%s%s %s\r\n" %(type, size, perm, modify, create,
679 mode, uid, gid, unique, path)
681 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: