Skip to content

fix(userTransfer): honour .rtorrentDisable opt-out on post-transfer restart (Refs #869) #929

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
Shabbir7890 wants to merge 2 commits into
base: main
Choose a base branch
from
+38 −0
Open

fix(userTransfer): honour .rtorrentDisable opt-out on post-transfer restart (Refs #869) #929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
681e28d
fix(userTransfer): honour .rtorrentDisable opt-out on post-transfer r…
Shabbir7890 Sep 9, 2026
b53e814
test(userTransfer): cover the .rtorrentDisable opt-out on the post-tr…
Shabbir7890 Sep 26, 2026
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
29 changes: 29 additions & 0 deletions scripts/lib/tests/development/userTransferTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,35 @@ public function testRewriteRtorrentSessionPathsReportsWhenNothingNeedsRewrite():
$this->assertStringContainsString('[INFO] rTorrent session rewrite found no /home path references to update', $output);
}

public function testRequestRtorrentRestartSkipsWhenUserOptedOut(): void
{
$home = $this->pmssMakeUserWebHome('pmss-userTransfer-rtorrent-optout-', 'newuser');
$this->pmssWriteFile($home.'/.rtorrentDisable', '');
$logDir = $this->pmssEnsureDir($this->pmssMakeTempDir('pmss-userTransfer-optout-logs-'));

list(, $output) = $this->pmssCaptureStdout(function () use ($home): void {
\pmssUserTransferRequestRtorrentRestart($home, 'newuser');
}, ['PMSS_DRY_RUN' => '1', 'PMSS_LOG_DIR' => $logDir]);

// The opt-out is honoured: the skip is logged and no restart marker is requested.
$this->assertStringContainsString('[INFO] Skipping rTorrent restart: user opted out via .rtorrentDisable', $output);
$this->assertStringNotContainsString('Requesting rTorrent restart marker', $output);
}

public function testRequestRtorrentRestartRequestsMarkerWithoutOptOut(): void
{
$home = $this->pmssMakeUserWebHome('pmss-userTransfer-rtorrent-restart-', 'newuser');
$logDir = $this->pmssEnsureDir($this->pmssMakeTempDir('pmss-userTransfer-restart-logs-'));

list(, $output) = $this->pmssCaptureStdout(function () use ($home): void {
\pmssUserTransferRequestRtorrentRestart($home, 'newuser');
}, ['PMSS_DRY_RUN' => '1', 'PMSS_LOG_DIR' => $logDir]);

// Control: without the marker the restart is requested as before.
$this->assertStringContainsString('Requesting rTorrent restart marker', $output);
$this->assertStringNotContainsString('user opted out via .rtorrentDisable', $output);
}

public function testRtorrentRestartScriptUsesLiveUserProcessFallback(): void
{
$this->pmssAssertRepoFileContainsAllStrings('etc/skel/.rtorrentRestart.php', [
Expand Down
9 changes: 9 additions & 0 deletions scripts/lib/userTransfer/postSetup.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,15 @@ function pmssUserTransferRenameRutorrentShare(string $home, string $remoteUser,

function pmssUserTransferRequestRtorrentRestart(string $home, string $localUser): void
{
// Respect the per-user rTorrent opt-out (GH#470, GH#869): `.rtorrentDisable`
// means "stop and stay stopped". checkRtorrent honours it on every cron
// cycle, so restarting here would only be undone within a few minutes while
// needlessly reloading the migrated session against the user's wishes. Skip.
if (is_file(rtrim($home, '/').'/.rtorrentDisable')) {
logMessage('[INFO] Skipping rTorrent restart: user opted out via .rtorrentDisable');
return;
}

$wwwDir = $home.'/www';
if (!is_dir($wwwDir) || is_link($wwwDir) || !pmssUserTransferIsPathWithinHome($wwwDir, $home)) {
logMessage('[WARN] Skipping rTorrent restart marker (www dir missing or unsafe)');
Expand Down
Loading