lportal 1.0.7 → 1.0.8

data/README

@@ -9,20 +9,91 @@ This is a collection of (some) Liferay models for developers that use the databa
 2. require 'lportal'
 3. You're good to go.
 
-This gem quite effectively pollutes your namespace, and that is intentional. If you are working in the context of the portal, having your users modeled by User is more convenient rather than having to reference them as Lportal::Users.
+This gem quite effectively pollutes your namespace, and that is intentional. If you are working in the context of the portal, having your users modeled by User is more convenient rather than having to reference them as "Lportal::Users".
 
 
-== Tips & Tricks
-Find the public layouts of a Group "g" that have the Message Board portlet:
-(only possible with Caterpillar)
+== General notions and examples
+=== Caterpillar
+To create new instances you need Caterpillar. Liferay's ORM, Hibernate, does not seem to use database sequences, but ActiveRecord assumes they exist. Caterpillar's purpose is to lower the barriers to deploy Rails portlets and it contains various tasks that do not belong to this library. See the Caterpillar docs on installation; this document assumes your environment is set up. Do not forget to run the migrations!
 
-  title = 'Message Boards'
-  g = Group.find 15833
 
-  layout = g.public_layouts.select{
-    |l| l.portlets.find{|p| p.title=="#{title}"}}.first
+=== Layouts
+Each Group can have public and private pages. In both cases, there has to first exist a Web::LayoutSet, which is automatically created for a new Group. The individual pages (class Web::Layout) belong to this set, but they are not directly linked (in 5.1.1 at least). Instead, they belong to the Group and are either public or private. The models have methods to query the relations.
 
-  puts layout.inspect
+Say you create a new Group "group".
 
+  company = Company.first
+  group = Group.create(
+    :company => company,
+    :creatoruserid => company.administrators.first.id,
+    :name => 'Example'
+  )
 
