class.ilBibTex.php

Go to the documentation of this file.

<?php
require_once('./Modules/Bibliographic/classes/Types/class.ilBibliograficFileReaderBase.php');

class ilBibTex extends ilBibliograficFileReaderBase implements ilBibliograficFileReader {

        protected static $ignored_keywords = array( 'Preamble' );


        public function parseContent() {
                $this->convertBibSpecialChars();
                $this->normalizeContent();

                // get entries

                $objects = preg_split("/\\@([\\w]*)/uix", $this->getFileContent(), null, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);

                if (in_array($objects[0], self::$ignored_keywords)) {
                        $objects = array_splice($objects, 2);
                }
                // some files lead to a empty first entry in the array with the fist bib-entry, we have to trow them away...
                if (strlen($objects[0]) <= 3) {
                        $objects = array_splice($objects, 1);
                }

                $entries = array();
                foreach ($objects as $key => $object) {
                        if ((int)$key % 2 == 0 || (int)$key == 0) {
                                $entry = array();
                                $entry['entryType'] = strtolower($object);
                        } else {
                                // Citation
                                preg_match("/^{(?<cite>.*),\\n/um", $object, $cite_matches);
                                if ($cite_matches['cite']) {
                                        $entry['cite'] = $cite_matches['cite'];
                                }

                                // Edit at regex101.com: (?<attr>[\w]*)\s*=\s*[{"]*(?<content>(.*?))\s*[}"]*?\s*[,]*?\s*\n
                                $re = "/(?<attr>[\\w]*)\\s*=\\s*[{\"]*(?<content>(.*?))\\s*[}\"]*?\\s*[,]*?\\s*\\n/";

                                preg_match_all($re, $object, $matches, PREG_SET_ORDER);

                                foreach ($matches as $match) {
                                        $clean = $match['content'];
                                        $clean = preg_replace("/[\", \\t\\s]*\\n/u", "\n", $clean);

                                        $entry[strtolower($match['attr'])] = $clean;
                                }

                                $entries[] = $entry;
                        }
                }

                return $entries;
        }


        protected function normalizeContent() {
                $result = $this->removeBomUtf8($this->getFileContent());
                // remove emty newlines
                $result = preg_replace("/^\n/um", "", $result);
                // Remove lines with only whitespaces
                $result = preg_replace("/^[\\s]*$/um", "\n", $result);
                $result = preg_replace("/\\n\\n\\n/um", "\n\n", $result);

                // remove comments
                $result = preg_replace("/^%.*\\n/um", "", $result);

                // Intend attributes with a tab
                $result = preg_replace("/^[ ]+/um", "\t", $result);
                $result = preg_replace("/^([\\w])/um", "\t$1", $result);

                // replace newline-braktes with brakets
                $result = preg_replace('/\\n}/uimx', '}', $result);

                // move last bracket on newline
                $result = preg_replace("/}[\\s]*$/um", "\n}", $result);

                // Support long lines (not working at the moment)
                //              $re = "/(\"[^\"\\n]*)\\r?\\n(?!(([^\"]*\"){2})*[^\"]*$)/";
                //              $subst = "$1";
                //              $result = preg_replace($re, $subst, $result);

                $this->setFileContent($result);
        }


        protected function convertBibSpecialChars() {
                $bibtex_special_chars['ä'] = '{\"a}';
                $bibtex_special_chars['ë'] = '{\"e}';
                $bibtex_special_chars['ï'] = '{\"i}';
                $bibtex_special_chars['ö'] = '{\"o}';
                $bibtex_special_chars['ü'] = '{\"u}';
                $bibtex_special_chars['Ä'] = '{\"A}';
                $bibtex_special_chars['Ë'] = '{\"E}';
                $bibtex_special_chars['Ï'] = '{\"I}';
                $bibtex_special_chars['Ö'] = '{\"O}';
                $bibtex_special_chars['Ü'] = '{\"U}';
                $bibtex_special_chars['â'] = '{\^a}';
                $bibtex_special_chars['ê'] = '{\^e}';
                $bibtex_special_chars['î'] = '{\^i}';
                $bibtex_special_chars['ô'] = '{\^o}';
                $bibtex_special_chars['û'] = '{\^u}';
                $bibtex_special_chars['Â'] = '{\^A}';
                $bibtex_special_chars['Ê'] = '{\^E}';
                $bibtex_special_chars['Î'] = '{\^I}';
                $bibtex_special_chars['Ô'] = '{\^O}';
                $bibtex_special_chars['Û'] = '{\^U}';
                $bibtex_special_chars['à'] = '{\`a}';
                $bibtex_special_chars['è'] = '{\`e}';
                $bibtex_special_chars['ì'] = '{\`i}';
                $bibtex_special_chars['ò'] = '{\`o}';
                $bibtex_special_chars['ù'] = '{\`u}';
                $bibtex_special_chars['À'] = '{\`A}';
                $bibtex_special_chars['È'] = '{\`E}';
                $bibtex_special_chars['Ì'] = '{\`I}';
                $bibtex_special_chars['Ò'] = '{\`O}';
                $bibtex_special_chars['Ù'] = '{\`U}';
                $bibtex_special_chars['á'] = '{\\\'a}';
                $bibtex_special_chars['é'] = '{\\\'e}';
                $bibtex_special_chars['í'] = '{\\\'i}';
                $bibtex_special_chars['ó'] = '{\\\'o}';
                $bibtex_special_chars['ú'] = '{\\\'u}';
                $bibtex_special_chars['Á'] = '{\\\'A}';
                $bibtex_special_chars['É'] = '{\\\'E}';
                $bibtex_special_chars['Í'] = '{\\\'I}';
                $bibtex_special_chars['Ó'] = '{\\\'O}';
                $bibtex_special_chars['Ú'] = '{\\\'U}';
                $bibtex_special_chars['à'] = '{\`a}';
                $bibtex_special_chars['è'] = '{\`e}';
                $bibtex_special_chars['ì'] = '{\`i}';
                $bibtex_special_chars['ò'] = '{\`o}';
                $bibtex_special_chars['ù'] = '{\`u}';
                $bibtex_special_chars['À'] = '{\`A}';
                $bibtex_special_chars['È'] = '{\`E}';
                $bibtex_special_chars['Ì'] = '{\`I}';
                $bibtex_special_chars['Ò'] = '{\`O}';
                $bibtex_special_chars['Ù'] = '{\`U}';
                $bibtex_special_chars['ç'] = '{\c c}';
                $bibtex_special_chars['ß'] = '{\ss}';
                $bibtex_special_chars['ñ'] = '{\~n}';
                $bibtex_special_chars['Ñ'] = '{\~N}';
                $bibtex_special_chars['ń'] = "{\\'n}";
                $bibtex_special_chars['l'] = "{\\'n}";
                $bibtex_special_chars['&'] = "{\&}";
                $bibtex_special_chars['@'] = "{\@}";

                $this->setFileContent(str_replace(array_values($bibtex_special_chars), array_keys($bibtex_special_chars), $this->getFileContent()));
        }


        protected static $standard_fields = array(
                'address',
                'annote',
                'author',
                'booktitle',
                'chapter',
                'crossref',
                'edition',
                'editor',
                'eprint',
                'howpublished',
                'institution',
                'journal',
                'key',
                'month',
                'note',
                'number',
                'organization',
                'pages',
                'publisher',
                'school',
                'series',
                'title',
                'type',
                'url',
                'volume',
                'year',
        );
        protected static $entry_types = array(
                'article',
                'book',
                'booklet',
                'conference',
                'inbook',
                'incollection',
                'inproceedings',
                'manual',
                'mastersthesis',
                'misc',
                'phdthesis',
                'proceedings',
                'techreport',
                'unpublished',
        );


        public static function isStandardField($field_name) {
                return in_array($field_name, self::$standard_fields);
        }


        public static function isEntryType($entry_ype) {
                return in_array($entry_ype, self::$entry_types);
        }


        protected function removeBomUtf8($s) {
                if (substr($s, 0, 3) == chr(hexdec('EF')) . chr(hexdec('BB')) . chr(hexdec('BF'))) {
                        return substr($s, 3);
                } else {
                        return $s;
                }
        }
}