Differences

This shows you the differences between two versions of the page.

--- buechereielektrik:unapi:unapi.php [2009-12-20 14:50] – Some minor style and other corrections. strols
+++ buechereielektrik:unapi:unapi.php [2010-02-19 13:18] – Added csv as format. strols
@@ Line 1: / Line 1: @@
-<code>
+<code php unAPI.php>
 <?php
-// hatop@ub.uni-marburg.de 2008-12-08 2009-12-03
+/*
-// http://unapi.info/specs/
+ *  Purpose
+ *
+ *  This is an implementation of an unAPI for PICA-LBSs.
+ *  It uses the XML-interface of the OPC4 for extracting bibliographic
+ *  data.
+ *  For the specification of unAPI, see <http://unapi.info/specs/>.
+ */
-/*  Copyright 2008 2009 Goetz Hatop
+/*
+ *  Copyright
+ *
+ *  Copyright 2008 2009 Goetz Hatop <hatop@ub.uni-marburg.de>.
  *  Goetz Hatop's original Version can be found at
- *  <ftp://ftp.ub.uni-marburg.de/pub/research/unapi.tar.gz>
+ *  <ftp://ftp.ub.uni-marburg.de/pub/research/unapi.tar.gz>.
+ *
+ *  Copyright 2009 2010 Stephan Rosenke <rosenke@ulb.tu-darmstadt.de> or
+ *  <r01-551@r0s.de>. See also <http://r0s.de/unapi>.
  */
-/*  Copyright 2009 Stephan Rosenke <rosenke@ulb.tu-darmstadt.de> */
+/*
+ *  License
-/*  This program is free software: you can redistribute it and/or modify
+ *
+ *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation, either version 3 of the License, or
@@ Line 26: / Line 39: @@
  */
-/*  Version:	0.1 */
+/*
+ *  Version
+ *
+ *  0.5
+ */
-/*  Changelog
+/*
- *
+ *  Changelog
+ *
+ *  20100219:	Added csv as format.
+ *  20100127:	Added link in copyright.
+ *  20100111:	Added openurl-kev as format.
+ *  20100110:	Some style improvements, added comments, removed some old code.
+ *  20100109:	Some style improvements, added comments.
  *  20091216:	Some minor style and other corrections.
  *  20091215:   Added JSON as format.
@@ Line 35: / Line 58: @@
  *              Made last switch() more validator compliant.
  *  20091211:	Added HTTP-Response-Codes to some cases in the last switch.
- * 		Corrected answer if format=''.
+ *		Corrected answer if format=''.
  *		Added BibTex as format.
  *  20091210:	Put class Picappn to PicaRecord.php.
  *		Inserted conditional for textual output of array.
  *		Ordered final switch() alphabetically.
- * 		Added format "plain", renamed "picaplus" to "extpp".
+ *		Added format "plain", renamed "picaplus" to "extpp".
-		Put header() in the case-loops in final switch().
+ *		Put header() in the case-loops in final switch().
- *  20091210:	Started with Goetz Hatop's version of 2009-12-08
+ *  20091210:	Started with Goetz Hatop's version of 2009-12-08.
  */
-require_once('PicaRecord.php');
+/*
+ *
+ *  DO NOT MESS BEHIND THIS LINE
+ *
+ */
+//  include some objects and methods
+require_once('unAPI.inc.php');
+//  make some GET-variables a little bit handier
+$format = $_GET['format'];
+$id = $_GET['id'];
+/*
+ *  Output if no id-parameter or no parameter at all is given.
+ *  Plain-format is not announced.
+ */
 $noparam = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
 <formats>
 <format name=\"bibtex\" type=\"text/plain\" />
+<format name=\"csv\" type=\"text/plain\" />
 <format name=\"dc\" type=\"application/xml\" />
 <format name=\"extpp\" type=\"application/xml\" />
 <format name=\"json\" type=\"application/json\" />
+<format name=\"openurl-kev\" type=\"text/plain\" />
 <format name=\"rdf\" type=\"application/xml\" />
 <format name=\"text\" type=\"text/plain\" />
@@ Line 59: / Line 100: @@
 ";
-$idparam = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+/*
-<formats id=\"info:pica/004\">
+ *  check if $id is not empty, if it's empty show
-<format name=\"text\" type=\"text/plain\" />
+ *  available formats.
-</formats>
+ */
-";
+if (!isset($id) || $id == '') {
-if (!isset($_GET['id']) || $_GET['id']=='') {
   header('Content-type: application/xml');
   echo "$noparam";
   return;
 }
+//  instantiate new Picappn()
 $pica = new Picappn();
-$pica->setPpn( $_GET['id'] );
-if ($_GET['format'] == "array") {
+//  set PPN as identifier
+$pica->setPpn($id);
+/*
+ *  This is no part of the unAPI but for debugging.
+ *  It is triggered by supplying "array" as $format and print_rs the
+ *  pica-data as array.
+ */
+if ($format == "array") {
   echo "<head></head>\n<body>\n <pre>\n";
   print_r($pica->getArray());
@@ Line 81: / Line 128: @@
 }
-switch ($_GET['format']) {
+//  Final switch for printing result according to $format
+switch ($format) {
+  //  BibTeX
   case 'bibtex':
      $res = $pica->getBibTex();
      final_result($res, 'text/plain');
      break;
+  //  CSV
+  case 'csv':
+     $res = $pica->getCsv();
+     final_result($res, 'text/plain');
+     break;
+  //  Dublin Core
   case 'dc':
      $res = $pica->getDublinCore();
      final_result($res, 'application/xml');
      break;
+  //  External PICA+
   case 'extpp':
      $res = $pica->getPicaPlus();
      final_result($res, 'application/xml');
      break;
+  //  JSON
   case 'json':
      $res = $pica->getJson();
      final_result($res, 'application/json');
      break;
+  //  OpenURL-KEV
+  case 'openurl-kev':
+     $res = $pica->getOpenUrlKev();
+     final_result($res, 'text/plain');
+     break;
+  //  pseudo-XML
   case 'plain':
      $res = $pica->getPlain();
      break;
+  //  RDF
   case 'rdf':
      $res = $pica->getDublinCoreRDF();
      final_result($res, 'application/xml');
      break;
+  //  plain text
   case 'text':
      $res = $pica->getText();
      final_result($res, 'text/plain');
      break;
+  //  XML
   case 'xml':
      $res = $pica->getXmlData();
      final_result($res, 'application/xml');
      break;
+  //  if no $format is given but $id is set
   case '':
      header('HTTP/1.0 300 Multiple Choices');
@@ Line 118: / Line 185: @@
      echo "$noparam";
      break;
+  //  for all other values of $format
   default:
      header('HTTP/1.0 406 Not Acceptable');