/** BEGIN COPYRIGHT BLOCK
 * Copyright (C) 2001 Sun Microsystems, Inc. Used by permission.
 * Copyright (C) 2005 Red Hat, Inc.
 * All rights reserved.
 *
 * License: GPL (version 3 or any later version).
 * See LICENSE for details.
 * END COPYRIGHT BLOCK **/

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

/* operation.c - routines to deal with pending ldap operations */

#include <stdio.h>
#include <string.h>
#include <sys/types.h>
#include <sys/socket.h>
#include "slap.h"
#include "fe.h"

int
slapi_is_operation_abandoned(Slapi_Operation *op)
{
    if (op != NULL) {
        return (op->o_status == SLAPI_OP_STATUS_ABANDONED);
    }
    return 0;
}

int
slapi_op_abandoned(Slapi_PBlock *pb)
{
    if (pb != NULL) {
        Operation *pb_op;
        slapi_pblock_get(pb, SLAPI_OPERATION, &pb_op);
        return slapi_is_operation_abandoned(pb_op);
    }
    return 0;
}

int
slapi_op_internal(Slapi_PBlock *pb)
{
    if (pb) {
        Operation *pb_op;
        slapi_pblock_get(pb, SLAPI_OPERATION, &pb_op);
        if (pb_op) {
            return operation_is_flag_set(pb_op, OP_FLAG_INTERNAL);
        }
    }
    return 0;
}

void
operation_out_of_disk_space()
{
    slapi_log_err(SLAPI_LOG_EMERG, "operation_out_of_disk_space",
                  "*** DISK FULL ***\n");
    slapi_log_err(SLAPI_LOG_EMERG, "operation_out_of_disk_space",
                  "Attempting to shut down gracefully.\n");
    g_set_shutdown(SLAPI_SHUTDOWN_DISKFULL);
}

/* Setting the flags on the operation allows more control to the plugin
 * to disable and enable checks
 * Flags that we support  for setting in the operation  from the plugin are
 * SLAPI_OP_FLAG_NO_ACCESS_CHECK - do not check for access control
 * This function can be extended to support other flag setting as well
 */

void
slapi_operation_set_flag(Slapi_Operation *op, unsigned long flag)
{

    operation_set_flag(op, flag);
}

void
slapi_operation_clear_flag(Slapi_Operation *op, unsigned long flag)
{
    operation_clear_flag(op, flag);
}

int
slapi_operation_is_flag_set(Slapi_Operation *op, unsigned long flag)
{
    return operation_is_flag_set(op, flag);
}


static int operation_type = -1; /* The type number assigned by the Factory for 'Operation' */

int
get_operation_object_type()
{
    if (operation_type == -1) {
        /* The factory is given the name of the object type, in
         * return for a type handle. Whenever the object is created
         * or destroyed the factory is called with the handle so
         * that it may call the constructors or destructors registered
         * with it.
         */
        operation_type = factory_register_type(SLAPI_EXT_OPERATION, offsetof(Operation, o_extension));
    }
    return operation_type;
}

/* openldap doesn't have anything like this, nor does it have
   a way to portably and without cheating discover the
   sizeof BerElement - see lber_pvt.h for the trick used
   for BerElementBuffer
   so we just allocate everything separately
   If we wanted to get fancy, we could use LBER_OPT_MEMORY_FNS
   to override the ber malloc, realloc, etc. and use
   LBER_OPT_BER_MEMCTX to provide callback data for use
   with those functions
*/
static void *
ber_special_alloc(size_t size, BerElement **ppBer)
{
    void *mem = NULL;

    /* starts out with a null buffer - will grow as needed */
    *ppBer = ber_alloc_t(0);

    /* Make sure mem size requested is aligned */
    if (0 != (size & 0x03)) {
        size += (sizeof(ber_int_t) - (size & 0x03));
    }

    mem = slapi_ch_malloc(size);

    return mem;
}

static void
ber_special_free(void *buf, BerElement *ber)
{
    ber_free(ber, 1);
    slapi_ch_free(&buf);
}

