moodle2cc 0.0.1

data/lib/moodle2cc/cc/converter.rb

@@ -0,0 +1,136 @@
+module Moodle2CC::CC
+  class Converter
+    include CCHelper
+
+    def initialize(moodle_backup, destination_dir)
+      @resource_factory = Moodle2CC::ResourceFactory.new Moodle2CC::CC
+      @moodle_backup = moodle_backup
+      @export_dir = Dir.mktmpdir
+      @destination_dir = destination_dir
+    end
+
+    def imscc_file_name
+      "#{file_slug(@moodle_backup.course.fullname)}.imscc"
+    end
+
+    def imscc_path
+      @imscc_path ||= File.join(@destination_dir, imscc_file_name)
+    end
+
+    def imscc_tmp_path
+      @imscc_tmp_path ||= File.join(@export_dir, imscc_file_name)
+    end
+
+    def convert
+      File.open(File.join(@export_dir, MANIFEST), 'w') do |file|
+        @document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        @document.instruct!
+        create_manifest
+      end
+      create_web_resources
+      Zip::ZipFile.open(imscc_tmp_path, Zip::ZipFile::CREATE) do |zipfile|
+        Dir["#{@export_dir}/**/*"].each do |file|
+          zipfile.add(file.sub(@export_dir + '/', ''), file)
+        end
+      end
+      FileUtils.mv imscc_tmp_path, imscc_path
+      FileUtils.rm_r @export_dir
+    end
+
+    def create_manifest
+      @document.manifest(
+        "identifier" => create_key(@moodle_backup.course.id, "common_cartridge_"),
+        "xmlns" => "http://www.imsglobal.org/xsd/imsccv1p1/imscp_v1p1",
+        "xmlns:lom" => "http://ltsc.ieee.org/xsd/imsccv1p1/LOM/resource",
+        "xmlns:lomimscc" => "http://ltsc.ieee.org/xsd/imsccv1p1/LOM/manifest",
+        "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+        "xsi:schemaLocation" => "http://www.imsglobal.org/xsd/imsccv1p1/imscp_v1p1 http://www.imsglobal.org/profile/cc/ccv1p1/ccv1p1_imscp_v1p2_v1p0.xsd http://ltsc.ieee.org/xsd/imsccv1p1/LOM/resource http://www.imsglobal.org/profile/cc/ccv1p1/LOM/ccv1p1_lomresource_v1p0.xsd http://ltsc.ieee.org/xsd/imsccv1p1/LOM/manifest http://www.imsglobal.org/profile/cc/ccv1p1/LOM/ccv1p1_lommanifest_v1p0.xsd"
+      ) do |manifest_node|
+        @manifest_node = manifest_node
+        @manifest_node.metadata do |md|
+          md.schema "IMS Common Cartridge"
+          md.schemaversion "1.1.0"
+          md.lomimscc :lom do |lom|
+            lom.lomimscc :general do |general|
+              general.lomimscc :title do |title|
+                title.lomimscc :string, @moodle_backup.course.fullname
+              end
+            end
+            lom.lomimscc :lifeCycle do |lifecycle|
+              lifecycle.lomimscc :contribute do |contribute|
+                contribute.lomimscc :date do |date|
+                  date.lomimscc :dateTime, ims_date
+                end
+              end
+            end
+            lom.lomimscc :rights do |rights|
+              rights.lomimscc :copyrightAndOtherRestrictions do |node|
+                node.lomimscc :value, 'yes'
+              end
+              rights.lomimscc :description do |desc|
+                desc.lomimscc :string, 'Private (Copyrighted) - http://en.wikipedia.org/wiki/Copyright'
+              end
+            end
+          end
+        end
+
+        create_organizations
+
+        @manifest_node.resources do |resources_node|
+          create_resources(resources_node)
+        end
+      end
+    end
+
+    def create_organizations
+      course = Course.new(@moodle_backup.course)
+      @manifest_node.organizations do |orgs|
+        orgs.organization(
+          :identifier => 'org_1',
+          :structure => 'rooted-hierarchy'
+        ) do |org|
+          org.item(:identifier => "LearningModules") do |root_item|
+            @moodle_backup.course.sections.each do |section|
+              next unless section.visible
+              root_item.item(:identifier => create_key(section.id, "section_")) do |item_node|
+                item_node.title "#{course.format} #{section.number}"
+                section.mods.each do |mod|
+                  resource = @resource_factory.get_resource_from_mod(mod.instance)
+                  resource.create_organization_item_node(item_node) if resource
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def create_resources(resources_node)
+      @moodle_backup.course.mods.each_with_index do |mod, index|
+        resource = @resource_factory.get_resource_from_mod(mod, index)
+        if resource
+          resource.create_resource_node(resources_node)
+          resource.create_files(@export_dir)
+        end
+      end
+
+      @moodle_backup.files.each do |file|
+        href = File.join(WEB_RESOURCES_FOLDER, file)
+        resources_node.resource(
+          :type => WEBCONTENT,
+          :identifier => create_key(href, 'resource_'),
+          :href => href
+        ) do |resource_node|
+          resource_node.file(:href => href)
+        end
+      end
+    end
+
+    def create_web_resources
+      web_resources_folder = File.join(@export_dir, WEB_RESOURCES_FOLDER)
+      FileUtils.mkdir(web_resources_folder)
+      @moodle_backup.copy_files_to(web_resources_folder)
+    end
+
+  end
+end

