MDL-28701 add old cache and temp creation debug message and improve docs a bit

diff --git a/config-dist.php b/config-dist.php
index a35dcb3..6a5f7fc 100644 (file)
--- a/config-dist.php
+++ b/config-dist.php
@@ -347,6 +347,12 @@ $CFG->admin = 'admin';
 //
 //     $CFG->themedir = '/location/of/extra/themes';
 //
+// It is possible to specify different cache and temp directories, use local fast filesystem.
+// The directories must not be accessible via web.
+//
+//     $CFG->tempdir = '/var/www/moodle/temp';
+//     $CFG->cachedir = '/var/www/moodle/cache';
+//
 // If $CFG->langstringcache is enabled (which should always be in production
 // environment), Moodle keeps aggregated strings in its own internal format
 // optimised for performance. By default, this on-disk cache is created in

diff --git a/lib/setuplib.php b/lib/setuplib.php
index 297ed93..f45221b 100644 (file)
--- a/lib/setuplib.php
+++ b/lib/setuplib.php
@@ -1107,6 +1107,7 @@ function check_dir_exists($dir, $create = true, $recursive = true) {
 /**
  * Create a directory and make sure it is writable.
  *
+ * @private
  * @param string $dir  the full path of the directory to be created
  * @param bool $exceptiononerror throw exception if error encountered
  * @return string|false Returns full path to directory if successful, false if not; may throw exception
@@ -1149,6 +1150,7 @@ function make_writable_directory($dir, $exceptiononerror = true) {
  * Protect a directory from web access.
  * Could be extended in the future to support other mechanisms (e.g. other webservers).
  *
+ * @private
  * @param string $dir  the full path of the directory to be protected
  */
 function protect_directory($dir) {
@@ -1163,6 +1165,7 @@ function protect_directory($dir) {
 
 /**
  * Create a directory under dataroot and make sure it is writable.
+ * Do not use for temporary and cache files - see make_temp_directory() and make_cache_directory().
  *
  * @param string $directory  the full path of the directory to be created under $CFG->dataroot
  * @param bool $exceptiononerror throw exception if error encountered
@@ -1170,12 +1173,21 @@ function protect_directory($dir) {
  */
 function make_upload_directory($directory, $exceptiononerror = true) {
     global $CFG;
+
+    if (strpos($directory, 'temp/') === 0 or $directory === 'temp') {
+        debugging('Use make_temp_directory() for creation of temporary directory and $CFG->tempdir to get the location.');
+
+    } else if (strpos($directory, 'cache/') === 0 or $directory === 'cache') {
+        debugging('Use make_cache_directory() for creation of chache directory and $CFG->cachedir to get the location.');
+    }
+
     protect_directory($CFG->dataroot);
     return make_writable_directory("$CFG->dataroot/$directory", $exceptiononerror);
 }
 
 /**
  * Create a directory under tempdir and make sure it is writable.
+ * Temporary files should be used during the current request only!
  *
  * @param string $directory  the full path of the directory to be created under $CFG->tempdir
  * @param bool $exceptiononerror throw exception if error encountered