
    ^h;                        S r SSKrSSKJr  SSKJr   SSKJr  SSK
Jr  SSKJr  SS	KJrJr  SS
KJrJrJr  SSKJrJr  SrS\S\\\4   S\\   4S jrS%S jr " S S\5      r " S S\5      r  " S S\5      r! " S S\5      r" " S S\5      r# " S S\5      r$Sr%S\-  \!4S \ S!\% 3\"4S"\-  \$4S#\-  \ 4S$\#4/r&g! \ a	    SSKJ	r   Nf = f)&zTornado handlers for the contents web service.

Preliminary documentation at https://github.com/ipython/ipython/wiki/IPEP-27%3A-Contents-Service
    N)
HTTPStatus)Any)json_default)date_default)ensure_async)web)allow_unauthenticated
authorized)
APIHandlerJupyterHandler
path_regex)
url_escapeurl_path_joincontentsexpect_definedmodelkeysc                    U (       a;  U Vs/ s H  o1U   b  M
  UPM     nnU(       a  [         R                  " SSU 35      egU Vs0 s H  o1U   c  M
  X1U   _M     nnU(       a  [         R                  " SSU 35      egs  snf s  snf )zG
Validate that the keys are defined (i.e. not None) or not (i.e. None)
N  zKeys unexpectedly None: zKeys unexpectedly not None: )r   	HTTPError)r   r   r   keyerrorss        c/home/james-whalen/.local/lib/python3.13/site-packages/jupyter_server/services/contents/handlers.py_validate_keysr      s    
 !%<#s#<--*6(3   .2LTc3Z/#Sz/TL--.vh7   = Ms   	BB	B	Bc                    1 SknU(       a  UR                  SS/5        U[        U R                  5       5      -
  nU(       a  [        R                  " SSU 35      eSS/n[        XU5        U(       a  [        X SS/5        gg)	z
Validate a model returned by a ContentsManager method.

If expect_content is True, then we expect non-null entries for 'content'
and 'format'.

If expect_hash is True, then we expect non-null entries for 'hash' and 'hash_algorithm'.
>	   namepathtypeformatcontentcreatedmimetypewritablelast_modifiedhashhash_algorithmr   zMissing Model Keys: r    r   N)updatesetr   r   r   r   )r   expect_contentexpect_hashrequired_keysmissingcontent_keyss         r   validate_modelr.   0   s    
M f&678c%**,//Gmm"7),
 	

 x(L>,7{F4D+EF     c                       \ rS rSrSr\rSrg)ContentsAPIHandlerS   zA contents API handler. N)__name__
__module____qualname____firstlineno____doc__AUTH_RESOURCEauth_resource__static_attributes__r3   r/   r   r1   r1   S   s
    !!Mr/   r1   c                   H   \ rS rSrSrS rSS jrS r\R                  \
SS j5       5       r\R                  \
SS j5       5       rSS	 jrS
 rSS jrS r\R                  \
SS j5       5       r\R                  \
SS j5       5       r\R                  \
SS j5       5       rSrg)ContentsHandlerY   zA contents handler.c                 D    [        U R                  SS[        U5      5      $ )zReturn the full URL location of a file.

Parameters
----------
path : unicode
    The API path of the file, such as "foo/bar.txt".
apir   )r   base_urlr   selfr   s     r   location_urlContentsHandler.location_url\   s     T]]E:z$?OPPr/   c                     U(       a&  U R                  US   5      nU R                  SU5        U R                  SUS   5        U R                  SS5        U R                  [        R                  " U[
        S95        g)	zBFinish a JSON request with a model, setting relevant headers, etc.r   LocationzLast-Modifiedr$   zContent-Typezapplication/jsondefaultN)rD   
