Support saving blobs for beta versions without a URL

airsquared · airsquared · commit 8625f24398a0 · 2022-04-11T15:57:48.000-07:00
diff --git a/src/main/java/airsquared/blobsaver/app/Background.java b/src/main/java/airsquared/blobsaver/app/Background.java
@@ -267,7 +267,8 @@ private static void saveBlobs(Prefs.SavedDevice savedDevice) {
         System.out.println("attempting to save for device " + savedDevice);
 
         TSS.Builder builder = new TSS.Builder().setDevice(savedDevice.getIdentifier())
-                .setEcid(savedDevice.getEcid()).setSavePath(savedDevice.getSavePath());
+                .setEcid(savedDevice.getEcid()).setSavePath(savedDevice.getSavePath())
+                .setIncludeBetas(savedDevice.doesIncludeBetas());
         savedDevice.getBoardConfig().ifPresent(builder::setBoardConfig);
         savedDevice.getApnonce().ifPresent(builder::setApnonce);
         savedDevice.getGenerator().ifPresent(builder::setGenerator);
diff --git a/src/main/java/airsquared/blobsaver/app/Controller.java b/src/main/java/airsquared/blobsaver/app/Controller.java
@@ -57,7 +57,8 @@ public class Controller {
     @FXML private TextField ecidField, boardConfigField, apnonceField, generatorField, versionField, identifierField,
             pathField, ipswField;
 
-    @FXML private CheckBox apnonceCheckBox, allSignedVersionsCheckBox, identifierCheckBox, betaCheckBox, saveToTSSSaverCheckBox, saveToSHSHHostCheckBox;
+    @FXML private CheckBox apnonceCheckBox, allSignedVersionsCheckBox, identifierCheckBox, betaCheckBox,
+            manualURLCheckBox, saveToTSSSaverCheckBox, saveToSHSHHostCheckBox;
 
     @FXML private Label versionLabel, savedDevicesLabel;
 
@@ -82,6 +83,7 @@ public void initialize() {
             if (!newValue) {
                 saveToTSSSaverCheckBox.setSelected(false);
                 saveToSHSHHostCheckBox.setSelected(false);
+                betaCheckBox.setSelected(false);
             }
         });
         switch (Prefs.getDarkMode()) {
@@ -159,8 +161,8 @@ public void identifierCheckBoxHandler() {
         }
     }
 
-    public void betaCheckBoxHandler() {
-        if (betaCheckBox.isSelected()) {
+    public void manualURLCheckBoxHandler() {
+        if (manualURLCheckBox.isSelected()) {
             ipswField.setEffect(Utils.borderGlow);
             versionField.setEffect(null);
             versionField.setText("");
@@ -188,6 +190,9 @@ private void loadSavedDevice(Prefs.SavedDevice savedDevice) {
 
         ecidField.setText(savedDevice.getEcid());
         pathField.setText(savedDevice.getSavePath());
+        if (!betaCheckBox.isDisabled()) {
+            betaCheckBox.setSelected(savedDevice.doesIncludeBetas());
+        }
         String identifier = savedDevice.getIdentifier();
         if (Devices.containsIdentifier(identifier)) {
             Utils.setSelectedFire(identifierCheckBox, false);
@@ -223,7 +228,7 @@ public void saveDeviceHandler() {
         if (!Utils.isEmptyOrNull(result)) {
             Prefs.SavedDeviceBuilder builder = new Prefs.SavedDeviceBuilder(result);
 
-            builder.setEcid(ecidField.getText()).setSavePath(pathField.getText())
+            builder.setEcid(ecidField.getText()).setSavePath(pathField.getText()).setIncludeBetas(betaCheckBox.isSelected())
                     .setIdentifier(identifierField.isDisabled() ?
                             Devices.modelToIdentifier(deviceModelChoiceBox.getValue()) : identifierField.getText());
             if (!boardConfigField.isDisable()) {
@@ -415,7 +420,7 @@ public void addBackgroundHandler(Prefs.SavedDevice device, SimpleBooleanProperty
             updateBackgroundSettings();
         } else if (enable.get()) {
             loadSavedDevice(device);
-            Utils.setSelectedFire(betaCheckBox, false);
+            Utils.setSelectedFire(manualURLCheckBox, false);
             Utils.setSelectedFire(allSignedVersionsCheckBox, true);
             TSS tss = createTSS("Testing device...");
             EventHandler<WorkerStateEvent> oldSucceeded = tss.getOnSucceeded();
@@ -629,8 +634,8 @@ private boolean checkInputs() {
         incorrect |= Utils.isFieldEmpty(!boardConfigField.isDisable(), boardConfigField);
         incorrect |= Utils.isFieldEmpty(apnonceCheckBox, apnonceField);
         incorrect |= Utils.isFieldEmpty(true, pathField);
-        incorrect |= Utils.isFieldEmpty(!allSignedVersionsCheckBox.isSelected() && !betaCheckBox.isSelected(), versionField);
-        incorrect |= Utils.isFieldEmpty(betaCheckBox, ipswField);
+        incorrect |= Utils.isFieldEmpty(!allSignedVersionsCheckBox.isSelected() && !manualURLCheckBox.isSelected(), versionField);
+        incorrect |= Utils.isFieldEmpty(manualURLCheckBox, ipswField);
         return incorrect;
     }
 
@@ -639,6 +644,7 @@ private TSS createTSS(String runningAlertTitle) {
                 .setDevice(identifierCheckBox.isSelected() ?
                         identifierField.getText() : Devices.modelToIdentifier(deviceModelChoiceBox.getValue()))
                 .setEcid(ecidField.getText()).setSavePath(pathField.getText())
+                .setIncludeBetas(betaCheckBox.isSelected())
                 .saveToTSSSaver(saveToTSSSaverCheckBox.isSelected())
                 .saveToSHSHHost(saveToSHSHHostCheckBox.isSelected());
         if (!boardConfigField.isDisabled()) {
@@ -693,7 +699,7 @@ private void parseException(Throwable t) {
                 apnonceField.setEffect(Utils.errorBorder);
             } else if (message.contains("not a valid path")) {
                 pathField.setEffect(Utils.errorBorder);
-            } else if (message.contains("not being signed") && betaCheckBox.isSelected()) {
+            } else if (message.contains("not being signed") && manualURLCheckBox.isSelected()) {
                 ipswField.setEffect(Utils.errorBorder);
             } else if (message.contains("not being signed") && !allSignedVersionsCheckBox.isSelected()) {
                 versionField.setEffect(Utils.errorBorder);
diff --git a/src/main/java/airsquared/blobsaver/app/Prefs.java b/src/main/java/airsquared/blobsaver/app/Prefs.java
@@ -253,6 +253,14 @@ public void setGenerator(String generator) {
             node.put("Generator", generator);
         }
 
+        public boolean doesIncludeBetas() {
+            return node.getBoolean("Include Betas", false);
+        }
+
+        public void setIncludeBetas(boolean includeBetas) {
+            node.putBoolean("Include Betas", includeBetas);
+        }
+
         public boolean isBackground() {
             return node.getBoolean("Save in background", false);
         }
@@ -281,6 +289,7 @@ public int hashCode() {
     public static class SavedDeviceBuilder {
         private final String name;
         private String ecid, savePath, identifier, boardConfig, apnonce, generator;
+        private boolean includeBetas;
 
         public SavedDeviceBuilder(String name) {
             this.name = name;
@@ -316,11 +325,17 @@ public SavedDeviceBuilder setGenerator(String generator) {
             return this;
         }
 
+        public SavedDeviceBuilder setIncludeBetas(boolean includeBetas) {
+            this.includeBetas = includeBetas;
+            return this;
+        }
+
         public SavedDevice save() {
             SavedDevice device = new SavedDevice(Objects.requireNonNull(name, "Device Name"));
             device.setEcid(Objects.requireNonNull(ecid, "ECID"));
             device.setSavePath(Objects.requireNonNull(savePath, "Save Path"));
             device.setIdentifier(Objects.requireNonNull(identifier, "Identifier"));
+            device.setIncludeBetas(includeBetas);
             if (boardConfig != null) {
                 device.setBoardConfig(boardConfig);
             }
diff --git a/src/main/java/airsquared/blobsaver/app/TSS.java b/src/main/java/airsquared/blobsaver/app/TSS.java
@@ -38,11 +38,13 @@
 import java.util.Objects;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import java.util.stream.Stream;
 
 import static airsquared.blobsaver.app.Utils.containsIgnoreCase;
 import static airsquared.blobsaver.app.Utils.executeProgram;
 import static airsquared.blobsaver.app.Utils.extractBuildManifest;
 import static airsquared.blobsaver.app.Utils.getFirmwareList;
+import static airsquared.blobsaver.app.Utils.getSignedBetas;
 import static airsquared.blobsaver.app.Utils.getSignedFirmwares;
 
 public class TSS extends Task<String> {
@@ -57,6 +59,7 @@ public class TSS extends Task<String> {
 
     private final String boardConfig;
 
+    private final boolean includeBetas;
     private final String manualVersion;
     private final String manualIpswURL;
 
@@ -67,11 +70,12 @@ public class TSS extends Task<String> {
     /**
      * Private constructor; use {@link TSS.Builder} instead
      */
-    private TSS(String deviceIdentifier, String ecid, String savePath, String boardConfig, String manualVersion, String manualIpswURL, String apnonce, String generator, boolean saveToTSSSaver, boolean saveToSHSHHost) {
+    private TSS(String deviceIdentifier, String ecid, String savePath, String boardConfig, boolean includeBetas, String manualVersion, String manualIpswURL, String apnonce, String generator, boolean saveToTSSSaver, boolean saveToSHSHHost) {
         this.deviceIdentifier = deviceIdentifier;
         this.ecid = ecid;
         this.savePath = savePath;
         this.boardConfig = boardConfig;
+        this.includeBetas = includeBetas;
         this.manualVersion = manualVersion;
         this.manualIpswURL = manualIpswURL;
         this.apnonce = apnonce;
@@ -91,7 +95,6 @@ protected String call() throws TSSException {
         List<Utils.IOSVersion> iosVersions = getIOSVersions();
         System.out.println("iosVersions = " + iosVersions);
         ArrayList<String> args = constructArgs();
-        final int urlIndex = args.size() - 1;
 
         StringBuilder responseBuilder = new StringBuilder("Successfully saved blobs in\n").append(savePath);
         if (manualIpswURL == null) {
@@ -100,18 +103,7 @@ protected String call() throws TSSException {
 
         // can't use forEach() because exception won't be caught
         for (Utils.IOSVersion iosVersion : iosVersions) {
-            try {
-                args.set(urlIndex, extractBuildManifest(iosVersion.ipswURL()).toString());
-            } catch (IOException e) {
-                throw new TSSException("Unable to extract BuildManifest.", true, e);
-            }
-            try {
-                System.out.println("Running: " + args);
-                String tssLog = executeProgram(args);
-                parseTSSLog(tssLog);
-            } catch (IOException e) {
-                throw new TSSException("There was an error starting tsschecker.", true, e);
-            }
+            saveFor(iosVersion, args);
 
             if (iosVersion.versionString() != null) {
                 responseBuilder.append(iosVersion.versionString());
@@ -134,6 +126,29 @@ protected String call() throws TSSException {
         return responseBuilder.toString();
     }
 
+
+    private void saveFor(Utils.IOSVersion iosVersion, ArrayList<String> args) throws TSSException {
+        final int urlIndex = args.size() - 1;
+        try {
+            args.set(urlIndex, extractBuildManifest(iosVersion.ipswURL()).toString());
+        } catch (IOException e) {
+            throw new TSSException("Unable to extract BuildManifest.", true, e);
+        }
+        try {
+            System.out.println("Running: " + args);
+            String tssLog = executeProgram(args);
+            parseTSSLog(tssLog);
+        } catch (IOException e) {
+            throw new TSSException("There was an error starting tsschecker.", true, e);
+        } catch (TSSException e) {
+            if ((manualVersion == null && manualIpswURL == null) && e.getMessage().contains("not being signed")) {
+                System.out.println("Warning: ignoring unsigned version; API might be out of date");
+                return; // ignore not being signed (API might not be updated)
+            }
+            throw e;
+        }
+    }
+
     private void checkInputs() throws TSSException {
         boolean hasCorrectIdentifierPrefix = deviceIdentifier.startsWith("iPad") || deviceIdentifier.startsWith("iPod")
                 || deviceIdentifier.startsWith("iPhone") || deviceIdentifier.startsWith("AppleTV");
@@ -177,6 +192,8 @@ private List<Utils.IOSVersion> getIOSVersions() throws TSSException {
                         .orElseThrow(() -> new TSSException("No versions found.", false)));
             } else if (manualIpswURL != null) {
                 return Collections.singletonList(new Utils.IOSVersion(null, manualIpswURL, null));
+            } else if (includeBetas) {
+                return Stream.concat(getSignedFirmwares(deviceIdentifier), getSignedBetas(deviceIdentifier)).toList();
             } else { // all signed firmwares
                 return getSignedFirmwares(deviceIdentifier).toList();
             }
@@ -252,7 +269,7 @@ && containsIgnoreCase(tsscheckerLog, "checking tss status failed")) {
     @SuppressWarnings("UnusedReturnValue")
     public static class Builder {
         private String device, ecid, savePath, boardConfig, manualVersion, manualIpswURL, apnonce, generator;
-        private boolean saveToTSSSaver, saveToSHSHHost;
+        private boolean includeBetas, saveToTSSSaver, saveToSHSHHost;
 
         public Builder setDevice(String device) {
             this.device = device;
@@ -296,6 +313,11 @@ public Builder setGenerator(String generator) {
             return this;
         }
 
+        public Builder setIncludeBetas(boolean includeBetas) {
+            this.includeBetas = includeBetas;
+            return this;
+        }
+
         public Builder saveToTSSSaver(boolean saveToTSSSaver) {
             this.saveToTSSSaver = saveToTSSSaver;
             return this;
@@ -310,7 +332,7 @@ public TSS build() {
             return new TSS(Objects.requireNonNull(device, "Device"),
                     Objects.requireNonNull(ecid, "ECID"),
                     Objects.requireNonNull(savePath, "Save Path"),
-                    boardConfig, manualVersion, manualIpswURL, apnonce, generator, saveToTSSSaver, saveToSHSHHost);
+                    boardConfig, includeBetas, manualVersion, manualIpswURL, apnonce, generator, saveToTSSSaver, saveToSHSHHost);
         }
     }
 
diff --git a/src/main/java/airsquared/blobsaver/app/Utils.java b/src/main/java/airsquared/blobsaver/app/Utils.java
@@ -18,6 +18,7 @@
 
 package airsquared.blobsaver.app;
 
+import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonParser;
 import com.sun.jna.Platform;
@@ -349,7 +350,16 @@ static void runSafe(Runnable runnable) {
 
     static Stream<IOSVersion> getFirmwareList(String deviceIdentifier) throws IOException {
         String url = "https://api.ipsw.me/v4/device/" + deviceIdentifier;
-        return StreamSupport.stream(makeRequest(url).getAsJsonObject().getAsJsonArray("firmwares").spliterator(), false)
+        return createVersionStream(makeRequest(url).getAsJsonObject().getAsJsonArray("firmwares"));
+    }
+
+    static Stream<IOSVersion> getBetaList(String deviceIdentifier) throws IOException {
+        String url = "https://api.m1sta.xyz/betas/" + deviceIdentifier;
+        return createVersionStream(makeRequest(url).getAsJsonArray());
+    }
+
+    private static Stream<IOSVersion> createVersionStream(JsonArray array) {
+        return StreamSupport.stream(array.spliterator(), false)
                 .map(JsonElement::getAsJsonObject)
                 .map(o -> new IOSVersion(o.get("version").getAsString(), o.get("url").getAsString(), o.get("signed").getAsBoolean()));
     }
@@ -358,6 +368,10 @@ static Stream<IOSVersion> getSignedFirmwares(String deviceIdentifier) throws IOE
         return getFirmwareList(deviceIdentifier).filter(IOSVersion::signed);
     }
 
+    static Stream<IOSVersion> getSignedBetas(String deviceIdentifier) throws IOException {
+        return getBetaList(deviceIdentifier).filter(IOSVersion::signed);
+    }
+
     record IOSVersion(String versionString, String ipswURL, Boolean signed) {
         public IOSVersion {
             Objects.requireNonNull(ipswURL, "ipsw url cannot be null");
diff --git a/src/main/resources/airsquared/blobsaver/app/blobsaver.fxml b/src/main/resources/airsquared/blobsaver/app/blobsaver.fxml
@@ -167,8 +167,13 @@
                 <Insets left="10.0" top="5.0"/>
             </VBox.margin>
             <CheckBox fx:id="allSignedVersionsCheckBox" mnemonicParsing="false" onAction="#versionCheckBoxHandler"
-                      selected="true" text="All Signed Versions" disable="${betaCheckBox.selected}"/>
-            <CheckBox fx:id="betaCheckBox" mnemonicParsing="false" onAction="#betaCheckBoxHandler" text="Beta Version">
+                      selected="true" text="All Signed Versions" disable="${manualURLCheckBox.selected}"/>
+            <CheckBox fx:id="betaCheckBox" mnemonicParsing="false" text="Include Betas" disable="${!allSignedVersionsCheckBox.selected}">
+                <HBox.margin>
+                    <Insets left="10.0"/>
+                </HBox.margin>
+            </CheckBox>
+            <CheckBox fx:id="manualURLCheckBox" mnemonicParsing="false" onAction="#manualURLCheckBoxHandler" text="Manually Specify URL">
                 <HBox.margin>
                     <Insets left="10.0"/>
                 </HBox.margin>
@@ -178,9 +183,9 @@
             <VBox.margin>
                 <Insets bottom="5.0" left="10.0" right="10.0" top="5.0"/>
             </VBox.margin>
-            <TextField fx:id="versionField" disable="${allSignedVersionsCheckBox.selected || betaCheckBox.selected}"
+            <TextField fx:id="versionField" disable="${allSignedVersionsCheckBox.selected || manualURLCheckBox.selected}"
                        promptText="Version" onTextChange="#clearEffectHandler"/>
-            <TextField fx:id="ipswField" disable="${!betaCheckBox.selected}" HBox.hgrow="ALWAYS"
+            <TextField fx:id="ipswField" disable="${!manualURLCheckBox.selected}" HBox.hgrow="ALWAYS"
                        promptText="URL to .ipsw file" onTextChange="#clearEffectHandler">
                 <HBox.margin>
                     <Insets left="5.0"/>
diff --git a/src/test/java/airsquared/blobsaver/app/TSSTest.java b/src/test/java/airsquared/blobsaver/app/TSSTest.java
@@ -26,7 +26,7 @@ public class TSSTest extends BlobsaverTest {
 
     @Test
     public void call() throws TSS.TSSException {
-        TSS tss = new TSS.Builder().setDevice("iPhone8,4").setEcid("1")
+        TSS tss = new TSS.Builder().setDevice("iPhone8,4").setEcid("1").setIncludeBetas(true)
                 .setSavePath(System.getProperty("user.home") + File.separator + "Blobs").setBoardConfig("n69ap").build();
         tss.call(); // don't create another thread
     }

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public class TSSTest extends BlobsaverTest {`
`26`	`26`
`27`	`27`	`@Test`
`28`	`28`	`public void call() throws TSS.TSSException {`
`29`		`- TSS tss = new TSS.Builder().setDevice("iPhone8,4").setEcid("1")`
	`29`	`+ TSS tss = new TSS.Builder().setDevice("iPhone8,4").setEcid("1").setIncludeBetas(true)`
`30`	`30`	`.setSavePath(System.getProperty("user.home") + File.separator + "Blobs").setBoardConfig("n69ap").build();`
`31`	`31`	`tss.call(); // don't create another thread`
`32`	`32`	`}`