ladderr
Access your remote files directly from qBittorrent Web UI, just like in the desktop app.
Current version: v0.5.8
💥 You will need to re-install the latest ladderr.reg if you had a version prior to v0.5.4 💥
⚠️ The script is enabled on all pages by default. See section below if you want to change this ⚠️
⚠️ There's a bug in Windows that keeps explorer.exe processes open even after closing their respective window, if you never restart your machine you may be filling your RAM inadvertently. This issue seems to be fixed in the 24H2 update (see related issue) ⚠️
How does it work?
By leveraging protocol handlers, a File Explorer window can be opened directly
to a specified network path.
After mapping your remote and local path in the script settings, Ladderr can create a
protocol link pointing to your local files (by using information that's already available
in the Web UI). When opening a file or folder (by using the Open destination folder,
Open or Open containing folder menu items or by double-clicking the file or folder
in the Content tab), the protocol is invoked and an inline Powershell script is executed
to parse and open the target path.
The files in this repo:
- ladderr.js: the userscript itself
- ladderr.reg: the custom protocol handlers
ladderr-open: and ladderr-select:
- uninstall-ladderr.reg: removes the protocol handlers from the registry
- urlparser.ps1: Powershell script describing the one-line code that is executed when the protocols are invoked
To learn more about protocol handlers, you can read MS-URI-Handlers.
How to use
Path mapping
We need to map your qBittorrent remote root path to your local network root path.
This can be done by going to the Tools navbar menu and clicking Ladderr Options.
The remote path should be the root folder that you configured
in Default Save Path (Options\Downloads\Saving Management) and your local root
path the equivalent in your local machine.
For example, if you have a network location:
- Default Save Path:
/data/downloads
- Remote root server path:
/data/
- Local root path:
D:\
And if you have an NFS\SMB\Samba server:
- Default Save Path:
/downloads
- Remote root server path:
/downloads
- Local root path:
\\server_name_or_ip\very\long\path\downloads
What's next
- Linux support (any help would be appreciated).
Limitations
- Only works in Windows.
- In Chromium-based browsers, and when using HTTP, it will ask for permission when opening a new file/folder. For a more seamless experience, use HTTPS. If your server is local, look up self-signed certs with mkcert, or use this solution.
Security concerns
Since everyone's Web UI will have a different URL, the script is active on all pages by default.
There's a check to detect when the page is a qBittorrent Web UI but to be safe you should change this.
For Tapermonkey:
- Go to your
Dashboard.
- Hover over the Ladderr entry and click the
Edit button in the rightmost column.
- Go to the
Settings tab (left side below the Ladderr logo).
- Deselect
Original matches in the Includes/Excludes section.
- Add your qBittorrent Web UI URL by clicking
Add... below the User matches box.
For Violentmonkey:
- Go to your
Dashboard (⚙️ icon).
- Hover over the Ladderr entry and click the
Edit button (</> icon).
- Go to the
Settings tab.
- Deselect
Keep original under @match rules.
- Add your qBittorrent Web UI URL in the adjacent text box.
Alternatively, if your extension doesn't allow this, you can do it manually:
- Remove the following lines:
// @match https://*/ and // @match http://*/.
- Add your custom URL. For example:
// @match https://192.168.1.100:8080/ or // @match http://myserver.local/.
Unfortunately, if done manually, you'll have to redo this with each update.
Recent changes
Version 0.5
- Fix RCE vulnerability.
- Add unicode support and fix issue with whitespaces.
- 0.5.1: Fix for paths with depth (relative to the base path).
- 0.5.2: Fix for paths containing commas.
- 0.5.3: Fix for certain unicode characters.
- 0.5.4: Fix for paths longer than 259 characters.
- 0.5.5: Fix for Chromium browsers when opening a file/folder for the first time.
- 0.5.6: Fix for qBittorrent 5.0 Web UI changes.
- 0.5.7: Added ability to open parent folders of uninitialized files and folders.
- 0.5.8: Added ability to open files and folders directly from the torrent list by double-clicking (see the settings menu).
Version 0.4
- Powershell popup window no longer appears.
- New browser window/tab closes itself immediately after opening a file/folder.
- Removed dependency from Python by replacing it with Powershell.
Version 0.3
- Added ability to open files and folders by double-clicking (in the
Content tab).
Version 0.2
- Added
Open and Open containing folder in the Content tab.
- Technical: splitted URI protocol into
ladderr-open: and ladderr-select: to allow opening files directly.
