From 163b2f12e2076a643e744774c8408370655bfc09 Mon Sep 17 00:00:00 2001
From: Vidar Holen <spam@vidarholen.net>
Date: Sat, 5 Jun 2021 18:16:22 -0700
Subject: [PATCH] Sanity check command names (fixes #2227)

---
 CHANGELOG.md                  |  2 ++
 src/ShellCheck/Analytics.hs   | 38 +++++++++++++++++++++++++++++++++++
 src/ShellCheck/AnalyzerLib.hs |  4 ++++
 3 files changed, 44 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e0295e3..af762b6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,7 @@
 ## Git
 ### Added
+- SC2286-SC2288: Warn when command name ends in a symbol like `/.)'"`
+- SC2289: Warn when command name contains tabs or linefeeds
 
 ### Fixed
 
diff --git a/src/ShellCheck/Analytics.hs b/src/ShellCheck/Analytics.hs
index e61c30a..7c44986 100644
--- a/src/ShellCheck/Analytics.hs
+++ b/src/ShellCheck/Analytics.hs
@@ -197,6 +197,7 @@ nodeChecks = [
     ,checkEqualsInCommand
     ,checkSecondArgIsComparison
     ,checkComparisonWithLeadingX
+    ,checkCommandWithTrailingSymbol
     ]
 
 optionalChecks = map fst optionalTreeChecks
@@ -4265,5 +4266,42 @@ checkSecondArgIsComparison _ t =
             T_NormalWord _ (x:_) -> getId x
             _ -> getId t
 
+
+prop_checkCommandWithTrailingSymbol1 = verify checkCommandWithTrailingSymbol "/"
+prop_checkCommandWithTrailingSymbol2 = verify checkCommandWithTrailingSymbol "/foo/ bar/baz"
+prop_checkCommandWithTrailingSymbol3 = verify checkCommandWithTrailingSymbol "/"
+prop_checkCommandWithTrailingSymbol4 = verifyNot checkCommandWithTrailingSymbol "/*"
+prop_checkCommandWithTrailingSymbol5 = verifyNot checkCommandWithTrailingSymbol "$foo/$bar"
+prop_checkCommandWithTrailingSymbol6 = verify checkCommandWithTrailingSymbol "foo, bar"
+prop_checkCommandWithTrailingSymbol7 = verifyNot checkCommandWithTrailingSymbol ". foo.sh"
+prop_checkCommandWithTrailingSymbol8 = verifyNot checkCommandWithTrailingSymbol ": foo"
+prop_checkCommandWithTrailingSymbol9 = verifyNot checkCommandWithTrailingSymbol "/usr/bin/python[23] file.py"
+
+checkCommandWithTrailingSymbol _ t =
+    case t of
+        T_SimpleCommand _ _ (cmd:_) ->
+            let str = fromJust $ getLiteralStringExt (\_ -> Just "x") cmd
+                last = lastOrDefault 'x' str
+            in
+                case str of
+                    "." -> return ()  -- The . command
+                    ":" -> return ()  -- The : command
+                    " " -> return ()  -- Probably caught by SC1101
+                    "//" -> return () -- Probably caught by SC1127
+                    "" -> err (getId cmd) 2286 "This empty string is interpreted as a command name. Double check syntax (or use 'true' as a no-op)."
+                    _ | last == '/' -> err (getId cmd) 2287 "This is interpreted as a command name ending with '/'. Double check syntax."
+                    _ | last `elem` "\\.,([{<>}])#\"\'% " -> warn (getId cmd) 2288 ("This is interpreted as a command name ending with " ++ (format last) ++ ". Double check syntax.")
+                    _ | '\t' `elem` str -> err (getId cmd) 2289 "This is interpreted as a command name containing a tab. Double check syntax."
+                    _ | '\n' `elem` str -> err (getId cmd) 2289 "This is interpreted as a command name containing a linefeed. Double check syntax."
+                    _ -> return ()
+        _ -> return ()
+  where
+    format x =
+        case x of
+            ' ' -> "space"
+            '\'' -> "apostrophe"
+            '\"' -> "doublequote"
+            x -> '\'' : x : "\'"
+
 return []
 runTests =  $( [| $(forAllProperties) (quickCheckWithResult (stdArgs { maxSuccess = 1 }) ) |])
diff --git a/src/ShellCheck/AnalyzerLib.hs b/src/ShellCheck/AnalyzerLib.hs
index 5b97e87..e4d76f8 100644
--- a/src/ShellCheck/AnalyzerLib.hs
+++ b/src/ShellCheck/AnalyzerLib.hs
@@ -877,6 +877,10 @@ getBracedModifier s = headOrDefault "" $ do
 headOrDefault _ (a:_) = a
 headOrDefault def _   = def
 
+-- Get the last element or a default. Like `last` but safe.
+lastOrDefault def [] = def
+lastOrDefault _ list = last list
+
 --- Get element n of a list, or Nothing. Like `!!` but safe.
 (!!!) list i =
     case drop i list of