summaryrefslogtreecommitdiff
path: root/check.php-dist
blob: 0cc9a000ecc7e2df388a81d25d7587f1d5d95089 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
<?php
/**
 * Copyright (c) 2008, Till Klampaeckel
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice, this
 *    list of conditions and the following disclaimer in the documentation and/or
 *    other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * PHP Version 5
 *
 * @category Config
 * @package  RoundCube
 * @author   Till Klampaeckel <till@php.net>
 * @license  http://www.opensource.org/licenses/bsd-license.php The BSD License
 * @version  CVS: $Id$
 * @link     https://svn.roundcube.net/trunk
 * @todo     HTML/CSS to make it pretty.
 * @todo     In devel-next, use bootstrap.
 * @todo     Refactor to use RoundCube classes.
 */

$rctest_config         = array();

/**
 * @var string Please edit this to an email address, such as yourname@example.org.
 *             This email address serves as from and to for the test emails.
 */
$rctest_config['from'] = '_yourfrom_';

/*
 ********************************************
 ********************************************
 ** Don't edit anything else in this file. **
 ** Unless (of course) you know what you   **
 ** are doing.                             **
 ********************************************
 ********************************************
 */

define('CHECK_OK', '<span class="success">OK</span>');
define('CHECK_NOK', '<span class="fail">NOT OK</span>');
define('CHECK_NA', '<span class="na">NOT AVAILABLE</span>');

error_reporting(E_ALL);

$include_path  = dirname(__FILE__) . '/program/lib';
$include_path .= PATH_SEPARATOR;
$include_path .= dirname(__FILE__) . '/program';
$include_path .= PATH_SEPARATOR;
$include_path .= get_include_path();

ini_set('display_errors', 1);
set_include_path($include_path);

$create_files = array('config/db.inc.php', 'config/main.inc.php');

$required_libs = array('PEAR' => 'PEAR.php', 'DB' => 'DB.php',
    'Net_SMTP' => 'Net/SMTP.php', 'Mail_mime' => 'Mail/mime.php',
    'MDB2' => 'MDB2.php', 'iilConnection' => 'lib/imap.inc');

$supported_drivers = array('MDB2#mysql' => 'MDB2/Driver/mysql.php',
    'MDB2#pgsql' => 'MDB2/Driver/pgsql.php',
    'MDB2#sqlite' => 'MDB2/Driver/sqlite.php');

$supported_dbs = array('MySQL' => 'mysql', 'MySQLi' => 'mysqli',
    'PostgreSQL' => 'pgsql', 'SQLite (v2)' => 'sqlite');

$required_php_exts = array('Session' => 'session',
    'PCRE' => 'pcre', 'Sockets' => 'sockets');

$optional_php_exts = array('FileInfo' => 'fileinfo', 'Libiconv' => 'iconv',
    'Multibyte' => 'mbstring', 'OpenSSL' => 'openssl', 'GD' => 'gd');

$source_urls = array(
    'Socket' => 'http://www.php.net/manual/en/ref.sockets.php',
    'Session' => 'http://www.php.net/manual/en/ref.session.php',
    'PCRE' => 'http://www.php.net/manual/en/ref.pcre.php',
    'FileInfo' => 'http://www.php.net/manual/en/ref.fileinfo.php',
    'Libiconv' => 'http://www.php.net/manual/en/ref.iconv.php',
    'Multibyte' => 'http://www.php.net/manual/en/ref.mbstring.php',
    'OpenSSL' => 'http://www.php.net/manual/en/ref.openssl.php',
    'PEAR' => 'http://pear.php.net',
    'MDB2' => 'http://pear.php.net/package/MDB2',
    'Net_SMTP' => 'http://pear.php.net/package/Net_SMTP',
    'Mail_mime' => 'http://pear.php.net/package/Mail_mime'
);

$path  = dirname(__FILE__) . '/';
$check = basename(__FILE__);

require_once 'include/bugs.inc';

function show_hint($key) {
    global $source_urls;
    if ($source_urls[$key]) {
        echo '<span class="indent">(See <a href="' . $source_urls[$key] . '">';
        echo  $source_urls[$key] . '</a>)</span>';
    }
}

?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/2002/REC-xhtml1-20020801/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<link rel="shortcut icon" href="skins/default/images/favicon.ico" />
<link rel="stylesheet" type="text/css" href="skins/default/common.css" />
<style type="text/css">
/* <![CDATA[ */
label {
	display: block;
}

