XMPPPrivacy.m 24.6 KB
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 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
#import "XMPP.h"
#import "XMPPLogging.h"
#import "XMPPPrivacy.h"
#import "NSNumber+XMPP.h"

// Log levels: off, error, warn, info, verbose
// Log flags: trace
#ifdef DEBUG
  static const int xmppLogLevel = XMPP_LOG_LEVEL_VERBOSE; // | XMPP_LOG_FLAG_TRACE;
#else
  static const int xmppLogLevel = XMPP_LOG_LEVEL_WARN;
#endif

#define QUERY_TIMEOUT 30.0 // NSTimeInterval (double) = seconds

NSString *const XMPPPrivacyErrorDomain = @"XMPPPrivacyErrorDomain";

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark -
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

typedef enum XMPPPrivacyQueryInfoType {
	FetchList,
	FetchRules,
	EditList,
	SetActiveList,
	SetDefaultList
	
} XMPPPrivacyQueryInfoType;

@interface XMPPPrivacyQueryInfo : NSObject
{
	XMPPPrivacyQueryInfoType type;
	NSString *privacyListName;
	NSArray *privacyListItems;
	
	dispatch_source_t timer;
}

@property (nonatomic, readonly) XMPPPrivacyQueryInfoType type;
@property (nonatomic, readonly) NSString *privacyListName;
@property (nonatomic, readonly) NSArray *privacyListItems;

@property (nonatomic, readwrite) dispatch_source_t timer;

- (void)cancel;

+ (XMPPPrivacyQueryInfo *)queryInfoWithType:(XMPPPrivacyQueryInfoType)type;
+ (XMPPPrivacyQueryInfo *)queryInfoWithType:(XMPPPrivacyQueryInfoType)type name:(NSString *)name;
+ (XMPPPrivacyQueryInfo *)queryInfoWithType:(XMPPPrivacyQueryInfoType)type name:(NSString *)name items:(NSArray *)items;

@end

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark -
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

@interface XMPPPrivacy (/* Must be nameless for properties */)

- (void)addQueryInfo:(XMPPPrivacyQueryInfo *)qi withKey:(NSString *)uuid;
- (void)queryTimeout:(NSString *)uuid;

@end

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark -
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

@implementation XMPPPrivacy

- (id)init
{
	return [self initWithDispatchQueue:NULL];
}

- (id)initWithDispatchQueue:(dispatch_queue_t)queue
{
	if ((self = [super initWithDispatchQueue:queue]))
	{
		autoRetrievePrivacyListNames = YES;
		autoRetrievePrivacyListItems = YES;
		autoClearPrivacyListInfo     = YES;
		
		privacyDict = [[NSMutableDictionary alloc] init];
		activeListName = nil;
		defaultListName = nil;
		
		pendingQueries = [[NSMutableDictionary alloc] init];
	}
	return self;
}

- (BOOL)activate:(XMPPStream *)aXmppStream
{
	if ([super activate:aXmppStream])
	{
		// Reserved for possible future use.
		
		return YES;
	}
	
	return NO;
}

