canvas_cc 0.0.1

data/lib/canvas_cc/cc/cc_helper.rb

@@ -0,0 +1,285 @@
+require 'digest/md5'
+
+module CanvasCc::CC
+module CCHelper
+
+  CANVAS_NAMESPACE = 'http://canvas.instructure.com/xsd/cccv1p0'
+  XSD_URI = 'http://canvas.instructure.com/xsd/cccv1p0.xsd'
+
+  # IMS formats/types
+  IMS_DATE = "%Y-%m-%d"
+  IMS_DATETIME = "%Y-%m-%dT%H:%M:%S"
+  CC_EXTENSION = 'imscc'
+  QTI_EXTENSION = ".xml.qti"
+  CANVAS_PLATFORM = 'canvas.instructure.com'
+
+  # Common Cartridge 1.0
+  # associatedcontent/imscc_xmlv1p0/learning-application-resource
+  # imsdt_xmlv1p0
+  # imswl_xmlv1p0
+  # imsqti_xmlv1p2/imscc_xmlv1p0/assessment
+  # imsqti_xmlv1p2/imscc_xmlv1p0/question-bank
+
+  # Common Cartridge 1.1 (What Canvas exports)
+  ASSESSMENT_TYPE = 'imsqti_xmlv1p2/imscc_xmlv1p1/assessment'
+  QUESTION_BANK = 'imsqti_xmlv1p2/imscc_xmlv1p1/question-bank'
+  DISCUSSION_TOPIC = "imsdt_xmlv1p1"
+  LOR = "associatedcontent/imscc_xmlv1p1/learning-application-resource"
+  WEB_LINK = "imswl_xmlv1p1"
+  WEBCONTENT = "webcontent"
+  BASIC_LTI = 'imsbasiclti_xmlv1p0'
+  BLTI_NAMESPACE = "http://www.imsglobal.org/xsd/imsbasiclti_v1p0"
+
+  # Common Cartridge 1.2
+  # associatedcontent/imscc_xmlv1p2/learning-application-resource
+  # imsdt_xmlv1p2
+  # imswl_xmlv1p2
+  # imsqti_xmlv1p2/imscc_xmlv1p2/assessment
+  # imsqti_xmlv1p2/imscc_xmlv1p2/question-bank
+  # imsbasiclti_xmlv1p0
+
+  # QTI-only export
+  QTI_ASSESSMENT_TYPE = 'imsqti_xmlv1p2'
+
+  # substitution tokens
+  OBJECT_TOKEN = "$CANVAS_OBJECT_REFERENCE$"
+  COURSE_TOKEN = "$CANVAS_COURSE_REFERENCE$"
+  WIKI_TOKEN = "$WIKI_REFERENCE$"
+  WEB_CONTENT_TOKEN = "$IMS_CC_FILEBASE$"
+  MOODLE_FILEBASE_TOKEN = "$@FILEPHP@$"
+  MOODLE_SLASH_TOKEN = "$@SLASH@$"
+
+  # file names/paths
+  ASSESSMENT_CC_QTI = "assessment_qti.xml"
+  ASSESSMENT_NON_CC_FOLDER = 'non_cc_assessments'
+  ASSESSMENT_META = "assessment_meta.xml"
+  ASSIGNMENT_GROUPS = "assignment_groups.xml"
+  ASSIGNMENT_SETTINGS = "assignment_settings.xml"
+  COURSE_SETTINGS = "course_settings.xml"
+  COURSE_SETTINGS_DIR = "course_settings"
+  EXTERNAL_FEEDS = "external_feeds.xml"
+  GRADING_STANDARDS = "grading_standards.xml"
+  EVENTS = "events.xml"
+  LEARNING_OUTCOMES = "learning_outcomes.xml"
+  MANIFEST = 'imsmanifest.xml'
+  MODULE_META = "module_meta.xml"
+  RUBRICS = "rubrics.xml"
+  EXTERNAL_TOOLS = "external_tools.xml"
+  FILES_META = "files_meta.xml"
+  SYLLABUS = "syllabus.html"
+  WEB_RESOURCES_FOLDER = 'web_resources'
+  WIKI_FOLDER = 'wiki_content'
+  MEDIA_OBJECTS_FOLDER = 'media_objects'
+  
+  CC_ASSIGNMENT_FOLDER = File.join(WEB_RESOURCES_FOLDER, "assignments")
+  CC_WIKI_FOLDER = File.join(WEB_RESOURCES_FOLDER, "pages")
+
+  def create_key(object, prepend="")
+    CCHelper.create_key(object, prepend)
+  end
+
+  def create_mod_key(mod)
+    CCHelper.create_mod_key(mod)
+  end
+
+  def create_resource_key(mod)
+    CCHelper.create_resource_key(mod)
+  end
+
+  def ims_date(date=nil)
+    CCHelper.ims_date(date)
+  end
+
+  def ims_datetime(date=nil)
+    CCHelper.ims_datetime(date)
+  end
+
+  def file_slug(name)
+    CCHelper.file_slug(name)
+  end
+
+  def convert_file_path_tokens(content)
+    CCHelper.convert_file_path_tokens(content)
+  end
+
+  def self.create_key(object, prepend="")
+    key = object.to_s
+    "i" + Digest::MD5.hexdigest(prepend + key)
+  end
+
+  def self.create_mod_key(mod)
+    create_key("#{mod.mod_type}_#{mod.id}", 'mod_')
+  end
+
+  def self.create_resource_key(mod)
+    create_key("#{mod.mod_type}_#{mod.id}", 'resource_')
+  end
+
+  def self.ims_date(date=nil)
+    date ||= Time.now
+    date.respond_to?(:utc) ? date.utc.strftime(IMS_DATE) : date.strftime(IMS_DATE)
+  end
+
+  def self.ims_datetime(date=nil)
+    date ||= Time.now
+    date.respond_to?(:utc) ? date.utc.strftime(IMS_DATETIME) : date.strftime(IMS_DATETIME)
+  end
+
+  def self.file_slug(name)
+    slug = name.downcase.gsub(/\s/, '-').gsub(/[^a-z0-9\.\-]/, '').gsub(/\.*$/, '')
+  end
+
+  def self.convert_file_path_tokens(content)
+    content.gsub(MOODLE_FILEBASE_TOKEN, WEB_CONTENT_TOKEN).gsub(MOODLE_SLASH_TOKEN, '/')
+  end
+
+  def get_html_title_and_body_and_id(doc)
+    id = get_node_val(doc, 'html head meta[name=identifier] @content')
+    get_html_title_and_body(doc) << id
+  end
+
+  def get_html_title_and_body_and_meta_fields(doc)
+    meta_fields = {}
+    doc.css('html head meta').each do |meta_node|
+      if key = meta_node['name']
+        meta_fields[key] = meta_node['content']
+      end
+    end
+    get_html_title_and_body(doc) << meta_fields
+  end
+
+  def get_html_title_and_body(doc)
+    title = get_node_val(doc, 'html head title')
+    body = doc.at_css('html body').to_s.gsub(%r{</?body>}, '').strip
+    [title, body]
+  end
+
+  require 'set'
+  class HtmlContentExporter
+    attr_reader :used_media_objects, :media_object_flavor, :media_object_infos
+    attr_accessor :referenced_files
+
+    def initialize(course, user, opts = {})
+      @media_object_flavor = opts[:media_object_flavor]
+      @used_media_objects = Set.new
+      @media_object_infos = {}
+      @rewriter = UserContent::HtmlRewriter.new(course, user)
+      @course = course
+      @user = user
+      @track_referenced_files = opts[:track_referenced_files]
+      @for_course_copy = opts[:for_course_copy]
+      @referenced_files = {}
+
+      @rewriter.set_handler('file_contents') do |match|
+        if match.url =~ %r{/media_objects/(\d_\w+)}
+          # This is a media object referencing an attachment that it shouldn't be
+          "/media_objects/#{$1}"
+        else
+          match.url.gsub(/course( |%20)files/, WEB_CONTENT_TOKEN)
+        end
+      end
+      @rewriter.set_handler('files') do |match|
+        obj = match.obj_class.find_by_id(match.obj_id)
+        next(match.url) unless obj && @rewriter.user_can_view_content?(obj)
+        folder = obj.folder.full_name.gsub(/course( |%20)files/, WEB_CONTENT_TOKEN)
+        @referenced_files[obj.id] = CCHelper.create_key(obj) if @track_referenced_files && !@referenced_files[obj.id]
+        # for files, turn it into a relative link by path, rather than by file id
+        # we retain the file query string parameters
+        "#{folder}/#{URI.escape(obj.display_name)}#{CCHelper.file_query_string(match.rest)}"
+      end
+      @rewriter.set_handler('wiki') do |match|
+        "#{WIKI_TOKEN}/#{match.type}#{match.rest}"
+      end
+      @rewriter.set_default_handler do |match|
+        new_url = match.url
+        if match.obj_id
+          obj = match.obj_class.find_by_id(match.obj_id)
+          if obj && @rewriter.user_can_view_content?(obj)
+            # for all other types,
+            # create a migration id for the object, and use that as the new link
+            migration_id = CCHelper.create_key(obj)
+            new_url = "#{OBJECT_TOKEN}/#{match.type}/#{migration_id}"
+          end
+        else
+          new_url = "#{COURSE_TOKEN}/#{match.type}#{match.rest}"
+        end
+        new_url
+      end
+    end
+
+    attr_reader :course, :user
+
+    def html_page(html, title, meta_fields={})
+      content = html_content(html)
+      meta_html = ""
+      meta_fields.each_pair do |k, v|
+        next unless v.present?
+        meta_html += %{<meta name="#{k}" content="#{v}"/>\n}
+      end
+
+      %{<html>\n<head>\n<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\n<title>#{title}</title>\n#{meta_html}</head>\n<body>\n#{content}\n</body>\n</html>}
+    end
+
+    def html_content(html)
+      html = @rewriter.translate_content(html)
+      return html if html.blank? || @for_course_copy
+
+      # keep track of found media comments, and translate them into links into the files tree
+      # if imported back into canvas, they'll get uploaded to the media server
+      # and translated back into media comments
+      doc = Nokogiri::HTML::DocumentFragment.parse(html)
+      doc.css('a.instructure_inline_media_comment').each do |anchor|
+        next unless anchor['id']
+        media_id = anchor['id'].gsub(/^media_comment_/, '')
+        obj = course.media_objects.by_media_id(media_id).first
+        if obj && obj.context == course && migration_id = CCHelper.create_key(obj)
+          @used_media_objects << obj
+          info = CCHelper.media_object_info(obj, nil, media_object_flavor)
+          @media_object_infos[obj.id] = info
+          anchor['href'] = File.join(WEB_CONTENT_TOKEN, MEDIA_OBJECTS_FOLDER, info[:filename])
+        end
+      end
+
+      return doc.to_s
+    end
+  end
+
+  def self.media_object_info(obj, client = nil, flavor = nil)
+    unless client
+      client = Kaltura::ClientV3.new
+      client.startSession(Kaltura::SessionType::ADMIN)
+    end
+    if flavor
+      assets = client.flavorAssetGetByEntryId(obj.media_id)
+      asset = assets.sort_by { |f| f[:size].to_i }.reverse.find { |f| f[:containerFormat] == flavor }
+      asset ||= assets.first
+    else
+      asset = client.flavorAssetGetOriginalAsset(obj.media_id)
+    end
+    # we use the media_id as the export filename, since it is guaranteed to
+    # be unique
+    filename = "#{obj.media_id}.#{asset[:fileExt]}" if asset
+    { :asset => asset, :filename => filename }
+  end
+
+  # sub_path is the last part of a file url: /courses/1/files/1(/download)
+  # we want to handle any sort of extra params to the file url, both in the
+  # path components and the query string
+  def self.file_query_string(sub_path)
+    return if sub_path.blank?
+    qs = []
+    uri = URI.parse(sub_path)
+    unless uri.path == "/preview" # defaults to preview, so no qs added
+      qs << "canvas_#{Rack::Utils.escape(uri.path[1..-1])}=1"
+    end
+
+    Rack::Utils.parse_query(uri.query).each do |k,v|
+      qs << "canvas_qs_#{Rack::Utils.escape(k)}=#{Rack::Utils.escape(v)}"
+    end
+
+    return nil if qs.blank?
+    "?#{qs.join("&")}"
+  end
+
+end
+end

data/lib/canvas_cc/cc/converter.rb

@@ -0,0 +1,137 @@
+module CanvasCc::CC
+  class Converter
+    include CCHelper
+
+    def initialize(moodle_backup, destination_dir)
+      @resource_factory = CanvasCc::ResourceFactory.new CanvasCc::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::File.open(imscc_tmp_path, Zip::File::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 if section.mods.length == 0
+              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)
+      resources = []
+      @moodle_backup.course.mods.each_with_index do |mod, index|
+        resources << @resource_factory.get_resource_from_mod(mod, index)
+      end
+      @moodle_backup.files.each do |file|
+        unless resources.find { |r| r.respond_to?(:url) && r.url == file }
+          mod = CanvasCc::Moodle::Mod.new
+          mod.mod_type = 'resource'
+          mod.type = 'file'
+          mod.reference = file
+          mod.course = @moodle_backup.course
+          resources << @resource_factory.get_resource_from_mod(mod)
+        end
+      end
+
+      resources.compact.each do |resource|
+        resource.create_resource_node(resources_node)
+        resource.create_files(@export_dir)
+      end
+    end
+
+    def create_web_resources
+      web_resources_folder = File.join(@export_dir, WEB_RESOURCES_FOLDER)
+      FileUtils.mkdir_p(web_resources_folder)
+      @moodle_backup.copy_files_to(web_resources_folder)
+    end
+
+  end
+end

data/lib/canvas_cc/cc/course.rb

@@ -0,0 +1,16 @@
+module CanvasCc::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/canvas_cc/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/canvas_cc/cc/label.rb

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

data/lib/canvas_cc/cc/question.rb

@@ -0,0 +1,23 @@
+module CanvasCc::CC
+  class Question
+    include CCHelper
+
+    attr_accessor :id, :title, :identifier
+
+    def initialize(question, assessment=nil)
+      @id = question.id
+      @title = CGI.unescapeHTML((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/canvas_cc/cc/resource.rb

@@ -0,0 +1,30 @@
+module CanvasCc::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/canvas_cc/cc/templates/assignment.html.erb

@@ -0,0 +1,13 @@
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <% if meta_fields
+       meta_fields.each_pair do |key, val|%>
+  <meta name="<%= key %>" content="<%= val %>" /> <% end %>
+  <% end %>
+  <title>Assignment: <%= title %></title>
+</head>
+<body>
+<%= body %>
+</body>
+</html>

data/lib/canvas_cc/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/canvas_cc/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/canvas_cc/cc/web_content.rb

@@ -0,0 +1,48 @@
+module CanvasCc::CC
+  class WebContent
+    include CCHelper
+    include Resource
+
+    attr_accessor :body
+
+    def initialize(mod)
+      super
+      @rel_path = File.join(CC_WIKI_FOLDER, "#{file_slug(@title)}.html")
+      body = mod.alltext
+      body = mod.content || '' if body.nil? || body.length == 0
+      if body.nil? || body.length == 0 && mod.summary
+        body = mod.summary
+        url = mod.reference.to_s.strip
+        unless url.gsub(%r{http(s)?://}, '').length == 0
+          body += %(<p><a href="#{CGI.escapeHTML(url)}" title="#{CGI.escapeHTML(@title)}">#{@title}</a></p>)
+        end
+      end
+      @body = convert_file_path_tokens(body)
+    end
+
+    def create_resource_node(resources_node)
+      href = @rel_path
+      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, @rel_path)
+      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