a
    ©ˆc‘R  ã                   @   sd  d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl	Z	d dl
Z
d dlZd dlZd dlmZ d dlmZ dZdZdZdZdZd	d
„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ ZG dd„ deƒZ G dd„ deƒZ!G dd „ d e!ƒZ"G d!d"„ d"eƒZ#G d#d$„ d$eƒZ$d%d&„ Z%d'd(„ Z&d0d*d+„Z'd1d-d.„Z(e)d/k�r`e'ƒ  dS )2é    N)Úchoice)ÚbackendséÈ   i�  i”  i÷  aÝ  
Here is a sample of what a configuration file could look like:

    {
        // ===============================
        // General launcher configuration
        // ===============================

        "configuration": {
            "host" : "localhost",
            "port" : 8080,
            "endpoint": "paraview",                   // SessionManager Endpoint
            "content": "/.../www",                    // Optional: Directory shared over HTTP
            "proxy_file" : "/.../proxy-mapping.txt",  // Proxy-Mapping file for Apache
            "sessionURL" : "ws://${host}:${port}/ws", // ws url used by the client to connect to the started process
            "timeout" : 25,                           // Wait time in second after process start
            "log_dir" : "/.../viz-logs",              // Directory for log files
            "fields" : ["file", "host", "port"]       // List of fields that should be send back to client
                                                             // include "secret" if you provide it as an --authKey to the app
            "sanitize": {                             // Check information coming from the client
                "cmd": {
                    "type": "inList",                 // 'cmd' must be one of the strings in 'list'
                    "list": [
                        "me", "you", "something/else/altogether", "nothing-to-do"
                    ],
                    "default": "nothing-to-do"        // If the string doesn't match, replace it with the default.
                                                      // Include the default in your list
                },
                "cmd2": {                             // 'cmd2' must match the regexp provided, example: not a quote
                    "type": "regexp",
                    "regexp": "^[^"]*$",             // Make sure to include '^' and '$' to match the entire string!
                    "default": "nothing"
                }
            }
        },

        // ===============================
        // Useful session vars for client
        // ===============================

        "sessionData" : { "key": "value" },      // Dictionary of values interesting to the client

        // ===============================
        // Resources list for applications
        // ===============================

        "resources" : [ { "host" : "localhost", "port_range" : [9001, 9003] } ],

        // ===============================
        // Set of properties for cmd line
        // ===============================

        "properties" : {
            "vtkpython" : "/.../VTK/build/bin/vtkpython",
            "pvpython" : "/.../ParaView/build/bin/pvpython",
            "vtk_python_path": "/.../VTK/build/Wrapping/Python/vtk/web",
            "pv_python_path": "/.../ParaView/build/lib/site-packages/paraview/web",
            "plugins_path": "/.../ParaView/build/lib",
            "dataDir": "/.../path/to/data/directory"
        },

        // ===============================
        // Application list with cmd lines
        // ===============================

        "apps" : {
            "cone" : {
                "cmd" : [
                    "${vtkpython}", "${vtk_python_path}/vtk_web_cone.py", "--port", "$port" ],
                "ready_line" : "Starting factory"
            },
            "graph" : {
                "cmd" : [
                    "${vtkpython}", "${vtk_python_path}/vtk_web_graph.py", "--port", "$port",
                    "--vertices", "${numberOfVertices}", "--edges", "${numberOfEdges}" ],
                "ready_line" : "Starting factory"
            },
            "phylotree" : {
                "cmd" : [
                    "${vtkpython}", "${vtk_python_path}/vtk_web_phylogenetic_tree.py", "--port", "$port",
                    "--tree", "${dataDir}/visomics/${treeFile}", "--table", "${dataDir}/visomics/${tableFile}" ],
                "ready_line" : "Starting factory"
            },
            "filebrowser" : {
                "cmd" : [
                    "${vtkpython}", "${vtk_python_path}/vtk_web_filebrowser.py",
                    "--port", "${port}", "--data-dir", "${dataDir}" ],
                "ready_line" : "Starting factory"
            },
            "data_prober": {
                "cmd": [
                    "${pvpython}", "-dr", "${pv_python_path}/pv_web_data_prober.py",
                    "--port", "${port}", "--data-dir", "${dataDir}", "-f" ],
                "ready_line" : "Starting factory"
            },
            "visualizer": {
                "cmd": [
                    "${pvpython}", "-dr", "${pv_python_path}/pv_web_visualizer.py",
                    "--plugins", "${plugins_path}/libPointSprite_Plugin.so", "--port", "${port}",
                    "--data-dir", "${dataDir}", "--load-file", "${dataDir}/${fileToLoad}",
                    "--authKey", "${secret}", "-f" ],  // Use of ${secret} means it needs to be provided to the client, in "fields", above.
                "ready_line" : "Starting factory"
            },
            "loader": {
                "cmd": [
                    "${pvpython}", "-dr", "${pv_python_path}/pv_web_file_loader.py",
                    "--port", "${port}", "--data-dir", "${dataDir}",
                    "--load-file", "${dataDir}/${fileToLoad}", "-f" ],
                "ready_line" : "Starting factory"
            },
            "launcher" : {
                "cmd": [
                    "/.../ParaView/Web/Applications/Parallel/server/launcher.sh",
                    "${port}", "${client}", "${resources}", "${file}" ],
                "ready_line" : "Starting factory"
            },
            "your_app": {
                "cmd": [
                    "your_shell_script.sh", "--resource-host", "${host}", "--resource-port", "${port}",
                    "--session-id", "${id}", "--generated-password", "${secret}",
                    "--application-key", "${application}" ],
                "ready_line": "Output line from your shell script indicating process is ready"
        }
    }
