From c2e45b07992bce2ed817bc09b8cecf7ed56f23a5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ta=C5=84ski?= <piotr.tanski@mudita.com>
Date: Fri, 2 Jul 2021 15:44:05 +0200
Subject: [PATCH] [EGD-7024] Keep the state of SMS on phone lock

The SMS is not deleted on manual or automatic phone lock.
---
 .../windows/NewMessage.cpp                    |  8 +++++++-
 .../windows/NewMessage.hpp                    |  4 ++--
 .../windows/SMSThreadViewWindow.cpp           |  2 +-
 .../windows/SMSThreadViewWindow.hpp           |  2 +-
 .../windows/NoteEditWindow.cpp                |  2 +-
 .../windows/NoteEditWindow.hpp                |  2 +-
 .../windows/PhonebookContactDetails.cpp       |  2 +-
 .../windows/PhonebookContactDetails.hpp       |  4 ++--
 .../windows/AddDeviceWindow.cpp               |  2 +-
 .../windows/AddDeviceWindow.hpp               |  2 +-
 module-apps/apps-common/Application.cpp       | 20 +++++++++++++------
 module-apps/apps-common/Application.hpp       |  9 ++++++++-
 .../apps-common/messages/AppMessage.hpp       | 10 ++++++++--
 .../apps-common/popups/WindowWithTimer.cpp    |  2 +-
 .../apps-common/popups/WindowWithTimer.hpp    |  2 +-
 .../apps-common/windows/OptionWindow.cpp      |  2 +-
 .../apps-common/windows/OptionWindow.hpp      |  2 +-
 module-gui/gui/widgets/Window.cpp             |  2 +-
 module-gui/gui/widgets/Window.hpp             | 10 ++++++++--
 19 files changed, 61 insertions(+), 28 deletions(-)

diff --git a/module-apps/application-messages/windows/NewMessage.cpp b/module-apps/application-messages/windows/NewMessage.cpp
index 2ded3f8ac..f34444108 100644
--- a/module-apps/application-messages/windows/NewMessage.cpp
+++ b/module-apps/application-messages/windows/NewMessage.cpp
@@ -290,12 +290,18 @@ namespace gui
         setFocusItem(body);
     }
 
-    void NewMessageWindow::onClose()
+    void NewMessageWindow::onClose(CloseReason reason)
     {
         if (message->getText().empty()) {
             // Nothing to do if text is empty.
             return;
         }
+
+        if (reason == CloseReason::PhoneLock) {
+            memento->setState(message);
+            message->clear();
+            return;
+        }
         if (const auto handled = handleMessageText(); !handled) {
             message->clear();
         }
diff --git a/module-apps/application-messages/windows/NewMessage.hpp b/module-apps/application-messages/windows/NewMessage.hpp
index 75b48e8af..53255d1fb 100644
--- a/module-apps/application-messages/windows/NewMessage.hpp
+++ b/module-apps/application-messages/windows/NewMessage.hpp
@@ -1,4 +1,4 @@
-// Copyright (c) 2017-2020, Mudita Sp. z.o.o. All rights reserved.
+// Copyright (c) 2017-2021, Mudita Sp. z.o.o. All rights reserved.
 // For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
 
 #pragma once
@@ -23,7 +23,7 @@ namespace gui
         bool onInput(const InputEvent &inputEvent) override;
         void onBeforeShow(ShowMode mode, SwitchData *data) override;
         void buildInterface() override;
-        void onClose() override;
+        void onClose(CloseReason reason) override;
 
       private:
         bool selectContact();
diff --git a/module-apps/application-messages/windows/SMSThreadViewWindow.cpp b/module-apps/application-messages/windows/SMSThreadViewWindow.cpp
index be2910c92..aac45f0d6 100644
--- a/module-apps/application-messages/windows/SMSThreadViewWindow.cpp
+++ b/module-apps/application-messages/windows/SMSThreadViewWindow.cpp
@@ -93,7 +93,7 @@ namespace gui
         return AppWindow::onInput(inputEvent);
     }
 
