This commit is contained in:
AriaLyy
2017-10-10 09:50:40 +08:00
132 changed files with 16174 additions and 16696 deletions

View File

@@ -23,7 +23,8 @@ dependencies {
testCompile 'junit:junit:4.12' testCompile 'junit:junit:4.12'
compile 'com.android.support:appcompat-v7:23.1.1' compile 'com.android.support:appcompat-v7:23.1.1'
compile project(':AriaAnnotations') compile project(':AriaAnnotations')
compile 'com.arialyy.aria:aria-ftp-plug:1.0.0' compile 'com.arialyy.aria:aria-ftp-plug:1.0.3'
// compile project(':AriaFtpPlug') // compile project(':AriaFtpPlug')
} }

View File

@@ -31,7 +31,7 @@ public class TaskManager {
private static volatile TaskManager INSTANCE = null; private static volatile TaskManager INSTANCE = null;
private Map<String, AbsTask> map = new ConcurrentHashMap<>(); private Map<String, AbsTask> map = new ConcurrentHashMap<>();
public TaskManager getInstance() { public static TaskManager getInstance() {
if (INSTANCE == null) { if (INSTANCE == null) {
synchronized (AriaManager.LOCK) { synchronized (AriaManager.LOCK) {
INSTANCE = new TaskManager(); INSTANCE = new TaskManager();

View File

@@ -16,10 +16,13 @@
package com.arialyy.aria.core.command.normal; package com.arialyy.aria.core.command.normal;
import android.text.TextUtils; import android.text.TextUtils;
import android.util.Log;
import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.download.DownloadTask; import com.arialyy.aria.core.download.DownloadTask;
import com.arialyy.aria.core.inf.AbsNormalTask; import com.arialyy.aria.core.inf.AbsNormalTask;
import com.arialyy.aria.core.inf.AbsTaskEntity; import com.arialyy.aria.core.inf.AbsTaskEntity;
import com.arialyy.aria.core.queue.DownloadTaskQueue; import com.arialyy.aria.core.queue.DownloadTaskQueue;
import com.arialyy.aria.util.NetUtils;
/** /**
* Created by lyy on 2017/6/2. * Created by lyy on 2017/6/2.
@@ -43,6 +46,10 @@ final class HighestPriorityCmd<T extends AbsTaskEntity> extends AbsNormalCmd<T>
@Override public void executeCmd() { @Override public void executeCmd() {
if (!canExeCmd) return; if (!canExeCmd) return;
if (!NetUtils.isConnected(AriaManager.APP)){
Log.w(TAG, "启动任务失败,网络未连接");
return;
}
DownloadTask task = (DownloadTask) getTask(); DownloadTask task = (DownloadTask) getTask();
if (task == null) { if (task == null) {
task = (DownloadTask) createTask(); task = (DownloadTask) createTask();

View File

@@ -28,39 +28,39 @@ public class NormalCmdFactory extends AbsCmdFactory<AbsTaskEntity, AbsNormalCmd>
/** /**
* 创建任务 * 创建任务
*/ */
public static final int TASK_CREATE = 0x122; public static final int TASK_CREATE = 0xb1;
/** /**
* 启动任务 * 启动任务
*/ */
public static final int TASK_START = 0x123; public static final int TASK_START = 0xb2;
/** /**
* 恢复任务 * 恢复任务
*/ */
public static final int TASK_RESUME = 0x127; public static final int TASK_RESUME = 0xb3;
/** /**
* 取消任务 * 取消任务
*/ */
public static final int TASK_CANCEL = 0x124; public static final int TASK_CANCEL = 0xb4;
/** /**
* 停止任务 * 停止任务
*/ */
public static final int TASK_STOP = 0x125; public static final int TASK_STOP = 0xb5;
/** /**
* 设置任务为最高优先级 * 设置任务为最高优先级
*/ */
public static final int TASK_HIGHEST_PRIORITY = 0x128; public static final int TASK_HIGHEST_PRIORITY = 0xb6;
/** /**
* 停止所有任务 * 停止所有任务
*/ */
public static final int TASK_STOP_ALL = 0x129; public static final int TASK_STOP_ALL = 0xb7;
/** /**
* 恢复所有停止的任务 * 恢复所有停止的任务
*/ */
public static final int TASK_RESUME_ALL = 0x130; public static final int TASK_RESUME_ALL = 0xb8;
/** /**
* 删除所有任务, * 删除所有任务,
*/ */
public static final int TASK_CANCEL_ALL = 0x131; public static final int TASK_CANCEL_ALL = 0xb9;
private static volatile NormalCmdFactory INSTANCE = null; private static volatile NormalCmdFactory INSTANCE = null;
private NormalCmdFactory() { private NormalCmdFactory() {

View File

@@ -1,5 +1,7 @@
package com.arialyy.aria.core.command.normal; package com.arialyy.aria.core.command.normal;
import android.util.Log;
import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.download.DownloadGroupTaskEntity; import com.arialyy.aria.core.download.DownloadGroupTaskEntity;
import com.arialyy.aria.core.download.DownloadTaskEntity; import com.arialyy.aria.core.download.DownloadTaskEntity;
import com.arialyy.aria.core.inf.AbsTaskEntity; import com.arialyy.aria.core.inf.AbsTaskEntity;
@@ -9,6 +11,7 @@ import com.arialyy.aria.core.queue.DownloadTaskQueue;
import com.arialyy.aria.core.queue.UploadTaskQueue; import com.arialyy.aria.core.queue.UploadTaskQueue;
import com.arialyy.aria.core.upload.UploadTaskEntity; import com.arialyy.aria.core.upload.UploadTaskEntity;
import com.arialyy.aria.orm.DbEntity; import com.arialyy.aria.orm.DbEntity;
import com.arialyy.aria.util.NetUtils;
import java.util.List; import java.util.List;
/** /**
@@ -26,6 +29,10 @@ final class ResumeAllCmd<T extends AbsTaskEntity> extends AbsNormalCmd<T> {
} }
@Override public void executeCmd() { @Override public void executeCmd() {
if (!NetUtils.isConnected(AriaManager.APP)) {
Log.w(TAG, "恢复任务失败,网络未连接");
return;
}
if (isDownloadCmd) { if (isDownloadCmd) {
resumeDownload(); resumeDownload();
} else { } else {
@@ -41,18 +48,22 @@ final class ResumeAllCmd<T extends AbsTaskEntity> extends AbsNormalCmd<T> {
DbEntity.findDatas(DownloadTaskEntity.class, "isGroupTask=?", "false"); DbEntity.findDatas(DownloadTaskEntity.class, "isGroupTask=?", "false");
if (dTaskEntity != null && !dTaskEntity.isEmpty()) { if (dTaskEntity != null && !dTaskEntity.isEmpty()) {
for (DownloadTaskEntity te : dTaskEntity) { for (DownloadTaskEntity te : dTaskEntity) {
if (te == null || te.getEntity() == null) continue;
int state = te.getState(); int state = te.getState();
if (state == IEntity.STATE_COMPLETE || state == IEntity.STATE_FAIL) continue; if (state == IEntity.STATE_STOP || state == IEntity.STATE_OTHER) {
resumeEntity(te); resumeEntity(te);
}
} }
} }
List<DownloadGroupTaskEntity> groupTask = DbEntity.findAllData(DownloadGroupTaskEntity.class); List<DownloadGroupTaskEntity> groupTask = DbEntity.findAllData(DownloadGroupTaskEntity.class);
if (groupTask != null && !groupTask.isEmpty()) { if (groupTask != null && !groupTask.isEmpty()) {
for (DownloadGroupTaskEntity te : groupTask) { for (DownloadGroupTaskEntity te : groupTask) {
if (te == null || te.getEntity() == null) continue;
int state = te.getState(); int state = te.getState();
if (state == IEntity.STATE_COMPLETE || state == IEntity.STATE_FAIL) continue; if (state == IEntity.STATE_STOP || state == IEntity.STATE_OTHER) {
resumeEntity(te); resumeEntity(te);
}
} }
} }
} }
@@ -65,9 +76,11 @@ final class ResumeAllCmd<T extends AbsTaskEntity> extends AbsNormalCmd<T> {
DbEntity.findDatas(UploadTaskEntity.class, "isGroupTask=?", "false"); DbEntity.findDatas(UploadTaskEntity.class, "isGroupTask=?", "false");
if (dTaskEntity != null && !dTaskEntity.isEmpty()) { if (dTaskEntity != null && !dTaskEntity.isEmpty()) {
for (UploadTaskEntity te : dTaskEntity) { for (UploadTaskEntity te : dTaskEntity) {
if (te == null || te.getEntity() == null) continue;
int state = te.getState(); int state = te.getState();
if (state == IEntity.STATE_COMPLETE || state == IEntity.STATE_FAIL) continue; if (state == IEntity.STATE_STOP || state == IEntity.STATE_OTHER) {
resumeEntity(te); resumeEntity(te);
}
} }
} }
} }

View File

@@ -17,11 +17,13 @@
package com.arialyy.aria.core.command.normal; package com.arialyy.aria.core.command.normal;
import android.text.TextUtils; import android.text.TextUtils;
import android.util.Log;
import com.arialyy.aria.core.AriaManager; import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.common.QueueMod; import com.arialyy.aria.core.common.QueueMod;
import com.arialyy.aria.core.inf.AbsTask; import com.arialyy.aria.core.inf.AbsTask;
import com.arialyy.aria.core.inf.IEntity;
import com.arialyy.aria.core.inf.AbsTaskEntity; import com.arialyy.aria.core.inf.AbsTaskEntity;
import com.arialyy.aria.core.inf.IEntity;
import com.arialyy.aria.util.NetUtils;
/** /**
* Created by lyy on 2016/8/22. * Created by lyy on 2016/8/22.
@@ -36,6 +38,10 @@ class StartCmd<T extends AbsTaskEntity> extends AbsNormalCmd<T> {
@Override public void executeCmd() { @Override public void executeCmd() {
if (!canExeCmd) return; if (!canExeCmd) return;
if (!NetUtils.isConnected(AriaManager.APP)) {
Log.w(TAG, "启动任务失败,网络未连接");
return;
}
String mod; String mod;
int maxTaskNum; int maxTaskNum;
AriaManager manager = AriaManager.getInstance(AriaManager.APP); AriaManager manager = AriaManager.getInstance(AriaManager.APP);
@@ -64,7 +70,6 @@ class StartCmd<T extends AbsTaskEntity> extends AbsNormalCmd<T> {
} }
} }
} else { } else {
// 任务不存在时,根据配置不同,对任务执行操作
if (!task.isRunning()) { if (!task.isRunning()) {
startTask(); startTask();
} }

View File

@@ -85,6 +85,9 @@ public abstract class AbsFileer<ENTITY extends AbsNormalEntity, TASK_ENTITY exte
} }
@Override public void run() { @Override public void run() {
if (mConstance.isRunning) {
return;
}
startFlow(); startFlow();
} }
@@ -92,12 +95,11 @@ public abstract class AbsFileer<ENTITY extends AbsNormalEntity, TASK_ENTITY exte
* 开始下载流程 * 开始下载流程
*/ */
private void startFlow() { private void startFlow() {
mConstance.resetState();
checkTask(); checkTask();
if (mListener instanceof IDownloadListener) { if (mListener instanceof IDownloadListener) {
((IDownloadListener) mListener).onPostPre(mEntity.getFileSize()); ((IDownloadListener) mListener).onPostPre(mEntity.getFileSize());
} }
mConstance.cleanState();
mConstance.isRunning = true;
if (!mTaskEntity.isSupportBP) { if (!mTaskEntity.isSupportBP) {
mThreadNum = 1; mThreadNum = 1;
mConstance.THREAD_NUM = mThreadNum; mConstance.THREAD_NUM = mThreadNum;
@@ -125,7 +127,10 @@ public abstract class AbsFileer<ENTITY extends AbsNormalEntity, TASK_ENTITY exte
mTimer = new Timer(true); mTimer = new Timer(true);
mTimer.schedule(new TimerTask() { mTimer.schedule(new TimerTask() {
@Override public void run() { @Override public void run() {
if (mConstance.isComplete() || !mConstance.isRunning) { if (mConstance.isComplete()
|| mConstance.isStop()
|| mConstance.isCancel()
|| !mConstance.isRunning) {
closeTimer(); closeTimer();
} else if (mConstance.CURRENT_LOCATION >= 0) { } else if (mConstance.CURRENT_LOCATION >= 0) {
mListener.onProgress(mConstance.CURRENT_LOCATION); mListener.onProgress(mConstance.CURRENT_LOCATION);
@@ -179,9 +184,9 @@ public abstract class AbsFileer<ENTITY extends AbsNormalEntity, TASK_ENTITY exte
@Override public void stop() { @Override public void stop() {
closeTimer(); closeTimer();
if (mConstance.isComplete()) return;
mConstance.isStop = true;
mConstance.isRunning = false; mConstance.isRunning = false;
mConstance.isStop = true;
if (mConstance.isComplete()) return;
if (mFixedThreadPool != null) { if (mFixedThreadPool != null) {
mFixedThreadPool.shutdown(); mFixedThreadPool.shutdown();
} }
@@ -393,5 +398,4 @@ public abstract class AbsFileer<ENTITY extends AbsNormalEntity, TASK_ENTITY exte
* 选择单任务线程的类型 * 选择单任务线程的类型
*/ */
protected abstract AbsThreadTask selectThreadTask(SubThreadConfig<TASK_ENTITY> config); protected abstract AbsThreadTask selectThreadTask(SubThreadConfig<TASK_ENTITY> config);
} }

View File

@@ -0,0 +1,198 @@
/*
* Copyright (C) 2016 AriaLyy(https://github.com/AriaLyy/Aria)
*
* Licensed 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 com.arialyy.aria.core.common;
import android.text.TextUtils;
import android.util.Log;
import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.download.DownloadEntity;
import com.arialyy.aria.core.download.DownloadGroupEntity;
import com.arialyy.aria.core.inf.AbsEntity;
import com.arialyy.aria.core.inf.AbsTaskEntity;
import com.arialyy.aria.core.upload.UploadEntity;
import java.io.IOException;
import org.apache.commons.net.ftp.FTP;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPFile;
import org.apache.commons.net.ftp.FTPReply;
/**
* Created by Aria.Lao on 2017/7/25.
* 获取ftp文件夹信息
*/
public abstract class AbsFtpInfoThread<ENTITY extends AbsEntity, TASK_ENTITY extends AbsTaskEntity<ENTITY>>
implements Runnable {
private final String TAG = "AbsFtpInfoThread";
protected ENTITY mEntity;
protected TASK_ENTITY mTaskEntity;
private int mConnectTimeOut;
protected OnFileInfoCallback mCallback;
protected long mSize = 0;
protected String mServerIp, mPort;
protected String charSet = "UTF-8";
private boolean isUpload = false;
public AbsFtpInfoThread(TASK_ENTITY taskEntity, OnFileInfoCallback callback) {
mTaskEntity = taskEntity;
mEntity = taskEntity.getEntity();
mConnectTimeOut =
AriaManager.getInstance(AriaManager.APP).getDownloadConfig().getConnectTimeOut();
mCallback = callback;
if (mEntity instanceof UploadEntity) {
isUpload = true;
}
}
/**
* 设置请求的远程文件路径
*
* @return 远程文件路径
*/
protected abstract String setRemotePath();
@Override public void run() {
FTPClient client = null;
try {
client = createFtpClient();
if (client == null) return;
String remotePath =
new String(setRemotePath().getBytes(charSet), AbsFtpThreadTask.SERVER_CHARSET);
FTPFile[] files = client.listFiles(remotePath);
mSize = getFileSize(files, client, remotePath);
int reply = client.getReplyCode();
if (!FTPReply.isPositiveCompletion(reply)) {
if (isUpload) {
//服务器上没有该文件路径,表示该任务为新的上传任务
mTaskEntity.isNewTask = true;
} else {
client.disconnect();
failDownload("获取文件信息错误,错误码为:" + reply);
return;
}
}
mTaskEntity.code = reply;
if (mSize != 0 && !isUpload) {
mEntity.setFileSize(mSize);
}
mEntity.update();
mTaskEntity.update();
onPreComplete(reply);
} catch (IOException e) {
failDownload(e.getMessage());
} finally {
if (client != null) {
try {
client.disconnect();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
public void start() {
new Thread(this).start();
}
protected void onPreComplete(int code) {
}
/**
* 创建FTP客户端
*/
private FTPClient createFtpClient() throws IOException {
String url = "";
if (mEntity instanceof DownloadEntity) {
url = ((DownloadEntity) mEntity).getUrl();
} else if (mEntity instanceof UploadEntity) {
url = ((UploadEntity) mEntity).getUrl();
} else if (mEntity instanceof DownloadGroupEntity) {
url = mEntity.getKey();
} else {
failDownload("未知实体");
Log.e(TAG, "未知实体");
return null;
}
String[] pp = url.split("/")[2].split(":");
mServerIp = pp[0];
mPort = pp[1];
FTPClient client = new FTPClient();
// 连接服务器
client.connect(mServerIp, Integer.parseInt(mPort));
if (!TextUtils.isEmpty(mTaskEntity.account)) {
client.login(mTaskEntity.userName, mTaskEntity.userPw);
} else {
client.login(mTaskEntity.userName, mTaskEntity.userPw, mTaskEntity.account);
}
int reply = client.getReplyCode();
if (!FTPReply.isPositiveCompletion(reply)) {
client.disconnect();
failDownload("无法连接到ftp服务器错误码为" + reply);
return null;
}
// 开启服务器对UTF-8的支持如果服务器支持就用UTF-8编码
charSet = "UTF-8";
if (!TextUtils.isEmpty(mTaskEntity.charSet) || !FTPReply.isPositiveCompletion(
client.sendCommand("OPTS UTF8", "ON"))) {
charSet = mTaskEntity.charSet;
}
client.setControlEncoding(charSet);
client.setDataTimeout(10 * 1000);
client.enterLocalPassiveMode();
client.setFileType(FTP.BINARY_FILE_TYPE);
client.setControlKeepAliveTimeout(5);
return client;
}
/**
* 遍历FTP服务器上对应文件或文件夹大小
*
* @throws IOException 字符串编码转换错误
*/
private long getFileSize(FTPFile[] files, FTPClient client, String dirName) throws IOException {
long size = 0;
String path = dirName + "/";
for (FTPFile file : files) {
if (file.isFile()) {
size += file.getSize();
handleFile(path + file.getName(), file);
} else {
String remotePath =
new String((path + file.getName()).getBytes(charSet), AbsFtpThreadTask.SERVER_CHARSET);
size += getFileSize(client.listFiles(remotePath), client, path + file.getName());
}
}
return size;
}
/**
* 处理FTP文件信息
*
* @param remotePath ftp服务器文件夹路径
* @param ftpFile ftp服务器上对应的文件
*/
protected void handleFile(String remotePath, FTPFile ftpFile) {
}
private void failDownload(String errorMsg) {
Log.e(TAG, errorMsg);
if (mCallback != null) {
mCallback.onFail(mEntity.getKey(), errorMsg);
}
}
}

View File

@@ -0,0 +1,81 @@
/*
* Copyright (C) 2016 AriaLyy(https://github.com/AriaLyy/Aria)
*
* Licensed 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 com.arialyy.aria.core.common;
import android.text.TextUtils;
import com.arialyy.aria.core.inf.AbsNormalEntity;
import com.arialyy.aria.core.inf.AbsTaskEntity;
import com.arialyy.aria.core.inf.IEventListener;
import java.io.IOException;
import org.apache.commons.net.ftp.FTP;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPReply;
/**
* Created by lyy on 2017/9/26.
* FTP单任务父类
*/
public abstract class AbsFtpThreadTask<ENTITY extends AbsNormalEntity, TASK_ENTITY extends AbsTaskEntity<ENTITY>>
extends AbsThreadTask<ENTITY, TASK_ENTITY> {
protected String charSet, serverIp, port;
/**
* FTP 服务器编码
*/
public static String SERVER_CHARSET = "ISO-8859-1";
protected AbsFtpThreadTask(StateConstance constance, IEventListener listener,
SubThreadConfig<TASK_ENTITY> info) {
super(constance, listener, info);
}
/**
* 构建FTP客户端
*/
protected FTPClient createClient() throws IOException {
String url = mEntity.getUrl();
String[] pp = url.split("/")[2].split(":");
serverIp = pp[0];
port = pp[1];
FTPClient client = new FTPClient();
// 连接服务器
client.connect(serverIp, Integer.parseInt(port));
if (!TextUtils.isEmpty(mTaskEntity.account)) {
client.login(mTaskEntity.userName, mTaskEntity.userPw);
} else {
client.login(mTaskEntity.userName, mTaskEntity.userPw, mTaskEntity.account);
}
int reply = client.getReplyCode();
if (!FTPReply.isPositiveCompletion(reply)) {
client.disconnect();
fail(STATE.CURRENT_LOCATION, "无法连接到ftp服务器错误码为" + reply, null);
return null;
}
// 开启服务器对UTF-8的支持如果服务器支持就用UTF-8编码
charSet = "UTF-8";
if (!TextUtils.isEmpty(mTaskEntity.charSet) || !FTPReply.isPositiveCompletion(
client.sendCommand("OPTS UTF8", "ON"))) {
charSet = mTaskEntity.charSet;
}
client.setControlEncoding(charSet);
client.setDataTimeout(STATE.READ_TIME_OUT);
client.enterLocalPassiveMode();
client.setFileType(FTP.BINARY_FILE_TYPE);
client.setBufferSize(mBufSize);
client.setControlKeepAliveTimeout(5);
//client.setCopyStreamListener();
return client;
}
}

View File

@@ -19,12 +19,13 @@ import android.os.Build;
import android.text.TextUtils; import android.text.TextUtils;
import android.util.Log; import android.util.Log;
import com.arialyy.aria.core.AriaManager; import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.inf.AbsEntity; import com.arialyy.aria.core.inf.AbsNormalEntity;
import com.arialyy.aria.core.inf.AbsTaskEntity; import com.arialyy.aria.core.inf.AbsTaskEntity;
import com.arialyy.aria.core.inf.IEventListener; import com.arialyy.aria.core.inf.IEventListener;
import com.arialyy.aria.core.upload.UploadEntity; import com.arialyy.aria.core.upload.UploadEntity;
import com.arialyy.aria.util.CommonUtil; import com.arialyy.aria.util.CommonUtil;
import com.arialyy.aria.util.ErrorHelp; import com.arialyy.aria.util.ErrorHelp;
import com.arialyy.aria.util.NetUtils;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.math.BigDecimal; import java.math.BigDecimal;
@@ -36,7 +37,7 @@ import java.util.TimerTask;
* Created by lyy on 2017/1/18. * Created by lyy on 2017/1/18.
* 任务线程 * 任务线程
*/ */
public abstract class AbsThreadTask<ENTITY extends AbsEntity, TASK_ENTITY extends AbsTaskEntity<ENTITY>> public abstract class AbsThreadTask<ENTITY extends AbsNormalEntity, TASK_ENTITY extends AbsTaskEntity<ENTITY>>
implements Runnable { implements Runnable {
/** /**
* 线程重试次数 * 线程重试次数
@@ -55,10 +56,6 @@ public abstract class AbsThreadTask<ENTITY extends AbsEntity, TASK_ENTITY extend
protected SubThreadConfig<TASK_ENTITY> mConfig; protected SubThreadConfig<TASK_ENTITY> mConfig;
protected ENTITY mEntity; protected ENTITY mEntity;
protected TASK_ENTITY mTaskEntity; protected TASK_ENTITY mTaskEntity;
/**
* FTP 服务器编码
*/
public static String SERVER_CHARSET = "ISO-8859-1";
private int mFailNum = 0; private int mFailNum = 0;
private String mTaskType; private String mTaskType;
private Timer mFailTimer; private Timer mFailTimer;
@@ -73,9 +70,7 @@ public abstract class AbsThreadTask<ENTITY extends AbsEntity, TASK_ENTITY extend
mConfig = info; mConfig = info;
mTaskEntity = mConfig.TASK_ENTITY; mTaskEntity = mConfig.TASK_ENTITY;
mEntity = mTaskEntity.getEntity(); mEntity = mTaskEntity.getEntity();
if (mConfig.SUPPORT_BP) { mConfigFPath = info.CONFIG_FILE_PATH;
mConfigFPath = info.CONFIG_FILE_PATH;
}
mBufSize = manager.getDownloadConfig().getBuffSize(); mBufSize = manager.getDownloadConfig().getBuffSize();
setMaxSpeed(AriaManager.getInstance(AriaManager.APP).getDownloadConfig().getMsxSpeed()); setMaxSpeed(AriaManager.getInstance(AriaManager.APP).getDownloadConfig().getMsxSpeed());
mTaskType = getTaskType(); mTaskType = getTaskType();
@@ -104,14 +99,15 @@ public abstract class AbsThreadTask<ENTITY extends AbsEntity, TASK_ENTITY extend
synchronized (AriaManager.LOCK) { synchronized (AriaManager.LOCK) {
try { try {
if (mConfig.SUPPORT_BP) { if (mConfig.SUPPORT_BP) {
final long currentTemp = mChildCurrentLocation;
STATE.STOP_NUM++; STATE.STOP_NUM++;
Log.d(TAG, "任务【" Log.d(TAG, "任务【"
+ mConfig.TEMP_FILE.getName() + mConfig.TEMP_FILE.getName()
+ "】thread__" + "】thread__"
+ mConfig.THREAD_ID + mConfig.THREAD_ID
+ "__停止, stop location ==> " + "__停止, stop location ==> "
+ mChildCurrentLocation); + currentTemp);
writeConfig(false, mChildCurrentLocation); writeConfig(false, currentTemp);
if (STATE.isStop()) { if (STATE.isStop()) {
Log.d(TAG, "任务【" + mConfig.TEMP_FILE.getName() + "】已停止"); Log.d(TAG, "任务【" + mConfig.TEMP_FILE.getName() + "】已停止");
STATE.isRunning = false; STATE.isRunning = false;
@@ -169,12 +165,9 @@ public abstract class AbsThreadTask<ENTITY extends AbsEntity, TASK_ENTITY extend
/** /**
* 任务失败 * 任务失败
*/ */
protected void fail(long currentLocation, String msg, Exception ex) { protected void fail(final long currentLocation, String msg, Exception ex) {
synchronized (AriaManager.LOCK) { synchronized (AriaManager.LOCK) {
try { try {
//STATE.FAIL_NUM++;
//STATE.isRunning = false;
//STATE.isStop = true;
if (ex != null) { if (ex != null) {
Log.e(TAG, msg + "\n" + CommonUtil.getPrintException(ex)); Log.e(TAG, msg + "\n" + CommonUtil.getPrintException(ex));
} else { } else {
@@ -182,11 +175,7 @@ public abstract class AbsThreadTask<ENTITY extends AbsEntity, TASK_ENTITY extend
} }
if (mConfig.SUPPORT_BP) { if (mConfig.SUPPORT_BP) {
writeConfig(false, currentLocation); writeConfig(false, currentLocation);
//if (STATE.isFail()) { retryThis(STATE.THREAD_NUM != 1);
// Log.e(TAG, "任务【" + mConfig.TEMP_FILE.getName() + "】执行失败");
// mListener.onFail(true);
//}
retryThis(true);
} else { } else {
Log.e(TAG, "任务【" + mConfig.TEMP_FILE.getName() + "】执行失败"); Log.e(TAG, "任务【" + mConfig.TEMP_FILE.getName() + "】执行失败");
mListener.onFail(true); mListener.onFail(true);
@@ -204,7 +193,11 @@ public abstract class AbsThreadTask<ENTITY extends AbsEntity, TASK_ENTITY extend
* @param needRetry 是否可以重试 * @param needRetry 是否可以重试
*/ */
private void retryThis(boolean needRetry) { private void retryThis(boolean needRetry) {
if (mFailNum < RETRY_NUM && needRetry) { if (!NetUtils.isConnected(AriaManager.APP)) {
Log.w(TAG,
"任务【" + mConfig.TEMP_FILE.getName() + "】thread__" + mConfig.THREAD_ID + "__重试失败网络未连接");
}
if (mFailNum < RETRY_NUM && needRetry && NetUtils.isConnected(AriaManager.APP)) {
if (mFailTimer != null) { if (mFailTimer != null) {
mFailTimer.purge(); mFailTimer.purge();
mFailTimer.cancel(); mFailTimer.cancel();
@@ -215,23 +208,26 @@ public abstract class AbsThreadTask<ENTITY extends AbsEntity, TASK_ENTITY extend
mFailNum++; mFailNum++;
Log.w(TAG, Log.w(TAG,
"任务【" + mConfig.TEMP_FILE.getName() + "】thread__" + mConfig.THREAD_ID + "__正在重试"); "任务【" + mConfig.TEMP_FILE.getName() + "】thread__" + mConfig.THREAD_ID + "__正在重试");
mConfig.START_LOCATION = mChildCurrentLocation; final long retryLocation = mChildCurrentLocation;
mConfig.START_LOCATION = retryLocation;
AbsThreadTask.this.run(); AbsThreadTask.this.run();
} }
}, RETRY_INTERVAL); }, RETRY_INTERVAL);
} else { } else {
STATE.FAIL_NUM++; STATE.FAIL_NUM++;
STATE.isRunning = false; if (STATE.isFail()) {
STATE.isStop = true; STATE.isRunning = false;
Log.e(TAG, "任务【" + mConfig.TEMP_FILE.getName() + "】执行失败"); STATE.isStop = true;
mListener.onFail(true); Log.e(TAG, "任务【" + mConfig.TEMP_FILE.getName() + "】执行失败");
mListener.onFail(true);
}
} }
} }
/** /**
* 将记录写入到配置文件 * 将记录写入到配置文件
*/ */
protected void writeConfig(boolean isComplete, long record) throws IOException { protected void writeConfig(boolean isComplete, final long record) throws IOException {
synchronized (AriaManager.LOCK) { synchronized (AriaManager.LOCK) {
String key = null, value = null; String key = null, value = null;
if (0 < record && record < mConfig.END_LOCATION) { if (0 < record && record < mConfig.END_LOCATION) {

View File

@@ -1,6 +1,6 @@
package com.arialyy.aria.core.download.downloader; package com.arialyy.aria.core.common;
interface OnFileInfoCallback { public interface OnFileInfoCallback {
/** /**
* 处理完成 * 处理完成
* *

View File

@@ -35,7 +35,7 @@ public class StateConstance {
public StateConstance() { public StateConstance() {
} }
public void cleanState() { public void resetState() {
isCancel = false; isCancel = false;
isStop = false; isStop = false;
isRunning = true; isRunning = true;
@@ -56,7 +56,7 @@ public class StateConstance {
* 所有子线程是否都已经下载失败 * 所有子线程是否都已经下载失败
*/ */
public boolean isFail() { public boolean isFail() {
return FAIL_NUM == THREAD_NUM; return FAIL_NUM + COMPLETE_THREAD_NUM >= THREAD_NUM;
} }
/** /**

View File

@@ -31,12 +31,14 @@ import java.lang.ref.WeakReference;
class BaseDListener<ENTITY extends AbsEntity, TASK extends AbsTask<ENTITY>> class BaseDListener<ENTITY extends AbsEntity, TASK extends AbsTask<ENTITY>>
implements IDownloadListener { implements IDownloadListener {
protected WeakReference<Handler> outHandler; protected WeakReference<Handler> outHandler;
private int RUN_SAVE_INTERVAL = 5 * 1000; //5s保存一次下载中的进度
private long mLastLen = 0; //上一次发送长度 private long mLastLen = 0; //上一次发送长度
private boolean isFirst = true; private boolean isFirst = true;
protected ENTITY mEntity; protected ENTITY mEntity;
protected TASK mTask; protected TASK mTask;
private boolean isConvertSpeed = false; private boolean isConvertSpeed = false;
boolean isWait = false; boolean isWait = false;
private long mLastSaveTime;
BaseDListener(TASK task, Handler outHandler) { BaseDListener(TASK task, Handler outHandler) {
this.outHandler = new WeakReference<>(outHandler); this.outHandler = new WeakReference<>(outHandler);
@@ -45,6 +47,7 @@ class BaseDListener<ENTITY extends AbsEntity, TASK extends AbsTask<ENTITY>>
final AriaManager manager = AriaManager.getInstance(AriaManager.APP); final AriaManager manager = AriaManager.getInstance(AriaManager.APP);
isConvertSpeed = manager.getDownloadConfig().isConvertSpeed(); isConvertSpeed = manager.getDownloadConfig().isConvertSpeed();
mLastLen = mEntity.getCurrentProgress(); mLastLen = mEntity.getCurrentProgress();
mLastSaveTime = System.currentTimeMillis();
} }
@Override public void onPre() { @Override public void onPre() {
@@ -82,6 +85,11 @@ class BaseDListener<ENTITY extends AbsEntity, TASK extends AbsTask<ENTITY>>
} }
handleSpeed(speed); handleSpeed(speed);
sendInState2Target(ISchedulers.RUNNING); sendInState2Target(ISchedulers.RUNNING);
if (System.currentTimeMillis() - mLastSaveTime >= RUN_SAVE_INTERVAL){
saveData(IEntity.STATE_RUNNING, currentLocation);
mLastSaveTime = System.currentTimeMillis();
}
mLastLen = currentLocation; mLastLen = currentLocation;
} }

View File

@@ -17,6 +17,7 @@ package com.arialyy.aria.core.download;
import android.os.Handler; import android.os.Handler;
import android.os.Looper; import android.os.Looper;
import android.util.Log;
import com.arialyy.aria.core.AriaManager; import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.common.IUtil; import com.arialyy.aria.core.common.IUtil;
import com.arialyy.aria.core.download.downloader.AbsGroupUtil; import com.arialyy.aria.core.download.downloader.AbsGroupUtil;
@@ -56,23 +57,23 @@ public class DownloadGroupTask extends AbsGroupTask<DownloadGroupTaskEntity, Dow
} }
@Override public void start() { @Override public void start() {
mUtil.start(); if (mUtil.isRunning()) {
Log.d(TAG, "任务正在下载");
} else {
mUtil.start();
}
} }
@Override public void stop() { @Override public void stop() {
if (!mUtil.isRunning()) { if (!mUtil.isRunning()) {
if (mOutHandler != null) { mListener.onStop(mEntity.getCurrentProgress());
mOutHandler.obtainMessage(ISchedulers.STOP, this).sendToTarget();
}
} }
mUtil.stop(); mUtil.stop();
} }
@Override public void cancel() { @Override public void cancel() {
if (!mUtil.isRunning()) { if (!mUtil.isRunning()) {
if (mOutHandler != null) { mListener.onCancel();
mOutHandler.obtainMessage(ISchedulers.CANCEL, this).sendToTarget();
}
} }
mUtil.cancel(); mUtil.cancel();
} }

View File

@@ -128,11 +128,7 @@ public class DownloadTask extends AbsNormalTask<DownloadEntity> {
if (mUtil.isRunning()) { if (mUtil.isRunning()) {
mUtil.stop(); mUtil.stop();
} else { } else {
mEntity.setState(isWait ? IEntity.STATE_WAIT : IEntity.STATE_STOP); mListener.onStop(mEntity.getCurrentProgress());
mEntity.update();
if (mOutHandler != null) {
mOutHandler.obtainMessage(ISchedulers.STOP, this).sendToTarget();
}
} }
} }
@@ -141,9 +137,7 @@ public class DownloadTask extends AbsNormalTask<DownloadEntity> {
*/ */
@Override public void cancel() { @Override public void cancel() {
if (!mUtil.isRunning()) { if (!mUtil.isRunning()) {
if (mOutHandler != null) { mListener.onCancel();
mOutHandler.obtainMessage(ISchedulers.CANCEL, this).sendToTarget();
}
} }
mUtil.cancel(); mUtil.cancel();
} }

View File

@@ -1,155 +0,0 @@
/*
* Copyright (C) 2016 AriaLyy(https://github.com/AriaLyy/Aria)
*
* Licensed 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 com.arialyy.aria.core.download.downloader;
import android.text.TextUtils;
import android.util.Log;
import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.common.AbsThreadTask;
import com.arialyy.aria.core.inf.AbsEntity;
import com.arialyy.aria.core.inf.AbsTaskEntity;
import com.arialyy.aria.util.CommonUtil;
import java.io.IOException;
import org.apache.commons.net.ftp.FTP;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPFile;
import org.apache.commons.net.ftp.FTPReply;
/**
* Created by Aria.Lao on 2017/7/25.
* 获取ftp文件夹信息
*/
abstract class AbsFtpInfoThread<ENTITY extends AbsEntity, TASK_ENTITY extends AbsTaskEntity<ENTITY>>
implements Runnable {
private final String TAG = "HttpFileInfoThread";
protected ENTITY mEntity;
protected TASK_ENTITY mTaskEntity;
private int mConnectTimeOut;
private OnFileInfoCallback mCallback;
protected long mSize = 0;
AbsFtpInfoThread(TASK_ENTITY taskEntity, OnFileInfoCallback callback) {
mTaskEntity = taskEntity;
mEntity = taskEntity.getEntity();
mConnectTimeOut =
AriaManager.getInstance(AriaManager.APP).getDownloadConfig().getConnectTimeOut();
mCallback = callback;
}
@Override public void run() {
FTPClient client = null;
try {
String url = mTaskEntity.getEntity().getKey();
String[] pp = url.split("/")[2].split(":");
String serverIp = pp[0];
int port = Integer.parseInt(pp[1]);
String remotePath = url.substring(url.indexOf(pp[1]) + pp[1].length(), url.length());
client = new FTPClient();
client.connect(serverIp, port);
if (!TextUtils.isEmpty(mTaskEntity.account)) {
client.login(mTaskEntity.userName, mTaskEntity.userPw);
} else {
client.login(mTaskEntity.userName, mTaskEntity.userPw, mTaskEntity.account);
}
int reply = client.getReplyCode();
if (!FTPReply.isPositiveCompletion(reply)) {
client.disconnect();
failDownload("无法连接到ftp服务器错误码为" + reply);
return;
}
client.setDataTimeout(mConnectTimeOut);
String charSet = "UTF-8";
// 开启服务器对UTF-8的支持如果服务器支持就用UTF-8编码
if (!TextUtils.isEmpty(mTaskEntity.charSet) || !FTPReply.isPositiveCompletion(
client.sendCommand("OPTS UTF8", "ON"))) {
charSet = mTaskEntity.charSet;
}
client.setControlEncoding(charSet);
client.enterLocalPassiveMode();
client.setFileType(FTP.BINARY_FILE_TYPE);
FTPFile[] files =
client.listFiles(new String(remotePath.getBytes(charSet), AbsThreadTask.SERVER_CHARSET));
mSize = getFileSize(files, client, remotePath);
reply = client.getReplyCode();
if (!FTPReply.isPositiveCompletion(reply)) {
client.disconnect();
failDownload("获取文件信息错误,错误码为:" + reply);
return;
}
mTaskEntity.code = reply;
onPreComplete();
mEntity.update();
mTaskEntity.update();
mCallback.onComplete(mEntity.getKey(), reply);
} catch (IOException e) {
failDownload(e.getMessage());
} finally {
if (client != null) {
try {
client.disconnect();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
void start() {
new Thread(this).start();
}
protected void onPreComplete() {
}
/**
* 遍历FTP服务器上对应文件或文件夹大小
*
* @throws IOException
*/
private long getFileSize(FTPFile[] files, FTPClient client, String dirName) throws IOException {
long size = 0;
String path = dirName + "/";
for (FTPFile file : files) {
if (file.isFile()) {
size += file.getSize();
handleFile(path + file.getName(), file);
} else {
size += getFileSize(client.listFiles(
CommonUtil.strCharSetConvert(path + file.getName(), mTaskEntity.charSet)), client,
path + file.getName());
}
}
return size;
}
/**
* 处理FTP文件信息
*
* @param remotePath ftp服务器文件夹路径
* @param ftpFile ftp服务器上对应的文件
*/
void handleFile(String remotePath, FTPFile ftpFile) {
}
private void failDownload(String errorMsg) {
Log.e(TAG, errorMsg);
if (mCallback != null) {
mCallback.onFail(mEntity.getKey(), errorMsg);
}
}
}

View File

@@ -25,6 +25,7 @@ import com.arialyy.aria.core.inf.IDownloadListener;
import com.arialyy.aria.core.inf.IEntity; import com.arialyy.aria.core.inf.IEntity;
import com.arialyy.aria.orm.DbEntity; import com.arialyy.aria.orm.DbEntity;
import com.arialyy.aria.util.CommonUtil; import com.arialyy.aria.util.CommonUtil;
import com.arialyy.aria.util.NetUtils;
import java.io.File; import java.io.File;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
@@ -42,23 +43,15 @@ import java.util.concurrent.Executors;
public abstract class AbsGroupUtil implements IUtil { public abstract class AbsGroupUtil implements IUtil {
private final String TAG = "AbsGroupUtil"; private final String TAG = "AbsGroupUtil";
/** /**
* 任务组所有任务总大小 * 任务组所有任务总长度
*/ */
long mTotalSize = 0; long mTotalLen = 0;
long mCurrentLocation = 0; long mCurrentLocation = 0;
private ExecutorService mExePool; private ExecutorService mExePool;
protected IDownloadGroupListener mListener; protected IDownloadGroupListener mListener;
protected DownloadGroupTaskEntity mTaskEntity; protected DownloadGroupTaskEntity mTaskEntity;
private boolean isRunning = false; private boolean isRunning = false;
private Timer mTimer; private Timer mTimer;
/**
* 初始化完成的任务书数
*/
int mInitNum = 0;
/**
* 初始化失败的任务数
*/
int mInitFailNum = 0;
/** /**
* 保存所有没有下载完成的任务key为下载地址 * 保存所有没有下载完成的任务key为下载地址
*/ */
@@ -78,18 +71,26 @@ public abstract class AbsGroupUtil implements IUtil {
* 该任务组对应的所有任务 * 该任务组对应的所有任务
*/ */
private Map<String, DownloadTaskEntity> mTasksMap = new HashMap<>(); private Map<String, DownloadTaskEntity> mTasksMap = new HashMap<>();
/**
* 是否需要读取文件长度,{@code true}需要
*/
boolean isNeedLoadFileSize = true;
//已经完成的任务数 //已经完成的任务数
private int mCompleteNum = 0; private int mCompleteNum = 0;
//失败的任务数 //失败的任务数
private int mFailNum = 0; private int mFailNum = 0;
//停止的任务数 //停止的任务数
private int mStopNum = 0; private int mStopNum = 0;
//实际的下载任务数 //实际的下载任务数
int mActualTaskNum = 0; int mActualTaskNum = 0;
/** //初始化完成的任务数
* 是否需要读取文件长度,{@code true}需要 int mInitNum = 0;
*/ // 初始化失败的任务数
boolean isNeedLoadFileSize = true; int mInitFailNum = 0;
//任务组大小
int mGroupSize = 0;
AbsGroupUtil(IDownloadGroupListener listener, DownloadGroupTaskEntity taskEntity) { AbsGroupUtil(IDownloadGroupListener listener, DownloadGroupTaskEntity taskEntity) {
mListener = listener; mListener = listener;
@@ -104,14 +105,13 @@ public abstract class AbsGroupUtil implements IUtil {
mTasksMap.put(te.getEntity().getUrl(), te); mTasksMap.put(te.getEntity().getUrl(), te);
} }
} }
mTotalSize = taskEntity.getEntity().getFileSize(); mGroupSize = mTaskEntity.entity.getSubTask().size();
isNeedLoadFileSize = mTotalSize <= 1; mTotalLen = taskEntity.getEntity().getFileSize();
isNeedLoadFileSize = mTotalLen <= 1;
for (DownloadEntity entity : mTaskEntity.entity.getSubTask()) { for (DownloadEntity entity : mTaskEntity.entity.getSubTask()) {
File file = new File(entity.getDownloadPath()); File file = new File(entity.getDownloadPath());
if (entity.getState() == IEntity.STATE_COMPLETE && file.exists()) { if (entity.getState() == IEntity.STATE_COMPLETE && file.exists()) {
mCompleteNum++; mCompleteNum++;
mInitNum++;
mStopNum++;
mCurrentLocation += entity.getFileSize(); mCurrentLocation += entity.getFileSize();
} else { } else {
mExeMap.put(entity.getUrl(), createChildDownloadTask(entity)); mExeMap.put(entity.getUrl(), createChildDownloadTask(entity));
@@ -119,7 +119,7 @@ public abstract class AbsGroupUtil implements IUtil {
mActualTaskNum++; mActualTaskNum++;
} }
if (isNeedLoadFileSize) { if (isNeedLoadFileSize) {
mTotalSize += entity.getFileSize(); mTotalLen += entity.getFileSize();
} }
} }
updateFileSize(); updateFileSize();
@@ -127,7 +127,7 @@ public abstract class AbsGroupUtil implements IUtil {
void updateFileSize() { void updateFileSize() {
if (isNeedLoadFileSize) { if (isNeedLoadFileSize) {
mTaskEntity.getEntity().setFileSize(mTotalSize); mTaskEntity.getEntity().setFileSize(mTotalLen);
mTaskEntity.getEntity().update(); mTaskEntity.getEntity().update();
} }
} }
@@ -211,7 +211,7 @@ public abstract class AbsGroupUtil implements IUtil {
} }
@Override public long getFileSize() { @Override public long getFileSize() {
return mTotalSize; return mTotalLen;
} }
@Override public long getCurrentLocation() { @Override public long getCurrentLocation() {
@@ -271,7 +271,6 @@ public abstract class AbsGroupUtil implements IUtil {
@Override public void stop() { @Override public void stop() {
closeTimer(false); closeTimer(false);
mListener.onStop(mCurrentLocation);
onStop(); onStop();
if (!mExePool.isShutdown()) { if (!mExePool.isShutdown()) {
mExePool.shutdown(); mExePool.shutdown();
@@ -324,7 +323,7 @@ public abstract class AbsGroupUtil implements IUtil {
*/ */
void startRunningFlow() { void startRunningFlow() {
closeTimer(true); closeTimer(true);
mListener.onPostPre(mTotalSize); mListener.onPostPre(mTotalLen);
mListener.onStart(mCurrentLocation); mListener.onStart(mCurrentLocation);
startTimer(); startTimer();
} }
@@ -405,14 +404,16 @@ public abstract class AbsGroupUtil implements IUtil {
DownloadTaskEntity taskEntity; DownloadTaskEntity taskEntity;
DownloadEntity entity; DownloadEntity entity;
private int RUN_SAVE_INTERVAL = 5 * 1000; //5s保存一次下载中的进度
private long mLastSaveTime;
long lastLen = 0; long lastLen = 0;
ChildDownloadListener(DownloadTaskEntity entity) { ChildDownloadListener(DownloadTaskEntity entity) {
this.taskEntity = entity; this.taskEntity = entity;
this.entity = taskEntity.getEntity(); this.entity = taskEntity.getEntity();
lastLen = this.entity.getCurrentProgress();
this.entity.setFailNum(0); this.entity.setFailNum(0);
lastLen = this.entity.getCurrentProgress();
mLastSaveTime = System.currentTimeMillis();
} }
@Override public void onPre() { @Override public void onPre() {
@@ -444,6 +445,10 @@ public abstract class AbsGroupUtil implements IUtil {
entity.setCurrentProgress(currentLocation); entity.setCurrentProgress(currentLocation);
handleSpeed(speed); handleSpeed(speed);
mListener.onSubRunning(entity); mListener.onSubRunning(entity);
if (System.currentTimeMillis() - mLastSaveTime >= RUN_SAVE_INTERVAL) {
saveData(IEntity.STATE_RUNNING, currentLocation);
mLastSaveTime = System.currentTimeMillis();
}
lastLen = currentLocation; lastLen = currentLocation;
} }
@@ -451,10 +456,12 @@ public abstract class AbsGroupUtil implements IUtil {
saveData(IEntity.STATE_STOP, stopLocation); saveData(IEntity.STATE_STOP, stopLocation);
handleSpeed(0); handleSpeed(0);
mListener.onSubStop(entity); mListener.onSubStop(entity);
mStopNum++; synchronized (AbsGroupUtil.class) {
if (mStopNum + mCompleteNum >= mInitNum) { mStopNum++;
closeTimer(false); if (mStopNum + mCompleteNum + mInitFailNum + mFailNum >= mGroupSize) {
mListener.onStop(mCurrentLocation); closeTimer(false);
mListener.onStop(mCurrentLocation);
}
} }
} }
@@ -466,16 +473,19 @@ public abstract class AbsGroupUtil implements IUtil {
@Override public void onComplete() { @Override public void onComplete() {
saveData(IEntity.STATE_COMPLETE, entity.getFileSize()); saveData(IEntity.STATE_COMPLETE, entity.getFileSize());
mCompleteNum++;
handleSpeed(0); handleSpeed(0);
mListener.onSubComplete(entity); mListener.onSubComplete(entity);
//如果子任务完成的数量和总任务数一致,表示任务组任务已经完成 synchronized (AbsGroupUtil.class) {
if (mCompleteNum >= mTaskEntity.getEntity().getSubTask().size()) { mCompleteNum++;
closeTimer(false); //如果子任务完成的数量和总任务数一致,表示任务组任务已经完成
mListener.onComplete(); if (mCompleteNum >= mGroupSize) {
} else if (mCompleteNum + mFailNum >= mActualTaskNum) { closeTimer(false);
//如果子任务完成数量加上失败的数量和总任务数一致,则任务组停止下载 mListener.onComplete();
closeTimer(false); } else if (mStopNum + mCompleteNum + mInitFailNum + mFailNum >= mGroupSize) {
//如果子任务完成数量加上失败的数量和总任务数一致,则任务组停止下载
closeTimer(false);
mListener.onStop(mCurrentLocation);
}
} }
} }
@@ -491,7 +501,8 @@ public abstract class AbsGroupUtil implements IUtil {
*/ */
private void reTry(boolean needRetry) { private void reTry(boolean needRetry) {
synchronized (AriaManager.LOCK) { synchronized (AriaManager.LOCK) {
if (entity.getFailNum() < 5 && isRunning && needRetry) { if (entity.getFailNum() < 5 && isRunning && needRetry && NetUtils.isConnected(
AriaManager.APP)) {
reStartTask(); reStartTask();
} else { } else {
mFailNum++; mFailNum++;

View File

@@ -17,6 +17,7 @@ package com.arialyy.aria.core.download.downloader;
import android.util.SparseArray; import android.util.SparseArray;
import com.arialyy.aria.core.common.IUtil; import com.arialyy.aria.core.common.IUtil;
import com.arialyy.aria.core.common.OnFileInfoCallback;
import com.arialyy.aria.core.download.DownloadGroupTaskEntity; import com.arialyy.aria.core.download.DownloadGroupTaskEntity;
import com.arialyy.aria.core.download.DownloadTaskEntity; import com.arialyy.aria.core.download.DownloadTaskEntity;
import com.arialyy.aria.core.inf.IEntity; import com.arialyy.aria.core.inf.IEntity;
@@ -73,7 +74,7 @@ public class DownloadGroupUtil extends AbsGroupUtil implements IUtil {
} }
} }
if (i != 0 && i == mExeMap.size()) startRunningFlow(); if (i != 0 && i == mExeMap.size()) startRunningFlow();
if (mCurrentLocation == mTotalSize) { if (mCurrentLocation == mTotalLen) {
mListener.onComplete(); mListener.onComplete();
} }
} }
@@ -92,7 +93,7 @@ public class DownloadGroupUtil extends AbsGroupUtil implements IUtil {
DownloadTaskEntity te = mExeMap.get(url); DownloadTaskEntity te = mExeMap.get(url);
if (te != null) { if (te != null) {
if (isNeedLoadFileSize) { if (isNeedLoadFileSize) {
mTotalSize += te.getEntity().getFileSize(); mTotalLen += te.getEntity().getFileSize();
} }
createChildDownload(te); createChildDownload(te);
} }

View File

@@ -16,7 +16,6 @@
package com.arialyy.aria.core.download.downloader; package com.arialyy.aria.core.download.downloader;
import android.util.Log; import android.util.Log;
import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.common.AbsFileer; import com.arialyy.aria.core.common.AbsFileer;
import com.arialyy.aria.core.common.AbsThreadTask; import com.arialyy.aria.core.common.AbsThreadTask;
import com.arialyy.aria.core.common.SubThreadConfig; import com.arialyy.aria.core.common.SubThreadConfig;
@@ -43,10 +42,7 @@ class Downloader extends AbsFileer<DownloadEntity, DownloadTaskEntity> {
} }
@Override protected void checkTask() { @Override protected void checkTask() {
mConfigFile = new File(mContext.getFilesDir().getPath() mConfigFile = new File(CommonUtil.getFileConfigPath(true, mEntity.getFileName()));
+ AriaManager.DOWNLOAD_TEMP_DIR
+ mEntity.getFileName()
+ ".properties");
mTempFile = new File(mEntity.getDownloadPath()); mTempFile = new File(mEntity.getDownloadPath());
if (!mTaskEntity.isSupportBP) { if (!mTaskEntity.isSupportBP) {
isNewTask = true; isNewTask = true;

View File

@@ -15,6 +15,7 @@
*/ */
package com.arialyy.aria.core.download.downloader; package com.arialyy.aria.core.download.downloader;
import com.arialyy.aria.core.common.OnFileInfoCallback;
import com.arialyy.aria.core.download.DownloadEntity; import com.arialyy.aria.core.download.DownloadEntity;
import com.arialyy.aria.core.download.DownloadGroupTaskEntity; import com.arialyy.aria.core.download.DownloadGroupTaskEntity;
import com.arialyy.aria.core.download.DownloadTaskEntity; import com.arialyy.aria.core.download.DownloadTaskEntity;
@@ -42,6 +43,8 @@ public class FtpDirDownloadUtil extends AbsGroupUtil {
mExeMap.put(entity.getUrl(), createChildDownloadTask(entity)); mExeMap.put(entity.getUrl(), createChildDownloadTask(entity));
} }
mActualTaskNum = mTaskEntity.entity.getSubTask().size(); mActualTaskNum = mTaskEntity.entity.getSubTask().size();
mGroupSize = mActualTaskNum;
mTotalLen = mTaskEntity.entity.getFileSize();
startDownload(); startDownload();
} }
} }

View File

@@ -15,6 +15,8 @@
*/ */
package com.arialyy.aria.core.download.downloader; package com.arialyy.aria.core.download.downloader;
import com.arialyy.aria.core.common.AbsFtpInfoThread;
import com.arialyy.aria.core.common.OnFileInfoCallback;
import com.arialyy.aria.core.download.DownloadEntity; import com.arialyy.aria.core.download.DownloadEntity;
import com.arialyy.aria.core.download.DownloadGroupEntity; import com.arialyy.aria.core.download.DownloadGroupEntity;
import com.arialyy.aria.core.download.DownloadGroupTaskEntity; import com.arialyy.aria.core.download.DownloadGroupTaskEntity;
@@ -33,14 +35,20 @@ class FtpDirInfoThread extends AbsFtpInfoThread<DownloadGroupEntity, DownloadGro
super(taskEntity, callback); super(taskEntity, callback);
} }
@Override void handleFile(String remotePath, FTPFile ftpFile) { @Override protected String setRemotePath() {
String url = mEntity.getKey();
return url.substring(url.indexOf(mPort) + mPort.length(), url.length());
}
@Override protected void handleFile(String remotePath, FTPFile ftpFile) {
super.handleFile(remotePath, ftpFile); super.handleFile(remotePath, ftpFile);
addEntity(remotePath, ftpFile); addEntity(remotePath, ftpFile);
} }
@Override protected void onPreComplete() { @Override protected void onPreComplete(int code) {
super.onPreComplete(); super.onPreComplete(code);
mEntity.setFileSize(mSize); mEntity.setFileSize(mSize);
mCallback.onComplete(mEntity.getKey(), code);
} }
private void addEntity(String remotePath, FTPFile ftpFile) { private void addEntity(String remotePath, FTPFile ftpFile) {

View File

@@ -15,6 +15,8 @@
*/ */
package com.arialyy.aria.core.download.downloader; package com.arialyy.aria.core.download.downloader;
import com.arialyy.aria.core.common.AbsFtpInfoThread;
import com.arialyy.aria.core.common.OnFileInfoCallback;
import com.arialyy.aria.core.download.DownloadEntity; import com.arialyy.aria.core.download.DownloadEntity;
import com.arialyy.aria.core.download.DownloadTaskEntity; import com.arialyy.aria.core.download.DownloadTaskEntity;
@@ -28,11 +30,17 @@ class FtpFileInfoThread extends AbsFtpInfoThread<DownloadEntity, DownloadTaskEnt
super(taskEntity, callback); super(taskEntity, callback);
} }
@Override protected void onPreComplete() { @Override protected String setRemotePath() {
super.onPreComplete(); String url = mEntity.getUrl();
return url.substring(url.indexOf(mPort) + mPort.length(), url.length());
}
@Override protected void onPreComplete(int code) {
super.onPreComplete(code);
if (mSize != mTaskEntity.getEntity().getFileSize()) { if (mSize != mTaskEntity.getEntity().getFileSize()) {
mTaskEntity.isNewTask = true; mTaskEntity.isNewTask = true;
} }
mEntity.setFileSize(mSize); mEntity.setFileSize(mSize);
mCallback.onComplete(mEntity.getUrl(), code);
} }
} }

View File

@@ -15,9 +15,8 @@
*/ */
package com.arialyy.aria.core.download.downloader; package com.arialyy.aria.core.download.downloader;
import android.text.TextUtils;
import android.util.Log; import android.util.Log;
import com.arialyy.aria.core.common.AbsThreadTask; import com.arialyy.aria.core.common.AbsFtpThreadTask;
import com.arialyy.aria.core.common.StateConstance; import com.arialyy.aria.core.common.StateConstance;
import com.arialyy.aria.core.common.SubThreadConfig; import com.arialyy.aria.core.common.SubThreadConfig;
import com.arialyy.aria.core.download.DownloadEntity; import com.arialyy.aria.core.download.DownloadEntity;
@@ -27,7 +26,6 @@ import com.arialyy.aria.util.BufferedRandomAccessFile;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import org.apache.commons.net.ftp.FTP;
import org.apache.commons.net.ftp.FTPClient; import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPReply; import org.apache.commons.net.ftp.FTPReply;
@@ -35,7 +33,7 @@ import org.apache.commons.net.ftp.FTPReply;
* Created by Aria.Lao on 2017/7/24. * Created by Aria.Lao on 2017/7/24.
* Ftp下载任务 * Ftp下载任务
*/ */
class FtpThreadTask extends AbsThreadTask<DownloadEntity, DownloadTaskEntity> { class FtpThreadTask extends AbsFtpThreadTask<DownloadEntity, DownloadTaskEntity> {
private final String TAG = "FtpThreadTask"; private final String TAG = "FtpThreadTask";
FtpThreadTask(StateConstance constance, IDownloadListener listener, FtpThreadTask(StateConstance constance, IDownloadListener listener,
@@ -57,40 +55,16 @@ class FtpThreadTask extends AbsThreadTask<DownloadEntity, DownloadTaskEntity> {
+ ",结束位置:" + ",结束位置:"
+ mConfig.END_LOCATION + mConfig.END_LOCATION
+ ""); + "");
client = createClient();
if (client == null) return;
String url = mEntity.getUrl(); String url = mEntity.getUrl();
String[] pp = url.split("/")[2].split(":"); String remotePath = new String(
String serverIp = pp[0]; url.substring(url.indexOf(port) + port.length(), url.length()).getBytes(charSet),
int port = Integer.parseInt(pp[1]); SERVER_CHARSET);
String remotePath = url.substring(url.indexOf(pp[1]) + pp[1].length(), url.length());
client = new FTPClient();
client.connect(serverIp, port);
if (!TextUtils.isEmpty(mTaskEntity.account)) {
client.login(mTaskEntity.userName, mTaskEntity.userPw);
} else {
client.login(mTaskEntity.userName, mTaskEntity.userPw, mTaskEntity.account);
}
int reply = client.getReplyCode();
if (!FTPReply.isPositiveCompletion(reply)) {
client.disconnect();
fail(STATE.CURRENT_LOCATION, "无法连接到ftp服务器错误码为" + reply, null);
return;
}
String charSet = "UTF-8";
// 开启服务器对UTF-8的支持如果服务器支持就用UTF-8编码
if (!TextUtils.isEmpty(mTaskEntity.charSet) || !FTPReply.isPositiveCompletion(
client.sendCommand("OPTS UTF8", "ON"))) {
charSet = mTaskEntity.charSet;
}
client.setControlEncoding(charSet);
client.setDataTimeout(STATE.READ_TIME_OUT);
client.enterLocalPassiveMode();
client.setFileType(FTP.BINARY_FILE_TYPE);
client.setRestartOffset(mConfig.START_LOCATION); client.setRestartOffset(mConfig.START_LOCATION);
client.allocate(mBufSize); is = client.retrieveFileStream(remotePath);
is = client.retrieveFileStream(
new String(remotePath.getBytes(charSet), SERVER_CHARSET));
//发送第二次指令时,还需要再做一次判断 //发送第二次指令时,还需要再做一次判断
reply = client.getReplyCode(); int reply = client.getReplyCode();
if (!FTPReply.isPositivePreliminary(reply)) { if (!FTPReply.isPositivePreliminary(reply)) {
client.disconnect(); client.disconnect();
fail(mChildCurrentLocation, "获取文件信息错误,错误码为:" + reply, null); fail(mChildCurrentLocation, "获取文件信息错误,错误码为:" + reply, null);

View File

@@ -18,6 +18,7 @@ package com.arialyy.aria.core.download.downloader;
import android.text.TextUtils; import android.text.TextUtils;
import android.util.Log; import android.util.Log;
import com.arialyy.aria.core.AriaManager; import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.common.OnFileInfoCallback;
import com.arialyy.aria.core.download.DownloadEntity; import com.arialyy.aria.core.download.DownloadEntity;
import com.arialyy.aria.core.download.DownloadTaskEntity; import com.arialyy.aria.core.download.DownloadTaskEntity;
import com.arialyy.aria.util.CommonUtil; import com.arialyy.aria.util.CommonUtil;

View File

@@ -17,6 +17,7 @@
package com.arialyy.aria.core.download.downloader; package com.arialyy.aria.core.download.downloader;
import com.arialyy.aria.core.common.IUtil; import com.arialyy.aria.core.common.IUtil;
import com.arialyy.aria.core.common.OnFileInfoCallback;
import com.arialyy.aria.core.download.DownloadTaskEntity; import com.arialyy.aria.core.download.DownloadTaskEntity;
import com.arialyy.aria.core.inf.AbsTaskEntity; import com.arialyy.aria.core.inf.AbsTaskEntity;
import com.arialyy.aria.core.inf.IDownloadListener; import com.arialyy.aria.core.inf.IDownloadListener;

View File

@@ -19,6 +19,8 @@ import android.os.Parcel;
import android.os.Parcelable; import android.os.Parcelable;
import com.arialyy.aria.orm.DbEntity; import com.arialyy.aria.orm.DbEntity;
import com.arialyy.aria.orm.Ignore; import com.arialyy.aria.orm.Ignore;
import java.util.LinkedList;
import java.util.List;
/** /**
* Created by AriaL on 2017/6/29. * Created by AriaL on 2017/6/29.

View File

@@ -19,10 +19,13 @@ import android.support.annotation.NonNull;
import android.text.TextUtils; import android.text.TextUtils;
import android.util.Log; import android.util.Log;
import com.arialyy.aria.core.AriaManager; import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.command.ICmd;
import com.arialyy.aria.core.command.normal.CancelCmd; import com.arialyy.aria.core.command.normal.CancelCmd;
import com.arialyy.aria.core.command.normal.NormalCmdFactory; import com.arialyy.aria.core.command.normal.NormalCmdFactory;
import com.arialyy.aria.core.common.RequestEnum; import com.arialyy.aria.core.common.RequestEnum;
import com.arialyy.aria.util.CommonUtil; import com.arialyy.aria.util.CommonUtil;
import java.util.ArrayList;
import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
@@ -199,6 +202,16 @@ public abstract class AbsTarget<TARGET extends AbsTarget, ENTITY extends AbsEnti
.exe(); .exe();
} }
/**
* 重试下载
*/
public void reTry() {
List<ICmd> cmds = new ArrayList<>();
cmds.add(CommonUtil.createNormalCmd(mTargetName, mTaskEntity, NormalCmdFactory.TASK_STOP));
cmds.add(CommonUtil.createNormalCmd(mTargetName, mTaskEntity, NormalCmdFactory.TASK_START));
AriaManager.getInstance(AriaManager.APP).setCmds(cmds).exe();
}
/** /**
* 删除任务 * 删除任务
* *
@@ -206,8 +219,8 @@ public abstract class AbsTarget<TARGET extends AbsTarget, ENTITY extends AbsEnti
* {@code false}如果任务已经完成,只删除任务数据库记录, * {@code false}如果任务已经完成,只删除任务数据库记录,
*/ */
public void cancel(boolean removeFile) { public void cancel(boolean removeFile) {
CancelCmd cancelCmd = CancelCmd cancelCmd = (CancelCmd) CommonUtil.createNormalCmd(mTargetName, mTaskEntity,
(CancelCmd) CommonUtil.createNormalCmd(mTargetName, mTaskEntity, NormalCmdFactory.TASK_CANCEL); NormalCmdFactory.TASK_CANCEL);
cancelCmd.removeFile = removeFile; cancelCmd.removeFile = removeFile;
AriaManager.getInstance(AriaManager.APP).setCmd(cancelCmd).exe(); AriaManager.getInstance(AriaManager.APP).setCmd(cancelCmd).exe();
} }

View File

@@ -17,13 +17,13 @@ package com.arialyy.aria.core.inf;
import android.content.Context; import android.content.Context;
import android.os.Handler; import android.os.Handler;
import com.arialyy.aria.orm.Ignore;
import com.arialyy.aria.util.CommonUtil; import com.arialyy.aria.util.CommonUtil;
/** /**
* Created by AriaL on 2017/6/29. * Created by AriaL on 2017/6/29.
*/ */
public abstract class AbsTask<ENTITY extends AbsEntity> implements ITask<ENTITY> { public abstract class AbsTask<ENTITY extends AbsEntity> implements ITask<ENTITY> {
/** /**
* 是否需要重试默认为true * 是否需要重试默认为true
*/ */

View File

@@ -21,6 +21,7 @@ import com.arialyy.aria.core.upload.UploadEntity;
import com.arialyy.aria.core.upload.UploadTask; import com.arialyy.aria.core.upload.UploadTask;
import com.arialyy.aria.core.upload.UploadTaskEntity; import com.arialyy.aria.core.upload.UploadTaskEntity;
import com.arialyy.aria.util.CheckUtil; import com.arialyy.aria.util.CheckUtil;
import com.arialyy.aria.util.CommonUtil;
import java.util.regex.Pattern; import java.util.regex.Pattern;
/** /**
@@ -39,6 +40,7 @@ public abstract class AbsUploadTarget<TARGET extends AbsUploadTarget, ENTITY ext
CheckUtil.checkDownloadUrl(uploadUrl); CheckUtil.checkDownloadUrl(uploadUrl);
if (mEntity.getUrl().equals(uploadUrl)) return (TARGET) this; if (mEntity.getUrl().equals(uploadUrl)) return (TARGET) this;
mEntity.setUrl(uploadUrl); mEntity.setUrl(uploadUrl);
//mEntity.setUrl(CommonUtil.convertUrl(uploadUrl));
mEntity.update(); mEntity.update();
return (TARGET) this; return (TARGET) this;
} }

View File

@@ -18,18 +18,13 @@ package com.arialyy.aria.core.queue;
import android.util.Log; import android.util.Log;
import com.arialyy.aria.core.AriaManager; import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.download.DownloadEntity;
import com.arialyy.aria.core.download.DownloadTask;
import com.arialyy.aria.core.inf.AbsEntity; import com.arialyy.aria.core.inf.AbsEntity;
import com.arialyy.aria.core.inf.AbsTask; import com.arialyy.aria.core.inf.AbsTask;
import com.arialyy.aria.core.inf.AbsTaskEntity; import com.arialyy.aria.core.inf.AbsTaskEntity;
import com.arialyy.aria.core.inf.IEntity; import com.arialyy.aria.core.inf.IEntity;
import com.arialyy.aria.core.queue.pool.BaseCachePool; import com.arialyy.aria.core.queue.pool.BaseCachePool;
import com.arialyy.aria.core.queue.pool.BaseExecutePool; import com.arialyy.aria.core.queue.pool.BaseExecutePool;
import java.security.Key; import com.arialyy.aria.util.NetUtils;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
/** /**
* Created by lyy on 2017/2/23. * Created by lyy on 2017/2/23.
@@ -187,7 +182,11 @@ abstract class AbsTaskQueue<TASK extends AbsTask, TASK_ENTITY extends AbsTaskEnt
@Override public void reTryStart(TASK task) { @Override public void reTryStart(TASK task) {
if (task == null) { if (task == null) {
Log.w(TAG, "重试下载失败task 为null"); Log.w(TAG, "重试失败task 为null");
return;
}
if (!NetUtils.isConnected(AriaManager.APP)){
Log.w(TAG, "重试失败,网络未连接");
return; return;
} }
if (!task.isRunning()) { if (!task.isRunning()) {

View File

@@ -20,9 +20,7 @@ import android.text.TextUtils;
import android.util.Log; import android.util.Log;
import com.arialyy.aria.core.AriaManager; import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.inf.AbsTask; import com.arialyy.aria.core.inf.AbsTask;
import com.arialyy.aria.core.inf.ITask;
import com.arialyy.aria.util.CommonUtil; import com.arialyy.aria.util.CommonUtil;
import java.util.HashMap;
import java.util.Map; import java.util.Map;
import java.util.concurrent.ArrayBlockingQueue; import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentHashMap;
@@ -90,16 +88,18 @@ public class BaseExecutePool<TASK extends AbsTask> implements IPool<TASK> {
* @param maxNum 下载数 * @param maxNum 下载数
*/ */
public void setMaxNum(int maxNum) { public void setMaxNum(int maxNum) {
try { synchronized (AriaManager.LOCK) {
ArrayBlockingQueue<TASK> temp = new ArrayBlockingQueue<>(maxNum); try {
TASK task; ArrayBlockingQueue<TASK> temp = new ArrayBlockingQueue<>(maxNum);
while ((task = mExecuteQueue.poll(TIME_OUT, TimeUnit.MICROSECONDS)) != null) { TASK task;
temp.offer(task); while ((task = mExecuteQueue.poll(TIME_OUT, TimeUnit.MICROSECONDS)) != null) {
temp.offer(task);
}
mExecuteQueue = temp;
mSize = maxNum;
} catch (InterruptedException e) {
e.printStackTrace();
} }
mExecuteQueue = temp;
mSize = maxNum;
} catch (InterruptedException e) {
e.printStackTrace();
} }
} }
@@ -109,33 +109,37 @@ public class BaseExecutePool<TASK extends AbsTask> implements IPool<TASK> {
* @param newTask 新任务 * @param newTask 新任务
*/ */
boolean putNewTask(TASK newTask) { boolean putNewTask(TASK newTask) {
String url = newTask.getKey(); synchronized (AriaManager.LOCK) {
boolean s = mExecuteQueue.offer(newTask); String url = newTask.getKey();
Log.w(TAG, "任务添加" + (s ? "成功" : "失败,【" + url + "")); boolean s = mExecuteQueue.offer(newTask);
if (s) { Log.w(TAG, "任务添加" + (s ? "成功" : "失败,【" + url + ""));
mExecuteMap.put(CommonUtil.keyToHashKey(url), newTask); if (s) {
mExecuteMap.put(CommonUtil.keyToHashKey(url), newTask);
}
return s;
} }
return s;
} }
/** /**
* 队列满时,将移除下载队列中的第一个任务 * 队列满时,将移除下载队列中的第一个任务
*/ */
boolean pollFirstTask() { boolean pollFirstTask() {
try { synchronized (AriaManager.LOCK) {
TASK oldTask = mExecuteQueue.poll(TIME_OUT, TimeUnit.MICROSECONDS); try {
if (oldTask == null) { TASK oldTask = mExecuteQueue.poll(TIME_OUT, TimeUnit.MICROSECONDS);
Log.e(TAG, "移除任务失败"); if (oldTask == null) {
Log.e(TAG, "移除任务失败");
return false;
}
oldTask.stop();
String key = CommonUtil.keyToHashKey(oldTask.getKey());
mExecuteMap.remove(key);
} catch (InterruptedException e) {
e.printStackTrace();
return false; return false;
} }
oldTask.stop(); return true;
String key = CommonUtil.keyToHashKey(oldTask.getKey());
mExecuteMap.remove(key);
} catch (InterruptedException e) {
e.printStackTrace();
return false;
} }
return true;
} }
@Override public TASK pollTask() { @Override public TASK pollTask() {
@@ -185,8 +189,14 @@ public class BaseExecutePool<TASK extends AbsTask> implements IPool<TASK> {
} }
String convertKey = CommonUtil.keyToHashKey(key); String convertKey = CommonUtil.keyToHashKey(key);
TASK task = mExecuteMap.get(convertKey); TASK task = mExecuteMap.get(convertKey);
mExecuteMap.remove(convertKey); final int oldQueueSize = mExecuteQueue.size();
return mExecuteQueue.remove(task); boolean isSuccess = mExecuteQueue.remove(task);
final int newQueueSize = mExecuteQueue.size();
if (isSuccess && newQueueSize != oldQueueSize) {
mExecuteMap.remove(convertKey);
return true;
}
return false;
} }
} }

View File

@@ -41,20 +41,11 @@ abstract class AbsSchedulers<TASK_ENTITY extends AbsTaskEntity, ENTITY extends A
implements ISchedulers<TASK> { implements ISchedulers<TASK> {
private final String TAG = "AbsSchedulers"; private final String TAG = "AbsSchedulers";
static final int DOWNLOAD = 0xa1;
static final int UPLOAD = 0xa2;
static final int DOWNLOAD_GROUP = 0xa3;
protected QUEUE mQueue; protected QUEUE mQueue;
private Map<String, AbsSchedulerListener<TASK, AbsNormalEntity>> mObservers = private Map<String, AbsSchedulerListener<TASK, AbsNormalEntity>> mObservers =
new ConcurrentHashMap<>(); new ConcurrentHashMap<>();
/**
* 设置调度器类型
*/
abstract int getSchedulerType();
/** /**
* 设置代理类后缀名 * 设置代理类后缀名
*/ */
@@ -282,7 +273,7 @@ abstract class AbsSchedulers<TASK_ENTITY extends AbsTaskEntity, ENTITY extends A
/** /**
* 启动下一个任务,条件:任务停止,取消下载,任务完成 * 启动下一个任务,条件:任务停止,取消下载,任务完成
*/ */
protected void startNextTask() { private void startNextTask() {
TASK newTask = mQueue.getNextTask(); TASK newTask = mQueue.getNextTask();
if (newTask == null) { if (newTask == null) {
Log.w(TAG, "没有下一任务"); Log.w(TAG, "没有下一任务");
@@ -292,20 +283,4 @@ abstract class AbsSchedulers<TASK_ENTITY extends AbsTaskEntity, ENTITY extends A
mQueue.startTask(newTask); mQueue.startTask(newTask);
} }
} }
/**
* 是否有下一任务
*
* @return {@code true} 有,{@code false} 无
*/
boolean hasNextTask() {
return mQueue.getCurrentCachePoolNum() > 0;
}
/**
* 获取正在执行的队列数
*/
int getExeTaskNum() {
return mQueue.getCurrentExePoolNum();
}
} }

View File

@@ -43,10 +43,6 @@ public class DownloadGroupSchedulers extends
return INSTANCE; return INSTANCE;
} }
@Override int getSchedulerType() {
return DOWNLOAD_GROUP;
}
@Override String getProxySuffix() { @Override String getProxySuffix() {
return "$$DownloadGroupListenerProxy"; return "$$DownloadGroupListenerProxy";
} }

View File

@@ -45,10 +45,6 @@ public class DownloadSchedulers
return INSTANCE; return INSTANCE;
} }
@Override int getSchedulerType() {
return DOWNLOAD;
}
@Override String getProxySuffix() { @Override String getProxySuffix() {
return "$$DownloadListenerProxy"; return "$$DownloadListenerProxy";
} }

View File

@@ -44,10 +44,6 @@ public class UploadSchedulers
return INSTANCE; return INSTANCE;
} }
@Override int getSchedulerType() {
return UPLOAD;
}
@Override String getProxySuffix() { @Override String getProxySuffix() {
return "$$UploadListenerProxy"; return "$$UploadListenerProxy";
} }

View File

@@ -31,12 +31,14 @@ import java.lang.ref.WeakReference;
class BaseUListener<ENTITY extends AbsEntity, TASK extends AbsTask<ENTITY>> class BaseUListener<ENTITY extends AbsEntity, TASK extends AbsTask<ENTITY>>
implements IUploadListener { implements IUploadListener {
private WeakReference<Handler> outHandler; private WeakReference<Handler> outHandler;
private int RUN_SAVE_INTERVAL = 5 * 1000; //5s保存一次下载中的进度
private long mLastLen = 0; //上一次发送长度 private long mLastLen = 0; //上一次发送长度
private boolean isFirst = true; private boolean isFirst = true;
protected ENTITY mEntity; protected ENTITY mEntity;
protected TASK mTask; protected TASK mTask;
private boolean isConvertSpeed = false; private boolean isConvertSpeed = false;
boolean isWait = false; boolean isWait = false;
private long mLastSaveTime;
BaseUListener(TASK task, Handler outHandler) { BaseUListener(TASK task, Handler outHandler) {
this.outHandler = new WeakReference<>(outHandler); this.outHandler = new WeakReference<>(outHandler);
@@ -45,6 +47,7 @@ class BaseUListener<ENTITY extends AbsEntity, TASK extends AbsTask<ENTITY>>
final AriaManager manager = AriaManager.getInstance(AriaManager.APP); final AriaManager manager = AriaManager.getInstance(AriaManager.APP);
isConvertSpeed = manager.getDownloadConfig().isConvertSpeed(); isConvertSpeed = manager.getDownloadConfig().isConvertSpeed();
mLastLen = mEntity.getCurrentProgress(); mLastLen = mEntity.getCurrentProgress();
mLastSaveTime = System.currentTimeMillis();
} }
@Override public void onPre() { @Override public void onPre() {
@@ -71,6 +74,10 @@ class BaseUListener<ENTITY extends AbsEntity, TASK extends AbsTask<ENTITY>>
} }
handleSpeed(speed); handleSpeed(speed);
sendInState2Target(ISchedulers.RUNNING); sendInState2Target(ISchedulers.RUNNING);
if (System.currentTimeMillis() - mLastSaveTime >= RUN_SAVE_INTERVAL) {
saveData(IEntity.STATE_RUNNING, currentLocation);
mLastSaveTime = System.currentTimeMillis();
}
mLastLen = currentLocation; mLastLen = currentLocation;
} }

View File

@@ -45,6 +45,9 @@ public class FtpUploadTarget
File file = new File(filePath); File file = new File(filePath);
mEntity.setFileName(file.getName()); mEntity.setFileName(file.getName());
mEntity.setFileSize(file.length()); mEntity.setFileSize(file.length());
//暂时不支持断点续传上传
//mTaskEntity.isSupportBP = false;
} }
/** /**

View File

@@ -0,0 +1,74 @@
/*
* Copyright (C) 2016 AriaLyy(https://github.com/AriaLyy/Aria)
*
* Licensed 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 com.arialyy.aria.core.upload.uploader;
import android.support.annotation.NonNull;
import com.arialyy.aria.util.BufferedRandomAccessFile;
import java.io.IOException;
import java.io.InputStream;
/**
* Created by lyy on 2017/9/26.
* BufferedRandomAccessFile 转 InputStream 适配器
*/
final class FtpFISAdapter extends InputStream {
private BufferedRandomAccessFile mIs;
private ProgressCallback mCallback;
private int count;
interface ProgressCallback {
void onProgressCallback(byte[] buffer, int byteOffset, int byteCount) throws IOException;
}
FtpFISAdapter(@NonNull BufferedRandomAccessFile is, @NonNull ProgressCallback callback) {
mIs = is;
mCallback = callback;
}
FtpFISAdapter(@NonNull BufferedRandomAccessFile is) {
mIs = is;
}
@Override public void close() throws IOException {
mIs.close();
}
@Override public int read() throws IOException {
return mIs.read();
}
@Override public int read(@NonNull byte[] buffer) throws IOException {
count = mIs.read(buffer);
if (mCallback != null) {
mCallback.onProgressCallback(buffer, 0, count);
}
return count;
}
@Override public int read(@NonNull byte[] buffer, int byteOffset, int byteCount)
throws IOException {
count = mIs.read(buffer, byteOffset, byteCount);
if (mCallback != null) {
mCallback.onProgressCallback(buffer, byteOffset, byteCount);
}
return count;
}
@Override public long skip(long byteCount) throws IOException {
return mIs.skipBytes((int) byteCount);
}
}

View File

@@ -0,0 +1,78 @@
/*
* Copyright (C) 2016 AriaLyy(https://github.com/AriaLyy/Aria)
*
* Licensed 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 com.arialyy.aria.core.upload.uploader;
import com.arialyy.aria.core.common.AbsFtpInfoThread;
import com.arialyy.aria.core.common.OnFileInfoCallback;
import com.arialyy.aria.core.upload.UploadEntity;
import com.arialyy.aria.core.upload.UploadTaskEntity;
import com.arialyy.aria.util.CommonUtil;
import java.io.File;
import java.util.Properties;
import org.apache.commons.net.ftp.FTPFile;
/**
* Created by Aria.Lao on 2017/9/26.
* 单任务远程服务器文件信息
*/
class FtpFileInfoThread extends AbsFtpInfoThread<UploadEntity, UploadTaskEntity> {
static final int CODE_COMPLETE = 0xab1;
private boolean isComplete = false;
FtpFileInfoThread(UploadTaskEntity taskEntity, OnFileInfoCallback callback) {
super(taskEntity, callback);
}
@Override protected String setRemotePath() {
String url = mEntity.getUrl();
return url.substring(url.indexOf(mPort) + mPort.length(), url.length())
+ "/"
+ mEntity.getFileName();
}
/**
* 如果服务器的文件长度和本地上传文件的文件长度一致,则任务任务已完成。
* 否则重新修改保存的停止位置这是因为outputStream是读不到服务器是否成功写入的。
* 而threadTask的保存的停止位置是File的InputStream的所有就会导致两端停止位置不一致
*
* @param remotePath ftp服务器文件夹路径
* @param ftpFile ftp服务器上对应的文件
*/
@Override protected void handleFile(String remotePath, FTPFile ftpFile) {
super.handleFile(remotePath, ftpFile);
if (ftpFile != null) {
//远程文件已完成
if (ftpFile.getSize() == mEntity.getFileSize()) {
isComplete = true;
} else {
File configFile = new File(CommonUtil.getFileConfigPath(false, mEntity.getFileName()));
Properties pro = CommonUtil.loadConfig(configFile);
String key = mEntity.getFileName() + "_record_" + 0;
long oldRecord = Long.parseLong(pro.getProperty(key, "0"));
if (oldRecord != 0) {
//修改本地保存的停止地址为服务器上的真实地址
pro.setProperty(key, ftpFile.getSize() + "");
CommonUtil.saveConfig(configFile, pro);
}
}
}
}
@Override protected void onPreComplete(int code) {
super.onPreComplete(code);
mCallback.onComplete(mEntity.getKey(), isComplete ? CODE_COMPLETE : code);
}
}

View File

@@ -15,9 +15,8 @@
*/ */
package com.arialyy.aria.core.upload.uploader; package com.arialyy.aria.core.upload.uploader;
import android.text.TextUtils;
import android.util.Log; import android.util.Log;
import com.arialyy.aria.core.common.AbsThreadTask; import com.arialyy.aria.core.common.AbsFtpThreadTask;
import com.arialyy.aria.core.common.StateConstance; import com.arialyy.aria.core.common.StateConstance;
import com.arialyy.aria.core.common.SubThreadConfig; import com.arialyy.aria.core.common.SubThreadConfig;
import com.arialyy.aria.core.inf.IEventListener; import com.arialyy.aria.core.inf.IEventListener;
@@ -26,29 +25,26 @@ import com.arialyy.aria.core.upload.UploadTaskEntity;
import com.arialyy.aria.util.BufferedRandomAccessFile; import com.arialyy.aria.util.BufferedRandomAccessFile;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.io.OutputStream; import java.io.UnsupportedEncodingException;
import org.apache.commons.net.ftp.FTP;
import org.apache.commons.net.ftp.FTPClient; import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPFile;
import org.apache.commons.net.ftp.FTPReply; import org.apache.commons.net.ftp.FTPReply;
import org.apache.commons.net.ftp.OnFtpInputStreamListener;
/** /**
* Created by Aria.Lao on 2017/7/28. * Created by Aria.Lao on 2017/7/28.
* FTP 单线程上传任务需要FTP 服务器给用户打开删除和读入IO的权限 * FTP 单线程上传任务需要FTP 服务器给用户打开删除和读入IO的权限
*/ */
class FtpThreadTask extends AbsThreadTask<UploadEntity, UploadTaskEntity> { class FtpThreadTask extends AbsFtpThreadTask<UploadEntity, UploadTaskEntity> {
private final String TAG = "FtpThreadTask"; private final String TAG = "FtpThreadTask";
private String dir, remotePath, charSet; private String dir, remotePath;
FtpThreadTask(StateConstance constance, IEventListener listener, FtpThreadTask(StateConstance constance, IEventListener listener,
SubThreadConfig<UploadTaskEntity> info) { SubThreadConfig<UploadTaskEntity> info) {
super(constance, listener, info); super(constance, listener, info);
} }
@Override public void run() { @Override public void run() {
FTPClient client = null; FTPClient client = null;
OutputStream os = null;
BufferedRandomAccessFile file = null; BufferedRandomAccessFile file = null;
try { try {
Log.d(TAG, "任务【" Log.d(TAG, "任务【"
@@ -64,22 +60,16 @@ class FtpThreadTask extends AbsThreadTask<UploadEntity, UploadTaskEntity> {
mChildCurrentLocation = mConfig.START_LOCATION; mChildCurrentLocation = mConfig.START_LOCATION;
client = createClient(); client = createClient();
if (client == null) return; if (client == null) return;
initPath();
client.makeDirectory(dir); client.makeDirectory(dir);
client.changeWorkingDirectory(dir); client.changeWorkingDirectory(dir);
client.setRestartOffset(mConfig.START_LOCATION); client.setRestartOffset(mConfig.START_LOCATION);
file = new BufferedRandomAccessFile(mConfig.TEMP_FILE, "rwd", mBufSize); file = new BufferedRandomAccessFile(mConfig.TEMP_FILE, "rwd", mBufSize);
file.seek(mConfig.START_LOCATION); if (mConfig.START_LOCATION != 0) {
if (!isRemoteComplete(client)) { //file.skipBytes((int) mConfig.START_LOCATION);
os = client.storeFileStream(new String(remotePath.getBytes(charSet), SERVER_CHARSET)); file.seek(mConfig.START_LOCATION);
//发送第二次指令时,还需要再做一次判断
int reply = client.getReplyCode();
if (!FTPReply.isPositivePreliminary(reply)) {
client.disconnect();
fail(mChildCurrentLocation, "上传文件错误,错误码为:" + reply, null);
return;
}
upload(file, os);
} }
upload(client, file);
if (STATE.isCancel || STATE.isStop) return; if (STATE.isCancel || STATE.isStop) return;
Log.i(TAG, "任务【" + mConfig.TEMP_FILE.getName() + "】线程__" + mConfig.THREAD_ID + "__上传完毕"); Log.i(TAG, "任务【" + mConfig.TEMP_FILE.getName() + "】线程__" + mConfig.THREAD_ID + "__上传完毕");
writeConfig(true, 1); writeConfig(true, 1);
@@ -101,9 +91,6 @@ class FtpThreadTask extends AbsThreadTask<UploadEntity, UploadTaskEntity> {
if (file != null) { if (file != null) {
file.close(); file.close();
} }
if (os != null) {
os.close();
}
if (client != null && client.isConnected()) { if (client != null && client.isConnected()) {
client.disconnect(); client.disconnect();
} }
@@ -113,78 +100,52 @@ class FtpThreadTask extends AbsThreadTask<UploadEntity, UploadTaskEntity> {
} }
} }
/** private void initPath() throws UnsupportedEncodingException {
* 远程文件是否已经玩飞车 String url = mEntity.getUrl();
* String temp = url.substring(url.indexOf(port) + port.length(), url.length());
* @return true 任务已经完成 dir = new String(temp.getBytes(charSet), SERVER_CHARSET);
*/ remotePath = new String((temp + "/" + mEntity.getFileName()).getBytes(charSet), SERVER_CHARSET);
private boolean isRemoteComplete(FTPClient client) throws IOException {
FTPFile[] files = client.listFiles(new String(remotePath.getBytes(charSet), SERVER_CHARSET));
return files.length != 0 && files[0].getSize() == mEntity.getFileSize();
} }
/** private void upload(final FTPClient client, final BufferedRandomAccessFile bis)
* 执行上传操作 throws IOException {
*/
private void upload(BufferedRandomAccessFile file, OutputStream os) try {
throws IOException, InterruptedException { client.storeFile(remotePath, new FtpFISAdapter(bis), new OnFtpInputStreamListener() {
int len; boolean isStoped = false;
byte[] buffer = new byte[mBufSize];
while ((len = file.read(buffer)) != -1) { @Override public void onFtpInputStream(FTPClient client, long totalBytesTransferred,
if (STATE.isCancel) break; int bytesTransferred, long streamSize) {
if (STATE.isStop) break; if ((STATE.isCancel || STATE.isStop) && !isStoped) {
if (mSleepTime > 0) Thread.sleep(mSleepTime); try {
if (mChildCurrentLocation + len >= mConfig.END_LOCATION) { isStoped = true;
len = (int) (mConfig.END_LOCATION - mChildCurrentLocation); client.abor();
os.write(buffer, 0, len); } catch (IOException e) {
progress(len); e.printStackTrace();
break; }
}
progress(bytesTransferred);
}
});
} catch (IOException e) {
if (e.getMessage().contains("IOException caught while copying")) {
e.printStackTrace();
} else { } else {
os.write(buffer, 0, len); fail(mChildCurrentLocation, "上传失败", e);
progress(len);
} }
} }
}
/**
* 构建FTP客户端
*/
private FTPClient createClient() throws IOException {
String url = mEntity.getUrl();
String[] pp = url.split("/")[2].split(":");
String serverIp = pp[0];
int port = Integer.parseInt(pp[1]);
dir = url.substring(url.indexOf(pp[1]) + pp[1].length(), url.length());
remotePath = dir + "/" + mEntity.getFileName();
FTPClient client = new FTPClient();
client.connect(serverIp, port);
if (!TextUtils.isEmpty(mTaskEntity.account)) {
client.login(mTaskEntity.userName, mTaskEntity.userPw);
} else {
client.login(mTaskEntity.userName, mTaskEntity.userPw, mTaskEntity.account);
}
int reply = client.getReplyCode(); int reply = client.getReplyCode();
if (!FTPReply.isPositiveCompletion(reply)) { if (!FTPReply.isPositiveCompletion(reply)) {
client.disconnect(); if (client.isConnected()) {
fail(STATE.CURRENT_LOCATION, "无法连接到ftp服务器错误码为" + reply, null); client.disconnect();
return null; }
if (reply == FTPReply.TRANSFER_ABORTED) return;
fail(mChildCurrentLocation, "上传文件错误,错误码为:" + reply, null);
} }
charSet = "UTF-8";
// 开启服务器对UTF-8的支持如果服务器支持就用UTF-8编码
if (!TextUtils.isEmpty(mTaskEntity.charSet) || !FTPReply.isPositiveCompletion(
client.sendCommand("OPTS UTF8", "ON"))) {
charSet = mTaskEntity.charSet;
}
client.setControlEncoding(charSet);
client.setDataTimeout(STATE.READ_TIME_OUT);
client.enterLocalPassiveMode();
client.setFileType(FTP.BINARY_FILE_TYPE);
client.allocate(mBufSize);
return client;
} }
@Override protected String getTaskType() { @Override protected String getTaskType() {
return "FTP_UPLOAD"; return "FTP_UPLOAD";
} }
} }

View File

@@ -16,6 +16,7 @@
package com.arialyy.aria.core.upload.uploader; package com.arialyy.aria.core.upload.uploader;
import com.arialyy.aria.core.common.IUtil; import com.arialyy.aria.core.common.IUtil;
import com.arialyy.aria.core.common.OnFileInfoCallback;
import com.arialyy.aria.core.inf.IUploadListener; import com.arialyy.aria.core.inf.IUploadListener;
import com.arialyy.aria.core.upload.UploadEntity; import com.arialyy.aria.core.upload.UploadEntity;
import com.arialyy.aria.core.upload.UploadTaskEntity; import com.arialyy.aria.core.upload.UploadTaskEntity;
@@ -46,7 +47,19 @@ public class SimpleUploadUtil implements IUtil, Runnable {
@Override public void run() { @Override public void run() {
mListener.onPre(); mListener.onPre();
mUploader.start(); new FtpFileInfoThread(mTaskEntity, new OnFileInfoCallback() {
@Override public void onComplete(String url, int code) {
if (code == FtpFileInfoThread.CODE_COMPLETE) {
mListener.onComplete();
} else {
mUploader.start();
}
}
@Override public void onFail(String url, String errorMsg) {
mListener.onFail(true);
}
}).start();
} }
@Override public long getFileSize() { @Override public long getFileSize() {

View File

@@ -15,7 +15,6 @@
*/ */
package com.arialyy.aria.core.upload.uploader; package com.arialyy.aria.core.upload.uploader;
import com.arialyy.aria.core.AriaManager;
import com.arialyy.aria.core.common.AbsFileer; import com.arialyy.aria.core.common.AbsFileer;
import com.arialyy.aria.core.common.AbsThreadTask; import com.arialyy.aria.core.common.AbsThreadTask;
import com.arialyy.aria.core.common.SubThreadConfig; import com.arialyy.aria.core.common.SubThreadConfig;
@@ -47,10 +46,7 @@ class Uploader extends AbsFileer<UploadEntity, UploadTaskEntity> {
* 5、不支持断点则是新任务 * 5、不支持断点则是新任务
*/ */
protected void checkTask() { protected void checkTask() {
mConfigFile = new File(mContext.getFilesDir().getPath() mConfigFile = new File(CommonUtil.getFileConfigPath(false, mEntity.getFileName()));
+ AriaManager.UPLOAD_TEMP_DIR
+ mEntity.getFileName()
+ ".properties");
if (!mTaskEntity.isSupportBP) { if (!mTaskEntity.isSupportBP) {
isNewTask = true; isNewTask = true;
return; return;

View File

@@ -230,7 +230,7 @@ final class SqlHelper extends SQLiteOpenHelper {
} }
/** /**
* 遍历所有数据 * 查找表的所有数据
*/ */
static synchronized <T extends DbEntity> List<T> findAllData(SQLiteDatabase db, Class<T> clazz) { static synchronized <T extends DbEntity> List<T> findAllData(SQLiteDatabase db, Class<T> clazz) {
db = checkDb(db); db = checkDb(db);

View File

@@ -266,7 +266,7 @@ public class CommonUtil {
file.delete(); file.delete();
} }
} }
File config = new File(getFileConfig(false, uEntity.getFileName())); File config = new File(getFileConfigPath(false, uEntity.getFileName()));
if (config.exists()) { if (config.exists()) {
config.delete(); config.delete();
} }
@@ -296,7 +296,7 @@ public class CommonUtil {
} }
} }
File config = new File(getFileConfig(true, dEntity.getFileName())); File config = new File(getFileConfigPath(true, dEntity.getFileName()));
if (config.exists()) { if (config.exists()) {
config.delete(); config.delete();
} }
@@ -705,6 +705,7 @@ public class CommonUtil {
* 设置打印的异常格式 * 设置打印的异常格式
*/ */
public static String getPrintException(Throwable ex) { public static String getPrintException(Throwable ex) {
if (ex == null) return "";
StringBuilder err = new StringBuilder(); StringBuilder err = new StringBuilder();
err.append("ExceptionDetailed:\n"); err.append("ExceptionDetailed:\n");
err.append("====================Exception Info====================\n"); err.append("====================Exception Info====================\n");
@@ -729,11 +730,11 @@ public class CommonUtil {
} }
/** /**
* 通过文件名获取下载配置文件 * 通过文件名获取下载配置文件路径
* *
* @param fileName 文件名 * @param fileName 文件名
*/ */
public static String getFileConfig(boolean isDownload, String fileName) { public static String getFileConfigPath(boolean isDownload, String fileName) {
return AriaManager.APP.getFilesDir().getPath() + (isDownload ? AriaManager.DOWNLOAD_TEMP_DIR return AriaManager.APP.getFilesDir().getPath() + (isDownload ? AriaManager.DOWNLOAD_TEMP_DIR
: AriaManager.UPLOAD_TEMP_DIR) + fileName + ".properties"; : AriaManager.UPLOAD_TEMP_DIR) + fileName + ".properties";
} }
@@ -764,8 +765,8 @@ public class CommonUtil {
private static void renameConfig(boolean isDownload, String oldName, String newName) { private static void renameConfig(boolean isDownload, String oldName, String newName) {
if (oldName.equals(newName)) return; if (oldName.equals(newName)) return;
File oldFile = new File(getFileConfig(isDownload, oldName)); File oldFile = new File(getFileConfigPath(isDownload, oldName));
File newFile = new File(getFileConfig(isDownload, oldName)); File newFile = new File(getFileConfigPath(isDownload, oldName));
if (!oldFile.exists()) { if (!oldFile.exists()) {
createFile(newFile.getPath()); createFile(newFile.getPath());
} else { } else {

View File

@@ -0,0 +1,136 @@
/*
* 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 com.arialyy.aria.util;
import android.content.Context;
import android.net.ConnectivityManager;
import android.net.NetworkInfo;
import android.telephony.TelephonyManager;
import android.text.TextUtils;
/**
* 跟网络相关的工具类
*/
public class NetUtils {
/**
* 没有网络
*/
public static final int NETWORK_TYPE_INVALID = 0;
/**
* wap网络
*/
public static final int NETWORK_TYPE_WAP = 1;
/**
* 2G网络
*/
public static final int NETWORK_TYPE_2G = 2;
/**
* 3G和3G以上网络或统称为快速网络
*/
public static final int NETWORK_TYPE_3G = 3;
/**
* wifi网络
*/
public static final int NETWORK_TYPE_WIFI = 4;
/**
* 判断网络是否连接
*/
public static boolean isConnected(Context context) {
ConnectivityManager cm =
(ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
NetworkInfo ni = cm.getActiveNetworkInfo();
return ni != null && ni.isConnectedOrConnecting();
}
/**
* 判断是否是wifi连接
*/
public static boolean isWifi(Context context) {
return getNetWorkType(context) == NETWORK_TYPE_WIFI;
}
/**
* 获取网络状态wifi,wap,2g,3g.
*
* @param context 上下文
* @return int 网络状态 {@link #NETWORK_TYPE_2G},{@link #NETWORK_TYPE_3G},
* {@link #NETWORK_TYPE_INVALID},{@link #NETWORK_TYPE_WAP},{@link #NETWORK_TYPE_WIFI}
*/
public static int getNetWorkType(Context context) {
int netWorkType = -1;
ConnectivityManager manager =
(ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
NetworkInfo networkInfo = manager.getActiveNetworkInfo();
if (networkInfo != null && networkInfo.isConnected()) {
String type = networkInfo.getTypeName();
if (type.equalsIgnoreCase("WIFI")) {
netWorkType = NETWORK_TYPE_WIFI;
} else if (type.equalsIgnoreCase("MOBILE")) {
String proxyHost = android.net.Proxy.getDefaultHost();
netWorkType = TextUtils.isEmpty(proxyHost) ? (isFastMobileNetwork(context) ? NETWORK_TYPE_3G
: NETWORK_TYPE_2G) : NETWORK_TYPE_WAP;
}
} else {
netWorkType = NETWORK_TYPE_INVALID;
}
return netWorkType;
}
private static boolean isFastMobileNetwork(Context context) {
TelephonyManager telephonyManager =
(TelephonyManager) context.getSystemService(Context.TELEPHONY_SERVICE);
switch (telephonyManager.getNetworkType()) {
case TelephonyManager.NETWORK_TYPE_1xRTT:
return false; // ~ 50-100 kbps
case TelephonyManager.NETWORK_TYPE_CDMA:
return false; // ~ 14-64 kbps
case TelephonyManager.NETWORK_TYPE_EDGE:
return false; // ~ 50-100 kbps
case TelephonyManager.NETWORK_TYPE_EVDO_0:
return true; // ~ 400-1000 kbps
case TelephonyManager.NETWORK_TYPE_EVDO_A:
return true; // ~ 600-1400 kbps
case TelephonyManager.NETWORK_TYPE_GPRS:
return false; // ~ 100 kbps
case TelephonyManager.NETWORK_TYPE_HSDPA:
return true; // ~ 2-14 Mbps
case TelephonyManager.NETWORK_TYPE_HSPA:
return true; // ~ 700-1700 kbps
case TelephonyManager.NETWORK_TYPE_HSUPA:
return true; // ~ 1-23 Mbps
case TelephonyManager.NETWORK_TYPE_UMTS:
return true; // ~ 400-7000 kbps
case TelephonyManager.NETWORK_TYPE_EHRPD:
return true; // ~ 1-2 Mbps
case TelephonyManager.NETWORK_TYPE_EVDO_B:
return true; // ~ 5 Mbps
case TelephonyManager.NETWORK_TYPE_HSPAP:
return true; // ~ 10-20 Mbps
case TelephonyManager.NETWORK_TYPE_IDEN:
return false; // ~25 kbps
case TelephonyManager.NETWORK_TYPE_LTE:
return true; // ~ 10+ Mbps
case TelephonyManager.NETWORK_TYPE_UNKNOWN:
return false;
default:
return false;
}
}
}

View File

@@ -3,7 +3,7 @@ publish {
artifactId = 'aria-ftp-plug' artifactId = 'aria-ftp-plug'
userOrg = rootProject.userOrg userOrg = rootProject.userOrg
groupId = rootProject.groupId groupId = rootProject.groupId
uploadName = 'AriaFtpPlug' uploadName = 'FtpPlug'
publishVersion = rootProject.publishVersion publishVersion = rootProject.publishVersion
description = rootProject.description description = rootProject.description
website = rootProject.website website = rootProject.website

View File

@@ -47,268 +47,241 @@ import java.nio.charset.Charset;
* @see DatagramSocketFactory * @see DatagramSocketFactory
***/ ***/
public abstract class DatagramSocketClient public abstract class DatagramSocketClient {
{ /***
/*** * The default DatagramSocketFactory shared by all DatagramSocketClient
* The default DatagramSocketFactory shared by all DatagramSocketClient * instances.
* instances. ***/
***/ private static final DatagramSocketFactory __DEFAULT_SOCKET_FACTORY =
private static final DatagramSocketFactory __DEFAULT_SOCKET_FACTORY = new DefaultDatagramSocketFactory();
new DefaultDatagramSocketFactory();
/** /**
* Charset to use for byte IO. * Charset to use for byte IO.
*/ */
private Charset charset = Charset.defaultCharset(); private Charset charset = Charset.defaultCharset();
/*** The timeout to use after opening a socket. ***/ /*** The timeout to use after opening a socket. ***/
protected int _timeout_; protected int _timeout_;
/*** The datagram socket used for the connection. ***/ /*** The datagram socket used for the connection. ***/
protected DatagramSocket _socket_; protected DatagramSocket _socket_;
/*** /***
* A status variable indicating if the client's socket is currently open. * A status variable indicating if the client's socket is currently open.
***/ ***/
protected boolean _isOpen_; protected boolean _isOpen_;
/*** The datagram socket's DatagramSocketFactory. ***/ /*** The datagram socket's DatagramSocketFactory. ***/
protected DatagramSocketFactory _socketFactory_; protected DatagramSocketFactory _socketFactory_;
/*** /***
* Default constructor for DatagramSocketClient. Initializes * Default constructor for DatagramSocketClient. Initializes
* _socket_ to null, _timeout_ to 0, and _isOpen_ to false. * _socket_ to null, _timeout_ to 0, and _isOpen_ to false.
***/ ***/
public DatagramSocketClient() public DatagramSocketClient() {
{ _socket_ = null;
_socket_ = null; _timeout_ = 0;
_timeout_ = 0; _isOpen_ = false;
_isOpen_ = false; _socketFactory_ = __DEFAULT_SOCKET_FACTORY;
_socketFactory_ = __DEFAULT_SOCKET_FACTORY; }
/***
* Opens a DatagramSocket on the local host at the first available port.
* Also sets the timeout on the socket to the default timeout set
* by {@link #setDefaultTimeout setDefaultTimeout() }.
* <p>
* _isOpen_ is set to true after calling this method and _socket_
* is set to the newly opened socket.
*
* @throws SocketException If the socket could not be opened or the
* timeout could not be set.
***/
public void open() throws SocketException {
_socket_ = _socketFactory_.createDatagramSocket();
_socket_.setSoTimeout(_timeout_);
_isOpen_ = true;
}
/***
* Opens a DatagramSocket on the local host at a specified port.
* Also sets the timeout on the socket to the default timeout set
* by {@link #setDefaultTimeout setDefaultTimeout() }.
* <p>
* _isOpen_ is set to true after calling this method and _socket_
* is set to the newly opened socket.
*
* @param port The port to use for the socket.
* @throws SocketException If the socket could not be opened or the
* timeout could not be set.
***/
public void open(int port) throws SocketException {
_socket_ = _socketFactory_.createDatagramSocket(port);
_socket_.setSoTimeout(_timeout_);
_isOpen_ = true;
}
/***
* Opens a DatagramSocket at the specified address on the local host
* at a specified port.
* Also sets the timeout on the socket to the default timeout set
* by {@link #setDefaultTimeout setDefaultTimeout() }.
* <p>
* _isOpen_ is set to true after calling this method and _socket_
* is set to the newly opened socket.
*
* @param port The port to use for the socket.
* @param laddr The local address to use.
* @throws SocketException If the socket could not be opened or the
* timeout could not be set.
***/
public void open(int port, InetAddress laddr) throws SocketException {
_socket_ = _socketFactory_.createDatagramSocket(port, laddr);
_socket_.setSoTimeout(_timeout_);
_isOpen_ = true;
}
/***
* Closes the DatagramSocket used for the connection.
* You should call this method after you've finished using the class
* instance and also before you call {@link #open open() }
* again. _isOpen_ is set to false and _socket_ is set to null.
***/
public void close() {
if (_socket_ != null) {
_socket_.close();
} }
_socket_ = null;
_isOpen_ = false;
}
/***
* Returns true if the client has a currently open socket.
*
* @return True if the client has a currently open socket, false otherwise.
***/
public boolean isOpen() {
return _isOpen_;
}
/*** /***
* Opens a DatagramSocket on the local host at the first available port. * Set the default timeout in milliseconds to use when opening a socket.
* Also sets the timeout on the socket to the default timeout set * After a call to open, the timeout for the socket is set using this value.
* by {@link #setDefaultTimeout setDefaultTimeout() }. * This method should be used prior to a call to {@link #open open()}
* <p> * and should not be confused with {@link #setSoTimeout setSoTimeout()}
* _isOpen_ is set to true after calling this method and _socket_ * which operates on the currently open socket. _timeout_ contains
* is set to the newly opened socket. * the new timeout value.
* *
* @throws SocketException If the socket could not be opened or the * @param timeout The timeout in milliseconds to use for the datagram socket
* timeout could not be set. * connection.
***/ ***/
public void open() throws SocketException public void setDefaultTimeout(int timeout) {
{ _timeout_ = timeout;
_socket_ = _socketFactory_.createDatagramSocket(); }
_socket_.setSoTimeout(_timeout_);
_isOpen_ = true; /***
* Returns the default timeout in milliseconds that is used when
* opening a socket.
*
* @return The default timeout in milliseconds that is used when
* opening a socket.
***/
public int getDefaultTimeout() {
return _timeout_;
}
/***
* Set the timeout in milliseconds of a currently open connection.
* Only call this method after a connection has been opened
* by {@link #open open()}.
*
* @param timeout The timeout in milliseconds to use for the currently
* open datagram socket connection.
* @throws SocketException if an error setting the timeout
***/
public void setSoTimeout(int timeout) throws SocketException {
_socket_.setSoTimeout(timeout);
}
/***
* Returns the timeout in milliseconds of the currently opened socket.
* If you call this method when the client socket is not open,
* a NullPointerException is thrown.
*
* @return The timeout in milliseconds of the currently opened socket.
* @throws SocketException if an error getting the timeout
***/
public int getSoTimeout() throws SocketException {
return _socket_.getSoTimeout();
}
/***
* Returns the port number of the open socket on the local host used
* for the connection. If you call this method when the client socket
* is not open, a NullPointerException is thrown.
*
* @return The port number of the open socket on the local host used
* for the connection.
***/
public int getLocalPort() {
return _socket_.getLocalPort();
}
/***
* Returns the local address to which the client's socket is bound.
* If you call this method when the client socket is not open, a
* NullPointerException is thrown.
*
* @return The local address to which the client's socket is bound.
***/
public InetAddress getLocalAddress() {
return _socket_.getLocalAddress();
}
/***
* Sets the DatagramSocketFactory used by the DatagramSocketClient
* to open DatagramSockets. If the factory value is null, then a default
* factory is used (only do this to reset the factory after having
* previously altered it).
*
* @param factory The new DatagramSocketFactory the DatagramSocketClient
* should use.
***/
public void setDatagramSocketFactory(DatagramSocketFactory factory) {
if (factory == null) {
_socketFactory_ = __DEFAULT_SOCKET_FACTORY;
} else {
_socketFactory_ = factory;
} }
}
/**
* Gets the charset name.
*
* @return the charset name.
* @since 3.3
* TODO Will be deprecated once the code requires Java 1.6 as a mininmum
*/
public String getCharsetName() {
return charset.name();
}
/*** /**
* Opens a DatagramSocket on the local host at a specified port. * Gets the charset.
* Also sets the timeout on the socket to the default timeout set *
* by {@link #setDefaultTimeout setDefaultTimeout() }. * @return the charset.
* <p> * @since 3.3
* _isOpen_ is set to true after calling this method and _socket_ */
* is set to the newly opened socket. public Charset getCharset() {
* return charset;
* @param port The port to use for the socket. }
* @throws SocketException If the socket could not be opened or the
* timeout could not be set.
***/
public void open(int port) throws SocketException
{
_socket_ = _socketFactory_.createDatagramSocket(port);
_socket_.setSoTimeout(_timeout_);
_isOpen_ = true;
}
/**
/*** * Sets the charset.
* Opens a DatagramSocket at the specified address on the local host *
* at a specified port. * @param charset the charset.
* Also sets the timeout on the socket to the default timeout set * @since 3.3
* by {@link #setDefaultTimeout setDefaultTimeout() }. */
* <p> public void setCharset(Charset charset) {
* _isOpen_ is set to true after calling this method and _socket_ this.charset = charset;
* is set to the newly opened socket. }
*
* @param port The port to use for the socket.
* @param laddr The local address to use.
* @throws SocketException If the socket could not be opened or the
* timeout could not be set.
***/
public void open(int port, InetAddress laddr) throws SocketException
{
_socket_ = _socketFactory_.createDatagramSocket(port, laddr);
_socket_.setSoTimeout(_timeout_);
_isOpen_ = true;
}
/***
* Closes the DatagramSocket used for the connection.
* You should call this method after you've finished using the class
* instance and also before you call {@link #open open() }
* again. _isOpen_ is set to false and _socket_ is set to null.
***/
public void close()
{
if (_socket_ != null) {
_socket_.close();
}
_socket_ = null;
_isOpen_ = false;
}
/***
* Returns true if the client has a currently open socket.
*
* @return True if the client has a currently open socket, false otherwise.
***/
public boolean isOpen()
{
return _isOpen_;
}
/***
* Set the default timeout in milliseconds to use when opening a socket.
* After a call to open, the timeout for the socket is set using this value.
* This method should be used prior to a call to {@link #open open()}
* and should not be confused with {@link #setSoTimeout setSoTimeout()}
* which operates on the currently open socket. _timeout_ contains
* the new timeout value.
*
* @param timeout The timeout in milliseconds to use for the datagram socket
* connection.
***/
public void setDefaultTimeout(int timeout)
{
_timeout_ = timeout;
}
/***
* Returns the default timeout in milliseconds that is used when
* opening a socket.
*
* @return The default timeout in milliseconds that is used when
* opening a socket.
***/
public int getDefaultTimeout()
{
return _timeout_;
}
/***
* Set the timeout in milliseconds of a currently open connection.
* Only call this method after a connection has been opened
* by {@link #open open()}.
*
* @param timeout The timeout in milliseconds to use for the currently
* open datagram socket connection.
* @throws SocketException if an error setting the timeout
***/
public void setSoTimeout(int timeout) throws SocketException
{
_socket_.setSoTimeout(timeout);
}
/***
* Returns the timeout in milliseconds of the currently opened socket.
* If you call this method when the client socket is not open,
* a NullPointerException is thrown.
*
* @return The timeout in milliseconds of the currently opened socket.
* @throws SocketException if an error getting the timeout
***/
public int getSoTimeout() throws SocketException
{
return _socket_.getSoTimeout();
}
/***
* Returns the port number of the open socket on the local host used
* for the connection. If you call this method when the client socket
* is not open, a NullPointerException is thrown.
*
* @return The port number of the open socket on the local host used
* for the connection.
***/
public int getLocalPort()
{
return _socket_.getLocalPort();
}
/***
* Returns the local address to which the client's socket is bound.
* If you call this method when the client socket is not open, a
* NullPointerException is thrown.
*
* @return The local address to which the client's socket is bound.
***/
public InetAddress getLocalAddress()
{
return _socket_.getLocalAddress();
}
/***
* Sets the DatagramSocketFactory used by the DatagramSocketClient
* to open DatagramSockets. If the factory value is null, then a default
* factory is used (only do this to reset the factory after having
* previously altered it).
*
* @param factory The new DatagramSocketFactory the DatagramSocketClient
* should use.
***/
public void setDatagramSocketFactory(DatagramSocketFactory factory)
{
if (factory == null) {
_socketFactory_ = __DEFAULT_SOCKET_FACTORY;
} else {
_socketFactory_ = factory;
}
}
/**
* Gets the charset name.
*
* @return the charset name.
* @since 3.3
* TODO Will be deprecated once the code requires Java 1.6 as a mininmum
*/
public String getCharsetName() {
return charset.name();
}
/**
* Gets the charset.
*
* @return the charset.
* @since 3.3
*/
public Charset getCharset() {
return charset;
}
/**
* Sets the charset.
*
* @param charset the charset.
* @since 3.3
*/
public void setCharset(Charset charset) {
this.charset = charset;
}
} }

View File

@@ -35,35 +35,33 @@ import java.net.SocketException;
* *
***/ ***/
public interface DatagramSocketFactory public interface DatagramSocketFactory {
{
/*** /***
* Creates a DatagramSocket on the local host at the first available port. * Creates a DatagramSocket on the local host at the first available port.
* @return the socket * @return the socket
* *
* @throws SocketException If the socket could not be created. * @throws SocketException If the socket could not be created.
***/ ***/
public DatagramSocket createDatagramSocket() throws SocketException; public DatagramSocket createDatagramSocket() throws SocketException;
/*** /***
* Creates a DatagramSocket on the local host at a specified port. * Creates a DatagramSocket on the local host at a specified port.
* *
* @param port The port to use for the socket. * @param port The port to use for the socket.
* @return the socket * @return the socket
* @throws SocketException If the socket could not be created. * @throws SocketException If the socket could not be created.
***/ ***/
public DatagramSocket createDatagramSocket(int port) throws SocketException; public DatagramSocket createDatagramSocket(int port) throws SocketException;
/*** /***
* Creates a DatagramSocket at the specified address on the local host * Creates a DatagramSocket at the specified address on the local host
* at a specified port. * at a specified port.
* *
* @param port The port to use for the socket. * @param port The port to use for the socket.
* @param laddr The local address to use. * @param laddr The local address to use.
* @return the socket * @return the socket
* @throws SocketException If the socket could not be created. * @throws SocketException If the socket could not be created.
***/ ***/
public DatagramSocket createDatagramSocket(int port, InetAddress laddr) public DatagramSocket createDatagramSocket(int port, InetAddress laddr) throws SocketException;
throws SocketException;
} }

View File

@@ -34,46 +34,39 @@ import java.net.SocketException;
* @see DatagramSocketClient#setDatagramSocketFactory * @see DatagramSocketClient#setDatagramSocketFactory
***/ ***/
public class DefaultDatagramSocketFactory implements DatagramSocketFactory public class DefaultDatagramSocketFactory implements DatagramSocketFactory {
{
/*** /***
* Creates a DatagramSocket on the local host at the first available port. * Creates a DatagramSocket on the local host at the first available port.
* @return a new DatagramSocket * @return a new DatagramSocket
* @throws SocketException If the socket could not be created. * @throws SocketException If the socket could not be created.
***/ ***/
@Override @Override public DatagramSocket createDatagramSocket() throws SocketException {
public DatagramSocket createDatagramSocket() throws SocketException return new DatagramSocket();
{ }
return new DatagramSocket();
}
/*** /***
* Creates a DatagramSocket on the local host at a specified port. * Creates a DatagramSocket on the local host at a specified port.
* *
* @param port The port to use for the socket. * @param port The port to use for the socket.
* @return a new DatagramSocket * @return a new DatagramSocket
* @throws SocketException If the socket could not be created. * @throws SocketException If the socket could not be created.
***/ ***/
@Override @Override public DatagramSocket createDatagramSocket(int port) throws SocketException {
public DatagramSocket createDatagramSocket(int port) throws SocketException return new DatagramSocket(port);
{ }
return new DatagramSocket(port);
}
/*** /***
* Creates a DatagramSocket at the specified address on the local host * Creates a DatagramSocket at the specified address on the local host
* at a specified port. * at a specified port.
* *
* @param port The port to use for the socket. * @param port The port to use for the socket.
* @param laddr The local address to use. * @param laddr The local address to use.
* @return a new DatagramSocket * @return a new DatagramSocket
* @throws SocketException If the socket could not be created. * @throws SocketException If the socket could not be created.
***/ ***/
@Override @Override public DatagramSocket createDatagramSocket(int port, InetAddress laddr)
public DatagramSocket createDatagramSocket(int port, InetAddress laddr) throws SocketException {
throws SocketException return new DatagramSocket(port, laddr);
{ }
return new DatagramSocket(port, laddr);
}
} }

View File

@@ -40,191 +40,165 @@ import javax.net.SocketFactory;
* @see SocketClient#setSocketFactory * @see SocketClient#setSocketFactory
***/ ***/
public class DefaultSocketFactory extends SocketFactory public class DefaultSocketFactory extends SocketFactory {
{ /** The proxy to use when creating new sockets. */
/** The proxy to use when creating new sockets. */ private final Proxy connProxy;
private final Proxy connProxy;
/** /**
* The default constructor. * The default constructor.
*/ */
public DefaultSocketFactory() public DefaultSocketFactory() {
{ this(null);
this(null); }
}
/** /**
* A constructor for sockets with proxy support. * A constructor for sockets with proxy support.
* *
* @param proxy The Proxy to use when creating new Sockets. * @param proxy The Proxy to use when creating new Sockets.
* @since 3.2 * @since 3.2
*/ */
public DefaultSocketFactory(Proxy proxy) public DefaultSocketFactory(Proxy proxy) {
{ connProxy = proxy;
connProxy = proxy; }
}
/** /**
* Creates an unconnected Socket. * Creates an unconnected Socket.
* *
* @return A new unconnected Socket. * @return A new unconnected Socket.
* @throws IOException If an I/O error occurs while creating the Socket. * @throws IOException If an I/O error occurs while creating the Socket.
* @since 3.2 * @since 3.2
*/ */
@Override @Override public Socket createSocket() throws IOException {
public Socket createSocket() throws IOException if (connProxy != null) {
{ return new Socket(connProxy);
if (connProxy != null)
{
return new Socket(connProxy);
}
return new Socket();
} }
return new Socket();
}
/*** /***
* Creates a Socket connected to the given host and port. * Creates a Socket connected to the given host and port.
* *
* @param host The hostname to connect to. * @param host The hostname to connect to.
* @param port The port to connect to. * @param port The port to connect to.
* @return A Socket connected to the given host and port. * @return A Socket connected to the given host and port.
* @throws UnknownHostException If the hostname cannot be resolved. * @throws UnknownHostException If the hostname cannot be resolved.
* @throws IOException If an I/O error occurs while creating the Socket. * @throws IOException If an I/O error occurs while creating the Socket.
***/ ***/
@Override @Override public Socket createSocket(String host, int port)
public Socket createSocket(String host, int port) throws UnknownHostException, IOException {
throws UnknownHostException, IOException if (connProxy != null) {
{ Socket s = new Socket(connProxy);
if (connProxy != null) s.connect(new InetSocketAddress(host, port));
{ return s;
Socket s = new Socket(connProxy);
s.connect(new InetSocketAddress(host, port));
return s;
}
return new Socket(host, port);
} }
return new Socket(host, port);
}
/*** /***
* Creates a Socket connected to the given host and port. * Creates a Socket connected to the given host and port.
* *
* @param address The address of the host to connect to. * @param address The address of the host to connect to.
* @param port The port to connect to. * @param port The port to connect to.
* @return A Socket connected to the given host and port. * @return A Socket connected to the given host and port.
* @throws IOException If an I/O error occurs while creating the Socket. * @throws IOException If an I/O error occurs while creating the Socket.
***/ ***/
@Override @Override public Socket createSocket(InetAddress address, int port) throws IOException {
public Socket createSocket(InetAddress address, int port) if (connProxy != null) {
throws IOException Socket s = new Socket(connProxy);
{ s.connect(new InetSocketAddress(address, port));
if (connProxy != null) return s;
{
Socket s = new Socket(connProxy);
s.connect(new InetSocketAddress(address, port));
return s;
}
return new Socket(address, port);
} }
return new Socket(address, port);
}
/*** /***
* Creates a Socket connected to the given host and port and * Creates a Socket connected to the given host and port and
* originating from the specified local address and port. * originating from the specified local address and port.
* *
* @param host The hostname to connect to. * @param host The hostname to connect to.
* @param port The port to connect to. * @param port The port to connect to.
* @param localAddr The local address to use. * @param localAddr The local address to use.
* @param localPort The local port to use. * @param localPort The local port to use.
* @return A Socket connected to the given host and port. * @return A Socket connected to the given host and port.
* @throws UnknownHostException If the hostname cannot be resolved. * @throws UnknownHostException If the hostname cannot be resolved.
* @throws IOException If an I/O error occurs while creating the Socket. * @throws IOException If an I/O error occurs while creating the Socket.
***/ ***/
@Override @Override public Socket createSocket(String host, int port, InetAddress localAddr, int localPort)
public Socket createSocket(String host, int port, throws UnknownHostException, IOException {
InetAddress localAddr, int localPort) if (connProxy != null) {
throws UnknownHostException, IOException Socket s = new Socket(connProxy);
{ s.bind(new InetSocketAddress(localAddr, localPort));
if (connProxy != null) s.connect(new InetSocketAddress(host, port));
{ return s;
Socket s = new Socket(connProxy);
s.bind(new InetSocketAddress(localAddr, localPort));
s.connect(new InetSocketAddress(host, port));
return s;
}
return new Socket(host, port, localAddr, localPort);
} }
return new Socket(host, port, localAddr, localPort);
}
/*** /***
* Creates a Socket connected to the given host and port and * Creates a Socket connected to the given host and port and
* originating from the specified local address and port. * originating from the specified local address and port.
* *
* @param address The address of the host to connect to. * @param address The address of the host to connect to.
* @param port The port to connect to. * @param port The port to connect to.
* @param localAddr The local address to use. * @param localAddr The local address to use.
* @param localPort The local port to use. * @param localPort The local port to use.
* @return A Socket connected to the given host and port. * @return A Socket connected to the given host and port.
* @throws IOException If an I/O error occurs while creating the Socket. * @throws IOException If an I/O error occurs while creating the Socket.
***/ ***/
@Override @Override public Socket createSocket(InetAddress address, int port, InetAddress localAddr,
public Socket createSocket(InetAddress address, int port, int localPort) throws IOException {
InetAddress localAddr, int localPort) if (connProxy != null) {
throws IOException Socket s = new Socket(connProxy);
{ s.bind(new InetSocketAddress(localAddr, localPort));
if (connProxy != null) s.connect(new InetSocketAddress(address, port));
{ return s;
Socket s = new Socket(connProxy);
s.bind(new InetSocketAddress(localAddr, localPort));
s.connect(new InetSocketAddress(address, port));
return s;
}
return new Socket(address, port, localAddr, localPort);
} }
return new Socket(address, port, localAddr, localPort);
}
/*** /***
* Creates a ServerSocket bound to a specified port. A port * Creates a ServerSocket bound to a specified port. A port
* of 0 will create the ServerSocket on a system-determined free port. * of 0 will create the ServerSocket on a system-determined free port.
* *
* @param port The port on which to listen, or 0 to use any free port. * @param port The port on which to listen, or 0 to use any free port.
* @return A ServerSocket that will listen on a specified port. * @return A ServerSocket that will listen on a specified port.
* @throws IOException If an I/O error occurs while creating * @throws IOException If an I/O error occurs while creating
* the ServerSocket. * the ServerSocket.
***/ ***/
public ServerSocket createServerSocket(int port) throws IOException public ServerSocket createServerSocket(int port) throws IOException {
{ return new ServerSocket(port);
return new ServerSocket(port); }
}
/*** /***
* Creates a ServerSocket bound to a specified port with a given * Creates a ServerSocket bound to a specified port with a given
* maximum queue length for incoming connections. A port of 0 will * maximum queue length for incoming connections. A port of 0 will
* create the ServerSocket on a system-determined free port. * create the ServerSocket on a system-determined free port.
* *
* @param port The port on which to listen, or 0 to use any free port. * @param port The port on which to listen, or 0 to use any free port.
* @param backlog The maximum length of the queue for incoming connections. * @param backlog The maximum length of the queue for incoming connections.
* @return A ServerSocket that will listen on a specified port. * @return A ServerSocket that will listen on a specified port.
* @throws IOException If an I/O error occurs while creating * @throws IOException If an I/O error occurs while creating
* the ServerSocket. * the ServerSocket.
***/ ***/
public ServerSocket createServerSocket(int port, int backlog) public ServerSocket createServerSocket(int port, int backlog) throws IOException {
throws IOException return new ServerSocket(port, backlog);
{ }
return new ServerSocket(port, backlog);
}
/*** /***
* Creates a ServerSocket bound to a specified port on a given local * Creates a ServerSocket bound to a specified port on a given local
* address with a given maximum queue length for incoming connections. * address with a given maximum queue length for incoming connections.
* A port of 0 will * A port of 0 will
* create the ServerSocket on a system-determined free port. * create the ServerSocket on a system-determined free port.
* *
* @param port The port on which to listen, or 0 to use any free port. * @param port The port on which to listen, or 0 to use any free port.
* @param backlog The maximum length of the queue for incoming connections. * @param backlog The maximum length of the queue for incoming connections.
* @param bindAddr The local address to which the ServerSocket should bind. * @param bindAddr The local address to which the ServerSocket should bind.
* @return A ServerSocket that will listen on a specified port. * @return A ServerSocket that will listen on a specified port.
* @throws IOException If an I/O error occurs while creating * @throws IOException If an I/O error occurs while creating
* the ServerSocket. * the ServerSocket.
***/ ***/
public ServerSocket createServerSocket(int port, int backlog, public ServerSocket createServerSocket(int port, int backlog, InetAddress bindAddr)
InetAddress bindAddr) throws IOException {
throws IOException return new ServerSocket(port, backlog, bindAddr);
{ }
return new ServerSocket(port, backlog, bindAddr);
}
} }

View File

@@ -32,25 +32,21 @@ import java.io.IOException;
* *
***/ ***/
public class MalformedServerReplyException extends IOException public class MalformedServerReplyException extends IOException {
{
private static final long serialVersionUID = 6006765264250543945L; private static final long serialVersionUID = 6006765264250543945L;
/*** Constructs a MalformedServerReplyException with no message ***/ /*** Constructs a MalformedServerReplyException with no message ***/
public MalformedServerReplyException() public MalformedServerReplyException() {
{ super();
super(); }
}
/***
* Constructs a MalformedServerReplyException with a specified message.
*
* @param message The message explaining the reason for the exception.
***/
public MalformedServerReplyException(String message)
{
super(message);
}
/***
* Constructs a MalformedServerReplyException with a specified message.
*
* @param message The message explaining the reason for the exception.
***/
public MalformedServerReplyException(String message) {
super(message);
}
} }

View File

@@ -28,175 +28,163 @@ import java.io.PrintWriter;
* @since 2.0 * @since 2.0
***/ ***/
public class PrintCommandListener implements ProtocolCommandListener public class PrintCommandListener implements ProtocolCommandListener {
{ private final PrintWriter __writer;
private final PrintWriter __writer; private final boolean __nologin;
private final boolean __nologin; private final char __eolMarker;
private final char __eolMarker; private final boolean __directionMarker;
private final boolean __directionMarker;
/** /**
* Create the default instance which prints everything. * Create the default instance which prints everything.
* *
* @param stream where to write the commands and responses * @param stream where to write the commands and responses
* e.g. System.out * e.g. System.out
* @since 3.0 * @since 3.0
*/ */
public PrintCommandListener(PrintStream stream) public PrintCommandListener(PrintStream stream) {
{ this(new PrintWriter(stream));
this(new PrintWriter(stream)); }
/**
* Create an instance which optionally suppresses login command text
* and indicates where the EOL starts with the specified character.
*
* @param stream where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @since 3.0
*/
public PrintCommandListener(PrintStream stream, boolean suppressLogin) {
this(new PrintWriter(stream), suppressLogin);
}
/**
* Create an instance which optionally suppresses login command text
* and indicates where the EOL starts with the specified character.
*
* @param stream where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
* @since 3.0
*/
public PrintCommandListener(PrintStream stream, boolean suppressLogin, char eolMarker) {
this(new PrintWriter(stream), suppressLogin, eolMarker);
}
/**
* Create an instance which optionally suppresses login command text
* and indicates where the EOL starts with the specified character.
*
* @param stream where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
* @param showDirection if {@code true}, add {@code "> "} or {@code "< "} as appropriate to the
* output
* @since 3.0
*/
public PrintCommandListener(PrintStream stream, boolean suppressLogin, char eolMarker,
boolean showDirection) {
this(new PrintWriter(stream), suppressLogin, eolMarker, showDirection);
}
/**
* Create the default instance which prints everything.
*
* @param writer where to write the commands and responses
*/
public PrintCommandListener(PrintWriter writer) {
this(writer, false);
}
/**
* Create an instance which optionally suppresses login command text.
*
* @param writer where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @since 3.0
*/
public PrintCommandListener(PrintWriter writer, boolean suppressLogin) {
this(writer, suppressLogin, (char) 0);
}
/**
* Create an instance which optionally suppresses login command text
* and indicates where the EOL starts with the specified character.
*
* @param writer where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
* @since 3.0
*/
public PrintCommandListener(PrintWriter writer, boolean suppressLogin, char eolMarker) {
this(writer, suppressLogin, eolMarker, false);
}
/**
* Create an instance which optionally suppresses login command text
* and indicates where the EOL starts with the specified character.
*
* @param writer where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
* @param showDirection if {@code true}, add {@code ">} " or {@code "< "} as appropriate to the
* output
* @since 3.0
*/
public PrintCommandListener(PrintWriter writer, boolean suppressLogin, char eolMarker,
boolean showDirection) {
__writer = writer;
__nologin = suppressLogin;
__eolMarker = eolMarker;
__directionMarker = showDirection;
}
@Override public void protocolCommandSent(ProtocolCommandEvent event) {
if (__directionMarker) {
__writer.print("> ");
} }
if (__nologin) {
/** String cmd = event.getCommand();
* Create an instance which optionally suppresses login command text if ("PASS".equalsIgnoreCase(cmd) || "USER".equalsIgnoreCase(cmd)) {
* and indicates where the EOL starts with the specified character. __writer.print(cmd);
* __writer.println(" *******"); // Don't bother with EOL marker for this!
* @param stream where to write the commands and responses } else {
* @param suppressLogin if {@code true}, only print command name for login final String IMAP_LOGIN = "LOGIN";
* if (IMAP_LOGIN.equalsIgnoreCase(cmd)) { // IMAP
* @since 3.0 String msg = event.getMessage();
*/ msg = msg.substring(0, msg.indexOf(IMAP_LOGIN) + IMAP_LOGIN.length());
public PrintCommandListener(PrintStream stream, boolean suppressLogin) { __writer.print(msg);
this(new PrintWriter(stream), suppressLogin); __writer.println(" *******"); // Don't bother with EOL marker for this!
}
/**
* Create an instance which optionally suppresses login command text
* and indicates where the EOL starts with the specified character.
*
* @param stream where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
*
* @since 3.0
*/
public PrintCommandListener(PrintStream stream, boolean suppressLogin, char eolMarker) {
this(new PrintWriter(stream), suppressLogin, eolMarker);
}
/**
* Create an instance which optionally suppresses login command text
* and indicates where the EOL starts with the specified character.
*
* @param stream where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
* @param showDirection if {@code true}, add {@code "> "} or {@code "< "} as appropriate to the output
*
* @since 3.0
*/
public PrintCommandListener(PrintStream stream, boolean suppressLogin, char eolMarker, boolean showDirection) {
this(new PrintWriter(stream), suppressLogin, eolMarker, showDirection);
}
/**
* Create the default instance which prints everything.
*
* @param writer where to write the commands and responses
*/
public PrintCommandListener(PrintWriter writer)
{
this(writer, false);
}
/**
* Create an instance which optionally suppresses login command text.
*
* @param writer where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
*
* @since 3.0
*/
public PrintCommandListener(PrintWriter writer, boolean suppressLogin)
{
this(writer, suppressLogin, (char) 0);
}
/**
* Create an instance which optionally suppresses login command text
* and indicates where the EOL starts with the specified character.
*
* @param writer where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
*
* @since 3.0
*/
public PrintCommandListener(PrintWriter writer, boolean suppressLogin, char eolMarker)
{
this(writer, suppressLogin, eolMarker, false);
}
/**
* Create an instance which optionally suppresses login command text
* and indicates where the EOL starts with the specified character.
*
* @param writer where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
* @param showDirection if {@code true}, add {@code ">} " or {@code "< "} as appropriate to the output
*
* @since 3.0
*/
public PrintCommandListener(PrintWriter writer, boolean suppressLogin, char eolMarker, boolean showDirection)
{
__writer = writer;
__nologin = suppressLogin;
__eolMarker = eolMarker;
__directionMarker = showDirection;
}
@Override
public void protocolCommandSent(ProtocolCommandEvent event)
{
if (__directionMarker) {
__writer.print("> ");
}
if (__nologin) {
String cmd = event.getCommand();
if ("PASS".equalsIgnoreCase(cmd) || "USER".equalsIgnoreCase(cmd)) {
__writer.print(cmd);
__writer.println(" *******"); // Don't bother with EOL marker for this!
} else {
final String IMAP_LOGIN = "LOGIN";
if (IMAP_LOGIN.equalsIgnoreCase(cmd)) { // IMAP
String msg = event.getMessage();
msg=msg.substring(0, msg.indexOf(IMAP_LOGIN)+IMAP_LOGIN.length());
__writer.print(msg);
__writer.println(" *******"); // Don't bother with EOL marker for this!
} else {
__writer.print(getPrintableString(event.getMessage()));
}
}
} else { } else {
__writer.print(getPrintableString(event.getMessage())); __writer.print(getPrintableString(event.getMessage()));
} }
__writer.flush(); }
} else {
__writer.print(getPrintableString(event.getMessage()));
} }
__writer.flush();
}
private String getPrintableString(String msg){ private String getPrintableString(String msg) {
if (__eolMarker == 0) { if (__eolMarker == 0) {
return msg; return msg;
}
int pos = msg.indexOf(SocketClient.NETASCII_EOL);
if (pos > 0) {
StringBuilder sb = new StringBuilder();
sb.append(msg.substring(0,pos));
sb.append(__eolMarker);
sb.append(msg.substring(pos));
return sb.toString();
}
return msg;
} }
int pos = msg.indexOf(SocketClient.NETASCII_EOL);
if (pos > 0) {
StringBuilder sb = new StringBuilder();
sb.append(msg.substring(0, pos));
sb.append(__eolMarker);
sb.append(msg.substring(pos));
return sb.toString();
}
return msg;
}
@Override @Override public void protocolReplyReceived(ProtocolCommandEvent event) {
public void protocolReplyReceived(ProtocolCommandEvent event) if (__directionMarker) {
{ __writer.print("< ");
if (__directionMarker) {
__writer.print("< ");
}
__writer.print(event.getMessage());
__writer.flush();
} }
__writer.print(event.getMessage());
__writer.flush();
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net; package org.apache.commons.net;
import java.util.EventObject; import java.util.EventObject;
/*** /***
@@ -32,117 +33,107 @@ import java.util.EventObject;
* @see ProtocolCommandSupport * @see ProtocolCommandSupport
***/ ***/
public class ProtocolCommandEvent extends EventObject public class ProtocolCommandEvent extends EventObject {
{ private static final long serialVersionUID = 403743538418947240L;
private static final long serialVersionUID = 403743538418947240L;
private final int __replyCode; private final int __replyCode;
private final boolean __isCommand; private final boolean __isCommand;
private final String __message, __command; private final String __message, __command;
/*** /***
* Creates a ProtocolCommandEvent signalling a command was sent to * Creates a ProtocolCommandEvent signalling a command was sent to
* the server. ProtocolCommandEvents created with this constructor * the server. ProtocolCommandEvents created with this constructor
* should only be sent after a command has been sent, but before the * should only be sent after a command has been sent, but before the
* reply has been received. * reply has been received.
* *
* @param source The source of the event. * @param source The source of the event.
* @param command The string representation of the command type sent, not * @param command The string representation of the command type sent, not
* including the arguments (e.g., "STAT" or "GET"). * including the arguments (e.g., "STAT" or "GET").
* @param message The entire command string verbatim as sent to the server, * @param message The entire command string verbatim as sent to the server,
* including all arguments. * including all arguments.
***/ ***/
public ProtocolCommandEvent(Object source, String command, String message) public ProtocolCommandEvent(Object source, String command, String message) {
{ super(source);
super(source); __replyCode = 0;
__replyCode = 0; __message = message;
__message = message; __isCommand = true;
__isCommand = true; __command = command;
__command = command; }
}
/***
* Creates a ProtocolCommandEvent signalling a reply to a command was
* received. ProtocolCommandEvents created with this constructor
* should only be sent after a complete command reply has been received
* fromt a server.
*
* @param source The source of the event.
* @param replyCode The integer code indicating the natureof the reply.
* This will be the protocol integer value for protocols
* that use integer reply codes, or the reply class constant
* corresponding to the reply for protocols like POP3 that use
* strings like OK rather than integer codes (i.e., POP3Repy.OK).
* @param message The entire reply as received from the server.
***/
public ProtocolCommandEvent(Object source, int replyCode, String message) {
super(source);
__replyCode = replyCode;
__message = message;
__isCommand = false;
__command = null;
}
/*** /***
* Creates a ProtocolCommandEvent signalling a reply to a command was * Returns the string representation of the command type sent (e.g., "STAT"
* received. ProtocolCommandEvents created with this constructor * or "GET"). If the ProtocolCommandEvent is a reply event, then null
* should only be sent after a complete command reply has been received * is returned.
* fromt a server. *
* * @return The string representation of the command type sent, or null
* @param source The source of the event. * if this is a reply event.
* @param replyCode The integer code indicating the natureof the reply. ***/
* This will be the protocol integer value for protocols public String getCommand() {
* that use integer reply codes, or the reply class constant return __command;
* corresponding to the reply for protocols like POP3 that use }
* strings like OK rather than integer codes (i.e., POP3Repy.OK).
* @param message The entire reply as received from the server.
***/
public ProtocolCommandEvent(Object source, int replyCode, String message)
{
super(source);
__replyCode = replyCode;
__message = message;
__isCommand = false;
__command = null;
}
/*** /***
* Returns the string representation of the command type sent (e.g., "STAT" * Returns the reply code of the received server reply. Undefined if
* or "GET"). If the ProtocolCommandEvent is a reply event, then null * this is not a reply event.
* is returned. *
* * @return The reply code of the received server reply. Undefined if
* @return The string representation of the command type sent, or null * not a reply event.
* if this is a reply event. ***/
***/ public int getReplyCode() {
public String getCommand() return __replyCode;
{ }
return __command;
}
/***
* Returns true if the ProtocolCommandEvent was generated as a result
* of sending a command.
*
* @return true If the ProtocolCommandEvent was generated as a result
* of sending a command. False otherwise.
***/
public boolean isCommand() {
return __isCommand;
}
/*** /***
* Returns the reply code of the received server reply. Undefined if * Returns true if the ProtocolCommandEvent was generated as a result
* this is not a reply event. * of receiving a reply.
* *
* @return The reply code of the received server reply. Undefined if * @return true If the ProtocolCommandEvent was generated as a result
* not a reply event. * of receiving a reply. False otherwise.
***/ ***/
public int getReplyCode() public boolean isReply() {
{ return !isCommand();
return __replyCode; }
}
/*** /***
* Returns true if the ProtocolCommandEvent was generated as a result * Returns the entire message sent to or received from the server.
* of sending a command. * Includes the line terminator.
* *
* @return true If the ProtocolCommandEvent was generated as a result * @return The entire message sent to or received from the server.
* of sending a command. False otherwise. ***/
***/ public String getMessage() {
public boolean isCommand() return __message;
{ }
return __isCommand;
}
/***
* Returns true if the ProtocolCommandEvent was generated as a result
* of receiving a reply.
*
* @return true If the ProtocolCommandEvent was generated as a result
* of receiving a reply. False otherwise.
***/
public boolean isReply()
{
return !isCommand();
}
/***
* Returns the entire message sent to or received from the server.
* Includes the line terminator.
*
* @return The entire message sent to or received from the server.
***/
public String getMessage()
{
return __message;
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net; package org.apache.commons.net;
import java.util.EventListener; import java.util.EventListener;
/*** /***
@@ -36,23 +37,21 @@ import java.util.EventListener;
* @see ProtocolCommandSupport * @see ProtocolCommandSupport
***/ ***/
public interface ProtocolCommandListener extends EventListener public interface ProtocolCommandListener extends EventListener {
{
/*** /***
* This method is invoked by a ProtocolCommandEvent source after * This method is invoked by a ProtocolCommandEvent source after
* sending a protocol command to a server. * sending a protocol command to a server.
* *
* @param event The ProtocolCommandEvent fired. * @param event The ProtocolCommandEvent fired.
***/ ***/
public void protocolCommandSent(ProtocolCommandEvent event); public void protocolCommandSent(ProtocolCommandEvent event);
/***
* This method is invoked by a ProtocolCommandEvent source after
* receiving a reply from a server.
*
* @param event The ProtocolCommandEvent fired.
***/
public void protocolReplyReceived(ProtocolCommandEvent event);
/***
* This method is invoked by a ProtocolCommandEvent source after
* receiving a reply from a server.
*
* @param event The ProtocolCommandEvent fired.
***/
public void protocolReplyReceived(ProtocolCommandEvent event);
} }

View File

@@ -33,103 +33,91 @@ import org.apache.commons.net.util.ListenerList;
* @see ProtocolCommandListener * @see ProtocolCommandListener
***/ ***/
public class ProtocolCommandSupport implements Serializable public class ProtocolCommandSupport implements Serializable {
{ private static final long serialVersionUID = -8017692739988399978L;
private static final long serialVersionUID = -8017692739988399978L;
private final Object __source; private final Object __source;
private final ListenerList __listeners; private final ListenerList __listeners;
/*** /***
* Creates a ProtocolCommandSupport instance using the indicated source * Creates a ProtocolCommandSupport instance using the indicated source
* as the source of ProtocolCommandEvents. * as the source of ProtocolCommandEvents.
* *
* @param source The source to use for all generated ProtocolCommandEvents. * @param source The source to use for all generated ProtocolCommandEvents.
***/ ***/
public ProtocolCommandSupport(Object source) public ProtocolCommandSupport(Object source) {
{ __listeners = new ListenerList();
__listeners = new ListenerList(); __source = source;
__source = source; }
/***
* Fires a ProtocolCommandEvent signalling the sending of a command to all
* registered listeners, invoking their
* {@link org.apache.commons.net.ProtocolCommandListener#protocolCommandSent protocolCommandSent() }
* methods.
*
* @param command The string representation of the command type sent, not
* including the arguments (e.g., "STAT" or "GET").
* @param message The entire command string verbatim as sent to the server,
* including all arguments.
***/
public void fireCommandSent(String command, String message) {
ProtocolCommandEvent event;
event = new ProtocolCommandEvent(__source, command, message);
for (EventListener listener : __listeners) {
((ProtocolCommandListener) listener).protocolCommandSent(event);
} }
}
/***
* Fires a ProtocolCommandEvent signalling the reception of a command reply
* to all registered listeners, invoking their
* {@link org.apache.commons.net.ProtocolCommandListener#protocolReplyReceived protocolReplyReceived() }
* methods.
*
* @param replyCode The integer code indicating the natureof the reply.
* This will be the protocol integer value for protocols
* that use integer reply codes, or the reply class constant
* corresponding to the reply for protocols like POP3 that use
* strings like OK rather than integer codes (i.e., POP3Repy.OK).
* @param message The entire reply as received from the server.
***/
public void fireReplyReceived(int replyCode, String message) {
ProtocolCommandEvent event;
event = new ProtocolCommandEvent(__source, replyCode, message);
/*** for (EventListener listener : __listeners) {
* Fires a ProtocolCommandEvent signalling the sending of a command to all ((ProtocolCommandListener) listener).protocolReplyReceived(event);
* registered listeners, invoking their
* {@link org.apache.commons.net.ProtocolCommandListener#protocolCommandSent protocolCommandSent() }
* methods.
*
* @param command The string representation of the command type sent, not
* including the arguments (e.g., "STAT" or "GET").
* @param message The entire command string verbatim as sent to the server,
* including all arguments.
***/
public void fireCommandSent(String command, String message)
{
ProtocolCommandEvent event;
event = new ProtocolCommandEvent(__source, command, message);
for (EventListener listener : __listeners)
{
((ProtocolCommandListener)listener).protocolCommandSent(event);
}
} }
}
/*** /***
* Fires a ProtocolCommandEvent signalling the reception of a command reply * Adds a ProtocolCommandListener.
* to all registered listeners, invoking their *
* {@link org.apache.commons.net.ProtocolCommandListener#protocolReplyReceived protocolReplyReceived() } * @param listener The ProtocolCommandListener to add.
* methods. ***/
* public void addProtocolCommandListener(ProtocolCommandListener listener) {
* @param replyCode The integer code indicating the natureof the reply. __listeners.addListener(listener);
* This will be the protocol integer value for protocols }
* that use integer reply codes, or the reply class constant
* corresponding to the reply for protocols like POP3 that use
* strings like OK rather than integer codes (i.e., POP3Repy.OK).
* @param message The entire reply as received from the server.
***/
public void fireReplyReceived(int replyCode, String message)
{
ProtocolCommandEvent event;
event = new ProtocolCommandEvent(__source, replyCode, message);
for (EventListener listener : __listeners) /***
{ * Removes a ProtocolCommandListener.
((ProtocolCommandListener)listener).protocolReplyReceived(event); *
} * @param listener The ProtocolCommandListener to remove.
} ***/
public void removeProtocolCommandListener(ProtocolCommandListener listener) {
/*** __listeners.removeListener(listener);
* Adds a ProtocolCommandListener. }
*
* @param listener The ProtocolCommandListener to add.
***/
public void addProtocolCommandListener(ProtocolCommandListener listener)
{
__listeners.addListener(listener);
}
/***
* Removes a ProtocolCommandListener.
*
* @param listener The ProtocolCommandListener to remove.
***/
public void removeProtocolCommandListener(ProtocolCommandListener listener)
{
__listeners.removeListener(listener);
}
/***
* Returns the number of ProtocolCommandListeners currently registered.
*
* @return The number of ProtocolCommandListeners currently registered.
***/
public int getListenerCount()
{
return __listeners.getListenerCount();
}
/***
* Returns the number of ProtocolCommandListeners currently registered.
*
* @return The number of ProtocolCommandListeners currently registered.
***/
public int getListenerCount() {
return __listeners.getListenerCount();
}
} }

View File

@@ -17,7 +17,6 @@
package org.apache.commons.net.ftp; package org.apache.commons.net.ftp;
/** /**
* This interface adds the aspect of configurability by means of * This interface adds the aspect of configurability by means of
* a supplied FTPClientConfig object to other classes in the * a supplied FTPClientConfig object to other classes in the
@@ -25,11 +24,11 @@ package org.apache.commons.net.ftp;
*/ */
public interface Configurable { public interface Configurable {
/** /**
* @param config the object containing the configuration data * @param config the object containing the configuration data
* @throws IllegalArgumentException if the elements of the * @throws IllegalArgumentException if the elements of the
* <code>config</code> are somehow inadequate to configure the * <code>config</code> are somehow inadequate to configure the
* Configurable object. * Configurable object.
*/ */
public void configure(FTPClientConfig config); public void configure(FTPClientConfig config);
} }

File diff suppressed because it is too large Load Diff

View File

@@ -19,98 +19,57 @@
package org.apache.commons.net.ftp; package org.apache.commons.net.ftp;
/** /**
* @since 3.3 * @since 3.3
*/ */
public enum FTPCmd { public enum FTPCmd {
ABOR, ABOR, ACCT, ALLO, APPE, CDUP, CWD, DELE, EPRT, EPSV, FEAT, HELP, LIST, MDTM, MFMT, MKD, MLSD, MLST, MODE, NLST, NOOP, PASS, PASV, PORT, PWD, QUIT, REIN, REST, RETR, RMD, RNFR, RNTO, SITE, SMNT, STAT, STOR, STOU, STRU, SYST, TYPE, USER,;
ACCT,
ALLO,
APPE,
CDUP,
CWD,
DELE,
EPRT,
EPSV,
FEAT,
HELP,
LIST,
MDTM,
MFMT,
MKD,
MLSD,
MLST,
MODE,
NLST,
NOOP,
PASS,
PASV,
PORT,
PWD,
QUIT,
REIN,
REST,
RETR,
RMD,
RNFR,
RNTO,
SITE,
SMNT,
STAT,
STOR,
STOU,
STRU,
SYST,
TYPE,
USER,
;
// Aliases // Aliases
public static final FTPCmd ABORT = ABOR; public static final FTPCmd ABORT = ABOR;
public static final FTPCmd ACCOUNT = ACCT; public static final FTPCmd ACCOUNT = ACCT;
public static final FTPCmd ALLOCATE = ALLO; public static final FTPCmd ALLOCATE = ALLO;
public static final FTPCmd APPEND = APPE; public static final FTPCmd APPEND = APPE;
public static final FTPCmd CHANGE_TO_PARENT_DIRECTORY = CDUP; public static final FTPCmd CHANGE_TO_PARENT_DIRECTORY = CDUP;
public static final FTPCmd CHANGE_WORKING_DIRECTORY = CWD; public static final FTPCmd CHANGE_WORKING_DIRECTORY = CWD;
public static final FTPCmd DATA_PORT = PORT; public static final FTPCmd DATA_PORT = PORT;
public static final FTPCmd DELETE = DELE; public static final FTPCmd DELETE = DELE;
public static final FTPCmd FEATURES = FEAT; public static final FTPCmd FEATURES = FEAT;
public static final FTPCmd FILE_STRUCTURE = STRU; public static final FTPCmd FILE_STRUCTURE = STRU;
public static final FTPCmd GET_MOD_TIME = MDTM; public static final FTPCmd GET_MOD_TIME = MDTM;
public static final FTPCmd LOGOUT = QUIT; public static final FTPCmd LOGOUT = QUIT;
public static final FTPCmd MAKE_DIRECTORY = MKD; public static final FTPCmd MAKE_DIRECTORY = MKD;
public static final FTPCmd MOD_TIME = MDTM; public static final FTPCmd MOD_TIME = MDTM;
public static final FTPCmd NAME_LIST = NLST; public static final FTPCmd NAME_LIST = NLST;
public static final FTPCmd PASSIVE = PASV; public static final FTPCmd PASSIVE = PASV;
public static final FTPCmd PASSWORD = PASS; public static final FTPCmd PASSWORD = PASS;
public static final FTPCmd PRINT_WORKING_DIRECTORY = PWD; public static final FTPCmd PRINT_WORKING_DIRECTORY = PWD;
public static final FTPCmd REINITIALIZE = REIN; public static final FTPCmd REINITIALIZE = REIN;
public static final FTPCmd REMOVE_DIRECTORY = RMD; public static final FTPCmd REMOVE_DIRECTORY = RMD;
public static final FTPCmd RENAME_FROM = RNFR; public static final FTPCmd RENAME_FROM = RNFR;
public static final FTPCmd RENAME_TO = RNTO; public static final FTPCmd RENAME_TO = RNTO;
public static final FTPCmd REPRESENTATION_TYPE = TYPE; public static final FTPCmd REPRESENTATION_TYPE = TYPE;
public static final FTPCmd RESTART = REST; public static final FTPCmd RESTART = REST;
public static final FTPCmd RETRIEVE = RETR; public static final FTPCmd RETRIEVE = RETR;
public static final FTPCmd SET_MOD_TIME = MFMT; public static final FTPCmd SET_MOD_TIME = MFMT;
public static final FTPCmd SITE_PARAMETERS = SITE; public static final FTPCmd SITE_PARAMETERS = SITE;
public static final FTPCmd STATUS = STAT; public static final FTPCmd STATUS = STAT;
public static final FTPCmd STORE = STOR; public static final FTPCmd STORE = STOR;
public static final FTPCmd STORE_UNIQUE = STOU; public static final FTPCmd STORE_UNIQUE = STOU;
public static final FTPCmd STRUCTURE_MOUNT = SMNT; public static final FTPCmd STRUCTURE_MOUNT = SMNT;
public static final FTPCmd SYSTEM = SYST; public static final FTPCmd SYSTEM = SYST;
public static final FTPCmd TRANSFER_MODE = MODE; public static final FTPCmd TRANSFER_MODE = MODE;
public static final FTPCmd USERNAME = USER; public static final FTPCmd USERNAME = USER;
/** /**
* Retrieve the FTP protocol command string corresponding to a specified * Retrieve the FTP protocol command string corresponding to a specified
* command code. * command code.
* *
* @return The FTP protcol command string corresponding to a specified * @return The FTP protcol command string corresponding to a specified
* command code. * command code.
*/ */
public final String getCommand() public final String getCommand() {
{ return this.name();
return this.name(); }
}
} }

View File

@@ -27,145 +27,144 @@ package org.apache.commons.net.ftp;
* *
* @deprecated use {@link FTPCmd} instead * @deprecated use {@link FTPCmd} instead
*/ */
@Deprecated @Deprecated public final class FTPCommand {
public final class FTPCommand
{
public static final int USER = 0; public static final int USER = 0;
public static final int PASS = 1; public static final int PASS = 1;
public static final int ACCT = 2; public static final int ACCT = 2;
public static final int CWD = 3; public static final int CWD = 3;
public static final int CDUP = 4; public static final int CDUP = 4;
public static final int SMNT = 5; public static final int SMNT = 5;
public static final int REIN = 6; public static final int REIN = 6;
public static final int QUIT = 7; public static final int QUIT = 7;
public static final int PORT = 8; public static final int PORT = 8;
public static final int PASV = 9; public static final int PASV = 9;
public static final int TYPE = 10; public static final int TYPE = 10;
public static final int STRU = 11; public static final int STRU = 11;
public static final int MODE = 12; public static final int MODE = 12;
public static final int RETR = 13; public static final int RETR = 13;
public static final int STOR = 14; public static final int STOR = 14;
public static final int STOU = 15; public static final int STOU = 15;
public static final int APPE = 16; public static final int APPE = 16;
public static final int ALLO = 17; public static final int ALLO = 17;
public static final int REST = 18; public static final int REST = 18;
public static final int RNFR = 19; public static final int RNFR = 19;
public static final int RNTO = 20; public static final int RNTO = 20;
public static final int ABOR = 21; public static final int ABOR = 21;
public static final int DELE = 22; public static final int DELE = 22;
public static final int RMD = 23; public static final int RMD = 23;
public static final int MKD = 24; public static final int MKD = 24;
public static final int PWD = 25; public static final int PWD = 25;
public static final int LIST = 26; public static final int LIST = 26;
public static final int NLST = 27; public static final int NLST = 27;
public static final int SITE = 28; public static final int SITE = 28;
public static final int SYST = 29; public static final int SYST = 29;
public static final int STAT = 30; public static final int STAT = 30;
public static final int HELP = 31; public static final int HELP = 31;
public static final int NOOP = 32; public static final int NOOP = 32;
/** @since 2.0 */ /** @since 2.0 */
public static final int MDTM = 33; public static final int MDTM = 33;
/** @since 2.2 */ /** @since 2.2 */
public static final int FEAT = 34; public static final int FEAT = 34;
/** @since 2.2 */ /** @since 2.2 */
public static final int MFMT = 35; public static final int MFMT = 35;
/** @since 2.2 */ /** @since 2.2 */
public static final int EPSV = 36; public static final int EPSV = 36;
/** @since 2.2 */ /** @since 2.2 */
public static final int EPRT = 37; public static final int EPRT = 37;
/** /**
* Machine parseable list for a directory * Machine parseable list for a directory
* @since 3.0 *
*/ * @since 3.0
public static final int MLSD = 38; */
public static final int MLSD = 38;
/** /**
* Machine parseable list for a single file * Machine parseable list for a single file
* @since 3.0 *
*/ * @since 3.0
public static final int MLST = 39; */
public static final int MLST = 39;
// Must agree with final entry above; used to check array size // Must agree with final entry above; used to check array size
private static final int LAST = MLST; private static final int LAST = MLST;
public static final int USERNAME = USER; public static final int USERNAME = USER;
public static final int PASSWORD = PASS; public static final int PASSWORD = PASS;
public static final int ACCOUNT = ACCT; public static final int ACCOUNT = ACCT;
public static final int CHANGE_WORKING_DIRECTORY = CWD; public static final int CHANGE_WORKING_DIRECTORY = CWD;
public static final int CHANGE_TO_PARENT_DIRECTORY = CDUP; public static final int CHANGE_TO_PARENT_DIRECTORY = CDUP;
public static final int STRUCTURE_MOUNT = SMNT; public static final int STRUCTURE_MOUNT = SMNT;
public static final int REINITIALIZE = REIN; public static final int REINITIALIZE = REIN;
public static final int LOGOUT = QUIT; public static final int LOGOUT = QUIT;
public static final int DATA_PORT = PORT; public static final int DATA_PORT = PORT;
public static final int PASSIVE = PASV; public static final int PASSIVE = PASV;
public static final int REPRESENTATION_TYPE = TYPE; public static final int REPRESENTATION_TYPE = TYPE;
public static final int FILE_STRUCTURE = STRU; public static final int FILE_STRUCTURE = STRU;
public static final int TRANSFER_MODE = MODE; public static final int TRANSFER_MODE = MODE;
public static final int RETRIEVE = RETR; public static final int RETRIEVE = RETR;
public static final int STORE = STOR; public static final int STORE = STOR;
public static final int STORE_UNIQUE = STOU; public static final int STORE_UNIQUE = STOU;
public static final int APPEND = APPE; public static final int APPEND = APPE;
public static final int ALLOCATE = ALLO; public static final int ALLOCATE = ALLO;
public static final int RESTART = REST; public static final int RESTART = REST;
public static final int RENAME_FROM = RNFR; public static final int RENAME_FROM = RNFR;
public static final int RENAME_TO = RNTO; public static final int RENAME_TO = RNTO;
public static final int ABORT = ABOR; public static final int ABORT = ABOR;
public static final int DELETE = DELE; public static final int DELETE = DELE;
public static final int REMOVE_DIRECTORY = RMD; public static final int REMOVE_DIRECTORY = RMD;
public static final int MAKE_DIRECTORY = MKD; public static final int MAKE_DIRECTORY = MKD;
public static final int PRINT_WORKING_DIRECTORY = PWD; public static final int PRINT_WORKING_DIRECTORY = PWD;
// public static final int LIST = LIST; // public static final int LIST = LIST;
public static final int NAME_LIST = NLST; public static final int NAME_LIST = NLST;
public static final int SITE_PARAMETERS = SITE; public static final int SITE_PARAMETERS = SITE;
public static final int SYSTEM = SYST; public static final int SYSTEM = SYST;
public static final int STATUS = STAT; public static final int STATUS = STAT;
//public static final int HELP = HELP; //public static final int HELP = HELP;
//public static final int NOOP = NOOP; //public static final int NOOP = NOOP;
/** @since 2.0 */ /** @since 2.0 */
public static final int MOD_TIME = MDTM; public static final int MOD_TIME = MDTM;
/** @since 2.2 */ /** @since 2.2 */
public static final int FEATURES = FEAT; public static final int FEATURES = FEAT;
/** @since 2.2 */ /** @since 2.2 */
public static final int GET_MOD_TIME = MDTM; public static final int GET_MOD_TIME = MDTM;
/** @since 2.2 */ /** @since 2.2 */
public static final int SET_MOD_TIME = MFMT; public static final int SET_MOD_TIME = MFMT;
// Cannot be instantiated // Cannot be instantiated
private FTPCommand() private FTPCommand() {
{} }
private static final String[] _commands = { private static final String[] _commands = {
"USER", "PASS", "ACCT", "CWD", "CDUP", "SMNT", "REIN", "QUIT", "PORT", "USER", "PASS", "ACCT", "CWD", "CDUP", "SMNT", "REIN", "QUIT", "PORT", "PASV", "TYPE", "STRU",
"PASV", "TYPE", "STRU", "MODE", "RETR", "STOR", "STOU", "APPE", "ALLO", "MODE", "RETR", "STOR", "STOU", "APPE", "ALLO", "REST", "RNFR", "RNTO", "ABOR", "DELE", "RMD",
"REST", "RNFR", "RNTO", "ABOR", "DELE", "RMD", "MKD", "PWD", "LIST", "MKD", "PWD", "LIST", "NLST", "SITE", "SYST", "STAT", "HELP", "NOOP", "MDTM", "FEAT", "MFMT",
"NLST", "SITE", "SYST", "STAT", "HELP", "NOOP", "MDTM", "FEAT", "MFMT", "EPSV", "EPRT", "MLSD", "MLST"
"EPSV", "EPRT", "MLSD", "MLST" }; };
// default access needed for Unit test
static void checkArray() {
// default access needed for Unit test int expectedLength = LAST + 1;
static void checkArray(){ if (_commands.length != expectedLength) {
int expectedLength = LAST+1; throw new RuntimeException("Incorrect _commands array. Should have length "
if (_commands.length != expectedLength) { + expectedLength
throw new RuntimeException("Incorrect _commands array. Should have length " + " found "
+expectedLength+" found "+_commands.length); + _commands.length);
}
} }
}
/** /**
* Retrieve the FTP protocol command string corresponding to a specified * Retrieve the FTP protocol command string corresponding to a specified
* command code. * command code.
* *
* @param command The command code. * @param command The command code.
* @return The FTP protcol command string corresponding to a specified * @return The FTP protcol command string corresponding to a specified
* command code. * command code.
*/ */
public static final String getCommand(int command) public static final String getCommand(int command) {
{ return _commands[command];
return _commands[command]; }
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp; package org.apache.commons.net.ftp;
import java.io.IOException; import java.io.IOException;
/*** /***
@@ -31,25 +32,21 @@ import java.io.IOException;
* @see FTPClient * @see FTPClient
***/ ***/
public class FTPConnectionClosedException extends IOException public class FTPConnectionClosedException extends IOException {
{
private static final long serialVersionUID = 3500547241659379952L; private static final long serialVersionUID = 3500547241659379952L;
/*** Constructs a FTPConnectionClosedException with no message ***/ /*** Constructs a FTPConnectionClosedException with no message ***/
public FTPConnectionClosedException() public FTPConnectionClosedException() {
{ super();
super(); }
}
/***
* Constructs a FTPConnectionClosedException with a specified message.
*
* @param message The message explaining the reason for the exception.
***/
public FTPConnectionClosedException(String message)
{
super(message);
}
/***
* Constructs a FTPConnectionClosedException with a specified message.
*
* @param message The message explaining the reason for the exception.
***/
public FTPConnectionClosedException(String message) {
super(message);
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp; package org.apache.commons.net.ftp;
import java.io.Serializable; import java.io.Serializable;
import java.util.Calendar; import java.util.Calendar;
import java.util.Date; import java.util.Date;
@@ -30,507 +31,463 @@ import java.util.TimeZone;
* @see FTPClient#listFiles * @see FTPClient#listFiles
***/ ***/
public class FTPFile implements Serializable public class FTPFile implements Serializable {
{ private static final long serialVersionUID = 9010790363003271996L;
private static final long serialVersionUID = 9010790363003271996L;
/** A constant indicating an FTPFile is a file. ***/ /** A constant indicating an FTPFile is a file. ***/
public static final int FILE_TYPE = 0; public static final int FILE_TYPE = 0;
/** A constant indicating an FTPFile is a directory. ***/ /** A constant indicating an FTPFile is a directory. ***/
public static final int DIRECTORY_TYPE = 1; public static final int DIRECTORY_TYPE = 1;
/** A constant indicating an FTPFile is a symbolic link. ***/ /** A constant indicating an FTPFile is a symbolic link. ***/
public static final int SYMBOLIC_LINK_TYPE = 2; public static final int SYMBOLIC_LINK_TYPE = 2;
/** A constant indicating an FTPFile is of unknown type. ***/ /** A constant indicating an FTPFile is of unknown type. ***/
public static final int UNKNOWN_TYPE = 3; public static final int UNKNOWN_TYPE = 3;
/** A constant indicating user access permissions. ***/ /** A constant indicating user access permissions. ***/
public static final int USER_ACCESS = 0; public static final int USER_ACCESS = 0;
/** A constant indicating group access permissions. ***/ /** A constant indicating group access permissions. ***/
public static final int GROUP_ACCESS = 1; public static final int GROUP_ACCESS = 1;
/** A constant indicating world access permissions. ***/ /** A constant indicating world access permissions. ***/
public static final int WORLD_ACCESS = 2; public static final int WORLD_ACCESS = 2;
/** A constant indicating file/directory read permission. ***/ /** A constant indicating file/directory read permission. ***/
public static final int READ_PERMISSION = 0; public static final int READ_PERMISSION = 0;
/** A constant indicating file/directory write permission. ***/ /** A constant indicating file/directory write permission. ***/
public static final int WRITE_PERMISSION = 1; public static final int WRITE_PERMISSION = 1;
/** /**
* A constant indicating file execute permission or directory listing * A constant indicating file execute permission or directory listing
* permission. * permission.
***/ ***/
public static final int EXECUTE_PERMISSION = 2; public static final int EXECUTE_PERMISSION = 2;
private int _type, _hardLinkCount; private int _type, _hardLinkCount;
private long _size; private long _size;
private String _rawListing, _user, _group, _name, _link; private String _rawListing, _user, _group, _name, _link;
private Calendar _date; private Calendar _date;
// If this is null, then list entry parsing failed // If this is null, then list entry parsing failed
private final boolean[] _permissions[]; // e.g. _permissions[USER_ACCESS][READ_PERMISSION] private final boolean[] _permissions[]; // e.g. _permissions[USER_ACCESS][READ_PERMISSION]
/*** Creates an empty FTPFile. ***/ /*** Creates an empty FTPFile. ***/
public FTPFile() public FTPFile() {
{ _permissions = new boolean[3][3];
_permissions = new boolean[3][3]; _type = UNKNOWN_TYPE;
_type = UNKNOWN_TYPE; // init these to values that do not occur in listings
// init these to values that do not occur in listings // so can distinguish which fields are unset
// so can distinguish which fields are unset _hardLinkCount = 0; // 0 is invalid as a link count
_hardLinkCount = 0; // 0 is invalid as a link count _size = -1; // 0 is valid, so use -1
_size = -1; // 0 is valid, so use -1 _user = "";
_user = ""; _group = "";
_group = ""; _date = null;
_date = null; _name = null;
_name = null; }
/**
* Constructor for use by {@link FTPListParseEngine} only.
* Used to create FTPFile entries for failed parses
*
* @param rawListing line that could not be parsed.
* @since 3.4
*/
FTPFile(String rawListing) {
_permissions = null; // flag that entry is invalid
_rawListing = rawListing;
_type = UNKNOWN_TYPE;
// init these to values that do not occur in listings
// so can distinguish which fields are unset
_hardLinkCount = 0; // 0 is invalid as a link count
_size = -1; // 0 is valid, so use -1
_user = "";
_group = "";
_date = null;
_name = null;
}
/***
* Set the original FTP server raw listing from which the FTPFile was
* created.
*
* @param rawListing The raw FTP server listing.
***/
public void setRawListing(String rawListing) {
_rawListing = rawListing;
}
/***
* Get the original FTP server raw listing used to initialize the FTPFile.
*
* @return The original FTP server raw listing used to initialize the
* FTPFile.
***/
public String getRawListing() {
return _rawListing;
}
/***
* Determine if the file is a directory.
*
* @return True if the file is of type <code>DIRECTORY_TYPE</code>, false if
* not.
***/
public boolean isDirectory() {
return (_type == DIRECTORY_TYPE);
}
/***
* Determine if the file is a regular file.
*
* @return True if the file is of type <code>FILE_TYPE</code>, false if
* not.
***/
public boolean isFile() {
return (_type == FILE_TYPE);
}
/***
* Determine if the file is a symbolic link.
*
* @return True if the file is of type <code>UNKNOWN_TYPE</code>, false if
* not.
***/
public boolean isSymbolicLink() {
return (_type == SYMBOLIC_LINK_TYPE);
}
/***
* Determine if the type of the file is unknown.
*
* @return True if the file is of type <code>UNKNOWN_TYPE</code>, false if
* not.
***/
public boolean isUnknown() {
return (_type == UNKNOWN_TYPE);
}
/**
* Used to indicate whether an entry is valid or not.
* If the entry is invalid, only the {@link #getRawListing()} method will be useful.
* Other methods may fail.
*
* Used in conjunction with list parsing that preseverves entries that failed to parse.
*
* @return true if the entry is valid
* @see FTPClientConfig#setUnparseableEntries(boolean)
* @since 3.4
*/
public boolean isValid() {
return (_permissions != null);
}
/***
* Set the type of the file (<code>DIRECTORY_TYPE</code>,
* <code>FILE_TYPE</code>, etc.).
*
* @param type The integer code representing the type of the file.
***/
public void setType(int type) {
_type = type;
}
/***
* Return the type of the file (one of the <code>_TYPE</code> constants),
* e.g., if it is a directory, a regular file, or a symbolic link.
*
* @return The type of the file.
***/
public int getType() {
return _type;
}
/***
* Set the name of the file.
*
* @param name The name of the file.
***/
public void setName(String name) {
_name = name;
}
/***
* Return the name of the file.
*
* @return The name of the file.
***/
public String getName() {
return _name;
}
/**
* Set the file size in bytes.
*
* @param size The file size in bytes.
*/
public void setSize(long size) {
_size = size;
}
/***
* Return the file size in bytes.
*
* @return The file size in bytes.
***/
public long getSize() {
return _size;
}
/***
* Set the number of hard links to this file. This is not to be
* confused with symbolic links.
*
* @param links The number of hard links to this file.
***/
public void setHardLinkCount(int links) {
_hardLinkCount = links;
}
/***
* Return the number of hard links to this file. This is not to be
* confused with symbolic links.
*
* @return The number of hard links to this file.
***/
public int getHardLinkCount() {
return _hardLinkCount;
}
/***
* Set the name of the group owning the file. This may be
* a string representation of the group number.
*
* @param group The name of the group owning the file.
***/
public void setGroup(String group) {
_group = group;
}
/***
* Returns the name of the group owning the file. Sometimes this will be
* a string representation of the group number.
*
* @return The name of the group owning the file.
***/
public String getGroup() {
return _group;
}
/***
* Set the name of the user owning the file. This may be
* a string representation of the user number;
*
* @param user The name of the user owning the file.
***/
public void setUser(String user) {
_user = user;
}
/***
* Returns the name of the user owning the file. Sometimes this will be
* a string representation of the user number.
*
* @return The name of the user owning the file.
***/
public String getUser() {
return _user;
}
/***
* If the FTPFile is a symbolic link, use this method to set the name of the
* file being pointed to by the symbolic link.
*
* @param link The file pointed to by the symbolic link.
***/
public void setLink(String link) {
_link = link;
}
/***
* If the FTPFile is a symbolic link, this method returns the name of the
* file being pointed to by the symbolic link. Otherwise it returns null.
*
* @return The file pointed to by the symbolic link (null if the FTPFile
* is not a symbolic link).
***/
public String getLink() {
return _link;
}
/***
* Set the file timestamp. This usually the last modification time.
* The parameter is not cloned, so do not alter its value after calling
* this method.
*
* @param date A Calendar instance representing the file timestamp.
***/
public void setTimestamp(Calendar date) {
_date = date;
}
/***
* Returns the file timestamp. This usually the last modification time.
*
* @return A Calendar instance representing the file timestamp.
***/
public Calendar getTimestamp() {
return _date;
}
/***
* Set if the given access group (one of the <code> _ACCESS </code>
* constants) has the given access permission (one of the
* <code> _PERMISSION </code> constants) to the file.
*
* @param access The access group (one of the <code> _ACCESS </code>
* constants)
* @param permission The access permission (one of the
* <code> _PERMISSION </code> constants)
* @param value True if permission is allowed, false if not.
* @throws ArrayIndexOutOfBoundsException if either of the parameters is out of range
***/
public void setPermission(int access, int permission, boolean value) {
_permissions[access][permission] = value;
}
/***
* Determines if the given access group (one of the <code> _ACCESS </code>
* constants) has the given access permission (one of the
* <code> _PERMISSION </code> constants) to the file.
*
* @param access The access group (one of the <code> _ACCESS </code>
* constants)
* @param permission The access permission (one of the
* <code> _PERMISSION </code> constants)
* @throws ArrayIndexOutOfBoundsException if either of the parameters is out of range
* @return true if {@link #isValid()} is {@code true &&} the associated permission is set;
* {@code false} otherwise.
***/
public boolean hasPermission(int access, int permission) {
if (_permissions == null) {
return false;
} }
return _permissions[access][permission];
}
/** /***
* Constructor for use by {@link FTPListParseEngine} only. * Returns a string representation of the FTPFile information.
* Used to create FTPFile entries for failed parses *
* @param rawListing line that could not be parsed. * @return A string representation of the FTPFile information.
* @since 3.4 */
*/ @Override public String toString() {
FTPFile(String rawListing) return getRawListing();
{ }
_permissions = null; // flag that entry is invalid
_rawListing = rawListing; /***
_type = UNKNOWN_TYPE; * Returns a string representation of the FTPFile information.
// init these to values that do not occur in listings * This currently mimics the Unix listing format.
// so can distinguish which fields are unset * This method uses the timezone of the Calendar entry, which is
_hardLinkCount = 0; // 0 is invalid as a link count * the server time zone (if one was provided) otherwise it is
_size = -1; // 0 is valid, so use -1 * the local time zone.
_user = ""; * <p>
_group = ""; * Note: if the instance is not valid {@link #isValid()}, no useful
_date = null; * information can be returned. In this case, use {@link #getRawListing()}
_name = null; * instead.
*
* @return A string representation of the FTPFile information.
* @since 3.0
*/
public String toFormattedString() {
return toFormattedString(null);
}
/**
* Returns a string representation of the FTPFile information.
* This currently mimics the Unix listing format.
* This method allows the Calendar time zone to be overridden.
* <p>
* Note: if the instance is not valid {@link #isValid()}, no useful
* information can be returned. In this case, use {@link #getRawListing()}
* instead.
*
* @param timezone the timezone to use for displaying the time stamp
* If {@code null}, then use the Calendar entry timezone
* @return A string representation of the FTPFile information.
* @since 3.4
*/
public String toFormattedString(final String timezone) {
if (!isValid()) {
return "[Invalid: could not parse file entry]";
} }
StringBuilder sb = new StringBuilder();
Formatter fmt = new Formatter(sb);
/*** sb.append(formatType());
* Set the original FTP server raw listing from which the FTPFile was sb.append(permissionToString(USER_ACCESS));
* created. sb.append(permissionToString(GROUP_ACCESS));
* sb.append(permissionToString(WORLD_ACCESS));
* @param rawListing The raw FTP server listing. fmt.format(" %4d", Integer.valueOf(getHardLinkCount()));
***/ fmt.format(" %-8s %-8s", getUser(), getGroup());
public void setRawListing(String rawListing) fmt.format(" %8d", Long.valueOf(getSize()));
{ Calendar timestamp = getTimestamp();
_rawListing = rawListing; if (timestamp != null) {
} if (timezone != null) {
TimeZone newZone = TimeZone.getTimeZone(timezone);
/*** if (!newZone.equals(timestamp.getTimeZone())) {
* Get the original FTP server raw listing used to initialize the FTPFile. Date original = timestamp.getTime();
* Calendar newStamp = Calendar.getInstance(newZone);
* @return The original FTP server raw listing used to initialize the newStamp.setTime(original);
* FTPFile. timestamp = newStamp;
***/
public String getRawListing()
{
return _rawListing;
}
/***
* Determine if the file is a directory.
*
* @return True if the file is of type <code>DIRECTORY_TYPE</code>, false if
* not.
***/
public boolean isDirectory()
{
return (_type == DIRECTORY_TYPE);
}
/***
* Determine if the file is a regular file.
*
* @return True if the file is of type <code>FILE_TYPE</code>, false if
* not.
***/
public boolean isFile()
{
return (_type == FILE_TYPE);
}
/***
* Determine if the file is a symbolic link.
*
* @return True if the file is of type <code>UNKNOWN_TYPE</code>, false if
* not.
***/
public boolean isSymbolicLink()
{
return (_type == SYMBOLIC_LINK_TYPE);
}
/***
* Determine if the type of the file is unknown.
*
* @return True if the file is of type <code>UNKNOWN_TYPE</code>, false if
* not.
***/
public boolean isUnknown()
{
return (_type == UNKNOWN_TYPE);
}
/**
* Used to indicate whether an entry is valid or not.
* If the entry is invalid, only the {@link #getRawListing()} method will be useful.
* Other methods may fail.
*
* Used in conjunction with list parsing that preseverves entries that failed to parse.
* @see FTPClientConfig#setUnparseableEntries(boolean)
* @return true if the entry is valid
* @since 3.4
*/
public boolean isValid() {
return (_permissions != null);
}
/***
* Set the type of the file (<code>DIRECTORY_TYPE</code>,
* <code>FILE_TYPE</code>, etc.).
*
* @param type The integer code representing the type of the file.
***/
public void setType(int type)
{
_type = type;
}
/***
* Return the type of the file (one of the <code>_TYPE</code> constants),
* e.g., if it is a directory, a regular file, or a symbolic link.
*
* @return The type of the file.
***/
public int getType()
{
return _type;
}
/***
* Set the name of the file.
*
* @param name The name of the file.
***/
public void setName(String name)
{
_name = name;
}
/***
* Return the name of the file.
*
* @return The name of the file.
***/
public String getName()
{
return _name;
}
/**
* Set the file size in bytes.
* @param size The file size in bytes.
*/
public void setSize(long size)
{
_size = size;
}
/***
* Return the file size in bytes.
*
* @return The file size in bytes.
***/
public long getSize()
{
return _size;
}
/***
* Set the number of hard links to this file. This is not to be
* confused with symbolic links.
*
* @param links The number of hard links to this file.
***/
public void setHardLinkCount(int links)
{
_hardLinkCount = links;
}
/***
* Return the number of hard links to this file. This is not to be
* confused with symbolic links.
*
* @return The number of hard links to this file.
***/
public int getHardLinkCount()
{
return _hardLinkCount;
}
/***
* Set the name of the group owning the file. This may be
* a string representation of the group number.
*
* @param group The name of the group owning the file.
***/
public void setGroup(String group)
{
_group = group;
}
/***
* Returns the name of the group owning the file. Sometimes this will be
* a string representation of the group number.
*
* @return The name of the group owning the file.
***/
public String getGroup()
{
return _group;
}
/***
* Set the name of the user owning the file. This may be
* a string representation of the user number;
*
* @param user The name of the user owning the file.
***/
public void setUser(String user)
{
_user = user;
}
/***
* Returns the name of the user owning the file. Sometimes this will be
* a string representation of the user number.
*
* @return The name of the user owning the file.
***/
public String getUser()
{
return _user;
}
/***
* If the FTPFile is a symbolic link, use this method to set the name of the
* file being pointed to by the symbolic link.
*
* @param link The file pointed to by the symbolic link.
***/
public void setLink(String link)
{
_link = link;
}
/***
* If the FTPFile is a symbolic link, this method returns the name of the
* file being pointed to by the symbolic link. Otherwise it returns null.
*
* @return The file pointed to by the symbolic link (null if the FTPFile
* is not a symbolic link).
***/
public String getLink()
{
return _link;
}
/***
* Set the file timestamp. This usually the last modification time.
* The parameter is not cloned, so do not alter its value after calling
* this method.
*
* @param date A Calendar instance representing the file timestamp.
***/
public void setTimestamp(Calendar date)
{
_date = date;
}
/***
* Returns the file timestamp. This usually the last modification time.
*
* @return A Calendar instance representing the file timestamp.
***/
public Calendar getTimestamp()
{
return _date;
}
/***
* Set if the given access group (one of the <code> _ACCESS </code>
* constants) has the given access permission (one of the
* <code> _PERMISSION </code> constants) to the file.
*
* @param access The access group (one of the <code> _ACCESS </code>
* constants)
* @param permission The access permission (one of the
* <code> _PERMISSION </code> constants)
* @param value True if permission is allowed, false if not.
* @throws ArrayIndexOutOfBoundsException if either of the parameters is out of range
***/
public void setPermission(int access, int permission, boolean value)
{
_permissions[access][permission] = value;
}
/***
* Determines if the given access group (one of the <code> _ACCESS </code>
* constants) has the given access permission (one of the
* <code> _PERMISSION </code> constants) to the file.
*
* @param access The access group (one of the <code> _ACCESS </code>
* constants)
* @param permission The access permission (one of the
* <code> _PERMISSION </code> constants)
* @throws ArrayIndexOutOfBoundsException if either of the parameters is out of range
* @return true if {@link #isValid()} is {@code true &&} the associated permission is set;
* {@code false} otherwise.
***/
public boolean hasPermission(int access, int permission)
{
if (_permissions == null) {
return false;
} }
return _permissions[access][permission]; }
} fmt.format(" %1$tY-%1$tm-%1$td", timestamp);
// Only display time units if they are present
/*** if (timestamp.isSet(Calendar.HOUR_OF_DAY)) {
* Returns a string representation of the FTPFile information. fmt.format(" %1$tH", timestamp);
* if (timestamp.isSet(Calendar.MINUTE)) {
* @return A string representation of the FTPFile information. fmt.format(":%1$tM", timestamp);
*/ if (timestamp.isSet(Calendar.SECOND)) {
@Override fmt.format(":%1$tS", timestamp);
public String toString() if (timestamp.isSet(Calendar.MILLISECOND)) {
{ fmt.format(".%1$tL", timestamp);
return getRawListing();
}
/***
* Returns a string representation of the FTPFile information.
* This currently mimics the Unix listing format.
* This method uses the timezone of the Calendar entry, which is
* the server time zone (if one was provided) otherwise it is
* the local time zone.
* <p>
* Note: if the instance is not valid {@link #isValid()}, no useful
* information can be returned. In this case, use {@link #getRawListing()}
* instead.
*
* @return A string representation of the FTPFile information.
* @since 3.0
*/
public String toFormattedString()
{
return toFormattedString(null);
}
/**
* Returns a string representation of the FTPFile information.
* This currently mimics the Unix listing format.
* This method allows the Calendar time zone to be overridden.
* <p>
* Note: if the instance is not valid {@link #isValid()}, no useful
* information can be returned. In this case, use {@link #getRawListing()}
* instead.
* @param timezone the timezone to use for displaying the time stamp
* If {@code null}, then use the Calendar entry timezone
* @return A string representation of the FTPFile information.
* @since 3.4
*/
public String toFormattedString(final String timezone)
{
if (!isValid()) {
return "[Invalid: could not parse file entry]";
}
StringBuilder sb = new StringBuilder();
Formatter fmt = new Formatter(sb);
sb.append(formatType());
sb.append(permissionToString(USER_ACCESS));
sb.append(permissionToString(GROUP_ACCESS));
sb.append(permissionToString(WORLD_ACCESS));
fmt.format(" %4d", Integer.valueOf(getHardLinkCount()));
fmt.format(" %-8s %-8s", getUser(), getGroup());
fmt.format(" %8d", Long.valueOf(getSize()));
Calendar timestamp = getTimestamp();
if (timestamp != null) {
if (timezone != null) {
TimeZone newZone = TimeZone.getTimeZone(timezone);
if (!newZone.equals(timestamp.getTimeZone())){
Date original = timestamp.getTime();
Calendar newStamp = Calendar.getInstance(newZone);
newStamp.setTime(original);
timestamp = newStamp;
}
}
fmt.format(" %1$tY-%1$tm-%1$td", timestamp);
// Only display time units if they are present
if (timestamp.isSet(Calendar.HOUR_OF_DAY)) {
fmt.format(" %1$tH", timestamp);
if (timestamp.isSet(Calendar.MINUTE)) {
fmt.format(":%1$tM", timestamp);
if (timestamp.isSet(Calendar.SECOND)) {
fmt.format(":%1$tS", timestamp);
if (timestamp.isSet(Calendar.MILLISECOND)) {
fmt.format(".%1$tL", timestamp);
}
}
}
fmt.format(" %1$tZ", timestamp);
} }
}
} }
sb.append(' '); fmt.format(" %1$tZ", timestamp);
sb.append(getName()); }
fmt.close();
return sb.toString();
} }
sb.append(' ');
sb.append(getName());
fmt.close();
return sb.toString();
}
private char formatType(){ private char formatType() {
switch(_type) { switch (_type) {
case FILE_TYPE: case FILE_TYPE:
return '-'; return '-';
case DIRECTORY_TYPE: case DIRECTORY_TYPE:
return 'd'; return 'd';
case SYMBOLIC_LINK_TYPE: case SYMBOLIC_LINK_TYPE:
return 'l'; return 'l';
default: default:
return '?'; return '?';
}
} }
}
private String permissionToString(int access ){ private String permissionToString(int access) {
StringBuilder sb = new StringBuilder(); StringBuilder sb = new StringBuilder();
if (hasPermission(access, READ_PERMISSION)) { if (hasPermission(access, READ_PERMISSION)) {
sb.append('r'); sb.append('r');
} else { } else {
sb.append('-'); sb.append('-');
}
if (hasPermission(access, WRITE_PERMISSION)) {
sb.append('w');
} else {
sb.append('-');
}
if (hasPermission(access, EXECUTE_PERMISSION)) {
sb.append('x');
} else {
sb.append('-');
}
return sb.toString();
} }
if (hasPermission(access, WRITE_PERMISSION)) {
sb.append('w');
} else {
sb.append('-');
}
if (hasPermission(access, EXECUTE_PERMISSION)) {
sb.append('x');
} else {
sb.append('-');
}
return sb.toString();
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp; package org.apache.commons.net.ftp;
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.util.List; import java.util.List;
@@ -78,50 +79,44 @@ import java.util.List;
* @see FTPFile * @see FTPFile
* @see FTPClient#listFiles() * @see FTPClient#listFiles()
*/ */
public interface FTPFileEntryParser public interface FTPFileEntryParser {
{ /**
/** * Parses a line of an FTP server file listing and converts it into a usable
* Parses a line of an FTP server file listing and converts it into a usable * format in the form of an <code> FTPFile </code> instance. If the
* format in the form of an <code> FTPFile </code> instance. If the * file listing line doesn't describe a file, <code> null </code> should be
* file listing line doesn't describe a file, <code> null </code> should be * returned, otherwise a <code> FTPFile </code> instance representing the
* returned, otherwise a <code> FTPFile </code> instance representing the * files in the directory is returned.
* files in the directory is returned. *
* * @param listEntry A line of text from the file listing
* @param listEntry A line of text from the file listing * @return An FTPFile instance corresponding to the supplied entry
* @return An FTPFile instance corresponding to the supplied entry */
*/ FTPFile parseFTPEntry(String listEntry);
FTPFile parseFTPEntry(String listEntry);
/**
* Reads the next entry using the supplied BufferedReader object up to
* whatever delemits one entry from the next. Implementors must define
* this for the particular ftp system being parsed. In many but not all
* cases, this can be defined simply by calling BufferedReader.readLine().
*
* @param reader The BufferedReader object from which entries are to be
* read.
*
* @return A string representing the next ftp entry or null if none found.
* @throws IOException thrown on any IO Error reading from the reader.
*/
String readNextEntry(BufferedReader reader) throws IOException;
/**
* This method is a hook for those implementors (such as
* VMSVersioningFTPEntryParser, and possibly others) which need to
* perform some action upon the FTPFileList after it has been created
* from the server stream, but before any clients see the list.
*
* The default implementation can be a no-op.
*
* @param original Original list after it has been created from the server stream
*
* @return Original list as processed by this method.
*/
List<String> preParse(List<String> original);
/**
* Reads the next entry using the supplied BufferedReader object up to
* whatever delemits one entry from the next. Implementors must define
* this for the particular ftp system being parsed. In many but not all
* cases, this can be defined simply by calling BufferedReader.readLine().
*
* @param reader The BufferedReader object from which entries are to be
* read.
* @return A string representing the next ftp entry or null if none found.
* @throws IOException thrown on any IO Error reading from the reader.
*/
String readNextEntry(BufferedReader reader) throws IOException;
/**
* This method is a hook for those implementors (such as
* VMSVersioningFTPEntryParser, and possibly others) which need to
* perform some action upon the FTPFileList after it has been created
* from the server stream, but before any clients see the list.
*
* The default implementation can be a no-op.
*
* @param original Original list after it has been created from the server stream
* @return Original list as processed by this method.
*/
List<String> preParse(List<String> original);
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp; package org.apache.commons.net.ftp;
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.util.List; import java.util.List;
@@ -24,50 +25,42 @@ import java.util.List;
* This abstract class implements both the older FTPFileListParser and * This abstract class implements both the older FTPFileListParser and
* newer FTPFileEntryParser interfaces with default functionality. * newer FTPFileEntryParser interfaces with default functionality.
* All the classes in the parser subpackage inherit from this. * All the classes in the parser subpackage inherit from this.
*
*/ */
public abstract class FTPFileEntryParserImpl public abstract class FTPFileEntryParserImpl implements FTPFileEntryParser {
implements FTPFileEntryParser /**
{ * The constructor for a FTPFileEntryParserImpl object.
/** */
* The constructor for a FTPFileEntryParserImpl object. public FTPFileEntryParserImpl() {
*/ }
public FTPFileEntryParserImpl()
{
}
/** /**
* Reads the next entry using the supplied BufferedReader object up to * Reads the next entry using the supplied BufferedReader object up to
* whatever delimits one entry from the next. This default implementation * whatever delimits one entry from the next. This default implementation
* simply calls BufferedReader.readLine(). * simply calls BufferedReader.readLine().
* *
* @param reader The BufferedReader object from which entries are to be * @param reader The BufferedReader object from which entries are to be
* read. * read.
* * @return A string representing the next ftp entry or null if none found.
* @return A string representing the next ftp entry or null if none found. * @throws IOException thrown on any IO Error reading from the reader.
* @throws IOException thrown on any IO Error reading from the reader. */
*/ @Override public String readNextEntry(BufferedReader reader) throws IOException {
@Override return reader.readLine();
public String readNextEntry(BufferedReader reader) throws IOException }
{
return reader.readLine(); /**
} * This method is a hook for those implementors (such as
/** * VMSVersioningFTPEntryParser, and possibly others) which need to
* This method is a hook for those implementors (such as * perform some action upon the FTPFileList after it has been created
* VMSVersioningFTPEntryParser, and possibly others) which need to * from the server stream, but before any clients see the list.
* perform some action upon the FTPFileList after it has been created *
* from the server stream, but before any clients see the list. * This default implementation does nothing.
* *
* This default implementation does nothing. * @param original Original list after it has been created from the server stream
* * @return <code>original</code> unmodified.
* @param original Original list after it has been created from the server stream */
* @Override public List<String> preParse(List<String> original) {
* @return <code>original</code> unmodified. return original;
*/ }
@Override
public List<String> preParse(List<String> original) {
return original;
}
} }
/* Emacs configuration /* Emacs configuration

View File

@@ -20,14 +20,15 @@ package org.apache.commons.net.ftp;
/** /**
* Perform filtering on FTPFile entries. * Perform filtering on FTPFile entries.
*
* @since 2.2 * @since 2.2
*/ */
public interface FTPFileFilter { public interface FTPFileFilter {
/** /**
* Checks if an FTPFile entry should be included or not. * Checks if an FTPFile entry should be included or not.
* *
* @param file entry to be checked for inclusion. May be <code>null</code>. * @param file entry to be checked for inclusion. May be <code>null</code>.
* @return <code>true</code> if the file is to be included, <code>false</code> otherwise * @return <code>true</code> if the file is to be included, <code>false</code> otherwise
*/ */
public boolean accept(FTPFile file); public boolean accept(FTPFile file);
} }

View File

@@ -20,38 +20,35 @@ package org.apache.commons.net.ftp;
/** /**
* Implements some simple FTPFileFilter classes. * Implements some simple FTPFileFilter classes.
*
* @since 2.2 * @since 2.2
*/ */
public class FTPFileFilters { public class FTPFileFilters {
/** /**
* Accepts all FTPFile entries, including null. * Accepts all FTPFile entries, including null.
*/ */
public static final FTPFileFilter ALL = new FTPFileFilter() { public static final FTPFileFilter ALL = new FTPFileFilter() {
@Override @Override public boolean accept(FTPFile file) {
public boolean accept(FTPFile file) { return true;
return true; }
} };
};
/** /**
* Accepts all non-null FTPFile entries. * Accepts all non-null FTPFile entries.
*/ */
public static final FTPFileFilter NON_NULL = new FTPFileFilter() { public static final FTPFileFilter NON_NULL = new FTPFileFilter() {
@Override @Override public boolean accept(FTPFile file) {
public boolean accept(FTPFile file) { return file != null;
return file != null; }
} };
};
/**
* Accepts all (non-null) FTPFile directory entries.
*/
public static final FTPFileFilter DIRECTORIES = new FTPFileFilter() {
@Override
public boolean accept(FTPFile file) {
return file != null && file.isDirectory();
}
};
/**
* Accepts all (non-null) FTPFile directory entries.
*/
public static final FTPFileFilter DIRECTORIES = new FTPFileFilter() {
@Override public boolean accept(FTPFile file) {
return file != null && file.isDirectory();
}
};
} }

View File

@@ -38,165 +38,157 @@ import org.apache.commons.net.util.Base64;
* @since 2.2 * @since 2.2
*/ */
public class FTPHTTPClient extends FTPClient { public class FTPHTTPClient extends FTPClient {
private final String proxyHost; private final String proxyHost;
private final int proxyPort; private final int proxyPort;
private final String proxyUsername; private final String proxyUsername;
private final String proxyPassword; private final String proxyPassword;
private static final byte[] CRLF={'\r', '\n'}; private static final byte[] CRLF = { '\r', '\n' };
private final Base64 base64 = new Base64(); private final Base64 base64 = new Base64();
private String tunnelHost; // Save the host when setting up a tunnel (needed for EPSV) private String tunnelHost; // Save the host when setting up a tunnel (needed for EPSV)
public FTPHTTPClient(String proxyHost, int proxyPort, String proxyUser, String proxyPass) { public FTPHTTPClient(String proxyHost, int proxyPort, String proxyUser, String proxyPass) {
this.proxyHost = proxyHost; this.proxyHost = proxyHost;
this.proxyPort = proxyPort; this.proxyPort = proxyPort;
this.proxyUsername = proxyUser; this.proxyUsername = proxyUser;
this.proxyPassword = proxyPass; this.proxyPassword = proxyPass;
this.tunnelHost = null; this.tunnelHost = null;
}
public FTPHTTPClient(String proxyHost, int proxyPort) {
this(proxyHost, proxyPort, null, null);
}
/**
* {@inheritDoc}
*
* @throws IllegalStateException if connection mode is not passive
* @deprecated (3.3) Use {@link FTPClient#_openDataConnection_(FTPCmd, String)} instead
*/
// Kept to maintain binary compatibility
// Not strictly necessary, but Clirr complains even though there is a super-impl
@Override @Deprecated protected Socket _openDataConnection_(int command, String arg)
throws IOException {
return super._openDataConnection_(command, arg);
}
/**
* {@inheritDoc}
*
* @throws IllegalStateException if connection mode is not passive
* @since 3.1
*/
@Override protected Socket _openDataConnection_(String command, String arg) throws IOException {
//Force local passive mode, active mode not supported by through proxy
if (getDataConnectionMode() != PASSIVE_LOCAL_DATA_CONNECTION_MODE) {
throw new IllegalStateException("Only passive connection mode supported");
} }
public FTPHTTPClient(String proxyHost, int proxyPort) { final boolean isInet6Address = getRemoteAddress() instanceof Inet6Address;
this(proxyHost, proxyPort, null, null); String passiveHost = null;
boolean attemptEPSV = isUseEPSVwithIPv4() || isInet6Address;
if (attemptEPSV && epsv() == FTPReply.ENTERING_EPSV_MODE) {
_parseExtendedPassiveModeReply(_replyLines.get(0));
passiveHost = this.tunnelHost;
} else {
if (isInet6Address) {
return null; // Must use EPSV for IPV6
}
// If EPSV failed on IPV4, revert to PASV
if (pasv() != FTPReply.ENTERING_PASSIVE_MODE) {
return null;
}
_parsePassiveModeReply(_replyLines.get(0));
passiveHost = this.getPassiveHost();
} }
Socket socket = _socketFactory_.createSocket(proxyHost, proxyPort);
/** InputStream is = socket.getInputStream();
* {@inheritDoc} OutputStream os = socket.getOutputStream();
* tunnelHandshake(passiveHost, this.getPassivePort(), is, os);
* @throws IllegalStateException if connection mode is not passive if ((getRestartOffset() > 0) && !restart(getRestartOffset())) {
* @deprecated (3.3) Use {@link FTPClient#_openDataConnection_(FTPCmd, String)} instead socket.close();
*/ return null;
// Kept to maintain binary compatibility
// Not strictly necessary, but Clirr complains even though there is a super-impl
@Override
@Deprecated
protected Socket _openDataConnection_(int command, String arg)
throws IOException {
return super._openDataConnection_(command, arg);
} }
/** if (!FTPReply.isPositivePreliminary(sendCommand(command, arg))) {
* {@inheritDoc} socket.close();
* return null;
* @throws IllegalStateException if connection mode is not passive
* @since 3.1
*/
@Override
protected Socket _openDataConnection_(String command, String arg)
throws IOException {
//Force local passive mode, active mode not supported by through proxy
if (getDataConnectionMode() != PASSIVE_LOCAL_DATA_CONNECTION_MODE) {
throw new IllegalStateException("Only passive connection mode supported");
}
final boolean isInet6Address = getRemoteAddress() instanceof Inet6Address;
String passiveHost = null;
boolean attemptEPSV = isUseEPSVwithIPv4() || isInet6Address;
if (attemptEPSV && epsv() == FTPReply.ENTERING_EPSV_MODE) {
_parseExtendedPassiveModeReply(_replyLines.get(0));
passiveHost = this.tunnelHost;
} else {
if (isInet6Address) {
return null; // Must use EPSV for IPV6
}
// If EPSV failed on IPV4, revert to PASV
if (pasv() != FTPReply.ENTERING_PASSIVE_MODE) {
return null;
}
_parsePassiveModeReply(_replyLines.get(0));
passiveHost = this.getPassiveHost();
}
Socket socket = _socketFactory_.createSocket(proxyHost, proxyPort);
InputStream is = socket.getInputStream();
OutputStream os = socket.getOutputStream();
tunnelHandshake(passiveHost, this.getPassivePort(), is, os);
if ((getRestartOffset() > 0) && !restart(getRestartOffset())) {
socket.close();
return null;
}
if (!FTPReply.isPositivePreliminary(sendCommand(command, arg))) {
socket.close();
return null;
}
return socket;
} }
@Override return socket;
public void connect(String host, int port) throws SocketException, IOException { }
_socket_ = _socketFactory_.createSocket(proxyHost, proxyPort); @Override public void connect(String host, int port) throws SocketException, IOException {
_input_ = _socket_.getInputStream();
_output_ = _socket_.getOutputStream(); _socket_ = _socketFactory_.createSocket(proxyHost, proxyPort);
Reader socketIsReader; _input_ = _socket_.getInputStream();
try { _output_ = _socket_.getOutputStream();
socketIsReader = tunnelHandshake(host, port, _input_, _output_); Reader socketIsReader;
} try {
catch (Exception e) { socketIsReader = tunnelHandshake(host, port, _input_, _output_);
IOException ioe = new IOException("Could not connect to " + host+ " using port " + port); } catch (Exception e) {
ioe.initCause(e); IOException ioe = new IOException("Could not connect to " + host + " using port " + port);
throw ioe; ioe.initCause(e);
} throw ioe;
super._connectAction_(socketIsReader); }
super._connectAction_(socketIsReader);
}
private BufferedReader tunnelHandshake(String host, int port, InputStream input,
OutputStream output) throws IOException, UnsupportedEncodingException {
final String connectString = "CONNECT " + host + ":" + port + " HTTP/1.1";
final String hostString = "Host: " + host + ":" + port;
this.tunnelHost = host;
output.write(connectString.getBytes("UTF-8")); // TODO what is the correct encoding?
output.write(CRLF);
output.write(hostString.getBytes("UTF-8"));
output.write(CRLF);
if (proxyUsername != null && proxyPassword != null) {
final String auth = proxyUsername + ":" + proxyPassword;
final String header =
"Proxy-Authorization: Basic " + base64.encodeToString(auth.getBytes("UTF-8"));
output.write(header.getBytes("UTF-8"));
}
output.write(CRLF);
List<String> response = new ArrayList<String>();
BufferedReader reader = new BufferedReader(new InputStreamReader(input, getCharset()));
for (String line = reader.readLine(); line != null && line.length() > 0;
line = reader.readLine()) {
response.add(line);
} }
private BufferedReader tunnelHandshake(String host, int port, InputStream input, OutputStream output) throws IOException, int size = response.size();
UnsupportedEncodingException { if (size == 0) {
final String connectString = "CONNECT " + host + ":" + port + " HTTP/1.1"; throw new IOException("No response from proxy");
final String hostString = "Host: " + host + ":" + port;
this.tunnelHost = host;
output.write(connectString.getBytes("UTF-8")); // TODO what is the correct encoding?
output.write(CRLF);
output.write(hostString.getBytes("UTF-8"));
output.write(CRLF);
if (proxyUsername != null && proxyPassword != null) {
final String auth = proxyUsername + ":" + proxyPassword;
final String header = "Proxy-Authorization: Basic "
+ base64.encodeToString(auth.getBytes("UTF-8"));
output.write(header.getBytes("UTF-8"));
}
output.write(CRLF);
List<String> response = new ArrayList<String>();
BufferedReader reader = new BufferedReader(
new InputStreamReader(input, getCharset()));
for (String line = reader.readLine(); line != null
&& line.length() > 0; line = reader.readLine()) {
response.add(line);
}
int size = response.size();
if (size == 0) {
throw new IOException("No response from proxy");
}
String code = null;
String resp = response.get(0);
if (resp.startsWith("HTTP/") && resp.length() >= 12) {
code = resp.substring(9, 12);
} else {
throw new IOException("Invalid response from proxy: " + resp);
}
if (!"200".equals(code)) {
StringBuilder msg = new StringBuilder();
msg.append("HTTPTunnelConnector: connection failed\r\n");
msg.append("Response received from the proxy:\r\n");
for (String line : response) {
msg.append(line);
msg.append("\r\n");
}
throw new IOException(msg.toString());
}
return reader;
} }
String code = null;
String resp = response.get(0);
if (resp.startsWith("HTTP/") && resp.length() >= 12) {
code = resp.substring(9, 12);
} else {
throw new IOException("Invalid response from proxy: " + resp);
}
if (!"200".equals(code)) {
StringBuilder msg = new StringBuilder();
msg.append("HTTPTunnelConnector: connection failed\r\n");
msg.append("Response received from the proxy:\r\n");
for (String line : response) {
msg.append(line);
msg.append("\r\n");
}
throw new IOException(msg.toString());
}
return reader;
}
} }

View File

@@ -29,7 +29,6 @@ import java.util.ListIterator;
import org.apache.commons.net.util.Charsets; import org.apache.commons.net.util.Charsets;
/** /**
* This class handles the entire process of parsing a listing of * This class handles the entire process of parsing a listing of
* file entries from the server. * file entries from the server.
@@ -73,257 +72,240 @@ import org.apache.commons.net.util.Charsets;
* <p> * <p>
* For unpaged access, simply use FTPClient.listFiles(). That method * For unpaged access, simply use FTPClient.listFiles(). That method
* uses this class transparently. * uses this class transparently.
*
* @version $Id: FTPListParseEngine.java 1747119 2016-06-07 02:22:24Z ggregory $ * @version $Id: FTPListParseEngine.java 1747119 2016-06-07 02:22:24Z ggregory $
*/ */
public class FTPListParseEngine { public class FTPListParseEngine {
private List<String> entries = new LinkedList<String>(); private List<String> entries = new LinkedList<String>();
private ListIterator<String> _internalIterator = entries.listIterator(); private ListIterator<String> _internalIterator = entries.listIterator();
private final FTPFileEntryParser parser; private final FTPFileEntryParser parser;
// Should invalid files (parse failures) be allowed? // Should invalid files (parse failures) be allowed?
private final boolean saveUnparseableEntries; private final boolean saveUnparseableEntries;
public FTPListParseEngine(FTPFileEntryParser parser) { public FTPListParseEngine(FTPFileEntryParser parser) {
this(parser, null); this(parser, null);
}
/**
* Intended for use by FTPClient only
*
* @since 3.4
*/
FTPListParseEngine(FTPFileEntryParser parser, FTPClientConfig configuration) {
this.parser = parser;
if (configuration != null) {
this.saveUnparseableEntries = configuration.getUnparseableEntries();
} else {
this.saveUnparseableEntries = false;
} }
}
/** /**
* Intended for use by FTPClient only * handle the initial reading and preparsing of the list returned by
* @since 3.4 * the server. After this method has completed, this object will contain
*/ * a list of unparsed entries (Strings) each referring to a unique file
FTPListParseEngine(FTPFileEntryParser parser, FTPClientConfig configuration) { * on the server.
this.parser = parser; *
if (configuration != null) { * @param stream input stream provided by the server socket.
this.saveUnparseableEntries = configuration.getUnparseableEntries(); * @param encoding the encoding to be used for reading the stream
} else { * @throws IOException thrown on any failure to read from the sever.
this.saveUnparseableEntries = false; */
} public void readServerList(InputStream stream, String encoding) throws IOException {
this.entries = new LinkedList<String>();
readStream(stream, encoding);
this.parser.preParse(this.entries);
resetIterator();
}
/**
* Internal method for reading the input into the <code>entries</code> list.
* After this method has completed, <code>entries</code> will contain a
* collection of entries (as defined by
* <code>FTPFileEntryParser.readNextEntry()</code>), but this may contain
* various non-entry preliminary lines from the server output, duplicates,
* and other data that will not be part of the final listing.
*
* @param stream The socket stream on which the input will be read.
* @param encoding The encoding to use.
* @throws IOException thrown on any failure to read the stream
*/
private void readStream(InputStream stream, String encoding) throws IOException {
BufferedReader reader =
new BufferedReader(new InputStreamReader(stream, Charsets.toCharset(encoding)));
String line = this.parser.readNextEntry(reader);
while (line != null) {
this.entries.add(line);
line = this.parser.readNextEntry(reader);
} }
reader.close();
}
/** /**
* handle the initial reading and preparsing of the list returned by * Returns an array of at most <code>quantityRequested</code> FTPFile
* the server. After this method has completed, this object will contain * objects starting at this object's internal iterator's current position.
* a list of unparsed entries (Strings) each referring to a unique file * If fewer than <code>quantityRequested</code> such
* on the server. * elements are available, the returned array will have a length equal
* * to the number of entries at and after after the current position.
* @param stream input stream provided by the server socket. * If no such entries are found, this array will have a length of 0.
* @param encoding the encoding to be used for reading the stream *
* * After this method is called this object's internal iterator is advanced
* @throws IOException * by a number of positions equal to the size of the array returned.
* thrown on any failure to read from the sever. *
*/ * @param quantityRequested the maximum number of entries we want to get.
public void readServerList(InputStream stream, String encoding) * @return an array of at most <code>quantityRequested</code> FTPFile
throws IOException * objects starting at the current position of this iterator within its
{ * list and at least the number of elements which exist in the list at
this.entries = new LinkedList<String>(); * and after its current position.
readStream(stream, encoding); * <p><b>
this.parser.preParse(this.entries); * NOTE:</b> This array may contain null members if any of the
resetIterator(); * individual file listings failed to parse. The caller should
* check each entry for null before referencing it.
*/
public FTPFile[] getNext(int quantityRequested) {
List<FTPFile> tmpResults = new LinkedList<FTPFile>();
int count = quantityRequested;
while (count > 0 && this._internalIterator.hasNext()) {
String entry = this._internalIterator.next();
FTPFile temp = this.parser.parseFTPEntry(entry);
if (temp == null && saveUnparseableEntries) {
temp = new FTPFile(entry);
}
tmpResults.add(temp);
count--;
} }
return tmpResults.toArray(new FTPFile[tmpResults.size()]);
}
/** /**
* Internal method for reading the input into the <code>entries</code> list. * Returns an array of at most <code>quantityRequested</code> FTPFile
* After this method has completed, <code>entries</code> will contain a * objects starting at this object's internal iterator's current position,
* collection of entries (as defined by * and working back toward the beginning.
* <code>FTPFileEntryParser.readNextEntry()</code>), but this may contain *
* various non-entry preliminary lines from the server output, duplicates, * If fewer than <code>quantityRequested</code> such
* and other data that will not be part of the final listing. * elements are available, the returned array will have a length equal
* * to the number of entries at and after after the current position.
* @param stream The socket stream on which the input will be read. * If no such entries are found, this array will have a length of 0.
* @param encoding The encoding to use. *
* * After this method is called this object's internal iterator is moved
* @throws IOException * back by a number of positions equal to the size of the array returned.
* thrown on any failure to read the stream *
*/ * @param quantityRequested the maximum number of entries we want to get.
private void readStream(InputStream stream, String encoding) throws IOException * @return an array of at most <code>quantityRequested</code> FTPFile
{ * objects starting at the current position of this iterator within its
BufferedReader reader = new BufferedReader( * list and at least the number of elements which exist in the list at
new InputStreamReader(stream, Charsets.toCharset(encoding))); * and after its current position. This array will be in the same order
* as the underlying list (not reversed).
String line = this.parser.readNextEntry(reader); * <p><b>
* NOTE:</b> This array may contain null members if any of the
while (line != null) * individual file listings failed to parse. The caller should
{ * check each entry for null before referencing it.
this.entries.add(line); */
line = this.parser.readNextEntry(reader); public FTPFile[] getPrevious(int quantityRequested) {
} List<FTPFile> tmpResults = new LinkedList<FTPFile>();
reader.close(); int count = quantityRequested;
while (count > 0 && this._internalIterator.hasPrevious()) {
String entry = this._internalIterator.previous();
FTPFile temp = this.parser.parseFTPEntry(entry);
if (temp == null && saveUnparseableEntries) {
temp = new FTPFile(entry);
}
tmpResults.add(0, temp);
count--;
} }
return tmpResults.toArray(new FTPFile[tmpResults.size()]);
}
/** /**
* Returns an array of at most <code>quantityRequested</code> FTPFile * Returns an array of FTPFile objects containing the whole list of
* objects starting at this object's internal iterator's current position. * files returned by the server as read by this object's parser.
* If fewer than <code>quantityRequested</code> such *
* elements are available, the returned array will have a length equal * @return an array of FTPFile objects containing the whole list of
* to the number of entries at and after after the current position. * files returned by the server as read by this object's parser.
* If no such entries are found, this array will have a length of 0. * None of the entries will be null
* * @throws IOException - not ever thrown, may be removed in a later release
* After this method is called this object's internal iterator is advanced */
* by a number of positions equal to the size of the array returned. public FTPFile[] getFiles() throws IOException // TODO remove; not actually thrown
* {
* @param quantityRequested return getFiles(FTPFileFilters.NON_NULL);
* the maximum number of entries we want to get. }
*
* @return an array of at most <code>quantityRequested</code> FTPFile
* objects starting at the current position of this iterator within its
* list and at least the number of elements which exist in the list at
* and after its current position.
* <p><b>
* NOTE:</b> This array may contain null members if any of the
* individual file listings failed to parse. The caller should
* check each entry for null before referencing it.
*/
public FTPFile[] getNext(int quantityRequested) {
List<FTPFile> tmpResults = new LinkedList<FTPFile>();
int count = quantityRequested;
while (count > 0 && this._internalIterator.hasNext()) {
String entry = this._internalIterator.next();
FTPFile temp = this.parser.parseFTPEntry(entry);
if (temp == null && saveUnparseableEntries) {
temp = new FTPFile(entry);
}
tmpResults.add(temp);
count--;
}
return tmpResults.toArray(new FTPFile[tmpResults.size()]);
/**
* Returns an array of FTPFile objects containing the whole list of
* files returned by the server as read by this object's parser.
* The files are filtered before being added to the array.
*
* @param filter FTPFileFilter, must not be <code>null</code>.
* @return an array of FTPFile objects containing the whole list of
* files returned by the server as read by this object's parser.
* <p><b>
* NOTE:</b> This array may contain null members if any of the
* individual file listings failed to parse. The caller should
* check each entry for null before referencing it, or use the
* a filter such as {@link FTPFileFilters#NON_NULL} which does not
* allow null entries.
* @throws IOException - not ever thrown, may be removed in a later release
* @since 2.2
*/
public FTPFile[] getFiles(FTPFileFilter filter)
throws IOException // TODO remove; not actually thrown
{
List<FTPFile> tmpResults = new ArrayList<FTPFile>();
Iterator<String> iter = this.entries.iterator();
while (iter.hasNext()) {
String entry = iter.next();
FTPFile temp = this.parser.parseFTPEntry(entry);
if (temp == null && saveUnparseableEntries) {
temp = new FTPFile(entry);
}
if (filter.accept(temp)) {
tmpResults.add(temp);
}
} }
return tmpResults.toArray(new FTPFile[tmpResults.size()]);
}
/** /**
* Returns an array of at most <code>quantityRequested</code> FTPFile * convenience method to allow clients to know whether this object's
* objects starting at this object's internal iterator's current position, * internal iterator's current position is at the end of the list.
* and working back toward the beginning. *
* * @return true if internal iterator is not at end of list, false
* If fewer than <code>quantityRequested</code> such * otherwise.
* elements are available, the returned array will have a length equal */
* to the number of entries at and after after the current position. public boolean hasNext() {
* If no such entries are found, this array will have a length of 0. return _internalIterator.hasNext();
* }
* After this method is called this object's internal iterator is moved
* back by a number of positions equal to the size of the array returned.
*
* @param quantityRequested
* the maximum number of entries we want to get.
*
* @return an array of at most <code>quantityRequested</code> FTPFile
* objects starting at the current position of this iterator within its
* list and at least the number of elements which exist in the list at
* and after its current position. This array will be in the same order
* as the underlying list (not reversed).
* <p><b>
* NOTE:</b> This array may contain null members if any of the
* individual file listings failed to parse. The caller should
* check each entry for null before referencing it.
*/
public FTPFile[] getPrevious(int quantityRequested) {
List<FTPFile> tmpResults = new LinkedList<FTPFile>();
int count = quantityRequested;
while (count > 0 && this._internalIterator.hasPrevious()) {
String entry = this._internalIterator.previous();
FTPFile temp = this.parser.parseFTPEntry(entry);
if (temp == null && saveUnparseableEntries) {
temp = new FTPFile(entry);
}
tmpResults.add(0,temp);
count--;
}
return tmpResults.toArray(new FTPFile[tmpResults.size()]);
}
/** /**
* Returns an array of FTPFile objects containing the whole list of * convenience method to allow clients to know whether this object's
* files returned by the server as read by this object's parser. * internal iterator's current position is at the beginning of the list.
* *
* @return an array of FTPFile objects containing the whole list of * @return true if internal iterator is not at beginning of list, false
* files returned by the server as read by this object's parser. * otherwise.
* None of the entries will be null */
* @throws IOException - not ever thrown, may be removed in a later release public boolean hasPrevious() {
*/ return _internalIterator.hasPrevious();
public FTPFile[] getFiles() }
throws IOException // TODO remove; not actually thrown
{
return getFiles(FTPFileFilters.NON_NULL);
}
/** /**
* Returns an array of FTPFile objects containing the whole list of * resets this object's internal iterator to the beginning of the list.
* files returned by the server as read by this object's parser. */
* The files are filtered before being added to the array. public void resetIterator() {
* this._internalIterator = this.entries.listIterator();
* @param filter FTPFileFilter, must not be <code>null</code>. }
*
* @return an array of FTPFile objects containing the whole list of
* files returned by the server as read by this object's parser.
* <p><b>
* NOTE:</b> This array may contain null members if any of the
* individual file listings failed to parse. The caller should
* check each entry for null before referencing it, or use the
* a filter such as {@link FTPFileFilters#NON_NULL} which does not
* allow null entries.
* @since 2.2
* @throws IOException - not ever thrown, may be removed in a later release
*/
public FTPFile[] getFiles(FTPFileFilter filter)
throws IOException // TODO remove; not actually thrown
{
List<FTPFile> tmpResults = new ArrayList<FTPFile>();
Iterator<String> iter = this.entries.iterator();
while (iter.hasNext()) {
String entry = iter.next();
FTPFile temp = this.parser.parseFTPEntry(entry);
if (temp == null && saveUnparseableEntries) {
temp = new FTPFile(entry);
}
if (filter.accept(temp)){
tmpResults.add(temp);
}
}
return tmpResults.toArray(new FTPFile[tmpResults.size()]);
} // DEPRECATED METHODS - for API compatibility only - DO NOT USE
/**
* convenience method to allow clients to know whether this object's
* internal iterator's current position is at the end of the list.
*
* @return true if internal iterator is not at end of list, false
* otherwise.
*/
public boolean hasNext() {
return _internalIterator.hasNext();
}
/**
* convenience method to allow clients to know whether this object's
* internal iterator's current position is at the beginning of the list.
*
* @return true if internal iterator is not at beginning of list, false
* otherwise.
*/
public boolean hasPrevious() {
return _internalIterator.hasPrevious();
}
/**
* resets this object's internal iterator to the beginning of the list.
*/
public void resetIterator() {
this._internalIterator = this.entries.listIterator();
}
// DEPRECATED METHODS - for API compatibility only - DO NOT USE
/**
* Do not use.
* @param stream the stream from which to read
* @throws IOException on error
* @deprecated use {@link #readServerList(InputStream, String)} instead
*/
@Deprecated
public void readServerList(InputStream stream)
throws IOException
{
readServerList(stream, null);
}
/**
* Do not use.
*
* @param stream the stream from which to read
* @throws IOException on error
* @deprecated use {@link #readServerList(InputStream, String)} instead
*/
@Deprecated public void readServerList(InputStream stream) throws IOException {
readServerList(stream, null);
}
} }

View File

@@ -26,176 +26,168 @@ package org.apache.commons.net.ftp;
* TODO replace with an enum * TODO replace with an enum
***/ ***/
public final class FTPReply public final class FTPReply {
{
public static final int RESTART_MARKER = 110; public static final int RESTART_MARKER = 110;
public static final int SERVICE_NOT_READY = 120; public static final int SERVICE_NOT_READY = 120;
public static final int DATA_CONNECTION_ALREADY_OPEN = 125; public static final int DATA_CONNECTION_ALREADY_OPEN = 125;
public static final int FILE_STATUS_OK = 150; public static final int FILE_STATUS_OK = 150;
public static final int COMMAND_OK = 200; public static final int COMMAND_OK = 200;
public static final int COMMAND_IS_SUPERFLUOUS = 202; public static final int COMMAND_IS_SUPERFLUOUS = 202;
public static final int SYSTEM_STATUS = 211; public static final int SYSTEM_STATUS = 211;
public static final int DIRECTORY_STATUS = 212; public static final int DIRECTORY_STATUS = 212;
public static final int FILE_STATUS = 213; public static final int FILE_STATUS = 213;
public static final int HELP_MESSAGE = 214; public static final int HELP_MESSAGE = 214;
public static final int NAME_SYSTEM_TYPE = 215; public static final int NAME_SYSTEM_TYPE = 215;
public static final int SERVICE_READY = 220; public static final int SERVICE_READY = 220;
public static final int SERVICE_CLOSING_CONTROL_CONNECTION = 221; public static final int SERVICE_CLOSING_CONTROL_CONNECTION = 221;
public static final int DATA_CONNECTION_OPEN = 225; public static final int DATA_CONNECTION_OPEN = 225;
public static final int CLOSING_DATA_CONNECTION = 226; public static final int CLOSING_DATA_CONNECTION = 226;
public static final int ENTERING_PASSIVE_MODE = 227; public static final int ENTERING_PASSIVE_MODE = 227;
/** @since 2.2 */ /** @since 2.2 */
public static final int ENTERING_EPSV_MODE = 229; public static final int ENTERING_EPSV_MODE = 229;
public static final int USER_LOGGED_IN = 230; public static final int USER_LOGGED_IN = 230;
public static final int FILE_ACTION_OK = 250; public static final int FILE_ACTION_OK = 250;
public static final int PATHNAME_CREATED = 257; public static final int PATHNAME_CREATED = 257;
public static final int NEED_PASSWORD = 331; public static final int NEED_PASSWORD = 331;
public static final int NEED_ACCOUNT = 332; public static final int NEED_ACCOUNT = 332;
public static final int FILE_ACTION_PENDING = 350; public static final int FILE_ACTION_PENDING = 350;
public static final int SERVICE_NOT_AVAILABLE = 421; public static final int SERVICE_NOT_AVAILABLE = 421;
public static final int CANNOT_OPEN_DATA_CONNECTION = 425; public static final int CANNOT_OPEN_DATA_CONNECTION = 425;
public static final int TRANSFER_ABORTED = 426; public static final int TRANSFER_ABORTED = 426;
public static final int FILE_ACTION_NOT_TAKEN = 450; public static final int FILE_ACTION_NOT_TAKEN = 450;
public static final int ACTION_ABORTED = 451; public static final int ACTION_ABORTED = 451;
public static final int INSUFFICIENT_STORAGE = 452; public static final int INSUFFICIENT_STORAGE = 452;
public static final int UNRECOGNIZED_COMMAND = 500; public static final int UNRECOGNIZED_COMMAND = 500;
public static final int SYNTAX_ERROR_IN_ARGUMENTS = 501; public static final int SYNTAX_ERROR_IN_ARGUMENTS = 501;
public static final int COMMAND_NOT_IMPLEMENTED = 502; public static final int COMMAND_NOT_IMPLEMENTED = 502;
public static final int BAD_COMMAND_SEQUENCE = 503; public static final int BAD_COMMAND_SEQUENCE = 503;
public static final int COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER = 504; public static final int COMMAND_NOT_IMPLEMENTED_FOR_PARAMETER = 504;
public static final int NOT_LOGGED_IN = 530; public static final int NOT_LOGGED_IN = 530;
public static final int NEED_ACCOUNT_FOR_STORING_FILES = 532; public static final int NEED_ACCOUNT_FOR_STORING_FILES = 532;
public static final int FILE_UNAVAILABLE = 550; public static final int FILE_UNAVAILABLE = 550;
public static final int PAGE_TYPE_UNKNOWN = 551; public static final int PAGE_TYPE_UNKNOWN = 551;
public static final int STORAGE_ALLOCATION_EXCEEDED = 552; public static final int STORAGE_ALLOCATION_EXCEEDED = 552;
public static final int FILE_NAME_NOT_ALLOWED = 553; public static final int FILE_NAME_NOT_ALLOWED = 553;
// FTPS Reply Codes // FTPS Reply Codes
/** @since 2.0 */ /** @since 2.0 */
public static final int SECURITY_DATA_EXCHANGE_COMPLETE = 234; public static final int SECURITY_DATA_EXCHANGE_COMPLETE = 234;
/** @since 2.0 */ /** @since 2.0 */
public static final int SECURITY_DATA_EXCHANGE_SUCCESSFULLY = 235; public static final int SECURITY_DATA_EXCHANGE_SUCCESSFULLY = 235;
/** @since 2.0 */ /** @since 2.0 */
public static final int SECURITY_MECHANISM_IS_OK = 334; public static final int SECURITY_MECHANISM_IS_OK = 334;
/** @since 2.0 */ /** @since 2.0 */
public static final int SECURITY_DATA_IS_ACCEPTABLE = 335; public static final int SECURITY_DATA_IS_ACCEPTABLE = 335;
/** @since 2.0 */ /** @since 2.0 */
public static final int UNAVAILABLE_RESOURCE = 431; public static final int UNAVAILABLE_RESOURCE = 431;
/** @since 2.2 */ /** @since 2.2 */
public static final int BAD_TLS_NEGOTIATION_OR_DATA_ENCRYPTION_REQUIRED = 522; public static final int BAD_TLS_NEGOTIATION_OR_DATA_ENCRYPTION_REQUIRED = 522;
/** @since 2.0 */ /** @since 2.0 */
public static final int DENIED_FOR_POLICY_REASONS = 533; public static final int DENIED_FOR_POLICY_REASONS = 533;
/** @since 2.0 */ /** @since 2.0 */
public static final int REQUEST_DENIED = 534; public static final int REQUEST_DENIED = 534;
/** @since 2.0 */ /** @since 2.0 */
public static final int FAILED_SECURITY_CHECK = 535; public static final int FAILED_SECURITY_CHECK = 535;
/** @since 2.0 */ /** @since 2.0 */
public static final int REQUESTED_PROT_LEVEL_NOT_SUPPORTED = 536; public static final int REQUESTED_PROT_LEVEL_NOT_SUPPORTED = 536;
// IPv6 error codes // IPv6 error codes
// Note this is also used as an FTPS error code reply // Note this is also used as an FTPS error code reply
/** @since 2.2 */ /** @since 2.2 */
public static final int EXTENDED_PORT_FAILURE = 522; public static final int EXTENDED_PORT_FAILURE = 522;
// Cannot be instantiated // Cannot be instantiated
private FTPReply() private FTPReply() {
{} }
/*** /***
* Determine if a reply code is a positive preliminary response. All * Determine if a reply code is a positive preliminary response. All
* codes beginning with a 1 are positive preliminary responses. * codes beginning with a 1 are positive preliminary responses.
* Postitive preliminary responses are used to indicate tentative success. * Postitive preliminary responses are used to indicate tentative success.
* No further commands can be issued to the FTP server after a positive * No further commands can be issued to the FTP server after a positive
* preliminary response until a follow up response is received from the * preliminary response until a follow up response is received from the
* server. * server.
* *
* @param reply The reply code to test. * @param reply The reply code to test.
* @return True if a reply code is a postive preliminary response, false * @return True if a reply code is a postive preliminary response, false
* if not. * if not.
***/ ***/
public static boolean isPositivePreliminary(int reply) public static boolean isPositivePreliminary(int reply) {
{ return (reply >= 100 && reply < 200);
return (reply >= 100 && reply < 200); }
}
/*** /***
* Determine if a reply code is a positive completion response. All * Determine if a reply code is a positive completion response. All
* codes beginning with a 2 are positive completion responses. * codes beginning with a 2 are positive completion responses.
* The FTP server will send a positive completion response on the final * The FTP server will send a positive completion response on the final
* successful completion of a command. * successful completion of a command.
* *
* @param reply The reply code to test. * @param reply The reply code to test.
* @return True if a reply code is a postive completion response, false * @return True if a reply code is a postive completion response, false
* if not. * if not.
***/ ***/
public static boolean isPositiveCompletion(int reply) public static boolean isPositiveCompletion(int reply) {
{ return (reply >= 200 && reply < 300);
return (reply >= 200 && reply < 300); }
}
/*** /***
* Determine if a reply code is a positive intermediate response. All * Determine if a reply code is a positive intermediate response. All
* codes beginning with a 3 are positive intermediate responses. * codes beginning with a 3 are positive intermediate responses.
* The FTP server will send a positive intermediate response on the * The FTP server will send a positive intermediate response on the
* successful completion of one part of a multi-part sequence of * successful completion of one part of a multi-part sequence of
* commands. For example, after a successful USER command, a positive * commands. For example, after a successful USER command, a positive
* intermediate response will be sent to indicate that the server is * intermediate response will be sent to indicate that the server is
* ready for the PASS command. * ready for the PASS command.
* *
* @param reply The reply code to test. * @param reply The reply code to test.
* @return True if a reply code is a postive intermediate response, false * @return True if a reply code is a postive intermediate response, false
* if not. * if not.
***/ ***/
public static boolean isPositiveIntermediate(int reply) public static boolean isPositiveIntermediate(int reply) {
{ return (reply >= 300 && reply < 400);
return (reply >= 300 && reply < 400); }
}
/*** /***
* Determine if a reply code is a negative transient response. All * Determine if a reply code is a negative transient response. All
* codes beginning with a 4 are negative transient responses. * codes beginning with a 4 are negative transient responses.
* The FTP server will send a negative transient response on the * The FTP server will send a negative transient response on the
* failure of a command that can be reattempted with success. * failure of a command that can be reattempted with success.
* *
* @param reply The reply code to test. * @param reply The reply code to test.
* @return True if a reply code is a negative transient response, false * @return True if a reply code is a negative transient response, false
* if not. * if not.
***/ ***/
public static boolean isNegativeTransient(int reply) public static boolean isNegativeTransient(int reply) {
{ return (reply >= 400 && reply < 500);
return (reply >= 400 && reply < 500); }
}
/***
* Determine if a reply code is a negative permanent response. All
* codes beginning with a 5 are negative permanent responses.
* The FTP server will send a negative permanent response on the
* failure of a command that cannot be reattempted with success.
*
* @param reply The reply code to test.
* @return True if a reply code is a negative permanent response, false
* if not.
***/
public static boolean isNegativePermanent(int reply)
{
return (reply >= 500 && reply < 600);
}
/**
* Determine if a reply code is a protected response.
* @param reply The reply code to test.
* @return True if a reply code is a protected response, false
* if not.
* @since 3.0
*/
public static boolean isProtectedReplyCode(int reply)
{
// actually, only 3 protected reply codes are
// defined in RFC 2228: 631, 632 and 633.
return (reply >= 600 && reply < 700);
}
/***
* Determine if a reply code is a negative permanent response. All
* codes beginning with a 5 are negative permanent responses.
* The FTP server will send a negative permanent response on the
* failure of a command that cannot be reattempted with success.
*
* @param reply The reply code to test.
* @return True if a reply code is a negative permanent response, false
* if not.
***/
public static boolean isNegativePermanent(int reply) {
return (reply >= 500 && reply < 600);
}
/**
* Determine if a reply code is a protected response.
*
* @param reply The reply code to test.
* @return True if a reply code is a protected response, false
* if not.
* @since 3.0
*/
public static boolean isProtectedReplyCode(int reply) {
// actually, only 3 protected reply codes are
// defined in RFC 2228: 631, 632 and 633.
return (reply >= 600 && reply < 700);
}
} }

View File

@@ -19,34 +19,34 @@ package org.apache.commons.net.ftp;
/** /**
* FTPS-specific commands. * FTPS-specific commands.
*
* @since 2.0 * @since 2.0
* @deprecated 3.0 DO NOT USE * @deprecated 3.0 DO NOT USE
*/ */
@Deprecated @Deprecated public final class FTPSCommand {
public final class FTPSCommand { public static final int AUTH = 0;
public static final int AUTH = 0; public static final int ADAT = 1;
public static final int ADAT = 1; public static final int PBSZ = 2;
public static final int PBSZ = 2; public static final int PROT = 3;
public static final int PROT = 3; public static final int CCC = 4;
public static final int CCC = 4;
public static final int AUTHENTICATION_SECURITY_MECHANISM = AUTH; public static final int AUTHENTICATION_SECURITY_MECHANISM = AUTH;
public static final int AUTHENTICATION_SECURITY_DATA = ADAT; public static final int AUTHENTICATION_SECURITY_DATA = ADAT;
public static final int PROTECTION_BUFFER_SIZE = PBSZ; public static final int PROTECTION_BUFFER_SIZE = PBSZ;
public static final int DATA_CHANNEL_PROTECTION_LEVEL = PROT; public static final int DATA_CHANNEL_PROTECTION_LEVEL = PROT;
public static final int CLEAR_COMMAND_CHANNEL = CCC; public static final int CLEAR_COMMAND_CHANNEL = CCC;
private static final String[] _commands = {"AUTH","ADAT","PBSZ","PROT","CCC"}; private static final String[] _commands = { "AUTH", "ADAT", "PBSZ", "PROT", "CCC" };
/** /**
* Retrieve the FTPS command string corresponding to a specified * Retrieve the FTPS command string corresponding to a specified
* command code. * command code.
* *
* @param command The command code. * @param command The command code.
* @return The FTPS command string corresponding to a specified * @return The FTPS command string corresponding to a specified
* command code. * command code.
*/ */
public static final String getCommand(int command) { public static final String getCommand(int command) {
return _commands[command]; return _commands[command];
} }
} }

View File

@@ -27,48 +27,46 @@ import javax.net.ssl.SSLServerSocket;
/** /**
* Server socket factory for FTPS connections. * Server socket factory for FTPS connections.
*
* @since 2.2 * @since 2.2
*/ */
public class FTPSServerSocketFactory extends ServerSocketFactory { public class FTPSServerSocketFactory extends ServerSocketFactory {
/** Factory for secure socket factories */ /** Factory for secure socket factories */
private final SSLContext context; private final SSLContext context;
public FTPSServerSocketFactory(SSLContext context) { public FTPSServerSocketFactory(SSLContext context) {
this.context = context; this.context = context;
} }
// Override the default superclass method // Override the default superclass method
@Override @Override public ServerSocket createServerSocket() throws IOException {
public ServerSocket createServerSocket() throws IOException { return init(this.context.getServerSocketFactory().createServerSocket());
return init(this.context.getServerSocketFactory().createServerSocket()); }
}
@Override @Override public ServerSocket createServerSocket(int port) throws IOException {
public ServerSocket createServerSocket(int port) throws IOException { return init(this.context.getServerSocketFactory().createServerSocket(port));
return init(this.context.getServerSocketFactory().createServerSocket(port)); }
}
@Override @Override public ServerSocket createServerSocket(int port, int backlog) throws IOException {
public ServerSocket createServerSocket(int port, int backlog) throws IOException { return init(this.context.getServerSocketFactory().createServerSocket(port, backlog));
return init(this.context.getServerSocketFactory().createServerSocket(port, backlog)); }
}
@Override @Override public ServerSocket createServerSocket(int port, int backlog, InetAddress ifAddress)
public ServerSocket createServerSocket(int port, int backlog, InetAddress ifAddress) throws IOException { throws IOException {
return init(this.context.getServerSocketFactory().createServerSocket(port, backlog, ifAddress)); return init(this.context.getServerSocketFactory().createServerSocket(port, backlog, ifAddress));
} }
/** /**
* Sets the socket so newly accepted connections will use SSL client mode. * Sets the socket so newly accepted connections will use SSL client mode.
* *
* @param socket the SSLServerSocket to initialise * @param socket the SSLServerSocket to initialise
* @return the socket * @return the socket
* @throws ClassCastException if socket is not an instance of SSLServerSocket * @throws ClassCastException if socket is not an instance of SSLServerSocket
*/ */
public ServerSocket init(ServerSocket socket) { public ServerSocket init(ServerSocket socket) {
((SSLServerSocket) socket).setUseClientMode(true); ((SSLServerSocket) socket).setUseClientMode(true);
return socket; return socket;
} }
} }

View File

@@ -26,87 +26,91 @@ import javax.net.SocketFactory;
import javax.net.ssl.SSLContext; import javax.net.ssl.SSLContext;
/** /**
*
* Implementation of org.apache.commons.net.SocketFactory * Implementation of org.apache.commons.net.SocketFactory
* *
* @since 2.0 * @since 2.0
*/ */
public class FTPSSocketFactory extends SocketFactory { public class FTPSSocketFactory extends SocketFactory {
private final SSLContext context; private final SSLContext context;
public FTPSSocketFactory(SSLContext context) { public FTPSSocketFactory(SSLContext context) {
this.context = context; this.context = context;
} }
// Override the default implementation // Override the default implementation
@Override @Override public Socket createSocket() throws IOException {
public Socket createSocket() throws IOException{ return this.context.getSocketFactory().createSocket();
return this.context.getSocketFactory().createSocket(); }
}
@Override @Override public Socket createSocket(String address, int port)
public Socket createSocket(String address, int port) throws UnknownHostException, IOException { throws UnknownHostException, IOException {
return this.context.getSocketFactory().createSocket(address, port); return this.context.getSocketFactory().createSocket(address, port);
} }
@Override @Override public Socket createSocket(InetAddress address, int port) throws IOException {
public Socket createSocket(InetAddress address, int port) throws IOException { return this.context.getSocketFactory().createSocket(address, port);
return this.context.getSocketFactory().createSocket(address, port); }
}
@Override @Override
public Socket createSocket(String address, int port, InetAddress localAddress, int localPort) public Socket createSocket(String address, int port, InetAddress localAddress, int localPort)
throws UnknownHostException, IOException { throws UnknownHostException, IOException {
return this.context.getSocketFactory().createSocket(address, port, localAddress, localPort); return this.context.getSocketFactory().createSocket(address, port, localAddress, localPort);
} }
@Override @Override
public Socket createSocket(InetAddress address, int port, InetAddress localAddress, int localPort) throws IOException { public Socket createSocket(InetAddress address, int port, InetAddress localAddress, int localPort)
return this.context.getSocketFactory().createSocket(address, port, localAddress, localPort); throws IOException {
} return this.context.getSocketFactory().createSocket(address, port, localAddress, localPort);
}
// DEPRECATED METHODS - for API compatibility only - DO NOT USE
// DEPRECATED METHODS - for API compatibility only - DO NOT USE /**
* @param port the port
* @return the socket
* @throws IOException on error
* @deprecated (2.2) use {@link FTPSServerSocketFactory#createServerSocket(int) instead}
*/
@Deprecated public java.net.ServerSocket createServerSocket(int port) throws IOException {
return this.init(this.context.getServerSocketFactory().createServerSocket(port));
}
/** @param port the port /**
* @return the socket * @param port the port
* @throws IOException on error * @param backlog the backlog
* @deprecated (2.2) use {@link FTPSServerSocketFactory#createServerSocket(int) instead} */ * @return the socket
@Deprecated * @throws IOException on error
public java.net.ServerSocket createServerSocket(int port) throws IOException { * @deprecated (2.2) use {@link FTPSServerSocketFactory#createServerSocket(int, int) instead}
return this.init(this.context.getServerSocketFactory().createServerSocket(port)); */
} @Deprecated public java.net.ServerSocket createServerSocket(int port, int backlog)
throws IOException {
return this.init(this.context.getServerSocketFactory().createServerSocket(port, backlog));
}
/** @param port the port /**
* @param backlog the backlog * @param port the port
* @return the socket * @param backlog the backlog
* @throws IOException on error * @param ifAddress the interface
* @deprecated (2.2) use {@link FTPSServerSocketFactory#createServerSocket(int, int) instead} */ * @return the socket
@Deprecated * @throws IOException on error
public java.net.ServerSocket createServerSocket(int port, int backlog) throws IOException { * @deprecated (2.2) use {@link FTPSServerSocketFactory#createServerSocket(int, int, InetAddress)
return this.init(this.context.getServerSocketFactory().createServerSocket(port, backlog)); * instead}
} */
@Deprecated public java.net.ServerSocket createServerSocket(int port, int backlog,
/** @param port the port InetAddress ifAddress) throws IOException {
* @param backlog the backlog return this.init(
* @param ifAddress the interface this.context.getServerSocketFactory().createServerSocket(port, backlog, ifAddress));
* @return the socket }
* @throws IOException on error
* @deprecated (2.2) use {@link FTPSServerSocketFactory#createServerSocket(int, int, InetAddress) instead} */
@Deprecated
public java.net.ServerSocket createServerSocket(int port, int backlog, InetAddress ifAddress) throws IOException {
return this.init(this.context.getServerSocketFactory().createServerSocket(port, backlog, ifAddress));
}
/** @param socket the socket
* @return the socket
* @throws IOException on error
* @deprecated (2.2) use {@link FTPSServerSocketFactory#init(java.net.ServerSocket)} */
@Deprecated
public java.net.ServerSocket init(java.net.ServerSocket socket) throws IOException {
((javax.net.ssl.SSLServerSocket) socket).setUseClientMode(true);
return socket;
}
/**
* @param socket the socket
* @return the socket
* @throws IOException on error
* @deprecated (2.2) use {@link FTPSServerSocketFactory#init(java.net.ServerSocket)}
*/
@Deprecated public java.net.ServerSocket init(java.net.ServerSocket socket) throws IOException {
((javax.net.ssl.SSLServerSocket) socket).setUseClientMode(true);
return socket;
}
} }

View File

@@ -24,37 +24,30 @@ import javax.net.ssl.X509TrustManager;
/** /**
* Do not use. * Do not use.
*
* @since 2.0 * @since 2.0
* @deprecated 3.0 use * @deprecated 3.0 use
* {@link org.apache.commons.net.util.TrustManagerUtils#getValidateServerCertificateTrustManager() * {@link org.apache.commons.net.util.TrustManagerUtils#getValidateServerCertificateTrustManager()
* TrustManagerUtils#getValidateServerCertificateTrustManager()} instead * TrustManagerUtils#getValidateServerCertificateTrustManager()} instead
*/ */
@Deprecated @Deprecated public class FTPSTrustManager implements X509TrustManager {
public class FTPSTrustManager implements X509TrustManager private static final X509Certificate[] EMPTY_X509CERTIFICATE_ARRAY = new X509Certificate[] {};
{
private static final X509Certificate[] EMPTY_X509CERTIFICATE_ARRAY = new X509Certificate[]{};
/** /**
* No-op * No-op
*/ */
@Override @Override public void checkClientTrusted(X509Certificate[] certificates, String authType) {
public void checkClientTrusted(X509Certificate[] certificates, String authType) return;
{ }
return;
}
@Override @Override public void checkServerTrusted(X509Certificate[] certificates, String authType)
public void checkServerTrusted(X509Certificate[] certificates, String authType) throws CertificateException throws CertificateException {
{ for (X509Certificate certificate : certificates) {
for (X509Certificate certificate : certificates) certificate.checkValidity();
{
certificate.checkValidity();
}
} }
}
@Override @Override public X509Certificate[] getAcceptedIssuers() {
public X509Certificate[] getAcceptedIssuers() return EMPTY_X509CERTIFICATE_ARRAY;
{ }
return EMPTY_X509CERTIFICATE_ARRAY;
}
} }

View File

@@ -0,0 +1,33 @@
/*
* Copyright (C) 2016 AriaLyy(https://github.com/AriaLyy/Aria)
*
* Licensed 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.commons.net.ftp;
import org.apache.commons.net.io.CopyStreamListener;
/**
* Created by AriaL on 2017/9/26.
* ftp 上传文件流事件监听
*/
public interface OnFtpInputStreamListener {
/**
* {@link CopyStreamListener#bytesTransferred(long, int, long)}
*
* @param totalBytesTransferred 已经上传的文件长度
* @param bytesTransferred 上传byte长度
*/
void onFtpInputStream(FTPClient client, long totalBytesTransferred, int bytesTransferred,
long streamSize);
}

View File

@@ -28,42 +28,32 @@ import org.apache.commons.net.ftp.FTPFileEntryParserImpl;
* If the cached parser wont match due to the server changed the dirstyle, * If the cached parser wont match due to the server changed the dirstyle,
* a new matching parser will be searched. * a new matching parser will be searched.
*/ */
public class CompositeFileEntryParser extends FTPFileEntryParserImpl public class CompositeFileEntryParser extends FTPFileEntryParserImpl {
{ private final FTPFileEntryParser[] ftpFileEntryParsers;
private final FTPFileEntryParser[] ftpFileEntryParsers; private FTPFileEntryParser cachedFtpFileEntryParser;
private FTPFileEntryParser cachedFtpFileEntryParser;
public CompositeFileEntryParser(FTPFileEntryParser[] ftpFileEntryParsers) public CompositeFileEntryParser(FTPFileEntryParser[] ftpFileEntryParsers) {
{ super();
super();
this.cachedFtpFileEntryParser = null; this.cachedFtpFileEntryParser = null;
this.ftpFileEntryParsers = ftpFileEntryParsers; this.ftpFileEntryParsers = ftpFileEntryParsers;
} }
@Override @Override public FTPFile parseFTPEntry(String listEntry) {
public FTPFile parseFTPEntry(String listEntry) if (cachedFtpFileEntryParser != null) {
{ FTPFile matched = cachedFtpFileEntryParser.parseFTPEntry(listEntry);
if (cachedFtpFileEntryParser != null) if (matched != null) {
{ return matched;
FTPFile matched = cachedFtpFileEntryParser.parseFTPEntry(listEntry); }
if (matched != null) } else {
{ for (FTPFileEntryParser ftpFileEntryParser : ftpFileEntryParsers) {
return matched; FTPFile matched = ftpFileEntryParser.parseFTPEntry(listEntry);
} if (matched != null) {
cachedFtpFileEntryParser = ftpFileEntryParser;
return matched;
} }
else }
{
for (FTPFileEntryParser ftpFileEntryParser : ftpFileEntryParsers)
{
FTPFile matched = ftpFileEntryParser.parseFTPEntry(listEntry);
if (matched != null)
{
cachedFtpFileEntryParser = ftpFileEntryParser;
return matched;
}
}
}
return null;
} }
return null;
}
} }

View File

@@ -23,7 +23,6 @@ import java.util.Calendar;
import org.apache.commons.net.ftp.Configurable; import org.apache.commons.net.ftp.Configurable;
import org.apache.commons.net.ftp.FTPClientConfig; import org.apache.commons.net.ftp.FTPClientConfig;
/** /**
* <p> * <p>
* This abstract class implements the common timestamp parsing * This abstract class implements the common timestamp parsing
@@ -38,91 +37,88 @@ import org.apache.commons.net.ftp.FTPClientConfig;
* *
* @since 1.4 * @since 1.4
*/ */
public abstract class ConfigurableFTPFileEntryParserImpl public abstract class ConfigurableFTPFileEntryParserImpl extends RegexFTPFileEntryParserImpl
extends RegexFTPFileEntryParserImpl implements Configurable {
implements Configurable
{
private final FTPTimestampParser timestampParser; private final FTPTimestampParser timestampParser;
/** /**
* constructor for this abstract class. * constructor for this abstract class.
* @param regex Regular expression used main parsing of the *
* file listing. * @param regex Regular expression used main parsing of the
*/ * file listing.
public ConfigurableFTPFileEntryParserImpl(String regex) */
{ public ConfigurableFTPFileEntryParserImpl(String regex) {
super(regex); super(regex);
this.timestampParser = new FTPTimestampParserImpl(); this.timestampParser = new FTPTimestampParserImpl();
} }
/** /**
* constructor for this abstract class. * constructor for this abstract class.
* @param regex Regular expression used main parsing of the *
* file listing. * @param regex Regular expression used main parsing of the
* @param flags the flags to apply, see * file listing.
* {@link java.util.regex.Pattern#compile(String, int) Pattern#compile(String, int)}. Use 0 for none. * @param flags the flags to apply, see
* @since 3.4 * {@link java.util.regex.Pattern#compile(String, int) Pattern#compile(String, int)}. Use 0 for
*/ * none.
public ConfigurableFTPFileEntryParserImpl(String regex, int flags) * @since 3.4
{ */
super(regex, flags); public ConfigurableFTPFileEntryParserImpl(String regex, int flags) {
this.timestampParser = new FTPTimestampParserImpl(); super(regex, flags);
} this.timestampParser = new FTPTimestampParserImpl();
}
/** /**
* This method is called by the concrete parsers to delegate * This method is called by the concrete parsers to delegate
* timestamp parsing to the timestamp parser. * timestamp parsing to the timestamp parser.
* *
* @param timestampStr the timestamp string pulled from the * @param timestampStr the timestamp string pulled from the
* file listing by the regular expression parser, to be submitted * file listing by the regular expression parser, to be submitted
* to the <code>timestampParser</code> for extracting the timestamp. * to the <code>timestampParser</code> for extracting the timestamp.
* @return a <code>java.util.Calendar</code> containing results of the * @return a <code>java.util.Calendar</code> containing results of the
* timestamp parse. * timestamp parse.
* @throws ParseException on parse error * @throws ParseException on parse error
*/ */
public Calendar parseTimestamp(String timestampStr) throws ParseException { public Calendar parseTimestamp(String timestampStr) throws ParseException {
return this.timestampParser.parseTimestamp(timestampStr); return this.timestampParser.parseTimestamp(timestampStr);
} }
/**
/** * Implementation of the {@link Configurable Configurable}
* Implementation of the {@link Configurable Configurable} * interface. Configures this parser by delegating to the
* interface. Configures this parser by delegating to the * underlying Configurable FTPTimestampParser implementation, '
* underlying Configurable FTPTimestampParser implementation, ' * passing it the supplied {@link FTPClientConfig FTPClientConfig}
* passing it the supplied {@link FTPClientConfig FTPClientConfig} * if that is non-null or a default configuration defined by
* if that is non-null or a default configuration defined by * each concrete subclass.
* each concrete subclass. *
* * @param config the configuration to be used to configure this parser.
* @param config the configuration to be used to configure this parser. * If it is null, a default configuration defined by
* If it is null, a default configuration defined by * each concrete subclass is used instead.
* each concrete subclass is used instead. */
*/ @Override public void configure(FTPClientConfig config) {
@Override if (this.timestampParser instanceof Configurable) {
public void configure(FTPClientConfig config) FTPClientConfig defaultCfg = getDefaultConfiguration();
{ if (config != null) {
if (this.timestampParser instanceof Configurable) { if (null == config.getDefaultDateFormatStr()) {
FTPClientConfig defaultCfg = getDefaultConfiguration(); config.setDefaultDateFormatStr(defaultCfg.getDefaultDateFormatStr());
if (config != null) {
if (null == config.getDefaultDateFormatStr()) {
config.setDefaultDateFormatStr(defaultCfg.getDefaultDateFormatStr());
}
if (null == config.getRecentDateFormatStr()) {
config.setRecentDateFormatStr(defaultCfg.getRecentDateFormatStr());
}
((Configurable)this.timestampParser).configure(config);
} else {
((Configurable)this.timestampParser).configure(defaultCfg);
}
} }
if (null == config.getRecentDateFormatStr()) {
config.setRecentDateFormatStr(defaultCfg.getRecentDateFormatStr());
}
((Configurable) this.timestampParser).configure(config);
} else {
((Configurable) this.timestampParser).configure(defaultCfg);
}
} }
}
/** /**
* Each concrete subclass must define this member to create * Each concrete subclass must define this member to create
* a default configuration to be used when that subclass is * a default configuration to be used when that subclass is
* instantiated without a {@link FTPClientConfig FTPClientConfig} * instantiated without a {@link FTPClientConfig FTPClientConfig}
* parameter being specified. * parameter being specified.
* @return the default configuration for the subclass. *
*/ * @return the default configuration for the subclass.
protected abstract FTPClientConfig getDefaultConfiguration(); */
protected abstract FTPClientConfig getDefaultConfiguration();
} }

View File

@@ -23,7 +23,6 @@ import org.apache.commons.net.ftp.Configurable;
import org.apache.commons.net.ftp.FTPClientConfig; import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFileEntryParser; import org.apache.commons.net.ftp.FTPFileEntryParser;
/** /**
* This is the default implementation of the * This is the default implementation of the
* FTPFileEntryParserFactory interface. This is the * FTPFileEntryParserFactory interface. This is the
@@ -34,262 +33,222 @@ import org.apache.commons.net.ftp.FTPFileEntryParser;
* @see org.apache.commons.net.ftp.FTPClient#listFiles * @see org.apache.commons.net.ftp.FTPClient#listFiles
* @see org.apache.commons.net.ftp.FTPClient#setParserFactory * @see org.apache.commons.net.ftp.FTPClient#setParserFactory
*/ */
public class DefaultFTPFileEntryParserFactory public class DefaultFTPFileEntryParserFactory implements FTPFileEntryParserFactory {
implements FTPFileEntryParserFactory
{
// Match a plain Java Identifier // Match a plain Java Identifier
private static final String JAVA_IDENTIFIER = "\\p{javaJavaIdentifierStart}(\\p{javaJavaIdentifierPart})*"; private static final String JAVA_IDENTIFIER =
// Match a qualified name, e.g. a.b.c.Name - but don't allow the default package as that would allow "VMS"/"UNIX" etc. "\\p{javaJavaIdentifierStart}(\\p{javaJavaIdentifierPart})*";
private static final String JAVA_QUALIFIED_NAME = "("+JAVA_IDENTIFIER+"\\.)+"+JAVA_IDENTIFIER; // Match a qualified name, e.g. a.b.c.Name - but don't allow the default package as that would allow "VMS"/"UNIX" etc.
// Create the pattern, as it will be reused many times private static final String JAVA_QUALIFIED_NAME =
private static final Pattern JAVA_QUALIFIED_NAME_PATTERN = Pattern.compile(JAVA_QUALIFIED_NAME); "(" + JAVA_IDENTIFIER + "\\.)+" + JAVA_IDENTIFIER;
// Create the pattern, as it will be reused many times
private static final Pattern JAVA_QUALIFIED_NAME_PATTERN = Pattern.compile(JAVA_QUALIFIED_NAME);
/** /**
* This default implementation of the FTPFileEntryParserFactory * This default implementation of the FTPFileEntryParserFactory
* interface works according to the following logic: * interface works according to the following logic:
* First it attempts to interpret the supplied key as a fully * First it attempts to interpret the supplied key as a fully
* qualified classname (default package is not allowed) of a class implementing the * qualified classname (default package is not allowed) of a class implementing the
* FTPFileEntryParser interface. If that succeeds, a parser * FTPFileEntryParser interface. If that succeeds, a parser
* object of this class is instantiated and is returned; * object of this class is instantiated and is returned;
* otherwise it attempts to interpret the key as an identirier * otherwise it attempts to interpret the key as an identirier
* commonly used by the FTP SYST command to identify systems. * commonly used by the FTP SYST command to identify systems.
* <p> * <p>
* If <code>key</code> is not recognized as a fully qualified * If <code>key</code> is not recognized as a fully qualified
* classname known to the system, this method will then attempt * classname known to the system, this method will then attempt
* to see whether it <b>contains</b> a string identifying one of * to see whether it <b>contains</b> a string identifying one of
* the known parsers. This comparison is <b>case-insensitive</b>. * the known parsers. This comparison is <b>case-insensitive</b>.
* The intent here is where possible, to select as keys strings * The intent here is where possible, to select as keys strings
* which are returned by the SYST command on the systems which * which are returned by the SYST command on the systems which
* the corresponding parser successfully parses. This enables * the corresponding parser successfully parses. This enables
* this factory to be used in the auto-detection system. * this factory to be used in the auto-detection system.
* *
* @param key should be a fully qualified classname corresponding to * @param key should be a fully qualified classname corresponding to
* a class implementing the FTPFileEntryParser interface<br> * a class implementing the FTPFileEntryParser interface<br>
* OR<br> * OR<br>
* a string containing (case-insensitively) one of the * a string containing (case-insensitively) one of the
* following keywords: * following keywords:
* <ul> * <ul>
* <li>{@link FTPClientConfig#SYST_UNIX UNIX}</li> * <li>{@link FTPClientConfig#SYST_UNIX UNIX}</li>
* <li>{@link FTPClientConfig#SYST_NT WINDOWS}</li> * <li>{@link FTPClientConfig#SYST_NT WINDOWS}</li>
* <li>{@link FTPClientConfig#SYST_OS2 OS/2}</li> * <li>{@link FTPClientConfig#SYST_OS2 OS/2}</li>
* <li>{@link FTPClientConfig#SYST_OS400 OS/400}</li> * <li>{@link FTPClientConfig#SYST_OS400 OS/400}</li>
* <li>{@link FTPClientConfig#SYST_AS400 AS/400}</li> * <li>{@link FTPClientConfig#SYST_AS400 AS/400}</li>
* <li>{@link FTPClientConfig#SYST_VMS VMS}</li> * <li>{@link FTPClientConfig#SYST_VMS VMS}</li>
* <li>{@link FTPClientConfig#SYST_MVS MVS}</li> * <li>{@link FTPClientConfig#SYST_MVS MVS}</li>
* <li>{@link FTPClientConfig#SYST_NETWARE NETWARE}</li> * <li>{@link FTPClientConfig#SYST_NETWARE NETWARE}</li>
* <li>{@link FTPClientConfig#SYST_L8 TYPE:L8}</li> * <li>{@link FTPClientConfig#SYST_L8 TYPE:L8}</li>
* </ul> * </ul>
* @return the FTPFileEntryParser corresponding to the supplied key. * @return the FTPFileEntryParser corresponding to the supplied key.
* @throws ParserInitializationException thrown if for any reason the factory cannot resolve * @throws ParserInitializationException thrown if for any reason the factory cannot resolve
* the supplied key into an FTPFileEntryParser. * the supplied key into an FTPFileEntryParser.
* @see FTPFileEntryParser * @see FTPFileEntryParser
*/ */
@Override @Override public FTPFileEntryParser createFileEntryParser(String key) {
public FTPFileEntryParser createFileEntryParser(String key) if (key == null) {
{ throw new ParserInitializationException("Parser key cannot be null");
if (key == null) { }
throw new ParserInitializationException("Parser key cannot be null"); return createFileEntryParser(key, null);
}
// Common method to process both key and config parameters.
private FTPFileEntryParser createFileEntryParser(String key, FTPClientConfig config) {
FTPFileEntryParser parser = null;
// Is the key a possible class name?
if (JAVA_QUALIFIED_NAME_PATTERN.matcher(key).matches()) {
try {
Class<?> parserClass = Class.forName(key);
try {
parser = (FTPFileEntryParser) parserClass.newInstance();
} catch (ClassCastException e) {
throw new ParserInitializationException(parserClass.getName()
+ " does not implement the interface "
+ "org.apache.commons.net.ftp.FTPFileEntryParser.", e);
} catch (Exception e) {
throw new ParserInitializationException("Error initializing parser", e);
} catch (ExceptionInInitializerError e) {
throw new ParserInitializationException("Error initializing parser", e);
} }
return createFileEntryParser(key, null); } catch (ClassNotFoundException e) {
// OK, assume it is an alias
}
} }
// Common method to process both key and config parameters. if (parser == null) { // Now try for aliases
private FTPFileEntryParser createFileEntryParser(String key, FTPClientConfig config) { String ukey = key.toUpperCase(java.util.Locale.ENGLISH);
FTPFileEntryParser parser = null; if (ukey.indexOf(FTPClientConfig.SYST_UNIX_TRIM_LEADING) >= 0) {
parser = new UnixFTPEntryParser(config, true);
// Is the key a possible class name? }
if (JAVA_QUALIFIED_NAME_PATTERN.matcher(key).matches()) { // must check this after SYST_UNIX_TRIM_LEADING as it is a substring of it
try else if (ukey.indexOf(FTPClientConfig.SYST_UNIX) >= 0) {
{ parser = new UnixFTPEntryParser(config, false);
Class<?> parserClass = Class.forName(key); } else if (ukey.indexOf(FTPClientConfig.SYST_VMS) >= 0) {
try { parser = new VMSVersioningFTPEntryParser(config);
parser = (FTPFileEntryParser) parserClass.newInstance(); } else if (ukey.indexOf(FTPClientConfig.SYST_NT) >= 0) {
} catch (ClassCastException e) { parser = createNTFTPEntryParser(config);
throw new ParserInitializationException(parserClass.getName() } else if (ukey.indexOf(FTPClientConfig.SYST_OS2) >= 0) {
+ " does not implement the interface " parser = new OS2FTPEntryParser(config);
+ "org.apache.commons.net.ftp.FTPFileEntryParser.", e); } else if (ukey.indexOf(FTPClientConfig.SYST_OS400) >= 0
} catch (Exception e) { || ukey.indexOf(FTPClientConfig.SYST_AS400) >= 0) {
throw new ParserInitializationException("Error initializing parser", e); parser = createOS400FTPEntryParser(config);
} catch (ExceptionInInitializerError e) { } else if (ukey.indexOf(FTPClientConfig.SYST_MVS) >= 0) {
throw new ParserInitializationException("Error initializing parser", e); parser = new MVSFTPEntryParser(); // Does not currently support config parameter
} } else if (ukey.indexOf(FTPClientConfig.SYST_NETWARE) >= 0) {
} catch (ClassNotFoundException e) { parser = new NetwareFTPEntryParser(config);
// OK, assume it is an alias } else if (ukey.indexOf(FTPClientConfig.SYST_MACOS_PETER) >= 0) {
} parser = new MacOsPeterFTPEntryParser(config);
} } else if (ukey.indexOf(FTPClientConfig.SYST_L8) >= 0) {
// L8 normally means Unix, but move it to the end for some L8 systems that aren't.
if (parser == null) { // Now try for aliases // This check should be last!
String ukey = key.toUpperCase(java.util.Locale.ENGLISH); parser = new UnixFTPEntryParser(config);
if (ukey.indexOf(FTPClientConfig.SYST_UNIX_TRIM_LEADING) >= 0) } else {
{ throw new ParserInitializationException("Unknown parser type: " + key);
parser = new UnixFTPEntryParser(config, true); }
}
// must check this after SYST_UNIX_TRIM_LEADING as it is a substring of it
else if (ukey.indexOf(FTPClientConfig.SYST_UNIX) >= 0)
{
parser = new UnixFTPEntryParser(config, false);
}
else if (ukey.indexOf(FTPClientConfig.SYST_VMS) >= 0)
{
parser = new VMSVersioningFTPEntryParser(config);
}
else if (ukey.indexOf(FTPClientConfig.SYST_NT) >= 0)
{
parser = createNTFTPEntryParser(config);
}
else if (ukey.indexOf(FTPClientConfig.SYST_OS2) >= 0)
{
parser = new OS2FTPEntryParser(config);
}
else if (ukey.indexOf(FTPClientConfig.SYST_OS400) >= 0 ||
ukey.indexOf(FTPClientConfig.SYST_AS400) >= 0)
{
parser = createOS400FTPEntryParser(config);
}
else if (ukey.indexOf(FTPClientConfig.SYST_MVS) >= 0)
{
parser = new MVSFTPEntryParser(); // Does not currently support config parameter
}
else if (ukey.indexOf(FTPClientConfig.SYST_NETWARE) >= 0)
{
parser = new NetwareFTPEntryParser(config);
}
else if (ukey.indexOf(FTPClientConfig.SYST_MACOS_PETER) >= 0)
{
parser = new MacOsPeterFTPEntryParser(config);
}
else if (ukey.indexOf(FTPClientConfig.SYST_L8) >= 0)
{
// L8 normally means Unix, but move it to the end for some L8 systems that aren't.
// This check should be last!
parser = new UnixFTPEntryParser(config);
}
else
{
throw new ParserInitializationException("Unknown parser type: " + key);
}
}
if (parser instanceof Configurable) {
((Configurable)parser).configure(config);
}
return parser;
} }
/** if (parser instanceof Configurable) {
* <p>Implementation extracts a key from the supplied ((Configurable) parser).configure(config);
* {@link FTPClientConfig FTPClientConfig}
* parameter and creates an object implementing the
* interface FTPFileEntryParser and uses the supplied configuration
* to configure it.
* </p><p>
* Note that this method will generally not be called in scenarios
* that call for autodetection of parser type but rather, for situations
* where the user knows that the server uses a non-default configuration
* and knows what that configuration is.
* </p>
* @param config A {@link FTPClientConfig FTPClientConfig}
* used to configure the parser created
*
* @return the @link FTPFileEntryParser FTPFileEntryParser} so created.
* @throws ParserInitializationException
* Thrown on any exception in instantiation
* @throws NullPointerException if {@code config} is {@code null}
* @since 1.4
*/
@Override
public FTPFileEntryParser createFileEntryParser(FTPClientConfig config)
throws ParserInitializationException
{
String key = config.getServerSystemKey();
return createFileEntryParser(key, config);
} }
return parser;
}
/**
* <p>Implementation extracts a key from the supplied
* {@link FTPClientConfig FTPClientConfig}
* parameter and creates an object implementing the
* interface FTPFileEntryParser and uses the supplied configuration
* to configure it.
* </p><p>
* Note that this method will generally not be called in scenarios
* that call for autodetection of parser type but rather, for situations
* where the user knows that the server uses a non-default configuration
* and knows what that configuration is.
* </p>
*
* @param config A {@link FTPClientConfig FTPClientConfig}
* used to configure the parser created
* @return the @link FTPFileEntryParser FTPFileEntryParser} so created.
* @throws ParserInitializationException Thrown on any exception in instantiation
* @throws NullPointerException if {@code config} is {@code null}
* @since 1.4
*/
@Override public FTPFileEntryParser createFileEntryParser(FTPClientConfig config)
throws ParserInitializationException {
String key = config.getServerSystemKey();
return createFileEntryParser(key, config);
}
public FTPFileEntryParser createUnixFTPEntryParser() public FTPFileEntryParser createUnixFTPEntryParser() {
{ return new UnixFTPEntryParser();
return new UnixFTPEntryParser(); }
public FTPFileEntryParser createVMSVersioningFTPEntryParser() {
return new VMSVersioningFTPEntryParser();
}
public FTPFileEntryParser createNetwareFTPEntryParser() {
return new NetwareFTPEntryParser();
}
public FTPFileEntryParser createNTFTPEntryParser() {
return createNTFTPEntryParser(null);
}
/**
* Creates an NT FTP parser: if the config exists, and the system key equals
* {@link FTPClientConfig.SYST_NT} then a plain {@link NTFTPEntryParser} is used,
* otherwise a composite of {@link NTFTPEntryParser} and {@link UnixFTPEntryParser} is used.
*
* @param config the config to use, may be {@code null}
* @return the parser
*/
private FTPFileEntryParser createNTFTPEntryParser(FTPClientConfig config) {
if (config != null && FTPClientConfig.SYST_NT.equals(config.getServerSystemKey())) {
return new NTFTPEntryParser(config);
} else {
// clone the config as it may be changed by the parsers (NET-602)
final FTPClientConfig config2 = (config != null) ? new FTPClientConfig(config) : null;
return new CompositeFileEntryParser(new FTPFileEntryParser[] {
new NTFTPEntryParser(config), new UnixFTPEntryParser(config2,
config2 != null && FTPClientConfig.SYST_UNIX_TRIM_LEADING.equals(
config2.getServerSystemKey()))
});
} }
}
public FTPFileEntryParser createVMSVersioningFTPEntryParser() public FTPFileEntryParser createOS2FTPEntryParser() {
{ return new OS2FTPEntryParser();
return new VMSVersioningFTPEntryParser(); }
}
public FTPFileEntryParser createOS400FTPEntryParser() {
public FTPFileEntryParser createNetwareFTPEntryParser() { return createOS400FTPEntryParser(null);
return new NetwareFTPEntryParser(); }
}
/**
public FTPFileEntryParser createNTFTPEntryParser() * Creates an OS400 FTP parser: if the config exists, and the system key equals
{ * {@link FTPClientConfig.SYST_OS400} then a plain {@link OS400FTPEntryParser} is used,
return createNTFTPEntryParser(null); * otherwise a composite of {@link OS400FTPEntryParser} and {@link UnixFTPEntryParser} is used.
} *
* @param config the config to use, may be {@code null}
/** * @return the parser
* Creates an NT FTP parser: if the config exists, and the system key equals */
* {@link FTPClientConfig.SYST_NT} then a plain {@link NTFTPEntryParser} is used, private FTPFileEntryParser createOS400FTPEntryParser(FTPClientConfig config) {
* otherwise a composite of {@link NTFTPEntryParser} and {@link UnixFTPEntryParser} is used. if (config != null && FTPClientConfig.SYST_OS400.equals(config.getServerSystemKey())) {
* @param config the config to use, may be {@code null} return new OS400FTPEntryParser(config);
* @return the parser } else {
*/ // clone the config as it may be changed by the parsers (NET-602)
private FTPFileEntryParser createNTFTPEntryParser(FTPClientConfig config) final FTPClientConfig config2 = (config != null) ? new FTPClientConfig(config) : null;
{ return new CompositeFileEntryParser(new FTPFileEntryParser[] {
if (config != null && FTPClientConfig.SYST_NT.equals( new OS400FTPEntryParser(config), new UnixFTPEntryParser(config2,
config.getServerSystemKey())) config2 != null && FTPClientConfig.SYST_UNIX_TRIM_LEADING.equals(
{ config2.getServerSystemKey()))
return new NTFTPEntryParser(config); });
} else {
// clone the config as it may be changed by the parsers (NET-602)
final FTPClientConfig config2 = (config != null) ? new FTPClientConfig(config) : null;
return new CompositeFileEntryParser(new FTPFileEntryParser[]
{
new NTFTPEntryParser(config),
new UnixFTPEntryParser(config2,
config2 != null && FTPClientConfig.SYST_UNIX_TRIM_LEADING.equals(config2.getServerSystemKey()))
});
}
}
public FTPFileEntryParser createOS2FTPEntryParser()
{
return new OS2FTPEntryParser();
}
public FTPFileEntryParser createOS400FTPEntryParser()
{
return createOS400FTPEntryParser(null);
}
/**
* Creates an OS400 FTP parser: if the config exists, and the system key equals
* {@link FTPClientConfig.SYST_OS400} then a plain {@link OS400FTPEntryParser} is used,
* otherwise a composite of {@link OS400FTPEntryParser} and {@link UnixFTPEntryParser} is used.
* @param config the config to use, may be {@code null}
* @return the parser
*/
private FTPFileEntryParser createOS400FTPEntryParser(FTPClientConfig config)
{
if (config != null &&
FTPClientConfig.SYST_OS400.equals(config.getServerSystemKey()))
{
return new OS400FTPEntryParser(config);
} else {
// clone the config as it may be changed by the parsers (NET-602)
final FTPClientConfig config2 = (config != null) ? new FTPClientConfig(config) : null;
return new CompositeFileEntryParser(new FTPFileEntryParser[]
{
new OS400FTPEntryParser(config),
new UnixFTPEntryParser(config2,
config2 != null && FTPClientConfig.SYST_UNIX_TRIM_LEADING.equals(config2.getServerSystemKey()))
});
}
}
public FTPFileEntryParser createMVSEntryParser()
{
return new MVSFTPEntryParser();
} }
}
public FTPFileEntryParser createMVSEntryParser() {
return new MVSFTPEntryParser();
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp.parser; package org.apache.commons.net.ftp.parser;
import java.util.Calendar; import java.util.Calendar;
import org.apache.commons.net.ftp.FTPFile; import org.apache.commons.net.ftp.FTPFile;
@@ -23,144 +24,136 @@ import org.apache.commons.net.ftp.FTPFile;
/** /**
* Parser for the Connect Enterprise Unix FTP Server From Sterling Commerce. * Parser for the Connect Enterprise Unix FTP Server From Sterling Commerce.
* Here is a sample of the sort of output line this parser processes: * Here is a sample of the sort of output line this parser processes:
* "-C--E-----FTP B QUA1I1 18128 41 Aug 12 13:56 QUADTEST" * "-C--E-----FTP B QUA1I1 18128 41 Aug 12 13:56 QUADTEST"
* <P><B> * <P><B>
* Note: EnterpriseUnixFTPEntryParser can only be instantiated through the * Note: EnterpriseUnixFTPEntryParser can only be instantiated through the
* DefaultFTPParserFactory by classname. It will not be chosen * DefaultFTPParserFactory by classname. It will not be chosen
* by the autodetection scheme. * by the autodetection scheme.
* </B> * </B>
*
* @version $Id: EnterpriseUnixFTPEntryParser.java 1741829 2016-05-01 00:24:44Z sebb $ * @version $Id: EnterpriseUnixFTPEntryParser.java 1741829 2016-05-01 00:24:44Z sebb $
* @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions) * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
* @see org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory * @see org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory
*/ */
public class EnterpriseUnixFTPEntryParser extends RegexFTPFileEntryParserImpl public class EnterpriseUnixFTPEntryParser extends RegexFTPFileEntryParserImpl {
{
/** /**
* months abbreviations looked for by this parser. Also used * months abbreviations looked for by this parser. Also used
* to determine <b>which</b> month has been matched by the parser. * to determine <b>which</b> month has been matched by the parser.
*/ */
private static final String MONTHS = private static final String MONTHS = "(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)";
"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)";
/** /**
* this is the regular expression used by this parser. * this is the regular expression used by this parser.
*/ */
private static final String REGEX = private static final String REGEX =
"(([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])" "(([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])"
+ "([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z]))" + "([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z])([\\-]|[A-Z]))"
+ "(\\S*)\\s*" // 12 + "(\\S*)\\s*"
+ "(\\S+)\\s*" // 13 // 12
+ "(\\S*)\\s*" // 14 user + "(\\S+)\\s*"
+ "(\\d*)\\s*" // 15 group // 13
+ "(\\d*)\\s*" // 16 filesize + "(\\S*)\\s*"
+ MONTHS // 17 month // 14 user
+ "\\s*" // TODO should the space be optional? + "(\\d*)\\s*"
// TODO \\d* should be \\d? surely ? Otherwise 01111 is allowed // 15 group
+ "((?:[012]\\d*)|(?:3[01]))\\s*" // 18 date [012]\d* or 3[01] + "(\\d*)\\s*"
+ "((\\d\\d\\d\\d)|((?:[01]\\d)|(?:2[0123])):([012345]\\d))\\s" // 16 filesize
// 20 \d\d\d\d = year OR + MONTHS
// 21 [01]\d or 2[0123] hour + ':' // 17 month
// 22 [012345]\d = minute + "\\s*"
+ "(\\S*)(\\s*.*)"; // 23 name // TODO should the space be optional?
// TODO \\d* should be \\d? surely ? Otherwise 01111 is allowed
+ "((?:[012]\\d*)|(?:3[01]))\\s*"
// 18 date [012]\d* or 3[01]
+ "((\\d\\d\\d\\d)|((?:[01]\\d)|(?:2[0123])):([012345]\\d))\\s"
// 20 \d\d\d\d = year OR
// 21 [01]\d or 2[0123] hour + ':'
// 22 [012345]\d = minute
+ "(\\S*)(\\s*.*)"; // 23 name
/** /**
* The sole constructor for a EnterpriseUnixFTPEntryParser object. * The sole constructor for a EnterpriseUnixFTPEntryParser object.
* */
*/ public EnterpriseUnixFTPEntryParser() {
public EnterpriseUnixFTPEntryParser() super(REGEX);
{ }
super(REGEX);
}
/** /**
* Parses a line of a unix FTP server file listing and converts it into a * Parses a line of a unix FTP server file listing and converts it into a
* usable format in the form of an <code> FTPFile </code> instance. If * usable format in the form of an <code> FTPFile </code> instance. If
* the file listing line doesn't describe a file, <code> null </code> is * the file listing line doesn't describe a file, <code> null </code> is
* returned, otherwise a <code> FTPFile </code> instance representing the * returned, otherwise a <code> FTPFile </code> instance representing the
* files in the directory is returned. * files in the directory is returned.
* *
* @param entry A line of text from the file listing * @param entry A line of text from the file listing
* @return An FTPFile instance corresponding to the supplied entry * @return An FTPFile instance corresponding to the supplied entry
*/ */
@Override @Override public FTPFile parseFTPEntry(String entry) {
public FTPFile parseFTPEntry(String entry)
{
FTPFile file = new FTPFile(); FTPFile file = new FTPFile();
file.setRawListing(entry); file.setRawListing(entry);
if (matches(entry)) if (matches(entry)) {
{ String usr = group(14);
String usr = group(14); String grp = group(15);
String grp = group(15); String filesize = group(16);
String filesize = group(16); String mo = group(17);
String mo = group(17); String da = group(18);
String da = group(18); String yr = group(20);
String yr = group(20); String hr = group(21);
String hr = group(21); String min = group(22);
String min = group(22); String name = group(23);
String name = group(23);
file.setType(FTPFile.FILE_TYPE); file.setType(FTPFile.FILE_TYPE);
file.setUser(usr); file.setUser(usr);
file.setGroup(grp); file.setGroup(grp);
try try {
{ file.setSize(Long.parseLong(filesize));
file.setSize(Long.parseLong(filesize)); } catch (NumberFormatException e) {
} // intentionally do nothing
catch (NumberFormatException e) }
{
// intentionally do nothing
}
Calendar cal = Calendar.getInstance(); Calendar cal = Calendar.getInstance();
cal.set(Calendar.MILLISECOND, 0); cal.set(Calendar.MILLISECOND, 0);
cal.set(Calendar.SECOND, 0); cal.set(Calendar.SECOND, 0);
cal.set(Calendar.MINUTE, 0); cal.set(Calendar.MINUTE, 0);
cal.set(Calendar.HOUR_OF_DAY, 0); cal.set(Calendar.HOUR_OF_DAY, 0);
int pos = MONTHS.indexOf(mo); int pos = MONTHS.indexOf(mo);
int month = pos / 4; int month = pos / 4;
final int missingUnit; // the first missing unit final int missingUnit; // the first missing unit
try try {
{
if (yr != null) if (yr != null) {
{ // it's a year; there are no hours and minutes
// it's a year; there are no hours and minutes cal.set(Calendar.YEAR, Integer.parseInt(yr));
cal.set(Calendar.YEAR, Integer.parseInt(yr)); missingUnit = Calendar.HOUR_OF_DAY;
missingUnit = Calendar.HOUR_OF_DAY; } else {
} // it must be hour/minute or we wouldn't have matched
else missingUnit = Calendar.SECOND;
{ int year = cal.get(Calendar.YEAR);
// it must be hour/minute or we wouldn't have matched
missingUnit = Calendar.SECOND;
int year = cal.get(Calendar.YEAR);
// if the month we're reading is greater than now, it must // if the month we're reading is greater than now, it must
// be last year // be last year
if (cal.get(Calendar.MONTH) < month) if (cal.get(Calendar.MONTH) < month) {
{ year--;
year--; }
} cal.set(Calendar.YEAR, year);
cal.set(Calendar.YEAR, year); cal.set(Calendar.HOUR_OF_DAY, Integer.parseInt(hr));
cal.set(Calendar.HOUR_OF_DAY, Integer.parseInt(hr)); cal.set(Calendar.MINUTE, Integer.parseInt(min));
cal.set(Calendar.MINUTE, Integer.parseInt(min));
}
cal.set(Calendar.MONTH, month);
cal.set(Calendar.DAY_OF_MONTH, Integer.parseInt(da));
cal.clear(missingUnit);
file.setTimestamp(cal);
}
catch (NumberFormatException e)
{
// do nothing, date will be uninitialized
}
file.setName(name);
return file;
} }
return null; cal.set(Calendar.MONTH, month);
cal.set(Calendar.DAY_OF_MONTH, Integer.parseInt(da));
cal.clear(missingUnit);
file.setTimestamp(cal);
} catch (NumberFormatException e) {
// do nothing, date will be uninitialized
}
file.setName(name);
return file;
} }
return null;
}
} }

View File

@@ -16,53 +16,48 @@
*/ */
package org.apache.commons.net.ftp.parser; package org.apache.commons.net.ftp.parser;
import org.apache.commons.net.ftp.FTPClientConfig; import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFileEntryParser; import org.apache.commons.net.ftp.FTPFileEntryParser;
/** /**
* The interface describes a factory for creating FTPFileEntryParsers. * The interface describes a factory for creating FTPFileEntryParsers.
*
* @since 1.2 * @since 1.2
*/ */
public interface FTPFileEntryParserFactory public interface FTPFileEntryParserFactory {
{ /**
/** * Implementation should be a method that decodes the
* Implementation should be a method that decodes the * supplied key and creates an object implementing the
* supplied key and creates an object implementing the * interface FTPFileEntryParser.
* interface FTPFileEntryParser. *
* * @param key A string that somehow identifies an
* @param key A string that somehow identifies an * FTPFileEntryParser to be created.
* FTPFileEntryParser to be created. * @return the FTPFileEntryParser created.
* * @throws ParserInitializationException Thrown on any exception in instantiation
* @return the FTPFileEntryParser created. */
* @throws ParserInitializationException public FTPFileEntryParser createFileEntryParser(String key) throws ParserInitializationException;
* Thrown on any exception in instantiation
*/
public FTPFileEntryParser createFileEntryParser(String key)
throws ParserInitializationException;
/**
*<p>
* Implementation should be a method that extracts
* a key from the supplied {@link FTPClientConfig FTPClientConfig}
* parameter and creates an object implementing the
* interface FTPFileEntryParser and uses the supplied configuration
* to configure it.
* </p><p>
* Note that this method will generally not be called in scenarios
* that call for autodetection of parser type but rather, for situations
* where the user knows that the server uses a non-default configuration
* and knows what that configuration is.
* </p>
*
* @param config A {@link FTPClientConfig FTPClientConfig}
* used to configure the parser created
*
* @return the @link FTPFileEntryParser FTPFileEntryParser} so created.
* @throws ParserInitializationException
* Thrown on any exception in instantiation
* @since 1.4
*/
public FTPFileEntryParser createFileEntryParser(FTPClientConfig config)
throws ParserInitializationException;
/**
* <p>
* Implementation should be a method that extracts
* a key from the supplied {@link FTPClientConfig FTPClientConfig}
* parameter and creates an object implementing the
* interface FTPFileEntryParser and uses the supplied configuration
* to configure it.
* </p><p>
* Note that this method will generally not be called in scenarios
* that call for autodetection of parser type but rather, for situations
* where the user knows that the server uses a non-default configuration
* and knows what that configuration is.
* </p>
*
* @param config A {@link FTPClientConfig FTPClientConfig}
* used to configure the parser created
* @return the @link FTPFileEntryParser FTPFileEntryParser} so created.
* @throws ParserInitializationException Thrown on any exception in instantiation
* @since 1.4
*/
public FTPFileEntryParser createFileEntryParser(FTPClientConfig config)
throws ParserInitializationException;
} }

View File

@@ -23,30 +23,31 @@ import java.util.Calendar;
/** /**
* This interface specifies the concept of parsing an FTP server's * This interface specifies the concept of parsing an FTP server's
* timestamp. * timestamp.
*
* @since 1.4 * @since 1.4
*/ */
public interface FTPTimestampParser { public interface FTPTimestampParser {
/** /**
* the default default date format. * the default default date format.
*/ */
public static final String DEFAULT_SDF = UnixFTPEntryParser.DEFAULT_DATE_FORMAT; public static final String DEFAULT_SDF = UnixFTPEntryParser.DEFAULT_DATE_FORMAT;
/** /**
* the default recent date format. * the default recent date format.
*/ */
public static final String DEFAULT_RECENT_SDF = UnixFTPEntryParser.DEFAULT_RECENT_DATE_FORMAT; public static final String DEFAULT_RECENT_SDF = UnixFTPEntryParser.DEFAULT_RECENT_DATE_FORMAT;
/**
* Parses the supplied datestamp parameter. This parameter typically would
* have been pulled from a longer FTP listing via the regular expression
* mechanism
* @param timestampStr - the timestamp portion of the FTP directory listing
* to be parsed
* @return a <code>java.util.Calendar</code> object initialized to the date
* parsed by the parser
* @throws ParseException if none of the parser mechanisms belonging to
* the implementor can parse the input.
*/
public Calendar parseTimestamp(String timestampStr) throws ParseException;
/**
* Parses the supplied datestamp parameter. This parameter typically would
* have been pulled from a longer FTP listing via the regular expression
* mechanism
*
* @param timestampStr - the timestamp portion of the FTP directory listing
* to be parsed
* @return a <code>java.util.Calendar</code> object initialized to the date
* parsed by the parser
* @throws ParseException if none of the parser mechanisms belonging to
* the implementor can parse the input.
*/
public Calendar parseTimestamp(String timestampStr) throws ParseException;
} }

View File

@@ -36,371 +36,369 @@ import org.apache.commons.net.ftp.FTPClientConfig;
* @see ConfigurableFTPFileEntryParserImpl * @see ConfigurableFTPFileEntryParserImpl
* @since 1.4 * @since 1.4
*/ */
public class FTPTimestampParserImpl implements public class FTPTimestampParserImpl implements FTPTimestampParser, Configurable {
FTPTimestampParser, Configurable
{
/** The date format for all dates, except possibly recent dates. Assumed to include the year. */
private SimpleDateFormat defaultDateFormat;
/* The index in CALENDAR_UNITS of the smallest time unit in defaultDateFormat */
private int defaultDateSmallestUnitIndex;
/** The date format for all dates, except possibly recent dates. Assumed to include the year. */ /** The format used for recent dates (which don't have the year). May be null. */
private SimpleDateFormat defaultDateFormat; private SimpleDateFormat recentDateFormat;
/* The index in CALENDAR_UNITS of the smallest time unit in defaultDateFormat */ /* The index in CALENDAR_UNITS of the smallest time unit in recentDateFormat */
private int defaultDateSmallestUnitIndex; private int recentDateSmallestUnitIndex;
/** The format used for recent dates (which don't have the year). May be null. */ private boolean lenientFutureDates = false;
private SimpleDateFormat recentDateFormat;
/* The index in CALENDAR_UNITS of the smallest time unit in recentDateFormat */
private int recentDateSmallestUnitIndex;
private boolean lenientFutureDates = false; /*
* List of units in order of increasing significance.
* This allows the code to clear all units in the Calendar until it
* reaches the least significant unit in the parse string.
* The date formats are analysed to find the least significant
* unit (e.g. Minutes or Milliseconds) and the appropriate index to
* the array is saved.
* This is done by searching the array for the unit specifier,
* and returning the index. When clearing the Calendar units,
* the code loops through the array until the previous entry.
* e.g. for MINUTE it would clear MILLISECOND and SECOND
*/
private static final int[] CALENDAR_UNITS = {
Calendar.MILLISECOND, Calendar.SECOND, Calendar.MINUTE, Calendar.HOUR_OF_DAY,
Calendar.DAY_OF_MONTH, Calendar.MONTH, Calendar.YEAR
};
/* /*
* List of units in order of increasing significance. * Return the index to the array representing the least significant
* This allows the code to clear all units in the Calendar until it * unit found in the date format.
* reaches the least significant unit in the parse string. * Default is 0 (to avoid dropping precision)
* The date formats are analysed to find the least significant */
* unit (e.g. Minutes or Milliseconds) and the appropriate index to private static int getEntry(SimpleDateFormat dateFormat) {
* the array is saved. if (dateFormat == null) {
* This is done by searching the array for the unit specifier, return 0;
* and returning the index. When clearing the Calendar units,
* the code loops through the array until the previous entry.
* e.g. for MINUTE it would clear MILLISECOND and SECOND
*/
private static final int[] CALENDAR_UNITS = {
Calendar.MILLISECOND,
Calendar.SECOND,
Calendar.MINUTE,
Calendar.HOUR_OF_DAY,
Calendar.DAY_OF_MONTH,
Calendar.MONTH,
Calendar.YEAR};
/*
* Return the index to the array representing the least significant
* unit found in the date format.
* Default is 0 (to avoid dropping precision)
*/
private static int getEntry(SimpleDateFormat dateFormat) {
if (dateFormat == null) {
return 0;
}
final String FORMAT_CHARS="SsmHdM";
final String pattern = dateFormat.toPattern();
for(char ch : FORMAT_CHARS.toCharArray()) {
if (pattern.indexOf(ch) != -1){ // found the character
switch(ch) {
case 'S':
return indexOf(Calendar.MILLISECOND);
case 's':
return indexOf(Calendar.SECOND);
case 'm':
return indexOf(Calendar.MINUTE);
case 'H':
return indexOf(Calendar.HOUR_OF_DAY);
case 'd':
return indexOf(Calendar.DAY_OF_MONTH);
case 'M':
return indexOf(Calendar.MONTH);
}
}
}
return 0;
} }
final String FORMAT_CHARS = "SsmHdM";
/* final String pattern = dateFormat.toPattern();
* Find the entry in the CALENDAR_UNITS array. for (char ch : FORMAT_CHARS.toCharArray()) {
*/ if (pattern.indexOf(ch) != -1) { // found the character
private static int indexOf(int calendarUnit) { switch (ch) {
int i; case 'S':
for(i = 0; i <CALENDAR_UNITS.length; i++) { return indexOf(Calendar.MILLISECOND);
if (calendarUnit == CALENDAR_UNITS[i]) { case 's':
return i; return indexOf(Calendar.SECOND);
} case 'm':
return indexOf(Calendar.MINUTE);
case 'H':
return indexOf(Calendar.HOUR_OF_DAY);
case 'd':
return indexOf(Calendar.DAY_OF_MONTH);
case 'M':
return indexOf(Calendar.MONTH);
} }
return 0; }
} }
return 0;
}
/* /*
* Sets the Calendar precision (used by FTPFile#toFormattedDate) by clearing * Find the entry in the CALENDAR_UNITS array.
* the immediately preceeding unit (if any). */
* Unfortunately the clear(int) method results in setting all other units. private static int indexOf(int calendarUnit) {
*/ int i;
private static void setPrecision(int index, Calendar working) { for (i = 0; i < CALENDAR_UNITS.length; i++) {
if (index <= 0) { // e.g. MILLISECONDS if (calendarUnit == CALENDAR_UNITS[i]) {
return; return i;
} }
final int field = CALENDAR_UNITS[index-1];
// Just in case the analysis is wrong, stop clearing if
// field value is not the default.
final int value = working.get(field);
if (value != 0) { // don't reset if it has a value
// new Throwable("Unexpected value "+value).printStackTrace(); // DEBUG
} else {
working.clear(field); // reset just the required field
}
} }
return 0;
}
/** /*
* The only constructor for this class. * Sets the Calendar precision (used by FTPFile#toFormattedDate) by clearing
*/ * the immediately preceeding unit (if any).
public FTPTimestampParserImpl() { * Unfortunately the clear(int) method results in setting all other units.
setDefaultDateFormat(DEFAULT_SDF, null); */
setRecentDateFormat(DEFAULT_RECENT_SDF, null); private static void setPrecision(int index, Calendar working) {
if (index <= 0) { // e.g. MILLISECONDS
return;
} }
final int field = CALENDAR_UNITS[index - 1];
/** // Just in case the analysis is wrong, stop clearing if
* Implements the one {@link FTPTimestampParser#parseTimestamp(String) method} // field value is not the default.
* in the {@link FTPTimestampParser FTPTimestampParser} interface final int value = working.get(field);
* according to this algorithm: if (value != 0) { // don't reset if it has a value
* // new Throwable("Unexpected value "+value).printStackTrace(); // DEBUG
* If the recentDateFormat member has been defined, try to parse the } else {
* supplied string with that. If that parse fails, or if the recentDateFormat working.clear(field); // reset just the required field
* member has not been defined, attempt to parse with the defaultDateFormat
* member. If that fails, throw a ParseException.
*
* This method assumes that the server time is the same as the local time.
*
* @see FTPTimestampParserImpl#parseTimestamp(String, Calendar)
*
* @param timestampStr The timestamp to be parsed
* @return a Calendar with the parsed timestamp
*/
@Override
public Calendar parseTimestamp(String timestampStr) throws ParseException {
Calendar now = Calendar.getInstance();
return parseTimestamp(timestampStr, now);
} }
}
/** /**
* If the recentDateFormat member has been defined, try to parse the * The only constructor for this class.
* supplied string with that. If that parse fails, or if the recentDateFormat */
* member has not been defined, attempt to parse with the defaultDateFormat public FTPTimestampParserImpl() {
* member. If that fails, throw a ParseException. setDefaultDateFormat(DEFAULT_SDF, null);
* setRecentDateFormat(DEFAULT_RECENT_SDF, null);
* This method allows a {@link Calendar} instance to be passed in which represents the }
* current (system) time.
*
* @see FTPTimestampParser#parseTimestamp(String)
* @param timestampStr The timestamp to be parsed
* @param serverTime The current time for the server
* @return the calendar
* @throws ParseException if timestamp cannot be parsed
* @since 1.5
*/
public Calendar parseTimestamp(String timestampStr, Calendar serverTime) throws ParseException {
Calendar working = (Calendar) serverTime.clone();
working.setTimeZone(getServerTimeZone()); // is this needed?
Date parsed = null; /**
* Implements the one {@link FTPTimestampParser#parseTimestamp(String) method}
* in the {@link FTPTimestampParser FTPTimestampParser} interface
* according to this algorithm:
*
* If the recentDateFormat member has been defined, try to parse the
* supplied string with that. If that parse fails, or if the recentDateFormat
* member has not been defined, attempt to parse with the defaultDateFormat
* member. If that fails, throw a ParseException.
*
* This method assumes that the server time is the same as the local time.
*
* @param timestampStr The timestamp to be parsed
* @return a Calendar with the parsed timestamp
* @see FTPTimestampParserImpl#parseTimestamp(String, Calendar)
*/
@Override public Calendar parseTimestamp(String timestampStr) throws ParseException {
Calendar now = Calendar.getInstance();
return parseTimestamp(timestampStr, now);
}
if (recentDateFormat != null) { /**
Calendar now = (Calendar) serverTime.clone();// Copy this, because we may change it * If the recentDateFormat member has been defined, try to parse the
now.setTimeZone(this.getServerTimeZone()); * supplied string with that. If that parse fails, or if the recentDateFormat
if (lenientFutureDates) { * member has not been defined, attempt to parse with the defaultDateFormat
// add a day to "now" so that "slop" doesn't cause a date * member. If that fails, throw a ParseException.
// slightly in the future to roll back a full year. (Bug 35181 => NET-83) *
now.add(Calendar.DAY_OF_MONTH, 1); * This method allows a {@link Calendar} instance to be passed in which represents the
} * current (system) time.
// The Java SimpleDateFormat class uses the epoch year 1970 if not present in the input *
// As 1970 was not a leap year, it cannot parse "Feb 29" correctly. * @param timestampStr The timestamp to be parsed
// Java 1.5+ returns Mar 1 1970 * @param serverTime The current time for the server
// Temporarily add the current year to the short date time * @return the calendar
// to cope with short-date leap year strings. * @throws ParseException if timestamp cannot be parsed
// Since Feb 29 is more that 6 months from the end of the year, this should be OK for * @see FTPTimestampParser#parseTimestamp(String)
// all instances of short dates which are +- 6 months from current date. * @since 1.5
// TODO this won't always work for systems that use short dates +0/-12months */
// e.g. if today is Jan 1 2001 and the short date is Feb 29 public Calendar parseTimestamp(String timestampStr, Calendar serverTime) throws ParseException {
String year = Integer.toString(now.get(Calendar.YEAR)); Calendar working = (Calendar) serverTime.clone();
String timeStampStrPlusYear = timestampStr + " " + year; working.setTimeZone(getServerTimeZone()); // is this needed?
SimpleDateFormat hackFormatter = new SimpleDateFormat(recentDateFormat.toPattern() + " yyyy",
recentDateFormat.getDateFormatSymbols()); Date parsed = null;
hackFormatter.setLenient(false);
hackFormatter.setTimeZone(recentDateFormat.getTimeZone()); if (recentDateFormat != null) {
ParsePosition pp = new ParsePosition(0); Calendar now = (Calendar) serverTime.clone();// Copy this, because we may change it
parsed = hackFormatter.parse(timeStampStrPlusYear, pp); now.setTimeZone(this.getServerTimeZone());
// Check if we parsed the full string, if so it must have been a short date originally if (lenientFutureDates) {
if (parsed != null && pp.getIndex() == timeStampStrPlusYear.length()) { // add a day to "now" so that "slop" doesn't cause a date
working.setTime(parsed); // slightly in the future to roll back a full year. (Bug 35181 => NET-83)
if (working.after(now)) { // must have been last year instead now.add(Calendar.DAY_OF_MONTH, 1);
working.add(Calendar.YEAR, -1); }
} // The Java SimpleDateFormat class uses the epoch year 1970 if not present in the input
setPrecision(recentDateSmallestUnitIndex, working); // As 1970 was not a leap year, it cannot parse "Feb 29" correctly.
return working; // Java 1.5+ returns Mar 1 1970
} // Temporarily add the current year to the short date time
// to cope with short-date leap year strings.
// Since Feb 29 is more that 6 months from the end of the year, this should be OK for
// all instances of short dates which are +- 6 months from current date.
// TODO this won't always work for systems that use short dates +0/-12months
// e.g. if today is Jan 1 2001 and the short date is Feb 29
String year = Integer.toString(now.get(Calendar.YEAR));
String timeStampStrPlusYear = timestampStr + " " + year;
SimpleDateFormat hackFormatter = new SimpleDateFormat(recentDateFormat.toPattern() + " yyyy",
recentDateFormat.getDateFormatSymbols());
hackFormatter.setLenient(false);
hackFormatter.setTimeZone(recentDateFormat.getTimeZone());
ParsePosition pp = new ParsePosition(0);
parsed = hackFormatter.parse(timeStampStrPlusYear, pp);
// Check if we parsed the full string, if so it must have been a short date originally
if (parsed != null && pp.getIndex() == timeStampStrPlusYear.length()) {
working.setTime(parsed);
if (working.after(now)) { // must have been last year instead
working.add(Calendar.YEAR, -1);
} }
setPrecision(recentDateSmallestUnitIndex, working);
ParsePosition pp = new ParsePosition(0);
parsed = defaultDateFormat.parse(timestampStr, pp);
// note, length checks are mandatory for us since
// SimpleDateFormat methods will succeed if less than
// full string is matched. They will also accept,
// despite "leniency" setting, a two-digit number as
// a valid year (e.g. 22:04 will parse as 22 A.D.)
// so could mistakenly confuse an hour with a year,
// if we don't insist on full length parsing.
if (parsed != null && pp.getIndex() == timestampStr.length()) {
working.setTime(parsed);
} else {
throw new ParseException(
"Timestamp '"+timestampStr+"' could not be parsed using a server time of "
+serverTime.getTime().toString(),
pp.getErrorIndex());
}
setPrecision(defaultDateSmallestUnitIndex, working);
return working; return working;
}
} }
/** ParsePosition pp = new ParsePosition(0);
* @return Returns the defaultDateFormat. parsed = defaultDateFormat.parse(timestampStr, pp);
*/ // note, length checks are mandatory for us since
public SimpleDateFormat getDefaultDateFormat() { // SimpleDateFormat methods will succeed if less than
return defaultDateFormat; // full string is matched. They will also accept,
// despite "leniency" setting, a two-digit number as
// a valid year (e.g. 22:04 will parse as 22 A.D.)
// so could mistakenly confuse an hour with a year,
// if we don't insist on full length parsing.
if (parsed != null && pp.getIndex() == timestampStr.length()) {
working.setTime(parsed);
} else {
throw new ParseException("Timestamp '"
+ timestampStr
+ "' could not be parsed using a server time of "
+ serverTime.getTime().toString(), pp.getErrorIndex());
} }
/** setPrecision(defaultDateSmallestUnitIndex, working);
* @return Returns the defaultDateFormat pattern string. return working;
*/ }
public String getDefaultDateFormatString() {
return defaultDateFormat.toPattern(); /**
* @return Returns the defaultDateFormat.
*/
public SimpleDateFormat getDefaultDateFormat() {
return defaultDateFormat;
}
/**
* @return Returns the defaultDateFormat pattern string.
*/
public String getDefaultDateFormatString() {
return defaultDateFormat.toPattern();
}
/**
* @param format The defaultDateFormat to be set.
* @param dfs the symbols to use (may be null)
*/
private void setDefaultDateFormat(String format, DateFormatSymbols dfs) {
if (format != null) {
if (dfs != null) {
this.defaultDateFormat = new SimpleDateFormat(format, dfs);
} else {
this.defaultDateFormat = new SimpleDateFormat(format);
}
this.defaultDateFormat.setLenient(false);
} else {
this.defaultDateFormat = null;
} }
/** this.defaultDateSmallestUnitIndex = getEntry(this.defaultDateFormat);
* @param format The defaultDateFormat to be set. }
* @param dfs the symbols to use (may be null)
*/ /**
private void setDefaultDateFormat(String format, DateFormatSymbols dfs) { * @return Returns the recentDateFormat.
if (format != null) { */
if (dfs != null) { public SimpleDateFormat getRecentDateFormat() {
this.defaultDateFormat = new SimpleDateFormat(format, dfs); return recentDateFormat;
} else { }
this.defaultDateFormat = new SimpleDateFormat(format);
} /**
this.defaultDateFormat.setLenient(false); * @return Returns the recentDateFormat.
} else { */
this.defaultDateFormat = null; public String getRecentDateFormatString() {
} return recentDateFormat.toPattern();
this.defaultDateSmallestUnitIndex = getEntry(this.defaultDateFormat); }
/**
* @param format The recentDateFormat to set.
* @param dfs the symbols to use (may be null)
*/
private void setRecentDateFormat(String format, DateFormatSymbols dfs) {
if (format != null) {
if (dfs != null) {
this.recentDateFormat = new SimpleDateFormat(format, dfs);
} else {
this.recentDateFormat = new SimpleDateFormat(format);
}
this.recentDateFormat.setLenient(false);
} else {
this.recentDateFormat = null;
} }
/** this.recentDateSmallestUnitIndex = getEntry(this.recentDateFormat);
* @return Returns the recentDateFormat. }
*/
public SimpleDateFormat getRecentDateFormat() { /**
return recentDateFormat; * @return returns an array of 12 strings representing the short
* month names used by this parse.
*/
public String[] getShortMonths() {
return defaultDateFormat.getDateFormatSymbols().getShortMonths();
}
/**
* @return Returns the serverTimeZone used by this parser.
*/
public TimeZone getServerTimeZone() {
return this.defaultDateFormat.getTimeZone();
}
/**
* sets a TimeZone represented by the supplied ID string into all
* of the parsers used by this server.
*
* @param serverTimeZone Time Id java.util.TimeZone id used by
* the ftp server. If null the client's local time zone is assumed.
*/
private void setServerTimeZone(String serverTimeZoneId) {
TimeZone serverTimeZone = TimeZone.getDefault();
if (serverTimeZoneId != null) {
serverTimeZone = TimeZone.getTimeZone(serverTimeZoneId);
} }
/** this.defaultDateFormat.setTimeZone(serverTimeZone);
* @return Returns the recentDateFormat. if (this.recentDateFormat != null) {
*/ this.recentDateFormat.setTimeZone(serverTimeZone);
public String getRecentDateFormatString() {
return recentDateFormat.toPattern();
} }
/** }
* @param format The recentDateFormat to set.
* @param dfs the symbols to use (may be null) /**
*/ * Implementation of the {@link Configurable Configurable}
private void setRecentDateFormat(String format, DateFormatSymbols dfs) { * interface. Configures this <code>FTPTimestampParser</code> according
if (format != null) { * to the following logic:
if (dfs != null) { * <p>
this.recentDateFormat = new SimpleDateFormat(format, dfs); * Set up the {@link FTPClientConfig#setDefaultDateFormatStr(String) defaultDateFormat}
} else { * and optionally the {@link FTPClientConfig#setRecentDateFormatStr(String) recentDateFormat}
this.recentDateFormat = new SimpleDateFormat(format); * to values supplied in the config based on month names configured as follows:
} * </p>
this.recentDateFormat.setLenient(false); * <ul>
} else { * <li>If a {@link FTPClientConfig#setShortMonthNames(String) shortMonthString}
this.recentDateFormat = null; * has been supplied in the <code>config</code>, use that to parse parse timestamps.</li>
} * <li>Otherwise, if a {@link FTPClientConfig#setServerLanguageCode(String) serverLanguageCode}
this.recentDateSmallestUnitIndex = getEntry(this.recentDateFormat); * has been supplied in the <code>config</code>, use the month names represented
* by that {@link FTPClientConfig#lookupDateFormatSymbols(String) language}
* to parse timestamps.</li>
* <li>otherwise use default English month names</li>
* </ul><p>
* Finally if a {@link org.apache.commons.net.ftp.FTPClientConfig#setServerTimeZoneId(String)
* serverTimeZoneId}
* has been supplied via the config, set that into all date formats that have
* been configured.
* </p>
*/
@Override public void configure(FTPClientConfig config) {
DateFormatSymbols dfs = null;
String languageCode = config.getServerLanguageCode();
String shortmonths = config.getShortMonthNames();
if (shortmonths != null) {
dfs = FTPClientConfig.getDateFormatSymbols(shortmonths);
} else if (languageCode != null) {
dfs = FTPClientConfig.lookupDateFormatSymbols(languageCode);
} else {
dfs = FTPClientConfig.lookupDateFormatSymbols("en");
} }
/** String recentFormatString = config.getRecentDateFormatStr();
* @return returns an array of 12 strings representing the short setRecentDateFormat(recentFormatString, dfs);
* month names used by this parse.
*/ String defaultFormatString = config.getDefaultDateFormatStr();
public String[] getShortMonths() { if (defaultFormatString == null) {
return defaultDateFormat.getDateFormatSymbols().getShortMonths(); throw new IllegalArgumentException("defaultFormatString cannot be null");
} }
setDefaultDateFormat(defaultFormatString, dfs);
setServerTimeZone(config.getServerTimeZoneId());
/** this.lenientFutureDates = config.isLenientFutureDates();
* @return Returns the serverTimeZone used by this parser. }
*/
public TimeZone getServerTimeZone() {
return this.defaultDateFormat.getTimeZone();
}
/**
* sets a TimeZone represented by the supplied ID string into all
* of the parsers used by this server.
* @param serverTimeZone Time Id java.util.TimeZone id used by
* the ftp server. If null the client's local time zone is assumed.
*/
private void setServerTimeZone(String serverTimeZoneId) {
TimeZone serverTimeZone = TimeZone.getDefault();
if (serverTimeZoneId != null) {
serverTimeZone = TimeZone.getTimeZone(serverTimeZoneId);
}
this.defaultDateFormat.setTimeZone(serverTimeZone);
if (this.recentDateFormat != null) {
this.recentDateFormat.setTimeZone(serverTimeZone);
}
}
/** /**
* Implementation of the {@link Configurable Configurable} * @return Returns the lenientFutureDates.
* interface. Configures this <code>FTPTimestampParser</code> according */
* to the following logic: boolean isLenientFutureDates() {
* <p> return lenientFutureDates;
* Set up the {@link FTPClientConfig#setDefaultDateFormatStr(String) defaultDateFormat} }
* and optionally the {@link FTPClientConfig#setRecentDateFormatStr(String) recentDateFormat}
* to values supplied in the config based on month names configured as follows:
* </p>
* <ul>
* <li>If a {@link FTPClientConfig#setShortMonthNames(String) shortMonthString}
* has been supplied in the <code>config</code>, use that to parse parse timestamps.</li>
* <li>Otherwise, if a {@link FTPClientConfig#setServerLanguageCode(String) serverLanguageCode}
* has been supplied in the <code>config</code>, use the month names represented
* by that {@link FTPClientConfig#lookupDateFormatSymbols(String) language}
* to parse timestamps.</li>
* <li>otherwise use default English month names</li>
* </ul><p>
* Finally if a {@link org.apache.commons.net.ftp.FTPClientConfig#setServerTimeZoneId(String) serverTimeZoneId}
* has been supplied via the config, set that into all date formats that have
* been configured.
* </p>
*/
@Override
public void configure(FTPClientConfig config) {
DateFormatSymbols dfs = null;
String languageCode = config.getServerLanguageCode(); /**
String shortmonths = config.getShortMonthNames(); * @param lenientFutureDates The lenientFutureDates to set.
if (shortmonths != null) { */
dfs = FTPClientConfig.getDateFormatSymbols(shortmonths); void setLenientFutureDates(boolean lenientFutureDates) {
} else if (languageCode != null) { this.lenientFutureDates = lenientFutureDates;
dfs = FTPClientConfig.lookupDateFormatSymbols(languageCode); }
} else {
dfs = FTPClientConfig.lookupDateFormatSymbols("en");
}
String recentFormatString = config.getRecentDateFormatStr();
setRecentDateFormat(recentFormatString, dfs);
String defaultFormatString = config.getDefaultDateFormatStr();
if (defaultFormatString == null) {
throw new IllegalArgumentException("defaultFormatString cannot be null");
}
setDefaultDateFormat(defaultFormatString, dfs);
setServerTimeZone(config.getServerTimeZoneId());
this.lenientFutureDates = config.isLenientFutureDates();
}
/**
* @return Returns the lenientFutureDates.
*/
boolean isLenientFutureDates() {
return lenientFutureDates;
}
/**
* @param lenientFutureDates The lenientFutureDates to set.
*/
void setLenientFutureDates(boolean lenientFutureDates) {
this.lenientFutureDates = lenientFutureDates;
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp.parser; package org.apache.commons.net.ftp.parser;
import java.text.ParsePosition; import java.text.ParsePosition;
import java.text.SimpleDateFormat; import java.text.SimpleDateFormat;
import java.util.Calendar; import java.util.Calendar;
@@ -54,216 +55,207 @@ import org.apache.commons.net.ftp.FTPFileEntryParserImpl;
* *
* @since 3.0 * @since 3.0
*/ */
public class MLSxEntryParser extends FTPFileEntryParserImpl public class MLSxEntryParser extends FTPFileEntryParserImpl {
{ // This class is immutable, so a single instance can be shared.
// This class is immutable, so a single instance can be shared. private static final MLSxEntryParser PARSER = new MLSxEntryParser();
private static final MLSxEntryParser PARSER = new MLSxEntryParser();
private static final HashMap<String, Integer> TYPE_TO_INT = new HashMap<String, Integer>(); private static final HashMap<String, Integer> TYPE_TO_INT = new HashMap<String, Integer>();
static {
TYPE_TO_INT.put("file", Integer.valueOf(FTPFile.FILE_TYPE));
TYPE_TO_INT.put("cdir", Integer.valueOf(FTPFile.DIRECTORY_TYPE)); // listed directory
TYPE_TO_INT.put("pdir", Integer.valueOf(FTPFile.DIRECTORY_TYPE)); // a parent dir
TYPE_TO_INT.put("dir", Integer.valueOf(FTPFile.DIRECTORY_TYPE)); // dir or sub-dir
}
private static int UNIX_GROUPS[] = { // Groups in order of mode digits static {
FTPFile.USER_ACCESS, TYPE_TO_INT.put("file", Integer.valueOf(FTPFile.FILE_TYPE));
FTPFile.GROUP_ACCESS, TYPE_TO_INT.put("cdir", Integer.valueOf(FTPFile.DIRECTORY_TYPE)); // listed directory
FTPFile.WORLD_ACCESS, TYPE_TO_INT.put("pdir", Integer.valueOf(FTPFile.DIRECTORY_TYPE)); // a parent dir
}; TYPE_TO_INT.put("dir", Integer.valueOf(FTPFile.DIRECTORY_TYPE)); // dir or sub-dir
}
private static int UNIX_PERMS[][] = { // perm bits, broken down by octal int value private static int UNIX_GROUPS[] = { // Groups in order of mode digits
FTPFile.USER_ACCESS, FTPFile.GROUP_ACCESS, FTPFile.WORLD_ACCESS,
};
private static int UNIX_PERMS[][] = { // perm bits, broken down by octal int value
/* 0 */ {}, /* 0 */ {},
/* 1 */ {FTPFile.EXECUTE_PERMISSION}, /* 1 */ { FTPFile.EXECUTE_PERMISSION },
/* 2 */ {FTPFile.WRITE_PERMISSION}, /* 2 */ { FTPFile.WRITE_PERMISSION },
/* 3 */ {FTPFile.EXECUTE_PERMISSION, FTPFile.WRITE_PERMISSION}, /* 3 */ { FTPFile.EXECUTE_PERMISSION, FTPFile.WRITE_PERMISSION },
/* 4 */ {FTPFile.READ_PERMISSION}, /* 4 */ { FTPFile.READ_PERMISSION },
/* 5 */ {FTPFile.READ_PERMISSION, FTPFile.EXECUTE_PERMISSION}, /* 5 */ { FTPFile.READ_PERMISSION, FTPFile.EXECUTE_PERMISSION },
/* 6 */ {FTPFile.READ_PERMISSION, FTPFile.WRITE_PERMISSION}, /* 6 */ { FTPFile.READ_PERMISSION, FTPFile.WRITE_PERMISSION },
/* 7 */ {FTPFile.READ_PERMISSION, FTPFile.WRITE_PERMISSION, FTPFile.EXECUTE_PERMISSION}, /* 7 */ { FTPFile.READ_PERMISSION, FTPFile.WRITE_PERMISSION, FTPFile.EXECUTE_PERMISSION },
}; };
/** /**
* Create the parser for MSLT and MSLD listing entries * Create the parser for MSLT and MSLD listing entries
* This class is immutable, so one can use {@link #getInstance()} instead. * This class is immutable, so one can use {@link #getInstance()} instead.
*/ */
public MLSxEntryParser() public MLSxEntryParser() {
{ super();
super(); }
}
@Override @Override public FTPFile parseFTPEntry(String entry) {
public FTPFile parseFTPEntry(String entry) { if (entry.startsWith(" ")) {// leading space means no facts are present
if (entry.startsWith(" ")) {// leading space means no facts are present if (entry.length() > 1) { // is there a path name?
if (entry.length() > 1) { // is there a path name?
FTPFile file = new FTPFile();
file.setRawListing(entry);
file.setName(entry.substring(1));
return file;
} else {
return null; // Invalid - no pathname
}
}
String parts[] = entry.split(" ",2); // Path may contain space
if (parts.length != 2 || parts[1].length() == 0) {
return null; // no space found or no file name
}
final String factList = parts[0];
if (!factList.endsWith(";")) {
return null;
}
FTPFile file = new FTPFile(); FTPFile file = new FTPFile();
file.setRawListing(entry); file.setRawListing(entry);
file.setName(parts[1]); file.setName(entry.substring(1));
String[] facts = factList.split(";");
boolean hasUnixMode = parts[0].toLowerCase(Locale.ENGLISH).contains("unix.mode=");
for(String fact : facts) {
String []factparts = fact.split("=", -1); // Don't drop empty values
// Sample missing permission
// drwx------ 2 mirror mirror 4096 Mar 13 2010 subversion
// modify=20100313224553;perm=;type=dir;unique=811U282598;UNIX.group=500;UNIX.mode=0700;UNIX.owner=500; subversion
if (factparts.length != 2) {
return null; // invalid - there was no "=" sign
}
String factname = factparts[0].toLowerCase(Locale.ENGLISH);
String factvalue = factparts[1];
if (factvalue.length() == 0) {
continue; // nothing to see here
}
String valueLowerCase = factvalue.toLowerCase(Locale.ENGLISH);
if ("size".equals(factname)) {
file.setSize(Long.parseLong(factvalue));
}
else if ("sizd".equals(factname)) { // Directory size
file.setSize(Long.parseLong(factvalue));
}
else if ("modify".equals(factname)) {
final Calendar parsed = parseGMTdateTime(factvalue);
if (parsed == null) {
return null;
}
file.setTimestamp(parsed);
}
else if ("type".equals(factname)) {
Integer intType = TYPE_TO_INT.get(valueLowerCase);
if (intType == null) {
file.setType(FTPFile.UNKNOWN_TYPE);
} else {
file.setType(intType.intValue());
}
}
else if (factname.startsWith("unix.")) {
String unixfact = factname.substring("unix.".length()).toLowerCase(Locale.ENGLISH);
if ("group".equals(unixfact)){
file.setGroup(factvalue);
} else if ("owner".equals(unixfact)){
file.setUser(factvalue);
} else if ("mode".equals(unixfact)){ // e.g. 0[1]755
int off = factvalue.length()-3; // only parse last 3 digits
for(int i=0; i < 3; i++){
int ch = factvalue.charAt(off+i)-'0';
if (ch >= 0 && ch <= 7) { // Check it's valid octal
for(int p : UNIX_PERMS[ch]) {
file.setPermission(UNIX_GROUPS[i], p, true);
}
} else {
// TODO should this cause failure, or can it be reported somehow?
}
} // digits
} // mode
} // unix.
else if (!hasUnixMode && "perm".equals(factname)) { // skip if we have the UNIX.mode
doUnixPerms(file, valueLowerCase);
} // process "perm"
} // each fact
return file; return file;
} else {
return null; // Invalid - no pathname
}
} }
String parts[] = entry.split(" ", 2); // Path may contain space
/** if (parts.length != 2 || parts[1].length() == 0) {
* Parse a GMT time stamp of the form YYYYMMDDHHMMSS[.sss] return null; // no space found or no file name
* }
* @param timestamp the date-time to parse final String factList = parts[0];
* @return a Calendar entry, may be {@code null} if (!factList.endsWith(";")) {
* @since 3.4 return null;
*/ }
public static Calendar parseGMTdateTime(String timestamp) { FTPFile file = new FTPFile();
final SimpleDateFormat sdf; file.setRawListing(entry);
final boolean hasMillis; file.setName(parts[1]);
if (timestamp.contains(".")){ String[] facts = factList.split(";");
sdf = new SimpleDateFormat("yyyyMMddHHmmss.SSS"); boolean hasUnixMode = parts[0].toLowerCase(Locale.ENGLISH).contains("unix.mode=");
hasMillis = true; for (String fact : facts) {
String[] factparts = fact.split("=", -1); // Don't drop empty values
// Sample missing permission
// drwx------ 2 mirror mirror 4096 Mar 13 2010 subversion
// modify=20100313224553;perm=;type=dir;unique=811U282598;UNIX.group=500;UNIX.mode=0700;UNIX.owner=500; subversion
if (factparts.length != 2) {
return null; // invalid - there was no "=" sign
}
String factname = factparts[0].toLowerCase(Locale.ENGLISH);
String factvalue = factparts[1];
if (factvalue.length() == 0) {
continue; // nothing to see here
}
String valueLowerCase = factvalue.toLowerCase(Locale.ENGLISH);
if ("size".equals(factname)) {
file.setSize(Long.parseLong(factvalue));
} else if ("sizd".equals(factname)) { // Directory size
file.setSize(Long.parseLong(factvalue));
} else if ("modify".equals(factname)) {
final Calendar parsed = parseGMTdateTime(factvalue);
if (parsed == null) {
return null;
}
file.setTimestamp(parsed);
} else if ("type".equals(factname)) {
Integer intType = TYPE_TO_INT.get(valueLowerCase);
if (intType == null) {
file.setType(FTPFile.UNKNOWN_TYPE);
} else { } else {
sdf = new SimpleDateFormat("yyyyMMddHHmmss"); file.setType(intType.intValue());
hasMillis = false;
} }
TimeZone GMT = TimeZone.getTimeZone("GMT"); } else if (factname.startsWith("unix.")) {
// both timezones need to be set for the parse to work OK String unixfact = factname.substring("unix.".length()).toLowerCase(Locale.ENGLISH);
sdf.setTimeZone(GMT); if ("group".equals(unixfact)) {
GregorianCalendar gc = new GregorianCalendar(GMT); file.setGroup(factvalue);
ParsePosition pos = new ParsePosition(0); } else if ("owner".equals(unixfact)) {
sdf.setLenient(false); // We want to parse the whole string file.setUser(factvalue);
final Date parsed = sdf.parse(timestamp, pos); } else if ("mode".equals(unixfact)) { // e.g. 0[1]755
if (pos.getIndex() != timestamp.length()) { int off = factvalue.length() - 3; // only parse last 3 digits
return null; // did not fully parse the input for (int i = 0; i < 3; i++) {
} int ch = factvalue.charAt(off + i) - '0';
gc.setTime(parsed); if (ch >= 0 && ch <= 7) { // Check it's valid octal
if (!hasMillis) { for (int p : UNIX_PERMS[ch]) {
gc.clear(Calendar.MILLISECOND); // flag up missing ms units file.setPermission(UNIX_GROUPS[i], p, true);
} }
return gc; } else {
} // TODO should this cause failure, or can it be reported somehow?
}
} // digits
} // mode
} // unix.
else if (!hasUnixMode && "perm".equals(factname)) { // skip if we have the UNIX.mode
doUnixPerms(file, valueLowerCase);
} // process "perm"
} // each fact
return file;
}
// perm-fact = "Perm" "=" *pvals /**
// pvals = "a" / "c" / "d" / "e" / "f" / * Parse a GMT time stamp of the form YYYYMMDDHHMMSS[.sss]
// "l" / "m" / "p" / "r" / "w" *
private void doUnixPerms(FTPFile file, String valueLowerCase) { * @param timestamp the date-time to parse
for(char c : valueLowerCase.toCharArray()) { * @return a Calendar entry, may be {@code null}
// TODO these are mostly just guesses at present * @since 3.4
switch (c) { */
case 'a': // (file) may APPEnd public static Calendar parseGMTdateTime(String timestamp) {
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true); final SimpleDateFormat sdf;
break; final boolean hasMillis;
case 'c': // (dir) files may be created in the dir if (timestamp.contains(".")) {
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true); sdf = new SimpleDateFormat("yyyyMMddHHmmss.SSS");
break; hasMillis = true;
case 'd': // deletable } else {
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true); sdf = new SimpleDateFormat("yyyyMMddHHmmss");
break; hasMillis = false;
case 'e': // (dir) can change to this dir
file.setPermission(FTPFile.USER_ACCESS, FTPFile.READ_PERMISSION, true);
break;
case 'f': // (file) renamable
// ?? file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
case 'l': // (dir) can be listed
file.setPermission(FTPFile.USER_ACCESS, FTPFile.EXECUTE_PERMISSION, true);
break;
case 'm': // (dir) can create directory here
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
case 'p': // (dir) entries may be deleted
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
case 'r': // (files) file may be RETRieved
file.setPermission(FTPFile.USER_ACCESS, FTPFile.READ_PERMISSION, true);
break;
case 'w': // (files) file may be STORed
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
default:
break;
// ignore unexpected flag for now.
} // switch
} // each char
} }
TimeZone GMT = TimeZone.getTimeZone("GMT");
// both timezones need to be set for the parse to work OK
sdf.setTimeZone(GMT);
GregorianCalendar gc = new GregorianCalendar(GMT);
ParsePosition pos = new ParsePosition(0);
sdf.setLenient(false); // We want to parse the whole string
final Date parsed = sdf.parse(timestamp, pos);
if (pos.getIndex() != timestamp.length()) {
return null; // did not fully parse the input
}
gc.setTime(parsed);
if (!hasMillis) {
gc.clear(Calendar.MILLISECOND); // flag up missing ms units
}
return gc;
}
public static FTPFile parseEntry(String entry) { // perm-fact = "Perm" "=" *pvals
return PARSER.parseFTPEntry(entry); // pvals = "a" / "c" / "d" / "e" / "f" /
} // "l" / "m" / "p" / "r" / "w"
private void doUnixPerms(FTPFile file, String valueLowerCase) {
for (char c : valueLowerCase.toCharArray()) {
// TODO these are mostly just guesses at present
switch (c) {
case 'a': // (file) may APPEnd
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
case 'c': // (dir) files may be created in the dir
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
case 'd': // deletable
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
case 'e': // (dir) can change to this dir
file.setPermission(FTPFile.USER_ACCESS, FTPFile.READ_PERMISSION, true);
break;
case 'f': // (file) renamable
// ?? file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
case 'l': // (dir) can be listed
file.setPermission(FTPFile.USER_ACCESS, FTPFile.EXECUTE_PERMISSION, true);
break;
case 'm': // (dir) can create directory here
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
case 'p': // (dir) entries may be deleted
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
case 'r': // (files) file may be RETRieved
file.setPermission(FTPFile.USER_ACCESS, FTPFile.READ_PERMISSION, true);
break;
case 'w': // (files) file may be STORed
file.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
break;
default:
break;
// ignore unexpected flag for now.
} // switch
} // each char
}
public static MLSxEntryParser getInstance() { public static FTPFile parseEntry(String entry) {
return PARSER; return PARSER.parseFTPEntry(entry);
} }
public static MLSxEntryParser getInstance() {
return PARSER;
}
} }

View File

@@ -29,127 +29,125 @@ import org.apache.commons.net.ftp.FTPFile;
* *
* @version $Id: MVSFTPEntryParser.java 1752660 2016-07-14 13:25:39Z sebb $ * @version $Id: MVSFTPEntryParser.java 1752660 2016-07-14 13:25:39Z sebb $
* @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for
* usage instructions) * usage instructions)
*/ */
public class MVSFTPEntryParser extends ConfigurableFTPFileEntryParserImpl { public class MVSFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
static final int UNKNOWN_LIST_TYPE = -1; static final int UNKNOWN_LIST_TYPE = -1;
static final int FILE_LIST_TYPE = 0; static final int FILE_LIST_TYPE = 0;
static final int MEMBER_LIST_TYPE = 1; static final int MEMBER_LIST_TYPE = 1;
static final int UNIX_LIST_TYPE = 2; static final int UNIX_LIST_TYPE = 2;
static final int JES_LEVEL_1_LIST_TYPE = 3; static final int JES_LEVEL_1_LIST_TYPE = 3;
static final int JES_LEVEL_2_LIST_TYPE = 4; static final int JES_LEVEL_2_LIST_TYPE = 4;
private int isType = UNKNOWN_LIST_TYPE; private int isType = UNKNOWN_LIST_TYPE;
/** /**
* Fallback parser for Unix-style listings * Fallback parser for Unix-style listings
*/ */
private UnixFTPEntryParser unixFTPEntryParser; private UnixFTPEntryParser unixFTPEntryParser;
/** /**
* Dates are ignored for file lists, but are used for member lists where * Dates are ignored for file lists, but are used for member lists where
* possible * possible
*/ */
static final String DEFAULT_DATE_FORMAT = "yyyy/MM/dd HH:mm"; // 2001/09/18 static final String DEFAULT_DATE_FORMAT = "yyyy/MM/dd HH:mm"; // 2001/09/18
// 13:52 // 13:52
/** /**
* Matches these entries: * Matches these entries:
* <pre> * <pre>
* Volume Unit Referred Ext Used Recfm Lrecl BlkSz Dsorg Dsname * Volume Unit Referred Ext Used Recfm Lrecl BlkSz Dsorg Dsname
* B10142 3390 2006/03/20 2 31 F 80 80 PS MDI.OKL.WORK * B10142 3390 2006/03/20 2 31 F 80 80 PS MDI.OKL.WORK
* </pre> * </pre>
*/ */
static final String FILE_LIST_REGEX = "\\S+\\s+" + // volume static final String FILE_LIST_REGEX = "\\S+\\s+" + // volume
// ignored // ignored
"\\S+\\s+" + // unit - ignored "\\S+\\s+" + // unit - ignored
"\\S+\\s+" + // access date - ignored "\\S+\\s+" + // access date - ignored
"\\S+\\s+" + // extents -ignored "\\S+\\s+" + // extents -ignored
"\\S+\\s+" + // used - ignored "\\S+\\s+" + // used - ignored
"[FV]\\S*\\s+" + // recfm - must start with F or V "[FV]\\S*\\s+" + // recfm - must start with F or V
"\\S+\\s+" + // logical record length -ignored "\\S+\\s+" + // logical record length -ignored
"\\S+\\s+" + // block size - ignored "\\S+\\s+" + // block size - ignored
"(PS|PO|PO-E)\\s+" + // Dataset organisation. Many exist "(PS|PO|PO-E)\\s+" + // Dataset organisation. Many exist
// but only support: PS, PO, PO-E // but only support: PS, PO, PO-E
"(\\S+)\\s*"; // Dataset Name (file name) "(\\S+)\\s*"; // Dataset Name (file name)
/** /**
* Matches these entries: * Matches these entries:
* <pre> * <pre>
* Name VV.MM Created Changed Size Init Mod Id * Name VV.MM Created Changed Size Init Mod Id
* TBSHELF 01.03 2002/09/12 2002/10/11 09:37 11 11 0 KIL001 * TBSHELF 01.03 2002/09/12 2002/10/11 09:37 11 11 0 KIL001
* </pre> * </pre>
*/ */
static final String MEMBER_LIST_REGEX = "(\\S+)\\s+" + // name static final String MEMBER_LIST_REGEX = "(\\S+)\\s+" + // name
"\\S+\\s+" + // version, modification (ignored) "\\S+\\s+" + // version, modification (ignored)
"\\S+\\s+" + // create date (ignored) "\\S+\\s+" + // create date (ignored)
"(\\S+)\\s+" + // modification date "(\\S+)\\s+" + // modification date
"(\\S+)\\s+" + // modification time "(\\S+)\\s+" + // modification time
"\\S+\\s+" + // size in lines (ignored) "\\S+\\s+" + // size in lines (ignored)
"\\S+\\s+" + // size in lines at creation(ignored) "\\S+\\s+" + // size in lines at creation(ignored)
"\\S+\\s+" + // lines modified (ignored) "\\S+\\s+" + // lines modified (ignored)
"\\S+\\s*"; // id of user who modified (ignored) "\\S+\\s*"; // id of user who modified (ignored)
/** /**
* Matches these entries, note: no header: * Matches these entries, note: no header:
* <pre> * <pre>
* IBMUSER1 JOB01906 OUTPUT 3 Spool Files * IBMUSER1 JOB01906 OUTPUT 3 Spool Files
* 012345678901234567890123456789012345678901234 * 012345678901234567890123456789012345678901234
* 1 2 3 4 * 1 2 3 4
* </pre> * </pre>
*/ */
static final String JES_LEVEL_1_LIST_REGEX = static final String JES_LEVEL_1_LIST_REGEX = "(\\S+)\\s+" + // job name ignored
"(\\S+)\\s+" + // job name ignored "(\\S+)\\s+" + // job number
"(\\S+)\\s+" + // job number "(\\S+)\\s+" + // job status (OUTPUT,INPUT,ACTIVE)
"(\\S+)\\s+" + // job status (OUTPUT,INPUT,ACTIVE) "(\\S+)\\s+" + // number of spool files
"(\\S+)\\s+" + // number of spool files "(\\S+)\\s+" + // Text "Spool" ignored
"(\\S+)\\s+" + // Text "Spool" ignored "(\\S+)\\s*" // Text "Files" ignored
"(\\S+)\\s*" // Text "Files" ignored ;
;
/** /**
* JES INTERFACE LEVEL 2 parser * JES INTERFACE LEVEL 2 parser
* Matches these entries: * Matches these entries:
* <pre> * <pre>
* JOBNAME JOBID OWNER STATUS CLASS * JOBNAME JOBID OWNER STATUS CLASS
* IBMUSER1 JOB01906 IBMUSER OUTPUT A RC=0000 3 spool files * IBMUSER1 JOB01906 IBMUSER OUTPUT A RC=0000 3 spool files
* IBMUSER TSU01830 IBMUSER OUTPUT TSU ABEND=522 3 spool files * IBMUSER TSU01830 IBMUSER OUTPUT TSU ABEND=522 3 spool files
* </pre> * </pre>
* Sample output from FTP session: * Sample output from FTP session:
* <pre> * <pre>
* ftp> quote site filetype=jes * ftp> quote site filetype=jes
* 200 SITE command was accepted * 200 SITE command was accepted
* ftp> ls * ftp> ls
* 200 Port request OK. * 200 Port request OK.
* 125 List started OK for JESJOBNAME=IBMUSER*, JESSTATUS=ALL and JESOWNER=IBMUSER * 125 List started OK for JESJOBNAME=IBMUSER*, JESSTATUS=ALL and JESOWNER=IBMUSER
* JOBNAME JOBID OWNER STATUS CLASS * JOBNAME JOBID OWNER STATUS CLASS
* IBMUSER1 JOB01906 IBMUSER OUTPUT A RC=0000 3 spool files * IBMUSER1 JOB01906 IBMUSER OUTPUT A RC=0000 3 spool files
* IBMUSER TSU01830 IBMUSER OUTPUT TSU ABEND=522 3 spool files * IBMUSER TSU01830 IBMUSER OUTPUT TSU ABEND=522 3 spool files
* 250 List completed successfully. * 250 List completed successfully.
* ftp> ls job01906 * ftp> ls job01906
* 200 Port request OK. * 200 Port request OK.
* 125 List started OK for JESJOBNAME=IBMUSER*, JESSTATUS=ALL and JESOWNER=IBMUSER * 125 List started OK for JESJOBNAME=IBMUSER*, JESSTATUS=ALL and JESOWNER=IBMUSER
* JOBNAME JOBID OWNER STATUS CLASS * JOBNAME JOBID OWNER STATUS CLASS
* IBMUSER1 JOB01906 IBMUSER OUTPUT A RC=0000 * IBMUSER1 JOB01906 IBMUSER OUTPUT A RC=0000
* -------- * --------
* ID STEPNAME PROCSTEP C DDNAME BYTE-COUNT * ID STEPNAME PROCSTEP C DDNAME BYTE-COUNT
* 001 JES2 A JESMSGLG 858 * 001 JES2 A JESMSGLG 858
* 002 JES2 A JESJCL 128 * 002 JES2 A JESJCL 128
* 003 JES2 A JESYSMSG 443 * 003 JES2 A JESYSMSG 443
* 3 spool files * 3 spool files
* 250 List completed successfully. * 250 List completed successfully.
* </pre> * </pre>
*/ */
static final String JES_LEVEL_2_LIST_REGEX = static final String JES_LEVEL_2_LIST_REGEX = "(\\S+)\\s+" + // job name ignored
"(\\S+)\\s+" + // job name ignored "(\\S+)\\s+" + // job number
"(\\S+)\\s+" + // job number "(\\S+)\\s+" + // owner ignored
"(\\S+)\\s+" + // owner ignored "(\\S+)\\s+" + // job status (OUTPUT,INPUT,ACTIVE) ignored
"(\\S+)\\s+" + // job status (OUTPUT,INPUT,ACTIVE) ignored "(\\S+)\\s+" + // job class ignored
"(\\S+)\\s+" + // job class ignored "(\\S+).*" // rest ignored
"(\\S+).*" // rest ignored ;
;
/* /*
* --------------------------------------------------------------------- * ---------------------------------------------------------------------
@@ -238,317 +236,302 @@ public class MVSFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
* *
*/ */
/** /**
* The sole constructor for a MVSFTPEntryParser object. * The sole constructor for a MVSFTPEntryParser object.
* */
*/ public MVSFTPEntryParser() {
public MVSFTPEntryParser() { super(""); // note the regex is set in preParse.
super(""); // note the regex is set in preParse. super.configure(null); // configure parser with default configurations
super.configure(null); // configure parser with default configurations }
/**
* Parses a line of an z/OS - MVS FTP server file listing and converts it
* into a usable format in the form of an <code> FTPFile </code> instance.
* If the file listing line doesn't describe a file, then
* <code> null </code> is returned. Otherwise a <code> FTPFile </code>
* instance representing the file is returned.
*
* @param entry A line of text from the file listing
* @return An FTPFile instance corresponding to the supplied entry
*/
@Override public FTPFile parseFTPEntry(String entry) {
boolean isParsed = false;
FTPFile f = new FTPFile();
if (isType == FILE_LIST_TYPE) {
isParsed = parseFileList(f, entry);
} else if (isType == MEMBER_LIST_TYPE) {
isParsed = parseMemberList(f, entry);
if (!isParsed) {
isParsed = parseSimpleEntry(f, entry);
}
} else if (isType == UNIX_LIST_TYPE) {
isParsed = parseUnixList(f, entry);
} else if (isType == JES_LEVEL_1_LIST_TYPE) {
isParsed = parseJeslevel1List(f, entry);
} else if (isType == JES_LEVEL_2_LIST_TYPE) {
isParsed = parseJeslevel2List(f, entry);
} }
/** if (!isParsed) {
* Parses a line of an z/OS - MVS FTP server file listing and converts it f = null;
* into a usable format in the form of an <code> FTPFile </code> instance.
* If the file listing line doesn't describe a file, then
* <code> null </code> is returned. Otherwise a <code> FTPFile </code>
* instance representing the file is returned.
*
* @param entry
* A line of text from the file listing
* @return An FTPFile instance corresponding to the supplied entry
*/
@Override
public FTPFile parseFTPEntry(String entry) {
boolean isParsed = false;
FTPFile f = new FTPFile();
if (isType == FILE_LIST_TYPE) {
isParsed = parseFileList(f, entry);
} else if (isType == MEMBER_LIST_TYPE) {
isParsed = parseMemberList(f, entry);
if (!isParsed) {
isParsed = parseSimpleEntry(f, entry);
}
} else if (isType == UNIX_LIST_TYPE) {
isParsed = parseUnixList(f, entry);
} else if (isType == JES_LEVEL_1_LIST_TYPE) {
isParsed = parseJeslevel1List(f, entry);
} else if (isType == JES_LEVEL_2_LIST_TYPE) {
isParsed = parseJeslevel2List(f, entry);
}
if (!isParsed) {
f = null;
}
return f;
} }
/** return f;
* Parse entries representing a dataset list. Only datasets with DSORG PS or }
* PO or PO-E and with RECFM F* or V* will be parsed.
*
* Format of ZOS/MVS file list: 1 2 3 4 5 6 7 8 9 10 Volume Unit Referred
* Ext Used Recfm Lrecl BlkSz Dsorg Dsname B10142 3390 2006/03/20 2 31 F 80
* 80 PS MDI.OKL.WORK ARCIVE Not Direct Access Device
* KJ.IOP998.ERROR.PL.UNITTEST B1N231 3390 2006/03/20 1 15 VB 256 27998 PO
* PLU B1N231 3390 2006/03/20 1 15 VB 256 27998 PO-E PLB
*
* ----------------------------------- Group within Regex [1] Volume [2]
* Unit [3] Referred [4] Ext: number of extents [5] Used [6] Recfm: Record
* format [7] Lrecl: Logical record length [8] BlkSz: Block size [9] Dsorg:
* Dataset organisation. Many exists but only support: PS, PO, PO-E [10]
* Dsname: Dataset name
*
* Note: When volume is ARCIVE, it means the dataset is stored somewhere in
* a tape archive. These entries is currently not supported by this parser.
* A null value is returned.
*
* @param file
* will be updated with Name, Type, Timestamp if parsed.
* @param entry zosDirectoryEntry
* @return true: entry was parsed, false: entry was not parsed.
*/
private boolean parseFileList(FTPFile file, String entry) {
if (matches(entry)) {
file.setRawListing(entry);
String name = group(2);
String dsorg = group(1);
file.setName(name);
// DSORG /**
if ("PS".equals(dsorg)) { * Parse entries representing a dataset list. Only datasets with DSORG PS or
file.setType(FTPFile.FILE_TYPE); * PO or PO-E and with RECFM F* or V* will be parsed.
} *
else if ("PO".equals(dsorg) || "PO-E".equals(dsorg)) { * Format of ZOS/MVS file list: 1 2 3 4 5 6 7 8 9 10 Volume Unit Referred
// regex already ruled out anything other than PO or PO-E * Ext Used Recfm Lrecl BlkSz Dsorg Dsname B10142 3390 2006/03/20 2 31 F 80
file.setType(FTPFile.DIRECTORY_TYPE); * 80 PS MDI.OKL.WORK ARCIVE Not Direct Access Device
} * KJ.IOP998.ERROR.PL.UNITTEST B1N231 3390 2006/03/20 1 15 VB 256 27998 PO
else { * PLU B1N231 3390 2006/03/20 1 15 VB 256 27998 PO-E PLB
return false; *
} * ----------------------------------- Group within Regex [1] Volume [2]
* Unit [3] Referred [4] Ext: number of extents [5] Used [6] Recfm: Record
return true; * format [7] Lrecl: Logical record length [8] BlkSz: Block size [9] Dsorg:
} * Dataset organisation. Many exists but only support: PS, PO, PO-E [10]
* Dsname: Dataset name
*
* Note: When volume is ARCIVE, it means the dataset is stored somewhere in
* a tape archive. These entries is currently not supported by this parser.
* A null value is returned.
*
* @param file will be updated with Name, Type, Timestamp if parsed.
* @param entry zosDirectoryEntry
* @return true: entry was parsed, false: entry was not parsed.
*/
private boolean parseFileList(FTPFile file, String entry) {
if (matches(entry)) {
file.setRawListing(entry);
String name = group(2);
String dsorg = group(1);
file.setName(name);
// DSORG
if ("PS".equals(dsorg)) {
file.setType(FTPFile.FILE_TYPE);
} else if ("PO".equals(dsorg) || "PO-E".equals(dsorg)) {
// regex already ruled out anything other than PO or PO-E
file.setType(FTPFile.DIRECTORY_TYPE);
} else {
return false; return false;
}
return true;
} }
/** return false;
* Parse entries within a partitioned dataset. }
*
* Format of a memberlist within a PDS:
* <pre>
* 0 1 2 3 4 5 6 7 8
* Name VV.MM Created Changed Size Init Mod Id
* TBSHELF 01.03 2002/09/12 2002/10/11 09:37 11 11 0 KIL001
* TBTOOL 01.12 2002/09/12 2004/11/26 19:54 51 28 0 KIL001
*
* -------------------------------------------
* [1] Name
* [2] VV.MM: Version . modification
* [3] Created: yyyy / MM / dd
* [4,5] Changed: yyyy / MM / dd HH:mm
* [6] Size: number of lines
* [7] Init: number of lines when first created
* [8] Mod: number of modified lines a last save
* [9] Id: User id for last update
* </pre>
*
* @param file
* will be updated with Name, Type and Timestamp if parsed.
* @param entry zosDirectoryEntry
* @return true: entry was parsed, false: entry was not parsed.
*/
private boolean parseMemberList(FTPFile file, String entry) {
if (matches(entry)) {
file.setRawListing(entry);
String name = group(1);
String datestr = group(2) + " " + group(3);
file.setName(name);
file.setType(FTPFile.FILE_TYPE);
try {
file.setTimestamp(super.parseTimestamp(datestr));
} catch (ParseException e) {
e.printStackTrace();
// just ignore parsing errors.
// TODO check this is ok
return false; // this is a parsing failure too.
}
return true;
}
return false; /**
* Parse entries within a partitioned dataset.
*
* Format of a memberlist within a PDS:
* <pre>
* 0 1 2 3 4 5 6 7 8
* Name VV.MM Created Changed Size Init Mod Id
* TBSHELF 01.03 2002/09/12 2002/10/11 09:37 11 11 0 KIL001
* TBTOOL 01.12 2002/09/12 2004/11/26 19:54 51 28 0 KIL001
*
* -------------------------------------------
* [1] Name
* [2] VV.MM: Version . modification
* [3] Created: yyyy / MM / dd
* [4,5] Changed: yyyy / MM / dd HH:mm
* [6] Size: number of lines
* [7] Init: number of lines when first created
* [8] Mod: number of modified lines a last save
* [9] Id: User id for last update
* </pre>
*
* @param file will be updated with Name, Type and Timestamp if parsed.
* @param entry zosDirectoryEntry
* @return true: entry was parsed, false: entry was not parsed.
*/
private boolean parseMemberList(FTPFile file, String entry) {
if (matches(entry)) {
file.setRawListing(entry);
String name = group(1);
String datestr = group(2) + " " + group(3);
file.setName(name);
file.setType(FTPFile.FILE_TYPE);
try {
file.setTimestamp(super.parseTimestamp(datestr));
} catch (ParseException e) {
e.printStackTrace();
// just ignore parsing errors.
// TODO check this is ok
return false; // this is a parsing failure too.
}
return true;
} }
/** return false;
* Assigns the name to the first word of the entry. Only to be used from a }
* safe context, for example from a memberlist, where the regex for some
* reason fails. Then just assign the name field of FTPFile.
*
* @param file
* @param entry
* @return true if the entry string is non-null and non-empty
*/
private boolean parseSimpleEntry(FTPFile file, String entry) {
if (entry != null && entry.trim().length() > 0) {
file.setRawListing(entry);
String name = entry.split(" ")[0];
file.setName(name);
file.setType(FTPFile.FILE_TYPE);
return true;
}
return false;
}
/** /**
* Parse the entry as a standard unix file. Using the UnixFTPEntryParser. * Assigns the name to the first word of the entry. Only to be used from a
* * safe context, for example from a memberlist, where the regex for some
* @param file * reason fails. Then just assign the name field of FTPFile.
* @param entry *
* @return true: entry is parsed, false: entry could not be parsed. * @return true if the entry string is non-null and non-empty
*/ */
private boolean parseUnixList(FTPFile file, String entry) { private boolean parseSimpleEntry(FTPFile file, String entry) {
file = unixFTPEntryParser.parseFTPEntry(entry); if (entry != null && entry.trim().length() > 0) {
if (file == null) { file.setRawListing(entry);
return false; String name = entry.split(" ")[0];
} file.setName(name);
file.setType(FTPFile.FILE_TYPE);
return true;
}
return false;
}
/**
* Parse the entry as a standard unix file. Using the UnixFTPEntryParser.
*
* @return true: entry is parsed, false: entry could not be parsed.
*/
private boolean parseUnixList(FTPFile file, String entry) {
file = unixFTPEntryParser.parseFTPEntry(entry);
if (file == null) {
return false;
}
return true;
}
/**
* Matches these entries, note: no header:
* <pre>
* [1] [2] [3] [4] [5]
* IBMUSER1 JOB01906 OUTPUT 3 Spool Files
* 012345678901234567890123456789012345678901234
* 1 2 3 4
* -------------------------------------------
* Group in regex
* [1] Job name
* [2] Job number
* [3] Job status (INPUT,ACTIVE,OUTPUT)
* [4] Number of sysout files
* [5] The string "Spool Files"
* </pre>
*
* @param file will be updated with Name, Type and Timestamp if parsed.
* @param entry zosDirectoryEntry
* @return true: entry was parsed, false: entry was not parsed.
*/
private boolean parseJeslevel1List(FTPFile file, String entry) {
if (matches(entry)) {
if (group(3).equalsIgnoreCase("OUTPUT")) {
file.setRawListing(entry);
String name = group(2); /* Job Number, used by GET */
file.setName(name);
file.setType(FTPFile.FILE_TYPE);
return true; return true;
}
} }
/** return false;
* Matches these entries, note: no header: }
* <pre>
* [1] [2] [3] [4] [5]
* IBMUSER1 JOB01906 OUTPUT 3 Spool Files
* 012345678901234567890123456789012345678901234
* 1 2 3 4
* -------------------------------------------
* Group in regex
* [1] Job name
* [2] Job number
* [3] Job status (INPUT,ACTIVE,OUTPUT)
* [4] Number of sysout files
* [5] The string "Spool Files"
*</pre>
*
* @param file
* will be updated with Name, Type and Timestamp if parsed.
* @param entry zosDirectoryEntry
* @return true: entry was parsed, false: entry was not parsed.
*/
private boolean parseJeslevel1List(FTPFile file, String entry) {
if (matches(entry)) {
if (group(3).equalsIgnoreCase("OUTPUT")) {
file.setRawListing(entry);
String name = group(2); /* Job Number, used by GET */
file.setName(name);
file.setType(FTPFile.FILE_TYPE);
return true;
}
}
return false; /**
* Matches these entries:
* <pre>
* [1] [2] [3] [4] [5]
* JOBNAME JOBID OWNER STATUS CLASS
* IBMUSER1 JOB01906 IBMUSER OUTPUT A RC=0000 3 spool files
* IBMUSER TSU01830 IBMUSER OUTPUT TSU ABEND=522 3 spool files
* 012345678901234567890123456789012345678901234
* 1 2 3 4
* -------------------------------------------
* Group in regex
* [1] Job name
* [2] Job number
* [3] Owner
* [4] Job status (INPUT,ACTIVE,OUTPUT)
* [5] Job Class
* [6] The rest
* </pre>
*
* @param file will be updated with Name, Type and Timestamp if parsed.
* @param entry zosDirectoryEntry
* @return true: entry was parsed, false: entry was not parsed.
*/
private boolean parseJeslevel2List(FTPFile file, String entry) {
if (matches(entry)) {
if (group(4).equalsIgnoreCase("OUTPUT")) {
file.setRawListing(entry);
String name = group(2); /* Job Number, used by GET */
file.setName(name);
file.setType(FTPFile.FILE_TYPE);
return true;
}
} }
/** return false;
* Matches these entries: }
* <pre>
* [1] [2] [3] [4] [5]
* JOBNAME JOBID OWNER STATUS CLASS
* IBMUSER1 JOB01906 IBMUSER OUTPUT A RC=0000 3 spool files
* IBMUSER TSU01830 IBMUSER OUTPUT TSU ABEND=522 3 spool files
* 012345678901234567890123456789012345678901234
* 1 2 3 4
* -------------------------------------------
* Group in regex
* [1] Job name
* [2] Job number
* [3] Owner
* [4] Job status (INPUT,ACTIVE,OUTPUT)
* [5] Job Class
* [6] The rest
* </pre>
*
* @param file
* will be updated with Name, Type and Timestamp if parsed.
* @param entry zosDirectoryEntry
* @return true: entry was parsed, false: entry was not parsed.
*/
private boolean parseJeslevel2List(FTPFile file, String entry) {
if (matches(entry)) {
if (group(4).equalsIgnoreCase("OUTPUT")) {
file.setRawListing(entry);
String name = group(2); /* Job Number, used by GET */
file.setName(name);
file.setType(FTPFile.FILE_TYPE);
return true;
}
}
return false; /**
* preParse is called as part of the interface. Per definition is is called
* before the parsing takes place.
* Three kind of lists is recognize:
* z/OS-MVS File lists
* z/OS-MVS Member lists
* unix file lists
*
* @since 2.0
*/
@Override public List<String> preParse(List<String> orig) {
// simply remove the header line. Composite logic will take care of the
// two different types of
// list in short order.
if (orig != null && orig.size() > 0) {
String header = orig.get(0);
if (header.indexOf("Volume") >= 0 && header.indexOf("Dsname") >= 0) {
setType(FILE_LIST_TYPE);
super.setRegex(FILE_LIST_REGEX);
} else if (header.indexOf("Name") >= 0 && header.indexOf("Id") >= 0) {
setType(MEMBER_LIST_TYPE);
super.setRegex(MEMBER_LIST_REGEX);
} else if (header.indexOf("total") == 0) {
setType(UNIX_LIST_TYPE);
unixFTPEntryParser = new UnixFTPEntryParser();
} else if (header.indexOf("Spool Files") >= 30) {
setType(JES_LEVEL_1_LIST_TYPE);
super.setRegex(JES_LEVEL_1_LIST_REGEX);
} else if (header.indexOf("JOBNAME") == 0
&& header.indexOf("JOBID") > 8) {// header contains JOBNAME JOBID OWNER // STATUS CLASS
setType(JES_LEVEL_2_LIST_TYPE);
super.setRegex(JES_LEVEL_2_LIST_REGEX);
} else {
setType(UNKNOWN_LIST_TYPE);
}
if (isType != JES_LEVEL_1_LIST_TYPE) { // remove header is necessary
orig.remove(0);
}
} }
/** return orig;
* preParse is called as part of the interface. Per definition is is called }
* before the parsing takes place.
* Three kind of lists is recognize:
* z/OS-MVS File lists
* z/OS-MVS Member lists
* unix file lists
* @since 2.0
*/
@Override
public List<String> preParse(List<String> orig) {
// simply remove the header line. Composite logic will take care of the
// two different types of
// list in short order.
if (orig != null && orig.size() > 0) {
String header = orig.get(0);
if (header.indexOf("Volume") >= 0 && header.indexOf("Dsname") >= 0) {
setType(FILE_LIST_TYPE);
super.setRegex(FILE_LIST_REGEX);
} else if (header.indexOf("Name") >= 0 && header.indexOf("Id") >= 0) {
setType(MEMBER_LIST_TYPE);
super.setRegex(MEMBER_LIST_REGEX);
} else if (header.indexOf("total") == 0) {
setType(UNIX_LIST_TYPE);
unixFTPEntryParser = new UnixFTPEntryParser();
} else if (header.indexOf("Spool Files") >= 30) {
setType(JES_LEVEL_1_LIST_TYPE);
super.setRegex(JES_LEVEL_1_LIST_REGEX);
} else if (header.indexOf("JOBNAME") == 0
&& header.indexOf("JOBID") > 8) {// header contains JOBNAME JOBID OWNER // STATUS CLASS
setType(JES_LEVEL_2_LIST_TYPE);
super.setRegex(JES_LEVEL_2_LIST_REGEX);
} else {
setType(UNKNOWN_LIST_TYPE);
}
if (isType != JES_LEVEL_1_LIST_TYPE) { // remove header is necessary /**
orig.remove(0); * Explicitly set the type of listing being processed.
} *
} * @param type The listing type.
*/
return orig; void setType(int type) {
} isType = type;
}
/**
* Explicitly set the type of listing being processed.
* @param type The listing type.
*/
void setType(int type) {
isType = type;
}
/*
* @return
*/
@Override
protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(FTPClientConfig.SYST_MVS,
DEFAULT_DATE_FORMAT, null);
}
/*
* @return
*/
@Override protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(FTPClientConfig.SYST_MVS, DEFAULT_DATE_FORMAT, null);
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp.parser; package org.apache.commons.net.ftp.parser;
import java.text.ParseException; import java.text.ParseException;
import org.apache.commons.net.ftp.FTPClientConfig; import org.apache.commons.net.ftp.FTPClientConfig;
@@ -28,44 +29,44 @@ import org.apache.commons.net.ftp.FTPFile;
* @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions) * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
* @since 3.1 * @since 3.1
*/ */
public class MacOsPeterFTPEntryParser extends ConfigurableFTPFileEntryParserImpl public class MacOsPeterFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
{
static final String DEFAULT_DATE_FORMAT static final String DEFAULT_DATE_FORMAT = "MMM d yyyy"; //Nov 9 2001
= "MMM d yyyy"; //Nov 9 2001
static final String DEFAULT_RECENT_DATE_FORMAT static final String DEFAULT_RECENT_DATE_FORMAT = "MMM d HH:mm"; //Nov 9 20:06
= "MMM d HH:mm"; //Nov 9 20:06
/** /**
* this is the regular expression used by this parser. * this is the regular expression used by this parser.
* *
* Permissions: * Permissions:
* r the file is readable * r the file is readable
* w the file is writable * w the file is writable
* x the file is executable * x the file is executable
* - the indicated permission is not granted * - the indicated permission is not granted
* L mandatory locking occurs during access (the set-group-ID bit is * L mandatory locking occurs during access (the set-group-ID bit is
* on and the group execution bit is off) * on and the group execution bit is off)
* s the set-user-ID or set-group-ID bit is on, and the corresponding * s the set-user-ID or set-group-ID bit is on, and the corresponding
* user or group execution bit is also on * user or group execution bit is also on
* S undefined bit-state (the set-user-ID bit is on and the user * S undefined bit-state (the set-user-ID bit is on and the user
* execution bit is off) * execution bit is off)
* t the 1000 (octal) bit, or sticky bit, is on [see chmod(1)], and * t the 1000 (octal) bit, or sticky bit, is on [see chmod(1)], and
* execution is on * execution is on
* T the 1000 bit is turned on, and execution is off (undefined bit- * T the 1000 bit is turned on, and execution is off (undefined bit-
* state) * state)
* e z/OS external link bit * e z/OS external link bit
*/ */
private static final String REGEX = private static final String REGEX = "([bcdelfmpSs-])"
"([bcdelfmpSs-])" // type (1) // type (1)
+ "(((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-])))\\+?\\s+" // permission + "(((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-])))\\+?\\s+"
+ "(" // permission
+ "(folder\\s+)" + "("
+ "|" + "(folder\\s+)"
+ "((\\d+)\\s+(\\d+)\\s+)" // resource size & data size + "|"
+ ")" + "((\\d+)\\s+(\\d+)\\s+)"
+ "(\\d+)\\s+" // size // resource size & data size
+ ")"
+ "(\\d+)\\s+"
// size
/* /*
* numeric or standard format date: * numeric or standard format date:
* yyyy-mm-dd (expecting hh:mm to follow) * yyyy-mm-dd (expecting hh:mm to follow)
@@ -74,205 +75,170 @@ public class MacOsPeterFTPEntryParser extends ConfigurableFTPFileEntryParserImpl
* N.B. use non-space for MMM to allow for languages such as German which use * N.B. use non-space for MMM to allow for languages such as German which use
* diacritics (e.g. umlaut) in some abbreviations. * diacritics (e.g. umlaut) in some abbreviations.
*/ */
+ "((?:\\d+[-/]\\d+[-/]\\d+)|(?:\\S{3}\\s+\\d{1,2})|(?:\\d{1,2}\\s+\\S{3}))\\s+" + "((?:\\d+[-/]\\d+[-/]\\d+)|(?:\\S{3}\\s+\\d{1,2})|(?:\\d{1,2}\\s+\\S{3}))\\s+"
/* /*
year (for non-recent standard format) - yyyy year (for non-recent standard format) - yyyy
or time (for numeric or recent standard format) [h]h:mm or time (for numeric or recent standard format) [h]h:mm
*/ */
+ "(\\d+(?::\\d+)?)\\s+" + "(\\d+(?::\\d+)?)\\s+"
+ "(\\S*)(\\s*.*)"; // the rest + "(\\S*)(\\s*.*)"; // the rest
/**
* The default constructor for a UnixFTPEntryParser object.
*
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
*/
public MacOsPeterFTPEntryParser() {
this(null);
}
/** /**
* The default constructor for a UnixFTPEntryParser object. * This constructor allows the creation of a UnixFTPEntryParser object with
* * something other than the default configuration.
* @throws IllegalArgumentException *
* Thrown if the regular expression is unparseable. Should not be seen * @param config The {@link FTPClientConfig configuration} object used to
* under normal conditions. It it is seen, this is a sign that * configure this parser.
* <code>REGEX</code> is not a valid regular expression. * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
*/ * be seen
public MacOsPeterFTPEntryParser() * under normal conditions. It it is seen, this is a sign that
{ * <code>REGEX</code> is not a valid regular expression.
this(null); * @since 1.4
} */
public MacOsPeterFTPEntryParser(FTPClientConfig config) {
super(REGEX);
configure(config);
}
/** /**
* This constructor allows the creation of a UnixFTPEntryParser object with * Parses a line of a unix (standard) FTP server file listing and converts
* something other than the default configuration. * it into a usable format in the form of an <code> FTPFile </code>
* * instance. If the file listing line doesn't describe a file,
* @param config The {@link FTPClientConfig configuration} object used to * <code> null </code> is returned, otherwise a <code> FTPFile </code>
* configure this parser. * instance representing the files in the directory is returned.
* @throws IllegalArgumentException *
* Thrown if the regular expression is unparseable. Should not be seen * @param entry A line of text from the file listing
* under normal conditions. It it is seen, this is a sign that * @return An FTPFile instance corresponding to the supplied entry
* <code>REGEX</code> is not a valid regular expression. */
* @since 1.4 @Override public FTPFile parseFTPEntry(String entry) {
*/ FTPFile file = new FTPFile();
public MacOsPeterFTPEntryParser(FTPClientConfig config) file.setRawListing(entry);
{ int type;
super(REGEX); boolean isDevice = false;
configure(config);
}
/** if (matches(entry)) {
* Parses a line of a unix (standard) FTP server file listing and converts String typeStr = group(1);
* it into a usable format in the form of an <code> FTPFile </code> String hardLinkCount = "0";
* instance. If the file listing line doesn't describe a file, String usr = null;
* <code> null </code> is returned, otherwise a <code> FTPFile </code> String grp = null;
* instance representing the files in the directory is returned. String filesize = group(20);
* String datestr = group(21) + " " + group(22);
* @param entry A line of text from the file listing String name = group(23);
* @return An FTPFile instance corresponding to the supplied entry String endtoken = group(24);
*/
@Override
public FTPFile parseFTPEntry(String entry) {
FTPFile file = new FTPFile();
file.setRawListing(entry);
int type;
boolean isDevice = false;
if (matches(entry)) try {
{ file.setTimestamp(super.parseTimestamp(datestr));
String typeStr = group(1); } catch (ParseException e) {
String hardLinkCount = "0"; // intentionally do nothing
String usr = null; }
String grp = null;
String filesize = group(20);
String datestr = group(21) + " " + group(22);
String name = group(23);
String endtoken = group(24);
try // A 'whiteout' file is an ARTIFICIAL entry in any of several types of
{ // 'translucent' filesystems, of which a 'union' filesystem is one.
file.setTimestamp(super.parseTimestamp(datestr));
}
catch (ParseException e)
{
// intentionally do nothing
}
// A 'whiteout' file is an ARTIFICIAL entry in any of several types of // bcdelfmpSs-
// 'translucent' filesystems, of which a 'union' filesystem is one. switch (typeStr.charAt(0)) {
case 'd':
type = FTPFile.DIRECTORY_TYPE;
break;
case 'e': // NET-39 => z/OS external link
type = FTPFile.SYMBOLIC_LINK_TYPE;
break;
case 'l':
type = FTPFile.SYMBOLIC_LINK_TYPE;
break;
case 'b':
case 'c':
isDevice = true;
type = FTPFile.FILE_TYPE; // TODO change this if DEVICE_TYPE implemented
break;
case 'f':
case '-':
type = FTPFile.FILE_TYPE;
break;
default: // e.g. ? and w = whiteout
type = FTPFile.UNKNOWN_TYPE;
}
// bcdelfmpSs- file.setType(type);
switch (typeStr.charAt(0))
{
case 'd':
type = FTPFile.DIRECTORY_TYPE;
break;
case 'e': // NET-39 => z/OS external link
type = FTPFile.SYMBOLIC_LINK_TYPE;
break;
case 'l':
type = FTPFile.SYMBOLIC_LINK_TYPE;
break;
case 'b':
case 'c':
isDevice = true;
type = FTPFile.FILE_TYPE; // TODO change this if DEVICE_TYPE implemented
break;
case 'f':
case '-':
type = FTPFile.FILE_TYPE;
break;
default: // e.g. ? and w = whiteout
type = FTPFile.UNKNOWN_TYPE;
}
file.setType(type); int g = 4;
for (int access = 0; access < 3; access++, g += 4) {
// Use != '-' to avoid having to check for suid and sticky bits
file.setPermission(access, FTPFile.READ_PERMISSION, (!group(g).equals("-")));
file.setPermission(access, FTPFile.WRITE_PERMISSION, (!group(g + 1).equals("-")));
int g = 4; String execPerm = group(g + 2);
for (int access = 0; access < 3; access++, g += 4) if (!execPerm.equals("-") && !Character.isUpperCase(execPerm.charAt(0))) {
{ file.setPermission(access, FTPFile.EXECUTE_PERMISSION, true);
// Use != '-' to avoid having to check for suid and sticky bits } else {
file.setPermission(access, FTPFile.READ_PERMISSION, file.setPermission(access, FTPFile.EXECUTE_PERMISSION, false);
(!group(g).equals("-")));
file.setPermission(access, FTPFile.WRITE_PERMISSION,
(!group(g + 1).equals("-")));
String execPerm = group(g + 2);
if (!execPerm.equals("-") && !Character.isUpperCase(execPerm.charAt(0)))
{
file.setPermission(access, FTPFile.EXECUTE_PERMISSION, true);
}
else
{
file.setPermission(access, FTPFile.EXECUTE_PERMISSION, false);
}
}
if (!isDevice)
{
try
{
file.setHardLinkCount(Integer.parseInt(hardLinkCount));
}
catch (NumberFormatException e)
{
// intentionally do nothing
}
}
file.setUser(usr);
file.setGroup(grp);
try
{
file.setSize(Long.parseLong(filesize));
}
catch (NumberFormatException e)
{
// intentionally do nothing
}
if (null == endtoken)
{
file.setName(name);
}
else
{
// oddball cases like symbolic links, file names
// with spaces in them.
name += endtoken;
if (type == FTPFile.SYMBOLIC_LINK_TYPE)
{
int end = name.indexOf(" -> ");
// Give up if no link indicator is present
if (end == -1)
{
file.setName(name);
}
else
{
file.setName(name.substring(0, end));
file.setLink(name.substring(end + 4));
}
}
else
{
file.setName(name);
}
}
return file;
} }
return null; }
}
/** if (!isDevice) {
* Defines a default configuration to be used when this class is try {
* instantiated without a {@link FTPClientConfig FTPClientConfig} file.setHardLinkCount(Integer.parseInt(hardLinkCount));
* parameter being specified. } catch (NumberFormatException e) {
* @return the default configuration for this parser. // intentionally do nothing
*/ }
@Override }
protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(
FTPClientConfig.SYST_UNIX,
DEFAULT_DATE_FORMAT,
DEFAULT_RECENT_DATE_FORMAT);
}
file.setUser(usr);
file.setGroup(grp);
try {
file.setSize(Long.parseLong(filesize));
} catch (NumberFormatException e) {
// intentionally do nothing
}
if (null == endtoken) {
file.setName(name);
} else {
// oddball cases like symbolic links, file names
// with spaces in them.
name += endtoken;
if (type == FTPFile.SYMBOLIC_LINK_TYPE) {
int end = name.indexOf(" -> ");
// Give up if no link indicator is present
if (end == -1) {
file.setName(name);
} else {
file.setName(name.substring(0, end));
file.setLink(name.substring(end + 4));
}
} else {
file.setName(name);
}
}
return file;
}
return null;
}
/**
* Defines a default configuration to be used when this class is
* instantiated without a {@link FTPClientConfig FTPClientConfig}
* parameter being specified.
*
* @return the default configuration for this parser.
*/
@Override protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(FTPClientConfig.SYST_UNIX, DEFAULT_DATE_FORMAT,
DEFAULT_RECENT_DATE_FORMAT);
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp.parser; package org.apache.commons.net.ftp.parser;
import java.text.ParseException; import java.text.ParseException;
import java.util.regex.Pattern; import java.util.regex.Pattern;
@@ -29,139 +30,113 @@ import org.apache.commons.net.ftp.FTPFile;
* @version $Id: NTFTPEntryParser.java 1752660 2016-07-14 13:25:39Z sebb $ * @version $Id: NTFTPEntryParser.java 1752660 2016-07-14 13:25:39Z sebb $
* @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions) * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
*/ */
public class NTFTPEntryParser extends ConfigurableFTPFileEntryParserImpl public class NTFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
{
private static final String DEFAULT_DATE_FORMAT private static final String DEFAULT_DATE_FORMAT = "MM-dd-yy hh:mma"; //11-09-01 12:30PM
= "MM-dd-yy hh:mma"; //11-09-01 12:30PM
private static final String DEFAULT_DATE_FORMAT2 private static final String DEFAULT_DATE_FORMAT2 = "MM-dd-yy kk:mm"; //11-09-01 18:30
= "MM-dd-yy kk:mm"; //11-09-01 18:30
private final FTPTimestampParser timestampParser; private final FTPTimestampParser timestampParser;
/** /**
* this is the regular expression used by this parser. * this is the regular expression used by this parser.
*/ */
private static final String REGEX = private static final String REGEX =
"(\\S+)\\s+(\\S+)\\s+" // MM-dd-yy whitespace hh:mma|kk:mm; swallow trailing spaces "(\\S+)\\s+(\\S+)\\s+" // MM-dd-yy whitespace hh:mma|kk:mm; swallow trailing spaces
+ "(?:(<DIR>)|([0-9]+))\\s+" // <DIR> or ddddd; swallow trailing spaces + "(?:(<DIR>)|([0-9]+))\\s+" // <DIR> or ddddd; swallow trailing spaces
+ "(\\S.*)"; // First non-space followed by rest of line (name) + "(\\S.*)"; // First non-space followed by rest of line (name)
/** /**
* The sole constructor for an NTFTPEntryParser object. * The sole constructor for an NTFTPEntryParser object.
* *
* @throws IllegalArgumentException * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* Thrown if the regular expression is unparseable. Should not be seen * be seen
* under normal conditions. It it is seen, this is a sign that * under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression. * <code>REGEX</code> is not a valid regular expression.
*/ */
public NTFTPEntryParser() public NTFTPEntryParser() {
{ this(null);
this(null); }
}
/** /**
* This constructor allows the creation of an NTFTPEntryParser object * This constructor allows the creation of an NTFTPEntryParser object
* with something other than the default configuration. * with something other than the default configuration.
* *
* @param config The {@link FTPClientConfig configuration} object used to * @param config The {@link FTPClientConfig configuration} object used to
* configure this parser. * configure this parser.
* @throws IllegalArgumentException * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* Thrown if the regular expression is unparseable. Should not be seen * be seen
* under normal conditions. It it is seen, this is a sign that * under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression. * <code>REGEX</code> is not a valid regular expression.
* @since 1.4 * @since 1.4
*/ */
public NTFTPEntryParser(FTPClientConfig config) public NTFTPEntryParser(FTPClientConfig config) {
{ super(REGEX, Pattern.DOTALL);
super(REGEX, Pattern.DOTALL); configure(config);
configure(config); FTPClientConfig config2 =
FTPClientConfig config2 = new FTPClientConfig( new FTPClientConfig(FTPClientConfig.SYST_NT, DEFAULT_DATE_FORMAT2, null);
FTPClientConfig.SYST_NT, config2.setDefaultDateFormatStr(DEFAULT_DATE_FORMAT2);
DEFAULT_DATE_FORMAT2, this.timestampParser = new FTPTimestampParserImpl();
null); ((Configurable) this.timestampParser).configure(config2);
config2.setDefaultDateFormatStr(DEFAULT_DATE_FORMAT2); }
this.timestampParser = new FTPTimestampParserImpl();
((Configurable)this.timestampParser).configure(config2);
}
/** /**
* Parses a line of an NT FTP server file listing and converts it into a * Parses a line of an NT FTP server file listing and converts it into a
* usable format in the form of an <code> FTPFile </code> instance. If the * usable format in the form of an <code> FTPFile </code> instance. If the
* file listing line doesn't describe a file, <code> null </code> is * file listing line doesn't describe a file, <code> null </code> is
* returned, otherwise a <code> FTPFile </code> instance representing the * returned, otherwise a <code> FTPFile </code> instance representing the
* files in the directory is returned. * files in the directory is returned.
* *
* @param entry A line of text from the file listing * @param entry A line of text from the file listing
* @return An FTPFile instance corresponding to the supplied entry * @return An FTPFile instance corresponding to the supplied entry
*/ */
@Override @Override public FTPFile parseFTPEntry(String entry) {
public FTPFile parseFTPEntry(String entry) FTPFile f = new FTPFile();
{ f.setRawListing(entry);
FTPFile f = new FTPFile();
f.setRawListing(entry);
if (matches(entry)) if (matches(entry)) {
{ String datestr = group(1) + " " + group(2);
String datestr = group(1)+" "+group(2); String dirString = group(3);
String dirString = group(3); String size = group(4);
String size = group(4); String name = group(5);
String name = group(5); try {
try f.setTimestamp(super.parseTimestamp(datestr));
{ } catch (ParseException e) {
f.setTimestamp(super.parseTimestamp(datestr)); // parsing fails, try the other date format
} try {
catch (ParseException e) f.setTimestamp(timestampParser.parseTimestamp(datestr));
{ } catch (ParseException e2) {
// parsing fails, try the other date format // intentionally do nothing
try
{
f.setTimestamp(timestampParser.parseTimestamp(datestr));
}
catch (ParseException e2)
{
// intentionally do nothing
}
}
if (null == name || name.equals(".") || name.equals(".."))
{
return (null);
}
f.setName(name);
if ("<DIR>".equals(dirString))
{
f.setType(FTPFile.DIRECTORY_TYPE);
f.setSize(0);
}
else
{
f.setType(FTPFile.FILE_TYPE);
if (null != size)
{
f.setSize(Long.parseLong(size));
}
}
return (f);
} }
return null; }
}
/** if (null == name || name.equals(".") || name.equals("..")) {
* Defines a default configuration to be used when this class is return (null);
* instantiated without a {@link FTPClientConfig FTPClientConfig} }
* parameter being specified. f.setName(name);
* @return the default configuration for this parser.
*/
@Override
public FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(
FTPClientConfig.SYST_NT,
DEFAULT_DATE_FORMAT,
null);
}
if ("<DIR>".equals(dirString)) {
f.setType(FTPFile.DIRECTORY_TYPE);
f.setSize(0);
} else {
f.setType(FTPFile.FILE_TYPE);
if (null != size) {
f.setSize(Long.parseLong(size));
}
}
return (f);
}
return null;
}
/**
* Defines a default configuration to be used when this class is
* instantiated without a {@link FTPClientConfig FTPClientConfig}
* parameter being specified.
*
* @return the default configuration for this parser.
*/
@Override public FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(FTPClientConfig.SYST_NT, DEFAULT_DATE_FORMAT, null);
}
} }

View File

@@ -23,155 +23,153 @@ import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFile; import org.apache.commons.net.ftp.FTPFile;
/** /**
* Implementation of FTPFileEntryParser and FTPFileListParser for Netware Systems. Note that some of the proprietary * Implementation of FTPFileEntryParser and FTPFileListParser for Netware Systems. Note that some of
* the proprietary
* extensions for Novell-specific operations are not supported. See * extensions for Novell-specific operations are not supported. See
* <a href="http://www.novell.com/documentation/nw65/index.html?page=/documentation/nw65/ftp_enu/data/fbhbgcfa.html"> * <a href="http://www.novell.com/documentation/nw65/index.html?page=/documentation/nw65/ftp_enu/data/fbhbgcfa.html">
* http://www.novell.com/documentation/nw65/index.html?page=/documentation/nw65/ftp_enu/data/fbhbgcfa.html</a> * http://www.novell.com/documentation/nw65/index.html?page=/documentation/nw65/ftp_enu/data/fbhbgcfa.html</a>
* for more details. * for more details.
* *
* @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
* @version $Id: NetwareFTPEntryParser.java 1752660 2016-07-14 13:25:39Z sebb $ * @version $Id: NetwareFTPEntryParser.java 1752660 2016-07-14 13:25:39Z sebb $
* @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
* @since 1.5 * @since 1.5
*/ */
public class NetwareFTPEntryParser extends ConfigurableFTPFileEntryParserImpl { public class NetwareFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
/** /**
* Default date format is e.g. Feb 22 2006 * Default date format is e.g. Feb 22 2006
*/ */
private static final String DEFAULT_DATE_FORMAT = "MMM dd yyyy"; private static final String DEFAULT_DATE_FORMAT = "MMM dd yyyy";
/** /**
* Default recent date format is e.g. Feb 22 17:32 * Default recent date format is e.g. Feb 22 17:32
*/ */
private static final String DEFAULT_RECENT_DATE_FORMAT = "MMM dd HH:mm"; private static final String DEFAULT_RECENT_DATE_FORMAT = "MMM dd HH:mm";
/** /**
* this is the regular expression used by this parser. * this is the regular expression used by this parser.
* Example: d [-W---F--] SCION_VOL2 512 Apr 13 23:12 VOL2 * Example: d [-W---F--] SCION_VOL2 512 Apr 13 23:12 VOL2
*/ */
private static final String REGEX = "(d|-){1}\\s+" // Directory/file flag private static final String REGEX = "(d|-){1}\\s+" // Directory/file flag
+ "\\[([-A-Z]+)\\]\\s+" // Attributes RWCEAFMS or - + "\\[([-A-Z]+)\\]\\s+" // Attributes RWCEAFMS or -
+ "(\\S+)\\s+" + "(\\d+)\\s+" // Owner and size + "(\\S+)\\s+" + "(\\d+)\\s+" // Owner and size
+ "(\\S+\\s+\\S+\\s+((\\d+:\\d+)|(\\d{4})))" // Long/short date format + "(\\S+\\s+\\S+\\s+((\\d+:\\d+)|(\\d{4})))" // Long/short date format
+ "\\s+(.*)"; // Filename (incl. spaces) + "\\s+(.*)"; // Filename (incl. spaces)
/** /**
* The default constructor for a NetwareFTPEntryParser object. * The default constructor for a NetwareFTPEntryParser object.
* *
* @throws IllegalArgumentException * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* Thrown if the regular expression is unparseable. Should not be seen * be seen
* under normal conditions. It it is seen, this is a sign that * under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression. * <code>REGEX</code> is not a valid regular expression.
*/ */
public NetwareFTPEntryParser() { public NetwareFTPEntryParser() {
this(null); this(null);
} }
/** /**
* This constructor allows the creation of an NetwareFTPEntryParser object * This constructor allows the creation of an NetwareFTPEntryParser object
* with something other than the default configuration. * with something other than the default configuration.
* *
* @param config The {@link FTPClientConfig configuration} object used to * @param config The {@link FTPClientConfig configuration} object used to
* configure this parser. * configure this parser.
* @throws IllegalArgumentException * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* Thrown if the regular expression is unparseable. Should not be seen * be seen
* under normal conditions. It it is seen, this is a sign that * under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression. * <code>REGEX</code> is not a valid regular expression.
* @since 1.4 * @since 1.4
*/ */
public NetwareFTPEntryParser(FTPClientConfig config) { public NetwareFTPEntryParser(FTPClientConfig config) {
super(REGEX); super(REGEX);
configure(config); configure(config);
} }
/** /**
* Parses a line of an NetwareFTP server file listing and converts it into a * Parses a line of an NetwareFTP server file listing and converts it into a
* usable format in the form of an <code> FTPFile </code> instance. If the * usable format in the form of an <code> FTPFile </code> instance. If the
* file listing line doesn't describe a file, <code> null </code> is * file listing line doesn't describe a file, <code> null </code> is
* returned, otherwise a <code> FTPFile </code> instance representing the * returned, otherwise a <code> FTPFile </code> instance representing the
* files in the directory is returned. * files in the directory is returned.
* <p> * <p>
* Netware file permissions are in the following format: RWCEAFMS, and are explained as follows: * Netware file permissions are in the following format: RWCEAFMS, and are explained as follows:
* <ul> * <ul>
* <li><b>S</b> - Supervisor; All rights. * <li><b>S</b> - Supervisor; All rights.
* <li><b>R</b> - Read; Right to open and read or execute. * <li><b>R</b> - Read; Right to open and read or execute.
* <li><b>W</b> - Write; Right to open and modify. * <li><b>W</b> - Write; Right to open and modify.
* <li><b>C</b> - Create; Right to create; when assigned to a file, allows a deleted file to be recovered. * <li><b>C</b> - Create; Right to create; when assigned to a file, allows a deleted file to be
* <li><b>E</b> - Erase; Right to delete. * recovered.
* <li><b>M</b> - Modify; Right to rename a file and to change attributes. * <li><b>E</b> - Erase; Right to delete.
* <li><b>F</b> - File Scan; Right to see directory or file listings. * <li><b>M</b> - Modify; Right to rename a file and to change attributes.
* <li><b>A</b> - Access Control; Right to modify trustee assignments and the Inherited Rights Mask. * <li><b>F</b> - File Scan; Right to see directory or file listings.
* </ul> * <li><b>A</b> - Access Control; Right to modify trustee assignments and the Inherited Rights
* * Mask.
* See * </ul>
* <a href="http://www.novell.com/documentation/nfap10/index.html?page=/documentation/nfap10/nfaubook/data/abxraws.html"> *
* here</a> * See
* for more details * <a href="http://www.novell.com/documentation/nfap10/index.html?page=/documentation/nfap10/nfaubook/data/abxraws.html">
* * here</a>
* @param entry A line of text from the file listing * for more details
* @return An FTPFile instance corresponding to the supplied entry *
*/ * @param entry A line of text from the file listing
@Override * @return An FTPFile instance corresponding to the supplied entry
public FTPFile parseFTPEntry(String entry) { */
@Override public FTPFile parseFTPEntry(String entry) {
FTPFile f = new FTPFile();
if (matches(entry)) { FTPFile f = new FTPFile();
String dirString = group(1); if (matches(entry)) {
String attrib = group(2); String dirString = group(1);
String user = group(3); String attrib = group(2);
String size = group(4); String user = group(3);
String datestr = group(5); String size = group(4);
String name = group(9); String datestr = group(5);
String name = group(9);
try {
f.setTimestamp(super.parseTimestamp(datestr)); try {
} catch (ParseException e) { f.setTimestamp(super.parseTimestamp(datestr));
// intentionally do nothing } catch (ParseException e) {
} // intentionally do nothing
}
//is it a DIR or a file
if (dirString.trim().equals("d")) { //is it a DIR or a file
f.setType(FTPFile.DIRECTORY_TYPE); if (dirString.trim().equals("d")) {
} else // Should be "-" f.setType(FTPFile.DIRECTORY_TYPE);
{ } else // Should be "-"
f.setType(FTPFile.FILE_TYPE); {
} f.setType(FTPFile.FILE_TYPE);
}
f.setUser(user);
f.setUser(user);
//set the name
f.setName(name.trim()); //set the name
f.setName(name.trim());
//set the size
f.setSize(Long.parseLong(size.trim())); //set the size
f.setSize(Long.parseLong(size.trim()));
// Now set the permissions (or at least a subset thereof - full permissions would probably require
// subclassing FTPFile and adding extra metainformation there) // Now set the permissions (or at least a subset thereof - full permissions would probably require
if (attrib.indexOf("R") != -1) { // subclassing FTPFile and adding extra metainformation there)
f.setPermission(FTPFile.USER_ACCESS, FTPFile.READ_PERMISSION, if (attrib.indexOf("R") != -1) {
true); f.setPermission(FTPFile.USER_ACCESS, FTPFile.READ_PERMISSION, true);
} }
if (attrib.indexOf("W") != -1) { if (attrib.indexOf("W") != -1) {
f.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, f.setPermission(FTPFile.USER_ACCESS, FTPFile.WRITE_PERMISSION, true);
true); }
}
return (f);
return (f);
}
return null;
}
/**
* Defines a default configuration to be used when this class is
* instantiated without a {@link FTPClientConfig FTPClientConfig}
* parameter being specified.
* @return the default configuration for this parser.
*/
@Override
protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(FTPClientConfig.SYST_NETWARE,
DEFAULT_DATE_FORMAT, DEFAULT_RECENT_DATE_FORMAT);
} }
return null;
}
/**
* Defines a default configuration to be used when this class is
* instantiated without a {@link FTPClientConfig FTPClientConfig}
* parameter being specified.
*
* @return the default configuration for this parser.
*/
@Override protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(FTPClientConfig.SYST_NETWARE, DEFAULT_DATE_FORMAT,
DEFAULT_RECENT_DATE_FORMAT);
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp.parser; package org.apache.commons.net.ftp.parser;
import java.text.ParseException; import java.text.ParseException;
import org.apache.commons.net.ftp.FTPClientConfig; import org.apache.commons.net.ftp.FTPClientConfig;
@@ -31,116 +32,96 @@ public class OS2FTPEntryParser extends ConfigurableFTPFileEntryParserImpl
{ {
private static final String DEFAULT_DATE_FORMAT private static final String DEFAULT_DATE_FORMAT = "MM-dd-yy HH:mm"; //11-09-01 12:30
= "MM-dd-yy HH:mm"; //11-09-01 12:30 /**
/** * this is the regular expression used by this parser.
* this is the regular expression used by this parser. */
*/ private static final String REGEX = "\\s*([0-9]+)\\s*"
private static final String REGEX = + "(\\s+|[A-Z]+)\\s*"
"\\s*([0-9]+)\\s*" + "(DIR|\\s+)\\s*"
+ "(\\s+|[A-Z]+)\\s*" + "(\\S+)\\s+(\\S+)\\s+" /* date stuff */
+ "(DIR|\\s+)\\s*" + "(\\S.*)";
+ "(\\S+)\\s+(\\S+)\\s+" /* date stuff */
+ "(\\S.*)";
/** /**
* The default constructor for a OS2FTPEntryParser object. * The default constructor for a OS2FTPEntryParser object.
* *
* @throws IllegalArgumentException * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* Thrown if the regular expression is unparseable. Should not be seen * be seen
* under normal conditions. It it is seen, this is a sign that * under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression. * <code>REGEX</code> is not a valid regular expression.
*/ */
public OS2FTPEntryParser() public OS2FTPEntryParser() {
{ this(null);
this(null); }
}
/**
/** * This constructor allows the creation of an OS2FTPEntryParser object
* This constructor allows the creation of an OS2FTPEntryParser object * with something other than the default configuration.
* with something other than the default configuration. *
* * @param config The {@link FTPClientConfig configuration} object used to
* @param config The {@link FTPClientConfig configuration} object used to * configure this parser.
* configure this parser. * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* @throws IllegalArgumentException * be seen
* Thrown if the regular expression is unparseable. Should not be seen * under normal conditions. It it is seen, this is a sign that
* under normal conditions. It it is seen, this is a sign that * <code>REGEX</code> is not a valid regular expression.
* <code>REGEX</code> is not a valid regular expression. * @since 1.4
* @since 1.4 */
*/ public OS2FTPEntryParser(FTPClientConfig config) {
public OS2FTPEntryParser(FTPClientConfig config) super(REGEX);
{ configure(config);
super(REGEX); }
configure(config);
} /**
* Parses a line of an OS2 FTP server file listing and converts it into a
/** * usable format in the form of an <code> FTPFile </code> instance. If the
* Parses a line of an OS2 FTP server file listing and converts it into a * file listing line doesn't describe a file, <code> null </code> is
* usable format in the form of an <code> FTPFile </code> instance. If the * returned, otherwise a <code> FTPFile </code> instance representing the
* file listing line doesn't describe a file, <code> null </code> is * files in the directory is returned.
* returned, otherwise a <code> FTPFile </code> instance representing the *
* files in the directory is returned. * @param entry A line of text from the file listing
* * @return An FTPFile instance corresponding to the supplied entry
* @param entry A line of text from the file listing */
* @return An FTPFile instance corresponding to the supplied entry @Override public FTPFile parseFTPEntry(String entry) {
*/
@Override FTPFile f = new FTPFile();
public FTPFile parseFTPEntry(String entry) if (matches(entry)) {
{ String size = group(1);
String attrib = group(2);
FTPFile f = new FTPFile(); String dirString = group(3);
if (matches(entry)) String datestr = group(4) + " " + group(5);
{ String name = group(6);
String size = group(1); try {
String attrib = group(2); f.setTimestamp(super.parseTimestamp(datestr));
String dirString = group(3); } catch (ParseException e) {
String datestr = group(4)+" "+group(5); // intentionally do nothing
String name = group(6); }
try
{ //is it a DIR or a file
f.setTimestamp(super.parseTimestamp(datestr)); if (dirString.trim().equals("DIR") || attrib.trim().equals("DIR")) {
} f.setType(FTPFile.DIRECTORY_TYPE);
catch (ParseException e) } else {
{ f.setType(FTPFile.FILE_TYPE);
// intentionally do nothing }
}
//set the name
f.setName(name.trim());
//is it a DIR or a file
if (dirString.trim().equals("DIR") || attrib.trim().equals("DIR")) //set the size
{ f.setSize(Long.parseLong(size.trim()));
f.setType(FTPFile.DIRECTORY_TYPE);
} return (f);
else
{
f.setType(FTPFile.FILE_TYPE);
}
//set the name
f.setName(name.trim());
//set the size
f.setSize(Long.parseLong(size.trim()));
return (f);
}
return null;
}
/**
* Defines a default configuration to be used when this class is
* instantiated without a {@link FTPClientConfig FTPClientConfig}
* parameter being specified.
* @return the default configuration for this parser.
*/
@Override
protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(
FTPClientConfig.SYST_OS2,
DEFAULT_DATE_FORMAT,
null);
} }
return null;
}
/**
* Defines a default configuration to be used when this class is
* instantiated without a {@link FTPClientConfig FTPClientConfig}
* parameter being specified.
*
* @return the default configuration for this parser.
*/
@Override protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(FTPClientConfig.SYST_OS2, DEFAULT_DATE_FORMAT, null);
}
} }

View File

@@ -25,411 +25,376 @@ import org.apache.commons.net.ftp.FTPFile;
/** /**
* @version $Id: OS400FTPEntryParser.java 1752660 2016-07-14 13:25:39Z sebb $ * @version $Id: OS400FTPEntryParser.java 1752660 2016-07-14 13:25:39Z sebb $
* <pre> * <pre>
* Example *FILE/*MEM FTP entries, when the current * Example *FILE/*MEM FTP entries, when the current
* working directory is a file of file system QSYS: * working directory is a file of file system QSYS:
* ------------------------------------------------ * ------------------------------------------------
* *
* $ cwd /qsys.lib/rpgunit.lib/rpgunitc1.file * $ cwd /qsys.lib/rpgunit.lib/rpgunitc1.file
* 250-NAMEFMT set to 1. * 250-NAMEFMT set to 1.
* 250 "/QSYS.LIB/RPGUNIT.LIB/RPGUNITC1.FILE" is current directory. * 250 "/QSYS.LIB/RPGUNIT.LIB/RPGUNITC1.FILE" is current directory.
* $ dir * $ dir
* 227 Entering Passive Mode (10,200,36,33,40,249). * 227 Entering Passive Mode (10,200,36,33,40,249).
* 125 List started. * 125 List started.
* QPGMR 135168 22.06.13 13:18:19 *FILE * QPGMR 135168 22.06.13 13:18:19 *FILE
* QPGMR *MEM MKCMD.MBR * QPGMR *MEM MKCMD.MBR
* QPGMR *MEM RUCALLTST.MBR * QPGMR *MEM RUCALLTST.MBR
* QPGMR *MEM RUCMDHLP.MBR * QPGMR *MEM RUCMDHLP.MBR
* QPGMR *MEM RUCRTTST.MBR * QPGMR *MEM RUCRTTST.MBR
* 250 List completed. * 250 List completed.
* *
* *
* Example *FILE entry of an OS/400 save file: * Example *FILE entry of an OS/400 save file:
* --------------------------------------------------- * ---------------------------------------------------
* *
* $ cwd /qsys.lib/rpgunit.lib * $ cwd /qsys.lib/rpgunit.lib
* 250 "/QSYS.LIB/RPGUNIT.LIB" is current library. * 250 "/QSYS.LIB/RPGUNIT.LIB" is current library.
* $ dir rpgunit.file * $ dir rpgunit.file
* 227 Entering Passive Mode (10,200,36,33,188,106). * 227 Entering Passive Mode (10,200,36,33,188,106).
* 125 List started. * 125 List started.
* QPGMR 16347136 29.06.13 15:45:09 *FILE RPGUNIT.SAVF * QPGMR 16347136 29.06.13 15:45:09 *FILE RPGUNIT.SAVF
* 250 List completed. * 250 List completed.
* *
* *
* Example *STMF/*DIR FTP entries, when the * Example *STMF/*DIR FTP entries, when the
* current working directory is in file system "root": * current working directory is in file system "root":
* --------------------------------------------------- * ---------------------------------------------------
* *
* $ cwd /home/raddatz * $ cwd /home/raddatz
* 250 "/home/raddatz" is current directory. * 250 "/home/raddatz" is current directory.
* $ dir test* * $ dir test*
* 227 Entering Passive Mode (10,200,36,33,200,189). * 227 Entering Passive Mode (10,200,36,33,200,189).
* 125 List started. * 125 List started.
* RADDATZ 200 21.05.11 12:31:18 *STMF TEST_RG_02_CRLF.properties * RADDATZ 200 21.05.11 12:31:18 *STMF TEST_RG_02_CRLF.properties
* RADDATZ 187 08.05.11 12:31:40 *STMF TEST_RG_02_LF.properties * RADDATZ 187 08.05.11 12:31:40 *STMF TEST_RG_02_LF.properties
* RADDATZ 187 08.05.11 12:31:52 *STMF TEST_RG_02_CR.properties * RADDATZ 187 08.05.11 12:31:52 *STMF TEST_RG_02_CR.properties
* RADDATZ 8192 04.07.13 09:04:14 *DIR testDir1/ * RADDATZ 8192 04.07.13 09:04:14 *DIR testDir1/
* RADDATZ 8192 04.07.13 09:04:17 *DIR testDir2/ * RADDATZ 8192 04.07.13 09:04:17 *DIR testDir2/
* 250 List completed. * 250 List completed.
* *
* *
* Example 1, using ANT to list specific members of a file: * Example 1, using ANT to list specific members of a file:
* -------------------------------------------------------- * --------------------------------------------------------
* *
* &lt;echo/&gt; * &lt;echo/&gt;
* &lt;echo&gt;Listing members of a file:&lt;/echo&gt; * &lt;echo&gt;Listing members of a file:&lt;/echo&gt;
* *
* &lt;ftp action="list" * &lt;ftp action="list"
* server="${ftp.server}" * server="${ftp.server}"
* userid="${ftp.user}" * userid="${ftp.user}"
* password="${ftp.password}" * password="${ftp.password}"
* binary="false" * binary="false"
* verbose="true" * verbose="true"
* remotedir="/QSYS.LIB/RPGUNIT.LIB/RPGUNITY1.FILE" * remotedir="/QSYS.LIB/RPGUNIT.LIB/RPGUNITY1.FILE"
* systemTypeKey="OS/400" * systemTypeKey="OS/400"
* listing="ftp-listing.txt" * listing="ftp-listing.txt"
* &gt; * &gt;
* &lt;fileset dir="./i5-downloads-file" casesensitive="false"&gt; * &lt;fileset dir="./i5-downloads-file" casesensitive="false"&gt;
* &lt;include name="run*.mbr" /&gt; * &lt;include name="run*.mbr" /&gt;
* &lt;/fileset&gt; * &lt;/fileset&gt;
* &lt;/ftp&gt; * &lt;/ftp&gt;
* *
* Output: * Output:
* ------- * -------
* *
* [echo] Listing members of a file: * [echo] Listing members of a file:
* [ftp] listing files * [ftp] listing files
* [ftp] listing RUN.MBR * [ftp] listing RUN.MBR
* [ftp] listing RUNNER.MBR * [ftp] listing RUNNER.MBR
* [ftp] listing RUNNERBND.MBR * [ftp] listing RUNNERBND.MBR
* [ftp] 3 files listed * [ftp] 3 files listed
* *
* *
* Example 2, using ANT to list specific members of all files of a library: * Example 2, using ANT to list specific members of all files of a library:
* ------------------------------------------------------------------------ * ------------------------------------------------------------------------
* *
* &lt;echo/&gt; * &lt;echo/&gt;
* &lt;echo&gt;Listing members of all files of a library:&lt;/echo&gt; * &lt;echo&gt;Listing members of all files of a library:&lt;/echo&gt;
* *
* &lt;ftp action="list" * &lt;ftp action="list"
* server="${ftp.server}" * server="${ftp.server}"
* userid="${ftp.user}" * userid="${ftp.user}"
* password="${ftp.password}" * password="${ftp.password}"
* binary="false" * binary="false"
* verbose="true" * verbose="true"
* remotedir="/QSYS.LIB/RPGUNIT.LIB" * remotedir="/QSYS.LIB/RPGUNIT.LIB"
* systemTypeKey="OS/400" * systemTypeKey="OS/400"
* listing="ftp-listing.txt" * listing="ftp-listing.txt"
* &gt; * &gt;
* &lt;fileset dir="./i5-downloads-lib" casesensitive="false"&gt; * &lt;fileset dir="./i5-downloads-lib" casesensitive="false"&gt;
* &lt;include name="**\run*.mbr" /&gt; * &lt;include name="**\run*.mbr" /&gt;
* &lt;/fileset&gt; * &lt;/fileset&gt;
* &lt;/ftp&gt; * &lt;/ftp&gt;
* *
* Output: * Output:
* ------- * -------
* *
* [echo] Listing members of all files of a library: * [echo] Listing members of all files of a library:
* [ftp] listing files * [ftp] listing files
* [ftp] listing RPGUNIT1.FILE\RUN.MBR * [ftp] listing RPGUNIT1.FILE\RUN.MBR
* [ftp] listing RPGUNIT1.FILE\RUNRMT.MBR * [ftp] listing RPGUNIT1.FILE\RUNRMT.MBR
* [ftp] listing RPGUNITT1.FILE\RUNT.MBR * [ftp] listing RPGUNITT1.FILE\RUNT.MBR
* [ftp] listing RPGUNITY1.FILE\RUN.MBR * [ftp] listing RPGUNITY1.FILE\RUN.MBR
* [ftp] listing RPGUNITY1.FILE\RUNNER.MBR * [ftp] listing RPGUNITY1.FILE\RUNNER.MBR
* [ftp] listing RPGUNITY1.FILE\RUNNERBND.MBR * [ftp] listing RPGUNITY1.FILE\RUNNERBND.MBR
* [ftp] 6 files listed * [ftp] 6 files listed
* *
* *
* Example 3, using ANT to download specific members of a file: * Example 3, using ANT to download specific members of a file:
* ------------------------------------------------------------ * ------------------------------------------------------------
* *
* &lt;echo/&gt; * &lt;echo/&gt;
* &lt;echo&gt;Downloading members of a file:&lt;/echo&gt; * &lt;echo&gt;Downloading members of a file:&lt;/echo&gt;
* *
* &lt;ftp action="get" * &lt;ftp action="get"
* server="${ftp.server}" * server="${ftp.server}"
* userid="${ftp.user}" * userid="${ftp.user}"
* password="${ftp.password}" * password="${ftp.password}"
* binary="false" * binary="false"
* verbose="true" * verbose="true"
* remotedir="/QSYS.LIB/RPGUNIT.LIB/RPGUNITY1.FILE" * remotedir="/QSYS.LIB/RPGUNIT.LIB/RPGUNITY1.FILE"
* systemTypeKey="OS/400" * systemTypeKey="OS/400"
* &gt; * &gt;
* &lt;fileset dir="./i5-downloads-file" casesensitive="false"&gt; * &lt;fileset dir="./i5-downloads-file" casesensitive="false"&gt;
* &lt;include name="run*.mbr" /&gt; * &lt;include name="run*.mbr" /&gt;
* &lt;/fileset&gt; * &lt;/fileset&gt;
* &lt;/ftp&gt; * &lt;/ftp&gt;
* *
* Output: * Output:
* ------- * -------
* *
* [echo] Downloading members of a file: * [echo] Downloading members of a file:
* [ftp] getting files * [ftp] getting files
* [ftp] transferring RUN.MBR to C:\workspaces\rdp_080\workspace\ANT - FTP\i5-downloads-file\RUN.MBR * [ftp] transferring RUN.MBR to C:\workspaces\rdp_080\workspace\ANT -
* [ftp] transferring RUNNER.MBR to C:\workspaces\rdp_080\workspace\ANT - FTP\i5-downloads-file\RUNNER.MBR * FTP\i5-downloads-file\RUN.MBR
* [ftp] transferring RUNNERBND.MBR to C:\workspaces\rdp_080\workspace\ANT - FTP\i5-downloads-file\RUNNERBND.MBR * [ftp] transferring RUNNER.MBR to C:\workspaces\rdp_080\workspace\ANT -
* [ftp] 3 files retrieved * FTP\i5-downloads-file\RUNNER.MBR
* [ftp] transferring RUNNERBND.MBR to C:\workspaces\rdp_080\workspace\ANT -
* FTP\i5-downloads-file\RUNNERBND.MBR
* [ftp] 3 files retrieved
* *
* *
* Example 4, using ANT to download specific members of all files of a library: * Example 4, using ANT to download specific members of all files of a library:
* ---------------------------------------------------------------------------- * ----------------------------------------------------------------------------
* *
* &lt;echo/&gt; * &lt;echo/&gt;
* &lt;echo&gt;Downloading members of all files of a library:&lt;/echo&gt; * &lt;echo&gt;Downloading members of all files of a library:&lt;/echo&gt;
* *
* &lt;ftp action="get" * &lt;ftp action="get"
* server="${ftp.server}" * server="${ftp.server}"
* userid="${ftp.user}" * userid="${ftp.user}"
* password="${ftp.password}" * password="${ftp.password}"
* binary="false" * binary="false"
* verbose="true" * verbose="true"
* remotedir="/QSYS.LIB/RPGUNIT.LIB" * remotedir="/QSYS.LIB/RPGUNIT.LIB"
* systemTypeKey="OS/400" * systemTypeKey="OS/400"
* &gt; * &gt;
* &lt;fileset dir="./i5-downloads-lib" casesensitive="false"&gt; * &lt;fileset dir="./i5-downloads-lib" casesensitive="false"&gt;
* &lt;include name="**\run*.mbr" /&gt; * &lt;include name="**\run*.mbr" /&gt;
* &lt;/fileset&gt; * &lt;/fileset&gt;
* &lt;/ftp&gt; * &lt;/ftp&gt;
* *
* Output: * Output:
* ------- * -------
* *
* [echo] Downloading members of all files of a library: * [echo] Downloading members of all files of a library:
* [ftp] getting files * [ftp] getting files
* [ftp] transferring RPGUNIT1.FILE\RUN.MBR to C:\work\rdp_080\space\ANT - FTP\i5-downloads\RPGUNIT1.FILE\RUN.MBR * [ftp] transferring RPGUNIT1.FILE\RUN.MBR to C:\work\rdp_080\space\ANT -
* [ftp] transferring RPGUNIT1.FILE\RUNRMT.MBR to C:\work\rdp_080\space\ANT - FTP\i5-downloads\RPGUNIT1.FILE\RUNRMT.MBR * FTP\i5-downloads\RPGUNIT1.FILE\RUN.MBR
* [ftp] transferring RPGUNITT1.FILE\RUNT.MBR to C:\work\rdp_080\space\ANT - FTP\i5-downloads\RPGUNITT1.FILE\RUNT.MBR * [ftp] transferring RPGUNIT1.FILE\RUNRMT.MBR to C:\work\rdp_080\space\ANT -
* [ftp] transferring RPGUNITY1.FILE\RUN.MBR to C:\work\rdp_080\space\ANT - FTP\i5-downloads\RPGUNITY1.FILE\RUN.MBR * FTP\i5-downloads\RPGUNIT1.FILE\RUNRMT.MBR
* [ftp] transferring RPGUNITY1.FILE\RUNNER.MBR to C:\work\rdp_080\space\ANT - FTP\i5-downloads\RPGUNITY1.FILE\RUNNER.MBR * [ftp] transferring RPGUNITT1.FILE\RUNT.MBR to C:\work\rdp_080\space\ANT -
* [ftp] transferring RPGUNITY1.FILE\RUNNERBND.MBR to C:\work\rdp_080\space\ANT - FTP\i5-downloads\RPGUNITY1.FILE\RUNNERBND.MBR * FTP\i5-downloads\RPGUNITT1.FILE\RUNT.MBR
* [ftp] 6 files retrieved * [ftp] transferring RPGUNITY1.FILE\RUN.MBR to C:\work\rdp_080\space\ANT -
* FTP\i5-downloads\RPGUNITY1.FILE\RUN.MBR
* [ftp] transferring RPGUNITY1.FILE\RUNNER.MBR to C:\work\rdp_080\space\ANT -
* FTP\i5-downloads\RPGUNITY1.FILE\RUNNER.MBR
* [ftp] transferring RPGUNITY1.FILE\RUNNERBND.MBR to C:\work\rdp_080\space\ANT -
* FTP\i5-downloads\RPGUNITY1.FILE\RUNNERBND.MBR
* [ftp] 6 files retrieved
* *
* *
* Example 5, using ANT to download a save file of a library: * Example 5, using ANT to download a save file of a library:
* ---------------------------------------------------------- * ----------------------------------------------------------
* *
* &lt;ftp action="get" * &lt;ftp action="get"
* server="${ftp.server}" * server="${ftp.server}"
* userid="${ftp.user}" * userid="${ftp.user}"
* password="${ftp.password}" * password="${ftp.password}"
* binary="true" * binary="true"
* verbose="true" * verbose="true"
* remotedir="/QSYS.LIB/RPGUNIT.LIB" * remotedir="/QSYS.LIB/RPGUNIT.LIB"
* systemTypeKey="OS/400" * systemTypeKey="OS/400"
* &gt; * &gt;
* &lt;fileset dir="./i5-downloads-savf" casesensitive="false"&gt; * &lt;fileset dir="./i5-downloads-savf" casesensitive="false"&gt;
* &lt;include name="RPGUNIT.SAVF" /&gt; * &lt;include name="RPGUNIT.SAVF" /&gt;
* &lt;/fileset&gt; * &lt;/fileset&gt;
* &lt;/ftp&gt; * &lt;/ftp&gt;
* *
* Output: * Output:
* ------- * -------
* [echo] Downloading save file: * [echo] Downloading save file:
* [ftp] getting files * [ftp] getting files
* [ftp] transferring RPGUNIT.SAVF to C:\workspaces\rdp_080\workspace\net-Test\i5-downloads-lib\RPGUNIT.SAVF * [ftp] transferring RPGUNIT.SAVF to C:\workspaces\rdp_080\workspace\net-Test\i5-downloads-lib\RPGUNIT.SAVF
* [ftp] 1 files retrieved * [ftp] 1 files retrieved
* *
* </pre> * </pre>
*/ */
public class OS400FTPEntryParser extends ConfigurableFTPFileEntryParserImpl public class OS400FTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
{ private static final String DEFAULT_DATE_FORMAT = "yy/MM/dd HH:mm:ss"; //01/11/09 12:30:24
private static final String DEFAULT_DATE_FORMAT
= "yy/MM/dd HH:mm:ss"; //01/11/09 12:30:24
private static final String REGEX = "(\\S+)\\s+" // user
+ "(?:(\\d+)\\s+)?" // size, empty for members
+ "(?:(\\S+)\\s+(\\S+)\\s+)?" // date stuff, empty for members
+ "(\\*STMF|\\*DIR|\\*FILE|\\*MEM)\\s+" // *STMF/*DIR/*FILE/*MEM
+ "(?:(\\S+)\\s*)?"; // filename, missing, when CWD is a *FILE
/**
* The default constructor for a OS400FTPEntryParser object.
*
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
*/
public OS400FTPEntryParser() {
this(null);
}
private static final String REGEX = /**
"(\\S+)\\s+" // user * This constructor allows the creation of an OS400FTPEntryParser object
+ "(?:(\\d+)\\s+)?" // size, empty for members * with something other than the default configuration.
+ "(?:(\\S+)\\s+(\\S+)\\s+)?" // date stuff, empty for members *
+ "(\\*STMF|\\*DIR|\\*FILE|\\*MEM)\\s+" // *STMF/*DIR/*FILE/*MEM * @param config The {@link FTPClientConfig configuration} object used to
+ "(?:(\\S+)\\s*)?"; // filename, missing, when CWD is a *FILE * configure this parser.
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
* @since 1.4
*/
public OS400FTPEntryParser(FTPClientConfig config) {
super(REGEX);
configure(config);
}
@Override public FTPFile parseFTPEntry(String entry) {
/** FTPFile file = new FTPFile();
* The default constructor for a OS400FTPEntryParser object. file.setRawListing(entry);
* int type;
* @throws IllegalArgumentException
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
*/
public OS400FTPEntryParser()
{
this(null);
}
/** if (matches(entry)) {
* This constructor allows the creation of an OS400FTPEntryParser object String usr = group(1);
* with something other than the default configuration. String filesize = group(2);
* String datestr = "";
* @param config The {@link FTPClientConfig configuration} object used to if (!isNullOrEmpty(group(3)) || !isNullOrEmpty(group(4))) {
* configure this parser. datestr = group(3) + " " + group(4);
* @throws IllegalArgumentException }
* Thrown if the regular expression is unparseable. Should not be seen String typeStr = group(5);
* under normal conditions. It it is seen, this is a sign that String name = group(6);
* <code>REGEX</code> is not a valid regular expression.
* @since 1.4
*/
public OS400FTPEntryParser(FTPClientConfig config)
{
super(REGEX);
configure(config);
}
boolean mustScanForPathSeparator = true;
@Override try {
public FTPFile parseFTPEntry(String entry) file.setTimestamp(super.parseTimestamp(datestr));
{ } catch (ParseException e) {
// intentionally do nothing
}
FTPFile file = new FTPFile(); if (typeStr.equalsIgnoreCase("*STMF")) {
file.setRawListing(entry); type = FTPFile.FILE_TYPE;
int type; if (isNullOrEmpty(filesize) || isNullOrEmpty(name)) {
return null;
if (matches(entry))
{
String usr = group(1);
String filesize = group(2);
String datestr = "";
if (!isNullOrEmpty(group(3)) || !isNullOrEmpty(group(4)))
{
datestr = group(3)+" "+group(4);
}
String typeStr = group(5);
String name = group(6);
boolean mustScanForPathSeparator = true;
try
{
file.setTimestamp(super.parseTimestamp(datestr));
}
catch (ParseException e)
{
// intentionally do nothing
}
if (typeStr.equalsIgnoreCase("*STMF"))
{
type = FTPFile.FILE_TYPE;
if (isNullOrEmpty(filesize) || isNullOrEmpty(name))
{
return null;
}
}
else if (typeStr.equalsIgnoreCase("*DIR"))
{
type = FTPFile.DIRECTORY_TYPE;
if (isNullOrEmpty(filesize) || isNullOrEmpty(name))
{
return null;
}
}
else if (typeStr.equalsIgnoreCase("*FILE"))
{
// File, defines the structure of the data (columns of a row)
// but the data is stored in one or more members. Typically a
// source file contains multiple members whereas it is
// recommended (but not enforced) to use one member per data
// file.
// Save files are a special type of files which are used
// to save objects, e.g. for backups.
if (name != null && name.toUpperCase().endsWith(".SAVF"))
{
mustScanForPathSeparator = false;
type = FTPFile.FILE_TYPE;
}
else
{
return null;
}
}
else if (typeStr.equalsIgnoreCase("*MEM"))
{
mustScanForPathSeparator = false;
type = FTPFile.FILE_TYPE;
if (isNullOrEmpty(name))
{
return null;
}
if (!(isNullOrEmpty(filesize) && isNullOrEmpty(datestr)))
{
return null;
}
// Quick and dirty bug fix to make SelectorUtils work.
// Class SelectorUtils uses 'File.separator' to splitt
// a given path into pieces. But actually it had to
// use the separator of the FTP server, which is a forward
// slash in case of an AS/400.
name = name.replace('/', File.separatorChar);
}
else
{
type = FTPFile.UNKNOWN_TYPE;
}
file.setType(type);
file.setUser(usr);
try
{
file.setSize(Long.parseLong(filesize));
}
catch (NumberFormatException e)
{
// intentionally do nothing
}
if (name.endsWith("/"))
{
name = name.substring(0, name.length() - 1);
}
if (mustScanForPathSeparator)
{
int pos = name.lastIndexOf('/');
if (pos > -1)
{
name = name.substring(pos + 1);
}
}
file.setName(name);
return file;
} }
return null; } else if (typeStr.equalsIgnoreCase("*DIR")) {
} type = FTPFile.DIRECTORY_TYPE;
if (isNullOrEmpty(filesize) || isNullOrEmpty(name)) {
/** return null;
*
* @param string String value that is checked for <code>null</code>
* or empty.
* @return <code>true</code> for <code>null</code> or empty values,
* else <code>false</code>.
*/
private boolean isNullOrEmpty(String string) {
if (string == null || string.length() == 0) {
return true;
} }
return false; } else if (typeStr.equalsIgnoreCase("*FILE")) {
} // File, defines the structure of the data (columns of a row)
// but the data is stored in one or more members. Typically a
// source file contains multiple members whereas it is
// recommended (but not enforced) to use one member per data
// file.
// Save files are a special type of files which are used
// to save objects, e.g. for backups.
if (name != null && name.toUpperCase().endsWith(".SAVF")) {
mustScanForPathSeparator = false;
type = FTPFile.FILE_TYPE;
} else {
return null;
}
} else if (typeStr.equalsIgnoreCase("*MEM")) {
mustScanForPathSeparator = false;
type = FTPFile.FILE_TYPE;
/** if (isNullOrEmpty(name)) {
* Defines a default configuration to be used when this class is return null;
* instantiated without a {@link FTPClientConfig FTPClientConfig} }
* parameter being specified. if (!(isNullOrEmpty(filesize) && isNullOrEmpty(datestr))) {
* @return the default configuration for this parser. return null;
*/ }
@Override
protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(
FTPClientConfig.SYST_OS400,
DEFAULT_DATE_FORMAT,
null);
}
// Quick and dirty bug fix to make SelectorUtils work.
// Class SelectorUtils uses 'File.separator' to splitt
// a given path into pieces. But actually it had to
// use the separator of the FTP server, which is a forward
// slash in case of an AS/400.
name = name.replace('/', File.separatorChar);
} else {
type = FTPFile.UNKNOWN_TYPE;
}
file.setType(type);
file.setUser(usr);
try {
file.setSize(Long.parseLong(filesize));
} catch (NumberFormatException e) {
// intentionally do nothing
}
if (name.endsWith("/")) {
name = name.substring(0, name.length() - 1);
}
if (mustScanForPathSeparator) {
int pos = name.lastIndexOf('/');
if (pos > -1) {
name = name.substring(pos + 1);
}
}
file.setName(name);
return file;
}
return null;
}
/**
* @param string String value that is checked for <code>null</code>
* or empty.
* @return <code>true</code> for <code>null</code> or empty values,
* else <code>false</code>.
*/
private boolean isNullOrEmpty(String string) {
if (string == null || string.length() == 0) {
return true;
}
return false;
}
/**
* Defines a default configuration to be used when this class is
* instantiated without a {@link FTPClientConfig FTPClientConfig}
* parameter being specified.
*
* @return the default configuration for this parser.
*/
@Override protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(FTPClientConfig.SYST_OS400, DEFAULT_DATE_FORMAT, null);
}
} }

View File

@@ -24,39 +24,37 @@ package org.apache.commons.net.ftp.parser;
*/ */
public class ParserInitializationException extends RuntimeException { public class ParserInitializationException extends RuntimeException {
private static final long serialVersionUID = 5563335279583210658L; private static final long serialVersionUID = 5563335279583210658L;
/** /**
* Constucts a ParserInitializationException with just a message * Constucts a ParserInitializationException with just a message
* *
* @param message Exception message * @param message Exception message
*/ */
public ParserInitializationException(String message) { public ParserInitializationException(String message) {
super(message); super(message);
} }
/** /**
* Constucts a ParserInitializationException with a message * Constucts a ParserInitializationException with a message
* and a root cause. * and a root cause.
* *
* @param message Exception message * @param message Exception message
* @param rootCause root cause throwable that caused * @param rootCause root cause throwable that caused
* this to be thrown * this to be thrown
*/ */
public ParserInitializationException(String message, Throwable rootCause) { public ParserInitializationException(String message, Throwable rootCause) {
super(message, rootCause); super(message, rootCause);
} }
/**
* returns the root cause of this exception or null
* if no root cause was specified.
*
* @return the root cause of this exception being thrown
* @deprecated use {@link #getCause()} instead
*/
@Deprecated
public Throwable getRootCause() {
return super.getCause();
}
/**
* returns the root cause of this exception or null
* if no root cause was specified.
*
* @return the root cause of this exception being thrown
* @deprecated use {@link #getCause()} instead
*/
@Deprecated public Throwable getRootCause() {
return super.getCause();
}
} }

View File

@@ -15,7 +15,6 @@
* limitations under the License. * limitations under the License.
*/ */
package org.apache.commons.net.ftp.parser; package org.apache.commons.net.ftp.parser;
import java.util.regex.MatchResult; import java.util.regex.MatchResult;
@@ -32,171 +31,170 @@ import org.apache.commons.net.ftp.FTPFileEntryParserImpl;
* *
* This is the base class for all regular expression based FTPFileEntryParser classes * This is the base class for all regular expression based FTPFileEntryParser classes
*/ */
public abstract class RegexFTPFileEntryParserImpl extends public abstract class RegexFTPFileEntryParserImpl extends FTPFileEntryParserImpl {
FTPFileEntryParserImpl { /**
/** * internal pattern the matcher tries to match, representing a file
* internal pattern the matcher tries to match, representing a file * entry
* entry */
*/ private Pattern pattern = null;
private Pattern pattern = null;
/** /**
* internal match result used by the parser * internal match result used by the parser
*/ */
private MatchResult result = null; private MatchResult result = null;
/** /**
* Internal PatternMatcher object used by the parser. It has protected * Internal PatternMatcher object used by the parser. It has protected
* scope in case subclasses want to make use of it for their own purposes. * scope in case subclasses want to make use of it for their own purposes.
*/ */
protected Matcher _matcher_ = null; protected Matcher _matcher_ = null;
/** /**
* The constructor for a RegexFTPFileEntryParserImpl object. * The constructor for a RegexFTPFileEntryParserImpl object.
* The expression is compiled with flags = 0. * The expression is compiled with flags = 0.
* *
* @param regex The regular expression with which this object is * @param regex The regular expression with which this object is
* initialized. * initialized.
* * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* @throws IllegalArgumentException * be seen in
* Thrown if the regular expression is unparseable. Should not be seen in * normal conditions. It it is seen, this is a sign that a subclass has
* normal conditions. It it is seen, this is a sign that a subclass has * been created with a bad regular expression. Since the parser must be
* been created with a bad regular expression. Since the parser must be * created before use, this means that any bad parser subclasses created
* created before use, this means that any bad parser subclasses created * from this will bomb very quickly, leading to easy detection.
* from this will bomb very quickly, leading to easy detection. */
*/
public RegexFTPFileEntryParserImpl(String regex) { public RegexFTPFileEntryParserImpl(String regex) {
super(); super();
compileRegex(regex, 0); compileRegex(regex, 0);
}
/**
* The constructor for a RegexFTPFileEntryParserImpl object.
*
* @param regex The regular expression with which this object is
* initialized.
* @param flags the flags to apply, see {@link Pattern#compile(String, int)}. Use 0 for none.
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* be seen in
* normal conditions. It it is seen, this is a sign that a subclass has
* been created with a bad regular expression. Since the parser must be
* created before use, this means that any bad parser subclasses created
* from this will bomb very quickly, leading to easy detection.
* @since 3.4
*/
public RegexFTPFileEntryParserImpl(String regex, final int flags) {
super();
compileRegex(regex, flags);
}
/**
* Convenience method delegates to the internal MatchResult's matches()
* method.
*
* @param s the String to be matched
* @return true if s matches this object's regular expression.
*/
public boolean matches(String s) {
this.result = null;
_matcher_ = pattern.matcher(s);
if (_matcher_.matches()) {
this.result = _matcher_.toMatchResult();
} }
return null != this.result;
}
/** /**
* The constructor for a RegexFTPFileEntryParserImpl object. * Convenience method
* *
* @param regex The regular expression with which this object is * @return the number of groups() in the internal MatchResult.
* initialized. */
* @param flags the flags to apply, see {@link Pattern#compile(String, int)}. Use 0 for none.
* public int getGroupCnt() {
* @throws IllegalArgumentException if (this.result == null) {
* Thrown if the regular expression is unparseable. Should not be seen in return 0;
* normal conditions. It it is seen, this is a sign that a subclass has
* been created with a bad regular expression. Since the parser must be
* created before use, this means that any bad parser subclasses created
* from this will bomb very quickly, leading to easy detection.
* @since 3.4
*/
public RegexFTPFileEntryParserImpl(String regex, final int flags) {
super();
compileRegex(regex, flags);
} }
return this.result.groupCount();
}
/** /**
* Convenience method delegates to the internal MatchResult's matches() * Convenience method delegates to the internal MatchResult's group()
* method. * method.
* *
* @param s the String to be matched * @param matchnum match group number to be retrieved
* @return true if s matches this object's regular expression. * @return the content of the <code>matchnum'th</code> group of the internal
*/ * match or null if this method is called without a match having
* been made.
public boolean matches(String s) { */
this.result = null; public String group(int matchnum) {
_matcher_ = pattern.matcher(s); if (this.result == null) {
if (_matcher_.matches()) { return null;
this.result = _matcher_.toMatchResult();
}
return null != this.result;
} }
return this.result.group(matchnum);
}
/** /**
* Convenience method * For debugging purposes - returns a string shows each match group by
* * number.
* @return the number of groups() in the internal MatchResult. *
*/ * @return a string shows each match group by number.
*/
public int getGroupCnt() { public String getGroupsAsString() {
if (this.result == null) { StringBuilder b = new StringBuilder();
return 0; for (int i = 1; i <= this.result.groupCount(); i++) {
} b.append(i)
return this.result.groupCount(); .append(") ")
.append(this.result.group(i))
.append(System.getProperty("line.separator"));
} }
return b.toString();
}
/** /**
* Convenience method delegates to the internal MatchResult's group() * Alter the current regular expression being utilised for entry parsing
* method. * and create a new {@link Pattern} instance.
* *
* @param matchnum match group number to be retrieved * @param regex The new regular expression
* * @return true
* @return the content of the <code>matchnum'th</code> group of the internal * @throws IllegalArgumentException if the regex cannot be compiled
* match or null if this method is called without a match having * @since 2.0
* been made. */
*/ public boolean setRegex(final String regex) {
public String group(int matchnum) { compileRegex(regex, 0);
if (this.result == null) { return true;
return null; }
}
return this.result.group(matchnum); /**
} * Alter the current regular expression being utilised for entry parsing
* and create a new {@link Pattern} instance.
/** *
* For debugging purposes - returns a string shows each match group by * @param regex The new regular expression
* number. * @param flags the flags to apply, see {@link Pattern#compile(String, int)}. Use 0 for none.
* * @return true
* @return a string shows each match group by number. * @throws IllegalArgumentException if the regex cannot be compiled
*/ * @since 3.4
*/
public String getGroupsAsString() { public boolean setRegex(final String regex, final int flags) {
StringBuilder b = new StringBuilder(); compileRegex(regex, flags);
for (int i = 1; i <= this.result.groupCount(); i++) { return true;
b.append(i).append(") ").append(this.result.group(i)).append( }
System.getProperty("line.separator"));
} /**
return b.toString(); * Compile the regex and store the {@link Pattern}.
} *
* This is an internal method to do the work so the constructor does not
/** * have to call an overrideable method.
* Alter the current regular expression being utilised for entry parsing *
* and create a new {@link Pattern} instance. * @param regex the expression to compile
* @param regex The new regular expression * @param flags the flags to apply, see {@link Pattern#compile(String, int)}. Use 0 for none.
* @return true * @throws IllegalArgumentException if the regex cannot be compiled
* @since 2.0 */
* @throws IllegalArgumentException if the regex cannot be compiled private void compileRegex(final String regex, final int flags) {
*/ try {
public boolean setRegex(final String regex) { pattern = Pattern.compile(regex, flags);
compileRegex(regex, 0); } catch (PatternSyntaxException pse) {
return true; throw new IllegalArgumentException("Unparseable regex supplied: " + regex);
}
/**
* Alter the current regular expression being utilised for entry parsing
* and create a new {@link Pattern} instance.
* @param regex The new regular expression
* @param flags the flags to apply, see {@link Pattern#compile(String, int)}. Use 0 for none.
* @return true
* @since 3.4
* @throws IllegalArgumentException if the regex cannot be compiled
*/
public boolean setRegex(final String regex, final int flags) {
compileRegex(regex, flags);
return true;
}
/**
* Compile the regex and store the {@link Pattern}.
*
* This is an internal method to do the work so the constructor does not
* have to call an overrideable method.
*
* @param regex the expression to compile
* @param flags the flags to apply, see {@link Pattern#compile(String, int)}. Use 0 for none.
* @throws IllegalArgumentException if the regex cannot be compiled
*/
private void compileRegex(final String regex, final int flags) {
try {
pattern = Pattern.compile(regex, flags);
} catch (PatternSyntaxException pse) {
throw new IllegalArgumentException("Unparseable regex supplied: " + regex);
}
} }
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp.parser; package org.apache.commons.net.ftp.parser;
import java.text.ParseException; import java.text.ParseException;
import java.util.List; import java.util.List;
import java.util.ListIterator; import java.util.ListIterator;
@@ -30,90 +31,83 @@ import org.apache.commons.net.ftp.FTPFile;
* This class is based on the logic of Daniel Savarese's * This class is based on the logic of Daniel Savarese's
* DefaultFTPListParser, but adapted to use regular expressions and to fit the * DefaultFTPListParser, but adapted to use regular expressions and to fit the
* new FTPFileEntryParser interface. * new FTPFileEntryParser interface.
*
* @version $Id: UnixFTPEntryParser.java 1781925 2017-02-06 16:43:40Z sebb $ * @version $Id: UnixFTPEntryParser.java 1781925 2017-02-06 16:43:40Z sebb $
* @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions) * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
*/ */
public class UnixFTPEntryParser extends ConfigurableFTPFileEntryParserImpl public class UnixFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
{
static final String DEFAULT_DATE_FORMAT static final String DEFAULT_DATE_FORMAT = "MMM d yyyy"; //Nov 9 2001
= "MMM d yyyy"; //Nov 9 2001
static final String DEFAULT_RECENT_DATE_FORMAT static final String DEFAULT_RECENT_DATE_FORMAT = "MMM d HH:mm"; //Nov 9 20:06
= "MMM d HH:mm"; //Nov 9 20:06
static final String NUMERIC_DATE_FORMAT static final String NUMERIC_DATE_FORMAT = "yyyy-MM-dd HH:mm"; //2001-11-09 20:06
= "yyyy-MM-dd HH:mm"; //2001-11-09 20:06
// Suffixes used in Japanese listings after the numeric values // Suffixes used in Japanese listings after the numeric values
private static final String JA_MONTH = "\u6708"; private static final String JA_MONTH = "\u6708";
private static final String JA_DAY = "\u65e5"; private static final String JA_DAY = "\u65e5";
private static final String JA_YEAR = "\u5e74"; private static final String JA_YEAR = "\u5e74";
private static final String DEFAULT_DATE_FORMAT_JA private static final String DEFAULT_DATE_FORMAT_JA =
= "M'" + JA_MONTH + "' d'" + JA_DAY + "' yyyy'" + JA_YEAR + "'"; //6月 3日 2003年 "M'" + JA_MONTH + "' d'" + JA_DAY + "' yyyy'" + JA_YEAR + "'"; //6月 3日 2003年
private static final String DEFAULT_RECENT_DATE_FORMAT_JA private static final String DEFAULT_RECENT_DATE_FORMAT_JA =
= "M'" + JA_MONTH + "' d'" + JA_DAY + "' HH:mm"; //8月 17日 20:10 "M'" + JA_MONTH + "' d'" + JA_DAY + "' HH:mm"; //8月 17日 20:10
/** /**
* Some Linux distributions are now shipping an FTP server which formats * Some Linux distributions are now shipping an FTP server which formats
* file listing dates in an all-numeric format: * file listing dates in an all-numeric format:
* <code>"yyyy-MM-dd HH:mm</code>. * <code>"yyyy-MM-dd HH:mm</code>.
* This is a very welcome development, and hopefully it will soon become * This is a very welcome development, and hopefully it will soon become
* the standard. However, since it is so new, for now, and possibly * the standard. However, since it is so new, for now, and possibly
* forever, we merely accomodate it, but do not make it the default. * forever, we merely accomodate it, but do not make it the default.
* <p> * <p>
* For now end users may specify this format only via * For now end users may specify this format only via
* <code>UnixFTPEntryParser(FTPClientConfig)</code>. * <code>UnixFTPEntryParser(FTPClientConfig)</code>.
* Steve Cohen - 2005-04-17 * Steve Cohen - 2005-04-17
*/ */
public static final FTPClientConfig NUMERIC_DATE_CONFIG = public static final FTPClientConfig NUMERIC_DATE_CONFIG =
new FTPClientConfig( new FTPClientConfig(FTPClientConfig.SYST_UNIX, NUMERIC_DATE_FORMAT, null);
FTPClientConfig.SYST_UNIX,
NUMERIC_DATE_FORMAT,
null);
/** /**
* this is the regular expression used by this parser. * this is the regular expression used by this parser.
* *
* Permissions: * Permissions:
* r the file is readable * r the file is readable
* w the file is writable * w the file is writable
* x the file is executable * x the file is executable
* - the indicated permission is not granted * - the indicated permission is not granted
* L mandatory locking occurs during access (the set-group-ID bit is * L mandatory locking occurs during access (the set-group-ID bit is
* on and the group execution bit is off) * on and the group execution bit is off)
* s the set-user-ID or set-group-ID bit is on, and the corresponding * s the set-user-ID or set-group-ID bit is on, and the corresponding
* user or group execution bit is also on * user or group execution bit is also on
* S undefined bit-state (the set-user-ID bit is on and the user * S undefined bit-state (the set-user-ID bit is on and the user
* execution bit is off) * execution bit is off)
* t the 1000 (octal) bit, or sticky bit, is on [see chmod(1)], and * t the 1000 (octal) bit, or sticky bit, is on [see chmod(1)], and
* execution is on * execution is on
* T the 1000 bit is turned on, and execution is off (undefined bit- * T the 1000 bit is turned on, and execution is off (undefined bit-
* state) * state)
* e z/OS external link bit * e z/OS external link bit
* Final letter may be appended: * Final letter may be appended:
* + file has extended security attributes (e.g. ACL) * + file has extended security attributes (e.g. ACL)
* Note: local listings on MacOSX also use '@'; * Note: local listings on MacOSX also use '@';
* this is not allowed for here as does not appear to be shown by FTP servers * this is not allowed for here as does not appear to be shown by FTP servers
* {@code @} file has extended attributes * {@code @} file has extended attributes
*/ */
private static final String REGEX = private static final String REGEX = "([bcdelfmpSs-])" // file type
"([bcdelfmpSs-])" // file type + "(((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-])))\\+?" // permissions
+"(((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-]))((r|-)(w|-)([xsStTL-])))\\+?" // permissions
+ "\\s*" // separator TODO why allow it to be omitted?? + "\\s*" // separator TODO why allow it to be omitted??
+ "(\\d+)" // link count + "(\\d+)" // link count
+ "\\s+" // separator + "\\s+" // separator
+ "(?:(\\S+(?:\\s\\S+)*?)\\s+)?" // owner name (optional spaces) + "(?:(\\S+(?:\\s\\S+)*?)\\s+)?" // owner name (optional spaces)
+ "(?:(\\S+(?:\\s\\S+)*)\\s+)?" // group name (optional spaces) + "(?:(\\S+(?:\\s\\S+)*)\\s+)?" // group name (optional spaces)
+ "(\\d+(?:,\\s*\\d+)?)" // size or n,m + "(\\d+(?:,\\s*\\d+)?)" // size or n,m
+ "\\s+" // separator + "\\s+" // separator
/* /*
* numeric or standard format date: * numeric or standard format date:
@@ -124,256 +118,218 @@ public class UnixFTPEntryParser extends ConfigurableFTPFileEntryParserImpl
* diacritics (e.g. umlaut) in some abbreviations. * diacritics (e.g. umlaut) in some abbreviations.
* Japanese uses numeric day and month with suffixes to distinguish them * Japanese uses numeric day and month with suffixes to distinguish them
* [d]dXX [d]dZZ * [d]dXX [d]dZZ
*/ */ + "(" + "(?:\\d+[-/]\\d+[-/]\\d+)" + // yyyy-mm-dd
+ "("+ "|(?:\\S{3}\\s+\\d{1,2})" + // MMM [d]d
"(?:\\d+[-/]\\d+[-/]\\d+)" + // yyyy-mm-dd "|(?:\\d{1,2}\\s+\\S{3})" + // [d]d MMM
"|(?:\\S{3}\\s+\\d{1,2})" + // MMM [d]d "|(?:\\d{1,2}" + JA_MONTH + "\\s+\\d{1,2}" + JA_DAY + ")" + ")"
"|(?:\\d{1,2}\\s+\\S{3})" + // [d]d MMM
"|(?:\\d{1,2}" + JA_MONTH + "\\s+\\d{1,2}" + JA_DAY + ")"+
")"
+ "\\s+" // separator + "\\s+" // separator
/* /*
year (for non-recent standard format) - yyyy year (for non-recent standard format) - yyyy
or time (for numeric or recent standard format) [h]h:mm or time (for numeric or recent standard format) [h]h:mm
or Japanese year - yyyyXX or Japanese year - yyyyXX
*/ */ + "((?:\\d+(?::\\d+)?)|(?:\\d{4}" + JA_YEAR + "))" // (20)
+ "((?:\\d+(?::\\d+)?)|(?:\\d{4}" + JA_YEAR + "))" // (20)
+ "\\s" // separator + "\\s" // separator
+ "(.*)"; // the rest (21) + "(.*)"; // the rest (21)
// if true, leading spaces are trimmed from file names
// this was the case for the original implementation
final boolean trimLeadingSpaces; // package protected for access from test code
// if true, leading spaces are trimmed from file names /**
// this was the case for the original implementation * The default constructor for a UnixFTPEntryParser object.
final boolean trimLeadingSpaces; // package protected for access from test code *
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
*/
public UnixFTPEntryParser() {
this(null);
}
/** /**
* The default constructor for a UnixFTPEntryParser object. * This constructor allows the creation of a UnixFTPEntryParser object with
* * something other than the default configuration.
* @throws IllegalArgumentException *
* Thrown if the regular expression is unparseable. Should not be seen * @param config The {@link FTPClientConfig configuration} object used to
* under normal conditions. It it is seen, this is a sign that * configure this parser.
* <code>REGEX</code> is not a valid regular expression. * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
*/ * be seen
public UnixFTPEntryParser() * under normal conditions. It it is seen, this is a sign that
{ * <code>REGEX</code> is not a valid regular expression.
this(null); * @since 1.4
*/
public UnixFTPEntryParser(FTPClientConfig config) {
this(config, false);
}
/**
* This constructor allows the creation of a UnixFTPEntryParser object with
* something other than the default configuration.
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
* @param trimLeadingSpaces if {@code true}, trim leading spaces from file names
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
* @since 3.4
*/
public UnixFTPEntryParser(FTPClientConfig config, boolean trimLeadingSpaces) {
super(REGEX);
configure(config);
this.trimLeadingSpaces = trimLeadingSpaces;
}
/**
* Preparse the list to discard "total nnn" lines
*/
@Override public List<String> preParse(List<String> original) {
ListIterator<String> iter = original.listIterator();
while (iter.hasNext()) {
String entry = iter.next();
if (entry.matches("^total \\d+$")) { // NET-389
iter.remove();
}
} }
return original;
}
/** /**
* This constructor allows the creation of a UnixFTPEntryParser object with * Parses a line of a unix (standard) FTP server file listing and converts
* something other than the default configuration. * it into a usable format in the form of an <code> FTPFile </code>
* * instance. If the file listing line doesn't describe a file,
* @param config The {@link FTPClientConfig configuration} object used to * <code> null </code> is returned, otherwise a <code> FTPFile </code>
* configure this parser. * instance representing the files in the directory is returned.
* @throws IllegalArgumentException *
* Thrown if the regular expression is unparseable. Should not be seen * @param entry A line of text from the file listing
* under normal conditions. It it is seen, this is a sign that * @return An FTPFile instance corresponding to the supplied entry
* <code>REGEX</code> is not a valid regular expression. */
* @since 1.4 @Override public FTPFile parseFTPEntry(String entry) {
*/ FTPFile file = new FTPFile();
public UnixFTPEntryParser(FTPClientConfig config) file.setRawListing(entry);
{ int type;
this(config, false); boolean isDevice = false;
}
/** if (matches(entry)) {
* This constructor allows the creation of a UnixFTPEntryParser object with String typeStr = group(1);
* something other than the default configuration. String hardLinkCount = group(15);
* String usr = group(16);
* @param config The {@link FTPClientConfig configuration} object used to String grp = group(17);
* configure this parser. String filesize = group(18);
* @param trimLeadingSpaces if {@code true}, trim leading spaces from file names String datestr = group(19) + " " + group(20);
* @throws IllegalArgumentException String name = group(21);
* Thrown if the regular expression is unparseable. Should not be seen if (trimLeadingSpaces) {
* under normal conditions. It it is seen, this is a sign that name = name.replaceFirst("^\\s+", "");
* <code>REGEX</code> is not a valid regular expression. }
* @since 3.4
*/
public UnixFTPEntryParser(FTPClientConfig config, boolean trimLeadingSpaces)
{
super(REGEX);
configure(config);
this.trimLeadingSpaces = trimLeadingSpaces;
}
/** try {
* Preparse the list to discard "total nnn" lines if (group(19).contains(JA_MONTH)) { // special processing for Japanese format
*/ FTPTimestampParserImpl jaParser = new FTPTimestampParserImpl();
@Override jaParser.configure(new FTPClientConfig(FTPClientConfig.SYST_UNIX, DEFAULT_DATE_FORMAT_JA,
public List<String> preParse(List<String> original) { DEFAULT_RECENT_DATE_FORMAT_JA));
ListIterator<String> iter = original.listIterator(); file.setTimestamp(jaParser.parseTimestamp(datestr));
while (iter.hasNext()) { } else {
String entry = iter.next(); file.setTimestamp(super.parseTimestamp(datestr));
if (entry.matches("^total \\d+$")) { // NET-389
iter.remove();
}
} }
return original; } catch (ParseException e) {
} // intentionally do nothing
}
/** // A 'whiteout' file is an ARTIFICIAL entry in any of several types of
* Parses a line of a unix (standard) FTP server file listing and converts // 'translucent' filesystems, of which a 'union' filesystem is one.
* it into a usable format in the form of an <code> FTPFile </code>
* instance. If the file listing line doesn't describe a file,
* <code> null </code> is returned, otherwise a <code> FTPFile </code>
* instance representing the files in the directory is returned.
*
* @param entry A line of text from the file listing
* @return An FTPFile instance corresponding to the supplied entry
*/
@Override
public FTPFile parseFTPEntry(String entry) {
FTPFile file = new FTPFile();
file.setRawListing(entry);
int type;
boolean isDevice = false;
if (matches(entry)) // bcdelfmpSs-
{ switch (typeStr.charAt(0)) {
String typeStr = group(1); case 'd':
String hardLinkCount = group(15); type = FTPFile.DIRECTORY_TYPE;
String usr = group(16); break;
String grp = group(17); case 'e': // NET-39 => z/OS external link
String filesize = group(18); type = FTPFile.SYMBOLIC_LINK_TYPE;
String datestr = group(19) + " " + group(20); break;
String name = group(21); case 'l':
if (trimLeadingSpaces) { type = FTPFile.SYMBOLIC_LINK_TYPE;
name = name.replaceFirst("^\\s+", ""); break;
} case 'b':
case 'c':
isDevice = true;
type = FTPFile.FILE_TYPE; // TODO change this if DEVICE_TYPE implemented
break;
case 'f':
case '-':
type = FTPFile.FILE_TYPE;
break;
default: // e.g. ? and w = whiteout
type = FTPFile.UNKNOWN_TYPE;
}
try file.setType(type);
{
if (group(19).contains(JA_MONTH)) { // special processing for Japanese format
FTPTimestampParserImpl jaParser = new FTPTimestampParserImpl();
jaParser.configure(new FTPClientConfig(
FTPClientConfig.SYST_UNIX, DEFAULT_DATE_FORMAT_JA, DEFAULT_RECENT_DATE_FORMAT_JA));
file.setTimestamp(jaParser.parseTimestamp(datestr));
} else {
file.setTimestamp(super.parseTimestamp(datestr));
}
}
catch (ParseException e)
{
// intentionally do nothing
}
// A 'whiteout' file is an ARTIFICIAL entry in any of several types of int g = 4;
// 'translucent' filesystems, of which a 'union' filesystem is one. for (int access = 0; access < 3; access++, g += 4) {
// Use != '-' to avoid having to check for suid and sticky bits
file.setPermission(access, FTPFile.READ_PERMISSION, (!group(g).equals("-")));
file.setPermission(access, FTPFile.WRITE_PERMISSION, (!group(g + 1).equals("-")));
// bcdelfmpSs- String execPerm = group(g + 2);
switch (typeStr.charAt(0)) if (!execPerm.equals("-") && !Character.isUpperCase(execPerm.charAt(0))) {
{ file.setPermission(access, FTPFile.EXECUTE_PERMISSION, true);
case 'd': } else {
type = FTPFile.DIRECTORY_TYPE; file.setPermission(access, FTPFile.EXECUTE_PERMISSION, false);
break;
case 'e': // NET-39 => z/OS external link
type = FTPFile.SYMBOLIC_LINK_TYPE;
break;
case 'l':
type = FTPFile.SYMBOLIC_LINK_TYPE;
break;
case 'b':
case 'c':
isDevice = true;
type = FTPFile.FILE_TYPE; // TODO change this if DEVICE_TYPE implemented
break;
case 'f':
case '-':
type = FTPFile.FILE_TYPE;
break;
default: // e.g. ? and w = whiteout
type = FTPFile.UNKNOWN_TYPE;
}
file.setType(type);
int g = 4;
for (int access = 0; access < 3; access++, g += 4)
{
// Use != '-' to avoid having to check for suid and sticky bits
file.setPermission(access, FTPFile.READ_PERMISSION,
(!group(g).equals("-")));
file.setPermission(access, FTPFile.WRITE_PERMISSION,
(!group(g + 1).equals("-")));
String execPerm = group(g + 2);
if (!execPerm.equals("-") && !Character.isUpperCase(execPerm.charAt(0)))
{
file.setPermission(access, FTPFile.EXECUTE_PERMISSION, true);
}
else
{
file.setPermission(access, FTPFile.EXECUTE_PERMISSION, false);
}
}
if (!isDevice)
{
try
{
file.setHardLinkCount(Integer.parseInt(hardLinkCount));
}
catch (NumberFormatException e)
{
// intentionally do nothing
}
}
file.setUser(usr);
file.setGroup(grp);
try
{
file.setSize(Long.parseLong(filesize));
}
catch (NumberFormatException e)
{
// intentionally do nothing
}
// oddball cases like symbolic links, file names
// with spaces in them.
if (type == FTPFile.SYMBOLIC_LINK_TYPE)
{
int end = name.indexOf(" -> ");
// Give up if no link indicator is present
if (end == -1)
{
file.setName(name);
}
else
{
file.setName(name.substring(0, end));
file.setLink(name.substring(end + 4));
}
}
else
{
file.setName(name);
}
return file;
} }
return null; }
}
/** if (!isDevice) {
* Defines a default configuration to be used when this class is try {
* instantiated without a {@link FTPClientConfig FTPClientConfig} file.setHardLinkCount(Integer.parseInt(hardLinkCount));
* parameter being specified. } catch (NumberFormatException e) {
* @return the default configuration for this parser. // intentionally do nothing
*/ }
@Override }
protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(
FTPClientConfig.SYST_UNIX,
DEFAULT_DATE_FORMAT,
DEFAULT_RECENT_DATE_FORMAT);
}
file.setUser(usr);
file.setGroup(grp);
try {
file.setSize(Long.parseLong(filesize));
} catch (NumberFormatException e) {
// intentionally do nothing
}
// oddball cases like symbolic links, file names
// with spaces in them.
if (type == FTPFile.SYMBOLIC_LINK_TYPE) {
int end = name.indexOf(" -> ");
// Give up if no link indicator is present
if (end == -1) {
file.setName(name);
} else {
file.setName(name.substring(0, end));
file.setLink(name.substring(end + 4));
}
} else {
file.setName(name);
}
return file;
}
return null;
}
/**
* Defines a default configuration to be used when this class is
* instantiated without a {@link FTPClientConfig FTPClientConfig}
* parameter being specified.
*
* @return the default configuration for this parser.
*/
@Override protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(FTPClientConfig.SYST_UNIX, DEFAULT_DATE_FORMAT,
DEFAULT_RECENT_DATE_FORMAT);
}
} }

View File

@@ -16,6 +16,7 @@
*/ */
package org.apache.commons.net.ftp.parser; package org.apache.commons.net.ftp.parser;
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.text.ParseException; import java.text.ParseException;
@@ -28,9 +29,12 @@ import org.apache.commons.net.ftp.FTPFile;
* Implementation FTPFileEntryParser and FTPFileListParser for VMS Systems. * Implementation FTPFileEntryParser and FTPFileListParser for VMS Systems.
* This is a sample of VMS LIST output * This is a sample of VMS LIST output
* *
* "1-JUN.LIS;1 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", * "1-JUN.LIS;1 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER]
* "1-JUN.LIS;2 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", * (RWED,RWED,RWED,RE)",
* "DATA.DIR;1 1/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", * "1-JUN.LIS;2 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER]
* (RWED,RWED,RWED,RE)",
* "DATA.DIR;1 1/9 2-JUN-1998 07:32:04 [GROUP,OWNER]
* (RWED,RWED,RWED,RE)",
* <P><B> * <P><B>
* Note: VMSFTPEntryParser can only be instantiated through the * Note: VMSFTPEntryParser can only be instantiated through the
* DefaultFTPParserFactory by classname. It will not be chosen * DefaultFTPParserFactory by classname. It will not be chosen
@@ -39,231 +43,202 @@ import org.apache.commons.net.ftp.FTPFile;
* <P> * <P>
* *
* @version $Id: VMSFTPEntryParser.java 1752660 2016-07-14 13:25:39Z sebb $ * @version $Id: VMSFTPEntryParser.java 1752660 2016-07-14 13:25:39Z sebb $
*
* @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions) * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
* @see org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory * @see org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory
*/ */
public class VMSFTPEntryParser extends ConfigurableFTPFileEntryParserImpl public class VMSFTPEntryParser extends ConfigurableFTPFileEntryParserImpl {
{
private static final String DEFAULT_DATE_FORMAT private static final String DEFAULT_DATE_FORMAT = "d-MMM-yyyy HH:mm:ss"; //9-NOV-2001 12:30:24
= "d-MMM-yyyy HH:mm:ss"; //9-NOV-2001 12:30:24
/** /**
* this is the regular expression used by this parser. * this is the regular expression used by this parser.
*/ */
private static final String REGEX = private static final String REGEX =
"(.*?;[0-9]+)\\s*" //1 file and version "(.*?;[0-9]+)\\s*" //1 file and version
+ "(\\d+)/\\d+\\s*" //2 size/allocated + "(\\d+)/\\d+\\s*" //2 size/allocated
+"(\\S+)\\s+(\\S+)\\s+" //3+4 date and time + "(\\S+)\\s+(\\S+)\\s+" //3+4 date and time
+ "\\[(([0-9$A-Za-z_]+)|([0-9$A-Za-z_]+),([0-9$a-zA-Z_]+))\\]?\\s*" //5(6,7,8) owner + "\\[(([0-9$A-Za-z_]+)|([0-9$A-Za-z_]+),([0-9$a-zA-Z_]+))\\]?\\s*" //5(6,7,8) owner
+ "\\([a-zA-Z]*,([a-zA-Z]*),([a-zA-Z]*),([a-zA-Z]*)\\)"; //9,10,11 Permissions (O,G,W) + "\\([a-zA-Z]*,([a-zA-Z]*),([a-zA-Z]*),([a-zA-Z]*)\\)";
// TODO - perhaps restrict permissions to [RWED]* ? //9,10,11 Permissions (O,G,W)
// TODO - perhaps restrict permissions to [RWED]* ?
/**
* Constructor for a VMSFTPEntryParser object.
*
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
*/
public VMSFTPEntryParser() {
this(null);
}
/**
* This constructor allows the creation of a VMSFTPEntryParser object with
* something other than the default configuration.
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
* @since 1.4
*/
public VMSFTPEntryParser(FTPClientConfig config) {
super(REGEX);
configure(config);
}
/** /**
* Constructor for a VMSFTPEntryParser object. * Parses a line of a VMS FTP server file listing and converts it into a
* * usable format in the form of an <code> FTPFile </code> instance. If the
* @throws IllegalArgumentException * file listing line doesn't describe a file, <code> null </code> is
* Thrown if the regular expression is unparseable. Should not be seen * returned, otherwise a <code> FTPFile </code> instance representing the
* under normal conditions. It it is seen, this is a sign that * files in the directory is returned.
* <code>REGEX</code> is not a valid regular expression. *
*/ * @param entry A line of text from the file listing
public VMSFTPEntryParser() * @return An FTPFile instance corresponding to the supplied entry
{ */
this(null); @Override public FTPFile parseFTPEntry(String entry) {
//one block in VMS equals 512 bytes
long longBlock = 512;
if (matches(entry)) {
FTPFile f = new FTPFile();
f.setRawListing(entry);
String name = group(1);
String size = group(2);
String datestr = group(3) + " " + group(4);
String owner = group(5);
String permissions[] = new String[3];
permissions[0] = group(9);
permissions[1] = group(10);
permissions[2] = group(11);
try {
f.setTimestamp(super.parseTimestamp(datestr));
} catch (ParseException e) {
// intentionally do nothing
}
String grp;
String user;
StringTokenizer t = new StringTokenizer(owner, ",");
switch (t.countTokens()) {
case 1:
grp = null;
user = t.nextToken();
break;
case 2:
grp = t.nextToken();
user = t.nextToken();
break;
default:
grp = null;
user = null;
}
if (name.lastIndexOf(".DIR") != -1) {
f.setType(FTPFile.DIRECTORY_TYPE);
} else {
f.setType(FTPFile.FILE_TYPE);
}
//set FTPFile name
//Check also for versions to be returned or not
if (isVersioning()) {
f.setName(name);
} else {
name = name.substring(0, name.lastIndexOf(";"));
f.setName(name);
}
//size is retreived in blocks and needs to be put in bytes
//for us humans and added to the FTPFile array
long sizeInBytes = Long.parseLong(size) * longBlock;
f.setSize(sizeInBytes);
f.setGroup(grp);
f.setUser(user);
//set group and owner
//Set file permission.
//VMS has (SYSTEM,OWNER,GROUP,WORLD) users that can contain
//R (read) W (write) E (execute) D (delete)
//iterate for OWNER GROUP WORLD permissions
for (int access = 0; access < 3; access++) {
String permission = permissions[access];
f.setPermission(access, FTPFile.READ_PERMISSION, permission.indexOf('R') >= 0);
f.setPermission(access, FTPFile.WRITE_PERMISSION, permission.indexOf('W') >= 0);
f.setPermission(access, FTPFile.EXECUTE_PERMISSION, permission.indexOf('E') >= 0);
}
return f;
} }
return null;
}
/** /**
* This constructor allows the creation of a VMSFTPEntryParser object with * Reads the next entry using the supplied BufferedReader object up to
* something other than the default configuration. * whatever delemits one entry from the next. This parser cannot use
* * the default implementation of simply calling BufferedReader.readLine(),
* @param config The {@link FTPClientConfig configuration} object used to * because one entry may span multiple lines.
* configure this parser. *
* @throws IllegalArgumentException * @param reader The BufferedReader object from which entries are to be
* Thrown if the regular expression is unparseable. Should not be seen * read.
* under normal conditions. It it is seen, this is a sign that * @return A string representing the next ftp entry or null if none found.
* <code>REGEX</code> is not a valid regular expression. * @throws IOException thrown on any IO Error reading from the reader.
* @since 1.4 */
*/ @Override public String readNextEntry(BufferedReader reader) throws IOException {
public VMSFTPEntryParser(FTPClientConfig config) String line = reader.readLine();
{ StringBuilder entry = new StringBuilder();
super(REGEX); while (line != null) {
configure(config); if (line.startsWith("Directory") || line.startsWith("Total")) {
line = reader.readLine();
continue;
}
entry.append(line);
if (line.trim().endsWith(")")) {
break;
}
line = reader.readLine();
} }
return (entry.length() == 0 ? null : entry.toString());
}
/** protected boolean isVersioning() {
* Parses a line of a VMS FTP server file listing and converts it into a return false;
* usable format in the form of an <code> FTPFile </code> instance. If the }
* file listing line doesn't describe a file, <code> null </code> is
* returned, otherwise a <code> FTPFile </code> instance representing the
* files in the directory is returned.
*
* @param entry A line of text from the file listing
* @return An FTPFile instance corresponding to the supplied entry
*/
@Override
public FTPFile parseFTPEntry(String entry)
{
//one block in VMS equals 512 bytes
long longBlock = 512;
if (matches(entry)) /**
{ * Defines a default configuration to be used when this class is
FTPFile f = new FTPFile(); * instantiated without a {@link FTPClientConfig FTPClientConfig}
f.setRawListing(entry); * parameter being specified.
String name = group(1); *
String size = group(2); * @return the default configuration for this parser.
String datestr = group(3)+" "+group(4); */
String owner = group(5); @Override protected FTPClientConfig getDefaultConfiguration() {
String permissions[] = new String[3]; return new FTPClientConfig(FTPClientConfig.SYST_VMS, DEFAULT_DATE_FORMAT, null);
permissions[0]= group(9); }
permissions[1]= group(10);
permissions[2]= group(11);
try
{
f.setTimestamp(super.parseTimestamp(datestr));
}
catch (ParseException e)
{
// intentionally do nothing
}
// DEPRECATED METHODS - for API compatibility only - DO NOT USE
String grp; /**
String user; * DO NOT USE
StringTokenizer t = new StringTokenizer(owner, ","); *
switch (t.countTokens()) { * @param listStream the stream
case 1: * @return the array of files
grp = null; * @throws IOException on error
user = t.nextToken(); * @deprecated (2.2) No other FTPFileEntryParser implementations have this method.
break; */
case 2: @Deprecated public FTPFile[] parseFileList(java.io.InputStream listStream) throws IOException {
grp = t.nextToken(); org.apache.commons.net.ftp.FTPListParseEngine engine =
user = t.nextToken(); new org.apache.commons.net.ftp.FTPListParseEngine(this);
break; engine.readServerList(listStream, null);
default: return engine.getFiles();
grp = null; }
user = null;
}
if (name.lastIndexOf(".DIR") != -1)
{
f.setType(FTPFile.DIRECTORY_TYPE);
}
else
{
f.setType(FTPFile.FILE_TYPE);
}
//set FTPFile name
//Check also for versions to be returned or not
if (isVersioning())
{
f.setName(name);
}
else
{
name = name.substring(0, name.lastIndexOf(";"));
f.setName(name);
}
//size is retreived in blocks and needs to be put in bytes
//for us humans and added to the FTPFile array
long sizeInBytes = Long.parseLong(size) * longBlock;
f.setSize(sizeInBytes);
f.setGroup(grp);
f.setUser(user);
//set group and owner
//Set file permission.
//VMS has (SYSTEM,OWNER,GROUP,WORLD) users that can contain
//R (read) W (write) E (execute) D (delete)
//iterate for OWNER GROUP WORLD permissions
for (int access = 0; access < 3; access++)
{
String permission = permissions[access];
f.setPermission(access, FTPFile.READ_PERMISSION, permission.indexOf('R')>=0);
f.setPermission(access, FTPFile.WRITE_PERMISSION, permission.indexOf('W')>=0);
f.setPermission(access, FTPFile.EXECUTE_PERMISSION, permission.indexOf('E')>=0);
}
return f;
}
return null;
}
/**
* Reads the next entry using the supplied BufferedReader object up to
* whatever delemits one entry from the next. This parser cannot use
* the default implementation of simply calling BufferedReader.readLine(),
* because one entry may span multiple lines.
*
* @param reader The BufferedReader object from which entries are to be
* read.
*
* @return A string representing the next ftp entry or null if none found.
* @throws IOException thrown on any IO Error reading from the reader.
*/
@Override
public String readNextEntry(BufferedReader reader) throws IOException
{
String line = reader.readLine();
StringBuilder entry = new StringBuilder();
while (line != null)
{
if (line.startsWith("Directory") || line.startsWith("Total")) {
line = reader.readLine();
continue;
}
entry.append(line);
if (line.trim().endsWith(")"))
{
break;
}
line = reader.readLine();
}
return (entry.length() == 0 ? null : entry.toString());
}
protected boolean isVersioning() {
return false;
}
/**
* Defines a default configuration to be used when this class is
* instantiated without a {@link FTPClientConfig FTPClientConfig}
* parameter being specified.
* @return the default configuration for this parser.
*/
@Override
protected FTPClientConfig getDefaultConfiguration() {
return new FTPClientConfig(
FTPClientConfig.SYST_VMS,
DEFAULT_DATE_FORMAT,
null);
}
// DEPRECATED METHODS - for API compatibility only - DO NOT USE
/**
* DO NOT USE
* @param listStream the stream
* @return the array of files
* @throws IOException on error
* @deprecated (2.2) No other FTPFileEntryParser implementations have this method.
*/
@Deprecated
public FTPFile[] parseFileList(java.io.InputStream listStream) throws IOException {
org.apache.commons.net.ftp.FTPListParseEngine engine = new org.apache.commons.net.ftp.FTPListParseEngine(this);
engine.readServerList(listStream, null);
return engine.getFiles();
}
} }
/* Emacs configuration /* Emacs configuration

View File

@@ -34,128 +34,114 @@ import org.apache.commons.net.ftp.FTPClientConfig;
* *
* This is a sample of VMS LIST output * This is a sample of VMS LIST output
* *
* "1-JUN.LIS;1 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", * "1-JUN.LIS;1 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER]
* "1-JUN.LIS;2 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", * (RWED,RWED,RWED,RE)",
* "DATA.DIR;1 1/9 2-JUN-1998 07:32:04 [GROUP,OWNER] (RWED,RWED,RWED,RE)", * "1-JUN.LIS;2 9/9 2-JUN-1998 07:32:04 [GROUP,OWNER]
* (RWED,RWED,RWED,RE)",
* "DATA.DIR;1 1/9 2-JUN-1998 07:32:04 [GROUP,OWNER]
* (RWED,RWED,RWED,RE)",
* <P> * <P>
* *
* @version $Id: VMSVersioningFTPEntryParser.java 1747119 2016-06-07 02:22:24Z ggregory $ * @version $Id: VMSVersioningFTPEntryParser.java 1747119 2016-06-07 02:22:24Z ggregory $
*
* @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions) * @see org.apache.commons.net.ftp.FTPFileEntryParser FTPFileEntryParser (for usage instructions)
*/ */
public class VMSVersioningFTPEntryParser extends VMSFTPEntryParser public class VMSVersioningFTPEntryParser extends VMSFTPEntryParser {
{
private final Pattern _preparse_pattern_; private final Pattern _preparse_pattern_;
private static final String PRE_PARSE_REGEX = private static final String PRE_PARSE_REGEX = "(.*?);([0-9]+)\\s*.*";
"(.*?);([0-9]+)\\s*.*";
/** /**
* Constructor for a VMSFTPEntryParser object. * Constructor for a VMSFTPEntryParser object.
* *
* @throws IllegalArgumentException * @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* Thrown if the regular expression is unparseable. Should not be seen * be seen
* under normal conditions. It it is seen, this is a sign that * under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression. * <code>REGEX</code> is not a valid regular expression.
*/ */
public VMSVersioningFTPEntryParser() public VMSVersioningFTPEntryParser() {
{ this(null);
this(null); }
/**
* This constructor allows the creation of a VMSVersioningFTPEntryParser
* object with something other than the default configuration.
*
* @param config The {@link FTPClientConfig configuration} object used to
* configure this parser.
* @throws IllegalArgumentException Thrown if the regular expression is unparseable. Should not
* be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
* @since 1.4
*/
public VMSVersioningFTPEntryParser(FTPClientConfig config) {
super();
configure(config);
try {
//_preparse_matcher_ = new Perl5Matcher();
_preparse_pattern_ = Pattern.compile(PRE_PARSE_REGEX);
} catch (PatternSyntaxException pse) {
throw new IllegalArgumentException("Unparseable regex supplied: " + PRE_PARSE_REGEX);
} }
}
/** /**
* This constructor allows the creation of a VMSVersioningFTPEntryParser * Implement hook provided for those implementers (such as
* object with something other than the default configuration. * VMSVersioningFTPEntryParser, and possibly others) which return
* * multiple files with the same name to remove the duplicates ..
* @param config The {@link FTPClientConfig configuration} object used to *
* configure this parser. * @param original Original list
* @throws IllegalArgumentException * @return Original list purged of duplicates
* Thrown if the regular expression is unparseable. Should not be seen */
* under normal conditions. It it is seen, this is a sign that @Override public List<String> preParse(List<String> original) {
* <code>REGEX</code> is not a valid regular expression. HashMap<String, Integer> existingEntries = new HashMap<String, Integer>();
* @since 1.4 ListIterator<String> iter = original.listIterator();
*/ while (iter.hasNext()) {
public VMSVersioningFTPEntryParser(FTPClientConfig config) String entry = iter.next().trim();
{ MatchResult result = null;
super(); Matcher _preparse_matcher_ = _preparse_pattern_.matcher(entry);
configure(config); if (_preparse_matcher_.matches()) {
try result = _preparse_matcher_.toMatchResult();
{ String name = result.group(1);
//_preparse_matcher_ = new Perl5Matcher(); String version = result.group(2);
_preparse_pattern_ = Pattern.compile(PRE_PARSE_REGEX); Integer nv = Integer.valueOf(version);
Integer existing = existingEntries.get(name);
if (null != existing) {
if (nv.intValue() < existing.intValue()) {
iter.remove(); // removes older version from original list.
continue;
}
} }
catch (PatternSyntaxException pse) existingEntries.put(name, nv);
{ }
throw new IllegalArgumentException (
"Unparseable regex supplied: " + PRE_PARSE_REGEX);
}
}
/**
* Implement hook provided for those implementers (such as
* VMSVersioningFTPEntryParser, and possibly others) which return
* multiple files with the same name to remove the duplicates ..
*
* @param original Original list
*
* @return Original list purged of duplicates
*/
@Override
public List<String> preParse(List<String> original) {
HashMap<String, Integer> existingEntries = new HashMap<String, Integer>();
ListIterator<String> iter = original.listIterator();
while (iter.hasNext()) {
String entry = iter.next().trim();
MatchResult result = null;
Matcher _preparse_matcher_ = _preparse_pattern_.matcher(entry);
if (_preparse_matcher_.matches()) {
result = _preparse_matcher_.toMatchResult();
String name = result.group(1);
String version = result.group(2);
Integer nv = Integer.valueOf(version);
Integer existing = existingEntries.get(name);
if (null != existing) {
if (nv.intValue() < existing.intValue()) {
iter.remove(); // removes older version from original list.
continue;
}
}
existingEntries.put(name, nv);
}
}
// we've now removed all entries less than with less than the largest
// version number for each name that were listed after the largest.
// we now must remove those with smaller than the largest version number
// for each name that were found before the largest
while (iter.hasPrevious()) {
String entry = iter.previous().trim();
MatchResult result = null;
Matcher _preparse_matcher_ = _preparse_pattern_.matcher(entry);
if (_preparse_matcher_.matches()) {
result = _preparse_matcher_.toMatchResult();
String name = result.group(1);
String version = result.group(2);
Integer nv = Integer.valueOf(version);
Integer existing = existingEntries.get(name);
if (null != existing) {
if (nv.intValue() < existing.intValue()) {
iter.remove(); // removes older version from original list.
}
}
}
}
return original;
} }
// we've now removed all entries less than with less than the largest
// version number for each name that were listed after the largest.
@Override // we now must remove those with smaller than the largest version number
protected boolean isVersioning() { // for each name that were found before the largest
return true; while (iter.hasPrevious()) {
String entry = iter.previous().trim();
MatchResult result = null;
Matcher _preparse_matcher_ = _preparse_pattern_.matcher(entry);
if (_preparse_matcher_.matches()) {
result = _preparse_matcher_.toMatchResult();
String name = result.group(1);
String version = result.group(2);
Integer nv = Integer.valueOf(version);
Integer existing = existingEntries.get(name);
if (null != existing) {
if (nv.intValue() < existing.intValue()) {
iter.remove(); // removes older version from original list.
}
}
}
} }
return original;
}
@Override protected boolean isVersioning() {
return true;
}
} }
/* Emacs configuration /* Emacs configuration

View File

@@ -28,50 +28,48 @@ import java.io.Reader;
* *
* @since 3.0 * @since 3.0
*/ */
public final class CRLFLineReader extends BufferedReader public final class CRLFLineReader extends BufferedReader {
{ private static final char LF = '\n';
private static final char LF = '\n'; private static final char CR = '\r';
private static final char CR = '\r';
/** /**
* Creates a CRLFLineReader that wraps an existing Reader * Creates a CRLFLineReader that wraps an existing Reader
* input source. * input source.
* @param reader The Reader input source. *
*/ * @param reader The Reader input source.
public CRLFLineReader(Reader reader) */
{ public CRLFLineReader(Reader reader) {
super(reader); super(reader);
} }
/** /**
* Read a line of text. * Read a line of text.
* A line is considered to be terminated by carriage return followed immediately by a linefeed. * A line is considered to be terminated by carriage return followed immediately by a linefeed.
* This contrasts with BufferedReader which also allows other combinations. * This contrasts with BufferedReader which also allows other combinations.
* @since 3.0 *
*/ * @since 3.0
@Override */
public String readLine() throws IOException { @Override public String readLine() throws IOException {
StringBuilder sb = new StringBuilder(); StringBuilder sb = new StringBuilder();
int intch; int intch;
boolean prevWasCR = false; boolean prevWasCR = false;
synchronized(lock) { // make thread-safe (hopefully!) synchronized (lock) { // make thread-safe (hopefully!)
while((intch = read()) != -1) while ((intch = read()) != -1) {
{ if (prevWasCR && intch == LF) {
if (prevWasCR && intch == LF) { return sb.substring(0, sb.length() - 1);
return sb.substring(0, sb.length()-1);
}
if (intch == CR) {
prevWasCR = true;
} else {
prevWasCR = false;
}
sb.append((char) intch);
}
} }
String string = sb.toString(); if (intch == CR) {
if (string.length() == 0) { // immediate EOF prevWasCR = true;
return null; } else {
prevWasCR = false;
} }
return string; sb.append((char) intch);
}
} }
String string = sb.toString();
if (string.length() == 0) { // immediate EOF
return null;
}
return string;
}
} }

View File

@@ -32,87 +32,80 @@ import org.apache.commons.net.util.ListenerList;
* reasons and also because multiple listeners cannot be registered given * reasons and also because multiple listeners cannot be registered given
* that the methods are static. * that the methods are static.
* *
* * @version $Id: CopyStreamAdapter.java 1741829 2016-05-01 00:24:44Z sebb $
* @see CopyStreamEvent * @see CopyStreamEvent
* @see CopyStreamListener * @see CopyStreamListener
* @see Util * @see Util
* @version $Id: CopyStreamAdapter.java 1741829 2016-05-01 00:24:44Z sebb $
*/ */
public class CopyStreamAdapter implements CopyStreamListener public class CopyStreamAdapter implements CopyStreamListener {
{ private final ListenerList internalListeners;
private final ListenerList internalListeners;
/** /**
* Creates a new copyStreamAdapter. * Creates a new copyStreamAdapter.
*/ */
public CopyStreamAdapter() public CopyStreamAdapter() {
{ internalListeners = new ListenerList();
internalListeners = new ListenerList(); }
}
/** /**
* This method is invoked by a CopyStreamEvent source after copying * This method is invoked by a CopyStreamEvent source after copying
* a block of bytes from a stream. The CopyStreamEvent will contain * a block of bytes from a stream. The CopyStreamEvent will contain
* the total number of bytes transferred so far and the number of bytes * the total number of bytes transferred so far and the number of bytes
* transferred in the last write. The CopyStreamAdapater will relay * transferred in the last write. The CopyStreamAdapater will relay
* the event to all of its registered listeners, listing itself as the * the event to all of its registered listeners, listing itself as the
* source of the event. * source of the event.
* @param event The CopyStreamEvent fired by the copying of a block of *
* bytes. * @param event The CopyStreamEvent fired by the copying of a block of
*/ * bytes.
@Override */
public void bytesTransferred(CopyStreamEvent event) @Override public void bytesTransferred(CopyStreamEvent event) {
{ for (EventListener listener : internalListeners) {
for (EventListener listener : internalListeners) ((CopyStreamListener) (listener)).bytesTransferred(event);
{
((CopyStreamListener) (listener)).bytesTransferred(event);
}
} }
}
/** /**
* This method is not part of the JavaBeans model and is used by the * This method is not part of the JavaBeans model and is used by the
* static methods in the org.apache.commons.io.Util class for efficiency. * static methods in the org.apache.commons.io.Util class for efficiency.
* It is invoked after a block of bytes to inform the listener of the * It is invoked after a block of bytes to inform the listener of the
* transfer. The CopyStreamAdapater will create a CopyStreamEvent * transfer. The CopyStreamAdapater will create a CopyStreamEvent
* from the arguments and relay the event to all of its registered * from the arguments and relay the event to all of its registered
* listeners, listing itself as the source of the event. * listeners, listing itself as the source of the event.
* @param totalBytesTransferred The total number of bytes transferred *
* so far by the copy operation. * @param totalBytesTransferred The total number of bytes transferred
* @param bytesTransferred The number of bytes copied by the most recent * so far by the copy operation.
* write. * @param bytesTransferred The number of bytes copied by the most recent
* @param streamSize The number of bytes in the stream being copied. * write.
* This may be equal to CopyStreamEvent.UNKNOWN_STREAM_SIZE if * @param streamSize The number of bytes in the stream being copied.
* the size is unknown. * This may be equal to CopyStreamEvent.UNKNOWN_STREAM_SIZE if
*/ * the size is unknown.
@Override */
public void bytesTransferred(long totalBytesTransferred, @Override public void bytesTransferred(long totalBytesTransferred, int bytesTransferred,
int bytesTransferred, long streamSize) long streamSize) {
{ for (EventListener listener : internalListeners) {
for (EventListener listener : internalListeners) ((CopyStreamListener) (listener)).bytesTransferred(totalBytesTransferred, bytesTransferred,
{ streamSize);
((CopyStreamListener) (listener)).bytesTransferred(
totalBytesTransferred, bytesTransferred, streamSize);
}
} }
}
/** /**
* Registers a CopyStreamListener to receive CopyStreamEvents. * Registers a CopyStreamListener to receive CopyStreamEvents.
* Although this method is not declared to be synchronized, it is * Although this method is not declared to be synchronized, it is
* implemented in a thread safe manner. * implemented in a thread safe manner.
* @param listener The CopyStreamlistener to register. *
*/ * @param listener The CopyStreamlistener to register.
public void addCopyStreamListener(CopyStreamListener listener) */
{ public void addCopyStreamListener(CopyStreamListener listener) {
internalListeners.addListener(listener); internalListeners.addListener(listener);
} }
/** /**
* Unregisters a CopyStreamListener. Although this method is not * Unregisters a CopyStreamListener. Although this method is not
* synchronized, it is implemented in a thread safe manner. * synchronized, it is implemented in a thread safe manner.
* @param listener The CopyStreamlistener to unregister. *
*/ * @param listener The CopyStreamlistener to unregister.
public void removeCopyStreamListener(CopyStreamListener listener) */
{ public void removeCopyStreamListener(CopyStreamListener listener) {
internalListeners.removeListener(listener); internalListeners.removeListener(listener);
} }
} }

View File

@@ -25,87 +25,89 @@ import java.util.EventObject;
* transferred by the write triggering the event as well as the total * transferred by the write triggering the event as well as the total
* number of bytes transferred so far by the copy operation. * number of bytes transferred so far by the copy operation.
* *
* * @version $Id: CopyStreamEvent.java 1652801 2015-01-18 17:10:05Z sebb $
* @see CopyStreamListener * @see CopyStreamListener
* @see CopyStreamAdapter * @see CopyStreamAdapter
* @see Util * @see Util
* @version $Id: CopyStreamEvent.java 1652801 2015-01-18 17:10:05Z sebb $
*/ */
public class CopyStreamEvent extends EventObject public class CopyStreamEvent extends EventObject {
{ private static final long serialVersionUID = -964927635655051867L;
private static final long serialVersionUID = -964927635655051867L;
/** /**
* Constant used to indicate the stream size is unknown. * Constant used to indicate the stream size is unknown.
*/ */
public static final long UNKNOWN_STREAM_SIZE = -1; public static final long UNKNOWN_STREAM_SIZE = -1;
private final int bytesTransferred; private final int bytesTransferred;
private final long totalBytesTransferred; private final long totalBytesTransferred;
private final long streamSize; private final long streamSize;
/** /**
* Creates a new CopyStreamEvent instance. * Creates a new CopyStreamEvent instance.
* @param source The source of the event. *
* @param totalBytesTransferred The total number of bytes transferred so * @param source The source of the event.
* far during a copy operation. * @param totalBytesTransferred The total number of bytes transferred so
* @param bytesTransferred The number of bytes transferred during the * far during a copy operation.
* write that triggered the CopyStreamEvent. * @param bytesTransferred The number of bytes transferred during the
* @param streamSize The number of bytes in the stream being copied. * write that triggered the CopyStreamEvent.
* This may be set to <code>UNKNOWN_STREAM_SIZE</code> if the * @param streamSize The number of bytes in the stream being copied.
* size is unknown. * This may be set to <code>UNKNOWN_STREAM_SIZE</code> if the
*/ * size is unknown.
public CopyStreamEvent(Object source, long totalBytesTransferred, */
int bytesTransferred, long streamSize) public CopyStreamEvent(Object source, long totalBytesTransferred, int bytesTransferred,
{ long streamSize) {
super(source); super(source);
this.bytesTransferred = bytesTransferred; this.bytesTransferred = bytesTransferred;
this.totalBytesTransferred = totalBytesTransferred; this.totalBytesTransferred = totalBytesTransferred;
this.streamSize = streamSize; this.streamSize = streamSize;
} }
/** /**
* Returns the number of bytes transferred by the write that triggered * Returns the number of bytes transferred by the write that triggered
* the event. * the event.
* @return The number of bytes transferred by the write that triggered *
* the vent. * @return The number of bytes transferred by the write that triggered
*/ * the vent.
public int getBytesTransferred() */
{ public int getBytesTransferred() {
return bytesTransferred; return bytesTransferred;
} }
/** /**
* Returns the total number of bytes transferred so far by the copy * Returns the total number of bytes transferred so far by the copy
* operation. * operation.
* @return The total number of bytes transferred so far by the copy *
* operation. * @return The total number of bytes transferred so far by the copy
*/ * operation.
public long getTotalBytesTransferred() */
{ public long getTotalBytesTransferred() {
return totalBytesTransferred; return totalBytesTransferred;
} }
/** /**
* Returns the size of the stream being copied. * Returns the size of the stream being copied.
* This may be set to <code>UNKNOWN_STREAM_SIZE</code> if the * This may be set to <code>UNKNOWN_STREAM_SIZE</code> if the
* size is unknown. * size is unknown.
* @return The size of the stream being copied. *
*/ * @return The size of the stream being copied.
public long getStreamSize() */
{ public long getStreamSize() {
return streamSize; return streamSize;
} }
/** /**
* @since 3.0 * @since 3.0
*/ */
@Override @Override public String toString() {
public String toString(){ return getClass().getName()
return getClass().getName() + "[source=" + source + "[source="
+ ", total=" + totalBytesTransferred + source
+ ", bytes=" + bytesTransferred + ", total="
+ ", size=" + streamSize + totalBytesTransferred
+ ", bytes="
+ bytesTransferred
+ ", size="
+ streamSize
+ "]"; + "]";
} }
} }

View File

@@ -24,48 +24,46 @@ import java.io.IOException;
* copyStream() methods. It stores the number of bytes confirmed to * copyStream() methods. It stores the number of bytes confirmed to
* have been transferred before an I/O error as well as the IOException * have been transferred before an I/O error as well as the IOException
* responsible for the failure of a copy operation. * responsible for the failure of a copy operation.
* @see Util *
* @version $Id: CopyStreamException.java 1299238 2012-03-10 17:12:28Z sebb $ * @version $Id: CopyStreamException.java 1299238 2012-03-10 17:12:28Z sebb $
* @see Util
*/ */
public class CopyStreamException extends IOException public class CopyStreamException extends IOException {
{ private static final long serialVersionUID = -2602899129433221532L;
private static final long serialVersionUID = -2602899129433221532L;
private final long totalBytesTransferred; private final long totalBytesTransferred;
/** /**
* Creates a new CopyStreamException instance. * Creates a new CopyStreamException instance.
* @param message A message describing the error. *
* @param bytesTransferred The total number of bytes transferred before * @param message A message describing the error.
* an exception was thrown in a copy operation. * @param bytesTransferred The total number of bytes transferred before
* @param exception The IOException thrown during a copy operation. * an exception was thrown in a copy operation.
*/ * @param exception The IOException thrown during a copy operation.
public CopyStreamException(String message, */
long bytesTransferred, public CopyStreamException(String message, long bytesTransferred, IOException exception) {
IOException exception) super(message);
{ initCause(exception); // merge this into super() call once we need 1.6+
super(message); totalBytesTransferred = bytesTransferred;
initCause(exception); // merge this into super() call once we need 1.6+ }
totalBytesTransferred = bytesTransferred;
}
/** /**
* Returns the total number of bytes confirmed to have * Returns the total number of bytes confirmed to have
* been transferred by a failed copy operation. * been transferred by a failed copy operation.
* @return The total number of bytes confirmed to have *
* been transferred by a failed copy operation. * @return The total number of bytes confirmed to have
*/ * been transferred by a failed copy operation.
public long getTotalBytesTransferred() */
{ public long getTotalBytesTransferred() {
return totalBytesTransferred; return totalBytesTransferred;
} }
/** /**
* Returns the IOException responsible for the failure of a copy operation. * Returns the IOException responsible for the failure of a copy operation.
* @return The IOException responsible for the failure of a copy operation. *
*/ * @return The IOException responsible for the failure of a copy operation.
public IOException getIOException() */
{ public IOException getIOException() {
return (IOException) getCause(); // cast is OK because it was initialised with an IOException return (IOException) getCause(); // cast is OK because it was initialised with an IOException
} }
} }

Some files were not shown because too many files have changed in this diff Show More