aboutsummaryrefslogtreecommitdiffstats
path: root/embed/ephy-embed-persist.c
blob: aeee7584df6d9801217593a279658cd41a9a707b (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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
/*
 *  Copyright (C) 2000-2003 Marco Pesenti Gritti
 *  Copyright (C) 2003 Christian Persch
 *
 *  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, 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.
 *
 *  $Id$
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "ephy-embed-persist.h"
#include "mozilla-embed-persist.h"
#include "ephy-debug.h"

enum
{
    PROP_0,
    PROP_DEST,
    PROP_EMBED,
    PROP_FILECHOOSER_TITLE,
    PROP_FILECHOOSER_PARENT,
    PROP_FLAGS,
    PROP_HANDLER,
    PROP_MAX_SIZE,
    PROP_PERSISTKEY,
    PROP_SOURCE,    
};

#define EPHY_EMBED_PERSIST_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), EPHY_TYPE_EMBED_PERSIST, EphyEmbedPersistPrivate))

struct EphyEmbedPersistPrivate
{
    char *dest;
    char *source;
    char *fc_title;
    char *persist_key;
    EphyEmbed *embed;
    long max_size;
    EmbedPersistFlags flags;
    GtkWindow *fc_parent;
};

static void ephy_embed_persist_class_init   (EphyEmbedPersistClass *klass);
static void ephy_embed_persist_init     (EphyEmbedPersist *ges);

static GObjectClass *parent_class = NULL;

GType
ephy_embed_persist_get_type (void)
{
       static GType type = 0;

    if (G_UNLIKELY (type == 0))
    {
        static const GTypeInfo our_info =
        {
            sizeof (EphyEmbedPersistClass),
            NULL, /* base_init */
            NULL, /* base_finalize */
            (GClassInitFunc) ephy_embed_persist_class_init,
            NULL, /* class_finalize */
            NULL, /* class_data */
            sizeof (EphyEmbedPersist),
            0,    /* n_preallocs */
            (GInstanceInitFunc) ephy_embed_persist_init
        };

        type = g_type_register_static (G_TYPE_OBJECT,
                           "EphyEmbedPersist",
                           &our_info, G_TYPE_FLAG_ABSTRACT);
    }

    return type;
}

/**
 * ephy_embed_persist_set_dest:
 * @persist: an #EphyEmbedPersist
 * @value: the path to which @persist should save data
 *
 * Sets the path to which @persist should save data.
 **/
void
ephy_embed_persist_set_dest (EphyEmbedPersist *persist,
                 const char *value)
{
    g_return_if_fail (EPHY_IS_EMBED_PERSIST (persist));

    persist->priv->dest = g_strdup (value);
}

/**
 * ephy_embed_persist_set_embed:
 * @persist: an #EphyEmbedPersist
 * @value: a parent #EphyEmbed
 *
 * Sets the #EphyEmbed from which @persist will download data.
 *
 * An #EphyEmbed is absolutely required to download if @persist's
 * #EmbedPersistFlags include %EMBED_PERSIST_COPY_PAGE. Regardless, an
 * #EphyEmbed should be set for <emphasis>every</emphasis> #EphyEmbedPersist,
 * since it determines request information such as the referring page.
 **/
void
ephy_embed_persist_set_embed (EphyEmbedPersist *persist,
                  EphyEmbed *value)
{
    g_return_if_fail (EPHY_IS_EMBED_PERSIST (persist));

    persist->priv->embed = value;
}

/**
 * ephy_embed_persist_set_fc_title:
 * @persist: an #EphyEmbedPersist
 * @value: the title to be displayed by the filechooser
 *
 * Sets the title of the filechooser window. The filechooser will only be
 * displayed if %EMBED_PERSIST_ASK_DESTINATION has been set with
 * ephy_embed_persist_set_flags().
 **/
