fix:add,import: autocreate missing journal files again (but later) [#2514]

This restores the pre-1.50.3 behaviour of add and import, which once
again auto-create a missing file (specified by -f or LEDGER_FILE or
the builtin default path) rather than giving an error.
This fixes #2514 and refines the fix for [#2485].

There's also an improvement: they no longer create it unconditionally at the start;
they create lazily, when they have data to write.

Hledger.Read:
defaultExistingJournalPath
defaultExistingJournalPathSafely
readPossibleJournalFile

Hledger.Cli.Utils:
withPossibleJournal

hledger-lib/Hledger/Read.hs

@@ -93,6 +93,8 @@ module Hledger.Read (
   defaultJournalWithSafely,
   defaultJournalPath,
   defaultJournalPathSafely,
+  defaultExistingJournalPath,
+  defaultExistingJournalPathSafely,
   requireJournalFileExists,
   ensureJournalFileExists,
   journalEnvVar,
@@ -103,6 +105,7 @@ module Hledger.Read (
   runExceptT,
   readJournal,
   readJournalFile,
+  readPossibleJournalFile,
   readJournalFiles,
   readJournalFilesAndLatestDates,
 
@@ -153,21 +156,18 @@ import System.Environment (getEnv)
 import System.FilePath ((<.>), (</>), splitDirectories, splitFileName, takeFileName)
 import System.Info (os)
 import System.IO (Handle, hPutStrLn, stderr)
+import Text.Printf (printf)
 
 import Hledger.Data.Dates (getCurrentDay, parsedate, showDate)
+import Hledger.Data.Journal (journalNumberTransactions, nulljournal)
+import Hledger.Data.JournalChecks (journalStrictChecks)
 import Hledger.Data.Types
 import Hledger.Read.Common
 import Hledger.Read.InputOptions
 import Hledger.Read.JournalReader as JournalReader
 import Hledger.Read.CsvReader (tests_CsvReader)
 import Hledger.Read.RulesReader (tests_RulesReader)
--- import Hledger.Read.TimedotReader (tests_TimedotReader)
--- import Hledger.Read.TimeclockReader (tests_TimeclockReader)
 import Hledger.Utils
-import Prelude hiding (getContents, writeFile)
-import Hledger.Data.JournalChecks (journalStrictChecks)
-import Text.Printf (printf)
-import Hledger.Data.Journal (journalNumberTransactions)
 
 --- ** doctest setup
 -- $setup
@@ -202,34 +202,39 @@ defaultJournalWithSafely iopts = (do
     ,C.Handler (\(e :: C.IOException) -> return $ Left $ show e)
     ]
 
--- | Get the default journal file path, and check that it exists; or raise an error.
+-- | Get the default journal file path - either $LEDGER_FILE or $HOME/.hledger.journal file.
 --
 -- This looks for the LEDGER_FILE environment variable, like Ledger.
--- The value should be a file path; ~ at the start is supported, meaning user's home directory.
+-- The value should be a file path, possibly with ~ at the start meaning the current user's home directory.
--- The value can also be a glob pattern, for convenience; if so we consider only the first matched file.
+-- Or the value can be a glob pattern (containing *, ?, [ or {) ), in which case the first matching file path is used.
--- If no such file exists, an error is raised.
+-- When it's a glob pattern that matches no existing files, an error is raised.
 --
--- If LEDGER_FILE is unset or set to the empty string, we return a default file path:
+-- If LEDGER_FILE is unset or set to the empty string, this returns a default file path:
--- @.hledger.journal@ in the user's home directory.
+-- @.hledger.journal@ in the user's home directory,
--- Or if we can't find the user's home directory, in the current directory.
+-- or if we can't find the user's home directory, in the current directory.
--- If this default file doesn't exist, an error is raised.
+--
+-- The referenced file can be nonexistent.
 --
 defaultJournalPath :: IO String
 defaultJournalPath = do
-  ledgerfile <- getEnv journalEnvVar `C.catch` (\(_::C.IOException) -> return "")
+  p <- getEnv journalEnvVar `C.catch` (\(_::C.IOException) -> return "")
-  if null ledgerfile
+  if null p
   then do
     homedir <- fromMaybe "" <$> getHomeSafe
     let defaultfile = homedir </> journalDefaultFilename
-    exists <- doesFileExist defaultfile
+    return defaultfile
-    if exists then return defaultfile
-    -- else error' $ "LEDGER_FILE is unset and \"" <> defaultfile <> "\" was not found"
-    else error' $ "neither LEDGER_FILE nor \"" <> defaultfile <> "\" was found"
   else do
-    mf <- headMay <$> expandGlob "." ledgerfile `C.catch` (\(_::C.IOException) -> return [])
+    -- If it contains glob metacharacters, expand the pattern and error if no matches.
-    case mf of
+    -- Otherwise just expand ~ and return the path, even if the file doesn't exist yet.
-      Just f -> return f
+    let hasGlobChars = any (`elem` p) ("*?[{" :: [Char])
-      Nothing -> error' $ "LEDGER_FILE points to nonexistent \"" <> ledgerfile <> "\""
+    if hasGlobChars
+      then do
+        mf <- headMay <$> expandGlob "." p `C.catch` (\(_::C.IOException) -> return [])
+        case mf of
+          Just f -> return f
+          Nothing -> error' $ "LEDGER_FILE glob pattern \"" <> p <> "\" matched no files"
+      else
+        expandPath "." p
 
 -- | Like defaultJournalPath, but return an error message instead of raising an error.
 defaultJournalPathSafely :: IO (Either String String)
@@ -242,6 +247,24 @@ defaultJournalPathSafely = (do
     ,C.Handler (\(e :: C.IOException) -> return $ Left $ show e)
     ]
 
+-- | Like defaultJournalPath, but also checks that the file exists, and raises an error if it doesn't.
+defaultExistingJournalPath :: IO String
+defaultExistingJournalPath = do
+  f <- defaultJournalPath
+  requireJournalFileExists f
+  return f
+
+-- | Like defaultExistingJournalPath, but returns an error message instead of raising an error.
+defaultExistingJournalPathSafely :: IO (Either String String)
+defaultExistingJournalPathSafely = (do
+  f <- defaultExistingJournalPath
+  return $ Right f
+  )
+  `C.catches` [
+     C.Handler (\(e :: C.ErrorCall)   -> return $ Left $ show e)
+    ,C.Handler (\(e :: C.IOException) -> return $ Left $ show e)
+    ]
+
 -- | @readJournal iopts mfile txt@
 --
 -- Read a Journal from some handle, with strict checks if enabled,
@@ -322,6 +345,20 @@ readJournalFileAndLatestDates iopts prefixedfile = do
     else
       return (j, Nothing)
 
+-- | Like readJournalFile, but if the file does not exist, returns an empty journal
+-- with the file path set. This is useful for commands like add and import that
+-- need to work with a potentially non-existent journal file.
+readPossibleJournalFile :: InputOpts -> PrefixedFilePath -> ExceptT String IO Journal
+readPossibleJournalFile iopts prefixedfile = do
+  let (_, f) = splitReaderPrefix prefixedfile
+  if f == "-"
+    then readJournalFile iopts prefixedfile
+    else do
+      exists <- liftIO $ doesFileExist f
+      if exists
+        then readJournalFile iopts prefixedfile
+        else return $ nulljournal{jfiles = [(f, "")]}
+
 -- | Read a Journal from each specified file path (using @readJournalFile@)
 -- and combine them into one; or return the first error message.
 --

hledger/Hledger/Cli.hs

@@ -107,7 +107,6 @@ import Data.Either (isRight)
 import Data.Function ((&))
 import Data.Functor ((<&>))
 import Data.List
-import Data.List.NonEmpty qualified as NE
 import Data.Maybe (isJust, fromMaybe, fromJust)
 import Data.Text (pack, Text)
 import Data.Time.Clock.POSIX (getPOSIXTime)
@@ -426,10 +425,9 @@ main = handleExit $ withGhcDebug' $ do
         | cmdname `elem` ["commands","demo","help","setup","test"] ->
           cmdaction opts (ignoredjournal cmdname)
 
-        -- 6.4.3. builtin command which should create the journal if missing - do that and run it
+        -- 6.4.3. builtin command which can work with a non-existent journal
-        | cmdname `elem` ["add","import"] -> do
+        | cmdname `elem` ["add","import"] ->
-          ensureJournalFileExists . NE.head =<< journalFilePathFromOpts opts
+          withPossibleJournal opts (cmdaction opts)
-          withJournal opts (cmdaction opts)
 
         -- 6.4.4. "run" and "repl" need findBuiltinCommands passed to it to avoid circular dependency in the code
         | cmdname == "run"  -> Hledger.Cli.Commands.Run.run Nothing findBuiltinCommand addons opts

hledger/Hledger/Cli/CliOptions.hs

@@ -741,7 +741,7 @@ journalFilePathFromOpts opts = do
   case mbpaths of
     Just paths -> return paths
     Nothing -> do
-      f <- defaultJournalPath
+      f <- defaultExistingJournalPath
       return $ NE.fromList [f]
 
 -- | Like journalFilePathFromOpts, but does not use defaultJournalPath

hledger/Hledger/Cli/Commands/Add.hs

@@ -523,7 +523,9 @@ journalAddTransaction j@Journal{jtxns=ts} opts t = do
 appendToJournalFileOrStdout :: FilePath -> Text -> IO ()
 appendToJournalFileOrStdout f s
   | f == "-"  = T.putStr s'
-  | otherwise = appendFile f $ T.unpack s'
+  | otherwise = do
+      ensureJournalFileExists f
+      appendFile f $ T.unpack s'
   where s' = "\n" <> ensureOneNewlineTerminated s
 
 -- | Replace a string's 0 or more terminating newlines with exactly one.

hledger/Hledger/Cli/Utils.hs

@@ -12,6 +12,7 @@ module Hledger.Cli.Utils
      unsupportedOutputFormatError,
      withJournal,
      withJournalDo,
+     withPossibleJournal,
      writeOutput,
      writeOutputLazyText,
      journalTransform,
@@ -30,7 +31,7 @@ where
 import Control.Monad.Except (ExceptT)
 import Control.Monad.IO.Class (liftIO)
 import Data.List
-import Data.List.NonEmpty qualified as NE (toList)
+import Data.List.NonEmpty qualified as NE (head, toList)
 import Data.Maybe
 import Data.Text qualified as T
 import Data.Text.IO qualified as T
@@ -78,6 +79,18 @@ withJournal opts cmd = do
 {-# DEPRECATED withJournalDo "renamed, please use withJournal instead" #-}
 withJournalDo = withJournal
 
+-- | Like withJournal, but if the journal file does not exist, provides an empty
+-- journal with the file path set. This is useful for commands like add and import
+-- that need to work with a potentially non-existent journal file.
+withPossibleJournal :: CliOpts -> (Journal -> IO a) -> IO a
+withPossibleJournal opts cmd = do
+  journalpaths <- journalFilePathFromOptsNoDefault opts
+  f <- case journalpaths of
+    Just paths -> return $ NE.head paths
+    Nothing -> defaultJournalPath
+  j <- runExceptT $ journalTransform opts <$> readPossibleJournalFile (inputopts_ opts) f
+  either error' cmd j  -- PARTIAL:
+
 -- | Apply some journal transformations, if enabled by options, that should happen late.
 -- These happen after parsing, finalising the journal, strict checks, and .latest filtering/updating,
 -- but before report calculation. They are, in processing order: