3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009, StatusNet, Inc.
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.
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.
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/>.
20 define('INSTALLDIR', dirname(__FILE__));
29 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
36 function checkPrereqs()
40 if (file_exists(INSTALLDIR.'/config.php')) {
41 ?><p class="error">Config file "config.php" already exists.</p>
46 if (version_compare(PHP_VERSION, '5.2.3', '<')) {
47 ?><p class="error">Require PHP version 5.2.3 or greater.</p><?php
51 $reqs = array('gd', 'curl',
52 'xmlwriter', 'mbstring');
54 foreach ($reqs as $req) {
55 if (!checkExtension($req)) {
56 ?><p class="error">Cannot load required extension: <code><?php echo $req; ?></code></p><?php
60 if (!checkExtension('pgsql') && !checkExtension('mysql')) {
61 ?><p class="error">Cannot find mysql or pgsql extension. You need one or the other: <code><?php echo $req; ?></code></p><?php
65 if (!is_writable(INSTALLDIR)) {
66 ?><p class="error">Cannot write config file to: <code><?php echo INSTALLDIR; ?></code></p>
67 <p>On your server, try this command: <code>chmod a+w <?php echo INSTALLDIR; ?></code>
72 // Check the subdirs used for file uploads
73 $fileSubdirs = array('avatar', 'background', 'file');
74 foreach ($fileSubdirs as $fileSubdir) {
75 $fileFullPath = INSTALLDIR."/$fileSubdir/";
76 if (!is_writable($fileFullPath)) {
77 ?><p class="error">Cannot write <?php echo $fileSubdir; ?> directory: <code><?php echo $fileFullPath; ?></code></p>
78 <p>On your server, try this command: <code>chmod a+w <?php echo $fileFullPath; ?></code></p>
87 function checkExtension($name)
89 if (!extension_loaded($name)) {
90 if (!@dl($name.'.so')) {
103 <dl id="page_notice" class="system_notice">
106 <div class="instructions">
107 <p>Enter your database connection information below to initialize the database.</p>
111 <form method="post" action="install.php" class="form_settings" id="form_install">
113 <legend>Connection settings</legend>
114 <ul class="form_data">
116 <label for="sitename">Site name</label>
117 <input type="text" id="sitename" name="sitename" />
118 <p class="form_guide">The name of your site</p>
121 <label for="fancy-enable">Fancy URLs</label>
122 <input type="radio" name="fancy" id="fancy-enable" value="enable" checked='checked' /> enable<br />
123 <input type="radio" name="fancy" id="fancy-disable" value="" /> disable<br />
124 <p class="form_guide" id='fancy-form_guide'>Enable fancy (pretty) URLs. Auto-detection failed, it depends on Javascript.</p>
127 <label for="host">Hostname</label>
128 <input type="text" id="host" name="host" />
129 <p class="form_guide">Database hostname</p>
133 <label for="dbtype">Type</label>
134 <input type="radio" name="dbtype" id="fancy-mysql" value="mysql" checked='checked' /> MySQL<br />
135 <input type="radio" name="dbtype" id="dbtype-pgsql" value="pgsql" /> PostgreSQL<br />
136 <p class="form_guide">Database type</p>
140 <label for="database">Name</label>
141 <input type="text" id="database" name="database" />
142 <p class="form_guide">Database name</p>
145 <label for="username">Username</label>
146 <input type="text" id="username" name="username" />
147 <p class="form_guide">Database username</p>
150 <label for="password">Password</label>
151 <input type="password" id="password" name="password" />
152 <p class="form_guide">Database password (optional)</p>
155 <input type="submit" name="submit" class="submit" value="Submit" />
162 function updateStatus($status, $error=false)
165 <li <?php echo ($error) ? 'class="error"': ''; ?>><?php echo $status;?></li>
170 function handlePost()
175 $host = $_POST['host'];
176 $dbtype = $_POST['dbtype'];
177 $database = $_POST['database'];
178 $username = $_POST['username'];
179 $password = $_POST['password'];
180 $sitename = $_POST['sitename'];
181 $fancy = !empty($_POST['fancy']);
182 $server = $_SERVER['HTTP_HOST'];
183 $path = substr(dirname($_SERVER['PHP_SELF']), 1);
186 <dl class="system_notice">
194 updateStatus("No hostname specified.", true);
198 if (empty($database)) {
199 updateStatus("No database specified.", true);
203 if (empty($username)) {
204 updateStatus("No username specified.", true);
208 // if (empty($password)) {
209 // updateStatus("No password specified.", true);
213 if (empty($sitename)) {
214 updateStatus("No sitename specified.", true);
223 // FIXME: use PEAR::DB or PDO instead of our own switch
227 $db = mysql_db_installer($host, $database, $username, $password);
230 $db = pgsql_db_installer($host, $database, $username, $password);
236 // database connection failed, do not move on to create config file.
240 updateStatus("Writing config file...");
241 $res = writeConf($sitename, $server, $path, $fancy, $db);
244 updateStatus("Can't write config file.", true);
250 TODO https needs to be considered
252 $link = "http://".$server.'/'.$path;
254 updateStatus("StatusNet has been installed at $link");
255 updateStatus("You can visit your <a href='$link'>new StatusNet site</a>.");
261 function pgsql_db_installer($host, $database, $username, $password) {
262 $connstring = "dbname=$database host=$host user=$username";
264 //No password would mean trust authentication used.
265 if (!empty($password)) {
266 $connstring .= " password=$password";
268 updateStatus("Starting installation...");
269 updateStatus("Checking database...");
270 $conn = pg_connect($connstring);
272 if ($conn ===false) {
273 updateStatus("Failed to connect to database: $connstring");
278 //ensure database encoding is UTF8
279 $record = pg_fetch_object(pg_query($conn, 'SHOW server_encoding'));
280 if ($record->server_encoding != 'UTF8') {
281 updateStatus("StatusNet requires UTF8 character encoding. Your database is ". htmlentities($record->server_encoding));
286 updateStatus("Running database script...");
287 //wrap in transaction;
288 pg_query($conn, 'BEGIN');
289 $res = runDbScript(INSTALLDIR.'/db/statusnet_pg.sql', $conn, 'pgsql');
291 if ($res === false) {
292 updateStatus("Can't run database script.", true);
296 foreach (array('sms_carrier' => 'SMS carrier',
297 'notice_source' => 'notice source',
298 'foreign_services' => 'foreign service')
300 updateStatus(sprintf("Adding %s data to database...", $name));
301 $res = runDbScript(INSTALLDIR.'/db/'.$scr.'.sql', $conn, 'pgsql');
302 if ($res === false) {
303 updateStatus(sprintf("Can't run %d script.", $name), true);
308 pg_query($conn, 'COMMIT');
310 if (empty($password)) {
311 $sqlUrl = "pgsql://$username@$host/$database";
314 $sqlUrl = "pgsql://$username:$password@$host/$database";
317 $db = array('type' => 'pgsql', 'database' => $sqlUrl);
322 function mysql_db_installer($host, $database, $username, $password) {
323 updateStatus("Starting installation...");
324 updateStatus("Checking database...");
326 $conn = mysql_connect($host, $username, $password);
328 updateStatus("Can't connect to server '$host' as '$username'.", true);
332 updateStatus("Changing to database...");
333 $res = mysql_select_db($database, $conn);
335 updateStatus("Can't change to database.", true);
339 updateStatus("Running database script...");
340 $res = runDbScript(INSTALLDIR.'/db/statusnet.sql', $conn);
341 if ($res === false) {
342 updateStatus("Can't run database script.", true);
346 foreach (array('sms_carrier' => 'SMS carrier',
347 'notice_source' => 'notice source',
348 'foreign_services' => 'foreign service')
350 updateStatus(sprintf("Adding %s data to database...", $name));
351 $res = runDbScript(INSTALLDIR.'/db/'.$scr.'.sql', $conn);
352 if ($res === false) {
353 updateStatus(sprintf("Can't run %d script.", $name), true);
359 $sqlUrl = "mysqli://$username:$password@$host/$database";
360 $db = array('type' => 'mysql', 'database' => $sqlUrl);
364 function writeConf($sitename, $server, $path, $fancy, $db)
366 // assemble configuration file in a string
368 "if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }\n\n".
371 "\$config['site']['name'] = '$sitename';\n\n".
374 "\$config['site']['server'] = '$server';\n".
375 "\$config['site']['path'] = '$path'; \n\n".
377 // checks if fancy URLs are enabled
378 ($fancy ? "\$config['site']['fancy'] = true;\n\n":'').
381 "\$config['db']['database'] = '{$db['database']}';\n\n".
382 ($type == 'pgsql' ? "\$config['db']['quote_identifiers'] = true;\n\n":'').
383 "\$config['db']['type'] = '{$db['type']}';\n\n".
386 // write configuration file out to install directory
387 $res = file_put_contents(INSTALLDIR.'/config.php', $cfg);
392 function runDbScript($filename, $conn, $type = 'mysql')
394 $sql = trim(file_get_contents($filename));
395 $stmts = explode(';', $sql);
396 foreach ($stmts as $stmt) {
398 if (!mb_strlen($stmt)) {
401 // FIXME: use PEAR::DB or PDO instead of our own switch
404 $res = mysql_query($stmt, $conn);
405 if ($res === false) {
406 $error = mysql_error();
410 $res = pg_query($conn, $stmt);
411 if ($res === false) {
412 $error = pg_last_error();
416 updateStatus("runDbScript() error: unknown database type ". $type ." provided.");
418 if ($res === false) {
419 updateStatus("ERROR ($error) for SQL '$stmt'");
427 <?php echo"<?"; ?> xml version="1.0" encoding="UTF-8" <?php echo "?>"; ?>
429 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
430 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
431 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
433 <title>Install StatusNet</title>
434 <link rel="shortcut icon" href="favicon.ico"/>
435 <link rel="stylesheet" type="text/css" href="theme/default/css/display.css?version=0.8" media="screen, projection, tv"/>
436 <!--[if IE]><link rel="stylesheet" type="text/css" href="theme/base/css/ie.css?version=0.8" /><![endif]-->
437 <!--[if lte IE 6]><link rel="stylesheet" type="text/css" theme/base/css/ie6.css?version=0.8" /><![endif]-->
438 <!--[if IE]><link rel="stylesheet" type="text/css" href="theme/default/css/ie.css?version=0.8" /><![endif]-->
439 <script src="js/jquery.min.js"></script>
440 <script src="js/install.js"></script>
445 <address id="site_contact" class="vcard">
446 <a class="url home bookmark" href=".">
447 <img class="logo photo" src="theme/default/logo.png" alt="StatusNet"/>
448 <span class="fn org">StatusNet</span>
454 <h1>Install StatusNet</h1>