Skip to content

feat: ftp server support custom data transfer port in passive mode. #1131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: ftp server support custom data transfer port in passive mode. #1131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions app/src/main/java/me/zhanghai/android/files/ftpserver/FtpServer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ package me.zhanghai.android.files.ftpserver

import java8.nio.file.Path
import org.apache.ftpserver.ConnectionConfigFactory
import org.apache.ftpserver.DataConnectionConfigurationFactory
import org.apache.ftpserver.FtpServer
import org.apache.ftpserver.FtpServerFactory
import org.apache.ftpserver.ftplet.FtpException
Expand All @@ -18,6 +19,7 @@ class FtpServer(
private val username: String,
private val password: String?,
private val port: Int,
private val passiveDataPorts: String?,
private val homeDirectory: Path,
private val writable: Boolean
) {
Expand All @@ -28,8 +30,15 @@ class FtpServer(
server = FtpServerFactory()
.apply {
val listener = ListenerFactory()
.apply { port = this@FtpServer.port }
.createListener()
.apply {
port = this@FtpServer.port
passiveDataPorts?.let {
dataConnectionConfiguration = DataConnectionConfigurationFactory()
.apply {
passivePorts = it
}.createDataConnectionConfiguration()
}
}.createListener()
addListener("default", listener)
val user = BaseUser().apply {
name = username
Expand Down
10 changes: 5 additions & 5 deletions app/src/main/java/me/zhanghai/android/files/ftpserver/FtpServerService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,12 @@ class FtpServerService : Service() {
password = Settings.FTP_SERVER_PASSWORD.valueCompat
}
val port = Settings.FTP_SERVER_PORT.valueCompat
val passiveDataPort: String? = if (Settings.FTP_SERVER_CUSTOM_DATA_PORT.valueCompat) {
Settings.FTP_SERVER_DATA_PORT.valueCompat
} else null
val homeDirectory = Settings.FTP_SERVER_HOME_DIRECTORY.valueCompat
val writable = Settings.FTP_SERVER_WRITABLE.valueCompat
val server = FtpServer(username, password, port, homeDirectory, writable)
val server = FtpServer(username, password, port, passiveDataPort, homeDirectory, writable)
this.server = server
try {
server.start()
Expand Down Expand Up @@ -153,9 +156,6 @@ class FtpServerService : Service() {
}

enum class State {
STARTING,
RUNNING,
STOPPING,
STOPPED
STARTING, RUNNING, STOPPING, STOPPED
}
}
11 changes: 11 additions & 0 deletions app/src/main/java/me/zhanghai/android/files/settings/Settings.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,17 @@ object Settings {
R.string.pref_key_ftp_server_port, R.integer.pref_default_value_ftp_server_port
)

val FTP_SERVER_CUSTOM_DATA_PORT: SettingLiveData<Boolean> =
BooleanSettingLiveData(
R.string.pref_key_ftp_server_custom_data_port,
R.bool.pref_default_value_ftp_server_custom_data_port
)

val FTP_SERVER_DATA_PORT: SettingLiveData<String> =
StringSettingLiveData(
R.string.pref_key_ftp_server_data_port, R.string.pref_default_value_ftp_server_data_port
)

val FTP_SERVER_HOME_DIRECTORY: SettingLiveData<Path> =
ParcelValueSettingLiveData(
R.string.pref_key_ftp_server_home_directory,
Expand Down
2 changes: 2 additions & 0 deletions app/src/main/res/values-zh-rCN/strings.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,6 +581,8 @@
<string name="ftp_server_username_title">用户名</string>
<string name="ftp_server_password_title">密码</string>
<string name="ftp_server_port_title">端口</string>
<string name="ftp_server_custom_data_port_title">自定义被动模式数据端口范围</string>
<string name="ftp_server_data_port_title">数据端口范围</string>
<string name="ftp_server_home_directory_title">根文件夹</string>
<string name="ftp_server_writable_title">允许写入</string>

Expand Down
4 changes: 4 additions & 0 deletions app/src/main/res/values/donottranslate_prefs.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
<string name="pref_key_ftp_server_password">key_ftp_server_password</string>
<string name="pref_key_ftp_server_port">key_ftp_server_port</string>
<integer name="pref_default_value_ftp_server_port">2121</integer>
<string name="pref_key_ftp_server_custom_data_port">key_ftp_server_custom_data_port</string>
<bool name="pref_default_value_ftp_server_custom_data_port">false</bool>
<string name="pref_key_ftp_server_data_port">key_ftp_server_data_port</string>
<string name="pref_default_value_ftp_server_data_port">1024-65535</string>
<string name="pref_key_ftp_server_home_directory">key_ftp_server_home_directory</string>
<string name="pref_key_ftp_server_writable">key_ftp_server_writable</string>
<bool name="pref_default_value_ftp_server_writable">true</bool>
Expand Down
2 changes: 2 additions & 0 deletions app/src/main/res/values/strings.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,8 @@
<string name="ftp_server_username_title">Username</string>
<string name="ftp_server_password_title">Password</string>
<string name="ftp_server_port_title">Port</string>
<string name="ftp_server_custom_data_port_title">Using custom passive data ports</string>
<string name="ftp_server_data_port_title">Data Port Range</string>
<string name="ftp_server_home_directory_title">Root folder</string>
<string name="ftp_server_writable_title">Allow writing</string>
<string name="ftp_server_notification_title" translatable="false">@string/ftp_server_title</string>
Expand Down
16 changes: 14 additions & 2 deletions app/src/main/res/xml/ftp_server.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
~ All Rights Reserved.
-->

<PreferenceScreen
<androidx.preference.PreferenceScreen
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto">

Expand Down Expand Up @@ -51,6 +51,18 @@
android:defaultValue="@integer/pref_default_value_ftp_server_port"
app:useSimpleSummaryProvider="true" />

<SwitchPreferenceCompat
android:key="@string/pref_key_ftp_server_custom_data_port"
android:title="@string/ftp_server_custom_data_port_title"
android:defaultValue="@bool/pref_default_value_ftp_server_custom_data_port" />

<me.zhanghai.android.files.settings.DefaultIfEmptyEditTextPreference
android:key="@string/pref_key_ftp_server_data_port"
android:title="@string/ftp_server_data_port_title"
android:defaultValue="@string/pref_default_value_ftp_server_data_port"
android:dependency="@string/pref_key_ftp_server_custom_data_port"
app:useSimpleSummaryProvider="true" />

<me.zhanghai.android.files.ftpserver.FtpServerHomeDirectoryPreference
android:key="@string/pref_key_ftp_server_home_directory"
android:title="@string/ftp_server_home_directory_title"
Expand All @@ -61,4 +73,4 @@
android:title="@string/ftp_server_writable_title"
android:defaultValue="@bool/pref_default_value_ftp_server_writable" />
</PreferenceCategory>
</PreferenceScreen>
</androidx.preference.PreferenceScreen>