Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 900dac1e03
Fetching contributors…

Cannot retrieve contributors at this time

file 268 lines (207 sloc) 8.321 kb
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
//
// UKFNSubscribeFileWatcher.m
// Filie
//
// Created by Uli Kusterer on 03.02.05.
// Copyright 2005 Uli Kusterer.
//
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented; you must not
// claim that you wrote the original software. If you use this software
// in a product, an acknowledgment in the product documentation would be
// appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such, and must not be
// misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source
// distribution.
//

// -----------------------------------------------------------------------------
// Headers:
// -----------------------------------------------------------------------------

#import "UKFNSubscribeFileWatcher.h"
#import <Carbon/Carbon.h>


// -----------------------------------------------------------------------------
// Private stuff:
// -----------------------------------------------------------------------------

@interface UKFNSubscribeFileWatcher (UKPrivateMethods)

-(void) sendDelegateMessage: (FNMessage)message forSubscription: (FNSubscriptionRef)subscription;

@end


// -----------------------------------------------------------------------------
// Prototypes:
// -----------------------------------------------------------------------------

void UKFileSubscriptionProc(FNMessage message, OptionBits flags, void *refcon, FNSubscriptionRef subscription);


@implementation UKFNSubscribeFileWatcher

// -----------------------------------------------------------------------------
// sharedFileWatcher:
// Singleton accessor.
// -----------------------------------------------------------------------------

+(id) sharedFileWatcher
{
static UKFNSubscribeFileWatcher* sSharedFileWatcher = nil;

@synchronized( self )
{
if( !sSharedFileWatcher )
sSharedFileWatcher = [[UKFNSubscribeFileWatcher alloc] init]; // This is a singleton, and thus an intentional "leak".
    }

    return sSharedFileWatcher;
}


// -----------------------------------------------------------------------------
// * CONSTRUCTOR:
// -----------------------------------------------------------------------------

-(id) init
{
    self = [super init];
    if( !self )
        return nil;
    
    subscribedPaths = [[NSMutableArray alloc] init];
    subscribedObjects = [[NSMutableArray alloc] init];
    
    return self;
}


// -----------------------------------------------------------------------------
// * DESTRUCTOR:
// -----------------------------------------------------------------------------

-(void) dealloc
{
    [self removeAllPaths];
    
    [subscribedPaths release];
subscribedPaths = nil;
    [subscribedObjects release];
subscribedObjects = nil;

    [super dealloc];
}


-(void) finalize
{
    [self removeAllPaths];

    [super finalize];
}

// -----------------------------------------------------------------------------
// addPath:
// Start watching the object at the specified path. This only sends write
// notifications for all changes, as FNSubscribe doesn't tell what actually
// changed about our folder.
// -----------------------------------------------------------------------------

-(void) addPath: (NSString*)path
{
@synchronized( self )
{
OSStatus err = noErr;
static FNSubscriptionUPP subscriptionUPP = NULL;
FNSubscriptionRef subscription = NULL;

if( !subscriptionUPP )
subscriptionUPP = NewFNSubscriptionUPP( UKFileSubscriptionProc );

err = FNSubscribeByPath( (UInt8*) [path fileSystemRepresentation], subscriptionUPP, (void*)self,
kNilOptions, &subscription );
if( err != noErr )
{
NSLog( @"UKFNSubscribeFileWatcher addPath: %@ failed due to error ID=%ld.", path, err );
return;
}

[subscribedPaths addObject: path];
[subscribedObjects addObject: [NSValue valueWithPointer: subscription]];
}
}


// -----------------------------------------------------------------------------
// removePath:
// Stop watching the object at the specified path.
// -----------------------------------------------------------------------------

-(void) removePath: (NSString*)path
{
    NSValue* subValue = nil;
    @synchronized( self )
    {
int idx = [subscribedPaths indexOfObject: path];
if( idx != NSNotFound )
{
subValue = [[[subscribedObjects objectAtIndex: idx] retain] autorelease];
[subscribedPaths removeObjectAtIndex: idx];
[subscribedObjects removeObjectAtIndex: idx];
}
   }
    
if( subValue )
{
FNSubscriptionRef subscription = [subValue pointerValue];

FNUnsubscribe( subscription );
}
}


// -----------------------------------------------------------------------------
// delegate:
// Accessor for file watcher delegate.
// -----------------------------------------------------------------------------

-(id) delegate
{
    return delegate;
}


// -----------------------------------------------------------------------------
// setDelegate:
// Mutator for file watcher delegate.
// -----------------------------------------------------------------------------

-(void) setDelegate: (id)newDelegate
{
    delegate = newDelegate;
}


-(void) removeAllPaths
{
    @synchronized( self )
    {
NSEnumerator* enny = [subscribedObjects objectEnumerator];
NSValue* subValue = nil;

        while(( subValue = [enny nextObject] ))
{
FNSubscriptionRef subscription = [subValue pointerValue];
FNUnsubscribe( subscription );
}

[subscribedPaths removeAllObjects];
  [subscribedObjects removeAllObjects];
   }
}

@end

@implementation UKFNSubscribeFileWatcher (UKPrivateMethods)

// -----------------------------------------------------------------------------
// sendDelegateMessage:forSubscription:
// Bottleneck for change notifications. This is called by our callback
// function to actually inform the delegate and send out notifications.
//
// This *only* sends out write notifications, as FNSubscribe doesn't tell
// what changed about our folder.
// -----------------------------------------------------------------------------

-(void) sendDelegateMessage: (FNMessage)message forSubscription: (FNSubscriptionRef)subscription
{
    NSValue* subValue = [NSValue valueWithPointer: subscription];
int idx = [subscribedObjects indexOfObject: subValue];
if( idx == NSNotFound )
{
NSLog( @"Notification for unknown subscription." );
return;
}
    NSString* path = [subscribedPaths objectAtIndex: idx];
    
[[[NSWorkspace sharedWorkspace] notificationCenter] postNotificationName: UKFileWatcherWriteNotification
object: self
userInfo: [NSDictionary dictionaryWithObjectsAndKeys: path, @"path", nil]];

    [delegate watcher: self receivedNotification: UKFileWatcherWriteNotification forPath: path];
    //NSLog( @"UKFNSubscribeFileWatcher noticed change to %@", path ); // DEBUG ONLY!
}

@end



// -----------------------------------------------------------------------------
// UKFileSubscriptionProc:
// Callback function we hand to Carbon so it can tell us when something
// changed about our watched folders. We set the refcon to a pointer to
// our object. This simply extracts the object and hands the info off to
// sendDelegateMessage:forSubscription: which does the actual work.
// -----------------------------------------------------------------------------

void UKFileSubscriptionProc( FNMessage message, OptionBits flags, void *refcon, FNSubscriptionRef subscription )
{
    UKFNSubscribeFileWatcher* obj = (UKFNSubscribeFileWatcher*) refcon;
    
    if( message == kFNDirectoryModifiedMessage ) // No others exist as of 10.4
        [obj sendDelegateMessage: message forSubscription: subscription];
    else
        NSLog( @"UKFileSubscriptionProc: Unknown message %d", message );
}
Something went wrong with that request. Please try again.