import ctypes import os import string import traceback import time from couchpotato import CPLog from couchpotato.api import addApiView from couchpotato.core.event import addEvent from couchpotato.core.helpers.encoding import sp, ss, toUnicode from couchpotato.core.helpers.variable import getUserDir from couchpotato.core.plugins.base import Plugin log = CPLog(__name__) if os.name == 'nt': import imp try: imp.find_module('win32file') except: # todo:: subclass ImportError for missing dependencies, vs. broken plugins? raise ImportError("Missing the win32file module, which is a part of the prerequisite \ pywin32 package. You can get it from http://sourceforge.net/projects/pywin32/files/pywin32/") else: # noinspection PyUnresolvedReferences import win32file autoload = 'FileBrowser' class FileBrowser(Plugin): def __init__(self): self.soft_chroot_enabled = False self.soft_chroot = Plugin.conf(self, 'soft_chroot', section='core') if None != self.soft_chroot: self.soft_chroot = self.soft_chroot.strip() self.soft_chroot = self.soft_chroot.rstrip(os.path.sep) + os.path.sep self.soft_chroot_enabled = True addApiView('directory.list', self.view, docs = { 'desc': 'Return the directory list of a given directory', 'params': { 'path': {'desc': 'The directory to scan'}, 'show_hidden': {'desc': 'Also show hidden files'} }, 'return': {'type': 'object', 'example': """{ 'is_root': bool, //is top most folder 'parent': string, //parent folder of requested path 'home': string, //user home folder 'empty': bool, //directory is empty 'dirs': array, //directory names }"""} }) def getDirectories(self, path = '/', show_hidden = True): # Return driveletters or root if path is empty if path == '/' or not path or path == '\\': if os.name == 'nt': return self.getDriveLetters() path = '/' dirs = [] path = sp(path) for f in os.listdir(path): p = sp(os.path.join(path, f)) if os.path.isdir(p) and ((self.is_hidden(p) and bool(int(show_hidden))) or not self.is_hidden(p)): dirs.append(toUnicode('%s%s' % (p, os.path.sep))) return sorted(dirs) def getFiles(self): pass def getDriveLetters(self): driveletters = [] for drive in string.ascii_uppercase: if win32file.GetDriveType(drive + ':') in [win32file.DRIVE_FIXED, win32file.DRIVE_REMOTE, win32file.DRIVE_RAMDISK, win32file.DRIVE_REMOVABLE]: driveletters.append(drive + ':\\') return driveletters def soft_chroot_is_subdir(self, path): if None == path: return False if not path.endswith(os.path.sep): path += os.path.sep return path.startswith(self.soft_chroot) def soft_chroot_add(self, path): if None == path or len(path)==0: return self.soft_chroot if not path.startswith(os.path.sep): raise ValueError("path must starts with '/'") return self.soft_chroot[:-1] + path def soft_chroot_cut(self, path): if None == path or 0==len(path): raise ValueError('path is empty') if path == self.soft_chroot.rstrip(os.path.sep): return '/' if not path.startswith(self.soft_chroot): raise ValueError("path must starts with soft_chroot") l = len(self.soft_chroot)-1 return path[l:] def view(self, path = '/', show_hidden = True, **kwargs): home = getUserDir() if self.soft_chroot_enabled: if not self.soft_chroot_is_subdir(home): home = self.soft_chroot if not path: path = home if path.endswith(os.path.sep): path = path.rstrip(os.path.sep) elif self.soft_chroot_enabled: path = self.soft_chroot_add(path) try: dirs = self.getDirectories(path = path, show_hidden = show_hidden) except: log.error('Failed getting directory "%s" : %s', (path, traceback.format_exc())) dirs = [] if self.soft_chroot_enabled: dirs = map(self.soft_chroot_cut, dirs) parent = os.path.dirname(path.rstrip(os.path.sep)) if parent == path.rstrip(os.path.sep): parent = '/' elif parent != '/' and parent[-2:] != ':\\': parent += os.path.sep # TODO : check on windows: is_root = path == '/' if self.soft_chroot_enabled: # path could contain '/' on end, and could not contain.. # but in 'soft-chrooted' environment path could be included in chroot_dir only when it is root is_root = self.soft_chroot.startswith(path) # fix paths: if self.soft_chroot_is_subdir(parent): parent = self.soft_chroot_cut(parent) else: parent = os.path.sep home = self.soft_chroot_cut(home) return { 'is_root': is_root, 'empty': len(dirs) == 0, 'parent': parent, 'home': home, 'platform': os.name, 'dirs': dirs, } def is_hidden(self, filepath): name = ss(os.path.basename(os.path.abspath(filepath))) return name.startswith('.') or self.has_hidden_attribute(filepath) def has_hidden_attribute(self, filepath): result = False try: attrs = ctypes.windll.kernel32.GetFileAttributesW(sp(filepath)) #@UndefinedVariable assert attrs != -1 result = bool(attrs & 2) except (AttributeError, AssertionError): pass except: log.error('Failed getting hidden attribute: %s', traceback.format_exc()) return result