lportal 1.0.9 → 1.0.17

data/lib/web/typesettings.rb

@@ -3,6 +3,9 @@ module Web
   class Typesettings
 
     attr_accessor :template_id
+    
+    # accepts a Hash, where the key tells the column
+    # { 1 => [Web::PortletPreferences, ...], 2 => [...], ... }
     attr_accessor :portlets
 
     # Takes either existing raw typesettings string (to be parsed) or a Hash, when clean Typesettings is created.
@@ -15,7 +18,7 @@ module Web
       end
     end
 
-    # Parses raw typesettings String into internal format.
+    # Parses raw typesettings String into an object (self).
     def read(raw)
       _x = raw.split(/\n/)
       #puts _x.inspect
@@ -53,11 +56,11 @@ module Web
       return s
     end
 
-    # Accepts a PortletName as the first parameter,
+    # Accepts a PortletProperties as the first parameter,
     # the second parameter acceps a Hash {:column => nr} where nr is the column to place the portlet.
     def method_missing(method, *args, &block)
       begin
-        portlet = Web::PortletName.find_by_name(method.to_s)
+        portlet = Web::PortletProperties.find_by_name(method.to_s)
         return nil unless portlet
 
         column = 1
@@ -81,18 +84,40 @@ module Web
     def parse
       columns = []
       @portlets.each_pair do |column,portlets|
-        columns << "column-%i=%s," % [column, portlets.join(",")]
+        # handle several portlet types
+        portletids = []
+        portlets.each do |p|
+          next if p.nil?
+          if p.is_a?(String)
+            portletids << p
+          elsif (p.is_a?(Web::Portlet) or p.is_a?(Web::PortletPreferences))
+            portletids << p.portletid
+          else
+            raise 'Unknown portlet type %s' % p.class
+          end
+        end
+        columns << "column-%i=%s," % [column, portletids.join(",")]
       end
       columns.join("\n")
     end
 
     # Does this Typesettings include this portlet?
+    #
+    # This does not separate instantiated or non-instantiated portlets.
+    # Instantiated portlets do not theoretically match (TODO: test),
+    # as the portletid in the layout's typesettings contains the _INSTANCE_xxxx suffix.
+    #
+    #
     # Params:
-    #  - portlet (either name as String, or Web::PortletName)
+    #  - portlet (either name as String, or Web::PortletProperties)
     def include?(args)
       if args.is_a?(String)
-        p = Web::PortletName.find_by_name args
-      elsif args.is_a?(Web::PortletName)
+        p = Web::PortletProperties.find_by_name args
+      elsif args.is_a?(Web::PortletProperties)
+        p = args
+      elsif args.is_a?(Web::PortletPreferences)
+        p = args
+      elsif args.is_a?(Web::Portlet)
         p = args
       else
         raise 'Invalid input class: %s' % args.class

data/lportal.rb

@@ -4,10 +4,23 @@ require 'active_record'
 file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
 this_dir = File.dirname(File.expand_path(file))
 
-require this_dir+'/version'
+require File.join(this_dir,'version')
 
-# include all ruby files
-Find.find(this_dir+'/lib') do |file|
+# set the migrations directory for Caterpillar
+LPORTAL_MIGRATIONS=File.expand_path(
+  File.join(this_dir,'migrations')
+              )
+
+# make models able to act resourceful
+require File.join(this_dir,'lib','acts','resourceful')
+ActiveRecord::Base.class_eval { include Acts::Resourceful }
+
+# Define Liferay (asset viewer) portlets.
+# This class is for defining specific portlet functionality.
+require File.join(this_dir,'portlets')
+
+# include all models from lib
+Find.find(File.join(this_dir,'lib')) do |file|
   if FileTest.directory?(file)
     if File.basename(file) == "deprecated"
       Find.prune # Don't look any further into this directory.
@@ -18,3 +31,17 @@ Find.find(this_dir+'/lib') do |file|
     require file if file[/.rb$/]
   end
 end
+
+# define this database's schema version
+require File.join(this_dir,'schema')
+release = Release.current
+last_supported_release = 5201
+Lportal::Schema.buildnumber = (release ? release.buildnumber : last_supported_release)
+
+msg = 'Using Liferay schema build %i, version %s' % [
+  Lportal::Schema.buildnumber, Lportal::Schema.version]
+
+puts msg
+
+defined?(RAILS_DEFAULT_LOGGER) ?
+  RAILS_DEFAULT_LOGGER.info(msg) : STDOUT.puts(msg)

