Skip to content

Remove LZMA (XZ) support #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@
path = external/bzip2
url = https://sourceware.org/git/bzip2.git
branch = master
[submodule "external/xz"]
path = external/xz
url = https://github.com/tukaani-project/xz
[submodule "zlib"]
path = external/zlib
url = https://github.com/madler/zlib.git
Expand Down
68 changes: 3 additions & 65 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.18)
#
# TODO:
#
# * Windows: use vcpkg to build bzip2 and lzma (vcpkg can be used as a cmake subproject)
# * Windows: use vcpkg to build bzip2 (vcpkg can be used as a cmake subproject)
# * Include portions of Mono.Posix native code (if necessary and when the new Mono.Posix is ready)
# * Add support Android builds
# * Add support for iOS/tvOS/macCatalyst builds
Expand All @@ -12,7 +12,6 @@ cmake_minimum_required(VERSION 3.18)

option(BUILD_DEPENDENCIES "Build only libzip dependencies" OFF)
option(BUILD_LIBZIP "Build libzip and libZipSharp" OFF)
option(ENABLE_XZ "Enable XZ (LZMA compression) in the build" OFF)
option(ENABLE_ZLIBNG "Use zlib-ng instead of zlib" OFF)

set(CMAKE_POSITION_INDEPENDENT_CODE True CACHE BOOL "Always build position independent code" FORCE)
Expand All @@ -22,7 +21,7 @@ set(CMAKE_POSITION_INDEPENDENT_CODE True CACHE BOOL "Always build position indep
#

#
# libzip, zlib-ng, xz
# libzip, zlib-ng
#
set(BUILD_SHARED_LIBS OFF CACHE BOOL "Build only as a static library" FORCE)

Expand All @@ -48,10 +47,6 @@ set(ENABLE_MBEDTLS OFF CACHE BOOL "Do not use mbedtls for libzip" FORCE)
set(ENABLE_WINDOWS_CRYPTO OFF CACHE BOOL "Do not use Windows Crypto" FORCE)
set(ENABLE_ZSTD ON CACHE BOOL "Use zstd in libzip" FORCE)

if(NOT ENABLE_XZ)
set(ENABLE_LZMA OFF CACHE BOOL "Do not use XZ for libzip" FORCE)
endif()

#
# zstd
#
Expand Down Expand Up @@ -345,17 +340,6 @@ if(BUILD_DEPENDENCIES)
"${ZLIB_EXTERN}"
)

if(NOT WIN32 AND ENABLE_XZ)
add_subdirectory(external/xz)

target_compile_options(
liblzma
PRIVATE
${LZS_C_FLAGS}
-fvisibility=hidden
)
endif()

add_subdirectory(external/zstd/build/cmake)
if(UNIX)
set(ZSTD_EXTERN "-DZSTDLIB_VISIBILITY=__attribute__((visibility(\"hidden\")))")
Expand Down Expand Up @@ -425,14 +409,7 @@ else()

set(ZLIB_ROOT "${ARTIFACTS_ROOT_DIR}" CACHE STRING "" FORCE)
set(BZip2_ROOT "${ARTIFACTS_ROOT_DIR}" CACHE STRING "" FORCE)

if(ENABLE_XZ)
if(WIN32)
find_package(LibLZMA CONFIG REQUIRED)
else()
set(LibLZMA_ROOT "${ARTIFACTS_ROOT_DIR}" CACHE STRING "" FORCE)
endif()
endif()
set(ENABLE_LZMA False CACHE BOOL "Disable lzma support, even if detected" FORCE)

list(PREPEND CMAKE_PREFIX_PATH "${ARTIFACTS_ROOT_DIR}")

Expand Down Expand Up @@ -499,11 +476,6 @@ else()
LIBZIPSHARP_VERSION="${LZS_VERSION}"
)

