aboutsummaryrefslogtreecommitdiffstats
path: root/shell/evolution-activity-client.c
blob: 60e9f949d90837184d742030961e6f7b1d6afcd9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* evolution-activity-client.c
 *
 * Copyright (C) 2001  Ximian, Inc.
 *
 * 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 program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Ettore Perazzoli <ettore@ximian.com>
 */

/* Another evil GTK+ object wrapper for a CORBA API.  In this case, the wrapper
   is needed to avoid sending too frequent CORBA requests across the wire, thus
   slowing the client down.  The wrapper makes sure that there is a minimum
   amount of time between each CORBA method invocation.  */

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

#include "evolution-activity-client.h"

#include <gtk/gtksignal.h>
#include <gtk/gtkmain.h>

#include <bonobo/bonobo-listener.h>

#include <gal/util/e-util.h>


#define PARENT_TYPE gtk_object_get_type ()
static GtkObjectClass *parent_class = NULL;

/* The minimum time between updates, in msecs.  */
#define UPDATE_DELAY 1000

enum {
    SHOW_DETAILS,
    CANCEL,
    LAST_SIGNAL
};

static guint signals[LAST_SIGNAL] = { 0 };

struct _EvolutionActivityClientPrivate {
    /* The ::Activity interface that we QI from the shell.  */
    GNOME_Evolution_Activity activity_interface;

    /* BonoboListener used to get notification about actions that the user
       requested on the activity.  */
    BonoboListener *listener;

    /* Id of this activity.  */
    GNOME_Evolution_Activity_ActivityId activity_id;

    /* Id for the GTK+ timeout used to do updates.  */
    int next_update_timeout_id;

    /* Wether we have to actually push an update at this timeout.  */
    int have_pending_update;

    /* Data for the next update.  */
    char *new_information;
    double new_progress;
};


/* Utility functions.  */

/* Create an icon from @pixbuf in @icon_return.  */
static void
create_icon_from_pixbuf (GdkPixbuf *pixbuf,
             GNOME_Evolution_Icon *icon_return)
{
    const char *sp;
    CORBA_octet *dp;
    int width, height, total_width, rowstride;
    int i, j;
    gboolean has_alpha;

    width     = gdk_pixbuf_get_width (pixbuf);
    height    = gdk_pixbuf_get_height (pixbuf);
    rowstride = gdk_pixbuf_get_rowstride (pixbuf);
    has_alpha = gdk_pixbuf_get_has_alpha (pixbuf);

    if (has_alpha)
        total_width = 4 * width;
    else
        total_width = 3 * width;

    icon_return->width = width;
    icon_return->height = height;
    icon_return->hasAlpha = has_alpha;

    icon_return->rgba_data._length = icon_return->height * total_width;
    icon_return->rgba_data._maximum = icon_return->rgba_data._length;
    icon_return->rgba_data._buffer = CORBA_sequence_CORBA_octet_allocbuf (icon_return->rgba_data._maximum);

    sp = gdk_pixbuf_get_pixels (pixbuf);
    dp = icon_return->rgba_data._buffer;
    for (i = 0; i < height; i ++) {
        for (j = 0; j < total_width; j++)
            *(dp ++) = sp[j];
        sp += rowstride;
    }
}

/* Generate an AnimatedIcon from a NULL-terminated @pixbuf_array.  */
static GNOME_Evolution_AnimatedIcon *
create_corba_animated_icon_from_pixbuf_array (GdkPixbuf **pixbuf_array)
{
    GNOME_Evolution_AnimatedIcon *animated_icon;
    GdkPixbuf **p;
    int num_frames;
    int i;

    num_frames = 0;
    for (p = pixbuf_array; *p != NULL; p++)
        num_frames++; 

    if (num_frames == 0)
        return NULL;

    animated_icon = GNOME_Evolution_AnimatedIcon__alloc ();

    animated_icon->_length = num_frames;
    animated_icon->_maximum = num_frames;
    animated_icon->_buffer = CORBA_sequence_GNOME_Evolution_Icon_allocbuf (animated_icon->_maximum);

    for (i = 0; i < num_frames; i++)
        create_icon_from_pixbuf (pixbuf_array[i], & animated_icon->_buffer[i]);

    CORBA_sequence_set_release (animated_icon, TRUE);

    return animated_icon;
}

static gboolean
corba_update_progress (EvolutionActivityClient *activity_client,
               const char *information,
               double progress)
{
    EvolutionActivityClientPrivate *priv;
    CORBA_Environment ev;
    gboolean retval;

    priv = activity_client->priv;

    CORBA_exception_init (&ev);

    GNOME_Evolution_Activity_operationProgressing (priv->activity_interface,
                               priv->activity_id,
                               information,
                               progress,
                               &ev);

    if (ev._major == CORBA_NO_EXCEPTION) {
        retval = TRUE;
    } else {
        g_warning ("EvolutionActivityClient: Error updating progress -- %s",
               ev._repo_id);
        retval = FALSE;
    }

    CORBA_exception_free (&ev);

    return retval;
}

