root/util/gconf-builder @ 58

#!/usr/bin/perl -w

my $version = '0.1';

use strict;

use Data::Dumper;
use XMLTV::Ask;

my $config;
my $s;

print "GConf Builder for Shepherd\n\n";

my $grabber = lc(ask("Name of grabber? "));

die "I don't think so.\n" if ($grabber eq 'shepherd');

print   "\nCATEGORY: Grabber Type\n\n" .
        "Grabbers generally fall into two categories:\n" .
        "(1) Grabbers that fetch detailed data by downloading one page\n" .
        "    per show\n" .
        "(2) Grabbers that either cannot fetch detailed data, or fetch\n" .
        "    it for many shows with each download (e.g. one download\n" .
        "    per day, or one download for all shows)\n" .
        "Category 1 grabbers tend to be slow and use relatively large\n" .
        "amounts of bandwidth. Category 2 grabbers are quite fast\n" .
        "and download relatively few files.\n\n";
$config->{category} = ask("Which category is $grabber?");

print   "\nCATEGORY: Channels Supported\n\n" .
        "Enter the names of channels supported by $grabber. If $grabber\n" .
        "supports all free-to-air channels, just hit Enter. If it supports\n" .
        "a limited number of channels, enter these separated by spaces\n" .
        "(e.g. \"ABC ABC2\"). If it supports most channels with a\n" .
        "limited number of exceptions, enter a minus sign then a list\n" .
        "of the exceptions, separated by spaces (e.g. \"-ABC Nine\").\n" .
        "Please use standard channel names (e.g. Nine, TEN, Seven, etc).\n\n";

$config->{channels} = ask("Channels supported? ");

print   "\nCATEGORY: Days Supported\n\n" .
        "Enter how many days of data $grabber can retrieve. The current\n" .
        "day is considered to be day 1.\n\n";

$config->{max_days} = ask("Days supported? [default=7]");
$config->{max_days} ||= 7;

print   "\nSome grabbers aren't always able to retrieve the maximum number\n" .
        "of days, because sometimes the datasource isn't topped up. Enter\n" .
        "the minimum number of days of data that $grabber can reliably fetch,\n" .
        "where today is day 1.\n\n";

$config->{min_days} = ask("Minimum days supported? [default=7]");
$config->{min_days} ||= 7;

print   "\nCATEGORY: Configuration Requirements\n\n" .
        "Specify whether $grabber requires any manual configuration\n" .
        "before it can run (such as registration on a remote web site).\n\n";

$config->{config_reqd} = ask_boolean("Requires manual configuration? ");

if ($config->{config_reqd})
{
    print   "\nShepherd needs a way of detecting whether $grabber has been\n" .
            "correctly configured or not. Please enter a command-line option\n" .
            "that will cause $grabber to exit with status 0 if it is configured\n" .
            "correctly, and exit with another status if it is not.\n\n";
    $config->{option_ready} = ask("Command-line option for readiness? [default=--ready]");
    $config->{option_ready} ||= '--ready';
}
else
{
    print   "\nShepherd needs a way to run $grabber just to check that it compiles\n" .
            "on the user's system. Please enter a command-line option that will cause\n" .
            "$grabber to exit with status 0 as quickly as possible, i.e. preferably\n" .
            "without fetching any data.\n\n";
    $config->{option_ready} = ask("Command-line option for compilation check? " .
            "[default=--version]");
    $config->{option_read} ||= '--version';
}

print   "\nCATEGORY: Niceness\n\n" .
        "NOTE: This metric will probably change, so don't sweat it for now.\n".
        "Rate the niceness of $grabber. Niceness is a general score out\n" .
        "of 10 for how quickly, efficiently, and, well, nicely, the\n" .
        "grabber can retrieve data.\n\n";

$config->{niceness} = ask("Niceness? [default=5]");
$config->{niceness} ||= 5;

my $g = '';

