Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
significance: patch
type: fixed
entry: "Prevented trashing or deleting an order from unenrolling a student or deleting their enrollment when another active or completed order exists for the same product."
links:
- "#3464"
161 changes: 127 additions & 34 deletions includes/models/model.llms.student.php
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,55 @@ public function get_enrollment_order( $product_id ) {
return false;
}

/**
* Retrieve an active or completed order for the given product.
*
* @since [version]
*
* @param int $product_id WP Post ID of the LifterLMS Product (course, lesson, or membership).
* @param int|null $exclude_id Optional. Order ID to exclude from query. Default null.
* @return LLMS_Order|false Instance of the LLMS_Order or false if none found.
*/
public function get_active_order_for_product( $product_id, $exclude_id = null ) {

// If a lesson id was passed in, cascade up to the course for order retrieval.
if ( 'lesson' === get_post_type( $product_id ) ) {
$lesson = new LLMS_Lesson( $product_id );
$product_id = $lesson->get( 'parent_course' );
}

$query_args = array(
'order' => 'DESC',
'orderby' => 'date',
'post_status' => array( 'llms-active', 'llms-completed' ),
'post_type' => 'llms_order',
'posts_per_page' => 1,
'meta_query' => array(
'relation' => 'AND',
array(
'key' => '_llms_user_id',
'value' => $this->get_id(),
),
array(
'key' => '_llms_product_id',
'value' => $product_id,
),
),
);

if ( ! empty( $exclude_id ) ) {
$query_args['post__not_in'] = array( absint( $exclude_id ) );
}

$q = new WP_Query( $query_args );

if ( $q->have_posts() ) {
return new LLMS_Order( $q->posts[0] );
}

return false;
}

/**
* Retrieve IDs of user's courses based on supplied criteria
*
Expand Down Expand Up @@ -648,6 +697,22 @@ public function get_enrollment_trigger( $product_id ) {
return $trigger ? $trigger : false;
}

/**
* Set the enrollment trigger for a student's enrollment in a course or membership.
*
* @since [version]
*
* @param int $product_id WP Post ID of the course or membership.
* @param string $trigger Enrollment trigger string.
* @return bool Whether the postmeta was updated.
*/
public function set_enrollment_trigger( $product_id, $trigger ) {

llms_delete_user_postmeta( $this->get_id(), $product_id, '_enrollment_trigger' );

return (bool) llms_update_user_postmeta( $this->get_id(), $product_id, '_enrollment_trigger', $trigger );
}

/**
* Get the enrollment trigger id for a the student's enrollment in a course
*
Expand Down Expand Up @@ -1654,28 +1719,40 @@ public function unenroll( $product_id, $trigger = 'any', $new_status = 'expired'

$enrollment_trigger = $this->get_enrollment_trigger( $product_id );

// Check if another active or completed order exists for this product.
$excluded_id = ( 0 === strpos( $trigger, 'order_' ) ) ? absint( str_replace( array( 'order_', 'wc_order_' ), '', $trigger ) ) : null;
$active_order = $this->get_active_order_for_product( $product_id, $excluded_id );

// No enrollment trigger exists b/c pre 3.0.0 enrollment, unenroll the user as if it was an 'any' trigger.
if ( ! $enrollment_trigger ) {

/**
* This filter allows customization of enrollments created prior to version 3.0.0
*
* Prior to 3.0.0 enrollments did not track an enrollment trigger so any unenrollments
* performed on an enrollment in this state will automatically be unenrolled.
*
* Returning `false` will prevent unenrollments against enrollments which don't have
* an enrollment trigger.
*
* @since 3.0.0
*
* @param bool $allow_unenrollment If true, allows unenrollment, otherwise prevents unenrollment.
*/
$update = apply_filters( 'lifterlms_legacy_unenrollment_action', true );

if ( $active_order ) {
$this->set_enrollment_trigger( $product_id, 'order_' . $active_order->get( 'id' ) );
$update = false;
} else {
/**
* This filter allows customization of enrollments created prior to version 3.0.0
*
* Prior to 3.0.0 enrollments did not track an enrollment trigger so any unenrollments
* performed on an enrollment in this state will automatically be unenrolled.
*
* Returning `false` will prevent unenrollments against enrollments which don't have
* an enrollment trigger.
*
* @since 3.0.0
*
* @param bool $allow_unenrollment If true, allows unenrollment, otherwise prevents unenrollment.
*/
$update = apply_filters( 'lifterlms_legacy_unenrollment_action', true );
}
} elseif ( $enrollment_trigger === $trigger ) {

$update = true;

if ( $active_order ) {
$this->set_enrollment_trigger( $product_id, 'order_' . $active_order->get( 'id' ) );
$update = false;
} else {
$update = true;
}
}
}

