CHANGE(ipc): move Socket and OverlayPipe to $XDG_RUNTIME_DIR/mumble/

Moving MumbleSocket and MumbleOverlayPipe to a dedicated subdirectory keeps the runtime directory clean and allows flatpak applications to use the overlay by giving access only to Mumble's subdirectory. It also moves the default directory to /run/user/$UID/mumble/ when $XDG_RUNTIME_DIR is not set. Fixes mumble-voip#5951
carlocastoldi · Nov 23, 2022 · c9eeaec · c9eeaec
1 parent ce3294f
commit c9eeaec
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 30 deletions.
diff --git a/overlay_gl/CMakeLists.txt b/overlay_gl/CMakeLists.txt
@@ -31,10 +31,9 @@ if(NOT APPLE)
 			"-Wl,-z,lazy"
 	)
 
-	set_target_properties(overlay_gl
-		PROPERTIES
-			COMPILE_DEFINITIONS
-				"TARGET_UNIX"
+	target_compile_definitions(overlay_gl
+		PRIVATE
+			"TARGET_UNIX"
 	)
 
 	if(overlay-xcompile)

diff --git a/overlay_gl/overlay.c b/overlay_gl/overlay.c
@@ -147,25 +147,37 @@ static void newContext(Context *ctx) {
 	ctx->timeT             = clock();
 	ctx->frameCount        = 0;
 
+#ifdef __linux__
+	char *xdgRuntimeDir = getenv("XDG_RUNTIME_DIR");
+
+	if (xdgRuntimeDir != NULL) {
+		ctx->saName.sun_family = PF_UNIX;
+		strcpy(ctx->saName.sun_path, xdgRuntimeDir);
+		if(xdgRuntimeDir[(strlen(xdgRuntimeDir)-1)] != '/')
+			strcat(ctx->saName.sun_path, "/");
+		strcat(ctx->saName.sun_path, "mumble/MumbleOverlayPipe");
+	} else {
+		char uid[10];
+		sprintf(uid, "%d", getuid());
+		ctx->saName.sun_family = PF_UNIX;
+		strcpy(ctx->saName.sun_path, "/run/user/");
+		strcat(ctx->saName.sun_path, uid);
+		strcat(ctx->saName.sun_path, "/mumble/MumbleOverlayPipe");
+	}
+#else
 	char *home = getenv("HOME");
 	if (home == NULL) {
 		struct passwd *pwent = getpwuid(getuid());
 		if (pwent && pwent->pw_dir && pwent->pw_dir[0]) {
 			home = pwent->pw_dir;
 		}
 	}
-
-	char *xdgRuntimeDir = getenv("XDG_RUNTIME_DIR");
-
-	if (xdgRuntimeDir != NULL) {
-		ctx->saName.sun_family = PF_UNIX;
-		strcpy(ctx->saName.sun_path, xdgRuntimeDir);
-		strcat(ctx->saName.sun_path, "/MumbleOverlayPipe");
-	} else if (home) {
+	if (home) {
 		ctx->saName.sun_family = PF_UNIX;
 		strcpy(ctx->saName.sun_path, home);
-		strcat(ctx->saName.sun_path, "/.MumbleOverlayPipe");
+		strcat(ctx->saName.sun_path, "/MumbleOverlayPipe");
 	}
+#endif
 
 	ods("OpenGL Version %s, Vendor %s, Renderer %s, Shader %s", glGetString(GL_VERSION), glGetString(GL_VENDOR),
 		glGetString(GL_RENDERER), glGetString(GL_SHADING_LANGUAGE_VERSION));

diff --git a/src/mumble/Overlay.cpp b/src/mumble/Overlay.cpp
@@ -244,13 +244,15 @@ void Overlay::createPipe() {
 #else
 	{
 		QString xdgRuntimePath = QProcessEnvironment::systemEnvironment().value(QLatin1String("XDG_RUNTIME_DIR"));
-		QDir xdgRuntimeDir     = QDir(xdgRuntimePath);
-
-		if (!xdgRuntimePath.isNull() && xdgRuntimeDir.exists()) {
-			pipepath = xdgRuntimeDir.absoluteFilePath(QLatin1String("MumbleOverlayPipe"));
+		QString mumbleRuntimePath;
+		if (!xdgRuntimePath.isNull()) {
+		    mumbleRuntimePath = QDir(xdgRuntimePath).absolutePath() + QLatin1String("/mumble/");
 		} else {
-			pipepath = QDir::home().absoluteFilePath(QLatin1String(".MumbleOverlayPipe"));
+			mumbleRuntimePath = QLatin1String("/run/user/") + QString::number(getuid()) + QLatin1String("/mumble/");
 		}
+		QDir mumbleRuntimeDir = QDir(mumbleRuntimePath);
+		mumbleRuntimeDir.mkpath(".");
+		pipepath = mumbleRuntimeDir.absoluteFilePath(QLatin1String("MumbleOverlayPipe"));
 	}
 
 	{

diff --git a/src/mumble/SocketRPC.cpp b/src/mumble/SocketRPC.cpp
@@ -236,13 +236,15 @@ SocketRPC::SocketRPC(const QString &basename, QObject *p) : QObject(p) {
 #else
 	{
 		QString xdgRuntimePath = QProcessEnvironment::systemEnvironment().value(QLatin1String("XDG_RUNTIME_DIR"));
-		QDir xdgRuntimeDir     = QDir(xdgRuntimePath);
-
-		if (!xdgRuntimePath.isNull() && xdgRuntimeDir.exists()) {
-			pipepath = xdgRuntimeDir.absoluteFilePath(basename + QLatin1String("Socket"));
+		QString mumbleRuntimePath;
+		if (!xdgRuntimePath.isNull()) {
+		    mumbleRuntimePath = QDir(xdgRuntimePath).absolutePath() + QLatin1String("/mumble/");
 		} else {
-			pipepath = QDir::home().absoluteFilePath(QLatin1String(".") + basename + QLatin1String("Socket"));
+			mumbleRuntimePath = QLatin1String("/run/user/") + QString::number(getuid()) + QLatin1String("/mumble/");
 		}
+		QDir mumbleRuntimeDir = QDir(mumbleRuntimePath);
+		mumbleRuntimeDir.mkpath(".");
+		pipepath = mumbleRuntimeDir.absoluteFilePath(basename + QLatin1String("Socket"));
 	}
 
 	{
@@ -280,13 +282,15 @@ bool SocketRPC::send(const QString &basename, const QString &request, const QMap
 #else
 	{
 		QString xdgRuntimePath = QProcessEnvironment::systemEnvironment().value(QLatin1String("XDG_RUNTIME_DIR"));
-		QDir xdgRuntimeDir     = QDir(xdgRuntimePath);
-
-		if (!xdgRuntimePath.isNull() && xdgRuntimeDir.exists()) {
-			pipepath = xdgRuntimeDir.absoluteFilePath(basename + QLatin1String("Socket"));
+		QString mumbleRuntimePath;
+		if (!xdgRuntimePath.isNull()) {
+		    mumbleRuntimePath = QDir(xdgRuntimePath).absolutePath() + QLatin1String("/mumble/");
 		} else {
-			pipepath = QDir::home().absoluteFilePath(QLatin1String(".") + basename + QLatin1String("Socket"));
+			mumbleRuntimePath = QLatin1String("/run/user/") + QString::number(getuid()) + QLatin1String("/mumble/");
 		}
+		QDir mumbleRuntimeDir = QDir(mumbleRuntimePath);
+		mumbleRuntimeDir.mkpath(".");
+		pipepath = mumbleRuntimeDir.absoluteFilePath(basename + QLatin1String("Socket"));
 	}
 #endif
 
@@ -325,3 +329,4 @@ bool SocketRPC::send(const QString &basename, const QString &request, const QMap
 
 	return QVariant(succ.text()).toBool();
 }
+
diff --git a/src/tests/OverlayTest.cpp b/src/tests/OverlayTest.cpp
@@ -16,6 +16,7 @@
 #	include "win.h"
 #endif
 
+#include <unistd.h>
 #include <QtCore>
 #include <QtGui>
 #include <QtNetwork>
@@ -96,7 +97,18 @@ void OverlayWidget::paintEvent(QPaintEvent *) {
 #ifdef Q_OS_WIN
 		qlsSocket->connectToServer(QLatin1String("MumbleOverlayPipe"));
 #else
-		qlsSocket->connectToServer(QDir::home().absoluteFilePath(QLatin1String(".MumbleOverlayPipe")));
+		QString xdgRuntimePath = QProcessEnvironment::systemEnvironment().value(QLatin1String("XDG_RUNTIME_DIR"));
+		QString mumbleRuntimePath;
+		if (!xdgRuntimePath.isNull()) {
+		    mumbleRuntimePath = QDir(xdgRuntimePath).absolutePath() + QLatin1String("/mumble/");
+		} else {
+			mumbleRuntimePath = QLatin1String("/run/user/") + QString::number(getuid()) + QLatin1String("/mumble/");
+		}
+		QDir mumbleRuntimeDir = QDir(mumbleRuntimePath);
+		mumbleRuntimeDir.mkpath(".");
+		QString pipepath = mumbleRuntimeDir.absoluteFilePath(QLatin1String("MumbleOverlayPipe"));
+		qWarning() << "connectToServer(" << pipepath << ")";
+		qlsSocket->connectToServer(pipepath);
 #endif
 	}
 
@@ -166,7 +178,7 @@ void OverlayWidget::disconnected() {
 }
 
 void OverlayWidget::error(QLocalSocket::LocalSocketError) {
-	qWarning() << "error";
+	perror("error");
 	disconnected();
 }