Merge pull request fossology#3198 from Siemens-Healthineers/feat/ununpack/lzip

feat(ununpack): add support for lzip archive format

Reviewed-by: kaushlendra-pratap.singh@siemens.com
Tested-by: kaushlendra-pratap.singh@siemens.com

Author: shaheemazmalmmd

cmake/FoPackaging.cmake

@@ -212,7 +212,7 @@ resources.")
 set(CPACK_DEBIAN_FOSSOLOGY-UNUNPACK_PACKAGE_DEPENDS
     "fossology-common, binutils, bzip2, cabextract, cpio, sleuthkit,
     genisoimage, poppler-utils, rpm, unrar-free, unzip, p7zip-full, p7zip,
-    zstd")
+    zstd, lzip")
 
 set(CPACK_DEBIAN_FOSSOLOGY-UNUNPACK_PACKAGE_SECTION "utils")
 else()

src/ununpack/agent/CMakeLists.txt

@@ -35,6 +35,7 @@ foreach(FO_UNP_LIB ununpack ununpack_cov ununpack-sa)
         ${FO_CWD}/ununpack-ar.c
         ${FO_CWD}/ununpack-disk.c
         ${FO_CWD}/ununpack-zstd.c
+        ${FO_CWD}/ununpack-lzip.c
         ${FO_CWD}/utils.c
         ${FO_CWD}/checksum.c)
     if(${FO_UNP_LIB} STREQUAL "ununpack-sa")

src/ununpack/agent/traverse.c

@@ -189,6 +189,10 @@ void	TraverseChild	(int Index, ContainerInfo *CI, char *NewDir)
       /* unpack a ZSTD: source file, source name and destination directory */
       rc = ExtractZstd(CI->Source, CI->Partname, Queue[Index].ChildRecurse);
       break;
+    case CMD_LZIP:
+      /* unpack an LZIP: source file and destination directory */
+      rc = ExtractLzip(CI->Source, CI->Partname, Queue[Index].ChildRecurse);
+      break;
     case CMD_DEFAULT:
     default:
       /* use the original name */