void
operation_init(Slapi_Operation *o, int flags)
{
    if (NULL != o) {
        BerElement *ber = o->o_ber; /* may have already been set */
        /* We can't get rid of this til we remove the operation stack. */
        memset(o, 0, sizeof(Slapi_Operation));
        o->o_ber = ber;
        o->o_msgid = -1;         /* if changed please update start-tls that test this value */
        o->o_tag = LBER_DEFAULT; /* if changed please update start-tls that test this value */
        o->o_status = SLAPI_OP_STATUS_PROCESSING;
        slapi_sdn_init(&(o->o_sdn));
        o->o_authtype = NULL;
        o->o_isroot = 0;
        clock_gettime(CLOCK_MONOTONIC, &(o->o_hr_time_rel));
        clock_gettime(CLOCK_REALTIME, &(o->o_hr_time_utc));
        o->o_opid = 0;
        o->o_connid = 0;
        o->o_next = NULL;
        o->o_flags = flags;
        o->o_reverse_search_state = 0;
        o->o_pagedresults_sizelimit = -1;
    }
}

Slapi_Operation *
slapi_operation_new(int flags)
{
    return (operation_new(flags));
}
/*
 * Allocate a new Slapi_Operation.
 * The flag parameter indicates whether the the operation is
 * external (from an LDAP Client), or internal (from a plugin).
 */
Slapi_Operation *
operation_new(int flags)
{
    /* To improve performance, we allocate the Operation, BerElement and
     * ber buffer in one block, instead of a separate malloc() for each.
     * Subsequently, ber_special_free() frees them all; we're careful
     * not to free the Operation separately, and the ber software knows
     * not to free the buffer separately.
     */
    Slapi_Operation *o;
    BerElement *ber = NULL;
    if (flags & OP_FLAG_INTERNAL) {
        o = (Slapi_Operation *)slapi_ch_calloc(1, sizeof(Slapi_Operation));
    } else {
        o = (Slapi_Operation *)ber_special_alloc(sizeof(Slapi_Operation), &ber);
    }
    if (NULL != o) {
        o->o_ber = ber;
        operation_init(o, flags);
    }
    return o;
}

void
operation_done(Slapi_Operation **op, Connection *conn)
{
    if (op != NULL && *op != NULL) {

        /* Call the plugin extension destructors */
        factory_destroy_extension(get_operation_object_type(), *op, conn, &((*op)->o_extension));
        slapi_sdn_done(&(*op)->o_sdn);
        slapi_sdn_free(&(*op)->o_target_spec);
        slapi_ch_free_string(&(*op)->o_authtype);
        if ((*op)->o_searchattrs != NULL) {
            charray_free((*op)->o_searchattrs);
            (*op)->o_searchattrs = NULL;
        }
        if (NULL != (*op)->o_params.request_controls) {
            ldap_controls_free((*op)->o_params.request_controls);
            (*op)->o_params.request_controls = NULL;
        }
        if (NULL != (*op)->o_results.result_controls) {
            ldap_controls_free((*op)->o_results.result_controls);
            (*op)->o_results.result_controls = NULL;
        }
        slapi_ch_free_string(&(*op)->o_results.result_matched);
        slapi_ch_free_string(&(*op)->o_results.result_text);
        int options = 0;
        /* save the old options */
        if ((*op)->o_ber) {
            ber_get_option((*op)->o_ber, LBER_OPT_BER_OPTIONS, &options);
            /* we don't have a way to reuse the BerElement buffer so just free it */
            ber_free_buf((*op)->o_ber);
            /* clear out the ber for the next operation */
            ber_init2((*op)->o_ber, NULL, options);
        }
    }
}

void
operation_free(Slapi_Operation **op, Connection *conn)
{
    operation_done(op, conn);
    if (op != NULL && *op != NULL) {
        if (operation_is_flag_set(*op, OP_FLAG_INTERNAL)) {
            slapi_ch_free((void **)op);
        } else {
            ber_special_free(*op, (*op)->o_ber);
        }
        /* counters_to_errors_log("after operation"); */
    }
}

void
slapi_operation_set_csngen_handler(Slapi_Operation *op, void *callback)
{
    op->o_csngen_handler = (csngen_handler)callback;
}

void
slapi_operation_set_replica_attr_handler(Slapi_Operation *op, void *callback)
{
    op->o_replica_attr_handler = (replica_attr_handler)callback;
}

