Define new 'pivot-prop-loadable' property

[nautilus-actions.git] / src / core / na-pivot.c

/*
 * Nautilus-Actions
 * A Nautilus extension which offers configurable context menu actions.
 *
 * Copyright (C) 2005 The GNOME Foundation
 * Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
 * Copyright (C) 2009, 2010, 2011 Pierre Wieser and others (see AUTHORS)
 *
 * 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 2 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 Library; see the file COPYING.  If not,
 * write to the Free Software Foundation, Inc., 59 Temple Place,
 * Suite 330, Boston, MA 02111-1307, USA.
 *
 * Authors:
 *   Frederic Ruaudel <grumz@grumz.net>
 *   Rodrigo Moya <rodrigo@gnome-db.org>
 *   Pierre Wieser <pwieser@trychlos.org>
 *   ... and many others (see AUTHORS)
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <string.h>

#include <api/na-core-utils.h>
#include <api/na-timeout.h>

#include "na-io-provider.h"
#include "na-iprefs.h"
#include "na-module.h"
#include "na-pivot.h"

/* private class data
 */
struct _NAPivotClassPrivate {
        void *empty;                                            /* so that gcc -pedantic is happy */
};

/* private instance data
 */
struct _NAPivotPrivate {
        gboolean    dispose_has_run;

        guint       loadable_set;

        /* dynamically loaded modules (extension plugins)
         */
        GList      *modules;

        /* configuration tree of actions and menus
         */
        GList      *tree;

        /* timeout to manage i/o providers 'item-changed' burst
         */
        NATimeout   change_timeout;

        /* the preferences management
         */
        NASettings *settings;
};

/* NAPivot properties
 */
enum {
        PRIVOT_PROP_0,

        PIVOT_PROP_LOADABLE_ID,
        PIVOT_PROP_TREE_ID,

        /* count of properties */
        PIVOT_PROP_N
};

/* signals
 */
enum {
        ITEMS_CHANGED,
        LAST_SIGNAL
};

static GObjectClass *st_parent_class           = NULL;
static gint          st_burst_timeout          = 100;           /* burst timeout in msec */
static gint          st_signals[ LAST_SIGNAL ] = { 0 };

static GType         register_type( void );
static void          class_init( NAPivotClass *klass );
static void          instance_init( GTypeInstance *instance, gpointer klass );
static void          instance_constructed( GObject *object );
static void          instance_get_property( GObject *object, guint property_id, GValue *value, GParamSpec *spec );
static void          instance_set_property( GObject *object, guint property_id, const GValue *value, GParamSpec *spec );
static void          instance_dispose( GObject *object );
static void          instance_finalize( GObject *object );

static NAObjectItem *get_item_from_tree( const NAPivot *pivot, GList *tree, const gchar *id );

/* NAIIOProvider management */
static void          on_items_changed_timeout( NAPivot *pivot );

GType
na_pivot_get_type( void )
{
        static GType object_type = 0;

        if( !object_type ){
                object_type = register_type();
        }

        return( object_type );
}

static GType
register_type( void )
{
        static const gchar *thisfn = "na_pivot_register_type";
        GType type;

        static GTypeInfo info = {
                sizeof( NAPivotClass ),
                ( GBaseInitFunc ) NULL,
                ( GBaseFinalizeFunc ) NULL,
                ( GClassInitFunc ) class_init,
                NULL,
                NULL,
                sizeof( NAPivot ),
                0,
                ( GInstanceInitFunc ) instance_init
        };

        g_debug( "%s", thisfn );

        type = g_type_register_static( G_TYPE_OBJECT, "NAPivot", &info, 0 );

        return( type );
}

