core (tools): moved common to a separate package, and put data method in a data_format module

This commit is contained in:
Goffi 2016-03-22 22:46:04 +01:00
commit 2d1d286be2
6 changed files with 15 additions and 15 deletions

View file

@ -32,7 +32,7 @@ import tempfile
import subprocess import subprocess
import shlex import shlex
import glob import glob
from sat.tools import common from sat.tools.common import data_format
__commands__ = ["Blog"] __commands__ = ["Blog"]
@ -187,7 +187,7 @@ class Edit(base.CommandBase, BlogCommon):
# and override metadata with command-line arguments # and override metadata with command-line arguments
mb_data['allow_comments'] = C.boolConst(not self.args.no_comment) mb_data['allow_comments'] = C.boolConst(not self.args.no_comment)
if self.args.tag: if self.args.tag:
common.iter2dict('tag', self.args.tag, mb_data) data_format.iter2dict('tag', self.args.tag, mb_data)
if self.args.title is not None: if self.args.title is not None:
mb_data['title'] = self.args.title mb_data['title'] = self.args.title

View file

@ -25,7 +25,7 @@ log = getLogger(__name__)
from sat_frontends.quick_frontend.constants import Const as C from sat_frontends.quick_frontend.constants import Const as C
from sat_frontends.quick_frontend import quick_widgets from sat_frontends.quick_frontend import quick_widgets
from sat_frontends.tools import jid from sat_frontends.tools import jid
from sat.tools import common from sat.tools.common import data_format
try: try:
# FIXME: to be removed when an acceptable solution is here # FIXME: to be removed when an acceptable solution is here
@ -49,7 +49,7 @@ class Item(object):
self.title = data.get('title') self.title = data.get('title')
self.title_rich = None self.title_rich = None
self.title_xhtml = data.get('title_xhtml') self.title_xhtml = data.get('title_xhtml')
self.tags = list(common.dict2iter('tag', data)) self.tags = list(data_format.dict2iter('tag', data))
self.content = data.get('content') self.content = data.get('content')
self.content_rich = None self.content_rich = None
self.content_xhtml = data.get('content_xhtml') self.content_xhtml = data.get('content_xhtml')
@ -264,7 +264,7 @@ class Entry(EntriesManager):
if value is not None: if value is not None:
mb_data[name] = value mb_data[name] = value
common.iter2dict('tag', self.item.tags, mb_data) data_format.iter2dict('tag', self.item.tags, mb_data)
if self.blog.new_message_target not in (C.PUBLIC, C.GROUP): if self.blog.new_message_target not in (C.PUBLIC, C.GROUP):
raise NotImplementedError raise NotImplementedError
@ -273,7 +273,7 @@ class Entry(EntriesManager):
mb_data["allow_comments"] = C.BOOL_TRUE mb_data["allow_comments"] = C.BOOL_TRUE
if self.blog.new_message_target == C.GROUP: if self.blog.new_message_target == C.GROUP:
common.iter2dict('group', self.blog.targets, mb_data) data_format.iter2dict('group', self.blog.targets, mb_data)
self.blog.host.bridge.mbSend( self.blog.host.bridge.mbSend(
unicode(self.service or ''), unicode(self.service or ''),

View file

@ -22,7 +22,7 @@ from sat.core.constants import Const as C
from sat.core.log import getLogger from sat.core.log import getLogger
log = getLogger(__name__) log = getLogger(__name__)
from sat.core import exceptions from sat.core import exceptions
from sat.tools import common from sat.tools.common import data_format
from twisted.internet import threads from twisted.internet import threads
from collections import OrderedDict from collections import OrderedDict
import itertools import itertools
@ -159,7 +159,7 @@ class DotclearParser(object):
def metaFinishedHandler(self): def metaFinishedHandler(self):
for post_id, tags in self.tags.iteritems(): for post_id, tags in self.tags.iteritems():
common.iter2dict('tag', tags, self.posts_data[post_id]['blog']) data_format.iter2dict('tag', tags, self.posts_data[post_id]['blog'])
del self.tags del self.tags
def commentHandler(self, headers, data, index): def commentHandler(self, headers, data, index):

View file

@ -25,7 +25,7 @@ from twisted.internet import defer
from sat.core import exceptions from sat.core import exceptions
from wokkel import disco, data_form, iwokkel from wokkel import disco, data_form, iwokkel
from zope.interface import implements from zope.interface import implements
from sat.tools import common from sat.tools.common import data_format
try: try:
from twisted.words.protocols.xmlstream import XMPPHandler from twisted.words.protocols.xmlstream import XMPPHandler
@ -102,7 +102,7 @@ class GroupBlog(object):
access_model = config_form.get(self._p.OPT_ACCESS_MODEL, self._p.ACCESS_OPEN) access_model = config_form.get(self._p.OPT_ACCESS_MODEL, self._p.ACCESS_OPEN)
# FIXME: ACCESS_ROSTER need to be changed to a new ACCESS_PUBLISHER_ROSTER when available # FIXME: ACCESS_ROSTER need to be changed to a new ACCESS_PUBLISHER_ROSTER when available
if access_model == self._p.ACCESS_ROSTER: if access_model == self._p.ACCESS_ROSTER:
common.iter2dict('group', config_form.fields[self._p.OPT_ROSTER_GROUPS_ALLOWED].values, microblog_data) data_format.iter2dict('group', config_form.fields[self._p.OPT_ROSTER_GROUPS_ALLOWED].values, microblog_data)
def _data2entryTrigger(self, client, mb_data, entry_elt, item_elt): def _data2entryTrigger(self, client, mb_data, entry_elt, item_elt):
"""Build fine access permission if needed """Build fine access permission if needed
@ -110,7 +110,7 @@ class GroupBlog(object):
This trigger check if "group*" key are present, This trigger check if "group*" key are present,
and create a fine item config to restrict view to these groups and create a fine item config to restrict view to these groups
""" """
groups = list(common.dict2iter('group', mb_data)) groups = list(data_format.dict2iter('group', mb_data))
if not groups: if not groups:
return return
if not client.server_groupblog_available: if not client.server_groupblog_available:
@ -132,7 +132,7 @@ class GroupBlog(object):
if "group" in mb_data: if "group" in mb_data:
# FIXME: ACCESS_ROSTER need to be changed to a new ACCESS_PUBLISHER_ROSTER when available # FIXME: ACCESS_ROSTER need to be changed to a new ACCESS_PUBLISHER_ROSTER when available
options[self._p.OPT_ACCESS_MODEL] = self._p.ACCESS_ROSTER options[self._p.OPT_ACCESS_MODEL] = self._p.ACCESS_ROSTER
options[self._p.OPT_ROSTER_GROUPS_ALLOWED] = list(common.dict2iter('group', mb_data)) options[self._p.OPT_ROSTER_GROUPS_ALLOWED] = list(data_format.dict2iter('group', mb_data))
class GroupBlog_handler(XMPPHandler): class GroupBlog_handler(XMPPHandler):

View file

@ -28,7 +28,7 @@ from twisted.python import failure
from sat.core import exceptions from sat.core import exceptions
from sat.tools import xml_tools from sat.tools import xml_tools
from sat.tools import sat_defer from sat.tools import sat_defer
from sat.tools import common from sat.tools.common import data_format
# XXX: tmp.pubsub is actually use instead of wokkel version # XXX: tmp.pubsub is actually use instead of wokkel version
from wokkel import pubsub from wokkel import pubsub
@ -326,7 +326,7 @@ class XEP_0277(object):
# categories # categories
categories = (category_elt.getAttribute('term','') for category_elt in entry_elt.elements(NS_ATOM, 'category')) categories = (category_elt.getAttribute('term','') for category_elt in entry_elt.elements(NS_ATOM, 'category'))
common.iter2dict('tag', categories, microblog_data) data_format.iter2dict('tag', categories, microblog_data)
## the trigger ## ## the trigger ##
# if other plugins have things to add or change # if other plugins have things to add or change
@ -426,7 +426,7 @@ class XEP_0277(object):
content=rfc3339.timestamp_from_tf(float(data.get('published', current_time)))) content=rfc3339.timestamp_from_tf(float(data.get('published', current_time))))
## categories ## ## categories ##
for tag in common.dict2iter("tag", data): for tag in data_format.dict2iter("tag", data):
category_elt = entry_elt.addElement("category") category_elt = entry_elt.addElement("category")
category_elt['term'] = tag category_elt['term'] = tag

View file

@ -0,0 +1,81 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# SAT: a jabber client
# 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/>.
""" tools common to backend and frontends """
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 mb_data (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 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