Class: Puppet::FileServing::Metadata

Inherits:
Base show all
Extended by:
Indirector
Includes:
Util::Checksums
Defined in:
lib/puppet/file_serving/metadata.rb

Overview

A class that handles retrieving file metadata.

Defined Under Namespace

Classes: MetaStat, WindowsStat

Constant Summary collapse

PARAM_ORDER = 
[:mode, :ftype, :owner, :group]

Constants included from Indirector

Indirector::BadNameRegexp

Instance Attribute Summary collapse

Attributes inherited from Base

#links, #relative_path, #source

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Indirector

configure_routes, indirects

Methods included from Util::Checksums

#checksum?, #ctime, #ctime_file, #md5, #md5_file, #md5_stream, #md5lite, #md5lite_file, #mtime, #mtime_file, #mtime_stream, #none, #none_file, #none_stream, #sha1, #sha1_file, #sha1_stream, #sha1lite, #sha1lite_file, #sumdata, #sumtype

Methods inherited from Base

#exist?, #full_path, #stat

Constructor Details

#initialize(path, data = {}) ⇒ Metadata

Returns a new instance of Metadata.



110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/puppet/file_serving/metadata.rb', line 110

def initialize(path,data={})
  @owner       = data.delete('owner')
  @group       = data.delete('group')
  @mode        = data.delete('mode')
  if checksum = data.delete('checksum')
    @checksum_type = checksum['type']
    @checksum      = checksum['value']
  end
  @checksum_type ||= "md5"
  @ftype       = data.delete('type')
  @destination = data.delete('destination')
  super(path,data)
end

Instance Attribute Details

#checksum ⇒ Object (readonly)

Returns the value of attribute checksum.



16
17
18
 
# File 'lib/puppet/file_serving/metadata.rb', line 16

def checksum
  @checksum
end

#checksum_type ⇒ Object

Returns the value of attribute checksum_type.



16
17
18
 
# File 'lib/puppet/file_serving/metadata.rb', line 16

def checksum_type
  @checksum_type
end

#destination ⇒ Object (readonly)

Returns the value of attribute destination.



16
17
18
 
# File 'lib/puppet/file_serving/metadata.rb', line 16

def destination
  @destination
end

#ftype ⇒ Object (readonly)

Returns the value of attribute ftype.



16
17
18
 
# File 'lib/puppet/file_serving/metadata.rb', line 16

def ftype
  @ftype
end

#group ⇒ Object (readonly)

Returns the value of attribute group.



16
17
18
 
# File 'lib/puppet/file_serving/metadata.rb', line 16

def group
  @group
end

#mode ⇒ Object (readonly)

Returns the value of attribute mode.



16
17
18
 
# File 'lib/puppet/file_serving/metadata.rb', line 16

def mode
  @mode
end

#owner ⇒ Object (readonly)

Returns the value of attribute owner.



16
17
18
 
# File 'lib/puppet/file_serving/metadata.rb', line 16

def owner
  @owner
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



16
17
18
 
# File 'lib/puppet/file_serving/metadata.rb', line 16

def path
  @path
end

Class Method Details

.from_pson(data) ⇒ Object 



152
153
154
 
# File 'lib/puppet/file_serving/metadata.rb', line 152

def self.from_pson(data)
  new(data.delete('path'), data)
end

Instance Method Details

#attributes_with_tabs ⇒ Object

Raises:



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/puppet/file_serving/metadata.rb', line 20

def attributes_with_tabs
  raise(ArgumentError, "Cannot manage files of type #{ftype}") unless ['file','directory','link'].include? ftype
  desc = []
  PARAM_ORDER.each { |check|
    check = :ftype if check == :type
    desc << send(check)
  }

  desc << checksum
  desc << @destination rescue nil if ftype == 'link'

  desc.join("\t")
end

#collect ⇒ Object

Retrieve the attributes for this file, relative to a base directory. Note that File.stat raises Errno::ENOENT if the file is absent and this method does not catch that exception.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/puppet/file_serving/metadata.rb', line 85

def collect
  real_path = full_path

  stat = collect_stat(real_path)
  @owner = stat.owner
  @group = stat.group
  @ftype = stat.ftype

  # We have to mask the mode, yay.
  @mode = stat.mode & 007777

  case stat.ftype
  when "file"
    @checksum = ("{#{@checksum_type}}") + send("#{@checksum_type}_file", real_path).to_s
  when "directory" # Always just timestamp the directory.
    @checksum_type = "ctime"
    @checksum = ("{#{@checksum_type}}") + send("#{@checksum_type}_file", path).to_s
  when "link"
    @destination = File.readlink(real_path)
    @checksum = ("{#{@checksum_type}}") + send("#{@checksum_type}_file", real_path).to_s rescue nil
  else
    raise ArgumentError, "Cannot manage files of type #{stat.ftype}"
  end
end

#collect_stat(path) ⇒ Object 



72
73
74
75
76
77
78
79
80
 
# File 'lib/puppet/file_serving/metadata.rb', line 72

def collect_stat(path)
  stat = stat()

  if Puppet.features.microsoft_windows?
    WindowsStat.new(stat, path)
  else
    MetaStat.new(stat)
  end
end

#to_pson(*args) ⇒ Object 



148
149
150
 
# File 'lib/puppet/file_serving/metadata.rb', line 148

def to_pson(*args)
  to_pson_data_hash.to_pson(*args)
end

#to_pson_data_hash ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/puppet/file_serving/metadata.rb', line 125

def to_pson_data_hash
  {
    'document_type' => 'FileMetadata',

      'data'       => super['data'].update(
        {
        'owner'        => owner,
        'group'        => group,
        'mode'         => mode,
        'checksum'     => {
          'type'   => checksum_type,
          'value'  => checksum
      },
      'type'         => ftype,
      'destination'  => destination,

      }),
    'metadata' => {
      'api_version' => 1
      }
  }
end