| /** |
| * 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 org.apache.hadoop.fs.shell; |
| |
| import java.io.File; |
| import java.io.IOException; |
| import java.util.LinkedList; |
| import java.util.List; |
| |
| import org.apache.hadoop.classification.InterfaceAudience; |
| import org.apache.hadoop.classification.InterfaceStability; |
| import org.apache.hadoop.fs.FSDataInputStream; |
| import org.apache.hadoop.fs.FSDataOutputStream; |
| import org.apache.hadoop.fs.PathIsDirectoryException; |
| import org.apache.hadoop.io.IOUtils; |
| |
| /** Various commands for copy files */ |
| @InterfaceAudience.Private |
| @InterfaceStability.Evolving |
| |
| class CopyCommands { |
| public static void registerCommands(CommandFactory factory) { |
| factory.addClass(Merge.class, "-getmerge"); |
| factory.addClass(Cp.class, "-cp"); |
| factory.addClass(CopyFromLocal.class, "-copyFromLocal"); |
| factory.addClass(CopyToLocal.class, "-copyToLocal"); |
| factory.addClass(Get.class, "-get"); |
| factory.addClass(Put.class, "-put"); |
| } |
| |
| /** merge multiple files together */ |
| public static class Merge extends FsCommand { |
| public static final String NAME = "getmerge"; |
| public static final String USAGE = "[-nl] <src> <localdst>"; |
| public static final String DESCRIPTION = |
| "Get all the files in the directories that\n" + |
| "match the source file pattern and merge and sort them to only\n" + |
| "one file on local fs. <src> is kept.\n" + |
| " -nl Add a newline character at the end of each file."; |
| |
| protected PathData dst = null; |
| protected String delimiter = null; |
| protected List<PathData> srcs = null; |
| |
| @Override |
| protected void processOptions(LinkedList<String> args) throws IOException { |
| CommandFormat cf = new CommandFormat(2, Integer.MAX_VALUE, "nl"); |
| cf.parse(args); |
| |
| delimiter = cf.getOpt("nl") ? "\n" : null; |
| |
| dst = new PathData(new File(args.removeLast()), getConf()); |
| if (dst.exists && dst.stat.isDirectory()) { |
| throw new PathIsDirectoryException(dst.toString()); |
| } |
| srcs = new LinkedList<PathData>(); |
| } |
| |
| @Override |
| protected void processArguments(LinkedList<PathData> items) |
| throws IOException { |
| super.processArguments(items); |
| if (exitCode != 0) { // check for error collecting paths |
| return; |
| } |
| FSDataOutputStream out = dst.fs.create(dst.path); |
| try { |
| for (PathData src : srcs) { |
| FSDataInputStream in = src.fs.open(src.path); |
| try { |
| IOUtils.copyBytes(in, out, getConf(), false); |
| if (delimiter != null) { |
| out.write(delimiter.getBytes("UTF-8")); |
| } |
| } finally { |
| in.close(); |
| } |
| } |
| } finally { |
| out.close(); |
| } |
| } |
| |
| @Override |
| protected void processNonexistentPath(PathData item) throws IOException { |
| exitCode = 1; // flag that a path is bad |
| super.processNonexistentPath(item); |
| } |
| |
| // this command is handled a bit differently than others. the paths |
| // are batched up instead of actually being processed. this avoids |
| // unnecessarily streaming into the merge file and then encountering |
| // a path error that should abort the merge |
| |
| @Override |
| protected void processPath(PathData src) throws IOException { |
| // for directories, recurse one level to get its files, else skip it |
| if (src.stat.isDirectory()) { |
| if (getDepth() == 0) { |
| recursePath(src); |
| } // skip subdirs |
| } else { |
| srcs.add(src); |
| } |
| } |
| } |
| |
| static class Cp extends CommandWithDestination { |
| public static final String NAME = "cp"; |
| public static final String USAGE = "<src> ... <dst>"; |
| public static final String DESCRIPTION = |
| "Copy files that match the file pattern <src> to a\n" + |
| "destination. When copying multiple files, the destination\n" + |
| "must be a directory."; |
| |
| @Override |
| protected void processOptions(LinkedList<String> args) throws IOException { |
| CommandFormat cf = new CommandFormat(2, Integer.MAX_VALUE, "f"); |
| cf.parse(args); |
| setOverwrite(cf.getOpt("f")); |
| // should have a -r option |
| setRecursive(true); |
| getRemoteDestination(args); |
| } |
| } |
| |
| /** |
| * Copy local files to a remote filesystem |
| */ |
| public static class Get extends CommandWithDestination { |
| public static final String NAME = "get"; |
| public static final String USAGE = |
| "[-ignoreCrc] [-crc] <src> ... <localdst>"; |
| public static final String DESCRIPTION = |
| "Copy files that match the file pattern <src>\n" + |
| "to the local name. <src> is kept. When copying multiple,\n" + |
| "files, the destination must be a directory."; |
| |
| @Override |
| protected void processOptions(LinkedList<String> args) |
| throws IOException { |
| CommandFormat cf = new CommandFormat( |
| 1, Integer.MAX_VALUE, "crc", "ignoreCrc"); |
| cf.parse(args); |
| setWriteChecksum(cf.getOpt("crc")); |
| setVerifyChecksum(!cf.getOpt("ignoreCrc")); |
| setRecursive(true); |
| getLocalDestination(args); |
| } |
| } |
| |
| /** |
| * Copy local files to a remote filesystem |
| */ |
| public static class Put extends CommandWithDestination { |
| public static final String NAME = "put"; |
| public static final String USAGE = "<localsrc> ... <dst>"; |
| public static final String DESCRIPTION = |
| "Copy files from the local file system\n" + |
| "into fs."; |
| |
| @Override |
| protected void processOptions(LinkedList<String> args) throws IOException { |
| CommandFormat cf = new CommandFormat(1, Integer.MAX_VALUE, "f"); |
| cf.parse(args); |
| setOverwrite(cf.getOpt("f")); |
| getRemoteDestination(args); |
| // should have a -r option |
| setRecursive(true); |
| } |
| |
| // commands operating on local paths have no need for glob expansion |
| @Override |
| protected List<PathData> expandArgument(String arg) throws IOException { |
| List<PathData> items = new LinkedList<PathData>(); |
| items.add(new PathData(new File(arg), getConf())); |
| return items; |
| } |
| |
| @Override |
| protected void processArguments(LinkedList<PathData> args) |
| throws IOException { |
| // NOTE: this logic should be better, mimics previous implementation |
| if (args.size() == 1 && args.get(0).toString().equals("-")) { |
| copyStreamToTarget(System.in, getTargetPath(args.get(0))); |
| return; |
| } |
| super.processArguments(args); |
| } |
| } |
| |
| public static class CopyFromLocal extends Put { |
| public static final String NAME = "copyFromLocal"; |
| public static final String USAGE = Put.USAGE; |
| public static final String DESCRIPTION = "Identical to the -put command."; |
| } |
| |
| public static class CopyToLocal extends Get { |
| public static final String NAME = "copyToLocal"; |
| public static final String USAGE = Get.USAGE; |
| public static final String DESCRIPTION = "Identical to the -get command."; |
| } |
| } |