RubyGems - moodle2cc - Versions diffs - 0.0.1 - Mend

moodle2cc 0.0.1

Files changed (95) hide show

data/.gitignore +20 -0
data/Gemfile +4 -0
data/Guardfile +14 -0
data/LICENSE +661 -0
data/README.md +38 -0
data/Rakefile +12 -0
data/bin/moodle2cc +6 -0
data/lib/moodle2cc.rb +60 -0
data/lib/moodle2cc/canvas/.converter.rb.swo +0 -0
data/lib/moodle2cc/canvas/.wiki.rb.swo +0 -0
data/lib/moodle2cc/canvas/assessment.rb +109 -0
data/lib/moodle2cc/canvas/assignment.rb +108 -0
data/lib/moodle2cc/canvas/converter.rb +28 -0
data/lib/moodle2cc/canvas/course.rb +145 -0
data/lib/moodle2cc/canvas/discussion_topic.rb +64 -0
data/lib/moodle2cc/canvas/label.rb +8 -0
data/lib/moodle2cc/canvas/question.rb +468 -0
data/lib/moodle2cc/canvas/question_bank.rb +54 -0
data/lib/moodle2cc/canvas/resource.rb +16 -0
data/lib/moodle2cc/canvas/templates/assignment.html.erb +9 -0
data/lib/moodle2cc/canvas/templates/syllabus.html.erb +9 -0
data/lib/moodle2cc/canvas/templates/wiki_content.html.erb +10 -0
data/lib/moodle2cc/canvas/web_content.rb +10 -0
data/lib/moodle2cc/canvas/web_link.rb +17 -0
data/lib/moodle2cc/canvas/wiki.rb +25 -0
data/lib/moodle2cc/cc/assessment.rb +25 -0
data/lib/moodle2cc/cc/assignment.rb +66 -0
data/lib/moodle2cc/cc/cc_helper.rb +282 -0
data/lib/moodle2cc/cc/converter.rb +136 -0
data/lib/moodle2cc/cc/course.rb +16 -0
data/lib/moodle2cc/cc/discussion_topic.rb +53 -0
data/lib/moodle2cc/cc/label.rb +6 -0
data/lib/moodle2cc/cc/question.rb +23 -0
data/lib/moodle2cc/cc/resource.rb +30 -0
data/lib/moodle2cc/cc/templates/assignment.html.erb +9 -0
data/lib/moodle2cc/cc/templates/syllabus.html.erb +9 -0
data/lib/moodle2cc/cc/templates/wiki_content.html.erb +10 -0
data/lib/moodle2cc/cc/web_content.rb +40 -0
data/lib/moodle2cc/cc/web_link.rb +53 -0
data/lib/moodle2cc/cc/wiki.rb +72 -0
data/lib/moodle2cc/cli.rb +14 -0
data/lib/moodle2cc/error.rb +3 -0
data/lib/moodle2cc/migrator.rb +23 -0
data/lib/moodle2cc/moodle/backup.rb +38 -0
data/lib/moodle2cc/moodle/course.rb +24 -0
data/lib/moodle2cc/moodle/grade_item.rb +24 -0
data/lib/moodle2cc/moodle/info.rb +8 -0
data/lib/moodle2cc/moodle/mod.rb +127 -0
data/lib/moodle2cc/moodle/question.rb +98 -0
data/lib/moodle2cc/moodle/question_category.rb +17 -0
data/lib/moodle2cc/moodle/section.rb +37 -0
data/lib/moodle2cc/resource_factory.rb +32 -0
data/lib/moodle2cc/version.rb +3 -0
data/moodle2cc.gemspec +29 -0
data/test/acceptance/migrator_test.rb +23 -0
data/test/fixtures/cc.imscc +0 -0
data/test/fixtures/moodle_backup/course_files/folder/test.txt +1 -0
data/test/fixtures/moodle_backup/course_files/test.txt +1 -0
data/test/fixtures/moodle_backup/moodle.xml +916 -0
data/test/test_helper.rb +43 -0
data/test/test_question_helper.rb +107 -0
data/test/test_wiki_helper.rb +21 -0
data/test/unit/canvas/assessment_test.rb +218 -0
data/test/unit/canvas/assignment_test.rb +220 -0
data/test/unit/canvas/converter_test.rb +159 -0
data/test/unit/canvas/course_test.rb +176 -0
data/test/unit/canvas/discussion_topic_test.rb +129 -0
data/test/unit/canvas/label_test.rb +32 -0
data/test/unit/canvas/question_bank_test.rb +73 -0
data/test/unit/canvas/question_test.rb +824 -0
data/test/unit/canvas/web_content_test.rb +37 -0
data/test/unit/canvas/web_link_test.rb +48 -0
data/test/unit/canvas/wiki_test.rb +74 -0
data/test/unit/cc/assessment_test.rb +48 -0
data/test/unit/cc/assignment_test.rb +67 -0
data/test/unit/cc/cc_helper_test.rb +19 -0
data/test/unit/cc/converter_test.rb +159 -0
data/test/unit/cc/course_test.rb +36 -0
data/test/unit/cc/discussion_topic_test.rb +83 -0
data/test/unit/cc/label_test.rb +29 -0
data/test/unit/cc/question_test.rb +49 -0
data/test/unit/cc/web_content_test.rb +76 -0
data/test/unit/cc/web_link_test.rb +79 -0
data/test/unit/cc/wiki_test.rb +139 -0
data/test/unit/migrator_test.rb +56 -0
data/test/unit/moodle/backup_test.rb +30 -0
data/test/unit/moodle/course_test.rb +57 -0
data/test/unit/moodle/grade_item_test.rb +72 -0
data/test/unit/moodle/info_test.rb +21 -0
data/test/unit/moodle/mod_test.rb +301 -0
data/test/unit/moodle/question_category_test.rb +34 -0
data/test/unit/moodle/question_test.rb +185 -0
data/test/unit/moodle/section_test.rb +75 -0
data/test/unit/resource_factory_test.rb +119 -0
metadata +342 -0

