InfiniTimeOrg#1359: Introduce a restricted clock-only-mode when not woken with the button (#24)

* SystemTask: implement screen locked until button is pressed

When the device is woken through pressing the button everything is the
same.

But when woken through other means like single-tap or raise-to-wake,
then the screen is locked (and showing a lock screen on touch input)
until the button is pressed.

Only exception is when the alarm wakes the screen, then touch input is
still valid for the user to be able to press the red "stop alarm"
button.

Co-authored-by: NeroBurner <pyro4hell@gmail.com>

* PopupMessage: little cleanup, more const

* SystemTask: clang-format

* Always hide lock popup when changing appview

It fixes a potential double-free when removing lock popup

* SystemTask: unlock at double button press as well, fixes segfault

* SystemTask: hide lock before going to sleep

* PopupMessage: update popup pointer when object is deleted

Add a lvlg event handler when the `popup` object is deleted. This helps
to prevent double free memory errors due to `PopupMessage` class not
recognizing that the `popup` object was deleted by someone else (for
example when switching away from a notification)

---------

Co-authored-by: Tomas Groth <second@tgc.dk>
Co-authored-by: NeroBurner <pyro4hell@gmail.com>
Co-authored-by: sim <git@sgougeon.fr>

Author: 4 people

src/CMakeLists.txt

@@ -403,6 +403,7 @@ list(APPEND SOURCE_FILES
         displayapp/widgets/PageIndicator.cpp
         displayapp/widgets/DotIndicator.cpp
         displayapp/widgets/StatusIcons.cpp
+        displayapp/widgets/PopupMessage.cpp
 
         ## Settings
         displayapp/screens/settings/QuickSettings.cpp

src/displayapp/DisplayApp.cpp

@@ -485,6 +485,12 @@ void DisplayApp::Refresh() {
         LoadNewScreen(Apps::Clock, DisplayApp::FullRefreshDirections::None);
         motorController.RunForDuration(35);
         break;
+      case Messages::ShowIgnoreTouchPopup:
+        popupMessage.SetHidden(false);
+        break;
+      case Messages::HideIgnoreTouchPopup:
+        popupMessage.SetHidden(true);
+        break;
     }
   }
 
@@ -508,6 +514,11 @@ void DisplayApp::LoadNewScreen(Apps app, DisplayApp::FullRefreshDirections direc
   // This is mainly to fix an issue with receiving two notifications at the same time
   // and shouldn't happen otherwise.
   if (app != currentApp) {
+    // We need to remove the popup
+    // If we keep the popup linked to the previous view, and this view is deleted, a bug will occur if we try to re-remove the popup.
+    // Not removing the popup will also prevent the popup to be raised on top of
+    // the new app
+    popupMessage.SetHidden(true);
     returnAppStack.Push(currentApp);
     appStackDirections.Push(direction);
   }

src/displayapp/DisplayApp.h

@@ -16,6 +16,7 @@
 #include "components/stopwatch/StopWatchController.h"
 #include "components/alarm/AlarmController.h"
 #include "touchhandler/TouchHandler.h"
+#include "displayapp/widgets/PopupMessage.h"
 
 #include "displayapp/Messages.h"
 #include "BootErrors.h"
@@ -105,6 +106,7 @@ namespace Pinetime {
       Pinetime::Controllers::FirmwareValidator validator;
       Pinetime::Components::LittleVgl lvgl;
       Pinetime::Controllers::Timer timer;
+      Pinetime::Applications::Widgets::PopupMessage popupMessage;
 
       AppControllers controllers;
       TaskHandle_t taskHandle;

src/displayapp/Messages.h

@@ -24,6 +24,8 @@ namespace Pinetime {
         AlarmTriggered,
         Chime,
         BleRadioEnableToggle,
+        ShowIgnoreTouchPopup,
+        HideIgnoreTouchPopup
       };
     }
   }

src/displayapp/widgets/PopupMessage.cpp