void
ephy_embed_persist_set_fc_title (EphyEmbedPersist *persist,
                 const char *value)
{
    g_return_if_fail (EPHY_IS_EMBED_PERSIST (persist));

    persist->priv->fc_title = g_strdup (value);
}

/**
 * ephy_embed_persist_set_fc_parent:
 * @persist: an #EphyEmbedPersist
 * @value: the #EphyWindow which should be the filechooser's parent
 *
 * Sets the #EphyWindow which should be @persist's filechooser's parent. The
 * filechooser will only be displayed if %EMBED_PERSIST_ASK_DESTINATION has been
 * set with ephy_embed_persist_set_flags().
 **/
void
ephy_embed_persist_set_fc_parent (EphyEmbedPersist *persist,
                  GtkWindow *value)
{
    g_return_if_fail (EPHY_IS_EMBED_PERSIST (persist));

    persist->priv->fc_parent = value;
}

/**
 * ephy_embed_persist_set_flags:
 * @persist: an #EphyEmbedPersist
 * @value: the desired #EmbedPersistFlags
 *
 * Sets the flags to be used for @persist's download.
 **/
void
ephy_embed_persist_set_flags (EphyEmbedPersist *persist,
                  EmbedPersistFlags value)
{
    g_return_if_fail (EPHY_IS_EMBED_PERSIST (persist));

    persist->priv->flags = value;
}

/**
 * ephy_embed_persist_set_max_size:
 * @persist: an #EphyEmbedPersist
 * @value: maximum size of requested download, in bytes
 *
 * Sets the maximum size of @persist's download.
 *
 * If the requested file is discovered to be larger than @value, the download
 * will be aborted. Note that @persist will have to actually begin downloading
 * before it can abort, since it doesn't know the filesize before the download
 * starts.
 **/
void
ephy_embed_persist_set_max_size (EphyEmbedPersist *persist,
                 long value)
{
    g_return_if_fail (EPHY_IS_EMBED_PERSIST (persist));

    persist->priv->max_size = value;
}

/**
 * ephy_embed_persist_set_persist_key:
 * @persist: an #EphyEmbedPersist
 * @value: a GConf key
 *
 * Sets the GConf key from which @persist will determine the default download
 * directory.
 **/
void
ephy_embed_persist_set_persist_key (EphyEmbedPersist *persist,
                    const char *value)
{
    g_return_if_fail (EPHY_IS_EMBED_PERSIST (persist));

    persist->priv->persist_key = g_strdup (value);
}

/**
 * ephy_embed_persist_set_source:
 * @persist: an #EphyEmbedPersist
 * @value: the URL from which @persist should download
 *
 * Sets the URL from which @persist should download. This should be used in
 * conjunction with ephy_embed_persist_set_embed().
 **/
void
ephy_embed_persist_set_source (EphyEmbedPersist *persist,
                   const char *value)
{
    g_return_if_fail (EPHY_IS_EMBED_PERSIST (persist));

    persist->priv->source = g_strdup (value);
}

/**
 * ephy_embed_persist_get_dest:
 * @persist: an #EphyEmbedPersist
 *
 * Returns the destination filename to which @persist will save its download.
 *
 * Return value: @persist's destination filename
 **/
const char *
ephy_embed_persist_get_dest (EphyEmbedPersist *persist)
{
    g_return_val_if_fail (EPHY_IS_EMBED_PERSIST (persist), NULL);

    return persist->priv->dest;
}

/**
 * ephy_embed_persist_get_embed:
 * @persist: an #EphyEmbedPersist
 *
 * Returns the #EphyEmbed from which @persist will download.
 *
 * Return value: the #EphyEmbed from which @persist will download
 **/
EphyEmbed *
ephy_embed_persist_get_embed (EphyEmbedPersist *persist)
{
    g_return_val_if_fail (EPHY_IS_EMBED_PERSIST (persist), NULL);

    return persist->priv->embed;
}

