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 273 of file dbusunitysessionservice.cpp.

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

Definition at line 283 of file dbusunitysessionservice.cpp.

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

Definition at line 298 of file dbusunitysessionservice.cpp.

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

Definition at line 288 of file dbusunitysessionservice.cpp.

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

Definition at line 293 of file dbusunitysessionservice.cpp.

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

Definition at line 278 of file dbusunitysessionservice.cpp.

279 {
280  return d->checkLogin1Call(QStringLiteral("CanSuspend"));
281 }
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 264 of file dbusunitysessionservice.cpp.

265 {
266  const QDBusMessage msg = QDBusMessage::createMethodCall(QStringLiteral("com.ubuntu.Upstart"),
267  QStringLiteral("/com/ubuntu/Upstart"),
268  QStringLiteral("com.ubuntu.Upstart0_6"),
269  QStringLiteral("EndSession"));
270  QDBusConnection::sessionBus().asyncCall(msg);
271 }
void DBusUnitySessionService::Hibernate ( )
slot

Hibernate the system

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

Definition at line 401 of file dbusunitysessionservice.cpp.

402 {
403  PromptLock();
404  d->makeLogin1Call(QStringLiteral("Hibernate"), {false});
405 }
QString DBusUnitySessionService::HostName ( ) const
slot
Returns
the local hostname

Definition at line 322 of file dbusunitysessionservice.cpp.

323 {
324  char hostName[512];
325  if (gethostname(hostName, sizeof(hostName)) == -1) {
326  qWarning() << "Could not determine local hostname";
327  return QString();
328  }
329  hostName[sizeof(hostName) - 1] = '\0';
330  return QString::fromLocal8Bit(hostName);
331 }
void DBusUnitySessionService::HybridSleep ( )
slot

Hybrid sleep

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

Since
unity8

Definition at line 407 of file dbusunitysessionservice.cpp.

408 {
409  PromptLock();
410  d->makeLogin1Call(QStringLiteral("HybridSleep"), {false});
411 }
bool DBusUnitySessionService::IsLocked ( ) const
slot
Returns
whether the session is currently locked

Definition at line 368 of file dbusunitysessionservice.cpp.

369 {
370  return !d->isSessionActive;
371 }
void DBusUnitySessionService::Lock ( )
slot

Locks the session immediately

Definition at line 339 of file dbusunitysessionservice.cpp.

340 {
341  // signal u8 to show the lockscreen/greeter
342  PromptLock();
343 
344  // lock the session using the org.freedesktop.DisplayManager system DBUS service
345  const QString sessionPath = QString::fromLocal8Bit(qgetenv("XDG_SESSION_PATH"));
346  QDBusMessage msg = QDBusMessage::createMethodCall(QStringLiteral("org.freedesktop.DisplayManager"),
347  sessionPath,
348  QStringLiteral("org.freedesktop.DisplayManager.Session"),
349  QStringLiteral("Lock"));
350 
351  QDBusPendingCall pendingCall = QDBusConnection::systemBus().asyncCall(msg);
352  QDBusPendingCallWatcher *watcher = new QDBusPendingCallWatcher(pendingCall, this);
353  connect(watcher, &QDBusPendingCallWatcher::finished,
354  this, [this](QDBusPendingCallWatcher* watcher) {
355 
356  QDBusPendingReply<void> reply = *watcher;
357  watcher->deleteLater();
358  if (reply.isError()) {
359  qWarning() << "Lock call failed" << reply.error().message();
360  return;
361  }
362 
363  // emit Locked when the call succeeds
364  Q_EMIT Locked();
365  });
366 }
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 257 of file dbusunitysessionservice.cpp.

258 {
259  // TODO ask the apps to quit and then emit the signal
260  Q_EMIT LogoutReady();
261  Q_EMIT logoutReady();
262 }
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 333 of file dbusunitysessionservice.cpp.

334 {
335  Q_EMIT LockRequested();
336  Q_EMIT lockRequested();
337 }
Q_SCRIPTABLE void LockRequested()
QString DBusUnitySessionService::RealName ( ) const
slot
Returns
the real name of the current user

Definition at line 308 of file dbusunitysessionservice.cpp.

309 {
310  struct passwd *p = getpwuid(geteuid());
311  if (p) {
312  const QString gecos = QString::fromLocal8Bit(p->pw_gecos);
313  if (!gecos.isEmpty()) {
314  const QStringList splitGecos = gecos.split(QLatin1Char(','));
315  return splitGecos.first();
316  }
317  }
318 
319  return QString();
320 }
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 379 of file dbusunitysessionservice.cpp.

380 {
381  d->makeLogin1Call(QStringLiteral("Reboot"), {false});
382 }
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 373 of file dbusunitysessionservice.cpp.

374 {
375  Q_EMIT LogoutRequested(false);
376  Q_EMIT logoutRequested(false);
377 }
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 384 of file dbusunitysessionservice.cpp.

385 {
386  Q_EMIT RebootRequested(false);
387  Q_EMIT rebootRequested(false);
388 }
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 413 of file dbusunitysessionservice.cpp.

414 {
415  Q_EMIT ShutdownRequested(false);
416  Q_EMIT shutdownRequested(false);
417 }
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 390 of file dbusunitysessionservice.cpp.

391 {
392  d->makeLogin1Call(QStringLiteral("PowerOff"), {false});
393 }
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 395 of file dbusunitysessionservice.cpp.

396 {
397  PromptLock();
398  d->makeLogin1Call(QStringLiteral("Suspend"), {false});
399 }
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 303 of file dbusunitysessionservice.cpp.

304 {
305  return QString::fromUtf8(g_get_user_name());
306 }

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