Proyectos de Subversion Moodle

<?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/>.

namespace core_cache\output;

use context;

use core_cache\factory as cache_factory;

use core_cache\store as cache_store;

use core_collator;

use html_table;

use html_table_cell;

use html_table_row;

use html_writer;

use lang_string;

use moodle_url;

use single_select;

/**

 * The cache renderer (mainly admin interfaces).

 *

 * @package    core_cache

 * @copyright  2012 Sam Hemelryk

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class renderer extends \plugin_renderer_base {

    /**

     * Displays store summaries.

     *

     * @param array $storeinstancesummaries information about each store instance,

     *      as returned by core_cache\administration_helper::get_store_instance_summaries().

     * @param array $storepluginsummaries information about each store plugin as

     *      returned by core_cache\administration_helper::get_store_plugin_summaries().

     * @return string HTML

     */

    public function store_instance_summariers(array $storeinstancesummaries, array $storepluginsummaries) {

        $table = new html_table();

        $table->head = [

            get_string('storename', 'cache'),

            get_string('plugin', 'cache'),

            get_string('storeready', 'cache'),

            get_string('mappings', 'cache'),

            get_string('modes', 'cache'),

            get_string('supports', 'cache'),

            get_string('locking', 'cache') . ' ' . $this->output->help_icon('locking', 'cache'),

            get_string('actions', 'cache'),

        ];

        $table->colclasses = [

            'storename',

            'plugin',

            'storeready',

            'mappings',

            'modes',

            'supports',

            'locking',

            'actions',

        ];

        $table->data = [];

        $defaultstoreactions = get_string('defaultstoreactions', 'cache');

        foreach ($storeinstancesummaries as $name => $storesummary) {

            $htmlactions = cache_factory::get_administration_display_helper()->get_store_instance_actions($name, $storesummary);

            $modes = [];

            foreach ($storesummary['modes'] as $mode => $enabled) {

                if ($enabled) {

                    $modes[] = get_string('mode_' . $mode, 'cache');

                }

            }

            $supports = [];

            foreach ($storesummary['supports'] as $support => $enabled) {

                if ($enabled) {

                    $supports[] = get_string('supports_' . $support, 'cache');

                }

            }

            $info = '';

            if (!empty($storesummary['default'])) {

                $info = $this->output->pix_icon('i/info', $defaultstoreactions, '', ['class' => 'icon']);

            }

            $isready = $storesummary['isready'] && $storesummary['requirementsmet'];

            $readycell = new html_table_cell();

            if ($isready) {

                $readycell->text = $this->output->pix_icon('i/valid', '1');

            }

            $storename = $storesummary['name'];

            if (!empty($storesummary['default'])) {

                $storename = get_string('store_' . $storesummary['name'], 'cache');

            }

            if (!$isready && (int)$storesummary['mappings'] > 0) {

                $readycell->text = $this->output->help_icon('storerequiresattention', 'cache');

                $readycell->attributes['class'] = 'store-requires-attention';

            }

            $lock = $storesummary['lock']['name'];

            if (!empty($storesummary['lock']['default'])) {

                $lock = get_string($storesummary['lock']['name'], 'cache');

            }

            $row = new html_table_row([

                $storename,

                get_string('pluginname', 'cachestore_' . $storesummary['plugin']),

                $readycell,

                $storesummary['mappings'],

                join(', ', $modes),

                join(', ', $supports),

                $lock,

                $info . join(', ', $htmlactions),

            ]);

            $row->attributes['class'] = 'store-' . $name;

            if ($storesummary['default']) {

                $row->attributes['class'] .= ' default-store';

            }

            $table->data[] = $row;

        }

        $html  = html_writer::start_tag('div', ['id' => 'core-cache-store-summaries']);

        $html .= $this->output->heading(get_string('storesummaries', 'cache'), 3);

        $html .= html_writer::table($table);

        $html .= html_writer::end_tag('div');

        return $html;

    }

    /**

     * Displays plugin summaries.

     *

     * @param array $storepluginsummaries information about each store plugin as

     *      returned by core_cache\administration_helper::get_store_plugin_summaries().

     * @return string HTML

     */

    public function store_plugin_summaries(array $storepluginsummaries) {

        $table = new html_table();

        $table->head = [

            get_string('plugin', 'cache'),

            get_string('storeready', 'cache'),

            get_string('stores', 'cache'),

            get_string('modes', 'cache'),

            get_string('supports', 'cache'),

            get_string('actions', 'cache'),

        ];

        $table->colclasses = [

            'plugin',

            'storeready',

            'stores',

            'modes',

            'supports',

            'actions',

        ];

        $table->data = [];

        foreach ($storepluginsummaries as $name => $plugin) {

            $htmlactions = cache_factory::get_administration_display_helper()->get_store_plugin_actions($name, $plugin);

            $modes = [];

            foreach ($plugin['modes'] as $mode => $enabled) {

                if ($enabled) {

                    $modes[] = get_string('mode_' . $mode, 'cache');

                }

            }

            $supports = [];

            foreach ($plugin['supports'] as $support => $enabled) {

                if ($enabled) {

                    $supports[] = get_string('supports_' . $support, 'cache');

                }

            }

            $row = new html_table_row([

                $plugin['name'],

                ($plugin['requirementsmet']) ? $this->output->pix_icon('i/valid', '1') : '',

                $plugin['instances'],

                join(', ', $modes),

                join(', ', $supports),

                join(', ', $htmlactions),

            ]);

            $row->attributes['class'] = 'plugin-' . $name;

            $table->data[] = $row;

        }

        $html  = html_writer::start_tag('div', ['id' => 'core-cache-plugin-summaries']);

        $html .= $this->output->heading(get_string('pluginsummaries', 'cache'), 3);

        $html .= html_writer::table($table);

        $html .= html_writer::end_tag('div');

        return $html;

    }

    /**

     * Displays definition summaries.

     *

     * @param array $definitionsummaries information about each definition, as returned by

     *      core_cache\administration_helper::get_definition_summaries().

     * @param context $context the system context.

     *

     * @return string HTML.

     */

    public function definition_summaries(array $definitionsummaries, context $context) {

        $table = new html_table();

        $table->head = [

            get_string('definition', 'cache'),

            get_string('mode', 'cache'),

            get_string('component', 'cache'),

            get_string('area', 'cache'),

            get_string('mappings', 'cache'),

            get_string('sharing', 'cache'),

            get_string('canuselocalstore', 'cache'),

            get_string('actions', 'cache'),

        ];

        $table->colclasses = [

            'definition',

            'mode',

            'component',

            'area',

            'mappings',

            'sharing',

            'canuselocalstore',

            'actions',

        ];

        $table->data = [];

        core_collator::asort_array_of_arrays_by_key($definitionsummaries, 'name');

        $none = new lang_string('none', 'cache');

        foreach ($definitionsummaries as $id => $definition) {

            $htmlactions = cache_factory::get_administration_display_helper()->get_definition_actions($context, $definition);

            if (!empty($definition['mappings'])) {

                $mapping = join(', ', $definition['mappings']);

            } else {

                $mapping = '<em>' . $none . '</em>';

            }

            $uselocalcachecol = get_string('no');

            if ($definition['mode'] != cache_store::MODE_REQUEST) {

                if (isset($definition['canuselocalstore']) && $definition['canuselocalstore']) {

                    $uselocalcachecol = get_string('yes');

                }

            }

            $row = new html_table_row([

                $definition['name'],

                get_string('mode_' . $definition['mode'], 'cache'),

                $definition['component'],

                $definition['area'],

                $mapping,

                join(', ', $definition['selectedsharingoption']),

                $uselocalcachecol,

                join(', ', $htmlactions),

            ]);

            $row->attributes['class'] = 'definition-' . $definition['component'] . '-' . $definition['area'];

            $table->data[] = $row;

        }

        $html  = html_writer::start_tag('div', ['id' => 'core-cache-definition-summaries']);

        $html .= $this->output->heading(get_string('definitionsummaries', 'cache'), 3);

        $html .= html_writer::table($table);

        $url = new moodle_url('/cache/admin.php', ['action' => 'rescandefinitions', 'sesskey' => sesskey()]);

        $link = html_writer::link($url, get_string('rescandefinitions', 'cache'));

        $html .= html_writer::tag('div', $link, ['id' => 'core-cache-rescan-definitions']);

        $html .= html_writer::end_tag('div');

        return $html;

    }

    /**

     * Displays mode mappings

     *

     * @param string $applicationstore

     * @param string $sessionstore

     * @param string $requeststore

     * @param moodle_url $editurl

     * @return string HTML

     */

    public function mode_mappings($applicationstore, $sessionstore, $requeststore, moodle_url $editurl) {

        $table = new html_table();

        $table->colclasses = [

            'mode',

            'mapping',

        ];

        $table->rowclasses = [

            'mode_application',

            'mode_session',

            'mode_request',

        ];

        $table->head = [

            get_string('mode', 'cache'),

            get_string('mappings', 'cache'),

        ];

        $table->data = [

            [get_string('mode_' . cache_store::MODE_APPLICATION, 'cache'), $applicationstore],

            [get_string('mode_' . cache_store::MODE_SESSION, 'cache'), $sessionstore],

            [get_string('mode_' . cache_store::MODE_REQUEST, 'cache'), $requeststore],

        ];

        $html = html_writer::start_tag('div', ['id' => 'core-cache-mode-mappings']);

        $html .= $this->output->heading(get_string('defaultmappings', 'cache'), 3);

        $html .= html_writer::table($table);

        $link = html_writer::link($editurl, get_string('editmappings', 'cache'));

        $html .= html_writer::tag('div', $link, ['class' => 'edit-link']);

        $html .= html_writer::end_tag('div');

        return $html;

    }

    /**

     * Display basic information about lock instances.

     *

     * @todo Add some actions so that people can configure lock instances.

     *

     * @param array $locks

     * @return string

     */

    public function lock_summaries(array $locks) {

        $table = new html_table();

        $table->colclasses = [

            'name',

            'type',

            'default',

            'uses',

            'actions',

        ];

        $table->rowclasses = [

            'lock_name',

            'lock_type',

            'lock_default',

            'lock_uses',

            'lock_actions',

        ];

        $table->head = [

            get_string('lockname', 'cache'),

            get_string('locktype', 'cache'),

            get_string('lockdefault', 'cache'),

            get_string('lockuses', 'cache'),

            get_string('actions', 'cache'),

        ];

        $table->data = [];

        $tick = $this->output->pix_icon('i/valid', '');

        foreach ($locks as $lock) {

            $actions = [];

            if ($lock['uses'] === 0 && !$lock['default']) {

                $url = new moodle_url('/cache/admin.php', ['lock' => $lock['name'], 'action' => 'deletelock']);

                $actions[] = html_writer::link($url, get_string('delete', 'cache'));

            }

            $table->data[] = new html_table_row([

                new html_table_cell($lock['name']),

                new html_table_cell($lock['type']),

                new html_table_cell($lock['default'] ? $tick : ''),

                new html_table_cell($lock['uses']),

                new html_table_cell(join(' ', $actions)),

            ]);

        }

        $html = html_writer::start_tag('div', ['id' => 'core-cache-lock-summary']);

        $html .= $this->output->heading(get_string('locksummary', 'cache'), 3);

        $html .= html_writer::table($table);

        $html .= html_writer::end_tag('div');

        return $html;

    }

    /**

     * Renders additional actions for locks, such as Add.

     *

     * @return string

     */

    public function additional_lock_actions(): string {

        $url = new moodle_url('/cache/admin.php', ['action' => 'newlockinstance']);

        $select = new single_select($url, 'lock', cache_factory::get_administration_display_helper()->get_addable_lock_options());

        $select->label = get_string('addnewlockinstance', 'cache');

        $html = html_writer::start_tag('div', ['id' => 'core-cache-lock-additional-actions']);

        $html .= html_writer::tag('div', $this->output->render($select), ['class' => 'new-instance']);

        $html .= html_writer::end_tag('div');

        return $html;

    }

    /**

     * Renders an array of notifications for the cache configuration screen.

     *

     * Takes an array of notifications with the form:

     * $notifications = array(

     *     array('This is a success message', true),

     *     array('This is a failure message', false),

     * );

     *

     * @param array $notifications

     * @return string

     */

    public function notifications(array $notifications = []) {

        if (count($notifications) === 0) {

            // There are no notifications to render.

            return '';

        }

        $html = html_writer::start_div('notifications');

        foreach ($notifications as $notification) {

            [$message, $notifysuccess] = $notification;

            $html .= $this->notification($message, ($notifysuccess) ? 'notifysuccess' : 'notifyproblem');

        }

        $html .= html_writer::end_div();

        return $html;

    }

    /**

     * Creates the two tables which display on the usage page.

     *

     * @param array $usage Usage information (from \core_cache\helper::usage)

     * @return array Array of 2 tables (main and summary table)

     * @throws \coding_exception

     */

    public function usage_tables(array $usage): array {

        $table = new \html_table();

        $table->id = 'usage_main';

        $table->head = [

            get_string('definition', 'cache'),

            get_string('storename', 'cache'),

            get_string('plugin', 'cache'),

            get_string('usage_items', 'cache'),

            get_string('usage_mean', 'cache'),

            get_string('usage_sd', 'cache'),

            get_string('usage_total', 'cache'),

            get_string('usage_totalmargin', 'cache'), ];

        $table->align = [

            'left', 'left', 'left',

            'right', 'right', 'right', 'right', 'right',

        ];

        $table->data = [];

        $summarytable = new \html_table();

        $summarytable->id = 'usage_summary';

        $summarytable->head = [

            get_string('storename', 'cache'),

            get_string('plugin', 'cache'),

            get_string('usage_total', 'cache'),

            get_string('usage_realtotal', 'cache'),

        ];

        $summarytable->align = [

            'left', 'left',

            'right', 'right',

        ];

        $summarytable->data = [];

        $summarytable->attributes['class'] = 'generaltable w-auto';

        $storetotals = [];

        // We will highlight all cells that are more than 2% of total size, so work that out first.

        $total = 0;

        foreach ($usage as $definition) {

            foreach ($definition->stores as $storedata) {

                $total += $storedata->items * $storedata->mean;

            }

        }

        $highlightover = round($total / 50);

        foreach ($usage as $definition) {

            foreach ($definition->stores as $storedata) {

                $row = [];

                $row[] = s($definition->cacheid);

                $row[] = s($storedata->name);

                $row[] = s($storedata->class);

                if (!$storedata->supported) {

                    // We don't have data for this store because it isn't searchable.

                    $row[] = '-';

                } else {

                    $row[] = $storedata->items;

                }

                if ($storedata->items) {

                    $row[] = display_size(round($storedata->mean));

                    if ($storedata->items > 1) {

                        $row[] = display_size(round($storedata->sd));

                    } else {

                        $row[] = '';

                    }

                    $cellsize = round($storedata->items * $storedata->mean);

                    $row[] = display_size($cellsize, 1, 'MB');

                    if (!array_key_exists($storedata->name, $storetotals)) {

                        $storetotals[$storedata->name] = (object)[

                            'plugin' => $storedata->class,

                            'total' => 0,

                            'storetotal' => $storedata->storetotal,

                        ];

                    }

                    $storetotals[$storedata->name]->total += $cellsize;

                } else {

                    $row[] = '';

                    $row[] = '';

                    $cellsize = 0;

                    $row[] = '';

                }

                if ($storedata->margin) {

                    // Plus or minus.

                    $row[] = '±' . display_size($storedata->margin * $storedata->items, 1, 'MB');

                } else {

                    $row[] = '';

                }

                $htmlrow = new \html_table_row($row);

                if ($cellsize > $highlightover) {

                    $htmlrow->attributes = ['class' => 'table-warning'];

                }

                $table->data[] = $htmlrow;

            }

        }

        ksort($storetotals);

        foreach ($storetotals as $storename => $storedetails) {

            $row = [s($storename), s($storedetails->plugin)];

            $row[] = display_size($storedetails->total, 1, 'MB');

            if ($storedetails->storetotal !== null) {

                $row[] = display_size($storedetails->storetotal, 1, 'MB');

            } else {

                $row[] = '-';

            }

            $summarytable->data[] = $row;

        }

        return [$table, $summarytable];

    }

    /**

     * Renders the usage page.

     *

     * @param \html_table $maintable Main table

     * @param \html_table $summarytable Summary table

     * @param \moodleform $samplesform Form to select number of samples

     * @return string HTML for page

     */

    public function usage_page(\html_table $maintable, \html_table $summarytable, \moodleform $samplesform): string {

        $data = [

            'maintable' => \html_writer::table($maintable),

            'summarytable' => \html_writer::table($summarytable),

            'samplesform' => $samplesform->render(),

        ];

        return $this->render_from_template('core_cache/usage', $data);

    }

}