From edff34b548db49e94db2b6548adc95cc6001dcf5 Mon Sep 17 00:00:00 2001 From: yehudah Date: Sun, 15 Oct 2017 06:46:12 +0000 Subject: release git-svn-id: https://plugins.svn.wordpress.org/post-smtp/trunk@1746635 b8457f37-d9ea-0310-8a92-e5e31aec5664 --- .../PostmanRegisterConfigurationSettings.php | 407 +++++++++++++++++++++ 1 file changed, 407 insertions(+) create mode 100644 Postman/Postman-Configuration/PostmanRegisterConfigurationSettings.php (limited to 'Postman/Postman-Configuration/PostmanRegisterConfigurationSettings.php') diff --git a/Postman/Postman-Configuration/PostmanRegisterConfigurationSettings.php b/Postman/Postman-Configuration/PostmanRegisterConfigurationSettings.php new file mode 100644 index 0000000..c1a42a2 --- /dev/null +++ b/Postman/Postman-Configuration/PostmanRegisterConfigurationSettings.php @@ -0,0 +1,407 @@ +options = PostmanOptions::getInstance(); + } + + /** + * Fires on the admin_init method + */ + public function on_admin_init() { + // + $this->registerSettings (); + } + + /** + * Register and add settings + */ + private function registerSettings() { + + // only administrators should be able to trigger this + if (PostmanUtils::isAdmin ()) { + // + $sanitizer = new PostmanInputSanitizer (); + register_setting ( PostmanAdminController::SETTINGS_GROUP_NAME, PostmanOptions::POSTMAN_OPTIONS, array ( + $sanitizer, + 'sanitize' + ) ); + + // Sanitize + add_settings_section ( 'transport_section', __ ( 'Transport', Postman::TEXT_DOMAIN ), array ( + $this, + 'printTransportSectionInfo' + ), 'transport_options' ); + + add_settings_field ( PostmanOptions::TRANSPORT_TYPE, _x ( 'Type', '(i.e.) What kind is it?', Postman::TEXT_DOMAIN ), array ( + $this, + 'transport_type_callback' + ), 'transport_options', 'transport_section' ); + + // the Message From section + add_settings_section ( PostmanAdminController::MESSAGE_FROM_SECTION, _x ( 'From Address', 'The Message Sender Email Address', Postman::TEXT_DOMAIN ), array ( + $this, + 'printMessageFromSectionInfo' + ), PostmanAdminController::MESSAGE_FROM_OPTIONS ); + + add_settings_field ( PostmanOptions::MESSAGE_SENDER_EMAIL, __ ( 'Email Address', Postman::TEXT_DOMAIN ), array ( + $this, + 'from_email_callback' + ), PostmanAdminController::MESSAGE_FROM_OPTIONS, PostmanAdminController::MESSAGE_FROM_SECTION ); + + add_settings_field ( PostmanOptions::PREVENT_MESSAGE_SENDER_EMAIL_OVERRIDE, '', array ( + $this, + 'prevent_from_email_override_callback' + ), PostmanAdminController::MESSAGE_FROM_OPTIONS, PostmanAdminController::MESSAGE_FROM_SECTION ); + + add_settings_field ( PostmanOptions::MESSAGE_SENDER_NAME, __ ( 'Name', Postman::TEXT_DOMAIN ), array ( + $this, + 'sender_name_callback' + ), PostmanAdminController::MESSAGE_FROM_OPTIONS, PostmanAdminController::MESSAGE_FROM_SECTION ); + + add_settings_field ( PostmanOptions::PREVENT_MESSAGE_SENDER_NAME_OVERRIDE, '', array ( + $this, + 'prevent_from_name_override_callback' + ), PostmanAdminController::MESSAGE_FROM_OPTIONS, PostmanAdminController::MESSAGE_FROM_SECTION ); + + // the Additional Addresses section + add_settings_section ( PostmanAdminController::MESSAGE_SECTION, __ ( 'Additional Email Addresses', Postman::TEXT_DOMAIN ), array ( + $this, + 'printMessageSectionInfo' + ), PostmanAdminController::MESSAGE_OPTIONS ); + + add_settings_field ( PostmanOptions::REPLY_TO, __ ( 'Reply-To', Postman::TEXT_DOMAIN ), array ( + $this, + 'reply_to_callback' + ), PostmanAdminController::MESSAGE_OPTIONS, PostmanAdminController::MESSAGE_SECTION ); + + add_settings_field ( PostmanOptions::FORCED_TO_RECIPIENTS, __ ( 'To Recipient(s)', Postman::TEXT_DOMAIN ), array ( + $this, + 'to_callback' + ), PostmanAdminController::MESSAGE_OPTIONS, PostmanAdminController::MESSAGE_SECTION ); + + add_settings_field ( PostmanOptions::FORCED_CC_RECIPIENTS, __ ( 'Carbon Copy Recipient(s)', Postman::TEXT_DOMAIN ), array ( + $this, + 'cc_callback' + ), PostmanAdminController::MESSAGE_OPTIONS, PostmanAdminController::MESSAGE_SECTION ); + + add_settings_field ( PostmanOptions::FORCED_BCC_RECIPIENTS, __ ( 'Blind Carbon Copy Recipient(s)', Postman::TEXT_DOMAIN ), array ( + $this, + 'bcc_callback' + ), PostmanAdminController::MESSAGE_OPTIONS, PostmanAdminController::MESSAGE_SECTION ); + + // the Additional Headers section + add_settings_section ( PostmanAdminController::MESSAGE_HEADERS_SECTION, __ ( 'Additional Headers', Postman::TEXT_DOMAIN ), array ( + $this, + 'printAdditionalHeadersSectionInfo' + ), PostmanAdminController::MESSAGE_HEADERS_OPTIONS ); + + add_settings_field ( PostmanOptions::ADDITIONAL_HEADERS, __ ( 'Custom Headers', Postman::TEXT_DOMAIN ), array ( + $this, + 'headers_callback' + ), PostmanAdminController::MESSAGE_HEADERS_OPTIONS, PostmanAdminController::MESSAGE_HEADERS_SECTION ); + + // the Email Validation section + add_settings_section ( PostmanAdminController::EMAIL_VALIDATION_SECTION, __ ( 'Validation', Postman::TEXT_DOMAIN ), array ( + $this, + 'printEmailValidationSectionInfo' + ), PostmanAdminController::EMAIL_VALIDATION_OPTIONS ); + + add_settings_field ( PostmanOptions::ENVELOPE_SENDER, __ ( 'Email Address', Postman::TEXT_DOMAIN ), array ( + $this, + 'disable_email_validation_callback' + ), PostmanAdminController::EMAIL_VALIDATION_OPTIONS, PostmanAdminController::EMAIL_VALIDATION_SECTION ); + + // the Logging section + add_settings_section ( PostmanAdminController::LOGGING_SECTION, __ ( 'Email Log Settings', Postman::TEXT_DOMAIN ), array ( + $this, + 'printLoggingSectionInfo' + ), PostmanAdminController::LOGGING_OPTIONS ); + + add_settings_field ( 'logging_status', __ ( 'Enable Logging', Postman::TEXT_DOMAIN ), array ( + $this, + 'loggingStatusInputField' + ), PostmanAdminController::LOGGING_OPTIONS, PostmanAdminController::LOGGING_SECTION ); + + add_settings_field ( 'logging_max_entries', __ ( 'Maximum Log Entries', 'Configuration Input Field', Postman::TEXT_DOMAIN ), array ( + $this, + 'loggingMaxEntriesInputField' + ), PostmanAdminController::LOGGING_OPTIONS, PostmanAdminController::LOGGING_SECTION ); + + add_settings_field ( PostmanOptions::TRANSCRIPT_SIZE, __ ( 'Maximum Transcript Size', Postman::TEXT_DOMAIN ), array ( + $this, + 'transcriptSizeInputField' + ), PostmanAdminController::LOGGING_OPTIONS, PostmanAdminController::LOGGING_SECTION ); + + // the Network section + add_settings_section ( PostmanAdminController::NETWORK_SECTION, __ ( 'Network Settings', Postman::TEXT_DOMAIN ), array ( + $this, + 'printNetworkSectionInfo' + ), PostmanAdminController::NETWORK_OPTIONS ); + + add_settings_field ( 'connection_timeout', _x ( 'TCP Connection Timeout (sec)', 'Configuration Input Field', Postman::TEXT_DOMAIN ), array ( + $this, + 'connection_timeout_callback' + ), PostmanAdminController::NETWORK_OPTIONS, PostmanAdminController::NETWORK_SECTION ); + + add_settings_field ( 'read_timeout', _x ( 'TCP Read Timeout (sec)', 'Configuration Input Field', Postman::TEXT_DOMAIN ), array ( + $this, + 'read_timeout_callback' + ), PostmanAdminController::NETWORK_OPTIONS, PostmanAdminController::NETWORK_SECTION ); + + // the Advanced section + add_settings_section ( PostmanAdminController::ADVANCED_SECTION, _x ( 'Miscellaneous Settings', 'Configuration Section Title', Postman::TEXT_DOMAIN ), array ( + $this, + 'printAdvancedSectionInfo' + ), PostmanAdminController::ADVANCED_OPTIONS ); + + add_settings_field ( PostmanOptions::LOG_LEVEL, _x ( 'PHP Log Level', 'Configuration Input Field', Postman::TEXT_DOMAIN ), array ( + $this, + 'log_level_callback' + ), PostmanAdminController::ADVANCED_OPTIONS, PostmanAdminController::ADVANCED_SECTION ); + + add_settings_field ( PostmanOptions::RUN_MODE, _x ( 'Delivery Mode', 'Configuration Input Field', Postman::TEXT_DOMAIN ), array ( + $this, + 'runModeCallback' + ), PostmanAdminController::ADVANCED_OPTIONS, PostmanAdminController::ADVANCED_SECTION ); + + add_settings_field ( PostmanOptions::STEALTH_MODE, _x ( 'Stealth Mode', 'This mode removes the Postman X-Mailer signature from emails', Postman::TEXT_DOMAIN ), array ( + $this, + 'stealthModeCallback' + ), PostmanAdminController::ADVANCED_OPTIONS, PostmanAdminController::ADVANCED_SECTION ); + + add_settings_field ( PostmanOptions::TEMPORARY_DIRECTORY, __ ( 'Temporary Directory', Postman::TEXT_DOMAIN ), array ( + $this, + 'temporaryDirectoryCallback' + ), PostmanAdminController::ADVANCED_OPTIONS, PostmanAdminController::ADVANCED_SECTION ); + } + } + + /** + * Print the Transport section info + */ + public function printTransportSectionInfo() { + print __ ( 'Choose SMTP or a vendor-specific API:', Postman::TEXT_DOMAIN ); + } + public function printLoggingSectionInfo() { + print __ ( 'Configure the delivery audit log:', Postman::TEXT_DOMAIN ); + } + + /** + * Print the Section text + */ + public function printMessageFromSectionInfo() { + print sprintf ( __ ( 'This address, like the letterhead printed on a letter, identifies the sender to the recipient. Change this when you are sending on behalf of someone else, for example to use Google\'s Send Mail As feature. Other plugins, especially Contact Forms, may override this field to be your visitor\'s address.', Postman::TEXT_DOMAIN ), 'https://support.google.com/mail/answer/22370?hl=en' ); + } + + /** + * Print the Section text + */ + public function printMessageSectionInfo() { + print __ ( 'Separate multiple to/cc/bcc recipients with commas.', Postman::TEXT_DOMAIN ); + } + + /** + * Print the Section text + */ + public function printNetworkSectionInfo() { + print __ ( 'Increase the timeouts if your host is intermittenly failing to send mail. Be careful, this also correlates to how long your user must wait if the mail server is unreachable.', Postman::TEXT_DOMAIN ); + } + /** + * Print the Section text + */ + public function printAdvancedSectionInfo() { + } + /** + * Print the Section text + */ + public function printAdditionalHeadersSectionInfo() { + print __ ( 'Specify custom headers (e.g. X-MC-Tags: wordpress-site-A), one per line. Use custom headers with caution as they can negatively affect your Spam score.', Postman::TEXT_DOMAIN ); + } + + /** + * Print the Email Validation Description + */ + public function printEmailValidationSectionInfo() { + print __ ( 'E-mail addresses can be validated before sending e-mail, however this may fail with some newer domains.', Postman::TEXT_DOMAIN ); + } + + /** + * Get the settings option array and print one of its values + */ + public function transport_type_callback() { + $transportType = $this->options->getTransportType (); + printf ( ''; + } + + /** + * Get the settings option array and print one of its values + */ + public function sender_name_callback() { + printf ( '', null !== $this->options->getMessageSenderName () ? esc_attr ( $this->options->getMessageSenderName () ) : '' ); + } + + /** + */ + public function prevent_from_name_override_callback() { + $enforced = $this->options->isPluginSenderNameEnforced (); + printf ( ' %s', $enforced ? 'checked="checked"' : '', __ ( 'Prevent plugins and themes from changing this', Postman::TEXT_DOMAIN ) ); + } + + /** + * Get the settings option array and print one of its values + */ + public function from_email_callback() { + printf ( '', null !== $this->options->getMessageSenderEmail () ? esc_attr ( $this->options->getMessageSenderEmail () ) : '', __ ( 'Required', Postman::TEXT_DOMAIN ) ); + } + + /** + * Print the Section text + */ + public function printMessageSenderSectionInfo() { + print sprintf ( __ ( 'This address, like the return address printed on an envelope, identifies the account owner to the SMTP server.', Postman::TEXT_DOMAIN ), 'https://support.google.com/mail/answer/22370?hl=en' ); + } + + /** + * Get the settings option array and print one of its values + */ + public function prevent_from_email_override_callback() { + $enforced = $this->options->isPluginSenderEmailEnforced (); + printf ( ' %s', $enforced ? 'checked="checked"' : '', __ ( 'Prevent plugins and themes from changing this', Postman::TEXT_DOMAIN ) ); + } + + /** + * Shows the Mail Logging enable/disabled option + */ + public function loggingStatusInputField() { + // isMailLoggingAllowed + $disabled = ""; + if (! $this->options->isMailLoggingAllowed ()) { + $disabled = 'disabled="disabled" '; + } + printf ( '' ); + } + public function loggingMaxEntriesInputField() { + printf ( '', PostmanOptions::MAIL_LOG_MAX_ENTRIES, $this->options->getMailLoggingMaxEntries () ); + } + public function transcriptSizeInputField() { + $inputOptionsSlug = PostmanOptions::POSTMAN_OPTIONS; + $inputTranscriptSlug = PostmanOptions::TRANSCRIPT_SIZE; + $inputValue = $this->options->getTranscriptSize (); + $inputDescription = __ ( 'Change this value if you can\'t see the beginning of the transcript because your messages are too big.', Postman::TEXT_DOMAIN ); + printf ( '
%4$s', $inputOptionsSlug, $inputTranscriptSlug, $inputValue, $inputDescription ); + } + + /** + * Get the settings option array and print one of its values + */ + public function reply_to_callback() { + printf ( '', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::REPLY_TO, null !== $this->options->getReplyTo () ? esc_attr ( $this->options->getReplyTo () ) : '' ); + } + + /** + * Get the settings option array and print one of its values + */ + public function to_callback() { + printf ( '', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::FORCED_TO_RECIPIENTS, null !== $this->options->getForcedToRecipients () ? esc_attr ( $this->options->getForcedToRecipients () ) : '' ); + } + + /** + * Get the settings option array and print one of its values + */ + public function cc_callback() { + printf ( '', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::FORCED_CC_RECIPIENTS, null !== $this->options->getForcedCcRecipients () ? esc_attr ( $this->options->getForcedCcRecipients () ) : '' ); + } + + /** + * Get the settings option array and print one of its values + */ + public function bcc_callback() { + printf ( '', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::FORCED_BCC_RECIPIENTS, null !== $this->options->getForcedBccRecipients () ? esc_attr ( $this->options->getForcedBccRecipients () ) : '' ); + } + + /** + * Get the settings option array and print one of its values + */ + public function headers_callback() { + printf ( '', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::ADDITIONAL_HEADERS, null !== $this->options->getAdditionalHeaders () ? esc_attr ( $this->options->getAdditionalHeaders () ) : '' ); + } + + /** + */ + public function disable_email_validation_callback() { + $disabled = $this->options->isEmailValidationDisabled (); + printf ( ' %4$s', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::DISABLE_EMAIL_VALIDAITON, $disabled ? 'checked="checked"' : '', __ ( 'Disable e-mail validation', Postman::TEXT_DOMAIN ) ); + } + + /** + * Get the settings option array and print one of its values + */ + public function log_level_callback() { + $inputDescription = sprintf ( __ ( 'Log Level specifies the level of detail written to the WordPress Debug log - view the log with Debug.', Postman::TEXT_DOMAIN ), 'https://codex.wordpress.org/Debugging_in_WordPress', 'https://wordpress.org/plugins/debug/' ); + printf ( '
%s', $inputDescription ); + } + private function printSelectOption($label, $optionKey, $currentKey) { + $optionPattern = ''; + printf ( $optionPattern, $optionKey, $optionKey == $currentKey ? 'selected="selected"' : '', $label ); + } + public function runModeCallback() { + $inputDescription = __ ( 'Delivery mode offers options useful for developing or testing.', Postman::TEXT_DOMAIN ); + printf ( '
%s', $inputDescription ); + } + public function stealthModeCallback() { + printf ( ' %4$s', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::STEALTH_MODE, $this->options->isStealthModeEnabled () ? 'checked="checked"' : '', __ ( 'Remove the Postman X-Header signature from messages', Postman::TEXT_DOMAIN ) ); + } + public function temporaryDirectoryCallback() { + $inputDescription = __ ( 'Lockfiles are written here to prevent users from triggering an OAuth 2.0 token refresh at the same time.' ); + printf ( '', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::TEMPORARY_DIRECTORY, $this->options->getTempDirectory () ); + if (PostmanState::getInstance ()->isFileLockingEnabled ()) { + printf ( ' %s
%s', __ ( 'Valid', Postman::TEXT_DOMAIN ), $inputDescription ); + } else { + printf ( ' %s
%s', __ ( 'Invalid', Postman::TEXT_DOMAIN ), $inputDescription ); + } + } + + /** + * Get the settings option array and print one of its values + */ + public function connection_timeout_callback() { + printf ( '', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::CONNECTION_TIMEOUT, $this->options->getConnectionTimeout () ); + } + + /** + * Get the settings option array and print one of its values + */ + public function read_timeout_callback() { + printf ( '', PostmanOptions::POSTMAN_OPTIONS, PostmanOptions::READ_TIMEOUT, $this->options->getReadTimeout () ); + } + + /** + * Get the settings option array and print one of its values + */ + public function port_callback($args) { + printf ( '', null !== $this->options->getPort () ? esc_attr ( $this->options->getPort () ) : '', isset ( $args ['style'] ) ? $args ['style'] : '', __ ( 'Required', Postman::TEXT_DOMAIN ) ); + } +} \ No newline at end of file -- cgit v1.2.3