B
    3¢\A+  ã               @   sâ   d Z ddlZddlmZmZ ddlmZmZ ddlm	Z	 ddl
mZmZm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Zde efdeef efde efde efdefgZdS )z‘Tornado handlers for the contents web service.

Preliminary documentation at https://github.com/ipython/ipython/wiki/IPEP-27%3A-Contents-Service
é    N)ÚgenÚweb)Úurl_path_joinÚ
url_escape)Údate_default)ÚIPythonHandlerÚ
APIHandlerÚ
path_regexc          	      s¤   ddddddddd	h	}|t ˆ  ¡ ƒ }|r>t d
dj|d¡‚dd	g}|rv‡ fdd„|D ƒ}|r t d
dj|d¡‚n*‡ fdd„|D ƒ}|r t d
dj|d¡‚dS )z 
    Validate a model returned by a ContentsManager method.

    If expect_content is True, then we expect non-null entries for 'content'
    and 'format'.
    ÚnameÚpathÚtypeÚwritableZcreatedÚlast_modifiedZmimetypeÚcontentÚformatiô  zMissing Model Keys: {missing})Úmissingc                s   g | ]}ˆ | d kr|‘qS )N© )Ú.0Úkey)Úmodelr   úBlib/python3.7/site-packages/notebook/services/contents/handlers.pyú
<listcomp>0   s    z"validate_model.<locals>.<listcomp>zKeys unexpectedly None: {keys})Úkeysc                s"   i | ]}ˆ | d k	rˆ | |“qS )Nr   )r   r   )r   r   r   ú
<dictcomp>7   s   z"validate_model.<locals>.<dictcomp>z"Keys unexpectedly not None: {keys}N)Úsetr   r   Ú	HTTPErrorr   )r   Úexpect_contentZrequired_keysr   Zmaybe_none_keysÚerrorsr   )r   r   Úvalidate_model   s6    
r   c               @   sÈ   e Zd Zdd„ Zddd„Zejejddd„ƒƒZ	ejejdd	d
„ƒƒZ
ejddd„ƒZejdd„ ƒZejddd„ƒZejdd„ ƒZejejddd„ƒƒZejejd dd„ƒƒZejejd!dd„ƒƒZdS )"ÚContentsHandlerc             C   s   t | jddt|ƒƒS )z«Return the full URL location of a file.

        Parameters
        ----------
        path : unicode
            The API path of the file, such as "foo/bar.txt".
        ZapiÚcontents)r   Úbase_urlr   )Úselfr   r   r   r   Úlocation_urlE   s    zContentsHandler.location_urlTc             C   sR   |r|   |d ¡}|  d|¡ |  d|d ¡ |  dd¡ |  tj|td¡ dS )	zBFinish a JSON request with a model, setting relevant headers, etc.r   ÚLocationzLast-Modifiedr   zContent-Typezapplication/json)ÚdefaultN)r#   Ú
set_headerÚfinishÚjsonÚdumpsr   )r"   r   Úlocationr   r   r   Ú_finish_modelQ   s    zContentsHandler._finish_modelÚ c             c   s¼   |pd}| j ddd}|dkr.t dd| ¡‚| j ddd}|d	krTt dd
| ¡‚| j ddd}|dkrzt dd| ¡‚t|ƒ}t | jj||||d¡V }t||d | j	|dd dS )z©Return a model for a file or directory.

        A directory model contains a list of models (without content)
        of the files and directories it contains.
        r,   r   N)r%   >   Ú	directoryÚfileÚnotebookNi  zType %r is invalidr   >   ÚtextÚbase64NzFormat %r is invalidr   Ú1>   r2   Ú0zContent %r is invalid)r   r   r   r   )r   F)r*   )
