source: trunk/gtk/util.c @ 12676

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

(trunk gtk) remove some unnecessary #includes

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