<?php
/************************************************************************
 * Mailer v0.2.1-FINAL                                Start: 06/24/2012 *
 * ===================                          Last change: 06/24/2012 *
 *                                                                      *
 * -------------------------------------------------------------------- *
 * File              : ajax_installer.php                               *
 * -------------------------------------------------------------------- *
 * Short description : AJAX-related functions for installer             *
 * -------------------------------------------------------------------- *
 * Kurzbeschreibung  : AJAX-bezogene Funktionen fuer Installer          *
 * -------------------------------------------------------------------- *
 * $Revision::                                                        $ *
 * $Date::                                                            $ *
 * $Tag:: 0.2.1-FINAL                                                 $ *
 * $Author::                                                          $ *
 * -------------------------------------------------------------------- *
 * Copyright (c) 2003 - 2009 by Roland Haeder                           *
 * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
 * For more information visit: http://mxchange.org                      *
 *                                                                      *
 * This program is free software; you can redistribute it and/or modify *
 * it under the terms of the GNU General Public License as published by *
 * the Free Software Foundation; either version 2 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 General Public License for more details.                         *
 *                                                                      *
 * You should have received a copy of the GNU General Public License    *
 * along with this program; if not, write to the Free Software          *
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
 * MA  02110-1301  USA                                                  *
 ************************************************************************/

// Some security stuff...
if (!defined('__SECURITY')) {
	die();
} // END - if

//-----------------------------------------------------------------------------
//             Call-back functions for processing AJAX requests
//-----------------------------------------------------------------------------

// Processes AJAX requests for installer
function doAjaxProcessInstall () {
	// 'do' must always be set and installation phase must be true
	if (!isInstallationPhase()) {
		// This shall not happen
		reportBug(__FUNCTION__, __LINE__, 'This AJAX request handler was called outside the installer.');
	} elseif (!isPostRequestElementSet('do')) {
		// This shall not happen
		reportBug(__FUNCTION__, __LINE__, 'The JavaScript did not send "do" which is fatal.');
	} // END - if

	// Notify all modules that we are installing
	$GLOBALS['__mailer_installing'] =  true;

	// Again we do a call-back, so generate a function name depending on 'do'
	$callbackName = 'doAjaxInstaller' . capitalizeUnderscoreString(postRequestElement('do'));

	// Is the call-back function there?
	if (!function_exists($callbackName)) {
		// This shall not happen
		reportBug(__FUNCTION__, __LINE__, 'AJAX call-back ' . $callbackName . ' does not exist.');
	} // END - if

	// Call the function
	call_user_func($callbackName);

	// Is the status fine or template not found (404)?
	sendAjaxContent();
}

// Processes installer request for testing
function doAjaxInstallerTest () {
	// Load the "test passed" template
	setAjaxReplyContent(loadTemplate('ajax_test_passed', true));

	// All okay if we reach this point
	setHttpStatus('200 OK');
}

// Processes installer requests for footer navigation
function doAjaxInstallerFooterNavigation () {
	// 'tab' must always be set to determine which navigation buttons shall be visible
	if (!isPostRequestElementSet('tab')) {
		// This shall not happen
		reportBug(__FUNCTION__, __LINE__, 'The JavaScript did not send "tab" which is fatal.');
	} // END - if

	// Init array for footer navigation
	$enabledNavigations = array();

	// "Detect" the 'tab' value
	switch (postRequestElement('tab')) {
		case 'base_data': // Also 'previous' is valid
		case 'database_config':
		case 'smtp_config':
		case 'other_config':
			array_push($enabledNavigations, 'previous');
		case 'welcome': // Only 'next' works for welcome page
			array_push($enabledNavigations, 'next');
			break;

		case 'overview': // Enable only 'previous'
			array_push($enabledNavigations, 'previous');
			break;

		default: // Unsupported value
			// This shall not happen
			reportBug(__FUNCTION__, __LINE__, 'Unsupported "tab" value ' . postRequestElement('tab') . ' detected.');

			// This will never be reached
			break;
	} // END - switch

	// Output the array for JSON reply
	setAjaxReplyContent(json_encode($enabledNavigations, JSON_FORCE_OBJECT));

	// All okay if we reach this point
	setHttpStatus('200 OK');
}