data/migrations/20090101000001_add_sequences.rb

@@ -0,0 +1,64 @@
+class AddSequences < ActiveRecord::Migration
+  @@tables = [
+    Account,
+    Address,
+    Announcement::Delivery,
+    Announcement::Entry,
+    Contact,
+    Group,
+    Permission,
+    Phone,
+    ResourceCode,
+    Resource,
+    Role,
+    User,
+    MB::Category,
+    MB::Discussion,
+    MB::Message,
+    MB::MessageFlag,
+    MB::StatsUser,
+    MB::Thread,
+    RatingsStats,
+    SocialActivity,
+    SocialRelation,
+    Tag::Asset,
+    Tag::Entry,
+    Tag::Property,
+    Web::Layout,
+    Web::LayoutSet,
+    Web::PortletPreferences,
+    Web::Portlet
+  ]
+
+  def self.up
+    STDOUT.puts 'This migration does not do anything.'
+    STDOUT.puts 'The process is not refined properly yet, and could be quite disastrous if reverted unappropriately.'
+    STDOUT.puts 'If you are sure you need the sequences, copy this file to db/migrate and modify it.'
+    STDOUT.puts __FILE__
+
+    start = 8400000 # bigint = 8^8 bytes = 16 million bits, this is halfway up the possible range, rounded up
+    sql = ""
+    @@tables.each do |model|
+      table = model.table_name
+      primkey = model.primary_key
+      seq = table+'_'+primkey+'_seq'
+      sql += "CREATE SEQUENCE #{seq} START #{start}; ALTER TABLE #{table} ALTER #{primkey} SET default nextval('#{seq}');"
+    end
+
+    # To activate, uncomment this line.
+    #ActiveRecord::Base.connection.execute(sql)
+  end
+
+  # This is VERY DANGEROUS and may lead to breakage.
+  def self.down
+    STDOUT.puts 'Nothing will happen.'
+    # sql = ""
+    # @@tables.each do |model|
+    #   table = model.table_name
+    #   primkey = model.primary_key
+    #   seq = table+'_'+primkey+'_seq'
+    #   sql += "ALTER TABLE #{table} ALTER #{primkey} DROP default; DROP SEQUENCE #{seq};"
+    # end
+    # ActiveRecord::Base.connection.execute(sql)
+  end
+end

data/migrations/20090309000001_portlet_properties.rb

@@ -0,0 +1,19 @@
+class PortletProperties < ActiveRecord::Migration
+  def self.up
+    # dealing with tables that have no id is a pain with ActiveRecord,
+    # and using the 'id' column for portletid does not work either,
+    # ActiveRecord does not let that column to be set manually.
+    create_table :portletproperties do |t|
+      t.column :portletid,    :string,  :null => false
+      t.column :name,         :string,  :null => false
+      t.column :title,        :string,  :null => false
+      t.column :instanceable, :boolean, :null => false, :default => true
+    end
+    ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS portlet_names")
+  end
+
+  def self.down
+    drop_table :portletproperties
+    #ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS portletproperties")
+  end
+end

data/portlets.rb