static void
class_init( NAPivotClass *klass )
{
        static const gchar *thisfn = "na_pivot_class_init";
        GObjectClass *object_class;

        g_debug( "%s: klass=%p", thisfn, ( void * ) klass );

        st_parent_class = g_type_class_peek_parent( klass );

        object_class = G_OBJECT_CLASS( klass );
        object_class->constructed = instance_constructed;
        object_class->set_property = instance_set_property;
        object_class->get_property = instance_get_property;
        object_class->dispose = instance_dispose;
        object_class->finalize = instance_finalize;

        g_object_class_install_property( object_class, PIVOT_PROP_LOADABLE_ID,
                        g_param_spec_uint(
                                        PIVOT_PROP_LOADABLE,
                                        "Loadable set",
                                        "The set of loadble items",
                                        0, 255, 0,
                                        G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE ));

        g_object_class_install_property( object_class, PIVOT_PROP_TREE_ID,
                        g_param_spec_pointer(
                                        PIVOT_PROP_TREE,
                                        "Items tree",
                                        "Hierarchical tree of items",
                                        G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE ));

        klass->private = g_new0( NAPivotClassPrivate, 1 );

        /*
         * NAPivot::pivot-items-changed:
         *
         * This signal is sent by NAPivot at the end of a burst of modifications
         * as signaled by i/o providers.
         *
         * The signal is registered without any default handler.
         */
        st_signals[ ITEMS_CHANGED ] = g_signal_new(
                                PIVOT_SIGNAL_ITEMS_CHANGED,
                                NA_PIVOT_TYPE,
                                G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
                                0,                                                                      /* class offset */
                                NULL,                                                           /* accumulator */
                                NULL,                                                           /* accumulator data */
                                g_cclosure_marshal_VOID__VOID,
                                G_TYPE_NONE,
                                0 );
}

static void
instance_init( GTypeInstance *instance, gpointer klass )
{
        static const gchar *thisfn = "na_pivot_instance_init";
        NAPivot *self;

        g_return_if_fail( NA_IS_PIVOT( instance ));

        g_debug( "%s: instance=%p (%s), klass=%p",
                        thisfn, ( void * ) instance, G_OBJECT_TYPE_NAME( instance ), ( void * ) klass );

        self = NA_PIVOT( instance );

        self->private = g_new0( NAPivotPrivate, 1 );

        self->private->dispose_has_run = FALSE;
        self->private->loadable_set = PIVOT_LOAD_NONE;
        self->private->modules = NULL;
        self->private->tree = NULL;

        /* initialize timeout parameters for 'item-changed' handler
         */
        self->private->change_timeout.timeout = st_burst_timeout;
        self->private->change_timeout.handler = ( NATimeoutFunc ) on_items_changed_timeout;
        self->private->change_timeout.user_data = self;
        self->private->change_timeout.source_id = 0;
}

static void
instance_constructed( GObject *object )
{
        static const gchar *thisfn = "na_pivot_instance_constructed";
        NAPivot *self;

        g_return_if_fail( NA_IS_PIVOT( object ));
        self = NA_PIVOT( object );

        if( !self->private->dispose_has_run ){

                g_debug( "%s: object=%p", thisfn, ( void * ) object );

                self->private->modules = na_module_load_modules();
                self->private->settings = na_settings_new();

                /* force class initialization and io-factory registration
                 */
                g_object_unref( na_object_action_new_with_profile());
                g_object_unref( na_object_menu_new());

                /* chain up to the parent class */
                if( G_OBJECT_CLASS( st_parent_class )->constructed ){
                        G_OBJECT_CLASS( st_parent_class )->constructed( object );
                }
        }
}

static void
instance_get_property( GObject *object, guint property_id, GValue *value, GParamSpec *spec )
{
        NAPivot *self;

        g_return_if_fail( NA_IS_PIVOT( object ));
        self = NA_PIVOT( object );

        if( !self->private->dispose_has_run ){

                switch( property_id ){
                        case PIVOT_PROP_LOADABLE_ID:
                                g_value_set_uint( value, self->private->loadable_set );
                                break;

                        case PIVOT_PROP_TREE_ID:
                                g_value_set_pointer( value, self->private->tree );
                                break;

                        default:
                                G_OBJECT_WARN_INVALID_PROPERTY_ID( object, property_id, spec );
                                break;
                }
        }
}

