source: trunk/gtk/util.c @ 10031

Last change on this file since 10031 was 10031, checked in by charles, 12 years ago

(trunk) remove unnecessary #includes

  • Property svn:keywords set to Date Rev Author Id
File size: 18.9 KB
Line 
1/*
2 * This file Copyright (C) 2008-2010 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 10031 2010-01-28 13:33:40Z charles $
11 */
12
13#include <ctype.h> /* isxdigit() */
14#include <errno.h>
15#include <stdlib.h> /* free() */
16#include <string.h> /* strcmp() */
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#ifdef HAVE_GIO
26 #include <gio/gio.h> /* g_file_trash() */
27#endif
28#ifdef HAVE_DBUS_GLIB
29 #include <dbus/dbus-glib.h>
30#endif
31
32#include <evhttp.h>
33
34#include <libtransmission/transmission.h> /* TR_RATIO_NA, TR_RATIO_INF */
35#include <libtransmission/utils.h> /* tr_inf */
36#include <libtransmission/version.h> /* tr_inf */
37
38#include "conf.h"
39#include "hig.h"
40#include "tr-prefs.h"
41#include "util.h"
42
43gtr_lockfile_state_t
44gtr_lockfile( const char * filename )
45{
46    gtr_lockfile_state_t ret;
47
48#ifdef WIN32
49
50    HANDLE file = CreateFile( filename,
51                              GENERIC_READ | GENERIC_WRITE,
52                              FILE_SHARE_READ | FILE_SHARE_WRITE,
53                              NULL,
54                              OPEN_ALWAYS,
55                              FILE_ATTRIBUTE_NORMAL,
56                              NULL );
57    if( file == INVALID_HANDLE_VALUE )
58        ret = GTR_LOCKFILE_EOPEN;
59    else if( !LockFile( file, 0, 0, 1, 1 ) )
60        ret = GTR_LOCKFILE_ELOCK;
61    else
62        ret = GTR_LOCKFILE_SUCCESS;
63
64#else
65
66    int fd = open( filename, O_RDWR | O_CREAT, 0666 );
67    if( fd < 0 )
68        ret = GTR_LOCKFILE_EOPEN;
69    else {
70        struct flock lk;
71        memset( &lk, 0,  sizeof( lk ) );
72        lk.l_start = 0;
73        lk.l_len = 0;
74        lk.l_type = F_WRLCK;
75        lk.l_whence = SEEK_SET;
76        if( -1 == fcntl( fd, F_SETLK, &lk ) )
77            ret = GTR_LOCKFILE_ELOCK;
78        else
79            ret = GTR_LOCKFILE_SUCCESS;
80    }
81
82#endif
83
84    return ret;
85}
86
87/***
88****
89***/
90
91
92char*
93tr_strlratio( char * buf, double ratio, size_t buflen )
94{
95    return tr_strratio( buf, buflen, ratio, "\xE2\x88\x9E" );
96}
97
98#define KILOBYTE_FACTOR 1024.0
99#define MEGABYTE_FACTOR ( 1024.0 * 1024.0 )
100#define GIGABYTE_FACTOR ( 1024.0 * 1024.0 * 1024.0 )
101
102char*
103tr_strlsize( char *  buf,
104             guint64 size,
105             size_t  buflen )
106{
107    if( !size )
108        g_strlcpy( buf, _( "None" ), buflen );
109#if GLIB_CHECK_VERSION( 2, 16, 0 )
110    else
111    {
112        char * tmp = g_format_size_for_display( size );
113        g_strlcpy( buf, tmp, buflen );
114        g_free( tmp );
115    }
116#else
117    else if( size < (guint64)KILOBYTE_FACTOR )
118        g_snprintf( buf, buflen,
119                    ngettext( "%'u byte", "%'u bytes",
120                              (guint)size ), (guint)size );
121    else
122    {
123        gdouble displayed_size;
124        if( size < (guint64)MEGABYTE_FACTOR )
125        {
126            displayed_size = (gdouble) size / KILOBYTE_FACTOR;
127            g_snprintf( buf, buflen, _( "%'.1f KB" ), displayed_size );
128        }
129        else if( size < (guint64)GIGABYTE_FACTOR )
130        {
131            displayed_size = (gdouble) size / MEGABYTE_FACTOR;
132            g_snprintf( buf, buflen, _( "%'.1f MB" ), displayed_size );
133        }
134        else
135        {
136            displayed_size = (gdouble) size / GIGABYTE_FACTOR;
137            g_snprintf( buf, buflen, _( "%'.1f GB" ), displayed_size );
138        }
139    }
140#endif
141    return buf;
142}
143
144char*
145tr_strlspeed( char * buf,
146              double kb_sec,
147              size_t buflen )
148{
149    const double speed = kb_sec;
150
151    if( speed < 1000.0 )  /* 0.0 KB to 999.9 KB */
152        g_snprintf( buf, buflen, _( "%'.1f KB/s" ), speed );
153    else if( speed < 102400.0 ) /* 0.98 MB to 99.99 MB */
154        g_snprintf( buf, buflen, _( "%'.2f MB/s" ), ( speed / KILOBYTE_FACTOR ) );
155    else if( speed < 1024000.0 ) /* 100.0 MB to 999.9 MB */
156        g_snprintf( buf, buflen, _( "%'.1f MB/s" ), ( speed / MEGABYTE_FACTOR ) );
157    else /* insane speeds */
158        g_snprintf( buf, buflen, _( "%'.2f GB/s" ), ( speed / GIGABYTE_FACTOR ) );
159
160    return buf;
161}
162
163char*
164tr_strltime( char * buf,
165             int    seconds,
166             size_t buflen )
167{
168    int  days, hours, minutes;
169    char d[128], h[128], m[128], s[128];
170
171    if( seconds < 0 )
172        seconds = 0;
173
174    days = seconds / 86400;
175    hours = ( seconds % 86400 ) / 3600;
176    minutes = ( seconds % 3600 ) / 60;
177    seconds = ( seconds % 3600 ) % 60;
178
179    g_snprintf( d, sizeof( d ), ngettext( "%'d day", "%'d days",
180                                          days ), days );
181    g_snprintf( h, sizeof( h ), ngettext( "%'d hour", "%'d hours",
182                                          hours ), hours );
183    g_snprintf( m, sizeof( m ),
184                ngettext( "%'d minute", "%'d minutes", minutes ), minutes );
185    g_snprintf( s, sizeof( s ),
186                ngettext( "%'d second", "%'d seconds", seconds ), seconds );
187
188    if( days )
189    {
190        if( days >= 4 || !hours )
191        {
192            g_strlcpy( buf, d, buflen );
193        }
194        else
195        {
196            g_snprintf( buf, buflen, "%s, %s", d, h );
197        }
198    }
199    else if( hours )
200    {
201        if( hours >= 4 || !minutes )
202        {
203            g_strlcpy( buf, h, buflen );
204        }
205        else
206        {
207            g_snprintf( buf, buflen, "%s, %s", h, m );
208        }
209    }
210    else if( minutes )
211    {
212        if( minutes >= 4 || !seconds )
213        {
214            g_strlcpy( buf, m, buflen );
215        }
216        else
217        {
218            g_snprintf( buf, buflen, "%s, %s", m, s );
219        }
220    }
221    else
222    {
223        g_strlcpy( buf, s, buflen );
224    }
225
226    return buf;
227}
228
229char *
230gtr_localtime( time_t time )
231{
232    const struct tm tm = *localtime( &time );
233    char            buf[256], *eoln;
234
235    g_strlcpy( buf, asctime( &tm ), sizeof( buf ) );
236    if( ( eoln = strchr( buf, '\n' ) ) )
237        *eoln = '\0';
238
239    return g_locale_to_utf8( buf, -1, NULL, NULL, NULL );
240}
241
242char *
243gtr_localtime2( char * buf, time_t time, size_t buflen )
244{
245    char * tmp = gtr_localtime( time );
246    g_strlcpy( buf, tmp, buflen );
247    g_free( tmp );
248    return buf;
249}
250
251int
252gtr_mkdir_with_parents( const char * path, int mode )
253{
254#if GLIB_CHECK_VERSION( 2, 8, 0 )
255    return !g_mkdir_with_parents( path, mode );
256#else
257    return !tr_mkdirp( path, mode );
258#endif
259}
260
261GSList *
262dupstrlist( GSList * l )
263{
264    GSList * ret = NULL;
265
266    for( ; l != NULL; l = l->next )
267        ret = g_slist_prepend( ret, g_strdup( l->data ) );
268    return g_slist_reverse( ret );
269}
270
271char *
272joinstrlist( GSList *list,
273             char *  sep )
274{
275    GSList * l;
276    GString *gstr = g_string_new ( NULL );
277
278    for( l = list; l != NULL; l = l->next )
279    {
280        g_string_append ( gstr, (char*)l->data );
281        if( l->next != NULL )
282            g_string_append ( gstr, ( sep ) );
283    }
284    return g_string_free ( gstr, FALSE );
285}
286
287void
288freestrlist( GSList *list )
289{
290    g_slist_foreach ( list, (GFunc)g_free, NULL );
291    g_slist_free ( list );
292}
293
294char *
295decode_uri( const char * uri )
296{
297    gboolean in_query = FALSE;
298    char *   ret = g_new( char, strlen( uri ) + 1 );
299    char *   out = ret;
300
301    for( ; uri && *uri; )
302    {
303        char ch = *uri;
304        if( ch == '?' )
305            in_query = TRUE;
306        else if( ch == '+' && in_query )
307            ch = ' ';
308        else if( ch == '%' && isxdigit( (unsigned char)uri[1] )
309               && isxdigit( (unsigned char)uri[2] ) )
310        {
311            char buf[3] = { uri[1], uri[2], '\0' };
312            ch = (char) g_ascii_strtoull( buf, NULL, 16 );
313            uri += 2;
314        }
315
316        ++uri;
317        *out++ = ch;
318    }
319
320    *out = '\0';
321    return ret;
322}
323
324
325gboolean
326gtr_is_supported_url( const char * str )
327{
328    return !strncmp( str, "ftp://", 6 )
329        || !strncmp( str, "http://", 7 )
330        || !strncmp( str, "https://", 8 );
331}
332
333gboolean
334gtr_is_magnet_link( const char * str )
335{
336    return !strncmp( str, "magnet:?", 8 );
337}
338
339gboolean
340gtr_is_hex_hashcode( const char * str )
341{
342    int i;
343
344    if( !str || ( strlen( str ) != 40 ) )
345        return FALSE;
346
347    for( i=0; i<40; ++i )
348        if( !isxdigit( str[i] ) )
349            return FALSE;
350
351    return TRUE;
352}
353
354void
355addTorrentErrorDialog( GtkWidget *  child,
356                       int          err,
357                       const char * filename )
358{
359    GtkWidget *  w;
360    GtkWidget *  win;
361    const char * fmt;
362    char *       secondary;
363
364    switch( err )
365    {
366        case TR_PARSE_ERR: fmt = _( "The torrent file \"%s\" contains invalid data." ); break;
367        case TR_PARSE_DUPLICATE: fmt = _( "The torrent file \"%s\" is already in use." ); break;
368        default: fmt = _( "The torrent file \"%s\" encountered an unknown error." ); break;
369    }
370    secondary = g_strdup_printf( fmt, filename );
371    win = ( !child || GTK_IS_WINDOW( child ) )
372          ? child
373          : gtk_widget_get_ancestor( child ? GTK_WIDGET(
374                                         child ) : NULL, GTK_TYPE_WINDOW );
375    w = gtk_message_dialog_new( GTK_WINDOW( win ),
376                               GTK_DIALOG_DESTROY_WITH_PARENT,
377                               GTK_MESSAGE_ERROR,
378                               GTK_BUTTONS_CLOSE,
379                               "%s", _( "Error opening torrent" ) );
380    gtk_message_dialog_format_secondary_text( GTK_MESSAGE_DIALOG( w ),
381                                              "%s", secondary );
382    g_signal_connect_swapped( w, "response",
383                              G_CALLBACK( gtk_widget_destroy ), w );
384    gtk_widget_show_all( w );
385    g_free( secondary );
386}
387typedef void ( PopupFunc )( GtkWidget*, GdkEventButton* );
388
389/* pop up the context menu if a user right-clicks.
390   if the row they right-click on isn't selected, select it. */
391
392gboolean
393on_tree_view_button_pressed( GtkWidget *      view,
394                             GdkEventButton * event,
395                             gpointer         func )
396{
397    GtkTreeView * tv = GTK_TREE_VIEW( view );
398
399    if( event->type == GDK_BUTTON_PRESS  &&  event->button == 3 )
400    {
401        GtkTreeSelection * selection = gtk_tree_view_get_selection( tv );
402        GtkTreePath *      path;
403        if( gtk_tree_view_get_path_at_pos ( tv,
404                                            (gint) event->x,
405                                            (gint) event->y,
406                                            &path, NULL, NULL, NULL ) )
407        {
408            if( !gtk_tree_selection_path_is_selected ( selection, path ) )
409            {
410                gtk_tree_selection_unselect_all ( selection );
411                gtk_tree_selection_select_path ( selection, path );
412            }
413            gtk_tree_path_free( path );
414        }
415
416        if( func != NULL )
417            ( (PopupFunc*)func )( view, event );
418
419        return TRUE;
420    }
421
422    return FALSE;
423}
424
425/* if the user clicked in an empty area of the list,
426 * clear all the selections. */
427gboolean
428on_tree_view_button_released( GtkWidget *      view,
429                              GdkEventButton * event,
430                              gpointer         unused UNUSED )
431{
432    GtkTreeView * tv = GTK_TREE_VIEW( view );
433
434    if( !gtk_tree_view_get_path_at_pos ( tv,
435                                         (gint) event->x,
436                                         (gint) event->y,
437                                         NULL, NULL, NULL, NULL ) )
438    {
439        GtkTreeSelection * selection = gtk_tree_view_get_selection( tv );
440        gtk_tree_selection_unselect_all ( selection );
441    }
442
443    return FALSE;
444}
445
446gpointer
447tr_object_ref_sink( gpointer object )
448{
449#if GLIB_CHECK_VERSION( 2, 10, 0 )
450    g_object_ref_sink( object );
451#else
452    g_object_ref( object );
453    gtk_object_sink( GTK_OBJECT( object ) );
454#endif
455    return object;
456}
457
458int
459tr_file_trash_or_remove( const char * filename )
460{
461    if( filename && *filename )
462    {
463        gboolean trashed = FALSE;
464#ifdef HAVE_GIO
465        GError * err = NULL;
466        GFile *  file = g_file_new_for_path( filename );
467        trashed = g_file_trash( file, NULL, &err );
468        if( err )
469            g_message( "Unable to trash file \"%s\": %s", filename, err->message );
470        g_clear_error( &err );
471        g_object_unref( G_OBJECT( file ) );
472#endif
473
474        if( !trashed && g_remove( filename ) )
475        {
476            const int err = errno;
477            g_message( "Unable to remove file \"%s\": %s", filename, g_strerror( err ) );
478        }
479    }
480
481    return 0;
482}
483
484char*
485gtr_get_help_url( void )
486{
487    const char * fmt = "http://www.transmissionbt.com/help/gtk/%d.%dx";
488    int          major, minor;
489
490    sscanf( SHORT_VERSION_STRING, "%d.%d", &major, &minor );
491    return g_strdup_printf( fmt, major, minor / 10 );
492}
493
494void
495gtr_open_file( const char * path )
496{
497    if( path )
498    {
499        gboolean opened = FALSE;
500#ifdef HAVE_GIO
501        if( !opened )
502        {
503            GFile * file = g_file_new_for_path( path );
504            char *  uri = g_file_get_uri( file );
505            opened = g_app_info_launch_default_for_uri( uri, NULL, NULL );
506            g_free( uri );
507            g_object_unref( G_OBJECT( file ) );
508        }
509#endif
510        if( !opened )
511        {
512            char * argv[] = { (char*)"xdg-open", (char*)path, NULL };
513            opened = g_spawn_async( NULL, argv, NULL, G_SPAWN_SEARCH_PATH,
514                                    NULL, NULL, NULL, NULL );
515        }
516
517        if( !opened )
518        {
519            g_message( "Unable to open \"%s\"", path );
520        }
521    }
522}
523
524#define VALUE_SERVICE_NAME        "com.transmissionbt.Transmission"
525#define VALUE_SERVICE_OBJECT_PATH "/com/transmissionbt/Transmission"
526#define VALUE_SERVICE_INTERFACE   "com.transmissionbt.Transmission"
527
528gboolean
529gtr_dbus_add_torrent( const char * filename )
530{
531    /* FIXME: why is this static? */
532    static gboolean handled = FALSE;
533
534#ifdef HAVE_DBUS_GLIB
535    char * payload;
536    gsize file_length;
537    char * file_contents = NULL;
538
539    /* If it's a file, load its contents and send them over the wire...
540     * it might be a temporary file that's going to disappear. */
541    if( g_file_get_contents( filename, &file_contents, &file_length, NULL ) )
542        payload = tr_base64_encode( file_contents, file_length, NULL );
543    else if( gtr_is_supported_url( filename ) || gtr_is_magnet_link( filename ) )
544        payload = tr_strdup( filename );
545    else
546        payload = NULL;
547
548    if( payload != NULL )
549    {
550        GError * err = NULL;
551        DBusGConnection * conn;
552        DBusGProxy * proxy = NULL;
553
554        if(( conn = dbus_g_bus_get( DBUS_BUS_SESSION, &err )))
555            proxy = dbus_g_proxy_new_for_name (conn, VALUE_SERVICE_NAME,
556                                                     VALUE_SERVICE_OBJECT_PATH,
557                                                     VALUE_SERVICE_INTERFACE );
558        else if( err )
559           g_message( "err: %s", err->message );
560
561        if( proxy )
562            dbus_g_proxy_call( proxy, "AddMetainfo", &err,
563                               G_TYPE_STRING, payload,
564                               G_TYPE_INVALID,
565                               G_TYPE_BOOLEAN, &handled,
566                               G_TYPE_INVALID );
567        if( err )
568           g_message( "err: %s", err->message );
569
570        if( proxy )
571            g_object_unref( proxy );
572        if( conn )
573            dbus_g_connection_unref( conn );
574
575        tr_free( payload );
576    }
577
578    g_free( file_contents );
579
580#endif
581    return handled;
582}
583
584gboolean
585gtr_dbus_present_window( void )
586{
587    static gboolean   success = FALSE;
588
589#ifdef HAVE_DBUS_GLIB
590    DBusGProxy *      proxy = NULL;
591    GError *          err = NULL;
592    DBusGConnection * conn;
593    if( ( conn = dbus_g_bus_get( DBUS_BUS_SESSION, &err ) ) )
594        proxy = dbus_g_proxy_new_for_name ( conn, VALUE_SERVICE_NAME,
595                                            VALUE_SERVICE_OBJECT_PATH,
596                                            VALUE_SERVICE_INTERFACE );
597    else if( err )
598        g_message( "err: %s", err->message );
599    if( proxy )
600        dbus_g_proxy_call( proxy, "PresentWindow", &err,
601                           G_TYPE_INVALID,
602                           G_TYPE_BOOLEAN, &success,
603                           G_TYPE_INVALID );
604    if( err )
605        g_message( "err: %s", err->message );
606
607    g_object_unref( proxy );
608    dbus_g_connection_unref( conn );
609#endif
610    return success;
611}
612
613GtkWidget *
614gtr_button_new_from_stock( const char * stock,
615                           const char * mnemonic )
616{
617    GtkWidget * image = gtk_image_new_from_stock( stock,
618                                                  GTK_ICON_SIZE_BUTTON );
619    GtkWidget * button = gtk_button_new_with_mnemonic( mnemonic );
620
621    gtk_button_set_image( GTK_BUTTON( button ), image );
622    return button;
623}
624
625/***
626****
627***/
628
629void
630gtr_widget_set_tooltip_text( GtkWidget * w, const char * tip )
631{
632#if GTK_CHECK_VERSION( 2,12,0 )
633    gtk_widget_set_tooltip_text( w, tip );
634#else
635    static GtkTooltips * tips = NULL;
636    if( tips == NULL )
637        tips = gtk_tooltips_new( );
638    gtk_tooltips_set_tip( tips, w, tip, NULL );
639#endif
640}
641
642void
643gtr_toolbar_set_orientation( GtkToolbar      * toolbar,
644                             GtkOrientation    orientation )
645{
646#if GTK_CHECK_VERSION( 2,16,0 )
647    gtk_orientable_set_orientation( GTK_ORIENTABLE( toolbar ), orientation );
648#else
649    gtk_toolbar_set_orientation( toolbar, orientation );
650#endif
651}
652
653/***
654****
655***/
656
657#if !GTK_CHECK_VERSION( 2,12,0 )
658struct gtr_func_data
659{
660    GSourceFunc function;
661    gpointer data;
662};
663
664static void
665gtr_func_data_free( gpointer data )
666{
667#if GTK_CHECK_VERSION( 2,10,0 )
668    g_slice_free( struct gtr_func_data, data );
669#else
670    g_free( data );
671#endif
672}
673
674static struct gtr_func_data *
675gtr_func_data_new( GSourceFunc function, gpointer data )
676{
677#if GTK_CHECK_VERSION( 2,10,0 )
678    struct gtr_func_data * d = g_slice_new( struct gtr_func_data );
679#else
680    struct gtr_func_data * d = g_new( struct gtr_func_data, 1 );
681#endif
682    d->function = function;
683    d->data = data;
684    return d;
685}
686
687static gboolean
688gtr_thread_func( gpointer data )
689{
690    gboolean more;
691    struct gtr_func_data * idle_data = data;
692
693    gdk_threads_enter( );
694    more = idle_data->function( idle_data->data );
695    gdk_threads_leave( );
696
697    return more;
698}
699#endif
700
701void
702gtr_idle_add( GSourceFunc function, gpointer data )
703{
704#if GTK_CHECK_VERSION( 2,12,0 )
705    gdk_threads_add_idle( function, data );
706#else
707    g_idle_add_full( G_PRIORITY_DEFAULT,
708                     gtr_thread_func,
709                     gtr_func_data_new( function, data ),
710                     gtr_func_data_free );
711#endif
712}
713
714guint
715gtr_timeout_add_seconds( guint seconds, GSourceFunc function, gpointer data )
716{
717#if GTK_CHECK_VERSION( 2,14,0 )
718    return gdk_threads_add_timeout_seconds( seconds, function, data );
719#elif GTK_CHECK_VERSION( 2,12,0 )
720    return gdk_threads_add_timeout( seconds*1000, function, data );
721#else
722    return g_timeout_add_full( G_PRIORITY_DEFAULT,
723                               seconds * 1000,
724                               gtr_thread_func,
725                               gtr_func_data_new( function, data ),
726                               gtr_func_data_free );
727#endif
728}
Note: See TracBrowser for help on using the repository browser.