IFSiTunesTrack.m

/*
  Copyright (c) 2007-2015, Marcus Müller <znek@mulle-kybernetik.com>.
  All rights reserved.


  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:

  - Redistributions of source code must retain the above copyright notice, this
    list of conditions and the following disclaimer.

  - Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.

  - Neither the name of Mulle kybernetiK nor the names of its contributors
    may be used to endorse or promote products derived from this software
    without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.
*/

#import "common.h"
#import "IFSiTunesTrack.h"
#import "NSURL+Extensions.h"
#import "NSObject+FUSEOFS.h"

@interface IFSiTunesTrack (Private)
- (NSString *)prettyName;
- (void)setPrettyName:(NSString *)_prettyName;
- (void)setUrl:(NSURL *)_url;
- (NSURL *)url;
- (void)setAttributes:(NSDictionary *)_attributes;
- (NSDictionary *)attributes;
- (void)setTrackNumber:(NSUInteger)_trackNumber;
@end

@implementation IFSiTunesTrack

static BOOL     doDebug                    = NO;
static BOOL     useSymbolicLinks           = NO;
static NSString *locationReplacePrefix     = nil;
static NSString *locationDestinationPrefix = nil;

+ (void)initialize {
  static BOOL    didInit = NO;
  NSUserDefaults *ud;
  
  if (didInit) return;
  didInit                   = YES;
  ud                        = [NSUserDefaults standardUserDefaults];
  doDebug                   = [ud boolForKey:@"iTunesFileSystemDebugEnabled"];
  useSymbolicLinks          = [ud boolForKey:@"SymbolicLinks"];
  locationReplacePrefix     = [ud stringForKey:@"LocationReplacePrefix"];
  locationDestinationPrefix = [ud stringForKey:@"LocationDestinationPrefix"];

  if (doDebug && useSymbolicLinks)
    NSLog(@"Using symbolic links for tracks");
}

/* init & dealloc */

- (id)initWithLibraryRepresentation:(NSDictionary *)_track {
  self = [super init];
  if (self) {
    self->artist = [[[_track objectForKey:kTrackArtist]
                             properlyEscapedFSRepresentation] copy];
    self->album  = [[[_track objectForKey:kTrackAlbum]
                             properlyEscapedFSRepresentation] copy];

    self->albumArtist   = [[[_track objectForKey:kTrackAlbumArtist]
                                    properlyEscapedFSRepresentation] copy];
    self->composer      = [[[_track objectForKey:kTrackComposer]
                                    properlyEscapedFSRepresentation] copy];
    self->genre         = [[[_track objectForKey:kTrackGenre]
                                    properlyEscapedFSRepresentation] copy];
    self->grouping      = [[[_track objectForKey:kTrackGrouping]
                                    properlyEscapedFSRepresentation] copy];
    self->series        = [[[_track objectForKey:kTrackSeries]
                                    properlyEscapedFSRepresentation] copy];
    self->comments      = [[[_track objectForKey:kTrackComments]
                                    properlyEscapedFSRepresentation] copy];

    self->rating        = [[_track objectForKey:kTrackRating]
                                   unsignedIntValue];
    self->discNumber    = [[_track objectForKey:kTrackDiscNumber]
                                   unsignedIntValue];
    if (self->discNumber == 0)
      self->discNumber = 1;
    self->discCount     = [[_track objectForKey:kTrackDiscCount]
                                   unsignedIntValue];
    if (self->discCount == 0)
      self->discCount = 1;
    self->playCount     = [[_track objectForKey:kTrackPlayCount]
                                   unsignedIntValue];
    self->year          = [[_track objectForKey:kTrackYear]
                                   unsignedIntValue];
    self->bitRate       = [[_track objectForKey:kTrackBitRate]
                                   unsignedIntValue];
    self->sampleRate    = [[_track objectForKey:kTrackSampleRate]
                                   unsignedIntValue];
    self->seasonNumber  = [[_track objectForKey:kTrackSeasonNumber]
                                   unsignedIntValue];
    self->episodeNumber = [[_track objectForKey:kTrackEpisodeNumber]
                                   unsignedIntValue];

    [self setTrackNumber:[[_track objectForKey:kTrackNumber] unsignedIntValue]];

    NSString *name = [_track objectForKey:kTrackName];
    if (name) {
      [self setPrettyName:[name properlyEscapedFSRepresentation]];
    }
    else {
      NSLog(@"WARN: track without name! REP:%@", _track);
      [self setPrettyName:@"Empty"];
    }
    NSString *location = [_track objectForKey:kTrackLocation];
    if (location) {
      if ([location hasPrefix:@"file"]) {
        self->ext = [[location pathExtension] copy];
      }
      else {
        /* http:// stream address... */
        self->ext = @"webloc";
      }
      if (locationReplacePrefix) {
        NSRange r;
        
        r = [location rangeOfString:locationReplacePrefix];
        if (r.location != NSNotFound) {
          location = [location substringFromIndex:NSMaxRange(r)];
          location = [locationDestinationPrefix
                                              stringByAppendingString:location];
        }
      }
      [self setUrl:[NSURL URLWithString:location]];
    }

    NSMutableDictionary *attrs = [[NSMutableDictionary alloc]
                                                       initWithCapacity:3];
    id tmp;

    if ([[self url] isFileURL]) {
      tmp = [_track objectForKey:kTrackSize];
      if (tmp)
        [attrs setObject:tmp forKey:NSFileSize];
    }
    tmp = [_track objectForKey:kTrackDateAdded];
    if (tmp)
      [attrs setObject:tmp forKey:NSFileCreationDate];
    tmp = [_track objectForKey:kTrackDateModified];
    if (tmp) {
      [attrs setObject:tmp forKey:NSFileModificationDate];
    }
    else {
      tmp = [_track objectForKey:kTrackPlayDateUTC];
      if (tmp)
        [attrs setObject:tmp forKey:NSFileModificationDate];
    }
    if (useSymbolicLinks)
      [attrs setObject:NSFileTypeSymbolicLink forKey:NSFileType];
		else
	  	[attrs setObject:NSFileTypeRegular forKey:NSFileType];

    [self setAttributes:attrs];
    [attrs release];
  }
  return self;
}

