source: trunk/gtk/util.c @ 14526

Last change on this file since 14526 was 14526, checked in by mikedld, 6 years ago

Fix some issues revealed by coverity

  • Property svn:keywords set to Date Rev Author Id
File size: 18.4 KB
Line 
1/*
2 * This file Copyright (C) 2008-2014 Mnemosyne LLC
3 *
4 * It may be used under the GNU GPL versions 2 or 3
5 * or any future license endorsed by Mnemosyne LLC.
6 *
7 * $Id: util.c 14526 2015-05-09 11:56:35Z mikedld $
8 */
9
10#include <ctype.h> /* isxdigit () */
11#include <errno.h>
12#include <limits.h> /* INT_MAX */
13#include <stdarg.h>
14#include <string.h> /* strchr (), strrchr (), strlen (), strstr () */
15
16#include <gtk/gtk.h>
17#include <glib/gi18n.h>
18#include <gio/gio.h> /* g_file_trash () */
19
20#include <libtransmission/transmission.h> /* TR_RATIO_NA, TR_RATIO_INF */
21#include <libtransmission/utils.h> /* tr_strratio () */
22#include <libtransmission/web.h> /* tr_webResponseStr () */
23#include <libtransmission/version.h> /* SHORT_VERSION_STRING */
24
25#include "conf.h"
26#include "hig.h"
27#include "tr-core.h"
28#include "tr-prefs.h"
29#include "util.h"
30
31/***
32****  UNITS
33***/
34
35const int mem_K = 1024;
36const char * mem_K_str = N_("KiB");
37const char * mem_M_str = N_("MiB");
38const char * mem_G_str = N_("GiB");
39const char * mem_T_str = N_("TiB");
40
41const int disk_K = 1000;
42const char * disk_K_str = N_("kB");
43const char * disk_M_str = N_("MB");
44const char * disk_G_str = N_("GB");
45const char * disk_T_str = N_("TB");
46
47const int speed_K = 1000;
48const char * speed_K_str = N_("kB/s");
49const char * speed_M_str = N_("MB/s");
50const char * speed_G_str = N_("GB/s");
51const char * speed_T_str = N_("TB/s");
52
53/***
54****
55***/
56
57const char*
58gtr_get_unicode_string (int i)
59{
60  switch (i)
61    {
62      case GTR_UNICODE_UP:      return "\xE2\x96\xB4";
63      case GTR_UNICODE_DOWN:    return "\xE2\x96\xBE";
64      case GTR_UNICODE_INF:     return "\xE2\x88\x9E";
65      case GTR_UNICODE_BULLET:  return "\xE2\x88\x99";
66      default:                  return "err";
67    }
68}
69
70char*
71tr_strlratio (char * buf, double ratio, size_t buflen)
72{
73  return tr_strratio (buf, buflen, ratio, gtr_get_unicode_string (GTR_UNICODE_INF));
74}
75
76char*
77tr_strlpercent (char * buf, double x, size_t buflen)
78{
79  return tr_strpercent (buf, x, buflen);
80}
81
82char*
83tr_strlsize (char * buf, guint64 bytes, size_t buflen)
84{
85  if (!bytes)
86    g_strlcpy (buf, Q_("None"), buflen);
87  else
88    tr_formatter_size_B (buf, bytes, buflen);
89
90  return buf;
91}
92
93char*
94tr_strltime (char * buf, int seconds, size_t buflen)
95{
96  int days, hours, minutes;
97  char d[128], h[128], m[128], s[128];
98
99  if (seconds < 0)
100    seconds = 0;
101
102  days = seconds / 86400;
103  hours = (seconds % 86400) / 3600;
104  minutes = (seconds % 3600) / 60;
105  seconds = (seconds % 3600) % 60;
106
107  g_snprintf (d, sizeof (d), ngettext ("%'d day", "%'d days", days), days);
108  g_snprintf (h, sizeof (h), ngettext ("%'d hour", "%'d hours", hours), hours);
109  g_snprintf (m, sizeof (m), ngettext ("%'d minute", "%'d minutes", minutes), minutes);
110  g_snprintf (s, sizeof (s), ngettext ("%'d second", "%'d seconds", seconds), seconds);
111
112  if (days)
113    {
114      if (days >= 4 || !hours)
115        g_strlcpy (buf, d, buflen);
116      else
117        g_snprintf (buf, buflen, "%s, %s", d, h);
118    }
119  else if (hours)
120    {
121      if (hours >= 4 || !minutes)
122        g_strlcpy (buf, h, buflen);
123      else
124        g_snprintf (buf, buflen, "%s, %s", h, m);
125    }
126  else if (minutes)
127    {
128      if (minutes >= 4 || !seconds)
129        g_strlcpy (buf, m, buflen);
130      else
131        g_snprintf (buf, buflen, "%s, %s", m, s);
132    }
133  else
134    {
135      g_strlcpy (buf, s, buflen);
136    }
137
138  return buf;
139}
140
141/* pattern-matching text; ie, legaltorrents.com */
142void
143gtr_get_host_from_url (char * buf, size_t buflen, const char * url)
144{
145  char host[1024];
146  const char * pch;
147
148  if ((pch = strstr (url, "://")))
149    {
150      const size_t hostlen = strcspn (pch+3, ":/");
151      const size_t copylen = MIN (hostlen, sizeof (host)-1);
152      memcpy (host, pch+3, copylen);
153      host[copylen] = '\0';
154    }
155  else
156    {
157      *host = '\0';
158    }
159
160  if (tr_addressIsIP (host))
161    {
162      g_strlcpy (buf, url, buflen);
163    }
164  else
165    {
166      const char * first_dot = strchr (host, '.');
167      const char * last_dot = strrchr (host, '.');
168      if ((first_dot) && (last_dot) && (first_dot != last_dot))
169        g_strlcpy (buf, first_dot + 1, buflen);
170      else
171        g_strlcpy (buf, host, buflen);
172    }
173}
174
175static gboolean
176gtr_is_supported_url (const char * str)
177{
178  return ((str != NULL) &&
179           (g_str_has_prefix (str, "ftp://") ||
180            g_str_has_prefix (str, "http://") ||
181            g_str_has_prefix (str, "https://")));
182}
183
184gboolean
185gtr_is_magnet_link (const char * str)
186{
187  return (str != NULL) && (g_str_has_prefix (str, "magnet:?"));
188}
189
190gboolean
191gtr_is_hex_hashcode (const char * str)
192{
193  int i;
194
195  if (!str || (strlen (str) != 40))
196    return FALSE;
197
198  for (i=0; i<40; ++i)
199    if (!isxdigit (str[i]))
200      return FALSE;
201
202  return TRUE;
203}
204
205static GtkWindow *
206getWindow (GtkWidget * w)
207{
208  if (w == NULL)
209    return NULL;
210
211  if (GTK_IS_WINDOW (w))
212    return GTK_WINDOW (w);
213
214  return GTK_WINDOW (gtk_widget_get_ancestor (w, GTK_TYPE_WINDOW));
215}
216
217void
218gtr_add_torrent_error_dialog (GtkWidget   * child,
219                              int           err,
220                              tr_torrent  * duplicate_torrent,
221                              const char  * filename)
222{
223  char * secondary;
224  GtkWidget * w;
225  GtkWindow * win = getWindow (child);
226
227  if (err == TR_PARSE_ERR)
228    secondary = g_strdup_printf (_("The torrent file \"%s\" contains invalid data."), filename);
229  else if (err == TR_PARSE_DUPLICATE)
230    secondary = g_strdup_printf (_("The torrent file \"%s\" is already in use by \"%s.\""), filename, tr_torrentName (duplicate_torrent));
231  else
232    secondary = g_strdup_printf (_("The torrent file \"%s\" encountered an unknown error."), filename);
233
234  w = gtk_message_dialog_new (win,
235                              GTK_DIALOG_DESTROY_WITH_PARENT,
236                              GTK_MESSAGE_ERROR,
237                              GTK_BUTTONS_CLOSE,
238                              "%s", _("Error opening torrent"));
239  gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (w),
240                                            "%s", secondary);
241  g_signal_connect_swapped (w, "response",
242                            G_CALLBACK (gtk_widget_destroy), w);
243  gtk_widget_show_all (w);
244  g_free (secondary);
245}
246
247typedef void (PopupFunc)(GtkWidget*, GdkEventButton*);
248
249/* pop up the context menu if a user right-clicks.
250   if the row they right-click on isn't selected, select it. */
251
252gboolean
253on_tree_view_button_pressed (GtkWidget *      view,
254                             GdkEventButton * event,
255                             gpointer         func)
256{
257  GtkTreeView * tv = GTK_TREE_VIEW (view);
258
259  if (event->type == GDK_BUTTON_PRESS  &&  event->button == 3)
260    {
261      GtkTreePath * path;
262      GtkTreeSelection * selection = gtk_tree_view_get_selection (tv);
263
264      if (gtk_tree_view_get_path_at_pos (tv,
265                                         (gint) event->x,
266                                         (gint) event->y,
267                                         &path, NULL, NULL, NULL))
268        {
269          if (!gtk_tree_selection_path_is_selected (selection, path))
270            {
271              gtk_tree_selection_unselect_all (selection);
272              gtk_tree_selection_select_path (selection, path);
273            }
274          gtk_tree_path_free (path);
275        }
276
277      if (func != NULL)
278        ((PopupFunc*)func)(view, event);
279
280      return TRUE;
281    }
282
283  return FALSE;
284}
285
286/* if the user clicked in an empty area of the list,
287 * clear all the selections. */
288gboolean
289on_tree_view_button_released (GtkWidget *      view,
290                              GdkEventButton * event,
291                              gpointer         unused UNUSED)
292{
293  GtkTreeView * tv = GTK_TREE_VIEW (view);
294
295  if (!gtk_tree_view_get_path_at_pos (tv,
296                                      (gint) event->x,
297                                      (gint) event->y,
298                                      NULL, NULL, NULL, NULL))
299    {
300      GtkTreeSelection * selection = gtk_tree_view_get_selection (tv);
301      gtk_tree_selection_unselect_all (selection);
302    }
303
304  return FALSE;
305}
306
307int
308gtr_file_trash_or_remove (const char * filename)
309{
310  GFile * file;
311  gboolean trashed = FALSE;
312
313  g_return_val_if_fail (filename && *filename, 0);
314
315  file = g_file_new_for_path (filename);
316
317  if (gtr_pref_flag_get (TR_KEY_trash_can_enabled))
318    {
319      GError * err = NULL;
320      trashed = g_file_trash (file, NULL, &err);
321      if (err)
322        {
323          g_message ("Unable to trash file \"%s\": %s", filename, err->message);
324          g_clear_error (&err);
325        }
326    }
327
328  if (!trashed)
329    {
330      GError * err = NULL;
331      g_file_delete (file, NULL, &err);
332      if (err)
333        {
334          g_message ("Unable to delete file \"%s\": %s", filename, err->message);
335          g_clear_error (&err);
336        }
337    }
338
339  g_object_unref (G_OBJECT (file));
340  return 0;
341}
342
343const char*
344gtr_get_help_uri (void)
345{
346  static char * uri = NULL;
347
348  if (!uri)
349    {
350      const char * fmt = "http://www.transmissionbt.com/help/gtk/%d.%dx";
351      uri = g_strdup_printf (fmt, MAJOR_VERSION, MINOR_VERSION / 10);
352    }
353
354  return uri;
355}
356
357void
358gtr_open_file (const char * path)
359{
360  GFile * file = g_file_new_for_path (path);
361  gchar * uri = g_file_get_uri (file);
362  gtr_open_uri (uri);
363  g_free (uri);
364  g_object_unref (file);
365}
366
367void
368gtr_open_uri (const char * uri)
369{
370  if (uri)
371    {
372      gboolean opened = FALSE;
373
374      if (!opened)
375        opened = gtk_show_uri (NULL, uri, GDK_CURRENT_TIME, NULL);
376
377      if (!opened)
378        opened = g_app_info_launch_default_for_uri (uri, NULL, NULL);
379
380      if (!opened)
381        {
382          char * argv[] = { (char*)"xdg-open", (char*)uri, NULL };
383          opened = g_spawn_async (NULL, argv, NULL, G_SPAWN_SEARCH_PATH, NULL, NULL, NULL, NULL);
384        }
385
386      if (!opened)
387        g_message ("Unable to open \"%s\"", uri);
388    }
389}
390
391/***
392****
393***/
394
395void
396gtr_combo_box_set_active_enum (GtkComboBox * combo_box, int value)
397{
398  int i;
399  int currentValue;
400  const int column = 0;
401  GtkTreeIter iter;
402  GtkTreeModel * model = gtk_combo_box_get_model (combo_box);
403
404  /* do the value and current value match? */
405  if (gtk_combo_box_get_active_iter (combo_box, &iter))
406    {
407      gtk_tree_model_get (model, &iter, column, &currentValue, -1);
408      if (currentValue == value)
409        return;
410    }
411
412  /* find the one to select */
413  i = 0;
414  while ((gtk_tree_model_iter_nth_child (model, &iter, NULL, i++)))
415    {
416      gtk_tree_model_get (model, &iter, column, &currentValue, -1);
417      if (currentValue == value)
418        {
419          gtk_combo_box_set_active_iter (combo_box, &iter);
420          return;
421        }
422    }
423}
424
425
426GtkWidget *
427gtr_combo_box_new_enum (const char * text_1, ...)
428{
429  GtkWidget * w;
430  GtkCellRenderer * r;
431  GtkListStore * store;
432  const char * text;
433
434  store = gtk_list_store_new (2, G_TYPE_INT, G_TYPE_STRING);
435
436  text = text_1;
437  if (text != NULL)
438    {
439      va_list vl;
440
441      va_start (vl, text_1);
442      do
443        {
444          const int val = va_arg (vl, int);
445          gtk_list_store_insert_with_values (store, NULL, INT_MAX, 0, val, 1, text, -1);
446          text = va_arg (vl, const char *);
447        }
448      while (text != NULL);
449      va_end (vl);
450    }
451
452  w = gtk_combo_box_new_with_model (GTK_TREE_MODEL (store));
453  r = gtk_cell_renderer_text_new ();
454  gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (w), r, TRUE);
455  gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (w), r, "text", 1, NULL);
456
457  /* cleanup */
458  g_object_unref (store);
459  return w;
460}
461
462int
463gtr_combo_box_get_active_enum (GtkComboBox * combo_box)
464{
465  int value = 0;
466  GtkTreeIter iter;
467
468  if (gtk_combo_box_get_active_iter (combo_box, &iter))
469    gtk_tree_model_get (gtk_combo_box_get_model (combo_box), &iter, 0, &value, -1);
470
471  return value;
472}
473
474GtkWidget *
475gtr_priority_combo_new (void)
476{
477  return gtr_combo_box_new_enum (_("High"),   TR_PRI_HIGH,
478                                 _("Normal"), TR_PRI_NORMAL,
479                                 _("Low"),    TR_PRI_LOW,
480                                 NULL);
481}
482
483/***
484****
485***/
486
487#define GTR_CHILD_HIDDEN "gtr-child-hidden"
488
489void
490gtr_widget_set_visible (GtkWidget * w, gboolean b)
491{
492  /* toggle the transient children, too */
493  if (GTK_IS_WINDOW (w))
494    {
495      GList * l;
496      GList * windows = gtk_window_list_toplevels ();
497      GtkWindow * window = GTK_WINDOW (w);
498
499      for (l=windows; l!=NULL; l=l->next)
500        {
501          if (!GTK_IS_WINDOW (l->data))
502            continue;
503          if (gtk_window_get_transient_for (GTK_WINDOW (l->data)) != window)
504            continue;
505          if (gtk_widget_get_visible (GTK_WIDGET (l->data)) == b)
506            continue;
507
508          if (b && g_object_get_data (G_OBJECT (l->data), GTR_CHILD_HIDDEN) != NULL)
509            {
510              g_object_steal_data (G_OBJECT (l->data), GTR_CHILD_HIDDEN);
511              gtr_widget_set_visible (GTK_WIDGET (l->data), TRUE);
512            }
513          else if (!b)
514            {
515              g_object_set_data (G_OBJECT (l->data), GTR_CHILD_HIDDEN, GINT_TO_POINTER (1));
516              gtr_widget_set_visible (GTK_WIDGET (l->data), FALSE);
517            }
518        }
519
520      g_list_free (windows);
521    }
522
523  gtk_widget_set_visible (w, b);
524}
525
526void
527gtr_dialog_set_content (GtkDialog * dialog, GtkWidget * content)
528{
529  GtkWidget * vbox = gtk_dialog_get_content_area (dialog);
530  gtk_box_pack_start (GTK_BOX (vbox), content, TRUE, TRUE, 0);
531  gtk_widget_show_all (content);
532}
533
534/***
535****
536***/
537
538void
539gtr_http_failure_dialog (GtkWidget * parent, const char * url, long response_code)
540{
541  GtkWindow * window = getWindow (parent);
542
543  GtkWidget * w = gtk_message_dialog_new (window, 0,
544                                          GTK_MESSAGE_ERROR,
545                                          GTK_BUTTONS_CLOSE,
546                                          _("Error opening \"%s\""), url);
547
548  gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (w),
549                                            _("Server returned \"%1$ld %2$s\""),
550                                            response_code,
551                                            tr_webGetResponseStr (response_code));
552
553  g_signal_connect_swapped (w, "response", G_CALLBACK (gtk_widget_destroy), w);
554  gtk_widget_show (w);
555}
556
557void
558gtr_unrecognized_url_dialog (GtkWidget * parent, const char * url)
559{
560  const char * xt = "xt=urn:btih";
561
562  GtkWindow * window = getWindow (parent);
563
564  GString * gstr = g_string_new (NULL);
565
566  GtkWidget * w = gtk_message_dialog_new (window, 0,
567                                          GTK_MESSAGE_ERROR,
568                                          GTK_BUTTONS_CLOSE,
569                                          "%s", _("Unrecognized URL"));
570
571  g_string_append_printf (gstr, _("Transmission doesn't know how to use \"%s\""), url);
572
573  if (gtr_is_magnet_link (url) && (strstr (url, xt) == NULL))
574    {
575      g_string_append_printf (gstr, "\n \n");
576      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);
577    }
578
579  gtk_message_dialog_format_secondary_text (GTK_MESSAGE_DIALOG (w), "%s", gstr->str);
580  g_signal_connect_swapped (w, "response", G_CALLBACK (gtk_widget_destroy), w);
581  gtk_widget_show (w);
582  g_string_free (gstr, TRUE);
583}
584
585/***
586****
587***/
588
589void
590gtr_paste_clipboard_url_into_entry (GtkWidget * e)
591{
592  size_t i;
593
594  char * text[] =
595    {
596      g_strstrip (gtk_clipboard_wait_for_text (gtk_clipboard_get (GDK_SELECTION_PRIMARY))),
597      g_strstrip (gtk_clipboard_wait_for_text (gtk_clipboard_get (GDK_SELECTION_CLIPBOARD)))
598    };
599
600  for (i=0; i<G_N_ELEMENTS (text); ++i)
601    {
602      char * s = text[i];
603      if (s && (gtr_is_supported_url (s) || gtr_is_magnet_link (s) || gtr_is_hex_hashcode (s)))
604        {
605          gtk_entry_set_text (GTK_ENTRY (e), s);
606          break;
607        }
608    }
609
610  for (i=0; i<G_N_ELEMENTS (text); ++i)
611    g_free (text[i]);
612}
613
614/***
615****
616***/
617
618void
619gtr_label_set_text (GtkLabel * lb, const char * newstr)
620{
621  const char * oldstr = gtk_label_get_text (lb);
622
623  if (g_strcmp0 (oldstr, newstr))
624    gtk_label_set_text (lb, newstr);
625}
626
627/***
628****
629***/
630
631struct freespace_label_data
632{
633  guint timer_id;
634  TrCore * core;
635  GtkLabel * label;
636  char * dir;
637};
638
639static void on_freespace_label_core_destroyed (gpointer gdata, GObject * dead_core);
640static void on_freespace_label_destroyed      (gpointer gdata, GObject * dead_label);
641
642static void
643freespace_label_data_free (gpointer gdata)
644{
645  struct freespace_label_data * data = gdata;
646
647  if (data->core != NULL)
648    g_object_weak_unref (G_OBJECT(data->core), on_freespace_label_core_destroyed, data);
649
650  if (data->label != NULL)
651    g_object_weak_ref (G_OBJECT(data->label), on_freespace_label_destroyed, data);
652
653  g_source_remove (data->timer_id);
654  g_free (data->dir);
655  g_free (data);
656}
657
658static TR_DEFINE_QUARK (freespace_label_data, freespace_label_data)
659
660static void
661on_freespace_label_core_destroyed (gpointer gdata, GObject * dead_core G_GNUC_UNUSED)
662{
663  struct freespace_label_data * data = gdata;
664  data->core = NULL;
665  freespace_label_data_free (data);
666}
667
668static void
669on_freespace_label_destroyed (gpointer gdata, GObject * dead_label G_GNUC_UNUSED)
670{
671  struct freespace_label_data * data = gdata;
672  data->label = NULL;
673  freespace_label_data_free (data);
674}
675
676static gboolean
677on_freespace_timer (gpointer gdata)
678{
679  char text[128];
680  char markup[128];
681  int64_t bytes;
682  tr_session * session;
683  struct freespace_label_data * data = gdata;
684
685  session = gtr_core_session (data->core);
686  bytes = tr_sessionGetDirFreeSpace (session, data->dir);
687
688  if (bytes < 0)
689    {
690      g_snprintf (text, sizeof(text), _("Error"));
691    }
692  else
693    {
694      char size[128];
695      tr_strlsize (size, bytes, sizeof(size));
696      g_snprintf (text, sizeof(text), _("%s free"), size);
697    }
698
699  g_snprintf (markup, sizeof(markup), "<i>%s</i>", text);
700  gtk_label_set_markup (data->label, markup);
701
702  return G_SOURCE_CONTINUE;
703}
704
705GtkWidget *
706gtr_freespace_label_new (struct _TrCore * core, const char * dir)
707{
708  struct freespace_label_data * data;
709
710  data = g_new0 (struct freespace_label_data, 1);
711  data->timer_id = g_timeout_add_seconds (3, on_freespace_timer, data);
712  data->core = core;
713  data->label = GTK_LABEL (gtk_label_new (NULL));
714  data->dir = g_strdup (dir);
715
716  /* when either the core or the label is destroyed, stop updating */
717  g_object_weak_ref (G_OBJECT(core), on_freespace_label_core_destroyed, data);
718  g_object_weak_ref (G_OBJECT(data->label), on_freespace_label_destroyed, data);
719
720  g_object_set_qdata (G_OBJECT(data->label), freespace_label_data_quark (), data);
721  on_freespace_timer (data);
722  return GTK_WIDGET (data->label);
723}
724
725void
726gtr_freespace_label_set_dir (GtkWidget * label, const char * dir)
727{
728  struct freespace_label_data * data;
729
730  data = g_object_get_qdata (G_OBJECT(label), freespace_label_data_quark ());
731
732  tr_free (data->dir);
733  data->dir = g_strdup (dir);
734  on_freespace_timer (data);
735}
Note: See TracBrowser for help on using the repository browser.