cops/checkconfig.php

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<?php
/**
 * COPS (Calibre OPDS PHP Server) Configuration check
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     S<EFBFBD>bastien Lucas <sebastien@slucas.fr>
 *
 */
 
    require_once ("config.php");
    require_once ("base.php");
    
    header ("Content-Type:text/html; charset=UTF-8");
    
    $err = getURLParam ("err", -1);
    $error = NULL;
    switch ($err) {
        case 1 :
            $error = "Database error";
            break;
    }

?>
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>COPS Configuration Check</title>
    <link rel="stylesheet" type="text/css" href="<?php echo getUrlWithVersion(getCurrentCss ()) ?>" media="screen" />
</head>
<body>
<div class="container">
    <header>
        <div class="headcenter">
            <h1>COPS Configuration Check</h1>
        </div>
    </header>
    <div id="content" style="display: none;"></div>
    <section>
        <?php
        if (!is_null ($error)) {
        ?>
        <article class="frontpage">
            <h2>You've been redirected because COPS is not configured properly</h2>
            <h4><?php echo $error ?></h4>
        </article>
        <?php
        }
        ?>
        <article class="frontpage">
            <h2>Check if GD is properly installed and loaded</h2>
            <h4>
            <?php 
            if (extension_loaded('gd') && function_exists('gd_info')) {
                echo "OK";
            } else {
                echo "Please install the php5-gd extension and make sure it's enabled";
            }
            ?>
            </h4>
        </article>
        <article class="frontpage">
            <h2>Check if Sqlite is properly installed and loaded</h2>
            <h4>
            <?php 
            if (extension_loaded('pdo_sqlite')) {
                echo "OK";
            } else {
                echo "Please install the php5-sqlite extension and make sure it's enabled";
            }
            ?>
            </h4>
        </article>
        <article class="frontpage">
            <h2>Check if libxml is properly installed and loaded</h2>
            <h4>
            <?php 
            if (extension_loaded('libxml')) {
                echo "OK";
            } else {
                echo "Please make sure libxml is enabled";
            }
            ?>
            </h4>
        </article>
        <article class="frontpage">
            <h2>Check if the rendering will be done on client side or server side</h2>
            <h4>
            <?php 
            if (useServerSideRendering ()) {
                echo "Server side rendering";
            } else {
                echo "Client side rendering";
            }
            ?>
            </h4>
        </article>
<?php 
$i = 0;
foreach (Base::getDbList () as $name => $database) { 
?>
        <article class="frontpage">
            <h2>Check if Calibre database path is not an URL</h2>
            <h4>
            <?php
            if (!preg_match ("#^http#", $database)) {
                echo "OK";
            } else {
                echo "Calibre path has to be local (no URL allowed)";
            }
            ?>
            </h4>
        </article>
        <article class="frontpage">
            <h2>Check if Calibre database file exists and is readable</h2>
            <?php 
            if (is_readable (Base::getDbFileName ($i))) {
                echo "{$name} OK";
            } else {
                echo "{$name} File " . Base::getDbFileName ($i) . " not found, 
Please check 
<ul>
<li>Value of \$config['calibre_directory'] in config_local.php</li>
<li>Value of <a href='http://php.net/manual/en/ini.core.php#ini.open-basedir'>open_basedir</a> in your php.ini</li>
<li>The access rights of the Calibre Database</li>
<li>Synology users please read <a href='https://github.com/seblucas/cops/wiki/Howto---Synology'>this</a></li>
</ul>";
            }
            ?>
        </article>
        <article class="frontpage">
            <h2>Check if Calibre database file can be opened with PHP</h2>
            <h4>
            <?php 
            try {
                $db = new PDO('sqlite:'. Base::getDbFileName ($i));
                echo "{$name} OK";
            } catch (Exception $e) {
                echo "{$name} If the file is readable, check your php configuration. Exception detail : " . $e;
            }
            ?>
            </h4>
        </article>
        <article class="frontpage">
            <h2>Check if Calibre database file contains at least some of the needed tables</h2>
            <h4>
            <?php 
            try {
                $db = new PDO('sqlite:'. Base::getDbFileName ($i));
                $count = $db->query("select count(*) FROM sqlite_master WHERE type='table' AND name in ('books', 'authors', 'tags', 'series')")->fetchColumn();
                if ($count == 4) {
                    echo "{$name} OK";
                } else {
                    echo "{$name} Not all Calibre tables were found. Are you you're using the correct database.";
                }
            } catch (Exception $e) {
                echo "{$name} If the file is readable, check your php configuration. Exception detail : " . $e;
            }
            ?>
            </h4>
        </article>
<?php $i++; } ?>
    </section>
    <footer></footer>
