/** BEGIN COPYRIGHT BLOCK
 * Copyright (C) 2021 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

/*
 * memberof.h - memberOf shared definitions
 *
 */

#ifndef _MEMBEROF_H_
#define _MEMBEROF_H_

#include <stdio.h>
#include <string.h>
#include <time.h>
#include <sys/types.h>
#include "portable.h"
#include "slapi-plugin.h"
#include <nspr.h>

/* Private API: to get SLAPI_DSE_RETURNTEXT_SIZE, DSE_FLAG_PREOP, and DSE_FLAG_POSTOP */
#include "slapi-private.h"

/*
 * macros
 */
#define MEMBEROF_PLUGIN_SUBSYSTEM "memberof-plugin" /* used for logging */
#define MEMBEROF_INT_PREOP_DESC   "memberOf internal postop plugin"
#define MEMBEROF_PREOP_DESC       "memberof preop plugin"
#define MEMBEROF_BEPOSTOP_DESC    "memberof backend postop plugin"
#define MEMBEROF_GROUP_ATTR       "memberOfGroupAttr"
#define MEMBEROF_ATTR             "memberOfAttr"
#define MEMBEROF_BACKEND_ATTR     "memberOfAllBackends"
#define MEMBEROF_ENTRY_SCOPE_ATTR "memberOfEntryScope"
#define MEMBEROF_SKIP_NESTED_ATTR "memberOfSkipNested"
#define MEMBEROF_DEFERRED_UPDATE_ATTR "memberOfDeferredUpdate"
#define MEMBEROF_AUTO_ADD_OC      "memberOfAutoAddOC"
#define MEMBEROF_NEED_FIXUP       "memberOfNeedFixup"
#define MEMBEROF_LAUNCH_FIXUP     "memberOfLaunchFixup"
#define NSMEMBEROF                "nsMemberOf"
#define MEMBEROF_ENTRY_SCOPE_EXCLUDE_SUBTREE "memberOfEntryScopeExcludeSubtree"
#define DN_SYNTAX_OID             "1.3.6.1.4.1.1466.115.121.1.12"
#define NAME_OPT_UID_SYNTAX_OID   "1.3.6.1.4.1.1466.115.121.1.34"
#define SHUTDOWN_TIMEOUT          60   /* systemctl timeout is by default 90s */
#define MEMBEROF_SPECIFIC_GROUP_FILTER         "memberOfSpecificGroupFilter"
#define MEMBEROF_EXCLUDE_SPECIFIC_GROUP_FILTER "memberOfExcludeSpecificGroupFilter"
#define MEMBEROF_SPECIFIC_GROUP_OC "memberOfSpecificGroupOC"


/*
 * structs
 */

typedef struct memberof_deferred_mod_task
{
    Slapi_PBlock *pb_original;
    Slapi_PBlock *pb;
    LDAPMod **mods;
    Slapi_DN *target_sdn;
} MemberofDeferredModTask;
typedef struct memberof_deferred_add_task
{
    Slapi_PBlock *pb_original;
    Slapi_PBlock *pb;
    int foo;
} MemberofDeferredAddTask;
typedef struct memberof_deferred_del_task
{
    Slapi_PBlock *pb_original;
    Slapi_PBlock *pb;
    int foo;
} MemberofDeferredDelTask;
typedef struct memberof_deferred_modrdn_task
{
    Slapi_PBlock *pb_original;
    Slapi_PBlock *pb;
    int foo;
} MemberofDeferredModrdnTask;
typedef struct memberof_deferred_task
{
    unsigned long deferred_choice;
    union
    {
        /* modify */
        struct memberof_deferred_mod_task *d_un_mod;

        /* modify */
        struct memberof_deferred_add_task *d_un_add;

        /* modify */
        struct memberof_deferred_del_task *d_un_del;

        /* modify */
        struct memberof_deferred_modrdn_task *d_un_modrdn;
    } d_un;
#define d_mod d_un.d_un_mod
#define d_add d_un.d_un_add
#define d_del d_un.d_un_del
#define d_modrdn d_un.d_un_modrdn
    struct memberof_deferred_task *next;
    struct memberof_deferred_task *prev;
} MemberofDeferredTask;

typedef struct memberof_deferred_list
{
    pthread_mutex_t deferred_list_mutex;
    pthread_cond_t deferred_list_cv;
    PRThread *deferred_tid;
    int current_task;
    int total_added;
    int total_removed;
    MemberofDeferredTask *tasks_head;
    MemberofDeferredTask *tasks_queue;
} MemberofDeferredList;


typedef struct memberofconfig
{
    char **groupattrs;
    char *memberof_attr;
    int allBackends;
    Slapi_DN **entryScopes;
    int entryScopeCount;
    Slapi_DN **entryScopeExcludeSubtrees;
    int entryExcludeScopeCount;
    Slapi_Filter **specificGroupFilter;
    Slapi_Filter **excludeSpecificGroupFilter;
    int specificGroupFilterCount;
    int excludeSpecificGroupFilterCount;
    char **specificGroupOC;
    int specificGroupOCCount;
    Slapi_Filter *group_filter;
    Slapi_Attr **group_slapiattrs;
    int skip_nested;
    int fixup_task;
    char *auto_add_oc;
    PRBool deferred_update;
    MemberofDeferredList *deferred_list;
    PLHashTable *ancestors_cache;
    PLHashTable *fixup_cache;
    Slapi_Task *task;
    int need_fixup;
    PRBool launch_fixup;
    bool is_lmdb;
} MemberOfConfig;

/* The key to access the hash table is the normalized DN
 * The normalized DN is stored in the value because:
 *  - It is used in slapi_valueset_find
 *  - It is used to fill the memberof_get_groups_data.group_norm_vals
 */
typedef struct _memberof_cached_value
{
    char *key;
    char *group_dn_val;
    char *group_ndn_val;
    int valid;
} memberof_cached_value;

/*
 * functions
 */
int memberof_config(Slapi_Entry *config_e, Slapi_PBlock *pb);
void memberof_copy_config(MemberOfConfig *dest, MemberOfConfig *src);
void memberof_free_config(MemberOfConfig *config);
MemberOfConfig *memberof_get_config(void);
void memberof_rlock_config(void);
void memberof_wlock_config(void);
void memberof_unlock_config(void);
int memberof_config_get_all_backends(void);
void memberof_set_config_area(Slapi_DN *sdn);
Slapi_DN *memberof_get_config_area(void);
void memberof_set_plugin_area(Slapi_DN *sdn);
Slapi_DN *memberof_get_plugin_area(void);
int memberof_shared_config_validate(Slapi_PBlock *pb);
int memberof_apply_config(Slapi_PBlock *pb, Slapi_Entry *entryBefore, Slapi_Entry *e, int *returncode, char *returntext, void *arg);
void *memberof_get_plugin_id(void);
void memberof_release_config(void);
PRUint64 get_plugin_started(void);
void ancestor_hashtable_entry_free(memberof_cached_value *entry);
PLHashTable *hashtable_new(int usetxn);
int memberof_use_txn(void);

#endif /* _MEMBEROF_H_ */
