summaryrefslogtreecommitdiff
path: root/lib/chef/resource/windows_font.rb
blob: fbcbbecfbb71df78fdf663e68286937521c59c1f (plain)
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
#
# Copyright:: 2014-2017, Schuberg Philis BV.
# Copyright:: 2017, Chef Software, 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.
#

require "chef/resource"

class Chef
  class Resource
    # @author Sander Botman <sbotman@schubergphilis.com>
    # Installs font files. Sources the font by default from the cookbook, but a URI source can be specified as well.
    class WindowsFont < Chef::Resource
      resource_name :windows_font
      provides :windows_font, os: "windows"

      property :font_name, String, name_property: true
      property :source, String, coerce: proc { |x| x.tr('\\', "/").gsub("//", "/") }

      include Windows::Helper

      action :install do
        if font_exists?
          Chef::Log.debug("Not installing font: #{new_resource.font_name} as font already installed.")
        else
          retrieve_cookbook_font
          install_font
          del_cookbook_font
        end
      end

      action_class do
        # if a source is specified fetch using remote_file. It not use cookbook_file
        def retrieve_cookbook_font
          font_file = new_resource.font_name
          if new_resource.source
            declare_resource(:remote_file, font_file) do
              action :nothing
              source source_uri
              path win_friendly_path(::File.join(ENV["TEMP"], font_file))
            end.run_action(:create)
          else
            declare_resource(:cookbook_file, font_file) do
              action    :nothing
              cookbook  cookbook_name.to_s unless cookbook_name.nil?
              path      win_friendly_path(::File.join(ENV["TEMP"], font_file))
            end.run_action(:create)
          end
        end

        # delete the temp cookbook file
        def del_cookbook_font
          declare_resource(:file, ::File.join(ENV["TEMP"], new_resource.font_name)) do
            action :delete
          end
        end

        # install the font into the appropriate fonts directory
        def install_font
          require "win32ole" if RUBY_PLATFORM =~ /mswin|mingw32|windows/
          fonts_dir = WIN32OLE.new("WScript.Shell").SpecialFolders("Fonts")
          folder = WIN32OLE.new("Shell.Application").Namespace(fonts_dir)
          converge_by("install font #{new_resource.font_name} to #{fonts_dir}") do
            folder.CopyHere(win_friendly_path(::File.join(ENV["TEMP"], new_resource.font_name)))
          end
        end

        # Check to see if the font is installed in the fonts dir
        #
        # @return [Boolean] Is the font is installed?
        def font_exists?
          require "win32ole" if RUBY_PLATFORM =~ /mswin|mingw32|windows/
          fonts_dir = WIN32OLE.new("WScript.Shell").SpecialFolders("Fonts")
          Chef::Log.debug("Seeing if the font at #{win_friendly_path(::File.join(fonts_dir, new_resource.font_name))} exists")
          ::File.exist?(win_friendly_path(::File.join(fonts_dir, new_resource.font_name)))
        end

        # Parse out the schema provided to us to see if it's one we support via remote_file.
        # We do this because URI will parse C:/foo as schema 'c', which won't work with remote_file
        def remote_file_schema?(schema)
          return true if %w{http https ftp}.include?(schema)
        end

        # return new_resource.source if we have a proper URI specified
        # if it's a local file listed as a source return it in file:// format
        def source_uri
          begin
            require "uri"
            if remote_file_schema?(URI.parse(new_resource.source).scheme)
              Chef::Log.debug("source property starts with ftp/http. Using source property unmodified")
              return new_resource.source
            end
          rescue URI::InvalidURIError
            Chef::Log.warn("source property of #{new_resource.source} could not be processed as a URI. Check the format you provided.")
          end
          Chef::Log.debug("source property does not start with ftp/http. Prepending with file:// as it appears to be a local file.")
          "file://#{new_resource.source}"
        end
      end
    end
  end
end