sm.cpp

00001 /*****************************************************************
00002  KWin - the KDE window manager
00003  This file is part of the KDE project.
00004 
00005 Copyright (C) 1999, 2000 Matthias Ettrich <ettrich@kde.org>
00006 Copyright (C) 2003 Lubos Lunak <l.lunak@kde.org>
00007 
00008 You can Freely distribute this program under the GNU General Public
00009 License. See the file "COPYING" for the exact licensing terms.
00010 ******************************************************************/
00011 
00012 #include "sm.h"
00013 
00014 #include <qsocketnotifier.h>
00015 #include <qsessionmanager.h>
00016 #include <kdebug.h>
00017 #include <unistd.h>
00018 #include <stdlib.h>
00019 #include <pwd.h>
00020 #include <fixx11h.h>
00021 #include <kconfig.h>
00022 #include <kglobal.h>
00023 
00024 #include "workspace.h"
00025 #include "client.h"
00026 
00027 namespace KWinInternal
00028 {
00029 
00030 bool SessionManaged::saveState( QSessionManager& sm )
00031     {
00032     // If the session manager is ksmserver, save stacking
00033     // order, active window, active desktop etc. in phase 1,
00034     // as ksmserver assures no interaction will be done
00035     // before the WM finishes phase 1. Saving in phase 2 is
00036     // too late, as possible user interaction may change some things.
00037     // Phase2 is still needed though (ICCCM 5.2)
00038     char* sm_vendor = SmcVendor( static_cast< SmcConn >( sm.handle()));
00039     bool ksmserver = qstrcmp( sm_vendor, "KDE" ) == 0;
00040     free( sm_vendor );
00041     if ( !sm.isPhase2() )
00042         {
00043         Workspace::self()->sessionSaveStarted();
00044         if( ksmserver ) // save stacking order etc. before "save file?" etc. dialogs change it
00045             Workspace::self()->storeSession( kapp->sessionConfig(), SMSavePhase0 );
00046         sm.release(); // Qt doesn't automatically release in this case (bug?)
00047         sm.requestPhase2();
00048         return true;
00049         }
00050     Workspace::self()->storeSession( kapp->sessionConfig(), ksmserver ? SMSavePhase2 : SMSavePhase2Full );
00051     kapp->sessionConfig()->sync();
00052     return true;
00053     }
00054 
00055 // I bet this is broken, just like everywhere else in KDE
00056 bool SessionManaged::commitData( QSessionManager& sm )
00057     {
00058     if ( !sm.isPhase2() )
00059         Workspace::self()->sessionSaveStarted();
00060     return true;
00061     }
00062 
00063 // Workspace
00064 
00070 void Workspace::storeSession( KConfig* config, SMSavePhase phase )
00071     {
00072     config->setGroup("Session" );
00073     int count =  0;
00074     int active_client = -1;
00075     for (ClientList::Iterator it = clients.begin(); it != clients.end(); ++it) 
00076         {
00077         Client* c = (*it);
00078         QCString sessionId = c->sessionId();
00079         QCString wmCommand = c->wmCommand();
00080         if ( sessionId.isEmpty() )
00081         // remember also applications that are not XSMP capable
00082         // and use the obsolete WM_COMMAND / WM_SAVE_YOURSELF
00083             if ( wmCommand.isEmpty() )
00084                 continue;
00085         count++;
00086         if( c->isActive())
00087             active_client = count;
00088         QString n = QString::number(count);
00089         if( phase == SMSavePhase2 || phase == SMSavePhase2Full )
00090             {
00091             config->writeEntry( QString("sessionId")+n, sessionId.data() );
00092             config->writeEntry( QString("windowRole")+n, c->windowRole().data() );
00093             config->writeEntry( QString("wmCommand")+n, wmCommand.data() );
00094             config->writeEntry( QString("wmClientMachine")+n, c->wmClientMachine( true ).data() );
00095             config->writeEntry( QString("resourceName")+n, c->resourceName().data() );
00096             config->writeEntry( QString("resourceClass")+n, c->resourceClass().data() );
00097             config->writeEntry( QString("geometry")+n,  QRect( c->calculateGravitation(TRUE), c->clientSize() ) ); // FRAME
00098             config->writeEntry( QString("restore")+n, c->geometryRestore() );
00099             config->writeEntry( QString("fsrestore")+n, c->geometryFSRestore() );
00100             config->writeEntry( QString("maximize")+n, (int) c->maximizeMode() );
00101             config->writeEntry( QString("fullscreen")+n, (int) c->fullScreenMode() );
00102             config->writeEntry( QString("desktop")+n, c->desktop() );
00103             // the config entry is called "iconified" for back. comp. reasons
00104             // (kconf_update script for updating session files would be too complicated)
00105             config->writeEntry( QString("iconified")+n, c->isMinimized() );
00106             // the config entry is called "sticky" for back. comp. reasons
00107             config->writeEntry( QString("sticky")+n, c->isOnAllDesktops() );
00108             config->writeEntry( QString("shaded")+n, c->isShade() );
00109             // the config entry is called "staysOnTop" for back. comp. reasons
00110             config->writeEntry( QString("staysOnTop")+n, c->keepAbove() );
00111             config->writeEntry( QString("keepBelow")+n, c->keepBelow() );
00112             config->writeEntry( QString("skipTaskbar")+n, c->skipTaskbar( true ) );
00113             config->writeEntry( QString("skipPager")+n, c->skipPager() );
00114             config->writeEntry( QString("userNoBorder")+n, c->isUserNoBorder() );
00115             config->writeEntry( QString("windowType")+n, windowTypeToTxt( c->windowType()));
00116             config->writeEntry( QString("shortcut")+n, c->shortcut().toStringInternal());
00117             }
00118         }
00119     // TODO store also stacking order
00120     if( phase == SMSavePhase0 )
00121         {
00122         // it would be much simpler to save these values to the config file,
00123         // but both Qt and KDE treat phase1 and phase2 separately,
00124         // which results in different sessionkey and different config file :(
00125         session_active_client = active_client;
00126         session_desktop = currentDesktop();
00127         }
00128     else if( phase == SMSavePhase2 )
00129         {
00130         config->writeEntry( "count", count );
00131         config->writeEntry( "active", session_active_client );
00132         config->writeEntry( "desktop", session_desktop );
00133         }
00134     else // SMSavePhase2Full
00135         {
00136         config->writeEntry( "count", count );
00137         config->writeEntry( "active", session_active_client );
00138         config->writeEntry( "desktop", currentDesktop());
00139         }
00140     }
00141 
00142 
00148 void Workspace::loadSessionInfo()
00149     {
00150     session.clear();
00151     KConfig* config = kapp->sessionConfig();
00152     config->setGroup("Session" );
00153     int count =  config->readNumEntry( "count" );
00154     int active_client = config->readNumEntry( "active" );
00155     for ( int i = 1; i <= count; i++ ) 
00156         {
00157         QString n = QString::number(i);
00158         SessionInfo* info = new SessionInfo;
00159         session.append( info );
00160         info->sessionId = config->readEntry( QString("sessionId")+n ).latin1();
00161         info->windowRole = config->readEntry( QString("windowRole")+n ).latin1();
00162         info->wmCommand = config->readEntry( QString("wmCommand")+n ).latin1();
00163         info->wmClientMachine = config->readEntry( QString("wmClientMachine")+n ).latin1();
00164         info->resourceName = config->readEntry( QString("resourceName")+n ).latin1();
00165         info->resourceClass = config->readEntry( QString("resourceClass")+n ).lower().latin1();
00166         info->geometry = config->readRectEntry( QString("geometry")+n );
00167         info->restore = config->readRectEntry( QString("restore")+n );
00168         info->fsrestore = config->readRectEntry( QString("fsrestore")+n );
00169         info->maximized = config->readNumEntry( QString("maximize")+n, 0 );
00170         info->fullscreen = config->readNumEntry( QString("fullscreen")+n, 0 );
00171         info->desktop = config->readNumEntry( QString("desktop")+n, 0 );
00172         info->minimized = config->readBoolEntry( QString("iconified")+n, FALSE );
00173         info->onAllDesktops = config->readBoolEntry( QString("sticky")+n, FALSE );
00174         info->shaded = config->readBoolEntry( QString("shaded")+n, FALSE );
00175         info->keepAbove = config->readBoolEntry( QString("staysOnTop")+n, FALSE  );
00176         info->keepBelow = config->readBoolEntry( QString("keepBelow")+n, FALSE  );
00177         info->skipTaskbar = config->readBoolEntry( QString("skipTaskbar")+n, FALSE  );
00178         info->skipPager = config->readBoolEntry( QString("skipPager")+n, FALSE  );
00179         info->userNoBorder = config->readBoolEntry( QString("userNoBorder")+n, FALSE  );
00180         info->windowType = txtToWindowType( config->readEntry( QString("windowType")+n ).latin1());
00181         info->shortcut = config->readEntry( QString("shortcut")+n );
00182         info->active = ( active_client == i );
00183         }
00184     }
00185 
00195 SessionInfo* Workspace::takeSessionInfo( Client* c )
00196     {
00197     SessionInfo *realInfo = 0;
00198     QCString sessionId = c->sessionId();
00199     QCString windowRole = c->windowRole();
00200     QCString wmCommand = c->wmCommand();
00201     QCString wmClientMachine = c->wmClientMachine( true );
00202     QCString resourceName = c->resourceName();
00203     QCString resourceClass = c->resourceClass();
00204 
00205     // First search ``session''
00206     if (! sessionId.isEmpty() ) 
00207         {
00208         // look for a real session managed client (algorithm suggested by ICCCM)
00209         for (SessionInfo* info = session.first(); info && !realInfo; info = session.next() )
00210             if ( info->sessionId == sessionId && sessionInfoWindowTypeMatch( c, info )) 
00211             {
00212             if ( ! windowRole.isEmpty() ) 
00213                 {
00214                 if ( info->windowRole == windowRole )
00215                     realInfo = session.take();
00216                 }
00217             else 
00218                 {
00219                 if ( info->windowRole.isEmpty() &&
00220                      info->resourceName == resourceName &&
00221                      info->resourceClass == resourceClass )
00222                     realInfo = session.take();
00223                 }
00224             }
00225         }
00226     else 
00227         {
00228         // look for a sessioninfo with matching features.
00229         for (SessionInfo* info = session.first(); info && !realInfo; info = session.next() )
00230             if ( info->resourceName == resourceName &&
00231                  info->resourceClass == resourceClass &&
00232                  info->wmClientMachine == wmClientMachine &&
00233                  sessionInfoWindowTypeMatch( c, info ))
00234                 if ( wmCommand.isEmpty() || info->wmCommand == wmCommand )
00235                     realInfo = session.take();
00236         }
00237 
00238     return realInfo;
00239     }
00240 
00241 bool Workspace::sessionInfoWindowTypeMatch( Client* c, SessionInfo* info )
00242     {
00243     if( info->windowType == -2 ) 
00244         { // undefined (not really part of NET::WindowType)
00245         return !c->isSpecialWindow();
00246         }
00247     return info->windowType == c->windowType();
00248     }
00249 
00250 // maybe needed later
00251 #if 0
00252 // KMainWindow's without name() given have WM_WINDOW_ROLE in the form
00253 // of <appname>-mainwindow#<number>
00254 // when comparing them for fake session info, it's probably better to check
00255 // them without the trailing number
00256 bool Workspace::windowRoleMatch( const QCString& role1, const QCString& role2 )
00257     {
00258     if( role1.isEmpty() && role2.isEmpty())
00259         return true;
00260     int pos1 = role1.find( '#' );
00261     int pos2 = role2.find( '#' );
00262     bool ret;
00263     if( pos1 < 0 || pos2 < 0 || pos1 != pos2 )
00264         ret = role1 == role2;
00265     else
00266         ret = qstrncmp( role1, role2, pos1 ) == 0;
00267     kdDebug() << "WR:" << role1 << ":" << pos1 << ":" << role2 << ":" << pos2 << ":::" << ret << endl;
00268     return ret;
00269     }
00270 #endif
00271 
00272 static const char* const window_type_names[] = 
00273     {
00274     "Unknown", "Normal" , "Desktop", "Dock", "Toolbar", "Menu", "Dialog",
00275     "Override", "TopMenu", "Utility", "Splash"
00276     };
00277     // change also the two functions below when adding new entries
00278 
00279 const char* Workspace::windowTypeToTxt( NET::WindowType type )
00280     {
00281     if( type >= NET::Unknown && type <= NET::Splash )
00282         return window_type_names[ type + 1 ]; // +1 (unknown==-1)
00283     if( type == -2 ) // undefined (not really part of NET::WindowType)
00284         return "Undefined";
00285     kdFatal() << "Unknown Window Type" << endl;
00286     return NULL;
00287     }
00288 
00289 NET::WindowType Workspace::txtToWindowType( const char* txt )
00290     {
00291     for( int i = NET::Unknown;
00292          i <= NET::Splash;
00293          ++i )
00294         if( qstrcmp( txt, window_type_names[ i + 1 ] ) == 0 ) // +1
00295             return static_cast< NET::WindowType >( i );
00296     return static_cast< NET::WindowType >( -2 ); // undefined
00297     }
00298 
00299 
00300 
00301 
00302 // KWin's focus stealing prevention causes problems with user interaction
00303 // during session save, as it prevents possible dialogs from getting focus.
00304 // Therefore it's temporarily disabled during session saving. Start of
00305 // session saving can be detected in SessionManaged::saveState() above,
00306 // but Qt doesn't have API for saying when session saved finished (either
00307 // successfully, or was cancelled). Therefore, create another connection
00308 // to session manager, that will provide this information.
00309 static void save_yourself( SmcConn conn_P, SmPointer ptr, int, Bool, int, Bool )
00310     {
00311     SessionSaveDoneHelper* session = reinterpret_cast< SessionSaveDoneHelper* >( ptr );
00312     if( conn_P != session->connection())
00313         return;
00314     SmcSaveYourselfDone( conn_P, True );
00315     }
00316 
00317 static void die( SmcConn conn_P, SmPointer ptr )
00318     {
00319     SessionSaveDoneHelper* session = reinterpret_cast< SessionSaveDoneHelper* >( ptr );
00320     if( conn_P != session->connection())
00321         return;
00322     // session->saveDone(); we will quit anyway
00323     session->close();
00324     }
00325 
00326 static void save_complete( SmcConn conn_P, SmPointer ptr )
00327     {
00328     SessionSaveDoneHelper* session = reinterpret_cast< SessionSaveDoneHelper* >( ptr );
00329     if( conn_P != session->connection())
00330         return;
00331     session->saveDone();
00332     }
00333 
00334 static void shutdown_cancelled( SmcConn conn_P, SmPointer ptr )
00335     {
00336     SessionSaveDoneHelper* session = reinterpret_cast< SessionSaveDoneHelper* >( ptr );
00337     if( conn_P != session->connection())
00338         return;
00339     // no need to differentiate between successful finish and cancel
00340     session->saveDone();
00341     }
00342 
00343 void SessionSaveDoneHelper::saveDone()
00344     {
00345     Workspace::self()->sessionSaveDone();
00346     }
00347 
00348 SessionSaveDoneHelper::SessionSaveDoneHelper()
00349     {
00350     SmcCallbacks calls;
00351     calls.save_yourself.callback = save_yourself;
00352     calls.save_yourself.client_data = reinterpret_cast< SmPointer >(this);
00353     calls.die.callback = die;
00354     calls.die.client_data = reinterpret_cast< SmPointer >(this);
00355     calls.save_complete.callback = save_complete;
00356     calls.save_complete.client_data = reinterpret_cast< SmPointer >(this);
00357     calls.shutdown_cancelled.callback = shutdown_cancelled;
00358     calls.shutdown_cancelled.client_data = reinterpret_cast< SmPointer >(this);
00359     char* id = NULL;
00360     char err[ 11 ];
00361     conn = SmcOpenConnection( NULL, 0, 1, 0,
00362         SmcSaveYourselfProcMask | SmcDieProcMask | SmcSaveCompleteProcMask
00363         | SmcShutdownCancelledProcMask, &calls, NULL, &id, 10, err );
00364     if( id != NULL )
00365         free( id );
00366     if( conn == NULL )
00367         return; // no SM
00368     // set the required properties, mostly dummy values
00369     SmPropValue propvalue[ 5 ];
00370     SmProp props[ 5 ];
00371     propvalue[ 0 ].length = sizeof( int );
00372     int value0 = SmRestartNever; // so that this extra SM connection doesn't interfere
00373     propvalue[ 0 ].value = &value0;
00374     props[ 0 ].name = const_cast< char* >( SmRestartStyleHint );
00375     props[ 0 ].type = const_cast< char* >( SmCARD8 );
00376     props[ 0 ].num_vals = 1;
00377     props[ 0 ].vals = &propvalue[ 0 ];
00378     struct passwd* entry = getpwuid( geteuid() );
00379     propvalue[ 1 ].length = entry != NULL ? strlen( entry->pw_name ) : 0;
00380     propvalue[ 1 ].value = (SmPointer)( entry != NULL ? entry->pw_name : "" );
00381     props[ 1 ].name = const_cast< char* >( SmUserID );
00382     props[ 1 ].type = const_cast< char* >( SmARRAY8 );
00383     props[ 1 ].num_vals = 1;
00384     props[ 1 ].vals = &propvalue[ 1 ];
00385     propvalue[ 2 ].length = 0;
00386     propvalue[ 2 ].value = (SmPointer)( "" );
00387     props[ 2 ].name = const_cast< char* >( SmRestartCommand );
00388     props[ 2 ].type = const_cast< char* >( SmLISTofARRAY8 );
00389     props[ 2 ].num_vals = 1;
00390     props[ 2 ].vals = &propvalue[ 2 ];
00391     propvalue[ 3 ].length = 0;
00392     propvalue[ 3 ].value = qApp->argv()[ 0 ];
00393     props[ 3 ].name = const_cast< char* >( SmProgram );
00394     props[ 3 ].type = const_cast< char* >( SmARRAY8 );
00395     props[ 3 ].num_vals = 1;
00396     props[ 3 ].vals = &propvalue[ 3 ];
00397     propvalue[ 4 ].length = 0;
00398     propvalue[ 4 ].value = (SmPointer)( "" );
00399     props[ 4 ].name = const_cast< char* >( SmCloneCommand );
00400     props[ 4 ].type = const_cast< char* >( SmLISTofARRAY8 );
00401     props[ 4 ].num_vals = 1;
00402     props[ 4 ].vals = &propvalue[ 4 ];
00403     SmProp* p[ 5 ] = { &props[ 0 ], &props[ 1 ], &props[ 2 ], &props[ 3 ], &props[ 4 ] };
00404     SmcSetProperties( conn, 5, p );
00405     notifier = new QSocketNotifier( IceConnectionNumber( SmcGetIceConnection( conn )),
00406         QSocketNotifier::Read, this );
00407     connect( notifier, SIGNAL( activated( int )), SLOT( processData()));
00408     }
00409 
00410 SessionSaveDoneHelper::~SessionSaveDoneHelper()
00411     {
00412     close();
00413     }
00414 
00415 void SessionSaveDoneHelper::close()
00416     {
00417     if( conn != NULL )
00418         {
00419         delete notifier;
00420         SmcCloseConnection( conn, 0, NULL );
00421         }
00422     conn = NULL;
00423     }
00424 
00425 void SessionSaveDoneHelper::processData()
00426     {
00427     if( conn != NULL )
00428         IceProcessMessages( SmcGetIceConnection( conn ), 0, 0 );
00429     }
00430 
00431 } // namespace
00432 
00433 #include "sm.moc"
KDE Home | KDE Accessibility Home | Description of Access Keys