├── README.md
├── extract.py
└── extras
    ├── radarr_cleanup
    └── sonarr_cleanup


/README.md:
--------------------------------------------------------------------------------
 1 | # tExtractor
 2 | Extract torrents upon completion.
 3 | 
 4 | The script will recursively scan the `<download_location>/<torrent_name>` folder for compressed archives and extract them to `<download_location>/<torrent_name>/__extracted` (it will also scan the `__extracted` directory for any additional compressed archives and extract them into the same directory).
 5 | 
 6 | ## Help
 7 | 
 8 | The extract.py script has 5 parameters:
 9 | 
10 | Positional parameters:
11 | - Postion 1: torrent hash/id - currently not used
12 | - Postion 2: the torrent name
13 | - Postion 3: the download location
14 | 
15 | Optional parameters:
16 | - -t DIR / --tmp DIR: Specify a custom temporary directory to perform extraction into. NOTE: DIR must exist.
17 | - -v / --verbose: debug output
18 | 
19 | 
20 | ## Usage
21 | While this setup works with most torrent clients, I'll demonstrate the setup with Deluge:
22 | 
23 | - Fist make sure you have the `Execute` plugin installed
24 | - Then add a new event on `Torrent Completed` and then enter the location of extract.py in the command box
25 | - Restart Deluge for settings to take effect
26 | 
27 | The execute plugin will run any script with the paramters `<script> torrent_id torrent_name download_location`, but you don't need to enter the paramters here
28 | 
29 | ## Extras
30 | In the folder `extras` within this repository you'll find `sonarr_cleanup` and `radarr_cleanup`. 
31 | 
32 | To use these scripts setup Sonarr/Radarr via Settings->Connect->Add Connection:
33 | ```
34 | Name: Cleanup after processing
35 | On Grab: No
36 | On Download: Yes
37 | On Upgrade: Yes
38 | On Rename: No
39 | Filter Movie Tags: N/A
40 | Path: /path/to/script/location`
41 | ```
42 | This will check and delete the `__extracted` folder if Sonarr/Radarr grabbed the media item from there.
43 | 


--------------------------------------------------------------------------------
/extract.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/python3
  2 | 
  3 | import os
  4 | import logging
  5 | import tempfile
  6 | import argparse
  7 | import subprocess
  8 | import shutil
  9 | 
 10 | EXTRACT_DIR = '__extracted'
 11 | EXTRACTED_FILES = []
 12 | COMMANDS = {'.rar': 'unrar -r -o- e',
 13 |             '.001': 'unrar -r -o- e',
 14 |             '.zip': 'unzip -u -d'
 15 |             }
 16 | 
 17 | 
 18 | def find_files(path):
 19 |     found_files = []
 20 | 
 21 |     for dirpath, dirnames, filenames in os.walk(path):
 22 |         for filename in filenames:
 23 |             file_path = os.path.join(dirpath, filename)
 24 |             filename, ext = os.path.splitext(file_path)
 25 | 
 26 |             if ext in COMMANDS.keys() and file_path not in EXTRACTED_FILES:
 27 |                 logger.debug('Accepted: {0}'.format(os.path.basename(file_path)))
 28 |                 EXTRACTED_FILES.append(file_path)
 29 |                 found_files.append(file_path)
 30 | 
 31 |     return found_files
 32 | 
 33 | 
 34 | def extract(paths, out_dir):
 35 |     for p in paths:
 36 |         logger.info('Extracting: {0}'.format(p))
 37 | 
 38 |         filename, ext = os.path.splitext(p)
 39 |         cmd = COMMANDS.get(ext)
 40 | 
 41 |         util = cmd.split()[0]
 42 |         exec_path = shutil.which(util)
 43 |         if not exec_path:
 44 |             logger.error('Cant find executable {0}, not extracting {1}'.format(util, p))
 45 |             continue
 46 | 
 47 |         cmd = cmd.replace(util, exec_path)
 48 | 
 49 |         command = '{0} {1} {2}'.format(cmd, p, out_dir)
 50 |         logger.debug('Command: {0}'.format(command))
 51 | 
 52 |         subprocess.run(command.split())
 53 | 
 54 | 
 55 | def find_path(path, name):
 56 |     path = os.path.join(path, name)
 57 | 
 58 |     if os.path.isdir(path):
 59 |         return os.path.join(path, EXTRACT_DIR)
 60 | 
 61 |     return False
 62 | 
 63 | 
 64 | def main(args):
 65 |     orig_dir = os.path.join(args.path, args.name)
 66 |     logger.debug('Processing directory: {0}'.format(orig_dir))
 67 |     out_dir = find_path(args.path, args.name)
 68 |     if args.tmp:
 69 |         try:
 70 |             temp_dir = tempfile.mkdtemp(dir=args.tmp)
 71 |         except:
 72 |             logger.warning('Failed to create temporary extraction directory in specified location. Falling back to system default.')
 73 |             temp_dir = tempfile.mkdtemp()
 74 |     else:
 75 |         temp_dir = tempfile.mkdtemp()
 76 | 
 77 |     logger.debug('Using temporary extraction directory: {0}'.format(temp_dir))
 78 | 
 79 |     # no out_dir means this is a single file torrent
 80 |     if out_dir:
 81 |         logger.info('Output directory: {0}'.format(out_dir))
 82 | 
 83 |         files = find_files(orig_dir)
 84 | 
 85 |         # extact compressed archives found in the original path
 86 |         if files:
 87 |             logger.debug('Files in original path: {0}'.format(files))
 88 | 
 89 |             extract(files, temp_dir)
 90 | 
 91 |             # extract (also nested) archives found in the output path, if we found files in the original path
 92 |             while files:
 93 |                 files = find_files(temp_dir)
 94 | 
 95 |                 if files:
 96 |                     logger.debug('Files in output path: {0}'.format(files))
 97 |                     extract(files, temp_dir)
 98 |                 else:
 99 |                     logger.info('Finished processing directory: {0}'.format(orig_dir))
100 | 
101 |             if not os.path.exists(out_dir):
102 |                 os.mkdir(out_dir)
103 | 
104 |             logger.debug('Moving files from temporary directory: {0} to: {1}'.format(temp_dir, out_dir))
105 | 
106 |             for f in os.listdir(temp_dir):
107 |                 logger.debug('Moving file: {0} to: {1}'.format(f, out_dir))
108 |                 shutil.move(os.path.join(temp_dir, f), out_dir)
109 | 
110 |     else:
111 |         logger.warning('This must be a single file torrent, exiting!')
112 | 
113 |     if temp_dir:
114 |         logger.debug('Removing temporary directory: {0}'.format(temp_dir))
115 |         try:
116 |             shutil.rmtree(temp_dir, ignore_errors=True)
117 |         except:
118 |             logger.warning('Failed to remove temporary extraction directory: {0}'.format(temp_dir))
119 | 
120 | 
121 | if __name__ == "__main__":
122 |     parser = argparse.ArgumentParser()
123 |     parser.add_argument('id', type=str, help="The HASH/ID of the torrent")
124 |     parser.add_argument('name', type=str, help="The name of the torrent")
125 |     parser.add_argument('path', type=str, help="Absolute path to the root download location")
126 |     parser.add_argument("-t", "--tmp", help="Absolute path to temp extraction directory (must exist)")
127 |     parser.add_argument("-v", "--verbose", help="Set loglevel to debug", action="store_true")
128 |     args = parser.parse_args()
129 | 
130 | 
131 |     logger = logging.getLogger()
132 |     handler = logging.StreamHandler()
133 |     formatter = logging.Formatter('%(asctime)s %(levelname)-8s %(message)s')
134 |     handler.setFormatter(formatter)
135 |     logger.addHandler(handler)
136 |     if args.verbose:
137 |         logger.setLevel(logging.DEBUG)
138 |     else:
139 |         logger.setLevel(logging.INFO)
140 | 
141 |     main(args)
142 | 


--------------------------------------------------------------------------------
/extras/radarr_cleanup:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | if [ -d "$radarr_moviefile_sourcefolder" ] && [ "$(basename $radarr_moviefile_sourcefolder)" = "__extracted" ] ; then
3 |     /bin/rm -rf "$radarr_moviefile_sourcefolder"
4 | fi
5 | 


--------------------------------------------------------------------------------
/extras/sonarr_cleanup:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | 
3 | if [ -d "$sonarr_episodefile_sourcefolder" ] && [ "$(basename $sonarr_episodefile_sourcefolder)" = "__extracted" ] ; then
4 |     /bin/rm -rf "$sonarr_episodefile_sourcefolder"
5 | fi
6 | 


--------------------------------------------------------------------------------