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

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

Definition at line 222 of file dbusunitysessionservice.cpp.

223 {
224  return d->checkLogin1Call("CanHybridSleep");
225 }
bool DBusUnitySessionService::CanLock ( ) const
slot
Returns
whether the system is capable of locking the session

Definition at line 237 of file dbusunitysessionservice.cpp.

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

Definition at line 227 of file dbusunitysessionservice.cpp.

228 {
229  return d->checkLogin1Call("CanReboot");
230 }
bool DBusUnitySessionService::CanShutdown ( ) const
slot
Returns
whether the system is capable of shutting down

Definition at line 232 of file dbusunitysessionservice.cpp.

233 {
234  return d->checkLogin1Call("CanPowerOff");
235 }
bool DBusUnitySessionService::CanSuspend ( ) const
slot
Returns
whether the system is capable of suspending

Definition at line 217 of file dbusunitysessionservice.cpp.

218 {
219  return d->checkLogin1Call("CanSuspend");
220 }
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 203 of file dbusunitysessionservice.cpp.

204 {
205  const QDBusMessage msg = QDBusMessage::createMethodCall("com.ubuntu.Upstart",
206  "/com/ubuntu/Upstart",
207  "com.ubuntu.Upstart0_6",
208  "EndSession");
209  QDBusConnection::sessionBus().asyncCall(msg);
210 }
void DBusUnitySessionService::Hibernate ( )
slot

Hibernate the system

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

Definition at line 332 of file dbusunitysessionservice.cpp.

333 {
334  d->makeLogin1Call("Hibernate", {false});
335 }
QString DBusUnitySessionService::HostName ( ) const
slot
Returns
the local hostname

Definition at line 265 of file dbusunitysessionservice.cpp.

266 {
267  char hostName[512];
268  if (gethostname(hostName, sizeof(hostName)) == -1) {
269  qWarning() << "Could not determine local hostname";
270  return QString();
271  }
272  hostName[sizeof(hostName) - 1] = '\0';
273  return QString::fromLocal8Bit(hostName);
274 }
void DBusUnitySessionService::HybridSleep ( )
slot

Hybrid sleep

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

Since
unity8

Definition at line 337 of file dbusunitysessionservice.cpp.

338 {
339  d->makeLogin1Call("HybridSleep", {false});
340 }
bool DBusUnitySessionService::IsLocked ( ) const
slot
Returns
whether the session is currently locked

Definition at line 300 of file dbusunitysessionservice.cpp.

301 {
302  return !d->isSessionActive;
303 }
void DBusUnitySessionService::Lock ( )
slot

Locks the session immediately

Definition at line 282 of file dbusunitysessionservice.cpp.

283 {
284  // lock the session using the org.freedesktop.DisplayManager system DBUS service
285  const QString sessionPath = QString::fromLocal8Bit(qgetenv("XDG_SESSION_PATH"));
286  QDBusMessage msg = QDBusMessage::createMethodCall("org.freedesktop.DisplayManager",
287  sessionPath,
288  "org.freedesktop.DisplayManager.Session",
289  "Lock");
290  qDebug() << "Locking session" << msg.path();
291  QDBusReply<void> reply = QDBusConnection::systemBus().asyncCall(msg);
292  if (!reply.isValid()) {
293  qWarning() << "Lock call failed" << reply.error().message();
294  } else {
295  // emit Locked when the call succeeds
296  Q_EMIT Locked();
297  }
298 }
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 196 of file dbusunitysessionservice.cpp.

197 {
198  // TODO ask the apps to quit and then emit the signal
199  Q_EMIT LogoutReady();
200  Q_EMIT logoutReady();
201 }
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 276 of file dbusunitysessionservice.cpp.

277 {
278  Q_EMIT LockRequested();
279  Q_EMIT lockRequested();
280 }
Q_SCRIPTABLE void LockRequested()
QString DBusUnitySessionService::RealName ( ) const
slot
Returns
the real name of the current user

Definition at line 252 of file dbusunitysessionservice.cpp.

253 {
254  struct passwd *p = getpwuid(geteuid());
255  if (p) {
256  const QString gecos = QString::fromLocal8Bit(p->pw_gecos);
257  if (!gecos.isEmpty()) {
258  return gecos.split(QLatin1Char(',')).first();
259  }
260  }
261 
262  return QString();
263 }
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 311 of file dbusunitysessionservice.cpp.

312 {
313  d->makeLogin1Call("Reboot", {false});
314 }
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 305 of file dbusunitysessionservice.cpp.

306 {
307  Q_EMIT LogoutRequested(false);
308  Q_EMIT logoutRequested(false);
309 }
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 316 of file dbusunitysessionservice.cpp.

317 {
318  Q_EMIT RebootRequested(false);
319  Q_EMIT rebootRequested(false);
320 }
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 342 of file dbusunitysessionservice.cpp.

343 {
344  Q_EMIT ShutdownRequested(false);
345  Q_EMIT shutdownRequested(false);
346 }
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 322 of file dbusunitysessionservice.cpp.

323 {
324  d->makeLogin1Call("PowerOff", {false});
325 }
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 327 of file dbusunitysessionservice.cpp.

328 {
329  d->makeLogin1Call("Suspend", {false});
330 }
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 242 of file dbusunitysessionservice.cpp.

243 {
244  struct passwd *p = getpwuid(geteuid());
245  if (p) {
246  return QString::fromUtf8(p->pw_name);
247  }
248 
249  return QString();
250 }

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