/AObjectServer/AOS_Base/AOSConfiguration.hpp

/*

Written by Alex Chachanashvili



$Id: AOSConfiguration.hpp 336 2009-01-15 22:11:41Z achacha $

*/

#ifndef INCLUDED__AOSConfiguration_HPP__

#define INCLUDED__AOSConfiguration_HPP__



#include "apiAOS_Base.hpp"

#include "AOSAdminInterface.hpp"

#include "AOSDirectoryConfig.hpp"

#include "ABitArray.hpp"

#include "AFileSystem.hpp"

#include "AXmlDocument.hpp"

#include "AXmlElement.hpp"



class AUrl;

class AFile_Socket;

class AOSController;

class ASynchronization;

class ALog;

class AOSServices;

class AOSContext;



/*!

Global configuration

*/

class AOS_BASE_API AOSConfiguration : public AOSAdminInterface

{

public:

  //! Number of times to retry reading first char in HTTP header

  static int FIRST_CHAR_RETRIES;

  //! Initial sleep time waiting on reading first char

  static int SLEEP_STARTTIME;

  //! Increment the sleep every retry if first char is not read

  static int SLEEP_INCREMENT;

  //! If HTTP pipelining is enabled

  static bool IS_HTTP_PIPELINING_ENABLED;

  //! If gzip compression is enabled

  static bool GZIP_IS_ENABLED;

  //! Minimum size of content to compress

  static size_t GZIP_MIN_SIZE;

  //! Default gzip compression level

  static int GZIP_DEFAULT_LEVEL;

  //! Sleep time when flushing data and socket is unavailable

  static int UNAVAILABLE_SLEEP_TIME;

  //! Number of retries before considering socket unavailable for too long

  static int UNAVAILABLE_RETRIES;



  //! Class name

  static const AString CLASS;



  //! Map of locale to directory

  //! getPrev() points to parent locale as fallthrough, getNext() is always NULL

  class LocaleDirInfo : public ABase

  {

  public:

    LocaleDirInfo() {}

    LocaleDirInfo(AFilename& f) : dir(f) {}

    LocaleDirInfo(const LocaleDirInfo& that) : dir(that.dir) {}

    LocaleDirInfo& operator=(const LocaleDirInfo& that) { dir.set(that.dir); return *this; }

    bool operator< (const LocaleDirInfo& that) { return dir < that.dir; }



    AFilename dir;

  };

  

  //! Map of locale name to a directory

  typedef std::map<AString, LocaleDirInfo> MAP_LOCALE_DIRS;



public:

  /*!

  ctor



  @param baseDir where aos_root directory is to be found

  @param services reference to AOSServices object

  */

  AOSConfiguration(const AFilename& baseDir, AOSServices& services);

  

  //! virtual dtor

  virtual ~AOSConfiguration();



  //! Path to the database URL

  static const AString DATABASE_URL;



  //! Path to the database connection to create per URL

  static const AString DATABASE_CONNECTIONS;



  /*!

  Configuration XML document's root element

  Read only



  @return constant reference to AXmlElement that is the configuration root

  */

  const AXmlElement& getConfigRoot() const;

  

  /*!

  Configuration XML document's root element

  Modifiable



  @return reference to AXmlElement that is the configuration root

  */

  AXmlElement& useConfigRoot();



  /*!

  Base directory



  @return constant reference to AFilename

  */

  const AFilename& getBaseDir() const;



  /*!

  Base website directory



  @return constant reference to AFilename

  */

  const AFilename& getBaseWebSiteDir() const;



  /*!

  Base locale for directories without locale specification

  Used for data/ static/ directories



  @return constant reference to the base locale string  (defaults to en-us)

  */

  const AString& getBaseLocale() const;



  /*!

  Get a map of locales to static directories



  @return map of locales to static directories

  */

  const AOSConfiguration::MAP_LOCALE_DIRS& getLocaleStaticDirs() const;

  

  /*!

  Get a map of locales to data directories



  @return map of locales to data directories

  */

  const AOSConfiguration::MAP_LOCALE_DIRS& getLocaleDataDirs() const;



  /*!

  Load XML configuration for a given module in config directory

  Attached XML contents to the /config root



  @param filename of the module config to load

  */

  void loadConfig(const AFilename& filename);



  /*!

  Load all the controllers from the file system

  Checks dynamic and static directories and generates the website based on them

  */

  void loadControllers();



  /*!

  Checks all the loaded controllers against executors in the AOSServices

  */

  bool validateControllers();



  /*!

  Convert a given URl to the reported values

  server and port are used as per configuration



  @param url to convert

  */

  void convertUrlToReportedServerAndPort(AUrl& url) const;



  /*!

  Reported hostname

  Used when load balanced and a common DNS entry is desired

  

  @return constant reference to reported hostname

  */

  const AString& getReportedHostname() const;

  

  /*!

  Reported HTTP port

  Used when load balanced and a common DNS entry is desired

  

  @return reported HTTP port

  */

  int getReportedHttpPort() const;



  /*!

  Reported HTTPS port

  Used when load balanced and a common DNS entry is desired

  

  @return reported HTTPS port

  */

  int getReportedHttpsPort() const;



  /*!

  Set reported hostname



  @param configPath path in the config file to use content as hostname

  */

  void setReportedHostname(const AString& configPath);



  /*!

  Set reported port



  @param configPath path in the config file to use content as port

  */

  void setReportedHttpPort(const AString& configPath);



  /*!

  Set reported secure port



  @param configPath path in the config file to use content as port

  */

  void setReportedHttpsPort(const AString& configPath);



  /*!

  Reported 'Server:' value in the HTTP response header

  

  @return constant reference to the server name

  */

  const AString& getReportedServer() const;



  /*!

  Set server name



  @param configPath path in the config file to use content as server name

  */

  void setReportedServer(const AString& configPath);



  /*!

  Admin base directory



  @return constant reference to the AFilename

  */

  const AFilename& getAdminBaseHttpDir() const;



  /*!

  Set default filename



  @param filename to use as default (index.html is default)

  */

  void setAosDefaultFilename(const AString& filename);



  /*!

  Get default filename



  @return constant reference to the AFilename

  */

  const AString& getAosDefaultFilename() const;



  /*!

  Get default input processor registered class name



  @return constant reference to the AFilename

  */

  const AString& getAosDefaultInputProcessor() const;

  

  /*!

  Set default input processor



  @param name of the registered input processor (no default)

  */

  void setAosDefaultInputProcessor(const AString& name);



  /*!

  Get default ouput generator registered class name



  @return constant reference to the AFilename

  */

  const AString& getAosDefaultOutputGenerator() const;

  

  /*!

  Set default output generator



  @param name of the registered output generator (xml is default)

  */

  void setAosDefaultOutputGenerator(const AString& name);



  /*!

  Get the default mime type when it cannot be matched with extension



  @return configured default MIME type

  */

  const AString& getDefaultMimeType() const;

  

  /*!

  Map mime type from extension

  

  @param ext Extension to try and map

  @param target appended with extension if found

  @return true if extension is mapped and value was found, false if extension is not mapped

  */

  bool getMimeTypeFromExt(const AString& ext, AString& target) const;

  

  /*!

  Set the mime type based on extension or use configured default if extension is not found

  

  @param ext Extension to try and map, if not found will use default

  @param responseHeader AHTTPResponseHeader that will get set

  */

  void setMimeTypeFromExt(const AString& ext, AHTTPResponseHeader& responseHeader);



  /*!

  Set the mime type based on extension or use configured default if extension is not found

  

  @param ext Extension to try and map, if not found will use default

  @param context AOSContext contains the HTTP response header that will get set

  */

  void setMimeTypeFromExt(const AString& ext, AOSContext& context);



  /*!

  Set the MIME type in response header based on the extension found in the request header's URL

  NOTE: If extension mapping not found then default is set



  @param context AOSContext contains both request and response header

  */

