Mercurial > libervia-backend
view sat/plugins/plugin_misc_uri_finder.py @ 3187:d92a144f3589
plugin download: use cache if dest_path is empty:
if dest_path is not set, the file will be downloaded in cache. A new name will be
generated using a hash of the uri. If the file is already downloded in cache, it won't be
downloaded again (in this case returned progress_id is an empty string).
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 26 Feb 2020 22:03:11 +0100 |
parents | 559a625a236b |
children | be6d91572633 |
line wrap: on
line source
#!/usr/bin/env python3 # SAT plugin to find URIs # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero 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 Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. from sat.core.i18n import _ from sat.core.constants import Const as C from sat.core.log import getLogger from twisted.internet import defer import textwrap log = getLogger(__name__) import json import os.path import os import re PLUGIN_INFO = { C.PI_NAME: _("URI finder"), C.PI_IMPORT_NAME: "uri_finder", C.PI_TYPE: "EXP", C.PI_PROTOCOLS: [], C.PI_DEPENDENCIES: [], C.PI_MAIN: "URIFinder", C.PI_HANDLER: "no", C.PI_DESCRIPTION: textwrap.dedent(_("""\ Plugin to find URIs in well know location. This allows to retrieve settings to work with a project (e.g. pubsub node used for merge-requests). """)) } SEARCH_FILES = ('readme', 'contributing') class URIFinder(object): def __init__(self, host): log.info(_("URI finder plugin initialization")) self.host = host host.bridge.addMethod("URIFind", ".plugin", in_sign='sas', out_sign='a{sa{ss}}', method=self.find, async_=True) def find(self, path, keys): """Look for URI in well known locations @param path(unicode): path to start with @param keys(list[unicode]): keys lookeds after e.g.: "tickets", "merge-requests" @return (dict[unicode, unicode]): map from key to found uri """ keys_re = '|'.join(keys) label_re = r'"(?P<label>[^"]+)"' uri_re = re.compile(r'(?P<key>{keys_re})[ :]? +(?P<uri>xmpp:\S+)(?:.*use {label_re} label)?'.format( keys_re=keys_re, label_re = label_re)) path = os.path.normpath(path) if not os.path.isdir(path) or not os.path.isabs(path): raise ValueError('path must be an absolute path to a directory') found_uris = {} while path != '/': for filename in os.listdir(path): name, __ = os.path.splitext(filename) if name.lower() in SEARCH_FILES: file_path = os.path.join(path, filename) with open(file_path) as f: for m in uri_re.finditer(f.read()): key = m.group('key') uri = m.group('uri') label = m.group('label') if key in found_uris: log.warning(_("Ignoring already found uri for key \"{key}\"").format(key=key)) else: uri_data = found_uris[key] = {'uri': uri} if label is not None: uri_data['labels'] = json.dumps([label]) if found_uris: break path = os.path.dirname(path) return defer.succeed(found_uris)