src/ldapquery.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2003-2009 Match Grun and the Claws Mail team
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  */
  19
  20 /*
  21  * Functions necessary to define an LDAP query.
  22  */
  23
  24 #ifndef __LDAPQUERY_H__
  25 #define __LDAPQUERY_H__
  26
  27 #ifdef USE_LDAP
  28
  29 #include <glib.h>
  30 #include <stdio.h>
  31 #include <sys/time.h>
  32 #include <pthread.h>
  33 #include <ldap.h>
  34
  35 #include "addrquery.h"
  36 #include "ldapctrl.h"
  37 #include "addritem.h"
  38 #include "addrcache.h"
  39 #include "ldapserver.h"
  40
  41 typedef struct _LdapQuery LdapQuery;
  42 struct _LdapQuery {
  43         AddrQueryObject obj;
  44         LdapControl     *control;
  45         LdapServer      *server;        /* Reference to (parent) LDAP server */
  46         gint            entriesRead;
  47         gint            elapsedTime;
  48         gboolean        stopFlag;
  49         gboolean        busyFlag;
  50         gboolean        agedFlag;
  51         gboolean        completed;
  52         time_t          startTime;
  53         time_t          touchTime;
  54         pthread_t       *thread;
  55         pthread_mutex_t *mutexStop;
  56         pthread_mutex_t *mutexBusy;
  57         pthread_mutex_t *mutexEntry;
  58         void            (*callBackEntry)( void *, gint, void *, void * );
  59         void            (*callBackEnd)( void *, gint, gint, void * );
  60         LDAP            *ldap;
  61         gpointer        data;
  62 };
  63
  64 typedef struct _NameValuePair NameValuePair;
  65 struct _NameValuePair {
  66         gchar *name;
  67         gchar *value;
  68 };
  69
  70 /* Function prototypes */
  71 void ldapqry_print(LdapQuery *qry, FILE *stream);
  72 void ldapqry_initialize         ( void );
  73 LdapQuery *ldapqry_create       ( void );
  74 void ldapqry_set_control        ( LdapQuery *qry, LdapControl *ctl );
  75 void ldapqry_set_name           ( LdapQuery* qry, const gchar *value );
  76 void ldapqry_set_search_value   ( LdapQuery *qry, const gchar *value );
  77 void ldapqry_set_search_type    ( LdapQuery *qry, const AddrSearchType value );
  78 void ldapqry_set_query_id       ( LdapQuery* qry, const gint value );
  79 void ldapqry_set_callback_start ( LdapQuery *qry, void *func );
  80 void ldapqry_set_callback_entry ( LdapQuery *qry, void *func );
  81 void ldapqry_set_callback_end   ( LdapQuery *qry, void *func );
  82 void ldapqry_free               ( LdapQuery *qry );
  83 void ldapqry_set_stop_flag( LdapQuery *qry, const gboolean value );
  84 gboolean ldapqry_check_search   ( LdapQuery *qry );
  85 void ldapqry_touch              ( LdapQuery *qry );
  86 gint ldapqry_read_data_th       ( LdapQuery *qry );
  87 void ldapqry_cancel             ( LdapQuery *qry );
  88 void ldapqry_age                ( LdapQuery *qry, gint maxAge );
  89 void ldapqry_delete_folder      ( LdapQuery *qry );
  90 gboolean ldapquery_remove_results( LdapQuery *qry );
  91 void ldapqry_free_list_name_value( GList *list );
  92 void ldapqry_free_name_value( NameValuePair *nvp );
  93 #endif  /* USE_LDAP */
  94
  95 #endif /* __LDAPQUERY_H__ */