lportal 1.0.9 → 1.0.17

data/lib/web/layout.rb

@@ -5,7 +5,10 @@ module Web
     set_table_name       :layout
     set_primary_key      :plid
 
-    validates_uniqueness_of :layoutid, :scope => [:groupid, :privatelayout]
+    acts_as_resourceful
+
+    # FIXME: does not work properly. even if the layoutid is available, this causes self.errors
+    #validates_uniqueness_of :layoutid, :scope => [:groupid, :privatelayout]
 
 
     # com.liferay.portal.model.Layout
@@ -34,6 +37,7 @@ module Web
     # Optional extra parameters:
     #  - locale
     def initialize(params)
+      logger.debug params.inspect
       raise 'No groupid given' unless (params[:groupid] or params[:group])
       raise 'No privatelayout given' if params[:privatelayout].nil?
       _name = params.delete(:name) || 'New layout'
@@ -52,11 +56,13 @@ module Web
       name += _name
       name += '</name></root>'
       self.name = name
+      self.save
 
       # perhaps layoutid could be sequenced.
       layouts = (self.is_public? ? self.group.public_layouts : self.group.private_layouts)
       _ids = (layouts.any? ? layouts.collect(&:layoutid) : nil)
       self.layoutid = (_ids.nil? ? 1 : _ids.sort.max+1)
+      self.save
 
       # increment pagecount
       _set = self.layoutset
@@ -88,34 +94,11 @@ module Web
       # +201	2	10166
       # +202	3	10301
 
-      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
+      self.get_resource(:scope => 2)
 
       # 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
-      )
+      resource = self.get_resource(:scope => 4)
+      logger.debug 'resource: %s' % resource.inspect
 
       # COPY permission_ (permissionid, companyid, actionid, resourceid) FROM stdin;
       # +301	10109	ADD_DISCUSSION	202
@@ -123,7 +106,7 @@ module Web
       # +303	10109	VIEW	202
 
       self.class.actions.each do |actionid|
-        p = Permission.create(
+        p = Permission.get(
           :companyid  => self.companyid,
           :actionid   => actionid,
           :resourceid => resource.id
@@ -133,21 +116,50 @@ module Web
         # +10129	301
         # +10129	302
         # +10129	303
-        # +10111	303
 
+        # admins can do everything
         self.company.administrators.each do |user|
-          user.user_permissions << p
+          user.permissions << p
         end
 
         # COPY groups_permissions (groupid, permissionid) FROM stdin;
         # +10166	301
         # +10166	303
-        group = self.group
-        self.group.permissions << p
+
+        # group members can ADD_DISCUSSION and VIEW
+        if (actionid=='ADD_DISCUSSION' or actionid=='VIEW')
+          self.group.permissions << p
+        end
+
+        # COPY users_permissions (userid, permissionid) FROM stdin;
+        # +10111	303
+
+        # guest is permitted to VIEW if the layout is public.
+        if self.is_public? and actionid=='VIEW'
+          self.company.guest.permissions << p
+        end
+
       end
+
+      # the layout management portlet (new in 5.2.x?)
+
+      # COPY portletpreferences (portletpreferencesid, ownerid, ownertype, plid, portletid, preferences) FROM stdin;
+      # +10259	0	3	10301	88	<portlet-preferences />
+
+      # perhaps this will create itself?
+      # Web::PortletPreferences.create(:plid => self.plid, :portletid => 88)
+
       return self
     end
 
+    def save
+      super
+      if self.errors.any?
+        logger.error self.errors.inspect
+        raise self.errors[:layoutid] if self.errors[:layoutid]
+      end
+    end
+
     public
 
     belongs_to :group,
@@ -207,17 +219,100 @@ module Web
 
     # the URL path to this Layout
     def path
-      self.layoutset.url_prefix + self.group.friendlyurl + self.friendlyurl
+      self.layoutset ? 
+        self.layoutset.url_prefix + self.group.friendlyurl + self.friendlyurl : ''
+    end
+
+    # Settings for this Layout.
+    #
+    # Returns the object model of the string "typesettings".
+    def settings
+      Typesettings.new(self.typesettings)
     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}")
+    # Save settings. Parses them to typesettings string.
+    #
+    # Parameters:
+    #  - ts = Typesettings instance
+    def settings=(ts)
+      raise 'parameter must be a Typesettings instance' unless ts.is_a?(Typesettings)
+      self.typesettings = ts.to_s
     end
 
-    def contents
-      Typesettings.new(self.typesettings)
+    # As the method 'name' returns the name in XML, name_string is the string representation.
+    def name_string
+      self.name[/([^>]*)<\/name/,1]
+    end
+
+    # Insert the name string to XML.
+    def name_string=(name)
+      self.name = "<?xml version='1.0' encoding='UTF-8'?>"+\
+      '<root available-locales="en_US" default-locale="en_US"><name language-id="en_US">%s</name></root>' % name
+    end
+
+    # sets the number of columns in this layout
+    def columns=(nr)
+      s = self.settings
+      s.columns = nr
+      self.settings = s
+    end
+
+    # Add a portlet to this layout.
+    def <<(portlet, params={})
+      unless portlet
+        logger.debug 'No portlet given'
+        return false
+      end
+
+      if portlet.is_a?(Web::PortletPreferences)
+        preferences = portlet
+        portlet = preferences.portlet
+      else
+        preferences = portlet.preferences
+      end
+
+      # define the layout
+      preferences.layout = self
+      preferences.save
+
+      # not very OO..
+      settings = self.settings
+      location = (params[:location] ||= {:column => 1})
+      #puts location.inspect
+
+      # accept either a string or a symbol or Portlet
+#       puts portlet.inspect
+#       puts settings.portlets.inspect
+      settings.portlets.update(
+        location[:column] => [preferences || portlet]
+      )
+#       puts settings.portlets.inspect
+      self.settings=settings
+
+      [1,2].each do |scope|
+        preferences.get_resource(:scope => scope)
+      end
+
+      # guest permissions are given if the layout is public.
+      # (TODO: AND IF THE GROUP IS GUEST)
+
+      resource = preferences.get_resource(:scope => 4)
+      preferences.class.actions.each do |actionid|
+        p = Permission.get(
+          :companyid  => self.companyid,
+          :actionid   => actionid,
+          :resourceid => resource.id
+        )
+        if actionid=='VIEW'
+          self.group.permissions << p
+          if self.is_public?
+            guest = self.company.guest
+            guest.permissions << p
+          end
+        end
+      end
+
+      self
     end
 
   end

data/lib/web/layout_set.rb

@@ -45,14 +45,18 @@ module Web
     end
 
     def layouts
+      return 0 unless self.group
       Web::Layout.find(:all, :conditions => "groupid=#{self.groupid} AND privatelayout=#{self.privatelayout}" )
     end
 
     # lookup the path prefix for this LayoutSet
     def url_prefix
+      return '' unless self.group
       return '/web' if self.is_public?
-
-      _class = Classname.model(Classname.find(self.group.classnameid).value)
+      _class = (
+        self.group.classnameid==0 ?
+        Group : Classname.model(Classname.find(self.group.classnameid).value)
+      )
       if _class == User
         return '/user' #if self.is_private?
         #return '/web'
@@ -62,8 +66,8 @@ module Web
         #return '/web'
 
       else
-        logger.debug 'FIXME: ' + _class
-        return nil
+        logger.debug 'FIXME: %s' % _class
+        return ''
       end
     end
 

data/lib/web/portlet.rb

@@ -1,47 +1,119 @@
-module Web
-  # Not all portlets are necessarily saved in the database.
+module Web # :nodoc:
+  # Portlets can be included onto a Layout. Portlets are not instantiated per se; when one is
+  # inserted on a Layout, PortletPreferences is created. This instance (from ActiveRecord's point-of-view),
+  # may be instantiated or not, from Liferay's POV. Instantiation in this sense means that each PortletPreferences
+  # may have session-based customization.
+  #
+  # Caterpillar can gather this information from the Liferay XML files, see its documentation.
+  #
   class Portlet < ActiveRecord::Base
     set_table_name       :portlet
     set_primary_key      :id_
 
     public
 
+    # com.liferay.portal.model.Portlet
+    def liferay_class
+      'com.liferay.portal.model.Portlet'
+    end
+
     belongs_to :company,
       :foreign_key => "companyid"
 
-    def name
-      self.portletid
+    # Creates a portlet instance with preferences.
+    def initialize(params={})
+      super(params)
+      self.roles ||= ''
+      self.active_ = true if self.active_.nil?
+
+      self
     end
 
-    # primkey in resource_ table
-    def primkey(plid)
-      "#{plid}_LAYOUT_#{self.portletid}"
+
+    # Searches from PortletProperties.
+    # Returns nil unless one is found. Returns a Portlet if the properties are found.
+    def self.find_by_name(name)
+      pp = Web::PortletProperties.find_by_name(name)
+      unless pp
+        logger.warn 'Portlet by name was not found -- are portletproperties up-to-date?'
+        return nil
+      end
+      pp.portlet
     end
 
-    def resource(plid)
-      Resource.find_by_primkey(self.primkey(plid))
+
+    # PortletPreferences for this instance (@preferences)
+    #
+    # This Web::Portlet instance may have several "instances of itself", each of which are stored
+    # in PortletPreferences. Each of these are unique rows in the database,
+    # and these are accessible through the 'instances' association.
+    #
+    # PortletPreferences are created when the Portlet is added to a Layout.
+    # Its portletid, on the other hand, depends on whether this portlet is instanceable.
+    def preferences
+      unless @preferences
+        @preferences = Web::PortletPreferences.create({:portlet => self})
+      end
+      return @preferences
     end
 
-    # all instances
-    def resources
-  #     Resource.find_by_primkey(self.primkey)
-  #     Resource.find(:all, :conditions => "primkey='#{self.primkey}'")
-      resources = []
-      ResourceCode.find(:all, :conditions => "name='#{portletid}'").each do |rc|
-        resources << Resource.find(:all, :conditions => "codeid='#{rc.id}'")
+    attr_writer :preferences
+
+    # All instances of a specific portlet. See also preferences.
+    def instances
+      unless @instances
+        @instances = Web::PortletPreferences.find_all_by_portletid(self.portletid)
       end
+      return @instances
+    end
+
+    # Various static properties of the portlet instance and the portlet in general.
+    # Requires custom migrations for PortletProperties.
+    # The tables within are filled by Caterpillar, since it knows the location of the
+    # portlet XML files.
+    def properties
+      unless @properties
+        @properties = Web::PortletProperties.find_by_portletid(self.portletid)
+      end
+      return @properties
+    end
 
-      return resources.flatten
+    # The default title string that is displayed.
+    #
+    # Requires custom migrations for PortletProperties. Defaults to an empty string.
+    #
+    # PortletPreferences may override this, see PortletPreferences#title.
+    #
+    def title
+      self.properties ?
+        self.properties.title : ''
+    end
+
+    # Portlet's JSR286 name.
+    #
+    # Requires custom migrations for PortletProperties. Defaults to portletid.
+    #
+    def name
+      self.properties ?
+        self.properties.name : self.portletid
     end
 
     def is_active?
       self.active_
     end
 
-    # comply API with Web::PortletPreferences
-    def preferences_
-      ""
+    # Is the portlet instanceable? This is defined in the XML configuration.
+    # Requires custom migrations for PortletProperties.
+    #
+    # Defaults to true.
+    def instanceable?
+      return @instanceable if !@instanceable.nil? # test value
+      self.properties ?
+        self.properties.instanceable : true
     end
 
+    # for testing and debugging
+    attr_writer :instanceable
+
   end
 end

data/lib/web/portlet_preferences.rb

@@ -1,38 +1,167 @@
 module Web
+  # While PortletPreferences acts_as_resourceful, it is a resource as the portlet it represents.
+  # The ResourceCode has a 'name' value that is the Portlet's portletid.
+  #
+  # Also see Lportal::Portlets, that adds a method +path+.
   class PortletPreferences < ActiveRecord::Base
     set_table_name       :portletpreferences
     set_primary_key      :portletpreferencesid
 
+    acts_as_resourceful
+
+    include Lportal::Portlets
+
     public
 
+    # com.liferay.portal.model.PortletPreferences
+    def liferay_class
+      'com.liferay.portal.model.PortletPreferences'
+    end
+
+    # add portlets to layouts via Layout#<<
     belongs_to :layout,
       :class_name => 'Web::Layout',
       :foreign_key => 'plid'
 
-    belongs_to :owner,
-      :class_name => 'User',
-      :foreign_key => 'ownerid'
+# this is more complicated than this.
+#     belongs_to :owner,
+#       :class_name => 'User',
+#       :foreign_key => 'ownerid'
 
-    def name
+
+    # Actions for Permissions.
+    def self.actions
+      %w{
+        CONFIGURATION
+        VIEW
+      }
+    end
+
+    # PortletPreferences instance keeps record of unique Portlet preferences.
+    #
+    # Parameteres:
+    #  - portletid (String) (or portlet)
+    #  - portlet       Web::Portlet
+    #  - preferences   String
+    def initialize(params={})
+      portlet = params.delete(:portlet) if params[:portlet]
+
+      super(params)
+
+      self.preferences ||= '<portlet-preferences />'
+      self.ownerid     ||= 0 # ??
+      self.ownertype   ||= 3 # ??
+
+      # since the instance in not yet saved, the portletid might be integer
+      portlet ||= Web::Portlet.find_by_portletid("#{self.portletid}")
+      if portlet
+        self.portlet = portlet # instantiates if applicaple
+      else
+        # nil is most likely an error. the portlet database is not populated?
+        # in this case default to fallback action and instantiate the portlet.
+        self.portletid = self.class.instance_id(self.portletid)
+      end
+      self
+    end
+
+    # generates a random instance id
+    def self.instance_id(portletid)
+      '%s_INSTANCE_%s' % [portletid, random_string(4)]
+    end
+
+    # Defines the portlet that the preferences describe.
+    # Instantiates if the portlet can instantiated.
+    def portlet=(portlet)
+      self.portletid = (
+        portlet.instanceable? ?
+          self.class.instance_id(portlet.portletid) : portlet.portletid
+      )
+    end
+
+    # The Web::Portlet of this "preferences".
+    def portlet
+      unless @portlet
+        unless self.companyid
+          logger.warn 'Requested portlet of portletpreferences -- yet no companyid could be fetched.'
+          @portlet = nil
+        else
+          logger.debug 'ok'
+          logger.debug self.portlet_id
+          @portlet = Web::Portlet.find(:first,
+            :conditions => "companyid=#{self.companyid} AND portletid='#{self.portlet_id}'")
+        end
+      end
+      logger.debug @portlet.inspect
+      return @portlet
+    end
+
+    # Various static properties of the portlet instance and the portlet in general.
+    # Requires custom migrations for PortletProperties.
+    # The tables within are filled by Caterpillar, since it knows the location of the
+    # portlet XML files.
+    #
+    # This is intentionally duplicated for Web::Portlet to minimize database queries.
+    def properties
+      unless @properties
+        @properties = Web::PortletProperties.find_by_portletid(self.portlet_id)
+      end
+      return @properties
+    end
+
+    # The portletid of the Web::Portlet. <tt>portletid</tt> is still the actual portletid of the instance.
+    def portlet_id
       self.portletid.split(/_INSTANCE_/)[0]
     end
 
-    # primkey in resource_ table
+    # the 4-char random string
+    def instance_id
+      self.portletid.split(/_INSTANCE_/)[1]
+    end
+
+    # The default title string that is displayed. Requires custom migrations for PortletProperties.
+    # Rails-portlets override this, with the value of <head><title>.
+    # There are no Ruby setters yet, this value is read-only.
+    #
+    # TODO: parse self.preferences:
+    # <portlet-preferences>
+    #   <preference>
+    #     <name>portlet-setup-title-fi_FI</name>
+    #     <value>my custom title</value>
+    #   </preference>
+    #   <preference>
+    #     <name>portlet-setup-use-custom-title</name>
+    #     <value>true</value>
+    #   </preference>
+    # </portlet-preferences>
+    def title
+      self.properties ?
+        self.properties.title : ''
+    end
+
+    # Portlet's JSR286 name.
+    #
+    # Requires custom migrations for PortletProperties. Defaults to portlet's portletid.
+    #
+    def name
+      self.properties ?
+        self.properties.name : self.portlet_id
+    end
+
+    # primkey is the foreign key in the resource_ table.
     def primkey
+      logger.debug 'primkey'
       "#{self.plid}_LAYOUT_#{self.portletid}"
     end
 
-    # argument plid is to comply API with Web::Portlet.resource
-    def resource(plid=nil)
-      Resource.find_by_primkey(self.primkey)
-  #     Resource.find(:all, :conditions => "primkey='#{self.primkey}'")
+    # Parses the preferences string to an XML structure
+    def to_xml
+      REXML::Document.new(self.preferences)
     end
 
-    # loads the preferences XML structure to Ruby Hash
-    def preferences_
-      xml = REXML::Document.new(self.preferences)
+    # Translates the preferences XML structure to Array of Hashes.
+    def to_a
       preferences = []
-      xml.elements.each("portlet-preferences/preference") do |pref|
+      self.to_xml.elements.each("portlet-preferences/preference") do |pref|
         phash = {
           :name  => pref.elements["name"].text,
           :value => (pref.elements["value"] ? pref.elements["value"].text : "")
@@ -42,5 +171,39 @@ module Web
       return preferences
     end
 
+    attr_writer :companyid
+
+    # @companyid can be set temporarily.
+    # if layout is set, its companyid is used.
+    def companyid
+      ( self.layout ? self.layout.companyid : @companyid
+      ) or nil
+    end
+
+    # Override acts_as_resourceful. Use portlet's portletid (without INSTANCE) as the ResourceCode name.
+    def resource_code(scope=4)
+      ResourceCode.get({
+        :companyid => self.companyid,
+        :name      => self.portlet_id,
+        :scope     => scope
+      })
+    end
+
+    def scope2_primkey
+      self.layout ?
+        self.layout.groupid : nil
+    end
+
+    def scope4_primkey
+      self.primkey
+    end
+
+    private
+
+    def self.random_string(len=10)
+      chars = ('a'..'z').to_a + ('A'..'Z').to_a
+      (0...len).collect { chars[Kernel.rand(chars.length)] }.join
+    end
+
   end
 end

data/lib/web/portlet_properties.rb

@@ -0,0 +1,32 @@
+module Web # :nodoc:
+  # This table is not in the original lportal database.
+  # This is created by a ActiveRecord migration and contains metadata about portlets.
+  class PortletProperties < ActiveRecord::Base
+    set_table_name       :portletproperties
+
+    # Returns a portlet from a random company unless @companyid is set.
+    def portlet
+      unless @portlet
+        conditions = ["portletid='#{self.portletid}'"]
+        conditions << "companyid=#{@companyid}" if @companyid
+        @portlet = Web::Portlet.find(:first, :conditions => conditions.join(' AND '))
+        unless @portlet
+          # create
+          p = Web::Portlet.create(
+            :portletid => self.portletid
+          )
+          if @companyid
+            p.companyid = @companyid
+            p.save
+          end
+          @portlet = p.reload
+        end
+      end
+      return @portlet
+    end
+
+    # @companyid can be set temporarily.
+    attr_accessor :companyid
+
+  end
+end