]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkConfigurationFile.cxx
*** empty log message ***
[bbtk.git] / kernel / src / bbtkConfigurationFile.cxx
index 1dd5780150951a1384e8d10c127799930cb4423c..dbcc49becd70040a299d5e330eb0423962004a46 100644 (file)
@@ -1,20 +1,33 @@
-/*=========================================================================
-                                                                                
+/*=========================================================================                                                                               
   Program:   bbtk
   Module:    $RCSfile: bbtkConfigurationFile.cxx,v $
   Language:  C++
-  Date:      $Date: 2008/02/14 09:57:18 $
-  Version:   $Revision: 1.6 $
-                                                                                
-  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
-  l'Image). All rights reserved. See doc/license.txt or
-  http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
-                                                                                
-     This software is distributed WITHOUT ANY WARRANTY; without even
-     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
-     PURPOSE.  See the above copyright notices for more information.
-
+  Date:      $Date: 2008/12/10 10:00:36 $
+  Version:   $Revision: 1.24 $
 =========================================================================*/
+
+/* ---------------------------------------------------------------------
+
+* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
+* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+*
+*  This software is governed by the CeCILL-B license under French law and 
+*  abiding by the rules of distribution of free software. You can  use, 
+*  modify and/ or redistribute the software under the terms of the CeCILL-B 
+*  license as circulated by CEA, CNRS and INRIA at the following URL 
+*  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
+*  or in the file LICENSE.txt.
+*
+*  As a counterpart to the access to the source code and  rights to copy,
+*  modify and redistribute granted by the license, users are provided only
+*  with a limited warranty  and the software's author,  the holder of the
+*  economic rights,  and the successive licensors  have only  limited
+*  liability. 
+*
+*  The fact that you are presently reading this means that you have had
+*  knowledge of the CeCILL-B license and that you accept its terms.
+* ------------------------------------------------------------------------ */                                                                         
+
 /**
  *\file
  *\brief Class bbtk::ConfigurationFile
 #include "bbtkUtilities.h"
 
 #if defined(WIN32)
-#include <direct.h> // for getcwd
+# include <direct.h> // for getcwd
+# include <windows.h>
 #endif
 
+#if defined(MACOSX) // assume this is OSX 
+# include <sys/param.h>
+# include <mach-o/dyld.h> // _NSGetExecutablePath : must add -framework CoreFoundation to link line 
+# include <string.h>
+# ifndef PATH_MAX
+#  define PATH_MAX MAXPATHLEN
+# endif
+#endif // MACOSX
+
+#ifndef PATH_MAX // If not defined yet : do it 
+#  define PATH_MAX 2048
+#endif
+
+
 namespace bbtk
 {
 
@@ -36,24 +64,27 @@ namespace bbtk
   /// Constructor
   ConfigurationFile::ConfigurationFile()
   {
-    // file separator
-#if defined(_WIN32)
-    mFile_separator = "\\";
-#else
-    mFile_separator = "/";
-#endif
+
+       mFile_separator = VALID_FILE_SEPARATOR;
     
-    // ==> Set system paths
+    // ==> Set system paths 
     mBin_path = GetExecutablePath();
-    mInstall_path = mBin_path + mFile_separator + "..";
-    // The relative path to the doc folder (=BBTK_DOC_REL_PATH)
+//EED    mInstall_path = mBin_path + mFile_separator + "..";
+#ifdef MACOSX
+         mInstall_path = mBin_path + "/../../../..";
+#else
+         mInstall_path = mBin_path + "/..";
+#endif
+         // The relative path to the doc folder (=BBTK_DOC_REL_PATH)
     mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH);
     // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
-    mDoc_path = mInstall_path + mFile_separator + mDoc_rel_path;
+//EED    mDoc_path = mInstall_path + mFile_separator + mDoc_rel_path;
+    mDoc_path = mInstall_path + "/" + mDoc_rel_path;
     // The relative path to the doc folder (=BBTK_BBS_REL_PATH)
     mBbs_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_BBS_REL_PATH);
     // The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
-    mBbs_path = mInstall_path + mFile_separator + mBbs_rel_path;
+//EED    mBbs_path = mInstall_path + mFile_separator + mBbs_rel_path;
+    mBbs_path = mInstall_path + "/" + mBbs_rel_path;
     // The relative path to the rsc folder (=BBTK_RSC_REL_PATH)
     //   mRsc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_RSC_REL_PATH);
     // The path to the rsc folder (=mInstall_path+"/"+mRsc_rel_path)
@@ -61,37 +92,73 @@ namespace bbtk
     // The path to the bbtk data folder 
     // Initialized to mInstall_path+"/"+BBTK_DATA_REL_PATH
     // But can be overriden by value read from bbtk_config.xml
-    mData_path = mInstall_path + mFile_separator + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
+//EED    mData_path = mInstall_path + mFile_separator + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
+    mData_path = mInstall_path + "/" + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH);
+
+       Utilities::replace( mBin_path           , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
+       Utilities::replace( mInstall_path       , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
+       Utilities::replace( mDoc_rel_path       , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
+       Utilities::replace( mDoc_path           , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
+       Utilities::replace( mBbs_path           , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
+       Utilities::replace( mData_path          , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
 
     bbtkMessage("Config",1," ==> bin    : '"<<mBin_path<<"'"<<std::endl);
     bbtkMessage("Config",1," ==> prefix : '"<<mInstall_path<<"'"<<std::endl);
     bbtkMessage("Config",1," ==> doc    : '"<<mDoc_path<<"'"<<std::endl);
     bbtkMessage("Config",1," ==> bbs    : '"<<mBbs_path<<"'"<<std::endl);
-    //   bbtkMessage("Config",1," ==> rsc    : '"<<mRsc_path<<"'"<<std::endl);
     bbtkMessage("Config",1," ==> data   : '"<<mData_path<<"'"<<std::endl);
-    
+
+
+
     
     // bbs_paths
     // always add "." (current working directory) at the begining
-    mBbs_paths.push_back("."); 
+       mBbs_paths.push_back( "." ); 
     // add system bbs path 
     mBbs_paths.push_back(mBbs_path);
+    // add toolsbbtk/appli 
+//EED    std::string toolsappli_rel_path(mFile_separator);
+    std::string toolsappli_rel_path("/");
+//EED    toolsappli_rel_path +=  "toolsbbtk" + mFile_separator + "appli";
+    toolsappli_rel_path +=  "toolsbbtk/appli";
+    //
+    //-----------------------------------------------------------
+    // LG : REMOVE BUGGY PATH WITH include *:
+    // 
+    //    mBbs_paths.push_back(mBbs_path + toolsappli_rel_path);
+    //-----------------------------------------------------------
+    int iStrVec,sizeStrVec;
+    
+    sizeStrVec = mBbs_paths.size();
+    for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
+      Utilities::replace( mBbs_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
+    }
+
     
     // always add "." (current working directory) at the begining
     mPackage_paths.push_back(".");   
-#ifdef UNIX
-    // add system bin path (for build tree)
-    // mPackage_paths.push_back(mBin_path);
+    // add system bin path (for build tree / standalone folder install)
+    mPackage_paths.push_back(mBin_path);
     // add system lib path (for install tree)
-    mPackage_paths.push_back(mInstall_path + mFile_separator + "lib");
-#endif
+//EED    mPackage_paths.push_back(mInstall_path + mFile_separator + "lib");
+    mPackage_paths.push_back(mInstall_path + "/lib");
 #ifdef WIN32
     // add bin/Debug bin/Release paths (for build/install tree)
-    mPackage_paths.push_back(mBin_path + mFile_separator + "Debug");
-    mPackage_paths.push_back(mBin_path + mFile_separator + "Release");
+//EED    mPackage_paths.push_back(mBin_path + mFile_separator + "Debug");
+    mPackage_paths.push_back(mBin_path + "/Debug");
+//EED    mPackage_paths.push_back(mBin_path + mFile_separator + "Release");
+    mPackage_paths.push_back(mBin_path + "/Release");
 #endif
-    
-    
+
+       sizeStrVec = mPackage_paths.size();
+       for (iStrVec=0;iStrVec<sizeStrVec;iStrVec++){
+               Utilities::replace( mPackage_paths[iStrVec] , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
+       }
+
+
+
+    GetHelp(2);
+   
     // ==> First we look for bbtk_config.xml in "."
     char buf[2048];
     const char *currentDir = getcwd(buf, 2048);
@@ -104,8 +171,11 @@ namespace bbtk
        // LG : throw an exception 
       }
     
-    std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml";
-    
+//    std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml";
+    std::string configXmlFullPathName = currentDir ;
+                configXmlFullPathName += "/bbtk_config.xml";
+       Utilities::replace( configXmlFullPathName , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR);
+
     if ( Utilities::FileExists( configXmlFullPathName ))
       {
        bbtkMessage("Config",1, "ConfigurationFile : [" << configXmlFullPathName << 
@@ -117,12 +187,7 @@ namespace bbtk
     // ==> Then we look for bbtk_config.xml in ".bbtk"
     else 
       {
-#if defined(__GNUC__)
-       std::string str_home(getenv("HOME"));
-#elif defined(_WIN32)
-       std::string str_home(getenv("USERPROFILE"));
-#endif
-       configXmlFullPathName = str_home + mFile_separator + ".bbtk/bbtk_config.xml";
+       configXmlFullPathName = Utilities::MakeUserSettingsFullFileName("bbtk_config.xml");
        if (!Utilities::FileExists( configXmlFullPathName ))
          {         
            // ==> Nothing found, we create bbtk_config.xml in ".bbtk"
@@ -151,33 +216,173 @@ namespace bbtk
     FILE *fp;
     char configXml[250];
     sprintf (configXml , "%s/bbtk_config.xml", rootDirectory);
-    bbtkMessage("Config",1, "in CreateConfigXML[" << configXml << "]" << std::endl);
+    bbtkDebugMessage("Config",1, "in CreateConfigXML[" << configXml << "]" << std::endl);
     fp = fopen (configXml, "w");
     fprintf(fp, "<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n");
-    //  fprintf(fp, "<!DOCTYPE config SYSTEM \"/mnt/windows/bbtk/bbtk_config.xml>\n");
     fprintf(fp, "<config>\n");
-    fprintf(fp, "   <description>  </description>\n");
-    //   fprintf(fp, "   <url>  http://www.creatis.insa-lyon.fr/software/bbtk  </url>\n");
-    //  fprintf(fp, "   <install_path> </install_path>\n");
     fprintf(fp, "   <bbs_path>     </bbs_path>\n");
-    // fprintf(fp, "   <ext_dll_path> </ext_dll_path>\n");
     fprintf(fp, "   <package_path> </package_path>\n");
-    fprintf(fp, "   <data_path> </data_path>\n");//, BBTK_DATA_PATH);
-    /// \todo find a decent default value !
-      ///fprintf(fp, "   <default_temp_dir>  %s </default_temp_dir>\n", " ");
-      // when $ will be found, default_temp_dir value will be replaced
-      fprintf(fp, "   <default_temp_dir>$</default_temp_dir>\n");
-      fprintf(fp, "</config>\n");
-      fclose(fp);
+    fprintf(fp, "   <default_temp_dir> $ </default_temp_dir>\n");    
+    fprintf(fp, "</config>\n");
+    fclose(fp);
   }
   //=========================================================================  
 
+       
+       
+       //=========================================================================  
+       // From http://www.fltk.org/newsgroups.php?gfltk.general+v:22083
+       //
+       int get_app_path (char *pname, size_t pathsize)
+       {
+#ifdef LINUX
+        /* Oddly, the readlink(2) man page says no NULL is appended. */
+        /* So you have to do it yourself, based on the return value: */
+        pathsize --; /* Preserve a space to add the trailing NULL */
+        long result = readlink("/proc/self/exe", pname, pathsize);
+        if (result > 0)
+        {
+                       pname[result] = 0; /* add the #@!%ing NULL */
+                       
+                       if ((access(pname, 0) == 0))
+                               return 0; /* file exists, return OK */
+                       /*else name doesn't seem to exist, return FAIL (falls
+                        through) */
+        }
+#endif /* LINUX */
+               
+#ifdef WIN32
+        long result = GetModuleFileName(NULL, pname, pathsize);
+        if (result > 0)
+        {
+                       /* fix up the dir slashes... */
+                       int len = strlen(pname);
+                       int idx;
+                       for (idx = 0; idx < len; idx++)
+                       {
+                               if (pname[idx] == '\\') pname[idx] = '/';
+                       }
+
+                       for (idx = len-1; idx >=0 ; idx--)
+                       {
+                               if (pname[idx] == '/')
+                               { 
+                                       pname[idx+1] = '\0';
+                                       idx = -1;
+                               }
+                       }
+
+                       if ((access(pname, 0) == 0))
+                               return 0; /* file exists, return OK */
+                       /*else name doesn't seem to exist, return FAIL (falls
+                        through) */
+        }
+#endif /* WIN32 */
+               
+#ifdef SOLARIS
+        char *p = getexecname();
+        if (p)
+        {
+                       /* According to the Sun manpages, getexecname will
+                        "normally" return an */
+                       /* absolute path - BUT might not... AND that IF it is not,
+                        pre-pending */
+                       /* getcwd() will "usually" be the correct thing... Urgh!
+                        */
+                       
+                       /* check pathname is absolute (begins with a / ???) */
+                       if (p[0] == '/') /* assume this means we have an
+                        absolute path */
+                       {
+                               strncpy(pname, p, pathsize);
+                               if ((access(pname, 0) == 0))
+                                       return 0; /* file exists, return OK */
+                       }
+                       else /* if not, prepend getcwd() then check if file
+                        exists */
+                       {
+                               getcwd(pname, pathsize);
+                               long result = strlen(pname);
+                               strncat(pname, "/", (pathsize - result));
+                               result ++;
+                               strncat(pname, p, (pathsize - result));
+                               
+                               if ((access(pname, 0) == 0))
+                                       return 0; /* file exists, return OK */
+                               /*else name doesn't seem to exist, return FAIL
+                                (falls through) */
+                       }
+        }
+#endif /* SOLARIS */
+               
+#ifdef MACOSX /* assume this is OSX */
+               /*
+                from http://www.hmug.org/man/3/NSModule.html
+                
+                extern int _NSGetExecutablePath(char *buf, unsigned long
+                *bufsize);
+                
+                _NSGetExecutablePath  copies  the  path  of the executable
+                into the buffer and returns 0 if the path was successfully
+                copied  in the provided buffer. If the buffer is not large
+                enough, -1 is returned and the  expected  buffer  size  is
+                copied  in  *bufsize.  Note that _NSGetExecutablePath will
+                return "a path" to the executable not a "real path" to the
+                executable.  That  is  the path may be a symbolic link and
+                not the real file. And with  deep  directories  the  total
+                bufsize needed could be more than MAXPATHLEN.
+                */
+        int status = -1;
+        char *given_path = (char*)malloc(MAXPATHLEN * 2);
+        if (!given_path) return status;
+               
+        uint32_t npathsize = MAXPATHLEN * 2;
+        long result = _NSGetExecutablePath(given_path, &npathsize);
+        if (result == 0)
+        { /* OK, we got something - now try and resolve the real path...
+                */
+                       if (realpath(given_path, pname) != NULL)
+                       {
+                               if ((access(pname, 0) == 0))
+                                       status = 0; /* file exists, return OK */
+                       }
+        }
+        free (given_path);
+        return status;
+#endif /* MACOSX */
+               
+        return -1; /* Path Lookup Failed */
+       } 
+       
 
