,

, nothing resp.). // for list/ordered_list, the abbrevations are not taken into account (see ABBRV_TYPE) // for ordered_list, the index is given by HTML directly (in increasing order) @define('BIBTEXBROWSER_LAYOUT','table'); // should the original bibtex be displayed or a reconstructed one with filtering // values: original/reconstructed // warning, with reconstructed, the latex markup for accents/diacritics is lost @define('BIBTEXBROWSER_BIBTEX_VIEW','original'); // a list of fields that will not be shown in the bibtex view if BIBTEXBROWSER_BIBTEX_VIEW=reconstructed @define('BIBTEXBROWSER_BIBTEX_VIEW_FILTEREDOUT','comment|note|file'); // should Latex macros be executed (e.g. \'e -> é @define('BIBTEXBROWSER_USE_LATEX2HTML',true); // Which is the first html level that should be used in embedded mode? @define('BIBTEXBROWSER_HTMLHEADINGLEVEL', 2); @define('BIBTEXBROWSER_ACADEMIC_TOC', false); @define('BIBTEXBROWSER_DEBUG',false); // should we cache the parsed bibtex file? // ref: https://github.com/monperrus/bibtexbrowser/issues/128 @define('BIBTEXBROWSER_USE_CACHE',true); // how to print authors names? // default => as in the bibtex file // USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT = true => "Meyer, Herbert" // USE_INITIALS_FOR_NAMES = true => "Meyer H" // USE_FIRST_THEN_LAST => Herbert Meyer @define('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT',false);// output authors in a comma separated form, e.g. "Meyer, H"? @define('USE_INITIALS_FOR_NAMES',false); // use only initials for all first names? @define('USE_FIRST_THEN_LAST',false); // put first names before last names? @define('FORCE_NAMELIST_SEPARATOR', ''); // if non-empty, use this to separate multiple names regardless of USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT @define('LAST_AUTHOR_SEPARATOR',' and '); @define('USE_OXFORD_COMMA',false); // adds an additional separator in addition to LAST_AUTHOR_SEPARATOR if there are more than two authors @define('TYPES_SIZE',10); // number of entry types per table @define('YEAR_SIZE',20); // number of years per table @define('AUTHORS_SIZE',30); // number of authors per table @define('TAGS_SIZE',30); // number of keywords per table @define('READLINE_LIMIT',1024); @define('Q_YEAR', 'year'); @define('Q_YEAR_PAGE', 'year_page'); @define('Q_YEAR_INPRESS', 'in press'); @define('Q_YEAR_ACCEPTED', 'accepted'); @define('Q_YEAR_SUBMITTED', 'submitted'); @define('Q_FILE', 'bib'); @define('Q_AUTHOR', 'author'); @define('Q_AUTHOR_PAGE', 'author_page'); @define('Q_TAG', 'keywords'); @define('Q_TAG_PAGE', 'keywords_page'); @define('Q_TYPE', 'type');// used for queries @define('Q_TYPE_PAGE', 'type_page'); @define('Q_ALL', 'all'); @define('Q_ENTRY', 'entry'); @define('Q_KEY', 'key'); @define('Q_KEYS', 'keys'); // filter entries using a url-encoded, JSON-encoded array of bibtex keys @define('Q_SEARCH', 'search'); @define('Q_EXCLUDE', 'exclude'); @define('Q_RESULT', 'result'); @define('Q_ACADEMIC', 'academic'); @define('Q_DB', 'bibdb'); @define('Q_LATEST', 'latest'); @define('Q_RANGE', 'range'); @define('AUTHOR', 'author'); @define('EDITOR', 'editor'); @define('SCHOOL', 'school'); @define('TITLE', 'title'); @define('BOOKTITLE', 'booktitle'); @define('YEAR', 'year'); @define('BUFFERSIZE',100000); @define('MULTIPLE_BIB_SEPARATOR',';'); @define('METADATA_COINS',true); // see https://en.wikipedia.org/wiki/COinS @define('METADATA_GS',false); // metadata google scholar, see http://www.monperrus.net/martin/accurate+bibliographic+metadata+and+google+scholar @define('METADATA_DC',true); // see http://dublincore.org/ @define('METADATA_OPENGRAPH',true); // see http://ogp.me/ @define('METADATA_EPRINTS',false); // see https://wiki.eprints.org/w/Category:EPrints_Metadata_Fields // define sort order for special values in 'year' field // highest number is sorted first // don't exceed 0 though, since the values are added to PHP_INT_MAX @define('ORDER_YEAR_INPRESS', 0); @define('ORDER_YEAR_ACCEPTED', 1); @define('ORDER_YEAR_SUBMITTED', 2); @define('ORDER_YEAR_OTHERNONINT', 3); // in embedded mode, we still need a URL for displaying bibtex entries alone // this is usually resolved to bibtexbrowser.php // but can be overridden in bibtexbrowser.local.php // for instance with @define('BIBTEXBROWSER_URL',''); // links to the current page with ? @define('BIBTEXBROWSER_URL',basename(__FILE__)); // Specify the location of the cache file for servers that need temporary files written in a specific location @define('CACHE_DIR',''); // Specify the location of the bib file for servers that need do not allow slashes in URLs, // where the bib file and bibtexbrowser.php are in different directories. @define('DATA_DIR',''); // *************** END CONFIGURATION define('Q_INNER_AUTHOR', '_author');// internally used for representing the author define('Q_INNER_TYPE', 'x-bibtex-type');// used for representing the type of the bibtex entry internally @define('Q_INNER_KEYS_INDEX', '_keys-index');// used for storing indices in $_GET[Q_KEYS] array define('Q_NAME', 'name');// used to allow for exact last name matches in multisearch define('Q_AUTHOR_NAME', 'author_name');// used to allow for exact last name matches in multisearch define('Q_EDITOR_NAME', 'editor_name');// used to allow for exact last name matches in multisearch // for clean search engine links // we disable url rewriting // ... and hope that your php configuration will accept one of these @ini_set("session.use_only_cookies",1); @ini_set("session.use_trans_sid",0); @ini_set("url_rewriter.tags",""); function nothing() {} function config_value($key) { global $CONFIGURATION; if (isset($CONFIGURATION[$key])) { return $CONFIGURATION[$key]; } if (defined($key)) { return constant($key); } die('no such configuration: '.$key); } /** parses $_GET[Q_FILE] and puts the result (an object of type BibDataBase) in $_GET[Q_DB]. See also zetDB(). */ function setDB() { list($db, $parsed, $updated, $saved) = _zetDB(@$_GET[Q_FILE]); $_GET[Q_DB] = $db; return $updated; } /** parses the $bibtex_filenames (usually semi-column separated) and returns an object of type BibDataBase. See also setDB() */ function zetDB($bibtex_filenames) { list($db, $parsed, $updated, $saved) = _zetDB($bibtex_filenames); return $db; } /** @nodoc */ function default_message() { if (config_value('BIBTEXBROWSER_NO_DEFAULT')==true) { return; } ?>

