a î½j?'ã@s,dZddlTddlmZGdd„deƒZdS)a¹Browser module provides DISCO server framework for your application. This functionality can be used for very different purposes - from publishing software version and supported features to building of "XMPP site" that users can navigate with their disco browsers and interact with active content. Such functionality is achieved via registering "DISCO handlers" that are automatically called when user requests some node of your disco tree. é)Ú*)ÚPlugInc@sXeZdZdZdd„Zdd„Zdd„Zdd d „Zdd d „Zddd„Z ddd„Z dd„Z dS)ÚBrowsera WARNING! This class is for components only. It will not work in client mode! Standart xmpppy class that is ancestor of PlugIn and can be attached to your application. All processing will be performed in the handlers registered in the browser instance. You can register any number of handlers ensuring that for each node/jid combination only one (or none) handler registered. You can register static information or the fully-blown function that will calculate the answer dynamically. Example of static info (see XEP-0030, examples 13-14): # cl - your xmpppy connection instance. b=xmpp.browser.Browser() b.PlugIn(cl) items=[] item={} item['jid']='catalog.shakespeare.lit' item['node']='books' item['name']='Books by and about Shakespeare' items.append(item) item={} item['jid']='catalog.shakespeare.lit' item['node']='clothing' item['name']='Wear your literary taste with pride' items.append(item) item={} item['jid']='catalog.shakespeare.lit' item['node']='music' item['name']='Music from the time of Shakespeare' items.append(item) info={'ids':[], 'features':[]} b.setDiscoHandler({'items':items,'info':info}) items should be a list of item elements. every item element can have any of these four keys: 'jid', 'node', 'name', 'action' info should be a dicionary and must have keys 'ids' and 'features'. Both of them should be lists: ids is a list of dictionaries and features is a list of text strings. Example (see XEP-0030, examples 1-2) # cl - your xmpppy connection instance. b=xmpp.browser.Browser() b.PlugIn(cl) items=[] ids=[] ids.append({'category':'conference','type':'text','name':'Play-Specific Chatrooms'}) ids.append({'category':'directory','type':'chatroom','name':'Play-Specific Chatrooms'}) features=[NS_DISCO_INFO,NS_DISCO_ITEMS,NS_MUC,NS_REGISTER,NS_SEARCH,NS_TIME,NS_VERSION] info={'ids':ids,'features':features} # info['xdata']=xmpp.protocol.DataForm() # XEP-0128 b.setDiscoHandler({'items':[],'info':info}) cCs"t |¡d}g|_dii|_dS)z0Initialises internal variables. Used internally.ZbrowserÚN)rÚ__init__Z_exported_methodsÚ _handlers)ÚselfZDBG_LINE©r úR/Users/admin/.hermes/hermes-agent/venv/lib/python3.9/site-packages/xmpp/browser.pyrPs zBrowser.__init__cCs,|jd|jdtd|jd|jdtddS)ze Registers it's own iq handlers in your application dispatcher instance. Used internally.ÚiqÚget©ÚtypÚnsN)ZRegisterHandlerÚ_DiscoveryHandlerÚ NS_DISCO_INFOÚNS_DISCO_ITEMS)rÚownerr r r ÚpluginWszBrowser.plugincCs0|jjd|jdtd|jjd|jdtddS)zj Unregisters browser's iq handlers from your application dispatcher instance. Used internally.r r r N)Ú_ownerZUnregisterHandlerrrr)rr r r Úplugout]szBrowser.plugoutécCsä||jvr|j|}n$|r0i|j|<|j|}n |jd}|durJdg}n| dd¡ d¡}|D]b}|dkr~||vr~||}q`|r¤|dkr¤t|t|i||<||}q`|s°d|vr¼|dfSdSq`d|vsÐ|rØ|dfStdƒ‚dS)a  Returns dictionary and key or None,None None - root node (w/o "node" attribute) /a/b/c - node /a/b/ - branch Set returns '' or None as the key get returns '' or None as the key or None as the dict. Used internally.rNú/z /)NNrzCorrupted data)rÚreplaceÚsplitÚdictÚstrÚ Exception)rÚnodeÚjidÚsetÚcurÚir r r Ú _traversePathcs   &zBrowser._traversePathrcCs4| d|||fd¡| ||d¡\}}|||<dS)a This is the main method that you will use in this class. It is used to register supplied DISCO handler (or dictionary with static info) as handler of some disco tree branch. If you do not specify the node this handler will be used for all queried nodes. If you do not specify the jid this handler will be used for all queried JIDs. Usage: cl.Browser.setDiscoHandler(someDict,node,jid) or cl.Browser.setDiscoHandler(someDISCOHandler,node,jid) where someDict={ 'items':[ {'jid':'jid1','action':'action1','node':'node1','name':'name1'}, {'jid':'jid2','action':'action2','node':'node2','name':'name2'}, {'jid':'jid3','node':'node3','name':'name3'}, {'jid':'jid4','node':'node4'} ], 'info' :{ 'ids':[ {'category':'category1','type':'type1','name':'name1'}, {'category':'category2','type':'type2','name':'name2'}, {'category':'category3','type':'type3','name':'name3'}, ], 'features':['feature1','feature2','feature3','feature4'], 'xdata':DataForm } } and/or def someDISCOHandler(session,request,TYR): # if TYR=='items': # returns items list of the same format as shown above # elif TYR=='info': # returns info dictionary of the same format as shown above # else: # this case is impossible for now. z(Registering handler %s for "%s" node->%sÚinforN)ÚDEBUGr#)rÚhandlerrrÚkeyr r r ÚsetDiscoHandlerzs&zBrowser.setDiscoHandlercCs | ||¡\}}|r||SdS)z‹ Returns the previously registered DISCO handler that is resonsible for this node/jid combination. Used internally.N)r#)rrrr'r r r ÚgetDiscoHandler¤szBrowser.getDiscoHandlercCs2| ||¡\}}|r.||}|t|t=|SdS)zÚ Unregisters DISCO handler that is resonsible for this node/jid combination. When handler is unregistered the branch is handled in the same way that it's parent branch from this moment. N)r#rr)rrrr'r&r r r ÚdelDiscoHandler«s zBrowser.delDiscoHandlerc Csè| ¡}|r|}nd}| || ¡¡}|sr| d| ¡ ¡ d¡| d¡| ¡ d¡fd¡| t|t ƒ¡t ‚| d| ¡ ¡ d¡| d¡| ¡ d¡fd¡|  d¡}|r¾|  |¡|  d¡}| ¡tkr0t|ƒtkrì|d }n |||d ƒ}|d kr| t|t ƒ¡t ‚|D]} | d | ¡qn¦| ¡tkrÖt|ƒtkrV|d } n |||d ƒ} | d kr€| t|t ƒ¡t ‚| d D]} | d| ¡qˆ| dD]} | dd| i¡q¤d| vrÖ|j| dd| |¡t ‚d S)z¸ Servers DISCO iq request from the remote client. Automatically determines the best handler to use and calls it to handle the request. Used internally. ÚNonez3No Handler for request with jid->%s node->%s ns->%sÚutf8Úerrorz-Handling request with jid->%s node->%s ns->%sÚokÚresultÚqueryÚitemsNÚitemr$ZidsÚidentityÚfeaturesÚfeatureÚvarZxdata)r)Z getQuerynoder)ZgetTor%Ú__str__ÚencodeZ getQueryNSÚsendÚErrorZERR_ITEM_NOT_FOUNDZ NodeProcessedZ buildReplyZ setQuerynodeZgetTagrÚtyperZaddChildr) rÚconnÚrequestrZnodestrr&ÚrepÚqÚlstr2ÚdtÚidr5r r r r¶s>44        zBrowser._DiscoveryHandlerN)r)rr)rr)rr) Ú__name__Ú __module__Ú __qualname__Ú__doc__rrrr#r(r)r*rr r r r rs2  *  rN)rFÚ dispatcherÚclientrrr r r r Ús