lib.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Interface for the subplugintype step
 * It has to be implemented by all subplugins.
 *
 * @package tool_cleanupcourses_step
 * @subpackage email
 * @copyright  2017 Tobias Reischmann WWU
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
namespace tool_cleanupcourses\step;

use tool_cleanupcourses\manager\settings_manager;
use tool_cleanupcourses\response\step_response;
use tool_cleanupcourses\manager\step_manager;

defined('MOODLE_INTERNAL') || die();

require_once(__DIR__ . '/../lib.php');

class email extends libbase {


    /**
     * Processes the course and returns a repsonse.
     * The response tells either
     *  - that the subplugin is finished processing.
     *  - that the subplugin is not yet finished processing.
     *  - that a rollback for this course is necessary.
     * @param int $instanceid of the step instance.
     * @param mixed $course to be processed.
     * @return step_response
     */
    public function process_course($instanceid, $course) {
        global $DB;
        $coursecontext = \context_course::instance($course->id);
        $userstobeinformed = get_users_by_capability($coursecontext, 'cleanupcoursesstep/email:preventdeletion');
        foreach ($userstobeinformed as $user) {
            $record = new \stdClass();
            $record->touser = $user->id;
            $record->courseid = $course->id;
            $record->instanceid = $instanceid;
            $DB->insert_record('cleanupcoursesstep_email', $record);
        }
        return step_response::waiting();
    }

    public function process_waiting_course($instanceid, $course) {
        return step_response::waiting();
    }

    public function post_processing_bulk_operation() {
        global $DB;
        $stepinstances = step_manager::get_step_instances_by_subpluginname($this->get_subpluginname());
        foreach ($stepinstances as $step) {
            $settings = settings_manager::get_settings($step->id);
            // Format the raw string in the DB to FORMAT_HTML.
            $settings['contenthtml'] = format_text($settings['contenthtml'], FORMAT_HTML);

            $userstobeinformed = $DB->get_records('cleanupcoursesstep_email',
                array('instanceid' => $step->id), '', 'distinct touser');
            foreach ($userstobeinformed as $userrecord) {
                $user = \core_user::get_user($userrecord->touser);
                $transaction = $DB->start_delegated_transaction();
                $mailentries = $DB->get_records('cleanupcoursesstep_email',
                    array('instanceid' => $step->id,
                        'touser' => $user->id));

                $parsedsettings = $this->replace_placeholders($settings, $user);

                $subject = $parsedsettings['subject'];
                $content = $parsedsettings['content'];
                $contenthtml = $parsedsettings['contenthtml'];
                // TODO: use course info to parse content template!
                email_to_user($user, \core_user::get_noreply_user(), $subject, $content, $contenthtml);
                $DB->delete_records('cleanupcoursesstep_email',
                    array('instanceid' => $step->id,
                        'touser' => $user->id));
                $transaction->allow_commit();
            }
        }

    }

    /**
     * Replaces certain placeholders within the mail template.
     * @param string[] $strings array of mail templates.
     * @param mixed $user user object
     * @return string[] array of mail text.
     */
    private function replace_placeholders($strings, $user) {

        $patterns = array();
        $replacements = array();

        $patterns [] = '##firstname##';
        $replacements [] = $user->firstname;

        $patterns [] = '##lastname##';
        $replacements [] = $user->lastname;

        return str_ireplace($patterns, $replacements, $strings);
    }

    public function instance_settings() {
        return array(
            new instance_setting('subject', PARAM_TEXT),
            new instance_setting('content', PARAM_RAW),
            new instance_setting('contenthtml', PARAM_RAW),
        );
    }

    public function get_subpluginname() {
        return 'email';
    }

    public function extend_add_instance_form_definition($mform) {
        $elementname = 'subject';
        $mform->addElement('text', $elementname, get_string('email_subject', 'cleanupcoursesstep_email'));
        $mform->setType($elementname, PARAM_TEXT);

        $elementname = 'content';
        $mform->addElement('textarea', $elementname, get_string('email_content', 'cleanupcoursesstep_email'));
        $mform->setType($elementname, PARAM_TEXT);

        $elementname = 'contenthtml';
        $mform->addElement('editor', $elementname, get_string('email_content_html', 'cleanupcoursesstep_email'));
        $mform->setType($elementname, PARAM_RAW);
    }

    public function extend_add_instance_form_definition_after_data($mform, $settings) {
        $mform->setDefault('contenthtml', array('text' => $settings['contenthtml'], 'format' => FORMAT_HTML));
    }
}