/*
  Copyright (C) 2004 SKYRIX Software AG

  This file is part of OpenGroupware.org.

  OGo is free software; you can redistribute it and/or modify it under
  the terms of the GNU Lesser General Public License as published by the
  Free Software Foundation; either version 2, or (at your option) any
  later version.

  OGo 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 Lesser General Public
  License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with OGo; see the file COPYING.  If not, write to the
  Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/
// $Id$

#include "SoObjectSOAPDispatcher.h"
#include "SoObject.h"
#include "NSException+HTTP.h"
#include "WOContext+SoObjects.h"
#include "SoDefaultRenderer.h"
#include <NGObjWeb/WOActionResults.h>
#include <NGObjWeb/WOContext.h>
#include <NGObjWeb/WOResponse.h>
#include <NGObjWeb/WORequest.h>
#include "common.h"
#include <DOM/DOM.h>
#include <SaxObjC/XMLNamespaces.h>

/*
  TODO: is it required by SOAP that the HTTP method is POST?

  SOAP sample:
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <SOAP-ENV:Envelope 
      xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
      xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
      xmlns:xsd="http://www.w3.org/1999/XMLSchema" 
      xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
    >
      <SOAP-ENV:Body 
        xmlns:types="http://schemas.novell.com/2003/10/NCSP/types.xsd" 
        SOAP-ENV:encodingStyle=""
      >
        <loginRequest>
          <types:auth xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
                      xsi:type="types:PlainText"
          >
            <types:username>dummy</types:username>
            <types:password>user</types:password>
          </types:auth>
        </loginRequest>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
*/

@interface SoSOAPRenderer : SoDefaultRenderer
@end

@implementation SoObjectSOAPDispatcher

static BOOL debugOn      = NO;
static BOOL debugParsing = NO;

+ (void)initialize {
  NSUserDefaults *ud = [NSUserDefaults standardUserDefaults];
  
  debugOn = [ud boolForKey:@"SoObjectSOAPDispatcherDebugEnabled"];
  if (debugOn) NSLog(@"Note: SOPE SOAP dispatcher debugging turned on.");
}

/* XML actions */

- (id)performSOAPAction:(NSString *)_actionName
  header:(id<DOMElement>)_header body:(id<DOMElement>)_body
  inContext:(WOContext *)_ctx
{
  id clientObject;
  id methodObject;
  id resultObject;

  if (debugOn) 
    [self debugWithFormat:@"calling SOAP method: '%@'", _actionName];
  
  /* find client object */
  
  if ((clientObject = [_ctx clientObject]) != nil) {
    if (debugOn)
      [self debugWithFormat:@"  client object from ctx: %@", clientObject];
  }
  else if ((clientObject = [self->object clientObject])) {
    if (debugOn)
      [self debugWithFormat:@"  setting client object: %@", clientObject];
    [_ctx setClientObject:clientObject];
  }

  /* find callable (method) object */
  
  // TODO: should we allow acquisition?
  methodObject = [clientObject lookupName:_actionName inContext:_ctx
			       acquire:NO];
  if (methodObject == nil) {
    if ([_actionName hasSuffix:@"Request"])
      _actionName = [_actionName substringToIndex:[_actionName length] - 7];
    methodObject = [clientObject lookupName:_actionName inContext:_ctx
				 acquire:NO];
  }
  
  if (methodObject == nil) {
    [self debugWithFormat:@"WARNING: could not locate SOAP method: %@", 
	    _actionName];
    return [NSException exceptionWithHTTPStatus:501 /* not implemented */
			reason:@"did not find the specified SOAP method"];
  }
  else if (![methodObject isCallable]) {
    [self debugWithFormat:
	    @"WARNING: object found for SOAP method '%@' is not callable: "
	    @"%@", _actionName, methodObject];
    return [NSException exceptionWithHTTPStatus:501 /* not implemented */
			reason:@"did not find the specified SOAP method"];
  }
  if (debugOn) [self debugWithFormat:@"  method: %@", methodObject];
  
  /* apply arguments */
  
  // TODO: use some query syntax in product.plist to retrieve parameters
  //       from SOAP
  
  // TODO: somehow apply SOPE header/body?
  if (_header) [_ctx setObject:_header forKey:@"SOAPHeader"];
  if (_body)   [_ctx setObject:_body   forKey:@"SOAPBody"];
  
  if ([methodObject respondsToSelector:
  		      @selector(takeValuesFromRequest:inContext:)]) {
    if (debugOn)
      [self debugWithFormat:@"  applying values from request ..."];
    [methodObject takeValuesFromRequest:[_ctx request] inContext:_ctx];
  }
  
  /* perform call */
  
  resultObject = [methodObject callOnObject:[_ctx clientObject] 
			       inContext:_ctx];
  if (debugOn) [self debugWithFormat:@"got SOAP result: %@", resultObject];
  return resultObject;
}

