src/ldapserver.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2003 Match Grun
   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 2 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, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Definitions necessary to access LDAP servers.
  22  */
  23
  24 #ifndef __LDAPSERVER_H__
  25 #define __LDAPSERVER_H__
  26
  27 #ifdef USE_LDAP
  28
  29 #include <glib.h>
  30
  31 #include "ldapctrl.h"
  32 #include "addritem.h"
  33 #include "addrcache.h"
  34 #include "adbookbase.h"
  35 #include "addrquery.h"
  36
  37 /* Error codes */
  38 #define LDAPRC_SUCCESS    0
  39 #define LDAPRC_CONNECT    -1
  40 #define LDAPRC_INIT       -2
  41 #define LDAPRC_BIND       -3
  42 #define LDAPRC_SEARCH     -4
  43 #define LDAPRC_TIMEOUT    -5
  44 #define LDAPRC_CRITERIA   -6
  45 #define LDAPRC_NOENTRIES  -7
  46 #define LDAPRC_STOP_FLAG  -8
  47
  48 typedef struct _LdapServer LdapServer;
  49 struct _LdapServer {
  50         AddressBookType type;
  51         AddressCache    *addressCache;
  52         gint            retVal;
  53         LdapControl     *control;
  54         gboolean        searchFlag;
  55         GList           *listQuery;
  56 };
  57
  58 /* Function prototypes */
  59 LdapServer *ldapsvr_create_noctl( void );
  60 LdapServer *ldapsvr_create      ( void );
  61 void ldapsvr_set_name           ( LdapServer *server, const gchar *value );
  62 void ldapsvr_set_accessed       ( LdapServer *server, const gboolean value );
  63 void ldapsvr_force_refresh      ( LdapServer *server );
  64 void ldapsvr_free_all_query     ( LdapServer *server );
  65 void ldapsvr_free               ( LdapServer *server );
  66 gint ldapsvr_get_status         ( LdapServer *server );
  67 gboolean ldapsvr_get_accessed   ( LdapServer *server );
  68 gchar *ldapsvr_get_name         ( LdapServer *server );
  69 gboolean ldapsvr_get_modified   ( LdapServer *server );
  70 void ldapsvr_set_modified       ( LdapServer *server, const gboolean value );
  71 gboolean ldapsvr_get_read_flag  ( LdapServer *server );
  72 gboolean ldapsvr_get_search_flag( LdapServer *server );
  73 void ldapsvr_set_search_flag    ( LdapServer *server, const gboolean value );
  74
  75 void ldapsvr_print_data         ( LdapServer *server, FILE *stream );
  76 void ldapsvr_cancel_read        ( LdapServer *server );
  77
  78 ItemFolder *ldapsvr_get_root_folder     ( LdapServer *server );
  79 GList *ldapsvr_get_list_person  ( LdapServer *server );
  80 GList *ldapsvr_get_list_folder  ( LdapServer *server );
  81
  82 void ldapsvr_stop_query_id      ( LdapServer *server, const gint queryID );
  83 void ldapsvr_stop_all_query     ( LdapServer *server );
  84 void ldapsvr_cancel_all_query   ( LdapServer *server );
  85 void ldapsvr_retire_query       ( LdapServer *server );
  86
  87 gboolean ldapsvr_reuse_previous ( const LdapServer *server,
  88                                   const QueryRequest *req );
  89
  90 #endif  /* USE_LDAP */
  91
  92 #endif /* __LDAPSERVER_H__ */
  93