1 /*****************************************************************************
2 * update.c: VLC update checking and downloading
3 *****************************************************************************
4 * Copyright © 2005-2008 the VideoLAN team
7 * Authors: Antoine Cellerier <dionoea -at- videolan -dot- org>
8 * Rémi Duraffort <ivoire at via.ecp.fr>
9 Rafaël Carré <funman@videolanorg>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either release 2 of the License, or
14 * (at your option) any later release.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
28 * This file contains functions related to VLC update management
31 /*****************************************************************************
33 *****************************************************************************/
39 #include <vlc_common.h>
40 #include <vlc_update.h>
46 #include <vlc_pgpkey.h>
47 #include <vlc_stream.h>
48 #include <vlc_strings.h>
49 #include <vlc_charset.h>
50 #include <vlc_dialog.h>
53 #include <vlc_gcrypt.h>
56 #include "../libvlc.h"
58 /*****************************************************************************
60 *****************************************************************************/
63 * Here is the format of these "status files" :
64 * First line is the last version: "X.Y.Ze" where:
65 * * X is the major number
66 * * Y is the minor number
67 * * Z is the revision number
68 * * e is an OPTIONAL extra letter
69 * * AKA "0.8.6d" or "0.9.0"
70 * Second line is an url of the binary for this last version
71 * Remaining text is a required description of the update
74 #if defined( UNDER_CE )
75 # define UPDATE_VLC_STATUS_URL "http://update.videolan.org/vlc/status-ce"
76 #elif defined( WIN32 )
77 # define UPDATE_VLC_STATUS_URL "http://update.videolan.org/vlc/status-win-x86"
78 #elif defined( __APPLE__ )
79 # if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
80 # define UPDATE_VLC_STATUS_URL "http://update.videolan.org/vlc/status-mac-ppc"
82 # define UPDATE_VLC_STATUS_URL "http://update.videolan.org/vlc/status-mac-x86"
84 #elif defined( SYS_BEOS )
85 # define UPDATE_VLC_STATUS_URL "http://update.videolan.org/vlc/status-beos-x86"
87 # define UPDATE_VLC_STATUS_URL "http://update.videolan.org/vlc/status"
91 /*****************************************************************************
93 *****************************************************************************/
94 static void EmptyRelease( update_t *p_update );
95 static bool GetUpdateFile( update_t *p_update );
96 static char * size_str( long int l_size );
100 /*****************************************************************************
102 *****************************************************************************/
105 * Create a new update VLC struct
107 * \param p_this the calling vlc_object
108 * \return pointer to new update_t or NULL
110 update_t *__update_New( vlc_object_t *p_this )
115 p_update = (update_t *)malloc( sizeof( update_t ) );
116 if( !p_update ) return NULL;
118 vlc_mutex_init( &p_update->lock );
120 p_update->p_libvlc = p_this->p_libvlc;
122 p_update->release.psz_url = NULL;
123 p_update->release.psz_desc = NULL;
125 p_update->p_download = NULL;
126 p_update->p_check = NULL;
128 p_update->p_pkey = NULL;
135 * Delete an update_t struct
137 * \param p_update update_t* pointer
140 void update_Delete( update_t *p_update )
144 if( p_update->p_check )
146 vlc_object_kill( p_update->p_check );
147 vlc_thread_join( p_update->p_check );
148 vlc_object_release( p_update->p_check );
151 if( p_update->p_download )
153 vlc_object_kill( p_update->p_download );
154 vlc_thread_join( p_update->p_download );
155 vlc_object_release( p_update->p_download );
158 vlc_mutex_destroy( &p_update->lock );
160 free( p_update->release.psz_url );
161 free( p_update->release.psz_desc );
162 free( p_update->p_pkey );
168 * Empty the release struct
170 * \param p_update update_t* pointer
173 static void EmptyRelease( update_t *p_update )
175 p_update->release.i_major = 0;
176 p_update->release.i_minor = 0;
177 p_update->release.i_revision = 0;
179 FREENULL( p_update->release.psz_url );
180 FREENULL( p_update->release.psz_desc );
184 * Get the update file and parse it
185 * p_update has to be locked when calling this function
187 * \param p_update pointer to update struct
188 * \return true if the update is valid and authenticated
190 static bool GetUpdateFile( update_t *p_update )
192 stream_t *p_stream = NULL;
197 char *psz_version_line = NULL;
199 p_stream = stream_UrlNew( p_update->p_libvlc, UPDATE_VLC_STATUS_URL );
202 msg_Err( p_update->p_libvlc, "Failed to open %s for reading",
203 UPDATE_VLC_STATUS_URL );
207 /* Start reading the status file */
208 if( !( psz_version_line = stream_ReadLine( p_stream ) ) )
210 msg_Err( p_update->p_libvlc, "Update file %s is corrupted : missing version",
211 UPDATE_VLC_STATUS_URL );
215 /* first line : version number */
216 p_update->release.extra = 0;
217 switch( sscanf( psz_version_line, "%i.%i.%i%c",
218 &i_major, &i_minor, &i_revision, &extra ) )
221 p_update->release.extra = extra;
223 p_update->release.i_major = i_major;
224 p_update->release.i_minor = i_minor;
225 p_update->release.i_revision = i_revision;
228 msg_Err( p_update->p_libvlc, "Update version false formated" );
232 /* second line : URL */
233 if( !( p_update->release.psz_url = stream_ReadLine( p_stream ) ) )
235 msg_Err( p_update->p_libvlc, "Update file %s is corrupted : URL missing",
236 UPDATE_VLC_STATUS_URL );
240 /* Remaining data : description */
241 int i_read = stream_Size( p_stream ) - stream_Tell( p_stream );
244 msg_Err( p_update->p_libvlc,
245 "Update file %s is corrupted: description missing",
246 UPDATE_VLC_STATUS_URL );
250 p_update->release.psz_desc = (char*) malloc( i_read + 1 );
251 if( !p_update->release.psz_desc )
254 if( stream_Read( p_stream, p_update->release.psz_desc, i_read ) != i_read )
256 msg_Err( p_update->p_libvlc, "Couldn't download update file %s",
257 UPDATE_VLC_STATUS_URL );
260 p_update->release.psz_desc[i_read] = '\0';
262 stream_Delete( p_stream );
265 /* Now that we know the status is valid, we must download its signature
266 * to authenticate it */
267 signature_packet_t sign;
268 if( download_signature( VLC_OBJECT( p_update->p_libvlc ), &sign,
269 UPDATE_VLC_STATUS_URL ) != VLC_SUCCESS )
271 msg_Err( p_update->p_libvlc, "Couldn't download signature of status file" );
275 if( sign.type != BINARY_SIGNATURE && sign.type != TEXT_SIGNATURE )
277 msg_Err( p_update->p_libvlc, "Invalid signature type" );
281 p_update->p_pkey = (public_key_t*)malloc( sizeof( public_key_t ) );
282 if( !p_update->p_pkey )
285 if( parse_public_key( videolan_public_key, sizeof( videolan_public_key ),
286 p_update->p_pkey, NULL ) != VLC_SUCCESS )
288 msg_Err( p_update->p_libvlc, "Couldn't parse embedded public key, something went really wrong..." );
289 FREENULL( p_update->p_pkey );
293 memcpy( p_update->p_pkey->longid, videolan_public_key_longid, 8 );
295 if( memcmp( sign.issuer_longid, p_update->p_pkey->longid , 8 ) != 0 )
297 msg_Dbg( p_update->p_libvlc, "Need to download the GPG key" );
298 public_key_t *p_new_pkey = download_key(
299 VLC_OBJECT(p_update->p_libvlc),
300 sign.issuer_longid, videolan_public_key_longid );
303 msg_Err( p_update->p_libvlc, "Couldn't download GPG key" );
304 FREENULL( p_update->p_pkey );
308 uint8_t *p_hash = hash_sha1_from_public_key( p_new_pkey );
311 msg_Err( p_update->p_libvlc, "Failed to hash signature" );
313 FREENULL( p_update->p_pkey );
317 if( verify_signature( p_new_pkey->sig.r, p_new_pkey->sig.s,
318 &p_update->p_pkey->key, p_hash ) == VLC_SUCCESS )
321 msg_Info( p_update->p_libvlc, "Key authenticated" );
322 free( p_update->p_pkey );
323 p_update->p_pkey = p_new_pkey;
328 msg_Err( p_update->p_libvlc, "Key signature invalid !\n" );
333 /* FIXME : read the status file all at once instead of line per line */
335 if( asprintf( &psz_text, "%s\n%s\n%s", psz_version_line,
336 p_update->release.psz_url, p_update->release.psz_desc ) == -1 )
340 FREENULL( psz_version_line );
342 uint8_t *p_hash = hash_sha1_from_text( psz_text, &sign );
345 msg_Warn( p_update->p_libvlc, "Can't compute SHA1 hash for status file" );
349 else if( p_hash[0] != sign.hash_verification[0] ||
350 p_hash[1] != sign.hash_verification[1] )
352 msg_Warn( p_update->p_libvlc, "Bad SHA1 hash for status file" );
356 else if( verify_signature( sign.r, sign.s, &p_update->p_pkey->key, p_hash )
359 msg_Err( p_update->p_libvlc, "BAD SIGNATURE for status file" );
365 msg_Info( p_update->p_libvlc, "Status file authenticated" );
371 stream_Delete( p_stream );
372 free( psz_version_line );
376 static void* update_CheckReal( vlc_object_t *p_this );
381 * \param p_update pointer to update struct
382 * \param pf_callback pointer to a function to call when the update_check is finished
383 * \param p_data pointer to some datas to give to the callback
386 void update_Check( update_t *p_update, void (*pf_callback)( void*, bool ), void *p_data )
390 // If the object already exist, destroy it
391 if( p_update->p_check )
393 vlc_object_kill( p_update->p_check );
394 vlc_thread_join( p_update->p_check );
395 vlc_object_release( p_update->p_check );
398 update_check_thread_t *p_uct =
399 vlc_custom_create( p_update->p_libvlc, sizeof( *p_uct ),
400 VLC_OBJECT_GENERIC, "update check" );
403 p_uct->p_update = p_update;
404 p_update->p_check = p_uct;
405 p_uct->pf_callback = pf_callback;
406 p_uct->p_data = p_data;
408 vlc_thread_create( p_uct, "check for update", update_CheckReal,
409 VLC_THREAD_PRIORITY_LOW );
412 void* update_CheckReal( vlc_object_t* p_this )
414 update_check_thread_t *p_uct = (update_check_thread_t *)p_this;
418 canc = vlc_savecancel ();
419 vlc_mutex_lock( &p_uct->p_update->lock );
421 EmptyRelease( p_uct->p_update );
422 b_ret = GetUpdateFile( p_uct->p_update );
423 vlc_mutex_unlock( &p_uct->p_update->lock );
425 if( p_uct->pf_callback )
426 (p_uct->pf_callback)( p_uct->p_data, b_ret );
428 vlc_restorecancel (canc);
433 * Compare a given release's version number to the current VLC's one
435 * \param p_update structure
436 * \return true if we have to upgrade to the given version to be up to date
438 static bool is_strictly_greater( int * a, int * b, int n)
440 if( n <= 0 ) return false;
441 if(a[0] > b[0] ) return true;
442 if(a[0] == b[0] ) return is_strictly_greater( a+1, b+1, n-1 );
443 /* a[0] < b[0] */ return false;
446 bool update_NeedUpgrade( update_t *p_update )
450 int current_version[] = {
451 *PACKAGE_VERSION_MAJOR - '0',
452 *PACKAGE_VERSION_MINOR - '0',
453 *PACKAGE_VERSION_REVISION - '0',
454 *PACKAGE_VERSION_EXTRA
456 int latest_version[] = {
457 p_update->release.i_major,
458 p_update->release.i_minor,
459 p_update->release.i_revision,
460 p_update->release.extra
463 return is_strictly_greater( latest_version, current_version, 4 );
467 * Convert a long int size in bytes to a string
469 * \param l_size the size in bytes
470 * \return the size as a string
472 static char *size_str( long int l_size )
474 char *psz_tmp = NULL;
477 i_retval = asprintf( &psz_tmp, _("%.1f GB"), (float)l_size/(1<<30) );
478 else if( l_size >> 20 )
479 i_retval = asprintf( &psz_tmp, _("%.1f MB"), (float)l_size/(1<<20) );
480 else if( l_size >> 10 )
481 i_retval = asprintf( &psz_tmp, _("%.1f kB"), (float)l_size/(1<<10) );
483 i_retval = asprintf( &psz_tmp, _("%ld B"), l_size );
485 return i_retval == -1 ? NULL : psz_tmp;
488 static void* update_DownloadReal( vlc_object_t *p_this );
491 * Download the file given in the update_t
493 * \param p_update structure
494 * \param dir to store the download file
497 void update_Download( update_t *p_update, const char *psz_destdir )
501 // If the object already exist, destroy it
502 if( p_update->p_download )
504 vlc_object_kill( p_update->p_download );
505 vlc_thread_join( p_update->p_download );
506 vlc_object_release( p_update->p_download );
509 update_download_thread_t *p_udt =
510 vlc_custom_create( p_update->p_libvlc, sizeof( *p_udt ),
511 VLC_OBJECT_GENERIC, "update download" );
515 p_udt->p_update = p_update;
516 p_update->p_download = p_udt;
517 p_udt->psz_destdir = psz_destdir ? strdup( psz_destdir ) : NULL;
519 vlc_thread_create( p_udt, "download update", update_DownloadReal,
520 VLC_THREAD_PRIORITY_LOW );
523 static void* update_DownloadReal( vlc_object_t *p_this )
525 update_download_thread_t *p_udt = (update_download_thread_t *)p_this;
526 dialog_progress_bar_t *p_progress = NULL;
528 long int l_downloaded = 0;
530 char *psz_status = NULL;
531 char *psz_downloaded = NULL;
532 char *psz_size = NULL;
533 char *psz_destfile = NULL;
534 char *psz_tmpdestfile = NULL;
537 stream_t *p_stream = NULL;
538 void* p_buffer = NULL;
542 update_t *p_update = p_udt->p_update;
543 char *psz_destdir = p_udt->psz_destdir;
545 msg_Dbg( p_udt, "Opening Stream '%s'", p_update->release.psz_url );
546 canc = vlc_savecancel ();
548 /* Open the stream */
549 p_stream = stream_UrlNew( p_udt, p_update->release.psz_url );
552 msg_Err( p_udt, "Failed to open %s for reading", p_update->release.psz_url );
556 /* Get the stream size */
557 l_size = stream_Size( p_stream );
559 /* Get the file name and open it*/
560 psz_tmpdestfile = strrchr( p_update->release.psz_url, '/' );
561 if( !psz_tmpdestfile )
563 msg_Err( p_udt, "The URL %s is badly formated",
564 p_update->release.psz_url );
568 if( asprintf( &psz_destfile, "%s%s", psz_destdir, psz_tmpdestfile ) == -1 )
571 p_file = utf8_fopen( psz_destfile, "w" );
574 msg_Err( p_udt, "Failed to open %s for writing", psz_destfile );
575 dialog_FatalWait( p_udt, _("Saving file failed"),
576 _("Failed to open \"%s\" for writing"),
581 /* Create a buffer and fill it with the downloaded file */
582 p_buffer = (void *)malloc( 1 << 10 );
585 msg_Err( p_udt, "Can't malloc (1 << 10) bytes! download cancelled." );
589 msg_Dbg( p_udt, "Downloading Stream '%s'", p_update->release.psz_url );
591 psz_size = size_str( l_size );
592 if( asprintf( &psz_status, _("%s\nDownloading... %s/%s %.1f%% done"),
593 p_update->release.psz_url, "0.0", psz_size, 0.0 ) != -1 )
595 p_progress = dialog_ProgressCreate( p_udt, _( "Downloading ..."),
596 psz_status, _("Cancel") );
600 while( vlc_object_alive( p_udt ) &&
601 ( i_read = stream_Read( p_stream, p_buffer, 1 << 10 ) ) &&
602 !dialog_ProgressCancelled( p_progress ) )
604 if( fwrite( p_buffer, i_read, 1, p_file ) < 1 )
606 msg_Err( p_udt, "Failed to write into %s", psz_destfile );
610 l_downloaded += i_read;
611 psz_downloaded = size_str( l_downloaded );
612 f_progress = (float)l_downloaded/(float)l_size;
614 if( asprintf( &psz_status, _( "%s\nDownloading... %s/%s - %.1f%% done" ),
615 p_update->release.psz_url, psz_downloaded, psz_size,
616 f_progress*100 ) != -1 )
618 dialog_ProgressSet( p_progress, psz_status, f_progress );
621 free( psz_downloaded );
624 /* Finish the progress bar or delete the file if the user had canceled */
628 if( vlc_object_alive( p_udt ) &&
629 !dialog_ProgressCancelled( p_progress ) )
631 if( asprintf( &psz_status, _("%s\nDone %s (100.0%%)"),
632 p_update->release.psz_url, psz_size ) != -1 )
634 dialog_ProgressDestroy( p_progress );
641 utf8_unlink( psz_destfile );
645 signature_packet_t sign;
646 if( download_signature( VLC_OBJECT( p_udt ), &sign,
647 p_update->release.psz_url ) != VLC_SUCCESS )
649 utf8_unlink( psz_destfile );
651 dialog_FatalWait( p_udt, _("File could not be verified"),
652 _("It was not possible to download a cryptographic signature for "
653 "the downloaded file \"%s\". Thus, it was deleted."),
655 msg_Err( p_udt, "Couldn't download signature of downloaded file" );
659 if( memcmp( sign.issuer_longid, p_update->p_pkey->longid, 8 ) )
661 utf8_unlink( psz_destfile );
662 msg_Err( p_udt, "Invalid signature issuer" );
663 dialog_FatalWait( p_udt, _("Invalid signature"),
664 _("The cryptographic signature for the downloaded file \"%s\" was "
665 "invalid and could not be used to securely verify it. Thus, the "
666 "file was deleted."),
671 if( sign.type != BINARY_SIGNATURE )
673 utf8_unlink( psz_destfile );
674 msg_Err( p_udt, "Invalid signature type" );
675 dialog_FatalWait( p_udt, _("Invalid signature"),
676 _("The cryptographic signature for the downloaded file \"%s\" was "
677 "invalid and could not be used to securely verify it. Thus, the "
678 "file was deleted."),
683 uint8_t *p_hash = hash_sha1_from_file( psz_destfile, &sign );
686 msg_Err( p_udt, "Unable to hash %s", psz_destfile );
687 utf8_unlink( psz_destfile );
688 dialog_FatalWait( p_udt, _("File not verifiable"),
689 _("It was not possible to securely verify the downloaded file"
690 " \"%s\". Thus, it was deleted."),
696 if( p_hash[0] != sign.hash_verification[0] ||
697 p_hash[1] != sign.hash_verification[1] )
699 utf8_unlink( psz_destfile );
700 dialog_FatalWait( p_udt, _("File corrupted"),
701 _("Downloaded file \"%s\" was corrupted. Thus, it was deleted."),
703 msg_Err( p_udt, "Bad SHA1 hash for %s", psz_destfile );
708 if( verify_signature( sign.r, sign.s, &p_update->p_pkey->key, p_hash )
711 utf8_unlink( psz_destfile );
712 dialog_FatalWait( p_udt, _("File corrupted"),
713 _("Downloaded file \"%s\" was corrupted. Thus, it was deleted."),
715 msg_Err( p_udt, "BAD SIGNATURE for %s", psz_destfile );
720 msg_Info( p_udt, "%s authenticated", psz_destfile );
725 dialog_ProgressDestroy( p_progress );
727 stream_Delete( p_stream );
731 free( psz_destfile );
735 vlc_restorecancel( canc );
739 update_release_t *update_GetRelease( update_t *p_update )
741 return &p_update->release;
745 update_t *__update_New( vlc_object_t *p_this )
751 void update_Delete( update_t *p_update )
756 void update_Check( update_t *p_update, void (*pf_callback)( void*, bool ),
759 (void)p_update; (void)pf_callback; (void)p_data;
762 bool update_NeedUpgrade( update_t *p_update )
768 void update_Download( update_t *p_update, const char *psz_destdir )
770 (void)p_update; (void)psz_destdir;
773 update_release_t *update_GetRelease( update_t *p_update )