okfile 1.2.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- okfile-1.2.0.dist-info/METADATA +252 -0
- okfile-1.2.0.dist-info/RECORD +8 -0
- okfile-1.2.0.dist-info/WHEEL +5 -0
- okfile-1.2.0.dist-info/entry_points.txt +2 -0
- okfile-1.2.0.dist-info/licenses/LICENSE +201 -0
- okfile-1.2.0.dist-info/top_level.txt +1 -0
- okfile_cli/__init__.py +3 -0
- okfile_cli/__main__.py +638 -0
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: okfile
|
|
3
|
+
Version: 1.2.0
|
|
4
|
+
Summary: Python CLI for uploading files and publishing static sites to OkFile
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
Project-URL: Homepage, https://www.okfile.com
|
|
7
|
+
Project-URL: Repository, https://github.com/okfilecom/okfile
|
|
8
|
+
Project-URL: Issues, https://github.com/okfilecom/okfile/issues
|
|
9
|
+
Keywords: okfile,upload,publish,cli,cloudflare,r2
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Classifier: Topic :: Internet
|
|
20
|
+
Classifier: Topic :: Utilities
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
Requires-Dist: requests>=2.31.0
|
|
25
|
+
Dynamic: license-file
|
|
26
|
+
|
|
27
|
+
# OkFile
|
|
28
|
+
|
|
29
|
+
Agent-first file upload and publish service built on Cloudflare Pages Functions, R2, and D1.
|
|
30
|
+
|
|
31
|
+
- Website: `https://www.okfile.com`
|
|
32
|
+
- Repository: `https://github.com/okfilecom/okfile`
|
|
33
|
+
- License: `Apache-2.0`
|
|
34
|
+
|
|
35
|
+
## What It Does
|
|
36
|
+
|
|
37
|
+
OkFile is designed for Agents, scripts, and lightweight manual upload use cases.
|
|
38
|
+
|
|
39
|
+
It supports:
|
|
40
|
+
|
|
41
|
+
- anonymous uploads
|
|
42
|
+
- authenticated uploads with user API keys
|
|
43
|
+
- direct file URLs for download or embedding
|
|
44
|
+
- preview/playback URLs for image, video, and PDF
|
|
45
|
+
- multipart upload for large files up to `500MB`
|
|
46
|
+
- phase-1 site directory upload with nested subdirectories and per-site subdomain publish URLs
|
|
47
|
+
- automatic shared top-level directory stripping for folder-based site uploads
|
|
48
|
+
- directory listing fallback when a published site does not contain root `index.html`
|
|
49
|
+
- retrying only missing parts after incomplete multipart uploads
|
|
50
|
+
- email magic-link login and account management
|
|
51
|
+
- localized home, upload, and account pages
|
|
52
|
+
|
|
53
|
+
## Main User Flows
|
|
54
|
+
|
|
55
|
+
### 1. Anonymous Publish
|
|
56
|
+
|
|
57
|
+
1. `POST /api/upload/prepare`
|
|
58
|
+
2. `PUT uploadUrl` or each `parts[].uploadUrl`
|
|
59
|
+
3. `POST /api/upload/complete`
|
|
60
|
+
4. return `url` and optionally `playUrl`
|
|
61
|
+
|
|
62
|
+
### 2. API Key Publish
|
|
63
|
+
|
|
64
|
+
1. request a magic link and log in
|
|
65
|
+
2. create an API key in `/account`
|
|
66
|
+
3. call `POST /api/upload/prepare` with `apiKey`
|
|
67
|
+
4. upload file data to signed URLs
|
|
68
|
+
5. call `POST /api/upload/complete`
|
|
69
|
+
|
|
70
|
+
### 3. Manual Upload
|
|
71
|
+
|
|
72
|
+
Users can also use:
|
|
73
|
+
|
|
74
|
+
- `/zh/upload/`
|
|
75
|
+
- `/en/upload/`
|
|
76
|
+
|
|
77
|
+
This path is kept as a fallback entry, while API integration remains the recommended flow.
|
|
78
|
+
|
|
79
|
+
### 4. Site Directory Publish
|
|
80
|
+
|
|
81
|
+
1. select a whole folder in `/zh/upload/` or `/en/upload/`
|
|
82
|
+
2. the uploader preserves nested relative paths
|
|
83
|
+
3. if every file sits under one shared top-level folder, that folder is stripped and treated as the site root
|
|
84
|
+
4. if the site contains root `index.html`, `/` renders that page
|
|
85
|
+
5. if root `index.html` does not exist, `/` renders a directory listing with file name, size, and upload time
|
|
86
|
+
6. image and video entries open inline, while other files use download links
|
|
87
|
+
|
|
88
|
+
## Architecture
|
|
89
|
+
|
|
90
|
+
### Runtime
|
|
91
|
+
|
|
92
|
+
- Cloudflare Pages Functions for routing and API handling
|
|
93
|
+
- Cloudflare Worker route for `*.ok26.org/*` site subdomains
|
|
94
|
+
- Cloudflare R2 for file storage
|
|
95
|
+
- Cloudflare D1 for auth and API key metadata
|
|
96
|
+
- Resend for email magic links
|
|
97
|
+
|
|
98
|
+
### Frontend
|
|
99
|
+
|
|
100
|
+
- static `index.html` for homepage
|
|
101
|
+
- static `upload.html` for manual upload
|
|
102
|
+
- server-side localization and SEO injection in `worker-app.js`
|
|
103
|
+
|
|
104
|
+
### Backend Responsibilities
|
|
105
|
+
|
|
106
|
+
- issue presigned R2 upload URLs
|
|
107
|
+
- complete multipart uploads
|
|
108
|
+
- activate public file routes
|
|
109
|
+
- resolve published site subdomains from request `Host`
|
|
110
|
+
- manage sessions, magic links, and API keys
|
|
111
|
+
- enforce anonymous and per-key quota limits
|
|
112
|
+
|
|
113
|
+
## Core Routes
|
|
114
|
+
|
|
115
|
+
### Pages
|
|
116
|
+
|
|
117
|
+
- `/zh/` and `/en/`: localized home pages
|
|
118
|
+
- `/zh/upload/` and `/en/upload/`: manual upload pages
|
|
119
|
+
- `/account`: redirects to localized account page
|
|
120
|
+
- `/zh/account/` and `/en/account/`: localized account pages
|
|
121
|
+
- `/admin`: admin console
|
|
122
|
+
|
|
123
|
+
### Upload APIs
|
|
124
|
+
|
|
125
|
+
- `POST /api/upload/prepare`
|
|
126
|
+
- `POST /api/upload/complete`
|
|
127
|
+
- `GET /api/upload/status/{id}`
|
|
128
|
+
|
|
129
|
+
### Auth APIs
|
|
130
|
+
|
|
131
|
+
- `POST /api/auth/request-link`
|
|
132
|
+
- `GET /auth/verify?token=...`
|
|
133
|
+
- `GET /api/account/me`
|
|
134
|
+
- `POST /api/account/api-keys`
|
|
135
|
+
|
|
136
|
+
### File URLs
|
|
137
|
+
|
|
138
|
+
- `/i/{id}`: direct file URL
|
|
139
|
+
- `/i/{id}?play=1`: preview/playback page
|
|
140
|
+
- `/d/{id}`: controlled download route
|
|
141
|
+
|
|
142
|
+
### Site URLs
|
|
143
|
+
|
|
144
|
+
- `https://{subdomain}.ok26.org/`: site root or directory listing
|
|
145
|
+
- `https://{subdomain}.ok26.org/path/to/file`: published site asset or document
|
|
146
|
+
- `https://{subdomain}.ok26.org/path/to/file?download=1`: force download for a site file
|
|
147
|
+
|
|
148
|
+
## Repository Layout
|
|
149
|
+
|
|
150
|
+
```text
|
|
151
|
+
.
|
|
152
|
+
|- worker-app.js # main Pages Function entry
|
|
153
|
+
|- index.html # homepage
|
|
154
|
+
|- upload.html # manual upload page
|
|
155
|
+
|- schema.sql # D1 schema
|
|
156
|
+
|- wrangler.toml # Cloudflare config
|
|
157
|
+
|- SKILL.md # root skill document
|
|
158
|
+
|- .trae/skills/okfile/SKILL.md # Trae skill definition
|
|
159
|
+
|- okfile-upload-pitfalls.md # upload pitfalls and debugging notes
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## Local Development
|
|
163
|
+
|
|
164
|
+
Install dependencies:
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
npm install
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
Run local development:
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
npx wrangler pages dev .
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
Deploy to Cloudflare Pages:
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
npx wrangler pages deploy . --project-name okfile --branch main
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
## Configuration
|
|
183
|
+
|
|
184
|
+
Store secrets in Cloudflare, not in the repository.
|
|
185
|
+
|
|
186
|
+
### Secrets
|
|
187
|
+
|
|
188
|
+
- `R2_ACCESS_KEY_ID`
|
|
189
|
+
- `R2_SECRET_ACCESS_KEY`
|
|
190
|
+
- `RESEND_API_KEY`
|
|
191
|
+
|
|
192
|
+
### Plain-Text Vars
|
|
193
|
+
|
|
194
|
+
- `R2_ACCOUNT_ID`
|
|
195
|
+
- `RESEND_FROM_EMAIL`
|
|
196
|
+
- `ADMIN_EMAILS`
|
|
197
|
+
|
|
198
|
+
## Database
|
|
199
|
+
|
|
200
|
+
The D1 schema is defined in `schema.sql` and includes:
|
|
201
|
+
|
|
202
|
+
- `users`
|
|
203
|
+
- `magic_links`
|
|
204
|
+
- `sessions`
|
|
205
|
+
- `api_keys`
|
|
206
|
+
- `api_key_usage_windows`
|
|
207
|
+
|
|
208
|
+
## Upload Notes
|
|
209
|
+
|
|
210
|
+
See these repo docs for integration details:
|
|
211
|
+
|
|
212
|
+
- `SKILL.md`
|
|
213
|
+
- `SITE_UPLOAD_DESIGN.md`
|
|
214
|
+
- `.trae/skills/okfile/SKILL.md`
|
|
215
|
+
- `okfile-upload-pitfalls.md`
|
|
216
|
+
|
|
217
|
+
The pitfalls doc includes practical notes such as:
|
|
218
|
+
|
|
219
|
+
- Cloudflare requiring a normal `User-Agent` for some requests
|
|
220
|
+
- explicit `Content-Length` on R2 PUT
|
|
221
|
+
- multipart retry strategy
|
|
222
|
+
- large-file client recommendations on Windows
|
|
223
|
+
|
|
224
|
+
For site publishing:
|
|
225
|
+
|
|
226
|
+
- use root `index.html` when you want the subdomain root to render a page
|
|
227
|
+
- if you upload a single wrapper folder such as `my-site/...`, OkFile strips `my-site/` automatically
|
|
228
|
+
- if no root `index.html` exists, users land on a browsable directory listing instead of downloading an arbitrary file
|
|
229
|
+
|
|
230
|
+
## Articles
|
|
231
|
+
|
|
232
|
+
Published and outward-facing articles are archived in `docs/`:
|
|
233
|
+
|
|
234
|
+
- docs/README.md
|
|
235
|
+
- docs/devto-agent-delivery-publish-file-or-site-test-guide.md
|
|
236
|
+
- docs/aliyun-workbuddy-agent-file-site-publish-test-guide.md
|
|
237
|
+
|
|
238
|
+
## Contributing
|
|
239
|
+
|
|
240
|
+
Please read `CONTRIBUTING.md` before opening pull requests.
|
|
241
|
+
|
|
242
|
+
## Security
|
|
243
|
+
|
|
244
|
+
Please read `SECURITY.md` for reporting instructions and secret-handling rules.
|
|
245
|
+
|
|
246
|
+
## Changelog
|
|
247
|
+
|
|
248
|
+
See `CHANGELOG.md` for release notes tracked in-repo.
|
|
249
|
+
|
|
250
|
+
## License
|
|
251
|
+
|
|
252
|
+
Apache-2.0
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
okfile-1.2.0.dist-info/licenses/LICENSE,sha256=dQW0icyK1_FroINDGEMg8VgzA8-s25EhubdWvAc98as,10254
|
|
2
|
+
okfile_cli/__init__.py,sha256=e_5GQqjfAws2vKzEbf_KtxV7uLbDKtVZNfOH6JhenUY,49
|
|
3
|
+
okfile_cli/__main__.py,sha256=J3NPpxh4MYeO8WEY5kxl4sXIUovWqeLqswXv2PUZHOE,22066
|
|
4
|
+
okfile-1.2.0.dist-info/METADATA,sha256=jebO2dzzk1OUDnB7tYmXGLv2ea1FKtn-Hywyoxb449M,7194
|
|
5
|
+
okfile-1.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
|
|
6
|
+
okfile-1.2.0.dist-info/entry_points.txt,sha256=iz4p_ZogSx8R7a5KM4goR6rIzZTKxCC2q724XqI3ko4,52
|
|
7
|
+
okfile-1.2.0.dist-info/top_level.txt,sha256=bYqd2paae91SCTTDcJvcN1nb4TKw_P6wexMKaOVpFro,11
|
|
8
|
+
okfile-1.2.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
okfile_cli
|
okfile_cli/__init__.py
ADDED
okfile_cli/__main__.py
ADDED
|
@@ -0,0 +1,638 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import argparse
|
|
4
|
+
import datetime as dt
|
|
5
|
+
import json
|
|
6
|
+
import mimetypes
|
|
7
|
+
import os
|
|
8
|
+
import sys
|
|
9
|
+
import traceback
|
|
10
|
+
from pathlib import Path
|
|
11
|
+
from typing import Any
|
|
12
|
+
|
|
13
|
+
import requests
|
|
14
|
+
|
|
15
|
+
from okfile_cli import __version__
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
DEFAULT_ORIGIN = "https://www.okfile.com"
|
|
19
|
+
DEFAULT_TIMEOUT = 60
|
|
20
|
+
UPLOAD_TIMEOUT = 900
|
|
21
|
+
FALLBACK_QUICK_UPLOAD_MAX_SIZE = 5 * 1024 * 1024
|
|
22
|
+
FALLBACK_MULTIPART_THRESHOLD = 25 * 1024 * 1024
|
|
23
|
+
FALLBACK_PART_SIZE = 10 * 1024 * 1024
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
class OkFileError(RuntimeError):
|
|
27
|
+
pass
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
def main() -> int:
|
|
31
|
+
parser = build_parser()
|
|
32
|
+
args = parser.parse_args()
|
|
33
|
+
|
|
34
|
+
if not getattr(args, "command", None):
|
|
35
|
+
parser.print_help()
|
|
36
|
+
return 0
|
|
37
|
+
|
|
38
|
+
try:
|
|
39
|
+
return args.func(args)
|
|
40
|
+
except KeyboardInterrupt:
|
|
41
|
+
print("Aborted by user", file=sys.stderr)
|
|
42
|
+
return 130
|
|
43
|
+
except requests.RequestException as exc:
|
|
44
|
+
if getattr(args, "verbose", False):
|
|
45
|
+
traceback.print_exc()
|
|
46
|
+
print(f"Network error: {exc}", file=sys.stderr)
|
|
47
|
+
return 1
|
|
48
|
+
except OkFileError as exc:
|
|
49
|
+
if getattr(args, "verbose", False):
|
|
50
|
+
traceback.print_exc()
|
|
51
|
+
print(f"Error: {exc}", file=sys.stderr)
|
|
52
|
+
return 1
|
|
53
|
+
except Exception as exc:
|
|
54
|
+
if getattr(args, "verbose", False):
|
|
55
|
+
traceback.print_exc()
|
|
56
|
+
return 1
|
|
57
|
+
print(f"Unexpected error: {exc}", file=sys.stderr)
|
|
58
|
+
print("Run again with --verbose for a traceback.", file=sys.stderr)
|
|
59
|
+
return 1
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
def build_parser() -> argparse.ArgumentParser:
|
|
63
|
+
parser = argparse.ArgumentParser(prog="okfile", description="Upload files and publish static sites to OkFile")
|
|
64
|
+
parser.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
|
|
65
|
+
|
|
66
|
+
subparsers = parser.add_subparsers(dest="command")
|
|
67
|
+
|
|
68
|
+
upload_parser = subparsers.add_parser("upload", help="Upload a single file")
|
|
69
|
+
upload_parser.add_argument("path", type=Path, help="Path to the file to upload")
|
|
70
|
+
upload_parser.add_argument("--key", help="API key to use for this command")
|
|
71
|
+
upload_parser.add_argument("--origin", help="OkFile origin, defaults to config or https://www.okfile.com")
|
|
72
|
+
upload_parser.add_argument("--max-downloads", type=int, help="Optional max download count")
|
|
73
|
+
upload_parser.add_argument("--expires-at", help="Optional ISO 8601 expiration timestamp")
|
|
74
|
+
upload_parser.add_argument("--verbose", action="store_true", help="Show debug details for request failures")
|
|
75
|
+
upload_parser.set_defaults(func=cmd_upload)
|
|
76
|
+
|
|
77
|
+
publish_parser = subparsers.add_parser("publish", help="Publish a local directory as a static site")
|
|
78
|
+
publish_parser.add_argument("path", type=Path, help="Path to the site directory")
|
|
79
|
+
publish_parser.add_argument("--name", help="Published site name")
|
|
80
|
+
publish_parser.add_argument("--key", help="API key to use for this command")
|
|
81
|
+
publish_parser.add_argument("--origin", help="OkFile origin, defaults to config or https://www.okfile.com")
|
|
82
|
+
publish_parser.add_argument("--expires-at", help="Optional ISO 8601 expiration timestamp")
|
|
83
|
+
publish_parser.add_argument("--verbose", action="store_true", help="Show debug details for request failures")
|
|
84
|
+
publish_parser.set_defaults(func=cmd_publish)
|
|
85
|
+
|
|
86
|
+
status_parser = subparsers.add_parser("status", help="Get upload status by file ID")
|
|
87
|
+
status_parser.add_argument("id", help="Upload ID")
|
|
88
|
+
status_parser.add_argument("--origin", help="OkFile origin, defaults to config or https://www.okfile.com")
|
|
89
|
+
status_parser.add_argument("--verbose", action="store_true", help="Show debug details for request failures")
|
|
90
|
+
status_parser.set_defaults(func=cmd_status)
|
|
91
|
+
|
|
92
|
+
config_parser = subparsers.add_parser("config", help="Store CLI defaults")
|
|
93
|
+
config_parser.add_argument("--key", help="Persist an API key for future commands")
|
|
94
|
+
config_parser.add_argument("--origin", help="Persist a default OkFile origin")
|
|
95
|
+
config_parser.add_argument("--clear-key", action="store_true", help="Remove the stored API key")
|
|
96
|
+
config_parser.add_argument("--verbose", action="store_true", help="Show debug details for request failures")
|
|
97
|
+
config_parser.set_defaults(func=cmd_config)
|
|
98
|
+
|
|
99
|
+
return parser
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
def cmd_upload(args: argparse.Namespace) -> int:
|
|
103
|
+
config = load_config()
|
|
104
|
+
origin = resolve_origin(args.origin, config)
|
|
105
|
+
api_key = resolve_api_key(args.key, config)
|
|
106
|
+
path = ensure_file(args.path)
|
|
107
|
+
max_downloads = validate_max_downloads(args.max_downloads)
|
|
108
|
+
expires_at = validate_expires_at(args.expires_at)
|
|
109
|
+
|
|
110
|
+
with requests.Session() as session:
|
|
111
|
+
upload_config = get_upload_config(session, origin)
|
|
112
|
+
result = upload_path(
|
|
113
|
+
session=session,
|
|
114
|
+
origin=origin,
|
|
115
|
+
path=path,
|
|
116
|
+
api_key=api_key,
|
|
117
|
+
upload_config=upload_config,
|
|
118
|
+
max_downloads=max_downloads,
|
|
119
|
+
expires_at=expires_at,
|
|
120
|
+
)
|
|
121
|
+
|
|
122
|
+
print_upload_result(result)
|
|
123
|
+
return 0
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
def cmd_publish(args: argparse.Namespace) -> int:
|
|
127
|
+
config = load_config()
|
|
128
|
+
origin = resolve_origin(args.origin, config)
|
|
129
|
+
api_key = resolve_api_key(args.key, config)
|
|
130
|
+
root = ensure_directory(args.path)
|
|
131
|
+
files = collect_site_files(root)
|
|
132
|
+
if not files:
|
|
133
|
+
raise OkFileError(f"No files found under {root}")
|
|
134
|
+
expires_at = validate_expires_at(args.expires_at)
|
|
135
|
+
|
|
136
|
+
entry_path = "index.html" if (root / "index.html").is_file() else None
|
|
137
|
+
site_name = (args.name or root.name).strip() or "site"
|
|
138
|
+
|
|
139
|
+
with requests.Session() as session:
|
|
140
|
+
upload_config = get_upload_config(session, origin)
|
|
141
|
+
prepared = api_json(
|
|
142
|
+
session,
|
|
143
|
+
"POST",
|
|
144
|
+
f"{origin}/api/site/prepare",
|
|
145
|
+
json_body={
|
|
146
|
+
"siteName": site_name,
|
|
147
|
+
"entryPath": entry_path,
|
|
148
|
+
"expiresAt": expires_at,
|
|
149
|
+
"apiKey": api_key,
|
|
150
|
+
"files": [
|
|
151
|
+
{
|
|
152
|
+
"path": relative,
|
|
153
|
+
"size": path.stat().st_size,
|
|
154
|
+
"contentType": guess_content_type(path),
|
|
155
|
+
}
|
|
156
|
+
for relative, path in files
|
|
157
|
+
],
|
|
158
|
+
},
|
|
159
|
+
headers=auth_headers(api_key),
|
|
160
|
+
timeout=DEFAULT_TIMEOUT,
|
|
161
|
+
)
|
|
162
|
+
|
|
163
|
+
uploaded_files = []
|
|
164
|
+
total = len(files)
|
|
165
|
+
for index, (relative, path) in enumerate(files, start=1):
|
|
166
|
+
print(f"[{index}/{total}] Uploading {relative}", file=sys.stderr)
|
|
167
|
+
result = upload_path(
|
|
168
|
+
session=session,
|
|
169
|
+
origin=origin,
|
|
170
|
+
path=path,
|
|
171
|
+
api_key=api_key,
|
|
172
|
+
upload_config=upload_config,
|
|
173
|
+
max_downloads=None,
|
|
174
|
+
expires_at=expires_at,
|
|
175
|
+
)
|
|
176
|
+
uploaded_files.append({"relativePath": relative, "fileId": result["id"]})
|
|
177
|
+
|
|
178
|
+
completed = api_json(
|
|
179
|
+
session,
|
|
180
|
+
"POST",
|
|
181
|
+
f"{origin}/api/site/complete",
|
|
182
|
+
json_body={
|
|
183
|
+
"siteId": prepared["siteId"],
|
|
184
|
+
"siteToken": prepared["siteToken"],
|
|
185
|
+
"files": uploaded_files,
|
|
186
|
+
},
|
|
187
|
+
timeout=DEFAULT_TIMEOUT,
|
|
188
|
+
)
|
|
189
|
+
|
|
190
|
+
print_site_result(completed)
|
|
191
|
+
return 0
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
def cmd_status(args: argparse.Namespace) -> int:
|
|
195
|
+
config = load_config()
|
|
196
|
+
origin = resolve_origin(args.origin, config)
|
|
197
|
+
status_url = f"{origin}/api/upload/status/{args.id}"
|
|
198
|
+
with requests.Session() as session:
|
|
199
|
+
response = request_or_error(session, "GET", status_url, timeout=DEFAULT_TIMEOUT)
|
|
200
|
+
if not is_json_response(response):
|
|
201
|
+
raise OkFileError(f"Upload not found or invalid ID: {args.id}")
|
|
202
|
+
result = decode_json_response(response)
|
|
203
|
+
print(json.dumps(result, indent=2, sort_keys=True))
|
|
204
|
+
return 0
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
def cmd_config(args: argparse.Namespace) -> int:
|
|
208
|
+
config = load_config()
|
|
209
|
+
changed = False
|
|
210
|
+
|
|
211
|
+
if args.clear_key:
|
|
212
|
+
config.pop("api_key", None)
|
|
213
|
+
changed = True
|
|
214
|
+
if args.key:
|
|
215
|
+
config["api_key"] = args.key.strip()
|
|
216
|
+
changed = True
|
|
217
|
+
if args.origin:
|
|
218
|
+
config["origin"] = normalize_origin(args.origin)
|
|
219
|
+
changed = True
|
|
220
|
+
|
|
221
|
+
if changed:
|
|
222
|
+
save_config(config)
|
|
223
|
+
|
|
224
|
+
print(f"Config file: {config_path()}")
|
|
225
|
+
print(json.dumps(config, indent=2, sort_keys=True))
|
|
226
|
+
return 0
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
def resolve_origin(cli_value: str | None, config: dict[str, Any]) -> str:
|
|
230
|
+
return normalize_origin(cli_value or config.get("origin") or DEFAULT_ORIGIN)
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
def resolve_api_key(cli_value: str | None, config: dict[str, Any]) -> str | None:
|
|
234
|
+
value = (cli_value or config.get("api_key") or "").strip()
|
|
235
|
+
return value or None
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
def normalize_origin(value: str) -> str:
|
|
239
|
+
normalized = str(value or "").strip().rstrip("/")
|
|
240
|
+
if not normalized:
|
|
241
|
+
raise OkFileError("Origin cannot be empty")
|
|
242
|
+
if "://" not in normalized:
|
|
243
|
+
normalized = "https://" + normalized
|
|
244
|
+
return normalized.rstrip("/")
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
def ensure_file(path: Path) -> Path:
|
|
248
|
+
resolved = Path(path).expanduser().resolve()
|
|
249
|
+
if not resolved.is_file():
|
|
250
|
+
raise OkFileError(f"File not found: {resolved}")
|
|
251
|
+
return resolved
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
def ensure_directory(path: Path) -> Path:
|
|
255
|
+
resolved = Path(path).expanduser().resolve()
|
|
256
|
+
if not resolved.is_dir():
|
|
257
|
+
raise OkFileError(f"Directory not found: {resolved}")
|
|
258
|
+
return resolved
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
def collect_site_files(root: Path) -> list[tuple[str, Path]]:
|
|
262
|
+
items: list[tuple[str, Path]] = []
|
|
263
|
+
for path in sorted(root.rglob("*")):
|
|
264
|
+
if path.is_file():
|
|
265
|
+
relative = path.relative_to(root).as_posix()
|
|
266
|
+
items.append((relative, path))
|
|
267
|
+
return items
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
def get_upload_config(session: requests.Session, origin: str) -> dict[str, Any]:
|
|
271
|
+
try:
|
|
272
|
+
data = api_json(session, "GET", f"{origin}/api/upload/config", timeout=DEFAULT_TIMEOUT)
|
|
273
|
+
except OkFileError:
|
|
274
|
+
data = {}
|
|
275
|
+
except requests.RequestException:
|
|
276
|
+
data = {}
|
|
277
|
+
return {
|
|
278
|
+
"quickUploadMaxSize": int(data.get("quickUploadMaxSize") or FALLBACK_QUICK_UPLOAD_MAX_SIZE),
|
|
279
|
+
"multipartThreshold": int(data.get("multipartThreshold") or FALLBACK_MULTIPART_THRESHOLD),
|
|
280
|
+
"partSize": int(data.get("partSize") or FALLBACK_PART_SIZE),
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
def upload_path(
|
|
285
|
+
session: requests.Session,
|
|
286
|
+
origin: str,
|
|
287
|
+
path: Path,
|
|
288
|
+
api_key: str | None,
|
|
289
|
+
upload_config: dict[str, Any],
|
|
290
|
+
max_downloads: int | None,
|
|
291
|
+
expires_at: str | None,
|
|
292
|
+
) -> dict[str, Any]:
|
|
293
|
+
size = path.stat().st_size
|
|
294
|
+
quick_limit = int(upload_config.get("quickUploadMaxSize") or FALLBACK_QUICK_UPLOAD_MAX_SIZE)
|
|
295
|
+
if size <= quick_limit:
|
|
296
|
+
return quick_upload(
|
|
297
|
+
session=session,
|
|
298
|
+
origin=origin,
|
|
299
|
+
path=path,
|
|
300
|
+
api_key=api_key,
|
|
301
|
+
max_downloads=max_downloads,
|
|
302
|
+
expires_at=expires_at,
|
|
303
|
+
)
|
|
304
|
+
return prepare_upload(
|
|
305
|
+
session=session,
|
|
306
|
+
origin=origin,
|
|
307
|
+
path=path,
|
|
308
|
+
api_key=api_key,
|
|
309
|
+
upload_config=upload_config,
|
|
310
|
+
max_downloads=max_downloads,
|
|
311
|
+
expires_at=expires_at,
|
|
312
|
+
)
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
def quick_upload(
|
|
316
|
+
session: requests.Session,
|
|
317
|
+
origin: str,
|
|
318
|
+
path: Path,
|
|
319
|
+
api_key: str | None,
|
|
320
|
+
max_downloads: int | None,
|
|
321
|
+
expires_at: str | None,
|
|
322
|
+
) -> dict[str, Any]:
|
|
323
|
+
fields = {}
|
|
324
|
+
if max_downloads is not None:
|
|
325
|
+
fields["maxDownloads"] = str(max_downloads)
|
|
326
|
+
if expires_at:
|
|
327
|
+
fields["expiresAt"] = expires_at
|
|
328
|
+
|
|
329
|
+
mime = guess_content_type(path)
|
|
330
|
+
with path.open("rb") as handle:
|
|
331
|
+
response = request_or_error(
|
|
332
|
+
session,
|
|
333
|
+
"POST",
|
|
334
|
+
f"{origin}/api/upload/quick",
|
|
335
|
+
headers=auth_headers(api_key),
|
|
336
|
+
data=fields,
|
|
337
|
+
files={"file": (path.name, handle, mime)},
|
|
338
|
+
timeout=UPLOAD_TIMEOUT,
|
|
339
|
+
)
|
|
340
|
+
return decode_json_response(response)
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
def prepare_upload(
|
|
344
|
+
session: requests.Session,
|
|
345
|
+
origin: str,
|
|
346
|
+
path: Path,
|
|
347
|
+
api_key: str | None,
|
|
348
|
+
upload_config: dict[str, Any],
|
|
349
|
+
max_downloads: int | None,
|
|
350
|
+
expires_at: str | None,
|
|
351
|
+
) -> dict[str, Any]:
|
|
352
|
+
prepare_body: dict[str, Any] = {
|
|
353
|
+
"filename": path.name,
|
|
354
|
+
"size": path.stat().st_size,
|
|
355
|
+
"contentType": guess_content_type(path),
|
|
356
|
+
}
|
|
357
|
+
if api_key:
|
|
358
|
+
prepare_body["apiKey"] = api_key
|
|
359
|
+
if max_downloads is not None:
|
|
360
|
+
prepare_body["maxDownloads"] = max_downloads
|
|
361
|
+
if expires_at:
|
|
362
|
+
prepare_body["expiresAt"] = expires_at
|
|
363
|
+
|
|
364
|
+
prepared = api_json(
|
|
365
|
+
session,
|
|
366
|
+
"POST",
|
|
367
|
+
f"{origin}/api/upload/prepare",
|
|
368
|
+
json_body=prepare_body,
|
|
369
|
+
headers=auth_headers(api_key),
|
|
370
|
+
timeout=DEFAULT_TIMEOUT,
|
|
371
|
+
)
|
|
372
|
+
|
|
373
|
+
if prepared.get("mode") == "multipart":
|
|
374
|
+
parts = upload_multipart_file(session, path, prepared)
|
|
375
|
+
completed = complete_upload(session, origin, prepared["id"], None, parts)
|
|
376
|
+
retries = 0
|
|
377
|
+
while completed.get("missingParts") and retries < 3:
|
|
378
|
+
retries += 1
|
|
379
|
+
parts = upload_multipart_file(session, path, prepared, missing_parts=set(completed["missingParts"]), existing_parts=parts)
|
|
380
|
+
completed = complete_upload(session, origin, prepared["id"], None, parts)
|
|
381
|
+
if not completed.get("success"):
|
|
382
|
+
raise OkFileError(str(completed.get("error") or "Upload complete failed"))
|
|
383
|
+
return completed
|
|
384
|
+
|
|
385
|
+
upload_etag = upload_single_file(session, path, prepared["uploadUrl"])
|
|
386
|
+
completed = complete_upload(session, origin, prepared["id"], upload_etag, None)
|
|
387
|
+
if not completed.get("success"):
|
|
388
|
+
raise OkFileError(str(completed.get("error") or "Upload complete failed"))
|
|
389
|
+
return completed
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
def upload_single_file(session: requests.Session, path: Path, upload_url: str) -> str:
|
|
393
|
+
size = path.stat().st_size
|
|
394
|
+
headers = {
|
|
395
|
+
"Content-Type": guess_content_type(path),
|
|
396
|
+
"Content-Length": str(size),
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
print(f"Uploading {path.name} ({size} bytes)", file=sys.stderr)
|
|
400
|
+
with path.open("rb") as handle:
|
|
401
|
+
body = handle.read()
|
|
402
|
+
response = request_or_error(
|
|
403
|
+
session,
|
|
404
|
+
"PUT",
|
|
405
|
+
upload_url,
|
|
406
|
+
data=body,
|
|
407
|
+
headers=headers,
|
|
408
|
+
timeout=UPLOAD_TIMEOUT,
|
|
409
|
+
)
|
|
410
|
+
|
|
411
|
+
if not response.ok:
|
|
412
|
+
raise OkFileError(f"Signed upload failed with HTTP {response.status_code}: {response.text}")
|
|
413
|
+
|
|
414
|
+
print_progress(size, size)
|
|
415
|
+
print("", file=sys.stderr)
|
|
416
|
+
return normalize_etag(response.headers.get("ETag", ""))
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
def upload_multipart_file(
|
|
420
|
+
session: requests.Session,
|
|
421
|
+
path: Path,
|
|
422
|
+
prepared: dict[str, Any],
|
|
423
|
+
missing_parts: set[int] | None = None,
|
|
424
|
+
existing_parts: list[dict[str, Any]] | None = None,
|
|
425
|
+
) -> list[dict[str, Any]]:
|
|
426
|
+
part_size = int(prepared["partSize"])
|
|
427
|
+
uploaded_by_number = {int(item["partNumber"]): item for item in (existing_parts or [])}
|
|
428
|
+
|
|
429
|
+
with path.open("rb") as handle:
|
|
430
|
+
for part in prepared.get("parts", []):
|
|
431
|
+
part_number = int(part["partNumber"])
|
|
432
|
+
if missing_parts is not None and part_number not in missing_parts:
|
|
433
|
+
continue
|
|
434
|
+
start = (part_number - 1) * part_size
|
|
435
|
+
handle.seek(start)
|
|
436
|
+
chunk = handle.read(part_size)
|
|
437
|
+
headers = {
|
|
438
|
+
"Content-Length": str(len(chunk)),
|
|
439
|
+
"Content-Type": "application/octet-stream",
|
|
440
|
+
}
|
|
441
|
+
response = request_or_error(
|
|
442
|
+
session,
|
|
443
|
+
"PUT",
|
|
444
|
+
part["uploadUrl"],
|
|
445
|
+
data=chunk,
|
|
446
|
+
headers=headers,
|
|
447
|
+
timeout=UPLOAD_TIMEOUT,
|
|
448
|
+
)
|
|
449
|
+
if not response.ok:
|
|
450
|
+
raise OkFileError(
|
|
451
|
+
f"Multipart upload failed at part {part_number} with HTTP {response.status_code}: {response.text}"
|
|
452
|
+
)
|
|
453
|
+
uploaded_by_number[part_number] = {
|
|
454
|
+
"partNumber": part_number,
|
|
455
|
+
"etag": normalize_etag(response.headers.get("ETag", "")),
|
|
456
|
+
}
|
|
457
|
+
print(f"Uploaded part {part_number}/{prepared['totalParts']} for {path.name}", file=sys.stderr)
|
|
458
|
+
|
|
459
|
+
return [uploaded_by_number[index] for index in sorted(uploaded_by_number)]
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
def complete_upload(
|
|
463
|
+
session: requests.Session,
|
|
464
|
+
origin: str,
|
|
465
|
+
file_id: str,
|
|
466
|
+
etag: str | None,
|
|
467
|
+
parts: list[dict[str, Any]] | None,
|
|
468
|
+
) -> dict[str, Any]:
|
|
469
|
+
body: dict[str, Any] = {"id": file_id}
|
|
470
|
+
if etag:
|
|
471
|
+
body["etag"] = etag
|
|
472
|
+
if parts:
|
|
473
|
+
body["parts"] = parts
|
|
474
|
+
|
|
475
|
+
response = request_or_error(
|
|
476
|
+
session,
|
|
477
|
+
"POST",
|
|
478
|
+
f"{origin}/api/upload/complete",
|
|
479
|
+
headers={"Content-Type": "application/json"},
|
|
480
|
+
json=body,
|
|
481
|
+
timeout=DEFAULT_TIMEOUT,
|
|
482
|
+
)
|
|
483
|
+
return decode_json_response(response, allow_error_json=True)
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
def api_json(
|
|
487
|
+
session: requests.Session,
|
|
488
|
+
method: str,
|
|
489
|
+
url: str,
|
|
490
|
+
*,
|
|
491
|
+
json_body: dict[str, Any] | None = None,
|
|
492
|
+
headers: dict[str, str] | None = None,
|
|
493
|
+
timeout: int = DEFAULT_TIMEOUT,
|
|
494
|
+
) -> dict[str, Any]:
|
|
495
|
+
merged_headers = dict(headers or {})
|
|
496
|
+
if json_body is not None:
|
|
497
|
+
merged_headers.setdefault("Content-Type", "application/json")
|
|
498
|
+
response = request_or_error(session, method, url, json=json_body, headers=merged_headers, timeout=timeout)
|
|
499
|
+
return decode_json_response(response)
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
def request_or_error(session: requests.Session, method: str, url: str, **kwargs: Any) -> requests.Response:
|
|
503
|
+
try:
|
|
504
|
+
return session.request(method, url, **kwargs)
|
|
505
|
+
except requests.ConnectionError as exc:
|
|
506
|
+
raise OkFileError(f"Could not connect to {url}. Check --origin and your network connection.") from exc
|
|
507
|
+
except requests.Timeout as exc:
|
|
508
|
+
raise OkFileError(f"Request timed out for {method.upper()} {url}") from exc
|
|
509
|
+
except requests.RequestException as exc:
|
|
510
|
+
raise OkFileError(f"Request failed for {method.upper()} {url}: {exc}") from exc
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
def is_json_response(response: requests.Response) -> bool:
|
|
514
|
+
content_type = response.headers.get("Content-Type", "").lower()
|
|
515
|
+
return "application/json" in content_type or content_type.endswith("+json")
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
def decode_json_response(response: requests.Response, allow_error_json: bool = False) -> dict[str, Any]:
|
|
519
|
+
try:
|
|
520
|
+
data = response.json()
|
|
521
|
+
except ValueError as exc:
|
|
522
|
+
content_type = response.headers.get("Content-Type", "").strip() or "unknown"
|
|
523
|
+
body_preview = response.text.strip().replace("\r", " ").replace("\n", " ")
|
|
524
|
+
body_preview = body_preview[:160] + ("..." if len(body_preview) > 160 else "")
|
|
525
|
+
if response.status_code == 404:
|
|
526
|
+
raise OkFileError(
|
|
527
|
+
f"Server returned HTTP 404 from {response.url}. The endpoint may be missing or the resource does not exist."
|
|
528
|
+
) from exc
|
|
529
|
+
raise OkFileError(
|
|
530
|
+
f"Server returned HTTP {response.status_code} with non-JSON content ({content_type}) from {response.url}. "
|
|
531
|
+
f"Body preview: {body_preview or '<empty>'}"
|
|
532
|
+
) from exc
|
|
533
|
+
|
|
534
|
+
if not response.ok and not allow_error_json:
|
|
535
|
+
message = data.get("error") if isinstance(data, dict) else None
|
|
536
|
+
raise OkFileError(str(message or f"HTTP {response.status_code}"))
|
|
537
|
+
if not response.ok and allow_error_json:
|
|
538
|
+
return data
|
|
539
|
+
if not isinstance(data, dict):
|
|
540
|
+
raise OkFileError("Server returned JSON that is not an object")
|
|
541
|
+
return data
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
def print_upload_result(result: dict[str, Any]) -> None:
|
|
545
|
+
print("Upload complete")
|
|
546
|
+
print(f"ID: {result.get('id', '-')}")
|
|
547
|
+
print(f"URL: {result.get('url', '-')}")
|
|
548
|
+
print(f"Download URL: {result.get('downloadUrl', '-')}")
|
|
549
|
+
print(f"Preview URL: {result.get('playUrl', '-')}")
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
def print_site_result(result: dict[str, Any]) -> None:
|
|
553
|
+
print("Site publish complete")
|
|
554
|
+
print(f"Site ID: {result.get('siteId', '-')}")
|
|
555
|
+
print(f"Site URL: {result.get('siteUrl', '-')}")
|
|
556
|
+
print(f"Entry URL: {result.get('entryUrl', '-')}")
|
|
557
|
+
print(f"Hostname: {result.get('siteHostname', '-')}")
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
def auth_headers(api_key: str | None) -> dict[str, str]:
|
|
561
|
+
return {"X-API-Key": api_key} if api_key else {}
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
def validate_max_downloads(value: int | None) -> int | None:
|
|
565
|
+
if value is None:
|
|
566
|
+
return None
|
|
567
|
+
if value <= 0:
|
|
568
|
+
raise OkFileError("--max-downloads must be greater than 0")
|
|
569
|
+
return value
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
def validate_expires_at(value: str | None) -> str | None:
|
|
573
|
+
if value is None:
|
|
574
|
+
return None
|
|
575
|
+
normalized = value.strip()
|
|
576
|
+
if not normalized:
|
|
577
|
+
return None
|
|
578
|
+
probe = normalized.replace("Z", "+00:00")
|
|
579
|
+
try:
|
|
580
|
+
dt.datetime.fromisoformat(probe)
|
|
581
|
+
except ValueError as exc:
|
|
582
|
+
raise OkFileError("--expires-at must be a valid ISO 8601 timestamp") from exc
|
|
583
|
+
return normalized
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
def guess_content_type(path: Path) -> str:
|
|
587
|
+
guessed, _ = mimetypes.guess_type(path.name)
|
|
588
|
+
return guessed or "application/octet-stream"
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
def normalize_etag(value: str) -> str:
|
|
592
|
+
return str(value or "").strip().removeprefix("W/").strip('"')
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
def iter_file(handle, total_size: int, chunk_size: int = 1024 * 1024):
|
|
596
|
+
sent = 0
|
|
597
|
+
while True:
|
|
598
|
+
chunk = handle.read(chunk_size)
|
|
599
|
+
if not chunk:
|
|
600
|
+
break
|
|
601
|
+
sent += len(chunk)
|
|
602
|
+
print_progress(sent, total_size)
|
|
603
|
+
yield chunk
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
def print_progress(done: int, total: int) -> None:
|
|
607
|
+
total = max(total, 1)
|
|
608
|
+
ratio = min(max(done / total, 0.0), 1.0)
|
|
609
|
+
percent = int(ratio * 100)
|
|
610
|
+
print(f"\rProgress: {percent:3d}% ({done}/{total} bytes)", end="", file=sys.stderr, flush=True)
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
def config_path() -> Path:
|
|
614
|
+
if os.name == "nt":
|
|
615
|
+
base = Path(os.environ.get("APPDATA", Path.home() / "AppData" / "Roaming"))
|
|
616
|
+
else:
|
|
617
|
+
base = Path(os.environ.get("XDG_CONFIG_HOME", Path.home() / ".config"))
|
|
618
|
+
return base / "okfile" / "config.json"
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
def load_config() -> dict[str, Any]:
|
|
622
|
+
path = config_path()
|
|
623
|
+
if not path.is_file():
|
|
624
|
+
return {}
|
|
625
|
+
try:
|
|
626
|
+
return json.loads(path.read_text(encoding="utf-8"))
|
|
627
|
+
except Exception as exc:
|
|
628
|
+
raise OkFileError(f"Failed to read config file {path}: {exc}") from exc
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
def save_config(config: dict[str, Any]) -> None:
|
|
632
|
+
path = config_path()
|
|
633
|
+
path.parent.mkdir(parents=True, exist_ok=True)
|
|
634
|
+
path.write_text(json.dumps(config, indent=2, sort_keys=True) + "\n", encoding="utf-8")
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
if __name__ == "__main__":
|
|
638
|
+
raise SystemExit(main())
|