*
* @package SendStudio
* @subpackage SendStudio_Functions
*/
/**
* Include the base sendstudio functions.
*/
require(dirname(__FILE__) . '/sendstudio_functions.php');
/**
* Class for the upgrade process. This will run through all the queries needed to upgrade sendstudio 2004 to sendstudio nx, and change the config file.
*
* @package SendStudio
* @subpackage SendStudio_Functions
*/
class UpgradeNX extends SendStudio_Functions
{
/**
* Constructor
* Just loads the language file.
*/
function UpgradeNX()
{
$this->LoadLanguageFile();
}
/**
* Process
* Works out which step we are up to in the upgrade process and passes it off for the other methods to handle.
*
* @return Void Works out which step you are up to and that's it.
*/
function Process()
{
$user = &GetUser();
if (!$user->Admin()) {
header('Location: index.php');
print 'Click here to continue';
exit();
}
$this->DbPermissionCheck();
$this->DbVersionCheck();
$step = 0;
if (isset($_GET['Step'])) {
$step = (int)$_GET['Step'];
}
if ($step <= 0) {
$step = 0;
}
$handle_step = 'ShowStep_' . $step;
$this->$handle_step();
}
/**
* DbPermissionCheck
* Checks if the database user has sufficient privileges to upgrade and will not allow upgrades to continue if not.
*
* @see DbVersionCheck
*
* @return Void Does not return anything.
*/
function DbPermissionCheck()
{
$db = IEM::getDatabase();
if (IEM_Installer::DbSufficientPrivileges($db)) {
return;
}
$tpl = GetTemplateSystem();
$tpl->Assign('title', 'This Upgrade Cannot Proceed');
$tpl->Assign('msg', '
The database user does not have sufficient privileges to upgrade the database. Please ensure the database user has permission to CREATE, CREATE INDEX, INSERT, SELECT, UPDATE, DELETE, ALTER and DROP.
');
$this->PrintHeader();
$tpl->ParseTemplate('Upgrade_Body');
$this->PrintFooter();
exit();
}
/**
* DbVersionCheck
* Checks if the database version is sufficient to upgrade and will not allow upgrades to continue if not.
*
* @return Void Does not return anything.
*/
function DbVersionCheck()
{
$db = IEM::getDatabase();
$version = $db->Version();
list($error, $msg) = IEM_Installer::DbVersionCheck(SENDSTUDIO_DATABASE_TYPE, $version);
if (!$error) {
return;
}
// See also admin/index.php for a similar message
$tpl = GetTemplateSystem();
$tpl->Assign('title', 'This Upgrade Cannot Proceed');
$tpl->Assign('msg', '
Interspire Email Marketer requires ' . $msg['product'] . ' ' . $msg['req_version'] . ' or above to work properly. Your server is running ' . $msg['version'] . '. To complete the installation, your web host must upgrade ' . $msg['product'] . ' to this version. Please note that this is not a software problem and it is something only your web host can change.
');
$this->PrintHeader();
$tpl->ParseTemplate('Upgrade_Body');
$this->PrintFooter();
exit();
}
/**
* PrintHeader
* This is a modified print-header function which does not include menus etc we need to remove.
* It is based on the popup header and stripped as bare as possible.
*
* @return Void Prints the header out, doesn't return it.
*/
function PrintHeader()
{
$this->ParseTemplate('Upgrade_Header');
}
/**
* PrintFooter
* This is a modified print-footer function.
* It is based on the popup footer and stripped as bare as possible.
*
* @return Void Prints the footer out, doesn't return it.
*/
function PrintFooter()
{
$this->ParseTemplate('Upgrade_Footer');
}
/**
* ShowStep_0
* This works out which upgrades are going to need to run, sets session variables and sets up javascript functionality to process the actions.
*
* @return Void Prints the page out, doesn't return it.
*/
function ShowStep_0()
{
$this->PrintHeader();
$api = $this->GetApi('Settings');
$current_db_version = $api->GetDatabaseVersion();
require(SENDSTUDIO_API_DIRECTORY . '/upgrade.php');
$upgrade_api = new Upgrade_API();
$upgrades_to_run = $upgrade_api->GetUpgradesToRun($current_db_version, SENDSTUDIO_DATABASE_VERSION);
IEM::sessionSet('UpgradesToRun', $upgrades_to_run['upgrades']);
$upgrades_done = array();
IEM::sessionSet('DatabaseUpgradesCompleted', $upgrades_done);
$upgrades_failed = array();
IEM::sessionSet('DatabaseUpgradesFailed', $upgrades_failed);
IEM::sessionSet('TotalSteps', $upgrades_to_run['number_to_run']);
IEM::sessionSet('StepNumber', 1);
IEM::sessionRemove('SendServerDetails');
$previous_version = 'NX1.0';
if (isset($upgrade_api->versions[$current_db_version])) {
$previous_version = $upgrade_api->versions[$current_db_version];
}
IEM::sessionSet('PreviousVersion', $previous_version);
IEM::sessionSet('PreviousDBVersion', $current_db_version);
?>
PrintFooter();
}
/**
* ShowStep_1
* This prints out the "progress report" thickbox window which tells us which upgrade we are up to and how far in the process we are.
*
* @return Void Prints the page out, doesn't return it.
*/
function ShowStep_1()
{
if (isset($_GET['sendServerDetails'])) {
IEM::sessionSet('SendServerDetails', 1);
}
$total_steps = IEM::sessionGet('TotalSteps');
$previous_version = IEM::sessionGet('PreviousVersion');
$variables['ProgressTitle'] = GetLang('UpgradePopup_ProgressTitle');
$variables['ProgressMessage'] = sprintf(GetLang('UpgradePopup_ProgressMessage'), $previous_version, GetLang('SENDSTUDIO_VERSION'));
$variables['ProgressReport'] = '';
$variables['ProgressStatus'] = ' ';
$variables['ProgressURLAction'] = 'index.php?Page=UpgradeNX&Step=2&random=' . uniqid('ss');
$variables['ProcessFinishedURL'] = 'index.php?Page=UpgradeNX&Step=3';
$variables['ProcessFailedURL'] = 'index.php?Page=UpgradeNX&Step=4';
print ''.
'
';
return;
}
/**
* ShowStep_2
* This actually runs an upgrade step and updates the status report (from step1) using javascript.
* If a process fails, then this step immediately takes you to step 4 which prints out the error reports.
*
* @return Void Prints the page out, doesn't return it.
*/
function ShowStep_2()
{
$upgrades_failed = IEM::sessionGet('DatabaseUpgradesFailed');
require(SENDSTUDIO_API_DIRECTORY . '/upgrade.php');
$upgrade_api = new Upgrade_API();
$running_upgrade = $upgrade_api->GetNextUpgrade();
$total_steps = IEM::sessionGet('TotalSteps');
$step_number = IEM::sessionGet('StepNumber');
if (!is_null($running_upgrade)) {
$msg = sprintf(GetLang('Upgrade_Running_StepXofY'), $this->FormatNumber($step_number), $this->FormatNumber($total_steps));
$percent = ceil(($step_number / $total_steps) * 100);
echo "";
flush();
$upgrade_result = $upgrade_api->RunUpgrade($running_upgrade);
$upgrades_done[] = $running_upgrade;
IEM::sessionSet('DatabaseUpgradesCompleted', $upgrades_done);
if (!$upgrade_result) {
$upgrades_failed[] = $upgrade_api->Get('error');
IEM::sessionSet('DatabaseUpgradesFailed', $upgrades_failed);
echo "";
exit;
}
IEM::sessionSet('StepNumber', ($step_number + 1));
// Throw back to this same page to continue the upgrade process
echo "";
exit;
}
echo "";
}
/**
* ShowStep_3
* This prints the "upgrade successful, all ok" message.
* It also calls the server-stats file to notify us of the upgrade and the server info, if the user chose to send it to us.
*
* @return Void Prints the page out, doesn't return it.
*/
function ShowStep_3()
{
$this->PrintHeader();
?>
