#!/usr/bin/env python
-# vim: set ts=4 sts=4 sw=4 textwidth=112 :
+# vim: set ts=4 sts=4 sw=4 textwidth=92:
-import re, os, sys
+"""
+The main program of the rarslave project.
-def get_basename (name):
- """Strips most kinds of endings from a filename"""
+This handles all of the commandline, configuration file, and option
+work. It gets the environment set up for a run using the RarslaveDetector
+class.
+"""
- regex = '^(.+)\.(par2|vol\d+\+\d+|\d\d\d|part\d+|rar|zip|avi|mp4|mkv|ogm)$'
- r = re.compile (regex, re.IGNORECASE)
- done = False
+__author__ = "Ira W. Snyder (devel@irasnyder.com)"
+__copyright__ = "Copyright (c) 2006,2007 Ira W. Snyder (devel@irasnyder.com)"
+__license__ = "GNU GPL v2 (or, at your option, any later version)"
- while not done:
- done = True
+# rarslave.py -- a usenet autorepair and autoextract utility
+#
+# Copyright (C) 2006,2007 Ira W. Snyder (devel@irasnyder.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- if r.match (name):
- g = r.match (name).groups()
- name = g[0]
- done = False
+VERSION="2.0.0"
+PROGRAM="rarslave"
- return name
+import os, sys, optparse, logging
+import rsutil
+import RarslaveDetector
-def find_likely_files (name, dir):
- """Finds files which are likely to be part of the set corresponding
- to $name in the directory $dir"""
+# Global options from the rsutil.globals class
+options = rsutil.globals.options
+config = rsutil.globals.config
- if not os.path.isdir (os.path.abspath (dir)):
- raise ValueError # bad directory given
+# A tiny class to hold logging output until we're finished
+class DelayedLogger (object):
- dir = os.path.abspath (dir)
- ename = re.escape (name)
- regex = re.compile ('^%s.*$' % (ename, ))
+ """A small class to hold logging output until the program is finished running.
+ It emulates sys.stdout in the needed ways for the logging module."""
+
+ def __init__ (self, output=sys.stdout.write):
+ self.__messages = []
+ self.__output = output
+
+ def write (self, msg):
+ self.__messages.append (msg)
+
+ def flush (self):
+ pass
+
+ def size (self):
+ """Returns the number of messages queued for printing"""
+ return len (self.__messages)
+
+ def close (self):
+ """Print all messages, clear the queue"""
+ for m in self.__messages:
+ self.__output (m)
+
+ self.__messages = []
+
+# A tiny class used to find unique PAR2 sets
+class CompareSet (object):
+
+ """A small class used to find unique PAR2 sets"""
+
+ def __init__ (self, dir, p2file):
+ self.dir = dir
+ self.p2file = p2file
+
+ self.basename = rsutil.common.get_basename (self.p2file)
+ self.name_matches = rsutil.common.find_name_matches (self.dir, self.basename)
+
+ 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)
- return [f for f in os.listdir (dir) if regex.match (f)]
def find_all_par2_files (dir):
- """Finds all par2 files in a directory"""
+ """Finds all par2 files in the given directory.
+
+ dir -- the directory in which to search for PAR2 files
+
+ NOTE: does not return absolute paths"""
if not os.path.isdir (os.path.abspath (dir)):
raise ValueError # bad directory given
dir = os.path.abspath (dir)
- regex = re.compile ('^.*\.par2$', re.IGNORECASE)
+ files = os.listdir (dir)
+
+ return rsutil.common.find_par2_files (files)
+
+def generate_all_parsets (dir):
+ """Generate all parsets in the given directory
+
+ dir -- the directory in which to search"""
+
+ assert os.path.isdir (dir) # Directory MUST be valid
+
+ parsets = []
+ p2files = find_all_par2_files (dir)
+
+ for f in p2files:
+ p = CompareSet (dir, f)
+ if p not in parsets:
+ parsets.append (p)
- # Find all files
- return [f for f in os.listdir (dir) if regex.match (f)]
+ return [(p.dir, p.p2file) for p in parsets]
-def has_extension (f, ext):
- """Checks if f has the extension ext"""
+def check_required_progs():
+ """Check if the required programs are installed"""
- if ext[0] != '.':
- ext = '.' + ext
+ shell_not_found = 32512
+ needed = []
- ext = re.escape (ext)
- regex = re.compile ('^.*%s$' % (ext, ), re.IGNORECASE)
- return regex.match (f)
+ if rsutil.common.run_command ('par2repair --help > /dev/null 2>&1') == shell_not_found:
+ needed.append ('par2repair')
-def find_extraction_heads (files):
- """Takes a list of possible files and finds likely heads of
- extraction."""
+ if rsutil.common.run_command ('unrar --help > /dev/null 2>&1') == shell_not_found:
+ needed.append ('unrar')
- # NOTE: perhaps this should happen AFTER repair is
- # NOTE: successful. That way all files would already exist
+ if rsutil.common.run_command ('unzip --help > /dev/null 2>&1') == shell_not_found:
+ needed.append ('unzip')
- # 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
+ if needed:
+ for n in needed:
+ print 'Needed program "%s" not found in $PATH' % (n, )
- heads = []
+ sys.exit(1)
- # Old RAR type, find all files ending in .rar
- if is_oldrar (files):
- regex = re.compile ('^.*\.rar$', re.IGNORECASE)
- for f in files:
- if regex.match (f):
- heads.append (f)
+def run_options (options):
+ """Process all of the commandline options, doing thing such as printing the
+ version number, etc."""
- return heads
+ # Fix directories
+ options.work_dir = rsutil.common.full_abspath (options.work_dir)
- if is_newrar (files):
- regex = re.compile ('^.*\.part01.rar$', re.IGNORECASE)
- for f in files:
- if regex.match (f):
- heads.append (f)
+ # 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)
- return heads
+ if options.extract_dir != None:
+ options.extract_dir = rsutil.common.full_abspath (options.extract_dir)
- if is_zip (files):
- regex = re.compile ('^.*\.zip$', re.IGNORECASE)
- for f in files:
- if regex.match (f):
- heads.append (f)
+ 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)
- return heads
+ if options.check_progs:
+ check_required_progs ()
- # Not a type we know yet
- raise ValueError
+ if options.write_def_config:
+ config.write_config (default=True)
+ sys.exit (0)
+ if options.write_config:
+ config.write_config ()
+ sys.exit (0)
-def is_oldrar (files):
- for f in files:
- if has_extension (f, '.r00'):
- return True
+def find_loglevel (options):
+ """Find the log level that should be printed by the logging class"""
-def is_newrar (files):
- for f in files:
- if has_extension (f, '.part01.rar'):
- return True
+ loglevel = options.verbose - options.quiet
-def is_zip (files):
- for f in files:
- if has_extension (f, '.zip'):
- return True
+ if loglevel > 1:
+ loglevel = 1
+ if loglevel < -3:
+ loglevel = -3
+
+ LEVELS = { 1 : logging.DEBUG,
+ 0 : logging.INFO,
+ -1: logging.WARNING,
+ -2: logging.ERROR,
+ -3: logging.CRITICAL
+ }
+
+ return LEVELS [loglevel]
def main ():
- print find_all_par2_files ('/home/irasnyd/downloads/test_material/01/')
+
+ # Setup the logger
+ logger = DelayedLogger ()
+ logging.basicConfig (stream=logger, level=logging.WARNING, \
+ format='%(levelname)-8s %(message)s')
+
+ # 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")
+
+ 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')
+
+ 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')
+
+ 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=rsutil.common.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
+ (rsutil.globals.options, args) = parser.parse_args()
+ options = rsutil.globals.options
+
+ # Run any special actions that are needed on these options
+ run_options (options)
+
+ # Find the loglevel using the options given
+ logging.getLogger().setLevel (find_loglevel (options))
+
+ # 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 ()
+
+ # Non-recursive
+ else:
+ parsets = generate_all_parsets (options.work_dir)
+ for (p2dir, p2file) in parsets:
+ detector = RarslaveDetector.RarslaveDetector (p2dir, p2file)
+ ret = detector.runMatchingTypes ()
+
+ # Print the results
+ if logger.size () > 0:
+ print '\nLog\n' + '=' * 80
+ logger.close ()
+
+ # Done!
+ return 0
if __name__ == '__main__':
main ()
+
projects / rarslave2.git / blobdiff