/hudson-core/src/main/java/hudson/util/io/ZipArchiver.java

 1/*
 2 * The MIT License
 3 *
 4 * Copyright (c) 2010, InfraDNA, Inc.
 5 *
 6 * Permission is hereby granted, free of charge, to any person obtaining a copy
 7 * of this software and associated documentation files (the "Software"), to deal
 8 * in the Software without restriction, including without limitation the rights
 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25package hudson.util.io;
26
27import hudson.util.FileVisitor;
28import org.apache.tools.zip.ZipEntry;
29import org.apache.tools.zip.ZipOutputStream;
30
31import java.io.File;
32import java.io.FileInputStream;
33import java.io.IOException;
34import java.io.OutputStream;
35
36/**
37 * {@link FileVisitor} that creates a zip archive.
38 *
39 * @see ArchiverFactory#ZIP
40 */
41final class ZipArchiver extends Archiver {
42    private final byte[] buf = new byte[8192];
43    private final ZipOutputStream zip;
44
45    ZipArchiver(OutputStream out) {
46        zip = new ZipOutputStream(out);
47        zip.setEncoding(System.getProperty("file.encoding"));
48    }
49
50    public void visit(File f, String relativePath) throws IOException {
51        if(f.isDirectory()) {
52            ZipEntry dirZipEntry = new ZipEntry(relativePath+'/');
53            // Setting this bit explicitly is needed by some unzipping applications (see HUDSON-3294).
54            dirZipEntry.setExternalAttributes(BITMASK_IS_DIRECTORY);
55            zip.putNextEntry(dirZipEntry);
56            zip.closeEntry();
57        } else {
58            zip.putNextEntry(new ZipEntry(relativePath));
59            FileInputStream in = new FileInputStream(f);
60            int len;
61            while((len=in.read(buf))>0)
62                zip.write(buf,0,len);
63            in.close();
64            zip.closeEntry();
65        }
66        entriesWritten++;
67    }
68
69    public void close() throws IOException {
70        zip.close();
71    }
72
73    // Bitmask indicating directories in 'external attributes' of a ZIP archive entry.
74    private static final long BITMASK_IS_DIRECTORY = 1<<4;
75}