annotate src/plugins/plugin_misc_groupblog.py @ 308:ce3607b7198d

plugin group blog: blog collection cleaning
author Goffi <goffi@goffi.org>
date Thu, 07 Apr 2011 23:40:33 +0200
parents 1e4575e12581
children 53adec87d1d7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
4 """
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
5 SAT plugin for microbloging with roster access
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
6 Copyright (C) 2009, 2010, 2011 Jérôme Poisson (goffi@goffi.org)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
7
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
8 This program is free software: you can redistribute it and/or modify
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
9 it under the terms of the GNU General Public License as published by
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
10 the Free Software Foundation, either version 3 of the License, or
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
11 (at your option) any later version.
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
12
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
13 This program is distributed in the hope that it will be useful,
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
16 GNU General Public License for more details.
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
17
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
20 """
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
21
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
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
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
24 from twisted.words.protocols.jabber import jid
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
25 from twisted.words.protocols.jabber import error as jab_error
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
26 import twisted.internet.error
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
27 from twisted.words.xish import domish
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
28 from sat.tools.xml_tools import ElementParser
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
29
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
30 from wokkel import disco,pubsub
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
31 from feed.atom import Entry, Author
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
32 import uuid
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
33 from time import time
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
34
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
35 MBLOG_COLLECTION = 'MBLOGCOLLECTION'
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
36 CONFIG_NODE = 'CONFIG'
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
37 NS_ACCESS_MODEL = 'pubsub#access_model'
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
38 NS_PERSIST_ITEMS = 'pubsub#persist_items'
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
39 NS_MAX_ITEMS = 'pubsub#max_items'
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
40 NS_NODE_TYPE = 'pubsub#node_type'
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
41 TYPE_COLLECTION = 'collection'
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
42
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
43 PLUGIN_INFO = {
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
44 "name": "Group blogging throught collections",
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
45 "import_name": "groupblog",
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
46 "type": "MISC",
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
47 "protocols": [],
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
48 "dependencies": ["XEP-0277"],
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
49 "main": "GroupBlog",
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
50 "handler": "no",
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
51 "description": _("""Implementation of microblogging with roster access""")
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
52 }
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
53
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
54 class NodeCreationError(Exception):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
55 pass
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
56
308
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
57 class NodeDeletionError(Exception):
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
58 pass
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
59
307
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
60 class GroupBlog():
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
61 """This class use a PubSub Collection to manage roster access on microblog"""
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
62
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
63 def __init__(self, host):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
64 info(_("Group blog plugin initialization"))
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
65 self.host = host
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
66 self._blog_nodes={}
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
67
308
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
68 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
69 method=self.cleanBlogCollection,
307
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
70 doc = {
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
71 })
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
72
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
73 host.bridge.addMethod("getMblogNodes", ".communication", in_sign='s', out_sign='a{sas}',
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
74 method=self.getMblogNodes,
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
75 async = True,
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
76 doc = { 'summary':"retrieve mblog node, and their association with roster's groups",
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
77 'param_0':'%(doc_profile)s',
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
78 'return':'list of microblog data (dict)'
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
79 })
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
80
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
81 host.bridge.addMethod("sendGroupBlog", ".communication", in_sign='asss', out_sign='',
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
82 method=self.sendGroupBlog,
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
83 doc = { 'summary':"Send a microblog to a list of groups",
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
84 'param_0':'list of groups which can read the microblog',
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
85 'param_1':'text to send',
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
86 'param_2':'%(doc_profile)s'
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
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
89 def _getRootNode(self, entity):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
90 return "%(entity)s_%(root_suff)s" % {'entity':entity.userhost(), 'root_suff':MBLOG_COLLECTION}
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
91
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
92 def _getConfigNode(self, entity):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
93 return "%(entity)s_%(root_suff)s" % {'entity':entity.userhost(), 'root_suff':CONFIG_NODE}
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
94
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
95 def _configNodeCb(self, result, callback, profile):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
96 self._blog_nodes[profile] = {}
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
97 for item in result:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
98 node_ass = item.firstChildElement()
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
99 assert(node_ass.name == "node_association")
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
100 node = node_ass['node']
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
101 groups = [unicode(group) for group in node_ass.children]
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
102 self._blog_nodes[profile][node] = groups
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
103 callback(self._blog_nodes[profile])
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
104
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
105 def _configNodeFail(self, failure, errback):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
106 import pdb
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
107 pdb.set_trace()
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
108 errback() #FIXME
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
109
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
110 def _configNodeErr(self, failure, user_jid, pubsub_ent, callback, errback, profile):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
111 if failure.value.condition == 'item-not-found':
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
112 debug(_('Multiblog config node not found, creating it'))
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
113 _options = {NS_ACCESS_MODEL:"whitelist", NS_PERSIST_ITEMS:1, NS_MAX_ITEMS:-1}
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
114 d = self.host.plugins["XEP-0060"].createNode(pubsub_ent, self._getConfigNode(user_jid), _options, profile_key=profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
115 d.addCallback(self._configNodeCb, callback, profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
116 d.addErrback(self._configNodeFail, errback)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
117 else:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
118 self._configNodeFail(failure, errback)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
119
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
120 def getMblogNodes(self, profile_key='@DEFAULT@', callback=None, errback=None):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
121 debug(_('Getting mblog nodes'))
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
122 profile = self.host.memory.getProfileName(profile_key)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
123 if not profile:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
124 error(_("Unknown profile"))
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
125 return {}
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
126
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
127 def after_init(ignore):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
128 pubsub_ent = self.host.memory.getServerServiceEntity("pubsub", "service", profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
129 _jid, xmlstream = self.host.getJidNStream(profile_key)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
130 d = self.host.plugins["XEP-0060"].getItems(pubsub_ent, self._getConfigNode(_jid), profile_key=profile_key)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
131 d.addCallbacks(self._configNodeCb, self._configNodeErr, callbackArgs=(callback, profile), errbackArgs=(_jid, pubsub_ent, callback, errback, profile))
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
132
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
133 client = self.host.getClient(profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
134 if not client:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
135 error(_('No client for this profile key: %s') % profile_key)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
136 return
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
137 client.client_initialized.addCallback(after_init)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
138
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
139 def _publishMblog(self, name, message, pubsub_ent, profile):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
140 """Actually publish the message on the group blog
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
141 @param name: name of the node where we publish
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
142 @param message: message to publish
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
143 @param pubsub_ent: entity of the publish-subscribe service
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
144 @param profile: profile of the owner of the group"""
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
145 mblog_item = self.host.plugins["XEP-0277"].data2entry({'content':message}, profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
146 defer_blog = self.host.plugins["XEP-0060"].publish(pubsub_ent, name, items=[mblog_item], profile_key=profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
147 defer_blog.addErrback(self._mblogPublicationFailed)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
148
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
149 def _groupNodeCreated(self, ignore, groups, name, message, user_jid, pubsub_ent, profile):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
150 """A group node as been created, we need to add it to the configure node, and send the message to it
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
151 @param groups: list of groups authorized to subscribe to the node
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
152 @param name: unique name of the group
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
153 @param message: message to publish to the group
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
154 @param user_jid: jid of the owner of the node
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
155 @param pubsub_ent: entity of the publish-subscribe service
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
156 @param profile: profile of the owner of the group"""
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
157 config_node = self._getConfigNode(user_jid)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
158 _payload = domish.Element(('','node_association'))
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
159 _payload['node'] = name
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
160 for group in groups:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
161 _payload.addElement('group',content=group)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
162 config_item = pubsub.Item(payload=_payload)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
163 defer_config = self.host.plugins["XEP-0060"].publish(pubsub_ent, config_node, items=[config_item], profile_key=profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
164 defer_config.addCallback(lambda x: debug(_("Configuration node updated")))
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
165 defer_config.addErrback(self._configUpdateFailed)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
166
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
167 #Finally, we publish the message
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
168 self._publishMblog(name, message, pubsub_ent, profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
169
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
170
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
171 def _mblogPublicationFailed(self, failure):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
172 #TODO
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
173 import pdb
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
174 pdb.set_trace()
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
175
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
176 def _configUpdateFailed(self, failure):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
177 #TODO
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
178 import pdb
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
179 pdb.set_trace()
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
180
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
181 def _nodeCreationFailed(self, failure, name, user_jid, groups, pubsub_ent, message, profile):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
182 #TODO
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
183 if failure.value.condition == "item-not-found":
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
184 #The root node doesn't exists
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
185 def err_creating_root_node(failure):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
186 msg = _("Can't create Root node")
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
187 error(msg)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
188 raise NodeCreationError(msg)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
189
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
190 _options = {NS_NODE_TYPE:TYPE_COLLECTION}
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
191 d = self.host.plugins["XEP-0060"].createNode(pubsub_ent, self._getRootNode(user_jid), _options, profile_key=profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
192 d.addCallback(self._createNode, name, user_jid, groups, pubsub_ent, message, profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
193 d.addErrback(err_creating_root_node)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
194 else:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
195 import pdb
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
196 pdb.set_trace()
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
197
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
198 def _createNode(self, ignore, name, user_jid, groups, pubsub_ent, message, profile):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
199 """create a group microblog node
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
200 @param ignore: ignored param, necessary to be added as a deferred callback
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
201 @param name: name of the node
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
202 @param user_jid: jid of the user creating the node
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
203 @param groups: list of group than can subscribe to the node
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
204 @param pubsub_ent: publish/subscribe service's entity
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
205 @param message: message to publish
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
206 @param profile: profile of the user creating the node"""
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
207 _options = {NS_ACCESS_MODEL:"roster", NS_PERSIST_ITEMS:1, NS_MAX_ITEMS:-1,
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
208 'pubsub#node_type':'leaf', 'pubsub#collection':self._getRootNode(user_jid),
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
209 'pubsub#roster_groups_allowed':groups}
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
210 d = self.host.plugins["XEP-0060"].createNode(pubsub_ent, name, _options, profile_key=profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
211 d.addCallback(self._groupNodeCreated, groups, name, message, user_jid, pubsub_ent, profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
212 d.addErrback(self._nodeCreationFailed, name, user_jid, groups, pubsub_ent, message, profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
213
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
214 def _getNodeForGroups(self, groups, profile):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
215 """Return node associated with the given list of groups
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
216 @param groups: list of groups
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
217 @param profile: profile of publisher"""
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
218 for node in self._blog_nodes[profile]:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
219 node_groups = self._blog_nodes[profile][node]
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
220 if set(node_groups) == set(groups):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
221 return node
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
222 return None
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
223
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
224 def sendGroupBlog(self, groups, message, profile_key='@DEFAULT@'):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
225 """Publish a microblog to the node associated to the groups
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
226 If the node doesn't exist, it is created, then the message is posted
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
227 @param groups: list of groups allowed to retrieve the microblog
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
228 @param message: microblog
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
229 @profile_key: %(doc_profile)s
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
230 """
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
231 profile = self.host.memory.getProfileName(profile_key)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
232 if not profile:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
233 error(_("Unknown profile"))
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
234 return
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
235
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
236 def after_init(ignore):
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
237 _groups = list(set(groups).intersection(client.roster.getGroups())) #We only keep group which actually exist
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
238 #TODO: send an error signal if user want to post to non existant groups
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
239 _groups.sort()
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
240 pubsub_ent = self.host.memory.getServerServiceEntity("pubsub", "service", profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
241 for group in _groups:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
242 _node = self._getNodeForGroups([group], profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
243 if not _node:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
244 _node_name = unicode(uuid.uuid4())
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
245 self._createNode(None, _node_name, client.jid, [group], pubsub_ent, message, profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
246 else:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
247 self._publishMblog(_node, message, pubsub_ent, profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
248
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
249 client = self.host.getClient(profile)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
250 if not client:
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
251 error(_('No client for this profile key: %s') % profile_key)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
252 return
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
253 client.client_initialized.addCallback(after_init)
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
254
308
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
255 def _doCleaning(self, result, pubsub_ent, profile):
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
256 """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
257 #TODO: manage groups which don't exist anymore
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
258 assert(len(result)==2)
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
259 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
260 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
261 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
262 to_delete = set(config_nodes).symmetric_difference(existing_nodes)
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
263 def check_deletion(result):
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
264 for (success, value) in result:
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
265 if not success:
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
266 msg = _("Can't delete node")
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
267 error(msg)
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
268 raise NodeDeletionError(msg)
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
269 #TODO: log node which was not deleted
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
270
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
271
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
272 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
273 d.addCallback(check_deletion)
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
274
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
275 def cleanBlogCollection(self, profile_key='@DEFAULT@'):
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
276 """Remove blog nodes not referenced in config node"""
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
277 debug(_('Getting mblog nodes'))
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
278 profile = self.host.memory.getProfileName(profile_key)
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
279 if not profile:
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
280 error(_("Unknown profile"))
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
281 return {}
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
282
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
283 def after_init(ignore):
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
284 pubsub_ent = self.host.memory.getServerServiceEntity("pubsub", "service", profile)
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
285 _jid, xmlstream = self.host.getJidNStream(profile_key)
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
286 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
287 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
288 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
289
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
290 client = self.host.getClient(profile)
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
291 if not client:
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
292 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
293 return
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
294 client.client_initialized.addCallback(after_init)
ce3607b7198d plugin group blog: blog collection cleaning
Goffi <goffi@goffi.org>
parents: 307
diff changeset
295