| 1 | ##-*- Mode: CPerl -*- | ||
| 2 | |||
| 3 | ## File: DTA::CAB::Server::HTTP::Handler::QueryList.pm | ||
| 4 | ## Author: Bryan Jurish <moocow@cpan.org> | ||
| 5 | ## Description: | ||
| 6 | ## + CAB HTTP Server: request handler: analyzer list (rsp. query handler) | ||
| 7 | ##====================================================================== | ||
| 8 | |||
| 9 | package DTA::CAB::Server::HTTP::Handler::QueryList; | ||
| 10 | use DTA::CAB::Server::HTTP::Handler::Query; | ||
| 11 | use HTTP::Status; | ||
| 12 | use URI::Escape qw(uri_escape uri_escape_utf8); | ||
| 13 | use CGI ':standard'; | ||
| 14 | use Carp; | ||
| 15 | use strict; | ||
| 16 | |||
| 17 | ##-------------------------------------------------------------- | ||
| 18 | ## Globals | ||
| 19 | |||
| 20 | our @ISA = qw(DTA::CAB::Server::HTTP::Handler::CGI); | ||
| 21 | |||
| 22 | ##-------------------------------------------------------------- | ||
| 23 | ## Aliases | ||
| 24 | BEGIN { | ||
| 25 | DTA::CAB::Server::HTTP::Handler->registerAlias( | ||
| 26 | 'QueryList' => __PACKAGE__, | ||
| 27 | 'querylist' => __PACKAGE__, | ||
| 28 | ); | ||
| 29 | } | ||
| 30 | |||
| 31 | ##-------------------------------------------------------------- | ||
| 32 | ## Methods: API | ||
| 33 | |||
| 34 | ## $h = $class_or_obj->new(%options) | ||
| 35 | ## %$h, %options: | ||
| 36 | ## ( | ||
| 37 | ## ##-- INHERITED from Handler::CGI | ||
| 38 | ## #encoding => $defaultEncoding, ##-- default encoding (UTF-8) | ||
| 39 | ## allowGet => $bool, ##-- allow GET requests? (default=1) | ||
| 40 | ## allowPost => $bool, ##-- allow POST requests? (default=1) | ||
| 41 | ## allowList => $bool, ##-- if true, allowed analyzers will be listed for 'PATHROOT/.../list' paths | ||
| 42 | ## pushMode => $mode, ##-- push mode for addVars (default='keep') | ||
| 43 | ## ## | ||
| 44 | ## ##-- NEW in Handler::QueryList | ||
| 45 | ## qh => $queryHandler, ##-- underlying query handler | ||
| 46 | ## ) | ||
| 47 | sub new { | ||
| 48 | my $that = shift; | ||
| 49 | my $h = $that->SUPER::new( | ||
| 50 | qh => undef, | ||
| 51 | #encoding=>'UTF-8', ##-- default CGI parameter encoding | ||
| 52 | allowGet=>1, | ||
| 53 | allowPost=>1, | ||
| 54 | @_, | ||
| 55 | ); | ||
| 56 | return $h; | ||
| 57 | } | ||
| 58 | |||
| 59 | ## $bool = $h->prepare($server) | ||
| 60 | ## + checks that $h->{qh} is defined | ||
| 61 | sub prepare { | ||
| 62 | my ($h,$srv) = @_; | ||
| 63 | $h->logconfess("no query handler 'qh' defined!") if (!$h->{qh}); | ||
| 64 | return 1; | ||
| 65 | } | ||
| 66 | |||
| 67 | ## $bool = $path->run($server, $localPath, $clientSocket, $httpRequest) | ||
| 68 | ## + process $httpRequest as CGI form-encoded analyzer list query | ||
| 69 | ## + form parameters: | ||
| 70 | ## ( | ||
| 71 | ## a => $analyzerRegex, ##-- analyzer key in %{$qh->{allowAnalyzers}}, %{$srv->{as}} | ||
| 72 | ## fmt => $queryFormat, ##-- query/response format (default=$h->{defaultFormat}) | ||
| 73 | ## #enc => $queryEncoding, ##-- query encoding (default='UTF-8') | ||
| 74 | ## raw => $bool, ##-- if true, data will be returned as text/plain (default=$h->{returnRaw}) | ||
| 75 | ## pretty => $level, ##-- response format level | ||
| 76 | ## ) | ||
| 77 | our %localParams = map {($_=>undef)} qw(q fmt raw pretty); | ||
| 78 | sub run { | ||
| 79 | my ($h,$srv,$path,$c,$hreq) = @_; | ||
| 80 | |||
| 81 | ##-- check for HEAD | ||
| 82 | return $h->headResponse() if ($hreq->method eq 'HEAD'); | ||
| 83 | |||
| 84 | ##-- parse list query parameters | ||
| 85 | my $vars = $h->cgiParams($c,$hreq) or return undef; | ||
| 86 | $h->vlog($h->{logVars}, "got query params:\n", Data::Dumper->Dump([$vars],['vars'])); | ||
| 87 | |||
| 88 | #my $enc = $h->getEncoding(@$vars{qw(enc encoding)},$hreq,$h->{encoding}); | ||
| 89 | #return $h->cerror($c, undef, "unknown encoding '$enc'") if (!defined(Encode::find_encoding($enc))); | ||
| 90 | |||
| 91 | $h->decodeVars($vars, vars=>[qw(a fmt format)], allowHtmlEscapes=>0); | ||
| 92 | $h->trimVars($vars, vars=>[qw(a fmt format)]); | ||
| 93 | |||
| 94 | ##-- get matching analyzers | ||
| 95 | my $qh = $h->{qh}; | ||
| 96 | my $qre = defined($vars->{a}) ? qr/$vars->{a}/ : qr//; | ||
| 97 | my @as = (grep {$_ =~ $qre} | ||
| 98 | grep {!defined($qh->{allowAnalyzers}) || $qh->{allowAnalyzers}{$_}} | ||
| 99 | sort | ||
| 100 | #map {($_,defined($h->{prefix}) ? "$h->{prefix}$_" : qw())} | ||
| 101 | keys %{$srv->{as}}); | ||
| 102 | |||
| 103 | ##-- get format | ||
| 104 | my $fc = $vars->{format} || $vars->{fmt} || $qh->{defaultFormat}; | ||
| 105 | my $fmt = $qh->{formats}->newFormat($fc,level=>$vars->{pretty}) | ||
| 106 | or return $h->cerror($c, undef, "unknown format '$fc': $@"); | ||
| 107 | |||
| 108 | ##-- dump analyzers | ||
| 109 | $fmt->{raw} = 1; ##-- hack to allow format dump of raw (non-document) data | ||
| 110 | my ($ostr); | ||
| 111 | if ($fmt->isa('DTA::CAB::Format::TT')) { | ||
| 112 | $ostr = join("\n", @as,''); | ||
| 113 | } | ||
| 114 | elsif ($fmt->isa('DTA::CAB::Format::XmlNative')) { | ||
| 115 | $fmt->{arrayEltKeys}{tokens} = 'a'; | ||
| 116 | $fmt->{key2xml}{text} = 'name'; | ||
| 117 | $fmt->toString(\$ostr)->putDocument({tokens=>[map {{text=>$_}} @as]}); | ||
| 118 | my $odoc = $fmt->xmlDocument; | ||
| 119 | $odoc->documentElement->setNodeName('analyzers'); | ||
| 120 | $ostr = $odoc->toString($fmt->{level}); | ||
| 121 | } | ||
| 122 | else { | ||
| 123 | $fmt->toString(\$ostr)->putData(\@as)->flush; | ||
| 124 | } | ||
| 125 | utf8::encode($ostr) if (utf8::is_utf8($ostr)); | ||
| 126 | |||
| 127 | ##-- dump response | ||
| 128 | return $h->dumpResponse(\$ostr, | ||
| 129 | raw=>$vars->{raw}, | ||
| 130 | type=>$fmt->mimeType, | ||
| 131 | charset=>'UTF-8', | ||
| 132 | filename=>("analyzers".$fmt->defaultExtension), | ||
| 133 | ); | ||
| 134 | } | ||
| 135 | |||
| 136 | |||
| 137 | ##-------------------------------------------------------------- | ||
| 138 | ## Methods: Local | ||
| 139 | |||
| 140 | 1; ##-- be happy | ||
| 141 | |||
| 142 | __END__ |