print   "\nCATEGORY: Granularity\n\n" .
        "Specify whether $grabber is able to fetch data in slices,\n" .
        "as opposed to having to fetch all or nothing.\n\n";

$s = ask_boolean("Can $grabber fetch a single day of data only? ");

if ($s)
{
    $g .= 'd';
    print   "\nWhat option needs to be sent to $grabber to specify the\n" .
            "number of days wanted? (E.g. if $grabber supports an option\n" .
            "\"--days n\", where n is the number of days to fetch data for,\n".
            "enter \"--days\").\n\n";
    $config->{option_days} = ask("Command-line option for max days? " .
            "[default=--days]");
    $config->{option_days} ||= '--days';

    print   "\nWhat option needs to be sent to $grabber to specify the\n" .
            "day to begin fetching data for? (E.g. if $grabber\n" .
            "supports an option \"--offset n\", where n is the first\n" .
            "day to start grabbing data for, enter \"--offset\".)\n\n";
    $config->{option_days_offset} = ask("Command-line option for offset? " .
            "[default=--offset]");
    $config->{option_days_offset} ||= '--offset';

    print   "\nAssuming today is day 1 and tomorrow is day 2, which day(s)\n" .
            "will $grabber retrieve data for if invoked with the following\n" .
            "command:\n" .
            "  ./$grabber $config->{option_days} 2 $config->{option_days_offset} 1\n" .
            "Enter a range, such as \"2-4\" or \"2-2\".\n\n";
    $s = ask("Days fetched with the above option? " .
            "[default=2-2]");
    $s ||= '2-2';
    if ($s =~ /(\d)-(\d)/)
    {
        $config->{option_days_adjust} = 2- $2;
        $config->{option_days_offset_adjust} = 2- $1;
    }

}

print "\n";

$s = ask_boolean("Can $grabber fetch a single channel of data only? ");

if ($s)
{
    $g .= 'c';
    print   "\nWhat option needs to be sent to $grabber to specify\n" .
            "the channels wanted? For example, if $grabber can be\n" .
            "instructed to fetch data for channels Seven and Nine by\n" .
            "the option \"--channels Seven,Nine\", enter \"--channels\".\n\n";
    
    $config->{option_channels} = ask("Command-line option for channels? " .
            "[default=--channels]");
    $config->{option_channels} ||= '--channels';
}

$config->{granularity} = $g;

print   "\nCATEGORY: Caching\n\n" .
        "Some grabbers use an internal cache, to avoid re-fetching data.\n\n";

$config->{cache} = ask_boolean("Does $grabber use an internal cache?");

if ($config->{cache})
{

    print   "\nSome grabbers are able to run in \"cheap\" mode, which\n" .
            "means they verify and return their internal cache without\n" .
            "fetching many web pages or taking too long to run.\n\n";
    $config->{cheap_mode} = ask_boolean("Does $grabber have a \"cheap\" mode?");
    if ($config->{cheap_mode})
    {
        $config->{option_cheap} = ask("\nWhat option enables this \"cheap\" " .
                "mode? [default=--cheap]");
        $config->{option_cheap} ||= '--cheap';
    }

    # Possibly ask a question about cache verification
}

print   "\nCATEGORY: Description\n\n" .
        "Please enter a brief description of $grabber.\n\n";

$config->{desc} = ask("Description?");

print   "\nCONFIGURATION COMPLETE\n\n" .
        "Grabber: $grabber\n" .
        Dumper($config);
        
abort() unless (ask_boolean("\nDo you want to go ahead and create $grabber.conf?"));

if (-e "$grabber.conf")
{
    print "WARNING: $grabber.conf already exists!\n";
    abort() unless (ask_boolean("Do you want to overwrite $grabber.conf?"));
}

print "Creating $grabber.conf.\n";
open(CONF, ">$grabber.conf") or die "cannot write to $grabber.conf: $!";
print CONF Data::Dumper->Dump([$config], ['config']);
close CONF;

print "Done.\n";

sub abort
{
    print "Aborting.\n";
    exit;
}