Internal: Change migration for plugin with settings by access url #2675

AngelFQC · AngelFQC · commit 8cd73f990900 · 2025-03-17T16:43:07.000-05:00
diff --git a/public/main/inc/lib/plugin.lib.php b/public/main/inc/lib/plugin.lib.php
@@ -192,11 +192,10 @@ public function getInstalledPluginsInCurrentUrl()
      *
      * @return array
      */
-    public function getOfficialPlugins()
+    public static function getOfficialPlugins(): array
     {
-        static $officialPlugins = null;
         // Please keep this list alphabetically sorted
-        $officialPlugins = [
+        return [
             'advanced_subscription',
             'ai_helper',
             'azure_active_directory',
@@ -252,8 +251,6 @@ public function getOfficialPlugins()
             'userremoteservice',
             'zoom',
         ];
-
-        return $officialPlugins;
     }
 
     /**
diff --git a/src/CoreBundle/Entity/AccessUrl.php b/src/CoreBundle/Entity/AccessUrl.php
@@ -153,6 +153,12 @@ class AccessUrl extends AbstractResource implements ResourceInterface, Stringabl
     #[ORM\OneToMany(mappedBy: 'url', targetEntity: AccessUrlRelColorTheme::class, cascade: ['persist'], orphanRemoval: true)]
     private Collection $colorThemes;
 
+    /**
+     * @var Collection<int, AccessUrlRelPlugin>
+     */
+    #[ORM\OneToMany(mappedBy: 'url', targetEntity: AccessUrlRelPlugin::class, orphanRemoval: true)]
+    private Collection $plugins;
+
     public function __construct()
     {
         $this->description = '';
@@ -166,6 +172,7 @@ public function __construct()
         $this->courseCategory = new ArrayCollection();
         $this->children = new ArrayCollection();
         $this->colorThemes = new ArrayCollection();
+        $this->plugins = new ArrayCollection();
     }
 
     public function __toString(): string
@@ -547,4 +554,34 @@ public function getColorThemeByTheme(ColorTheme $theme): ?AccessUrlRelColorTheme
 
         return $this->colorThemes->matching($criteria)->first() ?: null;
     }
+
+    /**
+     * @return Collection<int, AccessUrlRelPlugin>
+     */
+    public function getPlugins(): Collection
+    {
+        return $this->plugins;
+    }
+
+    public function addPlugin(AccessUrlRelPlugin $plugin): static
+    {
+        if (!$this->plugins->contains($plugin)) {
+            $this->plugins->add($plugin);
+            $plugin->setUrl($this);
+        }
+
+        return $this;
+    }
+
+    public function removePlugin(AccessUrlRelPlugin $plugin): static
+    {
+        if ($this->plugins->removeElement($plugin)) {
+            // set the owning side to null (unless already changed)
+            if ($plugin->getUrl() === $this) {
+                $plugin->setUrl(null);
+            }
+        }
+
+        return $this;
+    }
 }
diff --git a/src/CoreBundle/Entity/AccessUrlRelPlugin.php b/src/CoreBundle/Entity/AccessUrlRelPlugin.php
@@ -0,0 +1,86 @@
+<?php
+
+/* For licensing terms, see /license.txt */
+
+declare(strict_types=1);
+
+namespace Chamilo\CoreBundle\Entity;
+
+use Chamilo\CoreBundle\Repository\AccessUrlRelPluginRepository;
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity(repositoryClass: AccessUrlRelPluginRepository::class)]
+class AccessUrlRelPlugin
+{
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column]
+    private ?int $id = null;
+
+    #[ORM\ManyToOne(inversedBy: 'accessUrlRelPlugins')]
+    #[ORM\JoinColumn(nullable: false)]
+    private ?Plugin $plugin = null;
+
+    #[ORM\ManyToOne(inversedBy: 'plugins')]
+    #[ORM\JoinColumn(nullable: false)]
+    private ?AccessUrl $url = null;
+
+    #[ORM\Column]
+    private ?bool $active = null;
+
+    #[ORM\Column(nullable: true)]
+    private ?array $configuration = null;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getPlugin(): ?Plugin
+    {
+        return $this->plugin;
+    }
+
+    public function setPlugin(?Plugin $plugin): static
+    {
+        $this->plugin = $plugin;
+
+        return $this;
+    }
+
+    public function getUrl(): ?AccessUrl
+    {
+        return $this->url;
+    }
+
+    public function setUrl(?AccessUrl $url): static
+    {
+        $this->url = $url;
+
+        return $this;
+    }
+
+    public function isActive(): ?bool
+    {
+        return $this->active;
+    }
+
+    public function setActive(bool $active): static
+    {
+        $this->active = $active;
+
+        return $this;
+    }
+
+    public function getConfiguration(): ?array
+    {
+        return $this->configuration;
+    }
+
+    public function setConfiguration(?array $configuration): static
+    {
+        $this->configuration = $configuration;
+
+        return $this;
+    }
+}
diff --git a/src/CoreBundle/Entity/Plugin.php b/src/CoreBundle/Entity/Plugin.php
@@ -1,52 +1,49 @@
 <?php
 