-Copyright (c) 2008 Mikael Lammentausta, released under the MIT license
+  => #<Group groupid: 8400004, companyid: 10109, creatoruserid: 10129, classnameid: 0, classpk: 0, parentgroupid: 0, livegroupid: 0, name: "Example", description: "", type_: 1, typesettings: "", friendlyurl: "/example", active_: true>
+
+The LayoutSets can then be queried:
+
+  group.public_layoutset
+
+  => #<Web::LayoutSet layoutsetid: 8400011, groupid: 8400004, companyid: 10109, privatelayout: false, logo: false, logoid: 0, themeid: "", colorschemeid: "01", wapthemeid: "mobile", wapcolorschemeid: "01", css: "", pagecount: 0, virtualhost: "">
+
+  group.private_layoutset
+
+  => #<Web::LayoutSet layoutsetid: 8400010, groupid: 8400004, companyid: 10109, privatelayout: true, logo: false, logoid: 0, themeid: "", colorschemeid: "01", wapthemeid: "mobile", wapcolorschemeid: "01", css: "", pagecount: 0, virtualhost: "">
+
+  group.layoutsets.size
+
+  => 2
+
+And a new empty Layout can be created:
+
+  layout = Web::Layout.create(
+    :group => group,
+    :privatelayout => true,
+    :name => 'Private page'
+  )
+
+  => #<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\n", hidden_: false, friendlyurl: "/1", iconimage: false, iconimageid: 0, themeid: nil, colorschemeid: nil, wapthemeid: nil, wapcolorschemeid: nil, css: nil, priority: 0, dlfolderid: 0>
+
+You can view this page in the Liferay "Communities" portlet via "Available Communities" => "Actions" => "Manage Pages" => "Private Pages" => "View Pages".
+
+
+=== 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:
+
+  layout.typesettings = Web::Typesettings.new.message_boards(:column => 2).to_s
+
+  => "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')}
+
+Or, using a method designed for this:
+
+  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:
+
+  layouts.first.portlets.each{|p| puts p.title}
+
+  Message Boards
+  => [#<Web::PortletPreferences portletpreferencesid: 10210, ownerid: 0, ownertype: 3, plid: 10146, portletid: "19", preferences: "<portlet-preferences xmlns=\"http://java.sun.com/xml...">]
+
+Or whether the layouts include a specific portlet:
+
+  group.layouts_include?('message_boards')
+  => true
+  group.layouts_include?('message_boards',:private)
+  => true
+  group.layouts_include?('message_boards',:public)
+  => false
+
+
+
+
+Copyright (c) 2008,2009 Mikael Lammentausta, released under the MIT license

data/lib/blog_post.rb

@@ -1,3 +1,4 @@
+# TODO: rename to Blog::Entry
 class BlogPost < ActiveRecord::Base
   set_table_name       :blogsentry
   set_primary_key      :entryid
@@ -22,14 +23,13 @@ class BlogPost < ActiveRecord::Base
   alias :community :group
 
   has_one :asset,
+    :class_name  => 'Tag::Asset',
     :foreign_key => 'classpk'
 
-#   # association to assets (?)
-#   has_and_belongs_to_many  :assets,
-#     :class_name              => 'Asset',
-#     :join_table              => 'tagsasset',
-#     :foreign_key             => 'classpk',
-#     :association_foreign_key => 'assetid'
-
+#   # URL path to this BlogPost.
+#   # Layout should contain the 'tagged_content' portlet.
+#   def path(layout)
+#     basic_asset_url(content_viewer)
+#   end
 
 end

data/lib/bookmark/entry.rb

@@ -18,5 +18,9 @@ module Bookmark
       :class_name => 'Bookmark::Folder',
       :foreign_key => 'folderid'
 
+    has_one :asset,
+      :class_name  => 'Tag::Asset',
+      :foreign_key => 'classpk'
+
   end
 end

data/lib/contact.rb

@@ -69,7 +69,7 @@ class Contact < ActiveRecord::Base
 
   def fullname
     (self.firstname.empty? and self.lastname.empty?) ?
-      false : self.firstname+' '+self.lastname
+      'Guest' : self.firstname+' '+self.lastname
   end
 
 end

data/lib/dl_file.rb

@@ -19,6 +19,7 @@ class DlFile < ActiveRecord::Base
   alias :owner :user
 
   has_one :asset,
+    :class_name  => 'Tag::Asset',
     :foreign_key => 'classpk'
 
 end

data/lib/dl_folder.rb

@@ -22,4 +22,8 @@ class DlFolder < ActiveRecord::Base
     :foreign_key => 'groupid'
   alias :community :group
 
+#   has_one :asset,
+#     :class_name  => 'Tag::Asset',
+#     :foreign_key => 'classpk'
+
 end

data/lib/group.rb

@@ -10,17 +10,137 @@ class Group < ActiveRecord::Base
     'com.liferay.portal.model.Group'
   end
 
+  # Actions for Permissions.
+  def self.actions
+    %w{
+    APPROVE_PROPOSAL
+    ASSIGN_MEMBERS
+    ASSIGN_REVIEWER
+    DELETE
+    MANAGE_ANNOUNCEMENTS
+    MANAGE_ARCHIVED_SETUPS
+    MANAGE_LAYOUTS
+    MANAGE_STAGING
+    PERMISSIONS
+    PUBLISH_STAGING
+    UPDATE
+    }
+  end
+
+  # Creates a new group (community).
+  #
+  #
+  # Some instances are created based on the Classname of the Group.
+  # User's own group, for instance, has to be created with classnameid and classpk.
+  #
+  # The Group may also have public and private Web::LayoutSet s.
+  #
+  # This process is engineered by creating a new role with Liferay's (v. 5.1.1) tools and
+  # inspecting the database dump diffs.
+  #
+  # Mandatory parameters:
+  #  - companyid
+  #  - creatoruserid
   def initialize(params)
+    raise 'No companyid given' unless (params[:companyid] or params[:company])
+    raise 'No creatoruserid given' unless params[:creatoruserid]
+    raise 'No name given' if (
+      params[:name].nil? and (params[:classnameid].nil? or params[:classnameid]==0))
+
     super(params)
+
+    # COPY group_ (groupid, companyid, creatoruserid, classnameid, classpk, parentgroupid, livegroupid, name, description, type_, typesettings, friendlyurl, active_) FROM stdin;
+    # +10155	10109	10129	0	0	0	0	testiyhteisö open	testataan yhteisön luomista	1		/10155	t
+
+    self.classnameid   ||= 0 # Community
+    self.classpk       ||= 0 # -"-
     self.parentgroupid ||= 0
     self.livegroupid   ||= 0
-    self.type_         ||= 0
-    self.active_       ||= true
     self.name          ||= ''
     self.description   ||= ''
+    self.type_         ||= 1
     self.typesettings  ||= ''
+    self.active_       ||= true
+
+    unless self.friendlyurl
+      self.friendlyurl = (
+        case self.classnameid
+        when 0
+          '/'+self.name.downcase
+        else
+          self.friendlyurl   ||= '/%i' % self.id
+        end
+      )
+    end
 
     self.save
+
+    # public and private layoutsets
+
+    # COPY layoutset (layoutsetid, groupid, companyid, privatelayout, logo, logoid, themeid, colorschemeid, wapthemeid, wapcolorschemeid, css, pagecount, virtualhost) FROM stdin;
+    # +10156	10155	10109	t	f	0		01	mobile	01		0	
+    # +10157	10155	10109	f	f	0		01	mobile	01		0	
+
+    [true, false].each do |privacy|
+      Web::LayoutSet.create(
+        :groupid       => self.id,
+        :companyid     => self.companyid,
+        :privatelayout => privacy
+      )
+    end
+
+    ### GROUP
+    unless self.classnameid == 0
+      # Type is != 0 only for Groups of type Group (?)
+      self.type_ = 0
+      self.save
+    else
+
+      # COPY resource_ (resourceid, codeid, primkey) FROM stdin;
+      # +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
+      )
+
+      # Permissions (given to administrators)
+
+      # 
+      # COPY permission_ (permissionid, companyid, actionid, resourceid) FROM stdin;
+      # +81	10109	APPROVE_PROPOSAL	41
+      # +82	10109	ASSIGN_MEMBERS	41
+      # +83	10109	ASSIGN_REVIEWER	41
+      # +84	10109	DELETE	41
+      # +85	10109	MANAGE_ANNOUNCEMENTS	41
+      # +86	10109	MANAGE_ARCHIVED_SETUPS	41
+      # +87	10109	MANAGE_LAYOUTS	41
+      # +88	10109	MANAGE_STAGING	41
+      # +89	10109	PERMISSIONS	41
+      # +90	10109	PUBLISH_STAGING	41
+      # +91	10109	UPDATE	41
+      # 
+
+      self.class.actions.each do |actionid|
+        p = Permission.create(
+          :companyid  => self.companyid,
+          :actionid   => actionid,
+          :resourceid => r.id
+        )
+        self.company.administrators.each do |user|
+          user.user_permissions << p
+        end
+      end
+    end
   end
 
   belongs_to :company,
