Captcha.php
4 months ago
CronDaemon.php
3 years ago
ExportDownload.php
2 months ago
FormPreview.php
2 years ago
Subscription.php
5 days ago
TemplateImage.php
2 months ago
Track.php
2 months ago
ViewInBrowser.php
1 month ago
index.php
3 years ago
ExportDownload.php
254 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Router\Endpoints; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Config\AccessControl; |
| 9 | use MailPoet\Config\Env; |
| 10 | use MailPoet\Newsletter\Statistics\Export\StatisticsExporter; |
| 11 | use MailPoet\Router\Router; |
| 12 | use MailPoet\Subscribers\ImportExport\Export\Export; |
| 13 | use MailPoet\Util\Helpers; |
| 14 | use MailPoet\Util\Security; |
| 15 | use MailPoet\WP\Functions as WPFunctions; |
| 16 | |
| 17 | class ExportDownload { |
| 18 | public const ENDPOINT = 'export_download'; |
| 19 | public const ACTION_SUBSCRIBER_EXPORT = 'subscriberExport'; |
| 20 | public const ACTION_STATISTICS_EXPORT = 'statisticsExport'; |
| 21 | |
| 22 | private const DOWNLOAD_TOKEN_LENGTH = 32; |
| 23 | private const DOWNLOAD_TOKEN_CHARACTERS = 'abcdefghijklmnopqrstuvwxyz0123456789'; |
| 24 | private const EXPORT_DIRECTORY = 'exports'; |
| 25 | private const CONTENT_TYPES = [ |
| 26 | 'csv' => 'text/csv; charset=utf-8', |
| 27 | 'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', |
| 28 | ]; |
| 29 | |
| 30 | /** @var string[] */ |
| 31 | public $allowedActions = [ |
| 32 | self::ACTION_SUBSCRIBER_EXPORT, |
| 33 | self::ACTION_STATISTICS_EXPORT, |
| 34 | ]; |
| 35 | |
| 36 | public $permissions = [ |
| 37 | 'actions' => [ |
| 38 | self::ACTION_SUBSCRIBER_EXPORT => AccessControl::PERMISSION_MANAGE_SUBSCRIBERS, |
| 39 | self::ACTION_STATISTICS_EXPORT => AccessControl::PERMISSION_MANAGE_EMAILS, |
| 40 | ], |
| 41 | ]; |
| 42 | |
| 43 | /** @var WPFunctions */ |
| 44 | private $wp; |
| 45 | |
| 46 | public function __construct( |
| 47 | WPFunctions $wp |
| 48 | ) { |
| 49 | $this->wp = $wp; |
| 50 | } |
| 51 | |
| 52 | public static function buildSubscriberExportUrl(string $token, string $format, ?string $baseUrl = null): string { |
| 53 | return self::buildExportUrl(self::ACTION_SUBSCRIBER_EXPORT, $token, $format, $baseUrl); |
| 54 | } |
| 55 | |
| 56 | public static function buildStatisticsExportUrl(string $token, string $format, ?string $baseUrl = null): string { |
| 57 | return self::buildExportUrl(self::ACTION_STATISTICS_EXPORT, $token, $format, $baseUrl); |
| 58 | } |
| 59 | |
| 60 | public static function getExportDirectory(): string { |
| 61 | return Env::$tempPath . '/' . self::EXPORT_DIRECTORY; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * @return array{path: string, token: string} |
| 66 | */ |
| 67 | public static function createExportFile(string $filePrefix, string $format): array { |
| 68 | $token = self::generateDownloadToken(); |
| 69 | return [ |
| 70 | 'path' => self::getFilePathForToken($filePrefix, $token, $format), |
| 71 | 'token' => $token, |
| 72 | ]; |
| 73 | } |
| 74 | |
| 75 | public static function generateDownloadToken(): string { |
| 76 | return Security::generateRandomString(self::DOWNLOAD_TOKEN_LENGTH); |
| 77 | } |
| 78 | |
| 79 | public static function getFilePathForToken(string $filePrefix, string $token, string $format): string { |
| 80 | return self::getExportDirectory() . '/' . self::getFileNameForToken($filePrefix, $token, $format); |
| 81 | } |
| 82 | |
| 83 | public static function ensureExportDirectory(?WPFunctions $wp = null): void { |
| 84 | $wp = $wp ?? WPFunctions::get(); |
| 85 | $exportDirectory = self::getExportDirectory(); |
| 86 | $wasJustCreated = !is_dir($exportDirectory); |
| 87 | if ($wasJustCreated && !$wp->wpMkdirP($exportDirectory)) { |
| 88 | throw new \RuntimeException('Could not create the export directory.'); |
| 89 | } |
| 90 | if (!is_dir($exportDirectory)) { |
| 91 | throw new \RuntimeException('Could not create the export directory.'); |
| 92 | } |
| 93 | if (!self::writeFile($exportDirectory . '/index.php', str_replace('\n', PHP_EOL, '<?php\n\n// Silence is golden'))) { |
| 94 | throw new \RuntimeException('Could not protect the export directory.'); |
| 95 | } |
| 96 | $htaccessWritten = self::writeFile( |
| 97 | $exportDirectory . '/.htaccess', |
| 98 | implode(PHP_EOL, [ |
| 99 | '<IfModule mod_authz_core.c>', |
| 100 | 'Require all denied', |
| 101 | '</IfModule>', |
| 102 | '<IfModule !mod_authz_core.c>', |
| 103 | 'Deny from all', |
| 104 | '</IfModule>', |
| 105 | '', |
| 106 | ]) |
| 107 | ); |
| 108 | if (!$htaccessWritten) { |
| 109 | throw new \RuntimeException('Could not protect the export directory.'); |
| 110 | } |
| 111 | if ($wasJustCreated) { |
| 112 | self::purgeLegacyExportFiles(); |
| 113 | } |
| 114 | } |
| 115 | |
| 116 | private static function purgeLegacyExportFiles(): void { |
| 117 | $patterns = [ |
| 118 | Env::$tempPath . '/' . Export::getFilePrefix() . '*.*', |
| 119 | Env::$tempPath . '/' . StatisticsExporter::FILE_PREFIX . '*.*', |
| 120 | ]; |
| 121 | foreach ($patterns as $pattern) { |
| 122 | foreach (glob($pattern) ?: [] as $file) { |
| 123 | if (is_file($file)) { |
| 124 | unlink($file); |
| 125 | } |
| 126 | } |
| 127 | } |
| 128 | } |
| 129 | |
| 130 | public function subscriberExport(array $data): void { |
| 131 | $this->downloadFile($data, Export::getFilePrefix()); |
| 132 | } |
| 133 | |
| 134 | public function statisticsExport(array $data): void { |
| 135 | $this->downloadFile($data, StatisticsExporter::FILE_PREFIX); |
| 136 | } |
| 137 | |
| 138 | public function getDownloadFilePath(array $data, string $filePrefix): ?string { |
| 139 | if (empty($data['token']) || !is_string($data['token'])) { |
| 140 | return null; |
| 141 | } |
| 142 | |
| 143 | $token = $data['token']; |
| 144 | if ( |
| 145 | strlen($token) !== self::DOWNLOAD_TOKEN_LENGTH |
| 146 | || strspn($token, self::DOWNLOAD_TOKEN_CHARACTERS) !== self::DOWNLOAD_TOKEN_LENGTH |
| 147 | ) { |
| 148 | return null; |
| 149 | } |
| 150 | |
| 151 | if (empty($data['format']) || !is_string($data['format'])) { |
| 152 | return null; |
| 153 | } |
| 154 | |
| 155 | $extension = strtolower($data['format']); |
| 156 | if (!isset(self::CONTENT_TYPES[$extension])) { |
| 157 | return null; |
| 158 | } |
| 159 | |
| 160 | $realExportPath = realpath(self::getExportDirectory()); |
| 161 | $filePath = self::getFilePathForToken($filePrefix, $token, $extension); |
| 162 | $realFilePath = is_file($filePath) ? realpath($filePath) : false; |
| 163 | if (!is_string($realExportPath) || !is_string($realFilePath)) { |
| 164 | return null; |
| 165 | } |
| 166 | |
| 167 | $exportPath = rtrim($realExportPath, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR; |
| 168 | if (strpos($realFilePath, $exportPath) !== 0) { |
| 169 | return null; |
| 170 | } |
| 171 | |
| 172 | return $realFilePath; |
| 173 | } |
| 174 | |
| 175 | private static function buildExportUrl(string $action, string $token, string $format, ?string $baseUrl): string { |
| 176 | $baseUrl = $baseUrl ?? WPFunctions::get()->homeUrl(); |
| 177 | $params = [ |
| 178 | Router::NAME => '', |
| 179 | 'endpoint' => self::ENDPOINT, |
| 180 | 'action' => Helpers::camelCaseToUnderscore($action), |
| 181 | 'data' => Router::encodeRequestData([ |
| 182 | 'token' => $token, |
| 183 | 'format' => strtolower($format), |
| 184 | ]), |
| 185 | ]; |
| 186 | $separator = strpos($baseUrl, '?') === false ? '?' : '&'; |
| 187 | return $baseUrl . $separator . http_build_query($params, '', '&'); |
| 188 | } |
| 189 | |
| 190 | private static function getFileNameForToken(string $filePrefix, string $token, string $format): string { |
| 191 | return sprintf( |
| 192 | '%s%s.%s', |
| 193 | $filePrefix, |
| 194 | hash_hmac('sha256', $token, self::getDownloadSecret()), |
| 195 | strtolower($format) |
| 196 | ); |
| 197 | } |
| 198 | |
| 199 | private static function getDownloadSecret(): string { |
| 200 | $secret = ''; |
| 201 | $secretConstants = [ |
| 202 | 'AUTH_KEY', |
| 203 | 'SECURE_AUTH_KEY', |
| 204 | 'LOGGED_IN_KEY', |
| 205 | 'NONCE_KEY', |
| 206 | 'AUTH_SALT', |
| 207 | 'SECURE_AUTH_SALT', |
| 208 | 'LOGGED_IN_SALT', |
| 209 | 'NONCE_SALT', |
| 210 | ]; |
| 211 | foreach ($secretConstants as $constant) { |
| 212 | if (defined($constant)) { |
| 213 | $secret .= (string)constant($constant); |
| 214 | } |
| 215 | } |
| 216 | return $secret !== '' ? $secret : (string)Env::$path; |
| 217 | } |
| 218 | |
| 219 | private static function writeFile(string $filePath, string $contents): bool { |
| 220 | // phpcs:ignore WordPressVIPMinimum.Performance.FetchingRemoteData.FileGetContentsUnknown -- Reads protection files in MailPoet's export directory. |
| 221 | if (is_file($filePath) && file_get_contents($filePath) === $contents) { |
| 222 | return true; |
| 223 | } |
| 224 | // phpcs:ignore WordPressVIPMinimum.Functions.RestrictedFunctions.file_ops_file_put_contents -- Writes protection files to MailPoet's export directory. |
| 225 | return file_put_contents($filePath, $contents) !== false; |
| 226 | } |
| 227 | |
| 228 | private function downloadFile(array $data, string $filePrefix): void { |
| 229 | $filePath = $this->getDownloadFilePath($data, $filePrefix); |
| 230 | if (!$filePath) { |
| 231 | $this->wp->statusHeader(404); |
| 232 | exit; |
| 233 | } |
| 234 | |
| 235 | $extension = strtolower((string)pathinfo($filePath, PATHINFO_EXTENSION)); |
| 236 | if (!$this->wp->headersSent()) { |
| 237 | header('Content-Type: ' . self::CONTENT_TYPES[$extension]); |
| 238 | header('Content-Disposition: attachment; filename="' . rtrim($filePrefix, '_') . '.' . $extension . '"'); |
| 239 | header('X-Content-Type-Options: nosniff'); |
| 240 | header('Cache-Control: no-store, no-cache, must-revalidate, max-age=0'); |
| 241 | header('Pragma: no-cache'); |
| 242 | header('Expires: 0'); |
| 243 | $fileSize = filesize($filePath); |
| 244 | if ($fileSize !== false) { |
| 245 | header('Content-Length: ' . $fileSize); |
| 246 | } |
| 247 | } |
| 248 | |
| 249 | // phpcs:ignore WordPressVIPMinimum.Performance.FetchingRemoteData.FileGetContentsUnknown -- Reads a validated local export file from Env::$tempPath. |
| 250 | readfile($filePath); |
| 251 | exit; |
| 252 | } |
| 253 | } |
| 254 |