]> Creatis software - bbtk.git/blob - kernel/src/bbtkConfigurationFile.cxx
*** empty log message ***
[bbtk.git] / kernel / src / bbtkConfigurationFile.cxx
1 /*=========================================================================                                                                               
2   Program:   bbtk
3   Module:    $RCSfile: bbtkConfigurationFile.cxx,v $
4   Language:  C++
5   Date:      $Date: 2008/10/21 08:37:04 $
6   Version:   $Revision: 1.19 $
7 =========================================================================*/
8
9 /* ---------------------------------------------------------------------
10
11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
13 *
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.
20 *
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
25 *  liability. 
26 *
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 * ------------------------------------------------------------------------ */                                                                         
30
31 /**
32  *\file
33  *\brief Class bbtk::ConfigurationFile
34  */
35
36 #include "bbtkConfigurationFile.h"
37 #include "bbtkMessageManager.h"
38 #include "bbtkXML.h"
39 #include "bbtkUtilities.h"
40
41 #if defined(WIN32)
42 #include <direct.h> // for getcwd
43 #endif
44
45
46
47 namespace bbtk
48 {
49
50   //====================================================================
51   /// Constructor
52   ConfigurationFile::ConfigurationFile()
53   {
54
55         mFile_separator = VALID_FILE_SEPARATOR;
56     
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);
80
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);
87
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);
93
94
95
96     
97     // bbs_paths
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";
107     //
108     //-----------------------------------------------------------
109     // LG : REMOVE BUGGY PATH WITH include *:
110     // 
111     //    mBbs_paths.push_back(mBbs_path + toolsappli_rel_path);
112     //-----------------------------------------------------------
113     int iStrVec,sizeStrVec;
114     
115     sizeStrVec = mBbs_paths.size();
116     for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
117       Utilities::replace( mBbs_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
118     }
119
120     
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");
128 #ifdef WIN32
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");
134 #endif
135
136         sizeStrVec = mPackage_paths.size();
137         for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
138                 Utilities::replace( mPackage_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
139         }
140
141
142
143     GetHelp(2);
144    
145     // ==> First we look for bbtk_config.xml in "."
146     char buf[2048];
147     const char *currentDir = getcwd(buf, 2048);
148     
149     if( !currentDir )
150       {
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 
155       }
156     
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);
161
162     if ( Utilities::FileExists( configXmlFullPathName ))
163       {
164         bbtkMessage("Config",1, "ConfigurationFile : [" << configXmlFullPathName << 
165                     "] found in current directory" << std::endl); 
166         //Read(configXmlFullPathName.c_str());
167         // traiter le fichier local     
168       }
169     
170     // ==> Then we look for bbtk_config.xml in ".bbtk"
171     else 
172       {
173         configXmlFullPathName = Utilities::MakeUserSettingsFullFileName("bbtk_config.xml");
174         if (!Utilities::FileExists( configXmlFullPathName ))
175           {         
176             // ==> Nothing found, we create bbtk_config.xml in ".bbtk"
177             InstallPath ();
178           }
179       }
180     
181     // In any case, deal with bbtk_config.xml!
182     Read(configXmlFullPathName.c_str());
183   }
184   //=========================================================================
185
186   //=========================================================================
187   /// Destructor
188   ConfigurationFile::~ConfigurationFile()
189   {
190   }
191   //=========================================================================
192   
193
194
195
196   //=========================================================================
197   void ConfigurationFile::CreateConfigXML( char *rootDirectory )
198   {
199     FILE *fp;
200     char configXml[250];
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, "</config>\n");
209     fclose(fp);
210   }
211   //=========================================================================  
212
213
214   //=========================================================================
215   std::string ConfigurationFile::GetExecutablePath()
216   {
217     /// \todo : Think to delete it!
218     char *buf = (char *)malloc(512);
219     char *slash;
220     
221 #if defined(WIN32)
222     GetModuleFileName(NULL, buf, 511);
223     slash = strrchr(buf, '\\');
224     if (slash)
225       {
226         *slash = 0;
227       }
228 #elif defined(__GNUC__)
229     int res;
230     res = readlink("/proc/self/exe", buf, 512);
231     if (res == -1)
232       return "";
233     buf[res] = 0;
234     slash = strrchr(buf, '/');
235     if (slash)
236       {
237         *slash = 0;
238       }
239 #else
240     return "";
241 #endif
242     std::string ret(buf);
243     free(buf);
244     return ret;
245   }
246   //=========================================================================
247
248
249   //=========================================================================
250   void ConfigurationFile::InstallPath ()
251   {
252     
253     /*--------------------------------------------------
254       New policy for bbtk_config.xml :
255       
256       if bbtk_config.xml found in current directory (user is an aware user!)
257       use it!
258       
259       else if bbtk_config.xml found in HOME/.bbtk (user already worked with it)
260       use it!
261       
262       else if bbtk_config.xml.tmp found in /usr/local/bin or c:\\Program Files\\BBTK\\bin
263       copy it as .bbtk/bbtk_config.xml
264       
265       else (nothing installed)
266       create a minimum version in HOME/.bbtk
267       ----------------------------------------------------*/
268     
269     
270     // -----------------------------------------------------------------
271 #if defined(__GNUC__)
272     
273     // ------------------ create some usefull strings ----------------
274     // installed bbtk_path
275     char bbtk_path[100];
276     strcpy(bbtk_path, "/usr/local/bin");
277     
278     // rootDirectory
279     char rootDirectory[200];
280     sprintf( rootDirectory,  "%s/.bbtk", getenv("HOME"));
281     
282     // configPath
283     char configPath[200];
284     sprintf(configPath, "%s/bbtk_config.xml",rootDirectory);
285     
286     // makeDir
287     char makeDir[250];
288     sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
289     
290     // configXmlTmp
291     char configXmlTmp[250]; 
292     sprintf(configXmlTmp, "%s/bbtk_config.xml.tmp", bbtk_path);
293     
294     // copyFile
295     char copyFile[250];
296     
297     if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found (not installed)
298       {  
299         if (!Utilities::FileExists(rootDirectory)) // .bbtk not found
300           {
301             system(makeDir);  // create .bbtk
302           }
303         
304         // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
305         CreateConfigXML( rootDirectory );// create .bbtk
306       }
307     else
308       {
309         sprintf(copyFile,"cp %s  %s/bbtk_config.xml ",configXmlTmp,rootDirectory );
310         if (!Utilities::FileExists(rootDirectory))
311           {
312             //std::cout << "makeDir[" << makeDir << "]" << std::endl;
313             system(makeDir);
314           }
315         
316         if (!Utilities::FileExists(configPath))
317           {
318             system(copyFile);
319           }
320       }
321     return;
322     
323     // ------------------------------------------------------------------
324 #elif defined(WIN32)
325     
326     
327     // installed bbtk_path
328     char bbtk_path[100];
329     strcpy(bbtk_path, "\"c:\\Program Files\\BBTK\\bin\"");
330     char bbtk_path2[100];
331     strcpy(bbtk_path2, "c:\\Program Files\\BBTK\\bin");
332     
333     // rootDirectory
334     char rootDirectory[200];  
335     sprintf(rootDirectory, "%s\\.bbtk",getenv("USERPROFILE"));
336     //  std::cout << "[" << rootDirectory << "]" << std::endl;
337     
338     // configPath
339     char configPath[200];
340     sprintf(configPath, "%s\\bbtk_config.xml",rootDirectory);
341     
342     // makeDir
343     char makeDir[250];
344     sprintf( makeDir, "mkdir \"%s\" ", rootDirectory);
345     
346     // configXmlTmp
347     char configXmlTmp[250]; 
348     sprintf(configXmlTmp, "%s\\bbtk_config.xml.tmp", bbtk_path2);
349     
350     // copyFile
351     char copyFile[250];
352     
353     if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found
354       {
355         if (!Utilities::FileExists(rootDirectory)) // .bbtk not found
356           {
357             system(makeDir);  // create .bbtk
358           }
359         
360         // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk
361         CreateConfigXML( rootDirectory );// create .bbtk
362         return;
363       }  
364     
365     sprintf(copyFile,"copy %s\\bbtk_config.xml.tmp \"%s\"\\bbtk_config.xml ",bbtk_path,rootDirectory );
366     
367     int attribs = GetFileAttributes (rootDirectory);
368     bbtkMessage("Config",1,std::hex << attribs << " " << FILE_ATTRIBUTE_DIRECTORY << std::endl);
369     if ( attribs != 0xFFFFFFFF)
370       {
371         if ((attribs & FILE_ATTRIBUTE_DIRECTORY) == FILE_ATTRIBUTE_DIRECTORY ) /// \TODO : check !
372           {
373             if ( GetFileAttributes( configPath ) == 0xFFFFFFFF)
374               {
375                 system(copyFile);  
376               } 
377           }
378       } 
379     else 
380       {
381         system(makeDir);
382         system(copyFile); 
383       }    
384     return;  
385     // ------------------------------------------------------------------    
386 #else
387 /// \todo  ConfigurationFile::InstallPath() : exit when for not WIN32 and not__GNUC__
388
389   return;    
390 #endif
391
392 }
393   //=========================================================================
394
395
396
397   //=========================================================================
398   // Gets the list of directories holding bb scripts, packages, dll, ... from the xml file
399   //      bbtk_config.xml
400   
401   void ConfigurationFile::Read(const std::string& filename)
402   {
403     
404     bbtkDebugMessage("Config",1,"ConfigurationFile::Read(" <<filename << ")" << std::endl);
405     
406     mConfig_xml_full_path = filename;
407     XMLResults* res = new XMLResults;
408     XMLNode BB = XMLNode::parseFile((XMLCSTR)filename.c_str(),(XMLCSTR)"config",res);
409     
410     if ( res->error != eXMLErrorNone ) 
411       {
412         std::string mess = GetErrorMessage(res,filename);
413         delete res;
414         bbtkDebugMessage("Config",1,mess<< std::endl);
415         bbtkError(mess);
416       }
417     delete res;
418     
419     bbtkDebugMessage("Config",1,"OK" << std::endl);
420   
421     int i,j;
422     
423     // Description
424     for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"description"); i++) 
425       {
426         std::string val;
427         GetTextOrClear(BB.getChildNode((XMLCSTR)"description",&j),val);
428         mDescription += val;
429       }    
430     
431     // Url
432     if( BB.nChildNode((XMLCSTR)"url") ) 
433       GetTextOrClear(BB.getChildNode((XMLCSTR)"url"),mUrl);
434     
435     // Data_Path
436     if( BB.nChildNode((XMLCSTR)"data_path") ) 
437       GetTextOrClear(BB.getChildNode((XMLCSTR)"data_path"),mData_path);
438     
439     // install_path
440     //  if( BB.nChildNode((XMLCSTR)"install_path") )
441     //   GetTextOrClear(BB.getChildNode((XMLCSTR)"install_path"),mInstall_path);
442     
443     // add user bbs paths
444     for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"bbs_path"); i++) 
445       {
446         std::string val;
447         GetTextOrClear(BB.getChildNode((XMLCSTR)"bbs_path",&j),val);
448         mBbs_paths.push_back(val);
449       }
450     
451     // package_paths
452     
453     // add user package path
454     for (i=0,j=0; i<BB.nChildNode((XMLCSTR)"package_path"); i++) 
455       {
456         std::string val;
457         GetTextOrClear(BB.getChildNode((XMLCSTR)"package_path",&j),val);
458         mPackage_paths.push_back(val);
459       }
460     
461     // default_temp_dir
462     if( BB.nChildNode((XMLCSTR)"default_temp_dir") ) 
463       GetTextOrClear(BB.getChildNode((XMLCSTR)"default_temp_dir"),mDefault_temp_dir);
464     
465     if ( mDefault_temp_dir == "$") // no value found in config_xml
466       {
467         size_t pos = mConfig_xml_full_path.find("bbtk_config.xml");
468         mDefault_temp_dir = mConfig_xml_full_path.substr (0,pos); 
469       }    
470
471     GetHelp(2);
472   }
473   //=========================================================================
474   
475   //=========================================================================
476   bool ConfigurationFile::AddPackagePathsAndWrite( const std::string& path )
477   {
478     bbtkDebugMessageInc("Config",9,
479                         "ConfigurationFile::AddPackagePathsAndWrite("
480                         <<path<<")"<<std::endl);
481     
482      XMLResults* res = new XMLResults;
483     XMLNode BB = 
484       XMLNode::parseFile((XMLCSTR)Get_config_xml_full_path().c_str(),
485                          (XMLCSTR)"config",res);
486     
487     if ( res->error != eXMLErrorNone ) 
488       {
489         std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
490         delete res;
491         bbtkDebugMessage("Config",1,mess<< std::endl);
492         bbtkError(mess);
493       }
494    delete res;
495
496 #ifdef _WIN32
497     std::string bbs_path = path + "/bbs";
498 #else
499     std::string bbs_path = path + "/share/bbtk/bbs" ;
500 #endif
501     XMLNode BBSPATH = BB.addChild((XMLCSTR)"bbs_path");
502     BBSPATH.addText((XMLCSTR)bbs_path.c_str());
503     Utilities::replace(bbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR);
504     mBbs_paths.push_back(bbs_path);
505  
506 #ifdef _WIN32
507     std::string pack_path = path + "/bin";
508 #else
509     std::string pack_path = path ;
510 #endif
511     XMLNode PACKPATH = BB.addChild((XMLCSTR)"package_path");
512     PACKPATH.addText((XMLCSTR)pack_path.c_str());
513     Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
514     mPackage_paths.push_back(pack_path);
515
516 #ifdef _WIN32
517     pack_path = path + "/Debug";
518     PACKPATH = BB.addChild((XMLCSTR)"package_path");
519     PACKPATH.addText((XMLCSTR)pack_path.c_str());
520     Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
521     mPackage_paths.push_back(pack_path);
522     pack_path = path + "/Release";
523     PACKPATH = BB.addChild((XMLCSTR)"package_path");
524     PACKPATH.addText((XMLCSTR)pack_path.c_str());
525     Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
526     mPackage_paths.push_back(pack_path);
527 #endif
528
529
530     XMLError err = BB.writeToFile((XMLCSTR)Get_config_xml_full_path().c_str());
531     if ( err != eXMLErrorNone ) 
532       {
533         std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
534         bbtkDebugMessage("Config",1,mess<< std::endl);
535         bbtkError(mess);
536       }
537
538     return true;
539   }
540   //=========================================================================
541
542   //=========================================================================
543   void ConfigurationFile::GetHelp(int level) const
544   {
545     bbtkDebugMessageInc("Config",9,"ConfigurationFile::GetHelp("<<level
546                         <<")"<<std::endl);
547     
548     const std::string config_xml_full_path      = Get_config_xml_full_path();    
549     const std::string description               = Get_description();
550     const std::string url                       = Get_doc_path();
551     const std::string data_path                 = Get_data_path();
552     const std::string default_temp_dir          = Get_default_temp_dir();    
553     const std::string file_separator            = Get_file_separator();    
554     const std::vector<std::string>bbs_paths     = Get_bbs_paths();
555     const std::vector<std::string>package_paths = Get_package_paths();
556     
557     bbtkMessage("Help",level, "============="   << std::endl);           
558     bbtkMessage("Help",level, "Configuration"   << std::endl);
559     bbtkMessage("Help",level, "============="   << std::endl);
560     bbtkMessage("Help",level, "bbtk_config.xml    : [" << config_xml_full_path  << "]" << std::endl); 
561     bbtkMessage("Help",level, "Documentation Path : [" << url             << "]" << std::endl);
562     bbtkMessage("Help",level, "Data Path          : [" << data_path       << "]" << std::endl);
563     bbtkMessage("Help",level, "Temp Directory     : [" << default_temp_dir << "]" << std::endl);
564     bbtkMessage("Help",level, "File Separator     : [" << file_separator  << "]" << std::endl);
565
566     std::vector<std::string>::const_iterator i;
567            
568     bbtkMessage("Help",level, "BBS Paths   " << std::endl);     
569     for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
570     {
571       bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
572     }    
573     
574     bbtkMessage("Help",level, "PACKAGE Paths : " << std::endl);     
575     for (i = package_paths.begin(); i!=package_paths.end(); ++i )
576     {
577       bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
578     }
579
580     bbtkDebugDecTab("Config",9);
581   }
582   //=========================================================================
583
584
585 } // namespace bbtk