renderer.php

<?php
/**
 * Open LMS framework
 *
 * This program 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.
 *
 * This program 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 this program.  If not, see http://opensource.org/licenses/gpl-3.0.html.
 *
 * @copyright Copyright (c) 2009 Open LMS (https://www.openlms.net)
 * @license http://opensource.org/licenses/gpl-3.0.html GNU Public License
 * @package mr
 * @author Mark Nielsen
 */

defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');

/**
 * @see mr_html_tag
 */
require_once($CFG->dirroot.'/local/mr/framework/html/tag.php');

/**
 * MR Renderer
 *
 * Default renderer for the framework.
 *
 * @package mr
 * @author Mark Nielsen
 */
class local_mr_renderer extends plugin_renderer_base {
    /**
     * Returns rendered widget.
     *
     * Add another error catching layer for
     * rendering reports.
     *
     * @param renderable $widget instance with renderable interface
     * @return string
     */
    public function render(renderable $widget) {
        try {
            return parent::render($widget);
        } catch (coding_exception $e) {
            if ($widget instanceof mr_report_abstract) {
                return $this->render_mr_report_abstract($widget);
            }
            // Re-throw original error
            throw $e;
        }
    }

    /**
     * Renders mr_html_notify
     *
     * @param mr_html_notify $notify mr_html_notify instance
     * @return string
     */
    protected function render_mr_html_notify(mr_html_notify $notify) {
        $output = '';
        foreach($notify->get_messages() as $message) {
            $output .= $this->output->notification($message[0], $message[1]);
        }
        return $output;
    }

    /**
     * Renders mr_html_tabs
     *
     * @param mr_html_tabs $tabs mr_html_tabs instance
     * @return string
     */
    protected function render_mr_html_tabs(mr_html_tabs $tabs) {
        $rows   = $tabs->get_rows();
        $output = '';

        if (!empty($rows)) {
            $inactive = $active = array();

            if (count($rows) == 2 and !empty($tabs->subtab) and !empty($rows[1][$tabs->subtab])) {
                $active[]   = $tabs->toptab;
                $currenttab = $tabs->subtab;
            } else {
                $currenttab = $tabs->toptab;
            }
            $output = html_writer::tag('div', print_tabs($rows, $currenttab, $inactive, $active, true), array('class' => 'mr_html_tabs'));
        }
        return $output;
    }

    /**
     * Render mr_html_heading
     *
     * @param mr_html_heading $heading mr_html_heading instance
     * @return string
     */
    protected function render_mr_html_heading(mr_html_heading $heading) {
        // Do we have anything to render?
        if (empty($heading->text)) {
            return '';
        }

        $icon = '';
        if (!empty($heading->icon)) {
            $icon = $this->output->pix_icon($heading->icon, $heading->iconalt, $heading->component, array('class'=>'icon'));
        }
        $help = '';
        if (!empty($heading->helpidentifier)) {
            $help = $this->output->help_icon($heading->helpidentifier, $heading->component);
        }
        return html_writer::tag('div', $this->output->heading($icon.$heading->text.$help, $heading->level, $heading->classes, $heading->id), array('class' => 'mr_html_heading'));
    }

    /**
     * Render mr_html_filter
     *
     * @param mr_html_filter $filter mr_html_filter instance
     * @return string
     */
    protected function render_mr_html_filter(mr_html_filter $filter) {
        // Only render the filter form if one of the filters is not hidden
        foreach ($filter->get_filters() as $mrfilter) {
            if (!$mrfilter instanceof mr_html_filter_hidden) {
                return html_writer::tag('div', $filter->init()->get_helper()->buffer(array($filter->get_mform(), 'display')), array('class' => 'mr_html_filter'));
            }
        }
        return '';
    }

