Merge pull request #1945 from livecode/bugfix-extension_dependencies

[[ Extensions ]] Detect missing dependencies when installing package

Author: livecodepanos

Toolset/libraries/revideextensionlibrary.livecodescript

@@ -78,26 +78,55 @@ command revIDEExtensionDownloadAndInstall pExtensionPath, pType, pCallbackObject
    __extensionsChanged
 end revIDEExtensionDownloadAndInstall
 
-command revIDEExtensionInstall pPackageLocation
+private function __extensionDependencyExists pExt
+   return __extensionCacheID("name", pExt) is a number
+end __extensionDependencyExists
+   
+private command __extensionInstallPackage pPackageLocation
    if there is not a file pPackageLocation then
-      answer error "No package found at" && pPackageLocation
-      exit revIDEExtensionInstall
+      throw "No package found at" && pPackageLocation
    end if
 
-   local tCacheIndex, tFromStore
+   local tCacheIndex
    put __extensionCacheID("download_package_path", pPackageLocation) \
          into tCacheIndex
    if tCacheIndex is not a number then
-      -- Direct install from package file
-      put false into tFromStore
       put the number of elements of sExtensions + 1 into tCacheIndex
       __extensionPropertySet tCacheIndex, "download_package_path", pPackageLocation
-   else
-      put true into tFromStore
+      __extensionUpdateUIWithPackage tCacheIndex, pPackageLocation
    end if
+   __extensionPropertySet tCacheIndex, "status", "installing"
+   
+   local tVerifyResult, tName
+   __extensionDownloadVerify tCacheIndex
+   put the result into tVerifyResult
+   if tVerifyResult is not empty then
+      __extensionCacheRemove tCacheIndex
+      throw "Error installing extension" && pPackageLocation & return & the result
+   end if
+   
+   put __extensionPropertyGet(tCacheIndex, "name") into tName
 
+   # Fetch the dependency list (minus builtin modules) and ensure all
+   # are loaded
+   local tDeps
+   put revIDEExtensionsOrderByDependency(tName) into tDeps
+   repeat for each line tExtension in tDeps
+      # Skip the one we're installing
+      if tExtension is tName then
+         next repeat
+      end if
+      # Ensure dependency exists
+      if not __extensionDependencyExists(tExtension) then
+         throw "Dependency" && tExtension && "not available. Please install before proceeding"
+      end if
+   end repeat
+   __extensionInstall tCacheIndex, pPackageLocation
+end __extensionInstallPackage
+
+command revIDEExtensionInstall pPackageLocation
    try
-      __extensionInstall tCacheIndex, pPackageLocation, tFromStore
+      __extensionInstallPackage pPackageLocation
    catch tError
       answer error tError
    end try
@@ -288,14 +317,32 @@ private command __extensionDownloadBegin pExtensionUrl, pType, pCallbackObject,
    return tCacheIndex for value
 end __extensionDownloadBegin
 
+private command __extensionUpdateUIWithPackage pCacheIndex, pPath
+   # Get initial name from file
+   set the itemdel to "."
+   local tName
+   put pPath into tName
+   delete the last item of tName
+   repeat while the last item of tName is a number
+      delete the last item of tName
+   end repeat
+   __extensionPropertySet pCacheIndex, "name", tName
+   
+   # Send update to refresh UI with new package installation
+   doExtensionsChanged
+end __extensionUpdateUIWithPackage
+
 # Download the extension
 private command __extensionDownload pCacheIndex
    # Check the file extension is correct
    local tURL
    put __extensionPropertyGet(pCacheIndex,"package_url") into tURL
 
    set the itemdel to "."
-   if the last item of tURL is not "lce" then return __extensionError(pCacheIndex,"Could not download extension. The package must have the file extension 'lce':" && tURL)
+   if the last item of tURL is not "lce" then 
+      return __extensionError(pCacheIndex, \
+            "The package must have the file extension 'lce':" && tURL)
+   end if
 
    local tPackageFilePath
    set the itemdel to "/"
@@ -306,19 +353,9 @@ private command __extensionDownload pCacheIndex
    __extensionPropertySet pCacheIndex, "progress_message", "Downloading"
    __extensionPropertySet pCacheIndex, "progress", 0
    __extensionPropertySet pCacheIndex, "label", tPackageFilePath
+   __extensionPropertySet pCacheIndex, "downloaded_from_store", true
 
-   # Put is a first stab at the name
-   set the itemdel to "."
-   local tName
-   put tPackageFilePath into tName
-   delete the last item of tName
-   repeat while the last item of tName is a number
-      delete the last item of tName
-   end repeat
-   __extensionPropertySet pCacheIndex, "name", tName
-   
-   # Send update to refresh UI with new package installation
-   __extensionsChanged
+   __extensionUpdateUIWithPackage pCacheIndex, tPackageFilePath
 
    # Update progress
    __extensionSendProgressUpdate pCacheIndex, "Downloading", 0
@@ -356,11 +393,18 @@ private command __extensionDownloadVerify pCacheIndex
    put __extensionPropertyGet(pCacheIndex, "download_package_path") into tExtensionPath
 
    # Check the package exists