data/lib/moodle2cc/canvas/question_bank.rb ADDED Viewed

@@ -0,0 +1,54 @@
+module Moodle2CC::Canvas
+  class QuestionBank
+    include Moodle2CC::CC::CCHelper
+    attr_accessor :id, :title, :identifier
+    def initialize(question_category)
+      @id = question_category.id
+      @title = question_category.name
+      @identifier = create_key(@id, 'objectbank_')
+      @question_category = question_category
+    end
+    def create_resource_node(resources_node)
+      href = File.join(ASSESSMENT_NON_CC_FOLDER, "#{identifier}.xml.qti")
+      resources_node.resource(
+        :href => href,
+        :type => LOR,
+        :identifier => identifier
+      ) do |resource_node|
+        resource_node.file(:href => href)
+      end
+    end
+    def create_files(export_dir)
+      create_qti_xml(export_dir)
+    end
+    def create_qti_xml(export_dir)
+      path = File.join(export_dir, ASSESSMENT_NON_CC_FOLDER, "#{identifier}.xml.qti")
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        node = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        node.instruct!
+        node.questestinterop(
+          'xsi:schemaLocation' => "http://www.imsglobal.org/xsd/ims_qtiasiv1p2 http://www.imsglobal.org/xsd/ims_qtiasiv1p2p1.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://www.imsglobal.org/xsd/ims_qtiasiv1p2"
+        ) do |root_node|
+          root_node.objectbank(:ident => identifier) do |objectbank_node|
+            objectbank_node.qtimetadata do |qtimetadata_node|
+              qtimetadata_node.qtimetadatafield do |qtimetadatafield_node|
+                qtimetadatafield_node.fieldlabel "bank_title"
+                qtimetadatafield_node.fieldentry @title
+              end
+            end
+            @question_category.questions.each do |question|
+              Question.new(question).create_item_xml(objectbank_node) if question
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moodle2cc/canvas/resource.rb ADDED Viewed

@@ -0,0 +1,16 @@
+module Moodle2CC::Canvas
+  module Resource
+    def create_module_meta_item_node(items_node, position)
+      items_node.item(:identifier => create_mod_key(@mod)) do |item_node|
+        item_node.title @title
+        item_node.position position
+        item_node.new_tab ''
+        item_node.indent @indent
+        create_module_meta_item_elements(item_node)
+      end
+    end
+    def create_module_meta_item_elements(item_node)
+    end
+  end
+end

data/lib/moodle2cc/canvas/templates/assignment.html.erb ADDED Viewed

