forked from BigWigsMods/packager
-
Notifications
You must be signed in to change notification settings - Fork 0
/
release.sh
1992 lines (1859 loc) · 63.2 KB
/
release.sh
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
#!/bin/bash
# release.sh generates a zippable addon directory from a Git or SVN checkout.
#
# This is free and unencumbered software released into the public domain.
#
# Anyone is free to copy, modify, publish, use, compile, sell, or
# distribute this software, either in source code form or as a compiled
# binary, for any purpose, commercial or non-commercial, and by any
# means.
#
# In jurisdictions that recognize copyright laws, the author or authors
# of this software dedicate any and all copyright interest in the
# software to the public domain. We make this dedication for the benefit
# of the public at large and to the detriment of our heirs and
# successors. We intend this dedication to be an overt act of
# relinquishment in perpetuity of all present and future rights to this
# software under copyright law.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# For more information, please refer to <http://unlicense.org/>
# add some travis checks so we don't need to do it in the yaml file
if [ -n "$TRAVIS" ]; then
# don't need to run the packager for pull requests
if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
echo "Not packaging pull request."
exit 0
fi
# only want to package tags
if [ -z "$TRAVIS_TAG" ]; then
echo "Not packaging branches."
exit 0
fi
fi
# Script return code
exit_code=0
# Game versions for uploading
game_version=
game_version_id=
# Secrets for uploading
cf_token=$CF_API_KEY
github_token=$GITHUB_OAUTH
wowi_token=$WOWI_API_TOKEN
# Variables set via options.
slug=
addonid=
topdir=
releasedir=
overwrite=
nolib=
line_ending=dos
skip_copying=
skip_externals=
skip_localization=
skip_zipfile=
skip_upload=
# Process command-line options
usage() {
echo "Usage: release.sh [-cdelosuz] [-t topdir] [-r releasedir] [-p curse-id] [-w wowi-id] [-g game-version]" >&2
echo " -c Skip copying files into the package directory." >&2
echo " -d Skip uploading." >&2
echo " -e Skip checkout of external repositories." >&2
echo " -l Skip @localization@ keyword replacement." >&2
echo " -o Keep existing package directory, overwriting its contents." >&2
echo " -s Create a stripped-down \"nolib\" package." >&2
echo " -u Use Unix line-endings." >&2
echo " -z Skip zipfile creation." >&2
echo " -t topdir Set top-level directory of checkout." >&2
echo " -r releasedir Set directory containing the package directory. Defaults to \"\$topdir/.release\"." >&2
echo " -p curse-id Set the project id used on CurseForge for localization and uploading." >&2
echo " -w wowi-id Set the addon id used on WoWInterface for uploading." >&2
echo " -g game-version Set the game version to use for CurseForge and WoWInterface uploading." >&2
}
OPTIND=1
while getopts ":celzusop:dw:r:t:g:" opt; do
case $opt in
c)
# Skip copying files into the package directory.
skip_copying=true
;;
e)
# Skip checkout of external repositories.
skip_externals=true
;;
l)
# Skip @localization@ keyword replacement.
skip_localization=true
;;
d)
# Skip uploading.
skip_upload=true
;;
o)
# Skip deleting any previous package directory.
overwrite=true
;;
p)
slug="$OPTARG"
;;
w)
addonid="$OPTARG"
;;
r)
# Set the release directory to a non-default value.
releasedir="$OPTARG"
;;
s)
# Create a nolib package.
nolib=true
skip_externals=true
;;
t)
# Set the top-level directory of the checkout to a non-default value.
topdir="$OPTARG"
;;
u)
# Skip Unix-to-DOS line-ending translation.
line_ending=unix
;;
z)
# Skip generating the zipfile.
skip_zipfile=true
;;
g)
# Set version (x.y.z)
if [[ "$OPTARG" =~ ^[0-9]+\.[0-9]+\.[0-9]+[a-z]?$ ]]; then
game_version="$OPTARG"
else
echo "Invalid argument for option \"-g\" ($OPTARG)" >&2
usage
exit 1
fi
;;
:)
echo "Option \"-$OPTARG\" requires an argument." >&2
usage
exit 1
;;
\?)
if [ "$OPTARG" != "?" -a "$OPTARG" != "h" ]; then
echo "Unknown option \"-$OPTARG\"." >&2
fi
usage
exit 1
;;
esac
done
shift $((OPTIND - 1))
# Set $topdir to top-level directory of the checkout.
if [ -z "$topdir" ]; then
dir=$( pwd )
if [ -d "$dir/.git" -o -d "$dir/.svn" ]; then
topdir=.
else
dir=${dir%/*}
topdir=..
while [ -n "$dir" ]; do
if [ -d "$topdir/.git" -o -d "$topdir/.svn" ]; then
break
fi
dir=${dir%/*}
topdir="$topdir/.."
done
if [ ! -d "$topdir/.git" -a ! -d "$topdir/.svn" ]; then
echo "No Git or SVN checkout found." >&2
exit 1
fi
fi
fi
# Set $releasedir to the directory which will contain the generated addon zipfile.
if [ -z "$releasedir" ]; then
releasedir="$topdir/.release"
fi
# Set $basedir to the basename of the checkout directory.
basedir=$( cd "$topdir" && pwd )
case $basedir in
/*/*)
basedir=${basedir##/*/}
;;
/*)
basedir=${basedir##/}
;;
esac
# Set $repository_type to "git" or "svn".
repository_type=
if [ -d "$topdir/.git" ]; then
repository_type=git
elif [ -d "$topdir/.svn" ]; then
repository_type=svn
else
echo "No Git or SVN checkout found in \"$topdir\"." >&2
exit 1
fi
# $releasedir must be an absolute path or inside $topdir.
case $releasedir in
/*) ;;
$topdir/*) ;;
*)
echo "The release directory \"$releasedir\" must be an absolute path or inside \"$topdir\"." >&2
exit 1
;;
esac
# Create the staging directory.
mkdir -p "$releasedir"
# Expand $topdir and $releasedir to their absolute paths for string comparisons later.
topdir=$( cd "$topdir" && pwd )
releasedir=$( cd "$releasedir" && pwd )
package=$basedir
tocfile=$( cd "$topdir" && ls *.toc -1 2>/dev/null | head -n 1 )
if [ -f "$topdir/$tocfile" ]; then
# Set the package name from the TOC filename.
package=${tocfile%.toc}
# Parse the TOC file for the title of the project used in the changelog.
project=$( awk '/## Title:/' < "$topdir/$tocfile" | sed -e 's/## Title\s*:\s*\(.*\)\s*/\1/' -e 's/|c[0-9A-Fa-f]\{8\}//g' -e 's/|r//g' )
# Grab CurseForge slug and WoWI ID from the TOC file.
if [ -z "$slug" ]; then
slug=$( awk '/## X-Curse-Project-ID:/ { print $NF }' < "$topdir/$tocfile" )
fi
if [ -z "$addonid" ]; then
addonid=$( awk '/## X-WoWI-ID:/ { print $NF }' < "$topdir/$tocfile" )
fi
fi
###
### set_info_<repo> returns the following information:
###
si_repo_type= # "git" or "svn"
si_repo_dir= # the checkout directory
si_repo_url= # the checkout url
si_tag= # tag for HEAD
si_previous_tag= # previous tag
si_previous_revision= # [SVN] revision number for previous tag
si_project_revision= # Turns into the highest revision of the entire project in integer form, e.g. 1234, for SVN. Turns into the commit count for the project's hash for Git.
si_project_hash= # [Git] Turns into the hash of the entire project in hex form. e.g. 106c634df4b3dd4691bf24e148a23e9af35165ea
si_project_abbreviated_hash= # [Git] Turns into the abbreviated hash of the entire project in hex form. e.g. 106c63f
si_project_author= # Turns into the last author of the entire project. e.g. ckknight
si_project_date_iso= # Turns into the last changed date (by UTC) of the entire project in ISO 8601. e.g. 2008-05-01T12:34:56Z
si_project_date_integer= # Turns into the last changed date (by UTC) of the entire project in a readable integer fashion. e.g. 2008050123456
si_project_timestamp= # Turns into the last changed date (by UTC) of the entire project in POSIX timestamp. e.g. 1209663296
si_project_version= # Turns into an approximate version of the project. The tag name if on a tag, otherwise it's up to the repo. SVN returns something like "r1234", Git returns something like "v0.1-873fc1"
si_file_revision= # Turns into the current revision of the file in integer form, e.g. 1234, for SVN. Turns into the commit count for the file's hash for Git.
si_file_hash= # Turns into the hash of the file in hex form. e.g. 106c634df4b3dd4691bf24e148a23e9af35165ea
si_file_abbreviated_hash= # Turns into the abbreviated hash of the file in hex form. e.g. 106c63
si_file_author= # Turns into the last author of the file. e.g. ckknight
si_file_date_iso= # Turns into the last changed date (by UTC) of the file in ISO 8601. e.g. 2008-05-01T12:34:56Z
si_file_date_integer= # Turns into the last changed date (by UTC) of the file in a readable integer fashion. e.g. 20080501123456
si_file_timestamp= # Turns into the last changed date (by UTC) of the file in POSIX timestamp. e.g. 1209663296
set_info_git() {
si_repo_dir="$1"
si_repo_type="git"
si_repo_url=$( git -C "$si_repo_dir" remote get-url origin 2>/dev/null | sed -e 's/^git@\(.*\):/https:\/\/\1\//' )
if [ -z "$si_repo_url" ]; then # no origin so grab the first fetch url
si_repo_url=$( git -C "$si_repo_dir" remote -v | awk '/(fetch)/ { print $2; exit }' | sed -e 's/^git@\(.*\):/https:\/\/\1\//' )
fi
# Populate filter vars.
si_project_hash=$( git -C "$si_repo_dir" show --no-patch --format="%H" 2>/dev/null )
si_project_abbreviated_hash=$( git -C "$si_repo_dir" show --no-patch --format="%h" 2>/dev/null )
si_project_author=$( git -C "$si_repo_dir" show --no-patch --format="%an" 2>/dev/null )
si_project_timestamp=$( git -C "$si_repo_dir" show --no-patch --format="%at" 2>/dev/null )
si_project_date_iso=$( date -ud "@$si_project_timestamp" -Iseconds 2>/dev/null )
si_project_date_integer=$( date -ud "@$si_project_timestamp" +%Y%m%d%H%M%S 2>/dev/null )
# XXX --depth limits rev-list :\ [ ! -s "$(git rev-parse --git-dir)/shallow" ] || git fetch --unshallow --no-tags
si_project_revision=$( git -C "$si_repo_dir" rev-list --count $si_project_hash 2>/dev/null )
# Get the tag for the HEAD.
si_previous_tag=
si_previous_revision=
_si_tag=$( git -C "$si_repo_dir" describe --tags --always 2>/dev/null )
si_tag=$( git -C "$si_repo_dir" describe --tags --always --abbrev=0 2>/dev/null )
# Set $si_project_version to the version number of HEAD. May be empty if there are no commits.
si_project_version=$si_tag
# The HEAD is not tagged if the HEAD is several commits past the most recent tag.
if [ "$si_tag" = "$si_project_hash" ]; then
# --abbrev=0 expands out the full sha if there was no previous tag
si_project_version=$_si_tag
si_previous_tag=
si_tag=
elif [ "$_si_tag" != "$si_tag" ]; then
si_project_version=$_si_tag
si_previous_tag=$si_tag
si_tag=
else # we're on a tag, just jump back one commit
si_previous_tag=$( git -C "$si_repo_dir" describe --tags --abbrev=0 HEAD~ 2>/dev/null )
fi
}
set_info_svn() {
si_repo_dir="$1"
si_repo_type="svn"
# Temporary file to hold results of "svn info".
_si_svninfo="${si_repo_dir}/.svn/release_sh_svninfo"
svn info -r BASE "$si_repo_dir" 2>/dev/null > "$_si_svninfo"
if [ -s "$_si_svninfo" ]; then
_si_root=$( awk '/^Repository Root:/ { print $3; exit }' < "$_si_svninfo" )
_si_url=$( awk '/^URL:/ { print $2; exit }' < "$_si_svninfo" )
_si_revision=$( awk '/^Last Changed Rev:/ { print $NF; exit }' < "$_si_svninfo" )
si_repo_url=$_si_root
case ${_si_url#${_si_root}/} in
tags/*)
# Extract the tag from the URL.
si_tag=${_si_url#${_si_root}/tags/}
si_tag=${si_tag%%/*}
si_project_revision="$_si_revision"
;;
*)
# Check if the latest tag matches the working copy revision (/trunk checkout instead of /tags)
_si_tag_line=$( svn log --verbose --limit 1 "$_si_root/tags" 2>/dev/null | awk '/^ A/ { print $0; exit }' )
_si_tag=$( echo "$_si_tag_line" | awk '/^ A/ { print $2 }' | awk -F/ '{ print $NF }' )
_si_tag_from_revision=$( echo "$_si_tag_line" | sed -e 's/^.*:\([0-9]\{1,\}\)).*$/\1/' ) # (from /project/trunk:N)
if [ "$_si_tag_from_revision" = "$_si_revision" ]; then
si_tag="$_si_tag"
si_project_revision=$( svn info "$_si_root/tags/$si_tag" 2>/dev/null | awk '/^Last Changed Rev:/ { print $NF; exit }' )
else
# Set $si_project_revision to the highest revision of the project at the checkout path
si_project_revision=$( svn info --recursive "$si_repo_dir" 2>/dev/null | awk '/^Last Changed Rev:/ { print $NF }' | sort -nr | head -1 )
fi
;;
esac
if [ -n "$si_tag" ]; then
si_project_version="$si_tag"
else
si_project_version="r$si_project_revision"
fi
# Get the previous tag and it's revision
_si_limit=$((si_project_revision - 1))
_si_tag=$( svn log --verbose --limit 1 "$_si_root/tags" -r $_si_limit:1 2>/dev/null | awk '/^ A/ { print $0; exit }' | awk '/^ A/ { print $2 }' | awk -F/ '{ print $NF }' )
if [ -n "$_si_tag" ]; then
si_previous_tag="$_si_tag"
si_previous_revision=$( svn info "$_si_root/tags/$_si_tag" 2>/dev/null | awk '/^Last Changed Rev:/ { print $NF; exit }' )
fi
# Populate filter vars.
si_project_author=$( awk '/^Last Changed Author:/ { print $0; exit }' < "$_si_svninfo" | cut -d" " -f4- )
_si_timestamp=$( awk '/^Last Changed Date:/ { print $4,$5,$6; exit }' < "$_si_svninfo" )
si_project_timestamp=$( date -ud "$_si_timestamp" +%s 2>/dev/null )
si_project_date_iso=$( date -ud "$_si_timestamp" -Iseconds 2>/dev/null )
si_project_date_integer=$( date -ud "$_si_timestamp" +%Y%m%d%H%M%S 2>/dev/null )
# SVN repositories have no project hash.
si_project_hash=
si_project_abbreviated_hash=
rm -f "$_si_svninfo" 2>/dev/null
fi
}
set_info_file() {
if [ "$si_repo_type" = "git" ]; then
_si_file=${1#si_repo_dir} # need the path relative to the checkout
# Populate filter vars from the last commit the file was included in.
si_file_hash=$( git -C "$si_repo_dir" log --max-count=1 --format="%H" "$_si_file" 2>/dev/null )
si_file_abbreviated_hash=$( git -C "$si_repo_dir" log --max-count=1 --format="%h" "$_si_file" 2>/dev/null )
si_file_author=$( git -C "$si_repo_dir" log --max-count=1 --format="%an" "$_si_file" 2>/dev/null )
si_file_timestamp=$( git -C "$si_repo_dir" log --max-count=1 --format="%at" "$_si_file" 2>/dev/null )
si_file_date_iso=$( date -ud "@$si_file_timestamp" -Iseconds 2>/dev/null )
si_file_date_integer=$( date -ud "@$si_file_timestamp" +%Y%m%d%H%M%S 2>/dev/null )
si_file_revision=$( git -C "$si_repo_dir" rev-list --count $si_file_hash 2>/dev/null )
elif [ "$si_repo_type" = "svn" ]; then
_si_file="$1"
# Temporary file to hold results of "svn info".
_sif_svninfo="${si_repo_dir}/.svn/release_sh_svnfinfo"
svn info "$_si_file" 2>/dev/null > "$_sif_svninfo"
if [ -s "$_sif_svninfo" ]; then
# Populate filter vars.
si_file_revision=$( awk '/^Last Changed Rev:/ { print $NF; exit }' < "$_sif_svninfo" )
si_file_author=$( awk '/^Last Changed Author:/ { print $0; exit }' < "$_sif_svninfo" | cut -d" " -f4- )
_si_timestamp=$( awk '/^Last Changed Date:/ { print $4,$5,$6; exit }' < "$_sif_svninfo" )
si_file_timestamp=$( date -ud "$_si_timestamp" +%s 2>/dev/null )
si_file_date_iso=$( date -ud "$_si_timestamp" -Iseconds 2>/dev/null )
si_file_date_integer=$( date -ud "$_si_timestamp" +%Y%m%d%H%M%S 2>/dev/null )
# SVN repositories have no project hash.
si_file_hash=
si_file_abbreviated_hash=
rm -f "$_sif_svninfo" 2>/dev/null
fi
fi
}
# Set some version info about the project
case $repository_type in
git) set_info_git "$topdir" ;;
svn) set_info_svn "$topdir" ;;
esac
tag=$si_tag
project_version=$si_project_version
previous_version=$si_previous_tag
project_hash=$si_project_hash
project_revision=$si_project_revision
previous_revision=$si_previous_revision
project_timestamp=$si_project_timestamp
project_github_url=
project_github_slug=
if [[ "$si_repo_url" == "https://github.com"* ]]; then
project_github_url=${si_repo_url%.git}
project_github_slug=${project_github_url#https://github.com/}
fi
# Set the slug for cf/wowace checkouts.
if [ -z "$slug" ] && [[ "$si_repo_url" == *"curseforge.com"* || "$si_repo_url" == *"wowace.com"* ]]; then
slug=${si_repo_url#*/wow/}
slug=${slug%%/*}
fi
# The default slug is the lowercase basename of the checkout directory.
if [ -z "$slug" ]; then
slug=$( echo "$basedir" | tr '[:upper:].' '[:lower:]-' )
fi
# Set the Curse project site
if [[ "$slug" =~ ^[0-9]+$ ]]; then
# There is no good way of differentiating between sites short of using different TOC fields for CF and WowAce
# Curse does redirect to the proper site when using the project id, so we'll use that to get the API url
_ul_test_url="https://wow.curseforge.com/projects/$slug"
_ul_test_url_result=$( curl -s -L -w "%{url_effective}" -o /dev/null $_ul_test_url )
if [ "$_ul_test_url" != "$_ul_test_url_result" ]; then
project_site=${_ul_test_url_result%%/project*}
fi
fi
# Bare carriage-return character.
carriage_return=$( printf "\r" )
# Returns 0 if $1 matches one of the colon-separated patterns in $2.
match_pattern() {
_mp_file=$1
_mp_list="$2:"
while [ -n "$_mp_list" ]; do
_mp_pattern=${_mp_list%%:*}
_mp_list=${_mp_list#*:}
case $_mp_file in
$_mp_pattern)
return 0
;;
esac
done
return 1
}
# Simple .pkgmeta YAML processor.
yaml_keyvalue() {
yaml_key=${1%%:*}
yaml_value=${1#$yaml_key:}
yaml_value=${yaml_value#"${yaml_value%%[! ]*}"} # trim leading whitespace
yaml_value=${yaml_value#[\'\"]} # trim leading quotes
yaml_value=${yaml_value%[\'\"]} # trim trailing quotes
}
yaml_listitem() {
yaml_item=${1#-}
yaml_item=${yaml_item#"${yaml_item%%[! ]*}"} # trim leading whitespace
}
###
### Process .pkgmeta to set variables used later in the script.
###
# Variables set via .pkgmeta.
manual_changelog=
changelog=
changelog_markup="plain"
enable_nolib_creation=
ignore=
license=
contents=
nolib_exclude=
wowi_gen_changelog=true
wowi_archive=true
if [ -f "$topdir/.pkgmeta" ]; then
yaml_eof=
while [ -z "$yaml_eof" ]; do
IFS='' read -r yaml_line || yaml_eof=true
# Strip any trailing CR character.
yaml_line=${yaml_line%$carriage_return}
case $yaml_line in
[!\ ]*:*)
# Split $yaml_line into a $yaml_key, $yaml_value pair.
yaml_keyvalue "$yaml_line"
# Set the $pkgmeta_phase for stateful processing.
pkgmeta_phase=$yaml_key
case $yaml_key in
enable-nolib-creation)
if [ "$yaml_value" = "yes" ]; then
enable_nolib_creation=true
fi
;;
license-output)
license=$yaml_value
;;
manual-changelog)
changelog=$yaml_value
manual_changelog=true
;;
package-as)
package=$yaml_value
;;
wowi-create-changelog)
if [ "$yaml_value" = "no" ]; then
wowi_gen_changelog=
fi
;;
wowi-archive-previous)
if [ "$yaml_value" = "no" ]; then
wowi_archive=
fi
;;
esac
;;
" "*)
yaml_line=${yaml_line#"${yaml_line%%[! ]*}"} # trim leading whitespace
case $yaml_line in
"- "*)
# Get the YAML list item.
yaml_listitem "$yaml_line"
case $pkgmeta_phase in
ignore)
pattern=$yaml_item
if [ -d "$topdir/$pattern" ]; then
pattern="$pattern/*"
fi
if [ -z "$ignore" ]; then
ignore="$pattern"
else
ignore="$ignore:$pattern"
fi
;;
esac
;;
*:*)
# Split $yaml_line into a $yaml_key, $yaml_value pair.
yaml_keyvalue "$yaml_line"
case $pkgmeta_phase in
manual-changelog)
case $yaml_key in
filename)
changelog=$yaml_value
manual_changelog=true
;;
markup-type)
changelog_markup=$yaml_value
;;
esac
;;
esac
;;
esac
;;
esac
done < "$topdir/.pkgmeta"
fi
# Add untracked/ignored files to the ignore list
if [ "$repository_type" = "git" ]; then
_vcs_ignore=$( git -C "$topdir" ls-files --others | sed -e ':a' -e 'N' -e 's/\n/:/' -e 'ta' )
if [ -n "$_vcs_ignore" ]; then
if [ -z "$ignore" ]; then
ignore="$_vcs_ignore"
else
ignore="$ignore:$_vcs_ignore"
fi
fi
elif [ "$repository_type" = "svn" ]; then
# svn always being difficult.
OLDIFS=$IFS
IFS=$'\n'
for _vcs_ignore in $( cd "$topdir" && svn status --no-ignore --ignore-externals | awk '/^[?IX]/' | cut -c9- | tr '\\' '/' ); do
if [ -d "$topdir/$_vcs_ignore" ]; then
_vcs_ignore="$_vcs_ignore/*"
fi
if [ -z "$ignore" ]; then
ignore="$_vcs_ignore"
else
ignore="$ignore:$_vcs_ignore"
fi
done
IFS=$OLDIFS
fi
echo
if [ -z "$nolib" ]; then
echo "Packaging $package"
else
echo "Packaging $package (nolib)"
fi
if [ -n "$project_version" ]; then
echo "Current version: $project_version"
fi
if [ -n "$previous_version" ]; then
echo "Previous version: $previous_version"
fi
if [ -n "$slug" ]; then
if [ "$project_site" == "https://www.wowace.com" ]; then
echo "WowAce ID: $slug${cf_token:+ [token set]}"
else
echo "CurseForge ID: $slug${cf_token:+ [token set]}"
fi
fi
if [ -n "$addonid" ]; then
echo "WoWInterface ID: $addonid${wowi_token:+ [token set]}"
fi
if [ -n "$project_github_slug" ]; then
echo "GitHub: $project_github_slug${github_token:+ [token set]}"
fi
echo
echo "Checkout directory: $topdir"
echo "Release directory: $releasedir"
echo
# Set $pkgdir to the path of the package directory inside $releasedir.
pkgdir="$releasedir/$package"
if [ -d "$pkgdir" -a -z "$overwrite" ]; then
#echo "Removing previous package directory: $pkgdir"
rm -fr "$pkgdir"
fi
if [ ! -d "$pkgdir" ]; then
mkdir -p "$pkgdir"
fi
# Set the contents of the addon zipfile.
contents="$package"
###
### Create filters for pass-through processing of files to replace repository keywords.
###
# Filter for simple repository keyword replacement.
simple_filter() {
sed \
-e "s/@project-revision@/$si_project_revision/g" \
-e "s/@project-hash@/$si_project_hash/g" \
-e "s/@project-abbreviated-hash@/$si_project_abbreviated_hash/g" \
-e "s/@project-author@/$si_project_author/g" \
-e "s/@project-date-iso@/$si_project_date_iso/g" \
-e "s/@project-date-integer@/$si_project_date_integer/g" \
-e "s/@project-timestamp@/$si_project_timestamp/g" \
-e "s/@project-version@/$si_project_version/g" \
-e "s/@file-revision@/$si_file_revision/g" \
-e "s/@file-hash@/$si_file_hash/g" \
-e "s/@file-abbreviated-hash@/$si_file_abbreviated_hash/g" \
-e "s/@file-author@/$si_file_author/g" \
-e "s/@file-date-iso@/$si_file_date_iso/g" \
-e "s/@file-date-integer@/$si_file_date_integer/g" \
-e "s/@file-timestamp@/$si_file_timestamp/g"
}
# Find URL of localization api.
set_localization_url() {
localization_url=
if [ -n "$slug" -a -n "$cf_token" -a -n "$project_site" ]; then
localization_url="${project_site}/api/projects/$slug/localization/export"
fi
if [ -z "$localization_url" ]; then
echo "Skipping localization! Missing CurseForge API token and/or project id is invalid."
echo
fi
}
# Filter to handle @localization@ repository keyword replacement.
# https://www.curseforge.com/knowledge-base/world-of-warcraft/531-localization-substitutions
declare -A unlocalized_values=( ["english"]="ShowPrimary" ["comment"]="ShowPrimaryAsComment" ["blank"]="ShowBlankAsComment" ["ignore"]="Ignore" )
localization_filter() {
_ul_eof=
while [ -z "$_ul_eof" ]; do
IFS='' read -r _ul_line || _ul_eof=true
# Strip any trailing CR character.
_ul_line=${_ul_line%$carriage_return}
case $_ul_line in
*@localization\(*\)@*)
_ul_lang=
_ul_namespace=
_ul_singlekey=
_ul_tablename="L"
# Get the prefix of the line before the comment.
_ul_prefix=${_ul_line%%@localization(*}
_ul_prefix=${_ul_prefix%%--*}
# Strip everything but the localization parameters.
_ul_params=${_ul_line#*@localization(}
_ul_params=${_ul_params%)@}
# Sanitize the params a bit. (namespaces are restricted to [a-zA-Z0-9_], separated by [./:])
_ul_params=${_ul_params// /}
_ul_params=${_ul_params//,/, }
# Pull the locale language first (mainly for warnings).
_ul_lang="enUS"
if [[ $_ul_params == *"locale=\""* ]]; then
_ul_lang=${_ul_params##*locale=\"}
_ul_lang=${_ul_lang:0:4}
_ul_lang=${_ul_lang%%\"*}
else
echo " Warning! No locale set, using enUS." >&2
fi
# Generate a URL parameter string from the localization parameters. https://www.curseforge.com/docs/api
_ul_url_params=""
set -- ${_ul_params}
for _ul_param; do
_ul_key=${_ul_param%%=*}
_ul_value=${_ul_param#*=}
_ul_value=${_ul_value%,*}
_ul_value=${_ul_value#*\"}
_ul_value=${_ul_value%\"*}
case ${_ul_key} in
escape-non-ascii)
if [ "$_ul_value" = "true" ]; then
_ul_url_params="${_ul_url_params}&escape-non-ascii-characters=true"
fi
;;
format)
if [ "$_ul_value" = "lua_table" ]; then
_ul_url_params="${_ul_url_params}&export-type=Table"
fi
;;
handle-unlocalized)
if [ "$_ul_value" != "english" -a -n "${unlocalized_values[$_ul_value]}" ]; then
_ul_url_params="${_ul_url_params}&unlocalized=${unlocalized_values[$_ul_value]}"
fi
;;
handle-subnamespaces)
if [ "$_ul_value" = "concat" ]; then # concat with /
_ul_url_params="${_ul_url_params}&concatenante-subnamespaces=true"
elif [ "$_ul_value" = "subtable" ]; then
echo " ($_ul_lang) Warning! ${_ul_key}=\"${_ul_value}\" is not supported. Include each full subnamespace, comma delimited." >&2
fi
;;
key)
# _ul_params was stripped of spaces, so reparse the line for the key
_ul_singlekey=${_ul_line#*@localization(}
_ul_singlekey=${_ul_singlekey#*key=\"}
_ul_singlekey=${_ul_singlekey%%\",*}
_ul_singlekey=${_ul_singlekey%%\")@*}
;;
locale)
_ul_lang=$_ul_value
;;
namespace)
# reparse to get all namespaces if multiple
_ul_namespace=${_ul_params##*namespace=\"}
_ul_namespace=${_ul_namespace%%\"*}
_ul_namespace=${_ul_namespace//, /,}
_ul_url_params="${_ul_url_params}&namespaces=${_ul_namespace}"
_ul_namespace="/${_ul_namespace}"
;;
namespace-delimiter)
if [ "$_ul_value" != "/" ]; then
echo " ($_ul_lang) Warning! ${_ul_key}=\"${_ul_value}\" is not supported." >&2
fi
;;
prefix-values)
echo " ($_ul_lang) Warning! \"${_ul_key}\" is not supported." >&2
;;
same-key-is-true)
if [ "$_ul_value" = "true" ]; then
_ul_url_params="${_ul_url_params}&true-if-value-equals-key=true"
fi
;;
table-name)
if [ "$_ul_value" != "L" ]; then
_ul_tablename="$_ul_value"
_ul_url_params="${_ul_url_params}&table-name=${_ul_value}"
fi
;;
esac
done
if [ -z "$_cdt_localization" -o -z "$localization_url" ]; then
echo " Skipping localization (${_ul_lang}${_ul_namespace})" >&2
# If the line isn't a TOC entry, print anything before the keyword.
if [[ $_ul_line != "## "* ]]; then
if [ -n "$_ul_eof" ]; then
echo -n "$_ul_prefix"
else
echo "$_ul_prefix"
fi
fi
else
_ul_url="${localization_url}?lang=${_ul_lang}${_ul_url_params}"
echo " Adding ${_ul_lang}${_ul_namespace}" >&2
if [ -z "$_ul_singlekey" ]; then
# Write text that preceded the substitution.
echo -n "$_ul_prefix"
# Fetch the localization data, but don't output anything if there is an error.
curl -s -H "x-api-token: $cf_token" "${_ul_url}" | awk -v url="$_ul_url" '/^{"error/ { o=" Error! "$0"\n "url; print o >"/dev/stderr"; exit 1 } /<!DOCTYPE/ { print " Error! Invalid output\n "url >"/dev/stderr"; exit 1 } /^'"$_ul_tablename"' = '"$_ul_tablename"' or \{\}/ { next } { print }'
# Insert a trailing blank line to match CF packager.
if [ -z "$_ul_eof" ]; then
echo ""
fi
else
# Parse out a single phrase. This is kind of expensive, but caching would be way too much effort to optimize for what is basically an edge case.
_ul_value=$( curl -s -H "x-api-token: $cf_token" "${_ul_url}" | awk -v url="$_ul_url" '/^{"error/ { o=" Error! "$0"\n "url; print o >"/dev/stderr"; exit 1 } /<!DOCTYPE/ { print " Error! Invalid output\n "url >"/dev/stderr"; exit 1 } { print }' | sed -n '/L\["'"$_ul_singlekey"'"\]/p' | sed 's/^.* = "\(.*\)"/\1/' )
if [ -n "$_ul_value" -a "$_ul_value" != "$_ul_singlekey" ]; then
# The result is different from the base value so print out the line.
echo "${_ul_prefix}${_ul_value}${_ul_line##*)@}"
fi
fi
fi
;;
*)
if [ -n "$_ul_eof" ]; then
echo -n "$_ul_line"
else
echo "$_ul_line"
fi
esac
done
}
lua_filter() {
sed \
-e "s/--@$1@/--[===[@$1@/g" \
-e "s/--@end-$1@/--@end-$1@]===]/g" \
-e "s/--\[===\[@non-$1@/--@non-$1@/g" \
-e "s/--@end-non-$1@\]===\]/--@end-non-$1@/g"
}
toc_filter() {
_trf_token=$1; shift
_trf_comment=
_trf_eof=
while [ -z "$_trf_eof" ]; do
IFS='' read -r _trf_line || _trf_eof=true
# Strip any trailing CR character.
_trf_line=${_trf_line%$carriage_return}
_trf_passthrough=
case $_trf_line in
"#@${_trf_token}@"*)
_trf_comment="# "
_trf_passthrough=true
;;
"#@end-${_trf_token}@"*)
_trf_comment=
_trf_passthrough=true
;;
esac
if [ -z "$_trf_passthrough" ]; then
_trf_line="$_trf_comment$_trf_line"
fi
if [ -n "$_trf_eof" ]; then
echo -n "$_trf_line"
else
echo "$_trf_line"
fi
done
}
xml_filter() {
sed \
-e "s/<!--@$1@-->/<!--@$1/g" \
-e "s/<!--@end-$1@-->/@end-$1@-->/g" \
-e "s/<!--@non-$1@/<!--@non-$1@-->/g" \
-e "s/@end-non-$1@-->/<!--@end-non-$1@-->/g"
}
do_not_package_filter() {
_dnpf_token=$1; shift
_dnpf_string="do-not-package"
_dnpf_start_token=
_dnpf_end_token=
case $_dnpf_token in
lua)
_dnpf_start_token="--@$_dnpf_string@"
_dnpf_end_token="--@end-$_dnpf_string@"
;;
toc)
_dnpf_start_token="#@$_dnpf_string@"
_dnpf_end_token="#@end-$_dnpf_string@"
;;
xml)
_dnpf_start_token="<!--@$_dnpf_string@-->"
_dnpf_end_token="<!--@end-$_dnpf_string@-->"
;;
esac
if [ -z "$_dnpf_start_token" -o -z "$_dnpf_end_token" ]; then
cat
else
# Replace all content between the start and end tokens, inclusive, with a newline to match CF packager.
_dnpf_eof=
_dnpf_skip=
while [ -z "$_dnpf_eof" ]; do
IFS='' read -r _dnpf_line || _dnpf_eof=true
# Strip any trailing CR character.
_dnpf_line=${_dnpf_line%$carriage_return}
case $_dnpf_line in
*$_dnpf_start_token*)
_dnpf_skip=true
echo -n "${_dnpf_line%%${_dnpf_start_token}*}"
;;
*$_dnpf_end_token*)
_dnpf_skip=
if [ -z "$_dnpf_eof" ]; then
echo ""
fi
;;
*)
if [ -z "$_dnpf_skip" ]; then
if [ -n "$_dnpf_eof" ]; then
echo -n "$_dnpf_line"
else
echo "$_dnpf_line"
fi
fi
;;
esac
done
fi
}
line_ending_filter() {
_lef_eof=
while [ -z "$_lef_eof" ]; do
IFS='' read -r _lef_line || _lef_eof=true
# Strip any trailing CR character.
_lef_line=${_lef_line%$carriage_return}
if [ -n "$_lef_eof" ]; then
# Preserve EOF not preceded by newlines.
echo -n "$_lef_line"
else
case $line_ending in
dos)
# Terminate lines with CR LF.
printf "%s\r\n" "$_lef_line"
;;
unix)
# Terminate lines with LF.
printf "%s\n" "$_lef_line"
;;
esac
fi
done
}
###
### Copy files from the working directory into the package directory.
###
# Copy of the contents of the source directory into the destination directory.
# Dotfiles and any files matching the ignore pattern are skipped. Copied files
# are subject to repository keyword replacement.
#
copy_directory_tree() {
_cdt_alpha=
_cdt_debug=
_cdt_ignored_patterns=
_cdt_localization=
_cdt_nolib=
_cdt_do_not_package=
_cdt_unchanged_patterns=
OPTIND=1
while getopts :adi:lnpu: _cdt_opt "$@"; do
case $_cdt_opt in
a) _cdt_alpha=true ;;
d) _cdt_debug=true ;;
i) _cdt_ignored_patterns=$OPTARG ;;
l) _cdt_localization=true
set_localization_url
;;
n) _cdt_nolib=true ;;
p) _cdt_do_not_package=true ;;
u) _cdt_unchanged_patterns=$OPTARG ;;
esac
done
shift $((OPTIND - 1))
_cdt_srcdir=$1
_cdt_destdir=$2
echo "Copying files into ${_cdt_destdir#$topdir/}:"