moodle2cc 0.1.12 → 0.2.0

data/lib/moodle2cc/moodle2.rb

@@ -0,0 +1,9 @@
+module Moodle2CC
+  module Moodle2
+    require_relative 'moodle2/models'
+    require_relative 'moodle2/parsers'
+    require_relative 'moodle2/extractor'
+  end
+end
+
+

data/lib/moodle2cc/moodle2/extractor.rb

@@ -0,0 +1,144 @@
+require 'zip'
+
+module Moodle2CC::Moodle2
+  class Extractor
+
+    MOODLE_BACKUP_XML = 'moodle_backup.xml'
+
+    def initialize(zip_path)
+      @zip_path = zip_path
+    end
+
+    def extract
+      Dir.mktmpdir do |work_dir|
+        extract_zip(work_dir)
+        course = Moodle2CC::Moodle2::Parsers::CourseParser.new(work_dir).parse
+        parse_sections(work_dir, course)
+        parse_files(work_dir, course)
+        parse_pages(work_dir, course)
+        parse_forums(work_dir, course)
+        parse_assignments(work_dir, course)
+        parse_books(work_dir, course)
+        parse_folders(work_dir, course)
+        parse_question_categories(work_dir, course)
+        parse_quizzes(work_dir, course)
+        parse_glossaries(work_dir, course)
+        parse_labels(work_dir, course)
+        parse_external_urls(work_dir, course)
+        parse_resources(work_dir, course)
+        collect_files_for_resources(course.files, course.resources)
+        collect_activities_for_sections(course.sections, course.activities)
+        yield course
+      end
+    end
+
+    private
+
+    def extract_zip(work_dir)
+      Zip::File.open(@zip_path) do |zip_file|
+        zip_file.each do |f|
+          f_path=File.join(work_dir, f.name)
+          FileUtils.mkdir_p(File.dirname(f_path))
+          zip_file.extract(f, f_path) unless File.exist?(f_path)
+        end
+      end
+    end
+
+    def parse_sections(work_dir, course)
+      if sections = Moodle2CC::Moodle2::Parsers::SectionParser.new(work_dir).parse
+        course.sections += sections
+      end
+    end
+
+    def parse_files(work_dir, course)
+      if files = Moodle2CC::Moodle2::Parsers::FileParser.new(work_dir).parse
+        course.files += files
+      end
+    end
+
+    def parse_pages(work_dir, course)
+      if pages = Moodle2CC::Moodle2::Parsers::PageParser.new(work_dir).parse
+        course.pages += pages
+      end
+    end
+
+    def parse_forums(work_dir, course)
+      if forums = Moodle2CC::Moodle2::Parsers::ForumParser.new(work_dir).parse
+        course.forums += forums
+      end
+    end
+
+    def parse_assignments(work_dir, course)
+      if assignments = Moodle2CC::Moodle2::Parsers::AssignmentParser.new(work_dir).parse
+        course.assignments += assignments
+      end
+    end
+
+    def parse_books(work_dir, course)
+      if books = Moodle2CC::Moodle2::Parsers::BookParser.new(work_dir).parse
+        course.books += books
+      end
+    end
+
+    def parse_folders(work_dir, course)
+      if folders = Moodle2CC::Moodle2::Parsers::FolderParser.new(work_dir).parse
+        course.folders += folders
+      end
+    end
+
+    def parse_question_categories(work_dir, course)
+      if question_categories = Moodle2CC::Moodle2::Parsers::QuestionCategoryParser.new(work_dir).parse
+        course.question_categories += question_categories
+      end
+      course.question_categories.each{|qc| qc.resolve_embedded_question_references(question_categories)}
+    end
+
+    def parse_quizzes(work_dir, course)
+      if quizzes = Moodle2CC::Moodle2::Parsers::QuizParser.new(work_dir).parse
+        course.quizzes += quizzes
+      end
+    end
+
+    def parse_glossaries(work_dir, course)
+      if glossaries = Moodle2CC::Moodle2::Parsers::GlossaryParser.new(work_dir).parse
+        course.glossaries += glossaries
+      end
+    end
+
+    def parse_labels(work_dir, course)
+      if labels = Parsers::LabelParser.new(work_dir).parse
+        course.labels += labels
+      end
+    end
+
+    def parse_external_urls(work_dir, course)
+      if external_urls = Parsers::ExternalUrlParser.new(work_dir).parse
+        course.external_urls += external_urls
+      end
+    end
+
+    def parse_resources(work_dir, course)
+      if resources = Parsers::ResourceParser.new(work_dir).parse
+        course.resources += resources
+      end
+    end
+
+    def collect_files_for_resources(files, resources)
+      files_hash = {}
+      files.each{ |file| files_hash[file.id] = file }
+      resources.each do |resource|
+        file_id = resource.file_ids.find{|id| files_hash.key?(id)}
+        resource.file = files_hash[file_id]
+      end
+    end
+
+    def collect_activities_for_sections(sections, activities)
+      activities_hash = {}
+      activities.each { |activity| activities_hash[activity.module_id.to_s] = activity }
+      sections.each do |section|
+        section.activities = section.sequence.map { |module_id| activities_hash[module_id.to_s] }.compact
+      end
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2/models.rb

