gnustep/libs-gsweb
0
0
Fork 0
mirror of https://github.com/gnustep/libs-gsweb.git synced 2025-02-16 00:21:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
libs-gsweb/GSWExtensionsGSW/GSWCacheElement.m
Sebastian Reitenbach d4cc39b551 * nearly every file 
get rid of RCS_ID

as shortly discussed with David and Manuel



git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gsweb/trunk@37929 72102866-910b-0410-8b05-ffd578937521
2014-05-30 18:28:04 +00:00

467 lines
17 KiB
Objective-C
Raw Permalink Blame History

/** GSWCacheElement.m - <title>GSWeb: Class GSWCacheElement</title>
Copyright (C) 2004 Free Software Foundation, Inc.
Written by: Manuel Guesdon <mguesdon@orange-concept.com>
Date: Jan 2004
$Revision$
$Date$
$Id$
This file is part of the GNUstep Web Library.
<license>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
</license>
**/
#include "config.h"
#include "GSWExtGSWWOCompatibility.h"
#include "GSWCacheElement.h"
/**
GSWCacheElement is an object childrens
There's 2 modes: cachedObject or cache.
Bindings
cachedObject Evaluated with valueInComponent to get cached data , evaluated with setValue:inComponent: te cache data.
cache Evaluated to get a GSWCache object used to store and retrieve data using key, key0,keyN...
duration Evaluated when puting data in a GSWCache to set cache duration. Not allowed when using 'cachedObject' binding)
uniqID A string unique used to replace contextual data (session id, context and element id when storing data in cache.
it should be unique in children caches.
disabled If evaluated to yes, caching is disabled
enabled If evaluated to no, caching is disabled
key,key0,keyN... (key|key0), key1, key2,... are keys which will be used to put data in a GSWCache. You need at list one key (called
key or key0).
**/
//====================================================================
@implementation GSWCacheElement
static GSWIMP_BOOL standardEvaluateConditionInContextIMP = NULL;
static Class standardClass = Nil;
//--------------------------------------------------------------------
+ (void) initialize
{
if (self == [GSWCacheElement class])
{
standardClass=[GSWCacheElement class];
standardEvaluateConditionInContextIMP =
(GSWIMP_BOOL)[self instanceMethodForSelector:evaluateConditionInContextSEL];
};
};
//--------------------------------------------------------------------
-(id)initWithName:(NSString*)aName
associations:(NSDictionary*)associations
contentElements:(NSArray*)elements
{
if ((self=[super initWithName:aName
associations:nil
template:nil]))
{
if (elements)
_childrenGroup=[[GSWHTMLStaticGroup alloc]initWithContentElements:elements];
_cachedObject = [[associations objectForKey:@"cachedObject"
withDefaultObject:[_cachedObject autorelease]] retain];
_cache = [[associations objectForKey:@"cache"
withDefaultObject:[_cache autorelease]] retain];
_duration = [[associations objectForKey:@"duration"
withDefaultObject:[_duration autorelease]] retain];
_uniqID = [[associations objectForKey:@"uniqID"
withDefaultObject:[_uniqID autorelease]] retain];
_disabled = [[associations objectForKey:disabled__Key
withDefaultObject:[_disabled autorelease]] retain];
_enabled = [[associations objectForKey:enabled__Key
withDefaultObject:[_enabled autorelease]] retain];
if (_disabled && _enabled)
{
ExceptionRaise(@"GSWCacheElement",@"You can't specify 'disabled' and 'enabled' together. componentAssociations:%@",
associations);
}
else if (_cachedObject && _cache)
{
ExceptionRaise(@"GSWCacheElement",@"You can't specify 'cachedObject' and 'cache' together. componentAssociations:%@",
associations);
}
else
{
if (_cachedObject)
{
if ([_cachedObject isValueConstant])
{
ExceptionRaise0(@"GSWCacheElement",
@"'cachedObject' parameter can't be a constant");
};
}
else if (_cache)
{
// Get keys associations
static NSString* keysCache[10]={ @"key0", @"key1", @"key2", @"key3", @"key4",
@"key5", @"key6", @"key7", @"key8", @"key9" };
static int keysCacheCount=10;
int keyIndex=0;
NSMutableArray* keysArray=(NSMutableArray*)[NSMutableArray array];
GSWAssociation* aKeyAssociation=nil;
do
{
if (keyIndex==0)
{
aKeyAssociation=[associations objectForKey:@"key"];
if (!aKeyAssociation)
{
aKeyAssociation=[associations objectForKey:keysCache[0]];
}
}
else if (keyIndex<keysCacheCount)
{
aKeyAssociation=[associations objectForKey:keysCache[keyIndex]];
}
else
{
aKeyAssociation=[associations objectForKey:[@"key" stringByAppendingString:GSWIntToNSString(keyIndex)]];
};
if (aKeyAssociation)
[keysArray addObject:aKeyAssociation];
keyIndex++;
}
while(aKeyAssociation);
if ([keysArray count]>0)
ASSIGN(_keys,([NSArray arrayWithArray:keysArray]));
else
{
ExceptionRaise(@"GSWCacheElement",@"You have to define keys (like key=...; key1=...; ... componentAssociations:%@",
associations);
};
}
else
{
ExceptionRaise(@"GSWCacheElement",@"You have to define 'cachedObject' or 'cache' together. componentAssociations:%@",
associations);
};
};
};
return self;
};
//--------------------------------------------------------------------
-(id)initWithName:(NSString*)aName
associations:(NSDictionary*)someAssociations
template:(GSWElement*)templateElement
{
if ((self=[self initWithName:aName
associations:someAssociations
contentElements:templateElement ? [NSArray arrayWithObject:templateElement] : nil]))
{
};
return self;
};
//--------------------------------------------------------------------
-(void)dealloc
{
DESTROY(_childrenGroup);
DESTROY(_cachedObject);
DESTROY(_cache);
DESTROY(_duration);
DESTROY(_keys);
DESTROY(_uniqID);
DESTROY(_disabled);
DESTROY(_enabled);
[super dealloc];
}
//--------------------------------------------------------------------
-(void)setDeclarationName:(NSString*)declarationName
{
[super setDeclarationName:declarationName];
if (declarationName && _childrenGroup)
[_childrenGroup setDeclarationName:[declarationName stringByAppendingString:@"-StaticGroup"]];
};
//--------------------------------------------------------------------
-(NSString*)description
{
return [NSString stringWithFormat:@"<%s %p>",
object_getClassName(self),
(void*)self];
};
@end
//====================================================================
@implementation GSWCacheElement (GSWCacheElementA)
//--------------------------------------------------------------------
-(void)appendToResponse:(GSWResponse*)aResponse
inContext:(GSWContext*)aContext
{
GSWComponent* component=nil;
BOOL isDisabled=NO;
GSWDeclareDebugElementIDsCount(aContext);
component=[aContext component];
NS_DURING
{
BOOL cacheUsed=NO;
NSString* contextAndElementID=nil;
NSString* elementID=nil;
NSString* uniqID=nil;
NSString* sessionID=nil;
NSMutableString* contextAndElementIDCacheKey=nil;
NSMutableString* elementIDCacheKey=nil;
GSWCache* cache=nil;
int keysCount=[_keys count];
id keys[keysCount];
int i=0;
GSWStartElement(aContext);
GSWSaveAppendToResponseElementID(aContext);
/*NSLog(@"GSWCacheElement Start Date=%@",
GSWTime_format(GSWTime_now()));*/
if (_disabled)
{
isDisabled=GSWDynamicElement_evaluateValueInContext(self,standardClass,
standardEvaluateConditionInContextIMP,
_disabled,aContext);
}
else if (_enabled)
{
isDisabled=!GSWDynamicElement_evaluateValueInContext(self,standardClass,
standardEvaluateConditionInContextIMP,
_enabled,aContext);
};
uniqID=NSStringWithObject([_uniqID valueInComponent:component]);
// Append an element to elementID So all children elementIDs will start with the same prefix
[aContext appendElementIDComponent:[@"CacheElement-" stringByAppendingString:uniqID]];
contextAndElementID=[aContext contextAndElementID];
elementID=AUTORELEASE([[aContext elementID] copy]); // because elementID is mutable (and varying)
sessionID=[[aContext session] sessionID];
if (!isDisabled)
{
NSMutableData* cachedObject=nil;
if (_cachedObject)
cachedObject=[_cachedObject valueInComponent:component];
else
{
cache=[_cache valueInComponent:component];
for(i=0;i<keysCount;i++)
{
GSWAssociation* assoc=[_keys objectAtIndex:i];
keys[i]=[assoc valueInComponent:component];
if (!keys[i])
{
keys[i]=[NSNull null];
};
};
cachedObject=[cache objectForKeys:keys
count:keysCount];
};
contextAndElementIDCacheKey=(NSMutableString*)[NSMutableString stringWithString:@"##CONTEXT_ELEMENT_ID-"];
[contextAndElementIDCacheKey appendString:uniqID];
[contextAndElementIDCacheKey appendString:@"##"];
elementIDCacheKey=(NSMutableString*)[NSMutableString stringWithString:@"##ELEMENT_ID--"];
[elementIDCacheKey appendString:uniqID];
[elementIDCacheKey appendString:@"##"];
if (cachedObject)
{
NSData* sessionIDData=nil;
cacheUsed=YES;
cachedObject=AUTORELEASE([cachedObject mutableCopy]);
//NSLog(@"GSWCacheElement: cachedObject found=%@",cachedObject);
[cachedObject replaceOccurrencesOfData:[contextAndElementIDCacheKey dataUsingEncoding:[aResponse contentEncoding]]
withData:[contextAndElementID dataUsingEncoding:[aResponse contentEncoding]]
range:NSMakeRange(0,[cachedObject length])];
[cachedObject replaceOccurrencesOfData:[elementIDCacheKey dataUsingEncoding:[aResponse contentEncoding]]
withData:[elementID dataUsingEncoding:[aResponse contentEncoding]]
range:NSMakeRange(0,[cachedObject length])];
if (sessionID)
sessionIDData=[sessionID dataUsingEncoding:[aResponse contentEncoding]];
else
sessionIDData=[NSData data];
[cachedObject replaceOccurrencesOfData:[@"##SESSION_ID##" dataUsingEncoding:[aResponse contentEncoding]]
withData:sessionIDData
range:NSMakeRange(0,[cachedObject length])];
[aResponse appendContentData:cachedObject];
}
else
{
_cacheIndex=[aResponse startCache];
};
};
if (!cacheUsed)
{
/*NSLog(@"GSWCacheElement Children Start Date=%@",
GSWTime_format(GSWTime_now()));*/
[_childrenGroup appendToResponse:aResponse
inContext:aContext];
/*NSLog(@"GSWCacheElement Children Stop Date=%@",
GSWTime_format(GSWTime_now()));*/
};
if (!cacheUsed && !isDisabled)
{
NSMutableData* cachedObject=[aResponse stopCacheOfIndex:_cacheIndex];
//NSDebugMLLog(@"GSWCacheElement",@"cachedObject=%p",cachedObject);
//NSLog(@"GSWCacheElement6: sessionID=%@",sessionID);
//NSLog(@"GSWCacheElement6: elementID=%@",elementID);
//NSLog(@"GSWCacheElement6: contextAndElementID=%@",contextAndElementID);
[cachedObject replaceOccurrencesOfData:[contextAndElementID dataUsingEncoding:[aResponse contentEncoding]]
withData:[contextAndElementIDCacheKey dataUsingEncoding:[aResponse contentEncoding]]
range:NSMakeRange(0,[cachedObject length])];
[cachedObject replaceOccurrencesOfData:[elementID dataUsingEncoding:[aResponse contentEncoding]]
withData:[elementIDCacheKey dataUsingEncoding:[aResponse contentEncoding]]
range:NSMakeRange(0,[cachedObject length])];
if (sessionID)
[cachedObject replaceOccurrencesOfData:[sessionID dataUsingEncoding:[aResponse contentEncoding]]
withData:[@"##SESSION_ID##" dataUsingEncoding:[aResponse contentEncoding]]
range:NSMakeRange(0,[cachedObject length])];
if (_cachedObject)
[_cachedObject setValue:cachedObject
inComponent:component];
else
{
id duration=[_duration valueInComponent:component];
if (duration)
{
NSTimeInterval ts=0;
if ([duration respondsToSelector:@selector(floatValue)])
ts=[duration floatValue];
else if ([duration respondsToSelector:@selector(intValue)])
ts=[duration floatValue];
else
ExceptionRaise(@"GSWCacheElement",@"Don't know how to get a timeinterval from %@ of class %@",
duration,[duration class]);
[cache setObject:cachedObject
withDuration:ts
forKeys:keys
count:keysCount];
}
else
{
[cache setObject:cachedObject
forKeys:keys
count:keysCount];
};
};
};
[aContext deleteLastElementIDComponent];
/*NSLog(@"GSWCacheElement Stop Date=%@",
GSWTime_format(GSWTime_now()));*/
GSWAssertDebugElementIDsCount(aContext);
}
NS_HANDLER
{
localException=ExceptionByAddingUserInfoObjectFrameInfo(localException,
@"In GSWForm appendToResponse:inContext");
[localException raise];
}
NS_ENDHANDLER;
};
//--------------------------------------------------------------------
-(void)takeValuesFromRequest:(GSWRequest*)aRequest
inContext:(GSWContext*)aContext
{
NSString* uniqID=nil;
GSWStartElement(aContext);
GSWAssertCorrectElementID(aContext);
uniqID=NSStringWithObject([_uniqID valueInComponent:[aContext component]]);
// Append an element to elementID So all children elementIDs will start with the same prefix
[aContext appendElementIDComponent:[@"CacheElement-" stringByAppendingString:uniqID]];
[_childrenGroup takeValuesFromRequest:aRequest
inContext:aContext];
[aContext deleteLastElementIDComponent];
GSWStopElement(aContext);
GSWAssertIsElementID(aContext);
};
//--------------------------------------------------------------------
-(GSWElement*)invokeActionForRequest:(GSWRequest*)aRequest
inContext:(GSWContext*)aContext
{
GSWElement* element=nil;
NSString* uniqID=nil;
GSWStartElement(aContext);
GSWAssertCorrectElementID(aContext);
uniqID=NSStringWithObject([_uniqID valueInComponent:[aContext component]]);
// Append an element to elementID So all children elementIDs will start with the same prefix
[aContext appendElementIDComponent:[@"CacheElement-" stringByAppendingString:uniqID]];
element=[_childrenGroup invokeActionForRequest:aRequest
inContext:aContext];
NSAssert2(!element || [element isKindOfClass:[GSWElement class]],
@"Element is a %@ not a GSWElement: %@",
[element class],
element);
[aContext deleteLastElementIDComponent];
GSWStopElement(aContext);
GSWAssertIsElementID(aContext);
return element;
};
@end
Reference in a new issue View git blame Copy permalink