/**
 * ephy_embed_persist_get_fc_title:
 * @persist: an #EphyEmbedPersist
 *
 * Returns the title to be displayed in @persist's filechooser.
 *
 * Return value: the title to be displayed in @persist's filechooser
 **/
const char *
ephy_embed_persist_get_fc_title (EphyEmbedPersist *persist)
{
    g_return_val_if_fail (EPHY_IS_EMBED_PERSIST (persist), NULL);

    return persist->priv->fc_title;
}

/**
 * ephy_embed_persist_get_fc_parent:
 * @persist: an #EphyEmbedPersist
 *
 * Returns the #EphyWindow which should serve as a parent for @persist's
 * filechooser.
 *
 * Return value: the #EphyWindow parent for @persist's filechooser
 **/
GtkWindow *
ephy_embed_persist_get_fc_parent (EphyEmbedPersist *persist)
{
    g_return_val_if_fail (EPHY_IS_EMBED_PERSIST (persist), NULL);

    return persist->priv->fc_parent;
}

/**
 * ephy_embed_persist_get_flags:
 * @persist: an #EphyEmbedPersist
 *
 * Returns @persist's #EmbedPersistFlags.
 *
 * Return value: @persist's #EmbedPersistFlags
 **/
EmbedPersistFlags
ephy_embed_persist_get_flags (EphyEmbedPersist *persist)
{
    g_return_val_if_fail (EPHY_IS_EMBED_PERSIST (persist), 0);

    return persist->priv->flags;
}

/**
 * ephy_embed_persist_get_max_size:
 * @persist: an #EphyEmbedPersist
 *
 * Returns the maximum size of @persist's requested download, in bytes.
 *
 * Return value: the maximum size of @persist's requested download, in bytes
 **/
long
ephy_embed_persist_get_max_size (EphyEmbedPersist *persist)
{
    g_return_val_if_fail (EPHY_IS_EMBED_PERSIST (persist), 0);

    return persist->priv->max_size;
}

/**
 * ephy_embed_persist_get_persist_key:
 * @persist: an #EphyEmbedPersist
 *
 * Returns the GConf key which determines Epiphany's default download directory.
 *
 * Return value: the GConf key to the default download directory
 **/
const char *
ephy_embed_persist_get_persist_key (EphyEmbedPersist *persist)
{
    g_return_val_if_fail (EPHY_IS_EMBED_PERSIST (persist), NULL);

    return persist->priv->persist_key;
}

/**
 * ephy_embed_persist_get_source:
 * @persist: an #EphyEmbedPersist
 *
 * Returns the source URL of the file to download.
 *
 * Return value: a source URL
 **/
const char *
ephy_embed_persist_get_source (EphyEmbedPersist *persist)
{
    g_return_val_if_fail (EPHY_IS_EMBED_PERSIST (persist), NULL);

    return persist->priv->source;
}

static void
ephy_embed_persist_set_property (GObject *object,
                 guint prop_id,
                 const GValue *value,
                 GParamSpec *pspec)
{
    EphyEmbedPersist *persist = EPHY_EMBED_PERSIST (object);

    switch (prop_id)
    {
        case PROP_DEST:
            ephy_embed_persist_set_dest (persist, g_value_get_string (value));
            break;
        case PROP_EMBED:
            ephy_embed_persist_set_embed (persist, g_value_get_object (value));
            break;
        case PROP_FILECHOOSER_TITLE:
            ephy_embed_persist_set_fc_title (persist, g_value_get_string (value));
            break;
        case PROP_FILECHOOSER_PARENT:
            ephy_embed_persist_set_fc_parent (persist, g_value_get_object (value));
            break;
        case PROP_FLAGS:
            ephy_embed_persist_set_flags (persist, g_value_get_int (value));
            break;
        case PROP_MAX_SIZE:
            ephy_embed_persist_set_max_size (persist, g_value_get_long (value));
            break;
        case PROP_PERSISTKEY:
            ephy_embed_persist_set_persist_key (persist, g_value_get_string (value));
            break;
        case PROP_SOURCE:
            ephy_embed_persist_set_source (persist, g_value_get_string (value));
            break;
    }
}