data/lib/moodle2cc/cc/course.rb

@@ -0,0 +1,16 @@
+module Moodle2CC::CC
+  class Course
+    include CCHelper
+
+    attr_accessor :format
+
+    def initialize(course)
+      @format = case course.format
+                when 'weeks', 'weekscss'
+                  'Week'
+                else
+                  'Topic'
+                end
+    end
+  end
+end

data/lib/moodle2cc/cc/discussion_topic.rb

@@ -0,0 +1,53 @@
+module Moodle2CC
+  module CC
+  class DiscussionTopic
+    include CCHelper
+    include Resource
+
+    attr_accessor :text
+
+    def initialize(mod, position=0)
+      super
+      @text = convert_file_path_tokens(mod.intro)
+    end
+
+    def identifierref
+      create_key(id, 'topic_meta_')
+    end
+
+    def create_resource_node(resources_node)
+      resources_node.resource(
+        :type => DISCUSSION_TOPIC,
+        :identifier => identifier
+      ) do |resource_node|
+        resource_node.file(:href => "#{identifier}.xml")
+        create_resource_sub_nodes(resource_node)
+      end
+    end
+
+    def create_resource_sub_nodes(resource_node)
+    end
+
+    def create_files(export_dir)
+      create_topic_xml(export_dir)
+    end
+
+    def create_topic_xml(export_dir)
+      path = File.join(export_dir, "#{identifier}.xml")
+      File.open(path, 'w') do |file|
+        document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        document.instruct!
+        document.topicMeta(
+          :identifier => identifierref,
+          'xsi:schemaLocation' => "http://www.imsglobal.org/xsd/imsccv1p1/imsdt_v1p1 http://www.imsglobal.org/profile/cc/ccv1p1/ccv1p1_imsdt_v1p1.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://www.imsglobal.org/xsd/imsccv1p1/imsdt_v1p1"
+        ) do |topic|
+          topic.title @title
+          topic.text @text, :texttype => 'text/html'
+        end
+      end
+    end
+  end
+end
+end

data/lib/moodle2cc/cc/label.rb

@@ -0,0 +1,6 @@
+module Moodle2CC::CC
+  class Label
+    include CCHelper
+    include Resource
+  end
+end

data/lib/moodle2cc/cc/question.rb

@@ -0,0 +1,23 @@
+module Moodle2CC::CC
+  class Question
+    include CCHelper
+
+    attr_accessor :id, :title, :identifier
+
+    def initialize(question, assessment=nil)
+      @id = question.id
+      @title = (question.name || '').gsub('$@NULL@$', '')
+      @identifier_prefix = "#{assessment.mod.mod_type}_" if assessment
+
+      if question.instance_id
+        @identifier = create_key(question.instance_id, "#{@identifier_prefix}question_instance_")
+      else
+        @identifier = create_key(question.id, "#{@identifier_prefix}question_")
+      end
+    end
+
+    def create_item_xml(section_node)
+    end
+
+  end
+end

data/lib/moodle2cc/cc/resource.rb

@@ -0,0 +1,30 @@
+module Moodle2CC::CC
+  module Resource
+    def self.included(klass)
+      klass.class_eval do
+        attr_accessor :mod, :identifier, :id, :title, :indent
+      end
+    end
+
+    def initialize(mod, *args)
+      @mod = mod
+      @id = mod.id
+      @title = mod.name
+      @indent = mod.section_mod.nil? ? 0 : mod.section_mod.indent
+      @identifier = create_resource_key(mod)
+    end
+
+    def create_files(export_dir)
+    end
+
+    def create_resource_node(resources_node)
+    end
+
+    def create_organization_item_node(item_node)
+      item_node.item(:identifier => create_mod_key(@mod), :identifierref => @identifier) do |sub_item|
+        sub_item.title @title
+      end
+    end
+
+  end
+end

data/lib/moodle2cc/cc/templates/assignment.html.erb

@@ -0,0 +1,9 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Assignment: <%= title %></title>
+</head>
+<body>
+  <%= body %>
+</body>
+</html>

data/lib/moodle2cc/cc/templates/syllabus.html.erb

@@ -0,0 +1,9 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Syllabus</title>
+</head>
+<body>
+<%= syllabus_body %>
+</body>
+</html>

data/lib/moodle2cc/cc/templates/wiki_content.html.erb

@@ -0,0 +1,10 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title><%= title %></title>
+<meta name="identifier" content="<%= identifier %>"/>
+</head>
+<body>
+<%= body %>
+</body>
+</html>

