File: CameraController.m

package info (click to toggle)
camera.app 0.8.0-10
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 212 kB
  • sloc: objc: 952; makefile: 19
file content (618 lines) | stat: -rw-r--r-- 15,932 bytes parent folder | download | duplicates (6)
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618

// created 11.2003 by Stefan Kleine Stegemann
// 
// licensed under GPL


#include "CameraController.h"
#include "OpenPanelAddons.h"

#include <Foundation/NSUserDefaults.h>
#include <Foundation/NSString.h>
#include <Foundation/NSException.h>
#include <Foundation/NSCalendarDate.h>
#include <Foundation/NSPathUtilities.h>
#include <Foundation/NSThread.h>
#include <Foundation/NSArray.h>
#include <Foundation/NSEnumerator.h>
#include <Foundation/NSFileManager.h>
#include <Foundation/NSValue.h>
#include <Foundation/NSDictionary.h>
#include <AppKit/NSApplication.h>
#include <AppKit/NSButton.h>
#include <AppKit/NSProgressIndicator.h>
#include <AppKit/NSImageView.h>
#include <AppKit/NSWindow.h>
#include <AppKit/NSPanel.h>
#include <AppKit/NSOpenPanel.h>
#include <AppKit/NSTextField.h>
#include <AppKit/NSWorkspace.h>


NSString* PREF_DOWNLOAD_BASE_PATH = @"DownloadBasePath";
NSString* PREF_USE_TIMESTAMP_DIR  = @"UseTimestampDirectory";

static NSString* DEFAULT_DOWNLOAD_PATH  =  @"Multimedia/Pictures/Photos";
static NSString* DOWNLOAD_PATH          =  @"DownloadPath";
static NSString* CAMERA                 =  @"Camera";
static NSString* FILES_TO_DOWNLOAD      =  @"FilesToDownload";
static NSString* DELETE_FILES           =  @"DeleteFilesAfterDownload";
static NSString* GOTO_DOWNLOAD_LOCATION =  @"GotoDownloadLocation";

// this is a temporary workaround to disable
// thumbnails on systems that use wraster for
// jpeg processing. this is not multi-thread-
// capable.
static BOOL WithThumbnails;


/*
 * Non-Public methods.
 */
@interface CameraController(Private)
- (void) _downloadFiles: (id)params;
- (NSString*) _downloadBasePath;
- (void) _ensurePathExists: (NSString*)path;
- (NSString*) _getUnusedFilenameBasedOn: (NSString*)filename;
- (NSImage*) _defaultThumbnail;
@end


/*
 * Controls the Camera Application.
 */
@implementation CameraController

/*
 * Designated initializer.
 */
- (id) init
{
   if ((self = [super init]))
   {
      selectedCamera = nil;
      [self setDownloadIsActive: NO];
   }

   return self;
}


- (void) dealloc
{
   [self setSelectedCamera: nil];
   [super dealloc];
}


/*
 * only as long as we need to take care about
 * wraster-based guis
 */
+ (void) initialize
{
   NSUserDefaults* defs = [NSUserDefaults standardUserDefaults];
   NSMutableDictionary* standardDefaults = [NSMutableDictionary dictionary];
   NSString* defaultDestination;

   // use timestamp directory by default
   [standardDefaults setObject: [NSNumber numberWithBool: YES]
                     forKey: PREF_USE_TIMESTAMP_DIR];

   defaultDestination = [NSHomeDirectory() stringByAppendingPathComponent:
                                           DEFAULT_DOWNLOAD_PATH];
   [standardDefaults setObject: defaultDestination forKey: PREF_DOWNLOAD_BASE_PATH];

   [defs registerDefaults: standardDefaults];
   
   // use thumbnails?
   WithThumbnails = [defs boolForKey: @"WithThumbnails"];
}


- (void) awakeFromNib
{
   [self downloadFinished];
   [progressInfoMsg setStringValue: @""];

   // remove thumbnail if thumbnails are disabled
   if (!WithThumbnails)
   {
      float height = [thumbnailView frame].size.height;

      NSRect frame = [window frame];
      frame.size.height -=  height;      
      [thumbnailView removeFromSuperview];
      [window setFrame: frame display: YES];

      [cameraInfo setFrameOrigin: NSMakePoint([cameraInfo frame].origin.x,
                                              [cameraInfo frame].origin.y - height)];

      [cameraIcon setFrameOrigin: NSMakePoint([cameraIcon frame].origin.x,
                                              [cameraIcon frame].origin.y - height)];
   }

   [self detectCamera: nil];
}


