/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package com.mucommander.commons.file.archive.zip.provider;
import java.util.Hashtable;
import java.util.Vector;
import java.util.zip.ZipException;
/**
* ZipExtraField related methods.
*
* <p>--------------------------------------------------------------------------------------------------------------<br>
* <br>
* This class is based off the <code>org.apache.tools.zip</code> package of the <i>Apache Ant</i> project. The Ant
* code has been modified under the terms of the Apache License which you can find in the bundled muCommander license
* file. It was forked at version 1.7.0 of Ant.</p>
*
* @author Apache Ant, Maxence Bernard
*/
public class ExtraFieldUtils {
/**
* Static registry of known extra fields.
*/
private static Hashtable<ZipShort, Class<? extends ZipExtraField>> implementations;
static {
implementations = new Hashtable<ZipShort, Class<? extends ZipExtraField>>();
register(AsiExtraField.class);
register(JarMarker.class);
}
/**
* Register a ZipExtraField implementation.
*
* <p>The given class must have a no-arg constructor and implement
* the {@link ZipExtraField ZipExtraField interface}.</p>
* @param c the class to register
*/
public static void register(Class<? extends ZipExtraField> c) {
try {
ZipExtraField ze = c.newInstance();
implementations.put(ze.getHeaderId(), c);
} catch (ClassCastException cc) {
throw new RuntimeException(c + " doesn\'t implement ZipExtraField");
} catch (InstantiationException ie) {
throw new RuntimeException(c + " is not a concrete class");
} catch (IllegalAccessException ie) {
throw new RuntimeException(c + "\'s no-arg constructor is not public");
}
}
/**
* Create an instance of the approriate ExtraField, falls back to
* {@link UnrecognizedExtraField UnrecognizedExtraField}.
* @param headerId the header identifier
* @return an instance of the appropiate ExtraField
* @exception InstantiationException if unable to instantiate the class
* @exception IllegalAccessException if not allowed to instatiate the class
*/
public static ZipExtraField createExtraField(ZipShort headerId)
throws InstantiationException, IllegalAccessException {
Class<? extends ZipExtraField> c = implementations.get(headerId);
if (c != null) {
return c.newInstance();
}
UnrecognizedExtraField u = new UnrecognizedExtraField();
u.setHeaderId(headerId);
return u;
}
/**
* Split the array into ExtraFields and populate them with the
* give data.
* @param data an array of bytes
* @return an array of ExtraFields
* @throws ZipException on error
*/
public static ZipExtraField[] parse(byte[] data) throws ZipException {
Vector<ZipExtraField> v = new Vector<ZipExtraField>();
int start = 0;
while (start <= data.length - 4) {
ZipShort headerId = new ZipShort(data, start);
int length = (new ZipShort(data, start + 2)).getValue();
if (start + 4 + length > data.length) {
throw new ZipException("data starting at " + start
+ " is in unknown format");
}
try {
ZipExtraField ze = createExtraField(headerId);
ze.parseFromLocalFileData(data, start + 4, length);
v.addElement(ze);
} catch (InstantiationException ie) {
throw new ZipException(ie.getMessage());
} catch (IllegalAccessException iae) {
throw new ZipException(iae.getMessage());
}
start += (length + 4);
}
if (start != data.length) { // array not exhausted
throw new ZipException("data starting at " + start
+ " is in unknown format");
}
ZipExtraField[] result = new ZipExtraField[v.size()];
v.copyInto(result);
return result;
}
/**
* Merges the local file data fields of the given ZipExtraFields.
* @param data an array of ExtraFiles
* @return an array of bytes
*/
public static byte[] mergeLocalExtraFields(ZipExtraField[] data) {
int sum = 4 * data.length;
for (ZipExtraField d : data) {
sum += d.getLocalFileDataLength().getValue();
}
byte[] result = new byte[sum];
int start = 0;
for (ZipExtraField d : data) {
System.arraycopy(d.getHeaderId().getBytes(),
0, result, start, 2);
System.arraycopy(d.getLocalFileDataLength().getBytes(),
0, result, start + 2, 2);
byte[] local = d.getLocalFileDataData();
System.arraycopy(local, 0, result, start + 4, local.length);
start += (local.length + 4);
}
return result;
}
/**
* Merges the central directory fields of the given ZipExtraFields.
* @param data an array of ExtraFields
* @return an array of bytes
*/
public static byte[] mergeCentralExtraFields(ZipExtraField[] data) {
int sum = 4 * data.length;
for (ZipExtraField d : data) {
sum += d.getCentralDirectoryLength().getValue();
}
byte[] result = new byte[sum];
int start = 0;
for (ZipExtraField d : data) {
System.arraycopy(d.getHeaderId().getBytes(),
0, result, start, 2);
System.arraycopy(d.getCentralDirectoryLength().getBytes(),
0, result, start + 2, 2);
byte[] local = d.getCentralDirectoryData();
System.arraycopy(local, 0, result, start + 4, local.length);
start += (local.length + 4);
}
return result;
}
}