";
if (array_search($string, $this->undefinedStrings) === FALSE)
// if not already in the undefinedStrings array
$this->undefinedStrings[] = $string;
return '';
}
*/
}
return $string;
}
/**
* This function works like explode('#',$val) but has to take into account whether
* the character # is part of a string (i.e., is enclosed into "..." or {...} )
* or defines a string concatenation as in @string{ "x # x" # ss # {xx{x}x} }
*
* @param string $val
* @return string[]
*/
public function explodeString($val) {
$valLen = mb_strlen($val);
$openquote = $bracelevel = $i = $j = 0;
while ($i < $valLen) {
$s = mb_substr($val, $i, 1);
if ($s == '"') {
$openquote = !$openquote;
}
elseif ($s == '{') {
$bracelevel++;
}
elseif ($s == '}') {
$bracelevel--;
}
elseif ( $s == '#' && !$openquote && !$bracelevel ) {
$strings[] = mb_substr($val, $j, $i - $j);
$j = $i + 1;
}
$i++;
}
$strings[] = mb_substr($val, $j);
return $strings;
}
/**
* This function receives a string and a closing delimiter '}' or ')'
* and looks for the position of the closing delimiter taking into
* account the following Bibtex rules:
* Inside the braces, there can arbitrarily nested pairs of braces,
* but braces must also be balanced inside quotes!
* Inside quotes, to place the " character it is not sufficient
* to simply escape with \": Quotes must be placed inside braces.
*
* @param string $val
* @param string $delimitBegin
* @param string $delimitEnd
*
* @return int (0)
*/
public function closingDelimiter($val, $delimitBegin, $delimitEnd) {
$valLen = mb_strlen($val);
$DelimLen = mb_strlen($delimitEnd);
$openquote = 0;
$bracelevel = 0;
$i = 0;
while ($i < $valLen && ($valLen - $i >= $DelimLen)) {
$s = mb_substr($val, $i, $DelimLen);
// a '"' found at brace level 0 defines a value such as "ss{\"o}ss"
if ($s == '"' && !$bracelevel) {
$openquote = !$openquote;
}
elseif ($s == $delimitBegin) {
$bracelevel++;
}
elseif ($s == $delimitEnd) {
$bracelevel--;
}
if ($s == $delimitEnd && !$openquote && !$bracelevel) {
return $i;
}
$i += $DelimLen;
}
return 0;
}
/**
* Remove enclosures around entry field values. Additionally, expand macros if flag set.
*
* @param string $string
* @param bool $inpreamble Default is FALSE
* @return string
*/
public function removeDelimitersAndExpand($string, $inpreamble = FALSE) {
// only expand the macro if flag set, if strings defined and not in preamble
if (!$this->expandMacro || empty($this->strings) || $inpreamble) {
$string = $this->removeDelimiters($string);
}
else {
$stringlist = $this->explodeString($string);
$string = "";
foreach ($stringlist as $str) {
// trim the string since usually # is enclosed by spaces
$str = trim($str);
// replace the string if macro is already defined
// strtolower is used since macros are case insensitive
if ( isset( $this->strings[mb_strtolower($str)] ) ) {
$string .= $this->strings[mb_strtolower($str)];
}
else {
$string .= $this->removeDelimiters( trim($str) );
}
}
}
return $string;
}
/**
* This function extract entries taking into account how comments are defined in BibTeX.
* BibTeX splits the file in two areas: inside an entry and outside an entry, the delimitation
* being indicated by the presence of a @ sign. When this character is met, BibTex expects to
* find an entry. Before that sign, and after an entry, everything is considered a comment!
*/
public function extractEntries() {
$EntryDelim = '@';
$ListDelim = array('(' => ')', '{' => '}');
$inside = $possibleEntryStart = FALSE;
$entry = '';
while ($line = $this->getLine()) {
if ($possibleEntryStart) {
$line = $possibleEntryStart . $line;
}
if (!$inside && mb_strstr($line, $EntryDelim)) {
// throw all characters before the '@'
$line = mb_strstr($line, $EntryDelim);
$IsOpenDelimNotFinded = TRUE;
foreach ($ListDelim as $do => $dc) {
$IsOpenDelimNotFinded &= !mb_strstr($line, $do);
}
if ($IsOpenDelimNotFinded) {
$possibleEntryStart = $line;
}
elseif (preg_match("/$EntryDelim.*([" . preg_quote(implode('', array_keys($ListDelim))) . "])/Uu", preg_quote($line), $matches)) {
$inside = TRUE;
$delimitBegin = $matches[1];
$delimitEnd = $ListDelim[$matches[1]];
$possibleEntryStart = FALSE;
}
}
if ($inside) {
$entry .= ' ' . $line;
if ( $j = $this->closingDelimiter($entry, $delimitBegin, $delimitEnd) ) {
// all characters after the delimiter are thrown but the remaining
// characters must be kept since they may start the next entry !!!
$lastLine = mb_substr($entry, $j + 1);
$entry = mb_substr($entry, 0, $j + 1);
// Strip excess whitespaces from the entry
$entry = preg_replace('/\s\s+/u', ' ', $entry);
$this->parseEntry($entry);
$entry = mb_strstr($lastLine, $EntryDelim);
if ($entry) {
$inside = TRUE;
}
else {
$inside = FALSE;
}
}
}
}
}
/**
* Return arrays of entries etc. to the calling process.
*
* @return array (preamble, strings, entry, undefinedStrings)
*/
public function returnArrays() {
foreach ($this->preamble as $value) {
preg_match("/.*?[{(](.*)/u", $value, $matches);
$preamble = mb_substr($matches[1], 0, -1);
$preambles['bibtexPreamble'] = trim($this->removeDelimitersAndExpand(trim($preamble), TRUE));
}
if (isset($preambles)) {
$this->preamble = $preambles;
}
if ($this->fieldExtract) {
// Next lines must take into account strings defined by previously-defined strings
$strings = $this->strings;
// $this->strings is initialized with strings provided by user if they exists
// it is supposed that there are no substitutions to be made in the user strings, i.e., no #
$this->strings = isset($this->userStrings) ? $this->userStrings : array();
foreach ($strings as $value) {
// changed 21/08/2004 G. Gardey
// 23/08/2004 Mark G. account for comments on same line as @string - count delimiters in string value
$value = trim($value);
$matches = preg_split("/@\\s*string\\s*([{(])/ui", $value, 2, PREG_SPLIT_DELIM_CAPTURE);
$matches = preg_split("/=/u", $matches[2], 2, PREG_SPLIT_DELIM_CAPTURE);
// macros are case insensitive
$this->strings[mb_strtolower(trim($matches[0]))] = $this->extractStringValue($matches[1]);
}
}
// changed 21/08/2004 G. Gardey
// 22/08/2004 Mark Grimshaw-Aagaard - stopped useless looping.
// removeDelimit and expandMacro have NO effect if !$this->fieldExtract
if ($this->removeDelimit || $this->expandMacro && $this->fieldExtract) {
for ($i = 0; $i < count($this->entries); $i++) {
foreach ($this->entries[$i] as $key => $value) {
// 02/05/2005 G. Gardey don't expand macro for bibtexCitation
// and bibtexEntryType
if ($key != 'bibtexCitation' && $key != 'bibtexEntryType') {
$this->entries[$i][$key] = trim($this->removeDelimitersAndExpand($this->entries[$i][$key]));
}
}
}
}
return array($this->preamble, $this->strings, $this->entries, $this->undefinedStrings);
}
/**
* Simulate substr_replace() for multibytes strings
*
* @param string $string
* @param string $replacement
* @param int $start
* @param int $length Default is NULL.
* @param string $encoding Default is NULL.
*
* @return string
*/
private static function _mb_substr_replace($string, $replacement, $start, $length = NULL, $encoding = NULL) {
if (extension_loaded('mbstring') === FALSE) {
return (is_null($length) === TRUE) ? substr_replace($string, $replacement, $start) : substr_replace($string, $replacement, $start, $length);
}
$string_length = (is_null($encoding) === TRUE) ? mb_strlen($string) : mb_strlen($string, $encoding);
if ($start < 0) {
$start = max(0, $string_length + $start);
}
elseif ($start > $string_length) {
$start = $string_length;
}
if ($length < 0) {
$length = max(0, $string_length - $start + $length);
}
elseif ((is_null($length) === TRUE) || ($length > $string_length)) {
$length = $string_length;
}
if (($start + $length) > $string_length) {
$length = $string_length - $start;
}
if (is_null($encoding) === TRUE) {
return mb_substr($string, 0, $start) . $replacement . mb_substr($string, $start + $length, $string_length - $start - $length);
}
return mb_substr($string, 0, $start, $encoding) . $replacement . mb_substr($string, $start + $length, $string_length - $start - $length, $encoding);
}
/**
* Simulate strrev() for multibytes strings
*
* @param string $str
*
* @return string
*/
private static function _mb_strrev($str) {
preg_match_all('/./us', $str, $ar);
return implode('', array_reverse($ar[0]));
}
/**
* Sets a control character for saving line breaks
* @param array $line_array
* @return array
* @since 2.3
* @author Michael Winkler