cups/request.c

   1 /*
   2  * IPP utilities for CUPS.
   3  *
   4  * Copyright © 2007-2018 by Apple Inc.
   5  * Copyright © 1997-2007 by Easy Software Products.
   6  *
   7  * Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
   8  */
   9
  10 /*
  11  * Include necessary headers...
  12  */
  13
  14 #include "cups-private.h"
  15 #include <fcntl.h>
  16 #include <sys/stat.h>
  17 #if defined(WIN32) || defined(__EMX__)
  18 #  include <io.h>
  19 #else
  20 #  include <unistd.h>
  21 #endif /* WIN32 || __EMX__ */
  22 #ifndef O_BINARY
  23 #  define O_BINARY 0
  24 #endif /* O_BINARY */
  25 #ifndef MSG_DONTWAIT
  26 #  define MSG_DONTWAIT 0
  27 #endif /* !MSG_DONTWAIT */
  28
  29
  30 /*
  31  * 'cupsDoFileRequest()' - Do an IPP request with a file.
  32  *
  33  * This function sends the IPP request and attached file to the specified
  34  * server, retrying and authenticating as necessary.  The request is freed with
  35  * @link ippDelete@.
  36  */
  37
  38 ipp_t *                                 /* O - Response data */
  39 cupsDoFileRequest(http_t     *http,     /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
  40                   ipp_t      *request,  /* I - IPP request */
  41                   const char *resource, /* I - HTTP resource for POST */
  42                   const char *filename) /* I - File to send or @code NULL@ for none */
  43 {
  44   ipp_t         *response;              /* IPP response data */
  45   int           infile;                 /* Input file */
  46
  47
  48   DEBUG_printf(("cupsDoFileRequest(http=%p, request=%p(%s), resource=\"%s\", filename=\"%s\")", (void *)http, (void *)request, request ? ippOpString(request->request.op.operation_id) : "?", resource, filename));
  49
  50   if (filename)
  51   {
  52     if ((infile = open(filename, O_RDONLY | O_BINARY)) < 0)
  53     {
  54      /*
  55       * Can't get file information!
  56       */
  57
  58       _cupsSetError(errno == ENOENT ? IPP_STATUS_ERROR_NOT_FOUND : IPP_STATUS_ERROR_NOT_AUTHORIZED,
  59                     NULL, 0);
  60
  61       ippDelete(request);
  62
  63       return (NULL);
  64     }
  65   }
  66   else
  67     infile = -1;
  68
  69   response = cupsDoIORequest(http, request, resource, infile, -1);
  70
  71   if (infile >= 0)
  72     close(infile);
  73
  74   return (response);
  75 }
  76
  77
  78 /*
  79  * 'cupsDoIORequest()' - Do an IPP request with file descriptors.
  80  *
  81  * This function sends the IPP request with the optional input file "infile" to
  82  * the specified server, retrying and authenticating as necessary.  The request
  83  * is freed with @link ippDelete@.
  84  *
  85  * If "infile" is a valid file descriptor, @code cupsDoIORequest@ copies
  86  * all of the data from the file after the IPP request message.
  87  *
  88  * If "outfile" is a valid file descriptor, @code cupsDoIORequest@ copies
  89  * all of the data after the IPP response message to the file.
  90  *
  91  * @since CUPS 1.3/macOS 10.5@
  92  */
  93
  94 ipp_t *                                 /* O - Response data */
  95 cupsDoIORequest(http_t     *http,       /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
  96                 ipp_t      *request,    /* I - IPP request */
  97                 const char *resource,   /* I - HTTP resource for POST */
  98                 int        infile,      /* I - File to read from or -1 for none */
  99                 int        outfile)     /* I - File to write to or -1 for none */
 100 {
 101   ipp_t         *response = NULL;       /* IPP response data */
 102   size_t        length = 0;             /* Content-Length value */
 103   http_status_t status;                 /* Status of HTTP request */
 104   struct stat   fileinfo;               /* File information */
 105   ssize_t       bytes;                  /* Number of bytes read/written */
 106   char          buffer[32768];          /* Output buffer */
 107
 108
 109   DEBUG_printf(("cupsDoIORequest(http=%p, request=%p(%s), resource=\"%s\", infile=%d, outfile=%d)", (void *)http, (void *)request, request ? ippOpString(request->request.op.operation_id) : "?", resource, infile, outfile));
 110
 111  /*
 112   * Range check input...
 113   */
 114
 115   if (!request || !resource)
 116   {
 117     ippDelete(request);
 118
 119     _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
 120
 121     return (NULL);
 122   }
 123
 124  /*
 125   * Get the default connection as needed...
 126   */
 127
 128   if (!http && (http = _cupsConnect()) == NULL)
 129   {
 130     ippDelete(request);
 131
 132     return (NULL);
 133   }
 134
 135  /*
 136   * See if we have a file to send...
 137   */
 138
 139   if (infile >= 0)
 140   {
 141     if (fstat(infile, &fileinfo))
 142     {
 143      /*
 144       * Can't get file information!
 145       */
 146
 147       _cupsSetError(errno == EBADF ? IPP_STATUS_ERROR_NOT_FOUND : IPP_STATUS_ERROR_NOT_AUTHORIZED, NULL, 0);
 148       ippDelete(request);
 149
 150       return (NULL);
 151     }
 152
 153 #ifdef WIN32
 154     if (fileinfo.st_mode & _S_IFDIR)
 155 #else
 156     if (S_ISDIR(fileinfo.st_mode))
 157 #endif /* WIN32 */
 158     {
 159      /*
 160       * Can't send a directory...
 161       */
 162
 163       _cupsSetError(IPP_STATUS_ERROR_NOT_POSSIBLE, strerror(EISDIR), 0);
 164       ippDelete(request);
 165
 166       return (NULL);
 167     }
 168
 169 #ifndef WIN32
 170     if (!S_ISREG(fileinfo.st_mode))
 171       length = 0;                       /* Chunk when piping */
 172     else
 173 #endif /* !WIN32 */
 174     length = ippLength(request) + (size_t)fileinfo.st_size;
 175   }
 176   else
 177     length = ippLength(request);
 178
 179   DEBUG_printf(("2cupsDoIORequest: Request length=%ld, total length=%ld", (long)ippLength(request), (long)length));
 180
 181  /*
 182   * Clear any "Local" authentication data since it is probably stale...
 183   */
 184
 185   if (http->authstring && !strncmp(http->authstring, "Local ", 6))
 186     httpSetAuthString(http, NULL, NULL);
 187
 188  /*
 189   * Loop until we can send the request without authorization problems.
 190   */
 191
 192   while (response == NULL)
 193   {
 194     DEBUG_puts("2cupsDoIORequest: setup...");
 195
 196    /*
 197     * Send the request...
 198     */
 199
 200     status = cupsSendRequest(http, request, resource, length);
 201
 202     DEBUG_printf(("2cupsDoIORequest: status=%d", status));
 203
 204     if (status == HTTP_STATUS_CONTINUE && request->state == IPP_STATE_DATA && infile >= 0)
 205     {
 206       DEBUG_puts("2cupsDoIORequest: file write...");
 207
 208      /*
 209       * Send the file with the request...
 210       */
 211
 212 #ifndef WIN32
 213       if (S_ISREG(fileinfo.st_mode))
 214 #endif /* WIN32 */
 215       lseek(infile, 0, SEEK_SET);
 216
 217       while ((bytes = read(infile, buffer, sizeof(buffer))) > 0)
 218       {
 219         if ((status = cupsWriteRequestData(http, buffer, (size_t)bytes))
 220                 != HTTP_STATUS_CONTINUE)
 221           break;
 222       }
 223     }
 224
 225    /*
 226     * Get the server's response...
 227     */
 228
 229     if (status <= HTTP_STATUS_CONTINUE || status == HTTP_STATUS_OK)
 230     {
 231       response = cupsGetResponse(http, resource);
 232       status   = httpGetStatus(http);
 233     }
 234
 235     DEBUG_printf(("2cupsDoIORequest: status=%d", status));
 236
 237     if (status == HTTP_STATUS_ERROR ||
 238         (status >= HTTP_STATUS_BAD_REQUEST && status != HTTP_STATUS_UNAUTHORIZED &&
 239          status != HTTP_STATUS_UPGRADE_REQUIRED))
 240     {
 241       _cupsSetHTTPError(status);
 242       break;
 243     }
 244
 245     if (response && outfile >= 0)
 246     {
 247      /*
 248       * Write trailing data to file...
 249       */
 250
 251       while ((bytes = httpRead2(http, buffer, sizeof(buffer))) > 0)
 252         if (write(outfile, buffer, (size_t)bytes) < bytes)
 253           break;
 254     }
 255
 256     if (http->state != HTTP_STATE_WAITING)
 257     {
 258      /*
 259       * Flush any remaining data...
 260       */
 261
 262       httpFlush(http);
 263     }
 264   }
 265
 266  /*
 267   * Delete the original request and return the response...
 268   */
 269
 270   ippDelete(request);
 271
 272   return (response);
 273 }
 274
 275
 276 /*
 277  * 'cupsDoRequest()' - Do an IPP request.
 278  *
 279  * This function sends the IPP request to the specified server, retrying
 280  * and authenticating as necessary.  The request is freed with @link ippDelete@.
 281  */
 282
 283 ipp_t *                                 /* O - Response data */
 284 cupsDoRequest(http_t     *http,         /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
 285               ipp_t      *request,      /* I - IPP request */
 286               const char *resource)     /* I - HTTP resource for POST */
 287 {
 288   DEBUG_printf(("cupsDoRequest(http=%p, request=%p(%s), resource=\"%s\")", (void *)http, (void *)request, request ? ippOpString(request->request.op.operation_id) : "?", resource));
 289
 290   return (cupsDoIORequest(http, request, resource, -1, -1));
 291 }
 292
 293
 294 /*
 295  * 'cupsGetResponse()' - Get a response to an IPP request.
 296  *
 297  * Use this function to get the response for an IPP request sent using
 298  * @link cupsSendRequest@. For requests that return additional data, use
 299  * @link cupsReadResponseData@ after getting a successful response,
 300  * otherwise call @link httpFlush@ to complete the response processing.
 301  *
 302  * @since CUPS 1.4/macOS 10.6@
 303  */
 304
 305 ipp_t *                                 /* O - Response or @code NULL@ on HTTP error */
 306 cupsGetResponse(http_t     *http,       /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
 307                 const char *resource)   /* I - HTTP resource for POST */
 308 {
 309   http_status_t status;                 /* HTTP status */
 310   ipp_state_t   state;                  /* IPP read state */
 311   ipp_t         *response = NULL;       /* IPP response */
 312
 313
 314   DEBUG_printf(("cupsGetResponse(http=%p, resource=\"%s\")", (void *)http, resource));
 315   DEBUG_printf(("1cupsGetResponse: http->state=%d", http ? http->state : HTTP_STATE_ERROR));
 316
 317  /*
 318   * Connect to the default server as needed...
 319   */
 320
 321   if (!http)
 322   {
 323     _cups_globals_t *cg = _cupsGlobals();
 324                                         /* Pointer to library globals */
 325
 326     if ((http = cg->http) == NULL)
 327     {
 328       _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("No active connection."), 1);
 329       DEBUG_puts("1cupsGetResponse: No active connection - returning NULL.");
 330       return (NULL);
 331     }
 332   }
 333
 334   if (http->state != HTTP_STATE_POST_RECV && http->state != HTTP_STATE_POST_SEND)
 335   {
 336     _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("No request sent."), 1);
 337     DEBUG_puts("1cupsGetResponse: Not in POST state - returning NULL.");
 338     return (NULL);
 339   }
 340
 341  /*
 342   * Check for an unfinished chunked request...
 343   */
 344
 345   if (http->data_encoding == HTTP_ENCODING_CHUNKED)
 346   {
 347    /*
 348     * Send a 0-length chunk to finish off the request...
 349     */
 350
 351     DEBUG_puts("2cupsGetResponse: Finishing chunked POST...");
 352
 353     if (httpWrite2(http, "", 0) < 0)
 354       return (NULL);
 355   }
 356
 357  /*
 358   * Wait for a response from the server...
 359   */
 360
 361   DEBUG_printf(("2cupsGetResponse: Update loop, http->status=%d...",
 362                 http->status));
 363
 364   do
 365   {
 366     status = httpUpdate(http);
 367   }
 368   while (status == HTTP_STATUS_CONTINUE);
 369
 370   DEBUG_printf(("2cupsGetResponse: status=%d", status));
 371
 372   if (status == HTTP_STATUS_OK)
 373   {
 374    /*
 375     * Get the IPP response...
 376     */
 377
 378     response = ippNew();
 379
 380     while ((state = ippRead(http, response)) != IPP_STATE_DATA)
 381       if (state == IPP_STATE_ERROR)
 382         break;
 383
 384     if (state == IPP_STATE_ERROR)
 385     {
 386      /*
 387       * Flush remaining data and delete the response...
 388       */
 389
 390       DEBUG_puts("1cupsGetResponse: IPP read error!");
 391
 392       httpFlush(http);
 393
 394       ippDelete(response);
 395       response = NULL;
 396
 397       http->status = status = HTTP_STATUS_ERROR;
 398       http->error  = EINVAL;
 399     }
 400   }
 401   else if (status != HTTP_STATUS_ERROR)
 402   {
 403    /*
 404     * Flush any error message...
 405     */
 406
 407     httpFlush(http);
 408
 409    /*
 410     * Then handle encryption and authentication...
 411     */
 412
 413     if (status == HTTP_STATUS_UNAUTHORIZED)
 414     {
 415      /*
 416       * See if we can do authentication...
 417       */
 418
 419       DEBUG_puts("2cupsGetResponse: Need authorization...");
 420
 421       if (!cupsDoAuthentication(http, "POST", resource))
 422         httpReconnect2(http, 30000, NULL);
 423       else
 424         http->status = status = HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED;
 425     }
 426
 427 #ifdef HAVE_SSL
 428     else if (status == HTTP_STATUS_UPGRADE_REQUIRED)
 429     {
 430      /*
 431       * Force a reconnect with encryption...
 432       */
 433
 434       DEBUG_puts("2cupsGetResponse: Need encryption...");
 435
 436       if (!httpReconnect2(http, 30000, NULL))
 437         httpEncryption(http, HTTP_ENCRYPTION_REQUIRED);
 438     }
 439 #endif /* HAVE_SSL */
 440   }
 441
 442   if (response)
 443   {
 444     ipp_attribute_t     *attr;          /* status-message attribute */
 445
 446
 447     attr = ippFindAttribute(response, "status-message", IPP_TAG_TEXT);
 448
 449     DEBUG_printf(("1cupsGetResponse: status-code=%s, status-message=\"%s\"",
 450                   ippErrorString(response->request.status.status_code),
 451                   attr ? attr->values[0].string.text : ""));
 452
 453     _cupsSetError(response->request.status.status_code,
 454                   attr ? attr->values[0].string.text :
 455                       ippErrorString(response->request.status.status_code), 0);
 456   }
 457
 458   return (response);
 459 }
 460
 461
 462 /*
 463  * 'cupsLastError()' - Return the last IPP status code received on the current
 464  *                     thread.
 465  */
 466
 467 ipp_status_t                            /* O - IPP status code from last request */
 468 cupsLastError(void)
 469 {
 470   return (_cupsGlobals()->last_error);
 471 }
 472
 473
 474 /*
 475  * 'cupsLastErrorString()' - Return the last IPP status-message received on the
 476  *                           current thread.
 477  *
 478  * @since CUPS 1.2/macOS 10.5@
 479  */
 480
 481 const char *                            /* O - status-message text from last request */
 482 cupsLastErrorString(void)
 483 {
 484   return (_cupsGlobals()->last_status_message);
 485 }
 486
 487
 488 /*
 489  * '_cupsNextDelay()' - Return the next retry delay value.
 490  *
 491  * This function currently returns the Fibonacci sequence 1 1 2 3 5 8.
 492  *
 493  * Pass 0 for the current delay value to initialize the sequence.
 494  */
 495
 496 int                                     /* O  - Next delay value */
 497 _cupsNextDelay(int current,             /* I  - Current delay value or 0 */
 498                int *previous)           /* IO - Previous delay value */
 499 {
 500   int   next;                           /* Next delay value */
 501
 502
 503   if (current > 0)
 504   {
 505     next      = (current + *previous) % 12;
 506     *previous = next < current ? 0 : current;
 507   }
 508   else
 509   {
 510     next      = 1;
 511     *previous = 0;
 512   }
 513
 514   return (next);
 515 }
 516
 517
 518 /*
 519  * 'cupsReadResponseData()' - Read additional data after the IPP response.
 520  *
 521  * This function is used after @link cupsGetResponse@ to read the PPD or document
 522  * files from @code CUPS_GET_PPD@ and @code CUPS_GET_DOCUMENT@ requests,
 523  * respectively.
 524  *
 525  * @since CUPS 1.4/macOS 10.6@
 526  */
 527
 528 ssize_t                                 /* O - Bytes read, 0 on EOF, -1 on error */
 529 cupsReadResponseData(
 530     http_t *http,                       /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
 531     char   *buffer,                     /* I - Buffer to use */
 532     size_t length)                      /* I - Number of bytes to read */
 533 {
 534  /*
 535   * Get the default connection as needed...
 536   */
 537
 538   DEBUG_printf(("cupsReadResponseData(http=%p, buffer=%p, length=" CUPS_LLFMT ")", (void *)http, (void *)buffer, CUPS_LLCAST length));
 539
 540   if (!http)
 541   {
 542     _cups_globals_t *cg = _cupsGlobals();
 543                                         /* Pointer to library globals */
 544
 545     if ((http = cg->http) == NULL)
 546     {
 547       _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("No active connection"), 1);
 548       return (-1);
 549     }
 550   }
 551
 552  /*
 553   * Then read from the HTTP connection...
 554   */
 555
 556   return (httpRead2(http, buffer, length));
 557 }
 558
 559
 560 /*
 561  * 'cupsSendRequest()' - Send an IPP request.
 562  *
 563  * Use @link cupsWriteRequestData@ to write any additional data (document, PPD
 564  * file, etc.) for the request, @link cupsGetResponse@ to get the IPP response,
 565  * and @link cupsReadResponseData@ to read any additional data following the
 566  * response. Only one request can be sent/queued at a time per @code http_t@
 567  * connection.
 568  *
 569  * Returns the initial HTTP status code, which will be @code HTTP_STATUS_CONTINUE@
 570  * on a successful send of the request.
 571  *
 572  * Note: Unlike @link cupsDoFileRequest@, @link cupsDoIORequest@, and
 573  * @link cupsDoRequest@, the request is NOT freed with @link ippDelete@.
 574  *
 575  * @since CUPS 1.4/macOS 10.6@
 576  */
 577
 578 http_status_t                           /* O - Initial HTTP status */
 579 cupsSendRequest(http_t     *http,       /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
 580                 ipp_t      *request,    /* I - IPP request */
 581                 const char *resource,   /* I - Resource path */
 582                 size_t     length)      /* I - Length of data to follow or @code CUPS_LENGTH_VARIABLE@ */
 583 {
 584   http_status_t         status;         /* Status of HTTP request */
 585   int                   got_status;     /* Did we get the status? */
 586   ipp_state_t           state;          /* State of IPP processing */
 587   http_status_t         expect;         /* Expect: header to use */
 588   char                  date[256];      /* Date: header value */
 589   int                   digest;         /* Are we using Digest authentication? */
 590
 591
 592   DEBUG_printf(("cupsSendRequest(http=%p, request=%p(%s), resource=\"%s\", length=" CUPS_LLFMT ")", (void *)http, (void *)request, request ? ippOpString(request->request.op.operation_id) : "?", resource, CUPS_LLCAST length));
 593
 594  /*
 595   * Range check input...
 596   */
 597
 598   if (!request || !resource)
 599   {
 600     _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
 601
 602     return (HTTP_STATUS_ERROR);
 603   }
 604
 605  /*
 606   * Get the default connection as needed...
 607   */
 608
 609   if (!http && (http = _cupsConnect()) == NULL)
 610     return (HTTP_STATUS_SERVICE_UNAVAILABLE);
 611
 612  /*
 613   * If the prior request was not flushed out, do so now...
 614   */
 615
 616   if (http->state == HTTP_STATE_GET_SEND ||
 617       http->state == HTTP_STATE_POST_SEND)
 618   {
 619     DEBUG_puts("2cupsSendRequest: Flush prior response.");
 620     httpFlush(http);
 621   }
 622   else if (http->state != HTTP_STATE_WAITING)
 623   {
 624     DEBUG_printf(("1cupsSendRequest: Unknown HTTP state (%d), "
 625                   "reconnecting.", http->state));
 626     if (httpReconnect2(http, 30000, NULL))
 627       return (HTTP_STATUS_ERROR);
 628   }
 629
 630 #ifdef HAVE_SSL
 631  /*
 632   * See if we have an auth-info attribute and are communicating over
 633   * a non-local link.  If so, encrypt the link so that we can pass
 634   * the authentication information securely...
 635   */
 636
 637   if (ippFindAttribute(request, "auth-info", IPP_TAG_TEXT) &&
 638       !httpAddrLocalhost(http->hostaddr) && !http->tls &&
 639       httpEncryption(http, HTTP_ENCRYPTION_REQUIRED))
 640   {
 641     DEBUG_puts("1cupsSendRequest: Unable to encrypt connection.");
 642     return (HTTP_STATUS_SERVICE_UNAVAILABLE);
 643   }
 644 #endif /* HAVE_SSL */
 645
 646  /*
 647   * Reconnect if the last response had a "Connection: close"...
 648   */
 649
 650   if (!_cups_strcasecmp(httpGetField(http, HTTP_FIELD_CONNECTION), "close"))
 651   {
 652     DEBUG_puts("2cupsSendRequest: Connection: close");
 653     httpClearFields(http);
 654     if (httpReconnect2(http, 30000, NULL))
 655     {
 656       DEBUG_puts("1cupsSendRequest: Unable to reconnect.");
 657       return (HTTP_STATUS_SERVICE_UNAVAILABLE);
 658     }
 659   }
 660
 661  /*
 662   * Loop until we can send the request without authorization problems.
 663   */
 664
 665   expect = HTTP_STATUS_CONTINUE;
 666
 667   for (;;)
 668   {
 669     DEBUG_puts("2cupsSendRequest: Setup...");
 670
 671    /*
 672     * Setup the HTTP variables needed...
 673     */
 674
 675     httpClearFields(http);
 676     httpSetExpect(http, expect);
 677     httpSetField(http, HTTP_FIELD_CONTENT_TYPE, "application/ipp");
 678     httpSetField(http, HTTP_FIELD_DATE, httpGetDateString2(time(NULL), date, (int)sizeof(date)));
 679     httpSetLength(http, length);
 680
 681     digest = http->authstring && !strncmp(http->authstring, "Digest ", 7);
 682
 683     if (digest)
 684     {
 685      /*
 686       * Update the Digest authentication string...
 687       */
 688
 689       if (http->nextnonce[0])
 690       {
 691         strlcpy(http->nonce, http->nextnonce, sizeof(http->nonce));
 692         http->nonce_count = 1;
 693         http->nextnonce[0] = '\0';
 694       }
 695       else
 696         http->nonce_count ++;
 697
 698       _httpSetDigestAuthString(http, "POST", resource);
 699     }
 700
 701 #ifdef HAVE_GSSAPI
 702     if (http->authstring && !strncmp(http->authstring, "Negotiate", 9))
 703     {
 704      /*
 705       * Do not use cached Kerberos credentials since they will look like a
 706       * "replay" attack...
 707       */
 708
 709       _cupsSetNegotiateAuthString(http, "POST", resource);
 710     }
 711 #endif /* HAVE_GSSAPI */
 712
 713     httpSetField(http, HTTP_FIELD_AUTHORIZATION, http->authstring);
 714
 715     DEBUG_printf(("2cupsSendRequest: authstring=\"%s\"", http->authstring));
 716
 717    /*
 718     * Try the request...
 719     */
 720
 721     DEBUG_puts("2cupsSendRequest: Sending HTTP POST...");
 722
 723     if (httpPost(http, resource))
 724     {
 725       DEBUG_puts("2cupsSendRequest: POST failed, reconnecting.");
 726       if (httpReconnect2(http, 30000, NULL))
 727       {
 728         DEBUG_puts("1cupsSendRequest: Unable to reconnect.");
 729         return (HTTP_STATUS_SERVICE_UNAVAILABLE);
 730       }
 731       else
 732         continue;
 733     }
 734
 735    /*
 736     * Send the IPP data...
 737     */
 738
 739     DEBUG_puts("2cupsSendRequest: Writing IPP request...");
 740
 741     request->state = IPP_STATE_IDLE;
 742     status         = HTTP_STATUS_CONTINUE;
 743     got_status     = 0;
 744
 745     while ((state = ippWrite(http, request)) != IPP_STATE_DATA)
 746     {
 747       if (httpCheck(http))
 748       {
 749         got_status = 1;
 750
 751         _httpUpdate(http, &status);
 752         if (status >= HTTP_STATUS_MULTIPLE_CHOICES)
 753           break;
 754       }
 755       else if (state == IPP_STATE_ERROR)
 756         break;
 757     }
 758
 759     if (state == IPP_STATE_ERROR)
 760     {
 761      /*
 762       * We weren't able to send the IPP request. But did we already get a HTTP
 763       * error status?
 764       */
 765
 766       if (!got_status || status < HTTP_STATUS_MULTIPLE_CHOICES)
 767       {
 768        /*
 769         * No, something else went wrong.
 770         */
 771
 772         DEBUG_puts("1cupsSendRequest: Unable to send IPP request.");
 773
 774         http->status = HTTP_STATUS_ERROR;
 775         http->state  = HTTP_STATE_WAITING;
 776
 777         return (HTTP_STATUS_ERROR);
 778       }
 779     }
 780
 781    /*
 782     * Wait up to 1 second to get the 100-continue response as needed...
 783     */
 784
 785     if (!got_status || (digest && status == HTTP_STATUS_CONTINUE))
 786     {
 787       if (expect == HTTP_STATUS_CONTINUE || digest)
 788       {
 789         DEBUG_puts("2cupsSendRequest: Waiting for 100-continue...");
 790
 791         if (httpWait(http, 1000))
 792           _httpUpdate(http, &status);
 793       }
 794       else if (httpCheck(http))
 795         _httpUpdate(http, &status);
 796     }
 797
 798     DEBUG_printf(("2cupsSendRequest: status=%d", status));
 799
 800    /*
 801     * Process the current HTTP status...
 802     */
 803
 804     if (status >= HTTP_STATUS_MULTIPLE_CHOICES)
 805     {
 806       int temp_status;                  /* Temporary status */
 807
 808       _cupsSetHTTPError(status);
 809
 810       do
 811       {
 812         temp_status = httpUpdate(http);
 813       }
 814       while (temp_status != HTTP_STATUS_ERROR &&
 815              http->state == HTTP_STATE_POST_RECV);
 816
 817       httpFlush(http);
 818     }
 819
 820     switch (status)
 821     {
 822       case HTTP_STATUS_CONTINUE :
 823       case HTTP_STATUS_OK :
 824       case HTTP_STATUS_ERROR :
 825           DEBUG_printf(("1cupsSendRequest: Returning %d.", status));
 826           return (status);
 827
 828       case HTTP_STATUS_UNAUTHORIZED :
 829           if (cupsDoAuthentication(http, "POST", resource))
 830           {
 831             DEBUG_puts("1cupsSendRequest: Returning HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED.");
 832             return (HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED);
 833           }
 834
 835           DEBUG_puts("2cupsSendRequest: Reconnecting after HTTP_STATUS_UNAUTHORIZED.");
 836
 837           if (httpReconnect2(http, 30000, NULL))
 838           {
 839             DEBUG_puts("1cupsSendRequest: Unable to reconnect.");
 840             return (HTTP_STATUS_SERVICE_UNAVAILABLE);
 841           }
 842           break;
 843
 844 #ifdef HAVE_SSL
 845       case HTTP_STATUS_UPGRADE_REQUIRED :
 846          /*
 847           * Flush any error message, reconnect, and then upgrade with
 848           * encryption...
 849           */
 850
 851           DEBUG_puts("2cupsSendRequest: Reconnecting after "
 852                      "HTTP_STATUS_UPGRADE_REQUIRED.");
 853
 854           if (httpReconnect2(http, 30000, NULL))
 855           {
 856             DEBUG_puts("1cupsSendRequest: Unable to reconnect.");
 857             return (HTTP_STATUS_SERVICE_UNAVAILABLE);
 858           }
 859
 860           DEBUG_puts("2cupsSendRequest: Upgrading to TLS.");
 861           if (httpEncryption(http, HTTP_ENCRYPTION_REQUIRED))
 862           {
 863             DEBUG_puts("1cupsSendRequest: Unable to encrypt connection.");
 864             return (HTTP_STATUS_SERVICE_UNAVAILABLE);
 865           }
 866           break;
 867 #endif /* HAVE_SSL */
 868
 869       case HTTP_STATUS_EXPECTATION_FAILED :
 870          /*
 871           * Don't try using the Expect: header the next time around...
 872           */
 873
 874           expect = (http_status_t)0;
 875
 876           DEBUG_puts("2cupsSendRequest: Reconnecting after "
 877                      "HTTP_EXPECTATION_FAILED.");
 878
 879           if (httpReconnect2(http, 30000, NULL))
 880           {
 881             DEBUG_puts("1cupsSendRequest: Unable to reconnect.");
 882             return (HTTP_STATUS_SERVICE_UNAVAILABLE);
 883           }
 884           break;
 885
 886       default :
 887          /*
 888           * Some other error...
 889           */
 890
 891           return (status);
 892     }
 893   }
 894 }
 895
 896
 897 /*
 898  * 'cupsWriteRequestData()' - Write additional data after an IPP request.
 899  *
 900  * This function is used after @link cupsSendRequest@ to provide a PPD and
 901  * after @link cupsStartDocument@ to provide a document file.
 902  *
 903  * @since CUPS 1.4/macOS 10.6@
 904  */
 905
 906 http_status_t                           /* O - @code HTTP_STATUS_CONTINUE@ if OK or HTTP status on error */
 907 cupsWriteRequestData(
 908     http_t     *http,                   /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
 909     const char *buffer,                 /* I - Bytes to write */
 910     size_t     length)                  /* I - Number of bytes to write */
 911 {
 912   int   wused;                          /* Previous bytes in buffer */
 913
 914
 915  /*
 916   * Get the default connection as needed...
 917   */
 918
 919   DEBUG_printf(("cupsWriteRequestData(http=%p, buffer=%p, length=" CUPS_LLFMT ")", (void *)http, (void *)buffer, CUPS_LLCAST length));
 920
 921   if (!http)
 922   {
 923     _cups_globals_t *cg = _cupsGlobals();
 924                                         /* Pointer to library globals */
 925
 926     if ((http = cg->http) == NULL)
 927     {
 928       _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("No active connection"), 1);
 929       DEBUG_puts("1cupsWriteRequestData: Returning HTTP_STATUS_ERROR.");
 930       return (HTTP_STATUS_ERROR);
 931     }
 932   }
 933
 934  /*
 935   * Then write to the HTTP connection...
 936   */
 937
 938   wused = http->wused;
 939
 940   if (httpWrite2(http, buffer, length) < 0)
 941   {
 942     DEBUG_puts("1cupsWriteRequestData: Returning HTTP_STATUS_ERROR.");
 943     _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(http->error), 0);
 944     return (HTTP_STATUS_ERROR);
 945   }
 946
 947  /*
 948   * Finally, check if we have any pending data from the server...
 949   */
 950
 951   if (length >= HTTP_MAX_BUFFER ||
 952       http->wused < wused ||
 953       (wused > 0 && (size_t)http->wused == length))
 954   {
 955    /*
 956     * We've written something to the server, so check for response data...
 957     */
 958
 959     if (_httpWait(http, 0, 1))
 960     {
 961       http_status_t     status;         /* Status from _httpUpdate */
 962
 963       _httpUpdate(http, &status);
 964       if (status >= HTTP_STATUS_MULTIPLE_CHOICES)
 965       {
 966         _cupsSetHTTPError(status);
 967
 968         do
 969         {
 970           status = httpUpdate(http);
 971         }
 972         while (status != HTTP_STATUS_ERROR && http->state == HTTP_STATE_POST_RECV);
 973
 974         httpFlush(http);
 975       }
 976
 977       DEBUG_printf(("1cupsWriteRequestData: Returning %d.\n", status));
 978       return (status);
 979     }
 980   }
 981
 982   DEBUG_puts("1cupsWriteRequestData: Returning HTTP_STATUS_CONTINUE.");
 983   return (HTTP_STATUS_CONTINUE);
 984 }
 985
 986
 987 /*
 988  * '_cupsConnect()' - Get the default server connection...
 989  */
 990
 991 http_t *                                /* O - HTTP connection */
 992 _cupsConnect(void)
 993 {
 994   _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
 995
 996
 997  /*
 998   * See if we are connected to the same server...
 999   */
1000
1001   if (cg->http)
1002   {
1003    /*
1004     * Compare the connection hostname, port, and encryption settings to
1005     * the cached defaults; these were initialized the first time we
1006     * connected...
1007     */
1008
1009     if (strcmp(cg->http->hostname, cg->server) ||
1010 #ifdef AF_LOCAL
1011         (httpAddrFamily(cg->http->hostaddr) != AF_LOCAL && cg->ipp_port != httpAddrPort(cg->http->hostaddr)) ||
1012 #else
1013         cg->ipp_port != httpAddrPort(cg->http->hostaddr) ||
1014 #endif /* AF_LOCAL */
1015         (cg->http->encryption != cg->encryption &&
1016          cg->http->encryption == HTTP_ENCRYPTION_NEVER))
1017     {
1018      /*
1019       * Need to close the current connection because something has changed...
1020       */
1021
1022       httpClose(cg->http);
1023       cg->http = NULL;
1024     }
1025     else
1026     {
1027      /*
1028       * Same server, see if the connection is still established...
1029       */
1030
1031       char      ch;                     /* Connection check byte */
1032       ssize_t   n;                      /* Number of bytes */
1033
1034 #ifdef WIN32
1035       if ((n = recv(cg->http->fd, &ch, 1, MSG_PEEK)) == 0 ||
1036           (n < 0 && WSAGetLastError() != WSAEWOULDBLOCK))
1037 #else
1038       if ((n = recv(cg->http->fd, &ch, 1, MSG_PEEK | MSG_DONTWAIT)) == 0 ||
1039           (n < 0 && errno != EWOULDBLOCK))
1040 #endif /* WIN32 */
1041       {
1042        /*
1043         * Nope, close the connection...
1044         */
1045
1046         httpClose(cg->http);
1047         cg->http = NULL;
1048       }
1049     }
1050   }
1051
1052  /*
1053   * (Re)connect as needed...
1054   */
1055
1056   if (!cg->http)
1057   {
1058     if ((cg->http = httpConnect2(cupsServer(), ippPort(), NULL, AF_UNSPEC,
1059                                  cupsEncryption(), 1, 30000, NULL)) == NULL)
1060     {
1061       if (errno)
1062         _cupsSetError(IPP_STATUS_ERROR_SERVICE_UNAVAILABLE, NULL, 0);
1063       else
1064         _cupsSetError(IPP_STATUS_ERROR_SERVICE_UNAVAILABLE,
1065                       _("Unable to connect to host."), 1);
1066     }
1067   }
1068
1069  /*
1070   * Return the cached connection...
1071   */
1072
1073   return (cg->http);
1074 }
1075
1076
1077 /*
1078  * '_cupsSetError()' - Set the last IPP status code and status-message.
1079  */
1080
1081 void
1082 _cupsSetError(ipp_status_t status,      /* I - IPP status code */
1083               const char   *message,    /* I - status-message value */
1084               int          localize)    /* I - Localize the message? */
1085 {
1086   _cups_globals_t       *cg;            /* Global data */
1087
1088
1089   if (!message && errno)
1090   {
1091     message  = strerror(errno);
1092     localize = 0;
1093   }
1094
1095   cg             = _cupsGlobals();
1096   cg->last_error = status;
1097
1098   if (cg->last_status_message)
1099   {
1100     _cupsStrFree(cg->last_status_message);
1101
1102     cg->last_status_message = NULL;
1103   }
1104
1105   if (message)
1106   {
1107     if (localize)
1108     {
1109      /*
1110       * Get the message catalog...
1111       */
1112
1113       if (!cg->lang_default)
1114         cg->lang_default = cupsLangDefault();
1115
1116       cg->last_status_message = _cupsStrAlloc(_cupsLangString(cg->lang_default,
1117                                                               message));
1118     }
1119     else
1120       cg->last_status_message = _cupsStrAlloc(message);
1121   }
1122
1123   DEBUG_printf(("4_cupsSetError: last_error=%s, last_status_message=\"%s\"",
1124                 ippErrorString(cg->last_error), cg->last_status_message));
1125 }
1126
1127
1128 /*
1129  * '_cupsSetHTTPError()' - Set the last error using the HTTP status.
1130  */
1131
1132 void
1133 _cupsSetHTTPError(http_status_t status) /* I - HTTP status code */
1134 {
1135   switch (status)
1136   {
1137     case HTTP_STATUS_NOT_FOUND :
1138         _cupsSetError(IPP_STATUS_ERROR_NOT_FOUND, httpStatus(status), 0);
1139         break;
1140
1141     case HTTP_STATUS_UNAUTHORIZED :
1142         _cupsSetError(IPP_STATUS_ERROR_NOT_AUTHENTICATED, httpStatus(status), 0);
1143         break;
1144
1145     case HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED :
1146         _cupsSetError(IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED, httpStatus(status), 0);
1147         break;
1148
1149     case HTTP_STATUS_FORBIDDEN :
1150         _cupsSetError(IPP_STATUS_ERROR_FORBIDDEN, httpStatus(status), 0);
1151         break;
1152
1153     case HTTP_STATUS_BAD_REQUEST :
1154         _cupsSetError(IPP_STATUS_ERROR_BAD_REQUEST, httpStatus(status), 0);
1155         break;
1156
1157     case HTTP_STATUS_REQUEST_TOO_LARGE :
1158         _cupsSetError(IPP_STATUS_ERROR_REQUEST_VALUE, httpStatus(status), 0);
1159         break;
1160
1161     case HTTP_STATUS_NOT_IMPLEMENTED :
1162         _cupsSetError(IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED, httpStatus(status), 0);
1163         break;
1164
1165     case HTTP_STATUS_NOT_SUPPORTED :
1166         _cupsSetError(IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED, httpStatus(status), 0);
1167         break;
1168
1169     case HTTP_STATUS_UPGRADE_REQUIRED :
1170         _cupsSetError(IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED, httpStatus(status), 0);
1171         break;
1172
1173     case HTTP_STATUS_CUPS_PKI_ERROR :
1174         _cupsSetError(IPP_STATUS_ERROR_CUPS_PKI, httpStatus(status), 0);
1175         break;
1176
1177     case HTTP_STATUS_ERROR :
1178         _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(errno), 0);
1179         break;
1180
1181     default :
1182         DEBUG_printf(("4_cupsSetHTTPError: HTTP error %d mapped to "
1183                       "IPP_STATUS_ERROR_SERVICE_UNAVAILABLE!", status));
1184         _cupsSetError(IPP_STATUS_ERROR_SERVICE_UNAVAILABLE, httpStatus(status), 0);
1185         break;
1186   }
1187 }