ZipArchiveBackupDescriptor.java

package org.exist.backup;

import java.io.IOException;
import java.io.File;
import java.io.FileNotFoundException;
import java.util.zip.ZipEntry;
import java.util.zip.ZipException;
import java.util.zip.ZipFile;
import java.util.Enumeration;
import java.util.Properties;
import java.util.Date;

import org.exist.util.EXistInputSource;
import org.exist.util.ZipEntryInputSource;
import org.exist.xquery.value.DateTimeValue;
import org.exist.xquery.XPathException;

public class ZipArchiveBackupDescriptor extends AbstractBackupDescriptor
{
	protected ZipFile archive;
	protected ZipEntry descriptor;
	protected String base;

	public ZipArchiveBackupDescriptor(File fileArchive)
		throws ZipException,IOException,FileNotFoundException
	{
		archive=new ZipFile(fileArchive);
		
		//is it full backup?
		base="db/";
		descriptor=archive.getEntry(base+BackupDescriptor.COLLECTION_DESCRIPTOR);
		if(descriptor==null || descriptor.isDirectory()) {
			
			base = null;
			//looking for highest collection
			//TODO: better to put some information on top? 
			ZipEntry item = null;
			Enumeration zipEnum = archive.entries();
			while(zipEnum.hasMoreElements()) {
				item = (ZipEntry) zipEnum.nextElement();

				if (!item.isDirectory()) {
					if (item.getName().endsWith(BackupDescriptor.COLLECTION_DESCRIPTOR)) {
						if (base == null || base.length() > item.getName().length()) {
							descriptor = item;
							base = item.getName();
						}
					}
				}
			}
			
			if (base != null)
				base = base.substring(0, base.length() - BackupDescriptor.COLLECTION_DESCRIPTOR.length());
		}

		if (descriptor == null) {
			throw new FileNotFoundException("Archive "+fileArchive.getAbsolutePath()+" is not a valid eXist backup archive");
		}
	}
	
	private ZipArchiveBackupDescriptor(ZipFile archive,String base)
		throws FileNotFoundException
	{
		this.archive=archive;
		this.base=base;
		descriptor=archive.getEntry(base+BackupDescriptor.COLLECTION_DESCRIPTOR);
		if(descriptor==null || descriptor.isDirectory()) {
			throw new FileNotFoundException(archive.getName()+" is a bit corrupted ("+base+" descriptor not found): not a valid eXist backup archive");
		}
	}
    
    public Object getContent(String fileName) {
        EXistInputSource is = getInputSource(fileName);
        if (is.getByteStreamLength() == 0)
            return "";
        return is;
    }

    public BackupDescriptor getChildBackupDescriptor(String describedItem) {
		BackupDescriptor bd=null;
		try {
			bd=new ZipArchiveBackupDescriptor(archive,base+describedItem+"/");
		} catch(FileNotFoundException fnfe) {
			// DoNothing(R)
		}
		
		return bd;
	}

    public BackupDescriptor getBackupDescriptor(String describedItem) {
        if (describedItem.length() > 0 && describedItem.charAt(0) == '/')
            describedItem = describedItem.substring(1);
        if (!describedItem.endsWith("/"))
            describedItem = describedItem + '/';
        BackupDescriptor bd = null;
        try {
            bd = new ZipArchiveBackupDescriptor(archive, describedItem);
        } catch (FileNotFoundException e) {
            // DoNothing(R)
        }
        return bd;
    }

    public EXistInputSource getInputSource() {
		return new ZipEntryInputSource(archive,descriptor);
	}

	public EXistInputSource getInputSource(String describedItem) {
		ZipEntry ze = archive.getEntry(base+describedItem);
		EXistInputSource retval=null;
		if(ze!=null && !ze.isDirectory()) {
			retval=new ZipEntryInputSource(archive,ze);
		}
		
		return retval;
	}

	public String getSymbolicPath() {
		return archive.getName()+"#"+descriptor.getName();
	}
	
	public String getSymbolicPath(String describedItem,boolean isChildDescriptor) {
		String retval=archive.getName()+"#"+base+describedItem;
		if(isChildDescriptor)
			retval+="/"+BackupDescriptor.COLLECTION_DESCRIPTOR;
		return retval;
	}

    public Properties getProperties() throws IOException {
        Properties properties = null;
        ZipEntry ze = archive.getEntry(BACKUP_PROPERTIES);
        if (ze != null) {
            properties = new Properties();
            properties.load(archive.getInputStream(ze));
        }
        return properties;
    }

    public File getParentDir() {
        return new File(archive.getName()).getParentFile();
    }


    public String getName() {
        return new File(archive.getName()).getName();
    }
}