-- | Helper functions to generate the random part of an ULID
-- either with PRNGs or TRNGs.

{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric #-}
module Data.ULID.Random (
    ULIDRandom,
    mkCryptoULIDRandom,
    mkULIDRandom,
    getULIDRandom
) where

import Control.DeepSeq
import Control.Monad
import Crypto.Random
import Data.Binary
import Data.Binary.Roll
import Data.ByteString as BS hiding (split, take)
import Data.Data
import Data.Maybe
import Data.Word
import Data.Text as T hiding (split, take)
import GHC.Generics
import System.Random


import qualified Data.ULID.Base32 as B32


-- | Newtype wrapping a `ByteString`
newtype ULIDRandom = ULIDRandom BS.ByteString
    deriving (ULIDRandom -> ULIDRandom -> Bool
(ULIDRandom -> ULIDRandom -> Bool)
-> (ULIDRandom -> ULIDRandom -> Bool) -> Eq ULIDRandom
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ULIDRandom -> ULIDRandom -> Bool
$c/= :: ULIDRandom -> ULIDRandom -> Bool
== :: ULIDRandom -> ULIDRandom -> Bool
$c== :: ULIDRandom -> ULIDRandom -> Bool
Eq, Typeable, Typeable ULIDRandom
DataType
Constr
Typeable ULIDRandom
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> ULIDRandom -> c ULIDRandom)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c ULIDRandom)
-> (ULIDRandom -> Constr)
-> (ULIDRandom -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c ULIDRandom))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e))
    -> Maybe (c ULIDRandom))
-> ((forall b. Data b => b -> b) -> ULIDRandom -> ULIDRandom)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> ULIDRandom -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> ULIDRandom -> r)
-> (forall u. (forall d. Data d => d -> u) -> ULIDRandom -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> ULIDRandom -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom)
-> Data ULIDRandom
ULIDRandom -> DataType
ULIDRandom -> Constr
(forall b. Data b => b -> b) -> ULIDRandom -> ULIDRandom
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ULIDRandom -> c ULIDRandom
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ULIDRandom
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> ULIDRandom -> u
forall u. (forall d. Data d => d -> u) -> ULIDRandom -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> ULIDRandom -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> ULIDRandom -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ULIDRandom
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ULIDRandom -> c ULIDRandom
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c ULIDRandom)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ULIDRandom)
$cULIDRandom :: Constr
$tULIDRandom :: DataType
gmapMo :: (forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom
gmapMp :: (forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom
gmapM :: (forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> ULIDRandom -> m ULIDRandom
gmapQi :: Int -> (forall d. Data d => d -> u) -> ULIDRandom -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> ULIDRandom -> u
gmapQ :: (forall d. Data d => d -> u) -> ULIDRandom -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> ULIDRandom -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> ULIDRandom -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> ULIDRandom -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> ULIDRandom -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> ULIDRandom -> r
gmapT :: (forall b. Data b => b -> b) -> ULIDRandom -> ULIDRandom
$cgmapT :: (forall b. Data b => b -> b) -> ULIDRandom -> ULIDRandom
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ULIDRandom)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ULIDRandom)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c ULIDRandom)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c ULIDRandom)
dataTypeOf :: ULIDRandom -> DataType
$cdataTypeOf :: ULIDRandom -> DataType
toConstr :: ULIDRandom -> Constr
$ctoConstr :: ULIDRandom -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ULIDRandom
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ULIDRandom
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ULIDRandom -> c ULIDRandom
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ULIDRandom -> c ULIDRandom
$cp1Data :: Typeable ULIDRandom
Data, (forall x. ULIDRandom -> Rep ULIDRandom x)
-> (forall x. Rep ULIDRandom x -> ULIDRandom) -> Generic ULIDRandom
forall x. Rep ULIDRandom x -> ULIDRandom
forall x. ULIDRandom -> Rep ULIDRandom x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ULIDRandom x -> ULIDRandom
$cfrom :: forall x. ULIDRandom -> Rep ULIDRandom x
Generic)

instance Show ULIDRandom where
    show :: ULIDRandom -> String
show (ULIDRandom ByteString
r) = Text -> String
T.unpack (Text -> String) -> Text -> String
forall a b. (a -> b) -> a -> b
$ Int -> Integer -> Text
forall i. Integral i => Int -> i -> Text
B32.encode Int
16 (Integer -> Text) -> (ByteString -> Integer) -> ByteString -> Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. [Word8] -> Integer
roll ([Word8] -> Integer)
-> (ByteString -> [Word8]) -> ByteString -> Integer
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ByteString -> [Word8]
BS.unpack (ByteString -> Text) -> ByteString -> Text
forall a b. (a -> b) -> a -> b
$ ByteString
r

instance Read ULIDRandom where
  readsPrec :: Int -> ReadS ULIDRandom
