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