/*
 * Tries to detect a connected camera.
 */
- (void) detectCamera: (id)sender
{
   NSArray* cameras;

   cameras = [DigitalCamera autodetectCameras];
   if ([cameras count])
   {
      // use the first detected camera
      [self setSelectedCamera: [cameras objectAtIndex: 0]];
   }
   else
   {
      [self setSelectedCamera: nil];
   }
}


/*
 * Set the selected camera.
 */
- (void) setSelectedCamera: (DigitalCamera*)aCamera
{
   RELEASE(selectedCamera);
   selectedCamera = aCamera;
   RETAIN(selectedCamera);
   
   if (selectedCamera)
   {
      [cameraInfo setStringValue: [aCamera name]];
      NSLog(@"using camera %@ at port %@", [aCamera name], [aCamera portName]);
   }
   else
   {
      [cameraInfo setStringValue: @"no camera"];
   }
}


/*
 * Get the selected camera.
 */
- (DigitalCamera*) selectedCamera
{
   return selectedCamera;
}


/*
 * Set a status that indicates whether a download
 * is active at the moment.
 */
- (void) setDownloadIsActive: (BOOL)active
{
   downloadIsActive = active;
}


/*
 * Returns YES if a download is currently active.
 */
- (BOOL) downloadIsActive
{
   return downloadIsActive;
}


/*
 * Start downloading the files from the selected
 * Camera.
 */
- (void) initiateDownloadFiles: (id)sender
{
   NSMutableDictionary* threadParams;
   NSString*            downloadPath;
   BOOL                 deleteFiles;
   NSArray*             files;

   if (![self selectedCamera])
   {
      // TODO: localize this
      NSRunAlertPanel(@"Error while downloading files!",
                      @"No camera was found on your system.",
                      @"Confirm", nil, nil);
      return;
   }

   // initiate download parameters
   downloadPath = [self _downloadBasePath];
   [self _ensurePathExists: downloadPath];
   
   deleteFiles = ([deleteFilesAfterDownload state] == NSOnState);
   // TODO: save in user prefs

   files = [[self selectedCamera] availableFiles];
   if ([files count] == 0)
   {
      // TODO: localize this
      NSRunAlertPanel(@"Nothing to download!",
                      @"There are no files on this camera.",
                      @"Confirm", nil, nil);
      return;
   }


   // adjust progressbar min/max
   [progressBar setMinValue: 0];
   if (!deleteFiles)
   {
      [progressBar setMaxValue: [files count]];
   }
   else
   {
      // add 1/4 for deleting
      [progressBar setMaxValue: ([files count] + ([files count] * 0.25))];
   }


   // detach a thread that downloads the files
   threadParams = [[NSMutableDictionary alloc] initWithCapacity: 0];
   [threadParams setObject: downloadPath forKey: DOWNLOAD_PATH];
   [threadParams setObject: [self selectedCamera] forKey: CAMERA];
   [threadParams setObject: files forKey: FILES_TO_DOWNLOAD];
   [threadParams setObject: [NSNumber numberWithBool: deleteFiles] forKey: DELETE_FILES];
   [threadParams setObject: [NSNumber numberWithBool: YES] forKey: GOTO_DOWNLOAD_LOCATION];

   [self setDownloadIsActive: YES];
   [NSThread detachNewThreadSelector: @selector(_downloadFiles:)
             toTarget: self
             withObject: threadParams];


   // the user can now abort the download
   [transferButton setTitle: @"Abort"];
}


/*
 * Abort the currently running download. If no
 * download is active, nothing happens.
 */
- (void) abortDownloadFiles: (id)sender
{
   [transferButton setEnabled: NO];
   // will be re-enabled by downloadFinished
   [self setDownloadIsActive: NO];
}


/*
 * If no download is active, this method will intiate one.
 * Otherwise, the active download will be aborted.
 */
- (void) initiateOrAbortDownload: (id)sender
{
   if (![self downloadIsActive])
   {
      [self initiateDownloadFiles: sender];
   }
   else
   {
      [self abortDownloadFiles: sender];
   }
}


/*
 * Let the User select the destination directory
 * where the downloaded files should go into.
 */
- (void) setDestination: (id)sender
{
   NSUserDefaults*  defs = [NSUserDefaults standardUserDefaults];
   id               panel;
   id               accessoryView;
   int              answer;

   panel = [NSOpenPanel openPanel];
   [panel setCanChooseDirectories: YES];
   [panel setCanChooseFiles: NO];
   [panel setAllowsMultipleSelection: NO];
   [panel setTitle: @"Set download Destination"];

   accessoryView = [OpenPanelAccessoryView accessoryView];
   [accessoryView setUseTimestampeDirectory: [defs boolForKey: PREF_USE_TIMESTAMP_DIR]];
   [panel setAccessoryView: accessoryView];
   
   answer = [panel runModalForDirectory:  [defs stringForKey: PREF_DOWNLOAD_BASE_PATH] 
                   file: nil
                   types: nil];

   if (answer == NSOKButton)
   {
      [defs setObject: [[panel filenames] objectAtIndex: 0]
            forKey: PREF_DOWNLOAD_BASE_PATH];
      [defs setObject: [NSNumber numberWithBool: [accessoryView useTimestampDirectory]]
            forKey: PREF_USE_TIMESTAMP_DIR];
   }
}


/*
 * Update the progress information about the
 * current download. Thumbnail may be nil
 * of not available for downloaded file.
 */
- (void) willDownloadFile: (DigitalCameraFile*)file
                       at: (int)index
                       of: (int)total
                thumbnail: (NSImage*)thumbnail
{
   NSString* msg;

   msg = [NSString stringWithFormat: @"download %@ (%d of %d) ....",
                   [file filename], index, total];
   
   [progressInfoMsg setStringValue: msg];
   NSLog(msg);

   if (thumbnail)
   {
      [thumbnailView setImage: thumbnail];
   }

   [progressBar setDoubleValue: index];
}


/*
 * Inform the controller the a file file will
 * be deleted from the camera.
 */
- (void) willDeleteFile: (DigitalCameraFile*)file
                     at: (int)index
                     of: (int)total
{
   NSString* msg;
   
   msg = [NSString stringWithFormat: @"delete file %@ (%d of %d) ....",
                   [file filename], index, total];
   
   [progressInfoMsg setStringValue: msg];
   NSLog(msg);

   [progressBar setDoubleValue: (total + (index * 0.25))];
}


/*
 * Invoked when the download has finished.
 */
- (void) downloadFinished;
{
   NSLog(@"download finished");
   [self setDownloadIsActive: NO];

   // TODO: reset all UI elements
   [progressInfoMsg setStringValue: @"download complete"];
   [progressBar setDoubleValue: 0.0];
   [transferButton setTitle: @"Download Files"];
   [transferButton setEnabled: YES];
}


@end



@implementation CameraController(Private)

/*
 * Download all files from the camera. This method
 * is intended to be used in a separate thread. The
 * controller is notified about the progress.
 */
- (void) _downloadFiles: (id)params
{
   NSString*           downloadPath = [params objectForKey: DOWNLOAD_PATH];
   DigitalCamera*      camera = [params objectForKey: CAMERA];
   NSArray*            files  = [params objectForKey: FILES_TO_DOWNLOAD];
   BOOL                deleteFiles  = [[params objectForKey: DELETE_FILES] boolValue];
   BOOL                gotoDownloadLocation = [[params objectForKey: GOTO_DOWNLOAD_LOCATION]
                                                 boolValue];
   NSEnumerator*       e;
   DigitalCameraFile*  aFile;
   NSImage*            aThumbnail = nil;
   int                 counter;
   NSString*           targetFile;
   NSAutoreleasePool*  autoreleasePool;
   BOOL                aborted;

   autoreleasePool = [[NSAutoreleasePool alloc] init];

   NSAssert(downloadPath, @"no download path");
   NSAssert(camera, @"no camera");
   NSAssert(files, @"no files");

   // download the files
   counter = 0;
   e = [files objectEnumerator];
   while ((aFile = [e nextObject]) && [self downloadIsActive])
   {
      counter++;

      if (WithThumbnails)
      {
         aThumbnail = [camera thumbnailForFile: aFile];
         if (!aThumbnail)
         {
            aThumbnail = [self _defaultThumbnail];
         }
      }

      [self willDownloadFile: aFile
            at: counter
            of: [files count] 
            thumbnail: aThumbnail];
      
      targetFile = [downloadPath stringByAppendingPathComponent: [aFile filename]];
      targetFile = [self _getUnusedFilenameBasedOn: targetFile];

      [camera downloadFile: aFile to: targetFile];
   }


   // delete files if requested
   if (deleteFiles)
   {
      counter = 0;
      e = [files objectEnumerator];
      while ((aFile = [e nextObject]) && [self downloadIsActive])
      {
         counter++;

         [self willDeleteFile: aFile
               at: counter
               of: [files count]];

         [camera deleteFile: aFile];
      }
   }

   aborted = ![self downloadIsActive];
   [self downloadFinished];
   
   // open the download location in workspace (if not aborted)
   if (!aborted && gotoDownloadLocation)
   {
      [[NSWorkspace sharedWorkspace] noteFileSystemChanged];
      [[NSWorkspace sharedWorkspace] selectFile: downloadPath
                                     inFileViewerRootedAtPath:
                                        [downloadPath stringByDeletingLastPathComponent]];      
   }

   RELEASE(autoreleasePool);
}