static void
instance_set_property( GObject *object, guint property_id, const GValue *value, GParamSpec *spec )
{
        NAPivot *self;

        g_return_if_fail( NA_IS_PIVOT( object ));
        self = NA_PIVOT( object );

        if( !self->private->dispose_has_run ){

                switch( property_id ){
                        case PIVOT_PROP_LOADABLE_ID:
                                self->private->loadable_set = g_value_get_uint( value );
                                break;

                        case PIVOT_PROP_TREE_ID:
                                self->private->tree = g_value_get_pointer( value );
                                break;

                        default:
                                G_OBJECT_WARN_INVALID_PROPERTY_ID( object, property_id, spec );
                                break;
                }
        }
}

static void
instance_dispose( GObject *object )
{
        static const gchar *thisfn = "na_pivot_instance_dispose";
        NAPivot *self;

        g_return_if_fail( NA_IS_PIVOT( object ));

        self = NA_PIVOT( object );

        if( !self->private->dispose_has_run ){

                g_debug( "%s: object=%p (%s)", thisfn, ( void * ) object, G_OBJECT_TYPE_NAME( object ));

                self->private->dispose_has_run = TRUE;

                /* release modules */
                na_module_release_modules( self->private->modules );
                self->private->modules = NULL;

                /* release item tree */
                g_debug( "%s: tree=%p (count=%u)", thisfn,
                                ( void * ) self->private->tree, g_list_length( self->private->tree ));
                na_object_dump_tree( self->private->tree );
                self->private->tree = na_object_free_items( self->private->tree );

                /* release the settings */
                g_object_unref( self->private->settings );

                /* release the I/O Provider object list */
                na_io_provider_unref_io_providers_list();

                /* chain up to the parent class */
                if( G_OBJECT_CLASS( st_parent_class )->dispose ){
                        G_OBJECT_CLASS( st_parent_class )->dispose( object );
                }
        }
}

static void
instance_finalize( GObject *object )
{
        static const gchar *thisfn = "na_pivot_instance_finalize";
        NAPivot *self;

        g_return_if_fail( NA_IS_PIVOT( object ));

        g_debug( "%s: object=%p (%s)", thisfn, ( void * ) object, G_OBJECT_TYPE_NAME( object ));

        self = NA_PIVOT( object );

        g_free( self->private );

        /* chain call to parent class */
        if( G_OBJECT_CLASS( st_parent_class )->finalize ){
                G_OBJECT_CLASS( st_parent_class )->finalize( object );
        }
}

/*
 * na_pivot_new:
 *
 * This object takes care of all items/actions/menus/providers/settings
 * management which is required to correctly handle file manager context
 * menus.
 *
 * When this object is instantiated, it automatically takes care of:
 * - loading Nautilus-Actions dynamic modules;
 * - initializing the preferences monitoring.
 *
 * Actual loading of items from i/o providers is delayed until a call
 * to call to na_pivot_load_items() function, so that the caller is able
 * to set its own needed #NAPivot properties (e.g. the loadable set of
 * items).
 *
 * Only one #NAPivot object should be instantiated for a running application.
 *
 * Returns: a newly allocated #NAPivot object which should be g_object_unref()
 * by the caller at the end of the application.
 */
NAPivot *
na_pivot_new( void )
{
        static const gchar *thisfn = "na_pivot_new";
        NAPivot *pivot;

        g_debug( "%s", thisfn );

        pivot = g_object_new( NA_PIVOT_TYPE, NULL );

        return( pivot );
}

/*
 * na_pivot_dump:
 * @pivot: the #NAPivot object do be dumped.
 *
 * Dumps the content of a #NAPivot object.
 */
void
na_pivot_dump( const NAPivot *pivot )
{
        static const gchar *thisfn = "na_pivot_dump";
        GList *it;
        int i;

        if( !pivot->private->dispose_has_run ){

                g_debug( "%s: loadable_set=%d", thisfn, pivot->private->loadable_set );
                g_debug( "%s:      modules=%p (%d elts)", thisfn, ( void * ) pivot->private->modules, g_list_length( pivot->private->modules ));
                g_debug( "%s:         tree=%p (%d elts)", thisfn, ( void * ) pivot->private->tree, g_list_length( pivot->private->tree ));
                /*g_debug( "%s:     monitors=%p (%d elts)", thisfn, ( void * ) pivot->private->monitors, g_list_length( pivot->private->monitors ));*/

                for( it = pivot->private->tree, i = 0 ; it ; it = it->next ){
                        g_debug( "%s:     [%d]: %p", thisfn, i++, it->data );
                }
        }
}

/*
 * na_pivot_get_providers:
 * @pivot: this #NAPivot instance.
 * @type: the type of searched interface.
 * For now, we only have NA_IIO_PROVIDER_TYPE interfaces.
 *
 * Returns: a newly allocated list of providers of the required interface.
 *
 * This function is called by interfaces API in order to find the
 * list of providers registered for their own given interface.
 *
 * The returned list should be release by calling na_pivot_free_providers().
 */
GList *
na_pivot_get_providers( const NAPivot *pivot, GType type )
{
        static const gchar *thisfn = "na_pivot_get_providers";
        GList *list = NULL;

        g_return_val_if_fail( NA_IS_PIVOT( pivot ), NULL );

        if( !pivot->private->dispose_has_run ){

                g_debug( "%s: pivot=%p, type=%lu (%s)", thisfn, ( void * ) pivot, ( unsigned long ) type, g_type_name( type ));

                list = na_module_get_extensions_for_type( pivot->private->modules, type );
                g_debug( "%s: list=%p, count=%d", thisfn, ( void * ) list, list ? g_list_length( list ) : 0 );
        }

        return( list );
}

/*
 * na_pivot_free_providers:
 * @providers: a list of providers.
 *
 * Frees a list of providers as returned from na_pivot_get_providers().
 */
void
na_pivot_free_providers( GList *providers )
{
        static const gchar *thisfn = "na_pivot_free_providers";

        g_debug( "%s: providers=%p", thisfn, ( void * ) providers );

        na_module_free_extensions_list( providers );
}

/*
 * na_pivot_get_item:
 * @pivot: this #NAPivot instance.
 * @id: the required item identifier.
 *
 * Returns the specified item, action or menu.
 *
 * Returns: the required #NAObjectItem-derived object, or %NULL if not
 * found.
 *
 * The returned pointer is owned by #NAPivot, and should not be
 * g_free() nor g_object_unref() by the caller.
 */
NAObjectItem *
na_pivot_get_item( const NAPivot *pivot, const gchar *id )
{
        NAObjectItem *object = NULL;

        g_return_val_if_fail( NA_IS_PIVOT( pivot ), NULL );

        if( !pivot->private->dispose_has_run ){

                if( !id || !strlen( id )){
                        return( NULL );
                }

                object = get_item_from_tree( pivot, pivot->private->tree, id );
        }

        return( object );
}

static NAObjectItem *
get_item_from_tree( const NAPivot *pivot, GList *tree, const gchar *id )
{
        GList *subitems, *ia;
        NAObjectItem *found = NULL;

        for( ia = tree ; ia && !found ; ia = ia->next ){

                gchar *i_id = na_object_get_id( NA_OBJECT( ia->data ));

                if( !g_ascii_strcasecmp( id, i_id )){
                        found = NA_OBJECT_ITEM( ia->data );
                }

                if( !found && NA_IS_OBJECT_ITEM( ia->data )){
                        subitems = na_object_get_items( ia->data );
                        found = get_item_from_tree( pivot, subitems, id );
                }
        }

        return( found );
}

/*
 * na_pivot_get_items:
 * @pivot: this #NAPivot instance.
 *
 * Returns: the current configuration tree.
 *
 * The returned list is owned by this #NAPivot object, and should not
 * be g_free(), nor g_object_unref() by the caller.
 */
GList *
na_pivot_get_items( const NAPivot *pivot )
{
        GList *tree;

        g_return_val_if_fail( NA_IS_PIVOT( pivot ), NULL );

        tree = NULL;

        if( !pivot->private->dispose_has_run ){

                tree = pivot->private->tree;
        }

        return( tree );
}

/*
 * na_pivot_load_items:
 * @pivot: this #NAPivot instance.
 *
 * Loads the hierarchical list of items from I/O providers.
 */
void
na_pivot_load_items( NAPivot *pivot )
{
        static const gchar *thisfn = "na_pivot_load_items";
        GSList *messages, *im;

        g_return_if_fail( NA_IS_PIVOT( pivot ));

        if( !pivot->private->dispose_has_run ){

                g_debug( "%s: pivot=%p", thisfn, ( void * ) pivot );

                messages = NULL;
                na_object_free_items( pivot->private->tree );
                pivot->private->tree = na_io_provider_load_items( pivot, pivot->private->loadable_set, &messages );

                for( im = messages ; im ; im = im->next ){
                        g_warning( "%s: %s", thisfn, ( const gchar * ) im->data );
                }

                na_core_utils_slist_free( messages );
        }
}

/*
 * na_pivot_set_new_items:
 * @pivot: this #NAPivot instance.
 * @tree: the new tree of items.
 *
 * Replace the current list with this one, acquiring the full ownership
 * of the provided @tree.
 */
void
na_pivot_set_new_items( NAPivot *pivot, GList *items )
{
        static const gchar *thisfn = "na_pivot_set_new_items";

        g_return_if_fail( NA_IS_PIVOT( pivot ));

        if( !pivot->private->dispose_has_run ){

                g_debug( "%s: pivot=%p, items=%p (count=%d)",
                                thisfn, ( void * ) pivot, ( void * ) items, items ? g_list_length( items ) : 0 );

                na_object_free_items( pivot->private->tree );
                pivot->private->tree = items;
        }
}

/*
 * na_pivot_on_item_changed_handler:
 * @provider: the #NAIIOProvider which has emitted the signal.
 * @pivot: this #NAPivot instance.
 *
 * This handler is trigerred by #NAIIOProvider providers when an action
 * is changed in their underlying storage subsystems.
 *
 * The NAIIOProvider is supposed to have itself already summarized
 * a minima its own burst of notifications.
 *
 * We don't care of updating our internal list with each and every
 * atomic modification; instead we wait for the end of notifications
 * serie, and then signal our consumers.
 */
void
na_pivot_on_item_changed_handler( NAIIOProvider *provider, NAPivot *pivot  )
{
        static const gchar *thisfn = "na_pivot_on_item_changed_handler";

        g_return_if_fail( NA_IS_IIO_PROVIDER( provider ));
        g_return_if_fail( NA_IS_PIVOT( pivot ));

        if( !pivot->private->dispose_has_run ){
                g_debug( "%s: provider=%p, pivot=%p", thisfn, ( void * ) provider, ( void * ) pivot );

                na_timeout_event( &pivot->private->change_timeout );
        }
}

/*
 * this callback is triggered after having received a first 'item-changed' event,
 * and having received no more event during a 'st_burst_timeout' period; we can
 * so suppose that the burst if modification events is terminated
 * this is up to NAPivot to send now its summarized signal
 */
static void
on_items_changed_timeout( NAPivot *pivot )
{
        static const gchar *thisfn = "na_pivot_on_items_changed_timeout";

        g_return_if_fail( NA_IS_PIVOT( pivot ));

        g_debug( "%s: emitting %s signal", thisfn, PIVOT_SIGNAL_ITEMS_CHANGED );
        g_signal_emit_by_name(( gpointer ) pivot, PIVOT_SIGNAL_ITEMS_CHANGED );
}

/*
 * na_pivot_get_settings:
 * @pivot: this #NAPivot instance.
 *
 * Returns: a pointer (not a reference) to the common #NASettings object.
 * This pointer is owned by @pivot, and should not be released by the caller.
 *
 * Since: 3.1.0
 */
NASettings *
na_pivot_get_settings( const NAPivot *pivot )
{
        NASettings *settings;

        g_return_val_if_fail( NA_IS_PIVOT( pivot ), NULL );

        settings = NULL;

        if( !pivot->private->dispose_has_run ){

                settings = pivot->private->settings;
        }

        return( settings );
}

/*
 * na_pivot_set_loadable:
 * @pivot: this #NAPivot instance.
 * @loadable: the population of items to be loaded.
 *
 * Sets the loadable set.
 */
void
na_pivot_set_loadable( NAPivot *pivot, guint loadable )
{
        g_return_if_fail( NA_IS_PIVOT( pivot ));

        if( !pivot->private->dispose_has_run ){

                pivot->private->loadable_set = loadable;
        }
}