Merge pull request #1218 from scm-manager/feature/rename_repo

Feature/rename repo

scm-webapp/src/main/java/sonia/scm/api/v2/resources/RepositoryRenameDto.java

@@ -0,0 +1,39 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api.v2.resources;
+
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import sonia.scm.util.ValidationUtil;
+
+import javax.validation.constraints.Pattern;
+
+@Getter
+@NoArgsConstructor
+public class RepositoryRenameDto {
+  @Pattern(regexp = ValidationUtil.REGEX_REPOSITORYNAME)
+  private String name;
+  private String namespace;
+}

scm-webapp/src/main/java/sonia/scm/api/v2/resources/RepositoryResource.java

@@ -34,11 +34,11 @@ import sonia.scm.repository.RepositoryManager;
 import sonia.scm.web.VndMediaType;
 
 import javax.inject.Inject;
-import javax.inject.Provider;
 import javax.validation.Valid;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.DELETE;
 import javax.ws.rs.GET;
+import javax.ws.rs.POST;
 import javax.ws.rs.PUT;
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
@@ -64,8 +64,7 @@ public class RepositoryResource {
   public RepositoryResource(
     RepositoryToRepositoryDtoMapper repositoryToDtoMapper,
     RepositoryDtoToRepositoryMapper dtoToRepositoryMapper, RepositoryManager manager,
-    RepositoryBasedResourceProvider resourceProvider
-  ) {
+    RepositoryBasedResourceProvider resourceProvider) {
     this.dtoToRepositoryMapper = dtoToRepositoryMapper;
     this.manager = manager;
     this.repositoryToDtoMapper = repositoryToDtoMapper;
@@ -79,8 +78,7 @@ public class RepositoryResource {
    * <strong>Note:</strong> This method requires "repository" privilege.
    *
    * @param namespace the namespace of the repository
-   * @param name the name of the repository
-   *
+   * @param name      the name of the repository
    */
   @GET
   @Path("")
@@ -118,7 +116,7 @@ public class RepositoryResource {
       schema = @Schema(implementation = ErrorDto.class)
     )
   )
-  public Response get(@PathParam("namespace") String namespace, @PathParam("name") String name){
+  public Response get(@PathParam("namespace") String namespace, @PathParam("name") String name) {
     return adapter.get(loadBy(namespace, name), repositoryToDtoMapper::map);
   }
 
@@ -128,8 +126,7 @@ public class RepositoryResource {
    * <strong>Note:</strong> This method requires "repository" privilege.
    *
    * @param namespace the namespace of the repository to delete
-   * @param name the name of the repository to delete
-   *
+   * @param name      the name of the repository to delete
    */
   @DELETE
   @Path("")
@@ -147,8 +144,8 @@ public class RepositoryResource {
    *
    * <strong>Note:</strong> This method requires "repository" privilege.
    *
-   * @param namespace the namespace of the repository to be modified
-   * @param name the name of the repository to be modified
+   * @param namespace  the namespace of the repository to be modified
+   * @param name       the name of the repository to be modified
    * @param repository repository object to modify
    */
   @PUT
@@ -176,6 +173,37 @@ public class RepositoryResource {
     );
   }
 
+  /**
+   * Renames the given repository.
+   *
+   * <strong>Note:</strong> This method requires "repository" privilege.
+   *
+   * @param namespace the namespace of the repository to be modified
+   * @param name      the name of the repository to be modified
+   * @param renameDto renameDto object to modify
+   */
+  @POST
+  @Path("rename")
+  @Consumes(VndMediaType.REPOSITORY)
+  @Operation(summary = "Rename repository", description = "Renames the repository for the given namespace and name.", tags = "Repository")
+  @ApiResponse(responseCode = "204", description = "update success")
+  @ApiResponse(responseCode = "400", description = "invalid body, e.g. illegal change of namespace or name")
+  @ApiResponse(responseCode = "401", description = "not authenticated / invalid credentials")
+  @ApiResponse(responseCode = "403", description = "not authorized, the current user does not have the \"repository:renameDto\" privilege")
+  @ApiResponse(
+    responseCode = "404",
+    description = "not found, no repository with the specified namespace and name available",
+    content = @Content(
+      mediaType = VndMediaType.ERROR_TYPE,
+      schema = @Schema(implementation = ErrorDto.class)
+    ))
+  @ApiResponse(responseCode = "500", description = "internal server error")
+  public Response rename(@PathParam("namespace") String namespace, @PathParam("name") String name, @Valid RepositoryRenameDto renameDto) {
+    Repository repository = loadBy(namespace, name).get();
+    manager.rename(repository, renameDto.getNamespace(), renameDto.getName());
+    return Response.status(204).build();
+  }
+
   private Repository processUpdate(RepositoryDto repositoryDto, Repository existing) {
     Repository changedRepository = dtoToRepositoryMapper.map(repositoryDto, existing.getId());
     changedRepository.setPermissions(existing.getPermissions());

scm-webapp/src/main/java/sonia/scm/api/v2/resources/RepositoryToRepositoryDtoMapper.java

@@ -24,14 +24,15 @@
 
 package sonia.scm.api.v2.resources;
 
-import com.google.inject.Inject;
 import de.otto.edison.hal.Embedded;
 import de.otto.edison.hal.Link;
 import de.otto.edison.hal.Links;
 import org.mapstruct.Mapper;
 import org.mapstruct.ObjectFactory;
+import sonia.scm.config.ScmConfiguration;
 import sonia.scm.repository.Feature;
 import sonia.scm.repository.HealthCheckFailure;
+import sonia.scm.repository.NamespaceStrategy;
 import sonia.scm.repository.Repository;
 import sonia.scm.repository.RepositoryPermissions;
 import sonia.scm.repository.api.Command;
@@ -41,7 +42,9 @@ import sonia.scm.repository.api.ScmProtocol;
 import sonia.scm.web.EdisonHalAppender;
 import sonia.scm.web.api.RepositoryToHalMapper;
 
+import javax.inject.Inject;
 import java.util.List;
+import java.util.Set;
 
 import static de.otto.edison.hal.Embedded.embeddedBuilder;
 import static de.otto.edison.hal.Link.link;
@@ -56,7 +59,11 @@ public abstract class RepositoryToRepositoryDtoMapper extends BaseMapper<Reposit
   @Inject
   private ResourceLinks resourceLinks;
   @Inject
+  private ScmConfiguration scmConfiguration;
+  @Inject
   private RepositoryServiceFactory serviceFactory;
+  @Inject
+  private Set<NamespaceStrategy> strategies;
 
   abstract HealthCheckFailureDto toDto(HealthCheckFailure failure);
 
@@ -72,6 +79,13 @@ public abstract class RepositoryToRepositoryDtoMapper extends BaseMapper<Reposit
     if (RepositoryPermissions.modify(repository).isPermitted()) {
       linksBuilder.single(link("update", resourceLinks.repository().update(repository.getNamespace(), repository.getName())));
     }
+    if (RepositoryPermissions.rename(repository).isPermitted()) {
+      if (isRenameNamespacePossible()) {
+        linksBuilder.single(link("renameWithNamespace", resourceLinks.repository().rename(repository.getNamespace(), repository.getName())));
+      } else {
+        linksBuilder.single(link("rename", resourceLinks.repository().rename(repository.getNamespace(), repository.getName())));
+      }
+    }
     if (RepositoryPermissions.permissionRead(repository).isPermitted()) {
       linksBuilder.single(link("permissions", resourceLinks.repositoryPermission().all(repository.getNamespace(), repository.getName())));
     }
@@ -105,6 +119,15 @@ public abstract class RepositoryToRepositoryDtoMapper extends BaseMapper<Reposit
     return new RepositoryDto(linksBuilder.build(), embeddedBuilder.build());
   }
 
+  private boolean isRenameNamespacePossible() {
+    for (NamespaceStrategy strategy : strategies) {
+      if (strategy.getClass().getSimpleName().equals(scmConfiguration.getNamespaceStrategy())) {
+        return strategy.canBeChanged();
+      }
+    }
+    return false;
+  }
+
   private Link createProtocolLink(ScmProtocol protocol) {
     return Link.linkBuilder("protocol", protocol.getUrl()).withName(protocol.getType()).build();
   }

scm-webapp/src/main/java/sonia/scm/api/v2/resources/ResourceLinks.java

@@ -279,6 +279,10 @@ class ResourceLinks {
     String update(String namespace, String name) {
       return repositoryLinkBuilder.method("getRepositoryResource").parameters(namespace, name).method("update").parameters().href();
     }
+
+    String rename(String namespace, String name) {
+      return repositoryLinkBuilder.method("getRepositoryResource").parameters(namespace, name).method("rename").parameters().href();
+    }
   }
 
   RepositoryCollectionLinks repositoryCollection() {

scm-webapp/src/main/java/sonia/scm/repository/CustomNamespaceStrategy.java

@@ -41,4 +41,9 @@ public class CustomNamespaceStrategy implements NamespaceStrategy {
 
     return namespace;
   }
+
+  @Override
+  public boolean canBeChanged() {
+    return true;
+  }
 }

scm-webapp/src/main/java/sonia/scm/repository/DefaultRepositoryManager.java

@@ -21,10 +21,11 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-    
+
 package sonia.scm.repository;
 
 import com.github.sdorra.ssp.PermissionActionCheck;
+import com.google.common.base.Strings;
 import com.google.common.collect.Lists;
 import com.google.common.util.concurrent.ThreadFactoryBuilder;
 import com.google.inject.Inject;
@@ -35,6 +36,7 @@ import org.slf4j.LoggerFactory;
 import sonia.scm.ConfigurationException;
 import sonia.scm.HandlerEventType;
 import sonia.scm.ManagerDaoAdapter;
+import sonia.scm.NoChangesMadeException;
 import sonia.scm.NotFoundException;
 import sonia.scm.SCMContextProvider;
 import sonia.scm.Type;
@@ -83,7 +85,6 @@ public class DefaultRepositoryManager extends AbstractRepositoryManager {
   private final Provider<NamespaceStrategy> namespaceStrategyProvider;
   private final ManagerDaoAdapter<Repository> managerDaoAdapter;
 
-
   @Inject
   public DefaultRepositoryManager(ScmConfiguration configuration,
                                   SCMContextProvider contextProvider, KeyGenerator keyGenerator,
@@ -154,7 +155,7 @@ public class DefaultRepositoryManager extends AbstractRepositoryManager {
   }
 
   @Override
-  public void delete(Repository repository){
+  public void delete(Repository repository) {
     logger.info("delete repository {}/{} of type {}", repository.getNamespace(), repository.getName(), repository.getType());
     managerDaoAdapter.delete(
       repository,
@@ -179,7 +180,7 @@ public class DefaultRepositoryManager extends AbstractRepositoryManager {
   }
 
   @Override
-  public void modify(Repository repository){
+  public void modify(Repository repository) {
     logger.info("modify repository {}/{} of type {}", repository.getNamespace(), repository.getName(), repository.getType());
 
     managerDaoAdapter.modify(
@@ -243,6 +244,40 @@ public class DefaultRepositoryManager extends AbstractRepositoryManager {
     return repository;
   }
 
+  public Repository rename(Repository repository, String newNamespace, String newName) {
+
+    if (hasNamespaceOrNameNotChanged(repository, newNamespace, newName)) {
+      throw new NoChangesMadeException(repository);
+    }
+
+    Repository changedRepository = repository.clone();
+    if (!Strings.isNullOrEmpty(newName)) {
+      changedRepository.setName(newName);
+    }
+
+    if (!Strings.isNullOrEmpty(newNamespace) && !repository.getNamespace().equals(newNamespace)) {
+      NamespaceStrategy strategy = namespaceStrategyProvider.get();
+      if (!strategy.canBeChanged()) {
+        throw new ChangeNamespaceNotAllowedException(repository);
+      }
+      changedRepository.setNamespace(strategy.createNamespace(changedRepository));
+    }
+
+    managerDaoAdapter.modify(
+      changedRepository,
+      RepositoryPermissions::rename,
+      notModified -> {
+      },
+      notModified -> fireEvent(HandlerEventType.MODIFY, changedRepository, repository));
+
+    return changedRepository;
+  }
+
+  private boolean hasNamespaceOrNameNotChanged(Repository repository, String newNamespace, String newName) {
+    return repository.getName().equals(newName)
+      && repository.getNamespace().equals(newNamespace);
+  }
+
   @Override
   public Collection<Repository> getAll(Predicate<Repository> filter, Comparator<Repository> comparator) {
     List<Repository> repositories = Lists.newArrayList();
@@ -345,8 +380,7 @@ public class DefaultRepositoryManager extends AbstractRepositoryManager {
     types.add(type);
   }
 
-  private RepositoryHandler getHandler(Repository repository)
-    {
+  private RepositoryHandler getHandler(Repository repository) {
     String type = repository.getType();
     RepositoryHandler handler = handlerMap.get(type);