th {
	text-align: left;
}

h4 {
	margin-bottom: 0.2em;
}

.success {
	color: #006400;
	font-weight: bold !important;
}

.fail {
	color: #ff0000 !important;
	font-weight: bold !important;
}

.na {
	color: #f60;
	font-weight: bold;
}

.indent {
	padding-left: 0.8em;
}
/* ]]> */
</style>
<title>RoundCube :: check</title>
</head>
<body>
<img src="skins/default/images/roundcube_logo.png" width="165"
	height="55" border="0" alt="RoundCube Webmail" hspace="12" vspace="2" />

<h3>Check <?php echo basename(__FILE__); ?> Configuration</h3>
From correctly set:
<?php
if ($rctest_config['from'] == '_yourfrom_') {
    echo CHECK_NOK;
} else {
    echo $rctest_config['from'] . '<br /><br />';
    echo '<i><b>Note:</b> We do not check if this is a <b>valid</b> email address.';
    echo ' Because this settings serves as from &amp; to, make sure it is correctly set!</i>';
}

echo '<h3>Checking available databases</h3>';
echo '<p>Checks if the extension is loaded. At least one of them is required.</p>';

$prefix = (PHP_SHLIB_SUFFIX === 'dll') ? 'php_' : '';
foreach ($supported_dbs AS $database => $ext) {
    echo "$database: ";
    if (extension_loaded($ext)) {
        echo CHECK_OK;
    } else {
        $_ext = $prefix . $ext . '.' . PHP_SHLIB_SUFFIX;
        echo CHECK_NA;
        if (@dl($_ext)) {
            echo ' (<i>Could</i> be loaded. Please add in php.ini, if you plan on using it.)';
        } else {
            echo ' (<b>Not</b> installed.)';
        }
    }
    echo '<br />';
}

echo '<h3>Checking PHP extensions</h3>';
echo '<p>The following modules/extensions are <em>required</em> to run RoundCube</p>';
    
$prefix = (PHP_SHLIB_SUFFIX === 'dll') ? 'php_' : '';
foreach ($required_php_exts AS $name => $ext) {
    echo "$name: ";
    if (extension_loaded($ext)) {
        echo CHECK_OK;
    } else {
        $_ext = $prefix . $ext . '.' . PHP_SHLIB_SUFFIX;
        echo CHECK_NA;
        if (@dl($_ext)) {
            echo ' (<i>Could</i> be loaded. Please add in php.ini.)';
        } else {
            show_hint($name);
        }
    }
    echo '<br />';
}

echo '<p>These extensions are <em>optional</em> but recommended to get the best performance.</p>';

foreach ($optional_php_exts AS $name => $ext) {
    echo "$name: ";
    if (extension_loaded($ext)) {
        echo CHECK_OK;
    } else {
        $_ext = $prefix . $ext . '.' . PHP_SHLIB_SUFFIX;
        echo CHECK_NA;
        if (@dl($_ext)) {
            echo ' (<i>Could</i> be loaded. Please add in php.ini, if you plan on using it.)';
        } else {
            show_hint($name);
        }
    }
    echo '<br />';
}

echo '<h3>Check for required 3rd party libs</h3>';
echo '<p>This also checks if the include path is set correctly.</p>';

foreach ($required_libs as $classname => $file) {
    require_once $file;
    echo "$classname: ";
    if (class_exists($classname)) {
        echo CHECK_OK;
    } else {
        echo CHECK_NOK . " (Failed to load $file.)";
        show_hint($classname);
    }
    echo "<br />";
}

echo '<h3>Check if you setup config files</h3>';
echo '<p>Checks if the files exist and if they are readable.</p>';

foreach ($create_files AS $file) {
    echo "File $file: ";
    if (file_exists($path . $file) && is_readable($path . $file)) {
        echo CHECK_OK;
    } else {
        echo CHECK_NOK;
    }
    echo '<br />';
}

echo '<h3>Check if directories are writable</h3>';
echo '<p>RoundCube may need to write/save files into these directories.</p>';
require_once $path . 'config/main.inc.php';
$rctest_config = array_merge($rctest_config, $rcmail_config);

if (isset($rctest_config)) {
    foreach (array($rctest_config['temp_dir'], $rctest_config['log_dir']) AS $dir) {
        $dir = $dir{0} == '/' ? $dir : $path . $dir;
        echo "Directory $dir: ";
        if (!is_writable($dir)) {
            echo CHECK_NOK;
        } else {
            echo CHECK_OK;
        }
        echo "<br />";
    }
} else {
    echo 'Could not open db.inc.php config file, or file is empty.<br />';
}

echo '<h3>Check supplied DB settings</h3>';
require_once $path . 'config/db.inc.php';
$rctest_config = array_merge($rctest_config, $rcmail_config);

$db_working = false;
if (isset($rctest_config) && is_array($rctest_config)) {
    echo 'Selected backend: ';
    if ($rctest_config['db_backend'] != '') {

        echo 'PEAR::' . strtoupper($rctest_config['db_backend']) . '<br />';

        $_class = 'rcube_' . strtolower($rctest_config['db_backend']);

        require_once 'include/' . $_class . '.inc';

        echo 'DSN (standard): ';
        $DB = new $_class($rctest_config['db_dsnw'], '', false);
        $DB->db_connect('w');
        if (!($db_error_msg = $DB->is_error())) {
            echo CHECK_OK;
            $db_working = true;
        } else {
            echo CHECK_NOK . " (Error: $db_error_msg)";
        }
        echo '<br />';
        echo 'DSN (read-only, optional): ';
        if ($rctest_config['db_dsnr'] != '') {
            $DB_READ = new $_class($rctest_config['db_dsnr'], '', false);
            $DB_READ->db_connect('w');
            if (!($db_error_msg = $DB_READ->is_error())) {
                echo CHECK_OK;
            } else {
                echo CHECK_NOK . " (Error: $db_error_msg)";
            }
        } else {
            echo CHECK_NA.($db_working ? ' - <span class="success">will use DSN (standard)</span>' : '');
        }
        echo '<br />';
    } else {
        echo CHECK_NOK . ' (not set)';
    }
} else {
    echo 'Could not open db.inc.php config file, or file is empty.<br />';
}

echo '<h3>TimeZone</h3>';
echo 'Checks if web- and databaseserver are in the same timezone.<br /><br />';
echo 'Status: ';
if ($db_working === true) {
    $tz_db    = 'SELECT ' . $DB->unixtimestamp($DB->now()) . ' AS tz_db';
    $tz_db    = $DB->query($tz_db);
    $tz_db    = $DB->fetch_assoc($tz_db);
    $tz_db    = (int) $tz_db['tz_db'];
    $tz_local = (int) time();
    $tz_diff  = $tz_local - $tz_db;

    // sometimes we have 1 second gap, treat that as ok
    if ($tz_diff > 1) {
        echo CHECK_NOK;
    } else {
        echo CHECK_OK;
    }
} else {
    echo 'Could not test (fix DB first).';
}
echo '<br />';

echo '<h3>Checking .ini settings</h3>';

$ini_array = array('session.auto_start' => 0, 'file_uploads' => 1,
    'magic_quotes_sybase' => 0, 'magic_quotes_gpc' => 0,
    'zlib.output_compression' => 0);

