feat: support upload through usb (#155)

Author: sachiniyer

paper2remarkable/providers/_base.py

@@ -25,7 +25,8 @@
 from ..utils import check_pdftool
 from ..utils import download_url
 from ..utils import follow_redirects
-from ..utils import upload_to_remarkable
+from ..utils import upload_to_remarkable_rmapi
+from ..utils import upload_to_remarkable_usb
 from ._info import Informer
 
 logger = Logger()
@@ -43,6 +44,7 @@ def __init__(
         crop="left",
         blank=False,
         remarkable_dir="/",
+        usb_upload=False,
         rmapi_path="rmapi",
         pdftoppm_path="pdftoppm",
         pdftk_path="pdftk",
@@ -57,6 +59,7 @@ def __init__(
         self.experimental = experimental
         self.remarkable_dir = remarkable_dir
         self.rmapi_path = rmapi_path
+        self.usb_upload = usb_upload
         self.pdftoppm_path = pdftoppm_path
         self.pdftk_path = pdftk_path
         self.qpdf_path = qpdf_path
@@ -231,11 +234,17 @@ def run(self, src, filename=None):
                     return input()
 
                 if self.upload:
-                    return upload_to_remarkable(
-                        clean_filename,
-                        remarkable_dir=self.remarkable_dir,
-                        rmapi_path=self.rmapi_path,
-                    )
+                    if not self.usb_upload:
+                        return upload_to_remarkable_rmapi(
+                            clean_filename,
+                            remarkable_dir=self.remarkable_dir,
+                            rmapi_path=self.rmapi_path,
+                        )
+                    else:
+                        return upload_to_remarkable_usb(
+                            clean_filename,
+                            remarkable_dir=self.remarkable_dir,
+                        )
 
                 target_path = os.path.join(self.initial_dir, clean_filename)
                 while os.path.exists(target_path):

paper2remarkable/ui.py

@@ -90,6 +90,11 @@ def build_argument_parser():
         help="Filename to use for the file on reMarkable",
         action="append",
     )
+    parser.add_argument(
+        "--usb-upload",
+        help="upload through usb instead of rmapi",
+        action="store_true",
+    )
     parser.add_argument(
         "--gs", help="path to gs executable (default: gs)", default=None
     )
@@ -260,6 +265,7 @@ def set_path(d, key, value):
     set_bool(opts["core"], "verbose", args.verbose)
     set_bool(opts["core"], "upload", args.no_upload, invert=True)
     set_bool(opts["core"], "experimental", args.experimental)
+    set_bool(opts["core"], "usb_upload", args.usb_upload)
 
     if args.center:
         opts["core"]["crop"] = "center"
@@ -325,6 +331,7 @@ def runner(inputs, filenames, options, debug=False):
             crop=options["core"]["crop"],
             blank=options["core"]["blank"],
             remarkable_dir=options["core"]["remarkable_dir"],
+            usb_upload=options["core"]["usb_upload"],
             rmapi_path=options["system"]["rmapi"],
             pdftoppm_path=options["system"]["pdftoppm"],
             pdftk_path=options["system"]["pdftk"],

paper2remarkable/utils.py

@@ -34,6 +34,8 @@
 
 HTTP_SERVICE_UNAVAILABLE = 503
 
+REMARKABLE_USB_URL = "http://10.11.99.1"
+
 logger = Logger()
 
 
@@ -156,7 +158,9 @@ def follow_redirects(url):
     return url, jar
 
 
-def upload_to_remarkable(filepath, remarkable_dir="/", rmapi_path="rmapi"):
+def upload_to_remarkable_rmapi(
+    filepath, remarkable_dir="/", rmapi_path="rmapi"
+):
     logger.info("Starting upload to reMarkable")
 
     # Create the reMarkable dir if it doesn't exist
@@ -188,6 +192,63 @@ def upload_to_remarkable(filepath, remarkable_dir="/", rmapi_path="rmapi"):
     logger.info("Upload successful.")
 
 
+def list_usb_dir(guid):
+    url = REMARKABLE_USB_URL + "/documents/"
+    if guid:
+        url += guid + "/"
+    response = requests.post(url)
+    return response.json()
+
+
+def crawl_usb_dirs(remarkable_dir):
+    parts = [p for p in remarkable_dir.split("/") if p]
+    guid = None
+    while len(parts) > 0:
+        part = parts.pop(0)
+        data = list_usb_dir(guid)
+        guid = None
+        for item in data:
+            if item["VissibleName"] == part:
+                guid = item["ID"]
+        if not guid:
+            raise RemarkableError(
+                "Directory %s does not exist on reMarkable" % remarkable_dir
+            )
+    # necessary because the last listed dir is the one uploaded to
+    list_usb_dir(guid)
+
+
+def upload_to_remarkable_usb(filepath, remarkable_dir="/"):
+    # https://remarkable.guide/tech/usb-web-interface.html
+    logger.info("Starting upload to reMarkable")
+
+    # Check if the remarkable dir exists (no creation through usb api)
+    crawl_usb_dirs(remarkable_dir)
+
+    headers = {
+        "Origin": REMARKABLE_USB_URL,
+        "Accept": "*/*",
+        "Referer": REMARKABLE_USB_URL + "/",
+        "Connection": "keep-alive",
+    }
+    response = requests.post(
+        REMARKABLE_USB_URL + "/upload",
+        files={
+            "file": (
+                os.path.basename(filepath),
+                open(filepath, "rb"),
+                "application/pdf",
+            )
+        },
+        headers=headers,
+    )
+    if not response.ok:
+        raise RemarkableError(
+            "Uploading file %s to reMarkable failed" % filepath
+        )
+    logger.info("Upload successful.")
+
+
 def is_url(string):
     """Check if the string is a valid URL