Merge branch '10.0.x' of https://github.com/doubtfire-lms/doubtfire-api into 10.0.x

Author: macite

.ci-setup/crontab

@@ -3,7 +3,7 @@ BASH_ENV=/container.env
 PATH=/tmp/texlive/bin/x86_64-linux:/tmp/texlive/bin/aarch64-linux:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/local/bundle/bin
 
 10,15,20,25,30,35,40,45,50,55 * * * * /doubtfire/lib/shell/generate_pdfs.sh
-0 5 * * 1,3,5 /doubtfire/lib/shell/check_plagiarism.sh
+0 5 * * * /doubtfire/lib/shell/check_plagiarism.sh
 0 8 * * * /doubtfire/lib/shell/portfolio_autogen_check.sh
 0 7 * * 1 /doubtfire/lib/shell/send_weekly_emails.sh
 0 1 * * * /doubtfire/lib/shell/sync_enrolments.sh

.github/workflows/push.yml

@@ -29,6 +29,7 @@ env:
   DF_REDIS_SIDEKIQ_URL: "redis://redis:6379/0"
   LATEX_CONTAINER_NAME: doubtfire-texlive
   LATEX_BUILD_PATH: /texlive/shell/latex_build.sh
+  DF_JPLAG_REPORT_DIR: /jplag/results
 
 jobs:
   unit-tests:
@@ -61,6 +62,16 @@ jobs:
           tags: doubtfire-texlive-development:local
           cache-from: type=gha,scope=texlive
           cache-to: type=gha,mode=max,scope=texlive
+      - name: Build JPlag image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: jplag.Dockerfile
+          push: false
+          load: true
+          tags: doubtfire-jplag-development:local
+          cache-from: type=gha,scope=jplag
+          cache-to: type=gha,mode=max,scope=jplag
       - name: Build base doubtfire-api development image
         uses: docker/build-push-action@v5
         with:
@@ -91,6 +102,26 @@ jobs:
             -v ${{ github.workspace }}:/doubtfire
             -v /var/run/docker.sock:/var/run/docker.sock
           run: docker exec -t ${{ env.LATEX_CONTAINER_NAME }} lualatex -v
+      - name: Start JPlag service
+        uses: addnab/docker-run-action@v3
+        with:
+          image: doubtfire-jplag-development:local
+          options: >
+            --name jplag
+            -v ${{ github.workspace }}/student-work:/student-work
+            -v ${{ github.workspace }}/jplag/results:${{ env.DF_JPLAG_REPORT_DIR }}
+            -v ${{ github.workspace }}/tmp/jplag:/tmp/jplag
+            --detach
+          run: sleep infinity
+      - name: Test JPlag service
+        uses: addnab/docker-run-action@v3
+        with:
+          image: doubtfire-api-development:local
+          options: >
+            -t
+            -v ${{ github.workspace }}:/doubtfire
+            -v /var/run/docker.sock:/var/run/docker.sock
+          run: docker exec -t jplag ls /jplag/jplag-jar-with-dependencies.jar
       - name: Populate database
         uses: addnab/docker-run-action@v3
         with:
@@ -118,6 +149,7 @@ jobs:
             -e DF_REDIS_SIDEKIQ_URL
             -e LATEX_CONTAINER_NAME
             -e LATEX_BUILD_PATH
+            -e DF_JPLAG_REPORT_DIR
           run: bundle exec rake db:populate
       - name: Run unit tests
         uses: addnab/docker-run-action@v3
@@ -127,6 +159,8 @@ jobs:
             -v ${{ github.workspace }}:/doubtfire
             -v ${{ github.workspace }}/student-work:/student-work
             -v /var/run/docker.sock:/var/run/docker.sock
+            -v ${{ github.workspace }}/jplag/results:${{ env.DF_JPLAG_REPORT_DIR }}
+            -v ${{ github.workspace }}/tmp/jplag:/tmp/jplag
             -e RAILS_ENV
             -e DF_STUDENT_WORK_DIR
             -e DF_INSTITUTION_HOST
@@ -146,6 +180,9 @@ jobs:
             -e DF_REDIS_SIDEKIQ_URL
             -e LATEX_CONTAINER_NAME
             -e LATEX_BUILD_PATH
+            -e DF_JPLAG_REPORT_DIR
           run: TERM=xterm bundle exec rails test
       - name: Stop TexLive service
         run: docker rm -f ${{ env.LATEX_CONTAINER_NAME }}
+      - name: Stop JPlag service
+        run: docker rm -f jplag

app/api/entities/task_definition_entity.rb

@@ -45,11 +45,12 @@ def staff?(my_role)
     expose :scorm_bypass_test
     expose :scorm_time_delay_enabled
     expose :scorm_attempt_limit
