-
Notifications
You must be signed in to change notification settings - Fork 6
/
TNPubSubNode.j
904 lines (750 loc) · 33.3 KB
/
TNPubSubNode.j
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
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
/*
* TNPubSubNode.j
*
* Copyright (C) 2010 Antoine Mercadal <antoine.mercadal@inframonde.eu>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3.0 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
@import <Foundation/Foundation.j>
@import <Foundation/CPNotificationCenter.j>
@import "../Resources/Strophe/strophe.js"
@import "../Resources/Strophe/sha1.js"
@import "../TNStropheConnection.j"
@import "../TNStropheStanza.j"
@class TNStrophePubSubSubscriptionsRetrievedNotification
TNStrophePubSubVarAccessModel = @"pubsub#access_model";
TNStrophePubSubVarBodyXSLT = @"pubsub#body_xslt";
TNStrophePubSubVarDeliverNotification = @"pubsub#deliver_notifications";
TNStrophePubSubVarDeliverPayloads = @"pubsub#deliver_payloads";
TNStrophePubSubVarItemExpire = @"pubsub#item_expire";
TNStrophePubSubVarMaxItems = @"pubsub#max_items";
TNStrophePubSubVarMaxPayloadSize = @"pubsub#max_payload_size";
TNStrophePubSubVarNotificationType = @"pubsub#notification_type";
TNStrophePubSubVarNotifyConfig = @"pubsub#notify_config";
TNStrophePubSubVarNotifyDelete = @"pubsub#notify_delete";
TNStrophePubSubVarNotifyRectract = @"pubsub#notify_retract";
TNStrophePubSubVarNotifySub = @"pubsub#notify_sub";
TNStrophePubSubVarPersistItems = @"pubsub#persist_items";
TNStrophePubSubVarPresenceBasedDelivery = @"pubsub#presence_based_delivery";
TNStrophePubSubVarPublishModel = @"pubsub#publish_model";
TNStrophePubSubVarPurgeOffline = @"pubsub#purge_offline";
TNStrophePubSubVarRosterGroupAllowed = @"pubsub#roster_groups_allowed";
TNStrophePubSubVarSendLastPublishedItem = @"pubsub#send_last_published_item";
TNStrophePubSubVarTitle = @"pubsub#title";
TNStrophePubSubVarType = @"pubsub#type";
TNStrophePubSubVarAccessModelAuthorize = @"authorize";
TNStrophePubSubVarAccessModelOpen = @"open";
TNStrophePubSubVarAccessModelRoster = @"roster";
TNStrophePubSubVarAccessModelWhitelist = @"whitelist";
TNPubSubNodeAffiliationMember = @"member";
TNPubSubNodeAffiliationNone = @"none";
TNPubSubNodeAffiliationOutcast = @"outcast";
TNPubSubNodeAffiliationOwner = @"owner";
TNPubSubNodeAffiliationPublisher = @"publisher";
TNPubSubNodeAffiliationPublisherOnly = @"publish-only";
TNStrophePubSubItemPublishedNotification = @"TNStrophePubSubItemPublishedNotification";
TNStrophePubSubItemPublishErrorNotification = @"TNStrophePubSubItemPublishErrorNotification";
TNStrophePubSubItemRetractedNotification = @"TNStrophePubSubItemRetractedNotification";
TNStrophePubSubItemRetractErrorNotification = @"TNStrophePubSubItemRetractErrorNotification";
TNStrophePubSubNodeConfiguredNotification = @"TNStrophePubSubNodeConfiguredNotification";
TNStrophePubSubNodeCreatedNotification = @"TNStrophePubSubNodeCreatedNotification";
TNStrophePubSubNodeDeletedNotification = @"TNStrophePubSubNodeDeletedNotification";
TNStrophePubSubNodeEventNotification = @"TNStrophePubSubNodeEventNotification"
TNStrophePubSubNodeRetrievedNotification = @"TNStrophePubSubNodeRetrievedNotification";
TNStrophePubSubNodeSubscribedNotification = @"TNStrophePubSubNodeSubscribedNotification";
TNStrophePubSubNodeUnsubscribedNotification = @"TNStrophePubSubNodeUnsubscribedNotification";
// TODO: Abstract out subscription related stuff into TNPubSubNodeSubscription in order to handle multiple node subscriptions better
/*! @ingroup strophecappuccino
this is an implementation of a XMPP Publish-Subscribe node
*/
@implementation TNPubSubNode : CPObject
{
CPArray _content @accessors(getter=content);
CPArray _subscriptionIDs @accessors(getter=subscriptionIDs);
CPDictionary _affiliations @accessors(getter=affiliations);
CPString _nodeName @accessors(getter=name);
id _delegate @accessors(property=delegate);
TNStopheJID _pubSubServer @accessors(getter=server);
id _eventSelectorID;
TNStropheConnection _connection;
}
#pragma mark -
#pragma mark Class methods
/*! Register given selector of given object. When any pubsub event event is received, trigger the selector
@param aSelector the selector
@param anObject the object to use
@param aConnection a valid connected TNStropheConnection
@return int the id of the registration.
*/
+ (void)registerSelector:(SEL)aSelector ofObject:(id)anObject forPubSubEventWithConnection:(TNStropheConnection)aConnection
{
var params = [CPDictionary dictionaryWithObjectsAndKeys:@"message", @"name",
@"headline", @"type",
{"matchBare": YES}, @"options",
Strophe.NS.PUBSUB_EVENT, @"namespace"];
return [aConnection registerSelector:aSelector ofObject:anObject withDict:params];
}
#pragma mark -
#pragma mark Initialization
/*! create and initialize and return a new TNPubSubNode
@param aNodeName the name of the pubsub node
@param aConnection the TNStropheConnection to use to communicate
@param aPubSubServer a pubsubserver. if nil, it will be pubsub. + domain of [_connection JID]
@return initialized TNPubSubNode
*/
+ (TNPubSubNode)pubSubNodeWithNodeName:(CPString)aNodeName connection:(TNStropheConnection)aConnection pubSubServer:(CPString)aPubSubServer
{
return [[TNPubSubNode alloc] initWithNodeName:aNodeName connection:aConnection pubSubServer:aPubSubServer];
}
/*! initialize and return a new TNPubSubNode
@param aNodeName the name of the pubsub node
@param aConnection the TNStropheConnection to use to communicate
@param aPubSubServer a pubsubserver. if nil, it will be pubsub. + domain of [_connection JID]
@return initialized TNPubSubNode
*/
- (TNPubSubNode)initWithNodeName:(CPString)aNodeName connection:(TNStropheConnection)aConnection pubSubServer:(TNStropheJID)aPubSubServer
{
if (self = [super init])
{
_nodeName = aNodeName;
_connection = aConnection;
_pubSubServer = aPubSubServer ? aPubSubServer : [TNStropheJID stropheJIDWithString:@"pubsub." + [[_connection JID] domain]];
_subscriptionIDs = [CPArray array];
_affiliations = [CPDictionary dictionary];
[self _setEventHandler];
}
return self;
}
/*! create and initialize and return a new TNPubSubNode
@param aNodeName the name of the pubsub node
@param aConnection the TNStropheConnection to use to communicate
@param aPubSubServer a pubsubserver. if nil, it will be pubsub. + domain of [_connection JID]
@param aSubscriptionIDs array of the subsciption IDs if already subscribed
@return initialized TNPubSubNode
*/
+ (TNPubSubNode)pubSubNodeWithNodeName:(CPString)aNodeName connection:(TNStropheConnection)aConnection pubSubServer:(TNStropheJID)aPubSubServer subscriptionIDs:(CPArray)aSubscriptionIDs
{
return [[TNPubSubNode alloc] initWithNodeName:aNodeName connection:aConnection pubSubServer:aPubSubServer subscriptionIDs:aSubscriptionIDs];
}
/*! initialize and return a new TNPubSubNode
@param aNodeName the name of the pubsub node
@param aConnection the TNStropheConnection to use to communicate
@param aPubSubServer a pubsubserver. if nil, it will be pubsub. + domain of [_connection JID]
@param aSubscriptionIDs array of the subsciption IDs if already subscribed
@return initialized TNPubSubNode
*/
- (TNPubSubNode)initWithNodeName:(CPString)aNodeName connection:(TNStropheConnection)aConnection pubSubServer:(CPString)aPubSubServer subscriptionIDs:(CPArray)aSubscriptionIDs
{
if (self = [self initWithNodeName:aNodeName connection:aConnection pubSubServer:aPubSubServer])
{
_subscriptionIDs = aSubscriptionIDs;
}
return self;
}
#pragma mark -
#pragma mark Node Management
/*! retrieve the content of the PubSub node from the server and call _didRetrievePubSubNode selector
You should use this method to get past content
*/
- (void)retrieveItems
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iq],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid, @"id"];
[stanza setTo:_pubSubServer];
[stanza setType:@"get"];
[stanza setID:uid];
[stanza addChildWithName:@"pubsub" andAttributes:{@"xmlns": Strophe.NS.PUBSUB}];
[stanza addChildWithName:@"items" andAttributes:{@"node": _nodeName}];
[_connection registerSelector:@selector(_didRetrievePubSubNode:) ofObject:self withDict:params];
[_connection send:stanza];
}
/*! send TNStrophePubSubNodeRetrievedNotification if everything is ok
@param aStanza TNStropheStanza contaning the response of the server
@return NO in order to unregister the selector from connection
*/
- (BOOL)_didRetrievePubSubNode:(TNStropheStanza)aStanza
{
if ([aStanza type] == @"result")
{
_content = [aStanza childrenWithName:@"item"];
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubNodeRetrievedNotification object:self];
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:retrievedItems:)])
[_delegate pubSubNode:self retrievedItems:YES];
}
else
{
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:retrievedItems:)])
[_delegate pubSubNode:self retrievedItems:NO];
CPLog.error("Cannot retrieve the contents of pubsub node");
CPLog.error(aStanza);
}
return NO;
}
/*! ask server to create the pubsub node and call _didCreatePubSubNode selector
*/
- (void)create
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iq],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid, @"id"];
[stanza setTo:_pubSubServer];
[stanza setType:@"set"];
[stanza setID:uid];
[stanza addChildWithName:@"pubsub" andAttributes:{@"xmlns": Strophe.NS.PUBSUB}];
[stanza addChildWithName:@"create" andAttributes:{@"node": _nodeName}];
[_connection registerSelector:@selector(_didCreatePubSubNode:) ofObject:self withDict:params];
[_connection send:stanza];
}
/*! send TNStrophePubSubNodeCreatedNotification if everything is OK
@param aStanza TNStropheStanza contaning the response of the server
@return NO in order to unregister the selector from connection
*/
- (BOOL)_didCreatePubSubNode:(TNStropheStanza)aStanza
{
if ([aStanza type] == @"result")
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubNodeCreatedNotification object:self];
else
{
CPLog.error("Cannot create the pubsub node");
CPLog.error(aStanza);
}
return NO;
}
/*! ask the server to delete the pubsub node
*/
- (void)delete
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iq],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid, @"id"];
[stanza setTo:_pubSubServer];
[stanza setType:@"set"];
[stanza setID:uid];
[stanza addChildWithName:@"pubsub" andAttributes:{@"xmlns": Strophe.NS.PUBSUB_OWNER}];
[stanza addChildWithName:@"delete" andAttributes:{@"node": _nodeName}];
[_connection registerSelector:@selector(didDeletePubSubNode:) ofObject:self withDict:params];
[_connection send:stanza];
}
/*! send TNStrophePubSubNodeDeleted if everything is OK
@param aStanza TNStropheStanza contaning the response of the server
@return NO in order to unregister the selector from connection
*/
- (BOOL)_didCreatePubSubNode:(TNStropheStanza)aStanza
{
if ([aStanza type] == @"result")
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubNodeDeletedNotification object:self];
else
{
CPLog.error("Cannot delete the pubsub node");
CPLog.error(aStanza);
}
return NO;
}
/*! configure the pubsub node with given directory. This dictionary can be for example
[CPDictionary dictionaryWithObjectsAndKeys:1, TNStrophePubSubVarDeliverNotification,
10, TNStrophePubSubVarMaxItems,
0, TNStrophePubSubVarPurgeOffline];
See XEP-0060 for more information about configuring a PubSubNode.
@param aDictionary CPDictionary containing the configuration of the node
*/
- (void)configureWithDict:(CPDictionary)aDictionary
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iq],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid, @"id"];
[stanza setTo:_pubSubServer];
[stanza setType:@"set"];
[stanza setID:uid];
[stanza addChildWithName:@"pubsub" andAttributes:{@"xmlns": Strophe.NS.PUBSUB_OWNER}];
[stanza addChildWithName:@"configure" andAttributes:{@"node": _nodeName}];
[stanza addChildWithName:@"x" andAttributes:{@"xmlns": "jabber:x:data", @"type": @"submit"}];
[stanza addChildWithName:@"field" andAttributes:{@"var": @"FORM_TYPE", @"type": @"hidden"}];
[stanza addChildWithName:@"value"];
[stanza addTextNode:Strophe.NS.PUBSUB_NODE_CONFIG];
[stanza up];
[stanza up];
for (var i = 0; i < [[aDictionary allKeys] count]; i++)
{
var key = [[aDictionary allKeys] objectAtIndex:i],
value = [aDictionary objectForKey:key];
[stanza addChildWithName:@"field" andAttributes:{@"var": key}];
if ([value isKindOfClass:CPArray])
{
for (var j = 0; j < [value count]; j++)
{
[stanza addChildWithName:@"value"];
[stanza addTextNode:@"" + [value objectAtIndex:j] + @""];
[stanza up];
}
}
else
{
[stanza addChildWithName:@"value"];
[stanza addTextNode:@"" + value + @""];
[stanza up];
}
[stanza up];
}
[_connection registerSelector:@selector(_didConfigurePubSubNode:) ofObject:self withDict:params];
[_connection send:stanza];
}
/*! send TNStrophePubSubNodeConfiguredNotification if everything is OK
@param aStanza TNStropheStanza contaning the response of the server
@return NO in order to unregister the selector from connection
*/
- (BOOL)_didConfigurePubSubNode:(TNStropheStanza)aStanza
{
if ([aStanza type] == @"result")
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubNodeConfiguredNotification object:self];
else
{
CPLog.error("Cannot configure the pubsub node");
CPLog.error(aStanza);
}
return NO;
}
#pragma mark -
#pragma mark Item management
/*! Ask the server to publish a new item containing the content of the given TNXMLNode
@params anItem TNXMLNode containing the content of the item
*/
- (void)publishItem:(TNXMLNode)anItem
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iq],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid, @"id"];
[stanza setTo:_pubSubServer];
[stanza setType:@"set"];
[stanza setID:uid];
[stanza addChildWithName:@"pubsub" andAttributes:{@"xmlns": Strophe.NS.PUBSUB}];
[stanza addChildWithName:@"publish" andAttributes:{@"node": _nodeName}];
[stanza addChildWithName:@"item"];
[stanza addNode:anItem];
[_connection registerSelector:@selector(_didPublishPubSubItem:) ofObject:self withDict:params];
[_connection send:stanza];
}
/*! will recover the content of node if everything is OK
@param aStanza TNStropheStanza contaning the response of the server
@return NO in order to unregister the selector from connection
*/
- (BOOL)_didPublishPubSubItem:(TNStropheStanza)aStanza
{
if ([aStanza type] == @"result")
{
[[CPNotificationCenter defaultCenter] addObserver:self selector:@selector(_didUpdateContentAfterPublishing:) name:TNStrophePubSubNodeRetrievedNotification object:self];
[self retrieveItems];
}
else
{
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubItemPublishErrorNotification object:self userInfo:aStanza];
CPLog.error("Cannot publish the pubsub item in node");
CPLog.error(aStanza);
}
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:publishedItem:)])
[_delegate pubSubNode:self publishedItem:aStanza];
return NO;
}
/*! send TNStrophePubSubItemPublishedNotification if everything is OK
@param aNotification CPNotification given by [TNPubSubNode recover]
*/
- (void)_didUpdateContentAfterPublishing:(CPNotification)aNotification
{
[[CPNotificationCenter defaultCenter] removeObserver:self name:TNStrophePubSubNodeRetrievedNotification object:self];
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubItemPublishedNotification object:self];
}
/*! Ask the server to retract (remove) a node
@params aNode the node to remove
*/
- (void)retractItem:(TNXMLNode)aNode
{
[self retractItemWithID:[aNode valueForAttribute:@"id"]];
}
/*! Ask the server to retract (remove) a new item according to the given ID
@params anID CPString containing the ID of the item to retract
*/
- (void)retractItemWithID:(CPString)anID
{
[self retractItemsWithIDs:[anID]];
}
- (void)retractItemsWithIDs:(CPArray)someIDs
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iq],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid, @"id"];
[stanza setTo:_pubSubServer];
[stanza setType:@"set"];
[stanza setID:uid];
[stanza addChildWithName:@"pubsub" andAttributes:{@"xmlns": Strophe.NS.PUBSUB}];
for (var i = 0; i < [someIDs count]; i++)
{
[stanza addChildWithName:@"retract" andAttributes:{@"node": _nodeName}];
[stanza addChildWithName:@"item" andAttributes:{@"id": [someIDs objectAtIndex:i]}];
[stanza up];
[stanza up];
}
[_connection registerSelector:@selector(_didRetractPubSubItems:) ofObject:self withDict:params];
[_connection send:stanza];
}
/*! will recover the content of node if everything is OK
@param aStanza TNStropheStanza contaning the response of the server
@return NO in order to unregister the selector from connection
*/
- (BOOL)_didRetractPubSubItems:(TNStropheStanza)aStanza
{
if ([aStanza type] == @"result")
{
[[CPNotificationCenter defaultCenter] addObserver:self selector:@selector(_didUpdateContentAfterRetracting:) name:TNStrophePubSubNodeRetrievedNotification object:self];
[self retrieveItems];
}
else
{
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubItemRetractErrorNotification object:self userInfo:aStanza];
CPLog.error("Cannot remove the pubsub items from node");
CPLog.error(aStanza);
}
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:retractedItem:)])
[_delegate pubSubNode:self retractedItem:aStanza];
return NO;
}
/*! send TNStrophePubSubItemRetractedNotification if everything is OK
@param aNotification CPNotification given by [TNPubSubNode recover]
*/
- (void)_didUpdateContentAfterRetracting:(CPNotification)aNotification
{
[[CPNotificationCenter defaultCenter] removeObserver:self name:TNStrophePubSubNodeRetrievedNotification object:self];
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubItemRetractedNotification object:self];
}
#pragma mark -
#pragma mark Subscription Management
/*! retrieve all the subscription of the user
from all given servers
*/
- (void)recoverSubscriptions
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iqWithAttributes:{"type": "get", "to": _pubSubServer, "id": uid}],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid,@"id"];
[stanza addChildWithName:@"pubsub" andAttributes:{"xmlns": Strophe.NS.PUBSUB}];
[stanza addChildWithName:@"subscriptions" andAttributes:{"node": _nodeName}];
[_connection registerSelector:@selector(_didRetrieveSubscriptions:) ofObject:self withDict:params];
[_connection send:stanza];
}
/*! @ignore
*/
- (BOOL)_didRetrieveSubscriptions:(TNStropheStanza)aStanza
{
if ([aStanza type] == @"result")
{
var subscriptions = [aStanza childrenWithName:@"subscription"];
for (var i = 0; i < [subscriptions count]; i++)
{
var subscription = [subscriptions objectAtIndex:i],
nodeName = [subscription valueForAttribute:@"node"],
subid = [subscription valueForAttribute:@"subid"];
[self addSubscriptionID:subid];
}
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubSubscriptionsRetrievedNotification object:self];
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:retrievedSubscriptions:)])
[_delegate pubSubNode:self retrievedSubscriptions:YES];
}
else
{
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:retrievedSubscriptions:)])
[_delegate pubSubNode:self retrievedSubscriptions:NO];
}
return NO;
}
/*! Ask the server to subscribe to the node in order to recieve events
*/
- (void)subscribe
{
[self subscribeWithOptions:nil];
}
/*! Ask the server to subscribe to the node in order to recieve events
@param options key value pairs of subscription options
*/
- (void)subscribeWithOptions:(CPDictionary)options
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iq],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid, @"id"];
[stanza setType:@"set"];
[stanza setID:uid];
[stanza setTo:_pubSubServer];
[stanza addChildWithName:@"pubsub" andAttributes:{@"xmlns": Strophe.NS.PUBSUB}];
[stanza addChildWithName:@"subscribe" andAttributes:{@"node": _nodeName, @"jid": [[_connection JID] bare]}];
if (options && [options count] > 0)
{
[stanza up];
[stanza addChildWithName:@"options"];
[stanza addChildWithName:@"x" andAttributes:{"xmlns":Strophe.NS.X_DATA, "type":"submit"}];
[stanza addChildWithName:@"field" andAttributes:{"var":"FORM_TYPE", "type":"hidden"}];
[stanza addChildWithName:@"value"];
[stanza addTextNode:Strophe.NS.PUBSUB_SUBSCRIBE_OPTIONS];
[stanza up];
[stanza up];
var keys = [options allKeys];
for (var i = 0; i < [keys count]; i++)
{
var key = [keys objectAtIndex:i],
value = [options valueForKey:key];
[stanza addChildWithName:@"field" andAttributes:{"var":key}];
[stanza addChildWithName:@"value"];
[stanza addTextNode:value];
[stanza up];
[stanza up];
}
}
[_connection registerSelector:@selector(_didSubscribe:) ofObject:self withDict:params]
[_connection send:stanza];
}
/*! send TNStrophePubSubNodeSubscribedNotification if everything is OK and register __didReceiveEvent:
that will eventually call the delegate selector pubsubNode:receivedEvent: when an event is recieved
@param aStanza TNStropheStanza contaning the response of the server
@return NO in order to unregister the selector from connection
*/
- (BOOL)_didSubscribe:(TNStropheStanza)aStanza
{
if ([aStanza type] == @"result")
{
var subscription = [aStanza firstChildWithName:@"subscription"],
subID = [subscription valueForAttribute:@"subid"],
status = [subscription valueForAttribute:@"subscription"];
if ([subID length] > 0)
[_subscriptionIDs addObject:subID];
if (status === @"subscribed")
{
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubNodeSubscribedNotification object:self];
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:subscribed:)])
[_delegate pubSubNode:self subscribed:YES];
}
[self _setEventHandler];
}
else
{
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:subscribed:)])
[_delegate pubSubNode:self subscribed:NO];
CPLog.error("Cannot subscribe the pubsub node");
CPLog.error(aStanza);
}
return NO;
}
- (void)addSubscriptionID:(CPString)aSubscriptionID
{
[_subscriptionIDs addObject:aSubscriptionID];
}
/*! Ask the server to unsubscribe from the node in order to no longer recieve events
@param aSubID string representing the specific subscription ID to unsubscribe
*/
- (void)unsubscribeWithSubID:(CPString)aSubID
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iq],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid, @"id"];
[stanza setType:@"set"];
[stanza setID:uid];
[stanza setTo:_pubSubServer];
[stanza addChildWithName:@"pubsub" andAttributes:{"xmlns": Strophe.NS.PUBSUB}];
[stanza addChildWithName:@"unsubscribe" andAttributes:{"node": _nodeName, "jid": [[_connection JID] bare]}];
if (aSubID)
[stanza setValue:aSubID forAttribute:@"subid"];
[_connection registerSelector:@selector(_didUnsubscribe:) ofObject:self withDict:params];
[_connection send:stanza];
}
/*! Remove all known subscriptions
*/
- (void)unsubscribe
{
if ([_subscriptionIDs count] > 0)
{
// Unsubscribe from node for each subscription ID
for (var i = 0; i < [_subscriptionIDs count]; i++)
{
[self unsubscribeWithSubID:[_subscriptionIDs objectAtIndex:i]];
}
}
else
{
// There are no registered subscription IDs - send plain unsubscribe
[self unsubscribeWithSubID:nil];
}
}
/*! send TNStrophePubSubNodeUnsubscribedNotification if everything is OK and unregister __didReceiveEvent:
@param aStanza TNStropheStanza contaning the response of the server
@return NO in order to unregister the selector from connection
*/
- (BOOL)_didUnsubscribe:(TNStropheStanza)aStanza
{
if ([aStanza type] == @"result")
{
var params = [CPDictionary dictionary],
subID = [[[aStanza firstChildWithName:@"pubsub"] firstChildWithName:@"subscription"] valueForAttribute:@"subid"];
if ([subID length] > 0)
{
[_subscriptionIDs removeObject:subID];
[params setObject:subID forKey:@"subscriptionID"];
}
else if ([_subscriptionIDs count] === 1)
{
// TODO: Need to establish if subscription id is ever included in unsubscribe confirmation or if this association needs to be made by IQ id
[_subscriptionIDs removeAllObjects];
}
if ([_subscriptionIDs count] === 0)
{
// No subscriptions remaining
if (_eventSelectorID)
{
[_connection deleteRegisteredSelector:_eventSelectorID];
_eventSelectorID = nil;
}
}
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubNodeUnsubscribedNotification object:self userInfo:params];
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:unsubscribed:)])
[_delegate pubSubNode:self unsubscribed:YES];
}
else
{
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:unsubscribed:)])
[_delegate pubSubNode:self unsubscribed:NO];
CPLog.error("Cannot unsubscribe the pubsub node");
CPLog.error(aStanza);
}
return NO;
}
- (int)numberOfSubscriptions
{
return [_subscriptionIDs count];
}
#pragma mark -
#pragma mark Affiliation Management
/*! Retrieve the node affiliations
When done, call delegate method pubSubNode:retrievedAffiliations:
*/
- (void)retrieveAffiliations
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iq],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid, @"id"];
[stanza setTo:_pubSubServer];
[stanza setType:@"get"];
[stanza setID:uid];
[stanza addChildWithName:@"pubsub" andAttributes:{@"xmlns": Strophe.NS.PUBSUB_OWNER}];
[stanza addChildWithName:@"affiliations" andAttributes:{@"node": _nodeName}];
[_connection registerSelector:@selector(_didRetrieveAffiliations:) ofObject:self withDict:params];
[_connection send:stanza];
}
/*! @ignore
*/
- (void)_didRetrieveAffiliations:(TNStropheStanza)aStanza
{
if ([aStanza type] == @"result")
{
var affiliations = [aStanza childrenWithName:@"affiliation"];
for (var i = 0; i < [affiliations count]; i++)
{
var affiliation = [affiliations objectAtIndex:i];
[_affiliations setObject:[affiliation valueForAttribute:@"affiliation"] forKey:[TNStropheJID stropheJIDWithString:[affiliation valueForAttribute:@"jid"]]];
}
}
else
{
CPLog.error("Cannot get affiliations");
CPLog.error(aStanza);
}
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:retrievedAffiliations:)])
[_delegate pubSubNode:self retrievedAffiliations:aStanza];
return NO;
}
/*! Change an affilation for a given JID
When done, call delegate method pubSubNode:changedAffiliations:
@param anAffiliation the affilition to set
@param aJID target TNStropheJID for the affilition
*/
- (void)changeAffiliation:(CPString)anAffiliation forJID:(TNStropheJID)aJID
{
var uid = [_connection getUniqueId],
stanza = [TNStropheStanza iq],
params = [CPDictionary dictionaryWithObjectsAndKeys:uid, @"id"];
[stanza setTo:_pubSubServer];
[stanza setType:@"set"];
[stanza setID:uid];
[stanza addChildWithName:@"pubsub" andAttributes:{@"xmlns": Strophe.NS.PUBSUB_OWNER}];
[stanza addChildWithName:@"affiliations" andAttributes:{@"node": _nodeName}];
[stanza addChildWithName:@"affiliation" andAttributes:{@"jid": [aJID bare], @"affiliation": anAffiliation}];
var affiliationInformations = [CPDictionary dictionaryWithObjectsAndKeys: [aJID bare], @"jid",
anAffiliation, @"affiliation"];
[_connection registerSelector:@selector(_didChangeAffiliations:userInfo:) ofObject:self withDict:params userInfo:affiliationInformations];
[_connection send:stanza];
}
/*! ignore
*/
- (void)_didChangeAffiliations:(TNStropheStanza)aStanza userInfo:(CPDictionary)newAffiliation
{
if ([aStanza type] == @"result")
{
[_affiliations setObject:[newAffiliation objectForKey:@"affiliation"] forKey:[newAffiliation objectForKey:@"jid"]];
[self retrieveAffiliations];
}
else
{
CPLog.error("Cannot change affiliations");
CPLog.error(aStanza);
}
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:changedAffiliations:)])
[_delegate pubSubNode:self changedAffiliations:aStanza];
return NO;
}
#pragma mark -
#pragma mark Event Management
- (void)_setEventHandler
{
var params = [CPDictionary dictionaryWithObjectsAndKeys:@"message", @"name",
[_pubSubServer node], @"from"];
if (_eventSelectorID)
[_connection deleteRegisteredSelector:_eventSelectorID];
_eventSelectorID = [_connection registerSelector:@selector(_didReceiveEvent:) ofObject:self withDict:params];
}
/*! this message is send when a new pubsub event is recieved. It will call the delegate
pubsubNode:receivedEvent: if any selector and send TNStrophePubSubNodeEventNotification notification
@param aStanza TNStropheStanza contaning the response of the server
@return YES in order to keep the selector registered
*/
- (BOOL)_didReceiveEvent:(TNStropheStanza)aStanza
{
var pubsubEvent = [aStanza firstChildWithName:@"event"];
if ([pubsubEvent namespace] != Strophe.NS.PUBSUB_EVENT)
return YES;
if ([pubsubEvent containsChildrenWithName:@"subscription"])
{
var subscription = [pubsubEvent firstChildWithName:@"subscription"],
status = [subscription valueForAttribute:@"subscription"],
nodeName = [subscription valueForAttribute:@"node"];
if (status === @"subscribed" && nodeName === _nodeName)
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubNodeSubscribedNotification object:self];
return YES;
}
if (_nodeName != [[pubsubEvent firstChildWithName:@"items"] valueForAttribute:@"node"])
return YES;
if (_delegate && [_delegate respondsToSelector:@selector(pubSubNode:receivedEvent:)])
[_delegate pubSubNode:self receivedEvent:aStanza];
[[CPNotificationCenter defaultCenter] postNotificationName:TNStrophePubSubNodeEventNotification object:self userInfo:aStanza];
return YES;
}
- (CPString)description
{
return _nodeName;
}
@end