vendor/plugins/ssl_requirement/lib/ssl_requirement.rb

   1 # Copyright (c) 2005 David Heinemeier Hansson
   2 #
   3 # Permission is hereby granted, free of charge, to any person obtaining
   4 # a copy of this software and associated documentation files (the
   5 # "Software"), to deal in the Software without restriction, including
   6 # without limitation the rights to use, copy, modify, merge, publish,
   7 # distribute, sublicense, and/or sell copies of the Software, and to
   8 # permit persons to whom the Software is furnished to do so, subject to
   9 # the following conditions:
  10 #
  11 # The above copyright notice and this permission notice shall be
  12 # included in all copies or substantial portions of the Software.
  13 #
  14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  18 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  19 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  20 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21 module SslRequirement
  22   def self.included(controller)
  23     controller.extend(ClassMethods)
  24     controller.before_filter(:ensure_proper_protocol)
  25   end
  26
  27   module ClassMethods
  28     # Specifies that the named actions requires an SSL connection to be performed (which is enforced by ensure_proper_protocol).
  29     def ssl_required(*actions)
  30       write_inheritable_array(:ssl_required_actions, actions)
  31     end
  32
  33     def ssl_allowed(*actions)
  34       write_inheritable_array(:ssl_allowed_actions, actions)
  35     end
  36   end
  37
  38   protected
  39     # Returns true if the current action is supposed to run as SSL
  40     def ssl_required?
  41       (self.class.read_inheritable_attribute(:ssl_required_actions) || []).include?(action_name.to_sym)
  42     end
  43
  44     def ssl_allowed?
  45       (self.class.read_inheritable_attribute(:ssl_allowed_actions) || []).include?(action_name.to_sym)
  46     end
  47
  48   private
  49     def ensure_proper_protocol
  50       return true if ssl_allowed?
  51
  52       if ssl_required? && !request.ssl?
  53         redirect_to "https://" + request.host + request.request_uri
  54         flash.keep
  55         return false
  56       elsif request.ssl? && !ssl_required?
  57         redirect_to "http://" + request.host + request.request_uri
  58         flash.keep
  59         return false
  60       end
  61     end
  62 end