sakai-info 0.3.5 → 0.4.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # sakai-info Change History #
 
+### 0.4.0 ###
+
+*Released 2012-04-21*
+
+* CLI access to content
+* Content binary entity parsing
+* Command line tool name change to "sin"
+
 ## 0.3.5 ##
 
 *Released 2012-04-02*

data/README.md

@@ -1,12 +1,12 @@
 # sakai-info #
 
-last updated: 2012-04-02  
+last updated: 2012-04-21  
 author: David Adams (daveadams@gmail.com)  
 github url: https://github.com/daveadams/sakai-info
 
-*sakai-info* is a command line tool and a suite of Ruby libraries which enable
-the exploration of a Sakai database without the intermediation of a Java VM or
-any official Sakai code.
+The *sakai-info* gem consists of a suite of Ruby libraries which enable the
+exploration of a Sakai database without the intermediation of a Java VM or
+any official Sakai code, along with a command line tool, `sin`.
 
 Because the primary goal of this tool is to assist in information gathering
 and troubleshooting, no capability to change the database is included in the
@@ -24,7 +24,7 @@ Use `rake` to test and build the gem:
     $ rake gem:build
 
 The resulting gem will be saved to the working directory as
-`sakai-info-0.3.5.gem`.
+`sakai-info-0.4.0.gem`.
 
 Cleanup built gems using:
 
@@ -68,10 +68,10 @@ nickname for the connection.
 
 ## Command Line Usage ##
 
-After installing the gem, the `sakai-info` program should be found in your
-PATH. For usage details, run:
+After installing the gem, the `sin` program should be found in your PATH. For
+usage details, run:
 
-    $ sakai-info help
+    $ sin help
 
 ## Library Usage ##
 

data/ROADMAP.md

@@ -1,12 +1,6 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-04-02*
-
-### 0.4.0 ###
-
-* CLI access to content
-* Content binary entity parsing
-* Command line tool name change to "sin"
+*Last updated 2012-04-21*
 
 ### 0.4.1 ###
 

data/bin/{sakai-info → sin}

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 #
-# sakai-info
+# sin
 #   Command line tool for exploring the Sakai database via the
 #   sakai-info library
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-02-26 daveadams@gmail.com
+# Last updated 2012-04-02 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #

data/lib/sakai-info/cli/help.rb

@@ -1,5 +1,5 @@
 # sakai-info/cli/help.rb
-#  - sakai-info command line help
+#  - sin command line help
 #
 # Created 2012-02-19 daveadams@gmail.com
 # Last updated 2012-04-02 daveadams@gmail.com