int
slapi_operation_get_replica_attr(Slapi_PBlock *pb, Slapi_Operation *op, const char *type, void *value)
{
    int rc = -1;

    if (op->o_replica_attr_handler) {
        rc = op->o_replica_attr_handler(pb, type, value);
    }

    return rc;
}

CSN *
operation_get_csn(Slapi_Operation *op)
{
    return op->o_params.csn;
}

void
operation_set_csn(Slapi_Operation *op, CSN *csn)
{
    op->o_params.csn = csn;
}

unsigned long
slapi_op_get_type(Slapi_Operation *op)
{
    return op->o_params.operation_type;
}

char *
slapi_op_type_to_string(unsigned long type)
{
    switch (type) {
    case SLAPI_OPERATION_ADD:
        return "add";
    case SLAPI_OPERATION_DELETE:
        return "delete";
    case SLAPI_OPERATION_MODIFY:
        return "modify";
    case SLAPI_OPERATION_MODRDN:
        return "modrdn";
    case SLAPI_OPERATION_BIND:
        return "bind";
    case SLAPI_OPERATION_COMPARE:
        return "compare";
    case SLAPI_OPERATION_SEARCH:
        return "search";
    default:
        return "unknown operation type";
    }
}

/* DEPRECATED : USE FUNCTION ABOVE FOR NEW DVLPT */
unsigned long
operation_get_type(Slapi_Operation *op)
{
    return op->o_params.operation_type;
}

void
operation_set_type(Slapi_Operation *op, unsigned long type)
{
    op->o_params.operation_type = type;
}

void
operation_set_flag(Slapi_Operation *op, int flag)
{
    op->o_flags |= flag;
}

void
operation_clear_flag(Slapi_Operation *op, int flag)
{
    op->o_flags &= ~flag;
}

int
operation_is_flag_set(Slapi_Operation *op, int flag)
{
    return op->o_flags & flag;
}

void *
operation_get_target_entry(Slapi_Operation *op)
{
    PR_ASSERT(op);

    return op->o_target_entry;
}

void
operation_set_target_entry(Slapi_Operation *op, void *target_entry)
{
    PR_ASSERT(op);

    op->o_target_entry = target_entry;
}

u_int32_t
operation_get_target_entry_id(Slapi_Operation *op)
{
    PR_ASSERT(op);

    return op->o_target_entry_id;
}

void
operation_set_target_entry_id(Slapi_Operation *op, u_int32_t target_entry_id)
{
    PR_ASSERT(op);

    op->o_target_entry_id = target_entry_id;
}

Slapi_DN *
operation_get_target_spec(Slapi_Operation *op)
{
    return op->o_target_spec;
}

void
operation_set_target_spec(Slapi_Operation *op, const Slapi_DN *target_spec)
{
    PR_ASSERT(op);
    PR_ASSERT(target_spec);

    op->o_target_spec = slapi_sdn_dup(target_spec);
}

void
operation_set_target_spec_str(Slapi_Operation *op, const char *target_spec)
{
    PR_ASSERT(op);

    op->o_target_spec = slapi_sdn_new_dn_byval(target_spec);
}

unsigned long
operation_get_abandoned_op(const Slapi_Operation *op)
{
    PR_ASSERT(op);

    return op->o_abandoned_op;
}

void
operation_set_abandoned_op(Slapi_Operation *op, unsigned long abandoned_op)
{
    PR_ASSERT(op);

    op->o_abandoned_op = abandoned_op;
}

/* slapi_operation_parameters manipulation functions */

struct slapi_operation_parameters *
operation_parameters_new()
{
    return (slapi_operation_parameters *)slapi_ch_calloc(1, sizeof(slapi_operation_parameters));
}

ber_tag_t
slapi_operation_get_tag(Slapi_Operation *op)
{
    return op->o_tag;
}

ber_int_t
slapi_operation_get_msgid(Slapi_Operation *op)
{
    return op->o_msgid;
}

void
slapi_operation_set_tag(Slapi_Operation *op, ber_tag_t tag)
{
    op->o_tag = tag;
}

void
slapi_operation_set_msgid(Slapi_Operation *op, ber_int_t msgid)
{
    op->o_msgid = msgid;
}

