We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

install.php 13.7 KB
Newer Older
1 2
<?php
/**
3 4
 * StatusNet - a distributed open-source microblogging tool
 * Copyright (C) 2009, StatusNet, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

20 21
define('INSTALLDIR', dirname(__FILE__));

Evan Prodromou's avatar
Evan Prodromou committed
22 23
function main()
{
24 25 26 27 28
    if (!checkPrereqs())
    {
        return;
    }

Evan Prodromou's avatar
Evan Prodromou committed
29 30 31 32 33 34 35
    if ($_SERVER['REQUEST_METHOD'] == 'POST') {
        handlePost();
    } else {
        showForm();
    }
}

36 37
function checkPrereqs()
{
38
	$pass = true;
39

40 41
    if (file_exists(INSTALLDIR.'/config.php')) {
         ?><p class="error">Config file &quot;config.php&quot; already exists.</p>
42
         <?php
43
        $pass = false;
44 45
    }

Craig Andrews's avatar
Craig Andrews committed
46 47
    if (version_compare(PHP_VERSION, '5.2.3', '<')) {
            ?><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 54 55

    foreach ($reqs as $req) {
        if (!checkExtension($req)) {
Sarven Capadisli's avatar
Sarven Capadisli committed
56
            ?><p class="error">Cannot load required extension: <code><?php echo $req; ?></code></p><?php
57
		    $pass = false;
58 59
        }
    }
60
    if (!checkExtension('pgsql') && !checkExtension('mysql')) {
Brenda Wallace's avatar
Brenda Wallace committed
61
      ?><p class="error">Cannot find mysql or pgsql extension. You need one or the other: <code><?php echo $req; ?></code></p><?php
62 63
                    $pass = false;
    }
64 65

	if (!is_writable(INSTALLDIR)) {
Sarven Capadisli's avatar
Sarven Capadisli committed
66 67
         ?><p class="error">Cannot write config file to: <code><?php echo INSTALLDIR; ?></code></p>
	       <p>On your server, try this command: <code>chmod a+w <?php echo INSTALLDIR; ?></code>
68
         <?php
69
	     $pass = false;
70 71
	}

72 73 74 75 76 77 78
	// Check the subdirs used for file uploads
	$fileSubdirs = array('avatar', 'background', 'file');
	foreach ($fileSubdirs as $fileSubdir) {
		$fileFullPath = INSTALLDIR."/$fileSubdir/";
		if (!is_writable($fileFullPath)) {
    	     ?><p class="error">Cannot write <?php echo $fileSubdir; ?> directory: <code><?php echo $fileFullPath; ?></code></p>
		       <p>On your server, try this command: <code>chmod a+w <?php echo $fileFullPath; ?></code></p>
Tom Adams's avatar
Tom Adams committed
79
	     <?php
80 81
		     $pass = false;
		}
82
	}
83

84
	return $pass;
85 86 87 88 89 90 91 92 93 94
}

function checkExtension($name)
{
    if (!extension_loaded($name)) {
        if (!dl($name.'.so')) {
            return false;
        }
    }
    return true;
95 96
}

Evan Prodromou's avatar
Evan Prodromou committed
97 98
function showForm()
{
99
    echo<<<E_O_T
Sarven Capadisli's avatar
Sarven Capadisli committed
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
        </ul>
    </dd>
</dl>
<dl id="page_notice" class="system_notice">
    <dt>Page notice</dt>
    <dd>
        <div class="instructions">
            <p>Enter your database connection information below to initialize the database.</p>
        </div>
    </dd>
</dl>
<form method="post" action="install.php" class="form_settings" id="form_install">
    <fieldset>
        <legend>Connection settings</legend>
        <ul class="form_data">
            <li>
                <label for="sitename">Site name</label>
                <input type="text" id="sitename" name="sitename" />
                <p class="form_guide">The name of your site</p>
            </li>
            <li>
121 122 123 124 125
                <label for="fancy-enable">Fancy URLs</label>
                <input type="radio" name="fancy" id="fancy-enable" value="enable" checked='checked' /> enable<br />
                <input type="radio" name="fancy" id="fancy-disable" value="" /> disable<br />
                <p class="form_guide" id='fancy-form_guide'>Enable fancy (pretty) URLs. Auto-detection failed, it depends on Javascript.</p>
            </li>
126 127 128 129 130
            <li>
                <label for="host">Hostname</label>
                <input type="text" id="host" name="host" />
                <p class="form_guide">Database hostname</p>
            </li>
Sarven Capadisli's avatar
Sarven Capadisli committed
131
            <li>
132
            
133
                <label for="dbtype">Type</label>
134 135
                <input type="radio" name="dbtype" id="fancy-mysql" value="mysql" checked='checked' /> MySQL<br />
                <input type="radio" name="dbtype" id="dbtype-pgsql" value="pgsql" /> PostgreSQL<br />
136
                <p class="form_guide">Database type</p>
137
            </li>
138

Sarven Capadisli's avatar
Sarven Capadisli committed
139
            <li>
140
                <label for="database">Name</label>
Sarven Capadisli's avatar
Sarven Capadisli committed
141 142 143 144 145 146 147 148 149 150 151
                <input type="text" id="database" name="database" />
                <p class="form_guide">Database name</p>
            </li>
            <li>
                <label for="username">Username</label>
                <input type="text" id="username" name="username" />
                <p class="form_guide">Database username</p>
            </li>
            <li>
                <label for="password">Password</label>
                <input type="password" id="password" name="password" />
152
                <p class="form_guide">Database password (optional)</p>
Sarven Capadisli's avatar
Sarven Capadisli committed
153 154 155 156
            </li>
        </ul>
        <input type="submit" name="submit" class="submit" value="Submit" />
    </fieldset>
Evan Prodromou's avatar
Evan Prodromou committed
157
</form>
158 159

E_O_T;
Evan Prodromou's avatar
Evan Prodromou committed
160 161
}

162 163 164
function updateStatus($status, $error=false)
{
?>
Tom Adams's avatar
Tom Adams committed
165
                <li <?php echo ($error) ? 'class="error"': ''; ?>><?php echo $status;?></li>
Sarven Capadisli's avatar
Sarven Capadisli committed
166 167

<?php
168 169
}

Evan Prodromou's avatar
Evan Prodromou committed
170 171
function handlePost()
{
172
?>
Sarven Capadisli's avatar
Sarven Capadisli committed
173 174

<?php
175
    $host     = $_POST['host'];
176
    $dbtype   = $_POST['dbtype'];
177 178 179 180
    $database = $_POST['database'];
    $username = $_POST['username'];
    $password = $_POST['password'];
    $sitename = $_POST['sitename'];
181
    $fancy    = !empty($_POST['fancy']);
182 183 184
    $server = $_SERVER['HTTP_HOST'];
    $path = substr(dirname($_SERVER['PHP_SELF']), 1);
    
Sarven Capadisli's avatar
Sarven Capadisli committed
185 186 187 188 189 190
?>
    <dl class="system_notice">
        <dt>Page notice</dt>
        <dd>
            <ul>
<?php
191
	$fail = false;
192

Evan Prodromou's avatar
Evan Prodromou committed
193 194
    if (empty($host)) {
        updateStatus("No hostname specified.", true);
195
		$fail = true;
Evan Prodromou's avatar
Evan Prodromou committed
196 197 198 199
    }

    if (empty($database)) {
        updateStatus("No database specified.", true);
200
		$fail = true;
Evan Prodromou's avatar
Evan Prodromou committed
201 202 203 204
    }

    if (empty($username)) {
        updateStatus("No username specified.", true);
205
		$fail = true;
Evan Prodromou's avatar
Evan Prodromou committed
206 207
    }

Brenda Wallace's avatar
Brenda Wallace committed
208 209 210 211
//     if (empty($password)) {
//         updateStatus("No password specified.", true);
// 		$fail = true;
//     }
Evan Prodromou's avatar
Evan Prodromou committed
212 213 214

    if (empty($sitename)) {
        updateStatus("No sitename specified.", true);
215
		$fail = true;
Evan Prodromou's avatar
Evan Prodromou committed
216 217
    }

Brenda Wallace's avatar
Brenda Wallace committed
218
    if($fail){
219
            showForm();
220 221
        return;
    }
Brenda Wallace's avatar
Brenda Wallace committed
222
    
223
    switch($dbtype) {
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
        case 'mysql':
            $db = mysql_db_installer($host, $database, $username, $password);
            break;
        case 'pgsql':
            $db = pgsql_db_installer($host, $database, $username, $password);
            break;
        default:
    }
    
    if (!$db) {
        // database connection failed, do not move on to create config file.
        return false;
    }
    
    updateStatus("Writing config file...");
    $res = writeConf($sitename, $server, $path, $fancy, $db);
    
    if (!$res) {
        updateStatus("Can't write config file.", true);
        showForm();
        return;
Evan Prodromou's avatar
Evan Prodromou committed
245
    }
246 247 248 249 250 251
    
    /*
        TODO https needs to be considered
    */
    $link = "http://".$server.'/'.$path;
    
