From 4ad49105a58fc4241737718feb4b9aae57eced7f Mon Sep 17 00:00:00 2001
From: Lebbeous Fogle-Weekley <lebbeous@esilibrary.com>
Date: Fri, 10 May 2013 12:32:51 -0400
Subject: [PATCH] When delivering MARC21 via SuperCat, OpenSearch, offer
 filename w/ extension

If you want a record feed in MARC21, without this commit a web browser
just suggests "marc21" as the filename for saving to your local system.

Although many consumers of these feeds will be custom scripts and other
non-interactive software components that won't care about filename, for
the web browser case it's helpful if the server suggests a filename that
ends in .mrc.

So here we go.

Signed-off-by: Lebbeous Fogle-Weekley <lebbeous@esilibrary.com>
Signed-off-by: Ben Shum <bshum@biblio.org>
---
 .../src/perlmods/lib/OpenILS/WWW/SuperCat.pm  | 70 ++++++++++++++++---
 1 file changed, 62 insertions(+), 8 deletions(-)

diff --git a/Open-ILS/src/perlmods/lib/OpenILS/WWW/SuperCat.pm b/Open-ILS/src/perlmods/lib/OpenILS/WWW/SuperCat.pm
index 16fdb24a58..5e5a2b24c6 100644
--- a/Open-ILS/src/perlmods/lib/OpenILS/WWW/SuperCat.pm
+++ b/Open-ILS/src/perlmods/lib/OpenILS/WWW/SuperCat.pm
@@ -38,6 +38,13 @@ my ($bootstrap, $supercat, $actor, $parser, $search, $xslt, $cn_browse_xslt, %br
 
 my $authority_axis_re = qr/^authority\.(\w+)(\.refs)?$/;
 
+my %extra_header_action_per_type = (
+    marc21 => [
+        {"Content-Disposition" =>
+            sub { "attachment;filename=" . time . ".mrc"}}
+    ]
+);
+
 $browse_types{call_number}{xml} = sub {
     my $tree = shift;
 
@@ -371,6 +378,39 @@ sub unapi_format {
 }
 
 
+# Return a list of strings suitable for printing on STDOUT as HTTP headers.
+sub extra_headers_per_type_to_string {
+    my ($type) = @_;
+    if (my $list = $extra_header_action_per_type{$type}) {
+        return map {
+            my $str = (keys(%$_))[0] . ": ";
+            my $value = (values(%$_))[0];
+            if (ref $value eq 'CODE') {
+                $value = $value->();
+            }
+            return $str . $value . "\n";
+        } @$list;
+    }
+    return;
+}
+
+# Return key/value pairs suitable for feeding into CGI::header()
+sub extra_headers_per_type_to_cgi {
+    my ($type) = @_;
+
+    if (my $list = $extra_header_action_per_type{$type}) {
+        return map {
+            my $key = (keys(%$_))[0];
+            my $value = (values(%$_))[0];
+            if (ref $value eq 'CODE') {
+                $value = $value->();
+            }
+            return $key => $value;
+        } @$list;
+    }
+    return;
+}
+
 sub oisbn {
 
     my $apache = shift;
@@ -678,8 +718,11 @@ sub unapi {
         $feed->update_ts();
         $feed->link( unapi => $base) if ($flesh_feed);
 
-        print "Content-type: ". $feed->type ."; charset=utf-8\n\n";
-        print $feed->toString . "\n";
+        print "Content-type: ". $feed->type ."; charset=utf-8\n";
+
+        print $_ for extra_headers_per_type_to_string($type);
+
+        print "\n", $feed->toString, "\n";
 
         return Apache2::Const::OK;
     }
@@ -899,7 +942,9 @@ sub supercat {
         try {
             my $bib = $supercat->request( "open-ils.supercat.record.object.retrieve", $id )->gather(1)->[0];
         
-            print "Content-type: application/octet-stream\n\n" . MARC::Record->new_from_xml( $bib->marc, 'UTF-8', 'USMARC' )->as_usmarc;
+            print "Content-type: application/octet-stream\n";
+            print $_ for extra_headers_per_type_to_string($base_format);
+            print "\n" . MARC::Record->new_from_xml( $bib->marc, 'UTF-8', 'USMARC' )->as_usmarc;
 
         } otherwise {
             warn shift();
@@ -939,8 +984,11 @@ sub supercat {
 
         $feed->link( unapi => $base) if ($flesh_feed);
 
-        print "Content-type: ". $feed->type ."; charset=utf-8\n\n";
-        print $feed->toString . "\n";
+        print "Content-type: ". $feed->type ."; charset=utf-8\n";
+
+        print $_ for extra_headers_per_type_to_string($type);
+
+        print "\n", $feed->toString, "\n";
 
         return Apache2::Const::OK;
     }
@@ -1150,8 +1198,11 @@ sub changes_feed {
     );
 
 
-    print "Content-type: ". $feed->type ."; charset=utf-8\n\n";
-    print $feed->toString . "\n";
+    print "Content-type: ". $feed->type ."; charset=utf-8\n";
+
+    print $_ for extra_headers_per_type_to_string($type);
+
+    print "\n", $feed->toString, "\n";
 
     return Apache2::Const::OK;
 }
@@ -1451,7 +1502,10 @@ sub opensearch_feed {
 #    );
 
     #print $cgi->header( -type => $feed->type, -charset => 'UTF-8') . entityize($feed->toString) . "\n";
-    print $cgi->header( -type => $feed->type, -charset => 'UTF-8') . $feed->toString . "\n";
+    print $cgi->header(
+        -type => $feed->type, -charset => 'UTF-8',
+        extra_headers_per_type_to_cgi($type)
+    ), $feed->toString, "\n";
 
     $log->debug("...and feed returned.");
 
-- 
2.43.2