-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathaddon_updater_ops.py
1519 lines (1277 loc) · 57.7 KB
/
addon_updater_ops.py
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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# ##### 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 #####
"""Blender UI integrations for the addon updater.
Implements draw calls, popups, and operators that use the addon_updater.
"""
import os
import bpy
from bpy.app.handlers import persistent
# updater import, import safely
# Prevents popups for users with invalid python installs e.g. missing libraries
try:
from .addon_updater import Updater as updater
except Exception as e:
print("ERROR INITIALIZING UPDATER")
print(str(e))
class Singleton_updater_none(object):
def __init__(self):
self.addon = None
self.verbose = False
self.invalidupdater = True # used to distinguish bad install
self.error = None
self.error_msg = None
self.async_checking = None
def clear_state(self):
self.addon = None
self.verbose = False
self.invalidupdater = True
self.error = None
self.error_msg = None
self.async_checking = None
def run_update(self): pass
def check_for_update(self): pass
updater = Singleton_updater_none()
updater.error = "Error initializing updater module"
updater.error_msg = str(e)
# Must declare this before classes are loaded
# otherwise the bl_idname's will not match and have errors.
# Must be all lowercase and no spaces
updater.addon = "super_project_manager"
# -----------------------------------------------------------------------------
# Blender version utils
# -----------------------------------------------------------------------------
def make_annotations(cls):
"""Add annotation attribute to class fields to avoid Blender 2.8 warnings"""
if not hasattr(bpy.app, "version") or bpy.app.version < (2, 80):
return cls
bl_props = {k: v for k, v in cls.__dict__.items() if isinstance(v, tuple)}
if bl_props:
if '__annotations__' not in cls.__dict__:
setattr(cls, '__annotations__', {})
annotations = cls.__dict__['__annotations__']
for k, v in bl_props.items():
annotations[k] = v
delattr(cls, k)
return cls
def layout_split(layout, factor=0.0, align=False):
"""Intermediate method for pre and post blender 2.8 split UI function"""
if not hasattr(bpy.app, "version") or bpy.app.version < (2, 80):
return layout.split(percentage=factor, align=align)
return layout.split(factor=factor, align=align)
def get_user_preferences(context=None):
"""Intermediate method for pre and post blender 2.8 grabbing preferences"""
if not context:
context = bpy.context
prefs = None
if hasattr(context, "user_preferences"):
prefs = context.user_preferences.addons.get(__package__, None)
elif hasattr(context, "preferences"):
prefs = context.preferences.addons.get(__package__, None)
if prefs:
return prefs.preferences
# To make the addon stable and non-exception prone, return None
# raise Exception("Could not fetch user preferences")
return None
# -----------------------------------------------------------------------------
# Updater operators
# -----------------------------------------------------------------------------
# simple popup for prompting checking for update & allow to install if available
class addon_updater_install_popup(bpy.types.Operator):
"""Check and install update if available"""
bl_label = "Update {x} addon".format(x=updater.addon)
bl_idname = updater.addon+".updater_install_popup"
bl_description = "Popup menu to check and display current updates available"
bl_options = {'REGISTER', 'INTERNAL'}
# if true, run clean install - ie remove all files before adding new
# equivalent to deleting the addon and reinstalling, except the
# updater folder/backup folder remains
clean_install = bpy.props.BoolProperty(
name="Clean install",
description="If enabled, completely clear the addon's folder before installing new update, creating a fresh install",
default=False,
options={'HIDDEN'}
)
ignore_enum: bpy.props.EnumProperty(
name="Process update",
description="Decide to install, ignore, or defer new addon update",
items=[
("install", "Update Now", "Install update now"),
("ignore", "Ignore", "Ignore this update to prevent future popups"),
("defer", "Defer", "Defer choice till next blender session")
],
options={'HIDDEN'}
)
def check(self, context):
return True
def invoke(self, context, event):
return context.window_manager.invoke_props_dialog(self)
def draw(self, context):
layout = self.layout
if updater.invalidupdater == True:
layout.label(text="Updater module error")
return
elif updater.update_ready == True:
col = layout.column()
col.scale_y = 0.7
col.label(text="Update {} ready!".format(str(updater.update_version)),
icon="LOOP_FORWARDS")
col.label(
text="Choose 'Update Now' & press OK to install, ", icon="BLANK1")
col.label(text="or click outside window to defer", icon="BLANK1")
row = col.row()
row.prop(self, "ignore_enum", expand=True)
col.split()
elif updater.update_ready == False:
col = layout.column()
col.scale_y = 0.7
col.label(text="No updates available")
col.label(text="Press okay to dismiss dialog")
# add option to force install
else:
# case: updater.update_ready = None
# we have not yet checked for the update
layout.label(text="Check for update now?")
# potentially in future, could have UI for 'check to select old version'
# to revert back to.
def execute(self, context):
# in case of error importing updater
if updater.invalidupdater == True:
return {'CANCELLED'}
if updater.manual_only == True:
bpy.ops.wm.url_open(url=updater.website)
elif updater.update_ready == True:
# action based on enum selection
if self.ignore_enum == 'defer':
return {'FINISHED'}
elif self.ignore_enum == 'ignore':
updater.ignore_update()
return {'FINISHED'}
# else: "install update now!"
res = updater.run_update(
force=False,
callback=post_update_callback,
clean=self.clean_install)
# should return 0, if not something happened
if updater.verbose:
if res == 0:
print("Updater returned successful")
else:
print("Updater returned {}, error occurred".format(res))
elif updater.update_ready == None:
_ = updater.check_for_update(now=True)
# re-launch this dialog
atr = addon_updater_install_popup.bl_idname.split(".")
getattr(getattr(bpy.ops, atr[0]), atr[1])('INVOKE_DEFAULT')
else:
if updater.verbose:
print("Doing nothing, not ready for update")
return {'FINISHED'}
# User preference check-now operator
class addon_updater_check_now(bpy.types.Operator):
bl_label = "Check now for "+updater.addon+" update"
bl_idname = updater.addon+".updater_check_now"
bl_description = "Check now for an update to the {x} addon".format(
x=updater.addon)
bl_options = {'REGISTER', 'INTERNAL'}
def execute(self, context):
if updater.invalidupdater == True:
return {'CANCELLED'}
if updater.async_checking == True and updater.error == None:
# Check already happened
# Used here to just avoid constant applying settings below
# Ignoring if error, to prevent being stuck on the error screen
return {'CANCELLED'}
# apply the UI settings
settings = get_user_preferences(context)
if not settings:
if updater.verbose:
print("Could not get {} preferences, update check skipped".format(
__package__))
return {'CANCELLED'}
updater.set_check_interval(enable=settings.auto_check_update,
months=settings.updater_intrval_months,
days=settings.updater_intrval_days,
hours=settings.updater_intrval_hours,
minutes=settings.updater_intrval_minutes
) # optional, if auto_check_update
# input is an optional callback function
# this function should take a bool input, if true: update ready
# if false, no update ready
updater.check_for_update_now(ui_refresh)
return {'FINISHED'}
class addon_updater_update_now(bpy.types.Operator):
bl_label = "Update "+updater.addon+" addon now"
bl_idname = updater.addon+".updater_update_now"
bl_description = "Update to the latest version of the {x} addon".format(
x=updater.addon)
bl_options = {'REGISTER', 'INTERNAL'}
# if true, run clean install - ie remove all files before adding new
# equivalent to deleting the addon and reinstalling, except the
# updater folder/backup folder remains
clean_install = bpy.props.BoolProperty(
name="Clean install",
description="If enabled, completely clear the addon's folder before installing new update, creating a fresh install",
default=False,
options={'HIDDEN'}
)
def execute(self, context):
# in case of error importing updater
if updater.invalidupdater == True:
return {'CANCELLED'}
if updater.manual_only == True:
bpy.ops.wm.url_open(url=updater.website)
if updater.update_ready == True:
# if it fails, offer to open the website instead
try:
res = updater.run_update(
force=False,
callback=post_update_callback,
clean=self.clean_install)
# should return 0, if not something happened
if updater.verbose:
if res == 0:
print("Updater returned successful")
else:
print("Updater returned "+str(res)+", error occurred")
except Exception as e:
updater._error = "Error trying to run update"
updater._error_msg = str(e)
atr = addon_updater_install_manually.bl_idname.split(".")
getattr(getattr(bpy.ops, atr[0]), atr[1])('INVOKE_DEFAULT')
elif updater.update_ready == None:
(update_ready, version, link) = updater.check_for_update(now=True)
# re-launch this dialog
atr = addon_updater_install_popup.bl_idname.split(".")
getattr(getattr(bpy.ops, atr[0]), atr[1])('INVOKE_DEFAULT')
elif updater.update_ready == False:
self.report({'INFO'}, "Nothing to update")
return {'CANCELLED'}
else:
self.report(
{'ERROR'}, "Encountered problem while trying to update")
return {'CANCELLED'}
return {'FINISHED'}
class addon_updater_update_target(bpy.types.Operator):
bl_label = updater.addon+" version target"
bl_idname = updater.addon+".updater_update_target"
bl_description = "Install a targeted version of the {x} addon".format(
x=updater.addon)
bl_options = {'REGISTER', 'INTERNAL'}
def target_version(self, context):
# in case of error importing updater
if updater.invalidupdater == True:
ret = []
ret = []
i = 0
for tag in updater.tags:
ret.append((tag, tag, "Select to install "+tag))
i += 1
return ret
target: bpy.props.EnumProperty(
name="Target version to install",
description="Select the version to install",
items=target_version
)
# if true, run clean install - ie remove all files before adding new
# equivalent to deleting the addon and reinstalling, except the
# updater folder/backup folder remains
clean_install = bpy.props.BoolProperty(
name="Clean install",
description="If enabled, completely clear the addon's folder before installing new update, creating a fresh install",
default=False,
options={'HIDDEN'}
)
@classmethod
def poll(cls, context):
if updater.invalidupdater == True:
return False
return updater.update_ready != None and len(updater.tags) > 0
def invoke(self, context, event):
return context.window_manager.invoke_props_dialog(self)
def draw(self, context):
layout = self.layout
if updater.invalidupdater == True:
layout.label(text="Updater error")
return
split = layout_split(layout, factor=0.66)
subcol = split.column()
subcol.label(text="Select install version")
subcol = split.column()
subcol.prop(self, "target", text="")
def execute(self, context):
# in case of error importing updater
if updater.invalidupdater == True:
return {'CANCELLED'}
res = updater.run_update(
force=False,
revert_tag=self.target,
callback=post_update_callback,
clean=self.clean_install)
# should return 0, if not something happened
if res == 0:
if updater.verbose:
print("Updater returned successful")
else:
if updater.verbose:
print("Updater returned "+str(res)+", error occurred")
return {'CANCELLED'}
return {'FINISHED'}
class addon_updater_install_manually(bpy.types.Operator):
"""As a fallback, direct the user to download the addon manually"""
bl_label = "Install update manually"
bl_idname = updater.addon+".updater_install_manually"
bl_description = "Proceed to manually install update"
bl_options = {'REGISTER', 'INTERNAL'}
error = bpy.props.StringProperty(
name="Error Occurred",
default="",
options={'HIDDEN'}
)
def invoke(self, context, event):
return context.window_manager.invoke_popup(self)
def draw(self, context):
layout = self.layout
if updater.invalidupdater == True:
layout.label(text="Updater error")
return
# use a "failed flag"? it shows this label if the case failed.
if self.error != "":
col = layout.column()
col.scale_y = 0.7
col.label(
text="There was an issue trying to auto-install", icon="ERROR")
col.label(
text="Press the download button below and install", icon="BLANK1")
col.label(text="the zip file like a normal addon.", icon="BLANK1")
else:
col = layout.column()
col.scale_y = 0.7
col.label(text="Install the addon manually")
col.label(text="Press the download button below and install")
col.label(text="the zip file like a normal addon.")
# if check hasn't happened, i.e. accidentally called this menu
# allow to check here
row = layout.row()
if updater.update_link != None:
row.operator("wm.url_open",
text="Direct download").url = updater.update_link
else:
row.operator("wm.url_open",
text="(failed to retrieve direct download)")
row.enabled = False
if updater.website != None:
row = layout.row()
row.operator("wm.url_open", text="Open website").url =\
updater.website
else:
row = layout.row()
row.label(text="See source website to download the update")
def execute(self, context):
return {'FINISHED'}
class addon_updater_updated_successful(bpy.types.Operator):
"""Addon in place, popup telling user it completed or what went wrong"""
bl_label = "Installation Report"
bl_idname = updater.addon+".updater_update_successful"
bl_description = "Update installation response"
bl_options = {'REGISTER', 'INTERNAL', 'UNDO'}
error = bpy.props.StringProperty(
name="Error Occurred",
default="",
options={'HIDDEN'}
)
def invoke(self, context, event):
return context.window_manager.invoke_props_popup(self, event)
def draw(self, context):
layout = self.layout
if updater.invalidupdater == True:
layout.label(text="Updater error")
return
saved = updater.json
if self.error != "":
col = layout.column()
col.scale_y = 0.7
col.label(text="Error occurred, did not install", icon="ERROR")
if updater.error_msg:
msg = updater.error_msg
else:
msg = self.error
col.label(text=str(msg), icon="BLANK1")
rw = col.row()
rw.scale_y = 2
rw.operator("wm.url_open",
text="Click for manual download.",
icon="BLANK1"
).url = updater.website
# manual download button here
elif updater.auto_reload_post_update == False:
# tell user to restart blender
if "just_restored" in saved and saved["just_restored"] == True:
col = layout.column()
col.label(text="Addon restored", icon="RECOVER_LAST")
alert_row = col.row()
alert_row.alert = True
alert_row.operator(
"wm.quit_blender",
text="Restart blender to reload",
icon="BLANK1")
updater.json_reset_restore()
else:
col = layout.column()
col.label(text="Addon successfully installed",
icon="FILE_TICK")
alert_row = col.row()
alert_row.alert = True
alert_row.operator(
"wm.quit_blender",
text="Restart blender to reload",
icon="BLANK1")
else:
# reload addon, but still recommend they restart blender
if "just_restored" in saved and saved["just_restored"] == True:
col = layout.column()
col.scale_y = 0.7
col.label(text="Addon restored", icon="RECOVER_LAST")
col.label(text="Consider restarting blender to fully reload.",
icon="BLANK1")
updater.json_reset_restore()
else:
col = layout.column()
col.scale_y = 0.7
col.label(text="Addon successfully installed",
icon="FILE_TICK")
col.label(text="Consider restarting blender to fully reload.",
icon="BLANK1")
def execute(self, context):
return {'FINISHED'}
class addon_updater_restore_backup(bpy.types.Operator):
"""Restore addon from backup"""
bl_label = "Restore backup"
bl_idname = updater.addon+".updater_restore_backup"
bl_description = "Restore addon from backup"
bl_options = {'REGISTER', 'INTERNAL'}
@classmethod
def poll(cls, context):
try:
return os.path.isdir(os.path.join(updater.stage_path, "backup"))
except:
return False
def execute(self, context):
# in case of error importing updater
if updater.invalidupdater == True:
return {'CANCELLED'}
updater.restore_backup()
return {'FINISHED'}
class addon_updater_ignore(bpy.types.Operator):
"""Prevent future update notice popups"""
bl_label = "Ignore update"
bl_idname = updater.addon+".updater_ignore"
bl_description = "Ignore update to prevent future popups"
bl_options = {'REGISTER', 'INTERNAL'}
@classmethod
def poll(cls, context):
if updater.invalidupdater == True:
return False
elif updater.update_ready == True:
return True
else:
return False
def execute(self, context):
# in case of error importing updater
if updater.invalidupdater == True:
return {'CANCELLED'}
updater.ignore_update()
self.report({"INFO"}, "Open addon preferences for updater options")
return {'FINISHED'}
class addon_updater_end_background(bpy.types.Operator):
"""Stop checking for update in the background"""
bl_label = "End background check"
bl_idname = updater.addon+".end_background_check"
bl_description = "Stop checking for update in the background"
bl_options = {'REGISTER', 'INTERNAL'}
# @classmethod
# def poll(cls, context):
# if updater.async_checking == True:
# return True
# else:
# return False
def execute(self, context):
# in case of error importing updater
if updater.invalidupdater == True:
return {'CANCELLED'}
updater.stop_async_check_update()
return {'FINISHED'}
# -----------------------------------------------------------------------------
# Handler related, to create popups
# -----------------------------------------------------------------------------
# global vars used to prevent duplicate popup handlers
ran_autocheck_install_popup = False
ran_update_sucess_popup = False
# global var for preventing successive calls
ran_background_check = False
@persistent
def updater_run_success_popup_handler(scene):
global ran_update_sucess_popup
ran_update_sucess_popup = True
# in case of error importing updater
if updater.invalidupdater == True:
return
try:
if "scene_update_post" in dir(bpy.app.handlers):
bpy.app.handlers.scene_update_post.remove(
updater_run_success_popup_handler)
else:
bpy.app.handlers.depsgraph_update_post.remove(
updater_run_success_popup_handler)
except:
pass
atr = addon_updater_updated_successful.bl_idname.split(".")
getattr(getattr(bpy.ops, atr[0]), atr[1])('INVOKE_DEFAULT')
@persistent
def updater_run_install_popup_handler(scene):
global ran_autocheck_install_popup
ran_autocheck_install_popup = True
# in case of error importing updater
if updater.invalidupdater == True:
return
try:
if "scene_update_post" in dir(bpy.app.handlers):
bpy.app.handlers.scene_update_post.remove(
updater_run_install_popup_handler)
else:
bpy.app.handlers.depsgraph_update_post.remove(
updater_run_install_popup_handler)
except:
pass
if "ignore" in updater.json and updater.json["ignore"] == True:
return # don't do popup if ignore pressed
# elif type(updater.update_version) != type((0,0,0)):
# # likely was from master or another branch, shouldn't trigger popup
# updater.json_reset_restore()
# return
elif "version_text" in updater.json and "version" in updater.json["version_text"]:
version = updater.json["version_text"]["version"]
ver_tuple = updater.version_tuple_from_text(version)
if ver_tuple < updater.current_version:
# user probably manually installed to get the up to date addon
# in here. Clear out the update flag using this function
if updater.verbose:
print("{} updater: appears user updated, clearing flag".format(
updater.addon))
updater.json_reset_restore()
return
atr = addon_updater_install_popup.bl_idname.split(".")
getattr(getattr(bpy.ops, atr[0]), atr[1])('INVOKE_DEFAULT')
def background_update_callback(update_ready):
"""Passed into the updater, background thread updater"""
global ran_autocheck_install_popup
# in case of error importing updater
if updater.invalidupdater == True:
return
if updater.showpopups == False:
return
if update_ready != True:
return
# see if we need add to the update handler to trigger the popup
handlers = []
if "scene_update_post" in dir(bpy.app.handlers): # 2.7x
handlers = bpy.app.handlers.scene_update_post
else: # 2.8x
handlers = bpy.app.handlers.depsgraph_update_post
in_handles = updater_run_install_popup_handler in handlers
if in_handles or ran_autocheck_install_popup:
return
if "scene_update_post" in dir(bpy.app.handlers): # 2.7x
bpy.app.handlers.scene_update_post.append(
updater_run_install_popup_handler)
else: # 2.8x
bpy.app.handlers.depsgraph_update_post.append(
updater_run_install_popup_handler)
ran_autocheck_install_popup = True
def post_update_callback(module_name, res=None):
"""Callback for once the run_update function has completed
Only makes sense to use this if "auto_reload_post_update" == False,
i.e. don't auto-restart the addon
Arguments:
module_name: returns the module name from updater, but unused here
res: If an error occurred, this is the detail string
"""
# in case of error importing updater
if updater.invalidupdater == True:
return
if res == None:
# this is the same code as in conditional at the end of the register function
# ie if "auto_reload_post_update" == True, comment out this code
if updater.verbose:
print("{} updater: Running post update callback".format(updater.addon))
atr = addon_updater_updated_successful.bl_idname.split(".")
getattr(getattr(bpy.ops, atr[0]), atr[1])('INVOKE_DEFAULT')
global ran_update_sucess_popup
ran_update_sucess_popup = True
else:
# some kind of error occurred and it was unable to install,
# offer manual download instead
atr = addon_updater_updated_successful.bl_idname.split(".")
getattr(getattr(bpy.ops, atr[0]), atr[1])('INVOKE_DEFAULT', error=res)
return
def ui_refresh(update_status):
# find a way to just re-draw self?
# callback intended for trigger by async thread
for windowManager in bpy.data.window_managers:
for window in windowManager.windows:
for area in window.screen.areas:
area.tag_redraw()
def check_for_update_background():
"""Function for asynchronous background check.
*Could* be called on register, but would be bad practice.
"""
if updater.invalidupdater == True:
return
global ran_background_check
if ran_background_check == True:
# Global var ensures check only happens once
return
elif updater.update_ready != None or updater.async_checking == True:
# Check already happened
# Used here to just avoid constant applying settings below
return
# apply the UI settings
settings = get_user_preferences(bpy.context)
if not settings:
return
updater.set_check_interval(enable=settings.auto_check_update,
months=settings.updater_intrval_months,
days=settings.updater_intrval_days,
hours=settings.updater_intrval_hours,
minutes=settings.updater_intrval_minutes
) # optional, if auto_check_update
# input is an optional callback function
# this function should take a bool input, if true: update ready
# if false, no update ready
if updater.verbose:
print("{} updater: Running background check for update".format(
updater.addon))
updater.check_for_update_async(background_update_callback)
ran_background_check = True
def check_for_update_nonthreaded(self, context):
"""Can be placed in front of other operators to launch when pressed"""
if updater.invalidupdater == True:
return
# only check if it's ready, ie after the time interval specified
# should be the async wrapper call here
settings = get_user_preferences(bpy.context)
if not settings:
if updater.verbose:
print("Could not get {} preferences, update check skipped".format(
__package__))
return
updater.set_check_interval(enable=settings.auto_check_update,
months=settings.updater_intrval_months,
days=settings.updater_intrval_days,
hours=settings.updater_intrval_hours,
minutes=settings.updater_intrval_minutes
) # optional, if auto_check_update
(update_ready, version, link) = updater.check_for_update(now=False)
if update_ready == True:
atr = addon_updater_install_popup.bl_idname.split(".")
getattr(getattr(bpy.ops, atr[0]), atr[1])('INVOKE_DEFAULT')
else:
if updater.verbose:
print("No update ready")
self.report({'INFO'}, "No update ready")
def showReloadPopup():
"""For use in register only, to show popup after re-enabling the addon
Must be enabled by developer
"""
if updater.invalidupdater == True:
return
saved_state = updater.json
global ran_update_sucess_popup
has_state = saved_state != None
just_updated = "just_updated" in saved_state
updated_info = saved_state["just_updated"]
if not (has_state and just_updated and updated_info):
return
updater.json_reset_postupdate() # so this only runs once
# no handlers in this case
if updater.auto_reload_post_update == False:
return
# see if we need add to the update handler to trigger the popup
handlers = []
if "scene_update_post" in dir(bpy.app.handlers): # 2.7x
handlers = bpy.app.handlers.scene_update_post
else: # 2.8x
handlers = bpy.app.handlers.depsgraph_update_post
in_handles = updater_run_success_popup_handler in handlers
if in_handles or ran_update_sucess_popup is True:
return
if "scene_update_post" in dir(bpy.app.handlers): # 2.7x
bpy.app.handlers.scene_update_post.append(
updater_run_success_popup_handler)
else: # 2.8x
bpy.app.handlers.depsgraph_update_post.append(
updater_run_success_popup_handler)
ran_update_sucess_popup = True
# -----------------------------------------------------------------------------
# Example UI integrations
# -----------------------------------------------------------------------------
def update_notice_box_ui(self, context):
""" Panel - Update Available for placement at end/beginning of panel
After a check for update has occurred, this function will draw a box
saying an update is ready, and give a button for: update now, open website,
or ignore popup. Ideal to be placed at the end / beginning of a panel
"""
if updater.invalidupdater == True:
return
saved_state = updater.json
if updater.auto_reload_post_update == False:
if "just_updated" in saved_state and saved_state["just_updated"] == True:
layout = self.layout
box = layout.box()
col = box.column()
alert_row = col.row()
alert_row.alert = True
alert_row.operator(
"wm.quit_blender",
text="Restart blender",
icon="ERROR")
col.label(text="to complete update")
return
# if user pressed ignore, don't draw the box
if "ignore" in updater.json and updater.json["ignore"] == True:
return
if updater.update_ready != True:
return
layout = self.layout
box = layout.box()
col = box.column(align=True)
col.label(text="Update ready!", icon="ERROR")
col.separator()
row = col.row(align=True)
split = row.split(align=True)
colL = split.column(align=True)
colL.scale_y = 1.5
colL.operator(addon_updater_ignore.bl_idname, icon="X", text="Ignore")
colR = split.column(align=True)
colR.scale_y = 1.5
if updater.manual_only == False:
colR.operator(addon_updater_update_now.bl_idname,
text="Update", icon="LOOP_FORWARDS")
col.operator("wm.url_open", text="Open website").url = updater.website
#col.operator("wm.url_open",text="Direct download").url=updater.update_link
col.operator(addon_updater_install_manually.bl_idname,
text="Install manually")
else:
#col.operator("wm.url_open",text="Direct download").url=updater.update_link
col.operator("wm.url_open", text="Get it now").url = updater.website
def update_settings_ui(self, context, element=None):
"""Preferences - for drawing with full width inside user preferences
Create a function that can be run inside user preferences panel for prefs UI
Place inside UI draw using: addon_updater_ops.updaterSettingsUI(self, context)
or by: addon_updater_ops.updaterSettingsUI(context)
"""
# element is a UI element, such as layout, a row, column, or box
if element == None:
element = self.layout
box = element.box()
# in case of error importing updater
if updater.invalidupdater == True:
box.label(text="Error initializing updater code:")
box.label(text=updater.error_msg)
return
settings = get_user_preferences(context)
if not settings:
box.label(text="Error getting updater preferences", icon='ERROR')
return
# auto-update settings
box.label(text="Updater Settings")
row = box.row()
# special case to tell user to restart blender, if set that way
if updater.auto_reload_post_update == False:
saved_state = updater.json
if "just_updated" in saved_state and saved_state["just_updated"] == True:
row.alert = True
row.operator(
"wm.quit_blender",
text="Restart blender to complete update",
icon="ERROR")
return
split = layout_split(row, factor=0.4)
subcol = split.column()
subcol.prop(settings, "auto_check_update")
subcol = split.column()
if settings.auto_check_update == False:
subcol.enabled = False
subrow = subcol.row()
subrow.label(text="Interval between checks")
subrow = subcol.row(align=True)
checkcol = subrow.column(align=True)
checkcol.prop(settings, "updater_intrval_months")
checkcol = subrow.column(align=True)
checkcol.prop(settings, "updater_intrval_days")
checkcol = subrow.column(align=True)
# Consider un-commenting for local dev (e.g. to set shorter intervals)
checkcol.prop(settings, "updater_intrval_hours")
checkcol = subrow.column(align=True)
checkcol.prop(settings, "updater_intrval_minutes")
# checking / managing updates
row = box.row()
col = row.column()
if updater.error != None: