/*
* Viking - GPS data editor
* Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
- * Based on:
- * Copyright (C) 2003-2007, Leandro A. F. Pereira <leandro@linuxmag.com.br>
+ * Copyright (C) 2014, Rob Norris <rw_norris@hotmail.com>
*
* 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, version 2.
+ * 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
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
+ /*
+ * Dependencies must be just on Glib
+ * see ui_utils for thing that depend on Gtk
+ * see vikutils for things that further depend on other Viking types
+ */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
+#include <glib/gstdio.h>
#include <glib/gi18n.h>
#include <glib/gprintf.h>
+#include <gio/gio.h>
#include "util.h"
-#include "dialog.h"
+#include "globals.h"
+#include "fileutils.h"
-/*
#ifdef WINDOWS
#include <windows.h>
+#else
+#include <unistd.h>
#endif
-#ifndef WINDOWS
-static gboolean spawn_command_line_async(const gchar * cmd,
- const gchar * arg)
-{
- gchar *cmdline = NULL;
- gboolean status;
-
- cmdline = g_strdup_printf("%s '%s'", cmd, arg);
- g_debug("Running: %s", cmdline);
-
- status = g_spawn_command_line_async(cmdline, NULL);
-
- g_free(cmdline);
-
- return status;
-}
-#endif
-*/
-
-void open_url(GtkWindow *parent, const gchar * url)
+guint util_get_number_of_cpus ()
{
- GError *error = NULL;
- gtk_show_uri ( gtk_widget_get_screen (GTK_WIDGET(parent)), url, GDK_CURRENT_TIME, &error );
- if ( error ) {
- a_dialog_error_msg_extra ( parent, _("Could not launch web browser. %s"), error->message );
- g_error_free ( error );
- }
-}
-
-void new_email(GtkWindow *parent, const gchar * address)
-{
- gchar *uri = g_strdup_printf("mailto:%s", address);
- GError *error = NULL;
- gtk_show_uri ( gtk_widget_get_screen (GTK_WIDGET(parent)), uri, GDK_CURRENT_TIME, &error );
- if ( error ) {
- a_dialog_error_msg_extra ( parent, _("Could not create new email. %s"), error->message );
- g_error_free ( error );
- }
- /*
+#if GLIB_CHECK_VERSION (2, 36, 0)
+ return g_get_num_processors();
+#else
+ long nprocs = 1;
#ifdef WINDOWS
- ShellExecute(NULL, NULL, (char *) uri, NULL, ".\\", 0);
+ SYSTEM_INFO info;
+ GetSystemInfo(&info);
+ nprocs = info.dwNumberOfProcessors;
#else
- if (!spawn_command_line_async("xdg-email", uri))
- a_dialog_error_msg ( parent, _("Could not create new email.") );
+#ifdef _SC_NPROCESSORS_ONLN
+ nprocs = sysconf(_SC_NPROCESSORS_ONLN);
+ if (nprocs < 1)
+ nprocs = 1;
+#endif
+#endif
+ return nprocs;
#endif
- */
- g_free(uri);
- uri = NULL;
-}
-gchar *uri_escape(gchar *str)
-{
- gchar *esc_str = g_malloc(3*strlen(str));
- gchar *dst = esc_str;
- gchar *src;
-
- for (src = str; *src; src++) {
- if (*src == ' ')
- *dst++ = '+';
- else if (g_ascii_isalnum(*src))
- *dst++ = *src;
- else {
- g_sprintf(dst, "%%%02hhX", *src);
- dst += 3;
- }
- }
- *dst = '\0';
-
- return(esc_str);
-}
-
-
-GList * str_array_to_glist(gchar* data[])
-{
- GList *gl = NULL;
- gpointer * p;
- for (p = (gpointer)data; *p; p++)
- gl = g_list_prepend(gl, *p);
- return g_list_reverse(gl);
}
/**
// Remove newline from val and also any other whitespace
*key = g_strstrip ( *key );
*val = g_strstrip ( *val );
-
return TRUE;
}
+
+static GSList* deletion_list = NULL;
+
+/**
+ * util_add_to_deletion_list:
+ *
+ * Add a name of a file into the list that is to be deleted on program exit
+ * Normally this is for files that get used asynchronously,
+ * so we don't know when it's time to delete them - other than at this program's end
+ */
+void util_add_to_deletion_list ( const gchar* filename )
+{
+ deletion_list = g_slist_append ( deletion_list, g_strdup (filename) );
+}
+
+/**
+ * util_remove_all_in_deletion_list:
+ *
+ * Delete all the files in the deletion list
+ * This should only be called on program exit
+ */
+void util_remove_all_in_deletion_list ( void )
+{
+ while ( deletion_list )
+ {
+ if ( g_remove ( (const char*)deletion_list->data ) )
+ g_warning ( "%s: Failed to remove %s", __FUNCTION__, (char*)deletion_list->data );
+ g_free ( deletion_list->data );
+ deletion_list = g_slist_delete_link ( deletion_list, deletion_list );
+ }
+}
+
+/**
+ * Removes characters from a string, in place.
+ *
+ * @param string String to search.
+ * @param chars Characters to remove.
+ *
+ * @return @a string - return value is only useful when nesting function calls, e.g.:
+ * @code str = utils_str_remove_chars(g_strdup("f_o_o"), "_"); @endcode
+ *
+ * @see @c g_strdelimit.
+ **/
+gchar *util_str_remove_chars(gchar *string, const gchar *chars)
+{
+ const gchar *r;
+ gchar *w = string;
+
+ g_return_val_if_fail(string, NULL);
+ if (G_UNLIKELY(EMPTY(chars)))
+ return string;
+
+ foreach_str(r, string)
+ {
+ if (!strchr(chars, *r))
+ *w++ = *r;
+ }
+ *w = 0x0;
+ return string;
+}
+
+/**
+ * In 'extreme' debug mode don't remove temporary files
+ * thus the contents can be inspected if things go wrong
+ * with the trade off the user may need to delete tmp files manually
+ * Only use this for 'occasional' downloaded temporary files that need interpretation,
+ * rather than large volume items such as Bing attributions.
+ */
+int util_remove ( const gchar *filename )
+{
+ if ( vik_debug && vik_verbose ) {
+ g_warning ( "Not removing file: %s", filename );
+ return 0;
+ }
+ else
+ return g_remove ( filename );
+}
+
+/**
+ * Stream write buffer to a temporary file (in one go)
+ *
+ * @param buffer The buffer to write
+ * @param count Size of the buffer to write
+ *
+ * @return the filename of the buffer that was written
+ */
+gchar* util_write_tmp_file_from_bytes ( const void *buffer, gsize count )
+{
+ GFileIOStream *gios;
+ GError *error = NULL;
+ gchar *tmpname = NULL;
+
+#if GLIB_CHECK_VERSION(2,32,0)
+ GFile *gf = g_file_new_tmp ( "vik-tmp.XXXXXX", &gios, &error );
+ tmpname = g_file_get_path (gf);
+#else
+ gint fd = g_file_open_tmp ( "vik-tmp.XXXXXX", &tmpname, &error );
+ if ( error ) {
+ g_warning ( "%s", error->message );
+ g_error_free ( error );
+ return NULL;
+ }
+ gios = g_file_open_readwrite ( g_file_new_for_path (tmpname), NULL, &error );
+ if ( error ) {
+ g_warning ( "%s", error->message );
+ g_error_free ( error );
+ return NULL;
+ }
+#endif
+
+ gios = g_file_open_readwrite ( g_file_new_for_path (tmpname), NULL, &error );
+ if ( error ) {
+ g_warning ( "%s", error->message );
+ g_error_free ( error );
+ return NULL;
+ }
+
+ GOutputStream *gos = g_io_stream_get_output_stream ( G_IO_STREAM(gios) );
+ if ( g_output_stream_write ( gos, buffer, count, NULL, &error ) < 0 ) {
+ g_critical ( "Couldn't write tmp %s file due to %s", tmpname, error->message );
+ g_free (tmpname);
+ tmpname = NULL;
+ }
+
+ g_output_stream_close ( gos, NULL, &error );
+ g_object_unref ( gios );
+
+ return tmpname;
+}
+
+/**
+ * util_make_absolute_filename:
+ *
+ * Returns a newly allocated string of the absolute filename or
+ * NULL if name is already absolute (or dirpath is unusable)
+ */
+gchar* util_make_absolute_filename ( const gchar *filename, const gchar *dirpath )
+{
+ if ( !dirpath ) return NULL;
+
+ // Is it ready absolute?
+ if ( g_path_is_absolute ( filename ) ) {
+ return NULL;
+ }
+ else {
+ // Otherwise create the absolute filename from the given directory and filename
+ gchar *full = g_strconcat ( dirpath, G_DIR_SEPARATOR_S, filename, NULL );
+ gchar *absolute = file_realpath_dup ( full ); // resolved into the canonical name
+ g_free ( full );
+ return absolute;
+ }
+}
+
+/**
+ * util_make_absolute_filenames:
+ *
+ * Ensures the supplied list of filenames are all absolute
+ */
+void util_make_absolute_filenames ( GList *filenames, const gchar *dirpath )
+{
+ if ( !filenames ) return;
+ if ( !dirpath ) return;
+
+ GList *gl;
+ foreach_list ( gl, filenames ) {
+ gchar *fn = util_make_absolute_filename ( gl->data, dirpath );
+ if ( fn ) {
+ g_free ( gl->data );
+ gl->data = fn;
+ }
+ }
+}