Ticket #4760: mythtv-4760-database_backup_scripts-20080627.patch

programs/programs.pro

@@ -11 +11 @@
 }
 
 using_backend {
-    SUBDIRS += mythbackend mythfilldatabase mythtv-setup
+    SUBDIRS += mythbackend mythfilldatabase mythtv-setup scripts
 }
 
 using_frontend:using_backend {

programs/scripts/database/database_mythconverg_restore.pl

@@ +1 @@
+#!/usr/bin/perl -w
+#
+# database_mythconverg_restore.pl
+#
+# Restores a backup of the MythTV database.
+#
+# For details, see:
+#   database_mythconverg_restore.pl --help
+
+# Includes
+    use Getopt::Long;
+    use File::Temp qw/ tempfile /;
+
+# Script info
+    $NAME           = 'MythTV Database Restore Script';
+    $VERSION        = '1.0.1';
+
+# Some variables we'll use here
+    our ($username, $homedir, $mythconfdir, $database_information_file);
+    our ($partial_restore, $with_plugin_data, $restore_xmltvids);
+    our ($mysql_client, $uncompress, $mc_sql);
+    our ($change_hostname, $old_hostname, $new_hostname);
+    our ($usage, $debug, $show_version, $show_version_script, $dbh);
+    our ($d_mysql_client, $d_db_name, $d_uncompress);
+    our ($db_hostname, $db_port, $db_username, $db_name, $db_schema_version);
+# This script does not accept a database password on the command-line.
+# Any packager who enables the functionality should modify the --help output.
+#    our ($db_password);
+    our ($backup_directory, $backup_filename);
+    our ($verbose_level_always, $verbose_level_debug, $verbose_level_error);
+
+    our %mysql_conf  = ('db_host'       => '',
+                        'db_port'       => -1,
+                        'db_user'       => '',
+                        'db_pass'       => '',
+                        'db_name'       => '',
+                        'db_schemaver'  => ''
+                        );
+    our %backup_conf = ('directory'     => '',
+                        'filename'      => ''
+                       );
+
+# Debug levels
+    $verbose_level_always = 0;
+    $verbose_level_debug = 1;
+    $verbose_level_error = 255;
+
+# Defaults
+    $d_db_name       = 'mythconverg';
+    $d_mysql_client  = 'mysql';
+    $d_uncompress    = 'gzip -d';
+
+# Provide default values for GetOptions
+    $mysql_client    = $d_mysql_client;
+    $uncompress      = $d_uncompress;
+    $debug           = 0;
+    $new_hostname    = '';
+    $old_hostname    = '';
+
+# Load the cli options
+    GetOptions('hostname|DBHostName=s'              => \$db_hostname,
+               'port|DBPort=i'                      => \$db_port,
+               'username|DBUserName=s'              => \$db_username,
+# This script does not accept a database password on the command-line.
+#               'password|DBPassword=s'              => \$db_password,
+               'name|DBName=s'                      => \$db_name,
+               'schemaver|DBSchemaVer=s'            => \$db_schema_version,
+               'directory|DBBackupDirectory=s'      => \$backup_directory,
+               'filename|DBBackupFilename=s'        => \$backup_filename,
+               'partial_restore|new_hardware'       => \$partial_restore,
+               'with_plugin_data|plugin_data'       => \$with_plugin_data,
+               'restore_xmltvids|xmltvids'          => \$restore_xmltvids,
+               'mysql_client|client=s'              => \$mysql_client,
+               'uncompress=s'                       => \$uncompress,
+               'create_database|create_db|mc_sql=s' => \$mc_sql,
+               'change_hostname'                    => \$change_hostname,
+               'new_hostname=s'                     => \$new_hostname,
+               'old_hostname=s'                     => \$old_hostname,
+               'usage|help|h'                       => \$usage,
+               'version'                            => \$show_version,
+               'script_version|v'                   => \$show_version_script,
+               'verbose|debug|d+'                   => \$debug
+              );
+
+    $partial_restore ||= $restore_xmltvids;
+
+# Print version information
+    sub print_version_information
+    {
+        my $script_name = substr $0, rindex($0, '/') + 1;
+        print "$NAME\n$script_name\nversion: $VERSION\n";
+    }
+
+    if ($show_version_script)
+    {
+        print "$NAME,$VERSION,,\n";
+        exit;
+    }
+    elsif ($show_version)
+    {
+        print_version_information;
+        exit;
+    }
+
+# Print usage
+    if ($usage)
+    {
+        print_version_information;
+        print <<EOF;
+
+Usage:
+  $0 [options|database_information_file]
+
+Restores a backup of the MythTV database.
+
+DETAILED DESCRIPTION:
+
+This script is used to restore a backup of the MythTV database (as created by
+the database_mythconverg_backup.pl script). It can be called with a single
+command-line argument specifying the name of a "database information file" (see
+DATABASE INFORMATION FILE, below), which contains sufficient information about
+the database and the backup to allow the script to restore a backup without
+needing any additional configuration files. In this mode, all other MythTV
+configuration files (including config.xml, mysql.txt) are ignored, but the
+backup resource file (see RESOURCE FILE, below) and the MySQL option files
+(i.e. /etc/my.cnf or ~/.my.cnf) will be honored.
+
+The script can also be called  using command-line arguments to specify the
+required information. If no database information file is specified, the script
+will attempt to determine the appropriate configuration by using the MythTV
+configuration file(s) (prefering config.xml, but falling back to mysql.txt if
+no config.xml exists). Once the MythTV configuration file has been parsed, the
+backup resource file (see RESOURCE FILE, below) will be parsed, then
+command-line arguments will be applied (thus overriding any values determined
+from the configuration files).
+
+The only information required by the script is the directory in which the
+backup exists (the script will attempt to find the most current backup file,
+based on the filename). Therefore, when using a database information file, the
+DBBackupDirectory should be specified, or if running manually, the --directory
+command-line argument should be specified. The DBBackupDirectory may be
+specified in a backup resource file (see RESOURCE FILE, below). If the
+specified directory is not readable, the script will terminate. Likewise, if
+the backup file cannot be read, the script will terminate.
+
+If the database name is not specified, the script will attempt to use the
+MythTV default database name, $d_db_name. Note that the same is not true for
+the database username and database password. These must be explicitly
+specified. The password must be specified in a database information file, a
+backup resource file, or a MySQL options file. The username may be specified
+the same way or may be specified using a command-line argument if not using a
+database information file.
+
+If no database exists, the script can attempt to create the initial database.
+To allow this, specify the --create_database argument and specify the location
+of the mc.sql script (full directory/filename). On most MySQL configurations
+this will fail unless connecting to the database using the MySQL root user--
+even if the user specified has CREATE DATABASE privilege--as RELOAD privilege
+is also required. Though you may specify '--username=root' on the command line,
+the script does not allow specifying a database password on the command line.
+Therefore, you will need to specify 'DBPassword=<MySQL root user password>' in
+the backup resource file.
+
+If attempting to perform a full restore, the database must be empty (no
+tables), or--if the script is allowed to create the initial database, as
+explained above--must not exist. If attempting to do a partial or "new
+hardware" restore, the database must exist and must have tables. See QUICK
+START, below, for more information.
+
+DATABASE INFORMATION FILE
+
+The database information file contains information about the database and the
+backup. The information within the file is specified as name=value pairs using
+the same names as used by the MythTV config.xml and mysql.txt configuration
+files. The following variables are recognized:
+
+  DBHostName - The hostname (or IP address) which should be used to find the
+               MySQL server.
+  DBPort - The TCP/IP port number to use for the connection. This may have a
+           value of 0, i.e. if the hostname is localhost or if the server is
+           using the default MySQL port or the port specified in a MySQL
+           options file.
+  DBUserName - The database username to use when connecting to the server.
+  DBPassword - The password to use when connecting to the server.
+  DBName - The name of the database that contains the MythTV data.
+  DBSchemaVer - The MythTV schema version of the database. This value will be
+                used to create the backup filename, but only if the filename
+                has not been specified using DBBackupFilename or the --filename
+                argument.
+  DBBackupDirectory - The directory in which the backup file should be
+                      created. This directory may have been specially
+                      configured by the user as the "DB Backups" storage
+                      group. It is recommended that this directory be
+                      used--especially in "common-use" scripts such as those
+                      provided by distributions.
+  DBBackupFilename - The name of the file in which the backup should be
+                     created. Additional extensions may be added by this
+                     script as required (i.e. adding an appropriate suffix,
+                     such as ".gz", to the file if it is compressed). If the
+                     filename recommended by mythbackend is used, it will be
+                     displayed in the GUI messages provided for the user. If
+                     the recommended filename is not used, the user will not be
+                     told where to find the backup file. If no value is
+                     provided, a filename using the default filename format
+                     will be chosen.
+  partial_restore  - Do a partial restore (as would be required when setting
+                     up MythTV on new hardware) of only the MythTV recordings
+                     and recording rules.
+  with_plugin_data - When doing a partial restore, include plugin data.
+                     Ignored, unless the --partial_restore argument is given.i
+                     Note that you will still need to configure all plugins
+                     after the restore completes.
+  mysql_client     - The path (including filename) of the mysql client
+                     executable.
+  uncompress       - The command (including path, if necessary)  to use to
+                     uncompress the backup. If you specify an uncompress
+                     program, the backup file will be assumed to be compressed,
+                     so the command will be run on the file regardless.
+                     If no value is specified for uncompress or if the value
+                     '$d_uncompress' or 'gunzip' is specified, the script will
+                     check to see if the file is actually a gzip-compressed
+                     file, and if so, will first attempt to use the
+                     IO::Uncompress::Gunzip module to uncompress the backup
+                     file, but, if not available, will run the command
+                     specified. Therefore, if IO::Uncompress::Gunzip is
+                     installed and functional, specifying a value for
+                     uncompress is unnecessary.
+  create_database  - The location of the mc.sql script (full directory and
+                     filename). If specified, and if the database does not
+                     exist, the script will attempt to create the initial
+                     database by running the specified mc.sql script commands.
+                     This probably requires running the restore script with
+                     the DBUserName set to root. See, also, the MythTV HOWTO
+                     ( http://www.mythtv.org/docs/ )for details on "Setting up
+                     the initial database."
+
+RESOURCE FILE
+
+The backup resource file specifies values using the same format as described
+for the database information file, above, but is intended as a "permanent,"
+user-created configuration file. The database information file is intended as a
+"single-use" configuration file, often created automatically (i.e. by a
+program, such as a script). The backup resource file should be placed at
+"~/.mythtv/backuprc" and given appropriate permissions. To be usable by the
+script, it must be readable. However, it should be protected as required--i.e.
+if the DBPassword is specified, it should be made readable only by the owner.
+
+When specifying a database information file, the resource file is parsed before
+the database information file to prevent the resource file from overriding the
+information in the database information file. When no database information
+file is specified, the resource file is parsed after the MythTV configuration
+files, but before the command-line arguments to allow the resource file to
+override values in the configuration files and to allow command-line arguments
+to override resource file defaults.
+
+options:
+
+--hostname [database hostname]
+
+    The hostname (or IP address) which should be used to find the MySQL server.
+    See DBHostName, above.
+
+--port [database port]
+
+    The TCP/IP port number to use for connection to the MySQL server. See
+    DBPort, above.
+
+--username [database username]
+
+    The MySQL username to use for connection to the MySQL server. See
+    DBUserName, above.
+
+--name [database name]
+
+    The name of the database containing the MythTV data. See DBName, above.
+
+    Default:  $d_db_name
+
+--schemaver [MythTV database schema version]
+
+    The MythTV schema version. See DBSchemaVer, above.
+
+--directory [directory]
+
+    The directory in which the backup file should be stored. See
+    DBBackupDirectory, above.
+
+--filename [database backup filename]
+
+    The name to use for the database backup file. If not provided, a filename
+    using a default format will be chosen. See DBBackupFilename, above.
+
+--partial_restore
+
+    Do a partial restore (as would be required when setting up MythTV on new
+    hardware) of only the MythTV recordings and recording rules.
+
+--with_plugin_data
+
+    When doing a partial restore, include plugin data. Ignored, unless the
+    --partial_restore argument is given. Note that you will still need to
+    configure all plugins after the restore completes.
+
+--restore_xmltvids
+
+    Restore channel xmltvids from a backup create with
+    database_mythconverg_backup.pl --backup_xmltvids
+
+--mysql_client [path]
+
+    The path (including filename) of the mysql client executable. See
+    mysql_client in the DATABASE INFORMATION FILE description, above.
+
+    Default:  $d_mysql_client
+
+--uncompress [path]
+
+    The command (including path, if necessary) to use to uncompress the
+    backup. See uncompress in the DATABASE INFORMATION FILE description, above.
+
+    Default:  $d_uncompress
+
+--create_database [path]
+
+    The location of the mc.sql script (full directory and filename). See
+    create_database in the DATABASE INFORMATION FILE description, above.
+
+--change_hostname
+
+    Specifies that the script should change the hostname of a MythTV frontend
+    or backend in the database rather than restore a database backup. It is
+    critical that no MythTV frontends or backends are running when a hostname
+    is changed.
+
+--new_hostname
+
+    Specifies the new hostname. The new_hostname is only used when the
+    --change_hostname argument is specified.
+
+--old_hostname
+
+    Specifies the old hostname. The old_hostname is only used when the
+    --change_hostname argument is specified.
+
+--help
+
+    Show this help text.
+
+--version
+
+    Show version information.
+
+--verbose
+
+    Show what is happening.
+
+--script_version | -v
+
+    Show script version information. This is primarily useful for scripts
+    or programs needing to parse the version information.
+
+QUICK START:
+
+Create a file ~/.mythtv/backuprc with a single line,
+"DBBackupDirectory=/home/mythtv" (no quotes). For example:
+
+# echo "DBBackupDirectory=/home/mythtv" > ~/.mythtv/backuprc
+
+To do a full restore:
+Ensure you have an empty database. If you a replacing a corrupt database, you
+must first drop the existing database. You may do this using the mysql client
+executable by issuing the statement, "DROP DATABASE mythconverg;" (no quotes;
+fix the database name, as required). Then, execute the mc.sql script as
+described in the MythTV HOWTO ( http://www.mythtv.org/docs/ ) to prepare a new
+(empty) database (or see the above description of the --create_database
+argument).
+
+Run this script to restore the backup. Use the --verbose argument to see what
+is happening.
+
+# $0
+
+At this point, you may start mythtv-setup or mythbackend. If you restored a
+backup from an older version of MythTV, mythtv-setup will upgrade the database
+for you.
+
+To do a partial restore:
+
+You must have a fully-populated database schema (but without the data you wish
+to import) from the version of MythTV used to create the backup. You may
+create and populate the database by running the mc.sql script (see the above
+description of the --create_database argument) to create the database. Then,
+start and exit mythtv-setup to populate the database. And, finally, do the
+partial restore with:
+
+# $0 --partial_restore
+
+Include the --with_plugin_data argument if you would like to keep the data
+used by MythTV plugins.
+
+If you would like to do a partial/new-hardware restore and have upgraded
+MythTV, you must first do a full restore, then start and exit mythtv-setup (to
+upgrade the database), then create a backup, then drop the database, then
+follow the instructions for doing a partial restore with the new (upgraded)
+backup file.
+
+To change the hostname of a MythTV frontend or backend:
+
+Ensure that the database exists (restore an old database, as above, if
+necessary) and execute the following command, replacing "XXXX" and "YYYY"
+with appropriate values for the old and new hostnames, respectively:
+
+# $0 --change_hostname --old_hostname="XXXX" --new_hostname="YYYY"
+
+To restore xmltvids:
+
+Ensure you have a ~/.mythtv/backuprc file, as described above, and execute this
+script with the --restore_xmltvids argument.
+
+# $0 --restore_xmltvids
+
+EOF
+        exit;
+    }
+
+    sub verbose
+    {
+        my $level = shift;
+        my $error = 0;
+        if ($level == $verbose_level_error)
+        {
+            $error = 1;
+        }
+        else
+        {
+            return unless ($debug >= $level);
+        }
+        print { $error ? STDOUT : STDERR } join("\n", @_), "\n";
+    }
+
+    sub print_configuration
+    {
+        verbose($verbose_level_debug,
+                "\nDatabase Information:",
+                "         DBHostName:  $mysql_conf{'db_host'}",
+                "             DBPort:  $mysql_conf{'db_port'}",
+                "         DBUserName:  $mysql_conf{'db_user'}",
+                "         DBPassword:  " .
+                    ( $mysql_conf{'db_pass'} ? 'XXX' : '' ),
+                  #  "$mysql_conf{'db_pass'}",
+                "             DBName:  $mysql_conf{'db_name'}",
+                "        DBSchemaVer:  $mysql_conf{'db_schemaver'}",
+                "  DBBackupDirectory:  $backup_conf{'directory'}",
+                "   DBBackupFilename:  $backup_conf{'filename'}",
+                "    create_database:  " . ($mc_sql ? $mc_sql : ''));
+        verbose($verbose_level_debug,
+                "\nExecutables:",
+                "       mysql_client:  $mysql_client",
+                "         uncompress:  $uncompress");
+        verbose($verbose_level_debug,
+                "\nMiscellaneous:",
+                "    partial_restore:  " . ($partial_restore ? 'yes' : 'no'));
+        if ($partial_restore)
+        {
+            verbose($verbose_level_debug,
+                    "   with_plugin_data:  " . ($with_plugin_data ?
+                                                'yes' : 'no'));
+        }
+        verbose($verbose_level_debug,
+                "   restore_xmltvids:  " . ($restore_xmltvids ? 'yes' : 'no'),
+                "    change_hostname:  " . ($change_hostname ? 'yes' : 'no'));
+        if ($change_hostname)
+        {
+            verbose($verbose_level_debug,
+                    "     - old_hostname:  " . $old_hostname,
+                    "     - new_hostname:  " . $new_hostname);
+        }
+    }
+
+    sub configure_environment
+    {
+        verbose($verbose_level_debug,
+                "\nConfiguring environment:");
+
+    # Get the user's login and home directory, so we can look for config files
+        ($username, $homedir) = (getpwuid $>)[0,7];
+        $username = $ENV{'USER'} if ($ENV{'USER'});
+        $homedir  = $ENV{'HOME'} if ($ENV{'HOME'});
+        if ($username && !$homedir)
+        {
+            $homedir = "/home/$username";
+            if (!-e $homedir && -e "/Users/$username")
+            {
+                $homedir = "/Users/$username";
+            }
+        }
+        verbose($verbose_level_debug,
+                "  -    username:  $username",
+                "  -        HOME:  $homedir");
+
+    # Find the config directory
+        $mythconfdir = $ENV{'MYTHCONFDIR'}
+            ? $ENV{'MYTHCONFDIR'}
+            : "$homedir/.mythtv"
+            ;
+
+        verbose($verbose_level_debug,
+                "  - MYTHCONFDIR:  $mythconfdir");
+    }
+
+# Though much of the configuration file parsing could be done by the MythTV
+# Perl bindings, using them to retrieve database information is not appropriate
+# for a backup script. The Perl bindings require the backend to be running and
+# use UPnP for autodiscovery. Also, parsing the files "locally" allows
+# supporting even the old MythTV database configuration file, mysql.txt.
+    sub parse_database_information
+    {
+        my $file = shift;
+        verbose($verbose_level_debug,
+                "  - checking:  $file");
+        return 0 unless ($file && -e $file);
+        verbose($verbose_level_debug,
+                "     parsing:  $file");
+        open(CONF, $file) or die("\nERROR:  Unable to read $file:  $!".
+                                 ", stopped");
+        while (my $line = <CONF>)
+        {
+        # Cleanup
+            next if ($line =~ m/^\s*#/);
+            $line =~ s/^str //;
+            chomp($line);
+            $line =~ s/^\s+//;
+            $line =~ s/\s+$//;
+        # Split off the var=val pairs
+            my ($var, $val) = split(/ *[\=\: ] */, $line, 2);
+        # Also look for <var>val</var> from config.xml
+            if ($line =~ m/<(\w+)>(.+)<\/(\w+)>$/ && $1 eq $3)
+            {
+                $var = $1; $val = $2;
+            }
+            next unless ($var && $var =~ m/\w/);
+            if ($var eq 'DBHostName')
+            {
+                $mysql_conf{'db_host'} = $val;
+            }
+            elsif ($var eq 'DBPort')
+            {
+                $mysql_conf{'db_port'} = $val;
+            }
+            elsif ($var eq 'DBUserName')
+            {
+                $mysql_conf{'db_user'} = $val;
+            }
+            elsif ($var eq 'DBPassword')
+            {
+                $mysql_conf{'db_pass'} = $val;
+            }
+            elsif ($var eq 'DBName')
+            {
+                $mysql_conf{'db_name'} = $val;
+            }
+            elsif ($var eq 'DBSchemaVer')
+            {
+                $mysql_conf{'db_schemaver'} = $val;
+            }
+            elsif ($var eq 'DBBackupDirectory')
+            {
+                $backup_conf{'directory'} = $val;
+            }
+            elsif ($var eq 'DBBackupFilename')
+            {
+                $backup_conf{'filename'} = $val;
+            }
+            elsif ($var eq 'partial_restore')
+            {
+                $partial_restore = $val;
+            }
+            elsif ($var eq 'with_plugin_data')
+            {
+                $with_plugin_data = $val;
+            }
+            elsif ($var eq 'mysql_client')
+            {
+                $mysql_client = $val;
+            }
+            elsif ($var eq 'uncompress')
+            {
+                $uncompress = $val;
+            }
+            elsif ($var eq 'create_database')
+            {
+                $mc_sql = $val;
+            }
+        }
+        close CONF;
+        return 1;
+    }
+
+    sub read_mysql_txt
+    {
+    # Read the "legacy" mysql.txt file in use by MythTV. It could be in a
+    # couple places, so try the usual suspects in the same order that mythtv
+    # does in libs/libmyth/mythcontext.cpp
+        my $found = 0;
+        my $result = 0;
+        my @mysql = ('/usr/local/share/mythtv/mysql.txt',
+                     '/usr/share/mythtv/mysql.txt',
+                     '/usr/local/etc/mythtv/mysql.txt',
+                     '/etc/mythtv/mysql.txt',
+                     $homedir ? "$homedir/.mythtv/mysql.txt"    : '',
+                     'mysql.txt',
+                     $mythconfdir ? "$mythconfdir/mysql.txt"    : '',
+                    );
+        foreach my $file (@mysql)
+        {
+            $found = parse_database_information($file);
+            $result = $result + $found;
+        }
+        return $result;
+    }
+
+    sub read_resource_file
+    {
+        parse_database_information("$mythconfdir/backuprc");
+    }
+
+    sub apply_arguments
+    {
+        verbose($verbose_level_debug,
+                "\nApplying command-line arguments.");
+        if ($db_hostname)
+        {
+            $mysql_conf{'db_host'} = $db_hostname;
+        }
+        if ($db_port)
+        {
+            $mysql_conf{'db_port'} = $db_port;
+        }
+        if ($db_username)
+        {
+            $mysql_conf{'db_user'} = $db_username;
+        }
+    # This script does not accept a database password on the command-line.
+#        if ($db_password)
+#        {
+#            $mysql_conf{'db_pass'} = $db_password;
+#        }
+        if ($db_name)
+        {
+            $mysql_conf{'db_name'} = $db_name;
+        }
+        if ($db_schema_version)
+        {
+            $mysql_conf{'db_schemaver'} = $db_schema_version;
+        }
+        if ($backup_directory)
+        {
+            $backup_conf{'directory'} = $backup_directory;
+        }
+        if ($backup_filename)
+        {
+            $backup_conf{'filename'} = $backup_filename;
+        }
+    }
+
+    sub read_config
+    {
+        my $result = 0;
+    # If specified, use only the database information file
+        if ($database_information_file)
+        {
+            verbose($verbose_level_debug,
+                    "\nDatabase Information File specified. Ignoring all".
+                    " command-line arguments");
+            verbose($verbose_level_debug,
+                    "\nDatabase Information File:".
+                    " $database_information_file");
+            unless (-T "$database_information_file")
+            {
+                die("\nERROR:  Invalid database information file, stopped");
+            }
+        # When using a database information file, parse the resource file first
+        # so it cannot override database information file settings
+            read_resource_file;
+            $result = parse_database_information($database_information_file);
+            return $result;
+        }
+
+    # No database information file, so try the MythTV configuration files.
+        verbose($verbose_level_debug,
+                "\nParsing configuration files:");
+    # Prefer the config.xml file
+        my $file = $mythconfdir ? "$mythconfdir/config.xml" : '';
+        $result = parse_database_information($file);
+        if (!$result)
+        {
+        # Use the "legacy" mysql.txt file as a fallback
+            $result = read_mysql_txt;
+        }
+    # Read the resource file next to override the config file information, but
+    # to allow command-line arguments to override resource file "defaults"
+        read_resource_file;
+    # Apply the command-line arguments to override the information provided
+    # by the config file(s).
+        apply_arguments;
+        return $result;
+    }
+
+    sub create_defaults_extra_file
+    {
+        return '' if (!$mysql_conf{'db_pass'});
+        verbose($verbose_level_debug,
+                "\nAttempting to use supplied password for $mysql_client".
+                " command-line client.",
+                "Any [client] or [mysql] password specified in the MySQL".
+                " options file will",
+                "take precedence.");
+    # Let tempfile handle unlinking on exit so we don't have to verify that the
+    # file with $filename is the file we created
+        my ($fh, $filename) = tempfile(UNLINK => 1);
+        print $fh  "[client]\npassword=$mysql_conf{'db_pass'}\n".
+                   "[mysql]\npassword=$mysql_conf{'db_pass'}\n";
+        return $filename;
+    }
+
+    sub check_file_config
+    {
+        if (!$backup_conf{'directory'})
+        {
+            if (!-r "/$backup_conf{'filename'}")
+            {
+                print_configuration;
+                die("\nERROR:  DBBackupDirectory not specified, stopped");
+            }
+        # The user must have specified an absolute path for the
+        # DBBackupFilename. Though this is not how the script is meant to be
+        # used, allow it.
+            $backup_conf{'directory'} = '';
+        }
+        elsif (!-d $backup_conf{'directory'})
+        {
+            print_configuration;
+            verbose($verbose_level_error,
+                    "\nERROR:  DBBackupDirectory is not a directory. Please".
+                    " specify a directory in",
+                    "        your database information file using".
+                    " DBBackupDirectory.",
+                    "        If not using a database information file," .
+                    " please specify the ",
+                    "        --directory command-line option.");
+            die("\nInvalid backup directory, stopped");
+        }
+        if (!$backup_conf{'filename'})
+        {
+        # Look for most current backup file
+            verbose($verbose_level_debug,
+                    "\nNo filename specified. Attempting to find the newest".
+                    " database backup.");
+            if ($restore_xmltvids)
+            {
+                $backup_conf{'filename'} = 'mythtv_xmltvid_backup';
+            }
+            else
+            {
+                $backup_conf{'filename'} = $mysql_conf{'db_name'};
+                if (!$backup_conf{'filename'})
+                {
+                    $backup_conf{'filename'} = $d_db_name;
+                }
+            }
+            my @files = <$backup_conf{'directory'}/$backup_conf{'filename'}*>;
+            my $num_files = @files;
+            if ($num_files < 1)
+            {
+                verbose($verbose_level_error,
+                        "ERROR:  Unable to find any backup files in".
+                        " DBBackupDir and none specified.");
+            }
+            else
+            {
+                my @sorted_files = sort { lc($b) cmp lc($0) } @files;
+                $backup_conf{'filename'} = $sorted_files[0];
+                $backup_conf{'filename'} =~ s#^$backup_conf{'directory'}/?##;
+                verbose($verbose_level_debug,
+                        "Using database backup file:",
+                        "$backup_conf{'directory'}/$backup_conf{'filename'}");
+            }
+        }
+        if (!-e "$backup_conf{'directory'}/$backup_conf{'filename'}")
+        {
+            my $temp_filename = $backup_conf{'filename'};
+        # Perhaps the user specified some unnecessary path information in the
+        # filename (i.e. using the shell's filename completion)
+            $temp_filename =~ s#^.*/##;
+            if (-e "$backup_conf{'directory'}/$temp_filename")
+            {
+                $backup_conf{'filename'} = $temp_filename;
+            }
+            else
+            {
+                verbose($verbose_level_error,
+                        "\nERROR:  The specified backup file does not exist.",
+                        "$backup_conf{'directory'}/$backup_conf{'filename'}");
+                die("\nInvalid backup filename, stopped");
+            }
+        }
+        if (!-r "$backup_conf{'directory'}/$backup_conf{'filename'}")
+        {
+            verbose($verbose_level_error,
+                    "\nERROR:  The specified backup file cannot be read.");
+            die("\nInvalid backup filename, stopped");
+        }
+        if (!$mysql_conf{'db_name'})
+        {
+            verbose($verbose_level_debug,
+                    "\nWARNING:  DBName not specified. Using $d_db_name");
+            $mysql_conf{'db_name'} = $d_db_name;
+        }
+    }
+
+    sub check_config
+    {
+        verbose($verbose_level_debug,
+                "\nChecking configuration.");
+
+        if (!defined($change_hostname))
+        {
+        # Check directory/filename
+            check_file_config;
+        }
+    # Though the script will attempt a restore even if no other database
+    # information is provided (i.e. using "defaults" from the MySQL options
+    # file, warning the user that some "normally-necessary" information is not
+    # provided may be nice.
+        return if (!$debug);
+        if (!$mysql_conf{'db_host'})
+        {
+            verbose($verbose_level_debug,
+                    "\nWARNING:  DBHostName not specified.",
+                    "         Assuming it's specified in the MySQL".
+                    " options file.");
+        }
+        if (!$mysql_conf{'db_user'})
+        {
+            verbose($verbose_level_debug,
+                    "\nWARNING:  DBUserName not specified.",
+                    "         Assuming it's specified in the MySQL".
+                    " options file.");
+        }
+        if (!$mysql_conf{'db_pass'})
+        {
+            verbose($verbose_level_debug,
+                    "\nWARNING:  DBPassword not specified.",
+                    "         Assuming it's specified in the MySQL".
+                    " options file.");
+        }
+    }
+
+    sub database_exists
+    {
+        $result = 1;
+        $dbh = DBI->connect("dbi:mysql:".
+                            "database=$mysql_conf{'db_name'}:".
+                            "host=$mysql_conf{'db_host'}",
+                            "$mysql_conf{'db_user'}",
+                            "$mysql_conf{'db_pass'}",
+                            { PrintError => 0 });
+        if (!defined($dbh))
+        {
+            verbose($verbose_level_debug,
+                    "Unable to connect to database.");
+            $result = 0;
+        }
+        return $result;
+    }
+
+    sub create_initial_database
+    {
+        return 1 if (!$mc_sql);
+        return 1 if (!-r "$mc_sql");
+
+        my $defaults_extra_file = create_defaults_extra_file;
+        my $host_arg = '';
+        my $port_arg = '';
+        my $user_arg = '';
+        if ($defaults_extra_file)
+        {
+            $defaults_arg=" --defaults-extra-file='$defaults_extra_file'";
+        }
+        else
+        {
+            $defaults_arg='';
+        }
+    # Create the args for host, port, and user, shell-escaping values, as
+    # necessary.
+        if ($mysql_conf{'db_host'})
+        {
+            $mysql_conf{'db_host'} =~ s/'/'\\''/g;
+            $host_arg=" --host='$mysql_conf{'db_host'}'";
+        }
+        if ($mysql_conf{'db_port'} > 0)
+        {
+            $mysql_conf{'db_port'} =~ s/'/'\\''/g;
+            $port_arg=" --port='$mysql_conf{'db_port'}'";
+        }
+        if ($mysql_conf{'db_user'})
+        {
+            $mysql_conf{'db_user'} =~ s/'/'\\''/g;
+            $user_arg=" --user='$mysql_conf{'db_user'}'";
+        }
+        verbose($verbose_level_debug,
+                "\nAttempting to create initial database.");
+    # Use redirects to capture stdout and stderr (for debug)
+        my $command = "${mysql_client}${defaults_arg}${host_arg}${port_arg}".
+                      "${user_arg}  2>&1 < $mc_sql";
+        verbose($verbose_level_debug,
+                "\nExecuting command:", $command);
+        my $result = `$command`;
+        my $exit = $? >> 8;
+        verbose($verbose_level_debug,
+                "\n$mysql_client exited with status:  $exit");
+        verbose($verbose_level_error,
+                "$mysql_client output:", $result) if ($exit);
+        die("\nUnable to create initial database, stopped");
+        return $exit;
+    }
+
+    sub is_database_empty
+    {
+        $result = 1;
+        if (defined($dbh))
+        {
+            my $sth = $dbh->table_info('', '', '', 'TABLE');
+            my $num_tables = keys %{$sth->fetchall_hashref('TABLE_NAME')};
+            verbose($verbose_level_debug,
+                    "\nFound $num_tables tables in the database.");
+            if ($num_tables > 0)
+            {
+                if (!defined($change_hostname) && !defined($partial_restore))
+                {
+                    verbose($verbose_level_debug,
+                            "WARNING:  Database not empty.");
+                }
+                $result = 0;
+            }
+        }
+        return $result;
+    }
+
+    sub check_database_libs
+    {
+    # Try to load the DBI library if available (but don't require it)
+        BEGIN
+        {
+            our $has_dbi = 1;
+            eval 'use DBI;';
+            if ($@)
+            {
+                $has_dbi = 0;
+            }
+        }
+        verbose($verbose_level_debug,
+                "\nDBI is not installed.") if (!$has_dbi);
+    # Try to load the DBD::mysql library if available (but don't # require it)
+        BEGIN
+        {
+            our $has_dbd = 1;
+            eval 'use DBD::mysql;';
+            if ($@)
+            {
+                $has_dbd = 0;
+            }
+        }
+        verbose($verbose_level_debug,
+                "\nDBD::mysql is not installed.") if (!$has_dbd);
+        return ($has_dbi + $has_dbd);
+    }
+
+    sub check_database
+    {
+        my $have_database_libs = check_database_libs;
+        if ($have_database_libs < 2)
+        {
+            if ($mc_sql)
+            {
+                verbose($verbose_level_error,
+                        "\nERROR:  Unable to create initial database without".
+                        " Perl database libraries.",
+                        "        Please ensure the Perl DBI and DBD::mysql".
+                        " modules are installed.");
+                die("\nPerl database libraries missing, stopped");
+            }
+            if ($change_hostname)
+            {
+                verbose($verbose_level_error,
+                        "\nERROR:  Unable to change hostname without Perl".
+                        " database libraries.",
+                        "        Please ensure the Perl DBI and DBD::mysql".
+                        " modules are installed.");
+                die("\nPerl database libraries missing, stopped");
+            }
+            else
+            {
+                verbose($verbose_level_debug,
+                        "Blindly assuming your database is prepared for a".
+                        " restore. For better checking,",
+                        "please ensure the Perl DBI and DBD::mysql modules".
+                        " are installed.");
+                return 1;
+            }
+        }
+    # DBI/DBD::mysql are available; check the DB status
+        verbose($verbose_level_debug,
+                "\nChecking database.");
+        if (!database_exists)
+        {
+            if (create_initial_database)
+            {
+                verbose($verbose_level_always,
+                        "\nERROR:  The database does not exist.");
+                return 0;
+            }
+        }
+        my $database_empty = is_database_empty;
+        if ($change_hostname)
+        {
+            if ($database_empty)
+            {
+                verbose($verbose_level_always,
+                        "\nERROR:  Unable to change hostname. The database".
+                        " is empty.",
+                        "        Please restore a backup, first, then re-run".
+                        " this script.");
+                return 0;
+            }
+        }
+        elsif ($partial_restore)
+        {
+            if ($database_empty)
+            {
+                verbose($verbose_level_always,
+                        "\nERROR:  Unable to do a partial restore. The".
+                        " database is empty.",
+                        "        Please run mythtv-setup, first, then re-run".
+                        " this script.");
+                return 0;
+            }
+        }
+        else
+        {
+            if (!$database_empty)
+            {
+                verbose($verbose_level_always,
+                        "\nERROR:  Unable to do a full restore. The".
+                        " database contains data.");
+                return 0;
+            }
+        }
+        return 1;
+    }
+
+    sub is_gzipped
+    {
+    # Simple magic number verification.
+    # This naive approach works without requiring File::MMagic or any other
+    # modules.
+        my $result = 0;
+        my $magic_number;
+        my $gzip_magic_number = pack("C*", 0x1f, 0x8b);
+        open(BACKUPFILE, "$backup_conf{'directory'}/$backup_conf{'filename'}")
+          or return $result;
+        binmode(BACKUPFILE);
+        read(BACKUPFILE, $magic_number, 2);
+        close(BACKUPFILE);
+        return ($gzip_magic_number eq $magic_number);
+    }
+
+# Though it's possible to uncompress the file without writing the uncompressed
+# data to a file, doing so is complicated by supporting the use of
+# IO::Uncompress::Gunzip /and/ external uncompress programs. Also,
+# uncompressing the file separately allows for easier and more precise error
+# reporting.
+    sub uncompress_backup_file
+    {
+        if (($d_uncompress eq $uncompress) || ('gunzip' eq $uncompress))
+        {
+            if (!is_gzipped)
+            {
+                verbose($verbose_level_debug,
+                        "\nBackup file is uncompressed.");
+                return 0;
+            }
+            verbose($verbose_level_debug,
+                    "\nBackup file is compressed.");
+        # Try to load the IO::Uncompress::Gunzip library if available (but
+        # don't require it)
+            BEGIN
+            {
+                our $has_uncompress_gunzip = 1;
+                # Though this does nothing, it prevents an invalid "only used
+                # once" warning that occurs for users without IO::Uncompress
+                # installed.
+                undef $GunzipError;
+                eval 'use IO::Uncompress::Gunzip qw(gunzip $GunzipError);';
+                if ($@)
+                {
+                    $has_uncompress_gunzip = 0;
+                }
+            }
+            if (!$has_uncompress_gunzip)
+            {
+                verbose($verbose_level_debug,
+                        " - IO::Uncompress::Gunzip is not installed.");
+            }
+            else
+            {
+                verbose($verbose_level_debug,
+                        " - Uncompressing backup file with".
+                        " IO::Uncompress::Gunzip.");
+                my ($bfh, $temp_backup_filename) = tempfile(UNLINK => 1);
+                my $result = gunzip(
+                    "$backup_conf{'directory'}/$backup_conf{'filename'}" =>
+                    $bfh);
+                if ((defined($result)) &&
+                    (-f "$temp_backup_filename") &&
+                    (-r "$temp_backup_filename") &&
+                    (-s "$temp_backup_filename"))
+                {
+                    $backup_conf{'directory'} = '';
+                    $backup_conf{'filename'} = "$temp_backup_filename";
+                    return 0;
+                }
+                verbose($verbose_level_always,
+                        "   Error:  $GunzipError");
+            }
+        }
+        else
+        {
+            verbose($verbose_level_debug,
+                    "\nUnrecognized uncompress program.".
+                    " Assuming backup file is compressed.",
+                    " - If the file is not compressed, please do not specify".
+                    " a custom uncompress",
+                    "   program name.");
+        }
+    # Try to uncompress the file with the uncompress binary.
+    # With the approach, the original backup file will be uncompressed and
+    # left uncompressed.
+        verbose($verbose_level_debug,
+                " - Uncompressing backup file with $uncompress.",
+                "   The original backup file will be left uncompressed.".
+                " Please recompress,",
+                "   if desired.");
+        my $backup_path = "$backup_conf{'directory'}/$backup_conf{'filename'}";
+        my $output = `$uncompress '$backup_path' 2>&1`;
+        my $exit = $? >> 8;
+        verbose($verbose_level_debug,
+                "\n$uncompress exited with status:  $exit");
+        if ($exit)
+        {
+            verbose($verbose_level_debug,
+                    "$uncompress output:", $output);
+        }
+        else
+        {
+            if (!-r "$backup_conf{'directory'}/$backup_conf{'filename'}")
+            {
+        # Assume the final extension was removed by uncompressing.
+                $backup_conf{'filename'} =~ s/\.\w+$//;
+                if (!-r "$backup_conf{'directory'}/$backup_conf{'filename'}")
+                {
+                    verbose($verbose_level_error,
+                            "\nERROR:  Unable to find uncompressed backup".
+                            " file.");
+                    die("\nInvalid backup filename, stopped");
+                }
+            }
+        }
+        return $exit;
+    }
+
+    sub do_hostname_change
+    {
+        my $exit = 0;
+        if (!$new_hostname)
+        {
+            $exit++;
+            verbose($verbose_level_always,
+                    "\nERROR:  Cannot change hostname without --new_hostname".
+                    " value.");
+        }
+        if (!$old_hostname)
+        {
+            $exit++;
+            verbose($verbose_level_always,
+                    "\nERROR:  Cannot change hostname without --old_hostname".
+                    " value.");
+        }
+        if ($exit > 0)
+        {
+            die("\nInvalid --old/--new_hostname value(s) for".
+                " --change_hostname, stopped");
+        }
+    # Get a list of all tables in the DB.
+        if (defined($dbh))
+        {
+            my $num_tables = 0;
+            my $sth_tables;
+            my $table_cat;
+            my $table_schema;
+            my $table_name;
+            my $sth_columns;
+            my $column_name;
+            my $query;
+            my $sth_update;
+            my $result;
+
+            $sth_tables = $dbh->table_info('', '', '', 'TABLE');
+            while (my $table = $sth_tables->fetchrow_hashref)
+            {
+            # Loop over all tables in the DB, checking for a hostname column.
+                $num_tables++;
+                $table_cat = $table->{'TABLE_CAT'};
+                $table_schema = $table->{'TABLE_SCHEM'};
+                $table_name = $table->{'TABLE_NAME'};
+                $sth_columns = $dbh->column_info($table_cat, $table_schema,
+                                                 $table_name, '%');
+                while (my $column = $sth_columns->fetchrow_hashref)
+                {
+                # If a hostname column exists, change its value.
+                    $column_name = $column->{'COLUMN_NAME'};
+                    if ($column_name eq 'hostname')
+                    {
+                        verbose($verbose_level_debug,
+                                "Found 'hostname' column in $table_name.");
+                        $query = "UPDATE $table_name SET hostname = ?".
+                                 " WHERE hostname = ?";
+                        $sth_update = $dbh->prepare($query);
+                        $sth_update->bind_param(1, $new_hostname);
+                        $sth_update->bind_param(2, $old_hostname);
+                        $result = $sth_update->execute;
+                        if (!defined($result))
+                        {
+                            verbose($verbose_level_always,
+                                    "Unable to update hostname in table: ".
+                                    $table_name,
+                                    $sth_update->errstr);
+                            $exit++;
+                        }
+                        else
+                        {
+                            verbose($verbose_level_debug,
+                                    "Updated ".
+                                    (($result == 0E0) ? '0' : $result)
+                                    ." rows in table: $table_name");
+                        }
+                        last;
+                    }
+                }
+            }
+            if ($num_tables == 0)
+            {
+                verbose($verbose_level_always,
+                        "Database is empty. Cannot change hostname.");
+                return 1;
+            }
+        # delete (orphaned) rows with hostname coded into chainid in tvchain
+        # live-<hostname>-2008-06-26T18:43:18
+            $table_name = 'tvchain';
+            $query = "DELETE FROM $table_name WHERE chainid LIKE ?";
+            $sth_update = $dbh->prepare($query);
+            $sth_update->bind_param(1, '%'.$old_hostname.'%');
+            $result = $sth_update->execute;
+            if (!defined($result))
+            {
+                verbose($verbose_level_debug,
+                        "Unable to remove orphaned $table_name rows.",
+                        $sth_update->errstr);
+            }
+            else
+            {
+                verbose($verbose_level_debug,
+                        "Removed ".
+                        (($result == 0E0) ? '0' : $result)
+                        ." orphaned entries in table: $table_name");
+            }
+        # hostname coded into SGweightPerDir setting in settings (modify)
+        # SGweightPerDir:<hostname>:<directory>
+            $table_name = 'settings';
+            $query = "UPDATE $table_name SET value = REPLACE(value, ?, ?)".
+                     " WHERE value LIKE ?";
+            $sth_update = $dbh->prepare($query);
+            $sth_update->bind_param(1, $old_hostname);
+            $sth_update->bind_param(2, $new_hostname);
+            $sth_update->bind_param(3, '%'.$old_hostname.'%');
+            $result = $sth_update->execute;
+            if (!defined($result))
+            {
+                verbose($verbose_level_always,
+                        "Unable to update SGweightPerDir setting for host.",
+                        $sth_update->errstr);
+            }
+            else
+            {
+                verbose($verbose_level_debug,
+                        "Updated ".
+                        (($result == 0E0) ? '0' : $result)
+                        ." SGweightPerDir settings.");
+            }
+        }
+        return $exit;
+    }
+
+    sub restore_backup
+    {
+        my $exit = 0;
+        my $defaults_extra_file = create_defaults_extra_file;
+        my $host_arg = '';
+        my $port_arg = '';
+        my $user_arg = '';
+        my $filter = '';
+        if ($defaults_extra_file)
+        {
+            $defaults_arg=" --defaults-extra-file='$defaults_extra_file'";
+        }
+        else
+        {
+            $defaults_arg='';
+        }
+    # Create the args for host, port, and user, shell-escaping values, as
+    # necessary.
+        if ($mysql_conf{'db_host'})
+        {
+            $mysql_conf{'db_host'} =~ s/'/'\\''/g;
+            $host_arg=" --host='$mysql_conf{'db_host'}'";
+        }
+        if ($mysql_conf{'db_port'} > 0)
+        {
+            $mysql_conf{'db_port'} =~ s/'/'\\''/g;
+            $port_arg=" --port='$mysql_conf{'db_port'}'";
+        }
+        if ($mysql_conf{'db_user'})
+        {
+            $mysql_conf{'db_user'} =~ s/'/'\\''/g;
+            $user_arg=" --user='$mysql_conf{'db_user'}'";
+        }
+    # Configure a filter for a partial/new-host restore
+        if ($partial_restore)
+        {
+            my @partial_restore_tables;
+            if (defined($with_plugin_data))
+            {
+            # Blacklist the MythTV tables we don't want to keep
+            # This may result in keeping old tables that were dropped in
+            # previous DB schema updates if the user is running a restore
+            # script from an older version of MythTV, but the extra data will
+            # only take a bit of hard drive space.
+                @partial_restore_tables = ('callsignnetworkmap',
+                                           'capturecard',
+                                           'cardinput',
+                                           'channel',
+                                           'channelscan',
+                                           'channelscan_channel',
+                                           'channelscan_dtv_multiplex',
+                                           'codecparams',
+                                           'conflictresolutionany', # historic
+                                           'conflictresolutionoverride', # hst
+                                           'conflictresolutionsingle',   # hst
+                                           'credits',
+                                           'customexample',
+                                           'diseqc_config',
+                                           'diseqc_tree',
+                                           'displayprofilegroups',
+                                           'displayprofiles',
+                                           'dtv_multiplex',
+                                           'dtv_privatetypes',
+                                           'dvb_channel',           # historic
+                                           'dvb_pids',              # historic
+                                           'dvb_sat',               # historic
+                                           'dvb_signal_quality',    # historic
+                                           'dvb_transport',         # historic
+                                           'eit_cache',
+                                           'favorites',
+                                           'filemarkup',
+                                           'housekeeping',
+                                           'inputgroup',
+                                           'inuseprograms',
+                                           'jobqueue',
+                                           'jumppoints',
+                                           'keybindings',
+                                           'keyword',
+                                           'mythlog',
+                                           'networkiconmap',
+                                           'oldfind',
+                                           'oldprogram',
+                                           'people',
+                                           'pidcache',
+                                           'playgroup',
+                                           'powerpriority',
+                                           'profilegroups',
+                                           'program',
+                                           'programgenres',
+                                           'programrating',
+                                           'recgrouppassword',
+                                           'recordedcredits',
+                                           'recordedfile',
+                                           'recordedprogram',
+                                           'recordingprofiles',
+                                           'recordmatch',
+                                           'recordoverride',        # historic
+                                           'record_tmp',
+                                           'schemalock',
+                                           'settings',
+                                           'storagegroup',
+                                           'transcoding',           # historic
+                                           'tvchain',
+                                           'upnpmedia',
+                                           'videobookmarks',        # historic
+                                           'videosource',
+                                           'xvmc_buffer_settings'   # historic
+                                          );
+            }
+            else
+            {
+            # Whitelist the tables we want to keep
+                @partial_restore_tables = ('oldrecorded',
+                                           'record',
+                                           'recorded',
+                                           'recordedmarkup',
+                                           'recordedprogram',
+                                           'recordedrating',
+                                           'recordedseek');
+            }
+            if (!defined($restore_xmltvids))
+            {
+                $filter = '^INSERT INTO \`(' .
+                          join('|', @partial_restore_tables) . ')\` ';
+                verbose($verbose_level_debug,
+                        "\nRestoring partial backup with filter:", $filter);
+            }
+        }
+        my $command = "${mysql_client}${defaults_arg}${host_arg}${port_arg}".
+                      "${user_arg} $mysql_conf{'db_name'}";
+        verbose($verbose_level_debug,
+                "\nExecuting command:", $command);
+        my $read_status = open(BACKUP,
+            "<$backup_conf{'directory'}/$backup_conf{'filename'}");
+        if (!defined($read_status))
+        {
+            verbose($verbose_level_always,
+                    "\nERROR: Unable to read backup file.");
+            return 255;
+        }
+        my $write_status = open(COMMAND, "| $command");
+        if (!defined($write_status))
+        {
+            verbose($verbose_level_always,
+                    "\nERROR: Unable to execute $mysql_client.");
+            return 254;
+        }
+        my $lines_total = 0;
+        my $lines_restored = 0;
+        while (<BACKUP>)
+        {
+            $lines_total++;
+            if ($partial_restore)
+            {
+                if ($restore_xmltvids)
+                {
+                # Send all lines through
+                }
+                if ($with_plugin_data)
+                {
+                # Skip tables in the blacklist
+                    next if /$filter/;
+                }
+                else
+                {
+                # Skip tables not in the whitelist
+                    next if !/$filter/;
+                }
+            }
+            $lines_restored++;
+            print COMMAND or die("\nERROR:  Cannot write to ".
+                                 "$mysql_client, stopped");
+        }
+        close(COMMAND);
+        close(BACKUP);
+        $exit = $?;
+        verbose($verbose_level_debug,
+                "\n$mysql_client exited with status:  $exit",
+                "\nRestored $lines_restored of $lines_total lines.");
+        return $exit;
+    }
+
+##############################################################################
+# Main functionality
+##############################################################################
+
+# The first argument after option parsing, if it exists, should be a database
+# information file.
+    $database_information_file = shift;
+
+    configure_environment;
+    read_config;
+    check_config;
+
+    print_configuration;
+
+    my $status = 1;
+    if (check_database)
+    {
+        if ($change_hostname)
+        {
+            $status = do_hostname_change;
+            print("\nSuccessfully changed hostname.\n") if (!$status);
+        }
+        elsif (!uncompress_backup_file)
+        {
+            $status = restore_backup;
+            print("\nSuccessfully restored backup.\n") if (!$status);
+        }
+    }
+
+    $dbh->disconnect if (defined($dbh));
+
+    exit $status;
+

programs/scripts/database/database_mythconverg_backup.pl

@@ +1 @@
+#!/usr/bin/perl -w
+#
+# database_mythconverg_backup.pl
+#
+# Creates a backup of the MythTV database.
+#
+# For details, see:
+#   database_mythconverg_backup.pl --help
+
+# Includes
+    use Getopt::Long;
+    use File::Temp qw/ tempfile /;
+
+# Script info
+    $NAME           = 'MythTV Database Backup Script';
+    $VERSION        = '1.0.1';
+
+# Some variables we'll use here
+    our ($username, $homedir, $mythconfdir, $database_information_file);
+    our ($mysqldump, $compress, $rotate, $rotateglob, $backup_xmltvids);
+    our ($usage, $debug, $show_version, $show_version_script, $dbh);
+    our ($d_db_name, $d_mysqldump, $d_compress, $d_rotate, $d_rotateglob);
+# This script does not accept a database password on the command-line.
+# Any packager who enables the functionality should modify the --help output.
+#    our ($db_password);
+    our ($db_hostname, $db_port, $db_username, $db_name, $db_schema_version);
+    our ($backup_directory, $backup_filename);
+    our ($verbose_level_always, $verbose_level_debug, $verbose_level_error);
+
+    our %mysql_conf  = ('db_host'       => '',
+                        'db_port'       => -1,
+                        'db_user'       => '',
+                        'db_pass'       => '',
+                        'db_name'       => '',
+                        'db_schemaver'  => ''
+                        );
+    our %backup_conf = ('directory'     => '',
+                        'filename'      => ''
+                       );
+
+# Debug levels
+    $verbose_level_always = 0;
+    $verbose_level_debug = 1;
+    $verbose_level_error = 255;
+
+# Defaults
+    $d_db_name       = 'mythconverg';
+    $d_mysqldump     = 'mysqldump';
+    $d_compress      = 'gzip';
+    $d_rotate        = 5;
+    $d_rotateglob    = $d_db_name . '-????-??????????????.sql*';
+
+# Provide default values for GetOptions
+    $mysqldump       = $d_mysqldump;
+    $compress        = $d_compress;
+    $rotate          = $d_rotate;
+    $rotateglob      = $d_rotateglob;
+    $debug           = 0;
+
+# Load the cli options
+    GetOptions('hostname|DBHostName=s'              => \$db_hostname,
+               'port|DBPort=i'                      => \$db_port,
+               'username|DBUserName=s'              => \$db_username,
+# This script does not accept a database password on the command-line.
+#               'password|DBPassword=s'              => \$db_password,
+               'name|DBName=s'                      => \$db_name,
+               'schemaver|DBSchemaVer=s'            => \$db_schema_version,
+               'directory|DBBackupDirectory=s'      => \$backup_directory,
+               'filename|DBBackupFilename=s'        => \$backup_filename,
+               'mysqldump=s'                        => \$mysqldump,
+               'compress=s'                         => \$compress,
+               'rotate=i'                           => \$rotate,
+               'rotateglob|glob=s'                  => \$rotateglob,
+               'backup_xmltvids|xmltvids'           => \$backup_xmltvids,
+               'usage|help|h'                       => \$usage,
+               'version'                            => \$show_version,
+               'script_version|v'                   => \$show_version_script,
+               'verbose|debug|d+'                   => \$debug
+              );
+
+# Print version information
+    sub print_version_information
+    {
+        my $script_name = substr $0, rindex($0, '/') + 1;
+        print "$NAME\n$script_name\nversion: $VERSION\n";
+    }
+
+    if ($show_version_script)
+    {
+        print "$NAME,$VERSION,,\n";
+        exit;
+    }
+    elsif ($show_version)
+    {
+        print_version_information;
+        exit;
+    }
+
+
+# Print usage
+    if ($usage)
+    {
+        print_version_information;
+        print <<EOF;
+
+Usage:
+  $0 [options|database_information_file]
+
+Creates a backup of the MythTV database.
+
+DETAILED DESCRIPTION:
+
+This script can be called by MythTV for creating automatic database backups.
+In this mode, it is always exected with a single command-line argument
+specifying the name of a "database information file" (see DATABASE INFORMATION
+FILE, below), which contains sufficient information about the database and the
+backup to allow the script to create a backup without needing any additional
+configuration files. In this mode, all other MythTV configuration files
+(including config.xml, mysql.txt) are ignored, but the backup resource file
+(see RESOURCE FILE, below) and the MySQL option files (i.e. /etc/my.cnf or
+~/.my.cnf) will be honored.
+
+The script can also be called interactively (i.e. "manually") by the user to
+create a database backup on demand. Required information may be passed into
+the script using command-line arguments or with a database information file.
+If a database information file is specified, all command-line arguments will be
+ignored. If no database information file is specified, the script will attempt
+to determine the appropriate configuration by using the MythTV configuration
+file(s) (prefering config.xml, but falling back to mysql.txt if no config.xml
+exists). Once the MythTV configuration file has been parsed, the backup
+resource file (see RESOURCE FILE, below) will be parsed, then command-line
+arguments will be applied (thus overriding any values determined from the
+configuration files).
+
+The only information required by the script is the directory in which the
+backup should be created. Therefore, when using a database information file,
+the DBBackupDirectory should be specified, or if running manually, the
+--directory command-line argument should be specified. The DBBackupDirectory
+may be specified in a backup resource file (see RESOURCE FILE, below). Doing
+so is especially useful for manual backups. If the specified directory is not
+writable, the script will terminate. Likewise, if a file whose name matches
+the name to be used for the backup file already exists, the script will
+terminate.
+
+If the database name is not specified, the script will attempt to use the
+MythTV default database name, $d_db_name. Note that the same is not true for
+the database username and database password. These must be explicitly
+specified. The password must be specified in a database information file, a
+backup resource file, or a MySQL options file. The username may be specified
+the same way or may be specified using a command-line argument if not using a
+database information file.
+
+While this script may be called while MythTV is running, there is a possibility
+of creating a backup with data integrity errors (i.e. if MythTV updates data in
+multiple tables between the time the script backs up the first and subsequent
+tables). Also, depending on your system configuration, performing a backup
+(which may result in locking a table while it is being backed up) while
+recording may cause corruption of the recording or inability to properly write
+recording data (such as the recording seek table) to the database.
+Therefore, if configuring this script to run in a cron job, try to ensure it
+runs at a time when recordings are least likely to occur. Alternatively, by
+choosing to run the script in a system start/shutdown script (i.e. an init
+script), you may call the script before starting mythbackend or after stopping
+mythbackend. Note, however, that checking whether to perform the backup is the
+responsibility of the init script (not this script)--i.e. in a system with
+multiple frontends/backends, the init script should ensure the backup is
+created only on the master backend.
+
+DATABASE INFORMATION FILE
+
+The database information file contains information about the database and the
+backup. The information within the file is specified as name=value pairs using
+the same names as used by the MythTV config.xml and mysql.txt configuration
+files. The following variables are recognized:
+
+  DBHostName - The hostname (or IP address) which should be used to find the
+               MySQL server.
+  DBPort - The TCP/IP port number to use for the connection. This may have a
+           value of 0, i.e. if the hostname is localhost or if the server is
+           using the default MySQL port or the port specified in a MySQL
+           options file.
+  DBUserName - The database username to use when connecting to the server.
+  DBPassword - The password to use when connecting to the server.
+  DBName - The name of the database that contains the MythTV data.
+  DBSchemaVer - The MythTV schema version of the database. This value will be
+                used to create the backup filename, but only if the filename
+                has not been specified using DBBackupFilename or the --filename
+                argument.
+  DBBackupDirectory - The directory in which the backup file should be
+                      created. This directory may have been specially
+                      configured by the user as the "DB Backups" storage
+                      group. It is recommended that this directory be
+                      used--especially in "common-use" scripts such as those
+                      provided by distributions.
+  DBBackupFilename - The name of the file in which the backup should be
+                     created. Additional extensions may be added by this
+                     script as required (i.e. adding an appropriate suffix,
+                     such as ".gz", to the file if it is compressed). If the
+                     filename recommended by mythbackend is used, it will be
+                     displayed in the GUI messages provided for the user. If
+                     the recommended filename is not used, the user will not be
+                     told where to find the backup file. If no value is
+                     provided, a filename using the default filename format
+                     will be chosen.
+  mysqldump        - The path (including filename) of the mysqldump executable.
+  compress         - The command (including path, if necessary) to use to
+                     compress the backup. Using gzip is significantly less
+                     resource intensive on an SQL backup file than using bzip2,
+                     at the cost of a slightly (about 33%) larger compressed
+                     filesize, a difference which should be irrelevant at the
+                     filesizes involved (especially when compared to the size
+                     of recording files). If you decide to use another
+                     compression algorithm, please ensure you test it
+                     appropriately to verify it does not negatively affect
+                     operation of your system. If no value is specified for
+                     compress or if the value '$d_compress' is specified, the
+                     script will first attempt to use the IO::Compress::Gzip
+                     module to compress the backup file, but, if not available,
+                     will run the command specified. Therefore, if
+                     IO::Compress::Gzip is installed and functional, specifying
+                     a value for compress is unnecessary. If neither approach
+                     works, the backup file will be left uncompressed.
+  rotate           - The number of backups to keep when rotating. To disable
+                     rotation, specify -1. Backup rotation is performed by
+                     identifying all files in DBBackupDirectory whose names
+                     match the glob specified by rotateglob. It is critical
+                     that the chosen backup filenames can be sorted properly
+                     using an alphabetical sort. If using the default filename
+                     format--which contains the DBSchemaVer--and you downgrade
+                     MythTV and restore a backup from an older DBSchemaVer,
+                     make sure you move the backups from the newer DBSchemaVer
+                     out of the DBBackupDirectory or they may cause your new
+                     backups to be deleted.
+  rotateglob       - The sh-like glob used to identify files within
+                     DBBackupDirectory to be considered for rotation. Be
+                     very careful with the value--especially if using a
+                     DBBackupDirectory that contains any files other than
+                     backups.
+
+RESOURCE FILE
+
+The backup resource file specifies values using the same format as described
+for the database information file, above, but is intended as a "permanent,"
+user-created configuration file. The database information file is intended as
+a "single-use" configuration file, often created automatically (i.e. by a
+program, such as mythbackend, or a script). The backup resource file should be
+placed at "~/.mythtv/backuprc" and given appropriate permissions. To be usable
+by the script, it must be readable. However, it should be protected as
+required--i.e. if the DBPassword is specified, it should be made readable only
+by the owner.
+
+When specifying a database information file, the resource file is parsed before
+the database information file to prevent the resource file from overriding the
+information in the database information file. When no database information
+file is specified, the resource file is parsed after the MythTV configuration
+files, but before the command-line arguments to allow the resource file to
+override values in the configuration files and to allow command-line arguments
+to override resource file defaults.
+
+options:
+
+--hostname [database hostname]
+
+    The hostname (or IP address) which should be used to find the MySQL server.
+    See DBHostName, above.
+
+--port [database port]
+
+    The TCP/IP port number to use for connection to the MySQL server. See
+    DBPort, above.
+
+--username [database username]
+
+    The MySQL username to use for connection to the MySQL server. See
+    DBUserName, above.
+
+--name [database name]
+
+    The name of the database containing the MythTV data. See DBName, above.
+
+    Default:  $d_db_name
+
+--schemaver [MythTV database schema version]
+
+    The MythTV schema version. See DBSchemaVer, above.
+
+--directory [directory]
+
+    The directory in which the backup file should be stored. See
+    DBBackupDirectory, above.
+
+--filename [database backup filename]
+
+    The name to use for the database backup file. If not provided, a filename
+    using a default format will be chosen. See DBBackupFilename, above.
+
+--mysqldump [path]
+
+    The path (including filename) of the mysqldump executable. See mysqldump
+    in the DATABASE INFORMATION FILE description, above.
+
+    Default:  $d_mysqldump
+
+--compress [path]
+
+    The command (including path, if necessary) to use to compress the backup.
+    See compress in the DATABASE INFORMATION FILE description, above.
+
+    Default:  $d_compress
+
+--rotate [number]
+    The number of backups to keep when rotating. To disable rotation, specify
+    -1. See rotate in the DATABASE INFORMATION FILE description, above.
+
+    Default:  $d_rotate
+
+--rotateglob [glob]
+    The sh-like glob used to identify files within DBBackupDirectory to be
+    considered for rotation. See rotateglob in the DATABASE INFORMATION FILE
+    description, above.
+
+    Default:  $d_rotateglob
+
+--backup_xmltvids
+    Rather than creating a backup of the entire database, create a backup of
+    xmltvid's. This is useful when doing a full channel scan. The resulting
+    backup is a series of SQL UPDATE statements that can be executed to set
+    the xmltvid for channels whose callsign is the same before and after
+    the scan. Note that the backup file will contain comments with additional
+    channel information, which you can use to identify channels in case the
+    callsign changes.
+
+--help
+
+    Show this help text.
+
+--version
+
+    Show version information.
+
+--verbose
+
+    Show what is happening.
+
+--script_version | -v
+
+    Show script version information. This is primarily useful for scripts
+    or programs needing to parse the version information.
+
+QUICK START:
+
+Create a file ~/.mythtv/backuprc with a single line,
+"DBBackupDirectory=/home/mythtv" (no quotes), and run this script to create a
+database backup. Use the --verbose argument to see what is happening.
+
+# echo "DBBackupDirectory=/home/mythtv" > ~/.mythtv/backuprc
+# $0 --verbose
+
+Make sure you keep the backuprc file for next time. Once you have successfully
+created a backup, the script may be run without the --verbose argument.
+
+To backup xmltvids:
+
+Ensure you have a ~/.mythtv/backuprc file, as described above, and execute this
+script with the --backup_xmltvids argument.
+
+# $0 --backup_xmltvids
+
+EOF
+        exit;
+    }
+
+    sub verbose
+    {
+        my $level = shift;
+        my $error = 0;
+        if ($level == $verbose_level_error)
+        {
+            $error = 1;
+        }
+        else
+        {
+            return unless ($debug >= $level);
+        }
+        print { $error ? STDOUT : STDERR } join("\n", @_), "\n";
+    }
+
+    sub print_configuration
+    {
+        verbose($verbose_level_debug,
+                "\nDatabase Information:",
+                "         DBHostName:  $mysql_conf{'db_host'}",
+                "             DBPort:  $mysql_conf{'db_port'}",
+                "         DBUserName:  $mysql_conf{'db_user'}",
+                "         DBPassword:  " .
+                    ( $mysql_conf{'db_pass'} ? 'XXX' : '' ),
+                  #  "$mysql_conf{'db_pass'}",
+                "             DBName:  $mysql_conf{'db_name'}",
+                "        DBSchemaVer:  $mysql_conf{'db_schemaver'}",
+                "  DBBackupDirectory:  $backup_conf{'directory'}",
+                "   DBBackupFilename:  $backup_conf{'filename'}");
+        verbose($verbose_level_debug,
+                "\nExecutables:",
+                "          mysqldump:  $mysqldump",
+                "           compress:  $compress");
+    }
+
+    sub configure_environment
+    {
+        verbose($verbose_level_debug,
+                "\nConfiguring environment:");
+
+    # Get the user's login and home directory, so we can look for config files
+        ($username, $homedir) = (getpwuid $>)[0,7];
+        $username = $ENV{'USER'} if ($ENV{'USER'});
+        $homedir  = $ENV{'HOME'} if ($ENV{'HOME'});
+        if ($username && !$homedir)
+        {
+            $homedir = "/home/$username";
+            if (!-e $homedir && -e "/Users/$username")
+            {
+                $homedir = "/Users/$username";
+            }
+        }
+        verbose($verbose_level_debug,
+                "  -    username:  $username",
+                "  -        HOME:  $homedir");
+
+    # Find the config directory
+        $mythconfdir = $ENV{'MYTHCONFDIR'}
+            ? $ENV{'MYTHCONFDIR'}
+            : "$homedir/.mythtv"
+            ;
+
+        verbose($verbose_level_debug,
+                "  - MYTHCONFDIR:  $mythconfdir");
+    }
+
+# Though much of the configuration file parsing could be done by the MythTV
+# Perl bindings, using them to retrieve database information is not appropriate
+# for a backup script. The Perl bindings require the backend to be running and
+# use UPnP for autodiscovery. Also, parsing the files "locally" allows
+# supporting even the old MythTV database configuration file, mysql.txt.
+    sub parse_database_information
+    {
+        my $file = shift;
+        verbose($verbose_level_debug,
+                "  - checking:  $file");
+        return 0 unless ($file && -e $file);
+        verbose($verbose_level_debug,
+                "     parsing:  $file");
+        open(CONF, $file) or die("\nERROR:  Unable to read $file:  $!".
+                                 ", stopped");
+        while (my $line = <CONF>)
+        {
+        # Cleanup
+            next if ($line =~ m/^\s*#/);
+            $line =~ s/^str //;
+            chomp($line);
+            $line =~ s/^\s+//;
+            $line =~ s/\s+$//;
+        # Split off the var=val pairs
+            my ($var, $val) = split(/ *[\=\: ] */, $line, 2);
+        # Also look for <var>val</var> from config.xml
+            if ($line =~ m/<(\w+)>(.+)<\/(\w+)>$/ && $1 eq $3)
+            {
+                $var = $1; $val = $2;
+            }
+            next unless ($var && $var =~ m/\w/);
+            if ($var eq 'DBHostName')
+            {
+                $mysql_conf{'db_host'} = $val;
+            }
+            elsif ($var eq 'DBPort')
+            {
+                $mysql_conf{'db_port'} = $val;
+            }
+            elsif ($var eq 'DBUserName')
+            {
+                $mysql_conf{'db_user'} = $val;
+            }
+            elsif ($var eq 'DBPassword')
+            {
+                $mysql_conf{'db_pass'} = $val;
+            }
+            elsif ($var eq 'DBName')
+            {
+                $mysql_conf{'db_name'} = $val;
+            }
+            elsif ($var eq 'DBSchemaVer')
+            {
+                $mysql_conf{'db_schemaver'} = $val;
+            }
+            elsif ($var eq 'DBBackupDirectory')
+            {
+                $backup_conf{'directory'} = $val;
+            }
+            elsif ($var eq 'DBBackupFilename')
+            {
+                $backup_conf{'filename'} = $val;
+            }
+            elsif ($var eq 'mysqldump')
+            {
+                $mysqldump = $val;
+            }
+            elsif ($var eq 'compress')
+            {
+                $compress = $val;
+            }
+            elsif ($var eq 'rotate')
+            {
+                $rotate = $val;
+            }
+            elsif ($var eq 'rotateglob')
+            {
+                $rotateglob = $val;
+            }
+        }
+        close CONF;
+        return 1;
+    }
+
+    sub read_mysql_txt
+    {
+    # Read the "legacy" mysql.txt file in use by MythTV. It could be in a
+    # couple places, so try the usual suspects in the same order that mythtv
+    # does in libs/libmyth/mythcontext.cpp
+        my $found = 0;
+        my $result = 0;
+        my @mysql = ('/usr/local/share/mythtv/mysql.txt',
+                     '/usr/share/mythtv/mysql.txt',
+                     '/usr/local/etc/mythtv/mysql.txt',
+                     '/etc/mythtv/mysql.txt',
+                     $homedir ? "$homedir/.mythtv/mysql.txt"    : '',
+                     'mysql.txt',
+                     $mythconfdir ? "$mythconfdir/mysql.txt"    : '',
+                    );
+        foreach my $file (@mysql)
+        {
+            $found = parse_database_information($file);
+            $result = $result + $found;
+        }
+        return $result;
+    }
+
+    sub read_resource_file
+    {
+        parse_database_information("$mythconfdir/backuprc");
+    }
+
+    sub apply_arguments
+    {
+        verbose($verbose_level_debug,
+                "\nApplying command-line arguments.");
+        if ($db_hostname)
+        {
+            $mysql_conf{'db_host'} = $db_hostname;
+        }
+        if ($db_port)
+        {
+            $mysql_conf{'db_port'} = $db_port;
+        }
+        if ($db_username)
+        {
+            $mysql_conf{'db_user'} = $db_username;
+        }
+    # This script does not accept a database password on the command-line.
+#        if ($db_password)
+#        {
+#            $mysql_conf{'db_pass'} = $db_password;
+#        }
+        if ($db_name)
+        {
+            $mysql_conf{'db_name'} = $db_name;
+        }
+        if ($db_schema_version)
+        {
+            $mysql_conf{'db_schemaver'} = $db_schema_version;
+        }
+        if ($backup_directory)
+        {
+            $backup_conf{'directory'} = $backup_directory;
+        }
+        if ($backup_filename)
+        {
+            $backup_conf{'filename'} = $backup_filename;
+        }
+    }
+
+    sub read_config
+    {
+        my $result = 0;
+    # If specified, use only the database information file
+        if ($database_information_file)
+        {
+            verbose($verbose_level_debug,
+                    "\nDatabase Information File specified. Ignoring all".
+                    " command-line arguments");
+            verbose($verbose_level_debug,
+                    "\nDatabase Information File:".
+                    " $database_information_file");
+            unless (-T "$database_information_file")
+            {
+                die("\nERROR:  Invalid database information file, stopped");
+            }
+        # When using a database information file, parse the resource file first
+        # so it cannot override database information file settings
+            read_resource_file;
+            $result = parse_database_information($database_information_file);
+            return $result;
+        }
+
+    # No database information file, so try the MythTV configuration files.
+        verbose($verbose_level_debug,
+                "\nParsing configuration files:");
+    # Prefer the config.xml file
+        my $file = $mythconfdir ? "$mythconfdir/config.xml" : '';
+        $result = parse_database_information($file);
+        if (!$result)
+        {
+        # Use the "legacy" mysql.txt file as a fallback
+            $result = read_mysql_txt;
+        }
+    # Read the resource file next to override the config file information, but
+    # to allow command-line arguments to override resource file "defaults"
+        read_resource_file;
+    # Apply the command-line arguments to override the information provided
+    # by the config file(s).
+        apply_arguments;
+        return $result;
+    }
+
+    sub check_database_libs
+    {
+    # Try to load the DBI library if available (but don't require it)
+        BEGIN
+        {
+            our $has_dbi = 1;
+            eval 'use DBI;';
+            if ($@)
+            {
+                $has_dbi = 0;
+            }
+        }
+        verbose($verbose_level_debug,
+                "\nDBI is not installed.") if (!$has_dbi);
+    # Try to load the DBD::mysql library if available (but don't
+    # require it)
+        BEGIN
+        {
+            our $has_dbd = 1;
+            eval 'use DBD::mysql;';
+            if ($@)
+            {
+                $has_dbd = 0;
+            }
+        }
+        verbose($verbose_level_debug,
+                "\nDBD::mysql is not installed.") if (!$has_dbd);
+        return ($has_dbi + $has_dbd);
+    }
+
+    sub check_database
+    {
+        if (!defined($dbh))
+        {
+            my $have_database_libs = check_database_libs;
+            return 0 if ($have_database_libs < 2);
+            $dbh = DBI->connect("dbi:mysql:".
+                                "database=$mysql_conf{'db_name'}:".
+                                "host=$mysql_conf{'db_host'}",
+                                "$mysql_conf{'db_user'}",
+                                "$mysql_conf{'db_pass'}",
+                                { PrintError => 0 });
+        }
+        return 1;
+    }
+
+    sub create_backup_filename
+    {
+    # Create a default backup filename
+        $backup_conf{'filename'} = $mysql_conf{'db_name'};
+        if (!$backup_conf{'filename'})
+        {
+            $backup_conf{'filename'} = $d_db_name;
+        }
+        if ((!$mysql_conf{'db_schemaver'}) &&
+            ($mysql_conf{'db_host'}) && ($mysql_conf{'db_name'}) &&
+            ($mysql_conf{'db_user'}) && ($mysql_conf{'db_pass'}))
+        {
+        # If DBI is available, query the DB for the schema version
+            if (check_database)
+            {
+                verbose($verbose_level_debug,
+                        "\nNo DBSchemaVer specified, querying database.");
+                my $query = 'SELECT data FROM settings WHERE value = ?';
+                if (defined($dbh))
+                {
+                    my $sth = $dbh->prepare($query);
+                    if ($sth->execute('DBSchemaVer'))
+                    {
+                        while (my @data = $sth->fetchrow_array)
+                        {
+                            $mysql_conf{'db_schemaver'} = $data[0];
+                            verbose($verbose_level_debug,
+                                    "Found DBSchemaVer:".
+                                    " $mysql_conf{'db_schemaver'}.");
+                        }
+                    }
+                    else
+                    {
+                        verbose($verbose_level_debug,
+                                "Unable to retrieve DBSchemaVer from".
+                                " database. Filename will not contain ",
+                                "DBSchemaVer.");
+                    }
+                }
+            }
+            else
+            {
+                verbose($verbose_level_debug,
+                        "\nNo DBSchemaVer specified.",
+                        "DBI and/or DBD:mysql is not available. Unable".
+                        " to query database to determine ",
+                        "DBSchemaVer. DBSchemaVer will not be included".
+                        " in backup filename.",
+                        "Please ensure DBI and DBD::mysql are".
+                        " installed.");
+            }
+        }
+        if ($mysql_conf{'db_schemaver'})
+        {
+            $backup_conf{'filename'} .= '-'.$mysql_conf{'db_schemaver'};
+        }
+    # Format the time using localtime data so we don't have to bring in
+    # another dependency.
+        my @timeData = localtime(time);
+        $backup_conf{'filename'} .= sprintf('-%04d%02d%02d%02d%02d%02d.sql',
+                                            ($timeData[5] + 1900),
+                                            ($timeData[4] + 1),
+                                            $timeData[3], $timeData[2],
+                                            $timeData[1], $timeData[0]);
+    }
+
+    sub check_config
+    {
+        verbose($verbose_level_debug,
+                "\nChecking configuration.");
+    # Check directory/filename
+        if (!$backup_conf{'directory'})
+        {
+            print_configuration;
+            die("\nERROR:  DBBackupDirectory not specified, stopped");
+        }
+        if ((!-d $backup_conf{'directory'}) ||
+            (!-w $backup_conf{'directory'}))
+        {
+            print_configuration;
+            verbose($verbose_level_error,
+                    "\nERROR:  DBBackupDirectory is not a directory or is not".
+                    " writable. Please specify",
+                    "        a directory in your database information file" .
+                    " using DBBackupDirectory.",
+                    "        If not using a database information file," .
+                    " please specify the ",
+                    "        --directory command-line option.");
+            die("\nInvalid backup directory, stopped");
+        }
+        if (!$backup_conf{'filename'})
+        {
+            if ($backup_xmltvids)
+            {
+                my $file = 'mythtv_xmltvid_backup';
+            # Format the time using localtime data so we don't have to bring in
+            # another dependency.
+                my @timeData = localtime(time);
+                $file .= sprintf('-%04d%02d%02d%02d%02d%02d.sql',
+                                 ($timeData[5] + 1900),
+                                 ($timeData[4] + 1),
+                                 $timeData[3], $timeData[2],
+                                 $timeData[1], $timeData[0]);
+                $backup_conf{'filename'} = $file;
+            }
+            else
+            {
+                create_backup_filename;
+            }
+        }
+        if ( -e "$backup_conf{'directory'}/$backup_conf{'filename'}")
+        {
+            verbose($verbose_level_error,
+                    "\nERROR:  The specified file already exists.");
+            die("\nInvalid backup filename, stopped");
+        }
+        if (!$mysql_conf{'db_name'})
+        {
+            verbose($verbose_level_debug,
+                    "\nWARNING:  DBName not specified. Using $d_db_name");
+            $mysql_conf{'db_name'} = $d_db_name;
+        }
+    # Though the script will attempt a backup even if no other database
+    # information is provided (i.e. using "defaults" from the MySQL options
+    # file, warning the user that some "normally-necessary" information is not
+    # provided may be nice.
+        return if (!$debug);
+        if (!$mysql_conf{'db_host'})
+        {
+            verbose($verbose_level_debug,
+                    "\nWARNING:  DBHostName not specified.",
+                    "         Assuming it's specified in the MySQL".
+                    " options file.");
+        }
+        if (!$mysql_conf{'db_user'})
+        {
+            verbose($verbose_level_debug,
+                    "\nWARNING:  DBUserName not specified.",
+                    "         Assuming it's specified in the MySQL".
+                    " options file.");
+        }
+        if (!$mysql_conf{'db_pass'})
+        {
+            verbose($verbose_level_debug,
+                    "\nWARNING:  DBPassword not specified.",
+                    "         Assuming it's specified in the MySQL".
+                    " options file.");
+        }
+    }
+
+    sub create_defaults_extra_file
+    {
+        return '' if (!$mysql_conf{'db_pass'});
+        verbose($verbose_level_debug,
+                "\nAttempting to use supplied password for $mysqldump.",
+                "Any [client] or [mysqldump] password specified in the MySQL".
+                " options file will",
+                "take precedence.");
+    # Let tempfile handle unlinking on exit so we don't have to verify that the
+    # file with $filename is the file we created
+        my ($fh, $filename) = tempfile(UNLINK => 1);
+        print $fh  "[client]\npassword=$mysql_conf{'db_pass'}\n".
+                   "[mysqldump]\npassword=$mysql_conf{'db_pass'}\n";
+        return $filename;
+    }
+
+    sub do_xmltvid_backup
+    {
+        my $exit = 1;
+        if (check_database)
+        {
+            my ($chanid, $channum, $callsign, $name, $xmltvid);
+            my $query = "  SELECT chanid, channum, callsign, name, xmltvid".
+                        "    FROM channel ".
+                        "ORDER BY CAST(channum AS SIGNED),".
+                        "         CAST(SUBSTRING(channum".
+                        "                        FROM (1 +".
+                        "                              LOCATE('_', channum) +".
+                        "                              LOCATE('-', channum) +".
+                        "                              LOCATE('#', channum) +".
+                        "                              LOCATE('.', channum)))".
+                        "              AS SIGNED)";
+            my $sth = $dbh->prepare($query);
+            verbose($verbose_level_debug,
+                    "\nQuerying database for xmltvid information.");
+            my $file = "$backup_conf{'directory'}/$backup_conf{'filename'}";
+            open BACKUP, '>', $file or die("\nERROR:  Unable to open".
+                                           " $file:  $!, stopped");
+            for ($section = 0; $section < 2; $section++)
+            {
+                if ($sth->execute)
+                {
+                    while (my @data = $sth->fetchrow_array)
+                    {
+                        $chanid = $data[0];
+                        $channum = $data[1];
+                        $callsign = $data[2];
+                        $name = $data[3];
+                        $xmltvid = $data[4];
+                        verbose($verbose_level_debug,
+                                "Found channel: $chanid, $channum, $callsign,".
+                                " $name, $xmltvid.") if ($section == 0);
+                        if ($xmltvid && $callsign)
+                        {
+                            if ($section == 0)
+                            {
+                                print BACKUP "-- Start Channel Data\n".
+                                             "-- ID: '$chanid'\n".
+                                             "-- Number: '$channum'\n".
+                                             "-- Callsign: '$callsign'\n".
+                                             "-- Name: '$name'\n".
+                                             "-- XMLTVID: '$xmltvid'\n".
+                                             "-- End Channel Data\n";
+                                print BACKUP "UPDATE channel".
+                                             " SET xmltvid = '$xmltvid'".
+                                             " WHERE callsign = '$callsign'".
+                                             ";\n";
+                            }
+                            else
+                            {
+                                print BACKUP "UPDATE channel".
+                                             " SET xmltvid = '$xmltvid'".
+                                             " WHERE channum = '$channum'".
+                                             " AND name = '$name';\n";
+                            }
+                        }
+                    }
+                    if ($section == 0)
+                    {
+                        verbose($verbose_level_debug,
+                                "\nSuccessfully backed up xmltvid".
+                                " information.".
+                                "\n\nCreating alternate format backup.");
+                        print BACKUP "\n\n/* Alternate format */\n".
+                                     "/*\n";
+                    }
+                    else
+                    {
+                        print BACKUP "*/\n";
+                        verbose($verbose_level_debug,
+                                "Successfully created alternate format".
+                                " backup.");
+                    }
+                    $exit = 0;
+                }
+                else
+                {
+                    verbose($verbose_level_error,
+                            "\nERROR: Unable to retrieve xmltvid information".
+                            " from database.");
+                    die("\nError retrieving xmltvid information, stopped");
+                }
+            }
+            close BACKUP;
+        }
+        else
+        {
+            verbose($verbose_level_error,
+                    "\nERROR:  Unable to backup xmltvids without Perl".
+                    " database libraries.",
+                    "        Please ensure the Perl DBI and DBD::mysql".
+                    " modules are installed.");
+            die("\nPerl database libraries missing, stopped");
+        }
+        return $exit;
+    }
+
+    sub do_backup
+    {
+        my $defaults_extra_file = create_defaults_extra_file;
+        my $host_arg = '';
+        my $port_arg = '';
+        my $user_arg = '';
+        if ($defaults_extra_file)
+        {
+            $defaults_arg=" --defaults-extra-file='$defaults_extra_file'";
+        }
+        else
+        {
+            $defaults_arg='';
+        }
+    # Create the args for host, port, and user, shell-escaping values, as
+    # necessary.
+        if ($mysql_conf{'db_host'})
+        {
+            $mysql_conf{'db_host'} =~ s/'/'\\''/g;
+            $host_arg=" --host='$mysql_conf{'db_host'}'";
+        }
+        if ($mysql_conf{'db_port'} > 0)
+        {
+            $mysql_conf{'db_port'} =~ s/'/'\\''/g;
+            $port_arg=" --port='$mysql_conf{'db_port'}'";
+        }
+        if ($mysql_conf{'db_user'})
+        {
+            $mysql_conf{'db_user'} =~ s/'/'\\''/g;
+            $user_arg=" --user='$mysql_conf{'db_user'}'";
+        }
+    # Use redirects to capture stderr (for debug) and send stdout (the backup)
+    # to a file
+        my $command = "${mysqldump}${defaults_arg}${host_arg}${port_arg}".
+                      "${user_arg} --add-drop-table --add-locks ".
+                      "--allow-keywords --complete-insert --extended-insert ".
+                      "--lock-tables --no-create-db --quick ".
+                      "$mysql_conf{'db_name'} 2>&1 ".
+                      "1>$backup_conf{'directory'}/$backup_conf{'filename'}";
+        verbose($verbose_level_debug,
+                "\nExecuting command:", $command);
+        my $result = `$command`;
+        my $exit = $? >> 8;
+        verbose($verbose_level_debug,
+                "\n$mysqldump exited with status:  $exit");
+        verbose($verbose_level_debug,
+                "$mysqldump output:", $result) if ($exit);
+        return $exit;
+    }
+
+    sub compress_backup
+    {
+        if (!-e "$backup_conf{'directory'}/$backup_conf{'filename'}")
+        {
+            verbose($verbose_level_debug,
+                    "\nUnable to find backup file to compress");
+            return 1;
+        }
+        my $result = 0;
+        verbose($verbose_level_debug,
+                "\nAttempting to compress backup file.");
+        if ($d_compress eq $compress)
+        {
+        # Try to load the IO::Compress::Gzip library if available (but don't
+        # require it)
+            BEGIN
+            {
+                our $has_compress_gzip = 1;
+                # Though this does nothing, it prevents an invalid "only used
+                # once" warning that occurs for users without IO::Compress
+                # installed.
+                undef $GzipError;
+                eval 'use IO::Compress::Gzip qw(gzip $GzipError);';
+                if ($@)
+                {
+                    $has_compress_gzip = 0;
+                }
+            }
+            if (!$has_compress_gzip)
+            {
+                verbose($verbose_level_debug,
+                        " - IO::Compress::Gzip is not installed.");
+            }
+            else
+            {
+                if (-e "$backup_conf{'directory'}/$backup_conf{'filename'}.gz")
+                {
+                    verbose($verbose_level_debug,
+                            "\nA file whose name is the backup filename with".
+                            " the '.gz' extension already",
+                            "exists. Leaving backup uncompressed.");
+                    return 1;
+                }
+                verbose($verbose_level_debug,
+                        " - Compressing backup file with IO::Compress::Gzip.");
+                $result = gzip(
+                   "$backup_conf{'directory'}/$backup_conf{'filename'}" =>
+                   "$backup_conf{'directory'}/$backup_conf{'filename'}.gz");
+                if ((defined($result)) &&
+                    (-e "$backup_conf{'directory'}/".
+                        "$backup_conf{'filename'}.gz"))
+                {
+                    unlink "$backup_conf{'directory'}/".
+                           "$backup_conf{'filename'}";
+                    $backup_conf{'filename'} = "$backup_conf{'filename'}.gz";
+                    verbose($verbose_level_debug,
+                            "\nSuccessfully compressed backup to file:",
+                            "$backup_conf{'directory'}/".
+                            "$backup_conf{'filename'}");
+                    return 0;
+                }
+                verbose($verbose_level_debug,
+                        "   Error:  $GzipError");
+            }
+        }
+    # Try to compress the file with the compress binary.
+        verbose($verbose_level_debug,
+                " - Compressing backup file with $compress.");
+        my $backup_path = "$backup_conf{'directory'}/$backup_conf{'filename'}";
+        my $output = `$compress '$backup_path' 2>&1`;
+        my $exit = $? >> 8;
+        verbose($verbose_level_debug,
+                "\n$compress exited with status:  $exit");
+        if ($exit)
+        {
+            verbose($verbose_level_debug,
+                    "$compress output:", $output);
+        }
+        else
+        {
+            $backup_conf{'filename'} = "$backup_conf{'filename'}.gz";
+        }
+        return $exit;
+    }
+
+    sub rotate_backups
+    {
+        if (($rotate < 1) || (!defined($rotateglob)) || (!$rotateglob))
+        {
+            verbose($verbose_level_debug,
+                    "\nBackup file rotation disabled.");
+            return 0;
+        }
+        verbose($verbose_level_debug,
+                "\nRotating backups.");
+        verbose($verbose_level_debug,
+                "\nSearching for files matching pattern:",
+                "$backup_conf{'directory'}/$rotateglob");
+        my @files = <$backup_conf{'directory'}/$rotateglob>;
+        my @sorted_files = sort { lc($a) cmp lc($b) } @files;
+        my $num_files = @sorted_files;
+        verbose($verbose_level_debug,
+                " - Found $num_files matching files.");
+        $num_files = $num_files - $rotate;
+        $num_files = 0 if ($num_files < 0);
+        verbose($verbose_level_debug,
+                "\nDeleting $num_files and keeping (up to) $rotate backup".
+                " files.");
+        my $index = 0;
+        foreach my $file (@sorted_files)
+        {
+            if ($index++ < $num_files)
+            {
+                if ($file eq
+                    "$backup_conf{'directory'}/$backup_conf{'filename'}")
+                {
+                # This is the just-created backup. Warn the user that older
+                # backups with newer schema versions may cause rotation to
+                # fail.
+                    verbose($verbose_level_debug,
+                            "\nWARNING:  You seem to have reverted to an".
+                            " older database schema version.",
+                            "You should move all backups from newer schema".
+                            " versions to another directory or",
+                            "delete them to prevent your new backups from".
+                            " being deleted on rotation.\n");
+                    verbose($verbose_level_debug,
+                            " - Keeping backup file:  $file");
+
+                }
+                else
+                {
+                    verbose($verbose_level_debug,
+                            " - Deleting old backup file:  $file");
+                    unlink "$file";
+                }
+            }
+            else
+            {
+                verbose($verbose_level_debug,
+                        " - Keeping backup file:  $file");
+            }
+        }
+        return 1;
+    }
+
+##############################################################################
+# Main functionality
+##############################################################################
+
+# The first argument after option parsing, if it exists, should be a database
+# information file.
+    $database_information_file = shift;
+
+    configure_environment;
+    read_config;
+    check_config;
+
+    print_configuration;
+
+    my $status = 1;
+    if ($backup_xmltvids)
+    {
+        $status = do_xmltvid_backup;
+    }
+    else
+    {
+        $status = do_backup;
+        if (!$status)
+        {
+            compress_backup;
+            rotate_backups;
+        }
+    }
+
+    $dbh->disconnect if (defined($dbh));
+
+    exit $status;
+

programs/scripts/scripts.pro

@@ +1 @@
+include ( ../../config.mak )
+include ( ../../settings.pro )
+
+QMAKE_STRIP = echo
+
+TEMPLATE = app
+CONFIG -= moc qt
+
+installscripts.path = $${PREFIX}/share/mythtv
+installscripts.files = database/*
+
+INSTALLS += installscripts
+
+SOURCES += dummy.c

programs/scripts/dummy.c

@@ +1 @@
+int main(void)
+{
+    return 0;
+}