moodle2cc 0.1.12 → 0.2.0

data/lib/moodle2cc/moodle2/parsers/question_parsers/random_sa_parser.rb

@@ -0,0 +1,17 @@
+module Moodle2CC::Moodle2
+  class Parsers::QuestionParsers::RandomSAParser < Parsers::QuestionParsers::QuestionParser
+    include Parsers::ParserHelper
+    register_parser_type('randomsamatch')
+
+    def parse_question(node)
+      question = super
+
+      if choose_node = node.at_xpath("plugin_qtype_randomsamatch_question/randomsamatch/choose")
+        question.choose = choose_node.text
+      end
+
+      question
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2/parsers/question_parsers/short_answer_parser.rb

@@ -0,0 +1,16 @@
+module Moodle2CC::Moodle2
+  class Parsers::QuestionParsers::ShortAnswerParser < Parsers::QuestionParsers::QuestionParser
+    include Parsers::ParserHelper
+    register_parser_type('shortanswer')
+
+    def parse_question(node)
+      question = super
+
+      answer_parser = Parsers::AnswerParser.new
+      question.answers += node.search('answers/answer').map { |n| answer_parser.parse(n) }
+
+      question
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2/parsers/question_parsers/true_false_parser.rb

@@ -0,0 +1,20 @@
+module Moodle2CC::Moodle2
+  class Parsers::QuestionParsers::TrueFalseParser < Parsers::QuestionParsers::QuestionParser
+    include Parsers::ParserHelper
+    register_parser_type('truefalse')
+
+    def parse_question(node)
+      question = super
+      q_node = node.at_xpath('plugin_qtype_truefalse_question')
+      question.true_false_id = q_node.at_xpath('truefalse/@id').value
+      question.true_answer = parse_text(q_node, 'truefalse/trueanswer')
+      question.false_answer = parse_text(q_node, 'truefalse/falseanswer')
+
+      answer_parser = Parsers::AnswerParser.new
+      question.answers += node.search('answers/answer').map { |n| answer_parser.parse(n) }
+
+      question
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2/parsers/quiz_parser.rb

