diff --git a/index.php b/index.php index 716c24fe6..3c2f172f5 100755 --- a/index.php +++ b/index.php @@ -1,47 +1,42 @@ -install = ((file_exists('.htconfig.php') && filesize('.htconfig.php')) ? false : true); -@include(".htconfig.php"); +@include('.htconfig.php'); $a->timezone = ((x($default_timezone)) ? $default_timezone : 'UTC'); date_default_timezone_set($a->timezone); -/** - * +/* * Try to open the database; - * */ -require_once("include/dba/dba_driver.php"); +require_once('include/dba/dba_driver.php'); if(! $a->install) { $db = dba_factory($db_host, $db_port, $db_user, $db_pass, $db_data, $db_type, $a->install); - unset($db_host, $db_port, $db_user, $db_pass, $db_data, $db_type); + unset($db_host, $db_port, $db_user, $db_pass, $db_data, $db_type); /** * Load configs from db. Overwrite configs from .htconfig.php @@ -51,10 +46,10 @@ if(! $a->install) { load_config('system'); load_config('feature'); - require_once("include/session.php"); + require_once('include/session.php'); load_hooks(); call_hooks('init_1'); - + $a->language = get_best_language(); load_translation_table($a->language); // Force the cookie to be secure (https only) if this site is SSL enabled. Must be done before session_start(). @@ -82,7 +77,7 @@ else { * * The order of these may be important so use caution if you think they're all * intertwingled with no logical order and decide to sort it out. Some of the - * dependencies have changed, but at least at one time in the recent past - the + * dependencies have changed, but at least at one time in the recent past - the * order was critical to everything working properly * */ @@ -100,7 +95,7 @@ if(array_key_exists('system_language',$_POST)) { else unset($_SESSION['language']); } -if((x($_SESSION,'language')) && ($_SESSION['language'] !== $lang)) { +if((x($_SESSION, 'language')) && ($_SESSION['language'] !== $lang)) { $a->language = $_SESSION['language']; load_translation_table($a->language); } @@ -113,20 +108,19 @@ if((x($_GET,'zid')) && (! $a->install)) { } } -if((x($_SESSION,'authenticated')) || (x($_POST,'auth-params')) || ($a->module === 'login')) - require("include/auth.php"); +if((x($_SESSION, 'authenticated')) || (x($_POST, 'auth-params')) || ($a->module === 'login')) + require('include/auth.php'); - -if(! x($_SESSION,'sysmsg')) +if(! x($_SESSION, 'sysmsg')) $_SESSION['sysmsg'] = array(); -if(! x($_SESSION,'sysmsg_info')) +if(! x($_SESSION, 'sysmsg_info')) $_SESSION['sysmsg_info'] = array(); /* - * check_config() is responsible for running update scripts. These automatically + * check_config() is responsible for running update scripts. These automatically * update the DB schema whenever we push a new one out. It also checks to see if - * any plugins have been added or removed and reacts accordingly. + * any plugins have been added or removed and reacts accordingly. */ @@ -154,23 +148,22 @@ $a->set_apps($arr['app_menu']); * and use it for handling our URL request. * The module file contains a few functions that we call in various circumstances * and in the following order: - * + * * "module"_init * "module"_post (only called if there are $_POST variables) * "module"_aside * $theme_$module_aside (and $extends_$module_aside) are run first if either exist * if either of these return false, module_aside is not called - * This allows a theme to over-ride the sidebar layout completely. + * This allows a theme to over-ride the sidebar layout completely. * "module"_content - the string return of this function contains our page body * - * Modules which emit other serialisations besides HTML (XML,JSON, etc.) should do + * Modules which emit other serialisations besides HTML (XML,JSON, etc.) should do * so within the module init and/or post functions and then invoke killme() to terminate * further processing. */ if(strlen($a->module)) { - /** * * We will always have a module name. @@ -184,7 +177,6 @@ if(strlen($a->module)) { $a->module_loaded = true; } - if((strpos($a->module,'admin') === 0) && (! is_site_admin())) { $a->module_loaded = false; notice( t('Permission denied.') . EOL); @@ -197,7 +189,6 @@ if(strlen($a->module)) { */ if(! $a->module_loaded) { - if(file_exists("mod/site/{$a->module}.php")) { include_once("mod/site/{$a->module}.php"); $a->module_loaded = true; @@ -210,37 +201,36 @@ if(strlen($a->module)) { /** - * * The URL provided does not resolve to a valid module. * - * On Dreamhost sites, quite often things go wrong for no apparent reason and they send us to '/internal_error.html'. - * We don't like doing this, but as it occasionally accounts for 10-20% or more of all site traffic - + * On Dreamhost sites, quite often things go wrong for no apparent reason and they send us to '/internal_error.html'. + * We don't like doing this, but as it occasionally accounts for 10-20% or more of all site traffic - * we are going to trap this and redirect back to the requested page. As long as you don't have a critical error on your page * this will often succeed and eventually do the right thing. * * Otherwise we are going to emit a 404 not found. - * */ if(! $a->module_loaded) { // Stupid browser tried to pre-fetch our Javascript img template. Don't log the event or return anything - just quietly exit. - if((x($_SERVER,'QUERY_STRING')) && preg_match('/{[0-9]}/',$_SERVER['QUERY_STRING']) !== 0) { + if((x($_SERVER, 'QUERY_STRING')) && preg_match('/{[0-9]}/', $_SERVER['QUERY_STRING']) !== 0) { killme(); } - if((x($_SERVER,'QUERY_STRING')) && ($_SERVER['QUERY_STRING'] === 'q=internal_error.html') && isset($dreamhost_error_hack)) { + if((x($_SERVER, 'QUERY_STRING')) && ($_SERVER['QUERY_STRING'] === 'q=internal_error.html') && isset($dreamhost_error_hack)) { logger('index.php: dreamhost_error_hack invoked. Original URI =' . $_SERVER['REQUEST_URI']); goaway($a->get_baseurl() . $_SERVER['REQUEST_URI']); } logger('index.php: page not found: ' . $_SERVER['REQUEST_URI'] . ' ADDRESS: ' . $_SERVER['REMOTE_ADDR'] . ' QUERY: ' . $_SERVER['QUERY_STRING'], LOGGER_DEBUG); - header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . t('Not Found')); - $tpl = get_markup_template("404.tpl"); + header($_SERVER['SERVER_PROTOCOL'] . ' 404 ' . t('Not Found')); + $tpl = get_markup_template('404.tpl'); $a->page['content'] = replace_macros($tpl, array( - '$message' => t('Page not found.' ) + '$message' => t('Page not found.') )); - // pretend this is a module so it will initialise the theme. + + // pretend this is a module so it will initialise the theme $a->module = '404'; $a->module_loaded = true; } @@ -249,11 +239,10 @@ if(strlen($a->module)) { /* initialise content region */ -if(! x($a->page,'content')) +if(! x($a->page, 'content')) $a->page['content'] = ''; - if(! ($a->module === 'setup')) { /* set JS cookie */ if($_COOKIE['jsAvailable'] != 1) { @@ -263,9 +252,9 @@ if(! ($a->module === 'setup')) { $_COOKIE['jsAvailable'] = 1; } } - call_hooks('page_content_top',$a->page['content']); -} + call_hooks('page_content_top', $a->page['content']); +} @@ -282,7 +271,7 @@ if($a->module_loaded) { * For this reason, please restrict the use of templates to those which * do not provide any presentation details - as themes will not be able * to over-ride them. - */ + */ if(function_exists($a->module . '_init')) { call_hooks($a->module . '_mod_init', $placeholder); @@ -310,32 +299,31 @@ if($a->module_loaded) { * load current theme info */ - $theme_info_file = "view/theme/".current_theme()."/php/theme.php"; + $theme_info_file = 'view/theme/' . current_theme() . '/php/theme.php'; if (file_exists($theme_info_file)){ require_once($theme_info_file); } - if(function_exists(str_replace('-','_',current_theme()) . '_init')) { - $func = str_replace('-','_',current_theme()) . '_init'; + if(function_exists(str_replace('-', '_', current_theme()) . '_init')) { + $func = str_replace('-', '_', current_theme()) . '_init'; $func($a); } - elseif (x($a->theme_info,"extends") && file_exists("view/theme/".$a->theme_info["extends"]."/php/theme.php")) { - require_once("view/theme/".$a->theme_info["extends"]."/php/theme.php"); - if(function_exists(str_replace('-','_',$a->theme_info["extends"]) . '_init')) { - $func = str_replace('-','_',$a->theme_info["extends"]) . '_init'; + elseif (x($a->theme_info, 'extends') && file_exists('view/theme/' . $a->theme_info['extends'] . '/php/theme.php')) { + require_once('view/theme/' . $a->theme_info['extends'] . '/php/theme.php'); + if(function_exists(str_replace('-', '_', $a->theme_info['extends']) . '_init')) { + $func = str_replace('-', '_', $a->theme_info['extends']) . '_init'; $func($a); } } if(($_SERVER['REQUEST_METHOD'] === 'POST') && (! $a->error) && (function_exists($a->module . '_post')) - && (! x($_POST,'auth-params'))) { + && (! x($_POST, 'auth-params'))) { call_hooks($a->module . '_mod_post', $_POST); $func = $a->module . '_post'; $func($a); } - if(! $a->error) { // If a theme has defined an _aside() function, run that first // @@ -353,9 +341,9 @@ if($a->module_loaded) { $func = str_replace('-','_',current_theme()) . '_' . $a->module . '_aside'; $aside_default = $func($a); } - elseif($aside_default && x($a->theme_info,"extends") - && (function_exists(str_replace('-','_',$a->theme_info["extends"]) . '_' . $a->module . '_aside'))) { - $func = str_replace('-','_',$a->theme_info["extends"]) . '_' . $a->module . '_aside'; + elseif($aside_default && x($a->theme_info, "extends") + && (function_exists(str_replace('-', '_',$a->theme_info["extends"]) . '_' . $a->module . '_aside'))) { + $func = str_replace('-', '_', $a->theme_info["extends"]) . '_' . $a->module . '_aside'; $aside_default = $func($a); } if($aside_default && function_exists($a->module . '_aside')) { @@ -373,24 +361,25 @@ if($a->module_loaded) { call_hooks($a->module . '_mod_aftercontent', $arr); $a->page['content'] .= $arr['content']; } - } // If you're just visiting, let javascript take you home -if(x($_SESSION,'visitor_home')) +if(x($_SESSION, 'visitor_home')) { $homebase = $_SESSION['visitor_home']; -elseif(local_channel()) +} elseif(local_channel()) { $homebase = $a->get_baseurl() . '/channel/' . $a->channel['channel_address']; +} -if(isset($homebase)) - $a->page['content'] .= ''; +if(isset($homebase)) { + $a->page['content'] .= ''; +} // now that we've been through the module content, see if the page reported // a permission problem and if so, a 403 response would seem to be in order. -if(stristr( implode("",$_SESSION['sysmsg']), t('Permission denied'))) { - header($_SERVER["SERVER_PROTOCOL"] . ' 403 ' . t('Permission denied.')); +if(stristr(implode("", $_SESSION['sysmsg']), t('Permission denied'))) { + header($_SERVER['SERVER_PROTOCOL'] . ' 403 ' . t('Permission denied.')); } diff --git a/mod/setup.php b/mod/setup.php index eba28a9bc..d88cf73f1 100755 --- a/mod/setup.php +++ b/mod/setup.php @@ -1,40 +1,53 @@ connected) { - echo "Database Connect failed: " . $db->error; + echo 'Database Connect failed: ' . $db->error; killme(); $a->data['db_conn_failed']=true; } @@ -83,10 +97,10 @@ function setup_post(&$a) { } }*/ //if(get_db_errno()) { - + //} - return; + return; break; case 4: $urlpath = $a->get_path(); @@ -100,10 +114,9 @@ function setup_post(&$a) { $timezone = notags(trim($_POST['timezone'])); $adminmail = notags(trim($_POST['adminmail'])); $siteurl = notags(trim($_POST['siteurl'])); - if($siteurl != z_root()) { - $test = z_fetch_url($siteurl."/setup/testrewrite"); + $test = z_fetch_url($siteurl."/setup/testrewrite"); if((! $test['success']) || ($test['body'] != 'ok')) { $a->data['url_fail'] = true; $a->data['url_error'] = $test['error']; @@ -147,7 +160,7 @@ function setup_post(&$a) { $a->data['db_installed'] = true; return; - break; + break; } } @@ -156,47 +169,50 @@ function get_db_errno() { return mysqli_connect_errno(); else return mysql_errno(); -} +} +/** + * @brief Get output for the setup page. + * + * Depending on the state we are currently in it returns different content. + * + * @param App &$a + * @return string parsed HTML output + */ function setup_content(&$a) { - global $install_wizard_pass, $db; - $o = ''; - $wizard_status = ""; - $install_title = t('$Projectname Server - Setup'); - - - if(x($a->data,'db_conn_failed')) { + $o = ''; + $wizard_status = ''; + $install_title = t('$Projectname Server - Setup'); + + if(x($a->data, 'db_conn_failed')) { $install_wizard_pass = 2; $wizard_status = t('Could not connect to database.'); } - if(x($a->data,'url_fail')) { + if(x($a->data, 'url_fail')) { $install_wizard_pass = 3; $wizard_status = t('Could not connect to specified site URL. Possible SSL certificate or DNS issue.'); if($a->data['url_error']) $wizard_status .= ' ' . $a->data['url_error']; } - if(x($a->data,'db_create_failed')) { + if(x($a->data, 'db_create_failed')) { $install_wizard_pass = 2; $wizard_status = t('Could not create table.'); } - - $db_return_text=""; - if(x($a->data,'db_installed')) { + $db_return_text = ''; + if(x($a->data, 'db_installed')) { $txt = '
'; $txt .= t('Your site database has been installed.') . EOL; $db_return_text .= $txt; } - - if(x($a->data,'db_failed')) { + if(x($a->data, 'db_failed')) { $txt = t('You may need to import the file "install/schema_xxx.sql" manually using a database client.') . EOL; $txt .= t('Please see the file "install/INSTALL.txt".') . EOL ."
".$a->data['db_failed'] . "". EOL ; $db_return_text .= $txt; } - if($db && $db->connected) { $r = q("SELECT COUNT(*) as `total` FROM `account`"); if($r && count($r) && $r[0]['total']) { @@ -210,23 +226,22 @@ function setup_content(&$a) { } } - if(x($a->data,'txt') && strlen($a->data['txt'])) { + if(x($a->data, 'txt') && strlen($a->data['txt'])) { $db_return_text .= manual_config($a); } - - if ($db_return_text!="") { + + if ($db_return_text != "") { $tpl = get_markup_template('install.tpl'); return replace_macros($tpl, array( '$title' => $install_title, - '$pass' => "", + '$pass' => '', '$text' => $db_return_text . what_next(), )); } - + switch ($install_wizard_pass){ case 1: { // System check - $checks = array(); check_funcs($checks); @@ -238,22 +253,23 @@ function setup_content(&$a) { check_smarty3($checks); check_keys($checks); - - if(x($_POST,'phpath')) + + if (x($_POST, 'phpath')) $phpath = notags(trim($_POST['phpath'])); check_php($phpath, $checks); - check_htaccess($checks); - - function check_passed($v, $c){ + check_phpconfig($checks); + + check_htaccess($checks); + + function check_passed($v, $c) { if ($c['required']) $v = $v && $c['status']; + return $v; } $checkspassed = array_reduce($checks, "check_passed", true); - - $tpl = get_markup_template('install_checks.tpl'); $o .= replace_macros($tpl, array( @@ -269,7 +285,7 @@ function setup_content(&$a) { )); return $o; }; break; - + case 2: { // Database config $dbhost = ((x($_POST,'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost'); @@ -281,7 +297,6 @@ function setup_content(&$a) { $phpath = notags(trim($_POST['phpath'])); $adminmail = notags(trim($_POST['adminmail'])); $siteurl = notags(trim($_POST['siteurl'])); - $tpl = get_markup_template('install_db.tpl'); $o .= replace_macros($tpl, array( @@ -292,7 +307,7 @@ function setup_content(&$a) { '$info_03' => t('The database you specify below should already exist. If it does not, please create it before continuing.'), '$status' => $wizard_status, - + '$dbhost' => array('dbhost', t('Database Server Name'), $dbhost, t('Default is localhost')), '$dbport' => array('dbport', t('Database Port'), $dbport, t('Communication port number - use 0 for default')), '$dbuser' => array('dbuser', t('Database Login Name'), $dbuser, ''), @@ -302,16 +317,14 @@ function setup_content(&$a) { '$adminmail' => array('adminmail', t('Site administrator email address'), $adminmail, t('Your account email address must match this in order to use the web admin panel.')), '$siteurl' => array('siteurl', t('Website URL'), z_root(), t('Please use SSL (https) URL if available.')), - '$lbl_10' => t('Please select a default timezone for your website'), - + '$baseurl' => $a->get_baseurl(), - + '$phpath' => $phpath, - + '$submit' => t('Submit'), - )); return $o; }; break; @@ -324,241 +337,296 @@ function setup_content(&$a) { $dbdata = notags(trim($_POST['dbdata'])); $dbtype = intval(notags(trim($_POST['dbtype']))); $phpath = notags(trim($_POST['phpath'])); - + $adminmail = notags(trim($_POST['adminmail'])); $siteurl = notags(trim($_POST['siteurl'])); $timezone = ((x($_POST,'timezone')) ? ($_POST['timezone']) : 'America/Los_Angeles'); - + $tpl = get_markup_template('install_settings.tpl'); $o .= replace_macros($tpl, array( '$title' => $install_title, '$pass' => t('Site settings'), - '$status' => $wizard_status, - - '$dbhost' => $dbhost, - '$dbport' => $dbport, + + '$dbhost' => $dbhost, + '$dbport' => $dbport, '$dbuser' => $dbuser, '$dbpass' => $dbpass, '$dbdata' => $dbdata, '$phpath' => $phpath, '$dbtype' => $dbtype, - + '$adminmail' => array('adminmail', t('Site administrator email address'), $adminmail, t('Your account email address must match this in order to use the web admin panel.')), '$siteurl' => array('siteurl', t('Website URL'), z_root(), t('Please use SSL (https) URL if available.')), - '$timezone' => array('timezone', t('Please select a default timezone for your website'), $timezone, '', get_timezones()), - + '$baseurl' => $a->get_baseurl(), - - - + '$submit' => t('Submit'), - )); return $o; }; break; - } } /** - * checks : array passed to template - * title : string - * status : boolean - * required : boolean - * help : string optional + * @brief Add a check result to the array for output. + * + * @param[in,out] array &$checks array passed to template + * @param string $title a title for the check + * @param boolean $status + * @param boolean $required + * @param[optional] string $help optional help string */ -function check_add(&$checks, $title, $status, $required, $help){ +function check_add(&$checks, $title, $status, $required, $help = '') { $checks[] = array( - 'title' => $title, - 'status' => $status, + 'title' => $title, + 'status' => $status, 'required' => $required, - 'help' => $help, + 'help' => $help ); } +/** + * @brief Checks the PHP environment. + * + * @param[in,out] string &$phpath + * @param[out] array &$checks + */ function check_php(&$phpath, &$checks) { - if (strlen($phpath)){ + $help = ''; + + if (strlen($phpath)) { $passed = file_exists($phpath); } else { if(is_windows()) $phpath = trim(shell_exec('where php')); else $phpath = trim(shell_exec('which php')); + $passed = strlen($phpath); } - $help = ""; + if(!$passed) { $help .= t('Could not find a command line version of PHP in the web server PATH.'). EOL; - $help .= t("If you don't have a command line version of PHP installed on server, you will not be able to run background polling via cron.") . EOL; + $help .= t('If you don\'t have a command line version of PHP installed on server, you will not be able to run background polling via cron.') . EOL; $help .= EOL . EOL ; $tpl = get_markup_template('field_input.tpl'); $help .= replace_macros($tpl, array( '$field' => array('phpath', t('PHP executable path'), $phpath, t('Enter full path to php executable. You can leave this blank to continue the installation.')), )); - $phpath=""; + $phpath = ''; } - + check_add($checks, t('Command line PHP').($passed?" ($phpath)":""), $passed, false, $help); - + if($passed) { $str = autoname(8); $cmd = "$phpath install/testargs.php $str"; $result = trim(shell_exec($cmd)); $passed2 = $result == $str; - $help = ""; + $help = ''; if(!$passed2) { $help .= t('The command line version of PHP on your system does not have "register_argc_argv" enabled.'). EOL; $help .= t('This is required for message delivery to work.'); } + check_add($checks, t('PHP register_argc_argv'), $passed, true, $help); } - - } -function check_keys(&$checks) { +/** + * @brief Some PHP configuration checks. + * + * @todo Change how we display such informational text. Add more description + * how to change them. + * + * @param[out] array &$checks + */ +function check_phpconfig(&$checks) { + require_once 'include/environment.php'; $help = ''; + $result = getPhpiniUploadLimits(); + $help = sprintf(t('Your max allowed total upload size is set to %s. Maximum size of one file to upload is set to %s. You are allowed to upload up to %d files at once.'), + userReadableSize($result['post_max_size']), + userReadableSize($result['max_upload_filesize']), + $result['max_file_uploads'] + ); + $help .= '
".t('IMPORTANT: You will need to [manually] setup a scheduled task for the poller.') - .t('Please see the file "install/INSTALL.txt".') + .t('Please see the file "install/INSTALL.txt".') ."
" .t("Go to your new Red node registration page and register as new user. Remember to use the same email you have entered as administrator email. This will allow you to enter the site admin panel.") ."
"; } - -