libervia-backend: src/plugins/plugin_misc_extra

annotate src/plugins/plugin_misc_extra_pep.py @ 2109:85f3e12e984d

core (memory/cache): file caching handling, first draft: instead of having file caching handled individually by plugins, a generic module has been added in memory. - Cache can be global or associated to a profile. In the later case, client.cache can be used. - Cache are managed with unique ids (which can be any unique unicode, hash uuid, or something else). - To know if a file is in cache, getFilePath is used: if the file is in cache, its absolute path is returned, else None is returned. - To cache a file, cacheData is used with at list the source of cache (most of time plugin import name), and unique id. The method return file opened in binary writing mode (so cacheData can - and should - be used with "with" statement). - 2 files will be created: a metadata file (named after the unique id), and the actual file. - each file has a end of life time, after it, the cache is invalidated and the file must be requested again.

author	Goffi <goffi@goffi.org>
date	Thu, 05 Jan 2017 20:23:38 +0100
parents	2daf7b4c6756
children	33c8c4973743

rev	line source
1934 2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang Goffi <goffi@goffi.org> parents: 1746 diff changeset	1 #!/usr/bin/env python2
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	2 # -- coding: utf-8 --
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	3
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	4 # SAT plugin for displaying messages from extra PEP services
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	5 # Copyright (C) 2015 Adrien Cossa (souliane@mailoo.org)
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	6
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	10 # (at your option) any later version.
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	11
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	16
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	19
1741 cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	20 from sat.core.i18n import _, D_
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	21 from sat.core.log import getLogger
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	22 log = getLogger(__name__)
1744 9a48e09044eb plugin extra_pep, params: fixed insecure building of jids_list Goffi <goffi@goffi.org> parents: 1741 diff changeset	23 from sat.memory import params
9a48e09044eb plugin extra_pep, params: fixed insecure building of jids_list Goffi <goffi@goffi.org> parents: 1741 diff changeset	24 from twisted.words.protocols.jabber import jid
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	25
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	26
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	27 PLUGIN_INFO = {
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	28 "name": "Extra PEP",
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	29 "import_name": "EXTRA-PEP",
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	30 "type": "MISC",
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	31 "protocols": [],
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	32 "dependencies": [],
1741 cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	33 "recommendations": [],
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	34 "main": "ExtraPEP",
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	35 "handler": "no",
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	36 "description": _(u"""Display messages from extra PEP services""")
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	37 }
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	38
1744 9a48e09044eb plugin extra_pep, params: fixed insecure building of jids_list Goffi <goffi@goffi.org> parents: 1741 diff changeset	39
1741 cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	40 PARAM_KEY = u"Misc"
1746 0dfabe746ec4 plugin extra_pep: replaced name by a short one Goffi <goffi@goffi.org> parents: 1744 diff changeset	41 PARAM_NAME = u"blogs"
0dfabe746ec4 plugin extra_pep: replaced name by a short one Goffi <goffi@goffi.org> parents: 1744 diff changeset	42 PARAM_LABEL = u"Blog authors following list"
1744 9a48e09044eb plugin extra_pep, params: fixed insecure building of jids_list Goffi <goffi@goffi.org> parents: 1741 diff changeset	43 PARAM_DEFAULT = (jid.JID("salut-a-toi@libervia.org"),)
9a48e09044eb plugin extra_pep, params: fixed insecure building of jids_list Goffi <goffi@goffi.org> parents: 1741 diff changeset	44
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	45
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	46 class ExtraPEP(object):
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	47
1741 cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	48 params = """
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	49 <params>
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	50 <individual>
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	51 <category name="%(category_name)s" label="%(category_label)s">
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	52 <param name="%(param_name)s" label="%(param_label)s" type="jids_list" security="0">
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	53 %(jids)s
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	54 </param>
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	55 </category>
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	56 </individual>
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	57 </params>
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	58 """ % {
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	59 'category_name': PARAM_KEY,
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	60 'category_label': D_(PARAM_KEY),
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	61 'param_name': PARAM_NAME,
1746 0dfabe746ec4 plugin extra_pep: replaced name by a short one Goffi <goffi@goffi.org> parents: 1744 diff changeset	62 'param_label': D_(PARAM_LABEL),
1744 9a48e09044eb plugin extra_pep, params: fixed insecure building of jids_list Goffi <goffi@goffi.org> parents: 1741 diff changeset	63 'jids': u"\n".join({elt.toXml() for elt in params.createJidElts(PARAM_DEFAULT)})
1741 cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	64 }
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	65
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	66 def __init__(self, host):
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	67 log.info(_(u"Plugin Extra PEP initialization"))
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	68 self.host = host
1741 cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	69 host.memory.updateParams(self.params)
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: diff changeset	70
1741 cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	71 def getFollowedEntities(self, profile_key):
cc31dd72526d plugin misc_extra_pep: use a user parameter (jids_list) instead of a general configuration value souliane <souliane@mailoo.org> parents: 1728 diff changeset	72 return self.host.memory.getParamA(PARAM_NAME, PARAM_KEY, profile_key=profile_key)

Mercurial > libervia-backend

annotate src/plugins/plugin_misc_extra_pep.py @ 2109:85f3e12e984d