1 /*****************************************************************************
2 * update.c: VLC update checking and downloading
3 *****************************************************************************
4 * Copyright © 2005-2008 VLC authors and VideoLAN
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 it
12 * under the terms of the GNU Lesser 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 Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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.Z.E" 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 number
72 * * IE "1.2.0" or "1.1.10.1"
73 * Second line is a url of the binary for this last version
74 * Remaining text is a required description of the update
78 # define UPDATE_OS_SUFFIX "-win-x64"
79 #elif defined( WIN32 )
80 # define UPDATE_OS_SUFFIX "-win-x86"
82 # define UPDATE_OS_SUFFIX ""
86 # define UPDATE_VLC_STATUS_URL "http://update-test.videolan.org/vlc/status-win-x86"
88 # define UPDATE_VLC_STATUS_URL "http://update.videolan.org/vlc/status" UPDATE_OS_SUFFIX
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_join( p_update->p_check->thread, NULL );
139 free( p_update->p_check );
142 if( p_update->p_download )
144 vlc_atomic_set( &p_update->p_download->aborted, 1 );
145 vlc_join( p_update->p_download->thread, NULL );
146 vlc_object_release( p_update->p_download );
149 vlc_mutex_destroy( &p_update->lock );
151 free( p_update->release.psz_url );
152 free( p_update->release.psz_desc );
153 free( p_update->p_pkey );
159 * Empty the release struct
161 * \param p_update update_t* pointer
164 static void EmptyRelease( update_t *p_update )
166 p_update->release.i_major = 0;
167 p_update->release.i_minor = 0;
168 p_update->release.i_revision = 0;
170 FREENULL( p_update->release.psz_url );
171 FREENULL( p_update->release.psz_desc );
175 * Get the update file and parse it
176 * p_update has to be locked when calling this function
178 * \param p_update pointer to update struct
179 * \return true if the update is valid and authenticated
181 static bool GetUpdateFile( update_t *p_update )
183 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.i_extra = 0;
224 int ret = sscanf( psz_version_line, "%i.%i.%i.%i",
225 &p_update->release.i_major, &p_update->release.i_minor,
226 &p_update->release.i_revision, &p_update->release.i_extra);
227 if( ret != 3 && ret != 4 )
229 msg_Err( p_update->p_libvlc, "Update version false formated" );
233 /* second line : URL */
234 i_len = strcspn( psz_update_data_parser, "\r\n" );
237 msg_Err( p_update->p_libvlc, "Update file %s is corrupted: URL missing",
238 UPDATE_VLC_STATUS_URL );
243 if( !(p_update->release.psz_url = malloc( i_len + 1)) )
245 strncpy( p_update->release.psz_url, psz_update_data_parser, i_len );
246 p_update->release.psz_url[i_len] = '\0';
248 psz_update_data_parser += i_len;
249 while( *psz_update_data_parser == '\r' || *psz_update_data_parser == '\n' )
250 psz_update_data_parser++;
252 /* Remaining data : description */
253 i_len = strlen( psz_update_data_parser );
256 msg_Err( p_update->p_libvlc,
257 "Update file %s is corrupted: description missing",
258 UPDATE_VLC_STATUS_URL );
262 if( !(p_update->release.psz_desc = malloc( i_len + 1)) )
264 strncpy( p_update->release.psz_desc, psz_update_data_parser, i_len );
265 p_update->release.psz_desc[i_len] = '\0';
267 /* Now that we know the status is valid, we must download its signature
268 * to authenticate it */
269 signature_packet_t sign;
270 if( download_signature( VLC_OBJECT( p_update->p_libvlc ), &sign,
271 UPDATE_VLC_STATUS_URL ) != VLC_SUCCESS )
273 msg_Err( p_update->p_libvlc, "Couldn't download signature of status file" );
277 if( sign.type != BINARY_SIGNATURE && sign.type != TEXT_SIGNATURE )
279 msg_Err( p_update->p_libvlc, "Invalid signature type" );
283 p_update->p_pkey = (public_key_t*)malloc( sizeof( public_key_t ) );
284 if( !p_update->p_pkey )
287 if( parse_public_key( videolan_public_key, sizeof( videolan_public_key ),
288 p_update->p_pkey, NULL ) != VLC_SUCCESS )
290 msg_Err( p_update->p_libvlc, "Couldn't parse embedded public key, something went really wrong..." );
291 FREENULL( p_update->p_pkey );
295 memcpy( p_update->p_pkey->longid, videolan_public_key_longid, 8 );
297 if( memcmp( sign.issuer_longid, p_update->p_pkey->longid , 8 ) != 0 )
299 msg_Dbg( p_update->p_libvlc, "Need to download the GPG key" );
300 public_key_t *p_new_pkey = download_key(
301 VLC_OBJECT(p_update->p_libvlc),
302 sign.issuer_longid, videolan_public_key_longid );
305 msg_Err( p_update->p_libvlc, "Couldn't download GPG key" );
306 FREENULL( p_update->p_pkey );
310 uint8_t *p_hash = hash_sha1_from_public_key( p_new_pkey );
313 msg_Err( p_update->p_libvlc, "Failed to hash signature" );
315 FREENULL( p_update->p_pkey );
319 if( verify_signature( p_new_pkey->sig.r, p_new_pkey->sig.s,
320 &p_update->p_pkey->key, p_hash ) == VLC_SUCCESS )
323 msg_Info( p_update->p_libvlc, "Key authenticated" );
324 free( p_update->p_pkey );
325 p_update->p_pkey = p_new_pkey;
330 msg_Err( p_update->p_libvlc, "Key signature invalid !" );
335 uint8_t *p_hash = hash_sha1_from_text( psz_update_data, &sign );
338 msg_Warn( p_update->p_libvlc, "Can't compute SHA1 hash for status file" );
342 else if( p_hash[0] != sign.hash_verification[0] ||
343 p_hash[1] != sign.hash_verification[1] )
345 msg_Warn( p_update->p_libvlc, "Bad SHA1 hash for status file" );
349 else if( verify_signature( sign.r, sign.s, &p_update->p_pkey->key, p_hash )
352 msg_Err( p_update->p_libvlc, "BAD SIGNATURE for status file" );
358 msg_Info( p_update->p_libvlc, "Status file authenticated" );
364 stream_Delete( p_stream );
365 free( psz_version_line );
366 free( psz_update_data );
370 static void* update_CheckReal( void * );
375 * \param p_update pointer to update struct
376 * \param pf_callback pointer to a function to call when the update_check is finished
377 * \param p_data pointer to some datas to give to the callback
380 void update_Check( update_t *p_update, void (*pf_callback)( void*, bool ), void *p_data )
384 // If the object already exist, destroy it
385 if( p_update->p_check )
387 vlc_join( p_update->p_check->thread, NULL );
388 free( p_update->p_check );
391 update_check_thread_t *p_uct = calloc( 1, sizeof( *p_uct ) );
394 p_uct->p_update = p_update;
395 p_update->p_check = p_uct;
396 p_uct->pf_callback = pf_callback;
397 p_uct->p_data = p_data;
399 vlc_clone( &p_uct->thread, update_CheckReal, p_uct, VLC_THREAD_PRIORITY_LOW );
402 void* update_CheckReal( void *obj )
404 update_check_thread_t *p_uct = (update_check_thread_t *)obj;
408 canc = vlc_savecancel ();
409 vlc_mutex_lock( &p_uct->p_update->lock );
411 EmptyRelease( p_uct->p_update );
412 b_ret = GetUpdateFile( p_uct->p_update );
413 vlc_mutex_unlock( &p_uct->p_update->lock );
415 if( p_uct->pf_callback )
416 (p_uct->pf_callback)( p_uct->p_data, b_ret );
418 vlc_restorecancel (canc);
422 bool update_NeedUpgrade( update_t *p_update )
426 static const int current[4] = {
427 PACKAGE_VERSION_MAJOR,
428 PACKAGE_VERSION_MINOR,
429 PACKAGE_VERSION_REVISION,
430 PACKAGE_VERSION_EXTRA
432 const int latest[4] = {
433 p_update->release.i_major,
434 p_update->release.i_minor,
435 p_update->release.i_revision,
436 p_update->release.i_extra
439 for (unsigned i = 0; i < sizeof latest / sizeof *latest; i++) {
440 /* there is a new version available */
441 if (latest[i] > current[i])
444 /* current version is more recent than the latest version ?! */
445 if (latest[i] < current[i])
449 /* current version is not a release, it's a -git or -rc version */
450 if (*PACKAGE_VERSION_DEV)
453 /* current version is latest version */
458 * Convert a long int size in bytes to a string
460 * \param l_size the size in bytes
461 * \return the size as a string
463 static char *size_str( long int l_size )
465 char *psz_tmp = NULL;
468 i_retval = asprintf( &psz_tmp, _("%.1f GiB"), (float)l_size/(1<<30) );
469 else if( l_size >> 20 )
470 i_retval = asprintf( &psz_tmp, _("%.1f MiB"), (float)l_size/(1<<20) );
471 else if( l_size >> 10 )
472 i_retval = asprintf( &psz_tmp, _("%.1f KiB"), (float)l_size/(1<<10) );
474 i_retval = asprintf( &psz_tmp, _("%ld B"), l_size );
476 return i_retval == -1 ? NULL : psz_tmp;
479 static void* update_DownloadReal( void * );
482 * Download the file given in the update_t
484 * \param p_update structure
485 * \param dir to store the download file
488 void update_Download( update_t *p_update, const char *psz_destdir )
492 // If the object already exist, destroy it
493 if( p_update->p_download )
495 vlc_atomic_set( &p_update->p_download->aborted, 1 );
496 vlc_join( p_update->p_download->thread, NULL );
497 vlc_object_release( p_update->p_download );
500 update_download_thread_t *p_udt =
501 vlc_custom_create( p_update->p_libvlc, sizeof( *p_udt ),
506 p_udt->p_update = p_update;
507 p_update->p_download = p_udt;
508 p_udt->psz_destdir = psz_destdir ? strdup( psz_destdir ) : NULL;
510 vlc_atomic_set(&p_udt->aborted, 0);
511 vlc_clone( &p_udt->thread, update_DownloadReal, p_udt, VLC_THREAD_PRIORITY_LOW );
514 static void* update_DownloadReal( void *obj )
516 update_download_thread_t *p_udt = (update_download_thread_t *)obj;
517 dialog_progress_bar_t *p_progress = NULL;
519 long int l_downloaded = 0;
522 char *psz_downloaded = NULL;
523 char *psz_size = NULL;
524 char *psz_destfile = NULL;
525 char *psz_tmpdestfile = NULL;
528 stream_t *p_stream = NULL;
529 void* p_buffer = NULL;
533 update_t *p_update = p_udt->p_update;
534 char *psz_destdir = p_udt->psz_destdir;
536 msg_Dbg( p_udt, "Opening Stream '%s'", p_update->release.psz_url );
537 canc = vlc_savecancel ();
539 /* Open the stream */
540 p_stream = stream_UrlNew( p_udt, p_update->release.psz_url );
543 msg_Err( p_udt, "Failed to open %s for reading", p_update->release.psz_url );
547 /* Get the stream size */
548 l_size = stream_Size( p_stream );
550 /* Get the file name and open it*/
551 psz_tmpdestfile = strrchr( p_update->release.psz_url, '/' );
552 if( !psz_tmpdestfile )
554 msg_Err( p_udt, "The URL %s is badly formated",
555 p_update->release.psz_url );
559 if( asprintf( &psz_destfile, "%s%s", psz_destdir, psz_tmpdestfile ) == -1 )
562 p_file = vlc_fopen( psz_destfile, "w" );
565 msg_Err( p_udt, "Failed to open %s for writing", psz_destfile );
566 dialog_FatalWait( p_udt, _("Saving file failed"),
567 _("Failed to open \"%s\" for writing"),
572 /* Create a buffer and fill it with the downloaded file */
573 p_buffer = (void *)malloc( 1 << 10 );
574 if( unlikely(p_buffer == NULL) )
577 msg_Dbg( p_udt, "Downloading Stream '%s'", p_update->release.psz_url );
579 psz_size = size_str( l_size );
580 if( asprintf( &psz_status, _("%s\nDownloading... %s/%s %.1f%% done"),
581 p_update->release.psz_url, "0.0", psz_size, 0.0 ) == -1 )
584 p_progress = dialog_ProgressCreate( p_udt, _( "Downloading ..."),
585 psz_status, _("Cancel") );
588 if( p_progress == NULL )
591 while( !vlc_atomic_get( &p_udt->aborted ) &&
592 ( i_read = stream_Read( p_stream, p_buffer, 1 << 10 ) ) &&
593 !dialog_ProgressCancelled( p_progress ) )
595 if( fwrite( p_buffer, i_read, 1, p_file ) < 1 )
597 msg_Err( p_udt, "Failed to write into %s", psz_destfile );
601 l_downloaded += i_read;
602 psz_downloaded = size_str( l_downloaded );
603 f_progress = (float)l_downloaded/(float)l_size;
605 if( asprintf( &psz_status, _( "%s\nDownloading... %s/%s - %.1f%% done" ),
606 p_update->release.psz_url, psz_downloaded, psz_size,
607 f_progress*100 ) != -1 )
609 dialog_ProgressSet( p_progress, psz_status, f_progress );
612 free( psz_downloaded );
615 /* Finish the progress bar or delete the file if the user had canceled */
619 if( !vlc_atomic_get( &p_udt->aborted ) &&
620 !dialog_ProgressCancelled( p_progress ) )
622 dialog_ProgressDestroy( p_progress );
627 vlc_unlink( psz_destfile );
631 signature_packet_t sign;
632 if( download_signature( VLC_OBJECT( p_udt ), &sign,
633 p_update->release.psz_url ) != VLC_SUCCESS )
635 vlc_unlink( psz_destfile );
637 dialog_FatalWait( p_udt, _("File could not be verified"),
638 _("It was not possible to download a cryptographic signature for "
639 "the downloaded file \"%s\". Thus, it was deleted."),
641 msg_Err( p_udt, "Couldn't download signature of downloaded file" );
645 if( memcmp( sign.issuer_longid, p_update->p_pkey->longid, 8 ) )
647 vlc_unlink( psz_destfile );
648 msg_Err( p_udt, "Invalid signature issuer" );
649 dialog_FatalWait( p_udt, _("Invalid signature"),
650 _("The cryptographic signature for the downloaded file \"%s\" was "
651 "invalid and could not be used to securely verify it. Thus, the "
652 "file was deleted."),
657 if( sign.type != BINARY_SIGNATURE )
659 vlc_unlink( psz_destfile );
660 msg_Err( p_udt, "Invalid signature type" );
661 dialog_FatalWait( p_udt, _("Invalid signature"),
662 _("The cryptographic signature for the downloaded file \"%s\" was "
663 "invalid and could not be used to securely verify it. Thus, the "
664 "file was deleted."),
669 uint8_t *p_hash = hash_sha1_from_file( psz_destfile, &sign );
672 msg_Err( p_udt, "Unable to hash %s", psz_destfile );
673 vlc_unlink( psz_destfile );
674 dialog_FatalWait( p_udt, _("File not verifiable"),
675 _("It was not possible to securely verify the downloaded file"
676 " \"%s\". Thus, it was deleted."),
682 if( p_hash[0] != sign.hash_verification[0] ||
683 p_hash[1] != sign.hash_verification[1] )
685 vlc_unlink( psz_destfile );
686 dialog_FatalWait( p_udt, _("File corrupted"),
687 _("Downloaded file \"%s\" was corrupted. Thus, it was deleted."),
689 msg_Err( p_udt, "Bad SHA1 hash for %s", psz_destfile );
694 if( verify_signature( sign.r, sign.s, &p_update->p_pkey->key, p_hash )
697 vlc_unlink( psz_destfile );
698 dialog_FatalWait( p_udt, _("File corrupted"),
699 _("Downloaded file \"%s\" was corrupted. Thus, it was deleted."),
701 msg_Err( p_udt, "BAD SIGNATURE for %s", psz_destfile );
706 msg_Info( p_udt, "%s authenticated", psz_destfile );
710 int answer = dialog_Question( p_udt, _("Update VLC media player"),
711 _("The new version was successfully downloaded. Do you want to close VLC and install it now?"),
712 _("Install"), _("Cancel"), NULL);
716 wchar_t psz_wdestfile[MAX_PATH];
717 MultiByteToWideChar( CP_UTF8, 0, psz_destfile, -1, psz_wdestfile, MAX_PATH );
718 answer = (int)ShellExecuteW( NULL, L"open", psz_wdestfile, NULL, NULL, SW_SHOW);
720 libvlc_Quit(p_udt->p_libvlc);
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;
746 update_t *update_New( vlc_object_t *p_this )
752 void update_Delete( update_t *p_update )
757 void update_Check( update_t *p_update, void (*pf_callback)( void*, bool ),
760 (void)p_update; (void)pf_callback; (void)p_data;
763 bool update_NeedUpgrade( update_t *p_update )
769 void update_Download( update_t *p_update, const char *psz_destdir )
771 (void)p_update; (void)psz_destdir;
774 update_release_t *update_GetRelease( update_t *p_update )