a \ hX@sdZddlZddlZddlZddlZGdddZGdddZGdddZGd d d ZGd d d Z e d krddl Z e dS)z @modified: April 25, 2025 @author: Dale Hamel @author: Brian Fristensky @contact: frist@cc.umanitoba.ca The purpose of this class is to Provide support for the various actions that are repeated by several different python scripts Nc@sreZdZdZddZddZddZdd Zd d Zdd dZ ddZ ddZ ddZ ddZ ddZddZdS)Birchmodz Purpose: This class provides common safety features to scripts, as well as making user interactions more intuitive. In particular, this class is intended to provide user-readable information when an error occurs cCs||_||_dS)zBInitializes birchmod to contain the program usage and program nameN)PROGRAMUSAGE)selfZprogZuser2/home/psgendb/BIRCHDEV/install-scripts/birchlib.py__init__szBirchmod.__init__cCsddlm}|dS)z0return the location of the user's home directoryr) expanduser~)Zos.pathr )rr rrr getHomeDirs zBirchmod.getHomeDircCsptjd}|dkrhtjd}tj|ddd}t|d}|}tdd |Drht d d }t |S) areturn user's email address This is currently a bit of a hack. We need to find a better way to do this. 1. If MAILID environment variable is set, use that. 2. If MAILID="", then use the mailid in $BIRCH/local/admin/BIRCH.properties ZMAILIDBIRCHlocaladminBIRCH.propertiesrcss|]}|dVqdS)zBirchProps.adminEmailN) startswith).0linerrr 0z(Birchmod.getEmailAddr..=) osenvirongetpathjoinopen readlinesanyrstripsplitstr)rZ emailaddrr ZpropfileZ propfile_hlinesrrr getEmailAddr#s   zBirchmod.getEmailAddrc Cstj|ddd}t|d}d}d|}|}|t|}|dkrd} | |kr|dkr|| } | ds| d } | d|kr| d  }| d 7} qL|S) z Retrieve a value from BIRCH.properties. eg. To retrieve the value of BirchProps.adminEmail: GetBIRCHProperties(BIRCHDIR,"adminEmail") rrrrr z BirchProps.r#rr) rrrrrcloselenrr"r!) rZBIRCHDIRZPropNameZPFNZpfileValueZTargetr$ZplenirtokensrrrGetBIRCHProperties4s"      zBirchmod.GetBIRCHPropertiescsbtd|d|dddl}d fdd }|j|}|}t|d}|||dS) zQDownloads from url specified to the filename/path specified and displays progressz Fetching z from z rNcsrzt||d|d}Wnd}Yn0|dkrnd}jdt|ddt||d}tj|dS)Ndri@Bz Progress:%z of zMB )minrr#sysstdoutwrite)Z numblocks blocksizeZfilesizeurlZpercentZMB_CONSTZout_strrrr reporthookRs *z!Birchmod.wget..reporthookwb)N)printZurllib.requestZrequestZurlopenreadrr2r')rr4nameZurllibr6ZresponseZcontentfrr5rwgetNs   z Birchmod.wget.cCs t|}|||dS)zSExtracts the tarfile given by file to current working directory by default, or pathN)tarfiler extractallr')rfilerZtarballrrruntarcs  zBirchmod.untarcCstj|rt|dS)z5Mimics the behavior or unix rm -rf for the given pathN)rrexistsshutilrmtree)rrrrrrmrfps z Birchmod.rmrfcCst|j|jtdS)zsCalled when a program performs an illegal operation. Causes program to print its appropriate usage, and exit nicelyN)r8rr SystemExitr5rrr printusagevszBirchmod.printusagecCslt|}t|jd|dtj|rBt|jd|dn"t|jd|dtdtdS)zKCalled when reading a file fails, used to provide more comprehensive outputz2An error occurred trying to process file named : ''z The file 'z"' exists, but may not be accessed.z' does not exist in 'N)r#r8rrrisfilegetcwdrF)r file_namerrr file_error}s  "zBirchmod.file_errorcCst|jdtdS)zRUsed to indicate to the user that a script did execute, and completed successfullyz Successfully completed executionN)r8rrFr5rrr exit_successszBirchmod.exit_successcCs0t|tst|jdn|tjvr(dSdSdS)z?Returns true if "argId" was a string passed on the command linez/Argument to be check for not supplied as stringTFN) isinstancer#r8rr0argv)rargIdrrr arg_givens   zBirchmod.arg_givencCs4|dr,t|jdddl}|dSdSdS)ztcalled by using "pydoc {path to script} pydoc" * note must pass "pydoc" as an argument to toggle documentation mode*z-pydoczGenerating documentation...rNTF)rQr8rdoctesttestmod)rrRrrr documentors  zBirchmod.documentorN)r=)__name__ __module__ __qualname____doc__rr r%r,r<rArErGrLrMrQrTrrrrrs  rc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)Argumenta" The purpose of this class is to provide a simplified and common way for all scripts retrieve arguments from the command line parameters provided (sys.argv) This is done by declaring an Argument variable, and specifying any advanced attributes with the various augmentation methods provided. BUG: Argument will split up a quoted command line argument containing blanks into individual tokens. Eg. 'this should be a single argument'. DEPRECATED in favor of optparse. Even optparse is deprecated in favor of agrparse, but argparse is new in Python 2.7. Therefore, it is safer to use optparse, which has a very similar syntax to argparse, unless you are sure you will be using Python 2.7 or later. It is also worth mentioning that optparse will correctly parse command line arguments enclosed in quotes. There have been reports that argparse will break up strings between blank spaces. Examples: # optional arguments with parameters self.AInf = Argument("-inf", str, BM) self.AInf.set_optional() self.AOutf = Argument("-outf", str, BM) self.AOutf.set_optional() # optional argument with no parameters ie. switch self.AInvert = Argument("-inv", str, BM) self.AInvert.set_is_switch() self.AInvert.set_optional() # required arguments at a specific position. Ainfile = Argument("", str, BM) Ainfile.set_position(-2) Aoutfile = Argument("", str, BM) Aoutfile.set_position(-1) try: if (BM.arg_given("-inf")): self.InFormat = self.AInf.fetch() if (BM.arg_given("-outf")): self.OutFormat = self.AOutf.fetch() self.Invert = BM.arg_given("-inv") self.Ifn = Ainfile.fetch() self.Ofn = Aoutfile.fetch() except ValueError: BM.printusage() cCsnt||_d|_d|_d|_d|_d|_t|tr:||_ n|dkrPd|_d|_ nt t|t rf||_nt dS)a Initializer: arg_id: The command line flag that specifies an argument parameter is to follow, ex: "-o outfile" type: The type that the argument is. This must be a basic type, such as str, float, bool. if you are unsure if something is a basic type, try running "type(yourtypename)" at interpretter BM: a pointer to the Birchmod module for the class using this argument (they are coupled) TrNF) r#arg_id is_requiredpositionexcludeis_flagBMrNtypearg_type ValueErrorr)rrZraZBMODrrrrs   zArgument.__init__cCst||_dS)a| Specify the position on sys.argv where the argument is always found. Argument 0 is the name of the program, so argument 1 is the first argument. Note that arguments near the end can be specified by len(sys.argv)-X, where X is the index from the end. "-1" refers to the last argument, "-2" refers to the next to last argument, etc. N)intr\)rr\rrr set_positionszArgument.set_positioncCs<||jkrt|jjd|jdkr,t|_|j|dS)z`Add an argument (flag) to the list of mutually exclusive argument flags for this Argument's flagz"An argument may not exclude itselfN)rZr8r_rr]listappend)rr]rrr add_exclusive s   zArgument.add_exclusivecCs d|_dS)z/Use this if the paramter passed is NOT requiredFN)r[r5rrr set_optionalszArgument.set_optionalcCsd|_d|_dS)zcif this argument is just a switch (with no parameters), set this to true (ex ls -l, -l is a switch)TN)r^rar5rrr set_is_switchszArgument.set_is_switchcCsHt|jdkr2|jttjkr,tj|j}ntn|jr|jdkr|jD]B}|tjvrH|jtjvrHt |j j d|d|jdt qH|jtjv}nl|j r|jtjvrt tjtn ||j}n<|jdkr|jD]}|tjvr|jtjvrtq||j}|jdkr*|jtjvr*||}|jtkrD|dkrDd}|S)zh This method attempts to fetch the argument with the specified attributes from sys.argv rNz+Cannot combine mutually exclusive options "z" and ""r )absr\r(r0rOrbr^r]rZr8r_rexitr[_Argument__get_argrar#)rZ to_returnZeachrrrfetch"s4  "      zArgument.fetchcCslt|}z2tj|d}|ttjkr4tj|WStWn,tyft|jjd|dYdS0dS)z Used as a helper method. Retrieves a flags parameter, assuming it is one index to the right. ex "-o outfile", if argId= -o, this will return outfile rz Argument z not supplied at command line.N) r#r0rOindexr(rbr8r_r)rrPr\rrrZ __get_arg^s  zArgument.__get_argN) rUrVrWrXrrdrgrhrirnrmrrrrrYs4#   Nr2)rhtmlfiletagname attributesrrrstarts zHTMLWriter.startcCs|d|ddS)z Write end tag @param htmlfile: The of the html file to write tag for @type htmlfile: str @param tagname: The name of the tag to write @type tagname: str birch - z Nr{)rr|titlerrr page_titles zHTMLWriter.page_titlecCs&|d|d|d|ddS)z FIXME @param htmlfile: @type htmlfile: @param url: @type url: @param attributes: @type attributes: @param text: @type text: z ruz
N)r2rrrr)rr|rr~r4rrrr start_pages   zHTMLWriter.start_pagecCs,d}||d|||||ddS)z} FIXME @param htmlfile: @type htmlfile: @param text: @type text: z style="margin-left: 40px;"ZdivN)rr2r)rr|rr~rrr indent_texts  zHTMLWriter.indent_textcCs||d||ddS)zP FIXME @param htmlfile: @type htmlfile: rrN)r)rr|rrrend_pages zHTMLWriter.end_pageN)rUrVrWrXrrwrxrrrrrrrrrrrrpos      rpc@s4eZdZddZddZddZddZd d Zd S) HtmlutilscCs||_||_dS)z FIXME @param CATDICT: @type CATDICT: @param PROGDICT: @type PROGDICT: N)CATDICTPROGDICT)rrrrrrrszHtmlutils.__init__cCsL|}d}|t|krH||d||<||dd||<|d}q |S)z` FIXME @param line: @type line: rrj\r )r"r(r!replace)rrr+r*rrrtokenizes   zHtmlutils.tokenizecsGfdddt}|S)a this function simplifies the transition to python 3 by eleiminating the need for the "cmp" function this was a recommended workaround for using "cmp"'s in sorts (recommended by: http://wiki.python.org/moin/HowTo/Sorting/) cs\eZdZddZfddZfddZfddZfd d Zfd d Zfd dZ dS)zHtmlutils.cmp_to_key..KcWs ||_dS)z FIXME @param obj: @type obj: @param *args: @type *args: Nobj)rrargsrrrr!sz(Htmlutils.cmp_to_key..K.__init__cs|j|jdkSz FIXME @param other: @type other: rrrothermycmprr__lt__*sz&Htmlutils.cmp_to_key..K.__lt__cs|j|jdkSrrrrrr__gt__1sz&Htmlutils.cmp_to_key..K.__gt__cs|j|jdkSrrrrrr__hash__8sz(Htmlutils.cmp_to_key..K.__hash__cs|j|jdkSrrrrrr__le__?sz&Htmlutils.cmp_to_key..K.__le__cs|j|jdkSrrrrrr__ge__Fsz&Htmlutils.cmp_to_key..K.__ge__cs|j|jdkSrrrrrr__ne__Msz&Htmlutils.cmp_to_key..K.__ne__N) rUrVrWrrrrrrrrrrrK s     r)object)rrrrrr cmp_to_keys4zHtmlutils.cmp_to_keycCs*|ddkr"|d|dd}n|}|S)z FIXME @param name: @type name: @param doc_prefix: @type doc_prefix: r$/rNr)rr:Z doc_prefixr4rrr name_to_urlVs zHtmlutils.name_to_urlcCsjt|d}d}|D] }|dkr*|d|_|d}q||jddks\|jddkrbd}nd }|S) z FIXME @param fn: @type fn: @param p: @type p: rrrqz\szhttp://rzfile:///TF)rr! DOCPREFIXr'find)rfnpr@r*rZokayrrr get_prefixjs    zHtmlutils.get_prefixN)rUrVrWrrrrrrrrrrs  ;rc@s eZdZdZddZddZdS) SimpleXMLzOSimple methods for working wth XML files as an alternative to xml or defusedxmlcCsdS)z Nrr5rrrrszSimpleXML.__init__c Csd}d|d}d|d}t|d}|}d}|dkr|dkr||} ||} | dkrz| dkrz|| t|| }|}q2||S)a  return a string value from a field of the form Value This function ONLY returns the first field in the file that matches the pattern, regardless of how many subsequent fields may match. r ryrrr)rreadlinerr(r') rFileZ FieldNamer)Z BeginTargetZ EndTargetZ h_XMLFilerZPOSNZLPOSNZRPOSNrrr GetXMLFields      zSimpleXML.GetXMLFieldN)rUrVrWrXrrrrrrrsr__main__) rXrr0r>rCrrYrprrrUrRrSrrrrs G