WIP: steam upload

Author: tomprince

RELEASE.rst

@@ -0,0 +1,3 @@
+type: minor
+---
+Add support for uploading to the steam workshop.

mypy.ini

@@ -2,3 +2,6 @@
 mypy_path = stubs
 files = src
 strict = True
+
+[mypy-steam.*]
+ignore_missing_imports = True

pyproject.toml

@@ -6,6 +6,7 @@ build-backend = "flit_core.buildapi"
 module = "tts"
 dist-name = "tabletop-tools"
 requires = [
+    "appdirs",
     "attrs",
     "bson",
     "requests",
@@ -16,6 +17,11 @@ author-email = "[email protected]"
 description-file = "README.rst"
 classifiers = ["License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)"]
 
+[tool.flit.metadata.requires-extra]
+upload = [
+    "steam",
+]
+
 [tool.flit.metadata.urls]
 Repository = "https://github.com/tomprince/tabletop-tools"
 
@@ -26,3 +32,6 @@ tts = "tts.cli:main"
 [tool.tts_tooling]
 release_file = "RELEASE.rst"
 changelog = "CHANGELOG.rst"
+
+[tool.black]
+include = '\.pyi?$'

src/tts/cli.py

@@ -37,23 +37,41 @@ def unpack_cmd(*, savegame_file: Optional[Path], fileid: Optional[int]) -> None:
     type=Path,
     nargs="?",
 )
+@app.argument("--fileid", type=int, help="Workshop file id to unpack.")
 @app.argument("--binary", action="store_true")
-def repack_cmd(*, savegame_file: Optional[Path], binary: bool) -> None:
+def repack_cmd(
+    *, savegame_file: Optional[Path], fileid: Optional[int], binary: bool
+) -> None:
     from .config import config
     from .repack import repack
 
-    if not savegame_file:
+    if fileid and savegame_file:
+        raise Exception("Can't specify both a savegame file and a workshop file id.")
+    elif fileid and binary:
+        raise Exception("Can't specify both a workshop file id and '--binary'.")
+    elif not savegame_file:
         if binary:
             savegame_file = Path("build/savegame.bson")
         else:
             savegame_file = Path("build/savegame.json")
 
-    if not savegame_file.parent.exists():
+    if not fileid and not savegame_file.parent.exists():
         savegame_file.parent.mkdir(parents=True)
 
     savegame = repack(config=config)
 
-    if binary:
+    if fileid:
+        import bson
+
+        from tts.steam import cli_login, update_file, upload_file
+
+        client = cli_login()
+        # It appears that tabletop simulator depends on the file being named
+        # `WorkshopUpload`.
+        upload_file(client, "WorkshopUpload", bson.dumps(savegame))
+        update_file(client, fileid, "WorkshopUpload")
+
+    elif binary:
         import bson
 
         savegame_file.write_bytes(bson.dumps(savegame))
@@ -76,4 +94,28 @@ def download_cmd(*, fileid: int, output: Optional[Path]) -> None:
     output.write_text(format_json(mod))
 
 
+@app.command(
+    "workshop-upload",
+    help="Upload a mod to the steam workshop.",
+    description="This will currently only update a existing mod.",
+)
+@app.argument("fileid", type=int)
+@app.argument(
+    "savegame_file",
+    metavar="savegame",
+    type=Path,
+)
+def upload_cmd(*, fileid: int, savegame_file: Optional[Path]) -> None:
+    import bson
+
+    from tts.steam import cli_login, update_file, upload_file
+
+    savegame = json.loads(savegame_file.read_text())
+    client = cli_login()
+    # It appears that tabletop simulator depends on the file being named
+    # `WorkshopUpload`.
+    upload_file(client, "WorkshopUpload", bson.dumps(savegame))
+    update_file(client, fileid, "WorkshopUpload")
+
+
 main = app.main

src/tts/config.py

@@ -1,6 +1,11 @@
 from pathlib import Path
 
 import attr
+from appdirs import AppDirs
+
+APPID = 286160
+
+appdirs = AppDirs("tabletop-tools", appauthor=False)
 
 
 @attr.s(auto_attribs=True)

src/tts/steam/__init__.py

@@ -0,0 +1,33 @@
+from pathlib import Path
+
+from steam.client import SteamClient
+from steam.enums.common import EResult
+
+from ..config import APPID, appdirs
+from ._upload import upload_file
+
+__all__ = ["cli_login", "update_file", "upload_file"]
+
+
+def cli_login() -> SteamClient:
+    cache_dir = Path(appdirs.user_cache_dir)
+    client = SteamClient()
+    client.credential_location = cache_dir.joinpath("steam")
+    res = client.cli_login()
+    if res != EResult.OK:
+        raise Exception(f"Could not login: {res.name}")
+
+    return client
+
+
+def update_file(client: SteamClient, file_id: int, file_name: str) -> None:
+    resp = client.send_um_and_wait(
+        "PublishedFile.Update#1",
+        {
+            "appid": APPID,
+            "publishedfileid": file_id,
+            "filename": file_name,
+        },
+    )
+    if resp.header.eresult != EResult.OK:
+        raise Exception(f"Couldn't publish file: {EResult(resp.header.eresult).name}")

src/tts/steam/_upload.py

@@ -0,0 +1,85 @@
+import hashlib
+import time
+
+import requests
+from steam.client import SteamClient
+from steam.enums.common import EResult
+from steam.protobufs.steammessages_cloud_pb2 import ClientCloudFileUploadBlockDetails
+
+from ..config import APPID
+
+
+def _hash_sha1(data: bytes) -> bytes:
+    m = hashlib.sha1()
+    m.update(data)
+    return m.digest()
+
+
+def upload_file(client: SteamClient, file_name: str, file_data: bytes) -> None:
+    file_sha = _hash_sha1(file_data)
+    resp = client.send_um_and_wait(
+        "Cloud.ClientBeginFileUpload#1",
+        {
+            "appid": APPID,
+            "file_size": len(file_data),
+            "raw_file_size": len(file_data),
+            "file_sha": file_sha,
+            "filename": file_name,
+            "can_encrypt": False,
+            "time_stamp": int(time.time()),
+            "is_shared_file": False,
+        },
+    )
+    if resp.header.eresult == EResult.DuplicateRequest:
+        # Already uploaded.
+        return
+    if resp.header.eresult != EResult.OK:
+        raise Exception(f"Couldn't start upload: {EResult(resp.header.eresult).name}")
+    try:
+        for block_request in resp.body.block_requests:
+            _upload_block(block_request, file_data)
+    except Exception:
+        client.send_um_and_wait(
+            "Cloud.ClientCommitFileUpload#1",
+            {
+                "appid": APPID,
+                "filename": file_name,
+                "file_sha": file_sha,
+                "transfer_succeeded": False,
+            },
+        )
+        raise
+    else:
+        resp = client.send_um_and_wait(
+            "Cloud.ClientCommitFileUpload#1",
+            {
+                "appid": APPID,
+                "filename": file_name,
+                "file_sha": file_sha,
+                "transfer_succeeded": True,
+            },
+        )
+        if resp.header.eresult != EResult.OK:
+            raise Exception(
+                f"Couldn't commit upload: {EResult(resp.header.eresult).name}"
+            )
+
+
+def _upload_block(
+    block_request: ClientCloudFileUploadBlockDetails, file_data: bytes
+) -> None:
+    url = f"https://{block_request.url_host}{block_request.url_path}"
+    headers = {}
+    for header in block_request.request_headers:
+        if header.name == "Content-Disposition":
+            headers[header.name] = header.value.rstrip(";")
+        else:
+            headers[header.name] = header.value
+    block_end = block_request.block_offset + block_request.block_length
+    block_data = file_data[block_request.block_offset : block_end]
+    headers["Content-Length"] = f"{block_request.block_length}"
+    headers[
+        "Content-Range"
+    ] = f"bytes {block_request.block_offset}-{block_end}/{len(file_data)}"
+    response = requests.put(url, headers=headers, data=block_data)
+    response.raise_for_status()