cops/base.php

<?php
/**
 * COPS (Calibre OPDS PHP Server) class file
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     S<EFBFBD>bastien Lucas <sebastien@slucas.fr>
 */

define ("VERSION", "1.0.0RC2");
define ("DB", "db");
date_default_timezone_set($config['default_timezone']);


function useServerSideRendering () {
    global $config;
    return preg_match("/" . $config['cops_server_side_render'] . "/", $_SERVER['HTTP_USER_AGENT']);
}

function serverSideRender ($data) {
    // Get the templates
    $theme = getCurrentTemplate ();
    $header = file_get_contents('templates/' . $theme . '/header.html');
    $footer = file_get_contents('templates/' . $theme . '/footer.html');
    $main = file_get_contents('templates/' . $theme . '/main.html');
    $bookdetail = file_get_contents('templates/' . $theme . '/bookdetail.html');
    $page = file_get_contents('templates/' . $theme . '/page.html');

    // Generate the function for the template
    $template = new doT ();
    $dot = $template->template ($page, array ("bookdetail" => $bookdetail,
                                              "header" => $header,
                                              "footer" => $footer,
                                              "main" => $main));
    // Execute the template
    if (!empty ($data)) {
        return $dot ($data);
    }

    return NULL;
}

function getQueryString () {
    if ( isset($_SERVER['QUERY_STRING']) ) {
        return $_SERVER['QUERY_STRING'];
    }
    return "";
}

function notFound () {
    header($_SERVER["SERVER_PROTOCOL"]." 404 Not Found");
    header("Status: 404 Not Found");

    $_SERVER['REDIRECT_STATUS'] = 404;
}

function getURLParam ($name, $default = NULL) {
    if (!empty ($_GET) && isset($_GET[$name]) && $_GET[$name] != "") {
        return $_GET[$name];
    }
    return $default;
}

function getCurrentOption ($option) {
    global $config;
    if (isset($_COOKIE[$option])) {
        if (isset($config ["cops_" . $option]) && is_array ($config ["cops_" . $option])) {
            return explode (",", $_COOKIE[$option]);
        } else {
            return $_COOKIE[$option];
        }
    }
    if ($option == "style") {
        return "default";
    }

    if (isset($config ["cops_" . $option])) {
        return $config ["cops_" . $option];
    }

    return "";
}

function getCurrentCss () {
    return "templates/" . getCurrentTemplate () . "/styles/style-" . getCurrentOption ("style") . ".css";
}

function getCurrentTemplate () {
    return "default";
}

function getUrlWithVersion ($url) {
    return $url . "?v=" . VERSION;
}

function xml2xhtml($xml) {
    return preg_replace_callback('#<(\w+)([^>]*)\s*/>#s', create_function('$m', '
        $xhtml_tags = array("br", "hr", "input", "frame", "img", "area", "link", "col", "base", "basefont", "param");
        return in_array($m[1], $xhtml_tags) ? "<$m[1]$m[2] />" : "<$m[1]$m[2]></$m[1]>";
    '), $xml);
}

function display_xml_error($error)
{
    $return = "";
    $return .= str_repeat('-', $error->column) . "^\n";

    switch ($error->level) {
        case LIBXML_ERR_WARNING:
            $return .= "Warning $error->code: ";
            break;
         case LIBXML_ERR_ERROR:
            $return .= "Error $error->code: ";
            break;
        case LIBXML_ERR_FATAL:
            $return .= "Fatal Error $error->code: ";
            break;
    }

    $return .= trim($error->message) .
               "\n  Line: $error->line" .
               "\n  Column: $error->column";

    if ($error->file) {
        $return .= "\n  File: $error->file";
    }

    return "$return\n\n--------------------------------------------\n\n";
}

function are_libxml_errors_ok ()
{
    $errors = libxml_get_errors();

    foreach ($errors as $error) {
        if ($error->code == 801) return false;
    }
    return true;
}

function html2xhtml ($html) {
    $doc = new DOMDocument();
    libxml_use_internal_errors(true);

    $doc->loadHTML('<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body>' .
                        $html  . '</body></html>'); // Load the HTML
    $output = $doc->saveXML($doc->documentElement); // Transform to an Ansi xml stream
    $output = xml2xhtml($output);
    if (preg_match ('#<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></meta></head><body>(.*)</body></html>#ms', $output, $matches)) {
        $output = $matches [1]; // Remove <html><body>
    }
    /*
    // In case of error with summary, use it to debug
    $errors = libxml_get_errors();

    foreach ($errors as $error) {
        $output .= display_xml_error($error);
    }
    */

    if (!are_libxml_errors_ok ()) $output = "HTML code not valid.";

    libxml_use_internal_errors(false);
    return $output;
}

/**
 * This method is a direct copy-paste from
 * http://tmont.com/blargh/2010/1/string-format-in-php
 */
function str_format($format) {
    $args = func_get_args();
    $format = array_shift($args);

    preg_match_all('/(?=\{)\{(\d+)\}(?!\})/', $format, $matches, PREG_OFFSET_CAPTURE);
    $offset = 0;
    foreach ($matches[1] as $data) {
        $i = $data[0];
        $format = substr_replace($format, @$args[$i], $offset + $data[1] - 1, 2 + strlen($i));
        $offset += strlen(@$args[$i]) - 2 - strlen($i);
    }

    return $format;
}

/**
 * This method is based on this page
 * http://www.mind-it.info/2010/02/22/a-simple-approach-to-localization-in-php/
 */
function localize($phrase, $count=-1, $reset=false) {
    if ($count == 0)
        $phrase .= ".none";
    if ($count == 1)
        $phrase .= ".one";
    if ($count > 1)
        $phrase .= ".many";

    /* Static keyword is used to ensure the file is loaded only once */
    static $translations = NULL;
    if ($reset) {
        $translations = NULL;
    }
    /* If no instance of $translations has occured load the language file */
    if (is_null($translations)) {
        $lang = "en";
        if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE']))
        {
            $lang = substr($_SERVER['HTTP_ACCEPT_LANGUAGE'], 0, 2);
        }
        $lang_file_en = NULL;
        $lang_file = dirname(__FILE__). '/lang/Localization_' . $lang . '.json';
        if (!file_exists($lang_file)) {
            $lang_file = dirname(__FILE__). '/lang/' . 'Localization_en.json';
        }
        elseif ($lang != "en") {
            $lang_file_en = dirname(__FILE__). '/lang/' . 'Localization_en.json';
        }
        $lang_file_content = file_get_contents($lang_file);
        /* Load the language file as a JSON object and transform it into an associative array */
        $translations = json_decode($lang_file_content, true);

        /* Clean the array of all unfinished translations */
        foreach (array_keys ($translations) as $key) {
            if (preg_match ("/^##TODO##/", $key)) {
                unset ($translations [$key]);
            }
        }
        if ($lang_file_en)
        {
            $lang_file_content = file_get_contents($lang_file_en);
            $translations_en = json_decode($lang_file_content, true);
            $translations = array_merge ($translations_en, $translations);
        }
    }
    if (array_key_exists ($phrase, $translations)) {
        return $translations[$phrase];
    }
    return $phrase;
}

function addURLParameter($urlParams, $paramName, $paramValue) {
    if (empty ($urlParams)) {
        $urlParams = "";
    }
    $start = "";
    if (preg_match ("#^\?(.*)#", $urlParams, $matches)) {
        $start = "?";
        $urlParams = $matches[1];
    }
    $params = array();
    parse_str($urlParams, $params);
    if (empty ($paramValue) && $paramValue != 0) {
        unset ($params[$paramName]);
    } else {
        $params[$paramName] = $paramValue;
    }
    return $start . http_build_query($params);
}

function useNormAndUp () {
    global $config;
    return extension_loaded('mbstring') &&
           extension_loaded('intl') &&
           class_exists("Normalizer", $autoload = false) &&
           $config ['cops_normalized_search'] == "1";
}

function normalizeUtf8String( $s)
{
    $original_string = $s;

    // maps German (umlauts) and other European characters onto two characters before just removing diacritics
    $s    = preg_replace( '@\x{00c4}@u'    , "AE",    $s );    // umlaut Ä => AE
    $s    = preg_replace( '@\x{00d6}@u'    , "OE",    $s );    // umlaut Ö => OE
    $s    = preg_replace( '@\x{00dc}@u'    , "UE",    $s );    // umlaut Ü => UE
    $s    = preg_replace( '@\x{00e4}@u'    , "ae",    $s );    // umlaut ä => ae
    $s    = preg_replace( '@\x{00f6}@u'    , "oe",    $s );    // umlaut ö => oe
    $s    = preg_replace( '@\x{00fc}@u'    , "ue",    $s );    // umlaut ü => ue
    $s    = preg_replace( '@\x{00f1}@u'    , "ny",    $s );    // ñ => ny
    $s    = preg_replace( '@\x{00ff}@u'    , "yu",    $s );    // ÿ => yu


    // maps special characters (characters with diacritics) on their base-character followed by the diacritical mark
        // exmaple:  Ú => U´,  á => a`
    $s    = Normalizer::normalize( $s, Normalizer::FORM_D );


    $s    = preg_replace( '@\pM@u'        , "",    $s );    // removes diacritics


    $s    = preg_replace( '@\x{00df}@u'    , "ss",    $s );    // maps German ß onto ss
    $s    = preg_replace( '@\x{00c6}@u'    , "AE",    $s );    // Æ => AE
    $s    = preg_replace( '@\x{00e6}@u'    , "ae",    $s );    // æ => ae
    $s    = preg_replace( '@\x{0132}@u'    , "IJ",    $s );    // ? => IJ
    $s    = preg_replace( '@\x{0133}@u'    , "ij",    $s );    // ? => ij
    $s    = preg_replace( '@\x{0152}@u'    , "OE",    $s );    // Œ => OE
    $s    = preg_replace( '@\x{0153}@u'    , "oe",    $s );    // œ => oe

    $s    = preg_replace( '@\x{00d0}@u'    , "D",    $s );    // Ð => D
    $s    = preg_replace( '@\x{0110}@u'    , "D",    $s );    // Ð => D
    $s    = preg_replace( '@\x{00f0}@u'    , "d",    $s );    // ð => d
    $s    = preg_replace( '@\x{0111}@u'    , "d",    $s );    // d => d
    $s    = preg_replace( '@\x{0126}@u'    , "H",    $s );    // H => H
    $s    = preg_replace( '@\x{0127}@u'    , "h",    $s );    // h => h
    $s    = preg_replace( '@\x{0131}@u'    , "i",    $s );    // i => i
    $s    = preg_replace( '@\x{0138}@u'    , "k",    $s );    // ? => k
    $s    = preg_replace( '@\x{013f}@u'    , "L",    $s );    // ? => L
    $s    = preg_replace( '@\x{0141}@u'    , "L",    $s );    // L => L
    $s    = preg_replace( '@\x{0140}@u'    , "l",    $s );    // ? => l
    $s    = preg_replace( '@\x{0142}@u'    , "l",    $s );    // l => l
    $s    = preg_replace( '@\x{014a}@u'    , "N",    $s );    // ? => N
    $s    = preg_replace( '@\x{0149}@u'    , "n",    $s );    // ? => n
    $s    = preg_replace( '@\x{014b}@u'    , "n",    $s );    // ? => n
    $s    = preg_replace( '@\x{00d8}@u'    , "O",    $s );    // Ø => O
    $s    = preg_replace( '@\x{00f8}@u'    , "o",    $s );    // ø => o
    $s    = preg_replace( '@\x{017f}@u'    , "s",    $s );    // ? => s
    $s    = preg_replace( '@\x{00de}@u'    , "T",    $s );    // Þ => T
    $s    = preg_replace( '@\x{0166}@u'    , "T",    $s );    // T => T
    $s    = preg_replace( '@\x{00fe}@u'    , "t",    $s );    // þ => t
    $s    = preg_replace( '@\x{0167}@u'    , "t",    $s );    // t => t

    // remove all non-ASCii characters
    $s    = preg_replace( '@[^\0-\x80]@u'    , "",    $s );


    // possible errors in UTF8-regular-expressions
    if (empty($s))
        return $original_string;
    else
        return $s;
}

function normAndUp ($a) {
    return mb_strtoupper (normalizeUtf8String($a), 'UTF-8');
}

class Link
{
    const OPDS_THUMBNAIL_TYPE = "http://opds-spec.org/image/thumbnail";
    const OPDS_IMAGE_TYPE = "http://opds-spec.org/image";
    const OPDS_ACQUISITION_TYPE = "http://opds-spec.org/acquisition";
    const OPDS_NAVIGATION_TYPE = "application/atom+xml;profile=opds-catalog;kind=navigation";
    const OPDS_PAGING_TYPE = "application/atom+xml;profile=opds-catalog;kind=acquisition";

    public $href;
    public $type;
    public $rel;
    public $title;
    public $facetGroup;
    public $activeFacet;

    public function __construct($phref, $ptype, $prel = NULL, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {
        $this->href = $phref;
        $this->type = $ptype;
        $this->rel = $prel;
        $this->title = $ptitle;
        $this->facetGroup = $pfacetGroup;
        $this->activeFacet = $pactiveFacet;
    }

    public function hrefXhtml () {
        return $this->href;
    }
}

class LinkNavigation extends Link
{
    public function __construct($phref, $prel = NULL, $ptitle = NULL) {
        parent::__construct ($phref, Link::OPDS_NAVIGATION_TYPE, $prel, $ptitle);
        if (!is_null (GetUrlParam (DB))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
        if (!preg_match ("#^\?(.*)#", $this->href) && !empty ($this->href)) $this->href = "?" . $this->href;
        if (preg_match ("/(bookdetail|getJSON).php/", $_SERVER["SCRIPT_NAME"])) {
            $this->href = "index.php" . $this->href;
        } else {
            $this->href = $_SERVER["SCRIPT_NAME"] . $this->href;
        }
    }
}

class LinkFacet extends Link
{
    public function __construct($phref, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {
        parent::__construct ($phref, Link::OPDS_PAGING_TYPE, "http://opds-spec.org/facet", $ptitle, $pfacetGroup, $pactiveFacet);
        if (!is_null (GetUrlParam (DB))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
        $this->href = $_SERVER["SCRIPT_NAME"] . $this->href;
    }
}

class Entry
{
    public $title;
    public $id;
    public $content;
    public $numberOfElement;
    public $contentType;
    public $linkArray;
    public $localUpdated;
    public $className;
    private static $updated = NULL;

    public static $icons = array(
        Author::ALL_AUTHORS_ID       => 'images/author.png',
        Serie::ALL_SERIES_ID         => 'images/serie.png',
        Book::ALL_RECENT_BOOKS_ID    => 'images/recent.png',
        Tag::ALL_TAGS_ID             => 'images/tag.png',
        Language::ALL_LANGUAGES_ID   => 'images/language.png',
        CustomColumn::ALL_CUSTOMS_ID => 'images/tag.png',
        "cops:books$"             => 'images/allbook.png',
        "cops:books:letter"       => 'images/allbook.png',
        Publisher::ALL_PUBLISHERS_ID => 'images/publisher.png'
    );

    public function getUpdatedTime () {
        if (!is_null ($this->localUpdated)) {
            return date (DATE_ATOM, $this->localUpdated);
        }
        if (is_null (self::$updated)) {
            self::$updated = time();
        }
        return date (DATE_ATOM, self::$updated);
    }

    public function getNavLink () {
        foreach ($this->linkArray as $link) {
            if ($link->type != Link::OPDS_NAVIGATION_TYPE) { continue; }

            return $link->hrefXhtml ();
        }
        return "#";
    }

    public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pclass = "", $pcount = 0) {
        global $config;
        $this->title = $ptitle;
        $this->id = $pid;
        $this->content = $pcontent;
        $this->contentType = $pcontentType;
        $this->linkArray = $plinkArray;
        $this->className = $pclass;
        $this->numberOfElement = $pcount;

        if ($config['cops_show_icons'] == 1)
        {
            foreach (self::$icons as $reg => $image)
            {
                if (preg_match ("/" . $reg . "/", $pid)) {
                    array_push ($this->linkArray, new Link (getUrlWithVersion ($image), "image/png", Link::OPDS_THUMBNAIL_TYPE));
                    break;
                }
            }
        }

        if (!is_null (GetUrlParam (DB))) $this->id = str_replace ("cops:", "cops:" . GetUrlParam (DB) . ":", $this->id);
    }
}

class EntryBook extends Entry
{
    public $book;

    public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pbook) {
        parent::__construct ($ptitle, $pid, $pcontent, $pcontentType, $plinkArray);
        $this->book = $pbook;
        $this->localUpdated = $pbook->timestamp;
    }

    public function getCoverThumbnail () {
        foreach ($this->linkArray as $link) {
            if ($link->rel == Link::OPDS_THUMBNAIL_TYPE)
                return $link->hrefXhtml ();
        }
        return null;
    }

    public function getCover () {
        foreach ($this->linkArray as $link) {
            if ($link->rel == Link::OPDS_IMAGE_TYPE)
                return $link->hrefXhtml ();
        }
        return null;
    }
}

class Page
{
    public $title;
    public $subtitle = "";
    public $authorName = "";
    public $authorUri = "";
    public $authorEmail = "";
    public $idPage;
    public $idGet;
    public $query;
    public $favicon;
    public $n;
    public $book;
    public $totalNumber = -1;
    public $entryArray = array();

    public static function getPage ($pageId, $id, $query, $n)
    {
        switch ($pageId) {
            case Base::PAGE_ALL_AUTHORS :
                return new PageAllAuthors ($id, $query, $n);
            case Base::PAGE_AUTHORS_FIRST_LETTER :
                return new PageAllAuthorsLetter ($id, $query, $n);
            case Base::PAGE_AUTHOR_DETAIL :
                return new PageAuthorDetail ($id, $query, $n);
            case Base::PAGE_ALL_TAGS :
                return new PageAllTags ($id, $query, $n);
            case Base::PAGE_TAG_DETAIL :
                return new PageTagDetail ($id, $query, $n);
            case Base::PAGE_ALL_LANGUAGES :
                return new PageAllLanguages ($id, $query, $n);
            case Base::PAGE_LANGUAGE_DETAIL :
                return new PageLanguageDetail ($id, $query, $n);
            case Base::PAGE_ALL_CUSTOMS :
                return new PageAllCustoms ($id, $query, $n);
            case Base::PAGE_CUSTOM_DETAIL :
                return new PageCustomDetail ($id, $query, $n);
            case Base::PAGE_ALL_RATINGS :
                return new PageAllRating ($id, $query, $n);
            case Base::PAGE_RATING_DETAIL :
                return new PageRatingDetail ($id, $query, $n);
            case Base::PAGE_ALL_SERIES :
                return new PageAllSeries ($id, $query, $n);
            case Base::PAGE_ALL_BOOKS :
                return new PageAllBooks ($id, $query, $n);
            case Base::PAGE_ALL_BOOKS_LETTER:
                return new PageAllBooksLetter ($id, $query, $n);
            case Base::PAGE_ALL_RECENT_BOOKS :
                return new PageRecentBooks ($id, $query, $n);
            case Base::PAGE_SERIE_DETAIL :
                return new PageSerieDetail ($id, $query, $n);
            case Base::PAGE_OPENSEARCH_QUERY :
                return new PageQueryResult ($id, $query, $n);
            case Base::PAGE_BOOK_DETAIL :
                return new PageBookDetail ($id, $query, $n);
            case Base::PAGE_ALL_PUBLISHERS:
                return new PageAllPublishers ($id, $query, $n);
            case Base::PAGE_PUBLISHER_DETAIL :
                return new PagePublisherDetail ($id, $query, $n);
            case Base::PAGE_ABOUT :
                return new PageAbout ($id, $query, $n);
            case Base::PAGE_CUSTOMIZE :
                return new PageCustomize ($id, $query, $n);
            default:
                $page = new Page ($id, $query, $n);
                $page->idPage = "cops:catalog";
                return $page;
        }
    }

    public function __construct($pid, $pquery, $pn) {
        global $config;

        $this->idGet = $pid;
        $this->query = $pquery;
        $this->n = $pn;
        $this->favicon = $config['cops_icon'];
        $this->authorName = empty($config['cops_author_name']) ? utf8_encode('S<>bastien Lucas') : $config['cops_author_name'];
        $this->authorUri = empty($config['cops_author_uri']) ? 'http://blog.slucas.fr' : $config['cops_author_uri'];
        $this->authorEmail = empty($config['cops_author_email']) ? 'sebastien@slucas.fr' : $config['cops_author_email'];
    }

    public function InitializeContent ()
    {
        global $config;
        $this->title = $config['cops_title_default'];
        $this->subtitle = $config['cops_subtitle_default'];
        if (Base::noDatabaseSelected ()) {
            $i = 0;
            foreach (Base::getDbNameList () as $key) {
                $nBooks = Book::getBookCount ($i);
                array_push ($this->entryArray, new Entry ($key, "cops:{$i}:catalog",
                                        str_format (localize ("bookword", $nBooks), $nBooks), "text",
                                        array ( new LinkNavigation ("?" . DB . "={$i}")), "", $nBooks));
                $i++;
                Base::clearDb ();
            }
        } else {
            if (!in_array (PageQueryResult::SCOPE_AUTHOR, getCurrentOption ('ignored_categories'))) {
                array_push ($this->entryArray, Author::getCount());
            }
            if (!in_array (PageQueryResult::SCOPE_SERIES, getCurrentOption ('ignored_categories'))) {
                $series = Serie::getCount();
                if (!is_null ($series)) array_push ($this->entryArray, $series);
            }
            if (!in_array (PageQueryResult::SCOPE_PUBLISHER, getCurrentOption ('ignored_categories'))) {
                $publisher = Publisher::getCount();
                if (!is_null ($publisher)) array_push ($this->entryArray, $publisher);
            }
            if (!in_array (PageQueryResult::SCOPE_TAG, getCurrentOption ('ignored_categories'))) {
                $tags = Tag::getCount();
                if (!is_null ($tags)) array_push ($this->entryArray, $tags);
            }
            if (!in_array (PageQueryResult::SCOPE_RATING, getCurrentOption ('ignored_categories'))) {
                $rating = Rating::getCount();
                if (!is_null ($rating)) array_push ($this->entryArray, $rating);
            }
            if (!in_array ("language", getCurrentOption ('ignored_categories'))) {
                $languages = Language::getCount();
                if (!is_null ($languages)) array_push ($this->entryArray, $languages);
            }
            foreach ($config['cops_calibre_custom_column'] as $lookup) {
                $customId = CustomColumn::getCustomId ($lookup);
                if (!is_null ($customId)) {
                    array_push ($this->entryArray, CustomColumn::getCount($customId));
                }
            }
            $this->entryArray = array_merge ($this->entryArray, Book::getCount());

            if (Base::isMultipleDatabaseEnabled ()) $this->title =  Base::getDbName ();
        }
    }

    public function isPaginated ()
    {
        return (getCurrentOption ("max_item_per_page") != -1 &&
                $this->totalNumber != -1 &&
                $this->totalNumber > getCurrentOption ("max_item_per_page"));
    }

    public function getNextLink ()
    {
        $currentUrl = preg_replace ("/\&n=.*?$/", "", "?" . getQueryString ());
        if (($this->n) * getCurrentOption ("max_item_per_page") < $this->totalNumber) {
            return new LinkNavigation ($currentUrl . "&n=" . ($this->n + 1), "next", localize ("paging.next.alternate"));
        }
        return NULL;
    }

    public function getPrevLink ()
    {
        $currentUrl = preg_replace ("/\&n=.*?$/", "", "?" . getQueryString ());
        if ($this->n > 1) {
            return new LinkNavigation ($currentUrl . "&n=" . ($this->n - 1), "previous", localize ("paging.previous.alternate"));
        }
        return NULL;
    }

    public function getMaxPage ()
    {
        return ceil ($this->totalNumber / getCurrentOption ("max_item_per_page"));
    }

    public function containsBook ()
    {
        if (count ($this->entryArray) == 0) return false;
        if (get_class ($this->entryArray [0]) == "EntryBook") return true;
        return false;
    }
}

class PageAllAuthors extends Page
{
    public function InitializeContent ()
    {
        $this->title = localize("authors.title");
        if (getCurrentOption ("author_split_first_letter") == 1) {
            $this->entryArray = Author::getAllAuthorsByFirstLetter();
        }
        else {
            $this->entryArray = Author::getAllAuthors();
        }
        $this->idPage = Author::ALL_AUTHORS_ID;
    }
}

class PageAllAuthorsLetter extends Page
{
    public function InitializeContent ()
    {
        $this->idPage = Author::getEntryIdByLetter ($this->idGet);
        $this->entryArray = Author::getAuthorsByStartingLetter ($this->idGet);
        $this->title = str_format (localize ("splitByLetter.letter"), str_format (localize ("authorword", count ($this->entryArray)), count ($this->entryArray)), $this->idGet);
    }
}

class PageAuthorDetail extends Page
{
    public function InitializeContent ()
    {
        $author = Author::getAuthorById ($this->idGet);
        $this->idPage = $author->getEntryId ();
        $this->title = $author->name;
        list ($this->entryArray, $this->totalNumber) = Book::getBooksByAuthor ($this->idGet, $this->n);
    }
}

class PageAllPublishers extends Page
{
    public function InitializeContent ()
    {
        $this->title = localize("publishers.title");
        $this->entryArray = Publisher::getAllPublishers();
        $this->idPage = Publisher::ALL_PUBLISHERS_ID;
    }
}

class PagePublisherDetail extends Page
{
    public function InitializeContent ()
    {
        $publisher = Publisher::getPublisherById ($this->idGet);
        $this->title = $publisher->name;
        list ($this->entryArray, $this->totalNumber) = Book::getBooksByPublisher ($this->idGet, $this->n);
        $this->idPage = $publisher->getEntryId ();
    }
}

class PageAllTags extends Page
{
    public function InitializeContent ()
    {
        $this->title = localize("tags.title");
        $this->entryArray = Tag::getAllTags();
        $this->idPage = Tag::ALL_TAGS_ID;
    }
}

class PageAllLanguages extends Page
{
    public function InitializeContent ()
    {
        $this->title = localize("languages.title");
        $this->entryArray = Language::getAllLanguages();
        $this->idPage = Language::ALL_LANGUAGES_ID;
    }
}

class PageCustomDetail extends Page
{
    public function InitializeContent ()
    {
        $customId = getURLParam ("custom", NULL);
        $custom = CustomColumn::getCustomById ($customId, $this->idGet);
        $this->idPage = $custom->getEntryId ();
        $this->title = $custom->name;
        list ($this->entryArray, $this->totalNumber) = Book::getBooksByCustom ($customId, $this->idGet, $this->n);
    }
}

class PageAllCustoms extends Page
{
    public function InitializeContent ()
    {
        $customId = getURLParam ("custom", NULL);
        $this->title = CustomColumn::getAllTitle ($customId);
        $this->entryArray = CustomColumn::getAllCustoms($customId);
        $this->idPage = CustomColumn::getAllCustomsId ($customId);
    }
}

class PageTagDetail extends Page
{
    public function InitializeContent ()
    {
        $tag = Tag::getTagById ($this->idGet);
        $this->idPage = $tag->getEntryId ();
        $this->title = $tag->name;
        list ($this->entryArray, $this->totalNumber) = Book::getBooksByTag ($this->idGet, $this->n);
    }
}

class PageLanguageDetail extends Page
{
    public function InitializeContent ()
    {
        $language = Language::getLanguageById ($this->idGet);
        $this->idPage = $language->getEntryId ();
        $this->title = $language->lang_code;
        list ($this->entryArray, $this->totalNumber) = Book::getBooksByLanguage ($this->idGet, $this->n);
    }
}

class PageAllSeries extends Page
{
    public function InitializeContent ()
    {
        $this->title = localize("series.title");
        $this->entryArray = Serie::getAllSeries();
        $this->idPage = Serie::ALL_SERIES_ID;
    }
}

class PageSerieDetail extends Page
{
    public function InitializeContent ()
    {
        $serie = Serie::getSerieById ($this->idGet);
        $this->title = $serie->name;
        list ($this->entryArray, $this->totalNumber) = Book::getBooksBySeries ($this->idGet, $this->n);
        $this->idPage = $serie->getEntryId ();
    }
}

class PageAllRating extends Page
{
    public function InitializeContent ()
    {
        $this->title = localize("ratings.title");
        $this->entryArray = Rating::getAllRatings();
        $this->idPage = Rating::ALL_RATING_ID;
    }
}

class PageRatingDetail extends Page
{
    public function InitializeContent ()
    {
        $rating = Rating::getRatingById ($this->idGet);
        $this->idPage = $rating->getEntryId ();
        $this->title =str_format (localize ("ratingword", $rating->name/2), $rating->name/2);
        list ($this->entryArray, $this->totalNumber) = Book::getBooksByRating ($this->idGet, $this->n);
    }
}

class PageAllBooks extends Page
{
    public function InitializeContent ()
    {
        $this->title = localize ("allbooks.title");
        if (getCurrentOption ("titles_split_first_letter") == 1) {
            $this->entryArray = Book::getAllBooks();
        }
        else {
            list ($this->entryArray, $this->totalNumber) = Book::getBooks ($this->n);
        }
        $this->idPage = Book::ALL_BOOKS_ID;
    }
}

class PageAllBooksLetter extends Page
{
    public function InitializeContent ()
    {
        list ($this->entryArray, $this->totalNumber) = Book::getBooksByStartingLetter ($this->idGet, $this->n);
        $this->idPage = Book::getEntryIdByLetter ($this->idGet);

        $count = $this->totalNumber;
        if ($count == -1)
            $count = count ($this->entryArray);

        $this->title = str_format (localize ("splitByLetter.letter"), str_format (localize ("bookword", $count), $count), $this->idGet);
    }
}

class PageRecentBooks extends Page
{
    public function InitializeContent ()
    {
        $this->title = localize ("recent.title");
        $this->entryArray = Book::getAllRecentBooks ();
        $this->idPage = Book::ALL_RECENT_BOOKS_ID;
    }
}

class PageQueryResult extends Page
{
    const SCOPE_TAG = "tag";
    const SCOPE_RATING = "rating";
    const SCOPE_SERIES = "series";
    const SCOPE_AUTHOR = "author";
    const SCOPE_BOOK = "book";
    const SCOPE_PUBLISHER = "publisher";

    private function useTypeahead () {
        return !is_null (getURLParam ("search"));
    }

    private function searchByScope ($scope, $limit = FALSE) {
        $n = $this->n;
        $numberPerPage = NULL;
        $queryNormedAndUp = $this->query;
        if (useNormAndUp ()) {
            $queryNormedAndUp = normAndUp ($this->query);
        }
        if ($limit) {
            $n = 1;
            $numberPerPage = 5;
        }
        switch ($scope) {
            case self::SCOPE_BOOK :
                $array = Book::getBooksByStartingLetter ('%' . $queryNormedAndUp, $n, NULL, $numberPerPage);
                break;
            case self::SCOPE_AUTHOR :
                $array = Author::getAuthorsForSearch ('%' . $queryNormedAndUp);
                break;
            case self::SCOPE_SERIES :
                $array = Serie::getAllSeriesByQuery ($queryNormedAndUp);
                break;
            case self::SCOPE_TAG :
                $array = Tag::getAllTagsByQuery ($queryNormedAndUp, $n, NULL, $numberPerPage);
                break;
            case self::SCOPE_PUBLISHER :
                $array = Publisher::getAllPublishersByQuery ($queryNormedAndUp);
                break;
            default:
                $array = Book::getBooksByQuery (
                    array ("all" => "%" . $queryNormedAndUp . "%"), $n);
        }

        return $array;
    }

    public function doSearchByCategory () {
        $database = GetUrlParam (DB);
        $out = array ();
        $pagequery = Base::PAGE_OPENSEARCH_QUERY;
        $dbArray = array ("");
        $d = $database;
        $query = $this->query;
        // Special case when no databases were chosen, we search on all databases
        if (Base::noDatabaseSelected ()) {
            $dbArray = Base::getDbNameList ();
            $d = 0;
        }
        foreach ($dbArray as $key) {
            if (Base::noDatabaseSelected ()) {
                array_push ($this->entryArray, new Entry ($key, DB . ":query:{$d}",
                                        " ", "text",
                                        array ( new LinkNavigation ("?" . DB . "={$d}")), "tt-header"));
                Base::getDb ($d);
            }
            foreach (array (PageQueryResult::SCOPE_BOOK,
                            PageQueryResult::SCOPE_AUTHOR,
                            PageQueryResult::SCOPE_SERIES,
                            PageQueryResult::SCOPE_TAG,
                            PageQueryResult::SCOPE_PUBLISHER) as $key) {
                if (in_array($key, getCurrentOption ('ignored_categories'))) {
                    continue;
                }
                $array = $this->searchByScope ($key, TRUE);

                $i = 0;
                if (count ($array) == 2 && is_array ($array [0])) {
                    $total = $array [1];
                    $array = $array [0];
                } else {
                    $total = count($array);
                }
                if ($total > 0) {
                    // Comment to help the perl i18n script
                    // str_format (localize("bookword", count($array))
                    // str_format (localize("authorword", count($array))
                    // str_format (localize("seriesword", count($array))
                    // str_format (localize("tagword", count($array))
                    // str_format (localize("publisherword", count($array))
                    array_push ($this->entryArray, new Entry (str_format (localize ("search.result.{$key}"), $this->query), DB . ":query:{$d}:{$key}",
                                        str_format (localize("{$key}word", $total), $total), "text",
                                        array ( new LinkNavigation ("?page={$pagequery}&query={$query}&db={$d}&scope={$key}")),
                                        Base::noDatabaseSelected () ? "" : "tt-header"));
                }
                if (!Base::noDatabaseSelected () && $this->useTypeahead ()) {
                    foreach ($array as $entry) {
                        array_push ($this->entryArray, $entry);
                        $i++;
                        if ($i > 4) { break; };
                    }
                }
            }
            $d++;
            if (Base::noDatabaseSelected ()) {
                Base::clearDb ();
            }
        }
        return $out;
    }

    public function InitializeContent ()
    {
        $scope = getURLParam ("scope");
        if (empty ($scope)) {
            $this->title = str_format (localize ("search.result"), $this->query);
        } else {
            // Comment to help the perl i18n script
            // str_format (localize ("search.result.author"), $this->query)
            // str_format (localize ("search.result.tag"), $this->query)
            // str_format (localize ("search.result.series"), $this->query)
            // str_format (localize ("search.result.book"), $this->query)
            // str_format (localize ("search.result.publisher"), $this->query)
            $this->title = str_format (localize ("search.result.{$scope}"), $this->query);
        }

        $crit = "%" . $this->query . "%";

        // Special case when we are doing a search and no database is selected
        if (Base::noDatabaseSelected () && !$this->useTypeahead ()) {
            $i = 0;
            foreach (Base::getDbNameList () as $key) {
                Base::clearDb ();
                list ($array, $totalNumber) = Book::getBooksByQuery (array ("all" => $crit), 1, $i, 1);
                array_push ($this->entryArray, new Entry ($key, DB . ":query:{$i}",
                                        str_format (localize ("bookword", $totalNumber), $totalNumber), "text",
                                        array ( new LinkNavigation ("?" . DB . "={$i}&page=9&query=" . $this->query))));
                $i++;
            }
            return;
        }
        if (empty ($scope)) {
            $this->doSearchByCategory ();
            return;
        }

        $array = $this->searchByScope ($scope);
        if (count ($array) == 2 && is_array ($array [0])) {
            list ($this->entryArray, $this->totalNumber) = $array;
        } else {
            $this->entryArray = $array;
        }
    }
}

class PageBookDetail extends Page
{
    public function InitializeContent ()
    {
        $this->book = Book::getBookById ($this->idGet);
        $this->title = $this->book->title;
    }
}

class PageAbout extends Page
{
    public function InitializeContent ()
    {
        $this->title = localize ("about.title");
    }
}

class PageCustomize extends Page
{
    private function isChecked ($key, $testedValue = 1) {
        $value = getCurrentOption ($key);
        if (is_array ($value)) {
            if (in_array ($testedValue, $value)) {
                return "checked='checked'";
            }
        } else {
            if ($value == $testedValue) {
                return "checked='checked'";
            }
        }
        return "";
    }

    private function isSelected ($key, $value) {
        if (getCurrentOption ($key) == $value) {
            return "selected='selected'";
        }
        return "";
    }

    private function getStyleList () {
        $result = array ();
        foreach (glob ("templates/" . getCurrentTemplate () . "/styles/style-*.css") as $filename) {
            if (preg_match ('/styles\/style-(.*?)\.css/', $filename, $m)) {
                array_push ($result, $m [1]);
            }
        }
        return $result;
    }

    public function InitializeContent ()
    {
        $this->title = localize ("customize.title");
        $this->entryArray = array ();

        $ignoredBaseArray = array (PageQueryResult::SCOPE_AUTHOR,
                                   PageQueryResult::SCOPE_TAG,
                                   PageQueryResult::SCOPE_SERIES,
                                   PageQueryResult::SCOPE_PUBLISHER,
                                   PageQueryResult::SCOPE_RATING,
                                   "language");

        $content = "";
        if (!preg_match("/(Kobo|Kindle\/3.0|EBRD1101)/", $_SERVER['HTTP_USER_AGENT'])) {
            $content .= '<select id="style" onchange="updateCookie (this);">';
            foreach ($this-> getStyleList () as $filename) {
                $content .= "<option value='{$filename}' " . $this->isSelected ("style", $filename) . ">{$filename}</option>";
            }
            $content .= '</select>';
        } else {
            foreach ($this-> getStyleList () as $filename) {
                $content .= "<input type='radio' onchange='updateCookieFromCheckbox (this);' id='style-{$filename}' name='style' value='{$filename}' " . $this->isChecked ("style", $filename) . " /><label for='style-{$filename}'> {$filename} </label>";
            }
        }
        array_push ($this->entryArray, new Entry (localize ("customize.style"), "",
                                        $content, "text",
                                        array ()));
        if (!useServerSideRendering ()) {
            $content = '<input type="checkbox" onchange="updateCookieFromCheckbox (this);" id="use_fancyapps" ' . $this->isChecked ("use_fancyapps") . ' />';
            array_push ($this->entryArray, new Entry (localize ("customize.fancybox"), "",
                                            $content, "text",
                                            array ()));
        }
        $content = '<input type="number" onchange="updateCookie (this);" id="max_item_per_page" value="' . getCurrentOption ("max_item_per_page") . '" min="-1" max="1200" pattern="^[-+]?[0-9]+$" />';
        array_push ($this->entryArray, new Entry (localize ("customize.paging"), "",
                                        $content, "text",
                                        array ()));
        $content = '<input type="text" onchange="updateCookie (this);" id="email" value="' . getCurrentOption ("email") . '" />';
        array_push ($this->entryArray, new Entry (localize ("customize.email"), "",
                                        $content, "text",
                                        array ()));
        $content = '<input type="checkbox" onchange="updateCookieFromCheckbox (this);" id="html_tag_filter" ' . $this->isChecked ("html_tag_filter") . ' />';
        array_push ($this->entryArray, new Entry (localize ("customize.filter"), "",
                                        $content, "text",
                                        array ()));
        $content = "";
        foreach ($ignoredBaseArray as $key) {
            $keyPlural = preg_replace ('/(ss)$/', 's', $key . "s");
            $content .=  '<input type="checkbox" name="ignored_categories[]" onchange="updateCookieFromCheckboxGroup (this);" id="ignored_categories_' . $key . '" ' . $this->isChecked ("ignored_categories", $key) . ' > ' . localize ("{$keyPlural}.title") . '</input> ';
        }

        array_push ($this->entryArray, new Entry (localize ("customize.ignored"), "",
                                        $content, "text",
                                        array ()));
    }
}


abstract class Base
{
    const PAGE_INDEX = "index";
    const PAGE_ALL_AUTHORS = "1";
    const PAGE_AUTHORS_FIRST_LETTER = "2";
    const PAGE_AUTHOR_DETAIL = "3";
    const PAGE_ALL_BOOKS = "4";
    const PAGE_ALL_BOOKS_LETTER = "5";
    const PAGE_ALL_SERIES = "6";
    const PAGE_SERIE_DETAIL = "7";
    const PAGE_OPENSEARCH = "8";
    const PAGE_OPENSEARCH_QUERY = "9";
    const PAGE_ALL_RECENT_BOOKS = "10";
    const PAGE_ALL_TAGS = "11";
    const PAGE_TAG_DETAIL = "12";
    const PAGE_BOOK_DETAIL = "13";
    const PAGE_ALL_CUSTOMS = "14";
    const PAGE_CUSTOM_DETAIL = "15";
    const PAGE_ABOUT = "16";
    const PAGE_ALL_LANGUAGES = "17";
    const PAGE_LANGUAGE_DETAIL = "18";
    const PAGE_CUSTOMIZE = "19";
    const PAGE_ALL_PUBLISHERS = "20";
    const PAGE_PUBLISHER_DETAIL = "21";
    const PAGE_ALL_RATINGS = "22";
    const PAGE_RATING_DETAIL = "23";

    const COMPATIBILITY_XML_ALDIKO = "aldiko";

    private static $db = NULL;

    public static function isMultipleDatabaseEnabled () {
        global $config;
        return is_array ($config['calibre_directory']);
    }

    public static function useAbsolutePath () {
        global $config;
        $path = self::getDbDirectory();
        return preg_match ('/^\//', $path) || // Linux /
               preg_match ('/^\w\:/', $path); // Windows X:
    }

    public static function noDatabaseSelected () {
        return self::isMultipleDatabaseEnabled () && is_null (GetUrlParam (DB));
    }

    public static function getDbList () {
        global $config;
        if (self::isMultipleDatabaseEnabled ()) {
            return $config['calibre_directory'];
        } else {
            return array ("" => $config['calibre_directory']);
        }
    }

    public static function getDbNameList () {
        global $config;
        if (self::isMultipleDatabaseEnabled ()) {
            return array_keys ($config['calibre_directory']);
        } else {
            return array ("");
        }
    }

    public static function getDbName ($database = NULL) {
        global $config;
        if (self::isMultipleDatabaseEnabled ()) {
            if (is_null ($database)) $database = GetUrlParam (DB, 0);
            $array = array_keys ($config['calibre_directory']);
            return  $array[$database];
        }
        return "";
    }

    public static function getDbDirectory ($database = NULL) {
        global $config;
        if (self::isMultipleDatabaseEnabled ()) {
            if (is_null ($database)) $database = GetUrlParam (DB, 0);
            $array = array_values ($config['calibre_directory']);
            return  $array[$database];
        }
        return $config['calibre_directory'];
    }


    public static function getDbFileName ($database = NULL) {
        return self::getDbDirectory ($database) .'metadata.db';
    }

    private static function error () {
        if (php_sapi_name() != "cli") {
            header("location: checkconfig.php?err=1");
        }
        throw new Exception('Database not found.');
    }

    public static function getDb ($database = NULL) {
        if (is_null (self::$db)) {
            try {
                if (is_readable (self::getDbFileName ($database))) {
                    self::$db = new PDO('sqlite:'. self::getDbFileName ($database));
                    if (useNormAndUp ()) {
                        self::$db->sqliteCreateFunction ('normAndUp', 'normAndUp', 1);
                    }
                } else {
                    self::error ();
                }
            } catch (Exception $e) {
                self::error ();
            }
        }
        return self::$db;
    }

    public static function checkDatabaseAvailability () {
        if (self::noDatabaseSelected ()) {
            for ($i = 0; $i < count (self::getDbList ()); $i++) {
                self::getDb ($i);
                self::clearDb ();
            }
        } else {
            self::getDb ();
        }
        return true;
    }

    public static function clearDb () {
        self::$db = NULL;
    }

    public static function executeQuerySingle ($query, $database = NULL) {
        return self::getDb ($database)->query($query)->fetchColumn();
    }

    public static function getCountGeneric($table, $id, $pageId, $numberOfString = NULL) {
        if (!$numberOfString) {
            $numberOfString = $table . ".alphabetical";
        }
        $count = self::executeQuerySingle ('select count(*) from ' . $table);
        if ($count == 0) return NULL;
        $entry = new Entry (localize($table . ".title"), $id,
            str_format (localize($numberOfString, $count), $count), "text",
            array ( new LinkNavigation ("?page=".$pageId)), "", $count);
        return $entry;
    }

    public static function getEntryArrayWithBookNumber ($query, $columns, $params, $category) {
        list (, $result) = self::executeQuery ($query, $columns, "", $params, -1);
        $entryArray = array();
        while ($post = $result->fetchObject ())
        {
            $instance = new $category ($post);
            array_push ($entryArray, new Entry ($post->sort, $instance->getEntryId (),
                str_format (localize("bookword", $post->count), $post->count), "text",
                array ( new LinkNavigation ($instance->getUri ())), "", $post->count));
        }
        return $entryArray;
    }

    public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {
        $totalResult = -1;

        if (useNormAndUp ()) {
            $query = preg_replace("/upper/", "normAndUp", $query);
            $columns = preg_replace("/upper/", "normAndUp", $columns);
        }

        if (is_null ($numberPerPage)) {
            $numberPerPage = getCurrentOption ("max_item_per_page");
        }

        if ($numberPerPage != -1 && $n != -1)
        {
            // First check total number of results
            $result = self::getDb ($database)->prepare (str_format ($query, "count(*)", $filter));
            $result->execute ($params);
            $totalResult = $result->fetchColumn ();

            // Next modify the query and params
            $query .= " limit ?, ?";
            array_push ($params, ($n - 1) * $numberPerPage, $numberPerPage);
        }

        $result = self::getDb ($database)->prepare(str_format ($query, $columns, $filter));
        $result->execute ($params);
        return array ($totalResult, $result);
    }

}
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								<?php
 								/**
 								 * COPS (Calibre OPDS PHP Server) class file
 								 *
 								 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
-												ratings detail title

											
										
										
											2014-02-28 12:10:04 +02:00
+								 * @author     S<EFBFBD>bastien Lucas <sebastien@slucas.fr>
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								 */
-												Prepare next version

											
										
										
											2014-04-04 23:09:22 +03:00
+								define ("VERSION", "1.0.0RC2");
-												Basic multidatabase support. re #40

TODO :
 * Document the new option
 * Handle URL rewriting
 * Handle bookdetail
 * Test the case without fancybox
 * Update the title with database name

											
										
										
											2013-04-04 09:55:58 +03:00
+								define ("DB", "db");
-												Add a default timezone (reported by gaspine)

											
										
										
											2012-06-23 15:50:50 +03:00
+								date_default_timezone_set($config['default_timezone']);
-												Small modif

											
										
										
											2013-10-03 10:05:38 +03:00
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add (again) server side rendering ! the list of user agent need to be completed but it should work.

											
										
										
											2013-08-22 16:20:30 +03:00
+								function useServerSideRendering () {
 								    global $config;
 								    return preg_match("/" . $config['cops_server_side_render'] . "/", $_SERVER['HTTP_USER_AGENT']);
 								}
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add a test for function creation. I can't manage to make it fail when needed. Still I'll commit anyway !

											
										
										
											2014-01-06 22:24:11 +02:00
+								function serverSideRender ($data) {
 								    // Get the templates
-												Begin the templating

											
										
										
											2014-02-06 22:26:20 +02:00
+								    $theme = getCurrentTemplate ();
 								    $header = file_get_contents('templates/' . $theme . '/header.html');
 								    $footer = file_get_contents('templates/' . $theme . '/footer.html');
 								    $main = file_get_contents('templates/' . $theme . '/main.html');
 								    $bookdetail = file_get_contents('templates/' . $theme . '/bookdetail.html');
 								    $page = file_get_contents('templates/' . $theme . '/page.html');
-												Add a test for function creation. I can't manage to make it fail when needed. Still I'll commit anyway !

											
										
										
											2014-01-06 22:24:11 +02:00
 								    // Generate the function for the template
 								    $template = new doT ();
 								    $dot = $template->template ($page, array ("bookdetail" => $bookdetail,
 								                                              "header" => $header,
 								                                              "footer" => $footer,
 								                                              "main" => $main));
 								    // Execute the template
 								    if (!empty ($data)) {
 								        return $dot ($data);
 								    }
-												Fix trailing spaces

											
										
										
											2014-01-06 22:24:45 +02:00
-												Add a test for function creation. I can't manage to make it fail when needed. Still I'll commit anyway !

											
										
										
											2014-01-06 22:24:11 +02:00
+								    return NULL;
 								}
-												Fix a problem with PHP embedded server. $_SERVER['QUERY_STRING'] is not set if it's empty.

											
										
										
											2013-11-29 10:34:32 +02:00
+								function getQueryString () {
 								    if ( isset($_SERVER['QUERY_STRING']) ) {
 								        return $_SERVER['QUERY_STRING'];
 								    }
 								    return "";
 								}
-												Duplicate

											
										
										
											2014-02-13 19:03:38 +02:00
+								function notFound () {
 								    header($_SERVER["SERVER_PROTOCOL"]." 404 Not Found");
 								    header("Status: 404 Not Found");
 								    $_SERVER['REDIRECT_STATUS'] = 404;
 								}
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								function getURLParam ($name, $default = NULL) {
-												Fix search. re #73

											
										
										
											2013-06-21 09:38:02 +03:00
+								    if (!empty ($_GET) && isset($_GET[$name]) && $_GET[$name] != "") {
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								        return $_GET[$name];
 								    }
 								    return $default;
 								}
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
-												The current Css is modified if a specific cookie is set. re #25

											
										
										
											2013-05-29 22:13:02 +03:00
+								function getCurrentOption ($option) {
 								    global $config;
 								    if (isset($_COOKIE[$option])) {
-												The ignored categories is now in the customize UI page. re #34

It's far from complete but it works. I'll have to check the strings consistancy.

											
										
										
											2013-12-17 23:45:51 +02:00
+								        if (isset($config ["cops_" . $option]) && is_array ($config ["cops_" . $option])) {
 								            return explode (",", $_COOKIE[$option]);
 								        } else {
 								            return $_COOKIE[$option];
 								        }
-												The current Css is modified if a specific cookie is set. re #25

											
										
										
											2013-05-29 22:13:02 +03:00
+								    }
 								    if ($option == "style") {
 								        return "default";
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add the email in the customize page. re #53

											
										
										
											2013-07-04 00:40:08 +03:00
+								    if (isset($config ["cops_" . $option])) {
 								        return $config ["cops_" . $option];
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add the email in the customize page. re #53

											
										
										
											2013-07-04 00:40:08 +03:00
+								    return "";
-												The current Css is modified if a specific cookie is set. re #25

											
										
										
											2013-05-29 22:13:02 +03:00
+								}
-												Move the CSS to a specific directory. re #25

											
										
										
											2013-05-28 08:49:52 +03:00
+								function getCurrentCss () {
-												Move all default styles in the templates directory. re #79

--HG--
rename : styles/FontAwesome.otf => templates/default/styles/FontAwesome.otf
rename : styles/font-awesome.css => templates/default/styles/font-awesome.css
rename : styles/fontawesome-webfont.eot => templates/default/styles/fontawesome-webfont.eot
rename : styles/fontawesome-webfont.svg => templates/default/styles/fontawesome-webfont.svg
rename : styles/fontawesome-webfont.ttf => templates/default/styles/fontawesome-webfont.ttf
rename : styles/fontawesome-webfont.woff => templates/default/styles/fontawesome-webfont.woff
rename : styles/style-base.css => templates/default/styles/style-base.css
rename : styles/style-default.css => templates/default/styles/style-default.css
rename : styles/style-eink.css => templates/default/styles/style-eink.css
rename : styles/style-iphone.css => templates/default/styles/style-iphone.css

											
										
										
											2014-02-16 17:55:38 +02:00
+								    return "templates/" . getCurrentTemplate () . "/styles/style-" . getCurrentOption ("style") . ".css";
-												Move the CSS to a specific directory. re #25

											
										
										
											2013-05-28 08:49:52 +03:00
+								}
-												Begin the templating

											
										
										
											2014-02-06 22:26:20 +02:00
+								function getCurrentTemplate () {
-												Bad commit

											
										
										
											2014-02-09 22:18:05 +02:00
+								    return "default";
-												Begin the templating

											
										
										
											2014-02-06 22:26:20 +02:00
+								}
-												Ad script / images / css versionning to allow aggressive cache

											
										
										
											2012-06-02 10:10:54 +03:00
+								function getUrlWithVersion ($url) {
 								    return $url . "?v=" . VERSION;
 								}
-												Hopefully fix all the remaining case where the book summary is full of HTML crap.

Should fix all the OPDS page not working with Mantano and FBReaderJ.

											
										
										
											2013-02-19 22:50:38 +02:00
+								function xml2xhtml($xml) {
 								    return preg_replace_callback('#<(\w+)([^>]*)\s*/>#s', create_function('$m', '
 								        $xhtml_tags = array("br", "hr", "input", "frame", "img", "area", "link", "col", "base", "basefont", "param");
 								        return in_array($m[1], $xhtml_tags) ? "<$m[1]$m[2] />" : "<$m[1]$m[2]></$m[1]>";
 								    '), $xml);
 								}
-												Hopefully fix again comments. Reported by Alain. fixes #55

											
										
										
											2013-04-03 15:41:58 +03:00
+								function display_xml_error($error)
 								{
-												Fix some warnings

											
										
										
											2014-01-11 19:21:18 +02:00
+								    $return = "";
-												Hopefully fix again comments. Reported by Alain. fixes #55

											
										
										
											2013-04-03 15:41:58 +03:00
+								    $return .= str_repeat('-', $error->column) . "^\n";
 								    switch ($error->level) {
 								        case LIBXML_ERR_WARNING:
 								            $return .= "Warning $error->code: ";
 								            break;
 								         case LIBXML_ERR_ERROR:
 								            $return .= "Error $error->code: ";
 								            break;
 								        case LIBXML_ERR_FATAL:
 								            $return .= "Fatal Error $error->code: ";
 								            break;
 								    }
 								    $return .= trim($error->message) .
 								               "\n  Line: $error->line" .
 								               "\n  Column: $error->column";
 								    if ($error->file) {
 								        $return .= "\n  File: $error->file";
 								    }
 								    return "$return\n\n--------------------------------------------\n\n";
 								}
 								function are_libxml_errors_ok ()
 								{
 								    $errors = libxml_get_errors();
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Hopefully fix again comments. Reported by Alain. fixes #55

											
										
										
											2013-04-03 15:41:58 +03:00
+								    foreach ($errors as $error) {
 								        if ($error->code == 801) return false;
 								    }
 								    return true;
 								}
-												Hopefully fix all the remaining case where the book summary is full of HTML crap.

Should fix all the OPDS page not working with Mantano and FBReaderJ.

											
										
										
											2013-02-19 22:50:38 +02:00
+								function html2xhtml ($html) {
 								    $doc = new DOMDocument();
-												Hopefully fix again comments. Reported by Alain. fixes #55

											
										
										
											2013-04-03 15:41:58 +03:00
+								    libxml_use_internal_errors(true);
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
 								    $doc->loadHTML('<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body>' .
-												Reindent. re #55

											
										
										
											2013-04-09 22:30:33 +03:00
+								                        $html  . '</body></html>'); // Load the HTML
 								    $output = $doc->saveXML($doc->documentElement); // Transform to an Ansi xml stream
 								    $output = xml2xhtml($output);
 								    if (preg_match ('#<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></meta></head><body>(.*)</body></html>#ms', $output, $matches)) {
 								        $output = $matches [1]; // Remove <html><body>
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    /*
-												Hopefully fix again comments. Reported by Alain. fixes #55

											
										
										
											2013-04-03 15:41:58 +03:00
+								    // In case of error with summary, use it to debug
 								    $errors = libxml_get_errors();
 								    foreach ($errors as $error) {
 								        $output .= display_xml_error($error);
-												Hopefully fix all the remaining case where the book summary is full of HTML crap.

Should fix all the OPDS page not working with Mantano and FBReaderJ.

											
										
										
											2013-02-19 22:50:38 +02:00
+								    }
-												Hopefully fix again comments. Reported by Alain. fixes #55

											
										
										
											2013-04-03 15:41:58 +03:00
+								    */
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Hopefully fix again comments. Reported by Alain. fixes #55

											
										
										
											2013-04-03 15:41:58 +03:00
+								    if (!are_libxml_errors_ok ()) $output = "HTML code not valid.";
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Hopefully fix the book summary problem with Wamp. re #45

											
										
										
											2013-04-09 22:29:43 +03:00
+								    libxml_use_internal_errors(false);
-												Hopefully fix all the remaining case where the book summary is full of HTML crap.

Should fix all the OPDS page not working with Mantano and FBReaderJ.

											
										
										
											2013-02-19 22:50:38 +02:00
+								    return $output;
 								}
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								/**
 								 * This method is a direct copy-paste from
 								 * http://tmont.com/blargh/2010/1/string-format-in-php
 								 */
 								function str_format($format) {
 								    $args = func_get_args();
 								    $format = array_shift($args);
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								    preg_match_all('/(?=\{)\{(\d+)\}(?!\})/', $format, $matches, PREG_OFFSET_CAPTURE);
 								    $offset = 0;
 								    foreach ($matches[1] as $data) {
 								        $i = $data[0];
 								        $format = substr_replace($format, @$args[$i], $offset + $data[1] - 1, 2 + strlen($i));
 								        $offset += strlen(@$args[$i]) - 2 - strlen($i);
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								    return $format;
 								}
 								/**
 								 * This method is based on this page
 								 * http://www.mind-it.info/2010/02/22/a-simple-approach-to-localization-in-php/
 								 */
-												Add a test for the localize function. re #96

											
										
										
											2013-10-04 13:20:34 +03:00
+								function localize($phrase, $count=-1, $reset=false) {
-												Fix some plural strings and a missing title. Reported by David Ciscar Presas.

											
										
										
											2013-01-05 15:33:12 +02:00
+								    if ($count == 0)
 								        $phrase .= ".none";
 								    if ($count == 1)
 								        $phrase .= ".one";
 								    if ($count > 1)
 								        $phrase .= ".many";
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								    /* Static keyword is used to ensure the file is loaded only once */
 								    static $translations = NULL;
-												Add a test for the localize function. re #96

											
										
										
											2013-10-04 13:20:34 +03:00
+								    if ($reset) {
 								        $translations = NULL;
 								    }
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								    /* If no instance of $translations has occured load the language file */
 								    if (is_null($translations)) {
-												Fix a bug when there no language sent (many OPDS client do that).

											
										
										
											2012-09-05 11:35:50 +03:00
+								        $lang = "en";
 								        if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE']))
 								        {
 								            $lang = substr($_SERVER['HTTP_ACCEPT_LANGUAGE'], 0, 2);
 								        }
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        $lang_file_en = NULL;
-												Add directory prefix to localisation files
											
										
										
											2013-09-11 01:41:14 +03:00
+								        $lang_file = dirname(__FILE__). '/lang/Localization_' . $lang . '.json';
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        if (!file_exists($lang_file)) {
-												Add directory prefix to localisation files
											
										
										
											2013-09-11 01:41:14 +03:00
+								            $lang_file = dirname(__FILE__). '/lang/' . 'Localization_en.json';
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        }
 								        elseif ($lang != "en") {
-												Add directory prefix to localisation files
											
										
										
											2013-09-11 01:41:14 +03:00
+								            $lang_file_en = dirname(__FILE__). '/lang/' . 'Localization_en.json';
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        }
 								        $lang_file_content = file_get_contents($lang_file);
 								        /* Load the language file as a JSON object and transform it into an associative array */
 								        $translations = json_decode($lang_file_content, true);
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Better english ... maybe

											
										
										
											2013-09-20 21:44:15 +03:00
+								        /* Clean the array of all unfinished translations */
-												Fix some warnings. re #96

											
										
										
											2013-11-18 23:00:23 +02:00
+								        foreach (array_keys ($translations) as $key) {
-												Update all translations to be sure to only have strings really used in COPS. re #39

											
										
										
											2013-09-16 21:34:50 +03:00
+								            if (preg_match ("/^##TODO##/", $key)) {
 								                unset ($translations [$key]);
 								            }
 								        }
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        if ($lang_file_en)
 								        {
 								            $lang_file_content = file_get_contents($lang_file_en);
 								            $translations_en = json_decode($lang_file_content, true);
 								            $translations = array_merge ($translations_en, $translations);
 								        }
 								    }
-												Fix language if it is not found in the i18n. Reported by le_

											
										
										
											2013-07-29 11:10:54 +03:00
+								    if (array_key_exists ($phrase, $translations)) {
 								        return $translations[$phrase];
 								    }
 								    return $phrase;
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								}
-												Small fixes to facets handling. re #21

  * Fix ths duplicate of URL parameter
  * Fix when parameter is empty

											
										
										
											2013-01-20 09:30:41 +02:00
+								function addURLParameter($urlParams, $paramName, $paramValue) {
-												Getting closer maybe.

											
										
										
											2013-11-29 08:32:08 +02:00
+								    if (empty ($urlParams)) {
 								        $urlParams = "";
 								    }
-												Update addURLParameter to allow for a leading ?. re #40

											
										
										
											2013-04-03 15:54:03 +03:00
+								    $start = "";
 								    if (preg_match ("#^\?(.*)#", $urlParams, $matches)) {
 								        $start = "?";
 								        $urlParams = $matches[1];
 								    }
-												Small fixes to facets handling. re #21

  * Fix ths duplicate of URL parameter
  * Fix when parameter is empty

											
										
										
											2013-01-20 09:30:41 +02:00
+								    $params = array();
 								    parse_str($urlParams, $params);
-												Update addURLParameter to allow for a leading ?. re #40

											
										
										
											2013-04-03 15:54:03 +03:00
+								    if (empty ($paramValue) && $paramValue != 0) {
-												Small fixes to facets handling. re #21

  * Fix ths duplicate of URL parameter
  * Fix when parameter is empty

											
										
										
											2013-01-20 09:30:41 +02:00
+								        unset ($params[$paramName]);
 								    } else {
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								        $params[$paramName] = $paramValue;
-												Small fixes to facets handling. re #21

  * Fix ths duplicate of URL parameter
  * Fix when parameter is empty

											
										
										
											2013-01-20 09:30:41 +02:00
+								    }
-												Update addURLParameter to allow for a leading ?. re #40

											
										
										
											2013-04-03 15:54:03 +03:00
+								    return $start . http_build_query($params);
-												Small fixes to facets handling. re #21

  * Fix ths duplicate of URL parameter
  * Fix when parameter is empty

											
										
										
											2013-01-20 09:30:41 +02:00
+								}
-												Allow normalized search (without diacritics) it should also fix the case problem with non latin languages (cyrillic).

The last part is not tested.

disclaimer : Slow !

re #49, #48

											
										
										
											2014-05-03 18:57:06 +03:00
+								function useNormAndUp () {
 								    global $config;
 								    return extension_loaded('mbstring') &&
 								           extension_loaded('intl') &&
 								           class_exists("Normalizer", $autoload = false) &&
 								           $config ['cops_normalized_search'] == "1";
 								}
 								function normalizeUtf8String( $s)
 								{
 								    $original_string = $s;
 								    // maps German (umlauts) and other European characters onto two characters before just removing diacritics
 								    $s    = preg_replace( '@\x{00c4}@u'    , "AE",    $s );    // umlaut Ä => AE
 								    $s    = preg_replace( '@\x{00d6}@u'    , "OE",    $s );    // umlaut Ö => OE
 								    $s    = preg_replace( '@\x{00dc}@u'    , "UE",    $s );    // umlaut Ü => UE
 								    $s    = preg_replace( '@\x{00e4}@u'    , "ae",    $s );    // umlaut ä => ae
 								    $s    = preg_replace( '@\x{00f6}@u'    , "oe",    $s );    // umlaut ö => oe
 								    $s    = preg_replace( '@\x{00fc}@u'    , "ue",    $s );    // umlaut ü => ue
 								    $s    = preg_replace( '@\x{00f1}@u'    , "ny",    $s );    // ñ => ny
 								    $s    = preg_replace( '@\x{00ff}@u'    , "yu",    $s );    // ÿ => yu
 								    // maps special characters (characters with diacritics) on their base-character followed by the diacritical mark
 								        // exmaple:  Ú => U´,  á => a`
 								    $s    = Normalizer::normalize( $s, Normalizer::FORM_D );
 								    $s    = preg_replace( '@\pM@u'        , "",    $s );    // removes diacritics
 								    $s    = preg_replace( '@\x{00df}@u'    , "ss",    $s );    // maps German ß onto ss
 								    $s    = preg_replace( '@\x{00c6}@u'    , "AE",    $s );    // Æ => AE
 								    $s    = preg_replace( '@\x{00e6}@u'    , "ae",    $s );    // æ => ae
 								    $s    = preg_replace( '@\x{0132}@u'    , "IJ",    $s );    // ? => IJ
 								    $s    = preg_replace( '@\x{0133}@u'    , "ij",    $s );    // ? => ij
 								    $s    = preg_replace( '@\x{0152}@u'    , "OE",    $s );    // Œ => OE
 								    $s    = preg_replace( '@\x{0153}@u'    , "oe",    $s );    // œ => oe
 								    $s    = preg_replace( '@\x{00d0}@u'    , "D",    $s );    // Ð => D
 								    $s    = preg_replace( '@\x{0110}@u'    , "D",    $s );    // Ð => D
 								    $s    = preg_replace( '@\x{00f0}@u'    , "d",    $s );    // ð => d
 								    $s    = preg_replace( '@\x{0111}@u'    , "d",    $s );    // d => d
 								    $s    = preg_replace( '@\x{0126}@u'    , "H",    $s );    // H => H
 								    $s    = preg_replace( '@\x{0127}@u'    , "h",    $s );    // h => h
 								    $s    = preg_replace( '@\x{0131}@u'    , "i",    $s );    // i => i
 								    $s    = preg_replace( '@\x{0138}@u'    , "k",    $s );    // ? => k
 								    $s    = preg_replace( '@\x{013f}@u'    , "L",    $s );    // ? => L
 								    $s    = preg_replace( '@\x{0141}@u'    , "L",    $s );    // L => L
 								    $s    = preg_replace( '@\x{0140}@u'    , "l",    $s );    // ? => l
 								    $s    = preg_replace( '@\x{0142}@u'    , "l",    $s );    // l => l
 								    $s    = preg_replace( '@\x{014a}@u'    , "N",    $s );    // ? => N
 								    $s    = preg_replace( '@\x{0149}@u'    , "n",    $s );    // ? => n
 								    $s    = preg_replace( '@\x{014b}@u'    , "n",    $s );    // ? => n
 								    $s    = preg_replace( '@\x{00d8}@u'    , "O",    $s );    // Ø => O
 								    $s    = preg_replace( '@\x{00f8}@u'    , "o",    $s );    // ø => o
 								    $s    = preg_replace( '@\x{017f}@u'    , "s",    $s );    // ? => s
 								    $s    = preg_replace( '@\x{00de}@u'    , "T",    $s );    // Þ => T
 								    $s    = preg_replace( '@\x{0166}@u'    , "T",    $s );    // T => T
 								    $s    = preg_replace( '@\x{00fe}@u'    , "t",    $s );    // þ => t
 								    $s    = preg_replace( '@\x{0167}@u'    , "t",    $s );    // t => t
 								    // remove all non-ASCii characters
 								    $s    = preg_replace( '@[^\0-\x80]@u'    , "",    $s );
 								    // possible errors in UTF8-regular-expressions
 								    if (empty($s))
 								        return $original_string;
 								    else
 								        return $s;
 								}
 								function normAndUp ($a) {
 								    return mb_strtoupper (normalizeUtf8String($a), 'UTF-8');
 								}
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								class Link
 								{
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								    const OPDS_THUMBNAIL_TYPE = "http://opds-spec.org/image/thumbnail";
 								    const OPDS_IMAGE_TYPE = "http://opds-spec.org/image";
 								    const OPDS_ACQUISITION_TYPE = "http://opds-spec.org/acquisition";
 								    const OPDS_NAVIGATION_TYPE = "application/atom+xml;profile=opds-catalog;kind=navigation";
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								    const OPDS_PAGING_TYPE = "application/atom+xml;profile=opds-catalog;kind=acquisition";
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    public $href;
 								    public $type;
 								    public $rel;
 								    public $title;
-												Add custom filter of tags in the OPDS feed using facets.

Need more testing but should be ok.

re #21

											
										
										
											2013-01-11 16:16:15 +02:00
+								    public $facetGroup;
 								    public $activeFacet;
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add custom filter of tags in the OPDS feed using facets.

Need more testing but should be ok.

re #21

											
										
										
											2013-01-11 16:16:15 +02:00
+								    public function __construct($phref, $ptype, $prel = NULL, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								        $this->href = $phref;
 								        $this->type = $ptype;
 								        $this->rel = $prel;
 								        $this->title = $ptitle;
-												Add custom filter of tags in the OPDS feed using facets.

Need more testing but should be ok.

re #21

											
										
										
											2013-01-11 16:16:15 +02:00
+								        $this->facetGroup = $pfacetGroup;
 								        $this->activeFacet = $pactiveFacet;
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add v0.0.3

											
										
										
											2012-05-28 08:06:12 +03:00
+								    public function hrefXhtml () {
-												Move from Xhtml to Html. re #73

											
										
										
											2013-06-25 09:40:08 +03:00
+								        return $this->href;
-												Add v0.0.3

											
										
										
											2012-05-28 08:06:12 +03:00
+								    }
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								}
 								class LinkNavigation extends Link
 								{
 								    public function __construct($phref, $prel = NULL, $ptitle = NULL) {
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        parent::__construct ($phref, Link::OPDS_NAVIGATION_TYPE, $prel, $ptitle);
-												Basic multidatabase support. re #40

TODO :
 * Document the new option
 * Handle URL rewriting
 * Handle bookdetail
 * Test the case without fancybox
 * Update the title with database name

											
										
										
											2013-04-04 09:55:58 +03:00
+								        if (!is_null (GetUrlParam (DB))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
-												Fix a bad URL in OPDS catalog. re #40

											
										
										
											2013-04-30 10:57:12 +03:00
+								        if (!preg_match ("#^\?(.*)#", $this->href) && !empty ($this->href)) $this->href = "?" . $this->href;
-												The new interface is completely in Ajax. Feel a lot faster. re #73

Uses pushState / popState to keep browser history correct and allow using back in the browser.

											
										
										
											2013-06-15 09:03:22 +03:00
+								        if (preg_match ("/(bookdetail|getJSON).php/", $_SERVER["SCRIPT_NAME"])) {
-												Fix bookdetail when Fancyapps is enabled. re #40

											
										
										
											2013-04-04 22:11:45 +03:00
+								            $this->href = "index.php" . $this->href;
 								        } else {
 								            $this->href = $_SERVER["SCRIPT_NAME"] . $this->href;
 								        }
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    }
 								}
-												Add custom filter of tags in the OPDS feed using facets.

Need more testing but should be ok.

re #21

											
										
										
											2013-01-11 16:16:15 +02:00
+								class LinkFacet extends Link
 								{
 								    public function __construct($phref, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {
 								        parent::__construct ($phref, Link::OPDS_PAGING_TYPE, "http://opds-spec.org/facet", $ptitle, $pfacetGroup, $pactiveFacet);
-												Fix OPDS link. re #40

											
										
										
											2013-04-29 17:47:16 +03:00
+								        if (!is_null (GetUrlParam (DB))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
-												Add custom filter of tags in the OPDS feed using facets.

Need more testing but should be ok.

re #21

											
										
										
											2013-01-11 16:16:15 +02:00
+								        $this->href = $_SERVER["SCRIPT_NAME"] . $this->href;
 								    }
 								}
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
 								class Entry
 								{
 								    public $title;
 								    public $id;
 								    public $content;
-												Better bootstrap template with as little text as possible.

											
										
										
											2014-05-30 16:00:46 +03:00
+								    public $numberOfElement;
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    public $contentType;
 								    public $linkArray;
 								    public $localUpdated;
-												Integrate a little better the typeahead search in the normal search page. Heavily based on At-Libitum work. re #34

											
										
										
											2013-12-22 19:40:03 +02:00
+								    public $className;
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    private static $updated = NULL;
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								    public static $icons = array(
-												Add Custom columns through config. Only tested in HTML catalog for now

re #32

											
										
										
											2013-01-19 08:08:47 +02:00
+								        Author::ALL_AUTHORS_ID       => 'images/author.png',
 								        Serie::ALL_SERIES_ID         => 'images/serie.png',
 								        Book::ALL_RECENT_BOOKS_ID    => 'images/recent.png',
 								        Tag::ALL_TAGS_ID             => 'images/tag.png',
-												Merged Language Feature.

											
										
										
											2013-05-21 20:49:21 +03:00
+								        Language::ALL_LANGUAGES_ID   => 'images/language.png',
-												Add Custom columns through config. Only tested in HTML catalog for now

re #32

											
										
										
											2013-01-19 08:08:47 +02:00
+								        CustomColumn::ALL_CUSTOMS_ID => 'images/tag.png',
-												Fix the ids in OPDS feed to produce a valid feed. fix #104

											
										
										
											2013-10-25 08:59:27 +03:00
+								        "cops:books$"             => 'images/allbook.png',
-												**2012-11-22**

**Added global support for publishers**

Files modified:

*base.php*

-   changed class Entry,

	-   adding a constant ```cops:publishers``` to the icon array for the feed.

-   changed class Page

	-   added branches to the page selector switch

-   changed Page->public function InitializeContent

	-   added call to pull publisher count from database

-   changed class PageAllBooks

	-   changed it so ```getCurrentOption``` is actually used...

-   added page descendant class ```PageAllPublishers```

	-   handles pulling the publishers category from database

-   added page descendant class ```PagePublisherDetail```

	-   handles pulling the books per publisher data from database

-   changed class PageQueryResult

	-   added constant and switches for publisher search scope

-   abstract class Base

	-   added constants for the publisher pages

*book.php*

-   added require statement for publisher.php
-   added ```SQL_BOOKS_BY_PUBLISHER``` query to retrieve books by publisher.

-   changed class Book

	-   added query constant
	-   added publisher item
	-   added test in case no known publisher
	-   added publishername and url array elements for the JSON output
	-   added public function ```getPublisher```
	-   added public static function ```getBooksByPublisher``` to fire the query

-   changed function getJson

	-   added publisher category to search
	-   added publishername (single) and publishertitle(plural) localization entries to i18n translation array

*index.php*

-   added require statement for publisher.php

*lang/Localization_en.json

-   added new localization entries for publisher labels (see below)
```
"publisher.alphabetical.many":"Alphabetical index of the {0} publishers",
"publisher.alphabetical.none":"Alphabetical index of absolutely no publisher",
"publisher.alphabetical.one":"Alphabetical index of the single publisher",
"publisher.name":"Publisher",
"publisher.title":"Publishers",
"publisherword.many":"{0} publishers",
"publisherword.none":"No publisher",
"publisherword.one":"1 publisher",

"search.result.publisher":"Search result for *{0}* in publishers",
```

*templates\bookdetail.html*

-   added publisher label and item to bookdetail popup

*test\bookTest.php*

-   added indices and names of publishers added to testdatabase as comment
-   added test function ```testGetBooksByPublisher```
-   changed test function testGetBookById to add assertion for publisher name
-   changed test function testTypeaheadSearch to add search on partial publisher name.

*test\pageTest.php*

-   changed test function testPageIndex to insert publisher category and adjust page indices
-   changed test function testPageIndexWithCustomColum to adjust for the changed page indices
-   added test function testPageAllPublishers
-   added test function testPagePublishersDetail
-   added test function testPageSearchScopePublishers

*test\BaseWithSomeBooks\metadata.db*

-   added 5 publishers spread across all 14 books, replacing the original publisher Feedbooks

Files added:

*publisher.php*

											
										
										
											2013-11-22 23:08:09 +02:00
+								        "cops:books:letter"       => 'images/allbook.png',
-												renamed constant and removed some accidental tabs.

											
										
										
											2013-11-30 17:21:52 +02:00
+								        Publisher::ALL_PUBLISHERS_ID => 'images/publisher.png'
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								    );
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    public function getUpdatedTime () {
 								        if (!is_null ($this->localUpdated)) {
 								            return date (DATE_ATOM, $this->localUpdated);
 								        }
 								        if (is_null (self::$updated)) {
 								            self::$updated = time();
 								        }
 								        return date (DATE_ATOM, self::$updated);
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Cleanly handle suggestion title. re #34

											
										
										
											2013-10-06 19:58:16 +03:00
+								    public function getNavLink () {
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								        foreach ($this->linkArray as $link) {
-												The new interface is completely in Ajax. Feel a lot faster. re #73

Uses pushState / popState to keep browser history correct and allow using back in the browser.

											
										
										
											2013-06-15 09:03:22 +03:00
+								            if ($link->type != Link::OPDS_NAVIGATION_TYPE) { continue; }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Cleanly handle suggestion title. re #34

											
										
										
											2013-10-06 19:58:16 +03:00
+								            return $link->hrefXhtml ();
-												The new interface is completely in Ajax. Feel a lot faster. re #73

Uses pushState / popState to keep browser history correct and allow using back in the browser.

											
										
										
											2013-06-15 09:03:22 +03:00
+								        }
-												Cleanly handle suggestion title. re #34

											
										
										
											2013-10-06 19:58:16 +03:00
+								        return "#";
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Better bootstrap template with as little text as possible.

											
										
										
											2014-05-30 16:00:46 +03:00
+								    public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pclass = "", $pcount = 0) {
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        global $config;
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								        $this->title = $ptitle;
 								        $this->id = $pid;
 								        $this->content = $pcontent;
 								        $this->contentType = $pcontentType;
 								        $this->linkArray = $plinkArray;
-												Integrate a little better the typeahead search in the normal search page. Heavily based on At-Libitum work. re #34

											
										
										
											2013-12-22 19:40:03 +02:00
+								        $this->className = $pclass;
-												Better bootstrap template with as little text as possible.

											
										
										
											2014-05-30 16:00:46 +03:00
+								        $this->numberOfElement = $pcount;
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        if ($config['cops_show_icons'] == 1)
 								        {
 								            foreach (self::$icons as $reg => $image)
 								            {
 								                if (preg_match ("/" . $reg . "/", $pid)) {
-												Ad script / images / css versionning to allow aggressive cache

											
										
										
											2012-06-02 10:10:54 +03:00
+								                    array_push ($this->linkArray, new Link (getUrlWithVersion ($image), "image/png", Link::OPDS_THUMBNAIL_TYPE));
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								                    break;
 								                }
 								            }
 								        }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Fix the ids in OPDS feed to produce a valid feed. fix #104

											
										
										
											2013-10-25 08:59:27 +03:00
+								        if (!is_null (GetUrlParam (DB))) $this->id = str_replace ("cops:", "cops:" . GetUrlParam (DB) . ":", $this->id);
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    }
 								}
 								class EntryBook extends Entry
 								{
 								    public $book;
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pbook) {
 								        parent::__construct ($ptitle, $pid, $pcontent, $pcontentType, $plinkArray);
 								        $this->book = $pbook;
 								        $this->localUpdated = $pbook->timestamp;
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add v0.0.3

											
										
										
											2012-05-28 08:06:12 +03:00
+								    public function getCoverThumbnail () {
 								        foreach ($this->linkArray as $link) {
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								            if ($link->rel == Link::OPDS_THUMBNAIL_TYPE)
 								                return $link->hrefXhtml ();
 								        }
 								        return null;
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								    public function getCover () {
 								        foreach ($this->linkArray as $link) {
 								            if ($link->rel == Link::OPDS_IMAGE_TYPE)
-												Add v0.0.3

											
										
										
											2012-05-28 08:06:12 +03:00
+								                return $link->hrefXhtml ();
 								        }
 								        return null;
 								    }
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								}
 								class Page
 								{
 								    public $title;
-												Add subtitle in OPDS feed. suggested by Tyler J. Wagner.

											
										
										
											2012-12-22 19:23:17 +02:00
+								    public $subtitle = "";
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public $authorName = "";
 								    public $authorUri = "";
 								    public $authorEmail = "";
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    public $idPage;
 								    public $idGet;
 								    public $query;
-												Add a config item to specify a custom icon. Based on a patch by Tyler J. Wagner.

											
										
										
											2012-12-22 19:03:52 +02:00
+								    public $favicon;
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								    public $n;
-												Bookdetail is handled with ajax. Template is not complete though. re #73

Fixes some small bugs with the other template.

											
										
										
											2013-06-15 17:09:37 +03:00
+								    public $book;
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								    public $totalNumber = -1;
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    public $entryArray = array();
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								    public static function getPage ($pageId, $id, $query, $n)
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    {
 								        switch ($pageId) {
 								            case Base::PAGE_ALL_AUTHORS :
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                return new PageAllAuthors ($id, $query, $n);
-												Add author split by starting letter.

TODO : some code refactoring

											
										
										
											2012-09-29 15:45:27 +03:00
+								            case Base::PAGE_AUTHORS_FIRST_LETTER :
 								                return new PageAllAuthorsLetter ($id, $query, $n);
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								            case Base::PAGE_AUTHOR_DETAIL :
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                return new PageAuthorDetail ($id, $query, $n);
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								            case Base::PAGE_ALL_TAGS :
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                return new PageAllTags ($id, $query, $n);
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								            case Base::PAGE_TAG_DETAIL :
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                return new PageTagDetail ($id, $query, $n);
-												Merged Language Feature.

											
										
										
											2013-05-21 20:49:21 +03:00
+								            case Base::PAGE_ALL_LANGUAGES :
 								                return new PageAllLanguages ($id, $query, $n);
 								            case Base::PAGE_LANGUAGE_DETAIL :
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								                return new PageLanguageDetail ($id, $query, $n);
-												Add Custom columns through config. Only tested in HTML catalog for now

re #32

											
										
										
											2013-01-19 08:08:47 +02:00
+								            case Base::PAGE_ALL_CUSTOMS :
 								                return new PageAllCustoms ($id, $query, $n);
 								            case Base::PAGE_CUSTOM_DETAIL :
 								                return new PageCustomDetail ($id, $query, $n);
-												raw sketch of ratings category

											
										
										
											2014-02-27 01:33:40 +02:00
+								            case Base::PAGE_ALL_RATINGS :
 								                return new PageAllRating ($id, $query, $n);
 								            case Base::PAGE_RATING_DETAIL :
 								                return new PageRatingDetail ($id, $query, $n);
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								            case Base::PAGE_ALL_SERIES :
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                return new PageAllSeries ($id, $query, $n);
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								            case Base::PAGE_ALL_BOOKS :
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                return new PageAllBooks ($id, $query, $n);
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								            case Base::PAGE_ALL_BOOKS_LETTER:
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                return new PageAllBooksLetter ($id, $query, $n);
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								            case Base::PAGE_ALL_RECENT_BOOKS :
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                return new PageRecentBooks ($id, $query, $n);
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								            case Base::PAGE_SERIE_DETAIL :
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                return new PageSerieDetail ($id, $query, $n);
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								            case Base::PAGE_OPENSEARCH_QUERY :
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                return new PageQueryResult ($id, $query, $n);
-												Add a config item to avoid using Fancyapps.
For now the about box still use Fancyapps.

Reported by mcister and Northguy

											
										
										
											2012-12-10 07:06:45 +02:00
+								            case Base::PAGE_BOOK_DETAIL :
 								                return new PageBookDetail ($id, $query, $n);
-												**2012-11-22**

**Added global support for publishers**

Files modified:

*base.php*

-   changed class Entry,

	-   adding a constant ```cops:publishers``` to the icon array for the feed.

-   changed class Page

	-   added branches to the page selector switch

-   changed Page->public function InitializeContent

	-   added call to pull publisher count from database

-   changed class PageAllBooks

	-   changed it so ```getCurrentOption``` is actually used...

-   added page descendant class ```PageAllPublishers```

	-   handles pulling the publishers category from database

-   added page descendant class ```PagePublisherDetail```

	-   handles pulling the books per publisher data from database

-   changed class PageQueryResult

	-   added constant and switches for publisher search scope

-   abstract class Base

	-   added constants for the publisher pages

*book.php*

-   added require statement for publisher.php
-   added ```SQL_BOOKS_BY_PUBLISHER``` query to retrieve books by publisher.

-   changed class Book

	-   added query constant
	-   added publisher item
	-   added test in case no known publisher
	-   added publishername and url array elements for the JSON output
	-   added public function ```getPublisher```
	-   added public static function ```getBooksByPublisher``` to fire the query

-   changed function getJson

	-   added publisher category to search
	-   added publishername (single) and publishertitle(plural) localization entries to i18n translation array

*index.php*

-   added require statement for publisher.php

*lang/Localization_en.json

-   added new localization entries for publisher labels (see below)
```
"publisher.alphabetical.many":"Alphabetical index of the {0} publishers",
"publisher.alphabetical.none":"Alphabetical index of absolutely no publisher",
"publisher.alphabetical.one":"Alphabetical index of the single publisher",
"publisher.name":"Publisher",
"publisher.title":"Publishers",
"publisherword.many":"{0} publishers",
"publisherword.none":"No publisher",
"publisherword.one":"1 publisher",

"search.result.publisher":"Search result for *{0}* in publishers",
```

*templates\bookdetail.html*

-   added publisher label and item to bookdetail popup

*test\bookTest.php*

-   added indices and names of publishers added to testdatabase as comment
-   added test function ```testGetBooksByPublisher```
-   changed test function testGetBookById to add assertion for publisher name
-   changed test function testTypeaheadSearch to add search on partial publisher name.

*test\pageTest.php*

-   changed test function testPageIndex to insert publisher category and adjust page indices
-   changed test function testPageIndexWithCustomColum to adjust for the changed page indices
-   added test function testPageAllPublishers
-   added test function testPagePublishersDetail
-   added test function testPageSearchScopePublishers

*test\BaseWithSomeBooks\metadata.db*

-   added 5 publishers spread across all 14 books, replacing the original publisher Feedbooks

Files added:

*publisher.php*

											
										
										
											2013-11-22 23:08:09 +02:00
+								            case Base::PAGE_ALL_PUBLISHERS:
 								                return new PageAllPublishers ($id, $query, $n);
 								            case Base::PAGE_PUBLISHER_DETAIL :
 								                return new PagePublisherDetail ($id, $query, $n);
-												Get rid of fancybox completely if not enabled. fixes #50

About.xml is still utf8 but looses it's BOM

											
										
										
											2013-04-21 16:00:21 +03:00
+								            case Base::PAGE_ABOUT :
 								                return new PageAbout ($id, $query, $n);
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								            case Base::PAGE_CUSTOMIZE :
-												Move customize inside the current template. re #73

											
										
										
											2013-06-27 09:27:29 +03:00
+								                return new PageCustomize ($id, $query, $n);
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								            default:
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								                $page = new Page ($id, $query, $n);
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								                $page->idPage = "cops:catalog";
 								                return $page;
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								        }
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								    public function __construct($pid, $pquery, $pn) {
-												Add a config item to specify a custom icon. Based on a patch by Tyler J. Wagner.

											
										
										
											2012-12-22 19:03:52 +02:00
+								        global $config;
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								        $this->idGet = $pid;
 								        $this->query = $pquery;
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								        $this->n = $pn;
-												Add a config item to specify a custom icon. Based on a patch by Tyler J. Wagner.

											
										
										
											2012-12-22 19:03:52 +02:00
+								        $this->favicon = $config['cops_icon'];
-												ratings detail title

											
										
										
											2014-02-28 12:10:04 +02:00
+								        $this->authorName = empty($config['cops_author_name']) ? utf8_encode('S<>bastien Lucas') : $config['cops_author_name'];
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 08:11:32 +03:00
+								        $this->authorUri = empty($config['cops_author_uri']) ? 'http://blog.slucas.fr' : $config['cops_author_uri'];
 								        $this->authorEmail = empty($config['cops_author_email']) ? 'sebastien@slucas.fr' : $config['cops_author_email'];
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
 								    public function InitializeContent ()
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    {
 								        global $config;
 								        $this->title = $config['cops_title_default'];
-												Add subtitle in OPDS feed. suggested by Tyler J. Wagner.

											
										
										
											2012-12-22 19:23:17 +02:00
+								        $this->subtitle = $config['cops_subtitle_default'];
-												Refactor the detection of the case when no database has been selected. re #127

											
										
										
											2013-12-14 12:30:42 +02:00
+								        if (Base::noDatabaseSelected ()) {
-												Basic multidatabase support. re #40

TODO :
 * Document the new option
 * Handle URL rewriting
 * Handle bookdetail
 * Test the case without fancybox
 * Update the title with database name

											
										
										
											2013-04-04 09:55:58 +03:00
+								            $i = 0;
-												Factorize a little more the DB handling. re #127

											
										
										
											2013-12-14 19:25:32 +02:00
+								            foreach (Base::getDbNameList () as $key) {
-												Add the number of book in each databases (multidatabase).

											
										
										
											2013-05-23 19:55:45 +03:00
+								                $nBooks = Book::getBookCount ($i);
-												Forgot two while fixing the ids. re #104

											
										
										
											2013-10-25 09:07:42 +03:00
+								                array_push ($this->entryArray, new Entry ($key, "cops:{$i}:catalog",
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								                                        str_format (localize ("bookword", $nBooks), $nBooks), "text",
-												Better bootstrap template with as little text as possible.

											
										
										
											2014-05-30 16:00:46 +03:00
+								                                        array ( new LinkNavigation ("?" . DB . "={$i}")), "", $nBooks));
-												Basic multidatabase support. re #40

TODO :
 * Document the new option
 * Handle URL rewriting
 * Handle bookdetail
 * Test the case without fancybox
 * Update the title with database name

											
										
										
											2013-04-04 09:55:58 +03:00
+								                $i++;
-												Add the number of book in each databases (multidatabase).

											
										
										
											2013-05-23 19:55:45 +03:00
+								                Base::clearDb ();
-												Add Custom columns through config. Only tested in HTML catalog for now

re #32

											
										
										
											2013-01-19 08:08:47 +02:00
+								            }
-												Basic multidatabase support. re #40

TODO :
 * Document the new option
 * Handle URL rewriting
 * Handle bookdetail
 * Test the case without fancybox
 * Update the title with database name

											
										
										
											2013-04-04 09:55:58 +03:00
+								        } else {
-												The ignored categories is now in the customize UI page. re #34

It's far from complete but it works. I'll have to check the strings consistancy.

											
										
										
											2013-12-17 23:45:51 +02:00
+								            if (!in_array (PageQueryResult::SCOPE_AUTHOR, getCurrentOption ('ignored_categories'))) {
-												Extend the ignored parameter to the home screen. re #34

											
										
										
											2013-12-17 21:51:22 +02:00
+								                array_push ($this->entryArray, Author::getCount());
 								            }
-												The ignored categories is now in the customize UI page. re #34

It's far from complete but it works. I'll have to check the strings consistancy.

											
										
										
											2013-12-17 23:45:51 +02:00
+								            if (!in_array (PageQueryResult::SCOPE_SERIES, getCurrentOption ('ignored_categories'))) {
-												Extend the ignored parameter to the home screen. re #34

											
										
										
											2013-12-17 21:51:22 +02:00
+								                $series = Serie::getCount();
 								                if (!is_null ($series)) array_push ($this->entryArray, $series);
 								            }
-												The ignored categories is now in the customize UI page. re #34

It's far from complete but it works. I'll have to check the strings consistancy.

											
										
										
											2013-12-17 23:45:51 +02:00
+								            if (!in_array (PageQueryResult::SCOPE_PUBLISHER, getCurrentOption ('ignored_categories'))) {
-												Extend the ignored parameter to the home screen. re #34

											
										
										
											2013-12-17 21:51:22 +02:00
+								                $publisher = Publisher::getCount();
 								                if (!is_null ($publisher)) array_push ($this->entryArray, $publisher);
 								            }
-												The ignored categories is now in the customize UI page. re #34

It's far from complete but it works. I'll have to check the strings consistancy.

											
										
										
											2013-12-17 23:45:51 +02:00
+								            if (!in_array (PageQueryResult::SCOPE_TAG, getCurrentOption ('ignored_categories'))) {
-												Extend the ignored parameter to the home screen. re #34

											
										
										
											2013-12-17 21:51:22 +02:00
+								                $tags = Tag::getCount();
 								                if (!is_null ($tags)) array_push ($this->entryArray, $tags);
 								            }
-												raw sketch of ratings category

											
										
										
											2014-02-27 01:33:40 +02:00
+								            if (!in_array (PageQueryResult::SCOPE_RATING, getCurrentOption ('ignored_categories'))) {
 								                $rating = Rating::getCount();
 								                if (!is_null ($rating)) array_push ($this->entryArray, $rating);
 								            }
-												The ignored categories is now in the customize UI page. re #34

It's far from complete but it works. I'll have to check the strings consistancy.

											
										
										
											2013-12-17 23:45:51 +02:00
+								            if (!in_array ("language", getCurrentOption ('ignored_categories'))) {
-												Extend the ignored parameter to the home screen. re #34

											
										
										
											2013-12-17 21:51:22 +02:00
+								                $languages = Language::getCount();
 								                if (!is_null ($languages)) array_push ($this->entryArray, $languages);
 								            }
-												Basic multidatabase support. re #40

TODO :
 * Document the new option
 * Handle URL rewriting
 * Handle bookdetail
 * Test the case without fancybox
 * Update the title with database name

											
										
										
											2013-04-04 09:55:58 +03:00
+								            foreach ($config['cops_calibre_custom_column'] as $lookup) {
 								                $customId = CustomColumn::getCustomId ($lookup);
 								                if (!is_null ($customId)) {
 								                    array_push ($this->entryArray, CustomColumn::getCount($customId));
 								                }
 								            }
 								            $this->entryArray = array_merge ($this->entryArray, Book::getCount());
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Refactor the detection of the case when no database has been selected. re #127

											
										
										
											2013-12-14 12:30:42 +02:00
+								            if (Base::isMultipleDatabaseEnabled ()) $this->title =  Base::getDbName ();
-												Add Custom columns through config. Only tested in HTML catalog for now

re #32

											
										
										
											2013-01-19 08:08:47 +02:00
+								        }
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    }
-												The new interface is completely in Ajax. Feel a lot faster. re #73

Uses pushState / popState to keep browser history correct and allow using back in the browser.

											
										
										
											2013-06-15 09:03:22 +03:00
-												Refactoring

											
										
										
											2012-09-21 15:19:11 +03:00
+								    public function isPaginated ()
 								    {
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								        return (getCurrentOption ("max_item_per_page") != -1 &&
 								                $this->totalNumber != -1 &&
-												Add paging to the customize page.

											
										
										
											2013-06-26 22:28:04 +03:00
+								                $this->totalNumber > getCurrentOption ("max_item_per_page"));
-												Refactoring

											
										
										
											2012-09-21 15:19:11 +03:00
+								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add basing pagin support in HTML catalog

											
										
										
											2012-09-21 14:36:52 +03:00
+								    public function getNextLink ()
 								    {
-												Fix a problem with PHP embedded server. $_SERVER['QUERY_STRING'] is not set if it's empty.

											
										
										
											2013-11-29 10:34:32 +02:00
+								        $currentUrl = preg_replace ("/\&n=.*?$/", "", "?" . getQueryString ());
-												Add paging to the customize page.

											
										
										
											2013-06-26 22:28:04 +03:00
+								        if (($this->n) * getCurrentOption ("max_item_per_page") < $this->totalNumber) {
-												Fix untranslated strings.

											
										
										
											2013-09-17 18:28:42 +03:00
+								            return new LinkNavigation ($currentUrl . "&n=" . ($this->n + 1), "next", localize ("paging.next.alternate"));
-												Add basing pagin support in HTML catalog

											
										
										
											2012-09-21 14:36:52 +03:00
+								        }
 								        return NULL;
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add basing pagin support in HTML catalog

											
										
										
											2012-09-21 14:36:52 +03:00
+								    public function getPrevLink ()
 								    {
-												Fix a problem with PHP embedded server. $_SERVER['QUERY_STRING'] is not set if it's empty.

											
										
										
											2013-11-29 10:34:32 +02:00
+								        $currentUrl = preg_replace ("/\&n=.*?$/", "", "?" . getQueryString ());
-												Add basing pagin support in HTML catalog

											
										
										
											2012-09-21 14:36:52 +03:00
+								        if ($this->n > 1) {
-												Fix untranslated strings.

											
										
										
											2013-09-17 18:28:42 +03:00
+								            return new LinkNavigation ($currentUrl . "&n=" . ($this->n - 1), "previous", localize ("paging.previous.alternate"));
-												Add basing pagin support in HTML catalog

											
										
										
											2012-09-21 14:36:52 +03:00
+								        }
 								        return NULL;
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Make HTML paging usable.

											
										
										
											2012-10-11 22:14:06 +03:00
+								    public function getMaxPage ()
 								    {
-												Add paging to the customize page.

											
										
										
											2013-06-26 22:28:04 +03:00
+								        return ceil ($this->totalNumber / getCurrentOption ("max_item_per_page"));
-												Make HTML paging usable.

											
										
										
											2012-10-11 22:14:06 +03:00
+								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add custom filter of tags in the OPDS feed using facets.

Need more testing but should be ok.

re #21

											
										
										
											2013-01-11 16:16:15 +02:00
+								    public function containsBook ()
 								    {
 								        if (count ($this->entryArray) == 0) return false;
-												Fix ugly bug. Report by mariosipad.

											
										
										
											2013-01-29 10:03:30 +02:00
+								        if (get_class ($this->entryArray [0]) == "EntryBook") return true;
-												Add custom filter of tags in the OPDS feed using facets.

Need more testing but should be ok.

re #21

											
										
										
											2013-01-11 16:16:15 +02:00
+								        return false;
 								    }
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								}
 								class PageAllAuthors extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    {
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        $this->title = localize("authors.title");
-												**2012-11-22**

**Added global support for publishers**

Files modified:

*base.php*

-   changed class Entry,

	-   adding a constant ```cops:publishers``` to the icon array for the feed.

-   changed class Page

	-   added branches to the page selector switch

-   changed Page->public function InitializeContent

	-   added call to pull publisher count from database

-   changed class PageAllBooks

	-   changed it so ```getCurrentOption``` is actually used...

-   added page descendant class ```PageAllPublishers```

	-   handles pulling the publishers category from database

-   added page descendant class ```PagePublisherDetail```

	-   handles pulling the books per publisher data from database

-   changed class PageQueryResult

	-   added constant and switches for publisher search scope

-   abstract class Base

	-   added constants for the publisher pages

*book.php*

-   added require statement for publisher.php
-   added ```SQL_BOOKS_BY_PUBLISHER``` query to retrieve books by publisher.

-   changed class Book

	-   added query constant
	-   added publisher item
	-   added test in case no known publisher
	-   added publishername and url array elements for the JSON output
	-   added public function ```getPublisher```
	-   added public static function ```getBooksByPublisher``` to fire the query

-   changed function getJson

	-   added publisher category to search
	-   added publishername (single) and publishertitle(plural) localization entries to i18n translation array

*index.php*

-   added require statement for publisher.php

*lang/Localization_en.json

-   added new localization entries for publisher labels (see below)
```
"publisher.alphabetical.many":"Alphabetical index of the {0} publishers",
"publisher.alphabetical.none":"Alphabetical index of absolutely no publisher",
"publisher.alphabetical.one":"Alphabetical index of the single publisher",
"publisher.name":"Publisher",
"publisher.title":"Publishers",
"publisherword.many":"{0} publishers",
"publisherword.none":"No publisher",
"publisherword.one":"1 publisher",

"search.result.publisher":"Search result for *{0}* in publishers",
```

*templates\bookdetail.html*

-   added publisher label and item to bookdetail popup

*test\bookTest.php*

-   added indices and names of publishers added to testdatabase as comment
-   added test function ```testGetBooksByPublisher```
-   changed test function testGetBookById to add assertion for publisher name
-   changed test function testTypeaheadSearch to add search on partial publisher name.

*test\pageTest.php*

-   changed test function testPageIndex to insert publisher category and adjust page indices
-   changed test function testPageIndexWithCustomColum to adjust for the changed page indices
-   added test function testPageAllPublishers
-   added test function testPagePublishersDetail
-   added test function testPageSearchScopePublishers

*test\BaseWithSomeBooks\metadata.db*

-   added 5 publishers spread across all 14 books, replacing the original publisher Feedbooks

Files added:

*publisher.php*

											
										
										
											2013-11-22 23:08:09 +02:00
+								        if (getCurrentOption ("author_split_first_letter") == 1) {
-												Add author split by starting letter.

TODO : some code refactoring

											
										
										
											2012-09-29 15:45:27 +03:00
+								            $this->entryArray = Author::getAllAuthorsByFirstLetter();
 								        }
 								        else {
 								            $this->entryArray = Author::getAllAuthors();
 								        }
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        $this->idPage = Author::ALL_AUTHORS_ID;
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    }
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								}
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
-												Add author split by starting letter.

TODO : some code refactoring

											
										
										
											2012-09-29 15:45:27 +03:00
+								class PageAllAuthorsLetter extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add author split by starting letter.

TODO : some code refactoring

											
										
										
											2012-09-29 15:45:27 +03:00
+								    {
 								        $this->idPage = Author::getEntryIdByLetter ($this->idGet);
 								        $this->entryArray = Author::getAuthorsByStartingLetter ($this->idGet);
-												Fix some title again :(

											
										
										
											2013-01-05 19:19:56 +02:00
+								        $this->title = str_format (localize ("splitByLetter.letter"), str_format (localize ("authorword", count ($this->entryArray)), count ($this->entryArray)), $this->idGet);
-												Add author split by starting letter.

TODO : some code refactoring

											
										
										
											2012-09-29 15:45:27 +03:00
+								    }
 								}
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								class PageAuthorDetail extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    {
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        $author = Author::getAuthorById ($this->idGet);
 								        $this->idPage = $author->getEntryId ();
 								        $this->title = $author->name;
-												Continue the refactoring

											
										
										
											2012-09-20 22:15:03 +03:00
+								        list ($this->entryArray, $this->totalNumber) = Book::getBooksByAuthor ($this->idGet, $this->n);
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    }
 								}
-												**2012-11-22**

**Added global support for publishers**

Files modified:

*base.php*

-   changed class Entry,

	-   adding a constant ```cops:publishers``` to the icon array for the feed.

-   changed class Page

	-   added branches to the page selector switch

-   changed Page->public function InitializeContent

	-   added call to pull publisher count from database

-   changed class PageAllBooks

	-   changed it so ```getCurrentOption``` is actually used...

-   added page descendant class ```PageAllPublishers```

	-   handles pulling the publishers category from database

-   added page descendant class ```PagePublisherDetail```

	-   handles pulling the books per publisher data from database

-   changed class PageQueryResult

	-   added constant and switches for publisher search scope

-   abstract class Base

	-   added constants for the publisher pages

*book.php*

-   added require statement for publisher.php
-   added ```SQL_BOOKS_BY_PUBLISHER``` query to retrieve books by publisher.

-   changed class Book

	-   added query constant
	-   added publisher item
	-   added test in case no known publisher
	-   added publishername and url array elements for the JSON output
	-   added public function ```getPublisher```
	-   added public static function ```getBooksByPublisher``` to fire the query

-   changed function getJson

	-   added publisher category to search
	-   added publishername (single) and publishertitle(plural) localization entries to i18n translation array

*index.php*

-   added require statement for publisher.php

*lang/Localization_en.json

-   added new localization entries for publisher labels (see below)
```
"publisher.alphabetical.many":"Alphabetical index of the {0} publishers",
"publisher.alphabetical.none":"Alphabetical index of absolutely no publisher",
"publisher.alphabetical.one":"Alphabetical index of the single publisher",
"publisher.name":"Publisher",
"publisher.title":"Publishers",
"publisherword.many":"{0} publishers",
"publisherword.none":"No publisher",
"publisherword.one":"1 publisher",

"search.result.publisher":"Search result for *{0}* in publishers",
```

*templates\bookdetail.html*

-   added publisher label and item to bookdetail popup

*test\bookTest.php*

-   added indices and names of publishers added to testdatabase as comment
-   added test function ```testGetBooksByPublisher```
-   changed test function testGetBookById to add assertion for publisher name
-   changed test function testTypeaheadSearch to add search on partial publisher name.

*test\pageTest.php*

-   changed test function testPageIndex to insert publisher category and adjust page indices
-   changed test function testPageIndexWithCustomColum to adjust for the changed page indices
-   added test function testPageAllPublishers
-   added test function testPagePublishersDetail
-   added test function testPageSearchScopePublishers

*test\BaseWithSomeBooks\metadata.db*

-   added 5 publishers spread across all 14 books, replacing the original publisher Feedbooks

Files added:

*publisher.php*

											
										
										
											2013-11-22 23:08:09 +02:00
+								class PageAllPublishers extends Page
 								{
 								    public function InitializeContent ()
 								    {
-												Fix the languages string to add consistancy (plural form). re #34

											
										
										
											2013-12-19 09:24:02 +02:00
+								        $this->title = localize("publishers.title");
-												**2012-11-22**

**Added global support for publishers**

Files modified:

*base.php*

-   changed class Entry,

	-   adding a constant ```cops:publishers``` to the icon array for the feed.

-   changed class Page

	-   added branches to the page selector switch

-   changed Page->public function InitializeContent

	-   added call to pull publisher count from database

-   changed class PageAllBooks

	-   changed it so ```getCurrentOption``` is actually used...

-   added page descendant class ```PageAllPublishers```

	-   handles pulling the publishers category from database

-   added page descendant class ```PagePublisherDetail```

	-   handles pulling the books per publisher data from database

-   changed class PageQueryResult

	-   added constant and switches for publisher search scope

-   abstract class Base

	-   added constants for the publisher pages

*book.php*

-   added require statement for publisher.php
-   added ```SQL_BOOKS_BY_PUBLISHER``` query to retrieve books by publisher.

-   changed class Book

	-   added query constant
	-   added publisher item
	-   added test in case no known publisher
	-   added publishername and url array elements for the JSON output
	-   added public function ```getPublisher```
	-   added public static function ```getBooksByPublisher``` to fire the query

-   changed function getJson

	-   added publisher category to search
	-   added publishername (single) and publishertitle(plural) localization entries to i18n translation array

*index.php*

-   added require statement for publisher.php

*lang/Localization_en.json

-   added new localization entries for publisher labels (see below)
```
"publisher.alphabetical.many":"Alphabetical index of the {0} publishers",
"publisher.alphabetical.none":"Alphabetical index of absolutely no publisher",
"publisher.alphabetical.one":"Alphabetical index of the single publisher",
"publisher.name":"Publisher",
"publisher.title":"Publishers",
"publisherword.many":"{0} publishers",
"publisherword.none":"No publisher",
"publisherword.one":"1 publisher",

"search.result.publisher":"Search result for *{0}* in publishers",
```

*templates\bookdetail.html*

-   added publisher label and item to bookdetail popup

*test\bookTest.php*

-   added indices and names of publishers added to testdatabase as comment
-   added test function ```testGetBooksByPublisher```
-   changed test function testGetBookById to add assertion for publisher name
-   changed test function testTypeaheadSearch to add search on partial publisher name.

*test\pageTest.php*

-   changed test function testPageIndex to insert publisher category and adjust page indices
-   changed test function testPageIndexWithCustomColum to adjust for the changed page indices
-   added test function testPageAllPublishers
-   added test function testPagePublishersDetail
-   added test function testPageSearchScopePublishers

*test\BaseWithSomeBooks\metadata.db*

-   added 5 publishers spread across all 14 books, replacing the original publisher Feedbooks

Files added:

*publisher.php*

											
										
										
											2013-11-22 23:08:09 +02:00
+								        $this->entryArray = Publisher::getAllPublishers();
 								        $this->idPage = Publisher::ALL_PUBLISHERS_ID;
 								    }
 								}
 								class PagePublisherDetail extends Page
 								{
 								    public function InitializeContent ()
 								    {
 								        $publisher = Publisher::getPublisherById ($this->idGet);
 								        $this->title = $publisher->name;
 								        list ($this->entryArray, $this->totalNumber) = Book::getBooksByPublisher ($this->idGet, $this->n);
 								        $this->idPage = $publisher->getEntryId ();
 								    }
 								}
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								class PageAllTags extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								    {
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        $this->title = localize("tags.title");
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        $this->entryArray = Tag::getAllTags();
 								        $this->idPage = Tag::ALL_TAGS_ID;
 								    }
 								}
-												Merged Language Feature.

											
										
										
											2013-05-21 20:49:21 +03:00
+								class PageAllLanguages extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Merged Language Feature.

											
										
										
											2013-05-21 20:49:21 +03:00
+								    {
 								        $this->title = localize("languages.title");
 								        $this->entryArray = Language::getAllLanguages();
 								        $this->idPage = Language::ALL_LANGUAGES_ID;
 								    }
 								}
-												Add Custom columns through config. Only tested in HTML catalog for now

re #32

											
										
										
											2013-01-19 08:08:47 +02:00
+								class PageCustomDetail extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add Custom columns through config. Only tested in HTML catalog for now

re #32

											
										
										
											2013-01-19 08:08:47 +02:00
+								    {
 								        $customId = getURLParam ("custom", NULL);
 								        $custom = CustomColumn::getCustomById ($customId, $this->idGet);
 								        $this->idPage = $custom->getEntryId ();
 								        $this->title = $custom->name;
 								        list ($this->entryArray, $this->totalNumber) = Book::getBooksByCustom ($customId, $this->idGet, $this->n);
 								    }
 								}
 								class PageAllCustoms extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add Custom columns through config. Only tested in HTML catalog for now

re #32

											
										
										
											2013-01-19 08:08:47 +02:00
+								    {
 								        $customId = getURLParam ("custom", NULL);
 								        $this->title = CustomColumn::getAllTitle ($customId);
 								        $this->entryArray = CustomColumn::getAllCustoms($customId);
 								        $this->idPage = CustomColumn::getAllCustomsId ($customId);
 								    }
 								}
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								class PageTagDetail extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								    {
 								        $tag = Tag::getTagById ($this->idGet);
 								        $this->idPage = $tag->getEntryId ();
 								        $this->title = $tag->name;
-												Continue the refactoring

											
										
										
											2012-09-20 22:15:03 +03:00
+								        list ($this->entryArray, $this->totalNumber) = Book::getBooksByTag ($this->idGet, $this->n);
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								    }
 								}
-												Merged Language Feature.

											
										
										
											2013-05-21 20:49:21 +03:00
+								class PageLanguageDetail extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Merged Language Feature.

											
										
										
											2013-05-21 20:49:21 +03:00
+								    {
 								        $language = Language::getLanguageById ($this->idGet);
 								        $this->idPage = $language->getEntryId ();
-												Fix a PHP warning. re #66

											
										
										
											2013-05-22 19:31:44 +03:00
+								        $this->title = $language->lang_code;
-												Merged Language Feature.

											
										
										
											2013-05-21 20:49:21 +03:00
+								        list ($this->entryArray, $this->totalNumber) = Book::getBooksByLanguage ($this->idGet, $this->n);
 								    }
 								}
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								class PageAllSeries extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    {
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        $this->title = localize("series.title");
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								        $this->entryArray = Serie::getAllSeries();
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        $this->idPage = Serie::ALL_SERIES_ID;
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    }
 								}
 								class PageSerieDetail extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    {
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        $serie = Serie::getSerieById ($this->idGet);
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        $this->title = $serie->name;
-												Continue the refactoring

											
										
										
											2012-09-20 22:15:03 +03:00
+								        list ($this->entryArray, $this->totalNumber) = Book::getBooksBySeries ($this->idGet, $this->n);
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        $this->idPage = $serie->getEntryId ();
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    }
 								}
-												raw sketch of ratings category

											
										
										
											2014-02-27 01:33:40 +02:00
+								class PageAllRating extends Page
 								{
 								    public function InitializeContent ()
 								    {
-												adding ratings category to possible ignores and merge lang update (nl)
had to change rating.title to ratings.title due to $keyPlural in base.php#L997

											
										
										
											2014-03-05 12:15:20 +02:00
+								        $this->title = localize("ratings.title");
-												raw sketch of ratings category

											
										
										
											2014-02-27 01:33:40 +02:00
+								        $this->entryArray = Rating::getAllRatings();
 								        $this->idPage = Rating::ALL_RATING_ID;
 								    }
 								}
 								class PageRatingDetail extends Page
 								{
 								    public function InitializeContent ()
 								    {
 								        $rating = Rating::getRatingById ($this->idGet);
 								        $this->idPage = $rating->getEntryId ();
-												ratings detail title

											
										
										
											2014-02-28 12:10:04 +02:00
+								        $this->title =str_format (localize ("ratingword", $rating->name/2), $rating->name/2);
-												raw sketch of ratings category

											
										
										
											2014-02-27 01:33:40 +02:00
+								        list ($this->entryArray, $this->totalNumber) = Book::getBooksByRating ($this->idGet, $this->n);
 								    }
 								}
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								class PageAllBooks extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    {
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        $this->title = localize ("allbooks.title");
-												Added support for optional flat-list display of "All Books"

Files modified:

config_default.php

base.php

changed class PageAllBooks to test for configuration option "cops_titles_split_first_letter".
Used getCurrentOption to prepare for making Split Letter options configurable in web GUI

book.php

added SQL_BOOKS_ALL query to have a flat-list datasource not grouped by first letter.
added const SQL_BOOKS_ALL to class Book
added public static function "getBooks", called from Base::PageAllBooks to retrieve the flat-list

											
										
										
											2013-11-08 18:53:11 +02:00
+								        if (getCurrentOption ("titles_split_first_letter") == 1) {
 								            $this->entryArray = Book::getAllBooks();
 								        }
 								        else {
 								            list ($this->entryArray, $this->totalNumber) = Book::getBooks ($this->n);
 								        }
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        $this->idPage = Book::ALL_BOOKS_ID;
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    }
 								}
 								class PageAllBooksLetter extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    {
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								        list ($this->entryArray, $this->totalNumber) = Book::getBooksByStartingLetter ($this->idGet, $this->n);
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        $this->idPage = Book::getEntryIdByLetter ($this->idGet);
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Fix some title again :(

											
										
										
											2013-01-05 19:19:56 +02:00
+								        $count = $this->totalNumber;
 								        if ($count == -1)
 								            $count = count ($this->entryArray);
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Fix some title again :(

											
										
										
											2013-01-05 19:19:56 +02:00
+								        $this->title = str_format (localize ("splitByLetter.letter"), str_format (localize ("bookword", $count), $count), $this->idGet);
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    }
 								}
 								class PageRecentBooks extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    {
-												Add localization support (borrowed from Calibre2OPDS)

											
										
										
											2012-05-29 21:10:41 +03:00
+								        $this->title = localize ("recent.title");
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								        $this->entryArray = Book::getAllRecentBooks ();
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								        $this->idPage = Book::ALL_RECENT_BOOKS_ID;
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    }
 								}
 								class PageQueryResult extends Page
 								{
-												Change the search to look into tags and series (in addition to book title and author).

re #34, #47, #78

											
										
										
											2013-09-27 18:13:31 +03:00
+								    const SCOPE_TAG = "tag";
-												raw sketch of ratings category

											
										
										
											2014-02-27 01:33:40 +02:00
+								    const SCOPE_RATING = "rating";
-												Change the search to look into tags and series (in addition to book title and author).

re #34, #47, #78

											
										
										
											2013-09-27 18:13:31 +03:00
+								    const SCOPE_SERIES = "series";
 								    const SCOPE_AUTHOR = "author";
 								    const SCOPE_BOOK = "book";
-												**2012-11-22**

**Added global support for publishers**

Files modified:

*base.php*

-   changed class Entry,

	-   adding a constant ```cops:publishers``` to the icon array for the feed.

-   changed class Page

	-   added branches to the page selector switch

-   changed Page->public function InitializeContent

	-   added call to pull publisher count from database

-   changed class PageAllBooks

	-   changed it so ```getCurrentOption``` is actually used...

-   added page descendant class ```PageAllPublishers```

	-   handles pulling the publishers category from database

-   added page descendant class ```PagePublisherDetail```

	-   handles pulling the books per publisher data from database

-   changed class PageQueryResult

	-   added constant and switches for publisher search scope

-   abstract class Base

	-   added constants for the publisher pages

*book.php*

-   added require statement for publisher.php
-   added ```SQL_BOOKS_BY_PUBLISHER``` query to retrieve books by publisher.

-   changed class Book

	-   added query constant
	-   added publisher item
	-   added test in case no known publisher
	-   added publishername and url array elements for the JSON output
	-   added public function ```getPublisher```
	-   added public static function ```getBooksByPublisher``` to fire the query

-   changed function getJson

	-   added publisher category to search
	-   added publishername (single) and publishertitle(plural) localization entries to i18n translation array

*index.php*

-   added require statement for publisher.php

*lang/Localization_en.json

-   added new localization entries for publisher labels (see below)
```
"publisher.alphabetical.many":"Alphabetical index of the {0} publishers",
"publisher.alphabetical.none":"Alphabetical index of absolutely no publisher",
"publisher.alphabetical.one":"Alphabetical index of the single publisher",
"publisher.name":"Publisher",
"publisher.title":"Publishers",
"publisherword.many":"{0} publishers",
"publisherword.none":"No publisher",
"publisherword.one":"1 publisher",

"search.result.publisher":"Search result for *{0}* in publishers",
```

*templates\bookdetail.html*

-   added publisher label and item to bookdetail popup

*test\bookTest.php*

-   added indices and names of publishers added to testdatabase as comment
-   added test function ```testGetBooksByPublisher```
-   changed test function testGetBookById to add assertion for publisher name
-   changed test function testTypeaheadSearch to add search on partial publisher name.

*test\pageTest.php*

-   changed test function testPageIndex to insert publisher category and adjust page indices
-   changed test function testPageIndexWithCustomColum to adjust for the changed page indices
-   added test function testPageAllPublishers
-   added test function testPagePublishersDetail
-   added test function testPageSearchScopePublishers

*test\BaseWithSomeBooks\metadata.db*

-   added 5 publishers spread across all 14 books, replacing the original publisher Feedbooks

Files added:

*publisher.php*

											
										
										
											2013-11-22 23:08:09 +02:00
+								    const SCOPE_PUBLISHER = "publisher";
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Integrate a little better the typeahead search in the normal search page. Heavily based on At-Libitum work. re #34

											
										
										
											2013-12-22 19:40:03 +02:00
+								    private function useTypeahead () {
 								        return !is_null (getURLParam ("search"));
 								    }
-												Try to simplify a little the search.

											
										
										
											2014-01-02 13:23:04 +02:00
+								    private function searchByScope ($scope, $limit = FALSE) {
 								        $n = $this->n;
 								        $numberPerPage = NULL;
-												Allow normalized search (without diacritics) it should also fix the case problem with non latin languages (cyrillic).

The last part is not tested.

disclaimer : Slow !

re #49, #48

											
										
										
											2014-05-03 18:57:06 +03:00
+								        $queryNormedAndUp = $this->query;
 								        if (useNormAndUp ()) {
 								            $queryNormedAndUp = normAndUp ($this->query);
 								        }
-												Try to simplify a little the search.

											
										
										
											2014-01-02 13:23:04 +02:00
+								        if ($limit) {
 								            $n = 1;
 								            $numberPerPage = 5;
 								        }
 								        switch ($scope) {
 								            case self::SCOPE_BOOK :
-												Allow normalized search (without diacritics) it should also fix the case problem with non latin languages (cyrillic).

The last part is not tested.

disclaimer : Slow !

re #49, #48

											
										
										
											2014-05-03 18:57:06 +03:00
+								                $array = Book::getBooksByStartingLetter ('%' . $queryNormedAndUp, $n, NULL, $numberPerPage);
-												Try to simplify a little the search.

											
										
										
											2014-01-02 13:23:04 +02:00
+								                break;
 								            case self::SCOPE_AUTHOR :
-												Allow normalized search (without diacritics) it should also fix the case problem with non latin languages (cyrillic).

The last part is not tested.

disclaimer : Slow !

re #49, #48

											
										
										
											2014-05-03 18:57:06 +03:00
+								                $array = Author::getAuthorsForSearch ('%' . $queryNormedAndUp);
-												Try to simplify a little the search.

											
										
										
											2014-01-02 13:23:04 +02:00
+								                break;
 								            case self::SCOPE_SERIES :
-												Allow normalized search (without diacritics) it should also fix the case problem with non latin languages (cyrillic).

The last part is not tested.

disclaimer : Slow !

re #49, #48

											
										
										
											2014-05-03 18:57:06 +03:00
+								                $array = Serie::getAllSeriesByQuery ($queryNormedAndUp);
-												Try to simplify a little the search.

											
										
										
											2014-01-02 13:23:04 +02:00
+								                break;
 								            case self::SCOPE_TAG :
-												Allow normalized search (without diacritics) it should also fix the case problem with non latin languages (cyrillic).

The last part is not tested.

disclaimer : Slow !

re #49, #48

											
										
										
											2014-05-03 18:57:06 +03:00
+								                $array = Tag::getAllTagsByQuery ($queryNormedAndUp, $n, NULL, $numberPerPage);
-												Try to simplify a little the search.

											
										
										
											2014-01-02 13:23:04 +02:00
+								                break;
 								            case self::SCOPE_PUBLISHER :
-												Allow normalized search (without diacritics) it should also fix the case problem with non latin languages (cyrillic).

The last part is not tested.

disclaimer : Slow !

re #49, #48

											
										
										
											2014-05-03 18:57:06 +03:00
+								                $array = Publisher::getAllPublishersByQuery ($queryNormedAndUp);
-												Try to simplify a little the search.

											
										
										
											2014-01-02 13:23:04 +02:00
+								                break;
 								            default:
 								                $array = Book::getBooksByQuery (
-												Allow normalized search (without diacritics) it should also fix the case problem with non latin languages (cyrillic).

The last part is not tested.

disclaimer : Slow !

re #49, #48

											
										
										
											2014-05-03 18:57:06 +03:00
+								                    array ("all" => "%" . $queryNormedAndUp . "%"), $n);
-												Try to simplify a little the search.

											
										
										
											2014-01-02 13:23:04 +02:00
+								        }
 								        return $array;
 								    }
-												Integrate a little better the typeahead search in the normal search page. Heavily based on At-Libitum work. re #34

											
										
										
											2013-12-22 19:40:03 +02:00
+								    public function doSearchByCategory () {
 								        $database = GetUrlParam (DB);
 								        $out = array ();
 								        $pagequery = Base::PAGE_OPENSEARCH_QUERY;
 								        $dbArray = array ("");
 								        $d = $database;
 								        $query = $this->query;
 								        // Special case when no databases were chosen, we search on all databases
 								        if (Base::noDatabaseSelected ()) {
 								            $dbArray = Base::getDbNameList ();
 								            $d = 0;
 								        }
 								        foreach ($dbArray as $key) {
 								            if (Base::noDatabaseSelected ()) {
 								                array_push ($this->entryArray, new Entry ($key, DB . ":query:{$d}",
 								                                        " ", "text",
 								                                        array ( new LinkNavigation ("?" . DB . "={$d}")), "tt-header"));
 								                Base::getDb ($d);
 								            }
 								            foreach (array (PageQueryResult::SCOPE_BOOK,
 								                            PageQueryResult::SCOPE_AUTHOR,
 								                            PageQueryResult::SCOPE_SERIES,
 								                            PageQueryResult::SCOPE_TAG,
 								                            PageQueryResult::SCOPE_PUBLISHER) as $key) {
 								                if (in_array($key, getCurrentOption ('ignored_categories'))) {
 								                    continue;
 								                }
-												Try to simplify a little the search.

											
										
										
											2014-01-02 13:23:04 +02:00
+								                $array = $this->searchByScope ($key, TRUE);
-												Integrate a little better the typeahead search in the normal search page. Heavily based on At-Libitum work. re #34

											
										
										
											2013-12-22 19:40:03 +02:00
 								                $i = 0;
 								                if (count ($array) == 2 && is_array ($array [0])) {
 								                    $total = $array [1];
 								                    $array = $array [0];
 								                } else {
 								                    $total = count($array);
 								                }
 								                if ($total > 0) {
 								                    // Comment to help the perl i18n script
 								                    // str_format (localize("bookword", count($array))
 								                    // str_format (localize("authorword", count($array))
 								                    // str_format (localize("seriesword", count($array))
 								                    // str_format (localize("tagword", count($array))
 								                    // str_format (localize("publisherword", count($array))
 								                    array_push ($this->entryArray, new Entry (str_format (localize ("search.result.{$key}"), $this->query), DB . ":query:{$d}:{$key}",
 								                                        str_format (localize("{$key}word", $total), $total), "text",
 								                                        array ( new LinkNavigation ("?page={$pagequery}&query={$query}&db={$d}&scope={$key}")),
 								                                        Base::noDatabaseSelected () ? "" : "tt-header"));
 								                }
 								                if (!Base::noDatabaseSelected () && $this->useTypeahead ()) {
 								                    foreach ($array as $entry) {
 								                        array_push ($this->entryArray, $entry);
 								                        $i++;
 								                        if ($i > 4) { break; };
 								                    }
 								                }
 								            }
 								            $d++;
 								            if (Base::noDatabaseSelected ()) {
 								                Base::clearDb ();
 								            }
 								        }
 								        return $out;
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    {
-												Change the search to look into tags and series (in addition to book title and author).

re #34, #47, #78

											
										
										
											2013-09-27 18:13:31 +03:00
+								        $scope = getURLParam ("scope");
-												Simplify a little the code to get the title of the search page. re #127

											
										
										
											2013-12-14 11:44:48 +02:00
+								        if (empty ($scope)) {
 								            $this->title = str_format (localize ("search.result"), $this->query);
 								        } else {
 								            // Comment to help the perl i18n script
 								            // str_format (localize ("search.result.author"), $this->query)
 								            // str_format (localize ("search.result.tag"), $this->query)
 								            // str_format (localize ("search.result.series"), $this->query)
 								            // str_format (localize ("search.result.book"), $this->query)
 								            // str_format (localize ("search.result.publisher"), $this->query)
 								            $this->title = str_format (localize ("search.result.{$scope}"), $this->query);
-												The search page title is now more precise in case a scope is provided. re #34

											
										
										
											2013-10-06 19:08:26 +03:00
+								        }
-												Change the search to look into tags and series (in addition to book title and author).

re #34, #47, #78

											
										
										
											2013-09-27 18:13:31 +03:00
+								        $crit = "%" . $this->query . "%";
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Fix search when no database is selected. re #40

											
										
										
											2013-04-29 17:46:52 +03:00
+								        // Special case when we are doing a search and no database is selected
-												Integrate a little better the typeahead search in the normal search page. Heavily based on At-Libitum work. re #34

											
										
										
											2013-12-22 19:40:03 +02:00
+								        if (Base::noDatabaseSelected () && !$this->useTypeahead ()) {
-												Fix search when no database is selected. re #40

											
										
										
											2013-04-29 17:46:52 +03:00
+								            $i = 0;
-												Factorize a little more the DB handling. re #127

											
										
										
											2013-12-14 19:25:32 +02:00
+								            foreach (Base::getDbNameList () as $key) {
-												Fix search when no database is selected. re #40

											
										
										
											2013-04-29 17:46:52 +03:00
+								                Base::clearDb ();
-												Add a new config item to ignore a category in search. Simplify the queries. re #123

											
										
										
											2013-12-08 22:01:17 +02:00
+								                list ($array, $totalNumber) = Book::getBooksByQuery (array ("all" => $crit), 1, $i, 1);
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								                array_push ($this->entryArray, new Entry ($key, DB . ":query:{$i}",
-												Forgot a bit of the last commit. re #124

											
										
										
											2013-12-07 22:29:37 +02:00
+								                                        str_format (localize ("bookword", $totalNumber), $totalNumber), "text",
-												Fix search when no database is selected. re #40

											
										
										
											2013-04-29 17:46:52 +03:00
+								                                        array ( new LinkNavigation ("?" . DB . "={$i}&page=9&query=" . $this->query))));
 								                $i++;
 								            }
 								            return;
 								        }
-												Add the search by category with the standard search. Again inspired by At-Libitum. re #34

											
										
										
											2013-12-23 09:58:56 +02:00
+								        if (empty ($scope)) {
-												Integrate a little better the typeahead search in the normal search page. Heavily based on At-Libitum work. re #34

											
										
										
											2013-12-22 19:40:03 +02:00
+								            $this->doSearchByCategory ();
 								            return;
 								        }
-												Try to simplify a little the search.

											
										
										
											2014-01-02 13:23:04 +02:00
 								        $array = $this->searchByScope ($scope);
 								        if (count ($array) == 2 && is_array ($array [0])) {
 								            list ($this->entryArray, $this->totalNumber) = $array;
 								        } else {
 								            $this->entryArray = $array;
-												Enhance the search to have a different output depending on the current page. re #34

											
										
										
											2013-03-08 10:40:25 +02:00
+								        }
-												Add v0.0.2

											
										
										
											2012-05-28 08:05:05 +03:00
+								    }
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								}
-												Add a config item to avoid using Fancyapps.
For now the about box still use Fancyapps.

Reported by mcister and Northguy

											
										
										
											2012-12-10 07:06:45 +02:00
+								class PageBookDetail extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Add a config item to avoid using Fancyapps.
For now the about box still use Fancyapps.

Reported by mcister and Northguy

											
										
										
											2012-12-10 07:06:45 +02:00
+								    {
-												Bookdetail is handled with ajax. Template is not complete though. re #73

Fixes some small bugs with the other template.

											
										
										
											2013-06-15 17:09:37 +03:00
+								        $this->book = Book::getBookById ($this->idGet);
 								        $this->title = $this->book->title;
-												Add a config item to avoid using Fancyapps.
For now the about box still use Fancyapps.

Reported by mcister and Northguy

											
										
										
											2012-12-10 07:06:45 +02:00
+								    }
 								}
-												Get rid of fancybox completely if not enabled. fixes #50

About.xml is still utf8 but looses it's BOM

											
										
										
											2013-04-21 16:00:21 +03:00
+								class PageAbout extends Page
 								{
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Get rid of fancybox completely if not enabled. fixes #50

About.xml is still utf8 but looses it's BOM

											
										
										
											2013-04-21 16:00:21 +03:00
+								    {
-												Fix some strings. re #37

											
										
										
											2013-04-21 16:47:32 +03:00
+								        $this->title = localize ("about.title");
-												Get rid of fancybox completely if not enabled. fixes #50

About.xml is still utf8 but looses it's BOM

											
										
										
											2013-04-21 16:00:21 +03:00
+								    }
 								}
-												Move customize inside the current template. re #73

											
										
										
											2013-06-27 09:27:29 +03:00
+								class PageCustomize extends Page
 								{
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
+								    private function isChecked ($key, $testedValue = 1) {
-												little code refactoring. re #34

											
										
										
											2013-12-19 09:38:26 +02:00
+								        $value = getCurrentOption ($key);
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
+								        if (is_array ($value)) {
-												little code refactoring. re #34

											
										
										
											2013-12-19 09:38:26 +02:00
+								            if (in_array ($testedValue, $value)) {
 								                return "checked='checked'";
 								            }
 								        } else {
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
+								            if ($value == $testedValue) {
-												little code refactoring. re #34

											
										
										
											2013-12-19 09:38:26 +02:00
+								                return "checked='checked'";
 								            }
 								        }
 								        return "";
 								    }
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
+								    private function isSelected ($key, $value) {
 								        if (getCurrentOption ($key) == $value) {
 								            return "selected='selected'";
 								        }
 								        return "";
 								    }
 								    private function getStyleList () {
 								        $result = array ();
-												Move all default styles in the templates directory. re #79

--HG--
rename : styles/FontAwesome.otf => templates/default/styles/FontAwesome.otf
rename : styles/font-awesome.css => templates/default/styles/font-awesome.css
rename : styles/fontawesome-webfont.eot => templates/default/styles/fontawesome-webfont.eot
rename : styles/fontawesome-webfont.svg => templates/default/styles/fontawesome-webfont.svg
rename : styles/fontawesome-webfont.ttf => templates/default/styles/fontawesome-webfont.ttf
rename : styles/fontawesome-webfont.woff => templates/default/styles/fontawesome-webfont.woff
rename : styles/style-base.css => templates/default/styles/style-base.css
rename : styles/style-default.css => templates/default/styles/style-default.css
rename : styles/style-eink.css => templates/default/styles/style-eink.css
rename : styles/style-iphone.css => templates/default/styles/style-iphone.css

											
										
										
											2014-02-16 17:55:38 +02:00
+								        foreach (glob ("templates/" . getCurrentTemplate () . "/styles/style-*.css") as $filename) {
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
+								            if (preg_match ('/styles\/style-(.*?)\.css/', $filename, $m)) {
 								                array_push ($result, $m [1]);
 								            }
 								        }
 								        return $result;
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    public function InitializeContent ()
-												Move customize inside the current template. re #73

											
										
										
											2013-06-27 09:27:29 +03:00
+								    {
 								        $this->title = localize ("customize.title");
 								        $this->entryArray = array ();
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
-												The ignored categories is now in the customize UI page. re #34

It's far from complete but it works. I'll have to check the strings consistancy.

											
										
										
											2013-12-17 23:45:51 +02:00
+								        $ignoredBaseArray = array (PageQueryResult::SCOPE_AUTHOR,
 								                                   PageQueryResult::SCOPE_TAG,
 								                                   PageQueryResult::SCOPE_SERIES,
 								                                   PageQueryResult::SCOPE_PUBLISHER,
-												adding ratings category to possible ignores and merge lang update (nl)
had to change rating.title to ratings.title due to $keyPlural in base.php#L997

											
										
										
											2014-03-05 12:15:20 +02:00
+								                                   PageQueryResult::SCOPE_RATING,
-												The ignored categories is now in the customize UI page. re #34

It's far from complete but it works. I'll have to check the strings consistancy.

											
										
										
											2013-12-17 23:45:51 +02:00
+								                                   "language");
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Move customize inside the current template. re #73

											
										
										
											2013-06-27 09:27:29 +03:00
+								        $content = "";
 								        if (!preg_match("/(Kobo|Kindle\/3.0|EBRD1101)/", $_SERVER['HTTP_USER_AGENT'])) {
 								            $content .= '<select id="style" onchange="updateCookie (this);">';
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
+								            foreach ($this-> getStyleList () as $filename) {
 								                $content .= "<option value='{$filename}' " . $this->isSelected ("style", $filename) . ">{$filename}</option>";
-												Move customize inside the current template. re #73

											
										
										
											2013-06-27 09:27:29 +03:00
+								            }
 								            $content .= '</select>';
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
+								        } else {
 								            foreach ($this-> getStyleList () as $filename) {
 								                $content .= "<input type='radio' onchange='updateCookieFromCheckbox (this);' id='style-{$filename}' name='style' value='{$filename}' " . $this->isChecked ("style", $filename) . " /><label for='style-{$filename}'> {$filename} </label>";
 								            }
-												Move customize inside the current template. re #73

											
										
										
											2013-06-27 09:27:29 +03:00
+								        }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								        array_push ($this->entryArray, new Entry (localize ("customize.style"), "",
 								                                        $content, "text",
-												Move customize inside the current template. re #73

											
										
										
											2013-06-27 09:27:29 +03:00
+								                                        array ()));
-												Handle better when server side rendering is enabled. re #82

											
										
										
											2013-09-05 09:41:40 +03:00
+								        if (!useServerSideRendering ()) {
-												little code refactoring. re #34

											
										
										
											2013-12-19 09:38:26 +02:00
+								            $content = '<input type="checkbox" onchange="updateCookieFromCheckbox (this);" id="use_fancyapps" ' . $this->isChecked ("use_fancyapps") . ' />';
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								            array_push ($this->entryArray, new Entry (localize ("customize.fancybox"), "",
 								                                            $content, "text",
-												Handle better when server side rendering is enabled. re #82

											
										
										
											2013-09-05 09:41:40 +03:00
+								                                            array ()));
 								        }
-												Move customize inside the current template. re #73

											
										
										
											2013-06-27 09:27:29 +03:00
+								        $content = '<input type="number" onchange="updateCookie (this);" id="max_item_per_page" value="' . getCurrentOption ("max_item_per_page") . '" min="-1" max="1200" pattern="^[-+]?[0-9]+$" />';
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								        array_push ($this->entryArray, new Entry (localize ("customize.paging"), "",
 								                                        $content, "text",
-												Move customize inside the current template. re #73

											
										
										
											2013-06-27 09:27:29 +03:00
+								                                        array ()));
-												Handle many email recipient. fix #53

											
										
										
											2013-07-24 21:49:24 +03:00
+								        $content = '<input type="text" onchange="updateCookie (this);" id="email" value="' . getCurrentOption ("email") . '" />';
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								        array_push ($this->entryArray, new Entry (localize ("customize.email"), "",
 								                                        $content, "text",
-												Add the email in the customize page. re #53

											
										
										
											2013-07-04 00:40:08 +03:00
+								                                        array ()));
-												little code refactoring. re #34

											
										
										
											2013-12-19 09:38:26 +02:00
+								        $content = '<input type="checkbox" onchange="updateCookieFromCheckbox (this);" id="html_tag_filter" ' . $this->isChecked ("html_tag_filter") . ' />';
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								        array_push ($this->entryArray, new Entry (localize ("customize.filter"), "",
 								                                        $content, "text",
-												Add a way to enable tag filter directly in the customize page. re #46

											
										
										
											2013-07-13 09:29:17 +03:00
+								                                        array ()));
-												The ignored categories is now in the customize UI page. re #34

It's far from complete but it works. I'll have to check the strings consistancy.

											
										
										
											2013-12-17 23:45:51 +02:00
+								        $content = "";
 								        foreach ($ignoredBaseArray as $key) {
 								            $keyPlural = preg_replace ('/(ss)$/', 's', $key . "s");
-												little code refactoring. re #34

											
										
										
											2013-12-19 09:38:26 +02:00
+								            $content .=  '<input type="checkbox" name="ignored_categories[]" onchange="updateCookieFromCheckboxGroup (this);" id="ignored_categories_' . $key . '" ' . $this->isChecked ("ignored_categories", $key) . ' > ' . localize ("{$keyPlural}.title") . '</input> ';
-												The ignored categories is now in the customize UI page. re #34

It's far from complete but it works. I'll have to check the strings consistancy.

											
										
										
											2013-12-17 23:45:51 +02:00
+								        }
 								        array_push ($this->entryArray, new Entry (localize ("customize.ignored"), "",
 								                                        $content, "text",
 								                                        array ()));
-												Move customize inside the current template. re #73

											
										
										
											2013-06-27 09:27:29 +03:00
+								    }
 								}
-												Get rid of fancybox completely if not enabled. fixes #50

About.xml is still utf8 but looses it's BOM

											
										
										
											2013-04-21 16:00:21 +03:00
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								abstract class Base
 								{
 								    const PAGE_INDEX = "index";
 								    const PAGE_ALL_AUTHORS = "1";
 								    const PAGE_AUTHORS_FIRST_LETTER = "2";
 								    const PAGE_AUTHOR_DETAIL = "3";
 								    const PAGE_ALL_BOOKS = "4";
 								    const PAGE_ALL_BOOKS_LETTER = "5";
 								    const PAGE_ALL_SERIES = "6";
 								    const PAGE_SERIE_DETAIL = "7";
 								    const PAGE_OPENSEARCH = "8";
 								    const PAGE_OPENSEARCH_QUERY = "9";
 								    const PAGE_ALL_RECENT_BOOKS = "10";
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
+								    const PAGE_ALL_TAGS = "11";
 								    const PAGE_TAG_DETAIL = "12";
-												Add a config item to avoid using Fancyapps.
For now the about box still use Fancyapps.

Reported by mcister and Northguy

											
										
										
											2012-12-10 07:06:45 +02:00
+								    const PAGE_BOOK_DETAIL = "13";
-												Add Custom columns through config. Only tested in HTML catalog for now

re #32

											
										
										
											2013-01-19 08:08:47 +02:00
+								    const PAGE_ALL_CUSTOMS = "14";
 								    const PAGE_CUSTOM_DETAIL = "15";
-												Get rid of fancybox completely if not enabled. fixes #50

About.xml is still utf8 but looses it's BOM

											
										
										
											2013-04-21 16:00:21 +03:00
+								    const PAGE_ABOUT = "16";
-												Merged Language Feature.

											
										
										
											2013-05-21 20:49:21 +03:00
+								    const PAGE_ALL_LANGUAGES = "17";
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
+								    const PAGE_LANGUAGE_DETAIL = "18";
 								    const PAGE_CUSTOMIZE = "19";
-												**2012-11-22**

**Added global support for publishers**

Files modified:

*base.php*

-   changed class Entry,

	-   adding a constant ```cops:publishers``` to the icon array for the feed.

-   changed class Page

	-   added branches to the page selector switch

-   changed Page->public function InitializeContent

	-   added call to pull publisher count from database

-   changed class PageAllBooks

	-   changed it so ```getCurrentOption``` is actually used...

-   added page descendant class ```PageAllPublishers```

	-   handles pulling the publishers category from database

-   added page descendant class ```PagePublisherDetail```

	-   handles pulling the books per publisher data from database

-   changed class PageQueryResult

	-   added constant and switches for publisher search scope

-   abstract class Base

	-   added constants for the publisher pages

*book.php*

-   added require statement for publisher.php
-   added ```SQL_BOOKS_BY_PUBLISHER``` query to retrieve books by publisher.

-   changed class Book

	-   added query constant
	-   added publisher item
	-   added test in case no known publisher
	-   added publishername and url array elements for the JSON output
	-   added public function ```getPublisher```
	-   added public static function ```getBooksByPublisher``` to fire the query

-   changed function getJson

	-   added publisher category to search
	-   added publishername (single) and publishertitle(plural) localization entries to i18n translation array

*index.php*

-   added require statement for publisher.php

*lang/Localization_en.json

-   added new localization entries for publisher labels (see below)
```
"publisher.alphabetical.many":"Alphabetical index of the {0} publishers",
"publisher.alphabetical.none":"Alphabetical index of absolutely no publisher",
"publisher.alphabetical.one":"Alphabetical index of the single publisher",
"publisher.name":"Publisher",
"publisher.title":"Publishers",
"publisherword.many":"{0} publishers",
"publisherword.none":"No publisher",
"publisherword.one":"1 publisher",

"search.result.publisher":"Search result for *{0}* in publishers",
```

*templates\bookdetail.html*

-   added publisher label and item to bookdetail popup

*test\bookTest.php*

-   added indices and names of publishers added to testdatabase as comment
-   added test function ```testGetBooksByPublisher```
-   changed test function testGetBookById to add assertion for publisher name
-   changed test function testTypeaheadSearch to add search on partial publisher name.

*test\pageTest.php*

-   changed test function testPageIndex to insert publisher category and adjust page indices
-   changed test function testPageIndexWithCustomColum to adjust for the changed page indices
-   added test function testPageAllPublishers
-   added test function testPagePublishersDetail
-   added test function testPageSearchScopePublishers

*test\BaseWithSomeBooks\metadata.db*

-   added 5 publishers spread across all 14 books, replacing the original publisher Feedbooks

Files added:

*publisher.php*

											
										
										
											2013-11-22 23:08:09 +02:00
+								    const PAGE_ALL_PUBLISHERS = "20";
 								    const PAGE_PUBLISHER_DETAIL = "21";
-												raw sketch of ratings category

											
										
										
											2014-02-27 01:33:40 +02:00
+								    const PAGE_ALL_RATINGS = "22";
 								    const PAGE_RATING_DETAIL = "23";
-												Add v0.0.4

											
										
										
											2012-05-28 08:07:49 +03:00
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    const COMPATIBILITY_XML_ALDIKO = "aldiko";
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								    private static $db = NULL;
-												Remove trailing spaces

											
										
										
											2013-12-05 11:52:51 +02:00
-												Add a way to specify the number of item per page. re #34

											
										
										
											2013-11-22 15:36:39 +02:00
+								    public static function isMultipleDatabaseEnabled () {
 								        global $config;
 								        return is_array ($config['calibre_directory']);
 								    }
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
-												Simplify a little getLink

											
										
										
											2014-03-10 22:14:54 +02:00
+								    public static function useAbsolutePath () {
 								        global $config;
 								        $path = self::getDbDirectory();
-												Fix warning

											
										
										
											2014-03-10 22:41:35 +02:00
+								        return preg_match ('/^\//', $path) || // Linux /
 								               preg_match ('/^\w\:/', $path); // Windows X:
-												Simplify a little getLink

											
										
										
											2014-03-10 22:14:54 +02:00
+								    }
-												Refactor the detection of the case when no database has been selected. re #127

											
										
										
											2013-12-14 12:30:42 +02:00
+								    public static function noDatabaseSelected () {
 								        return self::isMultipleDatabaseEnabled () && is_null (GetUrlParam (DB));
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								    public static function getDbList () {
 								        global $config;
-												Try to use the method created ... re #127

											
										
										
											2013-12-14 11:32:28 +02:00
+								        if (self::isMultipleDatabaseEnabled ()) {
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								            return $config['calibre_directory'];
 								        } else {
 								            return array ("" => $config['calibre_directory']);
 								        }
 								    }
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
-												Factorize a little more the DB handling. re #127

											
										
										
											2013-12-14 19:25:32 +02:00
+								    public static function getDbNameList () {
 								        global $config;
 								        if (self::isMultipleDatabaseEnabled ()) {
 								            return array_keys ($config['calibre_directory']);
 								        } else {
 								            return array ("");
 								        }
 								    }
-												Fix database title with multiple database. re #40

											
										
										
											2013-04-17 14:36:19 +03:00
 								    public static function getDbName ($database = NULL) {
 								        global $config;
-												Try to use the method created ... re #127

											
										
										
											2013-12-14 11:32:28 +02:00
+								        if (self::isMultipleDatabaseEnabled ()) {
-												Fix database title with multiple database. re #40

											
										
										
											2013-04-17 14:36:19 +03:00
+								            if (is_null ($database)) $database = GetUrlParam (DB, 0);
 								            $array = array_keys ($config['calibre_directory']);
 								            return  $array[$database];
 								        }
 								        return "";
 								    }
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								    public static function getDbDirectory ($database = NULL) {
-												Add a configuration check page (checkconfig.php)
If opening the database is impossible redirect to the configuration check.

fix #7

											
										
										
											2013-01-05 08:35:19 +02:00
+								        global $config;
-												Try to use the method created ... re #127

											
										
										
											2013-12-14 11:32:28 +02:00
+								        if (self::isMultipleDatabaseEnabled ()) {
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								            if (is_null ($database)) $database = GetUrlParam (DB, 0);
-												Refactor the use of Calibre path to prepare multi database. re #40

											
										
										
											2013-04-03 16:00:09 +03:00
+								            $array = array_values ($config['calibre_directory']);
 								            return  $array[$database];
 								        }
 								        return $config['calibre_directory'];
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								    public static function getDbFileName ($database = NULL) {
 								        return self::getDbDirectory ($database) .'metadata.db';
-												Add a configuration check page (checkconfig.php)
If opening the database is impossible redirect to the configuration check.

fix #7

											
										
										
											2013-01-05 08:35:19 +02:00
+								    }
-												Remove trailing spaces

											
										
										
											2013-12-05 11:52:51 +02:00
-												Fix the redirect in case the database is not found. I also handle better the case were no file are actually found. Thanks to At Libitum. fix #116

											
										
										
											2013-11-25 18:10:43 +02:00
+								    private static function error () {
-												Ensure the check can be tested. re #127

											
										
										
											2013-12-14 19:48:34 +02:00
+								        if (php_sapi_name() != "cli") {
 								            header("location: checkconfig.php?err=1");
 								        }
 								        throw new Exception('Database not found.');
-												Fix the redirect in case the database is not found. I also handle better the case were no file are actually found. Thanks to At Libitum. fix #116

											
										
										
											2013-11-25 18:10:43 +02:00
+								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Fix search when no database is selected. re #40

											
										
										
											2013-04-29 17:46:52 +03:00
+								    public static function getDb ($database = NULL) {
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								        if (is_null (self::$db)) {
 								            try {
-												Better test for missing metadata.db (also test if it's readable). re #116

											
										
										
											2013-11-25 22:16:34 +02:00
+								                if (is_readable (self::getDbFileName ($database))) {
-												Fix the redirect in case the database is not found. I also handle better the case were no file are actually found. Thanks to At Libitum. fix #116

											
										
										
											2013-11-25 18:10:43 +02:00
+								                    self::$db = new PDO('sqlite:'. self::getDbFileName ($database));
-												Allow normalized search (without diacritics) it should also fix the case problem with non latin languages (cyrillic).

The last part is not tested.

disclaimer : Slow !

re #49, #48

											
										
										
											2014-05-03 18:57:06 +03:00
+								                    if (useNormAndUp ()) {
 								                        self::$db->sqliteCreateFunction ('normAndUp', 'normAndUp', 1);
 								                    }
-												Fix the redirect in case the database is not found. I also handle better the case were no file are actually found. Thanks to At Libitum. fix #116

											
										
										
											2013-11-25 18:10:43 +02:00
+								                } else {
 								                    self::error ();
 								                }
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								            } catch (Exception $e) {
-												Fix the redirect in case the database is not found. I also handle better the case were no file are actually found. Thanks to At Libitum. fix #116

											
										
										
											2013-11-25 18:10:43 +02:00
+								                self::error ();
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								            }
 								        }
 								        return self::$db;
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								    }
-												Refactorize a little. re #127

											
										
										
											2013-12-20 16:16:57 +02:00
-												Factorize a little more the DB handling. re #127

											
										
										
											2013-12-14 19:25:32 +02:00
+								    public static function checkDatabaseAvailability () {
 								        if (self::noDatabaseSelected ()) {
 								            for ($i = 0; $i < count (self::getDbList ()); $i++) {
 								                self::getDb ($i);
 								                self::clearDb ();
 								            }
 								        } else {
 								            self::getDb ();
 								        }
-												Ensure the check can be tested. re #127

											
										
										
											2013-12-14 19:48:34 +02:00
+								        return true;
-												Factorize a little more the DB handling. re #127

											
										
										
											2013-12-14 19:25:32 +02:00
+								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Fix search when no database is selected. re #40

											
										
										
											2013-04-29 17:46:52 +03:00
+								    public static function clearDb () {
 								        self::$db = NULL;
 								    }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Centralize some of the database function (linked to the normalized search). re #48, #49

											
										
										
											2014-05-28 17:13:57 +03:00
+								    public static function executeQuerySingle ($query, $database = NULL) {
 								        return self::getDb ($database)->query($query)->fetchColumn();
 								    }
-												Centralize the getCount function.

											
										
										
											2014-05-30 07:47:38 +03:00
+								    public static function getCountGeneric($table, $id, $pageId, $numberOfString = NULL) {
 								        if (!$numberOfString) {
 								            $numberOfString = $table . ".alphabetical";
 								        }
 								        $count = self::executeQuerySingle ('select count(*) from ' . $table);
 								        if ($count == 0) return NULL;
 								        $entry = new Entry (localize($table . ".title"), $id,
 								            str_format (localize($numberOfString, $count), $count), "text",
-												Better bootstrap template with as little text as possible.

											
										
										
											2014-05-30 16:00:46 +03:00
+								            array ( new LinkNavigation ("?page=".$pageId)), "", $count);
-												Centralize the getCount function.

											
										
										
											2014-05-30 07:47:38 +03:00
+								        return $entry;
 								    }
-												Centralize a little the code
Should be easier to add the count of element. re #79

											
										
										
											2014-06-02 22:31:55 +03:00
+								    public static function getEntryArrayWithBookNumber ($query, $columns, $params, $category) {
 								        list (, $result) = self::executeQuery ($query, $columns, "", $params, -1);
 								        $entryArray = array();
 								        while ($post = $result->fetchObject ())
 								        {
 								            $instance = new $category ($post);
 								            array_push ($entryArray, new Entry ($post->sort, $instance->getEntryId (),
 								                str_format (localize("bookword", $post->count), $post->count), "text",
 								                array ( new LinkNavigation ($instance->getUri ())), "", $post->count));
 								        }
 								        return $entryArray;
 								    }
-												Add a way to specify the number of item per page. re #34

											
										
										
											2013-11-22 15:36:39 +02:00
+								    public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								        $totalResult = -1;
-												Remove trailing spaces

											
										
										
											2013-12-05 11:52:51 +02:00
-												Allow normalized search (without diacritics) it should also fix the case problem with non latin languages (cyrillic).

The last part is not tested.

disclaimer : Slow !

re #49, #48

											
										
										
											2014-05-03 18:57:06 +03:00
+								        if (useNormAndUp ()) {
 								            $query = preg_replace("/upper/", "normAndUp", $query);
 								            $columns = preg_replace("/upper/", "normAndUp", $columns);
 								        }
-												Add a way to specify the number of item per page. re #34

											
										
										
											2013-11-22 15:36:39 +02:00
+								        if (is_null ($numberPerPage)) {
 								            $numberPerPage = getCurrentOption ("max_item_per_page");
 								        }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Add a way to specify the number of item per page. re #34

											
										
										
											2013-11-22 15:36:39 +02:00
+								        if ($numberPerPage != -1 && $n != -1)
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								        {
 								            // First check total number of results
-												Fix search when no database is selected. re #40

											
										
										
											2013-04-29 17:46:52 +03:00
+								            $result = self::getDb ($database)->prepare (str_format ($query, "count(*)", $filter));
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								            $result->execute ($params);
 								            $totalResult = $result->fetchColumn ();
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								            // Next modify the query and params
 								            $query .= " limit ?, ?";
-												Add a way to specify the number of item per page. re #34

											
										
										
											2013-11-22 15:36:39 +02:00
+								            array_push ($params, ($n - 1) * $numberPerPage, $numberPerPage);
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								        }
-												COPS config: Add author name, uri and email
											
										
										
											2013-10-10 07:25:04 +03:00
-												Fix search when no database is selected. re #40

											
										
										
											2013-04-29 17:46:52 +03:00
+								        $result = self::getDb ($database)->prepare(str_format ($query, $columns, $filter));
-												First attempt to add paging in the OPDS side.

Need more polishing before being used everywhere.

--HG--
extra : rebase_source : 0fb3a4b12cf83d4b450a1fca81f82addd8d58c14

											
										
										
											2012-09-18 16:39:22 +03:00
+								        $result->execute ($params);
 								        return array ($totalResult, $result);
 								    }
-												Add v0.0.1

											
										
										
											2012-05-28 08:01:33 +03:00
+								}