#
# $Date: 2010-08-16 22:09:22 -0700 (Mon, 16 Aug 2010) $
# $Revision: 25708 $
# $Author: beirdo $
#
#  cli.pm
#
#   routines for dealing with the commandline arguments
#

package nuv_export::cli;

    use English;
    use Getopt::Long qw(:config pass_through);

# Load the myth and nuv utilities, and make sure we're connected to the database
    use nuv_export::shared_utils;

    BEGIN {
        use Exporter;
        our @ISA = qw/ Exporter /;

        our @EXPORT = qw/ &add_arg      &load_cli_args
                          &arg          &rc_arg
                          $export_prog  $is_cli
                          $DEBUG
                        /;
    }


# Debug mode?
    our $DEBUG;

# Look for certain commandline options to determine if this is cli-mode
    our $is_cli = 0;

# Only need to keep track of cli args here
    my %cli_args;
    my %args;

# Load some options early, before anything else:
# --ffmpeg, --mencoder and --config
    our $export_prog = undef;
    our $config_file = undef;
    GetOptions('ffmpeg'     => sub { $export_prog = 'ffmpeg';    },
               'mencoder'   => sub { $export_prog = 'mencoder';  },
               'config|c=s' => \$config_file,
               'profile=s'  => \$args{'profile'},
              );

# Make sure the specified config file exists
    if ($config_file && !-e $config_file) {
        die "configuration file $config_file does not exist!\n\n";
    }

# Load the nuvexportrc file
    my %rc_args;
    foreach my $file ($config_file, 'nuvexportrc', "$ENV{'HOME'}/.nuvexportrc", "/etc/nuvexportrc") {
    # No file
        next unless ($file && -e $file);
    # Slurp
        local $/ = undef;
    # Read the file
        my $data = '';
        open(DATA, $file) or die "Couldn't read $file:  $!\n\n";
        $data .= $_ while (<DATA>);
        close DATA;
    # Clean out any comments
        $data =~ s/\s*#[^\n]*?\s*\n/\n/sg;
        $data =~ s/\n\s*\n/\n/sg;
    # Nothing there
        next unless ($data);
    # Parse the contents
        while ($data =~ /<\s*([^>]+)\s*>(.+?)<\s*\/\s*\1\s*>/sg) {
            my $section = lc($1);
            my $args    = $2;
        # Handle legacy corrections
            if ($section eq 'ffmpeg::ipod') {
                die "Please be aware that the ffmpeg::ipod section of $file should now be called ffmpeg:mp4\n";
            }
        # Extract the variables
            while ($args =~ /^\s*(\S+?)\s*=\s*(.+?)\s*$/mg) {
                my $var = lc($1);
                my $val = $2;
            # Boolean arg?
                if ($val =~ /^([yt1]|yes|true)$/i) {
                    $rc_args{$section}{$var} = 1;
                }
                elsif ($val =~ /^([nf0]|no|false)$/i) {
                    $rc_args{$section}{$var} = 0;
                }
                else {
                    $rc_args{$section}{$var} = $val;
                }
            }
        }
    # Time to leave
        last;
    }

# Unknown profile?
    if ($args{'profile'} && ! defined $rc_args{'profile::'.$args{'profile'}}) {
        print STDERR "Unknown profile:  $args{'profile'}\n";
        exit 1;
    }

# Make sure the export_prog exists
    if (!$export_prog) {
        if ($args{'profile'} && $rc_args{'profile::'.$args{'profile'}}{'export_prog'}) {
            $export_prog = lc($rc_args{'profile::'.$args{'profile'}}{'export_prog'});
        }
        else {
            $export_prog = lc($rc_args{'nuvexport'}{'export_prog'});
        }
        if ($export_prog) {
            if ($export_prog !~ /(?:ffmpeg|mencoder)$/) {
                print "Unknown export_prog in nuvexportrc:  $export_prog\n\n";
                exit;
            }
        }
        else {
            $export_prog = find_program('ffmpeg')
                            ? 'ffmpeg'
                            : 'mencoder';
        }
    }