c                 C   s(   t  dt jt jB ¡}dd„ }| || ¡S )a½  
    Removes C-style comments from *json_like* and returns the result.  Example::
        >>> test_json = '''        {
            "foo": "bar", // This is a single-line comment
            "baz": "blah" /* Multi-line
            Comment */
        }'''
        >>> remove_comments('{"foo":"bar","baz":"blah",}')
        '{
    "foo":"bar",
    "baz":"blah"
}'

        From: https://gist.github.com/liftoff/ee7b81659673eca23cd9fc0d8b8e68b7
    z7//.*?$|/\*.*?\*/|\'(?:\\.|[^\\\'])*\'|"(?:\\.|[^\\"])*"c                 S   s   |   d¡}|d dkrdS |S )Nr   ú/Ú )Úgroup)ÚmatchÚs© r
   úR/home/yuhw/wc/wire-cell-python/wcpy/lib/python3.9/site-packages/wslink/launcher.pyÚreplacer®   s    
z!remove_comments.<locals>.replacer)ÚreÚcompileÚDOTALLÚ	MULTILINEÚsub)Z	json_likeZcomments_rer   r
   r
   r   Úremove_comments›   s    
þr   c                   C   s   d  dd„ tdƒD ƒ¡S )Nr   c                 s   s   | ]}t tjtj ƒV  qd S ©N)r   ÚstringÚascii_lettersÚdigits)Ú.0Ú_r
   r
   r   Ú	<genexpr>¸   ó    z#generatePassword.<locals>.<genexpr>é   )ÚjoinÚranger
   r
   r
   r   ÚgeneratePassword·   s    r   c                 C   s.   d}|D ] }|| vrt d||f ƒ d}q|S )NTzERROR: %s is missing %s key.F)Úprint)ÚobjÚexpected_keysZobject_nameZall_key_foundÚkeyr
   r
   r   ÚvalidateKeySet¾   s    r#   c                 C   sÄ   |sd S |D ]²}|| v r|| }| | }|d dkrd||d vr¾t  d|| | f ¡ |d | |< q|d dkrd|vrŠt |d ¡|d< |d  |¡d krt  d|| | f ¡ |d | |< qd S )NÚtypeZinListÚlistz key %s: sanitize %s with defaultÚdefaultÚregexpZcompiled)ÚloggingÚwarningr   r   r   )Úkey_pairÚsanitizer"   Z	checkItemÚvaluer
   r
   r   ÚcheckSanitizeÇ   s(    ÿÿr-   c                 C   sB   |D ]"}t ||ƒ t | ¡}| |¡} qd| v r>t d|  ¡ | S )Nú$z'Some properties could not be resolved: )r-   r   ÚTemplateÚsafe_substituter(   Úerror)Útemplate_strÚvariable_listr+   r*   Zitem_templater
   r
   r   ÚreplaceVariablesä   s    

