2 * Copyright (C) 1995-2004, Index Data
5 * $Id: logrpn.c,v 1.6 2004-11-17 00:18:54 adam Exp $
10 * \brief Implements Z39.50 Query Printing
17 #include <yaz/logrpn.h>
19 static const char *relToStr(int v)
24 case 1: str = "Less than"; break;
25 case 2: str = "Less than or equal"; break;
26 case 3: str = "Equal"; break;
27 case 4: str = "Greater or equal"; break;
28 case 5: str = "Greater than"; break;
29 case 6: str = "Not equal"; break;
30 case 100: str = "Phonetic"; break;
31 case 101: str = "Stem"; break;
32 case 102: str = "Relevance"; break;
33 case 103: str = "AlwaysMatches"; break;
38 static void attrStr (int type, int value, enum oid_value ast, char *str)
53 rstr = relToStr(value);
55 sprintf (str, "relation=%s", rstr);
57 sprintf (str, "relation=%d", value);
63 sprintf (str, "position=First in field");
66 sprintf (str, "position=First in any subfield");
69 sprintf (str, "position=Any position in field");
72 sprintf (str, "position");
79 sprintf (str, "structure=Phrase");
82 sprintf (str, "structure=Word");
85 sprintf (str, "structure=Key");
88 sprintf (str, "structure=Year");
91 sprintf (str, "structure=Date");
94 sprintf (str, "structure=Word list");
97 sprintf (str, "structure=Date (un)");
100 sprintf (str, "structure=Name (norm)");
103 sprintf (str, "structure=Name (un)");
106 sprintf (str, "structure=Structure");
109 sprintf (str, "structure=urx");
112 sprintf (str, "structure=free-form-text");
115 sprintf (str, "structure=document-text");
118 sprintf (str, "structure=local-number");
121 sprintf (str, "structure=string");
124 sprintf (str, "structure=numeric string");
127 sprintf (str, "structure");
134 sprintf (str, "truncation=Right");
137 sprintf (str, "truncation=Left");
140 sprintf (str, "truncation=Left&right");
143 sprintf (str, "truncation=Do not truncate");
146 sprintf (str, "truncation=Process #");
149 sprintf (str, "truncation=re-1");
152 sprintf (str, "truncation=re-2");
155 sprintf (str, "truncation=CCL");
158 sprintf (str, "truncation");
165 sprintf (str, "completeness=Incomplete subfield");
168 sprintf (str, "completeness=Complete subfield");
171 sprintf (str, "completeness=Complete field");
174 sprintf (str, "completeness");
183 sprintf (str + strlen(str), " (%d=%d)", type, value);
185 sprintf (str, "%d=%d", type, value);
188 static void wrbuf_term(WRBUF b, const char *term, int len)
191 for (i = 0; i < len; i++)
192 if (strchr(" \"{", term[i]))
195 wrbuf_printf(b, "%.*s ", len, term);
199 for (i = 0; i<len; i++)
203 wrbuf_putc(b, term[i]);
205 wrbuf_printf(b, "\" ");
209 static void wrbuf_attr(WRBUF b, Z_AttributeElement *element)
213 char *sep = ""; /* optional space after attrset name */
214 if (element->attributeSet)
217 attrset = oid_getentbyoid (element->attributeSet);
218 setname = attrset->desc;
221 switch (element->which)
223 case Z_AttributeValue_numeric:
224 wrbuf_printf(b,"@attr %s%s%d=%d ", setname, sep,
225 *element->attributeType, *element->value.numeric);
227 case Z_AttributeValue_complex:
228 wrbuf_printf(b,"@attr %s%s\"%d=", setname, sep,
229 *element->attributeType);
230 for (i = 0; i<element->value.complex->num_list; i++)
234 if (element->value.complex->list[i]->which ==
235 Z_StringOrNumeric_string)
236 wrbuf_printf (b, "%s",
237 element->value.complex->list[i]->u.string);
238 else if (element->value.complex->list[i]->which ==
239 Z_StringOrNumeric_numeric)
240 wrbuf_printf (b, "%d",
241 *element->value.complex->list[i]->u.numeric);
243 wrbuf_printf(b, "\" ");
246 wrbuf_printf (b, "@attr 1=unknown ");
251 * zlog_attributes: print attributes of term
253 static void zlog_attributes (Z_AttributesPlusTerm *t, int depth,
254 enum oid_value ast, int loglevel)
258 int num_attributes = t->attributes->num_attributes;
260 for (of = 0; of < num_attributes; of++)
262 const char *attset_name = "";
263 Z_AttributeElement *element;
264 element = t->attributes->attributes[of];
265 if (element->attributeSet)
268 attrset = oid_getentbyoid (element->attributeSet);
269 attset_name = attrset->desc;
271 switch (element->which)
273 case Z_AttributeValue_numeric:
274 attrStr (*element->attributeType,
275 *element->value.numeric, ast, str);
276 yaz_log (loglevel, "%*.0s%s %s", depth, "", attset_name, str);
278 case Z_AttributeValue_complex:
279 yaz_log (loglevel, "%*.0s%s attributeType=%d complex",
280 depth, "", attset_name, *element->attributeType);
281 for (i = 0; i<element->value.complex->num_list; i++)
283 if (element->value.complex->list[i]->which ==
284 Z_StringOrNumeric_string)
285 yaz_log (loglevel, "%*.0s string: '%s'", depth, "",
286 element->value.complex->list[i]->u.string);
287 else if (element->value.complex->list[i]->which ==
288 Z_StringOrNumeric_numeric)
289 yaz_log (loglevel, "%*.0s numeric: '%d'", depth, "",
290 *element->value.complex->list[i]->u.numeric);
294 yaz_log (loglevel, "%.*s%s attribute unknown",
295 depth, "", attset_name);
300 static char *complex_op_name(Z_Operator *op)
308 case Z_Operator_and_not:
310 case Z_Operator_prox:
313 return "unknown complex operator";
317 static char *prox_unit_name(Z_ProximityOperator *op)
319 if (op->which!=Z_ProximityOperator_known)
323 case Z_ProxUnit_character: return "character";
324 case Z_ProxUnit_word: return "word";
325 case Z_ProxUnit_sentence: return "sentence";
326 case Z_ProxUnit_paragraph: return "paragraph";
327 case Z_ProxUnit_section: return "section";
328 case Z_ProxUnit_chapter: return "chapter";
329 case Z_ProxUnit_document: return "document";
330 case Z_ProxUnit_element: return "element";
331 case Z_ProxUnit_subelement: return "subelement";
332 case Z_ProxUnit_elementType: return "elementType";
333 case Z_ProxUnit_byte: return "byte";
334 default: return "unknown";
338 static void zlog_structure (Z_RPNStructure *zs, int depth,
339 enum oid_value ast, int loglevel)
341 if (zs->which == Z_RPNStructure_complex)
343 Z_Operator *op = zs->u.complex->roperator;
348 case Z_Operator_and_not:
349 yaz_log (loglevel, "%*.0s %s", depth, "", complex_op_name(op) );
351 case Z_Operator_prox:
352 yaz_log (loglevel, "%*.0s prox excl=%s dist=%d order=%s "
354 depth, "", op->u.prox->exclusion ?
355 (*op->u.prox->exclusion ? "T" : "F") : "N",
356 *op->u.prox->distance,
357 *op->u.prox->ordered ? "T" : "F",
358 relToStr(*op->u.prox->relationType),
359 prox_unit_name(op->u.prox) );
362 yaz_log (loglevel, "%*.0s unknown complex", depth, "");
365 zlog_structure (zs->u.complex->s1, depth+2, ast, loglevel);
366 zlog_structure (zs->u.complex->s2, depth+2, ast, loglevel);
368 else if (zs->which == Z_RPNStructure_simple)
370 if (zs->u.simple->which == Z_Operand_APT)
372 Z_AttributesPlusTerm *zapt = zs->u.simple->u.attributesPlusTerm;
374 switch (zapt->term->which)
377 yaz_log (loglevel, "%*.0s term '%.*s' (general)", depth, "",
378 zapt->term->u.general->len,
379 zapt->term->u.general->buf);
381 case Z_Term_characterString:
382 yaz_log (loglevel, "%*.0s term '%s' (string)", depth, "",
383 zapt->term->u.characterString);
386 yaz_log (loglevel, "%*.0s term '%d' (numeric)", depth, "",
387 *zapt->term->u.numeric);
390 yaz_log (loglevel, "%*.0s term (null)", depth, "");
393 yaz_log (loglevel, "%*.0s term (not general)", depth, "");
395 zlog_attributes (zapt, depth+2, ast, loglevel);
397 else if (zs->u.simple->which == Z_Operand_resultSetId)
399 yaz_log (loglevel, "%*.0s set '%s'", depth, "",
400 zs->u.simple->u.resultSetId);
403 yaz_log (loglevel, "%*.0s unknown simple structure", depth, "");
406 yaz_log (loglevel, "%*.0s unknown structure", depth, "");
409 static void wrbuf_apt(WRBUF b, Z_AttributesPlusTerm *zapt)
411 int num_attributes = zapt->attributes->num_attributes;
413 for (i = 0; i<num_attributes; i++)
414 wrbuf_attr(b,zapt->attributes->attributes[i]);
416 switch (zapt->term->which)
419 wrbuf_term(b, zapt->term->u.general->buf,
420 zapt->term->u.general->len);
422 case Z_Term_characterString:
423 wrbuf_printf(b, "@term string ");
424 wrbuf_term (b, zapt->term->u.characterString,
425 strlen(zapt->term->u.characterString));
428 wrbuf_printf(b, "@term numeric %d ", *zapt->term->u.numeric);
431 wrbuf_printf(b, "@term null x");
434 wrbuf_printf(b, "@term null unknown%d ", zapt->term->which);
438 static void wrbuf_structure (WRBUF b, Z_RPNStructure *zs, enum oid_value ast)
441 if (zs->which == Z_RPNStructure_complex)
443 Z_Operator *op = zs->u.complex->roperator;
444 wrbuf_printf(b, "@%s ", complex_op_name(op) );
445 if (op->which== Z_Operator_prox)
447 if (!op->u.prox->exclusion)
449 else if (*op->u.prox->exclusion)
454 wrbuf_printf(b, " %d %d %d ", *op->u.prox->distance,
455 *op->u.prox->ordered,
456 *op->u.prox->relationType);
458 switch(op->u.prox->which)
460 case Z_ProximityOperator_known:
463 case Z_ProximityOperator_private:
467 wrbuf_printf(b, "%d", op->u.prox->which);
469 if (op->u.prox->u.known)
470 wrbuf_printf(b, " %d ", *op->u.prox->u.known);
472 wrbuf_printf(b, " 0 ");
474 wrbuf_structure (b,zs->u.complex->s1, ast);
475 wrbuf_structure (b,zs->u.complex->s2, ast);
477 else if (zs->which == Z_RPNStructure_simple)
479 if (zs->u.simple->which == Z_Operand_APT)
480 wrbuf_apt(b, zs->u.simple->u.attributesPlusTerm);
481 else if (zs->u.simple->which == Z_Operand_resultSetId)
483 wrbuf_printf(b, "@set ");
484 wrbuf_term(b, zs->u.simple->u.resultSetId,
485 strlen(zs->u.simple->u.resultSetId));
488 wrbuf_printf (b, "(unknown simple structure)");
491 wrbuf_puts(b, "(unknown structure)");
494 void log_rpn_query_level (int loglevel, Z_RPNQuery *rpn)
499 attrset = oid_getentbyoid (rpn->attributeSetId);
502 ast = attrset->value;
503 yaz_log (loglevel, "RPN query. Type: %s", attrset->desc);
508 yaz_log (loglevel, "RPN query. Unknown type");
510 zlog_structure (rpn->RPNStructure, 0, ast, loglevel);
513 static void wrbuf_rpn_query(WRBUF b, Z_RPNQuery *rpn)
518 attrset = oid_getentbyoid (rpn->attributeSetId);
521 ast = attrset->value;
522 wrbuf_printf(b, " @attrset %s ", attrset->desc);
527 wrbuf_printf (b, "Unknown:");
529 wrbuf_structure (b,rpn->RPNStructure, ast);
533 void log_rpn_query (Z_RPNQuery *rpn)
535 log_rpn_query_level(LOG_LOG, rpn);
538 void log_scan_term_level (int loglevel,
539 Z_AttributesPlusTerm *zapt, oid_value ast)
544 if (zapt->term->which == Z_Term_general)
546 yaz_log (loglevel, "%*.0s term '%.*s' (general)", depth, "",
547 zapt->term->u.general->len, zapt->term->u.general->buf);
550 yaz_log (loglevel, "%*.0s term (not general)", depth, "");
551 zlog_attributes (zapt, depth+2, ast, loglevel);
554 void log_scan_term (Z_AttributesPlusTerm *zapt, oid_value ast)
556 log_scan_term_level (LOG_LOG, zapt, ast);
559 void wrbuf_scan_term(WRBUF b, Z_AttributesPlusTerm *zapt, oid_value ast)
564 void yaz_log_zquery_level (int loglevel, Z_Query *q)
570 case Z_Query_type_1: case Z_Query_type_101:
571 log_rpn_query_level (loglevel, q->u.type_1);
574 yaz_log(loglevel, "CCL: %.*s", q->u.type_2->len, q->u.type_2->buf);
576 case Z_Query_type_100:
577 yaz_log(loglevel, "Z39.58: %.*s", q->u.type_100->len,
580 case Z_Query_type_104:
581 if (q->u.type_104->which == Z_External_CQL)
582 yaz_log (loglevel, "CQL: %s", q->u.type_104->u.cql);
586 void yaz_log_zquery (Z_Query *q)
588 yaz_log_zquery_level(LOG_LOG,q);
591 void wrbuf_put_zquery(WRBUF b, Z_Query *q)
598 case Z_Query_type_101:
599 wrbuf_printf(b,"Z:");
600 wrbuf_rpn_query(b,q->u.type_1);
603 wrbuf_printf(b, "CCL: %.*s", q->u.type_2->len, q->u.type_2->buf);
605 case Z_Query_type_100:
606 wrbuf_printf(b, "Z39.58: %.*s", q->u.type_100->len,
609 case Z_Query_type_104:
610 if (q->u.type_104->which == Z_External_CQL)
611 wrbuf_printf(b, "CQL: %s", q->u.type_104->u.cql);
613 wrbuf_printf(b,"Unknown type 104 query %d", q->u.type_104->which);
617 void wrbuf_diags(WRBUF b, int num_diagnostics,Z_DiagRec **diags)
619 /* we only dump the first diag - that keeps the log cleaner. */
620 wrbuf_printf(b," ERROR ");
621 if (diags[0]->which != Z_DiagRec_defaultFormat)
622 wrbuf_printf(b,"(diag not in default format?)");
625 Z_DefaultDiagFormat *e=diags[0]->u.defaultFormat;
627 wrbuf_printf(b, "%d ",*e->condition);
629 wrbuf_printf(b, "?? ");
630 if ((e->which==Z_DefaultDiagFormat_v2Addinfo) && (e->u.v2Addinfo))
631 wrbuf_printf(b,"%s ",e->u.v2Addinfo);
632 else if ((e->which==Z_DefaultDiagFormat_v3Addinfo) && (e->u.v3Addinfo))
633 wrbuf_printf(b,"%s ",e->u.v3Addinfo);