Merge branch 'wip-MDL-50633-master2' of https://github.com/marinaglancy/moodle
[moodle.git] / admin / tool / generator / classes / course_backend.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * tool_generator course backend code.
19  *
20  * @package tool_generator
21  * @copyright 2013 The Open University
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * Backend code for the 'make large course' tool.
29  *
30  * @package tool_generator
31  * @copyright 2013 The Open University
32  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
34 class tool_generator_course_backend extends tool_generator_backend {
35     /**
36      * @var array Number of sections in course
37      */
38     private static $paramsections = array(1, 10, 100, 500, 1000, 2000);
39     /**
40      * @var array Number of assignments in course
41      */
42     private static $paramassignments = array(1, 10, 100, 500, 1000, 2000);
43     /**
44      * @var array Number of Page activities in course
45      */
46     private static $parampages = array(1, 50, 200, 1000, 5000, 10000);
47     /**
48      * @var array Number of students enrolled in course
49      */
50     private static $paramusers = array(1, 100, 1000, 10000, 50000, 100000);
51     /**
52      * Total size of small files: 1KB, 1MB, 10MB, 100MB, 1GB, 2GB.
53      *
54      * @var array Number of small files created in a single file activity
55      */
56     private static $paramsmallfilecount = array(1, 64, 128, 1024, 16384, 32768);
57     /**
58      * @var array Size of small files (to make the totals into nice numbers)
59      */
60     private static $paramsmallfilesize = array(1024, 16384, 81920, 102400, 65536, 65536);
61     /**
62      * Total size of big files: 8KB, 8MB, 80MB, 800MB, 8GB, 16GB.
63      *
64      * @var array Number of big files created as individual file activities
65      */
66     private static $parambigfilecount = array(1, 2, 5, 10, 10, 10);
67     /**
68      * @var array Size of each large file
69      */
70     private static $parambigfilesize = array(8192, 4194304, 16777216, 83886080,
71             858993459, 1717986918);
72     /**
73      * @var array Number of forum discussions
74      */
75     private static $paramforumdiscussions = array(1, 10, 100, 500, 1000, 2000);
76     /**
77      * @var array Number of forum posts per discussion
78      */
79     private static $paramforumposts = array(2, 2, 5, 10, 10, 10);
81     /**
82      * @var string Course shortname
83      */
84     private $shortname;
86     /**
87      * @var string Course fullname.
88      */
89     private $fullname = "";
91     /**
92      * @var string Course summary.
93      */
94     private $summary = "";
96     /**
97      * @var string Course summary format, defaults to FORMAT_HTML.
98      */
99     private $summaryformat = FORMAT_HTML;
101     /**
102      * @var testing_data_generator Data generator
103      */
104     protected $generator;
106     /**
107      * @var stdClass Course object
108      */
109     private $course;
111     /**
112      * @var array Array from test user number (1...N) to userid in database
113      */
114     private $userids;
116     /**
117      * Constructs object ready to create course.
118      *
119      * @param string $shortname Course shortname
120      * @param int $size Size as numeric index
121      * @param bool $fixeddataset To use fixed or random data
122      * @param int|bool $filesizelimit The max number of bytes for a generated file
123      * @param bool $progress True if progress information should be displayed
124      */
125     public function __construct(
126         $shortname,
127         $size,
128         $fixeddataset = false,
129         $filesizelimit = false,
130         $progress = true,
131         $fullname = null,
132         $summary = null,
133         $summaryformat = FORMAT_HTML) {
135         // Set parameters.
136         $this->shortname = $shortname;
138         // We can't allow fullname to be set to an empty string.
139         if (empty($fullname)) {
140             $this->fullname = get_string(
141                 'fullname',
142                 'tool_generator',
143                 array(
144                     'size' => get_string('shortsize_' . $size, 'tool_generator')
145                 )
146             );
147         } else {
148             $this->fullname = $fullname;
149         }
151         // Summary, on the other hand, should be empty-able.
152         if (!is_null($summary)) {
153             $this->summary = $summary;
154             $this->summaryformat = $summaryformat;
155         }
157         parent::__construct($size, $fixeddataset, $filesizelimit, $progress);
158     }
160     /**
161      * Returns the relation between users and course sizes.
162      *
163      * @return array
164      */
165     public static function get_users_per_size() {
166         return self::$paramusers;
167     }
169     /**
170      * Gets a list of size choices supported by this backend.
171      *
172      * @return array List of size (int) => text description for display
173      */
174     public static function get_size_choices() {
175         $options = array();
176         for ($size = self::MIN_SIZE; $size <= self::MAX_SIZE; $size++) {
177             $options[$size] = get_string('coursesize_' . $size, 'tool_generator');
178         }
179         return $options;
180     }
182     /**
183      * Checks that a shortname is available (unused).
184      *
185      * @param string $shortname Proposed course shortname
186      * @return string An error message if the name is unavailable or '' if OK
187      */
188     public static function check_shortname_available($shortname) {
189         global $DB;
190         $fullname = $DB->get_field('course', 'fullname',
191                 array('shortname' => $shortname), IGNORE_MISSING);
192         if ($fullname !== false) {
193             // I wanted to throw an exception here but it is not possible to
194             // use strings from moodle.php in exceptions, and I didn't want
195             // to duplicate the string in tool_generator, so I changed this to
196             // not use exceptions.
197             return get_string('shortnametaken', 'moodle', $fullname);
198         }
199         return '';
200     }
202     /**
203      * Runs the entire 'make' process.
204      *
205      * @return int Course id
206      */
207     public function make() {
208         global $DB, $CFG;
209         require_once($CFG->dirroot . '/lib/phpunit/classes/util.php');
211         raise_memory_limit(MEMORY_EXTRA);
213         if ($this->progress && !CLI_SCRIPT) {
214             echo html_writer::start_tag('ul');
215         }
217         $entirestart = microtime(true);
219         // Start transaction.
220         $transaction = $DB->start_delegated_transaction();
222         // Get generator.
223         $this->generator = phpunit_util::get_data_generator();
225         // Make course.
226         $this->course = $this->create_course();
227         $this->create_users();
228         $this->create_assignments();
229         $this->create_pages();
230         $this->create_small_files();
231         $this->create_big_files();
232         $this->create_forum();
234         // Log total time.
235         $this->log('coursecompleted', round(microtime(true) - $entirestart, 1));
237         if ($this->progress && !CLI_SCRIPT) {
238             echo html_writer::end_tag('ul');
239         }
241         // Commit transaction and finish.
242         $transaction->allow_commit();
243         return $this->course->id;
244     }
246     /**
247      * Creates the actual course.
248      *
249      * @return stdClass Course record
250      */
251     private function create_course() {
252         $this->log('createcourse', $this->shortname);
253         $courserecord = array(
254             'shortname' => $this->shortname,
255             'fullname' => $this->fullname,
256             'numsections' => self::$paramsections[$this->size]
257         );
258         if (strlen($this->summary) > 0) {
259             $courserecord['summary'] = $this->summary;
260             $courserecord['summary_format'] = $this->summaryformat;
261         }
263         return $this->generator->create_course($courserecord, array('createsections' => true));
264     }
266     /**
267      * Creates a number of user accounts and enrols them on the course.
268      * Note: Existing user accounts that were created by this system are
269      * reused if available.
270      */
271     private function create_users() {
272         global $DB;
274         // Work out total number of users.
275         $count = self::$paramusers[$this->size];
277         // Get existing users in order. We will 'fill up holes' in this up to
278         // the required number.
279         $this->log('checkaccounts', $count);
280         $nextnumber = 1;
281         $rs = $DB->get_recordset_select('user', $DB->sql_like('username', '?'),
282                 array('tool_generator_%'), 'username', 'id, username');
283         foreach ($rs as $rec) {
284             // Extract number from username.
285             $matches = array();
286             if (!preg_match('~^tool_generator_([0-9]{6})$~', $rec->username, $matches)) {
287                 continue;
288             }
289             $number = (int)$matches[1];
291             // Create missing users in range up to this.
292             if ($number != $nextnumber) {
293                 $this->create_user_accounts($nextnumber, min($number - 1, $count));
294             } else {
295                 $this->userids[$number] = (int)$rec->id;
296             }
298             // Stop if we've got enough users.
299             $nextnumber = $number + 1;
300             if ($number >= $count) {
301                 break;
302             }
303         }
304         $rs->close();
306         // Create users from end of existing range.
307         if ($nextnumber <= $count) {
308             $this->create_user_accounts($nextnumber, $count);
309         }
311         // Assign all users to course.
312         $this->log('enrol', $count, true);
314         $enrolplugin = enrol_get_plugin('manual');
315         $instances = enrol_get_instances($this->course->id, true);
316         foreach ($instances as $instance) {
317             if ($instance->enrol === 'manual') {
318                 break;
319             }
320         }
321         if ($instance->enrol !== 'manual') {
322             throw new coding_exception('No manual enrol plugin in course');
323         }
324         $role = $DB->get_record('role', array('shortname' => 'student'), '*', MUST_EXIST);
326         for ($number = 1; $number <= $count; $number++) {
327             // Enrol user.
328             $enrolplugin->enrol_user($instance, $this->userids[$number], $role->id);
329             $this->dot($number, $count);
330         }
332         // Sets the pointer at the beginning to be aware of the users we use.
333         reset($this->userids);
335         $this->end_log();
336     }
338     /**
339      * Creates user accounts with a numeric range.
340      *
341      * @param int $first Number of first user
342      * @param int $last Number of last user
343      */
344     private function create_user_accounts($first, $last) {
345         global $CFG;
347         $this->log('createaccounts', (object)array('from' => $first, 'to' => $last), true);
348         $count = $last - $first + 1;
349         $done = 0;
350         for ($number = $first; $number <= $last; $number++, $done++) {
351             // Work out username with 6-digit number.
352             $textnumber = (string)$number;
353             while (strlen($textnumber) < 6) {
354                 $textnumber = '0' . $textnumber;
355             }
356             $username = 'tool_generator_' . $textnumber;
358             // Create user account.
359             $record = array('username' => $username, 'idnumber' => $number);
361             // We add a user password if it has been specified.
362             if (!empty($CFG->tool_generator_users_password)) {
363                 $record['password'] = $CFG->tool_generator_users_password;
364             }
366             $user = $this->generator->create_user($record);
367             $this->userids[$number] = (int)$user->id;
368             $this->dot($done, $count);
369         }
370         $this->end_log();
371     }
373     /**
374      * Creates a number of Assignment activities.
375      */
376     private function create_assignments() {
377         // Set up generator.
378         $assigngenerator = $this->generator->get_plugin_generator('mod_assign');
380         // Create assignments.
381         $number = self::$paramassignments[$this->size];
382         $this->log('createassignments', $number, true);
383         for ($i = 0; $i < $number; $i++) {
384             $record = array('course' => $this->course);
385             $options = array('section' => $this->get_target_section());
386             $assigngenerator->create_instance($record, $options);
387             $this->dot($i, $number);
388         }
390         $this->end_log();
391     }
393     /**
394      * Creates a number of Page activities.
395      */
396     private function create_pages() {
397         // Set up generator.
398         $pagegenerator = $this->generator->get_plugin_generator('mod_page');
400         // Create pages.
401         $number = self::$parampages[$this->size];
402         $this->log('createpages', $number, true);
403         for ($i = 0; $i < $number; $i++) {
404             $record = array('course' => $this->course);
405             $options = array('section' => $this->get_target_section());
406             $pagegenerator->create_instance($record, $options);
407             $this->dot($i, $number);
408         }
410         $this->end_log();
411     }
413     /**
414      * Creates one resource activity with a lot of small files.
415      */
416     private function create_small_files() {
417         $count = self::$paramsmallfilecount[$this->size];
418         $this->log('createsmallfiles', $count, true);
420         // Create resource with default textfile only.
421         $resourcegenerator = $this->generator->get_plugin_generator('mod_resource');
422         $record = array('course' => $this->course,
423                 'name' => get_string('smallfiles', 'tool_generator'));
424         $options = array('section' => 0);
425         $resource = $resourcegenerator->create_instance($record, $options);
427         // Add files.
428         $fs = get_file_storage();
429         $context = context_module::instance($resource->cmid);
430         $filerecord = array('component' => 'mod_resource', 'filearea' => 'content',
431                 'contextid' => $context->id, 'itemid' => 0, 'filepath' => '/');
432         for ($i = 0; $i < $count; $i++) {
433             $filerecord['filename'] = 'smallfile' . $i . '.dat';
435             // Generate random binary data (different for each file so it
436             // doesn't compress unrealistically).
437             $data = self::get_random_binary($this->limit_filesize(self::$paramsmallfilesize[$this->size]));
439             $fs->create_file_from_string($filerecord, $data);
440             $this->dot($i, $count);
441         }
443         $this->end_log();
444     }
446     /**
447      * Creates a string of random binary data. The start of the string includes
448      * the current time, in an attempt to avoid large-scale repetition.
449      *
450      * @param int $length Number of bytes
451      * @return Random data
452      */
453     private static function get_random_binary($length) {
455         $data = microtime(true);
456         if (strlen($data) > $length) {
457             // Use last digits of data.
458             return substr($data, -$length);
459         }
460         $length -= strlen($data);
461         for ($j = 0; $j < $length; $j++) {
462             $data .= chr(rand(1, 255));
463         }
464         return $data;
465     }
467     /**
468      * Creates a number of resource activities with one big file each.
469      */
470     private function create_big_files() {
471         global $CFG;
473         // Work out how many files and how many blocks to use (up to 64KB).
474         $count = self::$parambigfilecount[$this->size];
475         $filesize = $this->limit_filesize(self::$parambigfilesize[$this->size]);
476         $blocks = ceil($filesize / 65536);
477         $blocksize = floor($filesize / $blocks);
479         $this->log('createbigfiles', $count, true);
481         // Prepare temp area.
482         $tempfolder = make_temp_directory('tool_generator');
483         $tempfile = $tempfolder . '/' . rand();
485         // Create resources and files.
486         $fs = get_file_storage();
487         $resourcegenerator = $this->generator->get_plugin_generator('mod_resource');
488         for ($i = 0; $i < $count; $i++) {
489             // Create resource.
490             $record = array('course' => $this->course,
491                     'name' => get_string('bigfile', 'tool_generator', $i));
492             $options = array('section' => $this->get_target_section());
493             $resource = $resourcegenerator->create_instance($record, $options);
495             // Write file.
496             $handle = fopen($tempfile, 'w');
497             if (!$handle) {
498                 throw new coding_exception('Failed to open temporary file');
499             }
500             for ($j = 0; $j < $blocks; $j++) {
501                 $data = self::get_random_binary($blocksize);
502                 fwrite($handle, $data);
503                 $this->dot($i * $blocks + $j, $count * $blocks);
504             }
505             fclose($handle);
507             // Add file.
508             $context = context_module::instance($resource->cmid);
509             $filerecord = array('component' => 'mod_resource', 'filearea' => 'content',
510                     'contextid' => $context->id, 'itemid' => 0, 'filepath' => '/',
511                     'filename' => 'bigfile' . $i . '.dat');
512             $fs->create_file_from_pathname($filerecord, $tempfile);
513         }
515         unlink($tempfile);
516         $this->end_log();
517     }
519     /**
520      * Creates one forum activity with a bunch of posts.
521      */
522     private function create_forum() {
523         global $DB;
525         $discussions = self::$paramforumdiscussions[$this->size];
526         $posts = self::$paramforumposts[$this->size];
527         $totalposts = $discussions * $posts;
529         $this->log('createforum', $totalposts, true);
531         // Create empty forum.
532         $forumgenerator = $this->generator->get_plugin_generator('mod_forum');
533         $record = array('course' => $this->course,
534                 'name' => get_string('pluginname', 'forum'));
535         $options = array('section' => 0);
536         $forum = $forumgenerator->create_instance($record, $options);
538         // Add discussions and posts.
539         $sofar = 0;
540         for ($i = 0; $i < $discussions; $i++) {
541             $record = array('forum' => $forum->id, 'course' => $this->course->id,
542                     'userid' => $this->get_target_user());
543             $discussion = $forumgenerator->create_discussion($record);
544             $parentid = $DB->get_field('forum_posts', 'id', array('discussion' => $discussion->id), MUST_EXIST);
545             $sofar++;
546             for ($j = 0; $j < $posts - 1; $j++, $sofar++) {
547                 $record = array('discussion' => $discussion->id,
548                         'userid' => $this->get_target_user(), 'parent' => $parentid);
549                 $forumgenerator->create_post($record);
550                 $this->dot($sofar, $totalposts);
551             }
552         }
554         $this->end_log();
555     }
557     /**
558      * Gets a section number.
559      *
560      * Depends on $this->fixeddataset.
561      *
562      * @return int A section number from 1 to the number of sections
563      */
564     private function get_target_section() {
566         if (!$this->fixeddataset) {
567             $key = rand(1, self::$paramsections[$this->size]);
568         } else {
569             // Using section 1.
570             $key = 1;
571         }
573         return $key;
574     }
576     /**
577      * Gets a user id.
578      *
579      * Depends on $this->fixeddataset.
580      *
581      * @return int A user id for a random created user
582      */
583     private function get_target_user() {
585         if (!$this->fixeddataset) {
586             $userid = $this->userids[rand(1, self::$paramusers[$this->size])];
587         } else if ($userid = current($this->userids)) {
588             // Moving pointer to the next user.
589             next($this->userids);
590         } else {
591             // Returning to the beginning if we reached the end.
592             $userid = reset($this->userids);
593         }
595         return $userid;
596     }
598     /**
599      * Restricts the binary file size if necessary
600      *
601      * @param int $length The total length
602      * @return int The limited length if a limit was specified.
603      */
604     private function limit_filesize($length) {
606         // Limit to $this->filesizelimit.
607         if (is_numeric($this->filesizelimit) && $length > $this->filesizelimit) {
608             $length = floor($this->filesizelimit);
609         }
611         return $length;
612     }