/*
* "lpadmin" command for CUPS.
*
- * Copyright 2007-2016 by Apple Inc.
- * Copyright 1997-2006 by Easy Software Products.
+ * Copyright © 2007-2018 by Apple Inc.
+ * Copyright © 1997-2006 by Easy Software Products.
*
- * These coded instructions, statements, and computer programs are the
- * property of Apple Inc. and are protected by Federal copyright
- * law. Distribution and use rights are outlined in the file "LICENSE.txt"
- * which should have been included with this file. If this file is
- * missing or damaged, see the license at "http://www.cups.org/".
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
* Include necessary headers...
*/
-#define _CUPS_NO_DEPRECATED
-#define _PPD_DEPRECATED
#include <cups/cups-private.h>
#include <cups/ppd-private.h>
static int delete_printer_option(http_t *http, char *printer,
char *option);
static int enable_printer(http_t *http, char *printer);
-static char *get_printer_ppd(const char *uri, char *buffer, size_t bufsize);
+static char *get_printer_ppd(const char *uri, char *buffer, size_t bufsize, int *num_options, cups_option_t **options);
static cups_ptype_t get_printer_type(http_t *http, char *printer, char *uri,
size_t urisize);
static int set_printer_options(http_t *http, char *printer,
int num_options, cups_option_t *options,
- char *file);
+ char *file, int enable);
+static void usage(void) _CUPS_NORETURN;
static int validate_name(const char *name);
* 'main()' - Parse options and configure the scheduler.
*/
-int
-main(int argc, /* I - Number of command-line arguments */
- char *argv[]) /* I - Command-line arguments */
+int /* O - Exit status */
+main(int argc, /* I - Number of command-line arguments */
+ char *argv[]) /* I - Command-line arguments */
{
- int i; /* Looping var */
- http_t *http; /* Connection to server */
- char *printer, /* Destination printer */
- *pclass, /* Printer class name */
- *opt, /* Option pointer */
- *val; /* Pointer to allow/deny value */
- int num_options; /* Number of options */
- cups_option_t *options; /* Options */
- char *file, /* New PPD file */
- evefile[1024] = "";
- /* IPP Everywhere PPD */
- const char *ppd_name, /* ppd-name value */
- *device_uri; /* device-uri value */
+ int i; /* Looping var */
+ http_t *http; /* Connection to server */
+ char *printer, /* Destination printer */
+ *pclass, /* Printer class name */
+ *opt, /* Option pointer */
+ *val; /* Pointer to allow/deny value */
+ int enable = 0; /* Enable/resume printer? */
+ int num_options; /* Number of options */
+ cups_option_t *options; /* Options */
+ char *file, /* New PPD file */
+ evefile[1024] = ""; /* IPP Everywhere PPD */
+ const char *ppd_name, /* ppd-name value */
+ *device_uri; /* device-uri value */
_cupsSetLocale(argv);
for (i = 1; i < argc; i ++)
{
- if (argv[i][0] == '-')
+ if (!strcmp(argv[i], "--help"))
+ usage();
+ else if (argv[i][0] == '-')
{
for (opt = argv[i] + 1; *opt; opt ++)
{
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected class name after \"-c\" option."));
- return (1);
+ usage();
}
pclass = argv[i];
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected printer name after \"-d\" option."));
- return (1);
+ usage();
}
printer = argv[i];
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected hostname after \"-h\" option."));
- return (1);
+ usage();
}
cupsSetServer(argv[i]);
if (i >= argc)
{
_cupsLangPrintf(stderr, _("lpadmin: Expected PPD after \"-%c\" option."), argv[i - 1][1]);
- return (1);
+ usage();
}
file = argv[i];
}
+
+ if (*opt == 'i')
+ {
+ /*
+ * Check to see that the specified file is, in fact, a PPD...
+ */
+
+ cups_file_t *fp = cupsFileOpen(file, "r");
+ char line[256];
+
+ if (!cupsFileGets(fp, line, sizeof(line)) || strncmp(line, "*PPD-Adobe", 10))
+ {
+ _cupsLangPuts(stderr, _("lpadmin: System V interface scripts are no longer supported for security reasons."));
+ cupsFileClose(fp);
+ return (1);
+ }
+
+ cupsFileClose(fp);
+ }
break;
case 'E' : /* Enable the printer/enable encryption */
}
}
- if (enable_printer(http, printer))
- return (1);
+ enable = 1;
break;
case 'm' : /* Use the specified standard script/PPD file */
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected model after \"-m\" option."));
- return (1);
+ usage();
}
num_options = cupsAddOption("ppd-name", argv[i], num_options, &options);
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected name=value after \"-o\" option."));
- return (1);
+ usage();
}
num_options = cupsParseOptions(argv[i], num_options, &options);
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected printer after \"-p\" option."));
- return (1);
+ usage();
}
printer = argv[i];
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected class after \"-r\" option."));
- return (1);
+ usage();
}
pclass = argv[i];
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected name after \"-R\" option."));
- return (1);
+ usage();
}
val = argv[i];
if (i >= argc)
{
_cupsLangPrintf(stderr, _("%s: Error - expected username after \"-U\" option."), argv[0]);
- return (1);
+ usage();
}
cupsSetUser(argv[i]);
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected allow/deny:userlist after \"-u\" option."));
- return (1);
+ usage();
}
val = argv[i];
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected device URI after \"-v\" option."));
- return (1);
+ usage();
}
num_options = cupsAddOption("device-uri", argv[i], num_options, &options);
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected printer or class after \"-x\" option."));
- return (1);
+ usage();
}
printer = argv[i];
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected description after \"-D\" option."));
- return (1);
+ usage();
}
num_options = cupsAddOption("printer-info", argv[i], num_options, &options);
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected file type(s) after \"-I\" option."));
- return (1);
+ usage();
}
_cupsLangPuts(stderr, _("lpadmin: Warning - content type list ignored."));
if (i >= argc)
{
_cupsLangPuts(stderr, _("lpadmin: Expected location after \"-L\" option."));
- return (1);
+ usage();
}
num_options = cupsAddOption("printer-location", argv[i], num_options, &options);
default :
_cupsLangPrintf(stderr, _("lpadmin: Unknown option \"%c\"."), *opt);
- return (1);
+ usage();
}
}
}
else
{
_cupsLangPrintf(stderr, _("lpadmin: Unknown argument \"%s\"."), argv[i]);
- return (1);
+ usage();
}
}
* Set options as needed...
*/
- if ((ppd_name = cupsGetOption("ppd-name", num_options, options)) != NULL && !strcmp(ppd_name, "everywhere") && (device_uri = cupsGetOption("device-uri", num_options, options)) != NULL)
+ ppd_name = cupsGetOption("ppd-name", num_options, options);
+ device_uri = cupsGetOption("device-uri", num_options, options);
+
+ if (ppd_name && !strcmp(ppd_name, "raw"))
{
- if ((file = get_printer_ppd(device_uri, evefile, sizeof(evefile))) == NULL)
+#ifdef __APPLE__
+ _cupsLangPuts(stderr, _("lpadmin: Raw queues are no longer supported on macOS."));
+#else
+ _cupsLangPuts(stderr, _("lpadmin: Raw queues are deprecated and will stop working in a future version of CUPS."));
+#endif /* __APPLE__ */
+
+ if (device_uri && (!strncmp(device_uri, "ipp://", 6) || !strncmp(device_uri, "ipps://", 7)) && strstr(device_uri, "/printers/"))
+ _cupsLangPuts(stderr, _("lpadmin: Use the 'everywhere' model for shared printers."));
+
+#ifdef __APPLE__
+ return (1);
+#endif /* __APPLE__ */
+ }
+ else if (ppd_name && !strcmp(ppd_name, "everywhere") && device_uri)
+ {
+ if ((file = get_printer_ppd(device_uri, evefile, sizeof(evefile), &num_options, &options)) == NULL)
return (1);
num_options = cupsRemoveOption("ppd-name", num_options, &options);
}
+ else if (ppd_name || file)
+ {
+ _cupsLangPuts(stderr, _("lpadmin: Printer drivers are deprecated and will stop working in a future version of CUPS."));
+ }
if (num_options || file)
{
- if (!http)
- {
- http = httpConnect2(cupsServer(), ippPort(), NULL, AF_UNSPEC, cupsEncryption(), 1, 30000, NULL);
-
- if (http == NULL)
- {
- _cupsLangPrintf(stderr,
- _("lpadmin: Unable to connect to server: %s"),
- strerror(errno));
- return (1);
- }
- }
-
if (printer == NULL)
{
_cupsLangPuts(stderr,
_("lpadmin: Unable to set the printer options:\n"
- " You must specify a printer name first."));
+ " You must specify a printer name first."));
return (1);
}
- if (set_printer_options(http, printer, num_options, options, file))
+ if (!http)
+ {
+ http = httpConnect2(cupsServer(), ippPort(), NULL, AF_UNSPEC,
+ cupsEncryption(), 1, 30000, NULL);
+
+ if (http == NULL) {
+ _cupsLangPrintf(stderr, _("lpadmin: Unable to connect to server: %s"),
+ strerror(errno));
+ return (1);
+ }
+ }
+
+ if (set_printer_options(http, printer, num_options, options, file, enable))
return (1);
}
+ else if (enable && enable_printer(http, printer))
+ return (1);
if (evefile[0])
unlink(evefile);
char uri[HTTP_MAX_URI]; /* URI for printer/class */
- DEBUG_printf(("add_printer_to_class(%p, \"%s\", \"%s\")\n", http,
- printer, pclass));
-
/*
* Build an IPP_OP_GET_PRINTER_ATTRIBUTES request, which requires the following
* attributes:
char uri[HTTP_MAX_URI]; /* URI for printer/class */
- DEBUG_printf(("default_printer(%p, \"%s\")\n", http, printer));
-
/*
* Build a CUPS-Set-Default request, which requires the following
* attributes:
char uri[HTTP_MAX_URI]; /* URI for printer/class */
- DEBUG_printf(("delete_printer(%p, \"%s\")\n", http, printer));
-
/*
* Build a CUPS-Delete-Printer request, which requires the following
* attributes:
char uri[HTTP_MAX_URI]; /* URI for printer/class */
- DEBUG_printf(("delete_printer_from_class(%p, \"%s\", \"%s\")\n", http,
- printer, pclass));
-
/*
* Build an IPP_OP_GET_PRINTER_ATTRIBUTES request, which requires the following
* attributes:
char uri[HTTP_MAX_URI]; /* URI for printer/class */
- DEBUG_printf(("enable_printer(%p, \"%s\")\n", http, printer));
-
/*
- * Build a IPP_OP_CUPS_ADD_MODIFY_PRINTER or IPP_OP_CUPS_ADD_MODIFY_CLASS request, which
+ * Send IPP_OP_ENABLE_PRINTER and IPP_OP_RESUME_PRINTER requests, which
* require the following attributes:
*
* attributes-charset
* attributes-natural-language
* printer-uri
* requesting-user-name
- * printer-state
- * printer-is-accepting-jobs
*/
- if (get_printer_type(http, printer, uri, sizeof(uri)) & CUPS_PRINTER_CLASS)
- request = ippNewRequest(IPP_OP_CUPS_ADD_MODIFY_CLASS);
- else
- request = ippNewRequest(IPP_OP_CUPS_ADD_MODIFY_PRINTER);
+ request = ippNewRequest(IPP_OP_ENABLE_PRINTER);
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI,
- "printer-uri", NULL, uri);
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
- "requesting-user-name", NULL, cupsUser());
- ippAddInteger(request, IPP_TAG_PRINTER, IPP_TAG_ENUM, "printer-state",
- IPP_PSTATE_IDLE);
- ippAddBoolean(request, IPP_TAG_PRINTER, "printer-is-accepting-jobs", 1);
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL, uri);
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name", NULL, cupsUser());
- /*
- * Do the request and get back a response...
- */
+ ippDelete(cupsDoRequest(http, request, "/admin/"));
+
+ if (cupsLastError() > IPP_STATUS_OK_CONFLICTING)
+ {
+ _cupsLangPrintf(stderr, _("%s: %s"), "lpadmin", cupsLastErrorString());
+
+ return (1);
+ }
+
+ request = ippNewRequest(IPP_OP_RESUME_PRINTER);
+
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL, uri);
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name", NULL, cupsUser());
ippDelete(cupsDoRequest(http, request, "/admin/"));
return (1);
}
- else
- return (0);
+
+ return (0);
}
* 'get_printer_ppd()' - Get an IPP Everywhere PPD file for the given URI.
*/
-static char * /* O - Filename or NULL */
-get_printer_ppd(const char *uri, /* I - Printer URI */
- char *buffer, /* I - Filename buffer */
- size_t bufsize) /* I - Size of filename buffer */
+static char * /* O - Filename or NULL */
+get_printer_ppd(
+ const char *uri, /* I - Printer URI */
+ char *buffer, /* I - Filename buffer */
+ size_t bufsize, /* I - Size of filename buffer */
+ int *num_options, /* IO - Number of options */
+ cups_option_t **options) /* IO - Options */
{
http_t *http; /* Connection to printer */
ipp_t *request, /* Get-Printer-Attributes request */
*response; /* Get-Printer-Attributes response */
+ ipp_attribute_t *attr; /* Attribute from response */
char resolved[1024], /* Resolved URI */
scheme[32], /* URI scheme */
userpass[256], /* Username:password */
host[256], /* Hostname */
resource[256]; /* Resource path */
int port; /* Port number */
+ static const char * const pattrs[] = /* Attributes to use */
+ {
+ "job-template",
+ "printer-defaults",
+ "printer-description",
+ "media-col-database"
+ };
/*
request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES);
ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL, uri);
+ ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD, "requested-attributes", sizeof(pattrs) / sizeof(pattrs[0]), NULL, pattrs);
response = cupsDoRequest(http, request, resource);
- if (!_ppdCreateFromIPP(buffer, bufsize, response))
+ if (cupsLastError() >= IPP_STATUS_REDIRECTION_OTHER_SITE)
+ {
+ _cupsLangPrintf(stderr, _("%s: Unable to query printer: %s"), "lpadmin", cupsLastErrorString());
+ buffer[0] = '\0';
+ }
+ else if (_ppdCreateFromIPP(buffer, bufsize, response))
+ {
+ if (!cupsGetOption("printer-geo-location", *num_options, *options) && (attr = ippFindAttribute(response, "printer-geo-location", IPP_TAG_URI)) != NULL)
+ *num_options = cupsAddOption("printer-geo-location", ippGetString(attr, 0, NULL), *num_options, options);
+
+ if (!cupsGetOption("printer-info", *num_options, *options) && (attr = ippFindAttribute(response, "printer-info", IPP_TAG_TEXT)) != NULL)
+ *num_options = cupsAddOption("printer-info", ippGetString(attr, 0, NULL), *num_options, options);
+
+ if (!cupsGetOption("printer-location", *num_options, *options) && (attr = ippFindAttribute(response, "printer-location", IPP_TAG_TEXT)) != NULL)
+ *num_options = cupsAddOption("printer-location", ippGetString(attr, 0, NULL), *num_options, options);
+ }
+ else
_cupsLangPrintf(stderr, _("%s: Unable to create PPD file: %s"), "lpadmin", strerror(errno));
ippDelete(response);
char *printer, /* I - Printer */
int num_options, /* I - Number of options */
cups_option_t *options, /* I - Options */
- char *file) /* I - PPD file/interface script */
+ char *file, /* I - PPD file */
+ int enable) /* I - Enable printer? */
{
ipp_t *request; /* IPP Request */
const char *ppdfile; /* PPD filename */
copied_options = 0; /* Copied options? */
- DEBUG_printf(("set_printer_options(http=%p, printer=\"%s\", num_options=%d, "
- "options=%p, file=\"%s\")\n", http, printer, num_options,
- options, file));
-
/*
* Build a CUPS-Add-Modify-Printer or CUPS-Add-Modify-Class request,
* which requires the following attributes:
ppdfile = NULL;
cupsEncodeOptions2(request, num_options, options, IPP_TAG_OPERATION);
+
+ if (enable)
+ {
+ ippAddInteger(request, IPP_TAG_PRINTER, IPP_TAG_ENUM, "printer-state", IPP_PSTATE_IDLE);
+ ippAddBoolean(request, IPP_TAG_PRINTER, "printer-is-accepting-jobs", 1);
+ }
+
cupsEncodeOptions2(request, num_options, options, IPP_TAG_PRINTER);
if ((protocol = cupsGetOption("protocol", num_options, options)) != NULL)
}
+/*
+ * 'usage()' - Show program usage and exit.
+ */
+
+static void
+usage(void)
+{
+ _cupsLangPuts(stdout, _("Usage: lpadmin [options] -d destination\n"
+ " lpadmin [options] -p destination\n"
+ " lpadmin [options] -p destination -c class\n"
+ " lpadmin [options] -p destination -r class\n"
+ " lpadmin [options] -x destination"));
+ _cupsLangPuts(stdout, _("Options:"));
+ _cupsLangPuts(stdout, _("-c class Add the named destination to a class"));
+ _cupsLangPuts(stdout, _("-d destination Set the named destination as the server default"));
+ _cupsLangPuts(stdout, _("-D description Specify the textual description of the printer"));
+ _cupsLangPuts(stdout, _("-E Encrypt the connection to the server"));
+ _cupsLangPuts(stdout, _("-E Enable and accept jobs on the printer (after -p)"));
+ _cupsLangPuts(stdout, _("-h server[:port] Connect to the named server and port"));
+ _cupsLangPuts(stdout, _("-i ppd-file Specify a PPD file for the printer"));
+ _cupsLangPuts(stdout, _("-L location Specify the textual location of the printer"));
+ _cupsLangPuts(stdout, _("-m model Specify a standard model/PPD file for the printer"));
+ _cupsLangPuts(stdout, _("-m everywhere Specify the printer is compatible with IPP Everywhere"));
+ _cupsLangPuts(stdout, _("-o name-default=value Specify the default value for the named option"));
+ _cupsLangPuts(stdout, _("-o Name=Value Specify the default value for the named PPD option "));
+ _cupsLangPuts(stdout, _("-o cupsIPPSupplies=false\n"
+ " Disable supply level reporting via IPP"));
+ _cupsLangPuts(stdout, _("-o cupsSNMPSupplies=false\n"
+ " Disable supply level reporting via SNMP"));
+ _cupsLangPuts(stdout, _("-o job-k-limit=N Specify the kilobyte limit for per-user quotas"));
+ _cupsLangPuts(stdout, _("-o job-page-limit=N Specify the page limit for per-user quotas"));
+ _cupsLangPuts(stdout, _("-o job-quota-period=N Specify the per-user quota period in seconds"));
+ _cupsLangPuts(stdout, _("-o printer-error-policy=name\n"
+ " Specify the printer error policy"));
+ _cupsLangPuts(stdout, _("-o printer-is-shared=true\n"
+ " Share the printer"));
+ _cupsLangPuts(stdout, _("-o printer-op-policy=name\n"
+ " Specify the printer operation policy"));
+ _cupsLangPuts(stdout, _("-p destination Specify/add the named destination"));
+ _cupsLangPuts(stdout, _("-r class Remove the named destination from a class"));
+ _cupsLangPuts(stdout, _("-R name-default Remove the default value for the named option"));
+ _cupsLangPuts(stdout, _("-u allow:all Allow all users to print"));
+ _cupsLangPuts(stdout, _("-u allow:list Allow the list of users or groups (@name) to print"));
+ _cupsLangPuts(stdout, _("-u deny:list Prevent the list of users or groups (@name) to print"));
+ _cupsLangPuts(stdout, _("-U username Specify the username to use for authentication"));
+ _cupsLangPuts(stdout, _("-v device-uri Specify the device URI for the printer"));
+ _cupsLangPuts(stdout, _("-x destination Remove the named destination"));
+
+ exit(1);
+}
+
+
/*
* 'validate_name()' - Make sure the printer name only contains valid chars.
*/
for (ptr = name; *ptr; ptr ++)
if (*ptr == '@')
break;
- else if ((*ptr >= 0 && *ptr <= ' ') || *ptr == 127 || *ptr == '/' ||
- *ptr == '#')
+ else if ((*ptr >= 0 && *ptr <= ' ') || *ptr == 127 || *ptr == '/' || *ptr == '\\' || *ptr == '?' || *ptr == '\'' || *ptr == '\"' || *ptr == '#')
return (0);
/*