Schedule Pause bittorrent session with scheduler

Author: piopodg

.gitignore

@@ -1,4 +1,6 @@
 .vscode/
+.zed/
+.idea/
 
 src/gui/geoip/GeoIP.dat
 src/gui/geoip/GeoIP.dat.gz
@@ -41,3 +43,10 @@ src/icons/skin/build-icons/icons/*.png
 
 # CMake build directory
 build/
+
+
+# clang cache
+.cache/
+
+# Node.js dependencies
+node_modules/

src/app/application.cpp

@@ -1043,6 +1043,15 @@ int Application::exec()
         for (const QBtCommandLineParameters &params : asConst(m_paramsQueue))
             processParams(params);
         m_paramsQueue.clear();
+
+        //FIXME this is a workaround to apply session state immediately after startup.
+        // Otherwise, session will start unpaused regardless of the Schedule Pause Session setting being enabled,
+        // and Alternative Speed Limits active
+        // Should find a better way to handle this
+        BitTorrent::Session::instance()->applySessionState(BitTorrent::Session::instance()->isAltGlobalSpeedLimitEnabled() &&
+                                                            BitTorrent::Session::instance()->isSchedulePauseSessionEnabled());
+
+
     });
 
     const QBtCommandLineParameters params = commandLineArgs();

src/base/bittorrent/session.h

@@ -256,8 +256,11 @@ namespace BitTorrent
         virtual void setUploadSpeedLimit(int limit) = 0;
         virtual bool isAltGlobalSpeedLimitEnabled() const = 0;
         virtual void setAltGlobalSpeedLimitEnabled(bool enabled) = 0;
+        virtual bool isSchedulePauseSessionEnabled() const = 0;
+        virtual void setSchedulePauseSessionEnabled(bool enabled) = 0;
         virtual bool isBandwidthSchedulerEnabled() const = 0;
         virtual void setBandwidthSchedulerEnabled(bool enabled) = 0;
+        virtual void applySessionState(bool schedule_paused) = 0;
 
         virtual bool isPerformanceWarningEnabled() const = 0;
         virtual void setPerformanceWarningEnabled(bool enable) = 0;

src/base/bittorrent/sessionimpl.cpp

@@ -538,6 +538,7 @@ SessionImpl::SessionImpl(QObject *parent)
     , m_altGlobalDownloadSpeedLimit(BITTORRENT_SESSION_KEY(u"AlternativeGlobalDLSpeedLimit"_s), 10, lowerLimited(0))
     , m_altGlobalUploadSpeedLimit(BITTORRENT_SESSION_KEY(u"AlternativeGlobalUPSpeedLimit"_s), 10, lowerLimited(0))
     , m_isAltGlobalSpeedLimitEnabled(BITTORRENT_SESSION_KEY(u"UseAlternativeGlobalSpeedLimit"_s), false)
+    , m_isSchedulePauseSessionEnabled(BITTORRENT_SESSION_KEY(u"SchedulePauseSession"_s), false)
     , m_isBandwidthSchedulerEnabled(BITTORRENT_SESSION_KEY(u"BandwidthSchedulerEnabled"_s), false)
     , m_isPerformanceWarningEnabled(BITTORRENT_SESSION_KEY(u"PerformanceWarning"_s), false)
     , m_saveResumeDataInterval(BITTORRENT_SESSION_KEY(u"SaveResumeDataInterval"_s), 60)
@@ -1321,6 +1322,20 @@ void SessionImpl::applyBandwidthLimits()
     m_nativeSession->apply_settings(std::move(settingsPack));
 }
 
+void SessionImpl::applySessionState(bool scheduled_pause)
+{
+    BitTorrent::Session *const session = BitTorrent::Session::instance();
+
+    // if session is not ready during startup, just return
+    if(nullptr == session)
+        return;
+
+    if (true == scheduled_pause)
+        session->pause();
+    else
+        session->resume();
+}
+
 void SessionImpl::configure()
 {
     m_nativeSession->apply_settings(loadLTSettings());
@@ -3632,10 +3647,28 @@ void SessionImpl::setAltGlobalSpeedLimitEnabled(const bool enabled)
     // Save new state to remember it on startup
     m_isAltGlobalSpeedLimitEnabled = enabled;
     applyBandwidthLimits();
+    applySessionState(isAltGlobalSpeedLimitEnabled() && isSchedulePauseSessionEnabled());
     // Notify
     emit speedLimitModeChanged(m_isAltGlobalSpeedLimitEnabled);
 }
 
+bool SessionImpl::isSchedulePauseSessionEnabled() const
+{
+    return m_isSchedulePauseSessionEnabled;
+}
+
+
+void SessionImpl::setSchedulePauseSessionEnabled(const bool enabled)
+{
+    if (enabled == isSchedulePauseSessionEnabled()) return;
+
+    // Save new state to remember it on startup
+    m_isSchedulePauseSessionEnabled = enabled;
+
+    // Notify
+    //emit speedLimitModeChanged(m_isAltGlobalSpeedLimitEnabled);
+}
+
 bool SessionImpl::isBandwidthSchedulerEnabled() const
 {
     return m_isBandwidthSchedulerEnabled;

src/base/bittorrent/sessionimpl.h

@@ -231,15 +231,18 @@ namespace BitTorrent
         void setUploadSpeedLimit(int limit) override;
         bool isAltGlobalSpeedLimitEnabled() const override;
         void setAltGlobalSpeedLimitEnabled(bool enabled) override;
+        bool isSchedulePauseSessionEnabled() const override;
+        void setSchedulePauseSessionEnabled(bool enabled) override;
         bool isBandwidthSchedulerEnabled() const override;
         void setBandwidthSchedulerEnabled(bool enabled) override;
+        void applySessionState(bool schedule_paused) override;
 
         bool isPerformanceWarningEnabled() const override;
         void setPerformanceWarningEnabled(bool enable) override;
         int saveResumeDataInterval() const override;
         void setSaveResumeDataInterval(int value) override;
         std::chrono::minutes saveStatisticsInterval() const override;
-        void setSaveStatisticsInterval(std::chrono::minutes value) override;
+        void setSaveStatisticsInterval(std::chrono::minutes timeInMinutes) override;
         int shutdownTimeout() const override;
         void setShutdownTimeout(int value) override;
         int port() const override;
@@ -736,6 +739,7 @@ namespace BitTorrent
         CachedSettingValue<int> m_altGlobalDownloadSpeedLimit;
         CachedSettingValue<int> m_altGlobalUploadSpeedLimit;
         CachedSettingValue<bool> m_isAltGlobalSpeedLimitEnabled;
+        CachedSettingValue<bool> m_isSchedulePauseSessionEnabled;
         CachedSettingValue<bool> m_isBandwidthSchedulerEnabled;
         CachedSettingValue<bool> m_isPerformanceWarningEnabled;
         CachedSettingValue<int> m_saveResumeDataInterval;

src/gui/optionsdialog.cpp

@@ -1082,6 +1082,7 @@ void OptionsDialog::loadSpeedTabOptions()
     m_ui->timeEditScheduleFrom->setTime(pref->getSchedulerStartTime());
     m_ui->timeEditScheduleTo->setTime(pref->getSchedulerEndTime());
     m_ui->comboBoxScheduleDays->setCurrentIndex(static_cast<int>(pref->getSchedulerDays()));
+    m_ui->checkBoxSchedulePauseSession->setChecked(session->isSchedulePauseSessionEnabled());
 
     m_ui->checkLimituTPConnections->setChecked(session->isUTPRateLimited());
     m_ui->checkLimitTransportOverhead->setChecked(session->includeOverheadInLimits());
@@ -1105,6 +1106,7 @@ void OptionsDialog::loadSpeedTabOptions()
     connect(m_ui->timeEditScheduleFrom, &QDateTimeEdit::timeChanged, this, &ThisType::enableApplyButton);
     connect(m_ui->timeEditScheduleTo, &QDateTimeEdit::timeChanged, this, &ThisType::enableApplyButton);
     connect(m_ui->comboBoxScheduleDays, qComboBoxCurrentIndexChanged, this, &ThisType::enableApplyButton);
+    connect(m_ui->checkBoxSchedulePauseSession, &QAbstractButton::toggled, this, &ThisType::enableApplyButton);
 
     connect(m_ui->checkLimituTPConnections, &QAbstractButton::toggled, this, &ThisType::enableApplyButton);
     connect(m_ui->checkLimitTransportOverhead, &QAbstractButton::toggled, this, &ThisType::enableApplyButton);
@@ -1131,6 +1133,7 @@ void OptionsDialog::saveSpeedTabOptions() const
     pref->setSchedulerStartTime(m_ui->timeEditScheduleFrom->time());
     pref->setSchedulerEndTime(m_ui->timeEditScheduleTo->time());
     pref->setSchedulerDays(static_cast<Scheduler::Days>(m_ui->comboBoxScheduleDays->currentIndex()));
+    session->setSchedulePauseSessionEnabled(m_ui->checkBoxSchedulePauseSession->isChecked());
 
     session->setUTPRateLimited(m_ui->checkLimituTPConnections->isChecked());
     session->setIncludeOverheadInLimits(m_ui->checkLimitTransportOverhead->isChecked());
@@ -2283,3 +2286,11 @@ void OptionsDialog::on_IPSubnetWhitelistButton_clicked()
     connect(dialog, &QDialog::accepted, this, &OptionsDialog::enableApplyButton);
     dialog->open();
 }
+
+void OptionsDialog::on_groupBoxSchedule_clicked(bool checked)
+{
+    if(!checked)
+    {
+        m_ui->checkBoxSchedulePauseSession->setChecked(checked);
+    }
+}

src/gui/optionsdialog.h

@@ -113,6 +113,8 @@ private slots:
     void setupWebUIAPIKey();
 #endif
 
+    void on_groupBoxSchedule_clicked(bool checked);
+
 private:
     void showEvent(QShowEvent *e) override;
 

src/gui/optionsdialog.ui

@@ -2674,6 +2674,13 @@ readme[0-9].txt: filter 'readme1.txt', 'readme2.txt' but not 'readme10.txt'.</st
                     </item>
                    </widget>
                   </item>
+                  <item row="1" column="4">
+                   <widget class="QCheckBox" name="checkBoxSchedulePauseSession">
+                    <property name="text">
+                     <string>Schedule Pause session</string>
+                    </property>
+                   </widget>
+                  </item>
                  </layout>
                 </widget>
                </item>

src/webui/api/appcontroller.cpp

@@ -294,6 +294,8 @@ void AppController::preferencesAction()
     data[u"schedule_to_hour"_s] = end_time.hour();
     data[u"schedule_to_min"_s] = end_time.minute();
     data[u"scheduler_days"_s] = static_cast<int>(pref->getSchedulerDays());
+    data[u"schedule_pause_session"_s] = session->isSchedulePauseSessionEnabled();
+
 
     // Bittorrent
     // Privacy
@@ -817,6 +819,8 @@ void AppController::setPreferencesAction()
         pref->setSchedulerEndTime({hourIter.value().toInt(), minIter.value().toInt()});
     if (hasKey(u"scheduler_days"_s))
         pref->setSchedulerDays(static_cast<Scheduler::Days>(it.value().toInt()));
+    if (hasKey(u"schedule_pause_session"_s))
+        session->setSchedulePauseSessionEnabled(it.value().toBool());
 
     // Bittorrent
     // Privacy

src/webui/www/private/views/preferences.html

@@ -698,6 +698,10 @@
                 <label id="scheduleToHourLabel">QBT_TR(To:)QBT_TR[CONTEXT=OptionsDialog]</label>
                 <input type="text" id="schedule_to_hour" aria-labelledby="scheduleToHourLabel" style="width: 3.6em;">:<input type="text" id="schedule_to_min" aria-labelledby="scheduleToHourLabel" style="width: 3.6em;">
             </div>
+            <div>
+                <input type="checkbox" id="schedule_pause_session_checkbox">
+                <label for="schedule_pause_session_checkbox">QBT_TR(Schedule Pause session)QBT_TR[CONTEXT=OptionsDialog]</label>
+            </div>
             <div class="formRow">
                 <label for="schedule_freq_select">QBT_TR(When:)QBT_TR[CONTEXT=OptionsDialog]</label>
                 <select id="schedule_freq_select">
@@ -2133,13 +2137,23 @@
         };
 
         // Speed tab
+        const updateSchedulePauseSessionCheckbox = () => {
+            const isLimitSchedulingEnabled = document.getElementById("limitSchedulingCheckbox").checked;
+
+            // disable and uncheck when scheduling disabled
+            document.getElementById("schedule_pause_session_checkbox").disabled = !isLimitSchedulingEnabled;
+            if (!isLimitSchedulingEnabled)
+                document.getElementById("schedule_pause_session_checkbox").checked = false;
+        };
+
         const updateSchedulingEnabled = () => {
             const isLimitSchedulingEnabled = document.getElementById("limitSchedulingCheckbox").checked;
             document.getElementById("schedule_from_hour").disabled = !isLimitSchedulingEnabled;
             document.getElementById("schedule_from_min").disabled = !isLimitSchedulingEnabled;
             document.getElementById("schedule_to_hour").disabled = !isLimitSchedulingEnabled;
             document.getElementById("schedule_to_min").disabled = !isLimitSchedulingEnabled;
             document.getElementById("schedule_freq_select").disabled = !isLimitSchedulingEnabled;
+            updateSchedulePauseSessionCheckbox();
         };
 
         // Bittorrent tab
@@ -2583,6 +2597,7 @@
                     document.getElementById("schedule_to_hour").value = time_padding(pref.schedule_to_hour);
                     document.getElementById("schedule_to_min").value = time_padding(pref.schedule_to_min);
                     document.getElementById("schedule_freq_select").value = pref.scheduler_days;
+                    document.getElementById("schedule_pause_session_checkbox").checked = pref.schedule_pause_session;
                     updateSchedulingEnabled();
 
                     // Bittorrent tab
@@ -3004,6 +3019,7 @@
                 settings["schedule_to_hour"] = Number(document.getElementById("schedule_to_hour").value);
                 settings["schedule_to_min"] = Number(document.getElementById("schedule_to_min").value);
                 settings["scheduler_days"] = Number(document.getElementById("schedule_freq_select").value);
+                settings["schedule_pause_session"] = document.getElementById("schedule_pause_session_checkbox").checked;
             }
 
             // Bittorrent tab