libervia-backend: src/plugins/plugin_misc

annotate src/plugins/plugin_misc_groupblog.py @ 1577:d04d7402b8e9

plugins XEP-0020, XEP-0065, XEP-0095, XEP-0096: fixed file copy with Stream Initiation: /!\ range is not working yet /!\ pipe plugin is broken for now

author	Goffi <goffi@goffi.org>
date	Wed, 11 Nov 2015 18:19:49 +0100
parents	e0bde0d0b321
children	9aa2a703e460

rev	line source
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
1e4575e12581 Group blog first draft 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 microbloging with roster access
1396 069ad98b360d 2015 copyright dates update Goffi <goffi@goffi.org> parents: 1294 diff changeset	5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Jérôme Poisson (goffi@goffi.org)
307 1e4575e12581 Group blog first draft 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.
307 1e4575e12581 Group blog first draft 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.
307 1e4575e12581 Group blog first draft 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/>.
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	19
771 bfabeedbf32e core: i18n refactoring: Goffi <goffi@goffi.org> parents: 770 diff changeset	20 from sat.core.i18n import _
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 892 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: 944 diff changeset	22 from sat.core.log import getLogger
301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 944 diff changeset	23 log = getLogger(__name__)
476 b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	24 from twisted.internet import defer
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	25 from twisted.words.protocols.jabber import jid
1552 e0bde0d0b321 core (disco): use of “profile” instead of “profile_key” in several disco methods Goffi <goffi@goffi.org> parents: 1516 diff changeset	26 from twisted.words.xish.domish import generateElementsNamed
708 6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	27 from sat.core import exceptions
476 b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	28 from wokkel import disco, data_form, iwokkel
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	29 from wokkel import rsm
476 b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	30 from zope.interface import implements
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	31 # import uuid
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	32
476 b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	33 try:
b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	34 from twisted.words.protocols.xmlstream import XMPPHandler
b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	35 except ImportError:
b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	36 from wokkel.subprotocols import XMPPHandler
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	37
462 d9456d94cd12 plugin groupblog: next-gen group blog first draft Goffi <goffi@goffi.org> parents: 459 diff changeset	38 NS_PUBSUB = 'http://jabber.org/protocol/pubsub'
476 b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	39 NS_GROUPBLOG = 'http://goffi.org/protocol/groupblog'
477 031b0e0aaab8 plugin groupblog: subscriptions/notifications Goffi <goffi@goffi.org> parents: 476 diff changeset	40 NS_NODE_PREFIX = 'urn:xmpp:groupblog:'
462 d9456d94cd12 plugin groupblog: next-gen group blog first draft Goffi <goffi@goffi.org> parents: 459 diff changeset	41 #NS_PUBSUB_EXP = 'http://goffi.org/protocol/pubsub' #for non official features
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	42 NS_PUBSUB_EXP = NS_PUBSUB # XXX: we can't use custom namespace as Wokkel's PubSubService use official NS
462 d9456d94cd12 plugin groupblog: next-gen group blog first draft Goffi <goffi@goffi.org> parents: 459 diff changeset	43 NS_PUBSUB_ITEM_ACCESS = NS_PUBSUB_EXP + "#item-access"
1485 9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	44 NS_PUBSUB_GROUPBLOG = NS_PUBSUB_EXP + "#groupblog"
462 d9456d94cd12 plugin groupblog: next-gen group blog first draft Goffi <goffi@goffi.org> parents: 459 diff changeset	45 NS_PUBSUB_CREATOR_JID_CHECK = NS_PUBSUB_EXP + "#creator-jid-check"
d9456d94cd12 plugin groupblog: next-gen group blog first draft Goffi <goffi@goffi.org> parents: 459 diff changeset	46 NS_PUBSUB_ITEM_CONFIG = NS_PUBSUB_EXP + "#item-config"
d9456d94cd12 plugin groupblog: next-gen group blog first draft Goffi <goffi@goffi.org> parents: 459 diff changeset	47 NS_PUBSUB_AUTO_CREATE = NS_PUBSUB + "#auto-create"
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	48 ACCESS_TYPE_MAP = { 'PUBLIC': 'open',
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	49 'GROUP': 'roster',
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	50 'JID': None, #JID is not yet managed
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	51 }
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	52
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	53 MAX_ITEMS = 5
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	54 MAX_COMMENTS = 5
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	55 DO_NOT_COUNT_COMMENTS = -1 # must be lower than 0
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	56
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	57 PLUGIN_INFO = {
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	58 "name": "Group blogging throught collections",
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	59 "import_name": "GROUPBLOG",
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	60 "type": "MISC",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	61 "protocols": [],
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	62 "dependencies": ["XEP-0277"],
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	63 "recommendations": ["XEP-0059"],
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	64 "main": "GroupBlog",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	65 "handler": "yes",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	66 "description": _("""Implementation of microblogging with roster access""")
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	67 }
1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	68
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	69
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	70 class NoCompatiblePubSubServerFound(Exception):
308 ce3607b7198d plugin group blog: blog collection cleaning Goffi <goffi@goffi.org> parents: 307 diff changeset	71 pass
ce3607b7198d plugin group blog: blog collection cleaning Goffi <goffi@goffi.org> parents: 307 diff changeset	72
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	73
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	74 class BadAccessTypeError(Exception):
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	75 pass
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	76
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	77
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	78 class BadAccessListError(Exception):
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	79 pass
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	80
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	81
529 c18e0e108925 plugin groupblog: fixed GROUP and JID publishers_type in getMassiveLastGroupBlogs and massiveSubscribeGroupBlogs Goffi <goffi@goffi.org> parents: 480 diff changeset	82 class UnknownType(Exception):
c18e0e108925 plugin groupblog: fixed GROUP and JID publishers_type in getMassiveLastGroupBlogs and massiveSubscribeGroupBlogs Goffi <goffi@goffi.org> parents: 480 diff changeset	83 pass
c18e0e108925 plugin groupblog: fixed GROUP and JID publishers_type in getMassiveLastGroupBlogs and massiveSubscribeGroupBlogs Goffi <goffi@goffi.org> parents: 480 diff changeset	84
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	85 class GroupBlog(object):
462 d9456d94cd12 plugin groupblog: next-gen group blog first draft Goffi <goffi@goffi.org> parents: 459 diff changeset	86 """This class use a SàT PubSub Service to manage access on microblog"""
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	87
1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	88 def __init__(self, host):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 944 diff changeset	89 log.info(_("Group blog plugin initialization"))
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	90 self.host = host
1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	91
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	92 host.bridge.addMethod("sendGroupBlog", ".plugin", in_sign='sassa{ss}s', out_sign='',
704 3c304929af74 plugin XEP-0277, group blogs: proper asynchronous methods for sending blogs. Goffi <goffi@goffi.org> parents: 703 diff changeset	93 method=self.sendGroupBlog,
3c304929af74 plugin XEP-0277, group blogs: proper asynchronous methods for sending blogs. Goffi <goffi@goffi.org> parents: 703 diff changeset	94 async=True)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	95
745 812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 742 diff changeset	96 host.bridge.addMethod("deleteGroupBlog", ".plugin", in_sign='(sss)ss', out_sign='',
812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 742 diff changeset	97 method=self.deleteGroupBlog,
812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 742 diff changeset	98 async=True)
812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 742 diff changeset	99
812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 742 diff changeset	100 host.bridge.addMethod("updateGroupBlog", ".plugin", in_sign='(sss)ssa{ss}s', out_sign='',
812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 742 diff changeset	101 method=self.updateGroupBlog,
812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 742 diff changeset	102 async=True)
812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 742 diff changeset	103
708 6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	104 host.bridge.addMethod("sendGroupBlogComment", ".plugin", in_sign='ssa{ss}s', out_sign='',
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	105 method=self.sendGroupBlogComment,
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	106 async=True)
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	107
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	108 # host.bridge.addMethod("getGroupBlogs", ".plugin",
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	109 # in_sign='sasa{ss}bs', out_sign='(aa{ss}a{ss})',
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	110 # method=self.getGroupBlogs,
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	111 # async=True)
891 a7b2aacf22ac plugin XEP-0060, groupblog: added nodeIdentifiers attribute to getItems in order to retrieve items by ids souliane <souliane@mailoo.org> parents: 860 diff changeset	112
892 58107179cd97 plugin groupblog: added a convenient bridge method getGroupBlogsWithComments souliane <souliane@mailoo.org> parents: 891 diff changeset	113 host.bridge.addMethod("getGroupBlogsWithComments", ".plugin",
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	114 in_sign='sasa{ss}is', out_sign='(a(a{ss}(aa{ss}a{ss}))a{ss})',
892 58107179cd97 plugin groupblog: added a convenient bridge method getGroupBlogsWithComments souliane <souliane@mailoo.org> parents: 891 diff changeset	115 method=self.getGroupBlogsWithComments,
58107179cd97 plugin groupblog: added a convenient bridge method getGroupBlogsWithComments souliane <souliane@mailoo.org> parents: 891 diff changeset	116 async=True)
58107179cd97 plugin groupblog: added a convenient bridge method getGroupBlogsWithComments souliane <souliane@mailoo.org> parents: 891 diff changeset	117
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	118 # host.bridge.addMethod("getMassiveGroupBlogs", ".plugin",
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	119 # in_sign='sasa{ss}s', out_sign='a{s(aa{ss}a{ss})}',
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	120 # method=self._getMassiveGroupBlogs,
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	121 # async=True)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	122
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	123 # host.bridge.addMethod("getGroupBlogComments", ".plugin",
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	124 # in_sign='ssa{ss}s', out_sign='(aa{ss}a{ss})',
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	125 # method=self.getGroupBlogComments,
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	126 # async=True)
621 0e16288d6816 pluging groupblog: comments handling: Goffi <goffi@goffi.org> parents: 619 diff changeset	127
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	128 # host.bridge.addMethod("subscribeGroupBlog", ".plugin", in_sign='ss', out_sign='',
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	129 # method=self.subscribeGroupBlog,
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	130 # async=True)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	131
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	132 # host.trigger.add("PubSubItemsReceived", self.pubSubItemsReceivedTrigger)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	133
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	134 ## plugin management methods ##
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	135
476 b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	136 def getHandler(self, profile):
b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	137 return GroupBlog_handler()
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	138
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	139 @defer.inlineCallbacks
1485 9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	140 def profileConnected(self, profile):
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	141 client = self.host.getClient(profile)
1492 6ec2741b7268 plugin groupblog: item access availability on serveur is checked on profile connection, and getFeatures is filled accordingly (with "available" key) Goffi <goffi@goffi.org> parents: 1485 diff changeset	142 try:
1552 e0bde0d0b321 core (disco): use of “profile” instead of “profile_key” in several disco methods Goffi <goffi@goffi.org> parents: 1516 diff changeset	143 yield self.host.checkFeatures((NS_PUBSUB_GROUPBLOG, NS_PUBSUB_AUTO_CREATE), profile=profile)
1492 6ec2741b7268 plugin groupblog: item access availability on serveur is checked on profile connection, and getFeatures is filled accordingly (with "available" key) Goffi <goffi@goffi.org> parents: 1485 diff changeset	144 except exceptions.FeatureNotFound:
6ec2741b7268 plugin groupblog: item access availability on serveur is checked on profile connection, and getFeatures is filled accordingly (with "available" key) Goffi <goffi@goffi.org> parents: 1485 diff changeset	145 client.server_groupblog_available = False
6ec2741b7268 plugin groupblog: item access availability on serveur is checked on profile connection, and getFeatures is filled accordingly (with "available" key) Goffi <goffi@goffi.org> parents: 1485 diff changeset	146 log.warning(_(u"Server is not able to manage item-access pubsub, we can't use group blog"))
1485 9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	147 else:
1492 6ec2741b7268 plugin groupblog: item access availability on serveur is checked on profile connection, and getFeatures is filled accordingly (with "available" key) Goffi <goffi@goffi.org> parents: 1485 diff changeset	148 client.server_groupblog_available = True
6ec2741b7268 plugin groupblog: item access availability on serveur is checked on profile connection, and getFeatures is filled accordingly (with "available" key) Goffi <goffi@goffi.org> parents: 1485 diff changeset	149 log.info(_(u"Server can manage group blogs"))
1485 9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	150
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	151 def getFeatures(self, profile):
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	152 try:
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	153 client = self.host.getClient(profile)
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	154 except exceptions.ProfileNotSetError:
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	155 return {}
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	156 try:
1492 6ec2741b7268 plugin groupblog: item access availability on serveur is checked on profile connection, and getFeatures is filled accordingly (with "available" key) Goffi <goffi@goffi.org> parents: 1485 diff changeset	157 return {'available': C.boolConst(client.server_groupblog_available)}
1485 9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	158 except AttributeError:
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	159 if self.host.isConnected(profile):
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	160 log.debug("Profile is not connected, service is not checked yet")
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	161 else:
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	162 log.error("Service should be available !")
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	163 return {}
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	164
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	165
9fcc16ef163a plugin groupblog: groupblog compatible pubsub service is checked in profileConected + getFeatures implementation Goffi <goffi@goffi.org> parents: 1459 diff changeset	166 @defer.inlineCallbacks
708 6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	167 def _initialise(self, profile_key):
858 660b3f5b6c78 plugins groupblog, XEP-0277: attempt to clarify the code for the comments handling: souliane <souliane@mailoo.org> parents: 847 diff changeset	168 """Check that the data for this profile are initialised, and do it else
660b3f5b6c78 plugins groupblog, XEP-0277: attempt to clarify the code for the comments handling: souliane <souliane@mailoo.org> parents: 847 diff changeset	169 @param profile_key: %(doc_profile)s"""
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	170 profile = self.host.memory.getProfileName(profile_key)
78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	171 if not profile:
708 6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	172 raise exceptions.ProfileUnknownError
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	173
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	174 client = self.host.getClient(profile)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	175
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	176 #we first check that we have a item-access pubsub server
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	177 if not hasattr(client, "item_access_pubsub"):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 944 diff changeset	178 log.debug(_('Looking for item-access powered pubsub server'))
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	179 #we don't have any pubsub server featuring item access yet
1552 e0bde0d0b321 core (disco): use of “profile” instead of “profile_key” in several disco methods Goffi <goffi@goffi.org> parents: 1516 diff changeset	180 item_access_pubsubs = yield self.host.findFeaturesSet((NS_PUBSUB_AUTO_CREATE, NS_PUBSUB_CREATOR_JID_CHECK), "pubsub", "service", profile=profile)
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	181 # item_access_pubsubs = yield self.host.findFeaturesSet((NS_PUBSUB_ITEM_ACCESS, NS_PUBSUB_AUTO_CREATE, NS_PUBSUB_CREATOR_JID_CHECK), "pubsub", "service", profile_key=profile)
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	182 try:
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	183 client.item_access_pubsub = item_access_pubsubs.pop()
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	184 log.info(_(u"item-access powered pubsub service found: [%s]") % client.item_access_pubsub.full())
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	185 except KeyError:
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	186 client.item_access_pubsub = None
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	187
78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	188 if not client.item_access_pubsub:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	189 log.error(_(u"No item-access powered pubsub server found, can't use group blog"))
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	190 raise NoCompatiblePubSubServerFound
78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	191
78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	192 defer.returnValue((profile, client))
78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	193
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	194 # def pubSubItemsReceivedTrigger(self, event, profile):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	195 # """"Trigger which catch groupblogs events"""
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	196
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	197 # if event.nodeIdentifier.startswith(NS_NODE_PREFIX):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	198 # # Microblog
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	199 # publisher = jid.JID(event.nodeIdentifier[len(NS_NODE_PREFIX):])
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	200 # origin_host = publisher.host.split('.')
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	201 # event_host = event.sender.host.split('.')
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	202 # #FIXME: basic origin check, must be improved
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	203 # #TODO: automatic security test
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	204 # if (not (origin_host)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	205 # or len(event_host) < len(origin_host)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	206 # or event_host[-len(origin_host):] != origin_host):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	207 # log.warning(u"Host incoherence between %s and %s (hack attempt ?)" % (unicode(event.sender),
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	208 # unicode(publisher)))
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	209 # return False
617 dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	210
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	211 # client = self.host.getClient(profile)
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	212
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	213 # def gbdataManagementMicroblog(gbdata):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	214 # for gbdatum in gbdata:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	215 # self.host.bridge.personalEvent(publisher.full(), "MICROBLOG", gbdatum, profile)
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	216
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	217 # d = self._itemsConstruction(event.items, publisher, client)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	218 # d.addCallback(gbdataManagementMicroblog)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	219 # return False
617 dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	220
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	221 # elif event.nodeIdentifier.startswith(NS_COMMENT_PREFIX):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	222 # # Comment
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	223 # def gbdataManagementComments(gbdata):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	224 # for gbdatum in gbdata:
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	225 # publisher = None # FIXME: see below (_handleCommentsItems)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	226 # self.host.bridge.personalEvent(publisher.full() if publisher else gbdatum["author"], "MICROBLOG", gbdatum, profile)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	227 # d = self._handleCommentsItems(event.items, event.sender, event.nodeIdentifier)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	228 # d.addCallback(gbdataManagementComments)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	229 # return False
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	230 # return True
477 031b0e0aaab8 plugin groupblog: subscriptions/notifications Goffi <goffi@goffi.org> parents: 476 diff changeset	231
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	232 ## internal helping methodes ##
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	233
621 0e16288d6816 pluging groupblog: comments handling: Goffi <goffi@goffi.org> parents: 619 diff changeset	234 def _handleCommentsItems(self, items, service, node_identifier):
617 dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	235 """ Convert comments items to groupblog data, and send them as signals
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	236
617 dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	237 @param items: comments items
dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	238 @param service: jid of the PubSub service used
dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	239 @param node_identifier: comments node
1233 0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	240 @return: deferred list of group blog data
617 dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	241 """
1233 0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	242 d_list = []
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	243
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	244 def cb(microblog_data):
617 dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	245 publisher = "" # FIXME: publisher attribute for item in SàT pubsub is not managed yet, so
dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	246 # publisher is not checked and can be easily spoofed. This need to be fixed
dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	247 # quickly.
dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	248 microblog_data["service"] = service.userhost()
dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	249 microblog_data["node"] = node_identifier
dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	250 microblog_data["verified_publisher"] = "true" if publisher else "false"
1233 0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	251 return microblog_data
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	252
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	253 for item in items:
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	254 d_list.append(self.item2gbdata(item, "comment").addCallback(cb))
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	255 return defer.DeferredList(d_list, consumeErrors=True).addCallback(lambda result: [value for (success, value) in result if success])
617 dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	256
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	257 def _parseAccessData(self, microblog_data, item):
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	258 P = self.host.plugins["XEP-0060"]
660 69a8bfd266a5 core, plugins: fixed bad use of children instead of elements() for domish.Element instances. Goffi <goffi@goffi.org> parents: 621 diff changeset	259 form_elts = [child for child in item.elements() if child.name == "x"]
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	260 for form_elt in form_elts:
07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	261 form = data_form.Form.fromElement(form_elt)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	262
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	263 if (form.formNamespace == NS_PUBSUB_ITEM_CONFIG):
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	264 access_model = form.get(P.OPT_ACCESS_MODEL, 'open')
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	265 if access_model == "roster":
07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	266 try:
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	267 # FIXME: groups are xs:string, so they can contain "\n" ! This code is bugged
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	268 microblog_data["groups"] = '\n'.join(form.fields[P.OPT_ROSTER_GROUPS_ALLOWED].values)
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	269 except KeyError:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 944 diff changeset	270 log.warning("No group found for roster access-model")
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	271 microblog_data["groups"] = ''
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	272
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	273 break
07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	274
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	275 @defer.inlineCallbacks
616 8782f94e761e plugin groupblog: comment item is specified through microblog data, there is no more a specific signal type Goffi <goffi@goffi.org> parents: 615 diff changeset	276 def item2gbdata(self, item, _type="main_item"):
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	277 """ Convert item to microblog data dictionary + add access data """
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	278 microblog_data = yield self.host.plugins["XEP-0277"].item2mbdata(item)
616 8782f94e761e plugin groupblog: comment item is specified through microblog data, there is no more a specific signal type Goffi <goffi@goffi.org> parents: 615 diff changeset	279 microblog_data["type"] = _type
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	280 self._parseAccessData(microblog_data, item)
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	281 defer.returnValue(microblog_data)
534 07f369ed3988 plugin group blog: item configuration data (which groups are allowed) are parsed and added to microblog data Goffi <goffi@goffi.org> parents: 532 diff changeset	282
477 031b0e0aaab8 plugin groupblog: subscriptions/notifications Goffi <goffi@goffi.org> parents: 476 diff changeset	283 def getNodeName(self, publisher):
031b0e0aaab8 plugin groupblog: subscriptions/notifications Goffi <goffi@goffi.org> parents: 476 diff changeset	284 """Retrieve the name of publisher's node
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	285
477 031b0e0aaab8 plugin groupblog: subscriptions/notifications Goffi <goffi@goffi.org> parents: 476 diff changeset	286 @param publisher: publisher's jid
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	287 @return: node's name (string)
be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	288 """
477 031b0e0aaab8 plugin groupblog: subscriptions/notifications Goffi <goffi@goffi.org> parents: 476 diff changeset	289 return NS_NODE_PREFIX + publisher.userhost()
031b0e0aaab8 plugin groupblog: subscriptions/notifications Goffi <goffi@goffi.org> parents: 476 diff changeset	290
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	291 ## publish ##
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	292
703 0c2c1dfb79e4 plugin group blog: renamed options parameter as extra for consistency with sendMessage Goffi <goffi@goffi.org> parents: 660 diff changeset	293 def _publishMblog(self, service, client, access_type, access_list, message, extra):
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	294 """Actually publish the message on the group blog
1419 be2df1ddea8e plugins (groupblog, xep-0277) + tmp(rsm): improved style: Goffi <goffi@goffi.org> parents: 1409 diff changeset	295
462 d9456d94cd12 plugin groupblog: next-gen group blog first draft Goffi <goffi@goffi.org> parents: 459 diff changeset	296 @param service: jid of the item-access pubsub service
858 660b3f5b6c78 plugins groupblog, XEP-0277: attempt to clarify the code for the comments handling: souliane <souliane@mailoo.org> parents: 847 diff changeset	297 @param client: SatXMPPClient of the publisher
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	298 @param access_type: one of "PUBLIC", "GROUP", "JID"
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	299 @param access_list: set of entities (empty list for all, groups or jids) allowed to see the item
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	300 @param message: message to publish
703 0c2c1dfb79e4 plugin group blog: renamed options parameter as extra for consistency with sendMessage Goffi <goffi@goffi.org> parents: 660 diff changeset	301 @param extra: dict which option name as key, which can be:
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	302 - allow_comments: True to accept comments, False else (default: False)
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	303 - rich: if present, contain rich text in currently selected syntax
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	304 """
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	305 node_name = self.getNodeName(client.jid)
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	306 mblog_data = {'content': message}
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 831 diff changeset	307
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 831 diff changeset	308 for attr in ['content_rich', 'title', 'title_rich']:
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 831 diff changeset	309 if attr in extra and extra[attr]:
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 831 diff changeset	310 mblog_data[attr] = extra[attr]
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	311 P = self.host.plugins["XEP-0060"]
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	312 access_model_value = ACCESS_TYPE_MAP[access_type]
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	313
703 0c2c1dfb79e4 plugin group blog: renamed options parameter as extra for consistency with sendMessage Goffi <goffi@goffi.org> parents: 660 diff changeset	314 if extra.get('allow_comments', 'False').lower() == 'true':
745 812dc38c0094 plugins groupblog (xep-0060, xep-0277): added blog item modification/deletion souliane <souliane@mailoo.org> parents: 742 diff changeset	315 # XXX: use the item identifier? http://bugs.goffi.org/show_bug.cgi?id=63
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	316 comments_node = self._fillCommentsElement(mblog_data, None, node_name, service)
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	317 _options = {P.OPT_ACCESS_MODEL: access_model_value,
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	318 P.OPT_PERSIST_ITEMS: 1,
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	319 P.OPT_MAX_ITEMS: -1,
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	320 P.OPT_DELIVER_PAYLOADS: 1,
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	321 P.OPT_SEND_ITEM_SUBSCRIBE: 1,
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 831 diff changeset	322 P.OPT_PUBLISH_MODEL: "subscribers", # TODO: should be open if both node and item access_model are open (public node and item)
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	323 }
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	324 if access_model_value == 'roster':
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	325 _options[P.OPT_ROSTER_GROUPS_ALLOWED] = list(access_list)
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	326
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	327 # FIXME: check comments node creation success, at the moment this is a potential security risk (if the node
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	328 # already exists, the creation will silently fail, but the comments link will stay the same, linking to a
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	329 # node owned by somebody else)
941 c6d8fc63b1db core, plugins: host.getClient now raise an exception instead of returning None when no profile is found, plugins have been adapted consequently and a bit cleaned Goffi <goffi@goffi.org> parents: 938 diff changeset	330 self.host.plugins["XEP-0060"].createNode(service, comments_node, _options, profile_key=client.profile)
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	331
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	332 def itemCreated(mblog_item):
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	333 form = data_form.Form('submit', formNamespace=NS_PUBSUB_ITEM_CONFIG)
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	334
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	335 if access_type == "PUBLIC":
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	336 if access_list:
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	337 raise BadAccessListError("access_list must be empty for PUBLIC access")
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	338 access = data_form.Field(None, P.OPT_ACCESS_MODEL, value=access_model_value)
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	339 form.addField(access)
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	340 elif access_type == "GROUP":
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	341 access = data_form.Field(None, P.OPT_ACCESS_MODEL, value=access_model_value)
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	342 allowed = data_form.Field(None, P.OPT_ROSTER_GROUPS_ALLOWED, values=access_list)
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	343 form.addField(access)
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	344 form.addField(allowed)
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	345 mblog_item.addChild(form.toElement())
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	346 elif access_type == "JID":
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	347 raise NotImplementedError
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	348 else:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 944 diff changeset	349 log.error(_("Unknown access_type"))
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	350 raise BadAccessTypeError
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	351
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	352 defer_blog = self.host.plugins["XEP-0060"].publish(service, node_name, items=[mblog_item], profile_key=client.profile)
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	353 defer_blog.addErrback(self._mblogPublicationFailed)
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	354 return defer_blog
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	355
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 831 diff changeset	356 entry_d = self.host.plugins["XEP-0277"].data2entry(mblog_data, client.profile)
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	357 entry_d.addCallback(itemCreated)
80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	358 return entry_d
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	359
1459 4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	360 # def _fillCommentsElement(self, mblog_data, entry_id, node_name, service_jid):
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	361 # """
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	362 # @param mblog_data: dict containing the microblog data
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	363 # @param entry_id: unique identifier of the entry
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	364 # @param node_name: the pubsub node name
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	365 # @param service_jid: the JID of the pubsub service
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	366 # @return: the comments node string
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	367 # """
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	368 # if entry_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	369 # entry_id = 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	370 # comments_node = "%s_%s__%s" % (NS_COMMENT_PREFIX, entry_id, node_name)
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	371 # mblog_data['comments'] = "xmpp:%(service)s?%(query)s" % {'service': service_jid.userhost(),
4c4f88d7b156 plugins xep-0060, xep-0163, xep-0277, groupblog: bloging improvments (huge patch, sorry): Goffi <goffi@goffi.org> parents: 1454 diff changeset	372 # '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	373 # return comments_node
858 660b3f5b6c78 plugins groupblog, XEP-0277: attempt to clarify the code for the comments handling: souliane <souliane@mailoo.org> parents: 847 diff changeset	374
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	375 def _mblogPublicationFailed(self, failure):
1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	376 #TODO
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	377 return failure
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	378
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 892 diff changeset	379 def sendGroupBlog(self, access_type, access_list, message, extra, profile_key=C.PROF_KEY_NONE):
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	380 """Publish a microblog with given item access
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	381
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	382 @param access_type: one of "PUBLIC", "GROUP", "JID"
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	383 @param access_list: list of authorized entity (empty list for PUBLIC ACCESS,
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	384 list of groups or list of jids) for this item
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	385 @param message: microblog
703 0c2c1dfb79e4 plugin group blog: renamed options parameter as extra for consistency with sendMessage Goffi <goffi@goffi.org> parents: 660 diff changeset	386 @param extra: dict which option name as key, which can be:
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	387 - allow_comments: True to accept comments, False else (default: False)
706 80e9d3ecb272 plugin XEP-0277, group blog: rich text management for sending microblogs Goffi <goffi@goffi.org> parents: 704 diff changeset	388 - rich: if present, contain rich text in currently selected syntax
708 6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	389 @profile_key: %(doc_profile_key)s
307 1e4575e12581 Group blog first draft Goffi <goffi@goffi.org> parents: diff changeset	390 """
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	391
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	392 def initialised(result):
78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	393 profile, client = result
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	394 if access_type == "PUBLIC":
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	395 if access_list:
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	396 raise Exception("Publishers list must be empty when getting microblogs for all contacts")
704 3c304929af74 plugin XEP-0277, group blogs: proper asynchronous methods for sending blogs. Goffi <goffi@goffi.org> parents: 703 diff changeset	397 return self._publishMblog(client.item_access_pubsub, client, "PUBLIC", [], message, extra)
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	398 elif access_type == "GROUP":
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	399 _groups = set(access_list).intersection(client.roster.getGroups()) # We only keep group which actually exist
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	400 if not _groups:
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	401 raise BadAccessListError("No valid group")
704 3c304929af74 plugin XEP-0277, group blogs: proper asynchronous methods for sending blogs. Goffi <goffi@goffi.org> parents: 703 diff changeset	402 return self._publishMblog(client.item_access_pubsub, client, "GROUP", _groups, message, extra)
471 6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	403 elif access_type == "JID":
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	404 raise NotImplementedError
6cd04adddaea core: exceptions moved to core Goffi <goffi@goffi.org> parents: 470 diff changeset	405 else:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 944 diff changeset	406 log.error(_("Unknown access type"))
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	407 raise BadAccessTypeError
952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	408
708 6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	409 return self._initialise(profile_key).addCallback(initialised)
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	410
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 892 diff changeset	411 def sendGroupBlogComment(self, node_url, message, extra, profile_key=C.PROF_KEY_NONE):
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	412 """Publish a comment in the given node
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	413 @param node url: link to the comments node as specified in XEP-0277 and given in microblog data's comments key
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	414 @param message: comment
708 6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	415 @param extra: dict which option name as key, which can be:
6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	416 - allow_comments: True to accept an other level of comments, False else (default: False)
6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	417 - rich: if present, contain rich text in currently selected syntax
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	418 @profile_key: %(doc_profile)s
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	419 """
708 6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	420 def initialised(result):
6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	421 profile, client = result
6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	422 service, node = self.host.plugins["XEP-0277"].parseCommentUrl(node_url)
6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	423 mblog_data = {'content': message}
832 c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 831 diff changeset	424 for attr in ['content_rich', 'title', 'title_rich']:
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 831 diff changeset	425 if attr in extra and extra[attr]:
c4b22aedb7d7 plugin groupblog, XEP-0071, XEP-0277, text_syntaxes: manage raw/rich/xhtml data for content/title: souliane <souliane@mailoo.org> parents: 831 diff changeset	426 mblog_data[attr] = extra[attr]
708 6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	427 if 'allow_comments' in extra:
6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	428 raise NotImplementedError # TODO
6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	429 entry_d = self.host.plugins["XEP-0277"].data2entry(mblog_data, profile)
6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	430 entry_d.addCallback(lambda mblog_item: self.host.plugins["XEP-0060"].publish(service, node, items=[mblog_item], profile_key=profile))
6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	431 return entry_d
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	432
708 6aa71c853bf5 plugin group blog: management of extra data/rich text for blog comments Goffi <goffi@goffi.org> parents: 707 diff changeset	433 return self._initialise(profile_key).addCallback(initialised)
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	434
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	435 def _itemsConstruction(self, items, pub_jid, client):
6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	436 """ Transforms items to group blog data and manage comments node
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	437
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	438 @param items: iterable of items
621 0e16288d6816 pluging groupblog: comments handling: Goffi <goffi@goffi.org> parents: 619 diff changeset	439 @param pub_jid: jid of the publisher or None to use items data
617 dafdbe28ca2f plugin group blog: comments handling (comments are automaticaly requested when a comment node is found) Goffi <goffi@goffi.org> parents: 616 diff changeset	440 @param client: SatXMPPClient instance
707 890fbf2d7fdd plugin XEP-0277, groupblog: rich text management for receiving microblogs Goffi <goffi@goffi.org> parents: 706 diff changeset	441 @return: deferred which fire list of group blog data """
621 0e16288d6816 pluging groupblog: comments handling: Goffi <goffi@goffi.org> parents: 619 diff changeset	442 # TODO: use items data when pub_jid is None
1233 0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	443 d_list = []
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	444
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	445 @defer.inlineCallbacks
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	446 def cb(gbdata):
858 660b3f5b6c78 plugins groupblog, XEP-0277: attempt to clarify the code for the comments handling: souliane <souliane@mailoo.org> parents: 847 diff changeset	447 try:
660b3f5b6c78 plugins groupblog, XEP-0277: attempt to clarify the code for the comments handling: souliane <souliane@mailoo.org> parents: 847 diff changeset	448 gbdata['service'] = client.item_access_pubsub.full()
660b3f5b6c78 plugins groupblog, XEP-0277: attempt to clarify the code for the comments handling: souliane <souliane@mailoo.org> parents: 847 diff changeset	449 except AttributeError:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	450 log.warning(_(u"Pubsub service is unknown for blog entry %s") % gbdata['id'])
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	451 # every comments node must be subscribed, except if we are the publisher (we are already subscribed in this case)
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	452 if "comments_node" in gbdata and pub_jid.userhostJID() != client.jid.userhostJID():
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	453 try:
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	454 service = jid.JID(gbdata["comments_service"])
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	455 node = gbdata["comments_node"]
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	456 except KeyError:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	457 log.error(_(u"Missing key for blog comment %s") % gbdata['id'])
1233 0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	458 defer.returnValue(gbdata)
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	459 # TODO: see if it is really needed to check for not subscribing twice to the node
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	460 # It previously worked without this check, but the pubsub service logs were polluted
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	461 # or, if in debug mode, it made sat-pubsub very difficult to debug.
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	462 subscribed_nodes = yield self.host.plugins['XEP-0060'].listSubscribedNodes(service, profile=client.profile)
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	463 if node not in subscribed_nodes: # avoid sat-pubsub "SubscriptionExists" error
318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	464 self.host.plugins["XEP-0060"].subscribe(service, node, profile_key=client.profile)
1233 0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	465 defer.returnValue(gbdata)
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	466
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	467 for item in items:
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	468 d_list.append(self.item2gbdata(item).addCallback(cb))
0b87d029f0a3 plugin XEP-0277, groupblog: fixes namespace issue of the items that are received from an event + trap some errors souliane <souliane@mailoo.org> parents: 1217 diff changeset	469 return defer.DeferredList(d_list, consumeErrors=True).addCallback(lambda result: [value for (success, value) in result if success])
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	470
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	471 ## modify ##
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	472
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	473 def updateGroupBlog(self, pub_data, comments, message, extra, profile_key=C.PROF_KEY_NONE):
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	474 """Modify a microblog node
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	475
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	476 @param pub_data: a tuple (service, node identifier, item identifier)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	477 @param comments: comments node identifier (for main item) or empty string
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	478 @param message: new message
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	479 @param extra: dict which option name as key, which can be:
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	480 - allow_comments: True to accept an other level of comments, False else (default: False)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	481 - rich: if present, contain rich text in currently selected syntax
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	482 @param profile_key: %(doc_profile)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	483 """
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	484
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	485 def initialised(result):
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	486 profile, client = result
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	487 mblog_data = {'content': message}
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	488 for attr in ['content_rich', 'title', 'title_rich']:
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	489 if attr in extra and extra[attr]:
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	490 mblog_data[attr] = extra[attr]
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	491 service, node, item_id = pub_data
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	492 service_jid = jid.JID(service) if service else client.item_access_pubsub
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	493 if comments or not node: # main item
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	494 node = self.getNodeName(client.jid)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	495 mblog_data['id'] = unicode(item_id)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	496 if 'published' in extra:
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	497 mblog_data['published'] = extra['published']
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	498 if extra.get('allow_comments', 'False').lower() == 'true':
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	499 comments_service, comments_node = self.host.plugins["XEP-0277"].parseCommentUrl(comments)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	500 # we could use comments_node directly but it's safer to rebuild it
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	501 # XXX: use the item identifier? http://bugs.goffi.org/show_bug.cgi?id=63
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	502 entry_id = comments_node.split('_')[1].split('__')[0]
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	503 self._fillCommentsElement(mblog_data, entry_id, node, service_jid)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	504 entry_d = self.host.plugins["XEP-0277"].data2entry(mblog_data, profile)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	505 entry_d.addCallback(lambda mblog_item: self.host.plugins["XEP-0060"].publish(service_jid, node, items=[mblog_item], profile_key=profile))
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	506 entry_d.addErrback(lambda failure: log.error(u"Modification of %s failed: %s" % (pub_data, failure.getErrorMessage())))
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	507 return entry_d
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	508
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	509 return self._initialise(profile_key).addCallback(initialised)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	510
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	511 ## get ##
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	512
1423 882e5fabf68c plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 1420 diff changeset	513 def _getOrCountComments(self, items, max_=0, profile_key=C.PROF_KEY_NONE):
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	514 """Get and/or count the comments of the given items.
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	515
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	516 @param items (list): items to consider.
1423 882e5fabf68c plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 1420 diff changeset	517 @param max_ (int): maximum number of comments to get, if 0 only count
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	518 them. The count is set to the item data of key "comments_count".
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	519 @param profile_key (str): %(doc_profile_key)s
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	520 @return: a deferred list of:
1423 882e5fabf68c plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 1420 diff changeset	521 - if max_ == 0: microblog data
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	522 - else: couple (dict, (list[dict], dict)) containing:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	523 - microblog data (main item)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	524 - couple (comments data, RSM response data for the comments)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	525 """
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	526 def comments_cb(comments_data, entry):
1440 226bbe758b1a plugin misc_groupblog: pubsub response do not fail when target server doesn't handle RSM souliane <souliane@mailoo.org> parents: 1425 diff changeset	527 try:
226bbe758b1a plugin misc_groupblog: pubsub response do not fail when target server doesn't handle RSM souliane <souliane@mailoo.org> parents: 1425 diff changeset	528 entry['comments_count'] = comments_data[1]['count']
226bbe758b1a plugin misc_groupblog: pubsub response do not fail when target server doesn't handle RSM souliane <souliane@mailoo.org> parents: 1425 diff changeset	529 except KeyError: # target pubsub server probably doesn't handle RSM
226bbe758b1a plugin misc_groupblog: pubsub response do not fail when target server doesn't handle RSM souliane <souliane@mailoo.org> parents: 1425 diff changeset	530 pass
1423 882e5fabf68c plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 1420 diff changeset	531 return (entry, comments_data) if max_ > 0 else entry
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	532
1423 882e5fabf68c plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 1420 diff changeset	533 assert max_ >= 0
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	534 d_list = []
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	535 for entry in items:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	536 if entry.get('comments', False):
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	537 comments_rsm = {'max_': max_}
7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	538 d = self.getGroupBlogComments(entry['comments_service'], entry['comments_node'], rsm_data=comments_rsm, profile_key=profile_key)
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	539 d.addCallback(comments_cb, entry)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	540 d_list.append(d)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	541 else:
1423 882e5fabf68c plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 1420 diff changeset	542 if max_ > 0:
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	543 d_list.append(defer.succeed((entry, ([], {}))))
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	544 else:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	545 d_list.append(defer.succeed(entry))
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	546 deferred_list = defer.DeferredList(d_list)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	547 deferred_list.addCallback(lambda result: [value for (success, value) in result if success])
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	548 return deferred_list
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	549
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	550 def _getGroupBlogs(self, pub_jid_s, item_ids=None, rsm_data=None, max_comments=0, profile_key=C.PROF_KEY_NONE):
891 a7b2aacf22ac plugin XEP-0060, groupblog: added nodeIdentifiers attribute to getItems in order to retrieve items by ids souliane <souliane@mailoo.org> parents: 860 diff changeset	551 """Retrieve previously published items from a publish subscribe node.
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	552
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	553 @param pub_jid_s: jid of the publisher
891 a7b2aacf22ac plugin XEP-0060, groupblog: added nodeIdentifiers attribute to getItems in order to retrieve items by ids souliane <souliane@mailoo.org> parents: 860 diff changeset	554 @param item_ids: list of microblogs items IDs
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	555 @param rsm_data (dict): RSM request data
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	556 @param max_comments (int): maximum number of comments to retrieve
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	557 @param profile_key (str): %(doc_profile_key)s
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	558 @return: a deferred couple (list, dict) containing:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	559 - list of:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	560 - if max_comments == 0: microblog data
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	561 - else: couple (dict, (list[dict], dict)) containing:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	562 - microblog data (main item)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	563 - couple (comments data, RSM response data for the comments)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	564 - RSM response data
465 78e67a59d51d plugin groupblog: added getLastGroupBlogs method Goffi <goffi@goffi.org> parents: 462 diff changeset	565 """
615 6f4c31192c7c plugins XEP-0060, XEP-0277, groupblog: comments implementation (first draft, not finished yet): Goffi <goffi@goffi.org> parents: 609 diff changeset	566 pub_jid = jid.JID(pub_jid_s)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	567
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	568 def cb(items, client):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	569 d = self._itemsConstruction(items, pub_jid, client)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	570 if max_comments == DO_NOT_COUNT_COMMENTS:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	571 return d
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	572 return d.addCallback(self._getOrCountComments, max_comments, profile_key)
308 ce3607b7198d plugin group blog: blog collection cleaning Goffi <goffi@goffi.org> parents: 307 diff changeset	573
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	574 return DeferredItems(self, cb, None, profile_key).get(self.getNodeName(pub_jid), item_ids, rsm_data=rsm_data)
462 d9456d94cd12 plugin groupblog: next-gen group blog first draft Goffi <goffi@goffi.org> parents: 459 diff changeset	575
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	576 # def getGroupBlogs(self, pub_jid_s, item_ids=None, rsm_data=None, count_comments=True, profile_key=C.PROF_KEY_NONE):
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	577 # """Get the published microblogs of the specified IDs. If item_ids is
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	578 # None, the result would be the same than calling getGroupBlogs
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	579 # with the default value for the attribute max_items.
891 a7b2aacf22ac plugin XEP-0060, groupblog: added nodeIdentifiers attribute to getItems in order to retrieve items by ids souliane <souliane@mailoo.org> parents: 860 diff changeset	580
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	581 # @param pub_jid_s: jid of the publisher
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	582 # @param item_ids: list of microblogs items IDs
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	583 # @param rsm_data (dict): RSM request data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	584 # @param count_comments (bool): also count the comments if True
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	585 # @param profile_key (str): %(doc_profile_key)s
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	586 # @return: a deferred couple (list, dict) containing:
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	587 # - list of microblog data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	588 # - RSM response data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	589 # """
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	590 # max_comments = 0 if count_comments else DO_NOT_COUNT_COMMENTS
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	591 # return self._getGroupBlogs(pub_jid_s, item_ids=item_ids, rsm_data=rsm_data, max_comments=max_comments, profile_key=profile_key)
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	592
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	593 def getGroupBlogsWithComments(self, pub_jid_s, item_ids=None, rsm_data=None, max_comments=None, profile_key=C.PROF_KEY_NONE):
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	594 """Get the published microblogs of the specified IDs and their comments. If
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	595 item_ids is None, returns the last published microblogs and their comments.
892 58107179cd97 plugin groupblog: added a convenient bridge method getGroupBlogsWithComments souliane <souliane@mailoo.org> parents: 891 diff changeset	596
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	597 @param pub_jid_s: jid of the publisher
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	598 @param item_ids: list of microblogs items IDs
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	599 @param rsm (dict): RSM request data
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	600 @param max_comments (int): maximum number of comments to retrieve
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	601 @param profile_key (str): %(doc_profile_key)s
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	602 @return: a deferred couple (list, dict) containing:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	603 - list of couple (dict, (list[dict], dict)) containing:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	604 - microblog data (main item)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	605 - couple (comments data, RSM response data for the comments)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	606 - RSM response data
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	607 """
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	608 if max_comments is None:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	609 max_comments = MAX_COMMENTS
1423 882e5fabf68c plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 1420 diff changeset	610 assert max_comments > 0 # otherwise the return signature is not the same
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	611 return self._getGroupBlogs(pub_jid_s, item_ids=item_ids, rsm_data=rsm_data, max_comments=max_comments, profile_key=profile_key)
892 58107179cd97 plugin groupblog: added a convenient bridge method getGroupBlogsWithComments souliane <souliane@mailoo.org> parents: 891 diff changeset	612
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	613 # def _getMassiveGroupBlogs(self, publishers_type, publishers, rsm_data=None, profile_key=C.PROF_KEY_NONE):
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	614 # if publishers_type == 'JID':
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	615 # publishers_jids = [jid.JID(publisher) for publisher in publishers]
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	616 # else:
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	617 # publishers_jids = publishers
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	618 # return self.getMassiveGroupBlogs(publishers_type, publishers_jids, rsm_data, profile_key)
726 ade9997fabfa core: use of Twisted JID instead of string bare jid in roster SatRosterProtocol Goffi <goffi@goffi.org> parents: 708 diff changeset	619
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	620 # def _getPublishersJIDs(self, publishers_type, publishers, client):
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	621 # #TODO: custom exception
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	622 # if publishers_type not in ["GROUP", "JID", "ALL"]:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	623 # raise Exception("Bad call, unknown publishers_type")
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	624 # if publishers_type == "ALL" and publishers:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	625 # raise Exception("Publishers list must be empty when getting microblogs for all contacts")
467 47af60767013 plugin group blog: getMassiveGroupBlog first draft Goffi <goffi@goffi.org> parents: 465 diff changeset	626
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	627 # if publishers_type == "ALL":
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	628 # contacts = client.roster.getItems()
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	629 # jids = [contact.jid.userhostJID() for contact in contacts]
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	630 # elif publishers_type == "GROUP":
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	631 # jids = []
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	632 # for _group in publishers:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	633 # jids.extend(client.roster.getJidsFromGroup(_group))
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	634 # elif publishers_type == 'JID':
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	635 # jids = publishers
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	636 # else:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	637 # raise UnknownType
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1440 diff changeset	638 # return jids
1243 b4a264915ea9 plugins groupblogs: fixes the massive retrieval callback (loop variable was misused in a lambda callback) souliane <souliane@mailoo.org> parents: 1233 diff changeset	639
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	640 # def getMassiveGroupBlogs(self, publishers_type, publishers, rsm_data=None, profile_key=C.PROF_KEY_NONE):
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	641 # """Get the last published microblogs for a list of groups or jids
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	642 # @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: 1452 diff changeset	643 # @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: 1452 diff changeset	644 # @param rsm_data (dict): RSM request data, common to all publishers
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	645 # @param profile_key: profile key
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	646 # @return: a deferred dict with:
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	647 # - key: publisher (unicode)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	648 # - value: couple (list[dict], dict) with:
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	649 # - the microblogs data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	650 # - RSM response data
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	651 # """
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	652 # def cb(items, publisher, client):
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	653 # d = self._itemsConstruction(items, publisher, client)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	654 # return d.addCallback(self._getOrCountComments, False, profile_key)
1243 b4a264915ea9 plugins groupblogs: fixes the massive retrieval callback (loop variable was misused in a lambda callback) souliane <souliane@mailoo.org> parents: 1233 diff changeset	655
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	656 # #TODO: we need to use the server corresponding to the host of the jid
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	657 # return DeferredItemsFromMany(self, cb, profile_key).get(publishers_type, publishers, rsm_data=rsm_data)
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	658
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	659 ## subscribe ##
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	660
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	661 # def subscribeGroupBlog(self, pub_jid, profile_key=C.PROF_KEY_NONE):
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	662 # def initialised(result):
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	663 # profile, client = result
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	664 # d = self.host.plugins["XEP-0060"].subscribe(client.item_access_pubsub, self.getNodeName(jid.JID(pub_jid)),
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	665 # profile_key=profile_key)
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	666 # return d
477 031b0e0aaab8 plugin groupblog: subscriptions/notifications Goffi <goffi@goffi.org> parents: 476 diff changeset	667
1454 4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	668 # #TODO: we need to use the server corresponding the the host of the jid
4e2fab4de195 plugin XEP-0277: added mBGetFromManyWithComments to have items + comments in one method call Goffi <goffi@goffi.org> parents: 1452 diff changeset	669 # return self._initialise(profile_key).addCallback(initialised)
477 031b0e0aaab8 plugin groupblog: subscriptions/notifications Goffi <goffi@goffi.org> parents: 476 diff changeset	670
1217 318eab3f93f8 plugin XEP-0060, groupblog: avoid unecessary pubsub errors while doing massive requests: souliane <souliane@mailoo.org> parents: 1182 diff changeset	671
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	672 ## delete ##
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	673
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	674 def deleteGroupBlog(self, pub_data, comments, profile_key=C.PROF_KEY_NONE):
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	675 """Delete a microblog item from a node.
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	676
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	677 @param pub_data: a tuple (service, node identifier, item identifier)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	678 @param comments: comments node identifier (for main item) or empty string
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	679 @param profile_key: %(doc_profile_key)s
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	680 """
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	681
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	682 def initialised(result):
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	683 profile, client = result
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	684 service, node, item_id = pub_data
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	685 service_jid = jid.JID(service) if service else client.item_access_pubsub
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	686 if comments or not node: # main item
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	687 node = self.getNodeName(client.jid)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	688 if comments:
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	689 # remove the associated comments node
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	690 comments_service, comments_node = self.host.plugins["XEP-0277"].parseCommentUrl(comments)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	691 d = self.host.plugins["XEP-0060"].deleteNode(comments_service, comments_node, profile_key=profile)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	692 d.addErrback(lambda failure: log.error(u"Deletion of node %s failed: %s" % (comments_node, failure.getErrorMessage())))
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	693 # remove the item itself
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	694 d = self.host.plugins["XEP-0060"].retractItems(service_jid, node, [item_id], profile_key=profile)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	695 d.addErrback(lambda failure: log.error(u"Deletion of item %s from %s failed: %s" % (item_id, node, failure.getErrorMessage())))
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	696 return d
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	697
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	698 def notify(d):
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	699 # TODO: this works only on the same host, and notifications for item deletion should be
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	700 # implemented according to http://xmpp.org/extensions/xep-0060.html#publisher-delete-success-notify
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	701 # instead. The notification mechanism implemented in sat_pubsub and wokkel have apriori
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	702 # a problem with retrieving the subscriptions, or something else.
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	703 service, node, item_id = pub_data
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	704 publisher = self.host.getJidNStream(profile_key)[0]
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	705 profile = self.host.memory.getProfileName(profile_key)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	706 gbdatum = {'id': item_id, 'type': 'main_item' if (comments or not node) else 'comment'}
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	707 self.host.bridge.personalEvent(publisher.full(), "MICROBLOG_DELETE", gbdatum, profile)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	708 return d
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	709
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	710 return self._initialise(profile_key).addCallback(initialised).addCallback(notify)
7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	711
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	712 def deleteAllGroupBlogsAndComments(self, profile_key=C.PROF_KEY_NONE):
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	713 """Delete absolutely all the microblog data that the user has posted"""
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	714 calls = [self.deleteAllGroupBlogs(profile_key), self.deleteAllGroupBlogsComments(profile_key)]
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	715 return defer.DeferredList(calls)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	716
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	717 def deleteAllGroupBlogs(self, profile_key=C.PROF_KEY_NONE):
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	718 """Delete all the main items that the user has posted and their comments.
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	719 """
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	720 def initialised(result):
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	721 profile, client = result
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	722 service = client.item_access_pubsub
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	723 jid_ = client.jid
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	724 main_node = self.getNodeName(jid_)
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	725
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	726 def cb(nodes):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	727 d_list = []
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	728 for node in [node for node in nodes if node.endswith(main_node)]:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	729 d = self.host.plugins["XEP-0060"].deleteNode(service, node, profile_key=profile)
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	730 d.addErrback(lambda failure: log.error(_(u"Deletion of node %(node)s failed: %(message)s") %
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	731 {'node': node, 'message': failure.getErrorMessage()}))
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	732 d_list.append(d)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	733 return defer.DeferredList(d_list)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	734
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	735 d = self.host.plugins["XEP-0060"].listNodes(service, profile=profile)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	736 d.addCallback(cb)
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	737 d.addCallback(lambda dummy: log.info(_(u"All microblog's main items from %s have been deleted!") % jid_.userhost()))
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	738 return d
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	739
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	740 return self._initialise(profile_key).addCallback(initialised)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	741
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	742 def deleteAllGroupBlogsComments(self, profile_key=C.PROF_KEY_NONE):
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	743 """Delete all the comments that the user posted on other's main items.
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	744 We avoid the conversions from item to microblog data as we only need
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	745 to retrieve some attributes, no need to convert text syntax...
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	746 """
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	747 def initialised(result):
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	748 """Get all the main items from our contact list
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	749 @return: a DeferredList
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	750 """
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	751 profile, client = result
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	752 service = client.item_access_pubsub
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	753 jids = [contact.jid.userhostJID() for contact in client.roster.getItems()]
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	754 blogs = []
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	755 for jid_ in jids:
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	756 if jid_ == client.jid.userhostJID():
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	757 continue # do not remove the comments on our own node
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	758 main_node = self.getNodeName(jid_)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	759 d = self.host.plugins["XEP-0060"].getItems(service, main_node, profile_key=profile)
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	760 d.addCallback(lambda res: getComments(res[0], client))
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	761 d.addErrback(lambda failure, main_node: log.error(_(u"Retrieval of items for node %(node)s failed: %(message)s") %
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	762 {'node': main_node, 'message': failure.getErrorMessage()}), main_node)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	763 blogs.append(d)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	764
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	765 return defer.DeferredList(blogs)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	766
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	767 def getComments(items, client):
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	768 """Get all the comments for a list of items
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	769 @param items: a list of main items for one user
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	770 @param client: the client of the user
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	771 @return: a DeferredList
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	772 """
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	773 comments = []
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	774 for item in items:
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	775 try:
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	776 entry = generateElementsNamed(item.elements(), 'entry').next()
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	777 link = generateElementsNamed(entry.elements(), 'link').next()
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	778 except StopIteration:
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	779 continue
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	780 href = link.getAttribute('href')
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	781 service, node = self.host.plugins['XEP-0277'].parseCommentUrl(href)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	782 d = self.host.plugins["XEP-0060"].getItems(service, node, profile_key=profile_key)
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	783 d.addCallback(lambda items: (service, node, items[0]))
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	784 d.addErrback(lambda failure, node: log.error(_(u"Retrieval of comments for node %(node)s failed: %(message)s") %
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	785 {'node': node, 'message': failure.getErrorMessage()}), node)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	786 comments.append(d)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	787 dlist = defer.DeferredList(comments)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	788 dlist.addCallback(deleteComments, client)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	789 return dlist
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	790
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	791 def deleteComments(result, client):
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	792 """Delete all the comments of the user that are found in result
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	793 @param result: a list of couple (success, value) with success a
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	794 boolean and value a tuple (service as JID, node_id, comment_items)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	795 @param client: the client of the user
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	796 @return: a DeferredList with the deletions result
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	797 """
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	798 user_jid_s = client.jid.userhost()
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	799 for (success, value) in result:
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	800 if not success:
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	801 continue
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	802 service, node_id, comment_items = value
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	803 item_ids = []
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	804 for comment_item in comment_items: # for all the comments on one post
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	805 try:
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	806 entry = generateElementsNamed(comment_item.elements(), 'entry').next()
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	807 author = generateElementsNamed(entry.elements(), 'author').next()
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	808 name = generateElementsNamed(author.elements(), 'name').next()
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	809 except StopIteration:
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	810 continue
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	811 if name.children[0] == user_jid_s:
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	812 item_ids.append(comment_item.getAttribute('id'))
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	813 deletions = []
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	814 if item_ids: # remove the comments of the user on the given post
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	815 d = self.host.plugins['XEP-0060'].retractItems(service, node_id, item_ids, profile_key=profile_key)
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	816 d.addCallback(lambda dummy, node_id: log.debug(_(u'Comments of user %(user)s in node %(node)s have been retracted') %
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	817 {'user': user_jid_s, 'node': node_id}), node_id)
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	818 d.addErrback(lambda failure, node_id: log.error(_(u"Retraction of comments from %(user)s in node %(node)s failed: %(message)s") %
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	819 {'user': user_jid_s, 'node': node_id, 'message': failure.getErrorMessage()}), node_id)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	820 deletions.append(d)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	821 return defer.DeferredList(deletions)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	822
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	823 return self._initialise(profile_key).addCallback(initialised)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	824
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	825 ## helper classes to manipulate items ##
477 031b0e0aaab8 plugin groupblog: subscriptions/notifications Goffi <goffi@goffi.org> parents: 476 diff changeset	826
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	827 class DeferredItems():
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	828 """Retrieve items using XEP-0060"""
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	829
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	830 def __init__(self, parent, cb, eb=None, profile_key=C.PROF_KEY_NONE):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	831 """
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	832 @param parent (GroupBlog): GroupBlog instance
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	833 @param cb (callable): callback method to be applied on items
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	834 @param eb (callable): errback method to be applied on items
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	835 @param profile_key (str): %(doc_profile_key)s
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	836 """
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	837 self.parent = parent
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	838 self.cb = cb
1294 8aa4dab01206 plugin groupblog: fixes bad errback default value souliane <souliane@mailoo.org> parents: 1281 diff changeset	839 self.eb = (lambda dummy: ([], {})) if eb is None else eb
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	840 self.profile_key = profile_key
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	841
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	842 def get(self, node, item_ids=None, sub_id=None, rsm_data=None):
1423 882e5fabf68c plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 1420 diff changeset	843 """Retrieve and process a page of pubsub items
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	844
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	845 @param node (str): node identifier.
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	846 @param item_ids (list[str]): list of items identifiers.
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	847 @param sub_id (str): optional subscription identifier.
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	848 @param rsm_data (dict): RSM request data
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	849 @return: a deferred couple (list, dict) containing:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	850 - list of microblog data
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	851 - RSM response data
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	852 """
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	853 if rsm_data is None:
7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	854 rsm_data = {'max_': (len(item_ids) if item_ids else MAX_ITEMS)}
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	855
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	856 def initialised(result):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	857 profile, client = result
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	858 rsm_request = rsm.RSMRequest(**rsm_data)
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	859 d = self.parent.host.plugins["XEP-0060"].getItems(client.item_access_pubsub,
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	860 node, rsm_request.max,
7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	861 item_ids, sub_id, rsm_request,
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	862 profile_key=profile)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	863
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	864 def cb(result):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	865 d = defer.maybeDeferred(self.cb, result[0], client)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	866 return d.addCallback(lambda items: (items, result[1]))
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	867
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	868 d.addCallbacks(cb, self.eb)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	869 return d
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	870
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	871 #TODO: we need to use the server corresponding to the host of the jid
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	872 return self.parent._initialise(self.profile_key).addCallback(initialised)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	873
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	874
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	875 class DeferredItemsFromMany():
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	876 def __init__(self, parent, cb, profile_key=C.PROF_KEY_NONE):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	877 """
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	878 @param parent (GroupBlog): GroupBlog instance
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	879 @param cb (callable): callback method to be applied on items
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	880 @param profile_key (str): %(doc_profile_key)s
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	881 """
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	882 self.parent = parent
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	883 self.cb = cb
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	884 self.profile_key = profile_key
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	885
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	886 def _buildData(self, publishers_type, publishers, client):
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	887 jids = self.parent._getPublishersJIDs(publishers_type, publishers, client)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	888 return {publisher: self.parent.getNodeName(publisher) for publisher in jids}
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	889
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	890 def get(self, publishers_type, publishers, sub_id=None, rsm_data=None):
1423 882e5fabf68c plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 1420 diff changeset	891 """Retrieve and process a page of pubsub items
882e5fabf68c plugin groupblog, tmp (mam, rsm): some style improvments/fixes: Goffi <goffi@goffi.org> parents: 1420 diff changeset	892
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	893 @param publishers_type (str): type of the list of publishers (one of "GROUP" or "JID" or "ALL")
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	894 @param publishers (list): list of publishers, according to publishers_type (list of groups or list of jids)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	895 @param sub_id (str): optional subscription identifier.
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	896 @param rsm_data (dict): RSM request data
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	897 @return: a deferred dict with:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	898 - key: publisher (unicode)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	899 - value: couple (list[dict], dict) with:
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	900 - the microblogs data
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	901 - RSM response data
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	902 """
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	903 if rsm_data is None:
7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	904 rsm_data = {'max_': MAX_ITEMS}
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	905
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	906 def initialised(result):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	907 profile, client = result
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	908
1420 7c0acb966fd6 plugins groupblog, xep-0060: first pass of simplification Goffi <goffi@goffi.org> parents: 1419 diff changeset	909 data = self._buildData(publishers_type, publishers, client)
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	910 rsm_request = rsm.RSMRequest(**rsm_data)
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	911 d = self.parent.host.plugins["XEP-0060"].getItemsFromMany(client.item_access_pubsub,
1425 7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	912 data, rsm_request.max, sub_id,
7f8af1e69812 core (tests): fixed bad use of reserved name Goffi <goffi@goffi.org> parents: 1423 diff changeset	913 rsm_request, profile_key=profile)
1268 bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	914
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	915 def cb(publisher):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	916 def callback(result):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	917 d = defer.maybeDeferred(self.cb, result[0], publisher, client)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	918 d.addCallback(lambda items: (publisher.full(), (items, result[1])))
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	919 return d
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	920 return callback
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	921
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	922 def cb_list(result):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	923 return {value[0]: value[1] for success, value in result if success}
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	924
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	925 def main_cb(result):
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	926 d_list = []
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	927 for publisher, d_items in result.items():
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	928 # XXX: trick needed as publisher is a loop variable
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	929 d_list.append(d_items.addCallback(cb(publisher)))
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	930 return defer.DeferredList(d_list, consumeErrors=False).addCallback(cb_list)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	931
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	932 d.addCallback(main_cb)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	933 return d
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	934
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	935 #TODO: we need to use the server corresponding to the host of the jid
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	936 return self.parent._initialise(self.profile_key).addCallback(initialised)
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	937
bb30bf3ae932 plugins XEP-0060, XEP-0277, groupblog: make use of RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 1243 diff changeset	938
476 b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	939 class GroupBlog_handler(XMPPHandler):
b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	940 implements(iwokkel.IDisco)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	941
476 b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	942 def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	943 return [disco.DiscoFeature(NS_GROUPBLOG)]
b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	944
b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	945 def getDiscoItems(self, requestor, target, nodeIdentifier=''):
b9fd32b46306 plugin groupblog: added disco info + misc fixes Goffi <goffi@goffi.org> parents: 471 diff changeset	946 return []

Mercurial > libervia-backend

annotate src/plugins/plugin_misc_groupblog.py @ 1577:d04d7402b8e9