Create SECURITY.md

Fix #2859; script error when cwd name contains `%`

.github/workflows/branches.yml

@@ -0,0 +1,33 @@
+name: Update branches
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push events for the development branch
+  push:
+    branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This job updates the development branch with the master branch
+  update-development:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out the repository under $GITHUB_WORKSPACE, so the job can access it
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # fetch all history for all branches and tags
+
+      # Runs a single command using the runners shell
+      - name: Merge master into development
+        run: |
+          git config user.name "${{ github.actor }}"
+          git config user.email "${{ github.actor }}@users.noreply.github.com"
+          git checkout development
+          git merge --no-ff master
+          git push origin development

.github/workflows/build.yml

@@ -30,7 +30,9 @@ jobs:
   build:
     name: Build Project
     runs-on: windows-latest
-
+    permissions:
+      contents: write
+      discussions: write
     steps:
     - name: Check out repository code (Action from GitHub)
       uses: actions/checkout@v3

.github/workflows/codeql.yml

@@ -3,20 +3,25 @@
 #
 # You may wish to alter this file to override the set of languages analyzed,
 # or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
+
 name: "CodeQL"
 
 on:
   push:
     branches: [ "master" ]
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.txt'
+      - '.github/**'
+      - '**/.gitignore'
   pull_request:
     # The branches below must be a subset of the branches above
     branches: [ "master" ]
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.txt'
+      - '.github/**'
+      - '**/.gitignore'
   schedule:
     - cron: '30 19 * * 0'
 

.github/workflows/tests.yml

@@ -4,9 +4,19 @@ on:
   push:
     branches:
       - master
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.txt'
+      - '.github/**'
+      - '**/.gitignore'
   pull_request:
     branches:
       - master
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.txt'
+      - '.github/**'
+      - '**/.gitignore'
 
 defaults:
   run:

SECURITY.md