LDAPMod **
copy_mods(LDAPMod **orig_mods)
{
    LDAPMod **new_mods = NULL;
    LDAPMod *mod;
    Slapi_Mods smods_old;
    Slapi_Mods smods_new;
    slapi_mods_init_byref(&smods_old, orig_mods);
    slapi_mods_init_passin(&smods_new, new_mods);
    mod = slapi_mods_get_first_mod(&smods_old);
    while (mod != NULL) {
        slapi_mods_add_modbvps(&smods_new, mod->mod_op, mod->mod_type, mod->mod_bvalues);
        mod = slapi_mods_get_next_mod(&smods_old);
    }
    new_mods = slapi_mods_get_ldapmods_passout(&smods_new);
    slapi_mods_done(&smods_old);
    slapi_mods_done(&smods_new);
    return new_mods;
}

struct slapi_operation_parameters *
operation_parameters_dup(struct slapi_operation_parameters *sop)
{
    struct slapi_operation_parameters *sop_new = (struct slapi_operation_parameters *)
        slapi_ch_malloc(sizeof(struct slapi_operation_parameters));
    memcpy(sop_new, sop, sizeof(struct slapi_operation_parameters));
    if (sop->target_address.uniqueid != NULL) {
        sop_new->target_address.uniqueid = slapi_ch_strdup(sop->target_address.uniqueid);
    }
    if (sop->target_address.sdn != NULL) {
        sop_new->target_address.sdn = slapi_sdn_dup(sop->target_address.sdn);
    }

    sop_new->csn = csn_dup(sop->csn);
    switch (sop->operation_type) {
    case SLAPI_OPERATION_ADD:
        sop_new->p.p_add.target_entry = slapi_entry_dup(sop->p.p_add.target_entry);
        sop_new->p.p_add.parentuniqueid = slapi_ch_strdup(sop->p.p_add.parentuniqueid);
        break;
    case SLAPI_OPERATION_MODIFY:
        sop_new->p.p_modify.modify_mods = NULL;
        if (sop->p.p_modify.modify_mods != NULL) {
            sop_new->p.p_modify.modify_mods = copy_mods(sop->p.p_modify.modify_mods);
        }
        break;
    case SLAPI_OPERATION_MODRDN:
        if (sop->p.p_modrdn.modrdn_newrdn != NULL) {
            sop_new->p.p_modrdn.modrdn_newrdn = slapi_ch_strdup(sop->p.p_modrdn.modrdn_newrdn);
        }
        if (sop->p.p_modrdn.modrdn_newsuperior_address.sdn != NULL) {
            sop_new->p.p_modrdn.modrdn_newsuperior_address.sdn =
                slapi_sdn_dup(sop->p.p_modrdn.modrdn_newsuperior_address.sdn);
        }
        if (sop->p.p_modrdn.modrdn_newsuperior_address.uniqueid != NULL) {
            sop_new->p.p_modrdn.modrdn_newsuperior_address.uniqueid =
                slapi_ch_strdup(sop->p.p_modrdn.modrdn_newsuperior_address.uniqueid);
        }
        sop_new->p.p_modrdn.modrdn_mods = NULL;
        if (sop->p.p_modrdn.modrdn_mods != NULL) {
            sop_new->p.p_modrdn.modrdn_mods = copy_mods(sop->p.p_modrdn.modrdn_mods);
        }
        break;
    case SLAPI_OPERATION_DELETE:
    /* Has no extra parameters. */
    case SLAPI_OPERATION_BIND:
    case SLAPI_OPERATION_COMPARE:
    case SLAPI_OPERATION_SEARCH:
    default:
        /* We are not interested in these. */
        break;
    }
    return sop_new;
}