Congratulations! bibtexbrowser is correctly installed!
Now you have to pass the name of the bibtex file as parameter (e.g. bibtexbrowser.php?bib=mybib.php)
You may browse:
'.$bibfile.'
'; } echo "

"; } /** returns the target of links */ function get_target() { if (c('BIBTEXBROWSER_LINKS_TARGET')!='_self') { return " target=\"".c('BIBTEXBROWSER_LINKS_TARGET')."\""; } else return ""; } /** @nodoc */ function _zetDB($bibtex_filenames) { $db = null; // default bib file, if no file is specified in the query string. if (!isset($bibtex_filenames) || $bibtex_filenames == "") { default_message(); exit; } // first does the bibfiles exist: // $bibtex_filenames can be urlencoded for instance if they contain slashes // so we decode it $bibtex_filenames = urldecode($bibtex_filenames); // ---------------------------- HANDLING unexistent files foreach(explode(MULTIPLE_BIB_SEPARATOR, $bibtex_filenames) as $bib) { // get file extension to only allow .bib files $ext = pathinfo($bib, PATHINFO_EXTENSION); // this is a security protection if (BIBTEXBROWSER_LOCAL_BIB_ONLY && (!file_exists(DATA_DIR.$bib) || strcasecmp($ext, 'bib') != 0)) { // to automate dectection of faulty links with tools such as webcheck header('HTTP/1.1 404 Not found'); // escape $bib to prevent XSS $escapedBib = htmlEntities($bib, ENT_QUOTES); die('the bib file '.$escapedBib.' does not exist !'); } } // end for each // ---------------------------- HANDLING HTTP If-modified-since // testing with $ curl -v --header "If-Modified-Since: Fri, 23 Oct 2010 19:22:47 GMT" "... bibtexbrowser.php?key=wasylkowski07&bib=..%252Fstrings.bib%253B..%252Fentries.bib" // and $ curl -v --header "If-Modified-Since: Fri, 23 Oct 2000 19:22:47 GMT" "... bibtexbrowser.php?key=wasylkowski07&bib=..%252Fstrings.bib%253B..%252Fentries.bib" // save bandwidth and server cpu // (imagine the number of requests from search engine bots...) $bib_is_unmodified = isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ; foreach(explode(MULTIPLE_BIB_SEPARATOR, $bibtex_filenames) as $bib) { $bib_is_unmodified = $bib_is_unmodified && (strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])>filemtime($bib)); } // end for each if ( $bib_is_unmodified && !headers_sent()) { header("HTTP/1.1 304 Not Modified"); exit; } $parse=true; $updated = false; if (config_value('BIBTEXBROWSER_USE_CACHE')==true) { // ---------------------------- HANDLING caching of compiled bibtex files // for sake of performance, once the bibtex file is parsed // we try to save a "compiled" in a txt file $compiledbib = CACHE_DIR.'bibtexbrowser_'.md5($bibtex_filenames).'.dat'; $parse=filemtime(__FILE__)>@filemtime($compiledbib); // do we have a compiled version ? if (is_file($compiledbib) && is_readable($compiledbib) && filesize($compiledbib)>0 ) { $f = fopen($compiledbib,'r+'); // some Unix seem to consider flock as a writing operation //we use a lock to avoid that a call to bibbtexbrowser made while we write the object loads an incorrect object if (flock($f,LOCK_EX)) { $s = filesize($compiledbib); $ser = fread($f,$s); $db = @unserialize($ser); flock($f,LOCK_UN); } else { die('could not get the lock'); } fclose($f); // basic test // do we have an correct version of the file if (!is_a($db,'BibDataBase')) { unlink($compiledbib); if (BIBTEXBROWSER_DEBUG) { die('$db not a BibDataBase. please reload.'); } $parse=true; } } else {$parse=true;} } // we don't have a compiled version if ($parse) { //echo ''; // then parsing the file $db = createBibDataBase(); foreach(explode(MULTIPLE_BIB_SEPARATOR, $bibtex_filenames) as $bib) { $db->load($bib); } } // now we may update the database if (!file_exists($compiledbib)) { @touch($compiledbib); $updated = true; // limit case } else foreach(explode(MULTIPLE_BIB_SEPARATOR, $bibtex_filenames) as $bib) { // is it up to date ? wrt to the bib file and the script // then upgrading with a new version of bibtexbrowser triggers a new compilation of the bib file if (filemtime($bib)>filemtime($compiledbib) || filemtime(__FILE__)>filemtime($compiledbib)) { // echo "updating ".$bib; $db->update($bib); $updated = true; } } // echo var_export($parse); // echo var_export($updated); $saved = false; // are we able to save the compiled version ? // note that the compiled version is saved in the current working directory if ( ($parse || $updated ) && is_writable($compiledbib)) { // we use 'a' because the file is not locked between fopen and flock $f = fopen($compiledbib,'a'); //we use a lock to avoid that a call to bibbtexbrowser made while we write the object loads an incorrect object if (flock($f,LOCK_EX)) { // echo ''; ftruncate($f,0); fwrite($f,serialize($db)); flock($f,LOCK_UN); $saved = true; } else { die('could not get the lock'); } fclose($f); } // end saving the cached verions //else echo ''; return array($db, $parse, $updated, $saved); } // end function setDB // internationalization if (!function_exists('__')){ function __($msg) { global $BIBTEXBROWSER_LANG; if (isset($BIBTEXBROWSER_LANG[$msg])) { return $BIBTEXBROWSER_LANG[$msg]; } return $msg; } } // factories // may be overridden in bibtexbrowser.local.php if (!function_exists('createBibDataBase')) { /** factory method for openness @nodoc */ function createBibDataBase() { $x = new BibDataBase(); return $x;} } if (!function_exists('createBibEntry')) { /** factory method for openness @nodoc */ function createBibEntry() { $x = new BibEntry(); return $x;} } if (!function_exists('createBibDBBuilder')) { /** factory method for openness @nodoc */ function createBibDBBuilder() { $x = new BibDBBuilder(); return $x;} } if (!function_exists('createBasicDisplay')) { /** factory method for openness @nodoc */ function createBasicDisplay() { $x = new SimpleDisplay(); return $x;} } if (!function_exists('createBibEntryDisplay')) { /** factory method for openness @nodoc */ function createBibEntryDisplay() { $x = new BibEntryDisplay(); return $x;} } if (!function_exists('createMenuManager')) { /** factory method for openness @nodoc */ function createMenuManager() { $x = new MenuManager(); return $x;} } //////////////////////////////////////////////////////// /** is a generic parser of bibtex files. usage:

  $delegate = new XMLPrettyPrinter();// or another delegate such as BibDBBuilder
  $parser = new StateBasedBibtexParser($delegate);
  $parser->parse(fopen('bibacid-utf8.bib','r'));

notes: - It has no dependencies, it can be used outside of bibtexbrowser - The delegate is expected to have some methods, see classes BibDBBuilder and XMLPrettyPrinter */ class StateBasedBibtexParser { var $delegate; function __construct($delegate) { $this->delegate = $delegate; } function parse($handle) { if (gettype($handle) == 'string') { throw new Exception('oops'); } $delegate = $this->delegate; // 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',13); @define('GETVALUEDELIMITEDBYCURLYBRACKETS_3NESTEDLEVEL_ESCAPED',14); $state=NOTHING; $entrytype=''; $entrykey=''; $entryvalue=''; $fieldvaluepart=''; $finalkey=''; $entrysource=''; // metastate $isinentry = false; $delegate->beginFile(); // if you encounter this error "Allowed memory size of xxxxx bytes exhausted" // then decrease the size of the temp buffer below $bufsize=BUFFERSIZE; while (!feof($handle)) { $sread=fread($handle,$bufsize); //foreach(str_split($sread) as $s) { for ( $i=0; $i < strlen( $sread ); $i++) { $s=$sread[$i]; 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; $fieldvaluepart=''; $finalkey=$entrykey; $entrykey=''; } // oups we only have the key :-) anyway else if ($s=='}') { $state = NOTHING;$isinentry = false;$delegate->endEntry($entrysource); $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; } // the value is delimited by curly brackets else if ($s=='{') { $state = GETVALUEDELIMITEDBYCURLYBRACKETS; } // 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($finalkey,$entryvalue); $entryvalue=''; // resetting the value buffer } // this is the end of the value AND of the entry else if ($s=='}') { $state = NOTHING; $delegate->setEntryField($finalkey,$entryvalue); $isinentry = false;$delegate->endEntry($entrysource); $entryvalue=''; // resetting the value buffer } else if ($s==' ' || $s=="\t" || $s=="\n" || $s=="\r" ) { // blank characters are not taken into account when values are not in quotes or curly brackets } else { $entryvalue=$entryvalue.$s; } } /* 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; $entryvalue=$entryvalue.$s; $delegate->entryValuePart($finalkey,$fieldvaluepart,'CURLYTOP'); $fieldvaluepart=''; } else if ($s=='}') { // end entry $state = GETVALUE; $delegate->entryValuePart($finalkey,$fieldvaluepart,'CURLYTOP'); } else { $entryvalue=$entryvalue.$s; $fieldvaluepart=$fieldvaluepart.$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;$entryvalue=$entryvalue.$s;} else if ($s=='}') { $state = GETVALUEDELIMITEDBYCURLYBRACKETS; $delegate->entryValuePart($finalkey,$fieldvaluepart,'CURLYONE'); $fieldvaluepart=''; $entryvalue=$entryvalue.$s; } else { $entryvalue=$entryvalue.$s; $fieldvaluepart=$fieldvaluepart.$s; } } // handle anti-slashed brackets else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL_ESCAPED) { $state = GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL; $entryvalue=$entryvalue.$s; } // 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;$entryvalue=$entryvalue.$s;} else if ($s=='}') { $state = GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL;$entryvalue=$entryvalue.$s;} else { $entryvalue=$entryvalue.$s;} } // handle anti-slashed brackets else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL_ESCAPED) { $state = GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL; $entryvalue=$entryvalue.$s; } // 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;$entryvalue=$entryvalue.$s;} else { $entryvalue=$entryvalue.$s;} } // handle anti-slashed brackets else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_3NESTEDLEVEL_ESCAPED) { $state = GETVALUEDELIMITEDBYCURLYBRACKETS_3NESTEDLEVEL; $entryvalue=$entryvalue.$s; } /* handles entries delimited by double quotes */ else if ($state==GETVALUEDELIMITEDBYQUOTES) { if ($s=='\\') { $state = GETVALUEDELIMITEDBYQUOTES_ESCAPED; $entryvalue=$entryvalue.$s;} else if ($s=='"') { $state = GETVALUE; } else { $entryvalue=$entryvalue.$s;} } // handle anti-double quotes else if ($state==GETVALUEDELIMITEDBYQUOTES_ESCAPED) { $state = GETVALUEDELIMITEDBYQUOTES; $entryvalue=$entryvalue.$s; } } // end for } // end while $delegate->endFile(); //$d = $this->delegate;print_r($d); } // end function } // end class /** a default empty implementation of a delegate for StateBasedBibtexParser */ class ParserDelegate { function beginFile() {} function endFile() {} function setEntryField($finalkey,$entryvalue) {} function setEntryType($entrytype) {} function setEntryKey($entrykey) {} function beginEntry() {} function endEntry($entrysource) {} /** called for each sub parts of type {part} of a field value * for now, only CURLYTOP and CURLYONE events */ function entryValuePart($key, $value, $type) {} } // end class ParserDelegate /** is a possible delegate for StateBasedBibParser. usage: see snippet of [[#StateBasedBibParser]] */ class XMLPrettyPrinter extends ParserDelegate { function beginFile() { header('Content-type: text/xml;'); print ''; print ''; } function endFile() { print ''; } function setEntryField($finalkey,$entryvalue) { print "\n".$finalkey."\n".$entryvalue."\n\n"; } function setEntryType($entrytype) { print ''.$entrytype.''; } function setEntryKey($entrykey) { print ''.$entrykey.''; } function beginEntry() { print "\n"; } function endEntry($entrysource) { print "\n"; } } // end class XMLPrettyPrinter /** represents @string{k=v} */ class StringEntry { public $filename; public $name; public $value; function __construct($k, $v, $filename) { $this->name=$k; $this->value=$v; $this->filename=$filename; } function toString() { return '@string{'.$this->name.'={'.$this->value.'}}'; } } // end class StringEntry /** builds arrays of BibEntry objects from a bibtex file. usage:

  $empty_array = array();
  $db = new BibDBBuilder(); // see also factory method createBibDBBuilder
  $db->build('bibacid-utf8.bib'); // parses bib file
  print_r($db->builtdb);// an associated array key -> BibEntry objects
  print_r($db->stringdb);// an associated array key -> strings representing @string

notes: method build can be used several times, bibtex entries are accumulated in the builder */ class BibDBBuilder extends ParserDelegate { /** A hashtable from keys to bib entries (BibEntry). */ var $builtdb = array(); /** A hashtable of constant strings */ var $stringdb = array(); var $filename; var $currentEntry; function build($bibfilename, $handle = NULL) { $this->filename = $bibfilename; if ($handle == NULL) { $handle = fopen(DATA_DIR.$bibfilename, "r"); } if (!$handle) die ('cannot open '.$bibfilename); $parser = new StateBasedBibtexParser($this); $parser->parse($handle); fclose($handle); //print_r(array_keys($this->builtdb)); //print_r($this->builtdb); } function getBuiltDb() { //print_r($this->builtdb); return $this->builtdb; } function beginFile() { } function endFile() { // resolving crossrefs // we are careful with PHP 4 semantics foreach (array_keys($this->builtdb) as $key) { $bib = $this->builtdb[$key]; if ($bib->hasField('crossref')) { if (isset($this->builtdb[$bib->getField('crossref')])) { $crossrefEntry = $this->builtdb[$bib->getField('crossref')]; $bib->crossref = $crossrefEntry; foreach($crossrefEntry->getFields() as $k => $v) { // copying the fields of the cross ref // only if they don't exist yet if (!$bib->hasField($k)) { $bib->setField($k,$v); } } } } } //print_r($this->builtdb); } function setEntryField($fieldkey,$entryvalue) { $fieldkey=trim($fieldkey); // support for Bibtex concatenation // see http://newton.ex.ac.uk/tex/pack/bibtex/btxdoc/node3.html // (?$v) { // spaces are allowed when using # and they are not taken into account // however # is not itself replaced by a space // warning: @strings are not case sensitive // see http://newton.ex.ac.uk/tex/pack/bibtex/btxdoc/node3.html $stringKey=strtolower(trim($v)); if (isset($this->stringdb[$stringKey])) { // this field will be formated later by xtrim and latex2html $entryvalue_array[$k]=$this->stringdb[$stringKey]->value; // we keep a trace of this replacement // so as to produce correct bibtex snippets $this->currentEntry->constants[$stringKey]=$this->stringdb[$stringKey]->value; } } $entryvalue=implode('',$entryvalue_array); $this->currentEntry->setField($fieldkey,$entryvalue); } function setEntryType($entrytype) { $this->currentEntry->setType($entrytype); } function setEntryKey($entrykey) { //echo "new entry:".$entrykey."\n"; $this->currentEntry->setKey($entrykey); } function beginEntry() { $this->currentEntry = createBibEntry(); $this->currentEntry->setFile($this->filename); } function endEntry($entrysource) { // we add a timestamp $this->currentEntry->timestamp(); // we add a key if there is no key if (!$this->currentEntry->hasField(Q_KEY) && $this->currentEntry->getType()!='string') { $this->currentEntry->setField(Q_KEY,md5($entrysource)); } // we set the fulltext $this->currentEntry->text = $entrysource; // we format the author names in a special field // to enable search if ($this->currentEntry->hasField('author')) { $this->currentEntry->setField(Q_INNER_AUTHOR,$this->currentEntry->getFormattedAuthorsString()); foreach($this->currentEntry->getCanonicalAuthors() as $author) { $homepage_key = $this->currentEntry->getHomePageKey($author); if (isset($this->stringdb[$homepage_key])) { $this->currentEntry->homepages[$homepage_key] = $this->stringdb[$homepage_key]->value; } } } // ignoring jabref comments if (($this->currentEntry->getType()=='comment')) { /* do nothing for jabref comments */ } // we add it to the string database else if ($this->currentEntry->getType()=='string') { foreach($this->currentEntry->fields as $k => $v) { $k!=Q_INNER_TYPE and $this->stringdb[$k] = new StringEntry($k,$v,$this->filename); } } // we add it to the database else { $this->builtdb[$this->currentEntry->getKey()] = $this->currentEntry; } } } // end class BibDBBuilder /** is an extended version of the trim function, removes linebreaks, tabs, etc. */ function xtrim($line) { $line = trim($line); // we remove the unneeded line breaks // this is *required* to correctly split author lists into names // 2010-06-30 // bug found by Thomas // windows new line is **\r\n"** and not the other way around!! // according to php.net: Proncess \r\n's first so they aren't converted twice $line = str_replace(array("\r\n", "\r", "\n", "\t"), ' ', $line); // remove superfluous spaces e.g. John+++Bar $line = preg_replace('/ {2,}/',' ', $line); return $line; } /** encapsulates the conversion of a single latex chars to the corresponding HTML entity. It expects a **lower-case** char. */ function char2html($line,$latexmodifier,$char,$entitiyfragment) { $line = char2html_case_sensitive($line,$latexmodifier,strtoupper($char),$entitiyfragment); return char2html_case_sensitive($line,$latexmodifier,strtolower($char),$entitiyfragment); } function char2html_case_sensitive($line,$latexmodifier,$char,$entitiyfragment) { $line = preg_replace('/\\{?\\\\'.preg_quote($latexmodifier,'/').' ?\\{?'.$char.'\\}?/','&'.$char.''.$entitiyfragment.';', $line); return $line; } /** converts latex chars to HTML entities. (I still look for a comprehensive translation table from late chars to html, better than [[http://isdc.unige.ch/Newsletter/help.html]]) */ function latex2html($line, $do_clean_extra_bracket=true) { $line = preg_replace('/([^\\\\])~/','\\1 ', $line); $line = str_replace(array('---', '--'), array('—', '–'), $line); $line = str_replace(array('``', "''"), array('"', '"'), $line); // performance increases with this test // bug found by Serge Barral: what happens if we have curly braces only (typically to ensure case in Latex) // added && strpos($line,'{')===false if (strpos($line,'\\')===false && strpos($line,'{')===false) return $line; // handling uppercase // echo preg_replace_callback('!\b[a-z]!', 'upper', strtolower($str)); if (!function_exists("strtolowercallback")) { function strtolowercallback($array) { return strtolower($array[1]); } } if (!function_exists("strtouppercallback")) { function strtouppercallback($array) { return strtoupper($array[1]); } } $line = preg_replace_callback('/\\\\uppercase\{(.*)\}/U',"strtouppercallback", $line); $line = preg_replace_callback('/\\\\lowercase\{(.*)\}/U',"strtolowercallback", $line); $maths = array(); $index = 0; // first we escape the math env preg_match_all('/\$.*?\$/', $line, $matches); foreach ($matches[0] as $k) { $maths[] = $k; $line = str_replace($k, '__MATH'.$index.'__', $line); $index++; } // we should better replace this before the others // in order not to mix with the HTML entities coming after (just in case) $line = str_replace('\\&','&', $line); $line = str_replace('\_','_',$line); $line = str_replace('\%','%',$line); // handling \url{....} // often used in howpublished for @misc $line = preg_replace('/\\\\url\{(.*)\}/U','\\1', $line); // Friday, April 01 2011 // added support for accented i // for instance \`\i // see http://en.wikibooks.org/wiki/LaTeX/Accents // " the letters "i" and "j" require special treatment when they are given accents because it is often desirable to replace the dot with the accent. For this purpose, the commands \i and \j can be used to produce dotless letters." $line = preg_replace('/\\\\([ij])/i','\\1', $line); $line = char2html($line,"'",'a',"acute"); $line = char2html($line,"'",'c',"acute"); $line = char2html($line,"'",'e',"acute"); $line = char2html($line,"'",'i',"acute"); $line = char2html($line,"'",'o',"acute"); $line = char2html($line,"'",'u',"acute"); $line = char2html($line,"'",'y',"acute"); $line = char2html($line,"'",'n',"acute"); $line = char2html($line,'`','a',"grave"); $line = char2html($line,'`','e',"grave"); $line = char2html($line,'`','i',"grave"); $line = char2html($line,'`','o',"grave"); $line = char2html($line,'`','u',"grave"); $line = char2html($line,'~','a',"tilde"); $line = char2html($line,'~','n',"tilde"); $line = char2html($line,'~','o',"tilde"); $line = char2html($line,'"','a',"uml"); $line = char2html($line,'"','e',"uml"); $line = char2html($line,'"','i',"uml"); $line = char2html($line,'"','o',"uml"); $line = char2html($line,'"','u',"uml"); $line = char2html($line,'"','y',"uml"); $line = char2html($line,'"','s',"zlig"); $line = char2html($line,'^','a',"circ"); $line = char2html($line,'^','e',"circ"); $line = char2html($line,'^','i',"circ"); $line = char2html($line,'^','o',"circ"); $line = char2html($line,'^','u',"circ"); $line = char2html($line,'r','a',"ring"); $line = char2html($line,'c','c',"cedil"); $line = char2html($line,'c','s',"cedil"); $line = char2html($line,'v','s',"caron"); $line = str_replace('\\ae','æ', $line); $line = str_replace('\\ss','ß', $line); $line = str_replace('\\o','ø', $line); $line = str_replace('\\O','Ø', $line); $line = str_replace('\\aa','å', $line); $line = str_replace('\\AA','Å', $line); $line = str_replace('\\l','ł',$line); $line = str_replace('\\L','Ł',$line); $line = str_replace('\\k{a}','ą',$line); $line = str_replace('\\\'{c}','ć',$line); $line = str_replace('\\v{c}','č',$line); $line = str_replace('\\v{C}','Č',$line); // handling \textsuperscript{....} FAILS if there still are nested {} $line = preg_replace('/\\\\textsuperscript\{(.*)\}/U','^\\1', $line); // handling \textsubscript{....} FAILS if there still are nested {} $line = preg_replace('/\\\\textsubscript\{(.*)\}/U','_\\1', $line); if ($do_clean_extra_bracket) { // clean extra tex curly brackets, usually used for preserving capitals // must come before the final math replacement $line = str_replace('}','',$line); $line = str_replace('{','',$line); } // we restore the math env for($i = 0; $i < count($maths); $i++) { $line = str_replace('__MATH'.$i.'__', $maths[$i], $line); } return $line; } /** encodes strings for Z3988 URLs. Note that & are encoded as %26 and not as &. */ function s3988($s) { if ($s == null) return ''; // first remove the HTML entities (e.g. é) then urlencode them return urlencode($s); } /** see BibEntry->formatAuthor($author) @deprecated @nodoc */ function formatAuthor() { die('Sorry, this function does not exist anymore, however, you can simply use $bibentry->formatAuthor($author) instead.'); } // ---------------------------------------------------------------------- // BIB ENTRIES // ---------------------------------------------------------------------- /** represents a bibliographic entry. usage:

  $db = zetDB('bibacid-utf8.bib');
  $entry = $db->getEntryByKey('classical');
  echo bib2html($entry);

notes: - BibEntry are usually obtained with getEntryByKey or multisearch */ class BibEntry { /** The fields (fieldName -> value) of this bib entry with Latex macros interpreted and encoded in the desired character set . */ var $fields = array(); /** The raw fields (fieldName -> value) of this bib entry. */ var $raw_fields = array(); /** The constants @STRINGS referred to by this entry */ var $constants = array(); /** The homepages of authors if any */ var $homepages = array(); /** The crossref entry if there is one */ var $crossref; /** The verbatim copy (i.e., whole text) of this bib entry. */ var $text = ''; /** A timestamp to trace when entries have been created */ var $timestamp; /** The name of the file containing this entry */ var $filename; /** The short name of the entry (parameterized by ABBRV_TYPE) */ var $abbrv; /** The index in a list of publications (e.g. [1] Foo */ var $index = ''; /** The location in the original bibtex file (set by addEntry) */ var $order = -1; /** returns a debug string representation */ function __toString() { return $this->getType()." ".$this->getKey(); } /** Creates an empty new bib entry. Each bib entry is assigned a unique * identification number. */ function __construct() { } /** Sets the name of the file containing this entry */ function setFile($filename) { $this->filename = $filename; return $this; } /** Adds timestamp to this object */ function timestamp() { $this->timestamp = time(); } /** Returns the timestamp of this object */ function getTimestamp() { return $this->timestamp; } /** Returns the type of this bib entry (always lowercase). */ function getType() { // strtolower is important to be case-insensitive return strtolower($this->getField(Q_INNER_TYPE)); } /** Sets the key of this bib entry. */ function setKey($value) { // Slashes are not allowed in keys because they don't play well with web servers // if url-rewriting is used $this->setField(Q_KEY,str_replace('/','-',$value)); } function transformValue($value) { if (c('BIBTEXBROWSER_USE_LATEX2HTML')) { // trim space $value = xtrim($value); // transform Latex markup to HTML entities (easier than a one to one mapping to each character) // HTML entity is an intermediate format $value = latex2html($value); // transform to the target output encoding $value = html_entity_decode($value, ENT_QUOTES|ENT_XHTML, OUTPUT_ENCODING); } return $value; } /** removes a field from this bibtex entry */ function removeField($name) { $name = strtolower($name); unset($this->raw_fields[$name]); unset($this->fields[$name]); } /** Sets a field of this bib entry. */ function setField($name, $value) { $name = strtolower($name); $this->raw_fields[$name] = $value; // fields that should not be transformed // we assume that "comment" is never latex code // but instead could contain HTML code (with links using the character "~" for example) // so "comment" is not transformed too if ($name!='url' && $name!='comment' && !preg_match('/^hp_/',$name) // homepage links should not be transformed with latex2html ) { $value = $this->transformValue($value); // 4. transform existing encoded character in the new format if (function_exists('mb_convert_encoding') && OUTPUT_ENCODING != BIBTEX_INPUT_ENCODING) { $value = mb_convert_encoding($value, OUTPUT_ENCODING, BIBTEX_INPUT_ENCODING); } } else { //echo "xx".$value."xx\n"; } $this->fields[$name] = $value; } function clean_top_curly($value) { $value = preg_replace('/^\{/','', $value); $value = preg_replace('/\}$/','', $value); return $value; } /** Sets a type of this bib entry. */ function setType($value) { // 2009-10-25 added trim // to support space e.g. "@article {" // as generated by ams.org // thanks to Jacob Kellner $this->fields[Q_INNER_TYPE] = trim($value); } function setIndex($index) { $this->index = $index; } /** Tries to build a good URL for this entry. The URL should be absolute (better for the generated RSS) */ function getURL() { if (defined('BIBTEXBROWSER_URL_BUILDER')) { $f = BIBTEXBROWSER_URL_BUILDER; return $f($this); } // echo $this->filename; // echo $this->getKey(); return BIBTEXBROWSER_URL.'?'.createQueryString(array(Q_KEY=>$this->getKey(), Q_FILE=>$this->filename)); } /** @see bib2links(), kept for backward compatibility */ function bib2links() { return bib2links($this); } /** Read the bibtex field $bibfield and return a link with icon (if $iconurl is given) or text * e.g. given the bibtex entry: @article{myarticle, pdf={myarticle.pdf}}, * $bibtexentry->getLink('pdf') creates a link to myarticle.pdf using the text '[pdf]'. * $bibtexentry->getLink('pdf','pdficon.png') returns <a href="myarticle.pdf"><img src="pdficon.png"/></a> * if you want a label that is different from the bibtex field, add a third parameter. */ function getLink($bibfield,$iconurl=NULL,$altlabel=NULL) { $show = true; if ($altlabel==NULL) { $altlabel=$bibfield; } $str = $this->getIconOrTxt($altlabel,$iconurl); if ($this->hasField($bibfield)) { return ''.$str.''; } return ''; } /** returns a "[bib]" link */ function getBibLink($iconurl=NULL) { $bibstr = $this->getIconOrTxt('bibtex',$iconurl); $href = 'href="'.$this->getURL().'"'; // we add biburl and title to be able to retrieve this important information // using Xpath expressions on the XHTML source $link = 'getKey()."\" {$href}>$bibstr"; return $link; } /** kept for backward compatibility */ function getPdfLink($iconurl = NULL, $label = NULL) { return $this->getUrlLink($iconurl); } /** returns a "[pdf]" link for the entry, if possible. Tries to get the target URL from the 'pdf' field first, then from 'url' or 'file'. Performs a sanity check that the file extension is 'pdf' or 'ps' and uses that as link label. Otherwise (and if no explicit $label is set) the field name is used instead. */ function getUrlLink($iconurl = NULL) { if ($this->hasField('pdf')) { return $this->getAndRenameLink('pdf', $iconurl); } if ($this->hasField('url')) { return $this->getAndRenameLink('url', $iconurl); } // Adding link to PDF file exported by Zotero // ref: https://github.com/monperrus/bibtexbrowser/pull/14 if ($this->hasField('file')) { return $this->getAndRenameLink('file', $iconurl); } return ""; } /** See description of 'getUrlLink' */ function getAndRenameLink($bibfield, $iconurl=NULL) { $extension = strtolower(pathinfo(parse_url($this->getField($bibfield),PHP_URL_PATH),PATHINFO_EXTENSION)); switch ($extension) { // overriding the label if it's a known extension case 'html': return $this->getLink($bibfield, $iconurl, 'html'); break; case 'pdf': return $this->getLink($bibfield, $iconurl, 'pdf'); break; case 'ps': return $this->getLink($bibfield, $iconurl, 'ps'); break; default: return $this->getLink($bibfield, $iconurl, $bibfield); } } /** DOI are a special kind of links, where the url depends on the doi */ function getDoiLink($iconurl=NULL) { $str = $this->getIconOrTxt('doi',$iconurl); if ($this->hasField('doi')) { return ''.$str.''; } return ''; } /** GS (Google Scholar) are a special kind of links, where the url depends on the google scholar id */ function getGSLink($iconurl=NULL) { $str = $this->getIconOrTxt('citations',$iconurl); if ($this->hasField('gsid')) { return ' '.$str.''; } return ''; } /** replace [$ext] with an icon whose url is defined in a string * e.g. getIconOrTxt('pdf') will print '[pdf]' * or getIconOrTxt('pdf','http://link/to/icon.png') will use the icon linked by the url, or print '[pdf'] * if the url does not point to a valid file (using the "alt" property of the "img" html tag) */ function getIconOrTxt($txt,$iconurl=NULL) { if ( $iconurl==NULL ) { $str='['.$txt.']'; } else { $str=''; } return $str; } /** Reruns the abstract */ function getAbstract() { if ($this->hasField('abstract')) return $this->getField('abstract'); else return ''; } /** * Returns the last name of an author name. */ function getLastName($author){ list($firstname, $lastname) = splitFullName($author); return $lastname; } /** * Returns the first name of an author name. */ function getFirstName($author){ list($firstname, $lastname) = splitFullName($author); return $firstname; } /** Has this entry the given field? */ function hasField($name) { return isset($this->fields[strtolower($name)]); } /** Returns the authors of this entry. If "author" is not given, * return a string 'Unknown'. */ function getAuthor() { if (array_key_exists(AUTHOR, $this->fields)) { return $this->getFormattedAuthorsString(); } // 2010-03-02: commented the following, it results in misleading author lists // issue found by Alan P. Sexton //if (array_key_exists(EDITOR, $this->fields)) { // return $this->fields[EDITOR]; //} return 'Unknown'; } /** Returns the key of this entry */ function getKey() { return $this->getField(Q_KEY); } /** Returns the title of this entry? */ function getTitle() { return $this->getField('title'); } /** Returns the publisher of this entry * It encodes a specific logic * */ function getPublisher() { // citation_publisher if ($this->hasField("publisher")) { return $this->getField("publisher"); } if ($this->getType()=="phdthesis") { return $this->getField(SCHOOL); } if ($this->getType()=="mastersthesis") { return $this->getField(SCHOOL); } if ($this->getType()=="bachelorsthesis") { return $this->getField(SCHOOL); } if ($this->getType()=="techreport") { return $this->getField("institution"); } // then we don't know return ''; } /** Returns the authors of this entry as an array (split by " and ") */ function getRawAuthors() { return $this->split_names(Q_AUTHOR); } // Previously called split_authors. Made generic to allow call on editors as well. function split_names($key) { if (!array_key_exists($key, $this->raw_fields)) return array(); // Sometimes authors/editors are split by line breaks followed by whitespace in bib files. // In this case we need to replace these with a normal space. $raw = preg_replace( '/\s+/', ' ', @$this->raw_fields[$key]); $array = preg_split('/ and( |$)/ims', $raw); $res = array(); // we merge the remaining ones for ($i=0; $i < count($array)-1; $i++) { if (strpos( latex2html($array[$i],false), '{') !== FALSE && strpos(latex2html($array[$i+1],false),'}') !== FALSE) { $res[] = $this->clean_top_curly(trim($array[$i])." and ".trim($array[$i+1])); $i = $i + 1; } else { $res[] = trim($array[$i]); } } $res[] = trim($array[count($array)-1]); return $res; } /** * Returns the formated author name w.r.t to the user preference * encoded in USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT and USE_INITIALS_FOR_NAMES */ function formatAuthor($author){ $author = $this->transformValue($author); if (bibtexbrowser_configuration('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT')) { return $this->formatAuthorCommaSeparated($author); } if (bibtexbrowser_configuration('USE_INITIALS_FOR_NAMES')) { return $this->formatAuthorInitials($author); } if (bibtexbrowser_configuration('USE_FIRST_THEN_LAST')) { return $this->formatAuthorCanonical($author); } return $author; } /** * Returns the formated author name as "FirstName LastName". */ function formatAuthorCanonical($author){ list($firstname, $lastname) = splitFullName($author); if ($firstname!='') return $firstname.' '.$lastname; else return $lastname; } /** * Returns the formated author name as "LastName, FirstName". */ function formatAuthorCommaSeparated($author){ list($firstname, $lastname) = splitFullName($author); if ($firstname!='') return $lastname.', '.$firstname; else return $lastname; } /** * Returns the formated author name as "LastName Initials". * e.g. for Vancouver-style used by PubMed. */ function formatAuthorInitials($author){ list($firstname, $lastname) = splitFullName($author); if ($firstname!='') return $lastname.' '.preg_replace("/(\p{Lu})\w*[- ]*/Su","$1", $firstname); else return $lastname; } /** @deprecated */ function formattedAuthors() { return $this->getFormattedAuthorsString(); } /** @deprecated */ function getFormattedAuthors() { return $this->getFormattedAuthorsArray(); } /** @deprecated */ function getFormattedAuthorsImproved() { return $this->getFormattedAuthorsString(); } /** Returns the authors as an array of strings (one string per author). */ function getFormattedAuthorsArray() { $array_authors = array(); // first we use formatAuthor foreach ($this->getRawAuthors() as $author) { $array_authors[]=$this->formatAuthor($author); } if (BIBTEXBROWSER_AUTHOR_LINKS=='homepage') { foreach ($array_authors as $k => $author) { $array_authors[$k]=$this->addHomepageLink($author); } } if (BIBTEXBROWSER_AUTHOR_LINKS=='resultpage') { foreach ($array_authors as $k => $author) { $array_authors[$k]=$this->addAuthorPageLink($author); } } return $array_authors; } /** Adds to getFormattedAuthors() the home page links and returns a string (not an array). Is configured with BIBTEXBROWSER_AUTHOR_LINKS and USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT. */ function getFormattedAuthorsString() { return $this->implodeAuthors($this->getFormattedAuthorsArray()); } function implodeAuthors($authors) { if (count($authors)==0) return ''; if (count($authors)==1) return $authors[0]; $result = ''; if (bibtexbrowser_configuration('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT')) {$sep = '; ';} else {$sep = ', ';} if (FORCE_NAMELIST_SEPARATOR !== '') {$sep = FORCE_NAMELIST_SEPARATOR;} for ($i=0;$i2) { $lastAuthorSeperator = $sep.$lastAuthorSeperator; $lastAuthorSeperator = preg_replace("/ {2,}/", " ", $lastAuthorSeperator); // get rid of double spaces } $result .= $authors[count($authors)-2].$lastAuthorSeperator.$authors[count($authors)-1]; return $result; } /** adds a link to the author page */ function addAuthorPageLink($author) { $link = makeHref(array(Q_AUTHOR => $author)); return "$author"; } /** Returns the authors of this entry as an array in a canonical form */ function getCanonicalAuthors() { $authors = array(); foreach ($this->getRawAuthors() as $author) { $authors[]=$this->formatAuthorCanonical($author); } return $authors; } /** Returns the authors of this entry as an array in a comma-separated form * Mostly used to create meta tags (eg */ function getArrayOfCommaSeparatedAuthors() { $authors = array(); foreach ($this->getRawAuthors() as $author) { $author = $this->transformValue($author); $authors[]=$this->formatAuthorCommaSeparated($author); } return $authors; } /** * Returns a compacted string form of author names by throwing away * all author names except for the first one and appending ", et al." */ function getCompactedAuthors(){ $authors = $this->getRawAuthors(); $etal = count($authors) > 1 ? ', et al.' : ''; return $this->formatAuthor($authors[0]) . $etal; } function getHomePageKey($author) { return strtolower('hp_'.preg_replace('/ /', '', $this->formatAuthorCanonical(latex2html($author)))); } /** add the link to the homepage if it is defined in a string * e.g. @string{hp_MartinMonperrus="http://www.monperrus.net/martin"} * The string is a concatenation of firstname, lastname, prefixed by hp_ * Warning: by convention @string are case sensitive so please be keep the same case as author names * @thanks Eric Bodden for the idea */ function addHomepageLink($author) { // hp as home page // accents are normally handled // e.g. @STRING{hp_Jean-MarcJézéquel="http://www.irisa.fr/prive/jezequel/"} $homepage = $this->getHomePageKey($author); if (isset($this->homepages[$homepage])) $author=''.$author.''; return $author; } /** Returns the editors of this entry as an arry */ function getEditors() { $editors = array(); foreach (preg_split('/ and /i', $this->getField(EDITOR)) as $editor) { $editors[]=$editor; } return $editors; } /** Returns the editors of this entry as an array (split by " and ") */ function getRawEditors() { return $this->split_names(EDITOR); } /** Returns the editors of this entry as an arry */ function getFormattedEditors() { $editors = array(); foreach ($this->getEditors() as $editor) { $editors[]=$this->formatAuthor($editor); } if (bibtexbrowser_configuration('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT')) {$sep = '; ';} else {$sep = ', ';} if (FORCE_NAMELIST_SEPARATOR !== '') {$sep = FORCE_NAMELIST_SEPARATOR;} return implode($sep, $editors).', '.(count($editors)>1?'eds.':'ed.'); } /** Returns the year of this entry? */ function getYear() { return __(strtolower($this->getYearRaw())); } function getYearRaw() { $r = $this->getField('year'); if ($r == null) return ''; return $r; } /** returns the array of keywords */ function getKeywords() { return preg_split('/[,;\\/]/', $this->getField("keywords")); } /** Returns the value of the given field? */ function getField($name) { // 2010-06-07: profiling showed that this is very costly // hence returning the value directly //if ($this->hasField($name)) // {return $this->fields[strtolower($name)];} //else return 'missing '.$name; return @$this->fields[strtolower($name)]; } /** Returns the fields */ function getFields() { return $this->fields; } /** Returns the raw, undecorated abbreviation depending on ABBRV_TYPE. */ function getRawAbbrv() { if (c('ABBRV_TYPE') == 'index') return $this->index; if (c('ABBRV_TYPE') == 'none') return ''; if (c('ABBRV_TYPE') == 'key') return $this->getKey(); if (c('ABBRV_TYPE') == 'year') return $this->getYear(); if (c('ABBRV_TYPE') == 'x-abbrv') { if ($this->hasField('x-abbrv')) {return $this->getField('x-abbrv');} return $this->abbrv; } if (c('ABBRV_TYPE') == 'keys-index') { if (isset($_GET[Q_INNER_KEYS_INDEX])) {return $_GET[Q_INNER_KEYS_INDEX][$this->getKey()]; } return ''; } // otherwise it is a user-defined function in bibtexbrowser.local.php $f = c('ABBRV_TYPE'); return $f($this); } /** Returns the abbreviation, etc [1] if ABBRV_TYPE='index'. */ function getAbbrv() { $abbrv = $this->getRawAbbrv(); if ( c('ABBRV_TYPE') != 'none' ) { $abbrv = '['.$abbrv.']'; } return $abbrv; } /** Sets the abbreviation (e.g. [OOPSLA] or [1]) */ function setAbbrv($abbrv) { //if (!is_string($abbrv)) { throw new Exception('Illegal argument'); } $this->abbrv = $abbrv; return $this; } /** Returns the verbatim text of this bib entry. */ function getText() { if (c('BIBTEXBROWSER_BIBTEX_VIEW') == 'original') { return $this->text; } if (c('BIBTEXBROWSER_BIBTEX_VIEW') == 'reconstructed') { $result = '@'.$this->getType().'{'.$this->getKey().",\n"; foreach ($this->raw_fields as $k=>$v) { if ( !preg_match('/^('.c('BIBTEXBROWSER_BIBTEX_VIEW_FILTEREDOUT').')$/i', $k) && !preg_match('/^(key|'.Q_INNER_AUTHOR.'|'.Q_INNER_TYPE.')$/i', $k) ) { $result .= ' '.$k.' = {'.$v.'},'."\n"; } } $result .= "}\n"; return $result; } throw new Exception('incorrect value of BIBTEXBROWSER_BIBTEX_VIEW: '+BIBTEXBROWSER_BIBTEX_VIEW); } /** Returns true if this bib entry contains the given phrase (PREG regexp) * in the given field. if $field is null, all fields are considered. * Note that this method is NOT case sensitive */ function hasPhrase($phrase, $field = null) { // we have to search in the formatted fields and not in the raw entry // i.e. all latex markups are not considered for searches if (!$field) { return preg_match('/'.$phrase.'/i',$this->getConstants().' '.join(" ",$this->getFields())); //return stripos($this->getText(), $phrase) !== false; } if ($this->hasField($field) && (preg_match('/'.$phrase.'/i',$this->getField($field)) ) ) { //if ($this->hasField($field) && (stripos($this->getField($field), $phrase) !== false) ) { return true; } return false; } /** Outputs HTML line according to layout */ function toHTML($wrapped=false) { $result = ''; if ($wrapped) { switch(BIBTEXBROWSER_LAYOUT) { // open row case 'list': $result .= '

'; break; case 'ordered_list': $result .= '

'; break; case 'table': $result .= '

 text of the given bib entry.
   * URLs are replaced by HTML links.
   */
  function toEntryUnformatted() {
    $result = "";
    $result .= '
'; // pre is nice when it is embedded with no CSS available
    $entry = htmlspecialchars($this->getFullText(),ENT_NOQUOTES|ENT_XHTML, OUTPUT_ENCODING);

    // Fields that should be hyperlinks
    // the order matters
    $hyperlinks = array('url' => '%O', 'file' => '%O', 'pdf' => '%O', 'doi' => 'https://doi.org/%O', 'gsid' => 'https://scholar.google.com/scholar?cites=%O');

    $vals = array();
    foreach ($hyperlinks as $field => $url) {
      if ($this->hasField($field)) {
        $href = str_replace('%O', $this->getField($field), $url);
        // this is not a parsing but a simple replacement
        $entry = str_replace($this->getField($field), '___'.$field.'___', $entry);
        $vals[$field] = $href;
      }
    }
    foreach ($vals as $field => $href) {
      if ($this->hasField($field)) {
        // this is not a parsing but a simple replacement
        $entry = str_replace('___'.$field.'___', ''.$this->getField($field).'', $entry);
      }
    }

    $result .=  $entry;
    $result .=  '
';
    return $result;
   }

   /**
   * Gets the raw text of the entry (crossref + strings + entry)
   */
  function getFullText() {
    $s = '';
    // adding the crossref if necessary
    if ($this->crossref!=null) { $s .= $this->crossref->getFullText()."\n";}
    $s.=$this->getConstants();
    $s.=$this->getText();
    return $s;
  }

  /** returns the first and last page of the entry as an array ([0]->first,  [2]->last) */
  function getPages() {
    preg_match('/([0-9]+).*?([0-9]+)/',$this->getField('pages'),$matches);
    array_shift($matches);
    return $matches;
  }

  /** returns in the citation file format, tailored for github */
  function toCFF() {
    $result = "";
    $result .= "cff-version: 1.2.0"."\n";
    $result .= "# CITATION.cff created with https://github.com/monperrus/bibtexbrowser/"."\n";
    $result .= "preferred-citation:"."\n";
    $result .= "  title: \"".$this->getTitle()."\""."\n";
    if ($this->hasField("doi")) {
        $result .= "  doi: \"".$this->getField("doi")."\""."\n";
    }
    if ($this->hasField("year")) {
        $result .= "  year: \"".$this->getField("year")."\""."\n";
    }
    if ($this->hasField("journal")) {
        $result .= "  type: article\n";
        $result .= "  journal: \"".$this->getField("journal")."\""."\n";
    }
    if ($this->hasField("booktitle")) {
        $result .= "  type: conference-paper\n";
        $result .= "  conference: \"".$this->getField("booktitle")."\""."\n";
    }
    $result .= "  authors:"."\n";
    foreach ($this->getFormattedAuthorsArray() as $author) {
        $split = splitFullName($author);
        $result .= "    - family-names: ".$split[1]."\n";
        $result .= "      given-names: ".$split[0]."\n";
    }
    return $result;
  }
  
  
} // end class BibEntry

class RawBibEntry extends BibEntry {
  function setField($name, $value) {
    $this->fields[$name]=$value;
    $this->raw_fields[$name]=$value;
  }
}

/** returns an HTML tag depending on BIBTEXBROWSER_LAYOUT e.g. 

@define('BIBLIOGRAPHYSTYLE','JanosBibliographyStyle');

@define('BIBLIOGRAPHYSTYLE','VancouverBibliographyStyle');
@define('USE_INITIALS_FOR_NAMES',true);

  $_GET['library']=1;
  $_GET['bib']='bibacid-utf8.bib';
  $_GET['all']=1;
  include( 'bibtexbrowser.php' );
  setDB();
  new IndependentYearMenu($_GET[Q_DB]);

  $db = zetDB('bibacid-utf8.bib');
  $d = new NewEntriesDisplay();
  $d->setDB($db);
  $d->setN(7);// optional
  $d->display();

  $db = zetDB('bibacid-utf8.bib');
  $d = new YearDisplay();
  $d->setDB($db);
  $d->display();

  $db = zetDB('bibacid-utf8.bib');
  $d = new SimpleDisplay();
  $d->setDB($db);
  $d->display();