/*========================================================================= Program: bbtk Module: $RCSfile: bbtkConfigurationFile.cxx,v $ Language: C++ Date: $Date: 2011/03/08 16:56:13 $ Version: $Revision: 1.37 $ =========================================================================*/ /* --------------------------------------------------------------------- * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale) * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux * * This software is governed by the CeCILL-B license under French law and * abiding by the rules of distribution of free software. You can use, * modify and/ or redistribute the software under the terms of the CeCILL-B * license as circulated by CEA, CNRS and INRIA at the following URL * http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html * or in the file LICENSE.txt. * * As a counterpart to the access to the source code and rights to copy, * modify and redistribute granted by the license, users are provided only * with a limited warranty and the software's author, the holder of the * economic rights, and the successive licensors have only limited * liability. * * The fact that you are presently reading this means that you have had * knowledge of the CeCILL-B license and that you accept its terms. * ------------------------------------------------------------------------ */ /** *\file *\brief Class bbtk::ConfigurationFile */ #include "bbtkConfigurationFile.h" #include "bbtkMessageManager.h" #include "bbtkXML.h" #include "bbtkUtilities.h" #include "creaSystem.h" #if defined(WIN32) # include // for getcwd # include #endif namespace bbtk { //==================================================================== /// Constructor ConfigurationFile::ConfigurationFile() { mFile_separator = VALID_FILE_SEPARATOR; // ==> Set system paths mBin_path = Utilities::GetExecutablePath(); /* EED 23 Mars 2009 #ifdef MACOSX mInstall_path = mBin_path + "/../../../.."; #else mInstall_path = mBin_path + "/.."; #endif */ #ifdef MACOSX std::string macPath("Contents/MacOS"); int sbp = mBin_path.length(); int smp = macPath.length(); if (mBin_path.compare( sbp-smp, smp, macPath )==0 ) { mBin_path = mBin_path + "/../../.."; } #endif ///\TODO : better use ?? mInstall_path = mBin_path + "/.."; // The relative path to the doc folder (=BBTK_DOC_REL_PATH) // mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH); // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path) // mDoc_path = mInstall_path + "/" + mDoc_rel_path; // Have to create bbtk user's dirs if needed // LG 27/01/09 : doc is now user dependent // and located in user's .bbtk dir /doc // All dirs under .bbtk user's dir are set and created by: InitializeDotBbtkStructure(); // The relative path to the doc folder (=BBTK_BBS_REL_PATH) mBbs_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_BBS_REL_PATH); // The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path) mBbs_path = mInstall_path + "/" + mBbs_rel_path; mData_path = mInstall_path + "/" + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH); Utilities::replace( mBin_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR); Utilities::replace( mInstall_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR); Utilities::replace( mBbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR); Utilities::replace( mData_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR); bbtkMessage("config",1," ==> bin : '"< prefix : '"< doc : '"< bbs : '"< data : '"< First we look for bbtk_config.xml in "." char buf[2048]; const char *currentDir = getcwd(buf, 2048); if( !currentDir ) { std::cerr << "Path was too long to fit on 2048 bytes ?!?" << std::endl; // \todo : what else? // How abort a constructor and warn the caller function? // LG : throw an exception } // std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml"; std::string configXmlFullPathName = currentDir ; configXmlFullPathName += "/bbtk_config.xml"; Utilities::replace( configXmlFullPathName , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR); if ( Utilities::FileExists( configXmlFullPathName )) { bbtkMessage("config",1, "ConfigurationFile : [" << configXmlFullPathName << "] found in current directory" << std::endl); //Read(configXmlFullPathName.c_str()); // traiter le fichier local } // ==> Then we look for bbtk_config.xml in ".bbtk" else { configXmlFullPathName = Utilities::MakeUserSettingsFullFileName("bbtk_config.xml"); if (!Utilities::FileExists( configXmlFullPathName )) { // ==> Nothing found, we create bbtk_config.xml in ".bbtk" InstallPath (); } } // In any case, deal with bbtk_config.xml! Read(configXmlFullPathName.c_str()); } //========================================================================= //========================================================================= /// Destructor ConfigurationFile::~ConfigurationFile() { } //========================================================================= //========================================================================= void ConfigurationFile::InitializeDotBbtkStructure() { mDot_bbtk_path = Utilities::GetUserSettingsDir(); mDot_bbtk_is_new = false; if (!Utilities::FileExists(mDot_bbtk_path)) mDot_bbtk_is_new = true; Utilities::CreateDirectoryIfNeeded(mDot_bbtk_path); mDoc_path = Utilities::MakeUserSettingsFullFileName("doc"); Utilities::CreateDirectoryIfNeeded(mDoc_path); std::string bbdoc_path = Utilities::MakeUserSettingsFullFileName("doc/bbdoc"); Utilities::CreateDirectoryIfNeeded(bbdoc_path); // Create help_contents.html if does not exist std::string filename = Utilities::MakeUserSettingsFullFileName("doc/help_contents.html"); if (!Utilities::FileExists(filename)) { bbtkDebugMessage("config",1, "* Creating [" << filename << "]" << std::endl); // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path) std::string doc_path = mInstall_path + "/" + BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH) + "/"; Utilities::MakeValidFileName(doc_path); std::ofstream f; f.open(filename.c_str(), std::ios::out ); f << "" << "Help Contents - bbtk " << GetVersion() << "" << "

