Skip to content

enh: add view file history to web ui #960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
isc-pbarton merged 3 commits into from
Apr 21, 2026
Merged

enh: add view file history to web ui #960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc9802a
enh: add view file history to web ui
syonip Apr 18, 2026
fabdfce
doc: changelog for file history view
isc-pbarton Apr 21, 2026
625c225
Merge branch 'main' of https://github.com/intersystems/git-source-con…
isc-pbarton Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added
- Import of decomposed production items now has a brief timeout in case another deploy is in progress (#949)
- Option to view an individual file's history in the source control menu (#960)

### Fixed
- Changes to % routines mapped to the current namespace may now be added to source control and committed (#944)
Expand Down
7 changes: 6 additions & 1 deletion cls/SourceControl/Git/Extension.cls
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,15 @@ XData Menu
<MenuItem Name="Import" />
<MenuItem Name="ImportForce" />
<MenuItem Name="TakeOwnership" />
<MenuItem Name="FileHistory" Save="101" />
</Menu>
<Menu Name="%SourceContext" Type="1">
<MenuItem Name="AddToSC" Save="100" />
<MenuItem Name="RemoveFromSC"/>
<MenuItem Name="Revert" Save="100" />
<MenuItem Name="Commit" Save="100" />
<MenuItem Name="TakeOwnership" />
<MenuItem Name="FileHistory" Save="101" />
</Menu>
</MenuBase>
}
Expand Down Expand Up @@ -153,6 +155,7 @@ Method LocalizeName(name As %String) As %String
"Revert":$$$Text("@Revert@Discard changes to file"),
"Commit":$$$Text("@Commit@Commit changes to file"),
"TakeOwnership":$$$Text("@TakeOwnership@Take ownership of changes to file"),
"FileHistory":$$$Text("@FileHistory@View file history"),
"Sync":$$$Text("@Sync@Sync"),
"Push":$$$Text("@Push@Push to remote branch"),
"PushForce":$$$Text("@PushForce@Push to remote branch (Force)"),
Expand All @@ -175,7 +178,7 @@ Method OnSourceMenuItem(name As %String, ByRef Enabled As %String, ByRef Display
}
if ##class(SourceControl.Git.Utils).IsNamespaceInGit() {

if $listfind($listbuild("AddToSC", "RemoveFromSC", "Revert", "Commit", "ExportProduction", "TakeOwnership"), name) {
if $listfind($listbuild("AddToSC", "RemoveFromSC", "Revert", "Commit", "ExportProduction", "TakeOwnership", "FileHistory"), name) {
quit ..OnSourceMenuContextItem(InternalName,name,.Enabled,.DisplayName)
}

Expand Down Expand Up @@ -270,6 +273,8 @@ Method OnSourceMenuContextItem(itemName As %String, menuItemName As %String, ByR
if isCheckedOut && (userCheckedOut '= $username) {
set Enabled = 1
}
} elseif menuItemName = "FileHistory" {
set Enabled = ##class(SourceControl.Git.Utils).IsInSourceControl(itemName)
} elseif menuItemName = "ExportProduction" {
set itemNameNoExt = $piece(itemName,".",1,*-1)
set Enabled = (##class(SourceControl.Git.Production).IsProductionClass(itemNameNoExt,"FullExternalName"))
Expand Down
10 changes: 8 additions & 2 deletions cls/SourceControl/Git/Utils.cls
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Parameter InstallNamespace = "%SYS";
Parameter Slash = {$case($system.Version.GetOS(),"Windows":"\",:"/")};

/// Name of the file with version controlled items
Parameter GitMenuItems = ",Settings,Commit,Sync,Pull,Fetch,Push,Revert,";
Parameter GitMenuItems = ",Settings,Commit,Sync,Pull,Fetch,Push,Revert,FileHistory,";

Parameter ImportAfterGitMenuItems = ",Commit,Sync,Pull,Fetch,Push,";

Parameter GitContextMenuItems = ",%Diff,%Blame,";
Parameter GitContextMenuItems = ",%Diff,%Blame,FileHistory,";

ClassMethod %SYSNamespaceStorage() As %String [ CodeMode = expression ]
{
Expand Down Expand Up @@ -282,6 +282,12 @@ ClassMethod UserAction(InternalName As %String, MenuName As %String, ByRef Targe
} elseif (menuItemName = "GitWebUI") {
set Action = 2 + externalBrowser
set Target = urlPrefix _ "/isc/studio/usertemplates/gitsourcecontrol/webuidriver.csp/"_$namespace_"/"_$zconvert(InternalName,"O","URL")_"?"_urlPostfix
} elseif (menuItemName = "FileHistory") {
set Action = 2 + externalBrowser
set Target = urlPrefix _ "/isc/studio/usertemplates/gitsourcecontrol/webuidriver.csp/"_$namespace_"/"_$zconvert(InternalName,"O","URL")_"?view=file-history"
if urlPostfix '= "" {
set Target = Target_"&"_urlPostfix
}
} elseif (menuItemName = "Export") || (menuItemName = "ExportForce") {
write !, "==export start==",!
set ec = ..ExportAll($case(menuItemName="ExportForce",1:$$$Force,:0))
Expand Down
17 changes: 17 additions & 0 deletions cls/SourceControl/Git/WebUIDriver.cls
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ ClassMethod HandleRequest(pagePath As %String, InternalName As %String = "", Out
set responseJSON = ..UserInfo()
} elseif $extract(pagePath,6,*) = "uncommitted" {
set responseJSON = ..Uncommitted()
} elseif $extract(pagePath,6,*) = "page-info" {
set responseJSON = ..PageInfo(InternalName, $get(%request.Data("view",1)))
} elseif $extract(pagePath,6,*) = "settings" {
set responseJSON = ..GetSettingsURL(%request)
} elseif $extract(pagePath, 6, *) = "get-package-version"{
Expand Down Expand Up @@ -380,6 +382,21 @@ ClassMethod UserInfo() As %SystemBase
}
}

ClassMethod PageInfo(InternalName As %String = "", View As %String = "") As %SystemBase
{
set externalName = ""
if InternalName '= "" {
set externalName = ##class(SourceControl.Git.Utils).ExternalName(InternalName)
set externalName = $translate(externalName, "\", "/")
}
quit {
"internalName": (InternalName),
"externalName": (externalName),
"view": (View),
"isFileHistory": (View = "file-history")
}
}

ClassMethod Uncommitted() As %SystemBase
{
// Stub
Expand Down
173 changes: 141 additions & 32 deletions git-webui/release/share/git-webui/webui/js/git-webui.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,32 @@ $.get("api/home", function(homeURL){
webui.homeURL = url.url;
});

webui.pageInfo = {
internalName: "",
externalName: "",
view: "",
isFileHistory: false
};

webui.quotePath = function(path) {
return '"' + path.replace(/"/g, '\\"') + '"';
}

webui.isFileHistoryMode = function() {
return !!(webui.pageInfo && webui.pageInfo.isFileHistory && webui.pageInfo.externalName);
}

webui.getHistoryPath = function() {
return webui.isFileHistoryMode() ? webui.pageInfo.externalName : "";
}

webui.getHistoryDisplayName = function() {
if (!webui.pageInfo) {
return "";
}
return webui.pageInfo.internalName || webui.pageInfo.externalName || "";
}

webui.showSuccess = function(message) {
var messageBox = $("#message-box");
messageBox.empty();
Expand Down Expand Up @@ -698,7 +724,7 @@ webui.SideBarView = function(mainView, noEventHandlers) {
}

self.getCurrentContext = function() {
var args = window.location.href.split("webuidriver.csp/")[1].split("/");
var args = window.location.href.split("webuidriver.csp/")[1].split("?")[0].split("/");
var context = args[0];
if (args[1] && (args[1].indexOf(".ZPM") != -1)) {
context = args[1];
Expand All @@ -708,14 +734,15 @@ webui.SideBarView = function(mainView, noEventHandlers) {

self.updateContext = function(context) {
var urlParts = window.location.href.split("webuidriver.csp/");
var args = urlParts[1].split("/");
var args = urlParts[1].split("?")[0].split("/");
var querySuffix = window.location.search || "";
if (context.indexOf(".ZPM") != -1) {
args[1] = context;
} else {
args[0] = context;
args[1] = "";
}
window.location = urlParts[0] + "webuidriver.csp/" + args.join("/");
window.location = urlParts[0] + "webuidriver.csp/" + args.join("/") + querySuffix;
self.currentContext = context;
}

Expand Down Expand Up @@ -1119,6 +1146,12 @@ webui.SideBarView = function(mainView, noEventHandlers) {
$("#sidebar-home", self.element).remove();
}

if (webui.isFileHistoryMode()) {
$("#sidebar-workspace", self.element).remove();
$("#sidebar-stash", self.element).remove();
$("#sidebarDiscarded", self.element).remove();
}


self.getPackageVersion();
self.getEnvironment()
Expand Down Expand Up @@ -1158,7 +1191,14 @@ webui.LogView = function(historyView) {
content.removeChild(content.lastElementChild);
}
var startAt = content.childElementCount;
webui.git("log --date-order --pretty=raw --decorate=full --max-count=" + (maxCount + 1) + " " + self.nextRef + " --", function(data) {
var command = "log --date-order --pretty=raw --decorate=full --max-count=" + (maxCount + 1) + " " + self.nextRef;
var historyPath = webui.getHistoryPath();
if (historyPath) {
command += " --follow -- " + webui.quotePath(historyPath);
} else {
command += " --";
}
webui.git(command, function(data) {
var start = 0;
var count = 0;
self.nextRef = undefined;
Expand Down Expand Up @@ -1684,7 +1724,7 @@ webui.DiffView = function(sideBySide, hunkSelectionAllowed, parent, stashedCommi
if (cmd) {
self.gitCmd = cmd;
self.gitDiffOpts = diffOpts;
if (file != self.gitFile && self.gitFile != '"undefined"') {
if (sideBySide && file != self.gitFile && self.gitFile != '"undefined"') {
left.scrollTop = 0;
left.scrollLeft = 0;
right.scrollTop = 0;
Expand Down Expand Up @@ -2078,6 +2118,60 @@ webui.DiffView = function(sideBySide, hunkSelectionAllowed, parent, stashedCommi
});
}

self.copyContent = function() {
function writeText(text) {
if (navigator.clipboard && navigator.clipboard.writeText) {
return navigator.clipboard.writeText(text);
}
return new Promise(function(resolve, reject) {
var textArea = document.createElement('textarea');
textArea.value = text;
textArea.style.position = 'fixed';
textArea.style.top = '0';
textArea.style.left = '0';
textArea.style.width = '1px';
textArea.style.height = '1px';
textArea.style.padding = '0';
textArea.style.border = 'none';
textArea.style.outline = 'none';
textArea.style.boxShadow = 'none';
textArea.style.background = 'transparent';
document.body.appendChild(textArea);
textArea.focus();
textArea.select();
try {
var successful = document.execCommand('copy');
document.body.removeChild(textArea);
if (successful) {
resolve();
} else {
reject(new Error('Copy command failed'));
}
} catch (err) {
document.body.removeChild(textArea);
reject(err);
}
});
}

var historyPath = webui.getHistoryPath();
if (webui.isFileHistoryMode() && parent.currentCommit && historyPath) {
var fileSpecifier = parent.currentCommit + ":" + historyPath;
webui.git_command(["show", fileSpecifier], function(content) {
writeText(content).then(function() {
webui.showSuccess("File content copied to clipboard");
}).catch(function(err) {
console.error('Failed to copy: ', err);
webui.showError("Unable to copy file content to clipboard.");
});
}, function(message) {
webui.showError(message);
});
} else {
webui.showWarning("Unable to copy file content: no file selected or history path unavailable.");
}
}

var html = '<div class="diff-view-container panel panel-default">';
if (! (parent instanceof webui.CommitExplorerView)) {
html +=
Expand All @@ -2094,6 +2188,7 @@ webui.DiffView = function(sideBySide, hunkSelectionAllowed, parent, stashedCommi
'<button type="button" class="btn btn-default diff-cancel" style="display:none">Cancel</button>' +
'<button type="button" class="btn btn-default diff-unstage" style="display:none">Unstage</button>' +
'</div>' +
(webui.isFileHistoryMode() ? '<button type="button" class="btn btn-sm btn-default diff-copy">Copy</button>' : '') +
((sideBySide || stashedCommit) ? '' : '<button type="button" class="btn btn-sm btn-default diff-explore">Explore</button>') +
(stashedCommit ? '<button type="button" class="btn btn-sm btn-default apply-stash">Apply</button>':'')+
(stashedCommit ? '<button type="button" class="btn btn-sm btn-default pop-stash">Pop</button>':'')+
Expand Down Expand Up @@ -2139,6 +2234,7 @@ webui.DiffView = function(sideBySide, hunkSelectionAllowed, parent, stashedCommi
$(".apply-stash", self.element).click(function() { self.applySelectedStash(); });
$(".pop-stash", self.element).click(function() { self.popSelectedStash(); });
$(".drop-stash", self.element).click(function() { self.dropSelectedStash(); });
$(".diff-copy", self.element).click(self.copyContent);

self.context = 3;
self.complete = false;
Expand Down Expand Up @@ -2567,12 +2663,17 @@ webui.CommitView = function(historyView) {

var self = this;

self.currentCommit = null;

self.update = function(entry) {
self.currentCommit = entry.commit;
currentCommit = entry.commit;
self.showDiff();
buttonBox.select(0);
diffView.update("show -p --diff-merges=separate", [entry.commit]);
treeView.update(entry.tree);
diffView.update("show -p --diff-merges=separate", [entry.commit], webui.getHistoryPath() || undefined);
if (!webui.isFileHistoryMode()) {
treeView.update(entry.tree);
}
};

self.showDiff = function() {
Expand All @@ -2590,8 +2691,11 @@ webui.CommitView = function(historyView) {
self.element = $('<div id="commit-view">')[0];
var commitViewHeader = $('<div id="commit-view-header">')[0];
self.element.appendChild(commitViewHeader);
var buttonBox = new webui.TabBox([["Commit", self.showDiff], ["Tree", self.showTree]]);
var buttonBox = new webui.TabBox(webui.isFileHistoryMode() ? [["File", self.showDiff]] : [["Commit", self.showDiff], ["Tree", self.showTree]]);
commitViewHeader.appendChild(buttonBox.element);
if (webui.isFileHistoryMode()) {
$('<div class="text-muted file-history-label">').text(webui.getHistoryDisplayName()).appendTo(commitViewHeader);
}
var commitViewContent = $('<div id="commit-view-content">')[0];
self.element.appendChild(commitViewContent);
var diffView = new webui.DiffView(false, false, self);
Expand Down Expand Up @@ -3387,30 +3491,35 @@ function MainUi() {

$.get("dirname", function (data) {
webui.repo = data;
var title = $("title")[0];
title.textContent = "Git - " + webui.repo;
$.get("viewonly", function (data) {
webui.viewonly = data == "1";
$.get("hostname", function (data) {
webui.hostname = data

var body = $("body")[0];
$('<div id="message-box">').appendTo(body);
var globalContainer = $('<div id="global-container">').appendTo(body)[0];

self.sideBarView = new webui.SideBarView(self);
globalContainer.appendChild(self.sideBarView.element);

self.mainView = $('<div id="main-view">')[0];
globalContainer.appendChild(self.mainView);

self.historyView = new webui.HistoryView(self);
if (!webui.viewonly) {
self.workspaceView = new webui.WorkspaceView(self);
self.stashView = new webui.StashView(self);
self.discardedView = new webui.DiscardedView(self);
}
self.sideBarView.selectRef("HEAD");
$.get("api/page-info" + window.location.search, function (pageInfo) {
webui.pageInfo = JSON.parse(pageInfo);
var title = $("title")[0];
title.textContent = webui.isFileHistoryMode()
? "Git File History - " + webui.getHistoryDisplayName() + " - " + webui.repo
: "Git - " + webui.repo;
$.get("viewonly", function (data) {
webui.viewonly = data == "1";
$.get("hostname", function (data) {
webui.hostname = data

var body = $("body")[0];
$('<div id="message-box">').appendTo(body);
var globalContainer = $('<div id="global-container">').appendTo(body)[0];

self.sideBarView = new webui.SideBarView(self);
globalContainer.appendChild(self.sideBarView.element);

self.mainView = $('<div id="main-view">')[0];
globalContainer.appendChild(self.mainView);

self.historyView = new webui.HistoryView(self);
if (!webui.viewonly && !webui.isFileHistoryMode()) {
self.workspaceView = new webui.WorkspaceView(self);
self.stashView = new webui.StashView(self);
self.discardedView = new webui.DiscardedView(self);
}
self.sideBarView.selectRef("HEAD");
});
});
});
});
Expand Down
Loading
Loading