Merge lp:~mc-return/compiz/compiz0.9.9.merge-plugin-startup into lp:compiz/0.9.10

[MC Return]

*Startup:
Added the plug-in "Startup" converted from git to bzr (including full history) to lp:compiz.

Cleaned up code and .xml, so it meets high Compiz standards.

(LP: #1012206)

Another useful plugin lost in the realms of the git repo :)

What can this be used for, one might ask...

Example 1:
You want to autostart some widgets, which should use Compiz' widget layer plugin and reside on their own layer.
To achieve this you have to ensure those widgets start after Compiz (Best option: First Time).

Example 2:
You want to ensure some OpenGL program starts after Compiz, like a GL-dock for example.

[MC Return (mc-return)]

I guess the only thing that is missing here now is to replace this macro:

267 +#define GET_ENV_VAR(ourvar, envvar, error) \
268 + ourvar = getenv(#envvar); \
269 + if (ourvar == NULL) \
270 + { \
271 + compLogMessage ("startup", CompLogLevelError, \
272 + "Environment variable " #envvar " is not set"); \
273 + error = true; \
274 + return; \
275 +}
276 +GET_ENV_VAR (dbus_env_var, DBUS_SESSION_BUS_ADDRESS, error)
277 +GET_ENV_VAR (dsp, DISPLAY, error)
278 +GET_ENV_VAR (home, HOME, error)
279 +#undef GET_ENV_VAR

- but I fear this could blow up my computer and I would be pleased if someone could help with this or give me some good tips on how best to replace this...

review: Needs Information

[lp:~mc-return/compiz/compiz0.9.9.merge-plugin-startup]

3303. By MC Return on 2013-04-28

Minor additional .xml improvements
(indentation, better tooltip)

[Sam Spilsbury (smspillaz)]

easy:

namespace
{
inline const char * getEnvVar (const char *env, bool &error)
{
    char *value = getenv (env);
    if (value == NULL)
    {
        compLogMessage ("startup", CompLogLevelError, "environment variable %s is not set", env);
        error = true;
        return NULL;
    }
    return value;
}
}

dbus_env_var = getEnvVar (DBUS_SESSION_BUS_ADDRESS, error);
dsp = getEnvVar (DISPLAY, error);
home = getEnvVar (HOME, error);

Although now I've just realized how poorly-written this code is in terms of having a class-scope "error" variable instead of just calling setFailed () on the constructor.

[MC Return (mc-return)]

> easy:
>
> namespace
> {
> inline const char * getEnvVar (const char *env, bool &error)
> {
> char *value = getenv (env);
> if (value == NULL)
> {
> compLogMessage ("startup", CompLogLevelError, "environment variable %s
> is not set", env);
> error = true;
> return NULL;
> }
> return value;
> }
> }
>
> dbus_env_var = getEnvVar (DBUS_SESSION_BUS_ADDRESS, error);
> dsp = getEnvVar (DISPLAY, error);
> home = getEnvVar (HOME, error);
>
Thanks :)

> Although now I've just realized how poorly-written this code is in terms of
> having a class-scope "error" variable instead of just calling setFailed () on
> the constructor.

I'll fix that.

[lp:~mc-return/compiz/compiz0.9.9.merge-plugin-startup]

3304. By MC Return on 2013-05-14

Merged latest lp:compiz

3305. By MC Return on 2013-05-14

Improved/harmonized ABI check

3306. By MC Return on 2013-05-18

Merged latest lp:compiz

Unmerged revisions

3306. By MC Return on 2013-05-18

Merged latest lp:compiz

3305. By MC Return on 2013-05-14

Improved/harmonized ABI check

3304. By MC Return on 2013-05-14

Merged latest lp:compiz

3303. By MC Return on 2013-04-28

Minor additional .xml improvements
(indentation, better tooltip)

3302. By MC Return on 2013-04-28

Added . to comment

3301. By MC Return on 2013-04-28

C++ style for comments
Fixed compilation (macro)

3300. By MC Return on 2013-04-28

Fixed typo

3299. By MC Return on 2013-04-28

Merged latest lp:compiz

3298. By MC Return on 2013-04-28

Fixed indentation
Use prefix instead of postfix increments
if (i == 0) -> if (!i)
C++ style for comments
Added newlines to improve readability

3297. By MC Return on 2013-01-31

Merged latest lp:compiz

=== modified file 'debian/compiz-plugins.install'
--- debian/compiz-plugins.install	2013-02-26 16:48:27 +0000
+++ debian/compiz-plugins.install	2013-05-18 13:41:27 +0000
@@ -40,6 +40,7 @@
 debian/tmp/usr/share/compiz/showmouse
 debian/tmp/usr/*/compiz/*splash.*
 debian/tmp/usr/share/compiz/splash
+debian/tmp/usr/*/compiz/*startup.*
 debian/tmp/usr/*/compiz/*showrepaint.*
 debian/tmp/usr/*/compiz/*switcher.*
 debian/tmp/usr/*/compiz/*td.*

=== added directory 'plugins/startup'
=== added file 'plugins/startup/CMakeLists.txt'
--- plugins/startup/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ plugins/startup/CMakeLists.txt	2013-05-18 13:41:27 +0000
@@ -0,0 +1,5 @@
+find_package (Compiz REQUIRED)
+
+include (CompizPlugin)
+
+compiz_plugin (startup PLUGINDEPS composite)

=== added directory 'plugins/startup/src'
=== added file 'plugins/startup/src/startup.cpp'
--- plugins/startup/src/startup.cpp	1970-01-01 00:00:00 +0000
+++ plugins/startup/src/startup.cpp	2013-05-18 13:41:27 +0000
@@ -0,0 +1,286 @@
+#include "startup.h"
+
+
+COMPIZ_PLUGIN_20090315 (startup, StartupPluginVTable);
+
+/* mkdir_p: Creates a directory making parent directories as needed.
+ * (same as mkdir -p)
+ */
+void
+mkdir_p(CompString &pathname)
+{
+    if (mkdir(pathname.c_str(), 0777) < 0)
+    {
+	/* If we couldn't make the whole directory because of ENOENT (a
+	 * parent directory doesn't exist), then try recursively to make
+	 * the immediate parent directory. */
+	if (errno == ENOENT)
+	{
+	    size_t slash = pathname.rfind('/');
+
+	    if (slash != CompString::npos)
+	    {
+		CompString prefix = pathname.substr(0, slash);
+		mkdir_p(prefix);
+		mkdir(pathname.c_str(), 0777);
+	    }
+	}
+    }
+}
+
+void
+StartupScreen::RunCommands()
+{
+    updateOptions();
+
+    if (numCommands < 1);
+	ranCommands = true;
+
+    for (int i = 0; i < numCommands; ++i)
+    {
+	/* FIXME: There may be a neater way to set this bool. */
+	if (!i)
+	    ranCommands = true;
+
+	if (error)
+	{
+	    compLogMessage ("startup", CompLogLevelError, "An error occurred, doing nothing.");
+	    return;
+	}
+	/* else
+	 * Run the commands.
+	 * If first time in this session, run all commands except with option 2.
+	 */
+	if (firstSession && commands[i].interval != 2)
+	{
+	    screen->runCommand (commands[i].command);
+	    continue;
+	}
+	/* If we've already run compiz at least once in this session,
+	 * run all commands with option 1 (Every)
+	 */
+	if (firstRun && commands[i].interval == 1)
+	{
+	    screen->runCommand (commands[i].command);
+	    continue;
+	}
+	/* Hopefully, these will be all of the commands with option 2 :-P */
+	if (!firstSession && !alreadyRunning && commands[i].interval == 2)
+	    screen->runCommand (commands[i].command);
+    }
+
+    return;
+}
+
+void
+StartupScreen::UpdateStatus()
+{
+
+    /* We're only interested in the dbus ID. */
+    CompString s(dbus_env_var);
+    size_t idx = s.find("guid=");
+    CompString dbus_id = s.substr(idx+5) + "\n";
+
+
+    std::fstream lock;
+    int nCompPid = getpid();
+    CompString compLockFile = lockdir + "complock" + dsp;
+    CompString xLockFile = lockdir + "xlock" + dsp;
+
+    lock.open(xLockFile.c_str (), std::ios::in);
+
+    if (!lock)
+    {
+	compLogMessage ("startup", CompLogLevelWarn, "Could not open %s for reading: %s", xLockFile.c_str (), strerror(errno));
+	compLogMessage ("startup", CompLogLevelWarn, "Perhaps this is the first time using this plugin?");
+    }
+    else
+    {
+	int nCompLock = 0;
+	std::stringstream xstrm;
+	xstrm << lock.rdbuf ();
+	lock.close ();
+	lock.open(compLockFile.c_str (), std::ios::in);
+
+	if (!lock)
+	{
+	    compLogMessage ("startup", CompLogLevelWarn, "Could not open %s for reading: %s", compLockFile.c_str (), strerror(errno));
+	    compLogMessage ("startup", CompLogLevelWarn, "Perhaps this is the first time using this plugin?");
+	}
+	else
+	{
+	    lock >> nCompLock;
+	    lock.close ();
+
+	    if (xstrm.str () == dbus_id)
+	    {
+		/* Compiz has already been run in this X session. */
+		if (nCompLock == nCompPid)
+		{
+		    // Control is reaching this path but compiz is already running
+		    // Plugins are most likely being reloaded
+		    if (!firstRun)
+			alreadyRunning = true;
+
+		    return;
+		}
+		else
+		{
+		    lock.open(compLockFile.c_str (), std::ios::out);
+
+		    if (!lock)
+			compLogMessage ("startup", CompLogLevelWarn, "Couldn't open %s for writing: %s", compLockFile.c_str (), strerror(errno));
+		    else
+		    {
+			/* Compiz has just been started. Save it's PID. */
+			if (!firstSession)
+			    firstRun = true;
+			lock << nCompPid;
+			lock.close ();
+			return;
+		    }
+		}
+	    }
+	}
+    }
+
+    mkdir_p(lockdir);
+    lock.open (xLockFile.c_str (), std::ios::out);
+
+    if (!lock)
+	compLogMessage ("startup", CompLogLevelWarn, "Could not open %s for writing: %s", xLockFile.c_str (), strerror(errno));
+    else
+    {
+	/* First time Compiz has been run in this X session. */
+	firstSession = true;
+	lock << dbus_id;
+	lock.close();
+    }
+
+    lock.open(compLockFile.c_str (), std::ios::out);
+
+    if (!lock)
+    {
+	compLogMessage ("startup", CompLogLevelWarn, "Could not open %s for writing: %s", compLockFile.c_str (), strerror(errno));
+    }
+    else
+    {
+	/* Save the PID */
+	if(firstSession)
+	    lock << nCompPid;
+
+	lock.close ();
+	return;
+    }
+
+    return;
+}
+
+bool
+StartupWindow::damageRect (bool           initial,
+			   const CompRect &rect)
+{
+    STARTUP_SCREEN (screen);
+
+    if (!ss->ranCommands)
+	ss->RunCommands();
+    else
+	cWindow->damageRectSetEnabled (this, false);
+
+    return cWindow->damageRect (initial, rect);
+}
+
+void
+StartupScreen::updateOptions ()
+{
+#define GET_OPTION(opt) CompOption::Value::Vector c##opt = optionGet##opt ();
+    GET_OPTION (PostStartupCommand);
+    GET_OPTION (PostStartupInterval);
+#undef GET_OPTION
+
+    if (cPostStartupCommand.size () != cPostStartupInterval.size ())
+    {
+	compLogMessage ("startup", CompLogLevelWarn, "Malformed option");
+	return;
+    }
+
+    commands.clear ();
+
+    for (unsigned int i = 0; i < cPostStartupCommand.size (); ++i, ++numCommands)
+    {
+	commands.push_back (StartupCommand ());
+	commands[i].command = cPostStartupCommand[i].s ();
+	commands[i].interval = cPostStartupInterval[i].i ();
+    }
+
+    UpdateStatus ();
+
+    return;
+}
+
+void
+StartupScreen::optionChanged (CompOption *opt, Options num)
+{
+    updateOptions ();
+}
+
+StartupScreen::StartupScreen (CompScreen *screen) :
+    PluginClassHandler <StartupScreen, CompScreen> (screen),
+    cScreen (CompositeScreen::get (screen)),
+    commands ()
+{
+    optionSetPostStartupCommandNotify    (boost::bind (&StartupScreen::
+						       optionChanged, this, _1, _2));
+
+    ranCommands = firstRun = firstSession = alreadyRunning = error = false;
+
+    numCommands = 0;
+
+#define GET_ENV_VAR(ourvar, envvar, error)	    \
+    ourvar = getenv(#envvar);			    \
+    if (ourvar == NULL)				    \
+    {						    \
+    compLogMessage ("startup", CompLogLevelError,   \
+    "Environment variable " #envvar " is not set"); \
+    error = true;				    \
+    return;					    \
+}
+GET_ENV_VAR (dbus_env_var, DBUS_SESSION_BUS_ADDRESS, error)
+GET_ENV_VAR (dsp, DISPLAY, error)
+GET_ENV_VAR (home, HOME, error)
+#undef GET_ENV_VAR
+
+	    /* We may be at risk of modifying the actual DISPLAY env var here... */
+	    dsp[2] = 0;
+	    /* ...though tests have shown it doesn't happen. */
+
+    lockdir = "/.compiz/locks/startup/";
+    lockdir.insert (0,home);
+}
+
+StartupWindow::StartupWindow (CompWindow *window) :
+    PluginClassHandler <StartupWindow, CompWindow> (window),
+    cWindow (CompositeWindow::get (window))
+{
+    CompositeWindowInterface::setHandler (cWindow);
+}
+
+StartupScreen::~StartupScreen ()
+{
+}
+
+StartupWindow::~StartupWindow ()
+{
+}
+
+bool
+StartupPluginVTable::init ()
+{
+    if (CompPlugin::checkPluginABI ("core", CORE_ABIVERSION) &&
+	CompPlugin::checkPluginABI ("composite", COMPIZ_COMPOSITE_ABI))
+	return true;
+
+    compLogMessage ("startup", CompLogLevelError, "Unable to verify if core and composite are present\n");
+
+    return false;
+}

=== added file 'plugins/startup/src/startup.h'
--- plugins/startup/src/startup.h	1970-01-01 00:00:00 +0000
+++ plugins/startup/src/startup.h	2013-05-18 13:41:27 +0000
@@ -0,0 +1,81 @@
+#include <fstream>
+#include <errno.h>
+#include <sstream>
+#include <sys/stat.h>
+#include <core/core.h>
+#include <composite/composite.h>
+
+#include "startup_options.h"
+
+class StartupCommand
+{
+    public:
+
+	CompString      command;
+	int             interval;
+};
+
+typedef std::vector<StartupCommand> StartupCommands;
+
+class StartupScreen :
+	public PluginClassHandler <StartupScreen, CompScreen>,
+	public StartupOptions
+{
+    public:
+
+	StartupScreen (CompScreen *);
+	~StartupScreen ();
+
+	CompositeScreen *cScreen;
+
+	bool            ranCommands;
+	bool            firstRun;
+	bool            firstSession;
+	bool            alreadyRunning;
+	bool            error;
+
+	char            *dbus_env_var;
+	char            *dsp;
+	char            *home;
+
+	CompString      lockdir;
+
+	StartupCommands commands;
+
+	int             numCommands;
+
+	void updateOptions ();
+
+	void UpdateStatus ();
+
+	void RunCommands ();
+
+	void optionChanged (CompOption*, Options);
+};
+
+class StartupWindow :
+	public PluginClassHandler <StartupWindow, CompWindow>,
+	public CompositeWindowInterface
+{
+    public:
+
+	StartupWindow (CompWindow *);
+	~StartupWindow ();
+
+	CompWindow *window;
+	CompositeWindow *cWindow;
+
+	bool
+	damageRect (bool, const CompRect&);
+};
+
+#define STARTUP_SCREEN(s)						\
+    StartupScreen *ss = StartupScreen::get (s);
+
+class StartupPluginVTable :
+	public CompPlugin::VTableForScreenAndWindow <StartupScreen, StartupWindow>
+{
+    public:
+
+	bool init ();
+};

=== added file 'plugins/startup/startup.xml.in'
--- plugins/startup/startup.xml.in	1970-01-01 00:00:00 +0000
+++ plugins/startup/startup.xml.in	2013-05-18 13:41:27 +0000
@@ -0,0 +1,45 @@
+<?xml version="1.0"?>
+<compiz>
+	<plugin name="startup" useBcop="true">
+	<_short>Startup</_short>
+	<_long>Define commands to run after Compiz is properly loaded</_long>
+	<category>Utility</category>
+		<deps>
+			<requirement>
+				<plugin>composite</plugin>
+			</requirement>
+			<relation type="after">
+				<plugin>composite</plugin>
+			</relation>
+		</deps>
+	<options>
+		<subgroup>
+			<option name="post_startup_command" type="list">
+				<_short>Command</_short>
+				<_long>The command to run.</_long>
+				<type>string</type>
+			</option>
+			<option name="post_startup_interval" type="list">
+				<_short>Interval</_short>
+				<_long>Interval the command will be run per X session. First Time: First time Compiz is started. Every Time: Every time Compiz starts. After First: Every time except the first time.</_long>
+				<type>int</type>
+				<min>0</min>
+				<max>2</max>
+				<desc>
+					<value>0</value>
+					<_name>First Time</_name>
+				</desc>
+				<desc>
+					<value>1</value>
+					<_name>Every Time</_name>
+				</desc>
+				<desc>
+					<value>2</value>
+					<_name>After First</_name>
+				</desc>
+			</option>
+		</subgroup>
+	</options>
+	</plugin>
+</compiz>
+