1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
/**
* $RCSfile: $
* $Revision: $
* $Date: $
*
* Copyright (C) 2006 Jive Software. All rights reserved.
*
* This software is published under the terms of the GNU Public License (GPL),
* a copy of which is included in this distribution.
*/
package org.jivesoftware.wildfire.pubsub;
import org.dom4j.Element;
import org.jivesoftware.util.LocaleUtils;
import org.jivesoftware.util.Log;
import org.jivesoftware.util.FastDateFormat;
import org.xmpp.forms.DataForm;
import org.xmpp.forms.FormField;
import org.xmpp.packet.JID;
import org.xmpp.packet.Message;
import org.xmpp.packet.IQ;
import org.xmpp.packet.Presence;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.*;
/**
* A subscription to a node. Entities may subscribe to a node to be notified when new events
* are published to the node. Published events may contain a {@link PublishedItem}. Only
* nodes that are configured to not deliver payloads with event notifications and to not
* persist items will let publishers to publish events without items thus not including
* items in the notifications sent to subscribers.<p>
*
* Node subscriptions may need to be configured by the subscriber or approved by a node owner
* to become active. The node configuration establishes whether configuration or approval are
* required. In any case, the subscriber will not get event notifications until the subscription
* is active.<p>
*
* Depending on the node configuration it may be possible for the same subscriber to subscribe
* multiple times to the node. Each subscription may have a different configuration like for
* instance different keywords. Keywords can be used as a way to filter the type of
* {@link PublishedItem} to be notified of. When the same subscriber has subscribed multiple
* times to the node a single notification is going to be sent to the subscriber instead of
* sending a notification for each subscription.
*
* @author Matt Tucker
*/
public class NodeSubscription {
private static SimpleDateFormat dateFormat;
private static FastDateFormat fastDateFormat;
/**
* Reference to the publish and subscribe service.
*/
private PubSubService service;
/**
* The node to which this subscription is interested in.
*/
private Node node;
/**
* JID of the entity that will receive the event notifications.
*/
private JID jid;
/**
* JID of the entity that owns this subscription. This JID is the JID of the
* NodeAffiliate that is subscribed to the node.
*/
private JID owner;
/**
* ID that uniquely identifies the subscription of the user in the node.
*/
private String id;
/**
* Current subscription state.
*/
private State state;
/**
* Flag that indicates if configuration is required by the node and is still pending to
* be configured by the subscriber.
*/
private boolean configurationPending = false;
/**
* Flag indicating whether an entity wants to receive or has disabled notifications.
*/
private boolean deliverNotifications = true;
/**
* Flag indicating whether an entity wants to receive digests (aggregations) of
* notifications or all notifications individually.
*/
private boolean usingDigest = false;
/**
* The minimum number of milliseconds between sending any two notification digests.
* Default is 24 hours.
*/
private int digestFrequency = 86400000;
/**
* The Date at which a leased subscription will end or has ended. A value of
* <tt>null</tt> means that the subscription will never expire.
*/
private Date expire = null;
/**
* Flag indicating whether an entity wants to receive an XMPP message body in
* addition to the payload format.
*/
private boolean includingBody = false;
/**
* The presence states for which an entity wants to receive notifications.
*/
private Collection<String> presenceStates = new ArrayList<String>();
/**
* When subscribing to collection nodes it is possible to be interested in new nodes
* added to the collection node or new items published in the children nodes. The default
* value is "nodes".
*/
private Type type = Type.nodes;
/**
* Receive notification from children up to certain depth. Possible values are 1 or 0.
* Zero means that there is no depth limit.
*/
private int depth = 1;
/**
* Keyword that the event needs to match. When <tt>null</tt> all event are going to
* be notified to the subscriber.
*/
private String keyword = null;
/**
* Indicates if the subscription is present in the database.
*/
private boolean savedToDB = false;
// TODO Do not send event notifications (e.g. node purge, node deleted) to unconfigured subscriptions ????
// TODO Send last published item when a subscription is authorized. We may need to move this logic to another place
// TODO Implement presence subscription from the node to the subscriber to figure out if event notifications can be sent
static {
dateFormat = new SimpleDateFormat("yyyy-MM-DD'T'HH:mm:ss.SSS'Z'");
dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
fastDateFormat = FastDateFormat
.getInstance("yyyy-MM-DD'T'HH:mm:ss.SSS'Z'", TimeZone.getTimeZone("UTC"));
}
/**
* Creates a new subscription of the specified user with the node.
*
* @param service the pubsub service hosting the node where this subscription lives.
* @param node Node to which this subscription is interested in.
* @param owner the JID of the entity that owns this subscription.
* @param jid the JID of the user that owns the subscription.
* @param state the state of the subscription with the node.
* @param id the id the uniquely identifies this subscriptin within the node.
*/
NodeSubscription(PubSubService service, Node node, JID owner, JID jid, State state, String id) {
this.service = service;
this.node = node;
this.jid = jid;
this.owner = owner;
this.state = state;
this.id = id;
if (node.isSubscriptionConfigurationRequired()) {
// Subscription configuration is required and it's still pending
setConfigurationPending(true);
}
}
/**
* Returns the node that holds this subscription.
*
* @return the node that holds this subscription.
*/
public Node getNode() {
return node;
}
/**
* Returns the ID that uniquely identifies the subscription of the user in the node.
*
* @return the ID that uniquely identifies the subscription of the user in the node.
*/
public String getID() {
return id;
}
/**
* Returns the JID that is going to receive the event notifications. This JID can be the
* owner JID or a full JID if the owner wants to receive the notification at a particular
* resource.<p>
*
* Moreover, since subscriber and owner are separated it should be theorically possible to
* have a different owner JID (e.g. gato@server1.com) and a subscriber JID
* (e.g. gato@server2.com). Note that letting this case to happen may open the pubsub service
* to get spam or security problems. However, the pubsub service should avoid this case to
* happen.
*
* @return the JID that is going to receive the event notifications.
*/
public JID getJID() {
return jid;
}
/**
* Retuns the JID of the entity that owns this subscription. The owner entity will have
* a {@link NodeAffiliate} for the owner JID. The owner may have more than one subscription
* with the node based on what this message
* {@link org.jivesoftware.wildfire.pubsub.Node#isMultipleSubscriptionsEnabled()}.
*
* @return he JID of the entity that owns this subscription.
*/
public JID getOwner() {
return owner;
}
/**
* Returns the current subscription state. Subscriptions with status of pending should be
* authorized by a node owner.
*
* @return the current subscription state.
*/
public State getState() {
return state;
}
/**
* Returns true if configuration is required by the node and is still pending to
* be configured by the subscriber. Otherwise return false.
*
* @return true if configuration is required by the node and is still pending to
* be configured by the subscriber.
*/
public boolean isConfigurationPending() {
return configurationPending;
}
/**
* Returns true if the subscription was approved by a node owner. Nodes that don't
* require node owners to approve subscription assume that all subscriptions are approved.
*
* @return true if the subscription was approved by a node owner.
*/
public boolean isApproved() {
return State.subscribed == state;
}
/**
* Returns whether an entity wants to receive or has disabled notifications.
*
* @return true when notifications should be sent to the subscriber.
*/
public boolean shouldDeliverNotifications() {
return deliverNotifications;
}
/**
* Returns whether an entity wants to receive digests (aggregations) of
* notifications or all notifications individually.
*
* @return true when an entity wants to receive digests (aggregations) of notifications.
*/
public boolean isUsingDigest() {
return usingDigest;
}
/**
* Returns the minimum number of milliseconds between sending any two notification digests.
* Default is 24 hours.
*
* @return the minimum number of milliseconds between sending any two notification digests.
*/
public int getDigestFrequency() {
return digestFrequency;
}
/**
* Returns the Date at which a leased subscription will end or has ended. A value of
* <tt>null</tt> means that the subscription will never expire.
*
* @return the Date at which a leased subscription will end or has ended. A value of
* <tt>null</tt> means that the subscription will never expire.
*/
public Date getExpire() {
return expire;
}
/**
* Returns whether an entity wants to receive an XMPP message body in
* addition to the payload format.
*
* @return true when an entity wants to receive an XMPP message body in
* addition to the payload format
*/
public boolean isIncludingBody() {
return includingBody;
}
/**
* The presence states for which an entity wants to receive notifications. When the owner
* is in any of the returned presence states then he is allowed to receive notifications.
*
* @return the presence states for which an entity wants to receive notifications.
* (e.g. available, away, etc.)
*/
public Collection<String> getPresenceStates() {
return presenceStates;
}
/**
* Returns if the owner has subscribed to receive notification of new items only
* or of new nodes only. When subscribed to a Leaf Node then only <tt>items</tt>
* is available.
*
* @return whether the owner has subscribed to receive notification of new items only
* or of new nodes only.
*/
public Type getType() {
return type;
}
/**
* Returns 1 when the subscriber wants to receive notifications only from first-level
* children of the collection. A value of 0 means that the subscriber wants to receive
* notifications from all descendents.
*
* @return 1 when the subscriber wants to receive notifications only from first-level
* children of the collection or 0 when notififying only from all descendents.
*/
public int getDepth() {
return depth;
}
/**
* Returns the keyword that the event needs to match. When <tt>null</tt> all event
* are going to be notified to the subscriber.
*
* @return the keyword that the event needs to match. When <tt>null</tt> all event
* are going to be notified to the subscriber.
*/
public String getKeyword() {
return keyword;
}
void setConfigurationPending(boolean configurationPending) {
this.configurationPending = configurationPending;
}
void setShouldDeliverNotifications(boolean deliverNotifications) {
this.deliverNotifications = deliverNotifications;
}
void setUsingDigest(boolean usingDigest) {
this.usingDigest = usingDigest;
}
void setDigestFrequency(int digestFrequency) {
this.digestFrequency = digestFrequency;
}
void setExpire(Date expire) {
this.expire = expire;
}
void setIncludingBody(boolean includingBody) {
this.includingBody = includingBody;
}
void setPresenceStates(Collection<String> presenceStates) {
this.presenceStates = presenceStates;
}
void setType(Type type) {
this.type = type;
}
void setDepth(int depth) {
this.depth = depth;
}
void setKeyword(String keyword) {
this.keyword = keyword;
}
void setSavedToDB(boolean savedToDB) {
this.savedToDB = savedToDB;
}
void configure(DataForm options) {
List<String> values;
String booleanValue;
// Remove this field from the form
options.removeField("FORM_TYPE");
// Process and remove specific collection node fields
FormField collectionField = options.getField("pubsub#subscription_type");
if (collectionField != null) {
values = collectionField.getValues();
if (values.size() > 0) {
type = Type.valueOf(values.get(0));
}
options.removeField("pubsub#subscription_type");
}
collectionField = options.getField("pubsub#subscription_depth");
if (collectionField != null) {
values = collectionField.getValues();
depth = "all".equals(values.get(0)) ? 0 : 1;
options.removeField("pubsub#subscription_depth");
}
// If there are more fields in the form then process them and set that
// the subscription has been configured
for (FormField field : options.getFields()) {
boolean fieldExists = true;
if ("pubsub#deliver".equals(field.getVariable())) {
values = field.getValues();
booleanValue = (values.size() > 0 ? values.get(0) : "1");
deliverNotifications = "1".equals(booleanValue);
}
else if ("pubsub#digest".equals(field.getVariable())) {
values = field.getValues();
booleanValue = (values.size() > 0 ? values.get(0) : "1");
usingDigest = "1".equals(booleanValue);
}
else if ("pubsub#digest_frequency".equals(field.getVariable())) {
values = field.getValues();
digestFrequency = values.size() > 0 ? Integer.parseInt(values.get(0)) : 86400000;
}
else if ("pubsub#expire".equals(field.getVariable())) {
values = field.getValues();
synchronized (dateFormat) {
try {
expire = dateFormat.parse(values.get(0));
}
catch (ParseException e) {
Log.error("Error parsing date", e);
}
}
}
else if ("pubsub#include_body".equals(field.getVariable())) {
values = field.getValues();
booleanValue = (values.size() > 0 ? values.get(0) : "1");
includingBody = "1".equals(booleanValue);
}
else if ("pubsub#show-values".equals(field.getVariable())) {
// Get the new list of presence states for which an entity wants to
// receive notifications
presenceStates = new ArrayList<String>();
for (String value : field.getValues()) {
try {
presenceStates.add(value);
}
catch (Exception e) {}
}
}
else if ("x-pubsub#keywords".equals(field.getVariable())) {
values = field.getValues();
keyword = values.isEmpty() ? null : values.get(0);
}
else {
fieldExists = false;
}
if (fieldExists) {
// Mark that the subscription has been configured
setConfigurationPending(false);
}
}
if (savedToDB) {
// Update the subscription in the backend store
PubSubPersistenceManager.saveSubscription(service, node, this, false);
}
}
/**
* Returns a data form with the subscription configuration. The data form can be used to
* edit the subscription configuration.
*
* @return data form used by the subscriber to edit the subscription configuration.
*/
DataForm getConfigurationForm() {
DataForm form = new DataForm(DataForm.Type.form);
form.setTitle(LocaleUtils.getLocalizedString("pubsub.form.subscription.title"));
List<String> params = new ArrayList<String>();
params.add(node.getNodeID());
form.addInstruction(LocaleUtils.getLocalizedString("pubsub.form.subscription.instruction", params));
// Add the form fields and configure them for edition
FormField formField = form.addField();
formField.setVariable("FORM_TYPE");
formField.setType(FormField.Type.hidden);
formField.addValue("http://jabber.org/protocol/pubsub#subscribe_options");
formField = form.addField();
formField.setVariable("pubsub#deliver");
formField.setType(FormField.Type.boolean_type);
formField.setLabel(LocaleUtils.getLocalizedString("pubsub.form.subscription.deliver"));
formField.addValue(deliverNotifications);
formField = form.addField();
formField.setVariable("pubsub#digest");
formField.setType(FormField.Type.boolean_type);
formField.setLabel(LocaleUtils.getLocalizedString("pubsub.form.subscription.digest"));
formField.addValue(usingDigest);
formField = form.addField();
formField.setVariable("pubsub#digest_frequency");
formField.setType(FormField.Type.text_single);
formField.setLabel(LocaleUtils.getLocalizedString("pubsub.form.subscription.digest_frequency"));
formField.addValue(digestFrequency);
formField = form.addField();
formField.setVariable("pubsub#expire");
formField.setType(FormField.Type.text_single);
formField.setLabel(LocaleUtils.getLocalizedString("pubsub.form.subscription.expire"));
if (expire != null) {
formField.addValue(fastDateFormat.format(expire));
}
formField = form.addField();
formField.setVariable("pubsub#include_body");
formField.setType(FormField.Type.boolean_type);
formField.setLabel(LocaleUtils.getLocalizedString("pubsub.form.subscription.include_body"));
formField.addValue(includingBody);
formField = form.addField();
formField.setVariable("pubsub#show-values");
formField.setType(FormField.Type.list_multi);
formField.setLabel(LocaleUtils.getLocalizedString("pubsub.form.subscription.show-values"));
formField.addOption(null, Presence.Show.away.name());
formField.addOption(null, Presence.Show.chat.name());
formField.addOption(null, Presence.Show.dnd.name());
formField.addOption(null, "online");
formField.addOption(null, Presence.Show.xa.name());
for (String value : presenceStates) {
formField.addValue(value);
}
if (node.isCollectionNode()) {
formField = form.addField();
formField.setVariable("pubsub#subscription_type");
formField.setType(FormField.Type.list_single);
formField.setLabel(LocaleUtils.getLocalizedString("pubsub.form.subscription.subscription_type"));
formField.addOption(null, Type.items.name());
formField.addOption(null, Type.nodes.name());
formField.addValue(type);
formField = form.addField();
formField.setVariable("pubsub#subscription_depth");
formField.setType(FormField.Type.list_single);
formField.setLabel(LocaleUtils.getLocalizedString("pubsub.form.subscription.subscription_depth"));
formField.addOption(null, "1");
formField.addOption(null, "all");
formField.addValue(depth == 1 ? "1" : "all");
}
if (!node.isCollectionNode() || type == Type.items) {
formField = form.addField();
formField.setVariable("x-pubsub#keywords");
formField.setType(FormField.Type.text_single);
formField.setLabel(LocaleUtils.getLocalizedString("pubsub.form.subscription.keywords"));
if (keyword != null) {
formField.addValue(keyword);
}
}
return form;
}
/**
* Returns true if an event notification can be sent to the subscriber for the specified
* published item based on the subsription configuration and subscriber status.
*
* @param leafNode the node that received the publication.
* @param publishedItem the published item to send or null if the publication didn't
* contain an item.
* @return true if an event notification can be sent to the subscriber for the specified
* published item.
*/
boolean canSendEventNotification(LeafNode leafNode, PublishedItem publishedItem) {
// Check if the subscription is active
if (!isActive()) {
return false;
}
// Check if delivery of notifications is disabled
if (!shouldDeliverNotifications()) {
return false;
}
// Check if delivery is subject to presence-based policy
if (!getPresenceStates().isEmpty()) {
String show = service.getShowPresence(jid);
if (show == null || !getPresenceStates().contains(show)) {
return false;
}
}
// Check that any defined keyword was matched (applies only if an item was published)
if (publishedItem != null && !isKeywordMatched(publishedItem)) {
return false;
}
// Check special conditions when subscribed to collection node
if (node.isCollectionNode()) {
// Check if not subscribe to items
if (Type.items != type) {
return false;
}
// Check if published node is a first-level child of the subscribed node
if (getDepth() == 1 && !node.isChildNode(leafNode)) {
return false;
}
// Check if published node is a descendant child of the subscribed node
if (getDepth() == 0 && !node.isDescendantNode(leafNode)) {
return false;
}
}
return true;
}
/**
* Returns true if the published item matches the keyword filter specified in
* the subscription. If no keyword was specified then answer true.
*
* @param publishedItem the published item to send.
* @return true if the published item matches the keyword filter specified in
* the subscription.
*/
private boolean isKeywordMatched(PublishedItem publishedItem) {
// Check if keyword was defined and it was not matched
if (keyword != null && keyword.length() > 0 && !publishedItem.containsKeyword(keyword)) {
return false;
}
return true;
}
/**
* Returns true if the subscription is active. A subscription is considered active if it
* has not expired, it has been approved and configured.
*
* @return true if the subscription is active.
*/
private boolean isActive() {
// Check if subscription is approved and configured (if required)
if (!isApproved() || this.isConfigurationPending()) {
return false;
}
// Check if the subscription has expired
if (expire != null && new Date().after(expire)) {
// TODO This checking does not replace the fact that we need to implement expiration.
// TODO A thread that checks expired subscriptions and removes them is needed.
return false;
}
return true;
}
/**
* Sends the current subscription status to the user that tried to create a subscription to
* the node. The subscription status is sent to the subsciber after the subscription was
* created or if the subscriber tries to subscribe many times and the node does not support
* multpiple subscriptions.
*
* @param originalRequest the IQ packet sent by the subscriber to create the subscription.
*/
void sendSubscriptionState(IQ originalRequest) {
IQ result = IQ.createResultIQ(originalRequest);
Element child = result.setChildElement("pubsub", "http://jabber.org/protocol/pubsub");
Element entity = child.addElement("entity");
if (!node.isRootCollectionNode()) {
entity.addAttribute("node", node.getNodeID());
}
entity.addAttribute("jid", getJID().toString());
NodeAffiliate nodeAffiliate = getAffiliate();
entity.addAttribute("affiliation", nodeAffiliate.getAffiliation().name());
if (node.isMultipleSubscriptionsEnabled()) {
entity.addAttribute("subid", getID());
}
entity.addAttribute("subscription", getState().name());
Element subscribeOptions = entity.addElement("subscribe-options");
if (node.isSubscriptionConfigurationRequired() && isConfigurationPending()) {
subscribeOptions.addElement("required");
}
// Send the result
service.send(result);
}
/**
* Sends an IQ result with the list of items published to the node to the subscriber. The
* items to include in the result is subject to the subscription configuration. If the
* subscription is still pending to be approved or unconfigured then no items will be included.
*
* @param originalRequest the IQ packet sent by the subscriber to get the node items.
* @param publishedItems the list of published items to send to the subscriber.
* @param forceToIncludePayload true if the item payload should be include if one exists. When
* false the decision is up to the node.
*/
void sendPublishedItems(IQ originalRequest, List<PublishedItem> publishedItems,
boolean forceToIncludePayload) {
IQ result = IQ.createResultIQ(originalRequest);
Element childElement = originalRequest.getChildElement().createCopy();
result.setChildElement(childElement);
Element items = childElement.element("items");
if (isActive()) {
for (PublishedItem publishedItem : publishedItems) {
// Check if this published item can be included in the result
if (!isKeywordMatched(publishedItem)) {
continue;
}
Element item = items.addElement("item");
if (((LeafNode) node).isItemRequired()) {
item.addAttribute("id", publishedItem.getID());
}
if ((forceToIncludePayload || node.isDeliverPayloads()) &&
publishedItem.getPayload() != null) {
item.add(publishedItem.getPayload().createCopy());
}
}
}
// Send the result
service.send(result);
}
/**
* Sends an event notification for the last published item to the subscriber. If
* the subscription has not yet been authorized or is pending to be configured then
* no notification is going to be sent.<p>
*
* Depending on the subscription configuration the event notification may or may not have
* a payload, may not be sent if a keyword (i.e. filter) was defined and it was not matched.
*
* @param publishedItem the last item that was published to the node.
*/
void sendLastPublishedItem(PublishedItem publishedItem) {
// Check if the published item can be sent to the subscriber
if (!canSendEventNotification(publishedItem.getNode(), publishedItem)) {
return;
}
// Send event notification to the subscriber
Message notification = new Message();
Element event = notification.getElement()
.addElement("event", "http://jabber.org/protocol/pubsub#event");
Element items = event.addElement("items");
items.addAttribute("node", node.getNodeID());
Element item = items.addElement("item");
if (((LeafNode) node).isItemRequired()) {
item.addAttribute("id", publishedItem.getID());
}
if (node.isDeliverPayloads() && publishedItem.getPayload() != null) {
item.add(publishedItem.getPayload().createCopy());
}
// Add a message body (if required)
if (isIncludingBody()) {
notification.setBody(LocaleUtils.getLocalizedString("pubsub.notification.message.body"));
}
// Include date when published item was created
notification.getElement().addElement("x", "jabber:x:delay")
.addAttribute("stamp", fastDateFormat.format(publishedItem.getCreationDate()));
// Send the event notification to the subscriber
service.sendNotification(node, notification, jid);
}
/**
* Returns true if the specified user is allowed to modify or cancel the subscription. Users
* that are allowed to modify/cancel the subscription are: the entity that is recieving the
* notifications, the owner of the subscriptions or sysadmins of the pubsub service.
*
* @param user the user that is trying to cancel the subscription.
* @return true if the specified user is allowed to modify or cancel the subscription.
*/
boolean canModify(JID user) {
return user.equals(getJID()) || user.equals(getOwner()) || service.isServiceAdmin(user);
}
/**
* Returns the {@link NodeAffiliate} that owns this subscription. Users that have a
* subscription with the node will ALWAYS have an affiliation even if the
* affiliation is of type <tt>none</tt>.
*
* @return the NodeAffiliate that owns this subscription.
*/
public NodeAffiliate getAffiliate() {
return node.getAffiliate(getOwner());
}
public String toString() {
return super.toString() + " - JID: " + getJID() + " - State: " + getState().name();
}
/**
* Subscriptions to a node may exist in several states. Delivery of event notifications
* varies according to the subscription state of the user with the node.
*/
public static enum State {
/**
* The node will never send event notifications or payloads to users in this state. Users
* with subscription state none and affiliation none are going to be deleted.
*/
none,
/**
* An entity has requested to subscribe to a node and the request has not yet been
* approved by a node owner. The node will not send event notifications or payloads
* to the entity while it is in this state.
*/
pending,
/**
* An entity has subscribed but its subscription options have not yet been configured.
* The node will send event notifications or payloads to the entity while it is in this
* state. Default subscription configuration is going to be assumed.
*/
unconfigured,
/**
* An entity is subscribed to a node. The node will send all event notifications
* (and, if configured, payloads) to the entity while it is in this state.
*/
subscribed;
}
public static enum Type {
/**
* Receive notification of new items only.
*/
items,
/**
* Receive notification of new nodes only.
*/
nodes;
}
}