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

/**

 * Provides code used during file browsing

 *

 * @category  files

 * @package   mod_workshop

 * @copyright 2009 David Mudrak <david.mudrak@gmail.com>

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

 */

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

/**

 * Represents virtual root node for all submissions

 *

 * Workshop submission uses two fileareas: submission_content for editor's embeded media

 * and submission_attachment for attachments. In both, the itemid represents the submission id.

 * This container is used to display the list of all submissions in these areas (ie when

 * these areas are browsed with itemid == null).

 */

class workshop_file_info_submissions_container extends file_info {

    protected $course;

    protected $cm;

    protected $areas;

    protected $filearea;

    public function __construct($browser, $course, $cm, $context, $areas, $filearea) {

        parent::__construct($browser, $context);

        $this->course   = $course;

        $this->cm       = $cm;

        $this->areas    = $areas;

        $this->filearea = $filearea;

    }

    /**

     * Returns list of standard virtual file/directory identification.

     * The difference from stored_file parameters is that null values

     * are allowed in all fields

     * @return array with keys contextid, filearea, itemid, filepath and filename

     */

    public function get_params() {

        return array('contextid'=>$this->context->id,

                     'component'=>'mod_workshop',

                     'filearea' =>$this->filearea,

                     'itemid'   =>null,

                     'filepath' =>null,

                     'filename' =>null);

    }

    /**

     * Returns localised visible name.

     * @return string

     */

    public function get_visible_name() {

        return $this->areas[$this->filearea];

    }

    /**

     * Can I add new files or directories?

     * @return bool

     */

    public function is_writable() {

        return false;

    }

    /**

     * Is directory?

     * @return bool

     */

    public function is_directory() {

        return true;

    }

    /**

     * Returns list of children nodes

     *

     * @return array of file_info instances

     */

    public function get_children() {

        return $this->get_filtered_children('*', false, true);

    }

    /**

     * Helper function to return files matching extensions or their count

     *

     * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')

     * @param bool|int $countonly if false returns the children, if an int returns just the

     *    count of children but stops counting when $countonly number of children is reached

     * @param bool $returnemptyfolders if true returns items that don't have matching files inside

     * @return array|int array of file_info instances or the count

     */

    private function get_filtered_children($extensions = '*', $countonly = false, $returnemptyfolders = false) {

        global $DB;

        $params = array('contextid' => $this->context->id,

            'component' => 'mod_workshop',

            'filearea' => $this->filearea);

        $sql = 'SELECT DISTINCT itemid

                    FROM {files}

                    WHERE contextid = :contextid

                    AND component = :component

                    AND filearea = :filearea';

        if (!$returnemptyfolders) {

            $sql .= ' AND filename <> :emptyfilename';

            $params['emptyfilename'] = '.';

        }

        list($sql2, $params2) = $this->build_search_files_sql($extensions);

        $sql .= ' '.$sql2;

        $params = array_merge($params, $params2);

        if ($countonly !== false) {

            $sql .= ' ORDER BY itemid DESC';

        }

        $rs = $DB->get_recordset_sql($sql, $params);

        $children = array();

        foreach ($rs as $record) {

            if (($child = $this->browser->get_file_info($this->context, 'mod_workshop', $this->filearea, $record->itemid))

                    && ($returnemptyfolders || $child->count_non_empty_children($extensions))) {

                $children[] = $child;

                if ($countonly !== false && count($children) >= $countonly) {

                    break;

                }

            }

        }

        $rs->close();

        if ($countonly !== false) {

            return count($children);

        }

        return $children;

    }

    /**

     * Returns list of children which are either files matching the specified extensions

     * or folders that contain at least one such file.

     *

     * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')

     * @return array of file_info instances

     */

    public function get_non_empty_children($extensions = '*') {

        return $this->get_filtered_children($extensions, false);

    }

    /**

     * Returns the number of children which are either files matching the specified extensions

     * or folders containing at least one such file.

     *

     * NOTE: We don't need the exact number of non empty children if it is >=2

     * In this function 1 is never returned to avoid skipping the single subfolder

     *

     * @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) {

        return $this->get_filtered_children($extensions, $limit);

    }

    /**

     * Returns parent file_info instance

     * @return file_info or null for root

     */

