hackers

Bloat is a basic Perl script to allow you to easily decompress files from many formats.

HACKERS
=======
NOTE - This doc is probably OUT OF DATE

This document contains an overview of all variables used, and what subroutines
do and take as arguments, and what filehandles are what.

Filehandles
===========

NAME:     CONFIG
FILE:     ~/.bloatrc OR /etc/bloatrc
PURPOSE:  The config file (if one exists)
NOTES:    ~/.bloatrc has a higher priority than /etc/bloatrc

Variables
=========

NAME:     $opentest
TYPE:     Boolean
PURPOSE:  Used to test whether open()s work.
SCOPE:    Global

NAME:     $closetest
TYPE:     Boolean
PURPOSE:  Used to test whether close()s work.
SCOPE:    Global

NAME:     $teststring
TYPE:     String
PURPOSE:  Used when testing for utilities; contains compressed forms of 
          "bloatcheck".
SCOPE:    Global 

NAME:     $filename
TYPE:     String
PURPOSE:  Contains the filename bloat is to work on
SCOPE:    Global

NAME:     $filetype
TYPE:     String
PURPOSE:  Holds the filetype, as used by bloat
SCOPE:    Global

NAME:     $version
TYPE:     String (numeric)
PURPOSE:  Contains the version number of bloat
SCOPE:    Global

NAME:     $verbose
TYPE:     Boolean
PURPOSE:  Controls whether bloat should provide verbose output or not
SCOPE:    Global

NAME:     $bloatsign
TYPE:     String
PURPOSE:  Provides the string to prefix any output
SCOPE:    Global

NAME:     $stop
TYPE:     Boolean
PURPOSE:  Used for handling stopping; at certain points, if this is true, bloat
          will stop (used, e.g., when $check is true).
SCOPE:    Global

NAME:     $check
TYPE:     Boolean
PURPOSE:  If --check is passed to bloat, this will be set to true and utility
          checking will occur.
SCOPE:    Global

NAME:     $error
TYPE:     Boolean
PURPOSE:  Becomes true if there's an error.
SCOPE:    Global, also used in extractFile

NAME:     $nowarn
TYPE:     Boolean
PURPOSE:  If the user does not want to be warned about missing utilities (for 
          some odd reason), and has a /etc/bloat-nowarn or ~/.bloat-nowarn
          this becomes 1.
SCOPE:    Global

NAME:     $checkforsubdirs
TYPE:     Boolean
PURPOSE:  Controls whether subdirectories should be checked for in zip and tar
          based archives.
SCOPE:    Global

NAME:     $getcontents
TYPE:     String
PURPOSE:  Provides the command needed to view the contents of an archive
SCOPE:    Global

NAME:     $type
TYPE:     String
PURPOSE:  Used when checking for subdirectories, to get the output format
SCOPE:    Global

NAME:     $longtype
TYPE:     String
PURPOSE:  Provides a user-friendly name for the archive format
SCOPE:    Global

NAME:     $extractcmd
TYPE:     String
PURPOSE:  Provides the command needed to extract the archive
SCOPE:    Global

NAME:     $fileext
TYPE:     String (joined with "o_O")
PURPOSE:  Passed to extractFile to specify what the file's possible extensions
          are
SCOPE:    Global

NAME:     $checksdir
TYPE:     Boolean
PURPOSE:  Set to true if an archive _can_ be checked for subdirectories
SCOPE:    Global

NAME:     $custcmd
TYPE:     Boolean
PURPOSE:  Set to true if an archive uses ugly/complex extraction techniques;
          hides the actual commands from the user
SCOPE:    Global

NAME:     $mknewdir
TYPE:     Boolean
PURPOSE:  Set to true if a new directory is to be created
SCOPE:    Global

NAME:     %loc
TYPE:     Hash, contains strings
PURPOSE:  Contains the locations of extraction utilities (e.g. $loc{tar}
          provides the location of tar).
SCOPE:    Global

NAME:     $option
TYPE:     String
PURPOSE:  Contains the currently-processed argument given to bloat
SCOPE:    Only used in checkForArgs

NAME:     @input
TYPE:     Array of arguments
PURPOSE:  Contains the <STRINGS> given in &subName(<STRINGS>);
SCOPE:    Only used in checkForSubdirs and extractFile (different variables
          in different subroutines)

