libervia-backend: src/plugins/plugin_xep

annotate src/plugins/plugin_xep_0277.py @ 1733:3770d13776e8

plugin XEP-0277, xml_tools: restore decapsulation of XHTML content - to avoid successive nesting of the content in <div> - otherwise there is a new <div> at each item modification

author	souliane <souliane@mailoo.org>
date	Thu, 10 Dec 2015 14:21:51 +0100
parents	cf11cfc87ef9
children	56fa4e7e158c

rev	line source
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	3
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	4 # SAT plugin for microblogging over XMPP (xep-0277)
1396 069ad98b360d 2015 copyright dates update Goffi <goffi@goffi.org> parents: 1275 diff changeset	5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Jérôme Poisson (goffi@goffi.org)
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	6
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	10 # (at your option) any later version.
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	11
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	15 # GNU Affero General Public License for more details.
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	16
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	19
1648 2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	20 from sat.core.i18n import _, D_
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 859 diff changeset	21 from sat.core.constants import Const as C
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	22 from sat.core.log import getLogger
301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 916 diff changeset	23 log = getLogger(__name__)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	24 from twisted.words.protocols.jabber import jid, error
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	25 from twisted.words.xish import domish
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	26 from twisted.internet import defer
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	27 from twisted.python import failure
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	28 from sat.core import exceptions
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	29 from sat.tools import xml_tools
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	30 from sat.tools import sat_defer
1664 5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	31 from sat.tools import common
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	32
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	33 # XXX: tmp.pubsub is actually use instead of wokkel version
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	34 from wokkel import pubsub
1542 94901070478e plugins: added new MissingModule exceptions to plugins using third party modules Goffi <goffi@goffi.org> parents: 1516 diff changeset	35 try:
94901070478e plugins: added new MissingModule exceptions to plugins using third party modules Goffi <goffi@goffi.org> parents: 1516 diff changeset	36 from feed.date import rfc3339
94901070478e plugins: added new MissingModule exceptions to plugins using third party modules Goffi <goffi@goffi.org> parents: 1516 diff changeset	37 except ImportError:
94901070478e plugins: added new MissingModule exceptions to plugins using third party modules Goffi <goffi@goffi.org> parents: 1516 diff changeset	38 raise exceptions.MissingModule(u"Missing module pyfeed, please download/install it from http://home.avvanta.com/~steveha/pyfeed.html")
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	39 import uuid
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	40 import time
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	41 import urlparse
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	42 import urllib
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	43
42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	44 NS_MICROBLOG = 'urn:xmpp:microblog:0'
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	45 NS_ATOM = 'http://www.w3.org/2005/Atom'
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	46 NS_XHTML = 'http://www.w3.org/1999/xhtml'
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	47 NS_PUBSUB_EVENT = "{}{}".format(pubsub.NS_PUBSUB, "#event")
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	48 NS_COMMENT_PREFIX = '{}:comments/'.format(NS_MICROBLOG)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	49
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	50
42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	51 PLUGIN_INFO = {
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	52 "name": "Microblogging over XMPP Plugin",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	53 "import_name": "XEP-0277",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	54 "type": "XEP",
1275 54a898821740 plugin XEP-0277: minor fix in plugin declaration souliane <souliane@mailoo.org> parents: 1268 diff changeset	55 "protocols": ["XEP-0277"],
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	56 "dependencies": ["XEP-0163", "XEP-0060", "TEXT-SYNTAXES"],
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	57 "recommendations": ["XEP-0059", "EXTRA-PEP"],
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	58 "main": "XEP_0277",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	59 "handler": "no",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	60 "description": _("""Implementation of microblogging Protocol""")
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	61 }
42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	62
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	63
339 b0b773f432e5 plugin XEP-00277: setMicroblogAccess is now asynchronous Goffi <goffi@goffi.org> parents: 311 diff changeset	64 class NodeAccessChangeException(Exception):
b0b773f432e5 plugin XEP-00277: setMicroblogAccess is now asynchronous Goffi <goffi@goffi.org> parents: 311 diff changeset	65 pass
b0b773f432e5 plugin XEP-00277: setMicroblogAccess is now asynchronous Goffi <goffi@goffi.org> parents: 311 diff changeset	66
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	67
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	68 class XEP_0277(object):
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	69
42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	70 def __init__(self, host):
1680 1e06a0f8be66 plugin XEP-0277: unicode fixes in logs Goffi <goffi@goffi.org> parents: 1679 diff changeset	71 log.info(_(u"Microblogging plugin initialization"))
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	72 self.host = host
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1450 diff changeset	73 self._p = self.host.plugins["XEP-0060"] # this facilitate the access to pubsub plugin
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	74 self.rt_sessions = sat_defer.RTDeferredSessions()
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	75 self.host.plugins["XEP-0060"].addManagedNode(None, items_cb=self._itemsReceived)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	76
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	77 host.bridge.addMethod("mbSend", ".plugin",
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	78 in_sign='ssa{ss}s', out_sign='',
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	79 method=self._mbSend,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	80 async=True)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	81 host.bridge.addMethod("mbRetract", ".plugin",
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	82 in_sign='ssss', out_sign='',
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	83 method=self._mbRetract,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	84 async=True)
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	85 host.bridge.addMethod("mbGet", ".plugin",
955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	86 in_sign='ssiasa{ss}s', out_sign='(aa{ss}a{ss})',
955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	87 method=self._mbGet,
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	88 async=True)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	89 host.bridge.addMethod("mbSetAccess", ".plugin", in_sign='ss', out_sign='',
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	90 method=self.mbSetAccess,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	91 async=True)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	92 host.bridge.addMethod("mbSetAccess", ".plugin", in_sign='ss', out_sign='',
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	93 method=self.mbSetAccess,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	94 async=True)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	95 host.bridge.addMethod("mbSubscribeToMany", ".plugin", in_sign='sass', out_sign='s',
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	96 method=self._mbSubscribeToMany)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	97 host.bridge.addMethod("mbGetFromManyRTResult", ".plugin", in_sign='ss', out_sign='(ua(sssaa{ss}a{ss}))',
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	98 method=self._mbGetFromManyRTResult, async=True)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	99 host.bridge.addMethod("mbGetFromMany", ".plugin", in_sign='sasia{ss}s', out_sign='s',
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	100 method=self._mbGetFromMany)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	101 host.bridge.addMethod("mbGetFromManyWithCommentsRTResult", ".plugin", in_sign='ss', out_sign='(ua(sssa(a{ss}a(sssaa{ss}a{ss}))a{ss}))',
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	102 method=self._mbGetFromManyWithCommentsRTResult, async=True)
1516 afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	103 host.bridge.addMethod("mbGetFromManyWithComments", ".plugin", in_sign='sasiia{ss}a{ss}s', out_sign='s',
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	104 method=self._mbGetFromManyWithComments)
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	105 host.bridge.addMethod("mbGetAtom", ".plugin", in_sign='ssiasa{ss}s', out_sign='s',
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	106 method=self._mbGetAtom, async=True)
302 9f3a6cf91668 plugin xep-0277: added getLastMicroblogs method Goffi <goffi@goffi.org> parents: 297 diff changeset	107
1656 069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	108 def _checkFeaturesCb(self, available):
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	109 return {'available': C.BOOL_TRUE}
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	110
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	111 def _checkFeaturesEb(self, fail):
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	112 return {'available': C.BOOL_FALSE}
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	113
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	114 def getFeatures(self, profile):
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	115 d = self.host.checkFeatures([], identity=('pubsub', 'pep'), profile=profile)
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	116 d.addCallbacks(self._checkFeaturesCb, self._checkFeaturesEb)
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	117 return d
069abd15354f plugin XEP-0277: checkFeatures implemented Goffi <goffi@goffi.org> parents: 1649 diff changeset	118
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	119 ## plugin management methods ##
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	120
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	121 def _itemsReceived(self, itemsEvent, profile):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	122 """Callback which manage items notifications (publish + retract)"""
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	123 if not itemsEvent.nodeIdentifier.startswith(NS_MICROBLOG):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	124 return
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	125 def manageItem(data, event):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	126 self.host.bridge.psEvent(C.PS_MICROBLOG, itemsEvent.sender.full(), itemsEvent.nodeIdentifier, event, data, profile)
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	127
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	128 for item in itemsEvent.items:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	129 if item.name == C.PS_ITEM:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	130 self.item2mbdata(item).addCallbacks(manageItem, lambda failure: None, (C.PS_PUBLISH,))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	131 elif item.name == C.PS_RETRACT:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	132 manageItem({'id': item['id']}, C.PS_RETRACT)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	133 else:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	134 raise exceptions.InternalError("Invalid event value")
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	135
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	136
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	137 ## data/item transformation ##
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	138
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	139 @defer.inlineCallbacks
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	140 def item2mbdata(self, item_elt):
302 9f3a6cf91668 plugin xep-0277: added getLastMicroblogs method Goffi <goffi@goffi.org> parents: 297 diff changeset	141 """Convert an XML Item to microblog data used in bridge API
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	142
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	143 @param item_elt: domish.Element of microblog item
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	144 @return: microblog data (dictionary)
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	145 """
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	146 microblog_data = {}
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	147
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	148 def check_conflict(key, increment=False):
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	149 """Check if key is already in microblog data
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	150
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	151 @param key(unicode): key to check
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	152 @param increment(bool): if suffix the key with an increment
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	153 instead of raising an exception
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	154 @raise exceptions.DataError: the key already exists
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	155 (not raised if increment is True)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	156 """
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	157 if key in microblog_data:
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	158 if not increment:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	159 raise failure.Failure(exceptions.DataError("key {} is already present for item {}").format(key, item_elt['id']))
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	160 else:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	161 idx=1 # the idx 0 is the key without suffix
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	162 fmt = "{}#{}"
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	163 new_key = fmt.format(key, idx)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	164 while new_key in microblog_data:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	165 idx+=1
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	166 new_key = fmt.format(key, idx)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	167 key = new_key
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	168 return key
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	169
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	170 @defer.inlineCallbacks
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	171 def parseElement(elem):
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	172 """Parse title/content elements and fill microblog_data accordingly"""
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	173 type_ = elem.getAttribute('type')
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	174 if type_ == 'xhtml':
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	175 data_elt = elem.firstChildElement()
1709 c47ba491a85a plugin XEP-0277: raise a failure if XHTML content is not wrapped in a <div/> Goffi <goffi@goffi.org> parents: 1708 diff changeset	176 if data_elt is None:
c47ba491a85a plugin XEP-0277: raise a failure if XHTML content is not wrapped in a <div/> Goffi <goffi@goffi.org> parents: 1708 diff changeset	177 raise failure.Failure(exceptions.DataError(u"XHML content not wrapped in a <div/> element, this is not standard !"))
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	178 if data_elt.uri != NS_XHTML:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	179 raise failure.Failure(exceptions.DataError(_('Content of type XHTML must declare its namespace!')))
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	180 key = check_conflict(u'{}_xhtml'.format(elem.name))
1733 3770d13776e8 plugin XEP-0277, xml_tools: restore decapsulation of XHTML content souliane <souliane@mailoo.org> parents: 1732 diff changeset	181
3770d13776e8 plugin XEP-0277, xml_tools: restore decapsulation of XHTML content souliane <souliane@mailoo.org> parents: 1732 diff changeset	182 # This is needed to avoid a successive encapsulation with a new <div>...</div>
3770d13776e8 plugin XEP-0277, xml_tools: restore decapsulation of XHTML content souliane <souliane@mailoo.org> parents: 1732 diff changeset	183 # each time the item is modified (encapsulation is done in self.data2entry).
3770d13776e8 plugin XEP-0277, xml_tools: restore decapsulation of XHTML content souliane <souliane@mailoo.org> parents: 1732 diff changeset	184 data = xml_tools.decapsulateDomishContent(data_elt)
3770d13776e8 plugin XEP-0277, xml_tools: restore decapsulation of XHTML content souliane <souliane@mailoo.org> parents: 1732 diff changeset	185
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	186 microblog_data[key] = yield self.host.plugins["TEXT-SYNTAXES"].clean_xhtml(data)
1732 cf11cfc87ef9 xml_tools, plugin XEP-0071, XEP-0277: add method expandNewLinesToXHTML: souliane <souliane@mailoo.org> parents: 1728 diff changeset	187 microblog_data[key] = xml_tools.expandNewLinesToXHTML(microblog_data[key])
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	188 else:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	189 key = check_conflict(elem.name)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	190 microblog_data[key] = unicode(elem)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	191
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	192
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	193 id_ = item_elt.getAttribute('id', '') # there can be no id for transient nodes
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	194 microblog_data['id'] = id_
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	195 if item_elt.uri not in (pubsub.NS_PUBSUB, NS_PUBSUB_EVENT):
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	196 msg = u"Unsupported namespace {ns} in pubsub item {id_}".format(ns=item_elt.uri, id_=id_)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	197 log.warning(msg)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	198 raise failure.Failure(exceptions.DataError(msg))
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	199
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	200 try:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	201 entry_elt = item_elt.elements(NS_ATOM, 'entry').next()
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	202 except StopIteration:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	203 msg = u'No atom entry found in the pubsub item {}'.format(id_)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	204 raise failure.Failure(exceptions.DataError(msg))
859 64ec04991d9d plugin XEP-0277: fix pubsub entry parsing using lxml instead of feed.atom souliane <souliane@mailoo.org> parents: 858 diff changeset	205
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	206 # atom:id
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	207 try:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	208 id_elt = entry_elt.elements(NS_ATOM, 'id').next()
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	209 except StopIteration:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	210 msg = u'No atom id found in the pubsub item {}, this is not standard !'.format(id_)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	211 log.warning(msg)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	212 microblog_data['atom_id'] = ""
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	213 else:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	214 microblog_data['atom_id'] = unicode(id_elt)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	215
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	216 # title/content(s)
1708 6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	217
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	218 # FIXME: ATOM and XEP-0277 only allow 1 <title/> element
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	219 # but in the wild we have some blogs with several ones
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	220 # so we don't respect the standard for now (it doesn't break
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	221 # anything anyway), and we'll find a better option later
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	222 # try:
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	223 # title_elt = entry_elt.elements(NS_ATOM, 'title').next()
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	224 # except StopIteration:
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	225 # msg = u'No atom title found in the pubsub item {}'.format(id_)
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	226 # raise failure.Failure(exceptions.DataError(msg))
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	227 title_elts = list(entry_elt.elements(NS_ATOM, 'title'))
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	228 if not title_elts:
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	229 msg = u'No atom title found in the pubsub item {}'.format(id_)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	230 raise failure.Failure(exceptions.DataError(msg))
1708 6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	231 for title_elt in title_elts:
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	232 yield parseElement(title_elt)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	233
1708 6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	234 # FIXME: as for <title/>, Atom only authorise at most 1 content
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	235 # but XEP-0277 allows several ones. So for no we handle as
6d6eae490681 plugin XEP-0277: accept several <title/> elements, there is a standard issue so for now it's the most flexible behaviour Goffi <goffi@goffi.org> parents: 1699 diff changeset	236 # if more than one can be present
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	237 for content_elt in entry_elt.elements(NS_ATOM, 'content'):
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	238 yield parseElement(content_elt)
859 64ec04991d9d plugin XEP-0277: fix pubsub entry parsing using lxml instead of feed.atom souliane <souliane@mailoo.org> parents: 858 diff changeset	239
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	240 # we check that text content is present
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	241 for key in ('title', 'content'):
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	242 if key not in microblog_data and ('{}_xhtml'.format(key)) in microblog_data:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	243 log.warning(u"item {id_} provide a {key}_xhtml data but not a text one".format(id_=id_, key=key))
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	244 # ... and do the conversion if it's not
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	245 microblog_data[key] = yield self.host.plugins["TEXT-SYNTAXES"].\
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	246 convert(microblog_data['{}_xhtml'.format(key)],
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	247 self.host.plugins["TEXT-SYNTAXES"].SYNTAX_XHTML,
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	248 self.host.plugins["TEXT-SYNTAXES"].SYNTAX_TEXT,
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	249 False)
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	250
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	251 if 'content' not in microblog_data:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	252 # use the atom title data as the microblog body content
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	253 microblog_data['content'] = microblog_data['title']
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	254 del microblog_data['title']
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	255 if 'title_xhtml' in microblog_data:
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	256 microblog_data['content_xhtml'] = microblog_data['title_xhtml']
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	257 del microblog_data['title_xhtml']
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	258
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	259 # published/updated dates
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	260 try:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	261 updated_elt = entry_elt.elements(NS_ATOM, 'updated').next()
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	262 except StopIteration:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	263 msg = u'No atom updated element found in the pubsub item {}'.format(id_)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	264 raise failure.Failure(exceptions.DataError(msg))
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	265 microblog_data['updated'] = unicode(rfc3339.tf_from_timestamp(unicode(updated_elt)))
302 9f3a6cf91668 plugin xep-0277: added getLastMicroblogs method Goffi <goffi@goffi.org> parents: 297 diff changeset	266 try:
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	267 published_elt = entry_elt.elements(NS_ATOM, 'published').next()
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	268 except StopIteration:
859 64ec04991d9d plugin XEP-0277: fix pubsub entry parsing using lxml instead of feed.atom souliane <souliane@mailoo.org> parents: 858 diff changeset	269 microblog_data['published'] = microblog_data['updated']
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	270 else:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	271 microblog_data['published'] = unicode(rfc3339.tf_from_timestamp(unicode(published_elt)))
859 64ec04991d9d plugin XEP-0277: fix pubsub entry parsing using lxml instead of feed.atom souliane <souliane@mailoo.org> parents: 858 diff changeset	272
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	273 # links
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	274 for link_elt in entry_elt.elements(NS_ATOM, 'link'):
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	275 if link_elt.getAttribute('rel') == 'replies' and link_elt.getAttribute('title') == 'comments':
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	276 key = check_conflict('comments', True)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	277 microblog_data[key] = link_elt['href']
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	278 try:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	279 service, node = self.parseCommentUrl(microblog_data[key])
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	280 except:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	281 log.warning(u"Can't parse url {}".format(microblog_data[key]))
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	282 del microblog_data[key]
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	283 else:
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	284 microblog_data['{}_service'.format(key)] = service.full()
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	285 microblog_data['{}_node'.format(key)] = node
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	286 else:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	287 rel = link_elt.getAttribute('rel','')
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	288 title = link_elt.getAttribute('title','')
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	289 href = link_elt.getAttribute('href','')
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	290 log.warning(u"Unmanaged link element: rel={rel} title={title} href={href}".format(rel=rel, title=title, href=href))
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	291
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	292 # author
859 64ec04991d9d plugin XEP-0277: fix pubsub entry parsing using lxml instead of feed.atom souliane <souliane@mailoo.org> parents: 858 diff changeset	293 try:
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	294 author_elt = entry_elt.elements(NS_ATOM, 'author').next()
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	295 except StopIteration:
1680 1e06a0f8be66 plugin XEP-0277: unicode fixes in logs Goffi <goffi@goffi.org> parents: 1679 diff changeset	296 log.debug(u"Can't find author element in item {}".format(id_))
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	297 else:
1681 c6c835046681 plugin XEP-0277: minor fixes for publisher attribute Goffi <goffi@goffi.org> parents: 1680 diff changeset	298 publisher = item_elt.getAttribute("publisher")
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	299 # name
770 64dd7c0f4feb plugin groupblog, XEP-0277: store both published and updated timestamps souliane <souliane@mailoo.org> parents: 745 diff changeset	300 try:
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	301 name_elt = author_elt.elements(NS_ATOM, 'name').next()
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	302 except StopIteration:
1680 1e06a0f8be66 plugin XEP-0277: unicode fixes in logs Goffi <goffi@goffi.org> parents: 1679 diff changeset	303 log.warning(u"No name element found in author element of item {}".format(id_))
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	304 else:
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	305 microblog_data['author'] = unicode(name_elt)
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	306 # uri
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	307 try:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	308 uri_elt = author_elt.elements(NS_ATOM, 'uri').next()
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	309 except StopIteration:
1680 1e06a0f8be66 plugin XEP-0277: unicode fixes in logs Goffi <goffi@goffi.org> parents: 1679 diff changeset	310 log.debug(u"No uri element found in author element of item {}".format(id_))
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	311 if publisher:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	312 microblog_data['author_jid'] = publisher
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	313 else:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	314 uri = unicode(uri_elt)
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	315 if uri.startswith("xmpp:"):
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	316 uri = uri[5:]
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	317 microblog_data['author_jid'] = uri
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	318 else:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	319 microblog_data['author_jid'] = item_elt.getAttribute("publisher") or ""
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	320
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	321 if not publisher:
1680 1e06a0f8be66 plugin XEP-0277: unicode fixes in logs Goffi <goffi@goffi.org> parents: 1679 diff changeset	322 log.debug(u"No publisher attribute, we can't verify author jid")
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	323 microblog_data['author_jid_verified'] = C.BOOL_FALSE
1681 c6c835046681 plugin XEP-0277: minor fixes for publisher attribute Goffi <goffi@goffi.org> parents: 1680 diff changeset	324 elif jid.JID(publisher).userhostJID() == jid.JID(uri).userhostJID():
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	325 microblog_data['author_jid_verified'] = C.BOOL_TRUE
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	326 else:
1680 1e06a0f8be66 plugin XEP-0277: unicode fixes in logs Goffi <goffi@goffi.org> parents: 1679 diff changeset	327 log.warning(u"item atom:uri differ from publisher attribute, spoofing attempt ? atom:uri = {} publisher = {}".format(uri, item_elt.getAttribute("publisher")))
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	328 microblog_data['author_jid_verified'] = C.BOOL_FALSE
1453 d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	329 # email
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	330 try:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	331 email_elt = author_elt.elements(NS_ATOM, 'email').next()
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	332 except StopIteration:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	333 pass
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	334 else:
d5e72362ee91 plugin XEP-0277: better parsing of atom:author element + item2mbdata minor reorganisation for better readability Goffi <goffi@goffi.org> parents: 1452 diff changeset	335 microblog_data['author_email'] = unicode(email_elt)
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	336
1664 5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	337 # categories
5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	338 categories = (category_elt.getAttribute('term','') for category_elt in entry_elt.elements(NS_ATOM, 'category'))
5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	339 common.iter2dict('tag', categories, microblog_data)
5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	340
1671 1895846fc9cb plugin XEP-0277, group blog: added item2data trigger + group permission are parsed when receiving a new item Goffi <goffi@goffi.org> parents: 1664 diff changeset	341 ## the trigger ##
1895846fc9cb plugin XEP-0277, group blog: added item2data trigger + group permission are parsed when receiving a new item Goffi <goffi@goffi.org> parents: 1664 diff changeset	342 # if other plugins have things to add or change
1895846fc9cb plugin XEP-0277, group blog: added item2data trigger + group permission are parsed when receiving a new item Goffi <goffi@goffi.org> parents: 1664 diff changeset	343 yield self.host.trigger.point("XEP-0277_item2data", item_elt, entry_elt, microblog_data)
1895846fc9cb plugin XEP-0277, group blog: added item2data trigger + group permission are parsed when receiving a new item Goffi <goffi@goffi.org> parents: 1664 diff changeset	344
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	345 defer.returnValue(microblog_data)
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	346
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	347 @defer.inlineCallbacks
1661 96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	348 def data2entry(self, data, item_id=None, profile=C.PROF_KEY_NONE):
306 169e7386650a plugin xep-0277: bridge data is now converted in pubsub item in a separate function Goffi <goffi@goffi.org> parents: 304 diff changeset	349 """Convert a data dict to en entry usable to create an item
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	350
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	351 @param data: data dict as given by bridge method.
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	352 @param item_id(unicode, None): id of the item to use
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	353 if None the id will be generated randomly
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	354 @return: deferred which fire domish.Element
be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	355 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	356 if item_id is None:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	357 item_id = unicode(uuid.uuid4())
1661 96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	358 client = self.host.getClient(profile)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	359 entry_elt = domish.Element((NS_ATOM, 'entry'))
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	360
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	361 ## content and title ##
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	362 synt = self.host.plugins["TEXT-SYNTAXES"]
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	363
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	364 for elem_name in ('title', 'content'):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	365 for type_ in ['', '_rich', '_xhtml']:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	366 attr = "{}{}".format(elem_name, type_)
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	367 if attr in data:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	368 elem = entry_elt.addElement(elem_name)
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	369 if type_:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	370 if type_ == '_rich': # convert input from current syntax to XHTML
1661 96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	371 converted = yield synt.convert(data[attr], synt.getCurrentSyntax(profile), "XHTML")
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	372 if '{}_xhtml'.format(elem_name) in data:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	373 raise failure.Failure(exceptions.DataError(_("Can't have xhtml and rich content at the same time")))
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	374 else: # clean the XHTML input
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	375 converted = yield synt.clean_xhtml(data[attr])
1732 cf11cfc87ef9 xml_tools, plugin XEP-0071, XEP-0277: add method expandNewLinesToXHTML: souliane <souliane@mailoo.org> parents: 1728 diff changeset	376 converted = xml_tools.expandNewLinesToXHTML(converted)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	377
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	378 xml_content = u'<div xmlns="{ns}">{converted}</div>'.format(
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	379 ns=NS_XHTML,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	380 converted=converted)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	381 elem.addChild(xml_tools.ElementParser()(xml_content))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	382 elem['type'] = 'xhtml'
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	383 if elem_name not in data:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	384 # there is raw text content, which is mandatory
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	385 # so we create one from xhtml content
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	386 elem_txt = entry_elt.addElement(elem_name)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	387 text_content = yield self.host.plugins["TEXT-SYNTAXES"].convert(xml_content,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	388 self.host.plugins["TEXT-SYNTAXES"].SYNTAX_XHTML,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	389 self.host.plugins["TEXT-SYNTAXES"].SYNTAX_TEXT,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	390 False)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	391 elem_txt.addContent(text_content)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	392 elem_txt['type'] = 'text'
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	393
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 811 diff changeset	394 else: # raw text only needs to be escaped to get HTML-safe sequence
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	395 elem.addContent(data[attr])
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	396 elem['type'] = 'text'
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	397
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	398 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	399 entry_elt.elements(NS_ATOM, 'title').next()
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	400 except StopIteration:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	401 # we have no title element which is mandatory
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	402 # so we transform content element to title
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	403 elems = list(entry_elt.elements(NS_ATOM, 'content'))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	404 if not elems:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	405 raise exceptions.DataError("There must be at least one content or title element")
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	406 for elem in elems:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	407 elem.name = 'title'
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	408
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	409 ## author ##
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	410 author_elt = entry_elt.addElement('author')
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	411 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	412 author_name = data['author']
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	413 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	414 # FIXME: must use better name
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	415 author_name = client.jid.user
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	416 author_elt.addElement('name', content=author_name)
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	417
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	418 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	419 author_jid_s = data['author_jid']
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	420 except KeyError:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	421 author_jid_s = client.jid.userhost()
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	422 author_elt.addElement('uri', content="xmpp:{}".format(author_jid_s))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	423
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	424 ## published/updated time ##
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	425 current_time = time.time()
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	426 entry_elt.addElement('updated',
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	427 content=rfc3339.timestamp_from_tf(float(data.get('updated', current_time))))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	428 entry_elt.addElement('published',
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	429 content=rfc3339.timestamp_from_tf(float(data.get('published', current_time))))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	430
1664 5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	431 ## categories ##
5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	432 for tag in common.dict2iter("tag", data):
5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	433 category_elt = entry_elt.addElement("category")
5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	434 category_elt['term'] = tag
5d0ff155be1a plugin XEP-0277: tags are handled through atom categories Goffi <goffi@goffi.org> parents: 1661 diff changeset	435
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	436 ## id ##
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	437 entry_id = data.get('id', item_id) # FIXME: use a proper id (see XEP-0277 §7.1)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	438 entry_elt.addElement('id', content=entry_id) #
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	439
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	440 ## comments ##
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	441 if 'comments' in data:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	442 link_elt = entry_elt.addElement('link')
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	443 link_elt['href'] = data['comments']
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	444 link_elt['rel'] = 'replies'
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	445 link_elt['title'] = 'comments'
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	446
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	447 ## final item building ##
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	448 item_elt = pubsub.Item(id=item_id, payload=entry_elt)
1661 96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	449
96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	450 ## the trigger ##
96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	451 # if other plugins have things to add or change
96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	452 yield self.host.trigger.point("XEP-0277_data2entry", client, data, entry_elt, item_elt)
96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	453
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	454 defer.returnValue(item_elt)
306 169e7386650a plugin xep-0277: bridge data is now converted in pubsub item in a separate function Goffi <goffi@goffi.org> parents: 304 diff changeset	455
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	456 ## publish ##
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	457
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	458 @defer.inlineCallbacks
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	459 def _manageComments(self, access, mb_data, service, node, item_id, profile):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	460 """Check comments keys in mb_data and create comments node if necessary
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	461
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	462 @param access(unicode): access model
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	463 @param mb_data(dict): microblog mb_data
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	464 @param service(jid.JID): Pubsub service of the parent item
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	465 @param node(unicode): node of the parent item
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	466 @param item_id(unicoe): id of the parent item
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	467 """
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	468 allow_comments = C.bool(mb_data.pop("allow_comments", "false"))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	469 if not allow_comments:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	470 return
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	471
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	472 client = self.host.getClient(profile)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	473
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	474 options = {self._p.OPT_ACCESS_MODEL: access,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	475 self._p.OPT_PERSIST_ITEMS: 1,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	476 self._p.OPT_MAX_ITEMS: -1,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	477 self._p.OPT_DELIVER_PAYLOADS: 1,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	478 self._p.OPT_SEND_ITEM_SUBSCRIBE: 1,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	479 self._p.OPT_PUBLISH_MODEL: "subscribers", # TODO: should be open if both node and item access_model are open (public node and item)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	480 }
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	481
1661 96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	482 # if other plugins need to change the options
96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	483 yield self.host.trigger.point("XEP-0277_comments", client, mb_data, options)
96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	484
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	485 comments_node_base = u"{}{}".format(NS_COMMENT_PREFIX, item_id)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	486 comments_node = comments_node_base
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	487 comments_service = client.pubsub_service if client.pubsub_service is not None else service
1661 96ee986dab3c plugin XEP-0277: added a trigger on data2entry and comments management Goffi <goffi@goffi.org> parents: 1656 diff changeset	488
1711 e5b569d0c2e7 plugin XEP-0277: don't try to create a new comments node if it already exists souliane <souliane@mailoo.org> parents: 1709 diff changeset	489 try:
e5b569d0c2e7 plugin XEP-0277: don't try to create a new comments node if it already exists souliane <souliane@mailoo.org> parents: 1709 diff changeset	490 yield self._p.createNode(comments_service, comments_node, options, profile_key=profile)
e5b569d0c2e7 plugin XEP-0277: don't try to create a new comments node if it already exists souliane <souliane@mailoo.org> parents: 1709 diff changeset	491 except error.StanzaError as e:
e5b569d0c2e7 plugin XEP-0277: don't try to create a new comments node if it already exists souliane <souliane@mailoo.org> parents: 1709 diff changeset	492 if e.condition == 'conflict':
e5b569d0c2e7 plugin XEP-0277: don't try to create a new comments node if it already exists souliane <souliane@mailoo.org> parents: 1709 diff changeset	493 log.info(u"node {} already exists on service {}".format(comments_node, comments_service))
e5b569d0c2e7 plugin XEP-0277: don't try to create a new comments node if it already exists souliane <souliane@mailoo.org> parents: 1709 diff changeset	494 else:
e5b569d0c2e7 plugin XEP-0277: don't try to create a new comments node if it already exists souliane <souliane@mailoo.org> parents: 1709 diff changeset	495 raise e
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	496
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	497 if comments_service is None:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	498 comments_service = client.jid.userhostJID()
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	499
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	500 mb_data['comments'] = "xmpp:%(service)s?%(query)s" % {
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	501 'service': comments_service.userhost(),
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	502 'query': urllib.urlencode([('node', comments_node.encode('utf-8'))])
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	503 }
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	504
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	505 def _mbSend(self, service, node, data, profile_key):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	506 service = jid.JID(service) if service else None
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	507 node = node if node else NS_MICROBLOG
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	508 profile = self.host.memory.getProfileName(profile_key)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	509 return self.send(service, node, data, profile)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	510
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	511 @defer.inlineCallbacks
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	512 def send(self, service=None, node=NS_MICROBLOG, data=None, profile=None):
306 169e7386650a plugin xep-0277: bridge data is now converted in pubsub item in a separate function Goffi <goffi@goffi.org> parents: 304 diff changeset	513 """Send XEP-0277's microblog data
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	514
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	515 @param service(jid.JID, None): PubSub service where the microblog must be published
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	516 None to publish on profile's PEP
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	517 @param node(unicode): PubSub node to use (defaut to microblog NS)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	518 @param data(dict): microblog data (must include at least a "content" or a "title" key).
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	519 see http://wiki.goffi.org/wiki/Bridge_API_-_Microblogging/en for details
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	520 @param profile: %(doc_profile)s
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	521 """
1699 a72f04c67ac9 plugin XEP-0277: just a reminder Goffi <goffi@goffi.org> parents: 1681 diff changeset	522 # TODO: check that all data keys are used, this would avoid sending publicly a private message
a72f04c67ac9 plugin XEP-0277: just a reminder Goffi <goffi@goffi.org> parents: 1681 diff changeset	523 # by accident (e.g. if group pluging is not loaded, and "grou*" key are not used)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	524 assert profile is not None
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	525
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	526 item_id = data.get('id') or unicode(uuid.uuid4())
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	527 try:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	528 yield self._manageComments(self._p.ACCESS_OPEN, data, service, node, item_id, profile)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	529 except error.StanzaError:
1680 1e06a0f8be66 plugin XEP-0277: unicode fixes in logs Goffi <goffi@goffi.org> parents: 1679 diff changeset	530 log.warning(u"Can't create comments node for item {}".format(item_id))
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	531 item = yield self.data2entry(data, item_id, profile)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	532 ret = yield self._p.publish(service, node, [item], profile_key=profile)
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	533 defer.returnValue(ret)
293 42438e43104a Plugin XEP-0277: first draft of microblogging over ip /!\ new dependencies added /!\ Goffi <goffi@goffi.org> parents: diff changeset	534
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	535
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	536 ## retract ##
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	537
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	538 def _mbRetract(self, service_jid_s, nodeIdentifier, itemIdentifier, profile_key):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	539 """Call self._p._retractItem, but use default node if node is empty"""
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	540 return self._p._retractItem(service_jid_s, nodeIdentifier or NS_MICROBLOG, itemIdentifier, True, profile_key)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	541
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	542 ## get ##
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	543
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	544 def _mbGet(self, service_jid_s, node="", max_items=10, item_ids=None, extra_dict=None, profile_key=C.PROF_KEY_NONE):
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	545 """
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	546 @param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	547 @param item_ids (list[unicode]): list of item IDs
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	548 """
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	549 max_items = None if max_items == C.NO_LIMIT else max_items
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	550 extra = self._p.parseExtra(extra_dict)
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	551 return self.mbGet(jid.JID(service_jid_s), node or None, max_items, item_ids, extra.rsm_request, extra.extra, profile_key)
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	552
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	553 @defer.inlineCallbacks
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	554 def mbGet(self, service_jid, node=None, max_items=None, item_ids=None, rsm_request=None, extra=None, profile_key=C.PROF_KEY_NONE):
1516 afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	555 """Get some microblogs
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	556
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	557 @param service_jid(jid.JID): jid of the publisher
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	558 @param node(unicode, None): node to get (or microblog node if None)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	559 @param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	560 @param item_ids (list[unicode]): list of item IDs
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	561 @param rsm_request (rsm.RSMRequest): RSM request data
1516 afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	562 @param extra (dict): extra data
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	563 @param profile_key: %(doc_profile_key)s
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1233 diff changeset	564
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	565 @return: a deferred couple with the list of items and metadatas.
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	566 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	567 if node is None:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	568 node = NS_MICROBLOG
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	569 items_data = yield self._p.getItems(service_jid, node, max_items=max_items, item_ids=item_ids, rsm_request=rsm_request, extra=extra, profile_key=profile_key)
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	570 serialised = yield self._p.serItemsDataD(items_data, self.item2mbdata)
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	571 defer.returnValue(serialised)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	572
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	573 def parseCommentUrl(self, node_url):
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	574 """Parse a XMPP URI
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	575
e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	576 Determine the fields comments_service and comments_node of a microblog data
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	577 from the href attribute of an entry's link element. For example this input:
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	578 xmpp:sat-pubsub.libervia.org?node=urn%3Axmpp%3Acomments%3A_c5c4a142-2279-4b2a-ba4c-1bc33aa87634__urn%3Axmpp%3Agroupblog%3Asouliane%40libervia.org
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	579 will return (JID(u'sat-pubsub.libervia.org'), 'urn:xmpp:comments:_c5c4a142-2279-4b2a-ba4c-1bc33aa87634__urn:xmpp:groupblog:souliane@libervia.org')
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	580 @return: a tuple (JID, str)
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	581 """
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	582 parsed_url = urlparse.urlparse(node_url, 'xmpp')
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	583 service = jid.JID(parsed_url.path)
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	584 queries = parsed_url.query.split(';')
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	585 parsed_queries = dict()
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	586 for query in queries:
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	587 parsed_queries.update(urlparse.parse_qs(query))
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	588 node = parsed_queries.get('node', [''])[0]
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	589
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	590 if not node:
1446 e8c8e467964b plugins xep-0060, xep-0277: code simplification/cleaning/fix: Goffi <goffi@goffi.org> parents: 1421 diff changeset	591 raise failure.Failure(exceptions.DataError('Invalid comments link'))
1421 16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	592
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	593 return (service, node)
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	594
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	595 ## configure ##
16b1ba7ccaaa plugins xep-0277: some methods reordering to make the plugin more readable Goffi <goffi@goffi.org> parents: 1419 diff changeset	596
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	597 def mbSetAccess(self, access="presence", profile_key=C.PROF_KEY_NONE):
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	598 """Create a microblog node on PEP with given access
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	599
304 e04ccf122bb6 microblog sending Goffi <goffi@goffi.org> parents: 303 diff changeset	600 If the node already exists, it change options
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	601 @param access: Node access model, according to xep-0060 #4.5
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	602 @param profile_key: profile key"""
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	603
306 169e7386650a plugin xep-0277: bridge data is now converted in pubsub item in a separate function Goffi <goffi@goffi.org> parents: 304 diff changeset	604 _jid, xmlstream = self.host.getJidNStream(profile_key)
311 0aa6ca6cdbdd plugin group blog: group blog now use PEP to take profit of autosubscribe Goffi <goffi@goffi.org> parents: 310 diff changeset	605 if not _jid:
1680 1e06a0f8be66 plugin XEP-0277: unicode fixes in logs Goffi <goffi@goffi.org> parents: 1679 diff changeset	606 log.error(_(u"Can't find profile's jid"))
311 0aa6ca6cdbdd plugin group blog: group blog now use PEP to take profit of autosubscribe Goffi <goffi@goffi.org> parents: 310 diff changeset	607 return
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1450 diff changeset	608 _options = {self._p.OPT_ACCESS_MODEL: access, self._p.OPT_PERSIST_ITEMS: 1, self._p.OPT_MAX_ITEMS: -1, self._p.OPT_DELIVER_PAYLOADS: 1, self._p.OPT_SEND_ITEM_SUBSCRIBE: 1}
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	609
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	610 def cb(result):
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	611 #Node is created with right permission
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	612 log.debug(_(u"Microblog node has now access %s") % access)
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	613
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	614 def fatal_err(s_error):
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	615 #Something went wrong
1680 1e06a0f8be66 plugin XEP-0277: unicode fixes in logs Goffi <goffi@goffi.org> parents: 1679 diff changeset	616 log.error(_(u"Can't set microblog access"))
468 c97640c90a94 D-Bus Bridge: use inspection to name attribute + fix asynchronous calls for dynamically added method, it now use deferred return value instead of callback/errback attributes Goffi <goffi@goffi.org> parents: 465 diff changeset	617 raise NodeAccessChangeException()
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	618
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	619 def err_cb(s_error):
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	620 #If the node already exists, the condition is "conflict",
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	621 #else we have an unmanaged error
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	622 if s_error.value.condition == 'conflict':
306 169e7386650a plugin xep-0277: bridge data is now converted in pubsub item in a separate function Goffi <goffi@goffi.org> parents: 304 diff changeset	623 #d = self.host.plugins["XEP-0060"].deleteNode(_jid.userhostJID(), NS_MICROBLOG, profile_key=profile_key)
304 e04ccf122bb6 microblog sending Goffi <goffi@goffi.org> parents: 303 diff changeset	624 #d.addCallback(lambda x: create_node().addCallback(cb).addErrback(fatal_err))
e04ccf122bb6 microblog sending Goffi <goffi@goffi.org> parents: 303 diff changeset	625 change_node_options().addCallback(cb).addErrback(fatal_err)
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	626 else:
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	627 fatal_err(s_error)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	628
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	629 def create_node():
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1450 diff changeset	630 return self._p.createNode(_jid.userhostJID(), NS_MICROBLOG, _options, profile_key=profile_key)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	631
304 e04ccf122bb6 microblog sending Goffi <goffi@goffi.org> parents: 303 diff changeset	632 def change_node_options():
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1450 diff changeset	633 return self._p.setOptions(_jid.userhostJID(), NS_MICROBLOG, _jid.userhostJID(), _options, profile_key=profile_key)
303 2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	634
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed Goffi <goffi@goffi.org> parents: 302 diff changeset	635 create_node().addCallback(cb).addErrback(err_cb)
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	636
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	637 ## methods to manage several stanzas/jids at once ##
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	638
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	639 # common
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	640
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	641 def _getClientAndNodeData(self, publishers_type, publishers, profile_key):
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	642 """Helper method to construct node_data from publishers_type/publishers
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	643
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	644 @param publishers_type: type of the list of publishers, one of:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	645 C.ALL: get all jids from roster, publishers is not used
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	646 C.GROUP: get jids from groups
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	647 C.JID: use publishers directly as list of jids
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	648 @param publishers: list of publishers, according to "publishers_type" (None, list of groups or list of jids)
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	649 @param profile_key: %(doc_profile_key)s
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	650 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	651 client = self.host.getClient(profile_key)
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	652 if publishers_type == C.JID:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	653 jids_set = set(publishers)
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	654 else:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	655 jids_set = client.roster.getJidsSet(publishers_type, publishers)
1728 0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	656 if publishers_type == C.ALL:
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	657 try: # display messages from salut-a-toi@libervia.org or other PEP services
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	658 services = self.host.plugins["EXTRA-PEP"].getConfig("get_items_from_list")
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	659 except KeyError:
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	660 pass
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	661 else:
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	662 log.debug("Items from the following extra PEP services will be requested as well: %s" % ", ".join(services))
0eaa1a409dfb plugin XEP-0277, EXTRA-PEP: get massive blogs from all the roster also retrieve items from a special JIDs list defined in EXTRA-PEP souliane <souliane@mailoo.org> parents: 1712 diff changeset	663 jids_set.update([jid.JID(service) for service in services])
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	664
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	665 node_data = []
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	666 for jid_ in jids_set:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	667 node_data.append((jid_, NS_MICROBLOG))
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	668 return client, node_data
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	669
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	670 def _checkPublishers(self, publishers_type, publishers):
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	671 """Helper method to deserialise publishers coming from bridge
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	672
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	673 publishers_type(unicode): type of the list of publishers, one of:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	674 publishers: list of publishers according to type
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	675 @return: deserialised (publishers_type, publishers) tuple
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	676 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	677 if publishers_type == C.ALL:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	678 if publishers:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	679 raise failure.Failure(ValueError("Can't use publishers with {} type".format(publishers_type)))
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	680 else:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	681 publishers = None
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	682 elif publishers_type == C.JID:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	683 publishers[:] = [jid.JID(publisher) for publisher in publishers]
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	684 return publishers_type, publishers
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	685
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	686
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	687
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	688 # subscribe #
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	689
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	690 def _mbSubscribeToMany(self, publishers_type, publishers, profile_key):
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	691 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	692
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	693 @return (str): session id: Use pubsub.getSubscribeRTResult to get the results
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	694 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	695 publishers_type, publishers = self._checkPublishers(publishers_type, publishers)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	696 return self.mbSubscribeToMany(publishers_type, publishers, profile_key)
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	697
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	698 def mbSubscribeToMany(self, publishers_type, publishers, profile_key):
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	699 """Subscribe microblogs for a list of groups or jids
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	700
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	701 @param publishers_type: type of the list of publishers, one of:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	702 C.ALL: get all jids from roster, publishers is not used
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	703 C.GROUP: get jids from groups
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	704 C.JID: use publishers directly as list of jids
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	705 @param publishers: list of publishers, according to "publishers_type" (None, list of groups or list of jids)
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	706 @param profile: %(doc_profile)s
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	707 @return (str): session id
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	708 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	709 client, node_data = self._getClientAndNodeData(publishers_type, publishers, profile_key)
1451 9b88b19b1ca8 plugins xep-0060, xep-0277: added methods to serialise getItems result (before bridge transmission): Goffi <goffi@goffi.org> parents: 1450 diff changeset	710 return self._p.subscribeToMany(node_data, client.jid.userhostJID(), profile_key=profile_key)
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1446 diff changeset	711
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	712 # get #
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	713
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	714 def _mbGetFromManyRTResult(self, session_id, profile_key=C.PROF_KEY_DEFAULT):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	715 """Get real-time results for mbGetFromMany session
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	716
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	717 @param session_id: id of the real-time deferred session
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	718 @param return (tuple): (remaining, results) where:
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	719 - remaining is the number of still expected results
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	720 - results is a list of tuple with
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	721 - service (unicode): pubsub service
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	722 - node (unicode): pubsub node
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	723 - failure (unicode): empty string in case of success, error message else
1513 955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	724 - items_data(list): data as returned by [mbGet]
955221487a3e plugin XEP-0277, quick_frontend: rename mbGetLast to mbGet and add it the parameter "item_ids" souliane <souliane@mailoo.org> parents: 1511 diff changeset	725 - items_metadata(dict): metadata as returned by [mbGet]
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	726 @param profile_key: %(doc_profile_key)s
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	727 """
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	728 def onSuccess(items_data):
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	729 """convert items elements to list of microblog data in items_data"""
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	730 d = self._p.serItemsDataD(items_data, self.item2mbdata)
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	731 d.addCallback(lambda serialised:('', serialised))
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	732 return d
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	733
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	734 profile = self.host.getClient(profile_key).profile
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	735 d = self._p.getRTResults(session_id,
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	736 on_success = onSuccess,
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	737 on_error = lambda failure: (unicode(failure.value), ([],{})),
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	738 profile = profile)
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	739 d.addCallback(lambda ret: (ret[0],
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	740 [(service.full(), node, failure, items, metadata)
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	741 for (service, node), (success, (failure, (items, metadata))) in ret[1].iteritems()]))
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	742 return d
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	743
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	744 def _mbGetFromMany(self, publishers_type, publishers, max_items=10, extra_dict=None, profile_key=C.PROF_KEY_NONE):
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	745 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	746 @param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	747 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	748 max_items = None if max_items == C.NO_LIMIT else max_items
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	749 publishers_type, publishers = self._checkPublishers(publishers_type, publishers)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	750 extra = self._p.parseExtra(extra_dict)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	751 return self.mbGetFromMany(publishers_type, publishers, max_items, extra.rsm_request, extra.extra, profile_key)
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	752
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	753 def mbGetFromMany(self, publishers_type, publishers, max_items=None, rsm_request=None, extra=None, profile_key=C.PROF_KEY_NONE):
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	754 """Get the published microblogs for a list of groups or jids
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	755
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	756 @param publishers_type (str): type of the list of publishers (one of "GROUP" or "JID" or "ALL")
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	757 @param publishers (list): list of publishers, according to publishers_type (list of groups or list of jids)
5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	758 @param max_items (int): optional limit on the number of retrieved items.
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	759 @param rsm_request (rsm.RSMRequest): RSM request data, common to all publishers
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	760 @param extra (dict): Extra data
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	761 @param profile_key: profile key
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	762 @return (str): RT Deferred session id
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	763 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	764 # XXX: extra is unused here so far
1452 5116d70ddd1c plugin xep-0060,xep-0277: added getFromMany using new RTDeferredSession mechanism Goffi <goffi@goffi.org> parents: 1451 diff changeset	765 client, node_data = self._getClientAndNodeData(publishers_type, publishers, profile_key)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	766 return self._p.getFromMany(node_data, max_items, rsm_request, profile_key=profile_key)
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	767
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	768 # comments #
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	769
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	770 def _mbGetFromManyWithCommentsRTResult(self, session_id, profile_key=C.PROF_KEY_DEFAULT):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	771 """Get real-time results for [mbGetFromManyWithComments] session
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	772
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	773 @param session_id: id of the real-time deferred session
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	774 @param return (tuple): (remaining, results) where:
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	775 - remaining is the number of still expected results
1511 83f71763e1a7 plugin XEP-0277: clarify a docstring for one complex method argument souliane <souliane@mailoo.org> parents: 1459 diff changeset	776 - results is a list of 5-tuple with
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	777 - service (unicode): pubsub service
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	778 - node (unicode): pubsub node
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	779 - failure (unicode): empty string in case of success, error message else
1511 83f71763e1a7 plugin XEP-0277: clarify a docstring for one complex method argument souliane <souliane@mailoo.org> parents: 1459 diff changeset	780 - items(list[tuple(dict, list)]): list of 2-tuple with
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	781 - item(dict): item microblog data
1511 83f71763e1a7 plugin XEP-0277: clarify a docstring for one complex method argument souliane <souliane@mailoo.org> parents: 1459 diff changeset	782 - comments_list(list[tuple]): list of 5-tuple with
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	783 - service (unicode): pubsub service where the comments node is
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	784 - node (unicode): comments node
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	785 - failure (unicode): empty in case of success, else error message
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	786 - comments(list[dict]): list of microblog data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	787 - comments_metadata(dict): metadata of the comment node
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	788 - metadata(dict): original node metadata
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	789 @param profile_key: %(doc_profile_key)s
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	790 """
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	791 profile = self.host.getClient(profile_key).profile
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	792 d = self.rt_sessions.getResults(session_id, profile=profile)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	793 d.addCallback(lambda ret: (ret[0],
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	794 [(service.full(), node, failure, items, metadata)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	795 for (service, node), (success, (failure, (items, metadata))) in ret[1].iteritems()]))
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	796 return d
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	797
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	798 def _mbGetFromManyWithComments(self, publishers_type, publishers, max_items=10, max_comments=C.NO_LIMIT, extra_dict=None, extra_comments_dict=None, profile_key=C.PROF_KEY_NONE):
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	799 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	800 @param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	801 @param max_comments(int): maximum number of comments to get, C.NO_LIMIT for no limit
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	802 """
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	803 max_items = None if max_items == C.NO_LIMIT else max_items
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	804 max_comments = None if max_comments == C.NO_LIMIT else max_comments
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	805 publishers_type, publishers = self._checkPublishers(publishers_type, publishers)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	806 extra = self._p.parseExtra(extra_dict)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	807 extra_comments = self._p.parseExtra(extra_comments_dict)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	808 return self.mbGetFromManyWithComments(publishers_type, publishers, max_items, max_comments,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	809 extra.rsm_request,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	810 extra.extra,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	811 extra_comments.rsm_request,
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	812 extra_comments.extra,
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	813 profile_key)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	814
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	815 def mbGetFromManyWithComments(self, publishers_type, publishers, max_items=None, max_comments=None, rsm_request=None, extra=None, rsm_comments=None, extra_comments=None, profile_key=C.PROF_KEY_NONE):
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	816 """Helper method to get the microblogs and their comments in one shot
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	817
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	818 @param publishers_type (str): type of the list of publishers (one of "GROUP" or "JID" or "ALL")
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	819 @param publishers (list): list of publishers, according to publishers_type (list of groups or list of jids)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	820 @param max_items (int): optional limit on the number of retrieved items.
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	821 @param max_comments (int): maximum number of comments to retrieve
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	822 @param rsm_request (rsm.RSMRequest): RSM request for initial items only
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	823 @param extra (dict): extra configuration for initial items only
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	824 @param rsm_comments (rsm.RSMRequest): RSM request for comments only
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	825 @param extra_comments (dict): extra configuration for comments only
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	826 @param profile_key: profile key
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	827 @return (str): RT Deferred session id
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	828 """
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	829 # XXX: this method seems complicated because it do a couple of treatments
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	830 # to serialise and associate the data, but it make life in frontends side
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	831 # a lot easier
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	832
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	833 def getComments(items_data):
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	834 """Retrieve comments and add them to the items_data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	835
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	836 @param items_data: serialised items data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	837 @return (defer.Deferred): list of items where each item is associated
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	838 with a list of comments data (service, node, list of items, metadata)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	839 """
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	840 items, metadata = items_data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	841 items_dlist = [] # deferred list for items
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	842 for item in items:
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	843 dlist = [] # deferred list for comments
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	844 for key, value in item.iteritems():
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	845 # we look for comments
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	846 if key.startswith('comments') and key.endswith('_service'):
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	847 prefix = key[:key.find('_')]
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	848 service_s = value
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	849 node = item["{}{}".format(prefix, "_node")]
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	850 # time to get the comments
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	851 d = self._p.getItems(jid.JID(service_s), node, max_comments, rsm_request=rsm_comments, extra=extra_comments, profile_key=profile_key)
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	852 # then serialise
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	853 d.addCallback(lambda items_data: self._p.serItemsDataD(items_data, self.item2mbdata))
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	854 # with failure handling
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	855 d.addCallback(lambda serialised_items_data: ('',) + serialised_items_data)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	856 d.addErrback(lambda failure: (unicode(failure.value), [], {}))
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	857 # and associate with service/node (needed if there are several comments nodes)
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	858 d.addCallback(lambda serialised, service_s=service_s, node=node: (service_s, node) + serialised)
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	859 dlist.append(d)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	860 # we get the comments
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	861 comments_d = defer.gatherResults(dlist)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	862 # and add them to the item data
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	863 comments_d.addCallback(lambda comments_data, item=item: (item, comments_data))
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	864 items_dlist.append(comments_d)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	865 # we gather the items + comments in a list
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	866 items_d = defer.gatherResults(items_dlist)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	867 # and add the metadata
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	868 items_d.addCallback(lambda items_completed: (items_completed, metadata))
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	869 return items_d
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	870
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	871 client, node_data = self._getClientAndNodeData(publishers_type, publishers, profile_key)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	872 deferreds = {}
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	873 for service, node in node_data:
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	874 d = deferreds[(service, node)] = self._p.getItems(service, node, max_items, rsm_request=rsm_request, extra=extra, profile_key=profile_key)
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	875 d.addCallback(lambda items_data: self._p.serItemsDataD(items_data, self.item2mbdata))
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	876 d.addCallback(getComments)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	877 d.addCallback(lambda items_comments_data: ('', items_comments_data))
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	878 d.addErrback(lambda failure: (unicode(failure.value), ([],{})))
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	879
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1453 diff changeset	880 return self.rt_sessions.newSession(deferreds, client.profile)
1516 afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	881
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	882 # atom feed
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	883
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	884 def _mbGetAtom(self, service_jid_s, node="", max_items=10, item_ids=None, extra_dict=None, profile_key=C.PROF_KEY_NONE):
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	885 """Get the atom feed of the last published microblogs
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	886
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	887 @param service_jid(jid.JID): jid of the publisher
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	888 @param node(unicode, None): node to get (or microblog node if None)
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	889 @param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	890 @param item_ids (list[unicode]): list of item IDs
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	891 @param rsm_request (rsm.RSMRequest): RSM request data
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	892 @param extra (dict): extra data
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	893 @param profile_key: %(doc_profile_key)s
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	894 @return: a deferred unicode (atom XML feed)
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	895 """
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	896 max_items = None if max_items == C.NO_LIMIT else max_items
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	897 extra = self._p.parseExtra(extra_dict)
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	898 return self.mbGetAtom(jid.JID(service_jid_s), node or None, max_items, item_ids, extra.rsm_request, extra.extra, profile_key)
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	899
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	900 @defer.inlineCallbacks
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	901 def mbGetAtom(self, service_jid, node=None, max_items=None, item_ids=None, rsm_request=None, extra=None, profile_key=C.PROF_KEY_NONE):
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	902 """Get the atom feed of the last published microblogs
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	903
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	904 @param service_jid(jid.JID): jid of the publisher
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	905 @param node(unicode, None): node to get (or microblog node if None)
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	906 @param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	907 @param item_ids (list[unicode]): list of item IDs
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	908 @param rsm_request (rsm.RSMRequest): RSM request data
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	909 @param extra (dict): extra data
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	910 @param profile_key: %(doc_profile_key)s
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	911
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	912 @return: a deferred couple with the list of items and metadatas.
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	913 """
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	914 if node is None:
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	915 node = NS_MICROBLOG
afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	916
1648 2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	917 feed_elt = domish.Element((NS_ATOM, 'feed'))
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	918 title = D_(u"{user}'s blogposts").format(user=service_jid.user)
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	919 feed_elt.addElement('title', content=title)
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	920 link_feed_elt = feed_elt.addElement('link')
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	921 link_feed_elt['href'] = 'http://{host}/blog/{user}/atom.xml'.format(
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	922 host=urllib.quote(service_jid.host,''),
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	923 user=urllib.quote(service_jid.user,''))
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	924 link_feed_elt['rel'] = 'self'
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	925 link_blog_elt = feed_elt.addElement('link')
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	926 link_blog_elt['href'] = 'http://{host}/blog/{user}'.format(
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	927 host=urllib.quote(service_jid.host,''),
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	928 user=urllib.quote(service_jid.user,''))
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	929 feed_elt.addElement('id', content=node)
2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	930 feed_elt.addElement('updated', rfc3339.timestamp_from_tf(rfc3339.tf_utc()))
1516 afa0894dcc71 plugin XEP-0277, misc_groupblog: move getGroupBlogsAtom to XEP-0277, rename to mbGetAtom souliane <souliane@mailoo.org> parents: 1513 diff changeset	931
1649 b58c8b4715c6 plugin XEP-0277: fixed entries in atom feed Goffi <goffi@goffi.org> parents: 1648 diff changeset	932 # FIXME: no cleaning is done here
b58c8b4715c6 plugin XEP-0277: fixed entries in atom feed Goffi <goffi@goffi.org> parents: 1648 diff changeset	933 # FIXME: no check is done neither, we have to be sure that we get microblogs
b58c8b4715c6 plugin XEP-0277: fixed entries in atom feed Goffi <goffi@goffi.org> parents: 1648 diff changeset	934 items, metadata = yield self._p.getItems(service_jid, node, max_items=max_items, item_ids=item_ids, rsm_request=rsm_request, extra=extra, profile_key=profile_key)
b58c8b4715c6 plugin XEP-0277: fixed entries in atom feed Goffi <goffi@goffi.org> parents: 1648 diff changeset	935
b58c8b4715c6 plugin XEP-0277: fixed entries in atom feed Goffi <goffi@goffi.org> parents: 1648 diff changeset	936 for item in items:
b58c8b4715c6 plugin XEP-0277: fixed entries in atom feed Goffi <goffi@goffi.org> parents: 1648 diff changeset	937 entry_elt = item.elements(NS_ATOM, 'entry').next()
b58c8b4715c6 plugin XEP-0277: fixed entries in atom feed Goffi <goffi@goffi.org> parents: 1648 diff changeset	938 feed_elt.addChild(entry_elt)
b58c8b4715c6 plugin XEP-0277: fixed entries in atom feed Goffi <goffi@goffi.org> parents: 1648 diff changeset	939
1648 2b8a975ff712 plugin XEP-0277: fixed unsecure blog feed Goffi <goffi@goffi.org> parents: 1542 diff changeset	940 defer.returnValue(u'<?xml version="1.0" encoding="utf-8"?>'+feed_elt.toXml())

Mercurial > libervia-backend

annotate src/plugins/plugin_xep_0277.py @ 1733:3770d13776e8