@@ -0,0 +1,75 @@
+#include "displayapp/widgets/PopupMessage.h"
+#include "displayapp/InfiniTimeTheme.h"
+#include <libraries/log/nrf_log.h>
+
+using namespace Pinetime::Applications::Widgets;
+
+namespace {
+  void event_handler(lv_obj_t* obj, lv_event_t event) {
+    auto* popupMessage = static_cast<PopupMessage*>(obj->user_data);
+    if (event == LV_EVENT_DELETE) {
+      popupMessage->HandleDelete(obj, event);
+    }
+  }
+}
+
+void PopupMessage::HandleDelete(lv_obj_t* object, lv_event_t event) {
+  if (object == popup && event == LV_EVENT_DELETE) {
+    // make sure to update the state of the popup pointer when someone
+    // deletes the popup object
+    popup = nullptr;
+    isHidden = true;
+  }
+}
+
+void PopupMessage::Create() {
+  popup = lv_obj_create(lv_scr_act(), nullptr);
+  lv_obj_set_size(popup, 90, 90);
+  lv_obj_align(popup, lv_scr_act(), LV_ALIGN_CENTER, 0, 0);
+  lv_obj_set_style_local_bg_color(popup, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, Colors::bg);
+  lv_obj_set_style_local_bg_opa(popup, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_OPA_60);
+  lv_obj_t* lockBody = lv_obj_create(popup, nullptr);
+  lv_obj_set_size(lockBody, 55, 50);
+  lv_obj_align(lockBody, popup, LV_ALIGN_CENTER, 0, 10);
+
+  lv_obj_set_style_local_bg_color(lockBody, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_COLOR_WHITE);
+  lv_obj_set_style_local_bg_opa(lockBody, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_OPA_0);
+  lv_obj_set_style_local_border_color(lockBody, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_COLOR_WHITE);
+  lv_obj_set_style_local_border_width(lockBody, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, 22);
+  lv_obj_set_style_local_border_side(lockBody, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_BORDER_SIDE_FULL);
+  lv_obj_set_style_local_border_opa(lockBody, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_OPA_100);
+
+  lv_obj_t* lockTop = lv_obj_create(popup, nullptr);
+  lv_obj_set_size(lockTop, 30, 35);
+  lv_obj_align(lockTop, popup, LV_ALIGN_CENTER, 0, -20);
+  lv_obj_set_style_local_bg_color(lockTop, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_COLOR_WHITE);
+  lv_obj_set_style_local_bg_opa(lockTop, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_OPA_0);
+  lv_obj_set_style_local_border_color(lockTop, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_COLOR_WHITE);
+  lv_obj_set_style_local_border_width(lockTop, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, 6);
+  lv_obj_set_style_local_border_side(lockTop, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_BORDER_SIDE_FULL);
+  lv_obj_set_style_local_border_opa(lockTop, LV_OBJ_PART_MAIN, LV_STATE_DEFAULT, LV_OPA_100);
+
+  // handler to keep popup pointer in sync
+  popup->user_data = this;
+  lv_obj_set_event_cb(popup, event_handler);
+
+  lv_obj_set_hidden(popup, isHidden);
+}
+
+void PopupMessage::SetHidden(const bool hidden) {
+  if (isHidden == hidden) {
+    return;
+  }
+  isHidden = hidden;
+  // create/delete on demand
+  if (popup == nullptr && !isHidden) {
+    Create();
+  } else if (popup != nullptr) {
+    lv_obj_del(popup);
+    popup = nullptr;
+  }
+}
+
+bool PopupMessage::IsHidden() const {
+  return isHidden;
+}

src/displayapp/widgets/PopupMessage.h

@@ -0,0 +1,18 @@
+#pragma once
+#include <lvgl/lvgl.h>
+
+namespace Pinetime::Applications::Widgets {
+  class PopupMessage {
+  public:
+    PopupMessage() = default;
+    void Create();
+    void SetHidden(bool hidden);
+    bool IsHidden() const;
+    // public function only to be used by lvgl handler
+    void HandleDelete(lv_obj_t* object, lv_event_t event);
+
+  private:
+    lv_obj_t* popup = nullptr;
+    bool isHidden = true;
+  };
+}

src/systemtask/SystemTask.cpp

@@ -232,6 +232,7 @@ void SystemTask::Work() {
           }
           break;
         case Messages::SetOffAlarm:
