nxdumptool/source/options_tab.cpp

/*
 * options_tab.cpp
 *
 * Copyright (c) 2020-2022, DarkMatterCore <pabloacurielz@gmail.com>.
 *
 * This file is part of nxdumptool (https://github.com/DarkMatterCore/nxdumptool).
 *
 * nxdumptool 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.
 *
 * nxdumptool 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 this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#include <nxdt_utils.h>
#include <options_tab.hpp>
#include <root_view.hpp>
#include <focusable_item.hpp>
#include <title.h>
#include <sstream>

namespace i18n = brls::i18n;    /* For getStr(). */
using namespace i18n::literals; /* For _i18n. */

namespace nxdt::views
{
    OptionsTabUpdateProgress::OptionsTabUpdateProgress(void)
    {
        this->progress_display = new brls::ProgressDisplay();
        this->progress_display->setParent(this);
        
        this->size_lbl = new brls::Label(brls::LabelStyle::MEDIUM, "", false);
        this->size_lbl->setVerticalAlign(NVG_ALIGN_BOTTOM);
        this->size_lbl->setParent(this);
        
        this->speed_eta_lbl = new brls::Label(brls::LabelStyle::MEDIUM, "", false);
        this->speed_eta_lbl->setVerticalAlign(NVG_ALIGN_TOP);
        this->speed_eta_lbl->setParent(this);
    }
    
    OptionsTabUpdateProgress::~OptionsTabUpdateProgress(void)
    {
        delete this->progress_display;
        delete this->size_lbl;
        delete this->speed_eta_lbl;
    }
    
    void OptionsTabUpdateProgress::SetProgress(const nxdt::tasks::DownloadTaskProgress& progress)
    {
        /* Update progress percentage. */
        this->progress_display->setProgress(progress.percentage, 100);
        
        /* Update size string. */
        this->size_lbl->setText(fmt::format("{} / {}", this->GetFormattedSizeString(static_cast<double>(progress.current)), \
                                                         progress.size ? this->GetFormattedSizeString(static_cast<double>(progress.size)) : "?"));
        
        /* Update speed / ETA string. */
        if (progress.eta.length())
        {
            this->speed_eta_lbl->setText(fmt::format("{}/s - ETA: {}", this->GetFormattedSizeString(progress.speed), progress.eta));
        } else {
            this->speed_eta_lbl->setText(fmt::format("{}/s", this->GetFormattedSizeString(progress.speed)));
        }
        
        this->invalidate();
    }
    
    void OptionsTabUpdateProgress::willAppear(bool resetState)
    {
        this->progress_display->willAppear(resetState);
    }
    
    void OptionsTabUpdateProgress::willDisappear(bool resetState)
    {
        this->progress_display->willDisappear(resetState);
    }
    
    void OptionsTabUpdateProgress::draw(NVGcontext* vg, int x, int y, unsigned width, unsigned height, brls::Style* style, brls::FrameContext* ctx)
    {
        /* Progress display. */
        this->progress_display->frame(ctx);
        
        /* Size label. */
        this->size_lbl->frame(ctx);
        
        /* Speed / ETA label. */
        this->speed_eta_lbl->frame(ctx);
    }
    
    void OptionsTabUpdateProgress::layout(NVGcontext* vg, brls::Style* style, brls::FontStash* stash)
    {
        unsigned elem_width = roundf(static_cast<float>(this->width) * 0.90f);
        
        /* Progress display. */
        this->progress_display->setBoundaries(
            this->x + (this->width - elem_width) / 2,
            this->y + (this->height - style->CrashFrame.buttonHeight) / 2,
            elem_width,
            style->CrashFrame.buttonHeight);
        
        this->progress_display->invalidate(true);
        
        /* Size label. */
        this->size_lbl->setWidth(elem_width);
        this->size_lbl->invalidate(true);
        
        this->size_lbl->setBoundaries(
            this->x + (this->width - this->size_lbl->getWidth()) / 2,
            this->progress_display->getY() - this->progress_display->getHeight() / 8,
            this->size_lbl->getWidth(),
            this->size_lbl->getHeight());
        
        /* Speed / ETA label. */
        this->speed_eta_lbl->setWidth(elem_width);
        this->speed_eta_lbl->invalidate(true);
        
        this->speed_eta_lbl->setBoundaries(
            this->x + (this->width - this->speed_eta_lbl->getWidth()) / 2,
            this->progress_display->getY() + this->progress_display->getHeight() + this->progress_display->getHeight() / 8,
            this->speed_eta_lbl->getWidth(),
            this->speed_eta_lbl->getHeight());
    }
    
    std::string OptionsTabUpdateProgress::GetFormattedSizeString(double size)
    {
        char strbuf[0x40] = {0};
        utilsGenerateFormattedSizeString(size, strbuf, sizeof(strbuf));
        return std::string(strbuf);
    }
    