/*
 * Returns a default image that can be used instead
 * of a thumbnail.
 */
- (NSImage*) _defaultThumbnail
{
   static NSImage* DefaultThumbnail = nil;
   if (!DefaultThumbnail)
   {
      NSLog(@"loading default thumbnail");
      DefaultThumbnail = [NSImage imageNamed: @"no_thumbnail.jpg"];
      [DefaultThumbnail setScalesWhenResized: NO];
      RETAIN(DefaultThumbnail);
   }

   return DefaultThumbnail;
}


/*
 * Returns the base path to where images should
 * be downloaded.
 */
- (NSString*) _downloadBasePath
{
   NSUserDefaults*  defs = [NSUserDefaults standardUserDefaults];
   NSString*        basePath;
   BOOL             useTimestampDir;
   NSCalendarDate*  now;
   NSString*        timestampDir;

   basePath = [defs stringForKey: PREF_DOWNLOAD_BASE_PATH];

   useTimestampDir = [defs boolForKey: PREF_USE_TIMESTAMP_DIR];
   if (useTimestampDir)
   {
      now = [NSCalendarDate calendarDate];
      timestampDir = [NSString stringWithFormat: @"%4d%2d%2d",
                               [now yearOfCommonEra],
                               [now monthOfYear],
                               [now dayOfMonth]];

      basePath = [basePath stringByAppendingPathComponent: timestampDir];
      basePath = [self _getUnusedFilenameBasedOn: basePath];
   }

   return basePath;
}


/*
 * Ensures that a directory exists. If necessary, the
 * complete path will be created (like mkdir -p).
 */
- (void) _ensurePathExists: (NSString*)path
{
   NSEnumerator*   e;
   NSString*       currentPath = @"";
   NSString*       aPathComp;
   NSFileManager*  fileman = [NSFileManager defaultManager];
   BOOL            success;

   e = [[path pathComponents] objectEnumerator];
   while ((aPathComp = [e nextObject]))
   {
      currentPath = [currentPath stringByAppendingPathComponent: aPathComp];

      if (![fileman fileExistsAtPath: currentPath])
      {
         NSLog(@"directory %@ does not exist, create it", currentPath);
         success = [fileman createDirectoryAtPath: currentPath
                            attributes: nil];
         
         NSAssert(success, [@"Failed to create directory: "
                                stringByAppendingString: currentPath]);
      }
      else
      {
         NSLog(@"directory %@ exists, good", currentPath);
      }
   }
}


/*
 * ....
 */
- (NSString*) _getUnusedFilenameBasedOn: (NSString*)filename
{
   NSString*      basename;
   NSString*      basedir;
   NSString*      extension;
   NSString*      result;
   NSString*      indexedBasename;
   int            indexCounter = 1;
   NSFileManager* fileman = [NSFileManager defaultManager];

   if (![fileman fileExistsAtPath: filename])
   {
      return filename;
   }

   basedir = [filename stringByDeletingLastPathComponent];
   basename = [[filename lastPathComponent] stringByDeletingPathExtension];
   extension = [filename pathExtension];

   do
   {
      indexedBasename = [NSString stringWithFormat: @"%@_%d", basename, indexCounter++];
      result = [basedir stringByAppendingPathComponent: indexedBasename];
      if ([extension length])
      {
         result = [result stringByAppendingPathExtension: extension];
      }
   } while ([fileman fileExistsAtPath: result]);

   return result;
}

@end