Merged in feature/migrate_user_v1 (pull request #254)

migrate user v1
2025-11-11 16:05:44 +01:00 · 2019-06-03 13:25:19 +00:00
parent 6bde9f5454 055cee2c4d
commit 3664d69713
10 changed files with 847 additions and 0 deletions
--- a/scm-webapp/src/main/java/sonia/scm/group/update/XmlGroupV1UpdateStep.java
+++ b/scm-webapp/src/main/java/sonia/scm/group/update/XmlGroupV1UpdateStep.java
@@ -0,0 +1,144 @@
+package sonia.scm.group.update;
+
+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.StoreConstants;
+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.Map;
+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;
+
+  @Inject
+  public XmlGroupV1UpdateStep(SCMContextProvider contextProvider, XmlGroupDAO groupDAO) {
+    this.contextProvider = contextProvider;
+    this.groupDAO = groupDAO;
+  }
+
+  @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(group -> update(group));
+  }
+
+  @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);
+  }
+
+  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 Map<String, String> 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;
+  }
+
+}
--- a/scm-webapp/src/main/java/sonia/scm/security/update/XmlSecurityV1UpdateStep.java
+++ b/scm-webapp/src/main/java/sonia/scm/security/update/XmlSecurityV1UpdateStep.java
@@ -0,0 +1,105 @@
+package sonia.scm.security.update;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import sonia.scm.SCMContextProvider;
+import sonia.scm.migration.UpdateStep;
+import sonia.scm.plugin.Extension;
+import sonia.scm.security.AssignedPermission;
+import sonia.scm.store.ConfigurationEntryStore;
+import sonia.scm.store.ConfigurationEntryStoreFactory;
+import sonia.scm.store.StoreConstants;
+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.nio.file.Path;
+import java.util.Arrays;
+import java.util.function.Consumer;
+
+import static java.util.Optional.ofNullable;
+import static sonia.scm.version.Version.parse;
+
+@Extension
+public class XmlSecurityV1UpdateStep implements UpdateStep {
+
+  private static final Logger LOG = LoggerFactory.getLogger(XmlSecurityV1UpdateStep.class);
+
+  private final SCMContextProvider contextProvider;
+  private final ConfigurationEntryStoreFactory configurationEntryStoreFactory;
+
+  @Inject
+  public XmlSecurityV1UpdateStep(SCMContextProvider contextProvider, ConfigurationEntryStoreFactory configurationEntryStoreFactory) {
+    this.contextProvider = contextProvider;
+    this.configurationEntryStoreFactory = configurationEntryStoreFactory;
+  }
+
+  @Override
+  public void doUpdate() throws JAXBException {
+    ConfigurationEntryStore<AssignedPermission> securityStore = createSecurityStore();
+
+    forAllAdmins(user -> createSecurityEntry(user, false, securityStore),
+        group -> createSecurityEntry(group, true, securityStore));
+  }
+
+  private void forAllAdmins(Consumer<String> userConsumer, Consumer<String> groupConsumer) throws JAXBException {
+    Path configDirectory = determineConfigDirectory();
+    Path existingConfigFile = configDirectory.resolve("config" + StoreConstants.FILE_EXTENSION);
+    if (existingConfigFile.toFile().exists()) {
+      forAllAdmins(existingConfigFile, userConsumer, groupConsumer);
+    }
+  }
+
+  private void forAllAdmins(
+    Path existingConfigFile, Consumer<String> userConsumer, Consumer<String> groupConsumer
+  ) throws JAXBException {
+    JAXBContext jaxbContext = JAXBContext.newInstance(XmlSecurityV1UpdateStep.V1Configuration.class);
+    V1Configuration v1Configuration = (V1Configuration) jaxbContext.createUnmarshaller().unmarshal(existingConfigFile.toFile());
+
+    ofNullable(v1Configuration.adminUsers).ifPresent(users -> forAll(users, userConsumer));
+    ofNullable(v1Configuration.adminGroups).ifPresent(groups -> forAll(groups, groupConsumer));
+  }
+
+  private void forAll(String entries, Consumer<String> consumer) {
+    Arrays.stream(entries.split(",")).forEach(consumer);
+  }
+
+
+  @Override
+  public Version getTargetVersion() {
+    return parse("2.0.0");
+  }
+
+  @Override
+  public String getAffectedDataType() {
+    return "sonia.scm.security.xml";
+  }
+
+  private void createSecurityEntry(String name, boolean group, ConfigurationEntryStore<AssignedPermission> securityStore) {
+    LOG.debug("setting admin permissions for {} {}", group? "group": "user", name);
+    securityStore.put(new AssignedPermission(name, group, "*"));
+  }
+
+  private ConfigurationEntryStore<AssignedPermission> createSecurityStore() {
+    return configurationEntryStoreFactory.withType(AssignedPermission.class).withName("security").build();
+  }
+
+  private Path determineConfigDirectory() {
+    return new File(contextProvider.getBaseDirectory(), StoreConstants.CONFIG_DIRECTORY_NAME).toPath();
+  }
+
+  @XmlAccessorType(XmlAccessType.FIELD)
+  @XmlRootElement(name = "scm-config")
+  private static class V1Configuration {
+    @XmlElement(name = "admin-users")
+    private String adminUsers;
+    @XmlElement(name = "admin-groups")
+    private String adminGroups;
+  }
+}
--- a/scm-webapp/src/main/java/sonia/scm/user/update/XmlUserV1UpdateStep.java
+++ b/scm-webapp/src/main/java/sonia/scm/user/update/XmlUserV1UpdateStep.java
@@ -0,0 +1,166 @@
+package sonia.scm.user.update;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import sonia.scm.SCMContextProvider;
+import sonia.scm.migration.UpdateException;
+import sonia.scm.migration.UpdateStep;
+import sonia.scm.plugin.Extension;
+import sonia.scm.security.AssignedPermission;
+import sonia.scm.store.ConfigurationEntryStore;
+import sonia.scm.store.ConfigurationEntryStoreFactory;
+import sonia.scm.store.StoreConstants;
+import sonia.scm.user.User;
+import sonia.scm.user.xml.XmlUserDAO;
+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.Map;
+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 XmlUserV1UpdateStep implements UpdateStep {
+
+  private static final Logger LOG = LoggerFactory.getLogger(XmlUserV1UpdateStep.class);
+
+  private final SCMContextProvider contextProvider;
+  private final XmlUserDAO userDAO;
+  private final ConfigurationEntryStoreFactory configurationEntryStoreFactory;
+
+  @Inject
+  public XmlUserV1UpdateStep(SCMContextProvider contextProvider, XmlUserDAO userDAO, ConfigurationEntryStoreFactory configurationEntryStoreFactory) {
+    this.contextProvider = contextProvider;
+    this.userDAO = userDAO;
+    this.configurationEntryStoreFactory = configurationEntryStoreFactory;
+  }
+
+  @Override
+  public void doUpdate() throws JAXBException {
+    Optional<Path> v1UsersFile = determineV1File();
+    if (!v1UsersFile.isPresent()) {
+      LOG.info("no v1 file for users found");
+      return;
+    }
+    XmlUserV1UpdateStep.V1UserDatabase v1Database = readV1Database(v1UsersFile.get());
+    ConfigurationEntryStore<AssignedPermission> securityStore = createSecurityStore();
+    v1Database.userList.users.forEach(user -> update(user, securityStore));
+  }
+
+  @Override
+  public Version getTargetVersion() {
+    return parse("2.0.0");
+  }
+
+  @Override
+  public String getAffectedDataType() {
+    return "sonia.scm.user.xml";
+  }
+
+  private void update(V1User v1User, ConfigurationEntryStore<AssignedPermission> securityStore) {
+    LOG.debug("updating user {}", v1User.name);
+    User user = new User(
+      v1User.name,
+      v1User.displayName,
+      v1User.mail,
+      v1User.password,
+      v1User.type,
+      v1User.active);
+    user.setCreationDate(v1User.creationDate);
+    user.setLastModified(v1User.lastModified);
+    userDAO.add(user);
+
+    if (v1User.admin) {
+      LOG.debug("setting admin permissions for user {}", v1User.name);
+      securityStore.put(new AssignedPermission(v1User.name, "*"));
+    }
+  }
+
+  private XmlUserV1UpdateStep.V1UserDatabase readV1Database(Path v1UsersFile) throws JAXBException {
+    JAXBContext jaxbContext = JAXBContext.newInstance(XmlUserV1UpdateStep.V1UserDatabase.class);
+    return (XmlUserV1UpdateStep.V1UserDatabase) jaxbContext.createUnmarshaller().unmarshal(v1UsersFile.toFile());
+  }
+
+  private ConfigurationEntryStore<AssignedPermission> createSecurityStore() {
+    return configurationEntryStoreFactory.withType(AssignedPermission.class).withName("security").build();
+  }
+
+  private Optional<Path> determineV1File() {
+    Path configDirectory = determineConfigDirectory();
+    Path existingUsersFile = configDirectory.resolve("users" + StoreConstants.FILE_EXTENSION);
+    Path usersV1File = configDirectory.resolve("usersV1" + StoreConstants.FILE_EXTENSION);
+    if (existingUsersFile.toFile().exists()) {
+      try {
+        Files.move(existingUsersFile, usersV1File);
+      } catch (IOException e) {
+        throw new UpdateException("could not move old users file to " + usersV1File.toAbsolutePath());
+      }
+      LOG.info("moved old users file to {}", usersV1File.toAbsolutePath());
+      return of(usersV1File);
+    }
+    return empty();
+  }
+
+  private Path determineConfigDirectory() {
+    return new File(contextProvider.getBaseDirectory(), StoreConstants.CONFIG_DIRECTORY_NAME).toPath();
+  }
+
+  @XmlAccessorType(XmlAccessType.FIELD)
+  @XmlRootElement(name = "user")
+  private static class V1User {
+    private Map<String, String> properties;
+    private boolean admin;
+    private long creationDate;
+    private String displayName;
+    private Long lastModified;
+    private String mail;
+    private String name;
+    private String password;
+    private String type;
+    private boolean active;
+
+    @Override
+    public String toString() {
+      return "V1User{" +
+        "properties=" + properties +
+        ", admin='" + admin + '\'' +
+        ", creationDate=" + creationDate + '\'' +
+        ", displayName=" + displayName + '\'' +
+        ", lastModified=" + lastModified + '\'' +
+        ", mail='" + mail + '\'' +
+        ", name='" + name + '\'' +
+        ", type='" + type + '\'' +
+        ", active='" + active + '\'' +
+        '}';
+    }
+  }
+
+  private static class UserList {
+    @XmlElement(name = "user")
+    private List<V1User> users;
+  }
+
+  @XmlRootElement(name = "user-db")
+  @XmlAccessorType(XmlAccessType.FIELD)
+  private static class V1UserDatabase {
+    private long creationTime;
+    private Long lastModified;
+    @XmlElement(name = "users")
+    private XmlUserV1UpdateStep.UserList userList;
+  }
+
+}