1 /*=========================================================================
3 Module: $RCSfile: bbtkConfigurationFile.cxx,v $
5 Date: $Date: 2008/10/17 08:18:13 $
6 Version: $Revision: 1.18 $
7 =========================================================================*/
9 /* ---------------------------------------------------------------------
11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
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.
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
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 * ------------------------------------------------------------------------ */
33 *\brief Class bbtk::ConfigurationFile
36 #include "bbtkConfigurationFile.h"
37 #include "bbtkMessageManager.h"
39 #include "bbtkUtilities.h"
42 #include <direct.h> // for getcwd
50 //====================================================================
52 ConfigurationFile::ConfigurationFile()
55 mFile_separator = VALID_FILE_SEPARATOR;
57 // ==> Set system paths
58 mBin_path = GetExecutablePath();
59 //EED mInstall_path = mBin_path + mFile_separator + "..";
60 mInstall_path = mBin_path + "/..";
61 // The relative path to the doc folder (=BBTK_DOC_REL_PATH)
62 mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH);
63 // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
64 //EED mDoc_path = mInstall_path + mFile_separator + mDoc_rel_path;
65 mDoc_path = mInstall_path + "/" + mDoc_rel_path;
66 // The relative path to the doc folder (=BBTK_BBS_REL_PATH)
67 mBbs_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_BBS_REL_PATH);
68 // The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
69 //EED mBbs_path = mInstall_path + mFile_separator + mBbs_rel_path;
70 mBbs_path = mInstall_path + "/" + mBbs_rel_path;
71 // The relative path to the rsc folder (=BBTK_RSC_REL_PATH)
72 // mRsc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_RSC_REL_PATH);
73 // The path to the rsc folder (=mInstall_path+"/"+mRsc_rel_path)
74 // mRsc_path = mInstall_path + mFile_separator + mRsc_rel_path;
75 // The path to the bbtk data folder
76 // Initialized to mInstall_path+"/"+BBTK_DATA_REL_PATH
77 // But can be overriden by value read from bbtk_config.xml
78 //EED mData_path = mInstall_path + mFile_separator + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
79 mData_path = mInstall_path + "/" + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
81 Utilities::replace( mBin_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
82 Utilities::replace( mInstall_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
83 Utilities::replace( mDoc_rel_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
84 Utilities::replace( mDoc_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
85 Utilities::replace( mBbs_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
86 Utilities::replace( mData_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
88 bbtkMessage("Config",1," ==> bin : '"<<mBin_path<<"'"<<std::endl);
89 bbtkMessage("Config",1," ==> prefix : '"<<mInstall_path<<"'"<<std::endl);
90 bbtkMessage("Config",1," ==> doc : '"<<mDoc_path<<"'"<<std::endl);
91 bbtkMessage("Config",1," ==> bbs : '"<<mBbs_path<<"'"<<std::endl);
92 bbtkMessage("Config",1," ==> data : '"<<mData_path<<"'"<<std::endl);
98 // always add "." (current working directory) at the begining
99 mBbs_paths.push_back( "." );
100 // add system bbs path
101 mBbs_paths.push_back(mBbs_path);
102 // add toolsbbtk/appli
103 //EED std::string toolsappli_rel_path(mFile_separator);
104 std::string toolsappli_rel_path("/");
105 //EED toolsappli_rel_path += "toolsbbtk" + mFile_separator + "appli";
106 toolsappli_rel_path += "toolsbbtk/appli";
108 //-----------------------------------------------------------
109 // LG : REMOVE BUGGY PATH WITH include *:
111 // mBbs_paths.push_back(mBbs_path + toolsappli_rel_path);
112 //-----------------------------------------------------------
113 int iStrVec,sizeStrVec;
115 sizeStrVec = mBbs_paths.size();
116 for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
117 Utilities::replace( mBbs_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
121 // always add "." (current working directory) at the begining
122 mPackage_paths.push_back(".");
123 // add system bin path (for build tree / standalone folder install)
124 mPackage_paths.push_back(mBin_path);
125 // add system lib path (for install tree)
126 //EED mPackage_paths.push_back(mInstall_path + mFile_separator + "lib");
127 mPackage_paths.push_back(mInstall_path + "/lib");
129 // add bin/Debug bin/Release paths (for build/install tree)
130 //EED mPackage_paths.push_back(mBin_path + mFile_separator + "Debug");
131 mPackage_paths.push_back(mBin_path + "/Debug");
132 //EED mPackage_paths.push_back(mBin_path + mFile_separator + "Release");
133 mPackage_paths.push_back(mBin_path + "/Release");
136 sizeStrVec = mPackage_paths.size();
137 for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
138 Utilities::replace( mPackage_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
145 // ==> First we look for bbtk_config.xml in "."
147 const char *currentDir = getcwd(buf, 2048);
151 std::cerr << "Path was too long to fit on 2048 bytes ?!?" << std::endl;
152 // \todo : what else?
153 // How abort a constructor and warn the caller function?
154 // LG : throw an exception
157 // std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml";
158 std::string configXmlFullPathName = currentDir ;
159 configXmlFullPathName += "/bbtk_config.xml";
160 Utilities::replace( configXmlFullPathName , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
162 if ( Utilities::FileExists( configXmlFullPathName ))
164 bbtkMessage("Config",1, "ConfigurationFile : [" << configXmlFullPathName <<
165 "] found in current directory" << std::endl);
166 //Read(configXmlFullPathName.c_str());
167 // traiter le fichier local
170 // ==> Then we look for bbtk_config.xml in ".bbtk"
173 configXmlFullPathName = Utilities::MakeUserSettingsFullFileName("bbtk_config.xml");
174 if (!Utilities::FileExists( configXmlFullPathName ))
176 // ==> Nothing found, we create bbtk_config.xml in ".bbtk"
181 // In any case, deal with bbtk_config.xml!
182 Read(configXmlFullPathName.c_str());
184 //=========================================================================
186 //=========================================================================
188 ConfigurationFile::~ConfigurationFile()
191 //=========================================================================
196 //=========================================================================
197 void ConfigurationFile::CreateConfigXML( char *rootDirectory )
201 sprintf (configXml , "%s/bbtk_config.xml", rootDirectory);
202 bbtkMessage("Config",1, "in CreateConfigXML[" << configXml << "]" << std::endl);
203 fp = fopen (configXml, "w");
204 fprintf(fp, "<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n");
205 // fprintf(fp, "<!DOCTYPE config SYSTEM \"/mnt/windows/bbtk/bbtk_config.xml>\n");
206 fprintf(fp, "<config>\n");
207 fprintf(fp, " <description> </description>\n");
208 // fprintf(fp, " <url> http://www.creatis.insa-lyon.fr/software/bbtk </url>\n");
209 // fprintf(fp, " <install_path> </install_path>\n");
210 fprintf(fp, " <bbs_path> </bbs_path>\n");
211 // fprintf(fp, " <ext_dll_path> </ext_dll_path>\n");
212 fprintf(fp, " <package_path> </package_path>\n");
213 fprintf(fp, " <data_path> </data_path>\n");//, BBTK_DATA_PATH);
214 /// \todo find a decent default value !
215 ///fprintf(fp, " <default_temp_dir> %s </default_temp_dir>\n", " ");
216 // when $ will be found, default_temp_dir value will be replaced
217 fprintf(fp, " <default_temp_dir>$</default_temp_dir>\n");
218 fprintf(fp, "</config>\n");
221 //=========================================================================
224 //=========================================================================
225 std::string ConfigurationFile::GetExecutablePath()
227 /// \todo : Think to delete it!
228 char *buf = (char *)malloc(512);
232 GetModuleFileName(NULL, buf, 511);
233 slash = strrchr(buf, '\\');
238 #elif defined(__GNUC__)
240 res = readlink("/proc/self/exe", buf, 512);
244 slash = strrchr(buf, '/');
252 std::string ret(buf);
256 //=========================================================================
259 //=========================================================================
260 void ConfigurationFile::InstallPath ()
263 /*--------------------------------------------------
264 New policy for bbtk_config.xml :
266 if bbtk_config.xml found in current directory (user is an aware user!)
269 else if bbtk_config.xml found in HOME/.bbtk (user already worked with it)
272 else if bbtk_config.xml.tmp found in /usr/local/bin or c:\\Program Files\\BBTK\\bin
273 copy it as .bbtk/bbtk_config.xml
275 else (nothing installed)
276 create a minimum version in HOME/.bbtk
277 ----------------------------------------------------*/
280 // -----------------------------------------------------------------
281 #if defined(__GNUC__)
283 // ------------------ create some usefull strings ----------------
284 // installed bbtk_path
286 strcpy(bbtk_path, "/usr/local/bin");
289 char rootDirectory[200];
290 sprintf( rootDirectory, "%s/.bbtk", getenv("HOME"));
293 char configPath[200];
294 sprintf(configPath, "%s/bbtk_config.xml",rootDirectory);
298 sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
301 char configXmlTmp[250];
302 sprintf(configXmlTmp, "%s/bbtk_config.xml.tmp", bbtk_path);
307 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found (not installed)
309 if (!Utilities::FileExists(rootDirectory)) // .bbtk not found
311 system(makeDir); // create .bbtk
314 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
315 CreateConfigXML( rootDirectory );// create .bbtk
319 sprintf(copyFile,"cp %s %s/bbtk_config.xml ",configXmlTmp,rootDirectory );
320 if (!Utilities::FileExists(rootDirectory))
322 //std::cout << "makeDir[" << makeDir << "]" << std::endl;
326 if (!Utilities::FileExists(configPath))
333 // ------------------------------------------------------------------
337 // installed bbtk_path
339 strcpy(bbtk_path, "\"c:\\Program Files\\BBTK\\bin\"");
340 char bbtk_path2[100];
341 strcpy(bbtk_path2, "c:\\Program Files\\BBTK\\bin");
344 char rootDirectory[200];
345 sprintf(rootDirectory, "%s\\.bbtk",getenv("USERPROFILE"));
346 // std::cout << "[" << rootDirectory << "]" << std::endl;
349 char configPath[200];
350 sprintf(configPath, "%s\\bbtk_config.xml",rootDirectory);
354 sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
357 char configXmlTmp[250];
358 sprintf(configXmlTmp, "%s\\bbtk_config.xml.tmp", bbtk_path2);
363 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found
365 if (!Utilities::FileExists(rootDirectory)) // .bbtk not found
367 system(makeDir); // create .bbtk
370 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
371 CreateConfigXML( rootDirectory );// create .bbtk
375 sprintf(copyFile,"copy %s\\bbtk_config.xml.tmp \"%s\"\\bbtk_config.xml ",bbtk_path,rootDirectory );
377 int attribs = GetFileAttributes (rootDirectory);
378 bbtkMessage("Config",1,std::hex << attribs << " " << FILE_ATTRIBUTE_DIRECTORY << std::endl);
379 if ( attribs != 0xFFFFFFFF)
381 if ((attribs & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY ) /// \TODO : check !
383 if ( GetFileAttributes( configPath ) == 0xFFFFFFFF)
395 // ------------------------------------------------------------------
397 /// \todo ConfigurationFile::InstallPath() : exit when for not WIN32 and not__GNUC__
403 //=========================================================================
407 //=========================================================================
408 // Gets the list of directories holding bb scripts, packages, dll, ... from the xml file
411 void ConfigurationFile::Read(const std::string& filename)
414 bbtkDebugMessage("Config",1,"ConfigurationFile::Read(" <<filename << ")" << std::endl);
416 mConfig_xml_full_path = filename;
417 XMLResults* res = new XMLResults;
418 XMLNode BB = XMLNode::parseFile((XMLCSTR)filename.c_str(),(XMLCSTR)"config",res);
420 if ( res->error != eXMLErrorNone )
422 std::string mess = GetErrorMessage(res,filename);
424 bbtkDebugMessage("Config",1,mess<< std::endl);
429 bbtkDebugMessage("Config",1,"OK" << std::endl);
434 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"description"); i++)
437 GetTextOrClear(BB.getChildNode((XMLCSTR)"description",&j),val);
442 if( BB.nChildNode((XMLCSTR)"url") )
443 GetTextOrClear(BB.getChildNode((XMLCSTR)"url"),mUrl);
446 if( BB.nChildNode((XMLCSTR)"data_path") )
447 GetTextOrClear(BB.getChildNode((XMLCSTR)"data_path"),mData_path);
450 // if( BB.nChildNode((XMLCSTR)"install_path") )
451 // GetTextOrClear(BB.getChildNode((XMLCSTR)"install_path"),mInstall_path);
453 // add user bbs paths
454 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"bbs_path"); i++)
457 GetTextOrClear(BB.getChildNode((XMLCSTR)"bbs_path",&j),val);
458 mBbs_paths.push_back(val);
463 // add user package path
464 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"package_path"); i++)
467 GetTextOrClear(BB.getChildNode((XMLCSTR)"package_path",&j),val);
468 mPackage_paths.push_back(val);
472 if( BB.nChildNode((XMLCSTR)"default_temp_dir") )
473 GetTextOrClear(BB.getChildNode((XMLCSTR)"default_temp_dir"),mDefault_temp_dir);
475 if ( mDefault_temp_dir == "$") // no value found in config_xml
477 size_t pos = mConfig_xml_full_path.find("bbtk_config.xml");
478 mDefault_temp_dir = mConfig_xml_full_path.substr (0,pos);
483 //=========================================================================
485 //=========================================================================
486 bool ConfigurationFile::AddPackagePathsAndWrite( const std::string& path )
488 bbtkDebugMessageInc("Config",9,
489 "ConfigurationFile::AddPackagePathsAndWrite("
490 <<path<<")"<<std::endl);
492 XMLResults* res = new XMLResults;
494 XMLNode::parseFile((XMLCSTR)Get_config_xml_full_path().c_str(),
495 (XMLCSTR)"config",res);
497 if ( res->error != eXMLErrorNone )
499 std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
501 bbtkDebugMessage("Config",1,mess<< std::endl);
507 std::string bbs_path = path + "/bbs";
509 std::string bbs_path = path + "/share/bbtk/bbs" ;
511 XMLNode BBSPATH = BB.addChild((XMLCSTR)"bbs_path");
512 BBSPATH.addText((XMLCSTR)bbs_path.c_str());
513 Utilities::replace(bbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR);
514 mBbs_paths.push_back(bbs_path);
517 std::string pack_path = path + "/bin";
519 std::string pack_path = path ;
521 XMLNode PACKPATH = BB.addChild((XMLCSTR)"package_path");
522 PACKPATH.addText((XMLCSTR)pack_path.c_str());
523 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
524 mPackage_paths.push_back(pack_path);
527 pack_path = path + "/Debug";
528 PACKPATH = BB.addChild((XMLCSTR)"package_path");
529 PACKPATH.addText((XMLCSTR)pack_path.c_str());
530 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
531 mPackage_paths.push_back(pack_path);
532 pack_path = path + "/Release";
533 PACKPATH = BB.addChild((XMLCSTR)"package_path");
534 PACKPATH.addText((XMLCSTR)pack_path.c_str());
535 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
536 mPackage_paths.push_back(pack_path);
540 XMLError err = BB.writeToFile((XMLCSTR)Get_config_xml_full_path().c_str());
541 if ( err != eXMLErrorNone )
543 std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
544 bbtkDebugMessage("Config",1,mess<< std::endl);
550 //=========================================================================
552 //=========================================================================
553 void ConfigurationFile::GetHelp(int level) const
555 bbtkDebugMessageInc("Config",9,"ConfigurationFile::GetHelp("<<level
558 const std::string config_xml_full_path = Get_config_xml_full_path();
559 const std::string description = Get_description();
560 const std::string url = Get_doc_path();
561 const std::string data_path = Get_data_path();
562 const std::string default_temp_dir = Get_default_temp_dir();
563 const std::string file_separator = Get_file_separator();
564 const std::vector<std::string>bbs_paths = Get_bbs_paths();
565 const std::vector<std::string>package_paths = Get_package_paths();
567 bbtkMessage("Help",level, "=============" << std::endl);
568 bbtkMessage("Help",level, "Configuration" << std::endl);
569 bbtkMessage("Help",level, "=============" << std::endl);
570 bbtkMessage("Help",level, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl);
571 bbtkMessage("Help",level, "Documentation Path : [" << url << "]" << std::endl);
572 bbtkMessage("Help",level, "Data Path : [" << data_path << "]" << std::endl);
573 bbtkMessage("Help",level, "Temp Directory : [" << default_temp_dir << "]" << std::endl);
574 bbtkMessage("Help",level, "File Separator : [" << file_separator << "]" << std::endl);
576 std::vector<std::string>::const_iterator i;
578 bbtkMessage("Help",level, "BBS Paths " << std::endl);
579 for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
581 bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
584 bbtkMessage("Help",level, "PACKAGE Paths : " << std::endl);
585 for (i = package_paths.begin(); i!=package_paths.end(); ++i )
587 bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
590 bbtkDebugDecTab("Config",9);
592 //=========================================================================