+       
   //=========================================================================
   std::string ConfigurationFile::GetExecutablePath()
   {
+         char name[PATH_MAX];
+         int err = get_app_path(name, PATH_MAX);
+         if (err) 
+         {
+               bbtkError("Could not determine current executable path ?");  
+         }
+         
+         // remove the exe name
+         char *slash;          
+         slash = strrchr(name, VALID_FILE_SEPARATOR_CHAR);
+         if (slash)
+         {
+                 *slash = 0;
+         }
+         return name;
+  }
+         
+/*       
     /// \todo : Think to delete it!
     char *buf = (char *)malloc(512);
+       if (!buf) 
+       {
+               bbtkError("Could not allocate 512 bytes !");
+       }
     char *slash;
     
 #if defined(WIN32)
@@ -187,26 +392,30 @@ namespace bbtk
       {
         *slash = 0;
       }
-#elif defined(__GNUC__)
+#endif 
+         
+
+#if defined(__GNUC__)
     int res;
     res = readlink("/proc/self/exe", buf, 512);
     if (res == -1)
-      return "";
+       {
+           free(buf);
+               
+       }
     buf[res] = 0;
     slash = strrchr(buf, '/');
     if (slash)
       {
         *slash = 0;
       }
-#else
-    return "";
 #endif
     std::string ret(buf);
     free(buf);
     return ret;
   }
   //=========================================================================
-
+*/
 
   //=========================================================================
   void ConfigurationFile::InstallPath ()