@@ -14,42 +14,24 @@ module SakaiInfo
     class Help
       STRINGS = {
         :default => <<EOF,
-sakai-info #{VERSION}
-
-  Usage: sakai-info <command> [<id>] [<options>]
+sin #{VERSION}
+  Usage: sin <command> [<id>] [<options>]
 
   Object commands:
-    user           User information
-    group          Group information
-
-    site           Site information
-    page           Site page information
-    tool           Page tool information
-
-    quiz           Quiz aka Assessment information, pending or published
-    quiz-section   Quiz section information, pending or published
-    quiz-item      Quiz item information, pending or published
-    quiz-attempt   Quiz attempt information
-    quiz-attempt-item
-                   Information on attempted quiz items
-    quiz-attempt-item-attachment
-                   Information on file attachments to attempted quiz items
-
-    question-pool  Question Pool information
-
-    assignment     Assignment information
-    assignment-submission
-                   Assignment submission information
-
-    forum          Forum information
-    forum-thread   Forum Thread information
-    forum-post     Forum Post information
+    user, group, site, page, tool, quiz, quiz-section, quiz-item, quiz-attempt,
+    quiz-attempt-item, quiz-attempt-item-attachment, question-pool, assignment,
+    assignment-submission, forum, forum-thread, forum-post, content
 
   Misc commands:
-    test         Tests configured database connections
-    help         Prints general help
-    version      Prints version
+    test             Tests configured database connections
+    help             Prints general help
+    version          Prints version
+    help <command>   Prints help about a particular command
+    help options     Prints help about additional options
+EOF
 
+        "options" => <<EOF,
+sin #{VERSION}
   Options that apply globally:
     --database=<name>
         Connect to database instance <name> as defined in ~/.sakai-info instead
@@ -78,40 +60,38 @@ sakai-info #{VERSION}
 
     --all
         Print all possible information (other than dbrow)
-
-  Type 'sakai-info help <command>' for help on a specific command.
 EOF
 
         "help" => <<EOF,
-sakai-info help
+sin help
 
-  Usage: sakai-info help [<command>]
+  Usage: sin help [<command>]
 
-  Prints usage information for other sakai-info commands, or without an
+  Prints usage information for other sin commands, or without an
   argument it prints a list of possible commands.
 EOF
 
         "version" => <<EOF,
-sakai-info version
+sin version
 
-  Usage: sakai-info version
+  Usage: sin version
 
-  Prints the current version of sakai-info.
+  Prints the current version of sin.
 EOF
 
         "test" => <<EOF,
-sakai-info test
+sin test
 
-  Usage: sakai-info test [<options>]
+  Usage: sin test [<options>]
 
   Reads configuration and tests connecting to each database specified, or if
   a specific database is specified it will test only that connection.
 EOF
 
         "user" => <<EOF,
-sakai-info user
+sin user
 
-  Usage: sakai-info user <id> [<options>]
+  Usage: sin user <id> [<options>]
 
   Prints information about the user ID or EID specified. Additional options
   may be passed to include additional information:
@@ -122,9 +102,9 @@ sakai-info user
 EOF
 
         "group" => <<EOF,
-sakai-info group
+sin group
 
-  Usage: sakai-info group <id> [<options>]
+  Usage: sin group <id> [<options>]
 
   Prints information about the group ID or EID specified. Additional options
   may be passed to include additional information:
@@ -135,9 +115,9 @@ sakai-info group
 EOF
 
         "site" => <<EOF,
-sakai-info site
+sin site
 
-  Usage: sakai-info site <id> [<options>]
+  Usage: sin site <id> [<options>]
 
   Prints information about the site ID specified. Additional options may be
   passed to include additional information:
@@ -156,25 +136,25 @@ sakai-info site
 EOF
 
         "page" => <<EOF,
-sakai-info page
+sin page
 
-  Usage: sakai-info page <id> [<options>]
+  Usage: sin page <id> [<options>]
 
   Prints information about the page ID specified, including tools.
 EOF
 
         "tool" => <<EOF,
-sakai-info tool
+sin tool
 
-  Usage: sakai-info tool <id> [<options>]
+  Usage: sin tool <id> [<options>]
 
   Prints information about the tool ID specified.
 EOF
 
         "quiz" => <<EOF,
-sakai-info quiz
+sin quiz
 
-  Usage: sakai-info quiz <id> [<options>]
+  Usage: sin quiz <id> [<options>]
 
   Prints information about the quiz ID specified. The quiz ID may represent
   a pending quiz or a published quiz. Additional options may be passed to
@@ -190,9 +170,9 @@ sakai-info quiz
 EOF
 
         "quiz-section" => <<EOF,
-sakai-info quiz-section
+sin quiz-section
 
-  Usage: sakai-info quiz-section <id> [<options>]
+  Usage: sin quiz-section <id> [<options>]
 
   Prints information about the quiz section ID specified. The ID may represent
   a pending quiz section or a published quiz section. Additional options may be
@@ -204,9 +184,9 @@ sakai-info quiz-section
 EOF
 
         "quiz-item" => <<EOF,
-sakai-info quiz-item
+sin quiz-item
 
-  Usage: sakai-info quiz-item <id> [<options>]
+  Usage: sin quiz-item <id> [<options>]
 
   Prints information about the quiz item ID specified. The ID may represent
   a pending quiz item or a published quiz item. Additional options may be
@@ -217,10 +197,10 @@ sakai-info quiz-item
 EOF
 
         "question-pool" => <<EOF,
-sakai-info question-pool
+sin question-pool
 
-  Usage: sakai-info qpool <id> [<options>]
-         sakai-info question-pool <id> [<options>]
+  Usage: sin qpool <id> [<options>]
+         sin question-pool <id> [<options>]
 
   Prints information about the question pool ID specified. Additional options
   may be passed to include additional information:
@@ -234,9 +214,9 @@ sakai-info question-pool
 EOF
 
         "quiz-attempt" => <<EOF,
-sakai-info quiz-attempt
+sin quiz-attempt
 
-  Usage: sakai-info quiz-attempt <id> [<options>]
+  Usage: sin quiz-attempt <id> [<options>]
 
   Prints information about the quiz attempt ID specified. Additional options
   may be passed to include additional information:
@@ -247,9 +227,9 @@ EOF
 
 
         "quiz-attempt-item" => <<EOF,
-sakai-info quiz-attempt-item
+sin quiz-attempt-item
 
-  Usage: sakai-info quiz-attempt-item <id> [<options>]
+  Usage: sin quiz-attempt-item <id> [<options>]
 
   Prints information about the quiz attempt item ID specified. Additional
   options may be passed to include additional information:
@@ -259,9 +239,9 @@ sakai-info quiz-attempt-item
 EOF
 
         "quiz-attempt-item-attachment" => <<EOF,
-sakai-info quiz-attempt-item-attachment
+sin quiz-attempt-item-attachment
 
-  Usage: sakai-info quiz-attempt-item-attachment <id> [<options>]
+  Usage: sin quiz-attempt-item-attachment <id> [<options>]
 
   Prints information about the quiz attempt item attachment ID specified.
   Additional options may be passed to include additional information:
@@ -271,9 +251,9 @@ sakai-info quiz-attempt-item-attachment
 EOF
 
         "assignment" => <<EOF,
-sakai-info assignment
+sin assignment
 
-  Usage: sakai-info assignment <id> [<options>]
+  Usage: sin assignment <id> [<options>]
 
   Prints information about the assignment ID specified. Additional options
   may be passed to include additional information:
@@ -285,9 +265,9 @@ sakai-info assignment
 EOF
 
         "assignment-submission" => <<EOF,
-sakai-info assignment-submission
+sin assignment-submission
 
-  Usage: sakai-info assignment-submission <id> [<options>]
+  Usage: sin assignment-submission <id> [<options>]
 
   Prints information about the assignment submission ID specified. Additional
   options may be passed to include additional information:
@@ -298,9 +278,9 @@ sakai-info assignment-submission
 EOF
 
         "forum" => <<EOF,
-sakai-info forum
+sin forum
 
-  Usage: sakai-info forum <id> [<options>]
+  Usage: sin forum <id> [<options>]
 
   Prints information about the forum ID specified. Additional options may be
   passed to include additional information:
@@ -311,9 +291,9 @@ sakai-info forum
 EOF
 
         "forum-thread" => <<EOF,
-sakai-info forum-thread
+sin forum-thread
 
-  Usage: sakai-info forum-thread <id> [<options>]
+  Usage: sin forum-thread <id> [<options>]
 
   Prints information about the forum thread ID specified. Additional options
   may be passed to include additional information:
@@ -324,13 +304,27 @@ sakai-info forum-thread
 EOF
 
         "forum-post" => <<EOF,
-sakai-info forum-post
+sin forum-post
 
-  Usage: sakai-info forum-post <id> [<options>]
+  Usage: sin forum-post <id> [<options>]
 
   Prints information about the forum post ID specified. Additional options
   may be passed to include additional information:
 
+    --mod        Print creation/modification info
+    --all        Print all possible details
+EOF
+
+        "content" => <<EOF,
+sin content
+
+  Usage: sin content <id> [<options>]
+
+  Prints information about the content resource or collection ID specified.
+  Additional options may be passed to include additional information:
+
+    --properties Print all properties
+    --children   Recursively print collection children
     --mod        Print creation/modification info
     --all        Print all possible details
 EOF

data/lib/sakai-info/cli.rb

@@ -35,6 +35,7 @@ module SakaiInfo
       "forum" => Forum,
       "forum-thread" => ForumThread,
       "forum-post" => ForumPost,
+      "content" => Content,
     }
   end
 end

