bacommon.bacloud

21def asset_file_cache_path(filehash: str) -> str:
22    """Given a sha256 hex file hash, return a storage path."""
23
24    # We expect a 64 byte hex str with only lowercase letters and
25    # numbers. Note to self: I considered base64 hashes to save space
26    # but then remembered that lots of filesystems out there ignore case
27    # so that would not end well.
28    assert len(filehash) == 64
29    assert filehash.islower()
30    assert filehash.isalnum()
31
32    # Split into a few levels of directories to keep directory listings
33    # and operations reasonable. This will give 256 top level dirs, each
34    # with 256 subdirs. So if we have 65,536 files in our cache then
35    # dirs will average 1 file each. That seems like a reasonable spread
36    # I think.
37    return f'{filehash[:2]}/{filehash[2:4]}/{filehash[4:]}'

40@ioprepped
41@dataclass
42class RequestData:
43    """Request sent to bacloud server."""
44
45    command: Annotated[str, IOAttrs('c')]
46    token: Annotated[str | None, IOAttrs('t')]
47    payload: Annotated[dict, IOAttrs('p')]
48    tzoffset: Annotated[float, IOAttrs('z')]
49    isatty: Annotated[bool, IOAttrs('y')]

 52@ioprepped
 53@dataclass
 54class ResponseData:
 55    """Response sent from the bacloud server to the client.
 56
 57    Attributes:
 58      message: If present, client should print this message before any other
 59        response processing (including error handling) occurs.
 60      message_end: end arg for message print() call.
 61      error: If present, client should abort with this error message.
 62      delay_seconds: How long to wait before proceeding with remaining
 63        response (can be useful when waiting for server progress in a loop).
 64      login: If present, a token that should be stored client-side and passed
 65        with subsequent commands.
 66      logout: If True, any existing client-side token should be discarded.
 67      dir_manifest: If present, client should generate a manifest of this dir.
 68        It should be added to end_command args as 'manifest'.
 69      uploads: If present, client should upload the requested files (arg1)
 70        individually to a server command (arg2) with provided args (arg3).
 71      uploads_inline: If present, a list of pathnames that should be gzipped
 72        and uploaded to an 'uploads_inline' bytes dict in end_command args.
 73        This should be limited to relatively small files.
 74      deletes: If present, file paths that should be deleted on the client.
 75      downloads: If present, describes files the client should individually
 76        request from the server if not already present on the client.
 77      downloads_inline: If present, pathnames mapped to gzipped data to
 78        be written to the client. This should only be used for relatively
 79        small files as they are all included inline as part of the response.
 80      dir_prune_empty: If present, all empty dirs under this one should be
 81        removed.
 82      open_url: If present, url to display to the user.
 83      input_prompt: If present, a line of input is read and placed into
 84        end_command args as 'input'. The first value is the prompt printed
 85        before reading and the second is whether it should be read as a
 86        password (without echoing to the terminal).
 87      end_message: If present, a message that should be printed after all other
 88        response processing is done.
 89      end_message_end: end arg for end_message print() call.
 90      end_command: If present, this command is run with these args at the end
 91        of response processing.
 92    """
 93
 94    @ioprepped
 95    @dataclass
 96    class Downloads:
 97        """Info about downloads included in a response."""
 98
 99        @ioprepped
100        @dataclass
101        class Entry:
102            """Individual download."""
103
104            path: Annotated[str, IOAttrs('p')]
105            # Args include with this particular request (combined with
106            # baseargs).
107            args: Annotated[dict[str, str], IOAttrs('a')]
108            # TODO: could add a hash here if we want the client to
109            # verify hashes.
110
111        # If present, will be prepended to all entry paths via os.path.join.
112        basepath: Annotated[str | None, IOAttrs('p')]
113
114        # Server command that should be called for each download. The
115        # server command is expected to respond with a downloads_inline
116        # containing a single 'default' entry. In the future this may
117        # be expanded to a more streaming-friendly process.
118        cmd: Annotated[str, IOAttrs('c')]
119
120        # Args that should be included with all download requests.
121        baseargs: Annotated[dict[str, str], IOAttrs('a')]
122
123        # Everything that should be downloaded.
124        entries: Annotated[list[Entry], IOAttrs('e')]
125
126    message: Annotated[str | None, IOAttrs('m', store_default=False)] = None
127    message_end: Annotated[str, IOAttrs('m_end', store_default=False)] = '\n'
128    error: Annotated[str | None, IOAttrs('e', store_default=False)] = None
129    delay_seconds: Annotated[float, IOAttrs('d', store_default=False)] = 0.0
130    login: Annotated[str | None, IOAttrs('l', store_default=False)] = None
131    logout: Annotated[bool, IOAttrs('lo', store_default=False)] = False
132    dir_manifest: Annotated[str | None, IOAttrs('man', store_default=False)] = (
133        None
134    )
135    uploads: Annotated[
136        tuple[list[str], str, dict] | None, IOAttrs('u', store_default=False)
137    ] = None
138    uploads_inline: Annotated[
139        list[str] | None, IOAttrs('uinl', store_default=False)
140    ] = None
141    deletes: Annotated[
142        list[str] | None, IOAttrs('dlt', store_default=False)
143    ] = None
144    downloads: Annotated[
145        Downloads | None, IOAttrs('dl', store_default=False)
146    ] = None
147    downloads_inline: Annotated[
148        dict[str, bytes] | None, IOAttrs('dinl', store_default=False)
149    ] = None
150    dir_prune_empty: Annotated[
151        str | None, IOAttrs('dpe', store_default=False)
152    ] = None
153    open_url: Annotated[str | None, IOAttrs('url', store_default=False)] = None
154    input_prompt: Annotated[
155        tuple[str, bool] | None, IOAttrs('inp', store_default=False)
156    ] = None
157    end_message: Annotated[str | None, IOAttrs('em', store_default=False)] = (
158        None
159    )
160    end_message_end: Annotated[str, IOAttrs('eme', store_default=False)] = '\n'
161    end_command: Annotated[
162        tuple[str, dict] | None, IOAttrs('ec', store_default=False)
163    ] = None

 94    @ioprepped
 95    @dataclass
 96    class Downloads:
 97        """Info about downloads included in a response."""
 98
 99        @ioprepped
100        @dataclass
101        class Entry:
102            """Individual download."""
103
104            path: Annotated[str, IOAttrs('p')]
105            # Args include with this particular request (combined with
106            # baseargs).
107            args: Annotated[dict[str, str], IOAttrs('a')]
108            # TODO: could add a hash here if we want the client to
109            # verify hashes.
110
111        # If present, will be prepended to all entry paths via os.path.join.
112        basepath: Annotated[str | None, IOAttrs('p')]
113
114        # Server command that should be called for each download. The
115        # server command is expected to respond with a downloads_inline
116        # containing a single 'default' entry. In the future this may
117        # be expanded to a more streaming-friendly process.
118        cmd: Annotated[str, IOAttrs('c')]
119
120        # Args that should be included with all download requests.
121        baseargs: Annotated[dict[str, str], IOAttrs('a')]
122
123        # Everything that should be downloaded.
124        entries: Annotated[list[Entry], IOAttrs('e')]

 99        @ioprepped
100        @dataclass
101        class Entry:
102            """Individual download."""
103
104            path: Annotated[str, IOAttrs('p')]
105            # Args include with this particular request (combined with
106            # baseargs).
107            args: Annotated[dict[str, str], IOAttrs('a')]
108            # TODO: could add a hash here if we want the client to
109            # verify hashes.