scinote-web/app/controllers/reports_controller.rb

560 lines
15 KiB
Ruby

class ReportsController < ApplicationController
include TeamsHelper
include ReportActions
include ReportsHelper
BEFORE_ACTION_METHODS = %i(
create
edit
update
generate_pdf
generate_docx
save_modal
new_template_values
project_contents
experiment_contents_modal
module_contents_modal
step_contents_modal
result_contents_modal
experiment_contents
module_contents
step_contents
result_contents
).freeze
before_action :load_vars, only: %i(edit update document_preview generate_pdf generate_docx status
save_pdf_to_inventory_modal save_pdf_to_inventory_item)
before_action :load_vars_nested, only: BEFORE_ACTION_METHODS
before_action :load_visible_projects, only: %i(new edit)
before_action :load_available_repositories, only: %i(index save_pdf_to_inventory_modal available_repositories)
before_action :check_manage_permissions, only: BEFORE_ACTION_METHODS
before_action :switch_team_with_param, only: :index
after_action :generate_pdf_report, only: %i(create update)
# Index showing all reports of a single project
def index; end
def datatable
respond_to do |format|
format.json do
render json: ::ReportDatatable.new(
view_context,
current_user,
Report.viewable_by_user(current_user, current_team)
)
end
end
end
# Report grouped by modules
def new
@templates = Extends::REPORT_TEMPLATES
@repositories = Repository.accessible_by_teams(current_team).active.select(:id, :name)
@report = current_team.reports.new
end
def new_template_values
template = Extends::REPORT_TEMPLATES[params[:template].to_sym]
return render_404 if template.blank?
report = current_team.reports.where(project: @project).find_by(id: params[:report_id])
report ||= current_team.reports.new(project: @project)
respond_to do |format|
format.json do
if lookup_context.template_exists?("reports/templates/#{template}/edit.html.erb")
render json: {
html: render_to_string(
template: "reports/templates/#{template}/edit.html.erb",
layout: 'reports/template_values_editor',
locals: { report: report }
)
}
else
render json: {
html: render_to_string(partial: 'reports/wizard/no_template_values.html.erb')
}
end
end
end
end
# Creating new report from the _save modal of the new page
def create
@report = Report.new(report_params)
@report.project = @project
@report.user = current_user
@report.team = current_team
@report.pdf_file_processing = true
@report.settings = report_params[:settings]
@report.last_modified_by = current_user
ReportActions::ReportContent.new(
@report,
params[:project_content],
params[:template_values],
current_user
).save_with_content
if @report.errors.blank?
log_activity(:create_report)
redirect_to reports_path
else
render json: @report.errors.full_messages, status: :unprocessable_entity
end
end
def edit
@edit = true
@templates = Extends::REPORT_TEMPLATES
@repositories = Repository.accessible_by_teams(current_team).active.select(:id, :name)
@report.settings = Report::DEFAULT_SETTINGS if @report.settings.blank?
@project_contents = {
experiments: @report.report_elements.experiment.pluck(:experiment_id),
my_modules: @report.report_elements.my_module.pluck(:my_module_id),
repositories: @report.report_elements.my_module_repository.distinct(:repository_id).pluck(:repository_id)
}
render :new
end
# Updating existing report from the _save modal of the new page
def update
@report.last_modified_by = current_user
@report.pdf_file_processing = true
@report.assign_attributes(report_params)
ReportActions::ReportContent.new(
@report,
params[:project_content],
params[:template_values],
current_user
).save_with_content
if @report.errors.blank?
log_activity(:edit_report)
redirect_to reports_path
else
render json: @report.errors.full_messages, status: :unprocessable_entity
end
end
# Destroy multiple entries action
def destroy
begin
report_ids = JSON.parse(params[:report_ids])
rescue
render_404
end
report_ids.each do |report_id|
report = Report.find_by_id(report_id)
next unless report.present? && can_manage_reports?(report.project.team)
# record an activity
log_activity(:delete_report, report)
report.destroy
end
redirect_to reports_path
end
def status
docx = @report.docx_file.attached? ? document_preview_report_path(@report, report_type: :docx) : nil
pdf = @report.pdf_file.attached? ? document_preview_report_path(@report, report_type: :pdf) : nil
respond_to do |format|
format.json do
render json: {
docx: {
processing: @report.docx_file_processing,
preview_url: docx,
error: false
},
pdf: {
processing: @report.pdf_file_processing,
preview_url: pdf,
error: false
}
}
end
end
end
# Generation actions
def generate_pdf
respond_to do |format|
format.json do
@report.update!(pdf_file_processing: true)
log_activity(:generate_pdf_report)
Reports::PdfJob.perform_later(@report, current_user)
render json: {
message: I18n.t('projects.reports.index.generation.accepted_message')
}
end
end
end
def generate_docx
respond_to do |format|
format.json do
@report.update!(docx_file_processing: true)
log_activity(:generate_docx_report)
Reports::DocxJob.perform_later(@report, current_user, current_team, root_url)
render json: {
message: I18n.t('projects.reports.index.generation.accepted_message')
}
end
end
end
def save_pdf_to_inventory_modal
respond_to do |format|
format.json do
render json: {
html: render_to_string(partial: 'reports/save_PDF_to_inventory_modal.html.erb')
}
end
end
end
def save_pdf_to_inventory_item
return render_404 unless @report.pdf_file.attached?
save_pdf_to_inventory_item = ReportActions::SavePdfToInventoryItem.new(
@report, current_user, current_team, save_pdf_params
)
if save_pdf_to_inventory_item.save
render json: {
message: I18n.t(
'projects.reports.new.save_PDF_to_inventory_modal.success_flash'
)
}, status: :ok
else
render json: { message: save_pdf_to_inventory_item.error_messages },
status: :unprocessable_entity
end
rescue ReportActions::RepositoryPermissionError => e
render json: { message: e.message }, status: :forbidden
rescue StandardError => e
render json: { message: e.message }, status: :internal_server_error
end
# Modal for saving the existsing/new report
def save_modal
# Assume user is updating existing report
@report = @project.reports.find_by_id(params[:id])
@method = :put
# Case when saving a new report
if @report.blank?
@report = Report.new
@method = :post
@url = project_reports_path(@project, format: :json)
else
@url = project_report_path(@project, @report, format: :json)
end
render_403 and return unless params.include? :contents
@report_contents = params[:contents]
respond_to do |format|
format.json do
render json: {
html: render_to_string(
partial: 'reports/new/modal/save.html.erb'
)
}
end
end
end
# Experiment for adding contents into experiment element
def experiment_contents_modal
experiment = @project.experiments.find_by_id(params[:experiment_id])
respond_to do |format|
if experiment.blank?
format.json do
render json: {}, status: :not_found
end
else
format.json do
render json: {
html: render_to_string(
partial: 'reports/new/modal/experiment_contents.html.erb',
locals: { project: @project, experiment: experiment }
)
}
end
end
end
end
# Modal for adding contents into module element
def module_contents_modal
my_module = MyModule.find_by_id(params[:my_module_id])
return render_403 unless my_module.experiment.project == @project
respond_to do |format|
if my_module.blank?
format.json do
render json: {}, status: :not_found
end
else
format.json do
render json: {
html: render_to_string(
partial: 'reports/new/modal/module_contents.html.erb',
locals: { project: @project, my_module: my_module }
)
}
end
end
end
end
# Modal for adding contents into step element
def step_contents_modal
step = Step.find_by_id(params[:step_id])
return render_403 unless step.my_module.experiment.project == @project
respond_to do |format|
if step.blank?
format.json do
render json: {}, status: :not_found
end
else
format.json do
render json: {
html: render_to_string(
partial: 'reports/new/modal/step_contents.html.erb',
locals: { project: @project, step: step }
)
}
end
end
end
end
# Modal for adding contents into result element
def result_contents_modal
result = Result.find_by_id(params[:result_id])
return render_403 unless result.experiment.project == @project
respond_to do |format|
if result.blank?
format.json do
render json: {}, status: :not_found
end
else
format.json do
render json: {
html: render_to_string(
partial: 'reports/new/modal/result_contents.html.erb',
locals: { project: @project, result: result }
)
}
end
end
end
end
def project_contents
render json: {
html: render_to_string(
partial: 'reports/wizard/project_contents.html.erb',
locals: { project: @project, report: nil}
)
}
end
def experiment_contents
experiment = @project.experiments.find_by(id: params[:id])
module_ids = (params[:modules].select { |_, p| p == '1' }).keys.collect(&:to_i)
selected_modules = experiment.my_modules.where(id: module_ids)
respond_to do |format|
if experiment.blank?
format.json { render json: {}, status: :not_found }
elsif selected_modules.blank?
format.json { render json: {}, status: :no_content }
else
elements = generate_experiment_contents_json(selected_modules)
end
if elements_empty? elements
format.json { render json: {}, status: :no_content }
else
format.json do
render json: {
status: :ok,
elements: elements
}
end
end
end
end
def module_contents
my_module = MyModule.find_by_id(params[:id])
return render_403 unless my_module.experiment.project == @project
respond_to do |format|
if my_module.blank?
format.json { render json: {}, status: :not_found }
else
elements = generate_module_contents_json(my_module)
if elements_empty? elements
format.json { render json: {}, status: :no_content }
else
format.json do
render json: {
status: :ok,
elements: elements
}
end
end
end
end
end
def step_contents
step = Step.find_by_id(params[:id])
return render_403 unless step.my_module.experiment.project == @project
respond_to do |format|
if step.blank?
format.json { render json: {}, status: :not_found }
else
elements = generate_step_contents_json(step)
if elements_empty? elements
format.json { render json: {}, status: :no_content }
else
format.json {
render json: {
status: :ok,
elements: elements
}
}
end
end
end
end
def result_contents
result = Result.find_by_id(params[:id])
return render_403 unless result.my_module.experiment.project == @project
respond_to do |format|
if result.blank?
format.json { render json: {}, status: :not_found }
else
elements = generate_result_contents_json(result)
if elements_empty? elements
format.json { render json: {}, status: :no_content }
else
format.json {
render json: {
status: :ok,
elements: elements
}
}
end
end
end
end
def available_repositories
render json: { results: @available_repositories }, status: :ok
end
def document_preview
render json: { html: render_to_string(
partial: 'reports/content_document_preview.html.erb',
locals: {
report: @report,
report_type: params[:report_type]
}
) }
end
private
include StringUtility
AvailableRepository = Struct.new(:id, :name)
def load_vars
@report = current_team.reports.find_by(id: params[:id])
render_404 unless @report
render_403 unless can_read_project?(@report.project)
end
def load_vars_nested
@project = current_team.projects.find_by(id: params[:project_id])
render_404 unless @project
render_403 unless can_read_project?(@project)
end
def check_manage_permissions
render_403 unless can_manage_reports?(@project.team)
end
def load_visible_projects
render_404 unless current_team
@visible_projects = Project.viewable_by_user(
current_user, current_team
).select(:id, :name)
end
def load_available_repositories
@available_repositories = []
repositories = Repository.active
.accessible_by_teams(current_team)
.name_like(search_params[:q])
.limit(Constants::SEARCH_LIMIT)
.select(:id, :name, :team_id, :permission_level)
repositories.each do |repository|
next unless can_manage_repository_rows?(current_user, repository)
@available_repositories.push(AvailableRepository.new(repository.id,
ellipsize(repository.name, 75, 50)))
end
end
def report_params
params.require(:report)
.permit(:name, :description, :grouped_by, :report_contents, settings: {})
end
def search_params
params.permit(:q)
end
def save_pdf_params
params.permit(:repository_id, :respository_column_id, :repository_item_id)
end
def log_activity(type_of, report = @report)
Activities::CreateActivityService
.call(activity_type: type_of,
owner: current_user,
subject: report,
team: report.team,
project: report.project,
message_items: { report: report.id })
end
def generate_pdf_report
log_activity(:generate_pdf_report)
Reports::PdfJob.perform_later(@report, current_user) if @report.persisted?
end
end