@@ -69,6 +189,7 @@ class Group < ActiveRecord::Base
 
   # association to assets
   has_many :assets,
+    :class_name  => 'Tag::Asset',
     :foreign_key => 'groupid'
 
   # a group may have two layoutsets (public and private)
@@ -101,6 +222,11 @@ class Group < ActiveRecord::Base
     :foreign_key => 'groupid',
     :conditions  => 'privatelayout = true'
 
+  def name
+    self.classnameid != 0 ?
+      self.owner.name : super
+  end
+
   # find owner by classnameid + classpk
   def owner
     return nil if self.classnameid==0
@@ -108,6 +234,29 @@ class Group < ActiveRecord::Base
     _class.find self.classpk
   end
 
+  # Members by the group type, ie. if the group is of type Organization, return Organization members.
+  def members
+    if self.owner.kind_of?(Organization)
+      return self.owner.members
+    else
+      #[self.users, self.organizations.collect(&:users)].flatten
+      return self.users
+    end
+  end
+
+  # Assign User to be a member of this Group
+  def assign_membership(user)
+    raise 'TODO'
+    # COPY usergrouprole (userid, groupid, roleid) FROM stdin;
+    # +10129	10155	10120
+    # +10129	10155	10119
+    # 
+    # COPY users_groups (userid, groupid) FROM stdin;
+    # +10129	10155
+    # 
+  end
+
+
   has_one :resource,
     :foreign_key => 'primkey'
 