252 253
    updateStatus("StatusNet has been installed at $link");
    updateStatus("You can visit your <a href='$link'>new StatusNet site</a>.");
254
?>
Sarven Capadisli's avatar
Sarven Capadisli committed
255 256

<?php
257 258
}

259
function pgsql_db_installer($host, $database, $username, $password) {
Brenda Wallace's avatar
Brenda Wallace committed
260
  $connstring = "dbname=$database host=$host user=$username";
261

Brenda Wallace's avatar
Brenda Wallace committed
262 263 264 265 266 267 268
  //No password would mean trust authentication used.
  if (!empty($password)) {
    $connstring .= " password=$password";
  }
  updateStatus("Starting installation...");
  updateStatus("Checking database...");
  $conn = pg_connect($connstring);
269 270 271 272 273 274
  
  if ($conn ===false) {
    updateStatus("Failed to connect to database: $connstring");
    showForm();
    return false;
  }
Brenda Wallace's avatar
Brenda Wallace committed
275

276 277 278
  //ensure database encoding is UTF8
  $record = pg_fetch_object(pg_query($conn, 'SHOW server_encoding'));
  if ($record->server_encoding != 'UTF8') {
279
    updateStatus("StatusNet requires UTF8 character encoding. Your database is ". htmlentities($record->server_encoding));
280 281 282 283
    showForm();
    return false;
  }

284 285 286 287 288 289 290 291
  updateStatus("Running database script...");
  //wrap in transaction;
  pg_query($conn, 'BEGIN');
  $res = runDbScript(INSTALLDIR.'/db/laconica_pg.sql', $conn, 'pgsql');
  
  if ($res === false) {
      updateStatus("Can't run database script.", true);
      showForm();
292
      return false;
293 294 295 296 297 298 299 300 301 302
  }
  foreach (array('sms_carrier' => 'SMS carrier',
                'notice_source' => 'notice source',
                'foreign_services' => 'foreign service')
          as $scr => $name) {
      updateStatus(sprintf("Adding %s data to database...", $name));
      $res = runDbScript(INSTALLDIR.'/db/'.$scr.'.sql', $conn, 'pgsql');
      if ($res === false) {
          updateStatus(sprintf("Can't run %d script.", $name), true);
          showForm();
303
          return false;
304 305 306 307 308 309 310 311 312 313
      }
  }
  pg_query($conn, 'COMMIT');

  if (empty($password)) {
    $sqlUrl = "pgsql://$username@$host/$database";
  }
  else {
    $sqlUrl = "pgsql://$username:$password@$host/$database";
  }
314 315 316 317
  
  $db = array('type' => 'pgsql', 'database' => $sqlUrl);
  
  return $db;
Brenda Wallace's avatar
Brenda Wallace committed
318 319
}

