/
schedules.rb
489 lines (439 loc) · 20.3 KB
/
schedules.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
module ReportController::Schedules
extend ActiveSupport::Concern
def show_schedule
if @schedule.nil?
redirect_to :action => "schedules", :flash_msg => _("Error: Record no longer exists in the database"), :flash_error => true
return
end
# Get configured tz, else use user's tz
@timezone = (@schedule.run_at && @schedule.run_at[:tz]) ? @schedule.run_at[:tz] : session[:user_tz]
if @schedule.filter.kind_of?(MiqExpression)
record = MiqReport.find_by_id(@schedule.filter.exp["="]["value"])
@rep_filter = record.name
end
@breadcrumbs = []
drop_breadcrumb(:name => @schedule.name, :url => "/report/show_schedule/#{@schedule.id}")
if @schedule.sched_action[:options] && @schedule.sched_action[:options][:email]
@email_to = []
@schedule.sched_action[:options][:email][:to].each_with_index do |e, _e_idx|
u = User.find_by_email(e)
@email_to.push(u ? "#{u.name} (#{e})" : e)
end
end
# render :action=>"show_schedule"
end
def schedule_get_all
@schedules = true
@force_no_grid_xml = true
@gtl_type = "list"
@ajax_paging_buttons = true
if params[:ppsetting] # User selected new per page value
@items_per_page = params[:ppsetting].to_i # Set the new per page value
@settings.store_path(:perpage, @gtl_type.to_sym, @items_per_page) # Set the per page setting for this gtl type
end
@sortcol = session[:schedule_sortcol].nil? ? 0 : session[:schedule_sortcol].to_i
@sortdir = session[:schedule_sortdir].nil? ? "ASC" : session[:schedule_sortdir]
if super_admin_user? # Super admins see all user's schedules
@view, @pages = get_view(MiqSchedule, :conditions => ["towhat=?", "MiqReport"]) # Get the records (into a view) and the paginator
else
@view, @pages = get_view(MiqSchedule, :conditions => ["towhat=? AND userid=?", "MiqReport", session[:userid]]) # Get the records (into a view) and the paginator
end
@current_page = @pages[:current] unless @pages.nil? # save the current page number
session[:schedule_sortcol] = @sortcol
session[:schedule_sortdir] = @sortdir
@sb[:tree_typ] = "schedules"
@right_cell_text = _("All %{models}") % {:models => ui_lookup(:models => "MiqSchedule")}
@right_cell_div = "schedule_list"
end
def schedule_new
assert_privileges("miq_report_schedule_add")
@schedule = MiqSchedule.new(:userid => session[:userid])
@in_a_form = true
@schedule.towhat = "MiqReport"
if @sb[:tree_typ] == "reports"
exp = {}
exp["="] = {"field" => "MiqReport-id", "value" => @sb[:miq_report_id]}
@_params.delete :id # incase add schedule button was pressed from report show screen.
@schedule.filter = MiqExpression.new(exp)
miq_report = MiqReport.find(@sb[:miq_report_id])
@schedule.name = miq_report.name
@schedule.description = miq_report.title
@changed = session[:changed] = true
end
schedule_edit
end
alias_method :miq_report_schedule_add, :schedule_new
# Delete all selected or single displayed action(s)
def miq_report_schedule_delete
assert_privileges("miq_report_schedule_delete")
scheds = find_checked_records_with_rbac(MiqSchedule)
scheds = [find_record_with_rbac(MiqSchedule, params[:id])] if scheds.empty? && params[:id] # sched. summary screen
add_flash(_("%{model} is not available or no longer exists") % {:model => ui_lookup(:model => "MiqSchedule")}, :error) if scheds.empty?
single_name = scheds.first.name if scheds.length == 1
process_schedules(scheds, "destroy") unless scheds.empty?
unless flash_errors?
if single_name
add_flash(_("%{schedule} %{name} was deleted") % {:schedule => ui_lookup(:model => "MiqSchedule"), :name => single_name}, :success, true)
else
add_flash(_("The selected %{schedules} were deleted") % {:schedules => ui_lookup(:models => "MiqSchedule")}, :success, true)
end
end
self.x_node = "root"
replace_right_cell(:replace_trees => [:schedules])
end
def miq_report_schedule_run_now
assert_privileges("miq_report_schedule_run_now")
schedules = find_records_with_rbac(MiqSchedule, checked_or_params)
schedules.sort_by { |e| e.name.downcase}.each do |schedule|
MiqSchedule.queue_scheduled_work(schedule.id, nil, Time.now.utc.to_i, nil)
audit = {
:event => "queue_scheduled_work",
:message => _("Schedule [%{schedule}] queued to run from the UI by user %{user}") %
{ :schedule => schedule.name, :user => current_user.name },
:target_id => schedule.id,
:target_class => "MiqSchedule",
:userid => session[:userid]
}
AuditEvent.success(audit)
end
unless flash_errors?
msg = if params[:id]
_("The selected Schedule has been queued to run")
else
_("The selected Schedules have been queued to run")
end
add_flash(msg, :info, true)
end
get_node_info
replace_right_cell
end
def schedule_toggle(enable)
assert_privileges("miq_report_schedule_#{enable ? 'enable' : 'disable'}")
msg1, msg2 = if enable
[_("No %{schedules} were selected to be enabled"),
_("The selected %{schedules} were enabled")]
else
[_("No %{schedules} were selected to be disabled"),
_("The selected %{schedules} were disabled")]
end
scheds = find_records_with_rbac(MiqSchedule, checked_or_params)
if scheds.empty?
add_flash(msg1 % {:schedules => "#{ui_lookup(:model => "MiqReport")} #{ui_lookup(:models => "MiqSchedule")}"},
:error)
javascript_flash
end
schedule_enable_disable(scheds, enable) unless scheds.empty?
add_flash(msg2 % {:schedules => "#{ui_lookup(:model => "MiqReport")} #{ui_lookup(:models => "MiqSchedule")}"},
:info, true) unless flash_errors?
schedule_get_all
replace_right_cell
end
def miq_report_schedule_enable
schedule_toggle(true)
end
def miq_report_schedule_disable
schedule_toggle(false)
end
# AJAX driven routine to check for changes in ANY field on the form
def schedule_form_field_changed
return unless load_edit("schedule_edit__#{params[:id]}", "replace_cell__explorer")
schedule_get_form_vars
if @edit[:new][:filter]
@folders ||= []
report_selection_menus
end
render :update do |page|
page << javascript_prologue
if params[:filter_typ]
@edit[:new][:subfilter] = nil
@edit[:new][:repfilter] = @reps = nil
elsif params[:subfilter_typ]
@edit[:new][:repfilter] = nil
end
page.replace("form_filter_div", :partial => "schedule_form_filter")
javascript_for_timer_type(params[:timer_typ]).each { |js| page << js }
if params[:time_zone]
page << "ManageIQ.calendar.calDateFrom = new Date(#{(Time.zone.now - 1.month).in_time_zone(@edit[:tz]).strftime("%Y,%m,%d")});"
page << "miqBuildCalendar();"
page << "$('#miq_date_1').val('#{@edit[:new][:timer].start_date}');"
page << "$('#start_hour').val('#{@edit[:new][:timer].start_hour.to_i}');"
page << "$('#start_min').val('#{@edit[:new][:timer].start_min.to_i}');"
page.replace_html("tz_span", @timezone_abbr)
end
if @email_refresh
page.replace("edit_email_div",
:partial => "layouts/edit_email",
:locals => {:action_url => "schedule_form_field_changed",
:box_title => "E-Mail after Running",
:record => @schedule})
page.replace("schedule_email_options_div", :partial => "schedule_email_options")
end
if params[:timer_typ].present?
# when timer_typ set to hourly set starting date to current day otherwise it's the day after
if params[:timer_typ] == 'Hourly'
@edit[:new][:timer].start_date = Time.zone.now.strftime("%m/%d/%Y")
else
@edit[:new][:timer].start_date = (Time.zone.now + 1.day).strftime("%m/%d/%Y")
end
end
page << "$('#miq_date_1').val('#{@edit[:new][:timer].start_date}');"
changed = (@edit[:new] != @edit[:current])
if changed != session[:changed]
session[:changed] = changed
page << javascript_for_miq_button_visibility(changed)
end
page << "miqSparkle(false);"
end
end
def schedule_edit
assert_privileges("miq_report_schedule_edit")
case params[:button]
when "cancel"
@schedule = MiqSchedule.find_by_id(session[:edit][:sched_id]) if session[:edit] && session[:edit][:sched_id]
if !@schedule || @schedule.id.blank?
add_flash(_("Add of new %{model} was cancelled by the user") % {:model => ui_lookup(:model => "MiqSchedule")})
else
add_flash(_("Edit of %{model} \"%{name}\" was cancelled by the user") % {:model => ui_lookup(:model => "MiqSchedule"), :name => @schedule.name})
end
@schedule = nil
@edit = session[:edit] = nil # clean out the saved info
@in_a_form = false
replace_right_cell
when "save", "add"
id = params[:id] ? params[:id] : "new"
return unless load_edit("schedule_edit__#{id}", "replace_cell__explorer")
schedule = @edit[:sched_id] ? MiqSchedule.find(@edit[:sched_id]) : MiqSchedule.new(:userid => session[:userid])
if !@edit[:new][:repfilter] || @edit[:new][:repfilter] == ""
add_flash(_("A Report must be selected"), :error)
end
schedule_set_record_vars(schedule)
schedule_valid?(schedule)
if schedule.valid? && !flash_errors? && schedule.save
AuditEvent.success(build_saved_audit(schedule, @edit))
@edit[:sched_id] ?
add_flash(_("%{model} \"%{name}\" was saved") % {:model => ui_lookup(:model => "MiqSchedule"), :name => schedule.name}) :
add_flash(_("%{model} \"%{name}\" was added") % {:model => ui_lookup(:model => "MiqSchedule"), :name => schedule.name})
params[:id] = schedule.id.to_s # reset id in params for show
@edit = session[:edit] = nil # clean out the saved info
# ensure we land in the right accordion with the right tree and
# with the listing opened even when entering 'add' from the reports
# menu
self.x_active_tree = "schedules_tree"
self.x_active_accord = "schedules"
self.x_node = "msc-#{to_cid(schedule.id)}"
@_params[:accord] = "schedules"
replace_right_cell(:replace_trees => [:schedules])
else
schedule.errors.each do |field, msg|
add_flash("#{field.to_s.capitalize} #{msg}", :error)
end
@changed = session[:changed] = (@edit[:new] != @edit[:current])
drop_breadcrumb(:name => "Edit Schedule", :url => "/miq_schedule/edit")
javascript_flash
end
when "reset", nil # Reset or first time in
add_flash(_("All changes have been reset"), :warning) if params[:button] == "reset"
if x_active_tree != :reports_tree
# dont set these if new schedule is being added from a report show screen
obj = find_checked_ids_with_rbac(MiqSchedule)
obj[0] = params[:id] if obj.blank? && params[:id]
@schedule = obj[0] && params[:id] != "new" ? MiqSchedule.find(obj[0]) :
MiqSchedule.new(:userid => session[:userid]) # Get existing or new record
session[:changed] = false
end
schedule_set_form_vars
schedule_build_edit_screen
@lock_tree = true
replace_right_cell
end
end
alias_method :miq_report_schedule_edit, :schedule_edit
private
# Common Schedule button handler routines
def process_schedules(schedules, task)
process_elements(schedules, MiqSchedule, task)
end
# Validate some of the schedule fields
def schedule_valid?(sched)
valid = true
if sched.sched_action[:options] &&
sched.sched_action[:options][:send_email] &&
sched.sched_action[:options][:email] &&
sched.sched_action[:options][:email][:to].blank?
valid = false
add_flash(_("At least one To E-mail address must be configured"),
:error)
end
unless flash_errors?
if sched.run_at[:interval][:unit] == "once" &&
sched.run_at[:start_time].to_time.utc < Time.now.utc &&
sched.enabled == true
add_flash(_("Warning: This 'Run Once' timer is in the past and will never run as currently configured"), :warning)
end
end
valid
end
# Set form variables for edit
def schedule_set_form_vars
@timezone_abbr = get_timezone_abbr
@edit = {}
@folders = []
# Remember how this edit started
@edit[:type] = %w(miq_report_schedule_copy
miq_report_schedule_new).include?(params[:action]) ? "schedule_new" : "schedule_edit"
# Get configured tz, default to user's tz
@edit[:tz] = @schedule.run_at && @schedule.run_at[:tz] ? @schedule.run_at[:tz] : session[:user_tz]
@edit[:sched_id] = @schedule.id
@edit[:new] = {}
@edit[:current] = {}
@edit[:key] = "schedule_edit__#{@schedule.id || "new"}"
@menu = get_reports_menu(true)
@menu.each { |r| @folders.push(r[0]) }
@edit[:new][:name] = @schedule.name
@edit[:new][:description] = @schedule.description
@edit[:new][:enabled] = @schedule.enabled.nil? ? false : @schedule.enabled
@edit[:new][:send_email] = @schedule.sched_action.nil? || !@schedule.sched_action.key?(:options) ?
false :
@schedule.sched_action[:options][:send_email] == true
@edit[:new][:email] = {}
if @schedule.sched_action && @schedule.sched_action[:options] && @schedule.sched_action[:options][:email]
@edit[:new][:email] = copy_hash(@schedule.sched_action[:options][:email])
end
@edit[:new][:email][:send_if_empty] = true if @edit[:new][:email][:send_if_empty].nil?
if @schedule.sched_action && @schedule.sched_action[:options] && @schedule.sched_action[:options][:email]
# rebuild hash to hold user's email along with name if user record was found for display, defined as hash so only email id can be sent from form to be deleted from array above
@email_to = {}
@schedule.sched_action[:options][:email][:to].each_with_index do |e, _e_idx|
u = User.find_by_email(e)
@email_to[e] = u ? "#{u.name} (#{e})" : e
end
end
if @schedule.filter
record = MiqReport.find_by_id(@schedule.filter.exp["="]["value"])
@menu.each do |m|
m[1].each do |f|
f.each do |r|
if r.class != String
r.each do |rep|
if rep == record.name
@edit[:new][:filter] = m[0]
@edit[:new][:subfilter] = f[0]
end
end
end
end
end
end
@edit[:new][:repfilter] = record.id
report_selection_menus
end
set_edit_timer_from_schedule(@schedule)
@edit[:current] = copy_hash(@edit[:new])
session[:edit] = @edit
end
# Get variables from edit form
def schedule_get_form_vars
@schedule = @edit[:sched_id] ? MiqSchedule.find_by_id(@edit[:sched_id]) :
MiqSchedule.new(:userid => session[:userid])
@edit[:new][:name] = params[:name] if params[:name]
@edit[:new][:description] = params[:description] if params[:description]
@edit[:new][:enabled] = (params[:enabled] == "1") if params[:enabled]
@edit[:new][:filter] = params[:filter_typ] if params[:filter_typ]
@edit[:new][:subfilter] = params[:subfilter_typ] if params[:subfilter_typ]
if params[:repfilter_typ] && params[:repfilter_typ] != "<Choose>"
rep = MiqReport.for_user(current_user).find(params[:repfilter_typ].to_i)
@edit[:new][:repfilter] = rep.id
elsif params[:repfilter_typ] && params[:repfilter_typ] == "<Choose>"
@edit[:new][:repfilter] = nil
end
@edit[:new][:timer] ||= ReportHelper::Timer.new
@edit[:new][:timer].update_from_hash(params)
if params[:time_zone]
@edit[:tz] = params[:time_zone]
@timezone_abbr = Time.now.in_time_zone(@edit[:tz]).strftime("%Z")
end
@edit[:new][:filter] = "" if @edit[:new][:filter] == "<Choose>"
@edit[:new][:subfilter] = "" if @edit[:new][:subfilter] == "<Choose>"
@edit[:new][:email][:from] = params[:from] if params.key?(:from)
@edit[:email] = params[:email] if params.key?(:email)
if params[:user_email]
@edit[:new][:email][:to] ||= []
@edit[:new][:email][:to].push(params[:user_email])
@edit[:new][:email][:to].sort!
@edit[:user_emails].delete(params[:user_email])
end
if params[:button] == "add_email"
@edit[:new][:email][:to] ||= []
@edit[:new][:email][:to].push(@edit[:email]) unless @edit[:email].blank? || @edit[:new][:email][:to].include?(@edit[:email])
@edit[:new][:email][:to].sort!
@edit[:email] = nil
end
if params[:remove_email]
@edit[:new][:email][:to].delete(params[:remove_email])
build_user_emails_for_edit
end
if params[:user_email] || params[:button] == "add_email" || params[:remove_email]
# rebuild hash to hold user's email along with name if user record was found for display, defined as hash so only email id can be sent from form to be deleted from array above
@email_to = {}
@edit[:new][:email][:to].each_with_index do |e, _e_idx|
u = User.find_by_email(e)
@email_to[e] = u ? "#{u.name} (#{e})" : e
end
end
@edit[:new][:email][:send_if_empty] = (params[:send_if_empty] == "1") if params.key?(:send_if_empty)
if params.key?(:send_txt) || params.key?(:send_csv) || params.key?(:send_pdf)
@edit[:new][:email][:attach] ||= []
if params.key?(:send_txt)
params[:send_txt] == "1" ? @edit[:new][:email][:attach].push(:txt) : @edit[:new][:email][:attach].delete(:txt)
end
if params.key?(:send_csv)
params[:send_csv] == "1" ? @edit[:new][:email][:attach].push(:csv) : @edit[:new][:email][:attach].delete(:csv)
end
if params.key?(:send_pdf)
params[:send_pdf] == "1" ? @edit[:new][:email][:attach].push(:pdf) : @edit[:new][:email][:attach].delete(:pdf)
end
@edit[:new][:email].delete(:attach) if @edit[:new][:email][:attach].blank?
end
@edit[:new][:send_email] = (params[:send_email_cb] == "1") if params.key?(:send_email_cb)
@email_refresh = true if params[:user_email] || params[:remove_email] ||
params[:button] == "add_email" || params.key?(:send_email_cb)
end
def schedule_build_edit_screen
@schedule = @edit[:sched_id] ? MiqSchedule.find_by_id(@edit[:sched_id]) :
MiqSchedule.new(:userid => session[:userid])
@in_a_form = true
build_user_emails_for_edit
end
# Set record variables to new values
def schedule_set_record_vars(schedule)
schedule.name = @edit[:new][:name]
schedule.description = @edit[:new][:description]
schedule.enabled = @edit[:new][:enabled]
schedule.towhat = "MiqReport" # Default schedules apply to MiqReport model for now
email_url_prefix = url_for_only_path(:controller => "report", :action => "show_saved") + "/"
schedule_options = {
:send_email => @edit[:new][:send_email],
:email_url_prefix => email_url_prefix,
:miq_group_id => current_user.current_group.id
}
schedule.sched_action = {:method => "run_report", :options => schedule_options}
schedule.sched_action[:options][:email] = copy_hash(@edit[:new][:email]) if @edit[:new][:send_email]
schedule.run_at = @edit[:new][:timer].flush_to_miq_schedule(schedule.run_at, @edit[:tz])
# Build the filter expression
exp = {}
unless !@edit[:new][:repfilter] || @edit[:new][:repfilter] == ""
record = MiqReport.find(@edit[:new][:repfilter].to_i)
exp["="] = {"field" => "MiqReport-id", "value" => record.id} if record
schedule.filter = MiqExpression.new(exp)
end
end
def build_schedules_tree
TreeBuilderReportSchedules.new('schedules_tree', 'schedules', @sb)
end
def get_schedule(nodeid)
@record = @schedule = MiqSchedule.find(from_cid(nodeid.split('__').last).to_i)
show_schedule
@right_cell_text = _("%{model} \"%{name}\"") % {:name => @schedule.name, :model => ui_lookup(:model => "MiqSchedule")}
@right_cell_div = "schedule_list"
end
end