/* The contents of this file are subject to the license and copyright terms
* detailed in the license directory at the root of the source tree (also
* available online at http://fedora-commons.org/license/).
*/
package org.fcrepo.client.utility.export;
import java.io.File;
import java.io.FileOutputStream;
import java.util.List;
import java.util.StringTokenizer;
import org.fcrepo.client.FedoraClient;
import org.fcrepo.client.utility.AutoFinder;
import org.fcrepo.common.Constants;
import org.fcrepo.server.access.FedoraAPIAMTOM;
import org.fcrepo.server.management.FedoraAPIMMTOM;
import org.fcrepo.server.types.gen.ArrayOfString;
import org.fcrepo.server.types.gen.FieldSearchQuery;
import org.fcrepo.server.types.gen.FieldSearchResult;
import org.fcrepo.server.types.gen.ObjectFields;
import org.fcrepo.server.types.gen.RepositoryInfo;
/**
* Utility to initiate an export of one or more objects. This class provides
* static utility methods, and it is also called by command line utilities. This
* class calls AutoExporter.class which is responsible for making the API-M SOAP
* calls for the export.
*
* @version $Id$
*/
public class Export
implements Constants {
// FIXME: this isn't export-specific... it doesn't belong here
public static String getDuration(long millis) {
long tsec = millis / 1000;
long h = tsec / 60 / 60;
long m = (tsec - h * 60 * 60) / 60;
long s = tsec - h * 60 * 60 - m * 60;
StringBuffer out = new StringBuffer();
if (h > 0) {
out.append(h + " hour");
if (h > 1) {
out.append('s');
}
}
if (m > 0) {
if (h > 0) {
out.append(", ");
}
out.append(m + " minute");
if (m > 1) {
out.append('s');
}
}
if (s > 0 || h == 0 && m == 0) {
if (h > 0 || m > 0) {
out.append(", ");
}
out.append(s + " second");
if (s != 1) {
out.append('s');
}
}
return out.toString();
}
public static void one(FedoraAPIAMTOM apia,
FedoraAPIMMTOM apim,
String pid,
String format,
String exportContext,
File dir) throws Exception {
String suffix;
if (ATOM_ZIP1_1.uri.equals(format)) {
suffix = ".zip";
} else {
suffix = ".xml";
}
String fName = pid.replaceAll(":", "_") + suffix;
File file = new File(dir, fName);
System.out.println("Exporting " + pid + " to " + file.getPath());
AutoExporter.export(apia,
apim,
pid,
format,
exportContext,
new FileOutputStream(file));
}
public static int multi(FedoraAPIAMTOM apia,
FedoraAPIMMTOM apim,
String format,
String exportContext,
File dir) throws Exception {
int count = 0;
// prepare the FieldSearch query
FieldSearchQuery query = new FieldSearchQuery();
query.setTerms(null);
ArrayOfString resultFields = new ArrayOfString();
resultFields.getItem().add("pid");
// get the first chunk of search results
FieldSearchResult result =
AutoFinder.findObjects(apia, resultFields, 100, query);
while (result != null && result.getResultList() != null) {
List<ObjectFields> ofs = result.getResultList().getObjectFields();
// export all objects from this chunk of search results
for (ObjectFields element : ofs) {
String pid = element.getPid().getValue();
one(apia, apim, pid, format, exportContext, dir);
count++;
}
// get the next chunk of search results, if any
String token = null;
try {
token = result.getListSession().getValue().getToken();
} catch (Throwable th) {
}
if (token != null) {
result = AutoFinder.resumeFindObjects(apia, token);
} else {
result = null;
}
}
return count;
}
/**
* Print error message and show usage for command-line interface.
*/
public static void badArgs(String msg) {
System.err.println("Command: fedora-export");
System.err.println();
System.err.println("Summary: Exports one or more objects from a Fedora repository.");
System.err.println();
System.err.println("Syntax:");
System.err.println(" fedora-export host:port user password pid|ftyps format econtext path protocol [context]");
System.err.println();
System.err.println("Where:");
System.err.println(" host is the repository hostname.");
System.err.println(" port is the repository port number.");
System.err.println(" user is the id of the repository user.");
System.err.println(" password is the password of repository user.");
System.err.println(" pid | ftyps is the id of the object to export from the source repository OR the types of objects.");
System.err.println(" format is the XML format to export ");
System.err.println(" ('" + FOXML1_1.uri + "',");
System.err.println(" '" + FOXML1_0.uri + "',");
System.err.println(" '" + METS_EXT1_1.uri + "',");
System.err.println(" '" + METS_EXT1_0.uri + "',");
System.err.println(" '" + ATOM1_1.uri + "',");
System.err.println(" '" + ATOM_ZIP1_1.uri + "',");
System.err.println(" or 'default')");
System.err.println(" econtext is the export context (which indicates what use case");
System.err.println(" the output should be prepared for.");
System.err.println(" ('public', 'migrate', 'archive' or 'default')");
System.err.println(" path is the directory to export the object.");
System.err.println(" protocol is the how to connect to repository, either http or https.");
System.err.println(" context is an optional parameter for specifying the context name under ");
System.err.println(" which the Fedora server is deployed. The default is fedora.");
System.err.println();
System.err.println("Examples:");
System.err.println("fedora-export myrepo.com:8443 user pw demo:1 "
+ FOXML1_1.uri + " migrate . https");
System.err.println();
System.err.println(" Exports demo:1 for migration in FOXML format ");
System.err.println(" using the secure https protocol (SSL).");
System.err.println(" (from myrepo.com:80 to the current directory).");
System.err.println();
System.err.println("fedora-export myrepo.com:80 user pw DMO default default /tmp/fedoradump http");
System.err.println();
System.err.println(" Exports all objects in the default export format and context ");
System.err.println(" (from myrepo.com:80 to directory /tmp/fedoradump).");
System.err.println();
System.err.println("fedora-export myrepo.com:80 user pw DMO default default /tmp/fedoradump http my-fedora");
System.err.println();
System.err.println(" Exports all objects in the default export format and context ");
System.err.println(" (from myrepo.com:80 to directory /tmp/fedoradump).");
System.err.println(" from a Fedora server running under http://myrepo:80/my-fedora instead of http://myrepo:80/fedora ");
System.err.println();
System.err.println("ERROR : " + msg);
System.exit(1);
}
/**
* Command-line interface for doing exports.
*/
public static void main(String[] args) {
System.setProperty("java.awt.headless", "true");
try {
// USAGE: fedora-export host:port user password pid|ftyps format econtext path protocol [context]
if (args.length < 8 || args.length > 9) {
Export.badArgs("Wrong number of arguments.");
}
String[] hp = args[0].split(":");
if (hp.length != 2) {
Export.badArgs("First arg must be of the form 'host:port'");
}
//SDP - HTTPS
String protocol = args[7];
if (!protocol.equals("http") && !protocol.equals("https")) {
Export.badArgs("protocol arg must be 'http' or 'https'");
}
String context = Constants.FEDORA_DEFAULT_APP_CONTEXT;
if (args.length == 9 && !args[8].equals("")) {
context = args[8];
}
// ******************************************
// NEW: use new client utility class
String baseURL =
protocol + "://" + hp[0] + ":" + Integer.parseInt(hp[1])
+ "/" + context;
FedoraClient fc = new FedoraClient(baseURL, args[1], args[2]);
FedoraAPIAMTOM sourceRepoAPIA = fc.getAPIAMTOM();
FedoraAPIMMTOM sourceRepoAPIM = fc.getAPIMMTOM();
fc.shutdown();
//*******************************************
String exportFormat = args[4];
String exportContext = args[5];
if (!exportFormat.equals(FOXML1_1.uri)
&& !exportFormat.equals(FOXML1_0.uri)
&& !exportFormat.equals(METS_EXT1_1.uri)
&& !exportFormat.equals(METS_EXT1_0.uri)
&& !exportFormat.equals(ATOM1_1.uri)
&& !exportFormat.equals(ATOM_ZIP1_1.uri)
&& !exportFormat.equals("default")) {
Export.badArgs(exportFormat + " is not a valid export format.");
}
if (!exportContext.equals("public")
&& !exportContext.equals("migrate")
&& !exportContext.equals("archive")
&& !exportContext.equals("default")) {
Export
.badArgs("econtext arg must be 'public', 'migrate', 'archive', or 'default'");
}
RepositoryInfo repoinfo = sourceRepoAPIA.describeRepository();
StringTokenizer stoken =
new StringTokenizer(repoinfo.getRepositoryVersion(), ".");
int majorVersion = new Integer(stoken.nextToken()).intValue();
if (majorVersion < 2 // pre-2.0 repo
&& !exportFormat.equals(METS_EXT1_0.uri)
&& !exportFormat.equals("default")) {
Export.badArgs("format arg must be '" + METS_EXT1_0.uri
+ "' or 'default' for pre-2.0 repository.");
}
if (exportFormat.equals("default")) {
exportFormat = null;
}
if (exportContext.equals("default")) {
exportContext = null;
}
if (args[3].indexOf(":") == -1) {
// assume args[3] is FTYPS... so multi-export
int count =
Export.multi(sourceRepoAPIA,
sourceRepoAPIM,
exportFormat,
exportContext,
//args[4], // format
//args[5], // export context
new File(args[6])); // path
System.out.print("Exported " + count + " objects.");
} else {
// assume args[3] is a PID...they only want to export one object
Export.one(sourceRepoAPIA, sourceRepoAPIM, args[3], // PID
exportFormat,
exportContext,
//args[4], // format
//args[5], // export context
new File(args[6])); // path
System.out.println("Exported " + args[3]);
}
} catch (Exception e) {
System.err.print("Error : " + e);
if (e.getMessage() == null) {
e.printStackTrace();
} else {
System.err.print(e.getMessage());
}
}
}
}