if(ENABLE_XZ)
message(STATUS "LZMA: ${LIBLZMA_INCLUDE_DIR}")
else()
message(STATUS "LZMA: DISABLED")
endif()
message(STATUS "ZSTD: ${Zstd_INCLUDE_DIR}")
message(STATUS "ZLIB: ${ZLIB_INCLUDE_DIR}")
message(STATUS "BZ2: ${BZIP2_INCLUDE_DIR}")
Expand All @@ -517,20 +489,6 @@ else()
${CMAKE_BINARY_DIR}/external/libzip
)

if(ENABLE_XZ)
target_include_directories(
${PROJECT_NAME}
PRIVATE
${LIBLZMA_INCLUDE_DIR}
)

target_compile_definitions(
${PROJECT_NAME}
PRIVATE
HAVE_XZ=1
)
endif()

target_compile_options(
${PROJECT_NAME}
PRIVATE
Expand Down Expand Up @@ -606,27 +564,15 @@ else()
set(BZ2_PATH "${CMAKE_BINARY_DIR}/libbz2-fat.a")
set(ZSTD_PATH "${CMAKE_BINARY_DIR}/libzstd-fat.a")

if(ENABLE_XZ)
set(LZMA_PATH "${CMAKE_BINARY_DIR}/liblzma-fat.a")
endif()

make_fat_archive("${ARTIFACTS_ROOT_DIR}/lib/libz.a" "${ARTIFACTS_OTHER_ROOT_DIR}/lib/libz.a" "${ZLIB_PATH}")
make_fat_archive("${ARTIFACTS_ROOT_DIR}/lib/libbz2.a" "${ARTIFACTS_OTHER_ROOT_DIR}/lib/libbz2.a" "${BZ2_PATH}")
make_fat_archive("${ARTIFACTS_ROOT_DIR}/lib/libzstd.a" "${ARTIFACTS_OTHER_ROOT_DIR}/lib/libzstd.a" "${ZSTD_PATH}")

if(ENABLE_XZ)
make_fat_archive("${ARTIFACTS_ROOT_DIR}/lib/liblzma.a" "${ARTIFACTS_OTHER_ROOT_DIR}/lib/liblzma.a" "${LZMA_PATH}")
endif()

set(LIBS
${ZLIB_PATH}
${BZ2_PATH}
${ZSTD_PATH}
)

if(ENABLE_XZ)
list(APPEND LIBS ${LZMA_PATH})
endif()
else()
if(WIN32)
if(ENABLE_ZLIBNG)
Expand All @@ -640,20 +586,12 @@ else()
${ARTIFACTS_ROOT_DIR}/lib/bz2.lib
${ARTIFACTS_ROOT_DIR}/lib/zstd.lib
)

if(ENABLE_XZ)
list(APPEND LIBS LibLZMA::LibLZMA)
endif()
else()
set(LIBS
${ARTIFACTS_ROOT_DIR}/lib/libz.a
${ARTIFACTS_ROOT_DIR}/lib/libbz2.a
${ARTIFACTS_ROOT_DIR}/lib/libzstd.a
)

if(ENABLE_XZ)
list(APPEND LIBS ${ARTIFACTS_ROOT_DIR}/lib/liblzma.a)
endif()
endif()
endif()

Expand Down
1 change: 0 additions & 1 deletion LibZipSharp.UnitTest/LibZipSharp.UnitTest.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
<LibZipSharpBundleAllNativeLibraries>true</LibZipSharpBundleAllNativeLibraries>
<ReferenceNuget Condition="'$(ReferenceNuget)' == ''">False</ReferenceNuget>
<DefineConstants Condition="'$(OS)' == 'Windows_NT'">$(DefineConstants);WINDOWS</DefineConstants>
<DefineConstants Condition=" '$(UseXZ)' == 'True' ">$(DefineConstants);HAVE_XZ</DefineConstants>
</PropertyGroup>