Expand Down Expand Up @@ -1746,30 +1823,46 @@ public function delete_enrollment( $product_id, $trigger = 'any' ) {
// Get the stored trigger.
$enrollment_trigger = $this->get_enrollment_trigger( $product_id );

// Check if another active or completed order exists for this product.
$excluded_id = ( 'any' !== $trigger && 0 === strpos( $trigger, 'order_' ) ) ? absint( str_replace( array( 'order_', 'wc_order_' ), '', $trigger ) ) : null;
$active_order = ( 'any' !== $trigger ) ? $this->get_active_order_for_product( $product_id, $excluded_id ) : false;

// Okay to delete if trigger is "any" or if it matches the stored enrollment trigger.
if ( 'any' === $trigger || $enrollment_trigger === $trigger ) {
if ( 'any' === $trigger ) {

$delete = true;

} elseif ( ! $enrollment_trigger ) {
} elseif ( $enrollment_trigger === $trigger ) {

/**
* Customize the behavior of enrollment deletion for "legacy" orders.
*
* These orders were created before version 3.0.0 when there was no stored
* enrollment trigger.
*
* By default, we'll automatically delete these enrollments regardless of trigger.
*
* @since 3.33.0
*
* @param boolean $delete Whether or not to delete the enrollment.
*/
$delete = apply_filters( 'lifterlms_legacy_delete_enrollment_action', true );
if ( $active_order ) {
$this->set_enrollment_trigger( $product_id, 'order_' . $active_order->get( 'id' ) );
$delete = false;
} else {
$delete = true;
}
} elseif ( ! $enrollment_trigger ) {

// Ensure we have an `$enrollment_trigger` when firing the `llms_user_enrollment_deleted` hook.
$enrollment_trigger = $trigger;
if ( $active_order ) {
$this->set_enrollment_trigger( $product_id, 'order_' . $active_order->get( 'id' ) );
$delete = false;
} else {
/**
* Customize the behavior of enrollment deletion for "legacy" orders.
*
* These orders were created before version 3.0.0 when there was no stored
* enrollment trigger.
*
* By default, we'll automatically delete these enrollments regardless of trigger.
*
* @since 3.33.0
*
* @param boolean $delete Whether or not to delete the enrollment.
*/
$delete = apply_filters( 'lifterlms_legacy_delete_enrollment_action', true );

// Ensure we have an `$enrollment_trigger` when firing the `llms_user_enrollment_deleted` hook.
$enrollment_trigger = $trigger;
}
}

// Delete the enrollment.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,109 @@ public function test_on_delete_order() {
);
}

/**
* Test that trashing an order does not unenroll a student who has another active order.
*
* @ticket 3464
* @since [version]
*
* @return void
*/
public function test_error_order_preserves_enrollment_when_active_order_exists() {

$plan = $this->get_mock_plan();
$student = $this->get_mock_student();
$product_id = $plan->get( 'product_id' );

$order_a = $this->get_mock_order( $plan, false, $student );
$order_b = $this->get_mock_order( $plan, false, $student );

// Set Order A to failed and Order B to active.
$order_a->set( 'status', 'llms-failed' );
$order_b->set( 'status', 'llms-active' );

// Remove the enrollment trigger to simulate missing trigger.
llms_delete_user_postmeta( $student->get_id(), $product_id, '_enrollment_trigger' );
$this->assertFalse( $student->get_enrollment_trigger( $product_id ) );
$this->assertTrue( $student->is_enrolled( $product_id ) );

// Trash Order A.
wp_trash_post( $order_a->get( 'id' ) );

// Student should remain enrolled because Order B is active.
$this->assertTrue( $student->is_enrolled( $product_id ) );
$this->assertEquals( 'enrolled', $student->get_enrollment_status( $product_id ) );
$this->assertEquals( 'order_' . $order_b->get( 'id' ), $student->get_enrollment_trigger( $product_id ) );
}

/**
* Test that permanently deleting an order does not remove enrollment when another active order exists.
*
* @ticket 3464
* @since [version]
*
* @return void
*/
public function test_on_delete_order_preserves_enrollment_when_active_order_exists() {

$plan = $this->get_mock_plan();
$student = $this->get_mock_student();
$product_id = $plan->get( 'product_id' );

$order_a = $this->get_mock_order( $plan, false, $student );
$order_b = $this->get_mock_order( $plan, false, $student );

// Set Order A to failed and Order B to active.
$order_a->set( 'status', 'llms-failed' );
$order_b->set( 'status', 'llms-active' );

// Remove the enrollment trigger to simulate missing trigger.
llms_delete_user_postmeta( $student->get_id(), $product_id, '_enrollment_trigger' );
$this->assertFalse( $student->get_enrollment_trigger( $product_id ) );
$this->assertTrue( $student->is_enrolled( $product_id ) );

// Permanently delete Order A.
wp_delete_post( $order_a->get( 'id' ), true );

// Student should remain enrolled because Order B is active.
$this->assertTrue( $student->is_enrolled( $product_id ) );
$this->assertEquals( 'enrolled', $student->get_enrollment_status( $product_id ) );
$this->assertEquals( 'order_' . $order_b->get( 'id' ), $student->get_enrollment_trigger( $product_id ) );
}

/**
* Test that trashing an older order matching the trigger does not unenroll a student with a newer active order.
*
* @ticket 3464
* @since [version]
*
* @return void
*/
public function test_error_order_matching_trigger_preserves_enrollment_when_active_order_exists() {

$plan = $this->get_mock_plan();
$student = $this->get_mock_student();
$product_id = $plan->get( 'product_id' );

$order_a = $this->get_mock_order( $plan, false, $student );
$order_b = $this->get_mock_order( $plan, false, $student );

// Set Order A active first, then Order B active.
$order_a->set( 'status', 'llms-active' );
$student->set_enrollment_trigger( $product_id, 'order_' . $order_a->get( 'id' ) );
$order_b->set( 'status', 'llms-active' );

$this->assertEquals( 'order_' . $order_a->get( 'id' ), $student->get_enrollment_trigger( $product_id ) );

// Trash Order A.
wp_trash_post( $order_a->get( 'id' ) );

// Student should remain enrolled and trigger should now point to Order B.
$this->assertTrue( $student->is_enrolled( $product_id ) );
$this->assertEquals( 'enrolled', $student->get_enrollment_status( $product_id ) );
$this->assertEquals( 'order_' . $order_b->get( 'id' ), $student->get_enrollment_trigger( $product_id ) );
}

/**
* Test on user enrollment deleted.
*
Expand Down
Loading
Loading