Class: OpenC3::PluginModel

Inherits:
Model show all
Extended by:
Api
Defined in:
lib/openc3/models/plugin_model.rb

Overview

Represents a OpenC3 plugin that can consist of targets, interfaces, routers microservices and tools. The PluginModel installs all these pieces as well as destroys them all when the plugin is removed.

Constant Summary collapse

PRIMARY_KEY = 
'openc3_plugins'
RESERVED_VARIABLE_NAMES =

Reserved VARIABLE names. See local_mode.rb: update_local_plugin()

['target_name', 'microservice_name', 'scope']
PLUGIN_TXT = 
'plugin.txt'

Constants included from Api

Api::DELAY_METRICS, Api::DURATION_METRICS, Api::SUBSCRIPTION_DELIMITER, Api::SUM_METRICS

Constants included from ApiShared

ApiShared::DEFAULT_TLM_POLLING_RATE

Constants included from Extract

Extract::SCANNING_REGULAR_EXPRESSION

Instance Attribute Summary collapse

Attributes inherited from Model

#name, #plugin, #scope, #updated_at

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Api

_cmd_implementation, _extract_target_command_names, _extract_target_command_parameter_names, _extract_target_packet_item_names, _extract_target_packet_names, _get_and_set_cmd, _get_item, _limits_group, _set_tlm_process_args, _tlm_process_args, _validate_tlm_type, build_cmd, cmd, cmd_no_checks, cmd_no_hazardous_check, cmd_no_range_check, cmd_raw, cmd_raw_no_checks, cmd_raw_no_hazardous_check, cmd_raw_no_range_check, config_tool_names, connect_interface, connect_router, delete_config, disable_cmd, disable_limits, disable_limits_group, disconnect_interface, disconnect_router, enable_cmd, enable_limits, enable_limits_group, get_all_cmd_names, get_all_cmds, get_all_interface_info, get_all_router_info, get_all_settings, get_all_tlm, get_all_tlm_item_names, get_all_tlm_names, get_cmd, get_cmd_buffer, get_cmd_cnt, get_cmd_cnts, get_cmd_hazardous, get_cmd_time, get_cmd_value, get_interface, get_interface_names, get_item, get_limits, get_limits_events, get_limits_groups, get_limits_set, get_limits_sets, get_metrics, get_out_of_limits, get_overall_limits_state, get_overrides, get_packet_derived_items, get_packets, get_param, get_router, get_router_names, get_setting, get_settings, get_target, get_target_interfaces, get_target_names, get_tlm, get_tlm_available, get_tlm_buffer, get_tlm_cnt, get_tlm_cnts, get_tlm_packet, get_tlm_values, inject_tlm, interface_cmd, interface_details, interface_protocol_cmd, interface_target_disable, interface_target_enable, limits_enabled?, list_configs, list_settings, load_config, map_target_to_interface, map_target_to_router, normalize_tlm, offline_access_needed, override_tlm, router_cmd, router_details, router_protocol_cmd, router_target_disable, router_target_enable, save_config, send_raw, set_limits, set_limits_set, set_offline_access, set_setting, set_tlm, start_raw_logging_interface, start_raw_logging_router, stash_all, stash_delete, stash_get, stash_keys, stash_set, stop_raw_logging_interface, stop_raw_logging_router, subscribe_packets, tlm, tlm_formatted, tlm_raw, tlm_variable, tlm_with_units, unmap_target_from_interface, unmap_target_from_router, update_news, update_plugin_store

Methods included from CmdLog

#_build_cmd_output_string

Methods inherited from Model

#check_disable_erb, #deploy, #destroy, #destroyed?, filter, find_all_by_plugin, from_json, get_all_models, get_model, handle_config, set, store, store_queued, #update

Constructor Details

#initialize(name:, variables: {}, plugin_txt_lines: [], needs_dependencies: false, store_id: nil, title: nil, description: nil, keywords: nil, licenses: nil, homepage: nil, repository: nil, img_path: nil, updated_at: nil, scope:) ⇒ PluginModel

Returns a new instance of PluginModel.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/openc3/models/plugin_model.rb', line 341

def initialize(
  name:,
  variables: {},
  plugin_txt_lines: [],
  needs_dependencies: false,
  store_id: nil,
  title: nil,
  description: nil,
  keywords: nil,
  licenses: nil,
  homepage: nil,
  repository: nil,
  img_path: nil,
  updated_at: nil,
  scope:
)
  super("#{scope}__#{PRIMARY_KEY}", name: name, updated_at: updated_at, scope: scope)
  @variables = variables
  @plugin_txt_lines = plugin_txt_lines
  @needs_dependencies = ConfigParser.handle_true_false(needs_dependencies)
  @store_id = store_id
  @title = title
  @description = description
  @keywords = keywords
  @licenses = licenses
  @homepage = homepage
  @repository = repository
  @img_path = img_path
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



