Merge pull request #594 from intersystems/master-deprecate-cspapp

fix: make CSPApplication deprecated & forward compatible
intersystems · Oct 24, 2024 · 0084ce2 · 0084ce2
2 parents 45b4512 + cc9bbf1
commit 0084ce2
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/src/%ZPM/PackageManager.cls b/src/%ZPM/PackageManager.cls
@@ -495,6 +495,7 @@ ClassMethod GetVersion(ModuleName, ByRef out, list)
 /// For use in unit tests that need to test if a command threw any exceptions.
 ClassMethod ShellInternal(pCommand As %String, Output pException As %Exception.AbstractException) [ Internal ]
 {
+	New $$$DeprecationWarned
 	Set pException = $$$NULLOREF
 	Set tOneCommand = 0
 	Set tCommand = $Get(pCommand)
@@ -509,6 +510,7 @@ ClassMethod ShellInternal(pCommand As %String, Output pException As %Exception.A
 	)
 	Set tInShell = 0
 	For {
+		Kill $$$DeprecationWarned
 		Try {
 
 			// Have intro message just for first entrance to shell

diff --git a/src/%ZPM/PackageManager/Common.inc b/src/%ZPM/PackageManager/Common.inc
@@ -141,3 +141,6 @@ ROUTINE %ZPM.PackageManager.Common [Type=INC]
 
 /// OS corresponding slash
 #define SLASH $Select($$$isWINDOWS: "\", 1: "/")
+
+#; Variable to mark deprecation warning has been shown in the current process
+#define DeprecationWarned %ZPMModuleDeprecatedResource
diff --git a/src/%ZPM/PackageManager/Developer/Processor/CSPApplication.cls b/src/%ZPM/PackageManager/Developer/Processor/CSPApplication.cls
@@ -1,4 +1,4 @@
-Include (%sySecurity, %occErrors)
+Include (%sySecurity, %occErrors, %ZPM.PackageManager.Common, %ZPM.Formatting)
 
 Class %ZPM.PackageManager.Developer.Processor.CSPApplication Extends (%ZPM.PackageManager.Developer.Processor.Abstract, %XML.Adaptor, %Installer.CSPApplication) [ PropertyClass = %ZPM.PackageManager.Developer.Processor.PropertyParameters ]
 {
@@ -31,10 +31,10 @@ Parameter XMLTYPE = "ZPMCSPApplication";
 Property Enabled As %Boolean [ InitialExpression = 1 ];
 
 /// DeepSee Enabled
-Property DeepSeeEnabled As %Boolean [ InitialExpression = 0 ];
+Property DeepSeeEnabled As %Installer.Boolean [ InitialExpression = 0 ];
 
 /// iKnow Enabled
-Property iKnowEnabled As %Boolean [ InitialExpression = 0 ];
+Property iKnowEnabled As %Installer.Boolean [ InitialExpression = 0 ];
 
 /// Password authentication enabled
 Property PasswordAuthEnabled As %Boolean [ InitialExpression = 0 ];
@@ -65,6 +65,12 @@ Property Directory As %String(ATTRIBUTEREQUIRED = 0, MAXLEN = 1024) [ Required ]
 
 Method %OnNew(pResourceReference As %ZPM.PackageManager.Developer.ResourceReference) As %Status [ Private, ServerOnly = 1 ]
 {
+	Set packageName = pResourceReference.Module.Name
+	If ($Get(packageName) '= "") && '$Data($$$DeprecationWarned(packageName)) {
+		Set $$$DeprecationWarned(packageName) = 1
+		Write !, $$$FormattedLine($$$Red, "WARNING: The <CSPApplication></CSPApplication> resource tag is deprecated and may be removed in a future release of ZPM (IPM).")
+		Write !, $$$FormattedLine($$$Red, $$$FormatText("         Please contact the package developer of %1 to use <WebApplication></WebApplication> instead", packageName))
+	}
 	Set tSC = ##super(pResourceReference)
 	Set ..Url = $ZConvert(..Url,"L")
 	Quit tSC