sakai-info 0.1.0

data/lib/sakai-info/assignment.rb

@@ -0,0 +1,281 @@
+# sakai-info/assignment.rb
+#   SakaiInfo::Assignment 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 Assignment < SakaiXMLEntity
+    attr_reader :site
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        site = nil
+        xml = ""
+        DB.connect.exec("select context, xml from assignment_assignment " +
+                      "where assignment_id = :id", id) do |row|
+          site = Site.find(row[0])
+          REXML::Document.new(row[1].read).write(xml, 2)
+        end
+        if site.nil?
+          raise ObjectNotFoundException.new(Assignment, id)
+        end
+        @@cache[id] = Assignment.new(id, site, xml)
+      end
+      @@cache[id]
+    end
+
+    # raw data constructor
+    def initialize(id, site, xml)
+      @id = id
+      @site = site
+      @xml = xml
+      parse_xml
+    end
+
+    # set lookup
+    def self.find_by_site_id(site_id)
+      assignments = []
+      DB.connect.exec("select assignment_id, context, xml from assignment_assignment " +
+                      "where context = :site_id", site_id) do |row|
+        id = row[0]
+        site = Site.find(row[1])
+        xml = ""
+        REXML::Document.new(row[2].read).write(xml, 2)
+        assignments << Assignment.new(id, site, xml)
+      end
+      return assignments
+    end
+
+    def self.count_by_site_id(site_id)
+      assignment_count = 0
+      DB.connect.exec("select count(*) from assignment_assignment " +
+                      "where context = :site_id", site_id) do |row|
+        assignment_count = row[0].to_i
+      end
+      return assignment_count
+    end
+
+    # getters
+    def title
+      @attributes["title"]
+    end
+
+    def submissions
+      @submissions ||= AssignmentSubmission.find_by_assignment_id(@id)
+    end
+
+    def submission_count
+      @submission_count ||= AssignmentSubmission.count_by_assignment_id(@id)
+    end
+
+    # yaml/json serialization
+    def default_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "site" => self.site.serialize(:summary),
+        "created_by" => self.created_by.eid,
+        "created_at" => self.created_at,
+        "submissions" => self.submission_count
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "created_by" => self.created_by.eid,
+        "submissions" => self.submission_count
+      }
+    end
+  end
+
+  class AssignmentSubmission < SakaiXMLEntity
+    attr_reader :assignment, :submitter
+
+    def initialize(id, assignment, xml, submitter, submitted, graded)
+      @id = id
+      @assignment = assignment
+      @xml = xml
+      @submitter = submitter
+      @submitted = submitted
+      @graded = graded
+      parse_xml
+    end
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        assignment = submitter = submitted_at = submitted = graded = nil
+        xml = ""
+        DB.connect.exec("select context, xml, submitter_id, " +
+                        "submitted, graded from assignment_submission " +
+                        "where submission_id = :id", id) do |row|
+          assignment = Assignment.find(row[0])
+          xml = ""
+          REXML::Document.new(row[1].read).write(xml, 2)
+          submitter = User.find(row[2])
+          submitted = (row[3] == "true")
+          graded = (row[4] == "true")
+        end
+        if assignment.nil?
+          raise ObjectNotFoundException.new(AssignmentSubmission, id)
+        end
+        @@cache[id] = AssignmentSubmission.new(id, assignment, xml, submitter, submitted, graded)
+      end
+      @@cache[id]
+    end
+
+    def submitted?
+      ( created_by.eid == @submitter.eid && @submitted ) || false
+    end
+
+    def graded?
+      @graded || false
+    end
+
+    def submitted_at
+      @submitted_at ||= format_entity_date(@attributes["datesubmitted"])
+    end
+
+    def self.find_by_assignment_id(assignment_id)
+      submissions = []
+      DB.connect.exec("select submission_id, context, xml, submitter_id, " +
+                      "submitted, graded from assignment_submission " +
+                      "where context = :assignment_id", assignment_id) do |row|
+        id = row[0]
+        assignment = Assignment.find(row[1])
+        xml = ""
+        REXML::Document.new(row[2].read).write(xml, 2)
+        submitter = User.find(row[3])
+        submitted = (row[4] == "true")
+        graded = (row[5] == "true")
+        submissions << AssignmentSubmission.new(id, assignment, xml, submitter, submitted, graded)
+      end
+      return submissions
+    end
+
+    def self.count_by_assignment_id(assignment_id)
+      submission_count = 0
+      DB.connect.exec("select count(*) from assignment_submission " +
+                      "where context = :assignment_id", assignment_id) do |row|
+        submission_count = row[0].to_i
+      end
+      return submission_count
+    end
+
+    def self.find_by_user_id(user_id)
+      submissions = []
+      DB.connect.exec("select submission_id, context, xml, submitter_id, " +
+                      "submitted, graded from assignment_submission " +
+                      "where submitter_id = :user_id", user_id) do |row|
+        id = row[0]
+        assignment = Assignment.find(row[1])
+        xml = ""
+        REXML::Document.new(row[2].read).write(xml, 2)
+        submitter = User.find(row[3])
+        submitted = (row[4] == "true")
+        graded = (row[5] == "true")
+        submissions << AssignmentSubmission.new(id, assignment, xml, submitter, submitted, graded)
+      end
+      return submissions
+    end
+
+    def self.count_by_user_id(user_id)
+      submission_count = 0
+      DB.connect.exec("select count(*) from assignment_submission " +
+                      "where submitter_id = :user_id", user_id) do |row|
+        submission_count = row[0].to_i
+      end
+      return submission_count
+    end
+
+    # yaml/json serialization
+    def default_serialization
+      {
+        "id" => self.id,
+        "assignment" => self.assignment.serialize(:summary),
+        "submitter" => self.submitter.serialize(:summary),
+        "submitted" => self.submitted?,
+        "submitted_at" => self.submitted_at,
+        "graded" => self.graded?,
+        "created_by" => self.created_by.eid,
+        "created_at" => self.created_at,
+        "modified_by" => self.modified_by.eid,
+        "modified_at" => self.modified_at
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "assignment_id" => self.assignment.id,
+        "submitter" => self.submitter.eid,
+        "submitted" => self.submitted?
+      }
+    end
+  end
+
+  class AssignmentContent < SakaiXMLEntity
+    attr_reader :owner
+
+    def initialize(id, owner, xml)
+      @id = id
+      @owner = owner
+      @xml = xml
+      parse_xml
+    end
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        context = nil
+        xml = ""
+        DB.connect.exec("select context, xml from assignment_content " +
+                      "where content_id = :id", id) do |row|
+          context = row[0]
+          REXML::Document.new(row[1].read).write(xml, 2)
+        end
+        if context.nil?
+          raise ObjectNotFoundException.new(AssignmentContent, id)
+        end
+        @@cache[id] = AssignmentContent.new(id, context, xml)
+      end
+      @@cache[id]
+    end
+
+    def self.find_by_user_id(user_id)
+      contents = []
+      DB.connect.exec("select content_id, context, xml from assignment_content " +
+                      "where context = :user_id", user_id) do |row|
+        id = row[0]
+        context = row[1]
+        xml = ""
+        REXML::Document.new(row[2].read).write(xml, 2)
+        contents << AssignmentContent.new(id, context, xml)
+      end
+      return contents
+    end
+
+    def self.count_by_user_id(user_id)
+      content_count = 0
+      DB.connect.exec("select count(*) from assignment_content " +
+                      "where context = :user_id", user_id) do |row|
+        content_count = row[0].to_i
+      end
+      content_count
+    end
+
+    # getters
+    def title
+      @attributes["title"]
+    end
+  end
+end

