core, setup: huge cleaning:
- moved directories from src and frontends/src to sat and sat_frontends, which is the recommanded naming convention - move twisted directory to root - removed all hacks from setup.py, and added missing dependencies, it is now clean - use https URL for website in setup.py - removed "Environment :: X11 Applications :: GTK", as wix is deprecated and removed - renamed sat.sh to sat and fixed its installation - added python_requires to specify Python version needed - replaced glib2reactor which use deprecated code by gtk3reactor sat can now be installed directly from virtualenv without using --system-site-packages anymore \o/
This commit is contained in:
parent
4afd2ff26f
commit
80ef13612b
9 changed files with 42 additions and 269 deletions
0
sat/tools/common/__init__.py
Normal file
0
sat/tools/common/__init__.py
Normal file
54
sat/tools/common/ansi.py
Normal file
54
sat/tools/common/ansi.py
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
#!/usr/bin/env python2
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# SàT: a XMPP client
|
||||
# Copyright (C) 2009-2018 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/>.
|
||||
|
||||
import sys
|
||||
|
||||
class ANSI(object):
|
||||
|
||||
## ANSI escape sequences ##
|
||||
RESET = '\033[0m'
|
||||
NORMAL_WEIGHT = '\033[22m'
|
||||
FG_BLACK, FG_RED, FG_GREEN, FG_YELLOW, FG_BLUE, FG_MAGENTA, FG_CYAN, FG_WHITE = ('\033[3%dm' % nb for nb in xrange(8))
|
||||
BOLD = '\033[1m'
|
||||
BLINK = '\033[5m'
|
||||
BLINK_OFF = '\033[25m'
|
||||
|
||||
@classmethod
|
||||
def color(cls, *args):
|
||||
"""output text using ANSI codes
|
||||
|
||||
this method simply merge arguments, and add RESET if is not the last arguments
|
||||
"""
|
||||
# XXX: we expect to have at least one argument
|
||||
if args[-1] != cls.RESET:
|
||||
args = list(args)
|
||||
args.append(cls.RESET)
|
||||
return u''.join(args)
|
||||
|
||||
|
||||
try:
|
||||
tty = sys.stdout.isatty()
|
||||
except (AttributeError, TypeError): # FIXME: TypeError is here for Pyjamas, need to be removed
|
||||
tty = False
|
||||
if not tty:
|
||||
# we don't want ANSI escape codes if we are not outputing to a tty!
|
||||
for attr in dir(ANSI):
|
||||
if isinstance(getattr(ANSI, attr), basestring):
|
||||
setattr(ANSI, attr, u'')
|
||||
del tty
|
||||
120
sat/tools/common/data_format.py
Normal file
120
sat/tools/common/data_format.py
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
#!/usr/bin/env python2
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# SAT: a jabber client
|
||||
# Copyright (C) 2009-2018 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/>.
|
||||
|
||||
""" tools common to backend and frontends """
|
||||
# FIXME: json may be more appropriate than manual serialising like done here
|
||||
|
||||
from sat.core import exceptions
|
||||
|
||||
def dict2iter(name, dict_, pop=False):
|
||||
"""iterate into a list serialised in a dict
|
||||
|
||||
name is the name of the key.
|
||||
Serialisation is done with [name] [name#1] [name#2] and so on
|
||||
e.g.: if name is 'group', keys are group, group#1, group#2, ...
|
||||
iteration stop at first missing increment
|
||||
Empty values are possible
|
||||
@param name(unicode): name of the key
|
||||
@param dict_(dict): dictionary with the serialised list
|
||||
@param pop(bool): if True, remove the value from dict
|
||||
@return iter: iterate through the deserialised list
|
||||
"""
|
||||
if pop:
|
||||
get=lambda d,k: d.pop(k)
|
||||
else:
|
||||
get=lambda d,k: d[k]
|
||||
|
||||
try:
|
||||
yield get(dict_,name)
|
||||
except KeyError:
|
||||
return
|
||||
else:
|
||||
idx = 1
|
||||
while True:
|
||||
try:
|
||||
yield get(dict_,u'{}#{}'.format(name, idx))
|
||||
except KeyError:
|
||||
return
|
||||
else:
|
||||
idx += 1
|
||||
|
||||
def dict2iterdict(name, dict_, extra_keys, pop=False):
|
||||
"""like dict2iter but yield dictionaries
|
||||
|
||||
params are like in [dict2iter], extra_keys is used for extra dict keys.
|
||||
e.g. dict2iterdict(comments, mb_data, ('node', 'service')) will yield dicts like:
|
||||
{u'comments': u'value1', u'node': u'value2', u'service': u'value3'}
|
||||
"""
|
||||
# FIXME: this format seem overcomplicated, it may be more appropriate to use json here
|
||||
if pop:
|
||||
get=lambda d,k: d.pop(k)
|
||||
else:
|
||||
get=lambda d,k: d[k]
|
||||
for idx, main_value in enumerate(dict2iter(name, dict_, pop=pop)):
|
||||
ret = {name: main_value}
|
||||
for k in extra_keys:
|
||||
ret[k] = get(dict_, u'{}{}_{}'.format(name, (u'#' + unicode(idx)) if idx else u'', k))
|
||||
yield ret
|
||||
|
||||
def iter2dict(name, iter_, dict_=None, check_conflict=True):
|
||||
"""Fill a dict with values from an iterable
|
||||
|
||||
name is used to serialise iter_, in the same way as in [dict2iter]
|
||||
Build from the tags a dict using the microblog data format.
|
||||
|
||||
@param name(unicode): key to use for serialisation
|
||||
e.g. "group" to have keys "group", "group#1", "group#2", ...
|
||||
@param iter_(iterable): values to store
|
||||
@param dict_(None, dict): dictionary to fill, or None to create one
|
||||
@param check_conflict(bool): if True, raise an exception in case of existing key
|
||||
@return (dict): filled dict, or newly created one
|
||||
@raise exceptions.ConflictError: a needed key already exists
|
||||
"""
|
||||
if dict_ is None:
|
||||
dict_ = {}
|
||||
for idx, value in enumerate(iter_):
|
||||
if idx == 0:
|
||||
key = name
|
||||
else:
|
||||
key = u'{}#{}'.format(name, idx)
|
||||
if check_conflict and key in dict_:
|
||||
raise exceptions.ConflictError
|
||||
dict_[key] = value
|
||||
return dict
|
||||
|
||||
def getSubDict(name, dict_, sep=u'_'):
|
||||
"""get a sub dictionary from a serialised dictionary
|
||||
|
||||
look for keys starting with name, and create a dict with it
|
||||
eg.: if "key" is looked for, {'html': 1, 'key_toto': 2, 'key_titi': 3} will return:
|
||||
{None: 1, toto: 2, titi: 3}
|
||||
@param name(unicode): name of the key
|
||||
@param dict_(dict): dictionary with the serialised list
|
||||
@param sep(unicode): separator used between name and subkey
|
||||
@return iter: iterate through the deserialised items
|
||||
"""
|
||||
for k,v in dict_.iteritems():
|
||||
if k.startswith(name):
|
||||
if k == name:
|
||||
yield None, v
|
||||
else:
|
||||
if k[len(name)] != sep:
|
||||
continue
|
||||
else:
|
||||
yield k[len(name)+1:], v
|
||||
356
sat/tools/common/data_objects.py
Normal file
356
sat/tools/common/data_objects.py
Normal file
|
|
@ -0,0 +1,356 @@
|
|||
#!/usr/bin/env python2
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# SAT: a jabber client
|
||||
# Copyright (C) 2009-2018 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/>.
|
||||
|
||||
"""Objects handling bridge data, with jinja2 safe markup handling"""
|
||||
|
||||
from sat.tools.common import data_format
|
||||
try:
|
||||
from jinja2 import Markup as safe
|
||||
except ImportError:
|
||||
safe = unicode
|
||||
|
||||
from sat.tools.common import uri as xmpp_uri
|
||||
import urllib
|
||||
|
||||
q = lambda value: urllib.quote(value.encode('utf-8'), safe='@')
|
||||
|
||||
|
||||
class BlogItem(object):
|
||||
|
||||
def __init__(self, mb_data, parent):
|
||||
self.mb_data = mb_data
|
||||
self.parent = parent
|
||||
self._tags = None
|
||||
self._groups = None
|
||||
self._comments = None
|
||||
self._comments_items_list = None
|
||||
|
||||
@property
|
||||
def id(self):
|
||||
return self.mb_data.get(u'id')
|
||||
|
||||
@property
|
||||
def atom_id(self):
|
||||
return self.mb_data.get(u'atom_id')
|
||||
|
||||
@property
|
||||
def uri(self):
|
||||
node = self.parent.node
|
||||
service = self.parent.service
|
||||
return xmpp_uri.buildXMPPUri(u'pubsub',
|
||||
subtype=u'microblog',
|
||||
path=service,
|
||||
node=node,
|
||||
item=self.id)
|
||||
|
||||
@property
|
||||
def published(self):
|
||||
return self.mb_data.get(u'published')
|
||||
|
||||
@property
|
||||
def updated(self):
|
||||
return self.mb_data.get(u'updated')
|
||||
|
||||
@property
|
||||
def language(self):
|
||||
return self.mb_data.get(u'language')
|
||||
|
||||
@property
|
||||
def author(self):
|
||||
return self.mb_data.get(u'author')
|
||||
|
||||
@property
|
||||
def author_jid(self):
|
||||
return self.mb_data.get(u'author_jid')
|
||||
|
||||
@property
|
||||
def author_jid_verified(self):
|
||||
return self.mb_data.get(u'author_jid_verified')
|
||||
|
||||
@property
|
||||
def author_email(self):
|
||||
return self.mb_data.get(u'author_email')
|
||||
|
||||
@property
|
||||
def tags(self):
|
||||
if self._tags is None:
|
||||
self._tags = list(data_format.dict2iter('tag', self.mb_data))
|
||||
return self._tags
|
||||
|
||||
@property
|
||||
def groups(self):
|
||||
if self._groups is None:
|
||||
self._groups = list(data_format.dict2iter('group', self.mb_data))
|
||||
return self._groups
|
||||
|
||||
@property
|
||||
def title(self):
|
||||
return self.mb_data.get(u'title')
|
||||
|
||||
@property
|
||||
def title_xhtml(self):
|
||||
try:
|
||||
return safe(self.mb_data[u'title_xhtml'])
|
||||
except KeyError:
|
||||
return None
|
||||
|
||||
@property
|
||||
def content(self):
|
||||
return self.mb_data.get(u'content')
|
||||
|
||||
@property
|
||||
def content_xhtml(self):
|
||||
try:
|
||||
return safe(self.mb_data[u'content_xhtml'])
|
||||
except KeyError:
|
||||
return None
|
||||
|
||||
@property
|
||||
def comments(self):
|
||||
if self._comments is None:
|
||||
self._comments = data_format.dict2iterdict(u'comments', self.mb_data, (u'node', u'service'))
|
||||
return self._comments
|
||||
|
||||
@property
|
||||
def comments_service(self):
|
||||
return self.mb_data.get(u'comments_service')
|
||||
|
||||
@property
|
||||
def comments_node(self):
|
||||
return self.mb_data.get(u'comments_node')
|
||||
|
||||
@property
|
||||
def comments_items_list(self):
|
||||
return [] if self._comments_items_list is None else self._comments_items_list
|
||||
|
||||
def appendCommentsItems(self, items):
|
||||
"""append comments items to self.comments_items"""
|
||||
if self._comments_items_list is None:
|
||||
self._comments_items_list = []
|
||||
self._comments_items_list.append(items)
|
||||
|
||||
|
||||
class BlogItems(object):
|
||||
|
||||
def __init__(self, mb_data):
|
||||
self.items = [BlogItem(i, self) for i in mb_data[0]]
|
||||
self.metadata = mb_data[1]
|
||||
|
||||
@property
|
||||
def service(self):
|
||||
return self.metadata[u'service']
|
||||
|
||||
@property
|
||||
def node(self):
|
||||
return self.metadata[u'node']
|
||||
|
||||
@property
|
||||
def uri(self):
|
||||
return self.metadata[u'uri']
|
||||
|
||||
def __len__(self):
|
||||
return self.items.__len__()
|
||||
|
||||
def __missing__(self, key):
|
||||
return self.items.__missing__(key)
|
||||
|
||||
def __getitem__(self, key):
|
||||
return self.items.__getitem__(key)
|
||||
|
||||
def __iter__(self):
|
||||
return self.items.__iter__()
|
||||
|
||||
def __reversed__(self):
|
||||
return self.items.__reversed__()
|
||||
|
||||
def __contains__(self, item):
|
||||
return self.items.__contains__(item)
|
||||
|
||||
|
||||
class Message(object):
|
||||
|
||||
def __init__(self, msg_data):
|
||||
self._uid = msg_data[0]
|
||||
self._timestamp = msg_data[1]
|
||||
self._from_jid = msg_data[2]
|
||||
self._to_jid = msg_data[3]
|
||||
self._message_data = msg_data[4]
|
||||
self._subject_data = msg_data[5]
|
||||
self._type = msg_data[6]
|
||||
self._extra = msg_data[7]
|
||||
self._html = dict(data_format.getSubDict('xhtml', self._extra))
|
||||
|
||||
@property
|
||||
def id(self):
|
||||
return self._uid
|
||||
|
||||
@property
|
||||
def timestamp(self):
|
||||
return self._timestamp
|
||||
|
||||
@property
|
||||
def from_(self):
|
||||
return self._from_jid
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
try:
|
||||
return self._message_data['']
|
||||
except KeyError:
|
||||
return next(self._message_data.itervalues())
|
||||
|
||||
@property
|
||||
def subject(self):
|
||||
try:
|
||||
return self._subject_data['']
|
||||
except KeyError:
|
||||
return next(self._subject_data.itervalues())
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
return self._type
|
||||
|
||||
@property
|
||||
def thread(self):
|
||||
return self._extra.get('thread')
|
||||
|
||||
@property
|
||||
def thread_parent(self):
|
||||
return self._extra.get('thread_parent')
|
||||
|
||||
@property
|
||||
def received(self):
|
||||
return self._extra.get('received_timestamp', self._timestamp)
|
||||
|
||||
@property
|
||||
def delay_sender(self):
|
||||
return self._extra.get('delay_sender')
|
||||
|
||||
@property
|
||||
def info_type(self):
|
||||
return self._extra.get('info_type')
|
||||
|
||||
@property
|
||||
def html(self):
|
||||
if not self._html:
|
||||
return None
|
||||
try:
|
||||
return safe(self._html[''])
|
||||
except KeyError:
|
||||
return safe(next(self._html.itervalues()))
|
||||
|
||||
|
||||
class Messages(object):
|
||||
|
||||
def __init__(self, msgs_data):
|
||||
self.messages = [Message(m) for m in msgs_data]
|
||||
|
||||
def __len__(self):
|
||||
return self.messages.__len__()
|
||||
|
||||
def __missing__(self, key):
|
||||
return self.messages.__missing__(key)
|
||||
|
||||
def __getitem__(self, key):
|
||||
return self.messages.__getitem__(key)
|
||||
|
||||
def __iter__(self):
|
||||
return self.messages.__iter__()
|
||||
|
||||
def __reversed__(self):
|
||||
return self.messages.__reversed__()
|
||||
|
||||
def __contains__(self, item):
|
||||
return self.messages.__contains__(item)
|
||||
|
||||
class Room(object):
|
||||
|
||||
def __init__(self, jid, name=None, url=None):
|
||||
self.jid = jid
|
||||
self.name = name or jid
|
||||
if url is not None:
|
||||
self.url = url
|
||||
|
||||
|
||||
class Identity(object):
|
||||
|
||||
def __init__(self, jid_str, data=None):
|
||||
self.jid_str = jid_str
|
||||
self.data = data if data is not None else {}
|
||||
|
||||
def __getitem__(self, key):
|
||||
return self.data[key]
|
||||
|
||||
def __getattr__(self, key):
|
||||
try:
|
||||
return self.data[key]
|
||||
except KeyError:
|
||||
raise AttributeError(key)
|
||||
|
||||
|
||||
class Identities(object):
|
||||
|
||||
def __init__(self):
|
||||
self.identities = {}
|
||||
|
||||
def __getitem__(self, jid_str):
|
||||
try:
|
||||
return self.identities[jid_str]
|
||||
except KeyError:
|
||||
return None
|
||||
|
||||
def __setitem__(self, jid_str, data):
|
||||
self.identities[jid_str] = Identity(jid_str, data)
|
||||
|
||||
def __contains__(self, jid_str):
|
||||
return jid_str in self.identities
|
||||
|
||||
|
||||
class ObjectQuoter(object):
|
||||
"""object wrapper which quote attribues (to be used in templates)"""
|
||||
|
||||
def __init__(self, obj):
|
||||
self.obj = obj
|
||||
|
||||
def __unicode__(self):
|
||||
return q(self.obj.__unicode__())
|
||||
|
||||
def __str__(self):
|
||||
return self.__unicode__()
|
||||
|
||||
def __getattr__(self, name):
|
||||
return q(self.obj.__getattr__(name))
|
||||
|
||||
def __getitem__(self, key):
|
||||
return q(self.obj.__getitem__(key))
|
||||
|
||||
|
||||
class OnClick(object):
|
||||
"""Class to handle clickable elements targets"""
|
||||
|
||||
def __init__(self, url=None):
|
||||
self.url = url
|
||||
|
||||
def formatUrl(self, *args, **kwargs):
|
||||
"""format URL using Python formatting
|
||||
|
||||
values will be quoted before being used
|
||||
"""
|
||||
return self.url.format(*[q(a) for a in args],
|
||||
**{k: ObjectQuoter(v) for k,v in kwargs.iteritems()})
|
||||
39
sat/tools/common/dynamic_import.py
Normal file
39
sat/tools/common/dynamic_import.py
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
#!/usr/bin/env python2
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# SàT: a XMPP
|
||||
# Copyright (C) 2009-2018 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/>.
|
||||
|
||||
""" tools dynamic import """
|
||||
|
||||
from importlib import import_module
|
||||
|
||||
|
||||
def bridge(name, module_path='sat.bridge'):
|
||||
"""Import bridge module
|
||||
|
||||
@param module_path(str): path of the module to import
|
||||
@param name(str): name of the bridge to import (e.g.: dbus)
|
||||
@return (module, None): imported module or None if nothing is found
|
||||
"""
|
||||
try:
|
||||
bridge_module = import_module(module_path + '.' + name)
|
||||
except ImportError:
|
||||
try:
|
||||
bridge_module = import_module(module_path + '.' + name + '_bridge')
|
||||
except ImportError:
|
||||
bridge_module = None
|
||||
return bridge_module
|
||||
72
sat/tools/common/regex.py
Normal file
72
sat/tools/common/regex.py
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
#!/usr/bin/env python2
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Salut à Toi: an XMPP client
|
||||
# Copyright (C) 2009-2018 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/>.
|
||||
|
||||
""" regex tools common to backend and frontends """
|
||||
|
||||
import re
|
||||
path_escape = {'%': '%25', '/': '%2F', '\\': '%5c'}
|
||||
path_escape_rev = {re.escape(v):k for k, v in path_escape.iteritems()}
|
||||
path_escape = {re.escape(k):v for k, v in path_escape.iteritems()}
|
||||
# thanks to Martijn Pieters (https://stackoverflow.com/a/14693789)
|
||||
RE_ANSI_REMOVE = re.compile(r'\x1b[^m]*m')
|
||||
|
||||
|
||||
def reJoin(exps):
|
||||
"""Join (OR) various regexes"""
|
||||
return re.compile('|'.join(exps))
|
||||
|
||||
|
||||
def reSubDict(pattern, repl_dict, string):
|
||||
"""Replace key, value found in dict according to pattern
|
||||
|
||||
@param pattern(basestr): pattern using keys found in repl_dict
|
||||
@repl_dict(dict): keys found in this dict will be replaced by
|
||||
corresponding values
|
||||
@param string(basestr): string to use for the replacement
|
||||
"""
|
||||
return pattern.sub(lambda m: repl_dict[re.escape(m.group(0))], string)
|
||||
|
||||
path_escape_re = reJoin(path_escape.keys())
|
||||
path_escape_rev_re = reJoin(path_escape_rev.keys())
|
||||
|
||||
|
||||
def pathEscape(string):
|
||||
"""Escape string so it can be use in a file path
|
||||
|
||||
@param string(basestr): string to escape
|
||||
@return (str, unicode): escaped string, usable in a file path
|
||||
"""
|
||||
return reSubDict(path_escape_re, path_escape, string)
|
||||
|
||||
|
||||
def pathUnescape(string):
|
||||
"""Unescape string from value found in file path
|
||||
|
||||
@param string(basestr): string found in file path
|
||||
@return (str, unicode): unescaped string
|
||||
"""
|
||||
return reSubDict(path_escape_rev_re, path_escape_rev, string)
|
||||
|
||||
def ansiRemove(string):
|
||||
"""Remove ANSI escape codes from string
|
||||
|
||||
@param string(basestr): string to filter
|
||||
@return (str, unicode): string without ANSI escape codes
|
||||
"""
|
||||
return RE_ANSI_REMOVE.sub('', string)
|
||||
653
sat/tools/common/template.py
Normal file
653
sat/tools/common/template.py
Normal file
|
|
@ -0,0 +1,653 @@
|
|||
#!/usr/bin/env python2
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# SAT: a jabber client
|
||||
# Copyright (C) 2009-2018 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/>.
|
||||
|
||||
""" template generation """
|
||||
|
||||
from sat.core.constants import Const as C
|
||||
from sat.core.i18n import _
|
||||
from sat.core import exceptions
|
||||
from sat.core.log import getLogger
|
||||
log = getLogger(__name__)
|
||||
import os.path
|
||||
from xml.sax.saxutils import quoteattr
|
||||
import datetime
|
||||
import time
|
||||
import re
|
||||
from babel import support
|
||||
from babel import Locale
|
||||
from babel.core import UnknownLocaleError
|
||||
from babel import dates
|
||||
import pygments
|
||||
from pygments import lexers
|
||||
from pygments import formatters
|
||||
try:
|
||||
import sat_templates
|
||||
except ImportError:
|
||||
raise exceptions.MissingModule(u'sat_templates module is not available, please install it or check your path to use template engine')
|
||||
else:
|
||||
sat_templates # to avoid pyflakes warning
|
||||
|
||||
try:
|
||||
import jinja2
|
||||
except:
|
||||
raise exceptions.MissingModule(u'Missing module jinja2, please install it from http://jinja.pocoo.org or with pip install jinja2')
|
||||
|
||||
from jinja2 import Markup as safe
|
||||
from jinja2 import is_undefined
|
||||
from lxml import etree
|
||||
|
||||
HTML_EXT = ('html', 'xhtml')
|
||||
DEFAULT_LOCALE = u'en_GB'
|
||||
RE_ATTR_ESCAPE = re.compile(r'[^a-z_-]')
|
||||
# TODO: handle external path (an additional search path for templates should be settable by user
|
||||
# TODO: handle absolute URL (should be used for trusted use cases) only (e.g. jp) for security reason
|
||||
|
||||
|
||||
class TemplateLoader(jinja2.FileSystemLoader):
|
||||
|
||||
def __init__(self):
|
||||
searchpath = os.path.dirname(sat_templates.__file__)
|
||||
super(TemplateLoader, self).__init__(searchpath, followlinks=True)
|
||||
|
||||
def parse_template(self, template):
|
||||
"""parse template path and return theme and relative URL
|
||||
|
||||
@param template_path(unicode): path to template with parenthesis syntax
|
||||
@return (tuple[(unicode,None),unicode]): theme and template_path
|
||||
theme can be None if relative path is used
|
||||
relative path is the path from search path with theme specified
|
||||
e.g. default/blog/articles.html
|
||||
"""
|
||||
if template.startswith(u'('):
|
||||
try:
|
||||
theme_end = template.index(u')')
|
||||
except IndexError:
|
||||
raise ValueError(u"incorrect theme in template")
|
||||
theme = template[1:theme_end]
|
||||
template = template[theme_end+1:]
|
||||
if not template or template.startswith(u'/'):
|
||||
raise ValueError(u"incorrect path after template name")
|
||||
template = os.path.join(theme, template)
|
||||
elif template.startswith(u'/'):
|
||||
# absolute path means no template
|
||||
theme = None
|
||||
raise NotImplementedError(u'absolute path is not implemented yet')
|
||||
else:
|
||||
theme = C.TEMPLATE_THEME_DEFAULT
|
||||
template = os.path.join(theme, template)
|
||||
return theme, template
|
||||
|
||||
def get_default_template(self, theme, template_path):
|
||||
"""return default template path
|
||||
|
||||
@param theme(unicode): theme used
|
||||
@param template_path(unicode): path to the not found template
|
||||
@return (unicode, None): default path or None if there is not
|
||||
"""
|
||||
ext = os.path.splitext(template_path)[1][1:]
|
||||
path_elems = template_path.split(u'/')
|
||||
if ext in HTML_EXT:
|
||||
if path_elems[1] == u'error':
|
||||
# if an inexisting error page is requested, we return base page
|
||||
default_path = os.path.join(theme, u'error/base.html')
|
||||
return default_path
|
||||
if theme != C.TEMPLATE_THEME_DEFAULT:
|
||||
# if template doesn't exists for this theme, we try with default
|
||||
return os.path.join(C.TEMPLATE_THEME_DEFAULT, path_elems[1:])
|
||||
|
||||
def get_source(self, environment, template):
|
||||
"""relative path to template dir, with special theme handling
|
||||
|
||||
if the path is just relative, "default" theme is used.
|
||||
The theme can be specified in parenthesis just before the path
|
||||
e.g.: (some_theme)path/to/template.html
|
||||
"""
|
||||
theme, template_path = self.parse_template(template)
|
||||
try:
|
||||
return super(TemplateLoader, self).get_source(environment, template_path)
|
||||
except jinja2.exceptions.TemplateNotFound as e:
|
||||
# in some special cases, a defaut template is returned if nothing is found
|
||||
if theme is not None:
|
||||
default_path = self.get_default_template(theme, template_path)
|
||||
if default_path is not None:
|
||||
return super(TemplateLoader, self).get_source(environment, default_path)
|
||||
# if no default template is found, we re-raise the error
|
||||
raise e
|
||||
|
||||
|
||||
class Indexer(object):
|
||||
"""Index global to a page"""
|
||||
|
||||
def __init__(self):
|
||||
self._indexes = {}
|
||||
|
||||
def next(self, value):
|
||||
if value not in self._indexes:
|
||||
self._indexes[value] = 0
|
||||
return 0
|
||||
self._indexes[value] += 1
|
||||
return self._indexes[value]
|
||||
|
||||
def current(self, value):
|
||||
return self._indexes.get(value)
|
||||
|
||||
|
||||
class ScriptsHandler(object):
|
||||
|
||||
def __init__(self, renderer, template_path, template_root_dir, root_path):
|
||||
self.renderer = renderer
|
||||
self.template_root_dir = template_root_dir
|
||||
self.root_path = root_path
|
||||
self.scripts = [] # we don't use a set because order may be important
|
||||
dummy, self.theme, self.is_default_theme = renderer.getThemeData(template_path)
|
||||
|
||||
def include(self, library_name, attribute='defer'):
|
||||
"""Mark that a script need to be imported.
|
||||
|
||||
Must be used before base.html is extended, as <script> are generated there.
|
||||
If called several time with the same library, it will be imported once.
|
||||
@param library_name(unicode): name of the library to import
|
||||
@param loading:
|
||||
"""
|
||||
if attribute not in ('defer', 'async', ''):
|
||||
raise exceptions.DataError(_(u'Invalid attribute, please use one of "defer", "async" or ""'))
|
||||
if library_name.endswith('.js'):
|
||||
library_name = library_name[:-3]
|
||||
if library_name not in self.scripts:
|
||||
self.scripts.append((library_name, attribute))
|
||||
return u''
|
||||
|
||||
def generate_scripts(self):
|
||||
"""Generate the <script> elements
|
||||
|
||||
@return (unicode): <scripts> HTML tags
|
||||
"""
|
||||
scripts = []
|
||||
tpl = u'<script src={src} {attribute}></script>'
|
||||
for library, attribute in self.scripts:
|
||||
path = self.renderer.getStaticPath(library, self.template_root_dir, self.theme, self.is_default_theme, '.js')
|
||||
if path is None:
|
||||
log.warning(_(u"Can't find {}.js javascript library").format(library))
|
||||
continue
|
||||
path = os.path.join(self.root_path, path)
|
||||
scripts.append(tpl.format(
|
||||
src = quoteattr(path),
|
||||
attribute = attribute,
|
||||
))
|
||||
return safe(u'\n'.join(scripts))
|
||||
|
||||
|
||||
class Renderer(object):
|
||||
|
||||
def __init__(self, host):
|
||||
self.host = host
|
||||
self.base_dir = os.path.dirname(sat_templates.__file__) # FIXME: should be modified if we handle use extra dirs
|
||||
self.env = jinja2.Environment(
|
||||
loader=TemplateLoader(),
|
||||
autoescape=jinja2.select_autoescape(['html', 'xhtml', 'xml']),
|
||||
trim_blocks=True,
|
||||
lstrip_blocks=True,
|
||||
extensions=['jinja2.ext.i18n'],
|
||||
)
|
||||
self._locale_str = DEFAULT_LOCALE
|
||||
self._locale = Locale.parse(self._locale_str)
|
||||
self.installTranslations()
|
||||
# we want to have access to SàT constants in templates
|
||||
self.env.globals[u'C'] = C
|
||||
# custom filters
|
||||
self.env.filters['next_gidx'] = self._next_gidx
|
||||
self.env.filters['cur_gidx'] = self._cur_gidx
|
||||
self.env.filters['date_fmt'] = self._date_fmt
|
||||
self.env.filters['xmlui_class'] = self._xmlui_class
|
||||
self.env.filters['attr_escape'] = self.attr_escape
|
||||
self.env.filters['item_filter'] = self._item_filter
|
||||
self.env.filters['adv_format'] = self._adv_format
|
||||
self.env.filters['dict_ext'] = self._dict_ext
|
||||
self.env.filters['highlight'] = self.highlight
|
||||
# custom tests
|
||||
self.env.tests['in_the_past'] = self._in_the_past
|
||||
self.icons_path = os.path.join(host.media_dir, u'fonts/fontello/svg')
|
||||
|
||||
def installTranslations(self):
|
||||
i18n_dir = os.path.join(self.base_dir, 'i18n')
|
||||
self.translations = {}
|
||||
for lang_dir in os.listdir(i18n_dir):
|
||||
lang_path = os.path.join(i18n_dir, lang_dir)
|
||||
if not os.path.isdir(lang_path):
|
||||
continue
|
||||
po_path = os.path.join(lang_path, 'LC_MESSAGES/sat.mo')
|
||||
try:
|
||||
with open(po_path, 'rb') as f:
|
||||
self.translations[Locale.parse(lang_dir)] = support.Translations(f, 'sat')
|
||||
except EnvironmentError:
|
||||
log.error(_(u"Can't find template translation at {path}").format(path = po_path))
|
||||
except UnknownLocaleError as e:
|
||||
log.error(_(u"Invalid locale name: {msg}").format(msg=e))
|
||||
else:
|
||||
log.info(_(u'loaded {lang} templates translations').format(lang=lang_dir))
|
||||
self.env.install_null_translations(True)
|
||||
|
||||
def setLocale(self, locale_str):
|
||||
"""set current locale
|
||||
|
||||
change current translation locale and self self._locale and self._locale_str
|
||||
"""
|
||||
if locale_str == self._locale_str:
|
||||
return
|
||||
if locale_str == 'en':
|
||||
# we default to GB English when it's not specified
|
||||
# one of the main reason is to avoid the nonsense U.S. short date format
|
||||
locale_str = 'en_GB'
|
||||
try:
|
||||
locale = Locale.parse(locale_str)
|
||||
except ValueError as e:
|
||||
log.warning(_(u"invalid locale value: {msg}").format(msg=e))
|
||||
locale_str = self._locale_str = DEFAULT_LOCALE
|
||||
locale = Locale.parse(locale_str)
|
||||
|
||||
locale_str = unicode(locale)
|
||||
if locale_str != DEFAULT_LOCALE:
|
||||
try:
|
||||
translations = self.translations[locale]
|
||||
except KeyError:
|
||||
log.warning(_(u"Can't find locale {locale}".format(locale=locale)))
|
||||
locale_str = DEFAULT_LOCALE
|
||||
locale = Locale.parse(self._locale_str)
|
||||
else:
|
||||
self.env.install_gettext_translations(translations, True)
|
||||
log.debug(_(u'Switched to {lang}').format(lang=locale.english_name))
|
||||
|
||||
if locale_str == DEFAULT_LOCALE:
|
||||
self.env.install_null_translations(True)
|
||||
|
||||
self._locale = locale
|
||||
self._locale_str = locale_str
|
||||
|
||||
def getThemeAndRoot(self, template):
|
||||
"""retrieve theme and root dir of a given tempalte
|
||||
|
||||
@param template(unicode): template to parse
|
||||
@return (tuple[unicode, unicode]): theme and absolute path to theme's root dir
|
||||
"""
|
||||
theme, dummy = self.env.loader.parse_template(template)
|
||||
return theme, os.path.join(self.base_dir, theme)
|
||||
|
||||
def getStaticPath(self, name, template_root_dir, theme, is_default, ext='.css'):
|
||||
"""retrieve path of a static file if it exists with current theme or default
|
||||
|
||||
File will be looked at [theme]/static/[name][ext], and then default
|
||||
if not found.
|
||||
@param name(unicode): name of the file to look for
|
||||
@param template_root_dir(unicode): absolute path to template root used
|
||||
@param theme(unicode): name of the template theme used
|
||||
@param is_default(bool): True if theme is the default theme
|
||||
@return (unicode, None): relative path if found, else None
|
||||
"""
|
||||
file_ = None
|
||||
path = os.path.join(theme, C.TEMPLATE_STATIC_DIR, name + ext)
|
||||
if os.path.exists(os.path.join(template_root_dir, path)):
|
||||
file_ = path
|
||||
elif not is_default:
|
||||
path = os.path.join(C.TEMPLATE_THEME_DEFAULT, C.TEMPLATE_STATIC_DIR, name + ext)
|
||||
if os.path.exists(os.path.join(template_root_dir, path)):
|
||||
file_.append(path)
|
||||
return file_
|
||||
|
||||
def getThemeData(self, template_path):
|
||||
"""return template data got from template_path
|
||||
|
||||
@return tuple(unicode, unicode, bool):
|
||||
path_elems: elements of the path
|
||||
theme: theme of the page
|
||||
is_default: True if the theme is the default theme
|
||||
"""
|
||||
path_elems = [os.path.splitext(p)[0] for p in template_path.split(u'/')]
|
||||
theme = path_elems.pop(0)
|
||||
is_default = theme == C.TEMPLATE_THEME_DEFAULT
|
||||
return (path_elems, theme, is_default)
|
||||
|
||||
def getCSSFiles(self, template_path, template_root_dir):
|
||||
"""retrieve CSS files to use according to theme and template path
|
||||
|
||||
for each element of the path, a .css file is looked for in /static, and returned if it exists.
|
||||
previous element are kept by replacing '/' with '_', and styles.css is always returned.
|
||||
For instance, if template_path is some_theme/blog/articles.html:
|
||||
some_theme/static/styles.css is returned if it exists else default/static/styles.css
|
||||
some_theme/static/blog.css is returned if it exists else default/static/blog.css (if it exists too)
|
||||
some_theme/static/blog_articles.css is returned if it exists else default/static/blog_articles.css (if it exists too)
|
||||
@param template_path(unicode): relative path to template file (e.g. some_theme/blog/articles.html)
|
||||
@param template_root_dir(unicode): absolute path of the theme root dir used
|
||||
@return list[unicode]: relative path to CSS files to use
|
||||
"""
|
||||
# TODO: some caching would be nice
|
||||
css_files = []
|
||||
path_elems, theme, is_default = self.getThemeData(template_path)
|
||||
for css in (u'fonts', u'styles'):
|
||||
css_path = self.getStaticPath(css, template_root_dir, theme, is_default)
|
||||
if css_path is not None:
|
||||
css_files.append(css_path)
|
||||
|
||||
for idx, path in enumerate(path_elems):
|
||||
css_path = self.getStaticPath(u'_'.join(path_elems[:idx+1]), template_root_dir, theme, is_default)
|
||||
if css_path is not None:
|
||||
css_files.append(css_path)
|
||||
|
||||
return css_files
|
||||
|
||||
|
||||
## custom filters ##
|
||||
|
||||
@jinja2.contextfilter
|
||||
def _next_gidx(self, ctx, value):
|
||||
"""Use next current global index as suffix"""
|
||||
next_ = ctx['gidx'].next(value)
|
||||
return value if next_ == 0 else u"{}_{}".format(value, next_)
|
||||
|
||||
@jinja2.contextfilter
|
||||
def _cur_gidx(self, ctx, value):
|
||||
"""Use current current global index as suffix"""
|
||||
current = ctx['gidx'].current(value)
|
||||
return value if not current else u"{}_{}".format(value, current)
|
||||
|
||||
def _date_fmt(self, timestamp, fmt='short', date_only=False, auto_limit=None, auto_old_fmt=None):
|
||||
try:
|
||||
return self.date_fmt(timestamp, fmt, date_only, auto_limit, auto_old_fmt)
|
||||
except Exception as e:
|
||||
log.warning(_(u"Can't parse date: {msg}").format(msg=e))
|
||||
return timestamp
|
||||
|
||||
def date_fmt(self, timestamp, fmt='short', date_only=False, auto_limit=7, auto_old_fmt='short', auto_new_fmt='relative'):
|
||||
"""format date according to locale
|
||||
|
||||
@param timestamp(basestring, int): unix time
|
||||
@param fmt(str): one of:
|
||||
- short: e.g. u'31/12/17'
|
||||
- medium: e.g. u'Apr 1, 2007'
|
||||
- long: e.g. u'April 1, 2007'
|
||||
- full: e.g. u'Sunday, April 1, 2007'
|
||||
- relative: format in relative time
|
||||
e.g.: 3 hours
|
||||
note that this format is not precise
|
||||
- iso: ISO 8601 format
|
||||
e.g.: u'2007-04-01T19:53:23Z'
|
||||
- auto: use auto_old_fmt if date is older than auto_limit
|
||||
else use auto_new_fmt
|
||||
- auto_day: shorcut to set auto format with change on day
|
||||
old format will be short, and new format will be time only
|
||||
or a free value which is passed to babel.dates.format_datetime
|
||||
@param date_only(bool): if True, only display date (not datetime)
|
||||
@param auto_limit (int): limit in days before using auto_old_fmt
|
||||
use 0 to have a limit at last midnight (day change)
|
||||
@param auto_old_fmt(unicode): format to use when date is older than limit
|
||||
@param auto_new_fmt(unicode): format to use when date is equal to or more recent
|
||||
than limit
|
||||
|
||||
"""
|
||||
if is_undefined(fmt):
|
||||
fmt = u'short'
|
||||
|
||||
if (auto_limit is not None or auto_old_fmt is not None) and fmt != 'auto':
|
||||
raise ValueError(u'auto argument can only be used with auto fmt')
|
||||
if fmt == 'auto_day':
|
||||
fmt, auto_limit, auto_old_fmt, auto_new_fmt = 'auto', 0, 'short', 'HH:mm'
|
||||
if fmt == 'auto':
|
||||
if auto_limit == 0:
|
||||
today = time.mktime(datetime.date.today().timetuple())
|
||||
if int(timestamp) < today:
|
||||
fmt = auto_old_fmt
|
||||
else:
|
||||
fmt = auto_new_fmt
|
||||
else:
|
||||
days_delta = (time.time() - int(timestamp)) / 3600
|
||||
if days_delta > (auto_limit or 7):
|
||||
fmt = auto_old_fmt
|
||||
else:
|
||||
fmt = auto_new_fmt
|
||||
|
||||
if fmt == 'relative':
|
||||
delta = int(timestamp) - time.time()
|
||||
return dates.format_timedelta(delta, granularity="minute", add_direction=True, locale=self._locale_str)
|
||||
elif fmt in ('short', 'long'):
|
||||
formatter = dates.format_date if date_only else dates.format_datetime
|
||||
return formatter(int(timestamp), format=fmt, locale=self._locale_str)
|
||||
elif fmt == 'iso':
|
||||
if date_only:
|
||||
fmt = 'yyyy-MM-dd'
|
||||
else:
|
||||
fmt = "yyyy-MM-ddTHH:mm:ss'Z'"
|
||||
return dates.format_datetime(int(timestamp), format=fmt)
|
||||
else:
|
||||
return dates.format_datetime(int(timestamp), format=fmt, locale=self._locale_str)
|
||||
|
||||
def attr_escape(self, text):
|
||||
"""escape a text to a value usable as an attribute
|
||||
|
||||
remove spaces, and put in lower case
|
||||
"""
|
||||
return RE_ATTR_ESCAPE.sub(u'_', text.strip().lower())[:50]
|
||||
|
||||
def _xmlui_class(self, xmlui_item, fields):
|
||||
"""return classes computed from XMLUI fields name
|
||||
|
||||
will return a string with a series of escaped {name}_{value} separated by spaces.
|
||||
@param xmlui_item(xmlui.XMLUIPanel): XMLUI containing the widgets to use
|
||||
@param fields(iterable(unicode)): names of the widgets to use
|
||||
@return (unicode, None): computer string to use as class attribute value
|
||||
None if no field was specified
|
||||
"""
|
||||
classes = []
|
||||
for name in fields:
|
||||
escaped_name = self.attr_escape(name)
|
||||
try:
|
||||
for value in xmlui_item.widgets[name].values:
|
||||
classes.append(escaped_name + '_' + self.attr_escape(value))
|
||||
except KeyError:
|
||||
log.debug(_(u"ignoring field \"{name}\": it doesn't exists").format(name=name))
|
||||
continue
|
||||
return u' '.join(classes) or None
|
||||
|
||||
@jinja2.contextfilter
|
||||
def _item_filter(self, ctx, item, filters):
|
||||
"""return item's value, filtered if suitable
|
||||
|
||||
@param item(object): item to filter
|
||||
value must have name and value attributes,
|
||||
mostly used for XMLUI items
|
||||
@param filters(dict[unicode, (callable, dict, None)]): map of name => filter
|
||||
if filter is None, return the value unchanged
|
||||
if filter is a callable, apply it
|
||||
if filter is a dict, it can have following keys:
|
||||
- filters: iterable of filters to apply
|
||||
- filters_args: kwargs of filters in the same order as filters (use empty dict if needed)
|
||||
- template: template to format where {value} is the filtered value
|
||||
"""
|
||||
value = item.value
|
||||
filter_ = filters.get(item.name, None)
|
||||
if filter_ is None:
|
||||
return value
|
||||
elif isinstance(filter_, dict):
|
||||
filters_args = filter_.get(u'filters_args')
|
||||
for idx, f_name in enumerate(filter_.get(u'filters', [])):
|
||||
kwargs = filters_args[idx] if filters_args is not None else {}
|
||||
filter_func = self.env.filters[f_name]
|
||||
try:
|
||||
eval_context_filter = filter_func.evalcontextfilter
|
||||
except AttributeError:
|
||||
eval_context_filter = False
|
||||
|
||||
if eval_context_filter:
|
||||
value = filter_func(ctx.eval_ctx, value, **kwargs)
|
||||
else:
|
||||
value = filter_func(value, **kwargs)
|
||||
template = filter_.get(u'template')
|
||||
if template:
|
||||
# format will return a string, so we need to check first
|
||||
# if the value is safe or not, and re-mark it after formatting
|
||||
is_safe = isinstance(value, safe)
|
||||
value = template.format(value=value)
|
||||
if is_safe:
|
||||
value = safe(value)
|
||||
return value
|
||||
|
||||
def _adv_format(self, value, template, **kwargs):
|
||||
"""Advancer formatter
|
||||
|
||||
like format() method, but take care or special values like None
|
||||
@param value(unicode): value to format
|
||||
@param template(None, unicode): template to use with format() method.
|
||||
It will be formatted using value=value and **kwargs
|
||||
None to return value unchanged
|
||||
@return (unicode): formatted value
|
||||
"""
|
||||
if template is None:
|
||||
return value
|
||||
# jinja use string when no special char is used, so we have to convert to unicode
|
||||
return unicode(template).format(value=value, **kwargs)
|
||||
|
||||
def _dict_ext(self, source_dict, extra_dict, key=None):
|
||||
"""extend source_dict with extra dict and return the result
|
||||
|
||||
@param source_dict(dict): dictionary to extend
|
||||
@param extra_dict(dict, None): dictionary to use to extend first one
|
||||
None to return source_dict unmodified
|
||||
@param key(unicode, None): if specified extra_dict[key] will be used
|
||||
if it doesn't exists, a copy of unmodified source_dict is returned
|
||||
@return (dict): resulting dictionary
|
||||
"""
|
||||
if extra_dict is None:
|
||||
return source_dict
|
||||
if key is not None:
|
||||
extra_dict = extra_dict.get(key, {})
|
||||
ret = source_dict.copy()
|
||||
ret.update(extra_dict)
|
||||
return ret
|
||||
|
||||
def highlight(self, code, lexer_name=None, lexer_opts=None, html_fmt_opts=None):
|
||||
"""Do syntax highlighting on code
|
||||
|
||||
under the hood, pygments is used, check its documentation for options possible values
|
||||
@param code(unicode): code or markup to highlight
|
||||
@param lexer_name(unicode, None): name of the lexer to use
|
||||
None to autodetect it
|
||||
@param html_fmt_opts(dict, None): kword arguments to use for HtmlFormatter
|
||||
@return (unicode): HTML markup with highlight classes
|
||||
"""
|
||||
if lexer_opts is None:
|
||||
lexer_opts = {}
|
||||
if html_fmt_opts is None:
|
||||
html_fmt_opts = {}
|
||||
if lexer_name is None:
|
||||
lexer = lexers.guess_lexer(code, **lexer_opts)
|
||||
else:
|
||||
lexer = lexers.get_lexer_by_name(lexer_name, **lexer_opts)
|
||||
formatter = formatters.HtmlFormatter(**html_fmt_opts)
|
||||
return safe(pygments.highlight(code, lexer, formatter))
|
||||
|
||||
## custom tests ##
|
||||
|
||||
def _in_the_past(self, timestamp):
|
||||
"""check if a date is in the past
|
||||
|
||||
@param timestamp(unicode, int): unix time
|
||||
@return (bool): True if date is in the past
|
||||
"""
|
||||
return time.time() > int(timestamp)
|
||||
|
||||
## template methods ##
|
||||
|
||||
def _icon_defs(self, *names):
|
||||
"""Define svg icons which will be used in the template, and use their name as id"""
|
||||
svg_elt = etree.Element('svg', nsmap={None: 'http://www.w3.org/2000/svg'},
|
||||
width='0', height='0', style='display: block'
|
||||
)
|
||||
defs_elt = etree.SubElement(svg_elt, 'defs')
|
||||
for name in names:
|
||||
path = os.path.join(self.icons_path, name + u'.svg')
|
||||
icon_svg_elt = etree.parse(path).getroot()
|
||||
# we use icon name as id, so we can retrieve them easily
|
||||
icon_svg_elt.set('id', name)
|
||||
if not icon_svg_elt.tag == '{http://www.w3.org/2000/svg}svg':
|
||||
raise exceptions.DataError(u'invalid SVG element')
|
||||
defs_elt.append(icon_svg_elt)
|
||||
return safe(etree.tostring(svg_elt, encoding='unicode'))
|
||||
|
||||
def _icon_use(self, name, cls=''):
|
||||
return safe(u"""<svg class="svg-icon{cls}" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
|
||||
<use href="#{name}"/>
|
||||
</svg>
|
||||
""".format(
|
||||
name=name,
|
||||
cls=(' ' + cls) if cls else ''))
|
||||
|
||||
def render(self, template, theme=None, locale=DEFAULT_LOCALE, root_path=u'', media_path=u'', css_files=None, css_inline=False, **kwargs):
|
||||
"""render a template
|
||||
.
|
||||
@param template(unicode): template to render (e.g. blog/articles.html)
|
||||
@param theme(unicode): template theme
|
||||
@param root_path(unicode): prefix of the path/URL to use for template root
|
||||
must end with a u'/'
|
||||
@param media_path(unicode): prefix of the SàT media path/URL to use for template root
|
||||
must end with a u'/'
|
||||
@param css_files(list[unicode],None): CSS files to used
|
||||
CSS files must be in static dir of the template
|
||||
use None for automatic selection of CSS files based on template category
|
||||
None is recommended. General static/style.css and theme file name will be used.
|
||||
@param css_inline(bool): if True, CSS will be embedded in the HTML page
|
||||
@param **kwargs: variable to transmit to the template
|
||||
"""
|
||||
if not template:
|
||||
raise ValueError(u"template can't be empty")
|
||||
if theme is not None:
|
||||
# use want to set a theme, we add it to the template path
|
||||
if template[0] == u'(':
|
||||
raise ValueError(u"you can't specify theme in template path and in argument at the same time")
|
||||
elif template[0] == u'/':
|
||||
raise ValueError(u"you can't specify theme with absolute paths")
|
||||
template= u'(' + theme + u')' + template
|
||||
else:
|
||||
theme, dummy = self.env.loader.parse_template(template)
|
||||
|
||||
template_source = self.env.get_template(template)
|
||||
template_root_dir = os.path.normpath(self.base_dir) # FIXME: should be modified if we handle use extra dirs
|
||||
# XXX: template_path may have a different theme as first element than theme if a default page is used
|
||||
template_path = template_source.filename[len(template_root_dir)+1:]
|
||||
|
||||
if css_files is None:
|
||||
css_files = self.getCSSFiles(template_path, template_root_dir)
|
||||
|
||||
kwargs['icon_defs'] = self._icon_defs
|
||||
kwargs['icon'] = self._icon_use
|
||||
|
||||
if css_inline:
|
||||
css_contents = []
|
||||
for css_file in css_files:
|
||||
css_file_path = os.path.join(template_root_dir, css_file)
|
||||
with open(css_file_path) as f:
|
||||
css_contents.append(f.read())
|
||||
if css_contents:
|
||||
kwargs['css_content'] = '\n'.join(css_contents)
|
||||
|
||||
scripts_handler = ScriptsHandler(self, template_path, template_root_dir, root_path)
|
||||
self.setLocale(locale)
|
||||
# XXX: theme used in template arguments is the requested theme, which may differ from actual theme
|
||||
# if the template doesn't exist in the requested theme.
|
||||
return template_source.render(theme=theme, root_path=root_path, media_path=media_path,
|
||||
css_files=css_files, locale=self._locale,
|
||||
gidx=Indexer(), script=scripts_handler,
|
||||
**kwargs)
|
||||
204
sat/tools/common/template_xmlui.py
Normal file
204
sat/tools/common/template_xmlui.py
Normal file
|
|
@ -0,0 +1,204 @@
|
|||
#!/usr/bin/env python2
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# SAT: a jabber client
|
||||
# Copyright (C) 2009-2018 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/>.
|
||||
|
||||
""" template XMLUI parsing
|
||||
|
||||
XMLUI classes from this modules can then be iterated to create the template
|
||||
"""
|
||||
|
||||
from sat.core.log import getLogger
|
||||
log = getLogger(__name__)
|
||||
from sat_frontends.tools import xmlui
|
||||
|
||||
|
||||
## Widgets ##
|
||||
|
||||
class Widget(object):
|
||||
category = u'widget'
|
||||
type = None
|
||||
enabled = True
|
||||
read_only = True
|
||||
|
||||
def __init__(self, xmlui_parent):
|
||||
self.xmlui_parent = xmlui_parent
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
return self._xmlui_name
|
||||
|
||||
|
||||
class ValueWidget(Widget):
|
||||
|
||||
def __init__(self, xmlui_parent, value):
|
||||
super(ValueWidget, self).__init__(xmlui_parent)
|
||||
self.value = value
|
||||
|
||||
@property
|
||||
def values(self):
|
||||
return [self.value]
|
||||
|
||||
@property
|
||||
def labels(self):
|
||||
# helper property, there is not label for ValueWidget
|
||||
# but using labels make rendering more easy (one single method to call)
|
||||
# values are actually returned
|
||||
return [self.value]
|
||||
|
||||
|
||||
class InputWidget(ValueWidget):
|
||||
|
||||
def __init__(self, xmlui_parent, value, read_only=False):
|
||||
super(InputWidget, self).__init__(xmlui_parent, value)
|
||||
self.read_only = read_only
|
||||
|
||||
|
||||
class OptionsWidget(Widget):
|
||||
|
||||
def __init__(self, xmlui_parent, options, selected, style):
|
||||
super(OptionsWidget, self).__init__(xmlui_parent)
|
||||
self.options = options
|
||||
self.selected = selected
|
||||
self.style = style
|
||||
|
||||
@property
|
||||
def values(self):
|
||||
for value, label in self.items:
|
||||
yield value
|
||||
|
||||
@property
|
||||
def labels(self):
|
||||
"""return only labels from self.items"""
|
||||
for value, label in self.items:
|
||||
yield label
|
||||
|
||||
@property
|
||||
def items(self):
|
||||
"""return suitable items, according to style"""
|
||||
no_select = self.no_select
|
||||
for value,label in self.options:
|
||||
if no_select or value in self.selected:
|
||||
yield value,label
|
||||
|
||||
@property
|
||||
def inline(self):
|
||||
return u'inline' in self.style
|
||||
|
||||
@property
|
||||
def no_select(self):
|
||||
return u'noselect' in self.style
|
||||
|
||||
|
||||
class EmptyWidget(xmlui.EmptyWidget, Widget):
|
||||
|
||||
def __init__(self, _xmlui_parent):
|
||||
Widget.__init__(self)
|
||||
|
||||
|
||||
class TextWidget(xmlui.TextWidget, ValueWidget):
|
||||
type = u"text"
|
||||
|
||||
|
||||
class LabelWidget(xmlui.LabelWidget, ValueWidget):
|
||||
type = u"label"
|
||||
|
||||
@property
|
||||
def for_name(self):
|
||||
try:
|
||||
return self._xmlui_for_name
|
||||
except AttributeError:
|
||||
return None
|
||||
|
||||
|
||||
class StringWidget(xmlui.StringWidget, InputWidget):
|
||||
type = u"string"
|
||||
|
||||
|
||||
class JidInputWidget(xmlui.JidInputWidget, StringWidget):
|
||||
type = u"jid"
|
||||
|
||||
|
||||
class TextBoxWidget(xmlui.TextWidget, InputWidget):
|
||||
type = u"textbox"
|
||||
|
||||
|
||||
class ListWidget(xmlui.ListWidget, OptionsWidget):
|
||||
type = u"list"
|
||||
|
||||
|
||||
## Containers ##
|
||||
|
||||
class Container(object):
|
||||
category = u'container'
|
||||
type = None
|
||||
|
||||
def __init__(self, xmlui_parent):
|
||||
self.xmlui_parent = xmlui_parent
|
||||
self.children = []
|
||||
|
||||
def __iter__(self):
|
||||
return iter(self.children)
|
||||
|
||||
def _xmluiAppend(self, widget):
|
||||
self.children.append(widget)
|
||||
|
||||
def _xmluiRemove(self, widget):
|
||||
self.children.remove(widget)
|
||||
|
||||
|
||||
class VerticalContainer(xmlui.VerticalContainer, Container):
|
||||
type = u'vertical'
|
||||
|
||||
|
||||
class PairsContainer(xmlui.PairsContainer, Container):
|
||||
type = u'pairs'
|
||||
|
||||
|
||||
class LabelContainer(xmlui.PairsContainer, Container):
|
||||
type = u'label'
|
||||
|
||||
|
||||
## Factory ##
|
||||
|
||||
class WidgetFactory(object):
|
||||
|
||||
def __getattr__(self, attr):
|
||||
if attr.startswith("create"):
|
||||
cls = globals()[attr[6:]]
|
||||
return cls
|
||||
|
||||
## Core ##
|
||||
|
||||
|
||||
class XMLUIPanel(xmlui.XMLUIPanel):
|
||||
widget_factory = WidgetFactory()
|
||||
|
||||
def show(self, *args, **kwargs):
|
||||
raise NotImplementedError
|
||||
|
||||
|
||||
class XMLUIDialog(xmlui.XMLUIDialog):
|
||||
dialog_factory = WidgetFactory()
|
||||
|
||||
def __init__(*args, **kwargs):
|
||||
raise NotImplementedError
|
||||
|
||||
|
||||
xmlui.registerClass(xmlui.CLASS_PANEL, XMLUIPanel)
|
||||
xmlui.registerClass(xmlui.CLASS_DIALOG, XMLUIDialog)
|
||||
create = xmlui.create
|
||||
95
sat/tools/common/uri.py
Normal file
95
sat/tools/common/uri.py
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
#!/usr/bin/env python2
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# SAT: a jabber client
|
||||
# Copyright (C) 2009-2018 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/>.
|
||||
|
||||
""" XMPP uri parsing tools """
|
||||
|
||||
import urlparse
|
||||
import urllib
|
||||
|
||||
# FIXME: basic implementation, need to follow RFC 5122
|
||||
|
||||
def parseXMPPUri(uri):
|
||||
"""Parse an XMPP uri and return a dict with various information
|
||||
|
||||
@param uri(unicode): uri to parse
|
||||
@return dict(unicode, unicode): data depending of the URI where key can be:
|
||||
type: one of ("pubsub", TODO)
|
||||
type is always present
|
||||
sub_type: can be:
|
||||
- microblog
|
||||
only used for pubsub for now
|
||||
path: XMPP path (jid of the service or entity)
|
||||
node: node used
|
||||
id: id of the element (item for pubsub)
|
||||
@raise ValueError: the scheme is not xmpp
|
||||
"""
|
||||
uri_split = urlparse.urlsplit(uri.encode('utf-8'))
|
||||
if uri_split.scheme != 'xmpp':
|
||||
raise ValueError(u'this is not a XMPP URI')
|
||||
|
||||
# XXX: we don't use jid.JID for path as it can be used both in backend and frontend
|
||||
# which may use different JID classes
|
||||
data = {u'path': urllib.unquote(uri_split.path).decode('utf-8')}
|
||||
|
||||
query_end = uri_split.query.find(';')
|
||||
query_type = uri_split.query[:query_end]
|
||||
if query_end == -1 or '=' in query_type:
|
||||
raise ValueError('no query type, invalid XMPP URI')
|
||||
|
||||
pairs = urlparse.parse_qs(uri_split.geturl())
|
||||
for k, v in pairs.items():
|
||||
if len(v) != 1:
|
||||
raise NotImplementedError(u"multiple values not managed")
|
||||
if k in ('path', 'type', 'sub_type'):
|
||||
raise NotImplementedError(u"reserved key used in URI, this is not supported")
|
||||
data[k.decode('utf-8')] = urllib.unquote(v[0]).decode('utf-8')
|
||||
|
||||
if query_type:
|
||||
data[u'type'] = query_type.decode('utf-8')
|
||||
elif u'node' in data:
|
||||
data[u'type'] = u'pubsub'
|
||||
else:
|
||||
data[u'type'] = ''
|
||||
|
||||
if u'node' in data:
|
||||
if data[u'node'].startswith(u'urn:xmpp:microblog:'):
|
||||
data[u'sub_type'] = 'microblog'
|
||||
|
||||
return data
|
||||
|
||||
def addPairs(uri, pairs):
|
||||
for k,v in pairs.iteritems():
|
||||
uri.append(u';' + urllib.quote_plus(k.encode('utf-8')) + u'=' + urllib.quote_plus(v.encode('utf-8')))
|
||||
|
||||
def buildXMPPUri(type_, **kwargs):
|
||||
uri = [u'xmpp:']
|
||||
subtype = kwargs.pop('subtype', None)
|
||||
path = kwargs.pop('path')
|
||||
uri.append(urllib.quote_plus(path.encode('utf-8')).replace(u'%40', '@'))
|
||||
|
||||
if type_ == u'pubsub':
|
||||
if subtype == 'microblog' and not kwargs.get('node'):
|
||||
kwargs[u'node'] = 'urn:xmpp:microblog:0'
|
||||
if kwargs:
|
||||
uri.append(u'?')
|
||||
addPairs(uri, kwargs)
|
||||
else:
|
||||
raise NotImplementedError(u'{type_} URI are not handled yet'.format(type_=type_))
|
||||
|
||||
return u''.join(uri)
|
||||
Loading…
Reference in a new issue