Implement powerMonitor 'shutdown' event for Linux.

The event is emitted when the OS is rebooting/shutting down, and allows
an electron app to call `e.preventDefault()` in order to delay shutdown
and exit cleanly.
This commit is contained in:
Thiago de Arruda 2017-12-07 10:10:40 -03:00 committed by Cheng Zhao
parent 28d96e2d29
commit 56b53e71aa
6 changed files with 104 additions and 2 deletions

View file

@ -24,6 +24,14 @@ PowerMonitor::~PowerMonitor() {
base::PowerMonitor::Get()->RemoveObserver(this); base::PowerMonitor::Get()->RemoveObserver(this);
} }
void PowerMonitor::BlockShutdown(mate::Arguments* args) {
atom::PowerObserver::BlockShutdown();
}
void PowerMonitor::UnblockShutdown(mate::Arguments* args) {
atom::PowerObserver::UnblockShutdown();
}
void PowerMonitor::OnPowerStateChange(bool on_battery_power) { void PowerMonitor::OnPowerStateChange(bool on_battery_power) {
if (on_battery_power) if (on_battery_power)
Emit("on-battery"); Emit("on-battery");
@ -39,6 +47,10 @@ void PowerMonitor::OnResume() {
Emit("resume"); Emit("resume");
} }
bool PowerMonitor::OnShutdown() {
return Emit("shutdown");
}
// static // static
v8::Local<v8::Value> PowerMonitor::Create(v8::Isolate* isolate) { v8::Local<v8::Value> PowerMonitor::Create(v8::Isolate* isolate) {
if (!Browser::Get()->is_ready()) { if (!Browser::Get()->is_ready()) {
@ -55,6 +67,9 @@ v8::Local<v8::Value> PowerMonitor::Create(v8::Isolate* isolate) {
void PowerMonitor::BuildPrototype( void PowerMonitor::BuildPrototype(
v8::Isolate* isolate, v8::Local<v8::FunctionTemplate> prototype) { v8::Isolate* isolate, v8::Local<v8::FunctionTemplate> prototype) {
prototype->SetClassName(mate::StringToV8(isolate, "PowerMonitor")); prototype->SetClassName(mate::StringToV8(isolate, "PowerMonitor"));
mate::ObjectTemplateBuilder(isolate, prototype->PrototypeTemplate())
.SetMethod("blockShutdown", &PowerMonitor::BlockShutdown)
.SetMethod("unblockShutdown", &PowerMonitor::UnblockShutdown);
} }
} // namespace api } // namespace api

View file

@ -26,11 +26,17 @@ class PowerMonitor : public mate::TrackableObject<PowerMonitor>,
explicit PowerMonitor(v8::Isolate* isolate); explicit PowerMonitor(v8::Isolate* isolate);
~PowerMonitor() override; ~PowerMonitor() override;
void BlockShutdown(mate::Arguments* args);
void UnblockShutdown(mate::Arguments* args);
// base::PowerObserver implementations: // base::PowerObserver implementations:
void OnPowerStateChange(bool on_battery_power) override; void OnPowerStateChange(bool on_battery_power) override;
void OnSuspend() override; void OnSuspend() override;
void OnResume() override; void OnResume() override;
// atom::PowerObserver
bool OnShutdown() override;
private: private:
DISALLOW_COPY_AND_ASSIGN(PowerMonitor); DISALLOW_COPY_AND_ASSIGN(PowerMonitor);
}; };

View file

@ -18,7 +18,19 @@ namespace atom {
#if defined(OS_LINUX) #if defined(OS_LINUX)
typedef PowerObserverLinux PowerObserver; typedef PowerObserverLinux PowerObserver;
#else #else
typedef base::PowerObserver PowerObserver; class PowerObserver : public base::PowerObserver {
public:
PowerObserver() {}
void BlockShutdown() {}
void UnblockShutdown() {}
// Notification that the system is rebooting or shutting down. If the
// implementation returns true, the PowerObserver instance should try to delay
// OS shutdown so the application can perform cleanup before exiting.
virtual bool OnShutdown() { return false; }
private:
DISALLOW_COPY_AND_ASSIGN(PowerObserver);
};
#endif // defined(OS_LINUX) #endif // defined(OS_LINUX)
} // namespace atom } // namespace atom

View file

@ -16,6 +16,10 @@ const char kLogindServiceName[] = "org.freedesktop.login1";
const char kLogindObjectPath[] = "/org/freedesktop/login1"; const char kLogindObjectPath[] = "/org/freedesktop/login1";
const char kLogindManagerInterface[] = "org.freedesktop.login1.Manager"; const char kLogindManagerInterface[] = "org.freedesktop.login1.Manager";
// Store shutdown lock as a global, since we only want to release it when the
// main process exits.
base::ScopedFD shutdown_lock;
std::string get_executable_basename() { std::string get_executable_basename() {
char buf[4096]; char buf[4096];
size_t buf_size = sizeof(buf); size_t buf_size = sizeof(buf);
@ -54,12 +58,18 @@ void PowerObserverLinux::OnLoginServiceAvailable(bool service_available) {
LOG(WARNING) << kLogindServiceName << " not available"; LOG(WARNING) << kLogindServiceName << " not available";
return; return;
} }
// listen sleep // Connect to PrepareForShutdown/PrepareForSleep signals
logind_->ConnectToSignal(kLogindManagerInterface, "PrepareForShutdown",
base::Bind(&PowerObserverLinux::OnPrepareForShutdown,
weak_ptr_factory_.GetWeakPtr()),
base::Bind(&PowerObserverLinux::OnSignalConnected,
weak_ptr_factory_.GetWeakPtr()));
logind_->ConnectToSignal(kLogindManagerInterface, "PrepareForSleep", logind_->ConnectToSignal(kLogindManagerInterface, "PrepareForSleep",
base::Bind(&PowerObserverLinux::OnPrepareForSleep, base::Bind(&PowerObserverLinux::OnPrepareForSleep,
weak_ptr_factory_.GetWeakPtr()), weak_ptr_factory_.GetWeakPtr()),
base::Bind(&PowerObserverLinux::OnSignalConnected, base::Bind(&PowerObserverLinux::OnSignalConnected,
weak_ptr_factory_.GetWeakPtr())); weak_ptr_factory_.GetWeakPtr()));
// Take sleep inhibit lock
TakeSleepLock(); TakeSleepLock();
} }
@ -78,6 +88,32 @@ void PowerObserverLinux::TakeSleepLock() {
weak_ptr_factory_.GetWeakPtr(), &sleep_lock_)); weak_ptr_factory_.GetWeakPtr(), &sleep_lock_));
} }
void PowerObserverLinux::BlockShutdown() {
if (shutdown_lock.is_valid()) {
LOG(WARNING) << "Trying to subscribe to shutdown multiple times";
return;
}
dbus::MethodCall shutdown_inhibit_call(kLogindManagerInterface, "Inhibit");
dbus::MessageWriter inhibit_writer(&shutdown_inhibit_call);
inhibit_writer.AppendString("shutdown"); // what
inhibit_writer.AppendString(lock_owner_name_); // who
inhibit_writer.AppendString("Ensure a clean shutdown"); // why
inhibit_writer.AppendString("delay"); // mode
logind_->CallMethod(
&shutdown_inhibit_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
base::Bind(&PowerObserverLinux::OnInhibitResponse,
weak_ptr_factory_.GetWeakPtr(), &shutdown_lock));
}
void PowerObserverLinux::UnblockShutdown() {
if (!shutdown_lock.is_valid()) {
LOG(WARNING)
<< "Trying to unsubscribe to shutdown without being subscribed";
return;
}
shutdown_lock.reset();
}
void PowerObserverLinux::OnInhibitResponse(base::ScopedFD* scoped_fd, void PowerObserverLinux::OnInhibitResponse(base::ScopedFD* scoped_fd,
dbus::Response* response) { dbus::Response* response) {
dbus::MessageReader reader(response); dbus::MessageReader reader(response);
@ -100,6 +136,22 @@ void PowerObserverLinux::OnPrepareForSleep(dbus::Signal* signal) {
} }
} }
void PowerObserverLinux::OnPrepareForShutdown(dbus::Signal* signal) {
dbus::MessageReader reader(signal);
bool status;
if (!reader.PopBool(&status)) {
LOG(ERROR) << "Invalid signal: " << signal->ToString();
return;
}
if (status) {
if (!OnShutdown()) {
// The user didn't try to prevent shutdown. Release the lock and allow the
// shutdown to continue normally.
shutdown_lock.reset();
}
}
}
void PowerObserverLinux::OnSignalConnected(const std::string& interface, void PowerObserverLinux::OnSignalConnected(const std::string& interface,
const std::string& signal, const std::string& signal,
bool success) { bool success) {

View file

@ -20,11 +20,16 @@ class PowerObserverLinux : public base::PowerObserver {
public: public:
PowerObserverLinux(); PowerObserverLinux();
void BlockShutdown();
void UnblockShutdown();
virtual bool OnShutdown() { return false; }
private: private:
void TakeSleepLock(); void TakeSleepLock();
void OnLoginServiceAvailable(bool available); void OnLoginServiceAvailable(bool available);
void OnInhibitResponse(base::ScopedFD* scoped_fd, dbus::Response* response); void OnInhibitResponse(base::ScopedFD* scoped_fd, dbus::Response* response);
void OnPrepareForSleep(dbus::Signal* signal); void OnPrepareForSleep(dbus::Signal* signal);
void OnPrepareForShutdown(dbus::Signal* signal);
void OnSignalConnected(const std::string& interface, void OnSignalConnected(const std::string& interface,
const std::string& signal, const std::string& signal,
bool success); bool success);

View file

@ -5,4 +5,16 @@ const {powerMonitor, PowerMonitor} = process.atomBinding('power_monitor')
Object.setPrototypeOf(PowerMonitor.prototype, EventEmitter.prototype) Object.setPrototypeOf(PowerMonitor.prototype, EventEmitter.prototype)
EventEmitter.call(powerMonitor) EventEmitter.call(powerMonitor)
powerMonitor.on('newListener', (event) => {
if (event === 'shutdown' && powerMonitor.listenerCount('shutdown') === 0) {
powerMonitor.blockShutdown()
}
})
powerMonitor.on('removeListener', (event) => {
if (event === 'shutdown' && powerMonitor.listenerCount('shutdown') === 0) {
powerMonitor.unblockShutdown()
}
})
module.exports = powerMonitor module.exports = powerMonitor