- (id)performSOAPAction:(NSString *)_actionName document:(id)_dom
  inContext:(WOContext *)_ctx
{
  id<DOMElement>  envelope;
  id<DOMElement>  header;
  id<DOMElement>  body;
  id<DOMNodeList> list;

  /* envelope */

  envelope = [_dom documentElement];
  if (![[envelope tagName] isEqualToString:@"Envelope"] ||
      ![[envelope namespaceURI] isEqualToString:XMLNS_SOAP_ENVELOPE]) {
    [self debugWithFormat:@"Note: missing SOAP envelope at document root."];
    return [NSException exceptionWithHTTPStatus:400 /* bad request */
			reason:@"could not parse SOAP content of request"];
  }
  if (debugParsing) [self debugWithFormat:@"envelope: %@", envelope];
  
  [_ctx setObject:envelope forKey:@"SOAPEnvelope"];
  
  /* header */

  list = [envelope getElementsByTagName:@"Header"];
  // TODO: not yet supported by DOMElement: namespaceURI:XMLNS_SOAP_ENVELOPE];
  if ([list length] > 1) {
    [self logWithFormat:
	    @"WARNING: multiple SOAP headers in request?! (using first)"];
  }
  header = [list length] > 0 ? [list objectAtIndex:0] : nil;
  if (debugParsing) [self debugWithFormat:@"header: %@", header];

  /* body */
  
  list = [envelope getElementsByTagName:@"Body"];
  // TODO: not yet supported by DOMElement: namespaceURI:XMLNS_SOAP_ENVELOPE];
  if ([list length] == 0) {
    [self debugWithFormat:@"Note: missing SOAP body."];
    return [NSException exceptionWithHTTPStatus:400 /* bad request */
			reason:@"could not parse SOAP body of request"];
  }
  else if ([list length] > 1) {
    [self logWithFormat:
	    @"WARNING: multiple SOAP bodies in request?! (using first)"];
  }
  body = [list objectAtIndex:0];
  if (debugParsing) [self debugWithFormat:@"body: %@", body];
  
  /* process */
  
  return [self performSOAPAction:_actionName 
	       header:header body:body inContext:_ctx];
}

/* main dispatcher */

- (id)dispatchInContext:(WOContext *)_ctx {
  NSAutoreleasePool *pool;
  WORequest         *rq;
  NSString          *SOAPAction;
  id<DOMDocument>   dom;
  id resultObject;
  
  pool = [[NSAutoreleasePool alloc] init];
  
  if ((rq = [_ctx request]) == nil) {
    [self logWithFormat:@"ERROR: missing request in context!"];
    return nil;
  }
  
  /* 
     Note: the SOAPAction is also contained in the body which is probably
           considered the authority.
  */
  
  SOAPAction = [rq headerForKey:@"soapaction"];
  if ([SOAPAction length] == 0) {
    [self logWithFormat:@"ERROR: missing SOAPAction HTTP header!"];
    return nil;
  }

  /* parse XML */
  
  if ((dom = [rq contentAsDOMDocument]) == nil) {
    [self debugWithFormat:@"Note: could not parse XML content of request"];
    return [NSException exceptionWithHTTPStatus:400 /* bad request */
			reason:@"could not parse XML content of request"];
  }
  
  resultObject = 
    [[self performSOAPAction:SOAPAction document:dom inContext:_ctx]retain];
  [pool release];
  
  return [resultObject autorelease];
}

/* debugging */

- (NSString *)loggingPrefix {
  return @"[obj-soap-dispatch]";
}
- (BOOL)isDebuggingEnabled {
  return debugOn;
}

@end /* SoObjectSOAPDispatcher */

@implementation SoSOAPRenderer

// TODO: render exceptions as SOAP faults
// TODO: maybe support rendering of DOM trees? (should be supported by default)
// TODO: maybe some "schema" driven rendering

@end /* SoSOAPRenderer */