static void
ephy_embed_persist_get_property (GObject *object,
                 guint prop_id,
                 GValue *value,
                 GParamSpec *pspec)
{
    EphyEmbedPersist *persist = EPHY_EMBED_PERSIST (object);

    switch (prop_id)
    {
        case PROP_DEST:
            g_value_set_string (value, ephy_embed_persist_get_dest (persist));
            break;
        case PROP_EMBED:
            g_value_set_object (value, ephy_embed_persist_get_embed (persist));
            break;
        case PROP_FILECHOOSER_TITLE:
            g_value_set_string (value, ephy_embed_persist_get_fc_title (persist));
            break;
        case PROP_FILECHOOSER_PARENT:
            g_value_set_object (value, ephy_embed_persist_get_fc_parent (persist));
            break;
        case PROP_FLAGS:
            g_value_set_int (value, ephy_embed_persist_get_flags (persist));
            break;
        case PROP_MAX_SIZE:
            g_value_set_long (value, ephy_embed_persist_get_max_size (persist));
            break;
        case PROP_PERSISTKEY:
            g_value_set_string (value, ephy_embed_persist_get_persist_key (persist));
            break;
        case PROP_SOURCE:
            g_value_set_string (value, ephy_embed_persist_get_source (persist));
            break;
    }
}

static void
ephy_embed_persist_init (EphyEmbedPersist *persist)
{
    persist->priv = EPHY_EMBED_PERSIST_GET_PRIVATE (persist);

    LOG ("EphyEmbedPersist initialising %p", persist)

    persist->priv->dest = NULL;
    persist->priv->source = NULL;
    persist->priv->fc_title = NULL;
    persist->priv->fc_parent = NULL;
    persist->priv->flags = 0;
    persist->priv->max_size = -1;
    persist->priv->persist_key = NULL;
}

static void
ephy_embed_persist_finalize (GObject *object)
{
    EphyEmbedPersist *persist = EPHY_EMBED_PERSIST (object);

    g_free (persist->priv->dest);
    g_free (persist->priv->source);
    g_free (persist->priv->fc_title);
    g_free (persist->priv->persist_key);

    LOG ("EphyEmbedPersist finalised %p", object)

    G_OBJECT_CLASS (parent_class)->finalize (object);
}

