1 /*=========================================================================
3 Module: $RCSfile: bbtkConfigurationFile.cxx,v $
5 Date: $Date: 2011/03/08 16:56:13 $
6 Version: $Revision: 1.37 $
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"
41 #include "creaSystem.h"
44 # include <direct.h> // for getcwd
51 //====================================================================
53 ConfigurationFile::ConfigurationFile()
55 mFile_separator = VALID_FILE_SEPARATOR;
57 // ==> Set system paths
58 mBin_path = Utilities::GetExecutablePath();
62 mInstall_path = mBin_path + "/../../../..";
64 mInstall_path = mBin_path + "/..";
68 std::string macPath("Contents/MacOS");
69 int sbp = mBin_path.length();
70 int smp = macPath.length();
71 if (mBin_path.compare( sbp-smp, smp, macPath )==0 )
73 mBin_path = mBin_path + "/../../..";
77 ///\TODO : better use ??
78 mInstall_path = mBin_path + "/..";
80 // The relative path to the doc folder (=BBTK_DOC_REL_PATH)
81 // mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH);
82 // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
83 // mDoc_path = mInstall_path + "/" + mDoc_rel_path;
84 // Have to create bbtk user's dirs if needed
86 // LG 27/01/09 : doc is now user dependent
87 // and located in user's .bbtk dir /doc
88 // All dirs under .bbtk user's dir are set and created by:
89 InitializeDotBbtkStructure();
91 // The relative path to the doc folder (=BBTK_BBS_REL_PATH)
92 mBbs_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_BBS_REL_PATH);
93 // The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
94 mBbs_path = mInstall_path + "/" + mBbs_rel_path;
96 mData_path = mInstall_path + "/" + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
98 Utilities::replace( mBin_path,
99 INVALID_FILE_SEPARATOR,
100 VALID_FILE_SEPARATOR);
101 Utilities::replace( mInstall_path,
102 INVALID_FILE_SEPARATOR,
103 VALID_FILE_SEPARATOR);
104 Utilities::replace( mBbs_path,
105 INVALID_FILE_SEPARATOR,
106 VALID_FILE_SEPARATOR);
107 Utilities::replace( mData_path,
108 INVALID_FILE_SEPARATOR,
109 VALID_FILE_SEPARATOR);
111 bbtkMessage("config",1," ==> bin : '"<<mBin_path<<"'"<<std::endl);
112 bbtkMessage("config",1," ==> prefix : '"<<mInstall_path<<"'"<<std::endl);
113 bbtkMessage("config",1," ==> doc : '"<<mDoc_path<<"'"<<std::endl);
114 bbtkMessage("config",1," ==> bbs : '"<<mBbs_path<<"'"<<std::endl);
115 bbtkMessage("config",1," ==> data : '"<<mData_path<<"'"<<std::endl);
118 // always add "." (current working directory) at the begining
119 mBbs_paths.push_back( "." );
120 // add system bbs path
121 mBbs_paths.push_back(mBbs_path);
122 // add toolsbbtk/appli
123 //EED std::string toolsappli_rel_path(mFile_separator);
124 std::string toolsappli_rel_path("/");
125 //EED toolsappli_rel_path += "toolsbbtk" + mFile_separator + "appli";
126 toolsappli_rel_path += "toolsbbtk/appli";
128 //-----------------------------------------------------------
129 // LG : REMOVE BUGGY PATH WITH include *:
131 // mBbs_paths.push_back(mBbs_path + toolsappli_rel_path);
132 //-----------------------------------------------------------
133 int iStrVec,sizeStrVec;
135 sizeStrVec = mBbs_paths.size();
136 for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
137 Utilities::replace( mBbs_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
141 // always add "." (current working directory) at the begining
142 mPackage_paths.push_back(".");
143 // add system bin path (for build tree / standalone folder install)
144 mPackage_paths.push_back(mBin_path);
145 // add system lib path (for install tree)
146 //EED mPackage_paths.push_back(mInstall_path + mFile_separator + "lib");
148 //mPackage_paths.push_back(mInstall_path + "/lib"); // JPR
149 //mPackage_paths.push_back(mInstall_path + "/lib64");// JPR
151 ///\TODO : better use BBTK_PACKAGE_LIB_PATH // JPR
153 mPackage_paths.push_back(mInstall_path + "/lib/creatools");
154 mPackage_paths.push_back(mInstall_path + "/lib64/creatools");
156 // add bin/Debug bin/Release paths (for build/install tree)
157 //EED mPackage_paths.push_back(mBin_path + mFile_separator + "Debug");
158 mPackage_paths.push_back(mBin_path + "/Debug");
159 //EED mPackage_paths.push_back(mBin_path + mFile_separator + "Release");
160 mPackage_paths.push_back(mBin_path + "/Release");
163 sizeStrVec = mPackage_paths.size();
164 for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
165 Utilities::replace( mPackage_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
170 // ==> First we look for bbtk_config.xml in "."
172 const char *currentDir = getcwd(buf, 2048);
176 std::cerr << "Path was too long to fit on 2048 bytes ?!?" << std::endl;
177 // \todo : what else?
178 // How abort a constructor and warn the caller function?
179 // LG : throw an exception
182 // std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml";
183 std::string configXmlFullPathName = currentDir ;
184 configXmlFullPathName += "/bbtk_config.xml";
185 Utilities::replace( configXmlFullPathName , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
187 if ( Utilities::FileExists( configXmlFullPathName ))
189 bbtkMessage("config",1, "ConfigurationFile : [" << configXmlFullPathName <<
190 "] found in current directory" << std::endl);
191 //Read(configXmlFullPathName.c_str());
192 // traiter le fichier local
195 // ==> Then we look for bbtk_config.xml in ".bbtk"
198 configXmlFullPathName = Utilities::MakeUserSettingsFullFileName("bbtk_config.xml");
199 if (!Utilities::FileExists( configXmlFullPathName ))
201 // ==> Nothing found, we create bbtk_config.xml in ".bbtk"
206 // In any case, deal with bbtk_config.xml!
207 Read(configXmlFullPathName.c_str());
209 //=========================================================================
211 //=========================================================================
213 ConfigurationFile::~ConfigurationFile()
216 //=========================================================================
218 //=========================================================================
219 void ConfigurationFile::InitializeDotBbtkStructure()
221 mDot_bbtk_path = Utilities::GetUserSettingsDir();
222 mDot_bbtk_is_new = false;
223 if (!Utilities::FileExists(mDot_bbtk_path)) mDot_bbtk_is_new = true;
224 Utilities::CreateDirectoryIfNeeded(mDot_bbtk_path);
226 mDoc_path = Utilities::MakeUserSettingsFullFileName("doc");
227 Utilities::CreateDirectoryIfNeeded(mDoc_path);
229 std::string bbdoc_path =
230 Utilities::MakeUserSettingsFullFileName("doc/bbdoc");
231 Utilities::CreateDirectoryIfNeeded(bbdoc_path);
233 // Create help_contents.html if does not exist
234 std::string filename = Utilities::MakeUserSettingsFullFileName("doc/help_contents.html");
235 if (!Utilities::FileExists(filename))
237 bbtkDebugMessage("config",1,
238 "* Creating [" << filename << "]" << std::endl);
239 // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
240 std::string doc_path = mInstall_path + "/"
241 + BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH) + "/";
242 Utilities::MakeValidFileName(doc_path);
245 f.open(filename.c_str(), std::ios::out );
246 f << "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD "
247 << "HTML 4.01 Transitional//EN\">"
248 << "<html><head><title>Help Contents - bbtk "
249 << GetVersion() << "</title>"
250 << "<meta http-equiv=\"Content-Type\" content=\"text/html; "
251 << "charset=iso-8859-1\"></head><H1>Help Contents</H1>"
252 << "<a href=\"bbdoc/index-category.html#demo\" "
253 << "target=\"information\">Demos</a><br>"
254 << "<a href=\"bbdoc/index-category.html#example\" "
255 << "target=\"information\">Examples</a>"
259 << "bbtkUsersGuide/bbtkUsersGuide.pdf"
260 << "\" target=\"information\">User's Guide</a><br>"
263 << "bbtkDevelopersGuide/bbtkDevelopersGuide.pdf"
264 << "\" target=\"information\">Developer's Guide</a><br>"
267 << "bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.pdf"
268 << "\" target=\"information\">Package Developer's Guide</a><br>"
271 << "doxygen/bbtk/main.html"
272 << "\" target=\"information\">bbtk library doxygen doc</a><br>"
274 << "<a target=\"information\" href=\"bbdoc/index-alpha.html\">"
275 << "Alphabetical list</a><br>"
276 << "<a target=\"information\" href=\"bbdoc/index-package.html\">"
277 << "List by package</a><br>"
278 << "<a target=\"information\" href=\"bbdoc/index-category.html\">"
279 << "List by category</a><br>"
280 << "<a target=\"information\" href=\"bbdoc/index-adaptors.html\">"
281 << "List of adaptors</a><br>"
286 mTemp_path = Utilities::MakeUserSettingsFullFileName("tmp");
287 Utilities::CreateDirectoryIfNeeded(mTemp_path);
290 //=========================================================================
292 //=========================================================================
293 void ConfigurationFile::CreateConfigXML( char *rootDirectory )
297 sprintf (configXml , "%s/bbtk_config.xml", rootDirectory);
298 bbtkDebugMessage("config",1, "in CreateConfigXML[" << configXml << "]" << std::endl);
299 fp = fopen (configXml, "w");
300 fprintf(fp, "<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n");
301 fprintf(fp, "<config>\n");
302 fprintf(fp, " <bbs_path> </bbs_path>\n");
303 fprintf(fp, " <package_path> </package_path>\n");
304 fprintf(fp, "</config>\n");
307 //=========================================================================
312 //=========================================================================
313 void ConfigurationFile::InstallPath ()
316 /*--------------------------------------------------
317 New policy for bbtk_config.xml :
319 if bbtk_config.xml found in current directory (user is an aware user!)
322 else if bbtk_config.xml found in HOME/.bbtk (user already worked with it)
325 else if bbtk_config.xml.tmp found in /usr/local/bin or c:\\Program Files\\BBTK\\bin
326 copy it as .bbtk/bbtk_config.xml
328 else (nothing installed)
329 create a minimum version in HOME/.bbtk
330 ----------------------------------------------------*/
333 // -----------------------------------------------------------------
334 #if defined(__GNUC__)
336 // ------------------ create some usefull strings ----------------
337 // installed bbtk_path
338 char bbtk_path[1000];
339 strcpy(bbtk_path, Utilities::GetExecutablePath().c_str()); // JPR
340 //strcpy(bbtk_path, "/usr/local/bin");
343 char rootDirectory[200];
344 sprintf( rootDirectory, "%s/.bbtk", getenv("HOME"));
347 char configPath[200];
348 sprintf(configPath, "%s/bbtk_config.xml",rootDirectory);
351 char configXmlTmp[250];
352 sprintf(configXmlTmp, "%s/bbtk_config.xml.tmp", bbtk_path);
357 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found (not installed)
359 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
360 CreateConfigXML( rootDirectory );// create .bbtk
364 sprintf(copyFile,"cp %s %s/bbtk_config.xml ",configXmlTmp,rootDirectory );
365 if (!Utilities::FileExists(configPath))
372 // ------------------------------------------------------------------
376 // installed bbtk_path
378 strcpy(bbtk_path, "\"c:\\Program Files\\BBTK\\bin\"");
379 char bbtk_path2[100];
380 strcpy(bbtk_path2, "c:\\Program Files\\BBTK\\bin");
383 char rootDirectory[200];
384 sprintf(rootDirectory, "%s\\.bbtk",getenv("USERPROFILE"));
385 // std::cout << "[" << rootDirectory << "]" << std::endl;
388 char configPath[200];
389 sprintf(configPath, "%s\\bbtk_config.xml",rootDirectory);
393 sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
396 char configXmlTmp[250];
397 sprintf(configXmlTmp, "%s\\bbtk_config.xml.tmp", bbtk_path2);
402 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found
404 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
405 CreateConfigXML( rootDirectory );// create .bbtk
409 sprintf(copyFile,"copy %s\\bbtk_config.xml.tmp \"%s\"\\bbtk_config.xml ",bbtk_path,rootDirectory );
411 int attribs = GetFileAttributes (rootDirectory);
412 bbtkMessage("config",1,std::hex << attribs << " " << FILE_ATTRIBUTE_DIRECTORY << std::endl);
413 if ( attribs != 0xFFFFFFFF)
415 if ((attribs & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY ) /// \TODO : check !
417 if ( GetFileAttributes( configPath ) == 0xFFFFFFFF)
429 // ------------------------------------------------------------------
431 /// \todo ConfigurationFile::InstallPath() : exit when for not WIN32 and not__GNUC__
437 //=========================================================================
441 //=========================================================================
442 // Gets the list of directories holding bb scripts, packages, dll, ... from the xml file
445 void ConfigurationFile::Read(const std::string& filename)
448 bbtkDebugMessage("config",1,"ConfigurationFile::Read(" <<filename << ")" << std::endl);
450 mConfig_xml_full_path = filename;
451 XMLResults* res = new XMLResults;
452 XMLNode BB = XMLNode::parseFile((XMLCSTR)filename.c_str(),(XMLCSTR)"config",res);
454 if ( res->error != eXMLErrorNone )
456 std::string mess = GetErrorMessage(res,filename);
458 bbtkDebugMessage("config",1,mess<< std::endl);
463 bbtkDebugMessage("config",1,"OK" << std::endl);
468 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"description"); i++)
471 GetTextOrClear(BB.getChildNode((XMLCSTR)"description",&j),val);
476 if( BB.nChildNode((XMLCSTR)"url") )
477 GetTextOrClear(BB.getChildNode((XMLCSTR)"url"),mUrl);
480 if( BB.nChildNode((XMLCSTR)"data_path") )
481 GetTextOrClear(BB.getChildNode((XMLCSTR)"data_path"),mData_path);
484 // if( BB.nChildNode((XMLCSTR)"install_path") )
485 // GetTextOrClear(BB.getChildNode((XMLCSTR)"install_path"),mInstall_path);
487 // add user bbs paths
488 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"bbs_path"); i++)
491 GetTextOrClear(BB.getChildNode((XMLCSTR)"bbs_path",&j),val);
492 mBbs_paths.push_back(val);
497 // add user package path
498 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"package_path"); i++)
501 GetTextOrClear(BB.getChildNode((XMLCSTR)"package_path",&j),val);
502 mPackage_paths.push_back(val);
507 if( BB.nChildNode((XMLCSTR)"default_temp_dir") )
508 GetTextOrClear(BB.getChildNode((XMLCSTR)"default_temp_dir"),mDefault_temp_dir);
510 if ( mDefault_temp_dir == "$") // no value found in config_xml
512 size_t pos = mConfig_xml_full_path.find("bbtk_config.xml");
513 mDefault_temp_dir = mConfig_xml_full_path.substr (0,pos);
519 //=========================================================================
521 //=========================================================================
522 bool ConfigurationFile::AddPackagePathsAndWrite( const std::string& path )
524 bbtkDebugMessageInc("config",9,
525 "ConfigurationFile::AddPackagePathsAndWrite("
526 <<path<<")"<<std::endl);
528 XMLResults* res = new XMLResults;
530 XMLNode::parseFile((XMLCSTR)Get_config_xml_full_path().c_str(),
531 (XMLCSTR)"config",res);
533 if ( res->error != eXMLErrorNone )
535 std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
537 bbtkDebugMessage("config",1,mess<< std::endl);
543 std::string bbs_path = path + "/bbs";
545 std::string bbs_path = path + "/share/bbtk/bbs" ;
547 XMLNode BBSPATH = BB.addChild((XMLCSTR)"bbs_path");
548 BBSPATH.addText((XMLCSTR)bbs_path.c_str());
549 Utilities::replace(bbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR);
550 mBbs_paths.push_back(bbs_path);
553 std::string pack_path = path + "/bin";
555 std::string pack_path = path ;
557 XMLNode PACKPATH = BB.addChild((XMLCSTR)"package_path");
558 PACKPATH.addText((XMLCSTR)pack_path.c_str());
559 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
560 mPackage_paths.push_back(pack_path);
563 pack_path = path + "/RelWithDebInfo";
564 PACKPATH = BB.addChild((XMLCSTR)"package_path");
565 PACKPATH.addText((XMLCSTR)pack_path.c_str());
566 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
567 mPackage_paths.push_back(pack_path);
568 pack_path = path + "/Debug";
569 PACKPATH = BB.addChild((XMLCSTR)"package_path");
570 PACKPATH.addText((XMLCSTR)pack_path.c_str());
571 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
572 mPackage_paths.push_back(pack_path);
573 pack_path = path + "/Release";
574 PACKPATH = BB.addChild((XMLCSTR)"package_path");
575 PACKPATH.addText((XMLCSTR)pack_path.c_str());
576 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
577 mPackage_paths.push_back(pack_path);
581 XMLError err = BB.writeToFile((XMLCSTR)Get_config_xml_full_path().c_str());
582 if ( err != eXMLErrorNone )
584 std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
585 bbtkDebugMessage("config",1,mess<< std::endl);
591 //=========================================================================
593 //=========================================================================
594 void ConfigurationFile::GetHelp(int level) const
596 bbtkDebugMessageInc("config",9,"ConfigurationFile::GetHelp("<<level
599 const std::string config_xml_full_path = Get_config_xml_full_path();
600 const std::string description = Get_description();
601 const std::string url = Get_doc_path();
602 const std::string data_path = Get_data_path();
603 const std::string default_temp_dir = Get_default_temp_dir();
604 const std::string file_separator = Get_file_separator();
605 const std::vector<std::string>bbs_paths = Get_bbs_paths();
606 const std::vector<std::string>package_paths = Get_package_paths();
608 bbtkMessage("help",level, "=============" << std::endl);
609 bbtkMessage("help",level, "Configuration" << std::endl);
610 bbtkMessage("help",level, "=============" << std::endl);
611 bbtkMessage("help",level, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl);
612 bbtkMessage("help",level, "Documentation Path : [" << url << "]" << std::endl);
613 bbtkMessage("help",level, "Data Path : [" << data_path << "]" << std::endl);
614 bbtkMessage("help",level, "Temp Directory : [" << default_temp_dir << "]" << std::endl);
615 bbtkMessage("help",level, "File Separator : [" << file_separator << "]" << std::endl);
617 std::vector<std::string>::const_iterator i;
619 bbtkMessage("help",level, "BBS Paths " << std::endl);
620 for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
622 bbtkMessage("help",level,"--- ["<<*i<<"]"<<std::endl);
625 bbtkMessage("help",level, "PACKAGE Paths : " << std::endl);
626 for (i = package_paths.begin(); i!=package_paths.end(); ++i )
628 bbtkMessage("help",level,"--- ["<<*i<<"]"<<std::endl);
631 bbtkDebugDecTab("config",9);
633 //=========================================================================