plugin.py

   1 import os
   2 import random
   3 import shutil
   4 import sys
   5 import threading
   6 import time
   7 import urllib
   8
   9 from Cheetah.Filters import Filter
  10 from lrucache import LRUCache
  11
  12 if os.path.sep == '/':
  13     quote = urllib.quote
  14     unquote = urllib.unquote_plus
  15 else:
  16     quote = lambda x: urllib.quote(x.replace(os.path.sep, '/'))
  17     unquote = lambda x: os.path.normpath(urllib.unquote_plus(x))
  18
  19 class Error:
  20     CONTENT_TYPE = 'text/html'
  21
  22 def GetPlugin(name):
  23     try:
  24         module_name = '.'.join(['plugins', name, name])
  25         module = __import__(module_name, globals(), locals(), name)
  26         plugin = getattr(module, module.CLASS_NAME)()
  27         return plugin
  28     except ImportError:
  29         print 'Error no', name, 'plugin exists. Check the type ' \
  30         'setting for your share.'
  31         return Error
  32
  33 class EncodeUnicode(Filter):
  34     def filter(self, val, **kw):
  35         """Encode Unicode strings, by default in UTF-8"""
  36
  37         encoding = kw.get('encoding', 'utf8')
  38
  39         if type(val) == str:
  40             try:
  41                 val = val.decode('utf8')
  42             except:
  43                 if sys.platform == 'darwin':
  44                     val = val.decode('macroman')
  45                 else:
  46                     val = val.decode('iso8859-1')
  47         elif type(val) != unicode:
  48             val = str(val)
  49         return val.encode(encoding)
  50
  51 class Plugin(object):
  52
  53     random_lock = threading.Lock()
  54
  55     CONTENT_TYPE = ''
  56
  57     recurse_cache = LRUCache(5)
  58     dir_cache = LRUCache(10)
  59
  60     def __new__(cls, *args, **kwds):
  61         it = cls.__dict__.get('__it__')
  62         if it is not None:
  63             return it
  64         cls.__it__ = it = object.__new__(cls)
  65         it.init(*args, **kwds)
  66         return it
  67
  68     def init(self):
  69         pass
  70
  71     def send_file(self, handler, path, query):
  72         handler.send_response(200)
  73         handler.end_headers()
  74         f = open(path, 'rb')
  75         shutil.copyfileobj(f, handler.wfile)
  76         f.close()
  77
  78     def get_local_base_path(self, handler, query):
  79
  80         subcname = query['Container'][0]
  81         container = handler.server.containers[subcname.split('/')[0]]
  82
  83         return os.path.normpath(container['path'])
  84
  85     def get_local_path(self, handler, query):
  86
  87         subcname = query['Container'][0]
  88         container = handler.server.containers[subcname.split('/')[0]]
  89
  90         path = os.path.normpath(container['path'])
  91         for folder in subcname.split('/')[1:]:
  92             if folder == '..':
  93                 return False
  94             path = os.path.join(path, folder)
  95         return path
  96
  97     def item_count(self, handler, query, cname, files, last_start=0):
  98         """Return only the desired portion of the list, as specified by
  99            ItemCount, AnchorItem and AnchorOffset. 'files' is either a
 100            list of strings, OR a list of objects with a 'name' attribute.
 101         """
 102         def no_anchor(handler, anchor):
 103             handler.server.logger.warning('Anchor not found: ' + anchor)
 104
 105         totalFiles = len(files)
 106         index = 0
 107
 108         if totalFiles and 'ItemCount' in query:
 109             count = int(query['ItemCount'][0])
 110
 111             if 'AnchorItem' in query:
 112                 bs = '/TiVoConnect?Command=QueryContainer&Container='
 113                 local_base_path = self.get_local_base_path(handler, query)
 114
 115                 anchor = query['AnchorItem'][0]
 116                 if anchor.startswith(bs):
 117                     anchor = anchor.replace(bs, '/', 1)
 118                 anchor = unquote(anchor)
 119                 anchor = anchor.replace(os.path.sep + cname, local_base_path, 1)
 120                 if not '://' in anchor:
 121                     anchor = os.path.normpath(anchor)
 122
 123                 if type(files[0]) == str:
 124                     filenames = files
 125                 else:
 126                     filenames = [x.name for x in files]
 127                 try:
 128                     index = filenames.index(anchor, last_start)
 129                 except ValueError:
 130                     if last_start:
 131                         try:
 132                             index = filenames.index(anchor, 0, last_start)
 133                         except ValueError:
 134                             no_anchor(handler, anchor)
 135                     else:
 136                         no_anchor(handler, anchor) # just use index = 0
 137
 138                 if count > 0:
 139                     index += 1
 140
 141                 if 'AnchorOffset' in query:
 142                     index += int(query['AnchorOffset'][0])
 143
 144             if count < 0:
 145                 index = (index + count) % len(files)
 146                 count = -count
 147             files = files[index:index + count]
 148
 149         return files, totalFiles, index
 150
 151     def get_files(self, handler, query, filterFunction=None, force_alpha=False):
 152
 153         class FileData:
 154             def __init__(self, name, isdir):
 155                 self.name = name
 156                 self.isdir = isdir
 157                 st = os.stat(name)
 158                 self.mdate = int(st.st_mtime)
 159
 160         class SortList:
 161             def __init__(self, files):
 162                 self.files = files
 163                 self.unsorted = True
 164                 self.sortby = None
 165                 self.last_start = 0
 166
 167         def build_recursive_list(path, recurse=True):
 168             files = []
 169             try:
 170                 for f in os.listdir(path):
 171                     if f.startswith('.'):
 172                         continue
 173                     f = os.path.join(path, f)
 174                     isdir = os.path.isdir(f)
 175                     if recurse and isdir:
 176                         files.extend(build_recursive_list(f))
 177                     else:
 178                        if not filterFunction or filterFunction(f, file_type):
 179                            files.append(FileData(f, isdir))
 180             except:
 181                 pass
 182             return files
 183
 184         subcname = query['Container'][0]
 185         cname = subcname.split('/')[0]
 186         path = self.get_local_path(handler, query)
 187
 188         file_type = query.get('Filter', [''])[0]
 189
 190         recurse = query.get('Recurse', ['No'])[0] == 'Yes'
 191
 192         filelist = []
 193         rc = self.recurse_cache
 194         dc = self.dir_cache
 195         if recurse:
 196             if path in rc and rc.mtime(path) + 300 >= time.time():
 197                 filelist = rc[path]
 198         else:
 199             updated = os.stat(path)[8]
 200             if path in dc and dc.mtime(path) >= updated:
 201                 filelist = dc[path]
 202             for p in rc:
 203                 if path.startswith(p) and rc.mtime(p) < updated:
 204                     del rc[p]
 205
 206         if not filelist:
 207             filelist = SortList(build_recursive_list(path, recurse))
 208
 209             if recurse:
 210                 rc[path] = filelist
 211             else:
 212                 dc[path] = filelist
 213
 214         def dir_sort(x, y):
 215             if x.isdir == y.isdir:
 216                 return name_sort(x, y)
 217             else:
 218                 return y.isdir - x.isdir
 219
 220         def name_sort(x, y):
 221             return cmp(x.name, y.name)
 222
 223         def date_sort(x, y):
 224             return cmp(y.mdate, x.mdate)
 225
 226         sortby = query.get('SortOrder', ['Normal'])[0]
 227         if filelist.unsorted or filelist.sortby != sortby:
 228             if force_alpha:
 229                 filelist.files.sort(dir_sort)
 230             elif sortby == '!CaptureDate':
 231                 filelist.files.sort(date_sort)
 232             else:
 233                 filelist.files.sort(name_sort)
 234
 235             filelist.sortby = sortby
 236             filelist.unsorted = False
 237
 238         files = filelist.files[:]
 239
 240         # Trim the list
 241         files, total, start = self.item_count(handler, query, cname, files,
 242                                               filelist.last_start)
 243         if len(files) > 1:
 244             filelist.last_start = start
 245         return files, total, start