B b8F@sdZddlmZddlmZddlmZdZdZdZdZdd l Z dd l Z dd l Z dd l Z dd l Z dd lZdd lZy dd lZWnek rdd lZYnXdd lmZdd lmZe eZGd d d eZGdddeZGdddeZd S)a ApiBase.py ^^^^^^^^^^ Core methods supporting the wwPDB OneDep webservice API. :copyright: @wwPDB :license: Apache 2.0, see LICENSE file for more details. Updates: 3-Aug-2016 jdw add Authorization header 20-Sep-2016 jdw refactor for standard packaging 21-Sep-2016 jdw add download by name and type. 21-Sep-2016 jdw make parameters optional in all prototypes 25-Sep-2016 jdw revise exception handling )print_function)unicode_literals)divisionzrestructuredtext enzJohn Westbrookzjwest@rcsb.rutgers.eduz Apache 2.0N) __version__)InsecureRequestWarningc@seZdZd0ddZddZddZd d Zd1d d ZddZddZ ddZ ddZ ddZ d2ddZ d3ddZd4ddZd5d d!Zd6d#d$Zd7d%d&Zd'd(Zd)d*Zd8d,d-Zd.d/ZdS)9ApiBaseNTcCstdd|_|r|nd|_|r&|nd|_|r4|nd|_t|_|rL|ndt t j df|jj d<d d |jf|jj d <d |_d |_d|_||_i|_|stjjtdS)a Core methods supporting the OneDep web client API. :param string apiKey: (Optional) security token. :param string userAgent: (Optional) alternative identifier for calling application. :param string apiName: (Optional) API service name :param string apiUrl: (Optional) API service base URL. :param string verify: (Optional) verify SSL certificate zService initializingizhttps://localhostZ anonymousonedepzOneDepApiClient/%s Python/%s rz User-Agentz%s %sZBearerzwwpdb-api-tokenZonedep_error_flagZonedep_status_textN)logdebug_ApiBase__chunkSize_apiUrlZ_apiKey_apiNamerequestssession_ApiBase__myreqrsysversionsplitheaders_returnApiErrorFlagKey_returnApiStatusTextKey _sessionId_verify_reservedContentTypesZpackagesZurllib3Zdisable_warningsr)selfZapiKeyZ userAgentZapiNameapiUrlverifyr3lib/python3.7/site-packages/onedep/utils/ApiBase.py__init__5s  &zApiBase.__init__cCs"i}|jd|}|dd|_|S)zCreate and maintain a session context in all subsequent API requests. :rtype: json service response converted to dictionary (with mininal keys: api_error_flag, api_status_text, session_id) r session_idN)r)postgetr)rpDrDrrr createSessionUs zApiBase.createSessioncCs ||_dS)z3Set the identifier for the current session context.N)r)rZ sessionIdrrr setSession`szApiBase.setSessioncCs|jS)N)r)rrrr getSessiondszApiBase.getSessionFcCs*|js|r|d|kr&||d<dS)zUInternal method to add the current session context to the input parameter dictionary.r N)rr%r')rr#autorrrZ__addSessionContextgs zApiBase.__addSessionContextcCs||_||_dS)N)rr)rZ errorFlagKeyZ statusTextKeyrrrsetApiReturnStatusKeysoszApiBase.setApiReturnStatusKeyscCs yt||_dSdSdS)NTF)copydeepcopyr)rZcontentTypeDictrrrsetContentTypesss  zApiBase.setContentTypescCsy |jSgSdS)N)rkeys)rrrrgetContentTypeszs zApiBase.getContentTypescCs||jkr|j|SgSdS)N)r)r contentTyperrrgetContentFormatLists  zApiBase.getContentFormatListcCs0y ||jkr|j|dSdSWn dSdS)Nr)r)rr/rrrgetContentFormatDefaults  zApiBase.getContentFormatDefaultdownloadcKs6i}x|D]}||||<q W||d<|j||f|S)aConstruct GET request to download the target fileName to dstPath. :param string fileName: file name target for download :param string dstPath: full local path to file for download :param string endPoint: API endPoint - valws. :param params: (Optional) Parameters as keyword arguments. :rtype: json response converted to dictionary filename)_ApiBase__download)rdstPathZfileNameendPointparams_paramsprrrdownloadByNames  zApiBase.downloadByNamecKspi}||jkr&d||j<d||j<|Si}x|D]}||||<q0W||d<|||d<|j|fd|i|S)aConstruct GET request to download the target data object type to dstPath. :param string contentType: data object content type target download :param string dstPath: full local path to file for download :param string endPoint: API endPoint - valws. :param params: (Optional) Parameters as keyword arguments. :rtype: json response converted to dictionary TzUnrecognized file typeZ contenttypeZ formattyper6)rrrr1r4)rr5r/r6r7r$r8r9rrrdownloadByTypes     zApiBase.downloadByTypec Ksi}x|D]}||||<q W||td||i}d||j<d||j<|j|j|j|f|}td|y|jj |||j dd}|j dkrt |d&} x| |jD]} | | qWWdQRXd ||j<d ||j<td |jjtd |jWn.tk r*} z|j| d dSd} ~ XYnX||\} } | rD| SyB||}|jd}||krzd||j<d||j<n tdWn$d||j<d|||j<YnX|S)aInternal method to construct GET request to download the target fileName or content type to dstPath. :param string dstPath: full path to file for download :param string endPoint: API endPoint - valws. :param params: Parameters as keyword arguments including file name/type specification and session details. :rtype: json response converted to dictionary z DOWNLOAD BEGINS for : %s %rTzMiscellaneous api failurezRequest: URL: %r)datarstreamwbNFokzdownload request headers %rzdownload response headers %rz%Download request processing exception) msgDefault checksum_md5zChecksum failurezchecksum comparison successz&Download checksum processing error %r )_ApiBase__addSessionContextr r rr_ApiBase__encodeUrlr r rr"r status_codeopenZ iter_contentr writerequestr Exception_ApiBase__filterExceptions_ApiBase__filterErrorsgetMD5)rr5r6r7r8r9r$urlresponsefchunkeerrFlagerrDZmyDigestZ theDigestrrrZ __downloadsH                zApiBase.__downloaduploadc Ks2td|||i}d||j<d||j<||jkrJd||j<d||j<|S||j|krpd||j<d||j<|Std|i}x|D]}||||<qWtd|||td|yL||} | |d <tj |\} } t |d } d | | fi} ||d <||d <Wnd||j<d||j<|Sd|j |j |f}td||y*|j j|| ||jd}td|jjWn.tk r}z|j|ddSd}~XYnX||\}}|r|Sy2|t|j|d||j<|d||j<Wn@tk r,}z d||j<dt|||j<Wdd}~XYnX|S)aConstruct POST request to perform multipart/ file upload and return the JSON response. :param string filepath: full path to file for upload :param string contentType: type ['model', 'structure-factors', 'nmr-chemical-shifts', 'nmr-restraints', 'em-volume'] :param string fileFormat: (pdbx) :param string endPoint: API endPoint - valws. :param params: (Optional) Parameters as keyword arguments. :rtype: json response converted to dictionary >>> url = 'http://httpbin.org/post' >>> files = {'file': ('report.xls', open('report.xls', 'rb'), 'application/vnd.ms-excel', {'Expires': '0'})} >>> r = requests.post(url, files=files) zupload request: %s %s %sTzMiscellaneous api failurezUnrecognized file typezUnrecognized file formatz A params %rz B _params %rz C _params %rrBrbfileZ content_typeZ file_formatz&Input file access or processing error z%s/service/%s/%szRequest: URL: %s PARAMS: %r)filesr<rzpost headers %rz#Upload request processing exception)rAN errorflag statusmessagez#Upload response processing error %s)r r rrrrCrLospathrrFr r rr!rrHrrIrJrKupdatejsonloadstextstr)rZfilePathr/Z fileFormatr6r7r$r8r9md5_fnZfobjZfDrMrNrQrRrSrrrrTsb                   $zApiBase.uploadOneDep API service failurecCs>d}|}y t|}Wn YnXi}|||j<|||j<|S)zHandle typical exceptions and map these to response dictionary - :param exception: target exception object :rtype dictionary: response dictionary (with mininal keys: api_error_flag, api_status_text) T)r`rr)rZ exceptionrA errorFlagmsgr$rrrZ__filterExceptionsCs   zApiBase.__filterExceptionscCsrd}d}y<|jdkrBd}|}yt|j}|d}Wn YnXWn YnXi}|||j<|||j<||fS)a(Check the response packet for typical error various error types and map these to response dictionary - :param rsp request response object: target response object :rtype tuple: errorFlag, response dictionary (with mininal keys: api_error_flag, api_status_text) FZ unprocessed)iiTZ statustext)rEr]r^r_rr)rrNrArerfrSr$rrrZ__filterErrorsWs"       zApiBase.__filterErrorsc KsDi}d||j<d||j<d|j|j|f}i}x|D]}||||<q4W||td||y(|jj|||j d}td|j j Wn,t k r}z|j |ddSd }~XYnX||\} } | r| Sy2|t|j|d ||j<|d ||j<Wn@t k r>}z d||j<d t|||j<Wd d }~XYnX|S) zConstruct POST request and return the JSON response. :param string endPoint: API endPoint - valws. :param params: (Optional) Parameters as keyword arguments. :rtype: json response converted to dictionary TzMiscellaneous api failurez%s/service/%s/%szRequest: %s %s)r<rzpost headers %rz!POST request processing exception)rANrXrYz!POST request processing error %r )rrr r rCr r rr!rrHrrIrJrKr\r]r^r_r`) rr6r7r$rMr8r9rNrQrRrSrrrr!ts2     $z ApiBase.postc Ks8i}d||j<d||j<i}x|D]}||||<q"W|||j|j|j|f|}y&|jj||jd}t d|j j Wn,t k r}z|j|ddSd}~XYnX||\} } | r| Sy2|t|j|d||j<|d ||j<Wn@t k r2}z d||j<d t|||j<Wdd}~XYnX|S) zConstruct GET request and return the JSON response. :param string endPoint: API endPoint - valws. :param params: (Optional) Parameters as keyword arguments. :rtype: json response converted to dictionary TzMiscellaneous api failure)rzget headers %rz GET request processing exception)rANrXrYz GET request processing error %r )rrrCrDr r rr"rr r rHrrIrJrKr\r]r^r_r`) rr6r7r$r8r9rMrNrQrRrSrrrr"s0     $z ApiBase.getc sZt}t|d.x&tfdddD]}||q*WWdQRX|rR|S|S)a Chunked MD5 function - Block size directly depends on the block size of your filesystem to avoid performances issues Linux Ext4 block size sudo /sbin/blockdev --getbsz /dev/sda1 > Block size: 4096 rUcs S)N)readr) block_sizerOrrz ApiBase.getMD5..rkN)hashlibrarFiterr\Z hexdigestZdigest)rr[rihrrarPr)rirOrrLs  zApiBase.getMD5c KsRg}x6|D]*\}}|d|tjjjt|fqWd|||d|fS)aInternal method to construct API url for a GET request. :param string api: the api service name - :param string endPoint: API endPoint - valws. :param params: (Optional) Parameters as keyword arguments. :rtype: string z%s=%sz%s/service/%s/%s?%s&) itemsappendsixZmovesZurllibparseZ quote_plusr`join)rrZapir6r7ZqskvrrrZ __encodeUrls &zApiBase.__encodeUrl)NNNNT)F)r2)r2)r2)rT)rd)rd)rgT)__name__ __module__ __qualname__rr%r&r'rCr)r,r.r0r1r:r;r4rTrJrKr!r"rLrDrrrrr4s(      9 O  '% rc@seZdZdZdS) ApiExceptionzService general exception.N)rwrxry__doc__rrrrrzsrzc@seZdZdZdS)ApiAuthExceptionz!Service authentication exception.N)rwrxryr{rrrrr|sr|)r{Z __future__rrrZ __docformat__ __author__Z __email__Z __license__ZloggingrrZr*rlrrrr] ImportErrorZ simplejsonrrZ$requests.packages.urllib3.exceptionsrZ getLoggerrwr objectrrIrzr|rrrrs6       3