Parent: [4c66fb] (diff)

Child: [1f62cf] (diff)

Download this file

uprclfolders.py    347 lines (298 with data), 13.0 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
#
# Copyright (C) 2017 J.F.Dockes
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Manage the [folders] section of the tree.
#
# Object Id prefix: 0$uprcl$folders
#
# Obect id inside the section.
# Container: $d<diridx> where <diridx> indexes into our directory vector.
# Item: $i<docidx> where <docidx> indexex into the docs vector.
#
# Data structure:
#
# The _dirvec vector has one entry for each directory. Each entry is a
# dictionary, mapping the names inside the directory to a pair
# (diridx,docidx), where:
# - diridx is an index into dirvec if the name is a directory, else -1
# - docidx is the index of the doc inside the doc array, or -1 if:
# - There is no doc entry, which could possibly happen if there is
# no result for an intermediary element in a path,
# because of some recoll issue, or because this is a synthetic
# 'contentgroup' entry.
# - Or if the doc was not yet seen, the index will then be updated
# when we see it.
#
# Each directory has a special ".." entry with a diridx pointing to
# the parent directory. This allows building a path from a container
# id (aka pwd).
#
# No need has emerged for a "." entry.
#
# Entry 0 in _dirvec is special: it holds the 'topdirs' from the recoll
# configuration. The entries are paths instead of simple names, and
# the docidx is 0. The diridx points to a dirvec entry.
import os
import shlex
import urllib
import sys
import time
from timeit import default_timer as timer
from upmplgutils import uplog
from uprclutils import docarturi, audiomtypes, rcldirentry, \
rcldoctoentry, cmpentries
from recoll import recoll
from recoll import rclconfig
class Folders(object):
# Initialize (read recoll data and build tree).
def __init__(self, confdir, httphp, pathprefix):
self._idprefix = '0$uprcl$folders'
self._httphp = httphp
self._pprefix = pathprefix
# Debug : limit processed recoll entries for speed
self._maxrclcnt = 0
self._fetchalldocs(confdir)
self._rcl2folders(confdir)
def rcldocs(self):
return self._rcldocs
# Create new directory entry: insert in father and append dirvec slot
# (with ".." entry)
def _createdir(self, fathidx, docidx, nm):
self._dirvec.append({})
self._dirvec[fathidx][nm] = (len(self._dirvec) - 1, docidx)
self._dirvec[-1][".."] = (fathidx, -1)
return len(self._dirvec) - 1
# Walk the recoll docs array and split the URLs paths to build the
# [folders] data structure
def _rcl2folders(self, confdir):
self._dirvec = []
start = timer()
rclconf = rclconfig.RclConfig(confdir)
topdirs = [os.path.expanduser(d) for d in
shlex.split(rclconf.getConfParam('topdirs'))]
topdirs = [d.rstrip('/') for d in topdirs]
# Create the 1st entry. This is special because it holds the
# recoll topdirs, which are paths instead of simple names. There
# does not seem any need to build the tree between a topdir and /
self._dirvec.append({})
self._dirvec[0][".."] = (0, -1)
for d in topdirs:
self._dirvec.append({})
self._dirvec[0][d] = (len(self._dirvec)-1, -1)
self._dirvec[-1][".."] = (0, -1)
# Walk the doc list and update the directory tree according to the
# url: create intermediary directories if needed, create leaf
# entry.
for docidx in range(len(self._rcldocs)):
doc = self._rcldocs[docidx]
# Possibly enrich the doc entry with a cover art uri.
arturi = docarturi(doc, self._httphp, self._pprefix)
if arturi:
# The uri is quoted, so it's ascii and we can just store
# it as a doc attribute
doc.albumarturi = arturi
# No need to include non-audio types in the visible tree.
if doc.mtype not in audiomtypes:
continue
url = doc.getbinurl()
url = url[7:]
try:
decoded = url.decode('utf-8')
except:
decoded = urllib.quote(url).decode('utf-8')
# Determine the root entry (topdirs element). Special because
# its path is not a simple name.
fathidx = -1
for rtpath,idx in self._dirvec[0].iteritems():
if url.startswith(rtpath):
fathidx = idx[0]
break
if fathidx == -1:
uplog("No parent in topdirs: %s" % decoded)
continue
# Compute rest of path
url1 = url[len(rtpath):]
if len(url1) == 0:
continue
# If there is a contentgroup field, just add it as a virtual
# directory in the path. This only affects the visible tree,
# not the 'real' URLs of course.
if doc.contentgroup:
a = os.path.dirname(url1).decode('utf-8', errors='replace')
b = os.path.basename(url1).decode('utf-8', errors='replace')
url1 = os.path.join(a, doc.contentgroup, b)
# Split path, then walk the vector, possibly creating
# directory entries as needed
path = url1.split('/')[1:]
#uplog("%s"%path, file=sys.stderr)
for idx in range(len(path)):
elt = path[idx]
if elt in self._dirvec[fathidx]:
# This path element was already seen
# If this is the last entry in the path, maybe update
# the doc idx (previous entries were created for
# intermediate elements without a Doc).
if idx == len(path) -1:
self._dirvec[fathidx][elt] = (self._dirvec[fathidx][elt][0], docidx)
#uplog("updating docidx for %s" % decoded)
# Update fathidx for next iteration
fathidx = self._dirvec[fathidx][elt][0]
else:
# Element has no entry in father directory (hence no
# self._dirvec entry either).
if idx != len(path) -1:
# This is an intermediate element. Create a
# Doc-less directory
fathidx = self._createdir(fathidx, -1, elt)
else:
# Last element. If directory, needs a self._dirvec entry
if doc.mtype == 'inode/directory':
fathidx = self._createdir(fathidx, docidx, elt)
#uplog("Setting docidx for %s" % decoded)
else:
self._dirvec[fathidx][elt] = (-1, docidx)
if False:
for ent in self._dirvec:
uplog("%s" % ent)
end = timer()
uplog("_rcl2folders took %.2f Seconds" % (end - start))
# Fetch all the docs by querying Recoll with [mime:*], which is
# guaranteed to match every doc without overflowing the query size
# (because the number of mime types is limited). Something like
# title:* would overflow. This creates the main doc array, which is
# then used by all modules.
def _fetchalldocs(self, confdir):
start = timer()
rcldb = recoll.connect(confdir=confdir)
rclq = rcldb.query()
rclq.execute("mime:*", stemming=0)
uplog("Estimated alldocs query results: %d" % (rclq.rowcount))
totcnt = 0
self._rcldocs = []
while True:
docs = rclq.fetchmany()
for doc in docs:
self._rcldocs.append(doc)
totcnt += 1
if (self._maxrclcnt > 0 and totcnt >= self._maxrclcnt) or \
len(docs) != rclq.arraysize:
break
time.sleep(0)
end = timer()
uplog("Retrieved %d docs in %.2f Seconds" % (totcnt,end - start))
##############
# Browsing the initialized [folders] hierarchy
# Extract dirvec index from objid, according to the way we generate them.
def _objidtodiridx(self, pid):
if not pid.startswith(self._idprefix):
raise Exception("folders.browse: bad pid %s" % pid)
if len(self._rcldocs) == 0:
raise Exception("folders:browse: no docs")
diridx = pid[len(self._idprefix):]
if not diridx:
diridx = 0
else:
if diridx[1] != 'd':
raise Exception("folders:browse: called on non dir objid %s" %
pid)
diridx = int(diridx[2:])
if diridx >= len(self._dirvec):
raise Exception("folders:browse: bad pid %s" % pid)
return diridx
# Tell the top module what entries we define in the root
def rootentries(self, pid):
return [rcldirentry(pid + 'folders', pid, '[folders]'),]
# Look all non-directory docs inside directory, and return the cover
# art we find.
def _arturifordir(self, diridx):
for nm,ids in self._dirvec[diridx].iteritems():
if ids[1] >= 0:
doc = self._rcldocs[ids[1]]
if doc.mtype != 'inode/directory' and doc.albumarturi:
return doc.albumarturi
# Folder hierarchy browse method.
# objid is like folders$index
# flag is meta or children.
def browse(self, pid, flag):
diridx = self._objidtodiridx(pid)
# If there is only one entry in root, skip it. This means that 0
# and 1 point to the same dir, but this does not seem to be an
# issue
if diridx == 0 and len(self._dirvec[0]) == 2:
diridx = 1
entries = []
# The basename call is just for diridx==0 (topdirs). Remove it if
# this proves a performance issue
for nm,ids in self._dirvec[diridx].iteritems():
if nm == "..":
continue
thisdiridx = ids[0]
thisdocidx = ids[1]
if thisdocidx >= 0:
doc = self._rcldocs[thisdocidx]
else:
uplog("No doc for %s" % pid)
doc = None
if thisdiridx >= 0:
# Skip empty directories
if len(self._dirvec[thisdiridx]) == 1:
continue
id = self._idprefix + '$' + 'd' + str(thisdiridx)
if doc and doc.albumarturi:
arturi = doc.albumarturi
else:
arturi = self._arturifordir(thisdiridx)
entries.append(rcldirentry(id, pid, os.path.basename(nm),
arturi=arturi))
else:
# Not a directory. docidx had better been set
if thisdocidx == -1:
uplog("folders:docidx -1 for non-dir entry %s"%nm)
continue
doc = self._rcldocs[thisdocidx]
id = self._idprefix + '$i' + str(thisdocidx)
e = rcldoctoentry(id, pid, self._httphp, self._pprefix, doc)
if e:
entries.append(e)
return sorted(entries, cmp=cmpentries)
# Return path for objid, which has to be a container.This is good old
# pwd... It is called from the search module for generating a 'dir:'
# recoll filtering directive.
def dirpath(self, objid):
# We may get called from search, on the top dir (above
# [folders]). Return empty in this case
try:
diridx = self._objidtodiridx(objid)
except:
return ""
if diridx == 0:
return "/"
lpath = []
while True:
fathidx = self._dirvec[diridx][".."][0]
for nm, ids in self._dirvec[fathidx].iteritems():
if ids[0] == diridx:
lpath.append(nm)
break
diridx = fathidx
if diridx == 0:
break
if not lpath:
path = "/"
else:
path = ""
for elt in reversed(lpath):
path += elt + "/"
return path