{-# LANGUAGE TupleSections #-}
module Opaleye.Internal.Aggregate where

import           Control.Applicative (Applicative, pure, (<*>))

import qualified Data.Profunctor as P
import qualified Data.Profunctor.Product as PP

import qualified Opaleye.Internal.PackMap as PM
import qualified Opaleye.Internal.PrimQuery as PQ
import qualified Opaleye.Internal.Tag as T
import qualified Opaleye.Internal.Column as C
import qualified Opaleye.Internal.Order as O

import qualified Opaleye.Internal.HaskellDB.PrimQuery as HPQ

{-|
An 'Aggregator' takes a collection of rows of type @a@, groups
them, and transforms each group into a single row of type @b@. This
corresponds to aggregators using @GROUP BY@ in SQL.

You should combine basic 'Aggregator's into 'Aggregator's on compound
types by using the operations in "Data.Profunctor.Product".

An 'Aggregator' corresponds closely to a 'Control.Foldl.Fold' from the
@foldl@ package.  Whereas an 'Aggregator' @a@ @b@ takes each group of
type @a@ to a single row of type @b@, a 'Control.Foldl.Fold' @a@ @b@
takes a list of @a@ and returns a single value of type @b@.
-}
newtype Aggregator a b =
  Aggregator (PM.PackMap (Maybe (HPQ.AggrOp, [HPQ.OrderExpr], HPQ.AggrDistinct),
                          HPQ.PrimExpr)
                         HPQ.PrimExpr
                         a b)

makeAggr' :: Maybe HPQ.AggrOp -> Aggregator (C.Field_ n a) (C.Field_ n' b)
makeAggr' :: forall (n :: Nullability) a (n' :: Nullability) b.
Maybe AggrOp -> Aggregator (Field_ n a) (Field_ n' b)
makeAggr' Maybe AggrOp
mAggrOp = forall a b.
PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
-> Aggregator a b
Aggregator (forall a b s t.
(forall (f :: * -> *). Applicative f => (a -> f b) -> s -> f t)
-> PackMap a b s t
PM.PackMap
  (\(Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) -> f PrimExpr
f (C.Column PrimExpr
e) -> forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap forall (n :: Nullability) sqlType. PrimExpr -> Field_ n sqlType
C.Column ((Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) -> f PrimExpr
f (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (, [], AggrDistinct
HPQ.AggrAll) Maybe AggrOp
mAggrOp, PrimExpr
e))))

makeAggr :: HPQ.AggrOp -> Aggregator (C.Field_ n a) (C.Field_ n' b)
makeAggr :: forall (n :: Nullability) a (n' :: Nullability) b.
AggrOp -> Aggregator (Field_ n a) (Field_ n' b)
makeAggr = forall (n :: Nullability) a (n' :: Nullability) b.
Maybe AggrOp -> Aggregator (Field_ n a) (Field_ n' b)
makeAggr' forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. a -> Maybe a
Just

-- | Order the values within each aggregation in `Aggregator` using
-- the given ordering. This is only relevant for aggregations that
-- depend on the order they get their elements, like
-- `Opaleye.Aggregate.arrayAgg` and `Opaleye.Aggregate.stringAgg`.
--
-- You can either apply it to an aggregation of multiple columns, in
-- which case it will apply to all aggregation functions in there
--
-- Example:
--
-- > x :: Aggregator (Column a, Column b) (Column (PGArray a), Column (PGArray b))
-- > x = orderAggregate (asc snd) $ p2 (arrayAgg, arrayAgg)
--
-- This will generate:
--
-- @
-- SELECT array_agg(a ORDER BY b ASC), array_agg(b ORDER BY b ASC)
-- FROM (SELECT a, b FROM ...)
-- @
--
-- Or you can apply it to a single column, and then compose the aggregations
-- afterwards.
--
-- Example:
--
-- > x :: Aggregator (Column a, Column b) (Column (PGArray a), Column (PGArray a))
-- > x = (,) <$> orderAggregate (asc snd) (lmap fst arrayAgg)
-- >         <*> orderAggregate (desc snd) (lmap fst arrayAgg)
--
-- This will generate:
--
-- @
-- SELECT array_agg(a ORDER BY b ASC), array_agg(a ORDER BY b DESC)
-- FROM (SELECT a, b FROM ...)
-- @

orderAggregate :: O.Order a -> Aggregator a b -> Aggregator a b
orderAggregate :: forall a b. Order a -> Aggregator a b -> Aggregator a b
orderAggregate Order a
o (Aggregator (PM.PackMap forall (f :: * -> *).
Applicative f =>
((Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr)
 -> f PrimExpr)
-> a -> f b
pm)) = forall a b.
PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
-> Aggregator a b
Aggregator (forall a b s t.
(forall (f :: * -> *). Applicative f => (a -> f b) -> s -> f t)
-> PackMap a b s t
PM.PackMap
  (\(Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) -> f PrimExpr
f a
c -> forall (f :: * -> *).
Applicative f =>
((Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr)
 -> f PrimExpr)
-> a -> f b
pm ((Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) -> f PrimExpr
f forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (p :: * -> * -> *) a b c.
Strong p =>
p a b -> p (a, c) (b, c)
P.first' (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap ((\[OrderExpr] -> [OrderExpr]
f' (AggrOp
a,[OrderExpr]
b,AggrDistinct
c') -> (AggrOp
a,[OrderExpr] -> [OrderExpr]
f' [OrderExpr]
b,AggrDistinct
c')) (forall a b. a -> b -> a
const forall a b. (a -> b) -> a -> b
$ forall a. a -> Order a -> [OrderExpr]
O.orderExprs a
c Order a
o)))) a
c))

runAggregator
  :: Applicative f
  => Aggregator a b
  -> ((Maybe (HPQ.AggrOp, [HPQ.OrderExpr], HPQ.AggrDistinct), HPQ.PrimExpr)
     -> f HPQ.PrimExpr)
  -> a -> f b
runAggregator :: forall (f :: * -> *) a b.
Applicative f =>
Aggregator a b
-> ((Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr)
    -> f PrimExpr)
-> a
-> f b
runAggregator (Aggregator PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
a) = forall (f :: * -> *) a b s t.
Applicative f =>
PackMap a b s t -> (a -> f b) -> s -> f t
PM.traversePM PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
a

-- For rel8.
--
-- Like https://www.stackage.org/haddock/lts-19.10/base-4.15.1.0/Control-Arrow.html#t:ArrowApply
aggregatorApply :: Aggregator (Aggregator a b, a) b
aggregatorApply :: forall a b. Aggregator (Aggregator a b, a) b
aggregatorApply = forall a b.
PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
-> Aggregator a b
Aggregator forall a b. (a -> b) -> a -> b
$ forall a b s t.
(forall (f :: * -> *). Applicative f => (a -> f b) -> s -> f t)
-> PackMap a b s t
PM.PackMap forall a b. (a -> b) -> a -> b
$ \(Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) -> f PrimExpr
f (Aggregator a b
agg, a
a) ->
  case Aggregator a b
agg of
    Aggregator (PM.PackMap forall (f :: * -> *).
Applicative f =>
((Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr)
 -> f PrimExpr)
-> a -> f b
inner) -> forall (f :: * -> *).
Applicative f =>
((Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr)
 -> f PrimExpr)
-> a -> f b
inner (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) -> f PrimExpr
f a
a

-- In Postgres (and, I believe, standard SQL) "aggregate functions are
-- not allowed in FROM clause of their own query level".  There
-- doesn't seem to be any fundamental reason for this, but we are
-- stuck with it.  That means that in a lateral subquery containing an
-- aggregation over a field C from a previous subquery we have to
-- create a new field name for C before we are allowed to aggregate it!
-- For more information see
--
--     https://www.postgresql.org/message-id/20200513110251.GC24083%40cloudinit-builder
--
--     https://github.com/tomjaguarpaw/haskell-opaleye/pull/460#issuecomment-626716160
--
-- Instead of detecting when we are aggregating over a field from a
-- previous query we just create new names for all field before we
-- aggregate.  On the other hand, referring to a field from a previous
-- query in an ORDER BY expression is totally fine!
aggregateU :: Aggregator a b
           -> (a, PQ.PrimQuery, T.Tag) -> (b, PQ.PrimQuery)
aggregateU :: forall a b. Aggregator a b -> (a, PrimQuery, Tag) -> (b, PrimQuery)
aggregateU Aggregator a b
agg (a
c0, PrimQuery
primQ, Tag
t0) = (b
c1, PrimQuery
primQ')
  where (b
c1, [((Symbol, (Maybe (AggrOp, [OrderExpr], AggrDistinct), Symbol)),
  (Symbol, PrimExpr))]
projPEs_inners) =
          forall a r. PM [a] r -> (r, [a])
PM.run (forall (f :: * -> *) a b.
Applicative f =>
Aggregator a b
-> ((Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr)
    -> f PrimExpr)
-> a
-> f b
runAggregator Aggregator a b
agg (forall m.
Tag
-> (m, PrimExpr)
-> PM [((Symbol, (m, Symbol)), (Symbol, PrimExpr))] PrimExpr
extractAggregateFields Tag
t0) a
c0)

        projPEs :: [(Symbol, (Maybe (AggrOp, [OrderExpr], AggrDistinct), Symbol))]
projPEs = forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> a
fst [((Symbol, (Maybe (AggrOp, [OrderExpr], AggrDistinct), Symbol)),
  (Symbol, PrimExpr))]
projPEs_inners
        inners :: [(Symbol, PrimExpr)]
inners  = forall a b. (a -> b) -> [a] -> [b]
map forall a b. (a, b) -> b
snd [((Symbol, (Maybe (AggrOp, [OrderExpr], AggrDistinct), Symbol)),
  (Symbol, PrimExpr))]
projPEs_inners

        primQ' :: PrimQuery
primQ' = forall a.
[(Symbol, (Maybe (AggrOp, [OrderExpr], AggrDistinct), Symbol))]
-> PrimQuery' a -> PrimQuery' a
PQ.Aggregate [(Symbol, (Maybe (AggrOp, [OrderExpr], AggrDistinct), Symbol))]
projPEs (forall a.
Bool -> [(Symbol, PrimExpr)] -> PrimQuery' a -> PrimQuery' a
PQ.Rebind Bool
True [(Symbol, PrimExpr)]
inners PrimQuery
primQ)

extractAggregateFields
  :: T.Tag
  -> (m, HPQ.PrimExpr)
  -> PM.PM [((HPQ.Symbol,
              (m, HPQ.Symbol)),
              (HPQ.Symbol, HPQ.PrimExpr))]
           HPQ.PrimExpr
extractAggregateFields :: forall m.
Tag
-> (m, PrimExpr)
-> PM [((Symbol, (m, Symbol)), (Symbol, PrimExpr))] PrimExpr
extractAggregateFields Tag
tag (m
m, PrimExpr
pe) = do
  String
i <- forall a. PM a String
PM.new

  let souter :: Symbol
souter = String -> Tag -> Symbol
HPQ.Symbol (String
"result" forall a. [a] -> [a] -> [a]
++ String
i) Tag
tag
      sinner :: Symbol
sinner = String -> Tag -> Symbol
HPQ.Symbol (String
"inner" forall a. [a] -> [a] -> [a]
++ String
i) Tag
tag

  forall a. a -> PM [a] ()
PM.write ((Symbol
souter, (m
m, Symbol
sinner)), (Symbol
sinner, PrimExpr
pe))

  forall (f :: * -> *) a. Applicative f => a -> f a
pure (Symbol -> PrimExpr
HPQ.AttrExpr Symbol
souter)

unsafeMax :: Aggregator (C.Field a) (C.Field a)
unsafeMax :: forall a. Aggregator (Field a) (Field a)
unsafeMax = forall (n :: Nullability) a (n' :: Nullability) b.
AggrOp -> Aggregator (Field_ n a) (Field_ n' b)
makeAggr AggrOp
HPQ.AggrMax

unsafeMin :: Aggregator (C.Field a) (C.Field a)
unsafeMin :: forall a. Aggregator (Field a) (Field a)
unsafeMin = forall (n :: Nullability) a (n' :: Nullability) b.
AggrOp -> Aggregator (Field_ n a) (Field_ n' b)
makeAggr AggrOp
HPQ.AggrMin

unsafeAvg :: Aggregator (C.Field a) (C.Field a)
unsafeAvg :: forall a. Aggregator (Field a) (Field a)
unsafeAvg = forall (n :: Nullability) a (n' :: Nullability) b.
AggrOp -> Aggregator (Field_ n a) (Field_ n' b)
makeAggr AggrOp
HPQ.AggrAvg

unsafeSum :: Aggregator (C.Field a) (C.Field a)
unsafeSum :: forall a. Aggregator (Field a) (Field a)
unsafeSum = forall (n :: Nullability) a (n' :: Nullability) b.
AggrOp -> Aggregator (Field_ n a) (Field_ n' b)
makeAggr AggrOp
HPQ.AggrSum

-- { Boilerplate instances

instance Functor (Aggregator a) where
  fmap :: forall a b. (a -> b) -> Aggregator a a -> Aggregator a b
fmap a -> b
f (Aggregator PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a a
g) = forall a b.
PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
-> Aggregator a b
Aggregator (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap a -> b
f PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a a
g)

instance Applicative (Aggregator a) where
  pure :: forall a. a -> Aggregator a a
pure = forall a b.
PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
-> Aggregator a b
Aggregator forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (f :: * -> *) a. Applicative f => a -> f a
pure
  Aggregator PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr)
  PrimExpr
  a
  (a -> b)
f <*> :: forall a b.
Aggregator a (a -> b) -> Aggregator a a -> Aggregator a b
<*> Aggregator PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a a
x = forall a b.
PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
-> Aggregator a b
Aggregator (PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr)
  PrimExpr
  a
  (a -> b)
f forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a a
x)

instance P.Profunctor Aggregator where
  dimap :: forall a b c d.
(a -> b) -> (c -> d) -> Aggregator b c -> Aggregator a d
dimap a -> b
f c -> d
g (Aggregator PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr b c
q) = forall a b.
PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
-> Aggregator a b
Aggregator (forall (p :: * -> * -> *) a b c d.
Profunctor p =>
(a -> b) -> (c -> d) -> p b c -> p a d
P.dimap a -> b
f c -> d
g PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr b c
q)

instance PP.ProductProfunctor Aggregator where
  purePP :: forall b a. b -> Aggregator a b
purePP = forall (f :: * -> *) a. Applicative f => a -> f a
pure
  **** :: forall a a b.
Aggregator a (a -> b) -> Aggregator a a -> Aggregator a b
(****) = forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
(<*>)

instance PP.SumProfunctor Aggregator where
  Aggregator PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
x1 +++! :: forall a b a' b'.
Aggregator a b
-> Aggregator a' b' -> Aggregator (Either a a') (Either b b')
+++! Aggregator PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr)
  PrimExpr
  a'
  b'
x2 = forall a b.
PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
-> Aggregator a b
Aggregator (PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr) PrimExpr a b
x1 forall (p :: * -> * -> *) a b a' b'.
SumProfunctor p =>
p a b -> p a' b' -> p (Either a a') (Either b b')
PP.+++! PackMap
  (Maybe (AggrOp, [OrderExpr], AggrDistinct), PrimExpr)
  PrimExpr
  a'
  b'
x2)

-- }