CAB/Server/HTTP/Handler/QueryFormats.pm untested

filter: Statementstmt 0.0% 0 / 70 Branchbran 0.0% 0 / 12 Conditioncond 0.0% 0 / 22 MC/DCmcdc 0.0% 0 / 12 Subroutinesub 0.0% 0 / 11 Podpod 0.0% 0 / 4 totaltotal 0.0% 0 / 131 CC 7 SCAR 28.1
CC
7
Cov
0%
run
42.0
prepare
6.0
BEGIN
2.0
CRAP 16.6
1 ##-*- Mode: CPerl -*-
2  
3 ## File: DTA::CAB::Server::HTTP::Handler::QueryFormats.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::QueryFormats;
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 XML::LibXML;
15 use Carp;
16 use strict;
17  
18 ##--------------------------------------------------------------
19 ## Globals
20  
21 our @ISA = qw(DTA::CAB::Server::HTTP::Handler::CGI);
22  
23 ##--------------------------------------------------------------
24 ## Aliases
25 BEGIN {
26 DTA::CAB::Server::HTTP::Handler->registerAlias(
27 'QueryFormats' => __PACKAGE__,
28 'queryformats' => __PACKAGE__,
29 );
30 }
31  
32 ##--------------------------------------------------------------
33 ## Methods: API
34  
35 ## $h = $class_or_obj->new(%options)
36 ## %$h, %options:
37 ## (
38 ## ##-- INHERITED from Handler::CGI
39 ## #encoding => $defaultEncoding, ##-- default encoding (UTF-8)
40 ## allowGet => $bool, ##-- allow GET requests? (default=1)
41 ## allowPost => $bool, ##-- allow POST requests? (default=1)
42 ## allowList => $bool, ##-- if true, allowed analyzers will be listed for 'PATHROOT/.../list' paths
43 ## pushMode => $mode, ##-- push mode for addVars (default='keep')
44 ## ##
45 ## ##-- NEW in Handler::QueryFormats
46 ## qh => $queryHandler, ##-- underlying query handler
47 ## )
48 sub new {
49 my $that = shift;
50 my $h = $that->SUPER::new(
51 qh => undef,
52 #encoding=>'UTF-8', ##-- default CGI parameter encoding
53 allowGet=>1,
54 allowPost=>1,
55 @_,
56 );
57 return $h;
58 }
59  
60 ## $bool = $h->prepare($server)
61 ## + checks that $h->{qh} is defined
62 sub prepare {
63 my ($h,$srv) = @_;
64 $h->logconfess("no query handler 'qh' defined!") if (!$h->{qh});
65 return 1;
66 }
67  
68 ## $bool = $path->run($server, $localPath, $clientSocket, $httpRequest)
69 ## + process $httpRequest as CGI form-encoded format list query
70 ## + form parameters:
71 ## (
72 ## f => $formatRegex, ##-- format name in @{$qh->{formats}{reg}}
73 ## fmt => $queryFormat, ##-- query/response format (default=$h->{defaultFormat})
74 ## #enc => $queryEncoding, ##-- query encoding (default='UTF-8')
75 ## raw => $bool, ##-- if true, data will be returned as text/plain (default=$h->{returnRaw})
76 ## pretty => $level, ##-- response format level
77 ## )
78 our %localParams = map {($_=>undef)} qw(f fmt raw pretty);
79 sub run {
80 my ($h,$srv,$path,$c,$hreq) = @_;
81  
82 ##-- check for HEAD
83 return $h->headResponse() if ($hreq->method eq 'HEAD');
84  
85 ##-- parse list query parameters
86 my $vars = $h->cgiParams($c,$hreq) or return undef;
87 $h->vlog($h->{logVars}, "got query params:\n", Data::Dumper->Dump([$vars],['vars']));
88  
89 #my $enc = $h->getEncoding(@$vars{qw(enc encoding)},$hreq,$h->{encoding});
90 #return $h->cerror($c, undef, "unknown encoding '$enc'") if (!defined(Encode::find_encoding($enc)));
91  
92 $h->decodeVars($vars, vars=>[qw(f fmt format)], allowHtmlEscapes=>0);
93 $h->trimVars($vars, vars=>[qw(f fmt format)]);
94  
95 ##-- get matching formats
96 my $qh = $h->{qh};
97 my $reg = $qh->{formats};
98 my $qre = defined($vars->{a}) ? qr/$vars->{a}/ : qr//;
99 my @fmts = (grep {$_->{name} =~ $qre || $_->{short} =~ $qre}
100 sort {$a->{short} cmp $b->{short} || $a->{name} cmp $b->{name}}
101 @{$reg->{reg}});
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 output 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",
113 map { join("\t", map {$_||''} @$_{qw(short name)}) } #readerClass writerClass filenameRegex
114 @fmts);
115 }
116 elsif ($fmt->isa('DTA::CAB::Format::XmlNative')) {
117 my $doc = XML::LibXML::Document->new(1.0,'UTF-8');
118 my $root = XML::LibXML::Element->new('formats');
119 $doc->setDocumentElement($root);
120 my ($f,$nod);
121 foreach $f (@fmts) {
122 $nod = $root->addNewChild(undef,'format');
123 $nod->setAttribute($_, ($f->{$_}||'')) foreach (qw(short name)); #readerClass writerClass filenameRegex
124 }
125 $ostr = $doc->toString($vars->{pretty}||0);
126 }
127 else {
128 ##-- raw data
129 $fmt->toString(\$ostr)->putData(\@fmts)->flush;
130 }
131 utf8::encode($ostr) if (utf8::is_utf8($ostr));
132  
133 ##-- dump response
134 return $h->dumpResponse(\$ostr,
135 raw=>$vars->{raw},
136 type=>$fmt->mimeType,
137 charset=>'UTF-8',
138 filename=>("analyzers".$fmt->defaultExtension),
139 );
140 }
141  
142  
143 ##--------------------------------------------------------------
144 ## Methods: Local
145  
146 1; ##-- be happy
147  
148 __END__