path: root/src/core/thread/Task.cpp

/**
 * Copyright (C) 2021 Saturneric <[email protected]>
 *
 * This file is part of GpgFrontend.
 *
 * GpgFrontend is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * GpgFrontend is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
 *
 * The initial version of the source code is inherited from
 * the gpg4usb project, which is under GPL-3.0-or-later.
 *
 * All the source code of GpgFrontend was modified and released by
 * Saturneric <[email protected]> starting on May 12, 2021.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#include "core/thread/Task.h"

#include <qscopedpointer.h>

#include <utility>

#include "utils/MemoryUtils.h"

namespace GpgFrontend::Thread {

class Task::Impl {
 public:
  Impl(Task *parent, QString name)
      : parent_(parent), uuid_(generate_uuid()), name_(name) {
    GF_CORE_LOG_TRACE("task {} created", GetFullID());
    init();
  }

  Impl(Task *parent, TaskRunnable runnable, QString name,
       DataObjectPtr data_object)
      : parent_(parent),
        uuid_(generate_uuid()),
        name_(std::move(name)),
        runnable_(std::move(runnable)),
        callback_([](int, const DataObjectPtr &) {}),
        callback_thread_(QThread::currentThread()),
        data_object_(std::move(data_object)) {
    GF_CORE_LOG_TRACE("task {} created with runnable, callback_thread_: {}",
                      GetFullID(), static_cast<void *>(callback_thread_));
    init();
  }

  Impl(Task *parent, TaskRunnable runnable, QString name,
       DataObjectPtr data_object, TaskCallback callback)
      : parent_(parent),
        uuid_(generate_uuid()),
        name_(std::move(name)),
        runnable_(std::move(runnable)),
        callback_(std::move(callback)),
        callback_thread_(QThread::currentThread()),
        data_object_(std::move(data_object)) {
    GF_CORE_LOG_TRACE(
        "task {} created with runnable and callback, callback_thread_: {}",
        GetFullID(), static_cast<void *>(callback_thread_));
    init();
  }

  ~Impl() { GF_CORE_LOG_TRACE("task {} destroyed", GetFullID()); }

  /**
   * @brief
   *
   * @return QString
   */
  [[nodiscard]] auto GetFullID() const -> QString {
    return uuid_ + "/" + name_;
  }

  auto GetUUID() const -> QString { return uuid_; }

  void Run() {
    GF_CORE_LOG_TRACE("task {} is using default runnable and callback mode",
                      GetFullID());
    if (runnable_) {
      SetRTN(runnable_(data_object_));
    } else {
      GF_CORE_LOG_WARN("no runnable in task, do callback operation");
    }
  }

  /**
   * @brief Set the Finish After Run object
   *
   * @param finish_after_run
   */
  void HoldOnLifeCycle(bool hold_on) { parent_->setAutoDelete(!hold_on); }

  /**
   * @brief
   *
   * @param rtn
   */
  void SetRTN(int rtn) { this->rtn_ = rtn; }

 private:
  Task *const parent_;
  const QString uuid_;
  const QString name_;
  TaskRunnable runnable_;                ///<
  TaskCallback callback_;                ///<
  int rtn_ = 0;                          ///<
  QThread *callback_thread_ = nullptr;   ///<
  DataObjectPtr data_object_ = nullptr;  ///<

  void init() {
    GF_CORE_LOG_TRACE("task {} created, parent: {}, impl: {}", name_,
                      (void *)parent_, (void *)this);

    //
    HoldOnLifeCycle(false);

    //
    connect(parent_, &Task::SignalRun, parent_, [=]() { inner_run(); });

    //
    connect(parent_, &Task::SignalTaskShouldEnd, parent_,
            [=](int rtn) { slot_task_should_end(rtn); });

    //
    connect(parent_, &Task::SignalTaskEnd, parent_, &Task::deleteLater);
  }

  /**
   * @brief
   *
   */
  void inner_run() {
    try {
      GF_CORE_LOG_TRACE("task {} is starting...", GetFullID());
      // Run() will set rtn by itself
      parent_->Run();
      GF_CORE_LOG_TRACE("task {} was end.", GetFullID());
    } catch (std::exception &e) {
      GF_CORE_LOG_ERROR("exception was caught at task: {}", e.what());
    }
    // raise signal to anounce after runnable returned
    if (parent_->autoDelete()) emit parent_->SignalTaskShouldEnd(rtn_);
  }

  /**
   * @brief
   *
   * @return QString
   */
  static auto generate_uuid() -> QString {
    return QUuid::createUuid().toString();
  }

  /**
   * @brief
   *
   */
  void slot_task_should_end(int rtn) {
    GF_CORE_LOG_TRACE("task runnable {} finished, rtn: {}", GetFullID(), rtn);
    // set return value
    this->SetRTN(rtn);
#ifdef RELEASE
    try {
#endif
      if (callback_) {
        GF_CORE_LOG_TRACE("task {} has a callback function", GetFullID());
        if (callback_thread_ == QThread::currentThread()) {
          GF_CORE_LOG_TRACE(
              "for task {}, the callback thread is the same thread",
              GetFullID(), callback_thread_->currentThreadId());

          callback_(rtn, data_object_);

          // raise signal, announcing this task comes to an end
          GF_CORE_LOG_TRACE(
              "for task {}, its life comes to an end in the same thread after "
              "its callback executed.",
              parent_->GetFullID());
          emit parent_->SignalTaskEnd();
        } else {
          GF_CORE_LOG_TRACE(
              "for task {}, callback thread is a different thread: {}",
              GetFullID(), callback_thread_->currentThreadId());
          if (!QMetaObject::invokeMethod(
                  callback_thread_,
                  [callback = callback_, rtn = rtn_, data_object = data_object_,
                   parent_ = this->parent_]() {
                    GF_CORE_LOG_TRACE("calling callback of task {}",
                                      parent_->GetFullID());
#ifdef RELEASE
                    try {
#endif
                      callback(rtn, data_object);
#ifdef RELEASE
                    } catch (...) {
                      GF_CORE_LOG_ERROR(
                          "unknown exception was caught when execute "
                          "callback of task {}",
                          parent_->GetFullID());
                    }
#endif
                    // raise signal, announcing this task comes to an end
                    GF_CORE_LOG_TRACE(
                        "for task {}, its life comes to an end whether its "
                        "callback function fails or not.",
                        parent_->GetFullID());
                    emit parent_->SignalTaskEnd();
                  })) {
            GF_CORE_LOG_ERROR(
                "task {} had failed to invoke the callback function to target "
                "thread",
                GetFullID());
            GF_CORE_LOG_TRACE(
                "for task {}, its life must come to an end now, although it "
                "has something not done yet.",
                GetFullID());
            emit parent_->SignalTaskEnd();
          }
        }
      } else {
        // raise signal, announcing this task comes to an end
        GF_CORE_LOG_TRACE(
            "for task {}, its life comes to an end without callback "
            "peacefully.",
            GetFullID());
        emit parent_->SignalTaskEnd();
      }
#ifdef RELEASE
    } catch (std::exception &e) {
      GF_CORE_LOG_ERROR("exception was caught at task callback: {}", e.what());
      // raise signal, announcing this task comes to an end
      GF_CORE_LOG_TRACE("for task {}, its life comes to an end at chaos.",
                        GetFullID());
      emit parent_->SignalTaskEnd();
    } catch (...) {
      GF_CORE_LOG_ERROR("unknown exception was caught");
      // raise signal, announcing this task comes to an end
      GF_CORE_LOG_TRACE(
          "for task {}, its life comes to an end at unknown chaos.",
          GetFullID());
      emit parent_->SignalTaskEnd();
    }
#endif
  }
};

Task::Task(QString name) : p_(new Impl(this, name)) {}

Task::Task(TaskRunnable runnable, QString name, DataObjectPtr data_object)
    : p_(SecureCreateUniqueObject<Impl>(this, runnable, name, data_object)) {}

Task::Task(TaskRunnable runnable, QString name, DataObjectPtr data_object,
           TaskCallback callback)
    : p_(SecureCreateUniqueObject<Impl>(this, runnable, name, data_object,
                                        callback)) {}

Task::~Task() = default;

/**
 * @brief
 *
 * @return QString
 */
QString Task::GetFullID() const { return p_->GetFullID(); }

QString Task::GetUUID() const { return p_->GetUUID(); }

void Task::HoldOnLifeCycle(bool hold_on) { p_->HoldOnLifeCycle(hold_on); }

void Task::SetRTN(int rtn) { p_->SetRTN(rtn); }

void Task::SafelyRun() { emit SignalRun(); }

void Task::Run() { p_->Run(); }

void Task::run() {
  GF_CORE_LOG_TRACE("interface run() of task {} was called by thread: {}",
                    GetFullID(), QThread::currentThread()->currentThreadId());
  this->SafelyRun();
}

}  // namespace GpgFrontend::Thread