+ * Resolves the given {@code filePath}, connects to the SFTP server, + * uploads the file to the remote path, and optionally deletes the local file + * if configured. Sends messages to {@code sender} about progress and success/failure. + *
+ * + * @param filePath the path of the local file to upload + * @param direct currently unused flag indicating direct upload + */ + public void uploadFileToSftp(String filePath, boolean direct) { + File file = new File(filePath); + + if (!file.getPath().contains(Configuration.backupDestination.replaceAll("/", ""))) { + file = new File(Configuration.backupDestination + "//" + filePath); + filePath = file.getPath(); + } + + if (!file.exists()) { + sender.sendMessage(OperationHandler.processMessage("Error.NoBackupFound").replaceAll("%file%", file.getName())); + + return; + } + + SSHClient sshClient = new SSHClient(); + SFTPClient sftpClient = null; + + try { + sftpClient = connect(sshClient); + + sender.sendMessage(OperationHandler.processMessage("Info.SftpUpload").replaceAll("%file%", file.getName())); + OperationHandler.tasks.add("SFTP UPLOAD {" + filePath + "}"); + + + try { + FileSystemFile localFile = new FileSystemFile(file); + sftpClient.put(localFile, getRemotePath(file.getName())); + sender.sendMessage(OperationHandler.processMessage("Info.SftpUploadSuccess")); + + if (ServerBackup.getInstance().getConfig().getBoolean("Sftp.DeleteLocalBackup")) { + boolean exists = false; + for (RemoteResourceInfo backup : sftpClient.ls(working_dir, RemoteResourceInfo::isRegularFile)) { + if (backup.getName().equalsIgnoreCase(file.getName())) { + exists = true; + } + } + + if (exists) { + file.delete(); + } else { + sender.sendMessage(OperationHandler.processMessage("Error.SftpLocalDeletionFailed")); + } + } + } catch (IOException e) { + sender.sendMessage(OperationHandler.processMessage("Error.SftpUploadFailed")); + e.printStackTrace(); + } + + } catch (IOException e) { + sender.sendMessage(OperationHandler.processMessage("Error.SftpUploadFailed")); + e.printStackTrace(); + } finally { + try { + disconnect(sftpClient, sshClient); + } catch (IOException e) { + // TODO: Handle exception here + e.printStackTrace(); + } + } + } + + /** + * Downloads a file from the configured SFTP server to the local backup destination. + *+ * Checks if the file exists on the remote server, downloads it if found, + * and sends progress and status messages to {@code sender}. Handles + * connection and I/O exceptions and ensures the SFTP client is disconnected. + *
+ * + * @param filePath the path of the file to download from the remote server + */ + public void downloadFileFromSftp(String filePath) { + File file = new File(filePath); + + SSHClient sshClient = new SSHClient(); + SFTPClient sftpClient = null; + + try { + sftpClient = connect(sshClient); + + boolean exists = false; + + for (RemoteResourceInfo backup : sftpClient.ls(working_dir, RemoteResourceInfo::isRegularFile)) { + if (backup.getName().equalsIgnoreCase(file.getName())) { + exists = true; + } + } + + if (!exists) { + sender.sendMessage(OperationHandler.processMessage("Error.SftpNotFound").replaceAll("%file%", file.getName())); + + return; + } + + sender.sendMessage(OperationHandler.processMessage("Info.SftpDownload").replaceAll("%file%", file.getName())); + + File dFile = new File(Configuration.backupDestination + "//" + file.getPath()); + + try { + sftpClient.get(getRemotePath(filePath), dFile.getAbsolutePath()); + sender.sendMessage(OperationHandler.processMessage("Info.SftpDownloadSuccess")); + } catch (IOException e) { + sender.sendMessage(OperationHandler.processMessage("Error.SftpDownloadFailed")); + e.printStackTrace(); + } + + } catch (IOException e) { + sender.sendMessage(OperationHandler.processMessage("Error.SftpDownloadFailed")); + e.printStackTrace(); + } finally { + try { + disconnect(sftpClient, sshClient); + } catch (IOException e) { + // TODO: Handle exception here + e.printStackTrace(); + } + } + } + + /** + * Deletes a file from the configured SFTP server. + *+ * Checks if the specified file exists on the remote server, deletes it if found, + * and sends progress and status messages to {@code sender}. Handles connection + * and I/O exceptions and ensures the SFTP client is disconnected. + *
+ * + * @param filePath the path of the file to delete on the remote server + */ + public void deleteFile(String filePath) { + File file = new File(filePath); + + SSHClient sshClient = new SSHClient(); + SFTPClient sftpClient = null; + + try { + sftpClient = connect(sshClient); + + boolean exists = false; + + for (RemoteResourceInfo backup : sftpClient.ls(working_dir, RemoteResourceInfo::isRegularFile)) { + if (backup.getName().equalsIgnoreCase(file.getName())) { + exists = true; + } + } + + if (!exists) { + sender.sendMessage(OperationHandler.processMessage("Error.SftpNotFound").replaceAll("%file%", file.getName())); + + return; + } + + sender.sendMessage(OperationHandler.processMessage("Info.FtpDeletion").replaceAll("%file%", file.getName())); + + try { + sftpClient.rm(getRemotePath(filePath)); + sender.sendMessage(OperationHandler.processMessage("Info.SftpDeletionSuccess")); + } catch (IOException e) { + sender.sendMessage(OperationHandler.processMessage("Error.SftpDeletionFailed")); + } + } catch (IOException e) { + sender.sendMessage(OperationHandler.processMessage("Error.SftpDeletionFailed")); + e.printStackTrace(); + } finally { + try { + disconnect(sftpClient, sshClient); + } catch (IOException e) { + // TODO: Handle exception here + e.printStackTrace(); + } + } + } + + /** + * Retrieves a list of backup files from the configured SFTP server. + *+ * Lists all regular files in the remote working directory and returns + * them either in a raw format (path:size in MB) or a formatted display + * string with an index and file size. + *
+ * + * @param rawList if true, returns a raw "path:size" list; if false, returns a formatted list + * @return a list of backup file strings from the SFTP server + */ + public ListThis method establishes an SSH connection to the configured server, authenticates + * with the provided username and password, and verifies the host key using a + * fingerprint from the configuration.
+ * + *Note: The returned SFTPClient does not maintain a current working directory. + * All file operations, such as upload or download, must use the full remote path, + * including the target directory. For example: + *
+ * sftp.put(localFilePath, remoteDir + "/" + remoteFileName); + *+ * + * + * @param sshClient The SSHClient used to connect to SFTP server + * @return an active SFTPClient connected to the remote server + * @throws IOException if the connection, authentication, or host key verification fails + */ + private SFTPClient connect(SSHClient sshClient) throws IOException { + + // Create verifier for host key from config + HostKeyVerifier verifier = new HostKeyVerifier() { + @Override + public boolean verify(String hostname, int port, PublicKey key) { + return true; + + // TODO: FIND A SOLUTION TO CHECK FINGERPRINTS, OR A WAY TO LOAD "BouncyCastle" + + /* + String actualFingerprint = SecurityUtils.getFingerprint(key); + return actualFingerprint.equals(fingerprint); + */ + } + + @Override + public List
This method ensures that both the SFTP session and the underlying SSH + * connection are properly terminated to avoid resource leaks.
+ * + * @param sftpClient the active SFTPClient to close; may be null + * @param sshClient the SSHClient associated with the SFTPClient; may be null + * @throws IOException if an error occurs while closing the SFTPClient or disconnecting the SSHClient + */ + private void disconnect(SFTPClient sftpClient, SSHClient sshClient) throws IOException { + + // close sftp client + if (sftpClient != null) { + sftpClient.close(); + } + + // disconnect ssh client + if (sshClient != null && sshClient.isConnected()) { + sshClient.disconnect(); + } + } +}