This is an automated email from the ASF dual-hosted git repository.
nmalin pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
The following commit(s) were added to refs/heads/trunk by this push:
new 42f86efb6b Improved: Prevent potential resource leak in
FtpServices.java putFile/getFile (OFBIZ-13427) (#1300)
42f86efb6b is described below
commit 42f86efb6b9818e35941c4fe16d373ee30e5c68c
Author: chandan-khandelwal <[email protected]>
AuthorDate: Tue Jun 9 12:51:25 2026 +0530
Improved: Prevent potential resource leak in FtpServices.java
putFile/getFile (OFBIZ-13427) (#1300)
We refactored putFile and getFile in FtpServices.java to use
try-with-resources, ensuring local file streams are always closed
automatically to prevent file descriptor leaks.
---
.../java/org/apache/ofbiz/common/FtpServices.java | 210 ++++++++++-----------
1 file changed, 103 insertions(+), 107 deletions(-)
diff --git
a/framework/common/src/main/java/org/apache/ofbiz/common/FtpServices.java
b/framework/common/src/main/java/org/apache/ofbiz/common/FtpServices.java
index 67e8ec88b7..3c3778050f 100644
--- a/framework/common/src/main/java/org/apache/ofbiz/common/FtpServices.java
+++ b/framework/common/src/main/java/org/apache/ofbiz/common/FtpServices.java
@@ -51,78 +51,76 @@ public class FtpServices {
public static Map<String, Object> putFile(DispatchContext dctx,
Map<String, ?> context) {
Locale locale = (Locale) context.get("locale");
Debug.logInfo("[putFile] starting...", MODULE);
- InputStream localFile = null;
- try {
- localFile = new FileInputStream((String)
context.get("localFilename"));
- } catch (IOException ioe) {
- Debug.logError(ioe, "[putFile] Problem opening local file",
MODULE);
- return ServiceUtil.returnError(UtilProperties.getMessage(RESOURCE,
"CommonFtpFileCannotBeOpen", locale));
- }
List<String> errorList = new LinkedList<>();
FTPClient ftp = new FTPClient();
- try {
- Integer defaultTimeout = (Integer) context.get("defaultTimeout");
- if (UtilValidate.isNotEmpty(defaultTimeout)) {
- Debug.logInfo("[putFile] set default timeout to: " +
defaultTimeout + " milliseconds", MODULE);
- ftp.setDefaultTimeout(defaultTimeout);
- }
- Debug.logInfo("[putFile] connecting to: " + (String)
context.get("hostname"), MODULE);
- ftp.connect((String) context.get("hostname"));
- if (!FTPReply.isPositiveCompletion(ftp.getReplyCode())) {
- Debug.logInfo("[putFile] Server refused connection", MODULE);
- errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpConnectionRefused", locale));
- } else {
- String username = (String) context.get("username");
- String password = (String) context.get("password");
- Debug.logInfo("[putFile] logging in: username=" + username +
", password=" + password, MODULE);
- if (!ftp.login(username, password)) {
- Debug.logInfo("[putFile] login failed", MODULE);
- errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpLoginFailure", UtilMisc.toMap("username",
- username, "password", password), locale));
+ try (InputStream localFile = new FileInputStream((String)
context.get("localFilename"))) {
+ try {
+ Integer defaultTimeout = (Integer)
context.get("defaultTimeout");
+ if (UtilValidate.isNotEmpty(defaultTimeout)) {
+ Debug.logInfo("[putFile] set default timeout to: " +
defaultTimeout + " milliseconds", MODULE);
+ ftp.setDefaultTimeout(defaultTimeout);
+ }
+ Debug.logInfo("[putFile] connecting to: " + (String)
context.get("hostname"), MODULE);
+ ftp.connect((String) context.get("hostname"));
+ if (!FTPReply.isPositiveCompletion(ftp.getReplyCode())) {
+ Debug.logInfo("[putFile] Server refused connection",
MODULE);
+ errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpConnectionRefused", locale));
} else {
- Boolean binaryTransfer = (Boolean)
context.get("binaryTransfer");
- boolean binary = (binaryTransfer == null) ? false :
binaryTransfer;
- if (binary) {
- ftp.setFileType(FTP.BINARY_FILE_TYPE);
- }
- Boolean passiveMode = (Boolean) context.get("passiveMode");
- boolean passive = (passiveMode == null) ? true :
passiveMode;
- if (passive) {
- ftp.enterLocalPassiveMode();
- }
- Debug.logInfo("[putFile] storing local file remotely as: "
+ context.get("remoteFilename"), MODULE);
- if (!ftp.storeFile((String) context.get("remoteFilename"),
localFile)) {
- Debug.logInfo("[putFile] store was unsuccessful",
MODULE);
- errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpFileNotSentSuccesfully",
- UtilMisc.toMap("replyString",
ftp.getReplyString()), locale));
+ String username = (String) context.get("username");
+ String password = (String) context.get("password");
+ Debug.logInfo("[putFile] logging in: username=" + username
+ ", password=" + password, MODULE);
+ if (!ftp.login(username, password)) {
+ Debug.logInfo("[putFile] login failed", MODULE);
+ errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpLoginFailure", UtilMisc.toMap("username",
+ username, "password", password), locale));
} else {
- Debug.logInfo("[putFile] store was successful",
MODULE);
- List<String> siteCommands =
checkCollection(context.get("siteCommands"), String.class);
- if (siteCommands != null) {
- for (String command : siteCommands) {
- Debug.logInfo("[putFile] sending SITE command:
" + command, MODULE);
- if (!ftp.sendSiteCommand(command)) {
-
errorList.add(UtilProperties.getMessage(RESOURCE, "CommonFtpSiteCommandFailed",
- UtilMisc.toMap("command", command,
"replyString", ftp.getReplyString()), locale));
+ Boolean binaryTransfer = (Boolean)
context.get("binaryTransfer");
+ boolean binary = (binaryTransfer == null) ? false :
binaryTransfer;
+ if (binary) {
+ ftp.setFileType(FTP.BINARY_FILE_TYPE);
+ }
+ Boolean passiveMode = (Boolean)
context.get("passiveMode");
+ boolean passive = (passiveMode == null) ? true :
passiveMode;
+ if (passive) {
+ ftp.enterLocalPassiveMode();
+ }
+ Debug.logInfo("[putFile] storing local file remotely
as: " + context.get("remoteFilename"), MODULE);
+ if (!ftp.storeFile((String)
context.get("remoteFilename"), localFile)) {
+ Debug.logInfo("[putFile] store was unsuccessful",
MODULE);
+ errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpFileNotSentSuccesfully",
+ UtilMisc.toMap("replyString",
ftp.getReplyString()), locale));
+ } else {
+ Debug.logInfo("[putFile] store was successful",
MODULE);
+ List<String> siteCommands =
checkCollection(context.get("siteCommands"), String.class);
+ if (siteCommands != null) {
+ for (String command : siteCommands) {
+ Debug.logInfo("[putFile] sending SITE
command: " + command, MODULE);
+ if (!ftp.sendSiteCommand(command)) {
+
errorList.add(UtilProperties.getMessage(RESOURCE, "CommonFtpSiteCommandFailed",
+ UtilMisc.toMap("command",
command, "replyString", ftp.getReplyString()), locale));
+ }
}
}
}
}
+ ftp.logout();
}
- ftp.logout();
- }
- } catch (IOException ioe) {
- Debug.logWarning(ioe, "[putFile] caught exception: " +
ioe.getMessage(), MODULE);
- errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpProblemWithTransfer", UtilMisc.toMap("errorString",
- ioe.getMessage()), locale));
- } finally {
- try {
- if (ftp.isConnected()) {
- ftp.disconnect();
+ } catch (IOException ioe) {
+ Debug.logWarning(ioe, "[putFile] caught exception: " +
ioe.getMessage(), MODULE);
+ errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpProblemWithTransfer", UtilMisc.toMap("errorString",
+ ioe.getMessage()), locale));
+ } finally {
+ try {
+ if (ftp.isConnected()) {
+ ftp.disconnect();
+ }
+ } catch (Exception e) {
+ Debug.logWarning(e, "[putFile] Problem with FTP
disconnect: ", MODULE);
}
- } catch (Exception e) {
- Debug.logWarning(e, "[putFile] Problem with FTP disconnect: ",
MODULE);
}
+ } catch (IOException ioe) {
+ Debug.logError(ioe, "[putFile] Problem opening local file",
MODULE);
+ return ServiceUtil.returnError(UtilProperties.getMessage(RESOURCE,
"CommonFtpFileCannotBeOpen", locale));
}
if (!errorList.isEmpty()) {
Debug.logError("[putFile] The following error(s) (" +
errorList.size() + ") occurred: " + errorList, MODULE);
@@ -135,60 +133,58 @@ public class FtpServices {
public static Map<String, Object> getFile(DispatchContext dctx,
Map<String, ?> context) {
Locale locale = (Locale) context.get("locale");
String localFilename = (String) context.get("localFilename");
- OutputStream localFile = null;
- try {
- localFile = new FileOutputStream(localFilename);
- } catch (IOException ioe) {
- Debug.logError(ioe, "[getFile] Problem opening local file",
MODULE);
- return ServiceUtil.returnError(UtilProperties.getMessage(RESOURCE,
"CommonFtpFileCannotBeOpen", locale));
- }
List<String> errorList = new LinkedList<>();
FTPClient ftp = new FTPClient();
- try {
- Integer defaultTimeout = (Integer) context.get("defaultTimeout");
- if (UtilValidate.isNotEmpty(defaultTimeout)) {
- Debug.logInfo("[getFile] Set default timeout to: " +
defaultTimeout + " milliseconds", MODULE);
- ftp.setDefaultTimeout(defaultTimeout);
- }
- ftp.connect((String) context.get("hostname"));
- if (!FTPReply.isPositiveCompletion(ftp.getReplyCode())) {
- errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpConnectionRefused", locale));
- } else {
- String username = (String) context.get("username");
- String password = (String) context.get("password");
- if (!ftp.login(username, password)) {
- errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpLoginFailure", UtilMisc.toMap("username",
- username, "password", password), locale));
+ try (OutputStream localFile = new FileOutputStream(localFilename)) {
+ try {
+ Integer defaultTimeout = (Integer)
context.get("defaultTimeout");
+ if (UtilValidate.isNotEmpty(defaultTimeout)) {
+ Debug.logInfo("[getFile] Set default timeout to: " +
defaultTimeout + " milliseconds", MODULE);
+ ftp.setDefaultTimeout(defaultTimeout);
+ }
+ ftp.connect((String) context.get("hostname"));
+ if (!FTPReply.isPositiveCompletion(ftp.getReplyCode())) {
+ errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpConnectionRefused", locale));
} else {
- Boolean binaryTransfer = (Boolean)
context.get("binaryTransfer");
- boolean binary = (binaryTransfer == null) ? false :
binaryTransfer;
- if (binary) {
- ftp.setFileType(FTP.BINARY_FILE_TYPE);
- }
- Boolean passiveMode = (Boolean) context.get("passiveMode");
- boolean passive = (passiveMode == null) ? false :
passiveMode;
- if (passive) {
- ftp.enterLocalPassiveMode();
+ String username = (String) context.get("username");
+ String password = (String) context.get("password");
+ if (!ftp.login(username, password)) {
+ errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpLoginFailure", UtilMisc.toMap("username",
+ username, "password", password), locale));
+ } else {
+ Boolean binaryTransfer = (Boolean)
context.get("binaryTransfer");
+ boolean binary = (binaryTransfer == null) ? false :
binaryTransfer;
+ if (binary) {
+ ftp.setFileType(FTP.BINARY_FILE_TYPE);
+ }
+ Boolean passiveMode = (Boolean)
context.get("passiveMode");
+ boolean passive = (passiveMode == null) ? false :
passiveMode;
+ if (passive) {
+ ftp.enterLocalPassiveMode();
+ }
+ if (!ftp.retrieveFile((String)
context.get("remoteFilename"), localFile)) {
+ errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpFileNotSentSuccesfully",
+ UtilMisc.toMap("replyString",
ftp.getReplyString()), locale));
+ }
}
- if (!ftp.retrieveFile((String)
context.get("remoteFilename"), localFile)) {
- errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpFileNotSentSuccesfully",
- UtilMisc.toMap("replyString",
ftp.getReplyString()), locale));
+ ftp.logout();
+ }
+ } catch (IOException ioe) {
+ Debug.logWarning(ioe, "[getFile] caught exception: " +
ioe.getMessage(), MODULE);
+ errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpProblemWithTransfer", UtilMisc.toMap("errorString",
+ ioe.getMessage()), locale));
+ } finally {
+ try {
+ if (ftp.isConnected()) {
+ ftp.disconnect();
}
+ } catch (Exception e) {
+ Debug.logWarning(e, "[getFile] Problem with FTP
disconnect: ", MODULE);
}
- ftp.logout();
}
} catch (IOException ioe) {
- Debug.logWarning(ioe, "[getFile] caught exception: " +
ioe.getMessage(), MODULE);
- errorList.add(UtilProperties.getMessage(RESOURCE,
"CommonFtpProblemWithTransfer", UtilMisc.toMap("errorString",
- ioe.getMessage()), locale));
- } finally {
- try {
- if (ftp.isConnected()) {
- ftp.disconnect();
- }
- } catch (Exception e) {
- Debug.logWarning(e, "[getFile] Problem with FTP disconnect: ",
MODULE);
- }
+ Debug.logError(ioe, "[getFile] Problem opening local file",
MODULE);
+ return ServiceUtil.returnError(UtilProperties.getMessage(RESOURCE,
"CommonFtpFileCannotBeOpen", locale));
}
if (!errorList.isEmpty()) {
Debug.logError("[getFile] The following error(s) (" +
errorList.size() + ") occurred: " + errorList, MODULE);
