- "
def driversToUninstallStr = "
- ${getAppById(manifest,optApp).name} " appsToInstallForModify << optApp hasChanges = true } } appsToInstallStr += "
- ${getDriverById(manifest,optDriver).name} " driversToInstallForModify << optDriver hasChanges = true } } driversToInstallStr += "
- ${getAppById(manifest,installedApp).name} " appsToUninstallForModify << installedApp hasChanges = true } } appsToUninstallStr += "
- ${getDriverById(manifest,installedDriver).name} " driversToUninstallForModify << installedDriver hasChanges = true } } driversToUninstallStr += "
- ${getBundleById(manifest,optBundle).name} " bundlesToInstallForModify << optBundle hasChanges = true } } bundlesToInstallStr += "
- "
def driversToInstallStr = "
- "
def bundlesToInstallStr = "
- "
def bundlesToUninstallStr = "
- "
appsToUninstallForModify = []
appsToInstallForModify = []
bundlesToInstallForModify = []
driversToUninstallForModify = []
driversToInstallForModify = []
def hasChanges = false
def manifest = getInstalledManifest(pkgModify)
for (optApp in appsToModify) {
if (!isAppInstalled(manifest,optApp)) {
appsToInstallStr += "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } else { return dynamicPage(name: "prefVerifyPackageChanges", title: "", install: true, uninstall: false) { displayHeader() section { paragraph "Nothing to modify" paragraph "You did not make any changes." } section { paragraph "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } } def prefMakePackageChanges() { if (state.mainMenu) return prefOptions() if (errorOccurred == true) { return buildErrorPage(errorTitle, errorMessage) } if (atomicState.backgroundActionInProgress == null) { logDebug "Executing modify" atomicState.backgroundActionInProgress = true runInMillis(1,performModify) } if (atomicState.backgroundActionInProgress != false) { return dynamicPage(name: "prefMakePackageChanges", title: "", nextPage: "prefInstall", install: false, uninstall: false, refreshInterval: 2) { displayHeader() section { showHideNextButton(false) paragraph "Modifying Package" paragraph "Your changes are currently in progress... Please wait..." paragraph getBackgroundStatusMessage() } } } else { return complete("Modification complete", "The package was sucessfully modified, click Next to return to the Main Menu.") } } def performModify() { if (!login()) return triggerError("Error logging in to hub", "An error occurred logging into the hub. Please verify your Hub Security username and password.", false) // Download all files first to reduce the chances of a network error def appFiles = [:] def driverFiles = [:] def bundleFiles = [:] def manifest = getInstalledManifest(pkgModify) for (appToInstall in appsToInstallForModify) { def app = getAppById(manifest, appToInstall) def location = getItemDownloadLocation(app) setBackgroundStatusMessage("Downloading ${app.name}") def fileContents = downloadFile(location) if (fileContents == null) { return triggerError("Failed download of file", "An error occurred downloading ${location}", false) } appFiles[location] = fileContents } for (driverToInstall in driversToInstallForModify) { def driver = getDriverById(manifest, driverToInstall) def location = getItemDownloadLocation(driver) setBackgroundStatusMessage("Downloading ${driver.name}") def fileContents = downloadFile(location) if (fileContents == null) { return triggerError("Failed download of file", "An error occurred downloading ${location}", false) } driverFiles[location] = fileContents } initializeRollbackState("modify") for (bundleToInstall in bundlesToInstallForModify) { def location = getItemDownloadLocation(bundleToInstall) def bundleContents = bundleToInstall[location] setBackgroundStatusMessage("Installing ${location}") if (!installBundle(location)) { return rollback("Failed to install bundle ${location}. Please notify the package developer.", false) } else completedActions["bundleInstalls"] << bundleToInstall } for (appToInstall in appsToInstallForModify) { def app = getAppById(manifest, appToInstall) def location = getItemDownloadLocation(app) setBackgroundStatusMessage("Installing ${app.name}") def id = installApp(appFiles[location]) if (id != null) { app.heID = id completedActions["appInstalls"] << id if (app.oauth) enableOAuth(app.heID) } else return rollback("Failed to install app ${location}. Please notify the package developer.", false) } for (appToUninstall in appsToUninstallForModify) { def app = getAppById(manifest, appToUninstall) def sourceCode = getDriverSource(app.heID) setBackgroundStatusMessage("Uninstalling ${app.name}") if (uninstallApp(app.heID)) { completedActions["appUninstalls"] << [id:app.id,source:sourceCode] app.heID = null } else return rollback("Failed to uninstall app ${app.name}, it may be in use. Please delete all instances of this app before uninstalling the package.", false) } for (driverToInstall in driversToInstallForModify) { def driver = getDriverById(manifest, driverToInstall) def location = getItemDownloadLocation(driver) setBackgroundStatusMessage("Installing ${driver.name}") def id = installDriver(driverFiles[location]) if (id != null) { driver.heID = id } else return rollback("Failed to install driver ${location}. Please notify the package developer.", false) } for (driverToUninstall in driversToUninstallForModify) { def driver = getDriverById(manifest, driverToUninstall) def sourceCode = getDriverSource(driver.heID) setBackgroundStatusMessage("Uninstalling ${driver.name}") if (uninstallDriver(driver.heID)) { completedActions["driverUninstalls"] << [id:driver.id,source:sourceCode] driver.heID = null } else return rollback("Failed to uninstall driver ${driver.name}. Please delete all instances of this device before uninstalling the package.", false) } for (bundleToUninstall in bundlesToInstallForModify) { setBackgroundStatusMessage("Uninstalling ${bundleToUninstall.name}") if (uninstallBundle(bundleToUninstall.name)) { completedActions["bundleUninstalls"] << bundle } else { return rollback("Failed to uninstall bundle ${bundleToUninstall.name}.", false) } } atomicState.backgroundActionInProgress = false } // Repair a package pathway def prefPkgRepair() { if (state.mainMenu) return prefOptions() logDebug "prefPkgModify" def pkgsToList = getInstalledPackages(false) return dynamicPage(name: "prefPkgRepair", title: "", nextPage: "prefPkgRepairExecute", install: false, uninstall: false) { displayHeader(' Repair') section { paragraph "Repair a Package" input "pkgRepair", "enum", title: "Choose the package to repair", options: pkgsToList, required: true } section { paragraph "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } def prefPkgRepairExecute() { if (state.mainMenu) return prefOptions() if (errorOccurred == true) { return buildErrorPage(errorTitle, errorMessage) } if (atomicState.backgroundActionInProgress == null) { logDebug "Executing repair" atomicState.backgroundActionInProgress = true if (pkgRepair == state.repositoryListingJSON.hpm.location) atomicState.hpmUpgraded = true else atomicState.hpmUpgraded = false runInMillis(1,performRepair) } atomicState.refreshIntervalValue = atomicState.refreshIntervalValue ? 2 : 11 // first time refresh in 7, after refresh in 2 seconds if (atomicState.backgroundActionInProgress != false) { return dynamicPage(name: "prefPkgRepairExecute", title: "", nextPage: "prefPkgRepairExecute", install: false, uninstall: false, refreshInterval: atomicState.refreshIntervalValue) { displayHeader(' Repair') section { showHideNextButton(false) paragraph "Repairing Package" paragraph "Your changes are currently in progress... Please wait..." paragraph getBackgroundStatusMessage() } } } else { atomicState.refreshIntervalValue = null if (!atomicState.hpmUpgraded) return complete("Repair complete", "The package was sucessfully repaired, click Next to return to the Main Menu.") else { return complete("Repair complete", "The package was sucessfully repaired, click Done to continue.", true) } } } def performRepair() { if (!login()) return triggerError("Error logging in to hub", "An error occurred logging into the hub. Please verify your Hub Security username and password.", runInBackground) def installedApps = getAppList() def installedDrivers = getDriverList() // Download all files first to reduce the chances of a network error def appFiles = [:] def driverFiles = [:] def fileManagerFiles = [:] def bundleFiles = [:] def installedManifest = state.manifests[pkgRepair] def manifest = getJSONFile(pkgRepair) if (manifest) { def fileMgrResults = downloadFileManagerFiles(manifest) if (fileMgrResults.success) fileManagerFiles = fileMgrResults.files else return triggerError("Failed download of file", "An error occurred downloading ${fileMgrResults.name}", false) for (app in manifest.apps) { def appHeID = getAppById(installedManifest,app.id)?.heID if (isAppInstalled(installedManifest,app.id) && installedApps.find { it -> it.id == appHeID }) { setBackgroundStatusMessage("Downloading ${app.name}") def location = getItemDownloadLocation(app) def fileContents = downloadFile(location) if (fileContents == null) { return triggerError("Failed download of file", "An error occurred downloading ${location}", runInBackground) } appFiles[location] = fileContents } else if (app.required) { setBackgroundStatusMessage("Downloading ${app.name} because it is required and not installed") def location = getItemDownloadLocation(app) def fileContents = downloadFile(location) if (fileContents == null) { return triggerError("Failed download of file", "An error occurred downloading ${location}", runInBackground) } appFiles[location] = fileContents } } for (driver in manifest.drivers) { def driverHeID = getDriverById(installedManifest,driver.id)?.heID if (isDriverInstalled(installedManifest,driver.id) && installedDrivers.find { it -> it.id == driverHeID }) { def location = getItemDownloadLocation(driver) setBackgroundStatusMessage("Downloading ${driver.name}") def fileContents = downloadFile(location) if (fileContents == null) { return triggerError("Failed download of file", "An error occurred downloading ${location}", runInBackground) } driverFiles[location] = fileContents } else if (driver.required) { setBackgroundStatusMessage("Downloading ${driver.name} because it is required and not installed") def location = getItemDownloadLocation(driver) def fileContents = downloadFile(location) if (fileContents == null) { return triggerError("Failed download of file", "An error occurred downloading ${location}", runInBackground) } driverFiles[location] = fileContents } } } else { return triggerError("Failed download of file", "The manifest file ${pkg} no longer seems to be valid.", runInBackground) } if (manifest) { initializeRollbackState("update") manifestForRollback = installedManifest for (bundleToInstall in manifest.bundles) { def location = getItemDownloadLocation(bundleToInstall) def bundleContents = bundleFiles[location] setBackgroundStatusMessage("Installing ${location}") if (!installBundle(location)) { return rollback("Failed to install bundle ${location}. Please notify the package developer.", false) } else completedActions["bundleInstalls"] << bundleToInstall } for (app in manifest.apps) { def appHeID = getAppById(installedManifest,app.id)?.heID if (isAppInstalled(installedManifest,app.id) && installedApps.find { it -> it.id == appHeID }) { app.heID = getAppById(installedManifest, app.id).heID app.beta = shouldInstallBeta(app) def location = getItemDownloadLocation(app) def sourceCode = getAppSource(app.heID) setBackgroundStatusMessage("Reinstalling ${app.name}") if (upgradeApp(app.heID, appFiles[location])) { completedActions["appUpgrades"] << [id:app.heID,source:sourceCode] if (app.oauth) enableOAuth(app.heID) } else return rollback("Failed to upgrade app ${location}. Please notify the package developer.", runInBackground) } else if (app.required) { def location = getItemDownloadLocation(app) setBackgroundStatusMessage("Installing ${app.name}") def id = installApp(appFiles[location]) if (id != null) { app.heID = id app.beta = shouldInstallBeta(app) if (app.oauth) enableOAuth(app.heID) } else return rollback("Failed to install app ${location}. Please notify the package developer.", runInBackground) } } for (driver in manifest.drivers) { def driverHeID = getDriverById(installedManifest,driver.id)?.heID if (isDriverInstalled(installedManifest,driver.id) && installedDrivers.find { it -> it.id == driverHeID }) { def location = getItemDownloadLocation(driver) driver.heID = getDriverById(installedManifest, driver.id).heID driver.beta = shouldInstallBeta(driver) def sourceCode = getDriverSource(driver.heID) setBackgroundStatusMessage("Reinstalling ${driver.name}") if (upgradeDriver(driver.heID, driverFiles[location])) { completedActions["driverUpgrades"] << [id:driver.heID,source:sourceCode] } else return rollback("Failed to upgrade driver ${location}. Please notify the package developer.", runInBackground) } else if (driver.required) { def location = getItemDownloadLocation(driver) setBackgroundStatusMessage("Installing ${driver.name}") def id = installDriver(driverFiles[location]) if (id != null) { driver.heID = id driver.beta = shouldInstallBeta(driver) } else return rollback("Failed to install driver ${location}. Please notify the package developer.", runInBackground) } } for (fileToInstall in manifest.files) { def location = getItemDownloadLocation(fileToInstall) def fileContents = fileManagerFiles[location] setBackgroundStatusMessage("Installing ${location}") if (!installFile(fileToInstall.id, fileToInstall.name, fileContents)) { return rollback("Failed to install file ${location}. Please notify the package developer.", false) } else completedActions["fileInstalls"] << fileToInstall } if (state.manifests[pkgRepair] != null) copyInstalledItemsToNewManifest(state.manifests[pkgRepair], manifest) state.manifests[pkgRepair] = manifest minimizeStoredManifests() } else { } logDebug "Repair complete" if (runInBackground != true) atomicState.backgroundActionInProgress = false else return true } // Uninstall a package pathway def prefPkgUninstall() { if (state.mainMenu) return prefOptions() logDebug "prefPkgUninstall" def pkgsToList = getInstalledPackages(false) return dynamicPage(name: "prefPkgUninstall", title: "", nextPage: "prefPkgUninstallConfirm", install: false, uninstall: false) { displayHeader(' UnInstall') section { paragraph "Uninstall Packages" input "pkgUninstall", "enum", title: "Choose the package(s) to uninstall", options: pkgsToList, required: true, multiple: true } section { paragraph "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } def prefPkgUninstallConfirm() { if (state.mainMenu) return prefOptions() logDebug "prefPkgUninstallConfirm" return dynamicPage(name: "prefPkgUninstallConfirm", title: "", nextPage: "prefUninstall", install: false, uninstall: false) { displayHeader(' UnInstall') section { paragraph "Uninstall Packages" paragraph "The following apps and drivers will be removed:" def str = "
- "
for (pkgToUninstall in pkgUninstall) {
def pkg = state.manifests[pkgToUninstall]
for (app in pkg.apps) {
if (app.heID != null)
str += "
- ${app.name} (App) " } for (driver in pkg.drivers) { if (driver.heID != null) str += "
- ${driver.name} (Device Driver) " } for (bundle in pkg.bundles) { if (bundle.name != null) str += "
- ${bundle.name} (Bundle) " } } str += "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } def prefUninstall() { if (state.mainMenu) return prefOptions() if (errorOccurred == true) { return buildErrorPage(errorTitle, errorMessage) } if (atomicState.backgroundActionInProgress == null) { logDebug "Performing uninstall" atomicState.backgroundActionInProgress = true runInMillis(1,performUninstall) } if (atomicState.backgroundActionInProgress != false) { return dynamicPage(name: "prefUninstall", title: "", nextPage: "prefUninstall", install: false, uninstall: false, refreshInterval: 2) { displayHeader(' UnInstall') section { showHideNextButton(false) paragraph "Uninstall in progress" paragraph "Your uninstall is currently in progress... Please wait..." paragraph getBackgroundStatusMessage() } } } else { return complete("Uninstall complete", "The package was sucessfully uninstalled, click Next to return to the Main Menu.") } } def performUninstall() { if (!login()) return triggerError("Error logging in to hub", "An error occurred logging into the hub. Please verify your Hub Security username and password.", false) for (pkgToUninstall in pkgUninstall) { def pkg = state.manifests[pkgToUninstall] initializeRollbackState("uninstall") for (app in pkg.apps) { if (app.heID != null) { def sourceCode = getAppSource(app.heID) setBackgroundStatusMessage("Uninstalling ${app.name}") if (uninstallApp(app.heID)) { completedActions["appUninstalls"] << [id:app.id,source:sourceCode] } else return rollback("Failed to uninstall app ${app.location}, it may be in use. Please delete all instances of this app before uninstalling the package.", false) } } for (driver in pkg.drivers) { if (driver.heID != null) { def sourceCode = getDriverSource(driver.heID) setBackgroundStatusMessage("Uninstalling ${driver.name}") if (uninstallDriver(driver.heID)) { completedActions["driverUninstalls"] << [id:driver.id,source:sourceCode] } else return rollback("Failed to uninstall driver ${driver.location}. Please delete all instances of this device before uninstalling the package.", false) } } for (file in pkg.files) { setBackgroundStatusMessage("Uninstalling ${file.name}") if (uninstallFile(file.id, file.name)) { completedActions["fileUninstalls"] << file } else { return rollback("Failed to uninstall file ${file.name}.", false) } } for (bundle in pkg.bundles) { setBackgroundStatusMessage("Uninstalling ${bundle.name}") if (uninstallBundle(bundle.name)) { completedActions["bundleUninstalls"] << bundle } else { return rollback("Failed to uninstall bundle ${bundle.name}.", false) } } state.manifests.remove(pkgToUninstall) } atomicState.backgroundActionInProgress = false } def addUpdateDetails(pkgId, pkgName, releaseNotes, updateType, item, forceProduction = false) { if (updateDetails[pkgId] == null) updateDetails[pkgId] = [name: null, releaseNotes: null, items: [], forceProduction: null] if (pkgName != null) updateDetails[pkgId].name = pkgName if (releaseNotes != null) updateDetails[pkgId].releaseNotes = releaseNotes updateDetails[pkgId].items << [type: updateType, id: item?.id, name: item?.name, forceProduction: forceProduction] logDebug "Updates found ${updateType} for ${pkgId} -> ${item?.name} (force production: ${forceProduction})" } // Update packages pathway def performUpdateCheck() { packagesWithUpdates = [:] for (pkg in state.manifests) { try { setBackgroundStatusMessage("Checking for updates for ${state.manifests[pkg.key].packageName}") def manifest = getJSONFile(pkg.key) if (shouldInstallBeta(manifest)) { manifest = getJSONFile(getItemDownloadLocation(manifest)) if (manifest) manifest.beta = true else { manifest = getJSONFile(pkg.key) manifest.beta = false } } else manifest.beta = false if (manifest == null) { log.warn "Found a bad manifest ${pkg.key}, please notify the package developer." continue } if (manifest.minimumHEVersion != null && !verifyHEVersion(manifest.minimumHEVersion)) { log.warn "New version of ${manifest.packageName} found but requires ${manifest.minimumHEVersion}, please update your firmware to upgrade." continue } def newVersionResult = newVersionAvailable(manifest, state.manifests[pkg.key]) if (newVersionResult.newVersion) { def version = includeBetas && manifest.betaVersion != null ? manifest.betaVersion : manifest.version packagesWithUpdates << ["${pkg.key}": "${state.manifests[pkg.key].packageName} (installed: ${state.manifests[pkg.key].version ?: "N/A"} current: ${version})"] logDebug "Updates found for package ${pkg.key}" addUpdateDetails(pkg.key, manifest.packageName, manifest.releaseNotes, "package", null, newVersionResult.forceProduction) } else { def appOrDriverNeedsUpdate = false for (app in manifest.apps) { try { if (app.id) { // skip if an app is not actually defined def installedApp = getAppById(state.manifests[pkg.key], app.id) if (app?.version != null && installedApp?.version != null) { newVersionResult = newVersionAvailable(app, installedApp) if (newVersionResult.newVersion) { if (!appOrDriverNeedsUpdate) { // Only add a package to the list once packagesWithUpdates << ["${pkg.key}": "${state.manifests[pkg.key].packageName} (driver or app has a new version)"] } appOrDriverNeedsUpdate = true addUpdateDetails(pkg.key, manifest.packageName, manifest.releaseNotes, "specificapp", app, newVersionResult.forceProduction) } } else if ((!installedApp || (!installedApp.required && installedApp.heID == null)) && app.required) { if (!appOrDriverNeedsUpdate) { // Only add a package to the list once packagesWithUpdates << ["${pkg.key}": "${state.manifests[pkg.key].packageName} (driver or app has a new requirement)"] } appOrDriverNeedsUpdate = true addUpdateDetails(pkg.key, manifest.packageName, manifest.releaseNotes, "reqapp", app, false) } else if (!installedApp && !app.required) { if (!appOrDriverNeedsUpdate) { // Only add a package to the list once packagesWithUpdates << ["${pkg.key}": "${state.manifests[pkg.key].packageName} (new optional app or driver is available)"] } appOrDriverNeedsUpdate = true addUpdateDetails(pkg.key, manifest.packageName, manifest.releaseNotes, "optapp", app, false) } } } catch (any) { logInfo "Skipping a bad manifest ${state.manifests[pkg.key].packageName}. Please notify the package developer." } } for (driver in manifest.drivers) { try { if (driver.id) { // skip if a driver is not actually defined def installedDriver = getDriverById(state.manifests[pkg.key], driver.id) if (driver?.version != null && installedDriver?.version != null) { newVersionResult = newVersionAvailable(driver, installedDriver) if (newVersionResult.newVersion) { if (!appOrDriverNeedsUpdate) {// Only add a package to the list once packagesWithUpdates << ["${pkg.key}": "${state.manifests[pkg.key].packageName} (driver or app has a new version)"] } appOrDriverNeedsUpdate = true addUpdateDetails(pkg.key, manifest.packageName, manifest.releaseNotes, "specificdriver", driver, newVersionResult.forceProduction) } } else if ((!installedDriver || (!installedDriver.required && installedDriver.heID == null)) && driver.required) { if (!appOrDriverNeedsUpdate) { // Only add a package to the list once packagesWithUpdates << ["${pkg.key}": "${state.manifests[pkg.key].packageName} (driver or app has a new requirement)"] } appOrDriverNeedsUpdate = true addUpdateDetails(pkg.key, manifest.packageName, manifest.releaseNotes, "reqdriver", driver, false) } else if (!installedDriver && !driver.required) { addUpdateDetails(pkg.key, manifest.packageName, manifest.releaseNotes, "optdriver", driver, false) if (!appOrDriverNeedsUpdate) { // Only add a package to the list once packagesWithUpdates << ["${pkg.key}": "${state.manifests[pkg.key].packageName} (new optional app or driver is available)"] } appOrDriverNeedsUpdate = true } } } catch (e) { logInfo "Skipping a bad manifest ${state.manifests[pkg.key].packageName}. ${e} Please notify the package developer." } } } } catch (e) { logInfo "Skipping a bad manifest ${state.manifests[pkg.key].packageName}. ${e} Please notify the package developer." } } packagesWithUpdates = packagesWithUpdates.sort { it -> it.value } atomicState.backgroundActionInProgress = false return packagesWithUpdates } def prefPkgUpdate() { if (state.mainMenu) return prefOptions() if (errorOccurred == true) { return buildErrorPage(errorTitle, errorMessage) } if (atomicState.backgroundActionInProgress == null) { logDebug "Update chosen" state.updatesNotified = false updateDetails = [:] optionalItemsToShow = [:] atomicState.backgroundActionInProgress = true runInMillis(1,performUpdateCheck) } if (atomicState.backgroundActionInProgress != false) { return dynamicPage(name: "prefPkgUpdate", title: "", nextPage: "prefPkgUpdate", install: false, uninstall: false, refreshInterval: 2) { displayHeader(' Update') section { paragraph "Checking for updates" paragraph "Checking for updates... Please wait..." paragraph getBackgroundStatusMessage() showHideNextButton(false) } } } else if (atomicState.backgroundActionInProgress == false) { if (packagesWithUpdates.size() > 0) { logDebug "Updates available" return dynamicPage(name: "prefPkgUpdate", title: "", nextPage: "prefPkgVerifyUpdates", install: false, uninstall: false) { displayHeader(' Update') section { paragraph "Updates Available" paragraph "Updates are available." input "pkgsToUpdate", "enum", title: "Which packages do you want to update?", multiple: true, required: true, options:packagesWithUpdates, submitOnChange: true } if (updateDetails?.size() > 0 && pkgsToUpdate != null) { for (pkgToUpdate in pkgsToUpdate) { def updateDetailsForPkg = updateDetails[pkgToUpdate] for (details in updateDetailsForPkg.items) { if (details.type == "optapp" || details.type == "optdriver") { optionalItemsToShow["${pkgToUpdate}~${details.id}"] = "${details.name} (${updateDetailsForPkg.name})" } } } if (optionalItemsToShow?.size() > 0) { section { input "pkgsToAddOpt", "enum", title: "One or more packages has new optional components. Choose which ones to add", multiple: true, options:optionalItemsToShow } } } section { if (updateDetails?.size() > 0 && pkgsToUpdate != null) showHideNextButton(true) else showHideNextButton(false) } section { paragraph "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } else { logDebug "No updates available" app.updateLabel("Hubitat Package Manager") return complete("No Updates Available", "All packages are up to date, click Next to return to the Main Menu.") } } } def prefPkgVerifyUpdates() { if (state.mainMenu) return prefOptions() logDebug "prefPkgVerifyUpdates" statusMessage = "" atomicState.backgroundActionInProgress = null errorOccurred = null errorTitle = null errorMessage = null def updatesToInstall = "
- "
if (pkgsToUpdate.size() == packagesWithUpdates.size())
app.updateLabel("Hubitat Package Manager")
else
app.updateLabel("Hubitat Package Manager Updates Available")
for (pkg in pkgsToUpdate) {
updatesToInstall += "
- ${state.manifests[pkg].packageName}"
if (updateDetails[pkg].releaseNotes != null) {
updatesToInstall += "
" updatesToInstall += "" } updatesToInstall += " "
}
updatesToInstall += "
- "
for (optItem in pkgsToAddOpt) {
optStrToInstall += "
- ${optionalItemsToShow[optItem]} " } optStrToInstall += "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } def prefPkgUpdatesComplete() { if (state.mainMenu) return prefOptions() if (errorOccurred == true) { return buildErrorPage(errorTitle, errorMessage) } if (atomicState.backgroundActionInProgress == null) { logDebug "Performing update" atomicState.hpmUpgraded = false for (pkg in pkgsToUpdate) { if (pkg == state.repositoryListingJSON.hpm.location) { atomicState.hpmUpgraded = true break } } atomicState.backgroundActionInProgress = true runInMillis(1,performUpdates) } if (atomicState.backgroundActionInProgress != false) { return dynamicPage(name: "prefPkgUpdatesComplete", title: "", nextPage: "prefPkgUpdatesComplete", install: false, uninstall: false, refreshInterval: 2) { displayHeader(' Update') section { showHideNextButton(false) paragraph "Installing Updates" paragraph "Installing updates... Please wait..." paragraph getBackgroundStatusMessage() } } } else { if (!atomicState.hpmUpgraded) return complete("Updates complete", "The updates have been installed, click Next to return to the Main Menu.") else { return complete("Updates complete", "The updates have been installed, click Done to continue.", true) } } } def shouldUpgrade(pkg, id) { def pkgUpdateDetails = updateDetails[pkg] for (updateItem in pkgUpdateDetails.items) { if (updateItem.type == "package") return true else if ((updateItem.type == "specificapp" || updateItem.type == "specificdriver") && updateItem.id == id) return true } return false } def optionalItemsOnly(pkg) { def pkgUpdateDetails = updateDetails[pkg] for (updateItem in pkgUpdateDetails.items) { if (updateItem.type == "package" || updateItem.type == "specificapp" || updateItem.type == "specificdriver" || updateItem.type == "reqapp" || updateItem.type == "reqdriver") return false } return true } def forceProduction(pkg, id) { def pkgUpdateDetails = updateDetails[pkg] for (updateItem in pkgUpdateDetails.items) { if (updateItem.type == "package") return updateItem.forceProduction else if ((updateItem.type == "specificapp" || updateItem.type == "specificdriver") && updateItem.id == id) return updateItem.forceProduction } return false } def performUpdates(runInBackground) { def resultData = [success: null, succeeded: [], failed: [], message: null] if (!login()) { resultData.message = triggerError("Error logging in to hub", "An error occurred logging into the hub. Please verify your Hub Security username and password.", runInBackground) resultData.success = false return resultData } // Download all files first to reduce the chances of a network error def downloadedManifests = [:] def appFiles = [:] def driverFiles = [:] def fileManagerFiles = [:] for (pkg in pkgsToUpdate) { def manifest = getJSONFile(pkg) if (shouldInstallBeta(manifest)) { manifest = getJSONFile(getItemDownloadLocation(manifest)) if (manifest) manifest.beta = true else manifest = getJSONFile(pkg) } else manifest.beta = false def installedManifest = state.manifests[pkg] downloadedManifests[pkg] = manifest if (manifest) { def fileMgrResults = downloadFileManagerFiles(manifest) if (fileMgrResults.success) fileManagerFiles = fileManagerFiles + fileMgrResults.files else return triggerError("Failed download of file", "An error occurred downloading ${fileMgrResults.name}", false) for (app in manifest.apps) { if (isAppInstalled(installedManifest,app.id)) { if (shouldUpgrade(pkg, app.id)) { def location if (!forceProduction(pkg, app.id)) location = getItemDownloadLocation(app) else location = app.location setBackgroundStatusMessage("Downloading ${app.name}") def fileContents = downloadFile(location) if (fileContents == null) { resultData.success = false resultData.failed << pkg resultData.message = triggerError("Failed download of file", "An error occurred downloading ${location}", runInBackground) return resultData } appFiles[location] = fileContents } } else if (app.required && !optionalItemsOnly(pkg)) { def location if (!forceProduction(pkg, app.id)) location = getItemDownloadLocation(app) else location = app.location setBackgroundStatusMessage("Downloading ${app.name} because it is required and not installed") def fileContents = downloadFile(location) if (fileContents == null) { resultData.success = false resultData.failed << pkg resultData.message = triggerError("Failed download of file", "An error occurred downloading ${location}", runInBackground) return resultData } appFiles[location] = fileContents } else { def location if (!forceProduction(pkg, app.id)) location = getItemDownloadLocation(app) else location = app.location for (optItem in pkgsToAddOpt) { def splitParts = optItem.split('~') if (splitParts[0] == pkg) { if (splitParts[1] == app.id) { setBackgroundStatusMessage("Downloading optional component ${app.name}") def fileContents = downloadFile(location) if (fileContents == null) { resultData.success = false resultData.failed << pkg resultData.message = triggerError("Failed download of file", "An error occurred downloading ${location}", runInBackground) return resultData } appFiles[location] = fileContents } } } } } for (driver in manifest.drivers) { if (isDriverInstalled(installedManifest,driver.id)) { if (shouldUpgrade(pkg, driver.id)) { def location if (!forceProduction(pkg, driver.id)) location = getItemDownloadLocation(driver) else location = driver.location setBackgroundStatusMessage("Downloading ${driver.name}") def fileContents = downloadFile(location) if (fileContents == null) { resultData.success = false resultData.failed << pkg resultData.message = triggerError("Failed download of file", "An error occurred downloading ${location}", runInBackground) return resultData } driverFiles[location] = fileContents } } else if (driver.required && !optionalItemsOnly(pkg)) { def location if (!forceProduction(pkg, driver.id)) location = getItemDownloadLocation(driver) else location = driver.location setBackgroundStatusMessage("Downloading ${driver.name} because it is required and not installed") def fileContents = downloadFile(location) if (fileContents == null) { resultData.success = false resultData.failed << pkg resultData.message = triggerError("Failed download of file", "An error occurred downloading ${location}", runInBackground) return resultData } driverFiles[location] = fileContents } else { def location if (!forceProduction(pkg, driver.id)) location = getItemDownloadLocation(driver) else location = driver.location for (optItem in pkgsToAddOpt) { def splitParts = optItem.split('~') if (splitParts[0] == pkg && splitParts[1] == driver.id) { setBackgroundStatusMessage("Downloading optional component ${driver.name}") def fileContents = downloadFile(location) if (fileContents == null) { resultData.success = false resultData.failed << pkg resultData.message = triggerError("Failed download of file", "An error occurred downloading ${location}", runInBackground) return resultData } driverFiles[location] = fileContents } } } } if (pkg == state.repositoryListingJSON.hpm?.location) sendLocationEvent(name: "hpmVersion", value: manifest.version) } else { resultData.success = false resultData.failed << pkg resultData.message = triggerError("Failed download of file", "The manifest file ${pkg} no longer seems to be valid.", runInBackground) return resultData } } for (pkg in pkgsToUpdate) { def manifest = downloadedManifests[pkg] def installedManifest = state.manifests[pkg] if (manifest) { initializeRollbackState("update") manifestForRollback = manifest if (manifest.betaVersion && includeBetas) manifest.beta = true for (bundleToInstall in manifest.bundles) { def location = getItemDownloadLocation(bundleToInstall) setBackgroundStatusMessage("Installing ${location}") if (!installBundle(location)) { return rollback("Failed to install bundle ${location}. Please notify the package developer.", false) } else completedActions["bundleInstalls"] << bundleToInstall } for (app in manifest.apps) { if (isAppInstalled(installedManifest,app.id)) { if (shouldUpgrade(pkg, app.id)) { def location if (!forceProduction(pkg, app.id)) location = getItemDownloadLocation(app) else location = app.location app.heID = getAppById(installedManifest, app.id).heID app.beta = shouldInstallBeta(app) && !forceProduction(pkg, app.id) def sourceCode = getAppSource(app.heID) setBackgroundStatusMessage("Upgrading ${app.name}") if (upgradeApp(app.heID, appFiles[location])) { completedActions["appUpgrades"] << [id:app.heID,source:sourceCode] if (app.oauth) enableOAuth(app.heID) } else { resultData.success = false resultData.failed << pkg resultData.message = rollback("Failed to upgrade app ${location}", runInBackground) return resultData } } } else if (app.required && !optionalItemsOnly(pkg)) { def location if (!forceProduction(pkg, app.id)) location = getItemDownloadLocation(app) else location = app.location setBackgroundStatusMessage("Installing ${app.name}") def id = installApp(appFiles[location]) if (id != null) { app.heID = id app.beta = shouldInstallBeta(app) && !forceProduction(pkg, app.id) if (app.oauth) enableOAuth(app.heID) } else { resultData.success = false resultData.failed << pkg resultData.message = rollback("Failed to install app ${location}", runInBackground) return resultData } } else { def location if (!forceProduction(pkg, app.id)) location = getItemDownloadLocation(app) else location = app.location for (optItem in pkgsToAddOpt) { def splitParts = optItem.split('~') if (splitParts[0] == pkg) { if (splitParts[1] == app.id) { setBackgroundStatusMessage("Installing ${app.name}") def id = installApp(appFiles[location]) if (id != null) { app.heID = id app.beta = shouldInstallBeta(app) && !forceProduction(pkg, app.id) if (app.oauth) enableOAuth(app.heID) } else { resultData.success = false resultData.failed << pkg resultData.message = rollback("Failed to install app ${location}", runInBackground) return resultData } } } } } } for (driver in manifest.drivers) { if (isDriverInstalled(installedManifest,driver.id)) { if (shouldUpgrade(pkg, driver.id)) { def location if (!forceProduction(pkg, driver.id)) location = getItemDownloadLocation(driver) else location = driver.location driver.heID = getDriverById(installedManifest, driver.id).heID driver.beta = shouldInstallBeta(driver) && !forceProduction(pkg, driver.id) def sourceCode = getDriverSource(driver.heID) setBackgroundStatusMessage("Upgrading ${driver.name}") if (upgradeDriver(driver.heID, driverFiles[location])) { completedActions["driverUpgrades"] << [id:driver.heID,source:sourceCode] } else { resultData.success = false resultData.failed << pkg resultData.message = rollback("Failed to upgrade driver ${location}", runInBackground) return resultData } } } else if (driver.required && !optionalItemsOnly(pkg)) { def location if (!forceProduction(pkg, driver.id)) location = getItemDownloadLocation(driver) else location = driver.location setBackgroundStatusMessage("Installing ${driver.name}") def id = installDriver(driverFiles[location]) if (id != null) { driver.heID = id driver.beta = shouldInstallBeta(driver) && !forceProduction(pkg, driver.id) } else { resultData.success = false resultData.failed << pkg resultData.message = rollback("Failed to install driver ${location}", runInBackground) return resultData } } else { def location if (!forceProduction(pkg, driver.id)) location = getItemDownloadLocation(driver) else location = driver.location for (optItem in pkgsToAddOpt) { def splitParts = optItem.split('~') if (splitParts[0] == pkg) { if (splitParts[1] == driver.id) { setBackgroundStatusMessage("Installing ${driver.name}") def id = installDriver(driverFiles[location]) if (id != null) { driver.heID = id driver.beta = shouldInstallBeta(driver) && !forceProduction(pkg, driver.id) } else { resultData.success = false resultData.failed << pkg resultData.message = rollback("Failed to install driver ${location}", runInBackground) return resultData } } } } } } for (fileToInstall in manifest.files) { def location = getItemDownloadLocation(fileToInstall) def fileContents = fileManagerFiles[location] setBackgroundStatusMessage("Installing ${location}") if (!installFile(fileToInstall.id, fileToInstall.name, fileContents)) { return rollback("Failed to install file ${location}. Please notify the package developer.", false) } else completedActions["fileInstalls"] << fileToInstall } if (state.manifests[pkg] != null) copyInstalledItemsToNewManifest(state.manifests[pkg], manifest) resultData.succeeded << pkg state.manifests[pkg] = manifest minimizeStoredManifests() } else { } } state.updatesNotified = false logDebug "Updates complete" if (runInBackground != true) atomicState.backgroundActionInProgress = false else { resultData.success = true return resultData } } def prefPkgMatchUp() { if (state.mainMenu) return prefOptions() logDebug "prefPkgMatchUp" return dynamicPage(name: "prefPkgMatchUp", title: "", nextPage: "prefPkgMatchUpVerify", install: false, uninstall: false) { displayHeader(' MatchUp') section { paragraph "Match Installed Apps and Drivers" paragraph "This will go through all of the apps and drivers you currently have installed in Hubitat and attempt to find matching packages. This process can take minutes or even hours depending on how many apps and drivers you have installed. Click Next to continue." } if (!state.firstRun) { section { paragraph "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } } def prefPkgMatchUpVerify() { if (state.mainMenu) return prefOptions() if (errorOccurred == true) { return buildErrorPage(errorTitle, errorMessage) } if (atomicState.backgroundActionInProgress == null) { logDebug "Performing Package Matching" atomicState.backgroundActionInProgress = true performPackageMatchup() } if (atomicState.backgroundActionInProgress != false) { return dynamicPage(name: "prefPkgMatchUpVerify", title: "", nextPage: "prefPkgMatchUpVerify", install: false, uninstall: false, refreshInterval: 2) { displayHeader(' MatchUp') section { showHideNextButton(false) paragraph "Matching Installed Apps and Drivers" paragraph "Matching packages... Please wait..." paragraph getBackgroundStatusMessage() } } } else { if (packagesMatchingInstalledEntries?.size() > 0) { def itemsForList = [:] for (pkg in packagesMatchingInstalledEntries) { def appAndDriverMatches = ((pkg.matchedApps?.collect { it -> it.title } ?: []) + (pkg.matchedDrivers?.collect { it -> it.title } ?: [])).join(", ") itemsForList << ["${pkg.location}":"${pkg.name} - matched (${appAndDriverMatches})"] } itemsForList = itemsForList.sort { it-> it.value} return dynamicPage(name: "prefPkgMatchUpVerify", title: "", nextPage: "prefPkgMatchUpComplete", install: false, uninstall: false) { displayHeader(' MatchUp') section { paragraph "Found Matching Packages" paragraph "The following matches were found. There is a possibility that some may have matched incorrectly. Only check off the items that you believe are correct." input "pkgMatches", "enum", title: "Choose packages to match", required: true, multiple: true, options: itemsForList input "pkgUpToDate", "bool", title: "Assume that packages are up-to-date? If set, the currently installed version will be marked as up-to-date. If not set, next time you run an update check this package will be updated." } if (!state.firstRun) { section { paragraph "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } } else { state.firstRun = false return complete("Match Up Complete", "No matching packages were found, click Next to return to the Main Menu.") } } } def performPackageMatchup() { if (!login()) return triggerError("Error logging in to hub", "An error occurred logging into the hub. Please verify your Hub Security username and password.", false) updateRepositoryListing() getMultipleJSONFiles(installedRepositories, performMatchupRepoRefreshComplete, performMatchupRepoRefreshStatus) } def performMatchupRepoRefreshComplete(results, data) { def packageManifests = [] def packageNames = [:] setBackgroundStatusMessage("Downloading package manifests") def manifestData = [:] for (uri in results.keySet()) { def repoName = getRepoName(uri) def result = results[uri] def fileContents = result.result if (fileContents == null) { setBackgroundStatusMessage("Unable to Refresh ${repoName ?: uri}", "warn") continue } for (pkg in fileContents.packages) { if (packageManifests.contains(pkg.location)) { logInfo "Skipping duplicate manifest ${pkg.location} Please notify the package developer." continue } packageManifests << pkg.location packageNames[pkg.location] = pkg.name manifestData[pkg.location] = [url: uri, githubUrl: fileContents.githubUrl, payPalUrl: fileContents.payPalUrl] } } getMultipleJSONFiles(packageManifests, performMatchupManifestsComplete, performMatchupManifestsStatus, [manifestData: manifestData, packageNames: packageNames]) } def performMatchupRepoRefreshStatus(uri, data) { def repoName = getRepoName(uri) setBackgroundStatusMessage("Refreshed ${repoName}") } def performMatchupManifestsStatus(uri, data) { } def performMatchupManifestsComplete(results, data) { setBackgroundStatusMessage("Retrieving list of installed apps") def allInstalledApps = getAppList() setBackgroundStatusMessage("Retrieving list of installed drivers") def allInstalledDrivers = getDriverList() // Filter out anything that already has an associated package for (manifest in state.manifests) { for (app in manifest.value.apps) { if (app.heID != null) allInstalledApps.removeIf {it -> it.id == app.heID} } for (driver in manifest.value.drivers) { if (driver.heID != null) allInstalledDrivers.removeIf {it -> it.id == driver.heID} } } def packagesToMatchAgainst = [] for (uri in results.keySet()) { def result = results[uri] def manifestContents = result.result if (manifestContents == null) logInfo "Ignoring an incomplete manifest ${uri}. Please notify the package developer." else { def pkgDetails = [ gitHubUrl: data.manifestData[uri].gitHubUrl, payPalUrl: data.manifestData[uri].payPalUrl, repository: getRepoName(data.manifestData[uri].url), name: data.packageNames[uri], location: uri, manifest: manifestContents ] packagesToMatchAgainst << pkgDetails } } packagesMatchingInstalledEntries = [] setBackgroundStatusMessage("Matching up packages") for (pkg in packagesToMatchAgainst) { def matchedInstalledApps = [] def matchedInstalledDrivers = [] for (app in pkg.manifest.apps) { def appsToAdd = findMatchingAppOrDriver(allInstalledApps, app) if (appsToAdd != null) matchedInstalledApps << appsToAdd } for (driver in pkg.manifest.drivers) { def driversToAdd = findMatchingAppOrDriver(allInstalledDrivers, driver) if (driversToAdd != null) matchedInstalledDrivers << driversToAdd } if (matchedInstalledApps?.size() > 0 || matchedInstalledDrivers?.size() > 0) { pkg.matchedApps = matchedInstalledApps pkg.matchedDrivers = matchedInstalledDrivers packagesMatchingInstalledEntries << pkg } } atomicState.backgroundActionInProgress = false } def prefPkgMatchUpComplete() { if (state.mainMenu) return prefOptions() logDebug "prefPkgMatchUpComplete" for (match in pkgMatches) { def matchFromState = packagesMatchingInstalledEntries.find {it -> it.location == match} if (matchFromState) { def manifest = matchFromState.manifest def installedApps = matchFromState.matchedApps def installedDrivers = matchFromState.matchedDrivers if (!pkgUpToDate && manifest.version != null) manifest.version = "0.0" for (app in manifest.apps) { def installedApp = findMatchingAppOrDriver(installedApps, app) if (installedApp != null) { app.heID = installedApp.id if (!pkgUpToDate && app.version != null) app.version = "0.0" } } for (driver in manifest.drivers) { def installedDriver = findMatchingAppOrDriver(installedDrivers, driver) if (installedDriver != null) { driver.heID = installedDriver.id if (!pkgUpToDate && driver.version != null) driver.version = "0.0" } } if (state.manifests[match]) copyInstalledItemsToNewManifest(state.manifests[match], manifest) if (matchFromState.gitHubUrl != null) manifest.gitHubUrl = matchFromState.gitHubUrl if (matchFromState.payPalUrl != null) manifest.payPalUrl = matchFromState.payPalUrl state.manifests[match] = manifest minimizeStoredManifests() } } state.firstRun = false return dynamicPage(name: "prefPkgMatchUpComplete", title: "", install: true, uninstall: false) { displayHeader(' MatchUp') section { paragraph "Match Up Complete" if (pkgUpToDate) paragraph "The selected packages have been marked as installed. Click Done to continue." else paragraph "The selected packages have been marked as installed. Click Done to continue. If you wish to update the packages to the latest version, run an Update." } section { paragraph "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } def prefPkgUnMatch() { if (state.mainMenu) return prefOptions() state.remove("UnMatch") logDebug "prefPkgUnMatch" def pkgsToList = getInstalledPackages(false) return dynamicPage(name: "prefPkgUnMatch", title: "", nextPage: "prefPkgUnMatchVerify", install: false, uninstall: false) { displayHeader(' UnMatch') section { paragraph "Package UnMatch" input "pkgUnMatch", "enum", title: "Choose packages to un-match", required: true, multiple: true, options: pkgsToList } section { // input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } def prefPkgUnMatchVerify() { if (state.mainMenu) return prefOptions() logDebug "prefPkgUnMatchVerify" return dynamicPage(name: "prefPkgUnMatchVerify", title: "", nextPage: "prefPkgUnMatchComplete", install: false, uninstall: false) { displayHeader(' UnMatch') section { paragraph "Un-Match Confirm" paragraph "The following packages will be Un-Matched:" def str = "
- "
for (pkgToUnM in pkgUnMatch) {
def pkg = state.manifests[pkgToUnM]
for (app in pkg.apps) {
if (app.heID != null)
str += "
- ${app.name} (App) " } for (driver in pkg.drivers) { if (driver.heID != null) str += "
- ${driver.name} (Device Driver) " } for (bundle in pkg.bundles) { if (bundle.name != null) str += "
- ${bundle.name} (Bundle) " } } str += "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } def prefPkgUnMatchComplete() { if (state.mainMenu) return prefOptions() logDebug "prefPkgUnMatchComplete" for (pkgToUnM in pkgUnMatch) { state.manifests.remove(pkgToUnM) } return dynamicPage(name: "prefPkgUnMatchComplete", title: "", install: true, uninstall: false) { displayHeader(' UnMatch') section { paragraph "Un-Match Complete" } section { paragraph "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } def prefPkgView() { if (state.mainMenu) return prefOptions() logDebug "prefPkgView" def appsManaged = [] def driversManaged = [] def str = "
- "
def sortedPkgs = state.manifests.sort{ it-> it.value.packageName}
for (pkg in sortedPkgs) {
def prependBar = false
str += "
- ${pkg.value.packageName}"
if (pkg.value.documentationLink?.trim()) {
str += " Documentation "
prependBar = true
}
if (pkg.value.communityLink?.trim()) {
if (prependBar)
str += "|"
str += " Community Thread "
prependBar = true
}
if (pkg.value.payPalUrl?.trim()) {
if (prependBar)
str += "|"
str += " Donate"
}
str += "
- "
for (app in pkg.value.apps?.sort { it -> it.name}) {
if (app.heID != null)
str += "
- ${app.name} v${getItemVersion(app) ?: getItemVersion(pkg.value)} (app) " } for (driver in pkg.value.drivers?.sort { it -> it.name}) { if (driver.heID != null) str += "
- ${driver.name} v${getItemVersion(driver) ?: getItemVersion(pkg.value)} (driver) " } str += "
"
}
str += "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } def buildErrorPage(title, message) { return dynamicPage(name: "prefError", title: "", install: true, uninstall: false) { displayHeader() section { paragraph "${title}" paragraph message showHideNextButton(true) } section { paragraph "
" input "btnMainMenu", "button", title: "Main Menu", width: 3 } } } def buildNotification(text) { if (notifyIncludeHubName) return "${location.name} - ${text}" else return text } def checkForUpdates() { updateRepositoryListing() def allUpgradeCount = 0 def packagesWithLabels = performUpdateCheck() def packagesWithUpdates = packagesWithLabels?.keySet() as List if (packagesWithUpdates?.size() == 0) app.updateLabel("Hubitat Package Manager") else { allUpgradeCount = packagesWithUpdates?.size()?: 0 if (notifyUpdatesAvailable && !state.updatesNotified) { logDebug "Sending update notification" state.updatesNotified = true notifyDevices*.deviceNotification(buildNotification("Hubitat Package updates are available")) } if (autoUpdateMode != "Never") { if (isHubSecurityEnabled() && !hpmSecurity) { log.error "Hub security is enabled but not configured in Package Manager. Updates cannot be installed." if (notifyOnFailure) { notifyUpdateFailureDevices*.deviceNotification(buildNotification("Hub security is enabled but not configured in Package Manager. Updates cannot be installed.")) } return } if (autoUpdateMode == "Include") packagesWithUpdates.removeIf { hasUpdate -> appsToAutoUpdate.find { it == hasUpdate} == null } else if (autoUpdateMode == "Exclude") packagesWithUpdates.removeIf { hasUpdate -> appsNotToAutoUpdate.find { it == hasUpdate} != null } if (packagesWithUpdates?.size() > 0) { app.updateSetting("pkgsToUpdate", packagesWithUpdates) pkgsToUpdate = packagesWithUpdates def result = null try { result = performUpdates(true) if (result.success == true) { if (notifyOnSuccess) { if (!notifySpecificPackages) notifyUpdateSuccessDevices*.deviceNotification(buildNotification("The packages were updated successfully")) if (packagesWithUpdates.size() < allUpgradeCount) app.updateLabel("Hubitat Package Manager Updates Available") else app.updateLabel("Hubitat Package Manager") } } else { log.warn "Automatic update failure: ${result}" if (notifyOnFailure) { if (notifySpecificPackages) notifyUpdateFailureDevices*.deviceNotification(buildNotification("One or more packages failed to automatically update. Check the logs for more information")) app.updateLabel("Hubitat Package Manager Updates Available") } } } catch (e) { log.warn "Automatic update failure: ${e}" if (notifyOnFailure) { if (notifySpecificPackages) notifyUpdateFailureDevices*.deviceNotification(buildNotification("One or more packages failed to automatically update. Check the logs for more information")) app.updateLabel("Hubitat Package Manager Updates Available") } } if (notifySpecificPackages) { if (notifyOnSuccess) { for (successful in result.succeeded) { log.debug successful log.debug state.manifests[successful].packageName notifyUpdateSuccessDevices*.deviceNotification(buildNotification("${state.manifests[successful].packageName} was updated successfully")) } } if (notifyOnFailure) { for (failed in result.failed) { notifyUpdateFailureDevices*.deviceNotification(buildNotification("${state.manifests[failed].packageName} failed to update")) } } } } } else app.updateLabel("Hubitat Package Manager Updates Available") } } def clearStateSettings(clearProgress) { installMode = null app.removeSetting("pkgInstall") app.removeSetting("appsToInstall") app.removeSetting("driversToInstall") app.removeSetting("pkgModify") app.removeSetting("pkgRepair") app.removeSetting("appsToModify") app.removeSetting("driversToModify") app.removeSetting("pkgUninstall") app.removeSetting("pkgsToUpdate") app.removeSetting("pkgsToAddOpt") app.removeSetting("pkgCategory") app.removeSetting("pkgTags") app.removeSetting("pkgMatches") app.removeSetting("pkgUpToDate") app.removeSetting("pkgSearch") app.removeSetting("launchInstaller") packagesWithUpdates = [:] updateDetails = [:] packagesMatchingInstalledEntries = [] optionalItemsToShow = [:] state.customRepo = false state.remove("UnMatch") app.removeSetting("customRepo") if (clearProgress) { statusMessage = "" atomicState.backgroundActionInProgress = null errorOccurred = null errorTitle = null errorMessage = null } // Things that used to be in state that are not any longer. Clean up state.remove("action") atomicState.remove("statusMessage") atomicState.remove("inProgress") atomicState.remove("errorTitle") atomicState.remove("errorMessage") atomicState.remove("error") atomicState.remove("completedActions") state.remove("releaseNotes") state.remove("needsUpdate") state.remove("packageToInstall") state.remove("specificPackageItemsToUpgrade") state.remove("appsToInstall") state.remove("appsToUninstall") state.remove("driversToInstall") state.remove("driversToUninstall") state.remove("packagesWithMatches") state.remove("updateManifest") } def initializeRollbackState(action) { installAction = action completedActions = [:] completedActions["appInstalls"] = [] completedActions["driverInstalls"] = [] completedActions["appUninstalls"] = [] completedActions["driverUninstalls"] = [] completedActions["appUpgrades"] = [] completedActions["driverUpgrades"] = [] completedActions["fileUninstalls"] = [] completedActions["fileInstalls"] = [] completedActions["fileUpgrades"] = [] completedActions["bundleUninstalls"] = [] completedActions["bundleInstalls"] = [] completedActions["bundleUpgrades"] = [] } def getInstalledPackages(onlyWithOptional) { def pkgsToList = [:] for (pkg in state.manifests) { if (!onlyWithOptional || pkg.value.apps?.find {it -> it.required == false } || pkg.value.drivers?.find {it -> it.required == false }) pkgsToList[pkg.key] = pkg.value.packageName } pkgsToList = pkgsToList.sort { it -> it.value } return pkgsToList } def isAppInstalled(manifest, id) { for (app in manifest.apps) { if (app.id == id) { if (app.heID != null) return true else return false } } return false } def isDriverInstalled(manifest, id) { for (driver in manifest.drivers) { if (driver.id == id) { if (driver.heID != null) return true else return false } } return false } def isBundleInstalled(manifest, id) { for (bundle in manifest.bundles) { if (bundle.id == id) { if (bundle.heID != null) return true else return false } } return false } def getAppById(manifest, id) { for (app in manifest.apps) { if (app.id == id) { return app } } return null } def getDriverById(manifest, id) { for (driver in manifest.drivers) { if (driver.id == id) { return driver } } return null } def getAppByHEId(manifest, id) { for (app in manifest.apps) { if (app.heID == id) { return app } } return null } def getDriverByHEId(manifest, id) { for (driver in manifest.drivers) { if (driver.heID == id) { return driver } } return null } def getInstalledOptionalApps(manifest) { def result = [] for (app in manifest.apps) { if (app.heID != null && app.required == false) { result << app.id } } return result } def getInstalledOptionalDrivers(manifest) { def result = [] for (driver in manifest.drivers) { if (driver.heID != null && driver.required == false) { result << driver.id } } return result } def downloadFile(file) { try { def params = [ uri: file, requestContentType: "application/json", contentType: "application/json", textParser: true, timeout: 300 ] def result = null httpGet(params) { resp -> result = resp.data.text } return result } catch (e) { logInfo "Skip download of ${file}: ${e} Please notify the package developer." return null } } def downloadFileAsync(String file, String callback, Map data = null) { try { def params = [ uri: file, requestContentType: "application/json", contentType: "text/plain", timeout: 300 ] asynchttpGet(downloadFileAsyncCallback, params, [callback: callback, data: data, file: file]) } catch (e) { logInfo "Skip download of ${file}: ${e} Please notify the package developer." return null } } def downloadFileAsyncCallback(resp, data) { def result = null try { if (resp.status >= 200 && resp.status <= 299) result = resp.data else logInfo "Skip download of ${data['file']}: Received response ${resp.status} Please notify the package developer." } catch (e) { logInfo "Skip download of ${data['file']}: ${e} Please notify the package developer." } this."${data['callback']}"(result, data['data']) } def getJSONFile(uri) { try { def fileContents = downloadFile(uri) return new groovy.json.JsonSlurper().parseText(fileContents) } catch (e) { return null } } def getMultipleJSONFilesCallback(resp, data) { def result = null "${data.statusCallback}"(data.uri, data.uri) synchronized (downloadQueue) { downloadQueue[data.batchid]?.results[data.uri]?.result = resp downloadQueue[data.batchid]?.results[data.uri]?.complete = true def queuedItem = downloadQueue[data.batchid].results.find { k, v -> v.queued == true} if (queuedItem != null) { def itemValue = queuedItem.value itemValue.queued = false getJSONFileAsync(queuedItem.key, getMultipleJSONFilesCallback, [batchid: data.batchid, uri: queuedItem.key, callback: itemValue.callback, statusCallback: itemValue.statusCallback, data: itemValue.data]) } else if (downloadQueue[data.batchid].results.count { k, v -> v.complete == true} == downloadQueue[data.batchid].totalBatchSize) { result = downloadQueue[data.batchid].results } } if (result != null) "${data.callback}"(result, data.data) } def getMultipleJSONFiles(uriList, completeCallback, statusCallback, data = null) { def batchid = UUID.randomUUID().toString() synchronized (downloadQueue) { def itemsToRemove = [] for (batch in downloadQueue.keySet()) { if (downloadQueue[batch].totalBatchSize == downloadQueue[batch].results.count { k, v -> v.complete == true}) { itemsToRemove << batch } } for (removeItem in itemsToRemove) { downloadQueue.remove(removeItem) } downloadQueue[batchid] = [totalBatchSize: uriList.size(), results: [:]] for (uri in uriList) { if (downloadQueue[batchid].results.count { k, v -> v.queued == false} < maxDownloadQueueSize) { downloadQueue[batchid].results[uri] = [complete: false, result: null, queued: false] getJSONFileAsync(uri, getMultipleJSONFilesCallback, [batchid: batchid, uri: uri, callback: completeCallback, statusCallback: statusCallback, data: data]) } else { downloadQueue[batchid].results[uri] = [complete: false, result: null, queued: true, callback: completeCallback, statusCallback: statusCallback, data: data] } } } } def getJSONFileAsync(String uri, String callback, Map data = null) { try { downloadFileAsync(uri, getJSONAsyncResult, [callback: callback, data: data]) } catch (e) { return null } } def getJSONAsyncResult(resp, data) { def result = null try { result = new groovy.json.JsonSlurper().parseText(resp) } catch (e) { } this."${data['callback']}"(result, data['data']) } def getOptionalAppsFromManifest(manifest) { def appsList = [:] for (app in manifest?.apps) { if (app.required == false) appsList << ["${app.id}":app.name] } return appsList } def getOptionalDriversFromManifest(manifest) { def driversList = [:] for (driver in manifest?.drivers) { if (driver.required == false) driversList << ["${driver.id}":driver.name] } return driversList } def getOptionalBundlesFromManifest(manifest) { def bundlesList = [:] for (bundle in manifest?.bundles) { if (bundle.required == false) bundlesList << ["${bundle.id}":bundle.name] } return bundlesList } def getRequiredAppsFromManifest(manifest) { def appsList = [:] for (app in manifest.apps) { if (app.required == true || app.required == "true") appsList << ["${app.id}":app] } return appsList } def getRequiredDriversFromManifest(manifest) { def driversList = [:] for (driver in manifest.drivers) { if (driver.required == true || driver.required == "true") driversList << ["${driver.id}":driver] } return driversList } def getRequiredBundlesFromManifest(manifest) { def bundlesList = [:] for (bundle in manifest.bundles) { if (bundle.required == true || bundle.required == "true") bundlesList << ["${bundle.id}":bundle] } return bundlesList } def getInstalledManifest(pkgId) { for (pkg in state.manifests) { if (pkg.key == pkgId) return pkg.value } return null } def verifyHEVersion(versionStr) { def installedVersionParts = location.hub.firmwareVersionString.split(/\./) def requiredVersionParts = versionStr.split(/\./) for (def i = 0; i < requiredVersionParts.size(); i++) { if (i >= installedVersionParts.size()) { return false } def installedPart = installedVersionParts[i].toInteger() def requiredPart = requiredVersionParts[i].toInteger() if (installedPart < requiredPart) { return false } else if (installedPart > requiredPart) { return true } } return true } def compareVersions(oldVersion, newVersion) { newVersion = newVersion.replaceAll("[^\\d.]", "") oldVersion = oldVersion?.replaceAll("[^\\d.]", "") if (newVersion == oldVersion) return 0 def oldVersionParts = oldVersion?.split(/\./) def newVersionParts = newVersion.split(/\./) for (def i = 0; i < newVersionParts.size(); i++) { if (i >= oldVersionParts.size()) { return 1 } def oldPart = oldVersionParts[i].toInteger() def newPart = newVersionParts[i].toInteger() if (oldPart < newPart) { return 1 } } return -1 } def newVersionAvailable(item, installedItem) { def result = [newVersion: false, forceProduction: false] def versionStr = includeBetas && item.betaVersion != null ? item?.betaVersion : item?.version def installedVersionStr = installedItem.beta ? (installedItem?.betaVersion ?: installedItem?.version) : installedItem?.version if (versionStr == null) return result if (installedVersionStr == null) { result.newVersion = true return result // Version scheme has changed, force an upgrade } if (compareVersions(versionStr, item?.version) != -1) { result.forceProduction = true versionStr = item?.version } if (compareVersions(installedVersionStr, versionStr) > 0) { result.newVersion = true return result } if (versionStr == installedVersionStr && installedItem?.beta && versionStr == item?.version) { result.forceProduction = true result.newVersion = true return result } return result } def isHubSecurityEnabled() { def hubSecurityEnabled = false httpGet( [ uri: getBaseUrl(), path: "/hub/edit", textParser: true, ignoreSSLIssues: true ] ) { resp -> hubSecurityEnabled = resp.data?.text?.contains("
