?De,dZddlZddlmZddlZejejejhZejejhZGdde Z GddZ Gdd e Z Gd d e Z Gd d e ZGdde ZGddeZdS)zg ldap.asyncsearch - handle async LDAP search operations See https://www.python-ldap.org/ for details. N) __version__ceZdZdZdZdS)WrongResultTypecV||_||_t|dSN)receivedResultTypeexpectedResultTypes Exception__init__)selfrr s /./ldap/asyncsearch.pyr zWrongResultType.__init__s,0D2D tchd|jd|jS)Nz3Received wrong result type {} (expected one of {}).z, )formatrjoinr r s r __str__zWrongResultType.__str__ s2 @ G G  ii())  rN)__name__ __module__ __qualname__r rrr rrs2 rrcLeZdZdZdZ d dZdZdZd Zd d Z d Z dS)AsyncSearchHandlerz` Class for stream-processing LDAP search results Arguments: l LDAPObject instance c0||_d|_d|_dS)N)_l_msgId_afterFirstResultr ls r r zAsyncSearchHandler.__init__1sDGDKDrNrc b|j||||||| || |_d|_dS)a searchRoot See parameter base of method LDAPObject.search() searchScope See parameter scope of method LDAPObject.search() filterStr See parameter filter of method LDAPObject.search() attrList=None See parameter attrlist of method LDAPObject.search() attrsOnly See parameter attrsonly of method LDAPObject.search() timeout Maximum time the server shall use for search operation sizelimit Maximum number of entries a server should return (request client-side limit) serverctrls list of server-side LDAP controls clientctrls list of client-side LDAP controls rN)r search_extrr) r searchRoot searchScope filterStrattrList attrsOnlytimeout sizelimit serverctrls clientctrlss r startSearchzAsyncSearchHandler.startSearch6sAB'$$Yy[DKD FrcdS)zd Do anything you want after starting search but before receiving and processing results Nrrs r preProcessingz AsyncSearchHandler.preProcessing^rcdS)zh Do anything you want right after successfully receiving but before processing first result Nrrs r afterFirstResultz#AsyncSearchHandler.afterFirstResultdr0rcdS)zI Do anything you want after receiving and processing all results Nrrs r postProcessingz!AsyncSearchHandler.postProcessingjr0rc|d}||z}d}d}d|_||_ d\}} |r|N| sL|j|jd|\}} } } |jr|d|_|| L| snu|tvrt|t| D]F} ||kr|jdz|_n)|dks||kr| || nd}d}n|dz}Gd\}} ||_||r*|jdkr|j |jn3#|r+|jdkr!|j |jwwwxYw| |S)a1 ignoreResultsNumber Don't process the first ignoreResultsNumber results. processResultsCount If non-zero this parameters indicates the number of results processed is limited to processResultsCount. timeout See parameter timeout of ldap.LDAPObject.result() rr)NNN) r/beginResultsDroppedendResultBreakrresult3rrr2SEARCH_RESULT_TYPESr_processSingleResultabandonr4) r ignoreResultsNumberprocessResultsCountr)result_counterend_result_countergo_aheadpartial result_type result_list result_msgidresult_serverctrls result_items r processResultsz!AsyncSearchHandler.processResultsos N,-@@HG D(D% )k+ -!+!DHGOOTXT_`abiDjDj A+k,/A  # '  ! ! # # #%&D " !+!    1 1 1 ,?@@ @& , ,K / / /'+'?'AD $ $"A%%8J)J)J  % %k+ > > > >HG E)!+.."+ K,- -0 %T[$&&  $$$ %T[$&&  $$$$%& Ns CD++0EcdS)zv Process single entry resultType result type resultItem Single item of a result list Nrr resultType resultItems r r:z'AsyncSearchHandler._processSingleResults  Dr)Nrr!rNN)rrr!) rrr__doc__r r-r/r2r4rGr:rrr rr's & & & & P   ....`      rrceZdZdZdZdZdS)Listz Class for collecting all search results. This does not seem to make sense in the first place but think of retrieving exactly a certain portion of the available search results. cJt||g|_dSr)rr allResultsrs r r z List.__init__#Q'''DOOOrc>|j||fdSr)rPappendrIs r r:zList._processSingleResults#OJz233333rNrrrrLr r:rrr rNrNs<44444rrNceZdZdZdZdZdS)DictzJ Class for collecting all search results into a dictionary {dn:entry} cJt||i|_dSr)rr allEntriesrs r r z Dict.__init__rQrc:|tvr|\}}||j|<dSdSr)ENTRY_RESULT_TYPESrXr rJrKdnentrys r r:zDict._processSingleResults1'''hb!dob('rNrTrrr rVrVs<"""""rrVc eZdZdZddZdZdS) IndexedDictz Class for collecting all search results into a dictionary {dn:entry} and maintain case-sensitive equality indexes to entries Nct|||pd|_i|ji|_dS)Nr)rVr indexed_attrsfromkeysindex)r r ras r r zIndexedDict.__init__s?MM$q&,"DT/33DJJJrc|tvrp|\}}||j|<|jD][}||vrS||D]J} |j|||*#t $r|g|j||<YGwxYwZdSdSr)rZrXrarcrSKeyError)r rJrKr\r]avs r r:z IndexedDict._processSingleResults'''hb!dob!((! ::8 ( (a (jmA%%b)))) ( ( (#%djmA (('((s&AA65A6rrTrrr r_r_sA 4444 ( ( ( ( (rr_c&eZdZdZddZdZdZdS) FileWriterz Class for writing a stream of LDAP search results to a file object Arguments: l LDAPObject instance f File object instance where the LDIF data is written to cft||||_||_||_dSr)rr _f headerStr footerStr)r r frmrns r r zFileWriter.__init__s1Q'''DGDNDNNNrcD|j|jdS)zs The headerStr is written to output after starting search but before receiving and processing results. N)rlwritermrs r r/zFileWriter.preProcessing  GMM$.!!!!!rcD|j|jdS)zX The footerStr is written to output after receiving and processing results. N)rlrqrnrs r r4zFileWriter.postProcessingrrrNrjrj)rrrrLr r/r4rrr ririsP """"""""rric eZdZdZddZdZdS) LDIFWriterz Class for writing a stream LDAP search results to a LDIF file Arguments: l LDAPObject instance writer_obj Either a file-like object or a ldif.LDIFWriter instance used for output rjct|tjr||_ntj||_t|||jj||dSr) isinstanceldifrv _ldif_writerrir _output_file)r r writer_objrmrns r r zLDIFWriter.__init__s[*T_--6$d/*55dQt0=i RRRRRrc\|tvr"|\}}|j||dSdSr)rZrzunparser[s r r:zLDIFWriter._processSingleResults>'''hb 5)))))('rNrtrTrrr rvrvsE  SSSS*****rrv)rLldaprryRES_SEARCH_ENTRYRES_SEARCH_RESULTRES_SEARCH_REFERENCEr9rZr rrrNrVr_rirvrrr rs        i   A A A A A A A A H44444 444" " " " " "  " " " ((((($(((2"""""#"""@**********r