/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.ftpserver.command;
import java.io.IOException;
import java.net.InetAddress;
import java.net.SocketException;
import org.apache.ftpserver.DefaultFtpReply;
import org.apache.ftpserver.IODataConnectionFactory;
import org.apache.ftpserver.ftplet.DataConnection;
import org.apache.ftpserver.ftplet.DataConnectionFactory;
import org.apache.ftpserver.ftplet.FtpException;
import org.apache.ftpserver.ftplet.FtpReply;
import org.apache.ftpserver.ftplet.FtpRequest;
import org.apache.ftpserver.interfaces.FtpIoSession;
import org.apache.ftpserver.interfaces.FtpServerContext;
import org.apache.ftpserver.listing.DirectoryLister;
import org.apache.ftpserver.listing.FileFormater;
import org.apache.ftpserver.listing.LISTFileFormater;
import org.apache.ftpserver.listing.ListArgument;
import org.apache.ftpserver.listing.ListArgumentParser;
import org.apache.ftpserver.listing.NLSTFileFormater;
import org.apache.ftpserver.util.FtpReplyUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* <code>NLST [<SP> <pathname>] <CRLF></code><br>
*
* This command causes a directory listing to be sent from
* server to user site. The pathname should specify a
* directory or other system-specific file group descriptor; a
* null argument implies the current directory. The server
* will return a stream of names of files and no other
* information.
*/
public
class NLST extends AbstractCommand {
private final Logger LOG = LoggerFactory.getLogger(NLST.class);
private static final NLSTFileFormater NLST_FILE_FORMATER = new NLSTFileFormater();
private static final LISTFileFormater LIST_FILE_FORMATER = new LISTFileFormater();
private DirectoryLister directoryLister = new DirectoryLister();
/**
* Execute command
*/
public void execute(final FtpIoSession session,
final FtpServerContext context,
final FtpRequest request) throws IOException, FtpException {
try {
// reset state
session.resetState();
// 24-10-2007 - added check if PORT or PASV is issued, see https://issues.apache.org/jira/browse/FTPSERVER-110
DataConnectionFactory connFactory = session.getDataConnection();
if (connFactory instanceof IODataConnectionFactory) {
InetAddress address = ((IODataConnectionFactory)connFactory).getInetAddress();
if (address == null) {
session.write(new DefaultFtpReply(FtpReply.REPLY_503_BAD_SEQUENCE_OF_COMMANDS, "PORT or PASV must be issued first"));
return;
}
}
// get data connection
session.write(FtpReplyUtil.translate(session, request, context, FtpReply.REPLY_150_FILE_STATUS_OKAY, "NLST", null));
// print listing data
DataConnection dataConnection;
try {
dataConnection = session.getDataConnection().openConnection();
} catch (Exception e) {
LOG.debug("Exception getting the output data stream", e);
session.write(FtpReplyUtil.translate(session, request, context, FtpReply.REPLY_425_CANT_OPEN_DATA_CONNECTION, "NLST", null));
return;
}
boolean failure = false;
try {
// parse argument
ListArgument parsedArg = ListArgumentParser.parse(request.getArgument());
FileFormater formater;
if(parsedArg.hasOption('l')) {
formater = LIST_FILE_FORMATER;
} else {
formater = NLST_FILE_FORMATER;
}
dataConnection.transferToClient(directoryLister.listFiles(parsedArg, session.getFileSystemView(), formater));
}
catch(SocketException ex) {
LOG.debug("Socket exception during data transfer", ex);
failure = true;
session.write(FtpReplyUtil.translate(session, request, context, FtpReply.REPLY_426_CONNECTION_CLOSED_TRANSFER_ABORTED, "NLST", null));
}
catch(IOException ex) {
LOG.debug("IOException during data transfer", ex);
failure = true;
session.write(FtpReplyUtil.translate(session, request, context, FtpReply.REPLY_551_REQUESTED_ACTION_ABORTED_PAGE_TYPE_UNKNOWN, "NLST", null));
} catch(IllegalArgumentException e) {
LOG.debug("Illegal listing syntax: " + request.getArgument(), e);
// if listing syntax error - send message
session.write(FtpReplyUtil.translate(session, request, context, FtpReply.REPLY_501_SYNTAX_ERROR_IN_PARAMETERS_OR_ARGUMENTS, "LIST", null));
}
// if data transfer ok - send transfer complete message
if(!failure) {
session.write(FtpReplyUtil.translate(session, request, context, FtpReply.REPLY_226_CLOSING_DATA_CONNECTION, "NLST", null));
}
}
finally {
session.getDataConnection().closeDataConnection();
}
}
}