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