-declare(strict_types=1);
-
 /* For licensing terms, see /license.txt */
 
+declare(strict_types=1);
+
 namespace Chamilo\CoreBundle\Entity;
 
-use ApiPlatform\Metadata\ApiResource;
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
-use Symfony\Component\Serializer\Annotation\Groups;
 
-#[ApiResource]
 #[ORM\Entity]
 #[ORM\Table(name: 'plugin')]
 class Plugin
 {
+    public const SOURCE_THIRD_PARTY = 'third_party';
+    public const SOURCE_OFFICIAL = 'official';
+
     #[ORM\Id]
     #[ORM\GeneratedValue]
     #[ORM\Column(type: 'integer')]
     private ?int $id = null;
 
     #[ORM\Column(type: 'string', length: 255, unique: true)]
-    #[Groups(['plugin:read', 'plugin:write'])]
     private string $title;
 
     #[ORM\Column(type: 'boolean')]
-    #[Groups(['plugin:read', 'plugin:write'])]
     private bool $installed = false;
 
-    #[ORM\Column(type: 'boolean')]
-    #[Groups(['plugin:read', 'plugin:write'])]
-    private bool $active = false;
-
     #[ORM\Column(type: 'string', length: 20)]
-    #[Groups(['plugin:read', 'plugin:write'])]
-    private string $version;
+    private string $installedVersion;
 
-    #[ORM\Column(type: 'integer')]
-    #[Groups(['plugin:read', 'plugin:write'])]
-    private int $accessUrlId;
+    #[ORM\Column(type: 'string', length: 20, options: ['default' => self::SOURCE_THIRD_PARTY])]
+    private string $source = 'third_party';
 
-    #[ORM\Column(type: 'json', nullable: true)]
-    #[Groups(['plugin:read', 'plugin:write'])]
-    private ?array $configuration = [];
+    /**
+     * @var Collection<int, AccessUrlRelPlugin>
+     */
+    #[ORM\OneToMany(mappedBy: 'plugin', targetEntity: AccessUrlRelPlugin::class, orphanRemoval: true)]
+    private Collection $urls;
 
-    #[ORM\Column(type: 'string', length: 20, options: ["default" => "third_party"])]
-    #[Groups(['plugin:read', 'plugin:write'])]
-    private string $source = 'third_party';
+    public function __construct()
+    {
+        $this->urls = new ArrayCollection();
+    }
 
     public function getId(): ?int
     {
@@ -61,6 +58,7 @@ public function getTitle(): string
     public function setTitle(string $title): self
     {
         $this->title = $title;
+
         return $this;
     }
 
@@ -72,61 +70,61 @@ public function isInstalled(): bool
     public function setInstalled(bool $installed): self
     {
         $this->installed = $installed;
-        return $this;
-    }
-
-    public function isActive(): bool
-    {
-        return $this->active;
-    }
 
-    public function setActive(bool $active): self
-    {
-        $this->active = $active;
         return $this;
     }
 
-    public function getVersion(): string
+    public function getInstalledVersion(): string
     {
-        return $this->version;
+        return $this->installedVersion;
     }
 
-    public function setVersion(string $version): self
+    public function setInstalledVersion(string $installedVersion): self
     {
-        $this->version = $version;
+        $this->installedVersion = $installedVersion;
+
         return $this;
     }
 
-    public function getAccessUrlId(): int
+    public function getSource(): string
     {
-        return $this->accessUrlId;
+        return $this->source;
     }
 
-    public function setAccessUrlId(int $accessUrlId): self
+    public function setSource(string $source): self
     {
-        $this->accessUrlId = $accessUrlId;
+        $this->source = $source;
+
         return $this;
     }
 
-    public function getConfiguration(): ?array
+    /**
+     * @return Collection<int, AccessUrlRelPlugin>
+     */
+    public function getUrls(): Collection
     {
-        return $this->configuration;
+        return $this->urls;
     }
 
-    public function setConfiguration(?array $configuration): self
+    public function addUrl(AccessUrlRelPlugin $url): static
     {
-        $this->configuration = $configuration;
+        if (!$this->urls->contains($url)) {
+            $this->urls->add($url);
+            $url->setPlugin($this);
+        }
+
         return $this;
     }
 
-    public function getSource(): string
+    public function removeUrl(AccessUrlRelPlugin $url): static
     {
-        return $this->source;
-    }
+        if ($this->urls->removeElement($url)) {
+            // set the owning side to null (unless already changed)
+            if ($url->getPlugin() === $this) {
+                $url->setPlugin(null);
+            }
+        }
 
-    public function setSource(string $source): self
-    {
-        $this->source = $source;
         return $this;
     }
 }
diff --git a/src/CoreBundle/Migrations/Schema/V200/Version20250306100000.php b/src/CoreBundle/Migrations/Schema/V200/Version20250306100000.php
@@ -1,5 +1,7 @@
 <?php
 
+/* For licensing terms, see /license.txt */
+
 declare(strict_types=1);
 
 namespace Chamilo\CoreBundle\Migrations\Schema\V200;
@@ -17,23 +19,17 @@ public function getDescription(): string
     public function up(Schema $schema): void
     {
         // Create the plugin table
-        $this->addSql("
-            CREATE TABLE plugin (
-                id INT AUTO_INCREMENT PRIMARY KEY,
-                title VARCHAR(255) UNIQUE NOT NULL,
-                installed TINYINT(1) NOT NULL DEFAULT 0,
-                active TINYINT(1) NOT NULL DEFAULT 0,
-                version VARCHAR(20) NOT NULL DEFAULT '1.0.0',
-                access_url_id INT NOT NULL,
-                configuration JSON DEFAULT NULL,
-                source ENUM('official', 'third_party') NOT NULL DEFAULT 'third_party'
-            );
-        ");
+        $this->addSql("CREATE TABLE plugin (id INT AUTO_INCREMENT NOT NULL, title VARCHAR(255) NOT NULL, installed TINYINT(1) NOT NULL, installed_version VARCHAR(20) NOT NULL, source VARCHAR(20) DEFAULT 'third_party' NOT NULL, UNIQUE INDEX UNIQ_E96E27942B36786B (title), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB ROW_FORMAT = DYNAMIC");
+
+        $this->addSql("CREATE TABLE access_url_rel_plugin (id INT AUTO_INCREMENT NOT NULL, plugin_id INT NOT NULL, url_id INT NOT NULL, active TINYINT(1) NOT NULL, configuration LONGTEXT DEFAULT NULL COMMENT '(DC2Type:json)', INDEX IDX_7167B425EC942BCF (plugin_id), INDEX IDX_7167B42581CFDAE7 (url_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB ROW_FORMAT = DYNAMIC");
+        $this->addSql("ALTER TABLE access_url_rel_plugin ADD CONSTRAINT FK_7167B425EC942BCF FOREIGN KEY (plugin_id) REFERENCES plugin (id)");
+        $this->addSql("ALTER TABLE access_url_rel_plugin ADD CONSTRAINT FK_7167B42581CFDAE7 FOREIGN KEY (url_id) REFERENCES access_url (id)");
     }
 
     public function down(Schema $schema): void
     {
         // Drop the plugin table if rolling back the migration
+        $this->addSql("DROP TABLE access_url_rel_plugin;");
         $this->addSql("DROP TABLE plugin;");
     }
 }
diff --git a/src/CoreBundle/Migrations/Schema/V200/Version20250306101000.php b/src/CoreBundle/Migrations/Schema/V200/Version20250306101000.php
diff --git a/src/CoreBundle/Repository/AccessUrlRelPluginRepository.php b/src/CoreBundle/Repository/AccessUrlRelPluginRepository.php
