Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Sun Lin]

[-- Attachment #1: Type: text/plain, Size: 908 bytes --]

Hi,

When the environment variable "DISPLAY" is invalid, exporting plantuml block in org will got error message:
Exception in thread "main" java.awt.AWTError: Can't connect to X11 window server using 'localhost:11.0' as the value of the DISPLAY variable.
    at sun.awt.X11GraphicsEnvironment.initDisplay(Native Method)
...
To reproduce this issue, install the plantuml.jar and make sure it work inside org-mode.
Then open `/tmp/testing.org` and  input follow plantuml code and eval-expression `(progn (setenv "DISPLAY" "localhost:90")(org-html-export-to-html))`.
The root cause is org-mord execute the plantuml.jar in command line without headless parameter, then plantuml will try read the DISPLAY, it's unnecessary.
(For standalone plantuml, `org-plantuml-executable-args` has default value '-headless' to avoid reading DISPLAY).

Please help review the patch. Thanks.

Best Regards
Lin

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-DISPLAY-error-on-exporting-org-with-plantuml-to-.patch --]
[-- Type: text/x-patch, Size: 927 bytes --]

From 5e04a800691b04edd940dd124987336f6f30dd62 Mon Sep 17 00:00:00 2001
From: Lin Sun <lin.sun@zoom.us>
Date: Sat, 16 Oct 2021 03:01:18 +0000
Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

* org-babel-execute:plantuml: using headless mode for org calling plantuml for exporting to html
---
 lisp/ob-plantuml.el | 1 +
 1 file changed, 1 insertion(+)

diff --git a/lisp/ob-plantuml.el b/lisp/ob-plantuml.el
index fc62160..7d92227 100644
--- a/lisp/ob-plantuml.el
+++ b/lisp/ob-plantuml.el
@@ -122,6 +122,7 @@ This function is called by `org-babel-execute-src-block'."
 				((not (file-exists-p org-plantuml-jar-path))
 				 (error "Could not find plantuml.jar at %s" org-plantuml-jar-path))
 				(t (list java
+					 "-Djava.awt.headless=true"
 					 "-jar"
 					 (shell-quote-argument (expand-file-name org-plantuml-jar-path))))))
 	 (full-body (org-babel-plantuml-make-body body params))
-- 
2.7.0

Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Sun Lin]

[-- Attachment #1: Type: text/plain, Size: 1257 bytes --]


Hi Bastien,

Please help to review this patch. Thanks

Best Regards

Lin Sun

----- Forwarded Message -----

From: Sun Lin <sunlin7@yahoo.com>
To: emacs-orgmode@gnu.org <emacs-orgmode@gnu.org>
Sent: Saturday, October 16, 2021, 03:25:40 AM UTC
Subject: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html


Hi,

When the environment variable "DISPLAY" is invalid, exporting plantuml block in org will got error message:
Exception in thread "main" java.awt.AWTError: Can't connect to X11 window server using 'localhost:11.0' as the value of the DISPLAY variable.
    at sun.awt.X11GraphicsEnvironment.initDisplay(Native Method)
...
To reproduce this issue, install the plantuml.jar and make sure it work inside org-mode.
Then open `/tmp/testing.org` and  input follow plantuml code and eval-expression `(progn (setenv "DISPLAY" "localhost:90")(org-html-export-to-html))`.
The root cause is org-mord execute the plantuml.jar in command line without headless parameter, then plantuml will try read the DISPLAY, it's unnecessary.
(For standalone plantuml, `org-plantuml-executable-args` has default value '-headless' to avoid reading DISPLAY).

Please help review the patch. Thanks.

Best Regards
Lin

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-DISPLAY-error-on-exporting-org-with-plantuml-to-.patch --]
[-- Type: text/x-patch, Size: 927 bytes --]

From 5e04a800691b04edd940dd124987336f6f30dd62 Mon Sep 17 00:00:00 2001
From: Lin Sun <lin.sun@zoom.us>
Date: Sat, 16 Oct 2021 03:01:18 +0000
Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

* org-babel-execute:plantuml: using headless mode for org calling plantuml for exporting to html
---
 lisp/ob-plantuml.el | 1 +
 1 file changed, 1 insertion(+)

diff --git a/lisp/ob-plantuml.el b/lisp/ob-plantuml.el
index fc62160..7d92227 100644
--- a/lisp/ob-plantuml.el
+++ b/lisp/ob-plantuml.el
@@ -122,6 +122,7 @@ This function is called by `org-babel-execute-src-block'."
 				((not (file-exists-p org-plantuml-jar-path))
 				 (error "Could not find plantuml.jar at %s" org-plantuml-jar-path))
 				(t (list java
+					 "-Djava.awt.headless=true"
 					 "-jar"
 					 (shell-quote-argument (expand-file-name org-plantuml-jar-path))))))
 	 (full-body (org-babel-plantuml-make-body body params))
