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


/**
 * Utility class for browsing of curse category files.
 *
 * @package    core_files
 * @copyright  2008 Petr Skoda (http://skodak.org)
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

/**
 * Represents a course category context in the tree navigated by {@link file_browser}.
 *
 * @package    core_files
 * @copyright  2008 Petr Skoda (http://skodak.org)
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class file_info_context_coursecat extends file_info {
    /** @var stdClass Category object */
    protected $category;

    /**
     * Constructor
     *
     * @param file_browser $browser file browser instance
     * @param stdClass $context context object
     * @param stdClass $category category object
     */
    public function __construct($browser, $context, $category) {
        parent::__construct($browser, $context);
        $this->category = $category;
    }

    /**
     * Return information about this specific context level
     *
     * @param string $component component
     * @param string $filearea file area
     * @param int $itemid item ID
     * @param string $filepath file path
     * @param string $filename file name
     * @return fileinfo|null
     */
    public function get_file_info($component, $filearea, $itemid, $filepath, $filename) {
        global $DB;

        if (!core_course_category::can_view_category($this->category)) {
            if (empty($component)) {
                // we can not list the category contents, so try parent, or top system
                if ($this->category->parent and $pc = $DB->get_record('course_categories', array('id'=>$this->category->parent))) {
                    $parent = context_coursecat::instance($pc->id, IGNORE_MISSING);
                    return $this->browser->get_file_info($parent);
                } else {
                    return $this->browser->get_file_info();
                }
            }
            return null;
        }

        if (empty($component)) {
            return $this;
        }

        $methodname = "get_area_{$component}_{$filearea}";
        if (method_exists($this, $methodname)) {
            return $this->$methodname($itemid, $filepath, $filename);
        }

        return null;
    }

    /**
     * Return a file from course category description area
     *
     * @param int $itemid item ID
     * @param string $filepath file path
     * @param string $filename file name
     * @return fileinfo|null
     */
    protected function get_area_coursecat_description($itemid, $filepath, $filename) {
        global $CFG;

        if (!$this->category->id) {
            // No coursecat description area for "system".
            return null;
        }
        if (!core_course_category::can_view_category($this->category)) {
            return null;
        }
        if (!has_capability('moodle/category:manage', $this->context)) {
            return null;
        }

        if (is_null($itemid)) {
            return $this;
        }

        $fs = get_file_storage();

        $filepath = is_null($filepath) ? '/' : $filepath;
        $filename = is_null($filename) ? '.' : $filename;
        $urlbase = $CFG->wwwroot.'/pluginfile.php';
        if (!$storedfile = $fs->get_file($this->context->id, 'coursecat', 'description', 0, $filepath, $filename)) {
            if ($filepath === '/' and $filename === '.') {
                $storedfile = new virtual_root_file($this->context->id, 'coursecat', 'description', 0);
            } else {
                // not found
                return null;
            }
        }

        return new file_info_stored($this->browser, $this->context, $storedfile, $urlbase, get_string('areacategoryintro', 'repository'), false, true, true, false);
    }

    /**
     * Returns localised visible name.
     *
     * @return string
     */
    public function get_visible_name() {
        return format_string($this->category->name, true, array('context'=>$this->context));
    }

    /**
     * Whether or not new files or directories can be added
     *
     * @return bool
     */
    public function is_writable() {
        return false;
    }

    /**
     * Whether or not this is a directory
     *
     * @return bool
     */
    public function is_directory() {
        return true;
    }

    /**
     * Returns list of children.
     *
     * @return array of file_info instances
     */
    public function get_children() {
        $children = array();

        if ($child = $this->get_area_coursecat_description(0, '/', '.')) {
            $children[] = $child;
        }

        list($coursecats, $hiddencats) = $this->get_categories();
        foreach ($coursecats as $category) {
            $context = context_coursecat::instance($category->id);
            $children[] = new self($this->browser, $context, $category);
        }

        $courses = $this->get_courses($hiddencats);
        foreach ($courses as $course) {
            $children[] = $this->get_child_course($course);
        }

        return array_filter($children);
    }

    /**
     * List of courses in this category and in hidden subcategories
     *
     * @param array $hiddencats list of categories that are hidden from current user and returned by {@link get_categories()}
     * @return array list of courses
     */
    protected function get_courses($hiddencats) {
        global $DB, $CFG;
        require_once($CFG->libdir.'/modinfolib.php');

        $params = array('category' => $this->category->id, 'contextlevel' => CONTEXT_COURSE);
        $sql = 'c.category = :category';

        foreach ($hiddencats as $category) {
            $catcontext = context_coursecat::instance($category->id);
            $sql .= ' OR ' . $DB->sql_like('ctx.path', ':path' . $category->id);
            $params['path' . $category->id] = $catcontext->path . '/%';
        }

        // Let's retrieve only minimum number of fields from course table -
        // what is needed to check access or call get_fast_modinfo().
        $coursefields = array_merge(['id', 'visible'], course_modinfo::$cachedfields);
        $fields = 'c.' . join(',c.', $coursefields) . ', ' .
            context_helper::get_preload_record_columns_sql('ctx');
        return $DB->get_records_sql('SELECT ' . $fields . ' FROM {course} c
                JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)
                WHERE ('.$sql.') ORDER BY c.sortorder', $params);
    }

    /**
     * Finds accessible and non-accessible direct subcategories
     *
     * @return array [$coursecats, $hiddencats] - child categories that are visible to the current user and not visible
     */
    protected function get_categories() {
        global $DB;
        $fields = 'c.*, ' . context_helper::get_preload_record_columns_sql('ctx');
        $coursecats = $DB->get_records_sql('SELECT ' . $fields . ' FROM {course_categories} c
                LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)
                WHERE c.parent = :parent ORDER BY c.sortorder',
            array('parent' => $this->category->id, 'contextlevel' => CONTEXT_COURSECAT));

        $hiddencats = [];

        foreach ($coursecats as $id => &$category) {
            context_helper::preload_from_record($category);
            if (!core_course_category::can_view_category($category)) {
                $hiddencats[$id] = $coursecats[$id];
                unset($coursecats[$id]);
            }
        }
        return [$coursecats, $hiddencats];
    }

    /**
     * Returns the file info element for a given course or null if course is not accessible
     *
     * @param stdClass $course may contain context fields for preloading
     * @return file_info_context_course|null
     */
    protected function get_child_course($course) {
        context_helper::preload_from_record($course);
        $context = context_course::instance($course->id);
        $child = new file_info_context_course($this->browser, $context, $course);
        return $child->get_file_info(null, null, null, null, null);
    }

    /**
     * Returns the number of children which are either files matching the specified extensions
     * or folders containing at least one such file.
     *
     * @param string|array $extensions, for example '*' or array('.gif','.jpg')
     * @param int $limit stop counting after at least $limit non-empty children are found
     * @return int
     */
    public function count_non_empty_children($extensions = '*', $limit = 1) {
        $cnt = 0;
        if ($child = $this->get_area_coursecat_description(0, '/', '.')) {
            $cnt += $child->count_non_empty_children($extensions) ? 1 : 0;
            if ($cnt >= $limit) {
                return $cnt;
            }
        }

        list($coursecats, $hiddencats) = $this->get_categories();
        foreach ($coursecats as $category) {
            $context = context_coursecat::instance($category->id);
            $child = new file_info_context_coursecat($this->browser, $context, $category);
            $cnt += $child->count_non_empty_children($extensions) ? 1 : 0;
            if ($cnt >= $limit) {
                return $cnt;
            }
        }

        $courses = $this->get_courses($hiddencats);
        foreach ($courses as $course) {
            if ($child = $this->get_child_course($course)) {
                $cnt += $child->count_non_empty_children($extensions) ? 1 : 0;
                if ($cnt >= $limit) {
                    return $cnt;
                }
            }
        }

        return $cnt;
    }

    /**
     * Returns parent file_info instance
     *
     * @return file_info|null fileinfo instance or null for root directory
     */
    public function get_parent() {
        $parent = $this->context->get_parent_context();
        return $this->browser->get_file_info($parent);
    }
}