chilkat.Tar

Controls whether extraction methods also capture an XML inventory of the archive. When set to true, methods such as Untar, UntarGz, UntarBz2, and UntarZ store the listing in XmlListing. The XML has the same structure as the string returned by ListXml. The default is false.

Specifies the character encoding used to decode filenames stored in a TAR archive during extraction. The default is utf-8, which is normally appropriate for modern archives.

This property affects archive entry names only. It does not convert or otherwise alter the contents of extracted files. TAR archives written by the WriteTar* methods store filenames as UTF-8.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

Specifies the UNIX permission bits written to the TAR header for directory entries created by the WriteTar* methods. The default is octal 0755, which represents rwxr-xr-x.

Specifies a path prefix to prepend to entries when a TAR archive is created. For example, setting this property to subdir1 causes an entry such as report.txt to be stored as subdir1/report.txt.

The prefix changes only the path stored in the archive; it does not rename or move the source file on disk.

Specifies the UNIX permission bits written to the TAR header for ordinary file entries created by the WriteTar* methods. The default is octal 0644, which represents rw-r--r--.

Specifies the numeric group identifier (GID) written to TAR headers when an archive is created. The default value is 1000.

Specifies the group name written to TAR headers when an archive is created. By default, Chilkat uses the username of the account running the application.

Specifies the approximate interval, in milliseconds, between AbortCheck event callbacks during supported long-running operations. The default is 0, which disables periodic AbortCheck callbacks.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

Controls whether the patterns in MustMatch and MustNotMatch are matched case-sensitively. The default is false.

Specifies an inclusion pattern applied when creating or extracting TAR archives, including compressed TAR formats. A candidate path is included or extracted only when it matches this pattern. The default is an empty string, which permits all paths.

The pattern may contain zero or more asterisks (*), where each asterisk matches zero or more characters. For example, *.txt selects paths ending in .txt. Case handling is controlled by MatchCaseSensitive.

Specifies an exclusion pattern applied when creating or extracting TAR archives, including compressed TAR formats. A candidate path that matches this pattern is skipped. The default is an empty string, which excludes nothing.

The pattern may contain zero or more asterisks (*), where each asterisk matches zero or more characters. For example, *.obj skips paths ending in .obj. Case handling is controlled by MatchCaseSensitive.

Controls whether absolute archive paths are converted to relative paths during extraction. When true, a leading / or \ is removed before the entry is written. The default is true.

Returns the number of directory roots currently registered for archive creation by calls to AddDirRoot and AddDirRoot2. Individual files added with AddFile or AddFile2 are not included in this count.

Use zero-based indexes from 0 through NumDirRoots - 1 with GetDirRoot.

Specifies the value reported by PercentDone when an eligible operation is 100% complete. The default is 100. Increasing the scale allows finer-grained integer progress values; for example, a scale of 1000 allows 453 to represent 45.3%.

The value is clamped to the range 10 through 100000. This property is available only in environments that support event callbacks, and only methods for which measurable progress is available emit percentage updates.

Specifies the UNIX permission bits written to TAR headers for shell-script files recognized by extensions such as .sh, .csh, .bash, and .bsh. The default is octal 0755, which records executable permissions.

Controls whether untar operations write extracted files and directories to the filesystem. When true, methods such as Untar, UntarGz, UntarBz2, and UntarZ scan the archive without producing extracted output. The default is false.

Deprecated. Use MatchCaseSensitive instead.

Until this property is removed, reading or setting it has the same effect as reading or setting MatchCaseSensitive.

Controls whether untar methods add per-entry extraction details to LastErrorText, LastErrorXml, and LastErrorHtml. The default is false.

Controls whether directory components from archive entry names are discarded during extraction. When true, each file is written directly into UntarFromDir rather than recreating the archived directory tree. The default is false.

Specifies the destination directory for extraction. The default is ., meaning the current working directory of the calling process.

When UntarDiscardPaths is false, archived subdirectories are recreated beneath this directory. When it is true, extracted files are placed directly in this directory.

Limits the number of matching entries extracted by an untar operation. The default is 0, which means no maximum.

For example, set MustMatch to select a particular path and set UntarMaxCount to 1 to stop after the first matching entry is extracted.

Specifies the numeric user identifier (UID) written to TAR headers when an archive is created. The default value is 1000.

Specifies the user name written to TAR headers when an archive is created. By default, Chilkat uses the username of the account running the application.

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version of the component/library, such as "10.1.0"

Specifies the TAR header format used by the WriteTar* methods. The default is gnu. Supported values are:

Contains the XML listing captured by the most recent untar operation for which CaptureXmlListing was true. The XML structure is the same as the output from ListXml.

Adds the directory tree at dir_path to the set of sources used by the next WriteTar* operation. Call this method multiple times to include multiple directory trees in one archive.

