[RARSLAVE] Add debug logging messages
[rarslave2.git] / rarslave.py
index 789452e..285974d 100644 (file)
@@ -3,9 +3,14 @@
 
 import re, os, sys
 import par2parser
+import RarslaveConfig
+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.RarslaveLogger ()
 
 class RarslaveExtractor (object):
 
@@ -20,20 +25,21 @@ 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):
+       def extract (self, todir=None):
                # Extract all heads of this set
 
                # Create the directory $todir if it doesn't exist
-               if not os.path.isdir (todir):
-                       # TODO: LOGGER
+               if todir != None and not os.path.isdir (todir):
+                       logger.addMessage ('Creating directory: %s' % todir, RarslaveLogger.MessageType.Verbose)
                        try:
                                os.makedirs (todir)
                        except OSError:
-                               # TODO: LOGGER
-                               # Failed mkdir -p, clean up time ...
-                               pass # FIXME: temporary for syntax
+                               logger.addMessage ('FAILED to create directory: %s' % todir, RarslaveLogger.MessageType.Fatal)
+                               return -EEXTRACT
 
                # Extract all heads
                extraction_func = \
@@ -44,32 +50,62 @@ class RarslaveExtractor (object):
 
                # Call the extraction function on each head
                for h in self.heads:
-                       extraction_func (h, todir)
+                       if todir == None:
+                               # Run in the head's directory
+                               ret = extraction_func (h, os.path.dirname (h))
+                       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, RarslaveLogger.MessageType.Fatal)
+                               return -EEXTRACT
+
+               return SUCCESS
 
        def __extract_rar (self, file, todir):
                assert os.path.isfile (file)
                assert os.path.isdir (todir)
 
-               RAR_CMD = 'unrar x -o+ -- '
-
-               #file = full_abspath (file)
-               #todir = full_abspath (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 = 'unzip \"%s\" -d \"%s\"'
+               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!
-               cmd = 'mv \"%s\" \"%s\"' % (file, todir)
+               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):
@@ -87,7 +123,7 @@ class RarslaveRepairer (object):
        def checkAndRepair (self):
                # Form the command:
                # par2repair -- PAR2 PAR2_EXTRA [JOIN_FILES]
-               PAR2_CMD = 'par2repair -- '
+               PAR2_CMD = config.get_value ('commands', 'par2repair')
 
                # Get set up
                basename = get_basename (self.file)
@@ -100,16 +136,23 @@ class RarslaveRepairer (object):
 
                for f in par2_files:
                        if f != self.file:
-                               command += "\"%s\" " % get_filename(f)
+                               command += "\"%s\" " % os.path.split (f)[1]
 
                if self.join:
                        for f in all_files:
                                if f not in par2_files:
-                                       command += "\"%s\" " % get_filename(f)
+                                       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, RarslaveLogger.MessageType.Fatal)
+                       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.
@@ -118,27 +161,22 @@ def run_command (cmd, indir=None):
 
        if indir != None:
                assert os.path.isdir (indir) # MUST be a directory!
-               os.chdir (pwd)
+               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_filename (f):
-       # TODO: I don't think that we should enforce this...
-       # TODO: ... because I think we should be able to get the filename, regardless
-       # TODO: of whether this is a legit filename RIGHT NOW or not.
-       # assert os.path.isfile (f)
-       return os.path.split (f)[1]
-
 def get_basename (name):
        """Strips most kinds of endings from a filename"""
 
-       regex = '^(.+)\.(par2|vol\d+\+\d+|\d\d\d|part\d+|rar|zip|avi|mp4|mkv|ogm)$'
+       regex = config.get_value ('regular expressions', 'basename_regex')
        r = re.compile (regex, re.IGNORECASE)
        done = False
 
@@ -168,7 +206,8 @@ def find_likely_files (name, dir):
 def find_par2_files (files):
        """Find all par2 files in the list $files"""
 
-       regex = re.compile ('^.*\.par2$', re.IGNORECASE)
+       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):
@@ -242,7 +281,7 @@ def find_extraction_heads (dir, files):
                                prot_files = par2parser.get_protected_files (dir, f)
                                done = True
                        except: #FIXME: add the actual exceptions
-                               print 'ERROR PARSING P2FILE ...', f
+                               logger.addMessage ('Error parsing PAR2 file: %s', f)
                                continue
 
                        if done:
@@ -252,10 +291,15 @@ def find_extraction_heads (dir, files):
                        for f in prot_files:
                                extractor.addHead (dir, f)
                else:
-                       print 'BADNESS'
+                       logger.addMessage ('Error parsing all PAR2 files in this set ...')
 
        # Make sure we found the type
-       assert extractor != None
+       if extractor == None:
+               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)
 
        return extractor
 
@@ -264,16 +308,22 @@ def is_oldrar (files):
                if has_extension (f, '.r00'):
                        return True
 
+       return False
+
 def is_newrar (files):
        for f in files:
                if has_extension (f, '.part01.rar'):
                        return True
 
+       return False
+
 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 ???
@@ -281,10 +331,13 @@ def is_noextract (files):
                if has_extension (f, '.001'):
                        return True
 
+       return False
+
 def find_deleteable_files (files):
        # Deleteable types regex should come from the config
        dfiles = []
-       dregex = re.compile ('^.*\.(par2|\d|\d\d\d|rar|r\d\d|zip)$', re.IGNORECASE)
+       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)]
 
@@ -292,70 +345,145 @@ 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))
+
+               self.dir = dir
+               self.file = file
+
+               basename = get_basename (file)
+               self.likely_files = find_likely_files (basename, dir)
+
+       def __list_eq (self, l1, l2):
+
+               if len(l1) != len(l2):
+                       return False
+
+               for e in l1:
+                       if e not in l2:
+                               return False
+
+               return True
+
+       def __eq__ (self, rhs):
+               return self.__list_eq (self.likely_files, rhs.likely_files)
+
+       def run_all (self):
+               par2files = find_par2_files (self.likely_files)
+               par2head = par2files[0]
+
+               join = is_noextract (self.likely_files)
+
+               # Repair Stage
+               repairer = RarslaveRepairer (self.dir, par2head, join)
+               ret = repairer.checkAndRepair ()
+
+               if ret != SUCCESS:
+                       logger.addMessage ('Repair stage failed for: %s' % par2head, RarslaveLogger.MessageType.Fatal)
+                       return -ECHECK
+
+               # Extraction Stage
+               EXTRACT_DIR = config.get_value ('directories', 'extract_directory')
+               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, RarslaveLogger.MessageType.Fatal)
+                       return -EEXTRACT
+
+               # Deletion Stage
+               DELETE_INTERACTIVE = config.get_value ('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, RarslaveLogger.MessageType.Fatal)
+                       return -EDELETE
+
+               logger.addMessage ('Successfully completed: %s' % par2head)
+               return SUCCESS
+
+def delete_list (files, interactive=False):
+       # Delete a list of files
+
+       done = False
+       valid_y = ['Y', 'YES']
+       valid_n = ['N', 'NO']
+
+       if interactive:
+               while not done:
+                       print 'Do you want to delete the following?:'
+                       s = raw_input ('Delete [y/N]: ').upper()
+
+                       if s in valid_y + valid_n:
+                               done = True
+
+               if s in valid_n:
+                       return SUCCESS
+
+       for f in files:
+               # FIXME: re-enable this in production
+               # os.remove (f)
+               print 'rm \"%s\"' % f
+
+       return SUCCESS
+
+
+def generate_all_parsets (dir):
+       # Generate all parsets in the given directory.
+
+       assert os.path.isdir (dir) # Directory MUST be valid
+
+       parsets = []
+       p2files = find_all_par2_files (dir)
+
+       for f in p2files:
+               p = PAR2Set (dir, f)
+               if p not in parsets:
+                       parsets.append (p)
+
+       return parsets
+
 def main ():
-       # Setup stage
-       print '\nSETUP STAGE'
-       DIR = os.path.abspath ('test_material/01/')
-       p2files = find_all_par2_files (DIR)
-       p2file = p2files[0]
-
-       # Repair stage
-       print '\nREPAIR STAGE'
-       repairer = RarslaveRepairer (DIR, p2file)
-       repairer.checkAndRepair ()
-
-       # Extraction stage
-       print '\nEXTRACTION STAGE'
-       files = find_likely_files (get_basename (p2file), DIR)
-       extractor = find_extraction_heads (DIR, files)
-       extractor.extract('extract_dir')
-
-       # Deletion stage
-       print '\nDELETION STAGE'
-       printlist ( find_deleteable_files (files) )
-
-       print '\n\n'
-
-       # Setup stage
-       print '\nSETUP STAGE'
-       DIR = os.path.abspath ('test_material/13/')
-       p2files = find_all_par2_files (DIR)
-       p2file = p2files[0]
-
-       # Repair stage
-       print '\nREPAIR STAGE'
-       RarslaveRepairer (DIR, p2file, join=True).checkAndRepair ()
-
-       # Extraction stage
-       print '\nEXTRACTION STAGE'
-       files = find_likely_files (get_basename (p2file), DIR)
-       find_extraction_heads (DIR, files).extract ('extract_dir')
-
-       # Deletion stage
-       print '\nDELETION STAGE'
-       printlist ( find_deleteable_files (files) )
-
-       print '\n\n'
-
-       # Setup stage
-       print '\nSETUP STAGE'
-       DIR = os.path.abspath ('test_material/14/')
-       p2files = find_all_par2_files (DIR)
-       p2file = p2files[0]
-
-       # Repair stage
-       print '\nREPAIR STAGE'
-       RarslaveRepairer (DIR, p2file, join=True).checkAndRepair ()
-
-       # Extraction stage
-       print '\nEXTRACTION STAGE'
-       files = find_likely_files (get_basename (p2file), DIR)
-       find_extraction_heads (DIR, files).extract ('extract_dir')
-
-       # Deletion stage
-       print '\nDELETEION STAGE'
-       printlist ( find_deleteable_files (files) )
+       TOPDIR = os.path.abspath ('test_material')
+
+       for (dir, subdirs, files) in os.walk (TOPDIR):
+               parsets = generate_all_parsets (dir)
+               for p in parsets:
+                       p.run_all ()
+
+       print '\nRARSLAVE STATUS\n'
+
+       # Used in '--quiet' mode
+       if logger.hasFatalMessages ():
+               print '\nFatal Messages\n' + '=' * 80
+               logger.printLoglevel (RarslaveLogger.MessageType.Fatal)
 
+       # Used in no options mode
+       if logger.hasNormalMessages ():
+               print '\nNormal Messages\n' + '=' * 80
+               logger.printLoglevel (RarslaveLogger.MessageType.Normal)
+
+       # Used in --verbose mode
+       if logger.hasVerboseMessages ():
+               print '\nVerbose Messages\n' + '=' * 80
+               logger.printLoglevel (RarslaveLogger.MessageType.Verbose)
+
+       # Used in --debug mode
+       if logger.hasDebugMessages ():
+               print '\nDebug Messages\n' + '=' * 80
+               logger.printLoglevel (RarslaveLogger.MessageType.Debug)
+
+       print '\n\nALL MESSAGES:'
+       logger.printAllMessages ()
 
 if __name__ == '__main__':
        main ()
+