| 1 |
#
|
| 2 |
# Query.pm
|
| 3 |
#
|
| 4 |
# Originally Written by Christopher Williams
|
| 5 |
#
|
| 6 |
# Description
|
| 7 |
# -----------
|
| 8 |
# Hold information request data
|
| 9 |
#
|
| 10 |
# Interface
|
| 11 |
# ---------
|
| 12 |
# new() : A new Query object
|
| 13 |
# querylist() : return ordered list of query names
|
| 14 |
# title() : return/set the title text
|
| 15 |
# intro() : return/set the intro text
|
| 16 |
# querytype(name) : return/set the input type of the named query
|
| 17 |
# querymessage(name) : return/set the message text associated with the named
|
| 18 |
# query
|
| 19 |
# queryprompt(name) : return/set the prompt string for the query
|
| 20 |
# queryoptions(name) : return/set the query option list for the named query
|
| 21 |
# querycheck(name) : return/set the query checker object
|
| 22 |
# currentvalue(name) : return the current value of the query list exapnded
|
| 23 |
# in the context of the other query values - affected
|
| 24 |
# by lodgevalue.
|
| 25 |
# getparam(name) : return the absolute value of the param (non expanded) - not
|
| 26 |
# affected by lodgevalue until OK called.
|
| 27 |
# setparam(name,value) : set the value of a given query to list
|
| 28 |
# setifundef(name,value) : set the value of a given query to list
|
| 29 |
# expand(string) : expand given string
|
| 30 |
# lodgevalue(name,val) : set a value of a given query variable to the list
|
| 31 |
# current value will be expanded in terms of these
|
| 32 |
# return (pass/fail,messageobject,new_vals_in_options)
|
| 33 |
# OK() : set all query values to the values of the lodged
|
| 34 |
# variables
|
| 35 |
# cancel() : clear the values of any lodged variables
|
| 36 |
# setparam(name,value) : hard set
|
| 37 |
# params : return list of all parameters
|
| 38 |
# runchecker(name,value) : run a query checker to analyse a value, any
|
| 39 |
# return values are added to the option list
|
| 40 |
|
| 41 |
package ActiveDoc::Query;
|
| 42 |
require 5.004;
|
| 43 |
|
| 44 |
sub new {
|
| 45 |
my $class=shift;
|
| 46 |
$self={};
|
| 47 |
bless $self, $class;
|
| 48 |
return $self;
|
| 49 |
}
|
| 50 |
|
| 51 |
sub title {
|
| 52 |
my $self=shift;
|
| 53 |
@_?$self->{title}=shift
|
| 54 |
:((defined $self->{title})?$self->{title}:"");
|
| 55 |
}
|
| 56 |
|
| 57 |
sub intro {
|
| 58 |
my $self=shift;
|
| 59 |
@_?$self->{intro}=shift
|
| 60 |
:((defined $self->{intro})?$self->{intro}:"");
|
| 61 |
}
|
| 62 |
|
| 63 |
sub querytype {
|
| 64 |
my $self=shift;
|
| 65 |
my $name=shift;
|
| 66 |
my $rv;
|
| 67 |
|
| 68 |
if ( @_) {
|
| 69 |
$rv=shift;
|
| 70 |
if ( ! exists $self->{querytype}{$name} ) {
|
| 71 |
# store the order in which definitions are made
|
| 72 |
push @{$self->{queryorder}}, $name;
|
| 73 |
}
|
| 74 |
$self->{querytype}{$name}=$rv;
|
| 75 |
}
|
| 76 |
else {
|
| 77 |
$rv=$self->{querytype}{$name};
|
| 78 |
}
|
| 79 |
return $rv;
|
| 80 |
|
| 81 |
}
|
| 82 |
|
| 83 |
sub querycheck {
|
| 84 |
my $self=shift;
|
| 85 |
my $name=shift;
|
| 86 |
|
| 87 |
@_?$self->{querycheck}{$name}=shift
|
| 88 |
:$self->{querycheck}{$name};
|
| 89 |
}
|
| 90 |
|
| 91 |
sub querymessage {
|
| 92 |
my $self=shift;
|
| 93 |
my $name=shift;
|
| 94 |
|
| 95 |
if ( @_ ) {
|
| 96 |
$self->{querymessage}{$name}=shift;
|
| 97 |
}
|
| 98 |
return $self->expand($self->{querymessage}{$name});
|
| 99 |
}
|
| 100 |
|
| 101 |
sub queryprompt {
|
| 102 |
my $self=shift;
|
| 103 |
my $name=shift;
|
| 104 |
|
| 105 |
my $rv=undef;
|
| 106 |
if ( @_ ) {
|
| 107 |
$self->{queryprompt}{$name}=shift;
|
| 108 |
} elsif ( ! defined $self->{queryprompt}{$name} ) {
|
| 109 |
$self->{queryprompt}{$name}="";
|
| 110 |
}
|
| 111 |
$rv=$self->expand($self->{queryprompt}{$name});
|
| 112 |
return $rv;
|
| 113 |
}
|
| 114 |
|
| 115 |
sub queryoptions {
|
| 116 |
my $self=shift;
|
| 117 |
my $name=shift;
|
| 118 |
my @out=();
|
| 119 |
|
| 120 |
if ( @_ ) {
|
| 121 |
push @{$self->{queryoptions}{$name}},@_;
|
| 122 |
}
|
| 123 |
foreach $option ( @{$self->{queryoptions}{$name}} ) {
|
| 124 |
push @out, $self->expand($option);
|
| 125 |
}
|
| 126 |
|
| 127 |
return @out;
|
| 128 |
}
|
| 129 |
|
| 130 |
sub expand {
|
| 131 |
my $self=shift;
|
| 132 |
my $string=shift;
|
| 133 |
|
| 134 |
return "" , if ( ! defined $string );
|
| 135 |
$string=~s{
|
| 136 |
\$\((\w+)\)
|
| 137 |
}{
|
| 138 |
if (defined $self->{lodgehash}{$1}) {
|
| 139 |
$self->expand($self->{lodgehash}{$1});
|
| 140 |
} else {
|
| 141 |
"\$$1";
|
| 142 |
}
|
| 143 |
}egx;
|
| 144 |
$string=~s{
|
| 145 |
\$(\w+)
|
| 146 |
}{
|
| 147 |
if (defined $self->{lodgehash}{$1}) {
|
| 148 |
$self->expand($self->{lodgehash}{$1});
|
| 149 |
} else {
|
| 150 |
"\$$1";
|
| 151 |
}
|
| 152 |
}egx;
|
| 153 |
return $string;
|
| 154 |
}
|
| 155 |
|
| 156 |
sub currentvalue {
|
| 157 |
my $self=shift;
|
| 158 |
my $name=shift;
|
| 159 |
|
| 160 |
$self->expand(
|
| 161 |
((defined $self->{lodgehash}{$name})?$self->{lodgehash}{$name}:""));
|
| 162 |
}
|
| 163 |
|
| 164 |
sub getparam {
|
| 165 |
my $self=shift;
|
| 166 |
my $name=shift;
|
| 167 |
return $self->{params}{$name};
|
| 168 |
}
|
| 169 |
|
| 170 |
sub lodgevalue {
|
| 171 |
my $self=shift;
|
| 172 |
my $name=shift;
|
| 173 |
my $value=shift;
|
| 174 |
|
| 175 |
# pass this parameter to the checker
|
| 176 |
my ($ret,$message,@vals)=$self->runchecker($name,$value);
|
| 177 |
# only lodge the value if its valid
|
| 178 |
if ( $ret eq 0 ) {
|
| 179 |
$self->_lodgevalue($name,$value);
|
| 180 |
}
|
| 181 |
return ($ret,$message,@vals);
|
| 182 |
}
|
| 183 |
|
| 184 |
sub _lodgevalue {
|
| 185 |
my $self=shift;
|
| 186 |
my $name=shift;
|
| 187 |
my $value=shift;
|
| 188 |
|
| 189 |
$self->{lodgehash}{$name}=$value;
|
| 190 |
}
|
| 191 |
|
| 192 |
sub runchecker {
|
| 193 |
my $self=shift;
|
| 194 |
my $name=shift;
|
| 195 |
my $value=shift;
|
| 196 |
my $ret=0;
|
| 197 |
my $message;
|
| 198 |
my @vals=();
|
| 199 |
|
| 200 |
if (defined $self->querycheck($name)) {
|
| 201 |
($ret,$message,@vals)=$self->querycheck($name)->consider($value);
|
| 202 |
# add any analysis options to the option list
|
| 203 |
if ( $#vals >= 0 ) {
|
| 204 |
$self->queryoptions($name,@vals);
|
| 205 |
}
|
| 206 |
}
|
| 207 |
return ($ret,$message,@vals);
|
| 208 |
}
|
| 209 |
|
| 210 |
sub OK {
|
| 211 |
my $self=shift;
|
| 212 |
|
| 213 |
foreach $name ( $self->querylist() ) {
|
| 214 |
$self->setparam($name, $self->{lodgehash}{$name});
|
| 215 |
}
|
| 216 |
}
|
| 217 |
|
| 218 |
sub querylist {
|
| 219 |
my $self=shift;
|
| 220 |
return @{$self->{queryorder}};
|
| 221 |
}
|
| 222 |
|
| 223 |
sub cancel {
|
| 224 |
my $self=shift;
|
| 225 |
|
| 226 |
foreach $name ( keys %{$self->{lodgehash}} ) {
|
| 227 |
$self->{lodgehash}{$name}=$self->{params}{$name};
|
| 228 |
}
|
| 229 |
}
|
| 230 |
|
| 231 |
sub setifundef {
|
| 232 |
my $self=shift;
|
| 233 |
my $name=shift;
|
| 234 |
my $value=shift;
|
| 235 |
|
| 236 |
if ( ! defined $self->{params}{$name} ) {
|
| 237 |
$self->setparam($name,$value);
|
| 238 |
}
|
| 239 |
}
|
| 240 |
|
| 241 |
sub setparam {
|
| 242 |
my $self=shift;
|
| 243 |
my $name=shift;
|
| 244 |
my $value=shift;
|
| 245 |
|
| 246 |
$self->{params}{$name}=$value;
|
| 247 |
$self->_lodgevalue($name,$value);
|
| 248 |
}
|
| 249 |
|
| 250 |
sub params {
|
| 251 |
my $self=shift;
|
| 252 |
|
| 253 |
return ( keys %{$self->{params}} );
|
| 254 |
}
|