    /**
     * Render mr_html_paging
     *
     * @param mr_html_paging $paging mr_html_paging instance
     * @return string
     */
    public function render_mr_html_paging(mr_html_paging $paging) {
        $output = '';
        if ($paging->get_perpage()) {
            $output = $this->output->paging_bar($paging->get_total(), $paging->get_page(), $paging->get_perpage(), $paging->get_url(), $paging->REQUEST_PAGE);
        }
        if ($paging->get_perpageopts()) {
            $options = array();
            foreach ($paging->get_perpageopts() as $opt) {
                if ($opt == 'all') {
                    $options[10000] = get_string('all');
                } else {
                    $options[$opt] = $opt;
                }
            }
            $singleselect = new single_select($paging->get_url(), $paging->REQUEST_PERPAGE, $options, $paging->get_perpage(), array());
            $singleselect->set_label(get_string('rowsperpage', 'local_mr'), array('class' => 'accesshide'));

            $select = $this->output->render($singleselect);

            // Attempt to place it within the paging bar's div
            if (substr($output, strlen($output)-6) == '</div>') {
                $output = substr($output, 0, -6)."$select</div>";
            } else {
                $output .= $this->output->box($select, 'paging');
            }
            $output = html_writer::tag('div', $output, array('class' => 'mr_html_paging'));
        }
        return $output;
    }

    /**
     * Render mr_html_table
     *
     * @param mr_html_table $table mr_html_table instance
     * @return string
     */
    protected function render_mr_html_table(mr_html_table $table) {
        $tag     = new mr_html_tag();
        $rows    = $table->get_rows();
        $columns = $table->get_columns(true);

        // Table setup
        $htmltable       = new html_table();
        $htmltable->data = array();

        foreach ($table->get_attributes() as $name => $value) {
            if (property_exists($htmltable, $name)) {
                $htmltable->$name = $value;
            } else {
                $htmltable->attributes[$name] = $value;
            }
        }

        // Check if we have any column headings
        $haveheadings = false;
        foreach ($columns as $column) {
            if ($column->has_heading()) {
                $haveheadings = true;
                break;
            }
        }
        if ($haveheadings) {
            $htmltable->head = array();
            foreach ($columns as $column) {
                // Must set sortable to false if table is not sort enabled or if empty $rows
                if (!$table->get_sortenabled() or empty($rows)) {
                    $column->set_config('sortable', false);
                }
                $config = $column->get_config();

                // Figure out column sort controls
                if ($config->sortable) {
                    $icon    = '';
                    $sortstr = get_string('asc');
                    $sortord = SORT_ASC;

                    if ($table->get_sort() == $column->get_name()) {
                        if ($table->get_order() == SORT_ASC) {
                            $icon    = $tag->img()->src($this->output->image_url('t/down'))->alt(get_string('asc'));
                            $sortstr = get_string('asc');
                            $sortord = SORT_DESC;
                        } else {
                            $icon = $tag->img()->src($this->output->image_url('t/up'))->alt(get_string('desc'));
                        }
                    }
                    $url     = $table->get_url()->out(false, array('tsort' => $config->name, 'torder' => $sortord));
                    $heading = get_string('sortby').' '.$config->heading.' '.$sortstr;
                    $heading = $config->heading.get_accesshide($heading);
                    $heading = $tag->a($heading)->href($url).$icon;
                } else {
                    $heading = $config->heading;
                }
                $cell = new html_table_cell($heading);
                $cell->attributes = array_merge($cell->attributes, $config->attributes);

                $htmltable->head[] = $cell;
            }
        }

        if (empty($rows)) {
            $cell = new html_table_cell($table->get_emptymessage());
            $cell->colspan = count($htmltable->head ?? array());
            $htmltable->data[] = new html_table_row(array($cell));
        } else {
            $htmltable->data = $this->convert_to_htmlrows($table);
        }
        return html_writer::tag('div', html_writer::table($htmltable), array('class' => 'mr_html_table'));
    }