data/lib/moodle2cc/cc/web_content.rb

@@ -0,0 +1,40 @@
+module Moodle2CC::CC
+  class WebContent
+    include CCHelper
+    include Resource
+
+    attr_accessor :body
+
+    def initialize(mod)
+      super
+      body = mod.alltext
+      body = mod.content || '' if body.nil? || body.length == 0
+      @body = convert_file_path_tokens(body)
+    end
+
+    def create_resource_node(resources_node)
+      href = File.join(WIKI_FOLDER, "#{file_slug(@title)}.html")
+      resources_node.resource(
+        :type => WEBCONTENT,
+        :identifier => identifier,
+        :href => href
+      ) do |resource_node|
+        resource_node.file(:href => href)
+      end
+    end
+
+    def create_files(export_dir)
+      create_html(export_dir)
+    end
+
+    def create_html(export_dir)
+      template = File.expand_path('../templates/wiki_content.html.erb', __FILE__)
+      path = File.join(export_dir, 'wiki_content', "#{file_slug(title)}.html")
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        erb = ERB.new(File.read(template))
+        file.write(erb.result(binding))
+      end
+    end
+  end
+end

data/lib/moodle2cc/cc/web_link.rb

@@ -0,0 +1,53 @@
+module Moodle2CC::CC
+  class WebLink
+    include CCHelper
+    include Resource
+
+    attr_accessor :url
+
+    def initialize(mod)
+      super
+      @url = mod.reference
+    end
+
+    def self.create_resource_key(mod)
+      if !URI.parse(mod.reference).scheme
+        create_key(File.join(WEB_RESOURCES_FOLDER, mod.reference), 'resource_')
+      else
+        super
+      end
+    end
+
+    def create_resource_node(resources_node)
+      resources_node.resource(
+        :type => WEB_LINK,
+        :identifier => identifier
+      ) do |resource_node|
+        resource_node.file(:href => "#{identifier}.xml")
+      end
+    end
+
+    def create_files(export_dir)
+      create_xml(export_dir)
+    end
+
+    def create_xml(export_dir)
+      path = File.join(export_dir, "#{identifier}.xml")
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        settings_node = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        settings_node.instruct!
+        settings_node.webLink(
+          :identifier => identifier,
+          'xsi:schemaLocation' => "http://www.imsglobal.org/xsd/imsccv1p1/imswl_v1p1 http://www.imsglobal.org/profile/cc/ccv1p1/ccv1p1_imswl_v1p1.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://www.imsglobal.org/xsd/imsccv1p1/imswl_v1p1"
+        ) do |web_link_node|
+          web_link_node.title @title
+          web_link_node.url(:href => @url)
+        end
+      end
+    end
+
+  end
+end

data/lib/moodle2cc/cc/wiki.rb

@@ -0,0 +1,72 @@
+module Moodle2CC::CC
+  class Wiki
+    include CCHelper
+    include Resource
+
+    attr_accessor :pages
+
+    def initialize(mod)
+      super
+      page_versions = mod.pages.inject({}) do |result, page|
+        version = result[page.page_name]
+        result[page.page_name] = page.version if version.nil? || page.version > version
+        result
+      end
+
+      @pages = mod.pages.map do |page|
+        if page.version == page_versions[page.page_name]
+          title_slug = file_slug(@title)
+          body = page.content
+          slug = [title_slug, file_slug(page.page_name)].join('-')
+          href = "#{WIKI_FOLDER}/#{slug}.html"
+          Moodle2CC::OpenStruct.new(:title => page.page_name, :body => body, :href => href, :identifier => create_key(href))
+        end
+      end.compact
+
+      if @pages.empty?
+        slug = file_slug(@title)
+        href = File.join(WIKI_FOLDER, "#{slug}.html")
+        @pages = [Moodle2CC::OpenStruct.new(:title => @title, :body => mod.summary, :href => href, :identifier => create_key(href))]
+      end
+
+      @identifier = root_page.identifier
+    end
+
+    def self.create_resource_key(mod)
+      Wiki.new(mod).identifer
+    end
+
+    def root_page
+      @pages.find { |page| page.title == @title }
+    end
+
+    def create_resource_node(resources_node)
+      @pages.each do |page|
+        href = page.href
+        resources_node.resource(
+          :href => href,
+          :type => WEBCONTENT,
+          :identifier => create_key(href)
+        ) do |resource_node|
+          resource_node.file(:href => href)
+        end
+      end
+    end
+
+    def create_files(export_dir)
+      create_html(export_dir)
+    end
+
+    def create_html(export_dir)
+      template = File.expand_path('../templates/wiki_content.html.erb', __FILE__)
+      @pages.each do |page|
+        path = File.join(export_dir, page.href)
+        FileUtils.mkdir_p(File.dirname(path))
+        File.open(path, 'w') do |file|
+          erb = ERB.new(File.read(template))
+          file.write(erb.result(page.instance_eval { binding }))
+        end
+      end
+    end
+  end
+end