]> git.evergreen-ils.org Git - Evergreen.git/blob - Open-ILS/src/perlmods/OpenILS/WWW/SuperCat.pm
refactoring to generic "feeds"; adding opensearch target
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / WWW / SuperCat.pm
1 package OpenILS::WWW::SuperCat;
2 use strict; use warnings;
3
4 use Apache2 ();
5 use Apache2::Log;
6 use Apache2::Const -compile => qw(OK REDIRECT DECLINED :log);
7 use APR::Const    -compile => qw(:error SUCCESS);
8 use Apache2::RequestRec ();
9 use Apache2::RequestIO ();
10 use Apache2::RequestUtil;
11 use CGI;
12 use Data::Dumper;
13
14 use OpenSRF::EX qw(:try);
15 use OpenSRF::Utils qw/:datetime/;
16 use OpenSRF::System;
17 use OpenSRF::AppSession;
18 use XML::LibXML;
19
20 use Unicode::Normalize;
21 use OpenILS::Utils::Fieldmapper;
22 use OpenILS::WWW::SuperCat::Feed;
23
24
25 # set the bootstrap config when this module is loaded
26 my ($bootstrap, $supercat, $actor, $parser, $search);
27
28 sub import {
29         my $self = shift;
30         $bootstrap = shift;
31 }
32
33
34 sub child_init {
35         OpenSRF::System->bootstrap_client( config_file => $bootstrap );
36         $supercat = OpenSRF::AppSession->create('open-ils.supercat');
37         $actor = OpenSRF::AppSession->create('open-ils.actor');
38         $search = OpenSRF::AppSession->create('open-ils.search');
39         $parser = new XML::LibXML;
40 }
41
42 sub oisbn {
43
44         my $apache = shift;
45         return Apache2::Const::DECLINED if (-e $apache->filename);
46
47         (my $isbn = $apache->path_info) =~ s{^.*?([^/]+)$}{$1}o;
48
49         my $list = $supercat
50                 ->request("open-ils.supercat.oisbn", $isbn)
51                 ->gather(1);
52
53         print "Content-type: application/xml; charset=utf-8\n\n";
54         print "<?xml version='1.0' encoding='UTF-8' ?>\n";
55
56         unless (exists $$list{metarecord}) {
57                 print '<idlist/>';
58                 return Apache2::Const::OK;
59         }
60
61         print "<idlist metarecord='$$list{metarecord}'>\n";
62
63         for ( keys %{ $$list{record_list} } ) {
64                 (my $o = $$list{record_list}{$_}) =~s/^(\S+).*?$/$1/o;
65                 print "  <isbn record='$_'>$o</isbn>\n"
66         }
67
68         print "</idlist>\n";
69
70         return Apache2::Const::OK;
71 }
72
73 sub unapi {
74
75         my $apache = shift;
76         return Apache2::Const::DECLINED if (-e $apache->filename);
77
78         print "Content-type: application/xml; charset=utf-8\n";
79         
80         my $cgi = new CGI;
81
82         my $uri = $cgi->param('uri') || '';
83         my $base = $cgi->url;
84         my $host = $cgi->virtual_host || $cgi->server_name;
85
86         my $format = $cgi->param('format');
87         my ($id,$type,$command) = ('','','');
88
89         if (!$format) {
90                 if ($uri =~ m{^tag:[^:]+:([^\/]+)/(\d+)}o) {
91                         $id = $2;
92                         $type = 'record';
93                         $type = 'metarecord' if ($1 =~ /^m/o);
94
95                         my $list = $supercat
96                         ->request("open-ils.supercat.$type.formats")
97                                 ->gather(1);
98
99                         print "\n";
100
101                         my $body =
102                                 "<formats>
103                                  <uri>$uri</uri>
104                                    <format>
105                                      <name>opac</name>
106                                      <type>text/html</type>
107                                    </format>";
108
109                         for my $h (@$list) {
110                                 my ($type) = keys %$h;
111                                 $body .= "<format><name>$type</name><type>application/$type+xml</type>";
112
113                                 for my $part ( qw/namespace_uri docs schema_location/ ) {
114                                         $body .= "<$part>$$h{$type}{$part}</$part>"
115                                                 if ($$h{$type}{$part});
116                                 }
117                                 
118                                 $body .= '</format>';
119                         }
120
121                         $body .= "</formats>\n";
122
123                         $apache->custom_response( 300, $body);
124                         return 300;
125                 } else {
126                         my $list = $supercat
127                                 ->request("open-ils.supercat.record.formats")
128                                 ->gather(1);
129                                 
130                         push @$list,
131                                 @{ $supercat
132                                         ->request("open-ils.supercat.metarecord.formats")
133                                         ->gather(1);
134                                 };
135
136                         my %hash = map { ( (keys %$_)[0] => (values %$_)[0] ) } @$list;
137                         $list = [ map { { $_ => $hash{$_} } } sort keys %hash ];
138
139                         print "\n<formats>
140                                    <format>
141                                      <name>opac</name>
142                                      <type>text/html</type>
143                                    </format>";
144
145                         for my $h (@$list) {
146                                 my ($type) = keys %$h;
147                                 print "<format><name>$type</name><type>application/$type+xml</type>";
148
149                                 for my $part ( qw/namespace_uri docs schema_location/ ) {
150                                         print "<$part>$$h{$type}{$part}</$part>"
151                                                 if ($$h{$type}{$part});
152                                 }
153                                 
154                                 print '</format>';
155                         }
156
157                         print "</formats>\n";
158
159
160                         return Apache2::Const::OK;
161                 }
162         }
163
164                 
165         if ($uri =~ m{^tag:[^:]+:([^\/]+)/(\d+)}o) {
166                 $id = $2;
167                 $type = 'record';
168                 $type = 'metarecord' if ($1 =~ /^m/o);
169                 $command = 'retrieve';
170         }
171
172         if ($format eq 'opac') {
173                 print "Location: $base/../../en-US/skin/default/xml/rresult.xml?m=$id\n\n"
174                         if ($type eq 'metarecord');
175                 print "Location: $base/../../en-US/skin/default/xml/rdetail.xml?r=$id\n\n"
176                         if ($type eq 'record');
177                 return 302;
178         }
179
180         print "\n" . $supercat->request("open-ils.supercat.$type.$format.$command",$id)->gather(1);
181
182         return Apache2::Const::OK;
183 }
184
185 sub supercat {
186
187         my $apache = shift;
188         return Apache2::Const::DECLINED if (-e $apache->filename);
189
190         my $path = $apache->path_info;
191
192         my $cgi = new CGI;
193         my $base = $cgi->url;
194
195         my ($id,$type,$format,$command) = reverse split '/', $path;
196
197         print "Content-type: application/xml; charset=utf-8\n";
198         
199         if ( $path =~ m{^/formats(?:/([^\/]+))?$}o ) {
200                 if ($1) {
201                         my $list = $supercat
202                                 ->request("open-ils.supercat.$1.formats")
203                                 ->gather(1);
204
205                         print "\n";
206
207                         print "<formats>
208                                    <format>
209                                      <name>opac</name>
210                                      <type>text/html</type>
211                                    </format>";
212
213                         for my $h (@$list) {
214                                 my ($type) = keys %$h;
215                                 print "<format><name>$type</name><type>application/$type+xml</type>";
216
217                                 for my $part ( qw/namespace_uri docs schema_location/ ) {
218                                         print "<$part>$$h{$type}{$part}</$part>"
219                                                 if ($$h{$type}{$part});
220                                 }
221                                 
222                                 print '</format>';
223                         }
224
225                         print "</formats>\n";
226
227                         return Apache2::Const::OK;
228                 }
229
230                 my $list = $supercat
231                         ->request("open-ils.supercat.record.formats")
232                         ->gather(1);
233                                 
234                 push @$list,
235                         @{ $supercat
236                                 ->request("open-ils.supercat.metarecord.formats")
237                                 ->gather(1);
238                         };
239
240                 my %hash = map { ( (keys %$_)[0] => (values %$_)[0] ) } @$list;
241                 $list = [ map { { $_ => $hash{$_} } } sort keys %hash ];
242
243                 print "\n<formats>
244                            <format>
245                              <name>opac</name>
246                              <type>text/html</type>
247                            </format>";
248
249                 for my $h (@$list) {
250                         my ($type) = keys %$h;
251                         print "<format><name>$type</name><type>application/$type+xml</type>";
252
253                         for my $part ( qw/namespace_uri docs schema_location/ ) {
254                                 print "<$part>$$h{$type}{$part}</$part>"
255                                         if ($$h{$type}{$part});
256                         }
257                         
258                         print '</format>';
259                 }
260
261                 print "</formats>\n";
262
263
264                 return Apache2::Const::OK;
265         }
266
267         if ($format eq 'opac') {
268                 print "Location: $base/../../en-US/skin/default/xml/rresult.xml?m=$id\n\n"
269                         if ($type eq 'metarecord');
270                 print "Location: $base/../../en-US/skin/default/xml/rdetail.xml?r=$id\n\n"
271                         if ($type eq 'record');
272                 return 302;
273         }
274
275         print "\n" . $supercat->request("open-ils.supercat.$type.$format.$command",$id)->gather(1);
276
277         return Apache2::Const::OK;
278 }
279
280
281 sub bookbag_feed {
282         my $apache = shift;
283         return Apache2::Const::DECLINED if (-e $apache->filename);
284
285         print "Content-type: application/xml; charset=utf-8\n\n";
286
287         my $cgi = new CGI;
288         (my $unapi = $cgi->url) =~ s{[^/]+/?$}{unapi};
289
290         my $year = (gmtime())[5];
291
292         my $host = $cgi->virtual_host || $cgi->server_name;
293         my $path = $apache->path_info;
294         my $base = $cgi->url;
295
296         my ($id,$type) = reverse split '/', $path;
297
298         my $bucket = $actor->request("open-ils.actor.container.public.flesh", 'biblio', $id)->gather(1);
299         my $bucket_tag = "tag:$host,$year:record_bucket/$id";
300
301         my $feed = create_record_feed(
302                 $type,
303                 [ map { $_->target_biblio_record_entry } @{ $bucket->items } ],
304                 $unapi,
305         );
306
307         $feed->title("Items in Book Bag #".$bucket->id);
308         $feed->creator($host);
309         $feed->update_ts(gmtime_ISO8601());
310
311         $feed->link(atom => $base . "/bookbag/atom/$id");
312         $feed->link(rss2 => $base . "/bookbag/rss2/$id");
313         $feed->link(html => $base . "/bookbag/html/$id");
314
315         print entityize($feed->toString) . "\n";
316
317         return Apache2::Const::OK;
318 }
319
320 sub opensearch_feed {
321         my $apache = shift;
322         return Apache2::Const::DECLINED if (-e $apache->filename);
323
324         print "Content-type: application/xml; charset=utf-8\n\n";
325
326         my $cgi = new CGI;
327         (my $unapi = $cgi->url) =~ s{[^/]+/?$}{unapi};
328
329         my $year = (gmtime())[5];
330
331         my $host = $cgi->virtual_host || $cgi->server_name;
332         my $base = $cgi->url;
333         my $path = $apache->path_info;
334
335         my $page = $cgi->param('startPage') || 1;
336         my $offset = $cgi->param('startIndex') || 1;
337         my $limit = $cgi->param('count') || 10;
338
339         if ($page > 1) {
340                 $offset = ($page - 1) * $limit;
341         } else {
342                 $offset -= 1;
343         }
344
345         my ($terms,$class,$type,$version) = reverse split '/', $path;
346
347         if ($version eq '1.0') {
348                 $type = 'rss2';
349         } elsif ($type eq '-') {
350                 $type = 'atom';
351         }
352
353         $class = 'keyword' if ($class eq '-');
354         $terms =~ s/\+/ /go;
355
356         warn "searching for $class -> [$terms] via OS $version, response type $type";
357
358         my $recs = $search->request(
359                 'open-ils.search.biblio.record.class.search' => $class,
360                 { term          => $terms,
361                   org_unit      => 1,
362                   limit         => $limit,
363                   offset        => $offset,
364                 }
365         )->gather(1);
366
367         my $feed = create_record_feed(
368                 $type,
369                 [ map { $_->[0] } @{$recs->{ids}} ],
370                 $unapi,
371         );
372
373 =head
374         my $bucket = $actor->request("open-ils.actor.container.public.flesh", 'biblio', $id)->gather(1);
375         my $bucket_tag = "tag:$host,$year:record_bucket/$id";
376
377         my $feed = create_record_feed(
378                 $type,
379                 [ map { $_->target_biblio_record_entry } @{ $bucket->items } ],
380                 $unapi,
381         );
382
383         $feed->title("Items in Book Bag #".$bucket->id);
384         $feed->creator($host);
385         $feed->update_ts(gmtime_ISO8601());
386
387         $feed->link(atom => $id);
388         $feed->link(rss2 => $id);
389         $feed->link(html => $id);
390
391 =cut
392
393         $feed->_create_node(
394                 $feed->{item_xpath},
395                 'http://a9.com/-/spec/opensearch/1.1/',
396                 'totalResults',
397                 $recs->{count},
398         );
399
400         $feed->_create_node(
401                 $feed->{item_xpath},
402                 'http://a9.com/-/spec/opensearch/1.1/',
403                 'startIndex',
404                 $offset + 1,
405         );
406
407         $feed->_create_node(
408                 $feed->{item_xpath},
409                 'http://a9.com/-/spec/opensearch/1.1/',
410                 'itemsPerPage',
411                 $limit,
412         );
413
414         $feed->link(
415                 next =>
416                 $base . $path . "?startIndex=" . int($offset + $limit + 1) . "&count=" . $limit =>
417                 'application/opensearch+xml'
418         ) if ($offset + $limit < $recs->{count});
419
420         $feed->link(
421                 prev =>
422                 $base . $path . "?startIndex=" . int(($offset - $limit) + 1) . "&count=" . $limit =>
423                 'application/opensearch+xml'
424         ) if ($offset);
425
426         $feed->link(
427                 self =>
428                 $base . $path =>
429                 'application/opensearch+xml'
430         );
431
432
433         print entityize($feed->toString) . "\n";
434         return Apache2::Const::OK;
435 }
436
437 sub create_record_feed {
438         my $type = shift;
439         my $records = shift;
440         my $unapi = shift;
441
442         my $cgi = new CGI;
443         my $base = $cgi->url;
444         my $host = $cgi->virtual_host || $cgi->server_name;
445
446         my $year = (gmtime())[5];
447
448         my $feed = new OpenILS::WWW::SuperCat::Feed ($type);
449         $feed->base($base);
450         $feed->unapi($unapi);
451
452         for my $rec (@$records) {
453                 my $item_tag = "tag:$host,$year:biblio-record_entry/" . $rec;
454
455                 my $xml = $supercat->request(
456                         "open-ils.supercat.record.$type.retrieve",
457                         $rec
458                 )->gather(1);
459
460                 my $node = $feed->add_item($xml);
461
462                 $node->id($item_tag);
463                 $node->link(opac => $feed->unapi . "?uri=$item_tag&format=opac");
464                 $node->link(unapi => $feed->unapi . "?uri=$item_tag");
465         }
466
467         return $feed;
468 }
469
470 sub entityize {
471         my $stuff = NFC(shift());
472         $stuff =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
473         return $stuff;
474 }
475
476 1;