Handle the XDG directories.

1 files changed, 385 insertions, 0 deletions

diff --git a/plugins/pychrysalide/common/xdg.c b/plugins/pychrysalide/common/xdg.c
new file mode 100644
index 0000000..789a0a6
--- /dev/null
+++ b/plugins/pychrysalide/common/xdg.c
@@ -0,0 +1,385 @@
+
+/* Chrysalide - Outil d'analyse de fichiers binaires
+ * xdg.c - équivalent Python du fichier "common/xdg.c"
+ *
+ * Copyright (C) 2024 Cyrille Bagard
+ *
+ *  This file is part of Chrysalide.
+ *
+ *  Chrysalide is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Chrysalide 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 General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+
+#include "xdg.h"
+
+
+#include <malloc.h>
+#include <pygobject.h>
+
+
+#include <common/xdg.h>
+
+
+#include "../access.h"
+#include "../helpers.h"
+
+
+
+/* Détermine le chemin d'un répertoire de données XDG. */
+static PyObject *py_xdg_get_xdg_cache_dir(PyObject *, PyObject *);
+
+/* Détermine le chemin d'un répertoire de données XDG. */
+static PyObject *py_xdg_get_xdg_config_dir(PyObject *, PyObject *);
+
+/* Détermine le chemin d'un répertoire de données XDG. */
+static PyObject *py_xdg_get_xdg_data_dir(PyObject *, PyObject *);
+
+/* Détermine le chemin d'un répertoire de données XDG. */
+static PyObject *py_xdg_get_xdg_state_dir(PyObject *, PyObject *);
+
+/* Détermine le chemin d'un répertoire éphémère XDG. */
+static PyObject *py_xdg_get_xdg_runtime_dir(PyObject *, PyObject *);
+
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self = NULL car méthode statique.                            *
+*                args = arguments fournis lors de l'appel à la fonction.      *
+*                                                                             *
+*  Description : Détermine le chemin d'un répertoire de données XDG.          *
+*                                                                             *
+*  Retour      : Chemin d'accès aux configurations personnelles ou None.      *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_xdg_get_xdg_cache_dir(PyObject *self, PyObject *args)
+{
+    PyObject *result;                       /* Instance à retourner        */
+    int create;                             /* Besoin en création          */
+    const char *suffix;                     /* Fin de la localisation      */
+    int ret;                                /* Bilan de lecture des args.  */
+    char *filename;                         /* Chemin d'accès construit    */
+
+#define GET_XDG_CACHE_DIR_METHOD PYTHON_METHOD_DEF                  \
+(                                                                   \
+    get_xdg_cache_dir, "suffix, create=True",                       \
+    METH_VARARGS, py_xdg,                                           \
+    "Get the location of a file belonging to the base directory"    \
+    " pointed by the *XDG_CACHE_HOME* environment variable.\n"      \
+    "\n"                                                            \
+    "The *suffix* argument is a string appended to the XDG base"    \
+    " directory. The *create* option ensures all the directories"   \
+    " involved in the returned path exist.\n"                       \
+    "\n"                                                            \
+    "The function returns the full filename to use for a content"   \
+    " related to cache according to the XDG specifications, or"     \
+    " *None* in case of failure."                                   \
+)
+
+    create = 1;
+
+    ret = PyArg_ParseTuple(args, "s|p", &suffix, &create);
+    if (!ret) return NULL;
+
+    filename = get_xdg_cache_dir(suffix, create);
+
+    if (filename == NULL)
+    {
+        result = Py_None;
+        Py_INCREF(result);
+    }
+    else
+    {
+        result = PyUnicode_FromString(filename);
+        free(filename);
+    }
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self = NULL car méthode statique.                            *
+*                args = arguments fournis lors de l'appel à la fonction.      *
+*                                                                             *
+*  Description : Détermine le chemin d'un répertoire de données XDG.          *
+*                                                                             *
+*  Retour      : Chemin d'accès aux configurations personnelles ou None.      *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_xdg_get_xdg_config_dir(PyObject *self, PyObject *args)
+{
+    PyObject *result;                       /* Instance à retourner        */
+    int create;                             /* Besoin en création          */
+    const char *suffix;                     /* Fin de la localisation      */
+    int ret;                                /* Bilan de lecture des args.  */
+    char *filename;                         /* Chemin d'accès construit    */
+
+#define GET_XDG_CONFIG_DIR_METHOD PYTHON_METHOD_DEF                 \
+(                                                                   \
+    get_xdg_config_dir, "suffix, create=True",                      \
+    METH_VARARGS, py_xdg,                                           \
+    "Get the location of a file belonging to the base directory"    \
+    " pointed by the *XDG_CONFIG_HOME* environment variable.\n"     \
+    "\n"                                                            \
+    "The *suffix* argument is a string appended to the XDG base"    \
+    " directory. The *create* option ensures all the directories"   \
+    " involved in the returned path exist.\n"                       \
+    "\n"                                                            \
+    "The function returns the full filename to use for a content"   \
+    " related to configuration according to the XDG specifications,"\
+    " or *None* in case of failure."                                \
+)
+
+    create = 1;
+
+    ret = PyArg_ParseTuple(args, "s|p", &suffix, &create);
+    if (!ret) return NULL;
+
+    filename = get_xdg_config_dir(suffix, create);
+
+    if (filename == NULL)
+    {
+        result = Py_None;
+        Py_INCREF(result);
+    }
+    else
+    {
+        result = PyUnicode_FromString(filename);
+        free(filename);
+    }
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self = NULL car méthode statique.                            *
+*                args = arguments fournis lors de l'appel à la fonction.      *
+*                                                                             *
+*  Description : Détermine le chemin d'un répertoire de données XDG.          *
+*                                                                             *
+*  Retour      : Chemin d'accès aux configurations personnelles ou None.      *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_xdg_get_xdg_data_dir(PyObject *self, PyObject *args)
+{
+    PyObject *result;                       /* Instance à retourner        */
+    int create;                             /* Besoin en création          */
+    const char *suffix;                     /* Fin de la localisation      */
+    int ret;                                /* Bilan de lecture des args.  */
+    char *filename;                         /* Chemin d'accès construit    */
+
+#define GET_XDG_DATA_DIR_METHOD PYTHON_METHOD_DEF                   \
+(                                                                   \
+    get_xdg_data_dir, "suffix, create=True",                        \
+    METH_VARARGS, py_xdg,                                           \
+    "Get the location of a file belonging to the base directory"    \
+    " pointed by the *XDG_DATA_HOME* environment variable.\n"       \
+    "\n"                                                            \
+    "The *suffix* argument is a string appended to the XDG base"    \
+    " directory. The *create* option ensures all the directories"   \
+    " involved in the returned path exist.\n"                       \
+    "\n"                                                            \
+    "The function returns the full filename to use for a content"   \
+    " related to data according to the XDG specifications, or"      \
+    " *None* in case of failure."                                   \
+)
+
+    create = 1;
+
+    ret = PyArg_ParseTuple(args, "s|p", &suffix, &create);
+    if (!ret) return NULL;
+
+    filename = get_xdg_data_dir(suffix, create);
+
+    if (filename == NULL)
+    {
+        result = Py_None;
+        Py_INCREF(result);
+    }
+    else
+    {
+        result = PyUnicode_FromString(filename);
+        free(filename);
+    }
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self = NULL car méthode statique.                            *
+*                args = arguments fournis lors de l'appel à la fonction.      *
+*                                                                             *
+*  Description : Détermine le chemin d'un répertoire de données XDG.          *
+*                                                                             *
+*  Retour      : Chemin d'accès aux configurations personnelles ou None.      *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_xdg_get_xdg_state_dir(PyObject *self, PyObject *args)
+{
+    PyObject *result;                       /* Instance à retourner        */
+    int create;                             /* Besoin en création          */
+    const char *suffix;                     /* Fin de la localisation      */
+    int ret;                                /* Bilan de lecture des args.  */
+    char *filename;                         /* Chemin d'accès construit    */
+
+#define GET_XDG_STATE_DIR_METHOD PYTHON_METHOD_DEF                  \
+(                                                                   \
+    get_xdg_state_dir, "suffix, create=True",                       \
+    METH_VARARGS, py_xdg,                                           \
+    "Get the location of a file belonging to the base directory"    \
+    " pointed by the *XDG_STATE_HOME* environment variable.\n"      \
+    "\n"                                                            \
+    "The *suffix* argument is a string appended to the XDG base"    \
+    " directory. The *create* option ensures all the directories"   \
+    " involved in the returned path exist.\n"                       \
+    "\n"                                                            \
+    "The function returns the full filename to use for a content"   \
+    " related to states according to the XDG specifications, or"    \
+    " *None* in case of failure."                                   \
+)
+
+    create = 1;
+
+    ret = PyArg_ParseTuple(args, "s|p", &suffix, &create);
+    if (!ret) return NULL;
+
+    filename = get_xdg_state_dir(suffix, create);
+
+    if (filename == NULL)
+    {
+        result = Py_None;
+        Py_INCREF(result);
+    }
+    else
+    {
+        result = PyUnicode_FromString(filename);
+        free(filename);
+    }
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : self = NULL car méthode statique.                            *
+*                args = arguments fournis lors de l'appel à la fonction.      *
+*                                                                             *
+*  Description : Détermine le chemin d'un répertoire éphémère XDG.            *
+*                                                                             *
+*  Retour      : Chemin d'accès aux configurations personnelles ou None.      *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+static PyObject *py_xdg_get_xdg_runtime_dir(PyObject *self, PyObject *args)
+{
+    PyObject *result;                       /* Instance à retourner        */
+    const char *suffix;                     /* Fin de la localisation      */
+    int ret;                                /* Bilan de lecture des args.  */
+    char *filename;                         /* Chemin d'accès construit    */
+
+#define GET_XDG_RUNTIME_DIR_METHOD PYTHON_METHOD_DEF                \
+(                                                                   \
+    get_xdg_runtime_dir, "suffix",                                  \
+    METH_VARARGS, py_xdg,                                           \
+    "Get the location of a file belonging to the base directory"    \
+    " pointed by the *XDG_RUNTIME_DIR* environment variable.\n"     \
+    "\n"                                                            \
+    "The *suffix* argument is a string appended to the XDG base"    \
+    " directory.\n"                                                 \
+    "\n"                                                            \
+    "The function returns the full filename to use for a content"   \
+    " related to runtime data according to the XDG specifications," \
+    " or *None* in case of failure."                                \
+)
+
+    ret = PyArg_ParseTuple(args, "s", &suffix);
+    if (!ret) return NULL;
+
+    filename = get_xdg_runtime_dir(suffix);
+
+    if (filename == NULL)
+    {
+        result = Py_None;
+        Py_INCREF(result);
+    }
+    else
+    {
+        result = PyUnicode_FromString(filename);
+        free(filename);
+    }
+
+    return result;
+
+}
+
+
+/******************************************************************************
+*                                                                             *
+*  Paramètres  : -                                                            *
+*                                                                             *
+*  Description : Définit une extension du module 'common' à compléter.        *
+*                                                                             *
+*  Retour      : Bilan de l'opération.                                        *
+*                                                                             *
+*  Remarques   : -                                                            *
+*                                                                             *
+******************************************************************************/
+
+bool populate_common_module_with_xdg(void)
+{
+    bool result;                            /* Bilan à retourner           */
+    PyObject *module;                       /* Module à recompléter        */
+
+    static PyMethodDef py_xdg_methods[] = {
+        GET_XDG_CACHE_DIR_METHOD,
+        GET_XDG_CONFIG_DIR_METHOD,
+        GET_XDG_DATA_DIR_METHOD,
+        GET_XDG_STATE_DIR_METHOD,
+        GET_XDG_RUNTIME_DIR_METHOD,
+        { NULL }
+    };
+
+    module = get_access_to_python_module("pychrysalide.common");
+
+    result = register_python_module_methods(module, py_xdg_methods);
+
+    return result;
+
+}