plugin.py

   1 import os, shutil, random, threading, urllib
   2 from urlparse import urlparse
   3
   4 if os.path.sep == '/':
   5     quote = urllib.quote
   6     unquote = urllib.unquote_plus
   7 else:
   8     quote = lambda x: urllib.quote(x.replace(os.path.sep, '/'))
   9     unquote = lambda x: urllib.unquote_plus(x).replace('/', os.path.sep)
  10
  11 class Error:
  12     CONTENT_TYPE = 'text/html'
  13
  14 def GetPlugin(name):
  15     module_name = '.'.join(['plugins', name, name])
  16     try:
  17         module = __import__(module_name, globals(), locals(), name)
  18         plugin = getattr(module, module.CLASS_NAME)()
  19         return plugin
  20     except:
  21         print 'Error no', name, 'plugin exists. Check the type ' \
  22               'setting for your share.'
  23         return Error
  24
  25 class Plugin(object):
  26
  27     random_lock = threading.Lock()
  28
  29     CONTENT_TYPE = ''
  30
  31     def __new__(cls, *args, **kwds):
  32         it = cls.__dict__.get('__it__')
  33         if it is not None:
  34             return it
  35         cls.__it__ = it = object.__new__(cls)
  36         it.init(*args, **kwds)
  37         return it
  38
  39     def init(self):
  40         pass
  41
  42     def send_file(self, handler, container, name):
  43         o = urlparse("http://fake.host" + handler.path)
  44         path = unquote(o[2])
  45         handler.send_response(200)
  46         handler.end_headers()
  47         f = file(container['path'] + path[len(name) + 1:], 'rb')
  48         shutil.copyfileobj(f, handler.wfile)
  49
  50     def get_local_base_path(self, handler, query):
  51
  52         subcname = query['Container'][0]
  53         container = handler.server.containers[subcname.split('/')[0]]
  54
  55         return os.path.normpath(container['path'])
  56
  57     def get_local_path(self, handler, query):
  58
  59         subcname = query['Container'][0]
  60         container = handler.server.containers[subcname.split('/')[0]]
  61
  62         path = os.path.normpath(container['path'])
  63         for folder in subcname.split('/')[1:]:
  64             if folder == '..':
  65                 return False
  66             path = os.path.join(path, folder)
  67         return path
  68
  69     def item_count(self, handler, query, cname, files, last_start=0):
  70         """Return only the desired portion of the list, as specified by
  71            ItemCount, AnchorItem and AnchorOffset. 'files' is either a
  72            list of strings, OR a list of objects with a 'name' attribute.
  73         """
  74         totalFiles = len(files)
  75         index = 0
  76
  77         if totalFiles and query.has_key('ItemCount'):
  78             count = int(query['ItemCount'][0])
  79
  80             if query.has_key('AnchorItem'):
  81                 bs = '/TiVoConnect?Command=QueryContainer&Container='
  82                 local_base_path = self.get_local_base_path(handler, query)
  83
  84                 anchor = query['AnchorItem'][0]
  85                 if anchor.startswith(bs):
  86                     anchor = anchor.replace(bs, '/', 1)
  87                 anchor = unquote(anchor)
  88                 anchor = anchor.replace(os.path.sep + cname, local_base_path, 1)
  89                 if not '://' in anchor:
  90                     anchor = os.path.normpath(anchor)
  91
  92                 if type(files[0]) == str:
  93                     filenames = files
  94                 else:
  95                     filenames = [x.name for x in files]
  96                 try:
  97                     index = filenames.index(anchor, last_start)
  98                 except ValueError:
  99                     if last_start:
 100                         try:
 101                             index = filenames.index(anchor, 0, last_start)
 102                         except ValueError:
 103                             print 'Anchor not found:', anchor
 104                     else:
 105                         print 'Anchor not found:', anchor  # just use index = 0
 106
 107                 if count > 0:
 108                     index += 1
 109
 110                 if query.has_key('AnchorOffset'):
 111                     index += int(query['AnchorOffset'][0])
 112
 113                 #foward count
 114                 if count >= 0:
 115                     files = files[index:index + count]
 116                 #backwards count
 117                 else:
 118                     if index + count < 0:
 119                         count = -index
 120                     files = files[index + count:index]
 121                     index += count
 122
 123             else:  # No AnchorItem
 124
 125                 if count >= 0:
 126                     files = files[:count]
 127                 else:
 128                     index = count % len(files)
 129                     files = files[count:]
 130
 131         return files, totalFiles, index
 132
 133     def get_files(self, handler, query, filterFunction=None):
 134
 135         def build_recursive_list(path, recurse=True):
 136             files = []
 137             for file in os.listdir(path):
 138                 if file.startswith('.'):
 139                     continue
 140                 file = os.path.join(path, file)
 141                 if recurse and os.path.isdir(file):
 142                     files.extend(build_recursive_list(file))
 143                 else:
 144                    if not filterFunction or filterFunction(file, file_type):
 145                        files.append(file)
 146             return files
 147
 148         subcname = query['Container'][0]
 149         cname = subcname.split('/')[0]
 150         path = self.get_local_path(handler, query)
 151
 152         file_type = query.get('Filter', [''])[0]
 153
 154         recurse = query.get('Recurse',['No'])[0] == 'Yes'
 155         files = build_recursive_list(path, recurse)
 156
 157         totalFiles = len(files)
 158
 159         def dir_sort(x, y):
 160             xdir = os.path.isdir(os.path.join(path, x))
 161             ydir = os.path.isdir(os.path.join(path, y))
 162
 163             if xdir == ydir:
 164                 return name_sort(x, y)
 165             else:
 166                 return ydir - xdir
 167
 168         def name_sort(x, y):
 169             return cmp(x, y)
 170
 171         if query.get('SortOrder',['Normal'])[0] == 'Random':
 172             seed = query.get('RandomSeed', ['1'])[0]
 173             self.random_lock.acquire()
 174             random.seed(seed)
 175             random.shuffle(files)
 176             self.random_lock.release()
 177         else:
 178             files.sort(dir_sort)
 179
 180         # Trim the list
 181         return self.item_count(handler, query, cname, files)