HgPlugin Config: Adds v2 endpoint

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/api/v2/resources/HgConfigDto.java

@@ -0,0 +1,30 @@
+package sonia.scm.api.v2.resources;
+
+import de.otto.edison.hal.HalRepresentation;
+import de.otto.edison.hal.Links;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+import java.io.File;
+
+@NoArgsConstructor
+@Getter
+@Setter
+public class HgConfigDto extends HalRepresentation {
+
+  private boolean disabled;
+  private File repositoryDirectory;
+
+  private String encoding;
+  private String hgBinary;
+  private String pythonBinary;
+  private String pythonPath;
+  private boolean useOptimizedBytecode;
+  private boolean showRevisionInId;
+
+  @Override
+  protected HalRepresentation add(Links links) {
+    return super.add(links);
+  }
+}

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/api/v2/resources/HgConfigDtoToHgConfigMapper.java

@@ -0,0 +1,11 @@
+package sonia.scm.api.v2.resources;
+
+import org.mapstruct.Mapper;
+import sonia.scm.repository.HgConfig;
+
+// Mapstruct does not support parameterized (i.e. non-default) constructors. Thus, we need to use field injection.
+@SuppressWarnings("squid:S3306")
+@Mapper
+public abstract class HgConfigDtoToHgConfigMapper {
+  public abstract HgConfig map(HgConfigDto dto);
+}

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/api/v2/resources/HgConfigResource.java

@@ -0,0 +1,100 @@
+package sonia.scm.api.v2.resources;
+
+import com.webcohesion.enunciate.metadata.rs.ResponseCode;
+import com.webcohesion.enunciate.metadata.rs.StatusCodes;
+import com.webcohesion.enunciate.metadata.rs.TypeHint;
+import sonia.scm.config.ConfigurationPermissions;
+import sonia.scm.repository.HgConfig;
+import sonia.scm.repository.HgRepositoryHandler;
+import sonia.scm.repository.HgVndMediaType;
+
+import javax.inject.Inject;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.PUT;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.UriInfo;
+
+/**
+ * RESTful Web Service Resource to manage the configuration of the hg plugin.
+ */
+@Path(HgConfigResource.GIT_CONFIG_PATH_V2)
+public class HgConfigResource {
+
+  static final String GIT_CONFIG_PATH_V2 = "v2/config/hg";
+  private final HgConfigDtoToHgConfigMapper dtoToConfigMapper;
+  private final HgConfigToHgConfigDtoMapper configToDtoMapper;
+  private final HgRepositoryHandler repositoryHandler;
+
+  @Inject
+  public HgConfigResource(HgConfigDtoToHgConfigMapper dtoToConfigMapper, HgConfigToHgConfigDtoMapper configToDtoMapper,
+                          HgRepositoryHandler repositoryHandler) {
+    this.dtoToConfigMapper = dtoToConfigMapper;
+    this.configToDtoMapper = configToDtoMapper;
+    this.repositoryHandler = repositoryHandler;
+  }
+
+  /**
+   * Returns the hg config.
+   */
+  @GET
+  @Path("")
+  @Produces(HgVndMediaType.HG_CONFIG)
+  @TypeHint(HgConfigDto.class)
+  @StatusCodes({
+    @ResponseCode(code = 200, condition = "success"),
+    @ResponseCode(code = 401, condition = "not authenticated / invalid credentials"),
+    @ResponseCode(code = 403, condition = "not authorized, the current user has no privileges to read the git config"),
+    @ResponseCode(code = 500, condition = "internal server error")
+  })
+  public Response get() {
+
+    HgConfig config = repositoryHandler.getConfig();
+
+    if (config == null) {
+      config = new HgConfig();
+      repositoryHandler.setConfig(config);
+    }
+
+    ConfigurationPermissions.read(config).check();
+
+    return Response.ok(configToDtoMapper.map(config)).build();
+  }
+
+  /**
+   * Modifies the hg config.
+   *
+   * @param configDto new git configuration as DTO
+   */
+  @PUT
+  @Path("")
+  @Consumes(HgVndMediaType.HG_CONFIG)
+  @StatusCodes({
+    @ResponseCode(code = 204, condition = "update success"),
+    @ResponseCode(code = 401, condition = "not authenticated / invalid credentials"),
+    @ResponseCode(code = 403, condition = "not authorized, the current user has no privileges to update the git config"),
+    @ResponseCode(code = 500, condition = "internal server error")
+  })
+  @TypeHint(TypeHint.NO_CONTENT.class)
+  public Response update(@Context UriInfo uriInfo, HgConfigDto configDto) {
+
+    HgConfig config = dtoToConfigMapper.map(configDto);
+
+    ConfigurationPermissions.write(config).check();
+
+    repositoryHandler.setConfig(config);
+    repositoryHandler.storeConfig();
+
+    return Response.noContent().build();
+  }
+
+  // TODO
+  //* `auto-configuration`
+  // * `packages`
+  // * `packages/{pkgId}`
+  // * `installations/hg`
+  //  * `installations/python
+}

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/api/v2/resources/HgConfigToHgConfigDtoMapper.java

