Skip to content

Improve rutracker_check updates for RuTracker and NNMClub #3048

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
IvanShift wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve rutracker_check updates for RuTracker and NNMClub #3048

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
263 changes: 244 additions & 19 deletions plugins/rutracker_check/check.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,24 @@ class ruTrackerChecker
const STE_ERROR = 6;
const STE_NOT_NEED = 7;
const STE_IGNORED = 8;

const MAX_LOCK_TIME = 900; // 15 min

private static $TRACKERS = array();
private static $ANNOUNCES = array();
private static $ANNOUNCES = array();

static public function registerTracker($commentFiler, $announceFilter, $handler)
/**
* Register a tracker handler.
*
* @param string $commentFilter Regex pattern for torrent comment
* @param string $announceFilter Regex pattern for announce URL list
* @param callable $handler Handler function: handler($url, $hash, $torrent)
*/
static public function registerTracker($commentFilter, $announceFilter, $handler)
{
if(!array_key_exists($commentFiler, self::$TRACKERS))
if(!array_key_exists($commentFilter, self::$TRACKERS))
{
self::$TRACKERS[$commentFiler] = $handler;
self::$TRACKERS[$commentFilter] = $handler;
self::$ANNOUNCES[] = $announceFilter;
}
}
Expand All @@ -46,6 +53,18 @@ static public function supportedTrackers()

