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 *****************************************************************************/
97 * Create a new update VLC struct
99 * \param p_this the calling vlc_object
100 * \return pointer to new update_t or NULL
102 update_t *update_New( vlc_object_t *p_this )
107 p_update = (update_t *)malloc( sizeof( update_t ) );
108 if( !p_update ) return NULL;
110 vlc_mutex_init( &p_update->lock );
112 p_update->p_libvlc = p_this->p_libvlc;
114 p_update->release.psz_url = NULL;
115 p_update->release.psz_desc = NULL;
117 p_update->p_download = NULL;
118 p_update->p_check = NULL;
120 p_update->p_pkey = NULL;
127 * Delete an update_t struct
129 * \param p_update update_t* pointer
132 void update_Delete( update_t *p_update )
136 if( p_update->p_check )
138 vlc_object_kill( p_update->p_check );
139 vlc_thread_join( p_update->p_check );
140 vlc_object_release( p_update->p_check );
143 if( p_update->p_download )
145 vlc_object_kill( p_update->p_download );
146 vlc_thread_join( p_update->p_download );
147 vlc_object_release( p_update->p_download );
150 vlc_mutex_destroy( &p_update->lock );
152 free( p_update->release.psz_url );
153 free( p_update->release.psz_desc );
154 free( p_update->p_pkey );
160 * Empty the release struct
162 * \param p_update update_t* pointer
165 static void EmptyRelease( update_t *p_update )
167 p_update->release.i_major = 0;
168 p_update->release.i_minor = 0;
169 p_update->release.i_revision = 0;
171 FREENULL( p_update->release.psz_url );
172 FREENULL( p_update->release.psz_desc );
176 * Get the update file and parse it
177 * p_update has to be locked when calling this function
179 * \param p_update pointer to update struct
180 * \return true if the update is valid and authenticated
182 static bool GetUpdateFile( update_t *p_update )
184 stream_t *p_stream = NULL;
189 char *psz_version_line = NULL;
190 char *psz_update_data = NULL;
192 p_stream = stream_UrlNew( p_update->p_libvlc, UPDATE_VLC_STATUS_URL );
195 msg_Err( p_update->p_libvlc, "Failed to open %s for reading",
196 UPDATE_VLC_STATUS_URL );
200 const int64_t i_read = stream_Size( p_stream );
201 psz_update_data = malloc( i_read + 1 ); /* terminating '\0' */
202 if( !psz_update_data )
205 if( stream_Read( p_stream, psz_update_data, i_read ) != i_read )
207 msg_Err( p_update->p_libvlc, "Couldn't download update file %s",
208 UPDATE_VLC_STATUS_URL );
211 psz_update_data[i_read] = '\0';
213 stream_Delete( p_stream );
216 /* first line : version number */
217 char *psz_update_data_parser = psz_update_data;
218 size_t i_len = strcspn( psz_update_data, "\r\n" );
219 psz_update_data_parser += i_len;
220 while( *psz_update_data_parser == '\r' || *psz_update_data_parser == '\n' )
221 psz_update_data_parser++;
223 if( !(psz_version_line = malloc( i_len + 1)) )
225 strncpy( psz_version_line, psz_update_data, i_len );
226 psz_version_line[i_len] = '\0';
228 p_update->release.extra = 0;
229 switch( sscanf( psz_version_line, "%i.%i.%i%c",
230 &i_major, &i_minor, &i_revision, &extra ) )
233 p_update->release.extra = extra;
235 p_update->release.i_major = i_major;
236 p_update->release.i_minor = i_minor;
237 p_update->release.i_revision = i_revision;
240 msg_Err( p_update->p_libvlc, "Update version false formated" );
244 /* second line : URL */
245 i_len = strcspn( psz_update_data_parser, "\r\n" );
248 msg_Err( p_update->p_libvlc, "Update file %s is corrupted: URL missing",
249 UPDATE_VLC_STATUS_URL );
254 if( !(p_update->release.psz_url = malloc( i_len + 1)) )
256 strncpy( p_update->release.psz_url, psz_update_data_parser, i_len );
257 p_update->release.psz_url[i_len] = '\0';
259 psz_update_data_parser += i_len;
260 while( *psz_update_data_parser == '\r' || *psz_update_data_parser == '\n' )
261 psz_update_data_parser++;
263 /* Remaining data : description */
264 i_len = strlen( psz_update_data_parser );
267 msg_Err( p_update->p_libvlc,
268 "Update file %s is corrupted: description missing",
269 UPDATE_VLC_STATUS_URL );
273 if( !(p_update->release.psz_desc = malloc( i_len + 1)) )
275 strncpy( p_update->release.psz_desc, psz_update_data_parser, i_len );
276 p_update->release.psz_desc[i_len] = '\0';
278 printf("desc %s\n", p_update->release.psz_desc);
280 /* Now that we know the status is valid, we must download its signature
281 * to authenticate it */
282 signature_packet_t sign;
283 if( download_signature( VLC_OBJECT( p_update->p_libvlc ), &sign,
284 UPDATE_VLC_STATUS_URL ) != VLC_SUCCESS )
286 msg_Err( p_update->p_libvlc, "Couldn't download signature of status file" );
290 if( sign.type != BINARY_SIGNATURE && sign.type != TEXT_SIGNATURE )
292 msg_Err( p_update->p_libvlc, "Invalid signature type" );
296 p_update->p_pkey = (public_key_t*)malloc( sizeof( public_key_t ) );
297 if( !p_update->p_pkey )
300 if( parse_public_key( videolan_public_key, sizeof( videolan_public_key ),
301 p_update->p_pkey, NULL ) != VLC_SUCCESS )
303 msg_Err( p_update->p_libvlc, "Couldn't parse embedded public key, something went really wrong..." );
304 FREENULL( p_update->p_pkey );
308 memcpy( p_update->p_pkey->longid, videolan_public_key_longid, 8 );
310 if( memcmp( sign.issuer_longid, p_update->p_pkey->longid , 8 ) != 0 )
312 msg_Dbg( p_update->p_libvlc, "Need to download the GPG key" );
313 public_key_t *p_new_pkey = download_key(
314 VLC_OBJECT(p_update->p_libvlc),
315 sign.issuer_longid, videolan_public_key_longid );
318 msg_Err( p_update->p_libvlc, "Couldn't download GPG key" );
319 FREENULL( p_update->p_pkey );
323 uint8_t *p_hash = hash_sha1_from_public_key( p_new_pkey );
326 msg_Err( p_update->p_libvlc, "Failed to hash signature" );
328 FREENULL( p_update->p_pkey );
332 if( verify_signature( p_new_pkey->sig.r, p_new_pkey->sig.s,
333 &p_update->p_pkey->key, p_hash ) == VLC_SUCCESS )
336 msg_Info( p_update->p_libvlc, "Key authenticated" );
337 free( p_update->p_pkey );
338 p_update->p_pkey = p_new_pkey;
343 msg_Err( p_update->p_libvlc, "Key signature invalid !\n" );
348 uint8_t *p_hash = hash_sha1_from_text( psz_update_data, &sign );
351 msg_Warn( p_update->p_libvlc, "Can't compute SHA1 hash for status file" );
355 else if( p_hash[0] != sign.hash_verification[0] ||
356 p_hash[1] != sign.hash_verification[1] )
358 msg_Warn( p_update->p_libvlc, "Bad SHA1 hash for status file" );
362 else if( verify_signature( sign.r, sign.s, &p_update->p_pkey->key, p_hash )
365 msg_Err( p_update->p_libvlc, "BAD SIGNATURE for status file" );
371 msg_Info( p_update->p_libvlc, "Status file authenticated" );
377 stream_Delete( p_stream );
378 free( psz_version_line );
379 free( psz_update_data );
383 static void* update_CheckReal( vlc_object_t *p_this );
388 * \param p_update pointer to update struct
389 * \param pf_callback pointer to a function to call when the update_check is finished
390 * \param p_data pointer to some datas to give to the callback
393 void update_Check( update_t *p_update, void (*pf_callback)( void*, bool ), void *p_data )
397 // If the object already exist, destroy it
398 if( p_update->p_check )
400 vlc_object_kill( p_update->p_check );
401 vlc_thread_join( p_update->p_check );
402 vlc_object_release( p_update->p_check );
405 update_check_thread_t *p_uct =
406 vlc_custom_create( p_update->p_libvlc, sizeof( *p_uct ),
407 VLC_OBJECT_GENERIC, "update check" );
410 p_uct->p_update = p_update;
411 p_update->p_check = p_uct;
412 p_uct->pf_callback = pf_callback;
413 p_uct->p_data = p_data;
415 vlc_thread_create( p_uct, "check for update", update_CheckReal,
416 VLC_THREAD_PRIORITY_LOW );
419 void* update_CheckReal( vlc_object_t* p_this )
421 update_check_thread_t *p_uct = (update_check_thread_t *)p_this;
425 canc = vlc_savecancel ();
426 vlc_mutex_lock( &p_uct->p_update->lock );
428 EmptyRelease( p_uct->p_update );
429 b_ret = GetUpdateFile( p_uct->p_update );
430 vlc_mutex_unlock( &p_uct->p_update->lock );
432 if( p_uct->pf_callback )
433 (p_uct->pf_callback)( p_uct->p_data, b_ret );
435 vlc_restorecancel (canc);
440 * Compare a given release's version number to the current VLC's one
442 * \param p_update structure
443 * \return true if we have to upgrade to the given version to be up to date
445 static bool is_strictly_greater( int * a, int * b, int n)
447 if( n <= 0 ) return false;
448 if(a[0] > b[0] ) return true;
449 if(a[0] == b[0] ) return is_strictly_greater( a+1, b+1, n-1 );
450 /* a[0] < b[0] */ return false;
453 bool update_NeedUpgrade( update_t *p_update )
457 int current_version[] = {
458 *PACKAGE_VERSION_MAJOR - '0',
459 *PACKAGE_VERSION_MINOR - '0',
460 *PACKAGE_VERSION_REVISION - '0',
461 /* extra string of development versions is "-git", "-rc" ..
462 * so make sure version a.b.c is newer than a.b.c-XXX */
463 (*PACKAGE_VERSION_EXTRA == '-') ? -1 : *PACKAGE_VERSION_EXTRA
465 int latest_version[] = {
466 p_update->release.i_major,
467 p_update->release.i_minor,
468 p_update->release.i_revision,
469 p_update->release.extra
472 return is_strictly_greater( latest_version, current_version, 4 );
476 * Convert a long int size in bytes to a string
478 * \param l_size the size in bytes
479 * \return the size as a string
481 static char *size_str( long int l_size )
483 char *psz_tmp = NULL;
486 i_retval = asprintf( &psz_tmp, _("%.1f GB"), (float)l_size/(1<<30) );
487 else if( l_size >> 20 )
488 i_retval = asprintf( &psz_tmp, _("%.1f MB"), (float)l_size/(1<<20) );
489 else if( l_size >> 10 )
490 i_retval = asprintf( &psz_tmp, _("%.1f kB"), (float)l_size/(1<<10) );
492 i_retval = asprintf( &psz_tmp, _("%ld B"), l_size );
494 return i_retval == -1 ? NULL : psz_tmp;
497 static void* update_DownloadReal( vlc_object_t *p_this );
500 * Download the file given in the update_t
502 * \param p_update structure
503 * \param dir to store the download file
506 void update_Download( update_t *p_update, const char *psz_destdir )
510 // If the object already exist, destroy it
511 if( p_update->p_download )
513 vlc_object_kill( p_update->p_download );
514 vlc_thread_join( p_update->p_download );
515 vlc_object_release( p_update->p_download );
518 update_download_thread_t *p_udt =
519 vlc_custom_create( p_update->p_libvlc, sizeof( *p_udt ),
520 VLC_OBJECT_GENERIC, "update download" );
524 p_udt->p_update = p_update;
525 p_update->p_download = p_udt;
526 p_udt->psz_destdir = psz_destdir ? strdup( psz_destdir ) : NULL;
528 vlc_thread_create( p_udt, "download update", update_DownloadReal,
529 VLC_THREAD_PRIORITY_LOW );
532 static void* update_DownloadReal( vlc_object_t *p_this )
534 update_download_thread_t *p_udt = (update_download_thread_t *)p_this;
535 dialog_progress_bar_t *p_progress = NULL;
537 long int l_downloaded = 0;
539 char *psz_status = NULL;
540 char *psz_downloaded = NULL;
541 char *psz_size = NULL;
542 char *psz_destfile = NULL;
543 char *psz_tmpdestfile = NULL;
546 stream_t *p_stream = NULL;
547 void* p_buffer = NULL;
551 update_t *p_update = p_udt->p_update;
552 char *psz_destdir = p_udt->psz_destdir;
554 msg_Dbg( p_udt, "Opening Stream '%s'", p_update->release.psz_url );
555 canc = vlc_savecancel ();
557 /* Open the stream */
558 p_stream = stream_UrlNew( p_udt, p_update->release.psz_url );
561 msg_Err( p_udt, "Failed to open %s for reading", p_update->release.psz_url );
565 /* Get the stream size */
566 l_size = stream_Size( p_stream );
568 /* Get the file name and open it*/
569 psz_tmpdestfile = strrchr( p_update->release.psz_url, '/' );
570 if( !psz_tmpdestfile )
572 msg_Err( p_udt, "The URL %s is badly formated",
573 p_update->release.psz_url );
577 if( asprintf( &psz_destfile, "%s%s", psz_destdir, psz_tmpdestfile ) == -1 )
580 p_file = utf8_fopen( psz_destfile, "w" );
583 msg_Err( p_udt, "Failed to open %s for writing", psz_destfile );
584 dialog_FatalWait( p_udt, _("Saving file failed"),
585 _("Failed to open \"%s\" for writing"),
590 /* Create a buffer and fill it with the downloaded file */
591 p_buffer = (void *)malloc( 1 << 10 );
594 msg_Err( p_udt, "Can't malloc (1 << 10) bytes! download cancelled." );
598 msg_Dbg( p_udt, "Downloading Stream '%s'", p_update->release.psz_url );
600 psz_size = size_str( l_size );
601 if( asprintf( &psz_status, _("%s\nDownloading... %s/%s %.1f%% done"),
602 p_update->release.psz_url, "0.0", psz_size, 0.0 ) != -1 )
604 p_progress = dialog_ProgressCreate( p_udt, _( "Downloading ..."),
605 psz_status, _("Cancel") );
609 while( vlc_object_alive( p_udt ) &&
610 ( i_read = stream_Read( p_stream, p_buffer, 1 << 10 ) ) &&
611 !dialog_ProgressCancelled( p_progress ) )
613 if( fwrite( p_buffer, i_read, 1, p_file ) < 1 )
615 msg_Err( p_udt, "Failed to write into %s", psz_destfile );
619 l_downloaded += i_read;
620 psz_downloaded = size_str( l_downloaded );
621 f_progress = (float)l_downloaded/(float)l_size;
623 if( asprintf( &psz_status, _( "%s\nDownloading... %s/%s - %.1f%% done" ),
624 p_update->release.psz_url, psz_downloaded, psz_size,
625 f_progress*100 ) != -1 )
627 dialog_ProgressSet( p_progress, psz_status, f_progress );
630 free( psz_downloaded );
633 /* Finish the progress bar or delete the file if the user had canceled */
637 if( vlc_object_alive( p_udt ) &&
638 !dialog_ProgressCancelled( p_progress ) )
640 if( asprintf( &psz_status, _("%s\nDone %s (100.0%%)"),
641 p_update->release.psz_url, psz_size ) != -1 )
643 dialog_ProgressDestroy( p_progress );
650 utf8_unlink( psz_destfile );
654 signature_packet_t sign;
655 if( download_signature( VLC_OBJECT( p_udt ), &sign,
656 p_update->release.psz_url ) != VLC_SUCCESS )
658 utf8_unlink( psz_destfile );
660 dialog_FatalWait( p_udt, _("File could not be verified"),
661 _("It was not possible to download a cryptographic signature for "
662 "the downloaded file \"%s\". Thus, it was deleted."),
664 msg_Err( p_udt, "Couldn't download signature of downloaded file" );
668 if( memcmp( sign.issuer_longid, p_update->p_pkey->longid, 8 ) )
670 utf8_unlink( psz_destfile );
671 msg_Err( p_udt, "Invalid signature issuer" );
672 dialog_FatalWait( p_udt, _("Invalid signature"),
673 _("The cryptographic signature for the downloaded file \"%s\" was "
674 "invalid and could not be used to securely verify it. Thus, the "
675 "file was deleted."),
680 if( sign.type != BINARY_SIGNATURE )
682 utf8_unlink( psz_destfile );
683 msg_Err( p_udt, "Invalid signature type" );
684 dialog_FatalWait( p_udt, _("Invalid signature"),
685 _("The cryptographic signature for the downloaded file \"%s\" was "
686 "invalid and could not be used to securely verify it. Thus, the "
687 "file was deleted."),
692 uint8_t *p_hash = hash_sha1_from_file( psz_destfile, &sign );
695 msg_Err( p_udt, "Unable to hash %s", psz_destfile );
696 utf8_unlink( psz_destfile );
697 dialog_FatalWait( p_udt, _("File not verifiable"),
698 _("It was not possible to securely verify the downloaded file"
699 " \"%s\". Thus, it was deleted."),
705 if( p_hash[0] != sign.hash_verification[0] ||
706 p_hash[1] != sign.hash_verification[1] )
708 utf8_unlink( psz_destfile );
709 dialog_FatalWait( p_udt, _("File corrupted"),
710 _("Downloaded file \"%s\" was corrupted. Thus, it was deleted."),
712 msg_Err( p_udt, "Bad SHA1 hash for %s", psz_destfile );
717 if( verify_signature( sign.r, sign.s, &p_update->p_pkey->key, p_hash )
720 utf8_unlink( psz_destfile );
721 dialog_FatalWait( p_udt, _("File corrupted"),
722 _("Downloaded file \"%s\" was corrupted. Thus, it was deleted."),
724 msg_Err( p_udt, "BAD SIGNATURE for %s", psz_destfile );
729 msg_Info( p_udt, "%s authenticated", psz_destfile );
734 dialog_ProgressDestroy( p_progress );
736 stream_Delete( p_stream );
740 free( psz_destfile );
744 vlc_restorecancel( canc );
748 update_release_t *update_GetRelease( update_t *p_update )
750 return &p_update->release;
755 update_t *update_New( vlc_object_t *p_this )
761 void update_Delete( update_t *p_update )
766 void update_Check( update_t *p_update, void (*pf_callback)( void*, bool ),
769 (void)p_update; (void)pf_callback; (void)p_data;
772 bool update_NeedUpgrade( update_t *p_update )
778 void update_Download( update_t *p_update, const char *psz_destdir )
780 (void)p_update; (void)psz_destdir;
783 update_release_t *update_GetRelease( update_t *p_update )