Merge lp:~vanvugt/compiz/fix-1014461 into lp:compiz/0.9.8

[Daniel van Vugt]

Start a window decorator automatically when the decor plugin starts, if none
is running already (LP: #1014461)

[Daniel van Vugt (vanvugt)]

The script "compiz-decorator" has been copied from downstream Ubuntu (precise).

[Didier Roche-Tolomelli (didrocks)]

FYI, as the kde decorator doesn't work anymore, I've removed the script in quantal and starts direclty the only working window decorator (gtk-w-d)

[Daniel van Vugt (vanvugt)]

No problem. You can still configure the command to whatever you want in the ubuntu branch. This proposal is mostly for making development easier.

[Sam Spilsbury (smspillaz)]

review: Approve

[Sam Spilsbury (smspillaz)]

(preferably remove emerald, I'd prefer not to give the impression that its even supported *ugh*)

[Daniel van Vugt (vanvugt)]

I would prefer to not modify a script that's stable and already in use in the ubuntu branches :P

[Sam Spilsbury (smspillaz)]

There is no point keeping emerald. It doesn't work with newer compiz versions afaik

[Daniel van Vugt (vanvugt)]

There are people using Emerald today with precise. Someone is maintaining it in a PPA I saw recently.

[Daniel van Vugt (vanvugt)]

https://launchpad.net/~brainpower/+archive/testing

[triplesqaurednine (triplesquarednine)]

@Sam

I just tested it, not only does it work - but i am no longer plagued by the white-edges on roll up/shade - which means that is a feature that i can use again (at least with emerald, as with gtk it looks horrible). or until this code gets pulled from compiz...

I think some of the compiz-standalone folks might appreciate it as well, i see people posting screenshots of emerald all the time (running with 0.8.8). I know i was disappointed when i couldn't use it anymore with compiz++, it might draw in some of those people and be a useful alternative to gtk-window-decorator. Which as of late, i am starting to hate gtk(3) because Gnome keeps breaking themes, every release - which stopped me from maintaining 3 gtk2/3/metacity themes...

i also haven't noticed any bugs/problems or weird issues using emerald. (for an hour or so).

cheerz

[MC Return (mc-return)]

Emerald from the archive Daniel posted (https://launchpad.net/~brainpower/+archive/testing) works with 0.9.7.8 on Precise and is still the best looking and most functional window decorator.
I would even like to see Emerald being used as default in Ubuntu 12.10+.

[MC Return (mc-return)]

The only two bugs with Emerald at the moment:

https://bugs.launchpad.net/ubuntu/+source/compiz/+bug/968112

I contacted brainpower about his Emerald PPA for Precise and about compiling instructions or code changes, this is what I got as answer:
"Well,
can you tell me, what git describe prints?

if there is output like "0.8.8-1-ga8c21c4", you've got the wrong version
and gotta switch to 0.9.5 (git checkout -b 0.9.5),
then git describe should print "0.8.4-11-ga272e26" (I know its weird, but it's alright) and emerald compiles fine ;)
"
Unfortunately this did not work here yet.

The second minor issue hunts Emerald for quite some time now:
https://bugs.launchpad.net/compiz/+bug/1009570

[MC Return (mc-return)]

Regarding stability: I am running Compiz/Unity/Emerald combination on Precise for several weeks now, no crashes, no glitches with it, not even one - it is a rock-stable, beautiful window decorator.
The only issue with the disappearing buttons can easily be reproduced and so it should not be hard to fix...

[MC Return (mc-return)]

Sorry for spamming here, but I want to quote Mark Shuttleworth here:

"From a styling point of view, we think in terms of quadruples: this next release starts a cycle of four, which will culminate in 14.04 LTS. So there’s an opportunity to refresh the look. That will kick off with a project on typography to make sure we are expressing ourselves with crystal clarity – making the most of Ubuntu’s Light and Medium font weights for a start. And a project on iconography, with the University of Reading, to refine the look of apps and interfaces throughout the platform. It’s amazing how quaint the early releases of Ubuntu look compared to the current style. And we’re only just getting started! In our artistic explorations we want to embrace tessellation as an expression of the part-digital, part-organic nature of Ubuntu. We love the way tessellated art expresses both the precision and reliability of our foundations, and the freedom and collaboration of a project driven by people making stuff for people. There’s nothing quixotic in our desire to make Ubuntu the easiest, steadiest, and most beautiful way to live digitally."

For me this means: Bring Emerald and upgrade and refresh the look of Ubuntu :)

[Sam Spilsbury (smspillaz)]

The developers employed by canonical have other priorities, we don't want to increase the maintainece burden by supporting something that was never supported in the first place.

If emerald still works, then I'd be fine with allowing an internal script to start it as a last resort, but there is no support for it.

[Daniel van Vugt (vanvugt)]

We don't claim to support Emerald. If anyone wants to remove references to it from /usr/bin/compiz-decorator where it has been on Ubuntu for quite some time, then that is a different discussion.

[Alan Griffiths (alan-griffiths)]

> The developers employed by canonical have other priorities, we don't want to
> increase the maintainece burden by supporting something that was never
> supported in the first place.
>
> If emerald still works, then I'd be fine with allowing an internal script to
> start it as a last resort, but there is no support for it.

While we are not free to put time into supporting emerald we shouldn't get in the way of others who want to. But for that all that is needed is a way to flag plugins as "supported by the community".

[triplesqaurednine (triplesquarednine)]

@ Sam and Daniel

My point wasn't to say that Canonical should 'officially support Emerald'. it was more along the lines of 'leave it be, if it is working and not causing issues'... and like i said, Gtk-window-decorator has at least one eye-sore / bug that emerald does not ~ just that alone is enough for me to switch. I could understand breaking support for it, if you had some major changes and/or Emerald was causing issues, but if that is not really the case - it's probably better to let it be an option for the 'community', and by community i don't just mean the Ubuntu Community - i mean the broader linux community.

I think Alan Griffiths, best summed it up (above).

anyway, for now i would like (and am going) to stick with emerald, so i can use shade on larger windows to (quickly) peek other windows - which is a feature of compiz that i have missed, being as it's somewhat broken... and after tweaking emerald looks exactly like my metacity does - so little to no impact on GUI.

=== modified file 'plugins/decor/CMakeLists.txt'
--- plugins/decor/CMakeLists.txt	2012-05-10 15:40:25 +0000
+++ plugins/decor/CMakeLists.txt	2012-06-18 06:29:36 +0000
@@ -18,3 +18,5 @@
 	INSTALL_RPATH "${COMPIZ_LIBDIR}"
     )
 endif (COMPIZ_BUILD_WITH_RPATH AND NOT COMPIZ_DISABLE_PLUGIN_DECOR)
+
+install (PROGRAMS "src/compiz-decorator" DESTINATION ${exec_prefix})

=== modified file 'plugins/decor/decor.xml.in'
--- plugins/decor/decor.xml.in	2012-01-17 05:19:03 +0000
+++ plugins/decor/decor.xml.in	2012-06-18 06:29:36 +0000
@@ -99,7 +99,8 @@
 	    </subgroup>
 	    <option name="command" type="string">
 		<_short>Command</_short>
-		<_long>Decorator command line that is executed if no decorator is already running</_long>
+		<_long>Decorator command line that is executed if no decorator is already running. Use prefix "./" if you want the program run from the compiz bin directory.</_long>
+		<default>./compiz-decorator</default>
 	    </option>
 	    <option name="mipmap" type="bool">
 		<_short>Mipmap</_short>

=== added file 'plugins/decor/src/compiz-decorator'
--- plugins/decor/src/compiz-decorator	1970-01-01 00:00:00 +0000
+++ plugins/decor/src/compiz-decorator	2012-06-18 06:29:36 +0000
@@ -0,0 +1,101 @@
+#!/bin/sh
+# Starts Compiz Decorator depending on the DE
+# 
+# Copyright (c) 2007 CyberOrg <[e-mail]>
+# Based on compiz-manager script by Kristian Lyngstøl <[e-mail]>
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# Contributions by: crdlb
+# Modifications by: Daniel van Vugt <[e-mail]>
+#
+
+if [ -z "$COMPIZ_BIN_PATH" ]; then
+    COMPIZ_BIN_PATH="/usr/bin/"
+fi
+KWIN=`which kwin`
+METACITY="/usr/bin/metacity"
+
+#
+# Default to gtk/kde4-window-decorator
+#
+USE_EMERALD="no"
+DECORATOR=""
+
+#Do not leave users without decoration if decorator fails
+if [ "$DESKTOP_SESSION" = "kde" ]; then
+    FALLBACKWM="${KWIN}"
+else
+    FALLBACKWM="${METACITY}"
+fi
+FALLBACKWM_OPTIONS=" --replace"
+
+#
+# Set to yes to enable verbose
+#
+VERBOSE="yes"
+ 
+#
+# Echos the arguments if verbose
+#
+verbose()
+{
+    if [ "x$VERBOSE" = "xyes" ]; then
+        printf "$*"
+    fi
+}
+
+# Read configuration from XDG paths
+if [ -z "$XDG_CONFIG_DIRS" ]; then
+    test -f /etc/xdg/compiz/compiz-manager && . /etc/xdg/compiz/compiz-manager
+else
+    test -f $XDG_CONFIG_DIRS/compiz/compiz-manager && . $XDG_CONFIG_DIRS/compiz/compiz-manager
+fi
+
+if [ -z "$XDG_CONFIG_HOME" ]; then
+    test -f $HOME/.config/compiz/compiz-manager && . $HOME/.config/compiz/compiz-manager
+else
+    test -f $XDG_CONFIG_HOME/compiz/compiz-manager && .  $XDG_CONFIG_HOME/compiz/compiz-manager
+fi
+
+# start a decorator
+if [ -x ${COMPIZ_BIN_PATH}emerald ] && [ "$USE_EMERALD" = "yes" ]; then
+    DECORATOR=emerald
+elif [ -x ${COMPIZ_BIN_PATH}gtk-window-decorator ] && [ -n "$GNOME_DESKTOP_SESSION_ID" ]; then
+    DECORATOR=gtk-window-decorator
+elif [ -x ${COMPIZ_BIN_PATH}kde4-window-decorator ] && [ x$KDE_SESSION_VERSION = x"4" ]; then
+    DECORATOR=kde4-window-decorator
+fi
+
+# fall back to any decorator that is installed
+if [ -z "$DECORATOR" ]; then
+    verbose "Couldn't find a perfect decorator match; trying all decorators\n"
+    if [ -x ${COMPIZ_BIN_PATH}emerald ]; then
+        DECORATOR=emerald
+    elif [ -x ${COMPIZ_BIN_PATH}gtk-window-decorator ]; then
+	DECORATOR=gtk-window-decorator
+    elif [ -x ${COMPIZ_BIN_PATH}kde4-window-decorator ]; then
+	DECORATOR=kde4-window-decorator
+    fi
+fi
+
+if [ -n "$DECORATOR" ]; then
+    verbose "Starting ${DECORATOR}\n"
+    exec ${COMPIZ_BIN_PATH}$DECORATOR "$@"
+else
+    verbose "Found no decorator to start\n"
+    exec $FALLBACKWM $FALLBACKWM_OPTIONS
+fi
+

=== modified file 'src/screen.cpp'
--- src/screen.cpp	2012-06-01 07:38:33 +0000
+++ src/screen.cpp	2012-06-18 06:29:36 +0000
@@ -39,6 +39,7 @@
 #include <assert.h>
 #include <limits.h>
 #include <poll.h>
+#include <libgen.h>
 #include <algorithm>
 
 #include <boost/bind.hpp>
@@ -52,6 +53,7 @@
 #include <X11/extensions/shape.h>
 #include <X11/cursorfont.h>
 
+#include <core/global.h>
 #include <core/screen.h>
 #include <core/icon.h>
 #include <core/atoms.h>
@@ -3893,7 +3895,22 @@
 
 	env.append (compPrintf (".%d", privateScreen.screenNum));
 
-	putenv (const_cast<char *> (env.c_str ()));
+	putenv (strdup (env.c_str ()));  // parameter needs to be leaked!
+
+	// We need a private copy of argv[0] for dirname() to modify
+	char *argv0 = strdup (programArgv[0]);
+	if (argv0 != NULL)
+	{
+	    const char *binpath = dirname (argv0);
+	    if (binpath == NULL)
+		binpath = ".";
+	    char binenv[PATH_MAX];
+	    snprintf (binenv, sizeof(binenv)-1, "COMPIZ_BIN_PATH=%s/", binpath);
+	    putenv (strdup (binenv));  // parameter needs to be leaked!
+	    if (binpath != NULL && command.substr (0, 2) == "./")
+		command.replace (0, 1, binpath);
+	    free (argv0);
+	}
 
 	exit (execl ("/bin/sh", "/bin/sh", "-c", command.c_str (), NULL));
     }