enforce term/course/section start and end dates

whitmer · whitmer · commit 41c9f1298899 · 2011-03-01T13:47:12.000-07:00
before we were recording these values but not doing anything about it. This commit starts scheduling delayed_jobs to activate/conclude enrollments in the background when dates pass. it does not conclude/publish courses/sections automatically, though. if we want that to be automated based on dates then I think we should do that in a separate commit. fixes #3356 Change-Id: Id94356fbc5b82196dd041fdb250607a7633cee9f Reviewed-on: https://gerrit.instructure.com/2431 Tested-by: Hudson <hudson@instructure.com> Reviewed-by: Bracken Mosbacker <bracken@instructure.com>
diff --git a/app/controllers/courses_controller.rb b/app/controllers/courses_controller.rb
@@ -324,6 +324,16 @@ def check_enrollment
       params[:invitation] = pending_enrollment.uuid
       enrollment = pending_enrollment
     end
+    if enrollment && enrollment.inactive?
+      start_at, end_at = @context.enrollment_dates_for(enrollment)
+      if start_at && start_at > Time.now
+        flash[:notice] = "You do not have permission to access the course, #{@context.name}, until #{start_at.to_date.to_s}"
+      else
+        flash[:notice] = "Your membership in the course, #{@context.name}, is not yet activated"
+      end
+      redirect_to dashboard_url
+      return true
+    end
     if params[:invitation] && enrollment
       if enrollment.rejected?
         enrollment.workflow_state = 'active'
diff --git a/app/models/account.rb b/app/models/account.rb
@@ -429,8 +429,6 @@ def self_and_all_sub_accounts
     @self_and_all_sub_accounts ||= ActiveRecord::Base.connection.send(:select, "SELECT id FROM accounts WHERE accounts.root_account_id = #{self.id} OR accounts.parent_account_id = #{self.id}").map{|ref| ref['id'].to_i}.uniq + [self.id] #(self.all_accounts + [self]).map &:id
   end
   
-  # validates_uniqueness_of :name
-  
   def abstract_courses
     if self.is_a?(Department)
       self.department_abstract_courses
diff --git a/app/models/course.rb b/app/models/course.rb
@@ -22,8 +22,9 @@ class Course < ActiveRecord::Base
   
   include Context
   include Workflow
+  include EnrollmentDateRestrictions
 
-  attr_accessible :name, :section, :account, :group_weighting_scheme, :start_at, :conclude_at, :grading_standard_id, :is_public, :publish_grades_immediately, :allow_student_wiki_edits, :allow_student_assignment_edits, :hashtag, :show_public_context_messages, :syllabus_body, :hidden_tabs, :allow_student_forum_attachments, :default_wiki_editing_roles, :allow_student_organized_groups, :course_code, :default_view, :show_all_discussion_entries, :open_enrollment, :allow_wiki_comments, :turnitin_comments, :self_enrollment, :license, :indexed, :enrollment_term, :abstract_course, :root_account, :storage_quota
+  attr_accessible :name, :section, :account, :group_weighting_scheme, :start_at, :conclude_at, :grading_standard_id, :is_public, :publish_grades_immediately, :allow_student_wiki_edits, :allow_student_assignment_edits, :hashtag, :show_public_context_messages, :syllabus_body, :hidden_tabs, :allow_student_forum_attachments, :default_wiki_editing_roles, :allow_student_organized_groups, :course_code, :default_view, :show_all_discussion_entries, :open_enrollment, :allow_wiki_comments, :turnitin_comments, :self_enrollment, :license, :indexed, :enrollment_term, :abstract_course, :root_account, :storage_quota, :restrict_enrollments_to_course_dates
 
   serialize :tab_configuration
   belongs_to :root_account, :class_name => 'Account'
@@ -33,12 +34,12 @@ class Course < ActiveRecord::Base
   has_many :course_sections
   has_many :active_course_sections, :class_name => 'CourseSection', :conditions => {:workflow_state => 'active'}
   has_many :enrollments, :include => [:user, :course], :conditions => ['enrollments.workflow_state != ?', 'deleted'], :dependent => :destroy
