zutil/pquery.c

   1 /*
   2  * Copyright (c) 1995-1998, Index Data.
   3  * See the file LICENSE for details.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: pquery.c,v $
   7  * Revision 1.3  1999-12-20 15:20:13  adam
   8  * Implemented ccl_pquery to convert from CCL tree to prefix query.
   9  *
  10  * Revision 1.2  1999/11/30 13:47:12  adam
  11  * Improved installation. Moved header files to include/yaz.
  12  *
  13  * Revision 1.1  1999/06/08 10:10:16  adam
  14  * New sub directory zutil. Moved YAZ Compiler to be part of YAZ tree.
  15  *
  16  * Revision 1.22  1999/04/20 09:56:49  adam
  17  * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
  18  * Modified all encoders/decoders to reflect this change.
  19  *
  20  * Revision 1.21  1998/10/13 16:03:37  adam
  21  * Better checking for invalid OID's in p_query_rpn.
  22  *
  23  * Revision 1.20  1998/03/31 15:13:20  adam
  24  * Development towards compiled ASN.1.
  25  *
  26  * Revision 1.19  1998/03/05 08:09:03  adam
  27  * Minor change to make C++ happy.
  28  *
  29  * Revision 1.18  1998/02/11 11:53:36  adam
  30  * Changed code so that it compiles as C++.
  31  *
  32  * Revision 1.17  1997/11/24 11:33:57  adam
  33  * Using function odr_nullval() instead of global ODR_NULLVAL when
  34  * appropriate.
  35  *
  36  * Revision 1.16  1997/09/29 13:19:00  adam
  37  * Added function, oid_ent_to_oid, to replace the function
  38  * oid_getoidbyent, which is not thread safe.
  39  *
  40  * Revision 1.15  1997/09/29 07:13:43  adam
  41  * Changed type of a few variables to avoid warnings.
  42  *
  43  * Revision 1.14  1997/09/22 12:33:41  adam
  44  * Fixed bug introduced by previous commit.
  45  *
  46  * Revision 1.13  1997/09/17 12:10:42  adam
  47  * YAZ version 1.4.
  48  *
  49  * Revision 1.12  1997/09/01 08:54:13  adam
  50  * New windows NT/95 port using MSV5.0. Made prefix query handling
  51  * thread safe. The function options ignores empty arguments when met.
  52  *
  53  * Revision 1.11  1996/11/11 13:15:29  adam
  54  * Added proximity operator.
  55  *
  56  * Revision 1.10  1996/08/12 14:10:35  adam
  57  * New function p_query_attset to define default attribute set.
  58  *
  59  * Revision 1.9  1996/03/15  11:03:46  adam
  60  * Attribute set can be set globally for a query with the @attrset
  61  * operator. The @attr operator has an optional attribute-set specifier
  62  * that sets the attribute set locally.
  63  *
  64  * Revision 1.8  1996/01/02  11:46:56  quinn
  65  * Changed 'operator' to 'roperator' to avoid C++ conflict.
  66  *
  67  * Revision 1.7  1995/09/29  17:12:36  quinn
  68  * Smallish
  69  *
  70  * Revision 1.6  1995/09/27  15:03:03  quinn
  71  * Modified function heads & prototypes.
  72  *
  73  * Revision 1.5  1995/06/15  12:31:02  quinn
  74  * *** empty log message ***
  75  *
  76  * Revision 1.4  1995/06/15  07:45:19  quinn
  77  * Moving to v3.
  78  *
  79  * Revision 1.3  1995/06/14  11:06:35  adam
  80  * Bug fix: Attributes wasn't interpreted correctly!
  81  *
  82  * Revision 1.2  1995/05/26  08:56:11  adam
  83  * New function: p_query_scan.
  84  *
  85  * Revision 1.1  1995/05/22  15:31:49  adam
  86  * New function, p_query_rpn, to convert from prefix (ascii) to rpn (asn).
  87  *
  88  */
  89
  90 #include <stdio.h>
  91 #include <string.h>
  92 #include <stdlib.h>
  93
  94 #include <yaz/proto.h>
  95 #include <yaz/oid.h>
  96 #include <yaz/pquery.h>
  97
  98 static oid_value p_query_dfset = VAL_NONE;
  99
 100 struct lex_info {
 101     const char *query_buf;
 102     const char *lex_buf;
 103     size_t lex_len;
 104     int query_look;
 105     char *left_sep;
 106     char *right_sep;
 107     int escape_char;
 108     int term_type;
 109 };
 110
 111 static Z_RPNStructure *rpn_structure (struct lex_info *li, ODR o, oid_proto,
 112                                       int num_attr, int max_attr,
 113                                       int *attr_list, oid_value *attr_set);
 114
 115 static enum oid_value query_oid_getvalbyname (struct lex_info *li)
 116 {
 117     enum oid_value value;
 118     char buf[32];
 119
 120     if (li->lex_len > 31)
 121         return VAL_NONE;
 122     memcpy (buf, li->lex_buf, li->lex_len);
 123     buf[li->lex_len] = '\0';
 124     value = oid_getvalbyname (buf);
 125     return value;
 126 }
 127
 128 static int compare_term (struct lex_info *li, const char *src, size_t off)
 129 {
 130     size_t len=strlen(src);
 131
 132     if (li->lex_len == len+off && !memcmp (li->lex_buf+off, src, len-off))
 133         return 1;
 134     return 0;
 135 }
 136
 137 static int query_token (struct lex_info *li)
 138 {
 139     const char *sep_match;
 140     const char **qptr = &li->query_buf;
 141
 142     while (**qptr == ' ')
 143         (*qptr)++;
 144     if (**qptr == '\0')
 145         return 0;
 146     li->lex_len = 0;
 147     if ((sep_match = strchr (li->left_sep, **qptr)))
 148     {
 149         int sep_index = sep_match - li->left_sep;
 150
 151         ++(*qptr);
 152         li->lex_buf = *qptr;
 153         while (**qptr && **qptr != li->right_sep[sep_index])
 154         {
 155             ++(li->lex_len);
 156             ++(*qptr);
 157         }
 158         if (**qptr)
 159             ++(*qptr);
 160     }
 161     else
 162     {
 163         li->lex_buf = *qptr;
 164         while (**qptr && **qptr != ' ')
 165         {
 166             ++(li->lex_len);
 167             ++(*qptr);
 168         }
 169     }
 170     if (li->lex_len >= 1 && li->lex_buf[0] == li->escape_char)
 171     {
 172         if (compare_term (li, "and", 1))
 173             return 'a';
 174         if (compare_term (li, "or", 1))
 175             return 'o';
 176         if (compare_term (li, "not", 1))
 177             return 'n';
 178         if (compare_term (li, "attr", 1))
 179             return 'l';
 180         if (compare_term (li, "set", 1))
 181             return 's';
 182         if (compare_term (li, "attrset", 1))
 183             return 'r';
 184         if (compare_term (li, "prox", 1))
 185             return 'p';
 186         if (compare_term (li, "term", 1))
 187             return 'y';
 188     }
 189     return 't';
 190 }
 191
 192 static int lex (struct lex_info *li)
 193 {
 194     return li->query_look = query_token (li);
 195 }
 196
 197 static Z_AttributesPlusTerm *rpn_term (struct lex_info *li, ODR o,
 198                                        oid_proto proto,
 199                                        int num_attr, int *attr_list,
 200                                        oid_value *attr_set)
 201 {
 202     Z_AttributesPlusTerm *zapt;
 203     Odr_oct *term_octet;
 204     Z_Term *term;
 205     Z_AttributeElement **elements;
 206
 207     zapt = (Z_AttributesPlusTerm *)odr_malloc (o, sizeof(*zapt));
 208     term_octet = (Odr_oct *)odr_malloc (o, sizeof(*term_octet));
 209     term = (Z_Term *)odr_malloc (o, sizeof(*term));
 210
 211     if (!num_attr)
 212         elements = (Z_AttributeElement**)odr_nullval();
 213     else
 214     {
 215         int i;
 216         int *attr_tmp;
 217
 218         elements = (Z_AttributeElement**)
 219             odr_malloc (o, num_attr * sizeof(*elements));
 220
 221         attr_tmp = (int *)odr_malloc (o, num_attr * 2 * sizeof(int));
 222         memcpy (attr_tmp, attr_list, num_attr * 2 * sizeof(int));
 223         for (i = 0; i < num_attr; i++)
 224         {
 225             elements[i] =
 226                 (Z_AttributeElement*)odr_malloc (o,sizeof(**elements));
 227             elements[i]->attributeType = &attr_tmp[2*i];
 228             if (attr_set[i] == VAL_NONE)
 229                 elements[i]->attributeSet = 0;
 230             else
 231             {
 232                 oident attrid;
 233                 int oid[OID_SIZE];
 234
 235                 attrid.proto = PROTO_Z3950;
 236                 attrid.oclass = CLASS_ATTSET;
 237                 attrid.value = attr_set[i];
 238
 239                 elements[i]->attributeSet =
 240                     odr_oiddup (o, oid_ent_to_oid (&attrid, oid));
 241             }
 242             elements[i]->which = Z_AttributeValue_numeric;
 243             elements[i]->value.numeric = &attr_tmp[2*i+1];
 244         }
 245     }
 246 #ifdef ASN_COMPILED
 247     zapt->attributes = (Z_AttributeList *)
 248         odr_malloc (o, sizeof(*zapt->attributes));
 249     zapt->attributes->num_attributes = num_attr;
 250     zapt->attributes->attributes = elements;
 251 #else
 252     zapt->num_attributes = num_attr;
 253     zapt->attributeList = elements;
 254 #endif
 255
 256     zapt->term = term;
 257     term->which = Z_Term_general;
 258     term->u.general = term_octet;
 259     term_octet->buf = (unsigned char *)odr_malloc (o, li->lex_len);
 260     term_octet->size = term_octet->len = li->lex_len;
 261     memcpy (term_octet->buf, li->lex_buf, li->lex_len);
 262     return zapt;
 263 }
 264
 265 static Z_Operand *rpn_simple (struct lex_info *li, ODR o, oid_proto proto,
 266                               int num_attr, int *attr_list,
 267                               oid_value *attr_set)
 268 {
 269     Z_Operand *zo;
 270
 271     zo = (Z_Operand *)odr_malloc (o, sizeof(*zo));
 272     switch (li->query_look)
 273     {
 274     case 't':
 275         zo->which = Z_Operand_APT;
 276         if (!(zo->u.attributesPlusTerm =
 277               rpn_term (li, o, proto, num_attr, attr_list, attr_set)))
 278             return NULL;
 279         lex (li);
 280         break;
 281     case 's':
 282         lex (li);
 283         if (!li->query_look)
 284             return NULL;
 285         zo->which = Z_Operand_resultSetId;
 286         zo->u.resultSetId = (char *)odr_malloc (o, li->lex_len+1);
 287         memcpy (zo->u.resultSetId, li->lex_buf, li->lex_len);
 288         zo->u.resultSetId[li->lex_len] = '\0';
 289         lex (li);
 290         break;
 291     default:
 292         return NULL;
 293     }
 294     return zo;
 295 }
 296
 297 static Z_ProximityOperator *rpn_proximity (struct lex_info *li, ODR o)
 298 {
 299     Z_ProximityOperator *p = (Z_ProximityOperator *)odr_malloc (o, sizeof(*p));
 300
 301     if (!lex (li))
 302         return NULL;
 303     if (*li->lex_buf == '1')
 304     {
 305         p->exclusion = (int *)odr_malloc (o, sizeof(*p->exclusion));
 306         *p->exclusion = 1;
 307     }
 308     else if (*li->lex_buf == '0')
 309     {
 310         p->exclusion = (int *)odr_malloc (o, sizeof(*p->exclusion));
 311         *p->exclusion = 0;
 312     }
 313     else
 314         p->exclusion = NULL;
 315
 316     if (!lex (li))
 317         return NULL;
 318     p->distance = (int *)odr_malloc (o, sizeof(*p->distance));
 319     *p->distance = atoi (li->lex_buf);
 320
 321     if (!lex (li))
 322         return NULL;
 323     p->ordered = (int *)odr_malloc (o, sizeof(*p->ordered));
 324     *p->ordered = atoi (li->lex_buf);
 325
 326     if (!lex (li))
 327         return NULL;
 328     p->relationType = (int *)odr_malloc (o, sizeof(*p->relationType));
 329     *p->relationType = atoi (li->lex_buf);
 330
 331     if (!lex (li))
 332         return NULL;
 333     if (*li->lex_buf == 'k')
 334         p->which = 0;
 335     else if (*li->lex_buf == 'p')
 336         p->which = 1;
 337     else
 338         p->which = atoi (li->lex_buf);
 339
 340     if (!lex (li))
 341         return NULL;
 342 #ifdef ASN_COMPILED
 343     p->which = Z_ProximityOperator_known;
 344     p->u.known = (int *)odr_malloc (o, sizeof(*p->u.known));
 345     *p->u.known = atoi (li->lex_buf);
 346 #else
 347     p->proximityUnitCode = (int *)odr_malloc (o, sizeof(*p->proximityUnitCode));
 348     *p->proximityUnitCode = atoi (li->lex_buf);
 349 #endif
 350     return p;
 351 }
 352
 353 static Z_Complex *rpn_complex (struct lex_info *li, ODR o, oid_proto proto,
 354                                int num_attr, int max_attr,
 355                                int *attr_list, oid_value *attr_set)
 356 {
 357     Z_Complex *zc;
 358     Z_Operator *zo;
 359
 360     zc = (Z_Complex *)odr_malloc (o, sizeof(*zc));
 361     zo = (Z_Operator *)odr_malloc (o, sizeof(*zo));
 362     zc->roperator = zo;
 363     switch (li->query_look)
 364     {
 365     case 'a':
 366         zo->which = Z_Operator_and;
 367         zo->u.and = odr_nullval();
 368         break;
 369     case 'o':
 370         zo->which = Z_Operator_or;
 371         zo->u.and = odr_nullval();
 372         break;
 373     case 'n':
 374         zo->which = Z_Operator_and_not;
 375         zo->u.and = odr_nullval();
 376         break;
 377     case 'p':
 378         zo->which = Z_Operator_prox;
 379         zo->u.prox = rpn_proximity (li, o);
 380         if (!zo->u.prox)
 381             return NULL;
 382         break;
 383     default:
 384         return NULL;
 385     }
 386     lex (li);
 387     if (!(zc->s1 =
 388           rpn_structure (li, o, proto, num_attr, max_attr, attr_list,
 389                          attr_set)))
 390         return NULL;
 391     if (!(zc->s2 =
 392           rpn_structure (li, o, proto, num_attr, max_attr, attr_list,
 393                          attr_set)))
 394         return NULL;
 395     return zc;
 396 }
 397
 398 static Z_RPNStructure *rpn_structure (struct lex_info *li, ODR o,
 399                                       oid_proto proto,
 400                                       int num_attr, int max_attr,
 401                                       int *attr_list, oid_value *attr_set)
 402 {
 403     Z_RPNStructure *sz;
 404     const char *cp;
 405     int i, attrtype;
 406
 407     sz = (Z_RPNStructure *)odr_malloc (o, sizeof(*sz));
 408     switch (li->query_look)
 409     {
 410     case 'a':
 411     case 'o':
 412     case 'n':
 413     case 'p':
 414         sz->which = Z_RPNStructure_complex;
 415         if (!(sz->u.complex =
 416               rpn_complex (li, o, proto, num_attr, max_attr, attr_list,
 417                            attr_set)))
 418             return NULL;
 419         break;
 420     case 't':
 421     case 's':
 422         sz->which = Z_RPNStructure_simple;
 423         if (!(sz->u.simple =
 424               rpn_simple (li, o, proto, num_attr, attr_list,
 425                           attr_set)))
 426             return NULL;
 427         break;
 428     case 'l':
 429         lex (li);
 430         if (!li->query_look)
 431             return NULL;
 432         if (num_attr >= max_attr)
 433             return NULL;
 434         if (!(cp = strchr (li->lex_buf, '=')) ||
 435             (size_t) (cp-li->lex_buf) > li->lex_len)
 436         {
 437             attr_set[num_attr] = query_oid_getvalbyname (li);
 438             if (attr_set[num_attr] == VAL_NONE)
 439                 return NULL;
 440             lex (li);
 441
 442             if (!(cp = strchr (li->lex_buf, '=')))
 443                 return NULL;
 444         }
 445         else
 446         {
 447             if (num_attr > 0)
 448                 attr_set[num_attr] = attr_set[num_attr-1];
 449             else
 450                 attr_set[num_attr] = VAL_NONE;
 451         }
 452         attrtype = atoi (li->lex_buf);
 453         for (i = 0; i < num_attr; i++)
 454             if (attrtype == attr_list[2*i])
 455             {
 456                 attr_list[2*i+1] = atoi (cp+1);
 457                 break;
 458             }
 459         if (i == num_attr)
 460         {
 461             attr_list[2*num_attr] = attrtype;
 462             attr_list[2*num_attr+1] = atoi (cp+1);
 463             num_attr++;
 464         }
 465         lex (li);
 466         return
 467             rpn_structure (li, o, proto, num_attr, max_attr, attr_list,
 468                            attr_set);
 469     case 'y':
 470         lex (li);
 471         if (!li->query_look)
 472             return NULL;
 473         if (compare_term (li, "general", 0))
 474             li->term_type = Z_Term_general;
 475         else if (compare_term (li, "numeric", 0))
 476             li->term_type = Z_Term_numeric;
 477         else if (compare_term (li, "string", 0))
 478             li->term_type = Z_Term_characterString;
 479         else if (compare_term (li, "oid", 0))
 480             li->term_type = Z_Term_oid;
 481         else if (compare_term (li, "datetime", 0))
 482             li->term_type = Z_Term_dateTime;
 483         else if (compare_term (li, "null", 0))
 484             li->term_type = Z_Term_null;
 485         lex (li);
 486         return
 487             rpn_structure (li, o, proto, num_attr, max_attr, attr_list,
 488                            attr_set);
 489     case 0:                /* operator/operand expected! */
 490         return NULL;
 491     }
 492     return sz;
 493 }
 494
 495 Z_RPNQuery *p_query_rpn_mk (ODR o, struct lex_info *li, oid_proto proto,
 496                             const char *qbuf)
 497 {
 498     Z_RPNQuery *zq;
 499     int attr_array[1024];
 500     oid_value attr_set[512];
 501     oid_value topSet = VAL_NONE;
 502     oident oset;
 503     int oid[OID_SIZE];
 504
 505     zq = (Z_RPNQuery *)odr_malloc (o, sizeof(*zq));
 506     lex (li);
 507     if (li->query_look == 'r')
 508     {
 509         lex (li);
 510         topSet = query_oid_getvalbyname (li);
 511         if (topSet == VAL_NONE)
 512             return NULL;
 513
 514         lex (li);
 515     }
 516     if (topSet == VAL_NONE)
 517         topSet = p_query_dfset;
 518     if (topSet == VAL_NONE)
 519         topSet = VAL_BIB1;
 520     oset.proto = proto;
 521     oset.oclass = CLASS_ATTSET;
 522     oset.value = topSet;
 523
 524     if (!oid_ent_to_oid (&oset, oid))
 525         return NULL;
 526     zq->attributeSetId = odr_oiddup (o, oid);
 527
 528     if (!(zq->RPNStructure = rpn_structure (li, o, proto, 0, 512,
 529                                             attr_array, attr_set)))
 530         return NULL;
 531     return zq;
 532 }
 533
 534 Z_RPNQuery *p_query_rpn (ODR o, oid_proto proto,
 535                          const char *qbuf)
 536 {
 537     struct lex_info li;
 538
 539     li.left_sep = "{\"";
 540     li.right_sep = "}\"";
 541     li.escape_char = '@';
 542     li.term_type = Z_Term_general;
 543     li.query_buf = qbuf;
 544     return p_query_rpn_mk (o, &li, proto, qbuf);
 545 }
 546
 547 Z_AttributesPlusTerm *p_query_scan_mk (struct lex_info *li,
 548                                        ODR o, oid_proto proto,
 549                                        Odr_oid **attributeSetP,
 550                                        const char *qbuf)
 551 {
 552     int attr_list[1024];
 553     oid_value attr_set[512];
 554     int num_attr = 0;
 555     int max_attr = 512;
 556     const char *cp;
 557     oid_value topSet = VAL_NONE;
 558     oident oset;
 559     int oid[OID_SIZE];
 560
 561     lex (li);
 562     if (li->query_look == 'r')
 563     {
 564         lex (li);
 565         topSet = query_oid_getvalbyname (li);
 566
 567         lex (li);
 568     }
 569     if (topSet == VAL_NONE)
 570         topSet = p_query_dfset;
 571     if (topSet == VAL_NONE)
 572         topSet = VAL_BIB1;
 573     oset.proto = proto;
 574     oset.oclass = CLASS_ATTSET;
 575     oset.value = topSet;
 576
 577     *attributeSetP = odr_oiddup (o, oid_ent_to_oid (&oset, oid));
 578
 579     while (li->query_look == 'l')
 580     {
 581         lex (li);
 582         if (!li->query_look)
 583             return NULL;
 584         if (num_attr >= max_attr)
 585             return NULL;
 586
 587         if (!(cp = strchr (li->lex_buf, '=')) ||
 588             (size_t) (cp-li->lex_buf) > li->lex_len)
 589         {
 590             attr_set[num_attr] = query_oid_getvalbyname (li);
 591             lex (li);
 592
 593             if (!(cp = strchr (li->lex_buf, '=')))
 594                 return NULL;
 595         }
 596         else
 597         {
 598             if (num_attr > 0)
 599                 attr_set[num_attr] = attr_set[num_attr-1];
 600             else
 601                 attr_set[num_attr] = VAL_NONE;
 602         }
 603         attr_list[2*num_attr] = atoi (li->lex_buf);
 604         attr_list[2*num_attr+1] = atoi (cp+1);
 605         num_attr++;
 606         lex (li);
 607     }
 608     if (!li->query_look)
 609         return NULL;
 610     return rpn_term (li, o, proto, num_attr, attr_list, attr_set);
 611 }
 612
 613 Z_AttributesPlusTerm *p_query_scan (ODR o, oid_proto proto,
 614                                     Odr_oid **attributeSetP,
 615                                     const char *qbuf)
 616 {
 617     struct lex_info li;
 618
 619     li.left_sep = "{\"";
 620     li.right_sep = "}\"";
 621     li.escape_char = '@';
 622     li.term_type = Z_Term_general;
 623     li.query_buf = qbuf;
 624
 625     return p_query_scan_mk (&li, o, proto, attributeSetP, qbuf);
 626 }
 627
 628 int p_query_attset (const char *arg)
 629 {
 630     p_query_dfset = oid_getvalbyname (arg);
 631     return (p_query_dfset == VAL_NONE) ? -1 : 0;
 632 }
 633