rset/rsbetween.c

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