+    expose :has_jplag_report?, as: :has_jplag_report, if: ->(unit, options) { staff?(options[:my_role]) }
     expose :is_graded
     expose :max_quality_pts
     expose :overseer_image_id, if: ->(unit, options) { staff?(options[:my_role]) }, expose_nil: false
     expose :assessment_enabled, if: ->(unit, options) { staff?(options[:my_role]) }
-    expose :moss_language, if: ->(unit, options) { staff?(options[:my_role]) }, expose_nil: false
+    expose :similarity_language, if: ->(unit, options) { staff?(options[:my_role]) }, expose_nil: false
 
     expose :learning_outcomes, using: LearningOutcomeEntity, as: :ilos
   end

app/api/similarity/entities/task_similarity_entity.rb

@@ -13,6 +13,9 @@ def staff?(my_role)
         similarity.ready_for_viewer?
       end
 
+      expose :other_task
+      expose :other_student
+
       expose :parts do |similarity, options|
         path = similarity.file_path
         has_resource = path.present? && File.exist?(path)
@@ -21,12 +24,13 @@ def staff?(my_role)
           {
             idx: 0,
             format: if has_resource
-                      similarity.type == 'MossTaskSimilarity' ? 'html' : 'pdf'
+                      similarity.type.in?(%w[MossTaskSimilarity JplagTaskSimilarity]) ? 'html' : 'pdf'
                     end,
-            description: "#{similarity.student.name} (#{similarity.student.username}) - #{similarity.pct}%"
+            description: "#{similarity.other_student.name} (#{similarity.other_student.username}) - #{similarity.pct}% similarity"
           }
         ]
 
+        # TODO: jplag integration
         # For moss similarity, show staff other student details
         if similarity.type == 'MossTaskSimilarity' && staff?(options[:my_role])
           other_path = similarity.other_similarity&.file_path

app/api/task_definitions_api.rb

@@ -32,7 +32,7 @@ class TaskDefinitionsApi < Grape::API
       requires :max_quality_pts,          type: Integer,  desc: 'A range for quality points when quality is assessed'
       optional :assessment_enabled,       type: Boolean,  desc: 'Enable or disable assessment'
       optional :overseer_image_id,        type: Integer,  desc: 'The id of the Docker image for overseer'
-      optional :moss_language,            type: String,   desc: 'The language to use for code similarity checks'
+      optional :similarity_language,            type: String,   desc: 'The language to use for code similarity checks'
       optional :scorm_enabled,            type: Boolean,  desc: 'Whether SCORM assessment is enabled for this task'
       optional :scorm_allow_review,       type: Boolean,  desc: 'Whether a student is allowed to review their completed test attempts'
       optional :scorm_bypass_test,        type: Boolean,  desc: 'Whether a student is allowed to upload files before passing SCORM test'
@@ -69,7 +69,7 @@ class TaskDefinitionsApi < Grape::API
                                                 :max_quality_pts,
                                                 :assessment_enabled,
                                                 :overseer_image_id,
-                                                :moss_language,
+                                                :similarity_language,
                                                 :upload_requirements,
                                                 :unit_id
                                               )
@@ -125,7 +125,7 @@ class TaskDefinitionsApi < Grape::API
       optional :max_quality_pts,          type: Integer,  desc: 'A range for quality points when quality is assessed'
       optional :assessment_enabled,       type: Boolean,  desc: 'Enable or disable assessment'
       optional :overseer_image_id,        type: Integer,  desc: 'The id of the Docker image name for overseer'
-      optional :moss_language,            type: String,   desc: 'The language to use for code similarity checks'
+      optional :similarity_language, type: String, desc: 'The language to use for code similarity checks'
     end
   end
   put '/units/:unit_id/task_definitions/:id' do
@@ -158,7 +158,7 @@ class TaskDefinitionsApi < Grape::API
                                                 :max_quality_pts,
                                                 :assessment_enabled,
                                                 :overseer_image_id,
-                                                :moss_language,
+                                                :similarity_language,
                                                 :upload_requirements
                                               )
 
@@ -711,4 +711,45 @@ class TaskDefinitionsApi < Grape::API
     task_def.remove_scorm_data
     true
   end
