├── .gitignore ├── LICENSE ├── README.md └── gsetting.py /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ansible-gsetting 2 | ================ 3 | 4 | Ansible module for setting GSettings entries. 5 | 6 | See also 7 | [ansible-dconf](https://github.com/jistr/ansible-dconf). 8 | 9 | Installation 10 | ------------ 11 | 12 | curl https://raw.githubusercontent.com/jistr/ansible-gsetting/master/gsetting.py > ~/ansible_dir/library/gsetting 13 | 14 | Usage examples 15 | -------------- 16 | 17 | # Embed the schema in the key 18 | - name: turn off hot corners 19 | gsetting: 20 | user: jistr 21 | key: org.gnome.desktop.interface.enable-hot-corners 22 | value: "{{'false'|string}}" 23 | 24 | # Specify the schema separately 25 | - name: turn off hot corners 26 | gsetting: 27 | user: jistr 28 | schema: org.gnome.desktop.interface 29 | key: enable-hot-corners 30 | value: "{{'false'|string}}" 31 | 32 | # Use a relocatable schema 33 | - name: set custom key binding 34 | gsetting: 35 | user: jistr 36 | schema: org.gnome.settings-daemon.plugins.media-keys.custom-keybinding 37 | path: /org/gnome/settings-daemon/plugins/media-keys/custom-keybindings/custom0/ 38 | settings: 39 | name: Flameshot 40 | binding: Print 41 | command: flameshot gui 42 | 43 | - name: do not remember mount password 44 | gsetting: 45 | user: jistr 46 | settings: 47 | org.gnome.shell.remember-mount-password: false 48 | org.gnome.desktop.wm.keybindings.panel-main-menu: "@as []" 49 | org.gnome.nautilus.preferences.default-folder-viewer: "'list-view'" 50 | 51 | If you want to run Ansible as the user you want to adjust settings 52 | for, you should omit the `user` parameter: 53 | 54 | - name: shortcut panel-main-menu 55 | gsetting: 56 | settings: 57 | org.gnome.desktop.wm.keybindings.panel-main-menu: "@as []" 58 | 59 | Be careful with string values, which should be passed into GSetting 60 | single-quoted. You'll need to quote the value twice in YAML: 61 | 62 | - name: nautilus use list view 63 | gsetting: 64 | user: jistr 65 | settings: 66 | org.gnome.nautilus.preferences.default-folder-viewer: "'list-view'" 67 | 68 | - name: nautilus list view columns 69 | gsetting: 70 | user: jistr 71 | settings: 72 | org.gnome.nautilus.list-view.default-visible-columns: "['name', 'size', 'date_modified', 'permissions', 'owner', 'group']" 73 | -------------------------------------------------------------------------------- /gsetting.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | from os import environ 4 | import re 5 | import subprocess 6 | 7 | from ansible.module_utils.basic import AnsibleModule 8 | 9 | 10 | class Setting: 11 | def __init__(self, schema, path, key): 12 | if not schema: 13 | schema, key = self.split_key(key) 14 | if path: 15 | if not path.endswith('/'): 16 | path += '/' 17 | arg1 = schema 18 | if path: 19 | arg1 += ':' + path 20 | self.args = (arg1, key) 21 | 22 | @staticmethod 23 | def split_key(full_key): 24 | key_array = full_key.split('.') 25 | schema = '.'.join(key_array[0:-1]) 26 | single_key = key_array[-1] 27 | return (schema, single_key) 28 | 29 | 30 | def _check_output_strip(command): 31 | return subprocess.check_output(command).decode('utf-8').strip() 32 | 33 | 34 | def _escape_single_quotes(string): 35 | return re.sub("'", r"'\''", string) 36 | 37 | 38 | def _maybe_int(val): 39 | try: 40 | return int(val) 41 | except ValueError: 42 | return 0 43 | 44 | 45 | def _get_gnome_version(): 46 | try: 47 | return tuple(map(_maybe_int, (_check_output_strip( 48 | ['gnome-shell', '--version']).split(' ')[2].split('.')))) 49 | except FileNotFoundError: 50 | return None 51 | 52 | 53 | def _get_gnome_session_pid(user): 54 | gnome_ver = _get_gnome_version() 55 | if gnome_ver and gnome_ver >= (42,): 56 | # It's actually gnome-session-binary, but pgrep uses /proc/#/status, 57 | # which truncates the process name at 15 characters. 58 | # 59 | # Note that this may _also_ work for GNOME 3.33.90, i.e., the code 60 | # block below, but I'm preserving that behavior because I don't have 61 | # earlier GNOME versions to check. 62 | # 63 | # Note also that the code block below won't work when the default 64 | # session named "gnome" isn't used. For example, in recent versions of 65 | # ubuntu the session name is "ubuntu", i.e., "session=ubuntu" rather 66 | # than "session=gnome". 67 | pgrep_cmd = ['pgrep', '-u', user, 'gnome-session-b'] 68 | elif gnome_ver and gnome_ver >= (3, 33, 90): 69 | # From GNOME 3.33.90 session process has changed 70 | # https://github.com/GNOME/gnome-session/releases/tag/3.33.90 71 | pgrep_cmd = ['pgrep', '-u', user, '-f', 'session=gnome'] 72 | else: 73 | pgrep_cmd = ['pgrep', '-u', user, 'gnome-session'] 74 | 75 | try: 76 | # At least in GNOME 42, there are multiple gnome-session-binary 77 | # processes, and we only want the first one. 78 | lines = _check_output_strip(pgrep_cmd) 79 | return lines.split()[0] 80 | except subprocess.CalledProcessError: 81 | return None 82 | 83 | 84 | def _get_phoc_session_pid(user): 85 | pgrep_cmd = ['pgrep', '-u', user, 'phoc'] 86 | 87 | try: 88 | return _check_output_strip(pgrep_cmd) 89 | except subprocess.CalledProcessError: 90 | return None 91 | 92 | 93 | def _get_dbus_bus_address(user): 94 | if user is None: 95 | if environ.get('DBUS_SESSION_BUS_ADDRESS') is None: 96 | return None 97 | 98 | return "DBUS_SESSION_BUS_ADDRESS={}".format( 99 | environ['DBUS_SESSION_BUS_ADDRESS']) 100 | 101 | pid = _get_gnome_session_pid(user) or _get_phoc_session_pid(user) 102 | if pid: 103 | return _check_output_strip( 104 | ['grep', '-z', '^DBUS_SESSION_BUS_ADDRESS', 105 | '/proc/{}/environ'.format(pid)]).strip('\0') 106 | 107 | 108 | def _run_cmd_with_dbus(user, cmd, dbus_addr): 109 | if not dbus_addr: 110 | command = ['dbus-run-session', '--'] 111 | else: 112 | command = ['export', dbus_addr, ';'] 113 | command.extend(cmd) 114 | 115 | if user is None: 116 | return _check_output_strip(['/bin/sh', '-c', " ".join(command)]) 117 | 118 | return _check_output_strip(['su', '-', user, '-c', " ".join(command)]) 119 | 120 | 121 | def _set_value(schemadir, user, setting, value, dbus_addr): 122 | command = ['/usr/bin/gsettings'] 123 | if schemadir: 124 | command.extend(['--schemadir', schemadir]) 125 | command.append('set') 126 | command.extend(setting.args) 127 | command.append(f"'{_escape_single_quotes(value)}'") 128 | 129 | return _run_cmd_with_dbus(user, command, dbus_addr) 130 | 131 | 132 | def _get_value(schemadir, user, setting, dbus_addr): 133 | command = ['/usr/bin/gsettings'] 134 | if schemadir: 135 | command.extend(['--schemadir', schemadir]) 136 | command.append('get') 137 | command.extend(setting.args) 138 | 139 | return _run_cmd_with_dbus(user, command, dbus_addr) 140 | 141 | 142 | def main(): 143 | 144 | module = AnsibleModule( 145 | argument_spec={ 146 | 'state': {'choices': ['present'], 'default': 'present'}, 147 | 'user': {'default': None}, 148 | 'schemadir': {'required': False}, 149 | 'schema': {'required': False}, 150 | 'path': {'required': False}, 151 | 'key': {'required': False}, 152 | 'value': {'required': False}, 153 | 'settings': {'type': 'dict', "required": False, 'default': dict()}, 154 | }, 155 | supports_check_mode=True, 156 | ) 157 | 158 | user = module.params['user'] 159 | schemadir = module.params['schemadir'] 160 | schema = module.params['schema'] 161 | path = module.params['path'] 162 | key = module.params['key'] 163 | value = module.params['value'] 164 | settings = module.params['settings'] 165 | any_changed = False 166 | unchanged_settings = list() 167 | changed_settings = list() 168 | 169 | if key is None and len(settings) == 0: 170 | module.fail_json(msg="Either a key or a settings dict is required, " 171 | "neither was provided.") 172 | 173 | parsed_settings = [] 174 | 175 | if key is not None: 176 | parsed_settings.append([Setting(schema, path, key), value]) 177 | 178 | for key, value in settings.items(): 179 | parsed_settings.append([Setting(schema, path, key), value]) 180 | 181 | dbus_addr = _get_dbus_bus_address(user) 182 | 183 | for setting, value in parsed_settings: 184 | old_value = _get_value(schemadir, user, setting, dbus_addr) 185 | result = {'key': '.'.join(setting.args), 'value': old_value} 186 | changed = old_value != value 187 | any_changed = any_changed or changed 188 | 189 | if changed and not module.check_mode: 190 | _set_value(schemadir, user, setting, value, dbus_addr) 191 | result['new_value'] = value 192 | changed_settings.append(result) 193 | else: 194 | unchanged_settings.append(result) 195 | 196 | module.exit_json(**{ 197 | 'changed': any_changed, 198 | 'unchanged_settings': unchanged_settings, 199 | 'changed_settings': changed_settings, 200 | }) 201 | 202 | 203 | if __name__ == '__main__': 204 | main() 205 | --------------------------------------------------------------------------------