install.php

   1 <?php
   2 /**
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2009, Control Yourself, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 define('INSTALLDIR', dirname(__FILE__));
  21
  22 function main()
  23 {
  24     if (!checkPrereqs())
  25     {
  26         return;
  27     }
  28
  29     if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  30         handlePost();
  31     } else {
  32         showForm();
  33     }
  34 }
  35
  36 function checkPrereqs()
  37 {
  38         $pass = true;
  39
  40     if (file_exists(INSTALLDIR.'/config.php')) {
  41          ?><p class="error">Config file &quot;config.php&quot; already exists.</p>
  42          <?php
  43         $pass = false;
  44     }
  45
  46     if (version_compare(PHP_VERSION, '5.2.3', '<')) {
  47             ?><p class="error">Require PHP version 5.2.3 or greater.</p><?php
  48                     $pass = false;
  49     }
  50
  51     $reqs = array('gd', 'curl',
  52                   'xmlwriter', 'mbstring',
  53                   'gettext');
  54
  55     foreach ($reqs as $req) {
  56         if (!checkExtension($req)) {
  57             ?><p class="error">Cannot load required extension: <code><?php echo $req; ?></code></p><?php
  58                     $pass = false;
  59         }
  60     }
  61     if (!checkExtension('pgsql') && !checkExtension('mysql')) {
  62       ?><p class="error">Cannot find mysql or pgsql extension. You need one or the other: <code><?php echo $req; ?></code></p><?php
  63                     $pass = false;
  64     }
  65
  66         if (!is_writable(INSTALLDIR)) {
  67          ?><p class="error">Cannot write config file to: <code><?php echo INSTALLDIR; ?></code></p>
  68                <p>On your server, try this command: <code>chmod a+w <?php echo INSTALLDIR; ?></code>
  69          <?php
  70              $pass = false;
  71         }
  72
  73         // Check the subdirs used for file uploads
  74         $fileSubdirs = array('avatar', 'background', 'file');
  75         foreach ($fileSubdirs as $fileSubdir) {
  76                 $fileFullPath = INSTALLDIR."/$fileSubdir/";
  77                 if (!is_writable($fileFullPath)) {
  78              ?><p class="error">Cannot write <?php echo $fileSubdir; ?> directory: <code><?php echo $fileFullPath; ?></code></p>
  79                        <p>On your server, try this command: <code>chmod a+w <?php echo $fileFullPath; ?></code></p>
  80              <?php
  81                      $pass = false;
  82                 }
  83         }
  84
  85         return $pass;
  86 }
  87
  88 function checkExtension($name)
  89 {
  90     if (!extension_loaded($name)) {
  91         if (!dl($name.'.so')) {
  92             return false;
  93         }
  94     }
  95     return true;
  96 }
  97
  98 function showForm()
  99 {
 100     echo<<<E_O_T
 101         </ul>
 102     </dd>
 103 </dl>
 104 <dl id="page_notice" class="system_notice">
 105     <dt>Page notice</dt>
 106     <dd>
 107         <div class="instructions">
 108             <p>Enter your database connection information below to initialize the database.</p>
 109         </div>
 110     </dd>
 111 </dl>
 112 <form method="post" action="install.php" class="form_settings" id="form_install">
 113     <fieldset>
 114         <legend>Connection settings</legend>
 115         <ul class="form_data">
 116             <li>
 117                 <label for="sitename">Site name</label>
 118                 <input type="text" id="sitename" name="sitename" />
 119                 <p class="form_guide">The name of your site</p>
 120             </li>
 121             <li>
 122                 <label for="fancy-enable">Fancy URLs</label>
 123                 <input type="radio" name="fancy" id="fancy-enable" value="enable" checked='checked' /> enable<br />
 124                 <input type="radio" name="fancy" id="fancy-disable" value="" /> disable<br />
 125                 <p class="form_guide" id='fancy-form_guide'>Enable fancy (pretty) URLs. Auto-detection failed, it depends on Javascript.</p>
 126             </li>
 127             <li>
 128                 <label for="host">Hostname</label>
 129                 <input type="text" id="host" name="host" />
 130                 <p class="form_guide">Database hostname</p>
 131             </li>
 132             <li>
 133
 134                 <label for="dbtype">Type</label>
 135                 <input type="radio" name="dbtype" id="fancy-mysql" value="mysql" checked='checked' /> MySQL<br />
 136                 <input type="radio" name="dbtype" id="dbtype-pgsql" value="pgsql" /> PostgreSQL<br />
 137                 <p class="form_guide">Database type</p>
 138             </li>
 139
 140             <li>
 141                 <label for="database">Name</label>
 142                 <input type="text" id="database" name="database" />
 143                 <p class="form_guide">Database name</p>
 144             </li>
 145             <li>
 146                 <label for="username">Username</label>
 147                 <input type="text" id="username" name="username" />
 148                 <p class="form_guide">Database username</p>
 149             </li>
 150             <li>
 151                 <label for="password">Password</label>
 152                 <input type="password" id="password" name="password" />
 153                 <p class="form_guide">Database password (optional)</p>
 154             </li>
 155         </ul>
 156         <input type="submit" name="submit" class="submit" value="Submit" />
 157     </fieldset>
 158 </form>
 159
 160 E_O_T;
 161 }
 162
 163 function updateStatus($status, $error=false)
 164 {
 165 ?>
 166                 <li <?php echo ($error) ? 'class="error"': ''; ?>><?php echo $status;?></li>
 167
 168 <?php
 169 }
 170
 171 function handlePost()
 172 {
 173 ?>
 174
 175 <?php
 176     $host     = $_POST['host'];
 177     $dbtype   = $_POST['dbtype'];
 178     $database = $_POST['database'];
 179     $username = $_POST['username'];
 180     $password = $_POST['password'];
 181     $sitename = $_POST['sitename'];
 182     $fancy    = !empty($_POST['fancy']);
 183 ?>
 184     <dl class="system_notice">
 185         <dt>Page notice</dt>
 186         <dd>
 187             <ul>
 188 <?php
 189         $fail = false;
 190
 191     if (empty($host)) {
 192         updateStatus("No hostname specified.", true);
 193                 $fail = true;
 194     }
 195
 196     if (empty($database)) {
 197         updateStatus("No database specified.", true);
 198                 $fail = true;
 199     }
 200
 201     if (empty($username)) {
 202         updateStatus("No username specified.", true);
 203                 $fail = true;
 204     }
 205
 206 //     if (empty($password)) {
 207 //         updateStatus("No password specified.", true);
 208 //              $fail = true;
 209 //     }
 210
 211     if (empty($sitename)) {
 212         updateStatus("No sitename specified.", true);
 213                 $fail = true;
 214     }
 215
 216     if($fail){
 217             showForm();
 218         return;
 219     }
 220
 221     switch($dbtype) {
 222       case 'mysql':    mysql_db_installer($host, $database, $username, $password, $sitename, $fancy);
 223       break;
 224       case 'pgsql':    pgsql_db_installer($host, $database, $username, $password, $sitename, $fancy);
 225       break;
 226       default:
 227     }
 228     if ($path) $path .= '/';
 229     updateStatus("You can visit your <a href='/$path'>new Laconica site</a>.");
 230 ?>
 231
 232 <?php
 233 }
 234
 235 function pgsql_db_installer($host, $database, $username, $password, $sitename, $fancy) {
 236   $connstring = "dbname=$database host=$host user=$username";
 237
 238   //No password would mean trust authentication used.
 239   if (!empty($password)) {
 240     $connstring .= " password=$password";
 241   }
 242   updateStatus("Starting installation...");
 243   updateStatus("Checking database...");
 244   $conn = pg_connect($connstring);
 245
 246   if ($conn ===false) {
 247     updateStatus("Failed to connect to database: $connstring");
 248     showForm();
 249     return false;
 250   }
 251
 252   //ensure database encoding is UTF8
 253   $record = pg_fetch_object(pg_query($conn, 'SHOW server_encoding'));
 254   if ($record->server_encoding != 'UTF8') {
 255     updateStatus("Laconica requires UTF8 character encoding. Your database is ". htmlentities($record->server_encoding));
 256     showForm();
 257     return false;
 258   }
 259
 260   updateStatus("Running database script...");
 261   //wrap in transaction;
 262   pg_query($conn, 'BEGIN');
 263   $res = runDbScript(INSTALLDIR.'/db/laconica_pg.sql', $conn, 'pgsql');
 264
 265   if ($res === false) {
 266       updateStatus("Can't run database script.", true);
 267       showForm();
 268       return;
 269   }
 270   foreach (array('sms_carrier' => 'SMS carrier',
 271                 'notice_source' => 'notice source',
 272                 'foreign_services' => 'foreign service')
 273           as $scr => $name) {
 274       updateStatus(sprintf("Adding %s data to database...", $name));
 275       $res = runDbScript(INSTALLDIR.'/db/'.$scr.'.sql', $conn, 'pgsql');
 276       if ($res === false) {
 277           updateStatus(sprintf("Can't run %d script.", $name), true);
 278           showForm();
 279           return;
 280       }
 281   }
 282   pg_query($conn, 'COMMIT');
 283
 284   updateStatus("Writing config file...");
 285   if (empty($password)) {
 286     $sqlUrl = "pgsql://$username@$host/$database";
 287   }
 288   else {
 289     $sqlUrl = "pgsql://$username:$password@$host/$database";
 290   }
 291   $res = writeConf($sitename, $sqlUrl, $fancy, 'pgsql');
 292   if (!$res) {
 293       updateStatus("Can't write config file.", true);
 294       showForm();
 295       return;
 296   }
 297   updateStatus("Done!");
 298
 299 }
 300
 301 function mysql_db_installer($host, $database, $username, $password, $sitename, $fancy) {
 302   updateStatus("Starting installation...");
 303   updateStatus("Checking database...");
 304
 305   $conn = mysql_connect($host, $username, $password);
 306   if (!$conn) {
 307       updateStatus("Can't connect to server '$host' as '$username'.", true);
 308       showForm();
 309       return;
 310   }
 311   updateStatus("Changing to database...");
 312   $res = mysql_select_db($database, $conn);
 313   if (!$res) {
 314       updateStatus("Can't change to database.", true);
 315       showForm();
 316       return;
 317   }
 318   updateStatus("Running database script...");
 319   $res = runDbScript(INSTALLDIR.'/db/laconica.sql', $conn);
 320   if ($res === false) {
 321       updateStatus("Can't run database script.", true);
 322       showForm();
 323       return;
 324   }
 325   foreach (array('sms_carrier' => 'SMS carrier',
 326                 'notice_source' => 'notice source',
 327                 'foreign_services' => 'foreign service')
 328           as $scr => $name) {
 329       updateStatus(sprintf("Adding %s data to database...", $name));
 330       $res = runDbScript(INSTALLDIR.'/db/'.$scr.'.sql', $conn);
 331       if ($res === false) {
 332           updateStatus(sprintf("Can't run %d script.", $name), true);
 333           showForm();
 334           return;
 335       }
 336   }
 337
 338       updateStatus("Writing config file...");
 339       $sqlUrl = "mysqli://$username:$password@$host/$database";
 340       $res = writeConf($sitename, $sqlUrl, $fancy);
 341       if (!$res) {
 342           updateStatus("Can't write config file.", true);
 343           showForm();
 344           return;
 345       }
 346       updateStatus("Done!");
 347     }
 348 function writeConf($sitename, $sqlUrl, $fancy, $type='mysql')
 349 {
 350     $res = file_put_contents(INSTALLDIR.'/config.php',
 351                              "<?php\n".
 352                              "if (!defined('LACONICA')) { exit(1); }\n\n".
 353                              "\$config['site']['name'] = \"$sitename\";\n\n".
 354                              ($fancy ? "\$config['site']['fancy'] = true;\n\n":'').
 355                              "\$config['db']['database'] = \"$sqlUrl\";\n\n".
 356                              ($type == 'pgsql' ? "\$config['db']['quote_identifiers'] = true;\n\n" .
 357                              "\$config['db']['type'] = \"$type\";\n\n" : '').
 358                              "?>");
 359     return $res;
 360 }
 361
 362 function runDbScript($filename, $conn, $type='mysql')
 363 {
 364     $sql = trim(file_get_contents($filename));
 365     $stmts = explode(';', $sql);
 366     foreach ($stmts as $stmt) {
 367         $stmt = trim($stmt);
 368         if (!mb_strlen($stmt)) {
 369             continue;
 370         }
 371         if ($type == 'mysql') {
 372           $res = mysql_query($stmt, $conn);
 373         } elseif ($type=='pgsql') {
 374           $res = pg_query($conn, $stmt);
 375         }
 376         if ($res === false) {
 377             updateStatus("FAILED SQL: $stmt");
 378             return $res;
 379         }
 380     }
 381     return true;
 382 }
 383
 384 ?>
 385 <?php echo"<?"; ?> xml version="1.0" encoding="UTF-8" <?php echo "?>"; ?>
 386 <!DOCTYPE html>
 387 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
 388     <head>
 389         <title>Install Laconica</title>
 390         <link rel="shortcut icon" href="favicon.ico"/>
 391         <link rel="stylesheet" type="text/css" href="theme/default/css/display.css?version=0.8" media="screen, projection, tv"/>
 392         <!--[if IE]><link rel="stylesheet" type="text/css" href="theme/base/css/ie.css?version=0.8" /><![endif]-->
 393         <!--[if lte IE 6]><link rel="stylesheet" type="text/css" theme/base/css/ie6.css?version=0.8" /><![endif]-->
 394         <!--[if IE]><link rel="stylesheet" type="text/css" href="theme/default/css/ie.css?version=0.8" /><![endif]-->
 395         <script src="js/jquery.min.js"></script>
 396         <script src="js/install.js"></script>
 397     </head>
 398     <body id="install">
 399         <div id="wrap">
 400             <div id="header">
 401                 <address id="site_contact" class="vcard">
 402                     <a class="url home bookmark" href=".">
 403                         <img class="logo photo" src="theme/default/logo.png" alt="Laconica"/>
 404                         <span class="fn org">Laconica</span>
 405                     </a>
 406                 </address>
 407             </div>
 408             <div id="core">
 409                 <div id="content">
 410                     <h1>Install Laconica</h1>
 411 <?php main(); ?>
 412                 </div>
 413             </div>
 414         </div>
 415     </body>
 416 </html>