jro_apps/redmine Commit - r15348:596a196f2e7e

Don't error if an invalid setting is given....

Jean-Philippe Lang -

r15348:596a196f2e7e

parent child

Context file:

r15348:596a196f2e7e

Collapse all files

app/models/setting.rb +3 -1

             # Redmine - project management software
             # Copyright (C) 2006-2016  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class Setting < ActiveRecord::Base
               DATE_FORMATS = [
                     '%Y-%m-%d',
                     '%d/%m/%Y',
                     '%d.%m.%Y',
                     '%d-%m-%Y',
                     '%m/%d/%Y',
                     '%d %b %Y',
                     '%d %B %Y',
                     '%b %d, %Y',
                     '%B %d, %Y'
                 ]
               TIME_FORMATS = [
                 '%H:%M',
                 '%I:%M %p'
                 ]
               ENCODINGS = %w(US-ASCII
                               windows-1250
                               windows-1251
                               windows-1252
                               windows-1253
                               windows-1254
                               windows-1255
                               windows-1256
                               windows-1257
                               windows-1258
                               windows-31j
                               ISO-2022-JP
                               ISO-2022-KR
                               ISO-8859-1
                               ISO-8859-2
                               ISO-8859-3
                               ISO-8859-4
                               ISO-8859-5
                               ISO-8859-6
                               ISO-8859-7
                               ISO-8859-8
                               ISO-8859-9
                               ISO-8859-13
                               ISO-8859-15
                               KOI8-R
                               UTF-8
                               UTF-16
                               UTF-16BE
                               UTF-16LE
                               EUC-JP
                               Shift_JIS
                               CP932
                               GB18030
                               GBK
                               ISCII91
                               EUC-KR
                               Big5
                               Big5-HKSCS
                               TIS-620)
               cattr_accessor :available_settings
               self.available_settings ||= {}
               validates_uniqueness_of :name, :if => Proc.new {|setting| setting.new_record? || setting.name_changed?}
               validates_inclusion_of :name, :in => Proc.new {available_settings.keys}
               validates_numericality_of :value, :only_integer => true, :if => Proc.new { |setting|
                 (s = available_settings[setting.name]) && s['format'] == 'int'
               }
               attr_protected :id
               # Hash used to cache setting values
               @cached_settings = {}
               @cached_cleared_on = Time.now
               def value
                 v = read_attribute(:value)
                 # Unserialize serialized settings
                 if available_settings[name]['serialized'] && v.is_a?(String)
                   v = YAML::load(v)
                   v = force_utf8_strings(v)
                 end
                 v = v.to_sym if available_settings[name]['format'] == 'symbol' && !v.blank?
                 v
               end
               def value=(v)
                 v = v.to_yaml if v && available_settings[name] && available_settings[name]['serialized']
                 write_attribute(:value, v.to_s)
               end
               # Returns the value of the setting named name
               def self.[](name)
                 v = @cached_settings[name]
                 v ? v : (@cached_settings[name] = find_or_default(name).value)
               end
               def self.[]=(name, v)
                 setting = find_or_default(name)
                 setting.value = (v ? v : "")
                 @cached_settings[name] = nil
                 setting.save
                 setting.value
               end
             	# Updates multiple settings from params and sends a security notification if needed
               def self.set_all_from_params(settings)
-                settings = (settings || {}).dup.symbolize_keys
+                return false unless settings.is_a?(Hash)
+                settings = settings.dup.symbolize_keys
                 changes = []
                 settings.each do |name, value|
+                  next unless available_settings[name.to_s]
                   previous_value = Setting[name]
                   set_from_params name, value
                   if available_settings[name.to_s]['security_notifications'] && Setting[name] != previous_value
                     changes << name
                   end
                 end
                 if changes.any?
                   Mailer.security_settings_updated(changes)
                 end
                 true
               end
               # Sets a setting value from params
               def self.set_from_params(name, params)
                 params = params.dup
                 params.delete_if {|v| v.blank? } if params.is_a?(Array)
                 params.symbolize_keys! if params.is_a?(Hash)
                 m = "#{name}_from_params"
                 if respond_to? m
                   self[name.to_sym] = send m, params
                 else
                   self[name.to_sym] = params
                 end
               end
               # Returns a hash suitable for commit_update_keywords setting
               #
               # Example:
               # params = {:keywords => ['fixes', 'closes'], :status_id => ["3", "5"], :done_ratio => ["", "100"]}
               # Setting.commit_update_keywords_from_params(params)
               # # => [{'keywords => 'fixes', 'status_id' => "3"}, {'keywords => 'closes', 'status_id' => "5", 'done_ratio' => "100"}]
               def self.commit_update_keywords_from_params(params)
                 s = []
                 if params.is_a?(Hash) && params.key?(:keywords) && params.values.all? {|v| v.is_a? Array}
                   attributes = params.except(:keywords).keys
                   params[:keywords].each_with_index do |keywords, i|
                     next if keywords.blank?
                     s << attributes.inject({}) {|h, a|
                       value = params[a][i].to_s
                       h[a.to_s] = value if value.present?
                       h
                     }.merge('keywords' => keywords)
                   end
                 end
                 s
               end
               # Helper that returns an array based on per_page_options setting
               def self.per_page_options_array
                 per_page_options.split(%r{[\s,]}).collect(&:to_i).select {|n| n > 0}.sort
               end
               # Helper that returns a Hash with single update keywords as keys
               def self.commit_update_keywords_array
                 a = []
                 if commit_update_keywords.is_a?(Array)
                   commit_update_keywords.each do |rule|
                     next unless rule.is_a?(Hash)
                     rule = rule.dup
                     rule.delete_if {|k, v| v.blank?}
                     keywords = rule['keywords'].to_s.downcase.split(",").map(&:strip).reject(&:blank?)
                     next if keywords.empty?
                     a << rule.merge('keywords' => keywords)
                   end
                 end
                 a
               end
               def self.openid?
                 Object.const_defined?(:OpenID) && self[:openid].to_i > 0
               end
               # Checks if settings have changed since the values were read
               # and clears the cache hash if it's the case
               # Called once per request
               def self.check_cache
                 settings_updated_on = Setting.maximum(:updated_on)
                 if settings_updated_on && @cached_cleared_on <= settings_updated_on
                   clear_cache
                 end
               end
               # Clears the settings cache
               def self.clear_cache
                 @cached_settings.clear
                 @cached_cleared_on = Time.now
                 logger.info "Settings cache cleared." if logger
               end
               def self.define_plugin_setting(plugin)
                 if plugin.settings
                   name = "plugin_#{plugin.id}"
                   define_setting name, {'default' => plugin.settings[:default], 'serialized' => true}
                 end
               end
               # Defines getter and setter for each setting
               # Then setting values can be read using: Setting.some_setting_name
               # or set using Setting.some_setting_name = "some value"
               def self.define_setting(name, options={})
                 available_settings[name.to_s] = options
                 src = <<-END_SRC
                 def self.#{name}
                   self[:#{name}]
                 end
                 def self.#{name}?
                   self[:#{name}].to_i > 0
                 end
                 def self.#{name}=(value)
                   self[:#{name}] = value
                 end
             END_SRC
                 class_eval src, __FILE__, __LINE__
               end
               def self.load_available_settings
                 YAML::load(File.open("#{Rails.root}/config/settings.yml")).each do |name, options|
                   define_setting name, options
                 end
               end
               def self.load_plugin_settings
                 Redmine::Plugin.all.each do |plugin|
                   define_plugin_setting(plugin)
                 end
               end
               load_available_settings
               load_plugin_settings
             private
               def force_utf8_strings(arg)
                 if arg.is_a?(String)
                   arg.dup.force_encoding('UTF-8')
                 elsif arg.is_a?(Array)
                   arg.map do |a|
                     force_utf8_strings(a)
                   end
                 elsif arg.is_a?(Hash)
                   arg = arg.dup
                   arg.each do |k,v|
                     arg[k] = force_utf8_strings(v)
                   end
                   arg
                 else
                   arg
                 end
               end
               # Returns the Setting instance for the setting named name
               # (record found in database or new record with default value)
               def self.find_or_default(name)
                 name = name.to_s
                 raise "There's no setting named #{name}" unless available_settings.has_key?(name)
                 setting = where(:name => name).order(:id => :desc).first
                 unless setting
                   setting = new
                   setting.name = name
                   setting.value = available_settings[name]['default']
                 end
                 setting
               end
             end

test/functional/settings_controller_test.rb +9 0

             # Redmine - project management software
             # Copyright (C) 2006-2016  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.expand_path('../../test_helper', __FILE__)
             class SettingsControllerTest < Redmine::ControllerTest
               fixtures :projects, :trackers, :issue_statuses, :issues,
                        :users
               def setup
                 User.current = nil
                 @request.session[:user_id] = 1 # admin
               end
               def teardown
                 Setting.delete_all
                 Setting.clear_cache
               end
               def test_index
                 get :index
                 assert_response :success
                 assert_select 'input[name=?][value=?]', 'settings[app_title]', Setting.app_title
               end
               def test_get_edit
                 get :edit
                 assert_response :success
                 assert_select 'input[name=?][value=""]', 'settings[enabled_scm][]'
               end
               def test_get_edit_should_preselect_default_issue_list_columns
                 with_settings :issue_list_default_columns => %w(tracker subject status updated_on) do
                   get :edit
                   assert_response :success
                 end
                 assert_select 'select[id=selected_columns][name=?]', 'settings[issue_list_default_columns][]' do
                   assert_select 'option', 4
                   assert_select 'option[value=tracker]', :text => 'Tracker'
                   assert_select 'option[value=subject]', :text => 'Subject'
                   assert_select 'option[value=status]', :text => 'Status'
                   assert_select 'option[value=updated_on]', :text => 'Updated'
                 end
                 assert_select 'select[id=available_columns]' do
                   assert_select 'option[value=tracker]', 0
                   assert_select 'option[value=priority]', :text => 'Priority'
                 end
               end
               def test_get_edit_without_trackers_should_succeed
                 Tracker.delete_all
                 get :edit
                 assert_response :success
               end
               def test_post_edit_notifications
                 post :edit, :params => {
                   :settings => {
                     :mail_from => 'functional@test.foo',
                     :bcc_recipients  => '0',
                     :notified_events => %w(issue_added issue_updated news_added),
                     :emails_footer => 'Test footer'
                   }
                 }
                 assert_redirected_to '/settings'
                 assert_equal 'functional@test.foo', Setting.mail_from
                 assert !Setting.bcc_recipients?
                 assert_equal %w(issue_added issue_updated news_added), Setting.notified_events
                 assert_equal 'Test footer', Setting.emails_footer
               end
               def test_edit_commit_update_keywords
                 with_settings :commit_update_keywords => [
                   {"keywords" => "fixes, resolves", "status_id" => "3"},
                   {"keywords" => "closes", "status_id" => "5", "done_ratio" => "100", "if_tracker_id" => "2"}
                 ] do
                   get :edit
                 end
                 assert_response :success
                 assert_select 'tr.commit-keywords', 2
                 assert_select 'tr.commit-keywords:nth-child(1)' do
                   assert_select 'input[name=?][value=?]', 'settings[commit_update_keywords][keywords][]', 'fixes, resolves'
                   assert_select 'select[name=?]', 'settings[commit_update_keywords][status_id][]' do
                     assert_select 'option[value="3"][selected=selected]'
                   end
                 end
                 assert_select 'tr.commit-keywords:nth-child(2)' do
                   assert_select 'input[name=?][value=?]', 'settings[commit_update_keywords][keywords][]', 'closes'
                   assert_select 'select[name=?]', 'settings[commit_update_keywords][status_id][]' do
                     assert_select 'option[value="5"][selected=selected]', :text => 'Closed'
                   end
                   assert_select 'select[name=?]', 'settings[commit_update_keywords][done_ratio][]' do
                     assert_select 'option[value="100"][selected=selected]', :text => '100 %'
                   end
                   assert_select 'select[name=?]', 'settings[commit_update_keywords][if_tracker_id][]' do
                     assert_select 'option[value="2"][selected=selected]', :text => 'Feature request'
                   end
                 end
               end
               def test_edit_without_commit_update_keywords_should_show_blank_line
                 with_settings :commit_update_keywords => [] do
                   get :edit
                 end
                 assert_response :success
                 assert_select 'tr.commit-keywords', 1 do
                   assert_select 'input[name=?]:not([value])', 'settings[commit_update_keywords][keywords][]'
                 end
               end
               def test_post_edit_commit_update_keywords
                 post :edit, :params => {
                   :settings => {
                     :commit_update_keywords => {
                       :keywords => ["resolves", "closes"],
                       :status_id => ["3", "5"],
                       :done_ratio => ["", "100"],
                       :if_tracker_id => ["", "2"]
                     }
                   }
                 }
                 assert_redirected_to '/settings'
                 assert_equal([
                   {"keywords" => "resolves", "status_id" => "3"},
                   {"keywords" => "closes", "status_id" => "5", "done_ratio" => "100", "if_tracker_id" => "2"}
                 ], Setting.commit_update_keywords)
               end
+              def test_post_edit_with_invalid_setting_should_not_error
+                post :edit, :params => {
+                  :settings => {
+                    :invalid_setting => '1'
+                  }
+                }
+                assert_redirected_to '/settings'
+              end
               def test_post_edit_should_send_security_notification_for_notified_settings
                 ActionMailer::Base.deliveries.clear
                 post :edit, :params => {
                   :settings => {
                     :login_required => 1
                   }
                 }
                 assert_not_nil (mail = ActionMailer::Base.deliveries.last)
                 assert_mail_body_match '0.0.0.0', mail
                 assert_mail_body_match I18n.t(:setting_login_required), mail
                 assert_select_email do
                   assert_select 'a[href^=?]', 'http://localhost:3000/settings'
                 end
                 # All admins should receive this
                 recipients = [mail.bcc, mail.cc].flatten
                 User.active.where(admin: true).each do |admin|
                   assert_include admin.mail, recipients
                 end
               end
               def test_post_edit_should_not_send_security_notification_for_non_notified_settings
                 ActionMailer::Base.deliveries.clear
                 post :edit, :params => {
                   :settings => {
                     :app_title => 'MineRed'
                   }
                 }
                 assert_nil (mail = ActionMailer::Base.deliveries.last)
               end
               def test_post_edit_should_not_send_security_notification_for_unchanged_settings
                 ActionMailer::Base.deliveries.clear
                 post :edit, :params => {
                   :settings => {
                     :login_required => 0
                   }
                 }
                 assert_nil (mail = ActionMailer::Base.deliveries.last)
               end
               def test_get_plugin_settings
                 ActionController::Base.append_view_path(File.join(Rails.root, "test/fixtures/plugins"))
                 Redmine::Plugin.register :foo do
                   settings :partial => "foo_plugin/foo_plugin_settings"
                 end
                 Setting.plugin_foo = {'sample_setting' => 'Plugin setting value'}
                 get :plugin, :params => {:id => 'foo'}
                 assert_response :success
                 assert_select 'form[action="/settings/plugin/foo"]' do
                   assert_select 'input[name=?][value=?]', 'settings[sample_setting]', 'Plugin setting value'
                 end
               ensure
                 Redmine::Plugin.unregister(:foo)
               end
               def test_get_invalid_plugin_settings
                 get :plugin, :params => {:id => 'none'}
                 assert_response 404
               end
               def test_get_non_configurable_plugin_settings
                 Redmine::Plugin.register(:foo) {}
                 get :plugin, :params => {:id => 'foo'}
                 assert_response 404
               ensure
                 Redmine::Plugin.unregister(:foo)
               end
               def test_post_plugin_settings
                 Redmine::Plugin.register(:foo) do
                   settings :partial => 'not blank', # so that configurable? is true
                     :default => {'sample_setting' => 'Plugin setting value'}
                 end
                 post :plugin, :params => {
                   :id => 'foo',
                   :settings => {'sample_setting' => 'Value'}
                 }
                 assert_redirected_to '/settings/plugin/foo'
                 assert_equal({'sample_setting' => 'Value'}, Setting.plugin_foo)
               end
               def test_post_non_configurable_plugin_settings
                 Redmine::Plugin.register(:foo) {}
                 post :plugin, :params => {
                   :id => 'foo',
                   :settings => {'sample_setting' => 'Value'}
                 }
                 assert_response 404
               ensure
                 Redmine::Plugin.unregister(:foo)
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages