Class: SourcesController

Inherits:
ApplicationController show all
Includes:
DataControllerConfiguration::SharedDataControllerConfiguration
Defined in:
app/controllers/sources_controller.rb

Constant Summary

Constants included from ProjectsHelper

ProjectsHelper::CLASSIFIER, ProjectsHelper::CLASSIFIER_ANNOTATION

Instance Method Summary collapse

Methods included from DataControllerConfiguration::SharedDataControllerConfiguration

#set_is_shared_data_model

Methods included from RedirectHelper

#destroy_redirect

Methods included from RequestType

#json_request?

Methods included from LogRecent

#log_user_recent_route

Methods included from Cookies

#digest_cookie, #digested_cookie_exists?

Methods included from Whitelist

#whitelist_constantize

Methods included from ProjectsHelper

#cumulative_gb_per_year, #document_cumulative_gb_per_year, #document_gb_per_year, #gb_per_year, #image_cumulative_gb_per_year, #image_gb_per_year, #invalid_object, #project_classification, #project_link, #project_matches, #project_tag, #projects_list, #projects_search_form, #taxonworks_classification, #week_in_review_graphs

Methods included from Api::Intercept

#intercept_api

Methods included from TokenAuthentication

#intercept_project, #intercept_user, #intercept_user_or_project, #project_token_authenticate, #token_authenticate

Instance Method Details

#api_indexObject

GET /api/v1/sources



273
274
275
276
277
278
# File 'app/controllers/sources_controller.rb', line 273

def api_index
  @sources = Queries::Source::Filter.new(params.merge!(api: true)).all
    .order('sources.id')
    .page(params[:page]).per(params[:per])
  render '/sources/api/v1/index'
end

#api_showObject

GET /api/v1/sources/:id



281
282
283
# File 'app/controllers/sources_controller.rb', line 281

def api_show
  render '/sources/api/v1/show'
end

#attributesObject



95
96
97
98
99
100
# File 'app/controllers/sources_controller.rb', line 95

def attributes
  render json: ::Source.columns.select{
    |a| Queries::Source::Filter::ATTRIBUTES.include?(
      a.name.to_sym)
  }.collect{|b| {'name' => b.name, 'type' => b.type } }
end

#autocompleteObject



154
155
156
157
158
159
160
# File 'app/controllers/sources_controller.rb', line 154

def autocomplete
  @term = params.require(:term)
  @sources = Queries::Source::Autocomplete.new(
    @term,
    **autocomplete_params
  ).autocomplete
end

#autocomplete_paramsObject (private)



295
296
297
# File 'app/controllers/sources_controller.rb', line 295

def autocomplete_params
  params.permit(:limit_to_project).merge(project_id: sessions_current_project_id).to_h.symbolize_keys
end

#batch_loadObject

GET /sources/batch_load



172
173
# File 'app/controllers/sources_controller.rb', line 172

def batch_load
end

#batch_paramsObject (private)



304
305
# File 'app/controllers/sources_controller.rb', line 304

def batch_params
end

#batch_updateObject

PATCH /sources/batch_update.json?source_query=<>&serial_id



176
177
178
179
180
181
182
183
184
185
186
# File 'app/controllers/sources_controller.rb', line 176

def batch_update
  if r = Source::Bibtex.batch_update(
      preview: params[:preview], 
      source: source_params.merge(by: sessions_current_user_id),
      source_query: params[:source_query],
  )
    render json: r.to_json, status: :ok
  else
    render json: {}, status: :unprocessable_entity
  end
end

#citation_object_typesObject

GET /sources/citation_object_types.json



103
104
105
106
107
108
109
# File 'app/controllers/sources_controller.rb', line 103

def citation_object_types
  render json: Source.joins(:citations)
    .where(citations: {project_id: sessions_current_project_id})
    .select('citations.project_id, citations.citation_object_type')
    .distinct
    .pluck(:citation_object_type).sort
end

#cloneObject

POST /sources/1/clone.json



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'app/controllers/sources_controller.rb', line 41

def clone
  respond_to do |format|

    # Don't panic, this `clone` is custom, see source.rb
    @source = @source.clone

    if @source.valid?

      @source.project_sources << ProjectSource.new(project_id: sessions_current_project_id)

      format.html { redirect_to edit_source_path(@source), notice: 'Clone successful, on new record.' }
      format.json { render :show }
    else
      format.html { redirect_to edit_source_path(@source), notice: 'Clone failed.  On original original.' }
      format.json { render json: @source.errors, status: :unprocessable_entity }
    end
  end
end

#createObject

POST /sources POST /sources.json



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'app/controllers/sources_controller.rb', line 72

def create
  params[:source].merge!( { project_sources_attributes: [{project_id: sessions_current_project_id}] } )
  @source = new_source

  respond_to do |format|

    if @source && @source.save
      format.html { redirect_to url_for(@source.metamorphosize),
                    notice: "#{@source.type} successfully created." }
      format.json { render action: 'show', status: :created, location: @source.metamorphosize }
    else
      format.html { render action: 'new' }
      format.json { render json: @source.errors, status: :unprocessable_entity }
    end

  end
end

#create_bibtex_batch_loadObject



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'app/controllers/sources_controller.rb', line 208

def create_bibtex_batch_load
  file = params.require(:file)
  redirect_to batch_load_sources_path, notice: 'no file has been selected' and return if file.blank?
  sha256 = Digest::SHA256.file(file.tempfile)
  if cookies[:batch_sources_md5] == sha256.hexdigest
    if result_hash = Source.batch_create(file.tempfile)
      # error in results?
      @count = result_hash[:count]
      @sources = result_hash[:records]
      flash[:notice] = "Successfully batch created #{@count} sources."
      render 'sources/batch_load/bibtex/bibtex_batch_create'
    else
      flash[:notice] = 'Failed to create sources.'
      redirect_to batch_load_sources_path
    end
  else
    flash[:notice] = 'Batch upload must be previewed before it can be created.'
    redirect_to batch_load_sources_path
  end
end

#csl_typesObject

GET /sources/csl_types.json



112
113
114
# File 'app/controllers/sources_controller.rb', line 112

def csl_types
  render json: ::CSL_STYLES
end

#destroyObject

DELETE /sources/1 DELETE /sources/1.json



140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'app/controllers/sources_controller.rb', line 140

def destroy
  if @source.destroy
    respond_to do |format|
      format.html { redirect_to sources_url, notice: "Destroyed source #{@source.cached}" }
      format.json { head :no_content }
    end
  else
    respond_to do |format|
      format.html { render action: :show, notice: 'failed to destroy the source, there is likely data associated with it' }
      format.json { render json: @source.errors, status: :unprocessable_entity }
    end
  end
end

#downloadObject

GET /sources/download



230
231
232
233
234
235
236
# File 'app/controllers/sources_controller.rb', line 230

def download
  send_data Export::CSV.generate_csv(
    Source.joins(:project_sources)
    .where(project_sources: {project_id: sessions_current_project_id})
    .all),
  type: 'text', filename: "sources_#{DateTime.now}.tsv"
end

#download_formattedObject

GET /sources/generate.json?<filter params>



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'app/controllers/sources_controller.rb', line 251

def download_formatted
  params.require(:style_id)
  @sources = Queries::Source::Filter.new(params).all
    .order(:cached)

  f = render_to_string(:index, formats: [:bib])

  respond_to do |format|
    format.pdf do
      pdf = ::Prawn::Document.new
      pdf.text(f, inline_format: true) # Formats <i>

      send_data(pdf.render, filename: "tw_bibliography_#{DateTime.now}.pdf", type: 'application/pdf')
    end

    format.json do
      send_data(f, filename: "tw_bibliography_#{DateTime.now}.txt", type: 'text/plain')
    end 
  end
end

#editObject

GET /sources/1/edit



61
62
63
# File 'app/controllers/sources_controller.rb', line 61

def edit
  redirect_to new_source_task_path(source_id: @source.id), notice: 'Editing in new interface.'
end

#generateObject

GET /sources/generate.json?<filter params>



239
240
241
242
243
244
245
246
247
248
# File 'app/controllers/sources_controller.rb', line 239

def generate
  sources = Queries::Source::Filter.new(params).all.page(params[:page]).per(params[:per] || 2000)
  @download = ::Export::Bibtex.download(
    sources,
    request.url,
    (params[:is_public] == 'true' ? true : false),
    params[:style_id]
  )
  render '/downloads/show'
end

#indexObject

GET /sources GET /sources.json



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# File 'app/controllers/sources_controller.rb', line 9

def index
  respond_to do |format|
    format.html do
      @recent_objects = Source.created_this_week.order(updated_at: :desc).limit(10)
      render '/shared/data/all/index'
    end
    format.json {
      @sources = Queries::Source::Filter.new(params).all
      .order(:cached)
      .page(params[:page])
      .per(params[:per])
    }
    format.bib {
      # TODO - handle count and download
      @sources = Queries::Source::Filter.new(params).all
      .order(:cached)
      .page(params[:page])
      .per(params[:per] || 2000)
    }
  end
end

#listObject



31
32
33
# File 'app/controllers/sources_controller.rb', line 31

def list
  @sources = Source.page(params[:page])
end

#newObject

GET /sources/new



66
67
68
# File 'app/controllers/sources_controller.rb', line 66

def new
  redirect_to new_source_task_path, notice: 'Redirected to new interface.'
end

#new_sourceObject (private)



287
288
289
290
291
292
293
# File 'app/controllers/sources_controller.rb', line 287

def new_source
  if params[:bibtex_input].blank?
    Source.new(source_params)
  else
    Source::Bibtex.new_from_bibtex_text(params[:bibtex_input])
  end
end

#parseObject



116
117
118
119
# File 'app/controllers/sources_controller.rb', line 116

def parse
  @source = new_source
  render '/sources/show'
end

#preview_bibtex_batch_loadObject



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'app/controllers/sources_controller.rb', line 188

def preview_bibtex_batch_load
  file = params.require(:file)
  redirect_to batch_load_sources_path, notice: 'No file has been selected.' and return if file.blank?
  file_ok, mimetype = Utilities::Files.recognized_batch_file_type?(file.tempfile)
  if !file_ok
    redirect_to batch_load_sources_path,
      notice: "File '#{file.original_filename}' is of type '#{mimetype}', and not processable as BibTex."
  else
    @sources, message = Source.batch_preview(file.tempfile)
    if @sources.size > 0
      sha256 = Digest::SHA256.file(file.tempfile)
      cookies[:batch_sources_md5] = sha256.hexdigest
      render 'sources/batch_load/bibtex/bibtex_batch_preview'
    else
      redirect_to batch_load_sources_path,
        notice: "Error parsing BibTeX :#{message}."
    end
  end
end

#searchObject



162
163
164
165
166
167
168
169
# File 'app/controllers/sources_controller.rb', line 162

def search
  if params[:id].blank?
    redirect_to sources_path, notice: 'You must select an item from the list with a click or tab ' \
      'press before clicking show.'
  else
    redirect_to source_path(params[:id])
  end
end

#select_optionsObject

GET /sources/select_options



91
92
93
# File 'app/controllers/sources_controller.rb', line 91

def select_options
  @sources = Source.select_optimized(sessions_current_user_id, sessions_current_project_id, params[:klass])
end

#set_sourceObject (private)



299
300
301
302
# File 'app/controllers/sources_controller.rb', line 299

def set_source
  @source = Source.find(params[:id])
  @recent_object = @source
end

#showObject

GET /sources/1 GET /sources/1.json



37
38
# File 'app/controllers/sources_controller.rb', line 37

def show
end

#source_paramsObject (private)



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# File 'app/controllers/sources_controller.rb', line 307

def source_params
  params.require(:source).permit(
    :serial_id, :address, :annote, :author, :booktitle, :chapter,
    :crossref, :edition, :editor, :howpublished, :institution,
    :journal, :key, :month, :note, :number, :organization, :pages,
    :publisher, :school, :series, :title, :type, :volume, :doi,
    :abstract, :copyright, :language, :stated_year, :verbatim,
    :bibtex_type, :day, :year, :isbn, :issn, :verbatim_contents,
    :verbatim_keywords, :language_id, :translator, :year_suffix, :url, :type, :style_id,
    :convert_to_bibtex,
    project_sources_attributes: [:project_id],
    roles_attributes: [
      :id,
      :_destroy,
      :type,
      :person_id,
      :position,
      person_attributes: [
        :last_name, :first_name, :suffix, :prefix
      ]
    ]
  )
end

#updateObject

PATCH/PUT /sources/1 PATCH/PUT /sources/1.json



123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'app/controllers/sources_controller.rb', line 123

def update
  respond_to do |format|
    if @source.update(source_params)
      # We go through this dance to handle changing types from verbatim to other
      @source = @source.becomes!(@source.type.safe_constantize)
      @source.reload # necessary to reload the cached value.
      format.html { redirect_to url_for(@source.metamorphosize), notice: 'Source was successfully updated.' }
      format.json { render :show, status: :ok, location: @source.metamorphosize }
    else
      format.html { render action: 'edit' }
      format.json { render json: @source.errors, status: :unprocessable_entity }
    end
  end
end