copyleftie
/
gajim-plural
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Coding standards and documentation improvements in features_nb.py. Remove unused methods.

This commit is contained in:
Stephan Erb 2008-12-28 01:29:33 +00:00
parent d7091c74a4
commit 8b3833b443
1 changed files with 65 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

179
src/common/xmpp/features_nb.py
View File

@ -17,111 +17,40 @@
''' '''
Different stuff that wasn't worth separating it into modules Different stuff that wasn't worth separating it into modules
(Registration, Privacy Lists, ...)
''' '''
from protocol import * from protocol import NS_REGISTER, NS_PRIVACY, NS_DATA, Iq, isResultNode, Node
REGISTER_DATA_RECEIVED='REGISTER DATA RECEIVED'
PRIVACY_LISTS_RECEIVED='PRIVACY LISTS RECEIVED'
PRIVACY_LIST_RECEIVED='PRIVACY LIST RECEIVED'
PRIVACY_LISTS_ACTIVE_DEFAULT='PRIVACY LISTS ACTIVE DEFAULT'
def _on_default_response(disp, iq, cb): def _on_default_response(disp, iq, cb):
def _on_response(resp): def _on_response(resp):
if isResultNode(resp): if isResultNode(resp):
if cb: if cb:
cb(1) cb(True)
elif cb: elif cb:
cb(False) cb(False)
disp.SendAndCallForResponse(iq, _on_response) disp.SendAndCallForResponse(iq, _on_response)
def _discover(disp, ns, jid, node = None, fb2b=0, fb2a=1, cb=None): ###############################################################################
''' Try to obtain info from the remote object. ### Registration
If remote object doesn't support disco fall back to browse (if fb2b is true) ###############################################################################
and if it doesnt support browse (or fb2b is not true) fall back to agents protocol
(if gb2a is true). Returns obtained info. Used internally. '''
iq=Iq(to=jid, typ='get', queryNS=ns)
if node:
iq.setQuerynode(node)
def _on_resp1(resp):
if fb2b and not isResultNode(resp):
# Fallback to browse
disp.SendAndCallForResponse(Iq(to=jid,typ='get',queryNS=NS_BROWSE), _on_resp2)
else:
_on_resp2('')
def _on_resp2(resp):
if fb2a and not isResultNode(resp):
# Fallback to agents
disp.SendAndCallForResponse(Iq(to=jid,typ='get',queryNS=NS_AGENTS), _on_result)
else:
_on_result('')
def _on_result(resp):
if isResultNode(resp):
if cb:
cb(resp.getQueryPayload())
elif cb:
cb([])
disp.SendAndCallForResponse(iq, _on_resp1)
# this function is not used in gajim ??? REGISTER_DATA_RECEIVED = 'REGISTER DATA RECEIVED'
def discoverItems(disp,jid,node=None, cb=None):
''' Query remote object about any items that it contains. Return items list. '''
# According to JEP-0030:
# query MAY have node attribute
# item: MUST HAVE jid attribute and MAY HAVE name, node, action attributes.
# action attribute of item can be either of remove or update value.
def _on_response(result_array):
ret=[]
for result in result_array:
if result.getName()=='agent' and result.getTag('name'):
result.setAttr('name', result.getTagData('name'))
ret.append(result.attrs)
if cb:
cb(ret)
_discover(disp, NS_DISCO_ITEMS, jid, node, _on_response)
# this one is
def discoverInfo(disp,jid,node=None, cb=None):
''' Query remote object about info that it publishes. Returns identities and features lists.'''
# According to JEP-0030:
# query MAY have node attribute
# identity: MUST HAVE category and name attributes and MAY HAVE type attribute.
# feature: MUST HAVE var attribute
def _on_response(result):
identities , features = [] , []
for i in result:
if i.getName()=='identity':
identities.append(i.attrs)
elif i.getName()=='feature':
features.append(i.getAttr('var'))
elif i.getName()=='agent':
if i.getTag('name'):
i.setAttr('name',i.getTagData('name'))
if i.getTag('description'):
i.setAttr('name',i.getTagData('description'))
identities.append(i.attrs)
if i.getTag('groupchat'):
features.append(NS_GROUPCHAT)
if i.getTag('register'):
features.append(NS_REGISTER)
if i.getTag('search'):
features.append(NS_SEARCH)
if cb:
cb(identities , features)
_discover(disp, NS_DISCO_INFO, jid, node, _on_response)
### Registration ### jabber:iq:register ### JEP-0077 ###########################
def getRegInfo(disp, host, info={}, sync=True): def getRegInfo(disp, host, info={}, sync=True):
''' Gets registration form from remote host. '''
You can pre-fill the info dictionary. Gets registration form from remote host. Info dict can be prefilled
F.e. if you are requesting info on registering user joey than specify :param disp: plugged dispatcher instance
info as {'username':'joey'}. See JEP-0077 for details. :param info: dict, like {'username':'joey'}.
'disp' must be connected dispatcher instance.'''
See JEP-0077 for details.
'''
iq=Iq('get',NS_REGISTER,to=host) iq=Iq('get',NS_REGISTER,to=host)
for i in info.keys(): for i in info.keys():
iq.setTagData(i,info[i]) iq.setTagData(i,info[i])
if sync: if sync:
disp.SendAndCallForResponse(iq, lambda resp: _ReceivedRegInfo(disp.Dispatcher,resp, host)) disp.SendAndCallForResponse(iq, lambda resp:
_ReceivedRegInfo(disp.Dispatcher,resp, host))
else: else:
disp.SendAndCallForResponse(iq, _ReceivedRegInfo, {'agent': host }) disp.SendAndCallForResponse(iq, _ReceivedRegInfo, {'agent': host })
@ -148,10 +77,11 @@ def _ReceivedRegInfo(con, resp, agent):
con.Event(NS_REGISTER, REGISTER_DATA_RECEIVED, (agent,df,False,'')) con.Event(NS_REGISTER, REGISTER_DATA_RECEIVED, (agent,df,False,''))
def register(disp, host, info, cb): def register(disp, host, info, cb):
''' Perform registration on remote server with provided info. '''
disp must be connected dispatcher instance. Perform registration on remote server with provided info.
If registration fails you can get additional info from the dispatcher's owner
attributes lastErrNode, lastErr and lastErrCode. If registration fails you can get additional info from the dispatcher's
owner attributes lastErrNode, lastErr and lastErrCode.
''' '''
iq=Iq('set', NS_REGISTER, to=host) iq=Iq('set', NS_REGISTER, to=host)
if not isinstance(info, dict): if not isinstance(info, dict):
@ -161,28 +91,42 @@ def register(disp, host, info, cb):
disp.SendAndCallForResponse(iq, cb) disp.SendAndCallForResponse(iq, cb)
def unregister(disp, host, cb): def unregister(disp, host, cb):
''' Unregisters with host (permanently removes account). '''
disp must be connected and authorized dispatcher instance. Unregisters with host (permanently removes account). Returns true on success
Returns true on success.''' '''
iq = Iq('set', NS_REGISTER, to=host, payload=[Node('remove')]) iq = Iq('set', NS_REGISTER, to=host, payload=[Node('remove')])
_on_default_response(disp, iq, cb) _on_default_response(disp, iq, cb)
def changePasswordTo(disp, newpassword, host=None, cb = None): def changePasswordTo(disp, newpassword, host=None, cb = None):
''' Changes password on specified or current (if not specified) server. '''
disp must be connected and authorized dispatcher instance. Changes password on specified or current (if not specified) server.
Returns true on success.''' Returns true on success.
if not host: host=disp._owner.Server '''
if not host:
host = disp._owner.Server
iq = Iq('set',NS_REGISTER,to=host, payload=[Node('username', iq = Iq('set',NS_REGISTER,to=host, payload=[Node('username',
payload=[disp._owner.Server]),Node('password',payload=[newpassword])]) payload=[disp._owner.Server]),Node('password',payload=[newpassword])])
_on_default_response(disp, iq, cb) _on_default_response(disp, iq, cb)
### Privacy ### jabber:iq:privacy ### draft-ietf-xmpp-im-19 #################### ###############################################################################
#type=[jid|group|subscription] ### Privacy List
#action=[allow|deny] ###############################################################################
PL_TYPE_JID = 'jid'
PL_TYPE_GROUP = 'group'
PL_TYPE_SUBC = 'subscription'
PL_ACT_ALLOW = 'allow'
PL_ACT_DENY = 'deny'
PRIVACY_LISTS_RECEIVED = 'PRIVACY LISTS RECEIVED'
PRIVACY_LIST_RECEIVED = 'PRIVACY LIST RECEIVED'
PRIVACY_LISTS_ACTIVE_DEFAULT = 'PRIVACY LISTS ACTIVE DEFAULT'
def getPrivacyLists(disp): def getPrivacyLists(disp):
''' Requests privacy lists from connected server. '''
Returns dictionary of existing lists on success.''' Requests privacy lists from connected server.
Returns dictionary of existing lists on success.
'''
iq = Iq('get', NS_PRIVACY) iq = Iq('get', NS_PRIVACY)
def _on_response(resp): def _on_response(resp):
dict_ = {'lists': []} dict_ = {'lists': []}
@ -213,8 +157,10 @@ def getActiveAndDefaultPrivacyLists(disp):
disp.SendAndCallForResponse(iq, _on_response) disp.SendAndCallForResponse(iq, _on_response)
def getPrivacyList(disp, listname): def getPrivacyList(disp, listname):
''' Requests specific privacy list listname. Returns list of XML nodes (rules) '''
taken from the server responce.''' Requests specific privacy list listname. Returns list of XML nodes (rules)
taken from the server responce.
'''
def _on_response(resp): def _on_response(resp):
if not isResultNode(resp): if not isResultNode(resp):
disp.Event(NS_PRIVACY, PRIVACY_LIST_RECEIVED, (False)) disp.Event(NS_PRIVACY, PRIVACY_LIST_RECEIVED, (False))
@ -224,8 +170,10 @@ def getPrivacyList(disp, listname):
disp.SendAndCallForResponse(iq, _on_response) disp.SendAndCallForResponse(iq, _on_response)
def setActivePrivacyList(disp, listname=None, typ='active', cb=None): def setActivePrivacyList(disp, listname=None, typ='active', cb=None):
''' Switches privacy list 'listname' to specified type. '''
By default the type is 'active'. Returns true on success.''' Switches privacy list 'listname' to specified type.
By default the type is 'active'. Returns true on success.
'''
if listname: if listname:
attrs={'name':listname} attrs={'name':listname}
else: else:
@ -234,19 +182,22 @@ def setActivePrivacyList(disp, listname=None, typ='active', cb=None):
_on_default_response(disp, iq, cb) _on_default_response(disp, iq, cb)
def setDefaultPrivacyList(disp, listname=None): def setDefaultPrivacyList(disp, listname=None):
''' Sets the default privacy list as 'listname'. Returns true on success.''' ''' Sets the default privacy list as 'listname'. Returns true on success. '''
return setActivePrivacyList(disp, listname,'default') return setActivePrivacyList(disp, listname,'default')
def setPrivacyList(disp, listname, tags): def setPrivacyList(disp, listname, tags):
''' Set the ruleset. 'list' should be the simpleXML node formatted '''
according to RFC 3921 (XMPP-IM) (I.e. Node('list',{'name':listname},payload=[...]) ) Set the ruleset.
Returns true on success.'''
'list' should be the simpleXML node formatted according to RFC 3921 (XMPP-IM) I.e. Node('list',{'name':listname},payload=[...]). Returns true on success.
'''
iq = Iq('set', NS_PRIVACY, xmlns = '') iq = Iq('set', NS_PRIVACY, xmlns = '')
list_query = iq.getTag('query').setTag('list', {'name': listname}) list_query = iq.getTag('query').setTag('list', {'name': listname})
for item in tags: for item in tags:
if 'type' in item and 'value' in item: if 'type' in item and 'value' in item:
item_tag = list_query.setTag('item', {'action': item['action'], item_tag = list_query.setTag('item', {'action': item['action'],
'order': item['order'], 'type': item['type'], 'value': item['value']}) 'order': item['order'], 'type': item['type'],
'value': item['value']})
else: else:
item_tag = list_query.setTag('item', {'action': item['action'], item_tag = list_query.setTag('item', {'action': item['action'],
'order': item['order']}) 'order': item['order']})
@ -255,8 +206,8 @@ def setPrivacyList(disp, listname, tags):
item_tag.setTag(child_tag) item_tag.setTag(child_tag)
_on_default_response(disp, iq, None) _on_default_response(disp, iq, None)
def delPrivacyList(disp,listname,cb=None): def delPrivacyList(disp, listname, cb=None):
''' Deletes privacy list 'listname'. Returns true on success.''' ''' Deletes privacy list 'listname'. Returns true on success. '''
iq = Iq('set',NS_PRIVACY,payload=[Node('list',{'name':listname})]) iq = Iq('set',NS_PRIVACY,payload=[Node('list',{'name':listname})])
_on_default_response(disp, iq, cb) _on_default_response(disp, iq, cb)