├── .gitignore ├── LICENSE ├── README.md └── prefs.py /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | 3 | *.pyc 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2018 Armin Briegel 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # `prefs` Tools 2 | 3 | This tool is an extension of [Greg Neagle's `fancy_defaults_read.py`](https://gist.github.com/gregneagle/010b369e86410a2f279ff8e980585c68). 4 | 5 | In the simplest use case you can just pass the app identifier: 6 | 7 | ``` 8 | $ ./prefs.py com.apple.screensaver 9 | idleTime : 0L (User/ByHost) 10 | CleanExit : u'YES' (User/ByHost) 11 | askForPassword : True (Managed) 12 | askForPasswordDelay : 0L (Managed) 13 | moduleDict : { 14 | moduleName = iLifeSlideshows; 15 | path = "/System/Library/Frameworks/ScreenSaver.framework/Resources/iLifeSlideshows.saver"; 16 | type = 0; 17 | } (User/ByHost) 18 | showClock : True (User/ByHost) 19 | PayloadUUID : u'AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE' (Managed) 20 | tokenRemovalAction : 0L (User/ByHost) 21 | PrefsVersion : 100L (User/ByHost) 22 | ``` 23 | 24 | The tool will print _all_ composited preferences keys and their type and value, with the preference domain where the value was set. The output format is: 25 | 26 | ``` 27 | prefKey : value (domain) 28 | ``` 29 | 30 | A preference domain of `Managed` means the value is set with a configuration profile. 31 | 32 | While preference values set in `.GlobalPreferences.plist` in the different domains are composited into the the application defaults, they are _not_ shown by default, since there are many of them and they will make the output fairly unreadable. If you want to see them add the `--globals` (or `-g` option): 33 | 34 | ``` 35 | $ ./prefs.py --globals com.apple.screensaver 36 | ``` 37 | 38 | You can also add one or more keys after the app identifier to get just specific values: 39 | 40 | ``` 41 | $ ./prefs.py com.apple.screensaver askForPassword askForPasswordDelay AppleLocale 42 | askForPassword : True (Managed) 43 | askForPasswordDelay : 0L (Managed) 44 | AppleLocale : u'en_NL' (User/Global) 45 | ``` 46 | 47 | You can also add the `--value` (or `-V`) option to show just the value in the output (might be useful when you want to get the composited value for another script. 48 | 49 | ``` 50 | $ ./prefs.py -V com.apple.screensaver askForPassword 51 | True 52 | ``` 53 | 54 | ## To do: 55 | 56 | - determine the configuration profile a setting came from 57 | - set or delete values in a certain domain 58 | - read keys or values in nested arrays or dicts 59 | 60 | (inherited from `fancy_defaults_read.py`) 61 | - Instead of '/Library/Preferences/ByHost/com.apple.screensaver.xxxx.plist', print the actual filename. 62 | - Add support for sandboxed applications that store their preferences in ~/Library/Containers//Data/Library/Preferences/.plist 63 | -------------------------------------------------------------------------------- /prefs.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | import os 4 | import sys 5 | import argparse 6 | from Foundation import (NSUserDefaults, 7 | CFPreferencesAppValueIsForced, 8 | CFPreferencesCopyAppValue, 9 | CFPreferencesCopyValue, 10 | kCFPreferencesAnyUser, 11 | kCFPreferencesAnyHost, 12 | kCFPreferencesCurrentUser, 13 | kCFPreferencesCurrentHost, 14 | kCFPreferencesAnyApplication) 15 | 16 | def get_type(value): 17 | '''Returns type of pref value''' 18 | if value is None: 19 | return 'null' 20 | type_name = type(value).__name__ 21 | if type_name == '__NSCFDictionary': 22 | return 'dict' 23 | if type_name == '__NSCFArray': 24 | return 'array' 25 | if type_name in ('pyobjc_unicode', '__NSCFString'): 26 | return 'string' 27 | if type_name in ('bool', '__NSCFBoolean'): 28 | return 'bool' 29 | if type_name == '__NSCFData': 30 | return 'data' 31 | if type_name == '__NSDate': 32 | return 'date' 33 | if type_name == 'OC_PythonLong': 34 | return 'int' 35 | if type_name == 'OC_PythonFloat': 36 | return 'real' 37 | return type(value).__name__ 38 | 39 | def get_pref_value(bundle_id, pref_name): 40 | '''Returns the effective value of a preference''' 41 | return CFPreferencesCopyAppValue(pref_name, bundle_id) 42 | 43 | def get_config_level(bundle_id, pref_name, value, showPath): 44 | '''Returns a string indicating where the given preference is defined''' 45 | if value is None: 46 | return 'not set' 47 | if CFPreferencesAppValueIsForced(pref_name, bundle_id): 48 | return 'Managed' 49 | home_dir = os.path.expanduser('~') 50 | # define all the places we need to search, in priority order 51 | levels = [ 52 | {'location': 'User/ByHost', 53 | 'file': os.path.join(home_dir, 'Library/Preferences/ByHost', 54 | bundle_id + '.xxxx.plist'), 55 | 'domain': bundle_id, 56 | 'user': kCFPreferencesCurrentUser, 57 | 'host': kCFPreferencesCurrentHost 58 | }, 59 | {'location': 'User', 60 | 'file': os.path.join(home_dir, 'Library/Preferences/', 61 | bundle_id + '.plist'), 62 | 'domain': bundle_id, 63 | 'user': kCFPreferencesCurrentUser, 64 | 'host': kCFPreferencesAnyHost 65 | }, 66 | {'location': 'User/ByHost/Global', 67 | 'file': os.path.join(home_dir, 'Library/Preferences/ByHost', 68 | '.GlobalPreferences.xxxx.plist'), 69 | 'domain': kCFPreferencesAnyApplication, 70 | 'user': kCFPreferencesCurrentUser, 71 | 'host': kCFPreferencesCurrentHost 72 | }, 73 | {'location': 'User/Global', 74 | 'file': os.path.join(home_dir, 'Library/Preferences', 75 | '.GlobalPreferences.plist'), 76 | 'domain': kCFPreferencesAnyApplication, 77 | 'user': kCFPreferencesCurrentUser, 78 | 'host': kCFPreferencesAnyHost 79 | }, 80 | {'location': 'Computer', 81 | 'file': os.path.join('/Library/Preferences', bundle_id +'.plist'), 82 | 'domain': bundle_id, 83 | 'user': kCFPreferencesAnyUser, 84 | 'host': kCFPreferencesCurrentHost 85 | }, 86 | {'location': 'Computer/Global', 87 | 'file': '/Library/Preferences/.GlobalPreferences.plist', 88 | 'domain': kCFPreferencesAnyApplication, 89 | 'user': kCFPreferencesAnyUser, 90 | 'host': kCFPreferencesCurrentHost 91 | }, 92 | ] 93 | for level in levels: 94 | if (value == CFPreferencesCopyValue( 95 | pref_name, level['domain'], level['user'], level['host'])): 96 | if showPath: 97 | return level['file'] 98 | else: 99 | return level['location'] 100 | return 'unknown' 101 | 102 | def print_detail(app_id, key, showGlobals, showPath): 103 | value = get_pref_value(app_id, key) 104 | type = get_type(value) 105 | location = get_config_level(app_id, key, value, showPath) 106 | if (showGlobals or "Global" not in location): 107 | print "%s <%s>: %r (%s)" % (key, type, value, location) 108 | 109 | def main(): 110 | prefs_version="0.1" 111 | 112 | parser = argparse.ArgumentParser() 113 | 114 | parser.add_argument("app_id", metavar="APP_ID", help="the app identifier or preference domain") 115 | parser.add_argument("keys", nargs="*", metavar="KEY", help="preference keys to show. When no key is given all values will be shown") 116 | 117 | parser.add_argument('--version', help='prints the version', action='version', version=prefs_version) 118 | 119 | parser.add_argument("-g", "--globals", action="store_true", help="show values from GlobalPreferences files as well") 120 | parser.add_argument("-V", "--value", action="store_true", help="show only the value, no other information") 121 | parser.add_argument("-p", "--path", action="store_true", help="print path to plist file instead of domain") 122 | args = parser.parse_args() 123 | 124 | app_id = args.app_id 125 | showGlobals = args.globals 126 | 127 | if len(args.keys) == 0: 128 | app_defaults = NSUserDefaults.alloc().initWithSuiteName_(app_id) 129 | keys = app_defaults.dictionaryRepresentation().keys() 130 | else: 131 | keys = args.keys 132 | # set showGlobals regardless so all keys will be shown 133 | showGlobals = True 134 | 135 | for key in keys: 136 | if args.value: 137 | print repr(get_pref_value(app_id, key)) 138 | else: 139 | print_detail(app_id, key, showGlobals, args.path) 140 | 141 | 142 | if __name__ == '__main__': 143 | main() --------------------------------------------------------------------------------