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