From a49a20e2c26c248ba6fa37520d58af4bbb9b8611 Mon Sep 17 00:00:00 2001
From: David Richardson <david.richardson@enquora.com>
Date: Tue, 19 Oct 2021 00:31:54 -0600
Subject: [PATCH] Fixed: nib2cib under Xcode 13 (#3006)

Backwards-compatible changes to accommodate different ibtool output from Xcode 13 onwards
---
 Tools/nib2cib/Converter.j | 48 ++++++++++++++++++++++++++++++++++++---
 1 file changed, 45 insertions(+), 3 deletions(-)

diff --git a/Tools/nib2cib/Converter.j b/Tools/nib2cib/Converter.j
index 330d3c526..74fe8bedd 100644
--- a/Tools/nib2cib/Converter.j
+++ b/Tools/nib2cib/Converter.j
@@ -36,6 +36,7 @@
 
 var FILE = require("file"),
     OS = require("os"),
+    SYSTEM = require("system"),
 
     SharedConverter = nil;
 
@@ -97,6 +98,10 @@ ConverterConversionException = @"ConverterConversionException";
     if (inferredFormat === NibFormatMac)
         var convertedData = [self convertedDataFromMacData:nibData];
     else
+        // TODO: this is insufficient to fully confirm the xib file is valid.
+        // Xcode offers to upgrade older xib file formats when they are opened in Interface Builder
+        // but this may not happen if a project is recompiled without opening the xib.
+        // We should perform the same check here and offer to upgrade the file format.
         [CPException raise:ConverterConversionException reason:@"nib2cib does not understand this nib format."];
 
     if ([outputPath length])
@@ -112,18 +117,51 @@ ConverterConversionException = @"ConverterConversionException";
     var temporaryNibFilePath = "",
         temporaryPlistFilePath = "";
 
+    var PROJECT_ROOT_DIR = SYSTEM.env["PWD"];
+    var PROJECT_BUILD_DIR = FILE.join(PROJECT_ROOT_DIR, "Build");
+    var TMP_DIR = FILE.join(PROJECT_BUILD_DIR, "tmp");
+
+    // System /tmp folder was previously used for ephemeral conversion artifacts
+    // In more recent versions of macOS, access permissions can be insufficient
+    // without using sudo.
+    // Additionally, temporary folders and files in /tmp were not being
+    // namespaced. This risks collisions
+    // between distinct xib files - ones named identically but in different project folders.
+    // Using a tmp folder in the project's Build folder resolves both issues.
+    // Leaving the tmp folder visible is an advantage when debugging failed conversions.
+
+    // Does Build folder exist? If not, create it
+    CPLog.info("\nCreating temporary directories for conversion process:");
+    if(!FILE.isDirectory(PROJECT_BUILD_DIR))
+    {
+        CPLog.info("Create 'Build' directory: " + PROJECT_BUILD_DIR);
+        FILE.mkdir(PROJECT_BUILD_DIR);
+    }
+
+    // Does tmp folder exist? If not, create it
+    if(!FILE.isDirectory(TMP_DIR))
+    {
+        CPLog.info("Create 'tmp' directory: " + TMP_DIR);
+        FILE.mkdir(TMP_DIR);
+    }
+
     try
     {
         if ([outputPath length])
         {
             // Compile xib or nib to make sure we have a non-new format nib.
-            temporaryNibFilePath = FILE.join("/tmp", FILE.basename(aFilePath) + ".tmp.nib");
+            temporaryNibFilePath = FILE.join(TMP_DIR, FILE.basename(aFilePath) + ".tmp.nib");
 
             try
             {
                 var p = OS.popen(["/usr/bin/ibtool", aFilePath, "--compile", temporaryNibFilePath]);
-                if (p.wait() === 1)
+                var error;
+                while (error = p.stderr.read()) CPLog.info("IBTool error(" + typeof error + "): '" + error + "'");
+                var wait = p.wait();
+                if (wait === 1) {
+                    CPLog.info(error);
                     [CPException raise:ConverterConversionException reason:@"Could not compile file: " + aFilePath];
+                }
             }
             finally
             {
@@ -131,13 +169,17 @@ ConverterConversionException = @"ConverterConversionException";
                 p.stdout.close();
                 p.stderr.close();
             }
-
         }
         else
         {
             temporaryNibFilePath = aFilePath;
         }
 
+        // Check if output path results in a directory
+        if (FILE.isDirectory(temporaryNibFilePath)) {
+            temporaryNibFilePath = FILE.join(temporaryNibFilePath, "keyedobjects.nib");
+        }
+
         // Convert from binary plist to XML plist
         var temporaryPlistFilePath = FILE.join("/tmp", FILE.basename(aFilePath) + ".tmp.plist");