Unity 8
DBusUnitySessionService Class Reference

#include <plugins/Unity/Session/dbusunitysessionservice.h>

Inherits UnityDBusObject.

Public Slots

Q_SCRIPTABLE void Logout ()
 
Q_SCRIPTABLE void Reboot ()
 
Q_SCRIPTABLE void Shutdown ()
 
Q_SCRIPTABLE void Suspend ()
 
Q_SCRIPTABLE void Hibernate ()
 
Q_SCRIPTABLE void HybridSleep ()
 
Q_SCRIPTABLE void RequestLogout ()
 
Q_SCRIPTABLE void RequestReboot ()
 
Q_SCRIPTABLE void RequestShutdown ()
 
Q_SCRIPTABLE void EndSession ()
 
Q_SCRIPTABLE bool CanHibernate () const
 
Q_SCRIPTABLE bool CanSuspend () const
 
Q_SCRIPTABLE bool CanHybridSleep () const
 
Q_SCRIPTABLE bool CanReboot () const
 
Q_SCRIPTABLE bool CanShutdown () const
 
Q_SCRIPTABLE bool CanLock () const
 
Q_SCRIPTABLE QString UserName () const
 
Q_SCRIPTABLE QString RealName () const
 
Q_SCRIPTABLE QString HostName () const
 
Q_SCRIPTABLE void PromptLock ()
 
Q_SCRIPTABLE void Lock ()
 
Q_SCRIPTABLE bool IsLocked () const
 

Signals

Q_SCRIPTABLE void LogoutRequested (bool have_inhibitors)
 
void logoutRequested (bool have_inhibitors)
 
Q_SCRIPTABLE void RebootRequested (bool have_inhibitors)
 
void rebootRequested (bool have_inhibitors)
 
Q_SCRIPTABLE void ShutdownRequested (bool have_inhibitors)
 
void shutdownRequested (bool have_inhibitors)
 
Q_SCRIPTABLE void LogoutReady ()
 
void logoutReady ()
 
Q_SCRIPTABLE void LockRequested ()
 
void lockRequested ()
 
Q_SCRIPTABLE void Locked ()
 
Q_SCRIPTABLE void Unlocked ()
 

Public Member Functions

Q_INVOKABLE void logout ()
 
Q_INVOKABLE void reboot ()
 
Q_INVOKABLE void shutdown ()
 
Q_INVOKABLE void endSession ()
 

Detailed Description

DBusUnitySessionService provides com.canonical.Unity.Session dbus interface.

com.canonical.Unity.Session interface provides public methods and signals to handle eg. Logout/Reboot/Shutdown.

Definition at line 34 of file dbusunitysessionservice.h.

Member Function Documentation

bool DBusUnitySessionService::CanHibernate ( ) const
slot
Returns
whether the system is capable of hibernating

Definition at line 249 of file dbusunitysessionservice.cpp.

250 {
251  return d->checkLogin1Call(QStringLiteral("CanHibernate"));
252 }
bool DBusUnitySessionService::CanHybridSleep ( ) const
slot
Returns
whether the system is capable of hybrid sleep
Since
unity8

Definition at line 259 of file dbusunitysessionservice.cpp.

260 {
261  return d->checkLogin1Call(QStringLiteral("CanHybridSleep"));
262 }
bool DBusUnitySessionService::CanLock ( ) const
slot
Returns
whether the system is capable of locking the session

Definition at line 274 of file dbusunitysessionservice.cpp.

275 {
276  return true; // FIXME
277 }
bool DBusUnitySessionService::CanReboot ( ) const
slot
Returns
whether the system is capable of rebooting
Since
unity8

Definition at line 264 of file dbusunitysessionservice.cpp.

265 {
266  return d->checkLogin1Call(QStringLiteral("CanReboot"));
267 }
bool DBusUnitySessionService::CanShutdown ( ) const
slot
Returns
whether the system is capable of shutting down

Definition at line 269 of file dbusunitysessionservice.cpp.

270 {
271  return d->checkLogin1Call(QStringLiteral("CanPowerOff"));
272 }
bool DBusUnitySessionService::CanSuspend ( ) const
slot
Returns
whether the system is capable of suspending

Definition at line 254 of file dbusunitysessionservice.cpp.

255 {
256  return d->checkLogin1Call(QStringLiteral("CanSuspend"));
257 }
void DBusUnitySessionService::EndSession ( )
slot