@@ -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/canvas/templates/syllabus.html.erb ADDED Viewed

@@ -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/canvas/templates/wiki_content.html.erb ADDED Viewed

@@ -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/canvas/web_content.rb ADDED Viewed

@@ -0,0 +1,10 @@
+module Moodle2CC::Canvas
+  class WebContent < Moodle2CC::CC::WebContent
+    include Resource
+    def create_module_meta_item_elements(item_node)
+      item_node.content_type 'WikiPage'
+      item_node.identifierref @identifier
+    end
+  end
+end

data/lib/moodle2cc/canvas/web_link.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module Moodle2CC::Canvas
+  class WebLink < Moodle2CC::CC::WebLink
+    include Resource
+    def create_module_meta_item_elements(item_node)
+      item_node.identifierref @identifier
+      uri = URI.parse(@url)
+      if uri.scheme
+        item_node.url @url
+        item_node.content_type 'ExternalUrl'
+      else
+        item_node.content_type 'Attachment'
+      end
+    end
+  end
+end

data/lib/moodle2cc/canvas/wiki.rb ADDED Viewed

@@ -0,0 +1,25 @@
+module Moodle2CC::Canvas
+  class Wiki < Moodle2CC::CC::Wiki
+    include Resource
+    attr_accessor :pages
+    def initialize(mod)
+      super
+      @pages.map! do |page|
+        page.body.gsub!(/\[(.*?)\]/) do |match|
+          title_slug = file_slug(@title)
+          slug = [title_slug, file_slug(match)].join('-')
+          href = File.join(CGI.escape(WIKI_TOKEN), 'wiki', slug)
+          %(<a href="#{href}" title="#{$1}">#{$1}</a>)
+        end
+        page
+      end
+    end
+    def create_module_meta_item_elements(item_node)
+      item_node.content_type 'WikiPage'
+      item_node.identifierref @identifier
+    end
+  end
+end

data/lib/moodle2cc/cc/assessment.rb ADDED Viewed

@@ -0,0 +1,25 @@
+module Moodle2CC::CC
+  class Assessment
+    include CCHelper
+    include Resource
+    def initialize(mod, position=0)
+      super
+    end
+    def create_resource_node(resources_node)
+      resources_node.resource(
+        :identifier => identifier,
+        :type => ASSESSMENT_TYPE
+      ) do |resource_node|
+        create_resource_sub_nodes(resource_node)
+      end
+    end
+    def create_resource_sub_nodes(resource_node)
+    end
+    def create_files(export_dir)
+    end
+  end
+end

data/lib/moodle2cc/cc/assignment.rb ADDED Viewed

@@ -0,0 +1,66 @@
+module Moodle2CC::CC
+  class Assignment
+    include CCHelper
+    include Resource
+    attr_accessor :body
+    def initialize(mod, position=0)
+      super
+      @body = convert_file_path_tokens(mod.description)
+    end
+    def get_submission_types(mod)
+      if mod.mod_type == 'assignment'
+        case mod.assignment_type
+        when 'online'
+          'online_text_entry'
+        when 'upload'
+          if mod.var2 == 1
+            'online_upload,online_text_entry'
+          else
+            'online_upload'
+          end
+        when 'uploadsingle'
+          'online_upload'
+        else
+          'none'
+        end
+      elsif mod.mod_type == 'workshop'
+        submission_types = ['online_text_entry']
+        submission_types.unshift('online_upload') if mod.number_of_attachments > 0
+        submission_types.join(',')
+      end
+    end
+    def create_resource_node(resources_node)
+      href = "#{identifier}/#{file_slug(@title)}.html"
+      resources_node.resource(
+        :href => href,
+        :type => LOR,
+        :identifier => identifier
+      ) do |resource_node|
+        resource_node.file(:href => href)
+        create_resource_sub_nodes(resource_node)
+      end
+    end
+    def create_resource_sub_nodes(resource_node)
+    end
+    def create_files(export_dir)
+      create_html(export_dir)
+    end
+    def create_html(export_dir)
+      template = File.expand_path('../templates/assignment.html.erb', __FILE__)
+      path = File.join(export_dir, identifier, "#{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/cc_helper.rb ADDED Viewed

@@ -0,0 +1,282 @@
+require 'digest/md5'
+module Moodle2CC::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'
+  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