Merge lp:~timo-jyrinki/kubuntu-packaging/qtchooser_qmlscene_fallback into lp:~kubuntu-packagers/kubuntu-packaging/qtchooser

[Timo Jyrinki]

* Add a proposed patch from upstream:
  - Implement-fallback-mechanism.patch

RFC, an updated upstream proposed patch not yet accepted by upstream.

Can be tested by:
sudo apt-add-repository ppa:canonical-qt5-edgers/qt5-beta1
sudo apt update
sudo apt install qtchooser

on Ubuntu 14.10.

Upstream discussion: https://codereview.qt-project.org/#/c/82702/

[Scott Kitterman (kitterman)]

Why was it not accepted upstream?

[Timo Jyrinki (timo-jyrinki)]

I guess it can be interpreted as disagreeing on the development tools definition. Qtchooser is used to manage development tools, which includes everything but the Qt Creator according to the upstream. But Ubuntu uses qmlscene for normal users, and Kubuntu qdbus, without any other developer software installed, so there rises this subtle conflict.

[Dmitry Shachnev (mitya57)]

I think we should whitelist qdbus and all tools that didn't exist in Qt 4 (like qml or qtpaths). For the latter category, I think even upstream will agree to do that.

[Timo Jyrinki (timo-jyrinki)]

Whitelisting a bit more sounds like a good way to go, let's see what upstream has to say about that. It should a more safe approach to the problem compared to the blacklisting, so maybe upstream would accept it.

I haven't received more urgent pushing on the issue now, so we can probably wait a bit. But I believe we'd need this one way or another, since the issue seems to come up also for users on IRC every now and then. People just use their Qt:s in various ways and end up with various configurations where the tools don't anymore behave like they would assume.

[lp:~timo-jyrinki/kubuntu-packaging/qtchooser_qmlscene_fallback]

19. By Timo Jyrinki on 2014-08-20

New proposal to upstream

20. By Timo Jyrinki on 2014-08-20

One line adjustment to compile against our older qtchooser version.

[Scott Kitterman (kitterman)]

Let's see what upstream says before uploading this.

[Harald Sitter (apachelogger)]

FWIW, waiting for upstream can be problematic because the qdbus thing causes issues with plasma startup in various forms and fashions depending on which packages are installed (or not)

[Sebastien Bacher (seb128)]

The ppa package resolves the issue and make qmlscene works out of the box in an unity8 session with qt5 examples

[Timo Jyrinki (timo-jyrinki)]

Despite pinging on the upstream codereview and directly on IRC, there's no update. The difference with qtchooser to normal Qt project repositories is that there's essentially only one reviewer.

I'd like to upload this as a distro patch to Ubuntu for utopic release to have a solution for the Unity8 desktop session. It can be reverted if needed, but it should be safe and actually prevent problems compared to people installing qt5-default/qt4-default.

[Timo Jyrinki (timo-jyrinki)]

Now uploaded and in queue, after discussions on #kubuntu-devel with apachelogger and mitya57.

[lp:~timo-jyrinki/kubuntu-packaging/qtchooser_qmlscene_fallback]

21. By Timo Jyrinki on 2014-10-06

Remove two non-used files that should have been removed during the import.

22. By Timo Jyrinki on 2014-10-06

Release ubuntu1