set_headerfinishjsondumpsr   )rC   r   locations      r   _finish_modelContentsHandler._finish_modelf   s`    ((v7HOOJ1)?@(:;DJJul;<r/   c                    #    U R                  U5        U R                  U5        U R                  5       I Sh  vN   g N7f)z@Finish a JSON request with an error code and descriptive messageN)
set_statuswriterK   )rC   codemessages      r   _finish_errorContentsHandler._finish_erroro   s,     

7kkms   6A >A c           
        #    U=(       d    SnU R                   nU R                  SSS9nUS;  a  SnU R                  SSS9nUS;  a  [        R                  " S	S
U-  5      eU R                  SSS9nUS;  a  [        R                  " S	SU-  5      e[	        U=(       d    S5      nU R                  SSS9nUS;  a  [        R                  " S	SU< S35      e[	        U5      nUR
                  (       dT  [        UR                  U5      5      I Sh  vN (       a-  U R                  [        R                  SU< S35      I Sh  vN    Un	 [        U R                   R                  UUUUUS95      I Sh  vN n
[        XU	S9  U R                  U
SS9  g N NS N#! [         a3    Sn	[        U R                   R                  UUUUS95      I Sh  vN  n
 N]f = f! [        R                   aR  nUR                  [        R                  :X  a.  U R                  [        R                  SU< S35      I Sh  vN    e SnAff = f7f)zReturn 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   NrH   >   Nfilenotebook	directoryrZ   r   >   Ntextbase64  zFormat %r is invalidr    1>   0r`   zContent %r is invalidr%   ra   zHash argument z# is invalid. It must be '0' or '1'.zfile or directory z does not exist)r   r   r   r    require_hashF)r   r   r   r    )r)   r*   )rN   )contents_managerget_query_argumentr   r   intallow_hiddenr   	is_hiddenrV   r   	NOT_FOUNDget	TypeErrorr.   rO   status_code)rC   r   cmr   r   content_strr    hash_strrb   r*   r   excs               r   ri   ContentsHandler.getu   sf     zr""&&vt&<>>D((4(@11--%;f%DEE--i-Ej(--%<{%JKKk'R(**63*?:%--~h\1TU  8}bll46H)I#I#I$$$$(:4(/&R   	&K*))--!!% '%1 .  * 5kRuu5= $J   $*))--!!% '	 .   	 }} 	*"6"66((((,>tho*V   	s   DIF1IFI	G )F 5F6F :G IIF 4GGGG GG I/AH<5H86H<<IIc                 $  #    U R                   nU R                  5       nUc  [        R                  " SS5      eUR	                  S5      nU(       az  UR
                  (       di  [        UR                  U5      5      I Sh  vN (       d'  [        UR                  U5      5      I Sh  vN (       a  [        R                  " SSU< 35      e[        UR                  X15      5      I Sh  vN n[        U5        U R                  U5        g N Ne N%7f)z?PATCH renames a file or directory without re-uploading content.Nr_   zJSON body missingr   z Cannot rename file or directory )rc   get_json_bodyr   r   ri   rf   r   rg   r'   r.   rO   )rC   r   rl   r   old_paths        r   patchContentsHandler.patch   s      """"$=--%89999V$OO"2<<#5666R\\ZbMc@d:d:d --'Gx%PQQ"299U#9::u5! 7:d
 ;s7   A=D?D
 &D&D'AD(D)"DDDNc                   #    U R                   R                  SUU=(       d    S5        [        U R                  R	                  X5      5      I Sh  vN nU R                  S5        [        U5        U R                  U5        g N27f)z6Copy a file, optionally specifying a target directory.zCopying %r to %rrY   N   )loginfor   rc   copyrR   r.   rO   )rC   	copy_fromcopy_tor   s       r   _copyContentsHandler._copy   sj     Mr	

 #4#8#8#=#=i#QRRu5! Ss   ABB3Bc                    #    U R                   R                  SU5        [        U R                  R	                  X5      5      I Sh  vN nU R                  S5        [        U5        U R                  U5        g N27f)z#Handle upload of a new file to pathzUploading file to %sNrw   )rx   ry   r   rc   newrR   r.   rO   )rC   r   r   s      r   _uploadContentsHandler._upload   s^     ,d3"4#8#8#<#<U#IJJu5! Ks   AA;A93A;c                   #    U R                   R                  SU=(       d    SU5        [        U R                  R	                  XUS95      I Sh  vN nU R                  S5        [        U5        U R                  U5        g N27f)z#Create a new, empty untitled entityzCreating new %s in %srZ   )r   r   extNrw   )rx   ry   r   rc   new_untitledrR   r.   rO   )rC   r   r   r   r   s        r   _new_untitledContentsHandler._new_untitled   so     -t~vtD"!!..D.M
 
 	u5!
s   ABB3Bc                   #    UR                  SS5      nU(       a  US:X  a  U R                  R                  SU5        [        U R                  R                  X5      5      I Sh  vN n[        U5        U R                  U5        g N!7f)zSave an existing file.chunkNzSaving file at %s)ri   rx   ry   r   rc   saver.   rO   )rC   r   r   r   s       r   _saveContentsHandler._save   sk     		'4(HHMM-t4"4#8#8#=#=e#JKKu5! Ls   A#B	%B&"B	c                    #    U R                   n[        UR                  U5      5      I Sh  vN nU(       a  [        R                  " SS5      eU R                  5       nU(       a  UR                  S5      nU(       a  UR                  (       di  [        UR                  U5      5      I Sh  vN (       d'  [        UR                  U5      5      I Sh  vN (       a  [        R                  " SSU< 35      eU R                  XQ5      I Sh  vN   gUR                  SS5      nUR                  SS5      nUS	;  a  S
nU R                  XUS9I Sh  vN   gU R                  U5      I Sh  vN   g GNE N N Nk N( N7f)a"  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
Nr_   z&Cannot POST to files, use PUT instead.r{   zCannot copy file or directory r   rY   r   >   NrY   rZ   r[   r\   rZ   )r   r   )rc   r   file_existsr   r   rr   ri   rf   rg   r}   r   )rC   r   rl   r   r   r{   r   r   s           r   postContentsHandler.post   s5     ""()=>>--%MNN""$		+.I&r||D'9:::)",,y*ABBB--/MdX-VWW**Y555iir*yy,JJ!D((c(BBB$$T***/ ? ;B 6 C*sk   *E>E1A?E>,E4-&E>E68E>E8AE>E:E>+E<,E>4E>6E>8E>:E><E>c                 :  #    U R                  5       nU R                  nU(       GaN  UR                  S5      (       a  [        R                  " SS5      eUR
                  (       d  UR                  S5      (       a6  [        UR                  UR                  S5      5      5      I Sh  vN (       d'  [        UR                  U5      5      I Sh  vN (       a  [        R                  " SSU< 35      e[        U R                  R                  U5      5      I Sh  vN nUR                  SS5      S	;  a  S
US'   U(       a  U R                  X!5      I Sh  vN   gU R                  X!5      I Sh  vN   gU R                  U5      I Sh  vN   g N N Nx N? N' N7f)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{   r_   zCannot copy with PUT, only POSTr   Nz Cannot create file or directory r   rY   >   NrY   rZ   r[   r\   rZ   )rr   rc   ri   r   r   rf   r   rg   r   r   r   r   )rC   r   r   rl   existss        r   putContentsHandler.put"  s:     ""$""yy%%mmC)JKK??6""\",,uyyQWGX:Y-Z'Z'Z%bll4&8999mmC+KD8)TUU'(=(=(I(I$(OPPFyy$,WW &fjj---ll5///$$T*** ([9 Q
 ./*sm   B%F'F(&FFAFF:FFF/F0F	F
FFFFFFc                   #    U R                   nUR                  (       dB  [        UR                  U5      5      I Sh  vN (       a  [        R
                  " SSU< 35      eU R                  R                  SU5        [        UR                  U5      5      I Sh  vN   U R                  S5        U R                  5         g N N(7f)zdelete a file in the given pathNr_   z Cannot delete file or directory z	delete %s   )rc   rf   r   rg   r   r   rx   warningdeleterR   rK   rC   r   rl   s      r   r   ContentsHandler.deleteF  s      ""bll46H)I#I#I--'Gx%PQQd+299T?+++ $J 	,s"   ;CCACC'CCr3   )TrY   )N)rY   rY   )r4   r5   r6   r7   r8   rD   rO   rV   r   authenticatedr
   ri   rt   r}   r   r   r   r   r   r   r;   r3   r/   r   r=   r=   Y   s    Q= 	B  BH 	"  "*
"""" 	%+  %+N 	 +   +D 	
  
r/   r=   c                   |    \ rS rSrSr\R                  \SS j5       5       r\R                  \SS j5       5       r	Sr
g)CheckpointsHandleriU  zA checkpoints API handler.c                    #    U R                   n[        UR                  U5      5      I Sh  vN n[        R                  " U[
        S9nU R                  U5        g N/7f)z get lists checkpoints for a fileNrH   )rc   r   list_checkpointsrL   rM   r   rK   )rC   r   rl   checkpointsdatas        r   ri   CheckpointsHandler.getX  sL      ""()<)<T)BCCzz+|<D Ds   *AA0Ac           
      b  #    U R                   n[        UR                  U5      5      I Sh  vN n[        R                  " U[
        S9n[        U R                  S[        U5      S[        US   5      5      nU R                  SU5        U R                  S5        U R                  U5        g N7f)zpost creates a new checkpointNrH   api/contentsr   idrG   rw   )rc   r   create_checkpointrL   rM   r   r   rA   r   rJ   rR   rK   )rC   r   rl   
