bc8052f4842684efd954a878b81c9cfbbdaac512
[vlc.git] / modules / gui / macosx / update.m
1 /*****************************************************************************
2  * update.m: MacOS X Check-For-Update window
3  *****************************************************************************
4  * Copyright (C) 2005-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Felix K├╝hne <fkuehne@users.sf.net>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24
25 /*****************************************************************************
26  * Note: the code used to communicate with VLC's core was inspired by
27  * ../wxwidgets/dialogs/updatevlc.cpp, written by Antoine Cellerier.
28  *****************************************************************************/
29
30 #ifdef UPDATE_CHECK
31
32 /*****************************************************************************
33  * Preamble
34  *****************************************************************************/
35 #import "update.h"
36 #import "intf.h"
37
38 static NSString * kPrefUpdateOnStartup = @"UpdateOnStartup";
39 static NSString * kPrefUpdateLastTimeChecked = @"UpdateLastTimeChecked";
40
41 /*****************************************************************************
42  * VLCExtended implementation
43  *****************************************************************************/
44
45 @implementation VLCUpdate
46
47 static VLCUpdate *_o_sharedInstance = nil;
48
49 + (VLCUpdate *)sharedInstance
50 {
51     return _o_sharedInstance ? _o_sharedInstance : [[self alloc] init];
52 }
53
54 - (id)init
55 {
56     if( _o_sharedInstance ) {
57         [self dealloc];
58     } else {
59         _o_sharedInstance = [super init];
60     }
61
62     return _o_sharedInstance;
63 }
64
65 - (void)awakeFromNib
66 {
67     /* get up */
68     p_intf = VLCIntf;
69
70     /* clean the interface */
71     [o_fld_releaseNote setString: @""];
72  
73     [self initInterface];
74 }
75
76 - (void)dealloc
77 {
78     if( o_urlOfBinary )
79         [o_urlOfBinary release];
80
81     [super dealloc];
82 }
83
84 - (void)initInterface
85 {
86     /* translate strings to the user's language */
87     [o_update_window setTitle: _NS("Check for Updates")];
88     [o_btn_DownloadNow setTitle: _NS("Download now")];
89     [o_btn_okay setTitle: _NS("OK")];
90     [o_chk_updateOnStartup setTitle: _NS("Automatically check for updates")];
91     /* we don't use - (BOOL)shouldCheckUpdateOnStartup because we don't want the Alert
92      * panel to pop up at this time */
93     [o_chk_updateOnStartup setState: [[NSUserDefaults standardUserDefaults] boolForKey: kPrefUpdateOnStartup]];
94 }
95
96 - (void)setShouldCheckUpdate: (BOOL)check
97 {
98     [[NSUserDefaults standardUserDefaults] setBool: check forKey: kPrefUpdateOnStartup];
99     [o_chk_updateOnStartup setState: check];
100 }
101
102 - (BOOL)shouldCheckForUpdate
103 {
104     NSDate *o_last_update;
105     NSDate *o_next_update;
106  
107     if( ![[NSUserDefaults standardUserDefaults] objectForKey: kPrefUpdateOnStartup] )
108     {
109         /* We don't have any preferences stored, ask the user. */
110         int res = NSRunInformationalAlertPanel( _NS("Do you want VLC to check for updates automatically?"),
111               _NS("You can change this option in VLC's update window later on."), _NS("Yes"), _NS("No"), nil );
112         [self setShouldCheckUpdate: res];
113     }
114
115     if( ![[NSUserDefaults standardUserDefaults] boolForKey: kPrefUpdateOnStartup] )
116         return NO;
117
118     o_last_update = [[NSUserDefaults standardUserDefaults] objectForKey: kPrefUpdateLastTimeChecked];
119     if( !o_last_update )
120         return YES;
121
122     o_next_update = [[[NSDate alloc] initWithTimeInterval: 60*60*24*2 /* every two days */ sinceDate: o_last_update] autorelease];
123     if( !o_next_update )
124         return YES;
125
126     return [o_next_update compare: [NSDate date]] == NSOrderedAscending;
127 }
128
129 - (void)showUpdateWindow
130 {
131     /* show the window and check for a potential update */
132     [o_fld_status setStringValue: _NS("Checking for Updates...")];
133     [o_fld_currentVersionAndSize setStringValue: @""];
134     [o_fld_releaseNote setString: @""];
135
136     [o_update_window center];
137     [o_update_window displayIfNeeded];
138     [o_update_window makeKeyAndOrderFront:nil];
139
140     [o_bar_checking startAnimation: self];
141     [self checkForUpdate];
142     [o_bar_checking stopAnimation: self];
143 }
144
145 - (IBAction)download:(id)sender
146 {
147     /* provide a save dialogue */
148     SEL sel = @selector(getLocationForSaving:returnCode:contextInfo:);
149     NSSavePanel * saveFilePanel = [[NSSavePanel alloc] init];
150  
151     [saveFilePanel setRequiredFileType: @"dmg"];
152     [saveFilePanel setCanSelectHiddenExtension: YES];
153     [saveFilePanel setCanCreateDirectories: YES];
154     [saveFilePanel beginSheetForDirectory:nil file:
155         [[o_urlOfBinary componentsSeparatedByString:@"/"] lastObject]
156                            modalForWindow: o_update_window 
157                             modalDelegate:self
158                            didEndSelector:sel
159                               contextInfo:nil];
160 }
161
162 - (void)getLocationForSaving: (NSSavePanel *)sheet 
163                   returnCode: (int)returnCode 
164                  contextInfo: (void *)contextInfo
165 {
166     if( returnCode == NSOKButton )
167     {
168         /* perform download and pass the selected path */
169         [self performDownload: [sheet filename]];
170     }
171     [sheet release];
172 }
173
174 - (IBAction)okay:(id)sender
175 {
176     /* just close the window */
177     [o_update_window close];
178 }
179
180 - (IBAction)changeCheckUpdateOnStartup:(id)sender
181 {
182     [self setShouldCheckUpdate: [sender state]];
183 }
184
185 - (void)checkForUpdate
186 {
187     /* We may not run on first thread */
188     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
189     p_u = update_New( p_intf );
190     update_Check( p_u, VLC_FALSE );
191     update_iterator_t *p_uit = update_iterator_New( p_u );
192     BOOL releaseChecked = NO;
193     BOOL gettingReleaseNote = NO;
194     int x = 0;
195     NSString * pathToReleaseNote;
196     pathToReleaseNote = [NSString stringWithFormat:
197         @"/tmp/vlc_releasenote_%d.tmp", mdate()];
198
199     [[NSUserDefaults standardUserDefaults] setObject: [NSDate date] forKey: kPrefUpdateLastTimeChecked];
200
201     if( p_uit )
202     {
203         p_uit->i_rs = UPDATE_RELEASE_STATUS_NEWER;
204         p_uit->i_t = UPDATE_FILE_TYPE_ALL;
205         update_iterator_Action( p_uit, UPDATE_MIRROR );
206  
207         while( update_iterator_Action( p_uit, UPDATE_FILE) != UPDATE_FAIL )
208         {
209             msg_Dbg( p_intf, "parsing available updates, run %i", x );
210             /* if the announced item is of the type "binary", keep it and display
211              * its details to the user. Do similar stuff on "info". Do both
212              * only if the file is announced as stable */
213             if( p_uit->release.i_type == UPDATE_RELEASE_TYPE_STABLE )
214             {
215                 if( p_uit->file.i_type == UPDATE_FILE_TYPE_INFO )
216                 {
217                     msg_Dbg( p_intf, "release note found, desc = %s",
218                         p_uit->file.psz_description );
219                     [o_fld_releaseNote setString:
220                         [NSString stringWithUTF8String:
221                         (p_uit->file.psz_description)]];
222                     /* download our release note
223                      * We will read the temp file after this loop */
224                     update_download( p_uit, (char *)[pathToReleaseNote UTF8String] );
225                     gettingReleaseNote = YES;
226                 }
227                 else if( p_uit->file.i_type == UPDATE_FILE_TYPE_BINARY )
228                 {
229                     msg_Dbg( p_intf, "binary found, version = %s, "
230                         "url=%s, size=%i MB", p_uit->release.psz_version,
231                         p_uit->file.psz_url,
232                         (int)((p_uit->file.l_size / 1024) / 1024) );
233                     [o_fld_currentVersionAndSize setStringValue: 
234                         [NSString stringWithFormat:
235                         _NS("The latest VLC media player release "
236                             "is %s (%i MB to download)."),
237                         p_uit->release.psz_version, ((p_uit->file.l_size
238                         / 1024) / 1024)]];
239  
240                     if( o_urlOfBinary )
241                         [o_urlOfBinary release];
242                     o_urlOfBinary = [[NSString alloc] initWithUTF8String:
243                         p_uit->file.psz_url];
244                 }
245                 if( p_uit->release.i_status == UPDATE_RELEASE_STATUS_NEWER &&
246                     !releaseChecked )
247                 {
248                     /* our version is outdated, let the user download the new
249                      * release */
250                     [o_fld_status setStringValue: _NS("This version of VLC "
251                         "is outdated.")];
252                     [o_btn_DownloadNow setEnabled: YES];
253                     msg_Dbg( p_intf, "this version of VLC is outdated" );
254                     /* put the mirror information */
255                     msg_Dbg( p_intf, "used mirror: %s, %s [%s]",
256                             p_uit->mirror.psz_name, p_uit->mirror.psz_location,\
257                             p_uit->mirror.psz_type );
258                     /* make sure that we perform this check only once */
259                     releaseChecked = YES;
260                     /* Make sure the update window is showed in case we have something */
261                     [o_update_window center];
262                     [o_update_window displayIfNeeded];
263                     [o_update_window makeKeyAndOrderFront: self];
264
265                 }
266                 else if(! releaseChecked )
267                 {
268                     [o_fld_status setStringValue: _NS("This version of VLC "
269                         "is the latest available.")];
270                     [o_btn_DownloadNow setEnabled: NO];
271                     msg_Dbg( p_intf, "current version is up-to-date" );
272                     releaseChecked = YES;
273                 }
274             }
275             x += 1;
276         }
277
278         update_iterator_Delete( p_uit );
279
280         /* wait for our release notes if necessary, since the download is done
281          * by another thread -- this does usually take 300000 to 500000 ms */
282         if( gettingReleaseNote )
283         {
284             int i = 0;
285             while( [[NSFileManager defaultManager] fileExistsAtPath: pathToReleaseNote] == NO )
286             {
287                 msleep( 100000 );
288                 i += 1;
289                 if( i == 150 )
290                 {
291                     /* if this takes more than 15 sec, exit */
292                     msg_Warn( p_intf, "download took more than 15 sec, exiting" );
293                     break;
294                 }
295             }
296             msg_Dbg( p_intf, "waited %i ms for the release notes", (i * 100000) );
297             msleep( 500000 );
298
299             /* let's open our cached release note and display it
300              * we can't use NSString stringWithContentsOfFile:encoding:error:
301              * since it is Tiger only */
302             NSString * releaseNote = [[NSString alloc] initWithData:
303                 [NSData dataWithContentsOfFile: pathToReleaseNote]
304                 encoding: NSISOLatin1StringEncoding];
305             if( releaseNote )
306                 [o_fld_releaseNote setString: releaseNote];
307  
308             /* delete the file since it isn't needed anymore */
309             BOOL myBOOL = NO;
310             myBOOL = [[NSFileManager defaultManager] removeFileAtPath:
311                 pathToReleaseNote handler: nil];
312         }
313         else
314         {
315             /* don't confuse the user, but make her happy */
316             [o_fld_status setStringValue: _NS("This version of VLC "
317                 "is the latest available.")];
318             [o_btn_DownloadNow setEnabled: NO];
319             msg_Dbg( p_intf, "current version is up-to-date" );
320         }
321     }
322     [pool release];
323 }
324
325 - (void)performDownload:(NSString *)path
326 {
327     update_iterator_t *p_uit = update_iterator_New( p_u );
328     if( p_uit )
329     {
330         update_iterator_Action( p_uit, UPDATE_MIRROR );
331
332         while( update_iterator_Action( p_uit, UPDATE_FILE) != UPDATE_FAIL )
333         {
334             if( p_uit->release.i_type == UPDATE_RELEASE_TYPE_STABLE &&
335                 p_uit->release.i_status == UPDATE_RELEASE_STATUS_NEWER &&
336                 p_uit->file.i_type == UPDATE_FILE_TYPE_BINARY )
337             {
338                 /* put the mirror information */
339                 msg_Dbg( p_intf, "used mirror: %s, %s [%s]",
340                     p_uit->mirror.psz_name, p_uit->mirror.psz_location,
341                     p_uit->mirror.psz_type );
342
343                 /* that's our binary */
344                 update_download( p_uit, (char *)[path UTF8String] );
345             }
346         }
347  
348         update_iterator_Delete( p_uit );
349     }
350
351     [o_update_window close];
352 }
353
354 @end
355
356 #endif