-    void SMSThreadViewWindow::onClose()
+    void SMSThreadViewWindow::onClose([[maybe_unused]] CloseReason reason)
     {
         smsModel->handleDraftMessage();
     }
diff --git a/module-apps/application-messages/windows/SMSThreadViewWindow.hpp b/module-apps/application-messages/windows/SMSThreadViewWindow.hpp
index fb1570a92..ce6c81d2c 100644
--- a/module-apps/application-messages/windows/SMSThreadViewWindow.hpp
+++ b/module-apps/application-messages/windows/SMSThreadViewWindow.hpp
@@ -29,7 +29,7 @@ namespace gui
 
         bool onInput(const InputEvent &inputEvent) override;
         void onBeforeShow(ShowMode mode, SwitchData *data) override;
-        void onClose() override;
+        void onClose(CloseReason reason) override;
         bool onDatabaseMessage(sys::Message *msgl) override;
         void rebuild() override;
         void buildInterface() override;
diff --git a/module-apps/application-notes/windows/NoteEditWindow.cpp b/module-apps/application-notes/windows/NoteEditWindow.cpp
index a06240eff..ac45ae461 100644
--- a/module-apps/application-notes/windows/NoteEditWindow.cpp
+++ b/module-apps/application-notes/windows/NoteEditWindow.cpp
@@ -120,7 +120,7 @@ namespace app::notes
         setNoteText(notesRecord->snippet);
     }
 
-    void NoteEditWindow::onClose()
+    void NoteEditWindow::onClose([[maybe_unused]] CloseReason reason)
     {
         if (presenter->isAutoSaveApproved()) {
             saveNote();
diff --git a/module-apps/application-notes/windows/NoteEditWindow.hpp b/module-apps/application-notes/windows/NoteEditWindow.hpp
index c3f7fa2b3..aeed81858 100644
--- a/module-apps/application-notes/windows/NoteEditWindow.hpp
+++ b/module-apps/application-notes/windows/NoteEditWindow.hpp
@@ -24,7 +24,7 @@ namespace app::notes
         ~NoteEditWindow() noexcept override;
 
         void onBeforeShow(gui::ShowMode mode, gui::SwitchData *data) override;
-        void onClose() override;
+        void onClose(CloseReason reason) override;
         bool onInput(const gui::InputEvent &inputEvent) override;
 
         void rebuild() override;
diff --git a/module-apps/application-phonebook/windows/PhonebookContactDetails.cpp b/module-apps/application-phonebook/windows/PhonebookContactDetails.cpp
index 75dce1cea..9e316fdf4 100644
--- a/module-apps/application-phonebook/windows/PhonebookContactDetails.cpp
+++ b/module-apps/application-phonebook/windows/PhonebookContactDetails.cpp
@@ -46,7 +46,7 @@ namespace gui
         erase();
     }
 
-    void PhonebookContactDetails::onClose()
+    void PhonebookContactDetails::onClose([[maybe_unused]] CloseReason reason)
     {
         contactDetailsModel->clearData();
     }
diff --git a/module-apps/application-phonebook/windows/PhonebookContactDetails.hpp b/module-apps/application-phonebook/windows/PhonebookContactDetails.hpp
index 3f8a64035..55bdcfa9c 100644
--- a/module-apps/application-phonebook/windows/PhonebookContactDetails.hpp
+++ b/module-apps/application-phonebook/windows/PhonebookContactDetails.hpp
@@ -1,4 +1,4 @@
-// Copyright (c) 2017-2020, Mudita Sp. z.o.o. All rights reserved.
+// Copyright (c) 2017-2021, Mudita Sp. z.o.o. All rights reserved.
 // For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
 
 #pragma once
@@ -22,7 +22,7 @@ namespace gui
         auto onInput(const InputEvent &inputEvent) -> bool override;
         void onBeforeShow(ShowMode mode, SwitchData *data) override;
         auto handleSwitchData(SwitchData *data) -> bool override;
-        void onClose() override;
+        void onClose(CloseReason reason) override;
         void rebuild() override;
         void buildInterface() override;
         void destroyInterface() override;
diff --git a/module-apps/application-settings-new/windows/AddDeviceWindow.cpp b/module-apps/application-settings-new/windows/AddDeviceWindow.cpp
index 8d63b466d..9e9e29aee 100644
--- a/module-apps/application-settings-new/windows/AddDeviceWindow.cpp
+++ b/module-apps/application-settings-new/windows/AddDeviceWindow.cpp
@@ -30,7 +30,7 @@ namespace gui
         refreshOptionsList();
     }
 
