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