wwwDocRoot.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2005 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: wwwDocRoot.h,v $ $Revision: 1.6 $ $State: Exp $
 *******************************************************************************/
#ifndef DtWwwDocRoot_H_
#define DtWwwDocRoot_H_

#include <rtiMsConfig.h>
#include "ehsHttpConnMgr.h"
#include <lrcConsoleLogXmlBlock.h>
#include <vlutil/vlString.h>
#include <vlutil/vlSmartPointers.h>
#include <basicEhsDoc.h>
#include <memory>
#include <list>

class DtRtiExec;
class DtAboutHTML;
class DtServerConnectionListXML;
class DtWwwDocSubDir;
class HttpRequest;
class HttpResponse;


// DtWwwDocRoot is the base EHS server page.  All requests for .htm, .js, .css, etc.
// are handled directly by the DtWwwDocRoot.  The Xml response pages are added as
// sub-pages as new RTI components connect to the Www Server.
class DT_DLL_WWWEHS DtWwwDocRoot : public DtBasicEhsDoc
{
public:

   // Datastructure to hold the directory structure that can be legally served
   struct Directory {
      typedef std::map< DtString, Directory > DirectoriesByName;
      DirectoriesByName subdirs;
   };

private:
   // No default constructor (needs parent)
   DtWwwDocRoot();
   // Copy Constructor not implimented : Copy not allowed
   DtWwwDocRoot(const DtWwwDocRoot&);
   // Copy Constructor not implimented : Copy not allowed
   DtWwwDocRoot& operator=(const DtWwwDocRoot&);

public:

   DtWwwDocRoot(DtEhsHttpConnectionMgr& parent);
   virtual ~DtWwwDocRoot();

   // Add a new page to the document tree
   virtual void addPage( const DtWebSpyUtils::ConnectionIdentifier& connInfo );

   // Update a specific page's state cache
   virtual void updatePage( const DtWebSpyUtils::ConnectionIdentifier& connInfo,
      std::auto_ptr< DtWebSpyUtils::ConnectionState > connState, bool appendToExisting );

   // Update a specific page's event log
   virtual void appendConnectionLogEvent( const DtWebSpyUtils::ConnectionIdentifier& connInfo,
      unsigned long componentId, DtLrcConsoleLogXmlBlockSP logSegmentSP );


   // Remove a page from the document tree
   virtual void removePage( const DtWebSpyUtils::ConnectionIdentifier& connInfo, const DtString& dropNotificationMsg );

public:
   
   static const DtString& uninitializedPageHTML();

protected:

   // Serve requests for this page
   virtual ResponseCode HandleNonFileRequest( HttpRequest * ipoHttpRequest, 
                                              HttpResponse * ipoHttpResponse );
   
   // Set the About box data creates the /about/ page
   virtual void setupAboutPage();

   // Create/update the Web Spy Front page (with connection list)
   virtual void setupFrontPage();

   // Prepare response page for direct component connect requests 
   virtual void setupDirectRequestPage();


   // Setup the Document Tree directory structure for file service (ie - add the directory
   // for javascript files, css files, etc.)
   virtual void setupDocumentTree();

   // Add the list of directory names to be offered as sub-directories from doc-root
   // Only ( and ALL ) files in these directories are available for service
   virtual void initDirectoryTree();

   // Does the specified page exist?
   virtual bool exists( const DtWebSpyUtils::ConnectionIdentifier& connInfo ) const;

   // Get the requested component from direct connect requests
   // Returns the user's specified connection ID (all parameter value parsing is
   // handled at the client side)
   // Returns a null string if this is not a direct connect request
   DtString parseDirectConnectionRequest( HttpRequest * ipoHttpRequest );

protected:

   typedef std::map< DtWebSpyUtils::ConnectionIdentifier, DtBasicEhsDocSP > ConnInfoToPageMap;

   ConnInfoToPageMap mySubPages;
   DtEhsHttpConnectionMgr& myParent;

   DtAboutHTML* myAboutPage;
   DtServerConnectionListXML* myConnectionListPage;
   std::list< DtWwwDocSubDir* > mySubdirectories;

   // When a direct connect is requested, we must build the response page
   // from its component parts (header + dynamic content + trailer)
   DtString myHeader;
   DtString myTrailer;

   // Tree of Directory names to be served (rooted at rootDir)
   // For security, only add directories which are absolutely required - and only put required
   // files into those directories
   // NOTE: for testing purposes, add directories only in DEBUG mode
   Directory myDirectoryTree;
};

#endif // DtWwwDocRoot_H_