├── tests ├── .gitignore ├── inventory ├── group_vars │ └── all ├── README.md ├── test-count.yml ├── results │ ├── test-set-children-elements-unicode.xml │ ├── test-remove-element.xml │ ├── test-set-children-elements.xml │ ├── test-remove-attribute.xml │ ├── test-set-element-value-empty.xml │ ├── test-set-attribute-value.xml │ ├── test-pretty-print-only.xml │ ├── test-set-attribute-value-unicode.xml │ ├── test-set-element-value.xml │ ├── test-add-children-elements-unicode.xml │ ├── test-add-children-elements.xml │ ├── test-set-element-value-unicode.xml │ ├── test-pretty-print.xml │ ├── test-add-children-with-attributes.xml │ ├── test-add-children-with-attributes-unicode.xml │ ├── test-add-children-from-groupvars.xml │ ├── test-remove-namespaced-element.xml │ ├── test-remove-namespaced-attribute.xml │ ├── test-set-namespaced-element-value.xml │ ├── test-set-namespaced-attribute-value.xml │ ├── test-add-namespaced-children-elements.xml │ ├── test-set-children-elements-level.xml │ └── test-add-element-implicitly.yml ├── fixtures │ ├── ansible-xml-beers-unicode.xml │ ├── ansible-xml-beers.xml │ └── ansible-xml-namespaced-beers.xml ├── test-count-unicode.yml ├── test-pretty-print-only.yml ├── test-remove-element.yml ├── test-add-children-from-groupvars.yml ├── test-remove-attribute.yml ├── test-add-children-elements.yml ├── test-require-valid-path.yml ├── test-set-element-value-empty.yml ├── test-mutually-exclusive-attributes.yml ├── test-pretty-print.yml ├── test-add-children-elements-unicode.yml ├── test-children-elements-xml.yml ├── test-set-attribute-value.yml ├── test-add-children-with-attributes.yml ├── test-set-attribute-value-unicode.yml ├── test-add-children-with-attributes-unicode.yml ├── test-add-namespaced-children-elements.yml ├── test-remove-namespaced-element.yml ├── test-remove-namespaced-attribute.yml ├── test-get-element-content.yml ├── test-set-namespaced-attribute-value.yml ├── test-get-element-content-unicode.yml ├── test-set-children-elements-unicode.yml ├── test-set-children-elements.yml ├── test-xmlstring.yml ├── test-set-element-value.yml ├── test-set-element-value-unicode.yml ├── test-set-namespaced-element-value.yml ├── test.yml ├── test-set-children-elements-level.yml └── test-add-element-implicitly.yml ├── meta └── main.yml ├── .github ├── issue_template.md └── pull_request_template.md ├── .travis.yml ├── ansible-xml.spec ├── CHANGELOG.md ├── README.md ├── library └── xml.py └── LICENSE /tests/.gitignore: -------------------------------------------------------------------------------- 1 | test.retry 2 | -------------------------------------------------------------------------------- /tests/inventory: -------------------------------------------------------------------------------- 1 | localhost ansible_connection=local 2 | -------------------------------------------------------------------------------- /tests/group_vars/all: -------------------------------------------------------------------------------- 1 | # -*- mode: yaml -*- 2 | --- 3 | bad_beers: 4 | - beer: "Natty Lite" 5 | - beer: "Miller Lite" 6 | - beer: "Coors Lite" 7 | -------------------------------------------------------------------------------- /tests/README.md: -------------------------------------------------------------------------------- 1 | ansible-xml Tests 2 | ================= 3 | 4 | Work in progress. 5 | See also: https://servercheck.in/blog/testing-ansible-roles-travis-ci-github -------------------------------------------------------------------------------- /meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | galaxy_info: 3 | author: Tim Bielawa 4 | license: GPL-3.0 5 | min_ansible_version: 1.6 6 | categories: 7 | - files 8 | platforms: 9 | - name: GenericLinux 10 | versions: 11 | - all 12 | - any 13 | 14 | dependencies: [] 15 | 16 | ... -------------------------------------------------------------------------------- /tests/test-count.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Add child element 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/beers/beer 11 | count: yes 12 | register: beers 13 | failed_when: beers.count != 3 14 | -------------------------------------------------------------------------------- /tests/results/test-set-children-elements-unicode.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | ОкскоеНевское 6 | 10 7 | 8 | 9 |
http://tastybeverageco.com
10 | 11 | -------------------------------------------------------------------------------- /tests/fixtures/ansible-xml-beers-unicode.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Толстый бар 4 | 5 | Окское 6 | Невское 7 | 8 | десять 9 | 10 | 11 |
http://tolstyybar.com
12 | 13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-remove-element.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 | 11 |
http://tastybeverageco.com
12 | 13 | -------------------------------------------------------------------------------- /tests/results/test-set-children-elements.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | 90 Minute IPAHarvest Pumpkin Ale 6 | 10 7 | 8 | 9 |
http://tastybeverageco.com
10 | 11 | -------------------------------------------------------------------------------- /tests/test-count-unicode.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers-unicode.xml 5 | dest: /tmp/ansible-xml-beers-unicode.xml 6 | 7 | - name: Count child element 8 | xml: 9 | path: /tmp/ansible-xml-beers-unicode.xml 10 | xpath: /business/beers/beer 11 | count: yes 12 | register: beers 13 | failed_when: beers.count != 2 14 | -------------------------------------------------------------------------------- /tests/test-pretty-print-only.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | shell: sed 's/^[ ]*//g' /tmp/ansible-xml-beers.xml 4 | 5 | - name: Pretty print without modification 6 | xml: 7 | path: /tmp/ansible-xml-beers.xml 8 | pretty_print: yes 9 | 10 | - name: Test expected result 11 | command: diff results/test-pretty-print-only.xml /tmp/ansible-xml-beers.xml 12 | -------------------------------------------------------------------------------- /tests/results/test-remove-attribute.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-set-element-value-empty.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
13 | 14 | -------------------------------------------------------------------------------- /tests/fixtures/ansible-xml-beers.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-set-attribute-value.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/test-remove-element.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Remove '/business/rating' 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/rating 11 | state: absent 12 | 13 | - name: Test expected result 14 | command: diff results/test-remove-element.xml /tmp/ansible-xml-beers.xml 15 | -------------------------------------------------------------------------------- /tests/results/test-pretty-print-only.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | 15 | -------------------------------------------------------------------------------- /tests/results/test-set-attribute-value-unicode.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-set-element-value.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 5 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | 5 -------------------------------------------------------------------------------- /tests/results/test-add-children-elements-unicode.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | Окское 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-add-children-elements.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | Old Rasputin 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-set-element-value-unicode.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | пять 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | пять -------------------------------------------------------------------------------- /tests/test-add-children-from-groupvars.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Add child element 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/beers 11 | add_children: "{{ bad_beers }}" 12 | 13 | - name: Test expected result 14 | command: diff results/test-add-children-from-groupvars.xml /tmp/ansible-xml-beers.xml -------------------------------------------------------------------------------- /tests/test-remove-attribute.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Remove '/business/rating/@subjective' 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/rating/@subjective 11 | state: absent 12 | 13 | - name: Test expected result 14 | command: diff results/test-remove-attribute.xml /tmp/ansible-xml-beers.xml 15 | -------------------------------------------------------------------------------- /tests/results/test-pretty-print.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | Old Rasputin 9 | 10 | 10 11 | 12 | 13 |
http://tastybeverageco.com
14 | 15 | 16 | -------------------------------------------------------------------------------- /tests/test-add-children-elements.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Add child element 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/beers 11 | add_children: 12 | - beer: "Old Rasputin" 13 | 14 | - name: Test expected result 15 | command: diff results/test-add-children-elements.xml /tmp/ansible-xml-beers.xml -------------------------------------------------------------------------------- /tests/test-require-valid-path.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | vars_files: [group_vars/all] 4 | remote_user: root 5 | 6 | roles: 7 | - ../.. 8 | 9 | post_tasks: 10 | - name: Setup test fixture 11 | copy: 12 | src: fixtures/ansible-xml-beers.xml 13 | dest: /tmp/ansible-xml-beers.xml 14 | 15 | - name: Verify task requires a valid 'path' attribute 16 | xml: 17 | path: /klfj/dlfjkldf/sojfkljf.xml 18 | xpath: / 19 | ... 20 | -------------------------------------------------------------------------------- /tests/test-set-element-value-empty.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Set /business/website/address to empty string. 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/website/address 11 | value: '' 12 | 13 | - name: Test expected result 14 | command: diff results/test-set-element-value-empty.xml /tmp/ansible-xml-beers.xml 15 | -------------------------------------------------------------------------------- /tests/results/test-add-children-with-attributes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/test-mutually-exclusive-attributes.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Specify both children to add and a value 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | add_children: 11 | - child01 12 | - child02 13 | value: conflict! 14 | register: module_output 15 | failed_when: module_output.failed == 'false' 16 | -------------------------------------------------------------------------------- /tests/test-pretty-print.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Pretty print 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/beers 11 | pretty_print: yes 12 | add_children: 13 | - beer: "Old Rasputin" 14 | 15 | - name: Test expected result 16 | command: diff results/test-pretty-print.xml /tmp/ansible-xml-beers.xml 17 | -------------------------------------------------------------------------------- /tests/results/test-add-children-with-attributes-unicode.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/test-add-children-elements-unicode.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Add child element 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/beers 11 | add_children: 12 | - beer: "Окское" 13 | 14 | - name: Test expected result 15 | command: diff results/test-add-children-elements-unicode.xml /tmp/ansible-xml-beers.xml 16 | -------------------------------------------------------------------------------- /tests/results/test-add-children-from-groupvars.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | Natty LiteMiller LiteCoors Lite 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-remove-namespaced-element.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 | 11 |
http://tastybeverageco.com
12 | 13 | -------------------------------------------------------------------------------- /tests/test-children-elements-xml.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Add child element with xml format 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/beers 11 | input_type: xml 12 | add_children: 13 | - "Old Rasputin" 14 | 15 | - name: Test expected result 16 | command: diff results/test-add-children-elements.xml /tmp/ansible-xml-beers.xml -------------------------------------------------------------------------------- /tests/test-set-attribute-value.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Set '/business/rating/@subjective' to 'false' 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/rating 11 | attribute: subjective 12 | value: "false" 13 | 14 | - name: Test expected result 15 | command: diff results/test-set-attribute-value.xml /tmp/ansible-xml-beers.xml 16 | changed_when: no 17 | -------------------------------------------------------------------------------- /tests/test-add-children-with-attributes.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Add child element 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/beers 11 | add_children: 12 | - beer: 13 | name: Ansible Brew 14 | type: light 15 | 16 | - name: Test expected result 17 | command: diff results/test-add-children-with-attributes.xml /tmp/ansible-xml-beers.xml -------------------------------------------------------------------------------- /tests/test-set-attribute-value-unicode.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Set '/business/rating/@subjective' to 'нет' 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/rating 11 | attribute: subjective 12 | value: "нет" 13 | 14 | - name: Test expected result 15 | command: diff results/test-set-attribute-value-unicode.xml /tmp/ansible-xml-beers.xml 16 | changed_when: no 17 | -------------------------------------------------------------------------------- /tests/test-add-children-with-attributes-unicode.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Add child element 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/beers 11 | add_children: 12 | - beer: 13 | name: Окское 14 | type: экстра 15 | 16 | - name: Test expected result 17 | command: diff results/test-add-children-with-attributes-unicode.xml /tmp/ansible-xml-beers.xml -------------------------------------------------------------------------------- /.github/issue_template.md: -------------------------------------------------------------------------------- 1 | Thank you for your effort to improve this module! 2 | 3 | The xml module is upstream now and ships with Ansible since v2.4 (September 2017): 4 | https://github.com/ansible/ansible/blob/devel/docs/docsite/rst/roadmap/ROADMAP_2_4.rst 5 | 6 | Please try running a newer version of ansible and see if the issue is already fixed. 7 | 8 | Note that you'll need version of lxml>=2.3.0. 9 | 10 | If the issue still exists, please search for it upstream: 11 | https://github.com/ansible/ansible/issues 12 | and report it there if it's not already reported. 13 | -------------------------------------------------------------------------------- /tests/results/test-remove-namespaced-attribute.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/fixtures/ansible-xml-namespaced-beers.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-set-namespaced-element-value.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 11 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-set-namespaced-attribute-value.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-add-namespaced-children-elements.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | Old Rasputin 9 | 10 10 | 11 | 12 |
http://tastybeverageco.com
13 | 14 | -------------------------------------------------------------------------------- /tests/results/test-set-children-elements-level.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | 6 | 10 7 | 8 | 9 |
http://tastybeverageco.com
10 | 11 | -------------------------------------------------------------------------------- /tests/test-add-namespaced-children-elements.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-namespaced-beers.xml 5 | dest: /tmp/ansible-xml-namespaced-beers.xml 6 | 7 | - name: Add namespaced child element 8 | xml: 9 | path: /tmp/ansible-xml-namespaced-beers.xml 10 | xpath: /bus:business/ber:beers 11 | namespaces: 12 | bus: http://test.business 13 | ber: http://test.beers 14 | add_children: 15 | - beer: "Old Rasputin" 16 | 17 | - name: Test expected result 18 | command: diff results/test-add-namespaced-children-elements.xml /tmp/ansible-xml-namespaced-beers.xml -------------------------------------------------------------------------------- /tests/test-remove-namespaced-element.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-namespaced-beers.xml 5 | dest: /tmp/ansible-xml-namespaced-beers.xml 6 | 7 | - name: Remove namespaced '/bus:business/rat:rating' 8 | xml: 9 | path: /tmp/ansible-xml-namespaced-beers.xml 10 | xpath: /bus:business/rat:rating 11 | namespaces: 12 | bus: http://test.business 13 | ber: http://test.beers 14 | rat: http://test.rating 15 | attr: http://test.attribute 16 | state: absent 17 | 18 | - name: Test expected result 19 | command: diff results/test-remove-element.xml /tmp/ansible-xml-namespaced-beers.xml 20 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | Thank you for your effort to improve this module! 2 | 3 | The xml module is upstream now and ships with Ansible since v2.4 (September 2017): 4 | https://github.com/ansible/ansible/blob/devel/docs/docsite/rst/roadmap/ROADMAP_2_4.rst 5 | 6 | Please try running ansible from source: 7 | http://docs.ansible.com/ansible/intro_installation.html#running-from-source 8 | and see if the change you wanted to make is already done. 9 | 10 | Note that you'll need version of lxml>=2.3.0. 11 | 12 | If you still want to make a pull request, please check if something similar already exists upstream: 13 | https://github.com/ansible/ansible/pulls 14 | and create it there if it's not already created. 15 | -------------------------------------------------------------------------------- /tests/test-remove-namespaced-attribute.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-namespaced-beers.xml 5 | dest: /tmp/ansible-xml-namespaced-beers.xml 6 | 7 | - name: Remove namespaced '/bus:business/rat:rating/@attr:subjective' 8 | xml: 9 | path: /tmp/ansible-xml-namespaced-beers.xml 10 | xpath: /bus:business/rat:rating/@attr:subjective 11 | namespaces: 12 | bus: http://test.business 13 | ber: http://test.beers 14 | rat: http://test.rating 15 | attr: http://test.attribute 16 | state: absent 17 | 18 | - name: Test expected result 19 | command: diff results/test-remove-namespaced-attribute.xml /tmp/ansible-xml-namespaced-beers.xml 20 | -------------------------------------------------------------------------------- /tests/test-get-element-content.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Get element attributes 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business/rating 11 | content: 'attribute' 12 | register: get_element_attribute 13 | failed_when: get_element_attribute.matches[0]['rating'] is not defined or get_element_attribute.matches[0]['rating']['subjective'] != 'true' 14 | 15 | - name: Get element text 16 | xml: 17 | path: /tmp/ansible-xml-beers.xml 18 | xpath: /business/rating 19 | content: 'text' 20 | register: get_element_text 21 | failed_when: get_element_text.matches[0]['rating'] != '10' -------------------------------------------------------------------------------- /tests/test-set-namespaced-attribute-value.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-namespaced-beers.xml 5 | dest: /tmp/ansible-xml-namespaced-beers.xml 6 | 7 | - name: Set namespaced '/bus:business/rat:rating/@attr:subjective' to 'false' 8 | xml: 9 | path: /tmp/ansible-xml-namespaced-beers.xml 10 | xpath: /bus:business/rat:rating 11 | namespaces: 12 | bus: http://test.business 13 | ber: http://test.beers 14 | rat: http://test.rating 15 | attr: http://test.attribute 16 | attribute: attr:subjective 17 | value: "false" 18 | 19 | - name: Test expected result 20 | command: diff results/test-set-namespaced-attribute-value.xml /tmp/ansible-xml-namespaced-beers.xml 21 | changed_when: no 22 | -------------------------------------------------------------------------------- /tests/test-get-element-content-unicode.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers-unicode.xml 5 | dest: /tmp/ansible-xml-beers-unicode.xml 6 | 7 | - name: Get element attributes 8 | xml: 9 | path: /tmp/ansible-xml-beers-unicode.xml 10 | xpath: /business/rating 11 | content: 'attribute' 12 | register: get_element_attribute 13 | failed_when: get_element_attribute.matches[0]['rating'] is not defined or get_element_attribute.matches[0]['rating']['subjective'] != 'да' 14 | 15 | - name: Get element text 16 | xml: 17 | path: /tmp/ansible-xml-beers-unicode.xml 18 | xpath: /business/rating 19 | content: 'text' 20 | register: get_element_text 21 | failed_when: get_element_text.matches[0]['rating'] != 'десять' 22 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | language: python 3 | python: "2.7" 4 | 5 | before_install: 6 | # install libxml dependency binaries 7 | - sudo apt-get install libxml2 libxml2-dev libxslt-dev python-dev 8 | 9 | # build/install current version of libxml 10 | - sudo CFLAGS="-O0" pip install lxml --upgrade 11 | 12 | # Make sure everything's up to date. 13 | - sudo apt-get update -qq 14 | 15 | install: 16 | # build/install current version of Ansible 17 | - pip install ansible 18 | 19 | script: 20 | # log version of Ansible 21 | - ansible --version 22 | 23 | # change directory to test playbook 24 | - cd tests 25 | 26 | # Check the role/playbook's syntax. 27 | - ansible-playbook -i inventory test.yml --syntax-check --list-tasks -vvvv 28 | 29 | # Run the miscellaneous tests. 30 | - "ansible-playbook -i inventory test.yml" 31 | ... -------------------------------------------------------------------------------- /tests/test-set-children-elements-unicode.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | command: cp fixtures/ansible-xml-beers.xml /tmp/ansible-xml-beers.xml 4 | 5 | - name: Set child elements 6 | xml: 7 | path: /tmp/ansible-xml-beers.xml 8 | xpath: /business/beers 9 | set_children: 10 | - beer: "Окское" 11 | - beer: "Невское" 12 | 13 | - name: Test expected result 14 | command: diff results/test-set-children-elements-unicode.xml /tmp/ansible-xml-beers.xml 15 | 16 | - name: Set child elements 17 | xml: 18 | path: /tmp/ansible-xml-beers.xml 19 | xpath: /business/beers 20 | set_children: 21 | - beer: "Окское" 22 | - beer: "Невское" 23 | register: set_children_again 24 | 25 | - fail: 26 | msg: "Setting children is not idempotent!" 27 | when: set_children_again.changed 28 | -------------------------------------------------------------------------------- /tests/test-set-children-elements.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | command: cp fixtures/ansible-xml-beers.xml /tmp/ansible-xml-beers.xml 4 | 5 | - name: Set child elements 6 | xml: 7 | path: /tmp/ansible-xml-beers.xml 8 | xpath: /business/beers 9 | set_children: 10 | - beer: "90 Minute IPA" 11 | - beer: "Harvest Pumpkin Ale" 12 | 13 | - name: Test expected result 14 | command: diff results/test-set-children-elements.xml /tmp/ansible-xml-beers.xml 15 | 16 | - name: Set child elements 17 | xml: 18 | path: /tmp/ansible-xml-beers.xml 19 | xpath: /business/beers 20 | set_children: 21 | - beer: "90 Minute IPA" 22 | - beer: "Harvest Pumpkin Ale" 23 | register: set_children_again 24 | 25 | - fail: 26 | msg: "Setting children is not idempotent!" 27 | when: set_children_again.changed 28 | -------------------------------------------------------------------------------- /tests/test-xmlstring.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Read from xmlstring 3 | xml: 4 | xmlstring: "{{ lookup('file', 'fixtures/ansible-xml-beers.xml') }}" 5 | pretty_print: yes 6 | register: xmlresponse 7 | 8 | - name: Write result to file 9 | copy: 10 | dest: /tmp/ansible-xml-beers.xml 11 | content: "{{ xmlresponse.xmlstring }}" 12 | 13 | - name: Test expected result 14 | command: diff results/test-pretty-print-only.xml /tmp/ansible-xml-beers.xml 15 | 16 | - name: Read from xmlstring 17 | xml: 18 | xmlstring: "{{ lookup('file', 'fixtures/ansible-xml-beers.xml') }}" 19 | xpath: /business/beers 20 | pretty_print: yes 21 | add_children: 22 | - beer: "Old Rasputin" 23 | register: xmlresponse_modification 24 | 25 | - name: Write result to file 26 | copy: 27 | dest: /tmp/ansible-xml-beers.xml 28 | content: "{{ xmlresponse_modification.xmlstring }}" 29 | 30 | - name: Test expected result 31 | command: diff results/test-pretty-print.xml /tmp/ansible-xml-beers.xml 32 | -------------------------------------------------------------------------------- /ansible-xml.spec: -------------------------------------------------------------------------------- 1 | Name: ansible-xml 2 | BuildArch: noarch 3 | Version: 1.0.0 4 | Release: 1 5 | Summary: Ansible module for manipulating bits and pieces of XML files and strings 6 | Vendor: Chris Prescott 7 | License: GPLv3 8 | URL: https://github.com/cmprescott/ansible-xml 9 | Packager: Styopa Semenukha 10 | 11 | Requires: python-lxml >= 2.3 12 | Source: https://github.com/cmprescott/%name/archive/%version.tar.gz 13 | 14 | %bcond_with docs 15 | 16 | %if %{with docs} 17 | BuildRequires: markdown 18 | %endif 19 | 20 | %define ansible_lib %{_datarootdir}/ansible 21 | 22 | %description 23 | Ansible module for manipulating bits and pieces of XML files and strings 24 | 25 | %prep 26 | %setup 27 | 28 | %build 29 | %if %{with docs} 30 | markdown CHANGELOG.md > CHANGELOG.html 31 | markdown README.md > README.html 32 | %endif 33 | 34 | %install 35 | %{__mkdir_p} %buildroot%{ansible_lib} 36 | %{__install} -m 644 library/xml %buildroot%{ansible_lib}/xml 37 | 38 | %files 39 | %{ansible_lib}/xml 40 | %if %{with docs} 41 | %doc CHANGELOG.html README.html 42 | %endif 43 | 44 | %clean 45 | %{__rm} -rf %_buildrootdir 46 | -------------------------------------------------------------------------------- /tests/test-set-element-value.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Add 2nd '/business/rating' with value '5' 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business 11 | add_children: 12 | - rating: "5" 13 | 14 | - name: Set '/business/rating' to '5' 15 | xml: 16 | path: /tmp/ansible-xml-beers.xml 17 | xpath: /business/rating 18 | value: "5" 19 | register: set_element_first_run 20 | 21 | - name: Set '/business/rating' to 'false'... again 22 | xml: 23 | path: /tmp/ansible-xml-beers.xml 24 | xpath: /business/rating 25 | value: "5" 26 | register: set_element_second_run 27 | 28 | - name: Test expected result 29 | command: diff results/test-set-element-value.xml /tmp/ansible-xml-beers.xml 30 | changed_when: no 31 | 32 | - name: Test registered 'changed' on run 1 and unchanged on run 2 33 | assert: 34 | that: 35 | - set_element_first_run.changed 36 | - not set_element_second_run.changed 37 | ... 38 | -------------------------------------------------------------------------------- /tests/test-set-element-value-unicode.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers.xml 6 | 7 | - name: Add 2nd '/business/rating' with value 'пять' 8 | xml: 9 | path: /tmp/ansible-xml-beers.xml 10 | xpath: /business 11 | add_children: 12 | - rating: "пять" 13 | 14 | - name: Set '/business/rating' to 'пять' 15 | xml: 16 | path: /tmp/ansible-xml-beers.xml 17 | xpath: /business/rating 18 | value: "пять" 19 | register: set_element_first_run 20 | 21 | - name: Set '/business/rating' to 'false'... again 22 | xml: 23 | path: /tmp/ansible-xml-beers.xml 24 | xpath: /business/rating 25 | value: "пять" 26 | register: set_element_second_run 27 | 28 | - name: Test expected result 29 | command: diff results/test-set-element-value-unicode.xml /tmp/ansible-xml-beers.xml 30 | changed_when: no 31 | 32 | - name: Test registered 'changed' on run 1 and unchanged on run 2 33 | assert: 34 | that: 35 | - set_element_first_run.changed 36 | - not set_element_second_run.changed 37 | ... 38 | -------------------------------------------------------------------------------- /tests/results/test-add-element-implicitly.yml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Tasty Beverage Co. 4 | 5 | Rochefort 10 6 | St. Bernardus Abbot 12 7 | Schlitz 8 | George Killian's Irish Red 9 | Pilsner Urquell 10 | 11 | 10 12 | 13 | 14 |
http://tastybeverageco.com
15 | 16 | 17 | 555-555-1234 18 | 19 | 20 | Smith 21 | John 22 | Q 23 | 24 | 25 | 26 | 27 | 28 | xml tag with no special characters 29 | xml tag with dashes 30 | xml tag with dashes and dots 31 | xml tag with dashes, dots and underscores 32 | 33 | -------------------------------------------------------------------------------- /tests/test-set-namespaced-element-value.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-namespaced-beers.xml 5 | dest: /tmp/ansible-xml-namespaced-beers.xml 6 | 7 | - name: Set namespaced '/bus:business/rat:rating' to '11' 8 | xml: 9 | path: /tmp/ansible-xml-namespaced-beers.xml 10 | namespaces: 11 | bus: http://test.business 12 | ber: http://test.beers 13 | rat: http://test.rating 14 | attr: http://test.attribute 15 | xpath: /bus:business/rat:rating 16 | value: "11" 17 | register: set_element_first_run 18 | 19 | - name: Set namespaced '/bus:business/rat:rating' to '11' again 20 | xml: 21 | path: /tmp/ansible-xml-namespaced-beers.xml 22 | namespaces: 23 | bus: http://test.business 24 | ber: http://test.beers 25 | rat: http://test.rating 26 | attr: http://test.attribute 27 | xpath: /bus:business/rat:rating 28 | value: "11" 29 | register: set_element_second_run 30 | 31 | - name: Test expected result 32 | command: diff results/test-set-namespaced-element-value.xml /tmp/ansible-xml-namespaced-beers.xml 33 | changed_when: no 34 | 35 | - name: Test registered 'changed' on run 1 and unchanged on run 2 36 | assert: 37 | that: 38 | - set_element_first_run.changed 39 | - not set_element_second_run.changed 40 | -------------------------------------------------------------------------------- /tests/test.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | vars_files: [group_vars/all] 4 | remote_user: root 5 | 6 | roles: 7 | - ../.. 8 | 9 | tasks: 10 | - include: test-add-children-elements.yml 11 | - include: test-add-children-from-groupvars.yml 12 | - include: test-add-children-with-attributes.yml 13 | - include: test-add-element-implicitly.yml 14 | - include: test-count.yml 15 | - include: test-mutually-exclusive-attributes.yml 16 | - include: test-remove-attribute.yml 17 | - include: test-remove-element.yml 18 | - include: test-set-attribute-value.yml 19 | - include: test-set-children-elements.yml 20 | - include: test-set-children-elements-level.yml 21 | - include: test-set-element-value.yml 22 | - include: test-set-element-value-empty.yml 23 | - include: test-pretty-print.yml 24 | - include: test-pretty-print-only.yml 25 | - include: test-add-namespaced-children-elements.yml 26 | - include: test-remove-namespaced-attribute.yml 27 | - include: test-set-namespaced-attribute-value.yml 28 | - include: test-set-namespaced-element-value.yml 29 | - include: test-get-element-content.yml 30 | - include: test-xmlstring.yml 31 | - include: test-children-elements-xml.yml 32 | 33 | # Unicode tests 34 | - include: test-add-children-elements-unicode.yml 35 | - include: test-add-children-with-attributes-unicode.yml 36 | - include: test-set-attribute-value-unicode.yml 37 | - include: test-count-unicode.yml 38 | - include: test-get-element-content.yml 39 | - include: test-set-children-elements-unicode.yml 40 | - include: test-set-element-value-unicode.yml 41 | ... 42 | -------------------------------------------------------------------------------- /tests/test-set-children-elements-level.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | command: cp fixtures/ansible-xml-beers.xml /tmp/ansible-xml-beers.xml 4 | 5 | - name: Set child elements 6 | xml: 7 | path: /tmp/ansible-xml-beers.xml 8 | xpath: /business/beers 9 | set_children: 10 | - beer: 11 | name: "90 Minute IPA" 12 | alcohol: "0.5" 13 | _: 14 | - Water: 15 | quantity: 200g 16 | liter: "0.2" 17 | - Starch: 18 | quantity: 10g 19 | - Hops: 20 | quantity: 50g 21 | - Yeast: 22 | quantity: 20g 23 | - beer: 24 | name: "Harvest Pumpkin Ale" 25 | alcohol: "0.3" 26 | _: 27 | - Water: 28 | quantity: 200g 29 | liter: "0.2" 30 | - Hops: 31 | quantity: 25g 32 | - Yeast: 33 | quantity: 20g 34 | 35 | - name: Test expected result 36 | command: diff results/test-set-children-elements-level.xml /tmp/ansible-xml-beers.xml 37 | 38 | - name: Set child elements 39 | xml: 40 | path: /tmp/ansible-xml-beers.xml 41 | xpath: /business/beers 42 | set_children: 43 | - beer: 44 | name: "90 Minute IPA" 45 | alcohol: "0.5" 46 | _: 47 | - Water: 48 | quantity: 200g 49 | liter: "0.2" 50 | - Starch: 51 | quantity: 10g 52 | - Hops: 53 | quantity: 50g 54 | - Yeast: 55 | quantity: 20g 56 | - beer: 57 | name: "Harvest Pumpkin Ale" 58 | alcohol: "0.3" 59 | _: 60 | - Water: 61 | quantity: 200g 62 | liter: "0.2" 63 | - Hops: 64 | quantity: 25g 65 | - Yeast: 66 | quantity: 20g 67 | register: set_children_again 68 | 69 | - fail: 70 | msg: "Setting children is not idempotent!" 71 | when: set_children_again.changed 72 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | ## [Unreleased] 4 | 5 | ## [1.0.0] - 2017-08-18 6 | ### Added 7 | - Issue template 8 | 9 | ### Updated 10 | - Sync with upstream in Ansible 11 | 12 | ### Fixed 13 | - Documentation reporting incorrect license 14 | 15 | ## [0.4.0] - 2017-07-19 16 | ### Added 17 | - Dot in regex for implicit nodes 18 | - Implicit element creation via XPath 19 | 20 | ### Updated 21 | - Relicense to GPLv3+ header 22 | - Codestyle for inclusion for being upstreamed to Ansible 23 | - Guard main() 24 | 25 | ## [0.3.4] - 2016-07-06 26 | ### Added 27 | - ability to add/set nested elements 28 | - xmlstring output variable 29 | - abort statement at the end to prevent situations with unclear workflow end 30 | - pretty print only (without modifying the xml) 31 | 32 | ### Updated 33 | - refactor method signatures so module parameter is first 34 | 35 | ## [0.3.3] - 2016-06-01 36 | ### Added 37 | - Unicode symbol support 38 | 39 | ### Updated 40 | - CHANGELOG for previous releases 41 | 42 | ### Fix 43 | - can set element to empty value 44 | - unit test fails if module fails 45 | - default file param to empty string 46 | - argument parsing for Ansible 2.1 47 | - missing platform data in the Ansible Galaxy meta file 48 | 49 | ## [0.3.2] - 2016-01-27 50 | ### Added 51 | - RPM spec boilerplate 52 | 53 | ### Fix 54 | - Ansible 2.0.0.2 related errors 55 | 56 | ## [0.3.1] - 2015-11-23 57 | ### Added 58 | - CHANGELOG 59 | - XML pretty print 60 | - XML namespace parameter 61 | - Installation instructions 62 | 63 | ### Updated 64 | - GitHub repository maintainer from github_rhinception to cmprescott 65 | - module requirements 66 | 67 | ### Fix 68 | - abort lacks argument 69 | - cannot modify files in home directory 70 | - always returns changed for set element text 71 | - set_children shouldn't always change the xml file 72 | - setting multiple values reports no changes when there is no change in the last value 73 | 74 | ## [0.3.0] - 2014-07-08 75 | ### Added 76 | - set attributes by nesting a dictionary instead of a string 77 | 78 | ### Updated 79 | - refactor unit tests 80 | 81 | ## [0.2.0] - 2014-07-07 82 | ### Added 83 | - Python module 84 | - GNU v2 LICENSE 85 | - README with requirements, examples, contact 86 | - unit tests 87 | - Travis continuous integration 88 | 89 | [Unreleased]: https://github.com/cmprescott/ansible-xml/compare/1.0.0...HEAD 90 | [1.0.0]: https://github.com/cmprescott/ansible-xml/compare/0.4.0...1.0.0 91 | [0.4.0]: https://github.com/cmprescott/ansible-xml/compare/0.3.4...0.4.0 92 | [0.3.4]: https://github.com/cmprescott/ansible-xml/compare/0.3.3...0.3.4 93 | [0.3.3]: https://github.com/cmprescott/ansible-xml/compare/0.3.2...0.3.3 94 | [0.3.2]: https://github.com/cmprescott/ansible-xml/compare/0.3.1...0.3.2 95 | [0.3.1]: https://github.com/cmprescott/ansible-xml/compare/0.3.0...0.3.1 96 | [0.3.0]: https://github.com/cmprescott/ansible-xml/compare/0.2.0...0.3.0 97 | [0.2.0]: https://github.com/cmprescott/ansible-xml/compare/0154284...0.2.0 98 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status][travis_badge]][travis_results] 2 | # ansible-xml 3 | 4 | [Ansible][src_ansible] module for manipulating bits and pieces of XML files and strings. This module is currently in devel version of [Ansible][github_repo_ansible]. It should be released as part of Ansible 2.4.0 in [Mid-September](https://github.com/ansible/ansible/blob/devel/docs/docsite/rst/roadmap/ROADMAP_2_4.rst). As a consequence, all the issues should be reported to [ansible](https://github.com/ansible/ansible/issues). 5 | 6 | # Installation 7 | 8 | * This module requires Python bindings to ``libxml`` version 2.3 or later. This is usually in a package called 9 | ``python-lxml``. Install with ``apt-get install python-lxml``, ``yum install python-lxml``, or ``pip install lxml``. 10 | * This module is **NOT** included with Ansible v2.3 and below. Install with ``git clone https://github.com/cmprescott/ansible-xml.git``, 11 | or ``ansible-galaxy install cmprescott.xml``. Valid installation paths are 12 | [the playbook's library directory][doc_install_in_playbook], 13 | [the playbook's roles directory and include in the playbook][doc_install_as_role], 14 | or [Ansible's modules path][doc_install_in_path]. 15 | 16 | # Notes 17 | 18 | * Original module created by [@github_rhinception][github_team_rhinception]. 19 | * On 2015-05-05, [@tbielawa][github_user_tbielawa] transferred the project over to [@cmprescott][github_user_cmprescott] to resolve [issue #16][github_issue_16]. 20 | * On 2017-08-08, this module was merged upstream into [Ansible][github_repo_ansible]. 21 | * This software is available under the terms of the GPLv3 license. 22 | * Hi there, we have unit tests! 23 | 24 | # What is XPath? 25 | 26 | "XPath uses path expressions to select nodes or node-sets in an XML 27 | document. The node is selected by following a path or steps." 28 | 29 | Basically, it's a syntax which allows you to select a specific, or 30 | collection, of elements or attributes in an XML file. 31 | 32 | [Learn more at the Mozilla Developer Network][doc_xpath] 33 | 34 | 35 | # Unittests 36 | 37 | Also included in this repository are 38 | [Unittests][src_this_unittests]. Reference these, in addition to the 39 | [Travis-CI][src_this_travis] configuration, if you need some more examples. 40 | 41 | 42 | # Examples 43 | 44 | Given: 45 | 46 | ```xml 47 | 48 | 49 | Tasty Beverage Co. 50 | 51 | Rochefort 10 52 | St. Bernardus Abbot 12 53 | Schlitz 54 | 55 | 10 56 | 57 | 58 |
http://tastybeverageco.com
59 | 60 | 61 | ``` 62 | 63 | Remove the ``subjective`` attribute of the rating element: 64 | 65 | ```yaml 66 | xml: 67 | path: /foo/bar.xml 68 | xpath: /business/rating/@subjective 69 | state: absent 70 | ``` 71 | 72 | Set the rating to **11** 73 | 74 | ```yaml 75 | xml: 76 | path: /foo/bar.xml 77 | xpath: /business/rating 78 | value: 11 79 | ``` 80 | 81 | Get count of beers nodes 82 | 83 | ```yaml 84 | xml: 85 | path: /foo/bar.xml 86 | xpath: /business/beers/beer 87 | count: yes 88 | register: hits 89 | 90 | debug: 91 | var: hits.count 92 | ``` 93 | 94 | 95 | Add a ``phonenumber`` element to the ``business`` element Implicit 96 | ``mkdir -p`` behavior where applicable (parent xml nodes created 97 | automatically) 98 | 99 | ```yaml 100 | xml: 101 | path: /foo/bar.xml 102 | xpath: /business/phonenumber 103 | value: 555-555-1234 104 | ``` 105 | 106 | Add several more beers to the beers element, assuming a **vars.yaml** 107 | file with: 108 | 109 | ```yaml 110 | new_beers: 111 | - beer: "Old Rasputin" 112 | - beer: "Old Motor Oil" 113 | - beer: "Old Curmudgeon" 114 | ``` 115 | 116 | Then the playbook syntax would look like this: 117 | 118 | ```yaml 119 | xml: 120 | path: /foo/bar.xml 121 | xpath: /business/beers 122 | add_children: '{{ new_beers }}' 123 | ``` 124 | 125 | The same, but do it inline 126 | 127 | ```yaml 128 | xml: 129 | path: /foo/bar.xml 130 | xpath: /business/beers 131 | add_children: 132 | - beer: "Old Rasputin" 133 | - beer: "Old Motor Oil" 134 | - beer: "Old Curmudgeon" 135 | ``` 136 | 137 | Add a ``validxhtml`` element to the ``website`` element. Note that 138 | ``state`` is ``present`` by default, and ``value`` defaults to 139 | ``null`` for elements. The result is something like 140 | ``...`` 141 | 142 | ```yaml 143 | xml: 144 | path: /foo/bar.xml 145 | xpath: /business/website/validxhtml 146 | ``` 147 | 148 | Add an empty ``validatedon`` attribute to the ``validxhtml`` 149 | element. This actually makes the last example redundant because of the 150 | implicit parent-node creation behavior. The result is something like 151 | ``...`` 152 | 153 | ```yaml 154 | xml: 155 | path: /foo/bar.xml 156 | xpath: /business/website/validxhtml/@validatedon 157 | ``` 158 | 159 | (1/2) Remove all children from the website element: 160 | 161 | ```yaml 162 | xml: 163 | path: /foo/bar.xml 164 | xpath: /business/website/* 165 | state: absent 166 | ``` 167 | 168 | (2/2) Remove all children from the website element: 169 | 170 | ```yaml 171 | xml: 172 | path: /foo/bar.xml 173 | xpath: /business/website 174 | children: [] 175 | ``` 176 | 177 | Question? If You have ```` 178 | 179 | What happens if you say: 180 | 181 | ```yaml 182 | xml: 183 | path: /foo/bar.xml 184 | xpath: /beers 185 | ``` 186 | 187 | ``value`` defaults to an element, so then this would erase the 188 | children elements. 189 | 190 | [doc_xpath]: https://developer.mozilla.org/en-US/docs/Web/XPath 191 | [doc_install_as_role]: http://docs.ansible.com/ansible/playbooks_roles.html#embedding-modules-and-plugins-in-roles 192 | [doc_install_in_path]: http://docs.ansible.com/ansible/developing_modules.html#module-paths 193 | [doc_install_in_playbook]: http://docs.ansible.com/ansible/playbooks_best_practices.html#bundling-ansible-modules-with-playbooks 194 | [github_issue_16]: https://github.com/cmprescott/ansible-xml/issues/16 195 | [github_repo_ansible]: https://github.com/ansible/ansible 196 | [github_user_cmprescott]: https://github.com/cmprescott 197 | [github_user_tbielawa]: https://github.com/tbielawa 198 | [github_team_rhinception]: https://github.com/RHInception 199 | [src_ansible]: https://github.com/ansible/ansible 200 | [src_this_travis]: https://github.com/cmprescott/ansible-xml/blob/master/.travis.yml 201 | [src_this_unittests]: https://github.com/cmprescott/ansible-xml/tree/master/tests 202 | [travis_badge]: https://travis-ci.org/cmprescott/ansible-xml.svg?branch=master 203 | [travis_results]: https://travis-ci.org/cmprescott/ansible-xml 204 | -------------------------------------------------------------------------------- /tests/test-add-element-implicitly.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Setup test fixture 3 | copy: 4 | src: fixtures/ansible-xml-beers.xml 5 | dest: /tmp/ansible-xml-beers-implicit.xml 6 | 7 | - name: Add a phonenumber element to the business element. Implicit mkdir -p behavior where applicable 8 | xml: 9 | path: /tmp/ansible-xml-beers-implicit.xml 10 | xpath: /business/phonenumber 11 | value: 555-555-1234 12 | 13 | - name: Add a owner element to the business element, testing implicit mkdir -p behavior 1/2 14 | xml: 15 | path: /tmp/ansible-xml-beers-implicit.xml 16 | xpath: /business/owner/name/last 17 | value: Smith 18 | 19 | - name: Add a owner element to the business element, testing implicit mkdir -p behavior 2/2 20 | xml: 21 | path: /tmp/ansible-xml-beers-implicit.xml 22 | xpath: /business/owner/name/first 23 | value: John 24 | 25 | - name: Add a validxhtml element to the website element. Note that ensure is present by default and while value defaults to null for elements, if one doesn't specify it we don't know what to do. 26 | xml: 27 | path: /tmp/ansible-xml-beers-implicit.xml 28 | xpath: /business/website/validxhtml 29 | 30 | - name: Add an empty validateon attribute to the validxhtml element. This actually makes the previous example redundant because of the implicit parent-node creation behavior. 31 | xml: 32 | path: /tmp/ansible-xml-beers-implicit.xml 33 | xpath: /business/website/validxhtml/@validateon 34 | 35 | - name: Add an empty validateon attribute to the validxhtml element. Actually verifies the implicit parent-node creation behavior. 36 | xml: 37 | path: /tmp/ansible-xml-beers-implicit.xml 38 | xpath: /business/website_bis/validxhtml/@validateon 39 | 40 | - name: Add an attribute with a value 41 | xml: 42 | path: /tmp/ansible-xml-beers-implicit.xml 43 | xpath: /business/owner/@dob='1976-04-12' 44 | 45 | - name: Add an element with a value, alternate syntax 46 | xml: 47 | path: /tmp/ansible-xml-beers-implicit.xml 48 | # note the quote within an XPath string thing 49 | xpath: /business/beers/beer/text()="George Killian's Irish Red" 50 | 51 | - name: Add an element without special characters 52 | xml: 53 | file: /tmp/ansible-xml-beers-implicit.xml 54 | xpath: /business/testnormalelement 55 | value: xml tag with no special characters 56 | pretty_print: yes 57 | 58 | - name: Add an element with dash 59 | xml: 60 | file: /tmp/ansible-xml-beers-implicit.xml 61 | xpath: /business/test-with-dash 62 | value: xml tag with dashes 63 | pretty_print: yes 64 | 65 | - name: Add an element with dot 66 | xml: 67 | file: /tmp/ansible-xml-beers-implicit.xml 68 | xpath: /business/test-with-dash.and.dot 69 | value: xml tag with dashes and dots 70 | pretty_print: yes 71 | 72 | - name: Add an element with underscore 73 | xml: 74 | file: /tmp/ansible-xml-beers-implicit.xml 75 | xpath: /business/test-with.dash_and.dot_and-underscores 76 | value: xml tag with dashes, dots and underscores 77 | pretty_print: yes 78 | 79 | - name: Add an attribute on a conditional element 80 | xml: 81 | path: /tmp/ansible-xml-beers-implicit.xml 82 | xpath: /business/beers/beer[text()="George Killian's Irish Red"]/@color='red' 83 | 84 | - name: Add two attributes on a conditional element 85 | xml: 86 | path: /tmp/ansible-xml-beers-implicit.xml 87 | xpath: /business/beers/beer[text()="Pilsner Urquell" and @origin='CZ']/@color='blonde' 88 | 89 | - name: Add a owner element to the business element, testing implicit mkdir -p behavior 3/2 -- complex lookup 90 | xml: 91 | path: /tmp/ansible-xml-beers-implicit.xml 92 | xpath: /business/owner/name[first/text()='John']/middle 93 | value: Q 94 | 95 | - name: Pretty Print this! 96 | xml: 97 | path: /tmp/ansible-xml-beers-implicit.xml 98 | pretty_print: yes 99 | 100 | - name: Test expected result 101 | command: diff -u results/test-add-element-implicitly.yml /tmp/ansible-xml-beers-implicit.xml 102 | 103 | # 104 | # Now we repeat the same, just to ensure proper use of namespaces 105 | # 106 | 107 | - name: Add a phonenumber element to the business element. Implicit mkdir -p behavior where applicable 108 | xml: 109 | path: /tmp/ansible-xml-beers-implicit.xml 110 | xpath: /business/a:phonenumber 111 | value: 555-555-1234 112 | namespaces: 113 | a: http://example.com/some/namespace 114 | 115 | - name: Add a owner element to the business element, testing implicit mkdir -p behavior 1/2 116 | xml: 117 | path: /tmp/ansible-xml-beers-implicit.xml 118 | xpath: /business/a:owner/a:name/a:last 119 | value: Smith 120 | namespaces: 121 | a: http://example.com/some/namespace 122 | 123 | - name: Add a owner element to the business element, testing implicit mkdir -p behavior 2/2 124 | xml: 125 | path: /tmp/ansible-xml-beers-implicit.xml 126 | xpath: /business/a:owner/a:name/a:first 127 | value: John 128 | namespaces: 129 | a: http://example.com/some/namespace 130 | 131 | - name: Add a validxhtml element to the website element. Note that ensure is present by default and while value defaults to null for elements, if one doesn't specify it we don't know what to do. 132 | xml: 133 | path: /tmp/ansible-xml-beers-implicit.xml 134 | xpath: /business/a:website/a:validxhtml 135 | namespaces: 136 | a: http://example.com/some/namespace 137 | 138 | - name: Add an empty validateon attribute to the validxhtml element. This actually makes the previous example redundant because of the implicit parent-node creation behavior. 139 | xml: 140 | path: /tmp/ansible-xml-beers-implicit.xml 141 | xpath: /business/a:website/a:validxhtml/@a:validateon 142 | namespaces: 143 | a: http://example.com/some/namespace 144 | 145 | - name: Add an empty validateon attribute to the validxhtml element. Actually verifies the implicit parent-node creation behavior. 146 | xml: 147 | path: /tmp/ansible-xml-beers-implicit.xml 148 | xpath: /business/a:website_bis/a:validxhtml/@a:validateon 149 | namespaces: 150 | a: http://example.com/some/namespace 151 | 152 | - name: Add an attribute with a value 153 | xml: 154 | path: /tmp/ansible-xml-beers-implicit.xml 155 | xpath: /business/a:owner/@a:dob='1976-04-12' 156 | namespaces: 157 | a: http://example.com/some/namespace 158 | 159 | - name: Add an element with a value, alternate syntax 160 | xml: 161 | path: /tmp/ansible-xml-beers-implicit.xml 162 | xpath: /business/a:beers/a:beer/text()="George Killian's Irish Red" # note the quote within an XPath string thing 163 | namespaces: 164 | a: http://example.com/some/namespace 165 | 166 | - name: Add an attribute on a conditional element 167 | xml: 168 | path: /tmp/ansible-xml-beers-implicit.xml 169 | xpath: /business/a:beers/a:beer[text()="George Killian's Irish Red"]/@a:color='red' 170 | namespaces: 171 | a: http://example.com/some/namespace 172 | 173 | - name: Add two attributes on a conditional element 174 | xml: 175 | path: /tmp/ansible-xml-beers-implicit.xml 176 | xpath: /business/a:beers/a:beer[text()="Pilsner Urquell" and @a:origin='CZ']/@a:color='blonde' 177 | namespaces: 178 | a: http://example.com/some/namespace 179 | 180 | - name: Add a owner element to the business element, testing implicit mkdir -p behavior 3/2 -- complex lookup 181 | xml: 182 | path: /tmp/ansible-xml-beers-implicit.xml 183 | xpath: /business/a:owner/a:name[a:first/text()='John']/a:middle 184 | value: Q 185 | namespaces: 186 | a: http://example.com/some/namespace 187 | 188 | - name: Add an element without special characters 189 | xml: 190 | file: /tmp/ansible-xml-beers-implicit.xml 191 | xpath: /business/testnormalelement 192 | value: "xml tag with no special characters" 193 | pretty_print: true 194 | namespaces: 195 | a: http://example.com/some/namespace 196 | 197 | 198 | - name: Add an element with dash 199 | xml: 200 | file: /tmp/ansible-xml-beers-implicit.xml 201 | xpath: /business/test-with-dash 202 | value: "xml tag with dashes" 203 | pretty_print: true 204 | namespaces: 205 | a: http://example.com/some/namespace 206 | 207 | - name: Add an element with dot 208 | xml: 209 | file: /tmp/ansible-xml-beers-implicit.xml 210 | xpath: /business/test-with-dash.and.dot 211 | value: "xml tag with dashes and dots" 212 | pretty_print: true 213 | namespaces: 214 | a: http://example.com/some/namespace 215 | 216 | - name: Add an element with underscore 217 | xml: 218 | file: /tmp/ansible-xml-beers-implicit.xml 219 | xpath: /business/test-with.dash_and.dot_and-underscores 220 | value: "xml tag with dashes, dots and underscores" 221 | pretty_print: true 222 | namespaces: 223 | a: http://example.com/some/namespace 224 | 225 | - name: Pretty Print this! 226 | xml: 227 | path: /tmp/ansible-xml-beers-implicit.xml 228 | pretty_print: yes 229 | -------------------------------------------------------------------------------- /library/xml.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | 4 | # Copyright 2014, Red Hat, Inc. 5 | # Tim Bielawa 6 | # Magnus Hedemark 7 | # Copyright 2017, Dag Wieers 8 | # 9 | # This file is part of Ansible 10 | # 11 | # Ansible is free software: you can redistribute it and/or modify 12 | # it under the terms of the GNU General Public License as published by 13 | # the Free Software Foundation, either version 3 of the License, or 14 | # (at your option) any later version. 15 | # 16 | # Ansible is distributed in the hope that it will be useful, 17 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | # GNU General Public License for more details. 20 | # 21 | # You should have received a copy of the GNU General Public License 22 | # along with Ansible. If not, see . 23 | 24 | # Make coding more python3-ish 25 | from __future__ import (absolute_import, division, print_function) 26 | __metaclass__ = type 27 | 28 | ANSIBLE_METADATA = {'metadata_version': '1.1', 29 | 'status': ['preview'], 30 | 'supported_by': 'community'} 31 | 32 | DOCUMENTATION = r''' 33 | --- 34 | module: xml 35 | short_description: Manage bits and pieces of XML files or strings 36 | description: 37 | - A CRUD-like interface to managing bits of XML files. 38 | - You might also be interested in a brief tutorial from U(http://www.w3schools.com/xpath/). 39 | version_added: '2.4' 40 | options: 41 | path: 42 | description: 43 | - Path to the file to operate on. File must exist ahead of time. 44 | - This parameter is required, unless C(xmlstring) is given. 45 | required: yes 46 | aliases: [ dest, file ] 47 | xmlstring: 48 | description: 49 | - A string containing XML on which to operate. 50 | - This parameter is required, unless C(path) is given. 51 | required: yes 52 | xpath: 53 | description: 54 | - A valid XPath expression describing the item(s) you want to manipulate. 55 | - Operates on the document root, C(/), by default. 56 | default: / 57 | namespaces: 58 | description: 59 | - The namespace C(prefix:uri) mapping for the XPath expression. 60 | - Needs to be a C(dict), not a C(list) of items. 61 | state: 62 | description: 63 | - Set or remove an xpath selection (node(s), attribute(s)). 64 | default: present 65 | choices: [ absent, present ] 66 | aliases: [ ensure ] 67 | value: 68 | description: 69 | - Desired state of the selected attribute. 70 | - Either a string, or to unset a value, the Python C(None) keyword (YAML Equivalent, C(null)). 71 | - Elements default to no value (but present). 72 | - Attributes default to an empty string. 73 | add_children: 74 | description: 75 | - Add additional child-element(s) to a selected element. 76 | - Child elements must be given in a list and each item may be either a string 77 | (eg. C(children=ansible) to add an empty C() child element), 78 | or a hash where the key is an element name and the value is the element value. 79 | set_children: 80 | description: 81 | - Set the the child-element(s) of a selected element. 82 | - Removes any existing children. 83 | - Child elements must be specified as in C(add_children). 84 | count: 85 | description: 86 | - Search for a given C(xpath) and provide the count of any matches. 87 | type: bool 88 | default: 'no' 89 | print_match: 90 | description: 91 | - Search for a given C(xpath) and print out any matches. 92 | type: bool 93 | default: 'no' 94 | pretty_print: 95 | description: 96 | - Pretty print XML output. 97 | type: bool 98 | default: 'no' 99 | content: 100 | description: 101 | - Search for a given C(xpath) and get content. 102 | choices: [ attribute, text ] 103 | input_type: 104 | description: 105 | - Type of input for C(add_children) and C(set_children). 106 | choices: [ xml, yaml ] 107 | default: yaml 108 | requirements: 109 | - lxml >= 2.3.0 110 | notes: 111 | - This module does not handle complicated xpath expressions, so limit xpath selectors to simple expressions. 112 | - Beware that in case your XML elements are namespaced, you need to use the C(namespaces) parameter. 113 | - Namespaces prefix should be used for all children of an element where namespace is defined, unless another namespace is defined for them. 114 | author: 115 | - Tim Bielawa (@tbielawa) 116 | - Magnus Hedemark (@magnus919) 117 | - Dag Wieers (@dagwieers) 118 | - Marko Stanković (@sm4rk0) 119 | - Christopher Prescott (@cmprescott) 120 | ''' 121 | 122 | EXAMPLES = r''' 123 | - name: Remove the subjective attribute of the rating element 124 | xml: 125 | path: /foo/bar.xml 126 | xpath: /business/rating/@subjective 127 | state: absent 128 | 129 | - name: Set the rating to 11 130 | xml: 131 | path: /foo/bar.xml 132 | xpath: /business/rating 133 | value: 11 134 | 135 | # Retrieve and display the number of nodes 136 | - name: Get count of beers nodes 137 | xml: 138 | path: /foo/bar.xml 139 | xpath: /business/beers/beer 140 | count: yes 141 | register: hits 142 | 143 | - debug: 144 | var: hits.count 145 | 146 | - name: Add a phonenumber element to the business element 147 | xml: 148 | path: /foo/bar.xml 149 | xpath: /business/phonenumber 150 | value: 555-555-1234 151 | 152 | - name: Add several more beers to the beers element 153 | xml: 154 | path: /foo/bar.xml 155 | xpath: /business/beers 156 | add_children: 157 | - beer: Old Rasputin 158 | - beer: Old Motor Oil 159 | - beer: Old Curmudgeon 160 | 161 | - name: Add a validxhtml element to the website element 162 | xml: 163 | path: /foo/bar.xml 164 | xpath: /business/website/validxhtml 165 | 166 | - name: Add an empty validatedon attribute to the validxhtml element 167 | xml: 168 | path: /foo/bar.xml 169 | xpath: /business/website/validxhtml/@validatedon 170 | 171 | - name: Remove all children from the website element (option 1) 172 | xml: 173 | path: /foo/bar.xml 174 | xpath: /business/website/* 175 | state: absent 176 | 177 | - name: Remove all children from the website element (option 2) 178 | xml: 179 | path: /foo/bar.xml 180 | xpath: /business/website 181 | children: [] 182 | 183 | # In case of namespaces, like in below XML, they have to be explicitely stated 184 | # Note: there's the prefix "x" in front of the "bar", too 185 | # 186 | # 187 | # 188 | # 189 | # 190 | # 191 | 192 | - name: Set namespaced '/x:foo/x:bar/y:baz/@z:my_namespaced_attribute' to 'false' 193 | xml: 194 | path: foo.xml 195 | xpath: /x:foo/x:bar/y:baz 196 | namespaces: 197 | x: http://x.test 198 | y: http://y.test 199 | z: http://z.test 200 | attribute: z:my_namespaced_attribute 201 | value: "false" 202 | ''' 203 | 204 | RETURN = r''' 205 | actions: 206 | description: A dictionary with the original xpath, namespaces and state. 207 | type: dict 208 | returned: success 209 | sample: {xpath: xpath, namespaces: [namespace1, namespace2], state=present} 210 | count: 211 | description: The count of xpath matches. 212 | type: int 213 | returned: when parameter 'count' is set 214 | sample: 2 215 | matches: 216 | description: The xpath matches found. 217 | type: list 218 | returned: when parameter 'print_match' is set 219 | msg: 220 | description: A message related to the performed action(s). 221 | type: string 222 | returned: always 223 | xmlstring: 224 | description: An XML string of the resulting output. 225 | type: string 226 | returned: when parameter 'xmlstring' is set 227 | ''' 228 | 229 | import json 230 | import os 231 | import re 232 | import traceback 233 | 234 | from collections import MutableMapping 235 | from distutils.version import LooseVersion 236 | from io import BytesIO 237 | 238 | 239 | HAS_LXML = True 240 | try: 241 | from lxml import etree 242 | except ImportError: 243 | HAS_LXML = False 244 | 245 | from ansible.module_utils.basic import AnsibleModule, json_dict_bytes_to_unicode 246 | from ansible.module_utils.six import iteritems, string_types 247 | from ansible.module_utils._text import to_bytes, to_native 248 | 249 | _IDENT = "[a-zA-Z-][a-zA-Z0-9_\-\.]*" 250 | _NSIDENT = _IDENT + "|" + _IDENT + ":" + _IDENT 251 | # Note: we can't reasonably support the 'if you need to put both ' and " in a string, concatenate 252 | # strings wrapped by the other delimiter' XPath trick, especially as simple XPath. 253 | _XPSTR = "('(?:.*)'|\"(?:.*)\")" 254 | 255 | _RE_SPLITSIMPLELAST = re.compile("^(.*)/(" + _NSIDENT + ")$") 256 | _RE_SPLITSIMPLELASTEQVALUE = re.compile("^(.*)/(" + _NSIDENT + ")/text\\(\\)=" + _XPSTR + "$") 257 | _RE_SPLITSIMPLEATTRLAST = re.compile("^(.*)/(@(?:" + _NSIDENT + "))$") 258 | _RE_SPLITSIMPLEATTRLASTEQVALUE = re.compile("^(.*)/(@(?:" + _NSIDENT + "))=" + _XPSTR + "$") 259 | _RE_SPLITSUBLAST = re.compile("^(.*)/(" + _NSIDENT + ")\\[(.*)\\]$") 260 | _RE_SPLITONLYEQVALUE = re.compile("^(.*)/text\\(\\)=" + _XPSTR + "$") 261 | 262 | 263 | def print_match(module, tree, xpath, namespaces): 264 | match = tree.xpath(xpath, namespaces=namespaces) 265 | match_xpaths = [] 266 | for m in match: 267 | match_xpaths.append(tree.getpath(m)) 268 | match_str = json.dumps(match_xpaths) 269 | msg = "selector '%s' match: %s" % (xpath, match_str) 270 | finish(module, tree, xpath, namespaces, changed=False, msg=msg) 271 | 272 | 273 | def count_nodes(module, tree, xpath, namespaces): 274 | """ Return the count of nodes matching the xpath """ 275 | hits = tree.xpath("count(/%s)" % xpath, namespaces=namespaces) 276 | finish(module, tree, xpath, namespaces, changed=False, msg=int(hits), hitcount=int(hits)) 277 | 278 | 279 | def is_node(tree, xpath, namespaces): 280 | """ Test if a given xpath matches anything and if that match is a node. 281 | 282 | For now we just assume you're only searching for one specific thing.""" 283 | if xpath_matches(tree, xpath, namespaces): 284 | # OK, it found something 285 | match = tree.xpath(xpath, namespaces=namespaces) 286 | if isinstance(match[0], etree._Element): 287 | return True 288 | 289 | return False 290 | 291 | 292 | def is_attribute(tree, xpath, namespaces): 293 | """ Test if a given xpath matches and that match is an attribute 294 | 295 | An xpath attribute search will only match one item""" 296 | if xpath_matches(tree, xpath, namespaces): 297 | match = tree.xpath(xpath, namespaces=namespaces) 298 | if isinstance(match[0], etree._ElementStringResult): 299 | return True 300 | elif isinstance(match[0], etree._ElementUnicodeResult): 301 | return True 302 | return False 303 | 304 | 305 | def xpath_matches(tree, xpath, namespaces): 306 | """ Test if a node exists """ 307 | if tree.xpath(xpath, namespaces=namespaces): 308 | return True 309 | else: 310 | return False 311 | 312 | 313 | def delete_xpath_target(module, tree, xpath, namespaces): 314 | """ Delete an attribute or element from a tree """ 315 | try: 316 | for result in tree.xpath(xpath, namespaces=namespaces): 317 | # Get the xpath for this result 318 | if is_attribute(tree, xpath, namespaces): 319 | # Delete an attribute 320 | parent = result.getparent() 321 | # Pop this attribute match out of the parent 322 | # node's 'attrib' dict by using this match's 323 | # 'attrname' attribute for the key 324 | parent.attrib.pop(result.attrname) 325 | elif is_node(tree, xpath, namespaces): 326 | # Delete an element 327 | result.getparent().remove(result) 328 | else: 329 | raise Exception("Impossible error") 330 | except Exception as e: 331 | module.fail_json(msg="Couldn't delete xpath target: %s (%s)" % (xpath, e)) 332 | else: 333 | finish(module, tree, xpath, namespaces, changed=True) 334 | 335 | 336 | def replace_children_of(children, match): 337 | for element in match.getchildren(): 338 | match.remove(element) 339 | match.extend(children) 340 | 341 | 342 | def set_target_children_inner(module, tree, xpath, namespaces, children, in_type): 343 | matches = tree.xpath(xpath, namespaces=namespaces) 344 | 345 | # Create a list of our new children 346 | children = children_to_nodes(module, children, in_type) 347 | children_as_string = [etree.tostring(c) for c in children] 348 | 349 | changed = False 350 | 351 | # xpaths always return matches as a list, so.... 352 | for match in matches: 353 | # Check if elements differ 354 | if len(match.getchildren()) == len(children): 355 | for idx, element in enumerate(match.getchildren()): 356 | if etree.tostring(element) != children_as_string[idx]: 357 | replace_children_of(children, match) 358 | changed = True 359 | break 360 | else: 361 | replace_children_of(children, match) 362 | changed = True 363 | 364 | return changed 365 | 366 | 367 | def set_target_children(module, tree, xpath, namespaces, children, in_type): 368 | changed = set_target_children_inner(module, tree, xpath, namespaces, children, in_type) 369 | # Write it out 370 | finish(module, tree, xpath, namespaces, changed=changed) 371 | 372 | 373 | def add_target_children(module, tree, xpath, namespaces, children, in_type): 374 | if is_node(tree, xpath, namespaces): 375 | new_kids = children_to_nodes(module, children, in_type) 376 | for node in tree.xpath(xpath, namespaces=namespaces): 377 | node.extend(new_kids) 378 | finish(module, tree, xpath, namespaces, changed=True) 379 | else: 380 | finish(module, tree, xpath, namespaces) 381 | 382 | 383 | def _extract_xpstr(g): 384 | return g[1:-1] 385 | 386 | 387 | def split_xpath_last(xpath): 388 | """split an XPath of the form /foo/bar/baz into /foo/bar and baz""" 389 | xpath = xpath.strip() 390 | m = _RE_SPLITSIMPLELAST.match(xpath) 391 | if m: 392 | # requesting an element to exist 393 | return (m.group(1), [(m.group(2), None)]) 394 | m = _RE_SPLITSIMPLELASTEQVALUE.match(xpath) 395 | if m: 396 | # requesting an element to exist with an inner text 397 | return (m.group(1), [(m.group(2), _extract_xpstr(m.group(3)))]) 398 | 399 | m = _RE_SPLITSIMPLEATTRLAST.match(xpath) 400 | if m: 401 | # requesting an attribute to exist 402 | return (m.group(1), [(m.group(2), None)]) 403 | m = _RE_SPLITSIMPLEATTRLASTEQVALUE.match(xpath) 404 | if m: 405 | # requesting an attribute to exist with a value 406 | return (m.group(1), [(m.group(2), _extract_xpstr(m.group(3)))]) 407 | 408 | m = _RE_SPLITSUBLAST.match(xpath) 409 | if m: 410 | content = [x.strip() for x in m.group(3).split(" and ")] 411 | return (m.group(1), [('/' + m.group(2), content)]) 412 | 413 | m = _RE_SPLITONLYEQVALUE.match(xpath) 414 | if m: 415 | # requesting a change of inner text 416 | return (m.group(1), [("", _extract_xpstr(m.group(2)))]) 417 | return (xpath, []) 418 | 419 | 420 | def nsnameToClark(name, namespaces): 421 | if ":" in name: 422 | (nsname, rawname) = name.split(":") 423 | # return "{{%s}}%s" % (namespaces[nsname], rawname) 424 | return "{{{0}}}{1}".format(namespaces[nsname], rawname) 425 | else: 426 | # no namespace name here 427 | return name 428 | 429 | 430 | def check_or_make_target(module, tree, xpath, namespaces): 431 | (inner_xpath, changes) = split_xpath_last(xpath) 432 | if (inner_xpath == xpath) or (changes is None): 433 | module.fail_json(msg="Can't process Xpath %s in order to spawn nodes! tree is %s" % 434 | (xpath, etree.tostring(tree, pretty_print=True))) 435 | return False 436 | 437 | changed = False 438 | 439 | if not is_node(tree, inner_xpath, namespaces): 440 | changed = check_or_make_target(module, tree, inner_xpath, namespaces) 441 | 442 | # we test again after calling check_or_make_target 443 | if is_node(tree, inner_xpath, namespaces) and changes: 444 | for (eoa, eoa_value) in changes: 445 | if eoa and eoa[0] != '@' and eoa[0] != '/': 446 | # implicitly creating an element 447 | new_kids = children_to_nodes(module, [nsnameToClark(eoa, namespaces)], "yaml") 448 | if eoa_value: 449 | for nk in new_kids: 450 | nk.text = eoa_value 451 | 452 | for node in tree.xpath(inner_xpath, namespaces=namespaces): 453 | node.extend(new_kids) 454 | changed = True 455 | # module.fail_json(msg="now tree=%s" % etree.tostring(tree, pretty_print=True)) 456 | elif eoa and eoa[0] == '/': 457 | element = eoa[1:] 458 | new_kids = children_to_nodes(module, [nsnameToClark(element, namespaces)], "yaml") 459 | for node in tree.xpath(inner_xpath, namespaces=namespaces): 460 | node.extend(new_kids) 461 | for nk in new_kids: 462 | for subexpr in eoa_value: 463 | # module.fail_json(msg="element=%s subexpr=%s node=%s now tree=%s" % 464 | # (element, subexpr, etree.tostring(node, pretty_print=True), etree.tostring(tree, pretty_print=True)) 465 | check_or_make_target(module, nk, "./" + subexpr, namespaces) 466 | changed = True 467 | 468 | # module.fail_json(msg="now tree=%s" % etree.tostring(tree, pretty_print=True)) 469 | elif eoa == "": 470 | for node in tree.xpath(inner_xpath, namespaces=namespaces): 471 | if (node.text != eoa_value): 472 | node.text = eoa_value 473 | changed = True 474 | 475 | elif eoa and eoa[0] == '@': 476 | attribute = nsnameToClark(eoa[1:], namespaces) 477 | 478 | for element in tree.xpath(inner_xpath, namespaces=namespaces): 479 | changing = (attribute not in element.attrib or element.attrib[attribute] != eoa_value) 480 | 481 | if changing: 482 | changed = changed or changing 483 | if eoa_value is None: 484 | value = "" 485 | else: 486 | value = eoa_value 487 | element.attrib[attribute] = value 488 | 489 | # module.fail_json(msg="arf %s changing=%s as curval=%s changed tree=%s" % 490 | # (xpath, changing, etree.tostring(tree, changing, element[attribute], pretty_print=True))) 491 | 492 | else: 493 | module.fail_json(msg="unknown tree transformation=%s" % etree.tostring(tree, pretty_print=True)) 494 | 495 | return changed 496 | 497 | 498 | def ensure_xpath_exists(module, tree, xpath, namespaces): 499 | changed = False 500 | 501 | if not is_node(tree, xpath, namespaces): 502 | changed = check_or_make_target(module, tree, xpath, namespaces) 503 | 504 | finish(module, tree, xpath, namespaces, changed) 505 | 506 | 507 | def set_target_inner(module, tree, xpath, namespaces, attribute, value): 508 | changed = False 509 | 510 | try: 511 | if not is_node(tree, xpath, namespaces): 512 | changed = check_or_make_target(module, tree, xpath, namespaces) 513 | except Exception as e: 514 | module.fail_json(msg="Xpath %s causes a failure: %s\n -- tree is %s" % 515 | (xpath, e, etree.tostring(tree, pretty_print=True)), exception=traceback.format_exc(e)) 516 | 517 | if not is_node(tree, xpath, namespaces): 518 | module.fail_json(msg="Xpath %s does not reference a node! tree is %s" % 519 | (xpath, etree.tostring(tree, pretty_print=True))) 520 | 521 | for element in tree.xpath(xpath, namespaces=namespaces): 522 | if not attribute: 523 | changed = changed or (element.text != value) 524 | if element.text != value: 525 | element.text = value 526 | else: 527 | changed = changed or (element.get(attribute) != value) 528 | if ":" in attribute: 529 | attr_ns, attr_name = attribute.split(":") 530 | # attribute = "{{%s}}%s" % (namespaces[attr_ns], attr_name) 531 | attribute = "{{{0}}}{1}".format(namespaces[attr_ns], attr_name) 532 | if element.get(attribute) != value: 533 | element.set(attribute, value) 534 | 535 | return changed 536 | 537 | 538 | def set_target(module, tree, xpath, namespaces, attribute, value): 539 | changed = set_target_inner(module, tree, xpath, namespaces, attribute, value) 540 | finish(module, tree, xpath, namespaces, changed) 541 | 542 | 543 | def pretty(module, tree): 544 | xml_string = etree.tostring(tree, xml_declaration=True, encoding='UTF-8', pretty_print=module.params['pretty_print']) 545 | 546 | result = dict( 547 | changed=False, 548 | ) 549 | 550 | if module.params['path']: 551 | xml_file = module.params['path'] 552 | xml_content = open(xml_file) 553 | try: 554 | if xml_string != xml_content.read(): 555 | result['changed'] = True 556 | if not module.check_mode: 557 | tree.write(xml_file, xml_declaration=True, encoding='UTF-8', pretty_print=module.params['pretty_print']) 558 | finally: 559 | xml_content.close() 560 | 561 | elif module.params['xmlstring']: 562 | result['xmlstring'] = xml_string 563 | if xml_string != module.params['xmlstring']: 564 | result['changed'] = True 565 | 566 | module.exit_json(**result) 567 | 568 | 569 | def get_element_text(module, tree, xpath, namespaces): 570 | if not is_node(tree, xpath, namespaces): 571 | module.fail_json(msg="Xpath %s does not reference a node!" % xpath) 572 | 573 | elements = [] 574 | for element in tree.xpath(xpath, namespaces=namespaces): 575 | elements.append({element.tag: element.text}) 576 | 577 | finish(module, tree, xpath, namespaces, changed=False, msg=len(elements), hitcount=len(elements), matches=elements) 578 | 579 | 580 | def get_element_attr(module, tree, xpath, namespaces): 581 | if not is_node(tree, xpath, namespaces): 582 | module.fail_json(msg="Xpath %s does not reference a node!" % xpath) 583 | 584 | elements = [] 585 | for element in tree.xpath(xpath, namespaces=namespaces): 586 | child = {} 587 | for key in element.keys(): 588 | value = element.get(key) 589 | child.update({key: value}) 590 | elements.append({element.tag: child}) 591 | 592 | finish(module, tree, xpath, namespaces, changed=False, msg=len(elements), hitcount=len(elements), matches=elements) 593 | 594 | 595 | def child_to_element(module, child, in_type): 596 | if in_type == 'xml': 597 | infile = BytesIO(to_bytes(child, errors='surrogate_or_strict')) 598 | 599 | try: 600 | parser = etree.XMLParser() 601 | node = etree.parse(infile, parser) 602 | return node.getroot() 603 | except etree.XMLSyntaxError as e: 604 | module.fail_json(msg="Error while parsing child element: %s" % e) 605 | elif in_type == 'yaml': 606 | if isinstance(child, string_types): 607 | return etree.Element(child) 608 | elif isinstance(child, MutableMapping): 609 | if len(child) > 1: 610 | module.fail_json(msg="Can only create children from hashes with one key") 611 | 612 | (key, value) = next(iteritems(child)) 613 | if isinstance(value, MutableMapping): 614 | children = value.pop('_', None) 615 | 616 | node = etree.Element(key, value) 617 | 618 | if children is not None: 619 | if not isinstance(children, list): 620 | module.fail_json(msg="Invalid children type: %s, must be list." % type(children)) 621 | 622 | subnodes = children_to_nodes(module, children) 623 | node.extend(subnodes) 624 | else: 625 | node = etree.Element(key) 626 | node.text = value 627 | return node 628 | else: 629 | module.fail_json(msg="Invalid child type: %s. Children must be either strings or hashes." % type(child)) 630 | else: 631 | module.fail_json(msg="Invalid child input type: %s. Type must be either xml or yaml." % in_type) 632 | 633 | 634 | def children_to_nodes(module=None, children=[], type='yaml'): 635 | """turn a str/hash/list of str&hash into a list of elements""" 636 | return [child_to_element(module, child, type) for child in children] 637 | 638 | 639 | def finish(module, tree, xpath, namespaces, changed=False, msg="", hitcount=0, matches=tuple()): 640 | actions = dict(xpath=xpath, namespaces=namespaces, state=module.params['state']) 641 | 642 | if not changed: 643 | module.exit_json(changed=changed, actions=actions, msg=msg, count=hitcount, matches=matches) 644 | 645 | if module.params['path']: 646 | if not module.check_mode: 647 | tree.write(module.params['path'], xml_declaration=True, encoding='UTF-8', pretty_print=module.params['pretty_print']) 648 | module.exit_json(changed=changed, actions=actions, msg=msg, count=hitcount, matches=matches) 649 | 650 | if module.params['xmlstring']: 651 | xml_string = etree.tostring(tree, xml_declaration=True, encoding='UTF-8', pretty_print=module.params['pretty_print']) 652 | module.exit_json(changed=changed, actions=actions, msg=msg, count=hitcount, matches=matches, xmlstring=xml_string) 653 | 654 | 655 | def main(): 656 | module = AnsibleModule( 657 | argument_spec=dict( 658 | path=dict(type='path', aliases=['dest', 'file']), 659 | xmlstring=dict(type='str'), 660 | xpath=dict(type='str', default='/'), 661 | namespaces=dict(type='dict', default={}), 662 | state=dict(type='str', default='present', choices=['absent', 'present'], aliases=['ensure']), 663 | value=dict(), 664 | attribute=dict(), 665 | add_children=dict(type='list'), 666 | set_children=dict(type='list'), 667 | count=dict(type='bool', default=False), 668 | print_match=dict(type='bool', default=False), 669 | pretty_print=dict(type='bool', default=False), 670 | content=dict(type='str', choices=['attribute', 'text']), 671 | input_type=dict(type='str', default='yaml', choices=['xml', 'yaml']) 672 | ), 673 | supports_check_mode=True, 674 | mutually_exclusive=[ 675 | ['value', 'set_children'], 676 | ['value', 'add_children'], 677 | ['set_children', 'add_children'], 678 | ['path', 'xmlstring'], 679 | ['content', 'set_children'], 680 | ['content', 'add_children'], 681 | ['content', 'value'], 682 | ] 683 | ) 684 | 685 | xml_file = module.params['path'] 686 | xml_string = module.params['xmlstring'] 687 | xpath = module.params['xpath'] 688 | namespaces = module.params['namespaces'] 689 | state = module.params['state'] 690 | value = json_dict_bytes_to_unicode(module.params['value']) 691 | attribute = module.params['attribute'] 692 | set_children = json_dict_bytes_to_unicode(module.params['set_children']) 693 | add_children = json_dict_bytes_to_unicode(module.params['add_children']) 694 | pretty_print = module.params['pretty_print'] 695 | content = module.params['content'] 696 | input_type = module.params['input_type'] 697 | print_match = module.params['print_match'] 698 | count = module.params['count'] 699 | 700 | # Check if we have lxml 2.3.0 or newer installed 701 | if not HAS_LXML: 702 | module.fail_json(msg='The xml ansible module requires the lxml python library installed on the managed machine') 703 | elif LooseVersion('.'.join(to_native(f) for f in etree.LXML_VERSION)) < LooseVersion('2.3.0'): 704 | module.fail_json(msg='The xml ansible module requires lxml 2.3.0 or newer installed on the managed machine') 705 | elif LooseVersion('.'.join(to_native(f) for f in etree.LXML_VERSION)) < LooseVersion('3.0.0'): 706 | module.warn('Using lxml version lower than 3.0.0 does not guarantee predictable element attribute order.') 707 | 708 | # Check if the file exists 709 | if xml_string: 710 | infile = BytesIO(to_bytes(xml_string, errors='surrogate_or_strict')) 711 | elif os.path.isfile(xml_file): 712 | infile = open(xml_file, 'rb') 713 | else: 714 | module.fail_json(msg="The target XML source '%s' does not exist." % xml_file) 715 | 716 | # Try to parse in the target XML file 717 | try: 718 | parser = etree.XMLParser(remove_blank_text=pretty_print) 719 | doc = etree.parse(infile, parser) 720 | except etree.XMLSyntaxError as e: 721 | module.fail_json(msg="Error while parsing path: %s" % e) 722 | 723 | if print_match: 724 | print_match(module, doc, xpath, namespaces) 725 | 726 | if count: 727 | count_nodes(module, doc, xpath, namespaces) 728 | 729 | if content == 'attribute': 730 | get_element_attr(module, doc, xpath, namespaces) 731 | elif content == 'text': 732 | get_element_text(module, doc, xpath, namespaces) 733 | 734 | # module.fail_json(msg="OK. Well, etree parsed the xml file...") 735 | 736 | # module.exit_json(what_did={"foo": "bar"}, changed=True) 737 | 738 | # File exists: 739 | if state == 'absent': 740 | # - absent: delete xpath target 741 | delete_xpath_target(module, doc, xpath, namespaces) 742 | # Exit 743 | # - present: carry on 744 | 745 | # children && value both set?: should have already aborted by now 746 | # add_children && set_children both set?: should have already aborted by now 747 | 748 | # set_children set? 749 | if set_children: 750 | set_target_children(module, doc, xpath, namespaces, set_children, input_type) 751 | 752 | # add_children set? 753 | if add_children: 754 | add_target_children(module, doc, xpath, namespaces, add_children, input_type) 755 | 756 | # No?: Carry on 757 | 758 | # Is the xpath target an attribute selector? 759 | if value is not None: 760 | set_target(module, doc, xpath, namespaces, attribute, value) 761 | 762 | # Format the xml only? 763 | if pretty_print: 764 | pretty(module, doc) 765 | 766 | ensure_xpath_exists(module, doc, xpath, namespaces) 767 | # module.fail_json(msg="don't know what to do") 768 | 769 | 770 | if __name__ == '__main__': 771 | main() -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------