gem-graph-client/libide/projects/ide-doap.c

640 lines
16 KiB
C
Raw Normal View History

/* ide-doap.c
*
* Copyright 2015-2019 Christian Hergert <chergert@redhat.com>
*
* This program 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.
*
* This program 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, see <http://www.gnu.org/licenses/>.
*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
#define G_LOG_DOMAIN "ide-doap"
#include "config.h"
#include <glib/gi18n.h>
#include "ide-doap.h"
#include "xml-reader-private.h"
/* TODO: We don't do any XMLNS checking or anything here. */
struct _IdeDoap
{
GObject parent_instance;
gchar *bug_database;
gchar *category;
gchar *description;
gchar *download_page;
gchar *homepage;;
gchar *name;
gchar *shortdesc;
GPtrArray *languages;
GList *maintainers;
};
G_DEFINE_QUARK (ide_doap_error, ide_doap_error)
G_DEFINE_FINAL_TYPE (IdeDoap, ide_doap, G_TYPE_OBJECT)
enum {
PROP_0,
PROP_BUG_DATABASE,
PROP_CATEGORY,
PROP_DESCRIPTION,
PROP_DOWNLOAD_PAGE,
PROP_HOMEPAGE,
PROP_LANGUAGES,
PROP_NAME,
PROP_SHORTDESC,
LAST_PROP
};
static GParamSpec *properties [LAST_PROP];
IdeDoap *
ide_doap_new (void)
{
return g_object_new (IDE_TYPE_DOAP, NULL);
}
const gchar *
ide_doap_get_name (IdeDoap *self)
{
g_return_val_if_fail (IDE_IS_DOAP (self), NULL);
return self->name;
}
const gchar *
ide_doap_get_shortdesc (IdeDoap *self)
{
g_return_val_if_fail (IDE_IS_DOAP (self), NULL);
return self->shortdesc;
}
const gchar *
ide_doap_get_description (IdeDoap *self)
{
g_return_val_if_fail (IDE_IS_DOAP (self), NULL);
return self->description;
}
const gchar *
ide_doap_get_bug_database (IdeDoap *self)
{
g_return_val_if_fail (IDE_IS_DOAP (self), NULL);
return self->bug_database;
}
const gchar *
ide_doap_get_download_page (IdeDoap *self)
{
g_return_val_if_fail (IDE_IS_DOAP (self), NULL);
return self->download_page;
}
const gchar *
ide_doap_get_homepage (IdeDoap *self)
{
g_return_val_if_fail (IDE_IS_DOAP (self), NULL);
return self->homepage;
}
const gchar *
ide_doap_get_category (IdeDoap *self)
{
g_return_val_if_fail (IDE_IS_DOAP (self), NULL);
return self->category;
}
/**
* ide_doap_get_languages:
*
* Returns: (transfer none): a #GStrv.
*
* Since: 3.32
*/
gchar **
ide_doap_get_languages (IdeDoap *self)
{
g_return_val_if_fail (IDE_IS_DOAP (self), NULL);
if (self->languages != NULL)
return (gchar **)self->languages->pdata;
return NULL;
}
static void
ide_doap_set_bug_database (IdeDoap *self,
const gchar *bug_database)
{
g_return_if_fail (IDE_IS_DOAP (self));
if (g_strcmp0 (self->bug_database, bug_database) != 0)
{
g_free (self->bug_database);
self->bug_database = g_strdup (bug_database);
g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_BUG_DATABASE]);
}
}
static void
ide_doap_set_category (IdeDoap *self,
const gchar *category)
{
g_return_if_fail (IDE_IS_DOAP (self));
if (g_strcmp0 (self->category, category) != 0)
{
g_free (self->category);
self->category = g_strdup (category);
g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_CATEGORY]);
}
}
static void
ide_doap_set_description (IdeDoap *self,
const gchar *description)
{
g_return_if_fail (IDE_IS_DOAP (self));
if (g_strcmp0 (self->description, description) != 0)
{
g_free (self->description);
self->description = g_strdup (description);
g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_DESCRIPTION]);
}
}
static void
ide_doap_set_download_page (IdeDoap *self,
const gchar *download_page)
{
g_return_if_fail (IDE_IS_DOAP (self));
if (g_strcmp0 (self->download_page, download_page) != 0)
{
g_free (self->download_page);
self->download_page = g_strdup (download_page);
g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_DOWNLOAD_PAGE]);
}
}
static void
ide_doap_set_homepage (IdeDoap *self,
const gchar *homepage)
{
g_return_if_fail (IDE_IS_DOAP (self));
if (g_strcmp0 (self->homepage, homepage) != 0)
{
g_free (self->homepage);
self->homepage = g_strdup (homepage);
g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_HOMEPAGE]);
}
}
static void
ide_doap_set_name (IdeDoap *self,
const gchar *name)
{
g_return_if_fail (IDE_IS_DOAP (self));
if (g_strcmp0 (self->name, name) != 0)
{
g_free (self->name);
self->name = g_strdup (name);
g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_NAME]);
}
}
static void
ide_doap_set_shortdesc (IdeDoap *self,
const gchar *shortdesc)
{
g_return_if_fail (IDE_IS_DOAP (self));
if (g_strcmp0 (self->shortdesc, shortdesc) != 0)
{
g_free (self->shortdesc);
self->shortdesc = g_strdelimit (g_strdup (shortdesc), "\n", ' ');
g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_SHORTDESC]);
}
}
/**
* ide_doap_get_maintainers:
*
*
*
* Returns: (transfer none) (element-type IdeDoapPerson): a #GList of #IdeDoapPerson.
*
* Since: 3.32
*/
GList *
ide_doap_get_maintainers (IdeDoap *self)
{
g_return_val_if_fail (IDE_IS_DOAP (self), NULL);
return self->maintainers;
}
static void
ide_doap_add_language (IdeDoap *self,
const gchar *language)
{
g_return_if_fail (IDE_IS_DOAP (self));
g_return_if_fail (language != NULL);
if (self->languages == NULL)
{
self->languages = g_ptr_array_new_with_free_func (g_free);
g_ptr_array_add (self->languages, NULL);
}
g_assert (self->languages->len > 0);
g_ptr_array_index (self->languages, self->languages->len - 1) = g_strdup (language);
g_ptr_array_add (self->languages, NULL);
g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_LANGUAGES]);
}
static void
ide_doap_set_languages (IdeDoap *self,
gchar **languages)
{
gsize i;
g_return_if_fail (IDE_IS_DOAP (self));
if ((self->languages != NULL) && (self->languages->len > 0))
g_ptr_array_remove_range (self->languages, 0, self->languages->len);
g_object_freeze_notify (G_OBJECT (self));
for (i = 0; languages [i]; i++)
ide_doap_add_language (self, languages [i]);
g_object_thaw_notify (G_OBJECT (self));
}
static void
ide_doap_finalize (GObject *object)
{
IdeDoap *self = (IdeDoap *)object;
g_clear_pointer (&self->bug_database, g_free);
g_clear_pointer (&self->category, g_free);
g_clear_pointer (&self->description, g_free);
g_clear_pointer (&self->download_page, g_free);
g_clear_pointer (&self->homepage, g_free);
g_clear_pointer (&self->languages, g_ptr_array_unref);
g_clear_pointer (&self->name, g_free);
g_clear_pointer (&self->shortdesc, g_free);
g_list_free_full (self->maintainers, g_object_unref);
self->maintainers = NULL;
G_OBJECT_CLASS (ide_doap_parent_class)->finalize (object);
}
static void
ide_doap_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
IdeDoap *self = IDE_DOAP (object);
switch (prop_id)
{
case PROP_BUG_DATABASE:
g_value_set_string (value, ide_doap_get_bug_database (self));
break;
case PROP_CATEGORY:
g_value_set_string (value, ide_doap_get_category (self));
break;
case PROP_DESCRIPTION:
g_value_set_string (value, ide_doap_get_description (self));
break;
case PROP_DOWNLOAD_PAGE:
g_value_set_string (value, ide_doap_get_download_page (self));
break;
case PROP_HOMEPAGE:
g_value_set_string (value, ide_doap_get_homepage (self));
break;
case PROP_LANGUAGES:
g_value_set_boxed (value, ide_doap_get_languages (self));
break;
case PROP_NAME:
g_value_set_string (value, ide_doap_get_name (self));
break;
case PROP_SHORTDESC:
g_value_set_string (value, ide_doap_get_shortdesc (self));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
}
static void
ide_doap_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
IdeDoap *self = IDE_DOAP (object);
switch (prop_id)
{
case PROP_BUG_DATABASE:
ide_doap_set_bug_database (self, g_value_get_string (value));
break;
case PROP_CATEGORY:
ide_doap_set_category (self, g_value_get_string (value));
break;
case PROP_DESCRIPTION:
ide_doap_set_description (self, g_value_get_string (value));
break;
case PROP_DOWNLOAD_PAGE:
ide_doap_set_download_page (self, g_value_get_string (value));
break;
case PROP_HOMEPAGE:
ide_doap_set_homepage (self, g_value_get_string (value));
break;
case PROP_LANGUAGES:
ide_doap_set_languages (self, g_value_get_boxed (value));
break;
case PROP_NAME:
ide_doap_set_name (self, g_value_get_string (value));
break;
case PROP_SHORTDESC:
ide_doap_set_shortdesc (self, g_value_get_string (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
}
static void
ide_doap_class_init (IdeDoapClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->finalize = ide_doap_finalize;
object_class->get_property = ide_doap_get_property;
object_class->set_property = ide_doap_set_property;
properties [PROP_BUG_DATABASE] =
g_param_spec_string ("bug-database",
"Bug Database",
"Bug Database",
NULL,
(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
properties [PROP_CATEGORY] =
g_param_spec_string ("category",
"Category",
"Category",
NULL,
(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
properties [PROP_DESCRIPTION] =
g_param_spec_string ("description",
"Description",
"Description",
NULL,
(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
properties [PROP_DOWNLOAD_PAGE] =
g_param_spec_string ("download-page",
"Download Page",
"Download Page",
NULL,
(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
properties [PROP_HOMEPAGE] =
g_param_spec_string ("homepage",
"Homepage",
"Homepage",
NULL,
(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
properties [PROP_LANGUAGES] =
g_param_spec_string ("languages",
"Languages",
"Languages",
NULL,
(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
properties [PROP_NAME] =
g_param_spec_string ("name",
"Name",
"Name",
NULL,
(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
properties [PROP_SHORTDESC] =
g_param_spec_string ("shortdesc",
"Shortdesc",
"Shortdesc",
NULL,
(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_properties (object_class, LAST_PROP, properties);
}
static void
ide_doap_init (IdeDoap *self)
{
}
static gboolean
ide_doap_parse_maintainer (IdeDoap *self,
XmlReader *reader)
{
g_assert (IDE_IS_DOAP (self));
g_assert (XML_IS_READER (reader));
if (!xml_reader_read (reader))
return FALSE;
do
{
if (xml_reader_is_a_local (reader, "Person") && xml_reader_read (reader))
{
g_autoptr(IdeDoapPerson) person = ide_doap_person_new ();
do
{
if (xml_reader_is_a_local (reader, "name"))
{
gchar *str;
str = xml_reader_read_string (reader);
ide_doap_person_set_name (person, str);
g_free (str);
}
else if (xml_reader_is_a_local (reader, "mbox"))
{
gchar *str;
str = xml_reader_get_attribute (reader, "rdf:resource");
if (str != NULL && str[0] != '\0' && g_str_has_prefix (str, "mailto:"))
ide_doap_person_set_email (person, str + strlen ("mailto:"));
g_free (str);
}
}
while (xml_reader_read_to_next (reader));
if (ide_doap_person_get_name (person) || ide_doap_person_get_email (person))
self->maintainers = g_list_append (self->maintainers, g_object_ref (person));
}
}
while (xml_reader_read_to_next (reader));
return TRUE;
}
static gboolean
load_doap (IdeDoap *self,
XmlReader *reader,
GError **error)
{
if (!xml_reader_read_start_element (reader, "Project"))
{
g_set_error (error,
IDE_DOAP_ERROR,
IDE_DOAP_ERROR_INVALID_FORMAT,
"Project element is missing from doap.");
return FALSE;
}
g_object_freeze_notify (G_OBJECT (self));
xml_reader_read (reader);
do
{
const gchar *element_name;
element_name = xml_reader_get_local_name (reader);
if (g_strcmp0 (element_name, "name") == 0 ||
g_strcmp0 (element_name, "shortdesc") == 0 ||
g_strcmp0 (element_name, "description") == 0)
{
gchar *str;
str = xml_reader_read_string (reader);
if (str != NULL)
g_object_set (self, element_name, g_strstrip (str), NULL);
g_free (str);
}
else if (g_strcmp0 (element_name, "category") == 0 ||
g_strcmp0 (element_name, "homepage") == 0 ||
g_strcmp0 (element_name, "download-page") == 0 ||
g_strcmp0 (element_name, "bug-database") == 0)
{
gchar *str;
str = xml_reader_get_attribute (reader, "rdf:resource");
if (str != NULL)
g_object_set (self, element_name, g_strstrip (str), NULL);
g_free (str);
}
else if (g_strcmp0 (element_name, "programming-language") == 0)
{
gchar *str;
str = xml_reader_read_string (reader);
if (str != NULL && str[0] != '\0')
ide_doap_add_language (self, g_strstrip (str));
g_free (str);
}
else if (g_strcmp0 (element_name, "maintainer") == 0)
{
if (!ide_doap_parse_maintainer (self, reader))
break;
}
}
while (xml_reader_read_to_next (reader));
g_object_thaw_notify (G_OBJECT (self));
return TRUE;
}
gboolean
ide_doap_load_from_file (IdeDoap *self,
GFile *file,
GCancellable *cancellable,
GError **error)
{
g_autoptr(XmlReader) reader = NULL;
g_return_val_if_fail (IDE_IS_DOAP (self), FALSE);
g_return_val_if_fail (G_IS_FILE (file), FALSE);
g_return_val_if_fail (!cancellable || G_IS_CANCELLABLE (cancellable), FALSE);
reader = xml_reader_new ();
if (!xml_reader_load_from_file (reader, file, cancellable, error))
return FALSE;
return load_doap (self, reader, error);
}
gboolean
ide_doap_load_from_data (IdeDoap *self,
const gchar *data,
gsize length,
GError **error)
{
g_autoptr(XmlReader) reader = NULL;
g_return_val_if_fail (IDE_IS_DOAP (self), FALSE);
g_return_val_if_fail (data != NULL, FALSE);
reader = xml_reader_new ();
if (!xml_reader_load_from_data (reader, (const gchar *)data, length, NULL, NULL))
return FALSE;
return load_doap (self, reader, error);
}