Charsets.php
3 years ago
Hosts.php
3 months ago
Pages.php
9 months ago
SettingsChangeHandler.php
1 month ago
SettingsController.php
2 days ago
SettingsRepository.php
1 year ago
TrackingConfig.php
6 months ago
UserFlagsController.php
1 year ago
UserFlagsRepository.php
3 years ago
index.php
3 years ago
SettingsController.php
289 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Settings; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Cron\CronTrigger; |
| 9 | use MailPoet\DI\ContainerWrapper; |
| 10 | use MailPoet\Subscribers\TrackingConsentController; |
| 11 | |
| 12 | class SettingsController { |
| 13 | |
| 14 | const DEFAULT_SENDING_METHOD_GROUP = 'website'; |
| 15 | const DEFAULT_SENDING_METHOD = 'PHPMail'; |
| 16 | const DEFAULT_SENDING_FREQUENCY_EMAILS = 25; |
| 17 | const DEFAULT_SENDING_FREQUENCY_INTERVAL = 5; // in minutes |
| 18 | const DEFAULT_DEACTIVATE_SUBSCRIBER_AFTER_INACTIVE_DAYS = 365; |
| 19 | const DEFAULT_SENDING_STATUS_RETENTION_DAYS = ''; |
| 20 | const DEFAULT_SENDING_QUEUE_BODY_RETENTION_DAYS = 30; |
| 21 | const DEFAULT_DELETE_UNCONFIRMED_SUBSCRIBERS_AFTER_DAYS = ''; |
| 22 | const ALLOWED_DELETE_UNCONFIRMED_SUBSCRIBERS_AFTER_DAYS = ['', '30']; |
| 23 | const MANAGE_SUBSCRIPTION_PAGE_STYLE_CLASSIC = 'classic'; |
| 24 | const MANAGE_SUBSCRIPTION_PAGE_STYLE_MODERN = 'modern'; |
| 25 | |
| 26 | private $loaded = false; |
| 27 | |
| 28 | private $settings = []; |
| 29 | |
| 30 | private $defaults = null; |
| 31 | |
| 32 | /** @var SettingsRepository */ |
| 33 | private $settingsRepository; |
| 34 | |
| 35 | private static $instance; |
| 36 | |
| 37 | public function __construct( |
| 38 | SettingsRepository $settingsRepository |
| 39 | ) { |
| 40 | $this->settingsRepository = $settingsRepository; |
| 41 | } |
| 42 | |
| 43 | public function get($key, $default = null) { |
| 44 | $this->ensureLoaded(); |
| 45 | $keyParts = explode('.', $key); |
| 46 | $setting = $this->settings; |
| 47 | if ($default === null) { |
| 48 | $default = $this->getDefaultValue($keyParts); |
| 49 | } |
| 50 | foreach ($keyParts as $keyPart) { |
| 51 | if (is_array($setting) && array_key_exists($keyPart, $setting)) { |
| 52 | $setting = $setting[$keyPart]; |
| 53 | } else { |
| 54 | return $default; |
| 55 | } |
| 56 | } |
| 57 | if (is_array($setting) && is_array($default)) { |
| 58 | return array_replace_recursive($default, $setting); |
| 59 | } |
| 60 | if ($key === 'delete_unconfirmed_subscribers_after_days') { |
| 61 | return $this->normalizeDeleteUnconfirmedSubscribersAfterDays($setting); |
| 62 | } |
| 63 | return $setting; |
| 64 | } |
| 65 | |
| 66 | public function getAllDefaults() { |
| 67 | if ($this->defaults === null) { |
| 68 | $this->defaults = [ |
| 69 | 'mta_group' => self::DEFAULT_SENDING_METHOD_GROUP, |
| 70 | 'mta' => [ |
| 71 | 'method' => self::DEFAULT_SENDING_METHOD, |
| 72 | 'frequency' => [ |
| 73 | 'emails' => self::DEFAULT_SENDING_FREQUENCY_EMAILS, |
| 74 | 'interval' => self::DEFAULT_SENDING_FREQUENCY_INTERVAL, |
| 75 | ], |
| 76 | ], |
| 77 | CronTrigger::SETTING_NAME => [ |
| 78 | 'method' => CronTrigger::DEFAULT_METHOD, |
| 79 | ], |
| 80 | 'signup_confirmation' => [ |
| 81 | 'enabled' => true, |
| 82 | 'use_mailpoet_editor' => true, |
| 83 | ], |
| 84 | 'tracking' => [ |
| 85 | 'level' => TrackingConfig::LEVEL_FULL, |
| 86 | 'consent' => [ |
| 87 | 'subscriber_choice' => TrackingConsentController::CHOICE_TRACK_ALL, |
| 88 | ], |
| 89 | ], |
| 90 | 'subscription' => [ |
| 91 | 'manage_subscription_page_style' => self::MANAGE_SUBSCRIPTION_PAGE_STYLE_MODERN, |
| 92 | 'unsubscribe_survey' => [ |
| 93 | 'enabled' => true, |
| 94 | 'allow_other_text' => false, |
| 95 | ], |
| 96 | ], |
| 97 | 'analytics' => [ |
| 98 | 'enabled' => false, |
| 99 | ], |
| 100 | 'collect_subscriber_timezones' => [ |
| 101 | 'enabled' => true, |
| 102 | ], |
| 103 | 'display_nps_poll' => true, |
| 104 | 'deactivate_subscriber_after_inactive_days' => self::DEFAULT_DEACTIVATE_SUBSCRIBER_AFTER_INACTIVE_DAYS, |
| 105 | 'delete_unconfirmed_subscribers_after_days' => self::DEFAULT_DELETE_UNCONFIRMED_SUBSCRIBERS_AFTER_DAYS, |
| 106 | 'sending_status_retention_days' => self::DEFAULT_SENDING_STATUS_RETENTION_DAYS, |
| 107 | 'sending_queue_body_retention_days' => self::DEFAULT_SENDING_QUEUE_BODY_RETENTION_DAYS, |
| 108 | 'sharing' => [ |
| 109 | 'default_visibility' => 'public', |
| 110 | ], |
| 111 | ]; |
| 112 | } |
| 113 | |
| 114 | // Always include subject and body in defaults, using translated versions when available |
| 115 | $this->defaults['signup_confirmation']['subject'] = $this->getTranslatedDefaultSubject(); |
| 116 | $this->defaults['signup_confirmation']['body'] = $this->getTranslatedDefaultBody(); |
| 117 | |
| 118 | return $this->defaults; |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * Get translated default subject with fallback |
| 123 | * |
| 124 | * @return string |
| 125 | */ |
| 126 | private function getTranslatedDefaultSubject(): string { |
| 127 | if ($this->isTranslationReady()) { |
| 128 | return __('Confirm your subscription to [site:title]', 'mailpoet'); |
| 129 | } |
| 130 | return 'Confirm your subscription to [site:title]'; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Get translated default body with fallback |
| 135 | * |
| 136 | * @return string |
| 137 | */ |
| 138 | private function getTranslatedDefaultBody(): string { |
| 139 | if ($this->isTranslationReady()) { |
| 140 | return __("Hello [subscriber:firstname | default:there],\n\nYou've received this message because you subscribed to [site:title]. Please confirm your subscription to receive emails from us:\n\n[activation_link]Click here to confirm your subscription.[/activation_link] \n\nIf you received this email by mistake, simply delete it. You won't receive any more emails from us unless you confirm your subscription using the link above.\n\nThank you,\n\n<a target=\"_blank\" href=\"[site:homepage_url]\">[site:title]</a>", 'mailpoet'); |
| 141 | } |
| 142 | return "Hello [subscriber:firstname | default:there],\n\nYou've received this message because you subscribed to [site:title]. Please confirm your subscription to receive emails from us:\n\n[activation_link]Click here to confirm your subscription.[/activation_link] \n\nIf you received this email by mistake, simply delete it. You won't receive any more emails from us unless you confirm your subscription using the link above.\n\nThank you,\n\n<a target=\"_blank\" href=\"[site:homepage_url]\">[site:title]</a>"; |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * Check if translations are ready to be used |
| 147 | * |
| 148 | * @return bool |
| 149 | */ |
| 150 | private function isTranslationReady(): bool { |
| 151 | if (!function_exists('__')) { |
| 152 | return false; |
| 153 | } |
| 154 | |
| 155 | // Prefer using is_textdomain_loaded to confirm the 'mailpoet' text domain is present |
| 156 | if (function_exists('is_textdomain_loaded')) { |
| 157 | return (bool)is_textdomain_loaded('mailpoet'); |
| 158 | } |
| 159 | |
| 160 | // Fall back to did_action('init') if is_textdomain_loaded is unavailable |
| 161 | // Guard did_action() with function_exists to avoid fatals in non-WP contexts |
| 162 | if (function_exists('did_action')) { |
| 163 | return (bool)did_action('init'); |
| 164 | } |
| 165 | |
| 166 | return false; |
| 167 | } |
| 168 | |
| 169 | /** |
| 170 | * Fetches the value from DB and update in cache |
| 171 | * This is required for sync settings between parallel processes e.g. cron |
| 172 | */ |
| 173 | public function fetch($key, $default = null) { |
| 174 | $keys = explode('.', $key); |
| 175 | $mainKey = $keys[0]; |
| 176 | $this->settings[$mainKey] = $this->fetchValue($mainKey); |
| 177 | return $this->get($key, $default); |
| 178 | } |
| 179 | |
| 180 | public function getAll() { |
| 181 | $this->ensureLoaded(); |
| 182 | $settings = array_replace_recursive($this->getAllDefaults(), $this->settings); |
| 183 | $settings['delete_unconfirmed_subscribers_after_days'] = $this->normalizeDeleteUnconfirmedSubscribersAfterDays($settings['delete_unconfirmed_subscribers_after_days']); |
| 184 | return $settings; |
| 185 | } |
| 186 | |
| 187 | public function set($key, $value) { |
| 188 | $this->ensureLoaded(); |
| 189 | $keyParts = explode('.', $key); |
| 190 | $mainKey = $keyParts[0]; |
| 191 | $hadKey = array_key_exists($mainKey, $this->settings); |
| 192 | $previousValue = $hadKey ? $this->settings[$mainKey] : null; |
| 193 | $lastKey = array_pop($keyParts); |
| 194 | $setting =& $this->settings; |
| 195 | foreach ($keyParts as $keyPart) { |
| 196 | $setting =& $setting[$keyPart]; |
| 197 | if (!is_array($setting)) { |
| 198 | $setting = []; |
| 199 | } |
| 200 | } |
| 201 | $setting[$lastKey] = $value; |
| 202 | if (!$hadKey || $this->settings[$mainKey] !== $previousValue) { |
| 203 | $this->settingsRepository->createOrUpdateByName($mainKey, $this->settings[$mainKey]); |
| 204 | } |
| 205 | } |
| 206 | |
| 207 | public function delete($key) { |
| 208 | $setting = $this->settingsRepository->findOneByName($key); |
| 209 | if ($setting) { |
| 210 | $this->settingsRepository->remove($setting); |
| 211 | $this->settingsRepository->flush(); |
| 212 | } |
| 213 | unset($this->settings[$key]); |
| 214 | } |
| 215 | |
| 216 | /** |
| 217 | * Returns true if a value is stored in the database for the given key |
| 218 | * |
| 219 | * @param string $key |
| 220 | * |
| 221 | * @return bool |
| 222 | */ |
| 223 | public function hasSavedValue(string $key): bool { |
| 224 | return $this->get($key, 'unset') !== 'unset'; |
| 225 | } |
| 226 | |
| 227 | /** |
| 228 | * Returns true if the setting value is a truthy boolean. Settings are persisted as |
| 229 | * strings, integers, or booleans depending on how they were written, so this helper |
| 230 | * normalizes the check across all three representations. |
| 231 | */ |
| 232 | public function isSettingEnabled(string $key): bool { |
| 233 | $value = $this->get($key); |
| 234 | return $value === true || $value === '1' || $value === 1; |
| 235 | } |
| 236 | |
| 237 | private function ensureLoaded() { |
| 238 | if ($this->loaded) { |
| 239 | return; |
| 240 | } |
| 241 | |
| 242 | $this->settings = []; |
| 243 | foreach ($this->settingsRepository->findAll() as $setting) { |
| 244 | $this->settings[$setting->getName()] = $setting->getValue(); |
| 245 | } |
| 246 | $this->loaded = true; |
| 247 | } |
| 248 | |
| 249 | private function getDefaultValue($keys) { |
| 250 | $default = $this->getAllDefaults(); |
| 251 | foreach ($keys as $key) { |
| 252 | if (array_key_exists($key, $default)) { |
| 253 | $default = $default[$key]; |
| 254 | } else { |
| 255 | return null; |
| 256 | } |
| 257 | } |
| 258 | |
| 259 | return $default; |
| 260 | } |
| 261 | |
| 262 | private function normalizeDeleteUnconfirmedSubscribersAfterDays($value): string { |
| 263 | if (in_array($value, self::ALLOWED_DELETE_UNCONFIRMED_SUBSCRIBERS_AFTER_DAYS, true)) { |
| 264 | return $value; |
| 265 | } |
| 266 | return self::DEFAULT_DELETE_UNCONFIRMED_SUBSCRIBERS_AFTER_DAYS; |
| 267 | } |
| 268 | |
| 269 | private function fetchValue($key) { |
| 270 | $setting = $this->settingsRepository->findOneByName($key); |
| 271 | return $setting ? $setting->getValue() : null; |
| 272 | } |
| 273 | |
| 274 | public function resetCache() { |
| 275 | $this->settings = []; |
| 276 | $this->loaded = false; |
| 277 | } |
| 278 | |
| 279 | public static function setInstance($instance) { |
| 280 | self::$instance = $instance; |
| 281 | } |
| 282 | |
| 283 | /** @return SettingsController */ |
| 284 | public static function getInstance() { |
| 285 | if (isset(self::$instance)) return self::$instance; |
| 286 | return ContainerWrapper::getInstance()->get(SettingsController::class); |
| 287 | } |
| 288 | } |
| 289 |