1 // Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // SALOME Session : implementation of Session.idl
24 // File : SALOME_Session_Server.cxx
25 // Author : Paul RASCLE, EDF
28 #include <SALOME_NamingService.hxx>
29 #include <SALOME_ModuleCatalog_impl.hxx>
30 #include <SALOME_LifeCycleCORBA.hxx>
31 #include <SALOME_Event.h>
33 #include <Basics_OCCTVersion.hxx>
35 #include <Container_init_python.hxx>
36 #include <ConnectionManager_i.hxx>
37 #include <RegistryService.hxx>
39 #ifdef ENABLE_TESTRECORDER
40 #include <TestApplication.h>
44 #include <Utils_ORB_INIT.hxx>
45 #include <Utils_SINGLETON.hxx>
46 #include <Utils_SALOME_Exception.hxx>
47 #include <Utils_CorbaException.hxx>
49 #include <utilities.h>
50 #include "Session_ServerLauncher.hxx"
51 #include "Session_ServerCheck.hxx"
52 #include "Session_Session_i.hxx"
55 #include <QtxSplash.h>
57 #include <Style_Salome.h>
59 #include "GUI_version.h"
60 #include <SUIT_Tools.h>
61 #include <SUIT_Session.h>
62 #include <SUIT_Application.h>
63 #include <SUIT_Desktop.h>
64 #include <SUIT_ResourceMgr.h>
65 #include <SUIT_ExceptionHandler.h>
67 #include <SALOMEconfig.h>
68 #include CORBA_SERVER_HEADER(SALOME_Session)
69 #include CORBA_SERVER_HEADER(SALOMEDS)
73 #include <QApplication>
75 #include <QWaitCondition>
77 #include <QTextStream>
79 /*! - read arguments, define list of server to launch with their arguments.
80 * - wait for naming service
81 * - create and run a thread for launch of all servers
85 //! CORBA server for SALOME Session
87 * SALOME_Session Server launches a SALOME session servant.
88 * The servant registers to the Naming Service.
89 * See SALOME_Session.idl for interface specification.
91 * Main services offered by the servant are:
93 * - stop Session ( must be idle )
97 void MessageOutput( QtMsgType type, const char* msg )
102 //MESSAGE( "Debug: " << msg );
105 MESSAGE( "Warning: " << msg );
108 MESSAGE( "Fatal: " << msg );
113 QString salomeVersion()
115 return GUI_VERSION_STR;
118 class SALOME_ResourceMgr : public SUIT_ResourceMgr
121 SALOME_ResourceMgr( const QString& app, const QString& resVarTemplate ) : SUIT_ResourceMgr( app, resVarTemplate )
123 setCurrentFormat( "xml" );
124 setOption( "translators", QString( "%P_msg_%L.qm|%P_icons.qm|%P_images.qm" ) );
126 static void initResourceMgr()
128 if ( myExtAppName.isNull() || myExtAppVersion.isNull() ) {
129 SALOME_ResourceMgr resMgr( "SalomeApp", QString( "%1Config" ) );
130 resMgr.loadLanguage( "LightApp", "en" );
131 resMgr.loadLanguage( "SalomeApp", "en" );
133 myExtAppName = QObject::tr( "APP_NAME" ).trimmed();
134 if ( myExtAppName == "APP_NAME" || myExtAppName.toLower() == "salome" )
135 myExtAppName = "SalomeApp";
136 myExtAppVersion = QObject::tr( "APP_VERSION" );
137 if ( myExtAppVersion == "APP_VERSION" ) {
138 if ( myExtAppName != "SalomeApp" )
139 myExtAppVersion = "";
140 else myExtAppVersion = salomeVersion();
144 QString version() const { return myExtAppVersion; }
147 QString userFileName( const QString& appName, const bool for_load ) const
149 if ( version().isEmpty() ) return "";
150 return SUIT_ResourceMgr::userFileName( myExtAppName, for_load );
153 virtual long userFileId( const QString& _fname ) const
155 //////////////////////////////////////////////////////////////////////////////////////////////
156 // In SALOME and SALOME-based applications the user preferences file is named as
157 // - <AppName>.xml.<AppVersion> on Windows
158 // - <AppName>rc.<AppVersion> on Linux
160 // * AppName is application name, default SalomeApp (can be customized in SALOME-based
162 // * AppVersion is application version
164 // Since version 6.5.0 of SALOME, user file is situated in the ~/.config/salome
165 // directory. For backward compatibility, when user preferences from nearest
166 // version of application is searched, user home directory is also looked through,
167 // with lower priority.
169 // Since version 6.6.0 of SALOME, user file name on Linux is no more prefixed by dot
170 // symbol since it is situated in hidden ~/.config/salome directory. Files with dot
171 // prefix also though taken into account (with lower priority) for backward compatibility.
174 // - Currently the following format of version number is supported:
175 // <major>[.<minor>[.<release>[<type><dev>]]]
176 // Parts in square brackets are considered optional. Here:
177 // * major - major version id
178 // * minor - minor version id
179 // * release - maintenance version id
180 // * type - dev or patch marker; it can be either one alphabetical symbol (from 'a' to 'z')
181 // or 'rc' to point release candidate (case-insensitive)
182 // * dev - dev version or patch number
183 // All numerical values must be of range [1-99].
184 // Examples: 1.0, 6.5.0, 1.2.0a1, 3.3.3rc3 (release candidate 3), 11.0.0p1 (patch 1)
186 // - Versioning approach can be customized by implementing and using own resource manager class,
187 // see QtxResurceMgr, SUIT_ResourceMgr classes.
188 //////////////////////////////////////////////////////////////////////////////////////////////
190 if ( !myExtAppName.isEmpty() ) {
192 // On Windows, user file name is something like SalomeApp.xml.6.5.0 where
193 // - SalomeApp is an application name (can be customized)
194 // - xml is a file format (xml or ini)
195 // - 6.5.0 is an application version, can include alfa/beta/rc marks, e.g. 6.5.0a3, 6.5.0rc1
196 QRegExp exp( QString( "%1\\.%2\\.([a-zA-Z0-9.]+)" ).arg( myExtAppName ).arg( currentFormat() ) );
198 // On Linux, user file name is something like SalomeApprc.6.5.0 where
199 // - SalomeApp is an application name (can be customized)
200 // - 6.5.0 is an application version, can include alfa/beta/rc marks, e.g. 6.5.0a3, 6.5.0rc1
202 // VSR 24/09/2012: issue 0021781: since version 6.6.0 user filename is not prepended with "."
203 // when it is stored in the ~/.config/<appname> directory;
204 // for backward compatibility we also check files prepended with "." with lower priority
205 QRegExp exp( QString( "\\.?%1rc\\.([a-zA-Z0-9.]+)" ).arg( myExtAppName ) );
207 QString fname = QFileInfo( _fname ).fileName();
208 if ( exp.exactMatch( fname ) ) {
209 long fid = Qtx::versionToId( exp.cap( 1 ) );
210 if ( fid > 0 ) id = fid;
217 static QString myExtAppName;
218 static QString myExtAppVersion;
221 QString SALOME_ResourceMgr::myExtAppName = QString();
222 QString SALOME_ResourceMgr::myExtAppVersion = QString();
224 class SALOME_Session : public SUIT_Session
227 SALOME_Session() : SUIT_Session() {}
228 virtual ~SALOME_Session() {}
231 virtual SUIT_ResourceMgr* createResourceMgr( const QString& appName ) const
233 SALOME_ResourceMgr::initResourceMgr();
234 SALOME_ResourceMgr* resMgr = new SALOME_ResourceMgr( appName, QString( "%1Config" ) );
239 #ifdef ENABLE_TESTRECORDER
240 class SALOME_QApplication : public TestApplication
242 class SALOME_QApplication : public QApplication
246 #ifdef ENABLE_TESTRECORDER
247 SALOME_QApplication( int& argc, char** argv ) : TestApplication( argc, argv ), myHandler ( 0 ) {}
249 SALOME_QApplication( int& argc, char** argv )
251 // san: Opening an X display and choosing a visual most suitable for 3D visualization
252 // in order to make SALOME viewers work with non-native X servers
253 : QApplication( (Display*)Qtx::getDisplay(), argc, argv, Qtx::getVisual() ),
255 : QApplication( argc, argv ),
260 virtual bool notify( QObject* receiver, QEvent* e )
263 #ifdef ENABLE_TESTRECORDER
264 return myHandler ? myHandler->handle( receiver, e ) :
265 TestApplication::notify( receiver, e );
268 return myHandler ? myHandler->handle( receiver, e ) : QApplication::notify( receiver, e );
270 catch (std::exception& e) {
271 std::cerr << e.what() << std::endl;
273 catch (CORBA::Exception& e) {
274 std::cerr << "Caught CORBA::Exception" << std::endl;
277 CORBA::TypeCode_var tc = tmp.type();
278 const char *p = tc->name();
279 std::cerr << "notify(): CORBA exception of the kind : " << p << " is caught" << std::endl;
282 std::cerr << "Unknown exception caught in Qt handler: it's probably a bug in SALOME platform" << std::endl;
284 return false; // return false when exception is caught
287 SUIT_ExceptionHandler* handler() const { return myHandler; }
288 void setHandler( SUIT_ExceptionHandler* h ) { myHandler = h; }
291 SUIT_ExceptionHandler* myHandler;
294 // class which calls SALOME::Session::GetInterface() from another thread
295 // to avoid mutual lock ( if called from the same thread as main()
296 class GetInterfaceThread : public QThread
299 GetInterfaceThread( SALOME::Session_var s ) : session ( s )
306 if ( !CORBA::is_nil( session ) )
307 session->GetInterface();
309 printf( "\nFATAL ERROR: SALOME::Session object is nil! Can not display GUI\n\n" );
312 SALOME::Session_var session;
315 // returns true if 'str' is found in argv
316 bool isFound( const char* str, int argc, char** argv )
318 for ( int i = 1; i <= ( argc-1 ); i++ )
319 if ( !strcmp( argv[i], str ) )
326 SALOME_LifeCycleCORBA::killOmniNames();
329 // shutdown standalone servers
330 void shutdownServers( SALOME_NamingService* theNS )
332 SALOME_LifeCycleCORBA lcc(theNS);
333 lcc.shutdownServers();
336 // ---------------------------- MAIN -----------------------
337 int main( int argc, char **argv )
339 // Install Qt debug messages handler
340 qInstallMsgHandler( MessageOutput );
342 //Set a "native" graphic system in case if application runs on the remote host
343 QString remote(getenv("REMOTEHOST"));
344 QString client(getenv("SSH_CLIENT"));
345 if(remote.length() > 0 || client.length() > 0 ) {
346 QApplication::setGraphicsSystem(QLatin1String("native"));
349 // add $QTDIR/plugins to the pluins search path for image plugins
350 QString qtdir( ::getenv( "QTDIR" ) );
351 if ( !qtdir.isEmpty() )
352 QApplication::addLibraryPath( QDir( qtdir ).absoluteFilePath( "plugins" ) );
356 QApplication::setApplicationName( "salome" );
357 SUIT_ResourceMgr* resMgr = s.createResourceMgr( "SalomeApp" );
358 bool isCloc = resMgr->booleanValue( "language", "locale", true );
360 QLocale::setDefault( QLocale::c() );
363 QLocale::setDefault( QLocale::system() );
367 // Create Qt application instance;
368 // this should be done the very first!
369 SALOME_QApplication _qappl( argc, argv );
370 _qappl.setOrganizationName( "salome" );
371 _qappl.setApplicationName( "salome" );
372 _qappl.setApplicationVersion( salomeVersion() );
374 // Add application library path (to search style plugin etc...)
375 QString path = QDir::convertSeparators( SUIT_Tools::addSlash( QString( ::getenv( "GUI_ROOT_DIR" ) ) ) + QString( "bin/salome" ) );
376 _qappl.addLibraryPath( path );
378 bool isGUI = isFound( "GUI", argc, argv );
379 bool isSplash = isFound( "SPLASH", argc, argv );
380 // Show splash screen (only if both the "GUI" and "SPLASH" parameters are set)
381 // Note, that user preferences are not taken into account for splash settings -
382 // it is a property of the application!
383 QtxSplash* splash = 0;
384 if ( isGUI && isSplash ) {
385 // ...create resource manager
386 SUIT_ResourceMgr resMgr( "SalomeApp", QString( "%1Config" ) );
387 resMgr.setCurrentFormat( "xml" );
388 resMgr.setWorkingMode( QtxResourceMgr::IgnoreUserValues );
389 resMgr.loadLanguage( "LightApp" );
391 splash = QtxSplash::splash( QPixmap() );
392 splash->readSettings( &resMgr );
393 if ( splash->pixmap().isNull() )
394 splash->setPixmap( resMgr.loadPixmap( "LightApp", QObject::tr( "ABOUT_SPLASH" ) ) );
395 if ( splash->pixmap().isNull() ) {
400 splash->setOption( "%A", QObject::tr( "APP_NAME" ) );
401 splash->setOption( "%V", QObject::tr( "ABOUT_VERSION" ).arg( salomeVersion() ) );
402 splash->setOption( "%L", QObject::tr( "ABOUT_LICENSE" ) );
403 splash->setOption( "%C", QObject::tr( "ABOUT_COPYRIGHT" ) );
405 QApplication::instance()->processEvents();
414 PortableServer::POA_var poa;
416 SUIT_Session* aGUISession = 0;
417 SALOME_NamingService* _NS = 0;
418 GetInterfaceThread* guiThread = 0;
419 Session_ServerLauncher* myServerLauncher = 0;
422 // ...initialize Python (only once)
424 char* _argv[] = {(char*)""};
425 KERNEL_PYTHON::init_python( _argc,_argv );
427 // ...create ORB, get RootPOA object, NamingService, etc.
428 ORB_INIT &init = *SINGLETON_<ORB_INIT>::Instance();
429 ASSERT( SINGLETON_<ORB_INIT>::IsAlreadyExisting() );
431 orb = init( orbArgc, argv );
433 CORBA::Object_var obj = orb->resolve_initial_references( "RootPOA" );
434 poa = PortableServer::POA::_narrow( obj );
436 PortableServer::POAManager_var pman = poa->the_POAManager();
438 MESSAGE( "pman->activate()" );
440 _NS = new SALOME_NamingService( orb );
444 catch ( SALOME_Exception& e ) {
445 INFOS( "run(): SALOME::SALOME_Exception is caught: "<<e.what() );
447 catch ( CORBA::SystemException& e ) {
448 INFOS( "Caught CORBA::SystemException." );
450 catch ( CORBA::Exception& e ) {
451 INFOS( "Caught CORBA::Exception." );
454 CORBA::TypeCode_var tc = tmp.type();
455 const char *p = tc->name();
456 INFOS ( "run(): CORBA exception of the kind : "<<p<< " is caught" );
458 catch ( std::exception& e ) {
459 INFOS( "run(): An exception has been caught: " <<e.what() );
462 INFOS( "Caught unknown exception." );
465 QMutex _GUIMutex, _SessionMutex, _SplashMutex;
466 QWaitCondition _ServerLaunch, _SessionStarted, _SplashStarted;
468 // lock session mutex to ensure that GetInterface is not called
469 // until all initialization is done
470 _SessionMutex.lock();
473 // Start embedded servers launcher (Registry, SALOMEDS, etc.)
474 // ...lock mutex to block embedded servers launching thread until wait( mutex )
476 // ...create launcher
477 myServerLauncher = new Session_ServerLauncher( argc, argv, orb, poa, &_GUIMutex, &_ServerLaunch, &_SessionMutex, &_SessionStarted );
478 // ...block this thread until launcher is ready
479 _ServerLaunch.wait( &_GUIMutex );
481 // Start servers check thread (splash)
483 // ...lock mutex to block splash thread until wait( mutex )
485 // ...create servers checking thread
486 Session_ServerCheck sc( &_SplashMutex, &_SplashStarted );
487 // ... set initial progress
488 splash->setProgress( 0, sc.totalSteps() );
491 int step = sc.currentStep();
492 int total = sc.totalSteps();
493 QString msg = sc.currentMessage();
494 QString err = sc.error();
495 if ( !err.isEmpty() ) {
496 QtxSplash::setError( err );
497 QApplication::instance()->processEvents();
501 QtxSplash::setStatus( msg, step );
502 QApplication::instance()->processEvents();
505 // ...block this thread until servers checking is finished
506 _SplashStarted.wait( &_SplashMutex );
508 // ...unlock mutex 'cause it is no more needed
509 _SplashMutex.unlock();
512 // Finalize embedded servers launcher
513 // ...block this thread until launcher is finished
514 _ServerLaunch.wait( &_GUIMutex );
515 // ...unlock mutex 'cause it is no more needed
519 // Obtain Session interface reference
520 CORBA::Object_var obj = _NS->Resolve( "/Kernel/Session" );
521 SALOME::Session_var session = SALOME::Session::_narrow( obj ) ;
523 bool shutdownAll = false;
524 bool shutdownSession = false;
526 // Launch GUI activator
529 splash->setStatus( QApplication::translate( "", "Activating desktop..." ) );
530 // ...create GUI launcher
531 MESSAGE( "Session activated, Launch IAPP..." );
532 guiThread = new GetInterfaceThread( session );
536 // Allow multiple activation/deactivation of GUI
538 MESSAGE( "waiting wakeAll()" );
539 _SessionStarted.wait( &_SessionMutex ); // to be reseased by Launch server thread when ready:
540 // atomic operation lock - unlock on mutex
541 // unlock mutex: serverThread runs, calls _ServerLaunch->wakeAll()
542 // this thread wakes up, and lock mutex
544 _SessionMutex.unlock();
546 // Session might be shutdowning here, check status
547 SALOME::StatSession stat = session->GetStatSession();
548 shutdownSession = stat.state == SALOME::shutdown;
549 if ( shutdownSession ) {
550 _SessionMutex.lock(); // lock mutex before leaving loop - it will be unlocked later
554 // SUIT_Session creation
555 aGUISession = new SALOME_Session();
557 // Load SalomeApp dynamic library
558 MESSAGE( "creation SUIT_Application" );
559 SUIT_Application* aGUIApp = aGUISession->startApplication( "SalomeApp", 0, 0 );
562 Style_Salome::initialize( aGUIApp->resourceMgr() );
563 if ( aGUIApp->resourceMgr()->booleanValue( "Style", "use_salome_style", true ) )
564 Style_Salome::apply();
566 if ( !isFound( "noexcepthandler", argc, argv ) )
567 _qappl.setHandler( aGUISession->handler() ); // after loading SalomeApp application
568 // aGUISession contains SalomeApp_ExceptionHandler
570 MESSAGE( "run(): starting the main event loop" );
573 splash->finish( aGUIApp->desktop() );
575 result = _qappl.exec();
579 if ( result == SUIT_Session::NORMAL ) {
580 // desktop is explicitly closed by user from GUI
581 // exit flags says if it's necessary to shutdown all servers
582 // all session server only
583 shutdownAll = aGUISession->exitFlags();
586 // desktop might be closed from:
587 // - StopSesion() /temporarily/ or
588 // - Shutdown() /permanently/
589 stat = session->GetStatSession();
590 shutdownSession = stat.state == SALOME::shutdown;
592 if ( shutdownAll || shutdownSession ) {
593 _SessionMutex.lock(); // lock mutex before leaving loop - it will be unlocked later
601 // Prepare _GUIMutex for a new GUI activation
602 _SessionMutex.lock();
606 // unlock Session mutex
607 _SessionMutex.unlock();
609 if ( myServerLauncher )
610 myServerLauncher->ShutdownAll(); // shutdown embedded servers
612 if ( shutdownAll ) // shutdown standalone servers
613 shutdownServers( _NS );
615 if ( myServerLauncher )
616 myServerLauncher->KillAll(); // kill embedded servers
618 // Unregister session server
619 SALOME_Session_i* sessionServant = dynamic_cast<SALOME_Session_i*>( poa->reference_to_servant( session.in() ) );
620 if ( sessionServant )
621 sessionServant->NSunregister();
625 delete myServerLauncher;
632 //////////////////////////////////////////////////////////////
633 // VSR: silently skip exception:
634 // CORBA.BAD_INV_ORDER.BAD_INV_ORDER_ORBHasShutdown
635 // exception is raised when orb->destroy() is called and
636 // cpp continer is launched in the embedded mode
637 //////////////////////////////////////////////////////////////
638 // std::cerr << "Caught unexpected exception on shutdown : ignored !!" << std::endl;
641 abort(); //abort program to avoid deadlock in destructors or atexit when shutdown has been interrupted
644 //Destroy orb from python (for chasing memory leaks)
645 //PyRun_SimpleString("from omniORB import CORBA");
646 //PyRun_SimpleString("orb=CORBA.ORB_init([''], CORBA.ORB_ID)");
647 //PyRun_SimpleString("orb.destroy()");
650 MESSAGE("Explicitely destroying the ORB (hoping to kill omniORB threads ...)");
651 ORB_INIT * init = SINGLETON_<ORB_INIT>::Instance();
653 init->explicit_destroy();
655 // After ORB destruction
656 if(Py_IsInitialized())
665 MESSAGE( "Salome_Session_Server:endofserver" );