/*
   This file is part of TALER
   Copyright (C) 2023 Taler Systems SA

   TALER is free software; you can redistribute it and/or modify it under the
   terms of the GNU General Public License as published by the Free Software
   Foundation; either version 3, or (at your option) any later version.

   TALER is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

   You should have received a copy of the GNU General Public License along with
   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */
/**
 * @file src/include/auditor-database/iterate_pending_deposits.h
 * @brief implementation of the iterate_pending_deposits function for Postgres
 * @author Christian Grothoff
 */
#ifndef AUDITOR_DATABASE_ITERATE_PENDING_DEPOSITS_H
#define AUDITOR_DATABASE_ITERATE_PENDING_DEPOSITS_H

#include "taler/taler_util.h"
#include "taler/taler_json_lib.h"
#include "auditordb_lib.h"


/**
 * Function called on deposits that are past their due date
 * and have not yet seen a wire transfer.
 *
 * @param cls closure
 * @param row_id row ID of the alert in the auditor database
 * @param batch_deposit_serial_id where in the exchange table are we
 * @param total_amount value of all missing deposits, including fees
 * @param wire_target_h_payto hash of the recipient account's payto URI
 * @param deadline what was the earliest requested wire transfer deadline
 * @param suppressed true if this report was suppressed
 */
#ifndef TALER_AUDITORDB_WIRE_MISSING_RESULT_CLOSURE
/**
 * Type of the closure for #TALER_AUDITORDB_WireMissingCallback.
 */
#define TALER_AUDITORDB_WIRE_MISSING_RESULT_CLOSURE void
#endif
typedef void
(*TALER_AUDITORDB_WireMissingCallback) (
  TALER_AUDITORDB_WIRE_MISSING_RESULT_CLOSURE *cls,
  uint64_t row_id,
  uint64_t batch_deposit_serial_id,
  const struct TALER_Amount *total_amount,
  const struct TALER_FullPaytoHashP *wire_target_h_payto,
  struct GNUNET_TIME_Timestamp deadline,
  bool suppressed);


/* Callback typedefs */
/**
 * Function called on deposits that are past their due date
 * and have not yet seen a wire transfer.
 *
 * @param cls closure
 * @param row_id row ID of the alert in the auditor database
 * @param batch_deposit_serial_id where in the exchange table are we
 * @param total_amount value of all missing deposits, including fees
 * @param wire_target_h_payto hash of the recipient account's payto URI
 * @param deadline what was the earliest requested wire transfer deadline
 * @param suppressed true if this report was suppressed
 */
typedef void
(*TALER_AUDITORDB_WireMissingCallback) (
  TALER_AUDITORDB_WIRE_MISSING_RESULT_CLOSURE *cls,
  uint64_t row_id,
  uint64_t batch_deposit_serial_id,
  const struct TALER_Amount *total_amount,
  const struct TALER_FullPaytoHashP *wire_target_h_payto,
  struct GNUNET_TIME_Timestamp deadline,
  bool suppressed);

/**
 * Return (batch) deposits for which we have not yet
 * seen the required wire transfer.
 *
 * @param pg the database context
 * @param deadline only return up to this deadline
 * @param limit number of rows to return, negative to iterate backwards
 * @param offset starting offset, exclusive
 * @param return_suppressed true to also return suppressed events
 * @param cb function to call on each entry
 * @param cb_cls closure for @a cb
 * @return transaction status code
 */
enum GNUNET_DB_QueryStatus
TALER_AUDITORDB_iterate_pending_deposits (struct
                                          TALER_AUDITORDB_PostgresContext *pg,
                                          struct GNUNET_TIME_Absolute deadline,
                                          int64_t limit,
                                          uint64_t offset,
                                          bool return_suppressed,
                                          TALER_AUDITORDB_WireMissingCallback cb
                                          ,
                                          TALER_AUDITORDB_WIRE_MISSING_RESULT_CLOSURE
                                          *cb_cls);

#endif