@@ -429,8 +638,119 @@ namespace bbtk
        size_t pos = mConfig_xml_full_path.find("bbtk_config.xml");
        mDefault_temp_dir = mConfig_xml_full_path.substr (0,pos); 
       }    
+
+    GetHelp(2);
+  }
+  //=========================================================================
+  
+  //=========================================================================
+  bool ConfigurationFile::AddPackagePathsAndWrite( const std::string& path )
+  {
+    bbtkDebugMessageInc("Config",9,
+                       "ConfigurationFile::AddPackagePathsAndWrite("
+                       <<path<<")"<<std::endl);
+    
+     XMLResults* res = new XMLResults;
+    XMLNode BB = 
+      XMLNode::parseFile((XMLCSTR)Get_config_xml_full_path().c_str(),
+                        (XMLCSTR)"config",res);
     
+    if ( res->error != eXMLErrorNone ) 
+      {
+       std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
+       delete res;
+       bbtkDebugMessage("Config",1,mess<< std::endl);
+       bbtkError(mess);
+      }
+   delete res;
+
+#ifdef _WIN32
+    std::string bbs_path = path + "/bbs";
+#else
+    std::string bbs_path = path + "/share/bbtk/bbs" ;
+#endif
+    XMLNode BBSPATH = BB.addChild((XMLCSTR)"bbs_path");
+    BBSPATH.addText((XMLCSTR)bbs_path.c_str());
+    Utilities::replace(bbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR);
+    mBbs_paths.push_back(bbs_path);
+#ifdef _WIN32
+    std::string pack_path = path + "/bin";
+#else
+    std::string pack_path = path ;
+#endif
+    XMLNode PACKPATH = BB.addChild((XMLCSTR)"package_path");
+    PACKPATH.addText((XMLCSTR)pack_path.c_str());
+    Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
+    mPackage_paths.push_back(pack_path);
+
+#ifdef _WIN32
+    pack_path = path + "/Debug";
+    PACKPATH = BB.addChild((XMLCSTR)"package_path");
+    PACKPATH.addText((XMLCSTR)pack_path.c_str());
+    Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
+    mPackage_paths.push_back(pack_path);
+    pack_path = path + "/Release";
+    PACKPATH = BB.addChild((XMLCSTR)"package_path");
+    PACKPATH.addText((XMLCSTR)pack_path.c_str());
+    Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR);
+    mPackage_paths.push_back(pack_path);
+#endif
+
+
+    XMLError err = BB.writeToFile((XMLCSTR)Get_config_xml_full_path().c_str());
+    if ( err != eXMLErrorNone ) 
+      {
+       std::string mess = GetErrorMessage(res,Get_config_xml_full_path());
+       bbtkDebugMessage("Config",1,mess<< std::endl);
+       bbtkError(mess);
+      }
+
+    return true;
+  }
+  //=========================================================================
+
+  //=========================================================================
+  void ConfigurationFile::GetHelp(int level) const
+  {
+    bbtkDebugMessageInc("Config",9,"ConfigurationFile::GetHelp("<<level
+                       <<")"<<std::endl);
+    
+    const std::string config_xml_full_path      = Get_config_xml_full_path();    
+    const std::string description               = Get_description();
+    const std::string url                       = Get_doc_path();
+    const std::string data_path                 = Get_data_path();
+    const std::string default_temp_dir          = Get_default_temp_dir();    
+    const std::string file_separator            = Get_file_separator();    
+    const std::vector<std::string>bbs_paths     = Get_bbs_paths();
+    const std::vector<std::string>package_paths = Get_package_paths();
+    
+    bbtkMessage("Help",level, "============="   << std::endl);           
+    bbtkMessage("Help",level, "Configuration"   << std::endl);
+    bbtkMessage("Help",level, "============="   << std::endl);
+    bbtkMessage("Help",level, "bbtk_config.xml    : [" << config_xml_full_path  << "]" << std::endl); 
+    bbtkMessage("Help",level, "Documentation Path : [" << url             << "]" << std::endl);
+    bbtkMessage("Help",level, "Data Path          : [" << data_path       << "]" << std::endl);
+    bbtkMessage("Help",level, "Temp Directory     : [" << default_temp_dir << "]" << std::endl);
+    bbtkMessage("Help",level, "File Separator     : [" << file_separator  << "]" << std::endl);
+
+    std::vector<std::string>::const_iterator i;
+           
+    bbtkMessage("Help",level, "BBS Paths   " << std::endl);     
+    for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
+    {
+      bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
+    }    
+    
+    bbtkMessage("Help",level, "PACKAGE Paths : " << std::endl);     
+    for (i = package_paths.begin(); i!=package_paths.end(); ++i )
+    {
+      bbtkMessage("Help",level,"--- ["<<*i<<"]"<<std::endl);
+    }
+
+    bbtkDebugDecTab("Config",9);
   }
   //=========================================================================
 
+
 } // namespace bbtk