void
operation_parameters_done(struct slapi_operation_parameters *sop)
{
    if (sop != NULL) {
        slapi_ch_free((void **)&sop->target_address.uniqueid);
        slapi_sdn_free(&sop->target_address.sdn);

        csn_free(&sop->csn);

        switch (sop->operation_type) {
        case SLAPI_OPERATION_ADD:
            slapi_entry_free(sop->p.p_add.target_entry);
            sop->p.p_add.target_entry = NULL;
            slapi_ch_free((void **)&(sop->p.p_add.parentuniqueid));
            break;
        case SLAPI_OPERATION_MODIFY:
            ldap_mods_free(sop->p.p_modify.modify_mods, 1 /* Free the Array and the Elements */);
            sop->p.p_modify.modify_mods = NULL;
            break;
        case SLAPI_OPERATION_MODRDN:
            slapi_ch_free((void **)&(sop->p.p_modrdn.modrdn_newrdn));
            slapi_ch_free((void **)&(sop->p.p_modrdn.modrdn_newsuperior_address.uniqueid));
            slapi_sdn_free(&sop->p.p_modrdn.modrdn_newsuperior_address.sdn);
            ldap_mods_free(sop->p.p_modrdn.modrdn_mods, 1 /* Free the Array and the Elements */);
            sop->p.p_modrdn.modrdn_mods = NULL;
            break;
        case SLAPI_OPERATION_DELETE:
        /* Has no extra parameters. */
        case SLAPI_OPERATION_BIND:
        case SLAPI_OPERATION_COMPARE:
        case SLAPI_OPERATION_SEARCH:
        default:
            /* We are not interested in these */
            break;
        }
    }
}

void
operation_parameters_free(struct slapi_operation_parameters **sop)
{
    if (sop) {
        operation_parameters_done(*sop);
        slapi_ch_free((void **)sop);
    }
}

int
slapi_connection_acquire(Slapi_Connection *conn)
{
    int rc;

    pthread_mutex_lock(&(conn->c_mutex));
    /* rc = connection_acquire_nolock(conn); */
    /* connection in the closing state can't be acquired */
    if (conn->c_flags & CONN_FLAG_CLOSING) {
        /* This may happen while other threads are still working on this connection */
        slapi_log_err(SLAPI_LOG_ERR, "slapi_connection_acquire",
                      "conn=%" PRIu64 " fd=%d Attempt to acquire connection in the closing state\n",
                      conn->c_connid, conn->c_sd);
        rc = -1;
    } else {
        conn->c_refcnt++;
        rc = 0;
    }
    pthread_mutex_unlock(&(conn->c_mutex));
    return (rc);
}

int
slapi_connection_remove_operation(Slapi_PBlock *pb __attribute__((unused)), Slapi_Connection *conn, Slapi_Operation *op, int release)
{
    int rc = 0;
    Slapi_Operation **olist = &conn->c_ops;
    Slapi_Operation **tmp;
    pthread_mutex_lock(&(conn->c_mutex));
    /* connection_remove_operation_ext(pb, conn,op); */
    for (tmp = olist; *tmp != NULL && *tmp != op; tmp = &(*tmp)->o_next)
        ; /* NULL */
    if (*tmp == NULL) {
        if (op) {
            slapi_log_err(SLAPI_LOG_ERR, "slapi_connection_remove_operation",
                          "Can't find op %d for conn %" PRIu64 "\n",
                          (int)op->o_msgid, conn->c_connid);
        } else {
            slapi_log_err(SLAPI_LOG_ERR, "slapi_connection_remove_operation",
                          "No operation provided\n");
        }
    } else {
        *tmp = (*tmp)->o_next;
    }

    if (release) {
        /* connection_release_nolock(conn); */
        if (conn->c_refcnt <= 0) {
            slapi_log_err(SLAPI_LOG_ERR, "slapi_connection_remove_operation",
                          "conn=%" PRIu64 " fd=%d Attempt to release connection that is not acquired\n",
                          conn->c_connid, conn->c_sd);
            rc = -1;
        } else {
            conn->c_refcnt--;
            rc = 0;
        }
    }

    /* Call the plugin extension destructor */
    if (op) {
        factory_destroy_extension(get_operation_object_type(), op, conn, &((op)->o_extension));
    }

    pthread_mutex_unlock(&(conn->c_mutex));
    return (rc);
}

void
slapi_operation_time_elapsed(Slapi_Operation *o, struct timespec *elapsed)
{
    struct timespec o_hr_time_now;
    clock_gettime(CLOCK_MONOTONIC, &o_hr_time_now);

    slapi_timespec_diff(&o_hr_time_now, &(o->o_hr_time_rel), elapsed);
}

