githubFork/roundcubemail.git

Add note about removing some deprecated methods

Aleksander Machniak

2016-05-06 972f0bd886f777aeb9fbacdaf33f08a84db12b49

commit \| author \| age
4e17e6	1	<?php
a95874	2	/**
a6f90e	3	+-------------------------------------------------------------------------+
e019f2	4	\| Roundcube Webmail IMAP Client \|
3779b6	5	\| Version 1.2-git \|
a6f90e	6	\| \|
2f8b10	7	\| Copyright (C) 2005-2015, The Roundcube Dev Team \|
a6f90e	8	\| \|
7fe381	9	\| This program is free software: you can redistribute it and/or modify \|
T	10	\| it under the terms of the GNU General Public License (with exceptions \|
	11	\| for skins & plugins) as published by the Free Software Foundation, \|
	12	\| either version 3 of the License, or (at your option) any later version. \|
	13	\| \|
	14	\| This file forms part of the Roundcube Webmail Software for which the \|
	15	\| following exception is added: Plugins and Skins which merely make \|
	16	\| function calls to the Roundcube Webmail Software, and for that purpose \|
	17	\| include it by reference shall not be considered modifications of \|
	18	\| the software. \|
	19	\| \|
	20	\| If you wish to use this file in another project or create a modified \|
	21	\| version that will not be part of the Roundcube Webmail Software, you \|
	22	\| may remove the exception above and use this source code under the \|
	23	\| original version of the license. \|
a6f90e	24	\| \|
A	25	\| This program is distributed in the hope that it will be useful, \|
	26	\| but WITHOUT ANY WARRANTY; without even the implied warranty of \|
7fe381	27	\| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the \|
a6f90e	28	\| GNU General Public License for more details. \|
A	29	\| \|
7fe381	30	\| You should have received a copy of the GNU General Public License \|
T	31	\| along with this program. If not, see http://www.gnu.org/licenses/. \|
a6f90e	32	\| \|
A	33	+-------------------------------------------------------------------------+
	34	\| Author: Thomas Bruederli <roundcube@gmail.com> \|
0301d9	35	\| Author: Aleksander Machniak <alec@alec.pl> \|
a6f90e	36	+-------------------------------------------------------------------------+
4e17e6	37	*/
15a9d1	38
47124c	39	// include environment
T	40	require_once 'program/include/iniset.php';
15a9d1	41
48bc52	42	// init application, start session, init output class, etc.
1b39d9	43	$RCMAIL = rcmail::get_instance(0, $GLOBALS['env']);
83a763	44
9e54e6	45	// Make the whole PHP output non-cacheable (#1487797)
0c2596	46	$RCMAIL->output->nocacheing_headers();
ba5c53	47	$RCMAIL->output->common_headers();
9e54e6	48
d51c93	49	// turn on output buffering
A	50	ob_start();
8affba	51
8c72e3	52	// check if config files had errors
T	53	if ($err_str = $RCMAIL->config->get_error()) {
0301d9	54	rcmail::raise_error(array(
AM	55	'code' => 601,
	56	'type' => 'php',
	57	'message' => $err_str), false, true);
8c72e3	58	}
T	59
8affba	60	// check DB connections and exit on failure
c321a9	61	if ($err_str = $RCMAIL->db->is_error()) {
0301d9	62	rcmail::raise_error(array(
AM	63	'code' => 603,
	64	'type' => 'db',
a95874	65	'message' => $err_str), false, true);
f11541	66	}
8affba	67
4e17e6	68	// error steps
0c2596	69	if ($RCMAIL->action == 'error' && !empty($_GET['_code'])) {
a95874	70	rcmail::raise_error(array('code' => hexdec($_GET['_code'])), false, true);
47124c	71	}
570f0b	72
f5d61d	73	// check if https is required (for login) and redirect if necessary
T	74	if (empty($_SESSION['user_id']) && ($force_https = $RCMAIL->config->get('force_https', false))) {
0301d9	75	$https_port = is_bool($force_https) ? 443 : $force_https;
AM	76
	77	if (!rcube_utils::https_check($https_port)) {
	78	$host = preg_replace('/:[0-9]+$/', '', $_SERVER['HTTP_HOST']);
	79	$host .= ($https_port != 443 ? ':' . $https_port : '');
	80
	81	header('Location: https://' . $host . $_SERVER['REQUEST_URI']);
	82	exit;
	83	}
f5d61d	84	}
T	85
cc97ea	86	// trigger startup plugin hook
T	87	$startup = $RCMAIL->plugins->exec_hook('startup', array('task' => $RCMAIL->task, 'action' => $RCMAIL->action));
	88	$RCMAIL->set_task($startup['task']);
	89	$RCMAIL->action = $startup['action'];
	90
