mumble/plugins/link/link-posix.cpp
Robert Adam 27dbee8e62 FEAT(client): Plugin framework
This commit introduces a new plugin framework into the codebase of the
Mumble client. Note that "plugin" here really refers to a (more or less)
general purpose plugin and is therefore not to be confused with the
previously available positional data plugins (only responsible for
fetching positional data from a running game and passing that to
Mumble).

The plugin interface is written in C, removing the compiler-dependence
the old "plugins" had. Instead plugins can now be written in an
arbitrary language as long as that language is capable of being compiled
into a shared library and also being capable of being C-compatible.

As already indicated a plugin is essentially a shared library that
provides certain functions that allow Mumble to interface with it.

Inside Mumble the so-called PluginManager is responsible for managing
the plugins and relaying events to the respective callbacks. Plugins
themselves can also interact with Mumble on their own initiative by
using the provided API functions.

Fixes #2455
Fixes #2148
Fixes #1594
Fixes #2051
Fixes #3742
Fixes #4575
Fixes #4751
2021-04-16 20:15:44 +02:00

190 lines
4.5 KiB
C++

// Copyright 2008-2021 The Mumble Developers. All rights reserved.
// Use of this source code is governed by a BSD-style license
// that can be found in the LICENSE file at the root of the
// Mumble source tree or at <https://www.mumble.info/LICENSE>.
#define MUMBLE_ALLOW_DEPRECATED_LEGACY_PLUGIN_API
#include "../mumble_legacy_plugin.h"
#include <stdint.h>
#include <stdio.h>
#include <wchar.h>
#include <fcntl.h>
#include <string.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>
static std::wstring wsPluginName(L"Link");
static std::wstring wsDescription;
static char memname[256];
struct LinkedMem {
uint32_t uiVersion;
uint32_t ui32count;
float fAvatarPosition[3];
float fAvatarFront[3];
float fAvatarTop[3];
wchar_t name[256];
float fCameraPosition[3];
float fCameraFront[3];
float fCameraTop[3];
wchar_t identity[256];
uint32_t context_len;
unsigned char context[256];
wchar_t description[2048];
};
/// Non-monotonic tick count in ms resolution
static int64_t GetTickCount() {
struct timeval tv;
gettimeofday(&tv, nullptr);
return tv.tv_usec / 1000 + tv.tv_sec * 1000;
}
#define lm_invalid reinterpret_cast< struct LinkedMem * >(-1)
static struct LinkedMem *lm = lm_invalid;
static int shmfd = -1;
static int64_t last_tick = 0;
static uint32_t last_count = 0;
static void unlock() {
lm->ui32count = last_count = 0;
lm->uiVersion = 0;
lm->name[0] = 0;
wsPluginName.assign(L"Link");
wsDescription.clear();
}
static int trylock() {
if (lm == lm_invalid)
return false;
if ((lm->uiVersion == 1) || (lm->uiVersion == 2)) {
if (lm->ui32count != last_count) {
last_tick = GetTickCount();
last_count = lm->ui32count;
wchar_t buff[2048];
if (lm->name[0]) {
wcsncpy(buff, lm->name, 256);
buff[255] = 0;
wsPluginName.assign(buff);
}
if (lm->description[0]) {
wcsncpy(buff, lm->description, 2048);
buff[2047] = 0;
wsDescription.assign(buff);
}
return true;
}
}
return false;
}
static const std::wstring longdesc() {
return wsDescription;
}
static int fetch(float *avatar_pos, float *avatar_front, float *avatar_top, float *camera_pos, float *camera_front,
float *camera_top, std::string &context, std::wstring &identity) {
if (lm->ui32count != last_count) {
last_tick = GetTickCount();
last_count = lm->ui32count;
} else if ((GetTickCount() - last_tick) > 5000)
return false;
if ((lm->uiVersion != 1) && (lm->uiVersion != 2))
return false;
for (int i = 0; i < 3; ++i) {
avatar_pos[i] = lm->fAvatarPosition[i];
avatar_front[i] = lm->fAvatarFront[i];
avatar_top[i] = lm->fAvatarTop[i];
}
if (lm->uiVersion == 2) {
for (int i = 0; i < 3; ++i) {
camera_pos[i] = lm->fCameraPosition[i];
camera_front[i] = lm->fCameraFront[i];
camera_top[i] = lm->fCameraTop[i];
}
if (lm->context_len > 255)
lm->context_len = 255;
lm->identity[255] = 0;
context.assign(reinterpret_cast< const char * >(lm->context), lm->context_len);
identity.assign(lm->identity);
} else {
for (int i = 0; i < 3; ++i) {
camera_pos[i] = lm->fAvatarPosition[i];
camera_front[i] = lm->fAvatarFront[i];
camera_top[i] = lm->fAvatarTop[i];
}
context.clear();
identity.clear();
}
return true;
}
__attribute__((constructor)) static void load_plugin() {
bool bCreated = false;
snprintf(memname, 256, "/MumbleLink.%d", getuid());
shmfd = shm_open(memname, O_RDWR, S_IRUSR | S_IWUSR);
if (shmfd < 0) {
bCreated = true;
shmfd = shm_open(memname, O_CREAT | O_RDWR, S_IRUSR | S_IWUSR);
}
if (shmfd < 0) {
fprintf(stderr, "Mumble Link plugin: error creating shared memory\n");
return;
}
if (bCreated) {
if (ftruncate(shmfd, sizeof(struct LinkedMem)) != 0) {
fprintf(stderr, "Mumble Link plugin: failed to resize shared memory\n");
close(shmfd);
shmfd = -1;
return;
}
}
lm = static_cast< struct LinkedMem * >(
mmap(nullptr, sizeof(struct LinkedMem), PROT_READ | PROT_WRITE, MAP_SHARED, shmfd, 0));
if ((lm != lm_invalid) && bCreated)
memset(lm, 0, sizeof(struct LinkedMem));
}
__attribute__((destructor)) static void unload_plugin() {
if (lm != lm_invalid)
munmap(lm, sizeof(struct LinkedMem));
if (shmfd > -1)
close(shmfd);
shm_unlink(memname);
}
static std::wstring description(L"Link v1.2.0");
static MumblePlugin linkplug = {
MUMBLE_PLUGIN_MAGIC, description, wsPluginName, nullptr, nullptr, trylock, unlock, longdesc, fetch
};
extern "C" MUMBLE_PLUGIN_EXPORT MumblePlugin *getMumblePlugin() {
return &linkplug;
}