├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── 1_bug_report.md │ ├── 2_enhancement_request.md │ └── 3_question.md └── PULL_REQUEST_TEMPLATE.md ├── .gitignore ├── DirWatch.py ├── LICENSE ├── README.md └── requirements.txt /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: caronc 2 | custom: ['https://www.paypal.me/lead2gold', ] 3 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/1_bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: 🐛 Bug Report 3 | about: Report any errors and problems 4 | title: '' 5 | labels: 'bug' 6 | assignees: '' 7 | 8 | --- 9 | 10 | :beetle: **Describe the bug** 11 | 12 | 13 | :bulb: **Screenshots and Logs** 14 | 15 | 16 | 17 | :computer: **Your System Details:** 18 | - OS: [e.g. RedHat v8.0] 19 | - Python Version: [e.g. Python v2.7] 20 | 21 | :crystal_ball: **Additional context** 22 | Add any other context about the problem here. 23 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/2_enhancement_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: 💡 Enhancement Request 3 | about: Got a great idea? Let us know! 4 | title: '' 5 | labels: 'enhancement' 6 | assignees: '' 7 | 8 | --- 9 | 10 | :bulb: **The Idea** 11 | 12 | 13 | :hammer: **Breaking Feature** 14 | 16 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/3_question.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: ❓ Support Question 3 | about: Ask a question about NZBGet-DirWatch 4 | title: '' 5 | labels: 'question' 6 | assignees: '' 7 | 8 | --- 9 | 10 | :question: **Question** 11 | 12 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Description: 2 | **Related issue (if applicable):** # 3 | 4 | 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | local_settings.py 55 | 56 | # Flask stuff: 57 | instance/ 58 | .webassets-cache 59 | 60 | # Scrapy stuff: 61 | .scrapy 62 | 63 | # Sphinx documentation 64 | docs/_build/ 65 | 66 | # PyBuilder 67 | target/ 68 | 69 | # IPython Notebook 70 | .ipynb_checkpoints 71 | 72 | # pyenv 73 | .python-version 74 | 75 | # celery beat schedule file 76 | celerybeat-schedule 77 | 78 | # dotenv 79 | .env 80 | 81 | # virtualenv 82 | venv/ 83 | ENV/ 84 | 85 | # Spyder project settings 86 | .spyderproject 87 | 88 | # Rope project settings 89 | .ropeproject 90 | -------------------------------------------------------------------------------- /DirWatch.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- encoding: utf-8 -*- 3 | # 4 | # DirWatch scan script for NZBGet to move nzb files detected elsewhere 5 | # into NZBGet's file queue for processing. 6 | # 7 | # Copyright (C) 2017-2020 Chris Caron 8 | # 9 | # This program is free software; you can redistribute it and/or modify it 10 | # under the terms of the GNU Lesser General Public License as published by 11 | # the Free Software Foundation; either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU Lesser General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU Lesser General Public License 20 | # along with subliminal. If not, see . 21 | # 22 | ############################################################################## 23 | ### TASK TIME: * ### 24 | ############################################################################## 25 | ############################################################################## 26 | ### NZBGET SCHEDULER SCRIPT ### 27 | 28 | # The script searches the paths you tell it to for NZB-Files. If one is found 29 | # it is moved automatically for into the NZBGet incoming path for downloading. 30 | # 31 | # Info about this DirWatch NZB Script: 32 | # Author: Chris Caron (lead2gold@gmail.com). 33 | # Date: Tue, Sep 8th, 2020. 34 | # License: GPLv3 (http://www.gnu.org/licenses/gpl.html). 35 | # Script Version: 0.6.0 36 | # 37 | # The script takes a series of directories you want to monitor. 38 | # 39 | # NOTE: This script requires Python to be installed on your system. 40 | # 41 | 42 | ############################################################################## 43 | ### OPTIONS ### 44 | 45 | # Watch Paths. 46 | # 47 | # Specify the directories you want to monitor for NZB-Files. 48 | # The Tildy (~) can be used to expand the path in efforts to support the home 49 | # directory. You can specify as many paths as you want, simply just add a 50 | # comma (,) to delimit them. eg: 51 | # path1, path2, path3, etc 52 | # 53 | # You can additionally specify options too such as: 54 | # - c=category 55 | # 56 | # Options are specified at the end of the path name like one would do for 57 | # a URL. For example, one might specify the following to always load content 58 | # from a specific path and treat the NZBs found as books: 59 | # /path/to/book/dir?c=books 60 | # 61 | #WatchPaths=~/Downloads, ~/Dropbox/NZB-Files 62 | 63 | # Maximum Archive Size in Kilobytes. 64 | # 65 | # If we find a Zip file within one of our WatchPath's (defined above), then we 66 | # verify that it is no larger then this value (in Kilobytes). This is to 67 | # prevent processing excessively large compressed files that in no way would 68 | # have ever had an NZB-File in them anyway. 69 | # 70 | #MaxArchiveSizeKB=150 71 | 72 | # Scan Cycles. 73 | # 74 | # Specify the number of seconds you wish to poll the specified watch paths 75 | # for content. Set this to zero to just use the times defined by the 76 | # NZBGet Scheduler instead. By setting this to any value larger then 0 77 | # (but no less then 30), The script will run indefinitely (or until 78 | # NZB-Get is shutdown) 79 | # 80 | #PollTimeSec=60 81 | 82 | # DirWatch TempFile Auto-Cleanup (yes, no). 83 | # 84 | # This script renames NZB-Files (even the ZIPs that contain them) with 85 | # a .dw extension just prior to handling them. This is a failsafe 86 | # way of not processing it a second time around. Once these files have 87 | # been handled, this script attempts to remove them automatically. 88 | # 89 | # However... there are cases where file permissions allow for the initial 90 | # rename (to .dw) to occur, but do not allow the auto-cleanup afterwards. 91 | # 92 | # By setting this flag to Yes, you're allowing the script to attempt to 93 | # remove any lingering .dw files still residing in the DirWatch directories 94 | # if they're found under the presumption they've been handled already. 95 | # 96 | #AutoCleanup=No 97 | 98 | # Enable debug logging (yes, no). 99 | # 100 | # If you experience a problem, you can bet the developer of this script will 101 | # have a much easier time troubleshootng it for you if your logs include 102 | # debugging. Debugging is made possible by flipping this flag here. 103 | # 104 | #Debug=no 105 | 106 | # Issue a tidy of any directories you defined above here: 107 | #NZBScan@Scan Defined NZB Paths 108 | 109 | ### NZBGET SCHEDULER SCRIPT ### 110 | ############################################################################## 111 | 112 | import re 113 | from os import unlink 114 | from os.path import join 115 | from os.path import basename 116 | from os.path import abspath 117 | from os.path import dirname 118 | from os.path import isdir 119 | from os.path import isfile 120 | from os.path import splitext 121 | from os.path import expanduser 122 | from os.path import exists 123 | from shutil import move 124 | from shutil import copy 125 | from zipfile import ZipFile 126 | from time import sleep 127 | try: 128 | # Python 2.7 129 | from urlparse import parse_qsl 130 | from urllib import unquote 131 | 132 | except ImportError: 133 | from urllib.parse import parse_qsl 134 | from urllib.parse import unquote 135 | 136 | # This is required if the below environment variables 137 | # are not included in your environment already 138 | import sys 139 | 140 | # Script dependencies identified below 141 | from datetime import timedelta 142 | from datetime import datetime 143 | 144 | # pynzbget Script Wrappers 145 | from nzbget import SchedulerScript 146 | from nzbget import EXIT_CODE 147 | from nzbget import SCRIPT_MODE 148 | from nzbget.Utils import tidy_path 149 | 150 | # Stick an extension on files prior to handling them. This prevents 151 | # them from being detected later, and we can also grasp a handle 152 | # of what our disk access permissions are because if we can't even 153 | # rename the file, then we shouldn't be handling it it. 154 | HANDLING_EXTENSION = ".dw" 155 | 156 | # Match paths (path can't have a question makr in it though) 157 | ARG_EXTRACT_RE = re.compile('^(?P[^?]+)(\?(?P.*))?$') 158 | 159 | # Regular expression for the handling of NZB-Files 160 | STRICTLY_NZB_FILE_RE = re.compile( 161 | '^(?P.*)(?P\.nzb)$', re.IGNORECASE) 162 | 163 | # A bit looser version of an NZB-File to which we account for our 164 | # Handled/Ignore extension 165 | NZB_FILE_RE = re.compile( 166 | '^(?P.*)(?P\.nzb)(?P\.dw)?$', re.IGNORECASE) 167 | 168 | # Regular expression for the handling of ZIP-Files 169 | ZIP_FILE_RE = re.compile( 170 | '^(?P.*)(?P\.zip)(?P\.dw)?$', re.IGNORECASE) 171 | 172 | MARKED_FILE_RE = re.compile( 173 | '^(?P.*)(?P\.dw)?$', re.IGNORECASE) 174 | 175 | # Ignore Regular Expression 176 | IGNORE_FILE_RE = re.compile( 177 | '^(?P.*)(?P\.dw)$', re.IGNORECASE) 178 | 179 | # The number of seconds a matched directory/file has to have aged before it 180 | # is processed further. This prevents the script from removing content 181 | # that may being processed 'now'. All content must be older than this 182 | # to be considered. This value is represented in seconds. 183 | DEFAULT_MATCH_MINAGE = 30 184 | 185 | # The default setting for Auto Cleanup 186 | DEFAULT_AUTO_CLEANUP = False 187 | 188 | # The maximum size a compressed file can be before it is considered to 189 | # be looked within for NZB-Files 190 | DEFAULT_COMPRESSED_MAXSIZE_KB = 150 191 | 192 | # The default polling time for the directory watch script 193 | DEFAULT_POLL_TIME_SEC = 60 194 | 195 | # The minimum allowable setting the poll time can be 196 | MINIMUM_POLL_TIME_SEC = 30 197 | 198 | # Keyword that triggers the auto-detection of the category based 199 | # on what is parsed from the NZB-File (and or filename) 200 | AUTO_DETECT_CATEGORY_KEY = '*' 201 | 202 | class DIRWATCH_MODE(object): 203 | # Move content to the path specified instead of deleting it 204 | MOVE = "Move" 205 | # Do nothing; just preview what was intended to be tidied 206 | PREVIEW = "Preview" 207 | # Do nothing; just preview what was intended to be tidied 208 | REMOTE = "Remote Push" 209 | 210 | # TidyIt Modes 211 | DIRWATCH_MODES = ( 212 | DIRWATCH_MODE.PREVIEW, 213 | DIRWATCH_MODE.MOVE, 214 | DIRWATCH_MODE.REMOTE, 215 | ) 216 | 217 | # Default in a Read-Only Mode; It's the safest way! 218 | DIRWATCH_MODE_DEFAULT = DIRWATCH_MODE.PREVIEW 219 | 220 | # Allow different combinations of the category keyword when 221 | # specifying it on the command line 222 | CATEGORY_KEYWORDS = ('c', 'cat', 'category') 223 | 224 | 225 | class DirWatchScript(SchedulerScript): 226 | """A Script for NZBGet to allow one to monitor multiple locations that 227 | may potentially contain an NZB-File. 228 | 229 | If a file is found, it's contents are automatically moved into the 230 | NZBGet queue for processing. 231 | """ 232 | 233 | # Our default polling time in seconds; set this to zero to disable 234 | # poll checks. 235 | poll_time_sec = DEFAULT_POLL_TIME_SEC 236 | 237 | # Define our minimum age a file can be 238 | min_age = DEFAULT_MATCH_MINAGE 239 | 240 | # Define our maxium archive size a compressed file can be 241 | max_archive_size = DEFAULT_COMPRESSED_MAXSIZE_KB 242 | 243 | def mark_handled(self, path): 244 | """ 245 | Marks a file handled by adding the .dw extension. This is only 246 | done if the file doesn't already have this marking. 247 | """ 248 | result = MARKED_FILE_RE.match(path) 249 | if result and result.group('ignore'): 250 | # Nothing to do 251 | return True 252 | 253 | # Append our extension onto the file 254 | newpath = result.group('filename') + HANDLING_EXTENSION 255 | 256 | # Move our file into a processing 257 | try: 258 | move(path, newpath) 259 | self.logger.debug('Marked FILE: %s (%s)' % ( 260 | path, basename(newpath), 261 | )) 262 | 263 | except Exception as e: 264 | self.logger.error('Could not prep FILE: %s (%s)' % ( 265 | path, basename(newpath), 266 | )) 267 | self.logger.debug('Prep Exception %s' % str(e)) 268 | return False 269 | return True 270 | 271 | def remote_push(self, source_path, category=None): 272 | """ 273 | Processes the specified source path and handles remote api 274 | calls to NZBGet. If category is set to None, then it is auto-detected 275 | (if possible) by reading it from the Meta entries within the NZB-Files 276 | """ 277 | 278 | # If we reach here, we have some extra processing to do before 279 | # we pass the data right into NZBGet via its API 280 | result = ZIP_FILE_RE.match(basename(source_path)) 281 | if result: 282 | try: 283 | zp = ZipFile(source_path, mode='r') 284 | z_contents = zp.namelist() 285 | 286 | except Exception as e: 287 | self.logger.warning( 288 | 'Could not access Zipped NZB-File %s%s.' % ( 289 | result.group('filename'), 290 | result.group('ext'), 291 | )) 292 | self.logger.debug('ZIP Exception %s' % str(e)) 293 | return False 294 | 295 | # Iterate over our zip files 296 | for znzb in z_contents: 297 | # We search exclusively for .nzb files 298 | if STRICTLY_NZB_FILE_RE.match(znzb): 299 | continue 300 | 301 | # Read our content back 302 | if not self.add_nzb(basename(znzb), 303 | content=zp.read(znzb), 304 | category=category): 305 | 306 | self.logger.warning( 307 | 'Failed to push Compressed NZB-File content ' 308 | '%s%s to NZBGet (category=%s)' % ( 309 | result.group('filename'), 310 | result.group('ext'), 311 | category, 312 | )) 313 | 314 | # Load our content directly via it's file 315 | elif not self.add_nzb(source_path, category=category): 316 | self.logger.warning( 317 | 'Failed to load NZB-File %s%s' % ( 318 | basename(source_path), 319 | ((category) and ", category='%s'" % category or ""), 320 | )) 321 | return False 322 | 323 | self.logger.info('Loaded NZB-File: %s%s' % ( 324 | basename(source_path), 325 | ((category) and ", category='%s'" % category or ""), 326 | )) 327 | 328 | return True 329 | 330 | def local_push(self, source_path, target_dir, target_file=None): 331 | """ 332 | A Simple wrapper to handle content in addition to logging it. 333 | """ 334 | 335 | if not target_dir: 336 | return False 337 | 338 | if not isdir(target_dir): 339 | self.logger.error( 340 | "The target directory '%s' was not found (for handling)." % \ 341 | target_dir, 342 | ) 343 | return False 344 | 345 | if not isfile(source_path): 346 | self.logger.warning( 347 | "The source file '%s' was not found (for handling)." % \ 348 | source_path, 349 | ) 350 | return False 351 | 352 | if target_file is None: 353 | target_file = basename(source_path) 354 | 355 | self.logger.info('Scanning Source: %s' % target_file) 356 | 357 | # Generate the new filename 358 | new_fullpath = join( 359 | target_dir, 360 | target_file, 361 | ) 362 | 363 | # Handle duplicate files by prefixing them with a digit: 364 | if exists(new_fullpath): 365 | _path, _ext = splitext(new_fullpath) 366 | index = 1 367 | _new_fullpath = '%s.%.5d%s' % (_path, index, _ext) 368 | while exists(_new_fullpath): 369 | _path, _ext = splitext(new_fullpath) 370 | index += 1 371 | _new_fullpath = '%s.%.5d%s' % (_path, index, _ext) 372 | 373 | # Store our new path 374 | new_fullpath = _new_fullpath 375 | 376 | if self.mode == DIRWATCH_MODE.MOVE: 377 | if self.cleanup: 378 | _handle = move 379 | else: 380 | _handle = copy 381 | 382 | # Handle our file 383 | try: 384 | _handle(source_path, new_fullpath) 385 | self.logger.info('Handled FILE: %s (%s)' % ( 386 | join(dirname(source_path), target_file), 387 | basename(new_fullpath), 388 | )) 389 | 390 | except Exception as e: 391 | self.logger.error('Could not handle FILE: %s (%s)' % ( 392 | join(dirname(source_path), target_file), 393 | basename(new_fullpath), 394 | )) 395 | self.logger.debug('Handle Exception %s' % str(e)) 396 | return False 397 | 398 | return True 399 | 400 | def watch_library(self, sources, target_dir, *args, **kwargs): 401 | """ 402 | Recursively scan source directories specified for NZB-Files 403 | and move found entries to the target directory 404 | 405 | """ 406 | if target_dir is not None: 407 | # Target Directory exists (we're not doing remote pushes) 408 | target_dir = abspath(expanduser(target_dir)) 409 | if not isdir(target_dir): 410 | # We're done if the target path isn't a directory 411 | self.logger.error( 412 | 'Target directory %s was not found.' % target_dir) 413 | return False 414 | self.logger.debug('Target directory set to: %s' % target_dir) 415 | 416 | # Create a reference time 417 | ref_time = datetime.now() - timedelta(seconds=self.min_age) 418 | 419 | for _path in sources: 420 | _parsed = ARG_EXTRACT_RE.match(_path) 421 | 422 | # create an argument map 423 | _args = {} 424 | 425 | if _parsed is None: 426 | # Could not math path; just use what we were passed in 427 | path = _path 428 | else: 429 | path = _parsed.group('path') 430 | try: 431 | _args = dict([ (k.lower().strip(), v.strip()) \ 432 | for k, v in parse_qsl( 433 | _parsed.group('args'), 434 | keep_blank_values=True, 435 | strict_parsing=False, 436 | )]) 437 | 438 | except AttributeError: 439 | # No problem; there simply wasn't anything to parse 440 | pass 441 | 442 | # Get our absolute path 443 | path = abspath(expanduser(path)) 444 | 445 | if not isdir(path): 446 | # We're done if the target path isn't a directory 447 | self.logger.warning( 448 | 'Source directory %s was not found.' % path) 449 | continue 450 | 451 | if path == target_dir: 452 | # We're done if the target path isn't a directory 453 | self.logger.warning( 454 | 'Source and Target directory (%s) are the same.' % path) 455 | continue 456 | 457 | regex_filter=[ NZB_FILE_RE, ] 458 | if self.max_archive_size > 0: 459 | # Add ZIP Files into our mix 460 | regex_filter.append(ZIP_FILE_RE) 461 | 462 | # Scan our directory (but not recursively) 463 | possible_matches = self.get_files( 464 | path, 465 | regex_filter=regex_filter, 466 | min_depth=1, max_depth=1, 467 | fullstats=True, 468 | skip_directories=True, 469 | ) 470 | 471 | # Filter our files that are too new 472 | filtered_matches = dict( 473 | [ (k, v) for (k, v) in possible_matches.items() \ 474 | if v['modified'] < ref_time ]) 475 | 476 | ignored_matches = dict( 477 | [ (k, v) for (k, v) in filtered_matches.items() \ 478 | if IGNORE_FILE_RE.match(k) and \ 479 | IGNORE_FILE_RE.match(k).group('ignore') ]) 480 | 481 | for ignored, _ in ignored_matches.items(): 482 | self.logger.debug('Ignoring file: %s' % ignored) 483 | if self.cleanup: 484 | # file should not be handled as it already has 485 | # been but still lingers; attempt to tidy: 486 | try: 487 | unlink(ignored) 488 | self.logger.info('Auto-Cleanup removed %s' % ignored) 489 | 490 | except Exception as e: 491 | self.logger.warning( 492 | 'Auto-Cleanup failed to remove %s' % ( 493 | ignored, 494 | )) 495 | self.logger.debug('Auto-Cleanup Exception %s' % str(e)) 496 | 497 | # Eliminate file from search 498 | del filtered_matches[ignored] 499 | 500 | # Do our compression check as a second step since it's 501 | # possible to disable it 502 | if self.max_archive_size > 0: 503 | zip_files = [ f for (f, m) in filtered_matches.items() \ 504 | if ZIP_FILE_RE.match(f) is not None and \ 505 | m['filesize'] > 0 and \ 506 | (m['filesize']/1000) < self.max_archive_size ] 507 | 508 | for zfile in zip_files: 509 | # Iterate over each zip file and peak inside it 510 | z_contents = None 511 | try: 512 | zp = ZipFile(zfile, mode='r') 513 | z_contents = zp.namelist() 514 | 515 | except Exception as e: 516 | self.logger.error('Could not peek in ZIP: %s' % zfile) 517 | self.logger.debug('ZIP Exception %s' % str(e)) 518 | # pop file from our move list 519 | del filtered_matches[zfile] 520 | continue 521 | 522 | # Let's have a look at our contents to see if there is a 523 | # non-NZB-File entry 524 | is_nzb_only = next((False for i in z_contents \ 525 | if STRICTLY_NZB_FILE_RE.match(i) is None), True) 526 | if not is_nzb_only: 527 | self.logger.debug( 528 | 'ZIP %s: contains non NZB-Files within it.' % ( 529 | zfile, 530 | ) + ' Skipping') 531 | 532 | # pop file from our move list 533 | del filtered_matches[zfile] 534 | continue 535 | 536 | self.logger.debug('ZIP %s: contains NZB-Files.' % zfile) 537 | 538 | if len(filtered_matches) <= 0: 539 | self.logger.debug( 540 | 'No NZB-Files found in directory %s' % path, 541 | ) 542 | continue 543 | 544 | category = next(( _args[k] \ 545 | for k in CATEGORY_KEYWORDS if k in _args), "")\ 546 | .strip() 547 | 548 | if category: 549 | if not self.api_connect(): 550 | self.logger.warning( 551 | 'A category was defined, but a connection to NZBGet '\ 552 | ' could not be established.') 553 | continue 554 | 555 | for _fullpath in filtered_matches.keys(): 556 | # Iterate over each file and move it's content into the source 557 | # however, if a category was parsed, then we need to directly 558 | # connect to the NZBGet API and pass the NZB-File along bearing 559 | # the category we specified. This gets a bit more tricky if 560 | # we're dealing with zip (compressed files). 561 | # We need to open these up and parse the content from within 562 | # them instead. 563 | if self.mode == DIRWATCH_MODE.PREVIEW: 564 | self.logger.info('PREVIEW ONLY: Handle FILE: %s' % ( 565 | _fullpath, 566 | )) 567 | continue 568 | 569 | if not category and target_dir is not None: 570 | # move/preview our content 571 | if not self.local_push(_fullpath, target_dir): 572 | continue 573 | 574 | # Wild card to detect category from the NZB-File and load it 575 | if category == AUTO_DETECT_CATEGORY_KEY: 576 | category = None 577 | 578 | # Handle Remote Files 579 | if target_dir is None and not self.remote_push(_fullpath, category): 580 | # Move our file back for processing later 581 | continue 582 | 583 | 584 | if self.cleanup: 585 | # We were successful and cleanup flag is set, 586 | # therefore we unlink our (handled) content: 587 | try: 588 | unlink(_fullpath) 589 | self.logger.info('Auto-Cleanup removed %s' % _fullpath) 590 | 591 | except Exception as e: 592 | self.logger.warning( 593 | 'Auto-Cleanup failed to remove %s' % ( 594 | fullpath, 595 | )) 596 | else: 597 | # if we got here, we were successful; so mark our content 598 | self.mark_handled(_fullpath) 599 | 600 | return True 601 | 602 | 603 | def watch(self): 604 | """All of the core cleanup magic happens here. 605 | """ 606 | 607 | if not self.validate(keys=( 608 | 'WatchPaths', 609 | 'AutoCleanup', 610 | )): 611 | self.logger.error("Missing Environment Variables.") 612 | return False 613 | 614 | # Store our variables 615 | self.max_archive_size = int( 616 | self.get('MaxArchiveSizeKB', self.max_archive_size)) 617 | 618 | self.min_age = int(self.get('ProcessMinAge', self.min_age)) 619 | 620 | # Store our source paths 621 | source_paths = self.parse_path_list(self.get('WatchPaths')) 622 | 623 | # Get our Mode 624 | self.mode = self.get('Mode', DIRWATCH_MODE_DEFAULT) 625 | 626 | # Cleanup Flag set? 627 | self.cleanup = self.parse_bool(self.get('AutoCleanup', DEFAULT_AUTO_CLEANUP)) 628 | 629 | if self.get('NzbDir'): 630 | # Store target directory (if set) otherwise we assume a remote 631 | # setup 632 | target_path = tidy_path(self.get('NzbDir')) 633 | if not isdir(target_path): 634 | self.logger.error( 635 | "The target directory '%s' was not found." % \ 636 | target_path, 637 | ) 638 | return False 639 | else: 640 | target_path = None 641 | 642 | return self.watch_library( 643 | source_paths, 644 | target_path, 645 | ) 646 | 647 | def scheduler_main(self, *args, **kwargs): 648 | """Scheduler 649 | """ 650 | # We always use MOVE mode when the call comes from 651 | # NZBGet 652 | self.set('Mode', DIRWATCH_MODE.MOVE) 653 | self.get('PollTimeSec', DEFAULT_POLL_TIME_SEC) 654 | try: 655 | poll_time = abs(int( 656 | self.get('PollTimeSec', DEFAULT_POLL_TIME_SEC))) 657 | 658 | except (ValueError, TypeError): 659 | self.logger.warning( 660 | "The poll time specified was invalid; " + 661 | "Defaulting it to %ds." % DEFAULT_POLL_TIME_SEC) 662 | poll_time = DEFAULT_POLL_TIME_SEC 663 | 664 | if poll_time != 0 and poll_time < MINIMUM_POLL_TIME_SEC: 665 | self.logger.warning( 666 | "The poll time specified was to small; " + 667 | "Defaulting it to %ds." % MINIMUM_POLL_TIME_SEC) 668 | 669 | if poll_time == 0: 670 | self.logger.debug('Single Instance Mode') 671 | # run a single instance 672 | return self.watch() 673 | 674 | # If we reach here, we run indefinitely presuming we are not 675 | # already runnning elsewhere 676 | 677 | # Create our PID 678 | self.is_unique_instance() 679 | 680 | self.logger.debug('Parallel Instance Mode') 681 | 682 | # Run until we have to quit 683 | while self.is_unique_instance(): 684 | # Infinit loop; we rely on a signal sent by 685 | # NZBGet to quit 686 | if self.watch() is False: 687 | # We're done if we have a problem 688 | return False 689 | 690 | self.logger.debug( 691 | "Next NZB-File Scan in %d seconds..." % poll_time, 692 | ) 693 | sleep(poll_time) 694 | 695 | def action_nzbscan(self, *args, **kwargs): 696 | """ 697 | Execute the NZBScan Test Action 698 | """ 699 | # run a single instance 700 | return self.watch() 701 | 702 | def main(self, *args, **kwargs): 703 | """CLI 704 | """ 705 | return self.watch() 706 | 707 | 708 | # Call your script as follows: 709 | if __name__ == "__main__": 710 | from sys import exit 711 | from optparse import OptionParser 712 | 713 | # Support running from the command line 714 | usage = "Usage: %prog [options] [SrcDir1 [SrcDir2 [...]]]" 715 | parser = OptionParser(usage=usage) 716 | parser.add_option( 717 | "-t", 718 | "--target-dir", 719 | dest="target_dir", 720 | help="The directory you want to move found NZB-Files from the " +\ 721 | "identified source directories to. This option is required " +\ 722 | "if not using the --remote (-r) switch.", 723 | metavar="DIR", 724 | ) 725 | parser.add_option( 726 | "-a", 727 | "--min-age", 728 | dest="min_age", 729 | help="Specify the minimum age a NZB-File must be " +\ 730 | "before considering it for processing. This value " +\ 731 | "is interpreted in seconds and defaults to %d sec(s). " % \ 732 | (DEFAULT_MATCH_MINAGE) + "This is just a safety switch to " +\ 733 | "prevent us from creating a racing condition where an " +\ 734 | "NZB-File is still being written to disk at the same time "\ 735 | "as we're trying to process it.", 736 | metavar="AGE_IN_SEC", 737 | ) 738 | parser.add_option( 739 | "-s", 740 | "--max-archive-size", 741 | dest="max_archive_size", 742 | help="Specify the maximum size a detected compressed file can be " +\ 743 | "before ignoring it. If the found compressed file is within this " +\ 744 | "specified value, it's contents will be scanned to see if it " +\ 745 | "(only) contains NZB-Files. These types of files would qualify " +\ 746 | "to be moved as well. Set this value to Zero (0) to not process " +\ 747 | "compressed files. The value is interpreted in Kilobytes and has " +\ 748 | "a default value of %s" % (DEFAULT_COMPRESSED_MAXSIZE_KB) +\ 749 | "if not otherwise specified.", 750 | metavar="SIZE_IN_KB", 751 | ) 752 | parser.add_option( 753 | "-p", 754 | "--preview", 755 | dest="preview_only", 756 | action="store_true", 757 | help="This is like a test switch; the actions the script would " +\ 758 | "have otherwise performed are instead just printed to the screen." 759 | ) 760 | parser.add_option( 761 | "-L", 762 | "--logfile", 763 | dest="logfile", 764 | help="Send output to the specified logfile instead of stdout.", 765 | metavar="FILE", 766 | ) 767 | parser.add_option( 768 | "-u", 769 | "--api-url", 770 | dest="api_url", 771 | help="Specify the URL of the NZB-Get API server such as: " 772 | " nzbget://user:pass@control.nzbget.host (to access insecure " 773 | "port 6789), " 774 | " nzbgets://user:pass@control.nzbget.host (to access secure " 775 | "port 6791), " 776 | " nzbget://user:pass@control.nzbget.host:port (to specify your " 777 | "own insecure port), and" 778 | " nzbgets://user:pass@control.nzbget.host:port (to specify your " 779 | "own secure port). By default nzbget://127.0.0.1 is used.", 780 | metavar="API_URL", 781 | ) 782 | parser.add_option( 783 | "-r", 784 | "--remote-push", 785 | action="store_true", 786 | dest="remote", 787 | help="Perform a remote push to NZBGet. This allows you to scan " 788 | "directories for NZB-Files on different machines and still remotely " 789 | "push them to your central NZBGet server.", 790 | ) 791 | parser.add_option( 792 | "-c", 793 | "--auto-cleanup", 794 | action="store_true", 795 | dest="auto_clean", 796 | help="Removes any .dw files detected prior to the handling of " 797 | "detected NZB-Files (and/or ZIP files containing them).", 798 | ) 799 | parser.add_option( 800 | "-D", 801 | "--debug", 802 | action="store_true", 803 | dest="debug", 804 | help="Debug Mode", 805 | ) 806 | options, _args = parser.parse_args() 807 | 808 | logger = options.logfile 809 | if not logger: 810 | # True = stdout 811 | logger = True 812 | debug = options.debug 813 | 814 | _watch_paths = None 815 | if len(_args): 816 | # Support command line arguments too 817 | _watch_paths = ', '.join(_args) 818 | 819 | # We always enter this part of the code, so we have to be 820 | # careful to only set() values that have been set by an 821 | # external switch. Otherwise we use defaults or what might 822 | # already be resident in memory (environment variables). 823 | _min_age = options.min_age 824 | _max_archive_size = options.max_archive_size 825 | _preview = options.preview_only is True 826 | _target_dir = options.target_dir 827 | _api_url = options.api_url 828 | _remote = options.remote 829 | _auto_clean = options.auto_clean 830 | 831 | # Default Script Mode 832 | script_mode = None 833 | 834 | if _auto_clean or _remote or _api_url or _preview or _watch_paths \ 835 | or _target_dir: 836 | # By specifying one of the followings; we know for sure that the 837 | # user is running this script manually from the command line. 838 | # is running this as a standalone script, 839 | 840 | # Setting Script Mode to NONE forces main() to execute 841 | # which is where the code for the cli() is defined 842 | script_mode = SCRIPT_MODE.NONE 843 | 844 | script = DirWatchScript( 845 | logger=logger, 846 | debug=debug, 847 | script_mode=script_mode, 848 | ) 849 | 850 | if _api_url: 851 | # attempt to parse the URL specified and set the appropriate 852 | # system variables 853 | url = script.parse_url(_api_url) 854 | if url: 855 | if 'schema' in url and url['schema']: 856 | if url['schema'][-1] in ('s', 'S'): 857 | script.set('SecureControl', 'True') 858 | else: 859 | script.set('SecureControl', 'False') 860 | 861 | if 'host' in url and url['host']: 862 | script.set('ControlIP', url['host']) 863 | 864 | try: 865 | if 'port' in url and url['port']: 866 | _port = str(abs(int(url['port']))) 867 | script.set('SecurePort', _port) 868 | script.set('ControlPort', _port) 869 | 870 | except (ValueError, TypeError): 871 | script.logger.error( 872 | 'An invalid port was specified in the `api url` ' 873 | '(%s).' % (url['port']) 874 | ) 875 | exit(EXIT_CODE.FAILURE) 876 | 877 | if 'user' in url: 878 | if url['user']: 879 | script.set('ControlUsername', unquote(url['user'])) 880 | else: 881 | script.set('ControlUsername', '') 882 | 883 | if 'password' in url: 884 | if url['password']: 885 | script.set('ControlPassword', unquote(url['password'])) 886 | else: 887 | script.set('ControlPassword', '') 888 | 889 | if _watch_paths: 890 | # Default mode to Move 891 | script.set('Mode', DIRWATCH_MODE.MOVE) 892 | 893 | # Set our Watch paths 894 | script.set('WatchPaths', _watch_paths) 895 | 896 | if _preview: 897 | # Toggle Preview Mode 898 | script.set('Mode', DIRWATCH_MODE.PREVIEW) 899 | 900 | elif _remote: 901 | # Toggle Remote Mode 902 | script.set('Mode', DIRWATCH_MODE.REMOTE) 903 | 904 | # Ensure NzbDir is set 905 | script.set('NzbDir', '') 906 | 907 | if script.script_mode == SCRIPT_MODE.NONE: 908 | # AutoClean Handling 909 | if _auto_clean: 910 | script.set('AutoCleanup', 'Yes') 911 | else: 912 | script.set('AutoCleanup', 'No') 913 | 914 | if not _remote and not script.get('NzbDir') and _target_dir: 915 | if not (_preview or _watch_paths): 916 | script.set('Mode', DIRWATCH_MODE_DEFAULT) 917 | 918 | if script.get('WatchPaths') is None: 919 | # Allow this flag to exist 920 | script.set('WatchPaths', '') 921 | 922 | # Finally set the directory the user specified for scanning 923 | script.set('NzbDir', _target_dir) 924 | 925 | if _max_archive_size: 926 | try: 927 | _max_archive_size = str(abs(int(_max_archive_size))) 928 | script.set('MaxArchiveSizeKB', _max_archive_size) 929 | 930 | except (ValueError, TypeError): 931 | script.logger.error( 932 | 'An invalid `max_archive_size` (%s) was specified.' % (_max_archive_size) 933 | ) 934 | exit(EXIT_CODE.FAILURE) 935 | 936 | if _min_age: 937 | try: 938 | _min_age = str(abs(int(_min_age))) 939 | script.set('ProcessMinAge', _min_age) 940 | 941 | except (ValueError, TypeError): 942 | script.logger.error( 943 | 'An invalid `min_age` (%s) was specified.' % (_min_age) 944 | ) 945 | exit(EXIT_CODE.FAILURE) 946 | 947 | if not script.script_mode and not script.get('WatchPaths'): 948 | # Provide some CLI help when NzbDir has been 949 | # detected as not being identified 950 | parser.print_help() 951 | exit(1) 952 | 953 | # call run() and exit() using it's returned value 954 | exit(script.run()) 955 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | nzbget-dirwatch NZB-Files from multiple directories for for NZBGet 635 | Copyright (C) 2016 Chris Caron 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | nzbget-dirwatch Copyright (C) 2016 Chris Caron 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | __Note:__ This script was intended to work with [NZBGet](http://nzbget.net) as a _Scheduling_ script. However, it also works perfectly well as a standalone script for others too! It can be easily adapted to anyone's environment. 2 | See the _Command Line_ section below for details how you can easily use this on it's own (without NZBGet). 3 | 4 | [![Paypal](http://repo.nuxref.com/pub/img/paypaldonate.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MHANV39UZNQ5E) 5 | 6 | DirWatch Scheduler Script 7 | ======================== 8 | DirWatch is a script that allows you to identify one or more directories it 9 | should scan for NZB-Files in. When an NZB-File is found (or even a zip file 10 | containing NZB-Files), it is pushed either locally or remotely (depending on 11 | how it's configured) to a central NZBGet server. 12 | 13 | It can also just perform basic moving for any NZB-Processing application (such 14 | as SABnzbd. It can be easily scripted to simply read NZB-Files from multiple 15 | locations and place them into a central location. 16 | 17 | Why Would I Need This? 18 | ====================== 19 | NZBGet limits you to identifying _just one_ directory it should scan/watch for 20 | NZB-Files in (for processing). This is okay for most people, but consider a 21 | scenario where... 22 | - you have a DropBox share; you could easily download an NZB-File from your 23 | tablet/phone and copy into here. Then just know that your NZBGet server 24 | back at home will processed automatically for you! 25 | - Maybe there are multiple users on your network who each want use 26 | NZBGet too; rather then giving them your admin login (to NZBGet), you can 27 | just set this script up to scan a designated folder (in each of their home 28 | directories) and process everything found. Thus, there is no need to run 29 | multiple instances of NZBGet. 30 | - Consider that you have a media server somewhere in your house but want to 31 | post NZB-Files to it manually whenever they appear in your laptops Download 32 | directory.
No problem! This script can run on any machine and read from 33 | as many directories as you want! It can also remotely post whatever it finds 34 | (NZB related) to your central NZBGet server. 35 | 36 | Directory to Category Assignments 37 | ================================= 38 | With this script, you can control what categories to assign to what NZB-Files 39 | you process. So not only can allow manage mulitple directories containing 40 | NZB-Files, but you can associate whatever category you wish this way too! 41 | 42 | This is done by simply adding the __?c=category.name__ to each directory you 43 | wish to monitor. For example, consider a layout like this on your home server: 44 | ```bash 45 | /nzbroot/Movies/ 46 | /nzbroot/TVShows/ 47 | /nzbroot/MyEBooks/ 48 | ``` 49 | 50 | Category assignments are mapped by directories, so in this case you might just 51 | add the following to NZBGet (DirWatch) Script's configuration: 52 | ```bash 53 | /nzbroot/Movies?c=movie, /nzbroot/TVShows?c=tv, /nzbroot/MyEBooks?c=ebooks 54 | ``` 55 | 56 | With respect to the example above, you would have just acomplished to following 57 | mappings for NZBGet: 58 | 59 | | Directory | NZBGet Category | 60 | | --------------------------------- |:--------------- | 61 | | /nzbroot/Movies/ | movies | 62 | | /nzbroot/TVShows/ | tv | 63 | | /nzbroot/MyEBooks/ | ebooks | 64 | 65 | Easy-Peasy Right? 66 | 67 | How It Works 68 | ============ 69 | Whatever additional path you specify, the script will just move the detected NZB-Files 70 | out of them and into the directory NZBGet already processes (identified by _NzbDir_ in 71 | the Paths section of it's configuration). If you're calling this from the command line 72 | then you must provide the _NzbDir_ as an argument. There are examples of this below. 73 | 74 | Installation Instructions 75 | ========================= 76 | 1. Ensure you have at least Python v2.7 or higher installed onto your system. 77 | ```bash 78 | # Pull in dependencies: 79 | pip install -r requirements.txt 80 | ``` 81 | 2. Simply place the __DirWatch.py__ into your NZBGet scripts directory. 82 | * __NZBGet users__: you will want to place these inside of your _nzbget/scripts_ directory. Please ensure you are running _(at least)_ NZBGet v11.0 or higher. You can acquire the latest version of of it from [here](http://nzbget.net/download).