@@ -0,0 +1,17 @@
+module Moodle2CC::Moodle2::Models
+  require_relative 'models/quizzes'
+  require_relative 'models/assignment'
+  require_relative 'models/book'
+  require_relative 'models/book_chapter'
+  require_relative 'models/course'
+  require_relative 'models/folder'
+  require_relative 'models/forum'
+  require_relative 'models/moodle2_file'
+  require_relative 'models/page'
+  require_relative 'models/section'
+  require_relative 'models/glossary'
+  require_relative 'models/glossary_entry'
+  require_relative 'models/label'
+  require_relative 'models/resource'
+  require_relative 'models/external_url'
+end

data/lib/moodle2cc/moodle2/models/assignment.rb

@@ -0,0 +1,10 @@
+module Moodle2CC::Moodle2::Models
+  class Assignment
+    attr_accessor :id, :module_id, :name, :intro, :intro_format, :always_show_description, :submission_drafts,
+                  :send_notifications, :send_late_notifications, :due_date, :cut_off_date, :allow_submissions_from_date,
+                  :grade, :time_modified, :completion_submit, :require_submission_statement, :team_submission,
+                  :require_all_team_members_submit, :team_submission_grouping_id, :blind_marking, :reveal_identities,
+                  :online_text_submission, :file_submission, :max_file_size_submission, :max_files_submission,
+                  :submission_comments, :feedback_comments, :feedback_files, :offline_grading_worksheet, :visible
+  end
+end

data/lib/moodle2cc/moodle2/models/book.rb

@@ -0,0 +1,9 @@
+module Moodle2CC::Moodle2::Models
+  class Book
+    attr_accessor :id, :module_id, :name, :intro, :numbering, :custom_titles, :chapters, :intro_format, :visible
+
+    def initialize
+      @chapters = []
+    end
+  end
+end

data/lib/moodle2cc/moodle2/models/book_chapter.rb

@@ -0,0 +1,5 @@
+module Moodle2CC::Moodle2::Models
+  class BookChapter
+    attr_accessor :id, :pagenum, :subchapter, :title, :content, :content_format, :hidden
+  end
+end

data/lib/moodle2cc/moodle2/models/course.rb

@@ -0,0 +1,29 @@
+module Moodle2CC::Moodle2::Models
+  class Course
+    attr_accessor :id_number, :fullname, :shortname, :startdate, :summary,
+                  :course_id, :sections, :files, :pages, :forums, :assignments,
+                  :books, :folders, :question_categories, :quizzes, :glossaries,
+                  :labels, :resources, :external_urls
+
+    def initialize
+      @sections = []
+      @files = []
+      @pages = []
+      @forums = []
+      @assignments = []
+      @books = []
+      @folders = []
+      @question_categories = []
+      @quizzes = []
+      @glossaries = []
+      @labels = []
+      @resources = []
+      @external_urls = []
+    end
+
+    def activities
+      pages + forums + assignments + books + folders + quizzes + labels + resources + glossaries + external_urls
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2/models/external_url.rb

@@ -0,0 +1,7 @@
+module Moodle2CC::Moodle2::Models
+  class ExternalUrl
+    attr_accessor :id, :module_id, :name, :intro, :intro_format, :external_url, :display, :display_options, :parameters,
+                  :visible, :file_ids
+
+  end
+end

data/lib/moodle2cc/moodle2/models/folder.rb

@@ -0,0 +1,9 @@
+module Moodle2CC::Moodle2::Models
+  class Folder
+    attr_accessor :id, :module_id, :name, :intro, :intro_format, :revision, :file_ids, :visible
+
+    def initialize
+      @file_ids = []
+    end
+  end
+end

data/lib/moodle2cc/moodle2/models/forum.rb

@@ -0,0 +1,10 @@
+module Moodle2CC::Moodle2::Models
+  class Forum
+
+    attr_accessor :id, :module_id, :type, :name, :intro, :intro_format, :assessed, :assess_time_start, :assess_time_finish, :scale,
+                  :max_bytes, :max_attachments, :force_subsscribe, :tracking_type, :rss_type, :rss_articles,
+                  :time_modified, :warn_after, :block_after, :block_period, :completion_discussions, :completion_replies,
+                  :completion_posts, :visible
+
+  end
+end

data/lib/moodle2cc/moodle2/models/glossary.rb

@@ -0,0 +1,13 @@
+module Moodle2CC::Moodle2::Models
+  class Glossary
+    attr_accessor :id, :name, :intro, :intro_format, :allow_duplicated_entries, :display_format, :main_glossary, :show_special,
+                  :show_alphabet, :show_all, :allow_comments, :allow_printview, :use_dynalink, :default_approval, :global_glossary,
+                  :ent_by_page, :edit_always, :rss_type, :rss_articles, :assessed, :assess_time_start, :assess_time_finish, :scale,
+                  :completion_entries, :module_id, :entries, :visible
+
+    def initialize
+      @entries = []
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2/models/glossary_entry.rb

@@ -0,0 +1,13 @@
+module Moodle2CC::Moodle2::Models
+  class GlossaryEntry
+    attr_accessor :id, :user_id, :concept, :definition, :definition_format, :definition_trust, :attachment,
+                  :teacher_entry, :source_glossary_id, :use_dynalink, :case_sensitive, :full_match, :approved,
+                  :aliases, :ratings
+
+    def initialize
+      @aliases = []
+      @ratings = []
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2/models/label.rb

@@ -0,0 +1,6 @@
+module Moodle2CC::Moodle2::Models
+  class Label
+    attr_accessor :id, :module_id, :name, :intro, :intro_format, :visible
+
+  end
+end

data/lib/moodle2cc/moodle2/models/moodle2_file.rb

@@ -0,0 +1,13 @@
+module Moodle2CC::Moodle2::Models
+  class Moodle2File
+
+    attr_accessor :id, :content_hash, :context_id, :component, :file_area, :item_id, :file_path, :file_name,
+                  :user_id, :file_size, :mime_type, :status, :time_created, :time_modified, :source, :author,
+                  :license, :sort_order, :repository_type, :repository_id, :reference, :file_location
+
+    def file_size=(size)
+      @file_size = Integer(size)
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2/models/page.rb

@@ -0,0 +1,9 @@
+module Moodle2CC::Moodle2::Models
+  class Page
+
+    attr_accessor :module_id, :id, :name, :intro, :intro_format, :content, :content_format, :legacy_files,
+                  :legacy_files_last, :display, :display_options, :revision, :time_modified, :visible
+
+
+  end
+end

