1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.appender.rolling.action;
18
19 import java.io.BufferedOutputStream;
20 import java.io.File;
21 import java.io.FileInputStream;
22 import java.io.FileOutputStream;
23 import java.io.IOException;
24 import java.util.Objects;
25 import java.util.zip.GZIPOutputStream;
26
27 /**
28 * Compresses a file using GZ compression.
29 */
30 public final class GzCompressAction extends AbstractAction {
31
32 private static final int BUF_SIZE = 8192;
33
34 /**
35 * Source file.
36 */
37 private final File source;
38
39 /**
40 * Destination file.
41 */
42 private final File destination;
43
44 /**
45 * If true, attempt to delete file on completion.
46 */
47 private final boolean deleteSource;
48
49 /**
50 * Create new instance of GzCompressAction.
51 *
52 * @param source file to compress, may not be null.
53 * @param destination compressed file, may not be null.
54 * @param deleteSource if true, attempt to delete file on completion. Failure to delete
55 * does not cause an exception to be thrown or affect return value.
56 */
57 public GzCompressAction(final File source, final File destination, final boolean deleteSource) {
58 Objects.requireNonNull(source, "source");
59 Objects.requireNonNull(destination, "destination");
60
61 this.source = source;
62 this.destination = destination;
63 this.deleteSource = deleteSource;
64 }
65
66 /**
67 * Compress.
68 *
69 * @return true if successfully compressed.
70 * @throws IOException on IO exception.
71 */
72 @Override
73 public boolean execute() throws IOException {
74 return execute(source, destination, deleteSource);
75 }
76
77 /**
78 * Compress a file.
79 *
80 * @param source file to compress, may not be null.
81 * @param destination compressed file, may not be null.
82 * @param deleteSource if true, attempt to delete file on completion. Failure to delete
83 * does not cause an exception to be thrown or affect return value.
84 * @return true if source file compressed.
85 * @throws IOException on IO exception.
86 */
87 public static boolean execute(final File source, final File destination, final boolean deleteSource)
88 throws IOException {
89 if (source.exists()) {
90 try (final FileInputStream fis = new FileInputStream(source);
91 final BufferedOutputStream os = new BufferedOutputStream(new GZIPOutputStream(new FileOutputStream(
92 destination)))) {
93 final byte[] inbuf = new byte[BUF_SIZE];
94 int n;
95
96 while ((n = fis.read(inbuf)) != -1) {
97 os.write(inbuf, 0, n);
98 }
99 }
100
101 if (deleteSource && !source.delete()) {
102 LOGGER.warn("Unable to delete " + source.toString() + '.');
103 }
104
105 return true;
106 }
107
108 return false;
109 }
110
111
112 /**
113 * Capture exception.
114 *
115 * @param ex exception.
116 */
117 @Override
118 protected void reportException(final Exception ex) {
119 LOGGER.warn("Exception during compression of '" + source.toString() + "'.", ex);
120 }
121
122 @Override
123 public String toString() {
124 return GzCompressAction.class.getSimpleName() + '[' + source + " to " + destination
125 + ", deleteSource=" + deleteSource + ']';
126 }
127
128 public File getSource() {
129 return source;
130 }
131
132 public File getDestination() {
133 return destination;
134 }
135
136 public boolean isDeleteSource() {
137 return deleteSource;
138 }
139 }