checkpointr   rN   s         r   r   CheckpointsHandler.posta  s      ""'(<(<T(BCC
zz*l; MMtz$'(
 	
H-D Ds   *B/B-BB/r3   Nr   )r4   r5   r6   r7   r8   r   r   r
   ri   r   r;   r3   r/   r   r   r   U  sG    $   	  r/   r   c                   t    \ rS rSrSr\R                  \S 5       5       r\R                  \S 5       5       r	Sr
g)ModifyCheckpointsHandlerit  z#A checkpoints modification handler.c                    #    U R                   n[        UR                  X!5      5      I Sh  vN   U R                  S5        U R	                  5         g N&7f)z&post restores a file from a checkpointNr   )rc   r   restore_checkpointrR   rK   rC   r   checkpoint_idrl   s       r   r   ModifyCheckpointsHandler.postw  sF      ""200EFFF 	G   *AA'Ac                    #    U R                   n[        UR                  X!5      5      I Sh  vN   U R                  S5        U R	                  5         g N&7f)z+delete clears a checkpoint for a given fileNr   )rc   r   delete_checkpointrR   rK   r   s       r   r   ModifyCheckpointsHandler.delete  sF      ""2//DEEE 	Fr   r3   N)r4   r5   r6   r7   r8   r   r   r
   r   r   r;   r3   r/   r   r   r   t  sG    -   	  r/   r   c                   <    \ rS rSrSrSr\S 5       r\=r=r	=r
