Mercurial > libervia-backend
annotate src/plugins/plugin_misc_groupblog.py @ 329:be9f682c53a5
QuickApp: autoplay deactivated in Tarot game
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 23 May 2011 01:01:44 +0200 |
parents | 0f9925193586 |
children | 2572351d875a |
rev | line source |
---|---|
307 | 1 #!/usr/bin/python |
2 # -*- coding: utf-8 -*- | |
3 | |
4 """ | |
5 SAT plugin for microbloging with roster access | |
6 Copyright (C) 2009, 2010, 2011 Jérôme Poisson (goffi@goffi.org) | |
7 | |
8 This program is free software: you can redistribute it and/or modify | |
9 it under the terms of the GNU General Public License as published by | |
10 the Free Software Foundation, either version 3 of the License, or | |
11 (at your option) any later version. | |
12 | |
13 This program is distributed in the hope that it will be useful, | |
14 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 GNU General Public License for more details. | |
17 | |
18 You should have received a copy of the GNU General Public License | |
19 along with this program. If not, see <http://www.gnu.org/licenses/>. | |
20 """ | |
21 | |
22 from logging import debug, info, error | |
308
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
23 from twisted.internet import protocol, defer |
307 | 24 from twisted.words.protocols.jabber import jid |
25 from twisted.words.protocols.jabber import error as jab_error | |
26 import twisted.internet.error | |
27 from twisted.words.xish import domish | |
28 from sat.tools.xml_tools import ElementParser | |
29 | |
30 from wokkel import disco,pubsub | |
31 from feed.atom import Entry, Author | |
32 import uuid | |
33 from time import time | |
34 | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
35 NS_MICROBLOG = 'urn:xmpp:microblog:%02d' |
307 | 36 CONFIG_NODE = 'CONFIG' |
310
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
37 OPT_ACCESS_MODEL = 'pubsub#access_model' |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
38 OPT_PERSIST_ITEMS = 'pubsub#persist_items' |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
39 OPT_MAX_ITEMS = 'pubsub#max_items' |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
40 OPT_NODE_TYPE = 'pubsub#node_type' |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
41 OPT_SUBSCRIPTION_TYPE = 'pubsub#subscription_type' |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
42 OPT_SUBSCRIPTION_DEPTH = 'pubsub#subscription_depth' |
307 | 43 TYPE_COLLECTION = 'collection' |
44 | |
45 PLUGIN_INFO = { | |
46 "name": "Group blogging throught collections", | |
47 "import_name": "groupblog", | |
48 "type": "MISC", | |
49 "protocols": [], | |
50 "dependencies": ["XEP-0277"], | |
51 "main": "GroupBlog", | |
52 "handler": "no", | |
53 "description": _("""Implementation of microblogging with roster access""") | |
54 } | |
55 | |
56 class NodeCreationError(Exception): | |
57 pass | |
58 | |
308
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
59 class NodeDeletionError(Exception): |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
60 pass |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
61 |
307 | 62 class GroupBlog(): |
63 """This class use a PubSub Collection to manage roster access on microblog""" | |
64 | |
65 def __init__(self, host): | |
66 info(_("Group blog plugin initialization")) | |
67 self.host = host | |
326
0f9925193586
core, plugin mblog: fixed some exceptions
Goffi <goffi@goffi.org>
parents:
312
diff
changeset
|
68 self._blog_nodes={} #keep association betweek [profile][node] and [groups] |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
69 for i in range(1,21): |
312
f56108eb2880
plugin group blog: a custom cb is now used to specitfy node and groups targetted by the blog
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
70 self.host.plugins["XEP-0163"].addPEPEvent("MICROBLOG_%02d" % i, NS_MICROBLOG % i, self.groupblogCB, None) |
307 | 71 |
308
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
72 host.bridge.addMethod("cleanBlogCollection", ".communication", in_sign='s', out_sign='', |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
73 method=self.cleanBlogCollection, |
307 | 74 doc = { |
75 }) | |
76 | |
77 host.bridge.addMethod("getMblogNodes", ".communication", in_sign='s', out_sign='a{sas}', | |
78 method=self.getMblogNodes, | |
79 async = True, | |
80 doc = { 'summary':"retrieve mblog node, and their association with roster's groups", | |
81 'param_0':'%(doc_profile)s', | |
82 'return':'list of microblog data (dict)' | |
83 }) | |
84 | |
85 host.bridge.addMethod("sendGroupBlog", ".communication", in_sign='asss', out_sign='', | |
86 method=self.sendGroupBlog, | |
87 doc = { 'summary':"Send a microblog to a list of groups", | |
88 'param_0':'list of groups which can read the microblog', | |
89 'param_1':'text to send', | |
90 'param_2':'%(doc_profile)s' | |
91 }) | |
310
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
92 |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
93 host.bridge.addMethod("subscribeGroupBlog", ".communication", in_sign='ss', out_sign='', |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
94 method=self.subscribeGroupBlog, |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
95 doc = { 'summary':"Subscribe to the group blog of somebody", |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
96 'param_0':'jid of the group node published', |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
97 'param_1':'%(doc_profile)s' |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
98 }) |
312
f56108eb2880
plugin group blog: a custom cb is now used to specitfy node and groups targetted by the blog
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
99 |
f56108eb2880
plugin group blog: a custom cb is now used to specitfy node and groups targetted by the blog
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
100 def groupblogCB(self, itemsEvent, profile): |
f56108eb2880
plugin group blog: a custom cb is now used to specitfy node and groups targetted by the blog
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
101 for item in itemsEvent.items: |
f56108eb2880
plugin group blog: a custom cb is now used to specitfy node and groups targetted by the blog
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
102 microblog_data = self.host.plugins["XEP-0277"]._item2mbdata(item) |
f56108eb2880
plugin group blog: a custom cb is now used to specitfy node and groups targetted by the blog
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
103 microblog_data["node"] = itemsEvent.nodeIdentifier |
326
0f9925193586
core, plugin mblog: fixed some exceptions
Goffi <goffi@goffi.org>
parents:
312
diff
changeset
|
104 try: |
0f9925193586
core, plugin mblog: fixed some exceptions
Goffi <goffi@goffi.org>
parents:
312
diff
changeset
|
105 microblog_data["groups"] = "\n".join(self._blog_nodes[profile].get(itemsEvent.nodeIdentifier, [])) |
0f9925193586
core, plugin mblog: fixed some exceptions
Goffi <goffi@goffi.org>
parents:
312
diff
changeset
|
106 except KeyError: |
0f9925193586
core, plugin mblog: fixed some exceptions
Goffi <goffi@goffi.org>
parents:
312
diff
changeset
|
107 pass |
312
f56108eb2880
plugin group blog: a custom cb is now used to specitfy node and groups targetted by the blog
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
108 self.host.bridge.personalEvent(itemsEvent.sender.full(), "MICROBLOG", microblog_data, profile) |
307 | 109 |
110 def _getRootNode(self, entity): | |
111 return "%(entity)s_%(root_suff)s" % {'entity':entity.userhost(), 'root_suff':MBLOG_COLLECTION} | |
112 | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
113 def _getNodeName(self, number): |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
114 """Return the node name |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
115 @param number: int number of the node |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
116 @param entity: jid of the owner""" |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
117 return NS_MICROBLOG % number |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
118 |
307 | 119 def _getConfigNode(self, entity): |
120 return "%(entity)s_%(root_suff)s" % {'entity':entity.userhost(), 'root_suff':CONFIG_NODE} | |
121 | |
122 def _configNodeCb(self, result, callback, profile): | |
123 self._blog_nodes[profile] = {} | |
124 for item in result: | |
125 node_ass = item.firstChildElement() | |
126 assert(node_ass.name == "node_association") | |
127 node = node_ass['node'] | |
128 groups = [unicode(group) for group in node_ass.children] | |
129 self._blog_nodes[profile][node] = groups | |
130 callback(self._blog_nodes[profile]) | |
131 | |
132 def _configNodeFail(self, failure, errback): | |
133 import pdb | |
134 pdb.set_trace() | |
310
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
135 errback("") #FIXME |
307 | 136 |
137 def _configNodeErr(self, failure, user_jid, pubsub_ent, callback, errback, profile): | |
138 if failure.value.condition == 'item-not-found': | |
139 debug(_('Multiblog config node not found, creating it')) | |
310
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
140 _options = {OPT_ACCESS_MODEL:"whitelist", OPT_PERSIST_ITEMS:1, OPT_MAX_ITEMS:-1} |
307 | 141 d = self.host.plugins["XEP-0060"].createNode(pubsub_ent, self._getConfigNode(user_jid), _options, profile_key=profile) |
310
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
142 d.addCallback(lambda result: self._configNodeCb([] , callback, profile)) |
307 | 143 d.addErrback(self._configNodeFail, errback) |
144 else: | |
145 self._configNodeFail(failure, errback) | |
146 | |
147 def getMblogNodes(self, profile_key='@DEFAULT@', callback=None, errback=None): | |
148 debug(_('Getting mblog nodes')) | |
149 profile = self.host.memory.getProfileName(profile_key) | |
150 if not profile: | |
151 error(_("Unknown profile")) | |
152 return {} | |
153 | |
154 def after_init(ignore): | |
155 pubsub_ent = self.host.memory.getServerServiceEntity("pubsub", "service", profile) | |
156 _jid, xmlstream = self.host.getJidNStream(profile_key) | |
157 d = self.host.plugins["XEP-0060"].getItems(pubsub_ent, self._getConfigNode(_jid), profile_key=profile_key) | |
158 d.addCallbacks(self._configNodeCb, self._configNodeErr, callbackArgs=(callback, profile), errbackArgs=(_jid, pubsub_ent, callback, errback, profile)) | |
159 | |
160 client = self.host.getClient(profile) | |
161 if not client: | |
162 error(_('No client for this profile key: %s') % profile_key) | |
163 return | |
164 client.client_initialized.addCallback(after_init) | |
165 | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
166 def _publishMblog(self, name, message, client): |
307 | 167 """Actually publish the message on the group blog |
168 @param name: name of the node where we publish | |
169 @param message: message to publish | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
170 @param client: SatXMPPClient of the published""" |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
171 mblog_item = self.host.plugins["XEP-0277"].data2entry({'content':message}, client.profile) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
172 defer_blog = self.host.plugins["XEP-0060"].publish(client.jid.userhostJID(), name, items=[mblog_item], profile_key=client.profile) |
307 | 173 defer_blog.addErrback(self._mblogPublicationFailed) |
174 | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
175 def _groupNodeCreated(self, ignore, groups, name, message, client): |
307 | 176 """A group node as been created, we need to add it to the configure node, and send the message to it |
177 @param groups: list of groups authorized to subscribe to the node | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
178 @param name: unique name of the node |
307 | 179 @param message: message to publish to the group |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
180 @param client: SatXMPPClient""" |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
181 def configNodeUpdated(result): |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
182 self._blog_nodes[client.profile][name] = groups |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
183 debug(_("Configuration node updated")) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
184 |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
185 config_node = self._getConfigNode(client.jid) |
307 | 186 _payload = domish.Element(('','node_association')) |
187 _payload['node'] = name | |
188 for group in groups: | |
189 _payload.addElement('group',content=group) | |
190 config_item = pubsub.Item(payload=_payload) | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
191 pubsub_ent = self.host.memory.getServerServiceEntity("pubsub", "service", client.profile) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
192 defer_config = self.host.plugins["XEP-0060"].publish(pubsub_ent, config_node, items=[config_item], profile_key=client.profile) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
193 defer_config.addCallback(configNodeUpdated) |
307 | 194 defer_config.addErrback(self._configUpdateFailed) |
195 | |
196 #Finally, we publish the message | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
197 self._publishMblog(name, message, client) |
307 | 198 |
199 | |
200 def _mblogPublicationFailed(self, failure): | |
201 #TODO | |
202 import pdb | |
203 pdb.set_trace() | |
204 | |
205 def _configUpdateFailed(self, failure): | |
206 #TODO | |
207 import pdb | |
208 pdb.set_trace() | |
209 | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
210 def _nodeCreationFailed(self, failure, name, groups, message, client): |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
211 #FIXME: temporary behaviour is to delete the node, |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
212 #user input should be required in the future |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
213 def unmanagedError(failure): |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
214 msg = _("Can't create node") |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
215 error(msg) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
216 raise NodeCreationError(msg) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
217 |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
218 if failure.value.condition == 'conflict': |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
219 pubsub_elts = filter(lambda elt: elt.name == 'pubsub', failure.value.children) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
220 if pubsub_elts: |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
221 create_elts = filter(lambda elt: elt.name == 'create', pubsub_elts[0].children) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
222 if create_elts: |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
223 _from = jid.JID(failure.value.stanza['from']) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
224 _node = create_elts[0]['node'] |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
225 d = self.host.plugins["XEP-0060"].deleteNode(_from, _node, client.profile) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
226 d.addCallback(self._createNode, name, groups, message, client) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
227 d.addErrback(unmanagedError) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
228 else: |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
229 unmanagedError(None) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
230 msg = _("Can't create node") |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
231 error(msg) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
232 raise NodeCreationError(msg) |
307 | 233 |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
234 def _createNode(self, ignore, name, groups, message, client): |
307 | 235 """create a group microblog node |
236 @param ignore: ignored param, necessary to be added as a deferred callback | |
237 @param name: name of the node | |
238 @param groups: list of group than can subscribe to the node | |
239 @param message: message to publish | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
240 @param client: SatXMPPClient""" |
310
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
241 _options = {OPT_ACCESS_MODEL:"roster", OPT_PERSIST_ITEMS:1, OPT_MAX_ITEMS:-1, |
307 | 242 'pubsub#roster_groups_allowed':groups} |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
243 d = self.host.plugins["XEP-0060"].createNode(client.jid.userhostJID(), name, _options, client.profile) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
244 d.addCallback(self._groupNodeCreated, groups, name, message, client) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
245 d.addErrback(self._nodeCreationFailed, name, groups, message, client) |
307 | 246 |
247 def _getNodeForGroups(self, groups, profile): | |
248 """Return node associated with the given list of groups | |
249 @param groups: list of groups | |
250 @param profile: profile of publisher""" | |
251 for node in self._blog_nodes[profile]: | |
252 node_groups = self._blog_nodes[profile][node] | |
253 if set(node_groups) == set(groups): | |
254 return node | |
255 return None | |
256 | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
257 def _getFreeNode(self, entity, profile): |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
258 """Return a free group number, |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
259 raise an exception if we have reach limit""" |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
260 _all = set([self._getNodeName(idx) for idx in range(1,21)]) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
261 _used = set(self._blog_nodes[profile].keys()) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
262 _free = _all.difference(_used) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
263 if not _free: |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
264 msg = _("Can't create group node: no more free node available") |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
265 warning(msg) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
266 raise NodeCreationError(msg) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
267 else: |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
268 return _free.pop() |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
269 |
307 | 270 def sendGroupBlog(self, groups, message, profile_key='@DEFAULT@'): |
271 """Publish a microblog to the node associated to the groups | |
272 If the node doesn't exist, it is created, then the message is posted | |
273 @param groups: list of groups allowed to retrieve the microblog | |
274 @param message: microblog | |
275 @profile_key: %(doc_profile)s | |
276 """ | |
277 profile = self.host.memory.getProfileName(profile_key) | |
278 if not profile: | |
279 error(_("Unknown profile")) | |
280 return | |
281 | |
282 def after_init(ignore): | |
283 _groups = list(set(groups).intersection(client.roster.getGroups())) #We only keep group which actually exist | |
284 #TODO: send an error signal if user want to post to non existant groups | |
285 _groups.sort() | |
286 for group in _groups: | |
287 _node = self._getNodeForGroups([group], profile) | |
288 if not _node: | |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
289 _node_name = self._getFreeNode(client.jid, profile) |
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
290 self._createNode(None, _node_name, [group], message, client) |
307 | 291 else: |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
292 self._publishMblog(_node, message, client) |
307 | 293 |
294 client = self.host.getClient(profile) | |
295 if not client: | |
296 error(_('No client for this profile key: %s') % profile_key) | |
297 return | |
298 client.client_initialized.addCallback(after_init) | |
299 | |
308
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
300 def _doCleaning(self, result, pubsub_ent, profile): |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
301 """Compare the node in config node, and the existing nodes, and delete unknown ones""" |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
302 #TODO: manage groups which don't exist anymore |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
303 assert(len(result)==2) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
304 assert(result[0][0]==True and result[1][0]==True) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
305 config_nodes = [item.firstChildElement()["node"] for item in result[0][1]] |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
306 existing_nodes = [item.nodeIdentifier for item in result[1][1]._items] |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
307 to_delete = set(config_nodes).symmetric_difference(existing_nodes) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
308 def check_deletion(result): |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
309 for (success, value) in result: |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
310 if not success: |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
311 msg = _("Can't delete node") |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
312 error(msg) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
313 raise NodeDeletionError(msg) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
314 #TODO: log node which was not deleted |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
315 |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
316 |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
317 d = defer.DeferredList([self.host.plugins["XEP-0060"].deleteNode(pubsub_ent, node, profile) for node in to_delete]) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
318 d.addCallback(check_deletion) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
319 |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
320 def cleanBlogCollection(self, profile_key='@DEFAULT@'): |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
321 """Remove blog nodes not referenced in config node""" |
326
0f9925193586
core, plugin mblog: fixed some exceptions
Goffi <goffi@goffi.org>
parents:
312
diff
changeset
|
322 debug(_('Cleaning mblog nodes')) |
308
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
323 profile = self.host.memory.getProfileName(profile_key) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
324 if not profile: |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
325 error(_("Unknown profile")) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
326 return {} |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
327 |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
328 def after_init(ignore): |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
329 pubsub_ent = self.host.memory.getServerServiceEntity("pubsub", "service", profile) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
330 _jid, xmlstream = self.host.getJidNStream(profile_key) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
331 d_config = self.host.plugins["XEP-0060"].getItems(pubsub_ent, self._getConfigNode(_jid), profile_key=profile_key) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
332 d_root = client.disco.requestItems(pubsub_ent, self._getRootNode(client.jid)) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
333 defer.DeferredList([d_config, d_root]).addCallback(self._doCleaning, pubsub_ent, profile) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
334 |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
335 client = self.host.getClient(profile) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
336 if not client: |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
337 error(_('No client for this profile key: %s') % profile_key) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
338 return |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
339 client.client_initialized.addCallback(after_init) |
ce3607b7198d
plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
340 |
310
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
341 def subscribeGroupBlog(self, pub_jid, profile_key='@DEFAULT@'): |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
342 debug(_('subscribing mblog nodes')) |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
343 _pub_jid = jid.JID(pub_jid) |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
344 profile = self.host.memory.getProfileName(profile_key) |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
345 if not profile: |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
346 error(_("Unknown profile")) |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
347 return |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
348 |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
349 def after_init(ignore): |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
350 pubsub_ent = self.host.memory.getServerServiceEntity("pubsub", "service", profile) |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
351 _options = {OPT_SUBSCRIPTION_TYPE:'items', OPT_SUBSCRIPTION_DEPTH:'1'} |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
352 d = self.host.plugins["XEP-0060"].subscribe(pubsub_ent, self._getRootNode(_pub_jid), options = _options, profile_key=profile) |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
353 d.addCallback(lambda x: debug(_("%(publisher)s's group node subscribed [%(profile)s]") % {'publisher':_pub_jid.userhost(), 'profile': profile})) |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
354 d.addErrback(lambda x: error(_("Can't subscribe group node [%(profile)s]") % {'profile': profile})) |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
355 |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
356 client = self.host.getClient(profile) |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
357 if not client: |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
358 error(_('No client for this profile key: %s') % profile_key) |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
359 return |
53adec87d1d7
plugin group blog: group blog subscription
Goffi <goffi@goffi.org>
parents:
308
diff
changeset
|
360 client.client_initialized.addCallback(after_init) |
311
0aa6ca6cdbdd
plugin group blog: group blog now use PEP to take profit of autosubscribe
Goffi <goffi@goffi.org>
parents:
310
diff
changeset
|
361 |