WIP: rework of code

- use combo box, update gui
- add session state to Preferences
- add new signal to Bandwidth Scheduler
- no WebGUI yet

Author: piopodg

src/app/application.cpp

@@ -1048,8 +1048,8 @@ int Application::exec()
         // 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());
+        //BitTorrent::Session::instance()->applySessionState(BitTorrent::Session::instance()->isAltGlobalSpeedLimitEnabled() &&
+        //                                                    BitTorrent::Session::instance()->isSchedulePauseSessionEnabled());
 
 
     });

src/base/bittorrent/bandwidthscheduler.cpp

@@ -36,6 +36,7 @@
 #include <QTime>
 
 #include "base/preferences.h"
+#include "base/bittorrent/session.h"
 
 using namespace std::chrono_literals;
 
@@ -49,12 +50,31 @@ void BandwidthScheduler::start()
 {
     m_lastAlternative = isTimeForAlternative();
     emit bandwidthLimitRequested(m_lastAlternative);
+    emit sessionPauseRequested(m_lastAlternative && getScheduleSessionPauseState());
 
     // Timeout regularly to accommodate for external system clock changes
     // eg from the user or from a timesync utility
     m_timer.start(30s);
 }
 
+bool BandwidthScheduler::getScheduleSessionPauseState()
+{
+    const auto * const pref = Preferences::instance();
+
+    switch (pref->getSchedulerSessionState())
+    {
+        case Scheduler::AlternativeSessionState::Paused:
+        return true;
+        break;
+
+        //when not pausing, do nothing, fallback to default and return false
+        case Scheduler::AlternativeSessionState::Limited:
+        default:
+        return false;
+        break;
+    }
+}
+
 bool BandwidthScheduler::isTimeForAlternative() const
 {
     const Preferences *const pref = Preferences::instance();
@@ -113,10 +133,12 @@ bool BandwidthScheduler::isTimeForAlternative() const
 void BandwidthScheduler::onTimeout()
 {
     const bool alternative = isTimeForAlternative();
+    const bool state = getScheduleSessionPauseState();
 
     if (alternative != m_lastAlternative)
     {
         m_lastAlternative = alternative;
         emit bandwidthLimitRequested(alternative);
+        emit sessionPauseRequested(alternative && state);
     }
 }

src/base/bittorrent/bandwidthscheduler.h

@@ -43,9 +43,11 @@ class BandwidthScheduler : public QObject
 
 signals:
     void bandwidthLimitRequested(bool alternative);
+    void sessionPauseRequested(bool pause_requested);
 
 private:
     bool isTimeForAlternative() const;
+    bool getScheduleSessionPauseState();
     void onTimeout();
 
     QTimer m_timer;

src/base/bittorrent/session.h

@@ -501,6 +501,7 @@ namespace BitTorrent
         void paused();
         void resumed();
         void speedLimitModeChanged(bool alternative);
+        void sessionStateChanged(bool state);
         void statsUpdated();
         void subcategoriesSupportChanged();
         void tagAdded(const Tag &tag);

src/base/bittorrent/sessionimpl.cpp

@@ -2365,6 +2365,8 @@ void SessionImpl::enableBandwidthScheduler()
         m_bwScheduler = new BandwidthScheduler(this);
         connect(m_bwScheduler.data(), &BandwidthScheduler::bandwidthLimitRequested
                 , this, &SessionImpl::setAltGlobalSpeedLimitEnabled);
+        connect(m_bwScheduler.data(), &BandwidthScheduler::sessionPauseRequested
+                , this, &SessionImpl::setSchedulePauseSessionEnabled);
     }
     m_bwScheduler->start();
 }
@@ -3647,7 +3649,7 @@ 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);
 }
@@ -3660,13 +3662,13 @@ bool SessionImpl::isSchedulePauseSessionEnabled() const
 
 void SessionImpl::setSchedulePauseSessionEnabled(const bool enabled)
 {
-    if (enabled == isSchedulePauseSessionEnabled()) return;
+    //if (enabled == isSchedulePauseSessionEnabled()) return;
 
     // Save new state to remember it on startup
     m_isSchedulePauseSessionEnabled = enabled;
-
+    applySessionState(isAltGlobalSpeedLimitEnabled() && isSchedulePauseSessionEnabled());
     // Notify
-    //emit speedLimitModeChanged(m_isAltGlobalSpeedLimitEnabled);
+    emit sessionStateChanged(m_isSchedulePauseSessionEnabled);
 }
 
 bool SessionImpl::isBandwidthSchedulerEnabled() const

src/base/preferences.cpp

@@ -698,6 +698,20 @@ void Preferences::setSchedulerDays(const Scheduler::Days days)
     setValue(u"Preferences/Scheduler/days"_s, days);
 }
 
