sakai-info 0.1.0

data/lib/sakai-info/sakai_object.rb

@@ -0,0 +1,58 @@
+# sakai_object.rb
+#   SakaiInfo::SakaiObject
+#
+# Created 2012-02-15 daveadams@gmail.com
+# Last updated 2012-02-18 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  # this class forms the basis of all other Sakai object abstractions
+  class SakaiObject
+    # most objects will have unique IDs
+    # (perhaps the rest should generate their own?)
+    attr_reader :id
+
+    def serialize(*q)
+      q.flatten!
+
+      if q.length == 0
+        q = [:default]
+      end
+
+      serialization = {}
+      q.each do |sub|
+        sub_method_name = (sub.to_s + "_serialization").to_sym
+        begin
+          sub_method = self.method(sub_method_name)
+          serialization = serialization.merge(sub_method.call)
+        rescue NameError
+          # ignore any missing serialization patterns
+        end
+      end
+
+      serialization
+    end
+
+    def object_type_serialization
+      {
+        "sakai_object_type" => self.class
+      }
+    end
+
+    def default_serialization
+      object_type_serialization
+    end
+
+    def to_yaml
+      serialize.to_yaml
+    end
+
+    def to_json
+      serialize.to_json
+    end
+  end
+end

data/lib/sakai-info/sakai_xml_entity.rb

@@ -0,0 +1,126 @@
+# sakai_xml_entity.rb
+#   SakaiInfo::SakaiXMLEntity
+#
+# Created 2012-02-16 daveadams@gmail.com
+# Last updated 2012-02-18 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  # exception class for unrecognized property encodings
+  class UnrecognizedPropertyEncodingException < SakaiException
+    attr_reader :name, :encoding, :value
+
+    def initialize(name, encoding, value)
+      @name = name
+      @encoding = encoding
+      @value = value
+
+      super("Unrecognized property encoding '#{@encoding}' for property '#{@name}'")
+    end
+  end
+
+  # This class is the base for Sakai XML-based entities, which are many of the
+  # earliest data types in the Sakai database. Most properties of these objects
+  # are stored in a large XML clob/text field, and some are base64-encoded as
+  # well. Thus each record must be deserialized to read the various properties.
+  #
+  # Most XML entities consist of a top-level tag representing the entity with
+  # a number of attributes attached representing some of the properties of the
+  # entity. And then there are "property" tags inside the top-level tag
+  # which represent some other properties, including some defaults recording
+  # the creator and modifier and the times of those accesses.
+  #
+  # This class extends SakaiObject and implements some additional
+  # serialization methods to reflect the common elements of XML entities.
+  class SakaiXMLEntity < SakaiObject
+    attr_reader :xml, :xmldoc, :attributes, :properties
+
+    private
+    # this method parses the universal XML field for all entities
+    # down to two collections: attributes (XML attributes defined in the
+    # top-level tag) and properties (<property> tags inside the top-level
+    # tag). Properties are generally base64 encoded
+    def parse_xml
+      @xmldoc = REXML::Document.new(@xml)
+      @attributes = {}
+      @xmldoc.root.attributes.keys.each do |att_name|
+        @attributes[att_name] = @xmldoc.root.attributes[att_name]
+      end
+
+      @properties = {}
+      REXML::XPath.each(@xmldoc, "//property") do |prop_node|
+        prop_name = prop_node.attributes["name"]
+        prop_encoding = prop_node.attributes["enc"]
+        prop_value = prop_node.attributes["value"]
+
+        if prop_encoding == "BASE64"
+          prop_value = Base64.decode64(prop_value)
+        else
+          raise UnrecognizedPropertyEncodingException(prop_name, prop_encoding, prop_value)
+        end
+        @properties[prop_name] = prop_value
+      end
+    end
+
+    def format_entity_date(raw)
+      raw.gsub(/^(....)(..)(..)(..)(..)(..).*$/, '\1-\2-\3 \4:\5:\6')
+    end
+
+    public
+    # standard property for all entities
+    def created_by
+      @created_by ||= User.find(@properties["CHEF:creator"])
+    end
+
+    # standard property for all entities
+    def modified_by
+      @modified_by ||= User.find(@properties["CHEF:modifiedby"])
+    end
+
+    # standard property for all entities
+    def created_at
+      format_entity_date(@properties["DAV:creationdate"])
+    end
+
+    # standard property for all entities
+    def modified_at
+      format_entity_date(@properties["DAV:getlastmodified"])
+    end
+
+    # by default, serialize all the common properties
+    def default_serialization
+      {
+        "id" => self.id,
+        "created_by" => self.created_by,
+        "created_at" => self.created_at,
+        "modified_by" => self.modified_by,
+        "modified_at" => self.modified_at
+      }
+    end
+
+    # serialize all attributes
+    def attributes_serialization
+      {
+        "attributes" => @attributes
+      }
+    end
+
+    # serialize all properties
+    def properties_serialization
+      {
+        "properties" => @properties
+      }
+    end
+
+    # xml dump serialization option
+    def xml_serialization
+      {
+        "xml" => xml
+      }
+    end
+  end
+end

data/lib/sakai-info/samigo.rb

@@ -0,0 +1,219 @@
+# sakai-info/samigo.rb
+#   SakaiInfo::Samigo library
+#
+# Created 2012-02-17 daveadams@gmail.com
+# Last updated 2012-02-18 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class PendingQuiz < SakaiObject
+    attr_reader :title, :site
+
+    def initialize(id, title, site)
+      @id = id
+      @title = title
+      @site = site
+    end
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        DB.connect.exec("select title, agent_id from sam_assessmentbase_t " +
+                        "where id=:quizid", id) do |row|
+          @@cache[id] = PendingQuiz.new(id, row[0], Site.find(row[1]))
+        end
+        if @@cache[id].nil?
+          raise ObjectNotFoundException.new(PendingQuiz, id)
+        end
+      end
+      @@cache[id]
+    end
+
+    def self.find_by_site_id(site_id)
+      results = []
+      site = Site.find(site_id)
+      DB.connect.exec("select id, title from sam_assessmentbase_t " +
+                      "where id in (select qualifierid from sam_authzdata_t " +
+                      "where agentid=:site_id and " +
+                      "functionid='EDIT_ASSESSMENT')", site_id) do |row|
+        @@cache[row[0]] = PendingQuiz.new(row[0].to_i, row[1], site)
+        results << @@cache[row[0]]
+      end
+      results
+    end
+
+    def self.count_by_site_id(site_id)
+      count = 0
+      DB.connect.exec("select count(*) from sam_publishedassessment_t " +
+                      "where id in (select qualifierid from sam_authzdata_t " +
+                      "where agentid=:site_id and " +
+                      "functionid='EDIT_ASSESSMENT')", site_id) do |row|
+        count = row[0].to_i
+      end
+      count
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "site_id" => self.site.id
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title
+      }
+    end
+  end
+
+  class PublishedQuiz < SakaiObject
+    attr_reader :title, :site
+
+    def initialize(id, title, site)
+      @id = id
+      @title = title
+      @site = site
+    end
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        DB.connect.exec("select title, agent_id from sam_publishedassessment_t " +
+                        "where id=:quizid", id) do |row|
+          @@cache[id] = PublishedQuiz.new(id, row[0], Site.find(row[1]))
+        end
+        if @@cache[id].nil?
+          raise ObjectNotFoundException.new(PublishedQuiz, id)
+        end
+      end
+      @@cache[id]
+    end
+
+    def self.find_by_site_id(site_id)
+      results = []
+      site = Site.find(site_id)
+      DB.connect.exec("select id, title from sam_publishedassessment_t " +
+                      "where id in (select qualifierid from sam_authzdata_t " +
+                      "where agentid=:site_id and " +
+                      "functionid='OWN_PUBLISHED_ASSESSMENT')", site_id) do |row|
+        @@cache[row[0]] = PublishedQuiz.new(row[0].to_i, row[1], site)
+        results << @@cache[row[0]]
+      end
+      results
+    end
+
+    def self.count_by_site_id(site_id)
+      count = 0
+      DB.connect.exec("select count(*) from sam_publishedassessment_t " +
+                      "where id in (select qualifierid from sam_authzdata_t " +
+                      "where agentid=:site_id " +
+                      "and functionid='OWN_PUBLISHED_ASSESSMENT')", site_id) do |row|
+        count = row[0].to_i
+      end
+      count
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "site_id" => self.site.id
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title
+      }
+    end
+  end
+
+  class QuestionPool < SakaiObject
+    attr_reader :title, :owner
+
+    def initialize(id, title, owner)
+      @id = id
+      @title = title
+      @owner = owner
+    end
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        DB.connect.exec("select title, ownerid from sam_questionpool_t " +
+                        "where questionpoolid=:id", id) do |row|
+          @@cache[id] = QuestionPool.new(id, row[0], User.find(row[1]))
+        end
+        if @@cache[id].nil?
+          raise ObjectNotFoundException.new(QuestionPool, id)
+        end
+      end
+      @@cache[id]
+    end
+
+    def self.find_by_user_id(user_id)
+      results = []
+      user = User.find(user_id)
+      DB.connect.exec("select questionpoolid, title from sam_questionpool_t " +
+                      "where ownerid=:userid", user_id) do |row|
+        @@cache[row[0]] = QuestionPool.new(row[0].to_i, row[1], user)
+        results << @@cache[row[0]]
+      end
+      results
+    end
+
+    def self.count_by_user_id(user_id)
+      count = 0
+      DB.connect.exec("select count(*) from sam_questionpool_t " +
+                      "where ownerid=:userid", user_id) do |row|
+        count = row[0].to_i
+      end
+      count
+    end
+
+    def item_count
+      if @item_count.nil?
+        DB.connect.exec("select count(*) from sam_questionpoolitem_t " +
+                        "where questionpoolid=:id", @id) do |row|
+          @item_count = row[0].to_i
+        end
+      end
+      @item_count
+    end
+
+    # serialization
+    def default_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "owner" => self.owner.serialize(:summary),
+        "item_count" => self.item_count
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "owner_eid" => self.owner.eid,
+        "item_count" => self.item_count
+      }
+    end
+
+    def user_summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "item_count" => self.item_count
+      }
+    end
+  end
+end

data/lib/sakai-info/site.rb

@@ -0,0 +1,752 @@
+# sakai-info/site.rb
+#   SakaiInfo::Site library
+#
+# Created 2012-02-17 daveadams@gmail.com
+# Last updated 2012-02-17 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class Site < SakaiObject
+    attr_reader :title, :type
+    attr_reader :created_at, :modified_at
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        site_id = title = type = created_at = created_by_user_id =
+          modified_at = modified_by_user_id = joinable = join_role = nil
+        DB.connect.exec("select site_id, title, type, " +
+                        "createdby, to_char(createdon,'YYYY-MM-DD HH24:MI:SS'), " +
+                        "modifiedby, to_char(modifiedon,'YYYY-MM-DD HH24:MI:SS'), " +
+                        "joinable, join_role " +
+                        "from sakai_site where site_id = :site_id", id) do |row|
+          site_id, title, type, created_by_user_id, created_at, modified_by_user_id, modified_at, joinable_n, join_role = *row
+          if joinable_n.to_i == 1
+            joinable = true
+          else
+            joinable = false
+          end
+        end
+        if site_id.nil?
+          raise ObjectNotFoundException.new(Site, id)
+        end
+        @@cache[id] = Site.new(id, title, type, created_by_user_id, created_at, modified_by_user_id, modified_at, joinable, join_role)
+      end
+      @@cache[id]
+    end
+
+    def initialize(id, title, type, created_by_user_id, created_at, modified_by_user_id, modified_at, joinable, join_role)
+      @id = id
+      @title = title
+      @type = type
+      @created_by_user_id = created_by_user_id
+      @created_at = created_at
+      @modified_by_user_id = modified_by_user_id
+      @modified_at = modified_at
+      @joinable = joinable
+      @join_role_string = join_role.to_s
+    end
+
+    def joinable?
+      @joinable
+    end
+
+    def join_role
+      @join_role_string
+    end
+
+    def properties
+      @properties ||= SiteProperty.find_by_site_id(@id)
+    end
+
+    def membership
+      @membership ||= SiteMembership.find_by_site_id(@id)
+    end
+
+    def pages
+      @pages ||= Page.find_by_site_id(@id)
+    end
+
+    def assignments
+      @assignments ||= Assignment.find_by_site_id(@id)
+    end
+
+    def created_by
+      @created_by ||= User.find(@created_by_user_id)
+    end
+
+    def modified_by
+      @modified_by ||= User.find(@modified_by_user_id)
+    end
+
+    def user_count
+      if @user_count.nil?
+        DB.connect.exec("select count(*) from sakai_site_user " +
+                        "where site_id=:siteid", @id) do |row|
+          @user_count = row[0].to_i
+        end
+      end
+      @user_count
+    end
+
+    def page_count
+      if @page_count.nil?
+        DB.connect.exec("select count(*) from sakai_site_page " +
+                        "where site_id=:siteid", @id) do |row|
+          @page_count = row[0].to_i
+        end
+      end
+      @page_count
+    end
+
+    def assignment_count
+      @assignment_count ||= Assignment.count_by_site_id(@id)
+    end
+
+    # authz/realm properties
+    def realm
+      @authz_realm ||= AuthzRealm.find_by_site_id(@id)
+    end
+
+    def join_role
+      @join_role ||= AuthzRole.find_by_name(@join_role_string)
+    end
+
+    # group properties
+    def group_count
+      @group_count ||= Group.count_by_site_id(@id)
+    end
+
+    def groups
+      @groups ||= Group.find_by_site_id(@id)
+    end
+
+    # announcement properties
+    def announcements
+      @announcements ||= AnnouncementChannel.find_by_site_id(@id).announcements
+    end
+
+    def announcement_count
+      @announcement_count ||= AnnouncementChannel.find_by_site_id(@id).announcement_count
+    end
+
+    # samigo quiz properties
+    def published_quiz_count
+      @published_quiz_count ||= PublishedQuiz.count_by_site_id(@id)
+    end
+
+    def pending_quiz_count
+      @pending_quiz_count ||= PendingQuiz.count_by_site_id(@id)
+    end
+
+    def published_quizzes
+      @published_quizzes ||= PublishedQuiz.find_by_site_id(@id)
+    end
+
+    def pending_quizzes
+      @pending_quizzes ||= PendingQuiz.find_by_site_id(@id)
+    end
+
+    # gradebook properties
+    def gradebook
+      @gradebook ||= Gradebook.find_by_site_id(@id)
+    rescue ObjectNotFoundException
+      # not all sites have a gradebook, don't panic
+      nil
+    end
+
+    # forum properties
+    def forum_count
+      @forum_count ||= Forum.count_by_site_id(@id)
+    end
+
+    def forums
+      @forums ||= Forum.find_by_site_id(@id)
+    end
+
+    # content properties
+    def resource_storage
+      resource_collection_id = "/group/#{@id}/"
+      if @type == "myworkspace" or @type == "guestworkspace"
+        resource_collection_id = "/user/#{@id.sub(/^~/,'')}"
+      end
+      @resource_storage ||= ContentCollection.find!(resource_collection_id)
+    end
+
+    def attachment_storage
+      attachment_collection_id = "/attachment/#{@id}/"
+      @attachment_storage ||= ContentCollection.find!(attachment_collection_id)
+    end
+
+    def melete_storage
+      melete_collection_id = "/private/meleteDocs/#{@id}/"
+      @melete_storage ||= ContentCollection.find!(melete_collection_id)
+    end
+
+    def dropbox_storage
+      dropbox_collection_id = "/group-user/#{@id}/"
+      @dropbox_storage ||= ContentCollection.find!(dropbox_collection_id)
+    end
+
+    def total_disk_usage
+      resource_storage.size_on_disk + attachment_storage.size_on_disk + melete_storage.size_on_disk + dropbox_storage.size_on_disk
+    end
+
+    # generate a CSV line for disk usage reporting
+    def disk_usage_csv
+      "#{@id},#{@type},#{resource_storage.size_on_disk},#{attachment_storage.size_on_disk},#{melete_storage.size_on_disk},#{dropbox_storage.size_on_disk},#{total_disk_usage}"
+    end
+
+    # finders/counters
+    @@total_site_count = nil
+    def self.count
+      if @@total_site_count.nil?
+        @@total_site_count = 0
+        DB.connect.exec("select count(*) from sakai_site") do |row|
+          @@total_site_count = row[0].to_i
+        end
+      end
+      @@total_site_count
+    end
+
+    def self.count_by_user_id(user_id)
+      user_count = 0
+      DB.connect.exec("select count(*) from sakai_site_user " +
+                      "where user_id=:user_id", user_id) do |row|
+        user_count = row[0].to_i
+      end
+      user_count
+    end
+
+    def self.count_by_type(type)
+      type_count = 0
+      DB.connect.exec("select count(*) from sakai_site " +
+                      "where type=:type", type) do |row|
+        type_count = row[0].to_i
+      end
+      type_count
+    end
+
+    def self.count_by_semester(term_eid)
+      prop_name = "term_eid"
+      sem_count = 0
+      DB.connect.exec("select count(*) from sakai_site_property " +
+                      "where name=:name and to_char(value)=:term_eid",
+                      prop_name, term_eid) do |row|
+        sem_count = row[0].to_i
+      end
+      sem_count
+    end
+
+    def self.find_all_ids
+      ids = []
+      DB.connect.exec("select site_id from sakai_site") do |row|
+        ids << row[0]
+      end
+      ids
+    end
+
+    def self.find_all_workspace_ids
+      ids = []
+      DB.connect.exec("select site_id from sakai_site where site_id like '~%'") do |row|
+        ids << row[0]
+      end
+      ids
+    end
+
+    def self.find_all_non_workspace_ids
+      ids = []
+      DB.connect.exec("select site_id from sakai_site where site_id not like '~%'") do |row|
+        ids << row[0]
+      end
+      ids
+    end
+
+    def self.find_ids_by_type(type)
+      ids = []
+      DB.connect.exec("select site_id from sakai_site where type=:type", type) do |row|
+        ids << row[0]
+      end
+      ids
+    end
+
+    def self.find_by_type(type)
+      sites = []
+      DB.connect.exec("select site_id, title, type, " +
+                      "createdby, to_char(createdon,'YYYY-MM-DD HH24:MI:SS'), " +
+                      "modifiedby, to_char(modifiedon,'YYYY-MM-DD HH24:MI:SS'), " +
+                      "joinable, join_role " +
+                      "from sakai_site where type = :type", type) do |row|
+        joinable = false
+        site_id, title, type, created_by_user_id, created_at,
+        modified_by_user_id, modified_at, joinable_n, join_role = *row
+        if joinable_n.to_i == 1
+          joinable = true
+        end
+        @@cache[site_id] = Site.new(site_id, title, type, created_by_user_id, created_at, modified_by_user_id, modified_at, joinable, join_role)
+        sites << @@cache[site_id]
+      end
+      sites
+    end
+
+    def self.find_ids_by_property(property_name, property_value)
+      SiteProperty.find_site_ids_by_property(property_name, property_value)
+    end
+
+    def self.find_ids_by_semester(term_eid)
+      find_ids_by_property("term_eid", term_eid)
+    end
+
+    # serialization methods
+    def default_serialization
+      result = {
+        "id" => self.id,
+        "title" => self.title,
+        "type" => self.type,
+        "created_at" => self.created_at,
+        "created_by" => self.created_by.serialize(:summary),
+        "site_properties" => self.properties,
+        "providers" => self.realm.providers,
+        "joinable" => self.joinable?,
+        "join_role" => (self.joinable? ? self.join_role : nil),
+        "user_count" => self.user_count,
+        "group_count" => self.group_count,
+        "page_count" => self.page_count,
+        "pending_quiz_count" => self.pending_quiz_count,
+        "published_quiz_count" => self.published_quiz_count,
+        "assignment_count" => self.assignment_count,
+        "announcement_count" => self.announcement_count,
+        "gradebook_item_count" => (self.gradebook.nil? ? 0 : self.gradebook.item_count),
+        "forum_count" => self.forum_count
+      }
+      if result["providers"].nil? or result["providers"] == ""
+        result.delete("providers")
+      end
+      if result["joinable"] == false
+        result.delete("join_role")
+      end
+      if self.gradebook.nil?
+        result.delete("gradebook_item_count")
+      end
+      result
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "type" => self.type,
+        "created_by" => self.created_by.eid
+      }
+    end
+
+    def users_serialization
+      {
+        "users" => self.membership.collect { |sm| sm.serialize(:site_summary) }
+      }
+    end
+
+    def pages_serialization
+      {
+        "pages" => self.pages.collect { |pg| pg.serialize(:summary) }
+      }
+    end
+
+    def groups_serialization
+      {
+        "groups" => self.groups.collect { |grp| grp.serialize(:summary) }
+      }
+    end
+
+    def quizzes_serialization
+      result = {}
+      if self.pending_quiz_count > 0 or self.published_quiz_count > 0
+        result["quizzes"] = {}
+      end
+      if self.pending_quiz_count > 0
+        result["quizzes"]["pending"] =
+          self.pending_quizzes.collect { |pq| pq.serialize(:summary) }
+      end
+      if self.published_quiz_count > 0
+        result["quizzes"]["published"] =
+          self.pending_quizzes.collect { |pq| pq.serialize(:summary) }
+      end
+      result
+    end
+
+    def disk_serialization
+      {
+        "disk_usage" => {
+          "resources" => self.resource_storage.size_on_disk,
+          "attachments" => self.attachment_storage.size_on_disk,
+          "melete" => self.melete_storage.size_on_disk,
+          "dropbox" => self.dropbox_storage.size_on_disk,
+          "total" => (self.resource_storage.size_on_disk +
+                      self.attachment_storage.size_on_disk +
+                      self.melete_storage.size_on_disk +
+                      self.dropbox_storage.size_on_disk)
+        }
+      }
+    end
+
+    def disk_formatted_serialization
+      result = disk_serialization["disk_usage"]
+      result.keys.each do |key|
+        result[key] = format_filesize(result[key])
+      end
+      {
+        "disk_usage" => result
+      }
+    end
+
+    def assignments_serialization
+      if self.assignment_count > 0
+        {
+          "assignments" => self.assignments.collect { |asn| asn.serialize(:summary) }
+        }
+      else
+        {}
+      end
+    end
+
+    def announcements_serialization
+      if self.announcement_count > 0
+        {
+          "announcements" => self.announcements.collect { |annc| annc.serialize(:summary) }
+        }
+      else
+        {}
+      end
+    end
+
+    def gradebook_serialization
+      if self.gradebook and self.gradebook.item_count > 0
+        {
+          "gradebook_items" => self.gradebook.items.collect { |item| item.serialize(:summary) }
+        }
+      else
+        {}
+      end
+    end
+
+    def realm_roles_serialization
+      {
+        "realm_roles" => self.realm.realm_roles.collect { |rr| rr.serialize(:summary) }
+      }
+    end
+
+    def forums_serialization
+      if self.forum_count > 0
+        {
+          "forums" => self.forums.collect { |fr| fr.serialize(:summary) }
+        }
+      else
+        {}
+      end
+    end
+  end
+
+  class SiteProperty
+    def self.get(site_id, property_name)
+      value = nil
+      DB.connect.exec("select value from sakai_site_property " +
+                      "where site_id=:site_id and name=:name",
+                      site_id, property_name) do |row|
+        value = row[0].read
+      end
+      return value
+    end
+
+    def self.find_by_site_id(site_id)
+      properties = {}
+      DB.connect.exec("select name, value from sakai_site_property " +
+                      "where site_id=:site_id", site_id) do |row|
+        name = row[0]
+        value = row[1].read
+        properties[name] = value
+      end
+      return properties
+    end
+
+    def self.find_site_ids_by_property(name, value)
+      ids = []
+      DB.connect.exec("select distinct(site_id) from sakai_site_property " +
+                      "where name=:name " +
+                      "and to_char(value)=:value",
+                      name, value) do |row|
+        ids << row[0]
+      end
+      ids
+    end
+  end
+
+  class Page < SakaiObject
+    attr_reader :title, :order, :layout, :site
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        title = order = layout = site = nil
+        DB.connect.exec("select title, site_order, layout, site_id " +
+                        "from sakai_site_page where page_id = :page_id", id) do |row|
+          title = row[0]
+          order = row[1].to_i
+          layout = row[2]
+          site = Site.find(row[3])
+        end
+        if title.nil?
+          raise ObjectNotFoundException(Page, id)
+        end
+        @@cache[id] = Page.new(id, title, order, layout, site)
+      end
+      @@cache[id]
+    end
+
+    def self.find_by_site_id(site_id)
+      results = []
+      site = Site.find(site_id)
+      DB.connect.exec("select page_id, title, site_order, layout " +
+                      "from sakai_site_page where site_id = :site_id " +
+                      "order by site_order", site_id) do |row|
+        @@cache[row[0]] = Page.new(row[0], row[1], row[2].to_i, row[3], site)
+        results << @@cache[row[0]]
+      end
+      results
+    end
+
+    def initialize(id, title, order, layout, site)
+      @id = id
+      @title = title
+      @order = order
+      @layout = layout
+      @site = site
+    end
+
+    def properties
+      @properties ||= PageProperty.find_by_page_id(@id)
+    end
+
+    def tools
+      @tools ||= Tool.find_by_page_id(@id)
+    end
+
+    # serialization
+    def default_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "order" => self.order,
+        "tools" => self.tools.collect { |tool| tool.serialize(:summary) },
+        "properties" => self.properties,
+        "site_id" => self.site.id
+      }.delete_if do |k,v|
+        k == "properties" && v == {}
+      end
+    end
+
+    def summary_serialization
+      default_serialization.delete_if do |k,v|
+        k == "site_id"
+      end
+    end
+  end
+
+  class PageProperty
+    def self.get(page_id, property_name)
+      value = nil
+      DB.connect.exec("select value from sakai_site_page_property " +
+                      "where page_id=:page_id and name=:name", page_id, property_name) do |row|
+        value = row[0].read
+      end
+      return value
+    end
+
+    def self.find_by_page_id(page_id)
+      properties = {}
+      DB.connect.exec("select name, value from sakai_site_page_property " +
+                      "where page_id=:page_id", page_id) do |row|
+        name = row[0]
+        value = row[1].read
+        properties[name] = value
+      end
+      return properties
+    end
+  end
+
+  class Tool < SakaiObject
+    attr_reader :title, :registration, :order, :layout, :page, :site
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        tool_id = title = registration = page_order = layout_hints = page = nil
+        DB.connect.exec("select tool_id, title, registration, page_order, " +
+                        "layout_hints, page_id " +
+                        "from sakai_site_tool where tool_id = :tool_id", id) do |row|
+          tool_id, title, registration, page_order_s, layout_hints, page_id = *row
+          page_order = page_order_s.to_i
+          page = Page.find(page_id)
+        end
+        if tool_id.nil?
+          raise ObjectNotFoundException.new(Tool, id)
+        end
+        @@cache[id] = Tool.new(tool_id, title, registration, page_order, layout_hints, page)
+      end
+      @@cache[id]
+    end
+
+    def self.find_by_page_id(page_id)
+      results = []
+      page = Page.find(page_id)
+      DB.connect.exec("select tool_id, title, registration, page_order, layout_hints " +
+                      "from sakai_site_tool where page_id = :page_id " +
+                      "order by page_order", page_id) do |row|
+        @@cache[row[0]] = Tool.new(row[0], row[1], row[2], row[3].to_i, row[4], page)
+        results << @@cache[row[0]]
+      end
+      results
+    end
+
+    def initialize(id, title, registration, order, layout, page)
+      @id = id
+      @title = title
+      @registration = registration
+      @order = order
+      @layout = layout
+      @page = page
+      @site = page.site
+    end
+
+    def properties
+      @properties ||= ToolProperty.find_by_tool_id(@id)
+    end
+
+    # serialization
+    def default_serialization
+      result = {
+        "id" => self.id,
+        "registration" => self.registration,
+        "title" => self.title,
+        "site" => self.site.serialize(:summary),
+        "page_id" => self.page.id,
+        "order" => self.order,
+        "layout" => self.layout,
+        "properties" => self.properties
+      }
+      if result["properties"] == {}
+        result.delete("properties")
+      end
+      if result["layout"].nil?
+        result.delete("layout")
+      end
+      result
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "registration" => self.registration,
+        "title" => self.title
+      }
+    end
+  end
+
+  class ToolProperty
+    def self.get(tool_id, property_name)
+      value = nil
+      DB.connect.exec("select value from sakai_site_tool_property " +
+                      "where tool_id=:tool_id and name=:name",
+                      tool_id, property_name) do |row|
+        value = row[0].read
+      end
+      return value
+    end
+
+    def self.find_by_tool_id(tool_id)
+      properties = {}
+      DB.connect.exec("select name, value from sakai_site_tool_property " +
+                      "where tool_id=:tool_id", tool_id) do |row|
+        name = row[0]
+        value = row[1].read
+        properties[name] = value
+      end
+      return properties
+    end
+  end
+
+  class SiteMembership < SakaiObject
+    attr_reader :site, :user, :role
+
+    def initialize(site_id, user_id, role)
+      @site = Site.find(site_id)
+      @user = User.find(user_id)
+      @role = AuthzRole.find(role)
+    end
+
+    def self.find_by_site_id(site_id)
+      results = []
+      DB.connect.exec("select srrg.user_id, srr.role_name " +
+                      "from sakai_realm_rl_gr srrg, sakai_realm_role srr, sakai_realm sr " +
+                      "where srrg.role_key = srr.role_key " +
+                      "and srrg.realm_key = sr.realm_key " +
+                      "and sr.realm_id = '/site/'||:site_id", site_id) do |row|
+        results << SiteMembership.new(site_id, row[0], row[1])
+      end
+      results
+    end
+
+    def self.find_by_user_id(user_id)
+      results = []
+      DB.connect.exec("select substr(sr.realm_id,7), srr.role_name " +
+                      "from sakai_realm_rl_gr srrg, sakai_realm_role srr, sakai_realm sr " +
+                      "where srrg.role_key = srr.role_key " +
+                      "and srrg.realm_key = sr.realm_key " +
+                      "and srrg.user_id = :1 " +
+                      "and sr.realm_id like '/site/%' " +
+                      "and sr.realm_id not like '%/group/%'", user_id) do |row|
+        results << SiteMembership.new(row[0], user_id, row[1])
+      end
+      results
+    end
+
+    def default_serialization
+      {
+        "site" => self.site.serialize(:summary),
+        "user" => self.user.serialize(:summary),
+        "role" => self.role.name
+      }
+    end
+
+    def summary_serialization
+      {
+        "site_id" => self.site.id,
+        "site_title" => self.site.title,
+        "user_id" => self.user.id,
+        "user_eid" => self.user.eid,
+        "user_type" => self.user.type,
+        "role" => self.role.name
+      }
+    end
+
+    def user_summary_serialization
+      {
+        "site_id" => self.site.id,
+        "site_title" => self.site.title,
+        "role" => self.role.name
+      }
+    end
+
+    def site_summary_serialization
+      {
+        "user_id" => self.user.id,
+        "user_eid" => self.user.eid,
+        "user_type" => self.user.type,
+        "role" => self.role.name
+      }
+    end
+  end
+end