kernel/src/bbtkConfigurationFile.cxx

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbtkConfigurationFile.cxx,v $
   4   Language:  C++
   5   Date:      $Date: 2009/05/28 14:22:10 $
   6   Version:   $Revision: 1.31 $
   7 =========================================================================*/
   8
   9 /* ---------------------------------------------------------------------
  10
  11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  13 *
  14 *  This software is governed by the CeCILL-B license under French law and
  15 *  abiding by the rules of distribution of free software. You can  use,
  16 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 *  license as circulated by CEA, CNRS and INRIA at the following URL
  18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 *  or in the file LICENSE.txt.
  20 *
  21 *  As a counterpart to the access to the source code and  rights to copy,
  22 *  modify and redistribute granted by the license, users are provided only
  23 *  with a limited warranty  and the software's author,  the holder of the
  24 *  economic rights,  and the successive licensors  have only  limited
  25 *  liability.
  26 *
  27 *  The fact that you are presently reading this means that you have had
  28 *  knowledge of the CeCILL-B license and that you accept its terms.
  29 * ------------------------------------------------------------------------ */
  30
  31 /**
  32  *\file
  33  *\brief Class bbtk::ConfigurationFile
  34  */
  35
  36 #include "bbtkConfigurationFile.h"
  37 #include "bbtkMessageManager.h"
  38 #include "bbtkXML.h"
  39 #include "bbtkUtilities.h"
  40
  41 #if defined(WIN32)
  42 # include <direct.h> // for getcwd
  43 # include <windows.h>
  44 #endif
  45
  46
  47
  48
  49 namespace bbtk
  50 {
  51
  52   //====================================================================
  53   /// Constructor
  54   ConfigurationFile::ConfigurationFile()
  55   {
  56
  57         mFile_separator = VALID_FILE_SEPARATOR;
  58
  59     // ==> Set system paths
  60     mBin_path = Utilities::GetExecutablePath();
  61
  62
  63
  64
  65 /*      EED 23 Mars 2009
  66 #ifdef MACOSX
  67     mInstall_path = mBin_path + "/../../../..";
  68 #else
  69     mInstall_path = mBin_path + "/..";
  70 #endif
  71 */
  72 #ifdef MACOSX
  73
  74           std::string macPath("Contents/MacOS");
  75           int sbp = mBin_path.length();
  76           int smp = macPath.length();
  77           if (mBin_path.compare( sbp-smp, smp, macPath )==0 )
  78           {
  79                   mBin_path = mBin_path + "/../../..";
  80           }
  81
  82
  83 #endif
  84           mInstall_path = mBin_path + "/..";
  85
  86
  87
  88     // The relative path to the doc folder (=BBTK_DOC_REL_PATH)
  89     //    mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH);
  90     // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
  91     //    mDoc_path = mInstall_path + "/" + mDoc_rel_path;
  92     // Have to create bbtk user's dirs if needed
  93
  94     // LG 27/01/09 : doc is now user dependent
  95     //               and located in user's .bbtk dir /doc
  96     // All dirs under .bbtk user's dir are set and created by:
  97     InitializeDotBbtkStructure();
  98
  99     // The relative path to the doc folder (=BBTK_BBS_REL_PATH)
 100     mBbs_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_BBS_REL_PATH);
 101     // The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
 102     mBbs_path = mInstall_path + "/" + mBbs_rel_path;
 103
 104     mData_path = mInstall_path + "/" + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
 105
 106     Utilities::replace( mBin_path,
 107                         INVALID_FILE_SEPARATOR,
 108                         VALID_FILE_SEPARATOR);
 109     Utilities::replace( mInstall_path,
 110                         INVALID_FILE_SEPARATOR,
 111                         VALID_FILE_SEPARATOR);
 112     Utilities::replace( mBbs_path,
 113                         INVALID_FILE_SEPARATOR,
 114                         VALID_FILE_SEPARATOR);
 115     Utilities::replace( mData_path,
 116                         INVALID_FILE_SEPARATOR,
 117                         VALID_FILE_SEPARATOR);
 118
 119     bbtkMessage("config",1," ==> bin    : '"<<mBin_path<<"'"<<std::endl);
 120     bbtkMessage("config",1," ==> prefix : '"<<mInstall_path<<"'"<<std::endl);
 121     bbtkMessage("config",1," ==> doc    : '"<<mDoc_path<<"'"<<std::endl);
 122     bbtkMessage("config",1," ==> bbs    : '"<<mBbs_path<<"'"<<std::endl);
 123     bbtkMessage("config",1," ==> data   : '"<<mData_path<<"'"<<std::endl);
 124
 125
 126
 127
 128     // bbs_paths
 129     // always add "." (current working directory) at the begining
 130     mBbs_paths.push_back( "." );
 131     // add system bbs path
 132     mBbs_paths.push_back(mBbs_path);
 133     // add toolsbbtk/appli
 134 //EED    std::string toolsappli_rel_path(mFile_separator);
 135     std::string toolsappli_rel_path("/");
 136 //EED    toolsappli_rel_path +=  "toolsbbtk" + mFile_separator + "appli";
 137     toolsappli_rel_path +=  "toolsbbtk/appli";
 138     //
 139     //-----------------------------------------------------------
 140     // LG : REMOVE BUGGY PATH WITH include *:
 141     //
 142     //    mBbs_paths.push_back(mBbs_path + toolsappli_rel_path);
 143     //-----------------------------------------------------------
 144     int iStrVec,sizeStrVec;
 145
 146     sizeStrVec = mBbs_paths.size();
 147     for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
 148       Utilities::replace( mBbs_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
 149     }
 150
 151
 152     // always add "." (current working directory) at the begining
 153     mPackage_paths.push_back(".");
 154     // add system bin path (for build tree / standalone folder install)
 155     mPackage_paths.push_back(mBin_path);
 156     // add system lib path (for install tree)
 157     //EED    mPackage_paths.push_back(mInstall_path + mFile_separator + "lib");
 158     mPackage_paths.push_back(mInstall_path + "/lib");
 159 #ifdef WIN32
 160     // add bin/Debug bin/Release paths (for build/install tree)
 161     //EED    mPackage_paths.push_back(mBin_path + mFile_separator + "Debug");
 162     mPackage_paths.push_back(mBin_path + "/Debug");
 163     //EED    mPackage_paths.push_back(mBin_path + mFile_separator + "Release");
 164     mPackage_paths.push_back(mBin_path + "/Release");
 165 #endif
 166
 167     sizeStrVec = mPackage_paths.size();
 168     for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
 169       Utilities::replace( mPackage_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
 170     }
 171
 172
 173
 174     GetHelp(2);
 175
 176     // ==> First we look for bbtk_config.xml in "."
 177     char buf[2048];
 178     const char *currentDir = getcwd(buf, 2048);
 179
 180     if( !currentDir )
 181       {
 182         std::cerr << "Path was too long to fit on 2048 bytes ?!?" << std::endl;
 183         // \todo : what else?
 184         // How abort a constructor and warn the caller function?
 185         // LG : throw an exception
 186       }
 187
 188     //    std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml";
 189     std::string configXmlFullPathName = currentDir ;
 190     configXmlFullPathName += "/bbtk_config.xml";
 191     Utilities::replace( configXmlFullPathName , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
 192
 193     if ( Utilities::FileExists( configXmlFullPathName ))
 194       {
 195         bbtkMessage("config",1, "ConfigurationFile : [" << configXmlFullPathName <<
 196                     "] found in current directory" << std::endl);
 197         //Read(configXmlFullPathName.c_str());
 198         // traiter le fichier local
 199       }
 200
 201     // ==> Then we look for bbtk_config.xml in ".bbtk"
 202     else
 203       {
 204         configXmlFullPathName = Utilities::MakeUserSettingsFullFileName("bbtk_config.xml");
 205         if (!Utilities::FileExists( configXmlFullPathName ))
 206           {
 207             // ==> Nothing found, we create bbtk_config.xml in ".bbtk"
 208             InstallPath ();
 209           }
 210       }
 211
 212     // In any case, deal with bbtk_config.xml!
 213     Read(configXmlFullPathName.c_str());
 214   }
 215   //=========================================================================
 216
 217   //=========================================================================
 218   /// Destructor
 219   ConfigurationFile::~ConfigurationFile()
 220   {
 221   }
 222   //=========================================================================
 223
 224   //=========================================================================
 225   void ConfigurationFile::InitializeDotBbtkStructure()
 226   {
 227     mDot_bbtk_path = Utilities::GetUserSettingsDir();
 228     mDot_bbtk_is_new = false;
 229     if (!Utilities::FileExists(mDot_bbtk_path)) mDot_bbtk_is_new = true;
 230     Utilities::CreateDirectoryIfNeeded(mDot_bbtk_path);
 231
 232     mDoc_path = Utilities::MakeUserSettingsFullFileName("doc");
 233     Utilities::CreateDirectoryIfNeeded(mDoc_path);
 234
 235     std::string bbdoc_path =
 236       Utilities::MakeUserSettingsFullFileName("doc/bbdoc");
 237     Utilities::CreateDirectoryIfNeeded(bbdoc_path);
 238
 239     // Create help_contents.html if does not exist
 240     std::string filename = Utilities::MakeUserSettingsFullFileName("doc/help_contents.html");
 241     if (!Utilities::FileExists(filename))
 242       {
 243         bbtkDebugMessage("config",1,
 244                          "* Creating [" << filename << "]" << std::endl);
 245         // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
 246         std::string doc_path = mInstall_path + "/"
 247           + BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH) + "/";
 248         Utilities::MakeValidFileName(doc_path);
 249         std::ofstream f;
 250         f.open(filename.c_str(), std::ios::out );
 251         f << "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD "
 252           << "HTML 4.01 Transitional//EN\">"
 253           << "<html><head><title>Help Contents - bbtk "
 254           << GetVersion() << "</title>"
 255           << "<meta http-equiv=\"Content-Type\" content=\"text/html; "
 256           << "charset=iso-8859-1\"></head><H1>Help Contents</H1>"
 257           << "<a href=\"bbdoc/index-category.html#demo\" "
 258           << "target=\"information\">Demos</a><br>"
 259           << "<a href=\"bbdoc/index-category.html#example\" "
 260           << "target=\"information\">Examples</a>"
 261           << "<H2>Guides</H2>"
 262           << "<a href=\""
 263           << doc_path
 264           << "bbtkUsersGuide/bbtkUsersGuide.html"
 265           << "\" target=\"information\">User's Guide</a><br>"
 266           << "<a href=\""
 267           << doc_path
 268           << "bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.html"
 269           << "\" target=\"information\">Package Developer's Guide</a><br>"
 270           << "<a href=\""
 271           << doc_path
 272           << "doxygen/bbtk/main.html"
 273           << "\" target=\"information\">bbtk library doxygen doc</a><br>"
 274           << "<H2>Boxes</H2>"
 275           << "<a target=\"information\" href=\"bbdoc/index-alpha.html\">"
 276           << "Alphabetical list</a><br>"
 277           << "<a target=\"information\" href=\"bbdoc/index-package.html\">"
 278           << "List by package</a><br>"
 279           << "<a target=\"information\" href=\"bbdoc/index-category.html\">"
 280           << "List by category</a><br>"
 281           << "<a target=\"information\" href=\"bbdoc/index-adaptors.html\">"
 282           << "List of adaptors</a><br>"
 283           << "</body>"
 284           << "</html>";
 285       }
 286
 287
 288     mTemp_path = Utilities::MakeUserSettingsFullFileName("tmp");
 289     Utilities::CreateDirectoryIfNeeded(mTemp_path);
 290
 291   }
 292   //=========================================================================
 293
 294   //=========================================================================
 295   void ConfigurationFile::CreateConfigXML( char *rootDirectory )
 296   {
 297     FILE *fp;
 298     char configXml[250];
 299     sprintf (configXml , "%s/bbtk_config.xml", rootDirectory);
 300     bbtkDebugMessage("config",1, "in CreateConfigXML[" << configXml << "]" << std::endl);
 301     fp = fopen (configXml, "w");
 302     fprintf(fp, "<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n");
 303     fprintf(fp, "<config>\n");
 304     fprintf(fp, "   <bbs_path>     </bbs_path>\n");
 305     fprintf(fp, "   <package_path> </package_path>\n");
 306     fprintf(fp, "</config>\n");
 307     fclose(fp);
 308   }
 309   //=========================================================================
 310
 311
 312
 313
 314   //=========================================================================
 315   void ConfigurationFile::InstallPath ()
 316   {
 317
 318     /*--------------------------------------------------
 319       New policy for bbtk_config.xml :
 320
 321       if bbtk_config.xml found in current directory (user is an aware user!)
 322       use it!
 323
 324       else if bbtk_config.xml found in HOME/.bbtk (user already worked with it)
 325       use it!
 326
 327       else if bbtk_config.xml.tmp found in /usr/local/bin or c:\\Program Files\\BBTK\\bin
 328       copy it as .bbtk/bbtk_config.xml
 329
 330       else (nothing installed)
 331       create a minimum version in HOME/.bbtk
 332       ----------------------------------------------------*/
 333
 334
 335     // -----------------------------------------------------------------
 336 #if defined(__GNUC__)
 337
 338     // ------------------ create some usefull strings ----------------
 339     // installed bbtk_path
 340     char bbtk_path[100];
 341     strcpy(bbtk_path, "/usr/local/bin");
 342
 343     // rootDirectory
 344     char rootDirectory[200];
 345     sprintf( rootDirectory,  "%s/.bbtk", getenv("HOME"));
 346
 347     // configPath
 348     char configPath[200];
 349     sprintf(configPath, "%s/bbtk_config.xml",rootDirectory);
 350
 351     // configXmlTmp
 352     char configXmlTmp[250];
 353     sprintf(configXmlTmp, "%s/bbtk_config.xml.tmp", bbtk_path);
 354
 355     // copyFile
 356     char copyFile[250];
 357
 358     if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found (not installed)
 359       {
 360         // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
 361         CreateConfigXML( rootDirectory );// create .bbtk
 362       }
 363     else
 364       {
 365         sprintf(copyFile,"cp %s  %s/bbtk_config.xml ",configXmlTmp,rootDirectory );
 366         if (!Utilities::FileExists(configPath))
 367           {
 368             system(copyFile);
 369           }
 370       }
 371     return;
 372
 373     // ------------------------------------------------------------------
 374 #elif defined(WIN32)
 375
 376
 377     // installed bbtk_path
 378     char bbtk_path[100];
 379     strcpy(bbtk_path, "\"c:\\Program Files\\BBTK\\bin\"");
 380     char bbtk_path2[100];
 381     strcpy(bbtk_path2, "c:\\Program Files\\BBTK\\bin");
 382
 383     // rootDirectory
 384     char rootDirectory[200];
 385     sprintf(rootDirectory, "%s\\.bbtk",getenv("USERPROFILE"));
 386     //  std::cout << "[" << rootDirectory << "]" << std::endl;
 387
 388     // configPath
 389     char configPath[200];
 390     sprintf(configPath, "%s\\bbtk_config.xml",rootDirectory);
 391
 392     // makeDir
 393     char makeDir[250];
 394     sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
 395
 396     // configXmlTmp
 397     char configXmlTmp[250];
 398     sprintf(configXmlTmp, "%s\\bbtk_config.xml.tmp", bbtk_path2);
 399
 400     // copyFile
 401     char copyFile[250];
 402
 403     if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found
 404       {
 405         // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
 406         CreateConfigXML( rootDirectory );// create .bbtk
 407         return;
 408       }
 409
 410     sprintf(copyFile,"copy %s\\bbtk_config.xml.tmp \"%s\"\\bbtk_config.xml ",bbtk_path,rootDirectory );
 411
 412     int attribs = GetFileAttributes (rootDirectory);
 413     bbtkMessage("config",1,std::hex << attribs << " " << FILE_ATTRIBUTE_DIRECTORY << std::endl);
 414     if ( attribs != 0xFFFFFFFF)
 415       {
 416         if ((attribs & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY ) /// \TODO : check !
 417           {
 418             if ( GetFileAttributes( configPath ) == 0xFFFFFFFF)
 419               {
 420                 system(copyFile);
 421               }
 422           }
 423       }
 424     else
 425       {
 426         system(makeDir);
 427         system(copyFile);
 428       }
 429     return;
 430     // ------------------------------------------------------------------
 431 #else
 432 /// \todo  ConfigurationFile::InstallPath() : exit when for not WIN32 and not__GNUC__
 433
 434   return;
 435 #endif
 436
 437 }
 438   //=========================================================================
 439
 440
 441
 442   //=========================================================================
 443   // Gets the list of directories holding bb scripts, packages, dll, ... from the xml file
 444   //      bbtk_config.xml
 445
 446   void ConfigurationFile::Read(const std::string& filename)
 447   {
 448
 449     bbtkDebugMessage("config",1,"ConfigurationFile::Read(" <<filename << ")" << std::endl);
 450
 451     mConfig_xml_full_path = filename;
 452     XMLResults* res = new XMLResults;
 453     XMLNode BB = XMLNode::parseFile((XMLCSTR)filename.c_str(),(XMLCSTR)"config",res);
 454
 455     if ( res->error != eXMLErrorNone )
 456       {
 457         std::string mess = GetErrorMessage(res,filename);
 458         delete res;
 459         bbtkDebugMessage("config",1,mess<< std::endl);
 460         bbtkError(mess);
 461       }
 462     delete res;
 463
 464     bbtkDebugMessage("config",1,"OK" << std::endl);
 465
 466     int i,j;
 467
 468     // Description
 469     for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"description"); i++)
 470       {
 471         std::string val;
 472         GetTextOrClear(BB.getChildNode((XMLCSTR)"description",&j),val);
 473         mDescription += val;
 474       }
 475
 476     // Url
 477     if( BB.nChildNode((XMLCSTR)"url") )
 478       GetTextOrClear(BB.getChildNode((XMLCSTR)"url"),mUrl);
 479
 480     // Data_Path
 481     if( BB.nChildNode((XMLCSTR)"data_path") )
 482       GetTextOrClear(BB.getChildNode((XMLCSTR)"data_path"),mData_path);
 483
 484     // install_path
 485     //  if( BB.nChildNode((XMLCSTR)"install_path") )
 486     //   GetTextOrClear(BB.getChildNode((XMLCSTR)"install_path"),mInstall_path);
 487
 488     // add user bbs paths
 489     for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"bbs_path"); i++)
 490       {
 491         std::string val;
 492         GetTextOrClear(BB.getChildNode((XMLCSTR)"bbs_path",&j),val);
 493         mBbs_paths.push_back(val);
 494       }
 495
 496     // package_paths
 497
 498     // add user package path
 499     for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"package_path"); i++)
 500       {
 501         std::string val;
 502         GetTextOrClear(BB.getChildNode((XMLCSTR)"package_path",&j),val);
 503         mPackage_paths.push_back(val);
 504       }
 505
 506     // default_temp_dir
 507     /*
 508     if( BB.nChildNode((XMLCSTR)"default_temp_dir") )
 509       GetTextOrClear(BB.getChildNode((XMLCSTR)"default_temp_dir"),mDefault_temp_dir);
 510
 511     if ( mDefault_temp_dir == "$") // no value found in config_xml
 512       {
 513         size_t pos = mConfig_xml_full_path.find("bbtk_config.xml");
 514         mDefault_temp_dir = mConfig_xml_full_path.substr (0,pos);
 515       }
 516     */
 517
 518     GetHelp(2);
 519   }
 520   //=========================================================================
 521
 522   //=========================================================================
 523   bool ConfigurationFile::AddPackagePathsAndWrite( const std::string& path )
 524   {
 525     bbtkDebugMessageInc("config",9,
 526                         "ConfigurationFile::AddPackagePathsAndWrite("
 527                         <<path<<")"<<std::endl);
 528
 529      XMLResults* res = new XMLResults;
 530     XMLNode BB =
 531       XMLNode::parseFile((XMLCSTR)Get_config_xml_full_path().c_str(),
 532                          (XMLCSTR)"config",res);
 533
 534     if ( res->error != eXMLErrorNone )
 535       {
 536         std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
 537         delete res;
 538         bbtkDebugMessage("config",1,mess<< std::endl);
 539         bbtkError(mess);
 540       }
 541    delete res;
 542
 543 #ifdef _WIN32
 544     std::string bbs_path = path + "/bbs";
 545 #else
 546     std::string bbs_path = path + "/share/bbtk/bbs" ;
 547 #endif
 548     XMLNode BBSPATH = BB.addChild((XMLCSTR)"bbs_path");
 549     BBSPATH.addText((XMLCSTR)bbs_path.c_str());
 550     Utilities::replace(bbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR);
 551     mBbs_paths.push_back(bbs_path);
 552
 553 #ifdef _WIN32
 554     std::string pack_path = path + "/bin";
 555 #else
 556     std::string pack_path = path ;
 557 #endif
 558     XMLNode PACKPATH = BB.addChild((XMLCSTR)"package_path");
 559     PACKPATH.addText((XMLCSTR)pack_path.c_str());
 560     Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
 561     mPackage_paths.push_back(pack_path);
 562
 563 #ifdef _WIN32
 564     pack_path = path + "/RelWithDebInfo";
 565     PACKPATH = BB.addChild((XMLCSTR)"package_path");
 566     PACKPATH.addText((XMLCSTR)pack_path.c_str());
 567     Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
 568     mPackage_paths.push_back(pack_path);
 569     pack_path = path + "/Debug";
 570     PACKPATH = BB.addChild((XMLCSTR)"package_path");
 571     PACKPATH.addText((XMLCSTR)pack_path.c_str());
 572     Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
 573     mPackage_paths.push_back(pack_path);
 574     pack_path = path + "/Release";
 575     PACKPATH = BB.addChild((XMLCSTR)"package_path");
 576     PACKPATH.addText((XMLCSTR)pack_path.c_str());
 577     Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
 578     mPackage_paths.push_back(pack_path);
 579 #endif
 580
 581
 582     XMLError err = BB.writeToFile((XMLCSTR)Get_config_xml_full_path().c_str());
 583     if ( err != eXMLErrorNone )
 584       {
 585         std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
 586         bbtkDebugMessage("config",1,mess<< std::endl);
 587         bbtkError(mess);
 588       }
 589
 590     return true;
 591   }
 592   //=========================================================================
 593
 594   //=========================================================================
 595   void ConfigurationFile::GetHelp(int level) const
 596   {
 597     bbtkDebugMessageInc("config",9,"ConfigurationFile::GetHelp("<<level
 598                         <<")"<<std::endl);
 599
 600     const std::string config_xml_full_path      = Get_config_xml_full_path();
 601     const std::string description               = Get_description();
 602     const std::string url                       = Get_doc_path();
 603     const std::string data_path                 = Get_data_path();
 604     const std::string default_temp_dir          = Get_default_temp_dir();
 605     const std::string file_separator            = Get_file_separator();
 606     const std::vector<std::string>bbs_paths     = Get_bbs_paths();
 607     const std::vector<std::string>package_paths = Get_package_paths();
 608
 609     bbtkMessage("help",level, "============="   << std::endl);
 610     bbtkMessage("help",level, "Configuration"   << std::endl);
 611     bbtkMessage("help",level, "============="   << std::endl);
 612     bbtkMessage("help",level, "bbtk_config.xml    : [" << config_xml_full_path  << "]" << std::endl);
 613     bbtkMessage("help",level, "Documentation Path : [" << url             << "]" << std::endl);
 614     bbtkMessage("help",level, "Data Path          : [" << data_path       << "]" << std::endl);
 615     bbtkMessage("help",level, "Temp Directory     : [" << default_temp_dir << "]" << std::endl);
 616     bbtkMessage("help",level, "File Separator     : [" << file_separator  << "]" << std::endl);
 617
 618     std::vector<std::string>::const_iterator i;
 619
 620     bbtkMessage("help",level, "BBS Paths   " << std::endl);
 621     for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
 622     {
 623       bbtkMessage("help",level,"--- ["<<*i<<"]"<<std::endl);
 624     }
 625
 626     bbtkMessage("help",level, "PACKAGE Paths : " << std::endl);
 627     for (i = package_paths.begin(); i!=package_paths.end(); ++i )
 628     {
 629       bbtkMessage("help",level,"--- ["<<*i<<"]"<<std::endl);
 630     }
 631
 632     bbtkDebugDecTab("config",9);
 633   }
 634   //=========================================================================
 635
 636
 637 } // namespace bbtk