// Processes installer AJAX calls for content-requests
function doAjaxInstallerRequestContent () {
	// 'tab' must be there
	if (!isPostRequestElementSet('tab')) {
		// This shall not happen
		reportBug(__FUNCTION__, __LINE__, 'The JavaScript did not send "tab" which is fatal.');
	} // END - if

	// Construct call-back name for value-preset
	$callbackName = 'doAjaxPrepareInstaller' . capitalizeUnderscoreString(postRequestElement('tab'));

	// Is the function there?
	if (function_exists($callbackName)) {
		// Call it for setting values in session
		call_user_func($callbackName);
	} else {
		// Log missing functions
		logDebugMessage(__FUNCTION__, __LINE__, 'Call-back function ' . $callbackName . ' does not exist.');
	}

	// Is the HTTP status still the same? (204 No Content)
	if (getHttpStatus() == '204 No Content') {
		// We use the current access level 'install' as prefix and construct a template name
		setAjaxReplyContent(loadTemplate('install_page_' . trim(postRequestElement('tab')), true));

		// Has the template been loaded?
		if (isset($GLOBALS['tpl_content']['install_page_' . trim(postRequestElement('tab'))])) {
			// All okay if we reach this point
			setHttpStatus('200 OK');
		} else {
			// Set 404 error
			setHttpStatus('404 NOT FOUND');
		}
	} // END - if
}

// Process installer AJAX call for change-warning
function doAjaxInstallerChangeWarning () {
	// 'elements' and 'button' must be there
	if ((!isPostRequestElementSet('elements')) || (!isPostRequestElementSet('button'))) {
		// This shall not happen
		reportBug(__FUNCTION__, __LINE__, 'The JavaScript did not send "elements" and/or "button" which is fatal.');
	} // END - if

	// "Walk" through all elements
	$OUT = '<ol>';
	foreach (explode(':', postRequestElement('elements')) as $element) {
		// Add row
		$OUT .= '<li>{--INSTALLER_CHANGED_ELEMENT_' . strtoupper($element) . '--}</li>';
	} // END - foreach
	$OUT .= '</ol>';

	// Prepare content
	$content = array(
		'out'     => $OUT,
		'button'  => postRequestElement('button'),
		'message' => '{--INSTALLER_TAB_NAVIGATION_' . strtoupper(postRequestElement('button')) . '_LINK--}',
	);

	if (in_array(postRequestElement('button'), array('previous', 'next'))) {
		// Load 'prefixed' template
		setAjaxReplyContent(loadTemplate('install_warning_' . postRequestElement('button'), true, $content));
	} else {
		// Load 'tab' template
		setAjaxReplyContent(loadTemplate('install_warning_tab', true, $content));
	}

	// All okay if we reach this point
	setHttpStatus('200 OK');
}

