Skip to content

Commit 2075ebd

Browse files
robbiehansonrobbiehanson
committed
Merge pull request robbiehanson#69 from binarybucks/xep-0224
Added XEP-0224
2 parents 7ade49d + 7a4b4cf commit 2075ebd

File tree

4 files changed

+181
-0
lines changed

4 files changed

+181
-0
lines changed

‎Extensions/XEP-0224/XMPPAttentionModule.h

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#import "XMPPModule.h"
2+
#import "XMPPMessage+XEP_0224.h"
3+
4+
@interface XMPPAttentionModule : XMPPModule {
5+
BOOL respondsToQueries;
6+
}
7+
8+
/**
9+
* Whether or not the module should respond to incoming attention request queries.
10+
* It you create multiple instances of this module, only one instance should respond to queries.
11+
*
12+
* It is recommended you set this (if needed) before you activate the module.
13+
* The default value is YES.
14+
**/
15+
@property (readwrite) BOOL respondsToQueries;
16+
17+
@end
18+
19+
@protocol XMPPAttentionDelegate
20+
@optional
21+
- (void)xmppAttention:(XMPPAttentionModule *)sender didReceiveAttentionHeadlineMessage:(XMPPMessage *)attentionRequest;
22+
@end

‎Extensions/XEP-0224/XMPPAttentionModule.m

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
#import "XMPPAttentionModule.h"
2+
3+
#if ! __has_feature(objc_arc)
4+
#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC).
5+
#endif
6+
7+
@implementation XMPPAttentionModule
8+
9+
- (id)init
10+
{
11+
return [self initWithDispatchQueue:NULL];
12+
}
13+
14+
- (id)initWithDispatchQueue:(dispatch_queue_t)queue
15+
{
16+
if ((self = [super initWithDispatchQueue:queue]))
17+
{
18+
respondsToQueries = YES;
19+
}
20+
return self;
21+
}
22+
23+
- (BOOL)activate:(XMPPStream *)aXmppStream
24+
{
25+
if ([super activate:aXmppStream])
26+
{
27+
#ifdef _XMPP_CAPABILITIES_H
28+
[xmppStream autoAddDelegate:self delegateQueue:moduleQueue toModulesOfClass:[XMPPCapabilities class]];
29+
#endif
30+
return YES;
31+
}
32+
33+
return NO;
34+
}
35+
36+
- (void)deactivate
37+
{
38+
#ifdef _XMPP_CAPABILITIES_H
39+
[xmppStream removeAutoDelegate:self delegateQueue:moduleQueue fromModulesOfClass:[XMPPCapabilities class]];
40+
#endif
41+
42+
[super deactivate];
43+
}
44+
45+
- (BOOL)respondsToQueries
46+
{
47+
if (dispatch_get_current_queue() == moduleQueue)
48+
{
49+
return respondsToQueries;
50+
}
51+
else
52+
{
53+
__block BOOL result;
54+
55+
dispatch_sync(moduleQueue, ^{
56+
result = respondsToQueries;
57+
});
58+
return result;
59+
}
60+
}
61+
62+
- (void)setRespondsToQueries:(BOOL)flag
63+
{
64+
dispatch_block_t block = ^{
65+
66+
if (respondsToQueries != flag)
67+
{
68+
respondsToQueries = flag;
69+
70+
#ifdef _XMPP_CAPABILITIES_H
71+
@autoreleasepool {
72+
// Capabilities may have changed, need to notify others.
73+
[xmppStream resendMyPresence];
74+
}
75+
#endif
76+
}
77+
};
78+
79+
if (dispatch_get_current_queue() == moduleQueue)
80+
block();
81+
else
82+
dispatch_async(moduleQueue, block);
83+
}
84+
85+
86+
- (BOOL)xmppStream:(XMPPStream *)sender didReceiveMessage:(XMPPMessage *)message
87+
{
88+
// This method is invoked on the moduleQueue.
89+
90+
// Format of an attention message. Body is optional and not used by clients like Pidgin
91+
// <message from='[email protected]/lab' to='[email protected]/home' type='headline'>
92+
// <attention xmlns='urn:xmpp:attention:0'/>
93+
// <body>Why don't you answer, Herbie?</body>
94+
// </message>
95+
96+
if ([message isAttentionMessage])
97+
{
98+
[multicastDelegate xmppAttention:self didReceiveAttentionHeadlineMessage:message];
99+
}
100+
return YES;
101+
}
102+
103+
104+
#ifdef _XMPP_CAPABILITIES_H
105+
/**
106+
* If an XMPPCapabilites instance is used we want to advertise our support for attention requests.
107+
**/
108+
- (void)xmppCapabilities:(XMPPCapabilities *)sender collectingMyCapabilities:(NSXMLElement *)query
109+
{
110+
// This method is invoked on the moduleQueue.
111+
112+
if (respondsToQueries)
113+
{
114+
// <query xmlns="http://jabber.org/protocol/disco#info">
115+
// ...
116+
// <feature var="urn:xmpp:attention:0"/>
117+
// ...
118+
// </query>
119+
120+
NSXMLElement *feature = [NSXMLElement elementWithName:@"feature"];
121+
[feature addAttributeWithName:@"var" stringValue:XMLNS_ATTENTION];
122+
123+
[query addChild:feature];
124+
}
125+
}
126+
#endif
127+
128+
@end

‎Extensions/XEP-0224/XMPPMessage+XEP_0224.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#import "XMPPMessage.h"
2+
#define XMLNS_ATTENTION @"urn:xmpp:attention:0"
3+
4+
@interface XMPPMessage (XEP_0224)
5+
- (BOOL)isHeadLineMessage;
6+
- (BOOL)isAttentionMessage;
7+
- (BOOL)isAttentionMessageWithBody;
8+
@end

‎Extensions/XEP-0224/XMPPMessage+XEP_0224.m

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#import "XMPPMessage+XEP_0224.h"
2+
3+
@implementation XMPPMessage (XEP_0224)
4+
5+
- (BOOL)isHeadLineMessage {
6+
return [[[self attributeForName:@"type"] stringValue] isEqualToString:@"headline"];
7+
}
8+
9+
- (BOOL)isAttentionMessage
10+
{
11+
return [self isHeadLineMessage] && [self elementForName:@"attention" xmlns:XMLNS_ATTENTION];
12+
}
13+
14+
- (BOOL)isAttentionMessageWithBody
15+
{
16+
if([self isAttentionMessage])
17+
{
18+
return [self isMessageWithBody];
19+
}
20+
return NO;
21+
}
22+
23+
@end

0 commit comments

Comments
 (0)