[RSUTIL] Fix directory handling

Fix the directory handling to make it more os-portable, using os.join()
instead of hardcoded paths.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[PAR2Set] Fix extraction head regular expression

The regular expression for finding the extraction heads of an OldRAR type
was incorrect. This patch adds the missing termination character.

This keeps it from trying to extract files created during repair, such as:
X.rar.1

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[DETECTOR] Add detected type to log message

Add the PAR2Set type that was detected to the log message.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[JOIN] Fix os.path.samefile() check for win32

The function os.path.samefile() doesn't exist on win32, so we will just
check and see if the names are the same, that will be good enough to fix mv
in this case.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[JOIN] Fix removal of protected files

In the join case, since we are not extracting files, we don't really want
to remove the files. So, in this case, remove all files that the
delete_regex matches, but not the files that are protected.

This fixes the following case:
==========================================
X.rar.par2
X.rar.vol0+1.par2
...
X.rar.001
X.rar.002
...

Where X.rar is the only protected file. When the process completes, X.rar
will be the only file left.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Add Copyright / License information + Documentation

Add the COPYING file (GPLv2).
Add the GPLv2 copyright notice to all files.
Add documentation to all modules, classes, and functions.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Add executable bit

Add the executable bits to the rarslave.py file.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[PAR2SET] Add missing os declarations

Add the missing os declarations to the PAR2Set-derived classes.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Add NoExtract detector

Add a new PAR2Set-derived detector which will detect types that are not
extractable, and should be repaired only.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Convert all return values to use rsutil package

All of the return values used values defined in the rsutil package. This
fixes all of them so that rsutil is used.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Move common functionality into rsutil package

This patch moves all of the common functionality from the RarslaveCommon,
RarslaveConfig, and RarslaveGlobals classes into a new package, called
rsutil. It then converts everything over to the new package.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Migrate all PAR2Set-derived classes to the package notation

This package migrates all of the PAR2Set-derived classes to the new PAR2Set
package notation.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Package PAR2Set and derived classes

Move the PAR2Set class and it's derived classes into a new PAR2Set package.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[LOGGER] Switch to built-in logging class

Switch from the homegrown RarslaveLogger class to the built-in logging
class. Convert all code that used RarslaveLogger to use the logging class,
and remove the RarslaveLogger class completely.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[PAR2SET_JOIN] Fix detection code

This makes the detection code more exact. This will now properly fail when
a set with the following files comes along:

Name matches:
X.par2
X.vol0+1.par2
X.001
X.002
...

Protection matches:
X.001
X.002
...

This new type will have to be handled in a seperate PAR2Set-derived class.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Major Projectwide Restructuring

Some major deficiencies were noticed in the previous design. Specifically,
the order of execution of steps was not customizable on a per-type basis.
This led to the problem of some types not being able to finish correctly.
Since this was obviously sub-optimal, the change was needed.

This adds a RarslaveDetector class, and many PAR2Set-derived classes. Each
of the PAR2Set-derived classes will be able to detect and fully verify /
repair / extract their type of set. When adding new sets, the new types
only need to be added to the RarslaveDetector class. Everything else is
automatic.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[PAR2PARSER] Force file closure

Make sure that the par2 file we are parsing gets closed after each time we
parse it, regardless of whether or not we return successfully or raise an
exception.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Remove inappropriate class variables, add instance variable documentation

Removes all of the improperly used class variables.

In their place, adds documentation for all of the instance variables that
should be used throughout the life of each instance of a class.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Add .gitignore

Add the .gitignore file to the project. This should ignore most common
things that show up.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Remove forgotten debugging code

Remove some debugging code that was accidentally left in by mistake.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Fix runCheckAndRepair() for joined files

The function runCheckAndRepair() was broken for files that needed to be
joined, because it was including protected files on the par2 command line.
This patch fixes the behavior so that only split pieces are added.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Major Refactoring

This continues the refactoring started in the last commit. The changes
encompass both the PAR2Set and RarslaveExtractor classes.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Refactoring of PAR2Set

This patch moves much of the functionality required only by the PAR2Set
class from the global scope into the PAR2Set class itself. It is now much
more careful about only generating sets of data once (where possible).
Also, it is much more careful to re-generate a set of data when it is
possible (and likely) that it has changed.

Fixes: Failure to remove original versions (.1 extension) of repaired
files.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Eliminate duplicates when finding deleteable files

Use a set() to eliminate duplicates when searching for deletable files.
This fixes the OSError that happens when the file cannot be found because
it was already deleted.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Have find_deleteable_files() search when called

Changes the function find_deleteable_files() to do a search when it is
called, rather than operating on old (and probably out-of-date) data.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Fix exception syntax

Fixes a stupid error in syntax made in the last commit.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[PAR2PARSER] Fix Par2Parser class

The original class was registering every PAR2 file as corrupt, even though
the old parser handled them fine. This reverts to the old parser, fixing
the problem.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Fix default deletion option

Change the default null response to the deletion prompt to not delete
anything.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Update par2parser calls

Update calls to the par2parser class to Par2Parser to reflect the name
change made in the previous commit.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Rename par2parser to Par2Parser

Renamed the par2parser module to Par2Parser. Updated rarslave.py with the
change.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Catch exceptions from par2parser

Add try / except blocks to catch exceptions that happen in the par2parser
class.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[PAR2PARSER] Add extra corrupt file checks

Add checks to calls of file.read() and file.seek() to make sure that
exceptions caused by these calls are caught. They usually occur because of
corrupt PAR2 files.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[PAR2PARSER] Tabify the file properly

Tabify the par2parser.py file properly.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[TESTS] Remove old tests

Remove some tests that correspond to features that were removed.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Fix interactive deletion

Adds the accidentally ommitted list of files to the prompt that gets
displayed during interactive deletion.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Change message log-level

Change the message of using the default extractor to be a verbose message,
since it is likely to come up when extracting mp3 sets, etc.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Improve "likely file" detection

Improve the likely file detection by using not only the name of the par2
files, but also what they are protecting. This should help a lot.

Update all uses of find_likely_files() to the new API.

Also, fix the filetype detectors so that they work, and move the duplicate
code to a new function.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Fix delete_list()

Fixes the delete_list() function so that it looks in the corrent directory
for the files to delete.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Fix directory switching 2

Important bugfix. This resets the directory we are in after running the
command given to run_command(). This is the expected behavior, but was
overlooked.

None of the current code relies on this behavior, but it's good to act as
expected, anyway.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Enable production actions

Remove all of the non-production testing actions, and enable all of the
real actions, including running commands, deleting files, etc.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Fix noextract extraction

This adds a fix to the noextract type of extraction (usually mv), which
will exit early (and successfully) if the same file is being moved between.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Fix working directory option

Add a check to make sure the working directory is valid before trying
anything, that way we don't fail later.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Add porcelain

Add all of the user-level polish, such as the option parser, and all
related functions which are needed to implement its actions.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[CONFIG] Remove unneeded option

Remove an unnecessary option from the RarslaveConfig class' default
options. Also, change the default loglevel to 0. (Fatal and Normal
messages only)

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Add debug logging messages

Add a couple of debug-level messages.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[LOGGER] Change inner workings (again)

Change the inner workings of the RarslaveLogger class so that it has
four different message types: Fatal, Normal, Verbose, Debug. This also
adds the function printLoglevel() to the RarslaveLogger class. It will
print all messages at a certain loglevel.

Also update the unit tests so that they behave with the current workings of
the RarslaveLogger class.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Add logging messages

Adds a lot of logging messages. Also audited (and added) many error return
values, as well as missing success paths.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Remove id requirement from RarslaveLogger

Remove the id requirement from RarslaveLogger. This reduces the class'
utility, but makes it much easier to use in the existing rarslave
infrastructure.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Change RarslaveLogger operation

Changes the RarslaveLogger class' method of operation to not require a
pre-generated id. Instead, it still requires an id, but keeps track of all
id's given to it.

This also removes the unit tests that tested the old behavior.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[CONFIG] Fix automatic absolutizing of directories

Fix the automatic absolutizing of directories in the RarslaveConfig class.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[CONFIG] Automatically absolute-ize directories

This patch makes the RarslaveConfig class automatically return the absolute
paths to directories, even though they are not stored in the config that
way.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Config-ify rarslave

Have rarslave rely on the RarslaveConfig class for all of its configuration
needs, such as options, regexes, etc.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[CONFIG] Update RarslaveConfig for rarslave2

Updates the RarslaveConfig class for rarslave2, removing things that were
only needed in the original rarslave, and adding new things that we need.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[CONFIG] Add RarslaveConfig class

Add the RarslaveConfig class, which is almost entirely imported from the
original rarslave program.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Fix extraction

Important bugfix. If the extraction directory is None, then we can safely
assume that we just don't want to do anything but a default extraction, not
outputting the files anywhere special.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Fix directory switching

Important bugfix. This fixes the directory switching code in the
run_command() function. Without this fix, the directory never gets switched
as expected.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Improve error handling

Improve the error handling, mostly of the main operations that occur during
a program run (check, repair, join, extract, delete).

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Improve deletion

Improve the deletion capabilities. This has initial support for deleting
interactively as well.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Add main program logic

Add the main program logic to the PAR2Set class. This handles verifying,
repairing, joining, extraction, and deletion of the leftover files in the
PAR set.

This also converts over the main() code to use this function exclusively.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Add PAR2 Parser

Add the class par2parser which parses PAR2 files to extract the list of
files which are "protected" by them.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Add PAR2Set class

Add the PAR2Set class, which is able to tell whether a parset is the same
as another set.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Add repairer

Add the class RarslaveRepairer which will repair / join par sets.

Also, change the no-extract heads to return the files that are protected by
the rar set, so that they can be mv'd later.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Merge with add-logger

[RARSLAVE] Add extraction class

Adds the RarslaveExtractor class which handles extraction of all types of
set supported by rarslave.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

[RARSLAVE] Add logging class

This adds the RarslaveLogger class, used for logging of messages on a
per-set basis. It also adds the support class RarslaveMessage, which is
used within RarslaveLogger.

Signed-off-by: Ira W. Snyder <devel@irasnyder.com>

Initial work on extraction.

Add type detection code.

Initial commit of the rarslave project.