source: trunk/gtk/util.c @ 12655

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

remove the gtr_idle_add() portability wrapper around gdk_threads_add_idle() -- it's unnecessary now that the minimum gtk version's been bumped.

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