src/TOOLSDS/SALOMEDS_Tool.cxx

   1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 // This library is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU Lesser General Public
   6 // License as published by the Free Software Foundation; either
   7 // version 2.1 of the License.
   8 //
   9 // This library is distributed in the hope that it will be useful
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // Lesser General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Lesser General Public
  15 // License along with this library; if not, write to the Free Software
  16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/
  19 //
  20 //  File      : SALOMEDS_Tool.cxx
  21 //  Created   : Mon Oct 21 16:24:34 2002
  22 //  Author    : Sergey RUIN
  23
  24 //  Project   : SALOME
  25 //  Module    : SALOMEDS
  26 //  Copyright : Open CASCADE
  27
  28 #include "SALOMEDS_Tool.hxx"
  29
  30 #include "utilities.h"
  31
  32 #include <TCollection_AsciiString.hxx>
  33
  34 #include <OSD_Path.hxx>
  35 #include <OSD_File.hxx>
  36 #include <OSD_Directory.hxx>
  37 #include <OSD_Process.hxx>
  38 #include <OSD_Directory.hxx>
  39 #include <OSD_Protection.hxx>
  40 #include <OSD_SingleProtection.hxx>
  41 #include <OSD_FileIterator.hxx>
  42
  43 #ifndef WNT
  44 #include <stdio.h>
  45 #include <iostream.h>
  46 #include <fstream.h>
  47 #include <sys/time.h>
  48 #else
  49 #endif
  50 #include <stdlib.h>
  51
  52 #include CORBA_SERVER_HEADER(SALOMEDS_Attributes)
  53
  54 using namespace std;
  55
  56 //============================================================================
  57 // function : GetTempDir
  58 // purpose  : Return a temp directory to store created files like "/tmp/sub_dir/"
  59 //============================================================================
  60 std::string SALOMEDS_Tool::GetTmpDir()
  61 {
  62   //Find a temporary directory to store a file
  63
  64   TCollection_AsciiString aTmpDir;
  65
  66   char *Tmp_dir = getenv("SALOME_TMP_DIR");
  67   if(Tmp_dir != NULL) {
  68     aTmpDir = TCollection_AsciiString(Tmp_dir);
  69 #ifdef WIN32
  70     if(aTmpDir.Value(aTmpDir.Length()) != '\\') aTmpDir+='\\';
  71 #else
  72     if(aTmpDir.Value(aTmpDir.Length()) != '/') aTmpDir+='/';
  73 #endif
  74   }
  75   else {
  76 #ifdef WIN32
  77     aTmpDir = TCollection_AsciiString("C:\\");
  78 #else
  79     aTmpDir = TCollection_AsciiString("/tmp/");
  80 #endif
  81   }
  82
  83   srand((unsigned int)time(NULL));
  84   int aRND = 999 + (int)(100000.0*rand()/(RAND_MAX+1.0)); //Get a random number to present a name of a sub directory
  85   TCollection_AsciiString aSubDir(aRND);
  86   if(aSubDir.Length() <= 1) aSubDir = TCollection_AsciiString("123409876");
  87
  88   aTmpDir += aSubDir; //Get RND sub directory
  89
  90 #ifdef WIN32
  91   if(aTmpDir.Value(aTmpDir.Length()) != '\\') aTmpDir+='\\';
  92 #else
  93   if(aTmpDir.Value(aTmpDir.Length()) != '/') aTmpDir+='/';
  94 #endif
  95
  96   OSD_Path aPath(aTmpDir);
  97   OSD_Directory aDir(aPath);
  98
  99   for(aRND = 0; aDir.Exists(); aRND++) {
 100     aTmpDir.Insert((aTmpDir.Length() - 1), TCollection_AsciiString(aRND));  //Build a unique directory name
 101     aPath = OSD_Path(aTmpDir);
 102     aDir = OSD_Directory(aPath);
 103   }
 104
 105   MESSAGE("#### TMP" << aTmpDir.ToCString());
 106
 107   OSD_Protection aProtection(OSD_RW, OSD_RWX, OSD_RX, OSD_RX);
 108   aDir.Build(aProtection);
 109
 110   return aTmpDir.ToCString();
 111 }
 112
 113 //============================================================================
 114 // function : RemoveTemporaryFiles
 115 // purpose  : Removes files listed in theFileList
 116 //============================================================================
 117 void SALOMEDS_Tool::RemoveTemporaryFiles(const std::string& theDirectory,
 118                                          const SALOMEDS::ListOfFileNames& theFiles,
 119                                          const bool IsDirDeleted)
 120 {
 121   TCollection_AsciiString aDirName(const_cast<char*>(theDirectory.c_str()));
 122
 123   int i, aLength = theFiles.length();
 124   for(i=0; i<aLength; i++) {
 125     TCollection_AsciiString aFile(aDirName);
 126 //     aFile += (char*)theFiles[i];
 127     aFile += (char*)theFiles[i].in();
 128     OSD_Path anOSDPath(aFile);
 129     OSD_File anOSDFile(anOSDPath);
 130     if(!anOSDFile.Exists()) continue;
 131
 132     OSD_Protection aProtection = anOSDFile.Protection();
 133     aProtection.SetUser(OSD_RW);
 134     anOSDFile.SetProtection(aProtection);
 135
 136     anOSDFile.Remove();
 137   }
 138
 139   if(IsDirDeleted) {
 140     OSD_Path aPath(aDirName);
 141     OSD_Directory aDir(aPath);
 142     OSD_FileIterator anIterator(aPath, '*');
 143
 144     if(aDir.Exists() && !anIterator.More()) aDir.Remove();
 145   }
 146
 147 }
 148
 149 //============================================================================
 150 // function : PutFilesToStream
 151 // purpose  : converts the files from a list 'theFiles' to the stream
 152 //============================================================================
 153 SALOMEDS::TMPFile*
 154 SALOMEDS_Tool::PutFilesToStream(const std::string& theFromDirectory,
 155                                 const SALOMEDS::ListOfFileNames& theFiles,
 156                                 const int theNamesOnly)
 157 {
 158   int i, aLength = theFiles.length();
 159   if(aLength == 0)
 160 //    return NULL;
 161     return (new SALOMEDS::TMPFile);
 162
 163   //Get a temporary directory for saved a file
 164   TCollection_AsciiString aTmpDir(const_cast<char*>(theFromDirectory.c_str()));
 165
 166   long aBufferSize = 0;
 167   long aCurrentPos;
 168
 169   int aNbFiles = 0;
 170   int* aFileNameSize= new int[aLength];
 171   long* aFileSize= new long[aLength];
 172
 173   //Determine the required size of the buffer
 174
 175   for(i=0; i<aLength; i++) {
 176
 177     //Check if the file exists
 178
 179     if (!theNamesOnly) { // mpv 15.01.2003: if only file names must be stroed, then size of files is zero
 180       TCollection_AsciiString aFullPath = aTmpDir + CORBA::string_dup(theFiles[i]);
 181       OSD_Path anOSDPath(aFullPath);
 182       OSD_File anOSDFile(anOSDPath);
 183       if(!anOSDFile.Exists()) continue;
 184 #ifdef WNT
 185       ifstream aFile(aFullPath.ToCString(), ios::binary);
 186 #else
 187       ifstream aFile(aFullPath.ToCString());
 188 #endif
 189       aFile.seekg(0, ios::end);
 190       aFileSize[i] = aFile.tellg();
 191       aBufferSize += aFileSize[i];              //Add a space to store the file
 192     }
 193     aFileNameSize[i] = strlen(theFiles[i])+1;
 194     aBufferSize += aFileNameSize[i];          //Add a space to store the file name
 195     aBufferSize += (theNamesOnly)?4:12;       //Add 4 bytes: a length of the file name,
 196                                               //    8 bytes: length of the file itself
 197     aNbFiles++;
 198   }
 199
 200   aBufferSize += 4;      //4 bytes for a number of the files that will be written to the stream;
 201   unsigned char* aBuffer = new unsigned char[aBufferSize];
 202   if(aBuffer == NULL)
 203 //    return NULL;
 204     return (new SALOMEDS::TMPFile);
 205
 206   //Initialize 4 bytes of the buffer by 0
 207   memset(aBuffer, 0, 4);
 208   //Copy the number of files that will be written to the stream
 209   memcpy(aBuffer, &aNbFiles, ((sizeof(int) > 4) ? 4 : sizeof(int)));
 210
 211
 212   aCurrentPos = 4;
 213
 214   for(i=0; i<aLength; i++) {
 215     ifstream *aFile;
 216     if (!theNamesOnly) { // mpv 15.01.2003: we don't open any file if theNamesOnly = true
 217       TCollection_AsciiString aFullPath = aTmpDir + CORBA::string_dup(theFiles[i]);
 218       OSD_Path anOSDPath(aFullPath);
 219       OSD_File anOSDFile(anOSDPath);
 220       if(!anOSDFile.Exists()) continue;
 221 #ifdef WNT
 222       aFile = new ifstream(aFullPath.ToCString(), ios::binary);
 223 #else
 224       aFile = new ifstream(aFullPath.ToCString());
 225 #endif
 226     }
 227     //Initialize 4 bytes of the buffer by 0
 228     memset((aBuffer + aCurrentPos), 0, 4);
 229     //Copy the length of the file name to the buffer
 230     memcpy((aBuffer + aCurrentPos), (aFileNameSize + i), ((sizeof(int) > 4) ? 4 : sizeof(int)));
 231     aCurrentPos += 4;
 232
 233     //Copy the file name to the buffer
 234     memcpy((aBuffer + aCurrentPos), theFiles[i], aFileNameSize[i]);
 235     aCurrentPos += aFileNameSize[i];
 236
 237     if (!theNamesOnly) { // mpv 15.01.2003: we don't copy file content to the buffer if !theNamesOnly
 238       //Initialize 8 bytes of the buffer by 0
 239       memset((aBuffer + aCurrentPos), 0, 8);
 240       //Copy the length of the file to the buffer
 241       memcpy((aBuffer + aCurrentPos), (aFileSize + i), ((sizeof(long) > 8) ? 8 : sizeof(long)));
 242       aCurrentPos += 8;
 243
 244       aFile->seekg(0, ios::beg);
 245       aFile->read((char *)(aBuffer + aCurrentPos), aFileSize[i]);
 246       aFile->close();
 247       delete(aFile);
 248       aCurrentPos += aFileSize[i];
 249     }
 250   }
 251
 252   delete[] aFileNameSize;
 253   delete[] aFileSize;
 254
 255
 256   CORBA::Octet* anOctetBuf =  (CORBA::Octet*)aBuffer;
 257
 258   return (new SALOMEDS::TMPFile(aBufferSize, aBufferSize, anOctetBuf, 1));
 259 }
 260
 261 //============================================================================
 262 // function : PutStreamToFile
 263 // purpose  : converts the stream "theStream" to the files
 264 //============================================================================
 265 SALOMEDS::ListOfFileNames_var
 266 SALOMEDS_Tool::PutStreamToFiles(const SALOMEDS::TMPFile& theStream,
 267                                 const std::string& theToDirectory,
 268                                 const int theNamesOnly)
 269 {
 270   SALOMEDS::ListOfFileNames_var aFiles = new SALOMEDS::ListOfFileNames;
 271
 272   if(theStream.length() == 0)
 273     return aFiles;
 274
 275   //Get a temporary directory for saving a file
 276   TCollection_AsciiString aTmpDir(const_cast<char*>(theToDirectory.c_str()));
 277
 278   unsigned char *aBuffer = (unsigned char*)theStream.NP_data();
 279
 280   if(aBuffer == NULL)
 281     return aFiles;
 282
 283   long aFileSize, aCurrentPos = 4;
 284   int i, aFileNameSize, aNbFiles = 0;
 285
 286   //Copy the number of files in the stream
 287   memcpy(&aNbFiles, aBuffer, sizeof(int));
 288
 289   aFiles->length(aNbFiles);
 290
 291   for(i=0; i<aNbFiles; i++) {
 292
 293     //Put a length of the file name to aFileNameSize
 294     memcpy(&aFileNameSize, (aBuffer + aCurrentPos), ((sizeof(int) > 4) ? 4 : sizeof(int)));
 295     aCurrentPos += 4;
 296
 297     char *aFileName = new char[aFileNameSize];
 298     //Put a file name to aFileName
 299     memcpy(aFileName, (aBuffer + aCurrentPos), aFileNameSize);
 300     aCurrentPos += aFileNameSize;
 301
 302     //Put a length of the file to aFileSize
 303     if (!theNamesOnly) {
 304       memcpy(&aFileSize, (aBuffer + aCurrentPos), ((sizeof(long) > 8) ? 8 : sizeof(long)));
 305       aCurrentPos += 8;
 306
 307       TCollection_AsciiString aFullPath = aTmpDir + aFileName;
 308       ofstream aFile(aFullPath.ToCString());
 309       aFile.write((char *)(aBuffer+aCurrentPos), aFileSize);
 310       aFile.close();
 311       aCurrentPos += aFileSize;
 312     }
 313     aFiles[i] = CORBA::string_dup(aFileName);
 314     delete[] aFileName;
 315   }
 316
 317   return aFiles;
 318 }
 319
 320 //============================================================================
 321 // function : GetNameFromPath
 322 // purpose  : Returns the name by the path
 323 //============================================================================
 324 std::string SALOMEDS_Tool::GetNameFromPath(const std::string& thePath) {
 325   if(thePath == "")
 326     return "";
 327   OSD_Path aPath = OSD_Path(TCollection_AsciiString(const_cast<char*>(thePath.c_str())));
 328   TCollection_AsciiString aNameString(aPath.Name());
 329   return aNameString.ToCString();
 330 }
 331
 332 //============================================================================
 333 // function : GetDirFromPath
 334 // purpose  : Returns the dir by the path
 335 //============================================================================
 336 std::string SALOMEDS_Tool::GetDirFromPath(const std::string& thePath) {
 337   if(thePath == "")
 338     return "";
 339   OSD_Path aPath = OSD_Path(TCollection_AsciiString(const_cast<char*>(thePath.c_str())));
 340   TCollection_AsciiString aDirString(aPath.Trek());
 341   aDirString.ChangeAll('|','/');
 342   return aDirString.ToCString();
 343 }
 344
 345 //=======================================================================
 346 // name    : GetFlag
 347 // Purpose : Retrieve specified flaf from "AttributeFlags" attribute
 348 //=======================================================================
 349 bool SALOMEDS_Tool::GetFlag( const int             theFlag,
 350                              SALOMEDS::Study_var   theStudy,
 351                              SALOMEDS::SObject_var theObj )
 352 {
 353   SALOMEDS::GenericAttribute_var anAttr;
 354   if ( !theObj->_is_nil() && theObj->FindAttribute( anAttr, "AttributeFlags" ) )
 355   {
 356     SALOMEDS::AttributeFlags_var aFlags = SALOMEDS::AttributeFlags::_narrow( anAttr );
 357     return aFlags->Get( theFlag );
 358   }
 359
 360   return false;
 361 }
 362
 363 //=======================================================================
 364 // name    : SetFlag
 365 // Purpose : Set/Unset specified flaf from "AttributeFlags" attribute
 366 //=======================================================================
 367 bool SALOMEDS_Tool::SetFlag( const int           theFlag,
 368                              SALOMEDS::Study_var theStudy,
 369                              const std::string&  theEntry,
 370                              const bool          theValue )
 371 {
 372   SALOMEDS::SObject_var anObj = theStudy->FindObjectID(theEntry.c_str());
 373
 374   if ( !anObj->_is_nil() )
 375   {
 376     SALOMEDS::GenericAttribute_var aGAttr;
 377     if ( anObj->FindAttribute( aGAttr, "AttributeFlags" ) )
 378     {
 379       SALOMEDS::AttributeFlags_var anAttr = SALOMEDS::AttributeFlags::_narrow( aGAttr );
 380       anAttr->Set( theFlag, theValue );
 381     }
 382     else if ( theValue )
 383     {
 384       SALOMEDS::StudyBuilder_var aBuilder = theStudy->NewBuilder();
 385       SALOMEDS::AttributeFlags_var anAttr = SALOMEDS::AttributeFlags::_narrow(
 386         aBuilder->FindOrCreateAttribute( anObj, "AttributeFlags" ) );
 387       anAttr->Set( theFlag, theValue );
 388     }
 389     return true;
 390   }
 391
 392   return false;
 393 }
 394
 395 //=======================================================================
 396 // name    : getAllChildren
 397 // Purpose : Get all children of object.
 398 //           If theObj is null all objects of study are returned
 399 //=======================================================================
 400 void SALOMEDS_Tool::GetAllChildren( SALOMEDS::Study_var               theStudy,
 401                                     SALOMEDS::SObject_var             theObj,
 402                                     std::list<SALOMEDS::SObject_var>& theList )
 403 {
 404   if ( theObj->_is_nil() )
 405   {
 406     SALOMEDS::SComponentIterator_var anIter = theStudy->NewComponentIterator();
 407     for ( ; anIter->More(); anIter->Next() )
 408     {
 409       SALOMEDS::SObject_var anObj = SALOMEDS::SObject::_narrow( anIter->Value() );
 410       if ( !anObj->_is_nil() )
 411       {
 412         theList.push_back( anObj );
 413         GetAllChildren( theStudy, anObj, theList );
 414       }
 415     }
 416   }
 417   else
 418   {
 419     SALOMEDS::ChildIterator_var anIter = theStudy->NewChildIterator( theObj );
 420     for ( ; anIter->More(); anIter->Next() )
 421     {
 422       SALOMEDS::SObject_var anObj = anIter->Value();
 423       SALOMEDS::SObject_var aRef;
 424       if ( !anObj->ReferencedObject( aRef ) )
 425       {
 426         theList.push_back( anObj );
 427         GetAllChildren( theStudy, anObj, theList );
 428       }
 429     }
 430   }
 431 }
 432
 433
 434