Help Topics for vbox

vbox · open_remote

Sample CLI

gway vbox open-remote

References

cdv, cdv.load_all, cdv.update, error, info, mail, mail.search, resource

Signature

(server_url: str = '[SERVER_URL]', *, path: str = 'vbox', email: str = '[ADMIN_EMAIL]')

Docstring

Create a vbox on a remote system, retrieve the upload link from email, and store it locally. - server_url: Base URL of the remote server (e.g., 'https://example.com') - path: Path on remote server where vbox upload is handled (default 'vbox') - email: Email address to receive the upload link (should be accessible by local mail.search) Returns: dict of stored record fields, or None if unsuccessful.
vbox · periodic_purge

Sample CLI

gway vbox periodic-purge

Signature

(*, seconds=120)

Docstring

Background thread to periodically purge expired upload boxes.
vbox · poll_remote

Sample CLI

gway vbox poll-remote

References

cdv, cdv.load_all, error, info, resource

Signature

(server_url: str = '[SERVER_URL]', *, target='work/vbox/remote', interval=3600)

Docstring

Poll the remote vbox for files and download new/updated ones to the local target directory. - server_url: Remote GWAY instance base URL - target: Local directory to save downloaded files - interval: Seconds between polls (runs forever unless interval=None) Skips files already downloaded by using the modified_since parameter.
vbox · purge

Sample CLI

gway vbox purge

References

error, resource

Signature

(*, all=False)

Docstring

Manually purge expired vbox entries and remove their folders. Args: all (bool): If True, delete all folders, even non-empty ones and those not in _open_boxes.
vbox · render_error

Sample CLI

gway vbox render-error

References

web, web.app, web.app.build_url

Signature

(title: str, message: str, *, back_link: bool = True, target: str = 'uploads') -> str

Docstring

Helper for error display with optional link back to upload main page.
vbox · stream_file_response

Sample CLI

gway vbox stream-file-response

Signature

(path: str, filename: str) -> bottle.HTTPResponse

Docstring

Return a proper file download response that bypasses HTML templating.
vbox · view_downloads

Sample CLI

gway vbox view-downloads

References

build_url, error, resource, warning

Signature

(*hashes: tuple[str], vbid: str = None, modified_since=None, **kwargs)

Docstring

GET: Show list of files in the box (with hash), allow selection/downloads. If a single hash is provided, return that file. Multiple hashes are not supported yet. - Allows access via full vbid (short.long) or short-only (just the folder name). - If full vbid is used, shows link to upload more files. - If modified_since is passed (as iso or epoch seconds), only send file if newer, else 304.

TODOs

# TODO: Support multiple hashes by checking them one by one. If the first doesn't exist, # try the next and so forth. Give up when every hash fails to match. First matches is chosen first.