Extract common code

2025-11-12 08:25:44 +01:00 · 2019-06-03 15:24:19 +02:00
parent 0be816dd28
commit 7c50ad07ec
32 changed files with 143 additions and 126 deletions
--- a/scm-webapp/src/main/java/sonia/scm/update/group/XmlGroupV1UpdateStep.java
+++ b/scm-webapp/src/main/java/sonia/scm/update/group/XmlGroupV1UpdateStep.java
@@ -0,0 +1,157 @@
+package sonia.scm.update.group;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import sonia.scm.SCMContextProvider;
+import sonia.scm.group.Group;
+import sonia.scm.group.xml.XmlGroupDAO;
+import sonia.scm.migration.UpdateException;
+import sonia.scm.migration.UpdateStep;
+import sonia.scm.plugin.Extension;
+import sonia.scm.store.ConfigurationEntryStore;
+import sonia.scm.store.ConfigurationEntryStoreFactory;
+import sonia.scm.store.StoreConstants;
+import sonia.scm.update.properties.V1Properties;
+import sonia.scm.version.Version;
+
+import javax.inject.Inject;
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+import java.util.Optional;
+
+import static java.util.Optional.empty;
+import static java.util.Optional.of;
+import static sonia.scm.version.Version.parse;
+
+@Extension
+public class XmlGroupV1UpdateStep implements UpdateStep {
+
+  private static final Logger LOG = LoggerFactory.getLogger(XmlGroupV1UpdateStep.class);
+
+  private final SCMContextProvider contextProvider;
+  private final XmlGroupDAO groupDAO;
+  private final ConfigurationEntryStore<V1Properties> propertyStore;
+
+  @Inject
+  public XmlGroupV1UpdateStep(
+    SCMContextProvider contextProvider,
+    XmlGroupDAO groupDAO,
+    ConfigurationEntryStoreFactory configurationEntryStoreFactory
+  ) {
+    this.contextProvider = contextProvider;
+    this.groupDAO = groupDAO;
+    this.propertyStore = configurationEntryStoreFactory
+      .withType(V1Properties.class)
+      .withName("group-properties-v1")
+      .build();
+  }
+
+  @Override
+  public void doUpdate() throws JAXBException {
+    Optional<Path> v1GroupsFile = determineV1File();
+    if (!v1GroupsFile.isPresent()) {
+      LOG.info("no v1 file for groups found");
+      return;
+    }
+    XmlGroupV1UpdateStep.V1GroupDatabase v1Database = readV1Database(v1GroupsFile.get());
+    v1Database.groupList.groups.forEach(this::update);
+  }
+
+  @Override
+  public Version getTargetVersion() {
+    return parse("2.0.0");
+  }
+
+  @Override
+  public String getAffectedDataType() {
+    return "sonia.scm.group.xml";
+  }
+
+  private void update(V1Group v1Group) {
+    LOG.debug("updating group {}", v1Group.name);
+    Group group = new Group(
+      v1Group.type,
+      v1Group.name,
+      v1Group.members);
+    group.setDescription(v1Group.description);
+    group.setCreationDate(v1Group.creationDate);
+    group.setLastModified(v1Group.lastModified);
+    groupDAO.add(group);
+
+    propertyStore.put(v1Group.name, v1Group.properties);
+  }
+
+  private XmlGroupV1UpdateStep.V1GroupDatabase readV1Database(Path v1GroupsFile) throws JAXBException {
+    JAXBContext jaxbContext = JAXBContext.newInstance(XmlGroupV1UpdateStep.V1GroupDatabase.class);
+    return (XmlGroupV1UpdateStep.V1GroupDatabase) jaxbContext.createUnmarshaller().unmarshal(v1GroupsFile.toFile());
+  }
+
+  private Optional<Path> determineV1File() {
+    Path configDirectory = determineConfigDirectory();
+    Path existingGroupsFile = configDirectory.resolve("groups" + StoreConstants.FILE_EXTENSION);
+    Path groupsV1File = configDirectory.resolve("groupsV1" + StoreConstants.FILE_EXTENSION);
+    if (existingGroupsFile.toFile().exists()) {
+      try {
+        Files.move(existingGroupsFile, groupsV1File);
+      } catch (IOException e) {
+        throw new UpdateException("could not move old groups file to " + groupsV1File.toAbsolutePath());
+      }
+      LOG.info("moved old groups file to {}", groupsV1File.toAbsolutePath());
+      return of(groupsV1File);
+    }
+    return empty();
+  }
+
+  private Path determineConfigDirectory() {
+    return new File(contextProvider.getBaseDirectory(), StoreConstants.CONFIG_DIRECTORY_NAME).toPath();
+  }
+
+  @XmlAccessorType(XmlAccessType.FIELD)
+  @XmlRootElement(name = "group")
+  private static class V1Group {
+    private V1Properties properties;
+    private long creationDate;
+    private String description;
+    private Long lastModified;
+    private String name;
+    private String type;
+    @XmlElement(name = "members")
+    private List<String> members;
+
+    @Override
+    public String toString() {
+      return "V1Group{" +
+        "properties=" + properties +
+        ", creationDate=" + creationDate + '\'' +
+        ", description=" + description + '\'' +
+        ", lastModified=" + lastModified + '\'' +
+        ", name='" + name + '\'' +
+        ", type='" + type + '\'' +
+        '}';
+    }
+  }
+
+  private static class GroupList {
+    @XmlElement(name = "group")
+    private List<V1Group> groups;
+  }
+
+  @XmlRootElement(name = "group-db")
+  @XmlAccessorType(XmlAccessType.FIELD)
+  private static class V1GroupDatabase {
+    private long creationTime;
+    private Long lastModified;
+    @XmlElement(name = "groups")
+    private XmlGroupV1UpdateStep.GroupList groupList;
+  }
+
+}