MDL-18111 improving file api comments and docs, fixing license header

draftfile.php

@@ -1,66 +1,90 @@
-<?php  // $Id$
-
-    require_once('config.php');
-    require_once('lib/filelib.php');
-
-    require_login();
-    if (isguestuser()) {
-        print_error('noguest');
-    }
-
-    // disable moodle specific debug messages
-    disable_debugging();
-
-    $relativepath = get_file_argument();
-
-    // relative path must start with '/'
-    if (!$relativepath) {
-        print_error('invalidargorconf');
-    } else if ($relativepath{0} != '/') {
-        print_error('pathdoesnotstartslash');
-    }
-
-    // extract relative path components
-    $args = explode('/', ltrim($relativepath, '/'));
-
-    if (count($args) == 0) { // always at least user id
-        print_error('invalidarguments');
-    }
-
-    $contextid = (int)array_shift($args);
-    $filearea = array_shift($args);
-
-    $context = get_context_instance_by_id($contextid);
-    if ($context->contextlevel != CONTEXT_USER) {
-        print_error('invalidarguments');
-    }
-
-    $userid = $context->instanceid;
-    if ($USER->id != $userid) {
-        print_error('invaliduserid');
-    }
-
-    switch ($filearea) {
-        case 'user_draft':
-            $itemid = (int)array_shift($args);
-            break;
-        default:
-            send_file_not_found();
-    }
+<?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/>.
+
+/**
+ * This script delegates file serving to individual plugins
+ *
+ * @package    moodlecore
+ * @subpackage file
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once('config.php');
+require_once('lib/filelib.php');
+
+require_login();
+if (isguestuser()) {
+    print_error('noguest');
+}
+
+// disable moodle specific debug messages
+disable_debugging();
+
+$relativepath = get_file_argument();
+
+// relative path must start with '/'
+if (!$relativepath) {
+    print_error('invalidargorconf');
+} else if ($relativepath{0} != '/') {
+    print_error('pathdoesnotstartslash');
+}
+
+// extract relative path components
+$args = explode('/', ltrim($relativepath, '/'));
+
+if (count($args) == 0) { // always at least user id
+    print_error('invalidarguments');
+}
+
+$contextid = (int)array_shift($args);
+$filearea = array_shift($args);
+
+$context = get_context_instance_by_id($contextid);
+if ($context->contextlevel != CONTEXT_USER) {
+    print_error('invalidarguments');
+}
+
+$userid = $context->instanceid;
+if ($USER->id != $userid) {
+    print_error('invaliduserid');
+}
+
+switch ($filearea) {
+    case 'user_draft':
+        $itemid = (int)array_shift($args);
+        break;
+    default:
+        send_file_not_found();
+}
 
-    $relativepath = '/'.implode('/', $args);
+$relativepath = '/'.implode('/', $args);
 
 
-    $fs = get_file_storage();
+$fs = get_file_storage();
 
-    $fullpath = $context->id.$filearea.$itemid.$relativepath;
+$fullpath = $context->id.$filearea.$itemid.$relativepath;
 
-    if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->get_filename() == '.') {
-        send_file_not_found();
-    }
+if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->get_filename() == '.') {
+    send_file_not_found();
+}
 
-    // ========================================
-    // finally send the file
-    // ========================================
-    session_get_instance()->write_close(); // unlock session during fileserving
-    send_stored_file($file, 0, false, true); // force download - security first!
+// ========================================
+// finally send the file
+// ========================================
+session_get_instance()->write_close(); // unlock session during fileserving
+send_stored_file($file, 0, false, true); // force download - security first!