</div>
</body>
</html>
-												Cleanly fix the problems with line feed

											
										
										
											2013-07-22 15:29:32 +03:00
+								<!DOCTYPE html>
 								<html xmlns="http://www.w3.org/1999/xhtml">
-												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
+								<?php
 								/**
 								 * COPS (Calibre OPDS PHP Server) Configuration check
 								 *
 								 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 								 * @author     S<EFBFBD>bastien Lucas <sebastien@slucas.fr>
 								 *
 								 */
 								    require_once ("config.php");
 								    require_once ("base.php");
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								    header ("Content-Type:text/html; charset=UTF-8");
-												Try to better explain why the user has been redirected

											
										
										
											2013-01-06 10:49:05 +02:00
 								    $err = getURLParam ("err", -1);
 								    $error = NULL;
 								    switch ($err) {
 								        case 1 :
 								            $error = "Database error";
 								            break;
 								    }
-												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
 								?>
 								<head>
-												Small fixes to UI again

											
										
										
											2013-05-16 18:22:21 +03:00
+								    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-												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
+								    <title>COPS Configuration Check</title>
-												Move the CSS to a specific directory. re #25

											
										
										
											2013-05-28 08:49:52 +03:00
+								    <link rel="stylesheet" type="text/css" href="<?php echo getUrlWithVersion(getCurrentCss ()) ?>" media="screen" />
-												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
+								</head>
 								<body>
 								<div class="container">
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								    <header>
-												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
+								        <div class="headcenter">
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								            <h1>COPS Configuration Check</h1>
-												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
+								        </div>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								    </header>
-												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
+								    <div id="content" style="display: none;"></div>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								    <section>
-												Try to better explain why the user has been redirected

											
										
										
											2013-01-06 10:49:05 +02:00
+								        <?php
 								        if (!is_null ($error)) {
 								        ?>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								        <article class="frontpage">
 								            <h2>You've been redirected because COPS is not configured properly</h2>
 								            <h4><?php echo $error ?></h4>
 								        </article>
-												Try to better explain why the user has been redirected

											
										
										
											2013-01-06 10:49:05 +02:00
+								        <?php
 								        }
 								        ?>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								        <article class="frontpage">
 								            <h2>Check if GD is properly installed and loaded</h2>
 								            <h4>
-												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
+								            <?php
 								            if (extension_loaded('gd') && function_exists('gd_info')) {
 								                echo "OK";
 								            } else {
 								                echo "Please install the php5-gd extension and make sure it's enabled";
 								            }
 								            ?>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								            </h4>
 								        </article>
 								        <article class="frontpage">
 								            <h2>Check if Sqlite is properly installed and loaded</h2>
 								            <h4>
-												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
+								            <?php
 								            if (extension_loaded('pdo_sqlite')) {
 								                echo "OK";
 								            } else {
 								                echo "Please install the php5-sqlite extension and make sure it's enabled";
 								            }
 								            ?>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								            </h4>
 								        </article>
 								        <article class="frontpage">
 								            <h2>Check if libxml is properly installed and loaded</h2>
 								            <h4>
-												Add a test for the presence of libxml (not really needed in most cases).

											
										
										
											2013-04-08 18:29:31 +03:00
+								            <?php
 								            if (extension_loaded('libxml')) {
 								                echo "OK";
 								            } else {
 								                echo "Please make sure libxml is enabled";
 								            }
 								            ?>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								            </h4>
 								        </article>
-												Add a checkconfig test to show which rendering engine is used.

											
										
										
											2013-09-03 15:30:57 +03:00
