source: trunk/gtk/util.c @ 12963

Last change on this file since 12963 was 12963, checked in by jordan, 10 years ago

(trunk gtk) add portability wrappers for gtk_hbox_new() and gtk_vbox_new(), which are deprecated now in GTK+ 3.2

  • Property svn:keywords set to Date Rev Author Id
File size: 16.4 KB
Line 
1/*
2 * This file Copyright (C) Mnemosyne LLC
3 *
4 * This file is licensed by the GPL version 2. Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: util.c 12963 2011-10-11 04:11:08Z jordan $
11 */
12
13#include <ctype.h> /* isxdigit() */
14#include <errno.h>
15#include <stdarg.h>
16#include <string.h> /* strchr(), strrchr(), strlen(), strncmp(), strstr() */
17
18#include <gtk/gtk.h>
19#include <glib/gi18n.h>
20#include <glib/gstdio.h> /* g_unlink() */
21#include <gio/gio.h> /* g_file_trash() */
22
23#include <libtransmission/transmission.h> /* TR_RATIO_NA, TR_RATIO_INF */
24#include <libtransmission/utils.h> /* tr_strratio() */
25#include <libtransmission/web.h> /* tr_webResponseStr() */
26#include <libtransmission/version.h> /* SHORT_VERSION_STRING */
27
28#include "conf.h"
29#include "hig.h"
30#include "tr-prefs.h"
31#include "util.h"
32
33/***
34****  UNITS
35***/
36
37const int mem_K = 1024;
38const char * mem_K_str = N_("KiB");
39const char * mem_M_str = N_("MiB");
40const char * mem_G_str = N_("GiB");
41const char * mem_T_str = N_("TiB");
42
43const int disk_K = 1024;
44const char * disk_K_str = N_("KiB");
45const char * disk_M_str = N_("MiB");
46const char * disk_G_str = N_("GiB");
47const char * disk_T_str = N_("TiB");
48
49const int speed_K = 1024;
50const char * speed_K_str = N_("KiB/s");
51const char * speed_M_str = N_("MiB/s");
52const char * speed_G_str = N_("GiB/s");
53const char * speed_T_str = N_("TiB/s");
54
55/***
56****
57***/
58
59const char*
60gtr_get_unicode_string( int i )
61{
62    switch( i ) {
63        case GTR_UNICODE_UP:      return "\xE2\x86\x91";
64        case GTR_UNICODE_DOWN:    return "\xE2\x86\x93";
65        case GTR_UNICODE_INF:     return "\xE2\x88\x9E";
66        case GTR_UNICODE_BULLET:  return "\xE2\x88\x99";
67        default:                  return "err";
68    }
69}
70
71char*
72tr_strlratio( char * buf, double ratio, size_t buflen )
73{
74    return tr_strratio( buf, buflen, ratio, gtr_get_unicode_string( GTR_UNICODE_INF ) );
75}
76
77char*
78tr_strlpercent( char * buf, double x, size_t buflen )
79{
80    return tr_strpercent( buf, x, buflen );
81}
82
83char*
84tr_strlsize( char * buf, guint64 bytes, size_t buflen )
85{
86    if( !bytes )
87        g_strlcpy( buf, Q_( "None" ), buflen );
88    else
89        tr_formatter_size_B( buf, bytes, buflen );
90
91    return buf;
92}
93
94char*
95tr_strltime( char * buf, int seconds, size_t buflen )
96{
97    int  days, hours, minutes;
98    char d[128], h[128], m[128], s[128];
99
100    if( seconds < 0 )
101        seconds = 0;
102
103    days = seconds / 86400;
104    hours = ( seconds % 86400 ) / 3600;
105    minutes = ( seconds % 3600 ) / 60;
106    seconds = ( seconds % 3600 ) % 60;
107
108    g_snprintf( d, sizeof( d ), ngettext( "%'d day", "%'d days", days ), days );
109    g_snprintf( h, sizeof( h ), ngettext( "%'d hour", "%'d hours", hours ), hours );
110    g_snprintf( m, sizeof( m ), ngettext( "%'d minute", "%'d minutes", minutes ), minutes );
111    g_snprintf( s, sizeof( s ), ngettext( "%'d second", "%'d seconds", seconds ), seconds );
112
113    if( days )
114    {
115        if( days >= 4 || !hours )
116            g_strlcpy( buf, d, buflen );
117        else
118            g_snprintf( buf, buflen, "%s, %s", d, h );
119    }
120    else if( hours )
121    {
122        if( hours >= 4 || !minutes )
123            g_strlcpy( buf, h, buflen );
124        else
125            g_snprintf( buf, buflen, "%s, %s", h, m );
126    }
127    else if( minutes )
128    {
129        if( minutes >= 4 || !seconds )
130            g_strlcpy( buf, m, buflen );
131        else
132            g_snprintf( buf, buflen, "%s, %s", m, s );
133    }
134    else
135    {
136        g_strlcpy( buf, s, buflen );
137    }
138
139    return buf;
140}
141
142/* pattern-matching text; ie, legaltorrents.com */
143void
144gtr_get_host_from_url( char * buf, size_t buflen, const char * url )
145{
146    char host[1024];
147    const char * pch;
148
149    if(( pch = strstr( url, "://" ))) {
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    } else {
155        *host = '\0';
156    }
157
158    if( tr_addressIsIP( host ) )
159        g_strlcpy( buf, url, buflen );
160    else {
161        const char * first_dot = strchr( host, '.' );
162        const char * last_dot = strrchr( host, '.' );
163        if( ( first_dot ) && ( last_dot ) && ( first_dot != last_dot ) )
164            g_strlcpy( buf, first_dot + 1, buflen );
165        else
166            g_strlcpy( buf, host, buflen );
167    }
168}
169
170static gboolean
171gtr_is_supported_url( const char * str )
172{
173    return !strncmp( str, "ftp://", 6 )
174        || !strncmp( str, "http://", 7 )
175        || !strncmp( str, "https://", 8 );
176}
177
178gboolean
179gtr_is_magnet_link( const char * str )
180{
181    return !strncmp( str, "magnet:?", 8 );
182}
183
184gboolean
185gtr_is_hex_hashcode( const char * str )
186{
187    int i;
188
189    if( !str || ( strlen( str ) != 40 ) )
190        return FALSE;
191
192    for( i=0; i<40; ++i )
193        if( !isxdigit( str[i] ) )
194            return FALSE;
195
196    return TRUE;
197}
198
199static GtkWindow *
200getWindow( GtkWidget * w )
201{
202    if( w == NULL )
203        return NULL;
204
205    if( GTK_IS_WINDOW( w ) )
206        return GTK_WINDOW( w );
207
208    return GTK_WINDOW( gtk_widget_get_ancestor( w, GTK_TYPE_WINDOW ) );
209}
210
211void
212gtr_add_torrent_error_dialog( GtkWidget * child, int err, const char * file )
213{
214    char * secondary;
215    const char * fmt;
216    GtkWidget * w;
217    GtkWindow * win = getWindow( child );
218
219    switch( err )
220    {
221        case TR_PARSE_ERR: fmt = _( "The torrent file \"%s\" contains invalid data." ); break;
222        case TR_PARSE_DUPLICATE: fmt = _( "The torrent file \"%s\" is already in use." ); break;
223        default: fmt = _( "The torrent file \"%s\" encountered an unknown error." ); break;
224    }
225    secondary = g_strdup_printf( fmt, file );
226
227    w = gtk_message_dialog_new( win,
228                                GTK_DIALOG_DESTROY_WITH_PARENT,
229                                GTK_MESSAGE_ERROR,
230                                GTK_BUTTONS_CLOSE,
231                                "%s", _( "Error opening torrent" ) );
232    gtk_message_dialog_format_secondary_text( GTK_MESSAGE_DIALOG( w ),
233                                              "%s", secondary );
234    g_signal_connect_swapped( w, "response",
235                              G_CALLBACK( gtk_widget_destroy ), w );
236    gtk_widget_show_all( w );
237    g_free( secondary );
238}
239
240typedef void ( PopupFunc )( GtkWidget*, GdkEventButton* );
241
242/* pop up the context menu if a user right-clicks.
243   if the row they right-click on isn't selected, select it. */
244
245gboolean
246on_tree_view_button_pressed( GtkWidget *      view,
247                             GdkEventButton * event,
248                             gpointer         func )
249{
250    GtkTreeView * tv = GTK_TREE_VIEW( view );
251
252    if( event->type == GDK_BUTTON_PRESS  &&  event->button == 3 )
253    {
254        GtkTreeSelection * selection = gtk_tree_view_get_selection( tv );
255        GtkTreePath *      path;
256        if( gtk_tree_view_get_path_at_pos ( tv,
257                                            (gint) event->x,
258                                            (gint) event->y,
259                                            &path, NULL, NULL, NULL ) )
260        {
261            if( !gtk_tree_selection_path_is_selected ( selection, path ) )
262            {
263                gtk_tree_selection_unselect_all ( selection );
264                gtk_tree_selection_select_path ( selection, path );
265            }
266            gtk_tree_path_free( path );
267        }
268
269        if( func != NULL )
270            ( (PopupFunc*)func )( view, event );
271
272        return TRUE;
273    }
274
275    return FALSE;
276}
277
278/* if the user clicked in an empty area of the list,
279 * clear all the selections. */
280gboolean
281on_tree_view_button_released( GtkWidget *      view,
282                              GdkEventButton * event,
283                              gpointer         unused UNUSED )
284{
285    GtkTreeView * tv = GTK_TREE_VIEW( view );
286
287    if( !gtk_tree_view_get_path_at_pos ( tv,
288                                         (gint) event->x,
289                                         (gint) event->y,
290                                         NULL, NULL, NULL, NULL ) )
291    {
292        GtkTreeSelection * selection = gtk_tree_view_get_selection( tv );
293        gtk_tree_selection_unselect_all ( selection );
294    }
295
296    return FALSE;
297}
298
299int
300gtr_file_trash_or_remove( const char * filename )
301{
302    gboolean trashed = FALSE;
303    GFile * file = g_file_new_for_path( filename );
304
305    if( gtr_pref_flag_get( PREF_KEY_TRASH_CAN_ENABLED ) ) {
306        GError * err = NULL;
307        trashed = g_file_trash( file, NULL, &err );
308        if( err ) {
309            g_message( "Unable to trash file \"%s\": %s", filename, err->message );
310            g_clear_error( &err );
311        }
312    }
313
314    if( !trashed ) {
315        GError * err = NULL;
316        trashed = g_file_delete( file, NULL, &err );
317        if( err ) {
318            g_message( "Unable to delete file \"%s\": %s", filename, err->message );
319            g_clear_error( &err );
320        }
321    }
322
323    g_object_unref( G_OBJECT( file ) );
324    return 0;
325}
326
327const char*
328gtr_get_help_uri( void )
329{
330    static char * uri = NULL;
331
332    if( !uri )
333    {
334        int major, minor;
335        const char * fmt = "http://www.transmissionbt.com/help/gtk/%d.%dx";
336        sscanf( SHORT_VERSION_STRING, "%d.%d", &major, &minor );
337        uri = g_strdup_printf( fmt, major, minor / 10 );
338    }
339
340    return uri;
341}
342
343void
344gtr_open_file( const char * path )
345{
346    char * uri = NULL;
347
348    GFile * file = g_file_new_for_path( path );
349    uri = g_file_get_uri( file );
350    g_object_unref( G_OBJECT( file ) );
351
352    if( g_path_is_absolute( path ) )
353        uri = g_strdup_printf( "file://%s", path );
354    else {
355        char * cwd = g_get_current_dir();
356        uri = g_strdup_printf( "file://%s/%s", cwd, path );
357        g_free( cwd );
358    }
359
360    gtr_open_uri( uri );
361    g_free( uri );
362}
363
364void
365gtr_open_uri( const char * uri )
366{
367    if( uri )
368    {
369        gboolean opened = FALSE;
370
371        if( !opened )
372            opened = gtk_show_uri( NULL, uri, GDK_CURRENT_TIME, NULL );
373
374        if( !opened )
375            opened = g_app_info_launch_default_for_uri( uri, NULL, NULL );
376
377        if( !opened ) {
378            char * argv[] = { (char*)"xdg-open", (char*)uri, NULL };
379            opened = g_spawn_async( NULL, argv, NULL, G_SPAWN_SEARCH_PATH,
380                                    NULL, NULL, NULL, NULL );
381        }
382
383        if( !opened )
384            g_message( "Unable to open \"%s\"", uri );
385    }
386}
387
388/***
389****
390***/
391
392void
393gtr_combo_box_set_active_enum( GtkComboBox * combo_box, int value )
394{
395    int i;
396    int currentValue;
397    const int column = 0;
398    GtkTreeIter iter;
399    GtkTreeModel * model = gtk_combo_box_get_model( combo_box );
400
401    /* do the value and current value match? */
402    if( gtk_combo_box_get_active_iter( combo_box, &iter ) ) {
403        gtk_tree_model_get( model, &iter, column, &currentValue, -1 );
404        if( currentValue == value )
405            return;
406    }
407
408    /* find the one to select */
409    i = 0;
410    while(( gtk_tree_model_iter_nth_child( model, &iter, NULL, i++ ))) {
411        gtk_tree_model_get( model, &iter, column, &currentValue, -1 );
412        if( currentValue == value ) {
413            gtk_combo_box_set_active_iter( combo_box, &iter );
414            return;
415        }
416    }
417}
418
419
420GtkWidget *
421gtr_combo_box_new_enum( const char * text_1, ... )
422{
423    GtkWidget * w;
424    GtkCellRenderer * r;
425    GtkListStore * store;
426    va_list vl;
427    const char * text;
428    va_start( vl, text_1 );
429
430    store = gtk_list_store_new( 2, G_TYPE_INT, G_TYPE_STRING );
431
432    text = text_1;
433    if( text != NULL ) do
434    {
435        const int val = va_arg( vl, int );
436        gtk_list_store_insert_with_values( store, NULL, INT_MAX, 0, val, 1, text, -1 );
437        text = va_arg( vl, const char * );
438    }
439    while( text != NULL );
440
441    w = gtk_combo_box_new_with_model( GTK_TREE_MODEL( store ) );
442    r = gtk_cell_renderer_text_new( );
443    gtk_cell_layout_pack_start( GTK_CELL_LAYOUT( w ), r, TRUE );
444    gtk_cell_layout_set_attributes( GTK_CELL_LAYOUT( w ), r, "text", 1, NULL );
445
446    /* cleanup */
447    g_object_unref( store );
448    return w;
449}
450
451int
452gtr_combo_box_get_active_enum( GtkComboBox * combo_box )
453{
454    int value = 0;
455    GtkTreeIter iter;
456
457    if( gtk_combo_box_get_active_iter( combo_box, &iter ) )
458        gtk_tree_model_get( gtk_combo_box_get_model( combo_box ), &iter, 0, &value, -1 );
459
460    return value;
461}
462
463GtkWidget *
464gtr_priority_combo_new( void )
465{
466    return gtr_combo_box_new_enum( _( "High" ),   TR_PRI_HIGH,
467                                   _( "Normal" ), TR_PRI_NORMAL,
468                                   _( "Low" ),    TR_PRI_LOW,
469                                   NULL );
470}
471
472/***
473****
474***/
475
476GtkWidget*
477gtr_hbox_new( gboolean homogenous UNUSED, gint spacing )
478{
479#if GTK_CHECK_VERSION( 3,2,0 )
480    return gtk_box_new( GTK_ORIENTATION_HORIZONTAL, spacing );
481#else
482    return gtk_hbox_new( homogenous, spacing );
483#endif
484}
485
486GtkWidget*
487gtr_vbox_new( gboolean homogenous UNUSED, gint spacing )
488{
489#if GTK_CHECK_VERSION( 3,2,0 )
490    return gtk_box_new( GTK_ORIENTATION_VERTICAL, spacing );
491#else
492    return gtk_vbox_new( homogenous, spacing );
493#endif
494}
495
496void
497gtr_widget_set_visible( GtkWidget * w, gboolean b )
498{
499    /* toggle the transient children, too */
500    if( GTK_IS_WINDOW( w ) )
501    {
502        GList * l;
503        GList * windows = gtk_window_list_toplevels( );
504        GtkWindow * window = GTK_WINDOW( w );
505
506        for( l=windows; l!=NULL; l=l->next )
507            if( GTK_IS_WINDOW( l->data ) )
508                if( gtk_window_get_transient_for( GTK_WINDOW( l->data ) ) == window )
509                    gtr_widget_set_visible( GTK_WIDGET( l->data ), b );
510
511        g_list_free( windows );
512    }
513
514    gtk_widget_set_visible( w, b );
515}
516
517void
518gtr_dialog_set_content( GtkDialog * dialog, GtkWidget * content )
519{
520    GtkWidget * vbox = gtk_dialog_get_content_area( dialog );
521    gtk_box_pack_start( GTK_BOX( vbox ), content, TRUE, TRUE, 0 );
522    gtk_widget_show_all( content );
523}
524
525/***
526****
527***/
528
529void
530gtr_http_failure_dialog( GtkWidget * parent, const char * url, long response_code )
531{
532    GtkWindow * window = getWindow( parent );
533
534    GtkWidget * w = gtk_message_dialog_new( window, 0,
535                                            GTK_MESSAGE_ERROR,
536                                            GTK_BUTTONS_CLOSE,
537                                            _( "Error opening \"%s\"" ), url );
538
539    gtk_message_dialog_format_secondary_text( GTK_MESSAGE_DIALOG( w ),
540                                              _( "Server returned \"%1$ld %2$s\"" ),
541                                              response_code,
542                                              tr_webGetResponseStr( response_code ) );
543
544    g_signal_connect_swapped( w, "response", G_CALLBACK( gtk_widget_destroy ), w );
545    gtk_widget_show( w );
546}
547
548void
549gtr_unrecognized_url_dialog( GtkWidget * parent, const char * url )
550{
551    const char * xt = "xt=urn:btih";
552
553    GtkWindow * window = getWindow( parent );
554
555    GString * gstr = g_string_new( NULL );
556
557    GtkWidget * w = gtk_message_dialog_new( window, 0,
558                                            GTK_MESSAGE_ERROR,
559                                            GTK_BUTTONS_CLOSE,
560                                            "%s", _( "Unrecognized URL" ) );
561
562    g_string_append_printf( gstr, _( "Transmission doesn't know how to use \"%s\"" ), url );
563
564    if( gtr_is_magnet_link( url ) && ( strstr( url, xt ) == NULL ) )
565    {
566        g_string_append_printf( gstr, "\n \n" );
567        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 );
568    }
569
570    gtk_message_dialog_format_secondary_text( GTK_MESSAGE_DIALOG( w ), "%s", gstr->str );
571    g_signal_connect_swapped( w, "response", G_CALLBACK( gtk_widget_destroy ), w );
572    gtk_widget_show( w );
573    g_string_free( gstr, TRUE );
574}
575
576/***
577****
578***/
579
580void
581gtr_paste_clipboard_url_into_entry( GtkWidget * e )
582{
583  size_t i;
584
585  char * text[] = {
586    gtk_clipboard_wait_for_text( gtk_clipboard_get( GDK_SELECTION_PRIMARY ) ),
587    gtk_clipboard_wait_for_text( gtk_clipboard_get( GDK_SELECTION_CLIPBOARD ) )
588  };
589
590  for( i=0; i<G_N_ELEMENTS(text); ++i ) {
591      char * s = text[i];
592      if( s && ( gtr_is_supported_url( s ) || gtr_is_magnet_link( s )
593                                           || gtr_is_hex_hashcode( s ) ) ) {
594          gtk_entry_set_text( GTK_ENTRY( e ), s );
595          break;
596      }
597  }
598
599  for( i=0; i<G_N_ELEMENTS(text); ++i )
600    g_free( text[i] );
601}
602
603/***
604****
605***/
606
607void
608gtr_label_set_text( GtkLabel * lb, const char * newstr )
609{
610    const char * oldstr = gtk_label_get_text( lb );
611
612    if( tr_strcmp0( oldstr, newstr ) )
613        gtk_label_set_text( lb, newstr );
614}
Note: See TracBrowser for help on using the repository browser.