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 && query)
 492             operation = "searchRetrieve";
 493         version = yaz_negotiate_sru_version(version);
 494
 495         if (!version)
 496         {   /* negotiation failed. */
 497             yaz_add_srw_diagnostic(decode, diag, num_diag,
 498                                    YAZ_SRW_UNSUPP_VERSION, "2.0");
 499             version = "2.0";
 500         }
 501         if (!operation)
 502         {
 503             if (uri_name)
 504                 yaz_add_srw_diagnostic(
 505                     decode, diag, num_diag,
 506                     YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "operation");
 507             operation = "explain";
 508         }
 509         if (strcmp(version, "2.0"))
 510         {
 511             if (recordXMLEscaping)
 512             {
 513                 yaz_add_srw_diagnostic(decode, diag, num_diag,
 514                                        YAZ_SRW_UNSUPP_PARAMETER,
 515                                        "recordXMLEscaping");
 516
 517             }
 518             recordXMLEscaping = recordPacking;
 519             recordPacking = "packed";
 520         }
 521         if (!recordXMLEscaping)
 522             recordXMLEscaping = "xml";
 523         if (!strcmp(operation, "searchRetrieve"))
 524         {
 525             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_searchRetrieve_request);
 526
 527             sr->srw_version = version;
 528             sr->extra_args = extra_args;
 529             *srw_pdu = sr;
 530             yaz_srw_decodeauth(sr, hreq, username, password, decode);
 531
 532             sr->u.request->queryType = queryType;
 533             sr->u.request->query = query;
 534
 535             if (!query)
 536                 yaz_add_srw_diagnostic(
 537                     decode, diag, num_diag,
 538                     YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "query");
 539
 540             if (sortKeys)
 541             {
 542                 sr->u.request->sort_type = Z_SRW_sort_type_sort;
 543                 sr->u.request->sort.sortKeys = sortKeys;
 544             }
 545             sr->u.request->recordXPath = recordXPath;
 546             sr->u.request->recordSchema = recordSchema;
 547             sr->u.request->recordPacking = recordXMLEscaping;
 548             sr->u.request->packing = recordPacking;
 549             sr->u.request->stylesheet = stylesheet;
 550
 551             yaz_sru_decode_integer(decode, "maximumRecords", maximumRecords,
 552                                    &sr->u.request->maximumRecords,
 553                                    diag, num_diag, 0);
 554
 555             yaz_sru_decode_integer(decode, "startRecord", startRecord,
 556                                    &sr->u.request->startRecord,
 557                                    diag, num_diag, 1);
 558
 559             sr->u.request->database = db;
 560
 561             (*soap_package) = (Z_SOAP *)
 562                 odr_malloc(decode, sizeof(**soap_package));
 563             (*soap_package)->which = Z_SOAP_generic;
 564
 565             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 566                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 567
 568             (*soap_package)->u.generic->p = sr;
 569             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 570             (*soap_package)->u.generic->no = 0;
 571
 572             (*soap_package)->ns = "SRU";
 573
 574             return 0;
 575         }
 576         else if (!strcmp(operation, "explain"))
 577         {
 578             /* Transfer SRU explain parameters to common struct */
 579             /* http://www.loc.gov/z3950/agency/zing/srw/explain.html */
 580             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request);
 581
 582             sr->srw_version = version;
 583             sr->extra_args = extra_args;
 584             yaz_srw_decodeauth(sr, hreq, username, password, decode);
 585             *srw_pdu = sr;
 586             sr->u.explain_request->recordPacking = recordXMLEscaping;
 587             sr->u.explain_request->packing = recordPacking;
 588             sr->u.explain_request->database = db;
 589
 590             sr->u.explain_request->stylesheet = stylesheet;
 591
 592             (*soap_package) = (Z_SOAP *)
 593                 odr_malloc(decode, sizeof(**soap_package));
 594             (*soap_package)->which = Z_SOAP_generic;
 595
 596             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 597                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 598
 599             (*soap_package)->u.generic->p = sr;
 600             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 601             (*soap_package)->u.generic->no = 0;
 602
 603             (*soap_package)->ns = "SRU";
 604
 605             return 0;
 606         }
 607         else if (!strcmp(operation, "scan"))
 608         {
 609             /* Transfer SRU scan parameters to common struct */
 610             /* http://www.loc.gov/z3950/agency/zing/srw/scan.html */
 611             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_scan_request);
 612
 613             sr->srw_version = version;
 614             sr->extra_args = extra_args;
 615             *srw_pdu = sr;
 616             yaz_srw_decodeauth(sr, hreq, username, password, decode);
 617
 618             sr->u.scan_request->queryType = queryType;
 619             sr->u.scan_request->scanClause = scanClause;
 620
 621             if (!scanClause)
 622                 yaz_add_srw_diagnostic(
 623                     decode, diag, num_diag,
 624                     YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "scanClause");
 625             sr->u.scan_request->database = db;
 626
 627             yaz_sru_decode_integer(decode, "maximumTerms",
 628                                    maximumTerms,
 629                                    &sr->u.scan_request->maximumTerms,
 630                                    diag, num_diag, 0);
 631
 632             yaz_sru_decode_integer(decode, "responsePosition",
 633                                    responsePosition,
 634                                    &sr->u.scan_request->responsePosition,
 635                                    diag, num_diag, 0);
 636
 637             sr->u.scan_request->stylesheet = stylesheet;
 638
 639             (*soap_package) = (Z_SOAP *)
 640                 odr_malloc(decode, sizeof(**soap_package));
 641             (*soap_package)->which = Z_SOAP_generic;
 642
 643             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 644                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 645
 646             (*soap_package)->u.generic->p = sr;
 647             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 648             (*soap_package)->u.generic->no = 0;
 649
 650             (*soap_package)->ns = "SRU";
 651
 652             return 0;
 653         }
 654         else
 655         {
 656             /* unsupported operation ... */
 657             /* Act as if we received a explain request and throw diagnostic. */
 658
 659             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request);
 660
 661             sr->srw_version = version;
 662             *srw_pdu = sr;
 663             sr->u.explain_request->recordPacking = recordPacking;
 664             sr->u.explain_request->database = db;
 665
 666             sr->u.explain_request->stylesheet = stylesheet;
 667
 668             (*soap_package) = (Z_SOAP *)
 669                 odr_malloc(decode, sizeof(**soap_package));
 670             (*soap_package)->which = Z_SOAP_generic;
 671
 672             (*soap_package)->u.generic = (Z_SOAP_Generic *)
 673                 odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
 674
 675             (*soap_package)->u.generic->p = sr;
 676             (*soap_package)->u.generic->ns = soap_handlers[0].ns;
 677             (*soap_package)->u.generic->no = 0;
 678
 679             (*soap_package)->ns = "SRU";
 680
 681             yaz_add_srw_diagnostic(decode, diag, num_diag,
 682                                    YAZ_SRW_UNSUPP_OPERATION, operation);
 683             return 0;
 684         }
 685 #else
 686         return 1;
 687 #endif
 688     }
 689     return 2;
 690 }
 691
 692 Z_SRW_extra_record *yaz_srw_get_extra_record(ODR o)
 693 {
 694     Z_SRW_extra_record *res = (Z_SRW_extra_record *)
 695         odr_malloc(o, sizeof(*res));
 696
 697     res->extraRecordData_buf = 0;
 698     res->extraRecordData_len = 0;
 699     res->recordIdentifier = 0;
 700     return res;
 701 }
 702
 703
 704 Z_SRW_record *yaz_srw_get_records(ODR o, int n)
 705 {
 706     Z_SRW_record *res = (Z_SRW_record *) odr_malloc(o, n * sizeof(*res));
 707     int i;
 708
 709     for (i = 0; i<n; i++)
 710     {
 711         res[i].recordSchema = 0;
 712         res[i].recordPacking = Z_SRW_recordPacking_string;
 713         res[i].recordData_buf = 0;
 714         res[i].recordData_len = 0;
 715         res[i].recordPosition = 0;
 716     }
 717     return res;
 718 }
 719
 720 Z_SRW_record *yaz_srw_get_record(ODR o)
 721 {
 722     return yaz_srw_get_records(o, 1);
 723 }
 724
 725 static Z_SRW_PDU *yaz_srw_get_core_ver(ODR o, const char *version)
 726 {
 727     Z_SRW_PDU *p = (Z_SRW_PDU *) odr_malloc(o, sizeof(*p));
 728     p->srw_version = odr_strdup(o, version);
 729     p->username = 0;
 730     p->password = 0;
 731     p->extra_args = 0;
 732     p->extraResponseData_buf = 0;
 733     p->extraResponseData_len = 0;
 734     return p;
 735 }
 736
 737 Z_SRW_PDU *yaz_srw_get_core_v_2_0(ODR o)
 738 {
 739     return yaz_srw_get_core_ver(o, "2.0");
 740 }
 741
 742 Z_SRW_PDU *yaz_srw_get(ODR o, int which)
 743 {
 744     return yaz_srw_get_pdu(o, which, "2.0");
 745 }
 746
 747 Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version)
 748 {
 749     Z_SRW_PDU *sr = yaz_srw_get_core_ver(o, version);
 750
 751     sr->which = which;
 752     switch(which)
 753     {
 754     case Z_SRW_searchRetrieve_request:
 755         sr->u.request = (Z_SRW_searchRetrieveRequest *)
 756             odr_malloc(o, sizeof(*sr->u.request));
 757         sr->u.request->queryType = "cql";
 758         sr->u.request->query = 0;
 759         sr->u.request->sort_type = Z_SRW_sort_type_none;
 760         sr->u.request->sort.none = 0;
 761         sr->u.request->startRecord = 0;
 762         sr->u.request->maximumRecords = 0;
 763         sr->u.request->recordSchema = 0;
 764         sr->u.request->recordPacking = 0;
 765         sr->u.request->packing = 0;
 766         sr->u.request->recordXPath = 0;
 767         sr->u.request->database = 0;
 768         sr->u.request->resultSetTTL = 0;
 769         sr->u.request->stylesheet = 0;
 770         sr->u.request->facetList = 0;
 771         break;
 772     case Z_SRW_searchRetrieve_response:
 773         sr->u.response = (Z_SRW_searchRetrieveResponse *)
 774             odr_malloc(o, sizeof(*sr->u.response));
 775         sr->u.response->numberOfRecords = 0;
 776         sr->u.response->resultSetId = 0;
 777         sr->u.response->resultSetIdleTime = 0;
 778         sr->u.response->records = 0;
 779         sr->u.response->num_records = 0;
 780         sr->u.response->diagnostics = 0;
 781         sr->u.response->num_diagnostics = 0;
 782         sr->u.response->nextRecordPosition = 0;
 783         sr->u.response->extra_records = 0;
 784         sr->u.response->facetList = 0;
 785         sr->u.response->suggestions = 0;
 786         break;
 787     case Z_SRW_explain_request:
 788         sr->u.explain_request = (Z_SRW_explainRequest *)
 789             odr_malloc(o, sizeof(*sr->u.explain_request));
 790         sr->u.explain_request->recordPacking = 0;
 791         sr->u.explain_request->packing = 0;
 792         sr->u.explain_request->database = 0;
 793         sr->u.explain_request->stylesheet = 0;
 794         break;
 795     case Z_SRW_explain_response:
 796         sr->u.explain_response = (Z_SRW_explainResponse *)
 797             odr_malloc(o, sizeof(*sr->u.explain_response));
 798         sr->u.explain_response->record.recordData_buf = 0;
 799         sr->u.explain_response->record.recordData_len = 0;
 800         sr->u.explain_response->record.recordSchema = 0;
 801         sr->u.explain_response->record.recordPosition = 0;
 802         sr->u.explain_response->record.recordPacking =
 803             Z_SRW_recordPacking_string;
 804         sr->u.explain_response->diagnostics = 0;
 805         sr->u.explain_response->num_diagnostics = 0;
 806         sr->u.explain_response->extra_record = 0;
 807         break;
 808     case Z_SRW_scan_request:
 809         sr->u.scan_request = (Z_SRW_scanRequest *)
 810             odr_malloc(o, sizeof(*sr->u.scan_request));
 811         sr->u.scan_request->database = 0;
 812         sr->u.scan_request->stylesheet = 0;
 813         sr->u.scan_request->maximumTerms = 0;
 814         sr->u.scan_request->responsePosition = 0;
 815         sr->u.scan_request->queryType = "cql";
 816         sr->u.scan_request->scanClause = 0;
 817         break;
 818     case Z_SRW_scan_response:
 819         sr->u.scan_response = (Z_SRW_scanResponse *)
 820             odr_malloc(o, sizeof(*sr->u.scan_response));
 821         sr->u.scan_response->terms = 0;
 822         sr->u.scan_response->num_terms = 0;
 823         sr->u.scan_response->diagnostics = 0;
 824         sr->u.scan_response->num_diagnostics = 0;
 825         break;
 826     case Z_SRW_update_request:
 827         sr->u.update_request = (Z_SRW_updateRequest *)
 828             odr_malloc(o, sizeof(*sr->u.update_request));
 829         sr->u.update_request->database = 0;
 830         sr->u.update_request->stylesheet = 0;
 831         sr->u.update_request->record = 0;
 832         sr->u.update_request->recordId = 0;
 833         sr->u.update_request->recordVersions = 0;
 834         sr->u.update_request->num_recordVersions = 0;
 835         sr->u.update_request->extra_record = 0;
 836         sr->u.update_request->extraRequestData_buf = 0;
 837         sr->u.update_request->extraRequestData_len = 0;
 838         sr->u.request->database = 0;
 839         break;
 840     case Z_SRW_update_response:
 841         sr->u.update_response = (Z_SRW_updateResponse *)
 842             odr_malloc(o, sizeof(*sr->u.update_response));
 843         sr->u.update_response->operationStatus = 0;
 844         sr->u.update_response->recordId = 0;
 845         sr->u.update_response->recordVersions = 0;
 846         sr->u.update_response->num_recordVersions = 0;
 847         sr->u.update_response->record = 0;
 848         sr->u.update_response->extra_record = 0;
 849         sr->u.update_response->extraResponseData_buf = 0;
 850         sr->u.update_response->extraResponseData_len = 0;
 851         sr->u.update_response->diagnostics = 0;
 852         sr->u.update_response->num_diagnostics = 0;
 853     }
 854     return sr;
 855 }
 856
 857 void yaz_add_name_value_int(ODR o, char **name, char **value, int *i,
 858                             char *a_name, Odr_int *val)
 859 {
 860     if (val)
 861     {
 862         name[*i] = a_name;
 863         value[*i] = (char *) odr_malloc(o, 40);
 864         sprintf(value[*i], ODR_INT_PRINTF, *val);
 865         (*i)++;
 866     }
 867 }
 868
 869 void yaz_add_name_value_str(ODR o, char **name, char **value,  int *i,
 870                             char *a_name, char *val)
 871 {
 872     if (val)
 873     {
 874         name[*i] = a_name;
 875         value[*i] = val;
 876         (*i)++;
 877     }
 878 }
 879
 880 static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode,
 881                              char **name, char **value, int max_names)
 882 {
 883     int version2 = strcmp(srw_pdu->srw_version, "2.") > 0;
 884     int i = 0;
 885     char *queryType;
 886     if (!version2)
 887         yaz_add_name_value_str(encode, name, value, &i, "version", srw_pdu->srw_version);
 888     name[i] = "operation";
 889     switch (srw_pdu->which)
 890     {
 891     case Z_SRW_searchRetrieve_request:
 892         if (!version2)
 893             value[i++] = "searchRetrieve";
 894         queryType = srw_pdu->u.request->queryType;
 895         if (version2)
 896         {
 897             yaz_add_name_value_str(encode, name, value, &i, "queryType",
 898                                    queryType);
 899             yaz_add_name_value_str(encode, name, value, &i, "query",
 900                                    srw_pdu->u.request->query);
 901         }
 902         else
 903         {
 904             if (!strcmp(queryType, "cql"))
 905             {
 906                 yaz_add_name_value_str(encode, name, value, &i, "query",
 907                                        srw_pdu->u.request->query);
 908             }
 909             else if (!strcmp(queryType, "pqf"))
 910             {
 911                 yaz_add_name_value_str(encode, name, value, &i, "x-pquery",
 912                                        srw_pdu->u.request->query);
 913             }
 914             else if (!strcmp(queryType, "xcql"))
 915             {
 916                 yaz_add_name_value_str(encode, name, value, &i, "x-cql",
 917                                        srw_pdu->u.request->query);
 918             }
 919         }
 920         switch (srw_pdu->u.request->sort_type)
 921         {
 922         case Z_SRW_sort_type_none:
 923             break;
 924         case Z_SRW_sort_type_sort:
 925             yaz_add_name_value_str(encode, name, value, &i, "sortKeys",
 926                                    srw_pdu->u.request->sort.sortKeys);
 927             break;
 928         }
 929         yaz_add_name_value_int(encode, name, value, &i, "startRecord",
 930                                srw_pdu->u.request->startRecord);
 931         yaz_add_name_value_int(encode, name, value, &i, "maximumRecords",
 932                                srw_pdu->u.request->maximumRecords);
 933         yaz_add_name_value_str(encode, name, value, &i, "recordSchema",
 934                                srw_pdu->u.request->recordSchema);
 935         if (version2)
 936         {
 937             yaz_add_name_value_str(encode, name, value, &i, "recordXMLEscaping",
 938                                    srw_pdu->u.request->recordPacking);
 939             yaz_add_name_value_str(encode, name, value, &i, "recordPacking",
 940                                    srw_pdu->u.request->packing);
 941         }
 942         else
 943             yaz_add_name_value_str(encode, name, value, &i, "recordPacking",
 944                                    srw_pdu->u.request->recordPacking);
 945         yaz_add_name_value_str(encode, name, value, &i, "recordXPath",
 946                                srw_pdu->u.request->recordXPath);
 947         yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
 948                                srw_pdu->u.request->stylesheet);
 949         yaz_add_name_value_int(encode, name, value, &i, "resultSetTTL",
 950                                srw_pdu->u.request->resultSetTTL);
 951         break;
 952     case Z_SRW_explain_request:
 953         value[i++] = "explain";
 954
 955         if (version2)
 956         {
 957             yaz_add_name_value_str(encode, name, value, &i, "recordXMLEscaping",
 958                                    srw_pdu->u.explain_request->recordPacking);
 959             yaz_add_name_value_str(encode, name, value, &i, "recordPacking",
 960                                    srw_pdu->u.explain_request->packing);
 961         }
 962         else
 963             yaz_add_name_value_str(encode, name, value, &i, "recordPacking",
 964                                    srw_pdu->u.explain_request->recordPacking);
 965         yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
 966                                srw_pdu->u.explain_request->stylesheet);
 967         break;
 968     case Z_SRW_scan_request:
 969         value[i++] = "scan";
 970         queryType = srw_pdu->u.scan_request->queryType;
 971         if (version2)
 972         {
 973             if (queryType && strcmp(queryType, "cql"))
 974                 yaz_add_name_value_str(encode, name, value, &i, "queryType",
 975                                        queryType);
 976             yaz_add_name_value_str(encode, name, value, &i, "scanClause",
 977                                    srw_pdu->u.scan_request->scanClause);
 978         }
 979         else
 980         {
 981             if (!queryType || !strcmp(queryType, "cql"))
 982                 yaz_add_name_value_str(encode, name, value, &i, "scanClause",
 983                                        srw_pdu->u.scan_request->scanClause);
 984             else if (!strcmp(queryType, "pqf"))
 985                 yaz_add_name_value_str(encode, name, value, &i, "x-pScanClause",
 986                                        srw_pdu->u.scan_request->scanClause);
 987             else if (!strcmp(queryType, "xcql"))
 988                 yaz_add_name_value_str(encode, name, value, &i,
 989                                        "x-cqlScanClause",
 990                                        srw_pdu->u.scan_request->scanClause);
 991         }
 992         yaz_add_name_value_int(encode, name, value, &i, "responsePosition",
 993                                srw_pdu->u.scan_request->responsePosition);
 994         yaz_add_name_value_int(encode, name, value, &i, "maximumTerms",
 995                                srw_pdu->u.scan_request->maximumTerms);
 996         yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
 997                                srw_pdu->u.scan_request->stylesheet);
 998         break;
 999     case Z_SRW_update_request:
