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