@@ -0,0 +1,76 @@
+module Lportal # :nodoc:
+  # Liferay portlet functionalities.
+  # These are accessable in Web::PortletPreferences.
+  #
+  # Adds +path+, that is based on the name of the portlet.
+  module Portlets
+    def self.included(base)
+      #base.extend(ClassMethods)
+    end
+
+    include ERB::Util # for u()
+
+    def redirect
+      u('javascript: history.go(-1)')
+    end
+
+    # params:
+    #   - content_id or asset
+    def asset_publisher_path(params)
+      asset = params[:asset]
+      raise 'No asset' unless asset
+      raise ('Asset %i has no resource' % asset.id) unless asset.resource
+      content_id = asset.resource.id
+      _path = [
+        '-',
+        'asset_publisher',
+        self.instance_id,
+        'content',
+        content_id
+      ].join('/')
+      '%s/%s?redirect=%s' % [self.layout.path, _path, redirect]
+    end
+
+    # params:
+    #   - asset_id
+    def tagged_content_path(params)
+      asset = params[:asset]
+      raise 'No asset' unless asset
+
+      params = "?p_p_id=#{portletid}"+\
+        "&p_p_lifecycle=0"+\
+        "&p_p_state=normal"+\
+        "&p_p_mode=view"+\
+        "&_#{portletid}_struts_action=%2Ftagged_content%2Fview_content"+\
+        "&_#{portletid}_assetId=#{asset.id}"+\
+        "&_#{portletid}_redirect=#{redirect}"
+        # &p_p_col_id=column-1&p_p_col_count=1
+      path = self.layout.path + params
+    end
+
+
+    # Meta method that calls the actual method that yields the path to the portlet instance.
+    # In essence this is a singleton method based on the name of the portlet.
+    def path(args={})
+      unless self.name
+        logger.warn '%s has no name' % self.class
+        return ''
+      end
+      unless self.layout
+        logger.warn 'No layout given'
+        return ''
+      end
+
+      logger.debug 'Generating path for portlet %s' % self.name
+      method = self.name+'_path'
+      if self.respond_to?(method)
+        return self.send(method, args)
+      else
+        # unknown path
+        logger.warn 'Unknown path requested for portlet %s' % self.name
+        return ''
+      end
+    end
+
+  end
+end

data/schema.rb

@@ -0,0 +1,34 @@
+module Lportal
+  # The schema version of the Liferay database.
+  # The +buildnumber+ class variable is set when lportal is loaded,
+  # and is a Fixnum of form 5201, for example.
+  # the +version+ method is a String of form '5.2.x'.
+  class Schema
+    @@BUILD = nil
+    @@VERSION = nil
+
+    def self.buildnumber
+      @@BUILD
+    end
+
+    # setter for buildnumber
+    def self.buildnumber=(val)
+      @@BUILD = val
+    end
+
+    def self.version
+      unless @@VERSION
+        return nil if @@BUILD.nil?
+        @@VERSION = '%s.%s.%d' % @@BUILD.to_s.scan(/(.)(.)(..)/).flatten
+      end
+      return @@VERSION
+    end
+
+    def self.version=(val)
+      @@VERSION = val
+    end
+
+  end
+end
+
+

data/test/unit/company_test.rb

@@ -2,11 +2,17 @@ require 'test_helper'
 
 class CompanyTest < ActiveSupport::TestCase
   fixtures [
+    :company,
+    :user_, :group_,
     :account_, :organization_, :contact_,
     :layout, :layoutset,
     :resource_, :resourcecode
   ]
 
+  def setup
+    @companies = Company.all
+    flunk 'No companies in database!' unless @companies.any?
+  end
 
   # each company must have an account
   def test_account
@@ -50,24 +56,30 @@ class CompanyTest < ActiveSupport::TestCase
     end
   end
 
-  # each company must have organization(s)
   def test_organizations
     @companies.each do |c|
-      assert !c.organizations.empty?, "#{c.id} has no organizations"
+      c.organizations.each do |o|
+        assert_not_nil o
+      end
     end
   end
 
   def test_administrators
     @companies.each do |c|
-      assert !c.administrators.empty?, "#{c.id} has no administrators"
+      assert c.administrators.size > 0, 'Company %s (%i) does not have administrators' % [c.webid, c.id]
     end
   end
 
-# ?
-#   def test_resource
-#     @companies.each do |x|
-#       assert !x.resource.nil?, "#{x.id} has no resource"
-#     end
-#   end
+  def test_guest
+    @companies.each do |c|
+      assert_not_nil c.guest, 'Company %i does not have a guest account' % c.id
+    end
+  end
+
+  def test_guest_group
+    @companies.each do |c|
+      assert_not_nil c.guest_group
+    end
+  end
 
 end

data/test/unit/dl_file_test.rb

@@ -1,9 +1,10 @@
 require 'test_helper'
 
 class DlFileTest < ActiveSupport::TestCase
+  fixtures [:dlfileentry, :company, :user_, :tagsasset]
 
   def setup
-    @files = DLFile.all
+    @files = DlFile.all
   end
 
   def test_company

data/test/unit/group_test.rb

