blob: 898c030073242adea59ac142a5f9bc7152ceb472 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.logging.log4j.core.appender.rolling.helper;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import java.io.File;<a name="line.19"></a>
<FONT color="green">020</FONT> import java.io.FileInputStream;<a name="line.20"></a>
<FONT color="green">021</FONT> import java.io.FileOutputStream;<a name="line.21"></a>
<FONT color="green">022</FONT> import java.io.IOException;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.zip.ZipEntry;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.util.zip.ZipOutputStream;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * Compresses a file using Zip compression.<a name="line.29"></a>
<FONT color="green">030</FONT> */<a name="line.30"></a>
<FONT color="green">031</FONT> public final class ZipCompressAction extends ActionBase {<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> private static final int BUF_SIZE = 8102;<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> /**<a name="line.35"></a>
<FONT color="green">036</FONT> * Source file.<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> private final File source;<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> /**<a name="line.40"></a>
<FONT color="green">041</FONT> * Destination file.<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> private final File destination;<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> /**<a name="line.45"></a>
<FONT color="green">046</FONT> * If true, attempt to delete file on completion.<a name="line.46"></a>
<FONT color="green">047</FONT> */<a name="line.47"></a>
<FONT color="green">048</FONT> private final boolean deleteSource;<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> /**<a name="line.50"></a>
<FONT color="green">051</FONT> * Create new instance of GZCompressAction.<a name="line.51"></a>
<FONT color="green">052</FONT> *<a name="line.52"></a>
<FONT color="green">053</FONT> * @param source file to compress, may not be null.<a name="line.53"></a>
<FONT color="green">054</FONT> * @param destination compressed file, may not be null.<a name="line.54"></a>
<FONT color="green">055</FONT> * @param deleteSource if true, attempt to delete file on completion. Failure to delete<a name="line.55"></a>
<FONT color="green">056</FONT> * does not cause an exception to be thrown or affect return value.<a name="line.56"></a>
<FONT color="green">057</FONT> */<a name="line.57"></a>
<FONT color="green">058</FONT> public ZipCompressAction(final File source, final File destination, final boolean deleteSource) {<a name="line.58"></a>
<FONT color="green">059</FONT> if (source == null) {<a name="line.59"></a>
<FONT color="green">060</FONT> throw new NullPointerException("source");<a name="line.60"></a>
<FONT color="green">061</FONT> }<a name="line.61"></a>
<FONT color="green">062</FONT> <a name="line.62"></a>
<FONT color="green">063</FONT> if (destination == null) {<a name="line.63"></a>
<FONT color="green">064</FONT> throw new NullPointerException("destination");<a name="line.64"></a>
<FONT color="green">065</FONT> }<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> this.source = source;<a name="line.67"></a>
<FONT color="green">068</FONT> this.destination = destination;<a name="line.68"></a>
<FONT color="green">069</FONT> this.deleteSource = deleteSource;<a name="line.69"></a>
<FONT color="green">070</FONT> }<a name="line.70"></a>
<FONT color="green">071</FONT> <a name="line.71"></a>
<FONT color="green">072</FONT> /**<a name="line.72"></a>
<FONT color="green">073</FONT> * Compress.<a name="line.73"></a>
<FONT color="green">074</FONT> *<a name="line.74"></a>
<FONT color="green">075</FONT> * @return true if successfully compressed.<a name="line.75"></a>
<FONT color="green">076</FONT> * @throws IOException on IO exception.<a name="line.76"></a>
<FONT color="green">077</FONT> */<a name="line.77"></a>
<FONT color="green">078</FONT> public boolean execute() throws IOException {<a name="line.78"></a>
<FONT color="green">079</FONT> return execute(source, destination, deleteSource);<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> <a name="line.81"></a>
<FONT color="green">082</FONT> /**<a name="line.82"></a>
<FONT color="green">083</FONT> * Compress a file.<a name="line.83"></a>
<FONT color="green">084</FONT> *<a name="line.84"></a>
<FONT color="green">085</FONT> * @param source file to compress, may not be null.<a name="line.85"></a>
<FONT color="green">086</FONT> * @param destination compressed file, may not be null.<a name="line.86"></a>
<FONT color="green">087</FONT> * @param deleteSource if true, attempt to delete file on completion. Failure to delete<a name="line.87"></a>
<FONT color="green">088</FONT> * does not cause an exception to be thrown or affect return value.<a name="line.88"></a>
<FONT color="green">089</FONT> * @return true if source file compressed.<a name="line.89"></a>
<FONT color="green">090</FONT> * @throws IOException on IO exception.<a name="line.90"></a>
<FONT color="green">091</FONT> */<a name="line.91"></a>
<FONT color="green">092</FONT> public static boolean execute(final File source, final File destination, final boolean deleteSource)<a name="line.92"></a>
<FONT color="green">093</FONT> throws IOException {<a name="line.93"></a>
<FONT color="green">094</FONT> if (source.exists()) {<a name="line.94"></a>
<FONT color="green">095</FONT> FileInputStream fis = new FileInputStream(source);<a name="line.95"></a>
<FONT color="green">096</FONT> FileOutputStream fos = new FileOutputStream(destination);<a name="line.96"></a>
<FONT color="green">097</FONT> ZipOutputStream zos = new ZipOutputStream(fos);<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> ZipEntry zipEntry = new ZipEntry(source.getName());<a name="line.99"></a>
<FONT color="green">100</FONT> zos.putNextEntry(zipEntry);<a name="line.100"></a>
<FONT color="green">101</FONT> <a name="line.101"></a>
<FONT color="green">102</FONT> byte[] inbuf = new byte[BUF_SIZE];<a name="line.102"></a>
<FONT color="green">103</FONT> int n;<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> while ((n = fis.read(inbuf)) != -1) {<a name="line.105"></a>
<FONT color="green">106</FONT> zos.write(inbuf, 0, n);<a name="line.106"></a>
<FONT color="green">107</FONT> }<a name="line.107"></a>
<FONT color="green">108</FONT> <a name="line.108"></a>
<FONT color="green">109</FONT> zos.close();<a name="line.109"></a>
<FONT color="green">110</FONT> fis.close();<a name="line.110"></a>
<FONT color="green">111</FONT> <a name="line.111"></a>
<FONT color="green">112</FONT> if (deleteSource &amp;&amp; !source.delete()) {<a name="line.112"></a>
<FONT color="green">113</FONT> LOGGER.warn("Unable to delete " + source.toString() + ".");<a name="line.113"></a>
<FONT color="green">114</FONT> }<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> return true;<a name="line.116"></a>
<FONT color="green">117</FONT> }<a name="line.117"></a>
<FONT color="green">118</FONT> <a name="line.118"></a>
<FONT color="green">119</FONT> return false;<a name="line.119"></a>
<FONT color="green">120</FONT> }<a name="line.120"></a>
<FONT color="green">121</FONT> <a name="line.121"></a>
<FONT color="green">122</FONT> /**<a name="line.122"></a>
<FONT color="green">123</FONT> * Capture exception.<a name="line.123"></a>
<FONT color="green">124</FONT> *<a name="line.124"></a>
<FONT color="green">125</FONT> * @param ex exception.<a name="line.125"></a>
<FONT color="green">126</FONT> */<a name="line.126"></a>
<FONT color="green">127</FONT> protected void reportException(final Exception ex) {<a name="line.127"></a>
<FONT color="green">128</FONT> LOGGER.warn("Exception during compression of '" + source.toString() + "'.", ex);<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> }<a name="line.130"></a>
</PRE>
</BODY>
</HTML>