@@ -131,7 +280,7 @@ class Group < ActiveRecord::Base
     self.type_ == 3
   end
 
-  # the URL to this Group's public or private page
+  # URL path to this Group's public or private page
   def path(pl=:public)
     case pl
     when :public
@@ -147,5 +296,35 @@ class Group < ActiveRecord::Base
     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.
+  #  - pl          only check public or private layouts? defaults to both. ( nil | :public | :private )
+  def select_layouts_with(portlet,pl=nil)
+    layouts = (
+      if pl.nil?
+        self.layouts
+      elsif pl==:public
+        self.public_layouts
+      elsif pl==:private
+        self.private_layouts
+      else
+        []
+      end
+    )
+
+    layouts.select{|l| l.contents.include?(portlet)}
+  end
+
+  # Does any of the layouts include this portlet? See #select_layouts_with
+  def layouts_include?(portlet,pl=nil)
+    self.select_layouts_with(portlet,pl).any?
+  end
 
-end
+end

data/lib/ig/image.rb

@@ -16,6 +16,7 @@ module IG
       :foreign_key => 'userid'
 
     has_one :asset,
+      :class_name  => 'Tag::Asset',
       :foreign_key => 'classpk'
 
     belongs_to :folder,

data/lib/journal/article_resource.rb

@@ -12,6 +12,7 @@ module Journal
       :foreign_key => 'groupid'
 
     has_one :asset,
+      :class_name  => 'Tag::Asset',
       :foreign_key => 'classpk'
 
     #     belongs_to :article,

data/lib/mb/category.rb

@@ -4,11 +4,163 @@ module MB
     set_table_name       :mbcategory
     set_primary_key      :categoryid
 
+    validates_uniqueness_of :uuid_
+
     # com.liferay.portlet.messageboards.model.MBCategory
     def liferay_class
       'com.liferay.portlet.messageboards.model.MBCategory'
     end
 
+    # Actions for Permissions.
+    def self.actions
+      %w{
+        ADD_FILE
+        ADD_MESSAGE
+        ADD_SUBCATEGORY
+        DELETE
+        MOVE_THREAD
+        PERMISSIONS
+        REPLY_TO_MESSAGE
+        SUBSCRIBE
+        UPDATE
+        UPDATE_THREAD_PRIORITY
+        VIEW
+      }
+    end
+
+    # Creates a new Message Board category.
+    #
+    # This process is engineered by creating a new layout with Liferay's (v. 5.1.1) tools and
+    # inspecting the database dump diffs.
+    #
+    # Mandatory parameters:
+    #  - groupid
+    #  - name
+    def initialize(params)
+      raise 'No groupid given' unless (params[:groupid] or params[:group])
+      raise 'No name given' unless params[:name]
+      super(params)
+
+      # COPY mbcategory (uuid_, categoryid, groupid, companyid, userid, username, createdate, modifieddate, parentcategoryid, name, description, lastpostdate) FROM stdin;
+      # +fda18eef-3992-419e-a373-6e2f01a8b6a9	10307	10166	10109	10129	Test Test	2009-01-17 08:06:00.359	2009-01-17 08:06:00.359	0	Teppo Testaaja	message board for user Teppo	\N
+
+      unless self.uuid_
+        require 'rubygems'
+        require 'uuidtools'
+        self.uuid_ = UUID.random_create.to_s
+      end
+
+      self.companyid = self.group.companyid
+
+      # owner (if undefined, use admin)
+      unless self.userid
+        user = Company.first.administrators.first
+        self.userid   ||= user.id
+      end
+      self.username         ||= self.user.fullname
+      self.createdate       = Time.now
+      self.modifieddate     = Time.now
+      self.parentcategoryid ||= 0
+      self.description      ||= ''
+
+      self.save
+
+      # ResourceCode with scope 1 => Resource for Company
+      # ResourceCode with scope 2 => Resource for this Group and Guest's Group
+      # ResourceCode with scope 4 => Resource for self
+
+      # COPY resourcecode (codeid, companyid, name, scope) FROM stdin;
+      # +104	10109	com.liferay.portlet.messageboards.model.MBCategory	1
+      # +105	10109	com.liferay.portlet.messageboards.model.MBCategory	2
+      # +106	10109	com.liferay.portlet.messageboards.model.MBCategory	4
+
+      # COPY resource_ (resourceid, codeid, primkey) FROM stdin;
+      # +210	104	10109
+      # +211	105	10124
+      # +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
+      # +314	10109	ADD_SUBCATEGORY	213
+      # +315	10109	DELETE	213
+      # +316	10109	MOVE_THREAD	213
+      # +317	10109	PERMISSIONS	213
+      # +318	10109	REPLY_TO_MESSAGE	213
+      # +319	10109	SUBSCRIBE	213
+      # +320	10109	UPDATE	213
+      # +321	10109	UPDATE_THREAD_PRIORITY	213
+      # +322	10109	VIEW	213
+
+      # COPY users_permissions (userid, permissionid) FROM stdin;
+      # +10129	312
+      # +10129	313
+      # +10129	314
+      # +10129	315
+      # +10129	316
+      # +10129	317
+      # +10129	318
+      # +10129	319
+      # +10129	320
+      # +10129	321
+      # +10129	322
+
+      self.class.actions.each do |actionid|
+        self.user.user_permissions << Permission.create(
+          :companyid  => self.companyid,
+          :actionid   => actionid,
+          :resourceid => resource.id
+        )
+      end
+    end
+
     belongs_to :group,
       :foreign_key => "groupid"
 
@@ -26,7 +178,7 @@ module MB
 #       :class_name => self.class,
 #       :foreign_key => "parentcategoryid"
 
-    #
+    # Parent Category, nil if this is already root.
     def parent
       self.parentcategoryid != 0 ? MB::Category.find(self.parentcategoryid) : nil
     end
@@ -43,5 +195,20 @@ module MB
       :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 )
+    def path(pl=nil)
+      layouts = self.group.select_layouts_with('message_boards',pl)
+      return nil unless layouts.any?
+      '%s/-/message_boards/category/%i' % [layouts.first.path, self.id]
+    end
+
   end
 end

data/lib/mb/message.rb

@@ -24,6 +24,10 @@ module MB
       :class_name => 'MB::Thread',
       :foreign_key => 'threadid'
 
+#     has_one :asset,
+#       :class_name  => 'Tag::Asset',
+#       :foreign_key => 'classpk'
+
 
     # parent message
     def parent

data/lib/resource_code.rb

@@ -10,4 +10,16 @@ class ResourceCode < ActiveRecord::Base
   has_many :resources,
     :foreign_key => "codeid"
 
+  # ResourceCode associated to an Liferay class
+  #
+  # Args:
+  #  - :companyid
+  #  - :name
+  #  - :scope (defaults to 4)
+  def self.find_by_liferay_class(args={})
+    args.update(:scope => 4) unless args[:scope]
+    ResourceCode.find(:first,
+      :conditions => "companyid=#{args[:companyid]} AND name='#{args[:name]}' AND scope=#{args[:scope]}")
+  end
+
 end