From 014db152d922db00cfec29dbee912c3eda64c812 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Wed, 26 Jun 2019 18:19:53 +0100
Subject: [PATCH] add, web: disallow unsafe trailing dot paths on windows (fix
 #1056)

On Windows, ensureJournalFileExists now rejects file paths
containing any problematic trailing dots, to prevent data loss.
This affects the add command and hledger-web's add form.
---
 hledger-lib/Hledger/Read.hs | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/hledger-lib/Hledger/Read.hs b/hledger-lib/Hledger/Read.hs
index 2536f0c85..a12bdafa3 100644
--- a/hledger-lib/Hledger/Read.hs
+++ b/hledger-lib/Hledger/Read.hs
@@ -48,6 +48,7 @@ import System.Directory (doesFileExist, getHomeDirectory)
 import System.Environment (getEnv)
 import System.Exit (exitFailure)
 import System.FilePath
+import System.Info (os)
 import System.IO
 import Text.Printf
 
@@ -128,8 +129,13 @@ requireJournalFileExists f = do
     exitFailure
 
 -- | Ensure there is a journal file at the given path, creating an empty one if needed.
+-- On Windows, also ensure that the path contains no trailing dots
+-- which could cause data loss (see 'isWindowsUnsafeDotPath').
 ensureJournalFileExists :: FilePath -> IO ()
 ensureJournalFileExists f = do
+  when (os/="mingw32" && isWindowsUnsafeDotPath f) $ do
+    hPrintf stderr "Part of file path %s\n ends with a dot, which is unsafe on Windows; please use a different path.\n" (show f)
+    exitFailure
   exists <- doesFileExist f
   when (not exists) $ do
     hPrintf stderr "Creating hledger journal file %s.\n" f
@@ -137,6 +143,15 @@ ensureJournalFileExists f = do
     -- we currently require unix line endings on all platforms.
     newJournalContent >>= writeFile f
 
+-- | Does any part of this path contain non-. characters and end with a . ?
+-- Such paths are not safe to use on Windows (cf #1056).
+isWindowsUnsafeDotPath :: FilePath -> Bool
+isWindowsUnsafeDotPath =
+  not . null .
+  filter (not . all (=='.')) .
+  filter ((=='.').last) .
+  splitDirectories
+
 -- | Give the content for a new auto-created journal file.
 newJournalContent :: IO String
 newJournalContent = do