510Connectbot: src/ch/ethz/ssh2/SFTPv3Client.java annotate

annotate src/ch/ethz/ssh2/SFTPv3Client.java @ 297:c1f929cb3dd0 ganymed

start conversion from trilead to ganymed

author	Carl Byington <carl@five-ten-sg.com>
date	Tue, 29 Jul 2014 16:43:12 -0700
parents	91a31873c42a
children	d2b303406d63

rev	line source
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	1 /*
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	2 * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	3 * Please refer to the LICENSE.txt for licensing details.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	4 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	5 package ch.ethz.ssh2;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	6
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	7 import java.io.IOException;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	8 import java.util.ArrayList;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	9 import java.util.List;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	10
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	11 import ch.ethz.ssh2.log.Logger;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	12 import ch.ethz.ssh2.packets.TypesReader;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	13 import ch.ethz.ssh2.packets.TypesWriter;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	14 import ch.ethz.ssh2.sftp.ErrorCodes;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	15 import ch.ethz.ssh2.sftp.Packet;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	16
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	17 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	18 * A <code>SFTPv3Client</code> represents a SFTP (protocol version 3)
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	19 * client connection tunnelled over a SSH-2 connection. This is a very simple
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	20 * (synchronous) implementation.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	21 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	22 * Basically, most methods in this class map directly to one of
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	23 * the packet types described in draft-ietf-secsh-filexfer-02.txt.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	24 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	25 * Note: this is experimental code.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	26 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	27 * Error handling: the methods of this class throw IOExceptions. However, unless
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	28 * there is catastrophic failure, exceptions of the type {@link SFTPv3Client} will
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	29 * be thrown (a subclass of IOException). Therefore, you can implement more verbose
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	30 * behavior by checking if a thrown exception if of this type. If yes, then you
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	31 * can cast the exception and access detailed information about the failure.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	32 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	33 * Notes about file names, directory names and paths, copy-pasted
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	34 * from the specs:
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	35 * <ul>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	36 * <li>SFTP v3 represents file names as strings. File names are
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	37 * assumed to use the slash ('/') character as a directory separator.</li>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	38 * <li>File names starting with a slash are "absolute", and are relative to
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	39 * the root of the file system. Names starting with any other character
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	40 * are relative to the user's default directory (home directory).</li>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	41 * <li>Servers SHOULD interpret a path name component ".." as referring to
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	42 * the parent directory, and "." as referring to the current directory.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	43 * If the server implementation limits access to certain parts of the
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	44 * file system, it must be extra careful in parsing file names when
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	45 * enforcing such restrictions. There have been numerous reported
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	46 * security bugs where a ".." in a path name has allowed access outside
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	47 * the intended area.</li>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	48 * <li>An empty path name is valid, and it refers to the user's default
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	49 * directory (usually the user's home directory).</li>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	50 * </ul>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	51 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	52 * If you are still not tired then please go on and read the comment for
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	53 * {@link #setCharset(String)}.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	54 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	55 * @author Christian Plattner, plattner@inf.ethz.ch
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	56 * @version $Id: SFTPv3Client.java 133 2014-04-14 12:26:29Z dkocher@sudo.ch $
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	57 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	58 public class SFTPv3Client extends AbstractSFTPClient {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	59 private static final Logger log = Logger.getLogger(SFTPv3Client.class);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	60
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	61 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	62 * Open the file for reading.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	63 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	64 public static final int SSH_FXF_READ = 0x00000001;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	65 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	66 * Open the file for writing. If both this and SSH_FXF_READ are
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	67 * specified, the file is opened for both reading and writing.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	68 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	69 public static final int SSH_FXF_WRITE = 0x00000002;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	70 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	71 * Force all writes to append data at the end of the file.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	72 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	73 public static final int SSH_FXF_APPEND = 0x00000004;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	74 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	75 * If this flag is specified, then a new file will be created if one
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	76 * does not alread exist (if O_TRUNC is specified, the new file will
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	77 * be truncated to zero length if it previously exists).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	78 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	79 public static final int SSH_FXF_CREAT = 0x00000008;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	80 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	81 * Forces an existing file with the same name to be truncated to zero
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	82 * length when creating a file by specifying SSH_FXF_CREAT.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	83 * SSH_FXF_CREAT MUST also be specified if this flag is used.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	84 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	85 public static final int SSH_FXF_TRUNC = 0x00000010;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	86 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	87 * Causes the request to fail if the named file already exists.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	88 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	89 public static final int SSH_FXF_EXCL = 0x00000020;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	90
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	91 private PacketListener listener;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	92
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	93 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	94 * Create a SFTP v3 client.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	95 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	96 * @param conn The underlying SSH-2 connection to be used.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	97 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	98 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	99 public SFTPv3Client(Connection conn) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	100 this(conn, new PacketListener() {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	101 public void read(String packet) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	102 log.debug("Read packet " + packet);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	103 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	104
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	105 public void write(String packet) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	106 log.debug("Write packet " + packet);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	107 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	108 });
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	109 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	110
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	111 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	112 * Create a SFTP v3 client.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	113 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	114 * @param conn The underlying SSH-2 connection to be used.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	115 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	116 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	117 public SFTPv3Client(Connection conn, PacketListener listener) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	118 super(conn, 3, listener);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	119 this.listener = listener;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	120 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	121
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	122 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	123 public SFTPv3FileAttributes fstat(SFTPFileHandle handle) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	124 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	125
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	126 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	127 tw.writeString(handle.getHandle(), 0, handle.getHandle().length);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	128
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	129 sendMessage(Packet.SSH_FXP_FSTAT, req_id, tw.getBytes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	130
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	131 byte[] resp = receiveMessage(34000);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	132
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	133 TypesReader tr = new TypesReader(resp);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	134
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	135 int t = tr.readByte();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	136 listener.read(Packet.forName(t));
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	137
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	138 int rep_id = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	139 if(rep_id != req_id) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	140 throw new RequestMismatchException();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	141 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	142
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	143 if(t == Packet.SSH_FXP_ATTRS) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	144 return new SFTPv3FileAttributes(tr);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	145 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	146
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	147 if(t != Packet.SSH_FXP_STATUS) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	148 throw new PacketTypeException(t);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	149 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	150
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	151 int errorCode = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	152 String errorMessage = tr.readString();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	153 listener.read(errorMessage);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	154 throw new SFTPException(errorMessage, errorCode);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	155 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	156
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	157 private SFTPv3FileAttributes statBoth(String path, int statMethod) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	158 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	159
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	160 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	161 tw.writeString(path, this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	162
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	163 sendMessage(statMethod, req_id, tw.getBytes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	164
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	165 byte[] resp = receiveMessage(34000);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	166
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	167 TypesReader tr = new TypesReader(resp);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	168
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	169 int t = tr.readByte();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	170 listener.read(Packet.forName(t));
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	171
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	172 int rep_id = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	173 if(rep_id != req_id) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	174 throw new RequestMismatchException();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	175 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	176
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	177 if(t == Packet.SSH_FXP_ATTRS) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	178 return new SFTPv3FileAttributes(tr);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	179 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	180
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	181 if(t != Packet.SSH_FXP_STATUS) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	182 throw new PacketTypeException(t);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	183 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	184
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	185 int errorCode = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	186 String errorMessage = tr.readString();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	187 listener.read(errorMessage);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	188 throw new SFTPException(errorMessage, errorCode);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	189 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	190
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	191 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	192 public SFTPv3FileAttributes stat(String path) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	193 return statBoth(path, Packet.SSH_FXP_STAT);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	194 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	195
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	196 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	197 public SFTPv3FileAttributes lstat(String path) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	198 return statBoth(path, Packet.SSH_FXP_LSTAT);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	199 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	200
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	201
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	202 private List<SFTPv3DirectoryEntry> scanDirectory(byte[] handle) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	203 List<SFTPv3DirectoryEntry> files = new ArrayList<SFTPv3DirectoryEntry>();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	204
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	205 while(true) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	206 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	207
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	208 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	209 tw.writeString(handle, 0, handle.length);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	210
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	211 sendMessage(Packet.SSH_FXP_READDIR, req_id, tw.getBytes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	212
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	213 byte[] resp = receiveMessage(34000);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	214
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	215 TypesReader tr = new TypesReader(resp);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	216
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	217 int t = tr.readByte();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	218 listener.read(Packet.forName(t));
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	219
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	220 int rep_id = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	221 if(rep_id != req_id) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	222 throw new RequestMismatchException();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	223 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	224
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	225 if(t == Packet.SSH_FXP_NAME) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	226 int count = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	227 if(log.isDebugEnabled()) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	228 log.debug(String.format("Parsing %d name entries", count));
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	229 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	230 while(count > 0) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	231 SFTPv3DirectoryEntry file = new SFTPv3DirectoryEntry();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	232 file.filename = tr.readString(this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	233 file.longEntry = tr.readString(this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	234 listener.read(file.longEntry);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	235 file.attributes = new SFTPv3FileAttributes(tr);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	236 if(log.isDebugEnabled()) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	237 log.debug(String.format("Adding file %s", file));
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	238 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	239 files.add(file);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	240 count--;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	241 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	242 continue;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	243 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	244
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	245 if(t != Packet.SSH_FXP_STATUS) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	246 throw new PacketTypeException(t);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	247 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	248
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	249 int errorCode = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	250
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	251 if(errorCode == ErrorCodes.SSH_FX_EOF) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	252 return files;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	253 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	254 String errorMessage = tr.readString();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	255 listener.read(errorMessage);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	256 throw new SFTPException(errorMessage, errorCode);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	257 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	258 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	259
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	260 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	261 public final SFTPv3FileHandle openDirectory(String path) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	262 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	263
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	264 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	265 tw.writeString(path, this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	266
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	267 sendMessage(Packet.SSH_FXP_OPENDIR, req_id, tw.getBytes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	268
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	269 byte[] resp = receiveMessage(34000);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	270
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	271 TypesReader tr = new TypesReader(resp);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	272
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	273 int t = tr.readByte();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	274 listener.read(Packet.forName(t));
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	275
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	276 int rep_id = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	277 if(rep_id != req_id) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	278 throw new RequestMismatchException();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	279 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	280
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	281 if(t == Packet.SSH_FXP_HANDLE) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	282 return new SFTPv3FileHandle(this, tr.readByteString());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	283 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	284
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	285 if(t != Packet.SSH_FXP_STATUS) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	286 throw new PacketTypeException(t);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	287 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	288
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	289 int errorCode = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	290 String errorMessage = tr.readString();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	291 listener.read(errorMessage);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	292 throw new SFTPException(errorMessage, errorCode);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	293 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	294
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	295 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	296 * List the contents of a directory.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	297 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	298 * @param dirName See the {@link SFTPv3Client comment} for the class for more details.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	299 * @return A Vector containing {@link SFTPv3DirectoryEntry} objects.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	300 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	301 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	302 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	303 public List<SFTPv3DirectoryEntry> ls(String dirName) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	304 SFTPv3FileHandle handle = openDirectory(dirName);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	305 List<SFTPv3DirectoryEntry> result = scanDirectory(handle.getHandle());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	306 closeFile(handle);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	307 return result;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	308 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	309
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	310 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	311 * Open a file for reading.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	312 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	313 * @param filename See the {@link SFTPv3Client comment} for the class for more details.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	314 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	315 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	316 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	317 public SFTPv3FileHandle openFileRO(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	318 return openFile(filename, SSH_FXF_READ, new SFTPv3FileAttributes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	319 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	320
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	321 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	322 * Open a file for reading and writing.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	323 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	324 * @param filename See the {@link SFTPv3Client comment} for the class for more details.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	325 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	326 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	327 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	328 public SFTPv3FileHandle openFileRW(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	329 return openFile(filename, SSH_FXF_READ \| SSH_FXF_WRITE, new SFTPv3FileAttributes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	330 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	331
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	332 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	333 * Open a file in append mode. The SFTP v3 draft says nothing but assuming normal POSIX
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	334 * behavior, all writes will be appendend to the end of the file, no matter which offset
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	335 * one specifies.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	336 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	337 * A side note for the curious: OpenSSH does an lseek() to the specified writing offset before each write(),
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	338 * even for writes to files opened in O_APPEND mode. However, bear in mind that when working
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	339 * in the O_APPEND mode, each write() includes an implicit lseek() to the end of the file
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	340 * (well, this is what the newsgroups say).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	341 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	342 * @param filename See the {@link SFTPv3Client comment} for the class for more details.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	343 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	344 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	345 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	346 public SFTPv3FileHandle openFileRWAppend(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	347 return openFile(filename, SSH_FXF_READ \| SSH_FXF_WRITE \| SSH_FXF_APPEND, new SFTPv3FileAttributes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	348 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	349
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	350 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	351 * Open a file in append mode. The SFTP v3 draft says nothing but assuming normal POSIX
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	352 * behavior, all writes will be appendend to the end of the file, no matter which offset
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	353 * one specifies.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	354 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	355 * A side note for the curious: OpenSSH does an lseek() to the specified writing offset before each write(),
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	356 * even for writes to files opened in O_APPEND mode. However, bear in mind that when working
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	357 * in the O_APPEND mode, each write() includes an implicit lseek() to the end of the file
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	358 * (well, this is what the newsgroups say).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	359 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	360 * @param filename See the {@link SFTPv3Client comment} for the class for more details.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	361 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	362 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	363 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	364 public SFTPv3FileHandle openFileWAppend(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	365 return openFile(filename, SSH_FXF_WRITE \| SSH_FXF_APPEND, new SFTPv3FileAttributes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	366 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	367
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	368 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	369 public SFTPv3FileHandle createFile(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	370 return createFile(filename, new SFTPv3FileAttributes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	371 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	372
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	373 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	374 public SFTPv3FileHandle createFile(String filename, SFTPFileAttributes attr) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	375 return openFile(filename, SSH_FXF_CREAT \| SSH_FXF_READ \| SSH_FXF_WRITE, attr);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	376 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	377
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	378 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	379 * Create a file (truncate it if it already exists) and open it for writing.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	380 * Same as {@link #createFileTruncate(String, SFTPFileAttributes) createFileTruncate(filename, null)}.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	381 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	382 * @param filename See the {@link SFTPv3Client comment} for the class for more details.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	383 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	384 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	385 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	386 public SFTPv3FileHandle createFileTruncate(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	387 return createFileTruncate(filename, new SFTPv3FileAttributes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	388 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	389
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	390 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	391 * reate a file (truncate it if it already exists) and open it for writing.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	392 * You can specify the default attributes of the file (the server may or may
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	393 * not respect your wishes).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	394 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	395 * @param filename See the {@link SFTPv3Client comment} for the class for more details.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	396 * @param attr may be <code>null</code> to use server defaults. Probably only
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	397 * the <code>uid</code>, <code>gid</code> and <code>permissions</code>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	398 * (remember the server may apply a umask) entries of the {@link SFTPv3FileHandle}
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	399 * structure make sense. You need only to set those fields where you want
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	400 * to override the server's defaults.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	401 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	402 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	403 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	404 public SFTPv3FileHandle createFileTruncate(String filename, SFTPFileAttributes attr) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	405 return openFile(filename, SSH_FXF_CREAT \| SSH_FXF_TRUNC \| SSH_FXF_WRITE, attr);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	406 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	407
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	408 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	409 public SFTPv3FileHandle openFile(String filename, int flags) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	410 return openFile(filename, flags, new SFTPv3FileAttributes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	411 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	412
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	413 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	414 public SFTPv3FileHandle openFile(String filename, int flags, SFTPFileAttributes attr) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	415 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	416
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	417 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	418 tw.writeString(filename, this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	419 tw.writeUINT32(flags);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	420
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	421 tw.writeBytes(attr.toBytes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	422
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	423 sendMessage(Packet.SSH_FXP_OPEN, req_id, tw.getBytes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	424
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	425 byte[] resp = receiveMessage(34000);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	426
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	427 TypesReader tr = new TypesReader(resp);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	428
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	429 int t = tr.readByte();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	430 listener.read(Packet.forName(t));
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	431
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	432 int rep_id = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	433 if(rep_id != req_id) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	434 throw new RequestMismatchException();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	435 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	436
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	437 if(t == Packet.SSH_FXP_HANDLE) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	438 return new SFTPv3FileHandle(this, tr.readByteString());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	439 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	440
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	441 if(t != Packet.SSH_FXP_STATUS) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	442 throw new PacketTypeException(t);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	443 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	444
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	445 int errorCode = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	446 String errorMessage = tr.readString();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	447 listener.read(errorMessage);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	448 throw new SFTPException(errorMessage, errorCode);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	449 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	450
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	451 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	452 public void createSymlink(String src, String target) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	453 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	454
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	455 // Changed semantics of src and target. The bug is known on SFTP servers shipped with all
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	456 // versions of OpenSSH (Bug #861).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	457 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	458 tw.writeString(target, this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	459 tw.writeString(src, this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	460
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	461 sendMessage(Packet.SSH_FXP_SYMLINK, req_id, tw.getBytes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	462
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	463 expectStatusOKMessage(req_id);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	464 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	465 }

Mercurial > 510Connectbot

annotate src/ch/ethz/ssh2/SFTPv3Client.java @ 297:c1f929cb3dd0 ganymed