lportal 1.0.7 → 1.0.8

data/lib/role.rb

@@ -2,6 +2,163 @@ class Role < ActiveRecord::Base
   set_table_name       :role_
   set_primary_key      :roleid
 
+  validates_uniqueness_of :name, :scope => 'companyid'
+
+  # com.liferay.portal.model.Role
+  def liferay_class
+    'com.liferay.portal.model.Role'
+  end
+
+  # Actions for Permissions.
+  def self.actions
+    %w{
+      ASSIGN_MEMBERS
+      DEFINE_PERMISSIONS
+      DELETE
+      MANAGE_ANNOUNCEMENTS
+      PERMISSIONS
+      UPDATE
+      VIEW
+    }
+  end
+
+  # Creates a new role.
+  #
+  # 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
+  #  - name
+  def initialize(params)
+    raise 'No companyid given' unless (params[:companyid] or params[:company])
+    raise 'No name given' unless params[:name]
+
+    super(params)
+
+    # COPY role_ (roleid, companyid, classnameid, classpk, name, description, type_) FROM stdin;
+    # +10151	10109	0	0	Regular role	This role is a test	1
+
+    self.classnameid ||= 0
+    self.classpk     ||= 0
+    self.description ||= ''
+    # Type: 1 = regular, 2 = community, 3 = organization
+    self.type_       ||= 1
+
+    self.save
+
+    # Resource with code scope 1 is primkey'd to company.
+    # Resource with code scope 4 is primkey'd to this role.
+
+    # These are created regardless of what type_ is.
+
+    # COPY resourcecode (codeid, companyid, name, scope) FROM stdin;
+    # +29	10109	com.liferay.portal.model.Role	1
+    # +30	10109	com.liferay.portal.model.Role	4
+
+    [1,4].each do |scope|
+      rc = self.resource_code(scope)
+      unless rc
+        ResourceCode.create(
+          :companyid => self.companyid,
+          :name      => self.liferay_class,
+          :scope     => scope
+        )
+      end
+    end
+
+    # COPY resource_ (resourceid, codeid, primkey) FROM stdin;
+    # +33	29	10109
+    # +34	30	10151
+
+    rc = self.resource_code(1)
+    raise 'Required ResourceCode not found' unless rc
+    r = Resource.find(:first, :conditions => "codeid=#{rc.id} AND primkey='#{self.companyid}'")
+    unless r
+      Resource.create(
+        :codeid  => rc.id,
+        :primkey => self.companyid
+      )
+    end
+
+    rc = self.resource_code(4)
+    raise 'Required ResourceCode not found' unless rc
+    r = Resource.create(
+      :codeid  => rc.id,
+      :primkey => self.id
+    )
+
+    # Permissions (given to administrators)
+
+    #  COPY permission_ (permissionid, companyid, actionid, resourceid) FROM stdin;
+    # +70     10109   ASSIGN_MEMBERS  34
+    # +71     10109   DEFINE_PERMISSIONS      34
+    # +72     10109   DELETE  34
+    # +73     10109   MANAGE_ANNOUNCEMENTS    34
+    # +74     10109   PERMISSIONS     34
+    # +75     10109   UPDATE  34
+    # +76     10109   VIEW    34
+
+    # COPY users_permissions (userid, permissionid) FROM stdin;
+    # +10129	70
+    # +10129	71
+    # +10129	72
+    # +10129	73
+    # +10129	74
+    # +10129	75
+    # +10129	76
+
+    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
+
+  def destroy_without_callbacks
+    unless new_record?
+      rc = self.resource_code(4)
+      if rc
+        r = Resource.find(:first, :conditions => "codeid=#{rc.id} AND primkey='#{self.id}'")
+        if r
+          self.class.actions.each do |actionid|
+            p = Permission.find(:first,
+              :conditions => "companyid=#{self.companyid} AND actionid='#{actionid}' AND resourceid=#{r.id}")
+            next unless p
+            p.users.each do |user|
+              user.user_permissions.delete(p)
+            end
+            p.groups.each do |group|
+              group.permissions.delete(p)
+            end
+            p.destroy
+          end
+          r.destroy
+        end
+        rc.destroy
+      end
+
+      self.users.each do |user|
+        user.roles.delete(self)
+      end
+
+      self.groups.each do |group|
+        group.roles.delete(self)
+      end
+
+      super
+
+    end
+    freeze
+  end
+
+
+
   belongs_to :company,
     :foreign_key => "companyid"
 
@@ -16,4 +173,16 @@ class Role < ActiveRecord::Base
                            :foreign_key             => "roleid",
                            :association_foreign_key => "userid"
 
+  # association to users
+  has_and_belongs_to_many  :groups,
+                           :join_table              => "groups_roles",
+                           :foreign_key             => "roleid",
+                           :association_foreign_key => "groupid"
+
+  # 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
+
 end

data/lib/tag/asset.rb

@@ -33,13 +33,13 @@ module Tag
       [
         BlogPost,
         Wiki::Page,
-        MB::Message,
+#         MB::Message,
         Journal::Article,
         DlFile,
         IG::Image,
         Bookmark::Entry,
-        Group,
-        DlFolder
+#         Group,
+#         DlFolder
       ]
     end
 
@@ -69,5 +69,18 @@ module Tag
       end
     end
 
+    # label (logic to fetch non-empty title)
+    def label
+      return self.title if self.title.any?
+
+      # fallback to the name of the resource
+      if self.resource.respond_to?(:name) && self.resource.name.any?
+        return self.resource.name
+      else
+        STDERR.puts 'Asset %i has no title' % self.id
+        return ''
+      end
+    end
+
   end
 end

data/lib/tag/entry.rb

@@ -22,6 +22,7 @@ module Tag
 
     # association to assets
     has_and_belongs_to_many  :assets,
+      :class_name              => 'Tag::Asset',
       :join_table              => 'tagsassets_tagsentries',
       :foreign_key             => 'entryid',
       :association_foreign_key => 'assetid'

data/lib/user.rb

@@ -4,24 +4,42 @@ class User < ActiveRecord::Base
   set_primary_key      :userid
 
   validates_uniqueness_of :uuid_
-  validates_uniqueness_of :emailaddress
-  validates_uniqueness_of :screenname
+  validates_uniqueness_of :emailaddress, :scope => :companyid
+  validates_uniqueness_of :screenname, :scope => :companyid
 
   public
 
   # com.liferay.portal.model.User
-  def liferay_class
+  def self.liferay_class
     'com.liferay.portal.model.User'
   end
 
+  # FIXME: move all references from instance method to class method
+  def liferay_class
+    self.class.liferay_class
+  end
+
+  # Actions for Permissions.
+  def self.actions
+    %w{ DELETE IMPERSONATE PERMISSIONS UPDATE VIEW }
+  end
+
   # Creates a new user.
   #
   # It is a complicated process, as Liferay inserts new data into many tables.
-  # This process is figured by creating a new user with Liferay's (v. 5.1.1) tools and
-  # inspected by diff'ing the database dump.
+  # 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
+  #  - firstname
+  #  - lastname
+  #  - emailaddress
   def initialize(params)
+    raise 'No companyid given' unless (params[:companyid] or params[:company])
     raise 'No firstname' unless params[:firstname]
     raise 'No lastname' unless params[:lastname]
+    raise 'No emailaddress' unless params[:emailaddress]
     # Do not create Contact before creating self!
     firstname = params.delete(:firstname)
     lastname = params.delete(:lastname)
@@ -31,6 +49,9 @@ class User < ActiveRecord::Base
 
     super(params)
 
+    # COPY user_ (uuid_, userid, companyid, createdate, modifieddate, defaultuser, contactid, password_, passwordencrypted, passwordreset, passwordmodifieddate, gracelogincount, screenname, emailaddress, openid, portraitid, languageid, timezoneid, greeting, comments, logindate, loginip, lastlogindate, lastloginip, lastfailedlogindate, failedloginattempts, lockout, lockoutdate, agreedtotermsofuse, active_) FROM stdin;
+    # +c130e60d-d85a-40b8-b778-e0c0c868e508	10164	10109	2009-01-15 00:51:58.558	2009-01-15 00:51:58.558	f	10165	jGrep/LZ9ghV6N1IJ5iWcH3d4ps=	t	f	\N	0	teppo	teppo@localhost.localdomain		0	en_US	GMT	Welcome Teppo Testaaja!		\N		\N		\N	0	f	\N	f	t
+
     # insert data into user_
     unless self.uuid_
       require 'rubygems'