-  has_many :current_enrollments, :class_name => 'Enrollment', :conditions => ['enrollments.workflow_state != ? AND enrollments.workflow_state != ? AND enrollments.workflow_state != ?', 'rejected', 'completed', 'deleted'], :include => :user
+  has_many :current_enrollments, :class_name => 'Enrollment', :conditions => ['enrollments.workflow_state != ? AND enrollments.workflow_state != ? AND enrollments.workflow_state != ? AND enrollments.workflow_state != ?', 'rejected', 'completed', 'deleted', 'inactive'], :include => :user
   has_many :prior_enrollments, :class_name => 'Enrollment', :include => [:user, :course], :conditions => "enrollments.workflow_state = 'completed'"
   has_many :students, :through => :student_enrollments, :source => :user, :order => :sortable_name
   has_many :all_students, :through => :all_student_enrollments, :source => :user, :order => :sortable_name
   has_many :participating_students, :through => :enrollments, :source => :user, :conditions => "enrollments.type = 'StudentEnrollment' and enrollments.workflow_state = 'active'"
-  has_many :student_enrollments, :class_name => 'StudentEnrollment', :conditions => ['enrollments.workflow_state != ? AND enrollments.workflow_state != ? AND enrollments.workflow_state != ?', 'deleted', 'completed', 'rejected'], :include => :user #, :conditions => "type = 'StudentEnrollment'"
+  has_many :student_enrollments, :class_name => 'StudentEnrollment', :conditions => ['enrollments.workflow_state != ? AND enrollments.workflow_state != ? AND enrollments.workflow_state != ? AND enrollments.workflow_state != ?', 'deleted', 'completed', 'rejected', 'inactive'], :include => :user #, :conditions => "type = 'StudentEnrollment'"
   has_many :all_student_enrollments, :class_name => 'StudentEnrollment', :conditions => ['enrollments.workflow_state != ?', 'deleted'], :include => :user
   has_many :detailed_enrollments, :class_name => 'Enrollment', :conditions => ['enrollments.workflow_state != ?', 'deleted'], :include => {:user => {:pseudonym => :communication_channel}}
   has_many :teachers, :through => :teacher_enrollments, :source => :user
@@ -726,6 +727,40 @@ def self.find_all_by_context_code(codes)
     Course.find(:all, :conditions => {:id => ids}, :include => :current_enrollments)
   end
   
+  def enrollment_dates_for(enrollment)
+    if enrollment.start_at && enrollment.end_at
+      [enrollment.start_at, enrollment.end_at]
+    elsif (section = enrollment.course_section_id && course_sections.find_by_id(enrollment.course_section_id)) && 
+          section && section.restrict_enrollments_to_section_dates && !enrollment.admin?
+      [section.start_at, section.end_at]
+    elsif self.restrict_enrollments_to_course_dates && !enrollment.admin?
+      [start_at, end_at]
+    elsif enrollment_term
+      enrollment_term.enrollment_dates_for(enrollment)
+    else
+      [nil, nil]
+    end
+  end
+  
+  def enrollment_state_based_on_date(enrollment)
+    start_at, end_at = enrollment_dates_for(enrollment)
+    if start_at && start_at >= Time.now
+      'inactive'
+    elsif end_at && end_at <= Time.now
+      'completed'
+    else
+      'active'
+    end
+  end
+  
+  def end_at
+    conclude_at
+  end
+  
+  def end_at_changed?
+    conclude_at_changed?
+  end
+  
   def state_sortable
     case state
     when :invited
diff --git a/app/models/course_section.rb b/app/models/course_section.rb
@@ -18,6 +18,8 @@
 
 class CourseSection < ActiveRecord::Base
   include Workflow
+  include EnrollmentDateRestrictions
+  
   attr_protected :sis_source_id, :sis_batch_id, :course_id, :abstract_course_id,
       :root_account_id, :enrollment_term_id, :sis_cross_listed_section_id, :sis_cross_listed_section_sis_batch_id
   belongs_to :course
diff --git a/app/models/enrollment.rb b/app/models/enrollment.rb
@@ -19,6 +19,7 @@
 class Enrollment < ActiveRecord::Base
   
   include Workflow
+  include EnrollmentDateRestrictions
   
   belongs_to :course, :touch => true
   belongs_to :course_section
@@ -229,13 +230,23 @@ def state_sortable
     end
   end
   
+  def accept!
+    res = accept
+    raise "can't accept" unless res
+    res
+  end
+  
+  def accept
+    return false unless invited?
+    ids = nil
+    ids = self.user.dashboard_messages.find_all_by_context_id_and_context_type(self.id, 'Enrollment', :select => "id").map(&:id) if self.user
+    Message.delete_all({:id => ids}) if ids && !ids.empty?
+    update_attribute(:workflow_state, course.enrollment_state_based_on_date(self))
+    true
+  end
+  
   workflow do
     state :invited do