# Load the following extra parameters from the commandline
    add_arg('search-only',                 'Search only, do not do anything with the found recordings');
    add_arg('confirm!',                    'Confirm commandline-entered choices');

    add_arg('title=s',                     'Find programs to convert based on their title.');
    add_arg('subtitle|episode=s',          'Find programs to convert based on their subtitle (episode name).');
    add_arg('description=s',               'Find programs to convert based on their description.');
    add_arg('infile|input|i=s',            'Input filename');
    add_arg('chanid|channel=i',            'Find programs to convert based on their chanid');
    add_arg('starttime|start_time=i',      'Find programs to convert based on their starttime.');

    add_arg('require_cutlist',             'Only show programs that have a cutlist?');
    add_arg('force_aspect|force-aspect=s', 'Force input aspect ratio rather than detect it.');

    add_arg('mode|export=s',               'Specify which export mode to use');

    add_arg('noserver|no-server',          "Don't talk to the server -- do all encodes here in this execution");

    add_arg('nice=i',                      'Set the value of "nice" for subprocesses');
    add_arg('version',                     'Show the version and exit');

    add_arg('profile=s',                   'nuvexportrc profile to load');

    add_arg('save_info',                   'Save text file with program details.');
    add_arg('only_save_info',              'ONLY save program details; do not encode.');

    add_arg('noprogress',                  "Don't show export progress status messages.");

# Load the commandline options
    add_arg('help:s',                      'Show nuvexport help');
    add_arg('debug',                       'Enable debug mode');

# Load the commandline arguments
    sub load_cli_args {
    # Build an array of the requested commandline arguments
        my @args;
        foreach my $key (keys %cli_args) {
            push @args, $cli_args{$key}[0];
        }
    # Connect $DEBUG
        $args{'debug'} = \$DEBUG;
    # Get the options
        GetOptions(\%args, @args)
            or die "Invalid commandline parameter(s).\n";
    # Make sure $NICE is defined
        $args{'nice'} = arg('nice', 19);
        if (int($args{'nice'}) != $args{'nice'} || $args{'nice'} > 19 || $args{'nice'} < -20) {
            die "--nice must be between -20 (highest priority) and 19 (lowest)\n";
        }
        $NICE .= ' -n'.int($args{'nice'});
    # Is this a commandline-only request?
        if (!arg('confirm') && (arg('title') || arg('subtitle') || arg('description') || arg('infile') || arg('starttime') || arg('chanid'))) {
            $is_cli = 1;
        }
    # No server stuff enabled yet, default to off
        $args{'noserver'} = 1;
    }

# Add an argument to check for on the commandline
    sub add_arg {
        my ($arg, $description) = @_;
        my ($name) = $arg =~ /^([^!=:\|]+)/;
        $cli_args{$name} = [$arg, $description];
    }

# Retrieve the value of a commandline argument
    sub arg {
        my $arg     = lc(shift);
        my $default = shift;
        my $package = lc(shift or (caller())[0]);
    # Commandline preference/override
        return $args{$arg} if (defined($args{$arg}));
    # Profile settings are next in priority
        if ($args{'profile'} && defined $rc_args{'profile::'.$args{'profile'}}{$arg}) {
            return $rc_args{'profile::'.$args{'profile'}}{$arg};
        }
    # Load rc preference
        my $rc_arg = rc_arg($arg, $package);
    # Return the rc preference, or the passed-in default value
        return defined($rc_arg)
                ? $rc_arg
                : $default;
    }

# Retrieve the value of a nuvexportrc argument
    sub rc_arg {
        my $arg     = lc(shift);
        my $package = lc(shift or (caller())[0]);
    # Remove an unused package parent name, and any leftovers from $self
        $package =~ s/^export:://;
        $package =~ s/=.+?$//;
    # Scan the package from parent to child, looking for matches
        my $path = $package;
        while ($path) {
            if (defined $rc_args{$path}{$arg}) {
                #print "$arg used from $path:  $rc_args{$path}{$arg}\n";
                return $rc_args{$path}{$arg};
            }
            last unless ($path =~ s/^.+?:://);
        }
    # Scan the package from child to parent, looking for matches
        $path = $package;
        while ($path) {
            if (defined $rc_args{$path}{$arg}) {
                #print "$arg used from $path:  $rc_args{$path}{$arg}\n";
                return $rc_args{$path}{$arg};
            }
            last unless ($path =~ s/::.+?$//);
        }
    # Finally, try "generic"
        if (defined $rc_args{'generic'}{$arg}) {
            #print "$arg used from generic:  $rc_args{'generic'}{$arg}\n";
            return $rc_args{'generic'}{$arg};
        }
    # Lastly, try "nuvexport" (or just return undef)
        return $rc_args{'nuvexport'}{$arg};
    }

1;  #return true

# vim:ts=4:sw=4:ai:et:si:sts=4