@@ -0,0 +1,87 @@
+module Moodle2CC::Moodle2::Parsers
+  class QuizParser
+    include ParserHelper
+
+    QUIZ_XML = 'quiz.xml'
+    QUIZ_MODULE_NAME = 'quiz'
+
+    def initialize(backup_dir)
+      @backup_dir = backup_dir
+    end
+
+    def parse
+      activity_dirs = activity_directories(@backup_dir, QUIZ_MODULE_NAME)
+      activity_dirs.map { |dir| parse_quiz(dir) }
+    end
+
+    private
+
+    def parse_quiz(dir)
+      quiz = Moodle2CC::Moodle2::Models::Quizzes::Quiz.new
+      activity_dir = File.join(@backup_dir, dir)
+      File.open(File.join(activity_dir, QUIZ_XML)) do |f|
+        xml = Nokogiri::XML(f)
+        quiz.id = xml.at_xpath('/activity/quiz/@id').value
+        quiz.module_id = xml.at_xpath('/activity/@moduleid').value
+        quiz.name = parse_text(xml, '/activity/quiz/name')
+        quiz.intro = parse_text(xml, '/activity/quiz/intro')
+        quiz.intro_format = parse_text(xml, '/activity/quiz/introformat')
+        quiz.time_open = parse_text(xml, '/activity/quiz/timeopen')
+        quiz.time_close = parse_text(xml, '/activity/quiz/timeclose')
+        quiz.time_limit = parse_text(xml, '/activity/quiz/timelimit')
+        quiz.overdue_handling = parse_text(xml, '/activity/quiz/overduehandling')
+        quiz.grace_period = parse_text(xml, '/activity/quiz/graceperiod')
+        quiz.preferred_behavior = parse_text(xml, '/activity/quiz/preferredbehaviour')
+        quiz.attempts_number = parse_text(xml, '/activity/quiz/attempts_number')
+        quiz.attempt_on_last = parse_text(xml, '/activity/quiz/attemptonlast')
+        quiz.grade_method = parse_text(xml, '/activity/quiz/grademethod')
+        quiz.decimal_points = parse_text(xml, '/activity/quiz/decimalpoints')
+        quiz.question_decimal_points = parse_text(xml, '/activity/quiz/questiondecimalpoints')
+        quiz.review_attempt = parse_text(xml, '/activity/quiz/reviewattempt')
+        quiz.review_correctness = parse_text(xml, '/activity/quiz/reviewcorrectness')
+        quiz.review_marks = parse_text(xml, '/activity/quiz/reviewmarks')
+        quiz.review_specific_feedback = parse_text(xml, '/activity/quiz/reviewspecificfeedback')
+        quiz.review_general_feedback = parse_text(xml, '/activity/quiz/reviewgeneralfeedback')
+        quiz.review_right_answer = parse_text(xml, '/activity/quiz/reviewrightanswer')
+        quiz.review_overall_feedback = parse_text(xml, '/activity/quiz/reviewoverallfeedback')
+        quiz.questions_per_page = parse_text(xml, '/activity/quiz/questionsperpage')
+        quiz.nav_method = parse_text(xml, '/activity/quiz/navmethod')
+
+        quiz.shuffle_questions = parse_boolean(xml, '/activity/quiz/shufflequestions')
+        quiz.shuffle_answers = parse_boolean(xml, '/activity/quiz/shuffleanswers')
+
+        quiz.sum_grades = parse_text(xml, '/activity/quiz/sumgrades')
+        quiz.grade = parse_text(xml, '/activity/quiz/grade')
+        quiz.time_created = parse_text(xml, '/activity/quiz/timecreated')
+        quiz.time_modified = parse_text(xml, '/activity/quiz/timemodified')
+        quiz.password = parse_text(xml, '/activity/quiz/password')
+        quiz.subnet = parse_text(xml, '/activity/quiz/subnet')
+        quiz.browser_security = parse_text(xml, '/activity/quiz/browsersecurity')
+        quiz.delay1 = parse_text(xml, '/activity/quiz/delay1')
+        quiz.delay2 = parse_text(xml, '/activity/quiz/delay2')
+        quiz.show_user_picture = parse_text(xml, '/activity/quiz/showuserpicture')
+        quiz.show_blocks = parse_text(xml, '/activity/quiz/showblocks')
+
+        xml.search('/activity/quiz/question_instances/question_instance').each do |node|
+          quiz.question_instances << {
+            :question => parse_text(node, 'question'),
+            :grade => parse_text(node, 'grade')
+          }
+        end
+
+        xml.search('/activity/quiz/feedbacks/feedback').each do |node|
+          quiz.feedbacks << {
+            :text => parse_text(node, 'feedbacktext'),
+            :format => parse_text(node, 'feedbacktextformat'),
+            :min_grade => parse_text(node, 'mingrade'),
+            :max_grade => parse_text(node, 'maxgrade')
+          }
+        end
+      end
+      parse_module(activity_dir, quiz)
+
+      quiz
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2/parsers/resource_parser.rb

@@ -0,0 +1,54 @@
+module Moodle2CC::Moodle2::Parsers
+  class ResourceParser
+    include ParserHelper
+
+    RESOURCE_XML = 'resource.xml'
+    RESOURCE_MODULE_NAME = 'resource'
+
+    def initialize(backup_dir)
+      @backup_dir = backup_dir
+    end
+
+    def parse
+      activity_dirs = activity_directories(@backup_dir, RESOURCE_MODULE_NAME)
+      activity_dirs.map { |dir| parse_resource(dir) }
+    end
+
+    private
+
+    def parse_resource(dir)
+      resource = Moodle2CC::Moodle2::Models::Resource.new
+      activity_dir = File.join(@backup_dir, dir)
+      File.open(File.join(activity_dir, RESOURCE_XML)) do |f|
+        xml = Nokogiri::XML(f).at_xpath('/activity/resource')
+        resource.id = xml.at_xpath('@id').value
+        resource.module_id = xml.at_xpath('/activity/@moduleid').value
+        resource.name = parse_text(xml, 'name')
+        resource.intro = parse_text(xml, 'intro')
+        resource.intro_format = parse_text(xml, 'introformat')
+        resource.to_be_migrated = parse_text(xml, 'tobemigrated')
+        resource.legacy_files = parse_text(xml, 'legacyfiles')
+        resource.legacy_files_last = parse_text(xml, 'legacyfileslast')
+        resource.display = parse_text(xml, 'display')
+        resource.display_options = parse_text(xml, 'displayoptions')
+        resource.filter_files = parse_text(xml, 'filterfiles')
+      end
+      parse_module(activity_dir, resource)
+      resource.file_ids += parse_files(dir)
+      resource
+    end
+
+
+    def parse_files(dir)
+      files = []
+      File.open(File.join(@backup_dir, dir, FILES_XML)) do |f|
+        xml = Nokogiri::XML(f)
+        xml.search('/inforef/fileref/file').each do |node|
+          files << parse_text(node, 'id')
+        end
+      end
+      files
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2/parsers/section_parser.rb

