src/srwutil.c

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2013 Index Data
   3  * See the file LICENSE for details.
   4  */
   5 /**
   6  * \file srwutil.c
   7  * \brief Implements SRW/SRU utilities.
   8  */
   9 #if HAVE_CONFIG_H
  10 #include <config.h>
  11 #endif
  12
  13 #include <stdlib.h>
  14 #include <assert.h>
  15 #include <yaz/srw.h>
  16 #include <yaz/matchstr.h>
  17 #include <yaz/base64.h>
  18 #include <yaz/yaz-iconv.h>
  19 #include "sru-p.h"
  20
  21 #define MAX_SRU_PARAMETERS 30
  22
  23 static char *yaz_decode_sru_dbpath_odr(ODR n, const char *uri, size_t len)
  24 {
  25     return odr_strdupn(n, uri, len);
  26 }
  27
  28 void yaz_encode_sru_dbpath_buf(char *dst, const char *db)
  29 {
  30     assert(db);
  31     *dst = '/';
  32     strcpy(dst+1, db);
  33 }
  34
  35 char *yaz_encode_sru_dbpath_odr(ODR out, const char *db)
  36 {
  37     char *dst = odr_malloc(out, 3 * strlen(db) + 2);
  38     yaz_encode_sru_dbpath_buf(dst, db);
  39     return dst;
  40 }
  41
  42 Z_AttributeList *yaz_use_attribute_create(ODR o, const char *name)
  43 {
  44     Z_AttributeList *attributes= (Z_AttributeList *)
  45         odr_malloc(o, sizeof(*attributes));
  46     Z_AttributeElement ** elements;
  47     attributes->num_attributes = 1;
  48     elements = (Z_AttributeElement**)
  49         odr_malloc(o, attributes->num_attributes * sizeof(*elements));
  50     elements[0] = (Z_AttributeElement*) odr_malloc(o,sizeof(**elements));
  51     elements[0]->attributeType = odr_intdup(o, 1);
  52     elements[0]->attributeSet = odr_nullval();
  53     elements[0]->which = Z_AttributeValue_complex;
  54     elements[0]->value.complex = (Z_ComplexAttribute *)
  55         odr_malloc(o, sizeof(Z_ComplexAttribute));
  56     elements[0]->value.complex->num_list = 1;
  57     elements[0]->value.complex->list = (Z_StringOrNumeric **)
  58         odr_malloc(o, 1 * sizeof(Z_StringOrNumeric *));
  59     elements[0]->value.complex->list[0] = (Z_StringOrNumeric *)
  60         odr_malloc(o, sizeof(Z_StringOrNumeric));
  61     elements[0]->value.complex->list[0]->which = Z_StringOrNumeric_string;
  62     elements[0]->value.complex->list[0]->u.string = odr_strdup(o, name);
  63     elements[0]->value.complex->semanticAction = 0;
  64     elements[0]->value.complex->num_semanticAction = 0;
  65     attributes->attributes = elements;
  66     return attributes;
  67 }
  68
  69 #if YAZ_HAVE_XML2
  70 const char *yaz_element_attribute_value_get(xmlNodePtr ptr,
  71                                             const char *node_name,
  72                                             const char *attribute_name)
  73 {
  74     struct _xmlAttr *attr;
  75     // check if the node name matches
  76     if (strcmp((const char*) ptr->name, node_name))
  77         return 0;
  78     // check if the attribute name and return the value
  79     for (attr = ptr->properties; attr; attr = attr->next)
  80         if (attr->children && attr->children->type == XML_TEXT_NODE)
  81         {
  82             if (!strcmp((const char *) attr->name, attribute_name))
  83                 return (const char *) attr->children->content;
  84         }
  85     return 0;
  86 }
  87 #endif
  88
  89 int yaz_srw_check_content_type(Z_HTTP_Response *hres)
  90 {
  91     const char *content_type = z_HTTP_header_lookup(hres->headers,
  92                                                     "Content-Type");
  93     if (content_type)
  94     {
  95         if (!yaz_strcmp_del("text/xml", content_type, "; "))
  96             return 1;
  97         if (!yaz_strcmp_del("application/xml", content_type, "; "))
  98             return 1;
  99     }
 100     return 0;
 101 }
 102
 103 /**
 104  * Look for authentication tokens in HTTP Basic parameters or in x-username/x-password
 105  * parameters. Added by SH.
 106  */
 107 static void yaz_srw_decodeauth(Z_SRW_PDU *sr, Z_HTTP_Request *hreq,
 108                                char *username, char *password, ODR decode)
 109 {
 110     const char *basic = z_HTTP_header_lookup(hreq->headers, "Authorization");
 111
 112     if (username)
 113         sr->username = username;
 114     if (password)
 115         sr->password = password;
 116
 117     if (basic)
 118     {
 119         int len;
 120         char out[256];
 121         char ubuf[256] = "", pbuf[256] = "", *p;
 122         if (strncmp(basic, "Basic ", 6))
 123             return;
 124         basic += 6;
 125         len = strlen(basic);
 126         if (!len || len > 256)
 127             return;
 128         yaz_base64decode(basic, out);
 129         /* Format of out should be username:password at this point */
 130         strcpy(ubuf, out);
 131         if ((p = strchr(ubuf, ':')))
 132         {
 133             *(p++) = '\0';
 134             if (*p)
 135                 strcpy(pbuf, p);
 136         }
 137         if (*ubuf)
 138             sr->username = odr_strdup(decode, ubuf);
 139         if (*pbuf)
 140             sr->password = odr_strdup(decode, pbuf);
 141     }
 142 }
 143
 144 void yaz_uri_val_int(const char *path, const char *name, ODR o, Odr_int **intp)
 145 {
 146     const char *v = yaz_uri_val(path, name, o);
 147     if (v)
 148         *intp = odr_intdup(o, atoi(v));
 149 }
 150
 151 void yaz_mk_srw_diagnostic(ODR o, Z_SRW_diagnostic *d,
 152                            const char *uri, const char *message,
 153                            const char *details)
 154 {
 155     d->uri = odr_strdup(o, uri);
 156     if (message)
 157         d->message = odr_strdup(o, message);
 158     else
 159         d->message = 0;
 160     if (details)
 161         d->details = odr_strdup(o, details);
 162     else
 163         d->details = 0;
 164 }
 165
 166 void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d,
 167                            int code, const char *details)
 168 {
 169     char uri[40];
 170
 171     sprintf(uri, "info:srw/diagnostic/1/%d", code);
 172     yaz_mk_srw_diagnostic(o, d, uri, 0, details);
 173 }
 174
 175 void yaz_add_srw_diagnostic_uri(ODR o, Z_SRW_diagnostic **d,
 176                                 int *num, const char *uri,
 177                                 const char *message, const char *details)
 178 {
 179     Z_SRW_diagnostic *d_new;
 180     d_new = (Z_SRW_diagnostic *) odr_malloc(o, (*num + 1)* sizeof(**d));
 181     if (*num)
 182         memcpy(d_new, *d, *num *sizeof(**d));
 183     *d = d_new;
 184
 185     yaz_mk_srw_diagnostic(o, *d + *num, uri, message, details);
 186     (*num)++;
 187 }
 188
 189 void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
 190                             int *num, int code, const char *addinfo)
 191 {
 192     char uri[40];
 193
 194     sprintf(uri, "info:srw/diagnostic/1/%d", code);
 195     yaz_add_srw_diagnostic_uri(o, d, num, uri, 0, addinfo);
 196 }
 197
 198
 199 void yaz_add_sru_update_diagnostic(ODR o, Z_SRW_diagnostic **d,
 200                                    int *num, int code, const char *addinfo)
 201 {
 202     char uri[40];
 203
 204     sprintf(uri, "info:srw/diagnostic/12/%d", code);
 205     yaz_add_srw_diagnostic_uri(o, d, num, uri, 0, addinfo);
 206 }
 207
 208
 209 void yaz_mk_sru_surrogate(ODR o, Z_SRW_record *record, int pos,
 210                           int code, const char *details)
 211 {
 212     const char *message = yaz_diag_srw_str(code);
 213     int len = 200;
 214     if (message)
 215         len += strlen(message);
 216     if (details)
 217         len += strlen(details);
 218
 219     record->recordData_buf = (char *) odr_malloc(o, len);
 220
 221     sprintf(record->recordData_buf, "<diagnostic "
 222             "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
 223             " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
 224     if (details)
 225         sprintf(record->recordData_buf + strlen(record->recordData_buf),
 226                 " <details>%s</details>\n", details);
 227     if (message)
 228         sprintf(record->recordData_buf + strlen(record->recordData_buf),
 229                 " <message>%s</message>\n", message);
 230     sprintf(record->recordData_buf + strlen(record->recordData_buf),
 231             "</diagnostic>\n");
 232     record->recordData_len = strlen(record->recordData_buf);
 233     record->recordPosition = odr_intdup(o, pos);
 234     record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
 235 }
 236
 237 static void grab_charset(ODR o, const char *content_type, char **charset)
 238 {
 239     if (charset)
 240     {
 241         const char *charset_p = 0;
 242         if (content_type && (charset_p = strstr(content_type, "; charset=")))
 243         {
 244             int i = 0;
 245             charset_p += 10;
 246             while (i < 20 && charset_p[i] &&
 247                    !strchr("; \n\r", charset_p[i]))
 248                 i++;
 249             *charset = (char*) odr_malloc(o, i+1);
 250             memcpy(*charset, charset_p, i);
 251             (*charset)[i] = '\0';
 252         }
 253     }
 254 }
 255
 256 int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 257                    Z_SOAP **soap_package, ODR decode, char **charset)
 258 {
 259     if (!strcmp(hreq->method, "POST"))
 260     {
 261         const char *content_type = z_HTTP_header_lookup(hreq->headers,
 262                                                         "Content-Type");
 263         if (content_type &&
 264             (!yaz_strcmp_del("text/xml", content_type, "; ") ||
 265              !yaz_strcmp_del("application/soap+xml", content_type, "; ") ||
 266              !yaz_strcmp_del("text/plain", content_type, "; ")))
 267         {
 268             char *db = "Default";
 269             const char *p0 = hreq->path, *p1;
 270             int ret = -1;
 271
 272             static Z_SOAP_Handler soap_handlers[5] = {
 273 #if YAZ_HAVE_XML2
 274                 { YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec },
 275                 { YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec },
 276                 { YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec },
 277                 { YAZ_XMLNS_SRU_v2_mask, 0, (Z_SOAP_fun) yaz_srw_codec },
 278 #endif
 279                 {0, 0, 0}
 280             };
 281
 282             if (*p0 == '/')
 283                 p0++;
 284             p1 = strchr(p0, '?');
 285             if (!p1)
 286                 p1 = p0 + strlen(p0);
 287             if (p1 != p0)
 288                 db = yaz_decode_sru_dbpath_odr(decode, p0, p1 - p0);
 289             grab_charset(decode, content_type, charset);
 290
 291             ret = z_soap_codec(decode, soap_package,
 292                                &hreq->content_buf, &hreq->content_len,
 293                                soap_handlers);
 294             if (ret == 0 && (*soap_package)->which == Z_SOAP_generic)
 295             {
 296                 *srw_pdu = (Z_SRW_PDU*) (*soap_package)->u.generic->p;
 297                 yaz_srw_decodeauth(*srw_pdu, hreq, 0, 0, decode);
 298
 299                 /* last entry in handlers - SRU 2.0 - is turned into
 300                    offset 0.. due to other pieces relying on it */
 301                 if ((*soap_package)->u.generic->no == 3)
 302                     (*soap_package)->u.generic->no = 0;
 303                 if ((*srw_pdu)->which == Z_SRW_searchRetrieve_request &&
 304                     (*srw_pdu)->u.request->database == 0)
 305                     (*srw_pdu)->u.request->database = db;
 306
 307                 if ((*srw_pdu)->which == Z_SRW_explain_request &&
 308                     (*srw_pdu)->u.explain_request->database == 0)
 309                     (*srw_pdu)->u.explain_request->database = db;
 310
 311                 if ((*srw_pdu)->which == Z_SRW_scan_request &&
 312                     (*srw_pdu)->u.scan_request->database == 0)
 313                     (*srw_pdu)->u.scan_request->database = db;
 314
 315                 if ((*srw_pdu)->which == Z_SRW_update_request &&
 316                     (*srw_pdu)->u.update_request->database == 0)
 317                     (*srw_pdu)->u.update_request->database = db;
 318
 319                 return 0;
 320             }
 321             return 1;
 322         }
 323     }
 324     return 2;
 325 }
 326
 327 #if YAZ_HAVE_XML2
 328 static int yaz_sru_decode_integer(ODR odr, const char *pname,
 329                                   const char *valstr, Odr_int **valp,
 330                                   Z_SRW_diagnostic **diag, int *num_diag,
 331                                   int min_value)
 332 {
 333     int ival;
 334     if (!valstr)
 335         return 0;
 336     if (sscanf(valstr, "%d", &ival) != 1)
 337     {
 338         yaz_add_srw_diagnostic(odr, diag, num_diag,
 339                                YAZ_SRW_UNSUPP_PARAMETER_VALUE, pname);
 340         return 0;
 341     }
 342     if (min_value >= 0 && ival < min_value)
 343     {
 344         yaz_add_srw_diagnostic(odr, diag, num_diag,
 345                                YAZ_SRW_UNSUPP_PARAMETER_VALUE, pname);
 346         return 0;
 347     }
 348     *valp = odr_intdup(odr, ival);
 349     return 1;
 350 }
 351 #endif
 352
 353 /**
 354    http://www.loc.gov/z3950/agency/zing/srw/service.html
 355 */
 356 int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 357                    Z_SOAP **soap_package, ODR decode, char **charset,
 358                    Z_SRW_diagnostic **diag, int *num_diag)
 359 {
 360 #if YAZ_HAVE_XML2
 361     static Z_SOAP_Handler soap_handlers[2] = {
 362         {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
 363         {0, 0, 0}
 364     };
 365 #endif
 366     const char *content_type = z_HTTP_header_lookup(hreq->headers,
 367                                                     "Content-Type");
 368
 369     /*
 370       SRU GET: ignore content type.
 371       SRU POST: we support "application/x-www-form-urlencoded";
 372       not  "multipart/form-data" .
 373     */
 374     if (!strcmp(hreq->method, "GET")
 375         ||
 376         (!strcmp(hreq->method, "POST") && content_type &&
 377          !yaz_strcmp_del("application/x-www-form-urlencoded",
 378                          content_type, "; ")))
 379     {
 380         char *db = "Default";
 381         const char *p0 = hreq->path, *p1;
 382 #if YAZ_HAVE_XML2
 383         const char *operation = 0;
 384         char *version = 0;
 385         char *query = 0;
 386         char *queryType = "cql";
 387         char *username = 0;
 388         char *password = 0;
 389         char *sortKeys = 0;
 390         char *stylesheet = 0;
 391         char *scanClause = 0;
 392         char *recordXPath = 0;
 393         char *recordSchema = 0;
 394         char *recordXMLEscaping = 0;
 395         char *recordPacking = 0;
 396         char *maximumRecords = 0;
 397         char *startRecord = 0;
 398         char *maximumTerms = 0;
 399         char *responsePosition = 0;
 400         Z_SRW_extra_arg *extra_args = 0;
 401 #endif
 402         char **uri_name;
 403         char **uri_val;
 404
 405         grab_charset(decode, content_type, charset);
 406         if (charset && *charset == 0 && !strcmp(hreq->method, "GET"))
 407             *charset = "UTF-8";
 408
 409         if (*p0 == '/')
 410             p0++;
 411         p1 = strchr(p0, '?');
 412         if (!p1)
 413             p1 = p0 + strlen(p0);
 414         if (p1 != p0)
 415             db = yaz_decode_sru_dbpath_odr(decode, p0, p1 - p0);
 416         if (!strcmp(hreq->method, "POST"))
 417             p1 = hreq->content_buf;
 418         yaz_uri_to_array(p1, decode, &uri_name, &uri_val);
 419 #if YAZ_HAVE_XML2
 420         if (uri_name)
 421         {
 422             int i;
 423             for (i = 0; uri_name[i]; i++)
 424             {
 425                 char *n = uri_name[i];
 426                 char *v = uri_val[i];
 427                 if (!strcmp(n, "query"))
 428                     query = v;
 429                 else if (!strcmp(n, "x-pquery"))
 430                 {
 431                     query = v;
 432                     queryType = "pqf";
 433                 }
 434                 else if (!strcmp(n, "queryType"))
 435                     queryType = v;
 436                 else if (!strcmp(n, "x-username"))
 437                     username = v;
 438                 else if (!strcmp(n, "x-password"))
 439                     password = v;
 440                 else if (!strcmp(n, "operation"))
 441                     operation = v;
 442                 else if (!strcmp(n, "stylesheet"))
 443                     stylesheet = v;
 444                 else if (!strcmp(n, "sortKeys"))
 445                     sortKeys = v;
 446                 else if (!strcmp(n, "recordXPath"))
 447                     recordXPath = v;
 448                 else if (!strcmp(n, "recordSchema"))
 449                     recordSchema = v;
 450                 else if (!strcmp(n, "recordPacking"))
 451                     recordPacking = v;
 452                 else if (!strcmp(n, "recordXMLEscaping"))
 453                     recordXMLEscaping = v;
 454                 else if (!strcmp(n, "version"))
 455                     version = v;
 456                 else if (!strcmp(n, "scanClause"))
 457                     scanClause = v;
 458                 else if (!strcmp(n, "x-pScanClause"))
 459                 {
 460                     scanClause = v;
 461                     queryType = "pqf";
 462                 }
 463                 else if (!strcmp(n, "maximumRecords"))
 464                     maximumRecords = v;
 465                 else if (!strcmp(n, "startRecord"))
 466                     startRecord = v;
 467                 else if (!strcmp(n, "maximumTerms"))
 468                     maximumTerms = v;
 469                 else if (!strcmp(n, "responsePosition"))
 470                     responsePosition = v;
 471                 else if (!strcmp(n, "extraRequestData"))
 472                     ; /* ignoring extraRequestData */
 473                 else if (n[0] == 'x' && n[1] == '-')
 474                 {
 475                     Z_SRW_extra_arg **l = &extra_args;
 476                     while (*l)
 477                         l = &(*l)->next;
 478                     *l = (Z_SRW_extra_arg *) odr_malloc(decode, sizeof(**l));
 479                     (*l)->name = odr_strdup(decode, n);
 480                     (*l)->value = odr_strdup(decode, v);
 481                     (*l)->next = 0;
 482                 }
 483                 else
 484                 {
 485                     if (*num_diag < 10)
 486                         yaz_add_srw_diagnostic(decode, diag, num_diag,
 487                                                YAZ_SRW_UNSUPP_PARAMETER, n);
 488                 }
 489             }
 490         }
 491         if (!operation)
 492         {
 493             if (query)
 494                 operation = "searchRetrieve";
 495             else if (scanClause)
 496                 operation = "scan";
 497         }
 498         version = yaz_negotiate_sru_version(version);
 499
 500         if (!version)
 501         {   /* negotiation failed. */
 502             yaz_add_srw_diagnostic(decode, diag, num_diag,
 503                                    YAZ_SRW_UNSUPP_VERSION, "2.0");
 504             version = "2.0";
 505         }
 506         if (!operation)
 507         {
 508             if (uri_name)
 509                 yaz_add_srw_diagnostic(
 510                     decode, diag, num_diag,
 511                     YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "operation");
 512             operation = "explain";
 513         }
 514         if (strcmp(version, "2.0"))
 515         {
 516             if (recordXMLEscaping)
 517             {
 518                 yaz_add_srw_diagnostic(decode, diag, num_diag,
 519                                        YAZ_SRW_UNSUPP_PARAMETER,
 520                                        "recordXMLEscaping");
 521
 522             }
 523             recordXMLEscaping = recordPacking;
 524             recordPacking = "packed";
 525         }
 526         if (!recordXMLEscaping)
 527             recordXMLEscaping = "xml";
 528         if (!strcmp(operation, "searchRetrieve"))
 529         {
 530             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_searchRetrieve_request);
 531
 532             sr->srw_version = version;
 533             sr->extra_args = extra_args;
 534             *srw_pdu = sr;
 535             yaz_srw_decodeauth(sr, hreq, username, password, decode);
 536
 537             sr->u.request->queryType = queryType;
 538             sr->u.request->query = query;
 539
 540             if (!query)
 541                 yaz_add_srw_diagnostic(
 542                     decode, diag, num_diag,
 543                     YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "query");
 544
 545             if (sortKeys)
 546             {
 547                 sr->u.request->sort_type = Z_SRW_sort_type_sort;
 548                 sr->u.request->sort.sortKeys = sortKeys;
 549             }
 550             sr->u.request->recordXPath = recordXPath;
 551             sr->u.request->recordSchema = recordSchema;
 552             sr->u.request->recordPacking = recordXMLEscaping;
 553             sr->u.request->packing = recordPacking;
 554             sr->u.request->stylesheet = stylesheet;
 555
 556             yaz_sru_decode_integer(decode, "maximumRecords", maximumRecords,
 557                                    &sr->u.request->maximumRecords,
 558                                    diag, num_diag, 0);
 559
 560             yaz_sru_decode_integer(decode, "startRecord", startRecord,
 561                                    &sr->u.request->startRecord,
 562                                    diag, num_diag, 1);
 563
 564             sr->u.request->database = db;
 565
 566             (*soap_package) = (Z_SOAP *)
 567                 odr_malloc(decode, sizeof(**soap_package));
 568             (*soap_package)->which = Z_SOAP_generic;
 569
 570             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 571                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 572
 573             (*soap_package)->u.generic->p = sr;
 574             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 575             (*soap_package)->u.generic->no = 0;
 576
 577             (*soap_package)->ns = "SRU";
 578
 579             return 0;
 580         }
 581         else if (!strcmp(operation, "explain"))
 582         {
 583             /* Transfer SRU explain parameters to common struct */
 584             /* http://www.loc.gov/z3950/agency/zing/srw/explain.html */
 585             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request);
 586
 587             sr->srw_version = version;
 588             sr->extra_args = extra_args;
 589             yaz_srw_decodeauth(sr, hreq, username, password, decode);
 590             *srw_pdu = sr;
 591             sr->u.explain_request->recordPacking = recordXMLEscaping;
 592             sr->u.explain_request->packing = recordPacking;
 593             sr->u.explain_request->database = db;
 594
 595             sr->u.explain_request->stylesheet = stylesheet;
 596
 597             (*soap_package) = (Z_SOAP *)
 598                 odr_malloc(decode, sizeof(**soap_package));
 599             (*soap_package)->which = Z_SOAP_generic;
 600
 601             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 602                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 603
 604             (*soap_package)->u.generic->p = sr;
 605             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 606             (*soap_package)->u.generic->no = 0;
 607
 608             (*soap_package)->ns = "SRU";
 609
 610             return 0;
 611         }
 612         else if (!strcmp(operation, "scan"))
 613         {
 614             /* Transfer SRU scan parameters to common struct */
 615             /* http://www.loc.gov/z3950/agency/zing/srw/scan.html */
 616             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_scan_request);
 617
 618             sr->srw_version = version;
 619             sr->extra_args = extra_args;
 620             *srw_pdu = sr;
 621             yaz_srw_decodeauth(sr, hreq, username, password, decode);
 622
 623             sr->u.scan_request->queryType = queryType;
 624             sr->u.scan_request->scanClause = scanClause;
 625
 626             if (!scanClause)
 627                 yaz_add_srw_diagnostic(
 628                     decode, diag, num_diag,
 629                     YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "scanClause");
 630             sr->u.scan_request->database = db;
 631
 632             yaz_sru_decode_integer(decode, "maximumTerms",
 633                                    maximumTerms,
 634                                    &sr->u.scan_request->maximumTerms,
 635                                    diag, num_diag, 0);
 636
 637             yaz_sru_decode_integer(decode, "responsePosition",
 638                                    responsePosition,
 639                                    &sr->u.scan_request->responsePosition,
 640                                    diag, num_diag, 0);
 641
 642             sr->u.scan_request->stylesheet = stylesheet;
 643
 644             (*soap_package) = (Z_SOAP *)
 645                 odr_malloc(decode, sizeof(**soap_package));
 646             (*soap_package)->which = Z_SOAP_generic;
 647
 648             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 649                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 650
 651             (*soap_package)->u.generic->p = sr;
 652             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 653             (*soap_package)->u.generic->no = 0;
 654
 655             (*soap_package)->ns = "SRU";
 656
 657             return 0;
 658         }
 659         else
 660         {
 661             /* unsupported operation ... */
 662             /* Act as if we received a explain request and throw diagnostic. */
 663
 664             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request);
 665
 666             sr->srw_version = version;
 667             *srw_pdu = sr;
 668             sr->u.explain_request->recordPacking = recordPacking;
 669             sr->u.explain_request->database = db;
 670
 671             sr->u.explain_request->stylesheet = stylesheet;
 672
 673             (*soap_package) = (Z_SOAP *)
 674                 odr_malloc(decode, sizeof(**soap_package));
 675             (*soap_package)->which = Z_SOAP_generic;
 676
 677             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 678                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 679
 680             (*soap_package)->u.generic->p = sr;
 681             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 682             (*soap_package)->u.generic->no = 0;
 683
 684             (*soap_package)->ns = "SRU";
 685
 686             yaz_add_srw_diagnostic(decode, diag, num_diag,
 687                                    YAZ_SRW_UNSUPP_OPERATION, operation);
 688             return 0;
 689         }
 690 #else
 691         return 1;
 692 #endif
 693     }
 694     return 2;
 695 }
 696
 697 Z_SRW_extra_record *yaz_srw_get_extra_record(ODR o)
 698 {
 699     Z_SRW_extra_record *res = (Z_SRW_extra_record *)
 700         odr_malloc(o, sizeof(*res));
 701
 702     res->extraRecordData_buf = 0;
 703     res->extraRecordData_len = 0;
 704     res->recordIdentifier = 0;
 705     return res;
 706 }
 707
 708
 709 Z_SRW_record *yaz_srw_get_records(ODR o, int n)
 710 {
 711     Z_SRW_record *res = (Z_SRW_record *) odr_malloc(o, n * sizeof(*res));
 712     int i;
 713
 714     for (i = 0; i<n; i++)
 715     {
 716         res[i].recordSchema = 0;
 717         res[i].recordPacking = Z_SRW_recordPacking_string;
 718         res[i].recordData_buf = 0;
 719         res[i].recordData_len = 0;
 720         res[i].recordPosition = 0;
 721     }
 722     return res;
 723 }
 724
 725 Z_SRW_record *yaz_srw_get_record(ODR o)
 726 {
 727     return yaz_srw_get_records(o, 1);
 728 }
 729
 730 static Z_SRW_PDU *yaz_srw_get_core_ver(ODR o, const char *version)
 731 {
 732     Z_SRW_PDU *p = (Z_SRW_PDU *) odr_malloc(o, sizeof(*p));
 733     p->srw_version = odr_strdup(o, version);
 734     p->username = 0;
 735     p->password = 0;
 736     p->extra_args = 0;
 737     p->extraResponseData_buf = 0;
 738     p->extraResponseData_len = 0;
 739     return p;
 740 }
 741
 742 Z_SRW_PDU *yaz_srw_get_core_v_2_0(ODR o)
 743 {
 744     return yaz_srw_get_core_ver(o, "2.0");
 745 }
 746
 747 Z_SRW_PDU *yaz_srw_get(ODR o, int which)
 748 {
 749     return yaz_srw_get_pdu(o, which, "2.0");
 750 }
 751
 752 Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version)
 753 {
 754     Z_SRW_PDU *sr = yaz_srw_get_core_ver(o, version);
 755
 756     sr->which = which;
 757     switch(which)
 758     {
 759     case Z_SRW_searchRetrieve_request:
 760         sr->u.request = (Z_SRW_searchRetrieveRequest *)
 761             odr_malloc(o, sizeof(*sr->u.request));
 762         sr->u.request->queryType = "cql";
 763         sr->u.request->query = 0;
 764         sr->u.request->sort_type = Z_SRW_sort_type_none;
 765         sr->u.request->sort.none = 0;
 766         sr->u.request->startRecord = 0;
 767         sr->u.request->maximumRecords = 0;
 768         sr->u.request->recordSchema = 0;
 769         sr->u.request->recordPacking = 0;
 770         sr->u.request->packing = 0;
 771         sr->u.request->recordXPath = 0;
 772         sr->u.request->database = 0;
 773         sr->u.request->resultSetTTL = 0;
 774         sr->u.request->stylesheet = 0;
 775         sr->u.request->facetList = 0;
 776         break;
 777     case Z_SRW_searchRetrieve_response:
 778         sr->u.response = (Z_SRW_searchRetrieveResponse *)
 779             odr_malloc(o, sizeof(*sr->u.response));
 780         sr->u.response->numberOfRecords = 0;
 781         sr->u.response->resultCountPrecision = 0;
 782         sr->u.response->resultSetId = 0;
 783         sr->u.response->resultSetIdleTime = 0;
 784         sr->u.response->records = 0;
 785         sr->u.response->num_records = 0;
 786         sr->u.response->diagnostics = 0;
 787         sr->u.response->num_diagnostics = 0;
 788         sr->u.response->nextRecordPosition = 0;
 789         sr->u.response->extra_records = 0;
 790         sr->u.response->facetList = 0;
 791         sr->u.response->suggestions = 0;
 792         break;
 793     case Z_SRW_explain_request:
 794         sr->u.explain_request = (Z_SRW_explainRequest *)
 795             odr_malloc(o, sizeof(*sr->u.explain_request));
 796         sr->u.explain_request->recordPacking = 0;
 797         sr->u.explain_request->packing = 0;
 798         sr->u.explain_request->database = 0;
 799         sr->u.explain_request->stylesheet = 0;
 800         break;
 801     case Z_SRW_explain_response:
 802         sr->u.explain_response = (Z_SRW_explainResponse *)
 803             odr_malloc(o, sizeof(*sr->u.explain_response));
 804         sr->u.explain_response->record.recordData_buf = 0;
 805         sr->u.explain_response->record.recordData_len = 0;
 806         sr->u.explain_response->record.recordSchema = 0;
 807         sr->u.explain_response->record.recordPosition = 0;
 808         sr->u.explain_response->record.recordPacking =
 809             Z_SRW_recordPacking_string;
 810         sr->u.explain_response->diagnostics = 0;
 811         sr->u.explain_response->num_diagnostics = 0;
 812         sr->u.explain_response->extra_record = 0;
 813         break;
 814     case Z_SRW_scan_request:
 815         sr->u.scan_request = (Z_SRW_scanRequest *)
 816             odr_malloc(o, sizeof(*sr->u.scan_request));
 817         sr->u.scan_request->database = 0;
 818         sr->u.scan_request->stylesheet = 0;
 819         sr->u.scan_request->maximumTerms = 0;
 820         sr->u.scan_request->responsePosition = 0;
 821         sr->u.scan_request->queryType = "cql";
 822         sr->u.scan_request->scanClause = 0;
 823         break;
 824     case Z_SRW_scan_response:
 825         sr->u.scan_response = (Z_SRW_scanResponse *)
 826             odr_malloc(o, sizeof(*sr->u.scan_response));
 827         sr->u.scan_response->terms = 0;
 828         sr->u.scan_response->num_terms = 0;
 829         sr->u.scan_response->diagnostics = 0;
 830         sr->u.scan_response->num_diagnostics = 0;
 831         break;
 832     case Z_SRW_update_request:
 833         sr->u.update_request = (Z_SRW_updateRequest *)
 834             odr_malloc(o, sizeof(*sr->u.update_request));
 835         sr->u.update_request->database = 0;
 836         sr->u.update_request->stylesheet = 0;
 837         sr->u.update_request->record = 0;
 838         sr->u.update_request->recordId = 0;
 839         sr->u.update_request->recordVersions = 0;
 840         sr->u.update_request->num_recordVersions = 0;
 841         sr->u.update_request->extra_record = 0;
 842         sr->u.update_request->extraRequestData_buf = 0;
 843         sr->u.update_request->extraRequestData_len = 0;
 844         sr->u.request->database = 0;
 845         break;
 846     case Z_SRW_update_response:
 847         sr->u.update_response = (Z_SRW_updateResponse *)
 848             odr_malloc(o, sizeof(*sr->u.update_response));
 849         sr->u.update_response->operationStatus = 0;
 850         sr->u.update_response->recordId = 0;
 851         sr->u.update_response->recordVersions = 0;
 852         sr->u.update_response->num_recordVersions = 0;
 853         sr->u.update_response->record = 0;
 854         sr->u.update_response->extra_record = 0;
 855         sr->u.update_response->extraResponseData_buf = 0;
 856         sr->u.update_response->extraResponseData_len = 0;
 857         sr->u.update_response->diagnostics = 0;
 858         sr->u.update_response->num_diagnostics = 0;
 859     }
 860     return sr;
 861 }
 862
 863 void yaz_add_name_value_int(ODR o, char **name, char **value, int *i,
 864                             char *a_name, Odr_int *val)
 865 {
 866     if (val)
 867     {
 868         name[*i] = a_name;
 869         value[*i] = (char *) odr_malloc(o, 40);
 870         sprintf(value[*i], ODR_INT_PRINTF, *val);
 871         (*i)++;
 872     }
 873 }
 874
 875 void yaz_add_name_value_str(ODR o, char **name, char **value,  int *i,
 876                             char *a_name, char *val)
 877 {
 878     if (val)
 879     {
 880         name[*i] = a_name;
 881         value[*i] = val;
 882         (*i)++;
 883     }
 884 }
 885
 886 static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode,
 887                              char **name, char **value, int max_names)
 888 {
 889     int version2 = strcmp(srw_pdu->srw_version, "2.") > 0;
 890     int i = 0;
 891     char *queryType;
 892     yaz_add_name_value_str(encode, name, value, &i, "version",
 893                            srw_pdu->srw_version);
 894     name[i] = "operation";
 895     switch (srw_pdu->which)
 896     {
 897     case Z_SRW_searchRetrieve_request:
 898         value[i++] = "searchRetrieve";
 899         queryType = srw_pdu->u.request->queryType;
 900         if (version2)
 901         {
 902             if (queryType && strcmp(queryType, "cql"))
 903                 yaz_add_name_value_str(encode, name, value, &i, "queryType",
 904                                        queryType);
 905             yaz_add_name_value_str(encode, name, value, &i, "query",
 906                                    srw_pdu->u.request->query);
 907         }
 908         else
 909         {
 910             if (!strcmp(queryType, "cql"))
 911             {
 912                 yaz_add_name_value_str(encode, name, value, &i, "query",
 913                                        srw_pdu->u.request->query);
 914             }
 915             else if (!strcmp(queryType, "pqf"))
 916             {
 917                 yaz_add_name_value_str(encode, name, value, &i, "x-pquery",
 918                                        srw_pdu->u.request->query);
 919             }
 920             else if (!strcmp(queryType, "xcql"))
 921             {
 922                 yaz_add_name_value_str(encode, name, value, &i, "x-cql",
 923                                        srw_pdu->u.request->query);
 924             }
 925         }
 926         switch (srw_pdu->u.request->sort_type)
 927         {
 928         case Z_SRW_sort_type_none:
 929             break;
 930         case Z_SRW_sort_type_sort:
 931             yaz_add_name_value_str(encode, name, value, &i, "sortKeys",
 932                                    srw_pdu->u.request->sort.sortKeys);
 933             break;
 934         }
 935         yaz_add_name_value_int(encode, name, value, &i, "startRecord",
 936                                srw_pdu->u.request->startRecord);
 937         yaz_add_name_value_int(encode, name, value, &i, "maximumRecords",
 938                                srw_pdu->u.request->maximumRecords);
 939         yaz_add_name_value_str(encode, name, value, &i, "recordSchema",
 940                                srw_pdu->u.request->recordSchema);
 941         if (version2)
 942         {
 943             yaz_add_name_value_str(encode, name, value, &i, "recordXMLEscaping",
 944                                    srw_pdu->u.request->recordPacking);
 945             yaz_add_name_value_str(encode, name, value, &i, "recordPacking",
 946                                    srw_pdu->u.request->packing);
 947         }
 948         else
 949             yaz_add_name_value_str(encode, name, value, &i, "recordPacking",
 950                                    srw_pdu->u.request->recordPacking);
 951         yaz_add_name_value_str(encode, name, value, &i, "recordXPath",
 952                                srw_pdu->u.request->recordXPath);
 953         yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
 954                                srw_pdu->u.request->stylesheet);
 955         yaz_add_name_value_int(encode, name, value, &i, "resultSetTTL",
 956                                srw_pdu->u.request->resultSetTTL);
 957         break;
 958     case Z_SRW_explain_request:
 959         value[i++] = "explain";
 960
 961         if (version2)
 962         {
 963             yaz_add_name_value_str(encode, name, value, &i, "recordXMLEscaping",
 964                                    srw_pdu->u.explain_request->recordPacking);
 965             yaz_add_name_value_str(encode, name, value, &i, "recordPacking",
 966                                    srw_pdu->u.explain_request->packing);
 967         }
 968         else
 969             yaz_add_name_value_str(encode, name, value, &i, "recordPacking",
 970                                    srw_pdu->u.explain_request->recordPacking);
 971         yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
 972                                srw_pdu->u.explain_request->stylesheet);
 973         break;
 974     case Z_SRW_scan_request:
 975         value[i++] = "scan";
 976         queryType = srw_pdu->u.scan_request->queryType;
 977         if (version2)
 978         {
 979             if (queryType && strcmp(queryType, "cql"))
 980                 yaz_add_name_value_str(encode, name, value, &i, "queryType",
 981                                        queryType);
 982             yaz_add_name_value_str(encode, name, value, &i, "scanClause",
 983                                    srw_pdu->u.scan_request->scanClause);
 984         }
 985         else
 986         {
 987             if (!queryType || !strcmp(queryType, "cql"))
 988                 yaz_add_name_value_str(encode, name, value, &i, "scanClause",
 989                                        srw_pdu->u.scan_request->scanClause);
 990             else if (!strcmp(queryType, "pqf"))
 991                 yaz_add_name_value_str(encode, name, value, &i, "x-pScanClause",
 992                                        srw_pdu->u.scan_request->scanClause);
 993             else if (!strcmp(queryType, "xcql"))
 994                 yaz_add_name_value_str(encode, name, value, &i,
 995                                        "x-cqlScanClause",
 996                                        srw_pdu->u.scan_request->scanClause);
 997         }
 998         yaz_add_name_value_int(encode, name, value, &i, "responsePosition",
 999                                srw_pdu->u.scan_request->responsePosition);
