Semiconductor & Computer Engineering
$zip creates/tests/extracts zip using optional AES-256 encryption
Synopsis
$zip(file.zip,<c|e|t>[po],file|dir [,password]) $zip(file.zip,c[po],file|dir added [,password]) $zip(file.zip,t[p,password]) $zip(file.zip,e[po],ExtractDir [,password])
Parameters
- file.zip = filename used to create the .zip (or overwrite existing file when using o switch)
- cetpo = see valid switches below
- file|dir = when c switch used, if this is a filename, is the 1 file to be added without including path. Wildcards not accepted. If this is a foldername, the contents of that folder and any subfolders are added to file.zip with relative path beginning with "dirname\"
When e switch used, is the destination FOLDER for extraction of all contents of file.zip.
- password = password used to encrypt each file added to zip. Can contain spaces. Valid only when using the 'p' switch
Switches
- c = create zip
- e = extract from zip
- t = test zip contents
- p = password
- o = overwrite extraction dir & contents (required if extraction dir exists)
Returns 1=success 0=fail
- Warning: Using the 'o' switch when extracting should NOT be used when extracting into $mircdir or any folder having important files in that folder or in any subfolders below it, especially if the zip was not created by you. The 'o' switch is required when extracting into an existing folder, even if empty. However it also results in overwriting extracted contents on top of existing filenames or path\filenames relative to the parent folder of the folder being extracted into.
Properties
None
Example
These examples assume TESTDIR contains filenames test1.txt and test2.txt and a subfolder named Backup beneath TESTDIR contains test3.bak
//echo -a $zip(test,cp,testdir\test1.txt,foo bar)
returns 1=success:
Create zip filename "test" without the .zip extension. If you want the filename as test.zip, you must use test.zip as the zipfilename.
The zip contains the filename as test1.txt without the foldername. File is encrypted using the 7-character passphrase "foo bar".
Error "* Invalid parameters: $zip" if the name "test" exists as a foldername or filename, or if testdir\test1.txt does not exist.
//echo -a $zip(test,cpo,testdir\test1.txt,foo bar)
Same except overwrites filename "test" if it already exists.
//echo -a $zip(test.zip,tp,foo bar)
Tests contents of test.zip zipfile
Error "* Invalid parameters: $zip" if test.zip filename does not exist
Returns 1=success: contents of test.zip either use this password or are not encrypted
Returns 0=fail: At least 1 file in test.zip not able to be decrypted, or test.zip is not a valid zip file.
//echo -a $zip(test3.zip,cp,TESTDIR,foo bar)
adds to test3.zip the contents of TESTDIR and all contents of any of its subfolders. In this example, the .zip contains 5 items:
DIR entry for TESTDIR
filename TESTDIR\test1.txt
filename TESTDIR\test2.txt
DIR entry for TESTDIR\Backup
filename TESTDIR\Backup\test3.bak
Note: If TESTDIR uses a different case than the existing folder, the files are added using the spelling as used in the $zip parameter. Foldernames for any empty subfolders beneath TESTDIR are also added.
//echo -a $zip(test.zip3,ep,F:\ExtractDir,foo bar)
extract contents of test.zip to F:\ExtractDir. If no path were listed, subfolder below $mircdir.
Error "* Invalid parameters: $zip" if ExtractDir foldername already exists, even if empty
If this is the test3.zip created above, it extracts test1.txt and test2.txt into F:\ExtractDir\TESTDIR folder and extracts test3.bak into F:\ExtractDir\TESTDIR\Backup folder.
Note: After extraction, you must use
//echo -a $findfile(F:\ExtractDir\,*,0,echo -a $1-)
to discover which files were extracted from the .zip
Note: If the password is missing/wrong for a file inside the zip, any foldernames in the zip are created. </source>
Compatibility
7.55