def act():
# TODO: verify that it's coming from a known user
jid = msg.conn.data['user']['jid']
cjid = JID(tree.get('to'))
type = tree.get('type')
if not cjid:
logging.warning('[%s] No contact jid specified in subscription ' +\
'query. Tree: %s', self.__class__, tree)
# TODO: throw exception here
return
roster = Roster(jid)
# get the RosterItem
cinfo = roster.getContactInfo(cjid.getBare())
retVal = lastRetVal
# C2S SUBSCRIBE
if type == 'subscribe':
# we must always route the subscribe presence so as to allow
# the other servers to resynchronize their sub lists.
# RFC 3921 9.2
if not cinfo:
# contact doesn't exist, but according to RFC 3921
# section 8.2 bullet 4 we MUST create a new roster entry
# for it with empty name and groups.
roster.updateContact(cjid.getBare())
# now refetch the contact info
cinfo = roster.getContactInfo(cjid.getBare())
cid = cinfo.id
name = cinfo.name
subscription = cinfo.subscription
groups = cinfo.groups
# update the subscription state
if subscription == Subscription.NONE:
roster.setSubscription(cid, Subscription.NONE_PENDING_OUT)
subscription = Subscription.NONE_PENDING_OUT
elif subscription == Subscription.NONE_PENDING_IN:
roster.setSubscription(cid,
Subscription.NONE_PENDING_IN_OUT)
subscription = Subscription.NONE_PENDING_IN_OUT
elif subscription == Subscription.FROM:
roster.setSubscription(cid, Subscription.FROM_PENDING_OUT)
subscription = Subscription.FROM_PENDING_OUT
# send a roster push with ask
query = Roster.createRosterQuery(
cjid.getBare(),
Subscription.getPrimaryNameFromState(subscription), name,
groups, {'ask': 'subscribe'})
# stamp presence with 'from' JID
treeCopy = deepcopy(tree)
treeCopy.set('from', jid)
# prepare the presence data for routing
d = {
'to': cjid,
'data': treeCopy,
}
retVal = chainOutput(retVal, d)
# sequence of events in reverse order
# push the roster first, in case we have to create a new
# s2s connection
msg.setNextHandler('route-server')
msg.setNextHandler('roster-push')
return chainOutput(retVal, query)
# C2S SUBSCRIBED
elif type == 'subscribed':
if not cinfo:
logging.warning("[%s] 'subscribed' presence received for " +\
"non-existent contact %s", self.__class__, cjid)
else:
subscription = cinfo.subscription
if cinfo.subscription in (Subscription.NONE_PENDING_IN,
Subscription.NONE_PENDING_IN_OUT,
Subscription.TO_PENDING_IN):
# update state and deliver
if cinfo.subscription == Subscription.NONE_PENDING_IN:
roster.setSubscription(cinfo.id, Subscription.FROM)
subscription = Subscription.FROM
elif cinfo.subscription == Subscription.NONE_PENDING_IN_OUT:
roster.setSubscription(
cinfo.id, Subscription.FROM_PENDING_OUT)
subscription = Subscription.FROM_PENDING_OUT
elif cinfo.subscription == Subscription.TO_PENDING_IN:
roster.setSubscription(cinfo.id, Subscription.BOTH)
subscription = Subscription.BOTH
# roster stanza
query = Roster.createRosterQuery(
cjid.getBare(),
Subscription.getPrimaryNameFromState(subscription),
cinfo.name, cinfo.groups)
# stamp presence with 'from'
treeCopy = deepcopy(tree)
treeCopy.set('from', jid)
toRoute = tostring(treeCopy)
# create available presence stanzas for all resources of the user
resources = msg.conn.server.launcher.getC2SServer(
).data['resources']
jidForResources = resources.has_key(
jid) and resources[jid]
if jidForResources:
out = u''
for i in jidForResources:
out += "<presence from='%s/%s'" % (jid, i)
out += " to='%s'/>" % cjid.getBare()
# and queue for routing
toRoute += out
# prepare the presence data for routing
d = {
'to': cjid,
'data': toRoute,
}
retVal = chainOutput(retVal, d)
# next handlers in reverse order
msg.setNextHandler('route-server')
msg.setNextHandler('roster-push')
return chainOutput(retVal, query)
# C2S UNSUBSCRIBE
elif type == 'unsubscribe':
# we must always route the unsubscribe presence so as to allow
# the other servers to resynchronize their sub lists.
# RFC 3921 9.2
if not cinfo:
# we don't have this contact in our roster, but route the
# presence anyway
# stamp presence with 'from'
treeCopy = deepcopy(tree)
treeCopy.set('from', jid)
# prepare the presence data for routing
d = {
'to': cjid,
'data': treeCopy,
}
msg.setNextHandler('route-server')
return chainOutput(retVal, d)
else:
subscription = cinfo.subscription
if subscription == Subscription.BOTH: # mutual
roster.setSubscription(cinfo.id, Subscription.FROM)
subscription = Subscription.FROM
elif subscription in (
Subscription.NONE_PENDING_OUT, # one way
Subscription.NONE_PENDING_IN_OUT,
Subscription.TO,
Subscription.TO_PENDING_IN):
if subscription == Subscription.NONE_PENDING_OUT \
or subscription == Subscription.TO:
roster.setSubscription(cinfo.id, Subscription.NONE)
subscription = Subscription.NONE
elif subscription == Subscription.NONE_PENDING_IN_OUT \
or subscription == Subscription.TO_PENDING_IN:
roster.setSubscription(
cinfo.id, Subscription.NONE_PENDING_IN)
subscription = Subscription.NONE_PENDING_IN
# roster stanza
query = Roster.createRosterQuery(
cjid.getBare(),
Subscription.getPrimaryNameFromState(subscription),
cinfo.name, cinfo.groups)
# stamp presence with 'from'
treeCopy = deepcopy(tree)
treeCopy.set('from', jid)
# prepare the presence data for routing
d = {
'to': cjid,
'data': treeCopy,
}
retVal = chainOutput(retVal, d)
# schedules handlers in reverse order
msg.setNextHandler('route-server')
msg.setNextHandler('roster-push')
return chainOutput(retVal, query)
# C2S UNSUBSCRIBED
elif type == 'unsubscribed':
if not cinfo:
logging.warning("[%s] 'unsubscribed' presence received for " +\
"non-existent contact %s", self.__class__, cjid)
else:
subscription = cinfo.subscription
if subscription not in (Subscription.NONE,
Subscription.NONE_PENDING_OUT,
Subscription.TO):
if subscription == Subscription.NONE_PENDING_IN \
or subscription == Subscription.FROM:
roster.setSubscription(cinfo.id, Subscription.NONE)
subscription = Subscription.NONE
elif subscription == Subscription.NONE_PENDING_IN_OUT \
or subscription == Subscription.FROM_PENDING_OUT:
roster.setSubscription(
cinfo.id, Subscription.NONE_PENDING_OUT)
subscription = Subscription.NONE
elif subscription == Subscription.TO_PENDING_IN \
or subscription == Subscription.BOTH:
roster.setSubscription(cinfo.id, Subscription.TO)
subscription = Subscription.TO
# roster query
if subscription == Subscription.NONE_PENDING_OUT:
itemArgs = {'ask': 'subscribe'}
else:
itemArgs = {}
query = roster.createRosterQuery(
cjid.getBare(),
Subscription.getPrimaryNameFromState(subscription),
cinfo.name, cinfo.groups, itemArgs)
# stamp presence with 'from'
treeCopy = deepcopy(tree)
treeCopy.set('from', jid)
toRoute = tostring(treeCopy)
# create unavailable presence stanzas for all resources of the user
resources = msg.conn.server.launcher.getC2SServer(
).data['resources']
jidForResources = resources.has_key(
jid) and resources[jid]
if jidForResources:
out = u''
for i in jidForResources:
out += "<presence from='%s/%s'" % (jid, i)
out += " to='%s' type='unavailable'/>" % cjid.getBare(
)
# and add to output
toRoute += out
# prepare the presence data for routing
d = {
'to': cjid,
'data': toRoute,
}
retVal = chainOutput(retVal, d)
# handlers in reverse order
msg.setNextHandler('route-server')
msg.setNextHandler('roster-push')
return chainOutput(retVal, query)
def act():
# TODO: verify that it's coming from a known user
jid = msg.conn.data['user']['jid']
cjid = JID(tree.get('to'))
type = tree.get('type')
if not cjid:
logging.warning('[%s] No contact jid specified in subscription ' +\
'query. Tree: %s', self.__class__, tree)
# TODO: throw exception here
return
roster = Roster(jid)
# get the RosterItem
cinfo = roster.getContactInfo(cjid.getBare())
retVal = lastRetVal
# C2S SUBSCRIBE
if type == 'subscribe':
# we must always route the subscribe presence so as to allow
# the other servers to resynchronize their sub lists.
# RFC 3921 9.2
if not cinfo:
# contact doesn't exist, but according to RFC 3921
# section 8.2 bullet 4 we MUST create a new roster entry
# for it with empty name and groups.
roster.updateContact(cjid.getBare())
# now refetch the contact info
cinfo = roster.getContactInfo(cjid.getBare())
cid = cinfo.id
name = cinfo.name
subscription = cinfo.subscription
groups = cinfo.groups
# update the subscription state
if subscription == Subscription.NONE:
roster.setSubscription(cid, Subscription.NONE_PENDING_OUT)
subscription = Subscription.NONE_PENDING_OUT
elif subscription == Subscription.NONE_PENDING_IN:
roster.setSubscription(cid, Subscription.NONE_PENDING_IN_OUT)
subscription = Subscription.NONE_PENDING_IN_OUT
elif subscription == Subscription.FROM:
roster.setSubscription(cid, Subscription.FROM_PENDING_OUT)
subscription = Subscription.FROM_PENDING_OUT
# send a roster push with ask
query = Roster.createRosterQuery(cjid.getBare(),
Subscription.getPrimaryNameFromState(subscription),
name, groups, {'ask' : 'subscribe'})
# stamp presence with 'from' JID
treeCopy = deepcopy(tree)
treeCopy.set('from', jid)
# prepare the presence data for routing
d = {
'to' : cjid,
'data' : treeCopy,
}
retVal = chainOutput(retVal, d)
# sequence of events in reverse order
# push the roster first, in case we have to create a new
# s2s connection
msg.setNextHandler('route-server')
msg.setNextHandler('roster-push')
return chainOutput(retVal, query)
# C2S SUBSCRIBED
elif type == 'subscribed':
if not cinfo:
logging.warning("[%s] 'subscribed' presence received for " +\
"non-existent contact %s", self.__class__, cjid)
else:
subscription = cinfo.subscription
if cinfo.subscription in (Subscription.NONE_PENDING_IN,
Subscription.NONE_PENDING_IN_OUT,
Subscription.TO_PENDING_IN):
# update state and deliver
if cinfo.subscription == Subscription.NONE_PENDING_IN:
roster.setSubscription(cinfo.id, Subscription.FROM)
subscription = Subscription.FROM
elif cinfo.subscription == Subscription.NONE_PENDING_IN_OUT:
roster.setSubscription(cinfo.id, Subscription.FROM_PENDING_OUT)
subscription = Subscription.FROM_PENDING_OUT
elif cinfo.subscription == Subscription.TO_PENDING_IN:
roster.setSubscription(cinfo.id, Subscription.BOTH)
subscription = Subscription.BOTH
# roster stanza
query = Roster.createRosterQuery(cjid.getBare(),
Subscription.getPrimaryNameFromState(subscription),
cinfo.name, cinfo.groups)
# stamp presence with 'from'
treeCopy = deepcopy(tree)
treeCopy.set('from', jid)
toRoute = tostring(treeCopy)
# create available presence stanzas for all resources of the user
resources = msg.conn.server.launcher.getC2SServer().data['resources']
jidForResources = resources.has_key(jid) and resources[jid]
if jidForResources:
out = u''
for i in jidForResources:
out += "<presence from='%s/%s'" % (jid, i)
out += " to='%s'/>" % cjid.getBare()
# and queue for routing
toRoute += out
# prepare the presence data for routing
d = {
'to' : cjid,
'data' : toRoute,
}
retVal = chainOutput(retVal, d)
# next handlers in reverse order
msg.setNextHandler('route-server')
msg.setNextHandler('roster-push')
return chainOutput(retVal, query)
# C2S UNSUBSCRIBE
elif type == 'unsubscribe':
# we must always route the unsubscribe presence so as to allow
# the other servers to resynchronize their sub lists.
# RFC 3921 9.2
if not cinfo:
# we don't have this contact in our roster, but route the
# presence anyway
# stamp presence with 'from'
treeCopy = deepcopy(tree)
treeCopy.set('from', jid)
# prepare the presence data for routing
d = {
'to' : cjid,
'data' : treeCopy,
}
msg.setNextHandler('route-server')
return chainOutput(retVal, d)
else:
subscription = cinfo.subscription
if subscription == Subscription.BOTH: # mutual
roster.setSubscription(cinfo.id, Subscription.FROM)
subscription = Subscription.FROM
elif subscription in (Subscription.NONE_PENDING_OUT, # one way
Subscription.NONE_PENDING_IN_OUT,
Subscription.TO,
Subscription.TO_PENDING_IN):
if subscription == Subscription.NONE_PENDING_OUT \
or subscription == Subscription.TO:
roster.setSubscription(cinfo.id, Subscription.NONE)
subscription = Subscription.NONE
elif subscription == Subscription.NONE_PENDING_IN_OUT \
or subscription == Subscription.TO_PENDING_IN:
roster.setSubscription(cinfo.id, Subscription.NONE_PENDING_IN)
subscription = Subscription.NONE_PENDING_IN
# roster stanza
query = Roster.createRosterQuery(cjid.getBare(),
Subscription.getPrimaryNameFromState(subscription),
cinfo.name, cinfo.groups)
# stamp presence with 'from'
treeCopy = deepcopy(tree)
treeCopy.set('from', jid)
# prepare the presence data for routing
d = {
'to' : cjid,
'data' : treeCopy,
}
retVal = chainOutput(retVal, d)
# schedules handlers in reverse order
msg.setNextHandler('route-server')
msg.setNextHandler('roster-push')
return chainOutput(retVal, query)
# C2S UNSUBSCRIBED
elif type == 'unsubscribed':
if not cinfo:
logging.warning("[%s] 'unsubscribed' presence received for " +\
"non-existent contact %s", self.__class__, cjid)
else:
subscription = cinfo.subscription
if subscription not in (Subscription.NONE,
Subscription.NONE_PENDING_OUT,
Subscription.TO):
if subscription == Subscription.NONE_PENDING_IN \
or subscription == Subscription.FROM:
roster.setSubscription(cinfo.id, Subscription.NONE)
subscription = Subscription.NONE
elif subscription == Subscription.NONE_PENDING_IN_OUT \
or subscription == Subscription.FROM_PENDING_OUT:
roster.setSubscription(cinfo.id, Subscription.NONE_PENDING_OUT)
subscription = Subscription.NONE
elif subscription == Subscription.TO_PENDING_IN \
or subscription == Subscription.BOTH:
roster.setSubscription(cinfo.id, Subscription.TO)
subscription = Subscription.TO
# roster query
if subscription == Subscription.NONE_PENDING_OUT:
itemArgs = {'ask' : 'subscribe'}
else:
itemArgs = {}
query = roster.createRosterQuery(cjid.getBare(),
Subscription.getPrimaryNameFromState(subscription),
cinfo.name, cinfo.groups, itemArgs)
# stamp presence with 'from'
treeCopy = deepcopy(tree)
treeCopy.set('from', jid)
toRoute = tostring(treeCopy)
# create unavailable presence stanzas for all resources of the user
resources = msg.conn.server.launcher.getC2SServer().data['resources']
jidForResources = resources.has_key(jid) and resources[jid]
if jidForResources:
out = u''
for i in jidForResources:
out += "<presence from='%s/%s'" % (jid, i)
out += " to='%s' type='unavailable'/>" % cjid.getBare()
# and add to output
toRoute += out
# prepare the presence data for routing
d = {
'to' : cjid,
'data' : toRoute,
}
retVal = chainOutput(retVal, d)
# handlers in reverse order
msg.setNextHandler('route-server')
msg.setNextHandler('roster-push')
return chainOutput(retVal, query)
def act():
# TODO: verify that it's coming from a known user
jid = msg.conn.data['user']['jid']
id = tree.get('id')
if id is None:
logging.warning('[%s] No id in roster get query. Tree: %s',
self.__class__, tree)
# TODO: throw exception here
return
# RFC 3921 says in section 7.4 "an item", so we only handle the
# first <item>
item = tree[0][0] # iq -> query -> item
cjid = item.get('jid')
name = item.get('name')
if cjid is None:
logging.warning("[%s] Client trying to add a roster item " + \
"without a jid. Tree: %s",
self.__class__, tree)
# TODO: throw exception here
return
roster = Roster(jid)
xpath = './{jabber:iq:roster}query/{jabber:iq:roster}item[@subscription="remove"]'
if tree.find(xpath) is not None:
# we're removing the roster item. See 3921 8.6
out = "<presence from='%s' to='%s' type='unsubscribe'/>" \
% (jid, cjid)
out += "<presence from='%s' to='%s' type='unsubscribed'/>" \
% (jid, cjid)
# create unavailable presence stanzas for all resources of the user
resources = msg.conn.server.launcher.getC2SServer().data['resources']
jidForResources = resources.has_key(jid) and resources[jid]
if jidForResources:
for i in jidForResources:
out += "<presence from='%s/%s'" % (jid, i)
out += " to='%s' type='unavailable'/>" % cjid
# prepare routing data
d = {
'to' : cjid,
'data' : out
}
query = deepcopy(tree[0])
retVal = chainOutput(lastRetVal, query)
if roster.removeContact(cjid) is False:
# We don't even have this contact in the roster anymore.
# The contact is probably local (like ourselves).
# This happens with some clients (like pidgin/gaim) who
# cache the roster and don't delete some items even when
# they're not present in the roster the server sends out
# anymore. If we send the presence here it
# will probably arrive after roster-push (due to s2s)
# and will confuse the clients into thinking they still
# have that contact in their roster. This creates an
# undeletable contact. We can't do much about this.
# If/when the s2s component can do a shortcut delivery of
# stanzas to local users, while in the same phase, this
# problem should go away, as it will allow the roster-push
# to arrive after presences every time.
pass
# route the presence first, then do a roster push
msg.setNextHandler('roster-push')
msg.setNextHandler('route-server')
return chainOutput(retVal, d)
# we're updating/adding the roster item
groups = [i.text for i in list(item.findall('{jabber:iq:roster}group'))]
cid = roster.updateContact(cjid, groups, name)
# get the subscription status before roster push
sub = roster.getSubPrimaryName(cid)
# prepare the result for roster push
query = Roster.createRosterQuery(cjid, sub, name, groups)
msg.setNextHandler('roster-push')
return chainOutput(lastRetVal, query)
def act():
# TODO: verify that it's coming from a known user
jid = msg.conn.data['user']['jid']
id = tree.get('id')
if id is None:
logging.warning('[%s] No id in roster get query. Tree: %s',
self.__class__, tree)
# TODO: throw exception here
return
# RFC 3921 says in section 7.4 "an item", so we only handle the
# first <item>
item = tree[0][0] # iq -> query -> item
cjid = item.get('jid')
name = item.get('name')
if cjid is None:
logging.warning("[%s] Client trying to add a roster item " + \
"without a jid. Tree: %s",
self.__class__, tree)
# TODO: throw exception here
return
roster = Roster(jid)
xpath = './{jabber:iq:roster}query/{jabber:iq:roster}item[@subscription="remove"]'
if tree.find(xpath) is not None:
# we're removing the roster item. See 3921 8.6
out = "<presence from='%s' to='%s' type='unsubscribe'/>" \
% (jid, cjid)
out += "<presence from='%s' to='%s' type='unsubscribed'/>" \
% (jid, cjid)
# create unavailable presence stanzas for all resources of the user
resources = msg.conn.server.launcher.getC2SServer(
).data['resources']
jidForResources = resources.has_key(jid) and resources[jid]
if jidForResources:
for i in jidForResources:
out += "<presence from='%s/%s'" % (jid, i)
out += " to='%s' type='unavailable'/>" % cjid
# prepare routing data
d = {'to': cjid, 'data': out}
query = deepcopy(tree[0])
retVal = chainOutput(lastRetVal, query)
if roster.removeContact(cjid) is False:
# We don't even have this contact in the roster anymore.
# The contact is probably local (like ourselves).
# This happens with some clients (like pidgin/gaim) who
# cache the roster and don't delete some items even when
# they're not present in the roster the server sends out
# anymore. If we send the presence here it
# will probably arrive after roster-push (due to s2s)
# and will confuse the clients into thinking they still
# have that contact in their roster. This creates an
# undeletable contact. We can't do much about this.
# If/when the s2s component can do a shortcut delivery of
# stanzas to local users, while in the same phase, this
# problem should go away, as it will allow the roster-push
# to arrive after presences every time.
pass
# route the presence first, then do a roster push
msg.setNextHandler('roster-push')
msg.setNextHandler('route-server')
return chainOutput(retVal, d)
# we're updating/adding the roster item
groups = [
i.text for i in list(item.findall('{jabber:iq:roster}group'))
]
cid = roster.updateContact(cjid, groups, name)
# get the subscription status before roster push
sub = roster.getSubPrimaryName(cid)
# prepare the result for roster push
query = Roster.createRosterQuery(cjid, sub, name, groups)
msg.setNextHandler('roster-push')
return chainOutput(lastRetVal, query)
