File Coverage

lib/CGI/OptimalQuery.pm

Criterion	Covered	Total	%
statement	26	56	46.4
branch	0	10	0.0
condition	0	15	0.0
subroutine	8	13	61.5
pod	1	5	20.0
total	35	99	35.3

package CGI::OptimalQuery;

use strict;
use warnings;
no warnings qw( uninitialized redefine );
use CGI();
use CGI::OptimalQuery::SavedSearches();

BEGIN {
    use Exporter ();
    use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
    $VERSION     = '0.30';
    @ISA         = qw(Exporter);
    #Give a hoot don't pollute, do not export more than needed by default
    @EXPORT      = qw();
    @EXPORT_OK   = qw();
    %EXPORT_TAGS = ();
}


# module registry - when loading a sub module, the module CGI param is
# consulted, and the value is loaded as a module.
our $DEFAULT_MODULE = 'InteractiveQuery2';

our %DEFAULT_MODULES = (
  'SimpleQuery'       => 'CGI::OptimalQuery::SimpleQuery',
  'CustomOutput'      => 'CGI::OptimalQuery::CustomOutput',
  'PrinterFriendly'   => 'CGI::OptimalQuery::PrinterFriendly',
  'CSV'               => 'CGI::OptimalQuery::CSV',
  'InteractiveFilter' => 'CGI::OptimalQuery::InteractiveFilter',
  'InteractiveQuery'  => 'CGI::OptimalQuery::InteractiveQuery',
  'XML'               => 'CGI::OptimalQuery::XML',
  'JSON'              => 'CGI::OptimalQuery::JSON',
  'InteractiveQuery2' => 'CGI::OptimalQuery::InteractiveQuery2',
  'InteractiveFilter2' => 'CGI::OptimalQuery::InteractiveFilter2',
  'ShowColumns'        => 'CGI::OptimalQuery::ShowColumns',
  'InteractiveQuery2Tools' => 'CGI::OptimalQuery::InteractiveQuery2Tools'
);

sub default_output_handler {
  print STDOUT @_;
  return undef;
}
sub default_error_handler {
  print STDERR @_;
  return undef;
}


# Constructor
# my $recset = CGI::OptimalQuery->new(\%schema )
# This constructor instantiates the correct class based on the module param.
sub new {
  my $pack = shift;
  my $schema = $_[0];

  if ($CGI::OptimalQuery::q) {
    $$schema{q} = $CGI::OptimalQuery::q;
  } else {
    $$schema{q} ||= new CGI();
  }

  # if this is a mod_perl query object, turn it into a CGI object
  if (! $$schema{q}->isa('CGI')) {
    my @names = $$schema{q}->param();
    my %params;
    foreach my $p (@names) {
      my @v = $$schema{q}->param($p);
      $params{$p} = \@v;
    }
    $$schema{q} = new CGI(\%params);
  }

  # set default handlers
  $$schema{output_handler} ||= \&default_output_handler;
  $$schema{error_handler}  ||= \&default_error_handler;
  $$schema{httpHeader} ||= \&CGI::header;

  # find module & class
  my $module = $$schema{q}->param('module') || $$schema{module} || $DEFAULT_MODULE;
  my $class = $$schema{modules}{$module} || $DEFAULT_MODULES{$module};

  # dynamically load class
  my $rv = eval "require $class";
  if ($@ =~ /Not\ Found/) { die "Could not find class $class"; }
  elsif ($@) { die "Compile Error in class $class: $@"; }
  elsif ($rv != 1) { die "Initialization error in class $class, should return 1"; }

  # call appropriate constructor
  return $class->new(@_);
}

sub escape_js { CGI::OptimalQuery::Base::escape_js(@_); }


sub get_saved_search_list {
  my ($q, $dbh, $userid) = @_;
  return CGI::OptimalQuery::SavedSearches::get_html($q, $dbh, $userid);
}


1;
__END__