static void
ephy_embed_persist_class_init (EphyEmbedPersistClass *klass)
{
    GObjectClass *object_class = G_OBJECT_CLASS (klass);

    parent_class = g_type_class_peek_parent (klass);

    object_class->finalize = ephy_embed_persist_finalize;
    object_class->set_property = ephy_embed_persist_set_property;
    object_class->get_property = ephy_embed_persist_get_property;

    /* init signals */
/**
 * EphyEmbedPersist::completed:
 *
 * The ::completed signal is emitted when @persist has finished downloading. The
 * download must have started with ephy_embed_persist_save().
 **/
    g_signal_new ("completed",
              G_OBJECT_CLASS_TYPE (object_class),
              G_SIGNAL_RUN_LAST,
              G_STRUCT_OFFSET (EphyEmbedPersistClass, completed),
              NULL, NULL,
              g_cclosure_marshal_VOID__VOID,
              G_TYPE_NONE,
              0);
/**
 * EphyEmbedPersist::cancelled:
 *
 * The ::cancelled signal is emitted when @persist's download has been
 * cancelled with ephy_embed_persist_cancel().
 **/
    g_signal_new ("cancelled",
              G_OBJECT_CLASS_TYPE (object_class),
              G_SIGNAL_RUN_LAST,
              G_STRUCT_OFFSET (EphyEmbedPersistClass, cancelled),
              NULL, NULL,
              g_cclosure_marshal_VOID__VOID,
              G_TYPE_NONE,
              0);

    g_object_class_install_property (object_class,
                     PROP_DEST,
                     g_param_spec_string ("dest",
                                  "Destination",
                                  "Destination file path",
                                  NULL,
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_EMBED,
                     g_param_spec_object ("embed",
                                  "Embed",
                                  "The embed containing the document",
                                  G_TYPE_OBJECT,
                                  G_PARAM_READWRITE |
                                  G_PARAM_CONSTRUCT_ONLY));

    g_object_class_install_property (object_class,
                     PROP_FILECHOOSER_TITLE,
                     g_param_spec_string  ("filechooser-title",
                                   "Filechooser title",
                                   "Title to use if showing filechooser",
                                   NULL,
                                   G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_FILECHOOSER_PARENT,
                     g_param_spec_object ("filechooser-parent",
                                  "Filechooser parent",
                                  "The parent window for the filechooser",
                                  GTK_TYPE_WINDOW,
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_FLAGS,
                     g_param_spec_int    ("flags",
                                  "Flags",
                                  "Flags",
                                  0,
                                  G_MAXINT,
                                  0,
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_MAX_SIZE,
                     g_param_spec_long   ("max_size",
                                  "Maxsize",
                                  "Maximum size of the file",
                                  0,
                                  G_MAXLONG,
                                  0,
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_PERSISTKEY,
                     g_param_spec_string  ("persist-key",
                                   "persist key",
                                   "Path persistence gconf key",
                                   NULL,
                                   G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_SOURCE,
                     g_param_spec_string  ("source",
                                   "Source",
                                   "Url of the document to save",
                                   NULL,
                                   G_PARAM_READWRITE));

    g_type_class_add_private (object_class, sizeof(EphyEmbedPersistPrivate));
}

/**
 * ephy_embed_persist_cancel:
 * @persist: an #EphyEmbedPersist
 *
 * Cancels @persist's download. This will not delete the partially downloaded
 * file.
 **/
void
ephy_embed_persist_cancel (EphyEmbedPersist *persist)
{
    EphyEmbedPersistClass *klass = EPHY_EMBED_PERSIST_GET_CLASS (persist);
    klass->cancel (persist);
}

/**
 * ephy_embed_persist_save:
 * @persist: an #EphyEmbedPersist
 *
 * Begins saving the file specified in @persist.
 *
 * If @persist's #EmbedPersistFlags include %EMBED_PERSIST_ASK_DESTINATION, a
 * filechooser dialog will be shown first.
 *
 * The file will continue to download in the background until either the
 * ::completed or the ::cancelled signals are emitted by @persist.
 *
 * Return value: %TRUE if the download began successfully
 **/
gboolean
ephy_embed_persist_save (EphyEmbedPersist *persist)
{
    EphyEmbedPersistClass *klass = EPHY_EMBED_PERSIST_GET_CLASS (persist);
    return klass->save (persist);
}

/**
 * ephy_embed_persist_to_string:
 * @persist: an #EphyEmbedPersist
 *
 * Returns the download specified by @persist as a string instead of downloading
 * it to a file.
 *
 * The download is synchronous. An #EphyEmbed must be specified with
 * ephy_embed_persist_set_embed(). The function implicitly assumes that
 * @persist's #EmbedPersistFlags include %EMBED_PERSIST_COPY_PAGE. If @persist's
 * #EphyEmbed has not finished downloading, this function will only return the
 * portion of data which has already been downloaded.
 *
 * The document will be modified: it will only include absolute links and it
 * will be encoded as UTF-8.
 *
 * Return value: The contents of @persist's #EphyEmbed's web page
 **/
char *
ephy_embed_persist_to_string (EphyEmbedPersist *persist)
{
       EphyEmbedPersistClass *klass = EPHY_EMBED_PERSIST_GET_CLASS (persist);
       return klass->to_string (persist);
}