package ch.cyberduck.core;
/*
* Copyright (c) 2008 David Kocher. All rights reserved.
* http://cyberduck.ch/
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* Bug fixes, suggestions and comments should be sent to:
* dkocher@cyberduck.ch
*/
import ch.cyberduck.core.i18n.Locale;
import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;
/**
* Description of an archive format
* @version $Id: Archive.java 5746 2010-01-15 16:23:04Z dkocher $
*/
public abstract class Archive {
private static Logger log = Logger.getLogger(Archive.class);
/**
* @uml.property name="tAR"
* @uml.associationEnd
*/
public static final Archive TAR
= new Archive("tar") {
@Override
public String getDescription() {
return Locale.localizedString("tar archive", "Archive");
}
};
/**
* @uml.property name="tARGZ"
* @uml.associationEnd
*/
public static final Archive TARGZ
= new Archive("tar.gz") {
@Override
public String getDescription() {
return Locale.localizedString("gzip compressed tar archive", "Archive");
}
@Override
public String[] getExtensions() {
return new String[]{this.getIdentifier(), "tgz"};
}
};
/**
* @uml.property name="tARBZ2"
* @uml.associationEnd
*/
public static final Archive TARBZ2
= new Archive("tar.bz2") {
@Override
public String getDescription() {
return Locale.localizedString("bzip2 compressed tar archive", "Archive");
}
@Override
public String[] getExtensions() {
return new String[]{this.getIdentifier(), "tbz", "tbz2"};
}
};
/**
* @uml.property name="zIP"
* @uml.associationEnd
*/
public static final Archive ZIP
= new Archive("zip") {
@Override
public String getDescription() {
return Locale.localizedString("ZIP archive", "Archive");
}
};
/**
* @uml.property name="gZIP"
* @uml.associationEnd
*/
public static final Archive GZIP
= new Archive("gz") {
@Override
public String getDescription() {
return Locale.localizedString("gzip compressed tar archive", "Archive");
}
@Override
public String[] getExtensions() {
return new String[]{this.getIdentifier(), "gzip"};
}
};
/**
* @uml.property name="bZ2"
* @uml.associationEnd
*/
public static final Archive BZ2
= new Archive("bz2") {
@Override
public String getDescription() {
return Locale.localizedString("bzip2 compressed archive", "Archive");
}
@Override
public String[] getExtensions() {
return new String[]{this.getIdentifier(), "bz", "bzip2"};
}
};
/**
* @return The default archiver set in the Preferences
*/
public static Archive getDefault() {
return Archive.forName(Preferences.instance().getProperty("archive.default"));
}
/**
* @return
*/
public static Archive[] getKnownArchives() {
return new Archive[]{TAR, TARGZ, TARBZ2, ZIP};
}
/**
* Factory
*
* @param name
* @return
*/
public static Archive forName(final String name) {
if(StringUtils.isNotBlank(name)) {
for(Archive archive : getKnownArchives()) {
for(String extension : archive.getExtensions()) {
if(name.toLowerCase().endsWith(extension.toLowerCase())) {
return archive;
}
}
}
}
log.fatal("Unknown archive:" + name);
return null;
}
/**
* Typical filename extension. The default
* @uml.property name="identifier"
*/
private String identifier;
/**
* @param extension
*/
private Archive(final String extension) {
this.identifier = extension;
}
/**
* @return
*/
public String[] getExtensions() {
return new String[]{this.getIdentifier()};
}
/**
* @return
* @uml.property name="identifier"
*/
public String getIdentifier() {
return identifier;
}
/**
* @uml.property name="description"
*/
public abstract String getDescription();
/**
* @param files
* @return
*/
public Path getArchive(final List<Path> files) {
if(files.size() == 0) {
return null;
}
try {
if(files.size() == 1) {
return PathFactory.createPath(files.get(0).getSession(), files.get(0).getParent().getAbsolute(),
files.get(0).getName() + "." + this.getIdentifier(),
Path.FILE_TYPE);
}
return PathFactory.createPath(files.get(0).getSession(), files.get(0).getParent().getAbsolute(),
Locale.localizedString("Archive", "Archive") + "." + this.getIdentifier(),
Path.FILE_TYPE);
}
catch(ConnectionCanceledException e) {
log.error(e.getMessage());
}
return null;
}
/**
* @param files
* @return
*/
public List<Path> getExpanded(final List<Path> files) {
final List<Path> expanded = new ArrayList<Path>();
try {
for(Path file : files) {
expanded.add(PathFactory.createPath(file.getSession(), file.getParent().getAbsolute(),
StringUtils.remove(file.getName(), "." + this.getIdentifier()),
Path.FILE_TYPE));
}
}
catch(ConnectionCanceledException e) {
log.error(e.getMessage());
}
return expanded;
}
/**
* @param files
* @return
*/
public String getTitle(final List<Path> files) {
Path archive = this.getArchive(files);
if(null == archive) {
return this.getIdentifier();
}
return archive.getName();
}
/**
* @return
*/
public String getCompressCommand(final List<Path> paths) {
String archive;
if(paths.size() == 1) {
archive = paths.get(0).getAbsolute();
}
else {
archive = paths.get(0).getParent().getAbsolute() + Path.DELIMITER + "Archive";
}
final List<String> files = new ArrayList<String>();
for(Path path : paths) {
files.add(this.escape(path.getAbsolute()));
}
return MessageFormat.format(Preferences.instance().getProperty("archive.command.create." + this.getIdentifier()),
this.escape(archive), StringUtils.join(files, " "));
}
/**
* @return
*/
public String getDecompressCommand(final Path path) {
return MessageFormat.format(Preferences.instance().getProperty("archive.command.expand." + this.getIdentifier()),
this.escape(path.getAbsolute()), this.escape(path.getParent().getAbsolute()));
}
/**
* Escape blank
*
* @param path
* @return
*/
private String escape(String path) {
return StringUtils.replace(path, " ", "\\ ");
}
/**
* @return True if a known file extension for compressed archives
*/
public static boolean isArchive(final String filename) {
if(StringUtils.isNotBlank(filename)) {
for(Archive archive : getKnownArchives()) {
for(String extension : archive.getExtensions()) {
if(filename.endsWith(extension)) {
return true;
}
}
}
}
return false;
}
}