Class: OpenC3::TargetFile

Inherits:
Object show all
Defined in:
lib/openc3/utilities/target_file.rb

Direct Known Subclasses

Script

Constant Summary collapse

TEMP_FOLDER =

Matches ScriptRunner.vue const TEMP_FOLDER

'__TEMP__'

Class Method Summary collapse

Class Method Details

.all(scope, path_matchers, target: nil) ⇒ Object 



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
 
# File 'lib/openc3/utilities/target_file.rb', line 34

def self.all(scope, path_matchers, target: nil)
  target = target.upcase if target

  include_temp = true
  bucket = Bucket.getClient()
  if target
    prefix = "#{scope}/targets/#{target}/"
    modified_prefix = "#{scope}/targets_modified/#{target}/"
    if target != TEMP_FOLDER
      include_temp = false
    end
  else
    prefix = "#{scope}/targets/"
    modified_prefix = "#{scope}/targets_modified/"
  end
  result, _ = remote_target_files(bucket_client: bucket, prefix: prefix, include_temp: false, path_matchers: path_matchers)
  modified, temp = remote_target_files(bucket_client: bucket, prefix: modified_prefix, include_temp: include_temp, path_matchers: path_matchers)

  # Add in local targets_modified if present
  if ENV['OPENC3_LOCAL_MODE']
    local_modified = OpenC3::LocalMode.local_target_files(scope: scope, target: target, path_matchers: path_matchers, include_temp: include_temp)
    local_modified.each do |filename|
      if include_temp and filename.include?(TEMP_FOLDER)
        temp << filename
      else
        modified << filename unless modified.include?(filename)
        result << filename unless result.include?(filename)
      end
    end
  end

  # Determine if there are any modified files and mark them with '*'
  result.map! do |file|
    if modified.include?(file)
      modified.delete(file)
      "#{file}*"
    else
      file
    end
  end

  # Concat any remaining modified files (new files not in original target)
  result = result.merge(modified)
  result = result.merge(temp.uniq)
  result.sort
end

.body(scope, name) ⇒ Object 



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
 
# File 'lib/openc3/utilities/target_file.rb', line 101

def self.body(scope, name)
  name = strip_modified(name) # Remove '*' that indicates modified
  # First try opening a potentially modified version by looking for the modified target
  if ENV['OPENC3_LOCAL_MODE']
    local_file = OpenC3::LocalMode.open_local_file(name, scope: scope)
    if local_file
      if File.extname(name) == ".bin"
        return local_file.read
      else
        return local_file.read.force_encoding('UTF-8')
      end
    end
  end

  bucket = Bucket.getClient()
  resp = bucket.get_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: "#{scope}/targets_modified/#{name}")
  unless resp
    # Now try the original
    resp = bucket.get_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: "#{scope}/targets/#{name}")
  end
  if resp && resp.body
    if File.extname(name) == ".bin"
      resp.body.binmode
      return resp.body.read
    else
      return resp.body.read.force_encoding('UTF-8')
    end
  else
    nil
  end
end

.create(scope, name, text, content_type: 'text/plain') ⇒ Object 



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
 
# File 'lib/openc3/utilities/target_file.rb', line 133

def self.create(scope, name, text, content_type: 'text/plain')
  return false unless text
  # A trailing '*' here is the display-only modified marker leaking in from a
  # file listing, not a name any caller means to write. Remove it to avoid 
  # creating a file with a '*' in the name.
  name = strip_modified(name)
  if ENV['OPENC3_LOCAL_MODE']
    OpenC3::LocalMode.put_target_file("#{scope}/targets_modified/#{name}", text, scope: scope)
  end
  client = Bucket.getClient()
  client.put_object(
    # Use targets_modified to save modifications
    # This keeps the original target clean (read-only)
    bucket: ENV['OPENC3_CONFIG_BUCKET'],
    key: "#{scope}/targets_modified/#{name}",
    body: text,
    content_type: content_type,
  )
  # Wait for the object to exist
  if client.check_object(
    bucket: ENV['OPENC3_CONFIG_BUCKET'],
    key: "#{scope}/targets_modified/#{name}",
  )
    true
  else
    false
  end
end

.delete_temp(scope) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/openc3/utilities/target_file.rb', line 81

def self.delete_temp(scope)
  bucket = Bucket.getClient()
  resp = bucket.list_objects(
    bucket: ENV['OPENC3_CONFIG_BUCKET'],
    prefix: "#{scope}/targets_modified/#{TEMP_FOLDER}",
  )
  files = []
  resp.each do |object|
    files << object.key
    bucket.delete_object(
      bucket: ENV['OPENC3_CONFIG_BUCKET'],
      key: object.key,
    )
    if ENV['OPENC3_LOCAL_MODE']
      OpenC3::LocalMode.delete_local(object.key)
    end
  end
  files
end

.destroy(scope, name) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/openc3/utilities/target_file.rb', line 162

def self.destroy(scope, name)
  # Match body/create so deleting a name taken straight from a listing
  # removes the file the user actually picked
  name = strip_modified(name)
  if ENV['OPENC3_LOCAL_MODE']
    OpenC3::LocalMode.delete_local("#{scope}/targets_modified/#{name}")
  end

  # Only delete file from the modified target directory
  Bucket.getClient.delete_object(
    bucket: ENV['OPENC3_CONFIG_BUCKET'],
    key: "#{scope}/targets_modified/#{name}",
  )
  true
end

.remote_target_files(bucket_client:, prefix:, include_temp: false, path_matchers: nil) ⇒ Object

protected



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/openc3/utilities/target_file.rb', line 180

def self.remote_target_files(bucket_client:, prefix:, include_temp: false, path_matchers: nil)
  result = Set.new
  temp = Set.new
  resp = bucket_client.list_objects(
    bucket: ENV['OPENC3_CONFIG_BUCKET'],
    prefix: prefix,
  )
  resp.each do |object|
    split_key = object.key.split('/')
    # DEFAULT/targets_modified/__TEMP__/YYYY_MM_DD_HH_MM_SS_mmm_temp.rb
    if split_key[2] == TEMP_FOLDER
      temp << split_key[2..-1].join('/') if include_temp
      next
    end

    if path_matchers
      found = false
      path_matchers.each do |path|
        if split_key.include?(path)
          found = true
          break
        end
      end
      next unless found
    end
    result_no_scope_or_target_folder = split_key[2..-1].join('/')
    result << result_no_scope_or_target_folder
  end
  return result, temp
end

.strip_modified(name) ⇒ Object

self.all appends '*' to a name to mark it as modified on the server. The marker is display-only, so every path in and out of the bucket strips it.

Strip only '' at the end of a file name. '' is a legal S3 object key character and is allowed by FileOpenSaveDialog's filename charset, so files named that way exist in the field and have to stay addressable.



30
31
32
 
# File 'lib/openc3/utilities/target_file.rb', line 30

def self.strip_modified(name)
  name.sub(/\*$/, '')
end