* Adium is the legal property of its developers, whose names are listed in the copyright file included * with this source distribution. * This program 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; either version 2 of the License, * or (at your option) any later version. * This program 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, * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #import "AdiumContentFiltering.h" @interface AdiumContentFiltering () - ( void ) _registerContentFilter : ( id ) inFilter filterArray :( NSMutableArray * ) inFilterArray ; @implementation AdiumContentFiltering if (( self = [ super init ])){ stringsRequiringPolling = [[ NSMutableSet alloc ] init ]; delayedFilteringDict = [[ NSMutableDictionary alloc ] init ]; [ stringsRequiringPolling release ]; [ delayedFilteringDict release ]; //Content Filtering ---------------------------------------------------------------------------------------------------- #pragma mark Content Filtering * @brief Register a content filter. * If the particular filter wants to apply to multiple types or directions, it should register multiple times. - ( void ) registerContentFilter: ( id < AIContentFilter > ) inFilter ofType :( AIFilterType ) type direction :( AIFilterDirection ) direction NSParameterAssert ( type >= 0 && type < FILTER_TYPE_COUNT ); NSParameterAssert ( direction >= 0 && direction < FILTER_DIRECTION_COUNT ); if ( ! contentFilter [ type ][ direction ]) { contentFilter [ type ][ direction ] = [[ NSMutableArray alloc ] init ]; [ self _registerContentFilter : inFilter filterArray : contentFilter [ type ][ direction ]]; - ( void ) registerHTMLContentFilter: ( id < AIHTMLContentFilter > ) inFilter direction :( AIFilterDirection ) direction if ( ! htmlContentFilters [ direction ]) { htmlContentFilters [ direction ] = [[ NSMutableArray alloc ] init ]; [ self _registerContentFilter : inFilter filterArray : htmlContentFilters [ direction ]]; * @brief Register a delayed content filter * Delayed content filters return YES or NO from their filter method; YES means they began a filtering process. * When finished, the filter is responsible for notifying this class that the attributed string is ready. * A unique ID will be passed to identify each string. - ( void ) registerDelayedContentFilter: ( id < AIDelayedContentFilter > ) inFilter ofType :( AIFilterType ) type direction :( AIFilterDirection ) direction NSParameterAssert ( type >= 0 && type < FILTER_TYPE_COUNT ); NSParameterAssert ( direction >= 0 && direction < FILTER_DIRECTION_COUNT ); if ( ! contentFilter [ type ][ direction ]) { contentFilter [ type ][ direction ] = [[ NSMutableArray alloc ] init ]; [ self _registerContentFilter : inFilter filterArray : contentFilter [ type ][ direction ]]; //Note that this is a delayed filter if ( ! delayedContentFilters [ type ][ direction ]) { delayedContentFilters [ type ][ direction ] = [[ NSMutableArray alloc ] init ]; [ delayedContentFilters [ type ][ direction ] addObject : inFilter ]; * @brief Unregister a filter. - ( void ) unregisterContentFilter: ( id < AIContentFilter > ) inFilter NSParameterAssert ( inFilter != nil ); for ( NSUInteger i = 0 ; i < FILTER_TYPE_COUNT ; i ++ ) { for ( NSUInteger j = 0 ; j < FILTER_DIRECTION_COUNT ; j ++ ) { [ contentFilter [ i ][ j ] removeObject : inFilter ]; * @brief Unregister a delayed filter. - ( void ) unregisterDelayedContentFilter: ( id < AIDelayedContentFilter > ) inFilter NSParameterAssert ( inFilter != nil ); for ( NSUInteger i = 0 ; i < FILTER_TYPE_COUNT ; i ++ ) { for ( NSUInteger j = 0 ; j < FILTER_DIRECTION_COUNT ; j ++ ) { [ delayedContentFilters [ i ][ j ] removeObject : inFilter ]; * @brief Unregister an HTML filter. - ( void ) unregisterHTMLContentFilter: ( id < AIHTMLContentFilter > ) inFilter NSParameterAssert ( inFilter != nil ); for ( NSUInteger j = 0 ; j < FILTER_DIRECTION_COUNT ; j ++ ) { [ htmlContentFilters [ j ] removeObject : inFilter ]; * @brief Register a string to be filtered which requires polling to be updated - ( void ) registerFilterStringWhichRequiresPolling: ( NSString * ) inPollString [ stringsRequiringPolling addObject : inPollString ]; * @brief Is polling required to update the passed string? - ( BOOL ) shouldPollToUpdateString: ( NSString * ) inString NSString * stringRequiringPolling ; for ( stringRequiringPolling in stringsRequiringPolling ) { if ([ inString rangeOfString : stringRequiringPolling ]. location != NSNotFound ) { * @brief Filters an NSString containing HTML. * @param htmlString A pointer to the NSString to filter * @param direction An AIFilterDirection representing whether the message is incoming or outgoing * @param content The AIContentObject that the html was derived from * @result the filtered NSString - ( NSString * ) filterHTMLString: ( NSString * ) htmlString direction :( AIFilterDirection ) direction content :( AIContentObject * ) content NSString * result = htmlString ; for ( id < AIHTMLContentFilter > filter in htmlContentFilters [ direction ]) { result = [ filter filterHTMLString : result content : content ]; * @brief Perform the filtering of an attributedString on the specified content filter. * @param attributedString A pointer to the NSAttributedString to filter * @param inContentFilterArray Array of filters to use, which must each conform to either AIDelayedContentFilter or AIContentFilter * @param filterContext Passed to each filter as context. * @param uniqueID A unique ID used by delayed filters * @param filtersToSkip An array of filters which should not be performed, such as previously performed or inappropriate filters * @param finishedFilters A pointer to an array which will be filled with the filters which were performed, suitable for passing later as performedFilters * @result YES if any delayed filtering began; NO if it did not - ( BOOL ) _filterAttributedString: ( NSAttributedString ** ) attributedString contentFilter :( NSArray * ) inContentFilterArray filterContext :( id ) filterContext uniqueDelayedFilterID :( unsigned long long ) uniqueID filtersToSkip :( NSArray * ) filtersToSkip finishedFilters :( NSArray ** ) finishedFilters BOOL beganDelayedFiltering = NO ; NSMutableArray * performedFilters ; //If we're passed previouslyPerformedFilters, use them as a starting point for performedFilters performedFilters = [[ filtersToSkip mutableCopy ] autorelease ]; performedFilters = [ NSMutableArray array ]; for ( id filter in inContentFilterArray ) { //Only run the filter if there were no previously performed filters or this hasn't been previously done if ( ! filtersToSkip || ! [ filtersToSkip containsObject : filter ]) { if ([ filter conformsToProtocol : @ protocol ( AIDelayedContentFilter )]) { beganDelayedFiltering = [( id < AIDelayedContentFilter > ) filter delayedFilterAttributedString :* attributedString * attributedString = [( id < AIContentFilter > ) filter filterAttributedString :* attributedString context : filterContext ]; @catch ( NSException * exception ) { AILogWithSignature ( @"Caught exception in content %@: %@" , filter , exception ); //Note that we've now completed this filter [ performedFilters addObject : filter ]; if ( beganDelayedFiltering ) break ; if ( finishedFilters ) * finishedFilters = performedFilters ; return beganDelayedFiltering ; * @brief Filter an attributed string immediately * This does not perform delayed filters (it passes the delayed content filters as filtersToSkip). * @param attributedString NSAttributedString to filter * @param type Type of the filter * @param direction Direction of the filter * @param filterContext A object, such as an AIListContact or an AIAccount, used as context by filters * @result The filtered attributed string, which may be the same as attributedString - ( NSAttributedString * ) filterAttributedString: ( NSAttributedString * ) attributedString usingFilterType :( AIFilterType ) type direction :( AIFilterDirection ) direction context :( id ) filterContext [ self _filterAttributedString :& attributedString contentFilter : contentFilter [ type ][ direction ] filterContext : filterContext filtersToSkip : delayedContentFilters [ type ][ direction ] * @brief Filter an attributed string, notifying a target when complete * This performs delayed filters, which means there may be a non-blocking delay before the filtered attributed string * @param attributedString NSAttributedString to filter * @param type Type of the filter * @param direction Direction of the filter * @param filterContext A object, such as an AIListContact or an AIAccount, used as context by filters * @param target Target to notify when filtering is complete * @param selector Selector to call on target. It should take 2 arguments; the first will be the filtered attributedString; the second is the passed context. * @param context Context passed back to target via selector when filtering is complete * @result The filtered attributed string, which may be the same as attributedString - ( void ) filterAttributedString: ( NSAttributedString * ) attributedString usingFilterType :( AIFilterType ) type direction :( AIFilterDirection ) direction filterContext :( id ) filterContext notifyingTarget :( id ) target NSParameterAssert ( type >= 0 && type < FILTER_TYPE_COUNT ); NSParameterAssert ( direction >= 0 && direction < FILTER_DIRECTION_COUNT ); NSInvocation * invocation ; invocation = [ NSInvocation invocationWithMethodSignature : [ target methodSignatureForSelector : selector ]]; [ invocation setSelector : selector ]; [ invocation setTarget : target ]; [ invocation setArgument :& context atIndex : 3 ]; //context, the second argument after the two hidden arguments of every NSInvocation static unsigned long long uniqueDelayedFilterID = 0 ; NSArray * performedFilters = nil ; shouldDelay = [ self _filterAttributedString :& attributedString contentFilter : contentFilter [ type ][ direction ] filterContext : filterContext uniqueDelayedFilterID : uniqueDelayedFilterID finishedFilters : & performedFilters ]; //If we should delay (a delayed filter is doing its thing), store what we need to finish later NSMutableDictionary * trackingDict ; //NSInvocation does not retain its arguments by default; if we're caching the invocation, we must tell it to. [ invocation retainArguments ]; trackingDict = [ NSMutableDictionary dictionaryWithObjectsAndKeys : invocation , @"Invocation" , contentFilter [ type ][ direction ], @"Delayed Content Filter" , filterContext , @"Filter Context" , nil ]; [ trackingDict setObject : performedFilters forKey : @"Performed Filters" ]; //Track this so we can invoke with the filtered product later [ delayedFilteringDict setObject : trackingDict forKey :[ NSNumber numberWithUnsignedLongLong : uniqueDelayedFilterID ]]; //Increment our delayed filter ID //If we didn't delay, invoke immediately //Put that attributed string into the invocation as the first argument after the two hidden arguments of every NSInvocation [ invocation setArgument :& attributedString atIndex : 2 ]; //Send the filtered attributedString back via the invocation * @brief A delayed filter finished filtering * After this filter finishes, run it through the delayed filter system again * to hit the next delayed string, if necessary. * If no more delayed filtering is needed, look up the invocation and pass the * now-finished string to the appropriate target. - ( void ) delayedFilterDidFinish: ( NSAttributedString * ) attributedString uniqueID: ( unsigned long long ) uniqueID NSNumber * uniqueIDNumber ; NSMutableDictionary * infoDict ; NSArray * performedFilters = nil ; uniqueIDNumber = [ NSNumber numberWithUnsignedLongLong : uniqueID ]; infoDict = [ delayedFilteringDict objectForKey : uniqueIDNumber ]; //Run through the filters again, skipping the ones we did previously, since a delayed filter would stop after the first hit shouldDelay = [ self _filterAttributedString :& attributedString contentFilter :[ infoDict objectForKey : @"Delayed Content Filter" ] filterContext :[ infoDict objectForKey : @"Filter Context" ] uniqueDelayedFilterID : uniqueID filtersToSkip :[ infoDict objectForKey : @"Performed Filters" ] finishedFilters : & performedFilters ]; //If we no longer need to delay, set up the invocation and invoke it NSInvocation * invocation = [ infoDict objectForKey : @"Invocation" ]; //Put that attributed string into the invocation as the first argument after the two hidden arguments of every NSInvocation [ invocation setArgument :& attributedString atIndex : 2 ]; //Send the filtered attributedString back via the invocation //No further need for the infoDict from delayedFilteringDict [ delayedFilteringDict removeObjectForKey : uniqueIDNumber ]; /* performedFilters may now be a different object after filters ran; * update the infoDict for the next delayedFilterDidFinsh:uniqueId: call [ infoDict setObject : performedFilters forKey : @"Performed Filters" ]; #pragma mark Filter priority sort static NSInteger filterSort ( id < AIContentFilter > filterA , id < AIContentFilter > filterB , void * context ) CGFloat filterPriorityA = [ filterA filterPriority ]; CGFloat filterPriorityB = [ filterB filterPriority ]; if ( filterPriorityA < filterPriorityB ) return NSOrderedAscending ; else if ( filterPriorityA > filterPriorityB ) return NSOrderedDescending ; * @brief Add a content filter to the specified array * Adds, then sorts by priority - ( void ) _registerContentFilter: ( id ) inFilter filterArray :( NSMutableArray * ) inFilterArray NSParameterAssert ( inFilter != nil ); [ inFilterArray addObject : inFilter ]; [ inFilterArray sortUsingFunction : filterSort context : nil ];