data/lib/sakai-info/authz.rb

@@ -0,0 +1,378 @@
+# sakai-info/authz.rb
+#   SakaiInfo::Authz 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 AuthzRole < SakaiObject
+    attr_reader :name
+
+    def initialize(id, name)
+      @id = id
+      @name = name
+    end
+
+    def to_s
+      name
+    end
+
+    @@cache = {}
+    def self.find_by_id(id)
+      id = id.to_s
+      if @@cache[id].nil?
+        name = nil
+        DB.connect.exec("select role_name from sakai_realm_role " +
+                        "where role_key = :id", id.to_i) do |row|
+          name = row[0]
+        end
+        if name.nil?
+          raise ObjectNotFoundException.new(AuthzRole, id)
+        end
+        @@cache[id] = AuthzRole.new(id, name)
+        @@cache[name] = @@cache[id]
+      end
+      @@cache[id]
+    end
+
+    def self.find_by_name(name)
+      if name.nil?
+        raise ObjectNotFoundException.new(AuthzRole, "")
+      end
+      if @@cache[name].nil?
+        id = nil
+        DB.connect.exec("select role_key from sakai_realm_role " +
+                        "where role_name = :name", name) do |row|
+          id = row[0].to_i.to_s
+        end
+        if id.nil?
+          raise ObjectNotFoundException.new(AuthzRole, name)
+        end
+        @@cache[name] = AuthzRole.new(id, name)
+        @@cache[id] = @@cache[name]
+      end
+      @@cache[name]
+    end
+
+    def self.find(id_or_name)
+      id_or_name = id_or_name.to_s
+      role = nil
+      begin
+        role = AuthzRole.find_by_name(id_or_name)
+      rescue ObjectNotFoundException
+        # just in case
+        role = AuthzRole.find_by_id(id_or_name)
+      end
+      if role.nil?
+        raise ObjectNotFoundException.new(AuthzRole, id_or_name)
+      end
+      role
+    end
+
+    def self.find_by_realm_id_and_function_id(realm_id, function_id)
+      roles = []
+      DB.connect.exec("select role_key, role_name from " +
+                      "sakai_realm_role where role_key in " +
+                      "(select role_key from sakai_realm_rl_fn " +
+                      "where realm_key=:realm_id and function_key=:function_id) " +
+                      "order by role_name", realm_id, function_id) do |row|
+        role_id = row[0].to_i.to_s
+        role_name = row[1]
+        roles << AuthzRole.new(role_id, role_name)
+      end
+      roles
+    end
+  end
+
+  class AuthzFunction < SakaiObject
+    attr_reader :name
+
+    def initialize(id, name)
+      @id = id
+      @name = name
+    end
+
+    def to_s
+      name
+    end
+
+    @@cache = {}
+    def self.find_by_id(id)
+      id = id.to_s
+      if @@cache[id].nil?
+        name = nil
+        DB.connect.exec("select function_name from sakai_realm_function " +
+                        "where function_key = :id", id.to_i) do |row|
+          name = row[0]
+        end
+        if name.nil?
+          raise ObjectNotFoundException.new(AuthzFunction, id)
+        end
+        @@cache[id] = AuthzFunction.new(id, name)
+        @@cache[name] = @@cache[id]
+      end
+      @@cache[id]
+    end
+
+    def self.find_by_name(name)
+      if @@cache[name].nil?
+        id = nil
+        DB.connect.exec("select function_key from sakai_realm_function " +
+                        "where function_name = :name", name) do |row|
+          id = row[0].to_i.to_s
+        end
+        if id.nil?
+          raise ObjectNotFoundException.new(AuthzFunction, name)
+        end
+        @@cache[name] = AuthzFunction.new(id, name)
+        @@cache[id] = @@cache[name]
+      end
+      @@cache[name]
+    end
+
+    def self.find(id_or_name)
+      id_or_name = id_or_name.to_s
+      function = nil
+      begin
+        function = AuthzFunction.find_by_name(id_or_name)
+      rescue ObjectNotFoundException
+        # just in case
+        function = AuthzFunction.find_by_id(id_or_name)
+      end
+      if function.nil?
+        raise ObjectNotFoundException.new(AuthzFunction, id_or_name)
+      end
+      function
+    end
+
+    def self.count_by_realm_id_and_role_id(realm_id, role_id)
+      count = 0
+      DB.connect.exec("select count(*) from sakai_realm_rl_fn " +
+                      "where realm_key=:realm_id and role_key=:role_id",
+                      realm_id, role_id) do |row|
+        count = row[0].to_i
+      end
+      count
+    end
+
+    def self.find_by_realm_id_and_role_id(realm_id, role_id)
+      functions = []
+      DB.connect.exec("select function_key, function_name from " +
+                      "sakai_realm_function where function_key in " +
+                      "(select function_key from sakai_realm_rl_fn " +
+                      "where realm_key=:realm_id and role_key=:role_id) " +
+                      "order by function_name", realm_id, role_id) do |row|
+        function_id = row[0].to_i.to_s
+        function_name = row[1]
+        functions << AuthzFunction.new(function_id, function_name)
+      end
+      functions
+    end
+  end
+
+  class AuthzRealm < SakaiObject
+    attr_reader :name, :providers, :maintain_role
+
+    def initialize(id, name, providers, maintain_role)
+      @id = id
+      @name = name
+      if providers.nil?
+        @providers = nil
+      else
+        @providers = providers.split("+")
+      end
+      @maintain_role = maintain_role
+    end
+
+    def realm_roles
+      @realm_roles ||= AuthzRealmRole.find_by_realm_id(@id)
+    end
+
+    def to_s
+      name
+    end
+
+    def user_count
+      @user_count ||= AuthzRealmMembership.count_by_realm_id(@id)
+    end
+
+    def membership
+      @membership ||= AuthzRealmMembership.find_by_realm_id(@id)
+    end
+
+    @@cache = {}
+    def self.find_by_id(id)
+      id = id.to_s
+      if @@cache[id].nil?
+        name = providers = maintain_role = nil
+        DB.connect.exec("select realm_id, provider_id, maintain_role " +
+                        "from sakai_realm " +
+                        "where realm_key = :id", id.to_i) do |row|
+          name = row[0]
+          providers = row[1]
+          if row[2].nil? or row[2] == ""
+            maintain_role = nil
+          else
+            maintain_role = AuthzRole.find_by_id(row[2].to_i)
+          end
+        end
+        if name.nil?
+          raise ObjectNotFoundException.new(AuthzRealm, id)
+        end
+        @@cache[id] = AuthzRealm.new(id, name, providers, maintain_role)
+        @@cache[name] = @@cache[id]
+      end
+      @@cache[id]
+    end
+
+    def self.find_by_name(name)
+      if @@cache[name].nil?
+        id = providers = maintain_role = nil
+        DB.connect.exec("select realm_key, provider_id, maintain_role " +
+                        "from sakai_realm " +
+                        "where realm_id = :name", name) do |row|
+          id = row[0].to_i.to_s
+          providers = row[1]
+          if row[2].nil? or row[2] == ""
+            maintain_role = nil
+          else
+            maintain_role = AuthzRole.find_by_id(row[2].to_i)
+          end
+        end
+        if id.nil?
+          raise ObjectNotFoundException.new(AuthzRealm, name)
+        end
+        @@cache[name] = AuthzRealm.new(id, name, providers, maintain_role)
+        @@cache[id] = @@cache[name]
+      end
+      @@cache[name]
+    end
+
+    def self.find(id_or_name)
+      id_or_name = id_or_name.to_s
+      realm = nil
+      begin
+        realm = AuthzRealm.find_by_name(id_or_name)
+      rescue ObjectNotFoundException
+        # just in case
+        realm = AuthzRealm.find_by_id(id_or_name)
+      end
+      if realm.nil?
+        raise ObjectNotFoundException.new(AuthzRealm, id_or_name)
+      end
+      realm
+    end
+
+    def self.find_by_site_id(site_id)
+      AuthzRealm.find_by_name("/site/#{site_id}")
+    end
+
+    def self.find_by_site_id_and_group_id(site_id, group_id)
+      AuthzRealm.find_by_name("/site/#{site_id}/group/#{group_id}")
+    end
+  end
+
+  class AuthzRealmRole < SakaiObject
+    attr_reader :realm, :role
+
+    def initialize(realm, role)
+      @realm = realm
+      @role = role
+    end
+
+    def function_count
+      @function_count ||= AuthzFunction.count_by_realm_id_and_role_id(@realm.id, @role.id)
+    end
+
+    def functions
+      @functions ||= AuthzFunction.find_by_realm_id_and_role_id(@realm.id, @role.id)
+    end
+
+    def user_count
+      @user_count ||= User.count_by_realm_id_and_role_id(@realm.id, @role.id)
+    end
+
+    def users
+      @users ||= User.find_by_realm_id_and_role_id(@realm.id, @role.id)
+    end
+
+    def self.find_by_realm_id(realm_id)
+      realm_roles = []
+      realm = AuthzRealm.find_by_id(realm_id)
+      DB.connect.exec("select distinct role_key from " +
+                      "sakai_realm_rl_fn where " +
+                      "realm_key = :realm_id", realm_id) do |row|
+        begin
+          role = AuthzRole.find_by_id(row[0].to_i)
+          realm_roles << AuthzRealmRole.new(realm, role)
+        rescue AuthzRoleNotFoundException
+        end
+      end
+      realm_roles
+    end
+
+    def default_serialization
+      {
+        "realm_name" => self.realm.name,
+        "role_name" => self.role.name,
+        "user_count" => self.user_count,
+        "function_count" => self.function_count
+      }
+    end
+
+    def summary_serialization
+      {
+        "role_name" => self.role.name,
+        "user_count" => self.user_count,
+        "function_count" => self.function_count
+      }
+    end
+  end
+
+  class AuthzRealmMembership < SakaiObject
+    attr_reader :realm, :user, :role
+
+    def initialize(realm_id, user_id, role)
+      @realm = AuthzRealm.find(realm_id)
+      @user = User.find(user_id)
+      @role = AuthzRole.find(role)
+    end
+
+    def self.find_by_realm_id(realm_id)
+      results = []
+      DB.connect.exec("select srrg.user_id, srr.role_name " +
+                      "from sakai_realm_rl_gr srrg, sakai_realm_role srr " +
+                      "where srrg.role_key = srr.role_key " +
+                      "and srrg.realm_key = :realm_id", realm_id) do |row|
+        results << AuthzRealmMembership.new(realm_id, row[0], row[1])
+      end
+      results
+    end
+
+    def self.count_by_realm_id(realm_id)
+      count = 0
+      DB.connect.exec("select count(*) from sakai_realm_rl_gr " +
+                      "where realm_key = :realm_id", realm_id) do |row|
+        count = row[0].to_i
+      end
+      count
+    end
+
+    def self.find_by_user_id(user_id)
+      results = []
+      DB.connect.exec("select sr.realm_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 srrg.user_id = :user_id", user_id) do |row|
+        results << AuthzRealmMembership.new(row[0], user_id, row[1])
+      end
+      results
+    end
+  end
+end