err.no Git - sope/blob - sope-appserver/NGObjWeb/WOContext.m

   1 /*
   2   Copyright (C) 2000-2005 SKYRIX Software AG
   3
   4   This file is part of SOPE.
   5
   6   SOPE is free software; you can redistribute it and/or modify it under
   7   the terms of the GNU Lesser General Public License as published by the
   8   Free Software Foundation; either version 2, or (at your option) any
   9   later version.
  10
  11   SOPE is distributed in the hope that it will be useful, but WITHOUT ANY
  12   WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  14   License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with SOPE; see the file COPYING.  If not, write to the
  18   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19   02111-1307, USA.
  20 */
  21
  22 #include <NGObjWeb/WOContext.h>
  23 #include "NSObject+WO.h"
  24 #include "WOComponent+private.h"
  25 #include "WOContext+private.h"
  26 #include "WOApplication+private.h"
  27 #include <NGObjWeb/WOApplication.h>
  28 #include <NGObjWeb/WORequest.h>
  29 #include <NGObjWeb/WOResponse.h>
  30 #include <NGObjWeb/WOSession.h>
  31 #import <EOControl/EONull.h>
  32 #include "WOElementID.h"
  33 #include "common.h"
  34 #include <time.h>
  35
  36
  37 @interface WOContext(Privates5)
  38 - (NSArray *)_componentStack;
  39 @end
  40
  41 @interface WOComponent(Cursors)
  42 - (void)pushCursor:(id)_obj;
  43 - (id)popCursor;
  44 - (id)cursor;
  45 @end
  46
  47 static Class WOAppClass = Nil;
  48
  49 @implementation WOContext
  50
  51 + (int)version {
  52   return 7;
  53 }
  54
  55 static Class MutableStrClass    = Nil;
  56 static int  contextCount        = 0;
  57 static int  logComponents       = -1;
  58 static int  relativeURLs        = -1;
  59 static BOOL debugOn             = NO;
  60 static int  debugCursor         = -1;
  61 static BOOL debugComponentAwake = NO;
  62 static BOOL testNSURLs          = NO;
  63 static BOOL newCURLStyle        = NO;
  64 static NSString *WOApplicationSuffix = nil;
  65
  66 + (void)initialize {
  67   NSUserDefaults *ud = [NSUserDefaults standardUserDefaults];
  68   static BOOL didInitialize = NO;
  69   if (didInitialize) return;
  70
  71   if (WOAppClass == Nil)
  72     WOAppClass = [WOApplication class];
  73   if (MutableStrClass == Nil)
  74     MutableStrClass = [NSMutableString class];
  75
  76   didInitialize = YES;
  77
  78   logComponents = [[ud objectForKey:@"WOLogComponents"] boolValue] ? 1 : 0;
  79   relativeURLs  = [[ud objectForKey:@"WOUseRelativeURLs"] boolValue]? 1 : 0;
  80   debugCursor         = [ud boolForKey:@"WODebugCursor"] ? 1 : 0;
  81   debugComponentAwake = [ud boolForKey:@"WODebugComponentAwake"];
  82   WOApplicationSuffix = [[ud stringForKey:@"WOApplicationSuffix"] copy];
  83 }
  84
  85 + (id)contextWithRequest:(WORequest *)_request {
  86   return [[(WOContext *)[self alloc] initWithRequest:_request] autorelease];
  87 }
  88
  89 - (id)initWithRequest:(WORequest *)_request {
  90   if ((self = [super init])) {
  91     unsigned char buf[24];
  92     self->qpJoin = @"&";
  93
  94     sprintf(buf, "%03x%08x%08x", ++contextCount, (int)time(NULL), (int)self);
  95     self->ctxId = [[NSString alloc] initWithCString:buf];
  96
  97     self->elementID = [[WOElementID alloc] init];
  98     self->awakeComponents = [[NSMutableSet alloc] initWithCapacity:64];
  99
 100     self->request  = [_request retain];
 101     self->response = [[WOResponse responseWithRequest:_request] retain];
 102   }
 103   return self;
 104 }
 105
 106 + (id)context {
 107   return [[[self alloc] init] autorelease];
 108 }
 109 - (id)init {
 110   return [self initWithRequest:nil];
 111 }
 112
 113 /* components */
 114
 115 - (void)_addAwakeComponent:(WOComponent *)_component {
 116   if (_component == nil)
 117     return;
 118
 119   if ([self->awakeComponents containsObject:_component])
 120     return;
 121
 122   /* wake up component */
 123   if (debugComponentAwake)
 124     [self logWithFormat:@"mark component awake: %@", _component];
 125
 126   [self->awakeComponents addObject:_component];
 127 }
 128
 129 - (void)_awakeComponent:(WOComponent *)_component {
 130   if (_component == nil)
 131     return;
 132
 133   if ([self->awakeComponents containsObject:_component])
 134     return;
 135
 136   /* wake up component */
 137   if (debugComponentAwake)
 138     [self logWithFormat:@"awake component: %@", _component];
 139
 140   [_component _awakeWithContext:self];
 141
 142   [self _addAwakeComponent:_component];
 143
 144   if (debugComponentAwake)
 145     [self logWithFormat:@"woke up component: %@", _component];
 146 }
 147
 148 - (void)sleepComponents {
 149   NSEnumerator *e;
 150   WOComponent  *component;
 151   BOOL sendSleepToPage;
 152
 153   if (debugComponentAwake) {
 154     [self logWithFormat:@"sleep %d components ...",
 155             [self->awakeComponents count]];
 156   }
 157
 158   sendSleepToPage = YES;
 159   e = [self->awakeComponents objectEnumerator];
 160   while ((component = [e nextObject])) {
 161     if (debugComponentAwake)
 162       [self logWithFormat:@"  sleep component: %@", component];
 163     [component _sleepWithContext:self];
 164     if (component == self->page) sendSleepToPage = NO;
 165   }
 166   if (sendSleepToPage && (self->page != nil)) {
 167     if (debugComponentAwake)
 168       [self logWithFormat:@"  sleep page: %@", self->page];
 169     [self->page _sleepWithContext:self];
 170   }
 171
 172   if (debugComponentAwake) {
 173     [self logWithFormat:@"done sleep %d components.",
 174             [self->awakeComponents count]];
 175   }
 176   [self->awakeComponents removeAllObjects];
 177 }
 178
 179 #if WITH_DEALLOC_OBSERVERS
 180 - (void)addDeallocObserver:(id)_observer {
 181   if (_observer == NULL) return;
 182
 183   /* check array */
 184   if (self->deallocObservers == NULL) {
 185     self->deallocObservers        = calloc(8, sizeof(id));
 186     self->deallocObserverCount    = 0;
 187     self->deallocObserverCapacity = 8;
 188   }
 189
 190   /* check capacity */
 191   if (self->deallocObserverCapacity == self->deallocObserverCount) {
 192     /* need to increase array */
 193     id *newa;
 194
 195     newa = calloc(self->deallocObserverCapacity * 2, sizeof(id));
 196     memcpy(newa, self->deallocObservers,
 197            sizeof(id) * self->deallocObserverCount);
 198     free(self->deallocObservers);
 199     self->deallocObservers = newa;
 200     self->deallocObserverCapacity *= 2;
 201   }
 202
 203   /* register */
 204   self->deallocObservers[self->deallocObserverCount] = _observer;
 205   self->deallocObserverCount++;
 206 }
 207 - (void)removeDeallocObserver:(id)_observer {
 208   /* the observer currently will only grow (this should be OK for WOContext) */
 209   register int i;
 210   if (_observer == NULL) return;
 211
 212   for (i = self->deallocObserverCount - 1; i >= 0; i++) {
 213     if ((self->deallocObservers[i]) == _observer)
 214       self->deallocObservers[i] = NULL;
 215   }
 216 }
 217 #endif
 218
 219 - (void)dealloc {
 220   [self sleepComponents];
 221
 222 #if WITH_DEALLOC_OBSERVERS
 223   if (self->deallocObservers) {
 224     register int i;
 225
 226 #if DEBUG
 227     printf("%s: dealloc observer capacity: %i\n",
 228            __PRETTY_FUNCTION__, self->deallocObserverCapacity);
 229 #endif
 230
 231     /* GC!! process in reverse order ... */
 232     for (i = self->deallocObserverCount - 1; i >= 0; i++)
 233       [self->deallocObservers[i] _objectWillDealloc:self];
 234
 235     free(self->deallocObservers);
 236     self->deallocObservers = NULL;
 237   }
 238 #endif
 239
 240   [self->activeUser            release];
 241   [self->rootURL               release];
 242   [self->objectPermissionCache release];
 243   [self->traversalStack        release];
 244   [self->clientObject          release];
 245   [self->objectDispatcher      release];
 246   [self->soRequestType         release];
 247   [self->pathInfo              release];
 248
 249   [[NSNotificationCenter defaultCenter]
 250                          postNotificationName:@"WOContextWillDeallocate"
 251                          object:self->ctxId];
 252
 253   { /* release component stack */
 254     int i;
 255     for (i = (self->componentStackCount - 1); i >= 0; i--) {
 256       [self->componentStack[i] release]; self->componentStack[i] = nil;
 257       [self->contentStack[i]   release]; self->contentStack[i]   = nil;
 258     }
 259   }
 260
 261   [self->urlPrefix         release];
 262   [self->elementID         release];
 263   [self->reqElementID      release];
 264   [self->activeFormElement release];
 265   [self->page              release];
 266   [self->awakeComponents   release];
 267   [self->appURL            release];
 268   [self->baseURL           release];
 269   [self->session           release];
 270   [self->variables         release];
 271   [self->request           release];
 272   [self->response          release];
 273   [self->ctxId             release];
 274   [super dealloc];
 275 }
 276
 277 - (void)setSession:(WOSession *)_session {
 278   ASSIGN(self->session, _session);
 279 }
 280
 281 - (WOSession *)session {
 282   // in WO4 -session creates a new session if none is associated
 283
 284   if (self->session == nil) {
 285     [[self application] _initializeSessionInContext:self];
 286
 287     if (self->session == nil)
 288       [self logWithFormat:@"%s: missing session for context ..",
 289               __PRETTY_FUNCTION__];
 290   }
 291
 292   return self->session;
 293 }
 294
 295 - (NSString *)contextID {
 296   NSAssert(self->ctxId, @"context without id !");
 297 #if 0
 298   // in WO4 -contextID returns nil if there is no associated session
 299   return self->session ? self->ctxId : nil;
 300 #else
 301   /*
 302     IMHO the above isn't true, otherwise session cannot be automagically
 303     generated!
 304
 305     TODO: well, we might want to generate component URLs which work without
 306           a session - at least in theory the ID tree should be stable even
 307           without a session (and if proper uids are used for dynamic content).
 308           eg this would be quite useful for SOPE.
 309   */
 310   return self->ctxId;
 311 #endif
 312 }
 313
 314 - (WORequest *)request {
 315   return self->request;
 316 }
 317 - (WOResponse *)response {
 318   return self->response;
 319 }
 320
 321 - (BOOL)hasSession {
 322   return (self->session != nil) ? YES : NO;
 323 }
 324
 325 - (BOOL)savePageRequired {
 326   return self->savePageRequired;
 327 }
 328
 329 /* cursors */
 330
 331 - (void)pushCursor:(id)_obj {
 332   if (debugCursor == -1) {
 333     debugCursor = [[NSUserDefaults standardUserDefaults]
 334                                    boolForKey:@"WODebugCursor"]
 335       ? 1 : 0;
 336   }
 337
 338   if (debugCursor) [self logWithFormat:@"enter cursor: %@", _obj];
 339   [[self component] pushCursor:_obj];
 340 }
 341
 342 - (id)popCursor {
 343   if (debugCursor) [self logWithFormat:@"leave cursor ..."];
 344   return [[self component] popCursor];
 345 }
 346
 347 - (id)cursor {
 348   return [(id <WOPageGenerationContext>)[self component] cursor];
 349 }
 350
 351 /* components */
 352
 353 - (WOComponent *)component {
 354   return (self->componentStackCount > 0)
 355     ? self->componentStack[self->componentStackCount - 1]
 356     : nil;
 357 }
 358
 359 - (void)setPage:(WOComponent *)_page {
 360   [_page ensureAwakeInContext:self];
 361   ASSIGN(self->page, _page);
 362 }
 363 - (WOComponent *)page {
 364   return self->page;
 365 }
 366
 367 void WOContext_enterComponent
 368 (WOContext *self, WOComponent *_component, WOElement *_content)
 369 {
 370   WOComponent *parent = nil;
 371 #if DEBUG
 372   NSCAssert(_component, @"missing component to enter ...");
 373 #endif
 374
 375   if (logComponents) {
 376     [self->application logWithFormat:@"enter component %@ (content=%@) ..",
 377                          [_component name], _content];
 378   }
 379
 380   parent = self->componentStackCount > 0
 381     ? self->componentStack[self->componentStackCount - 1]
 382     : nil;
 383
 384   NSCAssert2(self->componentStackCount < NGObjWeb_MAX_COMPONENT_NESTING_DEPTH,
 385              @"exceeded maximum component nesting depth (%i):\n%@",
 386              NGObjWeb_MAX_COMPONENT_NESTING_DEPTH,
 387              [self _componentStack]);
 388   self->componentStack[(int)self->componentStackCount] = [_component retain];
 389   self->contentStack[(int)self->componentStackCount]   = [_content   retain];
 390   self->componentStackCount++;
 391
 392   [self _awakeComponent:_component];
 393
 394   if (parent) {
 395     if ([_component synchronizesVariablesWithBindings])
 396       WOComponent_syncFromParent(_component, parent);
 397   }
 398 }
 399 void WOContext_leaveComponent(WOContext *self, WOComponent *_component) {
 400   WOComponent *parent = nil;
 401
 402   BEGIN_PROFILE;
 403
 404   parent = (self->componentStackCount > 1)
 405     ? self->componentStack[self->componentStackCount - 2]
 406     : nil;
 407
 408   if (parent) {
 409     if ([_component synchronizesVariablesWithBindings])
 410       WOComponent_syncToParent(_component, parent);
 411   }
 412
 413   PROFILE_CHECKPOINT("after sync");
 414
 415   /* remove last object */
 416   self->componentStackCount--;
 417   NSCAssert(self->componentStackCount >= 0,
 418             @"tried to pop component from empty component stack !");
 419   [self->componentStack[(int)self->componentStackCount] release];
 420   self->componentStack[(int)self->componentStackCount] = nil;
 421   [self->contentStack[(int)self->componentStackCount] release];
 422   self->contentStack[(int)self->componentStackCount] = nil;
 423
 424   if (logComponents)
 425     [self->application logWithFormat:@"left component %@.", [_component name]];
 426
 427   END_PROFILE;
 428 }
 429
 430 - (void)enterComponent:(WOComponent *)_comp content:(WOElement *)_content {
 431   WOContext_enterComponent(self, _comp, _content);
 432 }
 433 - (void)leaveComponent:(WOComponent *)_component {
 434   BEGIN_PROFILE;
 435   WOContext_leaveComponent(self, _component);
 436   END_PROFILE;
 437 }
 438
 439 - (WOComponent *)parentComponent {
 440   return (self->componentStackCount > 1)
 441     ? self->componentStack[(int)self->componentStackCount - 2]
 442     : nil;
 443 }
 444
 445 - (WODynamicElement *)componentContent {
 446   return (self->componentStackCount > 0)
 447     ? self->contentStack[(int)self->componentStackCount - 1]
 448     : nil;
 449 }
 450
 451 - (unsigned)componentStackCount {
 452   return self->componentStackCount;
 453 }
 454 - (NSArray *)_componentStack {
 455   return [NSArray arrayWithObjects:self->componentStack
 456                   count:self->componentStackCount];
 457 }
 458
 459 /* URLs */
 460
 461 - (NSURL *)serverURL {
 462   WORequest *rq;
 463   NSString  *serverURL;
 464   NSURL     *url;
 465   NSString  *host;
 466
 467   if ((rq = [self request]) == nil) {
 468     [self logWithFormat:@"missing request in -baseURL call .."];
 469     return nil;
 470   }
 471
 472   if ((serverURL = [rq headerForKey:@"x-webobjects-server-url"]) == nil) {
 473     if ((host = [rq headerForKey:@"host"]))
 474       serverURL = [@"http://" stringByAppendingString:host];
 475   }
 476   else {
 477     // TODO: fix that (host is also broken for example with SOUP)
 478     /* sometimes the port is broken in the server URL ... */
 479     if ([serverURL hasSuffix:@":0"]) { // bad bad bad
 480       if ((host = [rq headerForKey:@"host"])) {
 481         NSString *scheme;
 482         scheme = [serverURL hasPrefix:@"https://"] ? @"https://" : @"http://";
 483         serverURL = [scheme stringByAppendingString:host];
 484       }
 485     }
 486   }
 487
 488   if ([serverURL length] == 0) {
 489     [self errorWithFormat:@"could not find x-webobjects-server-url header !"];
 490     return nil;
 491   }
 492
 493   if ((url = [NSURL URLWithString:serverURL]) == nil) {
 494     [self logWithFormat:@"could not construct NSURL from string '%@'",
 495             serverURL];
 496     return nil;
 497   }
 498   return url;
 499 }
 500
 501 - (NSURL *)baseURL {
 502   WORequest *rq;
 503   NSURL     *serverURL;
 504
 505   if (self->baseURL)
 506     return self->baseURL;
 507
 508   if ((rq = [self request]) == nil) {
 509     [self logWithFormat:@"missing request in -baseURL call .."];
 510     return nil;
 511   }
 512
 513   serverURL = [self serverURL];
 514   self->baseURL =
 515     [[NSURL URLWithString:[rq uri] relativeToURL:serverURL] retain];
 516
 517   if (self->baseURL == nil) {
 518     [self logWithFormat:
 519             @"could not construct NSURL for uri '%@' and base '%@' ...",
 520             [rq uri], serverURL];
 521   }
 522   return self->baseURL;
 523 }
 524
 525 - (NSURL *)applicationURL {
 526   NSString *s;
 527
 528   if (self->appURL != nil)
 529     return self->appURL;
 530
 531   // TODO: we should ensure that the suffix (.woa) is in the URL
 532
 533   s = [self->request adaptorPrefix];
 534   if ([s length] > 0) {
 535     s = [[[s stringByAppendingString:@"/"]
 536              stringByAppendingString:[self->request applicationName]]
 537              stringByAppendingString:@"/"];
 538   }
 539   else
 540     s = [[self->request applicationName] stringByAppendingString:@"/"];
 541
 542   self->appURL =
 543     [[NSURL URLWithString:s relativeToURL:[self serverURL]] retain];
 544   return self->appURL;
 545 }
 546 - (NSURL *)urlForKey:(NSString *)_key {
 547   _key = [_key stringByAppendingString:@"/"];
 548   return [NSURL URLWithString:_key relativeToURL:[self applicationURL]];
 549 }
 550
 551 /* forms */
 552
 553 - (void)setInForm:(BOOL)_form {
 554   self->inForm = _form;
 555 }
 556 - (BOOL)isInForm {
 557   return self->inForm;
 558 }
 559
 560 - (void)addActiveFormElement:(WOElement *)_formElement {
 561   if (self->activeFormElement) {
 562     [[self component] debugWithFormat:@"active form element already set !"];
 563     return;
 564   }
 565
 566   ASSIGN(self->activeFormElement, _formElement);
 567   [self setRequestSenderID:[self elementID]];
 568 }
 569 - (WOElement *)activeFormElement {
 570   return self->activeFormElement;
 571 }
 572
 573 /* context variables (transient) */
 574
 575 - (void)setObject:(id)_obj forKey:(NSString *)_key {
 576   if (self->variables == nil) {
 577     self->variables =
 578       [[NSMutableDictionary allocWithZone:[self zone]]
 579                             initWithCapacity:16];
 580   }
 581
 582   if (_obj)
 583     [self->variables setObject:_obj forKey:_key];
 584   else
 585     [self->variables removeObjectForKey:_key];
 586 }
 587 - (id)objectForKey:(NSString *)_key {
 588   return [self->variables objectForKey:_key];
 589 }
 590 - (void)removeObjectForKey:(NSString *)_key {
 591   [self->variables removeObjectForKey:_key];
 592 }
 593
 594 - (NSDictionary *)variableDictionary {
 595   return self->variables;
 596 }
 597
 598 - (void)takeValue:(id)_value forKey:(NSString *)_key {
 599   if (WOSetKVCValueUsingMethod(self, _key, _value))
 600     // method is used
 601     return;
 602   else if (WOGetKVCGetMethod(self, _key) == NULL) {
 603     if (_value == nil)
 604       _value = [EONull null];
 605
 606     if (self->variables == nil) {
 607       self->variables =
 608         [[NSMutableDictionary allocWithZone:[self zone]]
 609                               initWithCapacity:16];
 610     }
 611     [self->variables setObject:_value forKey:_key];
 612     return;
 613   }
 614   else {
 615     // only a 'get' method is defined for _key !
 616     [self handleTakeValue:_value forUnboundKey:_key];
 617   }
 618 }
 619 - (id)valueForKey:(NSString *)_key {
 620   id value;
 621
 622   if ((value = WOGetKVCValueUsingMethod(self, _key)))
 623     return value;
 624   value = [self->variables objectForKey:_key];
 625   return value;
 626 }
 627
 628 /* NSCopying */
 629
 630 - (id)copyWithZone:(NSZone *)_zone {
 631   return [self retain];
 632 }
 633
 634 /* description */
 635
 636 - (NSString *)description {
 637   NSString *sid = nil;
 638   WOApplication *app = [self application];
 639
 640   if ([self hasSession])
 641     sid = [[self session] sessionID];
 642
 643   return [NSString stringWithFormat:
 644                      @"<0x%08X[%@]: %@ app=%@ sn=%@ eid=%@ rqeid=%@>",
 645                      (unsigned)self, NSStringFromClass([self class]),
 646                      [self  contextID],
 647                      [app name],
 648                      sid ? sid : @"none",
 649                      [self  elementID],
 650                      [self  senderID]];
 651 }
 652
 653 /* ElementIDs */
 654
 655 - (NSString *)elementID {
 656   return [self->elementID elementID];
 657 }
 658 - (void)appendElementIDComponent:(NSString *)_eid {
 659   [self->elementID appendElementIDComponent:_eid];
 660 }
 661 - (void)appendZeroElementIDComponent {
 662   [self->elementID appendZeroElementIDComponent];
 663 }
 664 - (void)deleteAllElementIDComponents {
 665   [self->elementID deleteAllElementIDComponents];
 666 }
 667 - (void)deleteLastElementIDComponent {
 668   [self->elementID deleteLastElementIDComponent];
 669 }
 670 - (void)incrementLastElementIDComponent {
 671   [self->elementID incrementLastElementIDComponent];
 672 }
 673 - (void)appendIntElementIDComponent:(int)_eid {
 674   [self->elementID appendIntElementIDComponent:_eid];
 675 }
 676
 677 /* the following can be later moved to WOElementID */
 678
 679 - (id)currentElementID {
 680   return [self->reqElementID currentElementID];
 681 }
 682 - (id)consumeElementID {
 683   return [self->reqElementID consumeElementID];
 684 }
 685
 686 /* URLs */
 687
 688 - (void)_generateCompleteURLs {
 689   /* described in Apple TIL article 70101 */
 690 }
 691
 692 - (NSString *)queryStringFromDictionary:(NSDictionary *)_queryDict {
 693   NSEnumerator    *keys;
 694   NSString        *key;
 695   BOOL            isFirst;
 696   NSMutableString *qs;
 697
 698   qs   = [MutableStrClass stringWithCapacity:256];
 699   keys = [_queryDict keyEnumerator];
 700   for (isFirst = YES; (key = [keys nextObject]); ) {
 701     NSString *value;
 702
 703     if (isFirst)
 704       isFirst = NO;
 705     else
 706       [qs appendString:self->qpJoin];
 707
 708     value = [[_queryDict objectForKey:key] stringValue];
 709
 710     key   = [key   stringByEscapingURL];
 711     value = [value stringByEscapingURL];
 712
 713     [qs appendString:key];
 714     if (value) {
 715       [qs appendString:@"="];
 716       [qs appendString:value];
 717     }
 718   }
 719
 720   return qs;
 721 }
 722
 723 - (NSString *)directActionURLForActionNamed:(NSString *)_actionName
 724   queryDictionary:(NSDictionary *)_queryDict
 725 {
 726   NSMutableString *url;
 727   NSString        *qs;
 728
 729   url = [MutableStrClass stringWithCapacity:256];
 730
 731   if (!testNSURLs)
 732      [url appendString:@"/"];
 733
 734   [url appendString:_actionName];
 735
 736   /* add query parameters */
 737
 738   qs = [self queryStringFromDictionary:_queryDict];
 739
 740   return [self urlWithRequestHandlerKey:
 741                  [WOAppClass directActionRequestHandlerKey]
 742                path:url queryString:qs];
 743 }
 744
 745 - (NSString *)componentActionURL {
 746   // TODO: add a -cComponentActionURL
 747   //       (without NSString for use with appendContentCString:)
 748   // Profiling:
 749   //   26% -urlWithRequestHandler...
 750   //   21% -elementID (was 40% !! :-)
 751   //   ~20% mutable string ops
 752   if (newCURLStyle) {
 753     NSMutableString *qs;
 754     NSString *p;
 755
 756     self->savePageRequired = YES;
 757     qs = [MutableStrClass stringWithCapacity:64];
 758
 759     [qs appendString:WORequestValueSenderID];
 760     [qs appendString:@"="];
 761     [qs appendString:[self elementID]];
 762     [qs appendString:self->qpJoin];
 763     [qs appendString:WORequestValueSessionID];
 764     [qs appendString:@"="];
 765     [qs appendString:[[self session] sessionID]];
 766     [qs appendString:self->qpJoin];
 767     [qs appendString:WORequestValueContextID];
 768     [qs appendString:@"="];
 769     [qs appendString:[self contextID]];
 770
 771     p = [[self page] componentActionURLForContext:self];
 772
 773     if (testNSURLs) {
 774       if ([p hasPrefix:@"/"]) p = [p substringFromIndex:1];
 775     }
 776
 777     return [self urlWithRequestHandlerKey:
 778                    [WOAppClass componentRequestHandlerKey]
 779                  path:p
 780                  queryString:qs];
 781   }
 782   else {
 783     /* old style URLs ... */
 784     static NSMutableString *url = nil; // THREAD
 785     static IMP addStr = NULL;
 786     NSString *s;
 787
 788     self->savePageRequired = YES;
 789     if (url == nil) {
 790       url = [[MutableStrClass alloc] initWithCapacity:256];
 791       addStr = [url methodForSelector:@selector(appendString:)];
 792       addStr(url, @selector(appendString:), @"/");
 793     }
 794     else
 795       [url setString:@"/"];
 796
 797     /*
 798       Note: component actions *always* require sessions to be able to locate
 799       the request component !
 800     */
 801     addStr(url, @selector(appendString:), [[self session] sessionID]);
 802     addStr(url, @selector(appendString:), @"/");
 803     addStr(url, @selector(appendString:), [self->elementID elementID]);
 804
 805     s = [self urlWithRequestHandlerKey:
 806                 [WOAppClass componentRequestHandlerKey]
 807               path:url queryString:nil];
 808     return s;
 809   }
 810 }
 811
 812 - (NSString *)urlWithRequestHandlerKey:(NSString *)_key
 813   path:(NSString *)_path
 814   queryString:(NSString *)_query
 815 {
 816   if (testNSURLs) { /* use NSURLs for processing */
 817     NSURL *rqUrl;
 818
 819     if ([_path hasPrefix:@"/"]) {
 820 #if DEBUG
 821       [self warnWithFormat:@"got absolute path '%@'", _path];
 822 #endif
 823       _path = [_path substringFromIndex:1];
 824     }
 825
 826     if (_key == nil) _key = [WOAppClass componentRequestHandlerKey];
 827     rqUrl = [self urlForKey:_key];
 828
 829     if ([_query length] > 0) {
 830       NSMutableString *s;
 831
 832       s = [_path mutableCopy];
 833       [s appendString:@"?"];
 834       [s appendString:_query];
 835       rqUrl = [NSURL URLWithString:s relativeToURL:rqUrl];
 836       [s release];
 837     }
 838     else
 839       rqUrl = [NSURL URLWithString:_path relativeToURL:rqUrl];
 840
 841     //[self logWithFormat:@"constructed component URL: %@", rqUrl];
 842
 843     return [rqUrl stringValueRelativeToURL:[self baseURL]];
 844   }
 845   else {
 846     NSMutableString *url;
 847     NSString *tmp;
 848     IMP addStr;
 849
 850     if (_key == nil) _key = [WOAppClass componentRequestHandlerKey];
 851
 852     url = [MutableStrClass stringWithCapacity:256];
 853     addStr = [url methodForSelector:@selector(appendString:)];
 854
 855     /* static part */
 856     if (self->urlPrefix == nil) {
 857       if (!relativeURLs) {
 858         if ((tmp = [self->request headerForKey:@"x-webobjects-server-url"])) {
 859           if ([tmp hasSuffix:@":0"] && [tmp length] > 2) // TODO: BAD BAD BAD
 860             tmp = [tmp substringToIndex:([tmp length] - 2)];
 861           addStr(url, @selector(appendString:), tmp);
 862         }
 863         else if ((tmp = [self->request headerForKey:@"host"])) {
 864           addStr(url, @selector(appendString:), @"http://");
 865           addStr(url, @selector(appendString:), tmp);
 866         }
 867       }
 868
 869       addStr(url, @selector(appendString:), [self->request adaptorPrefix]);
 870       addStr(url, @selector(appendString:), @"/");
 871       tmp = [[self request] applicationName];
 872       if ([tmp length] == 0)
 873         tmp = [(WOApplication *)[self application] name];
 874       if ([tmp length] > 0) {
 875         addStr(url, @selector(appendString:), tmp);
 876         if (WOApplicationSuffix)
 877           addStr(url, @selector(appendString:), WOApplicationSuffix);
 878         addStr(url, @selector(appendString:), @"/");
 879       }
 880
 881       /* cache prefix */
 882       self->urlPrefix = [url copy];
 883       if (debugOn) [self debugWithFormat:@"URL prefix: '%@'", self->urlPrefix];
 884     }
 885     else {
 886       /* prefix is cached :-) */
 887       addStr(url, @selector(appendString:), self->urlPrefix);
 888     }
 889
 890     /* variable part */
 891     addStr(url, @selector(appendString:), _key);
 892     if (_path)
 893       addStr(url, @selector(appendString:), _path);
 894     if ([_query length] > 0) {
 895       addStr(url, @selector(appendString:), @"?");
 896       addStr(url, @selector(appendString:), _query);
 897     }
 898     return url;
 899   }
 900 }
 901 - (NSString *)completeURLWithRequestHandlerKey:(NSString *)_key
 902   path:(NSString *)_path queryString:(NSString *)_query
 903   isSecure:(BOOL)_isSecure port:(int)_port
 904 {
 905   NSMutableString *url = [MutableStrClass stringWithCapacity:256];
 906   [url appendString:_isSecure ? @"https://" : @"http://"];
 907   [url appendString:[[self request] headerForKey:@"host"]];
 908   if (_port > 0) {
 909     if (!(_isSecure && _port == 443) && !(!_isSecure && _port == 80))
 910       [url appendFormat:@":%i", _port];
 911   }
 912   [url appendString:[self urlWithRequestHandlerKey:_key
 913                           path:_path
 914                           queryString:_query]];
 915   return url;
 916 }
 917
 918 - (void)setRequestSenderID:(NSString *)_rid {
 919   WOElementID *eid;
 920
 921   eid = [[WOElementID alloc] initWithString:_rid];
 922   [self->reqElementID release];
 923   self->reqElementID = eid;
 924 }
 925 - (NSString *)senderID {
 926 #if 1
 927   return [self->reqElementID elementID];
 928 #else
 929   NSMutableString *eid;
 930   IMP addStr;
 931   int i;
 932
 933   eid = [MutableStrClass stringWithCapacity:(self->reqElementIdCount * 4) + 1];
 934   addStr = [eid methodForSelector:@selector(appendString:)];
 935   for (i = 0; i < self->reqElementIdCount; i++) {
 936     if (i != 0) addStr(eid, @selector(appendString:), @".");
 937     addStr(eid, @selector(appendString:), [self->reqElementId[i] stringValue]);
 938   }
 939   return eid;
 940 #endif
 941 }
 942
 943 /* DeprecatedMethodsInWO4 */
 944
 945 - (WOApplication *)application {
 946   if (self->application == nil)
 947     self->application = [WOAppClass application];
 948
 949   if (self->application == nil)
 950     NSLog(@"%s: missing application for context %@", __PRETTY_FUNCTION__, self);
 951
 952   return self->application;
 953 }
 954
 955 - (void)setDistributionEnabled:(BOOL)_flag {
 956   IS_DEPRECATED;
 957   [[self session] setDistributionEnabled:_flag];
 958 }
 959 - (BOOL)isDistributionEnabled {
 960   IS_DEPRECATED;
 961   return [[self session] isDistributionEnabled];
 962 }
 963
 964 - (NSString *)url {
 965   return [self componentActionURL];
 966 }
 967
 968 - (NSString *)urlSessionPrefix {
 969   NSMutableString *url;
 970   NSString *tmp;
 971
 972   url = [MutableStrClass stringWithCapacity:128];
 973
 974   [url appendString:[[self request] adaptorPrefix]];
 975   [url appendString:@"/"];
 976   tmp = [[self request] applicationName];
 977   [url appendString:
 978          tmp ? tmp : [(WOApplication *)[self application] name]];
 979
 980 #if DEBUG
 981   if ([url length] == 0) {
 982     [self warnWithFormat:@"(%s): could not determine session URL prefix !",
 983             __PRETTY_FUNCTION__];
 984   }
 985 #endif
 986
 987   return url;
 988 }
 989
 990 @end /* WOContext(DeprecatedMethodsInWO4) */
 991
 992
 993
 994 @implementation WOComponent(Cursors)
 995
 996 - (void)pushCursor:(id)_obj {
 997   if (debugCursor)
 998     [self logWithFormat:@"enter cursor: %@", _obj];
 999
1000   if (!self->cycleContext)
1001     self->cycleContext = [[NSMutableArray alloc] initWithCapacity:8];
1002
1003   /* add to cursor stack */
1004   [self->cycleContext addObject:(_obj ? _obj : [NSNull null])];
1005
1006   /* set active cursor */
1007   [self setObject:_obj forKey:@"_"];
1008 }
1009
1010 - (id)popCursor {
1011   NSMutableArray *ctxStack;
1012   id old;
1013
1014   /* retrieve last context */
1015   old  = [[self objectForKey:@"_"] retain];
1016   [self setObject:nil forKey:@"_"];
1017
1018   /* restore old ctx */
1019   if ((ctxStack = self->cycleContext) != nil) {
1020     unsigned count;
1021
1022     if ((count = [ctxStack count]) > 0) {
1023       [ctxStack removeObjectAtIndex:(count - 1)];
1024       count--;
1025
1026       if (count > 0) {
1027         id obj;
1028
1029         obj = [ctxStack objectAtIndex:(count - 1)];
1030
1031         if (![obj isNotNull]) obj = nil;
1032         [self setObject:obj forKey:@"_"];
1033       }
1034     }
1035   }
1036 #if DEBUG
1037   else {
1038     [self warnWithFormat:@"-popCursor called without cycle ctx !"];
1039   }
1040 #endif
1041
1042   if (debugCursor) {
1043     [self logWithFormat:@"leave cursor: %@ (restored=%@)",
1044             old, [self cursor]];
1045   }
1046
1047   return [old autorelease];
1048 }
1049
1050 - (id)cursor {
1051   NSMutableArray *ctxStack;
1052
1053   // TODO: why do we check for _ODCycleCtx, if we query '_' ?
1054
1055   if ((ctxStack = self->cycleContext) == nil)
1056     /* no cycle context setup for component ... */
1057     return self;
1058   if ([ctxStack count] == 0)
1059     /* nothing contained in cycle context ... */
1060     return self;
1061
1062   return [self objectForKey:@"_"];
1063 }
1064
1065 @end /* WOComponent(Cursors) */