Lua dynamic libraries isn't enabled

[Andreas Rönnquist]

[Impact]

No Lua module which is in the dynamic library can be loaded by SciTE on Linux since >=4.0 (when it started using Lua 5.3).

[Test Case]

First - create /usr/local/lib/lua/5.3/system and symlink a module there:

sudo apt -y install lua-system
sudo mkdir -p /usr/local/lib/lua/5.3/system
sudo ln -s /usr/lib/x86_64-linux-gnu/lua/5.3/system/core.so /usr/local/lib/lua/5.3/system/core.so

Add a Lua script to the startup scripts: (Use the menu "Options" -> "Open Lua Startup Script") and add

local system = require 'system.core'
print( "System.Gettime is ", system.gettime() )

which should simply print the current time using the Lua library when starting SciTE, instead gives an error:

error loading module 'system.core' from file '/usr/local/lib/lua/5.3/system/core.so':
 dynamic libraries not enabled; check your Lua installation
>Lua: error occurred while running startup script

[Other]

(Previous text):

SciTE in ubuntu 18.04 has the Lua library embedded, and compiled without dynamic libraries enabled. This makes it impossible to load Lua modules which is in the dynamic library on SciTE >= 4.0, when it started using Lua 5.3.

On later versions (SciTE >= 4.1.0) I have built Lua without using the embedded Lua library but using Debian-packaged shared object instead, and there this isn't a problem. (I am one of the Debian maintainers of SciTE).

This leaves the version in 18.04, where this still is a problem.

See upstream bug at
https://sourceforge.net/p/scintilla/bugs/2058/

for a patch. Another alternative is to backport version 4.1.0 or later to Ubuntu 18.04.

[Andreas Rönnquist (gusnan)]

Upstream fix here:

https://sourceforge.net/p/scintilla/scite/ci/2b22af2a7fbbaec530d5043523ecf8d49a6e02c9/

[Andreas Rönnquist (gusnan)]