    OptionsTabUpdateFileDialog::OptionsTabUpdateFileDialog(std::string path, std::string url, bool force_https, std::string success_str) : brls::Dialog(), success_str(success_str)
    {
        /* Set content view. */
        OptionsTabUpdateProgress *update_progress = new OptionsTabUpdateProgress();
        this->setContentView(update_progress);
        
        /* Add cancel button. */
        this->addButton("options_tab/update_dialog/cancel"_i18n, [this](brls::View* view) {
            /* Cancel download task. */
            this->download_task.cancel();
            
            /* Close dialog. */
            this->close();
        });
        
        /* Disable cancelling with B button. */
        this->setCancelable(false);
        
        /* Subscribe to the download task. */
        this->download_task.RegisterListener([this, update_progress](const nxdt::tasks::DownloadTaskProgress& progress) {
            /* Update progress. */
            update_progress->SetProgress(progress);
            
            /* Check if the download task has finished. */
            if (this->download_task.isFinished())
            {
                /* Stop spinner. */
                update_progress->willDisappear();
                
                /* Update button label. */
                this->setButtonText(0, "options_tab/update_dialog/close"_i18n);
                
                /* Display notification. */
                brls::Application::notify(this->download_task.get() ? this->success_str : "options_tab/notifications/update_failed"_i18n);
            }
        });
        
        /* Start download task. */
        this->download_task.execute(path, url, force_https);
    }
    
    OptionsTabUpdateApplicationFrame::OptionsTabUpdateApplicationFrame(void) : brls::StagedAppletFrame(false)
    {
        /* Set UI properties. */
        this->setTitle("options_tab/update_app/label"_i18n);
        this->setIcon(BOREALIS_ASSET("icon/" APP_TITLE ".jpg"));
        
        /* Add first stage. */
        this->wait_lbl = new brls::Label(brls::LabelStyle::DIALOG, "options_tab/update_app/frame/please_wait"_i18n, false);
        this->wait_lbl->setHorizontalAlign(NVG_ALIGN_CENTER);
        this->addStage(this->wait_lbl);
        
        /* Add second stage. */
        this->changelog_list = new brls::List();
        this->changelog_list->setSpacing(this->changelog_list->getSpacing() / 2);
        this->changelog_list->setMarginBottom(20);
        this->addStage(this->changelog_list);
        
        /* Add third stage. */
        this->update_progress = new OptionsTabUpdateProgress();
        this->addStage(this->update_progress);
        
        /* Register cancel action. */
        this->registerAction("brls/hints/back"_i18n, brls::Key::B, [this](void) {
            return this->onCancel();
        });
        
        /* Subscribe to the global focus change event so we can rebuild hints as soon as this frame is pushed to the view stack. */
        this->focus_event_sub = brls::Application::getGlobalFocusChangeEvent()->subscribe([this](brls::View* view) {
            this->rebuildHints();
        });
        
        /* Subscribe to the JSON task. */
        this->json_task.RegisterListener([this](const nxdt::tasks::DownloadTaskProgress& progress) {
            /* Return immediately if the JSON task hasn't finished. */
            if (!this->json_task.isFinished()) return;
            
            bool pop_view = false;
            std::string notification = "";
            
            /* Retrieve task result. */
            nxdt::tasks::DownloadDataResult json_task_result = this->json_task.get();
            this->json_buf = json_task_result.first;
            this->json_buf_size = json_task_result.second;
            
            /* Parse downloaded JSON object. */
            if (utilsParseGitHubReleaseJsonData(this->json_buf, this->json_buf_size, &(this->json_data)))
            {
                /* Check if the application can be updated. */
                if (utilsIsApplicationUpdatable(this->json_data.version, this->json_data.commit_hash))
                {
                    /* Display changelog. */
                    this->DisplayChangelog();
                } else {
                    /* Update flag. */
                    pop_view = true;
                    
                    /* Set notification string. */
                    notification = "options_tab/notifications/up_to_date"_i18n;
                }
            } else {
                /* Log downloaded data. */
                LOG_DATA(this->json_buf, this->json_buf_size, "Failed to parse GitHub release JSON. Downloaded data:");
                
                /* Update flag. */
                pop_view = true;
                
                /* Set notification string. */
                notification = "options_tab/notifications/github_json_failed"_i18n;
            }
            
            /* Pop view (if needed). */
            if (pop_view)
            {
                /* Display notification. */
                brls::Application::notify(notification);
                
                /* Pop view. */
                this->onCancel();
            }
        });
        
        /* Start JSON task. */
        this->json_task.execute(GITHUB_API_RELEASE_URL, true);
    }
    
