Skip to content

Ratio plugin: gate group.*.set call shape by rtorrent version #3071

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

Merged
xirvik merged 1 commit into from
Jun 26, 2026
+20 −28
Merged

Ratio plugin: gate group.*.set call shape by rtorrent version #3071

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
38 changes: 17 additions & 21 deletions php/settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,6 @@ class rTorrentSettings

static private $theSettings = null;

private $ratioCmds = array
(
"view",
"view.set",
"ratio.min",
"ratio.min.set",
"ratio.max",
"ratio.max.set",
"ratio.upload",
"ratio.upload.set",
);

private function __construct()
{
if( array_key_exists("browser_timezone",$_COOKIE) )
Expand Down Expand Up @@ -315,16 +303,24 @@ public function getCommand($cmd)
}
public function getRatioGroupCommand($ratio,$cmd,$args)
{
// rtorrent 0.16 removed the group2.* aliases (deprecated and gated
// behind method.use_deprecated, which on 0.16.14+ cannot be enabled
// from the rc file — only via the -D launch flag). Use group.* for
// every cmd on 0.16+; the older split is kept for pre-0.16 slots.
if($this->iVersion >= 0x1000) {
$prefix = "group.";
} else {
$prefix = ($this->iVersion >= 0x904) && in_array($cmd,$this->ratioCmds) ? "group2." : "group.";
// Use group.* on every rtorrent. group2.* was a transient alias
// experiment: stubbed (non-functional) on 0.15.x and removed in
// 0.16. The canonical group.* commands work across the version
// range we care to support.
//
// rtorrent 0.16+ tightened the signature on group.NAME.*.set:
// it strictly requires (target_string, value), and rejects a
// bare value with "invalid parameters: target must be a string".
// 0.15.x is the opposite — strictly takes the bare value and
// rejects (target, value) with "Wrong object type". Adapt the
// args automatically by rtorrent version so callers do not
// have to track which signature applies.
if(($this->iVersion >= 0x1000) && (substr($cmd, -4) === ".set"))
{
if(!is_array($args)) $args = array($args);
array_unshift($args, "");
}
return( new rXMLRPCCommand( $prefix.$ratio.".".$cmd, $args ) );
return( new rXMLRPCCommand( "group.".$ratio.".".$cmd, $args ) );
}
public function getEventCommand($cmd1,$cmd2,$args)
{
Expand Down
10 changes: 3 additions & 7 deletions plugins/ratio/ratio.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,9 @@ public function flush()
if($this->isCorrect($i))
{
$req->addCommand( rTorrentSettings::get()->getRatioGroupCommand("rat_".$i,'ratio.enable',array("")) );
// rtorrent 0.16+ requires (target, value) for group.*.ratio.*.set;
// pre-0.16 group2.* aliases tolerated a single scalar param. Always
// prepend the empty-string target so the call shape matches the
// strict 0.16 signature on every supported rtorrent.
$req->addCommand( rTorrentSettings::get()->getRatioGroupCommand("rat_".$i,'ratio.min.set',array("",$rat["min"])) );
$req->addCommand( rTorrentSettings::get()->getRatioGroupCommand("rat_".$i,'ratio.max.set',array("",$rat["max"])) );
$req->addCommand( rTorrentSettings::get()->getRatioGroupCommand("rat_".$i,'ratio.upload.set',array("",floatval($rat["upload"]*1024*1024*1024))) );
$req->addCommand( rTorrentSettings::get()->getRatioGroupCommand("rat_".$i,'ratio.min.set',$rat["min"]) );
$req->addCommand( rTorrentSettings::get()->getRatioGroupCommand("rat_".$i,'ratio.max.set',$rat["max"]) );
$req->addCommand( rTorrentSettings::get()->getRatioGroupCommand("rat_".$i,'ratio.upload.set',floatval($rat["upload"]*1024*1024*1024)) );
switch($rat["action"])
{
case RAT_STOP:
Expand Down