@@ -0,0 +1,48 @@
+module Moodle2CC::Moodle2::Parsers
+  class SectionParser
+    include ParserHelper
+
+    SECTION_XML = 'section.xml'
+
+    def initialize(backup_dir)
+      @backup_dir = backup_dir
+    end
+
+    def parse
+      section_directories.each_with_index.map { |section, i| parse_section(section, i) }
+    end
+
+    private
+
+    def parse_section(section_dir, i)
+      section = Moodle2CC::Moodle2::Models::Section.new
+      File.open(File.join(@backup_dir, section_dir, SECTION_XML)) do |f|
+        section_xml = Nokogiri::XML(f)
+        section.position = i
+        section.id = section_xml.%('/section/@id').value
+        section.number = parse_text(section_xml, '/section/number')
+        section.name = parse_text(section_xml, '/section/name')
+        section.summary = parse_text(section_xml, '/section/summary')
+        section.summary_format = parse_text(section_xml, 'section/summaryformat')
+        section.sequence = parse_text(section_xml, 'section/sequence')
+        section.sequence = section.sequence.split(',') if section.sequence
+        section.visible = parse_text(section_xml, 'section/visible') == '1' ? true : false
+        section.available_from = parse_text(section_xml, 'section/availablefrom')
+        section.available_until = parse_text(section_xml, 'section/availableuntil')
+        section.show_availability = parse_text(section_xml, 'section/showavailability')
+        section.grouping_id = parse_text(section_xml, 'section/groupingid')
+      end
+      section
+    end
+
+    private
+
+    def section_directories
+      File.open(File.join(@backup_dir, Moodle2CC::Moodle2::Extractor::MOODLE_BACKUP_XML)) do |f|
+        moodle_backup_xml = Nokogiri::XML(f)
+        sections = moodle_backup_xml / '/moodle_backup/information/contents/sections/section'
+        sections.map { |section| section./('directory').text }
+      end
+    end
+  end
+end

data/lib/moodle2cc/moodle2converter/assessment_converter.rb

@@ -0,0 +1,31 @@
+module Moodle2CC::Moodle2Converter
+  class AssessmentConverter
+    include ConverterHelper
+
+    def convert(moodle_quiz)
+      canvas_assessment = Moodle2CC::CanvasCC::Models::Assessment.new
+      canvas_assessment.identifier = generate_unique_identifier_for(moodle_quiz.id, ASSESSMENT_SUFFIX)
+      canvas_assessment.title = moodle_quiz.name
+      canvas_assessment.description = moodle_quiz.intro
+      canvas_assessment.workflow_state = workflow_state(moodle_quiz.visible)
+
+      canvas_assessment.lock_at = Time.at(Integer(moodle_quiz.time_close)) if moodle_quiz.time_close
+      canvas_assessment.unlock_at = Time.at(Integer(moodle_quiz.time_open)) if moodle_quiz.time_open
+
+      canvas_assessment.allowed_attempts = Integer(moodle_quiz.attempts_number)
+      canvas_assessment.allowed_attempts = -1 if canvas_assessment.allowed_attempts == 0
+
+      canvas_assessment.scoring_policy = moodle_quiz.grade_method == 4 ? 'keep_latest' : 'keep_highest'
+      canvas_assessment.access_code = moodle_quiz.password
+      canvas_assessment.ip_filter = moodle_quiz.subnet
+      canvas_assessment.shuffle_answers = moodle_quiz.shuffle_answers
+      canvas_assessment.time_limit = Integer(moodle_quiz.time_limit) if moodle_quiz.time_limit
+      canvas_assessment.quiz_type = 'practice_quiz'
+
+      canvas_assessment.question_references = moodle_quiz.question_instances
+
+      canvas_assessment
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2converter/assignment_converter.rb