320
function mysql_db_installer($host, $database, $username, $password) {
Brenda Wallace's avatar
Brenda Wallace committed
321 322 323 324 325 326 327
  updateStatus("Starting installation...");
  updateStatus("Checking database...");

  $conn = mysql_connect($host, $username, $password);
  if (!$conn) {
      updateStatus("Can't connect to server '$host' as '$username'.", true);
      showForm();
328
      return false;
Brenda Wallace's avatar
Brenda Wallace committed
329 330 331 332 333 334
  }
  updateStatus("Changing to database...");
  $res = mysql_select_db($database, $conn);
  if (!$res) {
      updateStatus("Can't change to database.", true);
      showForm();
335
      return false;
Brenda Wallace's avatar
Brenda Wallace committed
336 337 338 339 340 341
  }
  updateStatus("Running database script...");
  $res = runDbScript(INSTALLDIR.'/db/laconica.sql', $conn);
  if ($res === false) {
      updateStatus("Can't run database script.", true);
      showForm();
342
      return false;
Brenda Wallace's avatar
Brenda Wallace committed
343 344 345 346 347 348 349
  }
  foreach (array('sms_carrier' => 'SMS carrier',
                'notice_source' => 'notice source',
                'foreign_services' => 'foreign service')
          as $scr => $name) {
      updateStatus(sprintf("Adding %s data to database...", $name));
      $res = runDbScript(INSTALLDIR.'/db/'.$scr.'.sql', $conn);
350
      if ($res === false) {
Brenda Wallace's avatar
Brenda Wallace committed
351
          updateStatus(sprintf("Can't run %d script.", $name), true);
352
          showForm();
353
          return false;
354
      }
Brenda Wallace's avatar
Brenda Wallace committed
355
  }
356 357
      
      $sqlUrl = "mysqli://$username:$password@$host/$database";
358 359 360 361 362
      $db = array('type' => 'mysql', 'database' => $sqlUrl);
      return $db;
}