+
+  desc 'Download the JPLAG report for a given task'
+  params do
+    requires :unit_id, type: Integer, desc: 'The unit to download JPLAG report for'
+    requires :task_def_id, type: Integer, desc: 'The task definition to get the JPLAG report of'
+  end
+  get '/units/:unit_id/task_definitions/:task_def_id/jplag_report' do
+    unit = Unit.find(params[:unit_id])
+    task_def = unit.task_definitions.find(params[:task_def_id])
+    unless authorise? current_user, unit, :download_jplag_report
+      error!({ error: 'Not authorised to download JPLAG reports of unit' }, 403)
+    end
+    logger.debug "This is the has_jplag_report? #{task_def.has_jplag_report?}"
+    if task_def.has_jplag_report?
+      path = FileHelper.task_jplag_report_path(unit, task_def)
+      header['Content-Disposition'] = "attachment; filename=#{task_def.abbreviation}-jplag-report.jplag"
+    else
+      path = Rails.root.join("public/resources/FileNotFound.pdf")
+      content_type 'application/pdf'
+      header['Content-Disposition'] = 'attachment; filename=FileNotFound.pdf'
+    end
+    header['Access-Control-Expose-Headers'] = 'Content-Disposition'
+    content_type 'application/octet-stream'
+    stream_file path
+  end
+
+  desc 'Get hasJplagReport boolean for a given task'
+  params do
+    requires :unit_id, type: Integer, desc: 'The unit to get JPLAG report for'
+    requires :task_def_id, type: Integer, desc: 'The task definition to get the JPLAG report of'
+  end
+  get '/units/:unit_id/task_definitions/:task_def_id/has_jplag_report' do
+    unit = Unit.find(params[:unit_id])
+    task_def = unit.task_definitions.find(params[:task_def_id])
+
+    unless authorise? current_user, unit, :download_jplag_report
+      error!({ error: 'Not authorised to download JPLAG reports of unit' }, 403)
+    end
+
+    task_def.has_jplag_report?
+  end
 end

app/helpers/file_helper.rb

@@ -293,6 +293,15 @@ def student_portfolio_path(unit, username, create: true, archived: true)
     File.join(student_portfolio_dir(unit, username, create: create, archived: archived), FileHelper.sanitized_filename("#{username}-portfolio.pdf"))
   end
 
+  def task_jplag_report_dir(unit)
+    file_server = Doubtfire::Application.config.jplag_report_dir
+    "#{file_server}/#{unit.code}-#{unit.id}/" # trust the server config and passed in type for paths
+  end
+
+  def task_jplag_report_path(unit, task)
+    File.join(task_jplag_report_dir(unit), FileHelper.sanitized_filename("#{task.abbreviation}-result.jplag"))
+  end
+
   def comment_attachment_path(task_comment, attachment_extension)
     "#{File.join(student_work_dir(:comment, task_comment.task), "#{task_comment.id.to_s}#{attachment_extension}")}"
   end
@@ -783,4 +792,6 @@ def line_wrap(path, width: 160)
   module_function :known_extension?
   module_function :pages_in_pdf
   module_function :line_wrap
+  module_function :task_jplag_report_dir
+  module_function :task_jplag_report_path
 end

app/models/similarity/jplag_task_similarity.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class JplagTaskSimilarity < TaskSimilarity
+  belongs_to :other_task, class_name: 'Task'
+
+  def file_path
+    FileHelper.path_to_plagarism_html(self)
+  end
+
+  #
+  # Ensure file is also deleted
+  #
+  before_destroy do |similarity|
+    if similarity.task.group_task?
+      other_tasks = similarity.task.group_submission.tasks.reject { |t| t.id == similarity.task.id }
+
+      other_tasks_using_file = other_tasks.select { |t| t.task_similarities.where(other_task_id: similarity.other_task_id).count > 0 }
+      FileHelper.delete_plagarism_html(similarity) unless other_tasks_using_file.count > 0
+    else # individual... so can delete file
+      FileHelper.delete_plagarism_html(similarity)
+    end
+  rescue StandardError => e
+    logger.error "Error deleting match link for task #{similarity.task.id}. Error: #{e.message}"
+  end
+
+  after_destroy do |similarity|
+    similarity.other_similarity&.destroy
+  end
+
+  def other_similarity
+    JplagTaskSimilarity.where(task_id: other_task.id, other_task_id: task.id).first unless other_task.nil?
+  end
+
+  def other_student
+    other_task&.student
+  end
+
+  def other_tutor
+    other_task&.project&.tutor_for(other_task.task_definition)
+  end
+
+  def other_tutorial
+    tute = other_task.project.tutorial_for(other_task.task_definition) unless other_task.nil?
+    tute.nil? ? 'None' : tute.abbreviation
+  end
+
+  def ready_for_viewer?
+    true
+  end
+end

app/models/similarity/task_definition_similarity_module.rb

@@ -6,12 +6,21 @@ def moss_similarities?
     MossTaskSimilarity.joins(:task).where('tasks.task_definition_id' => id).count > 0
   end
 
+  def jplag_similarities?
+    JplagTaskSimilarity.joins(:task).where('tasks.task_definition_id' => id).count > 0
+  end
+
   def clear_related_plagiarism
     # delete old plagiarism links
     logger.info "Deleting old links for task definition #{id} - #{abbreviation}"
     MossTaskSimilarity.joins(:task).where('tasks.task_definition_id' => id).find_each do |plnk|
       pair = MossTaskSimilarity.find_by(id: plnk.id)
       pair.destroy! if pair.present?
     end
+
+    JplagTaskSimilarity.joins(:task).where('tasks.task_definition_id' => id).find_each do |plnk|
+      pair = JplagTaskSimilarity.find_by(id: plnk.id)
+      pair.destroy! if pair.present?
+    end
   end
 end