// Process installer AJAC call for saving changes
function doAjaxInstallerSaveChanges () {
	// 'tab' must always be set to create a post-check-callback
	if (!isPostRequestElementSet('tab')) {
		// This shall not happen
		reportBug(__FUNCTION__, __LINE__, 'The JavaScript did not send "tab" which is fatal.');
	} // END - if

	// Save the tab for pre-"filtering"
	$currentTab = postRequestElement('tab');

	// Remove some elements which should not be saved
	foreach (array('do', 'level') as $removedElement) {
		// Remove this element from POST data
		unsetPostRequestElement($removedElement);
	} // END - foreach

	// Default is failed save attempt (e.g. nothing to save)
	$saveStatus = array(
		'status'        => 'failed',
		'message'       => '{--INSTALLER_SAVE_CHANGES_FAILED--}',
		// Don't set this to false, or else it will be returned as 'failed' but is saved
		'is_saved'      => true,
		'failed_fields' => array()
	);

	// Init overall status
	$isAllSaved = true;

	// Now set all remaining data in session
	foreach (postRequestArray() as $key => $value) {
		// Set it, if it is valid, else it will be added to $saveStatus (call-by-reference)
		$saveStatus['is_saved'] = (
			// Is the data valid?
			(isInstallerDataValid($saveStatus, $key, $value))
		&&
			// And can it be stored in session?
			(setSession($key, $value))
		);

		// Save the overall status for below final check
		$isAllSaved = (($isAllSaved === true) && ($saveStatus['is_saved'] === true));
		//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key . ',value=' . $value . ',is_saved=' . intval($saveStatus['is_saved']) . ',isAllSaved=' . intval($isAllSaved));
	} // END - foreach

	// 'is_saved' is still true?
	if ($isAllSaved === true) {
		// Set 'done' and message
		$saveStatus['status']  = 'done';
		$saveStatus['message'] = '{--INSTALLER_SAVE_CHANGES_DONE--}';

		// Then do the post-check
		doInstallerPostCheck($currentTab, $saveStatus);
	} // END - if

	// Output the status array for JSON reply
	setAjaxReplyContent(json_encode($saveStatus, JSON_FORCE_OBJECT));

	// All okay if we reach this point
	setHttpStatus('200 OK');
}

// Prepare AJAX request 'welcome'
function doAjaxPrepareInstallerWelcome () {
	// Kept empty to prevent logfile entry
}

// Prepare AJAX request 'base_data'
function doAjaxPrepareInstallerBaseData () {
	// Is 'base_path' not set?
	if (!isSessionVariableSet('base_path')) {
		// Then set it from PATH
		setSession('base_path', getPath());
	} // END - if

	// Is 'base_url' not set?
	if (!isSessionVariableSet('base_url')) {
		// Then set it from URL
		setSession('base_url', getUrl());
	} // END - if

	// Is 'main_title' not set?
	if (!isSessionVariableSet('main_title')) {
		// Then set it from default main title
		setSession('main_title', '{--DEFAULT_MAIN_TITLE--}');
	} // END - if

	// Is 'slogan' not set?
	if (!isSessionVariableSet('slogan')) {
		// Then set it from default slogan
		setSession('slogan', '{--DEFAULT_SLOGAN--}');
	} // END - if

	// Is 'webmaster' not set?
	if (!isSessionVariableSet('webmaster')) {
		// Then set it from default webmaster email address
		setSession('webmaster', '{--DEFAULT_WEBMASTER--}');
	} // END - if
}

// Prepare AJAX request 'database_config'
function doAjaxPrepareInstallerDatabaseConfig () {
	// Is 'mysql_host' not set?
	if (!isSessionVariableSet('mysql_host')) {
		// Then set it directly
		setSession('mysql_host', 'localhost');
	} // END - if

	// Is 'mysql_dbase' not set?
	if (!isSessionVariableSet('mysql_dbase')) {
		// Then set it directly
		setSession('mysql_dbase', 'your_database');
	} // END - if

	// Is 'mysql_prefix' not set?
	if (!isSessionVariableSet('mysql_prefix')) {
		// Then set it directly
		setSession('mysql_prefix', 'mailer');
	} // END - if

	// Is 'mysql_login' not set?
	if (!isSessionVariableSet('mysql_login')) {
		// Then set it directly
		setSession('mysql_login', 'your_login');
	} // END - if

	// Is 'mysql_dbase' not set?
	if (!isSessionVariableSet('mysql_pass1')) {
		// Then set it directly
		setSession('mysql_pass1', '');
	} // END - if

	// Is 'mysql_pass2' not set?
	if (!isSessionVariableSet('mysql_pass2')) {
		// Then set it directly
		setSession('mysql_pass2', '');
	} // END - if

	// Is 'mysql_type' not set?
	if (!isSessionVariableSet('mysql_type')) {
		// Then set it directly
		setSession('mysql_type', 'MyISAM');
	} // END - if
}

// Prepare AJAX request 'smtp_config'
function doAjaxPrepareInstallerSmtpConfig () {
	// Kept empty to prevent logfile entry because SMTP settings are optional
}

// Prepare AJAX request 'other_config'
function doAjaxPrepareInstallerOtherConfig () {
	// Is 'output_mode' not set?
	if (!isSessionVariableSet('output_mode')) {
		// Then set it directly
		setSession('output_mode', 'render');
	} // END - if

	// Is 'warn_no_pass' not set?
	if (!isSessionVariableSet('warn_no_pass')) {
		// Then set it directly
		setSession('warn_no_pass', 'Y');
	} // END - if

	// Is 'write_footer' not set?
	if (!isSessionVariableSet('write_footer')) {
		// Then set it directly
		setSession('write_footer', 'Y');
	} // END - if

	// Is 'enable_backlink' not set?
	if (!isSessionVariableSet('enable_backlink')) {
		// Then set it directly
		setSession('enable_backlink', 'Y');
	} // END - if
}

// Prepare AJAX request 'overview'
function doAjaxPrepareInstallerOverview () {
	// 'tab' must always be set to create a post-check-callback
	if (!isPostRequestElementSet('tab')) {
		// This shall not happen
		reportBug(__FUNCTION__, __LINE__, 'The JavaScript did not send "tab" which is fatal.');
	} // END - if

	// Save the tab for pre-"filtering"
	$currentTab = postRequestElement('tab');

	// Default is failed save attempt (e.g. nothing to save)
	$verificationStatus = array(
		// Status code, can be 'failed' or 'done'
		'status'        => 'failed',
		// Status message (e.g. for output)
		'message'       => '{--INSTALLER_OVERVIEW_FINAL_CHECK_FAILED--}',
		// Don't set this to false, or else it will be returned as 'failed' but is saved
		'is_valid'      => true,
		// Failed fields
		'failed_fields' => array()
	);

	// Init overall status and final output
	$isAllValid = true;
	$output     = '';

	// Check all data in session
	foreach (getSessionArray() as $key => $value) {
		// Skip 'mailer_theme', 'tab' and 'installer'
		if (in_array($key, array('mailer_theme', 'tab', 'installer'))) {
			// Skip this
			continue;
		} // END - if

		// Is the data valid?
		$verificationStatus['is_valid'] = (isInstallerDataValid($verificationStatus, $key, $value));

		// Is this step okay?
		if ($verificationStatus['is_valid'] === true) {
			// Add this key/value pair to a overview group
			addKeyValueToInstallerOverviewGroup($key, $value);
		} // END - if

		// Save the overall status for below final check
		//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key . ',value=' . $value . ',is_valid=' . intval($verificationStatus['is_valid']) . ',isAllValid=' . intval($isAllValid));
		$isAllValid = (($isAllValid === true) && ($verificationStatus['is_valid'] === true));
	} // END - foreach

	// Is it still true?
	if ($isAllValid === true) {
		// Set 'done' and message
		$verificationStatus['status']  = 'done';
		$verificationStatus['message'] = '{--INSTALLER_OVERVIEW_FINAL_CHECK_DONE--}';

		// Then do the post-check
		doInstallerPostCheck($currentTab, $verificationStatus);
	} // END - if

	// Is it still valid?
	if ($verificationStatus['status'] != 'done') {
		// Log message away
		logDebugMessage(__FUNCTION__, __LINE__, 'Final check on all stored data failed. message=' . $verificationStatus['message']);

		// Output the array for JSON reply
		setAjaxReplyContent(json_encode($verificationStatus, JSON_FORCE_OBJECT));

		/*
		 * Something went wrong, this might happen when e.g. the user has tried
		 * to save invalid database login data but hit reload button on error
		 * message.
		 */
		setHttpStatus('500 Internal Server Error');

		// Abort here
		return;
	} // END - if

	// Output final rendered content
	setAjaxReplyContent($output);

	// All okay if we reach this point
	setHttpStatus('200 OK');
}

// [EOF]
?>