cgi-bin/printers.c

   1 /*
   2  * "$Id: printers.c 7940 2008-09-16 00:45:16Z mike $"
   3  *
   4  *   Printer status CGI for the Common UNIX Printing System (CUPS).
   5  *
   6  *   Copyright 2007-2008 by Apple Inc.
   7  *   Copyright 1997-2006 by Easy Software Products.
   8  *
   9  *   These coded instructions, statements, and computer programs are the
  10  *   property of Apple Inc. and are protected by Federal copyright
  11  *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  12  *   which should have been included with this file.  If this file is
  13  *   file is missing or damaged, see the license at "http://www.cups.org/".
  14  *
  15  * Contents:
  16  *
  17  *   main()              - Main entry for CGI.
  18  *   do_printer_op()     - Do a printer operation.
  19  *   show_all_printers() - Show all printers...
  20  *   show_printer()      - Show a single printer.
  21  */
  22
  23 /*
  24  * Include necessary headers...
  25  */
  26
  27 #include "cgi-private.h"
  28 #include <errno.h>
  29
  30
  31 /*
  32  * Local functions...
  33  */
  34
  35 static void     do_printer_op(http_t *http, const char *printer, ipp_op_t op,
  36                               const char *title);
  37 static void     show_all_printers(http_t *http, const char *username);
  38 static void     show_printer(http_t *http, const char *printer);
  39
  40
  41 /*
  42  * 'main()' - Main entry for CGI.
  43  */
  44
  45 int                                     /* O - Exit status */
  46 main(int  argc,                         /* I - Number of command-line arguments */
  47      char *argv[])                      /* I - Command-line arguments */
  48 {
  49   const char    *printer;               /* Printer name */
  50   const char    *user;                  /* Username */
  51   http_t        *http;                  /* Connection to the server */
  52   ipp_t         *request,               /* IPP request */
  53                 *response;              /* IPP response */
  54   ipp_attribute_t *attr;                /* IPP attribute */
  55   const char    *op;                    /* Operation to perform, if any */
  56   static const char *def_attrs[] =      /* Attributes for default printer */
  57                 {
  58                   "printer-name",
  59                   "printer-uri-supported"
  60                 };
  61
  62
  63  /*
  64   * Get any form variables...
  65   */
  66
  67   cgiInitialize();
  68
  69   op = cgiGetVariable("OP");
  70
  71  /*
  72   * Set the web interface section...
  73   */
  74
  75   cgiSetVariable("SECTION", "printers");
  76   cgiSetVariable("REFRESH_PAGE", "");
  77
  78  /*
  79   * See if we are displaying a printer or all printers...
  80   */
  81
  82   if ((printer = getenv("PATH_INFO")) != NULL)
  83   {
  84     printer ++;
  85
  86     if (!*printer)
  87       printer = NULL;
  88
  89     if (printer)
  90       cgiSetVariable("PRINTER_NAME", printer);
  91   }
  92
  93  /*
  94   * See who is logged in...
  95   */
  96
  97   user = getenv("REMOTE_USER");
  98
  99  /*
 100   * Connect to the HTTP server...
 101   */
 102
 103   http = httpConnectEncrypt(cupsServer(), ippPort(), cupsEncryption());
 104
 105  /*
 106   * Get the default printer...
 107   */
 108
 109   if (!op || !cgiIsPOST())
 110   {
 111    /*
 112     * Get the default destination...
 113     */
 114
 115     request = ippNewRequest(CUPS_GET_DEFAULT);
 116
 117     ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
 118                   "requested-attributes",
 119                   sizeof(def_attrs) / sizeof(def_attrs[0]), NULL, def_attrs);
 120
 121     if ((response = cupsDoRequest(http, request, "/")) != NULL)
 122     {
 123       if ((attr = ippFindAttribute(response, "printer-name", IPP_TAG_NAME)) != NULL)
 124         cgiSetVariable("DEFAULT_NAME", attr->values[0].string.text);
 125
 126       if ((attr = ippFindAttribute(response, "printer-uri-supported", IPP_TAG_URI)) != NULL)
 127       {
 128         char    url[HTTP_MAX_URI];      /* New URL */
 129
 130
 131         cgiSetVariable("DEFAULT_URI",
 132                        cgiRewriteURL(attr->values[0].string.text,
 133                                      url, sizeof(url), NULL));
 134       }
 135
 136       ippDelete(response);
 137     }
 138
 139    /*
 140     * See if we need to show a list of printers or the status of a
 141     * single printer...
 142     */
 143
 144     if (!printer)
 145       show_all_printers(http, user);
 146     else
 147       show_printer(http, printer);
 148   }
 149   else if (printer)
 150   {
 151     if (!strcmp(op, "start-printer"))
 152       do_printer_op(http, printer, IPP_RESUME_PRINTER,
 153                     cgiText(_("Resume Printer")));
 154     else if (!strcmp(op, "stop-printer"))
 155       do_printer_op(http, printer, IPP_PAUSE_PRINTER,
 156                     cgiText(_("Pause Printer")));
 157     else if (!strcmp(op, "accept-jobs"))
 158       do_printer_op(http, printer, CUPS_ACCEPT_JOBS, cgiText(_("Accept Jobs")));
 159     else if (!strcmp(op, "reject-jobs"))
 160       do_printer_op(http, printer, CUPS_REJECT_JOBS, cgiText(_("Reject Jobs")));
 161     else if (!strcmp(op, "purge-jobs"))
 162       do_printer_op(http, printer, IPP_PURGE_JOBS, cgiText(_("Purge Jobs")));
 163     else if (!strcasecmp(op, "print-self-test-page"))
 164       cgiPrintCommand(http, printer, "PrintSelfTestPage",
 165                       cgiText(_("Print Self-Test Page")));
 166     else if (!strcasecmp(op, "clean-print-heads"))
 167       cgiPrintCommand(http, printer, "Clean all",
 168                       cgiText(_("Clean Print Heads")));
 169     else if (!strcasecmp(op, "print-test-page"))
 170       cgiPrintTestPage(http, printer);
 171     else if (!strcasecmp(op, "move-jobs"))
 172       cgiMoveJobs(http, printer, 0);
 173     else
 174     {
 175      /*
 176       * Unknown/bad operation...
 177       */
 178
 179       cgiStartHTML(printer);
 180       cgiCopyTemplateLang("error-op.tmpl");
 181       cgiEndHTML();
 182     }
 183   }
 184   else
 185   {
 186    /*
 187     * Unknown/bad operation...
 188     */
 189
 190     cgiStartHTML(cgiText(_("Printers")));
 191     cgiCopyTemplateLang("error-op.tmpl");
 192     cgiEndHTML();
 193   }
 194
 195  /*
 196   * Close the HTTP server connection...
 197   */
 198
 199   httpClose(http);
 200
 201  /*
 202   * Return with no errors...
 203   */
 204
 205   return (0);
 206 }
 207
 208
 209 /*
 210  * 'do_printer_op()' - Do a printer operation.
 211  */
 212
 213 static void
 214 do_printer_op(http_t      *http,        /* I - HTTP connection */
 215               const char  *printer,     /* I - Printer name */
 216               ipp_op_t    op,           /* I - Operation to perform */
 217               const char  *title)       /* I - Title of page */
 218 {
 219   ipp_t         *request;               /* IPP request */
 220   char          uri[HTTP_MAX_URI],      /* Printer URI */
 221                 resource[HTTP_MAX_URI]; /* Path for request */
 222
 223
 224  /*
 225   * Build a printer request, which requires the following
 226   * attributes:
 227   *
 228   *    attributes-charset
 229   *    attributes-natural-language
 230   *    printer-uri
 231   */
 232
 233   request = ippNewRequest(op);
 234
 235   httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
 236                    "localhost", 0, "/printers/%s", printer);
 237   ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
 238                NULL, uri);
 239
 240  /*
 241   * Do the request and get back a response...
 242   */
 243
 244   snprintf(resource, sizeof(resource), "/printers/%s", printer);
 245   ippDelete(cupsDoRequest(http, request, resource));
 246
 247   if (cupsLastError() == IPP_NOT_AUTHORIZED)
 248   {
 249     puts("Status: 401\n");
 250     exit(0);
 251   }
 252   else if (cupsLastError() > IPP_OK_CONFLICT)
 253   {
 254     cgiStartHTML(title);
 255     cgiShowIPPError(_("Unable to do maintenance command:"));
 256   }
 257   else
 258   {
 259    /*
 260     * Redirect successful updates back to the printer page...
 261     */
 262
 263     char        url[1024],              /* Printer/class URL */
 264                 refresh[1024];          /* Refresh URL */
 265
 266
 267     cgiRewriteURL(uri, url, sizeof(url), NULL);
 268     cgiFormEncode(uri, url, sizeof(uri));
 269     snprintf(refresh, sizeof(refresh), "5;URL=%s", uri);
 270     cgiSetVariable("refresh_page", refresh);
 271
 272     cgiStartHTML(title);
 273
 274     if (op == IPP_PAUSE_PRINTER)
 275       cgiCopyTemplateLang("printer-stop.tmpl");
 276     else if (op == IPP_RESUME_PRINTER)
 277       cgiCopyTemplateLang("printer-start.tmpl");
 278     else if (op == CUPS_ACCEPT_JOBS)
 279       cgiCopyTemplateLang("printer-accept.tmpl");
 280     else if (op == CUPS_REJECT_JOBS)
 281       cgiCopyTemplateLang("printer-reject.tmpl");
 282     else if (op == IPP_PURGE_JOBS)
 283       cgiCopyTemplateLang("printer-purge.tmpl");
 284   }
 285
 286   cgiEndHTML();
 287 }
 288
 289
 290 /*
 291  * 'show_all_printers()' - Show all printers...
 292  */
 293
 294 static void
 295 show_all_printers(http_t     *http,     /* I - Connection to server */
 296                   const char *user)     /* I - Username */
 297 {
 298   int                   i;              /* Looping var */
 299   ipp_t                 *request,       /* IPP request */
 300                         *response;      /* IPP response */
 301   cups_array_t          *printers;      /* Array of printer objects */
 302   ipp_attribute_t       *printer;       /* Printer object */
 303   int                   ascending,      /* Order of printers (0 = descending) */
 304                         first,          /* First printer to show */
 305                         count;          /* Number of printers */
 306   const char            *var;           /* Form variable */
 307   void                  *search;        /* Search data */
 308   char                  val[1024];      /* Form variable */
 309
 310
 311   fprintf(stderr, "DEBUG: show_all_printers(http=%p, user=\"%s\")\n",
 312           http, user ? user : "(null)");
 313
 314  /*
 315   * Show the standard header...
 316   */
 317
 318   cgiStartHTML(cgiText(_("Printers")));
 319
 320  /*
 321   * Build a CUPS_GET_PRINTERS request, which requires the following
 322   * attributes:
 323   *
 324   *    attributes-charset
 325   *    attributes-natural-language
 326   *    printer-type
 327   *    printer-type-mask
 328   *    requesting-user-name
 329   */
 330
 331   request = ippNewRequest(CUPS_GET_PRINTERS);
 332
 333   ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM,
 334                 "printer-type", 0);
 335   ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM,
 336                 "printer-type-mask", CUPS_PRINTER_CLASS);
 337
 338   if (user)
 339     ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
 340                  "requesting-user-name", NULL, user);
 341
 342   cgiGetAttributes(request, "printers.tmpl");
 343
 344  /*
 345   * Do the request and get back a response...
 346   */
 347
 348   if ((response = cupsDoRequest(http, request, "/")) != NULL)
 349   {
 350    /*
 351     * Get a list of matching job objects.
 352     */
 353
 354     if ((var = cgiGetVariable("QUERY")) != NULL &&
 355         !cgiGetVariable("CLEAR"))
 356       search = cgiCompileSearch(var);
 357     else
 358       search = NULL;
 359
 360     printers  = cgiGetIPPObjects(response, search);
 361     count     = cupsArrayCount(printers);
 362
 363     if (search)
 364       cgiFreeSearch(search);
 365
 366    /*
 367     * Figure out which printers to display...
 368     */
 369
 370     if ((var = cgiGetVariable("FIRST")) != NULL)
 371       first = atoi(var);
 372     else
 373       first = 0;
 374
 375     if (first >= count)
 376       first = count - CUPS_PAGE_MAX;
 377
 378     first = (first / CUPS_PAGE_MAX) * CUPS_PAGE_MAX;
 379
 380     if (first < 0)
 381       first = 0;
 382
 383     sprintf(val, "%d", count);
 384     cgiSetVariable("TOTAL", val);
 385
 386     if ((var = cgiGetVariable("ORDER")) != NULL)
 387       ascending = !strcasecmp(var, "asc");
 388     else
 389       ascending = 1;
 390
 391     if (ascending)
 392     {
 393       for (i = 0, printer = (ipp_attribute_t *)cupsArrayIndex(printers, first);
 394            i < CUPS_PAGE_MAX && printer;
 395            i ++, printer = (ipp_attribute_t *)cupsArrayNext(printers))
 396         cgiSetIPPObjectVars(printer, NULL, i);
 397     }
 398     else
 399     {
 400       for (i = 0, printer = (ipp_attribute_t *)cupsArrayIndex(printers, count - first - 1);
 401            i < CUPS_PAGE_MAX && printer;
 402            i ++, printer = (ipp_attribute_t *)cupsArrayPrev(printers))
 403         cgiSetIPPObjectVars(printer, NULL, i);
 404     }
 405
 406    /*
 407     * Save navigation URLs...
 408     */
 409
 410     cgiSetVariable("THISURL", "/printers/");
 411
 412     if (first > 0)
 413     {
 414       sprintf(val, "%d", first - CUPS_PAGE_MAX);
 415       cgiSetVariable("PREV", val);
 416     }
 417
 418     if ((first + CUPS_PAGE_MAX) < count)
 419     {
 420       sprintf(val, "%d", first + CUPS_PAGE_MAX);
 421       cgiSetVariable("NEXT", val);
 422     }
 423
 424    /*
 425     * Then show everything...
 426     */
 427
 428     cgiCopyTemplateLang("search.tmpl");
 429
 430     cgiCopyTemplateLang("printers-header.tmpl");
 431
 432     if (count > CUPS_PAGE_MAX)
 433       cgiCopyTemplateLang("pager.tmpl");
 434
 435     cgiCopyTemplateLang("printers.tmpl");
 436
 437     if (count > CUPS_PAGE_MAX)
 438       cgiCopyTemplateLang("pager.tmpl");
 439
 440    /*
 441     * Delete the response...
 442     */
 443
 444     cupsArrayDelete(printers);
 445     ippDelete(response);
 446   }
 447   else
 448   {
 449    /*
 450     * Show the error...
 451     */
 452
 453     cgiShowIPPError(_("Unable to get printer list:"));
 454   }
 455
 456    cgiEndHTML();
 457 }
 458
 459
 460 /*
 461  * 'show_printer()' - Show a single printer.
 462  */
 463
 464 static void
 465 show_printer(http_t     *http,          /* I - Connection to server */
 466              const char *printer)       /* I - Name of printer */
 467 {
 468   ipp_t         *request,               /* IPP request */
 469                 *response;              /* IPP response */
 470   ipp_attribute_t *attr;                /* IPP attribute */
 471   char          uri[HTTP_MAX_URI];      /* Printer URI */
 472   char          refresh[1024];          /* Refresh URL */
 473
 474
 475   fprintf(stderr, "DEBUG: show_printer(http=%p, printer=\"%s\")\n",
 476           http, printer ? printer : "(null)");
 477
 478  /*
 479   * Build an IPP_GET_PRINTER_ATTRIBUTES request, which requires the following
 480   * attributes:
 481   *
 482   *    attributes-charset
 483   *    attributes-natural-language
 484   *    printer-uri
 485   */
 486
 487   request = ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES);
 488
 489   httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
 490                    "localhost", 0, "/printers/%s", printer);
 491   ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL,
 492                uri);
 493
 494   cgiGetAttributes(request, "printer.tmpl");
 495
 496  /*
 497   * Do the request and get back a response...
 498   */
 499
 500   if ((response = cupsDoRequest(http, request, "/")) != NULL)
 501   {
 502    /*
 503     * Got the result; set the CGI variables and check the status of a
 504     * single-queue request...
 505     */
 506
 507     cgiSetIPPVars(response, NULL, NULL, NULL, 0);
 508
 509     if (printer && (attr = ippFindAttribute(response, "printer-state",
 510                                             IPP_TAG_ENUM)) != NULL &&
 511         attr->values[0].integer == IPP_PRINTER_PROCESSING)
 512     {
 513      /*
 514       * Printer is processing - automatically refresh the page until we
 515       * are done printing...
 516       */
 517
 518       cgiFormEncode(uri, printer, sizeof(uri));
 519       snprintf(refresh, sizeof(refresh), "10;URL=/printers/%s", uri);
 520       cgiSetVariable("refresh_page", refresh);
 521     }
 522
 523    /*
 524     * Delete the response...
 525     */
 526
 527     ippDelete(response);
 528
 529    /*
 530     * Show the standard header...
 531     */
 532
 533     cgiStartHTML(printer);
 534
 535    /*
 536     * Show the printer status...
 537     */
 538
 539     cgiCopyTemplateLang("printer.tmpl");
 540
 541    /*
 542     * Show jobs for the specified printer...
 543     */
 544
 545     cgiCopyTemplateLang("printer-jobs-header.tmpl");
 546     cgiShowJobs(http, printer);
 547   }
 548   else
 549   {
 550    /*
 551     * Show the IPP error...
 552     */
 553
 554     cgiStartHTML(printer);
 555     cgiShowIPPError(_("Unable to get printer status:"));
 556   }
 557
 558    cgiEndHTML();
 559 }
 560
 561
 562 /*
 563  * End of "$Id: printers.c 7940 2008-09-16 00:45:16Z mike $".
 564  */