Zget_query_argumentr   r   Úintr   Úmaybe_futureÚcontents_managerÚgetr   r+   )r"   r   r   r   r   r   r   r   r   r7   Z   s    
zContentsHandler.getc             c   sP   | j }|  ¡ }|dkr"t dd¡‚t | ||¡¡V }t|dd |  |¡ dS )z?PATCH renames a file or directory without re-uploading content.Ni  zJSON body missingF)r   )	r6   Úget_json_bodyr   r   r   r5   Úupdater   r+   )r"   r   Úcmr   r   r   r   Úpatchu   s    zContentsHandler.patchNc             c   sT   | j  dj||pdd¡ t | j ||¡¡V }|  d¡ t|dd |  	|¡ dS )z6Copy a file, optionally specifying a target directory.z Copying {copy_from} to {copy_to}r,   )Ú	copy_fromÚcopy_toéÉ   F)r   N)
ÚlogÚinfor   r   r5   r6   ÚcopyÚ
set_statusr   r+   )r"   r<   r=   r   r   r   r   Ú_copy   s    

zContentsHandler._copyc             c   sH   | j  d|¡ t | j ||¡¡V }|  d¡ t|dd |  |¡ dS )z#Handle upload of a new file to pathzUploading file to %sr>   F)r   N)	r?   r@   r   r5   r6   ÚnewrB   r   r+   )r"   r   r   r   r   r   Ú_upload   s
    
zContentsHandler._uploadc             c   sR   | j  d|pd|¡ t | jj|||d¡V }|  d¡ t|dd |  |¡ dS )z#Create a new, empty untitled entityzCreating new %s in %sr.   )r   r   Úextr>   F)r   N)	r?   r@   r   r5   r6   Znew_untitledrB   r   r+   )r"   r   r   rF   r   r   r   r   Ú_new_untitled–   s
    
zContentsHandler._new_untitledc             c   sV   |  dd¡}|r|dkr&| j d|¡ t | j ||¡¡V }t|dd |  |¡ dS )zSave an existing file.ÚchunkNéÿÿÿÿzSaving file at %sF)r   )	r7   r?   r@   r   r5   r6   Zsaver   r+   )r"   r   r   rH   r   r   r   Ú_saveŸ   s    zContentsHandler._savec             c   s    | j }| |¡rt dd¡‚| |¡s6t dd| ¡‚|  ¡ }|dk	r| d¡}| dd¡}| d	d¡}|r||  ||¡V  qœ| j|||d
V  n|  |¡V  dS )aZ  Create a new file in the specified path.

        POST creates new files. The server always decides on the name.

        POST /api/contents/path
          New untitled, empty file or directory.
        POST /api/contents/path
          with body {"copy_from" : "/path/to/OtherNotebook.ipynb"}
          New copy of OtherNotebook in path
        i  z&Cannot POST to files, use PUT instead.i”  zNo such directory: %sNr<   rF   r,   r   )r   rF   )	r6   Úfile_existsr   r   Z
dir_existsr8   r7   rC   rG   )r"   r   r:   r   r<   rF   r   r   r   r   Úpost©   s    


zContentsHandler.postc             c   s|   |   ¡ }|rf| d¡r"t dd¡‚t | j |¡¡V }|rPt |  ||¡¡V  qxt |  	||¡¡V  nt |  
|¡¡V  dS )aµ  Saves the file in the location specified by name and path.

        PUT is very similar to POST, but the requester specifies the name,
        whereas with POST, the server picks the name.

        PUT /api/contents/path/Name.ipynb
          Save notebook at ``path/Name.ipynb``. Notebook structure is specified
          in `content` key of JSON request body. If content is not specified,
          create a new empty notebook.
        r<   i  zCannot copy with PUT, only POSTN)r8   r7   r   r   r   r5   r6   rK   rJ   rE   rG   )r"   r   r   Úexistsr   r   r   ÚputÌ   s    
zContentsHandler.putc             c   s<   | j }| j d|¡ t | |¡¡V  |  d¡ |  ¡  dS )zdelete a file in the given pathz	delete %séÌ   N)r6   r?   Úwarningr   r5   ÚdeleterB   r'   )r"   r   r:   r   r   r   rQ   å   s
    
