Class: DcCommonController

Inherits:
DcApplicationController show all
Defined in:
app/controllers/dc_common_controller.rb

Overview

This controller holds some common actions used by CMS.

Instance Method Summary collapse

Methods inherited from DcApplicationController

#dc_dump, #dc_edit_mode?, #dc_find_form_file, #dc_get_site, #dc_log_visit, #dc_render_404, #dc_user_has_role, #set_page_title

Instance Method Details

#ad_click ⇒ Object

Register and record click when ad link is clicked.



77
78
79
80
81
82
83
84
85
86
87
 
# File 'app/controllers/dc_common_controller.rb', line 77

def ad_click
  if params[:id] and (ad = DcAd.find(params[:id]))
    ad.clicked += 1
    ad.save
    DcAdStat.create!(dc_ad_id: params[:id], ip: request.ip, type: 2 ) 
  else
    logger.error "ERROR ADS: Invalid ad id=#{params[:id]} ip=#{request.ip}."
  end

  render body: nil
end

#add_json_ld_schema ⇒ Object

Will add new json_ld element with blank structure into dc_json_ld field on a document.



259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'app/controllers/dc_common_controller.rb', line 259

def add_json_ld_schema
  edited_document = DcJsonLd.find_document_by_ids(params[:table], params[:ids])
  yaml = YAML.load_file( dc_find_form_file('json_ld_schema') )
  schema_data = yaml[params[:schema]]
# Existing document  
  if edited_document.dc_json_lds.find_by(type: "@#{params[:schema]}")
    return render json: {'msg_error' => t('helpers.help.dc_json_ld.add_error', schema: params[:schema] ) }
  else
    add_empty_json_ld_schema(edited_document, schema_data, params[:schema], params[:schema], yaml)
  end
  render json: {'reload_' => 1}
end

#autocomplete ⇒ Object

This action is called on ajax autocomplete call. It checks if user has rights to view data.

URL parameters:

table

Table (collection) model name in lower case indicating table which will be searched.

id

Name of id key field that will be returned. Default is ‘_id’

input

Search data entered in input field.

search

when passed without dot it defines field name on which search

will be performed. When passed with dot class_method.method_name is assumed. Method name will be parsed and any class with class method name can be evaluated. Class method must accept input parameter and return array [ [_id, value],.. ] which will be used in autocomplete field.

Return: JSON array [label, value, id] of first 20 documents that confirm to query.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'app/controllers/dc_common_controller.rb', line 46

def autocomplete
  # table parameter must be defined. If not, get it from search parameter
  if params['table'].nil? and params['search'].match(/\./)
    name = params['search'].split('.').first
    params['table'] = name.underscore
  end
  
  return render plain: t('drgcms.not_authorized') unless dc_user_can(DcPermission::CAN_VIEW)
# TODO Double check if previous line works as it should.
  table = params['table'].classify.constantize
  id = [params['id']] || '_id'
# call method in class if search parameter has . This is for user defined searches
# result must be returned as array of [id, search_field_value]
  a = if params['search'].match(/\./)
    name, method = params['search'].split('.')
    table.send(method, params['input']).inject([]) do |r,v|
      r << { label: v[0], value: v[0], id: (v[1] || v[0]).to_s }
    end
