File System API - Revision history

Mudrd8mz: Text replacement - "" to ""

2021-07-14T13:02:30Z

Text replacement - "</code>" to "</syntaxhighlight>"

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:02:25Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"
Show changes



Golenkovm: Update file_system method name
2021-02-04T06:41:47Z
Update file_system method name

				
				
				
				
				
				← Older revision
				Revision as of 06:41, 4 February 2021
				
Line 312:
Line 312:
      */       */
     public function copy_content_from_storedfile(stored_file $file, $target) {      public function copy_content_from_storedfile(stored_file $file, $target) {
         return copy($this->get_remote_path_from_stored_file($file), $target);          return copy($this->get_remote_path_from_storedfile($file), $target);
     }      }






Brendanheywood: /* xsendfile */
2019-11-08T13:11:44Z
xsendfile

				
				
				
				
				
				← Older revision
				Revision as of 13:11, 8 November 2019
				
Line 198:
Line 198:
==== xsendfile ==== ==== xsendfile ====



This is how a file is actually sent when xsendfile is supported. The default implementation is below, but this can be overridden to provide any other way of serving a file which bypasses streaming the file php memory. This is how a file is actually sent when xsendfile is supported. The default implementation is below, but this can be overridden to provide any other way of serving a file which bypasses streaming the file through php memory.



<code> <code>





Brendanheywood: /* supports_xsendfile */
2019-11-06T22:42:57Z
supports_xsendfile

				
				
				
				
				
				← Older revision
				Revision as of 22:42, 6 November 2019
				
Line 190:
Line 190:
==== supports_xsendfile ==== ==== supports_xsendfile ====



This says whether this file system supports xsendfile or something similar to it. Most file systems will inherit an implementation from the base file_system class. This says whether this file system supports xsendfile or something similar to it. Most file systems will inherit an implementation from the base file_system class. See config-dist.php for how to set this up:



https://github.com/moodle/moodle/blob/master/config-dist.php https://github.com/moodle/moodle/blob/master/config-dist.php

See also: https://docs.moodle.org/en/Performance_recommendations#X-Sendfile



==== xsendfile ==== ==== xsendfile ====



Brendanheywood: /* Explanation of required functions */
2019-11-06T22:40:45Z
Explanation of required functions

				
				
				
				
				
				← Older revision
				Revision as of 22:40, 6 November 2019
				