-    void AddDeviceWindow::onClose()
+    void AddDeviceWindow::onClose([[maybe_unused]] CloseReason reason)
     {
         bluetoothSettingsModel->stopScan();
     }
diff --git a/module-apps/application-settings-new/windows/AddDeviceWindow.hpp b/module-apps/application-settings-new/windows/AddDeviceWindow.hpp
index 6ebedd260..65ba63459 100644
--- a/module-apps/application-settings-new/windows/AddDeviceWindow.hpp
+++ b/module-apps/application-settings-new/windows/AddDeviceWindow.hpp
@@ -17,7 +17,7 @@ namespace gui
 
       private:
         void onBeforeShow(ShowMode mode, SwitchData *data) override;
-        void onClose() override;
+        void onClose(CloseReason reason) override;
         auto buildOptionsList() -> std::list<Option> override;
 
         std::unique_ptr<BluetoothSettingsModel> bluetoothSettingsModel;
diff --git a/module-apps/apps-common/Application.cpp b/module-apps/apps-common/Application.cpp
index 28e1ab704..097d59acd 100644
--- a/module-apps/apps-common/Application.cpp
+++ b/module-apps/apps-common/Application.cpp
@@ -234,7 +234,8 @@ namespace app
 
     void Application::switchWindow(const std::string &windowName,
                                    gui::ShowMode cmd,
-                                   std::unique_ptr<gui::SwitchData> data)
+                                   std::unique_ptr<gui::SwitchData> data,
+                                   SwitchReason reason)
     {
 
         std::string window;
@@ -248,13 +249,13 @@ namespace app
         // case to handle returning to previous application
         if (windowName.empty()) {
             window = getCurrentWindow()->getName();
-            auto msg =
-                std::make_shared<AppSwitchWindowMessage>(window, getCurrentWindow()->getName(), std::move(data), cmd);
+            auto msg = std::make_shared<AppSwitchWindowMessage>(
+                window, getCurrentWindow()->getName(), std::move(data), cmd, reason);
             bus.sendUnicast(msg, this->GetName());
         }
         else {
             auto msg = std::make_shared<AppSwitchWindowMessage>(
-                windowName, getCurrentWindow() ? getCurrentWindow()->getName() : "", std::move(data), cmd);
+                windowName, getCurrentWindow() ? getCurrentWindow()->getName() : "", std::move(data), cmd, reason);
             bus.sendUnicast(msg, this->GetName());
         }
     }
@@ -507,7 +508,10 @@ namespace app
             }
             if (!isCurrentWindow(msg->getWindowName())) {
                 if (!windowsStack.isEmpty()) {
-                    getCurrentWindow()->onClose();
+                    const auto closeReason = msg->getReason() == SwitchReason::PhoneLock
+                                                 ? gui::Window::CloseReason::PhoneLock
+                                                 : gui::Window::CloseReason::WindowSwitch;
+                    getCurrentWindow()->onClose(closeReason);
                 }
                 setActiveWindow(msg->getWindowName());
             }
@@ -641,7 +645,7 @@ namespace app
 
         for (const auto &[windowName, window] : windowsStack) {
             LOG_INFO("Closing a window: %s", windowName.c_str());
-            window->onClose();
+            window->onClose(gui::Window::CloseReason::ApplicationClose);
         }
 
         windowsStack.windows.clear();
