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 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
|
"""
This file is part of xapers.
Xapers 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.
Xapers 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 xapers. If not, see <http://www.gnu.org/licenses/>.
Copyright 2012-2017
Jameson Rollins <jrollins@finestructure.net>
"""
import os
import shutil
import xapian
from .parser import parse_data
from .source import Sources
from .bibtex import Bibtex
##################################################
class DocumentError(Exception):
"""Base class for Xapers document exceptions."""
def __init__(self, msg):
self.msg = msg
def __str__(self):
return self.msg
##################################################
class Documents():
"""Represents a set of Xapers documents given a Xapian mset."""
def __init__(self, db, mset):
self.db = db
self.mset = mset
self.index = -1
self.max = len(mset)
def __getitem__(self, index):
m = self.mset[index]
doc = Document(self.db, m.document)
doc.matchp = m.percent
return doc
def __iter__(self):
return self
def __len__(self):
return self.max
def next(self):
self.index = self.index + 1
if self.index == self.max:
raise StopIteration
return self[self.index]
##################################################
class Document():
"""Represents a single Xapers document."""
def __init__(self, db, xapian_doc=None, docid=None):
# Xapers db
self.db = db
# if Xapian doc provided, initiate for that document
if xapian_doc:
self.xapian_doc = xapian_doc
self.docid = xapian_doc.get_docid()
# else, create a new empty document
# document won't be added to database until sync is called
else:
self.xapian_doc = xapian.Document()
# use specified docid if provided
if docid:
if docid in self.db:
raise DocumentError('Document already exists for id %d.' % docid)
self.docid = docid
else:
self.docid = self.db._generate_docid()
self._add_term(self.db._find_prefix('id'), self.docid)
# specify a directory in the Xapers root for document data
self.docdir = os.path.join(self.db.root, '%010d' % self.docid)
self.bibentry = None
self._infiles = {}
def get_docid(self):
"""Return document id of document."""
return self.docid
########################################
def _make_docdir(self):
if os.path.exists(self.docdir):
if not os.path.isdir(self.docdir):
raise DocumentError('File exists at intended docdir location: %s' % self.docdir)
else:
os.makedirs(self.docdir)
def _write_files(self):
for name, data in self._infiles.iteritems():
path = os.path.join(self.docdir, name)
with open(path, 'w') as f:
f.write(data)
def _write_bibfile(self):
bibpath = self.get_bibpath()
# reload bibtex only if we have new files
paths = self.get_fullpaths()
if paths:
self._load_bib()
if self.bibentry:
# we put only the first file in the bibtex
# FIXME: does jabref/mendeley spec allow for multiple files?
if paths and not self.bibentry.get_file():
self.bibentry.set_file(paths[0])
self.bibentry.to_file(bibpath)
def _write_tagfile(self):
with open(os.path.join(self.docdir, 'tags'), 'w') as f:
for tag in self.get_tags():
f.write(tag)
f.write('\n')
def _rm_docdir(self):
if os.path.exists(self.docdir) and os.path.isdir(self.docdir):
shutil.rmtree(self.docdir)
def sync(self):
"""Sync document to database."""
# FIXME: add value for modification time
# FIXME: catch db not writable errors
try:
self._make_docdir()
self._write_files()
self._write_bibfile()
self._write_tagfile()
self.db.replace_document(self.docid, self.xapian_doc)
except:
self._rm_docdir()
raise
def purge(self):
"""Purge document from database and root."""
# FIXME: catch db not writable errors
try:
self.db.delete_document(self.docid)
except xapian.DocNotFoundError:
pass
self._rm_docdir()
self.docid = None
########################################
# internal stuff
# add an individual prefix'd term for the document
def _add_term(self, prefix, value):
term = '%s%s' % (prefix, value)
self.xapian_doc.add_term(term)
# remove an individual prefix'd term for the document
def _remove_term(self, prefix, value):
term = '%s%s' % (prefix, value)
try:
self.xapian_doc.remove_term(term)
except xapian.InvalidArgumentError:
pass
# Parse 'text' and add a term to 'message' for each parsed
# word. Each term will be added both prefixed (if prefix is not
# None) and non-prefixed.
# http://xapian.org/docs/bindings/python/
# http://xapian.org/docs/quickstart.html
# http://www.flax.co.uk/blog/2009/04/02/xapian-search-architecture/
def _gen_terms(self, prefix, text):
term_gen = self.db.term_gen
term_gen.set_document(self.xapian_doc)
if prefix:
term_gen.index_text(text, 1, prefix)
term_gen.index_text(text)
# return a list of terms for prefix
def _term_iter(self, prefix=None):
term_iter = iter(self.xapian_doc)
if prefix:
plen = len(prefix)
term = term_iter.skip_to(prefix)
if not term.term.startswith(prefix):
return
yield term.term[plen:]
for term in term_iter:
if prefix:
if not term.term.startswith(prefix):
break
yield term.term[plen:]
else:
yield term.term
def term_iter(self, name=None):
"""Iterator over all terms in the document.
If a prefix is provided, will iterate over only the prefixed
terms, and the prefix will be removed from the returned terms.
"""
prefix = None
if name:
prefix = self.db._find_prefix(name)
if not prefix:
prefix = name
return self._term_iter(prefix)
# set the data object for the document
def _set_data(self, text):
self.xapian_doc.set_data(text)
def get_data(self):
"""Get data object for document."""
return self.xapian_doc.get_data()
########################################
# files
def add_file_data(self, name, data):
"""Add a file data to document.
'name' is the name of the file, 'data' is the file data,
e.g. a string of text extracted from the document.
File will not copied into docdir until sync().
"""
# FIXME: set mime type term
# parse the file data into text
text = parse_data(data)
# generate terms from the text
self._gen_terms(None, text)
# set data to be text sample
# FIXME: is this the right thing to put in the data?
summary = text[0:997] + '...'
self._set_data(summary)
# FIXME: should files be renamed to something generic (0.pdf)?
prefix = self.db._find_prefix('file')
self._add_term(prefix, name)
# add it to the cache to be written at sync()
self._infiles[name] = data
def add_file(self, infile):
"""Add a file to document.
Added file will have the same name.
File will not copied in to docdir until sync().
"""
with open(infile, 'r') as f:
data = f.read()
name = os.path.basename(infile)
self.add_file_data(name, data)
def get_files(self):
"""Return files associated with document."""
return list(self.term_iter('file'))
def get_fullpaths(self):
"""Return fullpaths of files associated with document."""
list = []
for path in self.get_files():
# FIXME: this is a hack for old path specifications that
# included the docdir
path = os.path.basename(path)
list.append(os.path.join(self.docdir, path))
return list
########################################
# SOURCES
def _purge_sources_prefix(self, source):
# purge all terms for a given source prefix
prefix = self.db._make_source_prefix(source)
for i in self._term_iter(prefix):
self._remove_term(prefix, i)
self._remove_term(self.db._find_prefix('source'), source)
def add_sid(self, sid):
"""Add source sid to document."""
source, oid = sid.split(':', 1)
source = source.lower()
# remove any existing terms for this source
self._purge_sources_prefix(source)
# add a term for the source
self._add_term(self.db._find_prefix('source'), source)
# add a term for the sid, with source as prefix
self._add_term(self.db._make_source_prefix(source), oid)
def get_sids(self):
"""Return a list of sids for document."""
sids = []
for source in self.term_iter('source'):
for oid in self._term_iter(self.db._make_source_prefix(source)):
sids.append('%s:%s' % (source, oid))
return sids
# TAGS
def add_tags(self, tags):
"""Add tags from list to document."""
prefix = self.db._find_prefix('tag')
for tag in tags:
self._add_term(prefix, tag)
def get_tags(self):
"""Return a list of tags associated with document."""
return list(self.term_iter('tag'))
def remove_tags(self, tags):
"""Remove tags from a document."""
prefix = self.db._find_prefix('tag')
for tag in tags:
self._remove_term(prefix, tag)
# TITLE
def _set_title(self, title):
pt = self.db._find_prefix('title')
for term in self._term_iter(pt):
self._remove_term(pt, term)
# FIXME: what's the clean way to get these prefixes?
for term in self._term_iter('ZS'):
self._remove_term('ZS', term)
self._gen_terms(pt, title)
# AUTHOR
def _set_authors(self, authors):
pa = self.db._find_prefix('author')
for term in self._term_iter(pa):
self._remove_term(pa, term)
# FIXME: what's the clean way to get these prefixes?
for term in self._term_iter('ZA'):
self._remove_term('ZA', term)
self._gen_terms(pa, authors)
# YEAR
def _set_year(self, year):
# FIXME: what to do if year is not an int?
try:
year = int(year)
except ValueError:
pass
prefix = self.db._find_prefix('year')
for term in self._term_iter(prefix):
self._remove_term(prefix, year)
self._add_term(prefix, year)
facet = self.db._find_facet('year')
self.xapian_doc.add_value(facet, xapian.sortable_serialise(year))
########################################
# bibtex
def get_bibpath(self):
"""Return path to document bibtex file."""
return os.path.join(self.docdir, 'bibtex')
def _set_bibkey(self, key):
prefix = self.db._find_prefix('key')
for term in self._term_iter(prefix):
self._remove_term(prefix, term)
self._add_term(prefix, key)
def _index_bibentry(self, bibentry):
authors = bibentry.get_authors()
fields = bibentry.get_fields()
if 'title' in fields:
self._set_title(fields['title'])
if 'year' in fields:
self._set_year(fields['year'])
if authors:
# authors should be a list, so we make a single text string
# FIXME: better way to do this?
self._set_authors(' '.join(authors))
# add any sources in the bibtex
for source in Sources().scan_bibentry(bibentry):
self.add_sid(source.sid)
# FIXME: index 'keywords' field as regular terms
self._set_bibkey(bibentry.key)
def add_bibentry(self, bibentry):
"""Add bibentry object."""
self.bibentry = bibentry
self._index_bibentry(self.bibentry)
def add_bibtex(self, bibtex):
"""Add bibtex to document, as string or file path."""
self.add_bibentry(Bibtex(bibtex)[0])
def _load_bib(self):
if self.bibentry:
return
bibpath = self.get_bibpath()
if os.path.exists(bibpath):
self.bibentry = Bibtex(bibpath)[0]
def get_bibtex(self):
"""Get the bib for document as a bibtex string."""
bibpath = self.get_bibpath()
if os.path.exists(bibpath):
with open(bibpath, 'r') as f:
bibtex = f.read().decode('utf-8')
return bibtex.strip()
def get_bibdata(self):
self._load_bib()
if self.bibentry:
data = self.bibentry.get_fields()
data['authors'] = self.bibentry.get_authors()
return data
def update_from_bibtex(self):
"""Update document metadata from document bibtex."""
self._load_bib()
self._index_bibentry(self.bibentry)
########################################
def get_key(self):
"""Get the document key."""
# FIXME: get from facet not bib
self._load_bib()
if not self.bibentry:
return
return self.bibentry.key
def get_title(self):
"""Get document full title from bibtex."""
self._load_bib()
if not self.bibentry:
return
fields = self.bibentry.get_fields()
if 'title' in fields:
return fields['title']
def get_year(self):
"""Get document year from bibtex."""
# FIXME: get from facet not bib
self._load_bib()
if not self.bibentry:
return
fields = self.bibentry.get_fields()
if 'year' in fields:
return fields['year']
def get_urls(self):
"""Get all URLs associated with document."""
sources = Sources()
urls = []
# get urls associated with known sources
for sid in self.get_sids():
urls.append(sources[sid].url)
# get urls from bibtex
self._load_bib()
if self.bibentry:
fields = self.bibentry.get_fields()
if 'url' in fields:
urls.append(fields['url'])
if 'adsurl' in fields:
urls.append(fields['adsurl'])
return urls
|