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.helper;
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
25 import java.util.zip.GZIPOutputStream;
26
27 /**
28 * Compresses a file using GZ compression.
29 */
30 public final class GZCompressAction extends ActionBase {
31
32 private static final int BUF_SIZE = 8102;
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 if (source == null) {
59 throw new NullPointerException("source");
60 }
61
62 if (destination == null) {
63 throw new NullPointerException("destination");
64 }
65
66 this.source = source;
67 this.destination = destination;
68 this.deleteSource = deleteSource;
69 }
70
71 /**
72 * Compress.
73 *
74 * @return true if successfully compressed.
75 * @throws IOException on IO exception.
76 */
77 public boolean execute() throws IOException {
78 return execute(source, destination, deleteSource);
79 }
80
81 /**
82 * Compress a file.
83 *
84 * @param source file to compress, may not be null.
85 * @param destination compressed file, may not be null.
86 * @param deleteSource if true, attempt to delete file on completion. Failure to delete
87 * does not cause an exception to be thrown or affect return value.
88 * @return true if source file compressed.
89 * @throws IOException on IO exception.
90 */
91 public static boolean execute(final File source, final File destination, final boolean deleteSource)
92 throws IOException {
93 if (source.exists()) {
94 FileInputStream fis = new FileInputStream(source);
95 FileOutputStream fos = new FileOutputStream(destination);
96 GZIPOutputStream gzos = new GZIPOutputStream(fos);
97 BufferedOutputStream os = new BufferedOutputStream(gzos);
98 byte[] inbuf = new byte[BUF_SIZE];
99 int n;
100
101 while ((n = fis.read(inbuf)) != -1) {
102 os.write(inbuf, 0, n);
103 }
104
105 os.close();
106 fis.close();
107
108 if (deleteSource && !source.delete()) {
109 LOGGER.warn("Unable to delete " + source.toString() + ".");
110 }
111
112 return true;
113 }
114
115 return false;
116 }
117
118
119 /**
120 * Capture exception.
121 *
122 * @param ex exception.
123 */
124 protected void reportException(final Exception ex) {
125 LOGGER.warn("Exception during compression of '" + source.toString() + "'.", ex);
126 }
127
128 }