aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ephy-file-helpers.c
blob: 9ccdf017b2aa9b782fed53e7a7378e2228a882b3 (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
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 *  Copyright © 2002 Jorn Baayen
 *  Copyright © 2003, 2004 Marco Pesenti Gritti
 *  Copyright © 2004, 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#include "config.h"

#include "ephy-file-helpers.h"

#include "ephy-prefs.h"
#include "ephy-debug.h"
#include "ephy-profile-utils.h"
#include "ephy-settings.h"
#include "ephy-string.h"

#include <glib.h>
#include <glib/gi18n.h>
#include <gio/gio.h>
#include <gio/gdesktopappinfo.h>
#include <gdk/gdk.h>
#include <libxml/xmlreader.h>

#include <gdk/gdk.h>
#include <gtk/gtk.h>

#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/stat.h>

/**
 * SECTION:ephy-file-helpers
 * @short_description: miscellaneous file related utility functions
 *
 * File related functions, including functions to launch, browse or move files
 * atomically.
 */

#define EPHY_UUID       "0d82d98f-7079-401c-abff-203fcde1ece3"
#define EPHY_UUID_ENVSTRING EPHY_UUID_ENVVAR "=" EPHY_UUID

#define DELAY_MAX_TICKS 64
#define INITIAL_TICKS   2

static GHashTable *files = NULL;
static GHashTable *mime_table = NULL;

static gboolean keep_temp_directory = FALSE; /* for debug purposes */
static char *dot_dir = NULL;
static char *tmp_dir = NULL;
static GList *del_on_exit = NULL;

GQuark ephy_file_helpers_error_quark;

/**
 * ephy_file_tmp_dir:
 *
 * Returns the name of the temp dir for the running Epiphany instance.
 *
 * Returns: the name of the temp dir, this string belongs to Epiphany.
 **/
const char *
ephy_file_tmp_dir (void)
{
    if (tmp_dir == NULL)
    {
        char *partial_name;
        char *full_name;

        partial_name = g_strconcat ("epiphany-", g_get_user_name (),
                        "-XXXXXX", NULL);
        full_name = g_build_filename (g_get_tmp_dir (), partial_name,
                          NULL);
#ifdef HAVE_MKDTEMP
        tmp_dir = mkdtemp (full_name);
#else
#error no mkdtemp implementation
#endif
        g_free (partial_name);

        if (tmp_dir == NULL)
        {
            g_free (full_name);
        }
    }

    return tmp_dir;
}

static char *
ephy_file_download_dir (void)
{
    const char *xdg_download_dir;

    xdg_download_dir = g_get_user_special_dir (G_USER_DIRECTORY_DOWNLOAD);
    if (xdg_download_dir != NULL)
        return g_strdup (xdg_download_dir);

    /* If we don't have XDG user dirs info, return an educated guess. */
    return g_build_filename (g_get_home_dir (), _("Downloads"), NULL);
}

/**
 * ephy_file_get_downloads_dir:
 *
 * Returns a proper downloads destination by checking the
 * EPHY_PREFS_STATE_DOWNLOAD_DIR GSettings key and following this logic:
 *
 *  - An absolute path: considered user-set, use this value directly.
 *
 *  - "Desktop" keyword in GSettings: the directory returned by
 *    ephy_file_desktop_dir().
 *
 *  - "Downloads" keyword in GSettings, or any other value: the XDG
 *  downloads directory, or ~/Downloads.
 *
 * Returns: a newly-allocated string containing the path to the downloads dir.
 **/
char *
ephy_file_get_downloads_dir (void)
{
    char *download_dir;

    download_dir = g_settings_get_string (EPHY_SETTINGS_STATE,
                          EPHY_PREFS_STATE_DOWNLOAD_DIR);

    if (g_str_equal (download_dir, "Desktop"))
        download_dir = ephy_file_desktop_dir ();
    if (g_str_equal (download_dir, "Downloads") ||
        g_path_is_absolute (download_dir) != TRUE)
        download_dir = ephy_file_download_dir ();

    return download_dir;
}

/**
 * ephy_file_desktop_dir:
 *
 * Gets the XDG desktop dir path or a default homedir/Desktop alternative.
 *
 * Returns: a newly-allocated string containing the desktop dir path.
 **/
char *
ephy_file_desktop_dir (void)
{
    const char *xdg_desktop_dir;

    xdg_desktop_dir = g_get_user_special_dir (G_USER_DIRECTORY_DESKTOP);
    if (xdg_desktop_dir != NULL)
        return g_strdup (xdg_desktop_dir);

    /* If we don't have XDG user dirs info, return an educated guess. */
    return g_build_filename (g_get_home_dir (), _("Desktop"), NULL);
}

/**
 * ephy_file_tmp_filename:
 * @base: the base name of the temp file to create, containing "XXXXXX"
 * @extension: an optional extension for @base or %NULL
 *
 * Gets a usable temp filename with g_mkstemp() using @base as the name
 * with an optional @extension. @base should contain "XXXXXX" in it.
 *
 * Notice that this does not create the file. It only gets a valid
 * filename.
 *
 * Returns: a newly-allocated string containing the name of the temp
 * file name or %NULL.
 **/
char *
ephy_file_tmp_filename (const char *base,
            const char *extension)
{
    int fd;
    char *name = g_strdup (base);

    fd = g_mkstemp (name);

    if (fd != -1)
    {
        unlink (name);
        close (fd);
    }
    else
    {
        g_free (name);

        return NULL;
    }

    if (extension)
    {
        char *tmp;
        tmp = g_strconcat (name, ".",
                   extension, NULL);
        g_free (name);
        name = tmp;
    }

    return name;
}

/**
 * ephy_file:
 * @filename: the name of the Epiphany file requested
 *
 * Looks for @filename in Epiphany's directories and relevant paths.
 *
 * Returns: the full path to the requested file
 **/
const char *
ephy_file (const char *filename)
{
    char *ret;
    guint i;

    static const char * const paths[] =
    {
#ifdef GNOME_ENABLE_DEBUG
        TOP_SRC_DATADIR "/",
        TOP_SRC_DATADIR "/pages/",
#endif
        SHARE_DIR "/",
        SHARE_DIR "/pages/"
    };

    g_assert (files != NULL);

    ret = g_hash_table_lookup (files, filename);
    if (ret != NULL)
        return ret;

    for (i = 0; i < G_N_ELEMENTS (paths); i++)
    {
        ret = g_strconcat (paths[i], filename, NULL);
        if (g_file_test (ret, G_FILE_TEST_EXISTS) == TRUE)
        {
            g_hash_table_insert (files, g_strdup (filename), ret);
            return (const char *) ret;
        }
        g_free (ret);
    }

    g_warning ("Failed to find %s\n", filename);

    return NULL;
}

/**
 * ephy_dot_dir:
 *
 * Gets Epiphany's configuration directory, usually .gnome2/epiphany under
 * user's homedir.
 *
 * Returns: the full path to Epiphany's configuration directory
 **/
const char *
ephy_dot_dir (void)
{
    return dot_dir;
}

/**
 * ephy_file_helpers_init:
 * @profile_dir: directory to use as Epiphany's profile
 * @flags: the %EphyFileHelpersFlags for this session
 * @error: an optional #GError
 *
 * Initializes Epiphany file helper functions, sets @profile_dir as Epiphany's
 * profile dir and whether the running session will be private.
 *
 * Returns: %FALSE if the profile dir couldn't be created or accessed
 **/
gboolean
ephy_file_helpers_init (const char *profile_dir,
            EphyFileHelpersFlags flags,
            GError **error)
{
    const char *uuid;
    gboolean private_profile;

    /* See if we've been calling ourself, and abort if we have */
    uuid = g_getenv (EPHY_UUID_ENVVAR);
    if (uuid && strcmp (uuid, EPHY_UUID) == 0)
    {
        g_warning ("Self call detected, exiting!\n");
        exit (1);
    }

    /* Put marker in env */
    g_setenv (EPHY_UUID_ENVVAR, EPHY_UUID, TRUE);

    ephy_file_helpers_error_quark = g_quark_from_static_string ("ephy-file-helpers-error");

    files = g_hash_table_new_full (g_str_hash,
                       g_str_equal,
                       (GDestroyNotify) g_free,
                       (GDestroyNotify) g_free);

    keep_temp_directory = flags & EPHY_FILE_HELPERS_KEEP_TEMP_DIR;
    private_profile = flags & EPHY_FILE_HELPERS_PRIVATE_PROFILE;

    if (private_profile && profile_dir != NULL)
    {
        dot_dir = g_strdup (profile_dir);
    }
    else if (private_profile)
    {
        if (ephy_file_tmp_dir () == NULL)
        {
            g_set_error (error,
                     EPHY_FILE_HELPERS_ERROR_QUARK,
                     0,
                     _("Could not create a temporary directory in “%s”."),
                     g_get_tmp_dir ());
            return FALSE;
        }

        dot_dir = g_build_filename (ephy_file_tmp_dir (),
                        "epiphany",
                        NULL);
    }
    else
    {
        dot_dir = g_build_filename (g_get_user_config_dir (),
                        "epiphany",
                        NULL);
    }

    if (flags & EPHY_FILE_HELPERS_ENSURE_EXISTS)
        return ephy_ensure_dir_exists (ephy_dot_dir (), error);
    else
        return TRUE;
}

static void
delete_files (GList *l)
{
    for (; l != NULL; l = l->next)
    {
        unlink (l->data);
    }
}

/**
 * ephy_file_helpers_shutdown:
 *
 * Cleans file helpers information, corresponds to ephy_file_helpers_init().
 **/
void
ephy_file_helpers_shutdown (void)
{
    g_hash_table_destroy (files);

    del_on_exit = g_list_reverse (del_on_exit);
    delete_files (del_on_exit);
    g_list_foreach (del_on_exit, (GFunc)g_free, NULL);
    g_list_free (del_on_exit);
    del_on_exit = NULL;

    if (mime_table != NULL)
    {
        LOG ("Destroying mime type hashtable");
        g_hash_table_destroy (mime_table);
        mime_table = NULL;
    }

    g_free (dot_dir);
    dot_dir = NULL;

    if (tmp_dir != NULL)
    {
        if (!keep_temp_directory)
        {
            GFile *tmp_dir_file;
            tmp_dir_file = g_file_new_for_path (tmp_dir);

            /* recursively delete the contents and the
             * directory */
            LOG ("shutdown: delete tmp_dir %s", tmp_dir);
            ephy_file_delete_dir_recursively (tmp_dir_file,
                              NULL);
            g_object_unref (tmp_dir_file);
        }

        g_free (tmp_dir);
        tmp_dir = NULL;
    }

    g_unsetenv (EPHY_UUID_ENVVAR);
}

/**
 * ephy_ensure_dir_exists:
 * @dir: path to a directory
 * @error: an optional GError to fill or %NULL
 *
 * Checks if @dir exists and is a directory, if it it exists and it's not a
 * directory %FALSE is returned. If @dir doesn't exist and can't be created
 * then %FALSE is returned.
 *
 * Returns: %TRUE if @dir exists and is a directory
 **/
gboolean
ephy_ensure_dir_exists (const char *dir,
                GError **error)
{
    if (g_file_test (dir, G_FILE_TEST_EXISTS) &&
        !g_file_test (dir, G_FILE_TEST_IS_DIR))
    {
        g_set_error (error,
                 EPHY_FILE_HELPERS_ERROR_QUARK,
                 0,
                 _("The file “%s” exists. Please move it out of the way."),
                 dir);

        return FALSE;
    }

    if (!g_file_test (dir, G_FILE_TEST_EXISTS))
    {
        if (g_mkdir_with_parents (dir, 488) == 0)
        {
            /* We need to set the .migrated file to the
             * current profile migration version,
             * otherwise the next time the browser runs
             * things might go awry. */
            ephy_profile_utils_set_migration_version (EPHY_PROFILE_MIGRATION_VERSION);
        }
        else
        {
            g_set_error (error,
                     EPHY_FILE_HELPERS_ERROR_QUARK,
                     0,
                     _("Failed to create directory “%s”."),
                     dir);

            return FALSE;
        }
    }

    return TRUE;
}

static void
ephy_find_file_recursive (const char *path,
              const char *fname,
              GSList **list,
              gint depth,
              gint maxdepth)
{
    GDir *dir;
    const gchar *file;

    dir = g_dir_open (path, 0, NULL);
    if (dir != NULL)
    {
        while ((file = g_dir_read_name (dir)))
        {
            if (depth < maxdepth)
            {
                char *new_path = g_build_filename (path, file, NULL);
                ephy_find_file_recursive (new_path, fname, list,
                              depth + 1, maxdepth);
                g_free (new_path);
            }
            if (strcmp (file, fname) == 0)
            {
                char *new_path = g_build_filename (path, file, NULL);
                *list = g_slist_prepend (*list, new_path);
            }
        }

        g_dir_close (dir);
    }
}

/**
 * ephy_file_find:
 * @path: path to search for @fname
 * @fname: filename to search for
 * @maxdepth: maximum directory depth when searching @path
 *
 * Searchs for @fname in @path with a maximum depth of @maxdepth.
 *
 * Returns: a GSList of matches
 **/
GSList *
ephy_file_find (const char *path,
            const char *fname,
            gint maxdepth)
{
    GSList *ret = NULL;
    ephy_find_file_recursive (path, fname, &ret, 0, maxdepth);
    return ret;
}

/**
 * ephy_file_switch_temp_file:
 * @file_dest: destination file
 * @file_temp: file to move to @file
 *
 * Moves @file_temp to @file_dest atomically, doing a backup and restoring it if
 * something fails.
 *
 * Returns: %TRUE if the switch was successful
 **/
gboolean
ephy_file_switch_temp_file (GFile *file_dest,
                GFile *file_temp)
{
    char *file_dest_path, *file_temp_path;
    char *backup_path;
    gboolean dest_exists;
    gboolean retval = TRUE;
    GFile *backup_file;
    GError *error = NULL;

    file_dest_path = g_file_get_path (file_dest);
    file_temp_path = g_file_get_path (file_temp);

    dest_exists = g_file_test (file_dest_path, G_FILE_TEST_EXISTS);

    backup_path = g_strconcat (file_dest_path, ".old", NULL);
    backup_file = g_file_new_for_path (backup_path);

    if (dest_exists)
    {
        if (g_file_move (file_dest, backup_file,
                 G_FILE_COPY_OVERWRITE,
                 NULL, NULL, NULL, &error) == FALSE)
        {
            g_warning ("Failed to backup %s to %s: %s",
                   file_dest_path, backup_path,
                   error ? error->message : "No error set");

            if (error)
            {
                g_error_free (error);
                error = NULL;
            }

            retval = FALSE;
            goto failed;
        }
    }

    if (g_file_move (file_temp, file_dest,
             G_FILE_COPY_OVERWRITE,
             NULL, NULL, NULL, &error) == FALSE)
    {
        g_warning ("Failed to replace %s with %s: %s",
               file_temp_path, file_dest_path,
               error ? error->message : "No error set");

        if (error)
        {
            g_error_free (error);
            error = NULL;
        }

        if (g_file_move (backup_file, file_dest,
                 G_FILE_COPY_OVERWRITE,
                 NULL, NULL, NULL, &error) == FALSE)
        {
            g_warning ("Failed to restore %s from %s: %s",
                   file_dest_path, file_temp_path,
                   error ? error->message : "No error set");

            if (error)
            {
                g_error_free (error);
                error = NULL;
            }
        }

        retval = FALSE;
        goto failed;
    }

    if (dest_exists)
    {
        if (g_file_delete (backup_file, NULL, &error) == FALSE)
        {
            g_warning ("Failed to delete old file %s: %s",
                   backup_path,
                   error ? error->message : "No error set");

            if (error)
            {
                g_error_free (error);
                error = NULL;
            }
        }
    }

failed:
    g_free (file_dest_path);
    g_free (file_temp_path);

    g_free (backup_path);
    g_object_unref (backup_file);

    return retval;
}

/**
 * ephy_file_delete_on_exit:
 * @file: a #GFile
 *
 * Schedules @file to be deleted when Epiphany exits. This function currently
 * does nothing.
 **/
void
ephy_file_delete_on_exit (GFile *file)
{
    /* does nothing now */
}

static void
load_mime_from_xml (void)
{
    xmlTextReaderPtr reader;
    const char *xml_file;
    int ret;
    EphyMimePermission permission = EPHY_MIME_PERMISSION_UNKNOWN;

    g_return_if_fail (mime_table == NULL);

    mime_table = g_hash_table_new_full (g_str_hash, g_str_equal,
                        xmlFree, NULL);

    xml_file = ephy_file ("mime-types-permissions.xml");
    if (xml_file == NULL)
    {
        g_warning ("MIME types permissions file not found!\n");
        return;
    }

    reader = xmlNewTextReaderFilename (xml_file);
    if (reader == NULL)
    {
        g_warning ("Could not load MIME types permissions file!\n");
        return;
    }

    ret = xmlTextReaderRead (reader);
    while (ret == 1)
    {
        const xmlChar *tag;
        xmlReaderTypes type;

        tag = xmlTextReaderConstName (reader);
        type = xmlTextReaderNodeType (reader);

        if (xmlStrEqual (tag, (const xmlChar *)"safe") && type == XML_READER_TYPE_ELEMENT)
        {
            permission = EPHY_MIME_PERMISSION_SAFE;
        }
        else if (xmlStrEqual (tag, (const xmlChar *)"unsafe") && type == XML_READER_TYPE_ELEMENT)
        {
            permission = EPHY_MIME_PERMISSION_UNSAFE;
        }
        else if (xmlStrEqual (tag, (const xmlChar *)"mime-type"))
        {
            xmlChar *type;

            type = xmlTextReaderGetAttribute (reader, (const xmlChar *)"type");
            g_hash_table_insert (mime_table, type,
                         GINT_TO_POINTER (permission));
        }

        ret = xmlTextReaderRead (reader);
    }

    xmlFreeTextReader (reader);
}

/**
 * ephy_file_check_mime:
 * @mime_type: a mime type
 *
 * Checks @mime_type against our safe/unsafe database of types, returns an
 * #EphyMimePermission.
 *
 * Returns: an #EphyMimePermission
 **/
EphyMimePermission
ephy_file_check_mime (const char *mime_type)
{
    EphyMimePermission permission;
    gpointer tmp;

    g_return_val_if_fail (mime_type != NULL, EPHY_MIME_PERMISSION_UNKNOWN);

    if (mime_table == NULL)
    {
        load_mime_from_xml ();
    }

    tmp = g_hash_table_lookup (mime_table, mime_type);
    if (tmp == NULL)
    {
        permission = EPHY_MIME_PERMISSION_UNKNOWN;
    }
    else
    {
        permission = GPOINTER_TO_INT (tmp);
    }

    return permission;
}

/**
 * ephy_file_launch_application:
 * @app: the application to launch
 * @files: files to pass to @app
 * @user_time: user time to prevent focus stealing
 * @widget: a relevant widget from where to get the #GdkScreen and #GdkDisplay
 *
 * Launches @app to open @files. If @widget is set the screen and display from
 * it will be used to launch the application, otherwise the defaults will be
 * used.
 *
 * Returns: %TRUE if g_app_info_launch() succeeded
 **/
gboolean
ephy_file_launch_application (GAppInfo *app,
                  GList *files,
                  guint32 user_time,
                  GtkWidget *widget)
{
    GdkAppLaunchContext *context;
    GdkDisplay *display;
    GdkScreen *screen;
    gboolean res;

    if (widget)
    {
        display = gtk_widget_get_display (widget);
        screen = gtk_widget_get_screen (widget);
    }
    else
    {
        display = gdk_display_get_default ();
        screen = gdk_screen_get_default ();
    }

    context = gdk_display_get_app_launch_context (display);
    gdk_app_launch_context_set_screen (context, screen);
    gdk_app_launch_context_set_timestamp (context, user_time);

    res = g_app_info_launch (app, files,
                 G_APP_LAUNCH_CONTEXT (context), NULL);
    g_object_unref (context);

    return res;
}

/**
 * ephy_file_launch_desktop_file:
 * @filename: the path to the .desktop file
 * @parameter: path to an optional parameter file to pass to the application
 * @user_time: user time to prevent focus stealing
 * @widget: an optional widget for ephy_file_launch_application()
 *
 * Calls ephy_file_launch_application() for the application described by the
 * .desktop file @filename. Can pass @parameter as optional file arguments.
 *
 * Returns: %TRUE if the application launch was successful
 **/
gboolean
ephy_file_launch_desktop_file (const char *filename,
                   const char *parameter,
                   guint32 user_time,
                   GtkWidget *widget)
{
    GDesktopAppInfo *app;
    GFile *file = NULL;
    GList *list = NULL;
    gboolean ret;

    app = g_desktop_app_info_new (filename);
    if (parameter)
    {
        file = g_file_new_for_path (parameter);
        list = g_list_append (list, file);
    }
    
    ret = ephy_file_launch_application (G_APP_INFO (app), list, user_time, widget);
    g_list_free (list);
    if (file)
        g_object_unref (file);
    return ret;
}

/**
 * ephy_file_launch_handler:
 * @mime_type: the mime type of @file or %NULL
 * @file: a #GFile to pass as argument
 * @user_time: user time to prevent focus stealing
 *
 * Launches @file with its default handler application, if @mime_type is %NULL
 * then @file will be queried for its type.
 *
 * Returns: %TRUE on success
 **/
gboolean
ephy_file_launch_handler (const char *mime_type,
              GFile *file,
              guint32 user_time)
{
    GAppInfo *app = NULL;
    gboolean ret = FALSE;

    g_return_val_if_fail (file != NULL, FALSE);

    if (mime_type != NULL)
    {
        app = g_app_info_get_default_for_type (mime_type,
                               FALSE);
    }
    else
    {
        GFileInfo *file_info;
        char *type;

        /* Sniff mime type and check if it's safe to open */
        file_info = g_file_query_info (file,
                           G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
                           0, NULL, NULL);
        if (file_info == NULL) {
            return FALSE;
        }
        type = g_strdup (g_file_info_get_content_type (file_info));
        
        g_object_unref (file_info);

        if (type != NULL && type[0] != '\0' &&
            ephy_file_check_mime (type) == EPHY_MIME_PERMISSION_SAFE)
        {
            /* FIXME rename tmp file to right extension ? */
            app = g_app_info_get_default_for_type (type, FALSE);
        }
        g_free (type);
    }

    if (app != NULL)
    {
        GList *list = NULL;
        
        list = g_list_append (list, file);
        ret = ephy_file_launch_application (app, list, user_time, NULL);
        g_list_free (list);
    }
    else
        ret = FALSE;

    return ret;
}

/**
 * ephy_file_browse_to:
 * @file: a #GFile
 * @user_time: user_time to prevent focus stealing
 *
 * Launches the default application for browsing directories, with @file's
 * parent directory as its target. Passes @user_time to
 * ephy_file_launch_handler() to prevent focus stealing.
 *
 * Returns: %TRUE if the launch succeeded
 **/
gboolean
ephy_file_browse_to (GFile *file,
             guint32 user_time)
{
    return ephy_file_launch_handler ("inode/directory", file, user_time);
}

/**
 * ephy_file_delete_dir_recursively:
 * @directory: directory to remove
 * @error: location to set any #GError
 *
 * Remove @path and its contents. Like calling rm -rf @path.
 *
 * Returns: %TRUE if delete succeeded
 **/
gboolean
ephy_file_delete_dir_recursively (GFile *directory, GError **error)
{
    GFileEnumerator *children = NULL;
    GFileInfo *info;
    gboolean ret = FALSE;

    children = g_file_enumerate_children (directory,
                          "standard::name,standard::type",
                          0, NULL, error);
    if (children == NULL || error)
        goto out;

    info = g_file_enumerator_next_file (children, NULL, error);
    while (info || error) {
        GFile *child;
        const char *name;
        GFileType type;

        if (error)
            goto out;

        name = g_file_info_get_name (info);
        child = g_file_get_child (directory, name);
        type = g_file_info_get_file_type (info);

        LOG ("ephy-file-delete-dir: delete child %s", name);
        if (type == G_FILE_TYPE_DIRECTORY)
            ret = ephy_file_delete_dir_recursively (child, error);
        else if (type == G_FILE_TYPE_REGULAR)
            ret = g_file_delete (child, NULL, error);

        g_object_unref (info);

        if (!ret)
            goto out;

        info = g_file_enumerator_next_file (children, NULL, error);
    }

    ret = TRUE;

    LOG ("ephy-file-delete-dir: delete successful");
    g_file_delete (directory, NULL, error);

out:
    if (children)
        g_object_unref (children);

    return ret;
}

/**
 * ephy_file_delete_uri
 * @uri: URI of the file to be deleted
 *
 * Remove the given URI.
 */
void
ephy_file_delete_uri (const char *uri)
{
    GFile *file;
    gboolean ret;

    g_return_if_fail (uri);

    file = g_file_new_for_uri (uri);

    ret = g_file_delete (file, NULL, NULL);

    if (ret == TRUE)
    {
        LOG ("Deleted file at URI '%s'", uri);
    }
    else
    {
        LOG ("Couldn't file at URI '%s'", uri);
    }
    g_object_unref (file);
}

/**
 * ephy_file_create_data_uri_for_filename:
 * @filename: the filename of a local path
 * @mime_type: the MIME type of the filename, or %NULL
 *
 * Create a data uri using the contents of @filename.
 * If @mime_type is %NULL, the %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE
 * attribute of @filename will be used.
 *
 * Returns: a new allocated string containg the data uri, or %NULL if the
 *   data uri could not be created
 */
char *ephy_file_create_data_uri_for_filename (const char *filename,
                          const char *mime_type)
{
    gchar *data;
    gsize data_length;
    gchar *base64;
    gchar *uri = NULL;
    GFileInfo *file_info = NULL;

    g_return_val_if_fail (filename != NULL, NULL);

    if (!g_file_get_contents (filename, &data, &data_length, NULL))
        return NULL;

    base64 = g_base64_encode ((const guchar *)data, data_length);
    g_free (data);

    if (!mime_type) {
        GFile *file;

        file = g_file_new_for_path (filename);
        file_info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
                           G_FILE_QUERY_INFO_NONE, NULL, NULL);
        if (file_info)
            mime_type = g_file_info_get_content_type (file_info);

        g_object_unref (file);
    }

    if (mime_type)
        uri = g_strdup_printf ("data:%s;charset=utf8;base64,%s", mime_type, base64);
    g_free(base64);

    if (file_info)
        g_object_unref (file_info);

    return uri;
}