static gboolean
update_timeout_callback (void *data)
{
    EvolutionActivityClient *activity_client;
    EvolutionActivityClientPrivate *priv;

    activity_client = EVOLUTION_ACTIVITY_CLIENT (data);
    priv = activity_client->priv;

    if (priv->have_pending_update) {
        corba_update_progress (activity_client, priv->new_information, priv->new_progress);
        priv->have_pending_update = FALSE;
        return TRUE;
    } else {
        priv->next_update_timeout_id = 0;
        return FALSE;
    }
}


/* BonoboListener callback.  */

static void
listener_callback (BonoboListener *listener,
           char *event_name, 
           CORBA_any *any,
           CORBA_Environment *ev,
           void *data)
{
    EvolutionActivityClient *activity_client;

    activity_client = EVOLUTION_ACTIVITY_CLIENT (data);

    if (strcmp (event_name, "ShowDetails") == 0)
        gtk_signal_emit (GTK_OBJECT (activity_client), signals[SHOW_DETAILS]);
    else if (strcmp (event_name, "Cancel") == 0)
        gtk_signal_emit (GTK_OBJECT (activity_client), signals[CANCEL]);
    else
        g_warning ("EvolutionActivityClient: Unknown event from listener -- %s", event_name);
}


/* GtkObject methods.  */