  void setMimeTypeFromRequestExt(AOSContext& context);

  

  /*!

  Location of the config directory

  This directory is not intended to be localized (see data/ and static/)



  @return constant reference to AFilename object

  */

  const AFilename& getAosBaseConfigDirectory() const;



  /*!

  Location of the dynamic directory (controllers)

  This directory is not intended to be localized (see data/ and static/)



  @return constant reference to AFilename object

  */

  const AFilename& getAosBaseDynamicDirectory() const;



  /*!

  Location of the data directory based on default locale



  @return constant reference to AFilename object

  */

  const AFilename& getAosBaseDataDirectory() const;



  /*!

  Location of the static directory based on default locale



  @return constant reference to AFilename object

  */

  const AFilename& getAosBaseStaticDirectory() const;



  /*!

  Location of the data directory based on locale, if no locale specific one found, base returned instead



  @param request to check HTTP request for Accept-Languages: pair for correct directory

  @param target to receive localized directory

  */

  void getAosDataDirectory(AHTTPRequestHeader& request, AFilename& target) const;



  /*!

  Location of the static directory based on locale, if no locale specific one found, base returned instead



  @param request to check HTTP request for Accept-Languages: pair for correct directory

  @param target to receive localized directory

  */

  void getAosStaticDirectory(AHTTPRequestHeader& request, AFilename& target) const;



  /*!

  Location of the static directories based on locale, default is appended to end



  @param request to check HTTP request for Accept-Languages: pair for correct directory

  @param directories to add to, last entry is always the default locale location

  */

  void getAosStaticDirectoryChain(AHTTPRequestHeader& request, LIST_AFilename& directories);



  /*!

  Location of the data directories based on locale, default is appended to end



  @param request to check HTTP request for Accept-Languages: pair for correct directory

  @param directories to add to, last entry is always the default locale location

  */

  void getAosDataDirectoryChain(AHTTPRequestHeader& request, LIST_AFilename& directories);



  /*!

  Check is dumpContext is allowed in the configuration file



  @return true if allowed

  */

  bool isDumpContextAllowed() const;

  

  /*!

  Check if overrideInput is allowed as parameter



  @return true if allowed

  */

  bool isInputOverrideAllowed() const;



  /*!

  Check if overrideOutput is allowed as parameter



  @return true if allowed

  */

  bool isOutputOverrideAllowed() const;



  /*!

  Get a list of XML config files in conf/load from which dynamic libraries to load



  @param container for AFileInfo objects for xml config files corresponding to libraries to load

  */

  void getDynamicModuleConfigsToLoad(AFileSystem::FileInfos& target) const;

  

  /*!

  Controller for a given filename (should be absolute based on / as root, as if it was a URL)



  Returned pointer should never be deleted by the caller



  @param f AFilename

  @return constant pointer AOSController for a given AFilename

  */

  const AOSController * const getController(const AFilename& f) const;



  /*!

  Controller for a given URL



  Returned pointer should never be deleted by the caller



  @param url AUrl

  @return constant pointer AOSController for a given URL

  */

  const AOSController* const getController(const AUrl& url) const;



  /*!

  Directory config for a given URL



  Returned pointer should never be deleted by the caller



  @param f AFilename

  @return constant pointer AOSDirectoryConfig for a given URL

  */

  const AOSDirectoryConfig* const getDirectoryConfig(const AFilename& f) const;



  /*!

  Directory config for a given URL



  Returned pointer should never be deleted by the caller



  @param url AUrl

  @return constant pointer AOSDirectoryConfig for a given URL

  */

  const AOSDirectoryConfig* const getDirectoryConfig(const AUrl& url) const;



  /*!

  Get a set of extensions that are to be compressed based on config

  

  @return constant reference to a set of extension that should be compressed

  */

  const SET_AString& getCompressedExtensions() const;



  /*!

  Admin interface

  */

