1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
|
# ##### BEGIN GPL LICENSE BLOCK #####
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# ##### END GPL LICENSE BLOCK #####
bl_info = {
"name": "Sketchfab Exporter",
"author": "Bart Crouch",
"version": (1, 2, 2),
"blender": (2, 7, 0),
"location": "Tools > File I/O tab",
"description": "Upload your model to Sketchfab",
"warning": "",
"wiki_url": "",
"category": "Import-Export"
}
import bpy
import os
import tempfile
import threading
import subprocess
from bpy.app.handlers import persistent
from bpy.props import (
StringProperty,
EnumProperty,
BoolProperty,
PointerProperty,
)
SKETCHFAB_API_URL = "https://api.sketchfab.com"
SKETCHFAB_API_MODELS_URL = SKETCHFAB_API_URL + "/v1/models"
SKETCHFAB_API_TOKEN_URL = SKETCHFAB_API_URL + "/v1/users/claim-token"
SKETCHFAB_MODEL_URL = "https://sketchfab.com/show/"
SKETCHFAB_EXPORT_FILENAME = "sketchfab-export.blend"
_presets = os.path.join(bpy.utils.user_resource('SCRIPTS'), "presets")
SKETCHFAB_PRESET_FILENAME = os.path.join(_presets, "sketchfab.txt")
SKETCHFAB_EXPORT_DATA_FILE = os.path.join(_presets, "sketchfab-export-data.json")
del _presets
# Singleton for storing global state
class _SketchfabState:
__slots__ = (
"uploading",
"token_reload",
"size_label",
"model_url",
# store report args
"report_message",
"report_type",
)
def __init__(self):
self.uploading = False
self.token_reload = True
self.size_label = ""
self.model_url = ""
self.report_message = ""
self.report_type = ''
sf_state = _SketchfabState()
del _SketchfabState
# if True, no contact is made with the webserver
DEBUG_MODE = False
# change a bytes int into a properly formatted string
def format_size(size):
size /= 1024
size_suffix = "kB"
if size > 1024:
size /= 1024
size_suffix = "mB"
if size >= 100:
size = "%d" % int(size)
else:
size = "%.1f" % size
size += " " + size_suffix
return size
# attempt to load token from presets
@persistent
def load_token(dummy=False):
filepath = SKETCHFAB_PRESET_FILENAME
if not os.path.exists(filepath):
return
token = ""
try:
with open(filepath, 'r', encoding='utf-8') as f:
token = f.readline()
except:
import traceback
traceback.print_exc()
wm = bpy.context.window_manager
wm.sketchfab.token = token
# save token to file
def update_token(self, context):
token = context.window_manager.sketchfab.token
filepath = SKETCHFAB_PRESET_FILENAME
path = os.path.dirname(filepath)
if not os.path.exists(path):
os.makedirs(path)
with open(filepath, 'w', encoding='utf-8') as f:
f.write(token)
def upload_report(report_message, report_type):
sf_state.report_message = report_message
sf_state.report_type = report_type
# upload the blend-file to sketchfab
def upload(filepath, filename):
import requests
wm = bpy.context.window_manager
props = wm.sketchfab
title = props.title
if not title:
title = os.path.splitext(os.path.basename(bpy.data.filepath))[0]
data = {
"title": title,
"description": props.description,
"filename": filename,
"tags": props.tags,
"private": props.private,
"token": props.token,
"source": "blender-exporter",
}
if props.private and props.password != "":
data["password"] = props.password
files = {
"fileModel": open(filepath, 'rb'),
}
try:
r = requests.post(SKETCHFAB_API_MODELS_URL, data=data, files=files, verify=False)
except requests.exceptions.RequestException as e:
return upload_report("Upload failed. Error: %s" % str(e), 'WARNING')
result = r.json()
if r.status_code != requests.codes.ok:
return upload_report("Upload failed. Error: %s" % result["error"], 'WARNING')
sf_state.model_url = SKETCHFAB_MODEL_URL + result["result"]["id"]
return upload_report("Upload complete. Available on your sketchfab.com dashboard.", 'INFO')
# operator to export model to sketchfab
class ExportSketchfab(bpy.types.Operator):
"""Upload your model to Sketchfab"""
bl_idname = "export.sketchfab"
bl_label = "Upload"
_timer = None
_thread = None
def modal(self, context, event):
if event.type == 'TIMER':
if not self._thread.is_alive():
wm = context.window_manager
props = wm.sketchfab
terminate(props.filepath)
if context.area:
context.area.tag_redraw()
# forward message from upload thread
if not sf_state.report_type:
sf_state.report_type = 'ERROR'
self.report({sf_state.report_type}, sf_state.report_message)
wm.event_timer_remove(self._timer)
self._thread.join()
sf_state.uploading = False
return {'FINISHED'}
return {'PASS_THROUGH'}
def execute(self, context):
import json
if sf_state.uploading:
self.report({'WARNING'}, "Please wait till current upload is finished")
return {'CANCELLED'}
wm = context.window_manager
sf_state.model_url = ""
props = wm.sketchfab
if not props.token:
self.report({'ERROR'}, "Token is missing")
return {'CANCELLED'}
# Prepare to save the file
binary_path = bpy.app.binary_path
script_path = os.path.dirname(os.path.realpath(__file__))
basename, ext = os.path.splitext(bpy.data.filepath)
if not basename:
basename = os.path.join(basename, "temp")
if not ext:
ext = ".blend"
tempdir = tempfile.mkdtemp()
filepath = os.path.join(tempdir, "export-sketchfab" + ext)
try:
# save a copy of actual scene but don't interfere with the users models
bpy.ops.wm.save_as_mainfile(filepath=filepath, compress=True, copy=True)
with open(SKETCHFAB_EXPORT_DATA_FILE, 'w') as s:
json.dump({
"models": props.models,
"lamps": props.lamps,
}, s)
subprocess.check_call([
binary_path,
"--background",
"-noaudio",
filepath,
"--python", os.path.join(script_path, "pack_for_export.py"),
"--", tempdir
])
os.remove(filepath)
# read subprocess call results
with open(SKETCHFAB_EXPORT_DATA_FILE, 'r') as s:
r = json.load(s)
size = r["size"]
props.filepath = r["filepath"]
filename = r["filename"]
except Exception as e:
self.report({'WARNING'}, "Error occured while preparing your file: %s" % str(e))
return {'FINISHED'}
sf_state.uploading = True
sf_state.size_label = format_size(size)
self._thread = threading.Thread(
target=upload,
args=(props.filepath, filename),
)
self._thread.start()
wm.modal_handler_add(self)
self._timer = wm.event_timer_add(1.0, context.window)
return {'RUNNING_MODAL'}
def cancel(self, context):
wm = context.window_manager
wm.event_timer_remove(self._timer)
self._thread.join()
# user interface
class VIEW3D_PT_sketchfab(bpy.types.Panel):
bl_space_type = 'VIEW_3D'
bl_region_type = 'TOOLS'
bl_category = "File I/O"
bl_context = "objectmode"
bl_label = "Sketchfab"
def draw(self, context):
wm = context.window_manager
props = wm.sketchfab
if sf_state.token_reload:
sf_state.token_reload = False
if not props.token:
load_token()
layout = self.layout
layout.label("Export:")
col = layout.box().column(align=True)
col.prop(props, "models")
col.prop(props, "lamps")
layout.label("Model info:")
col = layout.box().column(align=True)
col.prop(props, "title")
col.prop(props, "description")
col.prop(props, "tags")
col.prop(props, "private")
if props.private:
col.prop(props, "password")
layout.label("Sketchfab account:")
col = layout.box().column(align=True)
col.prop(props, "token")
row = col.row()
row.operator("wm.sketchfab_email_token", text="Claim Your Token")
row.alignment = 'RIGHT'
if sf_state.uploading:
layout.operator("export.sketchfab", text="Uploading %s" % sf_state.size_label)
else:
layout.operator("export.sketchfab")
model_url = sf_state.model_url
if model_url:
layout.operator("wm.url_open", text="View Online Model", icon='URL').url = model_url
# property group containing all properties for the user interface
class SketchfabProps(bpy.types.PropertyGroup):
description = StringProperty(
name="Description",
description="Description of the model (optional)",
default="")
filepath = StringProperty(
name="Filepath",
description="internal use",
default="",
)
lamps = EnumProperty(
name="Lamps",
items=(('ALL', "All", "Export all lamps in the file"),
('NONE', "None", "Don't export any lamps"),
('SELECTION', "Selection", "Only export selected lamps")),
description="Determines which lamps are exported",
default='ALL',
)
models = EnumProperty(
name="Models",
items=(('ALL', "All", "Export all meshes in the file"),
('SELECTION', "Selection", "Only export selected meshes")),
description="Determines which meshes are exported",
default='SELECTION',
)
private = BoolProperty(
name="Private",
description="Upload as private (requires a pro account)",
default=False,
)
password = StringProperty(
name="Password",
description="Password-protect your model (requires a pro account)",
default="",
subtype="PASSWORD"
)
tags = StringProperty(
name="Tags",
description="List of tags, separated by spaces (optional)",
default="",
)
title = StringProperty(
name="Title",
description="Title of the model (determined automatically if left empty)",
default="",
)
token = StringProperty(
name="Api Key",
description="You can find this on your dashboard at the Sketchfab website",
default="",
update=update_token,
subtype="PASSWORD"
)
class SketchfabEmailToken(bpy.types.Operator):
bl_idname = "wm.sketchfab_email_token"
bl_label = "Enter your email to get a sketchfab token"
email = StringProperty(
name="Email",
default="you@example.com",
)
def execute(self, context):
import re
import requests
EMAIL_RE = re.compile(r'[^@]+@[^@]+\.[^@]+')
if not EMAIL_RE.match(self.email):
self.report({'ERROR'}, "Wrong email format")
try:
r = requests.get(SKETCHFAB_API_TOKEN_URL + "?source=blender-exporter&email=" + self.email, verify=False)
except requests.exceptions.RequestException as e:
self.report({'ERROR'}, str(e))
return {'FINISHED'}
if r.status_code != requests.codes.ok:
self.report({'ERROR'}, "An error occured. Check the format of your email")
else:
self.report({'INFO'}, "Your email was sent at your email address")
return {'FINISHED'}
def invoke(self, context, event):
wm = context.window_manager
return wm.invoke_props_dialog(self, width=550)
# remove file copy
def terminate(filepath):
os.remove(filepath)
os.rmdir(os.path.dirname(filepath))
## Addons Preferences Update Panel
def update_panel(self, context):
try:
bpy.utils.unregister_class(VIEW3D_PT_sketchfab)
except:
pass
VIEW3D_PT_sketchfab.bl_category = context.user_preferences.addons[__name__].preferences.category
bpy.utils.register_class(VIEW3D_PT_sketchfab)
class SfabAddonPreferences(bpy.types.AddonPreferences):
# this must match the addon name, use '__package__'
# when defining this in a submodule of a python package.
bl_idname = __name__
category = bpy.props.StringProperty(
name="Tab Category",
description="Choose a name for the category of the panel",
default="File I/O",
update=update_panel)
def draw(self, context):
layout = self.layout
row = layout.row()
col = row.column()
col.label(text="Tab Category:")
col.prop(self, "category", text="")
# registration
classes = (
ExportSketchfab,
SketchfabProps,
SketchfabEmailToken,
VIEW3D_PT_sketchfab,
SfabAddonPreferences,
)
def register():
for cls in classes:
bpy.utils.register_class(cls)
bpy.types.WindowManager.sketchfab = PointerProperty(
type=SketchfabProps)
load_token()
bpy.app.handlers.load_post.append(load_token)
update_panel(None, bpy.context)
def unregister():
for cls in classes:
bpy.utils.unregister_class(cls)
del bpy.types.WindowManager.sketchfab
if __name__ == "__main__":
register()
|