-      event :accept, :transitions_to => :active do
-        ids = nil
-        ids = self.user.dashboard_messages.find_all_by_context_id_and_context_type(self.id, 'Enrollment', :select => "id").map(&:id) if self.user
-        Message.delete_all({:id => ids}) if ids && !ids.empty?
-      end
       event :reject, :transitions_to => :rejected
       event :complete, :transitions_to => :completed
       event :pend, :transitions_to => :pending
@@ -251,6 +262,10 @@ def state_sortable
       event :pend, :transitions_to => :pending
     end
     
+    state :inactive do
+      event :activate, :transitions_to => :active
+    end
+    
     state :deleted
     state :rejected do
       event :unreject, :transitions_to => :invited
@@ -290,7 +305,7 @@ def pending?
   end
   
   def active_or_pending?
-    self.active? || self.pending?
+    self.active? || self.inactive? || self.pending?
   end
   
   def email
diff --git a/app/models/enrollment_dates_override.rb b/app/models/enrollment_dates_override.rb
@@ -17,6 +17,8 @@
 #
 
 class EnrollmentDatesOverride < ActiveRecord::Base
+  include EnrollmentDateRestrictions
+  
   belongs_to :context, :polymorphic => true
   belongs_to :enrollment_term
 end
diff --git a/app/models/enrollment_term.rb b/app/models/enrollment_term.rb
@@ -17,8 +17,10 @@
 #
 
 class EnrollmentTerm < ActiveRecord::Base
-  attr_accessible :name, :start_at, :end_at
+  include EnrollmentDateRestrictions
   include Workflow
+
+  attr_accessible :name, :start_at, :end_at, :ignore_term_date_restrictions
   belongs_to :root_account, :class_name => 'Account'
   has_many :enrollment_dates_overrides
   has_many :courses
@@ -43,6 +45,16 @@ def set_overrides(context, params)
     state :deleted
   end
   
+  def enrollment_dates_for(enrollment)
+    return [nil, nil] if ignore_term_date_restrictions
+    override = EnrollmentDatesOverride.find_by_enrollment_term_id_and_enrollment_type(self.id, enrollment.type.to_s)
+    if override
+      [override.start_at, override.end_at]
+    else
+      [start_at, end_at]
+    end
+  end
+  
   alias_method :destroy!, :destroy
   def destroy
     self.workflow_state = 'deleted'
diff --git a/app/views/courses/course_details.html.erb b/app/views/courses/course_details.html.erb
@@ -186,6 +186,20 @@
           <span class="course_form"><%= f.text_field :conclude_at, :class => "date_entry" %></span>
           <span class="course_info conclude_at"><%= datetime_string(@context.conclude_at) || "No Date Set" %></span>
         </td>
+      </tr><tr>
+        <td></td>
+        <td>
+          <div class="course_form">
+            <%= f.check_box :restrict_enrollments_to_course_dates %>
+            <%= f.label :restrict_enrollments_to_course_dates, "Users can only access the course between these dates" %>
+            <div style="font-size: 0.8em; padding-left: 25px;">
+              This will override any term availability settings.
+            </div>
+          </div>
+          <div class="course_info restrict_dates" style="font-size: 0.8em;">
+            <%= @context.restrict_enrollments_to_course_dates ? "Users can only access the course between these dates" : "These dates will not affect course availability" %>
+          </div>
+        </td>
       </tr><tr>
         <td style="width: 10%;"><%= f.label :storage_quota, "File Storage:" %></td>
         <td>
diff --git a/app/views/sections/show.html.erb b/app/views/sections/show.html.erb
@@ -3,6 +3,7 @@
 <% content_for :right_side do %>
   <div class="rs-margin-all">
     <a href="#" class="button button-sidebar-wide edit_section_link"><%= image_tag "edit.png" %> Edit Section</a>
+    <a href="<%= context_url(@context, :context_details_url) %>" class="button button-sidebar-wide edit_section_link"><%= image_tag "back.png" %> Back to Course Settings</a>
   </div>
 <% end %>
 
