From 5942c754a38ecafa392f976f82a4df267711870e Mon Sep 17 00:00:00 2001
From: Chris BeHanna <chris@behanna.org>
Date: Thu, 29 Jul 2021 11:19:12 -0600
Subject: [PATCH] Add --limit-rate option for slow links

Rural areas still lack real broadband, so provide for limiting
the bandwidth consumed by downloading installers.  The syntax
is exactly the same as for curl's --limit-rate option.
---
 installinstallmacos.py | 28 +++++++++++++++++++++++-----
 1 file changed, 23 insertions(+), 5 deletions(-)

diff --git a/installinstallmacos.py b/installinstallmacos.py
index 21b2929..15d35b4 100755
--- a/installinstallmacos.py
+++ b/installinstallmacos.py
@@ -252,7 +252,8 @@ def replicate_url(full_url,
                   root_dir='/tmp',
                   show_progress=False,
                   ignore_cache=False,
-                  attempt_resume=False):
+                  attempt_resume=False,
+                  limit_rate=None):
     '''Downloads a URL and stores it in the same relative path on our
     filesystem. Returns a path to the replicated file.'''
 
@@ -270,6 +271,10 @@ def replicate_url(full_url,
                     '--create-dirs',
                     '-o', local_file_path,
                     '-w', '%{http_code}']
+
+        if limit_rate is not None:
+            curl_cmd.extend(['--limit-rate', limit_rate])
+
         if not full_url.endswith(".gz"):
             # stupid hack for stupid Apple behavior where it sometimes returns
             # compressed files even when not asked for
@@ -464,7 +469,12 @@ def os_installer_product_info(catalog, workdir, ignore_cache=False):
     return product_info
 
 
-def replicate_product(catalog, product_id, workdir, ignore_cache=False):
+def replicate_product(
+    catalog,
+    product_id,
+    workdir,
+    ignore_cache=False,
+    limit_rate=None):
     '''Downloads all the packages for a product'''
     product = catalog['Products'][product_id]
     for package in product.get('Packages', []):
@@ -476,7 +486,8 @@ def replicate_product(catalog, product_id, workdir, ignore_cache=False):
                 replicate_url(
                     package['URL'], root_dir=workdir,
                     show_progress=True, ignore_cache=ignore_cache,
-                    attempt_resume=(not ignore_cache))
+                    attempt_resume=(not ignore_cache),
+                    limit_rate=limit_rate)
             except ReplicationError as err:
                 print('Could not replicate %s: %s' % (package['URL'], err),
                       file=sys.stderr)
@@ -484,7 +495,8 @@ def replicate_product(catalog, product_id, workdir, ignore_cache=False):
         if 'MetadataURL' in package:
             try:
                 replicate_url(package['MetadataURL'], root_dir=workdir,
-                              ignore_cache=ignore_cache)
+                              ignore_cache=ignore_cache,
+                              limit_rate=limit_rate)
             except ReplicationError as err:
                 print('Could not replicate %s: %s'
                       % (package['MetadataURL'], err), file=sys.stderr)
@@ -525,6 +537,8 @@ def main():
                         'less available disk space and is faster.')
     parser.add_argument('--ignore-cache', action='store_true',
                         help='Ignore any previously cached files.')
+    parser.add_argument('--limit-rate', metavar='limit_rate', default=None,
+                        help='limit the download speed per curl --limit-rate')
     args = parser.parse_args()
 
     if os.getuid() != 0:
@@ -595,7 +609,11 @@ def main():
 
     # download all the packages for the selected product
     replicate_product(
-        catalog, product_id, args.workdir, ignore_cache=args.ignore_cache)
+        catalog,
+        product_id,
+        args.workdir,
+        ignore_cache=args.ignore_cache,
+        limit_rate=args.limit_rate)
 
     # generate a name for the sparseimage
     volname = ('Install_macOS_%s-%s'