# simply search which will search and return field_name defined in params['search']
  else
    table.where(params['search'] => /#{params['input']}/i).limit(20).inject([]) do |r,v|
      r << { label: v[params['search']], value: v[params['search']], id: v.id.to_s }
    end
  end

  render plain: a.to_json
end

#copy_clipboard ⇒ Object

Copy current record to clipboard as json text. It will actually ouput an window with data formatted as json.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'app/controllers/dc_common_controller.rb', line 204

def copy_clipboard
# Only administrators can perform this operation  
  return render(plain: t('drgcms.not_authorized') )  unless dc_user_can(DcPermission::CAN_ADMIN,'dc_site')
  respond_to do |format|
# just open new window to same url and come back with html request    
    format.json { dc_render_ajax(operation: 'window', url: request.url ) }
    
    format.html do
      doc = dc_find_document(params[:table], params[:id], params[:ids])
      text = "<br><br>[#{params[:table]},#{params[:id]},#{params[:ids]}]<br>"
      render plain: text + doc.as_document.to_json
    end
    
  end  
end

#help ⇒ Object

Will provide help data



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'app/controllers/dc_common_controller.rb', line 275

def help
  form_name = params[:form_name] || params[:table]
  @form = form_name ? YAML.load_file(dc_find_form_file(form_name)) : {}
  return render json: {} if @form.nil?

  help_file_name = @form['help'] || @form['extend'] || params[:form_name] || params[:table]
  help_file_name = find_help_file(help_file_name)
  @help = YAML.load_file(help_file_name) if help_file_name
  # no auto generated help on index action
  return render json: {} if params[:type] == 'index' && @help.nil?

  render json: { popup: render_to_string(partial: 'help') }
end

#login ⇒ Object

Alternative login action with remember_me cookie. If found it will automatically login user otherwise user will be presented with regular login dialog.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'app/controllers/dc_common_controller.rb', line 147

def 
  if cookies.signed[:remember_me]
    user = DcUser.find(cookies.signed[:remember_me])
    if user and user.active
      (user, true)
      return redirect_to params[:return_to]
    else
       # on the safe side
    end
  end
# Display login 
  route = params[:route] || 'poll'
  redirect_to "/#{route}?poll_id=login&return_to=#{params[:return_to]}"
end

#logout ⇒ Object

Default user logout action.



138
139
140
141
 
# File 'app/controllers/dc_common_controller.rb', line 138

def logout
  
  redirect_to params[:return_to] || '/'
end

#paste_clipboard ⇒ Object

Paste data from clipboard into text_area and update documents in destination database. This action is called twice. First time for displaying text_area field and second time ajax call for processing data.



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
 
# File 'app/controllers/dc_common_controller.rb', line 225

def paste_clipboard
# Only administrators can perform this operation  
  return render(plain: t('drgcms.not_authorized') )  unless dc_user_can(DcPermission::CAN_ADMIN,'dc_site')
  result = ''
  respond_to do |format|
# just open new window to same url and come back with html request    
    format.html { return render('paste_clipboard', layout: 'cms') }
    format.json {
      table, id, ids = nil
      params[:data].split("\n").each do |line|
        line.chomp!
        next if line.size < 5                 # empty line. Skip
        begin
          if line[0] == '['                   # id(s)
            result << "<br>#{line}"
            line = line[/\[(.*?)\]/, 1]       # just what is between []
            table, id, ids = line.split(',')
          elsif line[0] == '{'                # document data
            result << process_document(line, table, id, ids)
          end
        rescue Exception => e 
          result << " Runtime error. #{e.message}\n"
          break
        end
      end
    }
  end
  dc_render_ajax(div: 'result', value: result )
end

#process_login ⇒ Object

Default user login action.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'app/controllers/dc_common_controller.rb', line 118

def 
# Somebody is probably playing
  return dc_render_404 unless ( params[:record] and params[:record][:username] and params[:record][:password] )

  unless params[:record][:password].blank? #password must not be empty
    user  = DcUser.find_by(username: params[:record][:username], active: true)
    if user and user.authenticate(params[:record][:password])
      (user, params[:record][:remember_me].to_i == 1)
      return redirect_to params[:return_to] ||  '/'
    else
       # on the safe side
    end
  end
  flash[:error] = t('drgcms.invalid_username')
  redirect_to params[:return_to_error] ||  '/'
end

#restore_from_journal ⇒ Object

Action for restoring document data from journal document.



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
 
# File 'app/controllers/dc_common_controller.rb', line 165

def restore_from_journal
# Only administrators can perform this operation  
  unless dc_user_has_role('admin')
    return render plain: { 'msg_info' => (t ('drgcms.not_authorized')) }.to_json
  end
# selected fields to hash  
  restore = {} 
  params[:select].each {|key,value| restore[key] = value if value == '1' }
  result = if restore.size == 0
    { 'msg_error' => (t ('drgcms.dc_journal.zero_selected')) }
  else
    journal_doc = DcJournal.find(params[:id])
# update hash with data to be restored    
    JSON.parse(journal_doc.diff).each {|k,v| restore[k] = v.first if restore[k] }
# determine tables and document ids    
    tables = journal_doc.tables.split(';')
    ids = (journal_doc.ids.blank? ? [] : journal_doc.ids.split(';') ) << journal_doc.doc_id
# find document
    doc = nil
    tables.each_index do |i|
      doc = if doc.nil?
        (tables[i].classify.constantize).find(ids[i])
      else
        doc.send(tables[i].pluralize).find(ids[i])
      end
    end
# restore and save values
    restore.each { |field,value| doc.send("#{field}=",value) }
    doc.save
# TODO Error checking    
    { 'msg_info' => (t ('drgcms.dc_journal.restored')) }
  end
  render plain: result.to_json
end

#toggle_edit_mode ⇒ Object

Toggle CMS edit mode.This action is called when user clicks CMS option on top of the browser.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'app/controllers/dc_common_controller.rb', line 93

def toggle_edit_mode
  session[:edit_mode] ||= 0 
# error when not logged in  
  return dc_render_404 if session[:edit_mode] < 1 
# if return_to_ypos parameter is present it will forward it and thus scroll to
# aproximate position it was when toggle was clicked
  session[:edit_mode] = (session[:edit_mode] == 1) ? 2 : 1
  uri = Rack::Utils.parse_nested_query(request.url)
# it parses only on & so first (return_to) parameter also contains url
  url = uri.first.last
  if (i = url.index('return_to_ypos')).to_i > 0
    url = url[0,i-1]
  end 
# offset CMS menu
  if (ypos = uri['return_to_ypos'].to_i) > 0
    ypos += session[:edit_mode] == 2 ? 250 : -250
  end
  url << (url.match(/\?/) ? '&' : '?')
  url << "return_to_ypos=#{ypos}"
  redirect_to url
end