mirror of
https://github.com/Combodo/iTop.git
synced 2026-02-13 15:34:12 +01:00
286 lines
9.7 KiB
PHP
286 lines
9.7 KiB
PHP
<?php
|
|
// Copyright (C) 2010-2012 Combodo SARL
|
|
//
|
|
// This file is part of iTop.
|
|
//
|
|
// iTop is free software; you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// iTop 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 Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with iTop. If not, see <http://www.gnu.org/licenses/>
|
|
|
|
|
|
/**
|
|
* Emailing: helper for the admins to troubleshoot email issues
|
|
*
|
|
* @copyright Copyright (C) 2010-2012 Combodo SARL
|
|
* @license http://opensource.org/licenses/AGPL-3.0
|
|
*/
|
|
|
|
/**
|
|
* Wizard to configure and initialize the iTop application
|
|
*/
|
|
require_once('../approot.inc.php');
|
|
require_once(APPROOT.'/application/utils.inc.php');
|
|
require_once(APPROOT.'/core/email.class.inc.php');
|
|
require_once('./setuppage.class.inc.php');
|
|
|
|
require_once(APPROOT.'/application/startup.inc.php');
|
|
|
|
require_once(APPROOT.'/application/loginwebpage.class.inc.php');
|
|
LoginWebPage::DoLogin(true); // Check user rights and prompt if needed (must be admin)
|
|
|
|
$sOperation = Utils::ReadParam('operation', 'step1');
|
|
$oP = new SetupPage('iTop email test utility');
|
|
|
|
|
|
/**
|
|
* Helper to check server setting required to send an email
|
|
*/
|
|
function CheckEmailSetting($oP)
|
|
{
|
|
$bRet = true;
|
|
|
|
if (function_exists('php_ini_loaded_file')) // PHP >= 5.2.4
|
|
{
|
|
$sPhpIniFile = php_ini_loaded_file();
|
|
}
|
|
else
|
|
{
|
|
$sPhpIniFile = 'php.ini';
|
|
}
|
|
|
|
$sTransport = MetaModel::GetConfig()->Get('email_transport');
|
|
switch($sTransport)
|
|
{
|
|
case 'PHPMail':
|
|
$oP->info("iTop is configured to use PHP's <a style=\"background:transparent;padding:0;color:#000;text-decoration:underline;\" href=\"http://www.php.net/manual/en/function.mail.php\" target=\"_blank\">mail</a> function to send emails.");
|
|
$bIsWindows = (array_key_exists('WINDIR', $_SERVER) || array_key_exists('windir', $_SERVER));
|
|
if ($bIsWindows)
|
|
{
|
|
$sSmtpServer = ini_get('SMTP');
|
|
if (empty($sSmtpServer))
|
|
{
|
|
$oP->error("The SMTP server is not defined. Please add the 'SMTP' directive into $sPhpIniFile");
|
|
$bRet = false;
|
|
}
|
|
else if (strcasecmp($sSmtpServer, 'localhost') == 0)
|
|
{
|
|
$oP->warning("Your SMTP server is configured to 'localhost'. You might want to set or change the 'SMTP' directive into $sPhpIniFile");
|
|
}
|
|
else
|
|
{
|
|
$oP->info("Your SMTP server: <strong>$sSmtpServer</strong>. To change this value, modify the 'SMTP' directive into $sPhpIniFile");
|
|
}
|
|
|
|
$iSmtpPort = (int) ini_get('smtp_port');
|
|
if (empty($iSmtpPort))
|
|
{
|
|
$oP->info("The SMTP port is not defined. Please add the 'smtp_port' directive into $sPhpIniFile");
|
|
$bRet = false;
|
|
}
|
|
else if ($iSmtpPort == 25)
|
|
{
|
|
$oP->info("Your SMTP port is configured to the default value: 25. You might want to set or change the 'smtp_port' directive into $sPhpIniFile");
|
|
}
|
|
else
|
|
{
|
|
$oP->info("Your SMTP port is configured to $iSmtpPort. You might want to set or change the 'smtp_port' directive into $sPhpIniFile");
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Not a windows system
|
|
$sSendMail = ini_get('sendmail_path');
|
|
if (empty($sSendMail))
|
|
{
|
|
$oP->error("The command to send mail is not defined. Please add the 'sendmail_path' directive into $sPhpIniFile. A recommended setting is <em>sendmail_path=sendmail -t -i</em>");
|
|
$bRet = false;
|
|
}
|
|
else
|
|
{
|
|
$oP->info("The command to send mail is: <strong>$sSendMail</strong>. To change this value, modify the 'sendmail_path' directive into $sPhpIniFile");
|
|
}
|
|
}
|
|
break;
|
|
|
|
case 'SMTP':
|
|
$oP->info("iTop is configured to use the <b>SMTP</b> transport.");
|
|
$sHost = MetaModel::GetConfig()->Get('email_transport_smtp.host');
|
|
$sPort = MetaModel::GetConfig()->Get('email_transport_smtp.port');
|
|
$sEncryption = MetaModel::GetConfig()->Get('email_transport_smtp.encryption');
|
|
$sDisplayEncryption = empty($sEncryption) ? '<em>no encryption</em> ' : $sEncryption;
|
|
$sUserName = MetaModel::GetConfig()->Get('email_transport_smtp.username');
|
|
$sDisplayUserName = empty($sUserName) ? '<em>no user</em> ' : $sUserName;
|
|
$sPassword = MetaModel::GetConfig()->Get('email_transport_smtp.password');
|
|
$sDisplayPassword = empty($sPassword) ? '<em>no password</em> ' : str_repeat('*', strlen($sPassword));
|
|
$oP->info("SMTP configuration (from config-itop.php): host: $sHost, port: $sPort, user: $sDisplayUserName, password: $sDisplayPassword, encryption: $sDisplayEncryption.");
|
|
if (($sHost == 'localhost') && ($sPort == '25') && ($sUserName == '') && ($sPassword == '') )
|
|
{
|
|
$oP->warning("The default settings may not be suitable for your environment. You may want to ajust these values by editing iTop's configuration file (".APPROOT."conf/production/config-itop.php).");
|
|
}
|
|
break;
|
|
|
|
case 'Null':
|
|
$oP->warning("iTop is configured to use the <b>Null</b> transport: emails sending will have no effect.");
|
|
$bRet = false;
|
|
break;
|
|
|
|
case 'LogFile':
|
|
$oP->warning("iTop is configured to use the <b>LogFile</b> transport: emails will <em>not</em> be sent but logged to the file: '".APPROOT."/log/mail.log'.");
|
|
$bRet = true;
|
|
break;
|
|
|
|
default:
|
|
$oP->error("Unknown transport '$sTransport' configured.");
|
|
$bRet = false;
|
|
}
|
|
if ($bRet)
|
|
{
|
|
$oP->ok("PHP settings are ok to proceed with a test of the email");
|
|
}
|
|
$bConfigAsync = MetaModel::GetConfig()->Get('email_asynchronous');
|
|
if ($bConfigAsync)
|
|
{
|
|
$oP->warning("iTop is configured to send emails <em>asynchronously</em>. Make sure that cron.php is scheduled to run in the background, otherwise regular emails will <em>not</em> be sent. For the purpose of this test, the email will be sent <em>synchronously</em>.");
|
|
}
|
|
|
|
return $bRet;
|
|
}
|
|
|
|
|
|
/**
|
|
* Display the form for the first step of the test wizard
|
|
* which consists in a basic check of the configuration and display of a form for testing
|
|
*/
|
|
function DisplayStep1(SetupPage $oP)
|
|
{
|
|
$sNextOperation = 'step2';
|
|
$oP->add("<h1>iTop email test</h1>\n");
|
|
$oP->add("<h2>Checking prerequisites</h2>\n");
|
|
if (CheckEmailSetting($oP))
|
|
{
|
|
$sRedStar = '<span class="hilite">*</span>';
|
|
$oP->add("<h2>Try to send an email</h2>\n");
|
|
$oP->add("<form method=\"post\" onSubmit=\"return DoSubmit('Sending an email...', 10)\">\n");
|
|
// Form goes here
|
|
$oP->add("<fieldset><legend>Test recipient</legend>\n");
|
|
$aForm = array();
|
|
$aForm[] = array(
|
|
'label' => "To$sRedStar:",
|
|
'input' => "<input id=\"to\" type=\"text\" name=\"to\" value=\"\">",
|
|
'help' => ' email address (e.g. john.foo@worldcompany.com)',
|
|
);
|
|
$aForm[] = array(
|
|
'label' => "From:",
|
|
'input' => "<input id=\"from\" type=\"text\" name=\"from\" value=\"\">",
|
|
'help' => ' defaults to the configuration param "email_default_sender_address" or "To" field.',
|
|
);
|
|
$oP->form($aForm);
|
|
$oP->add("</fieldset>\n");
|
|
$oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
|
|
$oP->add("<div>\n");
|
|
$oP->add("<button style=\"float:left\" type=\"button\" onclick=\"window.location.reload()\">Refresh</button>\n");
|
|
$oP->add("<button style=\"float:right\" type=\"submit\">Next >></button>\n");
|
|
$oP->add("<div style=\"clear:both;\"></div>\n");
|
|
$oP->add("</div>\n");
|
|
$oP->add("</form>\n");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Display the form for the second step of the configuration wizard
|
|
* which consists in sending an email, which maybe a problem under Windows
|
|
*/
|
|
function DisplayStep2(SetupPage $oP, $sFrom, $sTo)
|
|
{
|
|
//$sNextOperation = 'step3';
|
|
$oP->add("<h1>iTop configuration wizard</h1>\n");
|
|
$oP->add("<h2>Step 2: send an email</h2>\n");
|
|
$oP->add("<p>Sending an email to '".htmlentities($sTo, ENT_QUOTES, 'utf-8')."'... (From: '".htmlentities($sFrom, ENT_QUOTES, 'utf-8')."')</p>\n");
|
|
$oP->add("<form method=\"post\">\n");
|
|
|
|
$oEmail = new Email();
|
|
$oEmail->SetRecipientTO($sTo);
|
|
$oEmail->SetRecipientFrom($sFrom);
|
|
$oEmail->SetSubject("Test iTop");
|
|
$oEmail->SetBody("<p>Hello,</p><p>The email function is now working fine.</p><p>You may now be able to use the notification function.</p><p>iTop</p>");
|
|
$iRes = $oEmail->Send($aIssues, true /* force synchronous exec */);
|
|
switch ($iRes)
|
|
{
|
|
case EMAIL_SEND_OK:
|
|
$sTransport = MetaModel::GetConfig()->Get('email_transport');
|
|
if ($sTransport == 'LogFile')
|
|
{
|
|
$oP->ok("The email has been logged into the file ".APPROOT."/log/mail.log.");
|
|
}
|
|
else
|
|
{
|
|
$oP->ok("The email has been sent, check your inbox for the incoming mail...");
|
|
}
|
|
$oP->add("<button onClick=\"window.history.back();\"><< Back</button>\n");
|
|
break;
|
|
|
|
case EMAIL_SEND_PENDING:
|
|
$oP->ok("Email queued");
|
|
$oP->add("<button onClick=\"window.history.back();\"><< Back</button>\n");
|
|
break;
|
|
|
|
case EMAIL_SEND_ERROR:
|
|
foreach ($aIssues as $sError)
|
|
{
|
|
$oP->error(htmlentities($sError, ENT_QUOTES, 'utf-8'));
|
|
}
|
|
$oP->add("<button onClick=\"window.history.back();\"><< Back</button>\n");
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Main program
|
|
*/
|
|
|
|
// #@# Init default timezone -> do not get a notice... to be improved !!!
|
|
// duplicated from 'attributedef.class.inc.php', needed here because mail() does
|
|
// generate a notice
|
|
date_default_timezone_set('Europe/Paris');
|
|
|
|
|
|
try
|
|
{
|
|
switch($sOperation)
|
|
{
|
|
case 'step1':
|
|
DisplayStep1($oP);
|
|
break;
|
|
|
|
case 'step2':
|
|
$oP->no_cache();
|
|
$sTo = Utils::ReadParam('to', '', false, 'raw_data');
|
|
$sFrom = Utils::ReadParam('from', '', false, 'raw_data');
|
|
DisplayStep2($oP, $sFrom, $sTo);
|
|
break;
|
|
|
|
default:
|
|
$oP->error("Error: unsupported operation '$sOperation'");
|
|
|
|
}
|
|
}
|
|
catch(Exception $e)
|
|
{
|
|
$oP->error("Error: '".htmlentities($e->getMessage(), ENT_QUOTES, 'utf-8')."'");
|
|
}
|
|
catch(CoreException $e)
|
|
{
|
|
$oP->error("Error: '".$e->getHtmlDesc()."'");
|
|
}
|
|
$oP->output();
|
|
?>
|