    OptionsTabUpdateApplicationFrame::~OptionsTabUpdateApplicationFrame(void)
    {
        /* Free parsed JSON data. */
        utilsFreeGitHubReleaseJsonData(&(this->json_data));
        
        /* Free JSON buffer. */
        if (this->json_buf) free(this->json_buf);
        
        /* Unsubscribe focus event listener. */
        brls::Application::getGlobalFocusChangeEvent()->unsubscribe(this->focus_event_sub);
    }
    
    void OptionsTabUpdateApplicationFrame::layout(NVGcontext* vg, brls::Style* style, brls::FontStash* stash)
    {
        brls::StagedAppletFrame::layout(vg, style, stash);
        
        if (this->getCurrentStage() == 0)
        {
            /* Center wait label. */
            this->wait_lbl->setBoundaries(this->x + (this->width / 2), this->y, this->width, this->height);
            this->wait_lbl->invalidate();
        }
    }
    
    bool OptionsTabUpdateApplicationFrame::onCancel(void)
    {
        /* Cancel NRO task. */
        this->nro_task.cancel();
        
        /* Cancel JSON task. */
        this->json_task.cancel();
        
        /* Pop view. */
        brls::Application::popView(brls::ViewAnimation::SLIDE_RIGHT);
        
        return true;
    }
    
    void OptionsTabUpdateApplicationFrame::DisplayChangelog(void)
    {
        std::string item;
        std::stringstream ss(std::string(this->json_data.changelog));
        
        /* Display version string at the top. */
        FocusableLabel *version_lbl = new FocusableLabel(brls::LabelStyle::CRASH, std::string(this->json_data.version), true);
        version_lbl->setHorizontalAlign(NVG_ALIGN_CENTER);
        this->changelog_list->addView(version_lbl);
        
        /* Display release date and commit hash. */
        brls::Label *release_details_lbl = new brls::Label(brls::LabelStyle::DESCRIPTION, i18n::getStr("options_tab/update_app/frame/release_details"_i18n, \
                                                           this->json_data.commit_hash, RootView::GetFormattedDateString(this->json_data.date)), true);
        release_details_lbl->setHorizontalAlign(NVG_ALIGN_CENTER);
        this->changelog_list->addView(release_details_lbl);
        
        /* Add changelog header. */
        this->changelog_list->addView(new brls::Header("options_tab/update_app/frame/changelog_header"_i18n));
        
        /* Split changelog string and fill list. */
        while(std::getline(ss, item))
        {
            /* Don't proceed if this is an empty line. */
            /* Make sure to remove any possible carriage returns. */
            size_t item_len = item.length();
            if (!item_len) continue;
            
            if (item.back() == '\r')
            {
                if (item_len > 1)
                {
                    item.pop_back();
                } else {
                    continue;
                }
            }
            
            /* Add line to the changelog view. */
            this->changelog_list->addView(new FocusableLabel(brls::LabelStyle::SMALL, item, true));
        }
        
        /* Register update action. */
        this->registerAction("options_tab/update_app/frame/update_action"_i18n, brls::Key::PLUS, [this](void) {
            /* Display update progress. */
            this->DisplayUpdateProgress();
            
            return true;
        });
        
        /* Rebuild action hints. */
        this->rebuildHints();
        
        /* Go to the next stage. */
        this->nextStage();
    }
    
    void OptionsTabUpdateApplicationFrame::DisplayUpdateProgress(void)
    {
        /* Remove update action. */
        this->registerAction("options_tab/update_app/frame/update_action"_i18n, brls::Key::PLUS, [](void) {
            return true;
        }, true);
        
        /* Register cancel action once more, using a different label. */
        this->registerAction("options_tab/update_dialog/cancel"_i18n, brls::Key::B, [this](void) {
            return this->onCancel();
        });
        
        /* Rebuild action hints. */
        this->rebuildHints();
        
        /* Subscribe to the NRO task. */
        this->nro_task.RegisterListener([this](const nxdt::tasks::DownloadTaskProgress& progress) {
            /* Update progress. */
            this->update_progress->SetProgress(progress);
            
            /* Check if the download task has finished. */
            if (this->nro_task.isFinished())
            {
                /* Get NRO task result and immediately set application updated state if the task succeeded. */
                bool ret = this->nro_task.get();
                if (ret) utilsSetApplicationUpdatedState();
                
                /* Display notification. */
                brls::Application::notify(ret ? "options_tab/notifications/app_updated"_i18n : "options_tab/notifications/update_failed"_i18n);
                
                /* Pop view */
                this->onCancel();
            }
        });
        
        /* Start NRO task. */
        this->nro_task.execute(NRO_TMP_PATH, std::string(this->json_data.download_url), true);
        
        /* Go to the next stage. */
        this->nextStage();
    }
    
