Utilities.cpp

Go to the documentation of this file.

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <cassert>
#include <ostream>
#include <sstream>
// Boost (Extended STL)
#include <boost/tokenizer.hpp>
// OpenTrep
#include <opentrep/OPENTREP_exceptions.hpp>
#include <opentrep/DBType.hpp>
#include <opentrep/basic/Utilities.hpp>
#include <opentrep/service/Logger.hpp>
 
namespace OPENTREP {
 
  // //////////////////////////////////////////////////////////////////////
  void tokeniseStringIntoWordList (const std::string& iPhrase,
                                   WordList_T& ioWordList) {
    // Empty the word list
    ioWordList.clear();
  
    // Boost Tokeniser
    typedef boost::tokenizer<boost::char_separator<char> > Tokeniser_T;
  
    // Define the single-character separators.
    // Note that multi-byte Unicode characters (e.g., “, ”)
    // should not be inserted here
    const boost::char_separator<char>
      lSepatorList(" .,;:|+-*/_=!@#$%`~^&(){}[]?'<>\"");
  
    // Initialise the phrase to be tokenised
    Tokeniser_T lTokens (iPhrase, lSepatorList);
    for (Tokeniser_T::const_iterator tok_iter = lTokens.begin();
         tok_iter != lTokens.end(); ++tok_iter) {
      const std::string& lTerm = *tok_iter;
      ioWordList.push_back (lTerm);
    }
  }
 
  // //////////////////////////////////////////////////////////////////////
  std::string createStringFromWordList (const WordList_T& iWordList,
                                        const NbOfWords_T iSplitIdx,
                                        const bool iFromBeginningFlag) {
    std::ostringstream oStr;
 
    // Browse the left-hand side of the string
    NbOfWords_T idx = 0;
    WordList_T::const_iterator itWord = iWordList.begin();
    for ( ; itWord != iWordList.end(); ++itWord, ++idx) {
 
      if (iFromBeginningFlag == true) {
        // The beginning of the word list is needed
 
        // Check whether the sub-list has reached the expected split point,
        // if any
        if (iSplitIdx != 0 && idx >= iSplitIdx) {
          break;
        }
      
        //
        if (idx > 0) {
          oStr << " ";
        }
        //
        const std::string& lWord = *itWord;
        oStr << lWord;
 
      } else {
        // The end of the word list is needed
        
        // Check whether the sub-list has reached the expected split point,
        // if any
        if (iSplitIdx == 0 || idx >= iSplitIdx) {
          break;
        }
      }
    }
 
    // The beginning of the word list is needed
    if (iFromBeginningFlag == true) {
      return oStr.str();
    }
 
    // The end of the word list is needed
    assert (iFromBeginningFlag == false);
 
    // Browse the right-hand side of the string
    for ( ; itWord != iWordList.end(); ++itWord, ++idx) {
      // The end of the word list is needed
 
      //
      if (idx > iSplitIdx) {
        oStr << " ";
      }
      //
      const std::string& lWord = *itWord;
      oStr << lWord;
    }
  
    return oStr.str();
  }
 
  // //////////////////////////////////////////////////////////////////////
  StringMap_T
  parseMySQLConnectionString (const SQLDBConnectionString_T& iSQLDBConnStr) {
    StringMap_T oStrMap;
 
    // Split on spaces; each token is "key=value". Split each token on the
    // first '=' only, so that passwords containing '=' are handled
    // correctly. This also means that any key supported by the underlying
    // MySQL/MariaDB client library (e.g., 'db', 'user', 'password', 'host',
    // 'port', 'unix_socket', etc.) is accepted and preserved, instead of
    // only a fixed, hard-coded subset.
    std::stringstream lConnStream (iSQLDBConnStr);
    std::string kvStr;
 
    while (std::getline (lConnStream, kvStr, ' ')) {
      if (kvStr.empty()) {
        continue;
      }
 
      const size_t eqPos = kvStr.find ('=');
      if (eqPos == std::string::npos) {
        continue;
      }
 
      const std::string lKey = kvStr.substr (0, eqPos);
      const std::string lVal = kvStr.substr (eqPos + 1);
      oStrMap[lKey] = lVal;
    }

    // SQL database name
    const StringMap_T::const_iterator itDBName = oStrMap.find ("db");
    if (itDBName == oStrMap.end()) {
      std::ostringstream errStr;
      errStr << "Error when parsing the SQL database connection string ('"
             << iSQLDBConnStr << "'), the 'db' value cannot be found";
      OPENTREP_LOG_ERROR (errStr.str());
      throw SQLDatabaseConnectionStringParsingException (errStr.str());
    }
 
    // SQL database user
    const StringMap_T::const_iterator itDBUser = oStrMap.find ("user");
    if (itDBUser == oStrMap.end()) {
      std::ostringstream errStr;
      errStr << "Error when parsing the SQL database connection string ('"
             << iSQLDBConnStr << "'), the 'user' value cannot be found";
      OPENTREP_LOG_ERROR (errStr.str());
      throw SQLDatabaseConnectionStringParsingException (errStr.str());
    }
 
    // SQL database password
    const StringMap_T::const_iterator itDBPasswd = oStrMap.find ("password");
    if (itDBPasswd == oStrMap.end()) {
      std::ostringstream errStr;
      errStr << "Error when parsing the SQL database connection string ('"
             << iSQLDBConnStr << "'), the 'password' value cannot be found";
      OPENTREP_LOG_ERROR (errStr.str());
      throw SQLDatabaseConnectionStringParsingException (errStr.str());
    }
 
    return oStrMap;
  }
 
  // //////////////////////////////////////////////////////////////////////
  SQLDBConnectionString_T
  buildMySQLConnectionString (const StringMap_T& iStringMap,
                              const DeploymentNumber_T& iDeploymentNumber) {
    std::ostringstream oStr;
 
    // SQL database name
    const StringMap_T::const_iterator itDBName = iStringMap.find ("db");
    assert (itDBName != iStringMap.end());
    const std::string& lDBName = itDBName->second;
 
    // SQL database user
    const StringMap_T::const_iterator itDBUser = iStringMap.find ("user");
    assert (itDBUser != iStringMap.end());
    const std::string& lDBUser = itDBUser->second;
 
    // SQL database password
    const StringMap_T::const_iterator itDBPasswd = iStringMap.find ("password");
    assert (itDBPasswd != iStringMap.end());
    const std::string& lDBPasswd = itDBPasswd->second;
 
    //
    oStr << "db=" << lDBName;
    if (lDBName != "mysql") {
      oStr << iDeploymentNumber;
    }
 
    //
    oStr << " user=" << lDBUser;
 
    //
    oStr << " password=" << lDBPasswd;
 
    // Optional host and port (and, more generally, any other extra key
    // supported by the underlying MySQL/MariaDB client library) are passed
    // through unchanged, since they do not need to be re-suffixed with the
    // deployment number.
    const StringMap_T::const_iterator itHost = iStringMap.find ("host");
    if (itHost != iStringMap.end()) {
      oStr << " host=" << itHost->second;
    }
 
    const StringMap_T::const_iterator itPort = iStringMap.find ("port");
    if (itPort != iStringMap.end()) {
      oStr << " port=" << itPort->second;
    }
 
    return SQLDBConnectionString_T (oStr.str());
  }
 
  // //////////////////////////////////////////////////////////////////////
  std::string
  displayMySQLConnectionString (const StringMap_T& iStringMap,
                                const DeploymentNumber_T& iDeploymentNumber) {
    std::ostringstream oStr;
 
    for (StringMap_T::const_iterator itDBKV = iStringMap.begin();
         itDBKV != iStringMap.end(); ++itDBKV) {
      const std::string& lDBKey = itDBKV->first;
      const std::string& lDBValue = itDBKV->second;
      oStr << lDBKey << "=";
      oStr << lDBValue;
      if (lDBKey == "db" && lDBValue != "mysql"
          && iDeploymentNumber != DEFAULT_OPENTREP_DEPLOYMENT_NUMBER_SIZE) {
        oStr << iDeploymentNumber;
      }
      oStr << " ";
    }
 
    return oStr.str();
  }
 
  // //////////////////////////////////////////////////////////////////////
  StringMap_T
  parsePGConnectionString (const SQLDBConnectionString_T& iSQLDBConnStr) {
    StringMap_T oStrMap;
 
    // Split on spaces; each token is "key=value". Split each token on the
    // first '=' only, so that passwords containing '=' are handled correctly.
    std::stringstream lConnStream (iSQLDBConnStr);
    std::string kvStr;
 
    while (std::getline (lConnStream, kvStr, ' ')) {
      if (kvStr.empty()) {
        continue;
      }
 
      const size_t eqPos = kvStr.find ('=');
      if (eqPos == std::string::npos) {
        continue;
      }
 
      const std::string lKey = kvStr.substr (0, eqPos);
      const std::string lVal = kvStr.substr (eqPos + 1);
      oStrMap[lKey] = lVal;
    }
 
    // Validate required fields
    if (oStrMap.find ("dbname") == oStrMap.end()) {
      std::ostringstream errStr;
      errStr << "Error when parsing the PG connection string ('"
             << iSQLDBConnStr << "'), the 'dbname' value cannot be found";
      OPENTREP_LOG_ERROR (errStr.str());
      throw SQLDatabaseConnectionStringParsingException (errStr.str());
    }
 
    if (oStrMap.find ("user") == oStrMap.end()) {
      std::ostringstream errStr;
      errStr << "Error when parsing the PG connection string ('"
             << iSQLDBConnStr << "'), the 'user' value cannot be found";
      OPENTREP_LOG_ERROR (errStr.str());
      throw SQLDatabaseConnectionStringParsingException (errStr.str());
    }
 
    if (oStrMap.find ("password") == oStrMap.end()) {
      std::ostringstream errStr;
      errStr << "Error when parsing the PG connection string ('"
             << iSQLDBConnStr << "'), the 'password' value cannot be found";
      OPENTREP_LOG_ERROR (errStr.str());
      throw SQLDatabaseConnectionStringParsingException (errStr.str());
    }
 
    return oStrMap;
  }
 
