[Summary view]

Differences Between: [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]

   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/>.
  16  
  17  declare(strict_types=1);
  18  
  19  namespace core_reportbuilder\local\systemreports;
  20  
  21  use core_reportbuilder\local\models\audience;
  22  use core_reportbuilder\local\models\report;
  23  use core_reportbuilder\permission;
  24  use core_reportbuilder\system_report;
  25  use core_reportbuilder\local\entities\user;
  26  use core_reportbuilder\local\helpers\audience as audience_helper;
  27  
  28  /**
  29   * Report access list
  30   *
  31   * @package     core_reportbuilder
  32   * @copyright   2021 David Matamoros <davidmc@moodle.com>
  33   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class report_access_list extends system_report {
  36  
  37      /**
  38       * Initialise the report
  39       */
  40      protected function initialise(): void {
  41          $userentity = new user();
  42          $userentityalias = $userentity->get_table_alias('user');
  43          $this->set_main_table('user', $userentityalias);
  44          $this->add_entity($userentity);
  45  
  46          $reportid = $this->get_parameter('id', 0, PARAM_INT);
  47  
  48          // Find users allowed to view the report thru the report audiences.
  49          [$wheres, $params] = self::get_users_by_audience_sql($reportid, $userentityalias);
  50  
  51          if (!empty($wheres)) {
  52              // Wrap each OR condition into brackets.
  53              $allwheres = '(' . implode(') OR (', $wheres) . ')';
  54          } else {
  55              $allwheres = "1=0";
  56          }
  57  
  58          $this->add_base_condition_sql("($allwheres)", $params);
  59  
  60          $this->add_column_from_entity('user:fullnamewithpicturelink');
  61          $this->add_filter_from_entity('user:fullname');
  62          $this->set_downloadable(false);
  63      }
  64  
  65      /**
  66       * Ensure we can view the report
  67       *
  68       * @return bool
  69       */
  70      protected function can_view(): bool {
  71          $reportid = $this->get_parameter('id', 0, PARAM_INT);
  72          $report = report::get_record(['id' => $reportid]);
  73  
  74          return $report && permission::can_edit_report($report);
  75      }
  76  
  77      /**
  78       * Find users who can access this report based on the audience and add them to the report.
  79       *
  80       * @param int $reportid
  81       * @param string $usertablealias
  82       * @return array
  83       */
  84      protected static function get_users_by_audience_sql(int $reportid, string $usertablealias): array {
  85          $audiences = audience::get_records(['reportid' => $reportid]);
  86  
  87          return audience_helper::user_audience_sql($audiences, $usertablealias);
  88      }
  89  }