@@ -0,0 +1,23 @@
+module Moodle2CC::Moodle2Converter
+  class AssignmentConverter
+    include ConverterHelper
+
+    def convert(moodle_assignment)
+      canvas_assignment = Moodle2CC::CanvasCC::Models::Assignment.new
+      canvas_assignment.identifier = generate_unique_identifier_for(moodle_assignment.id, ASSIGNMENT_SUFFIX)
+      canvas_assignment.title = moodle_assignment.name
+      canvas_assignment.body = moodle_assignment.intro
+      canvas_assignment.due_at = Time.at(Integer(moodle_assignment.due_date)) if moodle_assignment.due_date
+      canvas_assignment.lock_at = Time.at(Integer(moodle_assignment.cut_off_date)) if moodle_assignment.cut_off_date
+      canvas_assignment.unlock_at = Time.at(Integer(moodle_assignment.allow_submissions_from_date)) if moodle_assignment.allow_submissions_from_date
+      canvas_assignment.workflow_state = workflow_state(moodle_assignment.visible)
+      canvas_assignment.points_possible = moodle_assignment.grade
+      canvas_assignment.grading_type = 'points'
+      canvas_assignment.submission_types << 'online_text_entry' if moodle_assignment.online_text_submission == '1'
+      canvas_assignment.submission_types += %w(online_url online_upload) if moodle_assignment.file_submission == '1'
+
+      canvas_assignment
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2converter/book_converter.rb

@@ -0,0 +1,97 @@
+module Moodle2CC
+  class Moodle2Converter::BookConverter
+    include Moodle2Converter::ConverterHelper
+
+    def convert(moodle_book)
+      canvas_module = convert_moodle_book(moodle_book)
+      moodle_book.chapters.each do |chapter|
+        canvas_module.module_items << convert_moodle_chapter(moodle_book, chapter)
+      end
+      canvas_module
+    end
+
+    def convert_to_pages(moodle_book)
+      pages = moodle_book.chapters.map do |moodle_chapter|
+        page = create_page(moodle_chapter.title)
+        page.identifier = generate_unique_identifier_for_activity(moodle_chapter)
+        page.body = moodle_chapter.content
+        page.workflow_state = workflow_state(moodle_book.visible)
+        page
+      end
+
+      if moodle_book.intro
+        page = create_page(moodle_book.name)
+        page.identifier = generate_unique_identifier_for_book_intro(moodle_book)
+        page.body = moodle_book.intro
+        pages.unshift(page)
+      end
+
+      pages
+    end
+
+    def convert_to_module_items(moodle_book)
+      module_items = []
+      module_items << create_title(moodle_book)
+      module_items << create_introduction(moodle_book) if moodle_book.intro
+      module_items += moodle_book.chapters.map { |chapter| create_chapter(chapter) }
+      module_items
+    end
+
+    private
+
+    def create_title(moodle_book)
+      module_item = create_module_item_with_defaults()
+      module_item.content_type = Moodle2CC::CanvasCC::Models::ModuleItem::CONTENT_TYPE_CONTEXT_MODULE_SUB_HEADER
+      module_item.title = moodle_book.name
+      module_item.indent = "0"
+      module_item.identifier = generate_unique_identifier()
+      module_item.workflow_state = workflow_state(moodle_book.visible)
+
+      module_item
+    end
+
+    def create_introduction(moodle_book)
+      module_item = create_module_item_with_defaults()
+      module_item.title = 'Introduction'
+      module_item.indent = '1'
+      module_item.identifier = generate_unique_identifier()
+      module_item.identifierref = generate_unique_identifier_for_book_intro(moodle_book)
+      module_item.workflow_state = workflow_state(moodle_book.visible)
+
+      module_item
+    end
+
+    def create_chapter(moodle_chapter)
+      module_item = create_module_item_with_defaults()
+      module_item.title = moodle_chapter.title
+      module_item.indent = moodle_chapter.subchapter ? "2" : "1"
+      module_item.identifier = generate_unique_identifier()
+      module_item.identifierref = generate_unique_identifier_for_activity(moodle_chapter)
+      module_item.workflow_state = CanvasCC::Models::WorkflowState::UNPUBLISHED if moodle_chapter.hidden
+
+      module_item
+    end
+
+    def create_module_item_with_defaults
+      module_item = CanvasCC::Models::ModuleItem.new
+      module_item.identifier = generate_unique_identifier()
+      module_item.content_type = CanvasCC::Models::ModuleItem::CONTENT_TYPE_WIKI_PAGE
+      module_item.workflow_state = CanvasCC::Models::WorkflowState::ACTIVE
+      module_item
+    end
+
+    def create_page(title)
+      page = CanvasCC::Models::Page.new
+      page.type = CanvasCC::Models::Resource::WEB_CONTENT_TYPE
+      page.href = generate_unique_resource_path(CanvasCC::Models::Page::BOOK_PATH, title)
+      page.title = title
+      page.workflow_state = CanvasCC::Models::WorkflowState::ACTIVE
+      page.editing_roles = CanvasCC::Models::Page::EDITING_ROLE_TEACHER
+      page
+    end
+
+    def generate_unique_identifier_for_book_intro(moodle_book)
+      generate_unique_identifier_for(moodle_book.id, INTRO_SUFFIX)
+    end
+  end
+end

