git.sur5r.net Git - openldap/blob - libraries/libldap/tmplout.c

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
   4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   5  */
   6 /*
   7  * tmplout.c:  display template library output routines for LDAP clients
   8  * 12 April 1994 by Mark C Smith
   9  */
  10
  11 #include "portable.h"
  12
  13 #include <stdio.h>
  14
  15 #include <ac/socket.h>
  16 #include <ac/stdlib.h>
  17
  18 #include <ac/ctype.h>
  19 #include <ac/string.h>
  20 #include <ac/time.h>
  21
  22 #ifdef HAVE_SYS_FILE_H
  23 #include <sys/file.h>
  24 #endif
  25
  26 #include <ldap.h>
  27 #include <disptmpl.h>
  28
  29 #include "ldap_log.h"
  30
  31 #include "ldap-int.h"
  32 #include "ldap_defaults.h"
  33
  34 #define writeptype ldap_writeptype
  35
  36 /* local functions */
  37 static int do_entry2text LDAP_P((
  38         LDAP *ld, char *buf, char *base, LDAPMessage *entry,
  39         struct ldap_disptmpl *tmpl, char **defattrs, char ***defvals,
  40         writeptype writeproc, void *writeparm, char *eol, int rdncount,
  41         unsigned long opts, char *urlprefix ));
  42 static int do_entry2text_search LDAP_P((
  43         LDAP *ld, char *dn, char *base,
  44         LDAPMessage *entry, struct ldap_disptmpl *tmpllist, char **defattrs,
  45         char ***defvals, writeptype writeproc, void *writeparm, char *eol,
  46         int rdncount, unsigned long opts, char *urlprefix ));
  47 static int do_vals2text LDAP_P((
  48         LDAP *ld, char *buf, char **vals, char *label,
  49         int labelwidth, unsigned long syntaxid, writeptype writeproc,
  50         void *writeparm, char *eol, int rdncount, char *urlprefix ));
  51 static int max_label_len LDAP_P(( struct ldap_disptmpl *tmpl ));
  52 static int output_label LDAP_P((
  53         char *buf, char *label, int width,
  54         writeptype writeproc, void *writeparm, char *eol, int html ));
  55 static int output_dn LDAP_P((
  56         char *buf, char *dn, int width, int rdncount,
  57         writeptype writeproc, void *writeparm, char *eol, char *urlprefix ));
  58 static void strcat_escaped LDAP_P(( char *s1, char *s2 ));
  59 static char *time2text LDAP_P(( char *ldtimestr, int dateonly ));
  60 static long gtime LDAP_P(( struct tm *tm ));
  61 static int searchaction LDAP_P((
  62         LDAP *ld, char *buf, char *base, LDAPMessage *entry,
  63         char *dn, struct ldap_tmplitem *tip, int labelwidth, int rdncount,
  64         writeptype writeproc, void *writeparm, char *eol, char *urlprefix ));
  65
  66 #define DEF_LABEL_WIDTH         15
  67 #define SEARCH_TIMEOUT_SECS     120
  68 #define OCATTRNAME              "objectClass"
  69
  70
  71 #define NONFATAL_LDAP_ERR( err )        ( (err) == LDAP_SUCCESS || \
  72         (err) == LDAP_TIMELIMIT_EXCEEDED || (err) == LDAP_SIZELIMIT_EXCEEDED )
  73
  74 #define DEF_LDAP_URL_PREFIX     "ldap:///"
  75
  76
  77 int
  78 ldap_entry2text(
  79         LDAP                    *ld,
  80         char                    *buf,           /* NULL for "use internal" */
  81         LDAPMessage             *entry,
  82         struct ldap_disptmpl    *tmpl,
  83         char                    **defattrs,
  84         char                    ***defvals,
  85         writeptype              writeproc,
  86         void                    *writeparm,
  87         char                    *eol,
  88         int                     rdncount,
  89         unsigned long           opts
  90 )
  91 {
  92     Debug( LDAP_DEBUG_TRACE, "ldap_entry2text\n", 0, 0, 0 );
  93
  94     return( do_entry2text( ld, buf, NULL, entry, tmpl, defattrs, defvals,
  95                 writeproc, writeparm, eol, rdncount, opts, NULL ));
  96
  97 }
  98
  99
 100
 101 int
 102 ldap_entry2html(
 103         LDAP                    *ld,
 104         char                    *buf,           /* NULL for "use internal" */
 105         LDAPMessage             *entry,
 106         struct ldap_disptmpl    *tmpl,
 107         char                    **defattrs,
 108         char                    ***defvals,
 109         writeptype              writeproc,
 110         void                    *writeparm,
 111         char                    *eol,
 112         int                     rdncount,
 113         unsigned long           opts,
 114         char                    *base,
 115         char                    *urlprefix
 116 )
 117 {
 118     Debug( LDAP_DEBUG_TRACE, "ldap_entry2html\n", 0, 0, 0 );
 119
 120     if ( urlprefix == NULL ) {
 121         urlprefix = DEF_LDAP_URL_PREFIX;
 122     }
 123
 124     return( do_entry2text( ld, buf, base, entry, tmpl, defattrs, defvals,
 125                 writeproc, writeparm, eol, rdncount, opts, urlprefix ));
 126 }
 127
 128
 129 static int
 130 do_entry2text(
 131         LDAP                    *ld,
 132         char                    *buf,           /* NULL for use-internal */
 133         char                    *base,          /* used for search actions */
 134         LDAPMessage             *entry,
 135         struct ldap_disptmpl    *tmpl,
 136         char                    **defattrs,
 137         char                    ***defvals,
 138         writeptype              writeproc,
 139         void                    *writeparm,
 140         char                    *eol,
 141         int                     rdncount,
 142         unsigned long           opts,
 143         char                    *urlprefix      /* if non-NULL, do HTML */
 144 )
 145 {
 146     int                         i, err, html, show, labelwidth;
 147     int                         freebuf,  freevals;
 148     char                        *dn, **vals;
 149     struct ldap_tmplitem        *rowp, *colp;
 150
 151     if (( dn = ldap_get_dn( ld, entry )) == NULL ) {
 152         return( ld->ld_errno );
 153     }
 154
 155     if ( buf == NULL ) {
 156         if (( buf = LDAP_MALLOC( LDAP_DTMPL_BUFSIZ )) == NULL ) {
 157             ld->ld_errno = LDAP_NO_MEMORY;
 158             LDAP_FREE( dn );
 159             return( ld->ld_errno );
 160         }
 161         freebuf = 1;
 162     } else {
 163         freebuf = 0;
 164     }
 165
 166     html = ( urlprefix != NULL );
 167
 168     if ( html ) {
 169         /*
 170          * add HTML intro. and title
 171          */
 172         if (!(( opts & LDAP_DISP_OPT_HTMLBODYONLY ) != 0 )) {
 173             sprintf( buf, "<HTML>%s<HEAD>%s<TITLE>%s%s - ", eol, eol, eol,
 174                     ( tmpl == NULL ) ? "Entry" : tmpl->dt_name );
 175             (*writeproc)( writeparm, buf, strlen( buf ));
 176             output_dn( buf, dn, 0, rdncount, writeproc, writeparm, "", NULL );
 177             sprintf( buf, "%s</TITLE>%s</HEAD>%s<BODY>%s<H3>%s - ", eol, eol,
 178                     eol, eol, ( tmpl == NULL ) ? "Entry" : tmpl->dt_name );
 179             (*writeproc)( writeparm, buf, strlen( buf ));
 180             output_dn( buf, dn, 0, rdncount, writeproc, writeparm, "", NULL );
 181             sprintf( buf, "</H3>%s", eol );
 182             (*writeproc)( writeparm, buf, strlen( buf ));
 183         }
 184
 185         if (( opts & LDAP_DISP_OPT_NONLEAF ) != 0 &&
 186                 ( vals = ldap_explode_dn( dn, 0 )) != NULL ) {
 187             char        *untagged;
 188
 189             /*
 190              * add "Move Up" link
 191              */
 192             sprintf( buf, "<A HREF=\"%s", urlprefix );
 193             for ( i = 1; vals[ i ] != NULL; ++i ) {
 194                 if ( i > 1 ) {
 195                      strcat_escaped( buf, ", " );
 196                 }
 197                 strcat_escaped( buf, vals[ i ] );
 198             }
 199             if ( vals[ 1 ] != NULL ) {
 200                 untagged = strchr( vals[ 1 ], '=' );
 201             } else {
 202                 untagged = "=The World";
 203             }
 204             sprintf( buf + strlen( buf ),
 205                     "%s\">Move Up To <EM>%s</EM></A>%s<BR>",
 206                     ( vals[ 1 ] == NULL ) ? "??one" : "",
 207                     ( untagged != NULL ) ? untagged + 1 : vals[ 1 ], eol );
 208             (*writeproc)( writeparm, buf, strlen( buf ));
 209
 210             /*
 211              * add "Browse" link
 212              */
 213             untagged = strchr( vals[ 0 ], '=' );
 214             sprintf( buf, "<A HREF=\"%s", urlprefix );
 215             strcat_escaped( buf, dn );
 216             sprintf( buf + strlen( buf ), "??one?(!(objectClass=dsa))\">Browse Below <EM>%s</EM></A>%s%s",
 217                     ( untagged != NULL ) ? untagged + 1 : vals[ 0 ], eol, eol );
 218             (*writeproc)( writeparm, buf, strlen( buf ));
 219
 220             ldap_value_free( vals );
 221         }
 222
 223         (*writeproc)( writeparm, "<HR>", 4 );   /* horizontal rule */
 224     } else {
 225         (*writeproc)( writeparm, "\"", 1 );
 226         output_dn( buf, dn, 0, rdncount, writeproc, writeparm, "", NULL );
 227         sprintf( buf, "\"%s", eol );
 228         (*writeproc)( writeparm, buf, strlen( buf ));
 229     }
 230
 231     if ( tmpl != NULL && ( opts & LDAP_DISP_OPT_AUTOLABELWIDTH ) != 0 ) {
 232         labelwidth = max_label_len( tmpl ) + 3;
 233     } else {
 234         labelwidth = DEF_LABEL_WIDTH;;
 235     }
 236
 237     err = LDAP_SUCCESS;
 238
 239     if ( tmpl == NULL ) {
 240         BerElement      *ber;
 241         char            *attr;
 242
 243         ber = NULL;
 244         for ( attr = ldap_first_attribute( ld, entry, &ber );
 245                 NONFATAL_LDAP_ERR( err ) && attr != NULL;
 246                 attr = ldap_next_attribute( ld, entry, ber )) {
 247             if (( vals = ldap_get_values( ld, entry, attr )) == NULL ) {
 248                 freevals = 0;
 249                 if ( defattrs != NULL ) {
 250                     for ( i = 0; defattrs[ i ] != NULL; ++i ) {
 251                         if ( strcasecmp( attr, defattrs[ i ] ) == 0 ) {
 252                             break;
 253                         }
 254                     }
 255                     if ( defattrs[ i ] != NULL ) {
 256                         vals = defvals[ i ];
 257                     }
 258                 }
 259             } else {
 260                 freevals = 1;
 261             }
 262
 263             *attr = TOUPPER( (unsigned char) *attr );
 264
 265             err = do_vals2text( ld, buf, vals, attr, labelwidth,
 266                     LDAP_SYN_CASEIGNORESTR, writeproc, writeparm, eol,
 267                     rdncount, urlprefix );
 268             if ( freevals ) {
 269                 ldap_value_free( vals );
 270             }
 271         }
 272
 273         if( ber != NULL) {
 274                 ber_free( ber, 0 );
 275         }
 276     } else {
 277         for ( rowp = ldap_first_tmplrow( tmpl );
 278                 NONFATAL_LDAP_ERR( err ) && rowp != NULL;
 279                 rowp = ldap_next_tmplrow( tmpl, rowp )) {
 280             for ( colp = ldap_first_tmplcol( tmpl, rowp ); colp != NULL;
 281                     colp = ldap_next_tmplcol( tmpl, rowp, colp )) {
 282                 vals = NULL;
 283                 if ( colp->ti_attrname == NULL || ( vals = ldap_get_values( ld,
 284                         entry, colp->ti_attrname )) == NULL ) {
 285                     freevals = 0;
 286                     if ( !LDAP_IS_TMPLITEM_OPTION_SET( colp,
 287                             LDAP_DITEM_OPT_HIDEIFEMPTY ) && defattrs != NULL
 288                             && colp->ti_attrname != NULL ) {
 289                         for ( i = 0; defattrs[ i ] != NULL; ++i ) {
 290                             if ( strcasecmp( colp->ti_attrname, defattrs[ i ] )
 291                                     == 0 ) {
 292                                 break;
 293                             }
 294                         }
 295                         if ( defattrs[ i ] != NULL ) {
 296                             vals = defvals[ i ];
 297                         }
 298                     }
 299                 } else {
 300                     freevals = 1;
 301                     if ( LDAP_IS_TMPLITEM_OPTION_SET( colp,
 302                             LDAP_DITEM_OPT_SORTVALUES ) && vals[ 0 ] != NULL
 303                             && vals[ 1 ] != NULL ) {
 304                         ldap_sort_values( ld, vals, ldap_sort_strcasecmp );
 305                     }
 306                 }
 307
 308                 /*
 309                  * don't bother even calling do_vals2text() if no values
 310                  * or boolean with value false and "hide if false" option set
 311                  */
 312                 show = ( vals != NULL && vals[ 0 ] != NULL );
 313                 if ( show && LDAP_GET_SYN_TYPE( colp->ti_syntaxid )
 314                         == LDAP_SYN_TYPE_BOOLEAN && LDAP_IS_TMPLITEM_OPTION_SET(
 315                         colp, LDAP_DITEM_OPT_HIDEIFFALSE ) &&
 316                         TOUPPER( (unsigned char) vals[ 0 ][ 0 ] ) != 'T' ) {
 317                     show = 0;
 318                 }
 319
 320                 if ( colp->ti_syntaxid == LDAP_SYN_SEARCHACTION ) {
 321                     if (( opts & LDAP_DISP_OPT_DOSEARCHACTIONS ) != 0 ) {
 322                         if ( colp->ti_attrname == NULL || ( show &&
 323                                 TOUPPER( (unsigned char) vals[ 0 ][ 0 ] ) == 'T' )) {
 324                             err = searchaction( ld, buf, base, entry, dn, colp,
 325                                     labelwidth, rdncount, writeproc,
 326                                     writeparm, eol, urlprefix );
 327                         }
 328                     }
 329                     show = 0;
 330                 }
 331
 332                 if ( show ) {
 333                     err = do_vals2text( ld, buf, vals, colp->ti_label,
 334                         labelwidth, colp->ti_syntaxid, writeproc, writeparm,
 335                         eol, rdncount, urlprefix );
 336                 }
 337
 338                 if ( freevals ) {
 339                     ldap_value_free( vals );
 340                 }
 341             }
 342         }
 343     }
 344
 345     if ( html  && !(( opts & LDAP_DISP_OPT_HTMLBODYONLY ) != 0 )) {
 346         sprintf( buf, "</BODY>%s</HTML>%s", eol, eol );
 347         (*writeproc)( writeparm, buf, strlen( buf ));
 348     }
 349
 350     LDAP_FREE( dn );
 351     if ( freebuf ) {
 352         LDAP_FREE( buf );
 353     }
 354
 355     return( err );
 356 }
 357
 358
 359 int
 360 ldap_entry2text_search(
 361         LDAP                    *ld,
 362         char                    *dn,            /* if NULL, use entry */
 363         char                    *base,          /* if NULL, no search actions */
 364         LDAPMessage             *entry,         /* if NULL, use dn */
 365         struct ldap_disptmpl*   tmpllist,       /* if NULL, load default file */
 366         char                    **defattrs,
 367         char                    ***defvals,
 368         writeptype              writeproc,
 369         void                    *writeparm,
 370         char                    *eol,
 371         int                     rdncount,       /* if 0, display full DN */
 372         unsigned long           opts
 373 )
 374 {
 375     Debug( LDAP_DEBUG_TRACE, "ldap_entry2text_search\n", 0, 0, 0 );
 376
 377     return( do_entry2text_search( ld, dn, base, entry, tmpllist, defattrs,
 378             defvals, writeproc, writeparm, eol, rdncount, opts, NULL ));
 379 }
 380
 381
 382
 383 int
 384 ldap_entry2html_search(
 385         LDAP                    *ld,
 386         char                    *dn,            /* if NULL, use entry */
 387         char                    *base,          /* if NULL, no search actions */
 388         LDAPMessage             *entry,         /* if NULL, use dn */
 389         struct ldap_disptmpl*   tmpllist,       /* if NULL, load default file */
 390         char                    **defattrs,
 391         char                    ***defvals,
 392         writeptype              writeproc,
 393         void                    *writeparm,
 394         char                    *eol,
 395         int                     rdncount,       /* if 0, display full DN */
 396         unsigned long           opts,
 397         char                    *urlprefix
 398 )
 399 {
 400     Debug( LDAP_DEBUG_TRACE, "ldap_entry2html_search\n", 0, 0, 0 );
 401
 402     return( do_entry2text_search( ld, dn, base, entry, tmpllist, defattrs,
 403             defvals, writeproc, writeparm, eol, rdncount, opts, urlprefix ));
 404 }
 405
 406
 407 static int
 408 do_entry2text_search(
 409         LDAP                    *ld,
 410         char                    *dn,            /* if NULL, use entry */
 411         char                    *base,          /* if NULL, no search actions */
 412         LDAPMessage             *entry,         /* if NULL, use dn */
 413         struct ldap_disptmpl*   tmpllist,       /* if NULL, load default file */
 414         char                    **defattrs,
 415         char                    ***defvals,
 416         writeptype              writeproc,
 417         void                    *writeparm,
 418         char                    *eol,
 419         int                     rdncount,       /* if 0, display full DN */
 420         unsigned long           opts,
 421         char                    *urlprefix
 422 )
 423 {
 424     int                         err, freedn, freetmpls, html;
 425     char                        *buf, **fetchattrs, **vals;
 426     LDAPMessage                 *ldmp;
 427     struct ldap_disptmpl        *tmpl;
 428     struct timeval              timeout;
 429
 430     if ( dn == NULL && entry == NULL ) {
 431         ld->ld_errno = LDAP_PARAM_ERROR;
 432         return( ld->ld_errno );
 433     }
 434
 435     html = ( urlprefix != NULL );
 436
 437     timeout.tv_sec = SEARCH_TIMEOUT_SECS;
 438     timeout.tv_usec = 0;
 439
 440     if (( buf = LDAP_MALLOC( LDAP_DTMPL_BUFSIZ )) == NULL ) {
 441         ld->ld_errno = LDAP_NO_MEMORY;
 442         return( ld->ld_errno );
 443     }
 444
 445     freedn = freetmpls = 0;
 446     tmpl = NULL;
 447
 448     if ( tmpllist == NULL ) {
 449         if (( err = ldap_init_templates( TEMPLATEFILE, &tmpllist )) != 0 ) {
 450             sprintf( buf, "%sUnable to read template file %s (error %d)%s%s",
 451                     html ? "<!-- " : "", TEMPLATEFILE, err,
 452                     html ? "-->" : "", eol );
 453             (*writeproc)( writeparm, buf, strlen( buf ));
 454         }
 455         freetmpls = 1;
 456     }
 457
 458     if ( dn == NULL ) {
 459         if (( dn = ldap_get_dn( ld, entry )) == NULL ) {
 460             LDAP_FREE( buf );
 461             if ( freetmpls ) {
 462                 ldap_free_templates( tmpllist );
 463             }
 464             return( ld->ld_errno );
 465         }
 466         freedn = 1;
 467     }
 468
 469
 470     if ( tmpllist != NULL ) {
 471         ldmp = NULL;
 472
 473         if ( entry == NULL ) {
 474             char        *ocattrs[2];
 475
 476             ocattrs[0] = OCATTRNAME;
 477             ocattrs[1] = NULL;
 478 #ifdef LDAP_CONNECTIONLESS
 479             if ( LDAP_IS_CLDAP( ld ))
 480                     err = cldap_search_s( ld, dn, LDAP_SCOPE_BASE,
 481                         NULL, ocattrs, 0, &ldmp, NULL );
 482             else
 483 #endif /* LDAP_CONNECTIONLESS */
 484                     err = ldap_search_st( ld, dn, LDAP_SCOPE_BASE,
 485                             NULL, ocattrs, 0, &timeout, &ldmp );
 486
 487             if ( err == LDAP_SUCCESS ) {
 488                 entry = ldap_first_entry( ld, ldmp );
 489             }
 490         }
 491
 492         if ( entry != NULL ) {
 493             vals = ldap_get_values( ld, entry, OCATTRNAME );
 494             tmpl = ldap_oc2template( vals, tmpllist );
 495             if ( vals != NULL ) {
 496                 ldap_value_free( vals );
 497             }
 498         }
 499         if ( ldmp != NULL ) {
 500             ldap_msgfree( ldmp );
 501         }
 502     }
 503
 504     entry = NULL;
 505
 506     if ( tmpl == NULL ) {
 507         fetchattrs = NULL;
 508     } else {
 509         fetchattrs = ldap_tmplattrs( tmpl, NULL, 1, LDAP_SYN_OPT_DEFER );
 510     }
 511
 512 #ifdef LDAP_CONNECTIONLESS
 513     if ( LDAP_IS_CLDAP( ld ))
 514         err = cldap_search_s( ld, dn, LDAP_SCOPE_BASE, NULL,
 515                 fetchattrs, 0, &ldmp, NULL );
 516     else
 517 #endif /* LDAP_CONNECTIONLESS */
 518         err = ldap_search_st( ld, dn, LDAP_SCOPE_BASE, NULL,
 519                 fetchattrs, 0, &timeout, &ldmp );
 520
 521     if ( freedn ) {
 522         LDAP_FREE( dn );
 523     }
 524     if ( fetchattrs != NULL ) {
 525         ldap_value_free( fetchattrs );
 526     }
 527
 528     if ( err != LDAP_SUCCESS ||
 529             ( entry = ldap_first_entry( ld, ldmp )) == NULL ) {
 530         if ( freetmpls ) {
 531             ldap_free_templates( tmpllist );
 532         }
 533         LDAP_FREE( buf );
 534         return( ld->ld_errno );
 535     }
 536
 537     err = do_entry2text( ld, buf, base, entry, tmpl, defattrs, defvals,
 538             writeproc, writeparm, eol, rdncount, opts, urlprefix );
 539
 540     LDAP_FREE( buf );
 541     if ( freetmpls ) {
 542         ldap_free_templates( tmpllist );
 543     }
 544     ldap_msgfree( ldmp );
 545     return( err );
 546 }
 547
 548
 549 int
 550 ldap_vals2text(
 551         LDAP                    *ld,
 552         char                    *buf,           /* NULL for "use internal" */
 553         char                    **vals,
 554         char                    *label,
 555         int                     labelwidth,     /* 0 means use default */
 556         unsigned long           syntaxid,
 557         writeptype              writeproc,
 558         void                    *writeparm,
 559         char                    *eol,
 560         int                     rdncount
 561 )
 562 {
 563     Debug( LDAP_DEBUG_TRACE, "ldap_vals2text\n", 0, 0, 0 );
 564
 565     return( do_vals2text( ld, buf, vals, label, labelwidth, syntaxid,
 566                 writeproc, writeparm, eol, rdncount, NULL ));
 567 }
 568
 569
 570 int
 571 ldap_vals2html(
 572         LDAP                    *ld,
 573         char                    *buf,           /* NULL for "use internal" */
 574         char                    **vals,
 575         char                    *label,
 576         int                     labelwidth,     /* 0 means use default */
 577         unsigned long           syntaxid,
 578         writeptype              writeproc,
 579         void                    *writeparm,
 580         char                    *eol,
 581         int                     rdncount,
 582         char                    *urlprefix
 583 )
 584 {
 585     Debug( LDAP_DEBUG_TRACE, "ldap_vals2html\n", 0, 0, 0 );
 586
 587     if ( urlprefix == NULL ) {
 588         urlprefix = DEF_LDAP_URL_PREFIX;
 589     }
 590
 591     return( do_vals2text( ld, buf, vals, label, labelwidth, syntaxid,
 592                 writeproc, writeparm, eol, rdncount, urlprefix ));
 593 }
 594
 595
 596 static int
 597 do_vals2text(
 598         LDAP                    *ld,
 599         char                    *buf,           /* NULL for "use internal" */
 600         char                    **vals,
 601         char                    *label,
 602         int                     labelwidth,     /* 0 means use default */
 603         unsigned long           syntaxid,
 604         writeptype              writeproc,
 605         void                    *writeparm,
 606         char                    *eol,
 607         int                     rdncount,
 608         char                    *urlprefix
 609 )
 610 {
 611     int         i, html, writeoutval, freebuf, notascii;
 612     char        *p, *s, *outval;
 613
 614
 615     if ( vals == NULL ) {
 616         return( LDAP_SUCCESS );
 617     }
 618
 619     html = ( urlprefix != NULL );
 620
 621     switch( LDAP_GET_SYN_TYPE( syntaxid )) {
 622     case LDAP_SYN_TYPE_TEXT:
 623     case LDAP_SYN_TYPE_BOOLEAN:
 624         break;          /* we only bother with these two types... */
 625     default:
 626         return( LDAP_SUCCESS );
 627     }
 628
 629     if ( labelwidth == 0 || labelwidth < 0 ) {
 630         labelwidth = DEF_LABEL_WIDTH;
 631     }
 632
 633     if ( buf == NULL ) {
 634         if (( buf = LDAP_MALLOC( LDAP_DTMPL_BUFSIZ )) == NULL ) {
 635             ld->ld_errno = LDAP_NO_MEMORY;
 636             return( ld->ld_errno );
 637         }
 638         freebuf = 1;
 639     } else {
 640         freebuf = 0;
 641     }
 642
 643     output_label( buf, label, labelwidth, writeproc, writeparm, eol, html );
 644
 645     for ( i = 0; vals[ i ] != NULL; ++i ) {
 646         for ( p = vals[ i ]; *p != '\0'; ++p ) {
 647             if ( !isascii( *p )) {
 648                 break;
 649             }
 650         }
 651         notascii = ( *p != '\0' );
 652         outval = notascii ? "(unable to display non-ASCII text value)"
 653                 : vals[ i ];
 654
 655         writeoutval = 0;        /* if non-zero, write outval after switch */
 656
 657         switch( syntaxid ) {
 658         case LDAP_SYN_CASEIGNORESTR:
 659             ++writeoutval;
 660             break;
 661
 662         case LDAP_SYN_RFC822ADDR:
 663             if ( html ) {
 664                 strcpy( buf, "<DD><A HREF=\"mailto:" );
 665                 strcat_escaped( buf, outval );
 666                 sprintf( buf + strlen( buf ), "\">%s</A><BR>%s", outval, eol );
 667                 (*writeproc)( writeparm, buf, strlen( buf ));
 668             } else {
 669                 ++writeoutval;
 670             }
 671             break;
 672
 673         case LDAP_SYN_DN:       /* for now */
 674             output_dn( buf, outval, labelwidth, rdncount, writeproc,
 675                     writeparm, eol, urlprefix );
 676             break;
 677
 678         case LDAP_SYN_MULTILINESTR:
 679             if ( i > 0 && !html ) {
 680                 output_label( buf, label, labelwidth, writeproc,
 681                         writeparm, eol, html );
 682             }
 683
 684             p = s = outval;
 685             while (( s = strchr( s, '$' )) != NULL ) {
 686                 *s++ = '\0';
 687                 while ( isspace( (unsigned char) *s )) {
 688                     ++s;
 689                 }
 690                 if ( html ) {
 691                     sprintf( buf, "<DD>%s<BR>%s", p, eol );
 692                 } else {
 693                     sprintf( buf, "%-*s%s%s", labelwidth, " ", p, eol );
 694                 }
 695                 (*writeproc)( writeparm, buf, strlen( buf ));
 696                 p = s;
 697             }
 698             outval = p;
 699             ++writeoutval;
 700             break;
 701
 702         case LDAP_SYN_BOOLEAN:
 703             outval = TOUPPER((unsigned char) outval[0]) == 'T' ? "TRUE" : "FALSE";
 704             ++writeoutval;
 705             break;
 706
 707         case LDAP_SYN_TIME:
 708         case LDAP_SYN_DATE:
 709             outval = time2text( outval, syntaxid == LDAP_SYN_DATE );
 710             ++writeoutval;
 711             break;
 712
 713         case LDAP_SYN_LABELEDURL:
 714             if ( !notascii && ( p = strchr( outval, '$' )) != NULL ) {
 715                 *p++ = '\0';
 716                 while ( isspace( (unsigned char) *p )) {
 717                     ++p;
 718                 }
 719                 s = outval;
 720             } else if ( !notascii && ( s = strchr( outval, ' ' )) != NULL ) {
 721                 *s++ = '\0';
 722                 while ( isspace( (unsigned char) *s )) {
 723                     ++s;
 724                 }
 725                 p = outval;
 726             } else {
 727                 s = "URL";
 728                 p = outval;
 729             }
 730
 731             /*
 732              * at this point `s' points to the label & `p' to the URL
 733              */
 734             if ( html ) {
 735                 sprintf( buf, "<DD><A HREF=\"%s\">%s</A><BR>%s", p, s, eol );
 736             } else {
 737                 sprintf( buf, "%-*s%s%s%-*s%s%s", labelwidth, " ",
 738                     s, eol, labelwidth + 2, " ",p , eol );
 739             }
 740             (*writeproc)( writeparm, buf, strlen( buf ));
 741             break;
 742
 743         default:
 744             sprintf( buf, " Can't display item type %ld%s",
 745                     syntaxid, eol );
 746             (*writeproc)( writeparm, buf, strlen( buf ));
 747         }
 748
 749         if ( writeoutval ) {
 750             if ( html ) {
 751                 sprintf( buf, "<DD>%s<BR>%s", outval, eol );
 752             } else {
 753                 sprintf( buf, "%-*s%s%s", labelwidth, " ", outval, eol );
 754             }
 755             (*writeproc)( writeparm, buf, strlen( buf ));
 756         }
 757     }
 758
 759     if ( freebuf ) {
 760         LDAP_FREE( buf );
 761     }
 762
 763     return( LDAP_SUCCESS );
 764 }
 765
 766
 767 static int
 768 max_label_len( struct ldap_disptmpl *tmpl )
 769 {
 770     struct ldap_tmplitem        *rowp, *colp;
 771     int                         len, maxlen;
 772
 773     maxlen = 0;
 774
 775     for ( rowp = ldap_first_tmplrow( tmpl ); rowp != NULL;
 776             rowp = ldap_next_tmplrow( tmpl, rowp )) {
 777         for ( colp = ldap_first_tmplcol( tmpl, rowp ); colp != NULL;
 778                 colp = ldap_next_tmplcol( tmpl, rowp, colp )) {
 779             if (( len = strlen( colp->ti_label )) > maxlen ) {
 780                 maxlen = len;
 781             }
 782         }
 783     }
 784
 785     return( maxlen );
 786 }
 787
 788
 789 static int
 790 output_label( char *buf, char *label, int width, writeptype writeproc,
 791         void *writeparm, char *eol, int html )
 792 {
 793     char        *p;
 794
 795     if ( html ) {
 796         sprintf( buf, "<DT><B>%s</B>", label );
 797     } else {
 798         sprintf( buf, " %s:", label );
 799         p = buf + strlen( buf );
 800
 801         while ( p - buf < width ) {
 802             *p++ = ' ';
 803         }
 804
 805         *p = '\0';
 806         strcat( buf, eol );
 807     }
 808
 809     return ((*writeproc)( writeparm, buf, strlen( buf )));
 810 }
 811
 812
 813 static int
 814 output_dn( char *buf, char *dn, int width, int rdncount,
 815         writeptype writeproc, void *writeparm, char *eol, char *urlprefix )
 816 {
 817     char        **dnrdns;
 818     int         i;
 819
 820     if (( dnrdns = ldap_explode_dn( dn, 1 )) == NULL ) {
 821         return( -1 );
 822     }
 823
 824     if ( urlprefix != NULL ) {
 825         sprintf( buf, "<DD><A HREF=\"%s", urlprefix );
 826         strcat_escaped( buf, dn );
 827         strcat( buf, "\">" );
 828     } else if ( width > 0 ) {
 829         sprintf( buf, "%-*s", width, " " );
 830     } else {
 831         *buf = '\0';
 832     }
 833
 834     for ( i = 0; dnrdns[ i ] != NULL && ( rdncount == 0 || i < rdncount );
 835             ++i ) {
 836         if ( i > 0 ) {
 837             strcat( buf, ", " );
 838         }
 839         strcat( buf, dnrdns[ i ] );
 840     }
 841
 842     if ( urlprefix != NULL ) {
 843         strcat( buf, "</A><BR>" );
 844     }
 845
 846     ldap_value_free( dnrdns );
 847
 848     strcat( buf, eol );
 849
 850     return ((*writeproc)( writeparm, buf, strlen( buf )));
 851 }
 852
 853
 854
 855 #define HREF_CHAR_ACCEPTABLE( c )       (( (c) >= '-' && (c) <= '9' ) || \
 856                                          ( (c) >= '@' && (c) <= 'Z' ) || \
 857                                          ( (c) == '_' )               || \
 858                                          ( (c) >= 'a' && (c) <= 'z' ))
 859
 860 static void
 861 strcat_escaped( char *s1, char *s2 )
 862 {
 863     char        *p, *q;
 864     char        *hexdig = "0123456789ABCDEF";
 865
 866     p = s1 + strlen( s1 );
 867     for ( q = s2; *q != '\0'; ++q ) {
 868         if ( HREF_CHAR_ACCEPTABLE( *q )) {
 869             *p++ = *q;
 870         } else {
 871             *p++ = '%';
 872             *p++ = hexdig[ *q >> 4 ];
 873             *p++ = hexdig[ *q & 0x0F ];
 874         }
 875     }
 876
 877     *p = '\0';
 878 }
 879
 880
 881 #define GET2BYTENUM( p )        (( *(p) - '0' ) * 10 + ( *((p)+1) - '0' ))
 882
 883 static char *
 884 time2text( char *ldtimestr, int dateonly )
 885 {
 886     struct tm           t;
 887     char                *p, *timestr, zone, *fmterr = "badly formatted time";
 888     time_t              gmttime;
 889     char                timebuf[32];
 890         int ndigits;
 891
 892         if (strlen( ldtimestr ) < 12 ) {
 893                 return( fmterr );
 894         }
 895
 896     for ( ndigits=0; isdigit((unsigned char) ldtimestr[ndigits]); ndigits++) {
 897                 ; /* EMPTY */
 898     }
 899
 900         if ( ndigits != 12 && ndigits != 14) {
 901             return( fmterr );
 902         }
 903
 904     memset( (char *)&t, 0, sizeof( struct tm ));
 905
 906     p = ldtimestr;
 907
 908         if( ndigits == 14) {
 909                 /* came with a century */
 910                 /* POSIX says tm_year should be year - 1900 */
 911         t.tm_year = 100 * GET2BYTENUM( p ) - 1900;
 912                 p += 2;
 913                 t.tm_year += GET2BYTENUM( p ); p += 2;
 914
 915         } else {
 916                 /* came without a century */
 917                 t.tm_year = GET2BYTENUM( p ); p += 2;
 918
 919                 /* Y2K hack - 2 digit years < 70 are 21st century */
 920                 if( t.tm_year < 70 ) {
 921                         t.tm_year += 100;
 922                 }
 923         }
 924
 925     t.tm_mon = GET2BYTENUM( p ) - 1; p += 2;
 926     t.tm_mday = GET2BYTENUM( p ); p += 2;
 927     t.tm_hour = GET2BYTENUM( p ); p += 2;
 928     t.tm_min = GET2BYTENUM( p ); p += 2;
 929     t.tm_sec = GET2BYTENUM( p ); p += 2;
 930
 931     if (( zone = *p ) == 'Z' ) {        /* GMT */
 932         zone = '\0';    /* no need to indicate on screen, so we make it null */
 933     }
 934
 935     gmttime = gtime( &t );
 936
 937     timestr = ldap_pvt_ctime( &gmttime, timebuf );
 938
 939     timestr[ strlen( timestr ) - 1 ] = zone;    /* replace trailing newline */
 940     if ( dateonly ) {
 941         SAFEMEMCPY( timestr + 11, timestr + 20, strlen( timestr + 20 ) + 1 );
 942     }
 943
 944     return( timestr );
 945 }
 946
 947
 948
 949 /* gtime.c - inverse gmtime */
 950 /* gtime(): the inverse of localtime().
 951         This routine was supplied by Mike Accetta at CMU many years ago.
 952  */
 953
 954 static const int dmsize[] = {
 955     31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
 956 };
 957
 958 #define dysize(y)       \
 959         (((y) % 4) ? 365 : (((y) % 100) ? 366 : (((y) % 400) ? 365 : 366)))
 960
 961 /*
 962  * Y2K YEAR
 963  */
 964         /* per STDC & POSIX tm_year should be offset by 1900 */
 965 #define YEAR_POSIX(y)           ((y) + 1900)
 966
 967         /*
 968          * year is < 1900, year is offset by 1900
 969          */
 970 #define YEAR_CAREFUL(y)         ((y) < 1900 ? (y) + 1900 : (y))
 971
 972 #define YEAR(y) YEAR_CAREFUL(y)
 973
 974 /* \f */
 975
 976 static long     gtime ( struct tm *tm )
 977 {
 978     register int    i,
 979                     sec,
 980                     mins,
 981                     hour,
 982                     mday,
 983                     mon,
 984                     year;
 985     register long   result;
 986
 987     if ((sec = tm -> tm_sec) < 0 || sec > 59
 988             || (mins = tm -> tm_min) < 0 || mins > 59
 989             || (hour = tm -> tm_hour) < 0 || hour > 24
 990             || (mday = tm -> tm_mday) < 1 || mday > 31
 991             || (mon = tm -> tm_mon + 1) < 1 || mon > 12)
 992         return ((long) -1);
 993     if (hour == 24) {
 994         hour = 0;
 995         mday++;
 996     }
 997     year = YEAR (tm -> tm_year);
 998
 999     result = 0L;
1000     for (i = 1970; i < year; i++)
1001         result += dysize (i);
1002     if (dysize (year) == 366 && mon >= 3)
1003         result++;
1004     while (--mon)
1005         result += dmsize[mon - 1];
1006     result += mday - 1;
1007     result = 24 * result + hour;
1008     result = 60 * result + mins;
1009     result = 60 * result + sec;
1010
1011     return result;
1012 }
1013
1014 static int
1015 searchaction( LDAP *ld, char *buf, char *base, LDAPMessage *entry, char *dn,
1016         struct ldap_tmplitem *tip, int labelwidth, int rdncount,
1017         writeptype writeproc, void *writeparm, char *eol, char *urlprefix )
1018 {
1019     int                 err = 0, lderr, i, count, html;
1020     char                **vals, **members;
1021     char                *value, *filtpattern, *attr, *selectname;
1022     char                *retattrs[2], filter[ 256 ];
1023     LDAPMessage         *ldmp;
1024     struct timeval      timeout;
1025
1026     html = ( urlprefix != NULL );
1027
1028     for ( i = 0; tip->ti_args != NULL && tip->ti_args[ i ] != NULL; ++i ) {
1029         ;
1030     }
1031     if ( i < 3 ) {
1032         return( LDAP_PARAM_ERROR );
1033     }
1034     attr = tip->ti_args[ 0 ];
1035     filtpattern = tip->ti_args[ 1 ];
1036     retattrs[ 0 ] = tip->ti_args[ 2 ];
1037     retattrs[ 1 ] = NULL;
1038     selectname = tip->ti_args[ 3 ];
1039
1040     vals = NULL;
1041     if ( attr == NULL ) {
1042         value = NULL;
1043     } else if ( strcasecmp( attr, "-dnb" ) == 0 ) {
1044         return( LDAP_PARAM_ERROR );
1045     } else if ( strcasecmp( attr, "-dnt" ) == 0 ) {
1046         value = dn;
1047     } else if ( strcasecmp( attr, "-dn" ) == 0 ) {
1048         value = dn;
1049     } else if (( vals = ldap_get_values( ld, entry, attr )) != NULL ) {
1050         value = vals[ 0 ];
1051     } else {
1052         value = NULL;
1053     }
1054
1055     ldap_build_filter( filter, sizeof( filter ), filtpattern, NULL, NULL, NULL,
1056             value, NULL );
1057
1058     if ( html ) {
1059         /*
1060          * if we are generating HTML, we add an HREF link that embodies this
1061          * search action as an LDAP URL, instead of actually doing the search
1062          * now.
1063          */
1064         sprintf( buf, "<DT><A HREF=\"%s", urlprefix );
1065         if ( base != NULL ) {
1066             strcat_escaped( buf, base );
1067         }
1068         strcat( buf, "??sub?" );
1069         strcat_escaped( buf, filter );
1070         sprintf( buf + strlen( buf ), "\"><B>%s</B></A><DD><BR>%s",
1071                 tip->ti_label, eol );
1072         if ((*writeproc)( writeparm, buf, strlen( buf )) < 0 ) {
1073             return( LDAP_LOCAL_ERROR );
1074         }
1075         return( LDAP_SUCCESS );
1076     }
1077
1078     timeout.tv_sec = SEARCH_TIMEOUT_SECS;
1079     timeout.tv_usec = 0;
1080
1081 #ifdef LDAP_CONNECTIONLESS
1082     if ( LDAP_IS_CLDAP( ld ))
1083         lderr = cldap_search_s( ld, base, LDAP_SCOPE_SUBTREE, filter, retattrs,
1084                 0, &ldmp, NULL );
1085     else
1086 #endif /* LDAP_CONNECTIONLESS */
1087         lderr = ldap_search_st( ld, base, LDAP_SCOPE_SUBTREE, filter, retattrs,
1088                 0, &timeout, &ldmp );
1089
1090     if ( lderr == LDAP_SUCCESS || NONFATAL_LDAP_ERR( lderr )) {
1091         if (( count = ldap_count_entries( ld, ldmp )) > 0 ) {
1092             if (( members = (char **)LDAP_MALLOC( (count + 1) * sizeof(char *)))
1093                     == NULL ) {
1094                 err = LDAP_NO_MEMORY;
1095             } else {
1096                 for ( i = 0, entry = ldap_first_entry( ld, ldmp );
1097                         entry != NULL;
1098                         entry = ldap_next_entry( ld, entry ), ++i ) {
1099                     members[ i ] = ldap_get_dn( ld, entry );
1100                 }
1101                 members[ i ] = NULL;
1102
1103                 ldap_sort_values( ld, members, ldap_sort_strcasecmp );
1104
1105                 err = do_vals2text( ld, NULL, members, tip->ti_label,
1106                         html ? -1 : 0, LDAP_SYN_DN, writeproc, writeparm,
1107                         eol, rdncount, urlprefix );
1108
1109                 ldap_value_free( members );
1110             }
1111         }
1112         ldap_msgfree( ldmp );
1113     }
1114
1115
1116     if ( vals != NULL ) {
1117         ldap_value_free( vals );
1118     }
1119
1120     return(( err == LDAP_SUCCESS ) ? lderr : err );
1121 }