1 /*=========================================================================
3 Module: $RCSfile: bbtkConfigurationFile.cxx,v $
5 Date: $Date: 2008/11/12 12:47:00 $
6 Version: $Revision: 1.21 $
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
46 #if defined(MACOSX) // assume this is OSX
47 # include <sys/param.h>
48 # include <mach-o/dyld.h> // _NSGetExecutablePath : must add -framework CoreFoundation to link line
51 # define PATH_MAX MAXPATHLEN
55 #ifndef PATH_MAX // If not defined yet : do it
56 # define PATH_MAX 2048
63 //====================================================================
65 ConfigurationFile::ConfigurationFile()
68 mFile_separator = VALID_FILE_SEPARATOR;
70 // ==> Set system paths
71 mBin_path = GetExecutablePath();
72 //EED mInstall_path = mBin_path + mFile_separator + "..";
74 mInstall_path = mBin_path + "/../../../..";
76 mInstall_path = mBin_path + "/..";
78 // The relative path to the doc folder (=BBTK_DOC_REL_PATH)
79 mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH);
80 // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
81 //EED mDoc_path = mInstall_path + mFile_separator + mDoc_rel_path;
82 mDoc_path = mInstall_path + "/" + mDoc_rel_path;
83 // The relative path to the doc folder (=BBTK_BBS_REL_PATH)
84 mBbs_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_BBS_REL_PATH);
85 // The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
86 //EED mBbs_path = mInstall_path + mFile_separator + mBbs_rel_path;
87 mBbs_path = mInstall_path + "/" + mBbs_rel_path;
88 // The relative path to the rsc folder (=BBTK_RSC_REL_PATH)
89 // mRsc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_RSC_REL_PATH);
90 // The path to the rsc folder (=mInstall_path+"/"+mRsc_rel_path)
91 // mRsc_path = mInstall_path + mFile_separator + mRsc_rel_path;
92 // The path to the bbtk data folder
93 // Initialized to mInstall_path+"/"+BBTK_DATA_REL_PATH
94 // But can be overriden by value read from bbtk_config.xml
95 //EED mData_path = mInstall_path + mFile_separator + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
96 mData_path = mInstall_path + "/" + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
98 Utilities::replace( mBin_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
99 Utilities::replace( mInstall_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
100 Utilities::replace( mDoc_rel_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
101 Utilities::replace( mDoc_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
102 Utilities::replace( mBbs_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
103 Utilities::replace( mData_path , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
105 bbtkMessage("Config",1," ==> bin : '"<<mBin_path<<"'"<<std::endl);
106 bbtkMessage("Config",1," ==> prefix : '"<<mInstall_path<<"'"<<std::endl);
107 bbtkMessage("Config",1," ==> doc : '"<<mDoc_path<<"'"<<std::endl);
108 bbtkMessage("Config",1," ==> bbs : '"<<mBbs_path<<"'"<<std::endl);
109 bbtkMessage("Config",1," ==> data : '"<<mData_path<<"'"<<std::endl);
115 // always add "." (current working directory) at the begining
116 mBbs_paths.push_back( "." );
117 // add system bbs path
118 mBbs_paths.push_back(mBbs_path);
119 // add toolsbbtk/appli
120 //EED std::string toolsappli_rel_path(mFile_separator);
121 std::string toolsappli_rel_path("/");
122 //EED toolsappli_rel_path += "toolsbbtk" + mFile_separator + "appli";
123 toolsappli_rel_path += "toolsbbtk/appli";
125 //-----------------------------------------------------------
126 // LG : REMOVE BUGGY PATH WITH include *:
128 // mBbs_paths.push_back(mBbs_path + toolsappli_rel_path);
129 //-----------------------------------------------------------
130 int iStrVec,sizeStrVec;
132 sizeStrVec = mBbs_paths.size();
133 for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
134 Utilities::replace( mBbs_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
138 // always add "." (current working directory) at the begining
139 mPackage_paths.push_back(".");
140 // add system bin path (for build tree / standalone folder install)
141 mPackage_paths.push_back(mBin_path);
142 // add system lib path (for install tree)
143 //EED mPackage_paths.push_back(mInstall_path + mFile_separator + "lib");
144 mPackage_paths.push_back(mInstall_path + "/lib");
146 // add bin/Debug bin/Release paths (for build/install tree)
147 //EED mPackage_paths.push_back(mBin_path + mFile_separator + "Debug");
148 mPackage_paths.push_back(mBin_path + "/Debug");
149 //EED mPackage_paths.push_back(mBin_path + mFile_separator + "Release");
150 mPackage_paths.push_back(mBin_path + "/Release");
153 sizeStrVec = mPackage_paths.size();
154 for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
155 Utilities::replace( mPackage_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
162 // ==> First we look for bbtk_config.xml in "."
164 const char *currentDir = getcwd(buf, 2048);
168 std::cerr << "Path was too long to fit on 2048 bytes ?!?" << std::endl;
169 // \todo : what else?
170 // How abort a constructor and warn the caller function?
171 // LG : throw an exception
174 // std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml";
175 std::string configXmlFullPathName = currentDir ;
176 configXmlFullPathName += "/bbtk_config.xml";
177 Utilities::replace( configXmlFullPathName , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
179 if ( Utilities::FileExists( configXmlFullPathName ))
181 bbtkMessage("Config",1, "ConfigurationFile : [" << configXmlFullPathName <<
182 "] found in current directory" << std::endl);
183 //Read(configXmlFullPathName.c_str());
184 // traiter le fichier local
187 // ==> Then we look for bbtk_config.xml in ".bbtk"
190 configXmlFullPathName = Utilities::MakeUserSettingsFullFileName("bbtk_config.xml");
191 if (!Utilities::FileExists( configXmlFullPathName ))
193 // ==> Nothing found, we create bbtk_config.xml in ".bbtk"
198 // In any case, deal with bbtk_config.xml!
199 Read(configXmlFullPathName.c_str());
201 //=========================================================================
203 //=========================================================================
205 ConfigurationFile::~ConfigurationFile()
208 //=========================================================================
213 //=========================================================================
214 void ConfigurationFile::CreateConfigXML( char *rootDirectory )
218 sprintf (configXml , "%s/bbtk_config.xml", rootDirectory);
219 bbtkDebugMessage("Config",1, "in CreateConfigXML[" << configXml << "]" << std::endl);
220 fp = fopen (configXml, "w");
221 fprintf(fp, "<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n");
222 fprintf(fp, "<config>\n");
223 fprintf(fp, " <bbs_path> </bbs_path>\n");
224 fprintf(fp, " <package_path> </package_path>\n");
225 fprintf(fp, " <default_temp_dir> $ </default_temp_dir>\n");
226 fprintf(fp, "</config>\n");
229 //=========================================================================
233 //=========================================================================
234 // From http://www.fltk.org/newsgroups.php?gfltk.general+v:22083
236 int get_app_path (char *pname, size_t pathsize)
239 /* Oddly, the readlink(2) man page says no NULL is appended. */
240 /* So you have to do it yourself, based on the return value: */
241 pathsize --; /* Preserve a space to add the trailing NULL */
242 long result = readlink("/proc/self/exe", pname, pathsize);
245 pname[result] = 0; /* add the #@!%ing NULL */
247 if ((access(pname, 0) == 0))
248 return 0; /* file exists, return OK */
249 /*else name doesn't seem to exist, return FAIL (falls
255 long result = GetModuleFileName(NULL, pname, pathsize);
258 /* fix up the dir slashes... */
259 int len = strlen(pname);
261 for (idx = 0; idx < len; idx++)
263 if (pname[idx] == '\\') pname[idx] = '/';
265 if ((access(pname, 0) == 0))
266 return 0; /* file exists, return OK */
267 /*else name doesn't seem to exist, return FAIL (falls
273 char *p = getexecname();
276 /* According to the Sun manpages, getexecname will
277 "normally" return an */
278 /* absolute path - BUT might not... AND that IF it is not,
280 /* getcwd() will "usually" be the correct thing... Urgh!
283 /* check pathname is absolute (begins with a / ???) */
284 if (p[0] == '/') /* assume this means we have an
287 strncpy(pname, p, pathsize);
288 if ((access(pname, 0) == 0))
289 return 0; /* file exists, return OK */
291 else /* if not, prepend getcwd() then check if file
294 getcwd(pname, pathsize);
295 long result = strlen(pname);
296 strncat(pname, "/", (pathsize - result));
298 strncat(pname, p, (pathsize - result));
300 if ((access(pname, 0) == 0))
301 return 0; /* file exists, return OK */
302 /*else name doesn't seem to exist, return FAIL
308 #ifdef MACOSX /* assume this is OSX */
310 from http://www.hmug.org/man/3/NSModule.html
312 extern int _NSGetExecutablePath(char *buf, unsigned long
315 _NSGetExecutablePath copies the path of the executable
316 into the buffer and returns 0 if the path was successfully
317 copied in the provided buffer. If the buffer is not large
318 enough, -1 is returned and the expected buffer size is
319 copied in *bufsize. Note that _NSGetExecutablePath will
320 return "a path" to the executable not a "real path" to the
321 executable. That is the path may be a symbolic link and
322 not the real file. And with deep directories the total
323 bufsize needed could be more than MAXPATHLEN.
326 char *given_path = (char*)malloc(MAXPATHLEN * 2);
327 if (!given_path) return status;
329 uint32_t npathsize = MAXPATHLEN * 2;
330 long result = _NSGetExecutablePath(given_path, &npathsize);
332 { /* OK, we got something - now try and resolve the real path...
334 if (realpath(given_path, pname) != NULL)
336 if ((access(pname, 0) == 0))
337 status = 0; /* file exists, return OK */
344 return -1; /* Path Lookup Failed */
349 //=========================================================================
350 std::string ConfigurationFile::GetExecutablePath()
353 int err = get_app_path(name, PATH_MAX);
356 bbtkError("Could not determine current executable path ?");
359 // remove the exe name
361 slash = strrchr(name, VALID_FILE_SEPARATOR_CHAR);
370 /// \todo : Think to delete it!
371 char *buf = (char *)malloc(512);
374 bbtkError("Could not allocate 512 bytes !");
379 GetModuleFileName(NULL, buf, 511);
380 slash = strrchr(buf, '\\');
388 #if defined(__GNUC__)
390 res = readlink("/proc/self/exe", buf, 512);
397 slash = strrchr(buf, '/');
403 std::string ret(buf);
407 //=========================================================================
410 //=========================================================================
411 void ConfigurationFile::InstallPath ()
414 /*--------------------------------------------------
415 New policy for bbtk_config.xml :
417 if bbtk_config.xml found in current directory (user is an aware user!)
420 else if bbtk_config.xml found in HOME/.bbtk (user already worked with it)
423 else if bbtk_config.xml.tmp found in /usr/local/bin or c:\\Program Files\\BBTK\\bin
424 copy it as .bbtk/bbtk_config.xml
426 else (nothing installed)
427 create a minimum version in HOME/.bbtk
428 ----------------------------------------------------*/
431 // -----------------------------------------------------------------
432 #if defined(__GNUC__)
434 // ------------------ create some usefull strings ----------------
435 // installed bbtk_path
437 strcpy(bbtk_path, "/usr/local/bin");
440 char rootDirectory[200];
441 sprintf( rootDirectory, "%s/.bbtk", getenv("HOME"));
444 char configPath[200];
445 sprintf(configPath, "%s/bbtk_config.xml",rootDirectory);
449 sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
452 char configXmlTmp[250];
453 sprintf(configXmlTmp, "%s/bbtk_config.xml.tmp", bbtk_path);
458 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found (not installed)
460 if (!Utilities::FileExists(rootDirectory)) // .bbtk not found
462 system(makeDir); // create .bbtk
465 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
466 CreateConfigXML( rootDirectory );// create .bbtk
470 sprintf(copyFile,"cp %s %s/bbtk_config.xml ",configXmlTmp,rootDirectory );
471 if (!Utilities::FileExists(rootDirectory))
473 //std::cout << "makeDir[" << makeDir << "]" << std::endl;
477 if (!Utilities::FileExists(configPath))
484 // ------------------------------------------------------------------
488 // installed bbtk_path
490 strcpy(bbtk_path, "\"c:\\Program Files\\BBTK\\bin\"");
491 char bbtk_path2[100];
492 strcpy(bbtk_path2, "c:\\Program Files\\BBTK\\bin");
495 char rootDirectory[200];
496 sprintf(rootDirectory, "%s\\.bbtk",getenv("USERPROFILE"));
497 // std::cout << "[" << rootDirectory << "]" << std::endl;
500 char configPath[200];
501 sprintf(configPath, "%s\\bbtk_config.xml",rootDirectory);
505 sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
508 char configXmlTmp[250];
509 sprintf(configXmlTmp, "%s\\bbtk_config.xml.tmp", bbtk_path2);
514 if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found
516 if (!Utilities::FileExists(rootDirectory)) // .bbtk not found
518 system(makeDir); // create .bbtk
521 // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
522 CreateConfigXML( rootDirectory );// create .bbtk
526 sprintf(copyFile,"copy %s\\bbtk_config.xml.tmp \"%s\"\\bbtk_config.xml ",bbtk_path,rootDirectory );
528 int attribs = GetFileAttributes (rootDirectory);
529 bbtkMessage("Config",1,std::hex << attribs << " " << FILE_ATTRIBUTE_DIRECTORY << std::endl);
530 if ( attribs != 0xFFFFFFFF)
532 if ((attribs & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY ) /// \TODO : check !
534 if ( GetFileAttributes( configPath ) == 0xFFFFFFFF)
546 // ------------------------------------------------------------------
548 /// \todo ConfigurationFile::InstallPath() : exit when for not WIN32 and not__GNUC__
554 //=========================================================================
558 //=========================================================================
559 // Gets the list of directories holding bb scripts, packages, dll, ... from the xml file
562 void ConfigurationFile::Read(const std::string& filename)
565 bbtkDebugMessage("Config",1,"ConfigurationFile::Read(" <<filename << ")" << std::endl);
567 mConfig_xml_full_path = filename;
568 XMLResults* res = new XMLResults;
569 XMLNode BB = XMLNode::parseFile((XMLCSTR)filename.c_str(),(XMLCSTR)"config",res);
571 if ( res->error != eXMLErrorNone )
573 std::string mess = GetErrorMessage(res,filename);
575 bbtkDebugMessage("Config",1,mess<< std::endl);
580 bbtkDebugMessage("Config",1,"OK" << std::endl);
585 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"description"); i++)
588 GetTextOrClear(BB.getChildNode((XMLCSTR)"description",&j),val);
593 if( BB.nChildNode((XMLCSTR)"url") )
594 GetTextOrClear(BB.getChildNode((XMLCSTR)"url"),mUrl);
597 if( BB.nChildNode((XMLCSTR)"data_path") )
598 GetTextOrClear(BB.getChildNode((XMLCSTR)"data_path"),mData_path);
601 // if( BB.nChildNode((XMLCSTR)"install_path") )
602 // GetTextOrClear(BB.getChildNode((XMLCSTR)"install_path"),mInstall_path);
604 // add user bbs paths
605 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"bbs_path"); i++)
608 GetTextOrClear(BB.getChildNode((XMLCSTR)"bbs_path",&j),val);
609 mBbs_paths.push_back(val);
614 // add user package path
615 for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"package_path"); i++)
618 GetTextOrClear(BB.getChildNode((XMLCSTR)"package_path",&j),val);
619 mPackage_paths.push_back(val);
623 if( BB.nChildNode((XMLCSTR)"default_temp_dir") )
624 GetTextOrClear(BB.getChildNode((XMLCSTR)"default_temp_dir"),mDefault_temp_dir);
626 if ( mDefault_temp_dir == "$") // no value found in config_xml
628 size_t pos = mConfig_xml_full_path.find("bbtk_config.xml");
629 mDefault_temp_dir = mConfig_xml_full_path.substr (0,pos);
634 //=========================================================================
636 //=========================================================================
637 bool ConfigurationFile::AddPackagePathsAndWrite( const std::string& path )
639 bbtkDebugMessageInc("Config",9,
640 "ConfigurationFile::AddPackagePathsAndWrite("
641 <<path<<")"<<std::endl);
643 XMLResults* res = new XMLResults;
645 XMLNode::parseFile((XMLCSTR)Get_config_xml_full_path().c_str(),
646 (XMLCSTR)"config",res);
648 if ( res->error != eXMLErrorNone )
650 std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
652 bbtkDebugMessage("Config",1,mess<< std::endl);
658 std::string bbs_path = path + "/bbs";
660 std::string bbs_path = path + "/share/bbtk/bbs" ;
662 XMLNode BBSPATH = BB.addChild((XMLCSTR)"bbs_path");
663 BBSPATH.addText((XMLCSTR)bbs_path.c_str());
664 Utilities::replace(bbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR);
665 mBbs_paths.push_back(bbs_path);
668 std::string pack_path = path + "/bin";
670 std::string pack_path = path ;
672 XMLNode PACKPATH = BB.addChild((XMLCSTR)"package_path");
673 PACKPATH.addText((XMLCSTR)pack_path.c_str());
674 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
675 mPackage_paths.push_back(pack_path);
678 pack_path = path + "/Debug";
679 PACKPATH = BB.addChild((XMLCSTR)"package_path");
680 PACKPATH.addText((XMLCSTR)pack_path.c_str());
681 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
682 mPackage_paths.push_back(pack_path);
683 pack_path = path + "/Release";
684 PACKPATH = BB.addChild((XMLCSTR)"package_path");
685 PACKPATH.addText((XMLCSTR)pack_path.c_str());
686 Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
687 mPackage_paths.push_back(pack_path);
691 XMLError err = BB.writeToFile((XMLCSTR)Get_config_xml_full_path().c_str());
692 if ( err != eXMLErrorNone )
694 std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
695 bbtkDebugMessage("Config",1,mess<< std::endl);
701 //=========================================================================
703 //=========================================================================
704 void ConfigurationFile::GetHelp(int level) const
706 bbtkDebugMessageInc("Config",9,"ConfigurationFile::GetHelp("<<level
709 const std::string config_xml_full_path = Get_config_xml_full_path();
710 const std::string description = Get_description();
711 const std::string url = Get_doc_path();
712 const std::string data_path = Get_data_path();
713 const std::string default_temp_dir = Get_default_temp_dir();
714 const std::string file_separator = Get_file_separator();
715 const std::vector<std::string>bbs_paths = Get_bbs_paths();
716 const std::vector<std::string>package_paths = Get_package_paths();
718 bbtkMessage("Help",level, "=============" << std::endl);
719 bbtkMessage("Help",level, "Configuration" << std::endl);
720 bbtkMessage("Help",level, "=============" << std::endl);
721 bbtkMessage("Help",level, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl);
722 bbtkMessage("Help",level, "Documentation Path : [" << url << "]" << std::endl);
723 bbtkMessage("Help",level, "Data Path : [" << data_path << "]" << std::endl);
724 bbtkMessage("Help",level, "Temp Directory : [" << default_temp_dir << "]" << std::endl);
725 bbtkMessage("Help",level, "File Separator : [" << file_separator << "]" << std::endl);
727 std::vector<std::string>::const_iterator i;
729 bbtkMessage("Help",level, "BBS Paths " << std::endl);
730 for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
732 bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
735 bbtkMessage("Help",level, "PACKAGE Paths : " << std::endl);
736 for (i = package_paths.begin(); i!=package_paths.end(); ++i )
738 bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
741 bbtkDebugDecTab("Config",9);
743 //=========================================================================