@@ -830,6 +834,10 @@ namespace app
                      std::to_string(volumeParams->getVolume()).c_str());
             handleVolumeChanged(volumeParams->getVolume(), volumeParams->getAudioContext());
         }
+        else if (id == ID::PhoneLock) {
+            switchWindow(
+                gui::popup::resolveWindowName(id), gui::ShowMode::GUI_SHOW_INIT, nullptr, SwitchReason::PhoneLock);
+        }
         else if (id == ID::PhoneLockInput || id == ID::PhoneLockChangeInfo) {
             auto popupParams = static_cast<const gui::PhoneUnlockInputRequestParams *>(params);
 
diff --git a/module-apps/apps-common/Application.hpp b/module-apps/apps-common/Application.hpp
index 0feb7ec4a..28df0126f 100644
--- a/module-apps/apps-common/Application.hpp
+++ b/module-apps/apps-common/Application.hpp
@@ -78,6 +78,12 @@ namespace app
         // switch to main window on application switch and allow declared handler to switch to desired window.
     };
 
+    enum class SwitchReason
+    {
+        SwitchRequest,
+        PhoneLock
+    };
+
     struct StartInBackground
     {
         StartInBackground(bool _value) : value{_value}
@@ -225,7 +231,8 @@ namespace app
         ///        that we dont want to close app calling
         void switchWindow(const std::string &windowName,
                           gui::ShowMode cmd                     = gui::ShowMode::GUI_SHOW_INIT,
-                          std::unique_ptr<gui::SwitchData> data = nullptr);
+                          std::unique_ptr<gui::SwitchData> data = nullptr,
+                          SwitchReason reason                   = SwitchReason::SwitchRequest);
 
         /// Same as switchWindow above
         inline void switchWindow(const std::string &windowName, std::unique_ptr<gui::SwitchData> data)
diff --git a/module-apps/apps-common/messages/AppMessage.hpp b/module-apps/apps-common/messages/AppMessage.hpp
index c99313f63..500b1e2ee 100644
--- a/module-apps/apps-common/messages/AppMessage.hpp
+++ b/module-apps/apps-common/messages/AppMessage.hpp
@@ -116,6 +116,7 @@ namespace app
         std::string window;
         std::string senderWindow;
         gui::ShowMode command;
+        SwitchReason reason;
         std::unique_ptr<gui::SwitchData> data;
 
       public:
@@ -124,9 +125,10 @@ namespace app
         AppSwitchWindowMessage(const std::string &window,
                                const std::string senderWindow,
                                std::unique_ptr<gui::SwitchData> data,
-                               const gui::ShowMode command = gui::ShowMode::GUI_SHOW_INIT)
+                               gui::ShowMode command = gui::ShowMode::GUI_SHOW_INIT,
+                               SwitchReason reason   = SwitchReason::SwitchRequest)
             : AppMessage(MessageType::AppSwitchWindow), window{window},
-              senderWindow{senderWindow}, command{command}, data{std::move(data)} {};
+              senderWindow{senderWindow}, command{command}, reason{reason}, data{std::move(data)} {};
         virtual ~AppSwitchWindowMessage() = default;
 
         const std::string &getWindowName() const
@@ -141,6 +143,10 @@ namespace app
         {
             return command;
         };
+        [[nodiscard]] SwitchReason getReason() const noexcept
+        {
+            return reason;
+        }
         std::unique_ptr<gui::SwitchData> &getData()
         {
             return data;
diff --git a/module-apps/apps-common/popups/WindowWithTimer.cpp b/module-apps/apps-common/popups/WindowWithTimer.cpp
index efddfdaf6..ed52bdda2 100644
--- a/module-apps/apps-common/popups/WindowWithTimer.cpp
+++ b/module-apps/apps-common/popups/WindowWithTimer.cpp
@@ -52,7 +52,7 @@ namespace gui
         resetTimer();
     }
 