  // //////////////////////////////////////////////////////////////////////
  SQLDBConnectionString_T
  buildPGConnectionString (const StringMap_T& iStringMap,
                           const DeploymentNumber_T& iDeploymentNumber) {
    std::ostringstream oStr;
 
    const StringMap_T::const_iterator itDBName = iStringMap.find ("dbname");
    assert (itDBName != iStringMap.end());
    oStr << "dbname=" << itDBName->second << iDeploymentNumber;
 
    const StringMap_T::const_iterator itDBUser = iStringMap.find ("user");
    assert (itDBUser != iStringMap.end());
    oStr << " user=" << itDBUser->second;
 
    const StringMap_T::const_iterator itDBPasswd = iStringMap.find ("password");
    assert (itDBPasswd != iStringMap.end());
    oStr << " password=" << itDBPasswd->second;
 
    // Preserve optional host and port
    const StringMap_T::const_iterator itHost = iStringMap.find ("host");
    if (itHost != iStringMap.end()) {
      oStr << " host=" << itHost->second;
    }
 
    const StringMap_T::const_iterator itPort = iStringMap.find ("port");
    if (itPort != iStringMap.end()) {
      oStr << " port=" << itPort->second;
    }
 
    return SQLDBConnectionString_T (oStr.str());
  }
 
  // //////////////////////////////////////////////////////////////////////
  std::string
  displayPGConnectionString (const StringMap_T& iStringMap,
                             const DeploymentNumber_T& iDeploymentNumber) {
    std::ostringstream oStr;
 
    for (StringMap_T::const_iterator itDBKV = iStringMap.begin();
         itDBKV != iStringMap.end(); ++itDBKV) {
      const std::string& lDBKey = itDBKV->first;
      const std::string& lDBValue = itDBKV->second;
      oStr << lDBKey << "=";
      oStr << lDBValue;
      if (lDBKey == "dbname"
          && iDeploymentNumber != DEFAULT_OPENTREP_DEPLOYMENT_NUMBER_SIZE) {
        oStr << iDeploymentNumber;
      }
      oStr << " ";
    }
 
    return oStr.str();
  }
 
  // //////////////////////////////////////////////////////////////////////
  std::string
  parseAndDisplayConnectionString (const DBType& iDBType,
                                   const std::string& iSQLDBConnStr,
                                   const DeploymentNumber_T& iDeploymentNumber) {
    std::ostringstream oStr;
 
    if (iDBType == DBType::NODB) {
      // Do nothing at this stage
      oStr << "";
 
    } else if (iDBType == DBType::SQLITE3) {
      oStr << iSQLDBConnStr << iDeploymentNumber;
 
    } else if (iDBType == DBType::MYSQL) {
      // Parse the connection string
      const SQLDBConnectionString_T lSQLDBConnStr (iSQLDBConnStr);
      const StringMap_T& lStrMap = parseMySQLConnectionString (lSQLDBConnStr);
 
      // Re-build the new connection string, taking into account the
      // deployment number/version
      const std::string& lNewSQLDBConnStr =
        displayMySQLConnectionString (lStrMap, iDeploymentNumber);
      oStr << lNewSQLDBConnStr;
 
    } else if (iDBType == DBType::PG) {
      // Parse the connection string
      const SQLDBConnectionString_T lSQLDBConnStr (iSQLDBConnStr);
      const StringMap_T& lStrMap = parsePGConnectionString (lSQLDBConnStr);
 
      // Re-build the new connection string, taking into account the
      // deployment number/version
      const std::string& lNewSQLDBConnStr =
        displayPGConnectionString (lStrMap, iDeploymentNumber);
      oStr << lNewSQLDBConnStr;
    }
 
    //
    return oStr.str();
  }
}