@@ -0,0 +1,45 @@
+package sonia.scm.api.v2.resources;
+
+import de.otto.edison.hal.Links;
+import org.mapstruct.AfterMapping;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.MappingTarget;
+import sonia.scm.config.ConfigurationPermissions;
+import sonia.scm.repository.HgConfig;
+
+import javax.inject.Inject;
+
+import static de.otto.edison.hal.Link.link;
+import static de.otto.edison.hal.Links.linkingTo;
+
+// Mapstruct does not support parameterized (i.e. non-default) constructors. Thus, we need to use field injection.
+@SuppressWarnings("squid:S3306")
+@Mapper
+public abstract class HgConfigToHgConfigDtoMapper {
+
+  @Inject
+  private UriInfoStore uriInfoStore;
+
+  @Mapping(target = "attributes", ignore = true) // We do not map HAL attributes
+  public abstract HgConfigDto map(HgConfig config);
+
+  @AfterMapping
+  void appendLinks(HgConfig config, @MappingTarget HgConfigDto target) {
+    Links.Builder linksBuilder = linkingTo().self(self());
+    if (ConfigurationPermissions.write(config).isPermitted()) {
+      linksBuilder.single(link("update", update()));
+    }
+    target.add(linksBuilder.build());
+  }
+
+  private String self() {
+    LinkBuilder linkBuilder = new LinkBuilder(uriInfoStore.get(), HgConfigResource.class);
+    return linkBuilder.method("get").parameters().href();
+  }
+
+  private String update() {
+    LinkBuilder linkBuilder = new LinkBuilder(uriInfoStore.get(), HgConfigResource.class);
+    return linkBuilder.method("update").parameters().href();
+  }
+}

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/HgVndMediaType.java

@@ -0,0 +1,7 @@
+package sonia.scm.repository;
+
+import sonia.scm.web.VndMediaType;
+
+public class HgVndMediaType {
+  public static final String HG_CONFIG = VndMediaType.PREFIX + "hgConfig" + VndMediaType.SUFFIX;
+}

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgServletModule.java

@@ -36,7 +36,9 @@ package sonia.scm.web;
 //~--- non-JDK imports --------------------------------------------------------
 
 import com.google.inject.servlet.ServletModule;
-
+import org.mapstruct.factory.Mappers;
+import sonia.scm.api.v2.resources.HgConfigDtoToHgConfigMapper;
+import sonia.scm.api.v2.resources.HgConfigToHgConfigDtoMapper;
 import sonia.scm.installer.HgPackageReader;
 import sonia.scm.plugin.Extension;
 import sonia.scm.repository.HgContext;
@@ -70,6 +72,9 @@ public class HgServletModule extends ServletModule
     bind(HgHookManager.class);
     bind(HgPackageReader.class);
 
+    bind(HgConfigDtoToHgConfigMapper.class).to(Mappers.getMapper(HgConfigDtoToHgConfigMapper.class).getClass());
+    bind(HgConfigToHgConfigDtoMapper.class).to(Mappers.getMapper(HgConfigToHgConfigDtoMapper.class).getClass());
+
     // bind servlets
     serve(MAPPING_HOOK).with(HgHookCallbackServlet.class);