rset/rsbetween.c

   1 /* $Id: rsbetween.c,v 1.21 2004-08-24 15:00:16 heikki Exp $
   2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
   3    Index Data Aps
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23
  24 /* rsbetween is (mostly) used for xml searches. It returns the hits of the
  25  * "middle" rset, that are in between the "left" and "right" rsets. For
  26  * example "Shakespeare" in between "<title>" and </title>. The thing is
  27  * complicated by the inclusion of attributes (from their own rset). If attrs
  28  * specified, they must match the "left" rset (start tag). "Hamlet" between
  29  * "<title lang=eng>" and "</title>". (This assumes that the attributes are
  30  * indexed to the same seqno as the tags).
  31 */
  32
  33 #include <stdio.h>
  34 #include <stdlib.h>
  35 #include <string.h>
  36 #include <assert.h>
  37
  38 #include <zebrautl.h>
  39 #include <rsbetween.h>
  40
  41 #define RSBETWEEN_DEBUG 0
  42
  43 static RSFD r_open_between (RSET ct, int flag);
  44 static void r_close_between (RSFD rfd);
  45 static void r_delete_between (RSET ct);
  46 static void r_rewind_between (RSFD rfd);
  47 static int r_forward_between(RSET ct, RSFD rfd, void *buf,
  48                      int (*cmpfunc)(const void *p1, const void *p2),
  49                      const void *untilbuf);
  50 static int r_read_between (RSFD rfd, void *buf);
  51 static int r_write_between (RSFD rfd, const void *buf);
  52 static void r_pos_between (RSFD rfd, double *current, double *total);
  53
  54 static const struct rset_control control =
  55 {
  56     "between",
  57     r_open_between,
  58     r_close_between,
  59     r_delete_between,
  60     r_rewind_between,
  61     r_forward_between, /* rset_default_forward, */
  62     r_pos_between,
  63     r_read_between,
  64     r_write_between,
  65 };
  66
  67
  68 const struct rset_control *rset_kind_between = &control;
  69
  70 struct rset_between_info {
  71     int key_size;
  72     RSET rset_l;
  73     RSET rset_m;
  74     RSET rset_r;
  75     RSET rset_attr;
  76     int (*cmp)(const void *p1, const void *p2);
  77     char *(*printer)(const void *p1, char *buf);
  78     struct rset_between_rfd *rfd_list;
  79 };
  80
  81 struct rset_between_rfd {
  82     RSFD rfd_l;
  83     RSFD rfd_m;
  84     RSFD rfd_r;
  85     RSFD rfd_attr;
  86     int  more_l;
  87     int  more_m;
  88     int  more_r;
  89     int  more_attr;
  90     void *buf_l;
  91     void *buf_m;
  92     void *buf_r;
  93     void *buf_attr;
  94     int level;
  95     struct rset_between_rfd *next;
  96     struct rset_between_info *info;
  97     zint hits;
  98 };
  99
 100 #if RSBETWEEN_DEBUG
 101 static void log2 (struct rset_between_rfd *p, char *msg, int cmp_l, int cmp_r)
 102 {
 103     char buf_l[32];
 104     char buf_m[32];
 105     char buf_r[32];
 106     logf(LOG_DEBUG,"btw: %s l=%s(%d/%d) m=%s(%d) r=%s(%d/%d), lev=%d",
 107       msg,
 108       (*p->info->printer)(p->buf_l, buf_l), p->more_l, cmp_l,
 109       (*p->info->printer)(p->buf_m, buf_m), p->more_m,
 110       (*p->info->printer)(p->buf_r, buf_r), p->more_r, cmp_r,
 111       p->level);
 112 }
 113 #endif
 114
 115 RSET rsbetween_create( NMEM nmem, int key_size,
 116             int (*cmp)(const void *p1, const void *p2),
 117             RSET rset_l, RSET rset_m, RSET rset_r, RSET rset_attr,
 118             char *(*printer)(const void *p1, char *buf) )
 119 {
 120     RSET rnew=rset_create_base(&control, nmem);
 121     struct rset_between_info *info;
 122     info = (struct rset_between_info *) nmem_malloc(rnew->nmem,sizeof(*info));
 123     info->key_size = key_size;
 124     info->rset_l = rset_l;
 125     info->rset_m = rset_m;
 126     info->rset_r = rset_r;
 127     info->rset_attr = rset_attr;
 128     info->cmp = cmp;
 129     info->printer = printer;
 130     info->rfd_list = NULL;
 131
 132     rnew->priv=info;
 133     return rnew;
 134 }
 135
 136 /*
 137 static void *r_create_between (RSET ct, const struct rset_control *sel,
 138                                void *parms)
 139 {
 140     rset_between_parms *between_parms = (rset_between_parms *) parms;
 141     struct rset_between_info *info;
 142
 143     info = (struct rset_between_info *) xmalloc (sizeof(*info));
 144     info->key_size = between_parms->key_size;
 145     info->rset_l = between_parms->rset_l;
 146     info->rset_m = between_parms->rset_m;
 147     info->rset_r = between_parms->rset_r;
 148     info->rset_attr = between_parms->rset_attr;
 149     info->cmp = between_parms->cmp;
 150     info->printer = between_parms->printer;
 151     info->rfd_list = NULL;
 152     return info;
 153 }
 154 */
 155
 156
 157 static void r_delete_between (RSET ct)
 158 {
 159     struct rset_between_info *info = (struct rset_between_info *) ct->priv;
 160
 161     assert (info->rfd_list == NULL);
 162     rset_delete (info->rset_l);
 163     rset_delete (info->rset_m);
 164     rset_delete (info->rset_r);
 165     if (info->rset_attr)
 166         rset_delete (info->rset_attr);
 167 }
 168
 169
 170 static RSFD r_open_between (RSET ct, int flag)
 171 {
 172     struct rset_between_info *info = (struct rset_between_info *) ct->priv;
 173     struct rset_between_rfd *rfd;
 174
 175     if (flag & RSETF_WRITE)
 176     {
 177         logf (LOG_FATAL, "between set type is read-only");
 178         return NULL;
 179     }
 180     rfd = (struct rset_between_rfd *) nmem_malloc(ct->nmem, (sizeof(*rfd)));
 181     rfd->next = info->rfd_list;
 182     info->rfd_list = rfd;
 183     rfd->info = info;
 184
 185     rfd->buf_l = nmem_malloc(ct->nmem, (info->key_size));
 186     rfd->buf_m = nmem_malloc(ct->nmem, (info->key_size));
 187     rfd->buf_r = nmem_malloc(ct->nmem, (info->key_size));
 188     rfd->buf_attr = nmem_malloc(ct->nmem, (info->key_size));
 189
 190     rfd->rfd_l = rset_open (info->rset_l, RSETF_READ);
 191     rfd->rfd_m = rset_open (info->rset_m, RSETF_READ);
 192     rfd->rfd_r = rset_open (info->rset_r, RSETF_READ);
 193
 194     rfd->more_l = rset_read (info->rset_l, rfd->rfd_l, rfd->buf_l);
 195     rfd->more_m = rset_read (info->rset_m, rfd->rfd_m, rfd->buf_m);
 196     rfd->more_r = rset_read (info->rset_r, rfd->rfd_r, rfd->buf_r);
 197     if (info->rset_attr)
 198     {
 199         rfd->rfd_attr = rset_open (info->rset_attr, RSETF_READ);
 200         rfd->more_attr = rset_read (info->rset_attr, rfd->rfd_attr,
 201                                     rfd->buf_attr);
 202     }
 203     rfd->level=0;
 204     rfd->hits=0;
 205     return rfd;
 206 }
 207
 208 static void r_close_between (RSFD rfd)
 209 {
 210     struct rset_between_info *info = ((struct rset_between_rfd*)rfd)->info;
 211     struct rset_between_rfd **rfdp;
 212
 213     for (rfdp = &info->rfd_list; *rfdp; rfdp = &(*rfdp)->next)
 214         if (*rfdp == rfd)
 215         {
 216             rset_close (info->rset_l, (*rfdp)->rfd_l);
 217             rset_close (info->rset_m, (*rfdp)->rfd_m);
 218             rset_close (info->rset_r, (*rfdp)->rfd_r);
 219             if (info->rset_attr)
 220                 rset_close (info->rset_attr, (*rfdp)->rfd_attr);
 221
 222             *rfdp = (*rfdp)->next;
 223             return;
 224         }
 225     logf (LOG_FATAL, "r_close_between but no rfd match!");
 226     assert (0);
 227 }
 228
 229 static void r_rewind_between (RSFD rfd)
 230 {
 231     struct rset_between_info *info = ((struct rset_between_rfd*)rfd)->info;
 232     struct rset_between_rfd *p = (struct rset_between_rfd *) rfd;
 233
 234 #if RSBETWEEN_DEBUG
 235     logf (LOG_DEBUG, "rsbetween_rewind");
 236 #endif
 237     rset_rewind (info->rset_l, p->rfd_l);
 238     rset_rewind (info->rset_m, p->rfd_m);
 239     rset_rewind (info->rset_r, p->rfd_r);
 240     p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 241     p->more_m = rset_read (info->rset_m, p->rfd_m, p->buf_m);
 242     p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 243     if (info->rset_attr)
 244     {
 245         rset_rewind (info->rset_attr, p->rfd_attr);
 246         p->more_attr = rset_read (info->rset_attr, p->rfd_attr, p->buf_attr);
 247     }
 248     p->level=0;
 249     p->hits=0;
 250 }
 251
 252
 253
 254 static int r_forward_between(RSET ct, RSFD rfd, void *buf,
 255                      int (*cmpfunc)(const void *p1, const void *p2),
 256                      const void *untilbuf)
 257 {
 258     struct rset_between_info *info = ((struct rset_between_rfd*)rfd)->info;
 259     struct rset_between_rfd *p = (struct rset_between_rfd *) rfd;
 260     int rc;
 261 #if RSBETWEEN_DEBUG
 262     log2( p, "fwd: before forward", 0,0);
 263 #endif
 264     /* It is enough to forward the m pointer here, the read will */
 265     /* naturally forward the l, m, and attr pointers */
 266     if (p->more_m)
 267         p->more_m=rset_forward(info->rset_m,p->rfd_m, p->buf_m,
 268                         info->cmp,untilbuf);
 269 #if RSBETWEEN_DEBUG
 270     log2( p, "fwd: after forward M", 0,0);
 271 #endif
 272     rc = r_read_between(rfd, buf);
 273 #if RSBETWEEN_DEBUG
 274     log2( p, "fwd: after forward", 0,0);
 275 #endif
 276     return rc;
 277 }
 278
 279
 280
 281
 282 static int r_read_between (RSFD rfd, void *buf)
 283 {
 284     struct rset_between_rfd *p = (struct rset_between_rfd *) rfd;
 285     struct rset_between_info *info = p->info;
 286     int cmp_l=0;
 287     int cmp_r=0;
 288     int attr_match = 0;
 289
 290     while (p->more_m)
 291     {
 292 #if RSBETWEEN_DEBUG
 293         log2( p, "start of loop", cmp_l, cmp_r);
 294 #endif
 295
 296         /* forward L until past m, count levels, note rec boundaries */
 297         if (p->more_l)
 298             cmp_l= (*info->cmp)(p->buf_l, p->buf_m);
 299         else
 300         {
 301             p->level = 0;
 302             cmp_l=2; /* past this record */
 303         }
 304 #if RSBETWEEN_DEBUG
 305         log2( p, "after first L", cmp_l, cmp_r);
 306 #endif
 307
 308         while (cmp_l < 0)   /* l before m */
 309         {
 310             if (cmp_l == -2)
 311                 p->level=0; /* earlier record */
 312             if (cmp_l == -1)
 313             {
 314                 p->level++; /* relevant start tag */
 315
 316                 if (!info->rset_attr)
 317                     attr_match = 1;
 318                 else
 319                 {
 320                     int cmp_attr;
 321                     attr_match = 0;
 322                     while (p->more_attr)
 323                     {
 324                         cmp_attr = (*info->cmp)(p->buf_attr, p->buf_l);
 325                         if (cmp_attr == 0)
 326                         {
 327                             attr_match = 1;
 328                             break;
 329                         }
 330                         else if (cmp_attr > 0)
 331                             break;
 332                         else if (cmp_attr==-1)
 333                             p->more_attr = rset_read (info->rset_attr,
 334                                                   p->rfd_attr, p->buf_attr);
 335                             /* if we had a forward that went all the way to
 336                              * the seqno, we could use that. But fwd only goes
 337                              * to the sysno */
 338                         else if (cmp_attr==-2)
 339                         {
 340                             p->more_attr = rset_forward(
 341                                       info->rset_attr, p->rfd_attr,
 342                                       p->buf_attr, info->cmp, p->buf_l);
 343 #if RSBETWEEN_DEBUG
 344                             logf(LOG_DEBUG, "btw: after frowarding attr m=%d",p->more_attr);
 345 #endif
 346                         }
 347                     } /* while more_attr */
 348                 }
 349             }
 350 #define NEWCODE 1
 351 #if NEWCODE
 352             if (cmp_l==-2)
 353             {
 354                 if (p->more_l)
 355                 {
 356                     p->more_l=rset_forward( info->rset_l, p->rfd_l,
 357                                       p->buf_l, info->cmp, p->buf_m);
 358                     if (p->more_l)
 359                         cmp_l= (*info->cmp)(p->buf_l, p->buf_m);
 360                     else
 361                         cmp_l=2;
 362 #if RSBETWEEN_DEBUG
 363                     log2( p, "after forwarding L", cmp_l, cmp_r);
 364 #endif
 365                 }
 366             } else
 367             {
 368                 p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 369             }
 370 #else
 371             p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 372 #endif
 373             if (p->more_l)
 374             {
 375                 cmp_l= (*info->cmp)(p->buf_l, p->buf_m);
 376             }
 377             else
 378                 cmp_l=2;
 379 #if RSBETWEEN_DEBUG
 380             log2( p, "end of L loop", cmp_l, cmp_r);
 381 #endif
 382         } /* forward L */
 383
 384
 385         /* forward R until past m, count levels */
 386 #if RSBETWEEN_DEBUG
 387         log2( p, "Before moving R", cmp_l, cmp_r);
 388 #endif
 389         if (p->more_r)
 390             cmp_r= (*info->cmp)(p->buf_r, p->buf_m);
 391         else
 392             cmp_r=2;
 393 #if RSBETWEEN_DEBUG
 394         log2( p, "after first R", cmp_l, cmp_r);
 395 #endif
 396         while (cmp_r < 0)   /* r before m */
 397         {
 398              /* -2, earlier record, don't count level */
 399             if (cmp_r == -1)
 400                 p->level--; /* relevant end tag */
 401             if (p->more_r)
 402             {
 403 #if NEWCODE
 404                 if (cmp_r==-2)
 405                 {
 406                     p->more_r=rset_forward( info->rset_r, p->rfd_r,
 407                                       p->buf_r, info->cmp, p->buf_m);
 408                 } else
 409                 {
 410                     p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 411                 }
 412                 if (p->more_r)
 413                     cmp_r= (*info->cmp)(p->buf_r, p->buf_m);
 414
 415 #else
 416                 p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 417                 cmp_r= (*info->cmp)(p->buf_r, p->buf_m);
 418 #endif
 419             }
 420             else
 421                 cmp_r=2;
 422 #if RSBETWEEN_DEBUG
 423         log2( p, "End of R loop", cmp_l, cmp_r);
 424 #endif
 425         } /* forward R */
 426
 427         if ( ( p->level <= 0 ) && ! p->more_l)
 428             return 0; /* no more start tags, nothing more to find */
 429
 430         if ( attr_match && p->level > 0)  /* within a tag pair (or deeper) */
 431         {
 432             memcpy (buf, p->buf_m, info->key_size);
 433 #if RSBETWEEN_DEBUG
 434             log2( p, "Returning a hit (and forwarding m)", cmp_l, cmp_r);
 435 #endif
 436             p->more_m = rset_read (info->rset_m, p->rfd_m, p->buf_m);
 437             if (cmp_l == 2)
 438                 p->level = 0;
 439             p->hits++;
 440             return 1;
 441         }
 442         else if ( ! p->more_l )  /* not in data, no more starts */
 443         {
 444 #if RSBETWEEN_DEBUG
 445             log2( p, "no more starts, exiting without a hit", cmp_l, cmp_r);
 446 #endif
 447             return 0;  /* ergo, nothing can be found. stop scanning */
 448         }
 449 #if NEWCODE
 450         if (cmp_l == 2)
 451         {
 452             p->level = 0;
 453             p->more_m=rset_forward( info->rset_m, p->rfd_m,
 454                               p->buf_m, info->cmp, p->buf_l);
 455         } else
 456         {
 457             p->more_m = rset_read (info->rset_m, p->rfd_m, p->buf_m);
 458         }
 459 #else
 460         if (cmp_l == 2)
 461             p->level = 0;
 462         p->more_m = rset_read (info->rset_m, p->rfd_m, p->buf_m);
 463 #endif
 464 #if RSBETWEEN_DEBUG
 465         log2( p, "End of M loop", cmp_l, cmp_r);
 466 #endif
 467     } /* while more_m */
 468
 469 #if RSBETWEEN_DEBUG
 470     log2( p, "Exiting, nothing more in m", cmp_l, cmp_r);
 471 #endif
 472     return 0;  /* no more data possible */
 473
 474
 475 }  /* r_read */
 476
 477
 478 static int r_write_between (RSFD rfd, const void *buf)
 479 {
 480     logf (LOG_FATAL, "between set type is read-only");
 481     return -1;
 482 }
 483
 484
 485 static void r_pos_between (RSFD rfd, double *current, double *total)
 486 {
 487     struct rset_between_rfd *p = (struct rset_between_rfd *) rfd;
 488     struct rset_between_info *info = p->info;
 489     double lcur,ltot;
 490     double mcur,mtot;
 491     double rcur,rtot;
 492     double r;
 493     ltot=-1; rtot=-1;
 494     rset_pos(info->rset_l, p->rfd_l,  &lcur, &ltot);
 495     rset_pos(info->rset_m, p->rfd_m,  &mcur, &mtot);
 496     rset_pos(info->rset_r, p->rfd_r,  &rcur, &rtot);
 497     if ( (ltot<0) && (mtot<0) && (rtot<0) ) { /*no position */
 498         *current=mcur;  /* return same as you got */
 499         *total=mtot;    /* probably -1 for not available */
 500     }
 501     if ( ltot<0) { ltot=0; lcur=0;} /* if only one useful, use it */
 502     if ( mtot<0) { mtot=0; mcur=0;}
 503     if ( rtot<0) { rtot=0; rcur=0;}
 504     if ( ltot+mtot+rtot < 1 ) { /* empty rset */
 505         *current=0;
 506         *total=0;
 507         return;
 508     }
 509     r=1.0*(lcur+mcur+rcur)/(ltot+mtot+rtot); /* weighed average of l and r */
 510     *current=p->hits;
 511     *total=*current/r ;
 512 #if RSBETWEEN_DEBUG
 513     yaz_log(LOG_DEBUG,"betw_pos: (%s/%s) %0.1f/%0.1f= %0.4f ",
 514                     info->rset_l->control->desc, info->rset_r->control->desc,
 515                     *current, *total, r);
 516 #endif
 517 }