readsPrec Int
_ = ((Integer, Text) -> (ULIDRandom, String))
-> [(Integer, Text)] -> [(ULIDRandom, String)]
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap
    (\(Integer
int, Text
rest) ->
        (ByteString -> ULIDRandom
ULIDRandom (ByteString -> ULIDRandom) -> ByteString -> ULIDRandom
forall a b. (a -> b) -> a -> b
$ [Word8] -> ByteString
BS.pack ([Word8] -> ByteString) -> [Word8] -> ByteString
forall a b. (a -> b) -> a -> b
$ Int -> Integer -> [Word8]
unroll Int
numBytes Integer
int, Text -> String
T.unpack Text
rest))
    ([(Integer, Text)] -> [(ULIDRandom, String)])
-> (String -> [(Integer, Text)]) -> ReadS ULIDRandom
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> Text -> [(Integer, Text)]
forall i. Integral i => Int -> Text -> [(i, Text)]
B32.decode Int
16
    (Text -> [(Integer, Text)])
-> (String -> Text) -> String -> [(Integer, Text)]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> Text
T.pack

instance Binary ULIDRandom where
    put :: ULIDRandom -> Put
put (ULIDRandom ByteString
r) = (Word8 -> Put) -> [Word8] -> Put
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ Word8 -> Put
forall t. Binary t => t -> Put
put (ByteString -> [Word8]
BS.unpack ByteString
r)
    get :: Get ULIDRandom
get = ByteString -> ULIDRandom
ULIDRandom (ByteString -> ULIDRandom)
-> ([Word8] -> ByteString) -> [Word8] -> ULIDRandom
forall b c a. (b -> c) -> (a -> b) -> a -> c
. [Word8] -> ByteString
BS.pack ([Word8] -> ULIDRandom) -> Get [Word8] -> Get ULIDRandom
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Int -> Get Word8 -> Get [Word8]
forall (m :: * -> *) a. Applicative m => Int -> m a -> m [a]
replicateM Int
numBytes Get Word8
forall t. Binary t => Get t
get

instance NFData ULIDRandom where
    rnf :: ULIDRandom -> ()
rnf (ULIDRandom ByteString
r) = ByteString -> ()
forall a. NFData a => a -> ()
rnf ByteString
r


numBytes :: Int
numBytes = Int
10 -- 80 bits


-- | Generate a `ULIDRandom` based on a cryptographically secure
-- random number generator.
-- See:
-- https://hackage.haskell.org/package/crypto-api-0.13.3/docs/Crypto-Random.html
mkCryptoULIDRandom :: CryptoRandomGen g => g -> Either GenError (ULIDRandom, g)
mkCryptoULIDRandom :: g -> Either GenError (ULIDRandom, g)
mkCryptoULIDRandom g
g = do
  (ByteString
b, g
g2) <- Int -> g -> Either GenError (ByteString, g)
forall g.
CryptoRandomGen g =>
Int -> g -> Either GenError (ByteString, g)
genBytes Int
numBytes g
g
  (ULIDRandom, g) -> Either GenError (ULIDRandom, g)
forall (m :: * -> *) a. Monad m => a -> m a
return (ByteString -> ULIDRandom
ULIDRandom ByteString
b, g
g2)


-- | Generate a `ULIDRandom` based on a standard random number generator.
-- See:
-- https://hackage.haskell.org/package/random-1.1/docs/System-Random.html
mkULIDRandom :: RandomGen g => g -> (ULIDRandom, g)
mkULIDRandom :: g -> (ULIDRandom, g)
mkULIDRandom g
g = let
  (g
g1, g
g2) = g -> (g, g)
forall g. RandomGen g => g -> (g, g)
split g
g
  genbytes :: g -> ByteString
genbytes = [Word8] -> ByteString
BS.pack ([Word8] -> ByteString) -> (g -> [Word8]) -> g -> ByteString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> [Word8] -> [Word8]
forall a. Int -> [a] -> [a]
take Int
numBytes ([Word8] -> [Word8]) -> (g -> [Word8]) -> g -> [Word8]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. g -> [Word8]
forall a g. (Random a, RandomGen g) => g -> [a]
randoms
  in (ByteString -> ULIDRandom
ULIDRandom (ByteString -> ULIDRandom) -> ByteString -> ULIDRandom
forall a b. (a -> b) -> a -> b
$ g -> ByteString
genbytes g
g, g
g2)


-- | Generate a ULID Random based on the global random number generator.
getULIDRandom :: IO ULIDRandom
-- | Note: The call to `newStdGen` splits the generator,
-- so this is safe to call multiple times
getULIDRandom :: IO ULIDRandom
getULIDRandom =
  (ULIDRandom, StdGen) -> ULIDRandom
forall a b. (a, b) -> a
fst ((ULIDRandom, StdGen) -> ULIDRandom)
-> (StdGen -> (ULIDRandom, StdGen)) -> StdGen -> ULIDRandom
forall b c a. (b -> c) -> (a -> b) -> a -> c
. StdGen -> (ULIDRandom, StdGen)
forall g. RandomGen g => g -> (ULIDRandom, g)
mkULIDRandom (StdGen -> ULIDRandom) -> IO StdGen -> IO ULIDRandom
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> IO StdGen
forall (m :: * -> *). MonadIO m => m StdGen
newStdGen