Skip to content

Improve the parsing of HostPorts received from MongoDB to work properly with with IPv6 addresses #21

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 44 additions & 10 deletions Database/MongoDB/Connection.hs
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ import Database.MongoDB.Internal.Protocol (Pipe, newPipe)
import System.IO.Pipeline (IOE, close, isClosed)
import Control.Exception as E (try)
import Network (HostName, PortID(..), connectTo)
import Text.ParserCombinators.Parsec as T (parse, many1, letter, digit, char, eof, spaces, try, (<|>))
import Text.ParserCombinators.Parsec as T (ParseError, parse, many, many1, letter, digit, hexDigit, char, string, eof, spaces, try, (<|>))
import Control.Monad.Identity (runIdentity)
import Control.Monad.Error (ErrorT(..), lift, throwError)
import Control.Concurrent.MVar.Lifted
import Control.Monad (forM_)
import Control.Monad (forM_, liftM, liftM2)
import Control.Applicative ((<$>))
import Data.UString (UString, unpack)
import Data.Bson as D (Document, lookup, at, (=:))
Expand Down Expand Up @@ -71,15 +71,49 @@ readHostPortM :: (Monad m) => String -> m Host
-- TODO: handle Service and UnixSocket port
readHostPortM = either (fail . show) return . parse parser "readHostPort" where
hostname = many1 (letter <|> digit <|> char '-' <|> char '.')
parser = do
spaces
parser = spaces >> (T.try simpleParser <|> ipv6Parser)
simpleParser = do
h <- hostname
T.try (spaces >> eof >> return (host h)) <|> do
_ <- char ':'
port :: Int <- read <$> many1 digit
spaces >> eof
return $ Host h (PortNumber $ fromIntegral port)

T.try (spaces >> eof >> return (host h)) <|> do

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should fix the indentation to be consistent with the rest of the codebase.

_ <- char ':'
port :: Int <- read <$> many1 digit
spaces >> eof
return $ Host h (PortNumber $ fromIntegral port)
breakLast :: (a -> Bool) -> [a] -> ([a], [a])
breakLast f = either (\l -> (l, [])) id . foldr (\e s -> either (\l -> if f e then Right ([], l) else Left (e:l)) (\(a, b) -> Right (e:a, b)) s) (Left [])

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good example of unreadable Haskell, please stick to 80 chars, as suggested by haskell style guide.

ipv6Parser = do
fullHost <- liftM2 (++) (many hexDigit) (liftM2 (:) (char ':') (many1 (hexDigit <|> (char ':'))))

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not use Applicative here? you already use Alternative in the last part.

eof
let
(splitHost, splitPort) = breakLast (==':') fullHost
splitPortParsed :: Either ParseError Int
splitPortParsed = parse (liftM read (many1 digit)) "hostPort port" splitPort
splitHostParsed = parse ipv6HostTest "hostPort host" splitHost
fullHostParsed = parse ipv6HostTest "hostPort host" fullHost
case (splitHostParsed, splitPortParsed, fullHostParsed) of
-- Resolve the ambiguous cases (e.g. ::1:1234) as host:port
(Right _, Right p, _) -> return $ Host splitHost (PortNumber $ fromIntegral p)
(_, _, Right _) -> return $ host fullHost
_ -> fail "HostPort specification contains more than one :, but is invalid as an IPv6 address or IPv6 address:port"
ipv6HostTest = ((T.try (string "::") >> ipv6HostTest' True True 7) <|>
ipv6HostTest' False False 8) >> eof

ipv6HostTest' hadDouble True v = eof <|> ipv6HostTest' hadDouble False v
ipv6HostTest' hadDouble False v =
(do
many1 hexDigit
if v == 1

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like you can merge those ifs:

if v == 1 || hadDouble 
    then eof
    else do ...

then eof
else
(if hadDouble then eof else do
T.try (string "::")
ipv6HostTest' True True (v-1)
) <|>
(do
char ':'
ipv6HostTest' hadDouble False (v-1)
)
)
readHostPort :: String -> Host
-- ^ Read string \"hostname:port\" as @Host hostname (PortNumber port)@ or \"hostname\" as @host hostname@ (default port). Error if string does not match either syntax.
readHostPort = runIdentity . readHostPortM
Expand Down
24 changes: 24 additions & 0 deletions tests/TestReadHostPort.hs
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import Database.MongoDB.Connection
import System.Exit
import Control.Monad

testList = [
("Simple host", readHostPort "host" == Host "host" (PortNumber 27017)),
("Simple host with port", readHostPort "host:123" == Host "host" (PortNumber 123)),
("Pathological ::1:1234 case", readHostPort "::1:1234" == Host "::1" (PortNumber 1234)),
("Full IPv6 with port", readHostPort "1:2:3:4:5:6:7:8:1234" == Host "1:2:3:4:5:6:7:8" (PortNumber 1234)),
("Full IPv6 without port", readHostPort "1:2:3:4:5:6:7:8" == Host "1:2:3:4:5:6:7:8" (PortNumber 27017)),
("Partial IPv6 with port", readHostPort "1:2:3::4:12" == Host "1:2:3::4" (PortNumber 12)),
("Partial IPv6 with hex at end", readHostPort "1:2:3::4:a" == Host "1:2:3::4:a" (PortNumber 27017))
]
main =
let
failedTests = filter (not . snd) testList
in
if null failedTests then
putStrLn "All tests passed"
else
do
putStrLn "The following tests failed:"
forM_ failedTests $ \(descr, _) -> putStrLn $ " * " ++ descr
exitWith (ExitFailure 1)