Add required server option (#1948)

* Add required server option

* Use plan_resume() instead of the resume_task system

* Retry articles on required servers after connection failure

* Update comment to match new code

* Remove unnecessary try

interfaces/Config/templates/config_server.tmpl

@@ -104,6 +104,11 @@
                         <span class="desc">$T('srv-explain-send_group')</span>
                     </div>
                     <div class="field-pair advanced-settings">
+                        <label class="config" for="required">$T('srv-required')</label>
+                        <input type="checkbox" name="required" id="required" value="1" />
+                        <span class="desc">$T('explain-required')</span>
+                    </div>
+                    <div class="field-pair advanced-settings">
                         <label class="config" for="optional">$T('srv-optional')</label>
                         <input type="checkbox" name="optional" id="optional" value="1" />
                         <span class="desc">$T('explain-optional')</span>
@@ -226,6 +231,11 @@
                             <a href="${helpuri}advanced/ssl-ciphers" target="_blank">${helpuri}advanced/ssl-ciphers</a></span>
                         </div>
                         <div class="field-pair advanced-settings">
+                            <label class="config" for="required$cur">$T('srv-required')</label>
+                            <input type="checkbox" name="required" id="required$cur" value="1" <!--#if int($server['required']) != 0 then 'checked="checked"' else ""#--> />
+                            <span class="desc">$T('explain-required')</span>
+                        </div>
+                        <div class="field-pair advanced-settings">
                             <label class="config" for="optional$cur">$T('srv-optional')</label>
                             <input type="checkbox" name="optional" id="optional$cur" value="1" <!--#if int($server['optional']) != 0 then 'checked="checked"' else ""#--> />
                             <span class="desc">$T('explain-optional')</span>

sabnzbd/config.py

@@ -409,6 +409,7 @@ class ConfigServer:
         self.ssl_verify = OptionNumber(name, "ssl_verify", 2, add=False)
         self.ssl_ciphers = OptionStr(name, "ssl_ciphers", add=False)
         self.enable = OptionBool(name, "enable", True, add=False)
+        self.required = OptionBool(name, "required", False, add=False)
         self.optional = OptionBool(name, "optional", False, add=False)
         self.retention = OptionNumber(name, "retention", 0, add=False)
         self.expire_date = OptionStr(name, "expire_date", add=False)
@@ -442,6 +443,7 @@ class ConfigServer:
             "ssl_ciphers",
             "send_group",
             "enable",
+            "required",
             "optional",
             "retention",
             "expire_date",
@@ -476,6 +478,7 @@ class ConfigServer:
         output_dict["ssl_verify"] = self.ssl_verify()
         output_dict["ssl_ciphers"] = self.ssl_ciphers()
         output_dict["enable"] = self.enable()
+        output_dict["required"] = self.required()
         output_dict["optional"] = self.optional()
         output_dict["retention"] = self.retention()
         output_dict["expire_date"] = self.expire_date()

sabnzbd/downloader.py

@@ -73,6 +73,7 @@ class Server:
         "ssl",
         "ssl_verify",
         "ssl_ciphers",
+        "required",
         "optional",
         "retention",
         "send_group",
@@ -109,6 +110,7 @@ class Server:
         send_group,
         username=None,
         password=None,
+        required=False,
         optional=False,
         retention=0,
     ):
@@ -125,6 +127,7 @@ class Server:
         self.ssl: bool = ssl
         self.ssl_verify: int = ssl_verify
         self.ssl_ciphers: str = ssl_ciphers
+        self.required: bool = required
         self.optional: bool = optional
         self.retention: int = retention
         self.send_group: bool = send_group
@@ -312,6 +315,7 @@ class Downloader(Thread):
             ssl_ciphers = srv.ssl_ciphers()
             username = srv.username()
             password = srv.password()
+            required = srv.required()
             optional = srv.optional()
             retention = int(srv.retention() * 24 * 3600)  # days ==> seconds
             send_group = srv.send_group()
@@ -344,6 +348,7 @@ class Downloader(Thread):
                     send_group,
                     username,
                     password,
+                    required,
                     optional,
                     retention,
                 )
@@ -473,10 +478,14 @@ class Downloader(Thread):
             if server.errormsg != errormsg:
                 server.errormsg = errormsg
                 logging.warning(errormsg)
+                if not server.required:
                     logging.warning(T("Server %s will be ignored for %s minutes"), server.host, _PENALTY_TIMEOUT)
 
             # Not fully the same as the code below for optional servers
             server.bad_cons = 0
+            if server.required:
+                sabnzbd.Scheduler.plan_required_server_resume()
+            else:
                 server.deactivate()
                 self.plan_server(server, _PENALTY_TIMEOUT)
 
@@ -835,12 +844,17 @@ class Downloader(Thread):
                                 penalty = _PENALTY_UNKNOWN
                                 block = True
                             if block or (penalty and server.optional):
+                                retry_article = False
                                 if server.active:
+                                    if server.required:
+                                        sabnzbd.Scheduler.plan_required_server_resume()
+                                        retry_article = True
+                                    else:
                                         server.deactivate()
                                         if penalty and (block or server.optional):
                                             self.plan_server(server, penalty)
-                                # Note that the article is discard for this server
+                                # Note that the article is discard for this server if the server is not required
-                                self.__reset_nw(nw, retry_article=False, send_quit=True)
+                                self.__reset_nw(nw, retry_article=retry_article, send_quit=True)
                             continue
                         except:
                             logging.error(

sabnzbd/interface.py

@@ -1234,7 +1234,7 @@ def handle_server(kwargs, root=None, new_svr=False):
     if new_svr:
         server = unique_svr_name(server)
 
-    for kw in ("ssl", "send_group", "enable", "optional"):
+    for kw in ("ssl", "send_group", "enable", "required", "optional"):
         if kw not in kwargs.keys():
             kwargs[kw] = None
     if svr and not new_svr:

sabnzbd/scheduler.py

@@ -391,6 +391,11 @@ class Scheduler:
             self.__check_diskspace, "check_diskspace", 5 * 60, 9 * 60, "threaded", args=[full_dir, required_space]
         )
 
+    def plan_required_server_resume(self, interval: int = 5):
+        """Create task for resuming downloading"""
+        if not sabnzbd.Downloader.paused:
+            self.plan_resume(interval)
+
     def cancel_resume_task(self):
         """Cancel the current auto resume task"""
         if self.resume_task:

sabnzbd/skintext.py

@@ -644,6 +644,10 @@ SKIN_TEXT = {
     "ssl_verify-strict": TT("Strict"),
     "srv-priority": TT("Priority"),  #: Server priority
     "explain-svrprio": TT("0 is highest priority, 100 is the lowest priority"),  #: Explain server priority
+    "srv-required": TT("Required"),  #: Server required tickbox
+    "explain-required": TT(
+        "In case of connection failures, the download queue will be paused for a few minutes instead of skipping this server"
+    ),  #: Explain server required tickbox
     "srv-optional": TT("Optional"),  #: Server optional tickbox
     "explain-optional": TT(
         "For unreliable servers, will be ignored longer in case of failures"