Basic package manager implementation

build.gradle

@@ -101,6 +101,7 @@ dependencies {
     compile group: 'org.terasology', name: 'CrashReporter', version: '1.2.+'
     compile group: 'com.github.rjeschke', name: 'txtmark', version: '0.11'
 
+    compile 'com.google.code.gson:gson:2.8.5'
     compile group: 'ch.qos.logback', name: 'logback-classic', version: '1.1.2'
 
     // These dependencies are only needed for running tests

src/main/java/org/terasology/launcher/packages/GamePackage.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2019 MovingBlocks
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.terasology.launcher.packages;
+
+/**
+ * Model of a game package.
+ */
+public class GamePackage {
+    // TODO: Implement this
+}

src/main/java/org/terasology/launcher/packages/GamePackageType.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2019 MovingBlocks
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.terasology.launcher.packages;
+
+/**
+ * Enum for types of game package available now.
+ */
+public enum GamePackageType {
+    STABLE("TerasologyStable"),
+    UNSTABLE("Terasology"),
+    OMEGA_STABLE("DistroOmegaRelease"),
+    OMEGA_UNSTABLE("DistroOmega");
+
+    // TODO: Remove this enum when 3rd-party package types are supported
+
+    private final String jobName;
+
+    GamePackageType(String jobName) {
+        this.jobName = jobName;
+    }
+
+    public String getJobName() {
+        return jobName;
+    }
+}

src/main/java/org/terasology/launcher/packages/JenkinsStorage.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2019 MovingBlocks
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.terasology.launcher.packages;
+
+import com.google.gson.Gson;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.terasology.launcher.util.JobResult;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.net.URL;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+/**
+ * Provides game packages from our Jenkins server.
+ */
+public class JenkinsStorage implements Storage {
+
+    private static final Logger logger = LoggerFactory.getLogger(JenkinsStorage.class);
+
+    private static final String JENKINS_JOB_URL = "http://jenkins.terasology.org/job/";
+    private static final String API_PATH = "/api/json?tree=builds[number,result]";
+    private static final int LIMIT_VERSIONS = 20;
+
+    private Gson gson = new Gson();
+
+    @Override
+    public List<Integer> getPackageVersions(GamePackageType pkgType) {
+        final String jobApiPath = JENKINS_JOB_URL + pkgType.getJobName() + API_PATH;
+
+        try (BufferedReader reader = new BufferedReader(
+                new InputStreamReader(
+                        new URL(jobApiPath).openStream()))) {
+
+            final Job result = gson.fromJson(reader, Job.class);
+            return Arrays.stream(result.builds)
+                    .filter(build -> build.result.equals(JobResult.SUCCESS.name()))
+                    .map(build -> build.number)
+                    .limit(LIMIT_VERSIONS)
+                    .collect(Collectors.toList());
+
+        } catch (IOException e) {
+            logger.warn("Failed to access URL: {}", jobApiPath);
+        }
+        return Collections.emptyList();
+    }
+
+    @Override
+    public Optional<GamePackage> getPackage(GamePackageType pkgType, int version) {
+        // TODO: Implement this
+        return Optional.empty();
+    }
+
+    private static class Job {
+        private Build[] builds;
+    }
+
+    private static class Build {
+        private int number;
+        private String result;
+    }
+}

src/main/java/org/terasology/launcher/packages/LocalStorage.java

@@ -0,0 +1,104 @@
+/*
+ * Copyright 2019 MovingBlocks
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.terasology.launcher.packages;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Collections;
+import java.util.EnumMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
+/**
+ * Provides game packages from the local filesystem.
+ */
+public class LocalStorage implements Storage {
+
+    private static final Logger logger = LoggerFactory.getLogger(LocalStorage.class);
+
+    private static final String VERSIONS_CACHE_FILENAME = "versions.cache";
+
+    private final Path versionsCache;
+    private final Map<GamePackageType, List<Integer>> cachedVersions;
+
+    LocalStorage(Path localDir) {
+        versionsCache = localDir.resolve(VERSIONS_CACHE_FILENAME);
+
+        final Map<GamePackageType, List<Integer>> cache = loadCache();
+        if (!cache.isEmpty()) {
+            cachedVersions = cache;
+        } else {
+            cachedVersions = new EnumMap<>(GamePackageType.class);
+            for (GamePackageType pkgType : GamePackageType.values()) {
+                cachedVersions.put(pkgType, Collections.emptyList());
+            }
+        }
+    }
+
+    void updateCache(GamePackageType pkgType, List<Integer> versions) {
+        cachedVersions.put(pkgType, versions);
+        logger.trace("Updating cached version list for {} ...", pkgType);
+        saveCache();
+    }
+
+    private void saveCache() {
+        try (ObjectOutputStream out = new ObjectOutputStream(
+                Files.newOutputStream(versionsCache))) {
+            out.writeObject(cachedVersions);
+        } catch (IOException e) {
+            logger.warn("Failed to write cache file: {}", versionsCache.toAbsolutePath());
+        }
+    }
+
+    private Map<GamePackageType, List<Integer>> loadCache() {
+        // TODO: Do this in a background thread
+        try (ObjectInputStream in = new ObjectInputStream(
+                Files.newInputStream(versionsCache))) {
+            return (Map<GamePackageType, List<Integer>>) in.readObject();
+        } catch (ClassNotFoundException | IOException e) {
+            logger.warn("Failed to load cache file: {}", versionsCache.toAbsolutePath());
+        }
+        return Collections.emptyMap();
+    }
+
+    void install(GamePackage pkg) {
+        // TODO: Implement this
+    }
+
+    void remove(GamePackage pkg) {
+        // TODO: Implement this
+    }
+
+    @Override
+    public List<Integer> getPackageVersions(GamePackageType pkgType) {
+        // TODO: Implement this
+        return Collections.emptyList();
+    }
+
+    @Override
+    public Optional<GamePackage> getPackage(GamePackageType pkgType, int version) {
+        // TODO: Implement this
+        return Optional.empty();
+    }
+}

src/main/java/org/terasology/launcher/packages/PackageManager.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2019 MovingBlocks
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.terasology.launcher.packages;
+
+import java.nio.file.Path;
+
+/**
+ * Handles installation, removal and update of game packages.
+ */
+public class PackageManager {
+    private final Storage onlineStorage;
+    private final LocalStorage localStorage;
+
+    public PackageManager(Path localDir) {
+        onlineStorage = new JenkinsStorage();
+        localStorage = new LocalStorage(localDir);
+    }
+
+    public void sync() {
+        for (GamePackageType pkgType : GamePackageType.values()) {
+            localStorage.updateCache(pkgType, onlineStorage.getPackageVersions(pkgType));
+        }
+    }
+
+    public void install(GamePackageType pkgType, int version) {
+        // TODO: Install via cache
+    }
+
+    public void remove(GamePackageType pkgType, int version) {
+        localStorage.getPackage(pkgType, version)
+                .ifPresent(localStorage::remove);
+    }
+}

src/main/java/org/terasology/launcher/packages/Storage.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 MovingBlocks
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.terasology.launcher.packages;
+
+import java.util.List;
+import java.util.Optional;
+
+/**
+ * Interface for anything that can store game packages.
+ */
+public interface Storage {
+    List<Integer> getPackageVersions(GamePackageType pkgType);
+    Optional<GamePackage> getPackage(GamePackageType pkgType, int version);
+}