zContentsHandler.delete)T)r,   )r,   )N)r,   r,   )r,   )r,   )r,   )Ú__name__Ú
__module__Ú__qualname__r#   r+   r   Úauthenticatedr   Ú	coroutiner7   r;   rC   rE   rG   rJ   rL   rN   rQ   r   r   r   r   r   C   s.   
	
	
!r   c               @   s8   e Zd Zejejddd„ƒƒZejejddd„ƒƒZdS )	ÚCheckpointsHandlerr,   c             c   s4   | j }t | |¡¡V }tj|td}|  |¡ dS )z get lists checkpoints for a file)r%   N)r6   r   r5   Zlist_checkpointsr(   r)   r   r'   )r"   r   r:   ÚcheckpointsÚdatar   r   r   r7   ò   s    zCheckpointsHandler.getc             c   sh   | j }t | |¡¡V }tj|td}t| jdt	|ƒdt	|d ƒƒ}|  
d|¡ |  d¡ |  |¡ dS )zpost creates a new checkpoint)r%   zapi/contentsrX   Úidr$   r>   N)r6   r   r5   Zcreate_checkpointr(   r)   r   r   r!   r   r&   rB   r'   )r"   r   r:   Z
checkpointrY   r*   r   r   r   rL   û   s    
zCheckpointsHandler.postN)r,   )r,   )	rR   rS   rT   r   rU   r   rV   r7   rL   r   r   r   r   rW   ð   s   rW   c               @   s4   e Zd Zejejdd„ ƒƒZejejdd„ ƒƒZdS )ÚModifyCheckpointsHandlerc             c   s0   | j }t | ||¡¡V  |  d¡ |  ¡  dS )z&post restores a file from a checkpointrO   N)r6   r   r5   Zrestore_checkpointrB   r'   )r"   r   Úcheckpoint_idr:   r   r   r   rL     s    
zModifyCheckpointsHandler.postc             c   s0   | j }t | ||¡¡V  |  d¡ |  ¡  dS )z+delete clears a checkpoint for a given filerO   N)r6   r   r5   Zdelete_checkpointrB   r'   )r"   r   r\   r:   r   r   r   rQ     s    
zModifyCheckpointsHandler.deleteN)	rR   rS   rT   r   rU   r   rV   rL   rQ   r   r   r   r   r[   	  s   r[   c               @   s,   e Zd ZdZdZdd„ Ze Z Z ZZ	dS )ÚNotebooksRedirectHandlerz(Redirect /api/notebooks to /api/contents)ZGETZPUTZPATCHZPOSTZDELETEc             C   s$   | j  d¡ |  t| jd|ƒ¡ d S )Nz//api/notebooks is deprecated, use /api/contentszapi/contents)r?   rP   Zredirectr   r!   )r"   r   r   r   r   r7   "  s
    zNotebooksRedirectHandler.getN)
rR   rS   rT   Ú__doc__ZSUPPORTED_METHODSr7   rN   r;   rL   rQ   r   r   r   r   r]     s   r]   c               @   s&   e Zd ZdZejejddd„ƒƒZdS )ÚTrustNotebooksHandlerz$ Handles trust/signing of notebooks r,   c             c   s.   | j }t | |¡¡V  |  d¡ |  ¡  d S )Nr>   )r6   r   r5   Ztrust_notebookrB   r'   )r"   r   r:   r   r   r   rL   0  s    
zTrustNotebooksHandler.postN)r,   )	rR   rS   rT   r^   r   rU   r   rV   rL   r   r   r   r   r_   -  s   r_   z(?P<checkpoint_id>[\w-]+)z/api/contents%s/checkpointsz/api/contents%s/checkpoints/%sz/api/contents%s/trustz/api/contents%sz/api/notebooks/?(.*))r^   r(   Ztornador   r   Znotebook.utilsr   r   Zjupyter_client.jsonutilr   Znotebook.base.handlersr   r   r	   r   r   rW   r[   r]   r_   Z_checkpoint_id_regexZdefault_handlersr   r   r   r   Ú<module>   s&   . .



