Chris@1494: # Redmine - project management software Chris@1494: # Copyright (C) 2006-2014 Jean-Philippe Lang Chris@1494: # Chris@1494: # This program is free software; you can redistribute it and/or Chris@1494: # modify it under the terms of the GNU General Public License Chris@1494: # as published by the Free Software Foundation; either version 2 Chris@1494: # of the License, or (at your option) any later version. Chris@1494: # Chris@1494: # This program is distributed in the hope that it will be useful, Chris@1494: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@1494: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@1494: # GNU General Public License for more details. Chris@1494: # Chris@1494: # You should have received a copy of the GNU General Public License Chris@1494: # along with this program; if not, write to the Free Software Chris@1494: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@1494: Chris@1494: module Redmine Chris@1494: module SafeAttributes Chris@1494: def self.included(base) Chris@1494: base.extend(ClassMethods) Chris@1494: end Chris@1494: Chris@1494: module ClassMethods Chris@1494: # Declares safe attributes Chris@1494: # An optional Proc can be given for conditional inclusion Chris@1494: # Chris@1494: # Example: Chris@1494: # safe_attributes 'title', 'pages' Chris@1494: # safe_attributes 'isbn', :if => {|book, user| book.author == user} Chris@1494: def safe_attributes(*args) Chris@1494: @safe_attributes ||= [] Chris@1494: if args.empty? Chris@1494: if superclass.include?(Redmine::SafeAttributes) Chris@1494: @safe_attributes + superclass.safe_attributes Chris@1494: else Chris@1494: @safe_attributes Chris@1494: end Chris@1494: else Chris@1494: options = args.last.is_a?(Hash) ? args.pop : {} Chris@1494: @safe_attributes << [args, options] Chris@1494: end Chris@1494: end Chris@1494: end Chris@1494: Chris@1494: # Returns an array that can be safely set by user or current user Chris@1494: # Chris@1494: # Example: Chris@1494: # book.safe_attributes # => ['title', 'pages'] Chris@1494: # book.safe_attributes(book.author) # => ['title', 'pages', 'isbn'] Chris@1494: def safe_attribute_names(user=nil) Chris@1494: return @safe_attribute_names if @safe_attribute_names && user.nil? Chris@1494: names = [] Chris@1494: self.class.safe_attributes.collect do |attrs, options| Chris@1494: if options[:if].nil? || options[:if].call(self, user || User.current) Chris@1494: names += attrs.collect(&:to_s) Chris@1494: end Chris@1494: end Chris@1494: names.uniq! Chris@1494: @safe_attribute_names = names if user.nil? Chris@1494: names Chris@1494: end Chris@1494: Chris@1494: # Returns true if attr can be set by user or the current user Chris@1494: def safe_attribute?(attr, user=nil) Chris@1494: safe_attribute_names(user).include?(attr.to_s) Chris@1494: end Chris@1494: Chris@1494: # Returns a hash with unsafe attributes removed Chris@1494: # from the given attrs hash Chris@1494: # Chris@1494: # Example: Chris@1494: # book.delete_unsafe_attributes({'title' => 'My book', 'foo' => 'bar'}) Chris@1494: # # => {'title' => 'My book'} Chris@1494: def delete_unsafe_attributes(attrs, user=User.current) Chris@1494: safe = safe_attribute_names(user) Chris@1494: attrs.dup.delete_if {|k,v| !safe.include?(k)} Chris@1494: end Chris@1494: Chris@1494: # Sets attributes from attrs that are safe Chris@1494: # attrs is a Hash with string keys Chris@1494: def safe_attributes=(attrs, user=User.current) Chris@1494: return unless attrs.is_a?(Hash) Chris@1494: self.attributes = delete_unsafe_attributes(attrs, user) Chris@1494: end Chris@1494: end Chris@1494: end