refactor(platforms): move platforms data in code instead of database

refs #457
2026-04-13 03:27:45 +02:00 · 2024-04-24 14:47:05 +00:00 · 2024-04-24 14:47:05 +00:00 · 303a900f66
commit 303a900f66
parent 57e459e187
23 changed files with 7888 additions and 6754 deletions
--- a/modules/Platforms/Models/PlatformModel.php
+++ b/modules/Platforms/Models/PlatformModel.php
@ -0,0 +1,178 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Class PlatformModel Model for platforms table in database
+ *
+ * @copyright  2024 Ad Aures
+ * @license    https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
+ * @link       https://castopod.org/
+ */
+
+namespace Modules\Platforms\Models;
+
+use CodeIgniter\Model;
+use Modules\Platforms\Entities\Platform;
+use Modules\Platforms\Platforms;
+
+class PlatformModel extends Model
+{
+    /**
+     * @var string
+     */
+    protected $table = 'platforms';
+
+    /**
+     * @var string
+     */
+    protected $primaryKey = 'id';
+
+    /**
+     * @var string[]
+     */
+    protected $allowedFields = ['podcast_id', 'type', 'slug', 'link_url', 'account_id', 'is_visible'];
+
+    /**
+     * @var string
+     */
+    protected $returnType = Platform::class;
+
+    /**
+     * @var bool
+     */
+    protected $useSoftDeletes = false;
+
+    /**
+     * @var bool
+     */
+    protected $useTimestamps = false;
+
+    /**
+     * @return Platform[]
+     */
+    public function getPlatformsWithData(int $podcastId, string $platformType): array
+    {
+        $cacheName = "podcast#{$podcastId}_platforms_{$platformType}_withData";
+        if (! ($found = cache($cacheName))) {
+            $platforms = new Platforms();
+
+            $found = $this->getPlatforms($podcastId, $platformType);
+            $platformsData = $platforms->getPlatformsByType($platformType);
+
+            $knownSlugs = [];
+            foreach ($found as $podcastPlatform) {
+                $knownSlugs[] = $podcastPlatform->slug;
+            }
+
+            foreach ($platformsData as $slug => $platform) {
+                if (! in_array($slug, $knownSlugs)) {
+                    $found[] = new Platform([
+                        'podcast_id' => $podcastId,
+                        'slug'       => $slug,
+                        'type'       => $platformType,
+                        'label'      => $platform['label'],
+                        'home_url'   => $platform['home_url'],
+                        'submit_url' => $platform['submit_url'],
+                        'link_url'   => '',
+                        'account_id' => null,
+                        'is_visible' => false,
+                    ]);
+                }
+            }
+
+            cache()
+                ->save($cacheName, $found, DECADE);
+        }
+
+        return $found;
+    }
+
+    /**
+     * @return Platform[]
+     */
+    public function getPlatforms(int $podcastId, string $platformType): array
+    {
+        $cacheName = "podcast#{$podcastId}_platforms_{$platformType}";
+        if (! ($found = cache($cacheName))) {
+            $platforms = new Platforms();
+
+            /** @var Platform[] $found */
+            $found = $this
+                ->where('podcast_id', $podcastId)
+                ->where('type', $platformType)
+                ->orderBy('slug')
+                ->findAll();
+
+            foreach ($found as $platform) {
+                $platformData = $platforms->findPlatformBySlug($platformType, $platform->slug);
+
+                if ($platformData === null) {
+                    // delete platform, it does not correspond to any existing one
+                    $this->delete($platform->id);
+
+                    continue;
+                }
+
+                $platform->type = $platformType;
+                $platform->label = $platformData['label'];
+                $platform->home_url = $platformData['home_url'];
+                $platform->submit_url = $platformData['submit_url'];
+            }
+
+            cache()
+                ->save($cacheName, $found, DECADE);
+        }
+
+        return $found;
+    }
+
+    /**
+     * @return int|false Number of rows inserted or FALSE on failure
+     */
+    public function savePlatforms(int $podcastId, string $platformType, array $data): int | false
+    {
+        $this->clearCache($podcastId);
+
+        $platforms = new Platforms();
+
+        $platformsData = $platforms->getPlatformsByType($platformType);
+
+        $this->builder()
+            ->whereIn('slug', array_keys($platformsData))
+            ->delete();
+
+        if ($data === []) {
+            // no rows inserted
+            return 0;
+        }
+
+        return $this->insertBatch($data);
+    }
+
+    public function removePlatform(int $podcastId, string $platformType, string $platformSlug): bool | string
+    {
+        $this->clearCache($podcastId);
+
+        return $this->builder()
+            ->delete([
+                'podcast_id' => $podcastId,
+                'type'       => $platformType,
+                'slug'       => $platformSlug,
+            ]);
+    }
+
+    public function clearCache(int $podcastId): void
+    {
+        cache()->deleteMatching("podcast#{$podcastId}_platforms_*");
+
+        // delete localized podcast page cache
+        cache()
+            ->deleteMatching("page_podcast#{$podcastId}*");
+        // delete post and episode comments pages cache
+        cache()
+            ->deleteMatching('page_post*');
+        cache()
+            ->deleteMatching('page_episode#*');
+    }
+}