]> git.ipfire.org Git - thirdparty/cups.git/blame - berkeley/lpq.c
Load cups into easysw/current.
[thirdparty/cups.git] / berkeley / lpq.c
CommitLineData
ef416fc2 1/*
bc44d920 2 * "$Id: lpq.c 6649 2007-07-11 21:46:42Z mike $"
ef416fc2 3 *
4 * "lpq" command for the Common UNIX Printing System (CUPS).
5 *
bc44d920 6 * Copyright 2007 by Apple Inc.
ef416fc2 7 * Copyright 1997-2006 by Easy Software Products.
8 *
9 * These coded instructions, statements, and computer programs are the
bc44d920 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/".
ef416fc2 14 *
15 * Contents:
16 *
17 * main() - Parse options and commands.
18 * show_jobs() - Show jobs.
19 * show_printer() - Show printer status.
20 * usage() - Show program usage.
21 */
22
23/*
24 * Include necessary headers...
25 */
26
27/*
28 * Include necessary headers...
29 */
30
31#include <stdio.h>
32#include <stdlib.h>
33#include <cups/string.h>
34#include <cups/cups.h>
35#include <cups/i18n.h>
36#include <cups/debug.h>
37
38
39/*
40 * Local functions...
41 */
42
d6ae789d 43static http_t *connect_server(const char *, http_t *);
fa73b229 44static int show_jobs(const char *, http_t *, const char *,
45 const char *, const int, const int);
46static void show_printer(const char *, http_t *, const char *);
ef416fc2 47static void usage(void);
48
49
50/*
51 * 'main()' - Parse options and commands.
52 */
53
54int
fa73b229 55main(int argc, /* I - Number of command-line arguments */
56 char *argv[]) /* I - Command-line arguments */
ef416fc2 57{
fa73b229 58 int i; /* Looping var */
59 http_t *http; /* Connection to server */
60 const char *dest, /* Desired printer */
61 *user, /* Desired user */
62 *val; /* Environment variable name */
63 char *instance; /* Printer instance */
64 int id, /* Desired job ID */
65 all, /* All printers */
66 interval, /* Reporting interval */
67 longstatus; /* Show file details */
68 int num_dests; /* Number of destinations */
69 cups_dest_t *dests; /* Destinations */
ef416fc2 70
71
07725fee 72 _cupsSetLocale(argv);
d09495fa 73
ef416fc2 74 /*
75 * Check for command-line options...
76 */
77
d6ae789d 78 http = NULL;
ef416fc2 79 dest = NULL;
80 user = NULL;
81 id = 0;
82 interval = 0;
83 longstatus = 0;
84 all = 0;
d6ae789d 85 num_dests = 0;
d09495fa 86 dests = NULL;
ef416fc2 87
88 for (i = 1; i < argc; i ++)
89 if (argv[i][0] == '+')
90 interval = atoi(argv[i] + 1);
91 else if (argv[i][0] == '-')
92 {
93 switch (argv[i][1])
94 {
95 case 'E' : /* Encrypt */
96#ifdef HAVE_SSL
d6ae789d 97 cupsSetEncryption(HTTP_ENCRYPT_REQUIRED);
ef416fc2 98
99 if (http)
d6ae789d 100 httpEncryption(http, HTTP_ENCRYPT_REQUIRED);
ef416fc2 101#else
fa73b229 102 _cupsLangPrintf(stderr,
ef416fc2 103 _("%s: Sorry, no encryption support compiled in!\n"),
104 argv[0]);
105#endif /* HAVE_SSL */
106 break;
107
fa73b229 108 case 'U' : /* Username */
109 if (argv[i][2] != '\0')
110 cupsSetUser(argv[i] + 2);
111 else
112 {
113 i ++;
114 if (i >= argc)
115 {
116 _cupsLangPrintf(stderr,
117 _("%s: Error - expected username after "
118 "\'-U\' option!\n"),
119 argv[0]);
120 return (1);
121 }
122
123 cupsSetUser(argv[i]);
124 }
125 break;
126
ef416fc2 127 case 'P' : /* Printer */
128 if (argv[i][2])
129 dest = argv[i] + 2;
130 else
131 {
132 i ++;
133
134 if (i >= argc)
135 {
136 httpClose(http);
137 cupsFreeDests(num_dests, dests);
138
139 usage();
140 }
141
142 dest = argv[i];
143 }
144
145 if ((instance = strchr(dest, '/')) != NULL)
146 *instance++ = '\0';
147
d6ae789d 148 http = connect_server(argv[0], http);
149
150 if (num_dests == 0)
151 num_dests = cupsGetDests2(http, &dests);
152
ef416fc2 153 if (cupsGetDest(dest, instance, num_dests, dests) == NULL)
154 {
155 if (instance)
fa73b229 156 _cupsLangPrintf(stderr,
157 _("%s: Error - unknown destination \"%s/%s\"!\n"),
158 argv[0], dest, instance);
ef416fc2 159 else
fa73b229 160 _cupsLangPrintf(stderr,
161 _("%s: Unknown destination \"%s\"!\n"),
162 argv[0], dest);
ef416fc2 163
164 return (1);
165 }
166 break;
167
168 case 'a' : /* All printers */
169 all = 1;
170 break;
171
fa73b229 172 case 'h' : /* Connect to host */
d6ae789d 173 if (http)
174 {
fa73b229 175 httpClose(http);
d6ae789d 176 http = NULL;
177 }
fa73b229 178
179 if (argv[i][2] != '\0')
180 cupsSetServer(argv[i] + 2);
181 else
182 {
183 i ++;
184
185 if (i >= argc)
186 {
187 _cupsLangPrintf(stderr,
188 _("%s: Error - expected hostname after "
189 "\'-h\' option!\n"),
190 argv[0]);
191 return (1);
192 }
193 else
194 cupsSetServer(argv[i]);
195 }
196 break;
197
ef416fc2 198 case 'l' : /* Long status */
199 longstatus = 1;
200 break;
201
202 default :
203 httpClose(http);
204 cupsFreeDests(num_dests, dests);
205
206 usage();
207 break;
208 }
209 }
210 else if (isdigit(argv[i][0] & 255))
211 id = atoi(argv[i]);
212 else
213 user = argv[i];
214
d6ae789d 215 http = connect_server(argv[0], http);
216
ef416fc2 217 if (dest == NULL && !all)
218 {
d6ae789d 219 if (num_dests == 0)
220 num_dests = cupsGetDests2(http, &dests);
221
ef416fc2 222 for (i = 0; i < num_dests; i ++)
223 if (dests[i].is_default)
224 dest = dests[i].name;
225
226 if (dest == NULL)
227 {
228 val = NULL;
229
230 if ((dest = getenv("LPDEST")) == NULL)
231 {
232 if ((dest = getenv("PRINTER")) != NULL)
233 {
234 if (!strcmp(dest, "lp"))
235 dest = NULL;
236 else
237 val = "PRINTER";
238 }
239 }
240 else
241 val = "LPDEST";
242
243 if (dest && !cupsGetDest(dest, NULL, num_dests, dests))
fa73b229 244 _cupsLangPrintf(stderr,
245 _("%s: error - %s environment variable names "
ef416fc2 246 "non-existent destination \"%s\"!\n"),
fa73b229 247 argv[0], val, dest);
ef416fc2 248 else
fa73b229 249 _cupsLangPrintf(stderr,
250 _("%s: error - no default destination available.\n"),
251 argv[0]);
ef416fc2 252 httpClose(http);
253 cupsFreeDests(num_dests, dests);
254 return (1);
255 }
256 }
257
258 /*
259 * Show the status in a loop...
260 */
261
262 for (;;)
263 {
264 if (dest)
fa73b229 265 show_printer(argv[0], http, dest);
ef416fc2 266
fa73b229 267 i = show_jobs(argv[0], http, dest, user, id, longstatus);
ef416fc2 268
269 if (i && interval)
270 {
271 fflush(stdout);
272 sleep(interval);
273 }
274 else
275 break;
276 }
277
278 /*
279 * Close the connection to the server and return...
280 */
281
282 cupsFreeDests(num_dests, dests);
283 httpClose(http);
284
285 return (0);
286}
287
288
d6ae789d 289/*
290 * 'connect_server()' - Connect to the server as necessary...
291 */
292
293static http_t * /* O - New HTTP connection */
294connect_server(const char *command, /* I - Command name */
295 http_t *http) /* I - Current HTTP connection */
296{
297 if (!http)
298 {
299 http = httpConnectEncrypt(cupsServer(), ippPort(),
300 cupsEncryption());
301
302 if (http == NULL)
303 {
304 _cupsLangPrintf(stderr, _("%s: Unable to connect to server\n"), command);
305 exit(1);
306 }
307 }
308
309 return (http);
310}
311
312
ef416fc2 313/*
314 * 'show_jobs()' - Show jobs.
315 */
316
fa73b229 317static int /* O - Number of jobs in queue */
318show_jobs(const char *command, /* I - Command name */
319 http_t *http, /* I - HTTP connection to server */
320 const char *dest, /* I - Destination */
321 const char *user, /* I - User */
322 const int id, /* I - Job ID */
323 const int longstatus) /* I - 1 if long report desired */
ef416fc2 324{
fa73b229 325 ipp_t *request, /* IPP Request */
326 *response; /* IPP Response */
327 ipp_attribute_t *attr; /* Current attribute */
328 const char *jobdest, /* Pointer into job-printer-uri */
329 *jobuser, /* Pointer to job-originating-user-name */
330 *jobname; /* Pointer to job-name */
331 ipp_jstate_t jobstate; /* job-state */
332 int jobid, /* job-id */
333 jobsize, /* job-k-octets */
ef416fc2 334#ifdef __osf__
fa73b229 335 jobpriority, /* job-priority */
ef416fc2 336#endif /* __osf__ */
fa73b229 337 jobcount, /* Number of jobs */
338 jobcopies, /* Number of copies */
339 rank; /* Rank of job */
340 char resource[1024]; /* Resource string */
341 char rankstr[255]; /* Rank string */
342 char namestr[1024]; /* Job name string */
343 static const char *ranks[10] = /* Ranking strings */
ef416fc2 344 {
345 "th",
346 "st",
347 "nd",
348 "rd",
349 "th",
350 "th",
351 "th",
352 "th",
353 "th",
354 "th"
355 };
356
357
358 DEBUG_printf(("show_jobs(%08x, %08x, %08x, %d, %d)\n", http, dest, user, id,
359 longstatus));
360
361 if (http == NULL)
362 return (0);
363
364 /*
365 * Build an IPP_GET_JOBS or IPP_GET_JOB_ATTRIBUTES request, which requires
366 * the following attributes:
367 *
368 * attributes-charset
369 * attributes-natural-language
370 * job-uri or printer-uri
371 */
372
fa73b229 373 request = ippNewRequest(id ? IPP_GET_JOB_ATTRIBUTES : IPP_GET_JOBS);
ef416fc2 374
375 if (dest == NULL)
376 {
377 if (id)
378 sprintf(resource, "ipp://localhost/jobs/%d", id);
379 else
380 strcpy(resource, "ipp://localhost/jobs");
381
382 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "job-uri",
383 NULL, resource);
384 }
385 else
386 {
a4d04587 387 httpAssembleURIf(HTTP_URI_CODING_ALL, resource, sizeof(resource), "ipp",
388 NULL, "localhost", 0, "/printers/%s", dest);
ef416fc2 389
390 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
391 NULL, resource);
392 }
393
394 if (user)
395 {
396 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
397 "requesting-user-name", NULL, user);
398 ippAddBoolean(request, IPP_TAG_OPERATION, "my-jobs", 1);
399 }
400
401 /*
402 * Do the request and get back a response...
403 */
404
405 jobcount = 0;
406
407 if ((response = cupsDoRequest(http, request, "/")) != NULL)
408 {
409 if (response->request.status.status_code > IPP_OK_CONFLICT)
410 {
fa73b229 411 _cupsLangPrintf(stderr, "%s: %s\n", command, cupsLastErrorString());
ef416fc2 412 ippDelete(response);
413 return (0);
414 }
415
416 rank = 1;
417
418 /*
419 * Loop through the job list and display them...
420 */
421
422 for (attr = response->attrs; attr != NULL; attr = attr->next)
423 {
424 /*
425 * Skip leading attributes until we hit a job...
426 */
427
428 while (attr != NULL && attr->group_tag != IPP_TAG_JOB)
429 attr = attr->next;
430
431 if (attr == NULL)
432 break;
433
434 /*
435 * Pull the needed attributes from this job...
436 */
437
438 jobid = 0;
439 jobsize = 0;
440#ifdef __osf__
441 jobpriority = 50;
442#endif /* __osf__ */
443 jobstate = IPP_JOB_PENDING;
444 jobname = "untitled";
445 jobuser = NULL;
446 jobdest = NULL;
447 jobcopies = 1;
448
449 while (attr != NULL && attr->group_tag == IPP_TAG_JOB)
450 {
fa73b229 451 if (!strcmp(attr->name, "job-id") &&
ef416fc2 452 attr->value_tag == IPP_TAG_INTEGER)
453 jobid = attr->values[0].integer;
454
fa73b229 455 if (!strcmp(attr->name, "job-k-octets") &&
ef416fc2 456 attr->value_tag == IPP_TAG_INTEGER)
457 jobsize = attr->values[0].integer;
458
459#ifdef __osf__
fa73b229 460 if (!strcmp(attr->name, "job-priority") &&
ef416fc2 461 attr->value_tag == IPP_TAG_INTEGER)
462 jobpriority = attr->values[0].integer;
463#endif /* __osf__ */
464
fa73b229 465 if (!strcmp(attr->name, "job-state") &&
ef416fc2 466 attr->value_tag == IPP_TAG_ENUM)
467 jobstate = (ipp_jstate_t)attr->values[0].integer;
468
fa73b229 469 if (!strcmp(attr->name, "job-printer-uri") &&
ef416fc2 470 attr->value_tag == IPP_TAG_URI)
471 if ((jobdest = strrchr(attr->values[0].string.text, '/')) != NULL)
472 jobdest ++;
473
fa73b229 474 if (!strcmp(attr->name, "job-originating-user-name") &&
ef416fc2 475 attr->value_tag == IPP_TAG_NAME)
476 jobuser = attr->values[0].string.text;
477
fa73b229 478 if (!strcmp(attr->name, "job-name") &&
ef416fc2 479 attr->value_tag == IPP_TAG_NAME)
480 jobname = attr->values[0].string.text;
481
fa73b229 482 if (!strcmp(attr->name, "copies") &&
ef416fc2 483 attr->value_tag == IPP_TAG_INTEGER)
484 jobcopies = attr->values[0].integer;
485
486 attr = attr->next;
487 }
488
489 /*
490 * See if we have everything needed...
491 */
492
493 if (jobdest == NULL || jobid == 0)
494 {
495 if (attr == NULL)
496 break;
497 else
498 continue;
499 }
500
501 if (!longstatus && jobcount == 0)
502#ifdef __osf__
fa73b229 503 _cupsLangPuts(stdout,
ef416fc2 504 _("Rank Owner Pri Job Files"
505 " Total Size\n"));
506#else
fa73b229 507 _cupsLangPuts(stdout,
ef416fc2 508 _("Rank Owner Job File(s)"
509 " Total Size\n"));
510#endif /* __osf__ */
511
512 jobcount ++;
513
514 /*
515 * Display the job...
516 */
517
518 if (jobstate == IPP_JOB_PROCESSING)
519 strcpy(rankstr, "active");
520 else
521 {
522 /*
523 * Make the rank show the "correct" suffix for each number
524 * (11-13 are the only special cases, for English anyways...)
525 */
526
527 if ((rank % 100) >= 11 && (rank % 100) <= 13)
528 snprintf(rankstr, sizeof(rankstr), "%dth", rank);
529 else
530 snprintf(rankstr, sizeof(rankstr), "%d%s", rank, ranks[rank % 10]);
531
532 rank ++;
533 }
534
535 if (longstatus)
536 {
fa73b229 537 _cupsLangPuts(stdout, "\n");
ef416fc2 538
539 if (jobcopies > 1)
540 snprintf(namestr, sizeof(namestr), "%d copies of %s", jobcopies,
541 jobname);
542 else
543 strlcpy(namestr, jobname, sizeof(namestr));
544
fa73b229 545 _cupsLangPrintf(stdout, _("%s: %-33.33s [job %d localhost]\n"),
ef416fc2 546 jobuser, rankstr, jobid);
fa73b229 547 _cupsLangPrintf(stdout, _(" %-39.39s %.0f bytes\n"),
ef416fc2 548 namestr, 1024.0 * jobsize);
549 }
550 else
551#ifdef __osf__
fa73b229 552 _cupsLangPrintf(stdout,
ef416fc2 553 _("%-6s %-10.10s %-4d %-10d %-27.27s %.0f bytes\n"),
554 rankstr, jobuser, jobpriority, jobid, jobname,
555 1024.0 * jobsize);
556#else
fa73b229 557 _cupsLangPrintf(stdout,
ef416fc2 558 _("%-7s %-7.7s %-7d %-31.31s %.0f bytes\n"),
559 rankstr, jobuser, jobid, jobname, 1024.0 * jobsize);
560#endif /* __osf */
561
562 if (attr == NULL)
563 break;
564 }
565
566 ippDelete(response);
567 }
568 else
569 {
fa73b229 570 _cupsLangPrintf(stderr, "%s: %s\n", command, cupsLastErrorString());
ef416fc2 571 return (0);
572 }
573
574 if (jobcount == 0)
fa73b229 575 _cupsLangPuts(stdout, _("no entries\n"));
ef416fc2 576
577 return (jobcount);
578}
579
580
581/*
582 * 'show_printer()' - Show printer status.
583 */
584
585static void
fa73b229 586show_printer(const char *command, /* I - Command name */
587 http_t *http, /* I - HTTP connection to server */
588 const char *dest) /* I - Destination */
ef416fc2 589{
fa73b229 590 ipp_t *request, /* IPP Request */
591 *response; /* IPP Response */
592 ipp_attribute_t *attr; /* Current attribute */
593 ipp_pstate_t state; /* Printer state */
594 char uri[HTTP_MAX_URI]; /* Printer URI */
ef416fc2 595
596
597 if (http == NULL)
598 return;
599
600 /*
601 * Build an IPP_GET_PRINTER_ATTRIBUTES request, which requires the following
602 * attributes:
603 *
604 * attributes-charset
605 * attributes-natural-language
606 * printer-uri
607 */
608
fa73b229 609 request = ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES);
ef416fc2 610
a4d04587 611 httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
612 "localhost", 0, "/printers/%s", dest);
ef416fc2 613 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI,
614 "printer-uri", NULL, uri);
615
616 /*
617 * Do the request and get back a response...
618 */
619
620 if ((response = cupsDoRequest(http, request, "/")) != NULL)
621 {
622 if (response->request.status.status_code > IPP_OK_CONFLICT)
623 {
fa73b229 624 _cupsLangPrintf(stderr, "%s: %s\n", command, cupsLastErrorString());
ef416fc2 625 ippDelete(response);
626 return;
627 }
628
629 if ((attr = ippFindAttribute(response, "printer-state", IPP_TAG_ENUM)) != NULL)
630 state = (ipp_pstate_t)attr->values[0].integer;
631 else
632 state = IPP_PRINTER_STOPPED;
633
634 switch (state)
635 {
636 case IPP_PRINTER_IDLE :
fa73b229 637 _cupsLangPrintf(stdout, _("%s is ready\n"), dest);
ef416fc2 638 break;
639 case IPP_PRINTER_PROCESSING :
fa73b229 640 _cupsLangPrintf(stdout, _("%s is ready and printing\n"),
ef416fc2 641 dest);
642 break;
643 case IPP_PRINTER_STOPPED :
fa73b229 644 _cupsLangPrintf(stdout, _("%s is not ready\n"), dest);
ef416fc2 645 break;
646 }
647
648 ippDelete(response);
649 }
650 else
fa73b229 651 _cupsLangPrintf(stderr, "%s: %s\n", command, cupsLastErrorString());
ef416fc2 652}
653
654
655/*
656 * 'usage()' - Show program usage.
657 */
658
659static void
660usage(void)
661{
fa73b229 662 _cupsLangPuts(stderr,
663 _("Usage: lpq [-P dest] [-U username] [-h hostname[:port]] "
664 "[-l] [+interval]\n"));
ef416fc2 665 exit(1);
666}
667
668
669/*
bc44d920 670 * End of "$Id: lpq.c 6649 2007-07-11 21:46:42Z mike $".
ef416fc2 671 */