    /**
     * Render mr_file_export
     *
     * @param mr_file_export $export mr_file_export instance
     * @return string
     */
    protected function render_mr_file_export(mr_file_export $export) {
        $select = new url_select($export->get_url_select_options(), '');
        $select->set_label(get_string('export', 'local_mr'));

        return html_writer::tag('div', $this->output->render($select), array('class' => 'mr_file_export'));
    }

    /**
     * Render mr_report_abstract
     *
     * @param mr_report_abstract $report mr_report_abstract instance
     * @return string
     * @todo Render in heading with help button?
     */
    public function render_mr_report_abstract(mr_report_abstract $report) {
        // Send JSON if necessary
        $this->mr_html_table_json(
            $report->get_table(),
            $report->get_paging()
        );

        // Wrapper DIV
        $output = $this->output->box_start('boxwidthwide boxaligncenter mr_report');

        // Heading
        // $output .= $this->output->heading($report->name());

        // Render report SQL
        $output .= $this->help_render_mr_report_sql($report);

        // Render description
        if ($description = $report->get_description()) {
            $output .= $this->output->box($description, 'generalbox boxwidthnormal boxaligncenter mr_report_description');
        }

        // Render Hook
        $output .= $this->help_render_navigation_display($report);

        // Render filter
        if ($report->get_filter() instanceof mr_html_filter) {
            $output .= $this->render($report->get_filter());
        }

        // Render hook
        $output .= $this->help_render_chart_select($report);

        // Render as AJAX or our default rendering
        if ($report->get_config()->ajax and $report->get_preferences()->get('forceajax', $report->get_config()->ajaxdefault)) {
            $output .= $report->output_wrapper(
                $this->mr_html_table_ajax(
                    $report->get_table(),
                    $report->get_paging()
                )
            );
        } else {
            // Render paging top
            $output .= $this->render($report->get_paging());

            // Render table and allow report to wrap it with w/e
            $output .= $report->output_wrapper(
                $this->render($report->get_table())
            );

            // Render paging bottom
            $output .= $this->render($report->get_paging());
        }

        // Render export
        if ($report->get_export() instanceof mr_file_export) {
            $output .= $this->render($report->get_export());
        }

        // Render AJAX toggle link
        if ($report->get_config()->ajax) {
            if ($report->get_preferences()->get('forceajax', $report->get_config()->ajaxdefault)) {
                $newajax = 0;
                $label   = get_string('basichtml', 'local_mr');
            } else {
                $newajax = 1;
                $label   = get_string('standard', 'local_mr');
            }
            $url = clone($report->get_url());
            $url->param('forceajax', $newajax);

            $link = html_writer::link($url, $label, array('title' => $label));
            $output .= html_writer::tag('div', $link, array('class' => 'mr_ajax_table_forceajax'));
        }

        // Close wrapper DIV
        $output .= $this->output->box_end();

        return $output;
    }