62
63
64
 
# File 'lib/openc3/models/plugin_model.rb', line 62

def description
  @description
end

#homepage ⇒ Object

Returns the value of attribute homepage.



64
65
66
 
# File 'lib/openc3/models/plugin_model.rb', line 64

def homepage
  @homepage
end

#img_path ⇒ Object

Returns the value of attribute img_path.



67
68
69
 
# File 'lib/openc3/models/plugin_model.rb', line 67

def img_path
  @img_path
end

#keywords ⇒ Object

Returns the value of attribute keywords.



66
67
68
 
# File 'lib/openc3/models/plugin_model.rb', line 66

def keywords
  @keywords
end

#licenses ⇒ Object

Returns the value of attribute licenses.



63
64
65
 
# File 'lib/openc3/models/plugin_model.rb', line 63

def licenses
  @licenses
end

#needs_dependencies ⇒ Object

Returns the value of attribute needs_dependencies.



59
60
61
 
# File 'lib/openc3/models/plugin_model.rb', line 59

def needs_dependencies
  @needs_dependencies
end

#plugin_txt_lines ⇒ Object

Returns the value of attribute plugin_txt_lines.



58
59
60
 
# File 'lib/openc3/models/plugin_model.rb', line 58

def plugin_txt_lines
  @plugin_txt_lines
end

#repository ⇒ Object

Returns the value of attribute repository.



65
66
67
 
# File 'lib/openc3/models/plugin_model.rb', line 65

def repository
  @repository
end

#store_id ⇒ Object

Returns the value of attribute store_id.



60
61
62
 
# File 'lib/openc3/models/plugin_model.rb', line 60

def store_id
  @store_id
end

#title ⇒ Object

Returns the value of attribute title.



61
62
63
 
# File 'lib/openc3/models/plugin_model.rb', line 61

def title
  @title
end

#variables ⇒ Object

Returns the value of attribute variables.



57
58
59
 
# File 'lib/openc3/models/plugin_model.rb', line 57

def variables
  @variables
end

Class Method Details

.all(scope: nil) ⇒ Object 



79
80
81
 
# File 'lib/openc3/models/plugin_model.rb', line 79

def self.all(scope: nil)
  super("#{scope}__#{PRIMARY_KEY}")
end

.gem_names ⇒ Object

Get list of plugin gem names across all scopes to prevent uninstall of gems from GemModel



466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/openc3/models/plugin_model.rb', line 466

def self.gem_names
  result = []
  scopes = ScopeModel.names
  scopes.each do |scope|
    plugin_names = self.names(scope: scope)
    plugin_names.each do |plugin_name|
      gem_name = plugin_name.split("__")[0]
      result << gem_name unless result.include?(gem_name)
    end
  end
  return result.sort
end

.get(name:, scope: nil) ⇒ Object

NOTE: The following three class methods are used by the ModelController and are reimplemented to enable various Model class methods to work



71
72
73
 
# File 'lib/openc3/models/plugin_model.rb', line 71

def self.get(name:, scope: nil)
  super("#{scope}__#{PRIMARY_KEY}", name: name)
end

.install_phase1(gem_file_path, existing_variables: nil, existing_plugin_txt_lines: nil, store_id: nil, process_existing: false, scope:, validate_only: false) ⇒ Object

Called by the PluginsController to parse the plugin variables Doesn’t actually create the plugin during the phase



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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/openc3/models/plugin_model.rb', line 85

