OS4X plugin os4xplugin tar decompress

From OS4X
Jump to navigation Jump to search


Purpose

Tests each individual file in the job to see whether it is a TAR compressed file. If successful, the file is decompressed, the target path corresponds to the position of the file (i.e. any directory structures are also stored there). The TAR file itself is removed from the job after successful decompression (logically, not physically).

Requirements

  • File /etc/os4x.conf or configuration file referenced by environment variable $OS4X_CFGFILE. The temporary directory and the license file are obtained via the database that is configured here.

Configuration

  • extractOnlyTar: If this Boolean configuration value is activated, only files with the extension ".tar" will be decompressed. This makes it easier to handle TAR archives that are not intended to be viewed by decompression.

The program "tar" is searched for in the PATH of the shell under which the plugin is started. This means that the tar version used can be influenced by clever positioning or definition of the default PATH.

Return codes

  • 0: everything OK
  • 1: Number of parameters != 1; Config file /etc/os4x.conf not found; Config in database not readable; License not valid; XML file invalid
Retrieved from "https://wiki.os4x.com/index.php?title=OS4X_plugin_os4xplugin_tar_decompress&oldid=3780"