- (void)deactivate
{
	// Reserved for possible future use.
	
	[super deactivate];
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Properties
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

- (BOOL)autoRetrievePrivacyListNames
{
	if (dispatch_get_specific(moduleQueueTag))
	{
		return autoRetrievePrivacyListNames;
	}
	else
	{
		__block BOOL result;
		
		dispatch_sync(moduleQueue, ^{
			result = autoRetrievePrivacyListNames;
		});
		
		return result;
	}
}

- (void)setAutoRetrievePrivacyListNames:(BOOL)flag
{
	dispatch_block_t block = ^{
		
		autoRetrievePrivacyListNames = flag;
	};
	
	if (dispatch_get_specific(moduleQueueTag))
		block();
	else
		dispatch_async(moduleQueue, block);
}

- (BOOL)autoRetrievePrivacyListItems
{
	if (dispatch_get_specific(moduleQueueTag))
	{
		return autoRetrievePrivacyListItems;
	}
	else
	{
		__block BOOL result;
		
		dispatch_sync(moduleQueue, ^{
			result = autoRetrievePrivacyListItems;
		});
		
		return result;
	}
}

- (void)setAutoRetrievePrivacyListItems:(BOOL)flag
{
	dispatch_block_t block = ^{
		
		autoRetrievePrivacyListItems = flag;
	};
	
	if (dispatch_get_specific(moduleQueueTag))
		block();
	else
		dispatch_async(moduleQueue, block);
}

- (BOOL)autoClearPrivacyListInfo
{
	if (dispatch_get_specific(moduleQueueTag))
	{
		return autoClearPrivacyListInfo;
	}
	else
	{
		__block BOOL result;
		
		dispatch_sync(moduleQueue, ^{
			result = autoClearPrivacyListInfo;
		});
		
		return result;
	}
}

- (void)setAutoClearPrivacyListInfo:(BOOL)flag
{
	dispatch_block_t block = ^{
		
		autoClearPrivacyListInfo = flag;
	};
	
	if (dispatch_get_specific(moduleQueueTag))
		block();
	else
		dispatch_async(moduleQueue, block);
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Public API
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

- (void)retrieveListNames
{
	XMPPLogTrace();
	
	// <iq type='get' id='abc123'>
	//   <query xmlns='jabber:iq:privacy'/>
	// </iq>
	
	NSXMLElement *query = [NSXMLElement elementWithName:@"query" xmlns:@"jabber:iq:privacy"];
	
	NSString *uuid = [xmppStream generateUUID];
	XMPPIQ *iq = [XMPPIQ iqWithType:@"get" to:nil elementID:uuid child:query];
	
	[xmppStream sendElement:iq];
	
	XMPPPrivacyQueryInfo *qi = [XMPPPrivacyQueryInfo queryInfoWithType:FetchList];
	[self addQueryInfo:qi withKey:uuid];
}

- (void)retrieveListWithName:(NSString *)privacyListName
{
	XMPPLogTrace();
	
	if (privacyListName == nil) return;
	
	// <iq type='get' id='abc123'>
	//   <query xmlns='jabber:iq:privacy'>
	//     <list name='public'/>
	//   </query>
	// </iq>
	
	NSXMLElement *list = [NSXMLElement elementWithName:@"list"];
	[list addAttributeWithName:@"name" stringValue:privacyListName];
	
	NSXMLElement *query = [NSXMLElement elementWithName:@"query" xmlns:@"jabber:iq:privacy"];
	[query addChild:list];
	
	NSString *uuid = [xmppStream generateUUID];
	XMPPIQ *iq = [XMPPIQ iqWithType:@"get" to:nil elementID:uuid child:query];
	
	[xmppStream sendElement:iq];
	
	XMPPPrivacyQueryInfo *qi = [XMPPPrivacyQueryInfo queryInfoWithType:FetchRules name:privacyListName];
	[self addQueryInfo:qi withKey:uuid];
}

- (void)clearPrivacyListInfo
{
	XMPPLogTrace();
	
	if (dispatch_get_specific(moduleQueueTag))
	{
		[privacyDict removeAllObjects];
	}
	else
	{
		dispatch_async(moduleQueue, ^{ @autoreleasepool {
			
			[privacyDict removeAllObjects];
		}});
	}
}

- (NSArray *)listNames
{
	if (dispatch_get_specific(moduleQueueTag))
	{
		return [privacyDict allKeys];
	}
	else
	{
		__block NSArray *result;
		
		dispatch_sync(moduleQueue, ^{ @autoreleasepool {
			
			result = [[privacyDict allKeys] copy];
		}});
		
		return result;
	}
}

- (NSArray *)listWithName:(NSString *)privacyListName
{
	NSArray* (^block)() = ^ NSArray* () {
		
		id result = privacyDict[privacyListName];
		
		if (result == [NSNull null]) // Not fetched yet
			return nil;
		else
			return (NSArray *)result;
	};
	
	// ExecuteVoidBlock(moduleQueue, block);
	// ExecuteNonVoidBlock(moduleQueue, block, NSArray*)
	
	if (dispatch_get_specific(moduleQueueTag))
	{
		return block();
	}
	else
	{
		__block NSArray *result;
		
		dispatch_sync(moduleQueue, ^{ @autoreleasepool {
			
			result = block();
		}});
		
		return result;
	}
}

- (NSString *)activeListName
{
	return activeListName;
}

- (NSArray *)activeList
{
	return [self listWithName:activeListName];
}

- (void)setActiveListName:(NSString *)privacyListName
{
	// Setting active list:
	// 
	// <iq type='set' id='active1'>
	//   <query xmlns='jabber:iq:privacy'>
	//     <active name='special'/>
	//   </query>
	// </iq>
	// 
	// Decline the use of active lists:
	// 
	// <iq type='set' id='active3'>
	//   <query xmlns='jabber:iq:privacy'>
	//     <active/>
	//   </query>
	// </iq>
	
	NSXMLElement *active = [NSXMLElement elementWithName:@"active"];
	if (privacyListName)
	{
		[active addAttributeWithName:@"name" stringValue:privacyListName];
	}
	
	NSXMLElement *query = [NSXMLElement elementWithName:@"query" xmlns:@"jabber:iq:privacy"];
	[query addChild:active];
	
	NSString *uuid = [xmppStream generateUUID];
	XMPPIQ *iq = [XMPPIQ iqWithType:@"set" to:nil elementID:uuid child:query];
	
	[xmppStream sendElement:iq];
	
	XMPPPrivacyQueryInfo *qi = [XMPPPrivacyQueryInfo queryInfoWithType:SetActiveList name:privacyListName];
	[self addQueryInfo:qi withKey:uuid];
}

- (NSString *)defaultListName
{
	return defaultListName;
}

- (NSArray *)defaultList
{
	return [self listWithName:defaultListName];
}

- (void)setDefaultListName:(NSString *)privacyListName
{
	// Setting default list:
	// 
	// <iq type='set' id='default1'>
	//   <query xmlns='jabber:iq:privacy'>
	//     <default name='special'/>
	//   </query>
	// </iq>
	// 
	// Decline the use of default list:
	// 
	// <iq type='set' id='default2'>
	//   <query xmlns='jabber:iq:privacy'>
	//     <default/>
	//   </query>
	// </iq>
	
	NSXMLElement *dfault = [NSXMLElement elementWithName:@"default"];
	if (privacyListName)
	{
		[dfault addAttributeWithName:@"name" stringValue:privacyListName];
	}
	
	NSXMLElement *query = [NSXMLElement elementWithName:@"query" xmlns:@"jabber:iq:privacy"];
	[query addChild:dfault];
	
	NSString *uuid = [xmppStream generateUUID];
	XMPPIQ *iq = [XMPPIQ iqWithType:@"set" to:nil elementID:uuid child:query];
	
	[xmppStream sendElement:iq];
	
	XMPPPrivacyQueryInfo *qi = [XMPPPrivacyQueryInfo queryInfoWithType:SetDefaultList name:privacyListName];
	[self addQueryInfo:qi withKey:uuid];
}

- (void)setListWithName:(NSString *)privacyListName items:(NSArray *)items
{
	// Edit a privacy list:
	// 
	// <iq type='set' id='edit1'>
	//   <query xmlns='jabber:iq:privacy'>
	//     <list name='public'>
	//       <item type='jid' value='tybalt@example.com' action='deny' order='3'/>
	//       <item type='jid' value='paris@example.org' action='deny' order='5'/>
	//       <item action='allow' order='68'/>
	//     </list>
	//   </query>
	// </iq>
	// 
	// 
	// Remove a privacy list:
	// 
	// <iq type='set' id='remove1'>
	//   <query xmlns='jabber:iq:privacy'>
	//     <list name='private'/>
	//   </query>
	// </iq>
	
	NSXMLElement *list = [NSXMLElement elementWithName:@"list"];
	[list addAttributeWithName:@"name" stringValue:privacyListName];
	
	if (items && ([items count] > 0))
	{
		[list setChildren:items];
	}
	
	NSXMLElement *query = [NSXMLElement elementWithName:@"query" xmlns:@"jabber:iq:privacy"];
	[query addChild:list];
	
	NSString *uuid = [xmppStream generateUUID];
	XMPPIQ *iq = [XMPPIQ iqWithType:@"set" to:nil elementID:uuid child:query];
	
	[xmppStream sendElement:iq];
	
	XMPPPrivacyQueryInfo *qi = [XMPPPrivacyQueryInfo queryInfoWithType:EditList name:privacyListName items:items];
	[self addQueryInfo:qi withKey:uuid];
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Query Processing
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

- (void)addQueryInfo:(XMPPPrivacyQueryInfo *)queryInfo withKey:(NSString *)uuid
{
	// Setup timer
	
	dispatch_source_t timer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, moduleQueue);
	
	dispatch_source_set_event_handler(timer, ^{ @autoreleasepool {
		
		[self queryTimeout:uuid];
	}});
	
	dispatch_time_t fireTime = dispatch_time(DISPATCH_TIME_NOW, (QUERY_TIMEOUT * NSEC_PER_SEC));
	
	dispatch_source_set_timer(timer, fireTime, DISPATCH_TIME_FOREVER, 1.0);
	dispatch_resume(timer);
	
	queryInfo.timer = timer;
	
	// Add to dictionary
	pendingQueries[uuid] = queryInfo;
}

- (void)removeQueryInfo:(XMPPPrivacyQueryInfo *)queryInfo withKey:(NSString *)uuid
{
	// Invalidate timer
	[queryInfo cancel];
	
	// Remove from dictionary
	[pendingQueries removeObjectForKey:uuid];
}

- (void)processQuery:(XMPPPrivacyQueryInfo *)queryInfo withFailureCode:(XMPPPrivacyErrorCode)errorCode
{
	NSError *error = [NSError errorWithDomain:XMPPPrivacyErrorDomain code:errorCode userInfo:nil];
	
	if (queryInfo.type == FetchList)
	{
		[multicastDelegate xmppPrivacy:self didNotReceiveListNamesDueToError:error];
	}
	else if (queryInfo.type == FetchRules)
	{
		[multicastDelegate xmppPrivacy:self didNotReceiveListWithName:queryInfo.privacyListName error:error];
	}
	else if (queryInfo.type == EditList)
	{
		[multicastDelegate xmppPrivacy:self didNotSetListWithName:queryInfo.privacyListName error:error];
	}
	else if (queryInfo.type == SetActiveList)
	{
		[multicastDelegate xmppPrivacy:self didNotSetActiveListName:queryInfo.privacyListName error:error];
	}
	else if (queryInfo.type == SetDefaultList)
	{
		[multicastDelegate xmppPrivacy:self didNotSetDefaultListName:queryInfo.privacyListName error:error];
	}
}

- (void)queryTimeout:(NSString *)uuid
{
	XMPPPrivacyQueryInfo *queryInfo = privacyDict[uuid];
	if (queryInfo)
	{
		[self processQuery:queryInfo withFailureCode:XMPPPrivacyQueryTimeout];
		[self removeQueryInfo:queryInfo withKey:uuid];
	}
}

NSInteger sortItems(id itemOne, id itemTwo, void *context)
{
	NSXMLElement *item1 = (NSXMLElement *)itemOne;
	NSXMLElement *item2 = (NSXMLElement *)itemTwo;
	
	NSString *orderStr1 = [item1 attributeStringValueForName:@"order"];
	NSString *orderStr2 = [item2 attributeStringValueForName:@"order"];
	
	NSUInteger order1;
	BOOL parse1 = [NSNumber xmpp_parseString:orderStr1 intoNSUInteger:&order1];
	
	NSUInteger order2;
	BOOL parse2 = [NSNumber xmpp_parseString:orderStr2 intoNSUInteger:&order2];
	
	if (parse1)
	{
		if (parse2)
		{
			// item1 = valid
			// item2 = valid
			
			if (order1 < order2)
				return NSOrderedAscending;
			if (order1 > order2)
				return NSOrderedDescending;
			
			return NSOrderedSame;
		}
		else
		{
			// item1 = valid
			// item2 = invalid
			
			return NSOrderedAscending;
		}
	}
	else if (parse2)
	{
		// item1 = invalid
		// item2 = valid
		
		return NSOrderedDescending;
	}
	else
	{
		// item1 = invalid
		// item2 = invalid
		
		return NSOrderedSame;
	}
}

- (void)processQueryResponse:(XMPPIQ *)iq withInfo:(XMPPPrivacyQueryInfo *)queryInfo
{
	if (queryInfo.type == FetchList)
	{
		// Privacy List Names Query Response:
		// 
		// <iq type='result' id='getlist1'>
		//   <query xmlns='jabber:iq:privacy'>
		//     <active name='private'/>
		//     <default name='public'/>
		//     <list name='public'/>
		//     <list name='private'/>
		//     <list name='special'/>
		//   </query>
		// </iq>
		
		if ([[iq type] isEqualToString:@"result"])
		{
			NSXMLElement *query = [iq elementForName:@"query" xmlns:@"jabber:iq:privacy"];
			if (query == nil) return;
			
			NSXMLElement *active = [query elementForName:@"active"];
			activeListName = [[active attributeStringValueForName:@"name"] copy];
			
			NSXMLElement *dfault = [query elementForName:@"default"];
			defaultListName = [[dfault attributeStringValueForName:@"name"] copy];
			
			NSArray *listNames = [query elementsForName:@"list"];
			for (NSXMLElement *listName in listNames)
			{
				NSString *name = [listName attributeStringValueForName:@"name"];
				if (name)
				{
					id value = privacyDict[name];
					if (value == nil)
					{
						privacyDict[name] = [NSNull null];
					}
				}
			}
			
			[multicastDelegate xmppPrivacy:self didReceiveListNames:[self listNames]];
		}
		else
		{
			[multicastDelegate xmppPrivacy:self didNotReceiveListNamesDueToError:iq];
		}
	}
	else if (queryInfo.type == FetchRules)
	{
		// Privacy List Rules Query Response (success):
		// 
		// <iq type='result' id='getlist2'>
		//   <query xmlns='jabber:iq:privacy'>
		//     <list name='public'>
		//       <item type='jid' value='tybalt@example.com' action='deny' order='1'/>
		//       <item action='allow' order='2'/>
		//     </list>
		//   </query>
		// </iq>
		// 
		// 
		// Privacy List Rules Query Response (error):
		// 
		// <iq type='error' id='getlist5'>
		//   <query xmlns='jabber:iq:privacy'>
		//     <list name='The Empty Set'/>
		//   </query>
		//   <error type='cancel'>
		//     <item-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
		//   </error>
		// </iq>
		
		if ([[iq type] isEqualToString:@"result"])
		{
			NSXMLElement *query = [iq elementForName:@"query" xmlns:@"jabber:iq:privacy"];
			if (query == nil) return;
			
			NSXMLElement *list = [query elementForName:@"list"];
			if (list == nil) return;
			
			NSArray *items = [[list elementsForName:@"item"] sortedArrayUsingFunction:sortItems context:NULL];
			
			if (items == nil)
			{
				items = [NSArray array];
			}
			
			privacyDict[queryInfo.privacyListName] = items;
			
			[multicastDelegate xmppPrivacy:self didReceiveListWithName:queryInfo.privacyListName items:items];
		}
		else
		{
			[multicastDelegate xmppPrivacy:self didNotReceiveListWithName:queryInfo.privacyListName error:iq];
		}
	}
	else if (queryInfo.type == EditList)
	{
		// Privacy List Add/Edit/Remove Response (success):
		// 
		// <iq type='result' id='abc123' to='romeo@example.net/orchard'/>
		// 
		// Note: The result iq does NOT have a query child.
		
		if ([[iq type] isEqualToString:@"result"])
		{
			NSArray *items = [[queryInfo privacyListItems] sortedArrayUsingFunction:sortItems context:NULL];
			
			if (items == nil)
			{
				items = [NSArray array];
			}
			
			privacyDict[queryInfo.privacyListName] = items;
			
			[multicastDelegate xmppPrivacy:self didSetListWithName:queryInfo.privacyListName];
		}
		else
		{
			[multicastDelegate xmppPrivacy:self didNotSetListWithName:queryInfo.privacyListName error:iq];
		}
	}
	else if (queryInfo.type == SetActiveList)
	{
		// Change of active list (success):
		// 
		// <iq type='result' id='active1' to='romeo@example.net/orchard'/>
		// 
		// 
		// Change of active list (error):
		// 
		// <iq to='romeo@example.net/orchard' type='error' id='active2'>
		//   <query xmlns='jabber:iq:privacy'>
		//     <active name='Invalid List Name'/>
		//   </query>
		//   <error type='cancel'>
		//     <item-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
		//   </error>
		// </iq>
		// 
		// 
		// Note: The result iq does NOT have a query child.
		// Note: The success could also mean we declined the use of an active list.
		
		if ([[iq type] isEqualToString:@"result"])
		{
			activeListName = [[queryInfo privacyListName] copy];
			
			[multicastDelegate xmppPrivacy:self didSetActiveListName:queryInfo.privacyListName];
		}
		else
		{
			[multicastDelegate xmppPrivacy:self didNotSetActiveListName:queryInfo.privacyListName error:iq];
		}
	}
	else if (queryInfo.type == SetDefaultList)
	{
		// Change of default list (success):
		// 
		// <iq type='result' id='default1' to='romeo@example.net/orchard'/>
		// 
		// 
		// Change of default list (error):
		// 
		// <iq to='romeo@example.net/orchard' type='error' id='default1'>
		//   <query xmlns='jabber:iq:privacy'>
		//     <default name='special'/>
		//   </query>
		//   <error type='cancel'>
		//     <conflict xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
		//   </error>
		// </iq>
		// 
		// 
		// Note: The result iq does NOT have a query child.
		// Note: The success could also mean we declined the use of a default list.
		
		if ([[iq type] isEqualToString:@"result"])
		{
			defaultListName = [[queryInfo privacyListName] copy];
			
			[multicastDelegate xmppPrivacy:self didSetDefaultListName:queryInfo.privacyListName];
		}
		else
		{
			[multicastDelegate xmppPrivacy:self didNotSetDefaultListName:queryInfo.privacyListName error:iq];
		}
	}
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark XMPPStream Delegate
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender
{
	if (self.autoRetrievePrivacyListNames)
	{
		[self retrieveListNames];
	}
}

- (BOOL)xmppStream:(XMPPStream *)sender didReceiveIQ:(XMPPIQ *)iq
{
	NSString *type = [iq type];
	
	if ([type isEqualToString:@"set"])
	{
		NSXMLElement *query = [iq elementForName:@"query" xmlns:@"jabber:iq:privacy"];
		if (query)
		{
			// Privacy List Push:
			// 
			// <iq type='set' id='push1'>
			//   <query xmlns='jabber:iq:privacy'>
			//     <list name='public'/>
			//   </query>
			// </iq>
			// 
			// 
			// Push response:
			// 
			// <iq type='result' id='push1'/>
			
			NSXMLElement *list = [query elementForName:@"list"];
			
			NSString *listName = [list attributeStringValueForName:@"name"];
			if (listName == nil)
			{
				return NO;
			}
			
			[multicastDelegate xmppPrivacy:self didReceivePushWithListName:listName];
			
			XMPPIQ *iqResponse = [XMPPIQ iqWithType:@"result" to:[iq from] elementID:[iq elementID]];
			[xmppStream sendElement:iqResponse];
			
			if (self.autoRetrievePrivacyListItems)
			{
				[self retrieveListWithName:listName];
			}
			
			return YES;
		}
	}
	else
	{
		// This may be a response to a query we sent
		
		XMPPPrivacyQueryInfo *queryInfo = pendingQueries[[iq elementID]];
		if (queryInfo)
		{
			[self processQueryResponse:iq withInfo:queryInfo];
			
			if (queryInfo.type == FetchList && self.autoRetrievePrivacyListItems)
			{
				for (NSString *privacyListName in privacyDict)
				{
					id privacyListItems = privacyDict[privacyListName];
					
					if (privacyListItems == [NSNull null])
					{
						[self retrieveListWithName:privacyListName];
					}
				}
			}
			
			return YES;
		}
	}
	
	return NO;
}

-(void)xmppStreamDidDisconnect:(XMPPStream *)sender withError:(NSError *)error
{
	// If there are any pending queries,
	// they just failed due to the disconnection.
	
	for (NSString *uuid in pendingQueries)
	{
		XMPPPrivacyQueryInfo *queryInfo = privacyDict[uuid];
		
		[self processQuery:queryInfo withFailureCode:XMPPPrivacyDisconnect];
	}
	
	// Clear the list of pending queries
	
	[pendingQueries removeAllObjects];
	
	// Maybe clear all stored privacy info
	
	if (self.autoClearPrivacyListInfo)
	{
		[self clearPrivacyListInfo];
	}
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Privacy Items
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

+ (NSXMLElement *)privacyItemWithAction:(NSString *)action order:(NSUInteger)orderValue
{
	return [self privacyItemWithType:nil value:nil action:action order:orderValue];
}

+ (NSXMLElement *)privacyItemWithType:(NSString *)type
                                value:(NSString *)value
                               action:(NSString *)action
                                order:(NSUInteger)orderValue
{
	NSString *order = [[NSString alloc] initWithFormat:@"%lu", (unsigned long)orderValue];
	
	// <item type='[jid|group|subscription]'
	//      value='bar'
	//     action='[allow|deny]'
	//      order='unsignedInt'>
	//   [<iq/>]
	//   [<message/>]
	//   [<presence-in/>]
	//   [<presence-out/>]
	// </item>
	
	NSXMLElement *item = [NSXMLElement elementWithName:@"item"];
	
	if (type)
		[item addAttributeWithName:@"type"  stringValue:type];
	
	if (value)
		[item addAttributeWithName:@"value" stringValue:value];
	
	[item addAttributeWithName:@"action" stringValue:action];
	[item addAttributeWithName:@"order"  stringValue:order];
	
	return item;
}

+ (void)blockIQs:(NSXMLElement *)privacyItem
{
	[privacyItem addChild:[NSXMLElement elementWithName:@"iq"]];
}

+ (void)blockMessages:(NSXMLElement *)privacyItem
{
	[privacyItem addChild:[NSXMLElement elementWithName:@"message"]];
}

+ (void)blockPresenceIn:(NSXMLElement *)privacyItem
{
	[privacyItem addChild:[NSXMLElement elementWithName:@"presence-in"]];
}

+ (void)blockPresenceOut:(NSXMLElement *)privacyItem
{
	[privacyItem addChild:[NSXMLElement elementWithName:@"presence-out"]];
}

@end

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark -
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

@implementation XMPPPrivacyQueryInfo

@synthesize type;
@synthesize privacyListName;
@synthesize privacyListItems;
@synthesize timer;


- (id)initWithType:(XMPPPrivacyQueryInfoType)aType name:(NSString *)name items:(NSArray *)items
{
	if ((self = [super init]))
	{
		type = aType;
		privacyListName = [name copy];
		privacyListItems = [items copy];
	}
	return self;
}

- (void)cancel
{
	if (timer)
	{
		dispatch_source_cancel(timer);
		#if !OS_OBJECT_USE_OBJC
		dispatch_release(timer);
		#endif
		timer = NULL;
	}
}

- (void)dealloc
{
	[self cancel];
}

+ (XMPPPrivacyQueryInfo *)queryInfoWithType:(XMPPPrivacyQueryInfoType)type
{
	return [self queryInfoWithType:type name:nil items:nil];
}

+ (XMPPPrivacyQueryInfo *)queryInfoWithType:(XMPPPrivacyQueryInfoType)type name:(NSString *)name
{
	return [self queryInfoWithType:type name:name items:nil];
}

+ (XMPPPrivacyQueryInfo *)queryInfoWithType:(XMPPPrivacyQueryInfoType)type name:(NSString *)name items:(NSArray *)items
{
	return [[XMPPPrivacyQueryInfo alloc] initWithType:type name:name items:items];
}

@end