CkoTar Objective-C Reference Documentation

CkoTar

Current Version: 9.5.0.73

API for creating and extracting TAR archives. Also supports creating and extracting .tar.gz (.tgz), .tar.bz2, and .tar.Z (compressed TAR archives, also known as compressed tarball archives). Can read/write the following TAR formats: (1) GNU tar 1.13.x format, (2) PAX -- POSIX 1003.1-2001 format, (3) USTAR -- POSIX 1003.1-1988 format.

Object Creation

CkoTar *obj = [[CkoTar alloc] init];

Properties

CaptureXmlListing
@property (nonatomic) BOOL CaptureXmlListing;
Introduced in version 9.5.0.46

If YES, then untar methods, such as Untar, UntarGz, UntarBz2, and UntarZ, will also capture an XML listing of the contents in the XmlListing property. The format of the XML contained in XmlListing is identical to what is returned by the ListXml method. The default value is NO.

top
Charset
@property (nonatomic, copy) NSString *Charset;

Character encoding to be used when interpreting filenames within .tar archives for untar operations. The default is "utf-8", and this is typically not changed. (The WriteTar methods always uses utf-8 to store filenames within the TAR archive.)

top
DebugLogFilePath
@property (nonatomic, copy) NSString *DebugLogFilePath;

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DirMode
@property (nonatomic, copy) NSNumber *DirMode;

The directory permissions to used in WriteTar* methods. The default is octal 0755. This is the value to be stored in the "mode" field of each TAR header for a directory entries.

top
DirPrefix
@property (nonatomic, copy) NSString *DirPrefix;

A prefix to be added to each file's path within the TAR archive as it is being created. For example, if this property is set to the string "subdir1", then "subdir1/" will be prepended to each file's path within the TAR.

Note: This property does not apply to files added using the AddFile2 method, which directly specifies the path-in-tar.

top
FileMode
@property (nonatomic, copy) NSNumber *FileMode;

The file permissions to used in WriteTar* methods. The default is octal 0644. This is the value to be stored in the "mode" field of each TAR header for a file entries.

top
GroupId
@property (nonatomic, copy) NSNumber *GroupId;

The default numerical GID to be stored in each TAR header when writing TAR archives. The default value is 1000.

top
GroupName
@property (nonatomic, copy) NSString *GroupName;

The default group name to be stored in each TAR header when writing TAR archives. The default value is the logged-on username of the application's process.

top
HeartbeatMs
@property (nonatomic, copy) NSNumber *HeartbeatMs;

This is the number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any TAR operation prior to completion. If HeartbeatMs is 0, no AbortCheck event callbacks will occur.

top
LastErrorHtml
@property (nonatomic, readonly, copy) NSString *LastErrorHtml;

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
@property (nonatomic, readonly, copy) NSString *LastErrorText;

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
@property (nonatomic, readonly, copy) NSString *LastErrorXml;

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = YES and failure = NO.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
MatchCaseSensitive
@property (nonatomic) BOOL MatchCaseSensitive;
Introduced in version 9.5.0.46

Determines whether pattern matching for the MustMatch and MustNotMatch properties is case-sensitive or not. The default value is NO.

top
MustMatch
@property (nonatomic, copy) NSString *MustMatch;
Introduced in version 9.5.0.46

If set, then file paths must match this pattern when creating TAR archives, or when extracting from TAR archives. If a file does not match, it will not be included when creating a TAR, or it will not be extracted when extracting from a TAR. This property also applies to methods that create or extract from compressed TAR archives.

The must-match pattern may include 0 or more asterisk characters, each of which represents 0 or more of any character. For example, the pattern "*.txt" causes only .txt files to be included or extracted. The default value is an empty string, indicating that all files are implicitly matched.

top
MustNotMatch
@property (nonatomic, copy) NSString *MustNotMatch;
Introduced in version 9.5.0.46

If set, then file paths must NOT match this pattern when creating TAR archives, or when extracting from TAR archives. If a file path matches, it will not be included when creating a TAR, or it will not be extracted when extracting from a TAR. This property also applies to methods that create or extract from compressed TAR archives.

The must-not-match pattern may include 0 or more asterisk characters, each of which represents 0 or more of any character. For example, the pattern "*.obj" causes all .obj files to be skipped. The default value is an empty string, indicating that no files are skipped.

top
NoAbsolutePaths
@property (nonatomic) BOOL NoAbsolutePaths;

If YES, then absolute paths are converted to relative paths by removing the leading "/" or "\" character when untarring. This protects your system from unknowingly untarring files into important system directories, such as C:\Windows\system32. The default value is YES.

top
NumDirRoots
@property (nonatomic, readonly, copy) NSNumber *NumDirRoots;

The total number of directory roots set by calling AddDirRoot (i.e. the number of times AddDirRoot was called by the application). A TAR archive is created by calling AddDirRoot for one or more directory tree roots, followed by a single call to WriteTar (or WriteTarBz2, WriteTarGz, WriteTarZ). This allows for TAR archives containing multiple directory trees to be created.

top
PercentDoneScale
@property (nonatomic, copy) NSNumber *PercentDoneScale;
Introduced in version 9.5.0.49

This property is only valid in programming environment and languages that allow for event callbacks.

Sets the value to be defined as 100% complete for the purpose of PercentDone event callbacks. The defaut value of 100 means that at most 100 event PercentDone callbacks will occur in a method that (1) is event enabled and (2) is such that it is possible to measure progress as a percentage completed. This property may be set to larger numbers to get more fine-grained PercentDone callbacks. For example, setting this property equal to 1000 will provide callbacks with .1 percent granularity. For example, a value of 453 would indicate 45.3% competed. This property is clamped to a minimum value of 10, and a maximum value of 100000.

top
ScriptFileMode
@property (nonatomic, copy) NSNumber *ScriptFileMode;

The file permissions to used in WriteTar* methods for shell script files (.sh, .csh, .bash, .bsh). The default is octal 0755. This is the value to be stored in the "mode" field of each TAR header for a file entries.

top
SuppressOutput
@property (nonatomic) BOOL SuppressOutput;
Introduced in version 9.5.0.46

If YES, then untar methods, such as Untar, UntarGz, UntarBz2, and UntarZ, do not produce any output. Setting this value equal to YES is useful when the CaptureXmlListing is also set to YES, which enables an application to get the contents of a TAR archive without extracting. The default value is NO.

top
UntarCaseSensitive
@property (nonatomic) BOOL UntarCaseSensitive;

This property is deprecated. Applications should instead use the MatchCaseSensitive property. Until this property is officially removed, it will behave the same as the MatchCaseSensitive property.

top
UntarDebugLog
@property (nonatomic) BOOL UntarDebugLog;

Similar to the VerboseLogging property. If set to YES, then information about each file/directory extracted in an untar method call is logged to LastErrorText (or LastErrorXml / LastErrorHtml). The default value is NO.

top
UntarDiscardPaths
@property (nonatomic) BOOL UntarDiscardPaths;

If YES, then discard all path information when untarring. This causes all files to be untarred into a single directory. The default value is NO.

top
UntarFromDir
@property (nonatomic, copy) NSString *UntarFromDir;

The directory path where files are extracted when untarring. The default value is ".", meaning that the current working directory of the calling process is used. If UntarDiscardPaths is set, then all files are untarred into this directory. Otherwise, the untar operation will re-create a directory tree rooted in this directory.

top
UntarMatchPattern
@property (nonatomic, copy) NSString *UntarMatchPattern;
This property is deprecated. It will be removed in a future version.

This property is deprecated. The MustMatch property should be used instead. Until this property is officially removed from the API, it is identical in behavior the MustMatch property.

top
UntarMaxCount
@property (nonatomic, copy) NSNumber *UntarMaxCount;

Limits the number of files extracted during an untar to this count. The default value is 0 to indicate no maximum. To untar a single file, one might set the UntarMatchPattern such that it will match only the file to be extracted, and also set UntarMaxCount equal to 1. This causes an untar to scan the TAR archive until it finds the matching file, extract it, and then return.

top
UserId
@property (nonatomic, copy) NSNumber *UserId;

The default numerical UID to be stored in each TAR header when writing TAR archives. The default value is 1000.

top
UserName
@property (nonatomic, copy) NSString *UserName;

The default user name to be stored in each TAR header when writing TAR archives. The default value is the logged-on username of the application's process.

top
VerboseLogging
@property (nonatomic) BOOL VerboseLogging;

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

top
Version
@property (nonatomic, readonly, copy) NSString *Version;

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

top
WriteFormat
@property (nonatomic, copy) NSString *WriteFormat;

The TAR format to use when writing a TAR archive. Valid values are "gnu", "pax", and "ustar". The default value is "gnu".

top
XmlListing
@property (nonatomic, copy) NSString *XmlListing;
Introduced in version 9.5.0.46

Contains the XML listing of the contents of the TAR archive for the last untar method call (such as Untar, UntarGz, etc.) where the CaptureXmlListing property was set to YES.

top

Methods

AddDirRoot
- (BOOL)AddDirRoot:(NSString *)dirPath;

Adds a directory tree to be included in the next call to one of the WriteTar* methods. To include multiple directory trees in a .tar, call AddDirRoot multiple times followed by a single call to WriteTar.

Returns YES for success, NO for failure.

top
AddDirRoot2
- (BOOL)AddDirRoot2:(NSString *)rootPrefix
    rootPath:(NSString *)rootPath;
