From 0ad5c2985939eabd4864fbc4aed80e209508d0e4 Mon Sep 17 00:00:00 2001
From: Michael Prokop <mika@grml.org>
Date: Sat, 29 Nov 2008 13:07:12 +0100
Subject: [PATCH] Remove arename.pl

---
 debian/changelog   |   7 +
 debian/copyright   |  29 --
 debian/overrides   |   2 -
 debian/rules       |   5 +-
 manpages/arename.1 | 341 -----------------------
 usr_bin/arename.pl | 793 -----------------------------------------------------
 6 files changed, 9 insertions(+), 1168 deletions(-)
 delete mode 100644 manpages/arename.1
 delete mode 100755 usr_bin/arename.pl

diff --git a/debian/changelog b/debian/changelog
index b8d03f1..3710d88 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+grml-scripts (1.1.14) unstable; urgency=low
+
+  * Remove arename.pl, thanks ft.
+    [Closes: issue574] [Closes: issue435]
+
+ -- Michael Prokop <mika@grml.org>  Sat, 29 Nov 2008 13:04:23 +0100
+
 grml-scripts (1.1.13) unstable; urgency=low
 
   * grml-info: improve checks for present browsers.
diff --git a/debian/copyright b/debian/copyright
index 4418ce8..c581bdc 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -13,32 +13,3 @@ Scripts by the grml-team are licensed under GPL v2.
 
 On Debian GNU/Linux systems, the complete text of the GNU General
 Public License can be found in `/usr/share/common-licenses/GPL'.
-
-
-usr_bin/arename.pl:
-
- Copyright 2007 Frank Terbeck <ft@bewatermyfriend.org>, All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
-
-   1. Redistributions of source code must retain the above
-      copyright notice, this list of conditions and the following
-      disclaimer.
-   2. Redistributions in binary form must reproduce the above
-      copyright notice, this list of conditions and the following
-      disclaimer in the documentation and/or other materials
-      provided with the distribution.
-
-  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
-  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS OF THE
-  PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-  OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/debian/overrides b/debian/overrides
index 0029def..f5b14bd 100644
--- a/debian/overrides
+++ b/debian/overrides
@@ -1,8 +1,6 @@
 grml-scripts: executable-not-elf-or-script ./usr/bin/exifinfo
 grml-scripts: executable-not-elf-or-script ./usr/bin/tinyp2p.py
 grml-scripts: executable-not-elf-or-script ./usr/bin/wwwis
-grml-scripts: manpage-has-bad-whatis-entry usr/share/man/man1/arename.1.gz
-grml-scripts: script-with-language-extension usr/bin/arename.pl
 grml-scripts: script-with-language-extension usr/bin/bincompare.pl
 grml-scripts: script-with-language-extension usr/bin/cpufreq-detect.sh
 grml-scripts: script-with-language-extension usr/bin/cpu-screen.sh
diff --git a/debian/rules b/debian/rules
index 8486c49..7769b14 100755
--- a/debian/rules
+++ b/debian/rules
@@ -55,7 +55,7 @@ binary-arch: build install
 	dh_installchangelogs
 	dh_installdocs
 	dh_installman $(wildcard doc/*.gz)
-	dh_installman manpages/arename.1 manpages/grml-scripts.1 \
+	dh_installman manpages/grml-scripts.1 \
 	manpages/reread_partition_table.8 manpages/random-hostname.1 \
 	manpages/grml-setkeyboard.8 manpages/grml-setlang.8 manpages/getsf.1 \
 	manpages/grml-iptstate.8 manpages/qma.1 manpages/grml-swapon.8 \
@@ -153,8 +153,7 @@ binary-arch: build install
 		/usr/share/man/man1/grml-scripts.1.gz /usr/share/man/man1/XF86AudioMute.1.gz \
 		/usr/share/man/man1/grml-scripts.1.gz /usr/share/man/man1/XF86AudioRaiseVolume.1.gz \
 		/usr/share/man/man1/grml-scripts.1.gz /usr/share/man/man1/zsh-login.1.gz \
-		/usr/share/man/man1/gsuggest.1.gz     /usr/share/man/man1/gsuggest.pl.1.gz \
-		/usr/share/man/man1/arename.1.gz     /usr/share/man/man1/arename.pl.1.gz
+		/usr/share/man/man1/gsuggest.1.gz     /usr/share/man/man1/gsuggest.pl.1.gz
 	dh_strip
 	dh_compress
 	mkdir -p $(CURDIR)/debian/grml-scripts/usr/share/lintian/overrides/
diff --git a/manpages/arename.1 b/manpages/arename.1
deleted file mode 100644
index 3a22652..0000000
--- a/manpages/arename.1
+++ /dev/null
@@ -1,341 +0,0 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
-.\"
-.\" Standard preamble:
-.\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Vb \" Begin verbatim text
-.ft CW
-.nf
-.ne \\$1
-..
-.de Ve \" End verbatim text
-.ft R
-.fi
-..
-.\" Set up some character translations and predefined strings.  \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
-.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-.ie n \{\
-.    ds -- \(*W-
-.    ds PI pi
-.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
-.    ds L" ""
-.    ds R" ""
-.    ds C` ""
-.    ds C' ""
-'br\}
-.el\{\
-.    ds -- \|\(em\|
-.    ds PI \(*p
-.    ds L" ``
-.    ds R" ''
-'br\}
-.\"
-.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
-.\" entries marked with X<> in POD.  Of course, you'll have to process the
-.\" output yourself in some meaningful fashion.
-.if \nF \{\
-.    de IX
-.    tm Index:\\$1\t\\n%\t"\\$2"
-..
-.    nr % 0
-.    rr F
-.\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
-.    \" fudge factors for nroff and troff
-.if n \{\
-.    ds #H 0
-.    ds #V .8m
-.    ds #F .3m
-.    ds #[ \f1
-.    ds #] \fP
-.\}
-.if t \{\
-.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-.    ds #V .6m
-.    ds #F 0
-.    ds #[ \&
-.    ds #] \&
-.\}
-.    \" simple accents for nroff and troff
-.if n \{\
-.    ds ' \&
-.    ds ` \&
-.    ds ^ \&
-.    ds , \&
-.    ds ~ ~
-.    ds /
-.\}
-.if t \{\
-.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-.    \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-.    \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-.    \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-.    ds : e
-.    ds 8 ss
-.    ds o a
-.    ds d- d\h'-1'\(ga
-.    ds D- D\h'-1'\(hy
-.    ds th \o'bp'
-.    ds Th \o'LP'
-.    ds ae ae
-.    ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
-.\" ========================================================================
-.\"
-.IX Title "ARENAME 1"
-.TH ARENAME 1 "2007-10-28" "perl v5.8.8" "User Contributed Perl Documentation"
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
-arename.pl [\s-1OPTION\s0(s)] \s-1FILE\s0(s)...
-.SH "OPTIONS AND ARGUMENTS"
-.IX Header "OPTIONS AND ARGUMENTS"
-.IP "\fB\-d\fR" 8
-.IX Item "-d"
-Go into dryrun mode.
-.IP "\fB\-f\fR" 8
-.IX Item "-f"
-Overwrite files if needed.
-.IP "\fB\-h\fR" 8
-.IX Item "-h"
-Display a short help text.
-.IP "\fB\-V\fR" 8
-.IX Item "-V"
-Display version infomation.
-.IP "\fB\-v\fR" 8
-.IX Item "-v"
-Enable verbose output.
-.IP "\fB\-p\fR <prefix>" 8
-.IX Item "-p <prefix>"
-Define a prefix for destination files.
-.IP "\fB\-T\fR <template>" 8
-.IX Item "-T <template>"
-Define a compilation template.
-.IP "\fB\-t\fR <template>" 8
-.IX Item "-t <template>"
-Define a generic template.
-.IP "\fI\s-1FILE\s0(s)...\fR" 8
-.IX Item "FILE(s)..."
-Input files, that are subject for renaming.
-.SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
-\&\fBarename.pl\fR is a tool that is able to rename audio files by looking at
-a file's tagging information, from which it will assemble a consistent
-destination file name. The format of that filename is configurable for the
-user by the use of template strings.
-.PP
-\&\fBarename.pl\fR currently supports two widely used audio formats, namely
-\&\s-1MPEG\s0 Layer3 and ogg vorbis. The format, that \fBarename.pl\fR will assume
-for each input file is determined by the file's filename-extension
-(\fI.mp3\fR vs. \fI.ogg\fR). The extension check is case\-insensitive.
-.PP
-By default, \fBarename.pl\fR will refuse to overwrite destination files,
-if the file in question already exists. You can force overwriting by
-supplying the \fB\-f\fR option.
-.SH "FILES"
-.IX Header "FILES"
-\&\fBarename.pl\fR uses up to two configuration files. As for most programs,
-the script will try to read a configuration file, that is located in the
-user's \fIhome directory\fR. In addition to that, it will try to load \fIlocal\fR
-configuration files, if it finds appropriately named files in the
-\&\fIcurrent directory\fR.
-.IP "\fB~/.arenamerc\fR" 8
-.IX Item "~/.arenamerc"
-per-user global configuration file.
-.IP "\fB./.arename.local\fR" 8
-.IX Item "./.arename.local"
-per-directory local configuration file.
-.Sh "File format"
-.IX Subsection "File format"
-The format of the aforementioned files is pretty simple.
-It is parsed line by line. Empty lines, lines only containing whitespace
-and lines, whose first non whitespace character is a hash character (\fI#\fR)
-are ignored.
-.PP
-Each line consists of one or two parts. If there are two parts,
-they are separated by whitespace. The first part of the line will be used
-as the identifier of a setting (eg. \fIverbose\fR). The second part (read: the
-rest of the line) is used as the value of the setting. (No quoting, or whatsoever
-is required.)
-.PP
-If a line consists of only one part, that means the setting is switched on.
-.Sh "Configuration file example"
-.IX Subsection "Configuration file example"
-.Vb 2
-\&  # switch on verbosity
-\&  verbose
-.Ve
-.PP
-.Vb 2
-\&  # the author is crazy! use a sane template by default. :\-)
-\&  template &artist \- &album (&year) \- &tracknumber. &tracktitle
-.Ve
-.SH "SETTINGS"
-.IX Header "SETTINGS"
-The following settings are supported in all configuration files:
-.IP "\fBcomp_template\fR" 8
-.IX Item "comp_template"
-Defines a template to use with files that provide a compilation tag
-(for 'various artist' CDs, for example). This setting can still be
-overwritten by the \fB\-T\fR command line option. (default value:
-\&\fIva/&album/&tracknumber \- &artist \- &tracktitle\fR)
-.IP "\fBdefault_year\fR" 8
-.IX Item "default_year"
-Defines a default year, for files, that lack this information.
-(default value: \fIundefined\fR)
-.IP "\fBprefix\fR" 8
-.IX Item "prefix"
-Defines a prefix for destination files. This setting can still be
-overwritten by the \fB\-p\fR command line option. (default value: \fI.\fR)
-.IP "\fBsepreplace\fR" 8
-.IX Item "sepreplace"
-Tagging information strings may contain slashes, which is a pretty bad
-idea on most filesystems. Therefore, you can define a string, that replaces
-slashes with the value of this setting. (default value: \fI_\fR)
-.IP "\fBtemplate\fR" 8
-.IX Item "template"
-Defines a template to use with files that do not provide a compilation tag
-(or where the compilation tag and the artist tag are exactly the same).
-This setting can still be overwritten by the \fB\-T\fR command line option.
-(default value: \fI&artist[1]/&artist/&album/&tracknumber \- &tracktitle\fR)
-.IP "\fBtnpad\fR" 8
-.IX Item "tnpad"
-This defines the width, to which the tracknumber field is padded with zeros
-on the left. (default value: \fI2\fR)
-.IP "\fBverbose\fR" 8
-.IX Item "verbose"
-Switches on verbosity by default. (default value: \fIoff\fR)
-.SH "TEMPLATE FORMAT"
-.IX Header "TEMPLATE FORMAT"
-\&\fBarename.pl\fR's templates are quite simple, yet powerful.
-.PP
-At simplest, a template is just a fixes character string. However, that would
-not be exactly useful. So, the script is able to expand certain expressions
-with information gathered from the file's tagging information.
-.PP
-The expressions can have two slightly different forms:
-.IP "\fB&\fR\fIidentifier\fR" 8
-.IX Item "&identifier"
-The simple form.
-.IP "\fB&\fR\fIidentifier\fR\fB[\fR\fIlength\fR\fB]\fR" 8
-.IX Item "&identifier[length]"
-The \*(L"complex\*(R" form. The \fIlength\fR argument in square brackets defines the
-maximum length, to which the expression should be expanded.
-.Sh "Available expression identifiers"
-.IX Subsection "Available expression identifiers"
-The data, that is expanded is derived from tagging information in
-the audio files. For \fI.ogg\fR files, the tag checking \fBarename.pl\fR does
-is case insensitive and the first matching tag will be used.
-.IP "\fBalbum\fR" 8
-.IX Item "album"
-Guess.
-.IP "\fBartist\fR" 8
-.IX Item "artist"
-Guess again.
-.IP "\fBcompilation\fR" 8
-.IX Item "compilation"
-For \fI.ogg\fR this is filled with information found in the 'albumartist' tag.
-For \fI.mp3\fR this is filled with information from the id3v2 \s-1TPE2\s0 frame.
-If the mp3 file only provides a id3v1 tag, this is not supported.
-.IP "\fBtracknumber\fR" 8
-.IX Item "tracknumber"
-The number of the position of the track on the disc. Obviously. However, this
-can be in the form of '12' or '12/23'. In the second form, only the part left
-of the slash is used. The tracknumber is a little special, as you can defined
-to what width it should be padded with zeros on the left (see \fItnpad\fR setting
-in \*(L"\s-1SETTINGS\s0\*(R" in \fIarename\fR\|(1)).
-.IP "\fBtracktitle\fR" 8
-.IX Item "tracktitle"
-Well...
-.IP "\fByear\fR" 8
-.IX Item "year"
-Year (id3v1), \s-1TYER\s0 (id3v2) or \s-1DATE\s0 tag (.ogg).
-.SH "SEE ALSO"
-.IX Header "SEE ALSO"
-\&\fIOgg::Vorbis::Header\fR\|(3) and \fIMP3::Tag\fR\|(3).
-.SH "AUTHOR"
-.IX Header "AUTHOR"
-Frank Terbeck <ft@bewatermyfriend.org>,
-.PP
-Please report bugs.
-.SH "LICENSE"
-.IX Header "LICENSE"
-.Vb 2
-\& Copyright 2007
-\& Frank Terbeck <ft@bewatermyfriend.org>, All rights reserved.
-.Ve
-.PP
-.Vb 3
-\& Redistribution and use in source and binary forms, with or without
-\& modification, are permitted provided that the following conditions
-\& are met:
-.Ve
-.PP
-.Vb 7
-\&   1. Redistributions of source code must retain the above
-\&      copyright notice, this list of conditions and the following
-\&      disclaimer.
-\&   2. Redistributions in binary form must reproduce the above
-\&      copyright notice, this list of conditions and the following
-\&      disclaimer in the documentation and/or other materials
-\&      provided with the distribution.
-.Ve
-.PP
-.Vb 11
-\&  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
-\&  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-\&  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-\&  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS OF THE
-\&  PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-\&  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-\&  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-\&  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-\&  OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-\&  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-\&  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-.Ve
diff --git a/usr_bin/arename.pl b/usr_bin/arename.pl
deleted file mode 100755
index 465df5f..0000000
--- a/usr_bin/arename.pl
+++ /dev/null
@@ -1,793 +0,0 @@
-#!/usr/bin/perl
-use warnings;
-use strict;
-
-use Getopt::Std;
-use File::Basename;
-use File::Copy;
-use MP3::Tag;
-use Ogg::Vorbis::Header;
-
-# documentation {{{
-=head1 NAME
-
-arename.pl - automatically rename audio files by tagging information
-
-=head1 SYNOPSIS
-
-arename.pl [OPTION(s)] FILE(s)...
-
-=head1 OPTIONS AND ARGUMENTS
-
-=over 8
-
-=item B<-d>
-
-Go into dryrun mode.
-
-=item B<-f>
-
-Overwrite files if needed.
-
-=item B<-h>
-
-Display a short help text.
-
-=item B<-V>
-
-Display version infomation.
-
-=item B<-v>
-
-Enable verbose output.
-
-=item B<-p> E<lt>prefixE<gt>
-
-Define a prefix for destination files.
-
-=item B<-T> E<lt>templateE<gt>
-
-Define a compilation template.
-
-=item B<-t> E<lt>templateE<gt>
-
-Define a generic template.
-
-=item I<FILE(s)...>
-
-Input files, that are subject for renaming.
-
-=back
-
-=head1 DESCRIPTION
-
-B<arename.pl> is a tool that is able to rename audio files by looking at
-a file's tagging information, from which it will assemble a consistent
-destination file name. The format of that filename is configurable for the
-user by the use of template strings.
-
-B<arename.pl> currently supports two widely used audio formats, namely
-MPEG Layer3 and ogg vorbis. The format, that B<arename.pl> will assume
-for each input file is determined by the file's filename-extension
-(I<.mp3> vs. I<.ogg>). The extension check is case-insensitive.
-
-By default, B<arename.pl> will refuse to overwrite destination files,
-if the file in question already exists. You can force overwriting by
-supplying the B<-f> option.
-
-=head1 FILES
-
-B<arename.pl> uses up to two configuration files. As for most programs,
-the script will try to read a configuration file, that is located in the
-user's I<home directory>. In addition to that, it will try to load I<local>
-configuration files, if it finds appropriately named files in the
-I<current directory>.
-
-=over 8
-
-=item B<~/.arenamerc>
-
-per-user global configuration file.
-
-=item B<./.arename.local>
-
-per-directory local configuration file.
-
-=back
-
-=head2 File format
-
-The format of the aforementioned files is pretty simple.
-It is parsed line by line. Empty lines, lines only containing whitespace
-and lines, whose first non whitespace character is a hash character (I<#>)
-are ignored.
-
-Each line consists of one or two parts. If there are two parts,
-they are separated by whitespace. The first part of the line will be used
-as the identifier of a setting (eg. I<verbose>). The second part (read: the
-rest of the line) is used as the value of the setting. (No quoting, or whatsoever
-is required.)
-
-If a line consists of only one part, that means the setting is switched on.
-
-=head2 Configuration file example
-
-  # switch on verbosity
-  verbose
-
-  # the author is crazy! use a sane template by default. :-)
-  template &artist - &album (&year) - &tracknumber. &tracktitle
-
-=head1 SETTINGS
-
-The following settings are supported in all configuration files:
-
-=over 8
-
-=item B<comp_template>
-
-Defines a template to use with files that provide a compilation tag
-(for 'various artist' CDs, for example). This setting can still be
-overwritten by the B<-T> command line option. (default value:
-I<va/&album/&tracknumber - &artist - &tracktitle>)
-
-=item B<default_year>
-
-Defines a default year, for files, that lack this information.
-(default value: I<undefined>)
-
-=item B<prefix>
-
-Defines a prefix for destination files. This setting can still be
-overwritten by the B<-p> command line option. (default value: I<.>)
-
-=item B<sepreplace>
-
-Tagging information strings may contain slashes, which is a pretty bad
-idea on most filesystems. Therefore, you can define a string, that replaces
-slashes with the value of this setting. (default value: I<_>)
-
-=item B<template>
-
-Defines a template to use with files that do not provide a compilation tag
-(or where the compilation tag and the artist tag are exactly the same).
-This setting can still be overwritten by the B<-T> command line option.
-(default value: I<&artist[1]/&artist/&album/&tracknumber - &tracktitle>)
-
-=item B<tnpad>
-
-This defines the width, to which the tracknumber field is padded with zeros
-on the left. (default value: I<2>)
-
-=item B<verbose>
-
-Switches on verbosity by default. (default value: I<off>)
-
-=back
-
-=head1 TEMPLATE FORMAT
-
-B<arename.pl>'s templates are quite simple, yet powerful.
-
-At simplest, a template is just a fixes character string. However, that would
-not be exactly useful. So, the script is able to expand certain expressions
-with information gathered from the file's tagging information.
-
-The expressions can have two slightly different forms:
-
-=over 8
-
-=item B<&>I<identifier>
-
-The simple form.
-
-=item B<&>I<identifier>B<[>I<length>B<]>
-
-The "complex" form. The I<length> argument in square brackets defines the
-maximum length, to which the expression should be expanded.
-
-=back
-
-=head2 Available expression identifiers
-
-The data, that is expanded is derived from tagging information in
-the audio files. For I<.ogg> files, the tag checking B<arename.pl> does
-is case insensitive and the first matching tag will be used.
-
-=over 8
-
-=item B<album>
-
-Guess.
-
-=item B<artist>
-
-Guess again.
-
-=item B<compilation>
-
-For I<.ogg> this is filled with information found in the 'albumartist' tag.
-For I<.mp3> this is filled with information from the id3v2 TPE2 frame.
-If the mp3 file only provides a id3v1 tag, this is not supported.
-
-=item B<tracknumber>
-
-The number of the position of the track on the disc. Obviously. However, this
-can be in the form of '12' or '12/23'. In the second form, only the part left
-of the slash is used. The tracknumber is a little special, as you can defined
-to what width it should be padded with zeros on the left (see I<tnpad> setting
-in L<arename(1)/SETTINGS>).
-
-=item B<tracktitle>
-
-Well...
-
-=item B<year>
-
-Year (id3v1), TYER (id3v2) or DATE tag (.ogg).
-
-=back
-
-=head1 SEE ALSO
-
-L<Ogg::Vorbis::Header(3)> and L<MP3::Tag(3)>.
-
-=head1 AUTHOR
-
-Frank Terbeck E<lt>ft@bewatermyfriend.orgE<gt>,
-
-Please report bugs.
-
-=head1 LICENSE
-
- Copyright 2007
- Frank Terbeck <ft@bewatermyfriend.org>, All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
-
-   1. Redistributions of source code must retain the above
-      copyright notice, this list of conditions and the following
-      disclaimer.
-   2. Redistributions in binary form must reproduce the above
-      copyright notice, this list of conditions and the following
-      disclaimer in the documentation and/or other materials
-      provided with the distribution.
-
-  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
-  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS OF THE
-  PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-  OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-=cut
-#}}}
-# variables {{{
-my (
-    %defaults, %methods, %opts,
-    $dryrun, $comp_template, $force, $prefix,
-    $sepreplace, $template, $tnpad, $verbose
-);
-my ($NAME, $VERSION) = ( 'arename.pl', 'v0.3' );
-#}}}
-sub apply_defaults { #{{{
-    my ($datref) = @_;
-
-    foreach my $key (keys %defaults) {
-        if (!defined $datref->{$key}) {
-            if ($verbose) {
-                print "  -!- Setting ($key) to \"$defaults{$key}\".\n";
-            }
-            $datref->{$key} = $defaults{$key};
-        }
-    }
-}
-#}}}
-sub arename { #{{{
-    my ($file, $datref, $ext) = @_;
-    my ($t, $newname);
-
-    apply_defaults($datref);
-
-    if ($verbose) { #{{{
-        print "  -!- Artist     : \"" .
-            (defined $datref->{artist}      ? $datref->{artist}      : "-.-")
-            . "\"\n";
-        print "  -!- Compilation: \"" .
-            (defined $datref->{compilation} ? $datref->{compilation} : "-.-")
-            . "\"\n";
-        print "  -!- Album      : \"" .
-            (defined $datref->{album}       ? $datref->{album}       : "-.-")
-            . "\"\n";
-        print "  -!- Tracktitle : \"" .
-            (defined $datref->{tracktitle}  ? $datref->{tracktitle}  : "-.-")
-            . "\"\n";
-        print "  -!- Tracknumber: \"" .
-            (defined $datref->{tracknumber} ? $datref->{tracknumber} : "-.-")
-            . "\"\n";
-        print "  -!- Year       : \"" .
-            (defined $datref->{year}        ? $datref->{year}        : "-.-")
-            . "\"\n";
-    } #}}}
-
-    if (defined $datref->{compilation}
-        && $datref->{compilation} ne $datref->{artist}) {
-
-        $t = $comp_template;
-    } else {
-        $t = $template;
-    }
-
-    $newname = expand_template($t, $datref);
-    if (!defined $newname) {
-        return;
-    }
-
-    $newname = $prefix . '/' . $newname . '.' . $ext;
-
-    if (file_eq($newname, $file)) {
-        print "  -!- ($file)\n      would stay the way it is, skipping.\n";
-        return;
-    }
-
-    if (-e $newname && !$force) {
-        print "  -!- ($newname) exists.\n      use '-f' to force overwriting.\n";
-        return;
-    }
-
-    ensure_dir(dirname($newname));
-
-    print "  -!- mv '$file' \\\n" . 
-          "         '$newname'\n";
-
-    if (!$dryrun) {
-        xrename($file, $newname);
-    }
-}
-#}}}
-sub ensure_dir { #{{{
-    # think: mkdir -p /foo/bar/baz
-    my ($wantdir) = @_;
-    my (@parts, $sofar);
-
-    if (-d $wantdir) {
-        return;
-    }
-
-    if ($wantdir =~ '^/') {
-        $sofar = '/';
-    } else {
-        $sofar = '';
-    }
-
-    @parts = split(/\//, $wantdir);
-    foreach my $part (@parts) {
-        if ($part eq '') {
-            next;
-        }
-        $sofar = (
-                  $sofar eq ''
-                    ? $part
-                    : (
-                        $sofar eq '/'
-                          ? '/' . $part
-                          : $sofar . "/" . $part
-                      )
-                 );
-
-        if (!-d $sofar) {
-            if ($dryrun || $verbose) {
-                print "  -!- mkdir \"$sofar\"\n";
-            }
-            if (!$dryrun) {
-                mkdir($sofar) or die "  -!- Could not mkdir($sofar).\n" .
-                                     "  -!- Reason: $!\n";
-            }
-        }
-    }
-}
-#}}}
-sub expand_template { #{{{
-    my ($template, $datref) = @_;
-    my @tags = (
-        'album',
-        'artist',
-        'compilation',
-        'tracknumber',
-        'tracktitle',
-        'year'
-    );
-
-    foreach my $tag (@tags) {
-        my ($len, $token);
-
-        while ($template =~ m/&$tag(\[(\d+)\]|)/) {
-            $len = 0;
-            if (defined $2) { $len = $2; }
-
-            if (!defined $datref->{$tag} || $datref->{$tag} eq '') {
-                warn "  -!- $tag not defined, but required by template. Giving up.\n";
-                return undef;
-            }
-
-            if ($len > 0) {
-                $token = substr($datref->{$tag}, 0, $len);
-            } else {
-                if ($tag eq 'tracknumber') {
-                    my $val;
-                    if ($datref->{$tag} =~ m/^([^\/]*)\/.*$/) {
-                        $val = $1;
-                    } else {
-                        $val = $datref->{$tag};
-                    }
-                    $token = sprintf "%0" . $tnpad . "d", $val;
-                } else {
-                    $token = $datref->{$tag};
-                }
-            }
-            if ($token =~ m!/!) {
-                if ($verbose) {
-                    print "  -!- Found directory seperator in token.\n";
-                    print "  -!- Replacing with \"$sepreplace\".\n";
-                }
-                $token =~ s!/!$sepreplace!g;
-            }
-            $template =~ s/&$tag(\[(\d+)\]|)/$token/;
-        }
-    }
-
-    return $template;
-}
-#}}}
-sub file_eq { #{{{
-    my ($f0, $f1) = @_;
-    my (@stat0, @stat1);
-
-    if (!-e $f0 || !-e $f1) {
-        # one of the two doesn't even exist, can't be the same then.
-        return 0;
-    }
-
-    @stat0 = stat $f0 or die "Could not stat($f0): $!\n";
-    @stat1 = stat $f1 or die "Could not stat($f1): $!\n";
-
-    if ($stat0[0] == $stat1[0] && $stat0[1] == $stat1[1]) {
-        # device and inode are the same. same file.
-        return 1;
-    }
-
-    return 0;
-}
-#}}}
-sub process_mp3 { #{{{
-    my ($file) = @_;
-    my ($mp3, %data, $info);
-
-    $mp3 = MP3::Tag->new($file);
-
-    if (!defined $mp3) {
-        print "  -!- Failed to open \"$file\".\n  -!- Reason: $!\n";
-        return;
-    }
-
-    $mp3->get_tags;
-
-    if (!exists $mp3->{ID3v1} && !exists $mp3->{ID3v2}) {
-        print "  -!- No tag found. Ignoring.\n";
-        $mp3->close();
-        return;
-    }
-
-    if (exists $mp3->{ID3v2}) {
-        ($data{artist},      $info) = $mp3->{ID3v2}->get_frame("TPE1");
-        ($data{compilation}, $info) = $mp3->{ID3v2}->get_frame("TPE2");
-        ($data{album},       $info) = $mp3->{ID3v2}->get_frame("TALB");
-        ($data{tracktitle},  $info) = $mp3->{ID3v2}->get_frame("TIT2");
-        ($data{tracknumber}, $info) = $mp3->{ID3v2}->get_frame("TRCK");
-        ($data{year},        $info) = $mp3->{ID3v2}->get_frame("TYER");
-    } elsif (exists $mp3->{ID3v1}) {
-        print "  -!- Only found ID3v1 tag.\n";
-        $data{artist}      = $mp3->{ID3v1}->artist;
-        $data{album}       = $mp3->{ID3v1}->album;
-        $data{tracktitle}  = $mp3->{ID3v1}->title;
-        $data{tracknumber} = $mp3->{ID3v1}->track;
-        $data{year}        = $mp3->{ID3v1}->year;
-    }
-
-    $mp3->close();
-
-    arename($file, \%data, 'mp3');
-}
-#}}}
-sub process_ogg { #{{{
-    my ($file) = @_;
-    my ($ogg, %data, @tags);
-
-    $ogg = Ogg::Vorbis::Header->load($file);
-
-    if (!defined $ogg) {
-        print "  -!- Failed to open \"$file\".\n  -!- Reason: $!\n";
-        return;
-    }
-
-    @tags = $ogg->comment_tags;
-
-    foreach my $tag (@tags) {
-        my ($realtag, $value);
-        if (!(
-                $tag =~ m/^ALBUM$/i         ||
-                $tag =~ m/^ARTIST$/i        ||
-                $tag =~ m/^TITLE$/i         ||
-                $tag =~ m/^TRACKNUMBER$/i   ||
-                $tag =~ m/^DATE$/i          ||
-                $tag =~ m/^ALBUMARTIST$/i
-            )) { next; }
-
-        $value = join(' ', $ogg->comment($tag));
-        if ($tag =~ m/^ALBUM$/i) {
-            $realtag = 'album';
-        } elsif ($tag =~ m/^ARTIST$/i) {
-            $realtag = 'artist';
-        } elsif ($tag =~ m/^TITLE$/i) {
-            $realtag = 'tracktitle';
-        } elsif ($tag =~ m/^TRACKNUMBER$/i) {
-            $realtag = 'tracknumber';
-        } elsif ($tag =~ m/^DATE$/i) {
-            $realtag = 'year';
-        } elsif ($tag =~ m/^ALBUMARTIST$/i) {
-            $realtag = 'compilation';
-        } else {
-            die "This should not happen. Report this BUG. ($tag, $value)";
-        }
-
-        if (!defined $data{$realtag}) {
-            $data{$realtag} = $value;
-        }
-    }
-
-    arename($file, \%data, 'ogg');
-}
-#}}}
-sub process_warn { #{{{
-    my ($file) = @_;
-
-    warn "  -!- No method for handling \"$file\".\n";
-}
-#}}}
-sub rcload { #{{{
-    my ($file, $desc) = @_;
-    my ($fh, $retval);
-    my $count = 0;
-    my $lnum  = 0;
-
-    if (!open($fh, "<$file")) {
-        warn "Failed to read $desc ($file).\n  -!- Reason: $!\n";
-        return 1;
-    }
-
-    print "Reading \"$file\"...\n";
-
-    while (my $line = <$fh>) {
-        chomp($line);
-        $lnum++;
-
-        if ($line =~ m/^\s*#/ || $line =~ m/^\s*$/) {
-            next;
-        }
-
-        $line =~ s/^\s*//;
-        my ($key,$val) = split(/\s+/, $line, 2);
-
-        if ($key eq 'template') {
-            $template = $val;
-        } elsif ($key eq 'comp_template') {
-            $comp_template = $val;
-        } elsif ($key eq 'default_year') {
-            $defaults{year} = $val;
-        } elsif ($key eq 'sepreplace') {
-            $sepreplace = (defined $val ? $val : "");
-        } elsif ($key eq 'tnpad') {
-            $tnpad = $val;
-        } elsif ($key eq 'verbose') {
-            $verbose = 1;
-        } elsif ($key eq 'prefix') {
-            $prefix = $val;
-        } else {
-            warn "$file,$lnum: invalid line '$line'.\n";
-            return -1;
-        }
-
-        $count++;
-    }
-    close $fh;
-
-    print "  -!- Read $desc.\n  -!- $count valid items.\n";
-    return 0;
-}
-#}}}
-sub xrename { #{{{
-    # a rename() replacement, that implements renames across
-    # filesystems via File::copy() + unlink().
-    # This assumes, that source and destination directory are
-    # there, because it stat()s them, to check if it can use
-    # rename().
-    my ($src, $dest) = @_;
-    my (@stat0, @stat1, $d0, $d1, $cause);
-
-    $d0 = dirname($src);
-    $d1 = dirname($dest);
-    @stat0 = stat $d0 or die "Could not stat($d0): $!\n";
-    @stat1 = stat $d1 or die "Could not stat($d1): $!\n";
-
-    if ($stat0[0] == $stat1[0]) {
-        $cause = 'rename';
-        rename $src, $dest or goto err;
-    } else {
-        $cause = 'copy';
-        copy($src, $dest) or goto err;
-        $cause = 'unlink';
-        unlink $src or goto dir;
-    }
-
-    return 0;
-
-err:
-    die "  -!- Could not rename($src, $dest);\n" .
-        "  -!- Reason: $cause(): $!\n";
-}
-#}}}
-# handle options {{{
-
-if ($#ARGV == -1) {
-    $opts{h} = 1;
-} else {
-    if (!getopts('dfhVvp:T:t:', \%opts)) {
-        if (exists $opts{t} && !defined $opts{t}) {
-            die " -t *requires* a string argument!\n";
-        } elsif (exists $opts{T} && !defined $opts{T}) {
-            die " -T *requires* a string argument!\n";
-        } elsif (exists $opts{p} && !defined $opts{p}) {
-            die " -p *requires* a string argument!\n";
-        } else {
-            die "    Try $NAME -h\n";
-        }
-    }
-}
-
-if (defined $opts{h}) {
-    print " Usage:\n  $NAME [-d,-f,-h,-V,-v,-p <prefix>,-[Tt] <template>] FILE(s)...\n\n";
-    print "    -d                Go into dryrun mode.\n";
-    print "    -f                Overwrite files if needed.\n";
-    print "    -h                Display this help text.\n";
-    print "    -V                Display version infomation.\n";
-    print "    -v                Enable verbose output.\n";
-    print "    -p <prefix>       Define a prefix for destination files.\n";
-    print "    -T <template>     Define a compilation template.\n";
-    print "    -t <template>     Define a generic template.\n";
-    print "\n";
-    exit 0;
-}
-
-if (defined $opts{V}) {
-    print " $NAME $VERSION\n";
-    exit 0;
-}
-
-#}}}
-# set defaults {{{
-
-$dryrun        = 0;
-$force         = 0;
-$prefix        = '.';
-$sepreplace    = '_';
-$tnpad         = 2;
-$verbose       = 0;
-$comp_template = "va/&album/&tracknumber - &artist - &tracktitle";
-$template      = "&artist[1]/&artist/&album/&tracknumber - &tracktitle";
-
-#}}}
-# reading config file(s) {{{
-
-my $rc = $ENV{HOME} . "/.arenamerc";
-my $retval = rcload($rc, "arename.pl configuration");
-if ($retval < 0) {
-    die "Error(s) in \"$rc\". Aborting.\n";
-} elsif ($retval > 0) {
-    warn "Error opening configuration; using defaults.\n";
-}
-
-if (-r "./.arename.local") {
-    $rc = "./.arename.local";
-    $retval = rcload($rc, "local configuration");
-    if ($retval < 0) {
-        die "Error(s) in \"$rc\". Aborting.\n";
-    } elsif ($retval > 0) {
-        warn "Error opening local configuration.\n";
-    }
-}
-
-print "\n";
-
-#}}}
-# let cmd line options overwrite {{{
-
-if ($#ARGV == -1) {
-    die "No input files. See: $NAME -h\n";
-}
-
-if (defined $opts{f}) {
-    $force = $opts{f};
-}
-
-if (defined $opts{p}) {
-    $prefix = $opts{p};
-}
-
-if (defined $opts{t}) {
-    $template = $opts{t};
-}
-
-if (defined $opts{T}) {
-    $comp_template = $opts{T};
-}
-
-if (defined $opts{d}) {
-    $dryrun = $opts{d};
-}
-
-if (defined $opts{v}) {
-    $verbose = $opts{v};
-}
-
-undef %opts;
-
-#}}}
-# process what's left on the commandline aka. main() {{{
-%methods = (
-    '.mp3$' => \&process_mp3,
-    '.ogg$' => \&process_ogg
-);
-
-if ($dryrun) {
-    print "+++ We are on a dry run!\n";
-}
-
-if ($verbose) {
-    print "+++ Running verbose.\n";
-}
-
-if ($dryrun || $verbose) {
-    print "\n";
-}
-
-foreach my $file (@ARGV) {
-    my $done = 0;
-    print "Processing: $file\n";
-    if (-l $file) {
-        warn "  -!- Refusing to handle symbolic links ($file).\n";
-        next;
-    }
-    if (! -r $file) {
-        warn "  -!- Can't read \"$file\": $!\n";
-        next;
-    }
-
-    foreach my $method (sort keys %methods) {
-        if ($file =~ m!$method!i) {
-            $methods{$method}->($file);
-            $done = 1;
-        }
-    }
-
-    if (!$done) {
-        process_warn($file);
-    }
-}
-#}}}
-- 
2.1.4