U Nf@s0ddlZddlZddlmZmZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZddlmZmZddlmZmZddlmZdd lmZmZmZmZmZmZm Z m!Z!m"Z"dd l#m$Z%dd l&m'Z'm(Z(m)Z)m*Z*m+Z+dd l,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8dd l9m:Z:GdddeZ;dS)N)BytesIOUnsupportedOperation)Path) AnyCallableDictIterableListOptionalTupleUnioncast) PdfDocCommonconvert_to_int) Encryption PasswordType) PageObject) StrByteType StreamTypeb_logger_warningread_non_whitespaceread_previous_lineread_until_whitespaceskip_over_commentskip_over_whitespace) TrailerKeys)EmptyFileErrorFileNotDecryptedError PdfReadErrorPdfStreamErrorWrongPasswordError) ArrayObject ContentStreamDecodedStreamObjectDictionaryObjectEncodedStreamObjectIndirectObject NameObject NullObject NumberObject PdfObjectTextStringObject read_object)XmpInformationc @s&eZdZdZdTeeefeedee fddddZ e e ddd Z e ee dd d Ze eedd d ZdUedeefedeefeeefdddZe edddZe eedddZeedddZedeeefeedddZeeeeefdddZ eeefeedddZ!e"e#eefdd d!Z$eeeed"d#d$Z%eeeeeed%d&d'Z&eeed(d)d*Z'e"ddd+d,Z(e"ddd-d.Z)e"ddd/d0Z*e"edd1d2Z+e"ddd3d4Z,e"eeedd5d6d7Z-e"eedd8d9Z.e"eeed:d;d<Z/e"ee0e1e2fdd=d>Z3e4e"eed:d?d@Z5e"dddAdBZ6e7ee8egeee#edCfffe8eeee#edCffgefddDdEdFZ9e7eee#eefdGdHdIZ:eee fe;dJdKdLZeee dOdRdSZ?dS)V PdfReadera Initialize a PdfReader object. This operation can take some time, as the PDF stream's cross-reference tables are read into memory. Args: stream: A File object or an object that supports the standard read and seek methods similar to a File object. Could also be a string representing a path to a PDF file. strict: Determines whether user should be warned of all problems and also causes some correctable problems to be fatal. Defaults to ``False``. password: Decrypt PDF file at initialization. If the password is None, the file will not be decrypted. Defaults to ``None``. FN)streamstrictpasswordreturnc Cs2||_d|_i|_d|_d|_t|drsz/PdfReader._repr_mimebundle_..csi|]\}}|kr||qSrRrRr_)r^rRrSrcs)r1seekrCitems)rOr]r^Zpdf_datadatarR)r^r]rS_repr_mimebundle_s  zPdfReader._repr_mimebundle_cCs>|j}|jdd|jddd}|j|d|S)z The first 8 bytes of the file. This is typically something like ``'%PDF-1.6'`` and can be used to detect if the file is actually a PDF file and which version it is. rzutf-8backslashreplace)r1tellrdrCdecode)rOlocZpdf_file_versionrRrRrS pdf_headers zPdfReader.pdf_headercCs&zd|_tt|jjWSd|_XdS)z(XMP (Extensible Metadata Platform) data.FTN)rDr r/rW xmp_metadatarVrRrRrSrnszPdfReader.xmp_metadata) page_numberr4cCs.|jdkr||jdk s$td|j|S)z Retrieve a page by number from this PDF file. Args: page_number: The page number to retrieve (pages begin at zero) Returns: A :class:`PageObject` instance. N hint for mypy)r:_flattenAssertionError)rOrorRrRrS _get_pages zPdfReader._get_page)indirect_referencer4cCsp|jdkr ddt|jD|_|dks2t|tr6dSt|trF|}n|j}|jdk s^td|j|d}|S)z Generate _page_id2num. Args: indirect_reference: Returns: The page number or None NcSsi|]\}}|jj|qSrR)rtidnum)r`ixrRrRrSrcsz:PdfReader._get_page_number_by_indirect..rp) r= enumerateZpagesr@r*intrurrrH)rOrtruretrRrRrS_get_page_number_by_indirects  z&PdfReader._get_page_number_by_indirectc Cs|j|j\}}t|d|}tt|ddks6t||dksFttt| }t |dD]}t || ddt |}t || ddt |}t || dd||jkrqb|jr||krtd| t|d|dt || ddzt||} Wnftk rz} zFtd |d |jd |jd | t|jrdtd | t} W5d} ~ XYnX| S|jrtdtS)Nr/Typez/ObjStmz/NrzObject is in wrong index.z/FirstzInvalid stream (index z) within object  z: zCannot read object stream: z%This is a fatal error in strict mode.) xref_objStmrur(rKr rArrrrget_datarangerrdr+Zread_from_streamr2r ryr.r!r generationr?r*) rOrtZstmnumidxZobj_stm stream_datarvZobjnumoffsetobjexcrRrRrS_get_object_from_stream sN       z!PdfReader._get_object_from_streamc Cs^t|trt|d|}||j|j}|dk r2|S|jdkrV|j|jkrV||}n|j|jkr|j|j|jkr|j |ji |jdrt S|j|j|j}|j |dz0||j \}}||jks||jkrtdWntk rt|j drt|j }n2|j }|j dd|j d}|j |dtd|jd|jd|}|dk rtd |jd |jd t|dd |j|j|j<|j |dd ||j \}}nd}YnX||jkr$|jr$|jr^td |jd|jd|d|d n:||jkr^|jr^td |jd|jd|d|d |jrv||jksvtt|j |}|j sH|j!dk rH|j!"st#dt$t%|}|j!&||j|j}n|t|j drt|j }n2|j }|j dd|j d}|j |dtd|jd|jd|}|dk rtd|jd|jdt|j|jkr~i|j|j<|dd |j|j|j<|j |'dd t(|j |j dd t|j |}|j sH|j!dk rH|j!"st#dt$t%|}|j!&||j|j}n,td|jd|jdt|jrHtd|)|j|j||S)NrFz¬ matching, we parse the file for it getbufferr}z\sz\s+z\s+objz Object ID ,z ref repairedrzExpected object ID (r~z) does not match actual (z); xref table not zero-indexed.z).zFile has not been decryptedzObject z foundz not defined.zCould not find object.)*r@ryr(cache_get_indirect_objectrrurrxrefxref_free_entryrHr*r1rdread_object_headerr Exceptionr>bytesrrjrCresearchencoderr?startr<r2rrr.rDrEZ is_decryptedrr r,Zdecrypt_objectendrcache_indirect_object) rOrtretvalrrurbufpmrRrRrSrKZs                        zPdfReader.get_object)r1r4cCsd}t||t|O}|ddt|}|t|O}|ddt|}|t|O}|dd|d}t||dd|r|jrtd|d|tt |t |fS)NFr}rz.Superfluous whitespace found in object header r~) rrrdrrCrr2rr?ry)rOr1extrarur_objrRrRrSrs&         zPdfReader.read_object_header)rrur4cCs|j||fSN)r;rH)rOrrurRrRrSrsz#PdfReader.cache_get_indirect_object)rrurr4cCs^||f|jkr6d|d|}|jr,t|t|t||j||f<|dk rZt||||_|S)NzOverwriting cache for r~)r;r2r rr?r(rt)rOrrurmsgrRrRrSrs zPdfReader.cache_indirect_object)indirectrr4cCsH|j|krtd|j|jf|jkr,td||j|j|jf<||_|S)Nz,Cannot update PdfReader with external objectzCannot find referenced object)Zpdf ValueErrorrrur;rt)rOrrrRrRrS_replace_objects zPdfReader._replace_objectc Cs||||||}|||}|dkrV|jrD|rDtdtd|dt|||||j r6|js6| }|j D]\}}|dkrqt |}|D]~}|||dz||\} } Wn$tk r||YqYnX| ||j kr|j |||j || <|j ||=qq||d|js| }|j D]\}}|dkrfqPt|} | D]d}|||dz||Wn>tk rtd|d|d||dt||=YnXqvqP||ddS) NrzBroken xref tablezincorrect startxref pointer()zIgnoring wrong pointing object r~z (offset )_basic_validation_find_eof_marker_find_startxref_pos_get_xref_issuesr2r rr?_read_xref_tables_and_trailersr<rjrresortedkeysrdrr_rebuild_xref_tablelist) rOr1 startxref xref_issue_nrrlgenZ xref_entryZxref_kr[pidZ_pgenidsrRrRrSrCsZ          zPdfReader.readcCs|dtjz|d}Wntk r8tdYnX|dkrLtdn6|dkr|jrrtd| dd nt d |t |dtj d S) z/Ensure file is not empty. Read at most 5 bytes.rzcannot read headerr8zCannot read an empty files%PDF-zPDF starts with 'utf8z', but '%PDF-' expectedzinvalid pdf header: N) rdosSEEK_SETrCUnicodeDecodeErrorrrr2r rkrr?SEEK_END)rOr1Z header_byterRrRrSrSs zPdfReader._basic_validationcCsLd}d}|dddkrH||kr>|jr4tdn tdtt|}qdS)a Jump to the %%EOF marker. According to the specs, the %%EOF marker should be at the very end of the file. Hence for standard-compliant PDF documents this function will read only the last part (DEFAULT_BUFFER_SIZE). rhr8Nrs%%EOFzEOF marker not found)rjr2r rr?r)rOr1Z HEADER_SIZElinerRrRrSrfs   zPdfReader._find_eof_markercCs~t|}z t|}WnDtk rX|ds6tdt|dd}tdtYn"Xt|}|dddkrztd|S)z Find startxref entry - the location of the xref table. Args: stream: Returns: The bytes offset s startxrefzstartxref not found Nz startxref on same line as offset)rryr startswithr striprr?)rOr1rrrRrRrSrxs   zPdfReader._find_startxref_poscCs|d}|dkrtdt||ddd}ttt||}|rd|dkrd||_|jrdt dt d }t||ddttt||}t |tst d t | ||dSt||ddd}||kr|d }|dd kr|d d|d }q|ddkr"|ddz8|dd d\}} |dd} t|t| } } Wntk rt|drt|} n(|}|dd|d} ||t|d| }|dkrt d|dt d} d} n(t d|dt t|d} |} YnX| |jkr8i|j| <i|j| <||j| krJnt| dkrb| |j| |<z| dk|j| |<Wntk rYnXz| dk|jd|<Wntk rYnX|d7}|d7}qt||dd|d}|dkr |ddq2q q2dS)Nrsrefzxref table read errorr}rTrzFXref table not zero-indexed. ID numbers for objects will be corrected.Fz,Invalid/Truncated xref table. Rebuilding it. is 0123456789t rz\s+(\d+)\s+objzentry z( in Xref table invalid; object not foundrz' in Xref table invalid but object foundnfstraileri)rCr rrdr ryr.r<r2rr?r@rsplitrr>rrrjrrrgrouprrr)rOr1refZ first_timenumsizeZcntrZoffset_bZ generation_bZ entry_type_brrrrfZ trailer_tagrRrRrS_read_standard_xref_tables                            z#PdfReader._read_standard_xref_table)r1rrr4c Csi|_i|_i|_t|_|dk r||d|d}|dkrL|d}|dkr`||}q|rz||WqWnt k rd}YnXq| rz| |}Wn^t k r }z>t j |jkrtd|jtWYqntd|jW5d}~XYnXt j t jt jt jt jf}|D]0}||kr(||jkr(|||jt|<q(d|kr|} |tt|ddd| ||| dd|krtt|d}nqq|||}qdS) Nrrrxz!Previous trailer can not be read ztrailer can not be read /XRefStm/Prev)rrrr&rGrdrC _read_xrefrrisdigit_read_pdf15_xref_streamrIrUrargsr?r rMrXrJZSIZEZraw_getr)rjr ry_read_xref_other_error) rOr1rrrw xrefstreameZ trailer_keyskeyrrRrRrSrsR            "    z(PdfReader._read_xref_tables_and_trailerscCs|||ddkrdS|ddt||ddttttft||}| D]\}}||j kr\||j |<q\d|kr| }|tt |dddz| |Wn*tk rtd|ddtYnX||dd|kr|d}|SdSdS) Nrr8r}rrzXRef object at z, can not be read, some object may be missingr)rrCrdrr rrArr.rerGrjryrrrr?)rOr1 new_trailerrvaluerrrRrRrSr8s2        zPdfReader._read_xref)r1rr4cCs|dkr$|jrtdtdtdS|dd|d}|d}|dkr\|d |8}|S||dtd D]"}|drp||7}|Sqpd |j kr|jstd tz| |WdSt k rtd YnXtddS)Nrz6/Prev=0 in the trailer (try opening with strict=False)zA/Prev=0 in the trailer - assuming there is no previous xref tableirrxrefr} z/Rootz"Invalid parent xref., rebuild xrefzcan not rebuild xrefz/Could not find xref table at specified location) r2r rr?rdrCfindrrrGrr)rOr1rtmpZxref_locZlookrRrRrSrTs:         z PdfReader._read_xref_other_errorcs|dd|\}}ttt|}tt|ddks@t|||tt | | dd| dg}tt t t f| dtd kstjrtd krtd tttttd ffd fd d }tttttd fftdfdd }||||S)Nr}rr|z/XRefz/Indexrz/Sizez/WrzToo many entry sizes: .)rvr4cs<|dkr(|}t||S|dkr4dSdSdS)Nrr)rCr)rvd) entry_sizesrrRrS get_entrys  z4PdfReader._read_pdf15_xref_stream..get_entry)rrr4cs|j|gkp|jkSr)rrHr)rrrVrRrS used_beforesz6PdfReader._read_pdf15_xref_stream..used_before)rdrr r$r.rArrrrrrrHrrlenr2r ryr r bool_read_xref_subsections)rOr1rurr idx_pairsrrrR)rrOrrSr}s &&z!PdfReader._read_pdf15_xref_streamcCs||dd|d}|dkr,|d}|dkr8dS|d}|dkrd}|dkrn|d}|dkrNd SqN||d 7}|d krd SdS) z Return an int which indicates an issue. 0 means there is no issue. Args: stream: startxref: Returns: 0 means no issue, other values represent specific issues. rrjs rr8s 0123456789 sobjr)rdrClower)r1rrrRrRrSrs"      zPdfReader._get_xref_issuesc Csi|_|dd|d}td|D]H}t|d}t|d}||jkr\i|j|<|d|j||<q(|ddtd|D]N}||ddtt t t ft ||}t | D]\}}||j|<qqdS)Nrr}s([\r\n \t][ \t]*(\d+)[ \t]+(\d+)[ \t]+objrrs$[\r\n \t][ \t]*trailer[\r\n \t]*(<<))rrdrCrfinditerryrrr rrr.rrerG) rOr1Zf_rrurrrrrRrRrSrs     zPdfReader._rebuild_xref_table.)rrrr4cCs||D]\}}t|||D]}|d}|dkrF|d}|d} q |dkr|d} |d} | |jkrri|j| <||| s| |j| |<q |dkr|d} |d} d} ||| s| | f|j|<q |jr td|q q dS)NrrrzUnknown xref type: )_pairsrrrr2r )rOrrrrrrZ xref_typeZnext_free_objectZnext_generationZ byte_offsetrZ objstr_numZ obstr_idxrRrRrSrs*     z PdfReader._read_xref_subsections)arrayr4ccs:d}||||dfV|d7}|dt|krq6qdS)Nrrr)r)rOrrvrRrRrSrs zPdfReader._pairs)r3r4cCs|jstd|j|S)a When using an encrypted / secured PDF file with the PDF Standard encryption handler, this function will allow the file to be decrypted. It checks the given password against the document's user password and owner password, and then stores the resulting decryption key if either password is correct. It does not matter which password was matched. Both passwords provide the correct decryption key that will allow the document to be used with this library. Args: password: The password to match. Returns: An indicator if the document was decrypted and whether it was the owner password or the user password. r9)rEr rN)rOr3rRrRrSdecryptszPdfReader.decryptcCs tj|jkS)z Read-only boolean property showing whether this PDF file is encrypted. Note that this property, if true, will remain true even after the :meth:`decrypt()` method is called. )rIrMrGrVrRrRrSrFszPdfReader.is_encrypted)namer4cCs|j}d|kst|dts dStt|td}d|kr>dSt}t||td<|td|td<|dtdd|jDd |t }| |j ||td<tt |dD]6}| }d |krt d |j d t|j |td <q|S) z Add a top level form that groups all form fields below it. Args: name: text string of the "/T" Attribute of the created object Returns: The created object. ``None`` means no object was created. /AcroFormN/Fields/Tz/KidsrcSsg|]\}}|dkr|qS)rrR)r`grvrRrRrS =sz.PdfReader.add_form_topname..rz/ParentzTop Level Form Field z have a non-expected parent)rWr@r&r r)r-rmaxr;r#appendrtrKrr?)rOrcatalogacroforminterimZarrorrRrRrSadd_form_topname#s:     zPdfReader.add_form_topnamecCsr|j}d|kst|dts dStt|td}d|kr>dStttt|tdd}t||td<|S)z Rename top level form field that all form fields below it. Args: name: text string of the "/T" field of the created object Returns: The modified object. ``None`` means no object was modified. rNrrr)rWr@r&r r)r#rKr-)rOrrrrrRrRrSrename_form_topnameMs  zPdfReader.rename_form_topname)FN)NN)@r? __module__ __qualname____doc__r rrrrArrTpropertyr&rWr rZr#r\rrrrgrmr/rnryrrsr*r(r{r,rrKrr rrrrrCrrrrrrrr$r'r%r staticmethodrrr rrrrrrFrrrRrRrRrSr0Us   4    ;     :w 1 * ( "  *r0)s ,  , 8