mirror of
https://github.com/mpv-player/mpv
synced 2024-12-24 15:52:25 +00:00
c58f9a6579
The recently added feature to load scripts from a sub-directory. A problem was that the script name was still derived from the actual script source file that was loaded, which was always "main.lua" (or similar), resulting in "main" as name. Fix this by using the directory name. One odd corner case is that you can do "--script=/path/foo////". As by POSIX semantics, the extra "/" are ignored. However, the newly added code strips only one separator, so mp_basename() returns "" (as it should), and the empty name makes mp_new_client() fail in turn. I don't really care about this, just don't do it. But mp_new_client() failure was silent (since it normally never happens), so add at least an error message for that, instead of being entirely silent.
314 lines
9.0 KiB
C
314 lines
9.0 KiB
C
/*
|
|
* This file is part of mpv.
|
|
*
|
|
* mpv is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* mpv 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 Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with mpv. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include <string.h>
|
|
#include <strings.h>
|
|
#include <sys/types.h>
|
|
#include <dirent.h>
|
|
#include <math.h>
|
|
#include <pthread.h>
|
|
#include <assert.h>
|
|
|
|
#include "config.h"
|
|
|
|
#include "osdep/io.h"
|
|
#include "osdep/threads.h"
|
|
|
|
#include "common/common.h"
|
|
#include "common/msg.h"
|
|
#include "options/m_config.h"
|
|
#include "options/parse_configfile.h"
|
|
#include "options/path.h"
|
|
#include "misc/bstr.h"
|
|
#include "core.h"
|
|
#include "client.h"
|
|
#include "libmpv/client.h"
|
|
|
|
extern const struct mp_scripting mp_scripting_lua;
|
|
extern const struct mp_scripting mp_scripting_cplugin;
|
|
extern const struct mp_scripting mp_scripting_js;
|
|
|
|
static const struct mp_scripting *const scripting_backends[] = {
|
|
#if HAVE_LUA
|
|
&mp_scripting_lua,
|
|
#endif
|
|
#if HAVE_CPLUGINS
|
|
&mp_scripting_cplugin,
|
|
#endif
|
|
#if HAVE_JAVASCRIPT
|
|
&mp_scripting_js,
|
|
#endif
|
|
NULL
|
|
};
|
|
|
|
static char *script_name_from_filename(void *talloc_ctx, const char *fname)
|
|
{
|
|
fname = mp_basename(fname);
|
|
if (fname[0] == '@')
|
|
fname += 1;
|
|
char *name = talloc_strdup(talloc_ctx, fname);
|
|
// Drop file extension
|
|
char *dot = strrchr(name, '.');
|
|
if (dot)
|
|
*dot = '\0';
|
|
// Turn it into a safe identifier - this is used with e.g. dispatching
|
|
// input via: "send scriptname ..."
|
|
for (int n = 0; name[n]; n++) {
|
|
char c = name[n];
|
|
if (!(c >= 'A' && c <= 'Z') && !(c >= 'a' && c <= 'z') &&
|
|
!(c >= '0' && c <= '9'))
|
|
name[n] = '_';
|
|
}
|
|
return talloc_asprintf(talloc_ctx, "%s", name);
|
|
}
|
|
|
|
static void *script_thread(void *p)
|
|
{
|
|
pthread_detach(pthread_self());
|
|
|
|
struct mp_script_args *arg = p;
|
|
|
|
char name[90];
|
|
snprintf(name, sizeof(name), "%s (%s)", arg->backend->name,
|
|
mpv_client_name(arg->client));
|
|
mpthread_set_name(name);
|
|
|
|
if (arg->backend->load(arg) < 0)
|
|
MP_ERR(arg, "Could not load %s %s\n", arg->backend->name, arg->filename);
|
|
|
|
mpv_destroy(arg->client);
|
|
talloc_free(arg);
|
|
return NULL;
|
|
}
|
|
|
|
static int mp_load_script(struct MPContext *mpctx, const char *fname)
|
|
{
|
|
char *ext = mp_splitext(fname, NULL);
|
|
if (ext && strcasecmp(ext, "disable") == 0)
|
|
return 0;
|
|
|
|
void *tmp = talloc_new(NULL);
|
|
|
|
const char *path = NULL;
|
|
char *script_name = NULL;
|
|
const struct mp_scripting *backend = NULL;
|
|
|
|
struct stat s;
|
|
if (!stat(fname, &s) && S_ISDIR(s.st_mode)) {
|
|
path = fname;
|
|
fname = NULL;
|
|
|
|
for (int n = 0; scripting_backends[n]; n++) {
|
|
const struct mp_scripting *b = scripting_backends[n];
|
|
char *filename = mp_tprintf(80, "main.%s", b->file_ext);
|
|
fname = mp_path_join(tmp, path, filename);
|
|
if (!stat(fname, &s) && S_ISREG(s.st_mode)) {
|
|
backend = b;
|
|
break;
|
|
}
|
|
talloc_free((void *)fname);
|
|
fname = NULL;
|
|
}
|
|
|
|
if (!fname) {
|
|
MP_ERR(mpctx, "Cannot find main.* for any supported scripting "
|
|
"backend in: %s\n", path);
|
|
talloc_free(tmp);
|
|
return -1;
|
|
}
|
|
|
|
script_name = talloc_strdup(tmp, path);
|
|
mp_path_strip_trailing_separator(script_name);
|
|
script_name = mp_basename(script_name);
|
|
} else {
|
|
for (int n = 0; scripting_backends[n]; n++) {
|
|
const struct mp_scripting *b = scripting_backends[n];
|
|
if (ext && strcasecmp(ext, b->file_ext) == 0) {
|
|
backend = b;
|
|
break;
|
|
}
|
|
}
|
|
script_name = script_name_from_filename(tmp, fname);
|
|
}
|
|
|
|
if (!backend) {
|
|
MP_ERR(mpctx, "Can't load unknown script: %s\n", fname);
|
|
talloc_free(tmp);
|
|
return -1;
|
|
}
|
|
|
|
struct mp_script_args *arg = talloc_ptrtype(NULL, arg);
|
|
*arg = (struct mp_script_args){
|
|
.mpctx = mpctx,
|
|
.filename = talloc_strdup(arg, fname),
|
|
.path = talloc_strdup(arg, path),
|
|
.backend = backend,
|
|
// Create the client before creating the thread; otherwise a race
|
|
// condition could happen, where MPContext is destroyed while the
|
|
// thread tries to create the client.
|
|
.client = mp_new_client(mpctx->clients, script_name),
|
|
};
|
|
|
|
talloc_free(tmp);
|
|
|
|
if (!arg->client) {
|
|
MP_ERR(mpctx, "Failed to create client for script: %s\n", fname);
|
|
talloc_free(arg);
|
|
return -1;
|
|
}
|
|
|
|
mp_client_set_weak(arg->client);
|
|
arg->log = mp_client_get_log(arg->client);
|
|
|
|
MP_DBG(arg, "Loading %s %s...\n", backend->name, fname);
|
|
|
|
pthread_t thread;
|
|
if (pthread_create(&thread, NULL, script_thread, arg)) {
|
|
mpv_destroy(arg->client);
|
|
talloc_free(arg);
|
|
return -1;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
int mp_load_user_script(struct MPContext *mpctx, const char *fname)
|
|
{
|
|
char *path = mp_get_user_path(NULL, mpctx->global, fname);
|
|
int ret = mp_load_script(mpctx, path);
|
|
talloc_free(path);
|
|
return ret;
|
|
}
|
|
|
|
static int compare_filename(const void *pa, const void *pb)
|
|
{
|
|
char *a = (char *)pa;
|
|
char *b = (char *)pb;
|
|
return strcmp(a, b);
|
|
}
|
|
|
|
static char **list_script_files(void *talloc_ctx, char *path)
|
|
{
|
|
char **files = NULL;
|
|
int count = 0;
|
|
DIR *dp = opendir(path);
|
|
if (!dp)
|
|
return NULL;
|
|
struct dirent *ep;
|
|
while ((ep = readdir(dp))) {
|
|
if (ep->d_name[0] != '.') {
|
|
char *fname = mp_path_join(talloc_ctx, path, ep->d_name);
|
|
struct stat s;
|
|
if (!stat(fname, &s) && (S_ISREG(s.st_mode) || S_ISDIR(s.st_mode)))
|
|
MP_TARRAY_APPEND(talloc_ctx, files, count, fname);
|
|
}
|
|
}
|
|
closedir(dp);
|
|
if (files)
|
|
qsort(files, count, sizeof(char *), compare_filename);
|
|
MP_TARRAY_APPEND(talloc_ctx, files, count, NULL);
|
|
return files;
|
|
}
|
|
|
|
static void load_builtin_script(struct MPContext *mpctx, bool enable,
|
|
const char *fname)
|
|
{
|
|
void *tmp = talloc_new(NULL);
|
|
// (The name doesn't have to match if there were conflicts with other
|
|
// scripts, so this is on best-effort basis.)
|
|
char *name = script_name_from_filename(tmp, fname);
|
|
if (enable != mp_client_exists(mpctx, name)) {
|
|
if (enable) {
|
|
mp_load_script(mpctx, fname);
|
|
} else {
|
|
// Try to unload it by sending a shutdown event. This can be
|
|
// unreliable, because user scripts could have clashing names, or
|
|
// disabling and then quickly re-enabling a builtin script might
|
|
// detect the still-terminating script as loaded.
|
|
mp_client_send_event(mpctx, name, 0, MPV_EVENT_SHUTDOWN, NULL);
|
|
}
|
|
}
|
|
talloc_free(tmp);
|
|
}
|
|
|
|
void mp_load_builtin_scripts(struct MPContext *mpctx)
|
|
{
|
|
load_builtin_script(mpctx, mpctx->opts->lua_load_osc, "@osc.lua");
|
|
load_builtin_script(mpctx, mpctx->opts->lua_load_ytdl, "@ytdl_hook.lua");
|
|
load_builtin_script(mpctx, mpctx->opts->lua_load_stats, "@stats.lua");
|
|
load_builtin_script(mpctx, mpctx->opts->lua_load_console, "@console.lua");
|
|
}
|
|
|
|
bool mp_load_scripts(struct MPContext *mpctx)
|
|
{
|
|
bool ok = true;
|
|
|
|
// Load scripts from options
|
|
char **files = mpctx->opts->script_files;
|
|
for (int n = 0; files && files[n]; n++) {
|
|
if (files[n][0])
|
|
ok &= mp_load_user_script(mpctx, files[n]) >= 0;
|
|
}
|
|
if (!mpctx->opts->auto_load_scripts)
|
|
return ok;
|
|
|
|
// Load all scripts
|
|
void *tmp = talloc_new(NULL);
|
|
char **scriptsdir = mp_find_all_config_files(tmp, mpctx->global, "scripts");
|
|
for (int i = 0; scriptsdir && scriptsdir[i]; i++) {
|
|
files = list_script_files(tmp, scriptsdir[i]);
|
|
for (int n = 0; files && files[n]; n++)
|
|
ok &= mp_load_script(mpctx, files[n]) >= 0;
|
|
}
|
|
talloc_free(tmp);
|
|
|
|
return ok;
|
|
}
|
|
|
|
#if HAVE_CPLUGINS
|
|
|
|
#include <dlfcn.h>
|
|
|
|
#define MPV_DLOPEN_FN "mpv_open_cplugin"
|
|
typedef int (*mpv_open_cplugin)(mpv_handle *handle);
|
|
|
|
static int load_cplugin(struct mp_script_args *args)
|
|
{
|
|
void *lib = dlopen(args->filename, RTLD_NOW | RTLD_LOCAL);
|
|
if (!lib)
|
|
goto error;
|
|
// Note: once loaded, we never unload, as unloading the libraries linked to
|
|
// the plugin can cause random serious problems.
|
|
mpv_open_cplugin sym = (mpv_open_cplugin)dlsym(lib, MPV_DLOPEN_FN);
|
|
if (!sym)
|
|
goto error;
|
|
return sym(args->client) ? -1 : 0;
|
|
error: ;
|
|
char *err = dlerror();
|
|
if (err)
|
|
MP_ERR(args, "C plugin error: '%s'\n", err);
|
|
return -1;
|
|
}
|
|
|
|
const struct mp_scripting mp_scripting_cplugin = {
|
|
.name = "SO plugin",
|
|
.file_ext = "so",
|
|
.load = load_cplugin,
|
|
};
|
|
|
|
#endif
|