Add auto configuration for a php server configuration with path mapping

Author: nico-loeber

src/main/java/de/php_perfect/intellij/ddev/php/server/ConfigureServerListener.java

@@ -0,0 +1,41 @@
+package de.php_perfect.intellij.ddev.php.server;
+
+import com.intellij.openapi.project.Project;
+import de.php_perfect.intellij.ddev.DescriptionChangedListener;
+import de.php_perfect.intellij.ddev.cmd.Description;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+
+public final class ConfigureServerListener implements DescriptionChangedListener {
+    private final @NotNull Project project;
+
+    public ConfigureServerListener(@NotNull Project project) {
+        this.project = project;
+    }
+
+    @Override
+    public void onDescriptionChanged(@Nullable Description description) {
+        String localPath = this.project.getBasePath();
+
+        if (description == null || localPath == null) {
+            return;
+        }
+
+        if (description.getPrimaryUrl() == null) {
+            return;
+        }
+
+        URL url;
+        try {
+            url = new URL(description.getPrimaryUrl());
+        } catch (MalformedURLException ignored) {
+            return;
+        }
+
+        ServerConfig serverConfig = new ServerConfig(localPath, "/var/www/html", url);
+        ServerConfigManager.getInstance(this.project).configure(serverConfig);
+    }
+}

src/main/java/de/php_perfect/intellij/ddev/php/server/ServerConfig.java

@@ -0,0 +1,54 @@
+package de.php_perfect.intellij.ddev.php.server;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.net.URL;
+import java.util.Objects;
+
+public final class ServerConfig {
+    private final @NotNull String localPath;
+
+    private final @NotNull String remotePath;
+
+    private final @NotNull URL url;
+
+    public ServerConfig(@NotNull String localPath, @NotNull String remotePathPath, @NotNull URL url) {
+        this.localPath = localPath;
+        this.remotePath = remotePathPath;
+        this.url = url;
+    }
+
+    public @NotNull String getLocalPath() {
+        return localPath;
+    }
+
+    public @NotNull String getRemotePath() {
+        return remotePath;
+    }
+
+    public @NotNull URL getUrl() {
+        return url;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        ServerConfig that = (ServerConfig) o;
+        return getLocalPath().equals(that.getLocalPath()) && getRemotePath().equals(that.getRemotePath()) && getUrl().equals(that.getUrl());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(getLocalPath(), getRemotePath(), getUrl());
+    }
+
+    @Override
+    public String toString() {
+        return "ServerConfig{" +
+                "localPath='" + localPath + '\'' +
+                ", remotePath='" + remotePath + '\'' +
+                ", url=" + url +
+                '}';
+    }
+}

src/main/java/de/php_perfect/intellij/ddev/php/server/ServerConfigManager.java

@@ -0,0 +1,12 @@
+package de.php_perfect.intellij.ddev.php.server;
+
+import com.intellij.openapi.project.Project;
+import org.jetbrains.annotations.NotNull;
+
+public interface ServerConfigManager {
+    void configure(@NotNull ServerConfig serverConfig);
+
+    static ServerConfigManager getInstance(@NotNull Project project) {
+        return project.getService(ServerConfigManager.class);
+    }
+}

src/main/java/de/php_perfect/intellij/ddev/php/server/ServerConfigManagerImpl.java

@@ -0,0 +1,47 @@
+package de.php_perfect.intellij.ddev.php.server;
+
+import com.intellij.openapi.diagnostic.Logger;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.text.StringUtil;
+import com.intellij.util.PathMappingSettings;
+import com.jetbrains.php.config.servers.PhpServer;
+import com.jetbrains.php.config.servers.PhpServersWorkspaceStateComponent;
+import de.php_perfect.intellij.ddev.deployment.DeploymentConfigManagerImpl;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.List;
+
+public final class ServerConfigManagerImpl implements ServerConfigManager {
+    private static final @NotNull Logger LOG = Logger.getInstance(DeploymentConfigManagerImpl.class);
+
+    private final static @NotNull String SERVER_NAME = "DDEV";
+
+    private final @NotNull Project project;
+
+    public ServerConfigManagerImpl(final @NotNull Project project) {
+        this.project = project;
+    }
+
+    public void configure(final @NotNull ServerConfig serverConfig) {
+        LOG.debug(String.format("Updating server configuration %s", SERVER_NAME));
+        this.addOrReplaceServer(
+                PhpServersWorkspaceStateComponent.getInstance(project).getServers(),
+                createServerConfiguration(serverConfig)
+        );
+    }
+
+    private @NotNull PhpServer createServerConfiguration(final @NotNull ServerConfig serverConfig) {
+        final PhpServer phpServer = new PhpServer();
+        phpServer.setName(SERVER_NAME);
+        phpServer.setHost(serverConfig.getUrl().getHost());
+        phpServer.setUsePathMappings(true);
+        phpServer.getMappings().add(new PathMappingSettings.PathMapping(serverConfig.getLocalPath(), serverConfig.getRemotePath()));
+
+        return phpServer;
+    }
+
+    private void addOrReplaceServer(final @NotNull List<PhpServer> servers, final @NotNull PhpServer server) {
+        servers.removeIf(phpServer -> StringUtil.equals(phpServer.getName(), server.getName()));
+        servers.add(server);
+    }
+}

src/main/resources/META-INF/DdevIntegration-withPhp.xml

@@ -3,6 +3,8 @@
     <depends>Docker</depends>
 
     <extensions defaultExtensionNs="com.intellij">
+        <projectService serviceImplementation="de.php_perfect.intellij.ddev.php.server.ServerConfigManagerImpl"
+                        serviceInterface="de.php_perfect.intellij.ddev.php.server.ServerConfigManager"/>
         <projectService serviceImplementation="de.php_perfect.intellij.ddev.php.PhpInterpreterProviderImpl"
                         serviceInterface="de.php_perfect.intellij.ddev.php.PhpInterpreterProvider"/>
         <projectService serviceImplementation="de.php_perfect.intellij.ddev.php.DdevComposeFileLoaderImpl"
@@ -16,6 +18,8 @@
     </extensions>
 
     <projectListeners>
+        <listener class="de.php_perfect.intellij.ddev.php.server.ConfigureServerListener"
+                  topic="de.php_perfect.intellij.ddev.DescriptionChangedListener"/>
         <listener class="de.php_perfect.intellij.ddev.php.AutoConfigurePhpInterpreterListener"
                   topic="de.php_perfect.intellij.ddev.DescriptionChangedListener"/>
     </projectListeners>

src/test/java/de/php_perfect/intellij/ddev/php/server/ServerConfigManagerImplTest.java

@@ -0,0 +1,57 @@
+package de.php_perfect.intellij.ddev.php.server;
+
+import com.intellij.testFramework.fixtures.BasePlatformTestCase;
+import com.jetbrains.php.config.servers.PhpServer;
+import com.jetbrains.php.config.servers.PhpServersWorkspaceStateComponent;
+import org.junit.Assert;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.List;
+
+final class ServerConfigManagerImplTest extends BasePlatformTestCase {
+
+    @Override
+    @BeforeEach
+    protected void setUp() throws Exception {
+        super.setUp();
+    }
+
+    @Test
+    void configure() throws MalformedURLException {
+        final ServerConfigManager serverConfigManager = ServerConfigManager.getInstance(this.getProject());
+
+        final ServerConfig serverConfig = new ServerConfig(
+                "C:\\Users\\test\\AppData\\Local\\Temp\\my-project",
+                "/var/www/html",
+                new URL("https://test.ddev.site")
+        );
+
+        serverConfigManager.configure(serverConfig);
+        // Check server gets replaced
+        serverConfigManager.configure(serverConfig);
+
+        assertServerConfigMatches(serverConfig);
+    }
+
+    private void assertServerConfigMatches(ServerConfig serverConfig) {
+        final List<PhpServer> servers = PhpServersWorkspaceStateComponent.getInstance(this.getProject()).getServers();
+
+        Assert.assertEquals(1, servers.size());
+
+        final PhpServer server = servers.get(0);
+        Assert.assertEquals("DDEV", server.getName());
+        Assert.assertEquals("test.ddev.site", server.getHost());
+
+        var mappings = server.getMappings();
+
+        Assert.assertEquals(1, mappings.size());
+
+        var mapping = mappings.get(0);
+
+        Assert.assertEquals(serverConfig.getLocalPath(), mapping.getLocalRoot());
+        Assert.assertEquals(serverConfig.getRemotePath(), mapping.getRemoteRoot());
+    }
+}