[RARSLAVE] Fix working directory option
[rarslave2.git] / rarslave.py
index 224d105..ceb7eac 100644 (file)
@@ -1,16 +1,22 @@
 #!/usr/bin/env python
 # vim: set ts=4 sts=4 sw=4 textwidth=112 :
 
-import re, os, sys
+VERSION="2.0.0"
+PROGRAM="rarslave2"
+
+import re, os, sys, optparse
 import par2parser
 import RarslaveConfig
-from RarslaveLogger import RarslaveLogger
+import RarslaveLogger
 
 # Global Variables
 (TYPE_OLDRAR, TYPE_NEWRAR, TYPE_ZIP, TYPE_NOEXTRACT) = range (4)
 (SUCCESS, ECHECK, EEXTRACT, EDELETE) = range(4)
 config = RarslaveConfig.RarslaveConfig()
-logger = RarslaveLogger ()
+logger = RarslaveLogger.RarslaveLogger ()
+
+# Global options to be set / used later.
+options = None
 
 class RarslaveExtractor (object):
 
@@ -25,18 +31,20 @@ class RarslaveExtractor (object):
                # FIXME: probably CAN add this back, since we should be running this AFTER repair.
                #assert os.path.isfile (os.path.join (dir, head))
 
-               self.heads.append (os.path.join (dir, head))
+               full_head = os.path.join (dir, head)
+               logger.addMessage ('Adding extraction head: %s' % full_head, RarslaveLogger.MessageType.Debug)
+               self.heads.append (full_head)
 
        def extract (self, todir=None):
                # Extract all heads of this set
 
                # 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)
+                       logger.addMessage ('Creating directory: %s' % todir, RarslaveLogger.MessageType.Verbose)
                        try:
                                os.makedirs (todir)
                        except OSError:
-                               logger.addMessage ('FAILED to create directory: %s' % todir)
+                               logger.addMessage ('FAILED to create directory: %s' % todir, RarslaveLogger.MessageType.Fatal)
                                return -EEXTRACT
 
                # Extract all heads
@@ -54,9 +62,11 @@ class RarslaveExtractor (object):
                        else:
                                ret = extraction_func (h, todir)
 
+                       logger.addMessage ('Extraction Function returned: %d' % ret, RarslaveLogger.MessageType.Debug)
+
                        # Check error code
                        if ret != SUCCESS:
-                               logger.addMessage ('Failed extracting: %s' % h)
+                               logger.addMessage ('Failed extracting: %s' % h, RarslaveLogger.MessageType.Fatal)
                                return -EEXTRACT
 
                return SUCCESS
@@ -144,7 +154,7 @@ class RarslaveRepairer (object):
 
                # check the result
                if ret != 0:
-                       logger.addMessage ('PAR2 Check / Repair failed: %s' % self.file)
+                       logger.addMessage ('PAR2 Check / Repair failed: %s' % self.file, RarslaveLogger.MessageType.Fatal)
                        return -ECHECK
 
                return SUCCESS
@@ -287,11 +297,12 @@ def find_extraction_heads (dir, files):
                        for f in prot_files:
                                extractor.addHead (dir, f)
                else:
-                       logger.addMessage ('Error parsing all PAR2 files in this set ...', True)
+                       logger.addMessage ('Error parsing all PAR2 files in this set ...')
 
        # 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])
+               logger.addMessage ('Not able to find an extractor for this type of set: %s' % p2files[0],
+                               RarslaveLogger.MessageType.Fatal)
 
                # No-heads here, but it's better than failing completely
                extractor = RarslaveExtractor (TYPE_NOEXTRACT)
@@ -381,28 +392,28 @@ class PAR2Set (object):
                ret = repairer.checkAndRepair ()
 
                if ret != SUCCESS:
-                       logger.addMessage ('Repair stage failed for: %s' % par2head)
+                       logger.addMessage ('Repair stage failed for: %s' % par2head, RarslaveLogger.MessageType.Fatal)
                        return -ECHECK
 
                # Extraction Stage
-               EXTRACT_DIR = config.get_value ('directories', 'extract_directory')
+               EXTRACT_DIR = options.extract_dir
                extractor = find_extraction_heads (self.dir, self.likely_files)
                ret = extractor.extract (EXTRACT_DIR)
 
                if ret != SUCCESS:
-                       logger.addMessage ('Extraction stage failed for: %s' % par2head)
+                       logger.addMessage ('Extraction stage failed for: %s' % par2head, RarslaveLogger.MessageType.Fatal)
                        return -EEXTRACT
 
                # Deletion Stage
-               DELETE_INTERACTIVE = config.get_value ('options', 'interactive')
+               DELETE_INTERACTIVE = options.interactive
                deleteable_files = find_deleteable_files (self.likely_files)
                ret = delete_list (deleteable_files, DELETE_INTERACTIVE)
 
                if ret != SUCCESS:
-                       logger.addMessage ('Deletion stage failed for: %s' % par2head)
+                       logger.addMessage ('Deletion stage failed for: %s' % par2head, RarslaveLogger.MessageType.Fatal)
                        return -EDELETE
 
-               logger.addMessage ('Successfully completed: %s' % par2head, True)
+               logger.addMessage ('Successfully completed: %s' % par2head)
                return SUCCESS
 
 def delete_list (files, interactive=False):