@@ -85,9 +86,25 @@ h3 .tally {
 <% form_for @section, :url => context_url(@context, :context_section_url, @section), :html => {:id => "edit_section_form", :style => "display: none;"} do |f| %>
 <table class="formtable">
   <tr>
-    <td><%= f.label :name, "Section Name" %></td>
+    <td><%= f.label :name, "Section Name:" %></td>
     <td><%= f.text_field :name %></td>
   </tr>
+  <tr>
+    <td><%= f.label :start_at, "Starts:" %></td>
+    <td><%= f.text_field :start_at, :class => "datetime_field", :value => datetime_string(@section.start_at), :style => 'width: 120px;' %></td>
+  </tr>
+  <tr>
+    <td><%= f.label :end_at, "Ends:" %></td>
+    <td><%= f.text_field :end_at, :class => "datetime_field", :value => datetime_string(@section.end_at), :style => 'width: 120px;' %></td>
+  </tr>
+  <tr>
+    <td colspan="2">
+      <%= f.check_box :restrict_enrollments_to_section_dates %>
+      <%= f.label :restrict_enrollments_to_section_dates, "Users can only access the course between these dates" %>
+      <div style="font-size: 0.8em; padding-left: 25px;">
+        This will override any term or course date settings.
+    </td>
+  </tr>
   <tr>
     <td colspan="2">
       <div class="button-container">
@@ -98,8 +115,22 @@ h3 .tally {
   </tr>
 </table>
 <% end %>
+<h2><%= @section.name %></h2>
+<div style="margin-bottom: 20px;">
+  <div>
+    <%= pluralize((@current_enrollments + @completed_enrollments).length, 'Enrollment') %>
+  </div>
+  <% if @section.start_at || @section.end_at %>
+    <div>
+      Runs from <%= datetime_string(@section.start_at) || 'whenever' %> to <%= datetime_string(@section.end_at) || 'whenever' %>
+    </div>
+    <div style="margin-left: 10px; font-size: 0.8em;">
+      <%= 'Students can only access the course between these dates' if @section.restrict_enrollments_to_section_dates %>
+    </div>
+  <% end %>
+</div>
 <% unless @current_enrollments.empty? %>
-<h2>Current Enrollments</h2>
+<h3>Current Enrollments</h3>
 <ul class="user_list">
 <% @current_enrollments.each do |enrollment| %>
   <%= render :partial => "shared/enrollment", :object => enrollment, :locals => {:include_type => true} %>
@@ -137,6 +168,7 @@ $(document).ready(function() {
       }
     });
   });
+  $(".datetime_field").datetime_field();
 });
 </script>
 <% end %>
