Merge pull request #18 from intersystems/package-manager-aware

Package manager awareness

Author: isc-svelury

cls/SourceControl/Git/Extension.cls

@@ -41,6 +41,7 @@ Method UserAction(Type As %Integer, Name As %String, InternalName As %String, Se
 		quit $$$OK
 	}
 	set InternalName = ##class(Utils).NormalizeInternalName(InternalName)
+	set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
 	set ec = ##class(Utils).UserAction(InternalName, Name, .Target, .Action, .Reload)
 	quit ec
 }
@@ -53,6 +54,7 @@ Method AfterUserAction(Type As %Integer, Name As %String, InternalName As %Strin
 		quit $$$OK
 	}
 	set InternalName = ##class(Utils).NormalizeInternalName(InternalName)
+	set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
 	set ec = ##class(Utils).AfterUserAction(Type, Name, InternalName, .Answer, .Msg, .Reload)
 	quit ec
 }
@@ -133,7 +135,7 @@ Method OnSourceMenuContextItem(itemName As %String, menuItemName As %String, ByR
 		set Enabled = -1
 	} elseif $F(itemName,",") > 0 { //if more than one item is selected, we can only add/remove, no diff or blame
 		set Enabled = $case(menuItemName,"%AddToSC":1,"%RemoveFromSC":1,:-1)
-	} elseif ##class(Utils).IsInSourceControl(##class(Utils).NormalizeInternalName(itemName)) {
+	} elseif ##class(Utils).IsInSourceControl(itemName) {
 		set Enabled = $Case(menuItemName, "%AddToSC":-1,:1)
 	} else {
 		set Enabled = $Case(menuItemName, "%AddToSC":1,:-1)
@@ -148,6 +150,9 @@ Method OnSourceMenuContextItem(itemName As %String, menuItemName As %String, ByR
 /// this menu item from the list totally, 0 will gray the menu item out and the default 1 will display the menu item as normal.
 Method OnMenuItem(MenuName As %String, InternalName As %String, SelectedText As %String, ByRef Enabled As %Boolean, ByRef DisplayName As %String) As %Status
 {
+	set InternalName = ##class(Utils).NormalizeInternalName(InternalName)
+	set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
+
 	#dim menu As %String= $Piece(MenuName,",")
 	#dim name As %String = $Piece(MenuName,",",2)
 	if menu = "%SourceContext", name = "" {
@@ -170,6 +175,7 @@ Method OnMenuItem(MenuName As %String, InternalName As %String, SelectedText As
 /// to load the item from an external format.
 Method OnBeforeLoad(InternalName As %String) As %Status
 {
+	set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
 	set InternalName = ##class(Utils).NormalizeInternalName(InternalName)
 	if ##class(Utils).IsInSourceControl(InternalName) {
 		quit ##class(Utils).ImportItem(InternalName)
@@ -186,6 +192,7 @@ Method OnAfterSave(InternalName As %String, Object As %RegisteredObject = {$$$NU
 	set sc = $$$OK
 	try {
 		set InternalName = ##class(Utils).NormalizeInternalName(InternalName)
+		set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
 		if ##class(Utils).IsNamespaceInGit() && ..IsInSourceControl(InternalName) {
 			set filename = ##class(Utils).FullExternalName(InternalName)
 			$$$ThrowOnError(##class(Utils).RemoveRoutineTSH(InternalName))
@@ -216,6 +223,7 @@ InternalName'="" && ##class(Utils).IsInSourceControl(##class(Utils).NormalizeInt
 /// Called after an item is deleted.
 Method OnAfterDelete(InternalName As %String) As %Status
 {
+	set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
 	set InternalName = ##class(Utils).NormalizeInternalName(InternalName)
 	if ##class(Utils).IsInSourceControl(InternalName) {
 		quit ##class(Utils).DeleteExternalFile(InternalName)
@@ -240,7 +248,7 @@ Method IsReadOnly(InternalName As %String) As %Boolean
 /// Check if another user has committed any changes to the item and return the status
 Method GetStatus(InternalName As %String, ByRef IsInSourceControl As %Boolean, ByRef Editable As %Boolean, ByRef IsCheckedOut As %Boolean, ByRef UserCheckedOut As %String) As %Status
 {
-	#; Quit ##super(InternalName,.IsInSourceControl,.Editable,.IsCheckedOut,.UserCheckedOut)
+	set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
 	set Editable='..IsReadOnly(),IsCheckedOut=1,UserCheckedOut=""
 	set filename=##class(SourceControl.Git.Utils).FullExternalName(InternalName)
 	set IsInSourceControl=(filename'=""&&($$$FileExists(filename)))
@@ -250,7 +258,7 @@ Method GetStatus(InternalName As %String, ByRef IsInSourceControl As %Boolean, B
 	if '$$$FileExists(filename) {
 		set IsCheckedOut=0
 	}
-	do ##class(Utils).GitStatus(.files)
+	do ##class(SourceControl.Git.Utils).GitStatus(.files)
 	if $Get(files(InternalName)) '= "" {
 		///it's in source control, checked out, and should be locked to editing by other users
 		///find out who has it edited

cls/SourceControl/Git/PackageManagerContext.cls

@@ -0,0 +1,44 @@
+Class SourceControl.Git.PackageManagerContext Extends %ZPM.PackageManager.Core.Singleton
+{
+
+Property InternalName As %String;
+
+Property IsInDefaultPackage As %Boolean [ InitialExpression = 0 ];
+
+Property IsInGitEnabledPackage As %Boolean [ InitialExpression = 0 ];
+
+Property Package As %ZPM.PackageManager.Developer.Module [ InitialExpression = {$$$NULLOREF} ];
+
+Property ResourceReference As %ZPM.PackageManager.Developer.ResourceReference [ InitialExpression = {$$$NULLOREF} ];
+
+Method InternalNameSet(InternalName As %String = "") As %Status
+{
+    if (InternalName '= i%InternalName) {
+        set i%InternalName = InternalName
+        set ..Package = ##class(%ZPM.PackageManager.Developer.Extension.Utils).FindHomeModule(InternalName,,.resourceReference)
+        set ..ResourceReference = resourceReference
+        set ..IsInGitEnabledPackage = $IsObject(..Package) && ##class(%Library.File).DirectoryExists(##class(%Library.File).NormalizeFilename(".git",..Package.Root))
+        set ..IsInDefaultPackage = $IsObject(..Package) && (##class(%Library.File).NormalizeDirectory(..Package.Root) = ##class(%Library.File).NormalizeDirectory(##class(SourceControl.Git.Utils).TempFolder()))
+    }
+    quit $$$OK
+}
+
+ClassMethod ForInternalName(InternalName As %String = "") As SourceControl.Git.PackageManagerContext
+{
+    set instance = ..%Get()
+    set instance.InternalName = InternalName
+    quit instance
+}
+
+Method Dump()
+{
+    write !,"Package manager context: "
+    write !?4,"InternalName: ",..InternalName
+    write !?4,"Package: ",$Select($IsObject(..Package):..Package.Name,1:"<none>")
+    write !?4,"Resource: ",$Select($IsObject(..ResourceReference):..ResourceReference.Name,1:"<none>")
+    write !?4,"Default? ",$Select(..IsInDefaultPackage:"Yes",1:"No")
+    write !?4,"Git-enabled? ",$Select(..IsInGitEnabledPackage:"Yes",1:"No"),!
+}
+
+}
+

cls/SourceControl/Git/Utils.cls

@@ -34,9 +34,13 @@ ClassMethod MakeError(msg As %String) As %Status [ CodeMode = expression, Privat
 $$$ERROR(8012,"Git",msg)
 }
 
-ClassMethod TempFolder() As %String [ CodeMode = expression ]
+ClassMethod TempFolder() As %String
 {
-$Get(@..#Storage@("settings","namespaceTemp"),..DefaultTemp()_$Translate($znspace,"%")_..#Slash)
+    Set context = ##class(SourceControl.Git.PackageManagerContext).%Get()
+    If context.IsInGitEnabledPackage {
+        Quit context.Package.Root
+    }
+    Quit $Get(@..#Storage@("settings","namespaceTemp"),..DefaultTemp()_$Translate($znspace,"%")_..#Slash)
 }
 
 ClassMethod MappingsNode() As %String [ CodeMode = expression ]
@@ -153,7 +157,7 @@ ClassMethod UserAction(InternalName As %String, MenuName As %String, ByRef Targe
             }
         } elseif (menuItemName = "%GitWebUI") {
             set Action = 2
-            set Target = "/isc/studio/usertemplates/gitsourcecontrol/webuidriver.csp/"_$namespace
+            set Target = "/isc/studio/usertemplates/gitsourcecontrol/webuidriver.csp/"_$namespace_"/"_$ZConvert(InternalName,"O","URL")
         } elseif (menuItemName = "%Export") || (menuItemName = "%ExportForce") {
             write "==export start==",!
             set ec = ..ExportAll($case(menuItemName="%ExportForce",1:$$$Force,:0))
@@ -603,20 +607,26 @@ ClassMethod FindInCspFolders(InternalName As %String, ByRef sourceControlItem As
 ClassMethod IsInSourceControl(InternalName As %String, ByRef sourceControlItem As %String) As %String
 {
     #dim isInSourceControl As %Boolean = 1
-    
+    set sourceControlItem = ""
+    set context = ##class(SourceControl.Git.PackageManagerContext).%Get()
     if $Data(@..#Storage@("items", ..NormalizeExtension(InternalName))) {
 	    set InternalName = ..NormalizeExtension(InternalName)
     }
 
     set isInSourceControl = $Data(@..#Storage@("items", InternalName)) > 0
     if isInSourceControl {
+        // Direct reference to namespace-default project
         set sourceControlItem = InternalName
-    }else {
-        //if no direct reference maybe we have to look in packages, projects or csp-apps ?
-        //We have three groups of routines
-        //packages for classes
-        //projects for everything
-        //csp-folders for csp and static files
+    } elseif context.IsInGitEnabledPackage && (InternalName = context.InternalName) {
+        // Next thing to check is if we're in a package manager-based package
+        set isInSourceControl = 1
+        set sourceControlItem = context.ResourceReference.Name
+    } else {
+        // If no direct or package reference, look in packages, projects or csp-apps
+        // We have three groups of routines
+        // packages for classes
+        // projects for everything
+        // csp-folders for csp and static files
 
         #dim type As %String = ..Type(InternalName)
         if type = "cls" {
@@ -638,7 +648,6 @@ ClassMethod IsInSourceControl(InternalName As %String, ByRef sourceControlItem A
             set isInSourceControl = ..FindInProjects(InternalName, .sourceControlItem)
         }
     }
-    //w "checking ", $G(type), " ", InternalName, "=", isInSourceControl, !
     quit isInSourceControl
 }
 
@@ -950,8 +959,6 @@ ClassMethod ExportItem(InternalName As %String, expand As %Boolean = 1, force As
             write "exporting new version of ", InternalName, " to ", filename,!
             $$$QuitOnError($system.OBJ.ExportUDL(InternalName, filename,"-d/diff"))
             $$$QuitOnError(..UpdateRoutineTSH(InternalName, $Horolog))
-        } else {
-	        write !,InternalName, " is not newer than on-disk version, skipping export"
         }
     }
     quit $$$OK
@@ -1163,6 +1170,11 @@ ClassMethod GitStatus(ByRef files)
 ClassMethod Name(InternalName As %String) As %String
 {
 	Set InternalName=##class(%Studio.SourceControl.Interface).normalizeName(InternalName)
+    Set context = ##class(SourceControl.Git.PackageManagerContext).%Get()
+    If (context.IsInGitEnabledPackage) && (InternalName = context.InternalName) && $IsObject(context.ResourceReference) {
+        Set relativePath = context.ResourceReference.Processor.OnItemRelativePath(InternalName)
+        Quit relativePath
+    }
 	Set usertype=$system.CLS.IsMthd("%Library.RoutineMgr","UserType")
 
 	// For an abstract document, use the GetOther() method to try to determine its "real" class

cls/SourceControl/Git/WebUIDriver.cls

@@ -1,8 +1,9 @@
 Class SourceControl.Git.WebUIDriver
 {
 
-ClassMethod HandleRequest(pagePath As %String, Output handled As %Boolean = 0, Output %data As %Stream.Object)
+ClassMethod HandleRequest(pagePath As %String, InternalName As %String = "", Output handled As %Boolean = 0, Output %data As %Stream.Object)
 {
+    set context = ##class(SourceControl.Git.PackageManagerContext).ForInternalName(InternalName)
     kill %data
     #dim %response As %CSP.Response
     #dim %request As %CSP.Request

csp/webuidriver.csp

@@ -2,8 +2,9 @@
 	set url = $Piece($Get(%request.CgiEnvs("REQUEST_URI"),$Get(%request.CgiEnvs("HTTP_URL"))),"?")
 	set pagePath = $Piece(url,..#CSPURL,2,*)
     set namespace = $Piece(pagePath,"/",2)
-    set resource = $Piece(pagePath,"/",3,*)
-    set %base = $Piece(url,..#CSPURL,1)_..#CSPURL_"/"_namespace_"/"
+    set internalName = $ZConvert($Piece(pagePath,"/",3),"I","URL")
+    set resource = $Piece(pagePath,"/",4,*)
+    set %base = $Piece(url,..#CSPURL,1)_..#CSPURL_"/"_namespace_"/"_$ZConvert(internalName,"O","URL")_"/"
 
     new $NAMESPACE
     set $NAMESPACE = namespace
@@ -39,7 +40,7 @@
     }
 
 	// Handles HTTP requests to /api/ (everything new) plus things previously sent to the Python backend
-	do ##class(SourceControl.Git.WebUIDriver).HandleRequest("/"_resource, .handled, .%data)
+	do ##class(SourceControl.Git.WebUIDriver).HandleRequest("/"_resource, internalName, .handled, .%data)
 	if handled {
 		kill %base
 		quit 1