data/lib/moodle2cc/moodle2converter/converter_helper.rb

@@ -0,0 +1,68 @@
+module Moodle2CC
+  module Moodle2Converter::ConverterHelper
+    INTRO_SUFFIX = '_book_intro'
+    CHAPTER_SUFFIX = '_chapter'
+    FOLDER_SUFFIX = '_folder'
+    PAGE_SUFFIX = '_page'
+    ASSESSMENT_SUFFIX = '_assessment'
+    ASSIGNMENT_SUFFIX = '_assignment'
+    COURSE_SUFFIX = '_course'
+    DISCUSSION_SUFFIX = '_discussion'
+    FILE_SUFFIX = '_file'
+    QUESTION_BANK_SUFFIX = '_question_bank'
+    MODULE_SUFFIX = '_module'
+    GLOSSARY_SUFFIX = '_glossary'
+    SUMMARY_PAGE_SUFFIX = '_summary_page'
+    EXTERNAL_URL_SUFFIX = '_external_url'
+
+    ACTIVITY_LOOKUP = {
+      Moodle2::Models::Page => {suffix: PAGE_SUFFIX, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_WIKI_PAGE},
+      Moodle2::Models::Assignment => {suffix: ASSIGNMENT_SUFFIX, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_ASSIGNMENT},
+      Moodle2::Models::Folder => {suffix: FOLDER_SUFFIX, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_WIKI_PAGE},
+      Moodle2::Models::Forum => {suffix: DISCUSSION_SUFFIX, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_DISCUSSION_TOPIC},
+      Moodle2::Models::BookChapter => {suffix: CHAPTER_SUFFIX, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_WIKI_PAGE},
+      Moodle2::Models::Quizzes::Quiz => {suffix: ASSESSMENT_SUFFIX, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_QUIZ},
+      Moodle2::Models::Section => {suffix: SUMMARY_PAGE_SUFFIX, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_WIKI_PAGE},
+      Moodle2::Models::Label => {suffix: nil, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_CONTEXT_MODULE_SUB_HEADER},
+      Moodle2::Models::Glossary => {suffix: GLOSSARY_SUFFIX, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_WIKI_PAGE},
+      Moodle2::Models::ExternalUrl => {suffix: EXTERNAL_URL_SUFFIX, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_EXTERNAL_URL},
+      Moodle2::Models::Resource => {suffix: nil, content_type: CanvasCC::Models::ModuleItem::CONTENT_TYPE_ATTACHMENT}
+    }
+
+    def generate_unique_resource_path(base_path, readable_name, file_extension = 'html')
+      file_name_suffix = readable_name ? readable_name.downcase.strip.gsub(/\s/, '-') : ''
+      ext = file_extension ? ".#{file_extension}" : ''
+      File.join(base_path, generate_unique_identifier(), "#{file_name_suffix}#{ext}")
+    end
+
+    def generate_unique_identifier
+      "m2#{SecureRandom.uuid.gsub('-', '')}"
+    end
+
+    def generate_unique_identifier_for_activity(activity)
+      if lookup = ACTIVITY_LOOKUP[activity.class]
+        generate_unique_identifier_for(activity.id, lookup[:suffix])
+      else
+        raise "Unknown activity type: #{activity.class}"
+      end
+    end
+
+    def generate_unique_identifier_for(id, suffix = nil)
+      "m2#{Digest::MD5.hexdigest(id.to_s)}#{suffix}"
+    end
+
+    def activity_content_type(activity)
+      if lookup = ACTIVITY_LOOKUP[activity.class]
+        lookup[:content_type]
+      else
+        raise "Unknown activity type: #{activity.class}"
+      end
+    end
+
+    def workflow_state(moodle_visibility)
+      moodle_visibility ? CanvasCC::Models::WorkflowState::ACTIVE : CanvasCC::Models::WorkflowState::UNPUBLISHED
+    end
+
+
+  end
+end