summaryrefslogtreecommitdiff
path: root/frontends/cocoa/DownloadWindowController.m
blob: b8cf09b18865fdd209b6741f277762d3a2d64fc8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
/*
 * Copyright 2011 Sven Weidauer <sven.weidauer@gmail.com>
 *
 * This file is part of NetSurf, http://www.netsurf-browser.org/
 *
 * NetSurf is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * NetSurf is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#import "utils/log.h"
#import "utils/nsurl.h"
#import "desktop/download.h"
#import "netsurf/download.h"

#import "cocoa/DownloadWindowController.h"
#import "cocoa/gui.h"

@interface DownloadWindowController ()

@property (readwrite, retain, nonatomic) NSFileHandle *outputFile;
@property (readwrite, retain, nonatomic) NSMutableData *savedData;
@property (readwrite, copy, nonatomic) NSDate *startDate;

- (void)savePanelDidEnd:(NSSavePanel *)sheet returnCode:(int)returnCode contextInfo:(void *)contextInfo;
- (void)alertDidEnd:(NSAlert *)alert returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo;
- (void)askCancelDidEnd:(NSAlert *)alert returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo;

- (BOOL) receivedData: (NSData *)data;

- (void) showError: (NSString *)error;
- (void) downloadDone;
- (void) removeIfPossible;

@end

static void cocoa_unregister_download( DownloadWindowController *download );
static void cocoa_register_download( DownloadWindowController *download );


@implementation DownloadWindowController

- (id) initWithContext: (struct download_context *)ctx
{
        if ((self = [super initWithWindowNibName: @"DownloadWindow"]) == nil) {
                return nil;
        }

        context = ctx;
        totalSize = download_context_get_total_length( context );
        [self setURL: [NSURL URLWithString: [NSString stringWithUTF8String: nsurl_access(download_context_get_url( context ))]]];
        [self setMIMEType: [NSString stringWithUTF8String: download_context_get_mime_type( context )]];
        [self setStartDate: [NSDate date]];

        return self;
}

- (void) dealloc
{
        download_context_destroy( context );

        [self setURL: nil];
        [self setMIMEType: nil];
        [self setSaveURL: nil];
        [self setOutputFile: nil];
        [self setSavedData: nil];
        [self setStartDate: nil];

        [super dealloc];
}

- (void) abort
{
        download_context_abort( context );
        [self removeIfPossible];
}

- (void) askForSave
{
        canClose = NO;
        [[NSSavePanel savePanel]
                beginSheetForDirectory: nil
                                  file: [NSString stringWithUTF8String: download_context_get_filename( context )]
                        modalForWindow: [self window]
                         modalDelegate: self
                        didEndSelector: @selector(savePanelDidEnd:returnCode:contextInfo:)
                           contextInfo: NULL];
}

- (void) savePanelDidEnd:(NSSavePanel *)sheet returnCode:(int)returnCode contextInfo:(void *)contextInfo
{
        canClose = YES;

        if (returnCode == NSCancelButton) {
                [self abort];
                return;
        }

        NSURL *targetURL = [sheet URL];
        NSString *path = [targetURL path];

        [[NSFileManager defaultManager] createFileAtPath: path contents: nil attributes: nil];

        FSRef ref;
        if (CFURLGetFSRef( (CFURLRef)targetURL, &ref )) {
                NSDictionary *attributes = [NSDictionary dictionaryWithObjectsAndKeys:
                                                                 url, (NSString *)kLSQuarantineDataURLKey,
                                                         (NSString *)kLSQuarantineTypeWebDownload, (NSString *)kLSQuarantineTypeKey,
                                                         nil];
                LSSetItemAttribute( &ref, kLSRolesAll, kLSItemQuarantineProperties, (CFDictionaryRef)attributes );
                LOG("Set quarantine attributes on file %s", [path UTF8String]);
        }

        [self setOutputFile: [NSFileHandle fileHandleForWritingAtPath: path]];
        [self setSaveURL: targetURL];

        NSWindow *win = [self window];
        [win setRepresentedURL: targetURL];
        [win setTitle: [self fileName]];

        if (nil == outputFile) {
                [self performSelector: @selector(showError:) withObject: @"Cannot create file" afterDelay: 0];
                return;
        }

        if (nil != savedData) {
                [outputFile writeData: savedData];
                [self setSavedData: nil];
        }

        [self removeIfPossible];
}

- (BOOL) receivedData: (NSData *)data
{
        if (outputFile) {
                [outputFile writeData: data];
        } else {
                if (nil == savedData) {
                        [self setSavedData: [NSMutableData data]];
                }
                [savedData appendData: data];
        }

        [self setReceivedSize: receivedSize + [data length]];

        return YES;
}

- (void) showError: (NSString *)error
{
        canClose = NO;
        NSAlert *alert = [NSAlert alertWithMessageText: NSLocalizedString( @"Error", @"show error" )
                                         defaultButton: NSLocalizedString( @"OK", @"'OK' button" )
                                       alternateButton: nil otherButton: nil
                             informativeTextWithFormat: @"%@", error];

        [alert beginSheetModalForWindow: [self window] modalDelegate: self
                         didEndSelector: @selector(alertDidEnd:returnCode:contextInfo:)
                            contextInfo: NULL];
}

- (void) alertDidEnd:(NSAlert *)alert returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo
{
        [self abort];
}

- (void) removeIfPossible
{
        if (canClose && shouldClose) {
                cocoa_unregister_download( self );
        }
}
- (void) downloadDone
{
        shouldClose = YES;
        [self removeIfPossible];
}

- (BOOL) windowShouldClose: (id)sender
{
        if ([[NSUserDefaults standardUserDefaults] boolForKey: kAlwaysCancelDownload]) {
                return YES;
        }

        NSAlert *ask = [NSAlert alertWithMessageText: NSLocalizedString( @"Cancel download?", @"Download" )
                                       defaultButton: NSLocalizedString( @"Yes", @"" )
                                     alternateButton: NSLocalizedString( @"No", @"" )
                                         otherButton: nil
                           informativeTextWithFormat: NSLocalizedString( @"Should the download of '%@' really be cancelled?", @"Download" ),
                                [self fileName]];
        [ask setShowsSuppressionButton: YES];
        [ask beginSheetModalForWindow: [self window] modalDelegate: self
                       didEndSelector: @selector(askCancelDidEnd:returnCode:contextInfo:) contextInfo: NULL];
        return NO;
}

- (void) windowWillClose: (NSNotification *)notification
{
        [self abort];
}

- (void) askCancelDidEnd:(NSAlert *)alert returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo
{
        if (returnCode == NSOKButton) {
                [[NSUserDefaults standardUserDefaults]
                        setBool: [[alert suppressionButton] state] == NSOnState
                         forKey: kAlwaysCancelDownload];
                [self close];
        }
}

#pragma mark -
#pragma mark Properties

@synthesize URL = url;
@synthesize MIMEType = mimeType;
@synthesize totalSize;
@synthesize saveURL;
@synthesize outputFile;
@synthesize savedData;
@synthesize receivedSize;
@synthesize startDate;

+ (NSSet *) keyPathsForValuesAffectingStatusText
{
        return [NSSet setWithObjects: @"totalSize", @"receivedSize", nil];
}

#ifndef NSAppKitVersionNumber10_5
#define NSAppKitVersionNumber10_5 949
#endif

static NSString *cocoa_file_size_string( float size )
{
        static unsigned factor = 0;
        if (factor == 0) {
                if (floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_5) {
                        factor = 1000;
                } else {
                        factor = 1024;
                }
        }

        if (size == 0) return @"nothing";
        if (size <= 1.0) return @"1 byte";

        if (size < factor - 1) return [NSString stringWithFormat:@"%1.0f bytes",size];

        size /= factor;
        if (size < factor - 1) return [NSString stringWithFormat:@"%1.1f KB", size];

        size /= factor;
        if (size < factor - 1) return [NSString stringWithFormat:@"%1.1f MB", size];

        size /= factor;
        if (size < factor - 1) return [NSString stringWithFormat:@"%1.1f GB", size];

        size /= factor;
        return [NSString stringWithFormat:@"%1.1f TB", size];
}

static NSString *cocoa_time_string( unsigned seconds )
{
        if (seconds <= 10) {
                return NSLocalizedString(@"less than 10 seconds",
                                         @"time remaining" );
        }

        if (seconds < 60) {
                return [NSString stringWithFormat: NSLocalizedString( @"%u seconds",
                                                                      @"time remaining" ), seconds];
        }

        unsigned minutes = seconds / 60;
        seconds = seconds % 60;

        if (minutes < 60) {
                return [NSString stringWithFormat: NSLocalizedString( @"%u:%02u minutes",
                                                                      @"time remaining: minutes, seconds" ) , minutes, seconds];
        }

        unsigned hours = minutes / 60;
        minutes = minutes % 60;

        return [NSString stringWithFormat: NSLocalizedString( @"%2:%02u hours", @"time remaining: hours, minutes" ), hours, minutes];
}

- (NSString *) statusText
{
        NSString *speedString = @"";

        float speed = 0.0;
        NSTimeInterval elapsedTime = [[NSDate date] timeIntervalSinceDate: startDate];
        if (elapsedTime >= 0.1) {
                speed = (float)receivedSize / elapsedTime;
                speedString = [NSString stringWithFormat: @" (%@/s)", cocoa_file_size_string( speed )];
        }

        NSString *timeRemainingString = @"";
        NSString *totalSizeString = @"";
        if (totalSize != 0) {
                if (speed > 0.0) {
                        float timeRemaining = (float)(totalSize - receivedSize) / speed;
                        timeRemainingString = [NSString stringWithFormat: @": %@", cocoa_time_string( timeRemaining )];
                }
                totalSizeString = [NSString stringWithFormat: NSLocalizedString( @" of %@", @"... of (total size)" ), cocoa_file_size_string( totalSize )];
        }

        return [NSString stringWithFormat: @"%@%@%@%@", cocoa_file_size_string( receivedSize ),
                         totalSizeString, speedString, timeRemainingString];
}

+ (NSSet *) keyPathsForValuesAffectingFileName
{
        return [NSSet setWithObject: @"saveURL"];
}

- (NSString *) fileName
{
        return [[saveURL path] lastPathComponent];
}

+ (NSSet *) keyPathsForValuesAffectingIcon
{
        return [NSSet setWithObjects: @"mimeType", @"URL", nil];
}

- (NSImage *) icon;
{
        NSString *type = [(NSString *)UTTypeCreatePreferredIdentifierForTag( kUTTagClassMIMEType, (CFStringRef)mimeType, NULL ) autorelease];
        if ([type hasPrefix: @"dyn."] || [type isEqualToString: (NSString *)kUTTypeData]) {
                NSString *pathExt = [[url path] pathExtension];
                type = [(NSString *)UTTypeCreatePreferredIdentifierForTag( kUTTagClassFilenameExtension, (CFStringRef)pathExt, NULL ) autorelease];
        }
        return [[NSWorkspace sharedWorkspace] iconForFileType: type];
}


#pragma mark -
#pragma mark NetSurf interface functions

static struct gui_download_window *
gui_download_window_create(download_context *ctx,
                           struct gui_window *parent)
{
        DownloadWindowController * const window = [[DownloadWindowController alloc] initWithContext: ctx];
        cocoa_register_download( window );
        [window askForSave];
        [window release];

        return (struct gui_download_window *)window;
}

static nserror
gui_download_window_data(struct gui_download_window *dw,
                         const char *data,
                         unsigned int size)
{
        DownloadWindowController * const window = (DownloadWindowController *)dw;
        return [window receivedData: [NSData dataWithBytes: data length: size]] ? NSERROR_OK : NSERROR_SAVE_FAILED;
}

static void
gui_download_window_error(struct gui_download_window *dw,
                          const char *error_msg)
{
        DownloadWindowController * const window = (DownloadWindowController *)dw;
        [window showError: [NSString stringWithUTF8String: error_msg]];
}

static void
gui_download_window_done(struct gui_download_window *dw)
{
        DownloadWindowController * const window = (DownloadWindowController *)dw;
        [window downloadDone];
}

@end

#pragma mark -
static NSMutableSet *cocoa_all_downloads = nil;

static void
cocoa_register_download( DownloadWindowController *download )
{
        if (cocoa_all_downloads == nil) {
                cocoa_all_downloads = [[NSMutableSet alloc] init];
        }
        [cocoa_all_downloads addObject: download];
}

static void
cocoa_unregister_download( DownloadWindowController *download )
{
        [cocoa_all_downloads removeObject: download];
}


static struct gui_download_table download_table = {
        .create = gui_download_window_create,
        .data = gui_download_window_data,
        .error = gui_download_window_error,
        .done = gui_download_window_done,
};

struct gui_download_table *cocoa_download_table = &download_table;