Monkeybread Software - MBS FileMaker Plugin: Archive.ExtractFile

Components	All	New	MacOS		Windows		Linux		iOS
Examples	Mac & Win		Server	Client	Guides	Statistic	FMM	Blog	Deprecated	Old

Archive.ExtractFile

Extracts one file and returns as container.

Component	Version	macOS	Windows	Linux	Server	iOS SDK
Archive	10.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	✅ Yes

MBS( "Archive.ExtractFile"; Archive; FilePath { ; Passphrase; New file name; Options } ) More

Parameters

Parameter Description Example Flags

Archive Either container with archive or native file path. "C:\test\test.zip"

FilePath The path name of the file within the archive.
Or since version 14.3 the index of the item starting with 0 for the first file. "test/test.jpg"

Passphrase Password to use for the archive. Optional

New file name The new file name to use for container.
Default is to use name of the item in the zip archive. Optional

Options The options to pass to reader.
This is a comma-separated list of options. Option names can be prefixed with module name. "hdrcharset=cp1252" Optional

Added in version 14.3.

Parameter	Description	Example	Flags
Archive	Either container with archive or native file path.	"C:\test\test.zip"
FilePath	The path name of the file within the archive. Or since version 14.3 the index of the item starting with 0 for the first file.	"test/test.jpg"
Passphrase	Password to use for the archive.		Optional
New file name	The new file name to use for container. Default is to use name of the item in the zip archive.		Optional
Options	The options to pass to reader. This is a comma-separated list of options. Option names can be prefixed with module name.	"hdrcharset=cp1252"	Optional Added in version 14.3.

Result

Returns container or error.

Description

Extracts one file and returns as container.
You may use Archive.FileList to get a list of file names in the archive.

For pure gz file without an archive, you can use Archive.GZipDecompress function.

Examples

Extract one PDF file:

Set Field [ Contacts::Photo Container ; MBS( "Archive.ExtractFile"; "/Users/cs/Desktop/Archiv.zip"; "test40.pdf") ]

Show version number of MBS plugin in Mac container:

# extract info file with metadata
Set Variable [ $InfoFile ; Value: MBS( "Archive.ExtractFile"; Install Plugin Update if needed::Plugin File Mac; "MBS.fmplugin/Contents/Info.plist" ) ]
# get it as text
Set Variable [ $InfoText ; Value: MBS( "Container.GetText"; $InfoFile; "FILE") ]
# query version entry in XML
Set Variable [ $version ; Value: MBS( "XML.GetPathValue"; $InfoText; "plist.dict.string[6]") ]
Show Custom Dialog [ "Version of MBS Plugin" ; $version ]

<?xml version="1.0" encoding="UTF-8"?>
<fmxmlsnippet type="FMObjectList">
  <Step enable="True" id="89" name="# (comment)">
    <Text> extract info file with metadata</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS( "Archive.ExtractFile"; Install Plugin Update if needed::Plugin File Mac; "MBS.fmplugin/Contents/Info.plist" ) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$InfoFile</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> get it as text</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS( "Container.GetText"; $InfoFile; "FILE") </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$InfoText</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> query version entry in XML</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS( "XML.GetPathValue"; $InfoText; "plist.dict.string[6]") </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$version</Name>
  </Step>
  <Step enable="True" id="87" name="Show Custom Dialog">
    <Title>
      <Calculation> "Version of MBS Plugin" </Calculation>
    </Title>
    <Message>
      <Calculation>$version </Calculation>
    </Message>
    <Buttons>
      <Button CommitState="True">
        <Calculation>"OK"</Calculation>
      </Button>
      <Button CommitState="False">
        <Calculation>"Cancel"</Calculation>
      </Button>
      <Button CommitState="False"/>
    </Buttons>
  </Step>
</fmxmlsnippet>

Extract Mac version number via RegEx:

# extract info file with metadata
Set Variable [ $InfoFile ; Value: MBS( "Archive.ExtractFile"; Install Plugin Update if needed::Plugin File Mac; "MBS.fmplugin/Contents/Info.plist" ) ]
# get version as text
Set Variable [ $version ; Value: MBS( "RegEx.Extract"; $infoText; "<key>CFBundleVersion</key>\s*<string>(.*)</string>"; "\1"; "greedy, caseless" ) ]
Show Custom Dialog [ "MBS Version" ; $version ]

<?xml version="1.0" encoding="UTF-8"?>
<fmxmlsnippet type="FMObjectList">
  <Step enable="True" id="89" name="# (comment)">
    <Text> extract info file with metadata</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS( "Archive.ExtractFile"; Install Plugin Update if needed::Plugin File Mac; "MBS.fmplugin/Contents/Info.plist" ) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$InfoFile</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> get version as text</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS( "RegEx.Extract"; $infoText; "&lt;key&gt;CFBundleVersion&lt;/key&gt;\s*&lt;string&gt;(.*)&lt;/string&gt;"; "\1"; "greedy, caseless" ) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$version</Name>
  </Step>
  <Step enable="True" id="87" name="Show Custom Dialog">
    <Title>
      <Calculation> "MBS Version" </Calculation>
    </Title>
    <Message>
      <Calculation>$version </Calculation>
    </Message>
    <Buttons>
      <Button CommitState="True">
        <Calculation>"OK"</Calculation>
      </Button>
      <Button CommitState="False">
        <Calculation>"Cancel"</Calculation>
      </Button>
      <Button CommitState="False"/>
    </Buttons>
  </Step>
</fmxmlsnippet>

Extract first file:

MBS( "Archive.ExtractFile"; "/Users/cs/Desktop/test.zip"; 0)

Extract first file with password:

MBS( "Archive.ExtractFile"; "/Users/cs/Desktop/test.zip"; 0; "Hello"; "test.txt"; "hdrcharset=UTF-8")