<ItemGroup>
Expand Down
7 changes: 0 additions & 7 deletions LibZipSharp.UnitTest/ZipTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,13 @@ public void NativeVersions ()
Assert.IsNotEmpty (versions.LibZip, "libzip version must not be empty");
Assert.IsNotEmpty (versions.Zlib, "zlib version must not be empty");
Assert.IsNotEmpty (versions.ZlibNG, "zlib-ng version must not be empty");
#if HAVE_XZ
Assert.IsNotEmpty (versions.LZMA, "LZMA version must not be empty");
#endif
Assert.IsNotEmpty (versions.LibZipSharp, "LibZipSharp version must not be empty");

Console.WriteLine ($"LibZipSharp version: {versions.LibZipSharp}");
Console.WriteLine ($"BZip2 version: {versions.BZip2}");
Console.WriteLine ($"libzip version: {versions.LibZip}");
Console.WriteLine ($"zlib version: {versions.Zlib}");
Console.WriteLine ($"zlib-ng version: {versions.ZlibNG}");
Console.WriteLine ($"LZMA version: {versions.LZMA}");
}

[Test]
Expand Down Expand Up @@ -217,9 +213,6 @@ public void SmallTextFile ()
[TestCase (CompressionMethod.Deflate)]
[TestCase (CompressionMethod.Bzip2)]
[TestCase (CompressionMethod.ZSTD)]
#if HAVE_XZ
[TestCase (CompressionMethod.XZ)]
#endif
public void UpdateEntryCompressionMethod (CompressionMethod method)
{
var zipStream = new MemoryStream ();
Expand Down
1 change: 0 additions & 1 deletion LibZipSharp.props
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,5 @@
<_NativeBuildDir>$(MSBuildThisFileDirectory)lzsbuild</_NativeBuildDir>
<_ExternalDir>$(MSBuildThisFileDirectory)external</_ExternalDir>
<_MonoPosixNugetVersion>7.1.0-final.1.21458.1</_MonoPosixNugetVersion>
<UseXZ Condition=" '$(UseXZ)' == '' ">false</UseXZ>
</PropertyGroup>
</Project>
2 changes: 0 additions & 2 deletions LibZipSharp/Xamarin.Tools.Zip/Native.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ public struct LZSVersions
public string zlib;
public string zlibng;
public string zstd;
public string lzma;
public string libzipsharp;
};

Expand Down Expand Up @@ -149,7 +148,6 @@ public static Versions get_versions ()
Zlib = ret.zlib ?? String.Empty,
ZlibNG = ret.zlibng ?? String.Empty,
ZStd = ret.zstd ?? String.Empty,
LZMA = ret.lzma ?? String.Empty,
LibZipSharp = ret.libzipsharp ?? String.Empty
};
}
Expand Down
4 changes: 0 additions & 4 deletions LibZipSharp/Xamarin.Tools.Zip/Versions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ public string ZlibNG {
get; internal set;
}

public string LZMA {
get; internal set;
}

public string LibZipSharp {
get; internal set;
}
Expand Down
1 change: 0 additions & 1 deletion LibZipSharp/libZipSharp.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@
<None Include="..\LICENSE" PackagePath="Licences" Pack="true" />
<None Include="$(_ExternalDir)\libzip\LICENSE" PackagePath="Licences\libzip" Pack="true" />
<None Include="$(_ExternalDir)\bzip2\LICENSE" PackagePath="Licences\bzip2" Pack="true" />
<None Include="$(_ExternalDir)\xz\COPYING.LGPLv2.1" PackagePath="Licences\liblzma" Pack="true" />
<None Include="$(_ExternalDir)\zlib-ng\LICENSE.md" PackagePath="Licences\zlib-ng" Pack="true" />
</ItemGroup>
<ItemGroup>
Expand Down
18 changes: 1 addition & 17 deletions build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ JOBS=""
CONFIGURATION="RelWithDebInfo"
REBUILD="no"
VERBOSE="no"
USE_XZ="no"
USE_ZLIBNG="no"

# The color block is pilfered from the dotnet installer script
Expand Down Expand Up @@ -79,7 +78,6 @@ where OPTIONS are one or more of:
-n|--ninja PATH use ninja at PATH instead of the default of '${NINJA}'
-m|--cmake PATH use cmake at PATH instead of the default of '${CMAKE}'

