summaryrefslogtreecommitdiff
path: root/lib/chef/cookbook/remote_file_vendor.rb
blob: 668d74c9ce38da752f78b3980cc2204d76f37603 (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
#
# Author:: Tim Hinderliter (<tim@chef.io>)
# Copyright:: Copyright 2010-2016, 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/cookbook/file_vendor"

class Chef
  class Cookbook
    # == Chef::Cookbook::RemoteFileVendor
    # This FileVendor loads files by either fetching them from the local cache, or
    # if not available, loading them from the remote server.
    class RemoteFileVendor < FileVendor

      attr_reader :rest
      attr_reader :cookbook_name

      def initialize(manifest, rest)
        @manifest = manifest
        @cookbook_name = @manifest.name
        @rest = rest
      end

      # Implements abstract base's requirement. It looks in the
      # Chef::Config.cookbook_path file hierarchy for the requested
      # file.
      def get_filename(filename)
        if filename =~ /([^\/]+)\/(.+)$/
          segment = $1
        else
          raise "get_filename: Cannot determine segment/filename for incoming filename #{filename}"
        end

        raise "No such segment #{segment} in cookbook #{@cookbook_name}" unless @manifest.files_for(segment)
        found_manifest_record = @manifest.files_for(segment).find { |manifest_record| manifest_record[:path] == filename }
        raise "No such file #{filename} in #{@cookbook_name}" unless found_manifest_record

        cache_filename = File.join("cookbooks", @cookbook_name, found_manifest_record["path"])

        # update valid_cache_entries so the upstream cache cleaner knows what
        # we've used.
        validate_cached_copy(cache_filename)

        current_checksum = nil
        if Chef::FileCache.has_key?(cache_filename)
          current_checksum = Chef::CookbookVersion.checksum_cookbook_file(Chef::FileCache.load(cache_filename, false))
        end

        # If the checksums are different between on-disk (current) and on-server
        # (remote, per manifest), do the update. This will also execute if there
        # is no current checksum.
        if found_manifest_record[:lazy] || current_checksum != found_manifest_record["checksum"]
          raw_file = @rest.streaming_request(found_manifest_record[:url])

          Chef::Log.debug("Storing updated #{cache_filename} in the cache.")
          Chef::FileCache.move_to(raw_file.path, cache_filename)
        else
          Chef::Log.debug("Not fetching #{cache_filename}, as the cache is up to date.")
          Chef::Log.debug("Current checksum: #{current_checksum}; manifest checksum: #{found_manifest_record['checksum']})")
        end

        full_path_cache_filename = Chef::FileCache.load(cache_filename, false)

        # return the filename, not the contents (second argument= false)
        full_path_cache_filename
      end

      def validate_cached_copy(cache_filename)
        CookbookCacheCleaner.instance.mark_file_as_valid(cache_filename)
      end

    end
  end
end