Mercurial > libervia-backend
view src/plugins/plugin_misc_xmllog.py @ 2169:f472179305a1
tools(templates): workflow improvments:
- template theme can be specified in parenthesis: (some_theme)path/to/template.html. Withtout parenthesis, "default" is used
- static content are supposed to be in [theme]/static, error pages in [theme]/error/[err_code].html
- default page are used in some case (2 for now): if error page with specified code doesn't exists, a base page is used, and if a page doesn't exist for a theme, the same one for default theme is looked for
- CSS files are automatically found for HTML pages
- CSS files can be split, the'll be added in the template according to the page requested.
- theme CSS file is looked for, and if not found the default theme equivalent is looked for.
- each element of a path can be associated to a CSS file, and styles.css is always there. For instance if blog/articles.html is requested, the following CSS can be included: "styles.css", "blog.css", "blog_article.css". They all must be in /static
- if the automatic finding of CSS files is not wanted, css_files arguments can be used instead, with full relative path (i.e. including theme)
- CSS files can be merged and included inline with css_inline argument
- root_path can be specified, it will be used as a prefix for static files
- requested theme (which may differ from actual theme, e.g. if the template is not found and default one is used instead) is available in template with "theme" variable
- added getThemeAndRoot method to retrieve theme and theme root path from template
author | Goffi <goffi@goffi.org> |
---|---|
date | Sun, 05 Mar 2017 23:41:10 +0100 |
parents | 33c8c4973743 |
children | 51d346e283fd |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # SàT plugin for managing raw XML log # Copyright (C) 2011 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 log = getLogger(__name__) from twisted.words.protocols.jabber.xmlstream import XmlStream from twisted.words.xish import domish PLUGIN_INFO = { C.PI_NAME: "Raw XML log Plugin", C.PI_IMPORT_NAME: "XmlLog", C.PI_TYPE: "Misc", C.PI_PROTOCOLS: [], C.PI_DEPENDENCIES: [], C.PI_MAIN: "XmlLog", C.PI_HANDLER: "no", C.PI_DESCRIPTION: _("""Send raw XML logs to bridge""") } class LoggingXmlStream(XmlStream): """This class send the raw XML to the Bridge, for logging purpose""" def send(self, obj): if isinstance(obj, basestring): log = unicode(obj) elif isinstance(obj, domish.Element): log = obj.toXml() else: log.error(_('INTERNAL ERROR: Unmanaged XML type')) self._host.bridge.xmlLog("OUT", log, self._profile) return XmlStream.send(self, obj) def dataReceived(self, data): # FIXME: we use "replace" here because a big stanza can be cut in the middle of a unicode char # this plugin should probably moved to a better place, where stanzas are fully received self._host.bridge.xmlLog("IN", data.decode('utf-8', 'replace'), self._profile) return XmlStream.dataReceived(self, data) class XmlLog(object): params = """ <params> <general> <category name="Debug"> <param name="Xml log" label="%(label_xmllog)s" value="false" type="bool" /> </category> </general> </params> """ % {"label_xmllog": _("Activate XML log")} def __init__(self, host): log.info(_("Plugin XML Log initialization")) self.host = host #parameters host.memory.updateParams(self.params) #bridge host.bridge.addSignal("xmlLog", ".plugin", signature='sss') # args: direction("IN" or "OUT"), xml_data, profile do_log = self.host.memory.getParamA("Xml log", "Debug") if do_log: log.info(_("XML log activated")) host.trigger.add("XML Initialized", self.logXml) def logXml(self, xmlstream, profile): xmlstream.__class__ = LoggingXmlStream xmlstream._profile = profile xmlstream._host = self.host return True