-x|--xz use the XZ library for LZMA support (default: ${USE_XZ})
-g|--zlib-ng use the zlib-ng library instead of zlib (default: ${USE_ZLIBNG}
-c|--configuration NAME build using configuration NAME instead of the default of '${CONFIGURATION}'
-j|--jobs NUM run at most this many build jobs in parallel
Expand Down Expand Up @@ -124,16 +122,11 @@ function cmake_configure()
fi
shift

local use_xz
if [ "${USE_XZ}" == "yes" ]; then
use_xz="-DENABLE_XZ=ON"
fi

run_cmake_common \
-B "${build_dir}" \
-S "${MY_DIR}" \
-G "${GENERATOR}" \
-DCMAKE_BUILD_TYPE="${CONFIGURATION}" ${use_xz} \
-DCMAKE_BUILD_TYPE="${CONFIGURATION}" \
"$@"
}

Expand Down Expand Up @@ -235,11 +228,6 @@ while (( "$#" )); do
fi
;;

-x|--xz)
USE_XZ="yes"
GENERATOR="Unix Makefiles"
shift ;;

-g|--zlib-ng) USE_ZLIBNG="yes"; shift ;;

-v|--verbose) VERBOSE="yes"; shift ;;
Expand Down Expand Up @@ -347,7 +335,3 @@ cmake_configure "${LZS_BUILD_DIR}" -DBUILD_LIBZIP=ON "-DARTIFACTS_ROOT_DIR=${ART

print_banner "Building libZipSharpNative"
cmake_build "${LZS_BUILD_DIR}"

if [ "${USE_XZ}" == "yes" ]; then
echo "${BRIGHT_BLUE}DON'T FORGET TO BUILD THE MANAGED CODE WITH THE /p:UseXZ=True OPTION!${NORMAL}"
fi
3 changes: 0 additions & 3 deletions build_windows.bat
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,6 @@ popd
external\vcpkg\vcpkg.exe integrate install
if %errorlevel% neq 0 exit /b %errorlevel%

external\vcpkg\vcpkg.exe install liblzma:x64-windows-static liblzma:x86-windows-static liblzma:arm-windows-static
if %errorlevel% neq 0 exit /b %errorlevel%

REM 64-bit deps
mkdir "%DEPS_BUILD_DIR_ROOT_64%"
cmake %COMMON_CMAKE_PARAMS% ^
Expand Down
1 change: 0 additions & 1 deletion external/xz
Submodule xz deleted from 18b845
9 changes: 0 additions & 9 deletions native/version.cc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
#include <bzlib.h>
#include <zlib.h>
#include <zstd.h>
#if defined (HAVE_XZ)
#include <lzma.h>
#endif // def HAVE_XZ
#include <zipconf.h>

#include "version.hh"
Expand All @@ -17,11 +14,6 @@ constexpr char libzlibng_version[] = ZLIBNG_VERSION;
#else
constexpr char libzlibng_version[] = "not used";
#endif // ndef ZLIBNG_VERSION
#if defined (HAVE_XZ)
constexpr char lzma_version[] = LZMA_VERSION_STRING;
#else
constexpr char lzma_version[] = "not supported";
#endif // def HAVE_XZ

void lzs_get_versions (LZSVersions *versions)
{
Expand All @@ -34,6 +26,5 @@ void lzs_get_versions (LZSVersions *versions)
versions->zlib = strdup (libzlib_version);
versions->zlibng = strdup (libzlibng_version);
versions->zstd = strdup (ZSTD_versionString ());
versions->lzma = strdup (lzma_version);
versions->libzipsharp = strdup (libzipsharp_version);
}
1 change: 0 additions & 1 deletion native/version.hh
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ struct LZSVersions
const char *zlib;
const char *zlibng;
const char *zstd;
const char *lzma;
const char *libzipsharp;
};

Expand Down