1000         yaz_add_name_value_int(encode, name, value, &i, "maximumTerms",
1001                                srw_pdu->u.scan_request->maximumTerms);
1002         yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
1003                                srw_pdu->u.scan_request->stylesheet);
1004         break;
1005     case Z_SRW_update_request:
1006         value[i++] = "update";
1007         break;
1008     default:
1009         return -1;
1010     }
1011     if (srw_pdu->extra_args)
1012     {
1013         Z_SRW_extra_arg *ea = srw_pdu->extra_args;
1014         for (; ea && i < max_names-1; ea = ea->next)
1015         {
1016             name[i] = ea->name;
1017             value[i] = ea->value;
1018             i++;
1019         }
1020     }
1021     name[i++] = 0;
1022
1023     return 0;
1024 }
1025
1026 int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
1027                        ODR encode, const char *charset)
1028 {
1029     char *name[MAX_SRU_PARAMETERS], *value[MAX_SRU_PARAMETERS]; /* definite upper limit for SRU params */
1030     char *uri_args;
1031     char *path;
1032
1033     z_HTTP_header_add_basic_auth(encode, &hreq->headers,
1034                                  srw_pdu->username, srw_pdu->password);
1035     if (yaz_get_sru_parms(srw_pdu, encode, name, value, MAX_SRU_PARAMETERS))
1036         return -1;
1037     yaz_array_to_uri(&uri_args, encode, name, value);
1038
1039     hreq->method = "GET";
1040
1041     path = (char *)
1042         odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 4);
1043
1044     sprintf(path, "%s?%s", hreq->path, uri_args);
1045     yaz_log(YLOG_DEBUG, "SRU HTTP Get Request %s", path);
1046     hreq->path = path;
1047
1048     z_HTTP_header_add_content_type(encode, &hreq->headers,
1049                                    "text/xml", charset);
1050     return 0;
1051 }
1052
1053 int yaz_sru_post_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
1054                         ODR encode, const char *charset)
1055 {
1056     char *name[MAX_SRU_PARAMETERS], *value[MAX_SRU_PARAMETERS]; /* definite upper limit for SRU params */
1057     char *uri_args;
1058
1059     z_HTTP_header_add_basic_auth(encode, &hreq->headers,
1060                                  srw_pdu->username, srw_pdu->password);
1061     if (yaz_get_sru_parms(srw_pdu, encode, name, value, MAX_SRU_PARAMETERS))
1062         return -1;
1063
1064     yaz_array_to_uri(&uri_args, encode, name, value);
1065
1066     hreq->method = "POST";
1067
1068     hreq->content_buf = uri_args;
1069     hreq->content_len = strlen(uri_args);
1070
1071     z_HTTP_header_add_content_type(encode, &hreq->headers,
1072                                    "application/x-www-form-urlencoded",
1073                                    charset);
1074     return 0;
1075 }
1076
1077 int yaz_sru_soap_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
1078                         ODR odr, const char *charset)
1079 {
1080     Z_SOAP_Handler handlers[3] = {
1081 #if YAZ_HAVE_XML2
1082         {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1083         {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1084 #endif
1085         {0, 0, 0}
1086     };
1087     Z_SOAP *p = (Z_SOAP*) odr_malloc(odr, sizeof(*p));
1088
1089     z_HTTP_header_add_basic_auth(odr, &hreq->headers,
1090                                  srw_pdu->username, srw_pdu->password);
1091     z_HTTP_header_add_content_type(odr,
1092                                    &hreq->headers,
1093                                    "text/xml", charset);
1094
1095     z_HTTP_header_add(odr, &hreq->headers,
1096                       "SOAPAction", "\"\"");
1097     p->which = Z_SOAP_generic;
1098     p->u.generic = (Z_SOAP_Generic *) odr_malloc(odr, sizeof(*p->u.generic));
1099     p->u.generic->no = 0;
1100     p->u.generic->ns = 0;
1101     p->u.generic->p = srw_pdu;
1102     p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1103
1104 #if YAZ_HAVE_XML2
1105     if (srw_pdu->which == Z_SRW_update_request ||
1106         srw_pdu->which == Z_SRW_update_response)
1107         p->u.generic->no = 1; /* second handler */
1108 #endif
1109     return z_soap_codec_enc(odr, &p,
1110                             &hreq->content_buf,
1111                             &hreq->content_len, handlers,
1112                             charset);
1113 }
1114
1115 Z_SRW_recordVersion *yaz_srw_get_record_versions(ODR odr, int num)
1116 {
1117     Z_SRW_recordVersion *ver
1118         = (Z_SRW_recordVersion *) odr_malloc(odr,num * sizeof(*ver));
1119     int i;
1120     for (i = 0; i < num; ++i)
1121     {
1122         ver[i].versionType = 0;
1123         ver[i].versionValue = 0;
1124     }
1125     return ver;
1126 }
1127
1128 const char *yaz_srw_pack_to_str(int pack)
1129 {
1130     switch(pack)
1131     {
1132     case Z_SRW_recordPacking_string:
1133         return "string";
1134     case Z_SRW_recordPacking_XML:
1135         return "xml";
1136     case Z_SRW_recordPacking_URL:
1137         return "url";
1138     }
1139     return 0;
1140 }
1141
1142 int yaz_srw_str_to_pack(const char *str)
1143 {
1144     if (!yaz_matchstr(str, "string"))
1145         return Z_SRW_recordPacking_string;
1146     if (!yaz_matchstr(str, "xml"))
1147         return Z_SRW_recordPacking_XML;
1148     if (!yaz_matchstr(str, "url"))
1149         return Z_SRW_recordPacking_URL;
1150     return -1;
1151 }
1152
1153 void yaz_encode_sru_extra(Z_SRW_PDU *sr, ODR odr, const char *extra_args)
1154 {
1155     if (extra_args)
1156     {
1157         char **name;
1158         char **val;
1159         Z_SRW_extra_arg **ea = &sr->extra_args;
1160         yaz_uri_to_array(extra_args, odr, &name, &val);
1161
1162         while (*name)
1163         {
1164             *ea = (Z_SRW_extra_arg *) odr_malloc(odr, sizeof(**ea));
1165             (*ea)->name = *name;
1166             (*ea)->value = *val;
1167             ea = &(*ea)->next;
1168             val++;
1169             name++;
1170         }
1171         *ea = 0;
1172     }
1173 }
1174
1175
1176 /*
1177  * Local variables:
1178  * c-basic-offset: 4
1179  * c-file-style: "Stroustrup"
1180  * indent-tabs-mode: nil
1181  * End:
1182  * vim: shiftwidth=4 tabstop=8 expandtab
1183  */
1184