When returning from the details view in a subfolder, the TiVo would make
[pyTivo/TheBayer.git] / plugin.py
bloba9ca83ed462c2141ae6619a19433c3cc22c44e3b
1 import os
2 import random
3 import shutil
4 import sys
5 import threading
6 import time
7 import urllib
9 from Cheetah.Filters import Filter
10 from lrucache import LRUCache
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))
19 class Error:
20 CONTENT_TYPE = 'text/html'
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
33 class EncodeUnicode(Filter):
34 def filter(self, val, **kw):
35 """Encode Unicode strings, by default in UTF-8"""
37 encoding = kw.get('encoding', 'utf8')
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)
51 class Plugin(object):
53 random_lock = threading.Lock()
55 CONTENT_TYPE = ''
57 recurse_cache = LRUCache(5)
58 dir_cache = LRUCache(10)
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
68 def init(self):
69 pass
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()
78 def get_local_base_path(self, handler, query):
80 subcname = query['Container'][0]
81 container = handler.server.containers[subcname.split('/')[0]]
83 return os.path.normpath(container['path'])
85 def get_local_path(self, handler, query):
87 subcname = query['Container'][0]
88 container = handler.server.containers[subcname.split('/')[0]]
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
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.
102 def no_anchor(handler, anchor):
103 handler.server.logger.warning('Anchor not found: ' + anchor)
105 totalFiles = len(files)
106 index = last_start
108 if totalFiles and 'ItemCount' in query:
109 count = int(query['ItemCount'][0])
111 if 'AnchorItem' in query:
112 bs = '/TiVoConnect?Command=QueryContainer&Container='
113 local_base_path = self.get_local_base_path(handler, query)
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)
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
138 if count > 0:
139 index += 1
141 if 'AnchorOffset' in query:
142 index += int(query['AnchorOffset'][0])
144 #foward count
145 if count >= 0:
146 files = files[index:index + count]
147 #backwards count
148 else:
149 if index + count < 0:
150 count = -index
151 files = files[index + count:index]
152 index += count
154 return files, totalFiles, index
156 def get_files(self, handler, query, filterFunction=None, force_alpha=False):
158 class FileData:
159 def __init__(self, name, isdir):
160 self.name = name
161 self.isdir = isdir
162 st = os.stat(name)
163 self.mdate = int(st.st_mtime)
165 class SortList:
166 def __init__(self, files):
167 self.files = files
168 self.unsorted = True
169 self.sortby = None
170 self.last_start = 0
172 def build_recursive_list(path, recurse=True):
173 files = []
174 try:
175 for f in os.listdir(path):
176 if f.startswith('.'):
177 continue
178 f = os.path.join(path, f)
179 isdir = os.path.isdir(f)
180 if recurse and isdir:
181 files.extend(build_recursive_list(f))
182 else:
183 if not filterFunction or filterFunction(f, file_type):
184 files.append(FileData(f, isdir))
185 except:
186 pass
187 return files
189 subcname = query['Container'][0]
190 cname = subcname.split('/')[0]
191 path = self.get_local_path(handler, query)
193 file_type = query.get('Filter', [''])[0]
195 recurse = query.get('Recurse', ['No'])[0] == 'Yes'
197 filelist = []
198 rc = self.recurse_cache
199 dc = self.dir_cache
200 if recurse:
201 if path in rc and rc.mtime(path) + 300 >= time.time():
202 filelist = rc[path]
203 else:
204 updated = os.stat(path)[8]
205 if path in dc and dc.mtime(path) >= updated:
206 filelist = dc[path]
207 for p in rc:
208 if path.startswith(p) and rc.mtime(p) < updated:
209 del rc[p]
211 if not filelist:
212 filelist = SortList(build_recursive_list(path, recurse))
214 if recurse:
215 rc[path] = filelist
216 else:
217 dc[path] = filelist
219 def dir_sort(x, y):
220 if x.isdir == y.isdir:
221 return name_sort(x, y)
222 else:
223 return y.isdir - x.isdir
225 def name_sort(x, y):
226 return cmp(x.name, y.name)
228 def date_sort(x, y):
229 return cmp(y.mdate, x.mdate)
231 sortby = query.get('SortOrder', ['Normal'])[0]
232 if filelist.unsorted or filelist.sortby != sortby:
233 if force_alpha:
234 filelist.files.sort(dir_sort)
235 elif sortby == '!CaptureDate':
236 filelist.files.sort(date_sort)
237 else:
238 filelist.files.sort(name_sort)
240 filelist.sortby = sortby
241 filelist.unsorted = False
243 files = filelist.files[:]
245 # Trim the list
246 files, total, start = self.item_count(handler, query, cname, files,
247 filelist.last_start)
248 if len(files) > 1:
249 filelist.last_start = start
250 return files, total, start