void
slapi_operation_time_initiated(Slapi_Operation *o, struct timespec *initiated)
{
    initiated->tv_sec = o->o_hr_time_utc.tv_sec;
    initiated->tv_nsec = o->o_hr_time_utc.tv_nsec;
}

void
slapi_operation_time_expiry(Slapi_Operation *o, time_t timeout, struct timespec *expiry)
{
    slapi_timespec_expire_rel(timeout, &(o->o_hr_time_rel), expiry);
}


/*
 * Operation extension for operation statistics
 */
static int op_stat_objtype = -1;
static int op_stat_handle = -1;

Op_stat *
op_stat_get_operation_extension(Slapi_PBlock *pb)
{
    Slapi_Operation *op;

    slapi_pblock_get(pb, SLAPI_OPERATION, &op);
    return (Op_stat *)slapi_get_object_extension(op_stat_objtype,
                                                             op, op_stat_handle);
}

void
op_stat_set_operation_extension(Slapi_PBlock *pb, Op_stat *op_stat)
{
    Slapi_Operation *op;

    slapi_pblock_get(pb, SLAPI_OPERATION, &op);
    slapi_set_object_extension(op_stat_objtype, op,
                               op_stat_handle, (void *)op_stat);
}

/*
 * constructor for the operation object extension.
 */
static void *
op_stat_constructor(void *object __attribute__((unused)), void *parent __attribute__((unused)))
{
    Op_stat *op_statp = NULL;
    op_statp = (Op_stat *)slapi_ch_calloc(1, sizeof(Op_stat));
    op_statp->search_stat = (Op_search_stat *)slapi_ch_calloc(1, sizeof(Op_search_stat));

    return op_statp;
}
/*
 * destructor for the operation object extension.
 */
static void
op_stat_destructor(void *extension, void *object __attribute__((unused)), void *parent __attribute__((unused)))
{
    Op_stat *op_statp = (Op_stat *)extension;

    if (NULL == op_statp) {
        return;
    }

    if (op_statp->search_stat) {
        struct component_keys_lookup *keys, *next;

        /* free all the individual key counter */
        keys = op_statp->search_stat->keys_lookup;
        while (keys) {
            next = keys->next;
            slapi_ch_free_string(&keys->attribute_type);
            slapi_ch_free_string(&keys->key);
            slapi_ch_free_string(&keys->index_type);
            slapi_ch_free((void **) &keys);
            keys = next;
        }
        slapi_ch_free((void **) &op_statp->search_stat);
    }
    slapi_ch_free((void **) &op_statp);
}

#define SLAPI_OP_STAT_MODULE "Module to collect operation stat"
/* Called once from main */
void
op_stat_init(void)
{
    if (slapi_register_object_extension(SLAPI_OP_STAT_MODULE,
                                        SLAPI_EXT_OPERATION,
                                        op_stat_constructor,
                                        op_stat_destructor,
                                        &op_stat_objtype,
                                        &op_stat_handle) != 0) {
        slapi_log_err(SLAPI_LOG_ERR, "op_stat_init",
                      "slapi_register_object_extension failed; "
                      "operation statistics is not enabled\n");
    }
}

/* Set the time the operation actually started */
void
slapi_operation_set_time_started(Slapi_Operation *o)
{
	clock_gettime(CLOCK_MONOTONIC, &(o->o_hr_time_started_rel));
}

/* The time diff of how long the operation took once it actually started */
void
slapi_operation_op_time_elapsed(Slapi_Operation *o, struct timespec *elapsed)
{
    struct timespec o_hr_time_now;
    clock_gettime(CLOCK_MONOTONIC, &o_hr_time_now);

    slapi_timespec_diff(&o_hr_time_now, &(o->o_hr_time_started_rel), elapsed);
}

/* The time diff the operation waited in the work queue */
void
slapi_operation_workq_time_elapsed(Slapi_Operation *o, struct timespec *elapsed)
{
    slapi_timespec_diff(&(o->o_hr_time_started_rel), &(o->o_hr_time_rel), elapsed);
}

LDAPControl **
operation_get_req_controls(const Operation *o)
{
    return o->o_params.request_controls;
}

LDAPControl **
operation_get_result_controls(const Operation *o)
{
    return o->o_results.result_controls;
}
