Refactor/update message sendin #374
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,222 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace PhpList\Core\Domain\Common; | ||
|
|
||
| use PhpList\Core\Domain\Configuration\Model\ConfigOption; | ||
| use PhpList\Core\Domain\Configuration\Service\Provider\ConfigProvider; | ||
| use Psr\Log\LoggerInterface; | ||
| use Throwable; | ||
|
|
||
| class ExternalImageService | ||
| { | ||
| private string $externalCacheDir; | ||
|
|
||
| public function __construct( | ||
| private readonly ConfigProvider $configProvider, | ||
| private readonly LoggerInterface $logger, | ||
| private readonly string $tempDir, | ||
| private readonly int $externalImageMaxAge, | ||
| private readonly int $externalImageMaxSize, | ||
| private readonly ?int $externalImageTimeout = 30, | ||
| ) { | ||
| $this->externalCacheDir = $this->tempDir . '/external_cache'; | ||
| } | ||
|
|
||
| public function getFromCache(string $filename, int $messageId): ?string | ||
| { | ||
| $cacheFile = $this->generateLocalFileName($filename, $messageId); | ||
|
|
||
| if (!is_file($cacheFile) || filesize($cacheFile) <= 64) { | ||
| return null; | ||
| } | ||
|
|
||
| $content = file_get_contents($cacheFile); | ||
| if ($content === false) { | ||
| return null; | ||
| } | ||
|
|
||
| return base64_encode($content); | ||
| } | ||
|
|
||
| public function cache($filename, $messageId): bool | ||
| { | ||
| if (!$this->isCacheableUrl($filename)) { | ||
| return false; | ||
| } | ||
|
|
||
| if (!$this->ensureCacheDirectory()) { | ||
| return false; | ||
| } | ||
|
|
||
| $this->removeOldFilesInCache(); | ||
|
|
||
| $cacheFileName = $this->generateLocalFileName($filename, $messageId); | ||
|
|
||
| if (!file_exists($cacheFileName)) { | ||
| $cacheFileContent = null; | ||
|
|
||
| if (function_exists('curl_init')) { | ||
| $cacheFileContent = $this->downloadUsingCurl($filename); | ||
| } | ||
|
|
||
| if ($cacheFileContent === null) { | ||
| $cacheFileContent = $this->downloadUsingFileGetContent($filename); | ||
| } | ||
|
|
||
| if ($this->externalImageMaxSize && (strlen($cacheFileContent) > $this->externalImageMaxSize)) { | ||
| $cacheFileContent = 'MAX_SIZE'; | ||
| } | ||
TatevikGr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| $this->writeCacheFile($cacheFileName, $cacheFileContent); | ||
|
Comment on lines
+64
to
+72
There was a problem hiding this comment. Null check needed before strlen on line 68. If both 🔎 Suggested fix if ($cacheFileContent === null) {
$cacheFileContent = $this->downloadUsingFileGetContent($filename);
}
+ if ($cacheFileContent === null) {
+ return false;
+ }
+
if ($this->externalImageMaxSize && (strlen($cacheFileContent) > $this->externalImageMaxSize)) {🤖 Prompt for AI Agents |
||
| } | ||
|
|
||
| return $this->isValidCacheFile($cacheFileName); | ||
| } | ||
|
|
||
| private function removeOldFilesInCache(): void | ||
| { | ||
| // phpcs:ignore Generic.PHP.NoSilencedErrors | ||
| $extCacheDirHandle = @opendir($this->externalCacheDir); | ||
| if (!$this->externalImageMaxAge || !$extCacheDirHandle) { | ||
| return; | ||
| } | ||
|
|
||
| while (true) { | ||
| // phpcs:ignore Generic.PHP.NoSilencedErrors | ||
| $cacheFile = @readdir($extCacheDirHandle); | ||
|
|
||
| if ($cacheFile === false) { | ||
| break; | ||
| } | ||
| // todo: make sure that this is what we need | ||
| if (!str_starts_with($cacheFile, '.')) { | ||
| // phpcs:ignore Generic.PHP.NoSilencedErrors | ||
| $cfmt = @filemtime($this->externalCacheDir . '/' . $cacheFile); | ||
|
|
||
| if (is_numeric($cfmt) && ($cfmt > 0) && ((time() - $cfmt) > $this->externalImageMaxAge)) { | ||
| // phpcs:ignore Generic.PHP.NoSilencedErrors | ||
| @unlink($this->externalCacheDir . '/' . $cacheFile); | ||
| } | ||
| } | ||
| } | ||
| // phpcs:ignore Generic.PHP.NoSilencedErrors | ||
| @closedir($extCacheDirHandle); | ||
| } | ||
|
|
||
| private function generateLocalFileName(string $filename, int $messageId): string | ||
| { | ||
| return $this->externalCacheDir | ||
| . '/' | ||
| . $messageId | ||
| . '_' | ||
| . preg_replace([ '~[\.][\.]+~Ui', '~[^\w\.]~Ui',], ['', '_'], $filename); | ||
| } | ||
|
Comment on lines
+108
to
+115
There was a problem hiding this comment. Strengthen filename sanitization against path traversal. The regex 🔎 Proposed fix private function generateLocalFileName(string $filename, int $messageId): string
{
- return $this->externalCacheDir
- . '/'
- . $messageId
- . '_'
- . preg_replace([ '~[\.][\.]+~Ui', '~[^\w\.]~Ui',], ['', '_'], $filename);
+ $sanitized = preg_replace('~[^\w\.-]~', '_', basename(parse_url($filename, PHP_URL_PATH)));
+ return $this->externalCacheDir . '/' . $messageId . '_' . $sanitized;
}🤖 Prompt for AI Agents |
||
|
|
||
| private function downloadUsingCurl(string $filename): ?string | ||
| { | ||
| $cURLHandle = curl_init($filename); | ||
|
|
||
| if ($cURLHandle !== false) { | ||
| curl_setopt($cURLHandle, CURLOPT_HTTPGET, true); | ||
| curl_setopt($cURLHandle, CURLOPT_HEADER, 0); | ||
| curl_setopt($cURLHandle, CURLOPT_RETURNTRANSFER, true); | ||
| curl_setopt($cURLHandle, CURLOPT_TIMEOUT, $this->externalImageTimeout); | ||
| curl_setopt($cURLHandle, CURLOPT_FOLLOWLOCATION, true); | ||
| curl_setopt($cURLHandle, CURLOPT_MAXREDIRS, 10); | ||
| curl_setopt($cURLHandle, CURLOPT_SSL_VERIFYPEER, false); | ||
|
There was a problem hiding this comment. Disabling SSL peer verification is a security risk.
🤖 Prompt for AI Agents |
||
| curl_setopt($cURLHandle, CURLOPT_FAILONERROR, true); | ||
|
|
||
| $cacheFileContent = curl_exec($cURLHandle); | ||
|
|
||
| $cURLErrNo = curl_errno($cURLHandle); | ||
| $cURLInfo = curl_getinfo($cURLHandle); | ||
|
|
||
| curl_close($cURLHandle); | ||
|
|
||
| if ($cURLErrNo != 0) { | ||
| $cacheFileContent = 'CURL_ERROR_' . $cURLErrNo; | ||
| } | ||
| if ($cURLInfo['http_code'] >= 400) { | ||
| $cacheFileContent = 'HTTP_CODE_' . $cURLInfo['http_code']; | ||
| } | ||
| } | ||
|
|
||
| return $cacheFileContent ?? null; | ||
| } | ||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private function downloadUsingFileGetContent(string $filename): string | ||
| { | ||
| $remoteURLContext = stream_context_create([ | ||
| 'http' => [ | ||
| 'method' => 'GET', | ||
| 'timeout' => $this->externalImageTimeout, | ||
| 'max_redirects' => '10', | ||
| ] | ||
| ]); | ||
|
|
||
| $cacheFileContent = file_get_contents($filename, false, $remoteURLContext); | ||
| if ($cacheFileContent === false) { | ||
| $cacheFileContent = 'FGC_ERROR'; | ||
| } | ||
|
|
||
| return $cacheFileContent; | ||
| } | ||
TatevikGr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private function isCacheableUrl($filename): bool | ||
| { | ||
| if (!(str_starts_with($filename, 'http')) | ||
| || str_contains($filename, '://' . $this->configProvider->getValue(ConfigOption::Website) . '/') | ||
| ) { | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| private function ensureCacheDirectory(): bool | ||
| { | ||
|
|
||
| if (!file_exists($this->externalCacheDir)) { | ||
| // phpcs:ignore Generic.PHP.NoSilencedErrors | ||
| @mkdir($this->externalCacheDir); | ||
| } | ||
|
|
||
| if (!file_exists($this->externalCacheDir) || !is_writable($this->externalCacheDir)) { | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| private function isValidCacheFile(string $cacheFileName): bool | ||
| { | ||
| // phpcs:ignore Generic.PHP.NoSilencedErrors | ||
| if (file_exists($cacheFileName) && (@filesize($cacheFileName) > 64)) { | ||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| private function writeCacheFile(string $cacheFileName, $content): void | ||
| { | ||
| // phpcs:ignore Generic.PHP.NoSilencedErrors | ||
| $bytes = @file_put_contents($cacheFileName, $content, LOCK_EX); | ||
|
|
||
| if ($bytes === false) { | ||
| $this->logger->error('Cache file write failed', ['file' => $cacheFileName]); | ||
| return; | ||
| } | ||
|
|
||
| $expected = strlen($content); | ||
| if ($bytes !== $expected) { | ||
| $this->logger->error('Cache file partial write', [ | ||
| 'file' => $cacheFileName, | ||
| 'expected' => $expected, | ||
| 'written' => $bytes, | ||
| ]); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.