Issue an EndSession request.

This method calls the EndSession() Upstart DBus method on the current DBus session bus.

Definition at line 240 of file dbusunitysessionservice.cpp.

241 {
242  const QDBusMessage msg = QDBusMessage::createMethodCall(QStringLiteral("com.ubuntu.Upstart"),
243  QStringLiteral("/com/ubuntu/Upstart"),
244  QStringLiteral("com.ubuntu.Upstart0_6"),
245  QStringLiteral("EndSession"));
246  QDBusConnection::sessionBus().asyncCall(msg);
247 }
void DBusUnitySessionService::Hibernate ( )
slot

Hibernate the system

This method puts the system into hibernation without user's confirmation.

Definition at line 369 of file dbusunitysessionservice.cpp.

370 {
371  d->makeLogin1Call(QStringLiteral("Hibernate"), {false});
372 }
QString DBusUnitySessionService::HostName ( ) const
slot
Returns
the local hostname

Definition at line 303 of file dbusunitysessionservice.cpp.

304 {
305  char hostName[512];
306  if (gethostname(hostName, sizeof(hostName)) == -1) {
307  qWarning() << "Could not determine local hostname";
308  return QString();
309  }
310  hostName[sizeof(hostName) - 1] = '\0';
311  return QString::fromLocal8Bit(hostName);
312 }
void DBusUnitySessionService::HybridSleep ( )
slot

Hybrid sleep

This method puts the system into hybrid sleep without user's confirmation.

Since
unity8

Definition at line 374 of file dbusunitysessionservice.cpp.

375 {
376  d->makeLogin1Call(QStringLiteral("HybridSleep"), {false});
377 }
bool DBusUnitySessionService::IsLocked ( ) const
slot
Returns
whether the session is currently locked

Definition at line 337 of file dbusunitysessionservice.cpp.

338 {
339  return !d->isSessionActive;
340 }
void DBusUnitySessionService::Lock ( )
slot

Locks the session immediately

Definition at line 320 of file dbusunitysessionservice.cpp.

321 {
322  // lock the session using the org.freedesktop.DisplayManager system DBUS service
323  const QString sessionPath = QString::fromLocal8Bit(qgetenv("XDG_SESSION_PATH"));
324  QDBusMessage msg = QDBusMessage::createMethodCall(QStringLiteral("org.freedesktop.DisplayManager"),
325  sessionPath,
326  QStringLiteral("org.freedesktop.DisplayManager.Session"),
327  QStringLiteral("Lock"));
328  QDBusReply<void> reply = QDBusConnection::systemBus().asyncCall(msg);
329  if (!reply.isValid()) {
330  qWarning() << "Lock call failed" << reply.error().message();
331  } else {
332  // emit Locked when the call succeeds
333  Q_EMIT Locked();
334  }
335 }
Q_SCRIPTABLE void Locked()
Q_SCRIPTABLE void DBusUnitySessionService::Locked ( )
signal

Emitted after the session has been locked.

Q_SCRIPTABLE void DBusUnitySessionService::LockRequested ( )
signal

Emitted as a result of calling PromptLock()

void DBusUnitySessionService::Logout ( )
slot

Logout the system.

This method directly logs out the system without user's confirmation. Ordinary applications should avoid calling this method. Please call RequestLogout() to ask the user to decide logout or not.

Definition at line 233 of file dbusunitysessionservice.cpp.

234 {
235  // TODO ask the apps to quit and then emit the signal
236  Q_EMIT LogoutReady();
237  Q_EMIT logoutReady();
238 }
Q_SCRIPTABLE void LogoutReady()
Q_SCRIPTABLE void DBusUnitySessionService::LogoutReady ( )
signal

LogoutReady signal

This signal is emitted when all the apps are closed. And the system is safe to logout.

Q_SCRIPTABLE void DBusUnitySessionService::LogoutRequested ( bool  have_inhibitors)
signal

LogoutRequested signal

This signal is emitted when some applications request the system to logout.

Parameters
have_inhibitorsif there are any special running applications which inhibit the logout.
void DBusUnitySessionService::PromptLock ( )
slot

Request that the session get locked, emits signal LockRequested()

Definition at line 314 of file dbusunitysessionservice.cpp.

315 {
316  Q_EMIT LockRequested();
317  Q_EMIT lockRequested();
318 }
Q_SCRIPTABLE void LockRequested()
QString DBusUnitySessionService::RealName ( ) const
slot
Returns
the real name of the current user

