import re
from loguru import logger
from flexget import plugin
from flexget.entry import Entry
from flexget.event import event
from flexget.manager import Session
from . import db
logger = logger.bind(name='archive')
[docs]
class Archive:
"""Archive all new items into database where they can be later searched and injected.
Stores the entries in the state as they are at the exit phase, this way task cleanup for title
etc is stored into the database. This may however make injecting them back to the original task work
wrongly.
"""
schema = {'oneOf': [{'type': 'boolean'}, {'type': 'array', 'items': {'type': 'string'}}]}
[docs]
def on_task_learn(self, task, config):
"""Add new entries into archive. We use learn phase in case the task corrects title or url via some plugins."""
tag_names = [] if isinstance(config, bool) else config
tags = [db.get_tag(tag_name, task.session) for tag_name in set(tag_names)]
count = 0
processed = []
for entry in task.entries + task.rejected + task.failed:
# I think entry can be in multiple of those lists .. not sure though!
if entry in processed:
continue
processed.append(entry)
ae = (
task.session
.query(db.ArchiveEntry)
.filter(db.ArchiveEntry.title == entry['title'])
.filter(db.ArchiveEntry.url == entry['url'])
.first()
)
if ae:
# add (missing) sources
source = db.get_source(task.name, task.session)
if source not in ae.sources:
logger.debug('Adding `{}` into `{}` sources', task.name, ae)
ae.sources.append(source)
# add (missing) tags
for tag_name in tag_names:
atag = db.get_tag(tag_name, task.session)
if atag not in ae.tags:
logger.debug('Adding tag {} into {}', tag_name, ae)
ae.tags.append(atag)
else:
# create new archive entry
ae = db.ArchiveEntry()
ae.title = entry['title']
ae.url = entry['url']
if 'description' in entry:
ae.description = entry['description']
ae.task = task.name
ae.sources.append(db.get_source(task.name, task.session))
if tags:
# note, we're extending empty list
ae.tags.extend(tags)
logger.debug('Adding `{}` with {} tags to archive', ae, len(tags))
task.session.add(ae)
count += 1
if count:
logger.verbose('Added {} new entries to archive', count)
[docs]
def on_task_abort(self, task, config):
"""Archive even on task abort, except if the abort has happened before session was started."""
if task.session is not None:
self.on_task_learn(task, config)
[docs]
class UrlrewriteArchive:
"""Provides capability to rewrite urls from archive or make searches with discover."""
entry_map = {'title': 'title', 'url': 'url', 'description': 'description'}
schema = {'oneOf': [{'type': 'boolean'}, {'type': 'array', 'items': {'type': 'string'}}]}
[docs]
def search(self, task, entry, config=None):
"""Search plugin API method."""
session = Session()
entries = set()
tag_names = None if isinstance(config, bool) else config
try:
for query in entry.get('search_strings', [entry['title']]):
# clean some characters out of the string for better results
query = re.sub(r'[ \(\)\:]+', ' ', query).strip()
logger.debug('looking for `{}` config: {}', query, config)
for archive_entry in db.search(session, query, tags=tag_names, desc=True):
logger.debug('rewrite search result: {}', archive_entry)
entry = Entry()
entry.update_using_map(self.entry_map, archive_entry, ignore_none=True)
if entry.isvalid():
entries.add(entry)
finally:
session.close()
logger.debug('found {} entries', len(entries))
return entries
[docs]
@event('plugin.register')
def register_plugin():
plugin.register(Archive, 'archive', api_ver=2)
plugin.register(UrlrewriteArchive, 'flexget_archive', interfaces=['search'], api_ver=2)