-   if there is not a file tExtensionPath then return __extensionError(pCacheIndex,"Could not install extension. Package does not exists: " && tExtensionPath)
+   if there is not a file tExtensionPath then 
+      return __extensionError(pCacheIndex, \
+            "Package does not exist: " && tExtensionPath)
+   end if
 
    # Check the file extension is valid
    set the itemdel to "."
-   if the last item of tExtensionPath is not "lce" then return __extensionError(pCacheIndex,"Could not install extension. The package extension '"&the last item of tExtensionPath&"' Is not valid. Must be 'lce'.")
+   if the last item of tExtensionPath is not "lce" then 
+      return __extensionError(pCacheIndex, "The package extension '" & \
+            the last item of tExtensionPath&"' is not valid." && \
+            " Must be 'lce'.")
+   end if
 
    # Ensure the zip contains the things we expect
    local tManifestDataA
@@ -378,12 +422,7 @@ private command __extensionDownloadVerify pCacheIndex
          tManifestDataA["name"] & "." & tManifestDataA["version"]
 end __extensionDownloadVerify
 
-private command __extensionInstall pCacheIndex, pPackage, pFromStore
-   __extensionDownloadVerify pCacheIndex
-   if the result is not empty then
-      throw "Error installing extension" && pPackage & return & the result
-   end if
-   
+private command __extensionInstall pCacheIndex, pPackage
    local tName, tTypeId, tInstallPath
    put __extensionPropertyGet(pCacheIndex, "name") into tName
    put __extensionPropertyGet(pCacheIndex, "type_id") into tTypeId
@@ -394,7 +433,7 @@ private command __extensionInstall pCacheIndex, pPackage, pFromStore
    __extensionInstallExtract pCacheIndex, tInstallPath, tTypeID, pPackage, 30
    __extensionInstallCopyInterfaceFile pCacheIndex, tName, tInstallPath, 50
    __extensionInstallLoad pCacheIndex, tName, tInstallPath, 80
-   __extensionInstallFinalise pCacheIndex, tTypeID, pFromStore
+   __extensionInstallFinalise pCacheIndex, tTypeID
 end __extensionInstall
 
 on __extensionInstallRemoveOlderVersions pCacheIndex, pName, pProgress
@@ -491,9 +530,9 @@ private command __extensionInstallLoad pCacheIndex, pName, pInstallFolder, pProg
 end __extensionInstallLoad
 
 # Delete installation files and original package
-on __extensionInstallFinalise pCacheIndex, pTypeId, pDeletePackage
+on __extensionInstallFinalise pCacheIndex, pTypeId
    # Delete temp package file
-   if pDeletePackage then
+   if __extensionPropertyGet(pCacheIndex, "downloaded_from_store") then
       # Update progress
       __extensionSendProgressUpdate  pCacheIndex, "Removing temp files", 90
       local tTempInstallPackage
@@ -763,10 +802,9 @@ private command __extensionSetPropertyInfoFromManifest pID, pManifest
    put tPropertyInfo into sExtensionProperties[pID]
 end __extensionSetPropertyInfoFromManifest
 
-private command __extensionError pCacheIndex, pErrorMessage
+private function __extensionError pCacheIndex, pErrorMessage
    __extensionSendProgressUpdate pCacheIndex, "Error:" && pErrorMessage, 100
-   throw pErrorMessage
-   return empty
+   return pErrorMessage
 end __extensionError
 
 # Send notication that widget has been added/removed
@@ -901,6 +939,10 @@ private function __extensionCacheID pPropertyToSearch, pValue
    end repeat
 end __extensionCacheID
 
+private command __extensionCacheRemove pIndex
+   delete variable sExtensions[pIndex]
+end __extensionCacheRemove
+
 # Gets a property from the internal extension cache
 function __extensionPropertyGet pCacheIndex, pProperty
    return sExtensions[pCacheIndex][pProperty]
@@ -1285,39 +1327,6 @@ function revIDEExtensionFetchDefaultScript pFolder, pCacheIndex, pValidate
    return tScript
 end revIDEExtensionFetchDefaultScript
 
-private function __extensionManifestValueFromTree pTreeID, pProperty
-   local tValue
-   switch pProperty
-      case "requires"
-         # Fetch extension dependencies
-         local tRequires, tCount
-         put 0 into tCount
-         put revXMLChildNames(pTreeID,"package",return,"requires",true) into tRequires
-         if tRequires begins with "xmlerr" then
-            put tRequires into tValue
-            break
-         end if
-         repeat for each line tDependency in tRequires
-            add 1 to tCount
-            local tName
-            put revXMLAttribute(pTreeID,"package" & "/" & tDependency,"name") into tName
-            if tName begins with "xmlerr" then
-               put tName into tValue
-               break
-            end if
-            put tName into tValue[tCount]
-         end repeat
-      default
-         put revXMLNodeContents(pTreeID,"/package/" & pProperty) into tValue
-         break
-   end switch
-   
-   if tValue begins with "xmlerr" then
-      return tValue for error
-   end if
-   return tValue for value
-end __extensionManifestValueFromTree
-
 function __extensionSampleStacks pID, pFolder
    local tSampleFolder, tSamples, tSampleArray