=== modified file 'debian/changelog'
--- debian/changelog	2014-08-13 08:41:01 +0000
+++ debian/changelog	2014-10-07 06:42:00 +0000
@@ -1,3 +1,10 @@
+qtchooser (39-g4717841-3ubuntu1) utopic; urgency=medium
+
+  * Add a proposed patch from upstream:
+    - Implement-fallback-mechanism.patch (LP: #1295835)
+
+ -- Timo Jyrinki <[e-mail]>  Mon, 06 Oct 2014 16:39:42 +0300
+
 qtchooser (39-g4717841-3) unstable; urgency=medium
 
   * Add a patch from Daniel Schepler to allow easier bootstraping of qtchooser

=== modified file 'debian/control'
--- debian/control	2014-08-13 08:41:01 +0000
+++ debian/control	2014-10-07 06:42:00 +0000
@@ -1,7 +1,8 @@
 Source: qtchooser
 Section: libdevel
 Priority: optional
-Maintainer: Debian Qt/KDE Maintainers <[e-mail]>
+Maintainer: Ubuntu Developers <[e-mail]>
+XSBC-Original-Maintainer: Debian Qt/KDE Maintainers <[e-mail]>
 Uploaders: Timo Jyrinki <[e-mail]>,
            Lisandro Damián Nicanor Pérez Meyer <[e-mail]>
 Build-Depends: debhelper (>= 9), libqt4-dev

=== added file 'debian/patches/Implement-fallback-mechanism.patch'
--- debian/patches/Implement-fallback-mechanism.patch	1970-01-01 00:00:00 +0000
+++ debian/patches/Implement-fallback-mechanism.patch	2014-10-07 06:42:00 +0000
@@ -0,0 +1,142 @@
+From bd72414b48571b294e43dec06298308a2cfa7da9 Mon Sep 17 00:00:00 2001
+From: Dmitry Shachnev <[e-mail]>
+Date: Fri, 4 Apr 2014 13:53:15 +0400
+Subject: [PATCH] Implement fallback mechanism for some tools
+
+If a tool was requested without specifying the Sdk name, and the
+default Sdk does not have that tool, fall back to any installed
+Sdk that contains that tool.
+
+Currently this is enabled only for qdbus, qmlscene, and for tools
+that are new in Qt 5.
+
+Change-Id: I19a82a06c75fe9cd624aa51b086d72e75310ba35
+---
+ src/qtchooser/main.cpp | 58 +++++++++++++++++++++++++++++++++++++++++++-------
+ 1 file changed, 50 insertions(+), 8 deletions(-)
+
+diff --git a/src/qtchooser/main.cpp b/src/qtchooser/main.cpp
+index 5e6e9cb..314b089 100644
+--- a/src/qtchooser/main.cpp
++++ b/src/qtchooser/main.cpp
+@@ -65,10 +65,12 @@
+ #if defined(_WIN32) || defined(__WIN32__)
+ #  include <process.h>
+ #  define execv _execv
++#  define stat _stat
+ #  define PATH_SEP "\\"
+ #  define EXE_SUFFIX ".exe"
+ #else
+ #  include <sys/types.h>
++#  include <sys/stat.h> 
+ #  include <dirent.h>
+ #  include <libgen.h>
+ #  include <pwd.h>
+@@ -111,8 +112,21 @@ struct Sdk
+     string librariesPath;
+ 
+     bool isValid() const { return !toolsPath.empty(); }
++    bool hasTool(const string &targetTool) const;
+ };
+ 
++bool Sdk::hasTool(const string &targetTool) const {
++    struct stat st;
++    if (toolsPath.empty())
++        return false;
++    if (stat((toolsPath + PATH_SEP + targetTool).c_str(), &st))
++        return false;
++#ifdef S_IEXEC
++    return (st.st_mode & S_IEXEC);
++#endif
++    return true;
++}
++
+ struct ToolWrapper
+ {
+     int printHelp();
+@@ -126,8 +140,9 @@ private:
+ 
+     typedef bool (*VisitFunction)(const string &targetSdk, Sdk &item);
+     typedef void (*FinishFunction)(const set<string> &seenSdks);
+-    Sdk iterateSdks(const string &targetSdk, VisitFunction visit, FinishFunction finish = 0);
+-    Sdk selectSdk(const string &targetSdk);
++    Sdk iterateSdks(const string &targetSdk, VisitFunction visit, FinishFunction finish = 0,
++                    const string &targetTool = "");
++    Sdk selectSdk(const string &targetSdk, const string &targetTool = "");
+ 
+     static void printSdks(const set<string> &seenNames);
+     static bool matchSdk(const string &targetSdk, Sdk &sdk);
+@@ -266,7 +281,7 @@ static bool mkparentdir(string name)
+ 
+ int ToolWrapper::runTool(const string &targetSdk, const string &targetTool, char **argv)
+ {
+-    Sdk sdk = selectSdk(targetSdk);
++    Sdk sdk = selectSdk(targetSdk, targetTool);
+     if (!sdk.isValid())
+         return 1;
+ 
+@@ -454,7 +469,8 @@ vector<string> ToolWrapper::searchPaths() const
+     return paths;
+ }
+ 
+-Sdk ToolWrapper::iterateSdks(const string &targetSdk, VisitFunction visit, FinishFunction finish)
++Sdk ToolWrapper::iterateSdks(const string &targetSdk, VisitFunction visit, FinishFunction finish,
++                             const string &targetTool)
+ {
+     vector<string> paths = searchPaths();
+     set<string> seenNames;
+@@ -483,11 +499,20 @@ Sdk ToolWrapper::iterateSdks(const string &targetSdk, VisitFunction visit, Finis
+                 continue;
+ 
+             seenNames.insert(d->d_name);
+-            sdk.name = d->d_name;
+-            sdk.name.resize(fnamelen + 1 - sizeof confSuffix);
++            if (targetTool.empty()) {
++                sdk.name = d->d_name;
++                sdk.name.resize(fnamelen + 1 - sizeof confSuffix);
++            } else {
++                // To make the check in matchSdk() succeed
++                sdk.name = "default";
++            }
+             sdk.configFile = path + PATH_SEP + d->d_name;
+-            if (visit && visit(targetSdk, sdk))
++            if (visit && visit(targetSdk, sdk)) {
++                // If a tool was requested, but not found here, skip this sdk
++                if (!targetTool.empty() && !sdk.hasTool(targetTool))
++                    continue;
+                 return sdk;
++            }
+         }
+ 
+         closedir(dir);
+@@ -499,9 +524,26 @@ Sdk ToolWrapper::iterateSdks(const string &targetSdk, VisitFunction visit, Finis
+     return Sdk();
+ }
+ 
+-Sdk ToolWrapper::selectSdk(const string &targetSdk)
++// All tools that exist for only one Qt version should be
++// here. Other tools in this list are qdbus and qmlscene.
++bool fallbackAllowed(const string &tool)
+ {
++    return tool == "qdbus" ||
++           tool == "qml" ||
++           tool == "qmlimportscanner" ||
++           tool == "qmlscene" ||
++           tool == "qtdiag" ||
++           tool == "qtpaths";
++}
++
++Sdk ToolWrapper::selectSdk(const string &targetSdk, const string &targetTool)
++{
++    // first, try the default Sdk
+     Sdk matchedSdk = iterateSdks(targetSdk, &ToolWrapper::matchSdk);
++    if (targetSdk.empty() && !matchedSdk.hasTool(targetTool) && fallbackAllowed(targetTool)) {
++        // if a tool was requested, fall back to any Sdk that has it
++        matchedSdk = iterateSdks(string(), &ToolWrapper::matchSdk, 0, targetTool);
++    }
+     if (!matchedSdk.isValid()) {
+         fprintf(stderr, "%s: could not find a Qt installation of '%s'\n", argv0, targetSdk.c_str());
+     }
+-- 
+2.1.0
+

=== removed file 'debian/patches/create-a-system-default-path.patch'
--- debian/patches/create-a-system-default-path.patch	2013-03-20 14:03:30 +0000
+++ debian/patches/create-a-system-default-path.patch	1970-01-01 00:00:00 +0000
@@ -1,41 +0,0 @@
---- a/src/qtchooser/Makefile
-+++ b/src/qtchooser/Makefile
-@@ -17,6 +17,10 @@ TARGET        = qtchooser
- OBJECTS_TEST  = main-test.o
- TARGET_TEST   = test/qtchooser
- 
-+ifneq ($(QTCHOOSER_GLOBAL_DIR),)
-+	QTCHOOSER_GLOBAL_DIR_VAR:=-DQTCHOOSER_GLOBAL_DIR=\"$(QTCHOOSER_GLOBAL_DIR)\"
-+endif
-+
- first: all
- check: $(TARGET_TEST)
- 
-@@ -49,10 +53,10 @@ uninstall:
- ####### Compile
- 
- main.o: main.cpp
--	$(CXX) -c -Wall -Wextra $(CXXFLAGS) $(INCPATH) -o main.o main.cpp
-+	$(CXX) -c -Wall -Wextra $(QTCHOOSER_GLOBAL_DIR_VAR) $(CXXFLAGS) $(INCPATH) -o main.o main.cpp
- 
- main-test.o: main.cpp
--	$(CXX) -c -Wall -Wextra -DQTCHOOSER_TEST_MODE -g $(CXXFLAGS) $(INCPATH) -o main-test.o main.cpp
-+	$(CXX) -c -Wall -Wextra -DQTCHOOSER_TEST_MODE $(QTCHOOSER_GLOBAL_DIR_VAR) -g $(CXXFLAGS) $(INCPATH) -o main-test.o main.cpp
- 
- ####### Install
- 
---- a/src/qtchooser/main.cpp
-+++ b/src/qtchooser/main.cpp
-@@ -265,6 +265,12 @@ vector<string> ToolWrapper::searchPaths(
-     // search the XDG config location directories
-     paths = stringSplit(qgetenv("XDG_CONFIG_DIRS", "/etc/xdg").c_str());
- 
-+#if defined(QTCHOOSER_GLOBAL_DIR)
-+    // Add QTCHOOSER_GLOBAL_DIR at the beginning.
-+    vector<string> globalDir = stringSplit(QTCHOOSER_GLOBAL_DIR);
-+    paths.insert(paths.begin(), globalDir.begin(), globalDir.end());
-+#endif
-+
-     string localDir = qgetenv("XDG_CONFIG_HOME", userHome() + PATH_SEP ".config");
-     paths.push_back(localDir);
- 

=== modified file 'debian/patches/series'
--- debian/patches/series	2014-08-13 08:41:01 +0000
+++ debian/patches/series	2014-10-07 06:42:00 +0000
@@ -1,2 +1,3 @@
 enable-tests.patch
 Add-qmlimportscanner-qtpaths.patch
+Implement-fallback-mechanism.patch

=== removed file 'debian/qtchooser.1'
--- debian/qtchooser.1	2013-02-06 12:00:59 +0000
+++ debian/qtchooser.1	1970-01-01 00:00:00 +0000
@@ -1,78 +0,0 @@
-.TH QTCHOOSER 1 "JANUARY 2, 2013"
-.\" Please adjust this date whenever revising the manpage.
-.SH NAME
-qtchooser \- a wrapper used to select between Qt development binary versions
-.SH SYNOPSIS
-.B qtchooser
-\fB\-list\-versions\fR
-.br
-.B qtchooser
-\fB\-print\-env\fR [\fB\-qt=\fIversion\fR]
-.br
-.B qtchooser
-\fB\-run\-tool=\fItool\fR [\fB\-qt=\fIversion\fR] [\fIprogram_arguments\fR]
-.br
-.B <executable_name>
-[\fB\-qt=\fIversion\fR] [\fIprogram_arguments\fR]
-.br
-.SH DESCRIPTION
-Qt is a cross-platform C++ application framework. Qt's primary feature
-is its rich set of widgets that provide standard GUI functionality.
-
-The Qt Chooser provides a wrapper to switch between versions of Qt
-development binaries when multiple versions like 4 and 5 are installed
-or local Qt builds are to be used.
-
-It is commonly used via a symlink from an \fIexecutable_name\fR like qmake.
-.SH OPTIONS
-The options which apply to the
-\fBqtchooser\fR
-command are:
-.PP
-\fB\-list\-versions\fR
-.RS 4
-Lists available Qt versions from the configuration files
-.RE
-.PP
-\fB\-print\-env\fR
-.RS 4
-Prints environment information
-.RE
-.PP
-\fB\-qt=\fIversion\fR
-.RS 4
-Selects \fIversion\fR as the Qt version to be used
-.RE
-.PP
-\fB\-run\-tool=\fItool\fR
-.RS 4
-Runs the selected \fItool\fR.
-.RE
-.SH ENVIRONMENT
-.TP
-.B QT_SELECT
-Same as \fB\-qt=\fIversion\fR. If set, the selected configuration is used and binaries
-symlinked to qtchooser will be executed without additional paramenters.
-.RE
-.TP
-.B XDG_CONFIG_HOME
-.TP
-.B XDG_CONFIG_DIRS
-Used as specified in
-<\fBhttp://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html\fR>
-.SH FILES
-.TP
-.I /etc/xdg/qtchooser/*.conf
-System-wide configuration files. Each has two lines, the first is the path
-to the binaries and the second is the path to the Qt libraries. If a
-\fIdefault.conf\fR is provided, the settings from it will be automatically
-used in case nothing else is selected.
-.TP
-.I \fB$HOME\fP/.config/qtchooser/*.conf
-User configuration files.
-
-.SH AUTHOR
-qtchooser was written by Thiago Macieira from Intel.
-.PP
-This manual page was written by Timo Jyrinki <[e-mail]>,
-for the Debian project (but may be used by others).