X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkConfigurationFile.cxx;h=770608440abde5f91c223b2e011f26b41724cce0;hb=87efce51877a540d943b1aa26307994b38bba55b;hp=1d8c302753c6bc8b91836de1fe06e243c5d858a5;hpb=8a15ae69662abfba701a970f9efee218e0b126d3;p=bbtk.git diff --git a/kernel/src/bbtkConfigurationFile.cxx b/kernel/src/bbtkConfigurationFile.cxx index 1d8c302..7706084 100644 --- a/kernel/src/bbtkConfigurationFile.cxx +++ b/kernel/src/bbtkConfigurationFile.cxx @@ -1,20 +1,40 @@ +/* + # --------------------------------------------------------------------- + # + # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image + # pour la SantÈ) + # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton + # Previous Authors : Laurent Guigues, Jean-Pierre Roux + # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil + # + # 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. + # ------------------------------------------------------------------------ */ + + /*========================================================================= - Program: bbtk Module: $RCSfile: bbtkConfigurationFile.cxx,v $ Language: C++ - Date: $Date: 2008/03/17 10:51:35 $ - Version: $Revision: 1.14 $ - - Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de - l'Image). All rights reserved. See doc/license.txt or - http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details. - - This software is distributed WITHOUT ANY WARRANTY; without even - the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR - PURPOSE. See the above copyright notices for more information. - + Date: $Date: 2012/11/16 08:49:01 $ + Version: $Revision: 1.38 $ =========================================================================*/ + + + /** *\file *\brief Class bbtk::ConfigurationFile @@ -25,68 +45,90 @@ #include "bbtkXML.h" #include "bbtkUtilities.h" +#include "creaSystem.h" + #if defined(WIN32) -#include // for getcwd +# include // for getcwd +# include #endif - namespace bbtk { - //==================================================================== /// Constructor ConfigurationFile::ConfigurationFile() { + mFile_separator = VALID_FILE_SEPARATOR; - mFile_separator = VALID_FILE_SEPARATOR; - - // ==> Set system paths - mBin_path = GetExecutablePath(); -//EED mInstall_path = mBin_path + mFile_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); + // mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH); // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path) -//EED mDoc_path = mInstall_path + mFile_separator + mDoc_rel_path; - mDoc_path = 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) -//EED mBbs_path = mInstall_path + mFile_separator + mBbs_rel_path; mBbs_path = mInstall_path + "/" + mBbs_rel_path; - // The relative path to the rsc folder (=BBTK_RSC_REL_PATH) - // mRsc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_RSC_REL_PATH); - // The path to the rsc folder (=mInstall_path+"/"+mRsc_rel_path) - // mRsc_path = mInstall_path + mFile_separator + mRsc_rel_path; - // The path to the bbtk data folder - // Initialized to mInstall_path+"/"+BBTK_DATA_REL_PATH - // But can be overriden by value read from bbtk_config.xml -//EED mData_path = mInstall_path + mFile_separator + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_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( mDoc_rel_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR); - Utilities::replace( mDoc_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 : '"< 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 + // LG : throw an exception } - -// std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml"; + + // 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); + 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); + bbtkMessage("config",1, "ConfigurationFile : [" << configXmlFullPathName << + "] found in current directory" << std::endl); //Read(configXmlFullPathName.c_str()); - // traiter le fichier local + // traiter le fichier local } - + // ==> Then we look for bbtk_config.xml in ".bbtk" - else + else { -#if defined(__GNUC__) - std::string str_home(getenv("HOME")); -#elif defined(_WIN32) - std::string str_home(getenv("USERPROFILE")); -#endif -//EED configXmlFullPathName = str_home + mFile_separator + ".bbtk/bbtk_config.xml"; - configXmlFullPathName = str_home + "/.bbtk/bbtk_config.xml"; - Utilities::replace( configXmlFullPathName , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR); - + 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()); } @@ -184,214 +223,229 @@ namespace bbtk { } //========================================================================= - + //========================================================================= + 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); - bbtkMessage("Config",1, "in CreateConfigXML[" << configXml << "]" << std::endl); + 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, " http://www.creatis.insa-lyon.fr/software/bbtk \n"); - // fprintf(fp, " \n"); fprintf(fp, " \n"); - // fprintf(fp, " \n"); fprintf(fp, " \n"); - fprintf(fp, " \n");//, BBTK_DATA_PATH); - /// \todo find a decent default value ! - ///fprintf(fp, " %s \n", " "); - // when $ will be found, default_temp_dir value will be replaced - fprintf(fp, " $\n"); - fprintf(fp, "\n"); - fclose(fp); + fprintf(fp, "\n"); + fclose(fp); } - //========================================================================= + //========================================================================= - //========================================================================= - std::string ConfigurationFile::GetExecutablePath() - { - /// \todo : Think to delete it! - char *buf = (char *)malloc(512); - char *slash; - -#if defined(WIN32) - GetModuleFileName(NULL, buf, 511); - slash = strrchr(buf, '\\'); - if (slash) - { - *slash = 0; - } -#elif defined(__GNUC__) - int res; - res = readlink("/proc/self/exe", buf, 512); - if (res == -1) - return ""; - buf[res] = 0; - slash = strrchr(buf, '/'); - if (slash) - { - *slash = 0; - } -#else - return ""; -#endif - std::string ret(buf); - free(buf); - return ret; - } - //========================================================================= //========================================================================= 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[100]; - strcpy(bbtk_path, "/usr/local/bin"); - + char bbtk_path[1000]; + strcpy(bbtk_path, Utilities::GetExecutablePath().c_str()); // JPR + //strcpy(bbtk_path, "/usr/local/bin"); + + + std::string str_home=Utilities::GetEnvHome(); + + // rootDirectory char rootDirectory[200]; - sprintf( rootDirectory, "%s/.bbtk", getenv("HOME")); - + sprintf( rootDirectory, "%s/.bbtk", str_home.c_str()); + // configPath char configPath[200]; sprintf(configPath, "%s/bbtk_config.xml",rootDirectory); - - // makeDir - char makeDir[250]; - sprintf( makeDir, "mkdir \"%s\" ", rootDirectory); - + // configXmlTmp - char configXmlTmp[250]; + 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 (!Utilities::FileExists(rootDirectory)) // .bbtk not found - { - system(makeDir); // create .bbtk - } - + { // 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(rootDirectory)) - { - //std::cout << "makeDir[" << makeDir << "]" << std::endl; - system(makeDir); - } - 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]; + 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]; + 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 (!Utilities::FileExists(rootDirectory)) // .bbtk not found - { - system(makeDir); // create .bbtk - } - // 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); + 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); - } + system(copyFile); + } } - } - else + } + else { system(makeDir); - system(copyFile); - } - return; - // ------------------------------------------------------------------ + system(copyFile); + } + return; + // ------------------------------------------------------------------ #else /// \todo ConfigurationFile::InstallPath() : exit when for not WIN32 and not__GNUC__ - return; + return; #endif } @@ -402,121 +456,194 @@ namespace bbtk //========================================================================= // 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 ) + + if ( res->error != eXMLErrorNone ) { std::string mess = GetErrorMessage(res,filename); delete res; - bbtkDebugMessage("Config",1,mess<< std::endl); + bbtkDebugMessage("config",1,mess<< std::endl); bbtkError(mess); } delete res; - - bbtkDebugMessage("Config",1,"OK" << std::endl); - + + 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); + + 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); + + bbtkMessage("help",level, "BBS Paths " << std::endl); for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i ) { - bbtkMessage("Help",level,"--- ["<<*i<<"]"<