diff -Nru scite-4.0.0/debian/changelog scite-4.0.0/debian/changelog
--- scite-4.0.0/debian/changelog 2017-08-16 19:11:14.000000000 +0200
+++ scite-4.0.0/debian/changelog 2018-11-23 20:53:03.000000000 +0100
@@ -1,3 +1,10 @@
+scite (4.0.0-1ubuntu1) bionic; urgency=medium
+
+ * Add patch enable_lua_to_access_dynamic_libraries.patch
+ enabling dynamic Lua libraries in SciTE (LP: #1804865)
+
+ -- Andreas Rönnquist <email address hidden> Fri, 23 Nov 2018 20:53:03 +0100
+
 scite (4.0.0-1) unstable; urgency=medium

   * New upstream release
diff -Nru scite-4.0.0/debian/patches/enable_lua_to_access_dynamic_libraries.patch scite-4.0.0/debian/patches/enable_lua_to_access_dynamic_libraries.patch
--- scite-4.0.0/debian/patches/enable_lua_to_access_dynamic_libraries.patch 1970-01-01 01:00:00.000000000 +0100
+++ scite-4.0.0/debian/patches/enable_lua_to_access_dynamic_libraries.patch 2018-11-23 20:52:15.000000000 +0100
@@ -0,0 +1,32 @@
+Author: jj5
+Description: On Linux, enable Lua to access dynamic libraries.
+Applied-Upstream: https://sourceforge.net/p/scintilla/scite/ci/2b22af2a7fbbaec530d5043523ecf8d49a6e02c9/
+Index: scite-4.0.0/scite/gtk/makefile
+===================================================================
+--- scite-4.0.0.orig/scite/gtk/makefile
++++ scite-4.0.0/scite/gtk/makefile
+@@ -77,7 +77,7 @@ vpath %.c $(srcdir)/../lua/src
+ INCLUDEDIRS=-I $(srcdir)/../../scintilla/include -I $(srcdir)/../src -I$(srcdir)/../lua/src
+
+ .c.o:
+- $(CC) $(CPPFLAGS) $(INCLUDEDIRS) $(MISLEADING) -DLUA_USE_POSIX $(CXXTFLAGS) $(CFLAGS) -c $< -o $@
++ $(CC) $(CPPFLAGS) $(INCLUDEDIRS) $(MISLEADING) -DLUA_USE_POSIX $(LUACFLAGS) $(CXXTFLAGS) $(CFLAGS) -c $< -o $@
+
+ else
+ CXXTFLAGS+=-DNO_LUA
+@@ -88,12 +88,15 @@ CXXTFLAGS:=$(CXXTFLAGS)
+ UNAME:=$(shell uname -s)
+ ifeq ($(UNAME), Linux)
+ LIBDL:=-ldl
++LUACFLAGS:=-DLUA_USE_DLOPEN
+ endif
+ ifneq (,$(findstring GNU,$(UNAME)))
+ LIBDL:=-ldl
++LUACFLAGS:=-DLUA_USE_DLOPEN
+ endif
+ ifeq ($(UNAME), Darwin)
+ CXXTFLAGS:=$(CXXTFLAGS) -Dunix
++LUACFLAGS:=-DLUA_USE_DLOPEN
+ endif
+
+ .cxx.o:
diff -Nru scite-4.0.0/debian/patches/series scite-4.0.0/debian/patches/series
--- scite-4.0.0/debian/patches/series 2017-08-16 19:11:14.000000000 +0200
+++ scite-4.0.0/debian/patches/series 2018-11-23 20:39:40.000000000 +0100
@@ -1,3 +1,4 @@
 hardening_flags.patch
 do_not_use_remote_logo.patch
 reproducible_build.patch
+enable_lua_to_access_dynamic_libraries.patch

[Simon Quigley (tsimonq2)]

Thank you for the bug report, and apologies for the delay on this.

Could you please edit the bug description to follow the SRU template? https://wiki.ubuntu.com/StableReleaseUpdates#SRU_Bug_Template

As for the debdiff, please put it in a patch file and attach it to the bug report instead of pasting it into a comment. You can find the recommended versioning scheme here: https://wiki.ubuntu.com/SecurityTeam/UpdatePreparation#Update_the_packaging

Unsubscribing the sponsors team, please resubscribe us when that is complete.

Thank you!

[Andreas Rönnquist (gusnan)]

Done according to your instructions - I hope I got it right now. Thanks!

[Simon Quigley (tsimonq2)]

Sponsored to Bionic, thank you for your contribution to Ubuntu!

[Łukasz Zemczak (sil2100)]

Looks good! The SRU description is missing the regression potential field but for a change like this, I guess that would be not very relevant anyway. Accepting.

[Łukasz Zemczak (sil2100)]

Hello Andreas, or anyone else affected,

Accepted scite into bionic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/scite/4.0.0-1ubuntu0.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-bionic to verification-done-bionic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-bionic. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[Andreas Rönnquist (gusnan)]

Please someone perform a SRU verification of this, so we finally can get this into Bionic. (I would do it myself if I could, but it doesn't seem right to verify my own changes).

[Julian Andres Klode (juliank)]

It's absolutely right to verify your own changes.

[Andreas Rönnquist (gusnan)]

Alright, Installed the package from bionic-proposed in a clean virtual machine, and tested the package. The fix works.

[Andreas Rönnquist (gusnan)]

Alright, I should mention versions too: error in 4.0.0-1, and working fix in 4.0.0-1ubuntu0.1.

[Launchpad Janitor (janitor)]

This bug was fixed in the package scite - 4.0.0-1ubuntu0.1

---------------
scite (4.0.0-1ubuntu0.1) bionic; urgency=medium

  * Add patch enable_lua_to_access_dynamic_libraries.patch
    enabling dynamic Lua libraries in SciTE (LP: #1804865)

 -- Andreas Rönnquist <email address hidden> Fri, 23 Nov 2018 20:53:03 +0100