-/* $Id: rsbetween.c,v 1.23 2004-08-31 10:43:36 heikki Exp $
- Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
- Index Data Aps
+/* $Id: rsbetween.c,v 1.35 2005-01-15 20:47:16 adam Exp $
+ Copyright (C) 1995-2005
+ Index Data ApS
This file is part of the Zebra server.
/* rsbetween is (mostly) used for xml searches. It returns the hits of the
* "middle" rset, that are in between the "left" and "right" rsets. For
- * example "Shakespeare" in between "<title>" and </title>. The thing is
+ * example "Shakespeare" in between "<author>" and </author>. The thing is
* complicated by the inclusion of attributes (from their own rset). If attrs
* specified, they must match the "left" rset (start tag). "Hamlet" between
- * "<title lang=eng>" and "</title>". (This assumes that the attributes are
+ * "<title lang = eng>" and "</title>". (This assumes that the attributes are
* indexed to the same seqno as the tags).
+ *
*/
#include <stdio.h>
#include <assert.h>
#include <zebrautl.h>
-#include <rsbetween.h>
+#include <rset.h>
-#define RSBETWEEN_DEBUG 0
-static RSFD r_open_between (RSET ct, int flag);
-static void r_close_between (RSFD rfd);
-static void r_delete_between (RSET ct);
-static void r_rewind_between (RSFD rfd);
-static int r_forward_between(RSFD rfd, void *buf,
- int (*cmpfunc)(const void *p1, const void *p2),
- const void *untilbuf);
-static int r_read_between (RSFD rfd, void *buf);
-static int r_write_between (RSFD rfd, const void *buf);
-static void r_pos_between (RSFD rfd, double *current, double *total);
+static RSFD r_open (RSET ct, int flag);
+static void r_close (RSFD rfd);
+static void r_delete (RSET ct);
+static int r_forward(RSFD rfd, void *buf,
+ TERMID *term, const void *untilbuf);
+static int r_read(RSFD rfd, void *buf, TERMID *term );
+static int r_write(RSFD rfd, const void *buf);
+static void r_pos(RSFD rfd, double *current, double *total);
+static void r_get_terms(RSET ct, TERMID *terms, int maxterms, int *curterm);
static const struct rset_control control =
{
"between",
- r_delete_between,
- r_open_between,
- r_close_between,
- r_rewind_between,
- r_forward_between, /* rset_default_forward, */
- r_pos_between,
- r_read_between,
- r_write_between,
+ r_delete,
+ r_get_terms,
+ r_open,
+ r_close,
+ r_forward,
+ r_pos,
+ r_read,
+ r_write,
};
const struct rset_control *rset_kind_between = &control;
+#define STARTTAG 0
+#define HIT 1
+#define STOPTAG 2
+#define ATTRTAG 3
+
struct rset_between_info {
- int key_size;
- RSET rset_l;
- RSET rset_m;
- RSET rset_r;
- RSET rset_attr;
- int (*cmp)(const void *p1, const void *p2);
- char *(*printer)(const void *p1, char *buf);
+ RSET andset; /* the multi-and of the above */
+ TERMID startterm; /* pseudo terms for detecting which one we read from */
+ TERMID stopterm;
+ TERMID attrterm;
};
struct rset_between_rfd {
- RSFD rfd_l;
- RSFD rfd_m;
- RSFD rfd_r;
- RSFD rfd_attr;
- int more_l;
- int more_m;
- int more_r;
- int more_attr;
- void *buf_l;
- void *buf_m;
- void *buf_r;
- void *buf_attr;
- int level;
- struct rset_between_rfd *next;
- struct rset_between_info *info;
+ RSFD andrfd;
+ void *recbuf; /* a key that tells which record we are in */
+ void *startbuf; /* the start tag */
+ int startbufok; /* we have seen the first start tag */
+ void *attrbuf; /* the attr tag. If these two match, we have attr match */
+ int attrbufok; /* we have seen the first attr tag, can compare */
+ int depth; /* number of start-tags without end-tags */
+ int attrdepth; /* on what depth the attr matched */
zint hits;
};
-#if RSBETWEEN_DEBUG
-static void log2 (struct rset_between_rfd *p, char *msg, int cmp_l, int cmp_r)
+static int log_level = 0;
+static int log_level_initialized = 0;
+
+
+/* make sure that the rset has a term attached. If not, create one */
+/* we need these terms for the tags, to distinguish what we read */
+static void checkterm( RSET rs, char *tag, NMEM nmem)
{
- char buf_l[32];
- char buf_m[32];
- char buf_r[32];
- logf(LOG_DEBUG,"btw: %s l=%s(%d/%d) m=%s(%d) r=%s(%d/%d), lev=%d",
- msg,
- (*p->info->printer)(p->buf_l, buf_l), p->more_l, cmp_l,
- (*p->info->printer)(p->buf_m, buf_m), p->more_m,
- (*p->info->printer)(p->buf_r, buf_r), p->more_r, cmp_r,
- p->level);
+ if (!rs->term)
+ {
+ rs->term=
+ rset_term_create(tag,strlen(tag),"",0,nmem);
+ rs->term->rset = rs;
+ }
}
-#endif
-RSET rsbetween_create( NMEM nmem, int key_size,
- int (*cmp)(const void *p1, const void *p2),
- RSET rset_l, RSET rset_m, RSET rset_r, RSET rset_attr,
- char *(*printer)(const void *p1, char *buf) )
+
+RSET rsbetween_create( NMEM nmem, const struct key_control *kcontrol,
+ int scope,
+ RSET rset_l, RSET rset_m, RSET rset_r, RSET rset_attr)
{
- RSET rnew=rset_create_base(&control, nmem);
- struct rset_between_info *info;
- info = (struct rset_between_info *) nmem_malloc(rnew->nmem,sizeof(*info));
- info->key_size = key_size;
- info->rset_l = rset_l;
- info->rset_m = rset_m;
- info->rset_r = rset_r;
- info->rset_attr = rset_attr;
- info->cmp = cmp;
- info->printer = printer;
+ RSET rnew = rset_create_base(&control, nmem, kcontrol, scope,0);
+ struct rset_between_info *info=
+ (struct rset_between_info *) nmem_malloc(rnew->nmem,sizeof(*info));
+ RSET rsetarray[4];
+ int n = 4;
- rnew->priv=info;
+ if (!log_level_initialized)
+ {
+ log_level = yaz_log_module_level("rsbetween");
+ log_level_initialized = 1;
+ }
+ rsetarray[STARTTAG] = rset_l;
+ rsetarray[HIT] = rset_m;
+ rsetarray[STOPTAG] = rset_r;
+ rsetarray[ATTRTAG] = rset_attr;
+
+ /* make sure we have decent terms for all rsets. Create dummies if needed*/
+ checkterm( rsetarray[STARTTAG], "(start)",nmem);
+ checkterm( rsetarray[STOPTAG], "(start)",nmem);
+ info->startterm = rsetarray[STARTTAG]->term;
+ info->stopterm = rsetarray[STOPTAG]->term;
+
+ if (rset_attr)
+ {
+ checkterm( rsetarray[ATTRTAG], "(start)",nmem);
+ info->attrterm = rsetarray[ATTRTAG]->term;
+ n = 4;
+ }
+ else
+ {
+ info->attrterm = NULL;
+ n = 3;
+ }
+ info->andset = rsmulti_and_create( nmem, kcontrol, scope, n, rsetarray);
+ rnew->priv = info;
+ yaz_log(log_level,"create rset at %p",rnew);
return rnew;
}
-static void r_delete_between (RSET ct)
+static void r_delete (RSET ct)
{
struct rset_between_info *info = (struct rset_between_info *) ct->priv;
-
- rset_delete (info->rset_l);
- rset_delete (info->rset_m);
- rset_delete (info->rset_r);
- if (info->rset_attr)
- rset_delete (info->rset_attr);
+ yaz_log(log_level,"delete rset at %p",ct);
+ rset_delete(info->andset);
}
-static RSFD r_open_between (RSET ct, int flag)
+static RSFD r_open (RSET ct, int flag)
{
struct rset_between_info *info = (struct rset_between_info *) ct->priv;
RSFD rfd;
if (flag & RSETF_WRITE)
{
- logf (LOG_FATAL, "between set type is read-only");
+ yaz_log (YLOG_FATAL, "between set type is read-only");
return NULL;
}
- rfd=rfd_create_base(ct);
+ rfd = rfd_create_base(ct);
if (rfd->priv)
p=(struct rset_between_rfd *)rfd->priv;
else {
p = (struct rset_between_rfd *) nmem_malloc(ct->nmem, (sizeof(*p)));
- rfd->priv=p;
- p->buf_l = nmem_malloc(ct->nmem, (info->key_size));
- p->buf_m = nmem_malloc(ct->nmem, (info->key_size));
- p->buf_r = nmem_malloc(ct->nmem, (info->key_size));
- p->buf_attr = nmem_malloc(ct->nmem, (info->key_size));
- }
-
- p->rfd_l = rset_open (info->rset_l, RSETF_READ);
- p->rfd_m = rset_open (info->rset_m, RSETF_READ);
- p->rfd_r = rset_open (info->rset_r, RSETF_READ);
-
- p->more_l = rset_read (p->rfd_l, p->buf_l);
- p->more_m = rset_read (p->rfd_m, p->buf_m);
- p->more_r = rset_read (p->rfd_r, p->buf_r);
- if (info->rset_attr)
- {
- p->rfd_attr = rset_open (info->rset_attr, RSETF_READ);
- p->more_attr = rset_read (p->rfd_attr, p->buf_attr);
+ rfd->priv = p;
+ p->recbuf = nmem_malloc(ct->nmem, (ct->keycontrol->key_size));
+ p->startbuf = nmem_malloc(ct->nmem, (ct->keycontrol->key_size));
+ p->attrbuf = nmem_malloc(ct->nmem, (ct->keycontrol->key_size));
}
- p->level=0;
- p->hits=0;
+ p->andrfd = rset_open (info->andset, RSETF_READ);
+ p->hits=-1;
+ p->depth = 0;
+ p->attrdepth = 0;
+ p->attrbufok = 0;
+ p->startbufok = 0;
+ yaz_log(log_level,"open rset=%p rfd=%p", ct, rfd);
return rfd;
}
-static void r_close_between (RSFD rfd)
+static void r_close (RSFD rfd)
{
- struct rset_between_info *info =(struct rset_between_info *)rfd->rset->priv;
struct rset_between_rfd *p=(struct rset_between_rfd *)rfd->priv;
-
- rset_close (p->rfd_l);
- rset_close (p->rfd_m);
- rset_close (p->rfd_r);
- if (info->rset_attr)
- rset_close (p->rfd_attr);
+ yaz_log(log_level,"close rfd=%p", rfd);
+ rset_close (p->andrfd);
rfd_delete_base(rfd);
}
-static void r_rewind_between (RSFD rfd)
+
+
+static int r_forward(RSFD rfd, void *buf,
+ TERMID *term, const void *untilbuf)
{
- struct rset_between_info *info =(struct rset_between_info *)rfd->rset->priv;
struct rset_between_rfd *p=(struct rset_between_rfd *)rfd->priv;
-
-#if RSBETWEEN_DEBUG
- logf (LOG_DEBUG, "rsbetween_rewind");
-#endif
- rset_rewind (p->rfd_l);
- rset_rewind (p->rfd_m);
- rset_rewind (p->rfd_r);
- p->more_l = rset_read (p->rfd_l, p->buf_l);
- p->more_m = rset_read (p->rfd_m, p->buf_m);
- p->more_r = rset_read (p->rfd_r, p->buf_r);
- if (info->rset_attr)
- {
- rset_rewind (p->rfd_attr);
- p->more_attr = rset_read (p->rfd_attr, p->buf_attr);
- }
- p->level=0;
- p->hits=0;
+ int rc;
+ yaz_log(log_level, "forwarding ");
+ rc = rset_forward(p->andrfd,buf,term,untilbuf);
+ return rc;
}
-static int r_forward_between(RSFD rfd, void *buf,
- int (*cmpfunc)(const void *p1, const void *p2),
- const void *untilbuf)
+static void checkattr(RSFD rfd)
{
struct rset_between_info *info =(struct rset_between_info *)rfd->rset->priv;
struct rset_between_rfd *p=(struct rset_between_rfd *)rfd->priv;
- int rc;
-#if RSBETWEEN_DEBUG
- log2( p, "fwd: before forward", 0,0);
-#endif
- /* It is enough to forward the m pointer here, the read will */
- /* naturally forward the l, m, and attr pointers */
- if (p->more_m)
- p->more_m=rset_forward(p->rfd_m, p->buf_m,
- info->cmp,untilbuf);
-#if RSBETWEEN_DEBUG
- log2( p, "fwd: after forward M", 0,0);
-#endif
- rc = r_read_between(rfd, buf);
-#if RSBETWEEN_DEBUG
- log2( p, "fwd: after forward", 0,0);
-#endif
- return rc;
+ const struct key_control *kctrl = rfd->rset->keycontrol;
+ int cmp;
+ if (p->attrdepth)
+ return; /* already found one */
+ if (!info->attrterm)
+ {
+ p->attrdepth=-1; /* matches always */
+ return;
+ }
+ if ( p->startbufok && p->attrbufok )
+ { /* have buffers to compare */
+ cmp=(kctrl->cmp)(p->startbuf,p->attrbuf);
+ if (0==cmp) /* and the keys match */
+ {
+ p->attrdepth = p->depth;
+ yaz_log(log_level, "found attribute match at depth %d",p->attrdepth);
+ }
+ }
}
-
-
-static int r_read_between (RSFD rfd, void *buf)
+static int r_read (RSFD rfd, void *buf, TERMID *term)
{
struct rset_between_info *info =(struct rset_between_info *)rfd->rset->priv;
struct rset_between_rfd *p=(struct rset_between_rfd *)rfd->priv;
- int cmp_l=0;
- int cmp_r=0;
- int attr_match = 0;
-
- while (p->more_m)
+ const struct key_control *kctrl = rfd->rset->keycontrol;
+ int cmp;
+ TERMID dummyterm = 0;
+ yaz_log(log_level,"== read: term=%p",term);
+ if (!term)
+ term=&dummyterm;
+ while ( rset_read(p->andrfd,buf,term) )
{
-#if RSBETWEEN_DEBUG
- log2( p, "start of loop", cmp_l, cmp_r);
-#endif
-
- /* forward L until past m, count levels, note rec boundaries */
- if (p->more_l)
- cmp_l= (*info->cmp)(p->buf_l, p->buf_m);
- else
- {
- p->level = 0;
- cmp_l=2; /* past this record */
+ yaz_log(log_level,"read loop term=%p d=%d ad=%d",
+ *term,p->depth, p->attrdepth);
+ if (p->hits<0)
+ {/* first time? */
+ memcpy(p->recbuf,buf,kctrl->key_size);
+ p->hits = 0;
+ cmp = rfd->rset->scope; /* force newrecord */
+ }
+ else {
+ cmp=(kctrl->cmp)(buf,p->recbuf);
+ yaz_log(log_level, "cmp=%d",cmp);
}
-#if RSBETWEEN_DEBUG
- log2( p, "after first L", cmp_l, cmp_r);
-#endif
- while (cmp_l < 0) /* l before m */
- {
- if (cmp_l == -2)
- p->level=0; /* earlier record */
- if (cmp_l == -1)
- {
- p->level++; /* relevant start tag */
-
- if (!info->rset_attr)
- attr_match = 1;
- else
- {
- int cmp_attr;
- attr_match = 0;
- while (p->more_attr)
- {
- cmp_attr = (*info->cmp)(p->buf_attr, p->buf_l);
- if (cmp_attr == 0)
- {
- attr_match = 1;
- break;
- }
- else if (cmp_attr > 0)
- break;
- else if (cmp_attr==-1)
- p->more_attr = rset_read (p->rfd_attr, p->buf_attr);
- /* if we had a forward that went all the way to
- * the seqno, we could use that. But fwd only goes
- * to the sysno */
- else if (cmp_attr==-2)
- {
- p->more_attr = rset_forward( p->rfd_attr,
- p->buf_attr, info->cmp, p->buf_l);
-#if RSBETWEEN_DEBUG
- logf(LOG_DEBUG, "btw: after frowarding attr m=%d",p->more_attr);
-#endif
- }
- } /* while more_attr */
- }
- }
-#define NEWCODE 1
-#if NEWCODE
- if (cmp_l==-2)
- {
- if (p->more_l)
- {
- p->more_l=rset_forward(p->rfd_l,
- p->buf_l, info->cmp, p->buf_m);
- if (p->more_l)
- cmp_l= (*info->cmp)(p->buf_l, p->buf_m);
- else
- cmp_l=2;
-#if RSBETWEEN_DEBUG
- log2( p, "after forwarding L", cmp_l, cmp_r);
-#endif
- }
- } else
- {
- p->more_l = rset_read (p->rfd_l, p->buf_l);
- }
-#else
- p->more_l = rset_read (p->rfd_l, p->buf_l);
-#endif
- if (p->more_l)
- {
- cmp_l= (*info->cmp)(p->buf_l, p->buf_m);
- }
- else
- cmp_l=2;
-#if RSBETWEEN_DEBUG
- log2( p, "end of L loop", cmp_l, cmp_r);
-#endif
- } /* forward L */
-
-
- /* forward R until past m, count levels */
-#if RSBETWEEN_DEBUG
- log2( p, "Before moving R", cmp_l, cmp_r);
-#endif
- if (p->more_r)
- cmp_r= (*info->cmp)(p->buf_r, p->buf_m);
- else
- cmp_r=2;
-#if RSBETWEEN_DEBUG
- log2( p, "after first R", cmp_l, cmp_r);
-#endif
- while (cmp_r < 0) /* r before m */
- {
- /* -2, earlier record, don't count level */
- if (cmp_r == -1)
- p->level--; /* relevant end tag */
- if (p->more_r)
- {
-#if NEWCODE
- if (cmp_r==-2)
- {
- p->more_r=rset_forward(p->rfd_r,
- p->buf_r, info->cmp, p->buf_m);
- } else
- {
- p->more_r = rset_read (p->rfd_r, p->buf_r);
- }
- if (p->more_r)
- cmp_r= (*info->cmp)(p->buf_r, p->buf_m);
-
-#else
- p->more_r = rset_read (p->rfd_r, p->buf_r);
- cmp_r= (*info->cmp)(p->buf_r, p->buf_m);
-#endif
- }
- else
- cmp_r=2;
-#if RSBETWEEN_DEBUG
- log2( p, "End of R loop", cmp_l, cmp_r);
-#endif
- } /* forward R */
-
- if ( ( p->level <= 0 ) && ! p->more_l)
- return 0; /* no more start tags, nothing more to find */
-
- if ( attr_match && p->level > 0) /* within a tag pair (or deeper) */
- {
- memcpy (buf, p->buf_m, info->key_size);
-#if RSBETWEEN_DEBUG
- log2( p, "Returning a hit (and forwarding m)", cmp_l, cmp_r);
-#endif
- p->more_m = rset_read (p->rfd_m, p->buf_m);
- if (cmp_l == 2)
- p->level = 0;
- p->hits++;
- return 1;
+ if (cmp>=rfd->rset->scope)
+ {
+ yaz_log(log_level,"new record");
+ p->depth = 0;
+ p->attrdepth = 0;
+ memcpy(p->recbuf,buf,kctrl->key_size);
}
- else if ( ! p->more_l ) /* not in data, no more starts */
+
+ if (*term)
+ yaz_log(log_level," term: '%s'", (*term)->name);
+ if (*term==info->startterm)
{
-#if RSBETWEEN_DEBUG
- log2( p, "no more starts, exiting without a hit", cmp_l, cmp_r);
-#endif
- return 0; /* ergo, nothing can be found. stop scanning */
+ p->depth++;
+ yaz_log(log_level,"read start tag. d=%d",p->depth);
+ memcpy(p->startbuf,buf,kctrl->key_size);
+ p->startbufok = 1;
+ checkattr(rfd); /* in case we already saw the attr here */
}
-#if NEWCODE
- if (cmp_l == 2)
+ else if (*term==info->stopterm)
{
- p->level = 0;
- p->more_m=rset_forward(p->rfd_m,
- p->buf_m, info->cmp, p->buf_l);
- } else
+ if (p->depth == p->attrdepth)
+ p->attrdepth = 0; /* ending the tag with attr match */
+ p->depth--;
+ yaz_log(log_level,"read end tag. d=%d ad=%d",p->depth, p->attrdepth);
+ }
+ else if (*term==info->attrterm)
{
- p->more_m = rset_read (p->rfd_m, p->buf_m);
+ yaz_log(log_level,"read attr");
+ memcpy(p->attrbuf,buf,kctrl->key_size);
+ p->attrbufok = 1;
+ checkattr(rfd); /* in case the start tag came first */
}
-#else
- if (cmp_l == 2)
- p->level = 0;
- p->more_m = rset_read (p->rfd_m, p->buf_m);
-#endif
-#if RSBETWEEN_DEBUG
- log2( p, "End of M loop", cmp_l, cmp_r);
-#endif
- } /* while more_m */
-
-#if RSBETWEEN_DEBUG
- log2( p, "Exiting, nothing more in m", cmp_l, cmp_r);
-#endif
- return 0; /* no more data possible */
+ else
+ { /* mut be a real hit */
+ if (p->depth && p->attrdepth)
+ {
+ p->hits++;
+ yaz_log(log_level,"got a hit h="ZINT_FORMAT" d=%d ad=%d",
+ p->hits,p->depth,p->attrdepth);
+ return 1; /* we have everything in place already! */
+ } else
+ yaz_log(log_level, "Ignoring hit. h="ZINT_FORMAT" d=%d ad=%d",
+ p->hits,p->depth,p->attrdepth);
+ }
+ } /* while read */
+ return 0;
} /* r_read */
-static int r_write_between (RSFD rfd, const void *buf)
+static int r_write (RSFD rfd, const void *buf)
{
- logf (LOG_FATAL, "between set type is read-only");
+ yaz_log (YLOG_FATAL, "between set type is read-only");
return -1;
}
-static void r_pos_between (RSFD rfd, double *current, double *total)
+static void r_pos (RSFD rfd, double *current, double *total)
{
struct rset_between_rfd *p=(struct rset_between_rfd *)rfd->priv;
- double lcur,ltot;
- double mcur,mtot;
- double rcur,rtot;
- double r;
- ltot=-1; rtot=-1;
- rset_pos(p->rfd_l, &lcur, <ot);
- rset_pos(p->rfd_m, &mcur, &mtot);
- rset_pos(p->rfd_r, &rcur, &rtot);
- if ( (ltot<0) && (mtot<0) && (rtot<0) ) { /*no position */
- *current=mcur; /* return same as you got */
- *total=mtot; /* probably -1 for not available */
- }
- if ( ltot<0) { ltot=0; lcur=0;} /* if only one useful, use it */
- if ( mtot<0) { mtot=0; mcur=0;}
- if ( rtot<0) { rtot=0; rcur=0;}
- if ( ltot+mtot+rtot < 1 ) { /* empty rset */
- *current=0;
- *total=0;
- return;
- }
- r=1.0*(lcur+mcur+rcur)/(ltot+mtot+rtot); /* weighed average of l and r */
- *current=p->hits;
- *total=*current/r ;
-#if RSBETWEEN_DEBUG
- yaz_log(LOG_DEBUG,"betw_pos: (%s/%s) %0.1f/%0.1f= %0.4f ",
- info->rset_l->control->desc, info->rset_r->control->desc,
- *current, *total, r);
-#endif
+ rset_pos(p->andrfd,current, total);
+ yaz_log(log_level,"pos: %0.1f/%0.1f ", *current, *total);
}
+
+static void r_get_terms(RSET ct, TERMID *terms, int maxterms, int *curterm)
+{
+ struct rset_between_info *info = (struct rset_between_info *) ct->priv;
+ rset_getterms(info->andset, terms, maxterms, curterm);
+}
+
+