1000         value[i++] = "update";
1001         break;
1002     default:
1003         return -1;
1004     }
1005     if (srw_pdu->extra_args)
1006     {
1007         Z_SRW_extra_arg *ea = srw_pdu->extra_args;
1008         for (; ea && i < max_names-1; ea = ea->next)
1009         {
1010             name[i] = ea->name;
1011             value[i] = ea->value;
1012             i++;
1013         }
1014     }
1015     name[i++] = 0;
1016
1017     return 0;
1018 }
1019
1020 int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
1021                        ODR encode, const char *charset)
1022 {
1023     char *name[MAX_SRU_PARAMETERS], *value[MAX_SRU_PARAMETERS]; /* definite upper limit for SRU params */
1024     char *uri_args;
1025     char *path;
1026
1027     z_HTTP_header_add_basic_auth(encode, &hreq->headers,
1028                                  srw_pdu->username, srw_pdu->password);
1029     if (yaz_get_sru_parms(srw_pdu, encode, name, value, MAX_SRU_PARAMETERS))
1030         return -1;
1031     yaz_array_to_uri(&uri_args, encode, name, value);
1032
1033     hreq->method = "GET";
1034
1035     path = (char *)
1036         odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 4);
1037
1038     sprintf(path, "%s?%s", hreq->path, uri_args);
1039     yaz_log(YLOG_DEBUG, "SRU HTTP Get Request %s", path);
1040     hreq->path = path;
1041
1042     z_HTTP_header_add_content_type(encode, &hreq->headers,
1043                                    "text/xml", charset);
1044     return 0;
1045 }
1046
1047 int yaz_sru_post_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
1048                         ODR encode, const char *charset)
1049 {
1050     char *name[MAX_SRU_PARAMETERS], *value[MAX_SRU_PARAMETERS]; /* definite upper limit for SRU params */
1051     char *uri_args;
1052
1053     z_HTTP_header_add_basic_auth(encode, &hreq->headers,
1054                                  srw_pdu->username, srw_pdu->password);
1055     if (yaz_get_sru_parms(srw_pdu, encode, name, value, MAX_SRU_PARAMETERS))
1056         return -1;
1057
1058     yaz_array_to_uri(&uri_args, encode, name, value);
1059
1060     hreq->method = "POST";
1061
1062     hreq->content_buf = uri_args;
1063     hreq->content_len = strlen(uri_args);
1064
1065     z_HTTP_header_add_content_type(encode, &hreq->headers,
1066                                    "application/x-www-form-urlencoded",
1067                                    charset);
1068     return 0;
1069 }
1070
1071 int yaz_sru_soap_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
1072                         ODR odr, const char *charset)
1073 {
1074     Z_SOAP_Handler handlers[3] = {
1075 #if YAZ_HAVE_XML2
1076         {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1077         {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1078 #endif
1079         {0, 0, 0}
1080     };
1081     Z_SOAP *p = (Z_SOAP*) odr_malloc(odr, sizeof(*p));
1082
1083     z_HTTP_header_add_basic_auth(odr, &hreq->headers,
1084                                  srw_pdu->username, srw_pdu->password);
1085     z_HTTP_header_add_content_type(odr,
1086                                    &hreq->headers,
1087                                    "text/xml", charset);
1088
1089     z_HTTP_header_add(odr, &hreq->headers,
1090                       "SOAPAction", "\"\"");
1091     p->which = Z_SOAP_generic;
1092     p->u.generic = (Z_SOAP_Generic *) odr_malloc(odr, sizeof(*p->u.generic));
1093     p->u.generic->no = 0;
1094     p->u.generic->ns = 0;
1095     p->u.generic->p = srw_pdu;
1096     p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
1097
1098 #if YAZ_HAVE_XML2
1099     if (srw_pdu->which == Z_SRW_update_request ||
1100         srw_pdu->which == Z_SRW_update_response)
1101         p->u.generic->no = 1; /* second handler */
1102 #endif
1103     return z_soap_codec_enc(odr, &p,
1104                             &hreq->content_buf,
1105                             &hreq->content_len, handlers,
1106                             charset);
1107 }
1108
1109 Z_SRW_recordVersion *yaz_srw_get_record_versions(ODR odr, int num)
1110 {
1111     Z_SRW_recordVersion *ver
1112         = (Z_SRW_recordVersion *) odr_malloc(odr,num * sizeof(*ver));
1113     int i;
1114     for (i = 0; i < num; ++i)
1115     {
1116         ver[i].versionType = 0;
1117         ver[i].versionValue = 0;
1118     }
1119     return ver;
1120 }
1121
1122 const char *yaz_srw_pack_to_str(int pack)
1123 {
1124     switch(pack)
1125     {
1126     case Z_SRW_recordPacking_string:
1127         return "string";
1128     case Z_SRW_recordPacking_XML:
1129         return "xml";
1130     case Z_SRW_recordPacking_URL:
1131         return "url";
1132     }
1133     return 0;
1134 }
1135
1136 int yaz_srw_str_to_pack(const char *str)
1137 {
1138     if (!yaz_matchstr(str, "string"))
1139         return Z_SRW_recordPacking_string;
1140     if (!yaz_matchstr(str, "xml"))
1141         return Z_SRW_recordPacking_XML;
1142     if (!yaz_matchstr(str, "url"))
1143         return Z_SRW_recordPacking_URL;
1144     return -1;
1145 }
1146
1147 void yaz_encode_sru_extra(Z_SRW_PDU *sr, ODR odr, const char *extra_args)
1148 {
1149     if (extra_args)
1150     {
1151         char **name;
1152         char **val;
1153         Z_SRW_extra_arg **ea = &sr->extra_args;
1154         yaz_uri_to_array(extra_args, odr, &name, &val);
1155
1156         while (*name)
1157         {
1158             *ea = (Z_SRW_extra_arg *) odr_malloc(odr, sizeof(**ea));
1159             (*ea)->name = *name;
1160             (*ea)->value = *val;
1161             ea = &(*ea)->next;
1162             val++;
1163             name++;
1164         }
1165         *ea = 0;
1166     }
1167 }
1168
1169
1170 /*
1171  * Local variables:
1172  * c-basic-offset: 4
1173  * c-file-style: "Stroustrup"
1174  * indent-tabs-mode: nil
1175  * End:
1176  * vim: shiftwidth=4 tabstop=8 expandtab
1177  */
1178