X-Git-Url: https://www.irasnyder.com/gitweb/?p=rarslave2.git;a=blobdiff_plain;f=rarslave.py;h=a27c334cfe2e14d2b159c2defbaf5657c81e1de4;hp=224d1051e29b155a79e664a99c72915484efee44;hb=005129118bcc031f57c57d39ba8b05ed1842c47c;hpb=d8ef527e246184551ce125e6b7963d40a1c3b97a diff --git a/rarslave.py b/rarslave.py index 224d105..a27c334 100644 --- a/rarslave.py +++ b/rarslave.py @@ -1,210 +1,55 @@ #!/usr/bin/env python # vim: set ts=4 sts=4 sw=4 textwidth=112 : -import re, os, sys -import par2parser -import RarslaveConfig -from RarslaveLogger import RarslaveLogger +VERSION="2.0.0" +PROGRAM="rarslave2" -# Global Variables -(TYPE_OLDRAR, TYPE_NEWRAR, TYPE_ZIP, TYPE_NOEXTRACT) = range (4) -(SUCCESS, ECHECK, EEXTRACT, EDELETE) = range(4) -config = RarslaveConfig.RarslaveConfig() -logger = RarslaveLogger () +import os, sys, optparse, logging +import rsutil +import RarslaveDetector -class RarslaveExtractor (object): +# Global options from the rsutil.globals class +options = rsutil.globals.options +config = rsutil.globals.config - def __init__ (self, type): - self.type = type - self.heads = [] +# A tiny class to hold logging output until we're finished +class DelayedLogger (object): + def __init__ (self, output=sys.stdout.write): + self.__messages = [] + self.__output = output - def addHead (self, dir, head): - assert os.path.isdir (dir) - # REQUIRES that the dir is valid, but not that the file is valid, so that - # we can move a file that doesn't exist yet. - # FIXME: probably CAN add this back, since we should be running this AFTER repair. - #assert os.path.isfile (os.path.join (dir, head)) + def write (self, msg): + self.__messages.append (msg) - self.heads.append (os.path.join (dir, head)) + def flush (self): + pass - def extract (self, todir=None): - # Extract all heads of this set + def size (self): + """Returns the number of messages queued for printing""" + return len (self.__messages) - # Create the directory $todir if it doesn't exist - if todir != None and not os.path.isdir (todir): - logger.addMessage ('Creating directory: %s' % todir, False) - try: - os.makedirs (todir) - except OSError: - logger.addMessage ('FAILED to create directory: %s' % todir) - return -EEXTRACT + def close (self): + """Print all messages, clear the queue""" + for m in self.__messages: + self.__output (m) - # Extract all heads - extraction_func = \ - { TYPE_OLDRAR : self.__extract_rar, - TYPE_NEWRAR : self.__extract_rar, - TYPE_ZIP : self.__extract_zip, - TYPE_NOEXTRACT : self.__extract_noextract }[self.type] + self.__messages = [] - # Call the extraction function on each head - for h in self.heads: - if todir == None: - # Run in the head's directory - ret = extraction_func (h, os.path.dirname (h)) - else: - ret = extraction_func (h, todir) +# A tiny class used to find unique PAR2 sets +class CompareSet (object): - # Check error code - if ret != SUCCESS: - logger.addMessage ('Failed extracting: %s' % h) - return -EEXTRACT - - return SUCCESS - - def __extract_rar (self, file, todir): - assert os.path.isfile (file) - assert os.path.isdir (todir) - - RAR_CMD = config.get_value ('commands', 'unrar') - - cmd = '%s \"%s\"' % (RAR_CMD, file) - ret = run_command (cmd, todir) - - # Check error code - if ret != 0: - return -EEXTRACT - - return SUCCESS - - def __extract_zip (self, file, todir): - ZIP_CMD = config.get_value ('commands', 'unzip') - - cmd = ZIP_CMD % (file, todir) - ret = run_command (cmd) - - # Check error code - if ret != 0: - return -EEXTRACT - - return SUCCESS - - def __extract_noextract (self, file, todir): - # Just move this file to the $todir, since no extraction is needed - # FIXME: NOTE: mv will fail by itself if you're moving to the same dir! - NOEXTRACT_CMD = config.get_value ('commands', 'noextract') - - cmd = NOEXTRACT_CMD % (file, todir) - ret = run_command (cmd) - - # Check error code - if ret != 0: - return -EEXTRACT - - return SUCCESS - - - -class RarslaveRepairer (object): - # Verify (and repair) the set - # Make sure it worked, otherwise clean up and return failure - - def __init__ (self, dir, file, join=False): - self.dir = dir # the directory containing the par2 file - self.file = file # the par2 file - self.join = join # True if the par2 set is 001 002 ... - - assert os.path.isdir (dir) - assert os.path.isfile (os.path.join (dir, file)) - - def checkAndRepair (self): - # Form the command: - # par2repair -- PAR2 PAR2_EXTRA [JOIN_FILES] - PAR2_CMD = config.get_value ('commands', 'par2repair') - - # Get set up - basename = get_basename (self.file) - all_files = find_likely_files (basename, self.dir) - all_files.sort () - par2_files = find_par2_files (all_files) - - # assemble the command - command = "%s \"%s\" " % (PAR2_CMD, self.file) - - for f in par2_files: - if f != self.file: - command += "\"%s\" " % os.path.split (f)[1] - - if self.join: - for f in all_files: - if f not in par2_files: - command += "\"%s\" " % os.path.split (f)[1] - - # run the command - ret = run_command (command, self.dir) - - # check the result - if ret != 0: - logger.addMessage ('PAR2 Check / Repair failed: %s' % self.file) - return -ECHECK - - return SUCCESS - -def run_command (cmd, indir=None): - # Runs the specified command-line in the directory given (or, in the current directory - # if none is given). It returns the status code given by the application. - - pwd = os.getcwd () - - if indir != None: - assert os.path.isdir (indir) # MUST be a directory! - os.chdir (indir) - - # FIXME: re-enable this after testing - print 'RUNNING (%s): %s' % (indir, cmd) - return SUCCESS - - # return os.system (cmd) - - -def full_abspath (p): - return os.path.abspath (os.path.expanduser (p)) - -def get_basename (name): - """Strips most kinds of endings from a filename""" - - regex = config.get_value ('regular expressions', 'basename_regex') - r = re.compile (regex, re.IGNORECASE) - done = False - - while not done: - done = True - - if r.match (name): - g = r.match (name).groups() - name = g[0] - done = False - - return name - -def find_likely_files (name, dir): - """Finds files which are likely to be part of the set corresponding - to $name in the directory $dir""" - - if not os.path.isdir (os.path.abspath (dir)): - raise ValueError # bad directory given - - dir = os.path.abspath (dir) - ename = re.escape (name) - regex = re.compile ('^%s.*$' % (ename, )) + def __init__ (self, dir, p2file): + self.dir = dir + self.p2file = p2file - return [f for f in os.listdir (dir) if regex.match (f)] + self.basename = rsutil.common.get_basename (self.p2file) + self.name_matches = rsutil.common.find_name_matches (self.dir, self.basename) -def find_par2_files (files): - """Find all par2 files in the list $files""" + def __eq__ (self, rhs): + return (self.dir == rhs.dir) \ + and (self.basename == rhs.basename) \ + and rsutil.common.list_eq (self.name_matches, rhs.name_matches) - PAR2_REGEX = config.get_value ('regular expressions', 'par2_regex') - regex = re.compile (PAR2_REGEX, re.IGNORECASE) - return [f for f in files if regex.match (f)] def find_all_par2_files (dir): """Finds all par2 files in a directory""" @@ -216,246 +61,180 @@ def find_all_par2_files (dir): dir = os.path.abspath (dir) files = os.listdir (dir) - return find_par2_files (files) - -def has_extension (f, ext): - """Checks if f has the extension ext""" - - if ext[0] != '.': - ext = '.' + ext - - ext = re.escape (ext) - regex = re.compile ('^.*%s$' % (ext, ), re.IGNORECASE) - return regex.match (f) - -def find_extraction_heads (dir, files): - """Takes a list of possible files and finds likely heads of - extraction.""" - - # NOTE: perhaps this should happen AFTER repair is - # NOTE: successful. That way all files would already exist - - # According to various sources online: - # 1) pre rar-3.0: .rar .r00 .r01 ... - # 2) post rar-3.0: .part01.rar .part02.rar - # 3) zip all ver: .zip - - extractor = None - p2files = find_par2_files (files) - - # Old RAR type, find all files ending in .rar - if is_oldrar (files): - extractor = RarslaveExtractor (TYPE_OLDRAR) - regex = re.compile ('^.*\.rar$', re.IGNORECASE) - for f in files: - if regex.match (f): - extractor.addHead (dir, f) + return rsutil.common.find_par2_files (files) - if is_newrar (files): - extractor = RarslaveExtractor (TYPE_NEWRAR) - regex = re.compile ('^.*\.part01.rar$', re.IGNORECASE) - for f in files: - if regex.match (f): - extractor.addHead (dir, f) +def generate_all_parsets (dir): + # Generate all parsets in the given directory. - if is_zip (files): - extractor = RarslaveExtractor (TYPE_ZIP) - regex = re.compile ('^.*\.zip$', re.IGNORECASE) - for f in files: - if regex.match (f): - extractor.addHead (dir, f) + assert os.path.isdir (dir) # Directory MUST be valid - if is_noextract (files): - # Use the Par2 Parser (from cfv) here to find out what files are protected. - # Since these are not being extracted, they will be mv'd to another directory - # later. - extractor = RarslaveExtractor (TYPE_NOEXTRACT) + parsets = [] + p2files = find_all_par2_files (dir) - for f in p2files: - done = False - try: - prot_files = par2parser.get_protected_files (dir, f) - done = True - except: #FIXME: add the actual exceptions - logger.addMessage ('Error parsing PAR2 file: %s', f) - continue + for f in p2files: + p = CompareSet (dir, f) + if p not in parsets: + parsets.append (p) - if done: - break + return [(p.dir, p.p2file) for p in parsets] - if done: - for f in prot_files: - extractor.addHead (dir, f) - else: - logger.addMessage ('Error parsing all PAR2 files in this set ...', True) +def check_required_progs(): + """Check if the required programs are installed""" - # Make sure we found the type - if extractor == None: - logger.addMessage ('Not able to find an extractor for this type of set: %s' % p2files[0]) + shell_not_found = 32512 + needed = [] - # No-heads here, but it's better than failing completely - extractor = RarslaveExtractor (TYPE_NOEXTRACT) + if rsutil.common.run_command ('par2repair --help > /dev/null 2>&1') == shell_not_found: + needed.append ('par2repair') - return extractor + if rsutil.common.run_command ('unrar --help > /dev/null 2>&1') == shell_not_found: + needed.append ('unrar') -def is_oldrar (files): - for f in files: - if has_extension (f, '.r00'): - return True + if rsutil.common.run_command ('unzip --help > /dev/null 2>&1') == shell_not_found: + needed.append ('unzip') - return False + if needed: + for n in needed: + print 'Needed program "%s" not found in $PATH' % (n, ) -def is_newrar (files): - for f in files: - if has_extension (f, '.part01.rar'): - return True + sys.exit(1) - return False +def run_options (options): -def is_zip (files): - for f in files: - if has_extension (f, '.zip'): - return True - - return False - -def is_noextract (files): - # Type that needs no extraction. - # TODO: Add others ??? - for f in files: - if has_extension (f, '.001'): - return True - - return False - -def find_deleteable_files (files): - # Deleteable types regex should come from the config - dfiles = [] - DELETE_REGEX = config.get_value ('regular expressions', 'delete_regex') - dregex = re.compile (DELETE_REGEX, re.IGNORECASE) - - return [f for f in files if dregex.match (f)] - -def printlist (li): - for f in li: - print f - -class PAR2Set (object): - - dir = None - file = None - likely_files = [] - - def __init__ (self, dir, file): - assert os.path.isdir (dir) - assert os.path.isfile (os.path.join (dir, file)) + # Fix directories + options.work_dir = rsutil.common.full_abspath (options.work_dir) - self.dir = dir - self.file = file + # Make sure that the directory is valid + if not os.path.isdir (options.work_dir): + sys.stderr.write ('\"%s\" is not a valid directory. Use the \"-d\"\n' % options.work_dir) + sys.stderr.write ('option to override the working directory temporarily, or edit the\n') + sys.stderr.write ('configuration file to override the working directory permanently.\n') + sys.exit (1) - basename = get_basename (file) - self.likely_files = find_likely_files (basename, dir) + if options.extract_dir != None: + options.extract_dir = rsutil.common.full_abspath (options.extract_dir) - def __list_eq (self, l1, l2): + if options.version: + print PROGRAM + ' - ' + VERSION + print + print 'Copyright (c) 2005,2006 Ira W. Snyder (devel@irasnyder.com)' + print + print 'This program comes with ABSOLUTELY NO WARRANTY.' + print 'This is free software, and you are welcome to redistribute it' + print 'under certain conditions. See the file COPYING for details.' + sys.exit (0) - if len(l1) != len(l2): - return False + if options.check_progs: + check_required_progs () - for e in l1: - if e not in l2: - return False + if options.write_def_config: + config.write_config (default=True) - return True + if options.write_config: + config.write_config () - def __eq__ (self, rhs): - return self.__list_eq (self.likely_files, rhs.likely_files) +def find_loglevel (options): - def run_all (self): - par2files = find_par2_files (self.likely_files) - par2head = par2files[0] + loglevel = options.verbose - options.quiet - join = is_noextract (self.likely_files) + if loglevel > 1: + loglevel = 1 - # Repair Stage - repairer = RarslaveRepairer (self.dir, par2head, join) - ret = repairer.checkAndRepair () + if loglevel < -3: + loglevel = -3 - if ret != SUCCESS: - logger.addMessage ('Repair stage failed for: %s' % par2head) - return -ECHECK + LEVELS = { 1 : logging.DEBUG, + 0 : logging.INFO, + -1: logging.WARNING, + -2: logging.ERROR, + -3: logging.CRITICAL + } - # Extraction Stage - EXTRACT_DIR = config.get_value ('directories', 'extract_directory') - extractor = find_extraction_heads (self.dir, self.likely_files) - ret = extractor.extract (EXTRACT_DIR) + return LEVELS [loglevel] - if ret != SUCCESS: - logger.addMessage ('Extraction stage failed for: %s' % par2head) - return -EEXTRACT +def main (): - # Deletion Stage - DELETE_INTERACTIVE = config.get_value ('options', 'interactive') - deleteable_files = find_deleteable_files (self.likely_files) - ret = delete_list (deleteable_files, DELETE_INTERACTIVE) + # Setup the logger + logger = DelayedLogger () + logging.basicConfig (stream=logger, level=logging.WARNING, \ + format='%(levelname)-8s %(message)s') - if ret != SUCCESS: - logger.addMessage ('Deletion stage failed for: %s' % par2head) - return -EDELETE + # Build the OptionParser + parser = optparse.OptionParser() + parser.add_option('-n', '--not-recursive', action='store_false', dest='recursive', + default=rsutil.common.config_get_value('options', 'recursive'), + help="Don't run recursively") - logger.addMessage ('Successfully completed: %s' % par2head, True) - return SUCCESS + parser.add_option('-d', '--work-dir', dest='work_dir', type='string', + default=rsutil.common.config_get_value('directories', 'working_directory'), + help="Start running at DIR", metavar='DIR') -def delete_list (files, interactive=False): - # Delete a list of files + parser.add_option('-e', '--extract-dir', dest='extract_dir', type='string', + default=rsutil.common.config_get_value('directories', 'extract_directory'), + help="Extract to DIR", metavar='DIR') - done = False - valid_y = ['Y', 'YES'] - valid_n = ['N', 'NO'] + parser.add_option('-p', '--check-required-programs', + action='store_true', dest='check_progs', + default=False, + help="Check for required programs") - if interactive: - while not done: - print 'Do you want to delete the following?:' - s = raw_input ('Delete [y/N]: ').upper() + parser.add_option('-f', '--write-default-config', + action='store_true', dest='write_def_config', + default=False, help="Write out a new default config") - if s in valid_y + valid_n: - done = True + parser.add_option('-c', '--write-new-config', + action='store_true', dest='write_config', + default=False, help="Write out the current config") - if s in valid_n: - return SUCCESS + parser.add_option('-i', '--interactive', dest='interactive', action='store_true', + default=rsutil.common.config_get_value('options', 'interactive'), + help="Confirm before removing files") - for f in files: - # FIXME: re-enable this in production - # os.remove (f) - print 'rm \"%s\"' % f + parser.add_option('-q', '--quiet', dest='quiet', action='count', + default=0, help="Output fatal messages only") - return SUCCESS + parser.add_option('-v', '--verbose', dest='verbose', action='count', + default=0, help="Output extra information") + parser.add_option('-V', '--version', dest='version', action='store_true', + default=False, help="Output version information") -def generate_all_parsets (dir): - # Generate all parsets in the given directory. + parser.version = VERSION - assert os.path.isdir (dir) # Directory MUST be valid + # Parse the given options + global options + (rsutil.globals.options, args) = parser.parse_args() + options = rsutil.globals.options - parsets = [] - p2files = find_all_par2_files (dir) + # Run any special actions that are needed on these options + run_options (options) - for f in p2files: - p = PAR2Set (dir, f) - if p not in parsets: - parsets.append (p) + # Find the loglevel using the options given + logging.getLogger().setLevel (find_loglevel (options)) - return parsets + # Run recursively + if options.recursive: + for (dir, subdirs, files) in os.walk (options.work_dir): + parsets = generate_all_parsets (dir) + for (p2dir, p2file) in parsets: + detector = RarslaveDetector.RarslaveDetector (p2dir, p2file) + ret = detector.runMatchingTypes () -def main (): - TOPDIR = os.path.abspath ('test_material') + # Non-recursive + else: + parsets = generate_all_parsets (options.work_dir) + for (p2dir, p2file) in parsets: + detector = RarslaveDetector.RarslaveDetector (p2dir, p2file) + ret = detector.runMatchingTypes () - for (dir, subdirs, files) in os.walk (TOPDIR): - parsets = generate_all_parsets (dir) - for p in parsets: - p.run_all () + # Print the results + if logger.size () > 0: + print '\nLog\n' + '=' * 80 + logger.close () - print '\nRARSLAVE STATUS\n' - logger.printAllMessages () + # Done! + return 0 if __name__ == '__main__': main () +