    OptionsTab::OptionsTab(RootView *root_view) : brls::List(), root_view(root_view)
    {
        /* Set custom spacing. */
        this->setSpacing(this->getSpacing() / 2);
        this->setMarginBottom(20);
        
        /* Information about actual dump options. */
        brls::Label *dump_options_info = new brls::Label(brls::LabelStyle::DESCRIPTION, "options_tab/dump_options_info"_i18n, true);
        dump_options_info->setHorizontalAlign(NVG_ALIGN_CENTER);
        this->addView(dump_options_info);
        
        /* Overclock. */
        brls::ToggleListItem *overclock = new brls::ToggleListItem("options_tab/overclock/label"_i18n, configGetBoolean("overclock"), \
                                                                   "options_tab/overclock/description"_i18n, "options_tab/overclock/value_enabled"_i18n, \
                                                                   "options_tab/overclock/value_disabled"_i18n);
        
        overclock->getClickEvent()->subscribe([](brls::View* view) {
            brls::ToggleListItem *item = static_cast<brls::ToggleListItem*>(view);
            
            /* Get current value. */
            bool value = item->getToggleState();
            
            /* Change hardware clocks based on the current value. */
            utilsOverclockSystem(value);
            
            /* Update configuration. */
            configSetBoolean("overclock", value);
            
            brls::Logger::debug("Overclock setting changed by user.");
        });
        
        this->addView(overclock);
        
        /* Naming convention. */
        brls::SelectListItem *naming_convention = new brls::SelectListItem("options_tab/naming_convention/label"_i18n, {
                                                                               "options_tab/naming_convention/value_00"_i18n,
                                                                               "options_tab/naming_convention/value_01"_i18n
                                                                           }, static_cast<unsigned>(configGetInteger("naming_convention")),
                                                                           "options_tab/naming_convention/description"_i18n);
        
        naming_convention->getValueSelectedEvent()->subscribe([](int selected) {
            /* Make sure the current value isn't out of bounds. */
            if (selected < 0 || selected > static_cast<int>(TitleNamingConvention_Count)) return;
            
            /* Update configuration. */
            configSetInteger("naming_convention", selected);
            
            brls::Logger::debug("Naming convention setting changed by user.");
        });
        
        this->addView(naming_convention);
        
        /* Update NSWDB XML. */
        brls::ListItem *update_nswdb_xml = new brls::ListItem("options_tab/update_nswdb_xml/label"_i18n, "options_tab/update_nswdb_xml/description"_i18n);
        
        update_nswdb_xml->getClickEvent()->subscribe([this](brls::View* view) {
            if (!this->root_view->IsInternetConnectionAvailable())
            {
                /* Display a notification if no Internet connection is available. */
                this->DisplayNotification("options_tab/notifications/no_internet_connection"_i18n);
                return;
            }
            
            /* Open update dialog. */
            OptionsTabUpdateFileDialog *dialog = new OptionsTabUpdateFileDialog(NSWDB_XML_PATH, NSWDB_XML_URL, false, "options_tab/notifications/nswdb_xml_updated"_i18n);
            dialog->open(false);
        });
        
        this->addView(update_nswdb_xml);
        
        /* Update application. */
        brls::ListItem *update_app = new brls::ListItem("options_tab/update_app/label"_i18n, "options_tab/update_app/description"_i18n);
        
        update_app->getClickEvent()->subscribe([this](brls::View* view) {
            if (envIsNso())
            {
                /* Display a notification if we're running as a NSO. */
                this->DisplayNotification("options_tab/notifications/is_nso"_i18n);
                return;
            } else
            if (!this->root_view->IsInternetConnectionAvailable())
            {
                /* Display a notification if no Internet connection is available. */
                this->DisplayNotification("options_tab/notifications/no_internet_connection"_i18n);
                return;
            } else
            if (utilsGetApplicationUpdatedState())
            {
                /* Display a notification if the application has already been updated. */
                this->DisplayNotification("options_tab/notifications/already_updated"_i18n);
                return;
            }
            
            /* Display update frame. */
            brls::Application::pushView(new OptionsTabUpdateApplicationFrame(), brls::ViewAnimation::SLIDE_LEFT, false);
        });
        
        this->addView(update_app);
    }
    
    OptionsTab::~OptionsTab(void)
    {
        brls::menu_timer_kill(&(this->notification_timer));
    }
    
    void OptionsTab::DisplayNotification(std::string str)
    {
        if (str == "" || !this->display_notification) return;
        
        brls::Application::notify(str);
        this->display_notification = false;
        
        this->notification_timer_ctx.duration = brls::Application::getStyle()->AnimationDuration.notificationTimeout;
        this->notification_timer_ctx.cb = [this](void *userdata) { this->display_notification = true; };
        this->notification_timer_ctx.tick = [](void*){};
        this->notification_timer_ctx.userdata = nullptr;
        
        brls::menu_timer_start(&(this->notification_timer), &(this->notification_timer_ctx));
    }
}