8181571: printing to CUPS fails on mac sandbox app #4861

AlexanderScherbatiy · 2021-07-21T15:45:55Z

The issue is reproduced on macOS Big Sur 11.0.1 with jdk 16.0.1+9.

Create a native macOS app from the Hello.java file, sign and run it in sandbox:

import javax.print.*;
import javax.swing.*;

public class Hello {

    public static void main(String[] args) throws Exception {
        SwingUtilities.invokeAndWait(() -> {
            boolean isSandboxed = System.getenv("APP_SANDBOX_CONTAINER_ID") != null;
            PrintService defaultPrinter = PrintServiceLookup.lookupDefaultPrintService();
            PrintService[] services = PrintServiceLookup.lookupPrintServices(null, null);

            StringBuilder builder = new StringBuilder();
            builder.append("is sandboxed: ").append(isSandboxed).append("\n");
            builder.append("default printer: ").append(defaultPrinter).append("\n");
            int size = services.length;
            for (int i = 0; i < size; i++) {
                builder.append("printer[").append(i).append("]=").append(services[i]).append("\n");
            }
            JOptionPane.showMessageDialog(null, builder.toString());
        });
    }
}

The signed app in sandbox shows null default printer and PrintServiceLookup.lookupPrintServices(null, null) returns "Unix Printer: lp".

The problem has been discussed on 2d-dev mail list:
https://mail.openjdk.java.net/pipermail/2d-dev/2017-June/008375.html
https://mail.openjdk.java.net/pipermail/2d-dev/2017-July/008418.html

According to the discussion:

I've submitted a DTS incident to Apple and a friend there has followed-up.
Their unofficial position is that java should be connecting to the cups interface returned
by the cupsServer() function and not changing the interface string to "localhost".
Security changes in 10.12.4 reject the TCP connection which they say confuses
network-client access with print access. They don't seem interested in loosening that change.

The proposed solution is to use the domain socket pathname in httpConnect(...) cups function and cupsGetDests(...) to get list of printers from cups when the app is signed and is run in sandbox on MacOs.

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed

Issue

JDK-8181571: printing to CUPS fails on mac sandbox app

Reviewers