rSrg)NotebooksRedirectHandleri  z(Redirect /api/notebooks to /api/contents)GETPUTPATCHPOSTDELETEc           	          U R                   R                  S5        U R                  [        U R                  S[        U5      5      5        g)zHandle a notebooks redirect.z//api/notebooks is deprecated, use /api/contentsr   N)rx   r   redirectr   rA   r   rB   s     r   ri   NotebooksRedirectHandler.get  s5     	JKmDMM>:dCSTUr/   r3   N)r4   r5   r6   r7   r8   SUPPORTED_METHODSr	   ri   r   rt   r   r   r;   r3   r/   r   r   r     s9    2 V V
 #&%C%%%$r/   r   c                   R    \ rS rSrSr\R                  \" \S9SS j5       5       r	Sr
g)TrustNotebooksHandleri  z"Handles trust/signing of notebooks)resourcec                    #    U R                   n[        UR                  U5      5      I Sh  vN   U R                  S5        U R	                  5         g N&7f)zTrust a notebook by path.Nrw   )rc   r   trust_notebookrR   rK   r   s      r   r   TrustNotebooksHandler.post  sE      ""2,,T2333 	4r   r3   Nr   )r4   r5   r6   r7   r8   r   r   r
   r9   r   r;   r3   r/   r   r   r     s*    ,' ( r/   r   z(?P<checkpoint_id>[\w-]+)z/api/contents%s/checkpointsz/api/contentsz/checkpoints/z/api/contents%s/trustz/api/contents%sz/api/notebooks/?(.*))FF)'r8   rL   httpr   typingr   jupyter_client.jsonutilr   ImportErrorr   jupyter_core.utilsr   tornador   jupyter_server.auth.decoratorr	   r
   jupyter_server.base.handlersr   r   r   jupyter_server.utilsr   r   r9   booldictstrlistr   r.   r1   r=   r   r   r   r   _checkpoint_id_regexdefault_handlersr3   r/   r   <module>r      s)     E4 ,  K O O :4 S#X d3i * GF" "y( yx+ >1 ,&~ &(
N 
$ 4  $j02DEM2F1GH  
*,AB*$o667	 K  EDEs   B? ?CC