annotate .svn/pristine/f1/f19d4abffaa039e231b9a74b52069c378c5f3697.svn-base @ 1327:287f201c2802 redmine-2.2-integration

Add italic
author Chris Cannam <chris.cannam@soundsoftware.ac.uk>
date Wed, 19 Jun 2013 20:56:22 +0100
parents 038ba2d95de8
children
rev   line source
Chris@1296 1 # Redmine - project management software
Chris@1296 2 # Copyright (C) 2006-2012 Jean-Philippe Lang
Chris@1296 3 #
Chris@1296 4 # This program is free software; you can redistribute it and/or
Chris@1296 5 # modify it under the terms of the GNU General Public License
Chris@1296 6 # as published by the Free Software Foundation; either version 2
Chris@1296 7 # of the License, or (at your option) any later version.
Chris@1296 8 #
Chris@1296 9 # This program is distributed in the hope that it will be useful,
Chris@1296 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1296 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@1296 12 # GNU General Public License for more details.
Chris@1296 13 #
Chris@1296 14 # You should have received a copy of the GNU General Public License
Chris@1296 15 # along with this program; if not, write to the Free Software
Chris@1296 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@1296 17
Chris@1296 18 module Redmine
Chris@1296 19 module SafeAttributes
Chris@1296 20 def self.included(base)
Chris@1296 21 base.extend(ClassMethods)
Chris@1296 22 end
Chris@1296 23
Chris@1296 24 module ClassMethods
Chris@1296 25 # Declares safe attributes
Chris@1296 26 # An optional Proc can be given for conditional inclusion
Chris@1296 27 #
Chris@1296 28 # Example:
Chris@1296 29 # safe_attributes 'title', 'pages'
Chris@1296 30 # safe_attributes 'isbn', :if => {|book, user| book.author == user}
Chris@1296 31 def safe_attributes(*args)
Chris@1296 32 @safe_attributes ||= []
Chris@1296 33 if args.empty?
Chris@1296 34 if superclass.include?(Redmine::SafeAttributes)
Chris@1296 35 @safe_attributes + superclass.safe_attributes
Chris@1296 36 else
Chris@1296 37 @safe_attributes
Chris@1296 38 end
Chris@1296 39 else
Chris@1296 40 options = args.last.is_a?(Hash) ? args.pop : {}
Chris@1296 41 @safe_attributes << [args, options]
Chris@1296 42 end
Chris@1296 43 end
Chris@1296 44 end
Chris@1296 45
Chris@1296 46 # Returns an array that can be safely set by user or current user
Chris@1296 47 #
Chris@1296 48 # Example:
Chris@1296 49 # book.safe_attributes # => ['title', 'pages']
Chris@1296 50 # book.safe_attributes(book.author) # => ['title', 'pages', 'isbn']
Chris@1296 51 def safe_attribute_names(user=nil)
Chris@1296 52 return @safe_attribute_names if @safe_attribute_names && user.nil?
Chris@1296 53 names = []
Chris@1296 54 self.class.safe_attributes.collect do |attrs, options|
Chris@1296 55 if options[:if].nil? || options[:if].call(self, user || User.current)
Chris@1296 56 names += attrs.collect(&:to_s)
Chris@1296 57 end
Chris@1296 58 end
Chris@1296 59 names.uniq!
Chris@1296 60 @safe_attribute_names = names if user.nil?
Chris@1296 61 names
Chris@1296 62 end
Chris@1296 63
Chris@1296 64 # Returns true if attr can be set by user or the current user
Chris@1296 65 def safe_attribute?(attr, user=nil)
Chris@1296 66 safe_attribute_names(user).include?(attr.to_s)
Chris@1296 67 end
Chris@1296 68
Chris@1296 69 # Returns a hash with unsafe attributes removed
Chris@1296 70 # from the given attrs hash
Chris@1296 71 #
Chris@1296 72 # Example:
Chris@1296 73 # book.delete_unsafe_attributes({'title' => 'My book', 'foo' => 'bar'})
Chris@1296 74 # # => {'title' => 'My book'}
Chris@1296 75 def delete_unsafe_attributes(attrs, user=User.current)
Chris@1296 76 safe = safe_attribute_names(user)
Chris@1296 77 attrs.dup.delete_if {|k,v| !safe.include?(k)}
Chris@1296 78 end
Chris@1296 79
Chris@1296 80 # Sets attributes from attrs that are safe
Chris@1296 81 # attrs is a Hash with string keys
Chris@1296 82 def safe_attributes=(attrs, user=User.current)
Chris@1296 83 return unless attrs.is_a?(Hash)
Chris@1296 84 self.attributes = delete_unsafe_attributes(attrs, user)
Chris@1296 85 end
Chris@1296 86 end
Chris@1296 87 end