scinote-web/app/models/my_module.rb

# frozen_string_literal: true

class MyModule < ApplicationRecord
  ID_PREFIX = 'TA'
  include PrefixedIdModel
  SEARCHABLE_ATTRIBUTES = ['my_modules.name', 'my_modules.description', PREFIXED_ID_SQL].freeze

  include ArchivableModel
  include SearchableModel
  include SearchableByNameModel
  include TinyMceImages
  include PermissionCheckableModel
  include Assignable
  include Cloneable

  attr_accessor :transition_error_rollback

  enum state: Extends::TASKS_STATES
  enum provisioning_status: { done: 0, in_progress: 1, failed: 2 }

  before_validation :archiving_and_restoring_extras, on: :update, if: :archived_changed?
  before_save -> { report_elements.destroy_all }, if: -> { !new_record? && experiment_id_changed? }
  around_save :exec_status_consequences, if: :my_module_status_id_changed?
  before_create :create_blank_protocol
  before_create :assign_default_status_flow
  after_save -> { experiment.workflowimg.purge },
             if: -> { (saved_changes.keys & %w(x y experiment_id my_module_group_id input_id output_id archived)).any? }

  auto_strip_attributes :name, :description, nullify: false, if: proc { |mm| mm.name_changed? || mm.description_changed? }
  validates :name,
            length: { minimum: Constants::NAME_MIN_LENGTH,
                      maximum: Constants::NAME_MAX_LENGTH }
  validates :description, length: { maximum: Constants::RICH_TEXT_MAX_LENGTH }
  validates :x, :y, :workflow_order, presence: true
  validates :experiment, presence: true
  validates :my_module_group, presence: true, if: proc { |mm| !mm.my_module_group_id.nil? }
  validate :coordinates_uniqueness_check, if: :active?
  validates :completed_on, presence: true, if: proc { |mm| mm.completed? }

  validate :check_status, if: :my_module_status_id_changed?
  validate :check_status_conditions, if: :my_module_status_id_changed?
  validate :check_status_implications

  belongs_to :created_by, foreign_key: 'created_by_id', class_name: 'User', optional: true
  belongs_to :last_modified_by, foreign_key: 'last_modified_by_id', class_name: 'User', optional: true
  belongs_to :archived_by, foreign_key: 'archived_by_id', class_name: 'User', optional: true
  belongs_to :restored_by, foreign_key: 'restored_by_id', class_name: 'User', optional: true
  belongs_to :experiment, inverse_of: :my_modules, touch: true
  has_one :project, through: :experiment, autosave: false
  has_one :shareable_link, as: :shareable, dependent: :destroy
  delegate :team, to: :project
  belongs_to :my_module_group, inverse_of: :my_modules, optional: true
  belongs_to :my_module_status, optional: true
  belongs_to :changing_from_my_module_status, optional: true, class_name: 'MyModuleStatus'
  delegate :my_module_status_flow, to: :my_module_status, allow_nil: true
  has_many :results, inverse_of: :my_module, dependent: :destroy
  has_many :my_module_tags, inverse_of: :my_module, dependent: :destroy
  has_many :tags, through: :my_module_tags
  has_many :task_comments, foreign_key: :associated_id, dependent: :destroy
  has_many :inputs, class_name: 'Connection', foreign_key: 'input_id', inverse_of: :to, dependent: :destroy
  has_many :outputs, class_name: 'Connection', foreign_key: 'output_id', inverse_of: :from, dependent: :destroy
  has_many :my_modules, through: :outputs, source: :to, class_name: 'MyModule'
  has_many :my_module_antecessors, through: :inputs, source: :from, class_name: 'MyModule'
  has_many :my_module_repository_rows, inverse_of: :my_module, dependent: :destroy
  has_many :repository_rows, through: :my_module_repository_rows
  has_many :repository_snapshots, dependent: :destroy, inverse_of: :my_module
  has_many :user_my_modules, inverse_of: :my_module, dependent: :destroy
  has_many :users, through: :user_assignments
  has_many :designated_users, through: :user_my_modules, source: :user
  has_many :report_elements, inverse_of: :my_module, dependent: :destroy
  has_many :protocols, inverse_of: :my_module, dependent: :destroy
  has_many :steps, through: :protocols
  has_many :assets_in_steps, class_name: 'Asset', source: :assets, through: :steps
  has_many :assets_in_results, class_name: 'Asset', source: :asset, through: :results
  # Associations for old activity type
  has_many :activities, inverse_of: :my_module

  scope :overdue, -> { where('my_modules.due_date < ?', Time.current.utc) }
  scope :without_group, -> { active.where(my_module_group: nil) }
  scope :one_day_prior, (lambda do
    where('my_modules.due_date > ? AND my_modules.due_date < ?',
          Time.current.utc,
          Time.current.utc + 1.day)
  end)
  scope :workflow_ordered, -> { order(workflow_order: :asc) }
  scope :uncomplete, -> { where(state: 'uncompleted') }

  scope :my_module_search_scope, lambda { |experiment_ids, user|
    joins(:user_assignments).where(
      experiment: experiment_ids,
      user_assignments: { user: user }
    ).distinct
  }

  scope :repository_row_assignable_by_user, lambda { |user|
    active
      .joins(user_assignments: :user_role)
      .where(user_assignments: { user: user })
      .where('? = ANY(user_roles.permissions)', MyModulePermissions::REPOSITORY_ROWS_ASSIGN)
  }

  # A module takes this much space in canvas (x, y) in database
  WIDTH = 30
  HEIGHT = 14

  def self.search(
    user,
    include_archived,
    query = nil,
    page = 1,
    current_team = nil,
    options = {}
  )
    viewable_experiments = Experiment.search(user, include_archived, nil, Constants::SEARCH_NO_LIMIT, current_team)
                                     .pluck(:id)

    new_query = MyModule.with_granted_permissions(user, MyModulePermissions::READ)
                        .where(experiment: viewable_experiments)
                        .where_attributes_like(SEARCHABLE_ATTRIBUTES, query, options)

    new_query = new_query.active unless include_archived

    # Show all results if needed
    if page == Constants::SEARCH_NO_LIMIT
      new_query
    else
      new_query.limit(Constants::SEARCH_LIMIT).offset((page - 1) * Constants::SEARCH_LIMIT)
    end
  end

  def self.viewable_by_user(user, teams)
    with_granted_permissions(user, MyModulePermissions::READ)
      .where(experiment: Experiment.viewable_by_user(user, teams))
  end

  def self.filter_by_teams(teams = [])
    return self if teams.blank?

    joins(experiment: :project).where(experiment: { projects: { team: teams } })
  end

  def parent
    experiment
  end

  def navigable?
    !experiment.archived? && experiment.navigable?
  end

  def archived_branch?
    archived? || experiment.archived_branch?
  end

  def repository_rows_count(repository)
    my_module_repository_rows.joins(repository_row: :repository)
                             .where('repositories.id': repository.id)
                             .count
  end

  def assigned_repositories
    team = experiment.project.team
    Repository.accessible_by_teams(team)
              .joins(repository_rows: :my_module_repository_rows)
              .where(my_module_repository_rows: { my_module_id: id })
              .group(:id)
  end

  def live_and_snapshot_repositories_list
    snapshots = repository_snapshots.left_outer_joins(:original_repository)

    selected_snapshots = snapshots.where(selected: true)
                                  .or(snapshots.where(original_repositories_repositories: { id: nil }))
                                  .or(snapshots.where.not(parent_id: assigned_repositories.select(:id)))
                                  .select('DISTINCT ON ("repositories"."parent_id") "repositories".*')
                                  .select('COUNT(repository_rows.id) AS assigned_rows_count')
                                  .joins(:repository_rows)
                                  .group(:parent_id, :id)
                                  .order(:parent_id, updated_at: :desc)

    live_repositories = assigned_repositories
                        .select('repositories.*, COUNT(DISTINCT repository_rows.id) AS assigned_rows_count')
                        .where.not(id: repository_snapshots.where(selected: true).select(:parent_id))

    (live_repositories + selected_snapshots).sort_by { |r| r.name.downcase }
  end

  def update_report_repository_references(repository)
    ids = if repository.is_a?(Repository)
            RepositorySnapshot.where(parent_id: repository.id).pluck(:id)
          else
            Repository.where(id: repository.parent_id).pluck(:id) +
              RepositorySnapshot.where(parent_id: repository.parent_id).pluck(:id)
          end

    report_elements.where(repository_id: ids).update(repository: repository)
  end

  def undesignated_users
    User.joins(:user_assignments)
        .joins(
          "LEFT OUTER JOIN user_my_modules ON user_my_modules.user_id = users.id "\
          "AND user_my_modules.my_module_id = #{id}"
        )
        .where(user_assignments: { assignable: self })
        .where(user_my_modules: { id: nil })
        .distinct
  end

  def unassigned_tags
    experiment.project.tags.where.not(id: tags)
  end

  def last_activities(count = Constants::ACTIVITY_AND_NOTIF_SEARCH_LIMIT)
    Activity.where(my_module_id: id).order(:created_at).last(count)
  end

  # Get module comments ordered by created_at time. Results are paginated
  # using last comment id and per_page parameters.
  def last_comments(last_id = 1, per_page = Constants::COMMENTS_SEARCH_LIMIT)
    last_id = Constants::INFINITY if last_id <= 1
    comments = TaskComment.joins(:my_module)
                          .where(my_modules: { id: id })
                          .where('comments.id <  ?', last_id)
                          .order(created_at: :desc)
                          .limit(per_page)
    TaskComment.from(comments, :comments).order(created_at: :asc)
  end

  def last_activities(last_id = 1,
                      count = Constants::ACTIVITY_AND_NOTIF_SEARCH_LIMIT)
    last_id = Constants::INFINITY if last_id <= 1
    Activity.joins(:my_module)
            .where(my_module_id: id)
            .where('activities.id <  ?', last_id)
            .order(created_at: :desc)
            .limit(count)
            .uniq
  end

  def protocol
    # Temporary function (until we fully support
    # multiple protocols per module)
    protocols.count > 0 ? protocols.first : nil
  end

  def is_overdue?(datetime = DateTime.current)
    due_date.present? && datetime.utc > due_date.utc
  end

  def overdue_for_days(datetime = DateTime.current)
    if due_date.blank? || due_date.utc > datetime.utc
      0
    else
      ((datetime.utc.to_i - due_date.utc.to_i) / 1.day.to_f).ceil
    end
  end

  def is_one_day_prior?(datetime = DateTime.current)
    is_due_in?(datetime, 1.day)
  end

  def is_due_in?(datetime, diff)
    due_date.present? &&
      datetime.utc < due_date.utc &&
      datetime.utc > (due_date.utc - diff)
  end

  def space_taken
    st = 0
    protocol.steps.find_each do |step|
      st += step.space_taken
    end
    results
    .includes(:result_asset)
    .find_each do |result|
      st += result.space_taken
    end
    st
  end

  def archived_results
    results
    .select('results.*')
    .select('ra.id AS result_asset_id')
    .select('rt.id AS result_table_id')
    .select('rx.id AS result_text_id')
    .joins('LEFT JOIN result_assets AS ra ON ra.result_id = results.id')
    .joins('LEFT JOIN result_tables AS rt ON rt.result_id = results.id')
    .joins('LEFT JOIN result_texts AS rx ON rx.result_id = results.id')
    .where(:archived => true)
  end

  # Treat this module as root, get all modules of that subtree
  def downstream_modules
    final = []
    modules = [self]
    until modules.blank?
      my_module = modules.shift
      final << my_module unless final.include?(my_module)
      modules.push(*my_module.my_modules)
    end
    final
  end

  # Treat this module as inversed root, get all modules of that inversed subtree
  def upstream_modules
    final = []
    modules = [self]
    until modules.blank?
      my_module = modules.shift
      final << my_module unless final.include?(my_module)
      modules.push(*my_module.my_module_antecessors)
    end
    final
  end

  # Generate the repository rows belonging to this module
  # in JSON form, suitable for display in handsontable.js
  def repository_json_hot(repository, order)
    # Prepare column headers
    headers = [
      I18n.t('repositories.table.id'),
      I18n.t('repositories.table.row_name'),
      I18n.t('repositories.table.added_on'),
      I18n.t('repositories.table.added_by')
    ]
    data = []
    rows = repository.assigned_rows(self).includes(:created_by).order(created_at: order)
    if repository.has_stock_management?
      headers.push(I18n.t('repositories.table.row_consumption'))
      rows = rows.left_joins(my_module_repository_rows: :repository_stock_unit_item)
                 .select(
                   'repository_rows.*',
                   'my_module_repository_rows.stock_consumption'
                 )
    end
    rows.find_each do |row|
      row_json = []
      row_json << row.code
      row_json << (row.archived ? "#{row.name} [#{I18n.t('general.archived')}]" : row.name)
      row_json << I18n.l(row.created_at, format: :full)
      row_json << row.created_by.full_name
      if repository.has_stock_management?
        if repository.is_a?(RepositorySnapshot)
          consumed_stock = row.repository_stock_consumption_cell&.value&.formatted
          row_json << (consumed_stock || 0)
        else
          row_json << row.row_consumption(row.stock_consumption)
        end
      end
      data << row_json
    end

    { data: data, headers: headers }
  end

  def repository_docx_json(repository)
    headers = [
      I18n.t('repositories.table.id'),
      I18n.t('repositories.table.row_name'),
      I18n.t('repositories.table.added_on'),
      I18n.t('repositories.table.added_by')
    ]
    custom_columns = []
    return false unless repository

    repository.repository_columns.order(:id).each do |column|
      if column.data_type == 'RepositoryStockValue'
        headers.push(I18n.t('repositories.table.row_consumption'))
      else
        headers.push(column.name)
      end
      custom_columns.push(column.id)
    end

    records = repository.assigned_rows(self)
                        .select(:id, :name, :created_at, :created_by_id, :repository_id, :parent_id, :archived)
    { headers: headers, rows: records, custom_columns: custom_columns }
  end

  def deep_clone(current_user)
    deep_clone_to_experiment(current_user, experiment)
  end

  def deep_clone_to_experiment(current_user, experiment_dest)
    # Copy the module
    clone = MyModule.new(
      name: name,
      experiment: experiment_dest,
      description: description,
      x: x,
      y: y,
      created_by: current_user
    )

    # set new position if cloning in the same experiment
    clone.attributes = get_new_position if clone.experiment == experiment

    clone.save!

    clone.assign_user(current_user)

    copy_content(current_user, clone)

    clone
  end

  def copy_content(current_user, target_my_module)
    # Remove the automatically generated protocol,
    # & clone the protocol instead
    target_my_module.protocol.destroy
    target_my_module.reload

    # Update the cloned protocol if neccesary
    clone_tinymce_assets(target_my_module, target_my_module.experiment.project.team)
    protocol.deep_clone_my_module(target_my_module, current_user)
    target_my_module.reload
  end

  # Find an empty position for the restored module. It's
  # basically a first empty row with empty space inside x=[0, 32).
  def get_new_position
    return { x: 0, y: 0 } if experiment.blank?

    # Get all modules position that overlap with first column, [0, WIDTH) and
    # sort them by y coordinate.
    positions = experiment.my_modules.active.collect { |m| [m.x, m.y] }
                          .select { |x, _| x >= 0 && x < WIDTH }
                          .sort_by { |_, y| y }
    return { x: 0, y: 0 } if positions.blank? || positions.first[1] >= HEIGHT

    # It looks we'll have to find a gap between the modules if it exists (at
    # least 2*HEIGHT wide
    ind = positions.each_cons(2).map { |f, s| s[1] - f[1] }
                   .index { |y| y >= 2 * HEIGHT }
    return { x: 0, y: positions[ind][1] + HEIGHT } if ind

    # We lucked out, no gaps, therefore we need to add it after the last element
    { x: 0, y: positions.last[1] + HEIGHT }
  end

  def assign_user(user, assigned_by = nil)
    user_my_modules.create(
      assigned_by: assigned_by || user,
      user: user
    )
    Activities::CreateActivityService
      .call(activity_type: :designate_user_to_my_module,
            owner: assigned_by || user,
            team: experiment.project.team,
            project: experiment.project,
            subject: self,
            message_items: { my_module: id,
                             user_target: user.id })
  end

  def shared?
    team.shareable_links_enabled? && shareable_link.present?
  end

  def comments
    task_comments
  end

  def permission_parent
    experiment
  end

  private

  def create_blank_protocol
    protocols << Protocol.new_blank_for_module(self)
  end

  def coordinates_uniqueness_check
    if experiment && experiment.my_modules.active.where(x: x, y: y).where.not(id: id).any?
      errors.add(:position, I18n.t('activerecord.errors.models.my_module.attributes.position.not_unique'))
    end
  end

  def assign_default_status_flow
    return if my_module_status.present? || MyModuleStatusFlow.global.blank?

    self.my_module_status = MyModuleStatusFlow.global.last.initial_status
  end

  def check_status_conditions
    return if my_module_status.blank?

    my_module_status.my_module_status_conditions.each do |condition|
      condition.call(self)
    end
  end

  def check_status_implications
    return if my_module_status.blank?

    my_module_status.my_module_status_implications.each do |implication|
      implication.call(self)
    end
  end

  def check_status
    return unless my_module_status_id_was

    original_status = MyModuleStatus.find_by(id: my_module_status_id_was)
    unless my_module_status && [original_status.next_status, original_status.previous_status].include?(my_module_status)
      errors.add(:my_module_status_id,
                 I18n.t('activerecord.errors.models.my_module.attributes.my_module_status_id.not_correct_order'))
    end
  end

  def exec_status_consequences
    return if my_module_status.blank? || status_changing

    self.changing_from_my_module_status_id = my_module_status_id_was if my_module_status_id_was.present?
    self.status_changing = true

    status_changing_direction = my_module_status.previous_status_id == my_module_status_id_was ? :forward : :backward

    yield

    if my_module_status.my_module_status_consequences.any?(&:runs_in_background?)
      MyModuleStatusConsequencesJob
        .perform_later(self, my_module_status.my_module_status_consequences.to_a, status_changing_direction)
    else
      MyModuleStatusConsequencesJob
        .perform_now(self, my_module_status.my_module_status_consequences.to_a, status_changing_direction)
    end
  end

  def archiving_and_restoring_extras
    if archived?
      # Removes connections with other modules
      self.x = 0
      self.y = 0
      # Remove association with module group.
      self.my_module_group = nil
      # Remove all connection between modules.
      Connection.where(input_id: id).destroy_all
      Connection.where(output_id: id).destroy_all
    else
      # Calculate new module position
      new_pos = get_new_position
      self.x = new_pos[:x]
      self.y = new_pos[:y]
    end
  end
end