-- 
2.7.0

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Bastien Guerry]

Hi,

Sun Lin <sunlin7@yahoo.com> writes:

> Please help to review this patch.

I will - but please be aware that we have a policy of waiting at least
one month before bumping a thread:

https://orgmode.org/worg/org-mailing-list.html#i-didnt-receive-an-answer

Thanks,

-- 
 Bastien

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Sun Lin]

Hi Bastien,

Okay, waiting a month is no problem for me, I'll give org version info in future patches.

The patch is for org version:
Org mode version 9.5 (release_9.5-46-gb71474 @ ~/.root/share/emacs/28.0.60/lisp/org/)

And the reproduce steps are edit /tmp/testing.org and eval-expression 
(progn (setenv "DISPLAY" "localhost:90")(org-html-export-to-html))

# testing.org
#+BEGIN_SRC plantuml :cmdline -charset UTF-8 :file testing.png
  @startuml
  a -> b: testing
  @enduml
#+END_SRC


Thanks.

--
Lin

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Sun Lin]

[-- Attachment #1: Type: text/plain, Size: 279 bytes --]

Hi Bastien,

> Hi,
> I will - but please be aware that we have a policy of waiting at least
> one month before bumping a thread:
> https://orgmode.org/worg/org-mailing-list.html#i-didnt-receive-an-answer
> Thanks,
> Bastien

Please help the patch, thanks.

Lin    

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-DISPLAY-error-on-exporting-org-with-plantuml-to-.patch --]
[-- Type: text/x-patch, Size: 927 bytes --]

From 5e04a800691b04edd940dd124987336f6f30dd62 Mon Sep 17 00:00:00 2001
From: Lin Sun <lin.sun@zoom.us>
Date: Sat, 16 Oct 2021 03:01:18 +0000
Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

* org-babel-execute:plantuml: using headless mode for org calling plantuml for exporting to html
---
 lisp/ob-plantuml.el | 1 +
 1 file changed, 1 insertion(+)

