ev-file-helpers.h File Reference

#include <glib.h>
#include <gio/gio.h>

Include dependency graph for ev-file-helpers.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	EvCompressionType { EV_COMPRESSION_NONE, EV_COMPRESSION_BZIP2, EV_COMPRESSION_GZIP, EV_COMPRESSION_LZMA }

Functions
void	_ev_file_helpers_init (void)
void	_ev_file_helpers_shutdown (void)
int	ev_mkstemp (const char *tmpl, char **file_name, GError **error)
GFile *	ev_mkstemp_file (const char *tmpl, GError **error)
gchar *	ev_mkdtemp (const char *tmpl, GError **error)
void	ev_tmp_filename_unlink (const gchar *filename)
void	ev_tmp_file_unlink (GFile *file)
void	ev_tmp_uri_unlink (const gchar *uri)
gboolean	ev_file_is_temp (GFile *file)
gboolean	ev_xfer_uri_simple (const char *from, const char *to, GError **error)
gboolean	ev_file_copy_metadata (const char *from, const char *to, GError **error)
gchar *	ev_file_get_mime_type (const gchar *uri, gboolean fast, GError **error)
gchar *	ev_file_uncompress (const gchar *uri, EvCompressionType type, GError **error)
gchar *	ev_file_compress (const gchar *uri, EvCompressionType type, GError **error)

Enumeration Type Documentation

enum EvCompressionType

Enumerator
EV_COMPRESSION_NONE
EV_COMPRESSION_BZIP2
EV_COMPRESSION_GZIP
EV_COMPRESSION_LZMA

Definition at line 32 of file ev-file-helpers.h.

             {
    EV_COMPRESSION_NONE,
    EV_COMPRESSION_BZIP2,
    EV_COMPRESSION_GZIP,
        EV_COMPRESSION_LZMA
} EvCompressionType;

Function Documentation

void _ev_file_helpers_init

(

void

)

Definition at line 103 of file ev-file-helpers.c.

{
}

Here is the caller graph for this function:

void _ev_file_helpers_shutdown

(

void

)

Definition at line 108 of file ev-file-helpers.c.

{   
    if (tmp_dir != NULL)    
        g_rmdir (tmp_dir);

    g_free (tmp_dir);
    tmp_dir = NULL;
}

Here is the caller graph for this function:

gchar* ev_file_compress	(	const gchar *	uri,
		EvCompressionType	type,
		GError **	error
	)

ev_file_compress: : a file URI : the compression type : a #GError location to store an error, or NULL

Compresses the file at .

If is EV_COMPRESSION_NONE, it does nothing and returns NULL.

Otherwise, it returns the filename of a temporary file containing the compressed data from the file at .

On error it returns NULL and fills in .

It is the caller's responsibility to unlink the temp file after use.

Returns: a newly allocated string URI, or NULL on error

Definition at line 735 of file ev-file-helpers.c.

{
    g_return_val_if_fail (uri != NULL, NULL);

    return compression_run (uri, type, TRUE, error);
}

Here is the caller graph for this function:

gboolean ev_file_copy_metadata	(	const char *	from,
		const char *	to,
		GError **	error
	)

ev_file_copy_metadata: : the source URI : the target URI : a #GError location to store an error, or NULL

Performs a g_file_copy_attributes() with G_FILE_COPY_ALL_METADATA from to .

Returns: TRUE if the attributes were copied successfully, FALSE otherwise.

Since: 3.4

Definition at line 444 of file ev-file-helpers.c.

{
        GFile *source_file;
        GFile *target_file;
        gboolean result;

        g_return_val_if_fail (from != NULL, FALSE);
        g_return_val_if_fail (to != NULL, FALSE);

        source_file = g_file_new_for_uri (from);
        target_file = g_file_new_for_uri (to);

        result = g_file_copy_attributes (source_file, target_file,
                                         G_FILE_COPY_ALL_METADATA |
                                         G_FILE_COPY_TARGET_DEFAULT_PERMS,
                                         NULL, error);

        g_object_unref (target_file);
        g_object_unref (source_file);

        return result;
}

Here is the caller graph for this function:

gchar* ev_file_get_mime_type	(	const gchar *	uri,
		gboolean	fast,
		GError **	error
	)

ev_file_get_mime_type: : the URI : whether to use fast MIME type detection : a #GError location to store an error, or NULL

Returns: a newly allocated string with the MIME type of the file at , or NULL on error or if the MIME type could not be determined

Definition at line 573 of file ev-file-helpers.c.

{
    return fast ? get_mime_type_from_uri (uri, error) : get_mime_type_from_data (uri, error);
}

Here is the caller graph for this function:

gboolean ev_file_is_temp

(

GFile *

file)

Definition at line 374 of file ev-file-helpers.c.

{
    gchar   *path;
    gboolean retval;

    if (!g_file_is_native (file))
        return FALSE;

    path = g_file_get_path (file);
    if (!path)
        return FALSE;

    retval = g_str_has_prefix (path, g_get_tmp_dir ());
    g_free (path);

    return retval;
}

Here is the caller graph for this function:

gchar* ev_file_uncompress	(	const gchar *	uri,
		EvCompressionType	type,
		GError **	error
	)

ev_file_uncompress: : a file URI : the compression type : a #GError location to store an error, or NULL

Uncompresses the file at .

If is EV_COMPRESSION_NONE, it does nothing and returns NULL.

