1 /*=========================================================================
4 Module: $RCSfile: bbtkConfigurationFile.cxx,v $
6 Date: $Date: 2008/09/10 07:25:23 $
7 Version: $Revision: 1.15 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See doc/license.txt or
11 http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
20 *\brief Class bbtk::ConfigurationFile
23 #include "bbtkConfigurationFile.h"
24 #include "bbtkMessageManager.h"
26 #include "bbtkUtilities.h"
29 #include <direct.h> // for getcwd
37 //====================================================================
39 ConfigurationFile::ConfigurationFile()
42 mFile_separator = VALID_FILE_SEPARATOR;
44 // ==> Set system paths
45 mBin_path = GetExecutablePath();
46 //EED mInstall_path = mBin_path + mFile_separator + "..";
47 mInstall_path = mBin_path + "/..";
48 // The relative path to the doc folder (=BBTK_DOC_REL_PATH)
49 mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH);
50 // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
51 //EED mDoc_path = mInstall_path + mFile_separator + mDoc_rel_path;
52 mDoc_path = mInstall_path + "/" + mDoc_rel_path;
53 // The relative path to the doc folder (=BBTK_BBS_REL_PATH)
54 mBbs_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_BBS_REL_PATH);
55 // The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
56 //EED mBbs_path = mInstall_path + mFile_separator + mBbs_rel_path;
57 mBbs_path = mInstall_path + "/" + mBbs_rel_path;
58 // The relative path to the rsc folder (=BBTK_RSC_REL_PATH)
59 // mRsc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_RSC_REL_PATH);
60 // The path to the rsc folder (=mInstall_path+"/"+mRsc_rel_path)
61 // mRsc_path = mInstall_path + mFile_separator + mRsc_rel_path;
62 // The path to the bbtk data folder
63 // Initialized to mInstall_path+"/"+BBTK_DATA_REL_PATH
64 // But can be overriden by value read from bbtk_config.xml
65 //EED mData_path = mInstall_path + mFile_separator + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
66 mData_path = mInstall_path + "/" + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
68 Utilities::replace( mBin_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
69 Utilities::replace( mInstall_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
70 Utilities::replace( mDoc_rel_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
71 Utilities::replace( mDoc_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
72 Utilities::replace( mBbs_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
73 Utilities::replace( mData_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
75 bbtkMessage("Config",1," ==> bin : '"<<mBin_path<<"'"<<std::endl);
76 bbtkMessage("Config",1," ==> prefix : '"<<mInstall_path<<"'"<<std::endl);
77 bbtkMessage("Config",1," ==> doc : '"<<mDoc_path<<"'"<<std::endl);
78 bbtkMessage("Config",1," ==> bbs : '"<<mBbs_path<<"'"<<std::endl);
79 bbtkMessage("Config",1," ==> data : '"<<mData_path<<"'"<<std::endl);
85 // always add "." (current working directory) at the begining
86 mBbs_paths.push_back( "." );
87 // add system bbs path
88 mBbs_paths.push_back(mBbs_path);
89 // add toolsbbtk/appli
90 //EED std::string toolsappli_rel_path(mFile_separator);
91 std::string toolsappli_rel_path("/");
92 //EED toolsappli_rel_path += "toolsbbtk" + mFile_separator + "appli";
93 toolsappli_rel_path += "toolsbbtk/appli";
95 //-----------------------------------------------------------
96 // LG : REMOVE BUGGY PATH WITH include *:
98 // mBbs_paths.push_back(mBbs_path + toolsappli_rel_path);
99 //-----------------------------------------------------------
100 int iStrVec,sizeStrVec;
102 sizeStrVec = mBbs_paths.size();
103 for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
104 Utilities::replace( mBbs_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
108 // always add "." (current working directory) at the begining
109 mPackage_paths.push_back(".");
110 // add system bin path (for build tree / standalone folder install)
111 mPackage_paths.push_back(mBin_path);
112 // add system lib path (for install tree)
113 //EED mPackage_paths.push_back(mInstall_path + mFile_separator + "lib");
114 mPackage_paths.push_back(mInstall_path + "/lib");
116 // add bin/Debug bin/Release paths (for build/install tree)
117 //EED mPackage_paths.push_back(mBin_path + mFile_separator + "Debug");
118 mPackage_paths.push_back(mBin_path + "/Debug");
119 //EED mPackage_paths.push_back(mBin_path + mFile_separator + "Release");
120 mPackage_paths.push_back(mBin_path + "/Release");
123 sizeStrVec = mPackage_paths.size();
124 for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
125 Utilities::replace( mPackage_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
132 // ==> First we look for bbtk_config.xml in "."
134 const char *currentDir = getcwd(buf, 2048);
138 std::cerr << "Path was too long to fit on 2048 bytes ?!?" << std::endl;
139 // \todo : what else?
140 // How abort a constructor and warn the caller function?
141 // LG : throw an exception
144 // std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml";
145 std::string configXmlFullPathName = currentDir ;
146 configXmlFullPathName += "/bbtk_config.xml";
147 Utilities::replace( configXmlFullPathName , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
149 if ( Utilities::FileExists( configXmlFullPathName ))
151 bbtkMessage("Config",1, "ConfigurationFile : [" << configXmlFullPathName <<
152 "] found in current directory" << std::endl);
153 //Read(configXmlFullPathName.c_str());
154 // traiter le fichier local
157 // ==> Then we look for bbtk_config.xml in ".bbtk"
160 configXmlFullPathName = Utilities::MakeUserSettingsFullFileName("bbtk_config.xml");
161 if (!Utilities::FileExists( configXmlFullPathName ))
163 // ==> Nothing found, we create bbtk_config.xml in ".bbtk"
168 // In any case, deal with bbtk_config.xml!
169 Read(configXmlFullPathName.c_str());
171 //=========================================================================
173 //=========================================================================
175 ConfigurationFile::~ConfigurationFile()
178 //=========================================================================
183 //=========================================================================
184 void ConfigurationFile::CreateConfigXML( char *rootDirectory )
188 sprintf (configXml , "%s/bbtk_config.xml", rootDirectory);
189 bbtkMessage("Config",1, "in CreateConfigXML[" << configXml << "]" << std::endl);
190 fp = fopen (configXml, "w");
191 fprintf(fp, "<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n");
192 // fprintf(fp, "<!DOCTYPE config SYSTEM \"/mnt/windows/bbtk/bbtk_config.xml>\n");
193 fprintf(fp, "<config>\n");
194 fprintf(fp, " <description> </description>\n");
195 // fprintf(fp, " <url> http://www.creatis.insa-lyon.fr/software/bbtk </url>\n");
196 // fprintf(fp, " <install_path> </install_path>\n");
197 fprintf(fp, " <bbs_path> </bbs_path>\n");
198 // fprintf(fp, " <ext_dll_path> </ext_dll_path>\n");
199 fprintf(fp, " <package_path> </package_path>\n");
200 fprintf(fp, " <data_path> </data_path>\n");//, BBTK_DATA_PATH);
201 /// \todo find a decent default value !
202 ///fprintf(fp, " <default_temp_dir> %s </default_temp_dir>\n", " ");
203 // when $ will be found, default_temp_dir value will be replaced
204 fprintf(fp, " <default_temp_dir>$</default_temp_dir>\n");
205 fprintf(fp, "</config>\n");
208 //=========================================================================
211 //=========================================================================
212 std::string ConfigurationFile::GetExecutablePath()
214 /// \todo : Think to delete it!
215 char *buf = (char *)malloc(512);
219 GetModuleFileName(NULL, buf, 511);
220 slash = strrchr(buf, '\\');
225 #elif defined(__GNUC__)
227 res = readlink("/proc/self/exe", buf, 512);
231 slash = strrchr(buf, '/');
239 std::string ret(buf);
243 //=========================================================================
246 //=========================================================================
247 void ConfigurationFile::InstallPath ()
250 /*--------------------------------------------------
251 New policy for bbtk_config.xml :
253 if bbtk_config.xml found in current directory (user is an aware user!)
256 else if bbtk_config.xml found in HOME/.bbtk (user already worked with it)
259 else if bbtk_config.xml.tmp found in /usr/local/bin or c:\\Program Files\\BBTK\\bin
260 copy it as .bbtk/bbtk_config.xml
262 else (nothing installed)
263 create a minimum version in HOME/.bbtk
264 ----------------------------------------------------*/
267 // -----------------------------------------------------------------
268 #if defined(__GNUC__)
270 // ------------------ create some usefull strings ----------------
271 // installed bbtk_path
273 strcpy(bbtk_path, "/usr/local/bin");
276 char rootDirectory[200];
277 sprintf( rootDirectory, "%s/.bbtk", getenv("HOME"));
280 char configPath[200];
281 sprintf(configPath, "%s/bbtk_config.xml",rootDirectory);
285 sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
288 char configXmlTmp[250];
289 sprintf(configXmlTmp, "%s/bbtk_config.xml.tmp", bbtk_path);
294 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found (not installed)
296 if (!Utilities::FileExists(rootDirectory)) // .bbtk not found
298 system(makeDir); // create .bbtk
301 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
302 CreateConfigXML( rootDirectory );// create .bbtk
306 sprintf(copyFile,"cp %s %s/bbtk_config.xml ",configXmlTmp,rootDirectory );
307 if (!Utilities::FileExists(rootDirectory))
309 //std::cout << "makeDir[" << makeDir << "]" << std::endl;
313 if (!Utilities::FileExists(configPath))
320 // ------------------------------------------------------------------
324 // installed bbtk_path
326 strcpy(bbtk_path, "\"c:\\Program Files\\BBTK\\bin\"");
327 char bbtk_path2[100];
328 strcpy(bbtk_path2, "c:\\Program Files\\BBTK\\bin");
331 char rootDirectory[200];
332 sprintf(rootDirectory, "%s\\.bbtk",getenv("USERPROFILE"));
333 // std::cout << "[" << rootDirectory << "]" << std::endl;
336 char configPath[200];
337 sprintf(configPath, "%s\\bbtk_config.xml",rootDirectory);
341 sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
344 char configXmlTmp[250];
345 sprintf(configXmlTmp, "%s\\bbtk_config.xml.tmp", bbtk_path2);
350 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found
352 if (!Utilities::FileExists(rootDirectory)) // .bbtk not found
354 system(makeDir); // create .bbtk
357 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
358 CreateConfigXML( rootDirectory );// create .bbtk
362 sprintf(copyFile,"copy %s\\bbtk_config.xml.tmp \"%s\"\\bbtk_config.xml ",bbtk_path,rootDirectory );
364 int attribs = GetFileAttributes (rootDirectory);
365 bbtkMessage("Config",1,std::hex << attribs << " " << FILE_ATTRIBUTE_DIRECTORY << std::endl);
366 if ( attribs != 0xFFFFFFFF)
368 if ((attribs & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY ) /// \TODO : check !
370 if ( GetFileAttributes( configPath ) == 0xFFFFFFFF)
382 // ------------------------------------------------------------------
384 /// \todo ConfigurationFile::InstallPath() : exit when for not WIN32 and not__GNUC__
390 //=========================================================================
394 //=========================================================================
395 // Gets the list of directories holding bb scripts, packages, dll, ... from the xml file
398 void ConfigurationFile::Read(const std::string& filename)
401 bbtkDebugMessage("Config",1,"ConfigurationFile::Read(" <<filename << ")" << std::endl);
403 mConfig_xml_full_path = filename;
404 XMLResults* res = new XMLResults;
405 XMLNode BB = XMLNode::parseFile((XMLCSTR)filename.c_str(),(XMLCSTR)"config",res);
407 if ( res->error != eXMLErrorNone )
409 std::string mess = GetErrorMessage(res,filename);
411 bbtkDebugMessage("Config",1,mess<< std::endl);
416 bbtkDebugMessage("Config",1,"OK" << std::endl);
421 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"description"); i++)
424 GetTextOrClear(BB.getChildNode((XMLCSTR)"description",&j),val);
429 if( BB.nChildNode((XMLCSTR)"url") )
430 GetTextOrClear(BB.getChildNode((XMLCSTR)"url"),mUrl);
433 if( BB.nChildNode((XMLCSTR)"data_path") )
434 GetTextOrClear(BB.getChildNode((XMLCSTR)"data_path"),mData_path);
437 // if( BB.nChildNode((XMLCSTR)"install_path") )
438 // GetTextOrClear(BB.getChildNode((XMLCSTR)"install_path"),mInstall_path);
440 // add user bbs paths
441 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"bbs_path"); i++)
444 GetTextOrClear(BB.getChildNode((XMLCSTR)"bbs_path",&j),val);
445 mBbs_paths.push_back(val);
450 // add user package path
451 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"package_path"); i++)
454 GetTextOrClear(BB.getChildNode((XMLCSTR)"package_path",&j),val);
455 mPackage_paths.push_back(val);
459 if( BB.nChildNode((XMLCSTR)"default_temp_dir") )
460 GetTextOrClear(BB.getChildNode((XMLCSTR)"default_temp_dir"),mDefault_temp_dir);
462 if ( mDefault_temp_dir == "$") // no value found in config_xml
464 size_t pos = mConfig_xml_full_path.find("bbtk_config.xml");
465 mDefault_temp_dir = mConfig_xml_full_path.substr (0,pos);
470 //=========================================================================
473 //=========================================================================
474 void ConfigurationFile::GetHelp(int level) const
476 bbtkDebugMessageInc("Config",9,"ConfigurationFile::GetHelp("<<level
479 const std::string config_xml_full_path = Get_config_xml_full_path();
480 const std::string description = Get_description();
481 const std::string url = Get_doc_path();
482 const std::string data_path = Get_data_path();
483 const std::string default_temp_dir = Get_default_temp_dir();
484 const std::string file_separator = Get_file_separator();
485 const std::vector<std::string>bbs_paths = Get_bbs_paths();
486 const std::vector<std::string>package_paths = Get_package_paths();
488 bbtkMessage("Help",level, "=============" << std::endl);
489 bbtkMessage("Help",level, "Configuration" << std::endl);
490 bbtkMessage("Help",level, "=============" << std::endl);
491 bbtkMessage("Help",level, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl);
492 bbtkMessage("Help",level, "Documentation Path : [" << url << "]" << std::endl);
493 bbtkMessage("Help",level, "Data Path : [" << data_path << "]" << std::endl);
494 bbtkMessage("Help",level, "Temp Directory : [" << default_temp_dir << "]" << std::endl);
495 bbtkMessage("Help",level, "File Separator : [" << file_separator << "]" << std::endl);
497 std::vector<std::string>::const_iterator i;
499 bbtkMessage("Help",level, "BBS Paths " << std::endl);
500 for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
502 bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
505 bbtkMessage("Help",level, "PACKAGE Paths : " << std::endl);
506 for (i = package_paths.begin(); i!=package_paths.end(); ++i )
508 bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
511 bbtkDebugDecTab("Config",9);
513 //=========================================================================