r4   c                 C   s$   g }| D ]}|  t|||ƒ¡ q|S r   )Úappendr4   )Ztemplate_listr3   r+   Zresult_listr2   r
   r
   r   ÚreplaceListó   s    r6   c                 C   s4   |  g d¢¡ i }| D ]}||v r| | ||< q|S )N)ÚidÚ
sessionURLZsessionManagerURL)Úextend)r    Zpublic_keysZfiltered_outputÚfieldr
   r
   r   ÚfilterResponseý   s    r;   c                 C   s(   | j  d¡}t|ƒdk rd S t|d ƒS )Nr   é   é   )ÚpathÚsplitÚlenÚstr)Úrequestr>   r
   r
   r   ÚextractSessionId	  s    rC   c                 C   s   t j| dd� d¡S )NF)Úensure_asciiÚutf8)ÚjsonÚdumpsÚencode)Úpayloadr
   r
   r   ÚjsonResponse  s    rJ   c                   @   s,   e Zd Zdd„ Zdd„ Zdd„ Zdd„ Zd	S )
ÚSessionManagerc                 C   s2   i | _ || _t|d ƒ| _|| _|d d | _d S )NÚ	resourcesÚconfigurationr+   )ÚsessionsÚconfigÚResourceManagerrL   Úmappingr+   )ÚselfrO   rQ   r
   r
   r   Ú__init__  s
    zSessionManager.__init__c                 C   sü   t t ¡ ƒ}| j ¡ \}}|rø||d< ||d< ||d< d|vrHtƒ |d< t| jd d || jd g| jƒ|d< t	| jd |d	  d
 || jd g| jƒ|d
< d| jv rÜ| jd D ]*}t| jd | || jd g| jƒ||< q°|| j
|< | j | j
¡ |S d S )Nr7   ÚhostÚportÚsecretrM   r8   Ú
propertiesÚappsÚapplicationÚcmdZsessionData)rA   ÚuuidÚuuid1rL   ÚgetNextResourcer   r4   rO   r+   r6   rN   rQ   Úupdate)rR   Úoptionsr7   rT   rU   r"   r
   r
   r   ÚcreateSession!  s:    
ýý
ý

zSessionManager.createSessionc                 C   sD   | j | d }| j | d }| j ||¡ | j |= | j | j ¡ d S )NrT   rU   )rN   rL   ÚfreeResourcerQ   r^   )rR   r7   rT   rU   r
   r
   r   ÚdeleteSessionH  s
    zSessionManager.deleteSessionc                 C   s   || j v r| j | S d S r   ©rN   ©rR   r7   r
   r
   r   Ú
getSessionO  s    