data/lib/sakai-info/content.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Content library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-02-24 daveadams@gmail.com
+# Last updated 2012-04-21 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -13,6 +13,12 @@ module SakaiInfo
   class Content < SakaiObject
     attr_reader :parent_id
 
+    include ModProps
+    created_by_key :_binary_entity_created_by
+    created_at_key :_binary_entity_created_at
+    modified_by_key :_binary_entity_modified_by
+    modified_at_key :_binary_entity_modified_at
+
     def self.find(id)
       begin
         ContentResource.find(id)
@@ -37,18 +43,25 @@ module SakaiInfo
       end
     end
 
-    def binary
-      if @binary.nil?
-        row = DB.connect[@table_name.to_sym].filter(@id_column.to_sym => @id).first
-        @binary = row[:binary_entity].read
-      end
-      @binary
-    end
-
     def size_on_disk
       0
     end
 
+    def binary_entity
+      if @binary_entity.nil?
+        @binary_entity = ContentBinaryEntity.new(@dbrow[:binary_entity])
+
+        @dbrow[:_binary_entity_created_by] = @binary_entity["CHEF:creator"]
+        @dbrow[:_binary_entity_modified_by] = @binary_entity["CHEF:modifiedby"]
+        @dbrow[:_binary_entity_created_at] =
+          Util.format_entity_date(@binary_entity["DAV:creationdate"])
+        @dbrow[:_binary_entity_modified_at] =
+          Util.format_entity_date(@binary_entity["DAV:getlastmodified"])
+      end
+
+      @binary_entity
+    end
+
     def default_serialization
       {
         "id" => self.id,
@@ -71,7 +84,7 @@ module SakaiInfo
       else
         begin
           @realm ||= AuthzRealm.find_by_name("/content#{@id}")
-        rescue AuthzRealmNotFoundException
+        rescue ObjectNotFoundException
           @realm_is_nil = true
           nil
         end
@@ -81,19 +94,67 @@ module SakaiInfo
     def effective_realm
       self.realm || (parent.nil? ? nil : parent.effective_realm)
     end
+
+    def realm_serialization
+      if self.effective_realm.nil?
+        {}
+      else
+        {
+          "effective_realm" => self.effective_realm.name,
+        }
+      end
+    end
+
+    def child_summary_serialization
+      {
+        "id" => self.id.gsub(/^#{self.parent_id}/,""),
+        "size" => self.size_on_disk,
+      }
+    end
+
+    def properties_serialization
+      result = self.binary_entity.to_hash
+      if result["groups"] == []
+        result.delete("groups")
+      end
+      result.keys.each do |key|
+        if result[key].nil? or result[key] == ""
+          result.delete(key)
+        end
+      end
+      {
+        "properties" => result
+      }
+    end
+
+    # ensure @binary_entity has been parsed before returning mod info
+    alias :original_mod_serialization :mod_serialization
+    alias :original_mod_details_serialization :mod_details_serialization
+
+    def mod_serialization
+      self.binary_entity
+      self.original_mod_serialization
+    end
+
+    def mod_details_serialization
+      self.binary_entity
+      self.original_mod_details_serialization
+    end
   end
 
   class ContentResource < Content
-    attr_reader :file_path, :uuid, :context, :resource_type_id
+    attr_reader :file_path, :uuid, :context, :resource_type_id, :dbrow
 
-    def initialize(id, parent_id, file_path, uuid, file_size, context, resource_type_id)
-      @id = id
-      @parent_id = parent_id
-      @file_path = File.join(Instance.content_base_directory, file_path)
-      @uuid = uuid
-      @file_size = file_size
-      @context = context
-      @resource_type_id = resource_type_id
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = @dbrow[:resource_id]
+      @parent_id = @dbrow[:in_collection]
+      @file_path = @dbrow[:file_path]
+      @uuid = @dbrow[:resource_uuid]
+      @file_size = @dbrow[:file_size].to_i
+      @context = @dbrow[:context]
+      @resource_type_id = @dbrow[:resource_type_id]
 
       @table_name = "content_resource"
       @id_column = "resource_id"
@@ -102,11 +163,11 @@ module SakaiInfo
     @@cache = {}
     def self.find(id)
       if @@cache[id].nil?
-        row = DB.connect[:content_resource].filter(:resource_id => id).first
+        row = DB.connect[:content_resource].where(:resource_id => id).first
         if row.nil?
           raise ObjectNotFoundException.new(ContentResource, id)
         end
-        @@cache[id] = ContentResource.new(row[:resource_id], row[:in_collection], row[:file_path], row[:resource_uuid], row[:file_size].to_i, row[:context], row[:resource_type_id])
+        @@cache[id] = ContentResource.new(row)
       end
       @@cache[id]
     end
@@ -115,40 +176,54 @@ module SakaiInfo
       @file_size
     end
 
+    def self.query_by_parent(parent_id)
+      DB.connect[:content_resource].where(:in_collection => parent_id)
+    end
+
+    def self.find_by_parent(parent_id)
+      resources = []
+      ContentResource.query_by_parent(parent_id).all.each do |row|
+        @@cache[row[:resource_id]] = ContentResource.new(row)
+        resources << @@cache[row[:resource_id]]
+      end
+      resources
+    end
+
+    def self.count_by_parent(parent_id)
+      ContentResource.query_by_parent(parent_id).count
+    end
+
     def default_serialization
-      {
+      result = {
         "id" => self.id,
-        "parent" => self.parent_id,
         "uuid" => self.uuid,
         "file_path" => self.file_path,
         "size_on_disk" => self.size_on_disk,
         "context" => self.context,
-        "resource_type_id" => self.resource_type_id,
-        "effective_realm" => (self.effective_realm.nil? ? nil : self.effective_realm.name)
+        "resource_type" => self.resource_type_id,
       }
-    end
-
-    def self.find_by_parent(parent_id)
-      resources = []
-      DB.connect[:content_resource].filter(:in_collection => parent_id) do |row|
-        @@cache[row[:resource_id]] =
-          ContentResource.new(row[:resource_id], row[:in_collection], row[:file_path],
-                                row[:resource_uuid], row[:file_size].to_i, row[:context],
-                                row[:resource_type_id])
-        resources << @@cache[row[0]]
+      if result["uuid"].nil?
+        result.delete("uuid")
       end
-      resources
+      result
     end
 
-    def self.count_by_parent(parent_id)
-      DB.connect[:content_resource].filter(:in_collection => parent_id).count
+    def summary_serialization
+      {
+        "id" => self.id,
+        "size" => self.size_on_disk,
+      }
     end
   end
 
   class ContentCollection < Content
-    def initialize(id, parent_id)
-      @id = id
-      @parent_id = parent_id
+    attr_reader :dbrow
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = @dbrow[:collection_id]
+      @parent_id = @dbrow[:in_collection]
 
       @table_name = "content_collection"
       @id_column = "collection_id"
@@ -161,11 +236,11 @@ module SakaiInfo
       end
 
       if @@cache[id].nil?
-        row = DB.connect[:content_collection].filter(:collection_id => id).first
+        row = DB.connect[:content_collection].where(:collection_id => id).first
         if row.nil?
           raise ObjectNotFoundException.new(ContentCollection, id)
         end
-        @@cache[id] = ContentCollection.new(row[:collection_id], row[:in_collection])
+        @@cache[id] = ContentCollection.new(row)
       end
       @@cache[id]
     end
@@ -183,17 +258,12 @@ module SakaiInfo
       collections = []
       DB.connect[:content_collection].
         where(:collection_id.like('%/portfolio-interaction/')) do |row|
-        @@cache[row[:collection_id]] =
-          ContentCollection.new(row[:collection_id], row[:in_collection])
+        @@cache[row[:collection_id]] = ContentCollection.new(row)
         collections << @@cache[row[:collection_id]]
       end
       collections
     end
 
-    def self.count_by_parent(parent_id)
-      DB.connect[:content_collection].filter(:in_collection => parent_id).count
-    end
-
     def size_on_disk
       @size_on_disk ||=
         DB.connect[:content_resource].select(:sum.sql_function(:file_size).as(:total_size)).
@@ -230,36 +300,47 @@ module SakaiInfo
     def default_serialization
       {
         "id" => self.id,
-        "parent" => self.parent_id,
         "size_on_disk" => self.size_on_disk,
         "children" => self.child_counts,
-        "effective_realm" => (self.effective_realm.nil? ? nil : effective_realm.name)
       }
     end
 
     def summary_serialization
       {
         "id" => self.id,
-        "parent" => self.parent_id
       }
     end
 
     def children_serialization
-      {
+      result = {
         "collections" => self.children["collections"].collect { |cc|
-          cc.serialize(:summary, :children)
+          cc.serialize(:child_summary, :children)
         },
         "resources" => self.children["resources"].collect { |cr|
-          cr.serialize(:summary)
+          cr.serialize(:child_summary)
         }
       }
+      if result["collections"] == []
+        result.delete("collections")
+      end
+      if result["resources"] == []
+        result.delete("resources")
+      end
+      result
+    end
+
+    def self.query_by_parent(parent_id)
+      DB.connect[:content_collection].where(:in_collection => parent_id)
+    end
+
+    def self.count_by_parent(parent_id)
+      ContentCollection.query_by_parent(parent_id).count
     end
 
     def self.find_by_parent(parent_id)
       collections = []
-      DB.connect[:content_collection].filter(:in_collection => parent_id) do |row|
-        @@cache[row[:collection_id]] =
-          ContentCollection.new(row[:collection_id], row[:in_collection])
+      ContentCollection.query_by_parent(parent_id).all.each do |row|
+        @@cache[row[:collection_id]] = ContentCollection.new(row)
         collections << @@cache[row[:collection_id]]
       end
       collections
@@ -276,4 +357,226 @@ module SakaiInfo
       0
     end
   end
+
+  class UnknownBinaryEntityFormat < SakaiException; end
+  class ContentBinaryEntity
+    require 'stringio'
+
+    def read_tiny_int(bin)
+      bin.read(1).unpack("C")[0]
+    end
+
+    def read_int(bin)
+      bin.read(2).unpack("n")[0]
+    end
+
+    def read_long_int(bin)
+      bin.read(4).unpack("N")[0]
+    end
+
+    def read_huge_int(bin)
+      part1 = bin.read(4).unpack("N")[0]
+      part2 = bin.read(4).unpack("N")[0]
+
+      return ((part1 << 32) + part2)
+    end
+    MAX_HUGE_INT=(2**64 - 1)
+
+    def read_utf_string(bin)
+      byte_length = read_int(bin)
+      if byte_length == 0
+        return ""
+      end
+      bin.read(byte_length).force_encoding(Encoding::UTF_8)
+    end
+
+    def initialize(raw_blob)
+      blob = StringIO.new(raw_blob)
+      blob_id = blob.read(6)
+
+      serialization_type = read_long_int(blob)
+      if serialization_type != 1
+        raise UnknownBinaryEntityFormat.new("Unrecognized format version #{serialization_type}")
+      end
+
+      @properties = {}
+
+      if blob_id == "CHSBRE"
+        parse_for_content_resource(blob)
+      elsif blob_id == "CHSBCE"
+        parse_for_content_collection(blob)
+      else
+        raise UnknownBinaryEntityFormat.new("Unrecognized format ID: #{blob_id}")
+      end
+    end
+
+    def [](key)
+      @properties[key]
+    end
+
+    def keys
+      @properties.keys
+    end
+
+    def to_hash
+      @properties
+    end
+
+    # content resource block IDs
+    # yes, block 2 = 12 and block 3 = 11
+    # BLOCK1 = general attributes
+    CR_BLOCK1 = 10
+    # BLOCK2 = release and retract dates
+    CR_BLOCK2 = 12
+    # BLOCK3 = groups
+    CR_BLOCK3 = 11
+    # BLOCK4 = properties
+    CR_BLOCK4 = 13
+    # BLOCK5 = file properties
+    CR_BLOCK5 = 14
+    # BLOCK6 = byte[] storing file content if it's not in the filesystem
+    CR_BLOCK6 = 15
+    # BLOCK_END
+    CR_BLOCK_END = 2
+
+    def parse_for_content_resource(blob)
+      while true
+        block_number = read_long_int(blob)
+        case(block_number)
+        when CR_BLOCK1
+          parse_block1(blob)
+
+        when CR_BLOCK2
+          parse_block2(blob)
+
+        when CR_BLOCK3
+          parse_block3(blob)
+
+        when CR_BLOCK4
+          parse_block4(blob)
+
+        when CR_BLOCK5
+          @properties["content_type"] = read_utf_string(blob)
+          @properties["content_length"] = read_huge_int(blob)
+          @properties["file_path"] = read_utf_string(blob)
+
+        when CR_BLOCK6
+          body_size = read_long_int(blob)
+          if body_size > 0
+            STDERR.puts "WARNING: files stored in the database are not currently supported"
+          end
+
+        when CR_BLOCK_END
+          break
+
+        else
+          raise UnknownBinaryEntityFormat.new("Unknown Block ID: '#{block_number}'")
+        end
+      end
+    end
+
+    # content collection block IDs
+    # BLOCK1 = general attributes
+    CC_BLOCK1 = 10
+    # BLOCK2 = release and retract dates
+    CC_BLOCK2 = 11
+    # BLOCK3 = groups
+    CC_BLOCK3 = 12
+    # BLOCK4 = properties
+    CC_BLOCK4 = 13
+    # BLOCK_END
+    CC_BLOCK_END = 2
+
+    def parse_for_content_collection(blob)
+      while true
+        block_number = read_long_int(blob)
+        case(block_number)
+        when CC_BLOCK1
+          parse_block1(blob)
+
+        when CC_BLOCK2
+          parse_block2(blob)
+
+        when CC_BLOCK3
+          parse_block3(blob)
+
+        when CC_BLOCK4
+          parse_block4(blob)
+
+        when CC_BLOCK_END
+          break
+
+        else
+          raise UnknownBinaryEntityFormat.new("Unknown Block ID: '#{block_number}'")
+        end
+      end
+    end
+
+    def parse_block1(blob)
+      @properties["id"] = read_utf_string(blob)
+      @properties["resource_type"] = read_utf_string(blob)
+      @properties["access_mode"] = read_utf_string(blob)
+      @properties["is_hidden"] = (read_tiny_int(blob) != 0)
+    end
+
+    def parse_block2(blob)
+      @properties["release_date"] = read_huge_int(blob)
+      if @properties["release_date"] == MAX_HUGE_INT
+        @properties["release_date"] = nil
+      end
+
+      @properties["retract_date"] = read_huge_int(blob)
+      if @properties["retract_date"] == MAX_HUGE_INT
+        @properties["retract_date"] = nil
+      end
+    end
+
+    def parse_block3(blob)
+      group_count = read_long_int(blob)
+      @properties["groups"] = []
+      if group_count > 0
+        group_count.times do
+          @properties["groups"] << read_utf_string(blob)
+        end
+      end
+    end
+
+    # properties block types
+    PROPS_BLOCK1 = 100
+    PROPS_BLOCK2 = 101
+    PROPS_BLOCK3 = 102
+
+    def parse_block4(blob)
+      type = read_long_int(blob)
+      if type != 1
+        raise UnknownBinaryEntityFormat.new("Unknown properties serialization type #{type}")
+      end
+
+      props_block_number = read_long_int(blob)
+      if props_block_number == PROPS_BLOCK1
+        props_count = read_long_int(blob)
+      else
+        raise UnknownBinaryEntityFormat.new("Unable to parse properties block")
+      end
+
+      props_count.times do
+        props_block_number = read_long_int(blob)
+        case props_block_number
+        when PROPS_BLOCK2
+          key = read_utf_string(blob)
+          value = read_utf_string(blob)
+          @properties[key] = value
+        when PROPS_BLOCK3
+          key = read_utf_string(blob)
+          @properties[key] = []
+          value_count = read_long_int(blob)
+          value_count.times do
+            @properties[key] << read_utf_string(blob)
+          end
+        else
+          raise UnknownBinaryEntityFormat.new("Unknown Property Block ID: '#{block_number}'")
+        end
+      end
+    end
+  end
 end

data/lib/sakai-info/sakai_xml_entity.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::SakaiXMLEntity
 #
 # Created 2012-02-16 daveadams@gmail.com
-# Last updated 2012-02-29 daveadams@gmail.com
+# Last updated 2012-04-21 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -77,15 +77,8 @@ module SakaiInfo
 
       @dbrow[:_xml_entity_created_by] = @properties["CHEF:creator"]
       @dbrow[:_xml_entity_modified_by] = @properties["CHEF:modifiedby"]
-      @dbrow[:_xml_entity_created_at] = format_entity_date(@properties["DAV:creationdate"])
-      @dbrow[:_xml_entity_modified_at] = format_entity_date(@properties["DAV:getlastmodified"])
-    end
-
-    def format_entity_date(raw)
-      if raw =~ /^(....)(..)(..)(..)(..)(..).*$/
-        # I believe these are usually in UTC
-        Time.utc($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i).getlocal
-      end
+      @dbrow[:_xml_entity_created_at] = Util.format_entity_date(@properties["DAV:creationdate"])
+      @dbrow[:_xml_entity_modified_at] = Util.format_entity_date(@properties["DAV:getlastmodified"])
     end
 
     # serialize all attributes

data/lib/sakai-info/user.rb

@@ -159,7 +159,7 @@ module SakaiInfo
 
     # yaml/json serialization
     def default_serialization
-      {
+      result = {
         "id" => self.id,
         "name" => self.name,
         "eid" => self.eid,
@@ -169,6 +169,10 @@ module SakaiInfo
         "site_count" => self.site_count,
         "question_pool_count" => self.question_pool_count
       }
+      if result["user_properties"] == {}
+        result.delete("user_properties")
+      end
+      result
     end
 
     def summary_serialization

data/lib/sakai-info/version.rb

@@ -1,3 +1,3 @@
 module SakaiInfo
-  VERSION = "0.3.5"
+  VERSION = "0.4.0"
 end

data/lib/sakai-info.rb

@@ -2,7 +2,7 @@
 #   Base library file
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-02-25 daveadams@gmail.com
+# Last updated 2012-04-21 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -59,6 +59,15 @@ module SakaiInfo
         "#{negative ? "-" : ""}#{sprintf("%.1f", size)} #{FILESIZE_LABELS[label]}"
       end
     end
+
+    def self.format_entity_date(raw)
+      if raw =~ /^(....)(..)(..)(..)(..)(..).*$/
+        # I believe these are usually in UTC
+        Time.utc($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i).getlocal
+      else
+        raw
+      end
+    end
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sakai-info
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 5
-  version: 0.3.5
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - David Adams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-02 00:00:00 -05:00
+date: 2012-04-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,7 +49,7 @@ dependencies:
 description: A command line tool and a suite of libraries for representing the objects and relationships defined by a Sakai CLE database.
 email: daveadams@gmail.com
 executables: 
-- sakai-info
+- sin
 extensions: []
 
 extra_rdoc_files: []
@@ -78,7 +78,7 @@ files:
 - lib/sakai-info/content.rb
 - lib/sakai-info/page.rb
 - lib/sakai-info/sakai_xml_entity.rb
-- bin/sakai-info
+- bin/sin
 - README.md
 - LICENSE
 - CHANGELOG.md