Personal
/
cops
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Calibre OPDS (and HTML) PHP Server : web-based light alternative to Calibre content server / Calibre2OPDS to serve ebooks (epub, mobi, pdf, ...) http://blog.slucas.fr/en/oss/calibre-opds-php-server
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1030 Commits
1 Branch
5.4MB
Tree: 362f290972
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '362f290972'
${ noResults }
cops/base.php

1192 lines
41KB
Raw Blame History 

  1. <?php

  2. /**

  3.  * COPS (Calibre OPDS PHP Server) class file

  4.  *

  5.  * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)

  6.  * @author     S�bastien Lucas <sebastien@slucas.fr>

  7.  */

  8. 

  9. define ("VERSION", "0.9.1RC1");

  10. define ("DB", "db");

  11. date_default_timezone_set($config['default_timezone']);

  12. 

  13. 

  14. function useServerSideRendering () {

  15.     global $config;

  16.     return preg_match("/" . $config['cops_server_side_render'] . "/", $_SERVER['HTTP_USER_AGENT']);

  17. }

  18. 

  19. function serverSideRender ($data) {

  20.     // Get the templates

  21.     $theme = getCurrentTemplate ();

  22.     $header = file_get_contents('templates/' . $theme . '/header.html');

  23.     $footer = file_get_contents('templates/' . $theme . '/footer.html');

  24.     $main = file_get_contents('templates/' . $theme . '/main.html');

  25.     $bookdetail = file_get_contents('templates/' . $theme . '/bookdetail.html');

  26.     $page = file_get_contents('templates/' . $theme . '/page.html');

  27. 

  28.     // Generate the function for the template

  29.     $template = new doT ();

  30.     $dot = $template->template ($page, array ("bookdetail" => $bookdetail,

  31.                                               "header" => $header,

  32.                                               "footer" => $footer,

  33.                                               "main" => $main));

  34.     // Execute the template

  35.     if (!empty ($data)) {

  36.         return $dot ($data);

  37.     }

  38. 

  39.     return NULL;

  40. }

  41. 

  42. function getQueryString () {

  43.     if ( isset($_SERVER['QUERY_STRING']) ) {

  44.         return $_SERVER['QUERY_STRING'];

  45.     }

  46.     return "";

  47. }

  48. 

  49. function notFound () {

  50.     header($_SERVER["SERVER_PROTOCOL"]." 404 Not Found");

  51.     header("Status: 404 Not Found");

  52. 

  53.     $_SERVER['REDIRECT_STATUS'] = 404;

  54. }

  55. 

  56. function getURLParam ($name, $default = NULL) {

  57.     if (!empty ($_GET) && isset($_GET[$name]) && $_GET[$name] != "") {

  58.         return $_GET[$name];

  59.     }

  60.     return $default;

  61. }

  62. 

  63. function getCurrentOption ($option) {

  64.     global $config;

  65.     if (isset($_COOKIE[$option])) {

  66.         if (isset($config ["cops_" . $option]) && is_array ($config ["cops_" . $option])) {

  67.             return explode (",", $_COOKIE[$option]);

  68.         } else {

  69.             return $_COOKIE[$option];

  70.         }

  71.     }

  72.     if ($option == "style") {

  73.         return "default";

  74.     }

  75. 

  76.     if (isset($config ["cops_" . $option])) {

  77.         return $config ["cops_" . $option];

  78.     }

  79. 

  80.     return "";

  81. }

  82. 

  83. function getCurrentCss () {

  84.     return "templates/" . getCurrentTemplate () . "/styles/style-" . getCurrentOption ("style") . ".css";

  85. }

  86. 

  87. function getCurrentTemplate () {

  88.     return "default";

  89. }

  90. 

  91. function getUrlWithVersion ($url) {

  92.     return $url . "?v=" . VERSION;

  93. }

  94. 

  95. function xml2xhtml($xml) {

  96.     return preg_replace_callback('#<(\w+)([^>]*)\s*/>#s', create_function('$m', '

  97.         $xhtml_tags = array("br", "hr", "input", "frame", "img", "area", "link", "col", "base", "basefont", "param");

  98.         return in_array($m[1], $xhtml_tags) ? "<$m[1]$m[2] />" : "<$m[1]$m[2]></$m[1]>";

  99.     '), $xml);

  100. }

  101. 

  102. function display_xml_error($error)

  103. {

  104.     $return = "";

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

  106. 

  107.     switch ($error->level) {

  108.         case LIBXML_ERR_WARNING:

  109.             $return .= "Warning $error->code: ";

  110.             break;

  111.          case LIBXML_ERR_ERROR:

  112.             $return .= "Error $error->code: ";

  113.             break;

  114.         case LIBXML_ERR_FATAL:

  115.             $return .= "Fatal Error $error->code: ";

  116.             break;

  117.     }

  118. 

  119.     $return .= trim($error->message) .

  120.                "\n  Line: $error->line" .

  121.                "\n  Column: $error->column";

  122. 

  123.     if ($error->file) {

  124.         $return .= "\n  File: $error->file";

  125.     }

  126. 

  127.     return "$return\n\n--------------------------------------------\n\n";

  128. }

  129. 

  130. function are_libxml_errors_ok ()

  131. {

  132.     $errors = libxml_get_errors();

  133. 

  134.     foreach ($errors as $error) {

  135.         if ($error->code == 801) return false;

  136.     }

  137.     return true;

  138. }

  139. 

  140. function html2xhtml ($html) {

  141.     $doc = new DOMDocument();

  142.     libxml_use_internal_errors(true);

  143. 

  144.     $doc->loadHTML('<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body>' .

  145.                         $html  . '</body></html>'); // Load the HTML

  146.     $output = $doc->saveXML($doc->documentElement); // Transform to an Ansi xml stream

  147.     $output = xml2xhtml($output);

  148.     if (preg_match ('#<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></meta></head><body>(.*)</body></html>#ms', $output, $matches)) {

  149.         $output = $matches [1]; // Remove <html><body>

  150.     }

  151.     /*

  152.     // In case of error with summary, use it to debug

  153.     $errors = libxml_get_errors();

  154. 

  155.     foreach ($errors as $error) {

  156.         $output .= display_xml_error($error);

  157.     }

  158.     */

  159. 

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

  161. 

  162.     libxml_use_internal_errors(false);

  163.     return $output;

  164. }

  165. 

  166. /**

  167.  * This method is a direct copy-paste from

  168.  * http://tmont.com/blargh/2010/1/string-format-in-php

  169.  */

  170. function str_format($format) {

  171.     $args = func_get_args();

  172.     $format = array_shift($args);

  173. 

  174.     preg_match_all('/(?=\{)\{(\d+)\}(?!\})/', $format, $matches, PREG_OFFSET_CAPTURE);

  175.     $offset = 0;

  176.     foreach ($matches[1] as $data) {

  177.         $i = $data[0];

  178.         $format = substr_replace($format, @$args[$i], $offset + $data[1] - 1, 2 + strlen($i));

  179.         $offset += strlen(@$args[$i]) - 2 - strlen($i);

  180.     }

  181. 

  182.     return $format;

  183. }

  184. 

  185. /**

  186.  * This method is based on this page

  187.  * http://www.mind-it.info/2010/02/22/a-simple-approach-to-localization-in-php/

  188.  */

  189. function localize($phrase, $count=-1, $reset=false) {

  190.     if ($count == 0)

  191.         $phrase .= ".none";

  192.     if ($count == 1)

  193.         $phrase .= ".one";

  194.     if ($count > 1)

  195.         $phrase .= ".many";

  196. 

  197.     /* Static keyword is used to ensure the file is loaded only once */

  198.     static $translations = NULL;

  199.     if ($reset) {

  200.         $translations = NULL;

  201.     }

  202.     /* If no instance of $translations has occured load the language file */

  203.     if (is_null($translations)) {

  204.         $lang = "en";

  205.         if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE']))

  206.         {

  207.             $lang = substr($_SERVER['HTTP_ACCEPT_LANGUAGE'], 0, 2);

  208.         }

  209.         $lang_file_en = NULL;

  210.         $lang_file = dirname(__FILE__). '/lang/Localization_' . $lang . '.json';

  211.         if (!file_exists($lang_file)) {

  212.             $lang_file = dirname(__FILE__). '/lang/' . 'Localization_en.json';

  213.         }

  214.         elseif ($lang != "en") {

  215.             $lang_file_en = dirname(__FILE__). '/lang/' . 'Localization_en.json';

  216.         }

  217.         $lang_file_content = file_get_contents($lang_file);

  218.         /* Load the language file as a JSON object and transform it into an associative array */

  219.         $translations = json_decode($lang_file_content, true);

  220. 

  221.         /* Clean the array of all unfinished translations */

  222.         foreach (array_keys ($translations) as $key) {

  223.             if (preg_match ("/^##TODO##/", $key)) {

  224.                 unset ($translations [$key]);

  225.             }

  226.         }

  227.         if ($lang_file_en)

  228.         {

  229.             $lang_file_content = file_get_contents($lang_file_en);

  230.             $translations_en = json_decode($lang_file_content, true);

  231.             $translations = array_merge ($translations_en, $translations);

  232.         }

  233.     }

  234.     if (array_key_exists ($phrase, $translations)) {

  235.         return $translations[$phrase];

  236.     }

  237.     return $phrase;

  238. }

  239. 

  240. function addURLParameter($urlParams, $paramName, $paramValue) {

  241.     if (empty ($urlParams)) {

  242.         $urlParams = "";

  243.     }

  244.     $start = "";

  245.     if (preg_match ("#^\?(.*)#", $urlParams, $matches)) {

  246.         $start = "?";

  247.         $urlParams = $matches[1];

  248.     }

  249.     $params = array();

  250.     parse_str($urlParams, $params);

  251.     if (empty ($paramValue) && $paramValue != 0) {

  252.         unset ($params[$paramName]);

  253.     } else {

  254.         $params[$paramName] = $paramValue;

  255.     }

  256.     return $start . http_build_query($params);

  257. }

  258. 

  259. class Link

  260. {

  261.     const OPDS_THUMBNAIL_TYPE = "http://opds-spec.org/image/thumbnail";

  262.     const OPDS_IMAGE_TYPE = "http://opds-spec.org/image";

  263.     const OPDS_ACQUISITION_TYPE = "http://opds-spec.org/acquisition";

  264.     const OPDS_NAVIGATION_TYPE = "application/atom+xml;profile=opds-catalog;kind=navigation";

  265.     const OPDS_PAGING_TYPE = "application/atom+xml;profile=opds-catalog;kind=acquisition";

  266. 

  267.     public $href;

  268.     public $type;

  269.     public $rel;

  270.     public $title;

  271.     public $facetGroup;

  272.     public $activeFacet;

  273. 

  274.     public function __construct($phref, $ptype, $prel = NULL, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {

  275.         $this->href = $phref;

  276.         $this->type = $ptype;

  277.         $this->rel = $prel;

  278.         $this->title = $ptitle;

  279.         $this->facetGroup = $pfacetGroup;

  280.         $this->activeFacet = $pactiveFacet;

  281.     }

  282. 

  283.     public function hrefXhtml () {

  284.         return $this->href;

  285.     }

  286. }

  287. 

  288. class LinkNavigation extends Link

  289. {

  290.     public function __construct($phref, $prel = NULL, $ptitle = NULL) {

  291.         parent::__construct ($phref, Link::OPDS_NAVIGATION_TYPE, $prel, $ptitle);

  292.         if (!is_null (GetUrlParam (DB))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));

  293.         if (!preg_match ("#^\?(.*)#", $this->href) && !empty ($this->href)) $this->href = "?" . $this->href;

  294.         if (preg_match ("/(bookdetail|getJSON).php/", $_SERVER["SCRIPT_NAME"])) {

  295.             $this->href = "index.php" . $this->href;

  296.         } else {

  297.             $this->href = $_SERVER["SCRIPT_NAME"] . $this->href;

  298.         }

  299.     }

  300. }

  301. 

  302. class LinkFacet extends Link

  303. {

  304.     public function __construct($phref, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {

  305.         parent::__construct ($phref, Link::OPDS_PAGING_TYPE, "http://opds-spec.org/facet", $ptitle, $pfacetGroup, $pactiveFacet);

  306.         if (!is_null (GetUrlParam (DB))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));

  307.         $this->href = $_SERVER["SCRIPT_NAME"] . $this->href;

  308.     }

  309. }

  310. 

  311. class Entry

  312. {

  313.     public $title;

  314.     public $id;

  315.     public $content;

  316.     public $contentType;

  317.     public $linkArray;

  318.     public $localUpdated;

  319.     public $className;

  320.     private static $updated = NULL;

  321. 

  322.     public static $icons = array(

  323.         Author::ALL_AUTHORS_ID       => 'images/author.png',

  324.         Serie::ALL_SERIES_ID         => 'images/serie.png',

  325.         Book::ALL_RECENT_BOOKS_ID    => 'images/recent.png',

  326.         Tag::ALL_TAGS_ID             => 'images/tag.png',

  327.         Language::ALL_LANGUAGES_ID   => 'images/language.png',

  328.         CustomColumn::ALL_CUSTOMS_ID => 'images/tag.png',

  329.         "cops:books$"             => 'images/allbook.png',

  330.         "cops:books:letter"       => 'images/allbook.png',

  331.         Publisher::ALL_PUBLISHERS_ID => 'images/publisher.png'

  332.     );

  333. 

  334.     public function getUpdatedTime () {

  335.         if (!is_null ($this->localUpdated)) {

  336.             return date (DATE_ATOM, $this->localUpdated);

  337.         }

  338.         if (is_null (self::$updated)) {

  339.             self::$updated = time();

  340.         }

  341.         return date (DATE_ATOM, self::$updated);

  342.     }

  343. 

  344.     public function getNavLink () {

  345.         foreach ($this->linkArray as $link) {

  346.             if ($link->type != Link::OPDS_NAVIGATION_TYPE) { continue; }

  347. 

  348.             return $link->hrefXhtml ();

  349.         }

  350.         return "#";

  351.     }

  352. 

  353.     public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pclass = "") {

  354.         global $config;

  355.         $this->title = $ptitle;

  356.         $this->id = $pid;

  357.         $this->content = $pcontent;

  358.         $this->contentType = $pcontentType;

  359.         $this->linkArray = $plinkArray;

  360.         $this->className = $pclass;

  361. 

  362.         if ($config['cops_show_icons'] == 1)

  363.         {

  364.             foreach (self::$icons as $reg => $image)

  365.             {

  366.                 if (preg_match ("/" . $reg . "/", $pid)) {

  367.                     array_push ($this->linkArray, new Link (getUrlWithVersion ($image), "image/png", Link::OPDS_THUMBNAIL_TYPE));

  368.                     break;

  369.                 }

  370.             }

  371.         }

  372. 

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

  374.     }

  375. }

  376. 

  377. class EntryBook extends Entry

  378. {

  379.     public $book;

  380. 

  381.     public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pbook) {

  382.         parent::__construct ($ptitle, $pid, $pcontent, $pcontentType, $plinkArray);

  383.         $this->book = $pbook;

  384.         $this->localUpdated = $pbook->timestamp;

  385.     }

  386. 

  387.     public function getCoverThumbnail () {

  388.         foreach ($this->linkArray as $link) {

  389.             if ($link->rel == Link::OPDS_THUMBNAIL_TYPE)

  390.                 return $link->hrefXhtml ();

  391.         }

  392.         return null;

  393.     }

  394. 

  395.     public function getCover () {

  396.         foreach ($this->linkArray as $link) {

  397.             if ($link->rel == Link::OPDS_IMAGE_TYPE)

  398.                 return $link->hrefXhtml ();

  399.         }

  400.         return null;

  401.     }

  402. }

  403. 

  404. class Page

  405. {

  406.     public $title;

  407.     public $subtitle = "";

  408.     public $authorName = "";

  409.     public $authorUri = "";

  410.     public $authorEmail = "";

  411.     public $idPage;

  412.     public $idGet;

  413.     public $query;

  414.     public $favicon;

  415.     public $n;

  416.     public $book;

  417.     public $totalNumber = -1;

  418.     public $entryArray = array();

  419. 

  420.     public static function getPage ($pageId, $id, $query, $n)

  421.     {

  422.         switch ($pageId) {

  423.             case Base::PAGE_ALL_AUTHORS :

  424.                 return new PageAllAuthors ($id, $query, $n);

  425.             case Base::PAGE_AUTHORS_FIRST_LETTER :

  426.                 return new PageAllAuthorsLetter ($id, $query, $n);

  427.             case Base::PAGE_AUTHOR_DETAIL :

  428.                 return new PageAuthorDetail ($id, $query, $n);

  429.             case Base::PAGE_ALL_TAGS :

  430.                 return new PageAllTags ($id, $query, $n);

  431.             case Base::PAGE_TAG_DETAIL :

  432.                 return new PageTagDetail ($id, $query, $n);

  433.             case Base::PAGE_ALL_LANGUAGES :

  434.                 return new PageAllLanguages ($id, $query, $n);

  435.             case Base::PAGE_LANGUAGE_DETAIL :

  436.                 return new PageLanguageDetail ($id, $query, $n);

  437.             case Base::PAGE_ALL_CUSTOMS :

  438.                 return new PageAllCustoms ($id, $query, $n);

  439.             case Base::PAGE_CUSTOM_DETAIL :

  440.                 return new PageCustomDetail ($id, $query, $n);

  441.             case Base::PAGE_ALL_RATINGS :

  442.                 return new PageAllRating ($id, $query, $n);

  443.             case Base::PAGE_RATING_DETAIL :

  444.                 return new PageRatingDetail ($id, $query, $n);

  445.             case Base::PAGE_ALL_SERIES :

  446.                 return new PageAllSeries ($id, $query, $n);

  447.             case Base::PAGE_ALL_BOOKS :

  448.                 return new PageAllBooks ($id, $query, $n);

  449.             case Base::PAGE_ALL_BOOKS_LETTER:

  450.                 return new PageAllBooksLetter ($id, $query, $n);

  451.             case Base::PAGE_ALL_RECENT_BOOKS :

  452.                 return new PageRecentBooks ($id, $query, $n);

  453.             case Base::PAGE_SERIE_DETAIL :

  454.                 return new PageSerieDetail ($id, $query, $n);

  455.             case Base::PAGE_OPENSEARCH_QUERY :

  456.                 return new PageQueryResult ($id, $query, $n);

  457.             case Base::PAGE_BOOK_DETAIL :

  458.                 return new PageBookDetail ($id, $query, $n);

  459.             case Base::PAGE_ALL_PUBLISHERS:

  460.                 return new PageAllPublishers ($id, $query, $n);

  461.             case Base::PAGE_PUBLISHER_DETAIL :

  462.                 return new PagePublisherDetail ($id, $query, $n);

  463.             case Base::PAGE_ABOUT :

  464.                 return new PageAbout ($id, $query, $n);

  465.             case Base::PAGE_CUSTOMIZE :

  466.                 return new PageCustomize ($id, $query, $n);

  467.             default:

  468.                 $page = new Page ($id, $query, $n);

  469.                 $page->idPage = "cops:catalog";

  470.                 return $page;

  471.         }

  472.     }

  473. 

  474.     public function __construct($pid, $pquery, $pn) {

  475.         global $config;

  476. 

  477.         $this->idGet = $pid;

  478.         $this->query = $pquery;

  479.         $this->n = $pn;

  480.         $this->favicon = $config['cops_icon'];

  481.         $this->authorName = empty($config['cops_author_name']) ? utf8_encode('S�bastien Lucas') : $config['cops_author_name'];

  482.         $this->authorUri = empty($config['cops_author_uri']) ? 'http://blog.slucas.fr' : $config['cops_author_uri'];

  483.         $this->authorEmail = empty($config['cops_author_email']) ? 'sebastien@slucas.fr' : $config['cops_author_email'];

  484.     }

  485. 

  486.     public function InitializeContent ()

  487.     {

  488.         global $config;

  489.         $this->title = $config['cops_title_default'];

  490.         $this->subtitle = $config['cops_subtitle_default'];

  491.         if (Base::noDatabaseSelected ()) {

  492.             $i = 0;

  493.             foreach (Base::getDbNameList () as $key) {

  494.                 $nBooks = Book::getBookCount ($i);

  495.                 array_push ($this->entryArray, new Entry ($key, "cops:{$i}:catalog",

  496.                                         str_format (localize ("bookword", $nBooks), $nBooks), "text",

  497.                                         array ( new LinkNavigation ("?" . DB . "={$i}"))));

  498.                 $i++;

  499.                 Base::clearDb ();

  500.             }

  501.         } else {

  502.             if (!in_array (PageQueryResult::SCOPE_AUTHOR, getCurrentOption ('ignored_categories'))) {

  503.                 array_push ($this->entryArray, Author::getCount());

  504.             }

  505.             if (!in_array (PageQueryResult::SCOPE_SERIES, getCurrentOption ('ignored_categories'))) {

  506.                 $series = Serie::getCount();

  507.                 if (!is_null ($series)) array_push ($this->entryArray, $series);

  508.             }

  509.             if (!in_array (PageQueryResult::SCOPE_PUBLISHER, getCurrentOption ('ignored_categories'))) {

  510.                 $publisher = Publisher::getCount();

  511.                 if (!is_null ($publisher)) array_push ($this->entryArray, $publisher);

  512.             }

  513.             if (!in_array (PageQueryResult::SCOPE_TAG, getCurrentOption ('ignored_categories'))) {

  514.                 $tags = Tag::getCount();

  515.                 if (!is_null ($tags)) array_push ($this->entryArray, $tags);

  516.             }

  517.             if (!in_array (PageQueryResult::SCOPE_RATING, getCurrentOption ('ignored_categories'))) {

  518.                 $rating = Rating::getCount();

  519.                 if (!is_null ($rating)) array_push ($this->entryArray, $rating);

  520.             }

  521.             if (!in_array ("language", getCurrentOption ('ignored_categories'))) {

  522.                 $languages = Language::getCount();

  523.                 if (!is_null ($languages)) array_push ($this->entryArray, $languages);

  524.             }

  525.             foreach ($config['cops_calibre_custom_column'] as $lookup) {

  526.                 $customId = CustomColumn::getCustomId ($lookup);

  527.                 if (!is_null ($customId)) {

  528.                     array_push ($this->entryArray, CustomColumn::getCount($customId));

  529.                 }

  530.             }

  531.             $this->entryArray = array_merge ($this->entryArray, Book::getCount());

  532. 

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

  534.         }

  535.     }

  536. 

  537.     public function isPaginated ()

  538.     {

  539.         return (getCurrentOption ("max_item_per_page") != -1 &&

  540.                 $this->totalNumber != -1 &&

  541.                 $this->totalNumber > getCurrentOption ("max_item_per_page"));

  542.     }

  543. 

  544.     public function getNextLink ()

  545.     {

  546.         $currentUrl = preg_replace ("/\&n=.*?$/", "", "?" . getQueryString ());

  547.         if (($this->n) * getCurrentOption ("max_item_per_page") < $this->totalNumber) {

  548.             return new LinkNavigation ($currentUrl . "&n=" . ($this->n + 1), "next", localize ("paging.next.alternate"));

  549.         }

  550.         return NULL;

  551.     }

  552. 

  553.     public function getPrevLink ()

  554.     {

  555.         $currentUrl = preg_replace ("/\&n=.*?$/", "", "?" . getQueryString ());

  556.         if ($this->n > 1) {

  557.             return new LinkNavigation ($currentUrl . "&n=" . ($this->n - 1), "previous", localize ("paging.previous.alternate"));

  558.         }

  559.         return NULL;

  560.     }

  561. 

  562.     public function getMaxPage ()

  563.     {

  564.         return ceil ($this->totalNumber / getCurrentOption ("max_item_per_page"));

  565.     }

  566. 

  567.     public function containsBook ()

  568.     {

  569.         if (count ($this->entryArray) == 0) return false;

  570.         if (get_class ($this->entryArray [0]) == "EntryBook") return true;

  571.         return false;

  572.     }

  573. }

  574. 

  575. class PageAllAuthors extends Page

  576. {

  577.     public function InitializeContent ()

  578.     {

  579.         $this->title = localize("authors.title");

  580.         if (getCurrentOption ("author_split_first_letter") == 1) {

  581.             $this->entryArray = Author::getAllAuthorsByFirstLetter();

  582.         }

  583.         else {

  584.             $this->entryArray = Author::getAllAuthors();

  585.         }

  586.         $this->idPage = Author::ALL_AUTHORS_ID;

  587.     }

  588. }

  589. 

  590. class PageAllAuthorsLetter extends Page

  591. {

  592.     public function InitializeContent ()

  593.     {

  594.         $this->idPage = Author::getEntryIdByLetter ($this->idGet);

  595.         $this->entryArray = Author::getAuthorsByStartingLetter ($this->idGet);

  596.         $this->title = str_format (localize ("splitByLetter.letter"), str_format (localize ("authorword", count ($this->entryArray)), count ($this->entryArray)), $this->idGet);

  597.     }

  598. }

  599. 

  600. class PageAuthorDetail extends Page

  601. {

  602.     public function InitializeContent ()

  603.     {

  604.         $author = Author::getAuthorById ($this->idGet);

  605.         $this->idPage = $author->getEntryId ();

  606.         $this->title = $author->name;

  607.         list ($this->entryArray, $this->totalNumber) = Book::getBooksByAuthor ($this->idGet, $this->n);

  608.     }

  609. }

  610. 

  611. class PageAllPublishers extends Page

  612. {

  613.     public function InitializeContent ()

  614.     {

  615.         $this->title = localize("publishers.title");

  616.         $this->entryArray = Publisher::getAllPublishers();

  617.         $this->idPage = Publisher::ALL_PUBLISHERS_ID;

  618.     }

  619. }

  620. 

  621. class PagePublisherDetail extends Page

  622. {

  623.     public function InitializeContent ()

  624.     {

  625.         $publisher = Publisher::getPublisherById ($this->idGet);

  626.         $this->title = $publisher->name;

  627.         list ($this->entryArray, $this->totalNumber) = Book::getBooksByPublisher ($this->idGet, $this->n);

  628.         $this->idPage = $publisher->getEntryId ();

  629.     }

  630. }

  631. 

  632. class PageAllTags extends Page

  633. {

  634.     public function InitializeContent ()

  635.     {

  636.         $this->title = localize("tags.title");

  637.         $this->entryArray = Tag::getAllTags();

  638.         $this->idPage = Tag::ALL_TAGS_ID;

  639.     }

  640. }

  641. 

  642. class PageAllLanguages extends Page

  643. {

  644.     public function InitializeContent ()

  645.     {

  646.         $this->title = localize("languages.title");

  647.         $this->entryArray = Language::getAllLanguages();

  648.         $this->idPage = Language::ALL_LANGUAGES_ID;

  649.     }

  650. }

  651. 

  652. class PageCustomDetail extends Page

  653. {

  654.     public function InitializeContent ()

  655.     {

  656.         $customId = getURLParam ("custom", NULL);

  657.         $custom = CustomColumn::getCustomById ($customId, $this->idGet);

  658.         $this->idPage = $custom->getEntryId ();

  659.         $this->title = $custom->name;

  660.         list ($this->entryArray, $this->totalNumber) = Book::getBooksByCustom ($customId, $this->idGet, $this->n);

  661.     }

  662. }

  663. 

  664. class PageAllCustoms extends Page

  665. {

  666.     public function InitializeContent ()

  667.     {

  668.         $customId = getURLParam ("custom", NULL);

  669.         $this->title = CustomColumn::getAllTitle ($customId);

  670.         $this->entryArray = CustomColumn::getAllCustoms($customId);

  671.         $this->idPage = CustomColumn::getAllCustomsId ($customId);

  672.     }

  673. }

  674. 

  675. class PageTagDetail extends Page

  676. {

  677.     public function InitializeContent ()

  678.     {

  679.         $tag = Tag::getTagById ($this->idGet);

  680.         $this->idPage = $tag->getEntryId ();

  681.         $this->title = $tag->name;

  682.         list ($this->entryArray, $this->totalNumber) = Book::getBooksByTag ($this->idGet, $this->n);

  683.     }

  684. }

  685. 

  686. class PageLanguageDetail extends Page

  687. {

  688.     public function InitializeContent ()

  689.     {

  690.         $language = Language::getLanguageById ($this->idGet);

  691.         $this->idPage = $language->getEntryId ();

  692.         $this->title = $language->lang_code;

  693.         list ($this->entryArray, $this->totalNumber) = Book::getBooksByLanguage ($this->idGet, $this->n);

  694.     }

  695. }

  696. 

  697. class PageAllSeries extends Page

  698. {

  699.     public function InitializeContent ()

  700.     {

  701.         $this->title = localize("series.title");

  702.         $this->entryArray = Serie::getAllSeries();

  703.         $this->idPage = Serie::ALL_SERIES_ID;

  704.     }

  705. }

  706. 

  707. class PageSerieDetail extends Page

  708. {

  709.     public function InitializeContent ()

  710.     {

  711.         $serie = Serie::getSerieById ($this->idGet);

  712.         $this->title = $serie->name;

  713.         list ($this->entryArray, $this->totalNumber) = Book::getBooksBySeries ($this->idGet, $this->n);

  714.         $this->idPage = $serie->getEntryId ();

  715.     }

  716. }

  717. 

  718. class PageAllRating extends Page

  719. {

  720.     public function InitializeContent ()

  721.     {

  722.         $this->title = localize("ratings.title");

  723.         $this->entryArray = Rating::getAllRatings();

  724.         $this->idPage = Rating::ALL_RATING_ID;

  725.     }

  726. }

  727. 

  728. class PageRatingDetail extends Page

  729. {

  730.     public function InitializeContent ()

  731.     {

  732.         $rating = Rating::getRatingById ($this->idGet);

  733.         $this->idPage = $rating->getEntryId ();

  734.         $this->title =str_format (localize ("ratingword", $rating->name/2), $rating->name/2);

  735.         list ($this->entryArray, $this->totalNumber) = Book::getBooksByRating ($this->idGet, $this->n);

  736.     }

  737. }

  738. 

  739. class PageAllBooks extends Page

  740. {

  741.     public function InitializeContent ()

  742.     {

  743.         $this->title = localize ("allbooks.title");

  744.         if (getCurrentOption ("titles_split_first_letter") == 1) {

  745.             $this->entryArray = Book::getAllBooks();

  746.         }

  747.         else {

  748.             list ($this->entryArray, $this->totalNumber) = Book::getBooks ($this->n);

  749.         }

  750.         $this->idPage = Book::ALL_BOOKS_ID;

  751.     }

  752. }

  753. 

  754. class PageAllBooksLetter extends Page

  755. {

  756.     public function InitializeContent ()

  757.     {

  758.         list ($this->entryArray, $this->totalNumber) = Book::getBooksByStartingLetter ($this->idGet, $this->n);

  759.         $this->idPage = Book::getEntryIdByLetter ($this->idGet);

  760. 

  761.         $count = $this->totalNumber;

  762.         if ($count == -1)

  763.             $count = count ($this->entryArray);

  764. 

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

  766.     }

  767. }

  768. 

  769. class PageRecentBooks extends Page

  770. {

  771.     public function InitializeContent ()

  772.     {

  773.         $this->title = localize ("recent.title");

  774.         $this->entryArray = Book::getAllRecentBooks ();

  775.         $this->idPage = Book::ALL_RECENT_BOOKS_ID;

  776.     }

  777. }

  778. 

  779. class PageQueryResult extends Page

  780. {

  781.     const SCOPE_TAG = "tag";

  782.     const SCOPE_RATING = "rating";

  783.     const SCOPE_SERIES = "series";

  784.     const SCOPE_AUTHOR = "author";

  785.     const SCOPE_BOOK = "book";

  786.     const SCOPE_PUBLISHER = "publisher";

  787. 

  788.     private function useTypeahead () {

  789.         return !is_null (getURLParam ("search"));

  790.     }

  791. 

  792.     private function searchByScope ($scope, $limit = FALSE) {

  793.         $n = $this->n;

  794.         $numberPerPage = NULL;

  795.         if ($limit) {

  796.             $n = 1;

  797.             $numberPerPage = 5;

  798.         }

  799.         switch ($scope) {

  800.             case self::SCOPE_BOOK :

  801.                 $array = Book::getBooksByStartingLetter ('%' . $this->query, $n, NULL, $numberPerPage);

  802.                 break;

  803.             case self::SCOPE_AUTHOR :

  804.                 $array = Author::getAuthorsByStartingLetter ('%' . $this->query);

  805.                 break;

  806.             case self::SCOPE_SERIES :

  807.                 $array = Serie::getAllSeriesByQuery ($this->query);

  808.                 break;

  809.             case self::SCOPE_TAG :

  810.                 $array = Tag::getAllTagsByQuery ($this->query, $n, NULL, $numberPerPage);

  811.                 break;

  812.             case self::SCOPE_PUBLISHER :

  813.                 $array = Publisher::getAllPublishersByQuery ($this->query);

  814.                 break;

  815.             default:

  816.                 $array = Book::getBooksByQuery (

  817.                     array ("all" => "%" . $this->query . "%"), $n);

  818.         }

  819. 

  820.         return $array;

  821.     }

  822. 

  823.     public function doSearchByCategory () {

  824.         $database = GetUrlParam (DB);

  825.         $out = array ();

  826.         $pagequery = Base::PAGE_OPENSEARCH_QUERY;

  827.         $dbArray = array ("");

  828.         $d = $database;

  829.         $query = $this->query;

  830.         // Special case when no databases were chosen, we search on all databases

  831.         if (Base::noDatabaseSelected ()) {

  832.             $dbArray = Base::getDbNameList ();

  833.             $d = 0;

  834.         }

  835.         foreach ($dbArray as $key) {

  836.             if (Base::noDatabaseSelected ()) {

  837.                 array_push ($this->entryArray, new Entry ($key, DB . ":query:{$d}",

  838.                                         " ", "text",

  839.                                         array ( new LinkNavigation ("?" . DB . "={$d}")), "tt-header"));

  840.                 Base::getDb ($d);

  841.             }

  842.             foreach (array (PageQueryResult::SCOPE_BOOK,

  843.                             PageQueryResult::SCOPE_AUTHOR,

  844.                             PageQueryResult::SCOPE_SERIES,

  845.                             PageQueryResult::SCOPE_TAG,

  846.                             PageQueryResult::SCOPE_PUBLISHER) as $key) {

  847.                 if (in_array($key, getCurrentOption ('ignored_categories'))) {

  848.                     continue;

  849.                 }

  850.                 $array = $this->searchByScope ($key, TRUE);

  851. 

  852.                 $i = 0;

  853.                 if (count ($array) == 2 && is_array ($array [0])) {

  854.                     $total = $array [1];

  855.                     $array = $array [0];

  856.                 } else {

  857.                     $total = count($array);

  858.                 }

  859.                 if ($total > 0) {

  860.                     // Comment to help the perl i18n script

  861.                     // str_format (localize("bookword", count($array))

  862.                     // str_format (localize("authorword", count($array))

  863.                     // str_format (localize("seriesword", count($array))

  864.                     // str_format (localize("tagword", count($array))

  865.                     // str_format (localize("publisherword", count($array))

  866.                     array_push ($this->entryArray, new Entry (str_format (localize ("search.result.{$key}"), $this->query), DB . ":query:{$d}:{$key}",

  867.                                         str_format (localize("{$key}word", $total), $total), "text",

  868.                                         array ( new LinkNavigation ("?page={$pagequery}&query={$query}&db={$d}&scope={$key}")),

  869.                                         Base::noDatabaseSelected () ? "" : "tt-header"));

  870.                 }

  871.                 if (!Base::noDatabaseSelected () && $this->useTypeahead ()) {

  872.                     foreach ($array as $entry) {

  873.                         array_push ($this->entryArray, $entry);

  874.                         $i++;

  875.                         if ($i > 4) { break; };

  876.                     }

  877.                 }

  878.             }

  879.             $d++;

  880.             if (Base::noDatabaseSelected ()) {

  881.                 Base::clearDb ();

  882.             }

  883.         }

  884.         return $out;

  885.     }

  886. 

  887.     public function InitializeContent ()

  888.     {

  889.         $scope = getURLParam ("scope");

  890.         if (empty ($scope)) {

  891.             $this->title = str_format (localize ("search.result"), $this->query);

  892.         } else {

  893.             // Comment to help the perl i18n script

  894.             // str_format (localize ("search.result.author"), $this->query)

  895.             // str_format (localize ("search.result.tag"), $this->query)

  896.             // str_format (localize ("search.result.series"), $this->query)

  897.             // str_format (localize ("search.result.book"), $this->query)

  898.             // str_format (localize ("search.result.publisher"), $this->query)

  899.             $this->title = str_format (localize ("search.result.{$scope}"), $this->query);

  900.         }

  901. 

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

  903. 

  904.         // Special case when we are doing a search and no database is selected

  905.         if (Base::noDatabaseSelected () && !$this->useTypeahead ()) {

  906.             $i = 0;

  907.             foreach (Base::getDbNameList () as $key) {

  908.                 Base::clearDb ();

  909.                 list ($array, $totalNumber) = Book::getBooksByQuery (array ("all" => $crit), 1, $i, 1);

  910.                 array_push ($this->entryArray, new Entry ($key, DB . ":query:{$i}",

  911.                                         str_format (localize ("bookword", $totalNumber), $totalNumber), "text",

  912.                                         array ( new LinkNavigation ("?" . DB . "={$i}&page=9&query=" . $this->query))));

  913.                 $i++;

  914.             }

  915.             return;

  916.         }

  917.         if (empty ($scope)) {

  918.             $this->doSearchByCategory ();

  919.             return;

  920.         }

  921. 

  922.         $array = $this->searchByScope ($scope);

  923.         if (count ($array) == 2 && is_array ($array [0])) {

  924.             list ($this->entryArray, $this->totalNumber) = $array;

  925.         } else {

  926.             $this->entryArray = $array;

  927.         }

  928.     }

  929. }

  930. 

  931. class PageBookDetail extends Page

  932. {

  933.     public function InitializeContent ()

  934.     {

  935.         $this->book = Book::getBookById ($this->idGet);

  936.         $this->title = $this->book->title;

  937.     }

  938. }

  939. 

  940. class PageAbout extends Page

  941. {

  942.     public function InitializeContent ()

  943.     {

  944.         $this->title = localize ("about.title");

  945.     }

  946. }

  947. 

  948. class PageCustomize extends Page

  949. {

  950.     private function isChecked ($key, $testedValue = 1) {

  951.         $value = getCurrentOption ($key);

  952.         if (is_array ($value)) {

  953.             if (in_array ($testedValue, $value)) {

  954.                 return "checked='checked'";

  955.             }

  956.         } else {

  957.             if ($value == $testedValue) {

  958.                 return "checked='checked'";

  959.             }

  960.         }

  961.         return "";

  962.     }

  963. 

  964.     private function isSelected ($key, $value) {

  965.         if (getCurrentOption ($key) == $value) {

  966.             return "selected='selected'";

  967.         }

  968.         return "";

  969.     }

  970. 

  971.     private function getStyleList () {

  972.         $result = array ();

  973.         foreach (glob ("templates/" . getCurrentTemplate () . "/styles/style-*.css") as $filename) {

  974.             if (preg_match ('/styles\/style-(.*?)\.css/', $filename, $m)) {

  975.                 array_push ($result, $m [1]);

  976.             }

  977.         }

  978.         return $result;

  979.     }

  980. 

  981.     public function InitializeContent ()

  982.     {

  983.         $this->title = localize ("customize.title");

  984.         $this->entryArray = array ();

  985. 

  986.         $ignoredBaseArray = array (PageQueryResult::SCOPE_AUTHOR,

  987.                                    PageQueryResult::SCOPE_TAG,

  988.                                    PageQueryResult::SCOPE_SERIES,

  989.                                    PageQueryResult::SCOPE_PUBLISHER,

  990.                                    PageQueryResult::SCOPE_RATING,

  991.                                    "language");

  992. 

  993.         $content = "";

  994.         if (!preg_match("/(Kobo|Kindle\/3.0|EBRD1101)/", $_SERVER['HTTP_USER_AGENT'])) {

  995.             $content .= '<select id="style" onchange="updateCookie (this);">';

  996.             foreach ($this-> getStyleList () as $filename) {

  997.                 $content .= "<option value='{$filename}' " . $this->isSelected ("style", $filename) . ">{$filename}</option>";

  998.             }

  999.             $content .= '</select>';

  1000.         } else {

  1001.             foreach ($this-> getStyleList () as $filename) {

  1002.                 $content .= "<input type='radio' onchange='updateCookieFromCheckbox (this);' id='style-{$filename}' name='style' value='{$filename}' " . $this->isChecked ("style", $filename) . " /><label for='style-{$filename}'> {$filename} </label>";

  1003.             }

  1004.         }

  1005.         array_push ($this->entryArray, new Entry (localize ("customize.style"), "",

  1006.                                         $content, "text",

  1007.                                         array ()));

  1008.         if (!useServerSideRendering ()) {

  1009.             $content = '<input type="checkbox" onchange="updateCookieFromCheckbox (this);" id="use_fancyapps" ' . $this->isChecked ("use_fancyapps") . ' />';

  1010.             array_push ($this->entryArray, new Entry (localize ("customize.fancybox"), "",

  1011.                                             $content, "text",

  1012.                                             array ()));

  1013.         }

  1014.         $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]+$" />';

  1015.         array_push ($this->entryArray, new Entry (localize ("customize.paging"), "",

  1016.                                         $content, "text",

  1017.                                         array ()));

  1018.         $content = '<input type="text" onchange="updateCookie (this);" id="email" value="' . getCurrentOption ("email") . '" />';

  1019.         array_push ($this->entryArray, new Entry (localize ("customize.email"), "",

  1020.                                         $content, "text",

  1021.                                         array ()));

  1022.         $content = '<input type="checkbox" onchange="updateCookieFromCheckbox (this);" id="html_tag_filter" ' . $this->isChecked ("html_tag_filter") . ' />';

  1023.         array_push ($this->entryArray, new Entry (localize ("customize.filter"), "",

  1024.                                         $content, "text",

  1025.                                         array ()));

  1026.         $content = "";

  1027.         foreach ($ignoredBaseArray as $key) {

  1028.             $keyPlural = preg_replace ('/(ss)$/', 's', $key . "s");

  1029.             $content .=  '<input type="checkbox" name="ignored_categories[]" onchange="updateCookieFromCheckboxGroup (this);" id="ignored_categories_' . $key . '" ' . $this->isChecked ("ignored_categories", $key) . ' > ' . localize ("{$keyPlural}.title") . '</input> ';

  1030.         }

  1031. 

  1032.         array_push ($this->entryArray, new Entry (localize ("customize.ignored"), "",

  1033.                                         $content, "text",

  1034.                                         array ()));

  1035.     }

  1036. }

  1037. 

  1038. 

  1039. abstract class Base

  1040. {

  1041.     const PAGE_INDEX = "index";

  1042.     const PAGE_ALL_AUTHORS = "1";

  1043.     const PAGE_AUTHORS_FIRST_LETTER = "2";

  1044.     const PAGE_AUTHOR_DETAIL = "3";

  1045.     const PAGE_ALL_BOOKS = "4";

  1046.     const PAGE_ALL_BOOKS_LETTER = "5";

  1047.     const PAGE_ALL_SERIES = "6";

  1048.     const PAGE_SERIE_DETAIL = "7";

  1049.     const PAGE_OPENSEARCH = "8";

  1050.     const PAGE_OPENSEARCH_QUERY = "9";

  1051.     const PAGE_ALL_RECENT_BOOKS = "10";

  1052.     const PAGE_ALL_TAGS = "11";

  1053.     const PAGE_TAG_DETAIL = "12";

  1054.     const PAGE_BOOK_DETAIL = "13";

  1055.     const PAGE_ALL_CUSTOMS = "14";

  1056.     const PAGE_CUSTOM_DETAIL = "15";

  1057.     const PAGE_ABOUT = "16";

  1058.     const PAGE_ALL_LANGUAGES = "17";

  1059.     const PAGE_LANGUAGE_DETAIL = "18";

  1060.     const PAGE_CUSTOMIZE = "19";

  1061.     const PAGE_ALL_PUBLISHERS = "20";

  1062.     const PAGE_PUBLISHER_DETAIL = "21";

  1063.     const PAGE_ALL_RATINGS = "22";

  1064.     const PAGE_RATING_DETAIL = "23";

  1065. 

  1066.     const COMPATIBILITY_XML_ALDIKO = "aldiko";

  1067. 

  1068.     private static $db = NULL;

  1069. 

  1070.     public static function isMultipleDatabaseEnabled () {

  1071.         global $config;

  1072.         return is_array ($config['calibre_directory']);

  1073.     }

  1074. 

  1075.     public static function useAbsolutePath () {

  1076.         global $config;

  1077.         $path = self::getDbDirectory();

  1078.         return preg_match ('/^\//', $path) || // Linux /

  1079.                preg_match ('/^\w\:/', $path); // Windows X:

  1080.     }

  1081. 

  1082.     public static function noDatabaseSelected () {

  1083.         return self::isMultipleDatabaseEnabled () && is_null (GetUrlParam (DB));

  1084.     }

  1085. 

  1086.     public static function getDbList () {

  1087.         global $config;

  1088.         if (self::isMultipleDatabaseEnabled ()) {

  1089.             return $config['calibre_directory'];

  1090.         } else {

  1091.             return array ("" => $config['calibre_directory']);

  1092.         }

  1093.     }

  1094. 

  1095.     public static function getDbNameList () {

  1096.         global $config;

  1097.         if (self::isMultipleDatabaseEnabled ()) {

  1098.             return array_keys ($config['calibre_directory']);

  1099.         } else {

  1100.             return array ("");

  1101.         }

  1102.     }

  1103. 

  1104.     public static function getDbName ($database = NULL) {

  1105.         global $config;

  1106.         if (self::isMultipleDatabaseEnabled ()) {

  1107.             if (is_null ($database)) $database = GetUrlParam (DB, 0);

  1108.             $array = array_keys ($config['calibre_directory']);

  1109.             return  $array[$database];

  1110.         }

  1111.         return "";

  1112.     }

  1113. 

  1114.     public static function getDbDirectory ($database = NULL) {

  1115.         global $config;

  1116.         if (self::isMultipleDatabaseEnabled ()) {

  1117.             if (is_null ($database)) $database = GetUrlParam (DB, 0);

  1118.             $array = array_values ($config['calibre_directory']);

  1119.             return  $array[$database];

  1120.         }

  1121.         return $config['calibre_directory'];

  1122.     }

  1123. 

  1124. 

  1125.     public static function getDbFileName ($database = NULL) {

  1126.         return self::getDbDirectory ($database) .'metadata.db';

  1127.     }

  1128. 

  1129.     private static function error () {

  1130.         if (php_sapi_name() != "cli") {

  1131.             header("location: checkconfig.php?err=1");

  1132.         }

  1133.         throw new Exception('Database not found.');

  1134.     }

  1135. 

  1136.     public static function getDb ($database = NULL) {

  1137.         if (is_null (self::$db)) {

  1138.             try {

  1139.                 if (is_readable (self::getDbFileName ($database))) {

  1140.                     self::$db = new PDO('sqlite:'. self::getDbFileName ($database));

  1141.                 } else {

  1142.                     self::error ();

  1143.                 }

  1144.             } catch (Exception $e) {

  1145.                 self::error ();

  1146.             }

  1147.         }

  1148.         return self::$db;

  1149.     }

  1150. 

  1151.     public static function checkDatabaseAvailability () {

  1152.         if (self::noDatabaseSelected ()) {

  1153.             for ($i = 0; $i < count (self::getDbList ()); $i++) {

  1154.                 self::getDb ($i);

  1155.                 self::clearDb ();

  1156.             }

  1157.         } else {

  1158.             self::getDb ();

  1159.         }

  1160.         return true;

  1161.     }

  1162. 

  1163.     public static function clearDb () {

  1164.         self::$db = NULL;

  1165.     }

  1166. 

  1167.     public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {

  1168.         $totalResult = -1;

  1169. 

  1170.         if (is_null ($numberPerPage)) {

  1171.             $numberPerPage = getCurrentOption ("max_item_per_page");

  1172.         }

  1173. 

  1174.         if ($numberPerPage != -1 && $n != -1)

  1175.         {

  1176.             // First check total number of results

  1177.             $result = self::getDb ($database)->prepare (str_format ($query, "count(*)", $filter));

  1178.             $result->execute ($params);

  1179.             $totalResult = $result->fetchColumn ();

  1180. 

  1181.             // Next modify the query and params

  1182.             $query .= " limit ?, ?";

  1183.             array_push ($params, ($n - 1) * $numberPerPage, $numberPerPage);

  1184.         }

  1185. 

  1186.         $result = self::getDb ($database)->prepare(str_format ($query, $columns, $filter));

  1187.         $result->execute ($params);

  1188.         return array ($totalResult, $result);

  1189.     }

  1190. 

  1191. }