Create a __Schedule__; you can do this from inside NZBGet. From the __Settings__ -> __Scheduler__ section, you can choose to __[Add Task]__. 83 | 3. Optionally set up an NZBGet Scheduled Task: 84 | * TaskX.Time: 85 | * Setting for NZBGet _Versions < v18_: __*:00,*:05,*:10,*:15,*:20,*:25,*:30,*:35,*:40,*:45,*:50,*:55__
This basically does a check every _5 minutes_ to see if the _DirWatch_ plugin is running. This means if you restart NZBGet or reload it's configuration for whatever reason; you'll just have to wait up to (a maximum of) 5 minutes before the script re-launches and takes over (using it's configured poll time). 86 | * Setting for NZBGet _Versions >= v18_: __*__
A new feature allowing NZBGet to automatically start up any Scheduled service if you simply define a single asterix (__*__) as it's scheduled start time. So for this version an astrix is all you need. 87 | * TaskX.Weekdays: __1-7__ 88 | * TaskX.Command: __Script__ 89 | * TaskX.Param: __DirWatch.py__ 90 | 91 | The Non-NZBGet users can also use this script via a cron (or simply call it 92 | from the command line) to automatically poll directories for the latest 93 | subtitles for the video content within it. See the __Command Line__ section 94 | below for more instructions on how to do this. 95 | 96 | Command Line 97 | ============ 98 | DirWatch.py has a built in command line interface that can be easily tied 99 | to a cron entry or can be easilly called from the command line to automate 100 | the fetching of subtitles. 101 | 102 | Here are the switches available to you: 103 | ``` 104 | Usage: DirWatch.py [options] [SrcDir1 [SrcDir2 [...]]] 105 | 106 | Options: 107 | -h, --help show this help message and exit 108 | -t DIR, --target-dir=DIR 109 | The directory you want to move found NZB-Files from 110 | the identified source directories to. This option is 111 | required if not using the --remote (-r) switch. 112 | -a AGE_IN_SEC, --min-age=AGE_IN_SEC 113 | Specify the minimum age a NZB-File must be before 114 | considering it for processing. This value is 115 | interpreted in seconds and defaults to 30 sec(s). This 116 | is just a safety switch to prevent us from creating a 117 | racing condition where an NZB-File is still being 118 | written to disk at the same time as we're trying to 119 | process it. 120 | -s SIZE_IN_KB, --max-archive-size=SIZE_IN_KB 121 | Specify the maximum size a detected compressed file 122 | can be before ignoring it. If the found compressed 123 | file is within this specified value, it's contents 124 | will be scanned to see if it (only) contains NZB- 125 | Files. These types of files would qualify to be moved 126 | as well. Set this value to Zero (0) to not process 127 | compressed files. The value is interpreted in 128 | Kilobytes and has a default value of 150if not 129 | otherwise specified. 130 | -p, --preview This is like a test switch; the actions the script 131 | would have otherwise performed are instead just 132 | printed to the screen. 133 | -L FILE, --logfile=FILE 134 | Send output to the specified logfile instead of 135 | stdout. 136 | -u API_URL, --api-url=API_URL 137 | Specify the URL of the NZB-Get API server such as: 138 | nzbget://user:pass@control.nzbget.host (to access 139 | insecure port 6789), 140 | nzbgets://user:pass@control.nzbget.host (to access 141 | secure port 6791), 142 | nzbget://user:pass@control.nzbget.host:port (to 143 | specify your own insecure port), and 144 | nzbgets://user:pass@control.nzbget.host:port (to 145 | specify your own secure port). By default 146 | nzbget://127.0.0.1 is used. 147 | -r, --remote-push Perform a remote push to NZBGet. This allows you to 148 | scan directories for NZB-Files on different machines 149 | and still remotely push them to your central NZBGet 150 | server. 151 | -c, --auto-cleanup Removes any .dw files detected prior to the handling 152 | of detected NZB-Files (and/or ZIP files containing 153 | them). 154 | -D, --debug Debug Mode 155 | 156 | ``` 157 | 158 | You can scan as many directories as you want to type inline on the shell: 159 | ```bash 160 | # Scan your libraries for NZB-Files and move them 161 | # into: /path/to/NZBGet/NzbDir 162 | python DirWatch.py -t /path/to/NZBGet/NzbDir \ 163 | /home/joe/Downloads \ 164 | /home/jason/Downloads \ 165 | /home/trevor/Downloads \ 166 | /home/joe/Dropbox/NZBFiles \ 167 | /home/jason/Dropbox/NZBFiles \ 168 | /home/trevor/Dropbox/NZBFiles 169 | ``` 170 | 171 | Don't forget that if you're using the CLI, you can take advantage of wildcards 172 | supported by your shell: 173 | ```bash 174 | # Take advantage of shell wildcards: 175 | python DirWatch.py -t /path/to/NZBGet/NzbDir \ 176 | /home/*/Downloads /home/*/Dropbox/NZBFiles 177 | ``` 178 | 179 | If the script behaves as you expect it should, you can schedule it as a cron 180 | to frequently move matched NZB-Files found in the specified Source Directories 181 | ```bash 182 | # $> crontab -e 183 | # Scan every 2 minutes: 184 | */2 * * * * /path/to/DirWatch.py -t /path/to/NZBGet/NzbDir ~/DropBox 185 | ``` 186 | 187 | Consider different servers on your network each obtaining NZB-Files in different 188 | locations, but you only have 1 NZBGet instance. Perhaps the NZBGet instance 189 | is even on a different network. No problem; you can scan multiple locations for 190 | NZB-Files and then push them remotely to your NZBGet server: 191 | ```bash 192 | # Scan your libraries for NZB-Files and move them 193 | # into our remote location done by the --remote (-r) switch 194 | python DirWatch.py -r -u nzbget://my.nzbget.host \ 195 | /path/to/nzb-files \ 196 | /another/path/to/nzb-files 197 | ``` 198 | 199 | You can also use the category switches with the command line to force category 200 | assignments per directory: 201 | ```bash 202 | # Assign categories per directory (optionally) if you wish: 203 | python DirWatch.py -t /path/to/NZBGet/NzbDir \ 204 | /home/joe/Downloads/NZBFiles/Movies?c=movie \ 205 | /home/joe/Downloads/NZBFiles/Shows?c=tv 206 | /home/joe/Downloads/NZBFiles/General 207 | 208 | # You can do this using remote calls too: 209 | python DirWatch.py -r -u nzbget://my.nzbget.host \ 210 | /home/joe/Downloads/NZBFiles/Movies?c=movie \ 211 | /home/joe/Downloads/NZBFiles/Shows?c=tv 212 | ``` 213 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pynzbget 2 | --------------------------------------------------------------------------------