    /**
     * Generate YUI view of table and paging
     *
     * @param mr_html_table $table Table instance
     * @param mr_html_paging $paging Paging instance
     * @param bool $autoload
     * @param null $id
     * @return string
     */
    public function mr_html_table_ajax(mr_html_table $table, mr_html_paging $paging, $autoload = true, $id = null) {
        global $PAGE;

        // Columns
        $columns = array();
        foreach ($table->get_columns(true) as $column) {
            // Must set sortable to false if table is not sort enabled or if empty $rows
            if (!$table->get_sortenabled()) {
                $column->set_config('sortable', false);
            }
            $col = (object) array(
                'key'      => $column->get_name(),
                'label'    => $column->get_config()->heading,
                'sortable' => $column->get_config()->sortable,
            );
            if ($column->get_config()->editor) {
                $col->editor = $column->get_config()->editor;
            }
            $columns[] = $col;
        }

        // Page size
        $opts = array();
        if ($paging->get_perpageopts()) {
            foreach ($paging->get_perpageopts() as $opt) {
                if ($opt == 'all') {
                    $opts[] = (object) array('value' => 10000, 'text' => get_string('all'));
                } else {
                    $opts[] = (object) array('value' => $opt, 'text' => $opt);
                }
            }
        }

        // Place holder div's ID
        if (empty($id)) {
            $id = html_writer::random_id();
        }

        $loadingmsg = $this->output->pix_icon('i/ajaxloader', get_string('loadingdotdotdot', 'local_mr')).
            '&nbsp;'.get_string('loadingdotdotdot', 'local_mr');

        $module    = array(
            'name'     => 'local_mr',
            'fullpath' => '/local/mr/renderer.js',
            'requires' => array(
                'yui2-yahoo',
                'yui2-dom',
                'yui2-event',
                'yui2-element',
                'yui2-paginator',
                'yui2-datasource',
                'yui2-json',
                'yui2-connection',
                'yui2-get',
                'yui2-dragdrop',
                'yui2-datatable',
                'moodle-local_mr-livelog',
            ),
            'strings' => array(
                array('tablesortedbydesc', 'local_mr'),
                array('tablesortedbyasc', 'local_mr'),
            )
        );

        // Change the URL to send PLD AJAX requests with `tjson: 1`.
        $url = $table->get_url();
        if ($url->get_path() === '/local/pld/view.php') {
            $url = new moodle_url('/local/pld/ajax.php', array('controller' => $url->get_param('controller'), 'courseid' => $url->get_param('courseid')));
        }
        $url = $url->out(false, array('tjson' => 1));

        $arguments = (object) array(
            'id'          => $id,
            'url'         => $url,
            'sort'        => $table->get_sort(),
            'order'       => $table->get_order(),
            'page'        => $paging->get_page(),
            'perpage'     => $paging->get_perpage(),
            'loadingmsg'  => $loadingmsg,
            'perpageopts' => $opts,
            'columns'     => $columns,
            'asc'         => SORT_ASC,
            'desc'        => SORT_DESC,
            'autoload'    => $autoload,
        );

        if (!is_null($table->get_summary())) {
            $arguments->summary = $table->get_summary();
        }
        if (!empty($table->caption)) {
            $arguments->caption = $table->caption;
        }
        $PAGE->requires->js_init_call('M.local_mr.init_mr_html_table', array($arguments), false, $module);
        $PAGE->requires->strings_for_js(
            array(
                'paginatorfirstlabel',
                'paginatorfirsttitle',
                'paginatorlastlabel',
                'paginatorlasttitle',
                'paginatorprevlabel',
                'paginatorprevtitle',
                'paginatornextlabel',
                'paginatornexttitle',
            ), 'local_mr');

        return html_writer::tag('div', '', array('id' => $id, 'class' => 'mr_html_table mr_ajax_table'));
    }

    /**
     * Generate table rows as JSON
     *
     * @param mr_html_table $table Table instance
     * @param mr_html_paging $paging Paging instance
     * @return void
     * @todo Make this not a hack?
     */
    public function mr_html_table_json(mr_html_table $table, mr_html_paging $paging) {
        if (optional_param('tjson', 0, PARAM_BOOL)) {
            $json                  = new stdClass;
            $json->recordsReturned = (int) count($table->get_rows());
            $json->totalRecords    = (int) $paging->get_total();
            $json->startIndex      = (int) $paging->get_page();
            $json->sort            = $table->get_sort();
            $json->pageSize        = (int) $paging->get_perpage();
            $json->records         = array();
            $json->emptyMessage    = $table->get_emptymessage();

            if ($table->get_order() == SORT_ASC) {
                $json->dir = 'asc';
            } else {
                $json->dir = 'desc';
            }
            // If we are returning 0 records, we probably don't have any at all
            if ($json->recordsReturned == 0) {
                $json->totalRecords = 0;
            }

            $columns  = $table->get_columns(true);
            $htmlrows = $this->convert_to_htmlrows($table);
            foreach ($htmlrows as $htmlrow) {
                $position = 0;
                foreach ($columns as $column) {
                    if (array_key_exists($position, $htmlrow->cells)) {
                        $value = $htmlrow->cells[$position]->text;
                    } else {
                        $value = '';
                    }
                    $record[$column->get_name()] = $value;
                    $position++;
                }
                $json->records[] = (object) $record;
            }
            echo json_encode($json);
            die;
        }
    }