4e17e6	91	// try to log in
9b94eb	92	if ($RCMAIL->task == 'login' && $RCMAIL->action == 'login') {
681ba6	93	$request_valid = $_SESSION['temp'] && $RCMAIL->check_request();
784a42	94
681ba6	95	// purge the session in case of new login when a session already exists
0301d9	96	$RCMAIL->kill_session();
5f560e	97
0301d9	98	$auth = $RCMAIL->plugins->exec_hook('authenticate', array(
AM	99	'host' => $RCMAIL->autoselect_host(),
	100	'user' => trim(rcube_utils::get_input_value('_user', rcube_utils::INPUT_POST)),
	101	'pass' => rcube_utils::get_input_value('_pass', rcube_utils::INPUT_POST, true,
	102	$RCMAIL->config->get('password_charset', 'ISO-8859-1')),
	103	'cookiecheck' => true,
	104	'valid' => $request_valid,
	105	));
cc97ea	106
0301d9	107	// Login
AM	108	if ($auth['valid'] && !$auth['abort']
	109	&& $RCMAIL->login($auth['user'], $auth['pass'], $auth['host'], $auth['cookiecheck'])
	110	) {
	111	// create new session ID, don't destroy the current session
	112	// it was destroyed already by $RCMAIL->kill_session() above
	113	$RCMAIL->session->remove('temp');
	114	$RCMAIL->session->regenerate_id(false);
aad6e2	115
0301d9	116	// send auth cookie if necessary
AM	117	$RCMAIL->session->set_auth_cookie();
aad6e2	118
0301d9	119	// log successful login
AM	120	$RCMAIL->log_login();
10eedb	121
0301d9	122	// restore original request parameters
d2191c	123	$query = array();
0301d9	124	if ($url = rcube_utils::get_input_value('_url', rcube_utils::INPUT_POST)) {
AM	125	parse_str($url, $query);
cc97ea	126
0301d9	127	// prevent endless looping on login page
AM	128	if ($query['_task'] == 'login') {
	129	unset($query['_task']);
	130	}
5e0045	131
0301d9	132	// prevent redirect to compose with specified ID (#1488226)
AM	133	if ($query['_action'] == 'compose' && !empty($query['_id'])) {
4b72a1	134	$query = array('_action' => 'compose');
0301d9	135	}
AM	136	}
	137
	138	// allow plugins to control the redirect url after login success
	139	$redir = $RCMAIL->plugins->exec_hook('login_after', $query + array('_task' => 'mail'));
	140	unset($redir['abort'], $redir['_err']);
	141
	142	// send redirect
681ba6	143	$OUTPUT->redirect($redir, 0, true);
7c8fd8	144	}
AM	145	else {
0301d9	146	if (!$auth['valid']) {
AM	147	$error_code = RCMAIL::ERROR_INVALID_REQUEST;
	148	}
	149	else {
b51de3	150	$error_code = is_numeric($auth['error']) ? $auth['error'] : $RCMAIL->login_error();
0301d9	151	}
AM	152
	153	$error_labels = array(
	154	RCMAIL::ERROR_STORAGE => 'storageerror',
	155	RCMAIL::ERROR_COOKIES_DISABLED => 'cookiesdisabled',
	156	RCMAIL::ERROR_INVALID_REQUEST => 'invalidrequest',
	157	RCMAIL::ERROR_INVALID_HOST => 'invalidhost',
a15d87	158	RCMAIL::ERROR_RATE_LIMIT => 'accountlocked',
0301d9	159	);
AM	160
c45507	161	$error_message = !empty($auth['error']) && !is_numeric($auth['error']) ? $auth['error'] : ($error_labels[$error_code] ?: 'loginfailed');
0301d9	162
AM	163	$OUTPUT->show_message($error_message, 'warning');
	164
	165	// log failed login
	166	$RCMAIL->log_login($auth['user'], true, $error_code);
	167
	168	$RCMAIL->plugins->exec_hook('login_failed', array(
	169	'code' => $error_code, 'host' => $auth['host'], 'user' => $auth['user']));
	170
	171	$RCMAIL->kill_session();
7c8fd8	172	}
f11541	173	}
4e17e6	174
681ba6	175	// end session
AM	176	else if ($RCMAIL->task == 'logout' && isset($_SESSION['user_id'])) {
	177	$RCMAIL->request_security_check($mode = rcube_utils::INPUT_GET);
	178
0301d9	179	$userdata = array(
AM	180	'user' => $_SESSION['username'],
	181	'host' => $_SESSION['storage_host'],
	182	'lang' => $RCMAIL->user->language,
	183	);
	184
	185	$OUTPUT->show_message('loggedout');
	186
	187	$RCMAIL->logout_actions();
	188	$RCMAIL->kill_session();
	189	$RCMAIL->plugins->exec_hook('logout_after', $userdata);
f11541	190	}
4e17e6	191
bac7d1	192	// check session and auth cookie
d19a9b	193	else if ($RCMAIL->task != 'login' && $_SESSION['user_id']) {
0301d9	194	if (!$RCMAIL->session->check_auth()) {
AM	195	$RCMAIL->kill_session();
	196	$session_error = true;
	197	}
f11541	198	}
4e17e6	199
T	200	// not logged in -> show login page
197601	201	if (empty($RCMAIL->user->ID)) {
0301d9	202	// log session failures
AM	203	$task = rcube_utils::get_input_value('_task', rcube_utils::INPUT_GPC);
fcc7f8	204
0301d9	205	if ($task && !in_array($task, array('login','logout'))
AM	206	&& !$session_error && ($sess_id = $_COOKIE[ini_get('session.name')])
	207	) {
	208	$RCMAIL->session->log("Aborted session $sess_id; no valid session data found");
	209	$session_error = true;
	210	}
9e54e6	211
8d3d5b	212	if ($session_error \|\| $_REQUEST['_err'] == 'session') {
AM	213	$OUTPUT->show_message('sessionerror', 'error', null, true, -1);
	214	}
	215
7e7e45	216	if ($OUTPUT->ajax_call \|\| $OUTPUT->get_env('framed')) {
8d3d5b	217	$OUTPUT->command('session_error', $RCMAIL->url(array('_err' => 'session')));
AM	218	$OUTPUT->send('iframe');
	219	}
	220
0301d9	221	// check if installer is still active
AM	222	if ($RCMAIL->config->get('enable_installer') && is_readable('./installer/index.php')) {
	223	$OUTPUT->add_footer(html::div(array('style' => "background:#ef9398; border:2px solid #dc5757; padding:0.5em; margin:2em auto; width:50em"),
	224	html::tag('h2', array('style' => "margin-top:0.2em"), "Installer script is still accessible") .
	225	html::p(null, "The install script of your Roundcube installation is still stored in its default location!") .
	226	html::p(null, "Please <b>remove</b> the whole <tt>installer</tt> folder from the Roundcube directory because .
	227	these files may expose sensitive configuration data like server passwords and encryption keys
	228	to the public. Make sure you cannot access the <a href=\"./installer/\">installer script</a> from your browser.")
	229	));
	230	}
1c0ce1	231
0301d9	232	$plugin = $RCMAIL->plugins->exec_hook('unauthenticated', array('task' => 'login', 'error' => $session_error));
AM	233
	234	$RCMAIL->set_task($plugin['task']);
	235
	236	$OUTPUT->send($plugin['task']);
f11541	237	}
249db1	238	else {
681ba6	239	// CSRF prevention
AM	240	$RCMAIL->request_security_check();
d01f9f	241
AM	242	// check access to disabled actions
	243	$disabled_actions = (array) $RCMAIL->config->get('disabled_actions');
	244	if (in_array($RCMAIL->task . '.' . ($RCMAIL->action ?: 'index'), $disabled_actions)) {
	245	rcube::raise_error(array(
	246	'code' => 403, 'type' => 'php',
	247	'message' => "Action disabled"), true, true);
	248	}
249db1	249	}
4e17e6	250
370302	251	// we're ready, user is authenticated and the request is safe
A	252	$plugin = $RCMAIL->plugins->exec_hook('ready', array('task' => $RCMAIL->task, 'action' => $RCMAIL->action));
	253	$RCMAIL->set_task($plugin['task']);
	254	$RCMAIL->action = $plugin['action'];
	255
