caterpillar 1.4.4 → 1.6.0

data/lib/caterpillar/helpers/portlet.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+#--
+# Copyright (c) 2010 Mikael Lammmentausta, Tulio Ornelas dos Santos
+#
+# See the file MIT-LICENSE included with the distribution for
+# software license details.
+#++
+
+require 'rubygems'
+require 'action_controller'
+
+module Caterpillar # :nodoc:
+module Helpers # :nodoc:
+  module Portlet
+
+    # Get portlet namespace from cookie set by rails-portlet
+    def namespace_cookie
+      cookies[:Portlet_namespace]
+    end
+
+    # Set instance variable @namespace
+    def get_namespace
+      @namespace = namespace_cookie
+    end
+
+    # Send the rendered page in a file to serveResource method
+    #
+    def ajax_response params = {}
+      if params[:template]
+        content = render_to_string :template => params[:template]
+      else
+        content = render_to_string
+      end
+
+      send_data resposta, :type => 'text/html', :filename => "content_#{request.session_options[:id]}.html"
+    end
+
+  end
+end
+end
+  

data/lib/caterpillar/liferay.rb

@@ -60,10 +60,9 @@ module Caterpillar # :nodoc:
     attr_writer   :deploy_dir
 
     # Liferay version is given as a String, eg. '5.2.2'.
-    # Defaults to +Lportal::Schema.version+.
     def initialize(version=nil)
-      @version    = version || '5.2.3'
-      @root       = '/usr/local/liferay-portal-5.2.3/tomcat-6.0.18' # as described in setup guide, when unpacked to /usr/local
+      @version    = version || '6.0.6'
+      @root       = '/usr/local/liferay-portal-6.0.6/tomcat-6.0.29'
       @server     = 'Tomcat'
       @deploy_dir = nil
     end

data/lib/caterpillar/navigation.rb

@@ -1,9 +1,7 @@
 # encoding: utf-8
-
-
 #--
 # (c) Copyright 2008,2009 Mikael Lammentausta
-# See the file LICENSES.txt included with the distribution for
+# See the file MIT-LICENSE included with the distribution for
 # software license details.
 #++
 
@@ -44,4 +42,4 @@ module Caterpillar # :nodoc:
     end
 
   end
-end
+end

data/lib/caterpillar/parser.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #--
 # (c) Copyright 2008 Mikael Lammentausta
-# See the file LICENSES.txt included with the distribution for
+# See the file MIT-LICENSE included with the distribution for
 # software license details.
 #++
 
@@ -121,11 +121,7 @@ module Caterpillar
         ### unless defined, use default javascripts
         portlet[:javascripts] ||= @config.javascripts
 
-        # fix path variables to be replaced by rails-portlet at runtime
         path = portlet[:path]
-        path.gsub!(/:uid/,'%UID%')
-        path.gsub!(/:gid/,'%GID%')
-        # TODO: notify user of unsupported variables
         portlet.update( :path => path )
       end
 

data/lib/caterpillar/portlet.rb

@@ -2,7 +2,7 @@
 #--
 # (c) Copyright 2008, 2010 Mikael Lammentausta
 #                     2010 Tulio Ornelas
-# See the file LICENSES.txt included with the distribution for
+# See the file MIT-LICENSE included with the distribution for
 # software license details.
 #++
           
@@ -32,8 +32,9 @@ module Caterpillar
     # Creates <portlet-app> XML document for portlet-ext.xml.
     #
     # @param portlets is an Array of Hashes
+    # @param session_secret is a generated String that authorizes requests from portlet clients
     # @returns String
-    def xml(portlets)
+    def xml(portlets, session_secret=nil)
       # create a new XML document
       doc = REXML::Document.new
       doc << REXML::XMLDecl.new('1.0', 'utf-8') 