Help Contents

" << "Demos
" << "Examples" << "

Guides

" << "User's Guide
" << "Developer's Guide
" << "Package Developer's Guide
" << "bbtk library doxygen doc
" << "

Boxes

" << "" << "Alphabetical list
" << "" << "List by package
" << "" << "List by category
" << "" << "List of adaptors
" << "" << ""; } // if mTemp_path = Utilities::MakeUserSettingsFullFileName("tmp"); Utilities::CreateDirectoryIfNeeded(mTemp_path); } //========================================================================= //========================================================================= void ConfigurationFile::CreateConfigXML( char *rootDirectory ) { FILE *fp; char configXml[250]; sprintf (configXml , "%s/bbtk_config.xml", rootDirectory); bbtkDebugMessage("config",1, "in CreateConfigXML[" << configXml << "]" << std::endl); fp = fopen (configXml, "w"); fprintf(fp, "\n"); fprintf(fp, "\n"); fprintf(fp, " \n"); fprintf(fp, " \n"); fprintf(fp, "\n"); fclose(fp); } //========================================================================= //========================================================================= void ConfigurationFile::InstallPath () { /*-------------------------------------------------- New policy for bbtk_config.xml : if bbtk_config.xml found in current directory (user is an aware user!) use it! else if bbtk_config.xml found in HOME/.bbtk (user already worked with it) use it! else if bbtk_config.xml.tmp found in /usr/local/bin or c:\\Program Files\\BBTK\\bin copy it as .bbtk/bbtk_config.xml else (nothing installed) create a minimum version in HOME/.bbtk ----------------------------------------------------*/ // ----------------------------------------------------------------- #if defined(__GNUC__) // ------------------ create some usefull strings ---------------- // installed bbtk_path char bbtk_path[1000]; strcpy(bbtk_path, Utilities::GetExecutablePath().c_str()); // JPR //strcpy(bbtk_path, "/usr/local/bin"); // rootDirectory char rootDirectory[200]; sprintf( rootDirectory, "%s/.bbtk", getenv("HOME")); // configPath char configPath[200]; sprintf(configPath, "%s/bbtk_config.xml",rootDirectory); // configXmlTmp char configXmlTmp[250]; sprintf(configXmlTmp, "%s/bbtk_config.xml.tmp", bbtk_path); // copyFile char copyFile[250]; if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found (not installed) { // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk CreateConfigXML( rootDirectory );// create .bbtk } else { sprintf(copyFile,"cp %s %s/bbtk_config.xml ",configXmlTmp,rootDirectory ); if (!Utilities::FileExists(configPath)) { system(copyFile); } } return; // ------------------------------------------------------------------ #elif defined(WIN32) // installed bbtk_path char bbtk_path[100]; strcpy(bbtk_path, "\"c:\\Program Files\\BBTK\\bin\""); char bbtk_path2[100]; strcpy(bbtk_path2, "c:\\Program Files\\BBTK\\bin"); // rootDirectory char rootDirectory[200]; sprintf(rootDirectory, "%s\\.bbtk",getenv("USERPROFILE")); // std::cout << "[" << rootDirectory << "]" << std::endl; // configPath char configPath[200]; sprintf(configPath, "%s\\bbtk_config.xml",rootDirectory); // makeDir char makeDir[250]; sprintf( makeDir, "mkdir \"%s\" ", rootDirectory); // configXmlTmp char configXmlTmp[250]; sprintf(configXmlTmp, "%s\\bbtk_config.xml.tmp", bbtk_path2); // copyFile char copyFile[250]; if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found { // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk CreateConfigXML( rootDirectory );// create .bbtk return; } sprintf(copyFile,"copy %s\\bbtk_config.xml.tmp \"%s\"\\bbtk_config.xml ",bbtk_path,rootDirectory ); int attribs = GetFileAttributes (rootDirectory); bbtkMessage("config",1,std::hex << attribs << " " << FILE_ATTRIBUTE_DIRECTORY << std::endl); if ( attribs != 0xFFFFFFFF) { if ((attribs & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY ) /// \TODO : check ! { if ( GetFileAttributes( configPath ) == 0xFFFFFFFF) { system(copyFile); } } } else { system(makeDir); system(copyFile); } return; // ------------------------------------------------------------------ #else /// \todo ConfigurationFile::InstallPath() : exit when for not WIN32 and not__GNUC__ return; #endif } //========================================================================= //========================================================================= // Gets the list of directories holding bb scripts, packages, dll, ... from the xml file // bbtk_config.xml void ConfigurationFile::Read(const std::string& filename) { bbtkDebugMessage("config",1,"ConfigurationFile::Read(" <error != eXMLErrorNone ) { std::string mess = GetErrorMessage(res,filename); delete res; bbtkDebugMessage("config",1,mess<< std::endl); bbtkError(mess); } delete res; bbtkDebugMessage("config",1,"OK" << std::endl); int i,j; // Description for (i=0,j=0; ierror != eXMLErrorNone ) { std::string mess = GetErrorMessage(res,Get_config_xml_full_path()); delete res; bbtkDebugMessage("config",1,mess<< std::endl); bbtkError(mess); } delete res; #ifdef _WIN32 std::string bbs_path = path + "/bbs"; #else std::string bbs_path = path + "/share/bbtk/bbs" ; #endif XMLNode BBSPATH = BB.addChild((XMLCSTR)"bbs_path"); BBSPATH.addText((XMLCSTR)bbs_path.c_str()); Utilities::replace(bbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR); mBbs_paths.push_back(bbs_path); #ifdef _WIN32 std::string pack_path = path + "/bin"; #else std::string pack_path = path ; #endif XMLNode PACKPATH = BB.addChild((XMLCSTR)"package_path"); PACKPATH.addText((XMLCSTR)pack_path.c_str()); Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR); mPackage_paths.push_back(pack_path); #ifdef _WIN32 pack_path = path + "/RelWithDebInfo"; PACKPATH = BB.addChild((XMLCSTR)"package_path"); PACKPATH.addText((XMLCSTR)pack_path.c_str()); Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR); mPackage_paths.push_back(pack_path); pack_path = path + "/Debug"; PACKPATH = BB.addChild((XMLCSTR)"package_path"); PACKPATH.addText((XMLCSTR)pack_path.c_str()); Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR); mPackage_paths.push_back(pack_path); pack_path = path + "/Release"; PACKPATH = BB.addChild((XMLCSTR)"package_path"); PACKPATH.addText((XMLCSTR)pack_path.c_str()); Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR); mPackage_paths.push_back(pack_path); #endif XMLError err = BB.writeToFile((XMLCSTR)Get_config_xml_full_path().c_str()); if ( err != eXMLErrorNone ) { std::string mess = GetErrorMessage(res,Get_config_xml_full_path()); bbtkDebugMessage("config",1,mess<< std::endl); bbtkError(mess); } return true; } //========================================================================= //========================================================================= void ConfigurationFile::GetHelp(int level) const { bbtkDebugMessageInc("config",9,"ConfigurationFile::GetHelp("<bbs_paths = Get_bbs_paths(); const std::vectorpackage_paths = Get_package_paths(); bbtkMessage("help",level, "=============" << std::endl); bbtkMessage("help",level, "Configuration" << std::endl); bbtkMessage("help",level, "=============" << std::endl); bbtkMessage("help",level, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl); bbtkMessage("help",level, "Documentation Path : [" << url << "]" << std::endl); bbtkMessage("help",level, "Data Path : [" << data_path << "]" << std::endl); bbtkMessage("help",level, "Temp Directory : [" << default_temp_dir << "]" << std::endl); bbtkMessage("help",level, "File Separator : [" << file_separator << "]" << std::endl); std::vector::const_iterator i; bbtkMessage("help",level, "BBS Paths " << std::endl); for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i ) { bbtkMessage("help",level,"--- ["<<*i<<"]"<