1 /*=========================================================================
3 Module: $RCSfile: bbtkConfigurationFile.cxx,v $
5 Date: $Date: 2008/11/03 15:53:31 $
6 Version: $Revision: 1.20 $
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 bbtkDebugMessage("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, "<config>\n");
206 fprintf(fp, " <bbs_path> </bbs_path>\n");
207 fprintf(fp, " <package_path> </package_path>\n");
208 fprintf(fp, " <default_temp_dir> $ </default_temp_dir>\n");
209 fprintf(fp, "</config>\n");
212 //=========================================================================
215 //=========================================================================
216 std::string ConfigurationFile::GetExecutablePath()
218 /// \todo : Think to delete it!
219 char *buf = (char *)malloc(512);
223 GetModuleFileName(NULL, buf, 511);
224 slash = strrchr(buf, '\\');
229 #elif defined(__GNUC__)
231 res = readlink("/proc/self/exe", buf, 512);
235 slash = strrchr(buf, '/');
243 std::string ret(buf);
247 //=========================================================================
250 //=========================================================================
251 void ConfigurationFile::InstallPath ()
254 /*--------------------------------------------------
255 New policy for bbtk_config.xml :
257 if bbtk_config.xml found in current directory (user is an aware user!)
260 else if bbtk_config.xml found in HOME/.bbtk (user already worked with it)
263 else if bbtk_config.xml.tmp found in /usr/local/bin or c:\\Program Files\\BBTK\\bin
264 copy it as .bbtk/bbtk_config.xml
266 else (nothing installed)
267 create a minimum version in HOME/.bbtk
268 ----------------------------------------------------*/
271 // -----------------------------------------------------------------
272 #if defined(__GNUC__)
274 // ------------------ create some usefull strings ----------------
275 // installed bbtk_path
277 strcpy(bbtk_path, "/usr/local/bin");
280 char rootDirectory[200];
281 sprintf( rootDirectory, "%s/.bbtk", getenv("HOME"));
284 char configPath[200];
285 sprintf(configPath, "%s/bbtk_config.xml",rootDirectory);
289 sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
292 char configXmlTmp[250];
293 sprintf(configXmlTmp, "%s/bbtk_config.xml.tmp", bbtk_path);
298 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found (not installed)
300 if (!Utilities::FileExists(rootDirectory)) // .bbtk not found
302 system(makeDir); // create .bbtk
305 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
306 CreateConfigXML( rootDirectory );// create .bbtk
310 sprintf(copyFile,"cp %s %s/bbtk_config.xml ",configXmlTmp,rootDirectory );
311 if (!Utilities::FileExists(rootDirectory))
313 //std::cout << "makeDir[" << makeDir << "]" << std::endl;
317 if (!Utilities::FileExists(configPath))
324 // ------------------------------------------------------------------
328 // installed bbtk_path
330 strcpy(bbtk_path, "\"c:\\Program Files\\BBTK\\bin\"");
331 char bbtk_path2[100];
332 strcpy(bbtk_path2, "c:\\Program Files\\BBTK\\bin");
335 char rootDirectory[200];
336 sprintf(rootDirectory, "%s\\.bbtk",getenv("USERPROFILE"));
337 // std::cout << "[" << rootDirectory << "]" << std::endl;
340 char configPath[200];
341 sprintf(configPath, "%s\\bbtk_config.xml",rootDirectory);
345 sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
348 char configXmlTmp[250];
349 sprintf(configXmlTmp, "%s\\bbtk_config.xml.tmp", bbtk_path2);
354 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found
356 if (!Utilities::FileExists(rootDirectory)) // .bbtk not found
358 system(makeDir); // create .bbtk
361 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
362 CreateConfigXML( rootDirectory );// create .bbtk
366 sprintf(copyFile,"copy %s\\bbtk_config.xml.tmp \"%s\"\\bbtk_config.xml ",bbtk_path,rootDirectory );
368 int attribs = GetFileAttributes (rootDirectory);
369 bbtkMessage("Config",1,std::hex << attribs << " " << FILE_ATTRIBUTE_DIRECTORY << std::endl);
370 if ( attribs != 0xFFFFFFFF)
372 if ((attribs & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY ) /// \TODO : check !
374 if ( GetFileAttributes( configPath ) == 0xFFFFFFFF)
386 // ------------------------------------------------------------------
388 /// \todo ConfigurationFile::InstallPath() : exit when for not WIN32 and not__GNUC__
394 //=========================================================================
398 //=========================================================================
399 // Gets the list of directories holding bb scripts, packages, dll, ... from the xml file
402 void ConfigurationFile::Read(const std::string& filename)
405 bbtkDebugMessage("Config",1,"ConfigurationFile::Read(" <<filename << ")" << std::endl);
407 mConfig_xml_full_path = filename;
408 XMLResults* res = new XMLResults;
409 XMLNode BB = XMLNode::parseFile((XMLCSTR)filename.c_str(),(XMLCSTR)"config",res);
411 if ( res->error != eXMLErrorNone )
413 std::string mess = GetErrorMessage(res,filename);
415 bbtkDebugMessage("Config",1,mess<< std::endl);
420 bbtkDebugMessage("Config",1,"OK" << std::endl);
425 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"description"); i++)
428 GetTextOrClear(BB.getChildNode((XMLCSTR)"description",&j),val);
433 if( BB.nChildNode((XMLCSTR)"url") )
434 GetTextOrClear(BB.getChildNode((XMLCSTR)"url"),mUrl);
437 if( BB.nChildNode((XMLCSTR)"data_path") )
438 GetTextOrClear(BB.getChildNode((XMLCSTR)"data_path"),mData_path);
441 // if( BB.nChildNode((XMLCSTR)"install_path") )
442 // GetTextOrClear(BB.getChildNode((XMLCSTR)"install_path"),mInstall_path);
444 // add user bbs paths
445 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"bbs_path"); i++)
448 GetTextOrClear(BB.getChildNode((XMLCSTR)"bbs_path",&j),val);
449 mBbs_paths.push_back(val);
454 // add user package path
455 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"package_path"); i++)
458 GetTextOrClear(BB.getChildNode((XMLCSTR)"package_path",&j),val);
459 mPackage_paths.push_back(val);
463 if( BB.nChildNode((XMLCSTR)"default_temp_dir") )
464 GetTextOrClear(BB.getChildNode((XMLCSTR)"default_temp_dir"),mDefault_temp_dir);
466 if ( mDefault_temp_dir == "$") // no value found in config_xml
468 size_t pos = mConfig_xml_full_path.find("bbtk_config.xml");
469 mDefault_temp_dir = mConfig_xml_full_path.substr (0,pos);
474 //=========================================================================
476 //=========================================================================
477 bool ConfigurationFile::AddPackagePathsAndWrite( const std::string& path )
479 bbtkDebugMessageInc("Config",9,
480 "ConfigurationFile::AddPackagePathsAndWrite("
481 <<path<<")"<<std::endl);
483 XMLResults* res = new XMLResults;
485 XMLNode::parseFile((XMLCSTR)Get_config_xml_full_path().c_str(),
486 (XMLCSTR)"config",res);
488 if ( res->error != eXMLErrorNone )
490 std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
492 bbtkDebugMessage("Config",1,mess<< std::endl);
498 std::string bbs_path = path + "/bbs";
500 std::string bbs_path = path + "/share/bbtk/bbs" ;
502 XMLNode BBSPATH = BB.addChild((XMLCSTR)"bbs_path");
503 BBSPATH.addText((XMLCSTR)bbs_path.c_str());
504 Utilities::replace(bbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR);
505 mBbs_paths.push_back(bbs_path);
508 std::string pack_path = path + "/bin";
510 std::string pack_path = path ;
512 XMLNode PACKPATH = BB.addChild((XMLCSTR)"package_path");
513 PACKPATH.addText((XMLCSTR)pack_path.c_str());
514 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
515 mPackage_paths.push_back(pack_path);
518 pack_path = path + "/Debug";
519 PACKPATH = BB.addChild((XMLCSTR)"package_path");
520 PACKPATH.addText((XMLCSTR)pack_path.c_str());
521 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
522 mPackage_paths.push_back(pack_path);
523 pack_path = path + "/Release";
524 PACKPATH = BB.addChild((XMLCSTR)"package_path");
525 PACKPATH.addText((XMLCSTR)pack_path.c_str());
526 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
527 mPackage_paths.push_back(pack_path);
531 XMLError err = BB.writeToFile((XMLCSTR)Get_config_xml_full_path().c_str());
532 if ( err != eXMLErrorNone )
534 std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
535 bbtkDebugMessage("Config",1,mess<< std::endl);
541 //=========================================================================
543 //=========================================================================
544 void ConfigurationFile::GetHelp(int level) const
546 bbtkDebugMessageInc("Config",9,"ConfigurationFile::GetHelp("<<level
549 const std::string config_xml_full_path = Get_config_xml_full_path();
550 const std::string description = Get_description();
551 const std::string url = Get_doc_path();
552 const std::string data_path = Get_data_path();
553 const std::string default_temp_dir = Get_default_temp_dir();
554 const std::string file_separator = Get_file_separator();
555 const std::vector<std::string>bbs_paths = Get_bbs_paths();
556 const std::vector<std::string>package_paths = Get_package_paths();
558 bbtkMessage("Help",level, "=============" << std::endl);
559 bbtkMessage("Help",level, "Configuration" << std::endl);
560 bbtkMessage("Help",level, "=============" << std::endl);
561 bbtkMessage("Help",level, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl);
562 bbtkMessage("Help",level, "Documentation Path : [" << url << "]" << std::endl);
563 bbtkMessage("Help",level, "Data Path : [" << data_path << "]" << std::endl);
564 bbtkMessage("Help",level, "Temp Directory : [" << default_temp_dir << "]" << std::endl);
565 bbtkMessage("Help",level, "File Separator : [" << file_separator << "]" << std::endl);
567 std::vector<std::string>::const_iterator i;
569 bbtkMessage("Help",level, "BBS Paths " << std::endl);
570 for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
572 bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
575 bbtkMessage("Help",level, "PACKAGE Paths : " << std::endl);
576 for (i = package_paths.begin(); i!=package_paths.end(); ++i )
578 bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
581 bbtkDebugDecTab("Config",9);
583 //=========================================================================