]>
git.ipfire.org Git - thirdparty/cups.git/blob - cgi-bin/ipp-var.c
2 * "$Id: ipp-var.c 7541 2008-05-05 21:22:58Z mike $"
4 * CGI <-> IPP variable routines for the Common UNIX Printing System (CUPS).
6 * Copyright 2007-2008 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products.
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/".
17 * cgiGetAttributes() - Get the list of attributes that are needed
18 * by the template file.
19 * cgiGetIPPObjects() - Get the objects in an IPP response.
20 * cgiMoveJobs() - Move one or more jobs.
21 * cgiPrintTestPage() - Print a test page.
22 * cgiRewriteURL() - Rewrite a printer URI into a web browser URL...
23 * cgiSetIPPObjectVars() - Set CGI variables from an IPP object.
24 * cgiSetIPPVars() - Set CGI variables from an IPP response.
25 * cgiShowIPPError() - Show the last IPP error message.
26 * cgiShowJobs() - Show print jobs.
27 * cgiText() - Return localized text.
31 * Include necessary headers...
34 #include "cgi-private.h"
38 * 'cgiGetAttributes()' - Get the list of attributes that are needed
39 * by the template file.
43 cgiGetAttributes(ipp_t
*request
, /* I - IPP request */
44 const char *tmpl
) /* I - Base filename */
46 int num_attrs
; /* Number of attributes */
47 char *attrs
[1000]; /* Attributes */
48 int i
; /* Looping var */
49 char filename
[1024], /* Filename */
50 locale
[16]; /* Locale name */
51 const char *directory
, /* Directory */
53 FILE *in
; /* Input file */
54 int ch
; /* Character from file */
55 char name
[255], /* Name of variable */
56 *nameptr
; /* Pointer into name */
60 * Convert the language to a locale name...
63 if ((lang
= getenv("LANG")) != NULL
)
65 for (i
= 0; lang
[i
] && i
< 15; i
++)
66 if (isalnum(lang
[i
] & 255))
67 locale
[i
] = tolower(lang
[i
]);
77 * See if we have a template file for this language...
80 directory
= cgiGetTemplateDir();
82 snprintf(filename
, sizeof(filename
), "%s/%s/%s", directory
, locale
, tmpl
);
83 if (access(filename
, 0))
87 snprintf(filename
, sizeof(filename
), "%s/%s/%s", directory
, locale
, tmpl
);
88 if (access(filename
, 0))
89 snprintf(filename
, sizeof(filename
), "%s/%s", directory
, tmpl
);
93 * Open the template file...
96 if ((in
= fopen(filename
, "r")) == NULL
)
100 * Loop through the file adding attribute names as needed...
104 attrs
[0] = NULL
; /* Eliminate compiler warning */
106 while ((ch
= getc(in
)) != EOF
)
109 else if (ch
== '{' && num_attrs
< (sizeof(attrs
) / sizeof(attrs
[0])))
115 for (nameptr
= name
; (ch
= getc(in
)) != EOF
;)
116 if (strchr("}]<>=! \t\n", ch
))
118 else if (nameptr
> name
&& ch
== '?')
120 else if (nameptr
< (name
+ sizeof(name
) - 1))
130 if (!strncmp(name
, "printer_state_history", 21))
131 strcpy(name
, "printer_state_history");
134 * Possibly add it to the list of attributes...
137 for (i
= 0; i
< num_attrs
; i
++)
138 if (!strcmp(attrs
[i
], name
))
143 attrs
[num_attrs
] = strdup(name
);
149 * If we have attributes, add a requested-attributes attribute to the
155 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
156 "requested-attributes", num_attrs
, NULL
, (const char **)attrs
);
158 for (i
= 0; i
< num_attrs
; i
++)
167 * 'cgiGetIPPObjects()' - Get the objects in an IPP response.
170 cups_array_t
* /* O - Array of objects */
171 cgiGetIPPObjects(ipp_t
*response
, /* I - IPP response */
172 void *search
) /* I - Search filter */
174 int i
; /* Looping var */
175 cups_array_t
*objs
; /* Array of objects */
176 ipp_attribute_t
*attr
, /* Current attribute */
177 *first
; /* First attribute for object */
178 ipp_tag_t group
; /* Current group tag */
179 int add
; /* Add this object to the array? */
185 for (add
= 0, first
= NULL
, objs
= cupsArrayNew(NULL
, NULL
),
186 group
= IPP_TAG_ZERO
, attr
= response
->attrs
;
190 if (attr
->group_tag
!= group
)
192 group
= attr
->group_tag
;
194 if (group
!= IPP_TAG_ZERO
&& group
!= IPP_TAG_OPERATION
)
199 else if (add
&& first
)
201 cupsArrayAdd(objs
, first
);
208 if (attr
->name
&& attr
->group_tag
!= IPP_TAG_OPERATION
&& !add
)
213 * Add all objects if there is no search...
221 * Check the search string against the string and integer values.
224 switch (attr
->value_tag
)
226 case IPP_TAG_TEXTLANG
:
227 case IPP_TAG_NAMELANG
:
230 case IPP_TAG_KEYWORD
:
232 case IPP_TAG_MIMETYPE
:
233 for (i
= 0; !add
&& i
< attr
->num_values
; i
++)
234 if (cgiDoSearch(search
, attr
->values
[i
].string
.text
))
238 case IPP_TAG_INTEGER
:
239 for (i
= 0; !add
&& i
< attr
->num_values
; i
++)
241 char buf
[255]; /* Number buffer */
244 sprintf(buf
, "%d", attr
->values
[i
].integer
);
246 if (cgiDoSearch(search
, buf
))
259 cupsArrayAdd(objs
, first
);
266 * 'cgiMoveJobs()' - Move one or more jobs.
268 * At least one of dest or job_id must be non-zero/NULL.
272 cgiMoveJobs(http_t
*http
, /* I - Connection to server */
273 const char *dest
, /* I - Destination or NULL */
274 int job_id
) /* I - Job ID or 0 for all */
276 int i
; /* Looping var */
277 const char *user
; /* Username */
278 ipp_t
*request
, /* IPP request */
279 *response
; /* IPP response */
280 ipp_attribute_t
*attr
; /* Current attribute */
281 const char *name
; /* Destination name */
282 const char *job_printer_uri
; /* JOB_PRINTER_URI form variable */
283 char current_dest
[1024]; /* Current destination */
287 * See who is logged in...
290 if ((user
= getenv("REMOTE_USER")) == NULL
)
294 * See if the user has already selected a new destination...
297 if ((job_printer_uri
= cgiGetVariable("JOB_PRINTER_URI")) == NULL
)
300 * Make sure necessary form variables are set...
305 char temp
[255]; /* Temporary string */
308 sprintf(temp
, "%d", job_id
);
309 cgiSetVariable("JOB_ID", temp
);
313 cgiSetVariable("PRINTER_NAME", dest
);
316 * No new destination specified, show the user what the available
317 * printers/classes are...
323 * Get the current destination for job N...
326 char job_uri
[1024]; /* Job URI */
329 request
= ippNewRequest(IPP_GET_JOB_ATTRIBUTES
);
331 snprintf(job_uri
, sizeof(job_uri
), "ipp://localhost/jobs/%d", job_id
);
332 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "job-uri",
334 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
335 "requested-attributes", NULL
, "job-printer-uri");
337 if ((response
= cupsDoRequest(http
, request
, "/")) != NULL
)
339 if ((attr
= ippFindAttribute(response
, "job-printer-uri",
340 IPP_TAG_URI
)) != NULL
)
343 * Pull the name from the URI...
346 strlcpy(current_dest
, strrchr(attr
->values
[0].string
.text
, '/') + 1,
347 sizeof(current_dest
));
357 * Couldn't get the current destination...
360 cgiStartHTML(cgiText(_("Move Job")));
361 cgiShowIPPError(_("Unable to find destination for job!"));
368 * Get the list of available destinations...
371 request
= ippNewRequest(CUPS_GET_PRINTERS
);
373 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
374 "requested-attributes", NULL
, "printer-uri-supported");
376 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
377 "requesting-user-name", NULL
, user
);
379 if ((response
= cupsDoRequest(http
, request
, "/")) != NULL
)
381 for (i
= 0, attr
= ippFindAttribute(response
, "printer-uri-supported",
384 attr
= ippFindNextAttribute(response
, "printer-uri-supported",
388 * Pull the name from the URI...
391 name
= strrchr(attr
->values
[0].string
.text
, '/') + 1;
394 * If the name is not the same as the current destination, add it!
397 if (strcasecmp(name
, dest
))
399 cgiSetArray("JOB_PRINTER_URI", i
, attr
->values
[0].string
.text
);
400 cgiSetArray("JOB_PRINTER_NAME", i
, name
);
413 cgiStartHTML(cgiText(_("Move Job")));
415 cgiStartHTML(cgiText(_("Move All Jobs")));
417 cgiCopyTemplateLang("job-move.tmpl");
422 * Try moving the job or jobs...
425 char uri
[1024], /* Job/printer URI */
426 resource
[1024], /* Post resource */
427 refresh
[1024]; /* Refresh URL */
428 const char *job_printer_name
; /* New printer name */
431 request
= ippNewRequest(CUPS_MOVE_JOB
);
439 snprintf(resource
, sizeof(resource
), "/jobs/%d", job_id
);
441 snprintf(uri
, sizeof(uri
), "ipp://localhost/jobs/%d", job_id
);
442 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "job-uri",
448 * Move all active jobs on a destination...
451 snprintf(resource
, sizeof(resource
), "/%s/%s",
452 cgiGetVariable("SECTION"), dest
);
454 httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
,
455 "localhost", ippPort(), "/%s/%s",
456 cgiGetVariable("SECTION"), dest
);
457 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
461 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "job-printer-uri",
462 NULL
, job_printer_uri
);
464 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
465 "requesting-user-name", NULL
, user
);
467 ippDelete(cupsDoRequest(http
, request
, resource
));
470 * Show the results...
473 job_printer_name
= strrchr(job_printer_uri
, '/') + 1;
475 if (cupsLastError() <= IPP_OK_CONFLICT
)
477 const char *path
= strstr(job_printer_uri
, "/printers/");
479 path
= strstr(job_printer_uri
, "/classes/");
483 cgiFormEncode(uri
, path
, sizeof(uri
));
484 snprintf(refresh
, sizeof(refresh
), "2;URL=%s", uri
);
485 cgiSetVariable("refresh_page", refresh
);
490 cgiStartHTML(cgiText(_("Move Job")));
492 cgiStartHTML(cgiText(_("Move All Jobs")));
494 if (cupsLastError() > IPP_OK_CONFLICT
)
497 cgiShowIPPError(_("Unable to move job"));
499 cgiShowIPPError(_("Unable to move jobs"));
503 cgiSetVariable("JOB_PRINTER_NAME", job_printer_name
);
504 cgiCopyTemplateLang("job-moved.tmpl");
513 * 'cgiPrintTestPage()' - Print a test page.
517 cgiPrintTestPage(http_t
*http
, /* I - Connection to server */
518 const char *dest
) /* I - Destination printer/class */
520 ipp_t
*request
, /* IPP request */
521 *response
; /* IPP response */
522 char uri
[HTTP_MAX_URI
], /* Printer URI */
523 resource
[1024], /* POST resource path */
524 refresh
[1024], /* Refresh URL */
525 filename
[1024]; /* Test page filename */
526 const char *datadir
; /* CUPS_DATADIR env var */
527 const char *user
; /* Username */
531 * See who is logged in...
534 user
= getenv("REMOTE_USER");
537 * Locate the test page file...
540 if ((datadir
= getenv("CUPS_DATADIR")) == NULL
)
541 datadir
= CUPS_DATADIR
;
543 snprintf(filename
, sizeof(filename
), "%s/data/testprint.ps", datadir
);
546 * Point to the printer/class...
549 snprintf(resource
, sizeof(resource
), "/%s/%s", cgiGetVariable("SECTION"),
552 httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
,
553 "localhost", ippPort(), "/%s/%s", cgiGetVariable("SECTION"),
557 * Build an IPP_PRINT_JOB request, which requires the following
561 * attributes-natural-language
563 * requesting-user-name
567 request
= ippNewRequest(IPP_PRINT_JOB
);
569 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
573 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
574 "requesting-user-name", NULL
, user
);
576 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name",
579 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_MIMETYPE
, "document-format",
580 NULL
, "application/postscript");
583 * Do the request and get back a response...
586 if ((response
= cupsDoFileRequest(http
, request
, resource
,
589 cgiSetIPPVars(response
, NULL
, NULL
, NULL
, 0);
594 if (cupsLastError() <= IPP_OK_CONFLICT
)
597 * Automatically reload the printer status page...
600 cgiFormEncode(uri
, resource
, sizeof(uri
));
601 snprintf(refresh
, sizeof(refresh
), "2;URL=%s", uri
);
602 cgiSetVariable("refresh_page", refresh
);
604 else if (cupsLastError() == IPP_NOT_AUTHORIZED
)
606 puts("Status: 401\n");
610 cgiStartHTML(cgiText(_("Print Test Page")));
612 if (cupsLastError() > IPP_OK_CONFLICT
)
613 cgiShowIPPError(_("Unable to print test page:"));
616 cgiSetVariable("PRINTER_NAME", dest
);
618 cgiCopyTemplateLang("test-page.tmpl");
626 * 'cgiRewriteURL()' - Rewrite a printer URI into a web browser URL...
629 char * /* O - New URL */
630 cgiRewriteURL(const char *uri
, /* I - Current URI */
631 char *url
, /* O - New URL */
632 int urlsize
, /* I - Size of URL buffer */
633 const char *newresource
) /* I - Replacement resource */
635 char method
[HTTP_MAX_URI
],
636 userpass
[HTTP_MAX_URI
],
637 hostname
[HTTP_MAX_URI
],
638 rawresource
[HTTP_MAX_URI
],
639 resource
[HTTP_MAX_URI
],
640 /* URI components... */
641 *rawptr
, /* Pointer into rawresource */
642 *resptr
; /* Pointer into resource */
643 int port
; /* Port number */
644 static int ishttps
= -1; /* Using encryption? */
645 static const char *server
; /* Name of server */
646 static char servername
[1024];
647 /* Local server name */
648 static const char hexchars
[] = "0123456789ABCDEF";
649 /* Hexadecimal conversion characters */
653 * Check if we have been called before...
659 * No, initialize static vars for the conversion...
661 * First get the server name associated with the client interface as
662 * well as the locally configured hostname. We'll check *both* of
663 * these to see if the printer URL is local...
666 if ((server
= getenv("SERVER_NAME")) == NULL
)
669 httpGetHostname(NULL
, servername
, sizeof(servername
));
672 * Then flag whether we are using SSL on this connection...
675 ishttps
= getenv("HTTPS") != NULL
;
679 * Convert the URI to a URL...
682 httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, method
, sizeof(method
), userpass
,
683 sizeof(userpass
), hostname
, sizeof(hostname
), &port
,
684 rawresource
, sizeof(rawresource
));
686 if (!strcmp(method
, "ipp") ||
687 !strcmp(method
, "http") ||
688 !strcmp(method
, "https"))
693 * Force the specified resource name instead of the one in the URL...
696 strlcpy(resource
, newresource
, sizeof(resource
));
701 * Rewrite the resource string so it doesn't contain any
705 for (rawptr
= rawresource
, resptr
= resource
; *rawptr
; rawptr
++)
706 if ((*rawptr
& 128) || *rawptr
== '%' || *rawptr
== ' ' ||
707 *rawptr
== '#' || *rawptr
== '?' ||
708 *rawptr
== '.') /* For MSIE */
710 if (resptr
< (resource
+ sizeof(resource
) - 3))
713 *resptr
++ = hexchars
[(*rawptr
>> 4) & 15];
714 *resptr
++ = hexchars
[*rawptr
& 15];
717 else if (resptr
< (resource
+ sizeof(resource
) - 1))
724 * Map local access to a local URI...
727 if (!strcasecmp(hostname
, "localhost") ||
728 !strncasecmp(hostname
, "localhost.", 10) ||
729 !strcasecmp(hostname
, server
) ||
730 !strcasecmp(hostname
, servername
))
733 * Make URI relative to the current server...
736 strlcpy(url
, resource
, urlsize
);
741 * Rewrite URI with HTTP/HTTPS scheme...
745 snprintf(url
, urlsize
, "%s://%s@%s:%d%s",
746 ishttps
? "https" : "http",
747 userpass
, hostname
, port
, resource
);
749 snprintf(url
, urlsize
, "%s://%s:%d%s",
750 ishttps
? "https" : "http",
751 hostname
, port
, resource
);
755 strlcpy(url
, uri
, urlsize
);
762 * 'cgiSetIPPObjectVars()' - Set CGI variables from an IPP object.
765 ipp_attribute_t
* /* O - Next object */
767 ipp_attribute_t
*obj
, /* I - Response data to be copied... */
768 const char *prefix
, /* I - Prefix for name or NULL */
769 int element
) /* I - Parent element number */
771 ipp_attribute_t
*attr
; /* Attribute in response... */
772 int i
; /* Looping var */
773 char name
[1024], /* Name of attribute */
774 *nameptr
, /* Pointer into name */
775 value
[16384], /* Value(s) */
776 *valptr
; /* Pointer into value */
777 struct tm
*date
; /* Date information */
780 fprintf(stderr
, "DEBUG2: cgiSetIPPObjectVars(obj=%p, prefix=\"%s\", "
782 obj
, prefix
? prefix
: "(null)", element
);
785 * Set common CGI template variables...
789 cgiSetServerVersion();
792 * Loop through the attributes and set them for the template...
795 for (attr
= obj
; attr
&& attr
->group_tag
!= IPP_TAG_ZERO
; attr
= attr
->next
)
798 * Copy the attribute name, substituting "_" for "-"...
806 snprintf(name
, sizeof(name
), "%s.", prefix
);
807 nameptr
= name
+ strlen(name
);
812 for (i
= 0; attr
->name
[i
] && nameptr
< (name
+ sizeof(name
) - 1); i
++)
813 if (attr
->name
[i
] == '-')
816 *nameptr
++ = attr
->name
[i
];
821 * Add "job_printer_name" variable if we have a "job_printer_uri"
825 if (!strcmp(name
, "job_printer_uri"))
827 if ((valptr
= strrchr(attr
->values
[0].string
.text
, '/')) == NULL
)
832 cgiSetArray("job_printer_name", element
, valptr
);
836 * Localize event names in "notify_events" variable...
839 if (!strcmp(name
, "notify_events"))
841 size_t remaining
; /* Remaining bytes in buffer */
847 for (i
= 0; i
< attr
->num_values
; i
++)
849 if (valptr
>= (value
+ sizeof(value
) - 3))
858 remaining
= sizeof(value
) - (valptr
- value
);
860 if (!strcmp(attr
->values
[i
].string
.text
, "printer-stopped"))
861 strlcpy(valptr
, _("Printer Paused"), remaining
);
862 else if (!strcmp(attr
->values
[i
].string
.text
, "printer-added"))
863 strlcpy(valptr
, _("Printer Added"), remaining
);
864 else if (!strcmp(attr
->values
[i
].string
.text
, "printer-modified"))
865 strlcpy(valptr
, _("Printer Modified"), remaining
);
866 else if (!strcmp(attr
->values
[i
].string
.text
, "printer-deleted"))
867 strlcpy(valptr
, _("Printer Deleted"), remaining
);
868 else if (!strcmp(attr
->values
[i
].string
.text
, "job-created"))
869 strlcpy(valptr
, _("Job Created"), remaining
);
870 else if (!strcmp(attr
->values
[i
].string
.text
, "job-completed"))
871 strlcpy(valptr
, _("Job Completed"), remaining
);
872 else if (!strcmp(attr
->values
[i
].string
.text
, "job-stopped"))
873 strlcpy(valptr
, _("Job Stopped"), remaining
);
874 else if (!strcmp(attr
->values
[i
].string
.text
, "job-config-changed"))
875 strlcpy(valptr
, _("Job Options Changed"), remaining
);
876 else if (!strcmp(attr
->values
[i
].string
.text
, "server-restarted"))
877 strlcpy(valptr
, _("Server Restarted"), remaining
);
878 else if (!strcmp(attr
->values
[i
].string
.text
, "server-started"))
879 strlcpy(valptr
, _("Server Started"), remaining
);
880 else if (!strcmp(attr
->values
[i
].string
.text
, "server-stopped"))
881 strlcpy(valptr
, _("Server Stopped"), remaining
);
882 else if (!strcmp(attr
->values
[i
].string
.text
, "server-audit"))
883 strlcpy(valptr
, _("Server Security Auditing"), remaining
);
885 strlcpy(valptr
, attr
->values
[i
].string
.text
, remaining
);
887 valptr
+= strlen(valptr
);
890 cgiSetArray("notify_events", element
, value
);
895 * Add "notify_printer_name" variable if we have a "notify_printer_uri"
899 if (!strcmp(name
, "notify_printer_uri"))
901 if ((valptr
= strrchr(attr
->values
[0].string
.text
, '/')) == NULL
)
906 cgiSetArray("notify_printer_name", element
, valptr
);
910 * Add "notify_recipient_name" variable if we have a "notify_recipient_uri"
911 * attribute, and rewrite recipient URI...
914 if (!strcmp(name
, "notify_recipient_uri"))
916 char uri
[1024], /* New URI */
917 scheme
[32], /* Scheme portion of URI */
918 userpass
[256], /* Username/password portion of URI */
919 host
[1024], /* Hostname portion of URI */
920 resource
[1024], /* Resource portion of URI */
921 *options
; /* Options in URI */
922 int port
; /* Port number */
925 httpSeparateURI(HTTP_URI_CODING_ALL
, attr
->values
[0].string
.text
,
926 scheme
, sizeof(scheme
), userpass
, sizeof(userpass
),
927 host
, sizeof(host
), &port
, resource
, sizeof(resource
));
929 if (!strcmp(scheme
, "rss"))
932 * RSS notification...
935 if ((options
= strchr(resource
, '?')) != NULL
)
941 * Link to remote feed...
944 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "http",
945 userpass
, host
, port
, resource
);
946 strlcpy(name
, uri
, sizeof(name
));
951 * Link to local feed...
954 snprintf(uri
, sizeof(uri
), "/rss%s", resource
);
955 strlcpy(name
, resource
+ 1, sizeof(name
));
964 strlcpy(uri
, attr
->values
[0].string
.text
, sizeof(uri
));
965 strlcpy(name
, resource
, sizeof(name
));
968 cgiSetArray("notify_recipient_uri", element
, uri
);
969 cgiSetArray("notify_recipient_name", element
, name
);
974 * Add "admin_uri" variable if we have a "printer_uri_supported"
978 if (!strcmp(name
, "printer_uri_supported"))
980 cgiRewriteURL(attr
->values
[0].string
.text
, value
, sizeof(value
),
983 cgiSetArray("admin_uri", element
, value
);
990 value
[0] = '\0'; /* Initially an empty string */
991 valptr
= value
; /* Start at the beginning */
993 for (i
= 0; i
< attr
->num_values
; i
++)
996 strlcat(valptr
, ", ", sizeof(value
) - (valptr
- value
));
998 valptr
+= strlen(valptr
);
1000 switch (attr
->value_tag
)
1002 case IPP_TAG_INTEGER
:
1004 if (strncmp(name
, "time_at_", 8) == 0)
1006 time_t t
; /* Temporary time value */
1008 t
= (time_t)attr
->values
[i
].integer
;
1009 date
= localtime(&t
);
1011 strftime(valptr
, sizeof(value
) - (valptr
- value
), "%c", date
);
1014 snprintf(valptr
, sizeof(value
) - (valptr
- value
),
1015 "%d", attr
->values
[i
].integer
);
1018 case IPP_TAG_BOOLEAN
:
1019 snprintf(valptr
, sizeof(value
) - (valptr
- value
),
1020 "%d", attr
->values
[i
].boolean
);
1023 case IPP_TAG_NOVALUE
:
1024 strlcat(valptr
, "novalue", sizeof(value
) - (valptr
- value
));
1027 case IPP_TAG_RANGE
:
1028 snprintf(valptr
, sizeof(value
) - (valptr
- value
),
1029 "%d-%d", attr
->values
[i
].range
.lower
,
1030 attr
->values
[i
].range
.upper
);
1033 case IPP_TAG_RESOLUTION
:
1034 snprintf(valptr
, sizeof(value
) - (valptr
- value
),
1035 "%dx%d%s", attr
->values
[i
].resolution
.xres
,
1036 attr
->values
[i
].resolution
.yres
,
1037 attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
?
1042 if (strchr(attr
->values
[i
].string
.text
, ':') &&
1043 strcmp(name
, "device_uri"))
1049 if (!strcmp(name
, "member_uris"))
1051 char url
[1024]; /* URL for class member... */
1054 cgiRewriteURL(attr
->values
[i
].string
.text
, url
,
1057 snprintf(valptr
, sizeof(value
) - (valptr
- value
),
1058 "<A HREF=\"%s\">%s</A>", url
,
1059 strrchr(attr
->values
[i
].string
.text
, '/') + 1);
1062 cgiRewriteURL(attr
->values
[i
].string
.text
, valptr
,
1063 sizeof(value
) - (valptr
- value
), NULL
);
1067 case IPP_TAG_STRING
:
1070 case IPP_TAG_KEYWORD
:
1071 case IPP_TAG_CHARSET
:
1072 case IPP_TAG_LANGUAGE
:
1073 case IPP_TAG_MIMETYPE
:
1074 strlcat(valptr
, attr
->values
[i
].string
.text
,
1075 sizeof(value
) - (valptr
- value
));
1078 case IPP_TAG_BEGIN_COLLECTION
:
1079 snprintf(value
, sizeof(value
), "%s%d", name
, i
+ 1);
1080 cgiSetIPPVars(attr
->values
[i
].collection
, NULL
, NULL
, value
,
1085 break; /* anti-compiler-warning-code */
1090 * Add the element...
1093 if (attr
->value_tag
!= IPP_TAG_BEGIN_COLLECTION
)
1095 cgiSetArray(name
, element
, value
);
1097 fprintf(stderr
, "DEBUG2: %s[%d]=\"%s\"\n", name
, element
, value
);
1101 return (attr
? attr
->next
: NULL
);
1106 * 'cgiSetIPPVars()' - Set CGI variables from an IPP response.
1109 int /* O - Maximum number of elements */
1110 cgiSetIPPVars(ipp_t
*response
, /* I - Response data to be copied... */
1111 const char *filter_name
, /* I - Filter name */
1112 const char *filter_value
, /* I - Filter value */
1113 const char *prefix
, /* I - Prefix for name or NULL */
1114 int parent_el
) /* I - Parent element number */
1116 int element
; /* Element in CGI array */
1117 ipp_attribute_t
*attr
, /* Attribute in response... */
1118 *filter
; /* Filtering attribute */
1121 fprintf(stderr
, "DEBUG2: cgiSetIPPVars(response=%p, filter_name=\"%s\", "
1122 "filter_value=\"%s\", prefix=\"%s\", parent_el=%d)\n",
1123 response
, filter_name
? filter_name
: "(null)",
1124 filter_value
? filter_value
: "(null)",
1125 prefix
? prefix
: "(null)", parent_el
);
1128 * Set common CGI template variables...
1132 cgiSetServerVersion();
1135 * Loop through the attributes and set them for the template...
1138 attr
= response
->attrs
;
1141 while (attr
&& attr
->group_tag
== IPP_TAG_OPERATION
)
1144 for (element
= parent_el
; attr
; element
++)
1147 * Copy attributes to a separator...
1150 while (attr
&& attr
->group_tag
== IPP_TAG_ZERO
)
1159 filter
!= NULL
&& filter
->group_tag
!= IPP_TAG_ZERO
;
1160 filter
= filter
->next
)
1161 if (filter
->name
&& !strcmp(filter
->name
, filter_name
) &&
1162 (filter
->value_tag
== IPP_TAG_STRING
||
1163 (filter
->value_tag
>= IPP_TAG_TEXTLANG
&&
1164 filter
->value_tag
<= IPP_TAG_MIMETYPE
)) &&
1165 filter
->values
[0].string
.text
!= NULL
&&
1166 !strcasecmp(filter
->values
[0].string
.text
, filter_value
))
1170 return (element
+ 1);
1172 if (filter
->group_tag
== IPP_TAG_ZERO
)
1180 attr
= cgiSetIPPObjectVars(attr
, prefix
, element
);
1183 fprintf(stderr
, "DEBUG2: Returing %d from cgiSetIPPVars()...\n", element
);
1190 * 'cgiShowIPPError()' - Show the last IPP error message.
1192 * The caller must still call cgiStartHTML() and cgiEndHTML().
1196 cgiShowIPPError(const char *message
) /* I - Contextual message */
1198 cgiSetVariable("MESSAGE", cgiText(message
));
1199 cgiSetVariable("ERROR", cupsLastErrorString());
1200 cgiCopyTemplateLang("error.tmpl");
1205 * 'cgiShowJobs()' - Show print jobs.
1209 cgiShowJobs(http_t
*http
, /* I - Connection to server */
1210 const char *dest
) /* I - Destination name or NULL */
1212 int i
; /* Looping var */
1213 const char *which_jobs
; /* Which jobs to show */
1214 ipp_t
*request
, /* IPP request */
1215 *response
; /* IPP response */
1216 cups_array_t
*jobs
; /* Array of job objects */
1217 ipp_attribute_t
*job
; /* Job object */
1218 int ascending
, /* Order of jobs (0 = descending) */
1219 first
, /* First job to show */
1220 count
; /* Number of jobs */
1221 const char *var
; /* Form variable */
1222 void *search
; /* Search data */
1223 char url
[1024], /* Printer URI */
1224 val
[1024]; /* Form variable */
1228 * Build an IPP_GET_JOBS request, which requires the following
1231 * attributes-charset
1232 * attributes-natural-language
1236 request
= ippNewRequest(IPP_GET_JOBS
);
1240 httpAssembleURIf(HTTP_URI_CODING_ALL
, url
, sizeof(url
), "ipp", NULL
,
1241 "localhost", ippPort(), "/printers/%s", dest
);
1242 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1246 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "job-uri", NULL
,
1247 "ipp://localhost/jobs");
1249 if ((which_jobs
= cgiGetVariable("which_jobs")) != NULL
)
1250 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "which-jobs",
1253 cgiGetAttributes(request
, "jobs.tmpl");
1256 * Do the request and get back a response...
1259 if ((response
= cupsDoRequest(http
, request
, "/")) != NULL
)
1262 * Get a list of matching job objects.
1265 if ((var
= cgiGetVariable("QUERY")) != NULL
&&
1266 !cgiGetVariable("CLEAR"))
1267 search
= cgiCompileSearch(var
);
1271 jobs
= cgiGetIPPObjects(response
, search
);
1272 count
= cupsArrayCount(jobs
);
1275 cgiFreeSearch(search
);
1278 * Figure out which jobs to display...
1281 if ((var
= cgiGetVariable("FIRST")) != NULL
)
1287 first
= count
- CUPS_PAGE_MAX
;
1289 first
= (first
/ CUPS_PAGE_MAX
) * CUPS_PAGE_MAX
;
1294 sprintf(val
, "%d", count
);
1295 cgiSetVariable("TOTAL", val
);
1297 if ((var
= cgiGetVariable("ORDER")) != NULL
)
1298 ascending
= !strcasecmp(var
, "asc");
1301 ascending
= !which_jobs
|| !strcasecmp(which_jobs
, "not-completed");
1302 cgiSetVariable("ORDER", ascending
? "asc" : "dec");
1307 for (i
= 0, job
= (ipp_attribute_t
*)cupsArrayIndex(jobs
, first
);
1308 i
< CUPS_PAGE_MAX
&& job
;
1309 i
++, job
= (ipp_attribute_t
*)cupsArrayNext(jobs
))
1310 cgiSetIPPObjectVars(job
, NULL
, i
);
1314 for (i
= 0, job
= (ipp_attribute_t
*)cupsArrayIndex(jobs
, count
- first
- 1);
1315 i
< CUPS_PAGE_MAX
&& job
;
1316 i
++, job
= (ipp_attribute_t
*)cupsArrayPrev(jobs
))
1317 cgiSetIPPObjectVars(job
, NULL
, i
);
1321 * Save navigation URLs...
1325 snprintf(val
, sizeof(val
), "/%s/%s", cgiGetVariable("SECTION"), dest
);
1327 strlcpy(val
, "/jobs/", sizeof(val
));
1329 cgiSetVariable("THISURL", val
);
1333 sprintf(val
, "%d", first
- CUPS_PAGE_MAX
);
1334 cgiSetVariable("PREV", val
);
1337 if ((first
+ CUPS_PAGE_MAX
) < count
)
1339 sprintf(val
, "%d", first
+ CUPS_PAGE_MAX
);
1340 cgiSetVariable("NEXT", val
);
1344 * Then show everything...
1348 cgiSetVariable("SEARCH_DEST", dest
);
1350 cgiCopyTemplateLang("search.tmpl");
1352 cgiCopyTemplateLang("jobs-header.tmpl");
1355 cgiCopyTemplateLang("pager.tmpl");
1357 cgiCopyTemplateLang("jobs.tmpl");
1360 cgiCopyTemplateLang("pager.tmpl");
1362 cupsArrayDelete(jobs
);
1363 ippDelete(response
);
1369 * 'cgiText()' - Return localized text.
1372 const char * /* O - Localized message */
1373 cgiText(const char *message
) /* I - Message */
1375 static cups_lang_t
*language
= NULL
;
1380 language
= cupsLangDefault();
1382 return (_cupsLangString(language
, message
));
1387 * End of "$Id: ipp-var.c 7541 2008-05-05 21:22:58Z mike $".