rset/rsbetween.c

   1 /* $Id: rsbetween.c,v 1.19 2004-08-23 12:38:53 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 void *r_create_between(RSET ct, const struct rset_control *sel, void *parms);
  44 static RSFD r_open_between (RSET ct, int flag);
  45 static void r_close_between (RSFD rfd);
  46 static void r_delete_between (RSET ct);
  47 static void r_rewind_between (RSFD rfd);
  48 static int r_forward_between(RSET ct, RSFD rfd, void *buf,
  49                      int (*cmpfunc)(const void *p1, const void *p2),
  50                      const void *untilbuf);
  51 static int r_read_between (RSFD rfd, void *buf);
  52 static int r_write_between (RSFD rfd, const void *buf);
  53 static void r_pos_between (RSFD rfd, double *current, double *total);
  54
  55 static const struct rset_control control_between =
  56 {
  57     "between",
  58     r_create_between,
  59     r_open_between,
  60     r_close_between,
  61     r_delete_between,
  62     r_rewind_between,
  63     r_forward_between, /* rset_default_forward, */
  64     r_pos_between,
  65     r_read_between,
  66     r_write_between,
  67 };
  68
  69
  70 const struct rset_control *rset_kind_between = &control_between;
  71
  72 struct rset_between_info {
  73     int key_size;
  74     RSET rset_l;
  75     RSET rset_m;
  76     RSET rset_r;
  77     RSET rset_attr;
  78     int (*cmp)(const void *p1, const void *p2);
  79     char *(*printer)(const void *p1, char *buf);
  80     struct rset_between_rfd *rfd_list;
  81 };
  82
  83 struct rset_between_rfd {
  84     RSFD rfd_l;
  85     RSFD rfd_m;
  86     RSFD rfd_r;
  87     RSFD rfd_attr;
  88     int  more_l;
  89     int  more_m;
  90     int  more_r;
  91     int  more_attr;
  92     void *buf_l;
  93     void *buf_m;
  94     void *buf_r;
  95     void *buf_attr;
  96     int level;
  97     struct rset_between_rfd *next;
  98     struct rset_between_info *info;
  99     zint hits;
 100 };
 101
 102 #if RSBETWEEN_DEBUG
 103 static void log2 (struct rset_between_rfd *p, char *msg, int cmp_l, int cmp_r)
 104 {
 105     char buf_l[32];
 106     char buf_m[32];
 107     char buf_r[32];
 108     logf(LOG_DEBUG,"btw: %s l=%s(%d/%d) m=%s(%d) r=%s(%d/%d), lev=%d",
 109       msg,
 110       (*p->info->printer)(p->buf_l, buf_l), p->more_l, cmp_l,
 111       (*p->info->printer)(p->buf_m, buf_m), p->more_m,
 112       (*p->info->printer)(p->buf_r, buf_r), p->more_r, cmp_r,
 113       p->level);
 114 }
 115 #endif
 116
 117 static void *r_create_between (RSET ct, const struct rset_control *sel,
 118                                void *parms)
 119 {
 120     rset_between_parms *between_parms = (rset_between_parms *) parms;
 121     struct rset_between_info *info;
 122
 123     info = (struct rset_between_info *) xmalloc (sizeof(*info));
 124     info->key_size = between_parms->key_size;
 125     info->rset_l = between_parms->rset_l;
 126     info->rset_m = between_parms->rset_m;
 127     info->rset_r = between_parms->rset_r;
 128     info->rset_attr = between_parms->rset_attr;
 129     info->cmp = between_parms->cmp;
 130     info->printer = between_parms->printer;
 131     info->rfd_list = NULL;
 132     return info;
 133 }
 134
 135 static RSFD r_open_between (RSET ct, int flag)
 136 {
 137     struct rset_between_info *info = (struct rset_between_info *) ct->buf;
 138     struct rset_between_rfd *rfd;
 139
 140     if (flag & RSETF_WRITE)
 141     {
 142         logf (LOG_FATAL, "between set type is read-only");
 143         return NULL;
 144     }
 145     rfd = (struct rset_between_rfd *) xmalloc (sizeof(*rfd));
 146     rfd->next = info->rfd_list;
 147     info->rfd_list = rfd;
 148     rfd->info = info;
 149
 150     rfd->buf_l = xmalloc (info->key_size);
 151     rfd->buf_m = xmalloc (info->key_size);
 152     rfd->buf_r = xmalloc (info->key_size);
 153     rfd->buf_attr = xmalloc (info->key_size);
 154
 155     rfd->rfd_l = rset_open (info->rset_l, RSETF_READ);
 156     rfd->rfd_m = rset_open (info->rset_m, RSETF_READ);
 157     rfd->rfd_r = rset_open (info->rset_r, RSETF_READ);
 158
 159     rfd->more_l = rset_read (info->rset_l, rfd->rfd_l, rfd->buf_l);
 160     rfd->more_m = rset_read (info->rset_m, rfd->rfd_m, rfd->buf_m);
 161     rfd->more_r = rset_read (info->rset_r, rfd->rfd_r, rfd->buf_r);
 162     if (info->rset_attr)
 163     {
 164         rfd->rfd_attr = rset_open (info->rset_attr, RSETF_READ);
 165         rfd->more_attr = rset_read (info->rset_attr, rfd->rfd_attr,
 166                                     rfd->buf_attr);
 167     }
 168     rfd->level=0;
 169     rfd->hits=0;
 170     return rfd;
 171 }
 172
 173 static void r_close_between (RSFD rfd)
 174 {
 175     struct rset_between_info *info = ((struct rset_between_rfd*)rfd)->info;
 176     struct rset_between_rfd **rfdp;
 177
 178     for (rfdp = &info->rfd_list; *rfdp; rfdp = &(*rfdp)->next)
 179         if (*rfdp == rfd)
 180         {
 181             xfree ((*rfdp)->buf_l);
 182             xfree ((*rfdp)->buf_m);
 183             xfree ((*rfdp)->buf_r);
 184             xfree ((*rfdp)->buf_attr);
 185             rset_close (info->rset_l, (*rfdp)->rfd_l);
 186             rset_close (info->rset_m, (*rfdp)->rfd_m);
 187             rset_close (info->rset_r, (*rfdp)->rfd_r);
 188             if (info->rset_attr)
 189                 rset_close (info->rset_attr, (*rfdp)->rfd_attr);
 190
 191             *rfdp = (*rfdp)->next;
 192             xfree (rfd);
 193             return;
 194         }
 195     logf (LOG_FATAL, "r_close_between but no rfd match!");
 196     assert (0);
 197 }
 198
 199 static void r_delete_between (RSET ct)
 200 {
 201     struct rset_between_info *info = (struct rset_between_info *) ct->buf;
 202
 203     assert (info->rfd_list == NULL);
 204     rset_delete (info->rset_l);
 205     rset_delete (info->rset_m);
 206     rset_delete (info->rset_r);
 207     if (info->rset_attr)
 208         rset_delete (info->rset_attr);
 209     xfree (info);
 210 }
 211
 212 static void r_rewind_between (RSFD rfd)
 213 {
 214     struct rset_between_info *info = ((struct rset_between_rfd*)rfd)->info;
 215     struct rset_between_rfd *p = (struct rset_between_rfd *) rfd;
 216
 217 #if RSBETWEEN_DEBUG
 218     logf (LOG_DEBUG, "rsbetween_rewind");
 219 #endif
 220     rset_rewind (info->rset_l, p->rfd_l);
 221     rset_rewind (info->rset_m, p->rfd_m);
 222     rset_rewind (info->rset_r, p->rfd_r);
 223     p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 224     p->more_m = rset_read (info->rset_m, p->rfd_m, p->buf_m);
 225     p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 226     if (info->rset_attr)
 227     {
 228         rset_rewind (info->rset_attr, p->rfd_attr);
 229         p->more_attr = rset_read (info->rset_attr, p->rfd_attr, p->buf_attr);
 230     }
 231     p->level=0;
 232     p->hits=0;
 233 }
 234
 235
 236
 237 static int r_forward_between(RSET ct, RSFD rfd, void *buf,
 238                      int (*cmpfunc)(const void *p1, const void *p2),
 239                      const void *untilbuf)
 240 {
 241     struct rset_between_info *info = ((struct rset_between_rfd*)rfd)->info;
 242     struct rset_between_rfd *p = (struct rset_between_rfd *) rfd;
 243     int rc;
 244 #if RSBETWEEN_DEBUG
 245     log2( p, "fwd: before forward", 0,0);
 246 #endif
 247     /* It is enough to forward the m pointer here, the read will */
 248     /* naturally forward the l, m, and attr pointers */
 249     if (p->more_m)
 250         p->more_m=rset_forward(info->rset_m,p->rfd_m, p->buf_m,
 251                         info->cmp,untilbuf);
 252 #if RSBETWEEN_DEBUG
 253     log2( p, "fwd: after forward M", 0,0);
 254 #endif
 255     rc = r_read_between(rfd, buf);
 256 #if RSBETWEEN_DEBUG
 257     log2( p, "fwd: after forward", 0,0);
 258 #endif
 259     return rc;
 260 }
 261
 262
 263
 264
 265 static int r_read_between (RSFD rfd, void *buf)
 266 {
 267     struct rset_between_rfd *p = (struct rset_between_rfd *) rfd;
 268     struct rset_between_info *info = p->info;
 269     int cmp_l=0;
 270     int cmp_r=0;
 271     int attr_match = 0;
 272
 273     while (p->more_m)
 274     {
 275 #if RSBETWEEN_DEBUG
 276         log2( p, "start of loop", cmp_l, cmp_r);
 277 #endif
 278
 279         /* forward L until past m, count levels, note rec boundaries */
 280         if (p->more_l)
 281             cmp_l= (*info->cmp)(p->buf_l, p->buf_m);
 282         else
 283         {
 284             p->level = 0;
 285             cmp_l=2; /* past this record */
 286         }
 287 #if RSBETWEEN_DEBUG
 288         log2( p, "after first L", cmp_l, cmp_r);
 289 #endif
 290
 291         while (cmp_l < 0)   /* l before m */
 292         {
 293             if (cmp_l == -2)
 294                 p->level=0; /* earlier record */
 295             if (cmp_l == -1)
 296             {
 297                 p->level++; /* relevant start tag */
 298
 299                 if (!info->rset_attr)
 300                     attr_match = 1;
 301                 else
 302                 {
 303                     int cmp_attr;
 304                     attr_match = 0;
 305                     while (p->more_attr)
 306                     {
 307                         cmp_attr = (*info->cmp)(p->buf_attr, p->buf_l);
 308                         if (cmp_attr == 0)
 309                         {
 310                             attr_match = 1;
 311                             break;
 312                         }
 313                         else if (cmp_attr > 0)
 314                             break;
 315                         else if (cmp_attr==-1)
 316                             p->more_attr = rset_read (info->rset_attr,
 317                                                   p->rfd_attr, p->buf_attr);
 318                             /* if we had a forward that went all the way to
 319                              * the seqno, we could use that. But fwd only goes
 320                              * to the sysno */
 321                         else if (cmp_attr==-2)
 322                         {
 323                             p->more_attr = rset_forward(
 324                                       info->rset_attr, p->rfd_attr,
 325                                       p->buf_attr, info->cmp, p->buf_l);
 326 #if RSBETWEEN_DEBUG
 327                             logf(LOG_DEBUG, "btw: after frowarding attr m=%d",p->more_attr);
 328 #endif
 329                         }
 330                     } /* while more_attr */
 331                 }
 332             }
 333 #define NEWCODE 1
 334 #if NEWCODE
 335             if (cmp_l==-2)
 336             {
 337                 if (p->more_l)
 338                 {
 339                     p->more_l=rset_forward( info->rset_l, p->rfd_l,
 340                                       p->buf_l, info->cmp, p->buf_m);
 341                     if (p->more_l)
 342                         cmp_l= (*info->cmp)(p->buf_l, p->buf_m);
 343                     else
 344                         cmp_l=2;
 345 #if RSBETWEEN_DEBUG
 346                     log2( p, "after forwarding L", cmp_l, cmp_r);
 347 #endif
 348                 }
 349             } else
 350             {
 351                 p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 352             }
 353 #else
 354             p->more_l = rset_read (info->rset_l, p->rfd_l, p->buf_l);
 355 #endif
 356             if (p->more_l)
 357             {
 358                 cmp_l= (*info->cmp)(p->buf_l, p->buf_m);
 359             }
 360             else
 361                 cmp_l=2;
 362 #if RSBETWEEN_DEBUG
 363             log2( p, "end of L loop", cmp_l, cmp_r);
 364 #endif
 365         } /* forward L */
 366
 367
 368         /* forward R until past m, count levels */
 369 #if RSBETWEEN_DEBUG
 370         log2( p, "Before moving R", cmp_l, cmp_r);
 371 #endif
 372         if (p->more_r)
 373             cmp_r= (*info->cmp)(p->buf_r, p->buf_m);
 374         else
 375             cmp_r=2;
 376 #if RSBETWEEN_DEBUG
 377         log2( p, "after first R", cmp_l, cmp_r);
 378 #endif
 379         while (cmp_r < 0)   /* r before m */
 380         {
 381              /* -2, earlier record, don't count level */
 382             if (cmp_r == -1)
 383                 p->level--; /* relevant end tag */
 384             if (p->more_r)
 385             {
 386 #if NEWCODE
 387                 if (cmp_r==-2)
 388                 {
 389                     p->more_r=rset_forward( info->rset_r, p->rfd_r,
 390                                       p->buf_r, info->cmp, p->buf_m);
 391                 } else
 392                 {
 393                     p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 394                 }
 395                 if (p->more_r)
 396                     cmp_r= (*info->cmp)(p->buf_r, p->buf_m);
 397
 398 #else
 399                 p->more_r = rset_read (info->rset_r, p->rfd_r, p->buf_r);
 400                 cmp_r= (*info->cmp)(p->buf_r, p->buf_m);
 401 #endif
 402             }
 403             else
 404                 cmp_r=2;
 405 #if RSBETWEEN_DEBUG
 406         log2( p, "End of R loop", cmp_l, cmp_r);
 407 #endif
 408         } /* forward R */
 409
 410         if ( ( p->level <= 0 ) && ! p->more_l)
 411             return 0; /* no more start tags, nothing more to find */
 412
 413         if ( attr_match && p->level > 0)  /* within a tag pair (or deeper) */
 414         {
 415             memcpy (buf, p->buf_m, info->key_size);
 416 #if RSBETWEEN_DEBUG
 417             log2( p, "Returning a hit (and forwarding m)", cmp_l, cmp_r);
 418 #endif
 419             p->more_m = rset_read (info->rset_m, p->rfd_m, p->buf_m);
 420             if (cmp_l == 2)
 421                 p->level = 0;
 422             p->hits++;
 423             return 1;
 424         }
 425         else if ( ! p->more_l )  /* not in data, no more starts */
 426         {
 427 #if RSBETWEEN_DEBUG
 428             log2( p, "no more starts, exiting without a hit", cmp_l, cmp_r);
 429 #endif
 430             return 0;  /* ergo, nothing can be found. stop scanning */
 431         }
 432 #if NEWCODE
 433         if (cmp_l == 2)
 434         {
 435             p->level = 0;
 436             p->more_m=rset_forward( info->rset_m, p->rfd_m,
 437                               p->buf_m, info->cmp, p->buf_l);
 438         } else
 439         {
 440             p->more_m = rset_read (info->rset_m, p->rfd_m, p->buf_m);
 441         }
 442 #else
 443         if (cmp_l == 2)
 444             p->level = 0;
 445         p->more_m = rset_read (info->rset_m, p->rfd_m, p->buf_m);
 446 #endif
 447 #if RSBETWEEN_DEBUG
 448         log2( p, "End of M loop", cmp_l, cmp_r);
 449 #endif
 450     } /* while more_m */
 451
 452 #if RSBETWEEN_DEBUG
 453     log2( p, "Exiting, nothing more in m", cmp_l, cmp_r);
 454 #endif
 455     return 0;  /* no more data possible */
 456
 457
 458 }  /* r_read */
 459
 460
 461 static int r_write_between (RSFD rfd, const void *buf)
 462 {
 463     logf (LOG_FATAL, "between set type is read-only");
 464     return -1;
 465 }
 466
 467
 468 static void r_pos_between (RSFD rfd, double *current, double *total)
 469 {
 470     struct rset_between_rfd *p = (struct rset_between_rfd *) rfd;
 471     struct rset_between_info *info = p->info;
 472     double lcur,ltot;
 473     double mcur,mtot;
 474     double rcur,rtot;
 475     double r;
 476     ltot=-1; rtot=-1;
 477     rset_pos(info->rset_l, p->rfd_l,  &lcur, &ltot);
 478     rset_pos(info->rset_m, p->rfd_m,  &mcur, &mtot);
 479     rset_pos(info->rset_r, p->rfd_r,  &rcur, &rtot);
 480     if ( (ltot<0) && (mtot<0) && (rtot<0) ) { /*no position */
 481         *current=mcur;  /* return same as you got */
 482         *total=mtot;    /* probably -1 for not available */
 483     }
 484     if ( ltot<0) { ltot=0; lcur=0;} /* if only one useful, use it */
 485     if ( mtot<0) { mtot=0; mcur=0;}
 486     if ( rtot<0) { rtot=0; rcur=0;}
 487     if ( ltot+mtot+rtot < 1 ) { /* empty rset */
 488         *current=0;
 489         *total=0;
 490         return;
 491     }
 492     r=1.0*(lcur+mcur+rcur)/(ltot+mtot+rtot); /* weighed average of l and r */
 493     *current=p->hits;
 494     *total=*current/r ;
 495 #if RSBETWEEN_DEBUG
 496     yaz_log(LOG_DEBUG,"betw_pos: (%s/%s) %0.1f/%0.1f= %0.4f ",
 497                     info->rset_l->control->desc, info->rset_r->control->desc,
 498                     *current, *total, r);
 499 #endif
 500 }