data/lib/moodle2cc/moodle2/models/quizzes.rb

@@ -0,0 +1,13 @@
+module Moodle2CC::Moodle2::Models::Quizzes
+  require_relative 'quizzes/answer'
+  require_relative 'quizzes/question'
+  require_relative 'quizzes/question_category'
+  require_relative 'quizzes/quiz'
+  require_relative 'quizzes/calculated_question'
+  require_relative 'quizzes/match_question'
+  require_relative 'quizzes/multianswer_question'
+  require_relative 'quizzes/numerical_question'
+  require_relative 'quizzes/random_sa_question'
+  require_relative 'quizzes/true_false_question'
+end
+

data/lib/moodle2cc/moodle2/models/quizzes/answer.rb

@@ -0,0 +1,5 @@
+module Moodle2CC::Moodle2::Models::Quizzes
+  class Answer
+    attr_accessor :id, :answer_text, :answer_format, :fraction, :feedback, :feedback_format
+  end
+end

data/lib/moodle2cc/moodle2/models/quizzes/calculated_question.rb

@@ -0,0 +1,11 @@
+module Moodle2CC::Moodle2::Models::Quizzes
+  class CalculatedQuestion < Question
+    register_question_type 'calculated'
+    attr_accessor :correct_answer_format, :correct_answer_length, :dataset_definitions, :tolerance
+
+    def initialize
+      super
+      @dataset_definitions = []
+    end
+  end
+end

data/lib/moodle2cc/moodle2/models/quizzes/match_question.rb

@@ -0,0 +1,11 @@
+module Moodle2CC::Moodle2::Models::Quizzes
+  class MatchQuestion < Question
+    register_question_type 'match'
+    attr_accessor :matches
+
+    def initialize
+      super
+      @matches = []
+    end
+  end
+end

data/lib/moodle2cc/moodle2/models/quizzes/multianswer_question.rb

@@ -0,0 +1,23 @@
+module Moodle2CC::Moodle2::Models::Quizzes
+  class MultianswerQuestion < Question
+    register_question_type 'multianswer'
+    attr_accessor :embedded_question_references, :embedded_questions
+
+    def resolve_embedded_question_references(question_categories)
+      return unless @embedded_question_references
+
+      @embedded_questions ||= []
+      @embedded_question_references.each do |ref|
+        question = nil
+        question_categories.each do |qc|
+          if question = qc.questions.detect{|q| q.id.to_s == ref && q.parent.to_s == @id}
+            qc.questions.delete(question)
+            break
+          end
+        end
+
+        @embedded_questions << question if question
+      end
+    end
+  end
+end

data/lib/moodle2cc/moodle2/models/quizzes/numerical_question.rb

@@ -0,0 +1,11 @@
+module Moodle2CC::Moodle2::Models::Quizzes
+  class NumericalQuestion < Question
+    register_question_type 'numerical'
+    attr_accessor :tolerances
+
+    def initialize
+      super
+      @tolerances = {}
+    end
+  end
+end

data/lib/moodle2cc/moodle2/models/quizzes/question.rb

@@ -0,0 +1,33 @@
+module Moodle2CC::Moodle2::Models::Quizzes
+  class Question
+
+    @@subclasses = {}
+
+    STANDARD_TYPES = ['description', 'essay', 'multichoice', 'shortanswer']
+
+    def self.create(type)
+      if c = @@subclasses[type]
+        q = c.new
+        q.type = type
+        q
+      elsif STANDARD_TYPES.include?(type)
+        q = self.new
+        q.type = type
+        q
+      else
+        raise "Unknown question type: #{type}"
+      end
+    end
+
+    def self.register_question_type(name)
+      @@subclasses[name] = self
+    end
+
+    attr_accessor :id, :parent, :name, :question_text, :question_text_format, :general_feedback, :default_mark,
+                  :penalty, :qtype, :length, :stamp, :version, :hidden, :answers, :type
+
+    def initialize
+      @answers = []
+    end
+  end
+end