1 /*=========================================================================
3 Module: $RCSfile: bbtkConfigurationFile.cxx,v $
5 Date: $Date: 2011/03/08 11:32:02 $
6 Version: $Revision: 1.36 $
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
54 //====================================================================
56 ConfigurationFile::ConfigurationFile()
59 mFile_separator = VALID_FILE_SEPARATOR;
61 // ==> Set system paths
62 mBin_path = Utilities::GetExecutablePath();
69 mInstall_path = mBin_path + "/../../../..";
71 mInstall_path = mBin_path + "/..";
76 std::string macPath("Contents/MacOS");
77 int sbp = mBin_path.length();
78 int smp = macPath.length();
79 if (mBin_path.compare( sbp-smp, smp, macPath )==0 )
81 mBin_path = mBin_path + "/../../..";
86 mInstall_path = mBin_path + "/..";
90 // The relative path to the doc folder (=BBTK_DOC_REL_PATH)
91 // mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH);
92 // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
93 // mDoc_path = mInstall_path + "/" + mDoc_rel_path;
94 // Have to create bbtk user's dirs if needed
96 // LG 27/01/09 : doc is now user dependent
97 // and located in user's .bbtk dir /doc
98 // All dirs under .bbtk user's dir are set and created by:
99 InitializeDotBbtkStructure();
101 // The relative path to the doc folder (=BBTK_BBS_REL_PATH)
102 mBbs_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_BBS_REL_PATH);
103 // The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
104 mBbs_path = mInstall_path + "/" + mBbs_rel_path;
106 mData_path = mInstall_path + "/" + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
108 Utilities::replace( mBin_path,
109 INVALID_FILE_SEPARATOR,
110 VALID_FILE_SEPARATOR);
111 Utilities::replace( mInstall_path,
112 INVALID_FILE_SEPARATOR,
113 VALID_FILE_SEPARATOR);
114 Utilities::replace( mBbs_path,
115 INVALID_FILE_SEPARATOR,
116 VALID_FILE_SEPARATOR);
117 Utilities::replace( mData_path,
118 INVALID_FILE_SEPARATOR,
119 VALID_FILE_SEPARATOR);
121 bbtkMessage("config",1," ==> bin : '"<<mBin_path<<"'"<<std::endl);
122 bbtkMessage("config",1," ==> prefix : '"<<mInstall_path<<"'"<<std::endl);
123 bbtkMessage("config",1," ==> doc : '"<<mDoc_path<<"'"<<std::endl);
124 bbtkMessage("config",1," ==> bbs : '"<<mBbs_path<<"'"<<std::endl);
125 bbtkMessage("config",1," ==> data : '"<<mData_path<<"'"<<std::endl);
131 // always add "." (current working directory) at the begining
132 mBbs_paths.push_back( "." );
133 // add system bbs path
134 mBbs_paths.push_back(mBbs_path);
135 // add toolsbbtk/appli
136 //EED std::string toolsappli_rel_path(mFile_separator);
137 std::string toolsappli_rel_path("/");
138 //EED toolsappli_rel_path += "toolsbbtk" + mFile_separator + "appli";
139 toolsappli_rel_path += "toolsbbtk/appli";
141 //-----------------------------------------------------------
142 // LG : REMOVE BUGGY PATH WITH include *:
144 // mBbs_paths.push_back(mBbs_path + toolsappli_rel_path);
145 //-----------------------------------------------------------
146 int iStrVec,sizeStrVec;
148 sizeStrVec = mBbs_paths.size();
149 for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
150 Utilities::replace( mBbs_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
154 // always add "." (current working directory) at the begining
155 mPackage_paths.push_back(".");
156 // add system bin path (for build tree / standalone folder install)
157 mPackage_paths.push_back(mBin_path);
158 // add system lib path (for install tree)
159 //EED mPackage_paths.push_back(mInstall_path + mFile_separator + "lib");
160 mPackage_paths.push_back(mInstall_path + "/lib");
161 mPackage_paths.push_back(mInstall_path + "/lib64");
162 mPackage_paths.push_back(mInstall_path + "/lib/creatools");
163 mPackage_paths.push_back(mInstall_path + "/lib64/creatools");
165 // add bin/Debug bin/Release paths (for build/install tree)
166 //EED mPackage_paths.push_back(mBin_path + mFile_separator + "Debug");
167 mPackage_paths.push_back(mBin_path + "/Debug");
168 //EED mPackage_paths.push_back(mBin_path + mFile_separator + "Release");
169 mPackage_paths.push_back(mBin_path + "/Release");
172 sizeStrVec = mPackage_paths.size();
173 for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
174 Utilities::replace( mPackage_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
181 // ==> First we look for bbtk_config.xml in "."
183 const char *currentDir = getcwd(buf, 2048);
187 std::cerr << "Path was too long to fit on 2048 bytes ?!?" << std::endl;
188 // \todo : what else?
189 // How abort a constructor and warn the caller function?
190 // LG : throw an exception
193 // std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml";
194 std::string configXmlFullPathName = currentDir ;
195 configXmlFullPathName += "/bbtk_config.xml";
196 Utilities::replace( configXmlFullPathName , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
198 if ( Utilities::FileExists( configXmlFullPathName ))
200 bbtkMessage("config",1, "ConfigurationFile : [" << configXmlFullPathName <<
201 "] found in current directory" << std::endl);
202 //Read(configXmlFullPathName.c_str());
203 // traiter le fichier local
206 // ==> Then we look for bbtk_config.xml in ".bbtk"
209 configXmlFullPathName = Utilities::MakeUserSettingsFullFileName("bbtk_config.xml");
210 if (!Utilities::FileExists( configXmlFullPathName ))
212 // ==> Nothing found, we create bbtk_config.xml in ".bbtk"
217 // In any case, deal with bbtk_config.xml!
218 Read(configXmlFullPathName.c_str());
220 //=========================================================================
222 //=========================================================================
224 ConfigurationFile::~ConfigurationFile()
227 //=========================================================================
229 //=========================================================================
230 void ConfigurationFile::InitializeDotBbtkStructure()
232 mDot_bbtk_path = Utilities::GetUserSettingsDir();
233 mDot_bbtk_is_new = false;
234 if (!Utilities::FileExists(mDot_bbtk_path)) mDot_bbtk_is_new = true;
235 Utilities::CreateDirectoryIfNeeded(mDot_bbtk_path);
237 mDoc_path = Utilities::MakeUserSettingsFullFileName("doc");
238 Utilities::CreateDirectoryIfNeeded(mDoc_path);
240 std::string bbdoc_path =
241 Utilities::MakeUserSettingsFullFileName("doc/bbdoc");
242 Utilities::CreateDirectoryIfNeeded(bbdoc_path);
244 // Create help_contents.html if does not exist
245 std::string filename = Utilities::MakeUserSettingsFullFileName("doc/help_contents.html");
246 if (!Utilities::FileExists(filename))
248 bbtkDebugMessage("config",1,
249 "* Creating [" << filename << "]" << std::endl);
250 // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
251 std::string doc_path = mInstall_path + "/"
252 + BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH) + "/";
253 Utilities::MakeValidFileName(doc_path);
257 f.open(filename.c_str(), std::ios::out );
258 f << "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD "
259 << "HTML 4.01 Transitional//EN\">"
260 << "<html><head><title>Help Contents - bbtk "
261 << GetVersion() << "</title>"
262 << "<meta http-equiv=\"Content-Type\" content=\"text/html; "
263 << "charset=iso-8859-1\"></head><H1>Help Contents</H1>"
264 << "<a href=\"bbdoc/index-category.html#demo\" "
265 << "target=\"information\">Demos</a><br>"
266 << "<a href=\"bbdoc/index-category.html#example\" "
267 << "target=\"information\">Examples</a>"
271 << "bbtkUsersGuide/bbtkUsersGuide.pdf"
272 << "\" target=\"information\">User's Guide</a><br>"
275 << "bbtkDevelopersGuide/bbtkDevelopersGuide.pdf"
276 << "\" target=\"information\">Developer's Guide</a><br>"
279 << "bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.pdf"
280 << "\" target=\"information\">Package Developer's Guide</a><br>"
283 << "doxygen/bbtk/main.html"
284 << "\" target=\"information\">bbtk library doxygen doc</a><br>"
286 << "<a target=\"information\" href=\"bbdoc/index-alpha.html\">"
287 << "Alphabetical list</a><br>"
288 << "<a target=\"information\" href=\"bbdoc/index-package.html\">"
289 << "List by package</a><br>"
290 << "<a target=\"information\" href=\"bbdoc/index-category.html\">"
291 << "List by category</a><br>"
292 << "<a target=\"information\" href=\"bbdoc/index-adaptors.html\">"
293 << "List of adaptors</a><br>"
298 mTemp_path = Utilities::MakeUserSettingsFullFileName("tmp");
299 Utilities::CreateDirectoryIfNeeded(mTemp_path);
302 //=========================================================================
304 //=========================================================================
305 void ConfigurationFile::CreateConfigXML( char *rootDirectory )
309 sprintf (configXml , "%s/bbtk_config.xml", rootDirectory);
310 bbtkDebugMessage("config",1, "in CreateConfigXML[" << configXml << "]" << std::endl);
311 fp = fopen (configXml, "w");
312 fprintf(fp, "<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n");
313 fprintf(fp, "<config>\n");
314 fprintf(fp, " <bbs_path> </bbs_path>\n");
315 fprintf(fp, " <package_path> </package_path>\n");
316 fprintf(fp, "</config>\n");
319 //=========================================================================
324 //=========================================================================
325 void ConfigurationFile::InstallPath ()
328 /*--------------------------------------------------
329 New policy for bbtk_config.xml :
331 if bbtk_config.xml found in current directory (user is an aware user!)
334 else if bbtk_config.xml found in HOME/.bbtk (user already worked with it)
337 else if bbtk_config.xml.tmp found in /usr/local/bin or c:\\Program Files\\BBTK\\bin
338 copy it as .bbtk/bbtk_config.xml
340 else (nothing installed)
341 create a minimum version in HOME/.bbtk
342 ----------------------------------------------------*/
345 // -----------------------------------------------------------------
346 #if defined(__GNUC__)
348 // ------------------ create some usefull strings ----------------
349 // installed bbtk_path
350 char bbtk_path[1000];
351 strcpy(bbtk_path, Utilities::GetExecutablePath().c_str()); // JPR
352 //strcpy(bbtk_path, "/usr/local/bin");
355 char rootDirectory[200];
356 sprintf( rootDirectory, "%s/.bbtk", getenv("HOME"));
359 char configPath[200];
360 sprintf(configPath, "%s/bbtk_config.xml",rootDirectory);
363 char configXmlTmp[250];
364 sprintf(configXmlTmp, "%s/bbtk_config.xml.tmp", bbtk_path);
369 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found (not installed)
371 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
372 CreateConfigXML( rootDirectory );// create .bbtk
376 sprintf(copyFile,"cp %s %s/bbtk_config.xml ",configXmlTmp,rootDirectory );
377 if (!Utilities::FileExists(configPath))
384 // ------------------------------------------------------------------
388 // installed bbtk_path
390 strcpy(bbtk_path, "\"c:\\Program Files\\BBTK\\bin\"");
391 char bbtk_path2[100];
392 strcpy(bbtk_path2, "c:\\Program Files\\BBTK\\bin");
395 char rootDirectory[200];
396 sprintf(rootDirectory, "%s\\.bbtk",getenv("USERPROFILE"));
397 // std::cout << "[" << rootDirectory << "]" << std::endl;
400 char configPath[200];
401 sprintf(configPath, "%s\\bbtk_config.xml",rootDirectory);
405 sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
408 char configXmlTmp[250];
409 sprintf(configXmlTmp, "%s\\bbtk_config.xml.tmp", bbtk_path2);
414 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found
416 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
417 CreateConfigXML( rootDirectory );// create .bbtk
421 sprintf(copyFile,"copy %s\\bbtk_config.xml.tmp \"%s\"\\bbtk_config.xml ",bbtk_path,rootDirectory );
423 int attribs = GetFileAttributes (rootDirectory);
424 bbtkMessage("config",1,std::hex << attribs << " " << FILE_ATTRIBUTE_DIRECTORY << std::endl);
425 if ( attribs != 0xFFFFFFFF)
427 if ((attribs & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY ) /// \TODO : check !
429 if ( GetFileAttributes( configPath ) == 0xFFFFFFFF)
441 // ------------------------------------------------------------------
443 /// \todo ConfigurationFile::InstallPath() : exit when for not WIN32 and not__GNUC__
449 //=========================================================================
453 //=========================================================================
454 // Gets the list of directories holding bb scripts, packages, dll, ... from the xml file
457 void ConfigurationFile::Read(const std::string& filename)
460 bbtkDebugMessage("config",1,"ConfigurationFile::Read(" <<filename << ")" << std::endl);
462 mConfig_xml_full_path = filename;
463 XMLResults* res = new XMLResults;
464 XMLNode BB = XMLNode::parseFile((XMLCSTR)filename.c_str(),(XMLCSTR)"config",res);
466 if ( res->error != eXMLErrorNone )
468 std::string mess = GetErrorMessage(res,filename);
470 bbtkDebugMessage("config",1,mess<< std::endl);
475 bbtkDebugMessage("config",1,"OK" << std::endl);
480 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"description"); i++)
483 GetTextOrClear(BB.getChildNode((XMLCSTR)"description",&j),val);
488 if( BB.nChildNode((XMLCSTR)"url") )
489 GetTextOrClear(BB.getChildNode((XMLCSTR)"url"),mUrl);
492 if( BB.nChildNode((XMLCSTR)"data_path") )
493 GetTextOrClear(BB.getChildNode((XMLCSTR)"data_path"),mData_path);
496 // if( BB.nChildNode((XMLCSTR)"install_path") )
497 // GetTextOrClear(BB.getChildNode((XMLCSTR)"install_path"),mInstall_path);
499 // add user bbs paths
500 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"bbs_path"); i++)
503 GetTextOrClear(BB.getChildNode((XMLCSTR)"bbs_path",&j),val);
504 mBbs_paths.push_back(val);
509 // add user package path
510 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"package_path"); i++)
513 GetTextOrClear(BB.getChildNode((XMLCSTR)"package_path",&j),val);
514 mPackage_paths.push_back(val);
519 if( BB.nChildNode((XMLCSTR)"default_temp_dir") )
520 GetTextOrClear(BB.getChildNode((XMLCSTR)"default_temp_dir"),mDefault_temp_dir);
522 if ( mDefault_temp_dir == "$") // no value found in config_xml
524 size_t pos = mConfig_xml_full_path.find("bbtk_config.xml");
525 mDefault_temp_dir = mConfig_xml_full_path.substr (0,pos);
531 //=========================================================================
533 //=========================================================================
534 bool ConfigurationFile::AddPackagePathsAndWrite( const std::string& path )
536 bbtkDebugMessageInc("config",9,
537 "ConfigurationFile::AddPackagePathsAndWrite("
538 <<path<<")"<<std::endl);
540 XMLResults* res = new XMLResults;
542 XMLNode::parseFile((XMLCSTR)Get_config_xml_full_path().c_str(),
543 (XMLCSTR)"config",res);
545 if ( res->error != eXMLErrorNone )
547 std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
549 bbtkDebugMessage("config",1,mess<< std::endl);
555 std::string bbs_path = path + "/bbs";
557 std::string bbs_path = path + "/share/bbtk/bbs" ;
559 XMLNode BBSPATH = BB.addChild((XMLCSTR)"bbs_path");
560 BBSPATH.addText((XMLCSTR)bbs_path.c_str());
561 Utilities::replace(bbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR);
562 mBbs_paths.push_back(bbs_path);
565 std::string pack_path = path + "/bin";
567 std::string pack_path = path ;
569 XMLNode 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);
575 pack_path = path + "/RelWithDebInfo";
576 PACKPATH = BB.addChild((XMLCSTR)"package_path");
577 PACKPATH.addText((XMLCSTR)pack_path.c_str());
578 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
579 mPackage_paths.push_back(pack_path);
580 pack_path = path + "/Debug";
581 PACKPATH = BB.addChild((XMLCSTR)"package_path");
582 PACKPATH.addText((XMLCSTR)pack_path.c_str());
583 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
584 mPackage_paths.push_back(pack_path);
585 pack_path = path + "/Release";
586 PACKPATH = BB.addChild((XMLCSTR)"package_path");
587 PACKPATH.addText((XMLCSTR)pack_path.c_str());
588 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
589 mPackage_paths.push_back(pack_path);
593 XMLError err = BB.writeToFile((XMLCSTR)Get_config_xml_full_path().c_str());
594 if ( err != eXMLErrorNone )
596 std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
597 bbtkDebugMessage("config",1,mess<< std::endl);
603 //=========================================================================
605 //=========================================================================
606 void ConfigurationFile::GetHelp(int level) const
608 bbtkDebugMessageInc("config",9,"ConfigurationFile::GetHelp("<<level
611 const std::string config_xml_full_path = Get_config_xml_full_path();
612 const std::string description = Get_description();
613 const std::string url = Get_doc_path();
614 const std::string data_path = Get_data_path();
615 const std::string default_temp_dir = Get_default_temp_dir();
616 const std::string file_separator = Get_file_separator();
617 const std::vector<std::string>bbs_paths = Get_bbs_paths();
618 const std::vector<std::string>package_paths = Get_package_paths();
620 bbtkMessage("help",level, "=============" << std::endl);
621 bbtkMessage("help",level, "Configuration" << std::endl);
622 bbtkMessage("help",level, "=============" << std::endl);
623 bbtkMessage("help",level, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl);
624 bbtkMessage("help",level, "Documentation Path : [" << url << "]" << std::endl);
625 bbtkMessage("help",level, "Data Path : [" << data_path << "]" << std::endl);
626 bbtkMessage("help",level, "Temp Directory : [" << default_temp_dir << "]" << std::endl);
627 bbtkMessage("help",level, "File Separator : [" << file_separator << "]" << std::endl);
629 std::vector<std::string>::const_iterator i;
631 bbtkMessage("help",level, "BBS Paths " << std::endl);
632 for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
634 bbtkMessage("help",level,"--- ["<<*i<<"]"<<std::endl);
637 bbtkMessage("help",level, "PACKAGE Paths : " << std::endl);
638 for (i = package_paths.begin(); i!=package_paths.end(); ++i )
640 bbtkMessage("help",level,"--- ["<<*i<<"]"<<std::endl);
643 bbtkDebugDecTab("config",9);
645 //=========================================================================