static protected function setState( $hash, $state )
{
// First check if the torrent still exists in rTorrent
// This prevents "info-hash not found" errors when the torrent was already
// deleted (e.g., during replacement in createTorrent)
$checkReq = new rXMLRPCRequest( new rXMLRPCCommand( getCmd("d.hash"), $hash ) );
$checkReq->important = false;
if(!$checkReq->run() || $checkReq->fault)
{
// Torrent doesn't exist anymore, skip setting state
self::logDebug("setState: Torrent " . $hash . " not found, skipping state update");
return(true);
}

$req = new rXMLRPCRequest( array(
new rXMLRPCCommand( getCmd("d.set_custom"), array($hash, "chk-state", $state."") ),
new rXMLRPCCommand( getCmd("d.set_custom"), array($hash, "chk-time", time()."") )
Expand Down Expand Up @@ -76,17 +95,156 @@ static protected function getState( $hash, &$state, &$time, &$successful_time, &
$state = self::STE_INPROGRESS;
$time = time();
$successful_time = 0;
$label = "";
return(false);
}
}

// Build a list of relative file paths for a torrent (single-file or multi-file).
// Used to detect renamed/missing files when swapping torrents.
static private function collectTorrentPaths($torrent)
{
if(!is_object($torrent) || !isset($torrent->info))
return array();

$info = $torrent->info;
$paths = array();

// Multi-file mode
if(isset($info['files']) && is_array($info['files']))
{
// Note: We do NOT prepend $info['name'] (the torrent root folder) here,
// because d.get_directory_base already returns the path INCLUDING that folder.
// If we added it, we'd get: /base/FolderName/FolderName/file.mkv (duplicate)
foreach($info['files'] as $file)
{
if(!isset($file['path']) || !is_array($file['path']))
continue;

// Build relative path within the torrent folder (without the folder name prefix)
$rel = implode('/', $file['path']);
// Guard against path traversal
if(strpos($rel,'..')!==false)
continue;
$paths[] = $rel;
}
}
// Single-file mode
elseif(isset($info['name']))
{
if(strpos($info['name'],'..')===false)
$paths[] = $info['name'];
}

// Remove possible duplicates
return array_values(array_unique($paths));
}

// Helper function to remove empty subdirectories recursively
static private function removeEmptySubFolders($path, $baseAbs)
{
if(empty($path) || $path == $baseAbs)
return;

$dir = dirname($path);
// Ensure we're still inside the base directory
if(strpos(FileUtil::addslash($dir), $baseAbs) !== 0 || $dir == $baseAbs)
return;

if(is_dir($dir))
{
// scandir can return false (permissions, etc.), which causes TypeError in array_diff in PHP 8
$scanned = @scandir($dir);
if(is_array($scanned))
{
$files = array_diff($scanned, array('.', '..'));
if(empty($files))
{
@rmdir($dir);
// Recursively go up
self::removeEmptySubFolders($dir, $baseAbs);
}
}
}
}

// Remove files from the old torrent that are absent in the new one (to avoid duplicates after rename).
// Runs only after the new torrent is successfully loaded and the old one erased.
static private function cleanupObsoleteFiles($oldTorrent, $newTorrent, $baseDir)
{
self::logDebug("cleanupObsoleteFiles: Starting cleanup. BaseDir: " . $baseDir);

if(empty($baseDir) || !is_object($oldTorrent) || !is_object($newTorrent)) {
self::logDebug("cleanupObsoleteFiles: Invalid arguments or objects.");
return;
}

$oldPaths = self::collectTorrentPaths($oldTorrent);
if(empty($oldPaths)) {
self::logDebug("cleanupObsoleteFiles: No files found in old torrent.");
return;
}

$newPaths = self::collectTorrentPaths($newTorrent);
$missing = array_diff($oldPaths, $newPaths);

self::logDebug("cleanupObsoleteFiles: Old files count: " . count($oldPaths));
self::logDebug("cleanupObsoleteFiles: New files count: " . count($newPaths));
self::logDebug("cleanupObsoleteFiles: Missing files count: " . count($missing));

if(empty($missing)) {
self::logDebug("cleanupObsoleteFiles: No missing files to delete.");
return;
}

$baseAbs = FileUtil::addslash(FileUtil::fullpath($baseDir));
if(empty($baseAbs)) {
self::logDebug("cleanupObsoleteFiles: Could not resolve absolute base path.");
return;
}
self::logDebug("cleanupObsoleteFiles: Absolute base path: " . $baseAbs);

foreach($missing as $relPath)
{
// Build an absolute path inside the data directory and ensure it doesn't escape it.
$absolute = FileUtil::fullpath($relPath, $baseAbs);

// Security check
if(strpos(FileUtil::addslash($absolute), $baseAbs) !== 0) {
self::logDebug("cleanupObsoleteFiles: Security check failed for path: " . $absolute);
continue;
}

if(is_file($absolute))
{
self::logDebug("cleanupObsoleteFiles: Attempting to delete file: " . $absolute);
if(@unlink($absolute))
{
self::logDebug("cleanupObsoleteFiles: Successfully deleted: " . $absolute);
// Try to remove parent folder if it became empty
self::removeEmptySubFolders($absolute, $baseAbs);
} else {
self::logDebug("cleanupObsoleteFiles: Failed to delete file (unlink returned false): " . $absolute);
}
} else {
self::logDebug("cleanupObsoleteFiles: File not found or not a file: " . $absolute);
}
}
self::logDebug("cleanupObsoleteFiles: Cleanup finished.");
}

static public function createTorrent($torrent, $hash){
global $saveUploadedTorrents;
$torrent = new Torrent( $torrent );

if( $torrent->errors() ) return self::STE_DELETED;

if( $torrent->hash_info()==$hash ) return self::STE_UPTODATE;

// Keep the current torrent to compare file lists for cleanup after successful replacement.
// If loading the new torrent fails, the old files remain untouched.
$oldTorrent = rTorrent::getSource($hash);

$req = new rXMLRPCRequest( array(
new rXMLRPCCommand("d.get_directory_base",$hash),
new rXMLRPCCommand("d.get_custom1",$hash),
Expand All @@ -100,6 +258,7 @@ static public function createTorrent($torrent, $hash){
));

if($req->success()){
$baseDir = $req->val[0];
$addition = array(
getCmd("d.set_connection_seed=").$req->val[3],
getCmd("d.set_custom")."=chk-state,".self::STE_UPDATED,
Expand All @@ -109,15 +268,20 @@ static public function createTorrent($torrent, $hash){
$isStart = (($req->val[4]!=0) && ($req->val[5]!=0) && ($req->val[6]!=0));
if(!empty($req->val[2]))
$addition[] = getCmd("d.set_throttle_name=").$req->val[2];
if(preg_match('/rat_(\d+)/',$req->val[3],$ratio))
$addition[] = getCmd("view.set_visible=")."rat_".$ratio;
// Preserve ratio-group view if it was set (values like "rat_1", "rat_5" etc).
// Check if regex matched and index exists
if(preg_match('/rat_(\d+)/',$req->val[3],$ratio) && isset($ratio[1]))
$addition[] = getCmd("view.set_visible=")."rat_".$ratio[1];
$label = rawurldecode($req->val[1]);
if(rTorrent::sendTorrent($torrent, $isStart, false, $req->val[0],
if(rTorrent::sendTorrent($torrent, $isStart, false, $baseDir,
$label, $saveUploadedTorrents, false, true, $addition))
{
$req = new rXMLRPCRequest( new rXMLRPCCommand("d.erase", $hash ) );
if($req->success())
if($req->success()){
self::cleanupObsoleteFiles($oldTorrent, $torrent, $baseDir);
// Successful .torrent replacement: new torrent state is already set via $addition
return null;
}
}
}
return self::STE_ERROR;
Expand All @@ -126,33 +290,85 @@ static public function createTorrent($torrent, $hash){
static public function run_ex($hash, $fname){
$torrent = new Torrent( $fname );
if(!$torrent->errors()){
foreach (self::$TRACKERS as $key => $value)
// Get both announce URL and comment for matching
$announce = $torrent->announce();
$comment = $torrent->comment();

foreach (self::$TRACKERS as $pattern => $handler)
{
if( preg_match($key, $torrent->comment()) )
$matchedUrl = null;

// First check comment: usually contains topic URL (e.g., viewtopic.php?t=...)
if( preg_match($pattern, $comment) )
{
$matchedUrl = $comment;
}
// If not found in comment, try announce
elseif( preg_match($pattern, $announce) )
{
return call_user_func($value, $torrent->comment(), $hash, $torrent);
$matchedUrl = $announce;
}

if($matchedUrl !== null)
{
return call_user_func($handler, $matchedUrl, $hash, $torrent);
}
}
}
return self::STE_NOT_NEED;
}

/**
* Simple plugin logger.
* Writes to /tmp/rutracker_check.log
*/
static public function logDebug($message)
{
$logFile = '/tmp/rutracker_check.log';
$logDir = dirname($logFile);

// Protection: verify permissions before attempting to write
$canWrite = file_exists($logFile) ? is_writable($logFile) : is_writable($logDir);

if($canWrite)
{
$line = '[' . gmdate('Y-m-d H:i:s') . '] ' . $message . PHP_EOL;
@file_put_contents($logFile, $line, FILE_APPEND);
}
}

static public function makeClient( $url, $method="GET", $content_type="", $body="" )
{
$client = new Snoopy();
$client->read_timeout = 5;
$client->_fp_timeout = 5;
@$client->fetchComplex($url,$method,$content_type,$body);
return($client);
$client->_fp_timeout = 5;

// Pretend to be a modern browser to reduce 403/anti-bot errors
$client->agent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) "
. "AppleWebKit/537.36 (KHTML, like Gecko) "
. "Chrome/120.0.0.0 Safari/537.36";

// Suppress Snoopy errors with @, but log status on failure
@$client->fetchComplex($url, $method, $content_type, $body);

// Convention: plugins consider status < 0 as "tracker unreachable"
if($client->status < 0)
{
self::logDebug("Snoopy fetch failed: url=".$url." status=".$client->status);
}

return $client;
}

static public function run( $hash, $state = null, $time = null, $successful_time = null, $label = null )
{
global $ignoreLabels;

if(is_null($state)) self::getState( $hash, $state, $time, $successful_time, $label );

if (!is_null($label) && in_array($label, $ignoreLabels)) {

// Skip torrent if its label is in the ignore list
if(!is_null($label) && isset($ignoreLabels) && is_array($ignoreLabels) && in_array($label, $ignoreLabels))
{
$state = self::STE_IGNORED;
self::setState($hash, $state);
return(true);
Expand All @@ -164,7 +380,16 @@ static public function run( $hash, $state = null, $time = null, $successful_time
$state = self::STE_INPROGRESS;
if(!self::setState( $hash, $state )) return(false);

$fname = rTorrentSettings::get()->session.$hash.".torrent";
// Main path: via rTorrentSettings
if(class_exists('rTorrentSettings') && method_exists('rTorrentSettings', 'get'))
{
$fname = rTorrentSettings::get()->session.$hash.".torrent";
}
else
{
// Fallback for non-standard configurations
$fname = getSettingsPath().'/session/'.$hash.".torrent";
}

if(is_readable($fname)) $state = self::run_ex($hash, $fname);
if($state==self::STE_INPROGRESS) $state=self::STE_ERROR;
Expand Down
Loading