Phil Race (@prrace - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/4861/head:pull/4861
$ git checkout pull/4861

Update a local copy of the PR:
$ git checkout pull/4861
$ git pull https://git.openjdk.java.net/jdk pull/4861/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 4861

View PR using the GUI difftool:
$ git pr show -t 4861

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/4861.diff

bridgekeeper · 2021-07-21T15:47:03Z

👋 Welcome back alexsch! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2021-07-21T15:49:50Z

@AlexanderScherbatiy The following label will be automatically applied to this pull request:

2d

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

mlbridge · 2021-07-21T15:54:02Z

Webrevs

AlexanderScherbatiy · 2021-07-21T16:45:52Z

It is not clear how to write a test (automated or manual) for the fix.
To check the fix it is necessary to sign a native app on macOS, install it, and run it.

I run automated and manual test/jdk/java/awt/print and java/awt/PrintJob tests on macOS Big Sur 11.0.1 with the fix but they do not test the new behavior where a domain socket path name is used because tests are not run in sandbox.

The automated test/jdk/java/awt/print and java/awt/PrintJob tests pass.

The following manual tests fail with and without the fix:

java/awt/print/Dialog/DialogCopies.java                                               Failed. Execution failed: `main' threw exception: java.lang.RuntimeException: Copies not incremented
java/awt/print/Dialog/PrintDlgApp.java                                                Failed. Execution failed: `main' threw exception: java.lang.RuntimeException: No file created
java/awt/print/PrinterJob/PageDlgApp.java                                             Failed. Execution failed: `main' threw exception: java.lang.RuntimeException: PrinterJob.pageDialog(PrintRequestAttributeSet) does not return null when dialog is cancelled
java/awt/print/PrinterJob/PrintDialogCancel.java                                      Failed. Execution failed: `main' threw exception: java.lang.RuntimeException: User pressed cancel, but true returned
java/awt/print/PrinterJob/RadialGradientPrintingTest.java                             Failed. Unexpected exit from test [exit code: 0]
java/awt/print/Dialog/DialogOrient.java                                               Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/Dialog/DialogType.java                                                 Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/Dialog/PrintDlgPageable.java                                           Error. java.lang.IllegalAccessException: class com.sun.javatest.regtest.agent.MainWrapper$MainThread cannot access a member of class PrintDlgPageable with modifiers "public static"
java/awt/print/PrinterJob/ImagePrinting/ClippedImages.java                            Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/PrinterJob/ImagePrinting/ImageTypes.java                               Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/PrinterJob/ImagePrinting/PrintARGBImage.java                           Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/PrinterJob/PageDialogTest.java                                         Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/PrinterJob/PageRanges.java                                             Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/PrinterJob/PageRangesDlgTest.java                                      Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/PrinterJob/PrintGlyphVectorTest.java                                   Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/PrinterJob/PrintLatinCJKTest.java                                      Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/PrinterJob/PrintTextTest.java                                          Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/print/PrinterJob/SwingUIText.java                                            Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/PrintJob/ConstrainedPrintingTest/ConstrainedPrintingTest.java    Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/PrintJob/PageSetupDlgBlockingTest/PageSetupDlgBlockingTest.java  Error. Parse Exception: Arguments to `manual' option not supported: yesno
java/awt/PrintJob/PrintCheckboxTest/PrintCheckboxManualTest.java          Error. Can't find HTML file: /Users/sample/openjdk/jdk-cups/test/jdk/java/awt/PrintJob/PrintCheckboxTest/PrintCheckboxManualTest.html
java/awt/PrintJob/SaveDialogTitleTest.java                                Error. Parse Exception: Arguments to `manual' option not supported: yesno

AlexanderScherbatiy · 2021-07-22T09:08:07Z

/label awt,2d

openjdk · 2021-07-22T09:08:32Z

@AlexanderScherbatiy
The awt label was successfully added.
The 2d label was already applied.

AlexanderScherbatiy · 2021-07-22T09:14:51Z

/cc 2d

openjdk · 2021-07-22T09:15:16Z

@AlexanderScherbatiy The 2d label was already applied.

NikolayTach · 2021-07-28T17:18:12Z

JDK-8247768
Same here played 6 times yet moved, 8 issues missed.

AlexanderScherbatiy · 2021-08-05T19:20:34Z

JDK-8247768
Same here played 6 times yet moved, 8 issues missed.

What is the relation between JDK-8247768 and the current pull request?
Should something be updated in the pull request description?

prrace · 2021-08-12T19:30:42Z

src/java.desktop/unix/classes/sun/print/CUPSPrinter.java

+    private static String getDomainSocketPathname() {
+        return domainSocketPathname;
+    }
+


You will need to suppress deprecation warnings here.

Should I add @SuppressWarnings("deprecation") to the getDomainSocketPathname() method?

@SuppressWarnings("removal") is added for the isSandboxedApp() method.

prrace · 2021-08-12T19:31:12Z

src/java.desktop/unix/classes/sun/print/CUPSPrinter.java

-            IPPPrintService.debug_println(debugPrefix+"CUPS server "+getServer()+
-                                          " port "+getPort());
-            return canConnect(getServer(), getPort());
+            String server = getDomainSocketPathname() != null ? getDomainSocketPathname() : getServer();


Split this long line

prrace · 2021-08-12T19:34:44Z

src/java.desktop/unix/classes/sun/print/CUPSPrinter.java

@@ -92,6 +94,13 @@ public Void run() {
        libFound = initIDs();
        if (libFound) {
           cupsServer = getCupsServer();


I think we should wrap all the new lines in isMac()
Also can you explain the reasons for the logic that implies we may have a server starting with "/"
in which case your always change the cupServer to localhost even if it is not sandboxed ?

I ask because it seems to contradict what you pasted
"by the cupsServer() function and not changing the interface string to "localhost""

The logic which replaces a server starting with "/" to localhost is the original logic which is implemented in native level in the getCupsServer() function:

jdk/src/java.desktop/unix/native/common/awt/CUPSfuncs.c

Line 176 in f608e81

if (strncmp(server, "/", 1) == 0) {

The fix only moves this logic to the java level to store domainSocketPathname in case of sandboxed app on MacOS.

prrace · 2021-08-12T19:41:34Z

src/java.desktop/unix/classes/sun/print/CUPSPrinter.java

+                }
+                return printerURIs;
+            }
+        }


So if getCupsDefaultPrinters() doesn't find anything you always continue to the original code even though
it would seem that you know we are in a sandboxed app and it won't find anything ?

I updated the code to return null in case there are no printer names from j2d_cupsGetDests() function in a sandboxed on MacOS.

prrace · 2021-08-12T19:47:59Z

src/java.desktop/unix/native/common/awt/CUPSfuncs.c

+        j2d_cupsFreeDests(num_dests, dests);
+        DPRINTF("CUPSfuncs::bad alloc new array\n", "")
+        (*env)->ExceptionClear(env);
+        JNU_ThrowOutOfMemoryError(env, "OutOfMemoryError");


I find this weird. What is the ExceptionClear for ? The only possible exception here is for
an OOME which might be thrown by NewObjectArray. So you clear that and then re-create it ?
And who do will catch this ? What's the point ? Maybe just clear and return null.

The array creation error handling is implemented in the similar way as it is done in the getMedia() function.
The ExceptionClear() has been added to the getMedia() by 8031001: [Parfait] warnings from b121 for jdk/src/solaris/native/sun/awt: JNI-related warnings
I would prefer to have unified error handling in these methods. If ExceptionClear is not suitable in this place it would be better to recheck JDK-8031001 and update all places accordingly in a separate fix.

I can't agree with the apparent reasoning that "well that thing over there is wrong, so it's ok for me to add something here that's wrong too".

And the getMedia(..) case is different. It doesn't re-create the same exception.
It wants to create an OOME which is not actually thrown by GetStringUTFChars() since it needs to throw some exception and with an appropriate string reason.
And the clear there is just prudence since it is creating a new one and can't be 100% sure there isn't one pending.

In your case the JNI spec documents OOME
https://docs.oracle.com/en/java/javase/17/docs/specs/jni/functions.html#newobjectarray

So in your case it is pointless. Please just remote the Clear()

ExceptionClear(env) is removed from the if (nameArray == NULL) check.

I should have said (as I did in the beginning) remove the clear - and the new throw - and just return null.

JNU_ThrowOutOfMemoryError is removed from code where nameArray and utf_str are checked to NULL.

prrace · 2021-08-12T19:50:37Z

src/java.desktop/unix/native/common/awt/CUPSfuncs.c

+            if (utf_str == NULL) {
+                j2d_cupsFreeDests(num_dests, dests);
+                DPRINTF("CUPSfuncs::bad alloc new string ->name\n", "")
+                JNU_ThrowOutOfMemoryError(env, "OutOfMemoryError");


similar comments to above plus I am fairly sure you want to delete nameArray since it isn't returned.
For that matter if the NewString fails on the 4th printer you want to free the 3 previous ones too before returning.

The code is updated to remove previously created strings and clear the nameArray in case of an error during new string creation.

bridgekeeper · 2021-09-22T00:33:22Z

@AlexanderScherbatiy This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

AlexanderScherbatiy · 2021-09-29T09:58:04Z

/label client

openjdk · 2021-09-29T09:59:09Z

@AlexanderScherbatiy
The client label was successfully added.

AlexanderScherbatiy · 2021-09-29T12:36:39Z

/label remove awt,2d

openjdk · 2021-09-29T12:37:33Z

@AlexanderScherbatiy The label awt is not a valid label. These labels are valid:

serviceability
hotspot
hotspot-compiler
ide-support
kulla
i18n
shenandoah
jdk
javadoc
security
hotspot-runtime
jmx
build
nio
client
core-libs
compiler
net
hotspot-gc
hotspot-jfr

AlexanderScherbatiy · 2021-10-08T11:22:32Z

Just some more details about code in CUPSPrinter class static initialization.

The getCupsServer() native method from CUPSPrinter calls j2d_cupsServer() function to get the cups server. If the server name starts with "/" it is replaced to "localhost"

jdk/src/java.desktop/unix/native/common/awt/CUPSfuncs.c

Line 176 in f608e81

if (strncmp(server, "/", 1) == 0) {

To keep the domain socket path name from j2d_cupsServer() call the fix moves the cups server name handling to the java side. The original domain socket path name is preserved in the CUPSPrinter class only for MacOS when sandboxed app is used.

bridgekeeper · 2021-11-05T14:01:27Z

@AlexanderScherbatiy This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

AlexanderScherbatiy · 2021-11-24T12:26:32Z

Just a question. Should the fix have 2 reviewers?

bridgekeeper · 2021-12-22T14:00:27Z

@AlexanderScherbatiy This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

AlexanderScherbatiy · 2022-01-14T15:08:11Z

I see that the fix has been inactive for several months.
Is there something that I missed and should update from my side (add comments, answer on questions, update commits, or something else)?

bridgekeeper · 2022-02-11T21:15:32Z

@AlexanderScherbatiy This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

bridgekeeper · 2022-03-12T01:26:51Z

@AlexanderScherbatiy This pull request has been inactive for more than 8 weeks and will now be automatically closed. If you would like to continue working on this pull request in the future, feel free to reopen it! This can be done using the /open pull request command.

AlexanderScherbatiy · 2022-03-25T13:15:28Z

/open

openjdk · 2022-03-25T13:15:49Z

@AlexanderScherbatiy This pull request is now open

openjdk · 2022-03-29T16:48:53Z

@AlexanderScherbatiy This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8181571: printing to CUPS fails on mac sandbox app

Reviewed-by: prr

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 39 new commits pushed to the master branch:

fe670ff: 8283692: Add PrintIdealPhase that includes block scheduling
ab17f88: 8283626: AArch64: Set relocInfo::offset_unit to 4
c3d903a: 8282936: Write a regression test for JDK-4615365
cc598e0: 8283774: TestZoneOffset::test_immutable should ignore ZoneOffset::rules
0e788e0: 8283781: Avoid allocating unused lastRulesCaches
043b0a7: 8273355: Flickering on tooltip appearance IntelliJ IDEA 2021.2.1
2367228: 8283834: Unmappable character for US-ASCII encoding in TestPredicateInputBelowLoopPredicate
2e9fd56: 8283670: gtest os.release_multi_mappings_vm is still racy
f01cce2: 8264160: Regex \b is not consistent with \w without UNICODE_CHARACTER_CLASS
634800a: 8283806: [BACKOUT] JDK 19 L10n resource files update - msgdrop 10
... and 29 more: https://git.openjdk.java.net/jdk/compare/70648a6a153e5d321f78cf6445a9703f41083725...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

AlexanderScherbatiy · 2022-03-31T08:31:30Z

/integrate

openjdk · 2022-03-31T08:32:36Z

Going to push as commit 3d4be14.
Since your change was applied there have been 82 commits pushed to the master branch:

ef51dfd: 8283791: Parallel: Remove unnecessary condition in PSKeepAliveClosure
3e643f4: 8283799: Collapse identical catch branches in jdk.hotspot.agent
1ca0ede: 8283725: Launching java with "-Xlog:gc*=trace,safepoint*=trace,class*=trace" crashes the JVM
c9a469a: 8283784: java_lang_String::as_platform_dependent_str stores to oop in native state
fbb8ca5: 8281717: Cover logout method for several LoginModule
e0a8669: 8281223: Improve the API documentation of HttpRequest.Builder::build to state that the default implementation provided by the JDK returns immutable objects.
eeca3a3: 8253569: javax.xml.catalog.Catalog.matchURI() implementation should reset state variables
ec0897a: 8281705: SourceLauncherTest.testSystemProperty isn't being run
1ddab6f: 8283060: RawNativeLibraries should allow multiple clients to load/unload the same library
835c7e8: 8283907: Fix Huawei copyright in various files
... and 72 more: https://git.openjdk.java.net/jdk/compare/70648a6a153e5d321f78cf6445a9703f41083725...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-03-31T08:32:54Z

@AlexanderScherbatiy Pushed as commit 3d4be14.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

8181571: printing to CUPS fails on mac sandbox app

072cc49

openjdk bot added the rfr Pull request is ready for review label Jul 21, 2021

openjdk bot added the 2d client-libs-dev@openjdk.org label Jul 21, 2021

openjdk bot added the awt client-libs-dev@openjdk.org label Jul 22, 2021

prrace suggested changes Aug 12, 2021

View reviewed changes

AlexanderScherbatiy added 3 commits August 24, 2021 16:40

Split long line in CUPSPrinter.isCupsRunning() method

4e23b5c

Clean utf_str and nameArray references

104e792

Return null if printers are not found in sandboxed app on MacOS

067d002

openjdk bot added the client client-libs-dev@openjdk.org label Sep 29, 2021

bridgekeeper bot closed this Mar 12, 2022

openjdk bot reopened this Mar 25, 2022

AlexanderScherbatiy and others added 4 commits March 25, 2022 16:17

Merge branch 'openjdk:master' into JDK-8181571

9a83785

Add @SuppressWarnings(removal) for CUPSPrinter.isSandboxedApp() method

f6697fa

Remove ExceptionClear() from getCupsDefaultPrinters()

1b14401

Remove JNU_ThrowOutOfMemoryError from getCupsDefaultPrinters()

c35a844

prrace approved these changes Mar 29, 2022

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Mar 29, 2022

openjdk bot added the integrated Pull request has been integrated label Mar 31, 2022

openjdk bot closed this Mar 31, 2022

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Mar 31, 2022

8181571: printing to CUPS fails on mac sandbox app #4861

8181571: printing to CUPS fails on mac sandbox app #4861

Conversation

AlexanderScherbatiy commented Jul 21, 2021 • edited by openjdk bot

Progress

Issue

Reviewers

Reviewing

bridgekeeper bot commented Jul 21, 2021

openjdk bot commented Jul 21, 2021

mlbridge bot commented Jul 21, 2021 • edited

Webrevs

AlexanderScherbatiy commented Jul 21, 2021

AlexanderScherbatiy commented Jul 22, 2021

openjdk bot commented Jul 22, 2021

AlexanderScherbatiy commented Jul 22, 2021

openjdk bot commented Jul 22, 2021

NikolayTach commented Jul 28, 2021

AlexanderScherbatiy commented Aug 5, 2021

Choose a reason for hiding this comment

AlexanderScherbatiy Aug 24, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bridgekeeper bot commented Sep 22, 2021

AlexanderScherbatiy commented Sep 29, 2021

openjdk bot commented Sep 29, 2021

AlexanderScherbatiy commented Sep 29, 2021

openjdk bot commented Sep 29, 2021

AlexanderScherbatiy commented Oct 8, 2021

bridgekeeper bot commented Nov 5, 2021

AlexanderScherbatiy commented Nov 24, 2021

bridgekeeper bot commented Dec 22, 2021

AlexanderScherbatiy commented Jan 14, 2022

bridgekeeper bot commented Feb 11, 2022

bridgekeeper bot commented Mar 12, 2022

AlexanderScherbatiy commented Mar 25, 2022

openjdk bot commented Mar 25, 2022

openjdk bot commented Mar 29, 2022

AlexanderScherbatiy commented Mar 31, 2022

openjdk bot commented Mar 31, 2022

openjdk bot commented Mar 31, 2022

AlexanderScherbatiy commented Jul 21, 2021 •

edited by openjdk bot

mlbridge bot commented Jul 21, 2021 •

edited

AlexanderScherbatiy Aug 24, 2021 •

edited