-
Notifications
You must be signed in to change notification settings - Fork 27
/
Copy pathrecipe_generator.py
1789 lines (1568 loc) · 67.2 KB
/
recipe_generator.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/local/autopkg/python
# This Python file uses the following encoding: utf-8
# Recipe Robot
# Copyright 2015-2020 Elliot Jordan, Shea G. Craig, and Eldon Ahrold
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""recipe_generator.py.
This module of Recipe Robot uses the facts collected by the main script
to create autopkg recipes for the specified app.
"""
# TODO: refactor code issuing warnings about missing processors/repos.
# pylint: disable=no-member
from __future__ import absolute_import
import os
from . import processor
from .exceptions import RoboError
from .tools import (
SUPPORTED_ARCHIVE_FORMATS,
SUPPORTED_BUNDLE_TYPES,
SUPPORTED_IMAGE_FORMATS,
SUPPORTED_INSTALL_FORMATS,
LogLevel,
create_dest_dirs,
create_existing_recipe_list,
extract_app_icon,
get_bundle_name_info,
get_exitcode_stdout_stderr,
recipe_dirpath,
robo_join,
robo_print,
save_user_defaults,
strip_dev_suffix,
timed,
)
@timed
def generate_recipes(facts, prefs):
"""Generate the selected types of recipes.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
prefs (dict): The dictionary containing a key/value pair for Recipe Robot
preferences.
Raises:
RoboError: Standard exception raised when Recipe Robot cannot proceed.
"""
recipes = facts["recipes"]
# A bundle name key like "app_name" or "prefpane_name" is required, because
# it's strong evidence that we have enough facts to create a recipe set.
bundle_type, bundle_name_key = get_bundle_name_info(facts)
if bundle_name_key:
if not facts["args"].ignore_existing:
create_existing_recipe_list(facts)
else:
raise RoboError(
"I wasn't able to gather enough information about "
"this app to make recipes. If you saw any warnings "
"above, they may contain more specific information."
)
preferred = [recipe for recipe in recipes if recipe["preferred"]]
raise_if_recipes_cannot_be_generated(facts, preferred)
# We have enough information to create a recipe set, but with assumptions.
# TODO: This code may not be necessary if inspections do their job.
if "codesign_reqs" not in facts and "codesign_authorities" not in facts:
facts["reminders"].append(
"I can't tell whether this app is codesigned or not, so I'm "
"going to assume it's not. You may want to verify that yourself "
"and add the CodeSignatureVerifier processor if necessary."
)
facts["codesign_reqs"] = ""
facts["codesign_authorities"] = []
if "version_key" not in facts:
facts["reminders"].append(
"I can't tell whether to use CFBundleShortVersionString or "
"CFBundleVersion for the version key of this app. Most apps use "
"CFBundleShortVersionString, so that's what I'll use. You may "
"want to verify that and modify the recipes if necessary."
)
facts["version_key"] = "CFBundleShortVersionString"
# TODO: Run `autopkg repo-list` once and store the resulting value
# for future use when detecting missing required repos, rather than running
# `autopkg repo-list` separately during each check. (For example, the
# FileWaveImporter repo must be present to run created filewave recipes.)
# Prepare the destination directory.
recipe_dest_dir = recipe_dirpath(
facts[bundle_name_key], facts.get("developer", None), prefs
)
facts["recipe_dest_dir"] = recipe_dest_dir
create_dest_dirs(recipe_dest_dir)
build_recipes(facts, preferred, prefs)
# TODO: As far as I can tell, the only pref that changes is the
# recipe created count. Move out from here!
# Save preferences to disk for next time.
save_user_defaults(prefs)
def raise_if_recipes_cannot_be_generated(facts, preferred):
"""Raise a RoboError if recipes cannot be generated.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
preferred ([str]): List of strings representing our preferred recipe
types. If none are provided, we cannot produce recipes.
Raises:
RoboError: Standard exception raised when Recipe Robot cannot proceed.
"""
# No recipe types are preferred.
if not preferred:
raise RoboError("Sorry, no recipes available to generate.")
# We don't have enough information to create a recipe set.
if not facts.is_from_app_store() and not any(
[
key in facts
for key in ("sparkle_feed", "github_repo", "sourceforge_id", "download_url")
]
):
raise RoboError(
"Sorry, I don't know how to download this app. Maybe "
"try another angle? The app's developer might have a direct "
"download URL on their website, for example."
)
if not facts.is_from_app_store() and "download_format" not in facts:
raise RoboError(
"Sorry, I can't tell what format this app downloads in. It "
"doesn't seem to be a dmg, zip, or pkg."
)
def required_repo_reminder(repo_name, repo_url, facts):
"""Print a reminder if a required repo is not already added.
Args:
repo_name (str): Name of repo to issue reminder to add.
repo_url (str): URL to the repo, to use with `autopkg repo-add`.
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
"""
cmd = "/usr/local/bin/autopkg repo-list"
exitcode, out, err = get_exitcode_stdout_stderr(cmd)
if not any(
(line.endswith("(%s)" % repo_url) or line.endswith("(%s.git)" % repo_url))
for line in out.splitlines()
):
facts["reminders"].append(
"You'll need to add the %s repo in order to use "
"this recipe:\n autopkg repo-add "
'"%s"' % (repo_name, repo_url)
)
def build_recipes(facts, preferred, prefs):
"""Create a recipe for each preferred type we know about.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
preferred ([str]): List of strings representing our preferred recipe
types. If none are provided, we cannot produce recipes.
prefs (dict): The dictionary containing a key/value pair for Recipe Robot
preferences.
"""
recipe_dest_dir = facts["recipe_dest_dir"]
bundle_type, bundle_name_key = get_bundle_name_info(facts)
for recipe in preferred:
keys = recipe["keys"]
keys["Input"]["NAME"] = facts[bundle_name_key]
# Set the recipe filename (spaces are OK).
if recipe["type"] == "jamf":
recipe["filename"] = "%s-pkg-upload.%s.recipe" % (
facts[bundle_name_key],
recipe["type"],
)
else:
recipe["filename"] = "%s.%s.recipe" % (
facts[bundle_name_key],
recipe["type"],
)
# Set the recipe identifier.
clean_name = facts[bundle_name_key].replace(" ", "").replace("+", "Plus")
keys["Identifier"] = "%s.%s.%s" % (
prefs["RecipeIdentifierPrefix"],
recipe["type"],
clean_name,
)
# If the name of the app bundle differs from the name of the app
# itself, we need another input variable for that.
if "app_file" in facts:
keys["Input"]["APP_FILENAME"] = facts["app_file"]
facts["app_name_key"] = "%APP_FILENAME%"
else:
facts["app_name_key"] = "%NAME%"
# Set keys specific to download recipes.
generation_func = get_generation_func(facts, prefs, recipe)
if not generation_func:
facts["warnings"].append(
"Oops, I think my programmer messed up. I don't yet know how "
"to generate a %s recipe. Sorry about that." % recipe["type"]
)
else:
recipe = generation_func(facts, prefs, recipe)
if recipe:
if prefs.get("RecipeFormat") not in ("plist", None):
dest_path = robo_join(
recipe_dest_dir, recipe["filename"] + "." + prefs["RecipeFormat"]
)
else:
dest_path = robo_join(recipe_dest_dir, recipe["filename"])
if not os.path.exists(dest_path):
count = prefs.get("RecipeCreateCount", 0)
prefs["RecipeCreateCount"] = count + 1
recipe.write(dest_path, prefs.get("RecipeFormat"))
robo_print(dest_path, LogLevel.LOG, 4)
facts["recipes"].append(dest_path)
def get_generation_func(facts, prefs, recipe):
"""Return the correct generation function based on type.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
prefs (dict): The dictionary containing a key/value pair for Recipe Robot
preferences.
recipe (Recipe): Object representing the recipe being generated.
Returns:
str: String representing the function that is used to generate this
recipe type.
"""
if recipe["type"] not in prefs["RecipeTypes"]:
return None
func_name = ["generate", recipe["type"].replace("-", "_"), "recipe"]
if recipe["type"] in ("munki", "pkg") and facts.is_from_app_store():
func_name.insert(1, "app_store")
# TODO: This is a hack until I can use AbstractFactory for this.
generation_func = globals()["_".join(func_name)]
return generation_func
def generate_download_recipe(facts, prefs, recipe):
"""Generate a download recipe based on passed recipe dict.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
prefs (dict): The dictionary containing a key/value pair for Recipe Robot
preferences.
recipe (Recipe): The recipe to operate on. This recipe will be mutated
by this function.
Returns:
Recipe: Newly updated Recipe object suitable for converting to plist.
"""
# TODO: Handle signed or unsigned pkgs wrapped in dmgs or zips.
bundle_type, bundle_name_key = get_bundle_name_info(facts)
if facts.is_from_app_store():
warn_about_app_store_generation(facts, recipe["type"])
return
robo_print("Generating %s recipe..." % recipe["type"])
recipe.set_description(
"Downloads the latest version of %s." % facts[bundle_name_key]
)
# TODO: Extract method(s) to get_source_processor()
if "barebones_product" in facts:
BarebonesURLProvider = processor.ProcessorFactory(
"com.github.autopkg.download.bbedit/BarebonesURLProvider",
("product_name",),
)
bb_url_provider = BarebonesURLProvider(
product_name=facts["barebones_product"],
)
recipe.append_processor(bb_url_provider)
if not os.path.exists(
os.path.expanduser(
"~/Library/AutoPkg/RecipeRepos/com.github.autopkg."
"recipes/Barebones/BarebonesURLProvider.py"
)
):
facts["reminders"].append(
"The download recipe I created uses the "
"BarebonesURLProvider processor, which is not in the "
"AutoPkg core. You'll need to add the appropriate repository "
"before running the recipe:\n"
" autopkg repo-add recipes"
)
elif "sparkle_feed" in facts:
sparkle_processor = processor.SparkleUpdateInfoProvider(
appcast_url=facts["sparkle_feed"]
)
if "user-agent" in facts:
sparkle_processor.appcast_request_headers = {
"user-agent": facts["user-agent"]
}
recipe.append_processor(sparkle_processor)
# TODO: Extract method(s) to get_source_processor()
elif "github_repo" in facts:
if facts.get("use_asset_regex", False):
gh_release_info_provider = processor.GitHubReleasesInfoProvider(
asset_regex=".*\\.%s$" % facts["download_format"],
github_repo=facts["github_repo"],
)
else:
gh_release_info_provider = processor.GitHubReleasesInfoProvider(
github_repo=facts["github_repo"]
)
recipe.append_processor(gh_release_info_provider)
# TODO: Extract method(s) to get_source_processor()
elif "sourceforge_id" in facts:
SourceForgeURLProvider = processor.ProcessorFactory(
"com.github.jessepeterson.munki.GrandPerspective/SourceForgeURLProvider",
("SOURCEFORGE_FILE_PATTERN", "SOURCEFORGE_PROJECT_ID"),
)
sf_url_provider = SourceForgeURLProvider(
SOURCEFORGE_FILE_PATTERN="\\.%s\\/download$" % facts["download_format"],
SOURCEFORGE_PROJECT_ID=facts["sourceforge_id"],
)
recipe.append_processor(sf_url_provider)
if not os.path.exists(
os.path.expanduser(
"~/Library/AutoPkg/RecipeRepos/com.github.autopkg."
"jessepeterson-recipes/GrandPerspective/"
"SourceForgeURLProvider.py"
)
):
facts["reminders"].append(
"The download recipe I created uses the "
"SourceForgeURLProvider processor, which is not in the "
"AutoPkg core. You'll need to add the appropriate repository "
"before running the recipe:\n"
" autopkg repo-add jessepeterson-recipes"
)
url_downloader = processor.URLDownloader()
if "download_url" in facts:
if facts.get("sparkle_provides_version") or "github_repo" in facts:
# Sparkle and GitHub provide version information.
url_downloader.filename = "%NAME%-%version%.{}".format(
facts["download_format"]
)
elif "sourceforge_id" in facts:
# SourceForge does not provide reliable version information, but signed apps
# are generally handled with a Versioner or AppDmgVersioner processor.
url_downloader.filename = "%NAME%.{}".format(facts["download_format"])
if not facts.get("codesign_reqs") and not facts.get("codesign_authorities"):
# If no signing, chances are low that we have version information.
if facts["download_format"] in SUPPORTED_ARCHIVE_FORMATS:
facts["warnings"].append(
"I couldn't a reliable source of version information. You may need to "
"manually add Unarchiver and Versioner processors "
"to your download recipe."
)
if facts["download_format"] in SUPPORTED_IMAGE_FORMATS:
facts["warnings"].append(
"I couldn't a reliable source of version information. You may need to "
"manually add a Versioner or AppDmgVersioner processor "
"to your download recipe."
)
if facts["download_format"] in SUPPORTED_INSTALL_FORMATS:
facts["warnings"].append(
"I couldn't a reliable source of version information. You may need to "
"manually add FlatPkgUnpacker and Versioner processors "
"to your download recipe."
)
else:
url_downloader.url = facts["download_url"]
url_downloader.filename = "%NAME%.{}".format(facts["download_format"])
if "user-agent" in facts:
url_downloader.request_headers = {"user-agent": facts["user-agent"]}
recipe.append_processor(url_downloader)
end_of_check_phase = processor.EndOfCheckPhase()
recipe.append_processor(end_of_check_phase)
# TODO: Refactor to get_codesigning and get_unarchiver funcs.
if facts.get("codesign_reqs") or facts.get("codesign_authorities"):
if facts["download_format"] in SUPPORTED_ARCHIVE_FORMATS:
unarchiver = processor.Unarchiver()
unarchiver.archive_path = "%pathname%"
unarchiver.destination_path = "%RECIPE_CACHE_DIR%/%NAME%"
unarchiver.purge_destination = True
recipe.append_processor(unarchiver)
if facts["download_format"] in SUPPORTED_IMAGE_FORMATS:
# We're assuming that the app is at the root level of the dmg.
input_path = "%pathname%/{}{}".format(
facts.get("relative_path", ""), facts["codesign_input_filename"]
)
elif facts["download_format"] in SUPPORTED_ARCHIVE_FORMATS:
input_path = "%RECIPE_CACHE_DIR%/%NAME%/{}{}".format(
facts.get("relative_path", ""), facts["codesign_input_filename"]
)
elif facts["download_format"] in SUPPORTED_INSTALL_FORMATS:
# The download is in pkg format, and the pkg is signed.
# TODO: Need a few test cases to prove this works.
input_path = "%pathname%"
else:
facts["warnings"].append(
"CodeSignatureVerifier cannot be created. "
"The download format is not recognized."
)
input_path = None
if input_path:
codesigverifier = get_code_signature_verifier(input_path, facts)
recipe.append_processor(codesigverifier)
# TODO: Extract method -> get_versioner
if needs_versioner(facts):
versioner = processor.Versioner()
if (
facts.get("codesign_input_filename", "").endswith(".pkg")
or "pkg" in facts["inspections"]
):
facts["warnings"].append(
"To add a Versioner processor with a pkg as input requires quite "
"a bit of customization. I'm going to take my best shot, but I "
"might be wrong."
)
flatpkgunpacker = processor.FlatPkgUnpacker()
flatpkgunpacker.destination_path = "%RECIPE_CACHE_DIR%/unpack"
flatpkgunpacker.flat_pkg_path = input_path
flatpkgunpacker.purge_destination = True
recipe.append_processor(flatpkgunpacker)
pkgpayloadunpacker = processor.PkgPayloadUnpacker()
pkgpayloadunpacker.destination_path = "%RECIPE_CACHE_DIR%/payload"
pkgpayloadunpacker.purge_destination = True
if "pkg_filename" not in facts:
# Use FileFinder to search for the package if the name is unknown.
filefinder = processor.FileFinder()
filefinder.pattern = "%RECIPE_CACHE_DIR%/unpack/*.pkg/Payload"
filefinder.find_method = "glob"
recipe.append_processor(filefinder)
pkgpayloadunpacker.pkg_payload_path = "%found_filename%"
else:
# Skip FileFinder and specify the filename of the package.
pkgpayloadunpacker.pkg_payload_path = (
"%RECIPE_CACHE_DIR%/unpack/{}/Payload".format(
facts["pkg_filename"]
)
)
recipe.append_processor(pkgpayloadunpacker)
versioner.input_plist_path = (
"%RECIPE_CACHE_DIR%/payload/{}/Contents/Info.plist".format(
facts["app_relpath_from_payload"]
)
)
else:
if facts["download_format"] in SUPPORTED_IMAGE_FORMATS:
versioner.input_plist_path = (
"%pathname%/{}{}.{}/Contents/Info.plist".format(
facts.get("relative_path", ""),
facts.get("app_file", facts[bundle_name_key]),
bundle_type,
)
)
else:
versioner.input_plist_path = (
"%RECIPE_CACHE_DIR%/%NAME%/"
"{}{}.{}/Contents/Info.plist".format(
facts.get("relative_path", ""),
facts.get("app_file", facts[bundle_name_key]),
bundle_type,
)
)
versioner.plist_version_key = facts["version_key"]
recipe.append_processor(versioner)
return recipe
def warn_about_app_store_generation(facts, recipe_type):
"""Issue warning if we can't make this recipe due to it being from the Mac
App Store.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
recipe_type (str): String representing the type of this recipe.
"""
facts["warnings"].append(
"Skipping %s recipe, because this app was downloaded from the "
"App Store." % recipe_type
)
def get_code_signature_verifier(input_path, facts):
"""Build a CodeSignatureVerifier processor.
Args:
input_path (str): Path to signed code.
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
Returns:
CodeSignatureVerifier: An object representing the CodeSignatureVerifier
processor.
"""
"""
Args:
input_path (str): Path to signed code.
facts (Facts): Shared facts object.
Returns:
CodeSignatureVerifier
"""
codesigverifier = processor.CodeSignatureVerifier()
codesigverifier.input_path = input_path
if facts.get("codesign_reqs"):
codesigverifier.requirement = facts["codesign_reqs"]
elif len(facts["codesign_authorities"]) > 0:
codesigverifier.expected_authority_names = list(facts["codesign_authorities"])
return codesigverifier
def needs_versioner(facts):
"""Determine whether we need to add a Versioner processor, based on available
facts.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
Returns:
bool: True if a Versioner processor is needed, False otherwise.
"""
download_format = facts["download_format"]
sparkle_version = facts.get("sparkle_provides_version", False)
format_needs_versioner = any(
download_format in formats
for formats in (SUPPORTED_IMAGE_FORMATS, SUPPORTED_ARCHIVE_FORMATS)
)
return format_needs_versioner and not sparkle_version
def generate_app_store_munki_recipe(facts, prefs, recipe):
"""Generate an munki recipe for an App Store app on passed recipe dict.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
prefs (dict): The dictionary containing a key/value pair for Recipe Robot
preferences.
recipe (Recipe): The recipe to operate on. This recipe will be mutated
by this function.
Returns:
Recipe: Newly updated Recipe object suitable for converting to plist.
"""
keys = recipe["keys"]
robo_print("Generating %s recipe..." % recipe["type"])
recipe.set_description(
"Downloads the latest version of %s from the Mac "
"App Store and imports it into Munki." % facts["app_name"]
)
recipe.set_parent("com.github.nmcspadden.munki.appstore")
keys["Input"]["PATH"] = facts["app_path"]
recipe["filename"] = "MAS-" + recipe["filename"]
keys["Input"]["MUNKI_REPO_SUBDIR"] = "apps/%NAME%"
keys["Input"]["pkginfo"] = {
"catalogs": ["testing"],
"developer": facts.get("developer", ""),
"display_name": facts["app_name"],
"name": "%NAME%",
"unattended_install": True,
}
if "description" in facts:
keys["Input"]["pkginfo"]["description"] = facts["description"]
else:
facts["reminders"].append(
"I couldn't find a description for this app, so you'll need to "
"manually add one to the munki recipe."
)
keys["Input"]["pkginfo"]["description"] = " "
return recipe
def generate_munki_recipe(facts, prefs, recipe):
"""Generate a munki recipe for a non-App Store app on passed recipe dict.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
prefs (dict): The dictionary containing a key/value pair for Recipe Robot
preferences.
recipe (Recipe): The recipe to operate on. This recipe will be mutated
by this function.
Returns:
Recipe: Newly updated Recipe object suitable for converting to plist.
"""
keys = recipe["keys"]
bundle_type, bundle_name_key = get_bundle_name_info(facts)
robo_print("Generating %s recipe..." % recipe["type"])
recipe.set_description(
"Downloads the latest version of %s and imports it "
"into Munki." % facts[bundle_name_key]
)
recipe.set_parent_from(prefs, facts, "download")
keys["Input"]["MUNKI_REPO_SUBDIR"] = "apps/%NAME%"
keys["Input"]["pkginfo"] = {
"catalogs": ["testing"],
"display_name": facts[bundle_name_key],
"name": "%NAME%",
"unattended_install": True,
}
if "description" in facts:
keys["Input"]["pkginfo"]["description"] = facts["description"]
else:
facts["reminders"].append(
"I couldn't find a description for this app, so you'll need to "
"manually add one to the munki recipe."
)
keys["Input"]["pkginfo"]["description"] = " "
if prefs.get("StripDeveloperSuffixes", False) is True:
keys["Input"]["pkginfo"]["developer"] = strip_dev_suffix(
facts.get("developer", "")
)
else:
keys["Input"]["pkginfo"]["developer"] = facts.get("developer", "")
# Set default variable to use for substitution.
import_file_var = "%pathname%"
# Create empty container for additional makepkginfo options.
addl_makepkginfo_opts = []
if facts["download_format"] in SUPPORTED_IMAGE_FORMATS:
# If the app is not signed, we need a versioner processor here.
if (
facts.get("codesign_reqs", "") == ""
and len(facts["codesign_authorities"]) == 0
):
if (
facts["version_key"] == "CFBundleShortVersionString"
and bundle_type == "app"
):
recipe.append_processor(
{
"Processor": "AppDmgVersioner",
"Arguments": {"dmg_path": "%pathname%"},
}
)
else:
versioner = {
"Processor": "Versioner",
"Arguments": {
"input_plist_path": (
"%pathname%/{}{}.{}/Contents/Info.plist".format(
facts.get("relative_path", ""),
facts.get("app_file", facts[bundle_name_key]),
bundle_type,
)
)
},
}
if facts["version_key"] != "CFBundleShortVersionString":
versioner["Arguments"]["plist_version_key"] = facts["version_key"]
recipe.append_processor(versioner)
if bundle_type != "app":
# Add --itemname option.
itemname = "{}{}.{}".format(
facts.get("relative_path", ""),
facts.get("app_file", facts[bundle_name_key]),
bundle_type,
)
addl_makepkginfo_opts.append("--itemname")
addl_makepkginfo_opts.append(itemname)
# Add --destinationpath option.
destinationpath = SUPPORTED_BUNDLE_TYPES[bundle_type]
addl_makepkginfo_opts.append("--destinationpath")
addl_makepkginfo_opts.append(destinationpath)
elif facts["download_format"] in SUPPORTED_ARCHIVE_FORMATS:
if (
facts.get("codesign_reqs", "") == ""
and len(facts["codesign_authorities"]) == 0
):
# If unsigned, that means the download recipe hasn't
# unarchived the zip yet.
recipe.append_processor(
{
"Processor": "Unarchiver",
"Arguments": {
"archive_path": "%pathname%",
"destination_path": "%RECIPE_CACHE_DIR%/%NAME%",
"purge_destination": True,
},
}
)
recipe.append_processor(
{
"Processor": "DmgCreator",
"Arguments": {
"dmg_path": "%RECIPE_CACHE_DIR%/%NAME%.dmg",
"dmg_root": "%RECIPE_CACHE_DIR%/%NAME%",
},
}
)
import_file_var = "%dmg_path%"
if bundle_type != "app":
# Add --itemname option.
itemname = "{}{}.{}".format(
facts.get("relative_path", ""),
facts.get("app_file", facts[bundle_name_key]),
bundle_type,
)
addl_makepkginfo_opts.append("--itemname")
addl_makepkginfo_opts.append(itemname)
# Add --destinationpath option.
destinationpath = SUPPORTED_BUNDLE_TYPES[bundle_type]
addl_makepkginfo_opts.append("--destinationpath")
addl_makepkginfo_opts.append(destinationpath)
# Set blocking applications, if we found any.
if len(facts["blocking_applications"]) > 0 and "pkg" in facts["inspections"]:
keys["Input"]["pkginfo"]["blocking_applications"] = list(
set(facts["blocking_applications"])
)
if bundle_type != "app":
recipe.append_processor(
{
"Processor": "MunkiInstallsItemsCreator",
"Arguments": {
"installs_item_paths": [
"{}/{}.{}".format(
SUPPORTED_BUNDLE_TYPES[bundle_type],
facts.get("app_file", facts[bundle_name_key]),
bundle_type,
)
]
},
}
)
if facts["version_key"] != "CFBundleShortVersionString":
recipe.append_processor(
{
"Processor": "MunkiPkginfoMerger",
"Arguments": {"additional_pkginfo": {"version": "%version%"}},
}
)
munki_importer = {
"Processor": "MunkiImporter",
"Arguments": {
"pkg_path": import_file_var,
"repo_subdirectory": "%MUNKI_REPO_SUBDIR%",
"version_comparison_key": facts["version_key"],
},
}
else:
munki_importer = {
"Processor": "MunkiImporter",
"Arguments": {
"pkg_path": import_file_var,
"repo_subdirectory": "%MUNKI_REPO_SUBDIR%",
},
}
if addl_makepkginfo_opts:
munki_importer["Arguments"][
"additional_makepkginfo_options"
] = addl_makepkginfo_opts
recipe.append_processor(munki_importer)
# Extract the app's icon and save it to disk.
if "icon_path" in facts:
extracted_icon = robo_join(
recipe_dirpath(facts[bundle_name_key], facts.get("developer", None), prefs),
facts[bundle_name_key] + ".png",
)
extract_app_icon(facts, extracted_icon)
else:
facts["warnings"].append(
"I don't have enough information to create a PNG icon for this app."
)
return recipe
def get_pkgdirs(path):
"""Given a destination path, create the dictionary used for
PkgRootCreator.
Args:
path (str): Path to the package installer destination.
Returns:
dict: Dictionary of subdirectory paths and file modes used by PkgRootCreator.
"""
path_parts = os.path.split(path.lstrip("/"))
pkgdirs = {}
for index, dir in enumerate(path_parts):
pkgdirs["/".join(path_parts[: index + 1])] = "0775"
return pkgdirs
def generate_app_store_pkg_recipe(facts, prefs, recipe):
"""Generate a pkg recipe for an App Store app on passed recipe dict.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
prefs (dict): The dictionary containing a key/value pair for Recipe Robot
preferences.
recipe (Recipe): The recipe to operate on. This recipe will be mutated
by this function.
Returns:
Recipe: Newly updated Recipe object suitable for converting to plist.
"""
keys = recipe["keys"]
robo_print("Generating %s recipe..." % recipe["type"])
recipe.set_description(
"Downloads the latest version of %s from the Mac "
"App Store and creates a package." % facts["app_name"]
)
recipe.set_parent("com.github.nmcspadden.pkg.appstore")
keys["Input"]["PATH"] = facts["app_path"]
recipe["filename"] = "MAS-" + recipe["filename"]
warn_about_appstoreapp_pyasn(facts)
return recipe
def generate_pkg_recipe(facts, prefs, recipe):
"""Generate a pkg recipe for a non-App Store app based on passed recipe dict.
Args:
facts (RoboDict): A continually-updated dictionary containing all the
information we know so far about the app associated with the
input path.
prefs (dict): The dictionary containing a key/value pair for Recipe Robot
preferences.
recipe (Recipe): The recipe to operate on. This recipe will be mutated
by this function.
Returns:
Recipe: Newly updated Recipe object suitable for converting to plist.
"""
bundle_type, bundle_name_key = get_bundle_name_info(facts)
# Can't make this recipe without a bundle identifier.
# TODO: Bundle id is also provided by AppDmgVersioner and some
# Sparkle feeds. When those are present, can we proceed even though we
# don't have bundle_id in facts? (#40)
if "bundle_id" not in facts:
facts["warnings"].append(
"Skipping %s recipe, because I wasn't able to determine the "
"bundle identifier of this app. You may want to actually download "
"the app and try again, using the .app file itself as input."
% recipe["type"]
)
return
robo_print("Generating %s recipe..." % recipe["type"])
recipe.set_description(
"Downloads the latest version of %s and creates a package."
% facts[bundle_name_key]
)
recipe.set_parent_from(prefs, facts, "download")
# TODO: Try to make AppPkgCreator work with exclamation points in app names. Example:
# 'https://s3.amazonaws.com/shirtpocket/SuperDuper/SuperDuper!.dmg'
if facts["download_format"] in SUPPORTED_IMAGE_FORMATS:
if facts.get("pkg_in_dmg"):
recipe.append_processor(
{
"Processor": "PkgCopier",
"Arguments": {
"source_pkg": "%pathname%/{}".format(facts["pkg_in_dmg"]),
"pkg_path": "%RECIPE_CACHE_DIR%/%NAME%-%version%.pkg",
},
}
)
elif bundle_type == "app":
if "relative_path" in facts:
recipe.append_processor(
{
"Processor": "AppPkgCreator",
"Arguments": {
"app_path": "%pathname%/{}{}.{}".format(
facts.get("relative_path", ""),
facts.get("app_file", facts[bundle_name_key]),
bundle_type,
)
},
}
)
else:
recipe.append_processor({"Processor": "AppPkgCreator"})
else:
# TODO: Create postinstall script for running `qlmanage -r`
# if bundle_type is qlgenerator.
recipe.append_processor(
{
"Processor": "PkgRootCreator",
"Arguments": {
"pkgdirs": get_pkgdirs(SUPPORTED_BUNDLE_TYPES[bundle_type]),
"pkgroot": "%RECIPE_CACHE_DIR%/pkgroot",
},
}
)
recipe.append_processor(
{
"Processor": "Copier",
"Arguments": {
"destination_path": "%pkgroot%/{}/{}.{}".format(
SUPPORTED_BUNDLE_TYPES[bundle_type].lstrip("/"),
facts.get("app_file", facts[bundle_name_key]),