+          unlockedByButton = true; // unlock so it is possible to press red stop button
           GoToRunning();
           displayApp.PushMessage(Pinetime::Applications::Display::Messages::AlarmTriggered);
           break;
@@ -241,6 +242,7 @@ void SystemTask::Work() {
           bleDiscoveryTimer = 5;
           break;
         case Messages::BleFirmwareUpdateStarted:
+          unlockedByButton = true; // prevent no screen-locked popup on firmware update
           GoToRunning();
           wakeLocksHeld++;
           displayApp.PushMessage(Pinetime::Applications::Display::Messages::BleFirmwareUpdateStarted);
@@ -268,7 +270,14 @@ void SystemTask::Work() {
             break;
           }
           if (state == SystemTaskState::Running) {
-            displayApp.PushMessage(Pinetime::Applications::Display::Messages::TouchEvent);
+            if (unlockedByButton) {
+              displayApp.PushMessage(Pinetime::Applications::Display::Messages::TouchEvent);
+            } else {
+              auto gesture = touchHandler.GestureGet();
+              if (gesture != Pinetime::Applications::TouchEvents::None) {
+                displayApp.PushMessage(Pinetime::Applications::Display::Messages::ShowIgnoreTouchPopup);
+              }
+            }
           } else {
             // If asleep, check for touch panel wake triggers
             auto gesture = touchHandler.GestureGet();
@@ -290,6 +299,7 @@ void SystemTask::Work() {
             action = buttonHandler.HandleEvent(Controllers::ButtonHandler::Events::Press);
             // This is for faster wakeup, sacrificing special longpress and doubleclick handling while sleeping
             if (IsSleeping()) {
+              unlockedByButton = true;
               fastWakeUpDone = true;
               GoToRunning();
               break;
@@ -331,6 +341,8 @@ void SystemTask::Work() {
           } else {
             state = SystemTaskState::AODSleeping;
           }
+          // lock when going to sleep
+          unlockedByButton = false;
           break;
         case Messages::OnNewDay:
           motionSensor.ResetStepCounter();
@@ -437,12 +449,14 @@ void SystemTask::GoToSleep() {
     return;
   }
   NRF_LOG_INFO("[systemtask] Going to sleep");
+  displayApp.PushMessage(Pinetime::Applications::Display::Messages::HideIgnoreTouchPopup);
   if (settingsController.GetAlwaysOnDisplay()) {
     displayApp.PushMessage(Pinetime::Applications::Display::Messages::GoToAOD);
   } else {
     displayApp.PushMessage(Pinetime::Applications::Display::Messages::GoToSleep);
   }
   heartRateApp.PushMessage(Pinetime::Applications::HeartRateTask::Messages::GoToSleep);
+  unlockedByButton = false;
 
   state = SystemTaskState::GoingToSleep;
 };
@@ -481,10 +495,21 @@ void SystemTask::HandleButtonAction(Controllers::ButtonActions action) {
     case Actions::Click:
       // If the first action after fast wakeup is a click, it should be ignored.
       if (!fastWakeUpDone) {
-        displayApp.PushMessage(Applications::Display::Messages::ButtonPushed);
+        if (!unlockedByButton) {
+          // the first button event unlocks the touch input
+          unlockedByButton = true;
+          displayApp.PushMessage(Pinetime::Applications::Display::Messages::HideIgnoreTouchPopup);
+        } else {
+          displayApp.PushMessage(Applications::Display::Messages::ButtonPushed);
+        }
       }
       break;
     case Actions::DoubleClick:
+      if (!unlockedByButton) {
+        // the first button event unlocks the touch input
+        unlockedByButton = true;
+        displayApp.PushMessage(Pinetime::Applications::Display::Messages::HideIgnoreTouchPopup);
+      }
       displayApp.PushMessage(Applications::Display::Messages::ButtonDoubleClicked);
       break;
     case Actions::LongPress:

src/systemtask/SystemTask.h

@@ -144,6 +144,8 @@ namespace Pinetime {
       void UpdateMotion();
       static constexpr TickType_t batteryMeasurementPeriod = pdMS_TO_TICKS(10 * 60 * 1000);
 
+      bool unlockedByButton = true;
+
       SystemMonitor monitor;
     };
   }