@@ -464,6 +468,7 @@ int	Traverse	(char *Filename, char *Basename,
       case CMD_PARTITION:
       case CMD_PACK:
       case CMD_ZSTD:
+      case CMD_LZIP:
         CI.HasChild=1;
         IsContainer=1;
         strcat(Queue[Index].ChildRecurse,".dir");

src/ununpack/agent/ununpack-lzip.c

@@ -0,0 +1,112 @@
+/*
+ SPDX-FileCopyrightText: © 2025 Siemens Healthineers AG
+ SPDX-FileContributor: Sushant Kumar <sushant.kumar@siemens-healthineers.com>
+
+ SPDX-License-Identifier: GPL-2.0-only
+*/
+
+#include "ununpack.h"
+#include "externs.h"
+
+/**
+ * \file ununpack-lzip.c
+ * \brief The universal unpacker - Code to unpack an lzip compressed file.
+ **/
+
+/**
+ * \brief Given an lzip file, extract the contents to the directory.
+ * \param Source  Pathname of source file
+ * \param OrigName Original name of file
+ * \param Destination Unpack destination
+ * \return 0 on success, non-zero on failure.
+ **/
+int ExtractLzip(char *Source, const char *OrigName, char *Destination)
+{
+  char Cmd[FILENAME_MAX * 4]; /* command to run */
+  int rc;
+  char TempSource[FILENAME_MAX];
+  char CWD[FILENAME_MAX];
+  char OutputName[FILENAME_MAX] = {'\0'};
+  int i;
+
+  /* judge if the parameters are empty */
+  if ((NULL == Source) || (!strcmp(Source, "")) || (NULL == Destination) ||
+      (!strcmp(Destination, ""))) {
+    return 1;
+  }
+
+  if (getcwd(CWD, sizeof(CWD)) == NULL) {
+    fprintf(stderr, "ERROR: directory name longer than %d characters\n",
+        (int) sizeof(CWD));
+    return (-1);
+  }
+
+  i = 0;
+  while (OrigName[i] != '\0') {
+    if (OrigName[i] == '.') {
+      const char *ext = &OrigName[i + 1];
+      if (strncasecmp(ext, "lz", 2) == 0) {
+        break;
+      }
+      else if (strncasecmp(ext, "tlz", 3) == 0) {
+        /* Usually tlz implies tar.lz, stripping extension leaves base name.
+           Subsequent file type detection will handle the resulting tar. */
+        break;
+      }
+    }
+    OutputName[i] = OrigName[i];
+    i++;
+  }
+  /* Null terminate the output name explicitly */
+  OutputName[i] = '\0';
+
+  if (Verbose > 1) {
+    printf("CWD: %s\n", CWD);
+    if (!Quiet) { fprintf(stderr, "Extracting lzip: %s\n", Source); }
+  }
+
+  if (chdir(Destination) != 0) {
+    fprintf(stderr, "ERROR %s.%d: Unable to change directory to %s\n",
+        __FILE__, __LINE__, Destination);
+    fprintf(stderr, "ERROR: errno is: %s\n", strerror(errno));
+  }
+
+  if (TaintString(TempSource, FILENAME_MAX, Source, 1, NULL)) {
+    return (-1);
+  }
+  memset(Cmd, '\0', sizeof(Cmd));
+
+  if (Verbose > 1) {
+    printf("Extracting lzip with output name: %s\n", OutputName);
+  }
+
+  /* lzip options:
+   * -d, --decompress
+   * -k, --keep (keep input file, consistent with how standard tools behave)
+   * -f, --force (overwrite output if exists)
+   * -o, --output (specify output filename)
+   */
+  if (TempSource[0] != '/') {
+    snprintf(Cmd, sizeof(Cmd),
+        " (lzip --decompress --keep --force -o '%s/%s' "
+        "'%s/%s') 2>/dev/null", Destination, OutputName,
+        CWD, TempSource);
+  }
+  else {
+    snprintf(Cmd, sizeof(Cmd),
+        " (lzip --decompress --keep --force -o '%s/%s' "
+        "'%s') 2>/dev/null", Destination, OutputName,
+        TempSource);
+  }
+  
+  rc = WEXITSTATUS(system(Cmd));
+  if (rc) {
+    fprintf(stderr, "ERROR: Command failed (rc=%d): %s\n", rc, Cmd);
+  }
+
+  if (chdir(CWD) != 0) {
+    fprintf(stderr, "ERROR %s.%d: Unable to change directory to %s\n", __FILE__, __LINE__, CWD);
+    fprintf(stderr, "ERROR: errno is: %s\n", strerror(errno));
+  }
+  return (rc);
+} /* ExtractLzip() */

src/ununpack/agent/ununpack-lzip.h

@@ -0,0 +1,13 @@
+/*
+ SPDX-FileCopyrightText: © 2025 Siemens Healthineers AG
+ SPDX-FileContributor: Sushant Kumar <sushant.kumar@siemens-healthineers.com>
+
+ SPDX-License-Identifier: GPL-2.0-only
+*/
+
+#ifndef UNUNPACK_LZIP_H
+#define UNUNPACK_LZIP_H
+
+int ExtractLzip(char *Source, const char *OrigName, char *Destination);
+
+#endif

src/ununpack/agent/ununpack.h

@@ -34,6 +34,7 @@
 #include "checksum.h"
 #include "ununpack-ar.h"
 #include "ununpack-disk.h"
+#include "ununpack-lzip.h"
 #include "ununpack-iso.h"
 #include "ununpack-zstd.h"
 
@@ -63,6 +64,7 @@ enum cmdtype
   CMD_DISK,	        /** File system disk */
   CMD_DEB,	        /** Debian source package */
   CMD_ZSTD,         /** Zstandard compressed file */
+  CMD_LZIP,         /** Lzip compressed file */
   CMD_DEFAULT	      /** Default action */
 };
 

