fm
/
zrd-bibtexbrowser
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

improves author parsing and formatting, fixes #61

pull/63/merge
Martin Monperrus 9 years ago
parent
1465b13198
commit
86c8c5fd52
2 changed files with 311 additions and 74 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 150
      bibtexbrowser-test.php
  2. 217
      bibtexbrowser.php

150
bibtexbrowser-test.php
View File

@ -12,8 +12,8 @@ $ phpunit --coverage-html ./coverage btb-test.php
$_GET['library']=1; $_GET['library']=1;
copy('bibtexbrowser.local.php','bibtexbrowser.local.php.bak');
unlink('bibtexbrowser.local.php');
@copy('bibtexbrowser.local.php','bibtexbrowser.local.php.bak');
@unlink('bibtexbrowser.local.php');
require_once ('bibtexbrowser.php'); require_once ('bibtexbrowser.php');
@ -23,8 +23,9 @@ class BTBTest extends PHPUnit_Framework_TestCase {
function createDB() { function createDB() {
$test_data = fopen('php://memory','x+'); $test_data = fopen('php://memory','x+');
fwrite($test_data, "@book{aKey,title={A Book},author={Martin Monperrus},publisher={Springer},year=2009}\n".
"@book{aKey/withSlash,title={Slash Dangerous for web servers},author={Ap Ache},publisher={Springer},year=2009}\n"
fwrite($test_data, "@book{aKey,title={A Book},author={Martin Monperrus},publisher={Springer},year=2009}\n"
."@book{aKey/withSlash,title={Slash Dangerous for web servers},author={Ap Ache},publisher={Springer},year=2009}\n"
."@article{aKeyA,title={An Article},author={Foo Bar and Jane Doe},volume=5,journal=\"New Results\",year=2009}\n"
); );
fseek($test_data,0); fseek($test_data,0);
$btb = new BibDataBase(); $btb = new BibDataBase();
@ -33,13 +34,44 @@ class BTBTest extends PHPUnit_Framework_TestCase {
} }
function test_bibentry_to_html() {
function test_bibentry_to_html_book() {
$btb = $this->createDB(); $btb = $this->createDB();
$first_entry=$btb->bibdb[array_keys($btb->bibdb)[0]];
$first_entry=$btb->getEntryByKey('aKey');
// default style
$this->assertEquals("A Book (Martin Monperrus), Springer, 2009. [bibtex]",strip_tags($first_entry->toHTML()));
$this->assertEquals('<span itemscope="" itemtype="http://schema.org/ScholarlyArticle"><span class="bibtitle" itemprop="name">A Book</span> (<span class="bibauthor"><span itemprop="author" itemtype="http://schema.org/Person">Martin Monperrus</span></span>), <span class="bibpublisher">Springer</span>, <span itemprop="datePublished">2009</span>.<span class="Z3988" title="ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&amp;rft.btitle=A+Book&amp;rft.genre=book&amp;rft.pub=Springer&amp;rfr_id=info%3Asid%2F%3A&amp;rft.date=2009&amp;rft.au=Martin+Monperrus"></span></span> <span class="bibmenu"><a class="biburl" title="aKey" href="bibtexbrowser.php?key=aKey&amp;bib=inline">[bibtex]</a></span>',$first_entry->toHTML());
// IEEE style
bibtexbrowser_configure('BIBLIOGRAPHYSTYLE','JanosBibliographyStyle');
$this->assertEquals("Martin Monperrus, \"A Book\", Springer, 2009.\n [bibtex]",strip_tags($first_entry->toHTML()));
// Vancouver style
bibtexbrowser_configure('BIBLIOGRAPHYSTYLE','VancouverBibliographyStyle');
$this->assertEquals("Martin Monperrus. A Book. Springer; 2009.\n [bibtex]",strip_tags($first_entry->toHTML()));
// other methods
$this->assertEquals('<span class="bibmenu"><a class="biburl" title="aKey" href="bibtexbrowser.php?key=aKey&amp;bib=inline">[bibtex]</a></span>',$first_entry->bib2links()); $this->assertEquals('<span class="bibmenu"><a class="biburl" title="aKey" href="bibtexbrowser.php?key=aKey&amp;bib=inline">[bibtex]</a></span>',$first_entry->bib2links());
$this->assertEquals('<a class="bibanchor" name=""></a>',$first_entry->anchor()); $this->assertEquals('<a class="bibanchor" name=""></a>',$first_entry->anchor());
} }
function test_bibentry_to_html_article() {
$btb = $this->createDB();
$first_entry=$btb->getEntryByKey('aKeyA');
// default style
$this->assertEquals("An Article (Foo Bar and Jane Doe), In New Results, volume 5, 2009. [bibtex]",strip_tags($first_entry->toHTML()));
$this->assertEquals('<span itemscope="" itemtype="http://schema.org/ScholarlyArticle"><span class="bibtitle" itemprop="name">An Article</span> (<span class="bibauthor"><span itemprop="author" itemtype="http://schema.org/Person">Foo Bar</span> and <span itemprop="author" itemtype="http://schema.org/Person">Jane Doe</span></span>), <span class="bibbooktitle">In <span itemprop="isPartOf">New Results</span></span>, volume 5, <span itemprop="datePublished">2009</span>.<span class="Z3988" title="ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&amp;rft.atitle=An+Article&amp;rft.jtitle=New+Results&amp;rft.volume=5&amp;rft.issue=&amp;rft.pub=&amp;rfr_id=info%3Asid%2F%3A&amp;rft.date=2009&amp;rft.au=Foo+Bar&amp;rft.au=Jane+Doe"></span></span> <span class="bibmenu"><a class="biburl" title="aKeyA" href="bibtexbrowser.php?key=aKeyA&amp;bib=inline">[bibtex]</a></span>',$first_entry->toHTML());
// IEEE style
bibtexbrowser_configure('BIBLIOGRAPHYSTYLE','JanosBibliographyStyle');
$this->assertEquals("Foo Bar and Jane Doe, \"An Article\", In New Results, vol. 5, 2009.\n [bibtex]",strip_tags($first_entry->toHTML()));
// Vancouver style
bibtexbrowser_configure('BIBLIOGRAPHYSTYLE','VancouverBibliographyStyle');
$this->assertEquals("Foo Bar and Jane Doe. An Article. New Results. 2009;5.\n [bibtex]",strip_tags($first_entry->toHTML()));
}
function testMultiSearch() { function testMultiSearch() {
$btb = $this->createDB(); $btb = $this->createDB();
$q=array(Q_AUTHOR=>'monperrus'); $q=array(Q_AUTHOR=>'monperrus');
@ -67,16 +99,17 @@ class BTBTest extends PHPUnit_Framework_TestCase {
$this->assertTrue(config_value('BIBTEXBROWSER_NO_DEFAULT')); $this->assertTrue(config_value('BIBTEXBROWSER_NO_DEFAULT'));
ob_start(); ob_start();
default_message(); default_message();
$this->assertEquals('', ob_get_flush());
$this->assertEquals('', ob_get_clean());
// setting to false // setting to false
bibtexbrowser_configure('BIBTEXBROWSER_NO_DEFAULT', false); bibtexbrowser_configure('BIBTEXBROWSER_NO_DEFAULT', false);
$this->assertFalse(config_value('BIBTEXBROWSER_NO_DEFAULT')); $this->assertFalse(config_value('BIBTEXBROWSER_NO_DEFAULT'));
ob_start(); ob_start();
default_message(); default_message();
$this->assertContains('Congratulations', ob_get_flush());
$this->assertContains('Congratulations', ob_get_clean());
} }
function testInternationalization() { function testInternationalization() {
$btb = $this->createDB(); $btb = $this->createDB();
global $BIBTEXBROWSER_LANG; global $BIBTEXBROWSER_LANG;
@ -89,7 +122,7 @@ class BTBTest extends PHPUnit_Framework_TestCase {
$d->setDB($btb); $d->setDB($btb);
ob_start(); ob_start();
$d->display(); $d->display();
$data = ob_get_flush();
$data = ob_get_clean();
$this->assertContains('Livres', $data); $this->assertContains('Livres', $data);
} }
@ -270,6 +303,7 @@ class BTBTest extends PHPUnit_Framework_TestCase {
$this->assertEquals("\`a Book",$dis->getTitle()); $this->assertEquals("\`a Book",$dis->getTitle());
} }
function test_PagedDisplay() { function test_PagedDisplay() {
$PAGE_SIZE = 3; $PAGE_SIZE = 3;
bibtexbrowser_configure('BIBTEXBROWSER_DEFAULT_DISPLAY', 'PagedDisplay'); bibtexbrowser_configure('BIBTEXBROWSER_DEFAULT_DISPLAY', 'PagedDisplay');
@ -279,7 +313,7 @@ class BTBTest extends PHPUnit_Framework_TestCase {
$d = new Dispatcher(); $d = new Dispatcher();
ob_start(); ob_start();
$d->main(); $d->main();
$content = "<div>".ob_get_flush()."</div>";
$content = "<div>".ob_get_clean()."</div>";
$xml = new SimpleXMLElement($content); $xml = new SimpleXMLElement($content);
$result = $xml->xpath('//td[@class=\'bibref\']'); $result = $xml->xpath('//td[@class=\'bibref\']');
$this->assertEquals($PAGE_SIZE,count($result)); $this->assertEquals($PAGE_SIZE,count($result));
@ -297,6 +331,102 @@ class BTBTest extends PHPUnit_Framework_TestCase {
$dis = $db->getEntryByKey('aKey'); $dis = $db->getEntryByKey('aKey');
$this->assertEquals(2,count($dis->getKeywords())); $this->assertEquals(2,count($dis->getKeywords()));
} }
function test_formatting() {
$bibtex = "@article{aKey61,title={An article Book},author = {Meyer, Heribert and {Advanced Air and Ground Research Team} and Foo Bar}}\n";
$test_data = fopen('php://memory','x+');
fwrite($test_data, $bibtex);
fseek($test_data,0);
$db = new BibDataBase();
$db->update_internal("inline", $test_data);
$entry = $db->getEntryByKey('aKey61');
// test with formatting with default options same as getRawAuthors()
$authors = $entry->getFormattedAuthorsArray();
$this->assertEquals(3, count($authors));
$this->assertEquals("Meyer, Heribert", $authors[0]);
$this->assertEquals("Advanced Air and Ground Research Team", $authors[1]);
$this->assertEquals("Foo Bar", $authors[2]);
$this->assertEquals("Meyer, Heribert, Advanced Air and Ground Research Team and Foo Bar", $entry->getFormattedAuthorsString());
// test with formatting (first name before)
bibtexbrowser_configure('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT', true);
$authors = $entry->getFormattedAuthorsArray();
$this->assertEquals(3, count($authors));
$this->assertEquals("Meyer, Heribert", $authors[0]);
$this->assertEquals("Team, Advanced Air and Ground Research", $authors[1]);
$this->assertEquals("Bar, Foo", $authors[2]);
$this->assertEquals("Meyer, Heribert; Team, Advanced Air and Ground Research and Bar, Foo", $entry->getFormattedAuthorsString());
// test with formatting (with initials) formatAuthorInitials
bibtexbrowser_configure('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT', false);
bibtexbrowser_configure('USE_INITIALS_FOR_NAMES', true);
$authors = $entry->getFormattedAuthorsArray();
$this->assertEquals(3, count($authors));
$this->assertEquals("Meyer H", $authors[0]);
$this->assertEquals("Team AAand GR", $authors[1]);
$this->assertEquals("Bar F", $authors[2]);
$this->assertEquals("Meyer H, Team AAand GR and Bar F", $entry->getFormattedAuthorsString());
// test with first_name last_name formatAuthorCanonical
bibtexbrowser_configure('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT', false);
bibtexbrowser_configure('USE_INITIALS_FOR_NAMES', false);
bibtexbrowser_configure('USE_FIRST_THEN_LAST', true);
$authors = $entry->getFormattedAuthorsArray();
$this->assertEquals(3, count($authors));
$this->assertEquals("Heribert Meyer", $authors[0]);
$this->assertEquals("Advanced Air and Ground Research Team", $authors[1]);
$this->assertEquals("Foo Bar", $authors[2]);
$this->assertEquals("Heribert Meyer, Advanced Air and Ground Research Team and Foo Bar", $entry->getFormattedAuthorsString());
}
function test_parsing_author_list() {
// specify parsing of author list
// default case: one authors
$bibtex = "@article{aKey61,title={An article Book},author = {Meyer, Heribert}}\n";
$test_data = fopen('php://memory','x+');
fwrite($test_data, $bibtex);
fseek($test_data,0);
$db = new BibDataBase();
$db->update_internal("inline", $test_data);
$entry = $db->getEntryByKey('aKey61');
$authors = $entry->getRawAuthors();
$this->assertEquals(1,count($authors));
$this->assertEquals("Meyer, Heribert", $authors[0]);
// default case: no sub list
$bibtex = "@article{aKey61,title={An article Book},author = {Meyer, Heribert and Foo Bar}}\n";
$test_data = fopen('php://memory','x+');
fwrite($test_data, $bibtex);
fseek($test_data,0);
$db = new BibDataBase();
$db->update_internal("inline", $test_data);
$entry = $db->getEntryByKey('aKey61');
$authors = $entry->getRawAuthors();
$this->assertEquals(2,count($authors));
$this->assertEquals("Meyer, Heribert", $authors[0]);
$this->assertEquals("Meyer, Heribert and Foo Bar", $entry->getFormattedAuthorsString());
// Github issue 61
$bibtex = "@article{aKey61,title={An article Book},author = {Meyer, Heribert and {Advanced Air and Ground Research Team} and Foo Bar}}\n";
// wrong parsing of author names
$test_data = fopen('php://memory','x+');
fwrite($test_data, $bibtex);
fseek($test_data,0);
$db = new BibDataBase();
$db->update_internal("inline", $test_data);
$entry = $db->getEntryByKey('aKey61');
$authors = $entry->getRawAuthors();
$this->assertEquals(3, count($authors));
$this->assertEquals("Meyer, Heribert", $authors[0]);
$this->assertEquals("Advanced Air and Ground Research Team", $authors[1]);
$this->assertEquals("Foo Bar", $authors[2]);
}
} // end class } // end class
?> ?>

217
bibtexbrowser.php
View File

@ -60,6 +60,7 @@ if (defined('ENCODING')) {
// number of bib items per page // number of bib items per page
// we use the same parameter 'num' as Google // we use the same parameter 'num' as Google
@define('PAGE_SIZE',isset($_GET['num'])?(preg_match('/^\d+$/',$_GET['num'])?$_GET['num']:10000):14); @define('PAGE_SIZE',isset($_GET['num'])?(preg_match('/^\d+$/',$_GET['num'])?$_GET['num']:10000):14);
// bibtexbrowser uses a small piece of Javascript to improve the user experience // bibtexbrowser uses a small piece of Javascript to improve the user experience
// see http://en.wikipedia.org/wiki/Progressive_enhancement // see http://en.wikipedia.org/wiki/Progressive_enhancement
// if you don't like it, you can be disable it by adding in bibtexbrowser.local.php // if you don't like it, you can be disable it by adding in bibtexbrowser.local.php
@ -162,9 +163,17 @@ if (defined('ENCODING')) {
@define('BIBTEXBROWSER_DEBUG',false); @define('BIBTEXBROWSER_DEBUG',false);
@define('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT',false);// do have authors in a comma separated form?
@define('USE_INITIALS_FOR_NAMES',false); // use only initials for all first names
// 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); // use only initials for all first names?
@define('FORCE_NAMELIST_SEPARATOR', ''); // if non-empty, use this to separate multiple names regardless of USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT @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('TYPES_SIZE',10); // number of entry types per table @define('TYPES_SIZE',10); // number of entry types per table
@define('YEAR_SIZE',20); // number of years per table @define('YEAR_SIZE',20); // number of years per table
@define('AUTHORS_SIZE',30); // number of authors per table @define('AUTHORS_SIZE',30); // number of authors per table
@ -500,6 +509,7 @@ class StateBasedBibtexParser {
$entrytype=''; $entrytype='';
$entrykey=''; $entrykey='';
$entryvalue=''; $entryvalue='';
$fieldvaluepart='';
$finalkey=''; $finalkey='';
$entrysource=''; $entrysource='';
@ -542,8 +552,10 @@ class StateBasedBibtexParser {
// now we get the value // now we get the value
if ($s=='=') { if ($s=='=') {
$state = GETVALUE; $state = GETVALUE;
$fieldvaluepart='';
$finalkey=$entrykey; $finalkey=$entrykey;
$entrykey='';}
$entrykey='';
}
// oups we only have the key :-) anyway // oups we only have the key :-) anyway
else if ($s=='}') { else if ($s=='}') {
$state = NOTHING;$isinentry = false;$delegate->endEntry($entrysource); $state = NOTHING;$isinentry = false;$delegate->endEntry($entrysource);
@ -571,20 +583,22 @@ class StateBasedBibtexParser {
// the end of the key and no value found: it is the bibtex key e.g. \cite{Descartes1637} // the end of the key and no value found: it is the bibtex key e.g. \cite{Descartes1637}
else if ($s==',') { else if ($s==',') {
$state = GETKEY; $state = GETKEY;
$delegate->setEntryField(trim($finalkey),$entryvalue);
$delegate->setEntryField($finalkey,$entryvalue);
$entryvalue=''; // resetting the value buffer $entryvalue=''; // resetting the value buffer
} }
// this is the end of the value AND of the entry // this is the end of the value AND of the entry
else if ($s=='}') { else if ($s=='}') {
$state = NOTHING; $state = NOTHING;
$delegate->setEntryField(trim($finalkey),$entryvalue);
$delegate->setEntryField($finalkey,$entryvalue);
$isinentry = false;$delegate->endEntry($entrysource); $isinentry = false;$delegate->endEntry($entrysource);
$entryvalue=''; // resetting the value buffer $entryvalue=''; // resetting the value buffer
} }
else if ($s==' ' || $s=="\t" || $s=="\n" || $s=="\r" ) { 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 // blank characters are not taken into account when values are not in quotes or curly brackets
} }
else { $entryvalue=$entryvalue.$s;}
else {
$entryvalue=$entryvalue.$s;
}
} }
@ -595,10 +609,19 @@ class StateBasedBibtexParser {
$state = GETVALUEDELIMITEDBYCURLYBRACKETS_ESCAPED; $state = GETVALUEDELIMITEDBYCURLYBRACKETS_ESCAPED;
$entryvalue=$entryvalue.$s;} $entryvalue=$entryvalue.$s;}
else if ($s=='{') { else if ($s=='{') {
$state = GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL;$entryvalue=$entryvalue.$s;}
else if ($s=='}') {
$state = GETVALUE;}
else { $entryvalue=$entryvalue.$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 // handle anti-slashed brackets
else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_ESCAPED) { else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_ESCAPED) {
@ -613,8 +636,15 @@ class StateBasedBibtexParser {
else if ($s=='{') { else if ($s=='{') {
$state = GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL;$entryvalue=$entryvalue.$s;} $state = GETVALUEDELIMITEDBYCURLYBRACKETS_2NESTEDLEVEL;$entryvalue=$entryvalue.$s;}
else if ($s=='}') { else if ($s=='}') {
$state = GETVALUEDELIMITEDBYCURLYBRACKETS;$entryvalue=$entryvalue.$s;}
else { $entryvalue=$entryvalue.$s;}
$state = GETVALUEDELIMITEDBYCURLYBRACKETS;
$delegate->entryValuePart($finalkey,$fieldvaluepart,'CURLYONE');
$fieldvaluepart='';
$entryvalue=$entryvalue.$s;
}
else {
$entryvalue=$entryvalue.$s;
$fieldvaluepart=$fieldvaluepart.$s;
}
} }
// handle anti-slashed brackets // handle anti-slashed brackets
else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL_ESCAPED) { else if ($state==GETVALUEDELIMITEDBYCURLYBRACKETS_1NESTEDLEVEL_ESCAPED) {
@ -723,6 +753,32 @@ class StringEntry {
} }
} // end class StringEntry } // end class StringEntry
/** 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
/** builds arrays of BibEntry objects from a bibtex file. /** builds arrays of BibEntry objects from a bibtex file.
usage: usage:
<pre> <pre>
@ -735,7 +791,7 @@ usage:
notes: notes:
method build can be used several times, bibtex entries are accumulated in the builder method build can be used several times, bibtex entries are accumulated in the builder
*/ */
class BibDBBuilder {
class BibDBBuilder extends ParserDelegate {
/** A hashtable from keys to bib entries (BibEntry). */ /** A hashtable from keys to bib entries (BibEntry). */
var $builtdb = array(); var $builtdb = array();
@ -794,7 +850,8 @@ class BibDBBuilder {
//print_r($this->builtdb); //print_r($this->builtdb);
} }
function setEntryField($finalkey,$entryvalue) {
function setEntryField($fieldkey,$entryvalue) {
$fieldkey=trim($fieldkey);
// support for Bibtex concatenation // support for Bibtex concatenation
// see http://newton.ex.ac.uk/tex/pack/bibtex/btxdoc/node3.html // see http://newton.ex.ac.uk/tex/pack/bibtex/btxdoc/node3.html
// (?<! is a negative look-behind assertion, see http://www.php.net/manual/en/regexp.reference.assertions.php // (?<! is a negative look-behind assertion, see http://www.php.net/manual/en/regexp.reference.assertions.php
@ -817,7 +874,7 @@ class BibDBBuilder {
} }
$entryvalue=implode('',$entryvalue_array); $entryvalue=implode('',$entryvalue_array);
$this->currentEntry->setField($finalkey,$entryvalue);
$this->currentEntry->setField($fieldkey,$entryvalue);
} }
function setEntryType($entrytype) { function setEntryType($entrytype) {
@ -850,7 +907,7 @@ class BibDBBuilder {
// we format the author names in a special field // we format the author names in a special field
// to enable search // to enable search
if ($this->currentEntry->hasField('author')) { if ($this->currentEntry->hasField('author')) {
$this->currentEntry->setField(Q_INNER_AUTHOR,$this->currentEntry->getFormattedAuthorsImproved());
$this->currentEntry->setField(Q_INNER_AUTHOR,$this->currentEntry->getFormattedAuthorsString());
} }
// ignoring jabref comments // ignoring jabref comments
@ -870,6 +927,20 @@ class BibDBBuilder {
$this->builtdb[$this->currentEntry->getKey()] = $this->currentEntry; $this->builtdb[$this->currentEntry->getKey()] = $this->currentEntry;
} }
} }
function entryValuePart($key, $value, $type) {
if (preg_match('/^author$/i',trim($key)) && strlen($value)>0) {
if ($type == 'CURLYTOP') {
foreach (preg_split('/\s+and\s+/i', $value) as $author) {
if (strlen($author)>0) {
$this->currentEntry->addAuthor($author);
}
}
} else { // 'CURLYONE', nnon-breakable
$this->currentEntry->addAuthor($value);
}
}
}
} // end class BibDBBuilder } // end class BibDBBuilder
@ -1073,6 +1144,10 @@ class BibEntry {
/** The location in the original bibtex file (set by addEntry) */ /** The location in the original bibtex file (set by addEntry) */
var $order = -1; var $order = -1;
/** the authors (split at parsing time) */
var $author_array = array();
/** returns a debug string representation */ /** returns a debug string representation */
function __toString() { function __toString() {
return $this->getType()." ".$this->getKey(); return $this->getType()." ".$this->getKey();
@ -1274,11 +1349,16 @@ class BibEntry {
return isset($this->fields[strtolower($name)]); return isset($this->fields[strtolower($name)]);
} }
/** adds an author to this entry */
function addAuthor($author) {
$this->author_array[] = trim($author);
}
/** Returns the authors of this entry. If "author" is not given, /** Returns the authors of this entry. If "author" is not given,
* return a string 'Unknown'. */ * return a string 'Unknown'. */
function getAuthor() { function getAuthor() {
if (array_key_exists(AUTHOR, $this->fields)) { if (array_key_exists(AUTHOR, $this->fields)) {
return $this->fields[AUTHOR];
return getFormattedAuthorsString();
} }
// 2010-03-02: commented the following, it results in misleading author lists // 2010-03-02: commented the following, it results in misleading author lists
// issue found by Alan P. Sexton // issue found by Alan P. Sexton
@ -1322,26 +1402,26 @@ class BibEntry {
return ''; return '';
} }
/** Returns the authors of this entry as an array */
/** Returns the authors of this entry as an array (split by " and ") */
function getRawAuthors() { function getRawAuthors() {
$authors = array();
foreach (preg_split('/ and /i', $this->getAuthor()) as $author) {
$authors[]=$author;
}
return $authors;
return $this->author_array;
} }
/** /**
* Returns the formated author name w.r.t to the user preference encoded in USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT
* 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){ function formatAuthor($author){
if (USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT) {
if (bibtexbrowser_configuration('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT')) {
return $this->formatAuthorCommaSeparated($author); return $this->formatAuthorCommaSeparated($author);
} else if (USE_INITIALS_FOR_NAMES) {
} else if (bibtexbrowser_configuration('USE_INITIALS_FOR_NAMES')) {
return $this->formatAuthorInitials($author); return $this->formatAuthorInitials($author);
} else if (bibtexbrowser_configuration('USE_FIRST_THEN_LAST')) {
return $this->formatAuthorCanonical($author);
} }
else return $this->formatAuthorCanonical($author);
// otherwise to formatting
else return $author;
} }
/** /**
@ -1373,24 +1453,23 @@ class BibEntry {
} }
/** Returns the authors as an array of strings (one string per author) */
function getFormattedAuthors() {
$authors = array();
foreach ($this->getRawAuthors() as $author) {
$authors[]='<span itemprop="author" itemtype="http://schema.org/Person">'.$this->formatAuthor($author).'</span>';
}
return $authors;
}
/** @deprecated */
function formattedAuthors() { return $this->getFormattedAuthorsString(); }
/** @deprecated */
function getFormattedAuthors() { return $this->getFormattedAuthorsArray(); }
/** @deprecated */
function getFormattedAuthorsImproved() { return $this->getFormattedAuthorsString(); }
/** @deprecated
* @see getFormattedAuthorsImproved()
*/
function formattedAuthors() { return $this->getFormattedAuthorsImproved(); }
/** 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.
/** Returns the authors as an array of strings (one string per author).
*/ */
function getFormattedAuthorsImproved() {
$array_authors = $this->getFormattedAuthors();
function getFormattedAuthorsArray() {
$array_authors = array();
// first we use formatAuthor
foreach ($this->getRawAuthors() as $author) {
$array_authors[]=$this->formatAuthor($author);
}
if (BIBTEXBROWSER_AUTHOR_LINKS=='homepage') { if (BIBTEXBROWSER_AUTHOR_LINKS=='homepage') {
foreach ($array_authors as $k => $author) { foreach ($array_authors as $k => $author) {
@ -1404,10 +1483,28 @@ class BibEntry {
} }
} }
if (USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT) {$sep = '; ';} else {$sep = ', ';}
if (FORCE_NAMELIST_SEPARATOR !== '') {$sep = FORCE_NAMELIST_SEPARATOR;}
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 = '';
return implode($sep ,$array_authors);
if (bibtexbrowser_configuration('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT')) {$sep = '; ';} else {$sep = ', ';}
if (FORCE_NAMELIST_SEPARATOR !== '') {$sep = FORCE_NAMELIST_SEPARATOR;}
for ($i=0;$i<count($authors)-2;$i++) {
$result .= $authors[$i].$sep;
}
$result .= $authors[count($authors)-2].bibtexbrowser_configuration('LAST_AUTHOR_SEPARATOR'). $authors[count($authors)-1];
return $result;
} }
/** adds a link to the author page */ /** adds a link to the author page */
@ -1477,7 +1574,7 @@ class BibEntry {
foreach ($this->getEditors() as $editor) { foreach ($this->getEditors() as $editor) {
$editors[]=$this->addHomepageLink($this->formatAuthor($editor)); $editors[]=$this->addHomepageLink($this->formatAuthor($editor));
} }
if (USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT) {$sep = '; ';} else {$sep = ', ';}
if (bibtexbrowser_configuration('USE_COMMA_AS_NAME_SEPARATOR_IN_OUTPUT')) {$sep = '; ';} else {$sep = ', ';}
if (FORCE_NAMELIST_SEPARATOR !== '') {$sep = FORCE_NAMELIST_SEPARATOR;} if (FORCE_NAMELIST_SEPARATOR !== '') {$sep = FORCE_NAMELIST_SEPARATOR;}
return implode($sep, $editors).', '.(count($editors)>1?'eds.':'ed.'); return implode($sep, $editors).', '.(count($editors)>1?'eds.':'ed.');
} }
@ -1705,7 +1802,7 @@ class BibEntry {
$url_parts[]='rft.date='.s3988($this->getYear()); $url_parts[]='rft.date='.s3988($this->getYear());
foreach ($this->getFormattedAuthors() as $au) $url_parts[]='rft.au='.s3988($au);
foreach ($this->getFormattedAuthorsArray() as $au) $url_parts[]='rft.au='.s3988($au);
return '<span class="Z3988" title="'.implode('&amp;',$url_parts).'"></span>'; return '<span class="Z3988" title="'.implode('&amp;',$url_parts).'"></span>';
@ -1847,7 +1944,7 @@ function print_footer_layout() {
/** this function encapsulates the user-defined name for bib to HTML*/ /** this function encapsulates the user-defined name for bib to HTML*/
function bib2html(&$bibentry) { function bib2html(&$bibentry) {
$function = BIBLIOGRAPHYSTYLE;
$function = bibtexbrowser_configuration('BIBLIOGRAPHYSTYLE');
return $function($bibentry); return $function($bibentry);
} }
@ -2089,10 +2186,20 @@ function DefaultBibliographyStyle(&$bibentry) {
if ($bibentry->hasField('url')) $title = ' <a'.(BIBTEXBROWSER_BIB_IN_NEW_WINDOW?' target="_blank" ':'').' href="'.$bibentry->getField('url').'">'.$title.'</a>'; if ($bibentry->hasField('url')) $title = ' <a'.(BIBTEXBROWSER_BIB_IN_NEW_WINDOW?' target="_blank" ':'').' href="'.$bibentry->getField('url').'">'.$title.'</a>';
// author
$coreInfo = $title;
// adding author info
if ($bibentry->hasField('author')) { if ($bibentry->hasField('author')) {
$coreInfo = $title . ' (<span class="bibauthor">'.$bibentry->getFormattedAuthorsImproved().'</span>)';}
else $coreInfo = $title;
$coreInfo .= ' (<span class="bibauthor">';
$authors = array();
foreach ($bibentry->getFormattedAuthorsArray() as $a) {
$authors[]='<span itemprop="author" itemtype="http://schema.org/Person">'.$a.'</span>';
}
$coreInfo .= $bibentry->implodeAuthors($authors);
$coreInfo .= '</span>)';
}
// core info usually contains title + author // core info usually contains title + author
$entry[] = $coreInfo; $entry[] = $coreInfo;
@ -2189,7 +2296,7 @@ function JanosBibliographyStyle(&$bibentry) {
// author // author
if ($bibentry->hasField('author')) { if ($bibentry->hasField('author')) {
$entry[] = $bibentry->formattedAuthors();
$entry[] = $bibentry->getFormattedAuthorsString();
} }
// title // title
@ -2299,7 +2406,7 @@ function VancouverBibliographyStyle(&$bibentry) {
// author // author
if ($bibentry->hasField('author')) { if ($bibentry->hasField('author')) {
$entry[] = $bibentry->formattedAuthors().'. ';
$entry[] = $bibentry->getFormattedAuthorsString().'. ';
} }
// Ensure punctuation mark at title's end // Ensure punctuation mark at title's end
@ -2972,7 +3079,7 @@ class SimpleDisplay {
} }
if (BIBTEXBROWSER_DEBUG) { if (BIBTEXBROWSER_DEBUG) {
echo 'Style: '.BIBLIOGRAPHYSTYLE.'<br/>';
echo 'Style: '.bibtexbrowser_configuration('BIBLIOGRAPHYSTYLE').'<br/>';
echo 'Order: '.ORDER_FUNCTION.'<br/>'; echo 'Order: '.ORDER_FUNCTION.'<br/>';
echo 'Abbrv: '.ABBRV_TYPE.'<br/>'; echo 'Abbrv: '.ABBRV_TYPE.'<br/>';
echo 'Options: '.@implode(',',$this->options).'<br/>'; echo 'Options: '.@implode(',',$this->options).'<br/>';
@ -3177,7 +3284,7 @@ class BibEntryDisplay {
/** 2011/10/02: new display, inspired from Tom Zimmermann's home page */ /** 2011/10/02: new display, inspired from Tom Zimmermann's home page */
function displayOnSteroids() { function displayOnSteroids() {
$subtitle = '<div class="bibentry-by">by '.$this->bib->getFormattedAuthorsImproved().'</div>';
$subtitle = '<div class="bibentry-by">by '.$this->bib->getFormattedAuthorsString().'</div>';
$abstract = ''; $abstract = '';
if ($this->bib->hasField('abstract')) { if ($this->bib->hasField('abstract')) {

Write Preview
Loading…
Cancel
Save