libervia-backend/sat/plugins/plugin_misc_extra_pep.py
Goffi 6a6f15707a massive refactoring to switch from camelCase to snake_case:
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a
pre-PEP8 code, to use the same coding style as in Twisted.

However, snake_case is more readable and it's better to follow PEP8 best practices, so it
has been decided to move on full snake_case. Because Libervia has a huge codebase, this
ended with a ugly mix of camelCase and snake_case.

To fix that, this patch does a big refactoring by renaming every function and method
(including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case.

This is a massive change, and may result in some bugs.
2023-04-08 13:54:42 +02:00

74 lines
2.3 KiB
Python

#!/usr/bin/env python3
# SAT plugin for displaying messages from extra PEP services
# Copyright (C) 2015 Adrien Cossa (souliane@mailoo.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 _, D_
from sat.core.constants import Const as C
from sat.core.log import getLogger
log = getLogger(__name__)
from sat.memory import params
from twisted.words.protocols.jabber import jid
PLUGIN_INFO = {
C.PI_NAME: "Extra PEP",
C.PI_IMPORT_NAME: "EXTRA-PEP",
C.PI_TYPE: "MISC",
C.PI_PROTOCOLS: [],
C.PI_DEPENDENCIES: [],
C.PI_RECOMMENDATIONS: [],
C.PI_MAIN: "ExtraPEP",
C.PI_HANDLER: "no",
C.PI_DESCRIPTION: _("""Display messages from extra PEP services"""),
}
PARAM_KEY = "Misc"
PARAM_NAME = "blogs"
PARAM_LABEL = "Blog authors following list"
PARAM_DEFAULT = (jid.JID("salut-a-toi@libervia.org"),)
class ExtraPEP(object):
params = """
<params>
<individual>
<category name="%(category_name)s" label="%(category_label)s">
<param name="%(param_name)s" label="%(param_label)s" type="jids_list" security="0">
%(jids)s
</param>
</category>
</individual>
</params>
""" % {
"category_name": PARAM_KEY,
"category_label": D_(PARAM_KEY),
"param_name": PARAM_NAME,
"param_label": D_(PARAM_LABEL),
"jids": "\n".join({elt.toXml() for elt in params.create_jid_elts(PARAM_DEFAULT)}),
}
def __init__(self, host):
log.info(_("Plugin Extra PEP initialization"))
self.host = host
host.memory.update_params(self.params)
def get_followed_entities(self, profile_key):
return self.host.memory.param_get_a(PARAM_NAME, PARAM_KEY, profile_key=profile_key)