src/ununpack/agent/ununpack_globals.h

@@ -100,7 +100,8 @@ cmdlist CMD[] =
 /* 34 */{ "application/zstd", "zstd", "-d", ">/dev/null 2>&1", "zstd -lv '%s' > '%s'", CMD_ZSTD, 1, 0177000, 0177000, },
 /* 35 */{ "application/x-lz4", "zstd", "-d", ">/dev/null 2>&1", "", CMD_ZSTD, 1, 0177000, 0177000, },
 /* 36 */{ "application/x-lzma", "zstd", "-d", ">/dev/null 2>&1", "", CMD_ZSTD, 1, 0177000, 0177000, },
-/* 37 */{ "","","",">/dev/null 2>&1","",CMD_DEFAULT,1,0177000,0177000, },
+/* 37 */{ "application/x-lzip", "lzip", "-d", ">/dev/null 2>&1", "lzip -lv '%s' > '%s'", CMD_LZIP, 1, 0177000, 0177000, },
+/* 38 */{ "","","",">/dev/null 2>&1","",CMD_DEFAULT,1,0177000,0177000, },
   { NULL,NULL,NULL,NULL,NULL,-1,-1,0177000,0177000, },
 };
 #endif

src/ununpack/agent/utils.c

@@ -583,6 +583,7 @@ void	CheckCommands	(int Show)
       case CMD_AR:
       case CMD_PARTITION:
       case CMD_ZSTD:
+      case CMD_LZIP:
         CMD[i].Status = IsExe(CMD[i].Cmd,Quiet);
         break;
       default:

src/ununpack/agent_tests/Unit/run_tests.c

@@ -24,6 +24,7 @@ char *DBConfFile = NULL;          ///< DB conf file location
 /* **** test suite ********************************************************** */
 /* ************************************************************************** */
 extern CU_TestInfo ExtractAR_testcases[];       ///< AR test cases
+extern CU_TestInfo ExtractLzip_testcases[];     ///< Lzip test cases
 extern CU_TestInfo ExtractZstd_testcases[];      ///< Zstd test cases
 extern CU_TestInfo ununpack_iso_testcases[];    ///< ISO test cases
 extern CU_TestInfo ununpack_disk_testcases[];   ///< Disk image test cases
@@ -47,6 +48,9 @@ CU_SuiteInfo suites[] =
   // ununpack-ar.c
   {"ExtractAR", NULL, NULL, NULL, NULL, ExtractAR_testcases},
 
+  // ununpack-lzip.c
+  {"ExtractLzip", NULL, NULL, NULL, NULL, ExtractLzip_testcases},
+
   // ununpack-zstd.c
   {"ExtractZstd", NULL, NULL, NULL, NULL, ExtractZstd_testcases},
 

src/ununpack/agent_tests/Unit/test_ununpack-lzip.c

