diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 7e576c1cc4..1755642773 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -45,16 +45,16 @@ jobs: run: sudo apt-get install -y avahi-daemon cppcheck libavahi-client-dev libcups2-dev libcupsimage2-dev libgnutls28-dev libjpeg-dev libpam-dev libpng-dev libusb-1.0-0-dev zlib1g-dev - name: Initialize CodeQL - uses: github/codeql-action/init@v2 + uses: github/codeql-action/init@v3 with: languages: ${{ matrix.language }} config-file: ./.github/codeql.yml queries: +security-and-quality - name: Autobuild - uses: github/codeql-action/autobuild@v2 + uses: github/codeql-action/autobuild@v3 - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v2 + uses: github/codeql-action/analyze@v3 with: category: "/language:${{ matrix.language }}" diff --git a/CHANGES.md b/CHANGES.md index 04905ec42f..398d844620 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -4,42 +4,43 @@ CHANGES - OpenPrinting CUPS 2.5b1 - (TBA) Changes in CUPS v2.5b1 (TBA) ---------------------------- -- Added additional check on socket if `revents` from `poll()` returns POLLHUP - together with POLLIN or POLLOUT in `httpAddrConnect2()` (Issue #839) - Added `cupsDNSSD` APIs. - Added `cupsConcatString` and `cupsCopyString` string APIs. -- Added a new argument value for `lpstat` argument '-W' - `successful` - - to get successfully printed jobs (Issue #830) -- Added new API for form, JSON, JWT, IPP, raster +- Added new APIs for form, JSON, JWT, IPP, and raster setup. - Added OpenSSL support for `cupsHashData` (Issue #762) - Added warning if the device has to do IPP request for 'all,media-col-database' in separate requests (Issue #829) +- Added a new argument value for `lpstat` argument '-W' - `successful` - + to get successfully printed jobs (Issue #830) - Added driver filter to web interface (Issue #848) -- Building with TLS support is now required - CUPS supports OpenSSL, GNUTLS - and LibreSSL -- Updated `cupsArray` APIs. -- Fixed crash in `scan_ps()` if incoming argument is NULL (Issue #831) +- Updated CUPS to require TLS support - OpenSSL, GNUTLS and LibreSSL are + supported. +- Updated CUPS to require ZLIB. +- Updated CUPS to require support for `poll` API. +- Updated `cupsArray` APIs to support modern naming and types. +- Updated `cups_enum_dests()` timeout for listing available IPP printers (Issue #751) +- Updated `httpAddrConnect2()` to handle `POLLHUP` together with `POLLIN` or + `POLLOUT` (Issue #839) +- Fixed use-after-free in `cupsdAcceptClient()` when we log warning during error + handling (fixes CVE-2023-34241) +- Fixed hanging of `lpstat` on Solaris (Issue #156) - Fixed Digest authentication support (Issue #260) -- Fixed delays in lpd backend (Issue #741) - Fixed extensive looping in scheduler (Issue #604) -- Fixed hanging of `lpstat` on IBM AIX (Issue #773) -- Fixed hanging of `lpstat` on Solaris (Issue #156) -- Fixed memory leak when creating color profiles (Issue #814) -- Fixed memory leak when unloading a job (Issue #813) +- Fixed printing multiple files on specific printers (Issue #643) - Fixed segfault in `cupsGetNamedDest()` when trying to get default printer, but the default printer is not set (Issue #719) -- Fixed setting job state reasons for successful jobs (Issue #832) -- Fixed RFC 1179 port reserving behavior in LPD backend (Issue #743) -- Fixed printing multiple files on specific printers (Issue #643) -- Fixed printing to stderr if we can't open cups-files.conf (Issue #777) +- Fixed ready media support for iOS 17+ (Issue #738) +- Fixed delays in lpd backend (Issue #741) - Fixed purging job files via `cancel -x` (Issue #742) -- Fixed use-after-free in `cupsdAcceptClient()` when we log warning during error - handling (fixes CVE-2023-34241) +- Fixed RFC 1179 port reserving behavior in LPD backend (Issue #743) - Fixed a bug in the PPD command interpretation code (Issue #768) -- Raised `cups_enum_dests()` timeout for listing available IPP printers (Issue #751) -- Removed `HAVE_LIBZ` and `HAVE_POLL` defines, making CUPS to depend - on the functionality -- Removed hash support for SHA2-512-224 and SHA2-512-256 +- Fixed hanging of `lpstat` on IBM AIX (Issue #773) +- Fixed printing to stderr if we can't open cups-files.conf (Issue #777) +- Fixed memory leak when unloading a job (Issue #813) +- Fixed memory leak when creating color profiles (Issue #814) +- Fixed crash in `scan_ps()` if incoming argument is NULL (Issue #831) +- Fixed setting job state reasons for successful jobs (Issue #832) +- Removed hash support for SHA2-512-224 and SHA2-512-256. - Removed `mantohtml` script for generating html pages (use `https://www.msweet.org/mantohtml/`) - Removed SSPI and Security.framework support (CDSA) diff --git a/DEVELOPING.md b/DEVELOPING.md index b841d37fb9..9fac6ea4e2 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -8,10 +8,10 @@ contributing to the CUPS project. How To Contact The Developers ----------------------------- -The Linux Foundation's "printing-architecture" mailing list is the primary means -of asking questions and informally discussing issues and feature requests with -the OpenPrinting developers. To subscribe or see the mailing list archives, go -to . +The Linux "printing-architecture" mailing list is the primary means of asking +questions and informally discussing issues and feature requests with the +OpenPrinting developers. To subscribe or see the mailing list archives, go +to . Interfaces diff --git a/README.md b/README.md index 97dbe18bdb..a5be1493cd 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ for more information. > and iOS at . [1]: https://support.apple.com/en-us/HT201311 -[2]: https://www.pwg.org/ipp/everywhere.html +[2]: https://www.pwg.org/printers [3]: https://github.com/openprinting/cups-filters diff --git a/backend/Makefile b/backend/Makefile index d53e971d18..2074e4ce85 100644 --- a/backend/Makefile +++ b/backend/Makefile @@ -171,6 +171,13 @@ uninstall: -$(RMDIR) $(SERVERBIN) +# +# Run unit tests... (doesn't actually run these currently) +# + +test: unittests + + # # test1284 # diff --git a/cgi-bin/Makefile b/cgi-bin/Makefile index 5a1b4e5004..00ff4a5460 100644 --- a/cgi-bin/Makefile +++ b/cgi-bin/Makefile @@ -141,6 +141,16 @@ uninstall: -$(RMDIR) $(SERVERBIN)/cgi-bin +# +# Run unit tests... +# + +test: unittests + echo Testing CGI API... + ./testcgi + echo Testing help index API... + ./testhi + # # libcupscgi.a # @@ -211,8 +221,6 @@ testcgi: testcgi.o ../Makedefs libcupscgi.a ../cups/$(LIBCUPSSTATIC) $(LD_CC) $(ARCHFLAGS) $(ALL_LDFLAGS) -o $@ testcgi.o libcupscgi.a \ $(LINKCUPSSTATIC) $(CODE_SIGN) -s "$(CODE_SIGN_IDENTITY)" $@ - echo Testing CGI API... - ./testcgi # @@ -224,8 +232,6 @@ testhi: testhi.o ../Makedefs libcupscgi.a ../cups/$(LIBCUPSSTATIC) $(LD_CC) $(ARCHFLAGS) $(ALL_LDFLAGS) -o $@ testhi.o libcupscgi.a \ $(LINKCUPSSTATIC) $(CODE_SIGN) -s "$(CODE_SIGN_IDENTITY)" $@ - echo Testing help index API... - ./testhi # diff --git a/cups/cupspm.md b/cups/cupspm.md index d963d42a21..eb326920ce 100644 --- a/cups/cupspm.md +++ b/cups/cupspm.md @@ -71,25 +71,27 @@ to compile a simple program (shown below) in two common environments. The following simple program lists the available destinations: - #include - #include +```c +#include +#include - int print_dest(void *user_data, unsigned flags, cups_dest_t *dest) - { - if (dest->instance) - printf("%s/%s\n", dest->name, dest->instance); - else - puts(dest->name); +int print_dest(void *user_data, unsigned flags, cups_dest_t *dest) +{ + if (dest->instance) + printf("%s/%s\n", dest->name, dest->instance); + else + puts(dest->name); - return (1); - } + return (1); +} - int main(void) - { - cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, 0, 0, print_dest, NULL); +int main(void) +{ + cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, 0, 0, print_dest, NULL); - return (0); - } + return (0); +} +``` ### Compiling with Xcode @@ -113,11 +115,11 @@ From the command-line, create a file called `simple.c` using your favorite editor, copy the example to this file, and save. Then run the following command to compile it with GCC and run it: - gcc -o simple `cups-config --cflags` simple.c `cups-config --libs` + gcc -o simple `pkg-config --cflags cups` simple.c `pkg-config --libs cups` ./simple -The `cups-config` command provides the compiler flags (`cups-config --cflags`) -and libraries (`cups-config --libs`) needed for the local system. +The `pkg-config` command provides the compiler flags (`pkg-config --cflags cups`) +and libraries (`pkg-config --libs cups`) needed for the local system. # Working with Destinations @@ -136,12 +138,14 @@ the current network. ## Finding Available Destinations -The `cupsEnumDests` function finds all of the available destinations: +The [`cupsEnumDests`](@@) function finds all of the available destinations: - int - cupsEnumDests(unsigned flags, int msec, int *cancel, - cups_ptype_t type, cups_ptype_t mask, - cups_dest_cb_t cb, void *user_data) +```c +int +cupsEnumDests(unsigned flags, int msec, int *cancel, + cups_ptype_t type, cups_ptype_t mask, + cups_dest_cb_t cb, void *user_data) +``` The `flags` argument specifies enumeration options, which at present must be `CUPS_DEST_FLAGS_NONE`. @@ -187,9 +191,11 @@ can be used for filtering: The `cb` argument specifies a function to call for every destination that is found: - typedef int (*cups_dest_cb_t)(void *user_data, - unsigned flags, - cups_dest_t *dest); +```c +typedef int (*cups_dest_cb_t)(void *user_data, + unsigned flags, + cups_dest_t *dest); +``` The callback function receives a copy of the `user_data` argument along with a bitfield \(`flags`) and the destination that was found. The `flags` argument @@ -199,9 +205,10 @@ can have any of the following constant (bit) values set: - `CUPS_DEST_FLAGS_REMOVED`: The destination has gone away and should be removed from the list of destinations a user can select. - `CUPS_DEST_FLAGS_ERROR`: An error occurred. The reason for the error can be - found by calling the `cupsLastError` and/or `cupsLastErrorString` functions. + found by calling the [`cupsGetError`](@@) and/or [`cupsGetErrorString`](@@) + functions. -The callback function returns 0 to stop enumeration or 1 to continue. +The callback function returns `0` to stop enumeration or `1` to continue. > **Note:** > @@ -212,71 +219,73 @@ The callback function returns 0 to stop enumeration or 1 to continue. The following example shows how to use `cupsEnumDests` to get a filtered array of destinations: - typedef struct - { - int num_dests; - cups_dest_t *dests; - } my_user_data_t; - - int - my_dest_cb(my_user_data_t *user_data, unsigned flags, - cups_dest_t *dest) - { - if (flags & CUPS_DEST_FLAGS_REMOVED) - { - /* - * Remove destination from array... - */ - - user_data->num_dests = - cupsRemoveDest(dest->name, dest->instance, - user_data->num_dests, - &(user_data->dests)); - } - else - { - /* - * Add destination to array... - */ - - user_data->num_dests = - cupsCopyDest(dest, user_data->num_dests, - &(user_data->dests)); - } - - return (1); - } - - int - my_get_dests(cups_ptype_t type, cups_ptype_t mask, - cups_dest_t **dests) - { - my_user_data_t user_data = { 0, NULL }; - - if (!cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, type, - mask, (cups_dest_cb_t)my_dest_cb, - &user_data)) - { - /* - * An error occurred, free all of the destinations and - * return... - */ - - cupsFreeDests(user_data.num_dests, user_data.dests); - - *dests = NULL; - - return (0); - } - - /* - * Return the destination array... - */ - - *dests = user_data.dests; - - return (user_data.num_dests); - } +```c +typedef struct +{ + int num_dests; + cups_dest_t *dests; +} my_user_data_t; + +int +my_dest_cb(my_user_data_t *user_data, unsigned flags, + cups_dest_t *dest) +{ + if (flags & CUPS_DEST_FLAGS_REMOVED) + { + /* + * Remove destination from array... + */ + + user_data->num_dests = + cupsRemoveDest(dest->name, dest->instance, + user_data->num_dests, + &(user_data->dests)); + } + else + { + /* + * Add destination to array... + */ + + user_data->num_dests = + cupsCopyDest(dest, user_data->num_dests, + &(user_data->dests)); + } + + return (1); +} + +int +my_get_dests(cups_ptype_t type, cups_ptype_t mask, + cups_dest_t **dests) +{ + my_user_data_t user_data = { 0, NULL }; + + if (!cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, type, + mask, (cups_dest_cb_t)my_dest_cb, + &user_data)) + { + /* + * An error occurred, free all of the destinations and + * return... + */ + + cupsFreeDests(user_data.num_dests, user_data.dests); + + *dests = NULL; + + return (0); + } + + /* + * Return the destination array... + */ + + *dests = user_data.dests; + + return (user_data.num_dests); +} +``` ## Basic Destination Information @@ -309,21 +318,25 @@ destination attributes: - "printer-uri-supported": The URI associated with the destination; if not set, this destination was discovered but is not yet setup as a local printer. -Use the `cupsGetOption` function to retrieve the value. For example, the +Use the [`cupsGetOption`](@@) function to retrieve the value. For example, the following code gets the make and model of a destination: - const char *model = cupsGetOption("printer-make-and-model", - dest->num_options, - dest->options); +```c +const char *model = cupsGetOption("printer-make-and-model", + dest->num_options, + dest->options); +``` ## Detailed Destination Information -Once a destination has been chosen, the `cupsCopyDestInfo` function can be used -to gather detailed information about the destination: +Once a destination has been chosen, the [`cupsCopyDestInfo`](@@) function can be +used to gather detailed information about the destination: - cups_dinfo_t * - cupsCopyDestInfo(http_t *http, cups_dest_t *dest); +```c +cups_dinfo_t * +cupsCopyDestInfo(http_t *http, cups_dest_t *dest); +``` The `http` argument specifies a connection to the CUPS scheduler and is typically the constant `CUPS_HTTP_DEFAULT`. The `dest` argument specifies the @@ -337,14 +350,16 @@ to resolve those constraints. ### Getting Supported Options and Values -The `cupsCheckDestSupported` function can be used to test whether a particular -option or option and value is supported: +The [`cupsCheckDestSupported`](@@) function can be used to test whether a +particular option or option and value is supported: - int - cupsCheckDestSupported(http_t *http, cups_dest_t *dest, - cups_dinfo_t *info, - const char *option, - const char *value); +```c +int +cupsCheckDestSupported(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, + const char *option, + const char *value); +``` The `option` argument specifies the name of the option to check. The following constants can be used to check the various standard options: @@ -386,46 +401,57 @@ If the `value` argument is `NULL`, the `cupsCheckDestSupported` function returns whether the option is supported by the destination. Otherwise, the function returns whether the specified value of the option is supported. -The `cupsFindDestSupported` function returns the IPP attribute containing the -supported values for a given option: +The [`cupsFindDestSupported`](@@) function returns the IPP attribute containing +the supported values for a given option: - ipp_attribute_t * - cupsFindDestSupported(http_t *http, cups_dest_t *dest, - cups_dinfo_t *dinfo, - const char *option); +```c +ipp_attribute_t * +cupsFindDestSupported(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, + const char *option); +``` For example, the following code prints the supported finishing processes for a destination, if any, to the standard output: - cups_dinfo_t *info = cupsCopyDestInfo(CUPS_HTTP_DEFAULT, - dest); +```c +cups_dinfo_t *info = cupsCopyDestInfo(CUPS_HTTP_DEFAULT, + dest); - if (cupsCheckDestSupported(CUPS_HTTP_DEFAULT, dest, info, - CUPS_FINISHINGS, NULL)) - { - ipp_attribute_t *finishings = - cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, - CUPS_FINISHINGS); - int i, count = ippGetCount(finishings); - - puts("finishings supported:"); - for (i = 0; i < count; i ++) - printf(" %d\n", ippGetInteger(finishings, i)); - } - else - puts("finishings not supported."); +if (cupsCheckDestSupported(CUPS_HTTP_DEFAULT, dest, info, + CUPS_FINISHINGS, NULL)) +{ + ipp_attribute_t *finishings = + cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, + CUPS_FINISHINGS); + int i, count = ippGetCount(finishings); + + puts("finishings supported:"); + for (i = 0; i < count; i ++) + { + int val = ippGetInteger(finishings, i); + printf(" %d (%s)\n", val, + ippEnumString("finishings", val)); +} +else +{ + puts("finishings not supported."); +} +``` The "job-creation-attributes" option can be queried to get a list of supported options. For example, the following code prints the list of supported options to the standard output: - ipp_attribute_t *attrs = - cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, - "job-creation-attributes"); - int i, count = ippGetCount(attrs); +```c +ipp_attribute_t *attrs = + cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, + "job-creation-attributes"); +int i, count = ippGetCount(attrs); - for (i = 0; i < count; i ++) - puts(ippGetString(attrs, i, NULL)); +for (i = 0; i < count; i ++) + puts(ippGetString(attrs, i, NULL)); +``` ### Getting Default Values @@ -433,39 +459,43 @@ to the standard output: There are two sets of default values - user defaults that are available via the `num_options` and `options` members of the `cups_dest_t` structure, and destination defaults that available via the `cups_dinfo_t` structure and the -`cupsFindDestDefault` function which returns the IPP attribute containing the -default value(s) for a given option: - - ipp_attribute_t * - cupsFindDestDefault(http_t *http, cups_dest_t *dest, - cups_dinfo_t *dinfo, - const char *option); - -The user defaults from `cupsGetOption` should always take preference over the -destination defaults. For example, the following code prints the default +[`cupsFindDestDefault`](@@) function which returns the IPP attribute containing +the default value(s) for a given option: + +```c +ipp_attribute_t * +cupsFindDestDefault(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, + const char *option); +``` + +The user defaults from [`cupsGetOption`](@@) should always take preference over +the destination defaults. For example, the following code prints the default finishings value(s) to the standard output: - const char *def_value = - cupsGetOption(CUPS_FINISHINGS, dest->num_options, - dest->options); - ipp_attribute_t *def_attr = - cupsFindDestDefault(CUPS_HTTP_DEFAULT, dest, info, - CUPS_FINISHINGS); - - if (def_value != NULL) - { - printf("Default finishings: %s\n", def_value); - } - else - { - int i, count = ippGetCount(def_attr); - - printf("Default finishings: %d", - ippGetInteger(def_attr, 0)); - for (i = 1; i < count; i ++) - printf(",%d", ippGetInteger(def_attr, i)); - putchar('\n'); - } +```c +const char *def_value = + cupsGetOption(CUPS_FINISHINGS, dest->num_options, + dest->options); +ipp_attribute_t *def_attr = + cupsFindDestDefault(CUPS_HTTP_DEFAULT, dest, info, + CUPS_FINISHINGS); + +if (def_value != NULL) +{ + printf("Default finishings: %s\n", def_value); +} +else +{ + int i, count = ippGetCount(def_attr); + + printf("Default finishings: %d", + ippGetInteger(def_attr, 0)); + for (i = 1; i < count; i ++) + printf(",%d", ippGetInteger(def_attr, i)); + putchar('\n'); +} +``` ### Getting Ready (Loaded) Values @@ -478,66 +508,90 @@ Similarly, a printer may support hundreds of different sizes of media but only have a single size loaded at any given time - the ready values are limited to the media that is actually in the printer. -The `cupsFindDestReady` function finds the IPP attribute containing the ready -values for a given option: +The [`cupsFindDestReady`](@@) function finds the IPP attribute containing the +ready values for a given option: - ipp_attribute_t * - cupsFindDestReady(http_t *http, cups_dest_t *dest, - cups_dinfo_t *dinfo, const char *option); +```c +ipp_attribute_t * +cupsFindDestReady(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, const char *option); +``` For example, the following code lists the ready finishing processes: - ipp_attribute_t *ready_finishings = - cupsFindDestReady(CUPS_HTTP_DEFAULT, dest, info, - CUPS_FINISHINGS); - - if (ready_finishings != NULL) - { - int i, count = ippGetCount(ready_finishings); - - puts("finishings ready:"); - for (i = 0; i < count; i ++) - printf(" %d\n", ippGetInteger(ready_finishings, i)); - } - else - puts("no finishings are ready."); - - -### Media Size Options - -CUPS provides functions for querying the dimensions and margins for each of the -supported media size options. The `cups_size_t` structure is used to describe a -media size: - - typedef struct cups_size_s - { - char media[128]; - int width, length; - int bottom, left, right, top; - } cups_size_t; +```c +ipp_attribute_t *ready_finishings = + cupsFindDestReady(CUPS_HTTP_DEFAULT, dest, info, + CUPS_FINISHINGS); + +if (ready_finishings != NULL) +{ + int i, count = ippGetCount(ready_finishings); + + puts("finishings ready:"); + for (i = 0; i < count; i ++) + { + int val = ippGetInteger(ready_finishings, i); + printf(" %d (%s)\n", val, + ippEnumString("finishings", val)); +} +else +{ + puts("no finishings are ready."); +} +``` + + +### Media Options + +CUPS provides functions for querying the dimensions, margins, color, source +(tray/roll), and type for each of the supported media size options. The +`cups_media_t` structure is used to describe media: + +```c +typedef struct cups_media_s +{ + char media[128]; + char color[128]; + char source[128]; + char type[128]; + int width, length; + int bottom, left, right, top; +} cups_media_t; +``` + +The "media" member specifies a PWG self-describing media size name such as +"na\_letter\_8.5x11in", "iso\_a4\_210x297mm", etc. The "color" member specifies +a PWG media color name such as "white", "blue", etc. The "source" member +specifies a standard keyword for the paper tray or roll such as "tray-1", +"manual", "by-pass-tray" (multi-purpose tray), etc. The "type" member specifies +a PWG media type name such as "stationery" (plain paper), "photographic", +"envelope", "transparency", etc. The `width` and `length` members specify the dimensions of the media in hundredths of millimeters (1/2540th of an inch). The `bottom`, `left`, `right`, and `top` members specify the margins of the printable area, also in hundredths of millimeters. -The `cupsGetDestMediaByName` and `cupsGetDestMediaBySize` functions lookup the -media size information using a standard media size name or dimensions in -hundredths of millimeters: +The [`cupsGetDestMediaByName2`](@@) and [`cupsGetDestMediaBySize2`](@@) +functions lookup the media information using a standard media size name or +dimensions in hundredths of millimeters: - int - cupsGetDestMediaByName(http_t *http, cups_dest_t *dest, - cups_dinfo_t *dinfo, - const char *media, - unsigned flags, cups_size_t *size); +```c +bool +cupsGetDestMediaByName2(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, + const char *name, + unsigned flags, cups_media_t *media); - int - cupsGetDestMediaBySize(http_t *http, cups_dest_t *dest, - cups_dinfo_t *dinfo, - int width, int length, - unsigned flags, cups_size_t *size); +bool +cupsGetDestMediaBySize2(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, + int width, int length, + unsigned flags, cups_media_t *media); +``` -The `media`, `width`, and `length` arguments specify the size to lookup. The +The `name`, `width`, and `length` arguments specify the size to lookup. The `flags` argument specifies a bitfield controlling various lookup options: - `CUPS_MEDIA_FLAGS_DEFAULT`: Find the closest size supported by the printer. @@ -549,104 +603,150 @@ The `media`, `width`, and `length` arguments specify the size to lookup. The "ready" media. If a matching size is found for the destination, the size information is stored -in the structure pointed to by the `size` argument and 1 is returned. Otherwise -0 is returned. +in the structure pointed to by the `media` argument and `true` is returned. +Otherwise `false` is returned. For example, the following code prints the margins for two-sided printing on US Letter media: - cups_size_t size; - - if (cupsGetDestMediaByName(CUPS_HTTP_DEFAULT, dest, info, - CUPS_MEDIA_LETTER, - CUPS_MEDIA_FLAGS_DUPLEX, &size)) - { - puts("Margins for duplex US Letter:"); - printf(" Bottom: %.2fin\n", size.bottom / 2540.0); - printf(" Left: %.2fin\n", size.left / 2540.0); - printf(" Right: %.2fin\n", size.right / 2540.0); - printf(" Top: %.2fin\n", size.top / 2540.0); - } - else - puts("Margins for duplex US Letter are not available."); +```c +cups_media_t media: + +if (cupsGetDestMediaByName2(CUPS_HTTP_DEFAULT, dest, info, + CUPS_MEDIA_LETTER, + CUPS_MEDIA_FLAGS_DUPLEX, &size)) +{ + puts("Margins for duplex US Letter:"); + printf(" Bottom: %.2fin\n", media.bottom / 2540.0); + printf(" Left: %.2fin\n", media.left / 2540.0); + printf(" Right: %.2fin\n", media.right / 2540.0); + printf(" Top: %.2fin\n", media.top / 2540.0); +} +else +{ + puts("Margins for duplex US Letter are not available."); +} +``` You can also enumerate all of the sizes that match a given `flags` value using -the `cupsGetDestMediaByIndex` and `cupsGetDestMediaCount` functions: +the [`cupsGetDestMediaByIndex2`](@@) and [`cupsGetDestMediaCount`](@@) +functions: - int - cupsGetDestMediaByIndex(http_t *http, cups_dest_t *dest, - cups_dinfo_t *dinfo, int n, - unsigned flags, cups_size_t *size); +```c +bool +cupsGetDestMediaByIndex2(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, size_t n, + unsigned flags, cups_media_t *media); - int - cupsGetDestMediaCount(http_t *http, cups_dest_t *dest, - cups_dinfo_t *dinfo, unsigned flags); +int +cupsGetDestMediaCount(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, unsigned flags); +``` For example, the following code prints the list of ready media and corresponding margins: - cups_size_t size; - int i; - int count = cupsGetDestMediaCount(CUPS_HTTP_DEFAULT, - dest, info, - CUPS_MEDIA_FLAGS_READY); - - for (i = 0; i < count; i ++) - { - if (cupsGetDestMediaByIndex(CUPS_HTTP_DEFAULT, dest, info, - i, CUPS_MEDIA_FLAGS_READY, - &size)) - { - printf("%s:\n", size.name); - printf(" Width: %.2fin\n", size.width / 2540.0); - printf(" Length: %.2fin\n", size.length / 2540.0); - printf(" Bottom: %.2fin\n", size.bottom / 2540.0); - printf(" Left: %.2fin\n", size.left / 2540.0); - printf(" Right: %.2fin\n", size.right / 2540.0); - printf(" Top: %.2fin\n", size.top / 2540.0); - } - } - -Finally, the `cupsGetDestMediaDefault` function returns the default media size: - - int - cupsGetDestMediaDefault(http_t *http, cups_dest_t *dest, - cups_dinfo_t *dinfo, unsigned flags, - cups_size_t *size); +```c +cups_media_t media; +size_t i; +size_t count = (size_t)cupsGetDestMediaCount(CUPS_HTTP_DEFAULT, + dest, info, + CUPS_MEDIA_FLAGS_READY); + +for (i = 0; i < count; i ++) +{ + if (cupsGetDestMediaByIndex2(CUPS_HTTP_DEFAULT, dest, info, + i, CUPS_MEDIA_FLAGS_READY, + &media)) + { + printf("%s:\n", media.name); + printf(" Width: %.2fin\n", media.width / 2540.0); + printf(" Length: %.2fin\n", media.length / 2540.0); + printf(" Bottom: %.2fin\n", media.bottom / 2540.0); + printf(" Left: %.2fin\n", media.left / 2540.0); + printf(" Right: %.2fin\n", media.right / 2540.0); + printf(" Top: %.2fin\n", media.top / 2540.0); + } +} +``` + +Finally, the [`cupsGetDestMediaDefault2`](@@) function returns the default +media: + +```c +int +cupsGetDestMediaDefault2(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, unsigned flags, + cups_media_t *media); +``` ### Localizing Options and Values CUPS provides three functions to get localized, human-readable strings in the -user's current locale for options and values: `cupsLocalizeDestMedia`, -`cupsLocalizeDestOption`, and `cupsLocalizeDestValue`: - - const char * - cupsLocalizeDestMedia(http_t *http, cups_dest_t *dest, - cups_dinfo_t *info, unsigned flags, - cups_size_t *size); +user's current locale for options and values: [`cupsLocalizeDestMedia2`](@@), +[`cupsLocalizeDestOption`](@@), and [`cupsLocalizeDestValue`](@@): + +```c +const char * +cupsLocalizeDestMedia2(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, unsigned flags, + cups_media_t *media); + +const char * +cupsLocalizeDestOption(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, + const char *option); + +const char * +cupsLocalizeDestValue(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, + const char *option, const char *value); +``` - const char * - cupsLocalizeDestOption(http_t *http, cups_dest_t *dest, - cups_dinfo_t *info, - const char *option); - - const char * - cupsLocalizeDestValue(http_t *http, cups_dest_t *dest, - cups_dinfo_t *info, - const char *option, const char *value); +> **Note:** +> +> These functions require a valid `http_t` connection to work. Use the +> [`cupsConnectDest`](@@) function to connect to the destination for its +> localization information. + +For example, the following code will list the localized media names for a +destination: + +```c +char resource[256]; +http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_NONE, + /*msec*/30000, /*cancel*/NULL, + resource, sizeof(resource), + /*dest_cb*/NULL, /*user_data*/NULL); + +size_t i; +size_t count = (size_t)cupsGetDestMediaCount(http, dest, info, + CUPS_MEDIA_FLAGS_DEFAULT); +cups_media_t media; +for (i = 0; i < count; i ++) +{ + if (cupsGetDestMediaByIndex2(http, dest, info, i, + CUPS_MEDIA_FLAGS_DEFAULT, &media)) + printf("%s: %s\n", media.name, + cupsLocalizeDestMedia2(http, dest, info, + CUPS_MEDIA_FLAGS_DEFAULT, &media)); +} +``` ## Submitting a Print Job Once you are ready to submit a print job, you create a job using the -`cupsCreateDestJob` function: +[`cupsCreateDestJob`](@@) function: - ipp_status_t - cupsCreateDestJob(http_t *http, cups_dest_t *dest, - cups_dinfo_t *info, int *job_id, - const char *title, int num_options, - cups_option_t *options); +```c +ipp_status_t +cupsCreateDestJob(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, int *job_id, + const char *title, int num_options, + cups_option_t *options); +``` The `title` argument specifies a name for the print job such as "My Document". The `num_options` and `options` arguments specify the options for the print @@ -659,54 +759,58 @@ error status is returned. For example, the following code creates a new job that will print 42 copies of a two-sided US Letter document: - int job_id = 0; - int num_options = 0; - cups_option_t *options = NULL; - - num_options = cupsAddOption(CUPS_COPIES, "42", - num_options, &options); - num_options = cupsAddOption(CUPS_MEDIA, CUPS_MEDIA_LETTER, - num_options, &options); - num_options = cupsAddOption(CUPS_SIDES, - CUPS_SIDES_TWO_SIDED_PORTRAIT, - num_options, &options); - - if (cupsCreateDestJob(CUPS_HTTP_DEFAULT, dest, info, - &job_id, "My Document", num_options, - options) == IPP_STATUS_OK) - printf("Created job: %d\n", job_id); - else - printf("Unable to create job: %s\n", - cupsLastErrorString()); +```c +int job_id = 0; +int num_options = 0; +cups_option_t *options = NULL; + +num_options = cupsAddOption(CUPS_COPIES, "42", + num_options, &options); +num_options = cupsAddOption(CUPS_MEDIA, CUPS_MEDIA_LETTER, + num_options, &options); +num_options = cupsAddOption(CUPS_SIDES, + CUPS_SIDES_TWO_SIDED_PORTRAIT, + num_options, &options); + +if (cupsCreateDestJob(CUPS_HTTP_DEFAULT, dest, info, + &job_id, "My Document", num_options, + options) == IPP_STATUS_OK) + printf("Created job: %d\n", job_id); +else + printf("Unable to create job: %s\n", + cupsGetErrorString()); +``` Once the job is created, you submit documents for the job using the -`cupsStartDestDocument`, `cupsWriteRequestData`, and `cupsFinishDestDocument` -functions: - - http_status_t - cupsStartDestDocument(http_t *http, cups_dest_t *dest, - cups_dinfo_t *info, int job_id, - const char *docname, - const char *format, - int num_options, - cups_option_t *options, - int last_document); - - http_status_t - cupsWriteRequestData(http_t *http, const char *buffer, - size_t length); - - ipp_status_t - cupsFinishDestDocument(http_t *http, cups_dest_t *dest, - cups_dinfo_t *info); +[`cupsStartDestDocument`](@@), [`cupsWriteRequestData`](@@), and +[`cupsFinishDestDocument`](@@) functions: + +```c +http_status_t +cupsStartDestDocument(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, int job_id, + const char *docname, + const char *format, + int num_options, + cups_option_t *options, + int last_document); + +http_status_t +cupsWriteRequestData(http_t *http, const char *buffer, + size_t length); + +ipp_status_t +cupsFinishDestDocument(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info); +``` The `docname` argument specifies the name of the document, typically the original filename. The `format` argument specifies the MIME media type of the document, including the following constants: +- `CUPS_FORMAT_AUTO`: "application/octet-stream" - `CUPS_FORMAT_JPEG`: "image/jpeg" - `CUPS_FORMAT_PDF`: "application/pdf" -- `CUPS_FORMAT_POSTSCRIPT`: "application/postscript" - `CUPS_FORMAT_TEXT`: "text/plain" The `num_options` and `options` arguments specify per-document print options, @@ -716,28 +820,32 @@ whether this is the last document in the job. For example, the following code submits a PDF file to the job that was just created: - FILE *fp = fopen("filename.pdf", "rb"); - size_t bytes; - char buffer[65536]; - - if (cupsStartDestDocument(CUPS_HTTP_DEFAULT, dest, info, - job_id, "filename.pdf", 0, NULL, - 1) == HTTP_STATUS_CONTINUE) - { - while ((bytes = fread(buffer, 1, sizeof(buffer), fp)) > 0) - if (cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer, - bytes) != HTTP_STATUS_CONTINUE) - break; - - if (cupsFinishDestDocument(CUPS_HTTP_DEFAULT, dest, - info) == IPP_STATUS_OK) - puts("Document send succeeded."); - else - printf("Document send failed: %s\n", - cupsLastErrorString()); - } - - fclose(fp); +```c +FILE *fp = fopen("filename.pdf", "rb"); +size_t bytes; +char buffer[65536]; + +if (cupsStartDestDocument(CUPS_HTTP_DEFAULT, dest, info, + job_id, "filename.pdf", 0, NULL, + 1) == HTTP_STATUS_CONTINUE) +{ + while ((bytes = fread(buffer, 1, sizeof(buffer), fp)) > 0) + { + if (cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer, + bytes) != HTTP_STATUS_CONTINUE) + break; + } + + if (cupsFinishDestDocument(CUPS_HTTP_DEFAULT, dest, + info) == IPP_STATUS_OK) + puts("Document send succeeded."); + else + printf("Document send failed: %s\n", + cupsGetErrorString()); +} + +fclose(fp); +``` # Sending IPP Requests @@ -750,14 +858,16 @@ to send print jobs. ## Connecting to the Scheduler or Printer The connection to the scheduler or printer is represented by the HTTP connection -type `http_t`. The `cupsConnectDest` function connects to the scheduler or -printer associated with the destination: +type `http_t`. The [`cupsConnectDest`](@@) function connects to the scheduler +or printer associated with the destination: - http_t * - cupsConnectDest(cups_dest_t *dest, unsigned flags, int msec, - int *cancel, char *resource, - size_t resourcesize, cups_dest_cb_t cb, - void *user_data); +```c +http_t * +cupsConnectDest(cups_dest_t *dest, unsigned flags, int msec, + int *cancel, char *resource, + size_t resourcesize, cups_dest_cb_t cb, + void *user_data); +``` The `dest` argument specifies the destination to connect to. @@ -777,8 +887,8 @@ The `resource` and `resourcesize` arguments specify the address and size of a character string array to hold the path to use when sending an IPP request. The `cb` and `user_data` arguments specify a destination callback function that -returns 1 to continue connecting or 0 to stop. The destination callback work -the same way as the one used for the `cupsEnumDests` function. +returns 1 to continue connecting or 0 to stop. The destination callback works +the same way as the one used for the [`cupsEnumDests`](@@) function. On success, a HTTP connection is returned that can be used to send IPP requests and get IPP responses. @@ -786,10 +896,13 @@ and get IPP responses. For example, the following code connects to the printer associated with a destination with a 30 second timeout: - char resource[256]; - http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_DEVICE, - 30000, NULL, resource, - sizeof(resource), NULL, NULL); +```c +char resource[256]; +http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_DEVICE, + 30000, /*cancel*/NULL, resource, + sizeof(resource), + /*cb*/NULL, /*user_data*/NULL); +``` ## Creating an IPP Request @@ -801,13 +914,17 @@ IPP request includes an operation code (`IPP_OP_CREATE_JOB`, The `ippNewRequest` function creates a new IPP request: - ipp_t * - ippNewRequest(ipp_op_t op); +```c +ipp_t * +ippNewRequest(ipp_op_t op); +``` The `op` argument specifies the IPP operation code for the request. For example, the following code creates an IPP Get-Printer-Attributes request: - ipp_t *request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES); +```c +ipp_t *request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES); +``` The request identifier is automatically set to a unique value for the current process. @@ -820,19 +937,21 @@ add the target attribute(s). For example, the following code adds the "printer-uri" attribute to the IPP Get-Printer-Attributes request to specify which printer is being queried: - const char *printer_uri = cupsGetOption("device-uri", - dest->num_options, - dest->options); +```c +const char *printer_uri = cupsGetOption("device-uri", + dest->num_options, + dest->options); - ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, - "printer-uri", NULL, printer_uri); +ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, + "printer-uri", /*language*/NULL, printer_uri); +```c > **Note:** > > If we wanted to query the scheduler instead of the device, we would look > up the "printer-uri-supported" option instead of the "device-uri" value. -The `ippAddString` function adds the "printer-uri" attribute to the IPP +The [`ippAddString`](@@) function adds the "printer-uri" attribute to the IPP request. The `IPP_TAG_OPERATION` argument specifies that the attribute is part of the operation. The `IPP_TAG_URI` argument specifies that the value is a Universal Resource Identifier (URI) string. The `NULL` argument specifies there @@ -843,82 +962,95 @@ The IPP Get-Printer-Attributes request also supports an IPP attribute called "requested-attributes" that lists the attributes and values you are interested in. For example, the following code requests the printer state attributes: - static const char * const requested_attributes[] = - { - "printer-state", - "printer-state-message", - "printer-state-reasons" - }; - - ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD, - "requested-attributes", 3, NULL, - requested_attributes); - -The `ippAddStrings` function adds an attribute with one or more strings, in this -case three. The `IPP_TAG_KEYWORD` argument specifies that the strings are -keyword values, which are used for attribute names. All strings use the same -language (`NULL`), and the attribute will contain the three strings in the -array `requested_attributes`. +```c +static const char * const requested_attributes[] = +{ + "printer-state", + "printer-state-message", + "printer-state-reasons" +}; + +ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD, + "requested-attributes", 3, /*language*/NULL, + requested_attributes); +``` + +The [`ippAddStrings`](@@) function adds an attribute with one or more strings, +in this case three. The `IPP_TAG_KEYWORD` argument specifies that the strings +are keyword values, which are used for attribute names. All strings use the +same language (`NULL` for none), and the attribute will contain the three +strings in the array `requested_attributes`. CUPS provides many functions to adding attributes of different types: -- `ippAddBoolean` adds a boolean (`IPP_TAG_BOOLEAN`) attribute with one value. -- `ippAddInteger` adds an enum (`IPP_TAG_ENUM`) or integer (`IPP_TAG_INTEGER`) - attribute with one value. -- `ippAddIntegers` adds an enum or integer attribute with one or more values. -- `ippAddOctetString` adds an octetString attribute with one value. -- `ippAddOutOfBand` adds a admin-defined (`IPP_TAG_ADMINDEFINE`), default +- [`ippAddBoolean`](@@) adds a boolean (`IPP_TAG_BOOLEAN`) attribute with one + value. +- [`ippAddInteger`](@@) adds an enum (`IPP_TAG_ENUM`) or integer + (`IPP_TAG_INTEGER`) attribute with one value. +- [`ippAddIntegers`](@@) adds an enum or integer attribute with one or more + values. +- [`ippAddOctetString`](@@) adds an octetString attribute with one value. +- [`ippAddOutOfBand`](@@) adds a admin-defined (`IPP_TAG_ADMINDEFINE`), default (`IPP_TAG_DEFAULT`), delete-attribute (`IPP_TAG_DELETEATTR`), no-value (`IPP_TAG_NOVALUE`), not-settable (`IPP_TAG_NOTSETTABLE`), unknown (`IPP_TAG_UNKNOWN`), or unsupported (`IPP_TAG_UNSUPPORTED_VALUE`) out-of-band attribute. -- `ippAddRange` adds a rangeOfInteger attribute with one range. -- `ippAddRanges` adds a rangeOfInteger attribute with one or more ranges. -- `ippAddResolution` adds a resolution attribute with one resolution. -- `ippAddResolutions` adds a resolution attribute with one or more resolutions. -- `ippAddString` adds a charset (`IPP_TAG_CHARSET`), keyword (`IPP_TAG_KEYWORD`), - mimeMediaType (`IPP_TAG_MIMETYPE`), name (`IPP_TAG_NAME` and - `IPP_TAG_NAMELANG`), naturalLanguage (`IPP_TAG_NATURAL_LANGUAGE`), text +- [`ippAddRange`](@@) adds a rangeOfInteger attribute with one range. +- [`ippAddRanges`](@@) adds a rangeOfInteger attribute with one or more ranges. +- [`ippAddResolution`](@@) adds a resolution attribute with one resolution. +- [`ippAddResolutions`](@@) adds a resolution attribute with one or more + resolutions. +- [`ippAddString`](@@) adds a charset (`IPP_TAG_CHARSET`), keyword + (`IPP_TAG_KEYWORD`), mimeMediaType (`IPP_TAG_MIMETYPE`), name (`IPP_TAG_NAME` + and `IPP_TAG_NAMELANG`), naturalLanguage (`IPP_TAG_NATURAL_LANGUAGE`), text (`IPP_TAG_TEXT` and `IPP_TAG_TEXTLANG`), uri (`IPP_TAG_URI`), or uriScheme (`IPP_TAG_URISCHEME`) attribute with one value. -- `ippAddStrings` adds a charset, keyword, mimeMediaType, name, naturalLanguage, - text, uri, or uriScheme attribute with one or more values. +- [`ippAddStrings`](@@) adds a charset, keyword, mimeMediaType, name, + naturalLanguage, text, uri, or uriScheme attribute with one or more values. ## Sending the IPP Request Once you have created the IPP request, you can send it using the -`cupsDoRequest` function. For example, the following code sends the IPP +[`cupsDoRequest`](@@) function. For example, the following code sends the IPP Get-Printer-Attributes request to the destination and saves the response: - ipp_t *response = cupsDoRequest(http, request, resource); +```c +ipp_t *response = cupsDoRequest(http, request, resource); +``` -For requests like Send-Document that include a file, the `cupsDoFileRequest` -function should be used: +For requests like Send-Document that include a file, the +[`cupsDoFileRequest`](@@) function should be used: - ipp_t *response = cupsDoFileRequest(http, request, resource, - filename); +```c +ipp_t *response = cupsDoFileRequest(http, request, resource, + filename); +``` Both `cupsDoRequest` and `cupsDoFileRequest` free the IPP request. If a valid IPP response is received, it is stored in a new IPP message (`ipp_t`) and returned to the caller. Otherwise `NULL` is returned. -The status from the most recent request can be queried using the `cupsLastError` -function, for example: +The status from the most recent request can be queried using the +[`cupsGetError`](@@) function, for example: - if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST) - { - /* request failed */ - } +```c +if (cupsGetError() >= IPP_STATUS_ERROR_BAD_REQUEST) +{ + /* request failed */ +} +``` -A human-readable error message is also available using the `cupsLastErrorString` +A human-readable error message is also available using the `cupsGetErrorString` function: - if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST) - { - /* request failed */ - printf("Request failed: %s\n", cupsLastErrorString()); - } +```c +if (cupsGetError() >= IPP_STATUS_ERROR_BAD_REQUEST) +{ + /* request failed */ + printf("Request failed: %s\n", cupsGetErrorString()); +} +``` ## Processing the IPP Response @@ -931,70 +1063,78 @@ identifier from the request. For example, the following code finds the printer state attributes and prints their values: - ipp_attribute_t *attr; - - if ((attr = ippFindAttribute(response, "printer-state", - IPP_TAG_ENUM)) != NULL) - { - printf("printer-state=%s\n", - ippEnumString("printer-state", ippGetInteger(attr, 0))); - } - else - puts("printer-state=unknown"); - - if ((attr = ippFindAttribute(response, "printer-state-message", - IPP_TAG_TEXT)) != NULL) - { - printf("printer-state-message=\"%s\"\n", - ippGetString(attr, 0, NULL))); - } - - if ((attr = ippFindAttribute(response, "printer-state-reasons", - IPP_TAG_KEYWORD)) != NULL) - { - int i, count = ippGetCount(attr); - - puts("printer-state-reasons="); - for (i = 0; i < count; i ++) - printf(" %s\n", ippGetString(attr, i, NULL))); - } - -The `ippGetCount` function returns the number of values in an attribute. - -The `ippGetInteger` and `ippGetString` functions return a single integer or -string value from an attribute. - -The `ippEnumString` function converts a enum value to its keyword (string) +```c +ipp_attribute_t *attr; + +if ((attr = ippFindAttribute(response, "printer-state", + IPP_TAG_ENUM)) != NULL) +{ + printf("printer-state=%s\n", + ippEnumString("printer-state", ippGetInteger(attr, 0))); +} +else + puts("printer-state=unknown"); + +if ((attr = ippFindAttribute(response, "printer-state-message", + IPP_TAG_TEXT)) != NULL) +{ + printf("printer-state-message=\"%s\"\n", + ippGetString(attr, 0, NULL))); +} + +if ((attr = ippFindAttribute(response, "printer-state-reasons", + IPP_TAG_KEYWORD)) != NULL) +{ + int i, count = ippGetCount(attr); + + puts("printer-state-reasons="); + for (i = 0; i < count; i ++) + printf(" %s\n", ippGetString(attr, i, NULL))); +} +``` + +The [`ippGetCount`](@@) function returns the number of values in an attribute. + +The [`ippGetInteger`](@@) and [`ippGetString`](@@) functions return a single +integer or string value from an attribute. + +The [`ippEnumString`](@@) function converts a enum value to its keyword (string) equivalent. -Once you are done using the IPP response message, free it using the `ippDelete` -function: +Once you are done using the IPP response message, free it using the +[`ippDelete`](@@) function: - ippDelete(response); +```c +ippDelete(response); +``` ## Authentication CUPS normally handles authentication through the console. GUI applications -should set a password callback using the `cupsSetPasswordCB2` function: +should set a password callback using the [`cupsSetPasswordCB2`](@@) function: - void - cupsSetPasswordCB2(cups_password_cb2_t cb, void *user_data); +```c +void +cupsSetPasswordCB2(cups_password_cb2_t cb, void *user_data); +``` The password callback will be called when needed and is responsible for setting -the current user name using `cupsSetUser` and returning a string: +the current user name using [`cupsSetUser`](@@) and returning a string: - const char * - cups_password_cb2(const char *prompt, http_t *http, - const char *method, const char *resource, - void *user_data); +```c +const char * +cups_password_cb2(const char *prompt, http_t *http, + const char *method, const char *resource, + void *user_data); +``` The `prompt` argument is a string from CUPS that should be displayed to the user. The `http` argument is the connection hosting the request that is being -authenticated. The password callback can call the `httpGetField` and -`httpGetSubField` functions to look for additional details concerning the +authenticated. The password callback can call the [`httpGetField`](@@) and +[`httpGetSubField`](@@) functions to look for additional details concerning the authentication challenge. The `method` argument specifies the HTTP method used for the request and is @@ -1004,3 +1144,113 @@ The `resource` argument specifies the path used for the request. The `user_data` argument provides the user data pointer from the `cupsSetPasswordCB2` call. + + +# IPP Data File API + +The IPP data file API provides functions to read and write IPP attributes and +other commands or data using a common base format that supports tools such as +`ipptool` and `ippeveprinter`. + + +## Creating an IPP Data File + +The [`ippFileNew`](@@) function creates a new IPP data file (`ipp_file_t`) +object: + +```c +ipp_file_t *parent = NULL; +void *data; +ipp_file_t *file = ippFileNew(parent, attr_cb, error_cb, data); +``` + +The "parent" IPP data file pointer is typically used to support nested files and +is normally `NULL` for a new file. The "data" argument supplies your +application data to the callbacks. The "attr_cb" callback function is used to +filter IPP attributes; return `true` to include the attribute and `false` to ignore it: + +```c +bool +attr_cb(ipp_file_t *file, void *cb_data, const char *name) +{ + ... determine whether to use an attribute named "name" ... +} +``` + +The "error_cb" callback function is used to record/report errors when reading +the file: + +```c +bool +error_cb(ipp_file_t *file, void *cb_data, const char *error) +{ + ... display/record error and return `true` to continue or `false` to stop ... +} +``` + + +## Reading a Data File + +The [`ippFileOpen`](@@) function opens the specified data file and +[`ippFileRead`](@@) reads from it: + +```c +if (ippFileOpen(file, "somefile", "r")) +{ + // Opened successfully, now read it... + ippFileRead(file, token_cb, /*with_groups*/false); + ippFileClose(file); +} +``` + +The token callback function passed to `ippFileRead` handles custom directives in +your data file: + +```c +bool +token_cb(ipp_file_t *file, void *cb_data, const char *token) +{ + ... handle token, return `true` to continue or `false` to stop ... +} +``` + +The "token" parameter contains the token to be processed. The callback can use the [`ippFileReadToken`](@@) function to read additional tokens from the file +and the [`ippFileExpandToken`](@@) function to expand any variables in the token +string. Return `false` to stop reading the file and `true` to continue. The +default `NULL` callback reports an unknown token error through the error +callback end returns `false`. + +Once read, you call the [`ippFileGetAttributes`](@@) function to get the IPP +attributes from the file. + + +## Variables + +Each IPP data file object has associated variables that can be used when reading +the file. The default set of variables is: + +- "date-current": Current date in ISO-8601 format +- "date-start": Start date (when file opened) in ISO-8601 format +- "filename": Associated data/document filename, if any +- "filetype": MIME media type of associated data/document filename, if any +- "hostname": Hostname or IP address from the "uri" value, if any +- "port": Port number from the "uri" value, if any +- "resource": Resource path from the "uri" value, if any +- "scheme": URI scheme from the "uri" value, if any +- "uri": URI, if any +- "uriuser": Username from the "uri" value, if any +- "uripassword": Password from the "uri" value, if any +- "user": Current login user + +The [`ippFileGetVar`](@@), [`ippFileSetVar`](@@), and [`ippFileSetVarf`](@@) +functions get and set file variables, respectively. + + +## Writing IPP Data Files + +As when reading an IPP data file, the [`ippFileNew`](@@) function creates a new +file object, [`ippFileOpen`](@@) opens the file, and [`ippFileClose`](@@) closes +the file. However, you call [`ippFileWriteAttributes`](@@) to write the +attributes in an IPP message (`ipp_t`), [`ippFileWriteComment`](@@) to write a +comment in the file, and [`ippWriteToken`](@@) or [`ippWriteTokenf`](@@) to +write a token or value to the file. diff --git a/cups/http-addrlist.c b/cups/http-addrlist.c index 436e21f8a2..2036d92c4b 100644 --- a/cups/http-addrlist.c +++ b/cups/http-addrlist.c @@ -312,7 +312,7 @@ httpAddrConnect2( { pfds[i].revents |= POLLERR; # ifdef DEBUG - DEBUG_printf(("1httpAddrConnect2: getsockopt returned: %d with error: %s", sres, strerror(serr))); + DEBUG_printf("1httpAddrConnect2: getsockopt returned: %d with error: %s", sres, strerror(serr)); # endif } else if (pfds[i].revents && (pfds[i].revents & POLLHUP) && (pfds[i].revents & (POLLIN | POLLOUT))) @@ -321,7 +321,6 @@ httpAddrConnect2( } } - if (pfds[i].revents && !(pfds[i].revents & (POLLERR | POLLHUP))) { *sock = fds[i]; diff --git a/doc/help/cupspm.epub b/doc/help/cupspm.epub index 752b4e75bc..30b067d48f 100644 Binary files a/doc/help/cupspm.epub and b/doc/help/cupspm.epub differ diff --git a/doc/help/cupspm.html b/doc/help/cupspm.html index ba85a94a81..1d37d912c0 100644 --- a/doc/help/cupspm.html +++ b/doc/help/cupspm.html @@ -271,6 +271,12 @@

Contents

  • Processing the IPP Response
  • Authentication
  • +
  • IPP Data File API
  • Functions
    • DllMain
    • cupsAddDest
    • @@ -945,24 +951,24 @@

      Terms Used in This DocumentCompiling Programs That Use the CUPS API

      The CUPS libraries can be used from any C, C++, or Objective-C program. The method of compiling against the libraries varies depending on the operating system and installation of CUPS. The following sections show how to compile a simple program (shown below) in two common environments.

      The following simple program lists the available destinations:

      -
      #include <stdio.h>
      -#include <cups/cups.h>
      +
      #include <stdio.h>
      +#include <cups/cups.h>
       
      -int print_dest(void *user_data, unsigned flags, cups_dest_t *dest)
      +int print_dest(void *user_data, unsigned flags, cups_dest_t *dest)
       {
      -  if (dest->instance)
      -    printf("%s/%s\n", dest->name, dest->instance);
      -  else
      +  if (dest->instance)
      +    printf("%s/%s\n", dest->name, dest->instance);
      +  else
           puts(dest->name);
       
      -  return (1);
      +  return (1);
       }
       
      -int main(void)
      +int main(void)
       {
      -  cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, 0, 0, print_dest, NULL);
      +  cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, 0, 0, print_dest, NULL);
       
      -  return (0);
      +  return (0);
       }
       

      Compiling with Xcode

      @@ -971,19 +977,19 @@

      Compiling with Xcode

      Finally, click on the main.c file in the sidebar and copy the example program to the file. Build and run (CMD+R) to see the list of destinations.

      Compiling with GCC

      From the command-line, create a file called simple.c using your favorite editor, copy the example to this file, and save. Then run the following command to compile it with GCC and run it:

      -
      gcc -o simple `cups-config --cflags` simple.c `cups-config --libs`
      +
      gcc -o simple `pkg-config --cflags cups` simple.c `pkg-config --libs cups`
       ./simple
       
      -

      The cups-config command provides the compiler flags (cups-config --cflags) and libraries (cups-config --libs) needed for the local system.

      +

      The pkg-config command provides the compiler flags (pkg-config --cflags cups) and libraries (pkg-config --libs cups) needed for the local system.

      Working with Destinations

      Destinations, which in CUPS represent individual printers or classes (collections or pools) of printers, are represented by the cups_dest_t structure which includes the name (name), instance (instance, saved options/settings), whether the destination is the default for the user (is_default), and the options and basic information associated with that destination (num_options and options).

      Historically destinations have been manually maintained by the administrator of a system or network, but CUPS also supports dynamic discovery of destinations on the current network.

      Finding Available Destinations

      -

      The cupsEnumDests function finds all of the available destinations:

      -
       int
      - cupsEnumDests(unsigned flags, int msec, int *cancel,
      -               cups_ptype_t type, cups_ptype_t mask,
      -               cups_dest_cb_t cb, void *user_data)
      +

      The cupsEnumDests function finds all of the available destinations:

      +
      int
      +cupsEnumDests(unsigned flags, int msec, int *cancel,
      +              cups_ptype_t type, cups_ptype_t mask,
      +              cups_dest_cb_t cb, void *user_data)
       

      The flags argument specifies enumeration options, which at present must be CUPS_DEST_FLAGS_NONE.

      The msec argument specifies the maximum amount of time that should be used for enumeration in milliseconds - interactive applications should keep this value to 5000 or less when run on the main thread.

      @@ -1028,8 +1034,8 @@

      Finding Available Destinat

    The cb argument specifies a function to call for every destination that is found:

    -
    typedef int (*cups_dest_cb_t)(void *user_data,
    -                              unsigned flags,
    +
    typedef int (*cups_dest_cb_t)(void *user_data,
    +                              unsigned flags,
                                   cups_dest_t *dest);
     

    The callback function receives a copy of the user_data argument along with a bitfield (flags) and the destination that was found. The flags argument can have any of the following constant (bit) values set:

    @@ -1038,79 +1044,79 @@

    Finding Available Destinat

  • CUPS_DEST_FLAGS_REMOVED: The destination has gone away and should be removed from the list of destinations a user can select.

  • -
  • CUPS_DEST_FLAGS_ERROR: An error occurred. The reason for the error can be found by calling the cupsLastError and/or cupsLastErrorString functions.

    +
  • CUPS_DEST_FLAGS_ERROR: An error occurred. The reason for the error can be found by calling the cupsGetError and/or cupsGetErrorString functions.

  • -

    The callback function returns 0 to stop enumeration or 1 to continue.

    +

    The callback function returns 0 to stop enumeration or 1 to continue.

    Note:

    The callback function will likely be called multiple times for the same destination, so it is up to the caller to suppress any duplicate destinations.

    The following example shows how to use cupsEnumDests to get a filtered array of destinations:

    -
    typedef struct
    +
    typedef struct
     {
    -  int num_dests;
    +  int num_dests;
       cups_dest_t *dests;
     } my_user_data_t;
     
    -int
    -my_dest_cb(my_user_data_t *user_data, unsigned flags,
    +int
    +my_dest_cb(my_user_data_t *user_data, unsigned flags,
                cups_dest_t *dest)
     {
    -  if (flags & CUPS_DEST_FLAGS_REMOVED)
    +  if (flags & CUPS_DEST_FLAGS_REMOVED)
       {
    -   /*
    -    * Remove destination from array...
    -    */
    +   /*
    +    * Remove destination from array...
    +    */
     
         user_data->num_dests =
             cupsRemoveDest(dest->name, dest->instance,
                            user_data->num_dests,
                            &(user_data->dests));
       }
    -  else
    +  else
       {
    -   /*
    -    * Add destination to array...
    -    */
    +   /*
    +    * Add destination to array...
    +    */
     
         user_data->num_dests =
             cupsCopyDest(dest, user_data->num_dests,
                          &(user_data->dests));
       }
     
    -  return (1);
    +  return (1);
     }
     
    -int
    +int
     my_get_dests(cups_ptype_t type, cups_ptype_t mask,
                  cups_dest_t **dests)
     {
    -  my_user_data_t user_data = { 0, NULL };
    +  my_user_data_t user_data = { 0, NULL };
     
    -  if (!cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, type,
    +  if (!cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, type,
                          mask, (cups_dest_cb_t)my_dest_cb,
                          &user_data))
       {
    -   /*
    -    * An error occurred, free all of the destinations and
    -    * return...
    -    */
    +   /*
    +    * An error occurred, free all of the destinations and
    +    * return...
    +    */
     
         cupsFreeDests(user_data.num_dests, user_data.dests);
     
         *dests = NULL;
     
    -    return (0);
    +    return (0);
       }
     
    - /*
    -  * Return the destination array...
    -  */
    + /*
    +  * Return the destination array...
    +  */
     
       *dests = user_data.dests;
     
    -  return (user_data.num_dests);
    +  return (user_data.num_dests);
     }
     

    Basic Destination Information

    @@ -1139,25 +1145,25 @@

    Basic Destination Informati
  • "printer-uri-supported": The URI associated with the destination; if not set, this destination was discovered but is not yet setup as a local printer.

  • -

    Use the cupsGetOption function to retrieve the value. For example, the following code gets the make and model of a destination:

    -
    const char *model = cupsGetOption("printer-make-and-model",
    +

    Use the cupsGetOption function to retrieve the value. For example, the following code gets the make and model of a destination:

    +
    const char *model = cupsGetOption("printer-make-and-model",
                                       dest->num_options,
                                       dest->options);
     

    Detailed Destination Information

    -

    Once a destination has been chosen, the cupsCopyDestInfo function can be used to gather detailed information about the destination:

    -
    cups_dinfo_t *
    +

    Once a destination has been chosen, the cupsCopyDestInfo function can be used to gather detailed information about the destination:

    +
    cups_dinfo_t *
     cupsCopyDestInfo(http_t *http, cups_dest_t *dest);
     

    The http argument specifies a connection to the CUPS scheduler and is typically the constant CUPS_HTTP_DEFAULT. The dest argument specifies the destination to query.

    The cups_dinfo_t structure that is returned contains a snapshot of the supported options and their supported, ready, and default values. It also can report constraints between different options and values, and recommend changes to resolve those constraints.

    Getting Supported Options and Values

    -

    The cupsCheckDestSupported function can be used to test whether a particular option or option and value is supported:

    -
    int
    +

    The cupsCheckDestSupported function can be used to test whether a particular option or option and value is supported:

    +
    int
     cupsCheckDestSupported(http_t *http, cups_dest_t *dest,
                            cups_dinfo_t *info,
    -                       const char *option,
    -                       const char *value);
    +                       const char *option,
    +                       const char *value);
     

    The option argument specifies the name of the option to check. The following constants can be used to check the various standard options:

      @@ -1183,117 +1189,131 @@

      Getting Supported Options and Valu

    If the value argument is NULL, the cupsCheckDestSupported function returns whether the option is supported by the destination. Otherwise, the function returns whether the specified value of the option is supported.

    -

    The cupsFindDestSupported function returns the IPP attribute containing the supported values for a given option:

    -
     ipp_attribute_t *
    - cupsFindDestSupported(http_t *http, cups_dest_t *dest,
    -                       cups_dinfo_t *dinfo,
    -                       const char *option);
    +

    The cupsFindDestSupported function returns the IPP attribute containing the supported values for a given option:

    +
    ipp_attribute_t *
    +cupsFindDestSupported(http_t *http, cups_dest_t *dest,
    +                      cups_dinfo_t *dinfo,
    +                      const char *option);
     

    For example, the following code prints the supported finishing processes for a destination, if any, to the standard output:

    -
    cups_dinfo_t *info = cupsCopyDestInfo(CUPS_HTTP_DEFAULT,
    +
    cups_dinfo_t *info = cupsCopyDestInfo(CUPS_HTTP_DEFAULT,
                                           dest);
     
    -if (cupsCheckDestSupported(CUPS_HTTP_DEFAULT, dest, info,
    +if (cupsCheckDestSupported(CUPS_HTTP_DEFAULT, dest, info,
                                CUPS_FINISHINGS, NULL))
     {
       ipp_attribute_t *finishings =
           cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info,
                                 CUPS_FINISHINGS);
    -  int i, count = ippGetCount(finishings);
    +  int i, count = ippGetCount(finishings);
     
    -  puts("finishings supported:");
    -  for (i = 0; i < count; i ++)
    -    printf("  %d\n", ippGetInteger(finishings, i));
    +  puts("finishings supported:");
    +  for (i = 0; i < count; i ++)
    +  {
    +    int val = ippGetInteger(finishings, i);
    +    printf("  %d (%s)\n", val,
    +           ippEnumString("finishings", val));
    +}
    +else
    +{
    +  puts("finishings not supported.");
     }
    -else
    -  puts("finishings not supported.");
     

    The "job-creation-attributes" option can be queried to get a list of supported options. For example, the following code prints the list of supported options to the standard output:

    -
    ipp_attribute_t *attrs =
    +
    ipp_attribute_t *attrs =
         cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info,
    -                          "job-creation-attributes");
    -int i, count = ippGetCount(attrs);
    +                          "job-creation-attributes");
    +int i, count = ippGetCount(attrs);
     
    -for (i = 0; i < count; i ++)
    +for (i = 0; i < count; i ++)
       puts(ippGetString(attrs, i, NULL));
     

    Getting Default Values

    -

    There are two sets of default values - user defaults that are available via the num_options and options members of the cups_dest_t structure, and destination defaults that available via the cups_dinfo_t structure and the cupsFindDestDefault function which returns the IPP attribute containing the default value(s) for a given option:

    -
    ipp_attribute_t *
    +

    There are two sets of default values - user defaults that are available via the num_options and options members of the cups_dest_t structure, and destination defaults that available via the cups_dinfo_t structure and the cupsFindDestDefault function which returns the IPP attribute containing the default value(s) for a given option:

    +
    ipp_attribute_t *
     cupsFindDestDefault(http_t *http, cups_dest_t *dest,
                         cups_dinfo_t *dinfo,
    -                    const char *option);
    +                    const char *option);
     
    -

    The user defaults from cupsGetOption should always take preference over the destination defaults. For example, the following code prints the default finishings value(s) to the standard output:

    -
    const char *def_value =
    +

    The user defaults from cupsGetOption should always take preference over the destination defaults. For example, the following code prints the default finishings value(s) to the standard output:

    +
    const char *def_value =
         cupsGetOption(CUPS_FINISHINGS, dest->num_options,
                       dest->options);
     ipp_attribute_t *def_attr =
         cupsFindDestDefault(CUPS_HTTP_DEFAULT, dest, info,
                             CUPS_FINISHINGS);
     
    -if (def_value != NULL)
    +if (def_value != NULL)
     {
    -  printf("Default finishings: %s\n", def_value);
    +  printf("Default finishings: %s\n", def_value);
     }
    -else
    +else
     {
    -  int i, count = ippGetCount(def_attr);
    +  int i, count = ippGetCount(def_attr);
     
    -  printf("Default finishings: %d",
    -         ippGetInteger(def_attr, 0));
    -  for (i = 1; i < count; i ++)
    -    printf(",%d", ippGetInteger(def_attr, i));
    -  putchar('\n');
    +  printf("Default finishings: %d",
    +         ippGetInteger(def_attr, 0));
    +  for (i = 1; i < count; i ++)
    +    printf(",%d", ippGetInteger(def_attr, i));
    +  putchar('\n');
     }
     

    Getting Ready (Loaded) Values

    The finishings and media options also support queries for the ready, or loaded, values. For example, a printer may have punch and staple finishers installed but be out of staples - the supported values will list both punch and staple finishing processes but the ready values will only list the punch processes. Similarly, a printer may support hundreds of different sizes of media but only have a single size loaded at any given time - the ready values are limited to the media that is actually in the printer.

    -

    The cupsFindDestReady function finds the IPP attribute containing the ready values for a given option:

    -
    ipp_attribute_t *
    +

    The cupsFindDestReady function finds the IPP attribute containing the ready values for a given option:

    +
    ipp_attribute_t *
     cupsFindDestReady(http_t *http, cups_dest_t *dest,
    -                  cups_dinfo_t *dinfo, const char *option);
    +                  cups_dinfo_t *dinfo, const char *option);
     

    For example, the following code lists the ready finishing processes:

    -
    ipp_attribute_t *ready_finishings =
    +
    ipp_attribute_t *ready_finishings =
         cupsFindDestReady(CUPS_HTTP_DEFAULT, dest, info,
                           CUPS_FINISHINGS);
     
    -if (ready_finishings != NULL)
    +if (ready_finishings != NULL)
     {
    -  int i, count = ippGetCount(ready_finishings);
    +  int i, count = ippGetCount(ready_finishings);
     
    -  puts("finishings ready:");
    -  for (i = 0; i < count; i ++)
    -    printf("  %d\n", ippGetInteger(ready_finishings, i));
    +  puts("finishings ready:");
    +  for (i = 0; i < count; i ++)
    +  {
    +    int val = ippGetInteger(ready_finishings, i);
    +    printf("  %d (%s)\n", val,
    +           ippEnumString("finishings", val));
    +}
    +else
    +{
    +  puts("no finishings are ready.");
     }
    -else
    -  puts("no finishings are ready.");
     
    -

    Media Size Options

    -

    CUPS provides functions for querying the dimensions and margins for each of the supported media size options. The cups_size_t structure is used to describe a media size:

    -
    typedef struct cups_size_s
    +

    Media Options

    +

    CUPS provides functions for querying the dimensions, margins, color, source (tray/roll), and type for each of the supported media size options. The cups_media_t structure is used to describe media:

    +
    typedef struct cups_media_s
     {
    -  char media[128];
    -  int width, length;
    -  int bottom, left, right, top;
    -} cups_size_t;
    +  char media[128];
    +  char color[128];
    +  char source[128];
    +  char type[128];
    +  int width, length;
    +  int bottom, left, right, top;
    +} cups_media_t;
     
    +

    The "media" member specifies a PWG self-describing media size name such as "na_letter_8.5x11in", "iso_a4_210x297mm", etc. The "color" member specifies a PWG media color name such as "white", "blue", etc. The "source" member specifies a standard keyword for the paper tray or roll such as "tray-1", "manual", "by-pass-tray" (multi-purpose tray), etc. The "type" member specifies a PWG media type name such as "stationery" (plain paper), "photographic", "envelope", "transparency", etc.

    The width and length members specify the dimensions of the media in hundredths of millimeters (1/2540th of an inch). The bottom, left, right, and top members specify the margins of the printable area, also in hundredths of millimeters.

    -

    The cupsGetDestMediaByName and cupsGetDestMediaBySize functions lookup the media size information using a standard media size name or dimensions in hundredths of millimeters:

    -
    int
    -cupsGetDestMediaByName(http_t *http, cups_dest_t *dest,
    -                       cups_dinfo_t *dinfo,
    -                       const char *media,
    -                       unsigned flags, cups_size_t *size);
    -
    -int
    -cupsGetDestMediaBySize(http_t *http, cups_dest_t *dest,
    -                       cups_dinfo_t *dinfo,
    -                       int width, int length,
    -                       unsigned flags, cups_size_t *size);
    +

    The cupsGetDestMediaByName2 and cupsGetDestMediaBySize2 functions lookup the media information using a standard media size name or dimensions in hundredths of millimeters:

    +
    bool
    +cupsGetDestMediaByName2(http_t *http, cups_dest_t *dest,
    +                        cups_dinfo_t *dinfo,
    +                        const char *name,
    +                        unsigned flags, cups_media_t *media);
    +
    +bool
    +cupsGetDestMediaBySize2(http_t *http, cups_dest_t *dest,
    +                        cups_dinfo_t *dinfo,
    +                        int width, int length,
    +                        unsigned flags, cups_media_t *media);
     
    -

    The media, width, and length arguments specify the size to lookup. The flags argument specifies a bitfield controlling various lookup options:

    +

    The name, width, and length arguments specify the size to lookup. The flags argument specifies a bitfield controlling various lookup options:

    • CUPS_MEDIA_FLAGS_DEFAULT: Find the closest size supported by the printer.

    • @@ -1306,95 +1326,121 @@

      Media Size Options

    • CUPS_MEDIA_FLAGS_READY: If the printer supports media sensing or configuration of the media in each tray/source, find the size amongst the "ready" media.

    -

    If a matching size is found for the destination, the size information is stored in the structure pointed to by the size argument and 1 is returned. Otherwise 0 is returned.

    +

    If a matching size is found for the destination, the size information is stored in the structure pointed to by the media argument and true is returned. Otherwise false is returned.

    For example, the following code prints the margins for two-sided printing on US Letter media:

    -
    cups_size_t size;
    +
    cups_media_t media:
     
    -if (cupsGetDestMediaByName(CUPS_HTTP_DEFAULT, dest, info,
    -                           CUPS_MEDIA_LETTER,
    -                           CUPS_MEDIA_FLAGS_DUPLEX, &size))
    +if (cupsGetDestMediaByName2(CUPS_HTTP_DEFAULT, dest, info,
    +                            CUPS_MEDIA_LETTER,
    +                            CUPS_MEDIA_FLAGS_DUPLEX, &size))
    +{
    +  puts("Margins for duplex US Letter:");
    +  printf("  Bottom: %.2fin\n", media.bottom / 2540.0);
    +  printf("    Left: %.2fin\n", media.left / 2540.0);
    +  printf("   Right: %.2fin\n", media.right / 2540.0);
    +  printf("     Top: %.2fin\n", media.top / 2540.0);
    +}
    +else
     {
    -  puts("Margins for duplex US Letter:");
    -  printf("  Bottom: %.2fin\n", size.bottom / 2540.0);
    -  printf("    Left: %.2fin\n", size.left / 2540.0);
    -  printf("   Right: %.2fin\n", size.right / 2540.0);
    -  printf("     Top: %.2fin\n", size.top / 2540.0);
    +  puts("Margins for duplex US Letter are not available.");
     }
    -else
    -  puts("Margins for duplex US Letter are not available.");
     
    -

    You can also enumerate all of the sizes that match a given flags value using the cupsGetDestMediaByIndex and cupsGetDestMediaCount functions:

    -
    int
    -cupsGetDestMediaByIndex(http_t *http, cups_dest_t *dest,
    -                        cups_dinfo_t *dinfo, int n,
    -                        unsigned flags, cups_size_t *size);
    +

    You can also enumerate all of the sizes that match a given flags value using the cupsGetDestMediaByIndex2 and cupsGetDestMediaCount functions:

    +
    bool
    +cupsGetDestMediaByIndex2(http_t *http, cups_dest_t *dest,
    +                         cups_dinfo_t *dinfo, size_t n,
    +                         unsigned flags, cups_media_t *media);
     
    -int
    +int
     cupsGetDestMediaCount(http_t *http, cups_dest_t *dest,
    -                      cups_dinfo_t *dinfo, unsigned flags);
    +                      cups_dinfo_t *dinfo, unsigned flags);
     

    For example, the following code prints the list of ready media and corresponding margins:

    -
    cups_size_t size;
    -int i;
    -int count = cupsGetDestMediaCount(CUPS_HTTP_DEFAULT,
    -                                  dest, info,
    -                                  CUPS_MEDIA_FLAGS_READY);
    +
    cups_media_t media;
    +size_t i;
    +size_t count = (size_t)cupsGetDestMediaCount(CUPS_HTTP_DEFAULT,
    +                                             dest, info,
    +                                             CUPS_MEDIA_FLAGS_READY);
     
    -for (i = 0; i < count; i ++)
    +for (i = 0; i < count; i ++)
     {
    -  if (cupsGetDestMediaByIndex(CUPS_HTTP_DEFAULT, dest, info,
    -                              i, CUPS_MEDIA_FLAGS_READY,
    -                              &size))
    +  if (cupsGetDestMediaByIndex2(CUPS_HTTP_DEFAULT, dest, info,
    +                               i, CUPS_MEDIA_FLAGS_READY,
    +                               &media))
       {
    -    printf("%s:\n", size.name);
    -    printf("   Width: %.2fin\n", size.width / 2540.0);
    -    printf("  Length: %.2fin\n", size.length / 2540.0);
    -    printf("  Bottom: %.2fin\n", size.bottom / 2540.0);
    -    printf("    Left: %.2fin\n", size.left / 2540.0);
    -    printf("   Right: %.2fin\n", size.right / 2540.0);
    -    printf("     Top: %.2fin\n", size.top / 2540.0);
    +    printf("%s:\n", media.name);
    +    printf("   Width: %.2fin\n", media.width / 2540.0);
    +    printf("  Length: %.2fin\n", media.length / 2540.0);
    +    printf("  Bottom: %.2fin\n", media.bottom / 2540.0);
    +    printf("    Left: %.2fin\n", media.left / 2540.0);
    +    printf("   Right: %.2fin\n", media.right / 2540.0);
    +    printf("     Top: %.2fin\n", media.top / 2540.0);
       }
     }
     
    -

    Finally, the cupsGetDestMediaDefault function returns the default media size:

    -
    int
    -cupsGetDestMediaDefault(http_t *http, cups_dest_t *dest,
    -                        cups_dinfo_t *dinfo, unsigned flags,
    -                        cups_size_t *size);
    +

    Finally, the cupsGetDestMediaDefault2 function returns the default media:

    +
    int
    +cupsGetDestMediaDefault2(http_t *http, cups_dest_t *dest,
    +                         cups_dinfo_t *dinfo, unsigned flags,
    +                         cups_media_t *media);
     

    Localizing Options and Values

    -

    CUPS provides three functions to get localized, human-readable strings in the user's current locale for options and values: cupsLocalizeDestMedia, cupsLocalizeDestOption, and cupsLocalizeDestValue:

    -
    const char *
    -cupsLocalizeDestMedia(http_t *http, cups_dest_t *dest,
    -                      cups_dinfo_t *info, unsigned flags,
    -                      cups_size_t *size);
    +

    CUPS provides three functions to get localized, human-readable strings in the user's current locale for options and values: cupsLocalizeDestMedia2, cupsLocalizeDestOption, and cupsLocalizeDestValue:

    +
    const char *
    +cupsLocalizeDestMedia2(http_t *http, cups_dest_t *dest,
    +                       cups_dinfo_t *info, unsigned flags,
    +                       cups_media_t *media);
     
    -const char *
    +const char *
     cupsLocalizeDestOption(http_t *http, cups_dest_t *dest,
                            cups_dinfo_t *info,
    -                       const char *option);
    +                       const char *option);
     
    -const char *
    +const char *
     cupsLocalizeDestValue(http_t *http, cups_dest_t *dest,
                           cups_dinfo_t *info,
    -                      const char *option, const char *value);
    +                      const char *option, const char *value);
    +
    +
    +

    Note:

    +

    These functions require a valid http_t connection to work. Use the cupsConnectDest function to connect to the destination for its localization information.

    +
    +

    For example, the following code will list the localized media names for a destination:

    +
    char resource[256];
    +http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_NONE,
    +                               /*msec*/30000, /*cancel*/NULL,
    +                               resource, sizeof(resource),
    +                               /*dest_cb*/NULL, /*user_data*/NULL);
    +
    +size_t i;
    +size_t count = (size_t)cupsGetDestMediaCount(http, dest, info,
    +                                             CUPS_MEDIA_FLAGS_DEFAULT);
    +cups_media_t media;
    +for (i = 0; i < count; i ++)
    +{
    +  if (cupsGetDestMediaByIndex2(http, dest, info, i,
    +                               CUPS_MEDIA_FLAGS_DEFAULT, &media))
    +    printf("%s: %s\n", media.name,
    +           cupsLocalizeDestMedia2(http, dest, info,
    +                                  CUPS_MEDIA_FLAGS_DEFAULT, &media));
    +}
     

    Submitting a Print Job

    -

    Once you are ready to submit a print job, you create a job using the cupsCreateDestJob function:

    -
    ipp_status_t
    +

    Once you are ready to submit a print job, you create a job using the cupsCreateDestJob function:

    +
    ipp_status_t
     cupsCreateDestJob(http_t *http, cups_dest_t *dest,
    -                  cups_dinfo_t *info, int *job_id,
    -                  const char *title, int num_options,
    +                  cups_dinfo_t *info, int *job_id,
    +                  const char *title, int num_options,
                       cups_option_t *options);
     

    The title argument specifies a name for the print job such as "My Document". The num_options and options arguments specify the options for the print job which are allocated using the cupsAddOption function.

    When successful, the job's numeric identifier is stored in the integer pointed to by the job_id argument and IPP_STATUS_OK is returned. Otherwise, an IPP error status is returned.

    For example, the following code creates a new job that will print 42 copies of a two-sided US Letter document:

    -
    int job_id = 0;
    -int num_options = 0;
    +
    int job_id = 0;
    +int num_options = 0;
     cups_option_t *options = NULL;
     
    -num_options = cupsAddOption(CUPS_COPIES, "42",
    +num_options = cupsAddOption(CUPS_COPIES, "42",
                                 num_options, &options);
     num_options = cupsAddOption(CUPS_MEDIA, CUPS_MEDIA_LETTER,
                                 num_options, &options);
    @@ -1402,26 +1448,26 @@ 

    Submitting a Print Job

    CUPS_SIDES_TWO_SIDED_PORTRAIT, num_options, &options); -if (cupsCreateDestJob(CUPS_HTTP_DEFAULT, dest, info, - &job_id, "My Document", num_options, +if (cupsCreateDestJob(CUPS_HTTP_DEFAULT, dest, info, + &job_id, "My Document", num_options, options) == IPP_STATUS_OK) - printf("Created job: %d\n", job_id); -else - printf("Unable to create job: %s\n", - cupsLastErrorString()); + printf("Created job: %d\n", job_id); +else + printf("Unable to create job: %s\n", + cupsGetErrorString());
    -

    Once the job is created, you submit documents for the job using the cupsStartDestDocument, cupsWriteRequestData, and cupsFinishDestDocument functions:

    -
    http_status_t
    +

    Once the job is created, you submit documents for the job using the cupsStartDestDocument, cupsWriteRequestData, and cupsFinishDestDocument functions:

    +
    http_status_t
     cupsStartDestDocument(http_t *http, cups_dest_t *dest,
    -                      cups_dinfo_t *info, int job_id,
    -                      const char *docname,
    -                      const char *format,
    -                      int num_options,
    +                      cups_dinfo_t *info, int job_id,
    +                      const char *docname,
    +                      const char *format,
    +                      int num_options,
                           cups_option_t *options,
    -                      int last_document);
    +                      int last_document);
     
     http_status_t
    -cupsWriteRequestData(http_t *http, const char *buffer,
    +cupsWriteRequestData(http_t *http, const char *buffer,
                          size_t length);
     
     ipp_status_t
    @@ -1430,36 +1476,38 @@ 

    Submitting a Print Job

    The docname argument specifies the name of the document, typically the original filename. The format argument specifies the MIME media type of the document, including the following constants:

      +
    • CUPS_FORMAT_AUTO: "application/octet-stream"

      +
    • CUPS_FORMAT_JPEG: "image/jpeg"

    • CUPS_FORMAT_PDF: "application/pdf"

    • -
    • CUPS_FORMAT_POSTSCRIPT: "application/postscript"

      -
    • CUPS_FORMAT_TEXT: "text/plain"

    The num_options and options arguments specify per-document print options, which at present must be 0 and NULL. The last_document argument specifies whether this is the last document in the job.

    For example, the following code submits a PDF file to the job that was just created:

    -
    FILE *fp = fopen("filename.pdf", "rb");
    +
    FILE *fp = fopen("filename.pdf", "rb");
     size_t bytes;
    -char buffer[65536];
    +char buffer[65536];
     
    -if (cupsStartDestDocument(CUPS_HTTP_DEFAULT, dest, info,
    -                          job_id, "filename.pdf", 0, NULL,
    -                          1) == HTTP_STATUS_CONTINUE)
    +if (cupsStartDestDocument(CUPS_HTTP_DEFAULT, dest, info,
    +                          job_id, "filename.pdf", 0, NULL,
    +                          1) == HTTP_STATUS_CONTINUE)
     {
    -  while ((bytes = fread(buffer, 1, sizeof(buffer), fp)) > 0)
    -    if (cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer,
    +  while ((bytes = fread(buffer, 1, sizeof(buffer), fp)) > 0)
    +  {
    +    if (cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer,
                                  bytes) != HTTP_STATUS_CONTINUE)
    -      break;
    +      break;
    +  }
     
    -  if (cupsFinishDestDocument(CUPS_HTTP_DEFAULT, dest,
    +  if (cupsFinishDestDocument(CUPS_HTTP_DEFAULT, dest,
                                  info) == IPP_STATUS_OK)
    -    puts("Document send succeeded.");
    -  else
    -    printf("Document send failed: %s\n",
    -           cupsLastErrorString());
    +    puts("Document send succeeded.");
    +  else
    +    printf("Document send failed: %s\n",
    +           cupsGetErrorString());
     }
     
     fclose(fp);
    @@ -1467,162 +1515,235 @@ 

    Submitting a Print Job

    Sending IPP Requests

    CUPS provides a rich API for sending IPP requests to the scheduler or printers, typically from management or utility applications whose primary purpose is not to send print jobs.

    Connecting to the Scheduler or Printer

    -

    The connection to the scheduler or printer is represented by the HTTP connection type http_t. The cupsConnectDest function connects to the scheduler or printer associated with the destination:

    -
    http_t *
    -cupsConnectDest(cups_dest_t *dest, unsigned flags, int msec,
    -                int *cancel, char *resource,
    +

    The connection to the scheduler or printer is represented by the HTTP connection type http_t. The cupsConnectDest function connects to the scheduler or printer associated with the destination:

    +
    http_t *
    +cupsConnectDest(cups_dest_t *dest, unsigned flags, int msec,
    +                int *cancel, char *resource,
                     size_t resourcesize, cups_dest_cb_t cb,
    -                void *user_data);
    +                void *user_data);
     

    The dest argument specifies the destination to connect to.

    The flags argument specifies whether you want to connect to the scheduler (CUPS_DEST_FLAGS_NONE) or device/printer (CUPS_DEST_FLAGS_DEVICE) associated with the destination.

    The msec argument specifies how long you are willing to wait for the connection to be established in milliseconds. Specify a value of -1 to wait indefinitely.

    The cancel argument specifies the address of an integer variable that can be set to a non-zero value to cancel the connection. Specify a value of NULL to not provide a cancel variable.

    The resource and resourcesize arguments specify the address and size of a character string array to hold the path to use when sending an IPP request.

    -

    The cb and user_data arguments specify a destination callback function that returns 1 to continue connecting or 0 to stop. The destination callback work the same way as the one used for the cupsEnumDests function.

    +

    The cb and user_data arguments specify a destination callback function that returns 1 to continue connecting or 0 to stop. The destination callback works the same way as the one used for the cupsEnumDests function.

    On success, a HTTP connection is returned that can be used to send IPP requests and get IPP responses.

    For example, the following code connects to the printer associated with a destination with a 30 second timeout:

    -
    char resource[256];
    +
    char resource[256];
     http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_DEVICE,
    -                               30000, NULL, resource,
    -                               sizeof(resource), NULL, NULL);
    +                               30000, /*cancel*/NULL, resource,
    +                               sizeof(resource),
    +                               /*cb*/NULL, /*user_data*/NULL);
     

    Creating an IPP Request

    IPP requests are represented by the IPP message type ipp_t and each IPP attribute in the request is representing using the type ipp_attribute_t. Each IPP request includes an operation code (IPP_OP_CREATE_JOB, IPP_OP_GET_PRINTER_ATTRIBUTES, etc.) and a 32-bit integer identifier.

    The ippNewRequest function creates a new IPP request:

    -
    ipp_t *
    +
    ipp_t *
     ippNewRequest(ipp_op_t op);
     

    The op argument specifies the IPP operation code for the request. For example, the following code creates an IPP Get-Printer-Attributes request:

    -
    ipp_t *request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES);
    +
    ipp_t *request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES);
     

    The request identifier is automatically set to a unique value for the current process.

    Each IPP request starts with two IPP attributes, "attributes-charset" and "attributes-natural-language", followed by IPP attribute(s) that specify the target of the operation. The ippNewRequest automatically adds the correct "attributes-charset" and "attributes-natural-language" attributes, but you must add the target attribute(s). For example, the following code adds the "printer-uri" attribute to the IPP Get-Printer-Attributes request to specify which printer is being queried:

    -
    const char *printer_uri = cupsGetOption("device-uri",
    +
    const char *printer_uri = cupsGetOption("device-uri",
                                             dest->num_options,
                                             dest->options);
     
     ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI,
    -             "printer-uri", NULL, printer_uri);
    +             "printer-uri", /*language*/NULL, printer_uri);
    +```c
     

    Note:

    If we wanted to query the scheduler instead of the device, we would look up the "printer-uri-supported" option instead of the "device-uri" value.

    -

    The ippAddString function adds the "printer-uri" attribute to the IPP request. The IPP_TAG_OPERATION argument specifies that the attribute is part of the operation. The IPP_TAG_URI argument specifies that the value is a Universal Resource Identifier (URI) string. The NULL argument specifies there is no language (English, French, Japanese, etc.) associated with the string, and the printer_uri argument specifies the string value.

    +

    The ippAddString function adds the "printer-uri" attribute to the IPP request. The IPP_TAG_OPERATION argument specifies that the attribute is part of the operation. The IPP_TAG_URI argument specifies that the value is a Universal Resource Identifier (URI) string. The NULL argument specifies there is no language (English, French, Japanese, etc.) associated with the string, and the printer_uri argument specifies the string value.

    The IPP Get-Printer-Attributes request also supports an IPP attribute called "requested-attributes" that lists the attributes and values you are interested in. For example, the following code requests the printer state attributes:

    -
    static const char * const requested_attributes[] =
    +
    static const char * const requested_attributes[] =
     {
    -  "printer-state",
    -  "printer-state-message",
    -  "printer-state-reasons"
    +  "printer-state",
    +  "printer-state-message",
    +  "printer-state-reasons"
     };
     
     ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
    -              "requested-attributes", 3, NULL,
    +              "requested-attributes", 3, /*language*/NULL,
                   requested_attributes);
     
    -

    The ippAddStrings function adds an attribute with one or more strings, in this case three. The IPP_TAG_KEYWORD argument specifies that the strings are keyword values, which are used for attribute names. All strings use the same language (NULL), and the attribute will contain the three strings in the array requested_attributes.

    +

    The ippAddStrings function adds an attribute with one or more strings, in this case three. The IPP_TAG_KEYWORD argument specifies that the strings are keyword values, which are used for attribute names. All strings use the same language (NULL for none), and the attribute will contain the three strings in the array requested_attributes.

    CUPS provides many functions to adding attributes of different types:

      -
    • ippAddBoolean adds a boolean (IPP_TAG_BOOLEAN) attribute with one value.

      +
    • ippAddBoolean adds a boolean (IPP_TAG_BOOLEAN) attribute with one value.

    • -
    • ippAddInteger adds an enum (IPP_TAG_ENUM) or integer (IPP_TAG_INTEGER) attribute with one value.

      +
    • ippAddInteger adds an enum (IPP_TAG_ENUM) or integer (IPP_TAG_INTEGER) attribute with one value.

    • -
    • ippAddIntegers adds an enum or integer attribute with one or more values.

      +
    • ippAddIntegers adds an enum or integer attribute with one or more values.

    • -
    • ippAddOctetString adds an octetString attribute with one value.

      +
    • ippAddOctetString adds an octetString attribute with one value.

    • -
    • ippAddOutOfBand adds a admin-defined (IPP_TAG_ADMINDEFINE), default (IPP_TAG_DEFAULT), delete-attribute (IPP_TAG_DELETEATTR), no-value (IPP_TAG_NOVALUE), not-settable (IPP_TAG_NOTSETTABLE), unknown (IPP_TAG_UNKNOWN), or unsupported (IPP_TAG_UNSUPPORTED_VALUE) out-of-band attribute.

      +
    • ippAddOutOfBand adds a admin-defined (IPP_TAG_ADMINDEFINE), default (IPP_TAG_DEFAULT), delete-attribute (IPP_TAG_DELETEATTR), no-value (IPP_TAG_NOVALUE), not-settable (IPP_TAG_NOTSETTABLE), unknown (IPP_TAG_UNKNOWN), or unsupported (IPP_TAG_UNSUPPORTED_VALUE) out-of-band attribute.

    • -
    • ippAddRange adds a rangeOfInteger attribute with one range.

      +
    • ippAddRange adds a rangeOfInteger attribute with one range.

    • -
    • ippAddRanges adds a rangeOfInteger attribute with one or more ranges.

      +
    • ippAddRanges adds a rangeOfInteger attribute with one or more ranges.

    • -
    • ippAddResolution adds a resolution attribute with one resolution.

      +
    • ippAddResolution adds a resolution attribute with one resolution.

    • -
    • ippAddResolutions adds a resolution attribute with one or more resolutions.

      +
    • ippAddResolutions adds a resolution attribute with one or more resolutions.

    • -
    • ippAddString adds a charset (IPP_TAG_CHARSET), keyword (IPP_TAG_KEYWORD), mimeMediaType (IPP_TAG_MIMETYPE), name (IPP_TAG_NAME and IPP_TAG_NAMELANG), naturalLanguage (IPP_TAG_NATURAL_LANGUAGE), text (IPP_TAG_TEXT and IPP_TAG_TEXTLANG), uri (IPP_TAG_URI), or uriScheme (IPP_TAG_URISCHEME) attribute with one value.

      +
    • ippAddString adds a charset (IPP_TAG_CHARSET), keyword (IPP_TAG_KEYWORD), mimeMediaType (IPP_TAG_MIMETYPE), name (IPP_TAG_NAME and IPP_TAG_NAMELANG), naturalLanguage (IPP_TAG_NATURAL_LANGUAGE), text (IPP_TAG_TEXT and IPP_TAG_TEXTLANG), uri (IPP_TAG_URI), or uriScheme (IPP_TAG_URISCHEME) attribute with one value.

    • -
    • ippAddStrings adds a charset, keyword, mimeMediaType, name, naturalLanguage, text, uri, or uriScheme attribute with one or more values.

      +
    • ippAddStrings adds a charset, keyword, mimeMediaType, name, naturalLanguage, text, uri, or uriScheme attribute with one or more values.

    Sending the IPP Request

    -

    Once you have created the IPP request, you can send it using the cupsDoRequest function. For example, the following code sends the IPP Get-Printer-Attributes request to the destination and saves the response:

    -
    ipp_t *response = cupsDoRequest(http, request, resource);
    +

    Once you have created the IPP request, you can send it using the cupsDoRequest function. For example, the following code sends the IPP Get-Printer-Attributes request to the destination and saves the response:

    +
    ipp_t *response = cupsDoRequest(http, request, resource);
     
    -

    For requests like Send-Document that include a file, the cupsDoFileRequest function should be used:

    -
    ipp_t *response = cupsDoFileRequest(http, request, resource,
    +

    For requests like Send-Document that include a file, the cupsDoFileRequest function should be used:

    +
    ipp_t *response = cupsDoFileRequest(http, request, resource,
                                         filename);
     

    Both cupsDoRequest and cupsDoFileRequest free the IPP request. If a valid IPP response is received, it is stored in a new IPP message (ipp_t) and returned to the caller. Otherwise NULL is returned.

    -

    The status from the most recent request can be queried using the cupsLastError function, for example:

    -
    if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST)
    +

    The status from the most recent request can be queried using the cupsGetError function, for example:

    +
    if (cupsGetError() >= IPP_STATUS_ERROR_BAD_REQUEST)
     {
    -  /* request failed */
    +  /* request failed */
     }
     
    -

    A human-readable error message is also available using the cupsLastErrorString function:

    -
    if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST)
    +

    A human-readable error message is also available using the cupsGetErrorString function:

    +
    if (cupsGetError() >= IPP_STATUS_ERROR_BAD_REQUEST)
     {
    -  /* request failed */
    -  printf("Request failed: %s\n", cupsLastErrorString());
    +  /* request failed */
    +  printf("Request failed: %s\n", cupsGetErrorString());
     }
     

    Processing the IPP Response

    Each response to an IPP request is also an IPP message (ipp_t) with its own IPP attributes (ipp_attribute_t) that includes a status code (IPP_STATUS_OK, IPP_STATUS_ERROR_BAD_REQUEST, etc.) and the corresponding 32-bit integer identifier from the request.

    For example, the following code finds the printer state attributes and prints their values:

    -
    ipp_attribute_t *attr;
    +
    ipp_attribute_t *attr;
     
    -if ((attr = ippFindAttribute(response, "printer-state",
    +if ((attr = ippFindAttribute(response, "printer-state",
                                  IPP_TAG_ENUM)) != NULL)
     {
    -  printf("printer-state=%s\n",
    -         ippEnumString("printer-state", ippGetInteger(attr, 0)));
    +  printf("printer-state=%s\n",
    +         ippEnumString("printer-state", ippGetInteger(attr, 0)));
     }
    -else
    -  puts("printer-state=unknown");
    +else
    +  puts("printer-state=unknown");
     
    -if ((attr = ippFindAttribute(response, "printer-state-message",
    +if ((attr = ippFindAttribute(response, "printer-state-message",
                                  IPP_TAG_TEXT)) != NULL)
     {
    -  printf("printer-state-message=\"%s\"\n",
    -         ippGetString(attr, 0, NULL)));
    +  printf("printer-state-message=\"%s\"\n",
    +         ippGetString(attr, 0, NULL)));
     }
     
    -if ((attr = ippFindAttribute(response, "printer-state-reasons",
    +if ((attr = ippFindAttribute(response, "printer-state-reasons",
                                  IPP_TAG_KEYWORD)) != NULL)
     {
    -  int i, count = ippGetCount(attr);
    +  int i, count = ippGetCount(attr);
     
    -  puts("printer-state-reasons=");
    -  for (i = 0; i < count; i ++)
    -    printf("    %s\n", ippGetString(attr, i, NULL)));
    +  puts("printer-state-reasons=");
    +  for (i = 0; i < count; i ++)
    +    printf("    %s\n", ippGetString(attr, i, NULL)));
     }
     
    -

    The ippGetCount function returns the number of values in an attribute.

    -

    The ippGetInteger and ippGetString functions return a single integer or string value from an attribute.

    -

    The ippEnumString function converts a enum value to its keyword (string) equivalent.

    -

    Once you are done using the IPP response message, free it using the ippDelete function:

    -
    ippDelete(response);
    +

    The ippGetCount function returns the number of values in an attribute.

    +

    The ippGetInteger and ippGetString functions return a single integer or string value from an attribute.

    +

    The ippEnumString function converts a enum value to its keyword (string) equivalent.

    +

    Once you are done using the IPP response message, free it using the ippDelete function:

    +
    ippDelete(response);
     

    Authentication

    -

    CUPS normally handles authentication through the console. GUI applications should set a password callback using the cupsSetPasswordCB2 function:

    -
    void
    -cupsSetPasswordCB2(cups_password_cb2_t cb, void *user_data);
    +

    CUPS normally handles authentication through the console. GUI applications should set a password callback using the cupsSetPasswordCB2 function:

    +
    void
    +cupsSetPasswordCB2(cups_password_cb2_t cb, void *user_data);
     
    -

    The password callback will be called when needed and is responsible for setting the current user name using cupsSetUser and returning a string:

    -
    const char *
    -cups_password_cb2(const char *prompt, http_t *http,
    -                  const char *method, const char *resource,
    -                  void *user_data);
    +

    The password callback will be called when needed and is responsible for setting the current user name using cupsSetUser and returning a string:

    +
    const char *
    +cups_password_cb2(const char *prompt, http_t *http,
    +                  const char *method, const char *resource,
    +                  void *user_data);
     

    The prompt argument is a string from CUPS that should be displayed to the user.

    -

    The http argument is the connection hosting the request that is being authenticated. The password callback can call the httpGetField and httpGetSubField functions to look for additional details concerning the authentication challenge.

    +

    The http argument is the connection hosting the request that is being authenticated. The password callback can call the httpGetField and httpGetSubField functions to look for additional details concerning the authentication challenge.

    The method argument specifies the HTTP method used for the request and is typically "POST".

    The resource argument specifies the path used for the request.

    The user_data argument provides the user data pointer from the cupsSetPasswordCB2 call.

    +

    IPP Data File API

    +

    The IPP data file API provides functions to read and write IPP attributes and other commands or data using a common base format that supports tools such as ipptool and ippeveprinter.

    +

    Creating an IPP Data File

    +

    The ippFileNew function creates a new IPP data file (ipp_file_t) object:

    +
    ipp_file_t *parent = NULL;
    +void *data;
    +ipp_file_t *file = ippFileNew(parent, attr_cb, error_cb, data);
    +
    +

    The "parent" IPP data file pointer is typically used to support nested files and is normally NULL for a new file. The "data" argument supplies your application data to the callbacks. The "attr_cb" callback function is used to filter IPP attributes; return true to include the attribute and false to ignore it:

    +
    bool
    +attr_cb(ipp_file_t *file, void *cb_data, const char *name)
    +{
    +  ... determine whether to use an attribute named "name" ...
    +}
    +
    +

    The "error_cb" callback function is used to record/report errors when reading the file:

    +
    bool
    +error_cb(ipp_file_t *file, void *cb_data, const char *error)
    +{
    +  ... display/record error and return `true` to continue or `false` to stop ...
    +}
    +
    +

    Reading a Data File

    +

    The ippFileOpen function opens the specified data file and ippFileRead reads from it:

    +
    if (ippFileOpen(file, "somefile", "r"))
    +{
    +  // Opened successfully, now read it...
    +  ippFileRead(file, token_cb, /*with_groups*/false);
    +  ippFileClose(file);
    +}
    +
    +

    The token callback function passed to ippFileRead handles custom directives in your data file:

    +
    bool
    +token_cb(ipp_file_t *file, void *cb_data, const char *token)
    +{
    +  ... handle token, return `true` to continue or `false` to stop ...
    +}
    +
    +

    The "token" parameter contains the token to be processed. The callback can use the ippFileReadToken function to read additional tokens from the file and the ippFileExpandToken function to expand any variables in the token string. Return false to stop reading the file and true to continue. The default NULL callback reports an unknown token error through the error callback end returns false.

    +

    Once read, you call the ippFileGetAttributes function to get the IPP attributes from the file.

    +

    Variables

    +

    Each IPP data file object has associated variables that can be used when reading the file. The default set of variables is:

    +
      +
    • "date-current": Current date in ISO-8601 format

      +
    • +
    • "date-start": Start date (when file opened) in ISO-8601 format

      +
    • +
    • "filename": Associated data/document filename, if any

      +
    • +
    • "filetype": MIME media type of associated data/document filename, if any

      +
    • +
    • "hostname": Hostname or IP address from the "uri" value, if any

      +
    • +
    • "port": Port number from the "uri" value, if any

      +
    • +
    • "resource": Resource path from the "uri" value, if any

      +
    • +
    • "scheme": URI scheme from the "uri" value, if any

      +
    • +
    • "uri": URI, if any

      +
    • +
    • "uriuser": Username from the "uri" value, if any

      +
    • +
    • "uripassword": Password from the "uri" value, if any

      +
    • +
    • "user": Current login user

      +
    • +
    +

    The ippFileGetVar, ippFileSetVar, and ippFileSetVarf functions get and set file variables, respectively.

    +

    Writing IPP Data Files

    +

    As when reading an IPP data file, the ippFileNew function creates a new file object, ippFileOpen opens the file, and ippFileClose closes the file. However, you call ippFileWriteAttributes to write the attributes in an IPP message (ipp_t), ippFileWriteComment to write a comment in the file, and ippWriteToken or ippWriteTokenf to write a token or value to the file.

    Functions

    DllMain

    Main entry for library.

    diff --git a/scheduler/Makefile b/scheduler/Makefile index e00d62c8ec..9d6f3a02b3 100644 --- a/scheduler/Makefile +++ b/scheduler/Makefile @@ -101,17 +101,6 @@ libs: unittests: $(UNITTARGETS) -# -# Run unit tests... -# - -test: unittests - echo "Tests started at $(date)..." >test.log - echo Running MIME API tests... - ./testmime >>test.log - echo "Tests finished at $(date)..." >>test.log - - # # Clean all object files... # @@ -321,6 +310,17 @@ uninstall: fi +# +# Run unit tests... +# + +test: unittests + echo "Tests started at $(date)..." >test.log + echo Running MIME API tests... + ./testmime >>test.log + echo "Tests finished at $(date)..." >>test.log + + # # Make the scheduler executable, "cupsd". # diff --git a/scheduler/printers.c b/scheduler/printers.c index 7bca3bdc9b..fc0bc36c28 100644 --- a/scheduler/printers.c +++ b/scheduler/printers.c @@ -4485,7 +4485,8 @@ load_ppd(cupsd_printer_t *p) /* I - Printer */ for (media_col_ready = NULL, media_ready = NULL, i = p->pc->num_sizes, pwgsize = p->pc->sizes; i > 0; i --, pwgsize ++) { - ipp_t *col; // media-col-ready value + ipp_t *col; // media-col-ready value + char source[128]; // media-source value // Skip printer sizes that don't have a PPD size or aren't in the ready // sizes array... @@ -4501,6 +4502,13 @@ load_ppd(cupsd_printer_t *p) /* I - Printer */ // Add or append a media-col-ready value col = new_media_col(pwgsize); + // Add "media-source" for iOS 17 (Issue #738) + if (media_col_ready) + snprintf(source, sizeof(source), "auto.%d", ippGetCount(media_col_ready) + 1); + else + cupsCopyString(source, "auto", sizeof(source)); + ippAddString(col, IPP_TAG_PRINTER, IPP_TAG_KEYWORD, "media-source", NULL, source); + if (media_col_ready) ippSetCollection(p->ppd_attrs, &media_col_ready, ippGetCount(media_col_ready), col); else