+Scheduler::AlternativeSessionState Preferences::getSchedulerSessionState() const
+{
+    return value(u"Preferences/Scheduler/alt_session_state"_s, Scheduler::AlternativeSessionState::Limited);
+}
+
+void Preferences::setSchedulerSessionState(const Scheduler::AlternativeSessionState state)
+{
+    if (state == getSchedulerSessionState())
+        return;
+
+    setValue(u"Preferences/Scheduler/alt_session_state"_s, state);
+}
+
+
 // Search
 bool Preferences::isSearchEnabled() const
 {

src/base/preferences.h

@@ -59,6 +59,15 @@ namespace Scheduler
         Sunday = 9
     };
     Q_ENUM_NS(Days)
+
+    enum class AlternativeSessionState : int
+    {
+        Limited = 0,
+        Paused = 1
+    };
+    Q_ENUM_NS(AlternativeSessionState)
+
+
 }
 
 namespace DNS
@@ -163,6 +172,8 @@ class Preferences final : public QObject
     void setSchedulerEndTime(const QTime &time);
     Scheduler::Days getSchedulerDays() const;
     void setSchedulerDays(Scheduler::Days days);
+    void setSchedulerSessionState(Scheduler::AlternativeSessionState state);
+    Scheduler::AlternativeSessionState getSchedulerSessionState() const;
 
     // Search
     bool isSearchEnabled() const;

src/gui/optionsdialog.cpp

@@ -1082,7 +1082,8 @@ 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->comboBoxScheduleActions->setCurrentIndex(static_cast<int>(session->isSchedulePauseSessionEnabled()));
+    m_ui->comboBoxScheduleActions->setCurrentIndex(static_cast<int>(pref->getSchedulerSessionState()));
 
     m_ui->checkLimituTPConnections->setChecked(session->isUTPRateLimited());
     m_ui->checkLimitTransportOverhead->setChecked(session->includeOverheadInLimits());
@@ -1106,7 +1107,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->comboBoxScheduleActions, qComboBoxCurrentIndexChanged, this, &ThisType::enableApplyButton);
 
     connect(m_ui->checkLimituTPConnections, &QAbstractButton::toggled, this, &ThisType::enableApplyButton);
     connect(m_ui->checkLimitTransportOverhead, &QAbstractButton::toggled, this, &ThisType::enableApplyButton);
@@ -1133,7 +1134,8 @@ 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());
+    pref->setSchedulerSessionState(static_cast<Scheduler::AlternativeSessionState>(m_ui->comboBoxScheduleActions->currentIndex()));
+    session->setSchedulePauseSessionEnabled(m_ui->comboBoxScheduleActions->currentIndex());
 
     session->setUTPRateLimited(m_ui->checkLimituTPConnections->isChecked());
     session->setIncludeOverheadInLimits(m_ui->checkLimitTransportOverhead->isChecked());
@@ -2287,10 +2289,20 @@ void OptionsDialog::on_IPSubnetWhitelistButton_clicked()
     dialog->open();
 }
 
-void OptionsDialog::on_groupBoxSchedule_clicked(bool checked)
+void OptionsDialog::on_comboBoxScheduleActions_currentIndexChanged(int index)
 {
-    if(!checked)
-    {
-        m_ui->checkBoxSchedulePauseSession->setChecked(checked);
+    Scheduler::AlternativeSessionState state;
+    bool isPaused = false;
+    switch (index) {
+    case 1:
+        state = Scheduler::AlternativeSessionState::Paused;
+        isPaused = true;
+        break;
+    case 0:
+    default:
+        state = Scheduler::AlternativeSessionState::Limited;
+        break;
     }
+    Preferences::instance()->setSchedulerSessionState(state);
+    BitTorrent::Session::instance()->setSchedulePauseSessionEnabled(isPaused);
 }

src/gui/optionsdialog.h

@@ -113,7 +113,7 @@ private slots:
     void setupWebUIAPIKey();
 #endif
 
-    void on_groupBoxSchedule_clicked(bool checked);
+    void on_comboBoxScheduleActions_currentIndexChanged(int index);
 
 private:
     void showEvent(QShowEvent *e) override;

src/gui/optionsdialog.ui

@@ -2563,7 +2563,7 @@ readme[0-9].txt: filter 'readme1.txt', 'readme2.txt' but not 'readme10.txt'.</st
                <item row="2" column="0" colspan="4">
                 <widget class="QGroupBox" name="groupBoxSchedule">
                  <property name="title">
-                  <string>Schedule &amp;the use of alternative rate limits</string>
+                  <string>Scheduler</string>
                  </property>
                  <property name="checkable">
                   <bool>true</bool>
@@ -2674,13 +2674,27 @@ 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">
+                  <item row="2" column="0">
+                   <widget class="QLabel" name="label_9">
                     <property name="text">
-                     <string>Schedule Pause session</string>
+                     <string>Do:</string>
                     </property>
                    </widget>
                   </item>
+                  <item row="2" column="1">
+                   <widget class="QComboBox" name="comboBoxScheduleActions">
+                    <item>
+                     <property name="text">
+                      <string>Use alternative limits</string>
+                     </property>
+                    </item>
+                    <item>
+                     <property name="text">
+                      <string>Pause bittorrent session</string>
+                     </property>
+                    </item>
+                   </widget>
+                  </item>
                  </layout>
                 </widget>
                </item>