@@ -0,0 +1,22 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.3.x   | :white_check_mark: |
+| < 1.3   | ❎ |
+
+## Reporting a Vulnerability
+
+Please report any vulnerabilities to [MartiUK](https://github.com/MartiUK).
+
+Please include as much of the information listed below as you can to help us better understand and resolve the issue:
+
+The type of issue
+Full paths of source file(s) related to the manifestation of the issue
+The location of the affected source code (tag/branch/commit or direct URL)
+Any special configuration required to reproduce the issue
+Step-by-step instructions to reproduce the issue
+Proof-of-concept or exploit code (if possible)
+Impact of the issue, including how an attacker might exploit the issue

appveyor.yml

@@ -1,60 +0,0 @@
-#---------------------------------#
-#      general configuration      #
-#---------------------------------#
-
-version: 1.0.{build}-{branch}
-
-# branches to build
-branches:
-  # blacklist
-  except:
-    - gh-pages
-
-#---------------------------------#
-#    environment configuration    #
-#---------------------------------#
-
-# Operating system (build VM template)
-os: Visual Studio 2022
-
-#---------------------------------#
-#       build configuration       #
-#---------------------------------#
-
-build_script:
-  - ps: cd scripts; .\build.ps1 -Compile -verbose
-
-after_build:
-  - ps: .\pack.ps1 -verbose
-
-# Disable test search, since we don't have any.
-test: off
-
-#---------------------------------#
-#           artifacts             #
-#---------------------------------#
-
-artifacts:
-  - path: build\cmder.zip
-    name: cmderzip
-
-  - path: build\cmder.7z
-    name: cmder7z
-
-  - path: build\cmder_mini.zip
-    name: cmdermini
-
-  - path: build\hashes.txt
-    name: hashes
-
-#---------------------------------#
-#         notifications           #
-#---------------------------------#
-
-notifications:
-  # Webhook
-  - provider: Webhook
-    url: https://webhooks.gitter.im/e/d673abb1b2e659dcd625
-    on_build_success: true
-    on_build_failure: true
-    on_build_status_changed: true

vendor/clink.lua

@@ -3,7 +3,12 @@
 -- !!! THIS FILE IS OVERWRITTEN WHEN CMDER IS UPDATED
 -- !!! Use "%CMDER_ROOT%\config\<whatever>.lua" to add your lua startup scripts
 
--- luacheck: globals clink
+-- luacheck: globals CMDER_SESSION
+-- luacheck: globals uah_color cwd_color lamb_color clean_color dirty_color conflict_color unknown_color
+-- luacheck: globals prompt_homeSymbol prompt_lambSymbol prompt_type prompt_useHomeSymbol prompt_useUserAtHost
+-- luacheck: globals prompt_singleLine prompt_includeVersionControl
+-- luacheck: globals prompt_overrideGitStatusOptIn prompt_overrideSvnStatusOptIn
+-- luacheck: globals clink io.popenyield os.isdir settings.get
 
 -- At first, load the original clink.lua file
 -- this is needed as we set the script path to this dir and therefore the original
@@ -46,11 +51,37 @@ local function get_unknown_color()
 end
 
 ---
--- Makes a string safe to use as the replacement in string.gsub
+-- Escapes special characters in a string.gsub `find` parameter, so that it
+-- can be matched as a literal plain text string, i.e. disable Lua pattern
+-- matching.  See "Patterns" (https://www.lua.org/manual/5.2/manual.html#6.4.1).
+-- @param {string} text Text to escape
+-- @returns {string} Escaped text
 ---
-local function verbatim(s)
-    s = string.gsub(s, "%%", "%%%%")
-    return s
+local function escape_gsub_find_arg(text)
+    return text and text:gsub("([-+*?.%%()%[%]$^])", "%%%1") or ""
+end
+
+---
+-- Escapes special characters in a string.gsub `replace` parameter, so that it
+-- can be replaced as a literal plain text string, i.e. disable Lua pattern
+-- matching.  See "Patterns" (https://www.lua.org/manual/5.2/manual.html#6.4.1).
+-- @param {string} text Text to escape
+-- @returns {string} Escaped text
+---
+local function escape_gsub_replace_arg(text)
+    return text and text:gsub("%%", "%%%%") or ""
+end
+
+---
+-- Perform string.sub, but disable Lua pattern matching and just treat both
+-- the `find` and `replace` parameters as a literal plain text replacement.
+-- @param {string} str Text in which to perform find and replace
+-- @param {string} find Text to find (plain text; not a Lua pattern)
+-- @param {string} replace Replacement text (plain text; not a Lua pattern)
+-- @returns {string} Copy of the input `str` with `find` replaced by `replace`
+---
+local function gsub_plain(str, find, replace)
+    return string.gsub(str, escape_gsub_find_arg(find), escape_gsub_replace_arg(replace))
 end
 
 -- Extracts only the folder name from the input Path
@@ -148,15 +179,15 @@ local function set_prompt_filter()
     end
 
     if prompt_useHomeSymbol and string.find(cwd, clink.get_env("HOME")) then
-        cwd = string.gsub(cwd, clink.get_env("HOME"), prompt_homeSymbol)
+        cwd = gsub_plain(cwd, clink.get_env("HOME"), prompt_homeSymbol)
     end
 
-    uah = ''
+    local uah = ''
     if prompt_useUserAtHost then
         uah = clink.get_env("USERNAME") .. "@" .. clink.get_env("COMPUTERNAME") .. ' '
     end
 
-    cr = "\n"
+    local cr = "\n"
     if prompt_singleLine then
         cr = ' '
     end
@@ -170,15 +201,15 @@ local function set_prompt_filter()
 
     local version_control = prompt_includeVersionControl and "{git}{hg}{svn}" or ""
 
-    prompt = "{uah}{cwd}" .. version_control .. cr .. get_lamb_color() .. "{env}{lamb}\x1b[0m "
-    prompt = string.gsub(prompt, "{uah}", uah)
-    prompt = string.gsub(prompt, "{cwd}", cwd)
-    prompt = string.gsub(prompt, "{env}", env)
-    clink.prompt.value = string.gsub(prompt, "{lamb}", prompt_lambSymbol)
+    local prompt = "{uah}{cwd}" .. version_control .. cr .. get_lamb_color() .. "{env}{lamb}\x1b[0m "
+    prompt = gsub_plain(prompt, "{uah}", uah)
+    prompt = gsub_plain(prompt, "{cwd}", cwd)
+    prompt = gsub_plain(prompt, "{env}", env)
+    clink.prompt.value = gsub_plain(prompt, "{lamb}", prompt_lambSymbol)
 end
 
 local function percent_prompt_filter()
-    clink.prompt.value = string.gsub(clink.prompt.value, "{percent}", "%%")
+    clink.prompt.value = gsub_plain(clink.prompt.value, "{percent}", "%")
 end
 
 ---
@@ -191,7 +222,7 @@ end
 local function get_dir_contains(path, dirname)
 
     -- return parent path for specified entry (either file or directory)
-    local function pathname(path)
+    local function pathname(path) -- luacheck: ignore 432
         local prefix = ""
         local i = path:find("[\\/:][^\\/:]*$")
         if i then
@@ -201,14 +232,14 @@ local function get_dir_contains(path, dirname)
     end
 
     -- Navigates up one level
-    local function up_one_level(path)
+    local function up_one_level(path) -- luacheck: ignore 432
         if path == nil then path = '.' end
         if path == '.' then path = clink.get_cwd() end
         return pathname(path)
     end
 
     -- Checks if provided directory contains git directory
-    local function has_specified_dir(path, specified_dir)
+    local function has_specified_dir(path, specified_dir) -- luacheck: ignore 432
         if path == nil then path = '.' end
         local found_dirs = clink.find_dirs(path..'/'..specified_dir)
         if #found_dirs > 0 then return true end
@@ -236,7 +267,7 @@ end
 local function get_git_dir(path)
 
     -- return parent path for specified entry (either file or directory)
-    local function pathname(path)
+    local function pathname(path) -- luacheck: ignore 432
         local prefix = ""
         local i = path:find("[\\/:][^\\/:]*$")
         if i then
@@ -255,7 +286,8 @@ local function get_git_dir(path)
         local gitfile = io.open(dir..'/.git')
         if not gitfile then return false end
 
-        local git_dir = gitfile:read():match('gitdir: (.*)')
+        local line = gitfile:read() or ''
+        local git_dir = line:match('gitdir: (.*)')
         gitfile:close()
 
         if os.isdir then -- only available in Clink v1.0.0 and higher
@@ -303,6 +335,9 @@ local function get_git_branch(git_dir)
     local HEAD = head_file:read()
     head_file:close()
 
+    -- If HEAD is missing, something is wrong.
+    if not HEAD then return end
+
     -- if HEAD matches branch expression, then we're on named branch
     -- otherwise it is a detached commit
     local branch_name = HEAD:match('ref: refs/heads/(.+)')
@@ -322,6 +357,9 @@ local function get_hg_branch()
     -- local cmd = "hg prompt \"{branch}{status}{|{patch}}{update}\""
     local cmd = "hg branch 2>nul"
     local file = io.popen(cmd)
+    if not file then
+        return false
+    end
 
     for line in file:lines() do
         local m = line:match("(.+)$")
@@ -339,8 +377,12 @@ end
 -- Find out current branch
 -- @return {false|svn branch name}
 ---
-local function get_svn_branch(svn_dir)
+local function get_svn_branch()
     local file = io_popenyield("svn info 2>nul")
+    if not file then
+        return false
+    end
+
     for line in file:lines() do
         local m = line:match("^Relative URL:")
         if m then
@@ -359,12 +401,16 @@ end
 ---
 local function get_git_status()
     local file = io_popenyield("git --no-optional-locks status --porcelain 2>nul")
+    if not file then
+        return {}
+    end
+
     local conflict_found = false
     local is_status = true
     for line in file:lines() do
         local code = line:sub(1, 2)
         -- print (string.format("code: %s, line: %s", code, line))
-        if code == "DD" or code == "AU" or code == "UD" or code == "UA" or code == "DU" or code == "AA" or code == "UU" then
+        if code == "DD" or code == "AU" or code == "UD" or code == "UA" or code == "DU" or code == "AA" or code == "UU" then -- luacheck: no max line length
             is_status = false
             conflict_found = true
             break
@@ -374,38 +420,27 @@ local function get_git_status()
         end
     end
     file:close()
+
     return { status = is_status, conflict = conflict_found }
 end
 
-
----
--- Get the status of working dir
--- @return {bool}
----
-local function get_hg_status()
-    local file = io.popen("hg status -0")
-    for line in file:lines() do
-        file:close()
-        return false
-    end
-    file:close()
-
-    return true
-end
-
 ---
 -- Get the status of working dir
 -- @return {bool}
 ---
 local function get_svn_status()
     local file = io_popenyield("svn status -q")
-    for line in file:lines() do
+    if not file then
+        return { error = true }
+    end
+
+    for line in file:lines() do -- luacheck: ignore 512, no unused
         file:close()
-        return false
+        return { clean = false }
     end
     file:close()
 
-    return true
+    return { clean = true }
 end
 
 ---
@@ -433,24 +468,28 @@ local function get_git_status_setting()
     end
 
     local gitStatusConfig = io_popenyield("git --no-pager config cmder.status 2>nul")
-    for line in gitStatusConfig:lines() do
-        if string.match(line, 'false') then
-            gitStatusConfig:close()
-            last_git_status_setting = false
-            return false
+    if gitStatusConfig then
+        for line in gitStatusConfig:lines() do
+            if string.match(line, 'false') then
+                gitStatusConfig:close()
+                last_git_status_setting = false
+                return false
+            end
         end
+        gitStatusConfig:close()
     end
-    gitStatusConfig:close()
 
     local gitCmdStatusConfig = io_popenyield("git --no-pager config cmder.cmdstatus 2>nul")
-    for line in gitCmdStatusConfig:lines() do
-        if string.match(line, 'false') then
-            gitCmdStatusConfig:close()
-            last_git_status_setting = false
-            return false
+    if gitCmdStatusConfig then
+        for line in gitCmdStatusConfig:lines() do
+            if string.match(line, 'false') then
+                gitCmdStatusConfig:close()
+                last_git_status_setting = false
+                return false
+            end
         end
+        gitCmdStatusConfig:close()
     end
-    gitCmdStatusConfig:close()
 
     last_git_status_setting = true
     return true
@@ -519,13 +558,13 @@ local function git_prompt_filter()
                 color = colors.conflict
             end
 
-            clink.prompt.value = string.gsub(clink.prompt.value, "{git}", " "..color.."("..verbatim(branch)..")")
+            clink.prompt.value = gsub_plain(clink.prompt.value, "{git}", " "..color.."("..branch..")")
             return false
         end
     end
 
     -- No git present or not in git file
-    clink.prompt.value = string.gsub(clink.prompt.value, "{git}", "")
+    clink.prompt.value = gsub_plain(clink.prompt.value, "{git}", "")
     return false
 end
 
@@ -536,8 +575,6 @@ local function hg_prompt_filter()
         return false
     end
 
-    local result = ""
-
     local hg_dir = get_hg_dir()
     if hg_dir then
         -- Colors for mercurial status
@@ -559,16 +596,20 @@ local function hg_prompt_filter()
             local color = colors.clean
 
             local pipe = io.popen("hg status -amrd 2>&1")
-            local output = pipe:read('*all')
-            local rc = { pipe:close() }
+            if pipe then
+                output = pipe:read('*all')
+                pipe:close()
+                if output ~= nil and output ~= "" then color = colors.dirty end
+            end
 
-            if output ~= nil and output ~= "" then color = colors.dirty end
-            result = color .. "(" .. branch .. ")"
+            local result = color .. "(" .. branch .. ")"
+            clink.prompt.value = gsub_plain(clink.prompt.value, "{hg}", " "..result)
+            return false
         end
     end
 
-    clink.prompt.value = string.gsub(clink.prompt.value, "{hg}", " "..verbatim(result))
-    return false
+    -- No hg present or not in hg repo
+    clink.prompt.value = gsub_plain(clink.prompt.value, "{hg}", "")
 end
 
 local function svn_prompt_filter()
@@ -589,7 +630,6 @@ local function svn_prompt_filter()
     if svn_dir then
         -- if we're inside of svn repo then try to detect current branch
         local branch = get_svn_branch()
-        local color
         if branch then
             -- If in a different repo or branch than last time, discard cached info
             if cached_info.svn_dir ~= svn_dir or cached_info.svn_branch ~= branch then
@@ -599,7 +639,7 @@ local function svn_prompt_filter()
             end
             -- Get the svn status using coroutine if available and option is enabled. Otherwise use a blocking call
             local svnStatus
-            if clink.promptcoroutine and io.popenyield and settings.get("prompt.async") and prompt_overrideSvnStatusOptIn then
+            if clink.promptcoroutine and io.popenyield and settings.get("prompt.async") and prompt_overrideSvnStatusOptIn then -- luacheck: no max line length
                 svnStatus = clink_promptcoroutine(function ()
                     return get_svn_status()
                 end)
@@ -613,21 +653,22 @@ local function svn_prompt_filter()
                 svnStatus = get_svn_status()
             end
 
-            if svnStatus == nil then
+            local color
+            if not svnStatus or svnStatus.error then
                 color = colors.nostatus
-            elseif svnStatus then
+            elseif svnStatus.clean then
                 color = colors.clean
             else
                 color = colors.dirty
             end
 
-            clink.prompt.value = string.gsub(clink.prompt.value, "{svn}", " "..color.."("..verbatim(branch)..")")
+            clink.prompt.value = gsub_plain(clink.prompt.value, "{svn}", " "..color.."("..branch..")")
             return false
         end
     end
 
     -- No svn present or not in svn file
-    clink.prompt.value = string.gsub(clink.prompt.value, "{svn}", "")
+    clink.prompt.value = gsub_plain(clink.prompt.value, "{svn}", "")
     return false
 end
 

vendor/init.bat

@@ -153,7 +153,8 @@ if not "%CMDER_SHELL%" == "cmd" (
     set CMDER_ALIASES=0
 )
 
-:: Pick right version of Clink
+:: Pick the right version of Clink
+:: TODO: Support for ARM
 if "%PROCESSOR_ARCHITECTURE%"=="x86" (
     set clink_architecture=x86
     set architecture_bits=32
@@ -166,7 +167,7 @@ if "%PROCESSOR_ARCHITECTURE%"=="x86" (
 )
 
 if "%CMDER_CLINK%" == "1" (
-    REM TODO: If clink is already injected, goto :CLINK_FINISH
+    REM TODO: Detect if clink is already injected, if so goto :CLINK_FINISH
     goto :INJECT_CLINK
 )
 
@@ -205,8 +206,10 @@ goto :SKIP_CLINK
 
     "%CMDER_ROOT%\vendor\clink\clink_%clink_architecture%.exe" inject --quiet --profile "%CMDER_CONFIG_DIR%" --scripts "%CMDER_ROOT%\vendor"
 
-    if errorlevel 1 (
-        %print_error% "Clink initialization has failed with error code: %errorlevel%"
+    :: Check if a fatal error occurred when trying to inject Clink
+    if errorlevel 2 (
+        REM %print_error% "Clink injection has failed with error code: %errorlevel%"
+        goto :SKIP_CLINK
     )
 
     goto :CLINK_FINISH
@@ -237,8 +240,8 @@ if "%CMDER_CONFIGURED%" GTR "1" (
 :: Prepare for git-for-windows
 
 :: Detect which git.exe version to use
-:: * if the users points as to a specific git, use that
-:: * test if a git is in path and if yes, use that
+:: * if the user points to a specific git, use that
+:: * test if git is in path and if yes, use that
 :: * last, use our vendored git
 :: also check that we have a recent enough version of git by examining the version string
 if defined GIT_INSTALL_ROOT (

vendor/profile.ps1

@@ -28,7 +28,6 @@ if (!$ENV:CMDER_ROOT) {
 # Remove trailing '\'
 $ENV:CMDER_ROOT = ($ENV:CMDER_ROOT).TrimEnd("\")
 
-# Do not load bundled PsGet if a module installer is already available
 # -> recent PowerShell versions include PowerShellGet out of the box
 $moduleInstallerAvailable = [bool](Get-Command -Name 'Install-Module' -ErrorAction SilentlyContinue)
 

vendor/sources.json

@@ -1,22 +1,22 @@
 [
   {
     "name": "git-for-windows",
-    "version": "2.40.0.windows.1",
-    "url": "https://github.com/git-for-windows/git/releases/download/v2.40.0.windows.1/PortableGit-2.40.0-64-bit.7z.exe"
+    "version": "2.41.0.windows.3",
+    "url": "https://github.com/git-for-windows/git/releases/download/v2.41.0.windows.3/PortableGit-2.41.0.3-64-bit.7z.exe"
   },
   {
     "name": "clink",
-    "version": "1.4.23",
-    "url": "https://github.com/chrisant996/clink/releases/download/v1.4.23/clink.1.4.23.5fc3fc.zip"
+    "version": "1.5.1",
+    "url": "https://github.com/chrisant996/clink/releases/download/v1.5.1/clink.1.5.1.1e9e51.zip"
   },
   {
     "name": "conemu-maximus5",
-    "version": "22.12.18",
-    "url": "https://github.com/Maximus5/ConEmu/releases/download/v22.12.18/ConEmuPack.221218.7z"
+    "version": "23.07.24",
+    "url": "https://github.com/Maximus5/ConEmu/releases/download/v23.07.24/ConEmuPack.230724.7z"
   },
   {
     "name": "clink-completions",
-    "version": "0.4.7",
-    "url": "https://github.com/vladimir-kotikov/clink-completions/archive/v0.4.7.zip"
+    "version": "0.4.10",
+    "url": "https://github.com/vladimir-kotikov/clink-completions/archive/v0.4.10.zip"
   }
 ]