subscriber/src/key_gesture_manager.cpp

/*
 * Copyright (c) 2024 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "key_gesture_manager.h"

#include "account_manager.h"
#include "app_state_observer.h"
#include "display_event_monitor.h"
#include "event_log_helper.h"
#include "key_auto_repeat.h"
#ifdef OHOS_BUILD_ENABLE_KEY_PRESSED_HANDLER
#include "key_monitor_manager.h"
#endif // OHOS_BUILD_ENABLE_KEY_PRESSED_HANDLER
#include "timer_manager.h"

#undef MMI_LOG_DOMAIN
#define MMI_LOG_DOMAIN MMI_LOG_HANDLER
#undef MMI_LOG_TAG
#define MMI_LOG_TAG "KeyGestureManager"

namespace OHOS {
namespace MMI {
namespace {
constexpr int32_t COMBINATION_KEY_TIMEOUT { 150 };
constexpr int32_t INVALID_ENTITY_ID { -1 };
constexpr int32_t REPEAT_ONCE { 1 };
constexpr size_t MAX_N_PRINTABLE_ITEMS { 5 };
constexpr size_t SINGLE_KEY_PRESSED { 1 };
}

KeyGestureManager::Handler::~Handler()
{
    ResetTimer();
}

void KeyGestureManager::Handler::ResetTimer()
{
    if (timerId_ >= 0) {
        TimerMgr->RemoveTimer(timerId_);
        timerId_ = INVALID_ENTITY_ID;
    }
}

void KeyGestureManager::Handler::Trigger(std::shared_ptr<KeyEvent> keyEvent)
{
    MMI_HILOGI("[Handler] Handler(%{public}d) will run after %{public}dms", GetId(), GetLongPressTime());
    keyEvent_ = KeyEvent::Clone(keyEvent);
    timerId_ = TimerMgr->AddTimer(GetLongPressTime(), REPEAT_ONCE,
        [this]() {
            CHKPV(keyEvent_);
            Run(keyEvent_);
            keyEvent_ = nullptr;
            timerId_ = INVALID_ENTITY_ID;
        }, "KeyGestureManager");
    if (timerId_ < 0) {
        MMI_HILOGI("[Handler] AddTimer fail");
    }
}

void KeyGestureManager::Handler::Run(std::shared_ptr<KeyEvent> keyEvent) const
{
    if (callback_ != nullptr) {
        MMI_HILOGI("[Handler] Run handler(%{public}d)", GetId());
        callback_(keyEvent);
    }
}

void KeyGestureManager::Handler::RunPending()
{
    if (keyEvent_ != nullptr) {
        Run(keyEvent_);
        keyEvent_ = nullptr;
    }
}

bool KeyGestureManager::KeyGesture::IsWorking()
{
    return true;
}

int32_t KeyGestureManager::KeyGesture::AddHandler(int32_t pid, int32_t longPressTime,
    std::function<void(std::shared_ptr<KeyEvent>)> callback)
{
    static int32_t baseId { 0 };

    longPressTime = std::max(longPressTime, COMBINATION_KEY_TIMEOUT);
    return handlers_.emplace_back(++baseId, pid, longPressTime, callback).GetId();
}

bool KeyGestureManager::KeyGesture::RemoveHandler(int32_t id)
{
    for (auto iter = handlers_.begin(); iter != handlers_.end(); ++iter) {
        if (iter->GetId() == id) {
            iter->ResetTimer();
            handlers_.erase(iter);
            MMI_HILOGD("Handler(%{public}d) of key gesture was removed", id);
            return true;
        }
    }
    return false;
}

void KeyGestureManager::KeyGesture::Reset()
{
    MarkActive(false);
    ResetTimers();
}

void KeyGestureManager::KeyGesture::ResetTimers()
{
    for (auto &handler : handlers_) {
        handler.ResetTimer();
    }
}

std::set<int32_t> KeyGestureManager::KeyGesture::GetForegroundPids() const
{
    std::set<int32_t> pids;
    std::vector<AppExecFwk::AppStateData> appStates = APP_OBSERVER_MGR->GetForegroundAppData();
    std::for_each(appStates.cbegin(), appStates.cend(), [&pids](auto &appState) {
        pids.insert(appState.pid);
    });

    std::ostringstream sPids;
    size_t nItems = 0;

    if (auto iter = pids.cbegin(); iter != pids.cend()) {
        sPids << *iter;
        ++nItems;

        for (++iter; iter != pids.cend(); ++iter) {
            if (nItems > MAX_N_PRINTABLE_ITEMS) {
                sPids << ",...";
                break;
            }
            sPids << "," << *iter;
            ++nItems;
        }
    }
    MMI_HILOGI("Foreground pids: {%{public}zu}[%{public}s]", pids.size(), sPids.str().c_str());
    return pids;
}

bool KeyGestureManager::KeyGesture::HaveForegroundHandler(const std::set<int32_t> &foregroundApps) const
{
    return std::any_of(handlers_.cbegin(), handlers_.cend(), [&foregroundApps](const auto &handler) {
        return (foregroundApps.find(handler.GetPid()) != foregroundApps.cend());
    });
}

void KeyGestureManager::KeyGesture::TriggerHandlers(std::shared_ptr<KeyEvent> keyEvent)
{
    std::set<int32_t> foregroundPids = GetForegroundPids();
    bool haveForeground = HaveForegroundHandler(foregroundPids);
    ShowHandlers(std::string("TriggerHandlers"), foregroundPids);

    for (auto &handler : handlers_) {
        if (!haveForeground || (foregroundPids.find(handler.GetPid()) != foregroundPids.end())) {
            handler.Trigger(keyEvent);
        }
    }
}

void KeyGestureManager::KeyGesture::RunHandler(int32_t handlerId, std::shared_ptr<KeyEvent> keyEvent)
{
    for (auto &handler : handlers_) {
        if (handler.GetId() == handlerId) {
            handler.ResetTimer();
            handler.Run(keyEvent);
            break;
        }
    }
}

void KeyGestureManager::KeyGesture::NotifyHandlers(std::shared_ptr<KeyEvent> keyEvent)
{
    std::set<int32_t> foregroundPids = GetForegroundPids();
    bool haveForeground = HaveForegroundHandler(foregroundPids);
    ShowHandlers(std::string("NotifyHandlers"), foregroundPids);

    for (auto &handler : handlers_) {
        if (!haveForeground || (foregroundPids.find(handler.GetPid()) != foregroundPids.end())) {
            handler.Run(keyEvent);
        }
    }
}

void KeyGestureManager::KeyGesture::ShowHandlers(
    const std::string &prefix, const std::set<int32_t> &foregroundPids) const
{
    std::ostringstream output;
    size_t nHandlers = 0;

    for (const auto &handler : handlers_) {
        if (nHandlers > MAX_N_PRINTABLE_ITEMS) {
            output << "...";
            break;
        }
        ++nHandlers;
        output << "[" << handler.GetId() << "," << handler.GetPid()
            << (foregroundPids.find(handler.GetPid()) != foregroundPids.cend() ? ",F]" : ",B]");
    }
    MMI_HILOGI("[KeyGesture] %{public}s {%{public}zu}%{public}s",
        prefix.c_str(), handlers_.size(), output.str().c_str());
}

bool KeyGestureManager::LongPressSingleKey::ShouldIntercept(std::shared_ptr<KeyOption> keyOption) const
{
    std::set<int32_t> keys = keyOption->GetPreKeys();
    return (keys.empty() &&
            (keyOption->GetFinalKey() == keyCode_) &&
            keyOption->IsFinalKeyDown() &&
            (keyOption->GetFinalKeyDownDuration() < COMBINATION_KEY_TIMEOUT));
}

bool KeyGestureManager::LongPressSingleKey::Intercept(std::shared_ptr<KeyEvent> keyEvent)
{
    if ((keyEvent->GetKeyCode() == keyCode_) && (keyEvent->GetKeyAction() == KeyEvent::KEY_ACTION_DOWN)) {
        if (IsActive()) {
            int64_t now = GetSysClockTime();
            if ((now >= (firstDownTime_ + MS2US(COMBINATION_KEY_TIMEOUT))) &&
                !KeyMonitorIntercept(keyEvent)) {
                NotifyHandlers(keyEvent);
            }
        } else {
            firstDownTime_ = GetSysClockTime();
            MarkActive(true);
            if (!KeyMonitorIntercept(keyEvent, COMBINATION_KEY_TIMEOUT)) {
                TriggerHandlers(keyEvent);
            }
        }
        return true;
    }
    if (IsActive()) {
#ifdef OHOS_BUILD_ENABLE_KEY_PRESSED_HANDLER
        KEY_MONITOR_MGR->NotifyPendingMonitors();
#endif // OHOS_BUILD_ENABLE_KEY_PRESSED_HANDLER
        Reset();
        RunPendingHandlers();
    }
    return false;
}

void KeyGestureManager::LongPressSingleKey::Dump(std::ostringstream &output) const
{
    output << "[*] --> {";
    if (auto iter = handlers_.begin(); iter != handlers_.end()) {
        output << iter->GetLongPressTime();
        for (++iter; iter != handlers_.end(); ++iter) {
            output << "," << iter->GetLongPressTime();
        }
    }
    output << "}";
}

void KeyGestureManager::LongPressSingleKey::Reset()
{
#ifdef OHOS_BUILD_ENABLE_KEY_PRESSED_HANDLER
    KEY_MONITOR_MGR->ResetAll(keyCode_);
#endif // OHOS_BUILD_ENABLE_KEY_PRESSED_HANDLER
    KeyGesture::Reset();
}

void KeyGestureManager::LongPressSingleKey::RunPendingHandlers()
{
    std::set<int32_t> foregroundPids = GetForegroundPids();
    bool haveForeground = HaveForegroundHandler(foregroundPids);
    ShowHandlers(std::string("RunPendingHandlers"), foregroundPids);

    for (auto &handler : handlers_) {
        if (!haveForeground || (foregroundPids.find(handler.GetPid()) != foregroundPids.end())) {
            handler.RunPending();
        }
    }
}

bool KeyGestureManager::LongPressCombinationKey::ShouldIntercept(std::shared_ptr<KeyOption> keyOption) const
{
    std::set<int32_t> keys = keyOption->GetPreKeys();
    keys.insert(keyOption->GetFinalKey());
    return (keys_ == keys);
}

bool KeyGestureManager::LongPressCombinationKey::Intercept(std::shared_ptr<KeyEvent> keyEvent)
{
    if ((keys_.find(keyEvent->GetKeyCode()) != keys_.end()) &&
        (keyEvent->GetKeyAction() == KeyEvent::KEY_ACTION_DOWN)) {
        if (IsActive()) {
            std::ostringstream output;
            Dump(output);
            if (EventLogHelper::IsBetaVersion() && !keyEvent->HasFlag(InputEvent::EVENT_FLAG_PRIVACY_MODE)) {
                MMI_HILOGI("[LongPressCombinationKey] %s is active now", output.str().c_str());
            } else {
                MMI_HILOGI("[LongPressCombinationKey] %s is active now", output.str().c_str());
            }
            return true;
        }
        if (!IsWorking()) {
            std::ostringstream output;
            Dump(output);
            if (EventLogHelper::IsBetaVersion() && !keyEvent->HasFlag(InputEvent::EVENT_FLAG_PRIVACY_MODE)) {
                MMI_HILOGI("[LongPressCombinationKey] Switch off %s", output.str().c_str());
            } else {
                MMI_HILOGI("[LongPressCombinationKey] Switch off %s", output.str().c_str());
            }
            return false;
        }
        if (handlers_.empty()) {
            std::ostringstream output;
            Dump(output);
            if (EventLogHelper::IsBetaVersion() && !keyEvent->HasFlag(InputEvent::EVENT_FLAG_PRIVACY_MODE)) {
                MMI_HILOGI("[LongPressCombinationKey] No handler for %s", output.str().c_str());
            } else {
                MMI_HILOGI("[LongPressCombinationKey] No handler for %s", output.str().c_str());
            }
            return false;
        }
        if (RecognizeGesture(keyEvent)) {
            TriggerAll(keyEvent);
            return true;
        }
    }
    if (IsActive()) {
        Reset();
    }
    return UpdateConsumed(keyEvent);
}

void KeyGestureManager::LongPressCombinationKey::Dump(std::ostringstream &output) const
{
    output << "[**] --> {";
    if (auto iter = handlers_.begin(); iter != handlers_.end()) {
        output << "(ID:" << iter->GetId() << ",T:" << iter->GetLongPressTime() << ")";
        for (++iter; iter != handlers_.end(); ++iter) {
            output << ",(ID:" << iter->GetId() << ",T:" << iter->GetLongPressTime() << ")";
        }
    }
    output << "}";
}

void KeyGestureManager::LongPressCombinationKey::MarkKeyConsumed()
{
    consumedKeys_.insert(keys_.cbegin(), keys_.cend());
}

bool KeyGestureManager::LongPressCombinationKey::UpdateConsumed(std::shared_ptr<KeyEvent> keyEvent)
{
    if (((keyEvent->GetKeyAction() != KeyEvent::KEY_ACTION_UP) &&
         (keyEvent->GetKeyAction() != KeyEvent::KEY_ACTION_CANCEL)) ||
        (keys_.find(keyEvent->GetKeyCode()) == keys_.cend())) {
        return false;
    }
    if (auto iter = consumedKeys_.find(keyEvent->GetKeyCode()); iter != consumedKeys_.cend()) {
        consumedKeys_.erase(iter);
        return true;
    }
    return false;
}

bool KeyGestureManager::LongPressCombinationKey::RecognizeGesture(std::shared_ptr<KeyEvent> keyEvent)
{
    if ((keyEvent->GetPressedKeys().size() == SINGLE_KEY_PRESSED) && !keyEvent->IsRepeatKey()) {
        firstDownTime_ = GetSysClockTime();
    }
    int64_t now = GetSysClockTime();
    return std::all_of(keys_.cbegin(), keys_.cend(), [this, keyEvent, now](auto keyCode) {
        auto itemOpt = keyEvent->GetKeyItem(keyCode);
        return (itemOpt && itemOpt->IsPressed() &&
                (now < (firstDownTime_ + MS2US(COMBINATION_KEY_TIMEOUT))));
    });
}

void KeyGestureManager::LongPressCombinationKey::TriggerAll(std::shared_ptr<KeyEvent> keyEvent)
{
    MarkActive(true);
    std::ostringstream output;
    Dump(output);
    if (EventLogHelper::IsBetaVersion() && !keyEvent->HasFlag(InputEvent::EVENT_FLAG_PRIVACY_MODE)) {
        MMI_HILOGI("[LongPressCombinationKey] trigger %s", output.str().c_str());
    } else {
        MMI_HILOGI("[LongPressCombinationKey] trigger %s", output.str().c_str());
    }
    OnTriggerAll(keyEvent);
    TriggerHandlers(keyEvent);
}

KeyGestureManager::PullUpAccessibility::PullUpAccessibility()
    : LongPressCombinationKey(std::set({ KeyEvent::KEYCODE_VOLUME_DOWN, KeyEvent::KEYCODE_VOLUME_UP }))
{}

bool KeyGestureManager::PullUpAccessibility::IsWorking()
{
    if ((DISPLAY_MONITOR->GetScreenStatus() == EventFwk::CommonEventSupport::COMMON_EVENT_SCREEN_OFF)) {
        return false;
    }
    if (DISPLAY_MONITOR->GetScreenLocked()) {
        return ACCOUNT_MGR->GetCurrentAccountSetting().GetAccShortcutEnabledOnScreenLocked();
    } else {
        return ACCOUNT_MGR->GetCurrentAccountSetting().GetAccShortcutEnabled();
    }
}

int32_t KeyGestureManager::PullUpAccessibility::AddHandler(int32_t pid,
    int32_t longPressTime, std::function<void(std::shared_ptr<KeyEvent>)> callback)
{
    return KeyGesture::AddHandler(pid, ACCOUNT_MGR->GetCurrentAccountSetting().GetAccShortcutTimeout(),
        [this, callback](std::shared_ptr<KeyEvent> keyEvent) {
            MarkKeyConsumed();
            if (callback != nullptr) {
                callback(keyEvent);
            }
        });
}

void KeyGestureManager::PullUpAccessibility::OnTriggerAll(std::shared_ptr<KeyEvent> keyEvent)
{
    MMI_HILOGI("[PullUpAccessibility] Current AccShortcutTimeout setting:%{public}dms",
        ACCOUNT_MGR->GetCurrentAccountSetting().GetAccShortcutTimeout());
    for (auto &handler : handlers_) {
        handler.SetLongPressTime(ACCOUNT_MGR->GetCurrentAccountSetting().GetAccShortcutTimeout());
    }
}

KeyGestureManager::KeyGestureManager()
{
    keyGestures_.push_back(std::make_unique<PullUpAccessibility>());
    keyGestures_.push_back(std::make_unique<LongPressSingleKey>(KeyEvent::KEYCODE_VOLUME_DOWN));
    keyGestures_.push_back(std::make_unique<LongPressSingleKey>(KeyEvent::KEYCODE_VOLUME_UP));
}

bool KeyGestureManager::ShouldIntercept(std::shared_ptr<KeyOption> keyOption) const
{
    CALL_INFO_TRACE;
    CHKPF(keyOption);
    return std::any_of(keyGestures_.cbegin(), keyGestures_.cend(),
        [keyOption](const auto &keyGesture) {
            return keyGesture->ShouldIntercept(keyOption);
        });
}

int32_t KeyGestureManager::AddKeyGesture(int32_t pid, std::shared_ptr<KeyOption> keyOption,
    std::function<void(std::shared_ptr<KeyEvent>)> callback)
{
    CHKPR(keyOption, INVALID_ENTITY_ID);
    for (auto &keyGesture : keyGestures_) {
        CHKPC(keyGesture);
        if (keyGesture->ShouldIntercept(keyOption)) {
            auto downDuration = std::max(keyOption->GetFinalKeyDownDuration(), COMBINATION_KEY_TIMEOUT);
            return keyGesture->AddHandler(pid, downDuration, callback);
        }
    }
    return INVALID_ENTITY_ID;
}

void KeyGestureManager::RemoveKeyGesture(int32_t id)
{
    for (auto &keyGesture : keyGestures_) {
        if (keyGesture->RemoveHandler(id)) {
            break;
        }
    }
}

bool KeyGestureManager::Intercept(std::shared_ptr<KeyEvent> keyEvent)
{
    CALL_INFO_TRACE;
    CHKPF(keyEvent);
    for (auto iter = keyGestures_.begin(); iter != keyGestures_.end(); ++iter) {
        CHKPC(*iter);
        if ((*iter)->Intercept(keyEvent)) {
            std::ostringstream output;
            (*iter)->Dump(output);
            if (EventLogHelper::IsBetaVersion() && !keyEvent->HasFlag(InputEvent::EVENT_FLAG_PRIVACY_MODE)) {
                MMI_HILOGI("Intercepted by %s", output.str().c_str());
            } else {
                MMI_HILOGI("Intercepted by %s", output.str().c_str());
            }
            for (++iter; iter != keyGestures_.end(); ++iter) {
                (*iter)->Reset();
            }
            return true;
        }
    }
    return false;
}

void KeyGestureManager::ResetAll()
{
    for (auto &keyGesture : keyGestures_) {
        CHKPC(keyGesture);
        keyGesture->Reset();
    }
}

void KeyGestureManager::Dump() const
{
    for (const auto &keyGesture : keyGestures_) {
        std::ostringstream output;
        CHKPC(keyGesture);
        keyGesture->Dump(output);
        MMI_HILOGI("%s", output.str().c_str());
    }
}

bool KeyGestureManager::KeyMonitorIntercept(std::shared_ptr<KeyEvent> keyEvent)
{
#ifdef OHOS_BUILD_ENABLE_KEY_PRESSED_HANDLER
    return KEY_MONITOR_MGR->Intercept(keyEvent);
#else
    return false;
#endif // OHOS_BUILD_ENABLE_KEY_PRESSED_HANDLER
}

bool KeyGestureManager::KeyMonitorIntercept(std::shared_ptr<KeyEvent> keyEvent, int32_t delay)
{
#ifdef OHOS_BUILD_ENABLE_KEY_PRESSED_HANDLER
    return KEY_MONITOR_MGR->Intercept(keyEvent, delay);
#else
    return false;
#endif // OHOS_BUILD_ENABLE_KEY_PRESSED_HANDLER
}
} // namespace MMI
} // namespace OHOS