NAME:     $hasitgotstuffoutofsubdirs
TYPE:     Boolean
PURPOSE:  Set to true if there are files in the "root" directory of an archive
SCOPE:    Only used in checkForSubdirs

NAME:     @listofstuff
TYPE:     Array of strings
PURPOSE:  Contains the results of running $getcontents
SCOPE:    Only used in checkForSubdirs

NAME:     $line
TYPE:     String
PURPOSE:  Contains the currently-processed line in @listofstuff
SCOPE:    Only used in checkForSubdirs

NAME:     @fileext
TYPE:     Array of strings
PURPOSE:  An array-ised version of $fileext
SCOPE:    Only used in extractFile

NAME:     $doneextract
TYPE:     Boolean
PURPOSE:  Set to true when the file has been extracted
SCOPE:    Only used in extractFile

NAME:     $devnull
TYPE:     String
PURPOSE:  Normally ">/dev/null", unset if $verbose is true.
SCOPE:    Only used in extractFile

NAME:     $dirname
TYPE:     String
PURPOSE:  If a new directory is to be created, it will be called "$dirname"
SCOPE:    Only used in extractFile

NAME:     $dontusemimetypedetection
TYPE:     Boolean
PURPOSE:  Set to true to disable MIME-type detection.
SCOPE:    Global

NAME:     $dodgyresult
TYPE:     Boolean
PURPOSE:  Set to true if it's impossible to tell whether an archive contains
          another archive (e.g. with tar/bzip2 files).
SCOPE:    Global

NAME:     $mimename
TYPE:     String
PURPOSE:  getMimeType-specific version of $filename
SCOPE:    getMimeType

NAME:     $mimetype
TYPE:     String
PURPOSE:  A "working variable" for getMimeType - eventually contains string
          which goes into $filetype
SCOPE:    getMimeType

NAME:     $gofortar
TYPE:     Boolean
PURPOSE:  When true, ambiguous archives [see $dodgyresult] will use tar
SCOPE:    Global

NAME:     $filetypecheck
TYPE:     String
PURPOSE:  Used to see if a filetype has been assigned in getFileType
SCOPE:    getFileType

NAME:     $lastfile
TYPE:     String
PURPOSE:  Used in checkForSubdirs for checking of subdirs
SCOPE:    checkForSubdirs

NAME:     $date
TYPE:     String
PURPOSE:  Contains the current date
SCOPE:    Global

NAME:     $month
TYPE:     String
PURPOSE:  Used for working out the month
SCOPE:    Global

NAME:     $hasnonsubdirs
TYPE:     Boolean
PURPOSE:  See $hasitgotstuffoutofsubdirs
SCOPE:    Only used in extractFile

Subroutines
===========

NAME:      getHelp
ARGUMENTS: None
PURPOSE:   Provides the help text
RETURNS:   Nothing

NAME:      checkForArgs
ARGUMENTS: None
PURPOSE:   Checks the arguments supplied to bloat
RETURNS:   Nothing

NAME:      checkForSubdirs
ARGUMENTS: $getcontents, $type
PURPOSE:   Checks for files in the "root" directory
RETURNS:   1 if there are files in the root, 0 if not

NAME:      extractFile
ARGUMENTS: $getcontents, $type, $longtype, $extractcmd, $fileext, $checksdir,
           $custcmd, $mknewdir, $verbose
PURPOSE:   Extracts the archive
RETURNS:   1 if there was an error, 0 if not

NAME:      getFileType
ARGUMENTS: None
PURPOSE:   Gets the filetype and stores it in $filetype
RETURNS:   Nothing

NAME:      getExtractor
ARGUMENTS: None
PURPOSE:   Checks for the locations/existance of extractors
RETURNS:   Nothing

NAME:      runExractor
ARGUMENTS: None
PURPOSE:   Sorts out what to pass to extractFile (badly named, "legacy" name)
RETURNS:   Nothing

NAME:      getMimeType
ARGUMENTS: $filename
PURPOSE:   Discovers the file format of unrecognised files
RETURNS:   $filetype, $dodgyresult

NAME:      parseConfig
ARGUMENTS: None
PURPOSE:   Parses the config file
RETURNS:   Nothing

Last Updated: 2004-04-09