#symlink #file #regex #torrent

app tormov

TORrent MOVer, a simple tool to move (or link) regexed folders with no incomplete files

6 releases

Uses old Rust 2015

0.3.1 Feb 17, 2020
0.3.0 Feb 17, 2020
0.2.2 Oct 16, 2017
0.1.1 Sep 14, 2017

#1222 in Command line utilities

27 downloads per month

MIT license

13KB
175 lines

TORMOV

legal

Crate cratedown cratelastdown

tag release commitssince

TORrentMOVer

Simple script program to move completed torrents to specific folders.

Sometimes it's easy to let torrent download files to a generic directory and then move it afterwards. This program automates this task by:

  1. Looking for RegEx patterns in the folder. You can specify exactly which folder/file to handle.
  2. Checking if the downloads are completed. Every file (if there are more than one) must be completed.
  3. Moving or linking the file/folder to the designated directory.

The program is written in Rust so it's very quick and light on your system. The source code is very small so you can check yourself what it does in few moments.

Installation

  1. Make sure to have Rust installed. Grab it here https://www.rust-lang.org/en-US/ if you don't have it. This program is tested with rustc nightly but it should work with others versions too (I'm too lazy to test it myself, sorry 😄 ).
  2. Install the tool with cargo install tormov. This will install the latest published version. If you want the master branch use cargo install --git https://github.com/MindFlavor/tormov instead.
  3. type tormov in the console to test the program execution. You'll get an error because of missing parameters. We'll cover them in the next section.

Parameters

TORMOV expects, from the command line, two parameters:

  1. Configuration file.
  2. Folder to analyze.

So, for example, if you have a configuration file called tormov_config.json and you want to check the /var/lib/transmission-daemon/downloads/ you can write:

$ tormov tormov_config.json /var/lib/transmission-daemon/downloads/

Configuration file

A sample configuration file is available here: example_config.json. The format, however, is simple.

{
    "skipextension": "part",
    "matches": [
        {
            "regex": "Arrow",
            "destination": "/mnt/shows/Arrow",
	    "action": "Move"
        },
        {
            "regex": "Big.Bang",
            "destination": "/mnt/shows/The.big.bang.theory",
	    "action": "Move"
        },
        {
            "regex": "Marvels.Agents.of.S.H.I.E.L.D.*",
            "destination": "/mnt/shows/agents_of_the_shield",
	    "action": "Link"
        }
    ]
}

skipextension

skipextension is the extension appended whenever the file is not ready. Most torrent clients use part or incomplete but make sure to specify the right one.

matches

The matches section is an array of entries you want to check. Each entry must have:

  1. A regular expression to match in the field regex.
  2. A destination in the destination field. The destination is where the file/folder will be moved if the contents have been completely downloaded (that is, there is no file with skipextension anywhere in the folder).
  3. An action to perform in case all the rules match. The supported actions are Move or Link. The latter will create a symbolic link instead of moving the file. Note: right now linking is supported only on Linux, if you need Windows please drop a line.

Scheduling

While TORMOV does not have a scheduler it's fairly easy to automate it with cron jobs or systemd. For example with systemd you can schedule it creating two files. The first is tormov.service with these contents:


[Unit]
Description=TORrent MOVer

[Service]
ExecStart=<full TORMOV bin path> <config> <folder>

And another one called tormow.timer with the schedule:


[Unit]
Description=Runs tormov every minute

[Timer]
OnBootSec=5min
OnUnitActiveSec=1min

Unit=tormov.service

[Install]
WantedBy=timers.target

Now simply start end optionally enable the timer with:


$ sudo systemctl start tormov.timer
$ sudo systemctl enable tormov.timer

You can then check the output with sudo systemctl status tormov.service as usual.

Dependencies

~2.8–4.5MB
~85K SLoC