def self.install_phase1(gem_file_path, existing_variables: nil, existing_plugin_txt_lines: nil, store_id: nil, process_existing: false, scope:, validate_only: false)
  gem_name = File.basename(gem_file_path).split("__")[0]

  temp_dir = Dir.mktmpdir
  tf = nil
  begin
    if File.exist?(gem_file_path)
      if File.zero?(gem_file_path)
        raise EmptyGemFileError, "Gem file is empty: #{gem_file_path}"
      end

      # Load gem to internal gem server
      OpenC3::GemModel.put(gem_file_path, gem_install: false, scope: scope) unless validate_only
    else
      gem_file_path = OpenC3::GemModel.get(gem_name)
    end

    # Extract gem and process plugin.txt to determine what VARIABLEs need to be filled in
    pkg = Gem::Package.new(gem_file_path)

    if existing_plugin_txt_lines and process_existing
      # This is only used in openc3cli load when everything is known
      plugin_txt_lines = existing_plugin_txt_lines
      file_data = existing_plugin_txt_lines.join("\n")
      tf = Tempfile.new(PLUGIN_TXT)
      tf.write(file_data)
      tf.close
      plugin_txt_path = tf.path
    else
      # Otherwise we always process the new and return both
      pkg.extract_files(temp_dir)
      plugin_txt_path = File.join(temp_dir, PLUGIN_TXT)
      plugin_text = File.read(plugin_txt_path)
      plugin_txt_lines = []
      plugin_text.each_line do |line|
        plugin_txt_lines << line.chomp
      end
    end

    parser = OpenC3::ConfigParser.new("https://openc3.com")

    # Phase 1 Gather Variables
    variables = {}
    parser.parse_file(plugin_txt_path,
                      false,
                      true,
                      false) do |keyword, params|
      if keyword == 'VARIABLE'
        usage = "#{keyword} <Variable Name> <Default Value>"
        parser.verify_num_parameters(2, nil, usage)
        variable_name = params[0]
        if RESERVED_VARIABLE_NAMES.include?(variable_name)
          raise "VARIABLE name '#{variable_name}' is reserved"
        end
        value = params[1..-1].join(" ")
        variables[variable_name] = value
        if existing_variables && existing_variables.key?(variable_name)
          variables[variable_name] = existing_variables[variable_name]
        end
      end
    end

    store_id = Integer(store_id) if store_id
    model = PluginModel.new(name: gem_name, variables: variables, plugin_txt_lines: plugin_txt_lines, store_id: store_id, scope: scope)
    result = model.as_json()
    result['existing_plugin_txt_lines'] = existing_plugin_txt_lines if existing_plugin_txt_lines and not process_existing and existing_plugin_txt_lines != result['plugin_txt_lines']
    return result
  ensure
    FileUtils.remove_entry_secure(temp_dir, true)
    tf.unlink if tf
  end
end

.install_phase2(plugin_hash, scope:, gem_file_path: nil, validate_only: false) ⇒ Object

Called by the PluginsController to create the plugin Because this uses ERB it must be run in a separate process from the API to prevent corruption and single require problems in the current process



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/openc3/models/plugin_model.rb', line 161

def self.install_phase2(plugin_hash, scope:, gem_file_path: nil, validate_only: false)
  # Register plugin to aid in uninstall if install fails
  plugin_hash.delete("existing_plugin_txt_lines")
  plugin_model = PluginModel.new(**(plugin_hash.transform_keys(&:to_sym)), scope: scope)
  plugin_model.create unless validate_only

  temp_dir = Dir.mktmpdir
  begin
    tf = nil

    # Get the gem from local gem server if it hasn't been passed
    unless gem_file_path
      gem_name = plugin_hash['name'].split("__")[0]
      gem_file_path = OpenC3::GemModel.get(gem_name)
    end

    # Attempt to remove all older versions of this same plugin before install to prevent version conflicts
    # Especially on downgrades
    # Leave the same version if it already exists
    OpenC3::GemModel.destroy_all_other_versions(File.basename(gem_file_path))

    # Actually install the gem now (slow)
    OpenC3::GemModel.install(gem_file_path, scope: scope) unless validate_only

    # Extract gem contents
    gem_path = File.join(temp_dir, "gem")
    FileUtils.mkdir_p(gem_path)
    pkg = Gem::Package.new(gem_file_path)
    pkg.extract_files(gem_path)
    Dir[File.join(gem_path, '**/screens/*.txt')].each do |filename|
      if File.basename(filename) != File.basename(filename).downcase
        raise "Invalid screen filename: #{filename}. Screen filenames must be lowercase."
      end
    end

    # Process app store metadata
    plugin_model.title = pkg.spec.metadata['openc3_store_title'] || pkg.spec.summary.strip
    plugin_model.description = pkg.spec.metadata['openc3_store_description'] || pkg.spec.description.strip
    plugin_model.licenses = pkg.spec.licenses
    plugin_model.homepage = pkg.spec.homepage
    plugin_model.repository = pkg.spec.metadata['source_code_uri'] # this key because it's in the official gemspec examples
    plugin_model.keywords = pkg.spec.metadata['openc3_store_keywords']&.split(/, ?/)
    img_path = pkg.spec.metadata['openc3_store_image']
    unless img_path
      default_img_path = 'public/store_img.png'
      full_default_path = File.join(gem_path, default_img_path)
      img_path = default_img_path if File.exist? full_default_path
    end
    plugin_model.img_path = File.join('gems', gem_name.split(".gem")[0], img_path) if img_path # convert this filesystem path to volumes mount path
    plugin_model.update() unless validate_only

    needs_dependencies = pkg.spec.runtime_dependencies.length > 0
    needs_dependencies = true if Dir.exist?(File.join(gem_path, 'lib'))

    # Handle python dependencies (pyproject.toml or requirements.txt)
    pyproject_path = File.join(gem_path, 'pyproject.toml')
    requirements_path = File.join(gem_path, 'requirements.txt')

    if File.exist?(pyproject_path) || File.exist?(requirements_path)
      begin
        pypi_url = get_setting('pypi_url', scope: scope)
        if pypi_url
          pypi_url += '/simple'
        end
      rescue => e
        Logger.error("Failed to retrieve pypi_url: #{e.formatted}")
      ensure
        if pypi_url.nil?
          # If Redis isn't running try the ENV, then simply pypi.org/simple
          pypi_url = ENV['PYPI_URL']
          if pypi_url
            pypi_url += '/simple'
          end
          pypi_url ||= 'https://pypi.org/simple'
        end
      end
      unless validate_only
        if File.exist?(pyproject_path)
          Logger.info "Installing python packages from pyproject.toml with pypi_url=#{pypi_url}"
          if ENV['PIP_ENABLE_TRUSTED_HOST'].nil?
            pip_args = "--no-warn-script-location -i #{pypi_url} #{gem_path}"
          else
            pip_args = "--no-warn-script-location -i #{pypi_url} --trusted-host #{URI.parse(pypi_url).host} #{gem_path}"
          end
        else
          Logger.info "Installing python packages from requirements.txt with pypi_url=#{pypi_url}"
          if ENV['PIP_ENABLE_TRUSTED_HOST'].nil?
            pip_args = "--no-warn-script-location -i #{pypi_url} -r #{requirements_path}"
          else
            pip_args = "--no-warn-script-location -i #{pypi_url} --trusted-host #{URI.parse(pypi_url).host} -r #{requirements_path}"
          end
        end
        puts `/openc3/bin/pipinstall #{pip_args}`
      end
      needs_dependencies = true
    end

    # If needs_dependencies hasn't already been set we need to scan the plugin.txt
    # to see if they've explicitly set the NEEDS_DEPENDENCIES keyword
    unless needs_dependencies
      if plugin_hash['plugin_txt_lines'].join("\n").include?('NEEDS_DEPENDENCIES')
        needs_dependencies = true
      end
    end
    if needs_dependencies
      plugin_model.needs_dependencies = true
      plugin_model.update unless validate_only
    end

    # Temporarily add all lib folders from the gem to the end of the load path
    load_dirs = []
    begin
      Dir.glob("#{gem_path}/**/*").each do |load_dir|
        if File.directory?(load_dir) and File.basename(load_dir) == 'lib'
          load_dirs << load_dir
          $LOAD_PATH << load_dir
        end
      end

      # Process plugin.txt file
      file_data = plugin_hash['plugin_txt_lines'].join("\n")
      tf = Tempfile.new(PLUGIN_TXT)
      tf.write(file_data)
      tf.close
      plugin_txt_path = tf.path
      variables = plugin_hash['variables']
      variables ||= {}
      variables['scope'] = scope
      if File.exist?(plugin_txt_path)
        parser = OpenC3::ConfigParser.new("https://openc3.com")

        current_model = nil
        parser.parse_file(plugin_txt_path, false, true, true, variables) do |keyword, params|
          case keyword
          when 'VARIABLE', 'NEEDS_DEPENDENCIES'
            # Ignore during phase 2
          when 'TARGET', 'INTERFACE', 'ROUTER', 'MICROSERVICE', 'TOOL', 'WIDGET', 'SCRIPT_ENGINE'
            begin
              if current_model
                current_model.create unless validate_only
                current_model.deploy(gem_path, variables, validate_only: validate_only)
              end
            # If something goes wrong in create, or more likely in deploy,
            # we want to clear the current_model and try to instantiate the next
            # Otherwise we're stuck constantly iterating on the last model
            ensure
              current_model = nil
              current_model = OpenC3.const_get((keyword.split('_').collect(&:capitalize).join + 'Model').intern).handle_config(parser,
                keyword, params, plugin: plugin_model.name, needs_dependencies: needs_dependencies, scope: scope)
            end
          else
            if current_model
              current_model.handle_config(parser, keyword, params)
            else
              raise "Invalid keyword '#{keyword}' in plugin.txt"
            end
          end
        end
        if current_model
          current_model.create unless validate_only
          current_model.deploy(gem_path, variables, validate_only: validate_only)
          current_model = nil
        end
      end
    ensure
      load_dirs.each do |load_dir|
        $LOAD_PATH.delete(load_dir)
      end
    end
  rescue => e
    # Install failed - need to cleanup
    plugin_model.destroy unless validate_only
    raise e
  ensure
    FileUtils.remove_entry_secure(temp_dir, true)
    tf.unlink if tf
  end
  return plugin_model.as_json()
end

.names(scope: nil) ⇒ Object 



75
76
77
 
# File 'lib/openc3/models/plugin_model.rb', line 75

def self.names(scope: nil)
  super("#{scope}__#{PRIMARY_KEY}")
end

Instance Method Details

#as_json(*_a) ⇒ Object 



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/openc3/models/plugin_model.rb', line 381

def as_json(*_a)
  {
    'name' => @name,
    'variables' => @variables,
    'plugin_txt_lines' => @plugin_txt_lines,
    'needs_dependencies' => @needs_dependencies,
    'store_id' => @store_id,
    'title' => @title,
    'description' => @description,
    'keywords' => @keywords,
    'licenses' => @licenses,
    'homepage' => @homepage,
    'repository' => @repository,
    'img_path' => @img_path,
    'updated_at' => @updated_at
  }
end

#create(update: false, force: false, queued: false) ⇒ Object 



371
372
373
374
375
376
377
378
379
 
# File 'lib/openc3/models/plugin_model.rb', line 371

def create(update: false, force: false, queued: false)
  if not update and not @name.index("__")
    existing_names = Set.new(self.class.names(scope: @scope))
    counter = 0
    counter += 1 while existing_names.include?("#{@name}__#{counter}")
    @name = "#{@name}__#{counter}"
  end
  super(update: update, force: force, queued: queued)
end

#restore ⇒ Object

Reinstall



459
460
461
462
463
 
# File 'lib/openc3/models/plugin_model.rb', line 459

def restore
  plugin_hash = self.as_json()
  OpenC3::PluginModel.install_phase2(plugin_hash, scope: @scope)
  @destroyed = false
end

#undeploy ⇒ Object

Undeploy all models associated with this plugin



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/openc3/models/plugin_model.rb', line 400

def undeploy
  errors = []
  microservice_count = 0
  microservices = MicroserviceModel.find_all_by_plugin(plugin: @name, scope: @scope)
  microservices.each do |_name, model_instance|
    begin
      model_instance.destroy
    rescue Exception => e
      errors << e
    end
    microservice_count += 1
  end
  # Wait for the operator to wake up and remove the microservice processes
  sleep 15 if microservice_count > 0 # Cycle time 5s times 2 plus 5s wait for soft stop and then hard stop
  # Remove all the other models now that the processes have stopped
  # Save TargetModel for last as it has the most to cleanup
  [InterfaceModel, RouterModel, ToolModel, WidgetModel, TargetModel, ScriptEngineModel].each do |model|
    model.find_all_by_plugin(plugin: @name, scope: @scope).each do |_name, model_instance|
      begin
        model_instance.destroy
      rescue Exception => e
        errors << e
      end
    end
  end
  # Cleanup Redis stuff that might have been left by microservices
  microservices.each do |_name, model_instance|
    begin
      model_instance.cleanup
    rescue Exception => e
      errors << e
    end
  end
  # Raise all the errors at once
  if errors.length > 0
    message = ''
    errors.each do |error|
      message += "\n#{error.formatted}\n"
    end
    raise message
  end
rescue Exception => e
  Logger.error("Error undeploying plugin model #{@name} in scope #{@scope} due to: #{e.formatted}")
ensure
  # Double check everything is gone
  found = []
  [MicroserviceModel, InterfaceModel, RouterModel, ToolModel, WidgetModel, TargetModel, ScriptEngineModel].each do |model|
    model.find_all_by_plugin(plugin: @name, scope: @scope).each do |_name, model_instance|
      found << model_instance
    end
  end
  if found.length > 0
    # If undeploy failed we need to not move forward with anything else
    Logger.error("Error undeploying plugin model #{@name} in scope #{@scope} due to: Plugin submodels still exist after undeploy = #{found.length}")
    raise "Plugin #{@name} submodels still exist after undeploy = #{found.length}"
  end
end