feat(Submit): Improve and add action menu

CHANGELOG.md

@@ -1,8 +1,18 @@
 ## UNRELEASED
 
+### Added
+
+-   Now you can set shortcut for submitting solution. (#201 and #681)
+-   Added Submit option in Actions menu.(#681)
+
+### Changed
+
+-   Use of CF tool lower than 1.0 has been deprecated. We recommend you to update to 1.0 or above because in next release we will remove its support completely.
+
 ## Fixed
 
 -   Fix that the Find/Replace dialog is not floating in i3-wm. (#767)
+-   Fixed an issue where some URL was not being parsed by CF Tool. (#679 and #681) 
 
 ## v6.8
 

src/Extensions/CFTool.cpp

@@ -18,6 +18,7 @@
 #include "Extensions/CFTool.hpp"
 #include "Core/EventLogger.hpp"
 #include "Core/MessageLogger.hpp"
+#include "Util/Util.hpp"
 #include "generated/SettingsHelper.hpp"
 #include <QFileInfo>
 #include <QProcess>
@@ -27,125 +28,123 @@
 namespace Extensions
 {
 
-CFTool::CFTool(const QString &path, MessageLogger *logger) : CFToolPath(path)
+CFTool::CFTool(const QString &path, MessageLogger *logger) : path(path)
 {
     LOG_INFO(INFO_OF(path))
     log = logger;
 }
 
 CFTool::~CFTool()
 {
-    delete CFToolProcess;
+    delete process;
 }
 
 void CFTool::submit(const QString &filePath, const QString &url)
 {
-    if (CFToolProcess != nullptr)
+    if (process && process->state() == QProcess::Running)
     {
-        if (CFToolProcess->state() == QProcess::Running)
-        {
-            LOG_WARN("CF Tool was already running, forcefully killing it now");
-            CFToolProcess->kill();
-            delete CFToolProcess;
-            log->error(tr("CF Tool"), tr("CF Tool was killed"));
-        }
-        else
-            delete CFToolProcess;
-        CFToolProcess = nullptr;
+        LOG_WARN("CF Tool was already running, forcefully killing it now");
+        process->kill();
+        log->warn(tr("CF Tool"), tr("A CF Tool Instance was running. It has been killed"));
     }
 
+    delete process;
+    process = nullptr;
+
     LOG_INFO(INFO_OF(filePath) << INFO_OF(url));
 
-    if (parseCfUrl(url, problemContestId, problemCode))
+    auto version = getCFToolVersion();
+
+    if (version.isEmpty())
     {
-        if (problemCode == "0")
-        {
-            problemCode = "A";
-            log->warn(tr("CF Tool"),
-                      tr("The problem code is 0, now use A automatically. If the actual problem code is not A, "
-                         "please set the problem code manually in the right-click menu of the current tab."));
-        }
-        lastStatus = "Unknown"; // No tr here. We don't know what we'll get from network. Maybe a array for mapping.
-        CFToolProcess = new QProcess();
-        CFToolProcess->setProgram(CFToolPath);
-        auto version = getCFToolVersion();
-        if (version.isEmpty())
-        {
-            log->error(
-                tr("CF Tool"),
-                tr("Failed to get the version of CF Tool. Have you set the correct path to CF Tool in Preferences?"));
-            return;
-        }
-        if (version.split('.')[0] == "0")
-            CFToolProcess->setArguments({"submit", problemContestId, problemCode, filePath});
-        else
-            CFToolProcess->setArguments({"submit", "-f", filePath, url});
+        log->error(tr("CF Tool"),
+                   tr("You need to install CF Tool to submit your code to Codeforces. If already installed, you can "
+                      "add it in the PATH environment variable or check your settings at %1.")
+                       .arg(SettingsHelper::pathOfCFPath()),
+                   false);
+        return;
+    }
+
+    lastStatus = "Unknown"; // No tr here. We don't know what we'll get from network. Maybe a array for mapping.
+    lastUrl = url;
+    process = new QProcess();
+    process->setProgram(path);
 
-        LOG_INFO(INFO_OF(CFToolProcess->arguments().join(' ')));
+    bool wasProblemCodeChanged = false;
 
-        connect(CFToolProcess, &QProcess::readyReadStandardOutput, this, &CFTool::onReadReady);
-        connect(CFToolProcess, qOverload<int, QProcess::ExitStatus>(&QProcess::finished), this, &CFTool::onFinished);
-        CFToolProcess->start();
-        bool started = CFToolProcess->waitForStarted(2000);
-        if (started)
+    // @coder3101: Please delete this branch and wasProblemCodeChanged, when CFTool < 1.0 is unsupported.
+    // BRANCH Begin
+    QString problemContestId;
+    QString problemCode;
+    if (version.split('.')[0] == "0")
+    {
+        log->warn(tr("CF Tool"), tr("You are using CF Tool %1. It is recommened to update to CF Tool 1.0 or above as "
+                                    "next cpeditor will not support this version.")
+                                     .arg(version));
+
+        if (Util::parseCfUrl(url, problemContestId, problemCode))
         {
-            log->info(tr("CF Tool"), tr("CF Tool has started"));
+
+            if (problemCode == "0")
+            {
+                problemCode = "A";
+                wasProblemCodeChanged = true;
+            }
+
+            process->setArguments({"submit", problemContestId, problemCode, filePath});
         }
         else
         {
-            CFToolProcess->kill();
-            log->error(
-                tr("CF Tool"),
-                tr("Failed to start CF Tool in 2 seconds. Have you set the correct path to CF Tool in Preferences?"));
+            log->error(tr("CF Tool"), tr("Failed to parse URL [%1]. Please use CF tool 1.0 or higher.").arg(url));
+            return;
         }
     }
     else
+    // BRANCH end
     {
-        log->error(tr("CF Tool"), tr("Failed to parse the URL [%1]").arg(url));
+        QString convertedUrl = url;
+        if (url.endsWith("0"))
+        {
+            wasProblemCodeChanged = true;
+            lastUrl = convertedUrl = url.mid(0, url.size() - 1) + "A";
+        }
+        process->setArguments({"submit", "-f", filePath, convertedUrl});
     }
-}
 
-bool CFTool::check(const QString &path)
-{
-    LOG_INFO(INFO_OF(path));
-    QProcess checkProcess;
-    checkProcess.start(path, {"--version"});
-    bool finished = checkProcess.waitForFinished(2000);
-    LOG_INFO(BOOL_INFO_OF(finished) << INFO_OF(checkProcess.exitCode()) << INFO_OF(checkProcess.exitStatus()));
-    return finished && checkProcess.exitCode() == 0;
-}
+    if (wasProblemCodeChanged)
+    {
+        log->warn(tr("CF Tool"),
+                  tr("The problem code was 0. It has been changed to A. If the actual problem code is not this, "
+                     "please set the problem code manually in the right-click menu of the current tab."));
+    }
 
-void CFTool::updatePath(const QString &p)
-{
-    LOG_INFO(INFO_OF(p));
-    CFToolPath = p;
-}
+    LOG_INFO(INFO_OF(process->arguments().join(' ')));
 
-bool CFTool::parseCfUrl(const QString &url, QString &contestId, QString &problemCode)
-{
-    LOG_INFO(INFO_OF(url));
-    auto match =
-        QRegularExpression(".*://codeforces.com/(?:gym|contest)/([1-9][0-9]*)/problem/(0|[A-Z][1-9]?)").match(url);
-    if (match.hasMatch())
+    connect(process, &QProcess::readyReadStandardOutput, this, &CFTool::onReadReady);
+    connect(process, qOverload<int, QProcess::ExitStatus>(&QProcess::finished), this, &CFTool::onFinished);
+    process->start();
+    bool started = process->waitForStarted(2000);
+
+    if (started)
     {
-        contestId = match.captured(1);
-        problemCode = match.captured(2);
-        return true;
+        log->info(tr("CF Tool"), tr("CF Tool has started"));
     }
-    match = QRegularExpression(".*://codeforces.com/problemset/problem/([1-9][0-9]*)/([A-Z][1-9]?)").match(url);
-    if (match.hasMatch())
+    else
     {
-        contestId = match.captured(1);
-        problemCode = match.captured(2);
-        return true;
+        process->kill();
+        log->error(tr("CF Tool"), tr("Failed to start CF Tool in 2 seconds."));
     }
+}
 
-    return false;
+void CFTool::updatePath(const QString &p)
+{
+    LOG_INFO(INFO_OF(p));
+    path = p;
 }
 
 void CFTool::onReadReady()
 {
-    QString response = CFToolProcess->readAll();
+    QString response = process->readAll();
     response.remove(QRegularExpression("\x1b\\[.. "));
     if (response.contains("status: "))
     {
@@ -177,21 +176,31 @@ void CFTool::onFinished(int exitCode, QProcess::ExitStatus e)
         showToastMessage(tr("CF Tool failed"));
         log->error(tr("CF Tool"), tr("CF Tool finished with non-zero exit code %1").arg(exitCode));
     }
-    QString err = CFToolProcess->readAllStandardError();
+    QString err = process->readAllStandardError();
     if (!err.trimmed().isEmpty())
         log->error(tr("CF Tool"), err);
 }
 
 void CFTool::showToastMessage(const QString &message)
 {
     if (SettingsHelper::isCFShowToastMessages())
-        emit requestToastMessage(tr("Contest %1 Problem %2").arg(problemContestId).arg(problemCode), message);
+    {
+        QString problemContestId;
+        QString problemCode;
+        if (Util::parseCfUrl(lastUrl, problemContestId, problemCode))
+            emit requestToastMessage(tr("Contest %1 Problem %2").arg(problemContestId).arg(problemCode), message);
+        else
+        {
+            emit requestToastMessage(tr("Contest URL %1").arg(lastUrl), message);
+            LOG_WARN("Failed to parse CF URL " << lastUrl);
+        }
+    }
 }
 
 QString CFTool::getCFToolVersion() const
 {
     QProcess process;
-    process.start(CFToolPath, {"--version"});
+    process.start(path, {"--version"});
     if (!process.waitForFinished(2000))
     {
         LOG_WARN("CF Tool didn't finish after 2 second");

src/Extensions/CFTool.hpp

@@ -33,9 +33,7 @@ class CFTool : public QObject
     CFTool(const QString &path, MessageLogger *logger);
     ~CFTool() override;
     void submit(const QString &filePath, const QString &url);
-    static bool check(const QString &path);
     void updatePath(const QString &p);
-    static bool parseCfUrl(const QString &url, QString &contestId, QString &problemCode);
 
   signals:
     void requestToastMessage(const QString &head, const QString &body);
@@ -45,10 +43,10 @@ class CFTool : public QObject
     void onFinished(int exitCode, QProcess::ExitStatus);
 
   private:
-    QString problemContestId, problemCode, lastStatus;
-    QProcess *CFToolProcess = nullptr;
+    QString lastStatus, lastUrl;
+    QProcess *process = nullptr;
     MessageLogger *log;
-    QString CFToolPath;
+    QString path;
 
     void showToastMessage(const QString &message);
     QString getCFToolVersion() const;

src/Settings/PreferencesWindow.cpp

@@ -270,7 +270,7 @@ PreferencesWindow::PreferencesWindow(QWidget *parent) : QMainWindow(parent)
             .page(TRKEY("Default Paths"), DefaultPathManager::actionSettingsList() << "Default Path/Names And Paths")
         .end()
         .page(TRKEY("Key Bindings"), {"Hotkey/Compile", "Hotkey/Run", "Hotkey/Compile Run", "Hotkey/Format", "Hotkey/Kill",
-                                   "Hotkey/Change View Mode", "Hotkey/Snippets"})
+                                   "Hotkey/Change View Mode", "Hotkey/Snippets", "Hotkey/Submit"})
         .dir(TRKEY("Advanced"))
             .page(TRKEY("Update"), {"Check Update", "Beta"})
             .page(TRKEY("Limits"), {"Default Time Limit", "Output Length Limit", "Output Display Length Limit", "Message Length Limit",

src/Settings/settings.json

@@ -669,6 +669,12 @@
             "hotkey_snippets"
         ]
     },
+    {
+        "name": "Hotkey/Submit",
+        "desc": "Submit Solution",
+        "type": "QString",
+        "ui": "ShortcutItem"
+    },
     {
         "name": "Hot Exit/Enable",
         "desc": "Restore last session at startup",
@@ -1240,4 +1246,4 @@
         "type": "bool",
         "notr": true
     }
-]
+]

src/Util/Util.cpp

@@ -48,4 +48,25 @@ QString websiteLink(const QString &path)
         .url(QUrl::NormalizePathSegments);
 }
 
+bool parseCfUrl(const QString &url, QString &contestId, QString &problemCode)
+{
+    LOG_INFO(INFO_OF(url));
+    auto match =
+        QRegularExpression(".*://codeforces.com/(?:gym|contest)/([1-9][0-9]*)/problem/(0|[A-Z][1-9]?)").match(url);
+    if (match.hasMatch())
+    {
+        contestId = match.captured(1);
+        problemCode = match.captured(2);
+        return true;
+    }
+    match = QRegularExpression(".*://codeforces.com/problemset/problem/([1-9][0-9]*)/([A-Z][1-9]?)").match(url);
+    if (match.hasMatch())
+    {
+        contestId = match.captured(1);
+        problemCode = match.captured(2);
+        return true;
+    }
+    return false;
+}
+
 } // namespace Util

src/Util/Util.hpp

@@ -29,6 +29,8 @@ QString sanitizeAnchorName(const QString &str);
 
 QString websiteLink(const QString &path = QString());
 
+bool parseCfUrl(const QString &url, QString &contestId, QString &problemCode);
+
 } // namespace Util
 
 #endif // UTIL_HPP

