err.no Git - sope/blob - sope-appserver/NGObjWeb/DynamicElements/_WOComplexHyperlink.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 "WOHyperlink.h"
  23
  24 /*
  25   Class Hierachy
  26     [WOHTMLDynamicElement]
  27       [WOHyperlink]
  28         _WOComplexHyperlink
  29           _WOHrefHyperlink
  30           _WOActionHyperlink
  31           _WOPageHyperlink
  32           _WODirectActionHyperlink
  33 */
  34
  35 @interface _WOComplexHyperlink : WOHyperlink
  36 {
  37   /* superclass of most hyperlink classes */
  38 @protected
  39   WOAssociation *fragmentIdentifier;
  40   WOAssociation *string;
  41   WOAssociation *target;
  42   WOAssociation *disabled;
  43   WOElement     *template;
  44
  45   /* new in WO4: */
  46   WOAssociation *queryDictionary;
  47   NSDictionary  *queryParameters;  /* associations beginning with ? */
  48
  49   /* non WO, image stuff */
  50   WOAssociation *filename;         /* path relative to WebServerResources */
  51   WOAssociation *framework;
  52   WOAssociation *src;              /* absolute URL */
  53   WOAssociation *disabledFilename; /* icon for 'disabled' state */
  54 }
  55
  56 - (NSString *)associationDescription;
  57
  58 @end
  59
  60 @interface _WOHrefHyperlink : _WOComplexHyperlink
  61 {
  62   WOAssociation *href;
  63 }
  64 @end
  65
  66 @interface _WOActionHyperlink : _WOComplexHyperlink
  67 {
  68   WOAssociation *action;
  69 }
  70 @end
  71
  72 @interface _WOPageHyperlink : _WOComplexHyperlink
  73 {
  74   WOAssociation *pageName;
  75 }
  76 @end
  77
  78 @interface _WODirectActionHyperlink : _WOComplexHyperlink
  79 {
  80   WOAssociation *actionClass;
  81   WOAssociation *directActionName;
  82   BOOL          sidInUrl;          /* include session-id in wa URL ? */
  83 }
  84 @end
  85
  86 #include "WOElement+private.h"
  87 #include "WOHyperlinkInfo.h"
  88 #include "WOCompoundElement.h"
  89 #include <NGObjWeb/WOApplication.h>
  90 #include <NGObjWeb/WOResourceManager.h>
  91 #include <NGExtensions/NSString+Ext.h>
  92 #include "common.h"
  93
  94 static Class NSURLClass = Nil;
  95
  96 @implementation _WOComplexHyperlink
  97
  98 + (int)version {
  99   return [super version] /* v4 */;
 100 }
 101 + (void)initialize {
 102   NSAssert2([super version] == 4,
 103             @"invalid superclass (%@) version %i !",
 104             NSStringFromClass([self superclass]), [super version]);
 105   if (NSURLClass == Nil)
 106     NSURLClass = [NSURL class];
 107 }
 108
 109 - (id)initWithName:(NSString *)_name
 110   hyperlinkInfo:(WOHyperlinkInfo *)_info
 111   template:(WOElement *)_t
 112 {
 113   if ((self = [super initWithName:_name hyperlinkInfo:_info template:_t])) {
 114     self->template = [_t retain];
 115
 116     self->fragmentIdentifier = _info->fragmentIdentifier;
 117     self->string             = _info->string;
 118     self->target             = _info->target;
 119     self->disabled           = _info->disabled;
 120     self->queryDictionary    = _info->queryDictionary;
 121     self->queryParameters    = _info->queryParameters;
 122
 123     /* image */
 124     self->filename         = _info->filename;
 125     self->framework        = _info->framework;
 126     self->src              = _info->src;
 127     self->disabledFilename = _info->disabledFilename;
 128
 129     self->containsForm = self->queryParameters ? YES : NO;
 130   }
 131   return self;
 132 }
 133
 134 - (void)dealloc {
 135   [self->template           release];
 136   [self->queryDictionary    release];
 137   [self->queryParameters    release];
 138   [self->disabledFilename   release];
 139   [self->filename           release];
 140   [self->framework          release];
 141   [self->src                release];
 142   [self->fragmentIdentifier release];
 143   [self->string             release];
 144   [self->target             release];
 145   [self->disabled           release];
 146   [super dealloc];
 147 }
 148
 149 /* accessors */
 150
 151 - (WOElement *)template {
 152   return self->template;
 153 }
 154
 155 // ******************** responder ********************
 156
 157 - (void)takeValuesFromRequest:(WORequest *)_req inContext:(WOContext *)_ctx {
 158   /* links can take form values !!!! (for query-parameters) */
 159
 160   if (self->queryParameters) {
 161     /* apply values to ?style parameters */
 162     WOComponent  *sComponent = [_ctx component];
 163     NSEnumerator *keys;
 164     NSString     *key;
 165
 166     keys = [self->queryParameters keyEnumerator];
 167     while ((key = [keys nextObject])) {
 168       id assoc, value;
 169
 170       assoc = [self->queryParameters objectForKey:key];
 171
 172       if ([assoc isValueSettable]) {
 173         value = [_req formValueForKey:key];
 174         [assoc setValue:value inComponent:sComponent];
 175       }
 176     }
 177   }
 178
 179   [self->template takeValuesFromRequest:_req inContext:_ctx];
 180 }
 181
 182 - (id)invokeActionForRequest:(WORequest *)_request
 183   inContext:(WOContext *)_ctx
 184 {
 185   if (self->disabled) {
 186     if ([self->disabled boolValueInComponent:[_ctx component]])
 187       return nil;
 188   }
 189
 190   if (![[_ctx elementID] isEqualToString:[_ctx senderID]])
 191     /* link is not the active element */
 192     return [self->template invokeActionForRequest:_request inContext:_ctx];
 193
 194   /* link is active */
 195   [[_ctx session] logWithFormat:@"%@[0x%08X]: no action/page set !",
 196                   NSStringFromClass([self class]), self];
 197   return nil;
 198 }
 199
 200 - (BOOL)_appendHrefToResponse:(WOResponse *)_resp inContext:(WOContext *)_ctx {
 201   [self subclassResponsibility:_cmd];
 202   return NO;
 203 }
 204
 205 - (void)_addImageToResponse:(WOResponse *)_resp inContext:(WOContext *)_ctx {
 206   WOComponent *sComponent = [_ctx component];
 207   NSString *uUri;
 208   NSString *uFi  = nil;
 209   NSArray *languages;
 210
 211   uUri = [[self->src valueInContext:_ctx] stringValue];
 212
 213   if ([self->disabled boolValueInComponent:sComponent]) {
 214     uFi =  [self->disabledFilename stringValueInComponent:sComponent];
 215     if (uFi == nil)
 216       uFi = [self->filename stringValueInComponent:sComponent];
 217   }
 218   else
 219     uFi = [self->filename stringValueInComponent:sComponent];
 220
 221   if (!((uFi != nil) || (uUri != nil)))
 222     return;
 223
 224   languages = [_ctx resourceLookupLanguages];
 225
 226   WOResponse_AddCString(_resp, "<img src=\"");
 227
 228   if (uFi) {
 229     WOResourceManager *rm;
 230
 231     if ((rm = [[_ctx component] resourceManager]) == nil)
 232       rm = [[_ctx application] resourceManager];
 233
 234     uFi = [rm urlForResourceNamed:uFi
 235               inFramework:
 236                 [self->framework stringValueInComponent:sComponent]
 237               languages:languages
 238               request:[_ctx request]];
 239     if (uFi == nil) {
 240       NSLog(@"%@: did not find resource %@", sComponent,
 241             [self->filename stringValueInComponent:sComponent]);
 242       uFi = uUri;
 243     }
 244     [_resp appendContentHTMLAttributeValue:uFi];
 245   }
 246   else {
 247     [_resp appendContentHTMLAttributeValue:uUri];
 248   }
 249   WOResponse_AddChar(_resp, '"');
 250
 251   [self appendExtraAttributesToResponse:_resp inContext:_ctx];
 252   WOResponse_AddCString(_resp, " />");
 253 }
 254
 255 - (void)appendToResponse:(WOResponse *)_response inContext:(WOContext *)_ctx {
 256   WOComponent *sComponent = [_ctx component];
 257   NSString *content;
 258   NSString *targetView;
 259   NSString *queryString = nil;
 260
 261   if ([[_ctx request] isFromClientComponent])
 262     return;
 263
 264   content    = [self->string valueInContext:_ctx];
 265   targetView = [self->target stringValueInComponent:sComponent];
 266
 267   WOResponse_AddCString(_response, "<a href=\"");
 268
 269   if ([self _appendHrefToResponse:_response inContext:_ctx]) {
 270       queryString = [self queryStringForQueryDictionary:
 271                             [self->queryDictionary valueInComponent:sComponent]
 272                           andQueryParameters:self->queryParameters
 273                           inContext:_ctx];
 274   }
 275
 276   if (self->fragmentIdentifier) {
 277       [_response appendContentCharacter:'#'];
 278       WOResponse_AddString(_response,
 279          [self->fragmentIdentifier stringValueInComponent:sComponent]);
 280   }
 281   if (queryString) {
 282     [_response appendContentCharacter:'?'];
 283     WOResponse_AddString(_response, queryString);
 284   }
 285   [_response appendContentCharacter:'"'];
 286
 287   if (targetView) {
 288     WOResponse_AddCString(_response, " target=\"");
 289     WOResponse_AddString(_response, targetView);
 290     [_response appendContentCharacter:'"'];
 291   }
 292
 293   [self appendExtraAttributesToResponse:_response inContext:_ctx];
 294
 295   if (self->otherTagString) {
 296     WOResponse_AddChar(_response, ' ');
 297     WOResponse_AddString(_response,
 298                          [self->otherTagString stringValueInComponent:
 299                            [_ctx component]]);
 300   }
 301   [_response appendContentCharacter:'>'];
 302
 303   /* content */
 304   [self->template appendToResponse:_response inContext:_ctx];
 305   if (content) [_response appendContentHTMLString:content];
 306
 307   /* image content */
 308   if ((self->src != nil) || (self->filename != nil))
 309     [self _addImageToResponse:_response inContext:_ctx];
 310
 311   /* closing tag */
 312   WOResponse_AddCString(_response, "</a>");
 313 }
 314
 315 /* description */
 316
 317 - (NSString *)associationDescription {
 318   NSMutableString *str = [NSMutableString stringWithCapacity:256];
 319
 320   if (self->fragmentIdentifier)
 321     [str appendFormat:@" fragment=%@", self->fragmentIdentifier];
 322   if (self->string)   [str appendFormat:@" string=%@",   self->string];
 323   if (self->target)   [str appendFormat:@" target=%@",   self->target];
 324   if (self->disabled) [str appendFormat:@" disabled=%@", self->disabled];
 325
 326   /* image .. */
 327   if (self->filename)  [str appendFormat:@" filename=%@",  self->filename];
 328   if (self->framework) [str appendFormat:@" framework=%@", self->framework];
 329   if (self->src)       [str appendFormat:@" src=%@",       self->src];
 330
 331   return str;
 332 }
 333
 334 @end /* _WOComplexHyperlink */
 335
 336 @implementation _WOHrefHyperlink
 337
 338 static BOOL debugStaticLinks = NO;
 339
 340 + (void)initialize {
 341   NSUserDefaults *ud = [NSUserDefaults standardUserDefaults];
 342
 343   debugStaticLinks = [ud boolForKey:@"WODebugStaticLinkProcessing"];
 344 }
 345
 346 - (id)initWithName:(NSString *)_name
 347   hyperlinkInfo:(WOHyperlinkInfo *)_info
 348   template:(WOElement *)_t
 349 {
 350   if ((self = [super initWithName:_name hyperlinkInfo:_info template:_t])) {
 351     self->href = _info->href;
 352   }
 353   return self;
 354 }
 355
 356 - (void)dealloc {
 357   [self->href release];
 358   [super dealloc];
 359 }
 360
 361 /* URI generation */
 362
 363 - (BOOL)shouldRewriteURLString:(NSString *)_s inContext:(WOContext *)_ctx {
 364   // TODO: we need a binding to disable rewriting!
 365   if ([_s hasPrefix:@"mailto:"])
 366     return NO;
 367   if ([_s hasPrefix:@"javascript:"])
 368     return NO;
 369   return YES;
 370 }
 371
 372 - (BOOL)_appendHrefToResponse:(WOResponse *)_r inContext:(WOContext *)_ctx {
 373   NSString *s;
 374   id    hrefValue;
 375   NSURL *url, *base;
 376
 377   base      = [_ctx baseURL];
 378   hrefValue = [self->href valueInContext:_ctx];
 379   url       = hrefValue;
 380
 381   if (hrefValue == nil)
 382     return NO;
 383
 384   if ([hrefValue isKindOfClass:NSURLClass]) {
 385     s = [hrefValue stringValueRelativeToURL:base];
 386   }
 387   else {
 388     s = [hrefValue stringValue];
 389
 390     if ([self shouldRewriteURLString:s inContext:_ctx]) {
 391       if ([s isAbsoluteURL]) {
 392         // TODO: why are we doing this? we could just pass through the string?
 393         //    => probably to generate relative links
 394         url = [NSURLClass URLWithString:s];
 395       }
 396       else if (base != nil) {
 397         /* avoid creating a new URL for ".", just return the base */
 398         url = [s isEqualToString:@"."]
 399           ? base
 400           : [NSURLClass URLWithString:s relativeToURL:base];
 401       }
 402       else {
 403         [self logWithFormat:@"WARNING: missing base URL in context ..."];
 404         WOResponse_AddString(_r, s);
 405         return YES;
 406       }
 407
 408       if (url == nil) {
 409         [self logWithFormat:
 410                 @"couldn't construct URL from 'href' string '%@' (base=%@)",
 411                 s, base];
 412         return NO;
 413       }
 414
 415       s = [url stringValueRelativeToURL:base];
 416     }
 417   }
 418
 419   /* generate URL */
 420
 421   if (debugStaticLinks) {
 422     [self logWithFormat:@"static links based on 'href': '%@'", hrefValue];
 423     [self logWithFormat:@"  base     %@", base];
 424     [self logWithFormat:@"  base-abs %@", [base absoluteString]];
 425     [self logWithFormat:@"  url      %@", url];
 426     [self logWithFormat:@"  url-abs  %@", [url absoluteString]];
 427     [self logWithFormat:@"  string   %@", s];
 428   }
 429   WOResponse_AddString(_r, s);
 430   return YES;
 431 }
 432
 433 /* description */
 434
 435 - (NSString *)associationDescription {
 436   NSMutableString *str = [NSMutableString stringWithCapacity:256];
 437
 438   [str appendFormat:@" href=%@", self->href];
 439   [str appendString:[super associationDescription]];
 440
 441   return str;
 442 }
 443
 444 @end /* _WOHrefHyperlink */
 445
 446 @implementation _WOActionHyperlink
 447
 448 - (id)initWithName:(NSString *)_name
 449   hyperlinkInfo:(WOHyperlinkInfo *)_info
 450   template:(WOElement *)_t
 451 {
 452   if ((self = [super initWithName:_name hyperlinkInfo:_info template:_t])) {
 453     self->action = _info->action;
 454   }
 455   return self;
 456 }
 457
 458 - (void)dealloc {
 459   [self->action release];
 460   [super dealloc];
 461 }
 462
 463 /* dynamic invocation */
 464
 465 - (id)invokeActionForRequest:(WORequest *)_request
 466   inContext:(WOContext *)_ctx
 467 {
 468   if (self->disabled) {
 469     if ([self->disabled boolValueInComponent:[_ctx component]])
 470       return nil;
 471   }
 472
 473   if (![[_ctx elementID] isEqualToString:[_ctx senderID]])
 474     /* link is not the active element */
 475     return [self->template invokeActionForRequest:_request inContext:_ctx];
 476
 477   /* link is active */
 478   return [self executeAction:self->action inContext:_ctx];
 479 }
 480
 481 - (BOOL)_appendHrefToResponse:(WOResponse *)_response
 482   inContext:(WOContext *)_ctx
 483 {
 484   WOResponse_AddString(_response, [_ctx componentActionURL]);
 485   return YES;
 486 }
 487
 488 /* description */
 489
 490 - (NSString *)associationDescription {
 491   NSMutableString *str = [NSMutableString stringWithCapacity:256];
 492
 493   [str appendFormat:@" action=%@", self->action];
 494   [str appendString:[super associationDescription]];
 495   return str;
 496 }
 497
 498 @end /* _WOActionHyperlink */
 499
 500 @implementation _WOPageHyperlink
 501
 502 - (id)initWithName:(NSString *)_name
 503   hyperlinkInfo:(WOHyperlinkInfo *)_info
 504   template:(WOElement *)_t
 505 {
 506   if ((self = [super initWithName:_name hyperlinkInfo:_info template:_t])) {
 507     self->pageName = _info->pageName;
 508   }
 509   return self;
 510 }
 511
 512 - (void)dealloc {
 513   [self->pageName release];
 514   [super dealloc];
 515 }
 516
 517 /* actions */
 518
 519 - (id)invokeActionForRequest:(WORequest *)_request
 520   inContext:(WOContext *)_ctx
 521 {
 522   WOComponent *page;
 523   NSString    *name;
 524
 525   if (self->disabled) {
 526     if ([self->disabled boolValueInComponent:[_ctx component]])
 527       return nil;
 528   }
 529
 530   if (![[_ctx elementID] isEqualToString:[_ctx senderID]])
 531     /* link is not the active element */
 532     return [self->template invokeActionForRequest:_request inContext:_ctx];
 533
 534   /* link is the active element */
 535
 536   name = [self->pageName stringValueInComponent:[_ctx component]];
 537   page = [[_ctx application] pageWithName:name inContext:_ctx];
 538
 539   if (page == nil) {
 540     [[_ctx session] logWithFormat:
 541                       @"%@[0x%08X]: did not find page with name %@ !",
 542                       NSStringFromClass([self class]), self, name];
 543   }
 544   return page;
 545 }
 546
 547 - (BOOL)_appendHrefToResponse:(WOResponse *)_response
 548   inContext:(WOContext *)_ctx
 549 {
 550   /*
 551     Profiling:
 552       87% -componentActionURL
 553       13% NSString dataUsingEncoding(appendContentString!)
 554     TODO(prof): use addcstring
 555   */
 556   WOResponse_AddString(_response, [_ctx componentActionURL]);
 557   return YES;
 558 }
 559
 560 /* description */
 561
 562 - (NSString *)associationDescription {
 563   NSMutableString *str = [NSMutableString stringWithCapacity:256];
 564
 565   [str appendFormat:@" pageName=%@", self->pageName];
 566   [str appendString:[super associationDescription]];
 567   return str;
 568 }
 569
 570 @end /* _WOPageHyperlink */
 571
 572 @implementation _WODirectActionHyperlink
 573
 574 - (id)initWithName:(NSString *)_name
 575   hyperlinkInfo:(WOHyperlinkInfo *)_info
 576   template:(WOElement *)_t
 577 {
 578   if ((self = [super initWithName:_name hyperlinkInfo:_info template:_t])) {
 579     self->actionClass      = _info->actionClass;
 580     self->directActionName = _info->directActionName;
 581     self->sidInUrl         = _info->sidInUrl;
 582
 583     self->containsForm = NO; /* direct actions are never form stuff ... */
 584   }
 585   return self;
 586 }
 587
 588 - (void)dealloc {
 589   [self->actionClass      release];
 590   [self->directActionName release];
 591   [super dealloc];
 592 }
 593
 594 /* href */
 595
 596 - (void)takeValuesFromRequest:(WORequest *)_req inContext:(WOContext *)_ctx {
 597   /* DA links can *never* take form values !!!! */
 598   [self->template takeValuesFromRequest:_req inContext:_ctx];
 599 }
 600
 601 - (id)invokeActionForRequest:(WORequest *)_request
 602   inContext:(WOContext *)_ctx
 603 {
 604   /* DA links can *never* invoke an action !!!! */
 605   return [self->template invokeActionForRequest:_request inContext:_ctx];
 606 }
 607
 608 - (BOOL)_appendHrefToResponse:(WOResponse *)_response
 609   inContext:(WOContext *)_ctx
 610 {
 611   WOComponent         *sComponent;
 612   NSString            *daClass;
 613   NSString            *daName;
 614   NSMutableDictionary *qd;
 615   NSDictionary        *tmp;
 616
 617   sComponent = [_ctx component];
 618   daClass = [self->actionClass stringValueInComponent:sComponent];
 619   daName  = [self->directActionName stringValueInComponent:sComponent];
 620
 621   if (daClass) {
 622     if (daName) {
 623       if (![daClass isEqualToString:@"DirectAction"])
 624         daName = [NSString stringWithFormat:@"%@/%@", daClass, daName];
 625     }
 626     else
 627       daName = daClass;
 628   }
 629
 630   qd = [NSMutableDictionary dictionaryWithCapacity:16];
 631
 632   /* add query dictionary */
 633
 634   if (self->queryDictionary) {
 635     if ((tmp = [self->queryDictionary valueInComponent:sComponent]))
 636       [qd addEntriesFromDictionary:tmp];
 637   }
 638
 639   /* add ?style parameters */
 640
 641   if (self->queryParameters) {
 642     NSEnumerator *keys;
 643     NSString     *key;
 644
 645     keys = [self->queryParameters keyEnumerator];
 646     while ((key = [keys nextObject])) {
 647       id assoc, value;
 648
 649       assoc = [self->queryParameters objectForKey:key];
 650       value = [assoc stringValueInComponent:sComponent];
 651
 652       [qd setObject:(value ? value : @"") forKey:key];
 653     }
 654   }
 655
 656   /* add session ID */
 657
 658   if (self->sidInUrl) {
 659     if ([_ctx hasSession]) {
 660       WOSession *sn;
 661
 662       sn = [_ctx session];
 663       [qd setObject:[sn sessionID] forKey:WORequestValueSessionID];
 664
 665       if (![sn isDistributionEnabled]) {
 666         [qd setObject:[[WOApplication application] number]
 667             forKey:WORequestValueInstance];
 668       }
 669     }
 670   }
 671
 672   WOResponse_AddString(_response,
 673                        [_ctx directActionURLForActionNamed:daName
 674                              queryDictionary:qd]);
 675   return NO;
 676 }
 677
 678 /* description */
 679
 680 - (NSString *)associationDescription {
 681   NSMutableString *str = [NSMutableString stringWithCapacity:256];
 682
 683   if (self->actionClass)
 684     [str appendFormat:@" actionClass=%@", self->actionClass];
 685   if (self->directActionName)
 686     [str appendFormat:@" directAction=%@", self->directActionName];
 687
 688   [str appendString:[super associationDescription]];
 689   return str;
 690 }
 691
 692 @end /* _WODirectActionHyperlink */