zSessionManager.getSessionN)Ú__name__Ú
__module__Ú__qualname__rS   r`   rb   re   r
   r
   r
   r   rK     s   'rK   c                   @   s   e Zd Zdd„ ZdS )ÚProxyMappingManagerc                 C   s   d S r   r
   rc   r
   r
   r   r^   [  s    zProxyMappingManager.updateN)rf   rg   rh   r^   r
   r
   r
   r   ri   Z  s   ri   c                   @   s   e Zd Zddd„Zdd„ ZdS )ÚProxyMappingManagerTXTú	%s %s:%d
c                 C   s   || _ || _d S r   )Ú	file_pathÚpattern)rR   rl   rm   r
   r
   r   rS   `  s    zProxyMappingManagerTXT.__init__c              	   C   sf   t j| jddd��@}|D ]*}| | j||| d || d f ¡ qW d   ƒ n1 sX0    Y  d S )NÚwúutf-8©ÚencodingrT   rU   )ÚioÚopenrl   Úwriterm   )rR   rN   Zmap_filer7   r
   r
   r   r^   d  s
    ÿzProxyMappingManagerTXT.updateN)rk   )rf   rg   rh   rS   r^   r
   r
   r
   r   rj   _  s   
rj   c                   @   s(   e Zd ZdZdd„ Zdd„ Zdd„ ZdS )	rP   zV
    Class that provides methods to keep track on available resources (host/port)
    c                 C   sn   i | _ |D ]^}|d }tt|d d |d d d ƒƒ}|| j v rX| j | d  |¡ q
|g dœ| j |< q
d S )NrT   Z
port_ranger   é   Ú	available)rv   Úused)rL   r%   r   r9   )rR   ZresourceListÚresourcerT   ZportListr
   r
   r   rS   v  s    ÿ
zResourceManager.__init__c                 C   sv   d}d}| j D ]0}|t| j | d ƒk rt| j | d ƒ}|}q|rr| j | d  ¡ }| j | d  |¡ ||fS dS )zX
        Return a (host, port) pair if any available otherwise will return None
        Nr   rv   rw   )NN)rL   r@   Úpopr5   )rR   ÚwinnerZavailibilityCountrT   rU   r
   r
   r   r]   ‚  s    
zResourceManager.getNextResourcec                 C   sH   || j v rD|| j | d v rD| j | d  |¡ | j | d  |¡ dS )z5
        Free a previously reserved resource
        rw   rv   N)rL   Úremover5   )rR   rT   rU   r
   r
   r   ra   •  s    zResourceManager.freeResourceN)rf   rg   rh   Ú__doc__rS   r]   ra   r
   r
   r
   r   rP   q  s   rP   c                   @   sN   e Zd Zdd„ Zdd„ Zdd„ Zdd„ Zd	d
„ Zdd„ Zdd„ Z	ddd„Z
dS )ÚProcessManagerc                 C   s   || _ |d d | _i | _d S )NrM   Úlog_dir)rO   r~   Ú	processes)rR   rM   r
   r
   r   rS   ¤  s    zProcessManager.__init__c                 C   s   | j D ]}| j |  ¡  qd S r   ©r   Ú	terminaterd   r
   r
   r   Ú__del__©  s    
zProcessManager.__del__c                 C   s   d| j tj|f S )Nz
%s%s%s.txt)r~   ÚosÚseprd   r
   r
   r   Ú_getLogFilePath­  s    zProcessManager._getLogFilePathc                 C   s®   d }|   |d ¡}tj|dddd��v}z&tj|d ||d�}|| j|d < W n>   t d¡ t d	 t	t
|d ƒ¡¡ Y W d   ƒ d S 0 W d   ƒ n1 s 0    Y  |S )
Nr7   za+ru   ro   )ÚmodeÚ	bufferingrq   rZ   )ÚstdoutÚstderrzThe command line failedú )r…   rr   rs   Ú
subprocessÚPopenr   r(   r1   r   ÚmaprA   )rR   ÚsessionÚprocÚlogFilePathÚlog_filer
   r
   r   ÚstartProcess°  s    
ÿ
2zProcessManager.startProcessc                 C   s0   | j | }| j |= z| ¡  W n   Y n0 d S r   r€   )rR   r7   r�   r
   r
   r   ÚstopProcessÂ  s    
