=====Features=====
-* [[http://www.monperrus.net/martin/bibtexbrowser.php|bibtexbrowser can display the menu and all entries without filtering from the $filename hardcoded in the script ]]
-* [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib|bibtexbrowser can display the menu and all entries without filtering from the file name passed as parameter]]
-* [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&all|bibtexbrowser can display all entries out of a bibtex file]]
-* [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&year=2004|bibtexbrowser can display all entries for a given year]]
-* [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&author=Barbara+A.+Kitchenham|bibtexbrowser can display all entries for an author]]
-* [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&key=monperrus08phd|bibtexbrowser can display a single entry]]
-* [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&keywords=mda|bibtexbrowser can display all entries with a bib keyword]]
-* [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&search=ocl|bibtexbrowser can display found entries with a search word (it can be in any bib field)]]
+* bibtexbrowser can display the menu and all entries without filtering from the $filename hardcoded in the script [[http://www.monperrus.net/martin/bibtexbrowser.php|demo]]
+* bibtexbrowser can display the menu and all entries without filtering from the file name passed as parameter [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib|demo]]
+* bibtexbrowser can display all entries out of a bibtex file [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&all|demo]]
+* bibtexbrowser can display all entries for a given year [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&year=2004|demo]]
+* bibtexbrowser can display a single entry [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&key=monperrus08phd|demo]]
+* bibtexbrowser can display all entries with a bib keyword [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&keywords=mda|demo]]
+* bibtexbrowser can display found entries with a search word (it can be in any bib field) [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&search=ocl|demo]]
* bibtexbrowser allows multi criteria search, e.g. ?type=inproceedings&year=2004
* bibtexbrowser outputs valid XHTML 1.0 Transitional
* bibtexbrowser in designed to be search engine friendly.
-* You can include your publications list into your home page:
+* bibtexbrowser can display all entries for an author [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&author=Barbara+A.+Kitchenham|demo]]
+* bibtexbrowser can display all entries for an author with an academic style [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=biblio_monperrus.bib&academic=Martin+Monperrus|demo]]
+* bibtexbrowser can be used to include your publication list into your home page [[http://www.monperrus.net/martin/|demo]]
+* bibtexbrowser can be used with different encodings (change the default iso-8859-1 encoding if your bib file is in utf-8 ''define('ENCODING','utf-8')'' )
+
+=====How to include your publication list in your home page=====
+
+Use this PHP snippet:
<?php
-session_start(); //to avoid reparsing the bib file; should be at the very top of the script
-// the bib file
-$_GET['bib']='mybib.bib';
-// the request
-$_GET['author']='Martin Monperrus';
+$_GET['bib']='mybib.bib';
+$_GET['academic']='Martin Monperrus';
include('bibtexbrowser.php');
?>
-And tailor it with a CSS style!
-<style>
-.date {
- background-color: blue;
- }
-.rheader {
- font-size: large
- }
-
-.bibline {
- padding:3px;
- padding-left:15px;
- vertical-align:top;
-}
+Tailor it with a CSS style, for example:
+<style>
+.date { background-color: blue; }
+.rheader { font-size: large }
+.bibline { padding:3px; padding-left:15px; vertical-align:top;}
</style>
-Warning: you may change the default iso-8859-1 encoding if your bib file is in utf-8 (define('ENCODING','iso-8859-1') below);
=====Users=====
Don't hesitate to [[http://www.monperrus.net/martin/|contact me]] to be added in the list!
@@ -101,7 +94,6 @@ 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 2 of the
License, or (at your option) any later version.
-Current version: v__DATE__
*/
@@ -133,8 +125,9 @@ define('Q_ALL', 'all');
define('Q_ENTRY', 'entry');
define('Q_KEY', 'key');
define('Q_SEARCH', 'search');
+define('Q_EXCLUDE', 'exclude');
define('Q_RESULT', 'result');
-
+define('Q_ACADEMIC', 'academic');
define('AUTHOR', 'author');
define('EDITOR', 'editor');
define('SCHOOL', 'school');
@@ -142,9 +135,11 @@ define('TITLE', 'title');
define('BOOKTITLE', 'booktitle');
define('YEAR', 'year');
+// SCRIPT_NAME is used to create correct links when oncluding a publication list
+// in another page
// this constant may have already been initialized
// when using include('')
-@define('SCRIPT_NAME','bibtexbrowser.php');
+@define('SCRIPT_NAME',basename(__FILE__));
// for clean search engine links
// we disable url rewriting
@@ -167,7 +162,7 @@ global $filename;
$filename = "biblio_monperrus.bib";
// retrieve the filename sent as query or hidden data, if exists.
if (isset($_GET[Q_FILE])) {
- $filename = urldecode($_GET[Q_FILE]);
+ $filename = $_GET[Q_FILE];
}
if (!file_exists($filename)) {
@@ -183,182 +178,356 @@ if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && (strtotime($_SERVER['HTTP_IF_MO
exit;
}
+
// parse a new bib file, if this file has not been already parsed
if (!isset($_SESSION[$filename]) ) {
- echo '';
+ // for sake of performance, once the bibtex file is parsed
+ // the object that represents the database is stored in $_SESSION
// we use serialize in order to be able to get a session correctly set up
// without bibtexbrowser loaded in PHP
- $_SESSION[$filename] = serialize(new DisplayManager(new BibDataBase($filename)));
+ $_SESSION[$filename] = serialize(new BibDataBase($filename));
}
-$displaymanager=unserialize($_SESSION[$filename]);
+$displaymanager=new DisplayManager(unserialize($_SESSION[$filename]));
////////////////////////////////////////////////////////
-
-/**
- * Class to parse a bibtex file.
+/** This class is a generic parser of bibtex files
+ * It has no dependencies, i.e. it can be used outside of bibtexbrowser
+ * To use it, simply instantiate it and pass it an object that will receive semantic events
+ * The delegate is expected to have some methods
+ * see classes BibtexbrowserBibDB and XMLPrettyPrinter
*/
-class BibParser {
+class StateBasedBibtexParser {
+
+function StateBasedBibtexParser($bibfilename, $delegate) {
+
+$f=str_split(file_get_contents($bibfilename));
+
+
+// STATE DEFINITIONS
+
+define('NOTHING',1);
+define('GETTYPE',2);
+define('GETKEY',3);
+define('GETVALUE',4);
+define('GETVALUEDELIMITEDBYQUOTES',5);
+define('GETVALUEDELIMITEDBYQUOTES_ESCAPED',6);
+define('GETVALUEDELIMITEDBYCURLYBRACKETS',7);
+define('GETVALUEDELIMITEDBYCURLYBRACKETS_ESCAPED',8);
+define('GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL',9);
+define('GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL_ESCAPED',10);
+define('GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL',11);
+define('GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL_ESCAPED',12);
+define('GETVALUEDELIMITEDBYCURLYBRACKETS_3NESTEDLEVEL',11);
+define('GETVALUEDELIMITEDBYCURLYBRACKETS_3NESTEDLEVEL_ESCAPED',12);
+
+
+$state=NOTHING;
+$entrytype='';
+$entrykey='';
+$entryvalue='';
+$finalkey='';
+$entrysource='';
+
+// metastate
+$isinentry = false;
+
+$delegate->beginFile();
+
+foreach($f as $s) {
+
+ if ($isinentry) $entrysource.=$s;
+
+ if ($state==NOTHING) {
+ // this is the beginning of an entry
+ if ($s=='@') {
+ $delegate->beginEntry();
+ $state = GETTYPE;
+ $isinentry = true;
+ $entrysource='@';
+ }
+ }
+
+ else if ($state==GETTYPE) {
+ // this is the beginning of a key
+ if ($s=='{') {
+ $state = GETKEY;
+ $delegate->setEntryType($entrytype);
+ $entrytype='';
+ }
+ else $entrytype=$entrytype.$s;
+ }
+
+ else if ($state==GETKEY) {
+ // now we get the value
+ if ($s=='=') {
+ $state = GETVALUE;
+ $finalkey=$entrykey;
+ $entrykey='';}
+ // oups we only have the key :-) anyway
+ else if ($s=='}') {
+ $state = NOTHING;$isinentry = false;$delegate->endEntry($entrysource);
+ $delegate->setEntryKey($entrykey);
+ $entrykey='';
+ }
+ // OK now we look for values
+ else if ($s==',') {
+ $state=GETKEY;
+ $delegate->setEntryKey($entrykey);
+ $entrykey='';}
+ else { $entrykey=$entrykey.$s; }
+ }
+ // we just got a =, we can now receive the value, but we don't now whether the value
+ // is delimited by curly brackets, double quotes or nothing
+ else if ($state==GETVALUE) {
+
+ // the value is delimited by double quotes
+ if ($s=='"') {
+ $state = GETVALUEDELIMITEDBYQUOTES;
+ $entryvalue='';}
+ // the value is delimited by curly brackets
+ else if ($s=='{') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS;
+ $entryvalue='';}
+ // the end of the key and no value found: it is the bibtex key e.g. \cite{Descartes1637}
+ else if ($s==',') {
+ $state = GETKEY;
+ $delegate->setEntryField(trim($finalkey),$entryvalue);
+ $entryvalue='';}
+ // this is the end of the value AND of the entry
+ else if ($s=='}') {
+ $state = NOTHING;$isinentry = false;
+ $delegate->setEntryField(trim($finalkey),$entryvalue);
+ $delegate->endEntry($entrysource);
+ $entryvalue='';}
+ else { $entryvalue=$entryvalue.$s;}
+ }
- /** A hashtable from IDs (number) to bib entries (BibEntry). */
- var $bibdb;
- /** Parses the given bibtex file and stores all entries to $bibdb. */
- //@ assignable $bibdb;
- function BibParser($filename) {
- $file = fopen($filename, 'r');
- $entry =$this->parseEntry($file);
- while ($entry) {
- $this->bibdb[$entry->getKey()] = $entry;
- //if ($entry->getId() >= 500) { return; } // !FIXME!
- $entry =$this->parseEntry($file);
- //print_r($entry);
+/* GETVALUEDELIMITEDBYCURLYBRACKETS* handle entries delimited by curly brackets and the possible nested curly brackets */
+ else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS) {
+
+ if ($s=='\\') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_ESCAPED;
+ $entryvalue=$entryvalue.$s;}
+ else if ($s=='{') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL;}
+ else if ($s=='}') {
+ $state = GETVALUE;}
+ else { $entryvalue=$entryvalue.$s;}
+ }
+ // handle anti-slashed brackets
+ else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_ESCAPED) {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS;
+ $entryvalue=$entryvalue.$s;
+ }
+ // in first level of curly bracket
+ else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL) {
+ if ($s=='\\') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL_ESCAPED;
+ $entryvalue=$entryvalue.$s;}
+ else if ($s=='{') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL;}
+ else if ($s=='}') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS;}
+ else { $entryvalue=$entryvalue.$s;}
+ }
+ // handle anti-slashed brackets
+ else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL_ESCAPED) {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL;
+ $entryvalue=$entryvalue.$s;
}
- fclose($file);
- //print_r($this->bibdb);
+
+ // in second level of curly bracket
+ else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL) {
+ if ($s=='\\') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL_ESCAPED;
+ $entryvalue=$entryvalue.$s;}
+ else if ($s=='{') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_3NESTEDLEVEL;}
+ else if ($s=='}') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL;}
+ else { $entryvalue=$entryvalue.$s;}
}
-
-
- /** Returns the array of parsed bib entires. */
- function getEntries() {
- return $this->bibdb;
+ // handle anti-slashed brackets
+ else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL_ESCAPED) {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL;
+ $entryvalue=$entryvalue.$s;
}
- /** Parses and returns the next bib entry from the fiven file. If
- * no more entry exist, NULL is returned. */
- function parseEntry($file) {
- // parse bib type, e.g., @BOOK{
- while (true) {
- $raw_line = $this->nextLine($file);
- //echo 'RAW: ' . $raw_line;
- if (!$raw_line) { // EOF?
- return NULL;
- }
- $line = trim($raw_line);
- if (ereg('^[[:space:]]*@.*\{[[:space:]]*([^,]*)', $line,$regs)) {
- //echo 'NEW: ' . $regs[1] . "\n";
- $type = trim(substr($line, 1, strpos($line,'{') - 1));
- $fields = array();
- $fields['key']= $regs[1];
- $raw_bib = $raw_line;
- break;
- }
- }
+ // in third level of curly bracket
+ else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_3NESTEDLEVEL) {
+ if ($s=='\\') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_3NESTEDLEVEL_ESCAPED;
+ $entryvalue=$entryvalue.$s;}
+ else if ($s=='}') {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL;}
+ else { $entryvalue=$entryvalue.$s;}
+ }
+ // handle anti-slashed brackets
+ else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_3NESTEDLEVEL_ESCAPED) {
+ $state = GETVALUEDELIMITEDBYCURLYBRACKETS_3NESTEDLEVEL;
+ $entryvalue=$inentryvaluedelimitedA0.$s;
+ }
- // parse fields, if any
- $raw_line = $this->nextLine($file);
- while ($raw_line) {
- $raw_bib .= $raw_line;
-
- $line = trim($raw_line);
- if (ereg("^.*=", $line)) { // new field?
- //echo 'FIELD: ' . $line . "\n";
- //get the field type
- $ps = strpos($line, '=');
- $fkey = strtolower(trim(substr($line,0,$ps)));
- $fval = $this->extractFieldValue($line);
- if (strlen($fval)) {
- $fields[$fkey] = $fval;
+/* handles entries delimited by double quotes */
+ else if ($state==GETVALUEDELIMITEDBYQUOTES) {
+ if ($s=='\\') {
+ $state = GETVALUEDELIMITEDBYQUOTES_ESCAPED;
+ $inentryvaluedelimitedB=$inentryvaluedelimitedB.$s;}
+ else if ($s=='"') {
+ $state = GETVALUE;
+ $entryvalue=$entryvalue.$inentryvaluedelimitedB;
+ $inentryvaluedelimitedB='';}
+ else { $inentryvaluedelimitedB=$inentryvaluedelimitedB.$s;}
}
- if (ereg(",[:space:]*}$",$line)) return $this->makeBibEntry($type, $fields, $raw_bib);
- if (ereg("=[^{]*}$",$line)) return $this->makeBibEntry($type, $fields, $raw_bib);
- } else if ($line == "}") { // end of entry?
- //echo 'END: ' . $line . "\n";
- return $this->makeBibEntry($type, $fields, $raw_bib);
- } else { // continued field?
- $fval = $this->extractFieldValue($line);
- if (strlen($fval) > 0) {
- if (!isset($fields[$fkey])) { // no value seen so far?
- // remove starting " if exists
- if ($fval[0] == '"') {
- $fval = ltrim(substr($fval, 1));
- }
- }
- if (strlen($fval)) {
- if (isset($fields[$fkey])) {
- $fields[$fkey] = $fields[$fkey].' '.$fval;
- } else {
- $fields[$fkey] = $fval;
- }
- }
+ // handle anti-double quotes
+ else if ($state==GETVALUEDELIMITEDBYQUOTES_ESCAPED) {
+ $state = GETVALUEDELIMITEDBYQUOTES;
+ $inentryvaluedelimitedB=$inentryvaluedelimitedB.$s;
}
- }
- $raw_line = $this->nextLine($file);
- }
+}
+$delegate->endFile();
+} // end function
+} // end class
- // entry ended without a closing brace
- return $this->makeBibEntry($type, $fields, $raw_bib);
+/** This class can be used together with StateBasedBibParser */
+class XMLPrettyPrinter {
+ function beginFile() {
+ header('Content-type: text/xml;');
+ print '';
+ print '