Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

1.5.0.0 #96

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

1.5.0.0 #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6542b2f
Make Windows.isValid reject paths ending in a dot or space
ag-eitilt Jul 9, 2021
6e81f43
Add changelog for 1.5.0.0
hasufell Dec 3, 2021
f689550
Bump version to 1.5.0.0
hasufell Dec 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion System/FilePath/Internal.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,6 +927,10 @@ badElements =
-- > Windows: isValid "\\\\\\foo" == False
-- > Windows: isValid "\\\\?\\D:file" == False
-- > Windows: isValid "foo\tbar" == False
-- > Windows: isValid "foo." == False
-- > Windows: isValid "foo " == False
-- > Windows: isValid "foo.\\bar" == False
-- > Windows: isValid "foo \\bar" == False
-- > Windows: isValid "nul .txt" == False
-- > Windows: isValid " nul.txt" == True
isValid :: FilePath -> Bool
Expand All @@ -936,11 +940,15 @@ isValid _ | isPosix = True
isValid path =
not (any isBadCharacter x2) &&
not (any f $ splitDirectories x2) &&
not (any g $ splitDirectories x2) &&
not (isJust (readDriveShare x1) && all isPathSeparator x1) &&
not (isJust (readDriveUNC x1) && not (hasTrailingPathSeparator x1))
where
(x1,x2) = splitDrive path
f x = map toUpper (dropWhileEnd (== ' ') $ dropExtensions x) `elem` badElements
g "." = False
g ".." = False
g x = head (reverse $ '@' : x) `elem` ". "


-- | Take a FilePath and make it valid; does not change already valid FilePaths.
Expand All @@ -952,6 +960,8 @@ isValid path =
-- > Windows: makeValid "c:\\already\\/valid" == "c:\\already\\/valid"
-- > Windows: makeValid "c:\\test:of_test" == "c:\\test_of_test"
-- > Windows: makeValid "test*" == "test_"
-- > Windows: makeValid "test." == "test._"
-- > Windows: makeValid "test " == "test _"
-- > Windows: makeValid "c:\\test\\nul" == "c:\\test\\nul_"
-- > Windows: makeValid "c:\\test\\prn.txt" == "c:\\test\\prn_.txt"
-- > Windows: makeValid "c:\\test/prn.txt" == "c:\\test/prn_.txt"
Expand All @@ -974,10 +984,13 @@ makeValid path
f x = if isBadCharacter x then '_' else x

validElements x = joinPath $ map g $ splitPath x
g x = h a ++ b
g x = i (h a) ++ b
where (a,b) = break isPathSeparator x
h x = if map toUpper (dropWhileEnd (== ' ') a) `elem` badElements then a ++ "_" <.> b else x
where (a,b) = splitExtensions x
i "." = "."
i ".." = ".."
i x = if head (reverse $ '@' : x) `elem` ". " then x ++ "_" else x


-- | Is a path relative, or is it fixed to the root?
Expand Down
15 changes: 14 additions & 1 deletion System/FilePath/Posix.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,6 +927,10 @@ badElements =
-- > Windows: isValid "\\\\\\foo" == False
-- > Windows: isValid "\\\\?\\D:file" == False
-- > Windows: isValid "foo\tbar" == False
-- > Windows: isValid "foo." == False
-- > Windows: isValid "foo " == False
-- > Windows: isValid "foo.\\bar" == False
-- > Windows: isValid "foo \\bar" == False
-- > Windows: isValid "nul .txt" == False
-- > Windows: isValid " nul.txt" == True
isValid :: FilePath -> Bool
Expand All @@ -936,11 +940,15 @@ isValid _ | isPosix = True
isValid path =
not (any isBadCharacter x2) &&
not (any f $ splitDirectories x2) &&
not (any g $ splitDirectories x2) &&
not (isJust (readDriveShare x1) && all isPathSeparator x1) &&
not (isJust (readDriveUNC x1) && not (hasTrailingPathSeparator x1))
where
(x1,x2) = splitDrive path
f x = map toUpper (dropWhileEnd (== ' ') $ dropExtensions x) `elem` badElements
g "." = False
g ".." = False
g x = head (reverse $ '@' : x) `elem` ". "


-- | Take a FilePath and make it valid; does not change already valid FilePaths.
Expand All @@ -952,6 +960,8 @@ isValid path =
-- > Windows: makeValid "c:\\already\\/valid" == "c:\\already\\/valid"
-- > Windows: makeValid "c:\\test:of_test" == "c:\\test_of_test"
-- > Windows: makeValid "test*" == "test_"
-- > Windows: makeValid "test." == "test._"
-- > Windows: makeValid "test " == "test _"
-- > Windows: makeValid "c:\\test\\nul" == "c:\\test\\nul_"
-- > Windows: makeValid "c:\\test\\prn.txt" == "c:\\test\\prn_.txt"
-- > Windows: makeValid "c:\\test/prn.txt" == "c:\\test/prn_.txt"
Expand All @@ -974,10 +984,13 @@ makeValid path
f x = if isBadCharacter x then '_' else x

validElements x = joinPath $ map g $ splitPath x
g x = h a ++ b
g x = i (h a) ++ b
where (a,b) = break isPathSeparator x
h x = if map toUpper (dropWhileEnd (== ' ') a) `elem` badElements then a ++ "_" <.> b else x
where (a,b) = splitExtensions x
i "." = "."
i ".." = ".."
i x = if head (reverse $ '@' : x) `elem` ". " then x ++ "_" else x


-- | Is a path relative, or is it fixed to the root?
Expand Down
15 changes: 14 additions & 1 deletion System/FilePath/Windows.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,6 +927,10 @@ badElements =
-- > Windows: isValid "\\\\\\foo" == False
-- > Windows: isValid "\\\\?\\D:file" == False
-- > Windows: isValid "foo\tbar" == False
-- > Windows: isValid "foo." == False
-- > Windows: isValid "foo " == False
-- > Windows: isValid "foo.\\bar" == False
-- > Windows: isValid "foo \\bar" == False
-- > Windows: isValid "nul .txt" == False
-- > Windows: isValid " nul.txt" == True
isValid :: FilePath -> Bool
Expand All @@ -936,11 +940,15 @@ isValid _ | isPosix = True
isValid path =
not (any isBadCharacter x2) &&
not (any f $ splitDirectories x2) &&
not (any g $ splitDirectories x2) &&
not (isJust (readDriveShare x1) && all isPathSeparator x1) &&
not (isJust (readDriveUNC x1) && not (hasTrailingPathSeparator x1))
where
(x1,x2) = splitDrive path
f x = map toUpper (dropWhileEnd (== ' ') $ dropExtensions x) `elem` badElements
g "." = False
g ".." = False
g x = head (reverse $ '@' : x) `elem` ". "


-- | Take a FilePath and make it valid; does not change already valid FilePaths.
Expand All @@ -952,6 +960,8 @@ isValid path =
-- > Windows: makeValid "c:\\already\\/valid" == "c:\\already\\/valid"
-- > Windows: makeValid "c:\\test:of_test" == "c:\\test_of_test"
-- > Windows: makeValid "test*" == "test_"
-- > Windows: makeValid "test." == "test._"
-- > Windows: makeValid "test " == "test _"
-- > Windows: makeValid "c:\\test\\nul" == "c:\\test\\nul_"
-- > Windows: makeValid "c:\\test\\prn.txt" == "c:\\test\\prn_.txt"
-- > Windows: makeValid "c:\\test/prn.txt" == "c:\\test/prn_.txt"
Expand All @@ -974,10 +984,13 @@ makeValid path
f x = if isBadCharacter x then '_' else x

validElements x = joinPath $ map g $ splitPath x
g x = h a ++ b
g x = i (h a) ++ b
where (a,b) = break isPathSeparator x
h x = if map toUpper (dropWhileEnd (== ' ') a) `elem` badElements then a ++ "_" <.> b else x
where (a,b) = splitExtensions x
i "." = "."
i ".." = ".."
i x = if head (reverse $ '@' : x) `elem` ". " then x ++ "_" else x


-- | Is a path relative, or is it fixed to the root?
Expand Down
5 changes: 5 additions & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

_Note: below all `FilePath` values are unquoted, so `\\` really means two backslashes._

## 1.5.0.0 *WIP*

* breaking changes:
- Make `Windows.isValid` reject paths ending in a dot or space wrt [#94](https://github.com/haskell/filepath/pull/94)

## 1.4.2.2 *WIP*

* Document relation between `joinPath` and `(</>)` wrt [#82](https://github.com/haskell/filepath/issues/82), [#82](https://github.com/haskell/filepath/issues/86)
Expand Down
2 changes: 1 addition & 1 deletion filepath.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cabal-version: 1.18
name: filepath
version: 1.4.2.2
version: 1.5.0.0
-- NOTE: Don't forget to update ./changelog.md
license: BSD3
license-file: LICENSE
Expand Down
6 changes: 6 additions & 0 deletions tests/TestGen.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,10 @@ tests =
,("W.isValid \"\\\\\\\\\\\\foo\" == False", property $ W.isValid "\\\\\\foo" == False)
,("W.isValid \"\\\\\\\\?\\\\D:file\" == False", property $ W.isValid "\\\\?\\D:file" == False)
,("W.isValid \"foo\\tbar\" == False", property $ W.isValid "foo\tbar" == False)
,("W.isValid \"foo.\" == False", property $ W.isValid "foo." == False)
,("W.isValid \"foo \" == False", property $ W.isValid "foo " == False)
,("W.isValid \"foo.\\\\bar\" == False", property $ W.isValid "foo.\\bar" == False)
,("W.isValid \"foo \\\\bar\" == False", property $ W.isValid "foo \\bar" == False)
,("W.isValid \"nul .txt\" == False", property $ W.isValid "nul .txt" == False)
,("W.isValid \" nul.txt\" == True", property $ W.isValid " nul.txt" == True)
,("P.isValid (P.makeValid x)", property $ \(QFilePath x) -> P.isValid (P.makeValid x))
Expand All @@ -440,6 +444,8 @@ tests =
,("W.makeValid \"c:\\\\already\\\\/valid\" == \"c:\\\\already\\\\/valid\"", property $ W.makeValid "c:\\already\\/valid" == "c:\\already\\/valid")
,("W.makeValid \"c:\\\\test:of_test\" == \"c:\\\\test_of_test\"", property $ W.makeValid "c:\\test:of_test" == "c:\\test_of_test")
,("W.makeValid \"test*\" == \"test_\"", property $ W.makeValid "test*" == "test_")
,("W.makeValid \"test.\" == \"test._\"", property $ W.makeValid "test." == "test._")
,("W.makeValid \"test \" == \"test _\"", property $ W.makeValid "test " == "test _")
,("W.makeValid \"c:\\\\test\\\\nul\" == \"c:\\\\test\\\\nul_\"", property $ W.makeValid "c:\\test\\nul" == "c:\\test\\nul_")
,("W.makeValid \"c:\\\\test\\\\prn.txt\" == \"c:\\\\test\\\\prn_.txt\"", property $ W.makeValid "c:\\test\\prn.txt" == "c:\\test\\prn_.txt")
,("W.makeValid \"c:\\\\test/prn.txt\" == \"c:\\\\test/prn_.txt\"", property $ W.makeValid "c:\\test/prn.txt" == "c:\\test/prn_.txt")
Expand Down