summaryrefslogtreecommitdiff
path: root/lib/chef/resource/link.rb
blob: b3f8819d2b012a5fabb7650b7ceaee095b6ccf68 (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
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Tyler Cloke (<tyler@chef.io>)
# Copyright:: Copyright 2008-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# 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"
require "chef/mixin/securable"

class Chef
  class Resource
    # Use the link resource to create symbolic or hard links.
    #
    # A symbolic link—sometimes referred to as a soft link—is a directory entry that associates a file name with a string
    # that contains an absolute or relative path to a file on any file system. In other words, “a file that contains a path
    # that points to another file.” A symbolic link creates a new file with a new inode that points to the inode location
    # of the original file.
    #
    # A hard link is a directory entry that associates a file with another file in the same file system. In other words,
    # “multiple directory entries to the same file.” A hard link creates a new file that points to the same inode as the
    # original file.
    class Link < Chef::Resource
      include Chef::Mixin::Securable
      resource_name :link
      provides :link

      state_attrs :owner # required since it's not a property below

      default_action :create
      allowed_actions :create, :delete

      def initialize(name, run_context = nil)
        verify_links_supported!
        super
      end

      property :target_file, String, name_property: true, identity: true
      property :to, String
      property :link_type, [String, Symbol], coerce: proc { |arg| arg.kind_of?(String) ? arg.to_sym : arg }, equal_to: [ :symbolic, :hard ], default: :symbolic
      property :group, [String, Integer], regex: [Chef::Config[:group_valid_regex]]
      property :user, [String, Integer], regex: [Chef::Config[:user_valid_regex]]

      # make link quack like a file (XXX: not for public consumption)
      def path
        target_file
      end

      private

      def verify_links_supported!
        # On certain versions of windows links are not supported. Make
        # sure we are not on such a platform.

        if Chef::Platform.windows?
          require "chef/win32/file"
          begin
            Chef::ReservedNames::Win32::File.verify_links_supported!
          rescue Chef::Exceptions::Win32APIFunctionNotImplemented => e
            Chef::Log.fatal("Link resource is not supported on this version of Windows")
            raise e
          end
        end
      end
    end
  end
end