src/appwindow.cpp

@@ -366,6 +366,11 @@ void AppWindow::maybeSetHotkeys()
         hotkeyObjects.push_back(
             new QShortcut(SettingsHelper::getHotkeySnippets(), this, [this] { on_actionUseSnippets_triggered(); }));
     }
+    if (!SettingsHelper::getHotkeySubmit().isEmpty())
+    {
+        hotkeyObjects.push_back(
+            new QShortcut(SettingsHelper::getHotkeySubmit(), this, [this] { on_actionSubmit_triggered(); }));
+    }
 
     hotkeyObjects.push_back(new QShortcut(Qt::Key_Escape, this, [this] { ui->actionFullScreen->setChecked(false); }));
 }
@@ -886,6 +891,8 @@ void AppWindow::onTabChanged(int index)
 
     reAttachLanguageServer(tmp);
 
+    ui->actionSubmit->setVisible(tmp->canSubmitSolution());
+
     findReplaceDialog->setTextEdit(tmp->getEditor());
 
     setWindowTitle(tmp->getCompleteTitle() + " - CP Editor");
@@ -1447,7 +1454,7 @@ void AppWindow::onTabContextMenuRequested(const QPoint &pos)
         tabMenu->addAction(tr("Set Codeforces URL"), [window, this] {
             QString contestId;
             QString problemCode;
-            Extensions::CFTool::parseCfUrl(window->getProblemURL(), contestId, problemCode);
+            Util::parseCfUrl(window->getProblemURL(), contestId, problemCode);
             bool ok = false;
             contestId = QInputDialog::getText(this, tr("Set CF URL"), tr("Enter the contest ID:"), QLineEdit::Normal,
                                               contestId, &ok);
@@ -1564,3 +1571,9 @@ void AppWindow::onCompileOrRunTriggered()
     if (ui->actionEditorMode->isChecked())
         on_actionSplitMode_triggered();
 }
+
+void AppWindow::on_actionSubmit_triggered()
+{
+    if (currentWindow() && currentWindow()->canSubmitSolution())
+        currentWindow()->submitSolution();
+}