lportal 1.0.9 → 1.0.17

data/ChangeLog

@@ -0,0 +1,71 @@
+= 1.0.17
+	- introduced schema versions, automatic detection from the release_ table
+	- migrations imported from caterpillar trunk, define the migrations directory for caterpillar
+	- Group#asset_viewer_portlet(), the asset viewer selection is based on the schema version
+	- Liferay portlet path definitions (tagged_content, asset_publisher)
+	- Journal::Article#path(), Tag::Asset#path()
+	- fixed journal article link
+	- Web::PortletPreferences and Web::Portlet: cleanup
+	- DRY up various models with Acts::Resourceful
+	- api change; layout.contents -> layout.settings
+	- api change; user.user_permissions -> user.permissions
+	- self.get methods to ResourceCode, Resource and Permission
+	- Typesettings: accept Strings and Portlet* models
+	- Company: methods to find various groups by type
+
+
+= 1.0.9
+	- creation of MB::Messages
+	- new models: SocialActivity, SocialRelation, RatingsStats, MB::MessageFlag, MB::StatsUser
+	- URL path to download Document Library File
+	- helper methods to find various types of groups and groups assets tags
+
+
+= 1.0.8
+	- Uniqueness scopes in User
+	- Group members taken from Organization, if Group type if Organization
+	- Role creation and deletion
+	- Group creation
+	- Added a method to clean Phone number
+	- Web::Layout creation
+	- Typesettings model for Layout content
+	- MB::Category creation, MB::Category.path
+	- User.activate, User.portrait_path, User.path
+	- Group.name returns the name of Group's owner, if classnameid != 0
+	- Layout portlets helper methods
+	- fixed Tag::Asset relations
+
+Known bugs:
+	- Typesettings does not parse all existing Layouts correctly!
+
+
+= 1.0.7
+	- User creation
+	- new models: Listtype, Announcement::Delivery
+	- Counter increment method
+	- better creation of Phone, Contact and Group
+
+
+= 1.0.6
+	- fixed a bug in user.gsm= method
+	- portlet names
+	- Company's guest
+	- layouts and various Liferay URL handling
+
+
+= 1.0.5
+	- Group types
+
+
+= 1.0.4
+	- Saving user's birthday through User.birthday=
+	- New relations
+	- New models
+	- More tests!
+
+
+= 1.0.0
+Initial release on 18.11.2008.
+
+The structure is usable (though not complete), so tagged as version 1.0.0.
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008,2009 Mikael Lammentausta
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -61,20 +61,21 @@ You can view this page in the Liferay "Communities" portlet via "Available Commu
 === Portlets and Caterpillar
 To add new portlets the Caterpillar mixins and migrations are required. This data does not live in the lportal database, and this library does not understand about the environment in which Liferay is. Caterpillar, however, does. It parses some Liferay XML configuration files and makes the data available by defining a couple of new methods to classes in the Web module.
 
-The Layout contents are defined in its typesettings. The Web::Typesettings class makes their definitions more Ruby-like. To add a message_boards portlet into column 2:
+The Layout settings are configured via Web::Typesettings. The ”settings” method handles the conversion between the ”typesettings” string and the object model. To add a message_boards portlet into column 2:
 
-  layout.typesettings = Web::Typesettings.new.message_boards(:column => 2).to_s
+  layout.settings = Web::Typesettings.new.message_boards(:column => 2)
 
   => "layout-template-id=2_columns_ii\ncolumn-2=19,"
 
 
 The other way around, find the private layouts of "group" that have the Message Board portlet:
 
-  layouts = group.private_layouts.select{|l| l.contents.include?('message_boards')}
+  layouts = group.select_layouts_with('message_boards',:private)
 
-Or, using a method designed for this:
+Which is a short form for:
+
+  layouts = group.private_layouts.select{|l| l.settings.include?('message_boards')}
 
-  layouts = group.select_layouts_with('message_boards',:private)
   => [#<Web::Layout plid: 8400000, groupid: 8400004, companyid: 10109, privatelayout: true, layoutid: 1, parentlayoutid: 0, name: "<?xml version='1.0' encoding='UTF-8'?><root availab...", title: "<root />", description: "", type_: "portlet", typesettings: "layout-template-id=2_columns_ii\ncolumn-2=19,", hidden_: false, friendlyurl: "/1", iconimage: false, iconimageid: 0, themeid: nil, colorschemeid: nil, wapthemeid: nil, wapcolorschemeid: nil, css: nil, priority: 0, dlfolderid: 0>]
 
 Or query what portlets are in the Layout:

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the liferay plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the liferay plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Liferay ActiveRecord models'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '-U' << '-x deprecated'
+  rdoc.options << '--line-numbers' << '--inline-source'
+end

data/init.rb

@@ -1,4 +1,4 @@
 file = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
 this_dir = File.dirname(File.expand_path(file))
 
-require File.join(this_dir,'lportal')
+require File.join(this_dir,'lportal')

data/lib/acts/resourceful.rb

@@ -0,0 +1,104 @@
+module Acts #:nodoc:
+
+  # This +acts_as+ extension provides the capabilities for creating +ResourceCode+s, +Resource+s
+  # and +Permission+s.
+  #
+  # The model needs to have defined their +liferay_class+, +companyid+, and for scope 2 resources,
+  # their +groupid+. These functions may be overridden in the model itself.
+  module Resourceful
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def acts_as_resourceful(options = {})
+
+        class_eval <<-EOV
+          include Acts::Resourceful::InstanceMethods
+
+          def acts_as_resourceful_class
+            ::#{self.name}
+          end
+        EOV
+      end
+    end
+
+    # All the methods available to a record that has had <tt>acts_as_resourceful</tt> specified.
+    module InstanceMethods
+
+      # ResourceCode associated to this instance (and scope)
+      def resource_code(scope)
+        ResourceCode.get({
+          :companyid => self.companyid,
+          :name      => self.liferay_class,
+          :scope     => scope
+        })
+      end
+
+      # Default primkey in scope 1 is +self.companyid+. Override in the model if necessary.
+      def scope1_primkey
+        self.companyid
+      end
+
+      # Default primkey in scope 2 is +self.groupid+. Override in the model if necessary.
+      def scope2_primkey
+        raise ('Instance %s does not belong to a group' % self) unless self.group
+        self.groupid
+      end
+
+      # Default primkey in scope 4 is +self.id+. Override in the model if necessary.
+      def scope4_primkey
+        self.id
+      end
+
+      # resource by codeid
+      def resource(rc)
+        case rc.scope
+        when 1
+          primkey = self.scope1_primkey
+        when 2
+          primkey = self.scope2_primkey
+        when 4
+          primkey = self.scope4_primkey
+        else
+          raise 'unknown scope'
+        end
+        if primkey.nil?
+          logger.warn 'No primkey'
+          return nil
+        end
+        logger.debug 'primkey: %s' % primkey
+        Resource.get({
+          :codeid  => rc.codeid,
+          :primkey => primkey
+        })
+      end
+
+      # When creating new instances, it is common to find a resource code, and a resource that matches the code.
+      # If they cannot be found from the database, they are created.
+      # This method takes care of all that.
+      def get_resource(args)
+        scope = args[:scope]
+        raise 'No scope' unless scope
+        logger.debug 'Get resource for %s, scope %i' % [self.liferay_class, scope]
+        rc = self.resource_code(scope)
+        logger.debug rc.inspect
+        r = self.resource(rc)
+        logger.debug r.inspect
+        return r
+      end
+
+      # Finds or creates a new Permission (and Resource + ResourceCode) for a given action
+      # and a specific scope.
+      def permission(actionid, scope)
+        resource = get_resource(:scope => scope)
+        Permission.get(
+          :companyid  => self.companyid,
+          :actionid   => actionid,
+          :resourceid => resource.id
+        )
+      end
+
+    end
+  end
+end

data/lib/company.rb

@@ -44,6 +44,31 @@ class Company < ActiveRecord::Base
     User.find(:first, :conditions => "companyid=#{self.id} AND defaultuser = true" )
   end
 
+  # Oddly enough, guest user's does not have a personal group relation in 5.1.1 nor 5.2.1
+  def guest_group
+    Group.find(:first, :conditions => "companyid=#{self.id} AND name='Guest'")
+  end
+
+  # 0 = personal user groups
+  def personal_groups
+    Group.find_personal self.id
+  end
+
+  # 1 = public, guest can see
+  def public_groups
+    Group.find_public self.id
+  end
+
+  # 2 = user-created open communities
+  def open_groups
+    Group.find_open self.id
+  end
+
+  # 3 = private, also contains admins
+  def private_groups
+    Group.find_private self.id
+  end
+
 #   has_one :frontpage,
 #     :class_name  => "Web::LayoutSet",
 #     :foreign_key => "companyid",

data/lib/group.rb

@@ -3,6 +3,8 @@ class Group < ActiveRecord::Base
   set_table_name       :group_
   set_primary_key      :groupid
 
+  acts_as_resourceful
+
   public
 
   # com.liferay.portal.model.Group
@@ -100,18 +102,7 @@ class Group < ActiveRecord::Base
       # +41	6	10155
       # 
       # Create a resource with scope=4 for this Layout.
-      rc = self.resource_code(4)
-      unless rc
-        rc = ResourceCode.create(
-          :companyid => self.companyid,
-          :name => self.liferay_class,
-          :scope => 4
-        )
-      end
-      r = Resource.create(
-        :codeid  => rc.id,
-        :primkey => self.id
-      )
+      r = get_resource(:scope => 4)
 
       # Permissions (given to administrators)
 
@@ -131,13 +122,13 @@ class Group < ActiveRecord::Base
       # 
 
       self.class.actions.each do |actionid|
-        p = Permission.create(
+        p = Permission.get(
           :companyid  => self.companyid,
           :actionid   => actionid,
           :resourceid => r.id
         )
         self.company.administrators.each do |user|
-          user.user_permissions << p
+          user.permissions << p
         end
       end
     end
@@ -192,6 +183,10 @@ class Group < ActiveRecord::Base
     :class_name  => 'Tag::Asset',
     :foreign_key => 'groupid'
 
+  has_many :mbcategories,
+    :class_name => 'MB::Category',
+    :foreign_key => 'groupid'
+
   # a group may have two layoutsets (public and private)
   has_many :layoutsets,
     :class_name  => 'Web::LayoutSet',
@@ -224,7 +219,7 @@ class Group < ActiveRecord::Base
 
 
   # --
-  # Class methods
+  # Class methods, in functional paradigm
   # ++
 
   class << self
@@ -292,9 +287,6 @@ class Group < ActiveRecord::Base
   end
 
 
-  has_one :resource,
-    :foreign_key => 'primkey'
-
   has_many :mbcategories,
     :class_name  => 'MB::Category',
     :foreign_key => 'groupid'
@@ -303,6 +295,10 @@ class Group < ActiveRecord::Base
     self.active_
   end
 
+  def is_personal?
+    self.type_ == 0
+  end
+
   def is_public?
     self.type_ == 1
   end
@@ -320,28 +316,26 @@ class Group < ActiveRecord::Base
     case pl
     when :public
       self.public_layouts.any? ?
-        self.public_layoutset.url_prefix + self.friendlyurl : nil
+        self.public_layoutset.url_prefix + self.friendlyurl : ''
 
     when :private
       self.private_layouts.any? ?
-        self.private_layoutset.url_prefix + self.friendlyurl : nil
+        self.private_layoutset.url_prefix + self.friendlyurl : ''
 
     else
-      nil
+      ''
     end
   end
 
-  # ResourceCode associated to this instance (and scope)
-  def resource_code(scope=4)
-    ResourceCode.find(:first,
-      :conditions => "companyid=#{self.companyid} AND name='#{self.liferay_class}' AND scope=#{scope}")
-  end
-
   # Selects the layout (from both public and private) that has the portlet.
+  #
   # Parameters:
-  #  - portlet     can be either a String of portlet name (eg. 'message_boards') or a Web::PortletName instance.
+  #  - portlet     can be either a String of portlet name (eg. 'message_boards'),
+  #                or a Web::Portlet, Web::PortletPreferences or Web::PortletProperties instance.
   #  - pl          only check public or private layouts? defaults to both. ( nil | :public | :private )
+  #
   def select_layouts_with(portlet,pl=nil)
+    name = (portlet.is_a?(String) ? portlet : portlet.name)
     layouts = (
       if pl.nil?
         self.layouts
@@ -354,7 +348,10 @@ class Group < ActiveRecord::Base
       end
     )
 
-    layouts.select{|l| l.contents.include?(portlet)}
+#     layouts.select{|l| l.settings.include?(portlet)}
+    layouts.select do |l|
+      l.portlets.map {|p| p.name==name}.any?
+    end
   end
 
   # Does any of the layouts include this portlet? See #select_layouts_with
@@ -367,4 +364,61 @@ class Group < ActiveRecord::Base
     self.assets.collect(&:tags).flatten.uniq
   end
 
+  # Unless the tagged_content portlet is found in any of the groups layouts,
+  # a new layout (public by default) is created with this portlet.
+  #
+  # See #select_layouts_with
+  #
+  # The asset viewer is different in different versions of the Liferay database.
+  #  - 5.1.x: tagged_content
+  #  - 5.2.x: asset_publisher
+  def asset_viewer_portlet(params={})
+    if Lportal::Schema.buildnumber < 5200
+      logger.debug 'Using lportal schema 5.1.x'
+      params[:name] ||= 'tagged_content'
+    else
+      logger.debug 'Using lportal schema 5.2.x'
+      params[:name] ||= 'asset_publisher'
+    end
+
+    portlet = Web::Portlet.find_by_name(params[:name])
+    raise ('Portlet ”%s” not found! Check that Caterpillar migrations are up-to-date' % params[:name]) unless portlet
+
+    # this says: if <tt>pl</tt> is undefined, use public layout, else use what <tt>pl</tt> specified.
+    params.update(:privatelayout => ( params[:privatelayout].nil? ? false : params[:privatelayout] ))
+
+    pl = (params[:privatelayout] ? :private : :public) # a small "type conversion"
+    layouts = self.select_layouts_with(portlet,pl)
+
+    ### Use existing layout and portlet
+    if layouts.any?
+      logger.debug 'Layout with tagged_content portlet found..'
+      layout = layouts.first
+      layout.portlets.each do |p|
+        return p if p.name==portlet.name
+      end
+    end
+
+    ### Create Layout + PortletPreferences
+    logger.info 'Creating new Layout ”%s” in Group %s (%i)' % [params[:name],self.name,self.id]
+
+    params[:friendlyurl] ||= ('/%s' % params[:name])
+    params.update(:group => self)
+
+    layout = Web::Layout.create(params)
+    logger.debug 'Layout ready'
+    logger.debug layout.inspect
+
+    layout.settings = Web::Typesettings.new
+    layout.columns=1
+
+    # add the portlet to the layout
+    layout.<<( portlet )
+    layout.save
+
+    portlet.reload
+    logger.debug portlet.preferences.inspect
+    return portlet.preferences
+  end
+
 end

data/lib/journal/article.rb

@@ -27,16 +27,20 @@ module Journal
       self.resource.asset
     end
 
-    has_many :properties,
-      :class_name => 'TagsProperty',
-      :foreign_key => 'entryid'
-
+#     has_many :properties,
+#       :class_name => 'TagsProperty',
+#       :foreign_key => 'entryid'
+# 
 #     # association to assets
 #     has_and_belongs_to_many  :assets,
 #       :join_table              => 'tagsassets_tagsentries',
 #       :foreign_key             => 'entryid',
 #       :association_foreign_key => 'assetid'
 
+    # Path to this article. See Tag::Asset#path.
+    def path
+      self.asset.path(self.articleid)
+    end
 
   end
 

data/lib/mb/category.rb

@@ -4,6 +4,8 @@ module MB
     set_table_name       :mbcategory
     set_primary_key      :categoryid
 
+    acts_as_resourceful
+
     # this causes trouble when modifying instance attributes (!)
     #validates_uniqueness_of :uuid_
 
@@ -81,52 +83,6 @@ module MB
       # +212	105	10166
       # +213	106	10307
 
-      rc = self.resource_code(1)
-      unless rc
-        rc = ResourceCode.create(
-          :companyid => self.companyid,
-          :name => self.liferay_class,
-          :scope => 1
-        )
-      end
-      unless Resource.find(:first, :conditions => "codeid=#{rc.id} AND primkey='#{self.companyid}'")
-        Resource.create(
-          :codeid  => rc.id,
-          :primkey => self.companyid
-        )
-      end
-
-      rc = self.resource_code(2)
-      unless rc
-        rc = ResourceCode.create(
-          :companyid => self.companyid,
-          :name => self.liferay_class,
-          :scope => 2
-        )
-      end
-      unless Resource.find(:first, :conditions => "codeid=#{rc.id} AND primkey='#{self.group.id}'")
-        Resource.create(
-          :codeid  => rc.id,
-          :primkey => self.group.id
-        )
-      end
-
-      # Create a resource with scope=4 for this Layout.
-      rc = self.resource_code(4)
-      unless rc
-        rc = ResourceCode.create(
-          :companyid => self.companyid,
-          :name => self.liferay_class,
-          :scope => 4
-        )
-      end
-      resource = Resource.create(
-        :codeid  => rc.id,
-        :primkey => self.id
-      )
-
-      # Permissions to scope 4
-
       # COPY permission_ (permissionid, companyid, actionid, resourceid) FROM stdin;
       # +312	10109	ADD_FILE	213
       # +313	10109	ADD_MESSAGE	213
@@ -153,13 +109,33 @@ module MB
       # +10129	321
       # +10129	322
 
+      get_resource(:scope => 1)
+      get_resource(:scope => 2)
+
+      # Permissions to scope 4
+
       self.class.actions.each do |actionid|
-        self.user.user_permissions << Permission.create(
-          :companyid  => self.companyid,
-          :actionid   => actionid,
-          :resourceid => resource.id
-        )
+        self.user.permissions << permission(actionid,4)
+      end
+    end
+
+    # Finds existing or creates a new Resource (TODO: DRY up!!)
+    # Args Hash:
+    #  - :codeid
+    #  - :primkey
+    def self.get(args)
+      conditions = []
+      args.each_pair{ |k,v|
+        conditions << (k==:name ?
+          ("%s='%s'" % [k,v]) : ("%s=%s" % [k,v]))
+      }
+      #puts conditions.inspect
+      r = self.find(:first, :conditions => conditions.join(' AND '))
+      unless r
+        logger.debug 'creating new %s' % self.class
+        r = self.create(args)
       end
+      return r
     end
 
     belongs_to :group,
@@ -189,19 +165,14 @@ module MB
       :foreign_key => :parentcategoryid
 
     has_many :threads,
-      :class_name => 'MB::Thread',
-      :foreign_key => 'categoryid'
+      :class_name  => 'MB::Thread',
+      :foreign_key => 'categoryid',
+      :order       => 'lastpostdate DESC'
 
     has_many :messages,
       :class_name => 'MB::Message',
       :foreign_key => 'categoryid'
 
-    # ResourceCode associated to this instance (and scope)
-    def resource_code(scope=4)
-      ResourceCode.find(:first,
-        :conditions => "companyid=#{self.companyid} AND name='#{self.liferay_class}' AND scope=#{scope}")
-    end
-
     # URL path to this Category. Works on Liferay 5.1.1.
     # Parameters:
     #  - pl          only check public or private layouts? defaults to both. ( nil | :public | :private )