o „^Soã @s2dZddlZddlZddlZddlZddlZddlZddlZddlZddl Zddl Zddl Zzddl m Z WneyEddlm Z Ynwej ¡rRddlmZnddlmZzddlmZWn eymddlZYnwejj ddddd d d d d ¡ ZdZej ej  e!¡d¡Z"da#ejj$ %¡ o ejj$ &¡ o ejj$ '¡ Z(dZ)dde)dddddfZ*e dej+fdej,fdej-fdej.fdej/fdej0fdej1fdej2ffƒZ3Gd d!„d!e4ƒZ5d"d#„Z6Gd$d%„d%e7ƒZ8eƒd:d'd(„ƒZ9d)d*„Z:d+d,„Z;dded-fd.d/„Zd4d5„Z?d6d7„Z@d8d9„ZAdS);a Information available about Tor from `its manual `_. This provides three methods of getting this information... * :func:`~stem.manual.Manual.from_cache` provides manual content bundled with Stem. This is the fastest and most reliable method but only as up-to-date as Stem's release. * :func:`~stem.manual.Manual.from_man` reads Tor's local man page for information about it. * :func:`~stem.manual.Manual.from_remote` fetches the latest manual information remotely. This is the slowest and least reliable method but provides the most recent information about Tor. Manual information includes arguments, signals, and probably most usefully the torrc configuration options. For example, say we want a little script that told us what our torrc options do... .. literalinclude:: /_static/example/manual_config_options.py :language: python | .. image:: /_static/manual_output.png | **Module Overview:** :: query - performs a query on our cached sqlite manual information is_important - Indicates if a configuration option is of particularly common importance. download_man_page - Downloads tor's latest man page. Manual - Information about Tor available from its manual. | |- from_cache - Provides manual information cached with Stem. | |- from_man - Retrieves manual information from its man page. | +- from_remote - Retrieves manual information remotely from tor's latest manual. | +- save - writes the manual contents to a given location .. versionadded:: 1.5.0 éN)Ú OrderedDict)Ú lru_cacheÚGENERALÚCLIENTÚRELAYÚ DIRECTORYÚ AUTHORITYÚHIDDEN_SERVICEÚDENIAL_OF_SERVICEÚTESTINGÚUNKNOWNz9https://gitweb.torproject.org/tor.git/plain/doc/tor.1.txtzcached_manual.sqliteéz$CREATE TABLE schema(version INTEGER)z'INSERT INTO schema(version) VALUES (%i)zdCREATE TABLE metadata(name TEXT, synopsis TEXT, description TEXT, man_commit TEXT, stem_commit TEXT)zACREATE TABLE commandline(name TEXT PRIMARY KEY, description TEXT)z=CREATE TABLE signals(name TEXT PRIMARY KEY, description TEXT)z;CREATE TABLE files(name TEXT PRIMARY KEY, description TEXT)z€CREATE TABLE torrc(key TEXT PRIMARY KEY, name TEXT, category TEXT, usage TEXT, summary TEXT, description TEXT, position INTEGER)zGENERAL OPTIONSzCLIENT OPTIONSzSERVER OPTIONSzDIRECTORY SERVER OPTIONSz"DIRECTORY AUTHORITY SERVER OPTIONSzHIDDEN SERVICE OPTIONSz$DENIAL OF SERVICE MITIGATION OPTIONSzTESTING NETWORK OPTIONScs eZdZdZ‡fdd„Z‡ZS)ÚSchemaMismatchz¿ Database schema doesn't match what Stem supports. .. versionadded:: 1.6.0 :var int database_schema: schema of the database :var tuple supported_schemas: schemas library supports cs tt|ƒ |¡||_||_dS©N)ÚsuperrÚ__init__Údatabase_schemaÚlibrary_schema)ÚselfÚmessagerr©Ú __class__©ú-/usr/lib/python3/dist-packages/stem/manual.pyrys zSchemaMismatch.__init__)Ú__name__Ú __module__Ú __qualname__Ú__doc__rÚ __classcell__rrrrros rcGs8tj ¡s tdƒ‚ddl}tdur| t¡at ||¡S)a, Performs the given query on our sqlite manual cache. This database should be treated as being read-only. File permissions generally enforce this, and in the future will be enforced by this function as well. :: >>> import stem.manual >>> print(stem.manual.query('SELECT description FROM torrc WHERE key=?', 'CONTROLSOCKET').fetchone()[0]) Like ControlPort, but listens on a Unix domain socket, rather than a TCP socket. 0 disables ControlSocket. (Unix and Unix-like systems only.) (Default: 0) .. versionadded:: 1.6.0 :param str query: query to run on the cache :param list param: query parameters :returns: :class:`sqlite3.Cursor` with the query results :raises: * **ImportError** if the sqlite3 module is unavailable * **sqlite3.OperationalError** if query fails z$Querying requires the sqlite3 modulerN) ÚstemÚprereqÚis_sqlite_availableÚ ImportErrorÚsqlite3ÚDATABASEÚconnectÚ CACHE_PATHÚexecute)ÚqueryZparamr#rrrr(s   r(c@s<eZdZdZejdddfdd„Zdd„Zdd„Zd d „Z d S) Ú ConfigOptiona¬ Tor configuration attribute found in its torrc. :var str name: name of the configuration option :var stem.manual.Category category: category the config option was listed under, this is Category.UNKNOWN if we didn't recognize the category :var str usage: arguments accepted by the option :var str summary: brief description of what the option does :var str description: longer manual description with details ÚcCs"||_||_||_||_||_dSr©ÚnameÚcategoryÚusageÚsummaryÚ description)rr,r-r.r/r0rrrr¹s  zConfigOption.__init__c Cstjj|dddddddS)Nr,r-r.r/r0T©Úcache©rÚutilZ _hash_attr©rrrrÚ__hash__ÀszConfigOption.__hash__cCót|tƒr t|ƒt|ƒkSdS©NF)Ú isinstancer)Úhash©rÚotherrrrÚ__eq__ÃózConfigOption.__eq__cCó ||k Srrr;rrrÚ__ne__Æó zConfigOption.__ne__N) rrrrÚCategoryr rr6r=r@rrrrr)­s   r)Tc s°tjj ¡‰tj tj t¡d¡}z'ˆ  |¡t ‡‡fdd„ˆ  ¡Dƒƒ}‡fdd„ˆj dgddDƒ|d<|WSt yW}ztjj d||f¡iWYd }~Sd }~ww) aM Provides a dictionary for our settings.cfg. This has a couple categories... * manual.important (list) - configuration options considered to be important * manual.summary.* (str) - summary descriptions of config options :param bool lowercase: uses lowercase keys if **True** to allow for case insensitive lookups z settings.cfgcs0g|]}| d¡rˆr| ¡n|ˆ |¡f‘qS)zmanual.summary.)Ú startswithÚlowerÚ get_value)Ú.0Úkey©ZconfigÚ lowercaserrÚ Ûs0z_config..csg|] }ˆr | ¡n|‘qSr)rD)rFr,)rIrrrJÜsúmanual.importantT)ZmultiplezFBUG: stem failed to load its internal manual information from '%s': %sN)rr4ÚconfÚConfigÚosÚpathÚjoinÚdirnameÚ__file__ÚloadÚdictÚkeysrEÚ ExceptionÚlogÚwarn)rIZ config_pathZ config_dictÚexcrrHrÚ_configÊs  "€þrZc Csvg}dD]±}t||ƒ}t||ƒ}||krµ| d|¡|dvr.| d|¡| d|¡n‚|dkr‚| ¡D]5\}}| |¡}|durK| d|¡q6||krkd D]}t||ƒt||ƒkrj| d ||t||ƒf¡qQq6t| ¡ƒ | ¡¡D] }| d |¡qwn.t| ¡ƒ | ¡¡} t| ¡ƒ | ¡¡} | D] } | d | ¡qš| D] } | d | ¡q¦| d¡qd |¡S)z7 Provides a description of how two manuals differ. )r,Úsynopsisr0Úcommandline_optionsÚsignalsÚfilesÚconfig_optionsz * Manual's %s attribute changed )r,r[r0z Previously... %s z Updating to... %sr_Nz adding new config option => %sr+z modified %s (%s) => %sz removing config option => %sz adding %s => %sz removing %s => %sÚ )ÚgetattrÚappendÚitemsÚgetÚsetrUÚ differencerP) Zprevious_manualZ new_manualÚlinesÚattrZ previous_attrZnew_attrZ config_nameZ config_attrZpreviousZ added_itemsZ removed_itemsZ added_itemZ removed_itemrrrÚ_manual_differencesãs>   €ÿ € ricCs| ¡tƒdvS)zì Indicates if a configuration option of particularly common importance or not. :param str option: tor configuration option to check :returns: **bool** that's **True** if this is an important option and **False** otherwise rK)rDrZ)ÚoptionrrrÚ is_importants rkéc Cs|s|stdƒ‚tjj d¡stdƒ‚t ¡}tj   |d¡}tj   |d¡}zÕz$t |dƒ}t j ||d}t ||¡Wdƒn1sDwYWnt ¡d d …\} } d ||| f} t || | | ¡‚ztjj d |¡tj  |¡s{td ƒ‚Wntjjjy•} z td| j| jfƒ‚d} ~ ww|rÂztj  |¡} tj  | ¡sªt | ¡t ||¡WntyÁ} zt| ƒ‚d} ~ ww|rët |dƒ} t | |¡| ¡Wdƒn1sÞwYWt |¡dSWt |¡dSWt |¡dSt |¡w)a# Downloads tor's latest man page from `gitweb.torproject.org `_. This method is both slow and unreliable - please see the warnings on :func:`~stem.manual.Manual.from_remote`. :param str path: path to save tor's man page to :param file file_handle: file handler to save tor's man page to :param str url: url to download tor's asciidoc manual from :param int timeout: seconds to wait before timing out the request :raises: **IOError** if unable to retrieve the manual z?Either the path or file_handle we're saving to must be providedZa2xz2We require a2x from asciidoc to provide a man pagez tor.1.txtztor.1Úwb)ÚtimeoutNr éz1Unable to download tor's manual from %s to %s: %sza2x -f manpage %szno man page was generatedúUnable to run '%s': %sÚrb)Ú ValueErrorrr4ÚsystemZ is_availableÚIOErrorÚtempfileZmkdtemprNrOrPÚopenÚurllibZurlopenÚshutilÚ copyfileobjÚsysÚexc_infoZDownloadFailedÚcallÚexistsÚOSErrorZ CallErrorZcommandÚstderrrQÚmakedirsÚcopyfileÚflushÚrmtree)rOÚ file_handleZurlrnÚdirpathZ asciidoc_pathZ manual_pathZ asciidoc_fileÚrequestrYZ stacktracerZpath_dirZ manual_filerrrÚdownload_man_pages^ þ€ ÿ€ÿ   €ÿ   þûür‡c@sŠeZdZdZdd„Zeddd„ƒZedd„ƒZed d „ƒZedd d „ƒZ eddd„ƒZ dd„Z dd„Z dd„Z dd„Zdd„Zdd„ZdS) ÚManualaµ Parsed tor man page. Tor makes no guarantees about its man page format so this may not always be compatible. If not you can use the cached manual information stored with Stem. This does not include every bit of information from the tor manual. For instance, I've excluded the 'THE CONFIGURATION FILE FORMAT' section. If there's a part you'd find useful then `file an issue `_ and we can add it. :var str name: brief description of the tor command :var str synopsis: brief tor command usage :var str description: general description of what tor does :var collections.OrderedDict commandline_options: mapping of commandline arguments to their descripton :var collections.OrderedDict signals: mapping of signals tor accepts to their description :var collections.OrderedDict files: mapping of file paths to their description :var collections.OrderedDict config_options: :class:`~stem.manual.ConfigOption` tuples for tor configuration options :var str man_commit: latest tor commit editing the man page when this information was cached :var str stem_commit: stem commit to cache this manual information cCsP||_||_||_t|ƒ|_t|ƒ|_t|ƒ|_t|ƒ|_d|_d|_ d|_ dSr) r,r[r0rr\r]r^r_Ú man_commitÚ stem_commitÚschema)rr,r[r0r\r]r^r_rrrrus     zManual.__init__NcCs2|durt}|dur| d¡rt |¡St |¡S)ax Provides manual information cached with Stem. Unlike :func:`~stem.manual.Manual.from_man` and :func:`~stem.manual.Manual.from_remote` this doesn't have any system requirements, and is faster too. Only drawback is that this manual content is only as up to date as the Stem release we're using. .. versionchanged:: 1.6.0 Added support for sqlite cache. Support for :class:`~stem.util.conf.Config` caches will be dropped in Stem 2.x. :param str path: cached manual content to read, if not provided this uses the bundled manual information :returns: :class:`~stem.manual.Manual` with our bundled manual information :raises: * **ImportError** if cache is sqlite and the sqlite3 module is unavailable * **IOError** if a **path** was provided and we were unable to read it or the schema is out of date Nú.sqlite)r&ÚendswithrˆÚ_from_sqlite_cacheÚ_from_config_cache)rOrrrÚ from_caches   zManual.from_cachec Csvtj ¡s tdƒ‚ddl}tj |¡std|ƒ‚|  |¡“}z'|  d¡  ¡d}|t kr9t dt ||f|t fƒ‚|  d¡  ¡\}}}}}Wn|jy[} ztd|| fƒ‚d} ~ wwt|  d¡ ¡ƒ} t|  d ¡ ¡ƒ} t|  d ¡ ¡ƒ} tƒ} |  d ¡ ¡D]}|\}}}}}t|||||ƒ| |<qt|||| | | | ƒ}||_||_||_|WdƒS1s´wYdS) Nz2Reading a sqlite cache requires the sqlite3 modulerz%s doesn't existzSELECT version FROM schemazAStem's current manual schema version is %s, but %s was version %szISELECT name, synopsis, description, man_commit, stem_commit FROM metadataz,Failed to read database metadata from %s: %sz)SELECT name, description FROM commandlinez%SELECT name, description FROM signalsz#SELECT name, description FROM fileszOSELECT name, category, usage, summary, description FROM torrc ORDER BY position)rr r!r"r#rNrOr}rtr%r'ZfetchoneÚSCHEMA_VERSIONrZOperationalErrorrTZfetchallrr)rˆr‰rŠr‹)rOr#Úconnr‹r,r[r0r‰rŠrYZ commandliner]r^r_Úentryrjr-r.r/Zoption_descriptionÚmanualrrrrŽ¤s8    €ÿ$æzManual._from_sqlite_cachec Cstjj ¡}|j|ddtƒ}| ¡D]:}| d¡rN| d¡d}||vrNt |  d|d¡|  d|d¡|  d |d¡|  d |d¡|  d |d¡ƒ||<qt |  d d¡|  d d¡|  dd¡|  dtƒ¡|  dtƒ¡|  dtƒ¡|ƒ}|  dd¡|_ |  dd¡|_ |S)NF)Z commentingzconfig_options.Ú.r úconfig_options.%s.namer*úconfig_options.%s.categoryúconfig_options.%s.usageúconfig_options.%s.summaryúconfig_options.%s.descriptionr,r[r0r\r]r^r‰rŠ)rr4rLrMrSrrUrCÚsplitr)rdrˆr‰rŠ)rOrLr_rGr”rrrrÊs6   û€      ù zManual._from_config_cacheÚtorc Cs$dtrdnd|f}z tjjj|ddid}Wnty+}ztd||fƒ‚d}~wwt|ƒtƒ}}t   ¡D]\}}t |||  |g¡ƒq8|D]}|  d ¡rc|t vrc|d vrct |tj|  |g¡ƒqItt|  d g¡ƒt|  d g¡ƒt|  d g¡ƒt|  dg¡ƒt|  dg¡ƒt|  dg¡ƒ|ƒS)aí Reads and parses a given man page. On OSX the man command doesn't have an '--encoding' argument so its results may not quite match other platforms. For instance, it normalizes long dashes into '--'. :param str man_path: path argument for 'man', for example you might want '/path/to/tor/doc/tor.1' to read from tor's git repository :returns: :class:`~stem.manual.Manual` for the system's man page :raises: **IOError** if unable to retrieve the manual zman %s -P cat %sz--encoding=asciir*ZMANWIDTHZ10000000)ÚenvrpNz OPTIONS)úCOMMAND-LINE OPTIONSzNON-PERSISTENT OPTIONSÚNAMEZSYNOPSISZ DESCRIPTIONržZSIGNALSZFILES)ÚHAS_ENCODING_ARGrr4rsr|r~rtÚ_get_categoriesrÚCATEGORY_SECTIONSrcÚ_add_config_optionsrdrrBr rˆÚ _join_linesÚ_get_indented_descriptions) Zman_pathZman_cmdZ man_outputrYÚ categoriesr_Zcategory_headerZ category_enumr-rrrÚfrom_manís.€ÿ€ùzManual.from_mané<cCsDt ¡}t||dt |j¡WdƒS1swYdS)a³ Reads and parses the latest tor man page `from gitweb.torproject.org `_. Note that while convenient, this reliance on GitWeb means you should alway call with a fallback, such as... :: try: manual = stem.manual.from_remote() except IOError: manual = stem.manual.from_cache() In addition to our GitWeb dependency this requires 'a2x' which is part of `asciidoc `_ and... isn't quick. Personally this takes ~7.41s, breaking down for me as follows... * 1.67s to download tor.1.txt * 5.57s to convert the asciidoc to a man page * 0.17s for stem to read and parse the manual :param int timeout: seconds to wait before timing out the request :returns: latest :class:`~stem.manual.Manual` available for tor :raises: **IOError** if unable to retrieve the manual )r„rnN)ruZNamedTemporaryFiler‡rˆr§r,)rnÚtmprrrÚ from_remotes   $þzManual.from_remotecCs| d¡r | |¡S| |¡S)aœ Persists the manual content to a given location. .. versionchanged:: 1.6.0 Added support for sqlite cache. Support for :class:`~stem.util.conf.Config` caches will be dropped in Stem 2.x. :param str path: path to save our manual content to :raises: * **ImportError** if saving as sqlite and the sqlite3 module is unavailable * **IOError** if unsuccessful rŒ)rÚ_save_as_sqliteÚ_save_as_config)rrOrrrÚsave:s   z Manual.savec Csjtj ¡s tdƒ‚ddl}|d}tj |¡rt |¡|  |¡y}t D]}|  |¡q$|  d|j |j |j|j|jf¡|j ¡D] \}}|  d||f¡qA|j ¡D] \}}|  d||f¡qS|j ¡D] \}}|  d||f¡qet|j ¡ƒD]\}}|  d|j  ¡|j |j|j|j|j|f¡qyWdƒn1swYtj |¡r­t |¡t ||¡dS) Nz1Saving a sqlite cache requires the sqlite3 modulerz.newz]INSERT INTO metadata(name, synopsis, description, man_commit, stem_commit) VALUES (?,?,?,?,?)z7INSERT INTO commandline(name, description) VALUES (?,?)z3INSERT INTO signals(name, description) VALUES (?,?)z1INSERT INTO files(name, description) VALUES (?,?)zdINSERT INTO torrc(key, name, category, usage, summary, description, position) VALUES (?,?,?,?,?,?,?))rr r!r"r#rNrOr}Úremover%ÚSCHEMAr'r,r[r0r‰rŠr\rcr]r^Ú enumerater_ÚvaluesÚupperr-r.r/Úrename) rrOr#Ztmp_pathr’ÚcmdÚkÚvÚirrrr«Qs.      ,ÿñ  zManual._save_as_sqlitecCs^tjj ¡}| d|j¡| d|j¡| d|j¡|jr%| d|j¡|j r/| d|j ¡|j   ¡D]\}}|jdd||fdd q4|j   ¡D]\}}|jd d||fdd qJ|j   ¡D]\}}|jd d||fdd q`|j  ¡D]1\}}| d ||j¡| d ||j¡| d||j¡| d||j¡| d||j¡qv| |¡dS)Nr,r[r0r‰rŠr\z%s => %sF)Z overwriter]r^r—r–r˜r™rš)rr4rLrMrer,r[r0r‰rŠr\rcr]r^r_r-r.r/r­)rrOrLrµr¶rrrr¬rs* zManual._save_as_configc Cstjj|ddddddddd S) Nr,r[r0r\r]r^r_Tr1r3r5rrrr6r>zManual.__hash__cCr7r8)r9rˆr:r;rrrr=“r>z Manual.__eq__cCr?rrr;rrrr@–rAz Manual.__ne__r)rœ)r¨)rrrrrÚ staticmethodrrŽrr§rªr­r«r¬r6r=r@rrrrrˆZs& " % " * !! rˆcCs|rd|dvr|dd…}|r|d d¡r|dd…}tƒ}dg}}|D]R}tj ¡r0tnt}| |dƒd¡ |d ƒd ¡ |d ƒd ¡}|ri| d ¡si|ra|r]|ddkr]|dd…}|||<| ¡g}}q'| d¡rt|dd…}|  |¡q'|r€|||<|S)z The man page is headers followed by an indented section. First pass gets the mapping of category titles to their lines. zTOR(1)rr NéÿÿÿÿZTori ú'i ú-é·Ú*ú r*z é) rCrrr Z is_python_3ÚchrZunichrÚreplaceÚstriprb)Zcontentr¦r-rgÚlineZchar_forrrrr¡šs*   (    r¡cCs|tƒd}}|D]*}|dkrd}q|r | d¡s g|||<}q|r2| d¡r2|| |dd…¡qtdd„| ¡DƒƒS)a÷ Parses the commandline argument and signal sections. These are options followed by an indented description. For example... :: -f FILE Specify a new configuration file to contain further Tor configuration options OR pass - to make Tor read its configuration from standard input. (Default: /usr/local/etc/tor/torrc, or $HOME/.torrc if that file is not found) There can be additional paragraphs not related to any particular argument but ignoring those. Nz Noter¾ú écSs"g|] \}}|r|d |¡f‘qS)r¾)rP)rFÚargZ desc_linesrrrrJäs"z._get_indented_descriptions..)rrCrbrTrc)rgÚoptionsZlast_argrÃrrrr¥És €r¥csº‡‡‡fdd„‰dd„t|ƒDƒ}|r$|t|ƒd…}|| d¡d…}dg}}|D]&}|rA| d¡sA|r;ˆ||ƒ|g}}q+| d¡rL|d d…}| |¡q+|r[ˆ||ƒdSdS) ai Parses a section of tor configuration options. These have usage information, followed by an indented description. For instance... :: ConnLimit NUM The minimum number of file descriptors that must be available to the Tor process before it will start. Tor will ask the OS for as many file descriptors as the OS will allow (you can find this by "ulimit -H -n"). If this number is less than ConnLimit, then Tor will refuse to start. You probably don't need to adjust this. It has no effect on Windows since that platform lacks getrlimit(). (Default: 1000) csˆd|vrdSd|vr| d¡D]}ˆ||ƒqdSd|vr#| dd¡n|df\}}tƒ d| ¡d¡}t|ˆ||t|ƒ ¡ƒˆ|<dS)NzPER INSTANCE OPTIONSz, r¾r r*zmanual.summary.%s)r›rZrdrDr)r¤rÂ)Útitler0Zsubtitler,r.r/©Ú add_optionr-r_rrrÊùs ÿ  z'_add_config_options..add_optioncSs$g|]\}}d|vsd|vr|‘qS)zThe following optionszPER SERVICE OPTIONSr)rFr·rÃrrrrJ s$z'_add_config_options..Nr*r¾rÄrÅ)r°ÚmaxÚindexrCrb)r_r-rgZ end_indicesZ last_titler0rÃrrÉrr£çs"      ÿr£cCsJg}|D]}|s|r|ddkr| d¡q| |d¡qd |¡ ¡S)zI Simple join, except we want empty lines to still provide a newline. r¹r`r*)rbrPrÂ)rgÚresultrÃrrrr¤%s €r¤)T)BrrNrxrzrurZ stem.prereqZ stem.utilZstem.util.confZstem.util.enumZ stem.util.logZstem.util.systemÚ collectionsrr"Zstem.util.ordereddictr Z_is_lru_cache_availableÚ functoolsrZstem.util.lru_cacheZurllib.requestr†rwZurllib2r4ÚenumÚEnumrBZGITWEB_MANUAL_URLrOrPrQrRr&r$rsZis_macZis_bsdZ is_slackwarer r‘r¯rrrrrr r r r¢rtrr(Úobjectr)rZrirkr‡rˆr¡r¥r£r¤rrrrÚs€/ ÿ    ÿ*ø ø . - =B/ >