- (void)dealloc {
  [self->prettyName  release];
  [self->album       release];
  [self->artist      release];
  [self->albumArtist release];
  [self->composer    release];
  [self->series      release];
  [self->url         release];
  [self->attributes  release];
  [self->ext         release];
  [self->genre       release];
  [self->grouping    release];
  [self->comments    release];
  [super dealloc];
}

/* accessors */

- (void)setPrettyName:(NSString *)_prettyName {
  _prettyName = [_prettyName copy];
  [self->prettyName release];
  self->prettyName = _prettyName;
}
- (NSString *)prettyName {
  return self->prettyName;
}
- (NSString *)name {
  return self->prettyName;
}

- (NSString *)album {
  return self->album;
}
- (NSString *)artist {
  return self->artist;
}
- (NSString *)albumArtist {
  return self->albumArtist;
}
- (NSString *)composer {
  return self->composer;
}
- (NSString *)series {
  return self->series;
}
- (NSString *)genre {
  return self->genre;
}
- (NSString *)grouping {
  return self->grouping;
}
- (NSString *)comments {
  return self->comments;
}

- (void)setUrl:(NSURL *)_url {
  _url = [_url copy];
  [self->url release];
  self->url = _url;
}
- (NSURL *)url {
  return self->url;
}
- (NSString *)extension {
  return self->ext;
}
- (NSString *)ext {
  if (self->ext)
    return self->ext;
  return @"m4a";
}

- (void)setAttributes:(NSDictionary *)_attributes {
  _attributes = [_attributes copy];
  [self->attributes release];
  self->attributes = _attributes;
}
- (NSDictionary *)attributes {
  return self->attributes;
}

- (void)setTrackNumber:(NSUInteger)_trackNumber {
  self->trackNumber = _trackNumber;
}
- (NSUInteger)trackNumber {
  return self->trackNumber;
}

- (void)setPlaylistNumber:(NSUInteger)_playlistNumber {
  self->playlistNumber = _playlistNumber;
}
- (NSUInteger)playlistNumber {
  return self->playlistNumber;
}

- (NSUInteger)rating {
  return self->rating;
}
- (NSUInteger)seasonNumber {
  return self->seasonNumber;
}
- (NSUInteger)episodeNumber {
  return self->episodeNumber;
}
- (NSUInteger)discNumber {
  return self->discNumber;
}
- (NSUInteger)discCount {
  return self->discCount;
}
- (NSUInteger)playCount {
  return self->playCount;
}
- (NSUInteger)year {
  return self->year;
}
- (NSUInteger)bitRate {
  return self->bitRate;
}
- (NSUInteger)sampleRate {
  return self->sampleRate;
}

- (BOOL)isUsable {
  return [self url] != nil ? YES : NO;
}

- (BOOL)isApplication {
  return [[self extension] isEqualToString:@"ipa"] ? YES : NO;
}

/* FUSEOFS */

- (NSDictionary *)fileAttributes {
  return [self attributes];
}

- (NSData *)fileContents {
  NSString *path;

  if (!self->url) return nil;
  if (![self->url isFileURL]) { /* http based audio stream... */
    return [[self->url description] dataUsingEncoding:NSUTF8StringEncoding];
  }
  path = [self->url properlyEscapedPath];
#ifndef GNUSTEP_BASE_LIBRARY
  return [NSData dataWithContentsOfFile:path
                 options:NSUncachedRead
                 error:NULL];
#else
  return [NSData dataWithContentsOfFile:path];
#endif
}

- (NSDictionary *)resourceAttributes {
  if ([self->url isFileURL]) return nil;
  return [NSDictionary dictionaryWithObject:self->url
                       forKey:kGMUserFileSystemWeblocURLKey];
}

- (NSString *)symbolicLinkTarget {
  return [self->url properlyEscapedPath];
}

/* debugging */

- (NSString *)description {
  return [NSString stringWithFormat:@"<%s %p: name:%@ attrs:%@>",
                                    object_getClassName(self), self,
                                    [self prettyName], [self attributes]];
}

@end /* IFSiTunesTrack */