    /**
     * Hook for blocks/reports
     *
     * @param mr_report_abstract
     * @return string
     */
    protected function help_render_navigation_display(mr_report_abstract $report) {
        return '';
    }

    /**
     * Hook for blocks/reports
     *
     * @param mr_report_abstract
     * @return string
     */
    protected function help_render_chart_select(mr_report_abstract $report) {
        return '';
    }

    /**
     * Help render mr_report_abstract SQL
     *
     * @param mr_report_abstract $report mr_report_abstract instance
     * @return string
     */
    public function help_render_mr_report_sql(mr_report_abstract $report) {
        global $CFG, $USER;

        $output      = '';
        $executedsql = $report->get_executedsql();
        $usernames   = array('mrsupport', 'mrdev');
        if (!empty($CFG->reportviewsql) and is_array($CFG->reportviewsql)) {
            $usernames = array_merge($usernames, $CFG->reportviewsql);
        }
        if (in_array($USER->username, $usernames) and !empty($executedsql)) {
            $sql = '';
            foreach ($executedsql as $values) {
                list($rawsql, $params) = $values;
                $rawsql = trim($rawsql);

                $sql .= s($rawsql)."\n\n";
                if (!is_null($params)) {
                    $sql .= s(var_export($params, true))."\n\n\n";
                }
            }
            $output  = print_collapsible_region(
                $this->output->box('<pre>'.trim($sql).'</pre>', ''),
                'generalbox mr_report_sql',
                'mr_report_sql_id',
                get_string('reportsql', 'local_mr'),
                'mr_report_sql_toggle',
                false,
                true
            );
        }
        return $output;
    }

    /**
     * Convert a mr_html_table into an array of html_table_row instances
     *
     * @param mr_html_table $table Instance
     * @return array
     */
    protected function convert_to_htmlrows(mr_html_table $table) {
        $rows     = $table->get_rows();
        $columns  = $table->get_columns(true);
        $suppress = array();
        $htmlrows = array();
        foreach ($rows as $row) {
            // Generate a html_table_row
            if ($row instanceof html_table_row) {
                $htmlrow = $row;
            } else {
                $htmlrow = new html_table_row();
                foreach ($columns as $column) {
                    $cell = $column->get_cell($row);

                    if ($cell instanceof html_table_cell) {
                        $htmlrow->cells[] = $cell;
                    } else {
                        $cell = new html_table_cell($cell);
                        foreach ($column->get_config()->attributes as $name => $value) {
                            if (property_exists($cell, $name)) {
                                $cell->$name = $value;
                            } else {
                                $cell->attributes[$name] = $value;
                            }
                        }
                        $htmlrow->cells[] = $cell;
                    }
                }
            }

            // Apply column suppression to the row
            $position = -1;
            foreach ($columns as $column) {
                $position++;

                if (!$column->get_config()->suppress or !array_key_exists($position, $htmlrow->cells)) {
                    continue;
                }
                $cell = $htmlrow->cells[$position];

                if (isset($suppress[$position]) and $suppress[$position] == $cell->text) {
                    $htmlrow->cells[$position]->text = '';  // Suppressed
                } else {
                    // If a cell changes, reset suppression for all cells after it (left to right)
                    if (isset($suppress[$position]) and $suppress[$position] != $cell->text) {
                        foreach ($suppress as $key => $value) {
                            if ($key > $position) {
                                unset($suppress[$key]);
                            }
                        }
                    }
                    $suppress[$position] = $cell->text;
                }
            }
            $htmlrows[] = $htmlrow;
        }
        return $htmlrows;
    }
}