Use AddDirRoot2 when the tree should appear beneath an explicit prefix inside the archive.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Adds the directory tree at root_path to the archive-creation source list and stores its entries beneath the archive prefix supplied in root_prefix. Call this method multiple times, or combine it with AddDirRoot, before calling a WriteTar* method.

root_prefix should be a relative archive path such as abc/123 and should not end with /. If DirPrefix is also set, DirPrefix is applied first.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Adds the local file at path to the set of sources used by the next WriteTar* operation. Call AddFile, AddFile2, and the directory-root methods as needed before writing a single archive.

Use AddFile2 when the path stored inside the TAR must be specified independently of the source file path.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Adds the local file at file_path to the archive-creation source list and stores it using the exact archive path supplied in path_within_tar. This allows the source path and the path visible inside the TAR to differ.

Call this method as many times as needed, optionally together with the other file and directory-root methods, before calling a single WriteTar* method.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Removes all files and directory roots previously registered by AddDirRoot, AddDirRoot2, AddFile, and AddFile2.

Call this method before building a different archive with the same Tar object when the earlier source list should not be reused.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Creates a Debian binary package at deb_path from the prepared control archive at control_path and data archive at data_path. The inputs are typically named control.tar.gz and data.tar.gz, or use another compression form accepted by the target Debian tooling.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Returns a directory root previously added with AddDirRoot or AddDirRoot2. index is a zero-based index.

Valid indexes range from 0 through NumDirRoots - 1. For example, after two roots are added, GetDirRoot(0) returns the first and GetDirRoot(1) returns the second.

Returns the string, or nil, err on failure (or when nothing is found). The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Scans the uncompressed TAR archive at tar_path and returns an XML description of its files, directories, and archive metadata. The archive is not extracted.

Returns the string, or nil, err on failure (or when nothing is found). The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Extracts the uncompressed TAR archive at tar_path into the directory specified by UntarFromDir. Archived directory trees are recreated unless UntarDiscardPaths is true.

Returns the number of files and directories extracted, or -1 if the operation fails. Extraction is also affected by the matching, path-safety, count-limit, listing, and output-suppression properties of this object.

Decompresses and extracts the .tar.bz2 archive at tar_path into UntarFromDir. This format is also commonly named .tbz, .tbz2, or .tb2.

Returns true on success and false on failure. The same extraction filters, path controls, listing options, and output settings used by Untar also apply.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Scans the uncompressed TAR archive at tar_path and copies the contents of the first file whose archive path matches match_pattern into the BinData object supplied in bd. Matching is evaluated in archive order.

No archive entry is written to the local filesystem. Returns true when a matching file is successfully extracted to bd and false otherwise.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Decompresses and extracts the .tar.gz archive at tar_path into UntarFromDir. The .tgz extension is a common short form for the same gzip-compressed TAR structure.

Returns true on success and false on failure. The same extraction filters, path controls, listing options, and output settings used by Untar also apply.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Decompresses and extracts the .tar.Z archive at tar_path into UntarFromDir. The .Z suffix denotes the historical UNIX compress format; .taz is a common alternate extension.

Returns true on success and false on failure. The same extraction filters, path controls, listing options, and output settings used by Untar also apply.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Opens the uncompressed TAR archive at tar_path and scans its headers through the end of the archive. Returns true when the archive structure is accepted and no TAR-format errors are found; otherwise returns false.

Returns true or false: an answer, not a success flag.

Creates an uncompressed TAR archive at tar_path from the files and directory trees previously added with AddFile, AddFile2, AddDirRoot, and AddDirRoot2. Archive paths, permissions, ownership metadata, filters, and header format are controlled by the corresponding properties.

Returns true on success and false on failure.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Creates a bzip2-compressed TAR archive at bz2_path from the files and directory trees previously added to this object. Common filename extensions include .tar.bz2, .tbz, .tbz2, and .tb2.

Returns true on success and false on failure.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Creates a gzip-compressed TAR archive at gz_path from the files and directory trees previously added to this object. The usual extensions are .tar.gz and .tgz.

Returns true on success and false on failure.

Returns true on success, nil, err on failure. The second return value, err, is the object's last_error_text; wrap the call in assert() to raise an error instead.

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

Example

local deadline = os.time() + 30                  -- give up after 30 seconds
tar.heartbeat_ms = 250                      -- call the handler 4 times per second
tar:set_event_handler({ abort_check = function() return os.time() > deadline end })

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.

Example

tar:set_event_handler({
    percent_done = function(pct_done)     -- 0 to 100
        print("Percent done: " .. pct_done)
        return false                       -- return true to abort the method in progress
    end,
})

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

Example

tar:set_event_handler({
    progress_info = function(name, value) print(name .. ": " .. value) end,
})