transmission/gtk/util.c

/*
 * This file Copyright (C) Mnemosyne LLC
 *
 * This file is licensed by the GPL version 2. Works owned by the
 * Transmission project are granted a special exemption to clause 2 (b)
 * so that the bulk of its code can remain under the MIT license.
 * This exemption does not extend to derived works not owned by
 * the Transmission project.
 *
 * $Id$
 */

#include <ctype.h> /* isxdigit () */
#include <errno.h>
#include <stdarg.h>
#include <string.h> /* strchr (), strrchr (), strlen (), strstr () */

#include <gtk/gtk.h>
#include <glib/gi18n.h>
#include <glib/gstdio.h> /* g_unlink () */
#include <gio/gio.h> /* g_file_trash () */

#include <libtransmission/transmission.h> /* TR_RATIO_NA, TR_RATIO_INF */
#include <libtransmission/utils.h> /* tr_strratio () */
#include <libtransmission/web.h> /* tr_webResponseStr () */
#include <libtransmission/version.h> /* SHORT_VERSION_STRING */

#include "conf.h"
#include "hig.h"
#include "tr-prefs.h"
#include "util.h"

/***
****  UNITS
***/

const int mem_K = 1024;
const char * mem_K_str = N_("KiB");
const char * mem_M_str = N_("MiB");
const char * mem_G_str = N_("GiB");
const char * mem_T_str = N_("TiB");

const int disk_K = 1000;
const char * disk_K_str = N_("kB");
const char * disk_M_str = N_("MB");
const char * disk_G_str = N_("GB");
const char * disk_T_str = N_("TB");

const int speed_K = 1000;
const char * speed_K_str = N_("kB/s");
const char * speed_M_str = N_("MB/s");
const char * speed_G_str = N_("GB/s");
const char * speed_T_str = N_("TB/s");

/***
****
***/

const char*
gtr_get_unicode_string (int i)
{
    switch (i) {
        case GTR_UNICODE_UP:      return "\xE2\x86\x91";
        case GTR_UNICODE_DOWN:    return "\xE2\x86\x93";
        case GTR_UNICODE_INF:     return "\xE2\x88\x9E";
        case GTR_UNICODE_BULLET:  return "\xE2\x88\x99";
        default:                  return "err";
    }
}

char*
tr_strlratio (char * buf, double ratio, size_t buflen)
{
    return tr_strratio (buf, buflen, ratio, gtr_get_unicode_string (GTR_UNICODE_INF));
}

char*
tr_strlpercent (char * buf, double x, size_t buflen)
{
    return tr_strpercent (buf, x, buflen);
}

char*
tr_strlsize (char * buf, guint64 bytes, size_t buflen)
{
    if (!bytes)
        g_strlcpy (buf, Q_("None"), buflen);
    else
        tr_formatter_size_B (buf, bytes, buflen);

    return buf;
}

char*
tr_strltime (char * buf, int seconds, size_t buflen)
{
    int  days, hours, minutes;
    char d[128], h[128], m[128], s[128];

    if (seconds < 0)
        seconds = 0;

    days = seconds / 86400;
    hours = (seconds % 86400) / 3600;
    minutes = (seconds % 3600) / 60;
    seconds = (seconds % 3600) % 60;

    g_snprintf (d, sizeof (d), ngettext ("%'d day", "%'d days", days), days);
    g_snprintf (h, sizeof (h), ngettext ("%'d hour", "%'d hours", hours), hours);
    g_snprintf (m, sizeof (m), ngettext ("%'d minute", "%'d minutes", minutes), minutes);
    g_snprintf (s, sizeof (s), ngettext ("%'d second", "%'d seconds", seconds), seconds);

    if (days)
    {
        if (days >= 4 || !hours)
            g_strlcpy (buf, d, buflen);
        else
            g_snprintf (buf, buflen, "%s, %s", d, h);
    }
    else if (hours)
    {
        if (hours >= 4 || !minutes)
            g_strlcpy (buf, h, buflen);
        else
            g_snprintf (buf, buflen, "%s, %s", h, m);
    }
    else if (minutes)
    {
        if (minutes >= 4 || !seconds)
            g_strlcpy (buf, m, buflen);
        else
            g_snprintf (buf, buflen, "%s, %s", m, s);
    }
    else
    {
        g_strlcpy (buf, s, buflen);
    }

    return buf;
}

/* pattern-matching text; ie, legaltorrents.com */
void
gtr_get_host_from_url (char * buf, size_t buflen, const char * url)
{
    char host[1024];
    const char * pch;

    if ((pch = strstr (url, "://"))) {
        const size_t hostlen = strcspn (pch+3, ":/");
        const size_t copylen = MIN (hostlen, sizeof (host)-1);
        memcpy (host, pch+3, copylen);
        host[copylen] = '\0';
    } else {
        *host = '\0';
    }

    if (tr_addressIsIP (host))
        g_strlcpy (buf, url, buflen);
    else {
        const char * first_dot = strchr (host, '.');
        const char * last_dot = strrchr (host, '.');
        if ((first_dot) && (last_dot) && (first_dot != last_dot))
            g_strlcpy (buf, first_dot + 1, buflen);
        else
            g_strlcpy (buf, host, buflen);
    }
}

static gboolean
gtr_is_supported_url (const char * str)
{
    return ((str != NULL) &&
           (g_str_has_prefix (str, "ftp://") ||
               g_str_has_prefix (str, "http://") ||
               g_str_has_prefix (str, "https://")));
}

gboolean
gtr_is_magnet_link (const char * str)
{
    return (str != NULL) &&
         (g_str_has_prefix (str, "magnet:?"));
}

gboolean
gtr_is_hex_hashcode (const char * str)
{
    int i;

    if (!str || (strlen (str) != 40))
        return FALSE;

    for (i=0; i<40; ++i)
        if (!isxdigit (str[i]))
            return FALSE;

    return TRUE;
}

static GtkWindow *
getWindow (GtkWidget * w)
{
    if (w == NULL)
        return NULL;

    if (GTK_IS_WINDOW (w))
        return GTK_WINDOW (w);

    return GTK_WINDOW (gtk_widget_get_ancestor (w, GTK_TYPE_WINDOW));
}

void
gtr_add_torrent_error_dialog (GtkWidget * child, int err, const char * file)
{
    char * secondary;
    const char * fmt;
    GtkWidget * w;
    GtkWindow * win = getWindow (child);

    switch (err)
    {
        case TR_PARSE_ERR: fmt = _("The torrent file \"%s\" contains invalid data."); break;
        case TR_PARSE_DUPLICATE: fmt = _("The torrent file \"%s\" is already in use."); break;
        default: fmt = _("The torrent file \"%s\" encountered an unknown error."); break;
    }
    secondary = g_strdup_printf (fmt, file);

    w = gtk_message_dialog_new (win,
                                GTK_DIALOG_DESTROY_WITH_PARENT,
                                GTK_MESSAGE_ERROR,
                                GTK_BUTTONS_CLOSE,
                                "%s", _("Error opening torrent"));
    gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (w),
                                              "%s", secondary);
    g_signal_connect_swapped (w, "response",
                              G_CALLBACK (gtk_widget_destroy), w);
    gtk_widget_show_all (w);
    g_free (secondary);
}

typedef void (PopupFunc)(GtkWidget*, GdkEventButton*);

/* pop up the context menu if a user right-clicks.
   if the row they right-click on isn't selected, select it. */

gboolean
on_tree_view_button_pressed (GtkWidget *      view,
                             GdkEventButton * event,
                             gpointer         func)
{
    GtkTreeView * tv = GTK_TREE_VIEW (view);

    if (event->type == GDK_BUTTON_PRESS  &&  event->button == 3)
    {
        GtkTreeSelection * selection = gtk_tree_view_get_selection (tv);
        GtkTreePath *      path;
        if (gtk_tree_view_get_path_at_pos (tv,
                                          (gint) event->x,
                                          (gint) event->y,
                                            &path, NULL, NULL, NULL))
        {
            if (!gtk_tree_selection_path_is_selected (selection, path))
            {
                gtk_tree_selection_unselect_all (selection);
                gtk_tree_selection_select_path (selection, path);
            }
            gtk_tree_path_free (path);
        }

        if (func != NULL)
          ((PopupFunc*)func)(view, event);

        return TRUE;
    }

    return FALSE;
}

/* if the user clicked in an empty area of the list,
 * clear all the selections. */
gboolean
on_tree_view_button_released (GtkWidget *      view,
                              GdkEventButton * event,
                              gpointer         unused UNUSED)
{
    GtkTreeView * tv = GTK_TREE_VIEW (view);

    if (!gtk_tree_view_get_path_at_pos (tv,
                                       (gint) event->x,
                                       (gint) event->y,
                                         NULL, NULL, NULL, NULL))
    {
        GtkTreeSelection * selection = gtk_tree_view_get_selection (tv);
        gtk_tree_selection_unselect_all (selection);
    }

    return FALSE;
}

