-- |
-- Module    : Codec.Binary.Base32Hex
-- Copyright : (c) 2007 Magnus Therning
-- License   : BSD3
--
-- Implemented as specified in RFC 4648
-- (<http://tools.ietf.org/html/rfc4648>).
--
-- Further documentation and information can be found at
-- <http://www.haskell.org/haskellwiki/Library/Data_encoding>.
module Codec.Binary.Base32Hex
    ( EncIncData(..)
    , EncIncRes(..)
    , encodeInc
    , encode
    , DecIncData(..)
    , DecIncRes(..)
    , decodeInc
    , decode
    , chop
    , unchop
    ) where

import Codec.Binary.Util

import Control.Monad
import Data.Array
import Data.Bits
import Data.Maybe
import Data.Word
import qualified Data.Map as M

import qualified Codec.Binary.Base32 as Base32

-- {{{1 enc/dec map
_encMap :: [(Word8, Char)]
_encMap =
    [ (Word8
0, Char
'0'), (Word8
1, Char
'1'), (Word8
2, Char
'2'), (Word8
3, Char
'3'), (Word8
4, Char
'4')
    , (Word8
5, Char
'5'), (Word8
6, Char
'6'), (Word8
7, Char
'7'), (Word8
8, Char
'8'), (Word8
9, Char
'9')
    , (Word8
10, Char
'A'), (Word8
11, Char
'B'), (Word8
12, Char
'C'), (Word8
13, Char
'D'), (Word8
14, Char
'E')
    , (Word8
15, Char
'F'), (Word8
16, Char
'G'), (Word8
17, Char
'H'), (Word8
18, Char
'I'), (Word8
19, Char
'J')
    , (Word8
20, Char
'K'), (Word8
21, Char
'L'), (Word8
22, Char
'M'), (Word8
23, Char
'N'), (Word8
24, Char
'O')
    , (Word8
25, Char
'P'), (Word8
26, Char
'Q'), (Word8
27, Char
'R'), (Word8
28, Char
'S'), (Word8
29, Char
'T')
    , (Word8
30, Char
'U'), (Word8
31, Char
'V') ]

-- {{{1 encodeArray
encodeArray :: Array Word8 Char
encodeArray :: Array Word8 Char
encodeArray = (Word8, Word8) -> [(Word8, Char)] -> Array Word8 Char
forall i e. Ix i => (i, i) -> [(i, e)] -> Array i e
array (Word8
0, Word8
32) [(Word8, Char)]
_encMap

-- {{{1 decodeMap
decodeMap :: M.Map Char Word8
decodeMap :: Map Char Word8
decodeMap = [(Char, Word8)] -> Map Char Word8
forall k a. Ord k => [(k, a)] -> Map k a
M.fromList [((Word8, Char) -> Char
forall a b. (a, b) -> b
snd (Word8, Char)
i, (Word8, Char) -> Word8
forall a b. (a, b) -> a
fst (Word8, Char)
i) | (Word8, Char)
i <- [(Word8, Char)]
_encMap]

-- {{{1 encode
-- | Incremental encoder function.
encodeInc :: EncIncData -> EncIncRes String
encodeInc :: EncIncData -> EncIncRes String
encodeInc EncIncData
e = [Word8] -> EncIncData -> EncIncRes String
eI [] EncIncData
e
    where
        enc5 :: [Word8] -> String
enc5 [Word8
o1, Word8
o2, Word8
o3, Word8
o4, Word8
o5] = (Word8 -> Char) -> [Word8] -> String
forall a b. (a -> b) -> [a] -> [b]
map (Array Word8 Char
encodeArray Array Word8 Char -> Word8 -> Char
forall i e. Ix i => Array i e -> i -> e
!) [Word8
i1, Word8
i2, Word8
i3, Word8
i4, Word8
i5, Word8
i6, Word8
i7, Word8
i8]
            where
                i1 :: Word8
i1 = Word8
o1 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
3
                i2 :: Word8
i2 = (Word8
o1 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
2 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
o2 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
6) Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.&. Word8
0x1f
                i3 :: Word8
i3 = Word8
o2 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
1 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.&. Word8
0x1f
                i4 :: Word8
i4 = (Word8
o2 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
4 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
o3 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
4) Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.&. Word8
0x1f
                i5 :: Word8
i5 = (Word8
o3 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
1 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
o4 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
7) Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.&. Word8
0x1f
                i6 :: Word8
i6 = Word8
o4 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
2 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.&. Word8
0x1f
                i7 :: Word8
i7 = (Word8
o4 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
3 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
o5 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
5) Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.&. Word8
0x1f
                i8 :: Word8
i8 = Word8
o5 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.&. Word8
0x1f

        eI :: [Word8] -> EncIncData -> EncIncRes String
eI [] EncIncData
EDone = String -> EncIncRes String
forall i. i -> EncIncRes i
EFinal []
        eI [Word8
o1] EncIncData
EDone = String -> EncIncRes String
forall i. i -> EncIncRes i
EFinal (Int -> String -> String
forall a. Int -> [a] -> [a]
take Int
2 String
cs String -> String -> String
forall a. [a] -> [a] -> [a]
++ String
"======")
            where
                cs :: String
cs = [Word8] -> String
enc5 [Word8
o1, Word8
0, Word8
0, Word8
0, Word8
0]
        eI [Word8
o1, Word8
o2] EncIncData
EDone = String -> EncIncRes String
forall i. i -> EncIncRes i
EFinal (Int -> String -> String
forall a. Int -> [a] -> [a]
take Int
4 String
cs String -> String -> String
forall a. [a] -> [a] -> [a]
++ String
"====")
            where
                cs :: String
cs = [Word8] -> String
enc5 [Word8
o1, Word8
o2, Word8
0, Word8
0, Word8
0]
        eI [Word8
o1, Word8
o2, Word8
o3] EncIncData
EDone = String -> EncIncRes String
forall i. i -> EncIncRes i
EFinal (Int -> String -> String
forall a. Int -> [a] -> [a]
take Int
5 String
cs String -> String -> String
forall a. [a] -> [a] -> [a]
++ String
"===")
            where
                cs :: String
cs = [Word8] -> String
enc5 [Word8
o1, Word8
o2, Word8
o3, Word8
0, Word8
0]
        eI [Word8
o1, Word8
o2, Word8
o3, Word8
o4] EncIncData
EDone = String -> EncIncRes String
forall i. i -> EncIncRes i
EFinal (Int -> String -> String
forall a. Int -> [a] -> [a]
take Int
7 String
cs String -> String -> String
forall a. [a] -> [a] -> [a]
++ String
"=")
            where
                cs :: String
cs = [Word8] -> String
enc5 [Word8
o1, Word8
o2, Word8
o3, Word8
o4, Word8
0]
        eI [Word8]
lo (EChunk [Word8]
bs) = String -> [Word8] -> EncIncRes String
doEnc [] ([Word8]
lo [Word8] -> [Word8] -> [Word8]
forall a. [a] -> [a] -> [a]
++ [Word8]
bs)
            where
                doEnc :: String -> [Word8] -> EncIncRes String
doEnc String
acc (Word8
o1:Word8
o2:Word8
o3:Word8
o4:Word8
o5:[Word8]
os) = String -> [Word8] -> EncIncRes String
doEnc (String
acc String -> String -> String
forall a. [a] -> [a] -> [a]
++ [Word8] -> String
enc5 [Word8
o1, Word8
o2, Word8
o3, Word8
o4, Word8
o5]) [Word8]
os
                doEnc String
acc [Word8]
os = String -> (EncIncData -> EncIncRes String) -> EncIncRes String
forall i. i -> (EncIncData -> EncIncRes i) -> EncIncRes i
EPart String
acc ([Word8] -> EncIncData -> EncIncRes String
eI [Word8]
os)

-- | Encode data.
encode :: [Word8] -> String
encode :: [Word8] -> String
encode = (EncIncData -> EncIncRes String) -> [Word8] -> String
forall {a}. (EncIncData -> EncIncRes [a]) -> [Word8] -> [a]
encoder EncIncData -> EncIncRes String
encodeInc

-- {{{1 decode
-- | Incremental decoder function.
decodeInc :: DecIncData String -> DecIncRes String
decodeInc :: DecIncData String -> DecIncRes String
decodeInc DecIncData String
d = String -> DecIncData String -> DecIncRes String
dI [] DecIncData String
d
    where
        dec8 :: String -> Maybe [Word8]
dec8 String
cs = let
                ds :: [Maybe Word8]
ds = (Char -> Maybe Word8) -> String -> [Maybe Word8]
forall a b. (a -> b) -> [a] -> [b]
map ((Char -> Map Char Word8 -> Maybe Word8)
-> Map Char Word8 -> Char -> Maybe Word8
forall a b c. (a -> b -> c) -> b -> a -> c
flip Char -> Map Char Word8 -> Maybe Word8
forall k a. Ord k => k -> Map k a -> Maybe a
M.lookup Map Char Word8
decodeMap) String
cs
                es :: [Word8]
es@[Word8
e1, Word8
e2, Word8
e3, Word8
e4, Word8
e5, Word8
e6, Word8
e7, Word8
e8] = (Maybe Word8 -> Word8) -> [Maybe Word8] -> [Word8]
forall a b. (a -> b) -> [a] -> [b]
map Maybe Word8 -> Word8
forall a. HasCallStack => Maybe a -> a
fromJust [Maybe Word8]
ds
                o1 :: Word8
o1 = Word8
e1 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
3 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
e2 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
2
                o2 :: Word8
o2 = Word8
e2 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
6 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
e3 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
1 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
e4 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
4
                o3 :: Word8
o3 = Word8
e4 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
4 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
e5 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
1
                o4 :: Word8
o4 = Word8
e5 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
7 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
e6 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
2 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
e7 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftR` Int
3
                o5 :: Word8
o5 = Word8
e7 Word8 -> Int -> Word8
forall a. Bits a => a -> Int -> a
`shiftL` Int
5 Word8 -> Word8 -> Word8
forall a. Bits a => a -> a -> a
.|. Word8
e8
                allJust :: [Maybe a] -> Bool
allJust = [Bool] -> Bool
forall (t :: * -> *). Foldable t => t Bool -> Bool
and ([Bool] -> Bool) -> ([Maybe a] -> [Bool]) -> [Maybe a] -> Bool
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Maybe a -> Bool) -> [Maybe a] -> [Bool]
forall a b. (a -> b) -> [a] -> [b]
map Maybe a -> Bool
forall a. Maybe a -> Bool
isJust
            in if [Maybe Word8] -> Bool
forall {a}. [Maybe a] -> Bool
allJust [Maybe Word8]
ds
                then [Word8] -> Maybe [Word8]
forall a. a -> Maybe a
Just [Word8
o1, Word8
o2, Word8
o3, Word8
o4, Word8
o5]
                else Maybe [Word8]
forall a. Maybe a
Nothing

        dI :: String -> DecIncData String -> DecIncRes String
dI [] DecIncData String
DDone = [Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFinal [] []
        dI String
lo DecIncData String
DDone = [Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFail [] String
lo
        dI String
lo (DChunk String
s) = [Word8] -> String -> DecIncRes String
doDec [] (String
lo String -> String -> String
forall a. [a] -> [a] -> [a]
++ String
s)
            where
                doDec :: [Word8] -> String -> DecIncRes String
doDec [Word8]
acc s :: String
s@(Char
c1:Char
c2:Char
'=':Char
'=':Char
'=':Char
'=':Char
'=':Char
'=':String
cs) = DecIncRes String
-> ([Word8] -> DecIncRes String)
-> Maybe [Word8]
-> DecIncRes String
forall b a. b -> (a -> b) -> Maybe a -> b
maybe
                    ([Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFail [Word8]
acc String
s)
                    (\ [Word8]
bs -> [Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFinal ([Word8]
acc [Word8] -> [Word8] -> [Word8]
forall a. [a] -> [a] -> [a]
++ Int -> [Word8] -> [Word8]
forall a. Int -> [a] -> [a]
take Int
1 [Word8]
bs) String
cs)
                    (String -> Maybe [Word8]
dec8 [Char
c1, Char
c2, Char
'A', Char
'A', Char
'A', Char
'A', Char
'A', Char
'A'])
                doDec [Word8]
acc s :: String
s@(Char
c1:Char
c2:Char
c3:Char
c4:Char
'=':Char
'=':Char
'=':Char
'=':String
cs) = DecIncRes String
-> ([Word8] -> DecIncRes String)
-> Maybe [Word8]
-> DecIncRes String
forall b a. b -> (a -> b) -> Maybe a -> b
maybe
                    ([Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFail [Word8]
acc String
s)
                    (\ [Word8]
bs -> [Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFinal ([Word8]
acc [Word8] -> [Word8] -> [Word8]
forall a. [a] -> [a] -> [a]
++ Int -> [Word8] -> [Word8]
forall a. Int -> [a] -> [a]
take Int
2 [Word8]
bs) String
cs)
                    (String -> Maybe [Word8]
dec8 [Char
c1, Char
c2, Char
c3, Char
c4, Char
'A', Char
'A', Char
'A', Char
'A'])
                doDec [Word8]
acc s :: String
s@(Char
c1:Char
c2:Char
c3:Char
c4:Char
c5:Char
'=':Char
'=':Char
'=':String
cs) = DecIncRes String
-> ([Word8] -> DecIncRes String)
-> Maybe [Word8]
-> DecIncRes String
forall b a. b -> (a -> b) -> Maybe a -> b
maybe
                    ([Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFail [Word8]
acc String
s)
                    (\ [Word8]
bs -> [Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFinal ([Word8]
acc [Word8] -> [Word8] -> [Word8]
forall a. [a] -> [a] -> [a]
++ Int -> [Word8] -> [Word8]
forall a. Int -> [a] -> [a]
take Int
3 [Word8]
bs) String
cs)
                    (String -> Maybe [Word8]
dec8 [Char
c1, Char
c2, Char
c3, Char
c4, Char
c5, Char
'A', Char
'A', Char
'A'])
                doDec [Word8]
acc s :: String
s@(Char
c1:Char
c2:Char
c3:Char
c4:Char
c5:Char
c6:Char
c7:Char
'=':String
cs) = DecIncRes String
-> ([Word8] -> DecIncRes String)
-> Maybe [Word8]
-> DecIncRes String
forall b a. b -> (a -> b) -> Maybe a -> b
maybe
                    ([Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFail [Word8]
acc String
s)
                    (\ [Word8]
bs -> [Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFinal ([Word8]
acc [Word8] -> [Word8] -> [Word8]
forall a. [a] -> [a] -> [a]
++ Int -> [Word8] -> [Word8]
forall a. Int -> [a] -> [a]
take Int
4 [Word8]
bs) String
cs)
                    (String -> Maybe [Word8]
dec8 [Char
c1, Char
c2, Char
c3, Char
c4, Char
c5, Char
c6, Char
c7, Char
'A'])
                doDec [Word8]
acc s :: String
s@(Char
c1:Char
c2:Char
c3:Char
c4:Char
c5:Char
c6:Char
c7:Char
c8:String
cs) = DecIncRes String
-> ([Word8] -> DecIncRes String)
-> Maybe [Word8]
-> DecIncRes String
forall b a. b -> (a -> b) -> Maybe a -> b
maybe
                    ([Word8] -> String -> DecIncRes String
forall i. [Word8] -> i -> DecIncRes i
DFail [Word8]
acc String
s)
                    (\ [Word8]
bs -> [Word8] -> String -> DecIncRes String
doDec ([Word8]
acc [Word8] -> [Word8] -> [Word8]
forall a. [a] -> [a] -> [a]
++ [Word8]
bs) String
cs)
                    (String -> Maybe [Word8]
dec8 [Char
c1, Char
c2, Char
c3, Char
c4, Char
c5, Char
c6, Char
c7, Char
c8])
                doDec [Word8]
acc String
s = [Word8]
-> (DecIncData String -> DecIncRes String) -> DecIncRes String
forall i. [Word8] -> (DecIncData i -> DecIncRes i) -> DecIncRes i
DPart [Word8]
acc (String -> DecIncData String -> DecIncRes String
dI String
s)

-- | Decode data.
decode :: String
    -> Maybe [Word8]
decode :: String -> Maybe [Word8]
decode = (DecIncData String -> DecIncRes String) -> String -> Maybe [Word8]
forall i. (DecIncData i -> DecIncRes i) -> i -> Maybe [Word8]
decoder DecIncData String -> DecIncRes String
decodeInc

-- {{{1 chop
-- | Chop up a string in parts.
--
--   See 'Base32.chop' in "Base32" for more details.
chop :: Int     -- ^ length of individual lines
    -> String
    -> [String]
chop :: Int -> String -> [String]
chop = Int -> String -> [String]
Base32.chop

-- {{{1 unchop
-- | Concatenate the strings into one long string.
--
--   See 'Base32.unchop' in "Codec.Binary.Base32" for more details.
unchop :: [String]
    -> String
unchop :: [String] -> String
unchop = [String] -> String
Base32.unchop