Add a --user-agent option to the ipptool command.

Author: michaelrsweet

CHANGES.md

@@ -7,6 +7,7 @@ libcups v3.0.0 (YYYY-MM-DD)
 - Added `cupsOAuthGetDeviceGrant`, `cupsOAuthGetJWKS`, and `cupsOAuthGetUserId`
   APIs.
 - Added `httpGetCookieValue` and `httpGetSecurity` APIs.
+- Added a "--user-agent" option to the `ipptool` command.
 - Updated documentation (Issue #113)
 - Updated the `cupsOAuth` APIs to support sharing of some OAuth values between
   the system (root) and per-user cache values.

doc/ipptool.html

@@ -115,6 +115,9 @@ <h2 id="ipptool-1.synopsis">Synopsis</h2>
 ] [
 <strong>--stop-after-include-error</strong>
 ] [
+<strong>--user-agent</strong>
+<em>USER-AGENT</em>
+] [
 <strong>--version</strong>
 ] [
 <strong>-4</strong>
@@ -215,6 +218,15 @@ <h2 id="ipptool-1.options">Options</h2>
 to stop if an error occurs in an included file. Normally
 <strong>ipptool</strong>
 will continue with subsequent tests after the INCLUDE directive.
+</p>
+    <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>--user-agent </strong><em>USER-AGENT</em><br>
+Specifies the HTTP User-Agent string to use.
+The default is based on the
+<strong>UserAgentTokens</strong>
+value in the
+<a href="client.conf.html"><strong>client.conf</strong>(5)</a>
+
+file.
 </p>
     <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>--version</strong><br>
 Shows the version of
@@ -411,13 +423,15 @@ <h2 id="ipptool-1.examples">Examples</h2>
         ipp://localhost/printers/myprinter create-printer-subscription.test
 </pre>
     <h2 id="ipptool-1.see-also">See Also</h2>
-<a href="ipptoolfile.html"><p><strong>ipptoolfile</strong>(5),</a>
+<a href="client.conf.html"><p><strong>client.conf</strong>(5),</a>
+
+<a href="ipptoolfile.html"><strong>ipptoolfile</strong>(5),</a>
 
 IANA IPP Registry (<a href="https://www.iana.org/assignments/ipp-registrations">https://www.iana.org/assignments/ipp-registrations</a>),
 PWG Internet Printing Protocol Workgroup (<a href="https://www.pwg.org/ipp">https://www.pwg.org/ipp</a>),
 RFC 8011 (<a href="https://datatracker.ietf.org/doc/html/rfc8011">https://datatracker.ietf.org/doc/html/rfc8011</a>)
 </p>
     <h2 id="ipptool-1.copyright">Copyright</h2>
-<p>Copyright &copy; 2021-2024 by OpenPrinting.
+<p>Copyright &copy; 2021-2025 by OpenPrinting.
   </body>
 </html>

man/ipptool.1

@@ -26,6 +26,9 @@ ipptool \- perform internet printing protocol requests
 ] [
 .B \-\-stop\-after\-include\-error
 ] [
+.B \-\-user\-agent
+.I USER-AGENT
+] [
 .B \-\-version
 ] [
 .B \-4
@@ -123,6 +126,14 @@ to stop if an error occurs in an included file. Normally
 .B ipptool
 will continue with subsequent tests after the INCLUDE directive.
 .TP 5
+\fB\-\-user\-agent \fIUSER-AGENT\fR
+Specifies the HTTP User-Agent string to use.
+The default is based on the
+.B UserAgentTokens
+value in the
+.BR client.conf (5)
+file.
+.TP 5
 .B \-\-version
 Shows the version of
 .B ipptool
@@ -310,9 +321,10 @@ Send email notifications to "user@example.com" when "myprinter" changes:
         ipp://localhost/printers/myprinter create\-printer\-subscription.test
 .fi
 .SH SEE ALSO
+.BR client.conf (5),
 .BR ipptoolfile (5),
 IANA IPP Registry (https://www.iana.org/assignments/ipp\-registrations),
 PWG Internet Printing Protocol Workgroup (https://www.pwg.org/ipp),
 RFC 8011 (https://datatracker.ietf.org/doc/html/rfc8011)
 .SH COPYRIGHT
-Copyright \[co] 2021-2024 by OpenPrinting.
+Copyright \[co] 2021-2025 by OpenPrinting.

tools/ipptool.c

@@ -149,7 +149,8 @@ typedef struct ipptool_test_s		// Test Data
   int		verbosity;		// Show all attributes?
 
   char		*bearer_token,		// HTTP Bearer token
-		*client_name;		// TLS client certificate name
+		*client_name,		// TLS client certificate name
+		*user_agent;		// HTTP User-Agent value, if any
 
   // Test Defaults
   bool		def_ignore_errors;	// Default IGNORE-ERRORS value
@@ -379,6 +380,19 @@ main(int  argc,				// I - Number of command-line args
     {
       data->stop_after_include_error = true;
     }
+    else if (!strcmp(argv[i], "--user-agent"))
+    {
+      i ++;
+
+      if (i >= argc)
+      {
+	cupsLangPrintf(stderr, _("%s: Missing user agent after '--user-agent'."), "ipptool");
+	free_data(data);
+	return (usage(stderr));
+      }
+
+      data->user_agent = argv[i];
+    }
     else if (!strcmp(argv[i], "--version"))
     {
       puts(LIBCUPS_VERSION);
@@ -1055,6 +1069,9 @@ connect_printer(ipptool_test_t *data)	// I - Test data
 
   httpSetDefaultField(http, HTTP_FIELD_ACCEPT_ENCODING, "deflate, gzip, identity");
 
+  if (data->user_agent)
+    httpSetDefaultField(http, HTTP_FIELD_USER_AGENT, data->user_agent);
+
   if (data->timeout > 0.0)
     httpSetTimeout(http, data->timeout, timeout_cb, NULL);
 
@@ -6597,6 +6614,7 @@ usage(FILE *out)
   cupsLangPuts(out, _("--help                         Show this help"));
   cupsLangPuts(out, _("--ippfile FILENAME             Produce IPP attribute file"));
   cupsLangPuts(out, _("--stop-after-include-error     Stop tests after a failed INCLUDE"));
+  cupsLangPuts(out, _("--user-agent USER-AGENT        Set the HTTP User-Agent string"));
   cupsLangPuts(out, _("--version                      Show the program version"));
   cupsLangPuts(out, _("-4                             Connect using IPv4"));
   cupsLangPuts(out, _("-6                             Connect using IPv6"));