|
| 1 | +package org.cryptomator.integrations.update; |
| 2 | + |
| 3 | +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; |
| 4 | +import com.fasterxml.jackson.annotation.JsonProperty; |
| 5 | +import com.fasterxml.jackson.databind.ObjectMapper; |
| 6 | +import org.jetbrains.annotations.Blocking; |
| 7 | +import org.jetbrains.annotations.NotNull; |
| 8 | +import org.jetbrains.annotations.Nullable; |
| 9 | +import org.slf4j.Logger; |
| 10 | +import org.slf4j.LoggerFactory; |
| 11 | + |
| 12 | +import java.io.IOException; |
| 13 | +import java.io.InputStream; |
| 14 | +import java.net.URI; |
| 15 | +import java.net.http.HttpClient; |
| 16 | +import java.net.http.HttpRequest; |
| 17 | +import java.net.http.HttpResponse; |
| 18 | +import java.nio.file.Files; |
| 19 | +import java.nio.file.Path; |
| 20 | +import java.util.HexFormat; |
| 21 | +import java.util.List; |
| 22 | + |
| 23 | +public abstract class DownloadUpdateMechanism implements UpdateMechanism<DownloadUpdateInfo> { |
| 24 | + |
| 25 | + private static final Logger LOG = LoggerFactory .getLogger(DownloadUpdateMechanism.class); |
| 26 | + private static final String LATEST_VERSION_API_URL = "https://api.cryptomator.org/connect/apps/desktop/latest-version?format=1"; |
| 27 | + private static final ObjectMapper MAPPER = new ObjectMapper(); |
| 28 | + |
| 29 | + @Override |
| 30 | + public DownloadUpdateInfo checkForUpdate(String currentVersion, HttpClient httpClient) { |
| 31 | + try { |
| 32 | + HttpRequest request = HttpRequest.newBuilder().uri(URI.create(LATEST_VERSION_API_URL)).build(); |
| 33 | + HttpResponse<InputStream> response = httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream()); |
| 34 | + if (response.statusCode() != 200) { |
| 35 | + throw new RuntimeException("Failed to fetch release: " + response.statusCode()); |
| 36 | + } |
| 37 | + var release = MAPPER.readValue(response.body(), LatestVersionResponse.class); |
| 38 | + return checkForUpdate(currentVersion, release); |
| 39 | + } catch (InterruptedException e) { |
| 40 | + Thread.currentThread().interrupt(); |
| 41 | + LOG.debug("Update check interrupted."); |
| 42 | + return null; |
| 43 | + } catch (IOException e) { |
| 44 | + LOG.warn("Update check failed", e); |
| 45 | + return null; |
| 46 | + } |
| 47 | + } |
| 48 | + |
| 49 | + /** |
| 50 | + * Returns the first step to prepare the update. This downloads the {@link DownloadUpdateInfo#asset() asset} to a temporary location and verifies its checksum. |
| 51 | + * @param updateInfo The {@link DownloadUpdateInfo} retrieved from {@link #checkForUpdate(String, HttpClient)}. |
| 52 | + * @return a new {@link UpdateStep} that can be used to monitor the download progress. |
| 53 | + * @throws UpdateFailedException When failing to prepare a temporary download location. |
| 54 | + */ |
| 55 | + @Override |
| 56 | + public UpdateStep firstStep(DownloadUpdateInfo updateInfo) throws UpdateFailedException { |
| 57 | + try { |
| 58 | + Path workDir = Files.createTempDirectory("cryptomator-update"); |
| 59 | + return new FirstStep(workDir, updateInfo); |
| 60 | + } catch (IOException e) { |
| 61 | + throw new UpdateFailedException("Failed to create temporary directory for update", e); |
| 62 | + } |
| 63 | + } |
| 64 | + |
| 65 | + /** |
| 66 | + * Second step that is executed after the download has completed in the {@link #firstStep(DownloadUpdateInfo) first step}. |
| 67 | + * @param workDir A temporary working directory to which the asset has been downloaded. |
| 68 | + * @param assetPath The path of the downloaded asset. |
| 69 | + * @param updateInfo The {@link DownloadUpdateInfo} representing the update. |
| 70 | + * @return The next step of the update process. |
| 71 | + * @throws IllegalStateException if preconditions aren't met. |
| 72 | + * @throws IOException indicating an error preventing the next step from starting. |
| 73 | + * @implSpec The returned {@link UpdateStep} must either be stateless or a new instance must be returned on each call. |
| 74 | + */ |
| 75 | + public abstract UpdateStep secondStep(Path workDir, Path assetPath, DownloadUpdateInfo updateInfo) throws IllegalStateException, IOException; |
| 76 | + |
| 77 | + @Nullable |
| 78 | + @Blocking |
| 79 | + protected abstract DownloadUpdateInfo checkForUpdate(String currentVersion, LatestVersionResponse response); |
| 80 | + |
| 81 | + @JsonIgnoreProperties(ignoreUnknown = true) |
| 82 | + public record LatestVersionResponse( |
| 83 | + @JsonProperty("latestVersion") LatestVersion latestVersion, |
| 84 | + @JsonProperty("assets") List<Asset> assets |
| 85 | + ) {} |
| 86 | + |
| 87 | + @JsonIgnoreProperties(ignoreUnknown = true) |
| 88 | + public record LatestVersion( |
| 89 | + @JsonProperty("mac") String macVersion, |
| 90 | + @JsonProperty("win") String winVersion, |
| 91 | + @JsonProperty("linux") String linuxVersion |
| 92 | + ) {} |
| 93 | + |
| 94 | + @JsonIgnoreProperties(ignoreUnknown = true) |
| 95 | + public record Asset( |
| 96 | + @JsonProperty("name") String name, |
| 97 | + @JsonProperty("digest") String digest, // TODO: verify this starts with "sha256:"? |
| 98 | + @JsonProperty("size") long size, |
| 99 | + @JsonProperty("downloadUrl") String downloadUrl |
| 100 | + ) {} |
| 101 | + |
| 102 | + private class FirstStep extends DownloadUpdateStep { |
| 103 | + private final Path workDir; |
| 104 | + private final DownloadUpdateInfo updateInfo; |
| 105 | + |
| 106 | + public FirstStep(Path workDir, DownloadUpdateInfo updateInfo) { |
| 107 | + super(URI.create(updateInfo.asset().downloadUrl), |
| 108 | + workDir.resolve(updateInfo.asset().name), |
| 109 | + HexFormat.of().withLowerCase().parseHex(updateInfo.asset().digest.substring(7)), // remove "sha256:" prefix |
| 110 | + updateInfo.asset().size); |
| 111 | + this.workDir = workDir; |
| 112 | + this.updateInfo = updateInfo; |
| 113 | + } |
| 114 | + |
| 115 | + @Override |
| 116 | + public @Nullable UpdateStep nextStep() throws IllegalStateException, IOException { |
| 117 | + if (!isDone()) { |
| 118 | + throw new IllegalStateException("Download not yet completed."); |
| 119 | + } else if (downloadException != null) { |
| 120 | + throw new UpdateFailedException("Download failed.", downloadException); |
| 121 | + } |
| 122 | + return secondStep(workDir, destination, updateInfo); |
| 123 | + } |
| 124 | + } |
| 125 | + |
| 126 | +} |
0 commit comments