/
ConfigFileGenerator.yml
541 lines (523 loc) · 25.3 KB
/
ConfigFileGenerator.yml
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
# ---------------------------------------------------------------------------- #
# |
# |
# C o n f i g F i l e G e n e r a t o r |
# |
# A system for extracting default config files for your scripts |
# |
# |
# Author: |Anthony| |
# Version: 0.52 |
# dScript Version: 0.9.8-DEV-b646 |
# |
# ---------------------------------------------------------------------------- #
# |
# |
# ABOUT: |
# |
# Use the ConfigFileGenerator for any scripts that use config files or |
# YAML file storage. It will generate any default files for you based on |
# what you define in the Configurations Script Container. |
# |
# At its core, the ConfigFileGenerator is really a data extraction and |
# insertion tool. The provided helper script makes it super easy for end |
# users to get basic functionality (creating default config files). More |
# advanced users can bypass the helper script and get right to the core. |
# The advanced usage allows you to extract data from any yaml file and |
# insert it into any other yaml file. |
# |
# |
# ------------- |
# |
# USAGE: |
# |
# - Build your Configurations Script Container file as needed following the |
# examples shown here. |
# |
# - Use the ConfigFileGeneratorHelper to generate the files defined in your |
# Configurations Script Container. |
# - run s@ConfigFileGeneratorHelper def:%readID%|%readPath% |
# |
# - Use the ConfigFileGenerator directly to extract data from any yaml file |
# to any other yaml file.
# - run s@ConfigFileGenerator def:%readID%|%writeID%|%readPath%|%writePath%|%dryrun%|%verbose%|%forcewrite% instantly
#
# |
# Has my work helped you in some way? Show your support by clicking the |
# Like button. |
# Feeling generous? Get me a coffee :D |
# https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=NPXKHCNMTGSUG
# |
#--- Example: |
# |
# There is an example Configurations Script Container at the end of this |
# file that you can use to see how the ConfigFileGeneratorHelper works. |
# |
# There is also a command script supplied to make it easy to test. Assign |
# youself the denizen.cfg permission node to use the command: /cfg |
# |
# This will create 3 files inside /plugins/denizen/ConfigFileGeneratorTest |
# |
# You can also specify any or all of the 3 options for the /cfg command. |
# /cfg --dryrun --verbose --force |
# |
#__________ |
# |
################################################################################
# #
# #
# S O M E N O T S O E M P T Y S P A C E #
# #
# #
################################################################################
#
# ConfigFileGenerator Version
#
# Handles ConfigFileGenerator Versioning Checks
#
ConfigFileGenerator_Version:
type: version
author: Anthony
name: ConfigFileGenerator
version: 0.52
description: Automatically extract and update config files
id: 7
#
# END ConfigFileGenerator Version
#--------------------------------------
#
################################################################################
#
# Config File Generator Helper
#
# This is specifically for creating NEW files! This script tells the
# s@ConfigFileGenerator which files to generate based on the script
# container you reference. The files names and paths are determined based
# on this info!
#
# Check the usage below for how to reference your script container.
#
#
# Bare minimum usage:
#
# - Running the script
#
# This helper script expects that you will have a script container that
# matches a certain naming convention. It will fail if you do not!
#
# example:
# - define readID YourScript
# - define readPath Configurations
# - run s@ConfigFileGeneratorHelper def:%readID%|%readPath% instantly
#
# The above will look for a Script_Container named 'YourScript_Configurations'
# because it reconstructs the %readPath% to be '%readID%_%readPath%'. After it
# verifies the Script_Container it will load/reload the yaml file and identify
# it as %readID% which in our example would be 'YourScript'. It will unload
# this yaml file when it's finished.
#
# It then builds a %keylist% from all the child nodes it finds in that
# Script_Container excluding the required nodes for any script container. The
# first level child nodes it finds under the Script_Container will each be a
# new file. Check this example:
#
# YourScript_Configurations:
# type: yaml data
# debug: false
# script: []
#
# file1:
# key: value
#
# file2:
# key: value
#
# This example Script_Container would generate and load 2 new yaml files. It
# follows a similar naming convention as before. Here's an oversimplification
# of what it's doing behind the scenes for you:
# - yaml create 'id:YourScript_file1'
# - yaml create 'id:YourScript_file2'
# - yaml 'savefile:YourScript/file1.yml' 'id:YourScript_file1'
# - yaml 'savefile:YourScript/file2.yml' 'id:YourScript_file1'
#
# A new folder will be generated in the denizen folder named: YourScript
# Inside this folder there will be 2 new files: file1.yml file2.yml
# It will unload these files when it's finished.
#
# -----
#
# - Injecting the script
# - define readID
# - define readPath
# - inject s@ConfigFileGeneratorHelper
#
# Alternate functionality is available when injecting this helper script.
# I'll document that later...
#
#
#
# NOTES:
#
# - I want to update this so you can specify a single file to build from any
# config container. Currently it tries to build every file but will not
# overwrite existing files by default (you CAN specify the --force option)
#
#__________
#
ConfigFileGeneratorHelper:
type: task
debug: false
script:
- ^define readID '<def[readID]||%1%>'
- ^define readPath '<def[readPath]||%readID%_%2%>'
- ^define scriptPath '<def[readPath].as_script.relative_filename||null>'
- ^define dryrun '<def[dryrun]||<def[3]||false>>'
- ^define verbose '<def[verbose]||<def[4]||false>>'
- ^define forcewrite '<def[forcewrite]||<def[5]||false>>'
- ^if <def[scriptPath].is[==].to[null]> {
- announce "<&b>ConfigFileGenerator<&co> <&c><def[readID]> is not a valid readID." to_console
- queue stop
}
- ^if <server.has_file[%scriptPath%]> {
- if <yaml.list.contains[%readID%]> yaml unload 'id:%readID%'
- yaml 'load:<def[scriptPath]>' 'id:%readID%'
}
else {
- announce "<&b>ConfigFileGenerator<&co> <&c>%scriptPath% does not exist!" to_console
- queue stop
}
- ^define keylist '<yaml[%readID%].list_keys[%readPath%].exclude[type|debug|scriptPath|script]>'
- ^if <def[keylist].is_empty> {
- announce "<&b>ConfigFileGenerator<&co> <&c>The default <def[readID]> config file is emtpy!" to_console
- yaml unload 'id:%readID%'
- queue stop
}
- ^foreach <def[keylist]> {
- define file <def[value]>
- inject s@ConfigFileGeneratorHelper p:buildFile
}
- ^announce "<&b>ConfigFileGenerator<&co> <&a><def[readID]> has Completed!" to_console
- ^announce "<&b>ConfigFileGenerator<&co> <&a><def[readID]> has Completed!" to_flagged:ConfigFileGeneratorNotify
- ^yaml unload 'id:%readID%'
buildFile:
- if !<server.has_file[%readID%/%file%.yml]> || <def[forcewrite]> {
- announce "<&b>ConfigFileGenerator<&co> <&3>Generating default <def[readID]> %file%.yml file..." to_console
- announce "<&b>ConfigFileGenerator<&co> <&3>Generating default <def[readID]> %file%.yml file..." to_flagged:ConfigFileGeneratorNotify
- announce "" to_flagged:ConfigFileGeneratorNotify
- define newReadPath '%readPath%.%file%'
- define writePath '%file%'
- define writeID '%readID%_%file%'
- yaml create 'id:%writeID%'
- run s@ConfigFileGenerator def:<def[readID]>|<def[writeID]>|<def[newReadPath]>|<def[writePath]>|<def[dryrun]>|<def[verbose]>|<def[forcewrite]> instantly
- if !<def[dryrun]> {
- yaml 'savefile:%readID%/%file%.yml' 'id:%writeID%'
- announce "<&b>ConfigFileGenerator<&co> <&a><def[readID]> %file%.yml Save Complete!" to_console
- announce "<&b>ConfigFileGenerator<&co> <&a><def[readID]> %file%.yml Save Complete!" to_flagged:ConfigFileGeneratorNotify
- announce "" to_flagged:ConfigFileGeneratorNotify
- yaml unload 'id:%writeID%'
}
else {
- announce "<&b>ConfigFileGenerator<&co> <&a><def[readID]> %file%.yml Dryrun Complete!" to_console
- announce "<&b>ConfigFileGenerator<&co> <&a><def[readID]> %file%.yml Dryrun Complete!" to_flagged:ConfigFileGeneratorNotify
- announce "" to_flagged:ConfigFileGeneratorNotify
- yaml unload 'id:%writeID%'
}
}
else {
- announce "<&b>ConfigFileGenerator<&co> <&a><def[readID]> %file%.yml already exists!" to_console
- announce "<&b>ConfigFileGenerator<&co> <&a><def[readID]> %file%.yml already exists!" to_flagged:ConfigFileGeneratorNotify
}
#
#
################################################################################
# #
# #
# W H A T A R E Y O U L O O K I N G A T #
# #
# #
################################################################################
#
# Config File Generator
#
#
# This new script differs from the original in that it maintains the readPath
# and writePath seperately! This allows you to extract ALL data from %readPath%
# in your already loaded %readID% yaml file and insert it at any %writePath% in
# the already loaded %writeID% yaml file.
#
# example:
# - define readID 'YourScript'
# - define writeID 'YourYamlFile'
# - yaml 'load:Input/FilePath.yml' 'id:%readID%'
# - yaml 'load:Output/FilePath.yml' 'id:%writeID%'
# - define readPath 'Some.Yaml.Node.To.Read'
# - define writePath 'Some.Yaml.Node.To.Write'
# - run s@ConfigFileGenerator def:%readID%|%writeID%|%readPath%|%writePath%|false|false|false instantly
# - yaml unload 'id:%readID%'
# - yaml 'savefile:Output/FilePath.yml' 'id:%writeID%'
#
#__________
#
ConfigFileGenerator:
type: task
debug: false
definitions: readID|writeID|readPath|writePath|dryrun|verbose|forcewrite
script:
- ^define keylist '<yaml[<def[readID]>].list_keys[<def[readPath]>]||null>'
- ^if <def[keylist]> != null {
- if <def[keylist].is[==].to[li@]> {
- if <def[dryrun]> || <def[verbose]> {
- announce "<&b>ConfigFileGenerator<&co> <&a>Writing Empty Key<&co> <&b><def[writePath]>" to_console
- announce "<&b>ConfigFileGenerator<&co> <&a>Writing Empty Key<&co> <&b><def[writePath]>" to_flagged:ConfigFileGeneratorNotify
}
- yaml set '%writePath%:|:' 'id:%writeID%'
}
else {
- inject s@ConfigFileGenerator p:foreachKeylist instantly
}
}
else {
- define entry '<yaml[<def[readID]>].read[<def[readPath]>]>'
- if <def[dryrun]> || <def[verbose]> {
- announce "<&b>ConfigFileGenerator<&co> <&a>Reading<&co> <&b><def[readPath]>" to_console
- announce "<&b>ConfigFileGenerator<&co> <&a>Reading<&co> <&b><def[readPath]>" to_flagged:ConfigFileGeneratorNotify
}
- if <yaml[<def[readID]>].is_list[<def[readPath]>]> {
- inject s@ConfigFileGenerator p:foreachEntrylist instantly
}
else {
- inject s@ConfigFileGenerator p:singleEntry instantly
}
}
foreachKeylist:
- foreach <def[keylist]> {
- define key '<def[value]>'
- define newReadPath '%readPath%.%key%'
- define newWritePath '%writePath%.%key%'
- run s@ConfigFileGenerator def:<def[readID]>|<def[writeID]>|<def[newReadPath]>|<def[newWritePath]>|<def[dryrun]>|<def[verbose]>|<def[forcewrite]> instantly
}
foreachEntrylist:
# This first yaml command clears the node of any values
# - if <def[forcewrite]> {
# - yaml set '%writePath%:|:' 'id:%writeID%'
# }
- foreach <def[entry]> {
- if ( <def[dryrun].not> && <yaml[%writeID%].read[%writePath%].contains[%value%].not||true> ) || <def[forcewrite]> {
- yaml set '%writePath%:->:%value%' 'id:<def[writeID]>'
}
- if <def[dryrun]> || <def[verbose]> {
- announce "<&b>ConfigFileGenerator<&co> <&a>Writing<&co> <&9>%writePath%<&co> <&2>%value%" to_console
- announce "<&b>ConfigFileGenerator<&co> <&a>Writing<&co> <&9>%writePath%<&co> <&2>%value%" to_flagged:ConfigFileGeneratorNotify
}
}
- if <def[dryrun]> || <def[verbose]> {
- announce "<&b>ConfigFileGenerator<&co> <&3>*-----*" to_flagged:ConfigFileGeneratorNotify
- announce "" to_flagged:ConfigFileGeneratorNotify
}
singleEntry:
# - if <def[forcewrite]> {
# - yaml set '<def[writePath]>:!' 'id:<def[writeID]>'
# }
- if ( <def[dryrun].not> && <yaml[%writeID%].read[%writePath%].is[==].to[%entry%].not||true> ) || <def[forcewrite]> {
- yaml set '<def[writePath]>:<def[entry]>' 'id:<def[writeID]>'
}
- if <def[dryrun]> || <def[verbose]> {
- announce "<&b>ConfigFileGenerator<&co> <&a>Writing<&co> <&c>%writePath%<&co> <&e>%entry%" to_console
- announce "<&b>ConfigFileGenerator<&co> <&a>Writing<&co> <&c>%writePath%<&co> <&e>%entry%" to_flagged:ConfigFileGeneratorNotify
- announce "<&b>ConfigFileGenerator<&co> <&4>*-----*" to_flagged:ConfigFileGeneratorNotify
- announce "<&b>ConfigFileGenerator<&co> " to_flagged:ConfigFileGeneratorNotify
}
#
#
################################################################################
# #
# N O T H I N G T O S E E H E R E #
# #
# M O V E A L O N G #
# #
################################################################################
#
# Configuration File Generator Command
#
# Use this to build the example config files. You /could/ use it to build files
# for other scripts, but use at your own risk!
#
# I suppose you could add something like this to accept container names...
#
# - if <c.args.find[-b].is[MORE].than[0]> {
# - define file <c.args.get[<c.args.find[-b].add[1].as_int>]>
# }
# else {
# - narrate "<&4>You must specify the readPath!"
# }
# - if <c.args.find[-i].is[MORE].than[0]> {
# - define readID <c.args.get[<c.args.find[-i].add[1].as_int>]>
# - narrate "%readID%"
# }
# else {
# - narrate "<&4>You must specify the readID!"
# }
#
#__________
#
ConfigFileGeneratorCommand:
type: world
debug: false
events:
on system time hourly:
- wait 1t
# - if !<yaml[ConfigFileGenerator_config].read[config.stats.useStats]||true> {
# - queue clear
# }
- if <queue.list> !contains 'q@ConfigFileGenerator_UpdateCheck' {
- run locally delay:1t updateCheck 'id:ConfigFileGenerator_UpdateCheck'
}
- if <queue.list> !contains 'q@ConfigFileGenerator_SendMetrics' {
- run locally delay:1t sendMetrics 'id:ConfigFileGenerator_SendMetrics'
}
on cfg command:
- if !<player.has_permission[denizen.cfg]||false> {
- queue stop
}
- determine passively fulfilled
- flag <player> ConfigFileGeneratorNotify:true
- define dryrun '<tern[<c.args.contains[--dryrun]>]:true || false>'
- define verbose '<tern[<c.args.contains[--verbose]>]:true || false>'
- define forcewrite '<tern[<c.args.contains[--force]>]:true || false>'
- run s@ConfigFileGeneratorHelper def:ConfigFileGeneratorTest|Configurations|%dryrun%|%verbose%|%forcewrite% instantly
- flag <player> ConfigFileGeneratorNotify:!
sendMetrics:
# Tracks version, players, denizen_version, jenkins_build, bukkit_version
# - run s@msgPrefixed instantly 'def:ConfigFileGenerator|<&3>Sending usage metrics...'
- ~webget "http://morphanone.space/webizen.aspx/tracker?script=<s@ConfigFileGenerator_Version.yaml_key[id]>&version=<s@ConfigFileGenerator_Version.yaml_key[version]>&players=<server.list_online_players.size>&denizen_version=<server.denizen_version.replace[-SNAPSHOT].before[ ]>&jenkins_build=<server.denizen_version.after[(build ].before[)]>&bukkit_version=<server.bukkit_version>" 'save:send'
- if !<entry[send].result.starts_with[SUCCESS]||false> {
- run s@msgPrefixed instantly 'def:ConfigFileGenerator|<&c>Metrics failed!'
}
updateCheck:
- ^if !<server.has_flag[ConfigFileGenerator.Version.Repo]> {
- ~webget "http://old.mcmonkey.org/denizen/repo/version/<s@ConfigFileGenerator_Version.yaml_key[id]>" save:page
- ^flag server "ConfigFileGenerator.Version.Repo:<entry[page].result||unknown>" d:1h
}
- ^define repoVersion '<server.flag[ConfigFileGenerator.Version.Repo]||unknown>'
- ^define currentVersion '<s@ConfigFileGenerator_Version.yaml_key[version]>'
- ^if '%repoVersion%' == 'unknown' {
- run s@msgPrefixed instantly 'def:ConfigFileGenerator|<&7>Unable to check for update! <&7><&o>%currentVersion%<&7> is installed!'
}
else if '%repoVersion%' > '%currentVersion%' {
- run s@msgPrefixed instantly 'def:ConfigFileGenerator|<&7>Update from version <&o>%currentVersion%<&7> to <&o>%repoVersion%<&7>!'
}
else if '%repoVersion%' != '%currentVersion%' {
- run s@msgPrefixed instantly 'def:ConfigFileGenerator|<&7>What happened? You are on version <&o>%currentVersion%<&7> and the repo says <&o>%repoVersion%<&7>!'
}
#
#---------------------------------------
#
#
################################################################################
# #
# A N D N O W F O R S O M E T H I N G #
# #
# C O M P L E T E L Y D I F F E R E N T #
# #
################################################################################
# #
# Example Configurations Script Container #
# #
# #
# The Configurations Script Container is the house for your default files. #
# It will be referenced when using the ConfigFileGeneratorHelper. #
# #
# You are able to store any data needed inside this file. It can handle #
# recursive lists too. #
# #
#-- Naming the Container #
# * This is important! #
# #
# This script container should follow the naming convention: #
# YourScript_Configurations #
# %readID%_%readPath% #
# #
# This will be important when you go to run the ConfigFileGeneratorHelper #
# #
# example: #
# - define readID ConfigFileGeneratorTest #
# - define readPath Configurations #
# - run s@ConfigFileGeneratorHelper def:%readID%|%readPath% instantly #
# #
# #
# Each parent node under the script container defines a file name to generate. #
# The child nodes that follow are the entries for that individual file. #
# #
# In this example, 3 files are generated in denizen/ConfigFileGeneratorTest/ #
# #
# Although the examples are a bit robotic, they clearly illustrate a range of #
# usage scenarios. #
#______________________________________________________________________________#
# #
#______________________________DO_NOT_EDIT_THIS_FILE___________________________#
# #
#______________________________________________________________________________#
ConfigFileGeneratorTest_Configurations:
type: task
debug: false
script: ''
# ------ Single Value file container ------ #
singleValues:
keyA: 1
keyB: 0.1
keyC: -1
keyD: NaN
keyE: This is a StRiNg!
# ------ Single Lists file container ------ #
singleLists:
listA:
- 1
- 0.1
- -1
- NaN
- This is a StRiNg!
listB:
- 2
- 0.2
- -2
- nAn
- This is a sTrInG!
# ------ Recursive Lists file container ------ #
recursiveLists:
list1:
list1A:
list1A1:
key1A1A: 1
list1A1A:
- 1
- 2
list1A2:
list1A2A:
key1A2A1: 1
list1A2A1:
- 1
- 2
list1B:
- 1
- 2
list2:
list2A:
key2A1: 1
list2A1:
- 1
- 2
list2B:
key2B1: 1
list2B1:
- 1
- 2
list2C:
key2C1: 1
list2C1:
- 1
- 2
list3:
emptyKey: {}
empytList: []
emptyValue: ''
################################################################################