diff libervia/backend/plugins/plugin_misc_static_blog.py @ 4071:4b842c1fb686

refactoring: renamed `sat` package to `libervia.backend`
author Goffi <goffi@goffi.org>
date Fri, 02 Jun 2023 11:49:51 +0200
parents sat/plugins/plugin_misc_static_blog.py@524856bd7b19
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libervia/backend/plugins/plugin_misc_static_blog.py	Fri Jun 02 11:49:51 2023 +0200
@@ -0,0 +1,108 @@
+#!/usr/bin/env python3
+
+
+# SAT plugin for static blogs
+# Copyright (C) 2014 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 libervia.backend.core.log import getLogger
+
+log = getLogger(__name__)
+
+from libervia.backend.core.i18n import _, D_
+from libervia.backend.core.constants import Const as C
+from libervia.backend.core import exceptions
+from libervia.backend.tools import xml_tools
+
+from twisted.internet import defer
+from twisted.words.protocols.jabber import jid
+
+
+PLUGIN_INFO = {
+    C.PI_NAME: "Static Blog Plugin",
+    C.PI_IMPORT_NAME: "STATIC-BLOG",
+    C.PI_TYPE: "MISC",
+    C.PI_PROTOCOLS: [],
+    C.PI_DEPENDENCIES: [],
+    C.PI_RECOMMENDATIONS: [
+        "MISC-ACCOUNT"
+    ],  # TODO: remove when all blogs can be retrieved
+    C.PI_MAIN: "StaticBlog",
+    C.PI_HANDLER: "no",
+    C.PI_DESCRIPTION: _("""Plugin for static blogs"""),
+}
+
+
+class StaticBlog(object):
+
+    params = """
+    <params>
+    <individual>
+    <category name="{category_name}" label="{category_label}">
+        <param name="{title_name}" label="{title_label}" value="" type="string" security="0"/>
+        <param name="{banner_name}" label="{banner_label}" value="" type="string" security="0"/>
+        <param name="{background_name}" label="{background_label}" value ="" type="string" security="0"/>
+        <param name="{keywords_name}" label="{keywords_label}" value="" type="string" security="0"/>
+        <param name="{description_name}" label="{description_label}" value="" type="string" security="0"/>
+     </category>
+    </individual>
+    </params>
+    """.format(
+        category_name=C.STATIC_BLOG_KEY,
+        category_label=D_(C.STATIC_BLOG_KEY),
+        title_name=C.STATIC_BLOG_PARAM_TITLE,
+        title_label=D_("Page title"),
+        banner_name=C.STATIC_BLOG_PARAM_BANNER,
+        banner_label=D_("Banner URL"),
+        background_name="Background",
+        background_label=D_("Background image URL"),
+        keywords_name=C.STATIC_BLOG_PARAM_KEYWORDS,
+        keywords_label=D_("Keywords"),
+        description_name=C.STATIC_BLOG_PARAM_DESCRIPTION,
+        description_label=D_("Description"),
+    )
+
+    def __init__(self, host):
+        try:  # TODO: remove this attribute when all blogs can be retrieved
+            self.domain = host.plugins["MISC-ACCOUNT"].account_domain_new_get()
+        except KeyError:
+            self.domain = None
+        host.memory.update_params(self.params)
+        # host.import_menu((D_("User"), D_("Public blog")), self._display_public_blog, security_limit=1, help_string=D_("Display public blog page"), type_=C.MENU_JID_CONTEXT)
+
+    def _display_public_blog(self, menu_data, profile):
+        """Check if the blog can be displayed and answer the frontend.
+
+        @param menu_data: %(menu_data)s
+        @param profile: %(doc_profile)s
+        @return: dict
+        """
+        # FIXME: "public_blog" key has been removed
+        # TODO: replace this with a more generic widget call with URIs
+        try:
+            user_jid = jid.JID(menu_data["jid"])
+        except KeyError:
+            log.error(_("jid key is not present !"))
+            return defer.fail(exceptions.DataError)
+
+        # TODO: remove this check when all blogs can be retrieved
+        if self.domain and user_jid.host != self.domain:
+            info_ui = xml_tools.XMLUI("popup", title=D_("Not available"))
+            info_ui.addText(
+                D_("Retrieving a blog from an external domain is not implemented yet.")
+            )
+            return {"xmlui": info_ui.toXml()}
+
+        return {"public_blog": user_jid.userhost()}