  virtual void adminEmitXml(AXmlElement& eBase, const AHTTPRequestHeader& request);

  virtual void adminProcessAction(AXmlElement& eBase, const AHTTPRequestHeader& request);

  virtual const AString& getClass() const;



  /*!

  ADebugDumpable

  */

  virtual void debugDump(std::ostream& os = std::cerr, int indent = 0x0) const;



private:

  // Services

  AOSServices& m_Services;



  // Directory where all info lives for this instance

  AFilename m_BaseDir;



  // Directory where all website content info lives for this instance

  AFilename m_BaseWebSiteDir;



  // Configuration bits and Ini profile

  ABitArray m_ConfigBits;



  // Controllers

  typedef std::map<AString, AOSController *> MAP_ASTRING_CONTROLLERPTR;

  MAP_ASTRING_CONTROLLERPTR m_ControllerPtrs;

  

  // Directory configs

  // Maps absolute path (relative to dynamic root) to AXmlDocument with config

  typedef std::map<AString, AOSDirectoryConfig *> MAP_ASTRING_CONFIG;

  MAP_ASTRING_CONFIG m_DirectoryConfigs;



  // Extensions that should be compressed by default (assuming min size criterion is met)

  SET_AString m_CompressedExtensions;



  // Initialize statics

  void _initStatics();



  // Populate locale specific directories

  //   if ./static/ is used

  //      ./static.en/ is for en-* locales that don't have their own directory

  //      ./static.en-gb/ is for en-GB locale and falls through to ./static.en/ and then ./static/

  void _populateLocaleDirectories(const AFilename&, AOSConfiguration::MAP_LOCALE_DIRS&);

  

  // Locale maps

  MAP_LOCALE_DIRS m_LocaleStaticDirs;

  MAP_LOCALE_DIRS m_LocaleDataDirs;



  // Locale equivalents map

  // loaded from config file and maps language to languare-locale combo (usually when more than one may exist)

  MAP_AString_AString m_LocaleRemap;



  // Default locale that base directories are in

  AString m_BaseLocale;



  // Load locale info

  void _loadLocaleInfo();



  // Get locale specific directory

  void _getLocaleAosDirectory(AHTTPRequestHeader& request, AFilename& filename, const AOSConfiguration::MAP_LOCALE_DIRS& dirs, const AFilename& defaultDir) const;



  // Get chain of locale directries to look up, last entry is always the default

  void _getLocaleAosDirectoryChain(AHTTPRequestHeader& request, LIST_AFilename& directories, const AOSConfiguration::MAP_LOCALE_DIRS& dirs) const;



  // Populate the extension set

  void _populateGzipCompressionExtensions();



  /*!

  Load commands

  */

  void _readController(AFilename&);               // May alter the passed filename

  void _readDirectoryConfig(AFilename&);          // May alter the passed filename

  void _postProcessControllerAndConfig(AFileSystem::FileInfos &);



  // MIME type lookup

  MAP_AString_AString m_ExtToMimeType;

  void _readMIMETypes();



  // Default MIME type

  AString m_DefaultMimeType;



  // AOS directories from base

  AFilename m_AosBaseConfigDir;

  AFilename m_AosBaseStaticDir;

  AFilename m_AosBaseDynamicDir;

  AFilename m_AosBaseDataDir;

  

  // Internals

  AString m_AosDefaultFilename;

  AString m_AosDefaultInputProcessor;

  AString m_AosDefaultOutputGenerator;

  

  // Admin

  AFilename m_AdminBaseHttpDir;



  // XML document with all config files overlayed based on load order

  AXmlDocument m_Config;



  // Reported statics

  AString m_ReportedServer;

  AString m_ReportedHostname;

  int m_ReportedHttpPort;

  int m_ReportedHttpsPort;



  //Overrides

  bool m_IsOverrideInputAllowed;

  bool m_IsOverrideOutputAllowed;

  bool m_IsDumpContextAllowed;

};



#endif //INCLUDED__AOSConfiguration_HPP__