Mercurial > libervia-backend
view src/plugins/plugin_misc_welcome.py @ 1814:602a47ccc07c
plugin XEP-0277: removed cleanXHTML on output data:
- while it is mandatory to clean input data, output data sent by frontends should and need to be clean
- cleaning all output data means that we can't send be sure that all the XHTML we send is not modified
- it's a waste of resources as cleaning today reparse the data with lxml
- behaviour may change in the future (e.g. having an option to use cleaning on output data)
author | Goffi <goffi@goffi.org> |
---|---|
date | Tue, 19 Jan 2016 12:21:38 +0100 |
parents | d17772b0fe22 |
children | 2daf7b4c6756 |
line wrap: on
line source
#!/usr/bin/python # -*- coding: utf-8 -*- # SAT plugin for file tansfer # Copyright (C) 2009-2016 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 _, D_ from sat.core.constants import Const as C from sat.core.log import getLogger log = getLogger(__name__) from sat.tools import xml_tools PLUGIN_INFO = { "name": "Welcome", "import_name": "WELCOME", "type": C.PLUG_TYPE_MISC, "main": "Welcome", "handler": "no", "description": _("""Plugin which manage welcome message and things to to on first connection.""") } WELCOME_PARAM_CATEGORY = "General" WELCOME_PARAM_NAME = "welcome" WELCOME_PARAM_LABEL = D_(u"Display welcome message") WELCOME_MSG_TITLE = D_(u"Welcome to Libervia/Salut à Toi") # XXX: this message is mainly targetting libervia new users for now # (i.e.: it may look weird on other frontends) WELCOME_MSG = D_(u"""Welcome to a free (as in freedom) network! If you have any trouble, or you want to help us for the bug hunting, you can contact us in real time chat by using the “Help / Official chat room” menu. To use Libervia, you'll need to add contacts, either people you know, or people you discover by using the “Contacts / Search directory” menu. We hope that you'll enjoy using this project. The Libervia/Salut à Toi Team """) PARAMS = """ <params> <individual> <category name="{category}"> <param name="{name}" label="{label}" type="bool" /> </category> </individual> </params> """.format(category=WELCOME_PARAM_CATEGORY, name=WELCOME_PARAM_NAME, label=WELCOME_PARAM_LABEL) class Welcome(object): def __init__(self, host): log.info(_("plugin Welcome initialization")) self.host = host host.memory.updateParams(PARAMS) def profileConnected(self, profile): # XXX: if you wan to try first_start again, you'll have to remove manually # the welcome value from your profile params in sat.db welcome = self.host.memory.params.getParamA(WELCOME_PARAM_NAME, WELCOME_PARAM_CATEGORY, use_default=False, profile_key=profile) if welcome is None: first_start = True welcome = True else: first_start = False if welcome: xmlui = xml_tools.note(WELCOME_MSG, WELCOME_MSG_TITLE) self.host.actionNew({'xmlui': xmlui.toXml()}, profile=profile) self.host.memory.setParam(WELCOME_PARAM_NAME, C.BOOL_FALSE, WELCOME_PARAM_CATEGORY, profile_key=profile) self.host.trigger.point("WELCOME", first_start, welcome, profile)