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>
50 #include <vlc_dialog.h>
51 #include <vlc_interface.h>
54 #include <vlc_gcrypt.h>
59 #include "../libvlc.h"
61 /*****************************************************************************
63 *****************************************************************************/
66 * Here is the format of these "status files" :
67 * First line is the last version: "X.Y.Ze" where:
68 * * X is the major number
69 * * Y is the minor number
70 * * Z is the revision number
71 * * e is an OPTIONAL extra letter
72 * * AKA "0.8.6d" or "0.9.0"
73 * Second line is a url of the binary for this last version
74 * Remaining text is a required description of the update
77 #if defined( UNDER_CE )
78 # define UPDATE_VLC_STATUS_URL "http://update.videolan.org/vlc/status-ce"
79 #elif defined( WIN32 )
80 # define UPDATE_VLC_STATUS_URL "http://update.videolan.org/vlc/status-win-x86"
82 # define UPDATE_VLC_STATUS_URL "http://update.videolan.org/vlc/status"
86 /*****************************************************************************
88 *****************************************************************************/
92 * Create a new update VLC struct
94 * \param p_this the calling vlc_object
95 * \return pointer to new update_t or NULL
97 update_t *update_New( vlc_object_t *p_this )
102 p_update = (update_t *)malloc( sizeof( update_t ) );
103 if( !p_update ) return NULL;
105 vlc_mutex_init( &p_update->lock );
107 p_update->p_libvlc = p_this->p_libvlc;
109 p_update->release.psz_url = NULL;
110 p_update->release.psz_desc = NULL;
112 p_update->p_download = NULL;
113 p_update->p_check = NULL;
115 p_update->p_pkey = NULL;
122 * Delete an update_t struct
124 * \param p_update update_t* pointer
127 void update_Delete( update_t *p_update )
131 if( p_update->p_check )
133 vlc_object_kill( p_update->p_check );
134 vlc_thread_join( p_update->p_check );
135 vlc_object_release( p_update->p_check );
138 if( p_update->p_download )
140 vlc_object_kill( p_update->p_download );
141 vlc_thread_join( p_update->p_download );
142 vlc_object_release( p_update->p_download );
145 vlc_mutex_destroy( &p_update->lock );
147 free( p_update->release.psz_url );
148 free( p_update->release.psz_desc );
149 free( p_update->p_pkey );
155 * Empty the release struct
157 * \param p_update update_t* pointer
160 static void EmptyRelease( update_t *p_update )
162 p_update->release.i_major = 0;
163 p_update->release.i_minor = 0;
164 p_update->release.i_revision = 0;
166 FREENULL( p_update->release.psz_url );
167 FREENULL( p_update->release.psz_desc );
171 * Get the update file and parse it
172 * p_update has to be locked when calling this function
174 * \param p_update pointer to update struct
175 * \return true if the update is valid and authenticated
177 static bool GetUpdateFile( update_t *p_update )
179 stream_t *p_stream = NULL;
184 char *psz_version_line = NULL;
185 char *psz_update_data = NULL;
187 p_stream = stream_UrlNew( p_update->p_libvlc, UPDATE_VLC_STATUS_URL );
190 msg_Err( p_update->p_libvlc, "Failed to open %s for reading",
191 UPDATE_VLC_STATUS_URL );
195 const int64_t i_read = stream_Size( p_stream );
196 psz_update_data = malloc( i_read + 1 ); /* terminating '\0' */
197 if( !psz_update_data )
200 if( stream_Read( p_stream, psz_update_data, i_read ) != i_read )
202 msg_Err( p_update->p_libvlc, "Couldn't download update file %s",
203 UPDATE_VLC_STATUS_URL );
206 psz_update_data[i_read] = '\0';
208 stream_Delete( p_stream );
211 /* first line : version number */
212 char *psz_update_data_parser = psz_update_data;
213 size_t i_len = strcspn( psz_update_data, "\r\n" );
214 psz_update_data_parser += i_len;
215 while( *psz_update_data_parser == '\r' || *psz_update_data_parser == '\n' )
216 psz_update_data_parser++;
218 if( !(psz_version_line = malloc( i_len + 1)) )
220 strncpy( psz_version_line, psz_update_data, i_len );
221 psz_version_line[i_len] = '\0';
223 p_update->release.extra = 0;
224 switch( sscanf( psz_version_line, "%i.%i.%i%c",
225 &i_major, &i_minor, &i_revision, &extra ) )
228 p_update->release.extra = extra;
230 p_update->release.i_major = i_major;
231 p_update->release.i_minor = i_minor;
232 p_update->release.i_revision = i_revision;
235 msg_Err( p_update->p_libvlc, "Update version false formated" );
239 /* second line : URL */
240 i_len = strcspn( psz_update_data_parser, "\r\n" );
243 msg_Err( p_update->p_libvlc, "Update file %s is corrupted: URL missing",
244 UPDATE_VLC_STATUS_URL );
249 if( !(p_update->release.psz_url = malloc( i_len + 1)) )
251 strncpy( p_update->release.psz_url, psz_update_data_parser, i_len );
252 p_update->release.psz_url[i_len] = '\0';
254 psz_update_data_parser += i_len;
255 while( *psz_update_data_parser == '\r' || *psz_update_data_parser == '\n' )
256 psz_update_data_parser++;
258 /* Remaining data : description */
259 i_len = strlen( psz_update_data_parser );
262 msg_Err( p_update->p_libvlc,
263 "Update file %s is corrupted: description missing",
264 UPDATE_VLC_STATUS_URL );
268 if( !(p_update->release.psz_desc = malloc( i_len + 1)) )
270 strncpy( p_update->release.psz_desc, psz_update_data_parser, i_len );
271 p_update->release.psz_desc[i_len] = '\0';
273 /* Now that we know the status is valid, we must download its signature
274 * to authenticate it */
275 signature_packet_t sign;
276 if( download_signature( VLC_OBJECT( p_update->p_libvlc ), &sign,
277 UPDATE_VLC_STATUS_URL ) != VLC_SUCCESS )
279 msg_Err( p_update->p_libvlc, "Couldn't download signature of status file" );
283 if( sign.type != BINARY_SIGNATURE && sign.type != TEXT_SIGNATURE )
285 msg_Err( p_update->p_libvlc, "Invalid signature type" );
289 p_update->p_pkey = (public_key_t*)malloc( sizeof( public_key_t ) );
290 if( !p_update->p_pkey )
293 if( parse_public_key( videolan_public_key, sizeof( videolan_public_key ),
294 p_update->p_pkey, NULL ) != VLC_SUCCESS )
296 msg_Err( p_update->p_libvlc, "Couldn't parse embedded public key, something went really wrong..." );
297 FREENULL( p_update->p_pkey );
301 memcpy( p_update->p_pkey->longid, videolan_public_key_longid, 8 );
303 if( memcmp( sign.issuer_longid, p_update->p_pkey->longid , 8 ) != 0 )
305 msg_Dbg( p_update->p_libvlc, "Need to download the GPG key" );
306 public_key_t *p_new_pkey = download_key(
307 VLC_OBJECT(p_update->p_libvlc),
308 sign.issuer_longid, videolan_public_key_longid );
311 msg_Err( p_update->p_libvlc, "Couldn't download GPG key" );
312 FREENULL( p_update->p_pkey );
316 uint8_t *p_hash = hash_sha1_from_public_key( p_new_pkey );
319 msg_Err( p_update->p_libvlc, "Failed to hash signature" );
321 FREENULL( p_update->p_pkey );
325 if( verify_signature( p_new_pkey->sig.r, p_new_pkey->sig.s,
326 &p_update->p_pkey->key, p_hash ) == VLC_SUCCESS )
329 msg_Info( p_update->p_libvlc, "Key authenticated" );
330 free( p_update->p_pkey );
331 p_update->p_pkey = p_new_pkey;
336 msg_Err( p_update->p_libvlc, "Key signature invalid !" );
341 uint8_t *p_hash = hash_sha1_from_text( psz_update_data, &sign );
344 msg_Warn( p_update->p_libvlc, "Can't compute SHA1 hash for status file" );
348 else if( p_hash[0] != sign.hash_verification[0] ||
349 p_hash[1] != sign.hash_verification[1] )
351 msg_Warn( p_update->p_libvlc, "Bad SHA1 hash for status file" );
355 else if( verify_signature( sign.r, sign.s, &p_update->p_pkey->key, p_hash )
358 msg_Err( p_update->p_libvlc, "BAD SIGNATURE for status file" );
364 msg_Info( p_update->p_libvlc, "Status file authenticated" );
370 stream_Delete( p_stream );
371 free( psz_version_line );
372 free( psz_update_data );
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, update_CheckReal, VLC_THREAD_PRIORITY_LOW );
411 void* update_CheckReal( vlc_object_t* p_this )
413 update_check_thread_t *p_uct = (update_check_thread_t *)p_this;
417 canc = vlc_savecancel ();
418 vlc_mutex_lock( &p_uct->p_update->lock );
420 EmptyRelease( p_uct->p_update );
421 b_ret = GetUpdateFile( p_uct->p_update );
422 vlc_mutex_unlock( &p_uct->p_update->lock );
424 if( p_uct->pf_callback )
425 (p_uct->pf_callback)( p_uct->p_data, b_ret );
427 vlc_restorecancel (canc);
432 * Compare a given release's version number to the current VLC's one
434 * \param p_update structure
435 * \return true if we have to upgrade to the given version to be up to date
437 static bool is_strictly_greater( int * a, int * b, int n)
439 if( n <= 0 ) return false;
440 if(a[0] > b[0] ) return true;
441 if(a[0] == b[0] ) return is_strictly_greater( a+1, b+1, n-1 );
442 /* a[0] < b[0] */ return false;
445 bool update_NeedUpgrade( update_t *p_update )
449 int current_version[] = {
450 *PACKAGE_VERSION_MAJOR - '0',
451 *PACKAGE_VERSION_MINOR - '0',
452 *PACKAGE_VERSION_REVISION - '0',
453 /* extra string of development versions is "-git", "-rc" ..
454 * so make sure version a.b.c is newer than a.b.c-XXX */
455 (*PACKAGE_VERSION_EXTRA == '-') ? -1 : *PACKAGE_VERSION_EXTRA
457 int latest_version[] = {
458 p_update->release.i_major,
459 p_update->release.i_minor,
460 p_update->release.i_revision,
461 p_update->release.extra
464 return is_strictly_greater( latest_version, current_version, 4 );
468 * Convert a long int size in bytes to a string
470 * \param l_size the size in bytes
471 * \return the size as a string
473 static char *size_str( long int l_size )
475 char *psz_tmp = NULL;
478 i_retval = asprintf( &psz_tmp, _("%.1f GiB"), (float)l_size/(1<<30) );
479 else if( l_size >> 20 )
480 i_retval = asprintf( &psz_tmp, _("%.1f MiB"), (float)l_size/(1<<20) );
481 else if( l_size >> 10 )
482 i_retval = asprintf( &psz_tmp, _("%.1f KiB"), (float)l_size/(1<<10) );
484 i_retval = asprintf( &psz_tmp, _("%ld B"), l_size );
486 return i_retval == -1 ? NULL : psz_tmp;
489 static void* update_DownloadReal( vlc_object_t *p_this );
492 * Download the file given in the update_t
494 * \param p_update structure
495 * \param dir to store the download file
498 void update_Download( update_t *p_update, const char *psz_destdir )
502 // If the object already exist, destroy it
503 if( p_update->p_download )
505 vlc_object_kill( p_update->p_download );
506 vlc_thread_join( p_update->p_download );
507 vlc_object_release( p_update->p_download );
510 update_download_thread_t *p_udt =
511 vlc_custom_create( p_update->p_libvlc, sizeof( *p_udt ),
512 VLC_OBJECT_GENERIC, "update download" );
516 p_udt->p_update = p_update;
517 p_update->p_download = p_udt;
518 p_udt->psz_destdir = psz_destdir ? strdup( psz_destdir ) : NULL;
520 vlc_thread_create( p_udt, update_DownloadReal, 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;
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 = vlc_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 dialog_ProgressDestroy( p_progress );
636 vlc_unlink( psz_destfile );
640 signature_packet_t sign;
641 if( download_signature( VLC_OBJECT( p_udt ), &sign,
642 p_update->release.psz_url ) != VLC_SUCCESS )
644 vlc_unlink( psz_destfile );
646 dialog_FatalWait( p_udt, _("File could not be verified"),
647 _("It was not possible to download a cryptographic signature for "
648 "the downloaded file \"%s\". Thus, it was deleted."),
650 msg_Err( p_udt, "Couldn't download signature of downloaded file" );
654 if( memcmp( sign.issuer_longid, p_update->p_pkey->longid, 8 ) )
656 vlc_unlink( psz_destfile );
657 msg_Err( p_udt, "Invalid signature issuer" );
658 dialog_FatalWait( p_udt, _("Invalid signature"),
659 _("The cryptographic signature for the downloaded file \"%s\" was "
660 "invalid and could not be used to securely verify it. Thus, the "
661 "file was deleted."),
666 if( sign.type != BINARY_SIGNATURE )
668 vlc_unlink( psz_destfile );
669 msg_Err( p_udt, "Invalid signature type" );
670 dialog_FatalWait( p_udt, _("Invalid signature"),
671 _("The cryptographic signature for the downloaded file \"%s\" was "
672 "invalid and could not be used to securely verify it. Thus, the "
673 "file was deleted."),
678 uint8_t *p_hash = hash_sha1_from_file( psz_destfile, &sign );
681 msg_Err( p_udt, "Unable to hash %s", psz_destfile );
682 vlc_unlink( psz_destfile );
683 dialog_FatalWait( p_udt, _("File not verifiable"),
684 _("It was not possible to securely verify the downloaded file"
685 " \"%s\". Thus, it was deleted."),
691 if( p_hash[0] != sign.hash_verification[0] ||
692 p_hash[1] != sign.hash_verification[1] )
694 vlc_unlink( psz_destfile );
695 dialog_FatalWait( p_udt, _("File corrupted"),
696 _("Downloaded file \"%s\" was corrupted. Thus, it was deleted."),
698 msg_Err( p_udt, "Bad SHA1 hash for %s", psz_destfile );
703 if( verify_signature( sign.r, sign.s, &p_update->p_pkey->key, p_hash )
706 vlc_unlink( psz_destfile );
707 dialog_FatalWait( p_udt, _("File corrupted"),
708 _("Downloaded file \"%s\" was corrupted. Thus, it was deleted."),
710 msg_Err( p_udt, "BAD SIGNATURE for %s", psz_destfile );
715 msg_Info( p_udt, "%s authenticated", psz_destfile );
719 int answer = dialog_Question( p_udt, _("Update VLC media player"),
720 _("The new version was successfully downloaded. Do you want to close VLC and install it now?"),
721 _("Install"), _("Cancel"), NULL);
725 wchar_t psz_wdestfile[MAX_PATH];
726 MultiByteToWideChar( CP_UTF8, 0, psz_destfile, -1, psz_wdestfile, MAX_PATH );
727 answer = (int)ShellExecuteW( NULL, L"open", psz_wdestfile, NULL, NULL, SW_SHOW);
729 libvlc_Quit(p_this->p_libvlc);
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 )