+								        <article class="frontpage">
 								            <h2>Check if the rendering will be done on client side or server side</h2>
 								            <h4>
 								            <?php
 								            if (useServerSideRendering ()) {
 								                echo "Server side rendering";
 								            } else {
 								                echo "Client side rendering";
 								            }
 								            ?>
 								            </h4>
 								        </article>
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								<?php
 								$i = 0;
 								foreach (Base::getDbList () as $name => $database) {
 								?>
-												Add a check for calibre path : it has to be local.

											
										
										
											2013-06-26 22:36:25 +03:00
+								        <article class="frontpage">
 								            <h2>Check if Calibre database path is not an URL</h2>
 								            <h4>
 								            <?php
 								            if (!preg_match ("#^http#", $database)) {
 								                echo "OK";
 								            } else {
 								                echo "Calibre path has to be local (no URL allowed)";
 								            }
 								            ?>
 								            </h4>
 								        </article>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								        <article class="frontpage">
 								            <h2>Check if Calibre database file exists and is readable</h2>
-												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
+								            <?php
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								            if (is_readable (Base::getDbFileName ($i))) {
 								                echo "{$name} OK";
-												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
+								            } else {
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								                echo "{$name} File " . Base::getDbFileName ($i) . " not found,
-												Add better explaination if wrong Calibre path is provided

											
										
										
											2013-01-20 16:13:43 +02:00
+								Please check
 								<ul>
 								<li>Value of \$config['calibre_directory'] in config_local.php</li>
 								<li>Value of <a href='http://php.net/manual/en/ini.core.php#ini.open-basedir'>open_basedir</a> in your php.ini</li>
 								<li>The access rights of the Calibre Database</li>
 								<li>Synology users please read <a href='https://github.com/seblucas/cops/wiki/Howto---Synology'>this</a></li>
 								</ul>";
-												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
+								            }
 								            ?>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								        </article>
 								        <article class="frontpage">
 								            <h2>Check if Calibre database file can be opened with PHP</h2>
 								            <h4>
-												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
+								            <?php
 								            try {
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								                $db = new PDO('sqlite:'. Base::getDbFileName ($i));
 								                echo "{$name} OK";
-												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
+								            } catch (Exception $e) {
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								                echo "{$name} If the file is readable, check your php configuration. Exception detail : " . $e;
-												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
+								            }
 								            ?>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								            </h4>
 								        </article>
 								        <article class="frontpage">
 								            <h2>Check if Calibre database file contains at least some of the needed tables</h2>
 								            <h4>
-												Add another test in checkconfig to check if the database contains at least some table from Calibre.

											
										
										
											2013-03-19 22:11:10 +02:00
+								            <?php
 								            try {
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								                $db = new PDO('sqlite:'. Base::getDbFileName ($i));
-												Add another test in checkconfig to check if the database contains at least some table from Calibre.

											
										
										
											2013-03-19 22:11:10 +02:00
+								                $count = $db->query("select count(*) FROM sqlite_master WHERE type='table' AND name in ('books', 'authors', 'tags', 'series')")->fetchColumn();
 								                if ($count == 4) {
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								                    echo "{$name} OK";
-												Add another test in checkconfig to check if the database contains at least some table from Calibre.

											
										
										
											2013-03-19 22:11:10 +02:00
+								                } else {
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								                    echo "{$name} Not all Calibre tables were found. Are you you're using the correct database.";
-												Add another test in checkconfig to check if the database contains at least some table from Calibre.

											
										
										
											2013-03-19 22:11:10 +02:00
+								                }
 								            } catch (Exception $e) {
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								                echo "{$name} If the file is readable, check your php configuration. Exception detail : " . $e;
-												Add another test in checkconfig to check if the database contains at least some table from Calibre.

											
										
										
											2013-03-19 22:11:10 +02:00
+								            }
 								            ?>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								            </h4>
 								        </article>
-												Checkconfig can now handle multi database. re #40

											
										
										
											2013-04-04 21:53:44 +03:00
+								<?php $i++; } ?>
-												Almost fixed checkconfig.

											
										
										
											2013-05-16 15:41:24 +03:00
+								    </section>
-												Add a footer.

											
										
										
											2013-05-16 15:42:56 +03:00
+								    <footer></footer>
-												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
+								</div>
 								</body>
-												Cleanly fix the problems with line feed

											
										
										
											2013-07-22 15:29:32 +03:00
+								</html>