Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 1778f310f3
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 621 lines (539 sloc) 21.41 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
<?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 stored 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 an actual file or folder - a row in the file table 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_stored extends file_info {
    /** @var stored_file|virtual_root_file stored_file or virtual_root_file instance */
    protected $lf;
    /** @var string the serving script */
    protected $urlbase;
    /** @var string the human readable name of this area */
    protected $topvisiblename;
    /** @var int|bool it's false if itemid is 0 and not included in URL */
    protected $itemidused;
    /** @var bool allow file reading */
    protected $readaccess;
    /** @var bool allow file write, delee */
    protected $writeaccess;
    /** @var string do not show links to parent context/area */
    protected $areaonly;

    /**
* Constructor
*
* @param file_browser $browser file browser instance
* @param stdClass $context context object
* @param stored_file|virtual_root_file $storedfile stored_file instance
* @param string $urlbase the serving script - usually the $CFG->wwwroot/.'pluginfile.php'
* @param string $topvisiblename the human readable name of this area
* @param int|bool $itemidused false if itemid always 0 and not included in URL
* @param bool $readaccess allow file reading
* @param bool $writeaccess allow file write, delete
* @param string $areaonly do not show links to parent context/area
*/
    public function __construct(file_browser $browser, $context, $storedfile, $urlbase, $topvisiblename, $itemidused, $readaccess, $writeaccess, $areaonly) {
        parent::__construct($browser, $context);

        $this->lf = $storedfile;
        $this->urlbase = $urlbase;
        $this->topvisiblename = $topvisiblename;
        $this->itemidused = $itemidused;
        $this->readaccess = $readaccess;
        $this->writeaccess = $writeaccess;
        $this->areaonly = $areaonly;
    }

    /**
* 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, component, filearea, itemid, filepath and filename
*/
    public function get_params() {
        return array('contextid'=>$this->context->id,
                     'component'=>$this->lf->get_component(),
                     'filearea' =>$this->lf->get_filearea(),
                     'itemid' =>$this->lf->get_itemid(),
                     'filepath' =>$this->lf->get_filepath(),
                     'filename' =>$this->lf->get_filename());
    }

    /**
* Returns localised visible name.
*
* @return string
*/
    public function get_visible_name() {
        $filename = $this->lf->get_filename();
        $filepath = $this->lf->get_filepath();

        if ($filename !== '.') {
            return $filename;

        } else {
            $dir = trim($filepath, '/');
            $dir = explode('/', $dir);
            $dir = array_pop($dir);
            if ($dir === '') {
                return $this->topvisiblename;
            } else {
                return $dir;
            }
        }
    }

    /**
* Returns the localised human-readable name of the file together with virtual path
*
* @return string
*/
    public function get_readable_fullname() {
        global $CFG;
        // retrieve the readable path with all parents (excluding the top most 'System')
        $fpath = array();
        for ($parent = $this; $parent && $parent->get_parent(); $parent = $parent->get_parent()) {
            array_unshift($fpath, $parent->get_visible_name());
        }

        if ($this->lf->get_component() == 'user' && $this->lf->get_filearea() == 'private') {
            // use the special syntax for user private files - 'USERNAME Private files: PATH'
            $username = array_shift($fpath);
            array_shift($fpath); // get rid of "Private Files/" in the beginning of the path
            return get_string('privatefilesof', 'repository', $username). ': '. join('/', $fpath);
        } else {
            // for all other files (except user private files) return 'Server files: PATH'

            // first, get and cache the name of the repository_local (will be used as prefix for file names):
            static $replocalname = null;
            if ($replocalname === null) {
                require_once($CFG->dirroot . "/repository/lib.php");
                $instances = repository::get_instances(array('type' => 'local'));
                if (count($instances)) {
                    $firstinstance = reset($instances);
                    $replocalname = $firstinstance->get_name();
                } else if (get_string_manager()->string_exists('pluginname', 'repository_local')) {
                    $replocalname = get_string('pluginname', 'repository_local');
                } else {
                    $replocalname = get_string('arearoot', 'repository');
                }
            }

            return $replocalname. ': '. join('/', $fpath);
        }
    }

    /**
* Returns file download url
*
* @param bool $forcedownload Whether or not force download
* @param bool $https whether or not force https
* @return string url
*/
    public function get_url($forcedownload=false, $https=false) {
        if (!$this->is_readable()) {
            return null;
        }

        if ($this->is_directory()) {
            return null;
        }

        $this->urlbase;
        $contextid = $this->lf->get_contextid();
        $component = $this->lf->get_component();
        $filearea = $this->lf->get_filearea();
        $itemid = $this->lf->get_itemid();
        $filepath = $this->lf->get_filepath();
        $filename = $this->lf->get_filename();

        if ($this->itemidused) {
            $path = '/'.$contextid.'/'.$component.'/'.$filearea.'/'.$itemid.$filepath.$filename;
        } else {
            $path = '/'.$contextid.'/'.$component.'/'.$filearea.$filepath.$filename;
        }
        return file_encode_url($this->urlbase, $path, $forcedownload, $https);
    }

    /**
* Whether or not I can read content of this file or enter directory
*
* @return bool
*/
    public function is_readable() {
        return $this->readaccess;
    }

    /**
* Whether or not new files or directories can be added
*
* @return bool
*/
    public function is_writable() {
        return $this->writeaccess;
    }

    /**
* Whether or not this is an empty area
*
* @return bool
*/
    public function is_empty_area() {
        if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
            // test the emptiness only in the top most level, it does not make sense at lower levels
            $fs = get_file_storage();
            return $fs->is_area_empty($this->lf->get_contextid(), $this->lf->get_component(), $this->lf->get_filearea(), $this->lf->get_itemid());
        } else {
            return false;
        }
    }

    /**
* Returns file size in bytes, null for directories
*
* @return int bytes or null if not known
*/
    public function get_filesize() {
        return $this->lf->get_filesize();
    }

    /**
* Returns width, height and mimetype of the stored image, or false
*
* @see stored_file::get_imageinfo()
* @return array|false
*/
    public function get_imageinfo() {
        return $this->lf->get_imageinfo();
    }

    /**
* Returns mimetype
*
* @return string mimetype or null if not known
*/
    public function get_mimetype() {
        return $this->lf->get_mimetype();
    }

    /**
* Returns time created unix timestamp if known
*
* @return int timestamp or null
*/
    public function get_timecreated() {
        return $this->lf->get_timecreated();
    }

    /**
* Returns time modified unix timestamp if known
*
* @return int timestamp or null
*/
    public function get_timemodified() {
        return $this->lf->get_timemodified();
    }

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

    /**
* Returns the license type of the file
*
* @return string license short name or null
*/
    public function get_license() {
        return $this->lf->get_license();
    }

    /**
* Returns the author name of the file
*
* @return string author name or null
*/
    public function get_author() {
        return $this->lf->get_author();
    }

    /**
* Returns the source of the file
*
* @return string a source url or null
*/
    public function get_source() {
        return $this->lf->get_source();
    }

    /**
* Returns the sort order of the file
*
* @return int
*/
    public function get_sortorder() {
        return $this->lf->get_sortorder();
    }

    /**
* Whether or not this is a external resource
*
* @return bool
*/
    public function is_external_file() {
        return $this->lf->is_external_file();
    }

    /**
* Returns file status flag.
*
* @return int 0 means file OK, anything else is a problem and file can not be used
*/
    public function get_status() {
        return $this->lf->get_status();
    }

    /**
* Returns list of children.
*
* @return array of file_info instances
*/
    public function get_children() {
        if (!$this->lf->is_directory()) {
            return array();
        }

        $result = array();
        $fs = get_file_storage();

        $storedfiles = $fs->get_directory_files($this->context->id, $this->lf->get_component(), $this->lf->get_filearea(), $this->lf->get_itemid(),
                                                $this->lf->get_filepath(), false, true, "filepath, filename");
        foreach ($storedfiles as $file) {
            $result[] = new file_info_stored($this->browser, $this->context, $file, $this->urlbase, $this->topvisiblename,
                                             $this->itemidused, $this->readaccess, $this->writeaccess, false);
        }

        return $result;
    }

    /**
* Returns parent file_info instance
*
* @return file_info|null file_info instance or null for root
*/
    public function get_parent() {
        if ($this->lf->get_filepath() === '/' and $this->lf->is_directory()) {
            if ($this->areaonly) {
                return null;
            } else if ($this->itemidused) {
                return $this->browser->get_file_info($this->context, $this->lf->get_component(), $this->lf->get_filearea());
            } else {
                return $this->browser->get_file_info($this->context);
            }
        }

        if (!$this->lf->is_directory()) {
            return $this->browser->get_file_info($this->context, $this->lf->get_component(), $this->lf->get_filearea(), $this->lf->get_itemid(), $this->lf->get_filepath(), '.');
        }

        $filepath = $this->lf->get_filepath();
        $filepath = trim($filepath, '/');
        $dirs = explode('/', $filepath);
        array_pop($dirs);
        $filepath = implode('/', $dirs);
        $filepath = ($filepath === '') ? '/' : "/$filepath/";

        return $this->browser->get_file_info($this->context, $this->lf->get_component(), $this->lf->get_filearea(), $this->lf->get_itemid(), $filepath, '.');
    }

    /**
* Create new directory, may throw exception - make sure
* params are valid.
*
* @param string $newdirname name of new directory
* @param int $userid id of author, default $USER->id
* @return file_info|null new directory's file_info instance or null if failed
*/
    public function create_directory($newdirname, $userid = NULL) {
        if (!$this->is_writable() or !$this->lf->is_directory()) {
            return null;
        }

        $newdirname = clean_param($newdirname, PARAM_FILE);
        if ($newdirname === '') {
            return null;
        }

        $filepath = $this->lf->get_filepath().'/'.$newdirname.'/';

        $fs = get_file_storage();

        if ($file = $fs->create_directory($this->lf->get_contextid(), $this->lf->get_component(), $this->lf->get_filearea(), $this->lf->get_itemid(), $filepath, $userid)) {
            return $this->browser->get_file_info($this->context, $this->lf->get_component(), $file->get_filearea(), $file->get_itemid(), $file->get_filepath(), $file->get_filename());
        }
        return null;
    }


    /**
* Create new file from string - make sure
* params are valid.
*
* @param string $newfilename name of new file
* @param string $content of file
* @param int $userid id of author, default $USER->id
* @return file_info|null new file's file_info instance or null if failed
*/
    public function create_file_from_string($newfilename, $content, $userid = NULL) {
        if (!$this->is_writable() or !$this->lf->is_directory()) {
            return null;
        }

        $newfilename = clean_param($newfilename, PARAM_FILE);
        if ($newfilename === '') {
            return null;
        }

        $fs = get_file_storage();

        $now = time();

        $newrecord = new stdClass();
        $newrecord->contextid = $this->lf->get_contextid();
        $newrecord->component = $this->lf->get_component();
        $newrecord->filearea = $this->lf->get_filearea();
        $newrecord->itemid = $this->lf->get_itemid();
        $newrecord->filepath = $this->lf->get_filepath();
        $newrecord->filename = $newfilename;

        if ($fs->file_exists($newrecord->contextid, $newrecord->component, $newrecord->filearea, $newrecord->itemid, $newrecord->filepath, $newrecord->filename)) {
            // file already exists, sorry
            return null;
        }

        $newrecord->timecreated = $now;
        $newrecord->timemodified = $now;
        $newrecord->mimetype = mimeinfo('type', $newfilename);
        $newrecord->userid = $userid;

        if ($file = $fs->create_file_from_string($newrecord, $content)) {
            return $this->browser->get_file_info($this->context, $file->get_component(), $file->get_filearea(), $file->get_itemid(), $file->get_filepath(), $file->get_filename());
        }
        return null;
    }

    /**
* Create new file from pathname - make sure
* params are valid.
*
* @param string $newfilename name of new file
* @param string $pathname location of file
* @param int $userid id of author, default $USER->id
* @return file_info|null new file's file_info instance or null if failed
*/
    public function create_file_from_pathname($newfilename, $pathname, $userid = NULL) {
        if (!$this->is_writable() or !$this->lf->is_directory()) {
            return null;
        }

        $newfilename = clean_param($newfilename, PARAM_FILE);
        if ($newfilename === '') {
            return null;
        }

        $fs = get_file_storage();

        $now = time();

        $newrecord = new stdClass();
        $newrecord->contextid = $this->lf->get_contextid();
        $newrecord->component = $this->lf->get_component();
        $newrecord->filearea = $this->lf->get_filearea();
        $newrecord->itemid = $this->lf->get_itemid();
        $newrecord->filepath = $this->lf->get_filepath();
        $newrecord->filename = $newfilename;

        if ($fs->file_exists($newrecord->contextid, $newrecord->component, $newrecord->filearea, $newrecord->itemid, $newrecord->filepath, $newrecord->filename)) {
            // file already exists, sorry
            return null;
        }

        $newrecord->timecreated = $now;
        $newrecord->timemodified = $now;
        $newrecord->mimetype = mimeinfo('type', $newfilename);
        $newrecord->userid = $userid;

        if ($file = $fs->create_file_from_pathname($newrecord, $pathname)) {
            return $this->browser->get_file_info($this->context, $file->get_component(), $file->get_filearea(), $file->get_itemid(), $file->get_filepath(), $file->get_filename());
        }
        return null;
    }

    /**
* Create new file from stored file - make sure
* params are valid.
*
* @param string $newfilename name of new file
* @param int|stored_file $fid file id or stored_file of file
* @param int $userid id of author, default $USER->id
* @return file_info|null new file's file_info instance or null if failed
*/
    public function create_file_from_storedfile($newfilename, $fid, $userid = NULL) {
        if (!$this->is_writable() or $this->lf->get_filename() !== '.') {
            return null;
        }

        $newfilename = clean_param($newfilename, PARAM_FILE);
        if ($newfilename === '') {
            return null;
        }

        $fs = get_file_storage();

        $now = time();

        $newrecord = new stdClass();
        $newrecord->contextid = $this->lf->get_contextid();
        $newrecord->component = $this->lf->get_component();
        $newrecord->filearea = $this->lf->get_filearea();
        $newrecord->itemid = $this->lf->get_itemid();
        $newrecord->filepath = $this->lf->get_filepath();
        $newrecord->filename = $newfilename;

        if ($fs->file_exists($newrecord->contextid, $newrecord->component, $newrecord->filearea, $newrecord->itemid, $newrecord->filepath, $newrecord->filename)) {
            // file already exists, sorry
            return null;
        }

        $newrecord->timecreated = $now;
        $newrecord->timemodified = $now;
        $newrecord->mimetype = mimeinfo('type', $newfilename);
        $newrecord->userid = $userid;

        if ($file = $fs->create_file_from_storedfile($newrecord, $fid)) {
            return $this->browser->get_file_info($this->context, $file->get_component(), $file->get_filearea(), $file->get_itemid(), $file->get_filepath(), $file->get_filename());
        }
        return null;
    }

    /**
* Delete file, make sure file is deletable first.
*
* @return bool success
*/
    public function delete() {
        if (!$this->is_writable()) {
            return false;
        }

        if ($this->is_directory()) {
            $filepath = $this->lf->get_filepath();
            $fs = get_file_storage();
            $storedfiles = $fs->get_area_files($this->context->id, $this->get_component(), $this->lf->get_filearea(), $this->lf->get_itemid());
            foreach ($storedfiles as $file) {
                if (strpos($file->get_filepath(), $filepath) === 0) {
                    $file->delete();
                }
            }
        }

        return $this->lf->delete();
    }

    /**
* Copy content of this file to local storage, overriding current file if needed.
*
* @param array|stdClass $filerecord contains contextid, component, filearea,
* itemid, filepath, filename and optionally other attributes of the new file
* @return bool success
*/
    public function copy_to_storage($filerecord) {
        if (!$this->is_readable() or $this->is_directory()) {
            return false;
        }
        $filerecord = (array)$filerecord;

        $fs = get_file_storage();
        if ($existing = $fs->get_file($filerecord['contextid'], $filerecord['component'], $filerecord['filearea'], $filerecord['itemid'], $filerecord['filepath'], $filerecord['filename'])) {
            $existing->delete();
        }
        $fs->create_file_from_storedfile($filerecord, $this->lf);

        return true;
    }

    /**
* Copy content of this file to local storage, overriding current file if needed.
*
* @param string $pathname real local full file name
* @return bool success
*/
    public function copy_to_pathname($pathname) {
        if (!$this->is_readable() or $this->is_directory()) {
            return false;
        }

        if (file_exists($pathname)) {
            if (!unlink($pathname)) {
                return false;
            }
        }

        $this->lf->copy_content_to($pathname);

        return true;
    }
}
Something went wrong with that request. Please try again.