function writeConf($sitename, $server, $path, $fancy, $db)
363
{
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
    // assemble configuration file in a string
    $cfg =  "<?php\n".
            "if (!defined('LACONICA')) { exit(1); }\n\n".
            
            // site name
            "\$config['site']['name'] = '$sitename';\n\n".
            
            // site location
            "\$config['site']['server'] = '$server';\n".
            "\$config['site']['path'] = '$path'; \n\n".
            
            // checks if fancy URLs are enabled
            ($fancy ? "\$config['site']['fancy'] = true;\n\n":'').
            
            // database
            "\$config['db']['database'] = '{$db['database']}';\n\n".
Brett Taylor's avatar
Brett Taylor committed
380
            ($db['type'] == 'pgsql' ? "\$config['db']['quote_identifiers'] = true;\n\n":'').
381 382 383 384 385 386
            "\$config['db']['type'] = '{$db['type']}';\n\n".
            
            "?>";
    // write configuration file out to install directory
    $res = file_put_contents(INSTALLDIR.'/config.php', $cfg);

387
    return $res;
Evan Prodromou's avatar
Evan Prodromou committed
388
}
389

390
function runDbScript($filename, $conn, $type = 'mysql')
391 392 393 394 395 396 397 398
{
    $sql = trim(file_get_contents($filename));
    $stmts = explode(';', $sql);
    foreach ($stmts as $stmt) {
        $stmt = trim($stmt);
        if (!mb_strlen($stmt)) {
            continue;
        }
399 400 401 402 403 404 405 406 407
        switch ($type) {
        case 'mysql':
            $res = mysql_query($stmt, $conn);
            break;
        case 'pgsql':
            $res = pg_query($conn, $stmt);
            break;
        default:
            updateStatus("runDbScript() error: unknown database type ". $type ." provided.");
408
        }
409
        if ($res === false) {
410
            updateStatus("FAILED SQL: $stmt");
411 412 413 414 415 416
            return $res;
        }
    }
    return true;
}

Evan Prodromou's avatar
Evan Prodromou committed
417
?>
Sarven Capadisli's avatar
Sarven Capadisli committed
418
<?php echo"<?"; ?> xml version="1.0" encoding="UTF-8" <?php echo "?>"; ?>
419
<!DOCTYPE html>
Sarven Capadisli's avatar
Sarven Capadisli committed
420 421
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
    <head>
422
        <title>Install StatusNet</title>
423
	<link rel="shortcut icon" href="favicon.ico"/>
Sarven Capadisli's avatar
Sarven Capadisli committed
424 425 426
        <link rel="stylesheet" type="text/css" href="theme/default/css/display.css?version=0.8" media="screen, projection, tv"/>
        <!--[if IE]><link rel="stylesheet" type="text/css" href="theme/base/css/ie.css?version=0.8" /><![endif]-->
        <!--[if lte IE 6]><link rel="stylesheet" type="text/css" theme/base/css/ie6.css?version=0.8" /><![endif]-->
427 428 429
        <!--[if IE]><link rel="stylesheet" type="text/css" href="theme/default/css/ie.css?version=0.8" /><![endif]-->
        <script src="js/jquery.min.js"></script>
        <script src="js/install.js"></script>
Sarven Capadisli's avatar
Sarven Capadisli committed
430 431 432 433 434 435
    </head>
    <body id="install">
        <div id="wrap">
            <div id="header">
                <address id="site_contact" class="vcard">
                    <a class="url home bookmark" href=".">
436 437
                        <img class="logo photo" src="theme/default/logo.png" alt="StatusNet"/>
                        <span class="fn org">StatusNet</span>
Sarven Capadisli's avatar
Sarven Capadisli committed
438 439 440 441 442
                    </a>
                </address>
            </div>
            <div id="core">
                <div id="content">
443
                    <h1>Install StatusNet</h1>
444
<?php main(); ?>
Sarven Capadisli's avatar
Sarven Capadisli committed
445 446 447 448
                </div>
            </div>
        </div>
    </body>
449
</html>