int
gtr_file_trash_or_remove (const char * filename)
{
    GFile * file;
    gboolean trashed = FALSE;

    g_return_val_if_fail (filename && *filename, 0);

    file = g_file_new_for_path (filename);

    if (gtr_pref_flag_get (PREF_KEY_TRASH_CAN_ENABLED)) {
        GError * err = NULL;
        trashed = g_file_trash (file, NULL, &err);
        if (err) {
            g_message ("Unable to trash file \"%s\": %s", filename, err->message);
            g_clear_error (&err);
        }
    }

    if (!trashed) {
        GError * err = NULL;
        g_file_delete (file, NULL, &err);
        if (err) {
            g_message ("Unable to delete file \"%s\": %s", filename, err->message);
            g_clear_error (&err);
        }
    }

    g_object_unref (G_OBJECT (file));
    return 0;
}

const char*
gtr_get_help_uri (void)
{
    static char * uri = NULL;

    if (!uri)
    {
        int major, minor;
        const char * fmt = "http://www.transmissionbt.com/help/gtk/%d.%dx";
        sscanf (SHORT_VERSION_STRING, "%d.%d", &major, &minor);
        uri = g_strdup_printf (fmt, major, minor / 10);
    }

    return uri;
}

void
gtr_open_file (const char * path)
{
    char * uri;

    GFile * file = g_file_new_for_path (path);
    g_object_unref (G_OBJECT (file));

    if (g_path_is_absolute (path))
        uri = g_strdup_printf ("file://%s", path);
    else {
        char * cwd = g_get_current_dir ();
        uri = g_strdup_printf ("file://%s/%s", cwd, path);
        g_free (cwd);
    }

    gtr_open_uri (uri);
    g_free (uri);
}

void
gtr_open_uri (const char * uri)
{
    if (uri)
    {
        gboolean opened = FALSE;

        if (!opened)
            opened = gtk_show_uri (NULL, uri, GDK_CURRENT_TIME, NULL);

        if (!opened)
            opened = g_app_info_launch_default_for_uri (uri, NULL, NULL);

        if (!opened) {
            char * argv[] = { (char*)"xdg-open", (char*)uri, NULL };
            opened = g_spawn_async (NULL, argv, NULL, G_SPAWN_SEARCH_PATH,
                                    NULL, NULL, NULL, NULL);
        }

        if (!opened)
            g_message ("Unable to open \"%s\"", uri);
    }
}

/***
****
***/

void
gtr_combo_box_set_active_enum (GtkComboBox * combo_box, int value)
{
    int i;
    int currentValue;
    const int column = 0;
    GtkTreeIter iter;
    GtkTreeModel * model = gtk_combo_box_get_model (combo_box);

    /* do the value and current value match? */
    if (gtk_combo_box_get_active_iter (combo_box, &iter)) {
        gtk_tree_model_get (model, &iter, column, &currentValue, -1);
        if (currentValue == value)
            return;
    }

    /* find the one to select */
    i = 0;
    while ((gtk_tree_model_iter_nth_child (model, &iter, NULL, i++))) {
        gtk_tree_model_get (model, &iter, column, &currentValue, -1);
        if (currentValue == value) {
            gtk_combo_box_set_active_iter (combo_box, &iter);
            return;
        }
    }
}


GtkWidget *
gtr_combo_box_new_enum (const char * text_1, ...)
{
    GtkWidget * w;
    GtkCellRenderer * r;
    GtkListStore * store;
    va_list vl;
    const char * text;
    va_start (vl, text_1);

    store = gtk_list_store_new (2, G_TYPE_INT, G_TYPE_STRING);

    text = text_1;
    if (text != NULL) do
    {
        const int val = va_arg (vl, int);
        gtk_list_store_insert_with_values (store, NULL, INT_MAX, 0, val, 1, text, -1);
        text = va_arg (vl, const char *);
    }
    while (text != NULL);

    w = gtk_combo_box_new_with_model (GTK_TREE_MODEL (store));
    r = gtk_cell_renderer_text_new ();
    gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (w), r, TRUE);
    gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (w), r, "text", 1, NULL);

    /* cleanup */
    g_object_unref (store);
    return w;
}

int
gtr_combo_box_get_active_enum (GtkComboBox * combo_box)
{
    int value = 0;
    GtkTreeIter iter;

    if (gtk_combo_box_get_active_iter (combo_box, &iter))
        gtk_tree_model_get (gtk_combo_box_get_model (combo_box), &iter, 0, &value, -1);

    return value;
}

GtkWidget *
gtr_priority_combo_new (void)
{
    return gtr_combo_box_new_enum (_("High"),   TR_PRI_HIGH,
                                   _("Normal"), TR_PRI_NORMAL,
                                   _("Low"),    TR_PRI_LOW,
                                   NULL);
}

