-
Notifications
You must be signed in to change notification settings - Fork 11
/
SQLAPI.dscript
1780 lines (1669 loc) · 71.2 KB
/
SQLAPI.dscript
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
# ---------------------------------------------------------------------------- #
# |
# |
# D e n i z e n S Q L A P I |
# |
# An API for scripters to easily implement SQL |
# |
# *REQUIRES MYSQL* |
# |
# |
# Author: |Anthony| |
# Version: 0.1.3 |
# dScript Version: 0.9.6-dev-199 |
# |
# Dependencies: |
# - SQLManager: http://mcmonkey.org/denizen/repo/entry/19 |
# - ConfigFileGenerator: http://mcmonkey.org/denizen/repo/entry/7 |
# |
# ---------------------------------------------------------------------------- #
#
#
# ABOUT:
#
# SQLAPI is a library or API for Denizen scripters to easily implement SQL
# in their scripts. It is intended to supplement the denizen flag system for
# those who require data to be shared across a network of servers since
# Denizen currently has no cross server flag capability.
#
# The SQL backend functions are almost /completely/ handled by SQLManager.
# Automatically goes into offline caching mode if the sql database goes
# offline!
#
#
#------------------------------------------------
#
# USAGE:
#
# -- Setup
#
# 1. Create an empty SQL database on your server. You can name it anything you
# like. The default name is SQLAPI.
# Consult your operating system manual or other online documentation for
# instructions how to install and setup an sql server if needed. That is
# beyond the scope of this documentation.
#
# 2. Install SQLManager.dscript following the instructions provided. SQLAPI
# Will not load if SQLManager is not installed!
#
# 3. Install sqlapi.dscript to you Denizen scripts folder and type:
# /denizen reload scripts
#
# 4. From console or in game (with sqlapi.admin permission) type:
# /sqlapi --restart
# This will extract the config file to /Denizen/SQLAPI/config.yml
# SQLAPI will begin the connection attempt process, but will fail until
# you edit the config.yml file with valid connection information.
#
# 5. Edit the config.yml file with valid connection information for your SQL
# database created in step 1. If you have edit config.yml before the
# connection attempt cycle expires, SQLAPI will proceed with setup, if not
# you will need to repeat step 4.
#
# 6. SQLAPI is now installed! Rejoice!
#
#
# -- Permissions
#
# Admin permission: sqlapi.admin
#
#
#------------------------------------------------
#
# API Guidelines and Explanation
#
# -- Notes
#
# - SQLAPI utilizes the events system for setting/editing/deleting sql flags.
# - Learn more about the events command: http://mcmonkey.org/denizen/cmds/event
#
# - The events command in Denizen lacks the ability to handle lists directly
# in the context section. You MUST use the .escaped tag when supplying a
# list value!
#
# -- Setting/Editing/Deleting Flags
#
# Working with SQL flags is easy! You must specify the type, flagName,
# and flagValue context fields when you do. The duration field is optional. The
# owner field is not used for the server type flags.
#
# Full Example:
# - event 'sqlflag set' 'context:owner|<playerObject>|flagName|myFlag|flagValue|potato|duration|5s'
#
#
# -- Context Fields
#
# ~ Type
#
# There are four (4) flag types available through SQLAPI.
# - Type Values
# - server - Global flags with no owner
# - player - Player specific flags
# - npc - NPC specific flags
# - entity - Entity specific flags (not fully implemented)
#
# Example:
# 'context:type|player'
#
#
# ~ Owner
#
# The owner field is required for player, npc, and entity flag types, but is
# NOT required for server type flags. The owner field must contain a valid
# entity object for that particular flag type. A player type flag must have
# a <player> object in the owner field. An NPC flag must have an <npc> object
# in the owner field. An entity flag must have an <entity> object in the owner
# field.
#
# Example:
# 'context:owner|<player>'
#
#
# ~ FlagName
#
# The flagName field is where you declare the name of your flag. Flag names
# MUST be unique. Setting a flag value on an existing flag will overwrite it.
# Players, NPCs, and entities all have their own flag associations, which
# means that player A and player B can both have a flag named 'potato' with no
# conflicts.
#
# Flag names are limited to roughly 21,844 UTF-8 characters. You should have
# plenty of room for exotic flag names.
#
# Example:
# 'context:flagName|potato'
#
#
# ~ FlagValue
#
# The flagValue field is where you store the value of your flag. It can hold
# any string, integer, decimal, boolean, or list value you like. It has a
# theoretical limit of 5,592,404 UTF-8 characters.
#
# When working with a list flagValue, you must escape the whole list. This is
# required to overcome a limitation with the events command. Your data will be
# stored and returned to you correctly. You may also choose to use your own
# delimiter. You will be responsible for recreating your lists when you
# retrieve the value.
# Example:
# - define list 'li@a|b|c'
# - event 'sqlflag set' 'context:type|server|flagName|myFlag|flagValue|<def[list].escaped>'
#
#
# ~ Duration
#
# The duration field is an optional field for all flags. Setting a duration
# on a flag will make the flag available for specific amount of time. The
# value for the duration field can be provided in any of the following
# formats: T=ticks, M=minutes, S=seconds, H=hours, D=days, W = Weeks.
# Not using a unit will imply seconds.
# Example:
# - event 'sqlflag set' 'context:duration|10s'
#
#------------------------------------------------
#
# C h a n g e l o g
#
# - v0.1.3 - 4/29/15
# - Implement the event system
# - Scripts are encouraged to use the event system and NOT the command system
# - Break up the sqlflag command into its constituent parts.
# - Results in a flagString parser
# - Add fancy linewrapp and formatted message system
# - Run almost all messages through the message system
#
# - v0.1.2 - 4/28/15
# - List index manipulations
# - Insert: Inserts additional values starting at the specified index
# - Set: Inserts additional values replacing the specified index
# - Added <proc[SQLAPI_Expiration].context[owner|flag]>
# - Returns a Duration of the time remaining on the flag
# - Returns d@0t if the flag does not expire
# - Does not return if the flag is expired or is not set
# - Owner can be server, or any valid <player>, <npc>, or <entity> object
# - Added <proc[SQLAPI_ListFlags].context[owner]||null>
# - List all unexpired flags for <owner>
# - Owner can be server, or any valid <player>, <npc>, or <entity> object
# - Added <proc[SQLAPI_GetFlagged].context[type|flag]||null>
# - List all owners of the specified type that have the specified flag set.
# - Valid types are player, npc, and entity
# - Added <proc[SQLAPI_GetCurrentFlagged].context[type|flag]||null>
# - List all owners of the specified type that have the specified flag set.
# - Valid types are player, npc, and entity
# - Will only return owner objects for those (players) that are online or
# (npcs or entities) that are spawned.
#
#
# - v0.1.1 - 4/27/15
# - Correctly distinguish between existent and expired flags when editing lists
# - Math functions. Can now increment, decrement, multiply, and divide flags
#
# - v0.1.1 - 4/26/15
# - Make <proc[SQLAPI_GetFlag].context[owner|flag]||null> handle lists natively
# - Set list function works, may be expanded/revised at a later date
# - Added Include and Remove list functions
#
# - v0.1.1 - 4/25/15
# - Don't store escaped values in the db
#
# - v0.1.1 - 4/21/15
# - Added <proc[SQLAPI_GetFlag].context[owner|flag]||null>
# - Returns the flag value
# - Does not return if the flag doesn't exist or is expired.
#
# - v0.1.1 - 4/20/15
# - Added <proc[SQLAPI_ParseOwner].context[owner]||null>
# - Specify an owner object and it returns the type.
# - Return values are player, entity, npc, server, and thisPlayer.
# - Does not return on invalid input. Notify console instead
# - 'thisPlayer' is a literal string and should be handled in the calling
# script. It's intended for the sqlflag command so the literal string
# 'player' can be used to denote the person issuing the command.
# - Simplified the context required for GetFlagRecord, FlagExists, IsExpired,
# and HasFlag procedure scripts. Now only require the owner and flag context
# Eg.: <proc[SQLAPI_HasFlag].context[owner|flag]>
#
# - v0.1.1 - 4/20/15
# - sqlflag command
# - Allows setting/editing/deleting flags in game with a command
# - Currently only the set flag code is written. Don't try to do any list
# flags or removing flags yet!
# - Added <proc[SQLAPI_GetFlagRecord].context[tablename|owner|flag]||null>
# - Returns a raw flag record li@flagName|flagValue|expiriation
# - Returns "SQLAPI OFFLINE" if the db is offline
# - Really only meant for internal usage. There will be more user friendly
# options available in the future.
# - Added <proc[SQLAPI_FlagExists].context[tablename|owner|flag]>
# - Boolean tag to check if a flag exists
# - Does not return if the db is offline
# - Really only meant for internal usage.
# - Added <proc[SQLAPI_IsExpired].context[tablename|owner|flag]>
# - Boolean tag to check if a flag exists
# - Does not return if the flag does not exist OR the db is offline.
# - Really only meant for internal usage.
# - Added <proc[SQLAPI_HasFlag].context[tablename|owner|flag]>
# - Boolean tag to check if a object has a flag.
# - Returns true if the flag exists and is not expired.
# - Returns false if the flag does not exist or is expired.
# - Does not return if the db is offline.
#
# - v0.1 - 4/13/15
# - Initial commit
#
#
#------------------------------------------------
#
# TODO - Future Feature Fluff
#
#
#______________________________________________________________________________#
SQLAPI:
type: world
speed: 0
debug: false
action_map:
set_list: '&pipe'
include: '->'
remove: '<-'
increment: '++|+'
decrement: '--|-'
multiply: '**|*'
divide: '&fs&fs|&fs'
clear: '&exc'
events:
on server start:
- run locally start delay:1t
on sqlflag set:
- define owner '<c.owner>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
- if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagName '<c.flagName.sql_escaped||null>'
- if %flagName% == null || <def[flagName].length> == 0 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flagName!'
- queue clear
}
- define flagValue '<c.flagValue.unescaped.sql_escaped||true>'
- define expiration '<c.expiration.sql_escaped.as_duration.in_milliseconds.add_int[<server.current_time_milliseconds>]||0>'
- inject locally set_flag
on sqlflag set_index:
- define owner '<c.owner>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
- if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagName '<c.flagName.sql_escaped||null>'
- if %flagName% == null || <def[flagName].length> == 0 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flagName!'
- queue clear
}
- define index '<c.index.unescaped.sql_escaped.as_int||1>'
- define flagValue '<c.flagValue.unescaped.sql_escaped||true>'
- define expiration '<c.expiration.sql_escaped.as_duration.in_milliseconds.add_int[<server.current_time_milliseconds>]||0>'
- inject locally set_index_flag
on sqlflag clear:
- define owner '<c.owner>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
- if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagName '<c.flagName.sql_escaped||null>'
- if %flagName% == null || <def[flagName].length> == 0 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flagName!'
- queue clear
}
- inject locally clear_flag
on sqlflag include:
- define owner '<c.owner>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
- if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagName '<c.flagName.sql_escaped||null>'
- if %flagName% == null || <def[flagName].length> == 0 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flagName!'
- queue clear
}
- define flagValue '<c.flagValue.unescaped.sql_escaped>'
- define expiration '<c.expiration.sql_escaped.as_duration.in_milliseconds.add_int[<server.current_time_milliseconds>]||0>'
- inject locally include_flag
on sqlflag insert_index:
- define owner '<c.owner>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
- if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagName '<c.flagName.sql_escaped||null>'
- if %flagName% == null || <def[flagName].length> == 0 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flagName!'
- queue clear
}
- define index '<c.index.unescaped.sql_escaped.as_int||1>'
- define flagValue '<c.flagValue.unescaped.sql_escaped||true>'
- define expiration '<c.expiration.sql_escaped.as_duration.in_milliseconds.add_int[<server.current_time_milliseconds>]||0>'
- inject locally insert_index_flag
on sqlflag remove:
- define owner '<c.owner>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
- if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagName '<c.flagName.sql_escaped||null>'
- if %flagName% == null || <def[flagName].length> == 0 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flagName!'
- queue clear
}
- define flagValue '<c.flagValue.unescaped.sql_escaped>'
- define expiration '<c.expiration.sql_escaped.as_duration.in_milliseconds.add_int[<server.current_time_milliseconds>]||0>'
- inject locally remove_flag
on sqlflag increment:
- define owner '<c.owner>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
- if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagName '<c.flagName.sql_escaped||null>'
- if %flagName% == null || <def[flagName].length> == 0 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flagName!'
- queue clear
}
- define flagValue '<c.flagValue.unescaped.sql_escaped.as_decimal||1>'
- define expiration '<c.expiration.sql_escaped.as_duration.in_milliseconds.add_int[<server.current_time_milliseconds>]||0>'
- inject locally increment_flag
on sqlflag decrement:
- define owner '<c.owner>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
- if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagName '<c.flagName.sql_escaped||null>'
- if %flagName% == null || <def[flagName].length> == 0 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flagName!'
- queue clear
}
- define flagValue '<c.flagValue.unescaped.sql_escaped.as_decimal||1>'
- define expiration '<c.expiration.sql_escaped.as_duration.in_milliseconds.add_int[<server.current_time_milliseconds>]||0>'
- inject locally decrement_flag
on sqlflag multiply:
- define owner '<c.owner>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
- if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagName '<c.flagName.sql_escaped||null>'
- if %flagName% == null || <def[flagName].length> == 0 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flagName!'
- queue clear
}
- define flagValue '<c.flagValue.unescaped.sql_escaped.as_decimal||1>'
- define expiration '<c.expiration.sql_escaped.as_duration.in_milliseconds.add_int[<server.current_time_milliseconds>]||0>'
- inject locally multiply_flag
on sqlflag divide:
- define owner '<c.owner>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
- if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagName '<c.flagName.sql_escaped||null>'
- if %flagName% == null || <def[flagName].length> == 0 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flagName!'
- queue clear
}
- define flagValue '<c.flagValue.unescaped.sql_escaped.as_decimal||1>'
- define expiration '<c.expiration.sql_escaped.as_duration.in_milliseconds.add_int[<server.current_time_milliseconds>]||0>'
- inject locally divide_flag
on sqlapi command:
- if !<player.permission[sqlapi.admin]||false> && !<player.is_op> && !<c.server> {
- queue clear
}
- determine passively FULFILLED
- define arg1 '<c.args.get[1].escaped||null>'
- if <def[arg1].is[==].to[--restart]> {
- run s@SQLAPI_Msg delay:1t 'def:<&d>Restarting System!'
- define isRelaod ''
- inject locally start
}
on sqlflag command:
- define time '<server.current_time_millis>'
- if !<player.permission[sqlapi.admin]||false> && !<player.is_op> && !<c.server> {
- queue clear
}
- determine passively FULFILLED
- if <c.args.size> < 2 {
- run s@SQLAPI_Msg delay:1t 'def:<&c>/sqlflag <<>owner<>> flagName(<&lb>#<&rb>)(<&co>action)(<&co>value) (duration<&co>duration)'
- queue clear
}
- define owner '<parse:<c.args.get[1]||null>>'
- define type '<proc[SQLAPI_ParseOwner].context[%owner%]||null>'
- if %type% == null {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify valid flag holder!'
- queue clear
}
else if %type% == thisPlayer {
- if <c.server> {
- announce to_console "<&b>SQLAPI<&co><&c> Must specify valid player object from console!"
- queue clear
}
- define type 'player'
- define owner '<player>'
}
else if %type% != server {
- define owner '<def[owner].as_%type%>'
}
- define flagString '<c.args.get[2]>'
- inject locally parse_FlagString
- define duration '<c.args.get[3]||null>'
- if <def[duration].starts_with[d<&co>]> || <def[duration].starts_with[duration<&co>]> {
- define expiration '<def[duration].split[<&co>].get[2].as_duration||null>'
- if %expiration% == null {
- announce to_console '<&b>SQLAPI<&co><&c> <def[expiration].split[<&co>].get[2]||null> is not a valid duration!'
- define expiration '0'
}
else {
- define expiration '<def[expiration].in_milliseconds.add_int[<server.current_time_milliseconds>]>'
}
}
else {
- define expiration '0'
}
# - announce "Narrate values"
# - narrate "<&2>==="
# - narrate "size %size%"
# - narrate "owner %owner% %type% <def[owner].uuid>"
# - narrate "flag %flagName%"
# - narrate "action %action%"
# - narrate "flagvalue %flagvalue%"
# - narrate "expiration %expiration%"
- inject locally %action%_flag
- inject locally msg_%action%
- narrate "Time taken<&co> <server.current_time_millis.sub_int[%time%]>ms"
- queue clear
parseAction:
- define actions '<script.list_keys[action_map]>'
- foreach %actions% {
- define map '<script.yaml_key[action_map.%value%].as_list||li@>'
- if <def[map].contains_any[%action%]||false> {
- define action '<def[value].to_lowercase>'
- foreach stop
}
}
- if %actions% !contains %action% {
- define action 'set'
}
parse_FlagString:
- define preparse '<def[flagString].escaped.split[&co]||null>'
- define size '<def[preparse].size>'
- define flagName '<def[preparse].get[1].unescaped.to_lowercase.sql_escaped||null>'
- if %flagName% contains <&lb> {
- define index '<def[flagName].after[<&lb>].replace[<&rb>]>'
- define flagName '<def[flagName].before[<&lb>]>'
- if <def[index].length> == 0 || %index% !matches number {
- define index:!
}
}
- if %size% > 2 {
- define size 'extra'
}
- inject locally parse_flagString_%size%
parse_flagString_1:
- define flagValue 'true'
- define action 'set'
parse_flagString_2:
- define action '<def[preparse].get[2]||null>'
- inject locally parseAction
- if <li@set|clear|increment|decrement|multiply|divide> contains %action% {
- if %action% == set {
- define flagValue '<def[preparse].get[2].unescaped.sql_escaped>'
- if <def[index].exists> {
- define action 'set_index'
}
}
else if %action% != clear {
- narrate "set value to 1"
- define flagValue '1'
}
}
else {
- run s@SQLAPI_Msg delay:1t 'def:<&c>Must specify a flag value for %action% flag action!'
- queue clear
}
parse_flagString_Extra:
- define flagValue '<def[flagString].after[<def[preparse].get[2].unescaped><&co>].sql_escaped||null>'
- define action '<def[preparse].get[2]||null>'
- inject locally parseAction
- if <def[index].exists> {
- if li@set|set_list contains %action% {
- define action 'set_index'
}
else if %action% == include {
- define action 'insert_index'
}
}
- if %action% == set {
- define flagValue '<def[flagString].after[<def[preparse].get[1].unescaped><&co>].sql_escaped||null>'
}
else if <li@increment|decrement|multiply|divide> contains %action% {
- if %flagValue% !matches decimal {
- run s@SQLAPI_Msg delay:1t 'def:<&c>%flagValue% is not a valid number!'
- queue clear
}
}
start:
- ^define yamlName 'SQLAPI'
- ^define scriptName '<script.name>'
- ^inject locally reloadYaml instantly
- ^inject locally loadData instantly
- ^if %useSql% {
- announce "<&b>SQLAPI<&co><&c> Must be configured to use MySQL!" to_console
- inject locally unload
- queue stop
}
# Verify SQLManager is installed and ready
- ^if !<server.list_scripts.parse[name].contains[SQLManager]> {
- announce "<&b>SQLAPI<&co><&c> SQLManager not installed!" to_console
- inject locally unload
- queue stop
}
- ^repeat %retry% {
- if !<yaml.list.contains[SQLManager_Offline]> {
- announce "<&b>SQLAPI<&co><&c> Could not connect to SQLManager!" to_console
- if %loop_index% == %retry% {
- inject locally unload
- queue stop
}
- announce "<&b>SQLAPI<&co><&c> Will attempt again in %retryDelay%..." to_console
- wait %retryDelay%
}
}
# This checks the status as set by SQLManager to not duplicate restart
# processes. This is the only time this script needs to set the status.
# The SQLManager will handle every other situation.
- ^define status '<yaml[SQLManager_Offline].read[Offline_Cache.databases.%db%.status]||null>'
- ^if <def[status].is[==].to[connecting]> {
- announce "<&b>SQLManager<&co><&c> Already attempting to reconnect to %db% database!" to_console
- queue stop
}
else {
- yaml set 'id:SQLManager_Offline' 'Offline_Cache.databases.%db%.status:connecting'
- yaml 'savefile:SQLManager/cache.yml' 'id:SQLManager_Offline'
}
- ^if <def[isReload].exists||false> {
- run s@SQLManager p:restart delay:1t def:%yamlName%|%scriptName%|%db%
- queue clear
}
- ^inject s@SQLManager
- ^announce "<&b>SQLAPI<&co><&a> System loaded!" to_console
- queue stop
reloadYaml:
# Reloads the yaml files and generates default files if they don't exist.
- announce "<&b>SQLAPI<&co><&3> Loading system config files..." to_console
- if !<server.has_file[SQLAPI/config.yml]> {
- if <player> != null {
- flag <player> ConfigFileGeneratorNotify:true
- run s@ConfigFileGeneratorHelper def:SQLAPI|Configurations|false|false|false instantly
- flag <player> ConfigFileGeneratorNotify:!
}
else {
- run s@ConfigFileGeneratorHelper def:SQLAPI|Configurations instantly
}
}
- if <yaml.list.contains[SQLAPI_config]> yaml unload 'id:SQLAPI_config'
- yaml 'load:SQLAPI/config.yml' 'id:SQLAPI_config'
- inject s@SQLAPI_SQLTables
- announce "<&b>SQLAPI<&co><&a> System config files Loaded!" to_console
loadData:
- ^define yamlName 'SQLAPI'
- ^define scriptName '<script.name>'
- ^define useSql '<yaml[SQLAPI_config].read[config.MySQL.useSql]||false>'
- ^define retry '<yaml[SQLAPI_config].read[config.MySQL.retry]||3>'
- ^define retryDelay '<yaml[SQLAPI_config].read[config.MySQL.retryDelay]||10s>'
- ^define db '<yaml[SQLAPI_config].read[config.MySQL.database]||SQLAPI>'
- ^define PlayerSQLFLagsTable '<yaml[SQLAPI_config].read[config.MySQL.tables.PlayerSQLFLags]||dsqlapi_playersqlflags>'
- ^define NPCSQLFLagsTable '<yaml[SQLAPI_config].read[config.MySQL.tables.NPCSQLFLags]||dsqlapi_npcsqlflags>'
- ^define EntitySQLFLagsTable '<yaml[SQLAPI_config].read[config.MySQL.tables.EntitySQLFLags]||dsqlapi_entitysqlflags>'
- ^define ServerSQLFLagsTable '<yaml[SQLAPI_config].read[config.MySQL.tables.ServerSQLFLags]||dsqlapi_serversqlflags>'
unload:
- ^if <yaml.list.contains[SQLAPI_config]> {
- announce "<&b>SQLAPI<&co><&3> Unloading config.yml file..." to_console
- yaml unload 'id:SQLAPI_config'
}
- ^if <yaml.list.contains[SQLAPI_SQLTables]> {
- announce "<&b>SQLAPI<&co><&3> Unloading SQLAPI_SQLTables file..." to_console
- yaml unload 'id:SQLAPI_SQLTables'
}
- ^announce "<&b>SQLAPI<&co><&c> System disabled..." to_console
clear_flag:
- define yamlName 'SQLAPI'
- define scriptName 'SQLAPI'
- define db '<yaml[SQLAPI_config].read[config.MySQL.database]||SQLAPI>'
- define tableName '<yaml[SQLAPI_config].read[config.MySQL.tables.%type%SQLFLags]||dsqlapi_%type%sqlflags>'
- define flagExists '<proc[SQLAPI_FlagExists].context[%owner%|%flagName%]||offline>'
- if %flagExists% == offline {
- announce to_console "<&b>SQLAPI<&co><&c> System Offline! Can not remove %flagName% for %owner%!"
- queue clear
}
- if !%flagExists% {
- run s@SQLAPI_Msg delay:1t 'def:<&c>%owner% does not set %flagName%!'
- queue clear
}
- if %type% == server {
- define statement "DELETE FROM %tableName% WHERE flag='%flagName%';"
}
else {
- define uuid '<tern[<def[type].is[==].to[npc]>]:<def[owner].id>||<def[owner].uuid>>'
- define statement "DELETE FROM %tableName% WHERE flag='%flagName%' AND uuid='%uuid%';"
}
# - sql id:%db% "update:<def[statement]>" save:id
- inject s@SQLManager_Offline p:managedUpdateStatement
set_flag:
- define yamlName 'SQLAPI'
- define scriptName 'SQLAPI'
- define db '<yaml[SQLAPI_config].read[config.MySQL.database]||SQLAPI>'
- define tableName '<yaml[SQLAPI_config].read[config.MySQL.tables.%type%SQLFLags]||dsqlapi_%type%sqlflags>'
- define flagExists '<proc[SQLAPI_FlagExists].context[%owner%|%flagName%]>'
- if %flagExists% == offline {
- announce to_console "<&b>SQLAPI<&co><&c> System Offline! Can not set %flagName% for %owner% to %flagValue% in %tableName%!"
- queue clear
}
- if %type% == server {
- if %flagExists% {
- define statement "UPDATE %tableName% SET expiration = '%expiration%', value = '%flagValue%' WHERE flag='%flagName%';"
}
else {
- define statement "INSERT INTO %tableName% (flag, value, expiration) VALUES ('%flagName%', '%flagValue%', '%expiration%');"
}
}
else {
- define uuid '<tern[<def[type].is[==].to[npc]>]:<def[owner].id>||<def[owner].uuid>>'
- if %flagExists% {
- define statement "UPDATE %tableName% SET expiration = '%expiration%', value = '%flagValue%' WHERE flag='%flagName%' AND uuid='%uuid%';"
}
else {
- define statement "INSERT INTO %tableName% (uuid, flag, value, expiration) VALUES ('%uuid%', '%flagName%', '%flagValue%', '%expiration%');"
}
}
- inject s@SQLManager_Offline p:managedUpdateStatement
set_index_flag:
- define yamlName 'SQLAPI'
- define scriptName 'SQLAPI'
- define db '<yaml[SQLAPI_config].read[config.MySQL.database]||SQLAPI>'
- define tableName '<yaml[SQLAPI_config].read[config.MySQL.tables.%type%SQLFLags]||dsqlapi_%type%sqlflags>'
- define record '<proc[SQLAPI_GetFlagRecord].context[%owner%|%flagName%]||null>'
- if '<def[record].equals_case_sensitive[SQLAPI OFFLINE]>' {
- announce to_console "<&b>SQLAPI<&co><&c> System Offline! Can not set index %index% %flagName% for %owner% to %flagValue% in %tableName%!"
- queue clear
}
- if %record% != null {
- define flagExists 'true'
- define expires '<def[record].get[3].unescaped||0>'
- if %expires% == 0 || %expires% > <server.current_time_millis> {
- define isExpired 'false'
}
else {
- define isExpired 'true'
}
}
else {
- define flagExists 'false'
- define isExpired 'true'
}
- if %flagExists% && !%isExpired% {
- define flagVal '<def[record].get[2].unescaped||null>'
- if <def[flagVal].starts_with[|]> {
- define flagVal '<def[flagVal].as_list>'
- define flagValue '<&pipe><def[flagVal].get[2].to[<def[flagVal].size>].set[%flagValue%].at[%index%].replace[li@]>'
}
else {
- define flagValue '<&pipe>%flagValue%'
}
}
else {
- define flagValue '<&pipe>%flagValue%'
}
- if %type% == server {
- if %flagExists% {
- define statement "UPDATE %tableName% SET expiration = '%expiration%', value = '%flagValue%' WHERE flag='%flagName%';"
}
else {
- define statement "INSERT INTO %tableName% (flag, value, expiration) VALUES ('%flagName%', '%flagValue%', '%expiration%');"
}
}
else {
- define uuid '<tern[<def[type].is[==].to[npc]>]:<def[owner].id>||<def[owner].uuid>>'
- if %flagExists% {
- define statement "UPDATE %tableName% SET expiration = '%expiration%', value = '%flagValue%' WHERE flag='%flagName%' AND uuid='%uuid%';"
}
else {
- define statement "INSERT INTO %tableName% (uuid, flag, value, expiration) VALUES ('%uuid%', '%flagName%', '%flagValue%', '%expiration%');"
}
}
- inject s@SQLManager_Offline p:managedUpdateStatement
set_list_flag:
- define yamlName 'SQLAPI'
- define scriptName 'SQLAPI'
- define db '<yaml[SQLAPI_config].read[config.MySQL.database]||SQLAPI>'
- define tableName '<yaml[SQLAPI_config].read[config.MySQL.tables.%type%SQLFLags]||dsqlapi_%type%sqlflags>'
- define record '<proc[SQLAPI_GetFlagRecord].context[%owner%|%flagName%]||null>'
- if '<def[record].equals_case_sensitive[SQLAPI OFFLINE]>' {
- run s@SQLAPI_Msg delay:1t 'def:<&c>System Offline! Can not set %flagName% for %owner% to %flagValue% in %tableName%!'
- queue clear
}
- if %record% != null {
- define flagExists 'true'
- define expires '<def[record].get[3].unescaped||0>'
- if %expires% == 0 || %expires% > <server.current_time_millis> {
- define isExpired 'false'
}
else {
- define isExpired 'true'
}
}
else {
- define flagExists 'false'
- define isExpired 'true'
}
- if %flagExists% && !%isExpired% {
- define flagVal '<def[record].get[2].unescaped||null>'
- if <def[flagVal].starts_with[|]> {
- define flagVal '<def[flagVal].as_list>'
- define flagValue '<&pipe><def[flagVal].get[2].to[<def[flagVal].size>].replace[li@]><&pipe>%flagValue%'
}
else {
- define flagValue '<&pipe>%flagValue%'
}
}
else {
- define flagValue '<&pipe>%flagValue%'
}
- if %type% == server {
- if %flagExists% {
- define statement "UPDATE %tableName% SET expiration = '%expiration%', value = '%flagValue%' WHERE flag='%flagName%';"
}
else {
- define statement "INSERT INTO %tableName% (flag, value, expiration) VALUES ('%flagName%', '%flagValue%', '%expiration%');"
}
}
else {
- define uuid '<tern[<def[type].is[==].to[npc]>]:<def[owner].id>||<def[owner].uuid>>'
- if %flagExists% {
- define statement "UPDATE %tableName% SET expiration = '%expiration%', value = '%flagValue%' WHERE flag='%flagName%' AND uuid='%uuid%';"
}
else {
- define statement "INSERT INTO %tableName% (uuid, flag, value, expiration) VALUES ('%uuid%', '%flagName%', '%flagValue%', '%expiration%');"
}
}
- inject s@SQLManager_Offline p:managedUpdateStatement
include_flag:
- define yamlName 'SQLAPI'
- define scriptName 'SQLAPI'
- define db '<yaml[SQLAPI_config].read[config.MySQL.database]||SQLAPI>'
- define tableName '<yaml[SQLAPI_config].read[config.MySQL.tables.%type%SQLFLags]||dsqlapi_%type%sqlflags>'
- define record '<proc[SQLAPI_GetFlagRecord].context[%owner%|%flagName%]||null>'
- if '<def[record].equals_case_sensitive[SQLAPI OFFLINE]>' {
- run s@SQLAPI_Msg delay:1t 'def:<&c>System Offline! Can not include %flagValue% in %flagName% for %owner% in %tableName%!'
- queue clear
}
- if %record% != null {
- define flagExists 'true'
- define expires '<def[record].get[3].unescaped||0>'
- if %expires% == 0 || %expires% > <server.current_time_millis> {
- define isExpired 'false'
}
else {
- define isExpired 'true'
}
}
else {
- define flagExists 'false'
- define isExpired 'true'
}
- if %flagExists% && !%isExpired% {
- define flagVal '<def[record].get[2].unescaped||null>'
- if <def[flagVal].starts_with[|]> {
- define flagVal '<def[flagVal].as_list>'
- define flagValue '<&pipe><def[flagVal].get[2].to[<def[flagVal].size>].replace[li@]><&pipe>%flagValue%'
}
else {
- define flagValue '<&pipe>%flagValue%'
}
}
else {
- define flagValue '<&pipe>%flagValue%'
}
- if %type% == server {
- if %flagExists% {
- define statement "UPDATE %tableName% SET expiration = '%expiration%', value = '%flagValue%' WHERE flag='%flagName%';"
}
else {
- define statement "INSERT INTO %tableName% (flag, value, expiration) VALUES ('%flagName%', '%flagValue%', '%expiration%');"
}
}
else {
- define uuid '<tern[<def[type].is[==].to[npc]>]:<def[owner].id>||<def[owner].uuid>>'
- if %flagExists% {
- define statement "UPDATE %tableName% SET expiration = '%expiration%', value = '%flagValue%' WHERE flag='%flagName%' AND uuid='%uuid%';"
}
else {
- define statement "INSERT INTO %tableName% (uuid, flag, value, expiration) VALUES ('%uuid%', '%flagName%', '%flagValue%', '%expiration%');"
}
}
- inject s@SQLManager_Offline p:managedUpdateStatement
insert_index_flag:
- define yamlName 'SQLAPI'
- define scriptName 'SQLAPI'
- define db '<yaml[SQLAPI_config].read[config.MySQL.database]||SQLAPI>'
- define tableName '<yaml[SQLAPI_config].read[config.MySQL.tables.%type%SQLFLags]||dsqlapi_%type%sqlflags>'
- define record '<proc[SQLAPI_GetFlagRecord].context[%owner%|%flagName%]||null>'
- if '<def[record].equals_case_sensitive[SQLAPI OFFLINE]>' {
- run s@SQLAPI_Msg delay:1t 'def:<&c>System Offline! Can not insert %flagValue% at index %index% for %flagName% for %owner% in %tableName%!'
- queue clear
}
- if %record% != null {
- define flagExists 'true'
- define expires '<def[record].get[3].unescaped||0>'
- if %expires% == 0 || %expires% > <server.current_time_millis> {
- define isExpired 'false'
}
else {
- define isExpired 'true'
}
}
else {
- define flagExists 'false'
- define isExpired 'true'
}
- if %flagExists% && !%isExpired% {
- define flagVal '<def[record].get[2].unescaped||null>'
- if <def[flagVal].starts_with[|]> {
- define flagVal '<def[flagVal].as_list>'
- define flagValue '<&pipe><def[flagVal].get[2].to[<def[flagVal].size>].insert[%flagValue%].at[%index%].replace[li@]>'
}
else {
- define flagValue '<&pipe>%flagValue%'
}
}
else {
- define flagValue '<&pipe>%flagValue%'
}
- if %type% == server {
- if %flagExists% {
- define statement "UPDATE %tableName% SET expiration = '%expiration%', value = '%flagValue%' WHERE flag='%flagName%';"
}
else {
- define statement "INSERT INTO %tableName% (flag, value, expiration) VALUES ('%flagName%', '%flagValue%', '%expiration%');"
}
}
else {
- define uuid '<tern[<def[type].is[==].to[npc]>]:<def[owner].id>||<def[owner].uuid>>'
- if %flagExists% {
- define statement "UPDATE %tableName% SET expiration = '%expiration%', value = '%flagValue%' WHERE flag='%flagName%' AND uuid='%uuid%';"
}
else {
- define statement "INSERT INTO %tableName% (uuid, flag, value, expiration) VALUES ('%uuid%', '%flagName%', '%flagValue%', '%expiration%');"
}
}
- inject s@SQLManager_Offline p:managedUpdateStatement
remove_flag:
- define yamlName 'SQLAPI'
- define scriptName 'SQLAPI'
- define db '<yaml[SQLAPI_config].read[config.MySQL.database]||SQLAPI>'
- define tableName '<yaml[SQLAPI_config].read[config.MySQL.tables.%type%SQLFLags]||dsqlapi_%type%sqlflags>'
- define record '<proc[SQLAPI_GetFlagRecord].context[%owner%|%flagName%]||null>'
- if '<def[record].equals_case_sensitive[SQLAPI OFFLINE]>' {
- run s@SQLAPI_Msg delay:1t 'def:<&c>System Offline! Can not remove %flagValue% from %flagName% for %owner% in %tableName%!'
- queue clear
}