Difference between revisions of "ZIP Module"

From BaseX Documentation
Jump to navigation Jump to search
 
(43 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This module contains [[Querying#Functions|XQuery Functions]] to handle ZIP archives. The contents of ZIP files can be extracted and listed, and new archives can be created. All functions are preceded by the <code>zip:</code> prefix, which is linked to the <code>http://expath.org/ns/zip</code> namespace. The module is based on the [http://expath.org/spec/zip EXPath ZIP Module].
+
This [[Module Library|XQuery Module]] contains functions to handle ZIP archives. The contents of ZIP files can be extracted and listed, and new archives can be created. The module is based on the [http://expath.org/spec/zip EXPath ZIP Module]. Please note that the ZIP module is not being actively maintained but is still distributed for compatibility with older applications. We recommend you use the [[Archive Module]] wherever possible.
  
== Example ==
+
=Conventions=
* [[Modify a Word document]]
+
 
 +
All functions in this module are assigned to the <code><nowiki>http://expath.org/ns/zip</nowiki></code> namespace, which is statically bound to the {{Code|zip}} prefix.<br/>
 +
All errors are assigned to the <code><nowiki>http://expath.org/ns/error</nowiki></code> namespace, which is statically bound to the {{Code|experr}} prefix.
 +
 
 +
=Functions=
  
 
==zip:binary-entry==
 
==zip:binary-entry==
{|
+
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|<code><b>zip:binary-entry</b>($uri as xs:string, $path as xs:string) as xs:base64Binary</code><br />
+
|{{Func|zip:binary-entry|$uri as xs:string, $path as xs:string|xs:base64Binary}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Extracts the binary file at <code>$path</code> within the ZIP file located at <code>$uri</code> and returns it as an <code>xs:base64Binary</code> item.<br />
+
|Extracts the binary file at {{Code|$path}} within the ZIP file located at {{Code|$uri}} and returns it as an {{Code|xs:base64Binary}} item.
 
|-
 
|-
| valign='top' | '''Errors'''
+
| '''Errors'''
|<b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0001]]</b> is raised if the specified path does not exist.<br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0003]]</b> is raised if the operation fails for some other reason.
+
|{{Error|ZIP0001|#Errors}} the specified path does not exist.<br />{{Error|ZIP0003|#Errors}} the operation fails for some other reason.
 
|}
 
|}
  
 
==zip:text-entry==
 
==zip:text-entry==
{|
+
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|<code><b>zip:text-entry</b>($uri as xs:string, $path as xs:string) as xs:string</code><br /><code><b>zip:text-entry</b>($uri as xs:string, $path as xs:string, $encoding as xs:string) as xs:string</code>
+
|{{Func|zip:text-entry|$uri as xs:string, $path as xs:string|xs:string}}<br />{{Func|zip:text-entry|$uri as xs:string, $path as xs:string, $encoding as xs:string|xs:string}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Extracts the text file at <code>$path</code> within the ZIP file located at <code>$uri</code> and returns it as an <code>xs:string</code> item.<br />An optional encoding can be specified via <code>$encoding</code>.
+
|Extracts the text file at {{Code|$path}} within the ZIP file located at {{Code|$uri}} and returns it as an {{Code|xs:string}} item.<br />An optional encoding can be specified via {{Code|$encoding}}.
 
|-
 
|-
| valign='top' | '''Errors'''
+
| '''Errors'''
|<b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0001]]</b> is raised if the specified path does not exist.<br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0003]]</b> is raised if the operation fails for some other reason.
+
|{{Error|ZIP0001|#Errors}} the specified path does not exist.<br />{{Error|ZIP0003|#Errors}} the operation fails for some other reason.
 
|}
 
|}
  
 
==zip:xml-entry==
 
==zip:xml-entry==
{|
+
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|<code><b>zip:xml-entry</b>($uri as xs:string, $path as xs:string) as document-node()</code><br />
+
|{{Func|zip:xml-entry|$uri as xs:string, $path as xs:string|document-node()}}<br />
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Extracts the XML file at <code>$path</code> within the ZIP file located at <code>$uri</code> and returns it as a document node.
+
|Extracts the XML file at {{Code|$path}} within the ZIP file located at {{Code|$uri}} and returns it as a document node.
 
|-
 
|-
| valign='top' | '''Errors'''
+
| '''Errors'''
|<b>[[XQuery Errors#ZIP Functions Errors (FODC)|FODC0006]]</b> is raised if the addressed file is not well-formed.<br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0001]]</b> is raised if the specified path does not exist.<br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0003]]</b> is raised if the operation fails for some other reason.
+
|{{Error|ZIP0001|#Errors}} the specified path does not exist.<br />{{Error|ZIP0003|#Errors}} the operation fails for some other reason.
 
|}
 
|}
  
 
==zip:html-entry==
 
==zip:html-entry==
{|
+
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|<code><b>zip:html-entry</b>($uri as xs:string, $path as xs:string) as document-node()</code><br />
+
|{{Func|zip:html-entry|$uri as xs:string, $path as xs:string|document-node()}}<br />
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Extracts the HTML file at <code>$path</code> within the ZIP file located at <code>$uri</code> and returns it as a document node. The file is converted to XML first if [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is found in the classpath.
+
|Extracts the HTML file at {{Code|$path}} within the ZIP file located at {{Code|$uri}} and returns it as a document node. The file is converted to XML first if [[Parsers#HTML_Parser|Tagsoup]] is found in the classpath.
 
|-
 
|-
| valign='top' | '''Errors'''
+
| '''Errors'''
|<b>[[XQuery Errors#ZIP Functions Errors (FODC)|FODC0006]]</b> is raised if the addressed file is not well-formed, or cannot be converted to correct XML.<br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0001]]</b> is raised if the specified path does not exist.<br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0003]]</b> is raised if the operation fails for some other reason.
+
|{{Error|ZIP0001|#Errors}} the specified path does not exist.<br />{{Error|ZIP0003|#Errors}} the operation fails for some other reason.
 
|}
 
|}
  
 
==zip:entries==
 
==zip:entries==
{|
+
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|<code><b>zip:entries</b>($uri as xs:string) as element(zip:file)</code><br />
+
|{{Func|zip:entries|$uri as xs:string|element(zip:file)}}<br />
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Generates an [http://expath.org/spec/zip#spec-file-handling-elements-sect XML Representation] of the hierarchical structure of the ZIP file located at <code>$uri</code> and returns it as an element node. The contents are not returned by this function.
+
|Generates an [http://expath.org/spec/zip#spec-file-handling-elements-sect ZIP XML Representation] of the hierarchical structure of the ZIP file located at {{Code|$uri}} and returns it as an element node. The file contents are not returned by this function.
 
|-
 
|-
| valign='top' | '''Errors'''
+
| '''Errors'''
|<b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0001]]</b> is raised if the specified path does not exist.<br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0003]]</b> is raised if the operation fails for some other reason.
+
|{{Error|ZIP0001|#Errors}} the specified path does not exist.<br />{{Error|ZIP0003|#Errors}} the operation fails for some other reason.
 
|-
 
|-
| valign='top' | '''Examples'''
+
| '''Examples'''
|If the ZIP archive <code>archive.zip</code> is empty, <code>zip:entries('archive.zip')</code> returns <code><zip:file xmlns:zip="http://expath.org/ns/zip" href="archive.zip"/></code>.<br />
+
|If the ZIP archive {{Code|archive.zip}} is empty, {{Code|zip:entries('archive.zip')}} returns:
 +
<syntaxhighlight lang="xml">
 +
<zip:file xmlns:zip="http://expath.org/ns/zip" href="archive.zip"/>
 +
</syntaxhighlight>
 
|}
 
|}
  
 
==zip:zip-file==
 
==zip:zip-file==
{|
+
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|<code><b>zip:zip-file</b>($zip as element(zip:file)) as empty-sequence()</code><br />
+
|{{Func|zip:zip-file|$zip as element(zip:file)|empty-sequence()}}<br />
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Creates a new ZIP archive with the characteristics described by <code>$zip</code>, the [http://expath.org/spec/zip#spec-file-handling-elements-sect XML Representation].
+
|Creates a new ZIP archive with the characteristics described by {{Code|$zip}}, the [http://expath.org/spec/zip#spec-file-handling-elements-sect ZIP XML Representation].
 
|-
 
|-
| valign='top' | '''Errors'''
+
| '''Errors'''
|<b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0001]]</b> is raised if an addressed file does not exist.<br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0002]]</b> is raised if entries in the ZIP archive description are unknown, missing, or invalid.</b><br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0003]]</b> is raised if the operation fails for some other reason.<br /><b>[[XQuery Errors#Serialization Errors (SEPM, SERE, SESU)|Serialization Errors]]</b> are raised if an inlined XML fragment cannot be successfully serialized.
+
|{{Error|ZIP0001|#Errors}} an addressed file does not exist.<br />{{Error|ZIP0002|#Errors}} entries in the ZIP archive description are unknown, missing, or invalid.<br />{{Error|ZIP0003|#Errors}} the operation fails for some other reason.
 
|-
 
|-
| valign='top' | '''Examples'''
+
| '''Examples'''
|The following function creates a file <code>archive.zip</code> with the file <code>file.txt</code> inside:<br /><code>zip:zip-file(<file xmlns="http://expath.org/ns/zip" href="archive.zip"><entry src="file.txt"/></file>)</code><br/>The following function creates a file <code>archive.zip</code>. It contains one file <code>readme</code> with the content "<code>thanks</code>":<br /><code>zip:zip-file(<file xmlns="http://expath.org/ns/zip" href="archive.zip"><entry name="readme">thanks</entry></file>)</code>
+
|The following function creates a file {{Code|archive.zip}} with the file {{Code|file.txt}} inside:
 +
<syntaxhighlight lang="xquery">
 +
zip:zip-file(
 +
  <file xmlns="http://expath.org/ns/zip" href="archive.zip">
 +
    <entry src="file.txt"/>
 +
  </file>)
 +
</syntaxhighlight>
 +
The following function creates a file {{Code|archive.zip}}. It contains one file {{Code|readme}} with the content "{{Code|thanks}}":
 +
<syntaxhighlight lang="xquery">
 +
zip:zip-file(
 +
  <file xmlns="http://expath.org/ns/zip" href="archive.zip">
 +
    <entry name="readme">thanks</entry>
 +
  </file>)
 +
</syntaxhighlight>
 
|}
 
|}
  
 
==zip:update-entries==
 
==zip:update-entries==
{|
+
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|<code><b>zip:update-entries</b>($zip as element(zip:file), $output as xs:string) as empty-sequence()</code><br />
+
|{{Func|zip:update-entries|$zip as element(zip:file), $output as xs:string|empty-sequence()}}<br />
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Updates an existing ZIP archive or creates a modifed copy, based on the characteristics described by <code>$zip</code>, the [http://expath.org/spec/zip#spec-file-handling-elements-sect XML Representation]. The <code>$output</code> argument is the URI where the modified ZIP file is copied to.
+
|Updates an existing ZIP archive or creates a modifed copy, based on the characteristics described by {{Code|$zip}}, the [http://expath.org/spec/zip#spec-file-handling-elements-sect ZIP XML Representation]. The {{Code|$output}} argument is the URI where the modified ZIP file is copied to.
 
|-
 
|-
| valign='top' | '''Errors'''
+
| '''Errors'''
|<b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0001]]</b> is raised if an addressed file does not exist.<br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0002]]</b> is raised if entries in the ZIP archive description are unknown, missing, or invalid.</b><br /><b>[[XQuery Errors#ZIP Functions Errors (FOZP)|FOZP0003]]</b> is raised if the operation fails for some other reason.<br /><b>[[XQuery Errors#Serialization Errors (SEPM, SERE, SESU)|Serialization Errors]]</b> are raised if an inlined XML fragment cannot be successfully serialized.
+
|{{Error|ZIP0001|#Errors}} an addressed file does not exist.<br />{{Error|ZIP0002|#Errors}} entries in the ZIP archive description are unknown, missing, or invalid.<br />{{Error|ZIP0003|#Errors}} the operation fails for some other reason.
 
|-
 
|-
| valign='top' | '''Examples'''
+
| '''Examples'''
|The following function creates a copy <code>new.zip</code> of the existing <code>archive.zip</code> file:<br /><code>zip:update-entries(zip:entries('archive.zip'), 'new.zip')</code><br />The following function deletes all PNG files from <code>archive.zip</code>:<br /><code>declare namespace zip = "<nowiki>http://expath.org/ns/zip</nowiki>";<br/>copy $doc := zip:entries('archive.zip')<br/>modify delete node $doc//zip:entry[ends-with(lower-case(@name), '.png')]<br/>return zip:update-entries($doc, 'archive.zip')</code>
+
|The following function creates a copy {{Code|new.zip}} of the existing {{Code|archive.zip}} file:
 +
<syntaxhighlight lang="xquery">
 +
zip:update-entries(zip:entries('archive.zip'), 'new.zip')
 +
</syntaxhighlight>
 +
The following function deletes all PNG files from {{Code|archive.zip}}:
 +
<syntaxhighlight lang="xquery">
 +
declare namespace zip = "http://expath.org/ns/zip";
 +
copy $doc := zip:entries('archive.zip')
 +
modify delete node $doc//zip:entry[ends-with(lower-case(@name), '.png')]
 +
return zip:update-entries($doc, 'archive.zip')
 +
</syntaxhighlight>
 
|}
 
|}
  
[[Category:XQuery]]
+
=Errors=
 +
 
 +
{| class="wikitable" width="100%"
 +
! width="110"|Code
 +
|Description
 +
|-
 +
|{{Code|ZIP0001}}
 +
|A specified path does not exist.
 +
|-
 +
|{{Code|ZIP0002}}
 +
|Entries in the ZIP archive description are unknown, missing, or invalid.
 +
|-
 +
|{{Code|ZIP0003}}
 +
|An operation fails for some other reason.
 +
|}

Latest revision as of 14:16, 27 February 2020

This XQuery Module contains functions to handle ZIP archives. The contents of ZIP files can be extracted and listed, and new archives can be created. The module is based on the EXPath ZIP Module. Please note that the ZIP module is not being actively maintained but is still distributed for compatibility with older applications. We recommend you use the Archive Module wherever possible.

Conventions[edit]

All functions in this module are assigned to the http://expath.org/ns/zip namespace, which is statically bound to the zip prefix.
All errors are assigned to the http://expath.org/ns/error namespace, which is statically bound to the experr prefix.

Functions[edit]

zip:binary-entry[edit]

Signatures zip:binary-entry($uri as xs:string, $path as xs:string) as xs:base64Binary
Summary Extracts the binary file at $path within the ZIP file located at $uri and returns it as an xs:base64Binary item.
Errors ZIP0001: the specified path does not exist.
ZIP0003: the operation fails for some other reason.

zip:text-entry[edit]

Signatures zip:text-entry($uri as xs:string, $path as xs:string) as xs:string
zip:text-entry($uri as xs:string, $path as xs:string, $encoding as xs:string) as xs:string
Summary Extracts the text file at $path within the ZIP file located at $uri and returns it as an xs:string item.
An optional encoding can be specified via $encoding.
Errors ZIP0001: the specified path does not exist.
ZIP0003: the operation fails for some other reason.

zip:xml-entry[edit]

Signatures zip:xml-entry($uri as xs:string, $path as xs:string) as document-node()
Summary Extracts the XML file at $path within the ZIP file located at $uri and returns it as a document node.
Errors ZIP0001: the specified path does not exist.
ZIP0003: the operation fails for some other reason.

zip:html-entry[edit]

Signatures zip:html-entry($uri as xs:string, $path as xs:string) as document-node()
Summary Extracts the HTML file at $path within the ZIP file located at $uri and returns it as a document node. The file is converted to XML first if Tagsoup is found in the classpath.
Errors ZIP0001: the specified path does not exist.
ZIP0003: the operation fails for some other reason.

zip:entries[edit]

Signatures zip:entries($uri as xs:string) as element(zip:file)
Summary Generates an ZIP XML Representation of the hierarchical structure of the ZIP file located at $uri and returns it as an element node. The file contents are not returned by this function.
Errors ZIP0001: the specified path does not exist.
ZIP0003: the operation fails for some other reason.
Examples If the ZIP archive archive.zip is empty, zip:entries('archive.zip') returns:
<zip:file xmlns:zip="http://expath.org/ns/zip" href="archive.zip"/>

zip:zip-file[edit]

Signatures zip:zip-file($zip as element(zip:file)) as empty-sequence()
Summary Creates a new ZIP archive with the characteristics described by $zip, the ZIP XML Representation.
Errors ZIP0001: an addressed file does not exist.
ZIP0002: entries in the ZIP archive description are unknown, missing, or invalid.
ZIP0003: the operation fails for some other reason.
Examples The following function creates a file archive.zip with the file file.txt inside:
zip:zip-file(
  <file xmlns="http://expath.org/ns/zip" href="archive.zip">
    <entry src="file.txt"/>
  </file>)

The following function creates a file archive.zip. It contains one file readme with the content "thanks":

zip:zip-file(
  <file xmlns="http://expath.org/ns/zip" href="archive.zip">
    <entry name="readme">thanks</entry>
  </file>)

zip:update-entries[edit]

Signatures zip:update-entries($zip as element(zip:file), $output as xs:string) as empty-sequence()
Summary Updates an existing ZIP archive or creates a modifed copy, based on the characteristics described by $zip, the ZIP XML Representation. The $output argument is the URI where the modified ZIP file is copied to.
Errors ZIP0001: an addressed file does not exist.
ZIP0002: entries in the ZIP archive description are unknown, missing, or invalid.
ZIP0003: the operation fails for some other reason.
Examples The following function creates a copy new.zip of the existing archive.zip file:
zip:update-entries(zip:entries('archive.zip'), 'new.zip')

The following function deletes all PNG files from archive.zip:

declare namespace zip = "http://expath.org/ns/zip";
copy $doc := zip:entries('archive.zip')
modify delete node $doc//zip:entry[ends-with(lower-case(@name), '.png')]
return zip:update-entries($doc, 'archive.zip')

Errors[edit]

Code Description
ZIP0001 A specified path does not exist.
ZIP0002 Entries in the ZIP archive description are unknown, missing, or invalid.
ZIP0003 An operation fails for some other reason.