249db1	256	// handle special actions
48aff9	257	if ($RCMAIL->action == 'keep-alive') {
0301d9	258	$OUTPUT->reset();
AM	259	$RCMAIL->plugins->exec_hook('keep_alive', array());
	260	$OUTPUT->send();
48aff9	261	}
249db1	262	else if ($RCMAIL->action == 'save-pref') {
0301d9	263	include INSTALL_PATH . 'program/steps/utils/save_pref.inc';
249db1	264	}
4e17e6	265
6ea6c9	266
T	267	// include task specific functions
0301d9	268	if (is_file($incfile = INSTALL_PATH . 'program/steps/'.$RCMAIL->task.'/func.inc')) {
AM	269	include_once $incfile;
	270	}
4e17e6	271
6ea6c9	272	// allow 5 "redirects" to another action
T	273	$redirects = 0; $incstep = null;
	274	while ($redirects < 5) {
0301d9	275	// execute a plugin action
a873d9	276	if (preg_match('/^plugin\./', $RCMAIL->action)) {
TB	277	$RCMAIL->plugins->exec_action($RCMAIL->action);
0301d9	278	break;
AM	279	}
a873d9	280	// execute action registered to a plugin task
TB	281	else if ($RCMAIL->plugins->is_plugin_task($RCMAIL->task)) {
	282	if (!$RCMAIL->action) $RCMAIL->action = 'index';
	283	$RCMAIL->plugins->exec_action($RCMAIL->task.'.'.$RCMAIL->action);
0301d9	284	break;
AM	285	}
	286	// try to include the step file
	287	else if (($stepfile = $RCMAIL->get_action_file())
	288	&& is_file($incfile = INSTALL_PATH . 'program/steps/'.$RCMAIL->task.'/'.$stepfile)
	289	) {
	290	// include action file only once (in case it don't exit)
	291	include_once $incfile;
	292	$redirects++;
	293	}
	294	else {
	295	break;
	296	}
6ea6c9	297	}
4e17e6	298
a95687	299	if ($RCMAIL->action == 'refresh') {
0301d9	300	$RCMAIL->plugins->exec_hook('refresh', array('last' => intval(rcube_utils::get_input_value('_last', rcube_utils::INPUT_GPC))));
a95687	301	}
4e17e6	302
6ea6c9	303	// parse main template (default)
197601	304	$OUTPUT->send($RCMAIL->task);
539cd4	305
T	306	// if we arrive here, something went wrong
1aceb9	307	rcmail::raise_error(array(
0301d9	308	'code' => 404,
AM	309	'type' => 'php',
	310	'line' => __LINE__,
	311	'file' => __FILE__,
	312	'message' => "Invalid request"), true, true);