<?php
// This file is part of Level Up XP.
//
// Level Up XP 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.
//
// Level Up XP 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 Level Up XP.  If not, see <https://www.gnu.org/licenses/>.
//
// https://levelup.plus

/**
 * Log controller.
 *
 * @package    block_xp
 * @copyright  2017 Frédéric Massart
 * @author     Frédéric Massart <fred@branchup.tech>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace block_xp\local\controller;

use block_xp\di;
use block_xp\local\routing\url;
use block_xp\output\log_table_filterset;
use core_table\local\filter\filterset;
use core_table\local\filter\string_filter;
use core_user;
use html_writer;

/**
 * Log controller class.
 *
 * @package    block_xp
 * @copyright  2017 Frédéric Massart
 * @author     Frédéric Massart <fred@branchup.tech>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class log_controller extends page_controller {

    /** @var string The nav name. */
    protected $navname = 'report';
    /** @var string The route name. */
    protected $routename = 'log';
    /** @var bool Whether is wide. */
    protected $iswideview = true;
    /** @var bool Whether supports groups. */
    protected $supportsgroups = true;

    /** @var bool Whether we're using an old XP+. */
    protected $isusingoldxpp = false;
    /** @var int|null The user ID to filter the logs for. Use {@see self::get_user_id} to obtain. */
    protected $userid = null;

    protected function permissions_checks() {
        $accessperms = $this->world->get_access_permissions();
        if (!($accessperms instanceof \block_xp\local\permission\access_logs_permissions)) {
            throw new \coding_exception('Access permissions object requires logs permissions.');
        }
        $accessperms->require_access_logs();
    }

    protected function define_optional_params() {
        return [
            ['userid', null, PARAM_INT],
            ['term', null, PARAM_NOTAGS],
        ];
    }

    protected function post_login() {
        parent::post_login();

        $addon = di::get('addon');
        $this->isusingoldxpp = $addon->is_older_than(2024090500);
    }

    protected function get_table() {
        $table = new \block_xp\output\logs_table(
            $this->world,
            di::get('reason_from_log_entry_factory'),
            $this->get_groupid(),
            $this->get_user_id()
        );
        $table->define_baseurl($this->pageurl);
        $table->set_filterset($this->get_filterset());
        return $table;
    }

    /**
     * Get the filterset.
     *
     * @return filterset|null
     */
    protected function get_filterset(): ?filterset {
        $filterset = new log_table_filterset();
        if ($this->get_user_id()) {
            return $filterset;
        }
        if ($term = $this->get_param('term')) {
            $filterset->add_filter(new string_filter('term', null, [$term]));
        }
        return $filterset;
    }

    protected function get_page_html_head_title() {
        return get_string('courselog', 'block_xp');
    }

    protected function get_page_heading() {
        return get_string('courselog', 'block_xp');
    }

    /**
     * Get the user ID to display the logs for.
     *
     * @return int When falsy, no users or the user is invalid.
     */
    protected function get_user_id() {
        if ($this->userid === null) {
            $userid = $this->get_param('userid');
            if (!$userid || $userid <= 0 || isguestuser($userid)) {
                $userid = 0;
            }
            $this->userid = $userid;
        }
        return $this->userid;
    }

    protected function get_dismissable_filters() {
        $userid = $this->get_user_id();
        if (!$userid) {
            return;
        }

        $allusers = new url($this->pageurl);
        $allusers->remove_params('userid');
        $user = core_user::get_user($userid, '*', MUST_EXIST);
        return [
            [
                'label' => get_string('resultsfilteredforn', 'block_xp', fullname($user)),
                'removeurl' => $allusers,
            ],
        ];
    }

    protected function page_advanced_heading() {
        $output = $this->get_renderer();
        echo $output->advanced_heading(get_string('courselog', 'block_xp'), [
            'intro' => new \lang_string('courselogintro', 'block_xp'),
            'menu' => $this->get_page_menu_items(),
        ]);
    }

    protected function page_content() {
        global $PAGE;

        $userid = $this->get_user_id();
        $singleuser = (bool) $userid;

        $this->page_advanced_heading();

        if (!$singleuser) {
            $this->print_group_menu();
        }

        // Display the user filter.
        $this->page_user_filter();

        // Display the active dismissable filters.
        $this->page_dismissable_filters();

        // Displaying the report.
        echo html_writer::start_div('xp-cancel-overflow');
        echo $this->get_table()->out(50, !$singleuser && $this->isusingoldxpp);
        echo html_writer::end_div();
    }

    protected function page_dismissable_filters() {
        $dismissablefilters = $this->get_dismissable_filters();
        if (!$dismissablefilters) {
            return;
        }

        echo html_writer::start_tag('p');
        echo implode('<br>', array_map(function ($filter) {
            return s($filter['label'])
                . ' ' . html_writer::link($filter['removeurl'], get_string('removefilter', 'block_xp'));
        }, $dismissablefilters));
        echo html_writer::end_tag('p');
    }

    protected function page_user_filter() {
        if ($this->isusingoldxpp || $this->get_user_id()) {
            return null;
        }

        $formfields = [];
        foreach ($this->pageurl->params() as $name => $value) {
            if ($name === 'term') {
                continue;
            }
            $formfields[] = ['name' => $name, 'value' => $value];
        }

        echo $this->get_renderer()->render_from_template('block_xp/table/report-filters', [
            'term' => $this->get_param('term'),
            'action' => $this->pageurl->out(false),
            'hiddenfields' => $formfields,
        ]);
    }

    /**
     * Get the menu items for the page.
     *
     * @return array
     */
    protected function get_page_menu_items() {
        $config = di::get('config');
        $hasaddon = di::get('addon')->is_activated();
        return array_filter([
            $config->get('enablepromoincourses') && !$hasaddon ? [
                'label' => get_string('exportdata', 'block_xp'),
                'href' => '#',
                'disabled' => true,
                'addonrequired' => true,
            ] : null,
        ]);
    }

}
