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

annotate src/ch/ethz/ssh2/SFTPv3Client.java @ 407:85bf5f9c7983

bump version number

author	Carl Byington <carl@five-ten-sg.com>
date	Fri, 24 Oct 2014 14:24:19 -0700
parents	071eccdff8ea
children

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 public void write(String packet) {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	105 log.debug("Write packet " + packet);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	106 }
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 * Create a SFTP v3 client.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	112 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	113 * @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	114 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	115 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	116 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	117 super(conn, 3, listener);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	118 this.listener = listener;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	119 }
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 public SFTPv3FileAttributes fstat(SFTPFileHandle handle) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	122 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	123 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	124 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	125 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	126 byte[] resp = receiveMessage(34000);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	127 TypesReader tr = new TypesReader(resp);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	128 int t = tr.readByte();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	129 listener.read(Packet.forName(t));
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	130 int rep_id = tr.readUINT32();
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	131
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	132 if (rep_id != req_id) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	133 throw new RequestMismatchException();
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
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	136 if (t == Packet.SSH_FXP_ATTRS) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	137 return new SFTPv3FileAttributes(tr);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	138 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	139
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	140 if (t != Packet.SSH_FXP_STATUS) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	141 throw new PacketTypeException(t);
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
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	144 int errorCode = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	145 String errorMessage = tr.readString();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	146 listener.read(errorMessage);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	147 throw new SFTPException(errorMessage, errorCode);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	148 }
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 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	151 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	152 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	153 tw.writeString(path, this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	154 sendMessage(statMethod, req_id, tw.getBytes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	155 byte[] resp = receiveMessage(34000);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	156 TypesReader tr = new TypesReader(resp);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	157 int t = tr.readByte();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	158 listener.read(Packet.forName(t));
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	159 int rep_id = tr.readUINT32();
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	160
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	161 if (rep_id != req_id) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	162 throw new RequestMismatchException();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	163 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	164
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	165 if (t == Packet.SSH_FXP_ATTRS) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	166 return new SFTPv3FileAttributes(tr);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	167 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	168
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	169 if (t != Packet.SSH_FXP_STATUS) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	170 throw new PacketTypeException(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
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	173 int errorCode = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	174 String errorMessage = tr.readString();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	175 listener.read(errorMessage);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	176 throw new SFTPException(errorMessage, errorCode);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	177 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	178
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	179 public SFTPv3FileAttributes stat(String path) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	180 return statBoth(path, Packet.SSH_FXP_STAT);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	181 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	182
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	183 public SFTPv3FileAttributes lstat(String path) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	184 return statBoth(path, Packet.SSH_FXP_LSTAT);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	185 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	186
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	187
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	188 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	189 List<SFTPv3DirectoryEntry> files = new ArrayList<SFTPv3DirectoryEntry>();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	190
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	191 while (true) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	192 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	193 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	194 tw.writeString(handle, 0, handle.length);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	195 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	196 byte[] resp = receiveMessage(34000);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	197 TypesReader tr = new TypesReader(resp);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	198 int t = tr.readByte();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	199 listener.read(Packet.forName(t));
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	200 int rep_id = tr.readUINT32();
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	201
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	202 if (rep_id != req_id) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	203 throw new RequestMismatchException();
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
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	206 if (t == Packet.SSH_FXP_NAME) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	207 int count = tr.readUINT32();
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	208
071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	209 if (log.isDebugEnabled()) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	210 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	211 }
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	212
071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	213 while (count > 0) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	214 SFTPv3DirectoryEntry file = new SFTPv3DirectoryEntry();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	215 file.filename = tr.readString(this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	216 file.longEntry = tr.readString(this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	217 listener.read(file.longEntry);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	218 file.attributes = new SFTPv3FileAttributes(tr);
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	219
071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	220 if (log.isDebugEnabled()) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	221 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	222 }
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	223
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	224 files.add(file);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	225 count--;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	226 }
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	227
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	228 continue;
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
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	231 if (t != Packet.SSH_FXP_STATUS) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	232 throw new PacketTypeException(t);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	233 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	234
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	235 int errorCode = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	236
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	237 if (errorCode == ErrorCodes.SSH_FX_EOF) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	238 return files;
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	239 }
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	240
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	241 String errorMessage = tr.readString();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	242 listener.read(errorMessage);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	243 throw new SFTPException(errorMessage, errorCode);
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 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	246
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	247 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	248 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	249 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	250 tw.writeString(path, this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	251 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	252 byte[] resp = receiveMessage(34000);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	253 TypesReader tr = new TypesReader(resp);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	254 int t = tr.readByte();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	255 listener.read(Packet.forName(t));
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	256 int rep_id = tr.readUINT32();
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	257
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	258 if (rep_id != req_id) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	259 throw new RequestMismatchException();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	260 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	261
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	262 if (t == Packet.SSH_FXP_HANDLE) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	263 return new SFTPv3FileHandle(this, tr.readByteString());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	264 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	265
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	266 if (t != Packet.SSH_FXP_STATUS) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	267 throw new PacketTypeException(t);
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
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	270 int errorCode = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	271 String errorMessage = tr.readString();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	272 listener.read(errorMessage);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	273 throw new SFTPException(errorMessage, errorCode);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	274 }
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 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	277 * List the contents of a directory.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	278 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	279 * @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	280 * @return A Vector containing {@link SFTPv3DirectoryEntry} objects.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	281 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	282 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	283 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	284 SFTPv3FileHandle handle = openDirectory(dirName);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	285 List<SFTPv3DirectoryEntry> result = scanDirectory(handle.getHandle());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	286 closeFile(handle);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	287 return result;
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
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	290 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	291 * Open a file for reading.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	292 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	293 * @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	294 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	295 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	296 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	297 public SFTPv3FileHandle openFileRO(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	298 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	299 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	300
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 * Open a file for reading and writing.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	303 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	304 * @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	305 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	306 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	307 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	308 public SFTPv3FileHandle openFileRW(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	309 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	310 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	311
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 * 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	314 * 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	315 * one specifies.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	316 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	317 * 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	318 * 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	319 * 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	320 * (well, this is what the newsgroups say).
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 * @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	323 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	324 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	325 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	326 public SFTPv3FileHandle openFileRWAppend(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	327 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	328 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	329
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 * 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	332 * 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	333 * one specifies.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	334 * <p/>
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	335 * 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	336 * 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	337 * 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	338 * (well, this is what the newsgroups say).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	339 *
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	340 * @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	341 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	342 * @throws IOException
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	343 */
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	344 public SFTPv3FileHandle openFileWAppend(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	345 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	346 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	347
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	348 public SFTPv3FileHandle createFile(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	349 return createFile(filename, new SFTPv3FileAttributes());
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
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	352 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	353 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	354 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	355
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	356 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	357 * 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	358 * 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	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 createFileTruncate(String filename) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	365 return createFileTruncate(filename, 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 /**
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	369 * 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	370 * 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	371 * not respect your wishes).
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 * @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	374 * @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	375 * 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	376 * (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	377 * 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	378 * to override the server's defaults.
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	379 * @return a SFTPv3FileHandle handle
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	380 * @throws IOException
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 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	383 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	384 }
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 openFile(String filename, int flags) throws IOException {
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	387 return openFile(filename, flags, 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 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	391 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	392 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	393 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	394 tw.writeString(filename, this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	395 tw.writeUINT32(flags);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	396 tw.writeBytes(attr.toBytes());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	397 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	398 byte[] resp = receiveMessage(34000);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	399 TypesReader tr = new TypesReader(resp);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	400 int t = tr.readByte();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	401 listener.read(Packet.forName(t));
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	402 int rep_id = tr.readUINT32();
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	403
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	404 if (rep_id != req_id) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	405 throw new RequestMismatchException();
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
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	408 if (t == Packet.SSH_FXP_HANDLE) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	409 return new SFTPv3FileHandle(this, tr.readByteString());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	410 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	411
307 071eccdff8ea fix java formatting Carl Byington <carl@five-ten-sg.com> parents: 305 diff changeset	412 if (t != Packet.SSH_FXP_STATUS) {
273 91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	413 throw new PacketTypeException(t);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	414 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	415
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	416 int errorCode = tr.readUINT32();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	417 String errorMessage = tr.readString();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	418 listener.read(errorMessage);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	419 throw new SFTPException(errorMessage, errorCode);
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
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	422 @Override
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	423 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	424 int req_id = generateNextRequestID();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	425 // 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	426 // versions of OpenSSH (Bug #861).
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	427 TypesWriter tw = new TypesWriter();
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	428 tw.writeString(target, this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	429 tw.writeString(src, this.getCharset());
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	430 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	431 expectStatusOKMessage(req_id);
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	432 }
91a31873c42a start conversion from trilead to ganymed Carl Byington <carl@five-ten-sg.com> parents: diff changeset	433 }

Mercurial > 510Connectbot

annotate src/ch/ethz/ssh2/SFTPv3Client.java @ 407:85bf5f9c7983