diff --git a/db/migrate/20110223175857_add_restriction_options_to_courses_and_sections.rb b/db/migrate/20110223175857_add_restriction_options_to_courses_and_sections.rb
@@ -0,0 +1,13 @@
+class AddRestrictionOptionsToCoursesAndSections < ActiveRecord::Migration
+  def self.up
+    add_column :courses, :restrict_enrollments_to_course_dates, :boolean
+    add_column :course_sections, :restrict_enrollments_to_section_dates, :boolean
+    add_column :enrollment_terms, :ignore_term_date_restrictions, :boolean
+  end
+
+  def self.down
+    remove_column :courses, :restrict_enrollments_to_course_dates
+    remove_column :course_sections, :restrict_enrollments_to_section_dates
+    remove_column :enrollment_terms, :ignore_term_date_restrictions
+  end
+end
diff --git a/lib/enrollment_date_restrictions.rb b/lib/enrollment_date_restrictions.rb
@@ -0,0 +1,97 @@
+module EnrollmentDateRestrictions
+  def self.included(klass)
+    klass.send :before_save, :check_for_date_restrictions
+    klass.send :after_save, :schedule_date_restrictions_update
+  end
+
+  def check_for_date_restrictions
+    @schedule_restrictions_update = restrict_dates? &&
+      ((start_at && start_at_changed?) || (end_at && end_at_changed?))
+    true
+  end
+  
+  def restrict_dates?
+    (self.is_a?(Course) && restrict_enrollments_to_course_dates) || 
+    (self.is_a?(CourseSection) && restrict_enrollments_to_section_dates) ||
+    # as of right now overrides at the enrollment level require
+    # both start_at *and* end_at to be set.
+    (self.is_a?(Enrollment) && start_at && end_at) ||
+    (self.is_a?(EnrollmentTerm) && !ignore_term_date_restrictions) ||
+    (self.is_a?(EnrollmentDatesOverride) && !enrollment_term.ignore_term_date_restrictions)
+  end
+  
+  def schedule_date_restrictions_update
+    if @schedule_restrictions_update
+      do_it_now = false
+      
+      if start_at && start_at > Time.now
+        EnrollmentDateRestrictions.send_at(:start_at, :update_restricted_enrollments, self)
+      elsif start_at
+        do_it_now = true
+      end
+      
+      if end_at && end_at > Time.now
+        EnrollmentDateRestrictions.send_at(:end_at, :update_restricted_enrollments, self)
+      elsif end_at
+        do_it_now = true
+      end
+      
+      if do_it_now
+        EnrollmentDateRestrictions.send_later(:update_restricted_enrollments, self)
+      end
+    end
+  end
+  
+  def self.update_restricted_enrollments(context)
+    start_at = context.start_at
+    end_at = context.end_at
+    all_enrollment_ids = []
+    @course_lookups = []
+    if context.is_a?(Course)
+      if context.available? && context.restrict_enrollments_to_course_dates
+        all_enrollment_ids = Enrollment.find(:all, :conditions => {:course_id => context.id}, :select => 'id').map(&:id)
+      end
+    elsif context.is_a?(CourseSection)
+      if context.restrict_enrollments_to_section_dates
+        all_enrollment_ids = Enrollment.find(:all, :conditions => {:course_section_id => context.id}, :select => 'id').map(&:id)
+      end
+    elsif context.is_a?(EnrollmentDatesOverride)
+      term = context.enrollment_term
+      start_at = nil if term.ignore_term_date_restrictions
+      end_at = nil if term.ignore_term_date_restrictions
+      all_enrollment_ids = Enrollment.find(:all, :joins => [:course], :conditions => ['enrollments.course_id = courses.id AND courses.enrollment_term_id = ? AND enrollments.type = ?', context.enrollment_term_id, context.enrollment_type], :select => 'enrollments.id').map(&:id)
+      all_enrollment_ids += Enrollment.find(:all, :joins => [:course_section], :conditions => ['enrollments.course_section_id = course_sections.id AND course_sections.enrollment_term_id = ? AND enrollments.type = ?', context.enrollment_term_id, context.enrollment_type], :select => 'enrollments.id').map(&:id)
+    elsif context.is_a?(Enrollment)
+      all_enrollment_ids = [context.id]
+    elsif context.is_a?(EnrollmentTerm)
+      start_at = nil if context.ignore_term_date_restrictions
+      end_at = nil if context.ignore_term_date_restrictions
+      all_enrollment_ids = Enrollment.find(:all, :joins => [:course], :conditions => ['enrollments.course_id = courses.id AND courses.enrollment_term_id = ?', context.id], :select => 'enrollments.id').map(&:id)
+      all_enrollment_ids += Enrollment.find(:all, :joins => [:course_section], :conditions => ['enrollments.course_section_id = course_sections.id AND course_sections.enrollment_term_id = ?', context.id], :select => 'enrollments.id').map(&:id)
+    end
+    
+    return if all_enrollment_ids.empty?
+    
+    if start_at && end_at && start_at <= Time.now && end_at >= Time.now
+      Enrollment.find_all_by_id_and_workflow_state(all_enrollment_ids, 'inactive').each do |enrollment|
+        course = lookup_enrollment_course(enrollment)
+        if course.enrollment_state_based_on_date(enrollment) == 'active'
+          enrollment.activate
+        end
+      end
+    elsif end_at && end_at <= Time.now
+      Enrollment.find_all_by_id_and_workflow_state(all_enrollment_ids, ['active','invited']).each do |enrollment|
+        course = lookup_enrollment_course(enrollment)
+        if course.enrollment_state_based_on_date(enrollment) == 'completed'
+          enrollment.complete
+        end
+      end
+    end
+  end
+  
+  def self.lookup_enrollment_course(enrollment)
+    course = @course_lookups[enrollment.course_id]
+    course ||= enrollment.course
+    @course_lookups[enrollment.course_id] = course
+  end
+end
diff --git a/lib/sis/enrollment_importer.rb b/lib/sis/enrollment_importer.rb
diff --git a/public/javascripts/course_details.js b/public/javascripts/course_details.js
diff --git a/spec/lib/enrollment_date_rescrictions_spec.rb b/spec/lib/enrollment_date_rescrictions_spec.rb
diff --git a/spec/models/enrollment_spec.rb b/spec/models/enrollment_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`#`
`18`	`18`
`19`	`19`	`class EnrollmentDatesOverride < ActiveRecord::Base`
	`20`	`+ include EnrollmentDateRestrictions`
	`21`	`+`
`20`	`22`	`belongs_to :context, :polymorphic => true`
`21`	`23`	`belongs_to :enrollment_term`
`22`	`24`	`end`