src/ldapserver.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2003-2006 Match Grun and the Sylpheed-Claws 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 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 /*
  21  * Functions necessary to access LDAP servers.
  22  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include "config.h"
  26 #endif
  27
  28 #ifdef USE_LDAP
  29
  30 #include <glib.h>
  31 #include <sys/time.h>
  32 #include <string.h>
  33 #include <ldap.h>
  34 #include <lber.h>
  35
  36 #include "mgutils.h"
  37 #include "addritem.h"
  38 #include "addrcache.h"
  39 #include "ldapctrl.h"
  40 #include "ldapquery.h"
  41 #include "ldapserver.h"
  42 #include "utils.h"
  43 #include "adbookbase.h"
  44
  45 /**
  46  * Create new LDAP server interface object with no control object.
  47  * \return Initialized LDAP server object.
  48  */
  49 LdapServer *ldapsvr_create_noctl( void ) {
  50         LdapServer *server;
  51
  52         server = g_new0( LdapServer, 1 );
  53         server->type = ADBOOKTYPE_LDAP;
  54         server->addressCache = addrcache_create();
  55         server->retVal = MGU_SUCCESS;
  56         server->control = NULL;
  57         server->listQuery = NULL;
  58         server->searchFlag = FALSE;
  59         return server;
  60 }
  61
  62 /**
  63  * Create new LDAP server interface object.
  64  * \return Initialized LDAP server object.
  65  */
  66 LdapServer *ldapsvr_create( void ) {
  67         LdapServer *server;
  68
  69         server = ldapsvr_create_noctl();
  70         server->control = ldapctl_create();
  71         return server;
  72 }
  73
  74 /**
  75  * Return name of server.
  76  * \param  server Server object.
  77  * \return Name for server.
  78  */
  79 gchar *ldapsvr_get_name( LdapServer *server ) {
  80         g_return_val_if_fail( server != NULL, NULL );
  81         return addrcache_get_name( server->addressCache );
  82 }
  83
  84 /**
  85  * Specify name to be used.
  86  * \param server Server object.
  87  * \param value      Name for server.
  88  */
  89 void ldapsvr_set_name( LdapServer* server, const gchar *value ) {
  90         g_return_if_fail( server != NULL );
  91         addrcache_set_name( server->addressCache, value );
  92 }
  93
  94 /**
  95  * Refresh internal variables to force a file read.
  96  * \param server Server object.
  97  */
  98 void ldapsvr_force_refresh( LdapServer *server ) {
  99         addrcache_refresh( server->addressCache );
 100 }
 101
 102 /**
 103  * Return status/error code.
 104  * \param  server Server object.
 105  * \return Status/error code.
 106  */
 107 gint ldapsvr_get_status( LdapServer *server ) {
 108         g_return_val_if_fail( server != NULL, -1 );
 109         return server->retVal;
 110 }
 111
 112 /**
 113  * Return reference to root level folder.
 114  * \param  server Server object.
 115  * \return Root level folder.
 116  */
 117 ItemFolder *ldapsvr_get_root_folder( LdapServer *server ) {
 118         g_return_val_if_fail( server != NULL, NULL );
 119         /*
 120         printf( "ldapsvr_get_root_folder/start\n" );
 121         ldapsvr_print_data( server, stdout );
 122         printf( "ldapsvr_get_root_folder/done\n" );
 123         */
 124         return addrcache_get_root_folder( server->addressCache );
 125 }
 126
 127 /**
 128  * Test whether server data has been accessed.
 129  * \param  server Server object.
 130  * \return <i>TRUE</i> if data was accessed.
 131  */
 132 gboolean ldapsvr_get_accessed( LdapServer *server ) {
 133         g_return_val_if_fail( server != NULL, FALSE );
 134         return server->addressCache->accessFlag;
 135 }
 136
 137 /**
 138  * Specify that server's data whas beed accessed.
 139  * \param server Server object.
 140  * \param value      Value for flag.
 141  */
 142 void ldapsvr_set_accessed( LdapServer *server, const gboolean value ) {
 143         g_return_if_fail( server != NULL );
 144         server->addressCache->accessFlag = value;
 145 }
 146
 147 /**
 148  * Test whether server data has been modified.
 149  * \param  server Server object.
 150  * \return <i>TRUE</i> if data was modified.
 151  */
 152 gboolean ldapsvr_get_modified( LdapServer *server ) {
 153         g_return_val_if_fail( server != NULL, FALSE );
 154         return server->addressCache->modified;
 155 }
 156
 157 /**
 158  * Specify modify flag.
 159  * \param server Server object.
 160  * \param value      Value for flag.
 161  */
 162 void ldapsvr_set_modified( LdapServer *server, const gboolean value ) {
 163         g_return_if_fail( server != NULL );
 164         server->addressCache->modified = value;
 165 }
 166
 167 /**
 168  * Test whether data was read from server.
 169  * \param server Server object.
 170  * \return <i>TRUE</i> if data was read.
 171  */
 172 gboolean ldapsvr_get_read_flag( LdapServer *server ) {
 173         g_return_val_if_fail( server != NULL, FALSE );
 174         return server->addressCache->dataRead;
 175 }
 176
 177 /**
 178  * Test whether server is to be used for dynamic searches.
 179  * \param server Server object.
 180  * \return <i>TRUE</i> if server is used for dynamic searches.
 181  */
 182 gboolean ldapsvr_get_search_flag( LdapServer *server ) {
 183         g_return_val_if_fail( server != NULL, FALSE );
 184         return server->searchFlag;
 185 }
 186
 187 /**
 188  * Specify that server is to be used for dynamic searches.
 189  * \param server Server object.
 190  * \param value      Name for server.
 191  */
 192 void ldapsvr_set_search_flag( LdapServer *server, const gboolean value ) {
 193         g_return_if_fail( server != NULL );
 194         server->searchFlag = value;
 195 }
 196
 197 /**
 198  * Specify the reference to control data that will be used for the query. The calling
 199  * module should be responsible for creating and destroying this control object.
 200  * \param server Server object.
 201  * \param ctl    Control data.
 202  */
 203 void ldapsvr_set_control( LdapServer *server, LdapControl *ctl ) {
 204         g_return_if_fail( server != NULL );
 205         addrcache_refresh( server->addressCache );
 206         server->control = ctl;
 207 }
 208
 209 /**
 210  * Free all queries.
 211  * \param server Server object.
 212  */
 213 void ldapsvr_free_all_query( LdapServer *server ) {
 214         GList *node;
 215         g_return_if_fail( server != NULL );
 216
 217         node = server->listQuery;
 218         while( node ) {
 219                 LdapQuery *qry = node->data;
 220                 ldapqry_free( qry );
 221                 node->data = NULL;
 222                 node = g_list_next( node );
 223         }
 224         g_list_free( server->listQuery );
 225         server->listQuery = NULL;
 226 }
 227
 228 /**
 229  * Add query to server.
 230  * \param server Server object.
 231  * \param qry    Query object.
 232  */
 233 void ldapsvr_add_query( LdapServer *server, LdapQuery *qry ) {
 234         g_return_if_fail( server != NULL );
 235         g_return_if_fail( qry != NULL );
 236
 237         server->listQuery = g_list_append( server->listQuery, qry );
 238         qry->server = server;
 239 }
 240
 241 /**
 242  * Free up LDAP server interface object by releasing internal memory.
 243  * \param server Server object.
 244  */
 245 void ldapsvr_free( LdapServer *server ) {
 246         g_return_if_fail( server != NULL );
 247
 248         /* Stop and cancel any queries that may be active */
 249         ldapsvr_stop_all_query( server );
 250         ldapsvr_cancel_all_query( server );
 251
 252         /* Clear cache */
 253         addrcache_clear( server->addressCache );
 254         addrcache_free( server->addressCache );
 255
 256         /* Free LDAP control block */
 257         ldapctl_free( server->control );
 258         server->control = NULL;
 259
 260         /* Free all queries */
 261         ldapsvr_free_all_query( server );
 262
 263         /* Clear pointers */
 264         server->type = ADBOOKTYPE_NONE;
 265         server->addressCache = NULL;
 266         server->retVal = MGU_SUCCESS;
 267         server->listQuery = NULL;
 268         server->searchFlag = FALSE;
 269
 270         /* Now release LDAP object */
 271         g_free( server );
 272 }
 273
 274 /**
 275  * Display object to specified stream.
 276  * \param server Server object.
 277  * \param stream     Output stream.
 278  */
 279 void ldapsvr_print_data( LdapServer *server, FILE *stream ) {
 280         GList *node;
 281         gint  i;
 282
 283         g_return_if_fail( server != NULL );
 284
 285         fprintf( stream, "LdapServer:\n" );
 286         fprintf( stream, "  ret val: %d\n", server->retVal );
 287         fprintf( stream, "srch flag: %s\n",
 288                         server->searchFlag ? "yes" : "no" );
 289         if( server->control ) {
 290                 ldapctl_print( server->control, stream );
 291         }
 292         else {
 293                 fprintf( stream, "  control: NULL\n" );
 294         }
 295         addrcache_print( server->addressCache, stream );
 296         addritem_print_item_folder( server->addressCache->rootFolder, stream );
 297
 298         /* Dump queries */
 299         i = 1;
 300         node = server->listQuery;
 301         while( node ) {
 302                 LdapQuery *qry = node->data;
 303                 fprintf( stream, "    query: %2d : %s\n", i, ADDRQUERY_NAME(qry) );
 304                 i++;
 305                 node = g_list_next( node );
 306         }
 307 }
 308
 309 /**
 310  * Return link list of persons.
 311  * \param server Server object.
 312  * \return List of persons.
 313  */
 314 GList *ldapsvr_get_list_person( LdapServer *server ) {
 315         g_return_val_if_fail( server != NULL, NULL );
 316         return addrcache_get_list_person( server->addressCache );
 317 }
 318
 319 /**
 320  * Return link list of folders. There are no "real" folders that are returned
 321  * from the server.
 322  * \param  server Server object.
 323  * \return List of folders.
 324  */
 325 GList *ldapsvr_get_list_folder( LdapServer *server ) {
 326         g_return_val_if_fail( server != NULL, NULL );
 327         /* return addrcache_get_list_folder( server->addressCache ); */
 328         return NULL;
 329 }
 330
 331 /**
 332  * Execute specified query.
 333  * \param server LDAP server.
 334  * \param qry    LDAP query.
 335  */
 336 void ldapsvr_execute_query( LdapServer *server, LdapQuery *qry ) {
 337         LdapControl *ctlCopy;
 338
 339         g_return_if_fail( server != NULL );
 340         g_return_if_fail( qry != NULL );
 341
 342         /* Copy server's control data to the query */
 343         ctlCopy = ldapctl_create();
 344         ldapctl_copy( server->control, ctlCopy );
 345         ldapqry_set_control( qry, ctlCopy );
 346         ldapqry_initialize();
 347
 348         /* Perform query */
 349         /* printf( "ldapsvr_execute_query::checking query...\n" ); */
 350         if( ldapqry_check_search( qry ) ) {
 351                 /* printf( "ldapsvr_execute_query::reading with thread...\n" ); */
 352                 ldapqry_read_data_th( qry );
 353                 /*
 354                 if( qry->retVal == LDAPRC_SUCCESS ) {
 355                         printf( "ldapsvr_execute_query::SUCCESS with thread...\n" );
 356                 }
 357                 */
 358         }
 359         /* printf( "ldapsvr_execute_query... terminated\n" ); */
 360 }
 361
 362 /**
 363  * Stop all queries for specified ID.
 364  * \param server Server object.
 365  * \param queryID    Query ID to stop.
 366  */
 367 void ldapsvr_stop_query_id( LdapServer *server, const gint queryID ) {
 368         GList *node;
 369         g_return_if_fail( server != NULL );
 370
 371         node = server->listQuery;
 372         while( node ) {
 373                 LdapQuery *qry = node->data;
 374                 if( ADDRQUERY_ID(qry) == queryID ) {
 375                         /* Notify thread to stop */
 376                         ldapqry_set_stop_flag( qry, TRUE );
 377                 }
 378                 node = g_list_next( node );
 379         }
 380 }
 381
 382 /**
 383  * Stop all queries by notifying each thread to stop.
 384  * \param server Server object.
 385  */
 386 void ldapsvr_stop_all_query( LdapServer *server ) {
 387         GList *node;
 388         g_return_if_fail( server != NULL );
 389
 390         node = server->listQuery;
 391         while( node ) {
 392                 LdapQuery *qry = node->data;
 393                 ldapqry_set_stop_flag( qry, TRUE );
 394                 node = g_list_next( node );
 395         }
 396 }
 397
 398 /**
 399  * Cancel all query threads for server.
 400  * \param server Server object.
 401  */
 402 void ldapsvr_cancel_all_query( LdapServer *server ) {
 403         GList *node;
 404         g_return_if_fail( server != NULL );
 405
 406         node = server->listQuery;
 407         while( node ) {
 408                 LdapQuery *qry = node->data;
 409                 /* Notify thread to stop */
 410                 ldapqry_set_stop_flag( qry, TRUE );
 411                 /* Now cancel thread */
 412                 ldapqry_cancel( qry );
 413                 node = g_list_next( node );
 414         }
 415 }
 416
 417 /**
 418  * Search most recent query for specified search term. The most recent
 419  * completed query is returned. If no completed query is found, the most recent
 420  * incomplete is returned.
 421  * \param server LdapServer.
 422  * \param searchTerm Search term to locate.
 423  * \return Query object, or <i>NULL</i> if none found.
 424  */
 425 static LdapQuery *ldapsvr_locate_query(
 426         const LdapServer *server, const gchar *searchTerm )
 427 {
 428         LdapQuery *incomplete = NULL;
 429         GList *node;
 430         g_return_val_if_fail( server != NULL, NULL );
 431
 432         node = server->listQuery;
 433         node = g_list_last( node );
 434         /* Search backwards for query */
 435         while( node ) {
 436                 LdapQuery *qry = node->data;
 437                 if( g_utf8_collate( ADDRQUERY_SEARCHVALUE(qry), searchTerm ) == 0 ) {
 438                         if( qry->agedFlag ) continue;
 439                         if( qry->completed ) {
 440                                 /* Found */
 441                                 return qry;
 442                         }
 443                         if( ! incomplete ) {
 444                                 incomplete = qry;
 445                         }
 446                 }
 447                 node = g_list_previous( node );
 448         }
 449         return incomplete;
 450 }
 451
 452 /**
 453  * Retire aged queries. Only the following queries are retired:
 454  *
 455  * a) Dynamic queries.
 456  * b) Explicit searches that have a hidden folders.
 457  * c) Locate searches that have a hidden folder.
 458  *
 459  * \param server LdapServer.
 460  */
 461 void ldapsvr_retire_query( LdapServer *server ) {
 462         GList *node;
 463         GList *listDelete;
 464         GList *listQuery;
 465         gint maxAge;
 466         LdapControl *ctl;
 467         ItemFolder *folder;
 468
 469         /* printf( "ldapsvr_retire_query\n" ); */
 470         g_return_if_fail( server != NULL );
 471         ctl = server->control;
 472         maxAge = ctl->maxQueryAge;
 473
 474         /* Identify queries to age and move to deletion list */
 475         listDelete = NULL;
 476         node = server->listQuery;
 477         while( node ) {
 478                 LdapQuery *qry = node->data;
 479
 480                 node = g_list_next( node );
 481                 folder = ADDRQUERY_FOLDER(qry);
 482                 if( folder == NULL ) continue;
 483                 if( ! folder->isHidden ) {
 484                         if( ADDRQUERY_SEARCHTYPE(qry) == ADDRSEARCH_EXPLICIT ) continue;
 485                         if( ADDRQUERY_SEARCHTYPE(qry) == ADDRSEARCH_LOCATE ) continue;
 486                 }
 487
 488                 ldapqry_age( qry, maxAge );
 489                 if( qry->agedFlag ) {
 490                         /* Delete folder associated with query */
 491                         /*
 492                         printf( "deleting folder... ::%s::\n", ADDRQUERY_NAME(qry) );
 493                         */
 494                         ldapqry_delete_folder( qry );
 495                         listDelete = g_list_append( listDelete, qry );
 496                 }
 497         }
 498
 499         /* Delete queries */
 500         listQuery = server->listQuery;
 501         node = listDelete;
 502         while( node ) {
 503                 LdapQuery *qry = node->data;
 504
 505                 listQuery = g_list_remove( listQuery, qry );
 506                 ldapqry_free( qry );
 507                 node->data = NULL;
 508                 node = g_list_next( node );
 509         }
 510         server->listQuery = listQuery;
 511
 512         /* Free up deletion list */
 513         g_list_free( listDelete );
 514 }
 515
 516 /**
 517  * Return results of a previous query by executing callback for each address
 518  * contained in specified folder.
 519  *
 520  * \param folder  Address book folder to process.
 521  * \param req Address query request object.
 522  */
 523 static void ldapsvr_previous_query(
 524         const ItemFolder *folder, const QueryRequest *req, AddrQueryObject *aqo )
 525 {
 526         AddrSearchCallbackEntry *callBack;
 527         GList *listEMail;
 528         GList *node;
 529         GList *nodeEM;
 530         gpointer sender;
 531
 532         sender = aqo;
 533         callBack = ( AddrSearchCallbackEntry * ) req->callBackEntry;
 534         if( callBack ) {
 535                 listEMail = NULL;
 536                 node = folder->listPerson;
 537                 while( node ) {
 538                         AddrItemObject *aio = node->data;
 539                         if( aio &&  aio->type == ITEMTYPE_PERSON ) {
 540                                 ItemPerson *person = node->data;
 541                                 nodeEM = person->listEMail;
 542                                 while( nodeEM ) {
 543                                         ItemEMail *email = nodeEM->data;
 544
 545                                         nodeEM = g_list_next( nodeEM );
 546                                         listEMail = g_list_append( listEMail, email );
 547                                 }
 548                         }
 549                         node = g_list_next( node );
 550                 }
 551                 ( callBack ) ( sender, req->queryID, listEMail, NULL );
 552                 /* // g_list_free( listEMail ); */
 553         }
 554 }
 555
 556 /**
 557  * Reuse search results from a previous LDAP query. If there is a query that
 558  * has the same search term as specified in the query request, then the query
 559  * will be reused.
 560  *
 561  * \param server  LDAP server object.
 562  * \param req Address query object.
 563  * \return <i>TRUE</i> if previous query was used.
 564  */
 565 gboolean ldapsvr_reuse_previous( const LdapServer *server, const QueryRequest *req ) {
 566         LdapQuery *qry;
 567         gchar *searchTerm;
 568         ItemFolder *folder;
 569
 570         g_return_val_if_fail( server != NULL, FALSE );
 571         g_return_val_if_fail( req != NULL, FALSE );
 572
 573         searchTerm = req->searchTerm;
 574
 575         /* Test whether any queries for the same term exist */
 576         qry = ldapsvr_locate_query( server, searchTerm );
 577         if( qry ) {
 578                 /* Touch query to ensure it hangs around for a bit longer */
 579                 ldapqry_touch( qry );
 580                 folder = ADDRQUERY_FOLDER(qry);
 581                 if( folder ) {
 582                         ldapsvr_previous_query( folder, req, ADDRQUERY_OBJECT(qry) );
 583                         return TRUE;
 584                 }
 585         }
 586         return FALSE;
 587 }
 588
 589 /**
 590  * Construct a new LdapQuery object that will be used to perform an dynamic
 591  * search request.
 592  *
 593  * \param server LdapServer.
 594  * \param req    Query request.
 595  * \return LdapQuery object, or <i>NULL</i> if none created.
 596  */
 597 LdapQuery *ldapsvr_new_dynamic_search( LdapServer *server, QueryRequest *req )
 598 {
 599         LdapQuery *qry;
 600         gchar *name;
 601         gchar *searchTerm;
 602         ItemFolder *folder;
 603
 604         g_return_val_if_fail( server != NULL, NULL );
 605         g_return_val_if_fail( req != NULL, NULL );
 606
 607         /* Retire any aged queries */
 608         /* // ldapsvr_retire_query( server ); */
 609
 610         /* Name of folder and query */
 611         searchTerm = req->searchTerm;
 612         name = g_strdup_printf( "Search '%s'", searchTerm );
 613
 614         /* Create a folder for the search results */
 615         folder = addrcache_add_new_folder( server->addressCache, NULL );
 616         addritem_folder_set_name( folder, name );
 617         addritem_folder_set_remarks( folder, "" );
 618
 619         /* Construct a query */
 620         qry = ldapqry_create();
 621         ldapqry_set_query_id( qry, req->queryID );
 622         ldapqry_set_search_value( qry, searchTerm );
 623         ldapqry_set_search_type( qry, ADDRSEARCH_DYNAMIC );
 624         ldapqry_set_callback_entry( qry, req->callBackEntry );
 625         ldapqry_set_callback_end( qry, req->callBackEnd );
 626
 627         /* Specify folder type and back reference */
 628         ADDRQUERY_FOLDER(qry) = folder;
 629         folder->folderType = ADDRFOLDER_QUERY_RESULTS;
 630         folder->folderData = ( gpointer ) qry;
 631         folder->isHidden = TRUE;
 632
 633         /* Name the query */
 634         ldapqry_set_name( qry, name );
 635         g_free( name );
 636
 637         /* Add query to request */
 638         qryreq_add_query( req, ADDRQUERY_OBJECT(qry) );
 639
 640         /* Now start the search */
 641         ldapsvr_add_query( server, qry );
 642
 643         return qry;
 644 }
 645
 646 /**
 647  * Construct a new LdapQuery object that will be used to perform an explicit
 648  * search request.
 649  *
 650  * \param server LdapServer.
 651  * \param req    Query request.
 652  * \param folder Folder that will be used to contain search results.
 653  * \return LdapQuery object, or <i>NULL</i> if none created.
 654  */
 655 LdapQuery *ldapsvr_new_explicit_search(
 656                 LdapServer *server, QueryRequest *req, ItemFolder *folder )
 657 {
 658         LdapQuery *qry;
 659         gchar *searchTerm;
 660         gchar *name;
 661
 662         g_return_val_if_fail( server != NULL, NULL );
 663         g_return_val_if_fail( req != NULL, NULL );
 664         g_return_val_if_fail( folder != NULL, NULL );
 665
 666         /* Retire any aged queries */
 667         /* // ldapsvr_retire_query( server ); */
 668
 669         /* Name the query */
 670         searchTerm = req->searchTerm;
 671         name = g_strdup_printf( "Explicit search for '%s'", searchTerm );
 672
 673         /* Construct a query */
 674         qry = ldapqry_create();
 675         ldapqry_set_query_id( qry, req->queryID );
 676         ldapqry_set_name( qry, name );
 677         ldapqry_set_search_value( qry, searchTerm );
 678         ldapqry_set_search_type( qry, ADDRSEARCH_EXPLICIT );
 679         ldapqry_set_callback_end( qry, req->callBackEnd );
 680         ldapqry_set_callback_entry( qry, req->callBackEntry );
 681
 682         /* Specify folder type and back reference */
 683         ADDRQUERY_FOLDER(qry) = folder;
 684         folder->folderType = ADDRFOLDER_QUERY_RESULTS;
 685         folder->folderData = ( gpointer ) qry;
 686
 687         /* Setup server */
 688         ldapsvr_add_query( server, qry );
 689
 690         /* Set up query request */
 691         qryreq_add_query( req, ADDRQUERY_OBJECT(qry) );
 692
 693         g_free( name );
 694
 695         return qry;
 696 }
 697
 698 #endif  /* USE_LDAP */
 699
 700 /*
 701  * End of Source.
 702  */
 703