add support for XZ compression

Signed-off-by: Ceki Gulcu <[email protected]>

Author: ceki

Diff for: logback-core/src/main/java/ch/qos/logback/core/rolling/FixedWindowRollingPolicy.java

@@ -151,6 +151,7 @@ public void rollover() throws RolloverFailure {
                 util.rename(getActiveFileName(), fileNamePattern.convertInt(minIndex));
                 break;
             case GZ:
+            case XZ:
                 compressor.compress(getActiveFileName(), fileNamePattern.convertInt(minIndex), null);
                 break;
             case ZIP:

Diff for: logback-core/src/main/java/ch/qos/logback/core/rolling/RollingPolicyBase.java

@@ -51,6 +51,9 @@ protected void determineCompressionMode() {
         } else if (fileNamePatternStr.endsWith(".zip")) {
             addInfo("Will use zip compression");
             compressionMode = CompressionMode.ZIP;
+        } else if (fileNamePatternStr.endsWith(".xz")) {
+            addInfo("Will use xz compression");
+            compressionMode = CompressionMode.XZ;
         } else {
             addInfo("No compression will be used");
             compressionMode = CompressionMode.NONE;

Diff for: logback-core/src/main/java/ch/qos/logback/core/rolling/helper/CompressionStrategy.java

@@ -16,9 +16,14 @@
 
 import ch.qos.logback.core.spi.ContextAware;
 
+/**
+ * This interface was introduced in order to support for pluggable
+ * compression methods.
+ *
+ * @author Ceki Gülc&uuml
+ * @since 1.5.18
+ */
 public interface CompressionStrategy extends ContextAware {
 
     void compress(String originalFileName, String compressedFileName, String innerEntryName);
-
-   //String computeFileNameStrWithoutCompSuffix(String fileNamePatternStr);
 }

Diff for: logback-core/src/main/java/ch/qos/logback/core/rolling/helper/Compressor.java

@@ -82,30 +82,6 @@ private CompressionStrategy dynamicInstantiation(String className) {
         }
     }
 
-    // http://jira.qos.ch/browse/LBCORE-98
-    // The name of the compressed file as nested within the zip archive
-    //
-    // Case 1: RawFile = null, Pattern = foo-%d.zip
-    // nestedFilename = foo-${current-date}
-    //
-    // Case 2: RawFile = hello.txt, Pattern = = foo-%d.zip
-    // nestedFilename = foo-${current-date}
-    //
-    // in both cases, the strategy consisting of removing the compression
-    // suffix of zip file works reasonably well. The alternative strategy
-    // whereby the nested file name was based on the value of the raw file name
-    // (applicable to case 2 only) has the disadvantage of the nested files
-    // all having the same name, which could make it harder for the user
-    // to unzip the file without collisions
-    //    ZipEntry computeZipEntry(File zippedFile) {
-    //        return computeZipEntry(zippedFile.getName());
-    //    }
-    //
-    //    ZipEntry computeZipEntry(String filename) {
-    //        String nameOfFileNestedWithinArchive = computeFileNameStrWithoutCompSuffix(filename, compressionMode);
-    //        return new ZipEntry(nameOfFileNestedWithinArchive);
-    //    }
-
     static public String computeFileNameStrWithoutCompSuffix(String fileNamePatternStr, CompressionMode compressionMode) {
         int len = fileNamePatternStr.length();
         switch (compressionMode) {
@@ -130,13 +106,6 @@ static public String computeFileNameStrWithoutCompSuffix(String fileNamePatternS
         throw new IllegalStateException("Execution should not reach this point");
     }
 
-    //    void createMissingTargetDirsIfNecessary(File file) {
-    //        boolean result = FileUtil.createMissingParentDirectories(file);
-    //        if (!result) {
-    //            addError("Failed to create parent directories for [" + file.getAbsolutePath() + "]");
-    //        }
-    //    }
-
     @Override
     public String toString() {
         return this.getClass().getName();

Diff for: logback-core/src/main/java/ch/qos/logback/core/rolling/helper/GZCompressionStrategy.java

@@ -26,7 +26,6 @@
 public class GZCompressionStrategy extends CompressionStrategyBase {
 
 
-
     @Override
     public void compress(String originalFileName, String compressedFileName, String innerEntryName) {
 
@@ -70,15 +69,6 @@ public void compress(String originalFileName, String compressedFileName, String
         if (!file2gz.delete()) {
             addStatus(new WarnStatus("Could not delete [" + originalFileName + "].", this));
         }
-
     }
 
-//    @Override
-//    public String computeFileNameStrWithoutCompSuffix(String fileNamePatternStr) {
-//        int len = fileNamePatternStr.length();
-//        if (fileNamePatternStr.endsWith(".gz"))
-//            return fileNamePatternStr.substring(0, len - 3);
-//        else
-//            return fileNamePatternStr;
-//    }
 }

Diff for: logback-core/src/main/java/ch/qos/logback/core/rolling/helper/XZCompressionStrategy.java

@@ -1,3 +1,16 @@
+/*
+ * Logback: the reliable, generic, fast and flexible logging framework.
+ * Copyright (C) 1999-2025, QOS.ch. All rights reserved.
+ *
+ * This program and the accompanying materials are dual-licensed under
+ * either the terms of the Eclipse Public License v1.0 as published by
+ * the Eclipse Foundation
+ *
+ *   or (per the licensee's choosing)
+ *
+ * under the terms of the GNU Lesser General Public License version 2.1
+ * as published by the Free Software Foundation.
+ */
 package ch.qos.logback.core.rolling.helper;
 
 import java.io.BufferedInputStream;
@@ -7,6 +20,15 @@
 import org.tukaani.xz.LZMA2Options;
 import org.tukaani.xz.XZOutputStream;
 
+/**
+ * Compresses files using {@link org.tukaani.xz xz} library.
+ *
+ * <p>Note that </p>
+ *
+ * @author Marian Kazimir
+ * @author Ceki G&uuml;lc&uuml;
+ * @since 1.5.18
+ */
 public class XZCompressionStrategy extends CompressionStrategyBase {
 
     @Override

Diff for: logback-core/src/main/java/ch/qos/logback/core/rolling/helper/ZipCompressionStrategy.java

@@ -24,6 +24,12 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
 
+/**
+ * Compresses files using JDK's Zip compression algorithm.
+ *
+ * @author Ceki Gülcü
+ * @since 1.5.18
+ */
 public class ZipCompressionStrategy extends CompressionStrategyBase {
     static final int BUFFER_SIZE = 8192;
 
@@ -80,14 +86,6 @@ public void compress(String originalFileName, String compressedFileName, String
         }
     }
 
-    private String computeFileNameStrWithoutCompSuffix(String fileNamePatternStr) {
-        int len = fileNamePatternStr.length();
-        if (fileNamePatternStr.endsWith(".zip"))
-            return fileNamePatternStr.substring(0, len - 4);
-        else
-            return fileNamePatternStr;
-    }
-
     // http://jira.qos.ch/browse/LBCORE-98
     // The name of the compressed file as nested within the zip archive
     //
@@ -108,7 +106,7 @@ private String computeFileNameStrWithoutCompSuffix(String fileNamePatternStr) {
     //}
 
     ZipEntry computeZipEntry(String filename) {
-        String nameOfFileNestedWithinArchive = computeFileNameStrWithoutCompSuffix(filename);
+        String nameOfFileNestedWithinArchive = Compressor.computeFileNameStrWithoutCompSuffix(filename, CompressionMode.ZIP);
         return new ZipEntry(nameOfFileNestedWithinArchive);
     }
 }