diff --git a/lisp/ob-plantuml.el b/lisp/ob-plantuml.el
index fc62160..7d92227 100644
--- a/lisp/ob-plantuml.el
+++ b/lisp/ob-plantuml.el
@@ -122,6 +122,7 @@ This function is called by `org-babel-execute-src-block'."
 				((not (file-exists-p org-plantuml-jar-path))
 				 (error "Could not find plantuml.jar at %s" org-plantuml-jar-path))
 				(t (list java
+					 "-Djava.awt.headless=true"
 					 "-jar"
 					 (shell-quote-argument (expand-file-name org-plantuml-jar-path))))))
 	 (full-body (org-babel-plantuml-make-body body params))
-- 
2.7.0

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Timothy]

Hi Sun,

> [snipped patch description]
> Please help review the patch. Thanks.
> [2. text/x-patch; 0001-Fix-DISPLAY-error-on-exporting-org-with-plantuml-to-.patch]...

Thanks for your patience. This looks quite straight-forward. I don't use
or have plantuml so I'm in a poor position to test.

However, I can use google, and it seems that -Djava.awt.headless=true
just uses Java for some graphics operations which are normally delegated
to the system graphics stack.

This seems rather safe to me, and so I'd be inclined to take your word
that this is a beneficial change and merge the patch.

All the best,
Timothy

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Sun Lin]

Hi Timothy,

Thank you so much!

B.R.
Lin

Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Sun Lin]

Hi Timothy,

Can any help merge the patch? Or should I request Bastien to merge the patch? 
Thanks.

B.R.
Lin

>On Thursday, November 18, 2021, 07:42:24 AM UTC, Timothy <tecosaur@gmail.com> wrote:

>Hi Sun,

>> [snipped patch description]

>> Please help review the patch. Thanks.

>> [2. text/x-patch; 0001-Fix-DISPLAY-error-on-exporting-org-with-plantuml-to-.patch]...

>Thanks for your patience. This looks quite straight-forward. I don't use
>or have plantuml so I'm in a poor position to test.

>However, I can use google, and it seems that -Djava.awt.headless=true
>just uses Java for some graphics operations which are normally delegated
>to the system graphics stack.

>This seems rather safe to me, and so I'd be inclined to take your word
>that this is a beneficial change and merge the patch.

>All the best,

>Timothy

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Timothy]

[-- Attachment #1: Type: text/plain, Size: 628 bytes --]

Hi Sun,

> Can any help merge the patch? Or should I request Bastien to merge the patch? 

Thanks for not forgetting about this. As I commented before, I this looks
sensible enough to apply, and so I’ve just pushed it as f9dcc3d with a tweaked
commit message.

You’ve also been added to the list of TINYCHANGE contributors on
<https://orgmode.org/worg/contributors.html>. If you submit more than 20
cumulative lines of non-trivial code, you’ll need to get FSF assignment.

Thanks for sharing the issue and making a patch for it 🙂 hopefully we’ll see
you around in the future.

All the best,
Timothy

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Sun Lin]

Hi Timothy,

Thank you! : ) 

I had signed the FSF, RT: 1718442. 

B.R.
 Lin

On Tuesday, November 30, 2021, 04:22:03 AM UTC, Timothy <tecosaur@gmail.com> wrote: 
> Hi Sun,

> Thanks for not forgetting about this. As I commented before, I this looks
 sensible enough to apply, and so I’ve just pushed it as f9dcc3d with a tweaked
 commit message.

> You’ve also been added to the list of TINYCHANGE contributors on
 <https://orgmode.org/worg/contributors.html>. If you submit more than 20
 cumulative lines of non-trivial code, you’ll need to get FSF assignment.

> Thanks for sharing the issue and making a patch for it 🙂 hopefully we’ll see
 you around in the future.

Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[lin Sun via General discussions about Org-mode.]

[-- Attachment #1.1: Type: text/plain, Size: 191 bytes --]

Hi Timothy,

The commit f9dcc3d was overridden by the commit b5f0efc.

This patch will re-submit the solution based on the last rev.

Please help review and merge the patch. Thanks

B.R.
Lin

[-- Attachment #1.2: Type: text/html, Size: 362 bytes --]

[-- Attachment #2: 0001-ob-plantuml-fix-DISPLAY-error-with-html-export.patch --]
[-- Type: text/x-patch, Size: 1059 bytes --]

From 6512e94806a4c08f40e6796e239ad2b318f7fbc5 Mon Sep 17 00:00:00 2001
From: Lin Sun <lin.sun@zoom.us>
Date: Tue, 7 Jun 2022 04:06:06 +0000
Subject: [PATCH] ob-plantuml: fix DISPLAY error with html export

* lisp/ob-plantuml.el (org-babel-execute:plantuml): Use headless mode
for Org calling plantuml for exporting to html to avoid issues with
operations that normally try to access the system graphics stack.
---
 lisp/ob-plantuml.el | 1 +
 1 file changed, 1 insertion(+)

diff --git a/lisp/ob-plantuml.el b/lisp/ob-plantuml.el
index 6e1b1b1..37a631b 100644
--- a/lisp/ob-plantuml.el
+++ b/lisp/ob-plantuml.el
@@ -122,6 +122,7 @@ This function is called by `org-babel-execute-src-block'."
 				((not (file-exists-p org-plantuml-jar-path))
 				 (error "Could not find plantuml.jar at %s" org-plantuml-jar-path))
 				(t `(,java
+                                     "-Djava.awt.headless=true"
 				     "-jar"
 				     ,(shell-quote-argument (expand-file-name org-plantuml-jar-path))
                                      ,@org-plantuml-args))))
-- 
2.7.0

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Dr. Arne Babenhauserheide]

[-- Attachment #1: Type: text/plain, Size: 1581 bytes --]

Hi Lin Sun,

lin Sun via "General discussions about Org-mode." <emacs-orgmode@gnu.org> writes:
> This patch will re-submit the solution based on the last rev.
>
> Please help review and merge the patch. Thanks 
>
> [4. text/x-patch; 0001-ob-plantuml-fix-DISPLAY-error-with-html-export.patch]...
> From 6512e94806a4c08f40e6796e239ad2b318f7fbc5 Mon Sep 17 00:00:00 2001
> From: Lin Sun <lin.sun@zoom.us>
> Date: Tue, 7 Jun 2022 04:06:06 +0000
> Subject: [PATCH] ob-plantuml: fix DISPLAY error with html export
> 
> * lisp/ob-plantuml.el (org-babel-execute:plantuml): Use headless mode
> for Org calling plantuml for exporting to html to avoid issues with
> operations that normally try to access the system graphics stack.
> ---
>  lisp/ob-plantuml.el | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/lisp/ob-plantuml.el b/lisp/ob-plantuml.el
> index 6e1b1b1..37a631b 100644
> --- a/lisp/ob-plantuml.el
> +++ b/lisp/ob-plantuml.el
> @@ -122,6 +122,7 @@ This function is called by `org-babel-execute-src-block'."
>  				((not (file-exists-p org-plantuml-jar-path))
>  				 (error "Could not find plantuml.jar at %s" org-plantuml-jar-path))
>  				(t `(,java
> +                                     "-Djava.awt.headless=true"

This looks good and low-risk to me.

>  				     "-jar"
>  				     ,(shell-quote-argument (expand-file-name org-plantuml-jar-path))
>                                       ,@org-plantuml-args))))
> -- 
> 2.7.0

Best wishes,
Arne
-- 
Unpolitisch sein
heißt politisch sein,
ohne es zu merken.
draketo.de

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 1125 bytes --]

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Max Nikulin]

On 07/06/2022 13:34, Dr. Arne Babenhauserheide wrote:
> 
> lin Sun writes:
>> This patch will re-submit the solution based on the last rev.

>> diff --git a/lisp/ob-plantuml.el b/lisp/ob-plantuml.el
>> index 6e1b1b1..37a631b 100644
>> --- a/lisp/ob-plantuml.el
>> +++ b/lisp/ob-plantuml.el
>> @@ -122,6 +122,7 @@ This function is called by `org-babel-execute-src-block'."
>>   				((not (file-exists-p org-plantuml-jar-path))
>>   				 (error "Could not find plantuml.jar at %s" org-plantuml-jar-path))
>>   				(t `(,java
>> +                                     "-Djava.awt.headless=true"
> 
> This looks good and low-risk to me.

Could you, please, clarify why -headless in `org-plantuml-args' is not 
enough and -Djava.awt.headless=true should be added despite it looks 
redundant. Another question is why this option should be applied to jar 
but not to plantuml launcher script. The commit dropping this option has 
a link to discussion whether this argument is necessary and hard coded 
in such way.

> 
>>   				     "-jar"
>>   				     ,(shell-quote-argument (expand-file-name org-plantuml-jar-path))
>>                                        ,@org-plantuml-args))))

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[lin Sun]

[-- Attachment #1: Type: text/plain, Size: 88 bytes --]

Hi Arne,

Thanks a lot!

Look forward to seeing who can merge this patch. : )

B.R.
Lin

[-- Attachment #2: Type: text/html, Size: 191 bytes --]

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[Ihor Radchenko]

lin Sun <sunlin7@yahoo.com> writes:

> The commit f9dcc3d was overridden by the commit b5f0efc.
>
> This patch will re-submit the solution based on the last rev.
>
> Please help review and merge the patch. Thanks

I am unable to reproduce the original error on latest main.
Could you please provide a reproducer when the proposed patch is
actually useful?

Best,
Ihor

Re: Subject: [PATCH] Fix DISPLAY error on exporting org with plantuml to html

[lin Sun]

Hi lhor,

You're totally right, the commit b5f0efc had appended the `-headless`
to the jar parameter list. Here is the comment:
> *** =org-plantump-executable-args= is renamed and applies to jar as well
The original issue does not exist now.  Please ignore the previous patch.

Thank you so much.

B.R.
Lin