1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
#
# Author:: Doug Ireton (<doug@1strategy.com>)
# Copyright:: 2012-2018, Nordstrom, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# See here for more info:
# http://msdn.microsoft.com/en-us/library/windows/desktop/aa394492(v=vs.85).aspx
require_relative "../resource"
class Chef
class Resource
class WindowsPrinter < Chef::Resource
unified_mode true
autoload :Resolv, "resolv"
provides(:windows_printer) { true }
description "Use the **windows_printer** resource to setup Windows printers. Note that this doesn't currently install a printer driver. You must already have the driver installed on the system."
introduced "14.0"
examples <<~DOC
**Create a printer**:
```ruby
windows_printer 'HP LaserJet 5th Floor' do
driver_name 'HP LaserJet 4100 Series PCL6'
ipv4_address '10.4.64.38'
end
```
**Delete a printer**:
Note: this doesn't delete the associated printer port. See windows_printer_port above for how to delete the port.
```ruby
windows_printer 'HP LaserJet 5th Floor' do
action :delete
end
```
DOC
property :device_id, String,
description: "An optional property to set the printer queue name if it differs from the resource block's name. Example: `HP LJ 5200 in fifth floor copy room`.",
name_property: true
property :comment, String,
description: "Optional descriptor for the printer queue."
property :default, [TrueClass, FalseClass],
description: "Determines whether or not this should be the system's default printer.",
default: false
property :driver_name, String,
description: "The exact name of printer driver installed on the system.",
required: [:create]
property :location, String,
description: "Printer location, such as `Fifth floor copy room`."
property :shared, [TrueClass, FalseClass],
description: "Determines whether or not the printer is shared.",
default: false
property :share_name, String,
description: "The name used to identify the shared printer."
property :ipv4_address, String,
description: "The IPv4 address of the printer, such as `10.4.64.23`",
callbacks: {
"The ipv4_address property must be in the IPv4 format of `WWW.XXX.YYY.ZZZ`" =>
proc { |v| v.match(Resolv::IPv4::Regex) },
}
PRINTERS_REG_KEY = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Print\Printers\\'.freeze unless defined?(PRINTERS_REG_KEY)
# @todo Set @current_resource printer properties from registry
load_current_value do |desired|
name desired.name
end
action :create, description: "Create a new printer and printer port, if one doesn't already" do
description "Create a new printer and a printer port if one doesn't already exist."
if printer_exists?
Chef::Log.info "#{@new_resource} already exists - nothing to do."
else
converge_by("Create #{@new_resource}") do
create_printer
end
end
end
action :delete, description: "Delete an existing printer. Note that this resource does not delete the associated printer port." do
description "Delete an existing printer. Note this does not delete the associated printer port."
if printer_exists?
converge_by("Delete #{@new_resource}") do
delete_printer
end
else
Chef::Log.info "#{@current_resource} doesn't exist - can't delete."
end
end
action_class do
private
# does the printer exist
#
# @param [String] name the name of the printer
# @return [Boolean]
def printer_exists?
printer_reg_key = PRINTERS_REG_KEY + new_resource.name
logger.trace "Checking to see if this reg key exists: '#{printer_reg_key}'"
registry_key_exists?(printer_reg_key)
end
# creates the printer port and then the printer
def create_printer
# Create the printer port first
windows_printer_port new_resource.ipv4_address
port_name = "IP_#{new_resource.ipv4_address}"
declare_resource(:powershell_script, "Creating printer: #{new_resource.device_id}") do
code <<-EOH
Set-WmiInstance -class Win32_Printer `
-EnableAllPrivileges `
-Argument @{ DeviceID = "#{new_resource.device_id}";
Comment = "#{new_resource.comment}";
Default = "$#{new_resource.default}";
DriverName = "#{new_resource.driver_name}";
Location = "#{new_resource.location}";
PortName = "#{port_name}";
Shared = "$#{new_resource.shared}";
ShareName = "#{new_resource.share_name}";
}
EOH
end
end
def delete_printer
declare_resource(:powershell_script, "Deleting printer: #{new_resource.device_id}") do
code <<-EOH
$printer = Get-WMIObject -class Win32_Printer -EnableAllPrivileges -Filter "name = '#{new_resource.device_id}'"
$printer.Delete()
EOH
end
end
end
end
end
end
|