@@ -65,6 +86,10 @@ class User < ActiveRecord::Base
     self.reload
 
     # create new contact
+
+    # COPY contact_ (contactid, companyid, userid, username, createdate, modifieddate, accountid, parentcontactid, firstname, middlename, lastname, prefixid, suffixid, male, birthday, smssn, aimsn, facebooksn, icqsn, jabbersn, msnsn, myspacesn, skypesn, twittersn, ymsn, employeestatusid, employeenumber, jobtitle, jobclass, hoursofoperation) FROM stdin;
+    # +10165	10109	10129	Test Test	2009-01-15 00:51:58.558	2009-01-15 00:51:58.558	10110	0	Teppo		Testaaja	0	0	t	1970-01-01 00:00:00						
+
     if male.is_a?(String)
       male = (male=='true')
     end
@@ -76,20 +101,20 @@ class User < ActiveRecord::Base
       :male => male
     })
 
-    # organization membership
-    org = self.company.organizations.select{|o| o.parent==nil}.first
-    self.organizations << org
-
-    org_role = Role.find(:first, :conditions => "companyid=#{self.companyid} AND name='Organization Member'")
-    group = org.group
+    # assign "User" and "Power User" roles
 
-    # can ActiveRecord handle 3-way associations?
-    ActiveRecord::Base.connection.execute(
-      "INSERT INTO usergrouprole (userid, groupid, roleid) VALUES (%i, %i, %i);" % [
-        self.id, org.group.id, org_role.id])
+    # COPY users_roles (userid, roleid) FROM stdin;
+    # +10164	10116
+    # +10164	10117
 
+    self.roles << Role.find(:first, :conditions => "companyid=#{self.companyid} AND name='User'")
+    self.roles << Role.find(:first, :conditions => "companyid=#{self.companyid} AND name='Power User'")
 
     # Personal group
+
+    # COPY group_ (groupid, companyid, creatoruserid, classnameid, classpk, parentgroupid, livegroupid, name, description, type_, typesettings, friendlyurl, active_) FROM stdin;
+    # +10166	10109	10164	10034	10164	0	0			0		/teppo	t
+
     g = Group.create(
       :companyid     => self.companyid,
       :creatoruserid => self.id,
@@ -98,26 +123,24 @@ class User < ActiveRecord::Base
       :friendlyurl   => '/'+self.screenname
     )
 
-    # assign "User" and "Power User" roles
-    self.roles << Role.find(:first, :conditions => "companyid=#{self.companyid} AND name='User'")
-    self.roles << Role.find(:first, :conditions => "companyid=#{self.companyid} AND name='Power User'")
+    # Group's public + private layoutsets (should be created only for Power Users?)
+    # are created in the Group model.
 
-    # Group's layoutset (only for Power Users)
-    # public + private
-    [true, false].each do |privacy|
-      Web::LayoutSet.create(
-        :groupid       => g.id,
-        :companyid     => self.companyid,
-        :privatelayout => privacy
-      )
-    end
+    # COPY layoutset (layoutsetid, groupid, companyid, privatelayout, logo, logoid, themeid, colorschemeid, wapthemeid, wapcolorschemeid, css, pagecount, virtualhost) FROM stdin;
+    # +10167	10166	10109	t	f	0		01	mobile	01		0	
+    # +10168	10166	10109	f	f	0		01	mobile	01		0	
 
-    # scope=4 is a bit of a mystery..
+
+    # scope=4 means that the resource is "owned" by User
     rc = self.resource_code(4)
     raise 'Required ResourceCode not found' unless rc
 
     # insert data into counter_ so that Hibernate won't die
     Counter.increment(:resource, 100)