Line 184:
Line 184:
The <code>remove_file</code> function is responsible for removing a file. The <code>remove_file</code> function is responsible for removing a file.
A file system '''may''' choose to implement it's own trash mechanism, as in the case of <code>filesystem_filedir</code> A file system '''may''' choose to implement it's own trash mechanism, as in the case of <code>filesystem_filedir</code>


=== Other functions ===

==== supports_xsendfile ====

This says whether this file system supports xsendfile or something similar to it. Most file systems will inherit an implementation from the base file_system class.

https://github.com/moodle/moodle/blob/master/config-dist.php

==== xsendfile ====

This is how a file is actually sent when xsendfile is supported. The default implementation is below, but this can be overridden to provide any other way of serving a file which bypasses streaming the file php memory.

<code>
public function xsendfile($contenthash) {
    global $CFG;
    require_once($CFG->libdir . "/xsendfilelib.php");
    return xsendfile($this->get_remote_path_from_hash($contenthash));
}
</code>



=== Example === === Example ===



Jaked at 06:27, 20 September 2017
2017-09-20T06:27:48Z


				
				
				
				
				
				← Older revision
				Revision as of 06:27, 20 September 2017
				
Line 385:
Line 385:
Now, in your config.php, add: Now, in your config.php, add:
<code> <code>
$CFG->alternative_file_system_class = '\core_file_system_ftp'; $CFG->alternative_file_system_class = '\\core_file_system_ftp';
$CFG->file_system_ftp_user = 'test'; $CFG->file_system_ftp_user = 'test';
$CFG->file_system_ftp_pass = 'test'; $CFG->file_system_ftp_pass = 'test';





Jaked at 06:26, 20 September 2017
2017-09-20T06:26:55Z


				
				
				
				
				
				← Older revision
				Revision as of 06:26, 20 September 2017
				
Line 188:
Line 188:



==== FTP file system ==== ==== FTP file system ====
Tying together the information in the previous sections, we'll now set up an example FTP file system. Please note: Neither the sample <code>file_system_ftp</code> class, nor the use as FTP as a file system is recommended for use in production installs. It simply serves as an example to aid developers in grasping the concept of a remote file system. Tying together the information in the previous sections, we'll now set up an example FTP file system. Please note: Neither the sample <code>core_file_system_ftp</code> class, nor the use as FTP as a file system is recommended for use in production installs. It simply serves as an example to aid developers in grasping the concept of a remote file system.






The first step is creating the <code>file_system_ftp</code> class and setting it up as the alternative file system. To do this, create a file called '''file_system_ftp.php''' in your '''lib/classes''' directory and add the following content: The first step is creating the <code>core_file_system_ftp</code> class and setting it up as the alternative file system. To do this, create a file called '''file_system_ftp.php''' in your '''lib/classes''' directory and add the following content:











Jaked at 06:24, 20 September 2017
2017-09-20T06:24:57Z

Show changes


Cameron1729: /* Introduction */
2017-08-01T03:34:34Z
Introduction

				
				
				
				
				
				← Older revision
				Revision as of 03:34, 1 August 2017
				
Line 8:
Line 8:
The standard file system implementation uses the Moodle filedir, which is a locally available directory on disk, and which can be shared between clustered servers via network file systems such as NFS. The standard file system implementation uses the Moodle filedir, which is a locally available directory on disk, and which can be shared between clustered servers via network file systems such as NFS.



Since Moodle 3.3 it is possible to use alternative file systems, including remote file systems. These are easy to setup and configure, and allow for greater scalability which does not depends so heavily upon traditional network file systems. Since Moodle 3.3 it is possible to use alternative file systems, including remote file systems. These are easy to setup and configure, and allow for greater scalability which does not depends so heavily upon traditional network file systems. See config-dist.php for more details.  



Please note that the file *must* exist remotely and a local file is *optional*. The remote file is seen as canonical and this system is *not* designed to be used to cater to a split brain solution where some files are present in one place, and some files are present in another. Please note that the file *must* exist remotely and a local file is *optional*. The remote file is seen as canonical and this system is *not* designed to be used to cater to a split brain solution where some files are present in one place, and some files are present in another.

← Older revision		Revision as of 06:41, 4 February 2021
Line 312:		Line 312:
	*/		*/
	public function copy_content_from_storedfile(stored_file $file, $target) {		public function copy_content_from_storedfile(stored_file $file, $target) {
	return copy($this->~~get_remote_path_from_stored_file~~($file), $target);		return copy($this->get_remote_path_from_storedfile($file), $target);
	}		}

← Older revision		Revision as of 13:11, 8 November 2019
Line 198:		Line 198:
	==== xsendfile ====		==== xsendfile ====

	This is how a file is actually sent when xsendfile is supported. The default implementation is below, but this can be overridden to provide any other way of serving a file which bypasses streaming the file php memory.		This is how a file is actually sent when xsendfile is supported. The default implementation is below, but this can be overridden to provide any other way of serving a file which bypasses streaming the file through php memory.

	<code>		<code>

← Older revision		Revision as of 22:42, 6 November 2019
Line 190:		Line 190:
	==== supports_xsendfile ====		==== supports_xsendfile ====

	This says whether this file system supports xsendfile or something similar to it. Most file systems will inherit an implementation from the base file_system class.		This says whether this file system supports xsendfile or something similar to it. Most file systems will inherit an implementation from the base file_system class. See config-dist.php for how to set this up:

	https://github.com/moodle/moodle/blob/master/config-dist.php		https://github.com/moodle/moodle/blob/master/config-dist.php

			See also: https://docs.moodle.org/en/Performance_recommendations#X-Sendfile

	==== xsendfile ====		==== xsendfile ====

← Older revision		Revision as of 06:27, 20 September 2017
Line 385:		Line 385:
	Now, in your config.php, add:		Now, in your config.php, add:
	<code>		<code>
	$CFG->alternative_file_system_class = '\core_file_system_ftp';		$CFG->alternative_file_system_class = '\\core_file_system_ftp';
	$CFG->file_system_ftp_user = 'test';		$CFG->file_system_ftp_user = 'test';
	$CFG->file_system_ftp_pass = 'test';		$CFG->file_system_ftp_pass = 'test';

← Older revision		Revision as of 06:26, 20 September 2017
Line 188:		Line 188:

	==== FTP file system ====		==== FTP file system ====
	Tying together the information in the previous sections, we'll now set up an example FTP file system. Please note: Neither the sample <code>~~file_system_ftp~~</code> class, nor the use as FTP as a file system is recommended for use in production installs. It simply serves as an example to aid developers in grasping the concept of a remote file system.		Tying together the information in the previous sections, we'll now set up an example FTP file system. Please note: Neither the sample <code>core_file_system_ftp</code> class, nor the use as FTP as a file system is recommended for use in production installs. It simply serves as an example to aid developers in grasping the concept of a remote file system.


	The first step is creating the <code>~~file_system_ftp~~</code> class and setting it up as the alternative file system. To do this, create a file called '''file_system_ftp.php''' in your '''lib/classes''' directory and add the following content:		The first step is creating the <code>core_file_system_ftp</code> class and setting it up as the alternative file system. To do this, create a file called '''file_system_ftp.php''' in your '''lib/classes''' directory and add the following content:

← Older revision		Revision as of 03:34, 1 August 2017
Line 8:		Line 8:
	The standard file system implementation uses the Moodle filedir, which is a locally available directory on disk, and which can be shared between clustered servers via network file systems such as NFS.		The standard file system implementation uses the Moodle filedir, which is a locally available directory on disk, and which can be shared between clustered servers via network file systems such as NFS.

	Since Moodle 3.3 it is possible to use alternative file systems, including remote file systems. These are easy to setup and configure, and allow for greater scalability which does not depends so heavily upon traditional network file systems.		Since Moodle 3.3 it is possible to use alternative file systems, including remote file systems. These are easy to setup and configure, and allow for greater scalability which does not depends so heavily upon traditional network file systems. See config-dist.php for more details.

	Please note that the file must exist remotely and a local file is optional. The remote file is seen as canonical and this system is not designed to be used to cater to a split brain solution where some files are present in one place, and some files are present in another.		Please note that the file must exist remotely and a local file is optional. The remote file is seen as canonical and this system is not designed to be used to cater to a split brain solution where some files are present in one place, and some files are present in another.