/***
****
***/

#define GTR_CHILD_HIDDEN "gtr-child-hidden"

void
gtr_widget_set_visible (GtkWidget * w, gboolean b)
{
    /* toggle the transient children, too */
    if (GTK_IS_WINDOW (w))
    {
        GList * l;
        GList * windows = gtk_window_list_toplevels ();
        GtkWindow * window = GTK_WINDOW (w);

        for (l=windows; l!=NULL; l=l->next)
        {
            if (!GTK_IS_WINDOW (l->data))
                continue;
            if (gtk_window_get_transient_for (GTK_WINDOW (l->data)) != window)
                continue;
            if (gtk_widget_get_visible (GTK_WIDGET (l->data)) == b)
                continue;

            if (b && g_object_get_data (G_OBJECT (l->data), GTR_CHILD_HIDDEN) != NULL)
            {
                g_object_steal_data (G_OBJECT (l->data), GTR_CHILD_HIDDEN);
                gtr_widget_set_visible (GTK_WIDGET (l->data), TRUE);
            }
            else if (!b)
            {
                g_object_set_data (G_OBJECT (l->data), GTR_CHILD_HIDDEN, GINT_TO_POINTER (1));
                gtr_widget_set_visible (GTK_WIDGET (l->data), FALSE);
            }
        }

        g_list_free (windows);
    }

    gtk_widget_set_visible (w, b);
}

void
gtr_dialog_set_content (GtkDialog * dialog, GtkWidget * content)
{
    GtkWidget * vbox = gtk_dialog_get_content_area (dialog);
    gtk_box_pack_start (GTK_BOX (vbox), content, TRUE, TRUE, 0);
    gtk_widget_show_all (content);
}

/***
****
***/

void
gtr_http_failure_dialog (GtkWidget * parent, const char * url, long response_code)
{
    GtkWindow * window = getWindow (parent);

    GtkWidget * w = gtk_message_dialog_new (window, 0,
                                            GTK_MESSAGE_ERROR,
                                            GTK_BUTTONS_CLOSE,
                                            _("Error opening \"%s\""), url);

    gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (w),
                                              _("Server returned \"%1$ld %2$s\""),
                                              response_code,
                                              tr_webGetResponseStr (response_code));

    g_signal_connect_swapped (w, "response", G_CALLBACK (gtk_widget_destroy), w);
    gtk_widget_show (w);
}

void
gtr_unrecognized_url_dialog (GtkWidget * parent, const char * url)
{
    const char * xt = "xt=urn:btih";

    GtkWindow * window = getWindow (parent);

    GString * gstr = g_string_new (NULL);

    GtkWidget * w = gtk_message_dialog_new (window, 0,
                                            GTK_MESSAGE_ERROR,
                                            GTK_BUTTONS_CLOSE,
                                            "%s", _("Unrecognized URL"));

    g_string_append_printf (gstr, _("Transmission doesn't know how to use \"%s\""), url);

    if (gtr_is_magnet_link (url) && (strstr (url, xt) == NULL))
    {
        g_string_append_printf (gstr, "\n \n");
        g_string_append_printf (gstr, _("This magnet link appears to be intended for something other than BitTorrent. BitTorrent magnet links have a section containing \"%s\"."), xt);
    }

    gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (w), "%s", gstr->str);
    g_signal_connect_swapped (w, "response", G_CALLBACK (gtk_widget_destroy), w);
    gtk_widget_show (w);
    g_string_free (gstr, TRUE);
}

/***
****
***/

void
gtr_paste_clipboard_url_into_entry (GtkWidget * e)
{
  size_t i;

  char * text[] = {
    g_strstrip (gtk_clipboard_wait_for_text (gtk_clipboard_get (GDK_SELECTION_PRIMARY))),
    g_strstrip (gtk_clipboard_wait_for_text (gtk_clipboard_get (GDK_SELECTION_CLIPBOARD)))
  };

  for (i=0; i<G_N_ELEMENTS (text); ++i) {
      char * s = text[i];
      if (s && (gtr_is_supported_url (s) || gtr_is_magnet_link (s)
                                           || gtr_is_hex_hashcode (s))) {
          gtk_entry_set_text (GTK_ENTRY (e), s);
          break;
      }
  }

  for (i=0; i<G_N_ELEMENTS (text); ++i)
    g_free (text[i]);
}

/***
****
***/

void
gtr_label_set_text (GtkLabel * lb, const char * newstr)
{
    const char * oldstr = gtk_label_get_text (lb);

    if (tr_strcmp0 (oldstr, newstr))
        gtk_label_set_text (lb, newstr);
}