Introduced in version 9.5.0.56

Adds a directory tree to be included in the next call to one of the WriteTar* methods. To include multiple directory trees in a .tar, call AddDirRoot2 (and/or AddDirRoot) multiple times followed by a single call to WriteTar.

The rootPrefix adds a prefix to the path in the TAR for all files added under this root. The rootPrefix should not end with a forward-slash char. For example: This is good: "abc/123", but this is not good: "abc/123/". If the DirPrefix property is also set, its prefix will added first.

Returns YES for success, NO for failure.

top
AddFile
- (BOOL)AddFile:(NSString *)path;
Introduced in version 9.5.0.46

Adds a local file to be included in the next call to one of the WriteTar* methods. To include multiple files or directory trees in a .tar, call AddFile/AddDirRoot multiple times followed by a single call to WriteTar (or WriteTarGz, or WriteTarBz2).

Returns YES for success, NO for failure.

top
AddFile2
- (BOOL)AddFile2:(NSString *)filePath
    pathWithinTar:(NSString *)pathWithinTar;
Introduced in version 9.5.0.69

Adds a local file to be included in the next call to one of the WriteTar* methods. Allows for the path within the TAR to be specified. To include multiple files or directory trees in a .tar, call AddFile/AddFile2/AddDirRoot multiple times followed by a single call to WriteTar (or WriteTarGz, or WriteTarBz2).

Note: The DirPrefix property does not apply to files added via this method because this method explicilty specifies the path-in-tar.

Returns YES for success, NO for failure.

top
CreateDeb
- (BOOL)CreateDeb:(NSString *)controlPath
    dataPath:(NSString *)dataPath
    debPath:(NSString *)debPath;
Introduced in version 9.5.0.66

Creates a .deb Debian binary package archive from a control.tar.gz and data.tar.gz. The controlPath is the path to the control.tar.gz file (or equivalent), and the dataPath is the path to the data.tar.gz file. The output file path (.deb) is specified in debPath.

Returns YES for success, NO for failure.

top
GetDirRoot
- (NSString *)GetDirRoot:(NSNumber *)index;

Returns the value of the Nth directory root. For example, if an application calls AddDirRoot twice, then the NumDirRoots property would have a value of 2, and GetDirRoot(0) would return the path passed to AddDirRoot in the 1st call, and GetDirRoot(1) would return the directory path in the 2nd call to AddDirRoot.

Returns nil on failure

top
ListXml
- (NSString *)ListXml:(NSString *)tarPath;

Scans a TAR archive and returns XML detailing the files and directories found within the TAR.

Returns nil on failure

top
ListXmlAsync (1)
- (CkoTask *)ListXmlAsync:(NSString *)tarPath;

Creates an asynchronous task to call the ListXml method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
SaveLastError
- (BOOL)SaveLastError:(NSString *)path;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns YES for success, NO for failure.

top
UnlockComponent
- (BOOL)UnlockComponent:(NSString *)unlockCode;

Unlocks the component allowing for the full functionality to be used. If this method unexpectedly returns NO, examine the contents of the LastErrorText property to determine the reason for failure.

top
Untar
- (NSNumber *)Untar:(NSString *)tarPath;

Extracts the files and directories from a TAR archive, reconstructing the directory tree(s) in the local filesystem. The files are extracted to the directory specified by the UntarFromDir property. Returns the number of files and directories extracted, or -1 for failure.

More Information and Examples
top
UntarAsync (1)
- (CkoTask *)UntarAsync:(NSString *)tarPath;

Creates an asynchronous task to call the Untar method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
UntarBz2
- (BOOL)UntarBz2:(NSString *)tarPath;

Extracts the files and directories from a tar.bz2 (or tar.bzip2) archive, reconstructing the directory tree(s) in the local filesystem. The files are extracted to the directory specified by the UntarFromDir property.

Returns YES for success, NO for failure.

More Information and Examples
top
UntarBz2Async (1)
- (CkoTask *)UntarBz2Async:(NSString *)tarPath;

Creates an asynchronous task to call the UntarBz2 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
UntarFirstMatchingToMemory
- (NSData *)UntarFirstMatchingToMemory:(NSData *)tarFileBytes
    matchPattern:(NSString *)matchPattern;

Memory-to-memory untar. The first file matching a pattern in the MustMatch property is extracted and returned.

Returns nil on failure

top
UntarFromMemory
- (NSNumber *)UntarFromMemory:(NSData *)tarFileBytes;

Extracts the files and directories from an in-memory TAR archive, reconstructing the directory tree(s) in the local filesystem. The files are extracted to the directory specified by the UntarFromDir property. Returns the number of files and directories extracted, or -1 for failure.

top
UntarFromMemoryAsync (1)
- (CkoTask *)UntarFromMemoryAsync:(NSData *)tarFileBytes;

Creates an asynchronous task to call the UntarFromMemory method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
UntarGz
- (BOOL)UntarGz:(NSString *)tarPath;

Extracts the files and directories from a tar.gz (or tar.gzip) archive, reconstructing the directory tree(s) in the local filesystem. The files are extracted to the directory specified by the UntarFromDir property.

Returns YES for success, NO for failure.

More Information and Examples
top
UntarGzAsync (1)
- (CkoTask *)UntarGzAsync:(NSString *)tarPath;

Creates an asynchronous task to call the UntarGz method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
UntarZ
- (BOOL)UntarZ:(NSString *)tarPath;

Extracts the files and directories from a tar.Z archive, reconstructing the directory tree(s) in the local filesystem. The files are extracted to the directory specified by the UntarFromDir property.

Returns YES for success, NO for failure.

More Information and Examples
top
UntarZAsync (1)
- (CkoTask *)UntarZAsync:(NSString *)tarPath;

Creates an asynchronous task to call the UntarZ method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
VerifyTar
- (BOOL)VerifyTar:(NSString *)tarPath;

Verifies that a TAR archive is valid. This method opens the TAR archive and scans the entire file by walking the TAR headers. Returns YES if no errors were found. Otherwise returns NO.

top
VerifyTarAsync (1)
- (CkoTask *)VerifyTarAsync:(NSString *)tarPath;

Creates an asynchronous task to call the VerifyTar method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
WriteTar
- (BOOL)WriteTar:(NSString *)tarPath;

Writes a TAR archive. The directory trees previously added by calling AddDirRoot one or more times are included in the output TAR archive.

Returns YES for success, NO for failure.

More Information and Examples
top
WriteTarAsync (1)
- (CkoTask *)WriteTarAsync:(NSString *)tarPath;

Creates an asynchronous task to call the WriteTar method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
WriteTarBz2
- (BOOL)WriteTarBz2:(NSString *)bz2Path;

Writes a .tar.bz2 compressed TAR archive. The directory trees previously added by calling AddDirRoot one or more times are included in the output file.

Returns YES for success, NO for failure.

top
WriteTarBz2Async (1)
- (CkoTask *)WriteTarBz2Async:(NSString *)bz2Path;

Creates an asynchronous task to call the WriteTarBz2 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
WriteTarGz
- (BOOL)WriteTarGz:(NSString *)gzPath;

Writes a .tar.gz (also known as .tgz) compressed TAR archive. The directory trees previously added by calling AddDirRoot one or more times are included in the output file.

Returns YES for success, NO for failure.

More Information and Examples
top
WriteTarGzAsync (1)
- (CkoTask *)WriteTarGzAsync:(NSString *)gzPath;

Creates an asynchronous task to call the WriteTarGz method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top

Events

To implement an event callback, your application would define and implement a class that inherits from CkoTarProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkoTarProgress base class.

For example:

  CkoTar *tar = [[CkoTar alloc] init];

  MyTarProgress *callbackObj = [[MyTarProgress alloc] init];

  [tar setEventCallbackObject:callbackObj];

MyTarProgress interface example:

#import "CkoTarProgress.h"

@interface MyTarProgress : CkoTarProgress {

}

    - (id)init;
    - (void)dealloc;
    - (void)dispose;

    - (void)AbortCheck:(BOOL *)abort;

    - (void)BinaryData:(NSData *)data 
        length:(NSNumber *)length;

    - (void)NextTarFile:(NSString *)path 
        fileSize:(NSNumber *)fileSize 
        isDirectory:(BOOL)isDirectory 
        skip:(BOOL *)skip;

    - (void)PercentDone:(NSNumber *)pctDone 
        abort:(BOOL *)abort;

    - (void)ProgressInfo:(NSString *)name 
        value:(NSString *)value;

    - (void)TaskCompleted:(CkoTask *)task;

    - (void)TextData:(NSString *)data;

@end
AbortCheck
- (void)AbortCheck:(BOOL *)abort;

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

top
NextTarFile
- (void)NextTarFile:(NSString *)path
    fileSize:(NSNumber *)fileSize
    isDirectory:(BOOL)isDirectory
    skip:(BOOL *)skip;

Called for methods that create a TAR archive. This event is called just before a file is to be added to the TAR. The skip argument may be set to YES to prevent the file from being added.

top
PercentDone
- (void)PercentDone:(NSNumber *)pctDone
    abort:(BOOL *)abort;

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to YES will cause the method to abort and return a failed status (or whatever return value indicates failure).

top
ProgressInfo
- (void)ProgressInfo:(NSString *)name
    value:(NSString *)value;

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

top
TaskCompleted
- (void)TaskCompleted:(CkoTask *)task;

Called in the background thread when an asynchronous task completes.

top