zProcessManager.stopProcessc                 C   s0   g }| j D ] }| j |  ¡ d ur
| |¡ q
|S r   )r   Úpollr5   )rR   Zsession_to_releaser7   r
   r
   r   ÚlistEndedProcessÊ  s
    
zProcessManager.listEndedProcessc                 C   s   | j |  ¡ d u S r   )r   r”   rd   r
   r
   r   Ú	isRunningÑ  s    zProcessManager.isRunningr   c           
      C   s¸   |d }|   |¡s|dk rdS |   |¡s,dS | jd |d  }| dd ¡}|sRdS d}|  |d ¡}tj|dd	d
d��.}| ¡ D ]}	||	v r€d} q–q€W d   ƒ n1 sª0    Y  |S )Nr7   é<   FTrX   rY   Ú
ready_lineÚrru   ro   rp   )r–   rO   Úgetr…   rr   rs   Ú	readlines)
rR   rŽ   Úcountr7   rY   r˜   Úreadyr�   r‘   Úliner
   r
   r   ÚisReadyÚ  s"    
$zProcessManager.isReadyN)r   )rf   rg   rh   rS   r‚   r…   r’   r“   r•   r–   rŸ   r
   r
   r
   r   r}   £  s   	r}   c                 C   s  z*t tj| jd dd� ¡ ƒ}t |¡}W nR   d}|tt 	¡ d ƒd tt 	¡ d ƒ 7 }t
|ƒ t
tƒ t d¡ Y n0 g d¢}t||d	ƒs¤t
tƒ t d¡ g d
¢}t|d |dƒsÎt
tƒ t d¡ d|d vræd|d d< d|d vrþi |d d< |S )Nr   ro   rp   z#ERROR: Unable to read config file.
ru   Ú
r=   )rM   rX   rW   rL   zConfig file)ZendpointrT   rU   Z
proxy_filer8   Útimeoutr~   ÚfieldsrM   zfile.configurationÚcontentr   r+   )r   rr   rs   rO   ÚreadrF   ÚloadsrA   ÚsysÚexc_infor   Úsample_config_fileÚexitr#   )r_   Zconfig_commentsrO   Úmessager!   r
   r
   r   ÚparseConfigÿ  s0    ÿ(


r«   c                 C   s8   | j dtddd� | j ddddd	� | j d
ddd� | S )NrO   ru   z#configuration file for the launcher)r$   ÚnargsÚhelpz-dz--debugz log debugging messages to stdoutÚ
store_true)r­   Úactionz	--backendz&Server implementation to use (aiohttp)Úaiohttp)r­   r&   )Úadd_argumentrA   )Úparserr
   r
   r   Úadd_arguments/  s    ÿÿÿr³   úwslink Web Launcherc                 C   sB   t j|t jtd�}t|ƒ | | ¡}t|ƒ}tj|||j	d� d S )N)ÚdescriptionÚformatter_classÚepilog©Úbackend)
ÚargparseÚArgumentParserÚRawDescriptionHelpFormatterr¨   r³   Ú
parse_argsr«   r   Úlauncher_startr¹   )Úargvrµ   r²   ÚargsrO   r
   r
   r   ÚstartB  s    ý
rÁ   r°   c                 C   s   t j| ||d�S )Nr¸   )r   r¾   )rÀ   rO   r¹   r
   r
   r   ÚstartWebServerQ  s    rÂ   Ú__main__)Nr´   )r°   )*rº   ZasyncioÚdatetimerr   rF   r(   rƒ   r   r   r‹   r¦   Útimer[   Úrandomr   Zwslinkr   Z	STATUS_OKZSTATUS_BAD_REQUESTZSTATUS_NOT_FOUNDZSTATUS_SERVICE_UNAVAILABLEr¨   r   r   r#   r-   r4   r6   r;   rC   rJ   ÚobjectrK   ri   rj   rP   r}   r«   r³   rÁ   rÂ   rf   r
   r
   r
   r   Ú<module>   sP    	
	A2\0