foreach ($ini_array AS $var => $val) {
    $status = ini_get($var);

    echo "<h4>$var = $val</h4>";
    echo 'status: ';
    if ($status != $val) {
        echo CHECK_NOK;
    } else {
        echo CHECK_OK;
    }
    echo '<br />';
}
?>
<h3>Check email settings</h3>
<?php
echo 'Fetching config-settings from config/main.inc.php.<br /><br />';
if (is_array($rctest_config) && count($rctest_config)) {
    ?>
<table border="0">
	<tr>
		<th>
		<h4>SMTP Settings</h4>
		</th>
		<th>
		<h4>IMAP Settings</h4>
		</th>
	</tr>
	<tr>
		<td valign="top"><?php
		echo 'SMTP: ' . CHECK_OK . '<br />';
		echo 'server: '.(isset($rctest_config['smtp_server']) && !empty($rctest_config['smtp_server']) ? $rctest_config['smtp_server'] : '<i>not set</i>').'<br />';
		echo 'port: '.(isset($rctest_config['smtp_port']) && !empty($rctest_config['smtp_port']) ? $rctest_config['smtp_port'] : '<i>not set</i>').'<br />';
		if (isset($rctest_config['smtp_user']) && !empty($rctest_config['smtp_user'])) {
		    echo 'user: '.$rctest_config['smtp_user'].'<br/>';
		} elseif ($rctest_config['smtp_user'] == '%u') {
		    echo 'user: <i>use current session</i><br/>';
		} else {
		    echo 'user: <i>not set</i><br/>';
		}
        if (isset($rctest_config['smtp_pass']) && !empty($rctest_config['smtp_pass'])) {
		    echo 'pass: '.$rctest_config['smtp_pass'].'<br/>';
		} elseif (isset($rctest_config['smtp_pass']) && $rctest_config['smtp_pass'] == '%p') {
		    echo 'pass: <i>use current session</i><br/>';
		} else {
		    echo 'pass: <i>not set</i><br/>';
		}
		?></td>
		<td valign="top"><?php
		echo 'IMAP: ' . CHECK_OK . '<br />';
        if (isset($rctest_config['default_host']) && is_array($rctest_config['default_host'])) {
		    echo 'server: '.var_export($rctest_config['default_host'], true).'<br/>';
        } elseif (isset($rctest_config['default_host']) && !empty($rctest_config['default_host'])) {
            echo 'server: '.$rctest_config['default_host'].'<br/>';
		} else {
		    echo 'server: <i>not set</i><br/>';
		}
		echo 'port: '.(isset($rctest_config['default_port']) && !empty($rctest_config['default_port']) ? $rctest_config['default_port'] : '<i>not set</i>').'<br />';
		?></td>
	</tr>
</table>
<h3>Test SMTP settings - send an email</h3>
<p>Don't abuse this!</p>
<form action="<?php echo $check; ?>" method="post"><?php
if ($rctest_config['smtp_server'] != ''):
if ($rctest_config['smtp_user'] == '%u'):
?> <label>Username:</label><input type="text" name="smtp_test[user]" />
<label>Password:</label><input type="password" name="smtp_test[pass]" /><br />
<?php
endif;
endif;
?> Recipient:<br />
<?php echo $rctest_config['from']; ?><br />
<br />
<input type="hidden" name="action" value="smtp" /> <input type="submit"
	value="send an email" /></form>
<?php
if ($_SERVER['REQUEST_METHOD'] == 'POST' && $_POST['action'] == 'smtp') {

    echo 'Trying to send email: ';
    if ($rctest_config['from'] == '_yourfrom_') {
        echo CHECK_NOK . '<br />';
        echo '<i>Please edit $rctest_config in ' . basename(__FILE__) . '</i><br />';
    } else {

        $data   = $_POST['smtp_test'];
        $CONFIG = $rctest_config;

        require_once 'lib/rc_mail_mime.inc';
        require_once 'include/rcube_smtp.inc';

        $recipients = $rctest_config['from'];

        $headers['From']    = $rctest_config['from'];
        $headers['To']      = $recipients;
        $headers['Subject'] = 'Test message from RoundCube';

        $body = 'This is a test to confirm that RoundCube can send email.';

        $mail_object = new rc_mail_mime();
        $mail_object->headers($headers);

        $smtp_response = array();
        if (smtp_mail($rctest_config['from'], $recipients, ($foo = $mail_object->txtHeaders($send_headers)), $body, $smtp_response)) {
            echo CHECK_OK . '<br />';
        } else {
            echo CHECK_NOK;
            echo '<br />' . join('<br />', $smtp_response);
        }
    }
}
} else {
    echo CHECK_NOK;
}
?>
<h3>Test IMAP settings</h3>
<?php
if ($rctest_config['default_host'] == '') {
    echo '<span class="fail">We cannot test, default_host is not set in config/main.inc.php.</span>';
} else {
    ?>
<form action="<?php echo $check; ?>" method="post">
<label>Username:</label><input type="text" name="imap_test[user]" />
<label>Password:</label><input type="password" name="imap_test[pass]" /><br />
<br />
<input type="hidden" name="action" value="imap" />
<input type="submit" value="check email" />
</form>
<br /><br />
    <?php
    if ($_SERVER['REQUEST_METHOD'] == 'POST' && $_POST['action'] == 'imap') {

        echo 'Testing IMAP connect: ';

        $data = $_POST['imap_test'];

        require_once 'imap.inc';
        global $iil_error, $ICL_PORT;

        $ICL_PORT = $rctest_config['default_port'];
        $result   = iil_Connect($rctest_config['default_host'],
        $data['user'], $data['pass']);

        if ($result != true) {
            echo CHECK_NOK;
            echo '<br />Error return: ' . $iil_error;
        } else {
            echo CHECK_OK;
        }
        echo '<br />';
    }
}
?>
</body>
</html>