dcommander
commented
2 years ago It'd be nice if the big Java dependencies such as
jschcould be used from the system.
Several issues with that:
- I am unaware of any operating system that provides JSch or the other Java dependencies.
- Java JAR files are not like shared libraries in that they don't provide a means for API/ABI versioning. Thus, even if the operating system provided all of the Java dependencies, there would be no sane way for the TurboVNC Viewer to ensure that the system's version of those dependencies had the necessary interfaces.
- Since the original JSch source base is unmaintained, I had to add some features to it in order to support the TurboVNC Viewer, and I have since ported additional features from the JSch fork that is actively maintained. Thus, TurboVNC's version of JSch exists only in TurboVNC. It is so tightly integrated into the viewer that trying to support arbitrary external versions of it would be a nightmare, even if such were possible.
For those reasons, it is best to imagine the Java dependencies as an inseparable part of the TurboVNC Viewer source code, which is how they are treated. For a variety of other reasons, the usage of the TurboVNC Viewer requires that VncViewer.jar be fully self-contained.
;; d3des, rfb (headers) and turbojpeg-jni are preserved, since they ;; are not packaged and fairly small.
More importantly, they are critical to the correct operation of TurboVNC and are not provided by external libraries. TurboVNC has quite a few internal libraries and headers that are intentional and inseparable.
;; Use system libraries. #~(list "-DTVNC_SYSTEMLIBS=1" "-DTVNC_SYSTEMX11=1" "-DTVNC_DLOPENSSL=0"
You should also set TJPEG_INCLUDE_DIR and TJPEG_LIBRARY (for example, to /usr/include and -lturbojpeg, respectively) in order to link dynamically with the system's installation of libjpeg-turbo. The default is to link statically with an installation of the official libjpeg-turbo SDK under /opt/libjpeg-turbo. Also, you probably want to pass -DTVNC_INCLUDEJRE=0 to prevent the build system from embedding a JRE into the TurboVNC installation directory, which is unnecessary if you are using the system's JRE.
(string-append "-DDRI_DRIVER_PATH=" (search-input-directory %build-inputs "lib/dri")) (string-append "-DXKB_BASE_DIRECTORY=" (search-input-directory %build-inputs "share/X11/xkb"))
It's unclear what %build-inputs is, but those two directories are supposed to point to a system location, such as a directory under /usr/share/X11. You should also set FONT_ENCODINGS_DIRECTORY and SERVER_MISC_CONFIG_PATH, if those differ from their default values.
;; Help the build system to find the system pixman headers. (string-append "-DCMAKE_C_FLAGS=-I" (search-input-directory %build-inputs "include/pixman-1")))After deleting the unused bundled sources, the pixman headers would be missing.
I see that issue and will fix it.
(("string\\(REGEX REPLACE.*X11_Xfont2_LIB.*") (format #f "set(X11_Xfont2_LIB ~a)~%" (search-input-file inputs "lib/libXfont2.so"))) (("string\\(REGEX REPLACE.*X11_Fontenc_LIB.*") (format #f "set(X11_Fontenc_LIB ~a)~%" (search-input-file inputs "lib/libfontenc.so"))) (("string\\(REGEX REPLACE.*X11_Pixman_LIB.*") (format #f "set(X11_Pixman_LIB ~a)~%" (search-input-file inputs "lib/libpixman-1.so"))))These should be searched by CMake independently rather than assumed to live where Xorg is.
Are there any systems that install those libraries in a different directory than the one in which libX11 is installed? I have never seen such a system.
(substitute* "unix/Xvnc/programs/Xserver/CMakeLists.txt" ;; The default rule file name must have changed from 'xorg' to ;; 'base' for xkeyboard-config. Without this change, running ;; Xvnc would fail with the error "XKB: Failed to compile ;; keymap" (("set\\(DEFAULT_XKB_DFLT_RULES.*)") "set(DEFAULT_XKB_DFLT_RULES \"base\")") ;; XXX: This somehow overrides the user-specified ;; XKB_BASE_DIRECTORY. (("set\\(DEFAULT_XKB_BASE_DIRECTORY .*)") (format #f "set(DEFAULT_XKB_BASE_DIRECTORY \"~a\")" (search-input-directory inputs "share/X11/xkb"))) (("set\\(DEFAULT_XKB_BIN_DIRECTORY .*)") (format #f "set(DEFAULT_XKB_BIN_DIRECTORY \"~a\")" (dirname (search-input-file inputs "bin/xkbcomp"))))) (substitute* "unix/Xvnc/programs/Xserver/dix/CMakeLists.txt" ;; This is needed, otherwise the same error as above would ;; occur. Mimic xorg-server's "--with-xkb-output=/tmp" ;; configuration. (("-DCOMPILEDDEFAULTFONTPATH=\".*\"") "-DCOMPILEDDEFAULTFONTPATH=/tmp"))))It'd be nice if we could set them from CMake (top level) directly. They should honor what the user specified.
The build system provides CMake variables (XKB_BASE_DIRECTORY, XKB_BIN_DIRECTORY, XKB_DFLT_LAYOUT, XKB_DFLT_MODEL, XKB_DEFAULT_OPTIONS, XKB_DFLT_RULES, XKB_DFLT_VARIANT) for precisely that purpose. Are those insufficient?
(add-after 'unpack 'patch-vncviewer (lambda* (#:key inputs #:allow-other-keys) (define openjdk #$(this-package-input "openjdk")) (substitute* "unix/vncviewer/vncviewer.in" (("\\$BINDIR/../java/jre") openjdk)
This is unnecessary. Just build with -DTVNC_INCLUDEJRE=0.
;; Avoid resorting to grep and sed to locate libjawt.so. (("^_TMP=.*") (string-append "_TMP=" openjdk "/lib\n")))))
I don't know what you mean by resorting to grep and sed, but the vncviewer script finds libjawt.so by querying the JRE for the location of that library. It shouldn't be necessary to muck with that.
(add-after 'unpack 'patch-vncserver (lambda* (#:key inputs #:allow-other-keys) (substitute* "unix/vncserver.in" ;; Add sane Guix System default locations for X11 fonts. (("'/usr/share/X11/fonts'" all) (format #f "'~a', '~a', ~a" "/run/current-system/profile/share/fonts/X11" (string-append #$(this-package-input "font-alias") "share/fonts/X11") all)) ;; Add sane Guix System default locations for XKB layouts. ;; Note: the directory must be appended to the list, as the ;; last one to be searched wins. (("'/opt/X11/share/X11/xkb'" all) (format #f "~a, '~a/share/X11/xkb', '~a'" all #$(this-package-input "xkeyboard-config") "/run/current-system/profile/share/X11/xkb")) ;; Likewise for the xkbcompdirs. (("'/opt/X11/bin'" all) (format #f "~a, '~a'" all (dirname (search-input-file inputs "bin/xkbcomp")))) ;; Likewise for dridirs. (("push\\(@dridirs, '/usr/local/lib/dri').*" all) (format #f "~apush(@dridirs, '~a');~%" all (dirname (search-input-file inputs "lib/dri/swrast_dri.so")))) ;; Likewise for registrydirs. (("push\\(@registrydirs, '/opt/X11/lib/xorg').*" all) (format #f "~apush(@registrydirs, '~a');~%" all (dirname (search-input-file inputs "lib/xorg/protocol.txt")))))))
Does Guix somehow know the correct locations of all of those directories for every distribution on which it can run? If so, then this seems like it should be best handled by introducing specific CMake variables or even making vncserver Guix-aware. But if you're just searching the operating system for the correct directories, then I don't see the advantage of doing that at build time rather than at run time, as vncserver already does.
(add-after 'unpack 'patch-xstartup.turbovnc (lambda* (#:key inputs #:allow-other-keys) (substitute* "unix/xstartup.turbovnc" (("DBUS_LAUNCH=[[:graph:]]+") (format #f "DBUS_LAUNCH=~a" (search-input-file inputs "bin/dbus-launch"))) (("XSESSIONSDIR=[[:graph:]]+") (format #f "XSESSIONSDIR=~a" "/run/current-system/profile/share/xsessions")) (("GREP=[[:graph:]]+") (format #f "GREP=~a" (search-input-file inputs "bin/grep"))) (("SED=[[:graph:]]+") (format #f "SED=~a" (search-input-file inputs "bin/sed")))
Do these really need to be different than the defaults set by xstartup.turbovnc? If so, then it's probably also best handled by introducing new CMake variables.
;; There's no /etc/X11/xinit/Xsession file on Guix System, so ;; attempt a better guess. (("XSESSION=[[:graph:]]+") "XSESSION=$HOME/.xsession")
This is not the correct approach. If there is no Xsession script, then XSESSION should be blank. In the unmodified xstartup.turbovnc script, XSESSION will be blank if neither /etc/X11/xinit/Xsession nor /etc/X11/Xsession exists.
(("TVNC_SSHAGENT=[[:graph:]]+") (format #f "TVNC_SSHAGENT=~a" (search-input-file inputs "bin/ssh-agent"))) (("TVNC_VGLRUN=\"vglrun" all) (string-append "TVNC_VGLRUN=" (search-input-file inputs "bin/vglrun") all)))))
Similar comment to above: Are there any systems on which these files are not installed under /usr/bin? Unless this fixes a specific problem with a specific system, then why do it? Any changes I make to xstartup.turbovnc would likely break this.
(synopsis "TightVNC-compatible remote desktop software") (description "TurboVNC is a high-speed version of VNC derived fromTightVNC. It contains a variant of Tight encoding that is tuned to maximize performance for image-intensive applications (such as VirtualGL, video applications, and image editors) while still providing excellent performance for other types of applications.")
Can you use the summary from our own packages? The synopsis above makes it sound like we're just a TightVNC clone.
Apteryks
Hello, and thank you for this useful project.
Below, I share the package of
turbovncthat I'll propose for inclusion in GNU Guix, a package manager that can be used on top of any GNU/Linux machine, similar in essence to Nix. I do not expect all the idiosyncracies of the Scheme/Guix language to be understood, but I'll document the parts where the build system failed.It'd be nice if the big Java dependencies such as
jschcould be used from the system.The above cleans up (remove) the unused sources. This sometimes uncover issues such as the use of the bundled headers instead of the ones from the system (which it did; see below).
After deleting the unused bundled sources, the pixman headers would be missing.
These should be searched by CMake independently rather than assumed to live where Xorg is.
It'd be nice if we could set them from CMake (top level) directly. They should honor what the user specified.
The rest is pretty Guix-specific, similar to what Nix does or other functional (non-FHS) package manager would need to do.