This repository was archived by the owner on Oct 9, 2024. It is now read-only.
forked from gocodebox/lifterlms
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclass-llms-test-functions-access.php
More file actions
423 lines (335 loc) · 17.1 KB
/
class-llms-test-functions-access.php
File metadata and controls
423 lines (335 loc) · 17.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
<?php
/**
* Tests for LifterLMS Access Functions.
*
* @group access
*
* @since 3.7.3
* @since 3.16.0 Unknown.
* @since 3.37.10 Added tests on sitewide membership restriction.
* @since 6.5.0 Added tests for drip restrictions on completed lessons.
*/
class LLMS_Test_Functions_Access extends LLMS_UnitTestCase {
/**
* Get a formatted date for setting time period related restrictions.
*
* @param string $offset adjust day via strtotime
* @param string $format desired returned format, passed to date()
* @return string
* @since 3.7.3
* @version 3.7.3
*/
private function get_date( $offset = '+7 days', $format = 'm/d/y' ) {
return date( $format, strtotime( $offset, current_time( 'timestamp' ) ) );
}
/**
* Test drip restrictions.
*
* @since 3.16.0
* @since 6.0.0 Replaced use of deprecated items.
* - `llms_reset_current_time()` with `llms_tests_reset_current_time()` from the `lifterlms-tests` project
* - `llms_mock_current_time()` with `llms_tests_mock_current_time()` from the `lifterlms-tests` project
*
* @return void
*/
public function test_llms_is_post_restricted_by_drip_settings() {
$course_id = $this->generate_mock_courses( 1, 1, 2, 0 )[0];
$course = llms_get_post( $course_id );
$lesson = $course->get_lessons()[0];
$lesson_id = $lesson->get( 'id' );
$student = $this->get_mock_student();
wp_set_current_user( $student->get_id() );
$student->enroll( $course_id );
// no drip settings, lesson is currently available.
$this->assertFalse( llms_is_post_restricted_by_drip_settings( $lesson_id ) );
// date in past so the lesson is available.
$lesson = llms_get_post( $lesson_id );
$lesson->set( 'drip_method', 'date' );
$lesson->set( 'date_available', '12/12/2012' );
$lesson->set( 'time_available', '12:12 AM' );
$this->assertFalse( llms_is_post_restricted_by_drip_settings( $lesson_id ) );
// date in future so lesson not available.
$lesson->set( 'date_available', date( 'm/d/Y', current_time( 'timestamp' ) + DAY_IN_SECONDS ) );
$this->assertEquals( $lesson_id, llms_is_post_restricted_by_drip_settings( $lesson_id ) );
// available 3 days after enrollment.
$lesson->set( 'drip_method', 'enrollment' );
$lesson->set( 'days_before_available', '3' );
$this->assertEquals( $lesson_id, llms_is_post_restricted_by_drip_settings( $lesson_id ) );
// now available.
llms_tests_mock_current_time( '+4 days' );
$this->assertFalse( llms_is_post_restricted_by_drip_settings( $lesson_id ) );
llms_tests_reset_current_time();
$lesson->set( 'drip_method', 'start' );
$course->set( 'start_date', date( 'm/d/Y', current_time( 'timestamp' ) + DAY_IN_SECONDS ) );
// not available until 3 days after course start date.
$this->assertEquals( $lesson_id, llms_is_post_restricted_by_drip_settings( $lesson_id ) );
// now available.
llms_tests_mock_current_time( '+4 days' );
$this->assertFalse( llms_is_post_restricted_by_drip_settings( $lesson_id ) );
}
/**
* Test drip restriction for already completed lesson.
*
* @since 6.5.0
*
* @return void
*/
public function test_llms_is_post_restricted_by_drip_settings_completed_lesson() {
$course = $this->factory->course->create_and_get();
$lesson = $course->get_lessons()[0];
$lesson_id = $lesson->get( 'id' );
$student = $this->get_mock_student();
wp_set_current_user( $student->get( 'id' ) );
$student->enroll( $course );
// No drip settings, lesson is currently available.
$this->assertFalse( llms_is_post_restricted_by_drip_settings( $lesson_id ) );
// Add any drip settings, lesson available in the future.
$lesson->set( 'drip_method', 'date' );
$lesson->set( 'date_available', date( 'm/d/Y', current_time( 'timestamp' ) + DAY_IN_SECONDS ) );
$this->assertEquals( $lesson_id, llms_is_post_restricted_by_drip_settings( $lesson_id ) );
// Mark the lesson complete.
$student->mark_complete( $lesson_id, 'lesson' );
// We expect the lesson to be not restricted by drip settings anymore.
$this->assertFalse( llms_is_post_restricted_by_drip_settings( $lesson_id ) );
// Turn off the drip bypass filter: lesson drip.
add_filter( 'llms_lesson_drip_bypass_if_completed', '__return_false', 10 );
$this->assertEquals( $lesson_id, llms_is_post_restricted_by_drip_settings( $lesson_id ) );
remove_filter( 'llms_lesson_drip_bypass_if_completed', '__return_false', 10 );
}
/**
* Test restricted by membership.
*
* @since Unknown.
*
* @return void
*/
public function test_llms_is_post_restricted_by_membership() {
$memberships = $this->factory->post->create_many( 2, array(
'post_type' => 'llms_membership',
) );
$post_id = $this->factory->post->create();
$student = $this->get_mock_student();
$uid = $student->get_id();
$this->assertFalse( llms_is_post_restricted_by_membership( $post_id ) );
$this->assertFalse( llms_is_post_restricted_by_membership( $post_id, $uid ) );
update_post_meta( $post_id, '_llms_restricted_levels', $memberships );
update_post_meta( $post_id, '_llms_is_restricted', 'yes' );
$this->assertEquals( $memberships, llms_is_post_restricted_by_membership( $post_id ) );
$this->assertEquals( $memberships, llms_is_post_restricted_by_membership( $post_id, $uid ) );
$out = llms_is_post_restricted_by_membership( $post_id );
$in = llms_is_post_restricted_by_membership( $post_id, $uid );
$student->enroll( $memberships[1] );
$this->assertEquals( $memberships, llms_is_post_restricted_by_membership( $post_id, $uid ) );
}
/**
* Test restriction by membership sitewide.
*
* @since Unknown.
*
* @return void
*/
public function test_llms_is_post_restricted_by_sitewide_membership() {
$memberships = $this->factory->post->create_many( 2, array(
'post_type' => 'llms_membership',
) );
$post_id = $this->factory->post->create();
// create a page where redirect to.
$redirect_id = $this->factory->post->create( array(
'post_type' => 'page'
) );
/**
* Create pages that must be always accessible.
*/
// create and set privacy policy page.
update_option( 'wp_page_for_privacy_policy', $this->factory->post->create( array(
'post_type' => 'page'
) ) );
// create and set terms page.
update_option( 'lifterlms_terms_page_id', $this->factory->post->create( array(
'post_type' => 'page'
) ) );
// create and set memberships catalog page.
update_option( 'lifterlms_memberships_page_id', $this->factory->post->create( array(
'post_type' => 'page'
) ) );
// create and set myaccount page.
update_option( 'lifterlms_myaccount_page_id', $this->factory->post->create( array(
'post_type' => 'page'
) ) );
// create and set checkout page.
update_option( 'lifterlms_checkout_page_id', $this->factory->post->create( array(
'post_type' => 'page'
) ) );
// require membership sitewide.
update_option( 'lifterlms_membership_required', $memberships[1] );
// set membership's restriction redirection.
update_post_meta( $memberships[1], '_llms_redirect_page_id', $redirect_id );
update_post_meta( $memberships[1], '_llms_restriction_redirect_type', 'page' );
// I expect a post or another membership to be restricted.
// While I expect the redirection page and the membership set as requirement to be accessible.
$this->assertEquals( $memberships[1], llms_is_post_restricted_by_sitewide_membership( $post_id ) );
$this->assertEquals( $memberships[1], llms_is_post_restricted_by_sitewide_membership( $memberships[0] ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( $memberships[1] ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( $redirect_id ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( absint( get_option( 'lifterlms_terms_page_id' ) ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'memberships' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'myaccount' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'checkout' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( absint( get_option( 'wp_page_for_privacy_policy' ) ) ) );
// unset the redirection page.
// I expect a post, the former redirection page or another membership to be restricted.
// While I expect membership set as requirement to be accessible.
update_post_meta( $memberships[1], '_llms_redirect_page_id', '' );
$this->assertEquals( $memberships[1], llms_is_post_restricted_by_sitewide_membership( $post_id ) );
$this->assertEquals( $memberships[1], llms_is_post_restricted_by_sitewide_membership( $memberships[0] ) );
$this->assertEquals( $memberships[1], llms_is_post_restricted_by_sitewide_membership( $redirect_id ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( $memberships[1] ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( absint( get_option( 'lifterlms_terms_page_id' ) ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'memberships' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'myaccount' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'checkout' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( absint( get_option( 'wp_page_for_privacy_policy' ) ) ) );
// re-set the redirection page, but set the restriction redirect type as 'custom'.
// I expect a post, the former redirection page or another membership to be restricted.
// While I expect membership set as requirement to be accessible.
update_post_meta( $memberships[1], '_llms_redirect_page_id', $redirect_id );
update_post_meta( $memberships[1], '_llms_restriction_redirect_type', 'custom' );
$this->assertEquals( $memberships[1], llms_is_post_restricted_by_sitewide_membership( $post_id ) );
$this->assertEquals( $memberships[1], llms_is_post_restricted_by_sitewide_membership( $memberships[0] ) );
$this->assertEquals( $memberships[1], llms_is_post_restricted_by_sitewide_membership( $redirect_id ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( $memberships[1] ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( absint( get_option( 'lifterlms_terms_page_id' ) ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'memberships' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'myaccount' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'checkout' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( absint( get_option( 'wp_page_for_privacy_policy' ) ) ) );
// unset the membership enrollment requirement.
// I expect 'everything' to be not restricted.
update_option( 'lifterlms_membership_required', '' );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( $post_id ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( $memberships[0] ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( $memberships[1] ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( $redirect_id ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( absint( get_option( 'lifterlms_terms_page_id' ) ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'memberships' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'myaccount' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( llms_get_page_id( 'checkout' ) ) );
$this->assertFalse( llms_is_post_restricted_by_sitewide_membership( absint( get_option( 'wp_page_for_privacy_policy' ) ) ) );
}
/**
* Test the llms_is_post_restricted_by_prerequisite() function.
*
* @since 3.8.0
*
* @return void
*/
public function test_llms_is_post_restricted_by_prerequisite() {
$courses = $this->generate_mock_courses( 3, 2, 1, 1 );
$prereq_course_id = $courses[0];
$course_id = $courses[1];
$course = llms_get_post( $course_id );
$track = wp_insert_term( 'mock track', 'course_track' );
$track_id = $track['term_id'];
$course_in_track_id = $courses[2];
wp_set_post_terms( $course_in_track_id, $track_id, 'course_track' );
$lessons = $course->get_lessons( 'ids' );
$lesson_2 = llms_get_post( $lessons[1] );
$lesson_2->set( 'has_prerequisite', 'yes' );
$lesson_2->set( 'prerequisite', $lessons[0] );
$test_ids = array_merge( $lessons, $course->get_quizzes() );
$this->prereq_tests( $test_ids, $course, $prereq_course_id, $track_id );
$student_id = $this->factory->user->create( array( 'role' => 'student' ) );
// results should all be the same with the student b/c nothing completed.
$this->prereq_tests( $test_ids, $course, $prereq_course_id, $track_id, $student_id );
// results differ once student completes courses.
$this->complete_courses_for_student( $student_id, $courses );
$this->prereq_tests( $test_ids, $course, $prereq_course_id, $track_id, $student_id );
}
/**
* test_llms_is_post_restricted_by_prerequisite() runs this series of assertions several times.
*
* @since 3.7.3
* @since 3.12.0 Unknown.
* @since 4.9.0 Remove default value of `$test_ids` parameter for php8 compatibility.
*
* @param array $test_ids Array of post ids to test the llms_is_post_restricted_by_prerequisite() against.
* @param obj $course Course object.
* @param int $prereq_course_id Post id of the prereq course.
* @param int $track_id Term id of the prereq track.
* @param int $user_id Wp user id of a student.
* @return void
*/
private function prereq_tests( $test_ids, $course, $prereq_course_id, $track_id, $user_id = null ) {
$student = $user_id ? new LLMS_Student( $user_id ) : null;
foreach ( $test_ids as $test_id ) {
$course->set( 'has_prerequisite', 'no' );
$course->set( 'prerequisite', '' );
$course->set( 'prerequisite_track', '' );
$post = llms_get_post( $test_id );
if ( 'lesson' === get_post_type( $test_id ) && $post->has_prerequisite() ) {
$lesson_prereq_id = $post->get( 'prerequisite' );
$lesson_res = $student && $student->is_complete( $lesson_prereq_id, 'lesson' ) ? false : array(
'type' => 'lesson',
'id' => $lesson_prereq_id,
);
$this->assertEquals( $lesson_res, llms_is_post_restricted_by_prerequisite( $test_id, $user_id ) );
}
// set a course prereq.
$course->set( 'has_prerequisite', 'yes' );
$course->set( 'prerequisite', $prereq_course_id );
$prereq_course_res = $student && $student->is_complete( $prereq_course_id, 'course' ) ? false : array(
'type' => 'course',
'id' => $prereq_course_id,
);
$this->assertEquals( $prereq_course_res, llms_is_post_restricted_by_prerequisite( $test_id, $user_id ) );
// set a track prereq.
$course->set( 'prerequisite_track', $track_id );
// checks course prereq first and only returns one.
$this->assertEquals( $prereq_course_res, llms_is_post_restricted_by_prerequisite( $test_id, $user_id ) );
// no course prereq, returns track id.
$course->set( 'prerequisite', '' );
$prereq_track_res = $student && $student->is_complete( $track_id, 'course_track' ) ? false : array(
'type' => 'course_track',
'id' => $track_id,
);
$this->assertEquals( $prereq_track_res, llms_is_post_restricted_by_prerequisite( $test_id, $user_id ) );
}
}
/**
* Test the llms_is_post_restricted_by_time_period() function.
*
* @since 3.7.3
*
* @return void
*/
public function test_llms_is_post_restricted_by_time_period() {
$courses = $this->generate_mock_courses( 1, 1, 1, 1 );
$course_id = $courses[0];
$course = llms_get_post( $course_id );
$test_ids = array_merge( array( $course_id ), $course->get_lessons( 'ids' ), $course->get_quizzes() );
foreach ( $test_ids as $test_post_id ) {
$course->set( 'time_period', 'no' );
// no time period.
$this->assertFalse( llms_is_post_restricted_by_time_period( $test_post_id ) );
// enable the restriction.
$course->set( 'time_period', 'yes' );
// no dates set the course is closed without dates.
$this->assertEquals( $course_id, llms_is_post_restricted_by_time_period( $test_post_id ) );
// start date in the future.
$course->set( 'start_date', $this->get_date( '+7 days' ) );
$this->assertEquals( $course_id, llms_is_post_restricted_by_time_period( $test_post_id ) );
// start date in past.
$course->set( 'start_date', $this->get_date( '-7 days' ) );
$this->assertFalse( llms_is_post_restricted_by_time_period( $test_post_id ) );
// start date in past and end date in past.
$course->set( 'end_date', $this->get_date( '-5 days' ) );
$this->assertEquals( $course_id, llms_is_post_restricted_by_time_period( $test_post_id ) );
// no start date, end date in past.
$course->set( 'start_date', '' );
$this->assertEquals( $course_id, llms_is_post_restricted_by_time_period( $test_post_id ) );
// no start date end in future.
$course->set( 'end_date', $this->get_date( '+7 days' ) );
$this->assertEquals( $course_id, llms_is_post_restricted_by_time_period( $test_post_id ) );
}
}
}