@@ -0,0 +1,128 @@
+/*
+ SPDX-FileCopyrightText: © 2025 Siemens Healthineers AG
+ SPDX-FileContributor: Sushant Kumar <sushant.kumar@siemens-healthineers.com>
+
+ SPDX-License-Identifier: GPL-2.0-only
+*/
+
+#include "run_tests.h"
+
+/**
+ * \file
+ * \brief Unit test cases for ExtractLzip()
+ */
+
+/* locals */
+static int Result = 0;
+
+/**
+ * @brief unpack lzip file
+ * \test
+ * -# Try to extract `.lz` file using ExtractLzip()
+ * -# Check if the files are unpacked
+ */
+void testExtractLzipFile()
+{
+  deleteTmpFiles("./test-result/");
+  exists = file_dir_exists("./test-result/");
+  FO_ASSERT_EQUAL(exists, 0); // not existing
+
+  MkDirs("./test-result/test.lz.dir/");
+  Filename = "../testdata/test.lz";
+  /* Ensure test.lz contains a file named 'data.tar' for this assertion */
+  Result = ExtractLzip(Filename, "test.lz", "./test-result/test.lz.dir");
+  
+  exists = file_dir_exists("./test-result/test.lz.dir/test");
+  FO_ASSERT_EQUAL(exists, 1); // existing
+  FO_ASSERT_EQUAL(Result, 0); // Extract lzip successfully
+}
+
+/**
+ * @brief unpack tlz (tar.lz) file
+ * \test
+ * -# Try to extract `.tlz` archives using ExtractLzip()
+ * -# Check if the files are unpacked
+ */
+void testExtractTlzFile()
+{
+  deleteTmpFiles("./test-result/");
+  exists = file_dir_exists("./test-result/");
+  FO_ASSERT_EQUAL(exists, 0);
+
+  MkDirs("./test-result/test.tlz.dir/");
+  Filename = "../testdata/test.tlz";
+  Result = ExtractLzip(Filename, "test.tlz", "./test-result/test.tlz.dir");
+  
+  exists = file_dir_exists("./test-result/test.tlz.dir/test.tar");
+  FO_ASSERT_EQUAL(exists, 1);
+  FO_ASSERT_EQUAL(Result, 0);
+}
+
+/**
+ * @brief unpack tar.lz file
+ * \test
+ * -# Try to extract `.tar.lz` archives using ExtractLzip()
+ * -# Check if the files are unpacked
+ */
+void testExtractTarLzFile()
+{
+  deleteTmpFiles("./test-result/");
+  exists = file_dir_exists("./test-result/");
+  FO_ASSERT_EQUAL(exists, 0); 
+
+  MkDirs("./test-result/test.tar.lz.dir/");
+  Filename = "../testdata/test.tar.lz";
+  Result = ExtractLzip(Filename, "test.tar.lz", "./test-result/test.tar.lz.dir");
+
+  exists = file_dir_exists("./test-result/test.tar.lz.dir/test.tar");
+  FO_ASSERT_EQUAL(exists, 1); 
+  FO_ASSERT_EQUAL(Result, 0); 
+}
+
+/**
+ * @brief abnormal parameters
+ * \test
+ * -# Call ExtractLzip() with empty parameters
+ * -# Check if the function return NOT OK
+ */
+void testExtractLzipEmptyParameters()
+{
+  deleteTmpFiles("./test-result/");
+  exists = file_dir_exists("./test-result/");
+  FO_ASSERT_EQUAL(exists, 0);
+
+  Result = ExtractLzip("", "", "");
+  FO_ASSERT_EQUAL(Result, 1);
+}
+
+/**
+ * @brief abnormal parameters
+ * \test
+ * -# Try to extract non-existent archives using ExtractLzip()
+ * -# Check if the function return NOT OK
+ */
+void testExtractLzipErrorParameters()
+{
+  deleteTmpFiles("./test-result/");
+  exists = file_dir_exists("./test-result/");
+  FO_ASSERT_EQUAL(exists, 0);
+
+  MkDirs("./test-result/no_file.dir/");
+  Filename = "../testdata/non_existent_file.lz";
+  Result = ExtractLzip(Filename, "non_existent_file.lz", "./test-result/no_file.dir");
+  FO_ASSERT_EQUAL(Result, 1);
+}
+
+/* ************************************************************************** */
+/* **** cunit test cases **************************************************** */
+/* ************************************************************************** */
+
+CU_TestInfo ExtractLzip_testcases[] =
+{
+  {"Testing function ExtractLzip for .lz file:", testExtractLzipFile},
+  {"Testing function ExtractLzip for .tlz file:", testExtractTlzFile},
+  {"Testing function ExtractLzip for .tar.lz file:", testExtractTarLzFile},
+  {"Testing function ExtractLzip for empty parameters:", testExtractLzipEmptyParameters},
+  {"Testing function ExtractLzip for error parameters:", testExtractLzipErrorParameters},
+  CU_TEST_INFO_NULL
+};