@@ -446,16 +457,178 @@ def generate_all_parsets (dir):
 
        return parsets
 
+def check_required_progs():
+       """Check if the required programs are installed"""
+
+       shell_not_found = 32512
+       needed = []
+
+       if run_command ('par2repair --help > /dev/null 2>&1') == shell_not_found:
+               needed.append ('par2repair')
+
+       if run_command ('unrar --help > /dev/null 2>&1') == shell_not_found:
+               needed.append ('unrar')
+
+       if run_command ('unzip --help > /dev/null 2>&1') == shell_not_found:
+               needed.append ('unzip')
+
+       if needed:
+               for n in needed:
+                       print 'Needed program "%s" not found in $PATH' % (n, )
+
+               sys.exit(1)
+
+def run_options (options):
+
+       # Fix directories
+       options.work_dir = full_abspath (options.work_dir)
+
+       # 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)
+
+       if options.extract_dir != None:
+               options.extract_dir = full_abspath (options.extract_dir)
+
+       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 options.check_progs:
+               check_required_progs ()
+
+       if options.write_def_config:
+               config.write_config (default=True)
+
+       if options.write_config:
+               config.write_config ()
+
+def find_loglevel (options):
+
+       loglevel = options.verbose - options.quiet
+
+       if loglevel < RarslaveLogger.MessageType.Fatal:
+               loglevel = RarslaveLogger.MessageType.Fatal
+
+       if loglevel > RarslaveLogger.MessageType.Debug:
+               loglevel = RarslaveLogger.MessageType.Debug
+
+       return loglevel
+
+def printMessageTable (loglevel):
+
+       if logger.hasFatalMessages ():
+               print '\nFatal Messages\n' + '=' * 80
+               logger.printLoglevel (RarslaveLogger.MessageType.Fatal)
+
+       if loglevel == RarslaveLogger.MessageType.Fatal:
+               return
+
+       if logger.hasNormalMessages ():
+               print '\nNormal Messages\n' + '=' * 80
+               logger.printLoglevel (RarslaveLogger.MessageType.Normal)
+
+       if loglevel == RarslaveLogger.MessageType.Normal:
+               return
+
+       if logger.hasVerboseMessages ():
+               print '\nVerbose Messages\n' + '=' * 80
+               logger.printLoglevel (RarslaveLogger.MessageType.Verbose)
+
+       if loglevel == RarslaveLogger.MessageType.Verbose:
+               return
+
+       if logger.hasDebugMessages ():
+               print '\nDebug Messages\n' + '=' * 80
+               logger.printLoglevel (RarslaveLogger.MessageType.Debug)
+
+       return
+
 def main ():
-       TOPDIR = os.path.abspath ('test_material')
 
-       for (dir, subdirs, files) in os.walk (TOPDIR):
-               parsets = generate_all_parsets (dir)
+       # Build the OptionParser
+       parser = optparse.OptionParser()
+       parser.add_option('-n', '--not-recursive',
+                                               action='store_false', dest='recursive',
+                                               default=config.get_value('options', 'recursive'),
+                                               help="Don't run recursively")
+
+       parser.add_option('-d', '--work-dir',
+                                               dest='work_dir', type='string',
+                                               default=config.get_value('directories', 'working_directory'),
+                                               help="Start running at DIR", metavar='DIR')
+
+       parser.add_option('-e', '--extract-dir',
+                                               dest='extract_dir', type='string',
+                                               default=config.get_value('directories', 'extract_directory'),
+                                               help="Extract to DIR", metavar='DIR')
+
+       parser.add_option('-p', '--check-required-programs',
+                                               action='store_true', dest='check_progs',
+                                               default=False,
+                                               help="Check for required programs")
+
+       parser.add_option('-f', '--write-default-config',
+                                               action='store_true', dest='write_def_config',
+                                               default=False, help="Write out a new default config")
+
+       parser.add_option('-c', '--write-new-config',
+                                               action='store_true', dest='write_config',
+                                               default=False, help="Write out the current config")
+
+       parser.add_option('-i', '--interactive', dest='interactive', action='store_true',
+                                               default=config.get_value('options', 'interactive'),
+                                               help="Confirm before removing files")
+
+       parser.add_option('-q', '--quiet', dest='quiet', action='count',
+                                               default=0, help="Output fatal messages only")
+
+       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")
+
+       parser.version = VERSION
+
+       # Parse the given options
+       global options
+       (options, args) = parser.parse_args()
+
+       # Run any special actions that are needed on these options
+       run_options (options)
+
+       # Find the loglevel using the options given 
+       loglevel = find_loglevel (options)
+
+       # Run recursively
+       if options.recursive:
+               for (dir, subdirs, files) in os.walk (options.work_dir):
+                       parsets = generate_all_parsets (dir)
+                       for p in parsets:
+                               p.run_all ()
+
+       # Non-recursive
+       else:
+               parsets = generate_all_parsets (options.work_dir)
                for p in parsets:
                        p.run_all ()
 
-       print '\nRARSLAVE STATUS\n'
-       logger.printAllMessages ()
+       # Print the results
+       printMessageTable (loglevel)
+
+       # Done!
+       return 0
 
 if __name__ == '__main__':
        main ()
+