-    void WindowWithTimer::onClose()
+    void WindowWithTimer::onClose([[maybe_unused]] CloseReason reason)
     {
         detachTimerIfExists();
     }
diff --git a/module-apps/apps-common/popups/WindowWithTimer.hpp b/module-apps/apps-common/popups/WindowWithTimer.hpp
index 20251b947..679fc4f03 100644
--- a/module-apps/apps-common/popups/WindowWithTimer.hpp
+++ b/module-apps/apps-common/popups/WindowWithTimer.hpp
@@ -22,7 +22,7 @@ namespace gui
         void destroyInterface() override;
         ~WindowWithTimer() override;
         void onBeforeShow(ShowMode mode, SwitchData *data) override;
-        void onClose() override;
+        void onClose(CloseReason reason) override;
         bool onInput(const gui::InputEvent &inputEvent) override;
 
       protected:
diff --git a/module-apps/apps-common/windows/OptionWindow.cpp b/module-apps/apps-common/windows/OptionWindow.cpp
index 038090ea6..9baae5547 100644
--- a/module-apps/apps-common/windows/OptionWindow.cpp
+++ b/module-apps/apps-common/windows/OptionWindow.cpp
@@ -109,7 +109,7 @@ namespace gui
         return appConfiguration;
     }
 
-    void OptionWindow::onClose()
+    void OptionWindow::onClose([[maybe_unused]] CloseReason reason)
     {
         optionsList->onClose();
     }
diff --git a/module-apps/apps-common/windows/OptionWindow.hpp b/module-apps/apps-common/windows/OptionWindow.hpp
index 0167b1ede..d48ed8500 100644
--- a/module-apps/apps-common/windows/OptionWindow.hpp
+++ b/module-apps/apps-common/windows/OptionWindow.hpp
@@ -37,7 +37,7 @@ namespace gui
         OptionWindow(app::Application *app, const std::string &name, std::list<Option> options);
 
         void onBeforeShow(ShowMode mode, SwitchData *data) override;
-        void onClose() override;
+        void onClose(CloseReason reason) override;
         void rebuild() override;
         void buildInterface() override;
         status_bar::Configuration configureStatusBar(status_bar::Configuration appConfiguration) override;
diff --git a/module-gui/gui/widgets/Window.cpp b/module-gui/gui/widgets/Window.cpp
index adb9d2109..7b6699d48 100644
--- a/module-gui/gui/widgets/Window.cpp
+++ b/module-gui/gui/widgets/Window.cpp
@@ -23,7 +23,7 @@ namespace gui
     void Window::onBeforeShow(ShowMode mode, SwitchData *data)
     {}
 
-    void Window::onClose()
+    void Window::onClose(CloseReason reason)
     {}
 
     void Window::getRefreshArea(uint16_t &x, uint16_t &y, uint16_t &w, uint16_t &h)
diff --git a/module-gui/gui/widgets/Window.hpp b/module-gui/gui/widgets/Window.hpp
index b55d02e13..0cd62f4ea 100644
--- a/module-gui/gui/widgets/Window.hpp
+++ b/module-gui/gui/widgets/Window.hpp
@@ -10,7 +10,6 @@
 
 namespace gui
 {
-
     /// Base window for all UI windows
     ///
     /// It consists of:
@@ -34,6 +33,13 @@ namespace gui
         std::string name;
 
       public:
+        enum class CloseReason
+        {
+            ApplicationClose,
+            WindowSwitch,
+            PhoneLock
+        };
+
         Window() = delete;
         explicit Window(std::string name);
 
@@ -41,7 +47,7 @@ namespace gui
         /// switch data to show
         /// @note this is most likely being duplicated by handleSwitchData
         virtual void onBeforeShow(ShowMode mode, SwitchData *data);
-        virtual void onClose();
+        virtual void onClose(CloseReason reason);
         virtual void getRefreshArea(uint16_t &x, uint16_t &y, uint16_t &w, uint16_t &h);
 
         /// run prior to onBeforeShow