@@ -43,22 +44,22 @@ module Caterpillar
       app.attributes['xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance'
       app.attributes['xsi:schemaLocation'] = 'http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd'
 
-      # create session values, common for all portlets
-      session = 
-        begin
-          {
-            :key    => Caterpillar::Security.get_session_key(),
-            :secret => Caterpillar::Security.get_secret()
-          }
-        rescue
-          nil
-        end
+      unless session_secret
+        STDERR.puts %{WARNING: shared session secret not found from portlets.rb config.
+This feature was added in version 2.0.0. Please update your config file:
+
+  portlet.session_secret = {
+    :key    => '_rails_portlet',
+    :secret => '%s'
+  }
+        } % Security::random_secret
+      end
 
       # create XML element tree
       # (in proper order so the validation passes)
       portlets.each do |portlet|
         # <portlet>
-        app.elements << self.portlet_element(portlet, session, app)
+        app.elements << self.portlet_element(portlet, session_secret, app)
       end
       portlets.each do |portlet|
         # <filter>
@@ -72,23 +73,23 @@ module Caterpillar
     end
 
     # <portlet> element.
-    # session is a hash containing session key and secret from Rails.
-    def portlet_element(portlet, session = nil, app = nil)            
+    # session_secret is a hash containing session key and secret.
+    def portlet_element(portlet, session_secret = nil, app = nil)
       element = REXML::Element.new('portlet')
       # NOTE: to pass validation, the elements need to be in proper order!
                                                               
       REXML::Element.new('portlet-name', element).text = portlet[:name]
       REXML::Element.new('portlet-class', element).text = self.portlet_class
 
-      # insert session key
-      unless session.nil?
+      # insert shared secret
+      unless session_secret.nil?
         param = REXML::Element.new('init-param', element)
         REXML::Element.new('name', param).text = 'session_key'
-        REXML::Element.new('value', param).text = session[:key]
+        REXML::Element.new('value', param).text = session_secret[:key]
 
         param = REXML::Element.new('init-param', element)
         REXML::Element.new('name', param).text = 'secret'
-        REXML::Element.new('value', param).text = session[:secret]
+        REXML::Element.new('value', param).text = session_secret[:secret]
       end
 
       supports = REXML::Element.new('supports', element)

data/lib/caterpillar/portlet_support.rb

@@ -1,29 +1,16 @@
 # encoding: utf-8
+#--
+# Copyright (c) 2010 Tulio Ornelas dos Santos
+#
+# See the file MIT-LICENSE included with the distribution for
+# software license details.
+#++
 
 module Caterpillar
   
-  # Add some portlet support
+  # Add some portlet support (DEPRECATED)
   #
   module PortletSupport
-  
-    # Gets portlet preferences from a cookie (Liferay_preferences) and generates
-    # a hash with it. Returns nil if cookie do not exists or the value is nil.
-    #
-    def get_liferay_preferences(value = cookies[:Liferay_preferences])
-      preferences = {}
-      if value and (not value.empty?)
-        value.split(";").each do |pair|
-          if pair.nil? or pair.empty? then next end
-      
-          result = pair.split("=")
-          preferences[result[0].intern] = result[1]
-        
-        end
-        return preferences
-      end
-  
-      nil
-    end
-
+    #include Caterpillar::Helpers::Liferay
   end
-end
+end

data/lib/caterpillar/security.rb

@@ -1,8 +1,6 @@
 # encoding: utf-8
-
-
 #--
-# (c) Copyright 2010 Mikael Lammentausta
+# (c) Copyright 2010 - 2011 Mikael Lammentausta
 #
 # See the file MIT-LICENSE included with the distribution for
 # software license details.
@@ -30,10 +28,18 @@ module Caterpillar # :nodoc:
       base.extend(ClassMethods)
     end
     
+    def self.random_secret(len=64)
+      chars = ('a'..'z').to_a + ('A'..'Z').to_a + (0..9).to_a
+      (0...len).collect { chars[Kernel.rand(chars.length)] }.join
+    end
+    
     module ClassMethods # :nodoc:
+      # Inserts a before_filter that verifies user agent and checks the shared secret.
+      # Pass options for before_filter (eg. :only => [:secured_action])
       def secure_portlet_sessions(options = {})
         class_eval <<-EOV
           include Caterpillar::Security::InstanceMethods
+          before_filter [:authorize_agent, :authorize_request], options
         EOV
       end
     end
@@ -65,7 +71,12 @@ module Caterpillar # :nodoc:
       # check the user agent
       agent = request.env['HTTP_USER_AGENT']
       unless agent=='Jakarta Commons-HttpClient/3.1'
-        logger.warn 'Someone from IP %s may be spoofing using agent %s' % [request.env['REMOTE_ADDR'], agent]
+        addr = request.env['REMOTE_ADDR']
+        if addr[/^127/] and request.env['HTTP_X_FORWARDED_FOR']
+          # serving through virtualhost. obtain true IP addr.
+          addr = request.env['HTTP_X_FORWARDED_FOR']
+        end
+        logger.warn 'Someone from IP %s may be spoofing using agent %s' % [addr, agent]
         render :nothing => true, :status => 404
       end
     end
@@ -77,7 +88,8 @@ module Caterpillar # :nodoc:
     #
     def authorize_request
       if !cookies.nil? and !cookies[:session_secret].nil?
-      	if cookies[:session_secret] == Caterpillar::Security.get_secret
+        config = Util.eval_configuration
+        if cookies[:session_secret] == config.session_secret[:secret]
           logger.debug "Passes security check"
           return true
         end
@@ -88,49 +100,15 @@ module Caterpillar # :nodoc:
     end
 
 
-    # Get the Liferay UID from cookie.
+    # MOVED to Caterpillar::Helpers::Liferay
     def get_liferay_uid
-      uid_key = 'Liferay_UID'
-      unless cookies.nil? or cookies[uid_key].nil?
-        @uid = cookies[uid_key]
-        logger.debug("Liferay UID %s" % @uid)
-      else
-        logger.debug("UID key is not present in cookies %s" % cookies.inspect)
-      end
+      logger.warn 'DEPRECATION WARNING: get_liferay_uid has been moved to Caterpillar::Helpers::Liferay'
+      Caterpillar::Helpers::Liferay.get_liferay_uid
     end
 
 
     end # module
 
 
-    # Return Rails' session key    
-    def self.get_session_key
-      # Rails before 2.3 had a different way
-      if defined?(RAILS_GEM_VERSION) and RAILS_GEM_VERSION.gsub('.','').to_i < 230
-        ActionController::Base.session_options_for(nil,nil)[:session_key]
-      # On Rails 2.3:
-      else
-        key = ActionController::Base.session_options[:key]
-        return key unless key.nil?
-        # try session_key
-        key = ActionController::Base.session_options[:session_key]
-        return key unless key.nil?
-        # XXX: Rails changed sometime during 2.3.8 ..
-        STDERR.puts 'Failed to read session key - consider this a bug'
-        return nil
-      end
-    end
-
-    # Return Rails' secret    
-    def self.get_secret
-      # Rails before 2.3 had a different way
-      if RAILS_GEM_VERSION.gsub('.','').to_i < 230
-        ActionController::Base.session_options_for(nil,nil)[:secret]
-      # On Rails 2.3:
-      else
-        ActionController::Base.session_options[:secret]
-      end
-    end
-
   end
 end

data/lib/caterpillar/task.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
 #--
-# (c) Copyright 2008,2009,2010 Mikael Lammentausta
+# (c) Copyright 2008 - 2011 Mikael Lammentausta
 #
 # Thanks to Nick Sieger for the rake structure!
 #
-# See the file LICENSES.txt included with the distribution for
+# See the file MIT-LICENSE included with the distribution for
 # software license details.
 #++
 
@@ -84,7 +84,7 @@ module Caterpillar
     end
 
     def define_usage_task
-      task :usage do
+      task :usage => :version do
         Usage.show
       end
     end
@@ -217,12 +217,13 @@ module Caterpillar
           raise 'Rails environment could not be loaded'
         end
         if @config.container.is_a?(Caterpillar::Liferay)
-          if @config.container.version.nil? and !defined?(Lportal)
-            $stderr.puts 'Liferay version is undefined, and lportal gem is not present.'
-            $stderr.puts 'Please define portlet.container.version in %s.' % @config.class::FILE
-            raise 'Insufficient configuration'
-          end
-          @config.container.version ||= Lportal::Schema.version
+          # since Caterpillar version 1.6.0, Liferay version is not required
+          #if @config.container.version.nil? and !defined?(Lportal)
+          #  $stderr.puts 'Liferay version is undefined, and lportal gem is not present.'
+          #  $stderr.puts 'Please define portlet.container.version in %s.' % @config.class::FILE
+          #  raise 'Insufficient configuration'
+          #end
+          #@config.container.version ||= Lportal::Schema.version
           portal_info
         end
       end
@@ -253,7 +254,7 @@ module Caterpillar
 
           FileUtils.touch(file)
           f=File.open(file,'w')
-          f.write Portlet.xml(@portlets)
+          f.write Portlet.xml(@portlets,@config.session_secret)
           f.close
           #info '-> %s' % file
         end
@@ -362,31 +363,12 @@ module Caterpillar
       with_namespace_and_config do |name, config|
         desc 'Installs Rails-portlet JAR into the portlet container'
         task :install => :environment do
-          source = File.join(CATERPILLAR_LIBS,'java')
-
-          # detect (Liferay) container version
-          container_v = @config.container.version
-          unless container_v
-            info 'Unable to detect the version of the portlet container. Installing the latest version.'
-          end
 
-          # detect the version of the JAR to install
-          portlet_jar = nil
-          # XXX: since the filter name has changed, the old JAR does not work
-          #version = (
-          #  if container_v and container_v[/^5.1/]
-          #    '0.6.0' # FIXME: branch properly
-          #  else
-          #    '0.10.0'
-          #  end
-          #)
-          version = '0.10.1'
-          require 'find'
-          Find.find(source) do |file|
-            if File.basename(file) == "rails-portlet-#{version}.jar"
-              portlet_jar = file
-            end
-          end
+          # since rails-portlet jar version 0.12, Liferay5 and Liferay6 both work
+          # with the same version. version detection is unneeded.
+          # container_v = @config.container.version
+          version = '0.12.0'
+          portlet_jar = File.join(CATERPILLAR_LIBS,'java',"rails-portlet-#{version}.jar")
 
           # check if requirements match
           unless deployment_requirements_met?
@@ -672,10 +654,9 @@ module Caterpillar
     end
 
     def portal_info(config=@config)
-      msg = 'Caterpillar %s configured for %s version %s at %s' % [
+      msg = 'Caterpillar %s configured for %s at %s' % [
         Caterpillar::VERSION,
         config.container.name,
-        config.container.version,
         config.container.root
       ]
       info(msg)

data/lib/caterpillar/usage.rb

@@ -1,21 +1,25 @@
 # encoding: utf-8
-
-
 #--
-# (c) Copyright 2008 Mikael Lammentausta
-# See the file LICENSES.txt included with the distribution for
+# (c) Copyright 2008, 2010 Mikael Lammentausta
+# See the file MIT-LICENSE included with the distribution for
 # software license details.
 #++
 
 module Caterpillar
   class Usage
     def self.show
-      STDOUT.puts 'Usage:'
-      STDOUT.puts '  See "%s --describe" for an overview of the tasks.' % $0
-      STDOUT.puts       
-      STDOUT.puts 'How to start up a new rails-portlet project?'
-      STDOUT.puts '  caterpillar rails project_name'
-      STDOUT.puts
+      STDOUT.puts %{
+Usage:
+  caterpillar --describe # gives you an overview of the tasks
+
+For more information on usage in your Rails-portlet project,
+see the README in the gem or at http://github.com/lamikae/caterpillar
+      }
+# XXX: write better usage for stdout
+=begin
+To start up a new JRuby Rails-portlet project:
+  caterpillar rails project_name
+=end
     end
   end
 end