+
+    # COPY resource_ (resourceid, codeid, primkey) FROM stdin;
+    # +44	5	10164
+
     resource = Resource.create(
       :codeid  => rc.id,
       :primkey => self.id
@@ -125,8 +148,23 @@ class User < ActiveRecord::Base
 
     permissions = []
     # insert data into counter_ so that Hibernate won't die
+
+    # COPY permission_ (permissionid, companyid, actionid, resourceid) FROM stdin;
+    # +114	10109	DELETE	44
+    # +115	10109	IMPERSONATE	44
+    # +116	10109	PERMISSIONS	44
+    # +117	10109	UPDATE	44
+    # +118	10109	VIEW	44
+
+    # COPY users_permissions (userid, permissionid) FROM stdin;
+    # +10129	114
+    # +10129	115
+    # +10129	116
+    # +10129	117
+    # +10129	118
+
     Counter.increment(:permission, 100)
-    %w{ DELETE IMPERSONATE PERMISSIONS UPDATE VIEW }.each do |action|
+    self.class.actions.each do |action|
       self.user_permissions << Permission.create(
         :companyid  => self.companyid,
         :actionid   => action,
@@ -135,6 +173,12 @@ class User < ActiveRecord::Base
     end
 
     # announcementsdelivery
+
+    # COPY announcementsdelivery (deliveryid, companyid, userid, type_, email, sms, website) FROM stdin;
+    # +10169	10109	10164	general	f	f	t
+    # +10170	10109	10164	news	f	f	t
+    # +10171	10109	10164	test	f	f	t
+
     %w{ general news test }.each do |type|
       Announcement::Delivery.create(
         :userid    => self.id,
@@ -150,6 +194,7 @@ class User < ActiveRecord::Base
 
     # insert data into phone
     self.gsm=gsm if gsm
+    return self
   end
 
   def save
@@ -248,6 +293,29 @@ class User < ActiveRecord::Base
     user_permissions + group_permissions + role_permissions
   end
 
+
+  # Adds User to Organization members.
+  # TODO: move to Organization
+  #
+  # Updates users_organizations, adds the 'Organization Member' Role,
+  # and updates 3-way associations to usergrouprole.
+  def assign_organization_membership(org)
+    # organization membership
+    org = self.company.organizations.select{|o| o.parent==nil}.first
+    self.organizations << org
+
+    org_role = Role.find(:first, :conditions => "companyid=#{self.companyid} AND name='Organization Member'")
+    group = org.group
+
+    # can ActiveRecord handle 3-way associations?
+    ActiveRecord::Base.connection.execute(
+      "INSERT INTO usergrouprole (userid, groupid, roleid) VALUES (%i, %i, %i);" % [
+        self.id, org.group.id, org_role.id])
+
+    true
+  end
+
+
   # Fullname is fetched from Contact
   def name
     self.contact ?
@@ -344,19 +412,23 @@ class User < ActiveRecord::Base
     true
   end
 
+  # Perhaps it would make more sense to select phones with classnameid of "mobile"
   def gsm
     self.phones.any? ? self.phones.first.number : nil
   end
   # Creates a new Phone unless it exists
   def gsm=(number)
+    _number = self.class.cleanup_mobile_number(number)
+    return false if _number.empty? # no not save empty numbers
+
     if self.phones.any?
       phone = self.phones.first
-      phone.number=number
+      phone.number=_number
       phone.save
     else
       Phone.create(
         :userid => self.id,
-        :number_ => number,
+        :number_ => _number,
         :primary_ => true
       )
       self.phones.reload
@@ -364,6 +436,11 @@ class User < ActiveRecord::Base
     true
   end
 
+  # This method is meant to be overridden in custom configurations.
+  def self.cleanup_mobile_number(number)
+    return number
+  end
+
   def birthday
     self.contact.birthday
   end
@@ -420,5 +497,33 @@ class User < ActiveRecord::Base
   end
   alias :is_guest? :is_default?
 
+  # Activates inactive users. Makes it easy to extend functionality with mixins (to send email, for example).
+  def activate
+    self.active_ = true
+    self.save
+    self.class.instance_method_already_implemented?(:activate) ?
+      super : true
+  end
+
+  # Deactivates active users
+  def deactivate
+    self.active_ = false
+    self.save
+    self.class.instance_method_already_implemented?(:deactivate) ?
+      super : true
+  end
+
+  # URL path to this User's public or private page
+  def path(pl=:public)
+    self.hive.nil? ? nil : self.hive.path(pl)
+  end
+
+  # URL to user's portrait (needs to be prefixed with Liferay server URL).
+  # Unless the user has a portrait, a default image should be displayed.
+  def portrait_path
+    path = '/image/user_%s_portrait' % (self.contact.male ? 'male' : 'female')
+    path << "?img_id=#{self.portraitid}" if self.portraitid != 0
+    return path
+  end
 
 end

data/lib/web/layout.rb

@@ -5,11 +5,149 @@ module Web
     set_table_name       :layout
     set_primary_key      :plid
 
+    validates_uniqueness_of :layoutid, :scope => [:groupid, :privatelayout]
+
+
     # com.liferay.portal.model.Layout
     def liferay_class
       'com.liferay.portal.model.Layout'
     end
 
+    # Actions for Permissions.
+    def self.actions
+      %w{
+      ADD_DISCUSSION
+      UPDATE
+      VIEW
+      }
+    end
+
+    # Creates a new Layout.
+    #
+    # 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
+    #  - privatelayout (true or false)
+    #
+    # Optional extra parameters:
+    #  - locale
+    def initialize(params)
+      raise 'No groupid given' unless (params[:groupid] or params[:group])
+      raise 'No privatelayout given' if params[:privatelayout].nil?
+      _name = params.delete(:name) || 'New layout'
+      _locale = params[:locale] || 'en_US'
+
+      super(params)
+
+      # COPY layout (plid, groupid, companyid, privatelayout, layoutid, parentlayoutid, name, title, description, type_, typesettings, hidden_, friendlyurl, iconimage, iconimageid, themeid, colorschemeid, wapthemeid, wapcolorschemeid, css, priority, dlfolderid) FROM stdin;
+      # +10301	10166	10109	f	1	0	<?xml version='1.0' encoding='UTF-8'?><root available-locales="en_US" default-locale="en_US"><name language-id="en_US">frontpage</name></root>	<root />		portlet	layout-template-id=2_columns_ii\n	f	/1	f	0						0	0
+
+      self.companyid = self.group.companyid
+
+      name = "<?xml version='1.0' encoding='UTF-8'?>"
+      name += '<root available-locales="%s" default-locale="%s">' % [_locale, _locale]
+      name += '<name language-id="%s">' % _locale
+      name += _name
+      name += '</name></root>'
+      self.name = name
+
+      # 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)
+
+      # increment pagecount
+      _set = self.layoutset
+      _set.pagecount += 1
+      _set.save
+
+      self.friendlyurl    ||= '/'+self.layoutid.to_s
+      self.type_          ||= 'portlet'
+      self.typesettings   ||= Web::Typesettings.new.to_s # 'bout to change
+      self.title          ||= '<root />'
+      self.description    ||= ''
+      self.parentlayoutid ||= 0
+      self.priority       ||= 0
+      self.dlfolderid     ||= 0
+      self.iconimageid    ||= 0
+      self.iconimage = false if self.iconimage.nil?
+      self.hidden_ = false if self.hidden_.nil?
+
+      self.save
+
+      #####
+      # Group 10166 is a private group of User 10164.
+      # 10129 is the Company's admin. 10111 is Guest.
+      #####
+
+      # Create a resource with scope=2 for the Group.
+
+      # COPY resource_ (resourceid, codeid, primkey) FROM stdin;
+      # +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
+
+      # 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
+      )
+
+      # COPY permission_ (permissionid, companyid, actionid, resourceid) FROM stdin;
+      # +301	10109	ADD_DISCUSSION	202
+      # +302	10109	UPDATE	202
+      # +303	10109	VIEW	202
+
+      self.class.actions.each do |actionid|
+        p = Permission.create(
+          :companyid  => self.companyid,
+          :actionid   => actionid,
+          :resourceid => resource.id
+        )
+
+        # COPY users_permissions (userid, permissionid) FROM stdin;
+        # +10129	301
+        # +10129	302
+        # +10129	303
+        # +10111	303
+
+        self.company.administrators.each do |user|
+          user.user_permissions << p
+        end
+
+        # COPY groups_permissions (groupid, permissionid) FROM stdin;
+        # +10166	301
+        # +10166	303
+        group = self.group
+        self.group.permissions << p
+      end
+      return self
+    end
+
     public
 
     belongs_to :group,
@@ -72,5 +210,15 @@ module Web
       self.layoutset.url_prefix + self.group.friendlyurl + self.friendlyurl
     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
+
+    def contents
+      Typesettings.new(self.typesettings)
+    end
+
   end
 end

data/lib/web/portlet_preferences.rb

@@ -23,7 +23,7 @@ module Web
     end
 
     # argument plid is to comply API with Web::Portlet.resource
-    def resource(plid)
+    def resource(plid=nil)
       Resource.find_by_primkey(self.primkey)
   #     Resource.find(:all, :conditions => "primkey='#{self.primkey}'")
     end