Otherwise, it returns the filename of a temporary file containing the decompressed data from the file at . On error it returns NULL and fills in .

It is the caller's responsibility to unlink the temp file after use.

Returns: a newly allocated string URI, or NULL on error

Definition at line 706 of file ev-file-helpers.c.

{
    g_return_val_if_fail (uri != NULL, NULL);

    return compression_run (uri, type, FALSE, error);
}

Here is the caller graph for this function:

gchar* ev_mkdtemp	(	const char *	tmpl,
		GError **	error
	)

ev_mkdtemp: : a template string; must end in 'XXXXXX' : a location to store a #GError

Creates a temp directory in the evince temp directory.

Returns: a newly allocated string with the temp directory name, or NULL on error with filled in

Definition at line 295 of file ev-file-helpers.c.

{
        const char *tmp;
        char *name;

        if ((tmp = _ev_tmp_dir (error)) == NULL)
              return NULL;

        name = g_build_filename (tmp, tmpl, NULL);
        if (_ev_g_mkdtemp (name) == NULL) {
        int errsv = errno;

                g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
                             _("Failed to create a temporary directory: %s"),
                             g_strerror (errsv));

                g_free (name);
                return NULL;
        }

        return name;
}

int ev_mkstemp	(	const char *	tmpl,
		char **	file_name,
		GError **	error
	)

ev_mkstemp: : a template string; must contain 'XXXXXX', but not necessarily as a suffix : a location to store the filename of the temp file : a location to store a #GError

Creates a temp file in the evince temp directory.

Returns: a file descriptor to the newly created temp file name, or %-1 on error with filled in

Definition at line 129 of file ev-file-helpers.c.

{
        const char *tmp;
        char *name;
        int fd;

        if ((tmp = _ev_tmp_dir (error)) == NULL)
              return -1;

        name = g_build_filename (tmp, tmpl, NULL);
        fd = g_mkstemp (name);

        if (fd == -1) {
        int errsv = errno;

                g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
                             _("Failed to create a temporary file: %s"),
                             g_strerror (errsv));

                g_free (name);
                return -1;
        }

        if (file_name)
                *file_name = name;

        return fd;
}

Here is the caller graph for this function:

GFile* ev_mkstemp_file	(	const char *	tmpl,
		GError **	error
	)

ev_mkstemp_file: : a template string; must contain 'XXXXXX', but not necessarily as a suffix : a location to store a #GError

Creates a temp #GFile in the evince temp directory. See ev_mkstemp() for more information.

Returns: (transfer full): a newly allocated #GFile for the newly created temp file name, or NULL on error with filled in

Definition at line 179 of file ev-file-helpers.c.

{
        char *file_name;
        int fd;
        GFile *file;

        fd = ev_mkstemp (tmpl, &file_name, error);
        if (fd == -1)
                return NULL;

        file = g_file_new_for_path (file_name);
        g_free (file_name);

        g_object_set_data_full (G_OBJECT (file), "ev-mkstemp-fd",
                                GINT_TO_POINTER (fd), (GDestroyNotify) close_fd_cb);

        return file;
}

Here is the caller graph for this function:

void ev_tmp_file_unlink

(

GFile *

file)

Definition at line 335 of file ev-file-helpers.c.

{
    gboolean res;
    GError  *error = NULL;

    if (!file)
        return;
    
    res = g_file_delete (file, NULL, &error);
    if (!res) {
        char *uri;
        
        uri = g_file_get_uri (file);
        g_warning ("Unable to delete temp file %s: %s\n", uri, error->message);
        g_free (uri);
        g_error_free (error);
    }
}

Here is the caller graph for this function:

void ev_tmp_filename_unlink

(

const gchar *

filename)

Definition at line 321 of file ev-file-helpers.c.

{
    if (!filename)
        return;

    if (!tmp_dir)
        return;

    if (g_str_has_prefix (filename, tmp_dir)) {
        g_unlink (filename);
    }
}

Here is the caller graph for this function:

void ev_tmp_uri_unlink

(

const gchar *

uri)

Definition at line 355 of file ev-file-helpers.c.

{
    GFile *file;
    
    if (!uri)
        return;
    
    file = g_file_new_for_uri (uri);
    if (!g_file_is_native (file)) {
        g_warning ("Attempting to delete non native uri: %s\n", uri);
        g_object_unref (file);
        return;
    }
    
    ev_tmp_file_unlink (file);
    g_object_unref (file);
}

Here is the caller graph for this function:

gboolean ev_xfer_uri_simple	(	const char *	from,
		const char *	to,
		GError **	error
	)

ev_xfer_uri_simple: : the source URI : the target URI : a #GError location to store an error, or NULL

Performs a g_file_copy() from to .

Returns: TRUE on success, or FALSE on error with filled in

Definition at line 403 of file ev-file-helpers.c.

{
    GFile *source_file;
    GFile *target_file;
    gboolean result;
    
    if (!from)
        return TRUE;

        g_return_val_if_fail (to != NULL, TRUE);

    source_file = g_file_new_for_uri (from);
    target_file = g_file_new_for_uri (to);
    
    result = g_file_copy (source_file, target_file,
                  G_FILE_COPY_TARGET_DEFAULT_PERMS |
                  G_FILE_COPY_OVERWRITE,
                  NULL, NULL, NULL, error);

    g_object_unref (target_file);
    g_object_unref (source_file);
    
    return result;
}

Here is the caller graph for this function: