timeline_controller.rb

# encoding: ascii-8bit

# Copyright 2022 Ball Aerospace & Technologies Corp.
# All Rights Reserved.
#
# This program is free software; you can modify and/or redistribute it
# under the terms of the GNU Affero General Public License
# as published by the Free Software Foundation; version 3 with
# attribution addendums as found in the LICENSE.txt
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.

# Modified by OpenC3, Inc.
# All changes Copyright 2024, OpenC3, Inc.
# All Rights Reserved
#
# This file may also be used under the terms of a commercial license
# if purchased from OpenC3, Inc.

require 'openc3/models/timeline_model'

class TimelineController < ApplicationController
  def initialize
    super()
    @model_class = OpenC3::TimelineModel
  end

  # Returns an array/list of timeline values in json.
  #
  # scope [String] the scope of the timeline, `TEST`
  # @return [String] the array of timeline names converted into json format
  def index
    return unless authorization('system')
    timelines = @model_class.all
    ret = []
    timelines.each do |timeline, value|
      if params[:scope] == timeline.split('__')[0]
        ret << value
      end
    end
    render json: ret
  end

  # Create a new timeline returns object/hash of the timeline in json.
  #
  # scope [String] the scope of the timeline, `TEST`
  # json [String] The json of the timeline name (see below)
  # @return [String] the timeline converted into json format
  # Request Headers
  #```json
  #  {
  #    "Authorization": "token/password",
  #    "Content-Type": "application/json"
  #  }
  #```
  # Request Post Body
  #```json
  #  {
  #    "name": "system42",
  #    "color": "#FFFFFF"
  #  }
  #```
  def create
    return unless authorization('script_run')
    begin
      model = @model_class.new(name: params['name'], color: params['color'], scope: params[:scope])
      model.create()
      model.deploy()
      OpenC3::Logger.info("Timeline created: #{params['name']}", scope: params[:scope], user: username())
      render json: model.as_json(), status: 201
    rescue RuntimeError, JSON::ParserError => e
      log_error(e)
      render json: { status: 'error', message: e.message, type: e.class }, status: 400
    rescue TypeError => e
      log_error(e)
      render json: { status: 'error', message: 'Invalid json object', type: e.class }, status: 400
    rescue OpenC3::TimelineInputError => e
      log_error(e)
      render json: { status: 'error', message: e.message, type: e.class }, status: 400
    end
  end

  # Returns a timeline in json.
  #
  # name [String] the name of the timeline, `TEST`
  # scope [String] the scope of the timeline, `DEFAULT`
  # @return [String] timeline converted into json format
  def show
    return unless authorization('system')
    begin
      model = @model_class.get(name: params['name'], scope: params[:scope])
      if model.nil?
        render json: { status: 'error', message: 'not found' }, status: 404
      else
        render json: model.as_json()
      end
    rescue StandardError => e
      log_error(e)
      render json: { status: 'error', message: e.message, type: e.class, e: e.to_s }, status: 400
    end
  end

  # Change the color returns object/hash of the timeline in json.
  #
  # name [String] the timeline name, `system42`
  # scope [String] the scope of the timeline, `TEST`
  # json [String] The json of the timeline name (see below)
  # @return [String] the timeline converted into json format
  # Request Headers
  #```json
  #  {
  #    "Authorization": "token/password",
  #    "Content-Type": "application/json"
  #  }
  #```
  # Request Post Body
  #```json
  #  {
  #    "color": "#FFFFFF"
  #  }
  #```
  def color
    return unless authorization('script_run')
    model = @model_class.get(name: params[:name], scope: params[:scope])
    if model.nil?
      render json: {
        status: 'error',
        message: "failed to find timeline: #{params[:name]}",
      }, status: 404
      return
    end
    begin
      # Model color=(value) method handles the color validation
      model.color = params['color']
      model.update()
      model.notify(kind: 'updated')
      render json: model.as_json()
    rescue RuntimeError, JSON::ParserError => e
      log_error(e)
      render json: { status: 'error', message: e.message, type: e.class }, status: 400
    rescue TypeError => e
      log_error(e)
      render json: { status: 'error', message: 'Invalid json object', type: e.class }, status: 400
    rescue OpenC3::TimelineInputError => e
      log_error(e)
      render json: { status: 'error', message: e.message, type: e.class }, status: 400
    end
  end

  # Set the timeline execution status
  #
  # name [String] the timeline name, `system42`
  # scope [String] the scope of the timeline, `TEST`
  # json [String] The json of the timeline name (see below)
  # @return [String] the timeline converted into json format
  # Request Headers
  #```json
  #  {
  #    "Authorization": "token/password",
  #    "Content-Type": "application/json"
  #  }
  #```
  # Request Post Body
  #```json
  #  {
  #    "enable": "false"
  #  }
  #```
  def execute
    return unless authorization('script_run')
    model = @model_class.get(name: params[:name], scope: params[:scope])
    if model.nil?
      render json: {
        status: 'error',
        message: "failed to find timeline: #{params[:name]}",
      }, status: 404
      return
    end
    begin
      # Model execute=(value) method handles the conversion of the string to a boolean
      model.execute = params['enable']
      model.update()
      model.notify(kind: 'updated')
      render json: model.as_json()
    rescue RuntimeError, JSON::ParserError => e
      log_error(e)
      render json: { status: 'error', message: e.message, type: e.class }, status: 400
    rescue TypeError => e
      log_error(e)
      render json: { status: 'error', message: 'Invalid json object', type: e.class }, status: 400
    rescue OpenC3::TimelineInputError => e
      log_error(e)
      render json: { status: 'error', message: e.message, type: e.class }, status: 400
    end
  end

  # Delete timeline
  #
  # name [String] the timeline name, `system42`
  # scope [String] the scope of the timeline, `TEST`
  # @return [String] hash/object of timeline name in json with a 200 status code
  def destroy
    return unless authorization('script_run')
    model = @model_class.get(name: params[:name], scope: params[:scope])
    if model.nil?
      render json: { status: 'error', message: "failed to find timeline: #{params[:name]}" }, status: 404
    else
      begin
        use_force = params[:force].nil? == false && params[:force] == 'true'
        @model_class.delete(name: params[:name], scope: params[:scope], force: use_force)
        model.undeploy()
        model.notify(kind: 'deleted')
        OpenC3::Logger.info("Timeline destroyed: #{params[:name]}", scope: params[:scope], user: username())
        render json: { name: params[:name]}
      rescue OpenC3::TimelineError => e
        log_error(e)
        render json: { status: 'error', message: e.message, type: e.class }, status: 400
      end
    end
  end
end