|
| 1 | +using System; |
| 2 | +using System.Collections.Generic; |
| 3 | +using System.Linq; |
| 4 | + |
| 5 | +namespace GVFS.Hooks |
| 6 | +{ |
| 7 | + /// <summary> |
| 8 | + /// Pure parsing logic for detecting and extracting pathspecs from |
| 9 | + /// git unstage commands. Separated from Program.Unstage.cs so it |
| 10 | + /// can be linked into the unit test project without pulling in the |
| 11 | + /// rest of the Hooks assembly. |
| 12 | + /// </summary> |
| 13 | + public static class UnstageCommandParser |
| 14 | + { |
| 15 | + /// <summary> |
| 16 | + /// Result of parsing pathspec arguments from a git unstage command. |
| 17 | + /// </summary> |
| 18 | + public class PathspecResult |
| 19 | + { |
| 20 | + /// <summary>Null-separated inline pathspecs, or empty for all staged files.</summary> |
| 21 | + public string InlinePathspecs { get; set; } |
| 22 | + |
| 23 | + /// <summary>Path to a --pathspec-from-file, or null if not specified.</summary> |
| 24 | + public string PathspecFromFile { get; set; } |
| 25 | + |
| 26 | + /// <summary>Whether --pathspec-file-nul was specified.</summary> |
| 27 | + public bool PathspecFileNul { get; set; } |
| 28 | + |
| 29 | + /// <summary>True if parsing failed and the command should be blocked.</summary> |
| 30 | + public bool Failed { get; set; } |
| 31 | + } |
| 32 | + |
| 33 | + /// <summary> |
| 34 | + /// Detects whether the git command is an unstage operation that may need |
| 35 | + /// special handling for VFS projections. |
| 36 | + /// Matches: "restore --staged", "restore -S", "checkout HEAD --" |
| 37 | + /// </summary> |
| 38 | + public static bool IsUnstageOperation(string command, string[] args) |
| 39 | + { |
| 40 | + if (command == "restore") |
| 41 | + { |
| 42 | + return args.Any(arg => |
| 43 | + arg.Equals("--staged", StringComparison.OrdinalIgnoreCase) || |
| 44 | + // -S is --staged; char overload of IndexOf is case-sensitive, |
| 45 | + // which is required because lowercase -s means --source |
| 46 | + (arg.StartsWith("-") && !arg.StartsWith("--") && arg.IndexOf('S') >= 0)); |
| 47 | + } |
| 48 | + |
| 49 | + if (command == "checkout") |
| 50 | + { |
| 51 | + // "checkout HEAD -- <paths>" is an unstage+restore operation. |
| 52 | + // TODO: investigate whether "checkout <non-HEAD-tree> -- <paths>" also |
| 53 | + // needs PrepareForUnstage protection. It re-stages files (sets index to |
| 54 | + // a different tree-ish) and could hit the same skip-worktree interference |
| 55 | + // if the target files were staged by cherry-pick -n / merge and aren't in |
| 56 | + // ModifiedPaths. Currently scoped to HEAD only as the common unstage case. |
| 57 | + bool hasHead = args.Any(arg => arg.Equals("HEAD", StringComparison.OrdinalIgnoreCase)); |
| 58 | + bool hasDashDash = args.Any(arg => arg == "--"); |
| 59 | + return hasHead && hasDashDash; |
| 60 | + } |
| 61 | + |
| 62 | + return false; |
| 63 | + } |
| 64 | + |
| 65 | + /// <summary> |
| 66 | + /// Extracts pathspec arguments from a restore/checkout unstage command. |
| 67 | + /// Returns a <see cref="PathspecResult"/> containing either inline pathspecs, |
| 68 | + /// a --pathspec-from-file reference, or a failure indicator. |
| 69 | + /// |
| 70 | + /// When --pathspec-from-file is specified, the file path is returned so the |
| 71 | + /// caller can forward it through IPC to the mount process, which passes it |
| 72 | + /// to git diff --cached --pathspec-from-file. |
| 73 | + /// </summary> |
| 74 | + public static PathspecResult GetRestorePathspec(string command, string[] args) |
| 75 | + { |
| 76 | + // args[0] = hook type, args[1] = git command, rest are arguments |
| 77 | + List<string> paths = new List<string>(); |
| 78 | + bool pastDashDash = false; |
| 79 | + bool skipNext = false; |
| 80 | + bool isCheckout = command == "checkout"; |
| 81 | + |
| 82 | + // For checkout, the first non-option arg before -- is the tree-ish (e.g. HEAD), |
| 83 | + // not a pathspec. Track whether we've consumed it. |
| 84 | + bool treeishConsumed = false; |
| 85 | + |
| 86 | + // --pathspec-from-file support: collect the file path and nul flag |
| 87 | + string pathspecFromFile = null; |
| 88 | + bool pathspecFileNul = false; |
| 89 | + bool captureNextAsPathspecFile = false; |
| 90 | + |
| 91 | + for (int i = 2; i < args.Length; i++) |
| 92 | + { |
| 93 | + string arg = args[i]; |
| 94 | + |
| 95 | + if (captureNextAsPathspecFile) |
| 96 | + { |
| 97 | + pathspecFromFile = arg; |
| 98 | + captureNextAsPathspecFile = false; |
| 99 | + continue; |
| 100 | + } |
| 101 | + |
| 102 | + if (skipNext) |
| 103 | + { |
| 104 | + skipNext = false; |
| 105 | + continue; |
| 106 | + } |
| 107 | + |
| 108 | + if (arg.StartsWith("--git-pid=")) |
| 109 | + continue; |
| 110 | + |
| 111 | + // Capture --pathspec-from-file value |
| 112 | + if (arg.StartsWith("--pathspec-from-file=")) |
| 113 | + { |
| 114 | + pathspecFromFile = arg.Substring("--pathspec-from-file=".Length); |
| 115 | + continue; |
| 116 | + } |
| 117 | + |
| 118 | + if (arg == "--pathspec-from-file") |
| 119 | + { |
| 120 | + captureNextAsPathspecFile = true; |
| 121 | + continue; |
| 122 | + } |
| 123 | + |
| 124 | + if (arg == "--pathspec-file-nul") |
| 125 | + { |
| 126 | + pathspecFileNul = true; |
| 127 | + continue; |
| 128 | + } |
| 129 | + |
| 130 | + if (arg == "--") |
| 131 | + { |
| 132 | + pastDashDash = true; |
| 133 | + continue; |
| 134 | + } |
| 135 | + |
| 136 | + if (!pastDashDash && arg.StartsWith("-")) |
| 137 | + { |
| 138 | + // For restore: --source and -s take a following argument |
| 139 | + if (!isCheckout && |
| 140 | + (arg == "--source" || arg == "-s")) |
| 141 | + { |
| 142 | + skipNext = true; |
| 143 | + } |
| 144 | + |
| 145 | + continue; |
| 146 | + } |
| 147 | + |
| 148 | + // For checkout, the first positional arg before -- is the tree-ish |
| 149 | + if (isCheckout && !pastDashDash && !treeishConsumed) |
| 150 | + { |
| 151 | + treeishConsumed = true; |
| 152 | + continue; |
| 153 | + } |
| 154 | + |
| 155 | + paths.Add(arg); |
| 156 | + } |
| 157 | + |
| 158 | + // stdin ("-") is not supported in hook context — the hook's stdin |
| 159 | + // is not connected to the user's terminal |
| 160 | + if (pathspecFromFile == "-") |
| 161 | + { |
| 162 | + return new PathspecResult { Failed = true }; |
| 163 | + } |
| 164 | + |
| 165 | + return new PathspecResult |
| 166 | + { |
| 167 | + InlinePathspecs = paths.Count > 0 ? string.Join("\0", paths) : "", |
| 168 | + PathspecFromFile = pathspecFromFile, |
| 169 | + PathspecFileNul = pathspecFileNul, |
| 170 | + }; |
| 171 | + } |
| 172 | + } |
| 173 | +} |
0 commit comments