@@ -3,23 +3,37 @@ require 'test_helper'
 class GroupTest < ActiveSupport::TestCase
   fixtures [
     :organization_,
+    :groups_orgs,
     :users_orgs,
     :usergroup,
     :role_,
     :classname_
   ]
+  # to test asset_viewer_portlet, these are required
+  fixtures << [
+    :portlet, :portletproperties, :portletpreferences,
+    :layout,
+    :tagsasset,
+    :igimage,
+    :mbmessage,
+    :blogsentry,
+    :wikipage,
+    :bookmarksentry,
+    :journalarticle,
+    :dlfileentry
+  ]
 
   def setup
-    @groups = Group.find :all
-    assert !@groups.empty?, "No groups"
+    @groups = Group.all
+    flunk 'No groups in database!' unless @groups.any?
 
     @company = Company.first
-    flunk 'No company!' unless @company
+    flunk 'No companies in database!' unless @company
   end
 
   def test_create_group
+    flunk ('No administrators in Company %i!' % @company.id) unless @company.administrators.any?
     user = @company.administrators.first
-    flunk 'No user!' unless user
 
     # Type Group
     group = Group.create(
@@ -47,7 +61,7 @@ class GroupTest < ActiveSupport::TestCase
 
       # Permissions to administrators
       group.company.administrators.each do |user|
-        assert user.user_permissions.include?(p)
+        assert user.permissions.include?(p)
       end
     end
   end
@@ -92,14 +106,14 @@ class GroupTest < ActiveSupport::TestCase
   # each group must belong to a company
   def test_company
     @groups.each do |x|
-      assert !x.company.nil?, "#{x.id} belongs to no company"
+      assert_not_nil x.company
     end
   end
 
   def test_organizations
     @groups.each do |x|
       x.organizations.each do |org|
-        assert organization.nil?, "#{x.id} has_and_belongs_to to unknown organization #{org.inspect}"
+        assert_not_nil org
       end
     end
   end
@@ -107,7 +121,7 @@ class GroupTest < ActiveSupport::TestCase
   def test_roles
     @groups.each do |x|
       x.roles.each do |role|
-        assert role.nil?, "#{x.id} has_and_belongs_to an unknown role #{role.inspect}"
+        assert_not_nil role
       end
     end
   end
@@ -115,7 +129,7 @@ class GroupTest < ActiveSupport::TestCase
   def test_permissions
     @groups.each do |x|
       x.permissions.each do |permission|
-        assert permission.nil?, "#{x.id} has_and_belongs_to an unknown permission #{permission.inspect}"
+        assert_not_nil permission
       end
     end
   end
@@ -123,22 +137,28 @@ class GroupTest < ActiveSupport::TestCase
   def test_usergroups
     @groups.each do |x|
       x.usergroups.each do |usergroup|
-        assert usergroup.nil?, "#{x.id} has_and_belongs_to an unknown usergroup #{usergroup.inspect}"
+        assert_not_nil usergroup
       end
     end
   end
 
-  # each group must belong to a creator
-  def test_creator
+#   # each group must belong to a creator
+#   def test_creator
+#     @groups.each do |x|
+# #       assert !x.creator.nil?, "#{x.id} has no creator"
+#     end
+#   end
+
+  def test_mbcategories
     @groups.each do |x|
-#       assert !x.creator.nil?, "#{x.id} has no creator"
+      assert_not_nil x.mbcategories
     end
   end
 
   # each group must have a friendlyurl
   def test_friendlyurl
     @groups.each do |x|
-      assert !x.friendlyurl.nil?, "#{x.id} has no friendlyurl"
+      assert_not_nil x.friendlyurl
     end
   end
 
@@ -152,6 +172,24 @@ class GroupTest < ActiveSupport::TestCase
     end
   end
 
+  def test_public_layouts
+    @groups.each do |g|
+      g.public_layouts.each do |l|
+        assert_equal g, l.group
+        assert l.is_public?
+      end
+    end
+  end
+
+  def test_private_layouts
+    @groups.each do |g|
+      g.private_layouts.each do |l|
+        assert_equal g, l.group
+        assert l.is_private?
+      end
+    end
+  end
+
   def test_members
     @groups.each do |x|
       if x.owner.kind_of?(Organization)
@@ -165,20 +203,40 @@ class GroupTest < ActiveSupport::TestCase
       if x.private_layouts.any?
         assert_not_nil x.path(:private)
       else
-        assert_nil x.path(:private)
+        assert_equal '', x.path(:private)
       end
       if x.public_layouts.any?
         assert_not_nil x.path(:public)
       else
-        assert_nil x.path(:public)
+        assert_equal '', x.path(:public)
       end
     end
   end
 
+  def test_asset_viewer_portlet
+    @groups.each do |group|
+      asset = Tag::Asset.first
+      flunk 'No asset to test on' unless asset
+
+      portletpreferences = group.asset_viewer_portlet
+      assert_equal Web::PortletPreferences, portletpreferences.class
+      assert_not_nil portletpreferences.path(:asset => asset)
+
+      assert_not_nil portletpreferences.layout
+      assert_equal group, portletpreferences.layout.group
+      assert_equal group.companyid, portletpreferences.layout.companyid
+
+      # 2nd time the portlet should be retrieved from DB
+      group.reload
+      assert_equal portletpreferences, group.asset_viewer_portlet
+    end
+  end
+
 #   def test_resource
 #     @groups.each do |x|
 # #       assert !x.resource.nil?, "#{x.id} has no resource"
 #     end
 #   end
 
+
 end

data/test/unit/journal/article_test.rb

@@ -4,7 +4,9 @@ class Journal::ArticleTest < ActiveSupport::TestCase
   fixtures [
     :journalarticle,
     :journalarticleresource,
-    :tagsasset
+    :tagsasset,
+    :tagsproperty,
+    :portlet
   ]
 
   def setup
@@ -48,5 +50,17 @@ class Journal::ArticleTest < ActiveSupport::TestCase
     end
   end
 
+#   def test_properties
+#     @articles.each do |x|
+#       assert_not_nil x.properties
+#       assert !x.properties.empty?
+#     end
+#   end
+
+  def test_path
+    @articles.each do |x|
+      assert_not_nil x.path
+    end
+  end
 
 end

data/test/unit/mb/category_test.rb

@@ -8,13 +8,13 @@ class MB::CategoryTest < ActiveSupport::TestCase
     :mbthread,
     :group_,
     :layout,
-    :portlet_names
+    :portletproperties
   ]
 
+
   def setup
     @categories = MB::Category.all
-    @rootcategory = MB::Category.find 0
-    @categories.delete @rootcategory
+    flunk 'No categories to test' unless @categories.any?
   end
 
   def test_create
@@ -62,46 +62,43 @@ class MB::CategoryTest < ActiveSupport::TestCase
       p = Permission.find(:first,
         :conditions => "companyid=#{category.companyid} AND actionid='#{actionid}' AND resourceid=#{resource.id}")
       assert_not_nil p
-      assert user.user_permissions.include?(p)
+      assert user.permissions.include?(p)
     end
   end
 
   # each article must belong to a company
   def test_company
     @categories.each do |x|
-      assert_not_nil x.company, "#{x.id} belongs to no company"
+      assert_not_nil x.company, "Category #{x.id} belongs to no company"
     end
   end
 
   def test_group
     @categories.each do |x|
-      assert_not_nil x.group, "#{x.id} belongs to no group!"
+      assert_not_nil x.group, "Category #{x.id} belongs to no group!"
     end
   end
 
   def test_user
     @categories.each do |x|
-      assert_not_nil x.user, "#{x.id} belongs to no user!"
+      assert_not_nil x.user, "Category #{x.id} belongs to no user!"
     end
   end
 
   def test_parent
     @categories.each do |x|
       unless x.parentcategoryid == 0 then
-        assert_not_nil x.parent, "#{x.id} refers to parent category #{x.parentcategoryid} which does not exist"
+        assert_not_nil x.parent, "Category #{x.id} refers to parent category #{x.parentcategoryid} which does not exist"
       end
     end
   end
 
-  def test_root
-    assert_equal 0, @rootcategory.companyid
-    assert_equal 0, @rootcategory.groupid
-    assert_equal 0, @rootcategory.userid
-    assert_equal 0, @rootcategory.parentcategoryid
-  end
-
   def test_path
     @categories.each do |x|
+      unless x.group
+        STDERR.puts 'WARN: message_boards category %i does not belong to a group' % x.id
+        next
+      end
       if x.group.layouts_include?('message_boards')
         assert_not_nil x.path
       else