/*
* e-module.c
*
* This library 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.
*
* This library 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 this library. If not, see .
*
*/
/**
* SECTION: e-module
* @include: libedataserver/libedataserver.h
* @short_description: A module loader
**/
#include "evolution-data-server-config.h"
#include
#include "e-data-server-util.h"
#include "e-module.h"
/* This is the symbol we call when loading a module. */
#define LOAD_SYMBOL "e_module_load"
/* This is the symbol we call when unloading a module. */
#define UNLOAD_SYMBOL "e_module_unload"
struct _EModulePrivate {
GModule *module;
gchar *filename;
void (*load) (GTypeModule *type_module);
void (*unload) (GTypeModule *type_module);
};
enum {
PROP_0,
PROP_FILENAME
};
G_DEFINE_TYPE_WITH_PRIVATE (
EModule,
e_module,
G_TYPE_TYPE_MODULE)
static void
module_set_filename (EModule *module,
const gchar *filename)
{
g_return_if_fail (module->priv->filename == NULL);
module->priv->filename = g_strdup (filename);
}
static void
module_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
switch (property_id) {
case PROP_FILENAME:
module_set_filename (
E_MODULE (object),
g_value_get_string (value));
return;
}
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}
static void
module_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
switch (property_id) {
case PROP_FILENAME:
g_value_set_string (
value, e_module_get_filename (
E_MODULE (object)));
return;
}
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}
static void
module_finalize (GObject *object)
{
EModulePrivate *priv;
priv = E_MODULE (object)->priv;
g_free (priv->filename);
/* Chain up to parent's finalize() method. */
G_OBJECT_CLASS (e_module_parent_class)->finalize (object);
}
static gboolean
module_load (GTypeModule *type_module)
{
EModulePrivate *priv;
gpointer symbol;
priv = E_MODULE (type_module)->priv;
g_return_val_if_fail (priv->filename != NULL, FALSE);
priv->module = g_module_open (priv->filename, 0);
if (priv->module == NULL)
goto fail;
if (!g_module_symbol (priv->module, LOAD_SYMBOL, &symbol))
goto fail;
priv->load = symbol;
if (!g_module_symbol (priv->module, UNLOAD_SYMBOL, &symbol))
goto fail;
priv->unload = symbol;
priv->load (type_module);
/* XXX This is a Band-Aid for a design flaw in EExtension. If the
* "extensible_type" member of EExtensionClass is set to a GType
* that hasn't already been registered, then when the extension's
* module is unloaded the GType registration that was triggered
* by setting "extensible_type" will be invalidated and cause
* Evolution to malfunction when the module is loaded again.
*
* Extension modules get loaded and unloaded repeatedly by
* e_extensible_load_extensions(), which temporarily references
* all extension classes and picks out the ones it needs for a
* given EExtensible instance based on the "extensible_type"
* class member.
*
* Making the module resident prevents the aforementioned GType
* registration from being invalidated when the extension class
* is unreferenced.
*/
g_module_make_resident (priv->module);
return TRUE;
fail:
g_warning ("%s: %s", G_STRFUNC, g_module_error ());
if (priv->module != NULL)
g_module_close (priv->module);
return FALSE;
}
static void
module_unload (GTypeModule *type_module)
{
EModulePrivate *priv;
priv = E_MODULE (type_module)->priv;
priv->unload (type_module);
g_module_close (priv->module);
priv->module = NULL;
priv->load = NULL;
priv->unload = NULL;
}
static void
e_module_class_init (EModuleClass *class)
{
GObjectClass *object_class;
GTypeModuleClass *type_module_class;
object_class = G_OBJECT_CLASS (class);
object_class->set_property = module_set_property;
object_class->get_property = module_get_property;
object_class->finalize = module_finalize;
type_module_class = G_TYPE_MODULE_CLASS (class);
type_module_class->load = module_load;
type_module_class->unload = module_unload;
/**
* EModule:filename
*
* The filename of the module.
**/
g_object_class_install_property (
object_class,
PROP_FILENAME,
g_param_spec_string (
"filename",
"Filename",
"The filename of the module",
NULL,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
}
static void
e_module_init (EModule *module)
{
module->priv = e_module_get_instance_private (module);
}
/**
* e_module_new:
* @filename: filename of the shared library module
*
* Creates a new #EModule that will load the specific shared library
* when in use.
*
* Returns: a new #EModule for @filename
*
* Since: 3.4
**/
EModule *
e_module_new (const gchar *filename)
{
g_return_val_if_fail (filename != NULL, NULL);
return g_object_new (E_TYPE_MODULE, "filename", filename, NULL);
}
/**
* e_module_get_filename:
* @module: an #EModule
*
* Returns the filename of the shared library for @module. The
* string is owned by @module and should not be modified or freed.
*
* Returns: (transfer none): the filename for @module
*
* Since: 3.4
**/
const gchar *
e_module_get_filename (EModule *module)
{
g_return_val_if_fail (E_IS_MODULE (module), NULL);
return module->priv->filename;
}
/**
* e_module_load_all_in_directory:
* @dirname: pathname for a directory containing modules to load
*
* Loads all the modules in the specified directory into memory. If
* you want to unload them (enabling on-demand loading) you must call
* g_type_module_unuse() on all the modules. Free the returned list
* with g_list_free().
*
* Returns: (element-type EModule) (transfer container): a list of #EModules loaded from @dirname
*
* Since: 3.4
**/
GList *
e_module_load_all_in_directory (const gchar *dirname)
{
GDir *dir;
const gchar *basename;
GList *loaded_modules = NULL;
GError *error = NULL;
g_return_val_if_fail (dirname != NULL, NULL);
if (!g_module_supported ()) {
e_source_registry_debug_print ("Cannot load *." G_MODULE_SUFFIX " in '%s': modules not supported by glib\n", dirname);
return NULL;
}
dir = g_dir_open (dirname, 0, &error);
if (dir == NULL) {
e_source_registry_debug_print ("Cannot open module dir '%s': %s\n", dirname, error ? error->message : "Unknown error");
g_clear_error (&error);
return NULL;
}
while ((basename = g_dir_read_name (dir)) != NULL) {
EModule *module;
gchar *filename;
if (!g_str_has_suffix (basename, "." G_MODULE_SUFFIX)) {
e_source_registry_debug_print ("Skipping file '%s/%s': incorrect extension\n", dirname, basename);
continue;
}
filename = g_build_filename (dirname, basename, NULL);
module = e_module_load_file (filename);
g_free (filename);
if (module != NULL)
loaded_modules = g_list_prepend (loaded_modules, module);
}
e_source_registry_debug_print ("Loaded %u *." G_MODULE_SUFFIX " modules in '%s'\n", g_list_length (loaded_modules), dirname);
g_dir_close (dir);
return loaded_modules;
}
/**
* e_module_load_file:
* @filename: filename of the module to load
*
* Load the module from the specified filename into memory. If
* you want to unload it (enabling on-demand loading) you must call
* g_type_module_unuse() on the module.
*
* Returns: (transfer full): an #EModule loaded from @filename
*
* Since: 3.16
**/
EModule *
e_module_load_file (const gchar *filename)
{
EModule *module;
module = e_module_new (filename);
if (!g_type_module_use (G_TYPE_MODULE (module))) {
g_printerr ("Failed to load module: %s\n", filename);
g_clear_object (&module);
}
return module;
}
/**
* e_module_load_all_in_directory_and_prefixes:
* @dirname: pathname for a directory containing modules to load
* @dirprefix: (nullable): prefix of @dirname, which can be replaced by custom prefixes, or %NULL
*
* Loads all the modules in the specified directory into memory and the other
* custom prefixes returned by e_util_get_directory_variants(). If
* you want to unload them (enabling on-demand loading) you must call
* g_type_module_unuse() on all the modules. Free the returned list
* with g_list_free().
*
* When @dirprefix is %NULL, or not a prefix of @dirname, behaves
* the same as e_module_load_all_in_directory().
*
* Returns: (element-type EModule) (transfer container): a list of #EModules loaded
* from @dirname and any extra prefix directory.
*
* Since: 3.40
**/
GList *
e_module_load_all_in_directory_and_prefixes (const gchar *dirname,
const gchar *dirprefix)
{
GList *list = NULL;
GPtrArray *variants;
guint ii;
g_return_val_if_fail (dirname != NULL, NULL);
if (!g_module_supported ())
return NULL;
if (!dirprefix || !*dirprefix || !g_str_has_prefix (dirname, dirprefix))
return e_module_load_all_in_directory (dirname);
variants = e_util_get_directory_variants (dirname, dirprefix, TRUE);
if (!variants)
return e_module_load_all_in_directory (dirname);
for (ii = 0; ii < variants->len; ii++) {
const gchar *path = g_ptr_array_index (variants, ii);
if (path && *path) {
GList *modules;
modules = e_module_load_all_in_directory (path);
if (modules)
list = g_list_concat (list, modules);
}
}
g_ptr_array_unref (variants);
return list;
}