Merge pull request #657 from smadam813/devel

Adding win_regedit module.

windows/win_regedit.ps1

@@ -0,0 +1,190 @@
+#!powershell
+# This file is part of Ansible
+#
+# (c) 2015, Adam Keech <akeech@chathamfinancial.com>, Josh Ludwig <jludwig@chathamfinancial.com>
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+$ErrorActionPreference = "Stop"
+
+# WANT_JSON
+# POWERSHELL_COMMON
+
+$params = Parse-Args $args;
+$result = New-Object PSObject;
+Set-Attr $result "changed" $false;
+
+If ($params.key)
+{
+    $registryKey = $params.key
+}
+Else
+{
+    Fail-Json $result "missing required argument: key"
+}
+
+If ($params.value)
+{
+    $registryValue = $params.value
+}
+Else
+{
+    $registryValue = $null
+}
+
+If ($params.state)
+{
+    $state = $params.state.ToString().ToLower()
+    If (($state -ne "present") -and ($state -ne "absent"))
+    {
+        Fail-Json $result "state is $state; must be present or absent"
+    }
+}
+Else
+{
+    $state = "present"
+}
+
+If ($params.data)
+{
+    $registryData = $params.data
+}
+ElseIf ($state -eq "present" -and $registryValue -ne $null)
+{
+    Fail-Json $result "missing required argument: data"
+}
+
+If ($params.datatype)
+{
+    $registryDataType = $params.datatype.ToString().ToLower()
+    $validRegistryDataTypes = "binary", "dword", "expandstring", "multistring", "string", "qword"
+    If ($validRegistryDataTypes -notcontains $registryDataType)
+    {
+        Fail-Json $result "type is $registryDataType; must be binary, dword, expandstring, multistring, string, or qword"
+    }
+}
+Else
+{
+    $registryDataType = "string"
+}
+
+Function Test-RegistryValueData {
+    Param (
+        [parameter(Mandatory=$true)]
+        [ValidateNotNullOrEmpty()]$Path,
+        [parameter(Mandatory=$true)]
+        [ValidateNotNullOrEmpty()]$Value
+    )
+    Try {
+        Get-ItemProperty -Path $Path -Name $Value
+        Return $true
+    }
+    Catch {
+        Return $false
+    }
+}
+
+if($state -eq "present") {
+    if ((Test-Path $registryKey) -and $registryValue -ne $null)
+    {
+        if (Test-RegistryValueData -Path $registryKey -Value $registryValue)
+        {
+            # Changes Data and DataType
+            if ((Get-Item $registryKey).GetValueKind($registryValue) -ne $registryDataType)
+            {
+                Try
+                {
+                    Remove-ItemProperty -Path $registryKey -Name $registryValue
+                    New-ItemProperty -Path $registryKey -Name $registryValue -Value $registryData -PropertyType $registryDataType
+                    $result.changed = $true
+                }
+                Catch
+                {
+                    Fail-Json $result $_.Exception.Message
+                }
+            }
+            # Changes Only Data
+            elseif ((Get-ItemProperty -Path $registryKey | Select-Object -ExpandProperty $registryValue) -ne $registryData) 
+            {
+                Try {
+                    Set-ItemProperty -Path $registryKey -Name $registryValue -Value $registryData
+                    $result.changed = $true
+                }
+                Catch
+                {
+                    Fail-Json $result $_.Exception.Message
+                }
+            }
+        }
+        else
+        {
+            Try
+            {
+                New-ItemProperty -Path $registryKey -Name $registryValue -Value $registryData -PropertyType $registryDataType
+                $result.changed = $true
+            }
+            Catch
+            {
+                Fail-Json $result $_.Exception.Message
+            }
+        }
+    }
+    elseif(-not (Test-Path $registryKey))
+    {
+        Try 
+        {
+            $newRegistryKey = New-Item $registryKey -Force
+            $result.changed = $true
+
+            if($registryValue -ne $null) {
+                $newRegistryKey | New-ItemProperty -Name $registryValue -Value $registryData -Force -PropertyType $registryDataType
+                $result.changed = $true
+            }
+        }
+        Catch
+        {
+            Fail-Json $result $_.Exception.Message
+        }
+    }
+}
+else
+{
+    if (Test-Path $registryKey)
+    {
+        if ($registryValue -eq $null) {
+            Try
+            {
+                Remove-Item -Path $registryKey -Recurse
+                $result.changed = $true
+            }
+            Catch
+            {
+                Fail-Json $result $_.Exception.Message
+            }
+        }
+        elseif (Test-RegistryValueData -Path $registryKey -Value $registryValue) {
+            Try
+            {
+                Remove-ItemProperty -Path $registryKey -Name $registryValue
+                $result.changed = $true
+            }
+            Catch
+            {
+                Fail-Json $result $_.Exception.Message
+            }
+        }
+    }
+}
+
+Exit-Json $result

windows/win_regedit.py

@@ -0,0 +1,109 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2015, Adam Keech <akeech@chathamfinancial.com>, Josh Ludwig <jludwig@chathamfinancial.com>
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+# this is a windows documentation stub.  actual code lives in the .ps1
+# file of the same name
+
+DOCUMENTATION = '''
+---
+module: win_regedit
+version_added: "2.0"
+short_description: Add, Edit, or Remove Registry Keys and Values
+description:
+    - Add, Edit, or Remove Registry Keys and Values using ItemProperties Cmdlets
+options:
+  key:
+    description:
+      - Name of Registry Key
+    required: true
+    default: null
+    aliases: []
+  value:
+    description:
+      - Name of Registry Value
+    required: true
+    default: null
+    aliases: []
+  data:
+    description:
+      - Registry Value Data
+    required: false
+    default: null
+    aliases: []
+  datatype:
+    description:
+      - Registry Value Data Type
+    required: false
+    choices:
+      - binary
+      - dword
+      - expandstring
+      - multistring
+      - string
+      - qword
+    default: string
+    aliases: []
+  state:
+    description:
+      - State of Registry Value
+    required: false
+    choices:
+      - present
+      - absent
+    default: present
+    aliases: []
+author: "Adam Keech (@smadam813), Josh Ludwig (@joshludwig)"
+'''
+
+EXAMPLES = '''
+  # Creates Registry Key called MyCompany.
+  win_regedit:
+    key: HKCU:\Software\MyCompany
+    
+  # Creates Registry Key called MyCompany,
+  # a value within MyCompany Key called "hello", and
+  # data for the value "hello" containing "world".
+  win_regedit:
+    key: HKCU:\Software\MyCompany
+    value: hello
+    data: world
+
+  # Creates Registry Key called MyCompany,
+  # a value within MyCompany Key called "hello", and
+  # data for the value "hello" containing "1337" as type "dword".
+  win_regedit:
+    key: HKCU:\Software\MyCompany
+    value: hello
+    data: 1337
+    datatype: dword
+
+  # Delete Registry Key MyCompany
+  # NOTE: Not specifying a value will delete the root key which means
+  # all values will be deleted
+  win_regedit:
+    key: HKCU:\Software\MyCompany
+    state: absent
+    
+  # Delete Registry Value "hello" from MyCompany Key
+  win_regedit:
+    key: HKCU:\Software\MyCompany
+    value: hello
+    state: absent
+'''