o ú½“h”ã@srdZddlZddlZddlZddlZej d¡Zej  e¡ddl m Z ddl m Z ddl m Z dZdZe eeƒZgZiZiZiZiZe eeƒZGd d „d ƒZd d „Zd d„Zdd„ZGdd„dƒZdd„ZGdd„dƒZdd„ZGdd„dƒZdd„Z dd„Z!Gdd „d ƒZ"d!d"„Z#d#d$„Z$d%d&„Z%d'd(„Z&d)d*„Z'd+d,„Z(e)d-kr·e *¡s¬d.ej+vr®dSe(ƒe ,¡dSdS)/zÌ htmldoc.py - Create web pages for BIRCH documentation from birchdb database Synopsis: htmldoc.py @modified: July 25, 2023 @author: Brian Fristensky and Dale Hamel @contact: frist@cc.umanitoba.ca éNÚBIRCHLIB)ÚBirchmod)Ú Htmlutils)Ú HTMLWriterz htmldoc.py: z3 USAGE: htmldoc.py [currently takes no paramters]c@seZdZdZdd„ZdS)Ú Parametersz#Wrapper class for global parameterscCs d}tj |¡r@tdƒd|_d|_t|dƒ}|D]!}| d¡}|ddkr-|d ¡|_|dd kr:|d ¡|_q|  ¡n td ƒtj d |_d}ztj d }WnY|dkr_||_td |jƒtd|jƒ|jd|_ |jd|_ |jd|_ d|_d|_d|_d|_d|_dS)a. Get the location of the BIRCH home directory, BIRCHPATH Preferrably, we get it from the BIRCH.properties file, but if that isn't found, we get it from the BIRCH environment variable. The one catch is that since we don't already know the location of BIRCHPATH, the former will only work if the current working directory is install-scripts. Normally, this would only be used when installing or updating BIRCH Otherwise, the environment variable will be read. z../local/admin/BIRCH.propertiesz0htmldoc.py: Reading $BIRCH from BIRCH.propertiesÚÚrú=rzBirchProps.homedirézBirchProps.platformzEhtmldoc.py: Reading $BIRCH and $BIRCH_PLATFORM environment variables.ÚBIRCHÚBIRCH_PLATFORMzhtmldoc.py: BIRCHPATH set to: z#htmldoc.py: BIRCH_PLATFORM set to: z /public_htmlz/public_html/birchdbz/local/public_html/birchdbN)ÚosÚpathÚexistsÚprintÚ BIRCHPATHr ÚopenÚsplitÚstripÚcloseÚenvironÚ BIRCHWEBPATHÚ BIRCHDBPATHÚBIRCHLOCALDBPATHÚBFNÚLFNÚINFILEÚOFNÚOUTFILE)ÚselfÚFNÚFILEÚLINEÚTOKENSÚplat©r%ú,/home/birch/BIRCH/install-scripts/htmldoc.pyÚ__init__)sB     €      zParameters.__init__N)Ú__name__Ú __module__Ú __qualname__Ú__doc__r'r%r%r%r&r&s rcCsŠddl}t |j¡|jd|j}| d|j|j|dg¡}| ¡tj  |j d¡rCt |j ¡| d|j|j |dg¡}| ¡dSdS)zƒ Dump the core BIRCH and local databases to .ace files @param P: Instasnce of Paramters object @type P: Parameters rNz/bin-z ./tbirchdb.shz tace.inputz/database/ACEDB.wrm) Ú subprocessr Úchdirrrr ÚPopenÚwaitrrr)ÚPr,ÚTACEDIRÚpr%r%r&Ú DUMPTOACEas   ýr3cCsL| d¡}| d¡}||d|…}| dd¡}| dd¡}| dd¡}|S) al Read the first string delimited by double quotes @param LINE: The line to be cleaned up @type LINE: str Each quoted line is modified as follows: escape characters \ added by ACEDB are deleted '>' and '<' characters are changed to '>' and '<' so they are not accidentally recognized by HTML as tag delimiters. ú"r ú\rú>z>úrD)r@ÚC©ÚCATSr%r&ÚAssignCategoryÀóý z$ReadCategory..AssignCategoryrzCategory\s:\s".+"úProgram\s+".+"r úPackage\s+".+"N) r rrrÚreÚmatchr=ÚHTÚtokenizerArErFr)r rNrOr!r"rLr#r%rMr&Ú ReadCategoryµs       € ñrWc@rB)ÚPackagecCs4d|_d|_g|_g|_g|_g|_g|_g|_dS)a Initializes arguments: name="" description="" category=[] doc=[] program=[] data=[] platform=[] installation=[] rN)rDÚ descriptionÚcategoryÚdocrEÚdataÚplatformÚ installationrGr%r%r&r'ès  zPackage.__init__NrHr%r%r%r&rXærIrXcsh‡fdd„}tj |¡r²t|dƒ}|D]˜}t d|¡r"|t|ƒƒ}qt d|¡r.t|ƒ|_qt d|¡rBt  |¡}t |j |dƒqt d|¡rVt  |¡}t |j |dƒqt d |¡rjt  |¡}t |j |dƒqt d |¡r~t  |¡}t |j|dƒqt d |¡r’t  |¡}t |j|dƒqt d |¡rŸt |jd ƒqt d |¡r«t |jd ƒq| ¡dSdS)zÎ Read package.ace into a list of Package objects @param FN: The name of the file to be read in @type FN: str @param PKGS: The list of package objects to be read into @type PKGS:list crJ)zã If a package called NAME already exists, return a pointer If it does not exist, create a new package object and return a pointer @param NAME:The name to attempt to assign @type NAME:str )ÚPKGDICTrXr>rD)r@ÚPK©ÚPKGSr%r&Ú AssignPackage rPz"ReadPackage..AssignPackagerzPackage\s:\s".+"úDescription\s+".+"úCategory\s+".+"r úDocumentation\s+".+"rQú Data\s+".+"úPlatform\s+".+"r ÚlocalN)r rrrrSrTr=rYrUrVrArZr[rEr\r]r^r)r rbrcr!r"r`r#r%rar&Ú ReadPackageþs<                  € årjc@rB)ÚProgramcCs@d|_d|_g|_g|_d|_g|_g|_g|_g|_g|_ dS)aA Initializes arguments: name="" description="" category=[] interface=[] package="" doc=[] data=[] sampleinput=[] sampleoutput=[] platform=[] rN) rDrYrZÚ interfaceÚpackager[r\Ú sampleinputÚ sampleoutputr]rGr%r%r&r'9s zProgram.__init__NrHr%r%r%r&rk7rIrkcsê‡fdd„}tj |¡rót|dƒ}|D]×}t d|¡r$|t|ƒƒ}qt d|¡r0t|ƒ|_qt d|¡rDt  |¡}t |j |dƒqt d|¡rU|j   d t|ƒg¡qt d |¡rf|j   d t|ƒg¡qt d |¡rw|j   d t|ƒg¡qt d|¡rŽ| dd¡|j   dt|ƒg¡qt d|¡rŸ|j   dt|ƒg¡qt d|¡r°|j   dt|ƒg¡qt d|¡rÁ|j   dt|ƒg¡qt d|¡rÒ|j   dt|ƒg¡qt d|¡rã|j   dt|ƒg¡qt d|¡rô|j   dt|ƒg¡qt d|¡r|j   dt|ƒg¡qt d|¡r|j   d t|ƒg¡qt d!|¡r*|j   d"t|ƒg¡qt d#|¡r<|j   d$t|ƒg¡qt d%|¡rN|j   d&t|ƒg¡qt d'|¡r`|j   d(t|ƒg¡qt d)|¡rr|j   d*t|ƒg¡qt d+|¡r„t  |¡}|d|_qt d,|¡r™t  |¡}t |j|dƒqt d-|¡r®t  |¡}t |j|dƒqt d.|¡rÃt  |¡}t |j|dƒqt d/|¡rØt  |¡}t |j|dƒqt d0|¡rìt  |¡}t |j|dƒq| ¡d1Sd1S)2z× Read program.ace into a list of Program objects @param FN: The name of the file to be read in @type FN: str @param PROGS: The list of Program objects to read the file into @type PROGS: list crJ)zå If a program called NAME already exists, return a pointer If it does not exist, create a new program object and return a pointer @param NAME: The name to attempt to assign @type NAME: str )ÚPROGDICTrkr>rD)r@ÚPR©ÚPROGSr%r&Ú AssignProgram^rPz"ReadProgram..AssignProgramrzProgram\s:\s".+"rdrer zcommand\s+".+"Úcommandzinteractive\s+".+"Ú interactivez gui\s+".+"Úguiz_birch_\s+".+"Ú_birch_Úbirchzbirchadmin\s+".+"Ú birchadminz bldna\s+".+"Úbldnazblnalign\s+".+"Úblnalignzblprotein\s+".+"Ú blproteinzblpalign\s+".+"Úblpalignz bldata\s+".+"Úbldatazblmarker\s+".+"Úblmarkerzblnfetch\s+".+"Úblnfetchzblpfetch\s+".+"Úblpfetchzblreads\s+".+"Úblreadsz blncbi\s+".+"Úblncbizbltable\s+".+"Úbltablez bltree\s+".+"ÚbltreerRrfrgzSample_input\s+".+"zSample_output\s+".+"rhN)r rrrrSrTr=rYrUrVrArZrlr>r:rmr[r\rnror]r)r rsrtr!r"rqr#r%rrr&Ú ReadProgramSs†                          € ¸r‡c Csò dd„}t|dƒ}tƒ}| |d¡| |dd¡| |dd¡| |dd¡tt ¡ƒ}|jd d „d |D])}t|}||ƒ| |d d¡|jd }|jd}|  ||d|¡|  |d ¡q8|  |d¡|  |¡|  ¡t  |d¡dS)zR FIXME @param catfn: @type catfn: c Ss< |jd}t|dƒ}tƒ}| |d|j¡| |dd¡| |dd¡| d¡| |d¡| |dd¡|jjd d „d |jD]=}| |d d¡d |d}z|dt |j d}|  ||d|¡WqCt y€t d|ƒ|  |ddd|¡YqCw| |d ¡| |d¡| |¡| ¡t |d¡dS)z> FIXME @param c: @type c: ú.htmlÚwz category: ÚhrrÚh1z programs:ÚulcSó| ¡S©N©Úlower©rDr%r%r&ÚÔóz7write_category_page..writecat..©ÚkeyÚliú ../program/ú - Ú zIn writecat: KeyError: z KeyError: é´N)rDrrÚ start_pageÚstartÚwriteÚendrEÚsortrprYÚlinkÚKeyErrorrÚend_pagerr Úchmod)ÚcÚcatfnÚ catpagefileÚhÚpnameÚurlÚtextr%r%r&ÚwritecatÁs4        þ   z%write_category_page..writecatr‰zprograms by categoryrŠrÚbrrŒcSrrŽrr‘r%r%r&r’ör“z%write_category_page..r”r–rˆr™ršN)rrr›rœÚlistrKÚkeysrŸrDr ržr¢rr r£) r¥r«Úcatfiler§ÚcatlistÚcatkeyr¤r©rªr%r%r&Úwrite_category_page¸s, )      r²c@rB)ÚFilecCsd|_d|_d|_d|_dS)z« Initializes arguments: name="" description="" command='"$ACE_FILE_LAUNCHER" ' path="" rz"$ACE_FILE_LAUNCHER" N)rDrYrurrGr%r%r&r's z File.__init__NrHr%r%r%r&r³rIr³csŽ‡fdd„}tj |¡rEt|dƒ}|D]+}t d|¡r"|t|ƒƒ}qt d|¡r.t|ƒ|_qt d|¡r>t  |¡}|d|_q|  ¡dSdS) zÎ Read file.ace into a list of file objects @param FN: The name of the file to be read in @type FN: str @param DOCFILES: the list of file objects to be read into @type DOCFILES: list crJ)z× If a file called NAME already exists, return a pointer If it does not exist, create a new file object and return a pointer @param NAME: The name to attempt to assign @type NAME: str )ÚDOCDICTr³r>rD)r@ÚFL©ÚDOCFILESr%r&Ú AssignFile rPz ReadDocFiles..AssignFilerz File\s:\s".+"rdzPick_me_to_call\s+".+"éN) r rrrrSrTr=rYrUrVr)r r·r¸r!r"rµr#r%r¶r&Ú ReadDocFiless        € ôrºcCs0tj |¡r t |¡t |¡t |d¡dS)z± Delete an existing directory and create an empty directory with the same name. @param DIRNAME: The name of the directory to be refreshed @type DIRNAME: str iýN)r rÚisdirÚshutilÚrmtreeÚmkdirr£)ÚDIRNAMEr%r%r&ÚFreshDirBs   rÀc s‡fdd„}t|dƒ}tƒ}| |d¡| |dd¡| |dd¡| |dd¡tt ¡ƒ}|jd d „d |D]1}t|}||ƒ| |d d¡|jd }|jdt|jj d} |  ||d| ¡|  |d ¡q9|  |d¡|  |¡|  ¡t |d¡dS)zÓ Write HTML page listing program packages. @param PKGFN: The name of the html page to be created @type PKGFN: str @param P: An instance of the Paramaters object @type P: Paramters object c sÐ|jd}t|dƒ}tƒ}| |d|j¡d}| |d|¡d}| |d|¡d}| |d|¡d}| |d |¡d}| |d |¡| |jd |j¡| |d ¡| |d ¡| |d¡t||d |j t ˆƒt||d |j t ˆƒd}| |d|¡d}| |d |¡d}| |d |¡d}d}d}|  ||||¡| d¡| |d ¡d}|j D]}| |¡|d}|t|j ƒkrÄ| d¡q­| |d ¡| |d¡d}| |d|¡d}| |d |¡d}| |d |¡d}d}d}|  ||||¡| d¡| |d ¡d}|jD]} | | ¡|d}|t|jƒkr"| d¡q | |d ¡| |d¡d}| |d|¡d}| |d |¡d}| |d |¡d}d}d}|  ||||¡| d¡| |d ¡| |d ¡| |d¡d}| |d|¡d}| |d |¡| |dd¡|jjdd„d|jD])} | |dd¡d | d}| d t| jd!}|  ||d|¡| |d¡q•| |d¡| |d ¡| |d¡| |d¡| |¡| ¡t |d"¡d#S)$zs Write a page for a given package @param PK: The name of the package @type PK: str rˆr‰z Package: ú1 style="font-family: helvetica,arial,sans-serif;"ÚtablerÚtrúE colspan="2" rowspan="1" style= "background-color: rgb(51, 255, 51);"ÚtdÚbigr˜Ú DocumentationÚDataúG colspan="2" rowspan="1" style= "background-color: rgb(204, 204, 204);"ú!../Doc_definitions.html#PlatformsÚ Platformsútarget="FrameWindow"ú: rr ú, z$../Doc_definitions.html#InstallationÚ Installationz ../Doc_definitions.html#ProgramsÚProgramszG colspan="2" rowspan="1" style= "background-color: rgb(255, 255, 255);"rŒcSrrŽrr‘r%r%r&r’Ér“z4WritePackagePage..WritePkg..r”r–r—r™ršN)rDrrr›rœrrYržÚDocRowsr[r´r\r r]Úlenr^rErŸrpr¢rr r£) r`ÚPKGFNÚ PKGPAGEFILEÚHÚ ATTRIBUTESÚURLÚTEXTr;ÚPLATÚINSTÚPNAME©r0r%r&ÚWritePkg\s¾          €       €             z"WritePackagePage..WritePkgr‰zPrograms by PackagerŠrr¬rŒcSrrŽrr‘r%r%r&r’çr“z"WritePackagePage..r”r–rˆr˜r™ršN)rrr›rœr­r_r®rŸrDrYr ržr¢rr r£) rÓr0rÝÚPKGFILErÕÚPKGLISTÚPKGKEYr`r×rØr%rÜr&ÚWritePackagePageQs* ~     rác Cs@d}| |d|¡d}| |d|¡d}| |d|¡d| dd¡}|}d }| ||||¡| |d¡| |d¡| |d¡|D]Z} d}| |vr|| } t| jƒd kr| |d|¡d }| |d|¡| j} | || ¡| |d¡d }| |d|¡t  | j|j ¡}| j}| ||d|¡| |d¡| |d¡qCd S) a& Write rows for documentation lines: Documentation, Data, Sample input, Sample output @param OUTFILE: The name of the output file @type OUTFILE: str @param H: An instance of HTMLWriter @type H: HTMLWriter @param HEADING: The heading to place in each row @type HEADING: str @param FILELIST: The list of files to be documented @type FILELIST: list @param D: The dictionary to use for documentation @type D: dictionary @param P: An instance of the Parameters class @type P: Parameters object rrÃrÉrÅrÆz../Doc_definitions.html#ú Ú_rÌrúR border="0" colspan="1" rowspan="1" style= "background-color: rgb(255, 255, 255);"N) rœr:r ržrÒrrYÚ indent_textrUÚ name_to_urlÚ DOCPREFIX) rrÕÚHEADINGÚFILELISTÚDr0rÖr×rØÚDOCNAMEÚDOCUMENTÚDOCTYPEr%r%r&rÑøsB       €ïrÑc Csôdd„}t|dƒ}tƒ}| |d¡| |dd¡| |dd¡tt ¡ƒ}|jdd „d |D]2}t|}|||ƒ| |d d¡|jd }|jd t|jj d} |  ||d| ¡|  |d ¡q0|  |d¡|  |¡|  ¡t |d¡dS)zá Write HTML page listing programs in alphabetical order. @param PROGFN: The basename of the page to be written @type PROGFN: str @param P: An instance of the Parameters class @type P: Paramters object c Ss´|jd}t|dƒ}tƒ}| ||j¡d}| |d|¡d}| |d|¡d}| |d|¡d}| |d|¡d}| |d |¡| |jd |j¡| |d ¡| |d¡| |d¡d}| |d|¡d }| |d|¡d}| |d |¡d }d }d}| ||||¡| |d ¡| |d¡| |d¡|j D]M}d}| |d|¡d}| |d|¡|  ||d¡| |d¡d}| |d|¡d}| |d|¡| |d¡| |d¡| |d¡| |d¡qœt ||d|j t |ƒt ||d|jt |ƒt ||d|jt |ƒt ||d|jt |ƒd}| |d|¡d }| |d|¡d}| |d |¡d}d}d}| ||||¡| d¡| |d ¡d|jd}|j}| ||d|¡| |d¡| |d¡d}| |d|¡d }| |d|¡d}| |d |¡d}d}d}| ||||¡| d¡| |d ¡d} |jD]} | | ¡| d} | t|jƒkrµ| d¡q| |d¡| |d¡| |d¡| |¡| ¡t |d¡d S)!zâ Write a page for a given program @param PR: The name of the program to write the page for @type PR: str @param P: An instance of the Parameters class @type P: Parameters object rˆr‰rÁrÂrrÃrÄrÅrÆr˜rÉz!../Doc_definitions.html#LaunchingzLaunching the programrÌrärz face="Courier New,Courier"Úfontr rÇrÈz Sample inputz Sample outputz../Doc_definitions.html#PackagerXrÍz ../package/rÊrËrÎršN)rDrrr›rœrrYržr rlrårÑr[r´r\rnrormr]rÒr¢rr r£) rqr0ÚPROGFNÚ PROGPAGEFILErÕrÖr×rØÚCOMMANDr;rÙr%r%r&Ú WriteProg;s¸                    €    z#WriteProgramPage..WriteProgr‰z Program IndexrŠrrŒcSrrŽrr‘r%r%r&r’Èr“z"WriteProgramPage..r”r–rˆr˜r™ršN)rrr›rœr­rpr®rŸrDrYr ržr¢rr r£) rïr0ròÚPROGFILEr§ÚPROGLISTÚPROGKEYrqr×rØr%r%r&ÚWriteProgramPage0s*        röc CsBtdƒtƒ}tdƒt |jd¡|_|j dd¡|_td|jƒ|jdkr*d}nd}td ƒt|ƒg}td ƒt  |j ¡t d |ƒtd t t |ƒƒƒ|D]}|t|j<qQtj |j¡rut  |j¡t d |ƒ|D]}|t|j<qmtd t t tƒƒƒg}tdƒt  |j ¡td|ƒtdt t |ƒƒƒ|D]}|t|j<qœtj |j¡rÀt  |j¡td|ƒ|D]}|t|j<q¸tdt t tƒƒƒtdƒt  |j ¡tdtƒtdt t tƒƒƒtD]}|t|j<qåtj |j¡r t  |j¡tdtƒtD]}|t|j<qtdt t tƒƒƒg}tdƒt  |j ¡td|ƒ|D]}|t|j<q(tj |j¡rOt  |j¡td|ƒ|D]}|t|j<qFtdƒt  |jd¡tdƒtdƒtdƒ|rŸtdƒtdƒt  d¡d} t| ƒtd ƒt  d!¡d"} t| |ƒtd#ƒt  d$¡d%} t| |ƒd&Sd&S)'z0 Called when not in documentation mode. z***** obtaining parametersz***** reading BIRCH.propertiesÚbirchURLr5rz P.DOCPREFIX: TFz***** dumping to ACEz***** reading categoriesz category.acez Categories:zCATDICT size: z***** reading packagesz package.acez Packages:zPKGDICT size: z***** reading programsz program.acezProgs:zPROGDICT size: z%***** reading documentation filenameszfile.acez***** freshdirz/public_html/birchdocrZrmrEz***** read OK *****z***** writing category pagesz category.htmlz***** writing program pagesz ../programz program.htmlz***** writing package pagesz ../packagez package.htmlN)rrÚBMÚGetBIRCHPropertiesrrçr:r3r r-rrWÚstrrÒrKrDrrrrjr_r‡rsrprºr´rÀr²rörá) r0ÚOKAYrNrLrbr`rqr·rµÚCATFNrïrÓr%r%r&ÚmainÚs                            érýÚ__main__z-test)-r+r rSr¼ÚsysrÚgetÚblibrr>ÚbirchlibrrrÚPROGRAMÚUSAGErørsrKrpr_r´rUrr3r=rArCrWrXrjrkr‡r²r³rºrÀrárÑrörýr(Ú documentorÚargvÚ exit_successr%r%r%r&Ús\        ;19eM-(8+  û