Definition at line 289 of file dbusunitysessionservice.cpp.

290 {
291  struct passwd *p = getpwuid(geteuid());
292  if (p) {
293  const QString gecos = QString::fromLocal8Bit(p->pw_gecos);
294  if (!gecos.isEmpty()) {
295  const QStringList splitGecos = gecos.split(QLatin1Char(','));
296  return splitGecos.first();
297  }
298  }
299 
300  return QString();
301 }
void DBusUnitySessionService::Reboot ( )
slot

Reboot the system.

This method directly reboots the system without user's confirmation. Ordinary applications should avoid calling this method. Please call RequestReboot() to ask the user to decide reboot or not.

Definition at line 348 of file dbusunitysessionservice.cpp.

349 {
350  d->makeLogin1Call(QStringLiteral("Reboot"), {false});
351 }
Q_SCRIPTABLE void DBusUnitySessionService::RebootRequested ( bool  have_inhibitors)
signal

RebootRequested signal

This signal is emitted when some applications request the system to reboot.

Parameters
have_inhibitorsif there are any special running applications which inhibit the reboot.
void DBusUnitySessionService::RequestLogout ( )
slot

Issue a logout request.

This method emits the LogoutRequested signal to the shell with a boolean which indicates if there's any inhibitors. The shell should receive this signal and display a dialog to ask the user to confirm the logout action. If confirmed, shell can call Logout() method to logout.

Definition at line 342 of file dbusunitysessionservice.cpp.

343 {
344  Q_EMIT LogoutRequested(false);
345  Q_EMIT logoutRequested(false);
346 }
Q_SCRIPTABLE void LogoutRequested(bool have_inhibitors)
void DBusUnitySessionService::RequestReboot ( )
slot

Issue a reboot request.

This method emits the RebootRequested signal to the shell with a boolean which indicates if there's any inhibitors. The shell should receive this signal and display a dialog to ask the user to confirm the reboot action. If confirmed, shell can call Reboot() method to reboot.

Definition at line 353 of file dbusunitysessionservice.cpp.

354 {
355  Q_EMIT RebootRequested(false);
356  Q_EMIT rebootRequested(false);
357 }
Q_SCRIPTABLE void RebootRequested(bool have_inhibitors)
void DBusUnitySessionService::RequestShutdown ( )
slot

Issue a shutdown request.

This method emits the ShutdownRequested signal to the shell with a boolean which indicates if there's any inhibitors. The shell should receive this signal and display a dialog to ask the user to confirm the reboot action. If confirmed, shell can call Shutdown() method to shutdown.

Definition at line 379 of file dbusunitysessionservice.cpp.

380 {
381  Q_EMIT ShutdownRequested(false);
382  Q_EMIT shutdownRequested(false);
383 }
Q_SCRIPTABLE void ShutdownRequested(bool have_inhibitors)
void DBusUnitySessionService::Shutdown ( )
slot

Shutdown the system.

This method directly shuts down the system without user's confirmation. Ordinary applications should avoid calling this method. Please call RequestShutdown() to ask the user to decide shutdown or not.

Definition at line 359 of file dbusunitysessionservice.cpp.

360 {
361  d->makeLogin1Call(QStringLiteral("PowerOff"), {false});
362 }
Q_SCRIPTABLE void DBusUnitySessionService::ShutdownRequested ( bool  have_inhibitors)
signal

ShutdownRequested signal

This signal is emitted when some applications request the system to shutdown.

Parameters
have_inhibitorsif there are any special running applications which inhibit the shutdown.
void DBusUnitySessionService::Suspend ( )
slot

Suspend the system

This method puts the system into sleep without user's confirmation.

Definition at line 364 of file dbusunitysessionservice.cpp.

365 {
366  d->makeLogin1Call(QStringLiteral("Suspend"), {false});
367 }
Q_SCRIPTABLE void DBusUnitySessionService::Unlocked ( )
signal

Emitted after the session has been unlocked.

QString DBusUnitySessionService::UserName ( ) const
slot
Returns
the login name of the current user

Definition at line 279 of file dbusunitysessionservice.cpp.

280 {
281  struct passwd *p = getpwuid(geteuid());
282  if (p) {
283  return QString::fromUtf8(p->pw_name);
284  }
285 
286  return QString();
287 }

The documentation for this class was generated from the following files: