1 // Copyright (C) 2007-2013 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.
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 );
114 static const char* pixmap_not_found_xpm[] = {
136 QString salomeVersion()
138 return GUI_VERSION_STR;
141 class SALOME_ResourceMgr : public SUIT_ResourceMgr
144 SALOME_ResourceMgr( const QString& app, const QString& resVarTemplate ) : SUIT_ResourceMgr( app, resVarTemplate )
146 setCurrentFormat( "xml" );
147 setOption( "translators", QString( "%P_msg_%L.qm|%P_icons.qm|%P_images.qm" ) );
148 setDefaultPixmap( QPixmap( pixmap_not_found_xpm ) );
150 static void initResourceMgr()
152 if ( myExtAppName.isNull() || myExtAppVersion.isNull() ) {
153 SALOME_ResourceMgr resMgr( "SalomeApp", QString( "%1Config" ) );
154 resMgr.loadLanguage( "LightApp", "en" );
155 resMgr.loadLanguage( "SalomeApp", "en" );
157 myExtAppName = QObject::tr( "APP_NAME" ).trimmed();
158 if ( myExtAppName == "APP_NAME" || myExtAppName.toLower() == "salome" )
159 myExtAppName = "SalomeApp";
160 myExtAppVersion = QObject::tr( "APP_VERSION" );
161 if ( myExtAppVersion == "APP_VERSION" ) {
162 if ( myExtAppName != "SalomeApp" )
163 myExtAppVersion = "";
164 else myExtAppVersion = salomeVersion();
168 QString version() const { return myExtAppVersion; }
171 QString userFileName( const QString& appName, const bool for_load ) const
173 if ( version().isEmpty() ) return "";
174 return SUIT_ResourceMgr::userFileName( myExtAppName, for_load );
177 virtual long userFileId( const QString& _fname ) const
179 //////////////////////////////////////////////////////////////////////////////////////////////
180 // In SALOME and SALOME-based applications the user preferences file is named as
181 // - <AppName>.xml.<AppVersion> on Windows
182 // - <AppName>rc.<AppVersion> on Linux
184 // * AppName is application name, default SalomeApp (can be customized in SALOME-based
186 // * AppVersion is application version
188 // Since version 6.5.0 of SALOME, user file is situated in the ~/.config/salome
189 // directory. For backward compatibility, when user preferences from nearest
190 // version of application is searched, user home directory is also looked through,
191 // with lower priority.
193 // Since version 6.6.0 of SALOME, user file name on Linux is no more prefixed by dot
194 // symbol since it is situated in hidden ~/.config/salome directory. Files with dot
195 // prefix also though taken into account (with lower priority) for backward compatibility.
198 // - Currently the following format of version number is supported:
199 // <major>[.<minor>[.<release>[<type><dev>]]]
200 // Parts in square brackets are considered optional. Here:
201 // * major - major version id
202 // * minor - minor version id
203 // * release - maintenance version id
204 // * type - dev or patch marker; it can be either one alphabetical symbol (from 'a' to 'z')
205 // or 'rc' to point release candidate (case-insensitive)
206 // * dev - dev version or patch number
207 // All numerical values must be of range [1-99].
208 // Examples: 1.0, 6.5.0, 1.2.0a1, 3.3.3rc3 (release candidate 3), 11.0.0p1 (patch 1)
210 // - Versioning approach can be customized by implementing and using own resource manager class,
211 // see QtxResurceMgr, SUIT_ResourceMgr classes.
212 //////////////////////////////////////////////////////////////////////////////////////////////
214 if ( !myExtAppName.isEmpty() ) {
216 // On Windows, user file name is something like SalomeApp.xml.6.5.0 where
217 // - SalomeApp is an application name (can be customized)
218 // - xml is a file format (xml or ini)
219 // - 6.5.0 is an application version, can include alfa/beta/rc marks, e.g. 6.5.0a3, 6.5.0rc1
220 QRegExp exp( QString( "%1\\.%2\\.([a-zA-Z0-9.]+)" ).arg( myExtAppName ).arg( currentFormat() ) );
222 // On Linux, user file name is something like SalomeApprc.6.5.0 where
223 // - SalomeApp is an application name (can be customized)
224 // - 6.5.0 is an application version, can include alfa/beta/rc marks, e.g. 6.5.0a3, 6.5.0rc1
226 // VSR 24/09/2012: issue 0021781: since version 6.6.0 user filename is not prepended with "."
227 // when it is stored in the ~/.config/<appname> directory;
228 // for backward compatibility we also check files prepended with "." with lower priority
229 QRegExp exp( QString( "\\.?%1rc\\.([a-zA-Z0-9.]+)" ).arg( myExtAppName ) );
231 QRegExp vers_exp( "^([0-9]+)([A-Z]|RC)?([0-9]*)", Qt::CaseInsensitive );
233 QString fname = QFileInfo( _fname ).fileName();
234 if( exp.exactMatch( fname ) ) {
235 QStringList vers = exp.cap( 1 ).split( ".", QString::SkipEmptyParts );
236 int major=0, minor=0;
237 int release = 0, dev1 = 0, dev2 = 0;
238 if ( vers.count() > 0 ) major = vers[0].toInt();
239 if ( vers.count() > 1 ) minor = vers[1].toInt();
240 if ( vers.count() > 2 ) {
241 if ( vers_exp.indexIn( vers[2] ) != -1 ) {
242 release = vers_exp.cap( 1 ).toInt();
243 QString tag = vers_exp.cap( 2 ).toLower();
244 if ( !tag.isEmpty() ) {
245 if ( tag == "rc" ) // release candidate
246 dev1 = 49; // 'rc'=49
248 dev1 = (int)( tag[ 0 ].toLatin1() ) - (int)( QChar('a').toLatin1() ) + 1; // 'a'=1, 'b'=2, ..., 'z'=26
250 if ( !vers_exp.cap( 3 ).isEmpty() )
251 dev2 = vers_exp.cap( 3 ).toInt();
255 int dev = dev1*100+dev2;
258 id*=100; id+=release;
260 if ( dev > 0 ) id-=dev;
267 static QString myExtAppName;
268 static QString myExtAppVersion;
271 QString SALOME_ResourceMgr::myExtAppName = QString();
272 QString SALOME_ResourceMgr::myExtAppVersion = QString();
274 class SALOME_Session : public SUIT_Session
277 SALOME_Session() : SUIT_Session() {}
278 virtual ~SALOME_Session() {}
281 virtual SUIT_ResourceMgr* createResourceMgr( const QString& appName ) const
283 SALOME_ResourceMgr::initResourceMgr();
284 SALOME_ResourceMgr* resMgr = new SALOME_ResourceMgr( appName, QString( "%1Config" ) );
289 #ifdef ENABLE_TESTRECORDER
290 class SALOME_QApplication : public TestApplication
292 class SALOME_QApplication : public QApplication
296 #ifdef ENABLE_TESTRECORDER
297 SALOME_QApplication( int& argc, char** argv ) : TestApplication( argc, argv ), myHandler ( 0 ) {}
299 SALOME_QApplication( int& argc, char** argv )
301 // san: Opening an X display and choosing a visual most suitable for 3D visualization
302 // in order to make SALOME viewers work with non-native X servers
303 : QApplication( (Display*)Qtx::getDisplay(), argc, argv, Qtx::getVisual() ),
305 : QApplication( argc, argv ),
310 virtual bool notify( QObject* receiver, QEvent* e )
312 #if OCC_VERSION_LARGE < 0x06010100
313 // Disable GUI user actions while python command is executed
314 if (SUIT_Session::IsPythonExecuted()) {
315 // Disable mouse and keyboard events
316 QEvent::Type aType = e->type();
317 if (aType == QEvent::MouseButtonPress || aType == QEvent::MouseButtonRelease ||
318 aType == QEvent::MouseButtonDblClick || aType == QEvent::MouseMove ||
319 aType == QEvent::Wheel || aType == QEvent::ContextMenu ||
320 aType == QEvent::KeyPress || aType == QEvent::KeyRelease ||
321 aType == QEvent::Accel || aType == QEvent::AccelOverride)
326 #ifdef ENABLE_TESTRECORDER
327 return myHandler ? myHandler->handle( receiver, e ) :
328 TestApplication::notify( receiver, e );
331 return myHandler ? myHandler->handle( receiver, e ) : QApplication::notify( receiver, e );
333 catch (std::exception& e) {
334 std::cerr << e.what() << std::endl;
336 catch (CORBA::Exception& e) {
337 std::cerr << "Caught CORBA::Exception" << std::endl;
340 CORBA::TypeCode_var tc = tmp.type();
341 const char *p = tc->name();
342 std::cerr << "notify(): CORBA exception of the kind : " << p << " is caught" << std::endl;
345 std::cerr << "Unknown exception caught in Qt handler: it's probably a bug in SALOME platform" << std::endl;
347 return false; // return false when exception is caught
350 SUIT_ExceptionHandler* handler() const { return myHandler; }
351 void setHandler( SUIT_ExceptionHandler* h ) { myHandler = h; }
354 SUIT_ExceptionHandler* myHandler;
357 // class which calls SALOME::Session::GetInterface() from another thread
358 // to avoid mutual lock ( if called from the same thread as main()
359 class GetInterfaceThread : public QThread
362 GetInterfaceThread( SALOME::Session_var s ) : session ( s )
369 if ( !CORBA::is_nil( session ) )
370 session->GetInterface();
372 printf( "\nFATAL ERROR: SALOME::Session object is nil! Can not display GUI\n\n" );
375 SALOME::Session_var session;
378 // returns true if 'str' is found in argv
379 bool isFound( const char* str, int argc, char** argv )
381 for ( int i = 1; i <= ( argc-1 ); i++ )
382 if ( !strcmp( argv[i], str ) )
389 SALOME_LifeCycleCORBA::killOmniNames();
392 // shutdown standalone servers
393 void shutdownServers( SALOME_NamingService* theNS )
395 SALOME_LifeCycleCORBA lcc(theNS);
396 lcc.shutdownServers();
399 // ---------------------------- MAIN -----------------------
400 int main( int argc, char **argv )
402 // Install Qt debug messages handler
403 qInstallMsgHandler( MessageOutput );
405 //Set a "native" graphic system in case if application runs on the remote host
406 QString remote(getenv("REMOTEHOST"));
407 QString client(getenv("SSH_CLIENT"));
408 if(remote.length() > 0 || client.length() > 0 ) {
409 QApplication::setGraphicsSystem(QLatin1String("native"));
412 // add $QTDIR/plugins to the pluins search path for image plugins
413 QString qtdir( ::getenv( "QTDIR" ) );
414 if ( !qtdir.isEmpty() )
415 QApplication::addLibraryPath( QDir( qtdir ).absoluteFilePath( "plugins" ) );
417 // Create Qt application instance;
418 // this should be done the very first!
419 SALOME_QApplication _qappl( argc, argv );
420 _qappl.setOrganizationName( "salome" );
421 _qappl.setApplicationName( "salome" );
422 _qappl.setApplicationVersion( salomeVersion() );
424 // Add application library path (to search style plugin etc...)
425 QString path = QDir::convertSeparators( SUIT_Tools::addSlash( QString( ::getenv( "GUI_ROOT_DIR" ) ) ) + QString( "bin/salome" ) );
426 _qappl.addLibraryPath( path );
428 bool isGUI = isFound( "GUI", argc, argv );
429 bool isSplash = isFound( "SPLASH", argc, argv );
430 // Show splash screen (only if both the "GUI" and "SPLASH" parameters are set)
431 // Note, that user preferences are not taken into account for splash settings -
432 // it is a property of the application!
433 QtxSplash* splash = 0;
434 if ( isGUI && isSplash ) {
435 // ...create resource manager
436 SUIT_ResourceMgr resMgr( "SalomeApp", QString( "%1Config" ) );
437 resMgr.setCurrentFormat( "xml" );
438 resMgr.setWorkingMode( QtxResourceMgr::IgnoreUserValues );
439 resMgr.loadLanguage( "LightApp" );
441 splash = QtxSplash::splash( QPixmap() );
442 splash->readSettings( &resMgr );
443 if ( splash->pixmap().isNull() )
444 splash->setPixmap( resMgr.loadPixmap( "LightApp", QObject::tr( "ABOUT_SPLASH" ) ) );
445 if ( splash->pixmap().isNull() ) {
450 splash->setOption( "%A", QObject::tr( "APP_NAME" ) );
451 splash->setOption( "%V", QObject::tr( "ABOUT_VERSION" ).arg( salomeVersion() ) );
452 splash->setOption( "%L", QObject::tr( "ABOUT_LICENSE" ) );
453 splash->setOption( "%C", QObject::tr( "ABOUT_COPYRIGHT" ) );
455 QApplication::instance()->processEvents();
464 PortableServer::POA_var poa;
466 SUIT_Session* aGUISession = 0;
467 SALOME_NamingService* _NS = 0;
468 GetInterfaceThread* guiThread = 0;
469 Session_ServerLauncher* myServerLauncher = 0;
472 // ...initialize Python (only once)
474 char* _argv[] = {(char*)""};
475 KERNEL_PYTHON::init_python( _argc,_argv );
477 // ...create ORB, get RootPOA object, NamingService, etc.
478 ORB_INIT &init = *SINGLETON_<ORB_INIT>::Instance();
479 ASSERT( SINGLETON_<ORB_INIT>::IsAlreadyExisting() );
481 orb = init( orbArgc, argv );
483 CORBA::Object_var obj = orb->resolve_initial_references( "RootPOA" );
484 poa = PortableServer::POA::_narrow( obj );
486 PortableServer::POAManager_var pman = poa->the_POAManager();
488 MESSAGE( "pman->activate()" );
490 _NS = new SALOME_NamingService( orb );
494 catch ( SALOME_Exception& e ) {
495 INFOS( "run(): SALOME::SALOME_Exception is caught: "<<e.what() );
497 catch ( CORBA::SystemException& e ) {
498 INFOS( "Caught CORBA::SystemException." );
500 catch ( CORBA::Exception& e ) {
501 INFOS( "Caught CORBA::Exception." );
504 CORBA::TypeCode_var tc = tmp.type();
505 const char *p = tc->name();
506 INFOS ( "run(): CORBA exception of the kind : "<<p<< " is caught" );
508 catch ( std::exception& e ) {
509 INFOS( "run(): An exception has been caught: " <<e.what() );
512 INFOS( "Caught unknown exception." );
515 QMutex _GUIMutex, _SessionMutex, _SplashMutex;
516 QWaitCondition _ServerLaunch, _SessionStarted, _SplashStarted;
518 // lock session mutex to ensure that GetInterface is not called
519 // until all initialization is done
520 _SessionMutex.lock();
523 // Start embedded servers launcher (Registry, SALOMEDS, etc.)
524 // ...lock mutex to block embedded servers launching thread until wait( mutex )
526 // ...create launcher
527 myServerLauncher = new Session_ServerLauncher( argc, argv, orb, poa, &_GUIMutex, &_ServerLaunch, &_SessionMutex, &_SessionStarted );
528 // ...block this thread until launcher is ready
529 _ServerLaunch.wait( &_GUIMutex );
531 // Start servers check thread (splash)
533 // ...lock mutex to block splash thread until wait( mutex )
535 // ...create servers checking thread
536 Session_ServerCheck sc( &_SplashMutex, &_SplashStarted );
537 // ... set initial progress
538 splash->setProgress( 0, sc.totalSteps() );
541 int step = sc.currentStep();
542 int total = sc.totalSteps();
543 QString msg = sc.currentMessage();
544 QString err = sc.error();
545 if ( !err.isEmpty() ) {
546 QtxSplash::setError( err );
547 QApplication::instance()->processEvents();
551 QtxSplash::setStatus( msg, step );
552 QApplication::instance()->processEvents();
555 // ...block this thread until servers checking is finished
556 _SplashStarted.wait( &_SplashMutex );
558 // ...unlock mutex 'cause it is no more needed
559 _SplashMutex.unlock();
562 // Finalize embedded servers launcher
563 // ...block this thread until launcher is finished
564 _ServerLaunch.wait( &_GUIMutex );
565 // ...unlock mutex 'cause it is no more needed
569 // Obtain Session interface reference
570 CORBA::Object_var obj = _NS->Resolve( "/Kernel/Session" );
571 SALOME::Session_var session = SALOME::Session::_narrow( obj ) ;
573 bool shutdownAll = false;
574 bool shutdownSession = false;
576 // Launch GUI activator
579 splash->setStatus( QApplication::translate( "", "Activating desktop..." ) );
580 // ...create GUI launcher
581 MESSAGE( "Session activated, Launch IAPP..." );
582 guiThread = new GetInterfaceThread( session );
586 // Allow multiple activation/deactivation of GUI
588 MESSAGE( "waiting wakeAll()" );
589 _SessionStarted.wait( &_SessionMutex ); // to be reseased by Launch server thread when ready:
590 // atomic operation lock - unlock on mutex
591 // unlock mutex: serverThread runs, calls _ServerLaunch->wakeAll()
592 // this thread wakes up, and lock mutex
594 _SessionMutex.unlock();
596 // Session might be shutdowning here, check status
597 SALOME::StatSession stat = session->GetStatSession();
598 shutdownSession = stat.state == SALOME::shutdown;
599 if ( shutdownSession ) {
600 _SessionMutex.lock(); // lock mutex before leaving loop - it will be unlocked later
604 // SUIT_Session creation
605 aGUISession = new SALOME_Session();
607 // Load SalomeApp dynamic library
608 MESSAGE( "creation SUIT_Application" );
609 SUIT_Application* aGUIApp = aGUISession->startApplication( "SalomeApp", 0, 0 );
612 Style_Salome::initialize( aGUIApp->resourceMgr() );
613 if ( aGUIApp->resourceMgr()->booleanValue( "Style", "use_salome_style", true ) )
614 Style_Salome::apply();
616 if ( !isFound( "noexcepthandler", argc, argv ) )
617 _qappl.setHandler( aGUISession->handler() ); // after loading SalomeApp application
618 // aGUISession contains SalomeApp_ExceptionHandler
620 MESSAGE( "run(): starting the main event loop" );
623 splash->finish( aGUIApp->desktop() );
625 result = _qappl.exec();
629 if ( result == SUIT_Session::NORMAL ) {
630 // desktop is explicitly closed by user from GUI
631 // exit flags says if it's necessary to shutdown all servers
632 // all session server only
633 shutdownAll = aGUISession->exitFlags();
636 // desktop might be closed from:
637 // - StopSesion() /temporarily/ or
638 // - Shutdown() /permanently/
639 stat = session->GetStatSession();
640 shutdownSession = stat.state == SALOME::shutdown;
642 if ( shutdownAll || shutdownSession ) {
643 _SessionMutex.lock(); // lock mutex before leaving loop - it will be unlocked later
651 // Prepare _GUIMutex for a new GUI activation
652 _SessionMutex.lock();
656 // unlock Session mutex
657 _SessionMutex.unlock();
659 if ( myServerLauncher )
660 myServerLauncher->ShutdownAll(); // shutdown embedded servers
662 if ( shutdownAll ) // shutdown standalone servers
663 shutdownServers( _NS );
665 if ( myServerLauncher )
666 myServerLauncher->KillAll(); // kill embedded servers
668 // Unregister session server
669 SALOME_Session_i* sessionServant = dynamic_cast<SALOME_Session_i*>( poa->reference_to_servant( session.in() ) );
670 if ( sessionServant )
671 sessionServant->NSunregister();
675 delete myServerLauncher;
682 //////////////////////////////////////////////////////////////
683 // VSR: silently skip exception:
684 // CORBA.BAD_INV_ORDER.BAD_INV_ORDER_ORBHasShutdown
685 // exception is raised when orb->destroy() is called and
686 // cpp continer is launched in the embedded mode
687 //////////////////////////////////////////////////////////////
688 // std::cerr << "Caught unexpected exception on shutdown : ignored !!" << std::endl;
691 abort(); //abort program to avoid deadlock in destructors or atexit when shutdown has been interrupted
695 //Destroy orb from python (for chasing memory leaks)
696 //PyRun_SimpleString("from omniORB import CORBA");
697 //PyRun_SimpleString("orb=CORBA.ORB_init([''], CORBA.ORB_ID)");
698 //PyRun_SimpleString("orb.destroy()");
704 MESSAGE( "Salome_Session_Server:endofserver" );