sydney/IPB
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Version 5.0.0 release

Browse Source
This commit is contained in:
Neo committed 2025-12-19 18:37:58 -08:00
1 parent 90e8c7e903
commit a3a4a9ccbd
651 files changed
+7275 -9481
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

applications/core/modules/admin/settings/email.php
+100 -96
View File
@@ -10,25 +10,17 @@
namespace IPS\core\modules\admin\settings;
/* To prevent PHP errors (extending class does not exist) revealing path */
use DateInterval;
use Exception;
use IPS\core\AdminNotification;
use IPS\DateTime;
use IPS\Db;
use IPS\Dispatcher;
use IPS\Dispatcher\Controller;
use IPS\Email as EmailClass;
use IPS\File;
use IPS\Helpers\Form;
use IPS\Helpers\Form\Color;
use IPS\Helpers\Form\Email as FormEmail;
use IPS\Helpers\Form\Interval;
use IPS\Helpers\Form\Number;
use IPS\Helpers\Form\Password;
use IPS\Helpers\Form\Radio;
use IPS\Helpers\Form\Select;
use IPS\Helpers\Form\Text;
use IPS\Helpers\Form\TextArea;
use IPS\Helpers\Form\Upload;
@@ -41,23 +33,20 @@ use IPS\Request;
use IPS\Session;
use IPS\Settings;
use IPS\Theme;
use function defined;
use function get_class;
use function is_string;
use const IPS\CIC;
use const IPS\DEMO_MODE;
use const IPS\Helpers\Table\SEARCH_CONTAINS_TEXT;
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* email
*/
class email extends Controller
class email extends \IPS\Dispatcher\Controller
{
/**
* @brief Has been CSRF-protected
@@ -87,12 +76,11 @@ class email extends Controller
$settingsForm = new Form( 'settings_form' );
$settingsForm->addHeader( 'basic_settings' );
$settingsForm->add( new FormEmail( 'email_out', Settings::i()->email_out, TRUE, array(), NULL, NULL, NULL, 'email_out' ) );
$settingsForm->add( new FormEmail( 'email_out', Settings::i()->email_out, TRUE, [], NULL, NULL, NULL, 'email_out' ) );
$settingsForm->add( new FormEmail( 'email_in', Settings::i()->email_in, TRUE ) );
$settingsForm->add( new Color( 'email_color', Settings::i()->email_color, TRUE ) );
$settingsForm->add( new Upload( 'email_logo', Settings::i()->email_logo ? File::get( 'core_Theme', Settings::i()->email_logo ) : NULL, FALSE, array( 'image' => TRUE, 'storageExtension' => 'core_Theme' ) ) );
$settingsForm->add( new YesNo( 'social_links_in_email', Settings::i()->social_links_in_email, FALSE, array(), NULL, NULL, NULL, 'social_links_in_email' ) );
$settingsForm->add( new YesNo( 'our_picks_in_email', Settings::i()->our_picks_in_email, FALSE, array(), NULL, NULL, NULL, 'our_picks_in_email' ) );
$settingsForm->add( new Upload( 'email_logo', Settings::i()->email_logo ? File::get( 'core_Theme', Settings::i()->email_logo ) : NULL, FALSE, [ 'image' => TRUE, 'storageExtension' => 'core_Theme' ] ) );
$settingsForm->add( new YesNo( 'social_links_in_email', Settings::i()->social_links_in_email, FALSE, [], NULL, NULL, NULL, 'social_links_in_email' ) );
$settingsForm->add( new YesNo( 'email_truncate', ( Settings::i()->email_truncate ), FALSE, array(), NULL, NULL, NULL, 'email_truncate' ) );
@@ -101,10 +89,10 @@ class email extends Controller
if ( !DEMO_MODE )
{
$settingsForm->addHeader( 'advanced_settings' );
$method = Settings::i()->mail_method;
$disabled = array();
$disabled = [];
if ( Settings::i()->sendgrid_api_key AND Settings::i()->sendgrid_use_for > 0 )
{
if ( Settings::i()->sendgrid_use_for == 2 )
@@ -116,30 +104,56 @@ class email extends Controller
{
$disabled[] = 'sendgrid';
}
/* We previously renamed this to 'php' */
if( $method == 'mail' )
{
$method = 'php';
}
$settingsForm->add( new Radio( 'mail_method', $method, TRUE, array(
'options' => array( 'php' => ( CIC ? 'mail_method_cic' : 'mail_method_php' ), 'smtp' => 'mail_method_smtp', 'sendgrid' => 'mail_method_sendgrid' ),
'disabled' => $disabled,
'toggles' => array(
'php' => array( 'php_mail_extra' ),
'smtp' => array( 'smtp_host', 'smtp_port', 'smtp_user', 'smtp_pass', 'smtp_helo', 'smtp_protocol' ),
)
) ) );
$options = array( 'plain' => 'smtp_plaintext', 'ssl' => 'smtp_ssl', 'tls' => 'smtp_tls' );
$settingsForm->add( new Text( 'smtp_host', Settings::i()->smtp_host, FALSE, array(), NULL, NULL, NULL, 'smtp_host' ) );
$settingsForm->add( new Select( 'smtp_protocol', Settings::i()->smtp_protocol, FALSE, array( 'options' => $options ), NULL, NULL, NULL, 'smtp_protocol' ) );
$settingsForm->add( new Number( 'smtp_port', Settings::i()->smtp_port, FALSE, array(), NULL, NULL, NULL, 'smtp_port' ) );
$settingsForm->add( new Text( 'smtp_user', Settings::i()->smtp_user, FALSE, array(), NULL, NULL, NULL, 'smtp_user' ) );
$settingsForm->add( new Password( 'smtp_pass', Settings::i()->smtp_pass, FALSE, array( 'enforceMaxLimit' => FALSE ), NULL, NULL, NULL, 'smtp_pass' ) );
if ( !CIC )
$debug = FALSE;
if( EmailClass::classToUse( EmailClass::TYPE_TRANSACTIONAL ) == 'IPS\\Email\\Outgoing\\Debug' )
{
$settingsForm->add( new Text( 'php_mail_extra', Settings::i()->php_mail_extra, FALSE, array(), NULL, NULL, NULL, 'php_mail_extra' ) );
$debug = true;
$method = 'debug';
}
$mailOptions = $toggles = $fields = [];
foreach( EmailClass::outgoingHandlers() as $key => $handler )
{
if( ! $handler::isUsable( EmailClass::TYPE_TRANSACTIONAL ) )
{
continue;
}
$mailOptions[ $key ] = 'mail_method_' . $key;
$formFields = $handler::form();
$toggles[ $key ] = array_keys( $formFields );
$fields = $fields + $formFields;
}
/* Change value back to default for platform */
if( !\in_array( $method, array_keys( $mailOptions ) ) )
{
$method = \IPS\CIC ? 'cloud' : 'php';
}
if( !$debug )
{
$settingsForm->add( new Radio( 'mail_method', $method, TRUE, [
'options' => $mailOptions,
'disabled' => $disabled,
'toggles' => $toggles
] ) );
foreach( $fields as $f )
{
$settingsForm->add( $f );
}
}
else
{
$settingsForm->addDummy( 'mail_method', Member::loggedIn()->language()->addToStack('mail_method_debug', false, [ 'sprintf' => [ \IPS\EMAIL_DEBUG_PATH ] ] ) );
}
}
if ( $values = $settingsForm->values() )
@@ -160,14 +174,11 @@ class email extends Controller
}
unset( $values['email_log_do'] );
if ( $values['mail_method'] != 'sendgrid' and Settings::i()->sendgrid_use_for == 2 )
/* Allow individual handlers to save settings */
foreach( EmailClass::outgoingHandlers() as $key => $handler )
{
$values['sendgrid_use_for'] = 1;
}
elseif ( $values['mail_method'] == 'sendgrid' )
{
$values['sendgrid_use_for'] = 2;
$values = $handler::processSettings( $values );
}
if ( $values['email_logo'] )
@@ -180,31 +191,27 @@ class email extends Controller
if( $sendTestEmail )
{
$email = EmailClass::buildFromContent( Member::loggedIn()->language()->get('email_test_subject'), Member::loggedIn()->language()->addToStack('email_test_message'), Member::loggedIn()->language()->addToStack('email_test_message'), EmailClass::TYPE_BULK );
$email = EmailClass::buildFromContent( Member::loggedIn()->language()->get('email_test_subject'), Member::loggedIn()->language()->addToStack('email_test_message'), Member::loggedIn()->language()->addToStack('email_test_message'), EmailClass::TYPE_BULK );
try
{
$result = $email->send( to: Member::loggedIn(), fromEmail: Settings::i()->email_out, returnException: TRUE );
if( $result )
{
$messageHtml = Theme::i()->getTemplate( 'global', 'core', 'global' )->message( 'email_test_okay_auto', 'success' );
}
$email->_send( Member::loggedIn(), fromEmail: Settings::i()->email_out );
$messageHtml = Theme::i()->getTemplate( 'global', 'core', 'global' )->message( 'email_test_okay_auto', 'success' );
/* Sent successfully, remove notification */
AdminNotification::remove( 'core', 'ConfigurationError', 'failedMail' );
Db::i()->update( 'core_mail_error_logs', array( 'mlog_notification_sent' => TRUE ) );
Db::i()->update( 'core_mail_error_logs', [ 'mlog_notification_sent' => TRUE ] );
}
catch ( Exception $e )
catch ( \Exception $e )
{
$messageHtml = Theme::i()->getTemplate( 'global', 'core', 'global' )->message( $e->getMessage() ?: 'email_test_error_auto', 'error', $e->getMessage() );
$messageHtml = Theme::i()->getTemplate( 'global', 'core', 'global' )->message( 'email_test_error_auto', 'error', $e->getMessage() );
}
}
}
/* Build the test form */
$testFormHtml = '';
if ( !DEMO_MODE AND Member::loggedIn()->hasAcpRestriction( 'core', 'settings', 'email_test' ) )
if ( !DEMO_MODE AND Member::loggedIn()->hasAcpRestriction( 'core', 'settings', 'email_test' ) )
{
Output::i()->sidebar['actions']['test'] = array(
'title' => 'email_test',
@@ -212,7 +219,7 @@ class email extends Controller
'link' => Url::internal( '#testForm' ),
'data' => array( 'ipsDialog' => '', 'ipsDialog-title' => Member::loggedIn()->language()->addToStack('email_test'), 'ipsDialog-content' => '#testForm' )
);
$testForm = new Form( 'test_form' );
$testForm->add( new FormEmail( 'from', Settings::i()->email_out, TRUE ) );
$testForm->add( new FormEmail( 'to', Member::loggedIn()->email, TRUE ) );
@@ -222,32 +229,29 @@ class email extends Controller
{
try
{
$email = EmailClass::buildFromContent( $values['subject'], $values['message'], $values['message'], EmailClass::TYPE_BULK );
$result = $email->send( to: $values['to'], fromEmail: $values['from'], returnException: TRUE );
$email = EmailClass::buildFromContent( $values['subject'], $values['message'], $values['message'], EmailClass::TYPE_BULK );
$email->_send( $values['to'], fromEmail: $values['from'] );
/* Sent successfully, remove notification */
AdminNotification::remove( 'core', 'ConfigurationError', 'failedMail' );
Db::i()->update( 'core_mail_error_logs', array( 'mlog_notification_sent' => TRUE ) );
if( $result )
{
$messageHtml = Theme::i()->getTemplate( 'global', 'core', 'global' )->message( 'email_test_okay', 'success' );
}
$messageHtml = Theme::i()->getTemplate( 'global', 'core', 'global' )->message( 'email_test_okay', 'success' );
}
catch ( Exception $exception )
catch ( \Exception $exception )
{
$content = $exception->getMessage();
if ( !( $exception instanceof \IPS\Email\Outgoing\Exception ) )
{
$content = get_class( $exception ) . ": " . $exception->getMessage() . " (" . $exception->getCode() . ")";
$content = \get_class( $exception ) . ": " . $exception->getMessage() . " (" . $exception->getCode() . ")";
}
$messageHtml = Theme::i()->getTemplate( 'global', 'core', 'global' )->message( $content, 'error' );
$messageHtml = Theme::i()->getTemplate( 'global', 'core', 'global' )->message( $content ?: 'email_test_error_auto', 'error' );
}
}
$testFormHtml = Theme::i()->getTemplate( 'global' )->block( 'email_test', $testForm, FALSE, 'ipsJS_hide', 'testForm' );
}
/* Add a button for logs */
if ( Member::loggedIn()->hasAcpRestriction( 'core', 'settings', 'email_errorlog' ) )
{
@@ -257,14 +261,14 @@ class email extends Controller
'link' => Url::internal( 'app=core&module=settings&controller=email&do=errorLog' ),
);
}
/* Display */
Output::i()->title = Member::loggedIn()->language()->addToStack('email_settings');
Output::i()->title = Member::loggedIn()->language()->addToStack('email_settings');
Output::i()->output = $messageHtml;
Output::i()->output .= Theme::i()->getTemplate( 'global' )->block( 'email_settings', $settingsForm );
Output::i()->output .= $testFormHtml;
}
/**
* Error Log
*
@@ -273,7 +277,7 @@ class email extends Controller
protected function errorLog() : void
{
Dispatcher::i()->checkAcpPermission( 'email_errorlog' );
/* Add a button for settings */
if ( Member::loggedIn()->hasAcpRestriction( 'core', 'settings', 'email_errorlog_prune' ) )
{
@@ -291,7 +295,7 @@ class email extends Controller
Output::i()->title = Member::loggedIn()->language()->addToStack('emailerrorlogs');
Output::i()->output = (string) static::emailErrorLogTable( Url::internal( 'app=core&module=settings&controller=email&do=errorLog' ) );
}
/**
* Get email error log table
*
@@ -304,7 +308,7 @@ class email extends Controller
/* Create the table */
$table = new TableDb( 'core_mail_error_logs', $url, $where );
$table->langPrefix = 'emailerrorlogs_';
/* Columns we need */
$table->include = array( 'mlog_to', 'mlog_subject', 'mlog_date', 'mlog_msg' );
$table->rowClasses = array( 'mlog_subject' => array( 'ipsTable_wrap' ), 'mlog_msg' => array( 'ipsTable_wrap' ) );
@@ -312,20 +316,20 @@ class email extends Controller
$table->sortBy = $table->sortBy ?: 'mlog_date';
$table->sortDirection = $table->sortDirection ?: 'DESC';
$table->noSort = array( 'mlog_msg' );
/* Search */
$table->quickSearch = 'mlog_to';
$table->advancedSearch = array(
'mlog_to' => SEARCH_CONTAINS_TEXT,
'mlog_from' => SEARCH_CONTAINS_TEXT,
'mlog_subject' => SEARCH_CONTAINS_TEXT,
'mlog_msg' => SEARCH_CONTAINS_TEXT,
'mlog_content' => SEARCH_CONTAINS_TEXT,
'mlog_to' => SEARCH_CONTAINS_TEXT,
'mlog_from' => SEARCH_CONTAINS_TEXT,
'mlog_subject' => SEARCH_CONTAINS_TEXT,
'mlog_msg' => SEARCH_CONTAINS_TEXT,
'mlog_content' => SEARCH_CONTAINS_TEXT,
);
/* Custom parsers */
$table->parsers = array(
'mlog_date' => function( $val )
'mlog_date' => function( $val, $row )
{
return DateTime::ts( $val );
},
@@ -342,7 +346,7 @@ class email extends Controller
/* We may not have a 'message' key if this is an older SendGrid log entry */
if( isset( $data['message'] ) )
{
$val = is_string( $data['message'] ) ?
$val = \is_string( $data['message'] ) ?
( ( isset( $data['details'] ) AND $data['details'] ) ? Member::loggedIn()->language()->addToStack( $data['message'], FALSE, array( 'sprintf' => $data['details'] ) ) : Member::loggedIn()->language()->addToStack( $data['message'] ) ) :
$val;
}
@@ -378,7 +382,7 @@ class email extends Controller
return $return;
};
/* Return */
return $table;
}
@@ -392,11 +396,11 @@ class email extends Controller
{
Dispatcher::i()->checkAcpPermission( 'email_errorlog' );
Session::i()->csrfCheck();
$id = (int) Request::i()->id;
$log = Db::i()->select( '*', 'core_mail_error_logs', array( 'mlog_id=?', $id ) )->first();
$emailData = json_decode( $log['mlog_resend_data'], true );
try
{
$fromName = NULL;
@@ -409,8 +413,8 @@ class email extends Controller
unset( $emailData['headers']['MIME-Version'] );
unset( $emailData['headers']['Content-Type'] );
unset( $emailData['headers']['Content-Transfer-Encoding'] );
$email = EmailClass::buildFromContent( $log['mlog_subject'], $emailData['body']['html'], $emailData['body']['plain'], $emailData['type'] ?? EmailClass::TYPE_TRANSACTIONAL );
$email = EmailClass::buildFromContent( $log['mlog_subject'], $emailData['body']['html'], $emailData['body']['plain'], isset( $emailData['type'] ) ? $emailData['type'] : EmailClass::TYPE_TRANSACTIONAL );
$email->_send(
array_map( 'trim', explode( ',', $log['mlog_to'] ) ),
isset( $emailData['headers']['Cc'] ) ? array_map( 'trim', explode( ',', $emailData['headers']['Cc'] ) ) : array(),
@@ -420,7 +424,7 @@ class email extends Controller
$emailData['headers']
);
}
catch( Exception $e )
catch( \Exception $e )
{
Output::i()->error( $e->getMessage(), '4C143/1', 500, '' );
}
@@ -428,7 +432,7 @@ class email extends Controller
Db::i()->delete( 'core_mail_error_logs', array( 'mlog_id=?', $id ) );
/* Remove notification since this was re-sent with success and it is below the recent threshold */
if( EmailClass::countFailedMail( DateTime::create()->sub( new DateInterval( 'P3D' ) ), FALSE, TRUE ) <= 3 )
if( EmailClass::countFailedMail( DateTime::create()->sub( new \DateInterval( 'P3D' ) ), FALSE, TRUE ) <= 3 )
{
AdminNotification::remove( 'core', 'ConfigurationError', 'failedMail' );
Db::i()->update( 'core_mail_error_logs', array( 'mlog_notification_sent' => TRUE ), array( 'mlog_id=?', $id ) );
@@ -445,7 +449,7 @@ class email extends Controller
public function errorLogView() : void
{
Dispatcher::i()->checkAcpPermission( 'email_errorlog' );
$id = (int) Request::i()->id;
$log = Db::i()->select( '*', 'core_mail_error_logs', array( 'mlog_id=?', $id ) )->first();
@@ -460,17 +464,17 @@ class email extends Controller
protected function errorLogSettings() : void
{
Dispatcher::i()->checkAcpPermission( 'email_errorlog_prune' );
$form = new Form;
$form->add( new Interval( 'prune_log_email_error', Settings::i()->prune_log_email_error, FALSE, array( 'valueAs' => Interval::DAYS, 'unlimited' => 0, 'unlimitedLang' => 'never' ), NULL, Member::loggedIn()->language()->addToStack('after'), NULL, 'prune_log_email_error' ) );
if ( $values = $form->values() )
{
$form->saveAsSettings();
Session::i()->log( 'acplog__emailerrorlog_settings' );
Output::i()->redirect( Url::internal( 'app=core&module=settings&controller=email&do=errorLog' ), 'saved' );
}
Output::i()->title = Member::loggedIn()->language()->addToStack('emailerrorlogssettings');
Output::i()->output = Theme::i()->getTemplate('global')->block( 'emailerrorlogssettings', $form, FALSE );
}