static void
impl_destroy (GtkObject *object)
{
    EvolutionActivityClient *activity_client;
    EvolutionActivityClientPrivate *priv;
    CORBA_Environment ev;

    activity_client = EVOLUTION_ACTIVITY_CLIENT (object);
    priv = activity_client->priv;

    CORBA_exception_init (&ev);

    if (! CORBA_Object_is_nil (priv->activity_interface, &ev)) {
        GNOME_Evolution_Activity_operationFinished (priv->activity_interface,
                                priv->activity_id,
                                &ev);
        if (ev._major != CORBA_NO_EXCEPTION)
            g_warning ("EvolutionActivityClient: Error reporting completion of operation -- %s",
                   ev._repo_id);

        CORBA_Object_release (priv->activity_interface, &ev);
    }

    CORBA_exception_free (&ev);

    if (priv->next_update_timeout_id != 0)
        g_source_remove (priv->next_update_timeout_id);

    g_free (priv->new_information);

    g_free (priv);

    (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
}


static void
class_init (EvolutionActivityClientClass *klass)
{
    GtkObjectClass *object_class;

    parent_class = gtk_type_class (PARENT_TYPE);

    object_class = GTK_OBJECT_CLASS (klass);
    object_class->destroy = impl_destroy;

    signals[SHOW_DETAILS] 
        = gtk_signal_new ("show_details",
                  GTK_RUN_FIRST,
                  object_class->type,
                  GTK_SIGNAL_OFFSET (EvolutionActivityClientClass, show_details),
                  gtk_marshal_NONE__NONE,
                  GTK_TYPE_NONE, 0);

    signals[CANCEL] 
        = gtk_signal_new ("cancel",
                  GTK_RUN_FIRST,
                  object_class->type,
                  GTK_SIGNAL_OFFSET (EvolutionActivityClientClass, cancel),
                  gtk_marshal_NONE__NONE,
                  GTK_TYPE_NONE, 0);

    gtk_object_class_add_signals (object_class, signals, LAST_SIGNAL);
}


static void
init (EvolutionActivityClient *activity_client)
{
    EvolutionActivityClientPrivate *priv;

    priv = g_new (EvolutionActivityClientPrivate, 1);
    priv->activity_interface     = CORBA_OBJECT_NIL;
    priv->listener               = bonobo_listener_new (listener_callback, activity_client);
    priv->activity_id            = (GNOME_Evolution_Activity_ActivityId) 0;
    priv->next_update_timeout_id = 0;
    priv->have_pending_update    = FALSE;
    priv->new_information        = NULL;
    priv->new_progress           = 0.0;

    activity_client->priv = priv;
}


gboolean
evolution_activity_client_construct (EvolutionActivityClient *activity_client,
                     EvolutionShellClient *shell_client,
                     const char *component_id,
                     GdkPixbuf **animated_icon,
                     const char *information,
                     gboolean cancellable,
                     gboolean *suggest_display_return)
{
    EvolutionActivityClientPrivate *priv;
    GNOME_Evolution_Activity activity_interface;
    CORBA_Environment ev;
    CORBA_boolean suggest_display;

    g_return_val_if_fail (activity_client != NULL, FALSE);
    g_return_val_if_fail (EVOLUTION_IS_ACTIVITY_CLIENT (activity_client), FALSE);
    g_return_val_if_fail (shell_client != NULL, FALSE);
    g_return_val_if_fail (EVOLUTION_IS_SHELL_CLIENT (shell_client), FALSE);
    g_return_val_if_fail (animated_icon != NULL, FALSE);
    g_return_val_if_fail (*animated_icon != NULL, FALSE);
    g_return_val_if_fail (information != NULL, FALSE);
    g_return_val_if_fail (suggest_display_return != NULL, FALSE);

    priv = activity_client->priv;
    g_return_val_if_fail (priv->activity_interface == CORBA_OBJECT_NIL, FALSE);

    GTK_OBJECT_UNSET_FLAGS (activity_client, GTK_FLOATING);

    CORBA_exception_init (&ev);

    activity_interface = evolution_shell_client_get_activity_interface (shell_client);
    priv->activity_interface = CORBA_Object_duplicate (activity_interface, &ev);
    if (ev._major != CORBA_NO_EXCEPTION) {
        priv->activity_interface = CORBA_OBJECT_NIL;
        CORBA_exception_free (&ev);
        return FALSE;
    }

    GNOME_Evolution_Activity_operationStarted (activity_interface,
                           component_id,
                           create_corba_animated_icon_from_pixbuf_array (animated_icon),
                           information,
                           cancellable,
                           bonobo_object_corba_objref (BONOBO_OBJECT (priv->listener)),
                           &priv->activity_id,
                           &suggest_display,
                           &ev);
    if (ev._major != CORBA_NO_EXCEPTION) {
        CORBA_exception_free (&ev);
        return FALSE;
    }

    *suggest_display_return = (gboolean) suggest_display;

    CORBA_exception_free (&ev);
    return TRUE;
}

EvolutionActivityClient *
evolution_activity_client_new (EvolutionShellClient *shell_client,
                   const char *component_id,
                   GdkPixbuf **animated_icon,
                   const char *information,
                   gboolean cancellable,
                   gboolean *suggest_display_return)
{
    EvolutionActivityClient *activity_client;

    g_return_val_if_fail (shell_client != NULL, NULL);
    g_return_val_if_fail (EVOLUTION_IS_SHELL_CLIENT (shell_client), NULL);
    g_return_val_if_fail (animated_icon != NULL, NULL);
    g_return_val_if_fail (*animated_icon != NULL, NULL);
    g_return_val_if_fail (information != NULL, NULL);
    g_return_val_if_fail (suggest_display_return != NULL, NULL);

    activity_client = gtk_type_new (evolution_activity_client_get_type ());

    if (! evolution_activity_client_construct (activity_client,
                           shell_client,
                           component_id,
                           animated_icon,
                           information,
                           cancellable,
                           suggest_display_return)) {
        gtk_object_unref (GTK_OBJECT (activity_client));
        return NULL;
    }

    return activity_client;
}


gboolean
evolution_activity_client_update (EvolutionActivityClient *activity_client,
                  const char *information,
                  double progress)
{
    EvolutionActivityClientPrivate *priv;
    gboolean retval;

    g_return_val_if_fail (activity_client != NULL, FALSE);
    g_return_val_if_fail (EVOLUTION_IS_ACTIVITY_CLIENT (activity_client), FALSE);
    g_return_val_if_fail (information != NULL, FALSE);
    g_return_val_if_fail (progress >= 0.0 && progress <= 1.0, FALSE);

    priv = activity_client->priv;

    if (priv->next_update_timeout_id == 0) {
        /* There is no pending timeout, so the last CORBA update
           happened more than UPDATE_DELAY msecs ago.  */

        retval = corba_update_progress (activity_client, information, progress);

        /* Set up a timeout so we can check against it at the next
           update request.  */

        priv->next_update_timeout_id = g_timeout_add (UPDATE_DELAY,
                                  update_timeout_callback,
                                  activity_client);

        priv->have_pending_update = FALSE;
    } else {
        /* There is a pending timeout, so the last CORBA update
           happened less than UPDATE_DELAY msecs ago.  So just queue an
           update instead.  */

        g_free (priv->new_information);
        priv->new_information = g_strdup (information);
        priv->new_progress = progress;

        priv->have_pending_update = TRUE;

        retval = TRUE;
    }

    return retval;
}

GNOME_Evolution_Activity_DialogAction
evolution_activity_client_request_dialog (EvolutionActivityClient *client,
                      GNOME_Evolution_Activity_DialogType dialog_type)
{
    EvolutionActivityClientPrivate *priv;
    GNOME_Evolution_Activity_DialogAction retval;
    CORBA_Environment ev;

    g_return_val_if_fail (client != NULL, GNOME_Evolution_Activity_DIALOG_ACTION_ERROR);
    g_return_val_if_fail (EVOLUTION_IS_ACTIVITY_CLIENT (client), GNOME_Evolution_Activity_DIALOG_ACTION_ERROR);

    priv = client->priv;

    CORBA_exception_init (&ev);

    retval = GNOME_Evolution_Activity_requestDialog (priv->activity_interface,
                             priv->activity_id,
                             dialog_type,
                             &ev);
    if (ev._major != CORBA_NO_EXCEPTION) {
        g_warning ("EvolutionActivityClient: Error requesting a dialog -- %s", ev._repo_id);
        retval = GNOME_Evolution_Activity_DIALOG_ACTION_ERROR;
    }

    CORBA_exception_free (&ev);

    return retval;
}


E_MAKE_TYPE (evolution_activity_client, "EvolutionActivityClient", EvolutionActivityClient,
         class_init, init, PARENT_TYPE)