    public function get_parent() {

        return $this->browser->get_file_info($this->context);

    }

}

/**

 * Represents virtual root node for all files in overall feedbacks

 *

 * Overall feedback uses two fileareas: overallfeedback_content for editor's embeded media

 * and overallfeedback_attachment for attachments. In both, the itemid represents the assessment id.

 * This container is used to display the list of all submissions in these areas (ie when

 * these areas are browsed with itemid == null).

 */

class workshop_file_info_overallfeedback_container extends file_info {

    protected $course;

    protected $cm;

    protected $areas;

    protected $filearea;

    public function __construct($browser, $course, $cm, $context, $areas, $filearea) {

        parent::__construct($browser, $context);

        $this->course   = $course;

        $this->cm       = $cm;

        $this->areas    = $areas;

        $this->filearea = $filearea;

    }

    /**

     * Returns list of standard virtual file/directory identification

     *

     * The difference from stored_file parameters is that null values

     * are allowed in all fields.

     *

     * @return array with keys contextid, filearea, itemid, filepath and filename

     */

    public function get_params() {

        return array('contextid' => $this->context->id,

                     'component' => 'mod_workshop',

                     'filearea' => $this->filearea,

                     'itemid' => null,

                     'filepath' => null,

                     'filename' => null);

    }

    /**

     * Returns localised visible name

     *

     * @return string

     */

    public function get_visible_name() {

        return $this->areas[$this->filearea];

    }

    /**

     * Can I add new files or directories?

     *

     * @return bool

     */

    public function is_writable() {

        return false;

    }

    /**

     * Is directory?

     *

     * @return bool

     */

    public function is_directory() {

        return true;

    }

    /**

     * Returns list of children nodes

     *

     * @return array of file_info instances

     */

    public function get_children() {

        return $this->get_filtered_children('*', false, true);

    }

    /**

     * Helper function to return files matching extensions or their count

     *

     * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')

     * @param bool|int $countonly if false returns the children, if an int returns just the

     *    count of children but stops counting when $countonly number of children is reached

     * @param bool $returnemptyfolders if true returns items that don't have matching files inside

     * @return array|int array of file_info instances or the count

     */

    private function get_filtered_children($extensions = '*', $countonly = false, $returnemptyfolders = false) {

        global $DB;

        $params = array('contextid' => $this->context->id,

            'component' => 'mod_workshop',

            'filearea' => $this->filearea);

        $sql = "SELECT DISTINCT itemid

                  FROM {files}

                 WHERE contextid = :contextid

                       AND component = :component

                       AND filearea = :filearea";

        if (!$returnemptyfolders) {

            $sql .= " AND filename <> :emptyfilename";

            $params['emptyfilename'] = '.';

        }

        list($sql2, $params2) = $this->build_search_files_sql($extensions);

        $sql .= ' '.$sql2;

        $params = array_merge($params, $params2);

        if ($countonly !== false) {

            $sql .= " ORDER BY itemid DESC";

        }

        $rs = $DB->get_recordset_sql($sql, $params);

        $children = array();

        foreach ($rs as $record) {

            if (($child = $this->browser->get_file_info($this->context, 'mod_workshop', $this->filearea, $record->itemid))

                    && ($returnemptyfolders || $child->count_non_empty_children($extensions))) {

                $children[] = $child;

                if ($countonly !== false && count($children) >= $countonly) {

                    break;

                }

            }

        }

        $rs->close();

        if ($countonly !== false) {

            return count($children);

        }

        return $children;

    }

    /**

     * Returns list of children which are either files matching the specified extensions

     * or folders that contain at least one such file.

     *

     * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')

     * @return array of file_info instances

     */

    public function get_non_empty_children($extensions = '*') {

        return $this->get_filtered_children($extensions, false);

    }

    /**

     * Returns the number of children which are either files matching the specified extensions

     * or folders containing at least one such file.

     *

     * NOTE: We don't need the exact number of non empty children if it is >=2

     * In this function 1 is never returned to avoid skipping the single subfolder

     *

     * @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) {

        return $this->get_filtered_children($extensions, $limit);

    }

    /**

     * Returns parent file_info instance

     * @return file_info or null for root

     */

    public function get_parent() {

        return $this->browser->get_file_info($this->context);

    }

}