Development:File API - Revision history

Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""

2021-07-14T13:24:31Z

Text replacement - "class="nicetable"" to "class="wikitable""

← Older revision		Revision as of 13:24, 14 July 2021
Line 60:		Line 60:
	If, for example, the same image is used in a user's profile, and a forum post, then there will be two rows in this table, one for each use of the file, and Moodle will treat the two as separate files, even though the file is only stored once on disc.		If, for example, the same image is used in a user's profile, and a forum post, then there will be two rows in this table, one for each use of the file, and Moodle will treat the two as separate files, even though the file is only stored once on disc.

	{\| class="~~nicetable~~"		{\| class="wikitable"
	! Field		! Field
	! Type		! Type

CHRISF at 12:09, 2 December 2010

2010-12-02T12:09:32Z

← Older revision		Revision as of 12:09, 2 December 2010
Line 201:		Line 201:
	/file.php/courseid/dir/dir/filename.ext		/file.php/courseid/dir/dir/filename.ext

	Internally the files are stored in <code ~~php~~>array('contextid'=>$coursecontextid, 'component;=>'course', 'filearea'=>'legacy', 'itemid'=>0)</code>		Internally the files are stored in <code>array('contextid'=>$coursecontextid, 'component;=>'course', 'filearea'=>'legacy', 'itemid'=>0)</code>

	The legacy course files are completely disabled in all new courses created in 2.0. The major problem here is to how to educate our users that they can not make huge piles of files in each course any more.		The legacy course files are completely disabled in all new courses created in 2.0. The major problem here is to how to educate our users that they can not make huge piles of files in each course any more.

Skodak: /* userfile.php */

2010-07-03T13:45:10Z

userfile.php

← Older revision		Revision as of 13:45, 3 July 2010
Line 253:		Line 253:

	Internally stored in <code>array('contextid'=>SYSCONTEXTID, 'component'=>'blog', 'filearea'=>'post', 'itemid'=>$blogentryid)</code>		Internally stored in <code>array('contextid'=>SYSCONTEXTID, 'component'=>'blog', 'filearea'=>'post', 'itemid'=>$blogentryid)</code>

	~~===userfile.php===~~
	~~Personal file storage, intended as an online storage of work in progress like assignments before the submission.~~
	* read/write own files only for now
	* option to share with others later
	* personal "websites" will not be supported (security)

	~~/userfile.php/userid/dir/dir/filename.ext~~

Skodak: /* quiz example */

2010-07-03T13:44:55Z

quiz example

← Older revision		Revision as of 13:44, 3 July 2010
Line 236:		Line 236:
	====quiz example====		====quiz example====

	pluginfile.php/quizcontextid/~~quiz~~/intro/niceimage.jpg		pluginfile.php/quizcontextid/mod_quiz/intro/niceimage.jpg

	====questions example====		====questions example====

Skodak: /* pluginfile.php */

2010-07-03T13:44:41Z

pluginfile.php

← Older revision		Revision as of 13:44, 3 July 2010
Line 221:		Line 221:
	==== Assignment example ====		==== Assignment example ====

	/pluginfile.php/assignmentcontextid/~~assignment_intro~~/someimage.jpg		/pluginfile.php/assignmentcontextid/mod_assignment/intro/someimage.jpg
	/pluginfile.php/assignmentcontextid/~~assignment_submission~~/submissionid/attachmentname.ext		/pluginfile.php/assignmentcontextid/mod_assignment/submission/submissionid/attachmentname.ext
	/pluginfile.php/assignmentcontextid/~~assignment_allsubmissions~~/groupid/allsubmissionfiles.zip		/pluginfile.php/assignmentcontextid/mod_assignment/allsubmissions/groupid/allsubmissionfiles.zip

	The last line example of virtual file that is created on the fly.		The last line example of virtual file that should created on the fly, it is not implemented yet.

	====scorm example====		====scorm example====

	/pluginfile.php/scormcontextid/~~scorm_intro~~/someimage.jpg		/pluginfile.php/scormcontextid/mod_scorm/intro/someimage.jpg
	/pluginfile.php/scormcontextid/~~scorm_content~~/revisionnumber/dir/somescormfile.js		/pluginfile.php/scormcontextid/mod_scorm/content/revisionnumber/dir/somescormfile.js

	The revision counter is incremented when any file changes in order to prevent caching problems.		The revision counter is incremented when any file changes in order to prevent caching problems.
Line 236:		Line 236:
	====quiz example====		====quiz example====

	pluginfile.php/quizcontextid/~~quiz_intro~~/niceimage.jpg		pluginfile.php/quizcontextid/quiz/intro/niceimage.jpg
	~~pluginfile.php/quizcontextid/quiz_somereport/export.ods~~

	~~The second line is a virtual file for quiz report subplugin.~~

	====questions example====		====questions example====
Line 249:		Line 246:
	The note attachments are always served with XSS protection on, ideally we should use separate wwwroot for this. Access control can be hardcoded.		The note attachments are always served with XSS protection on, ideally we should use separate wwwroot for this. Access control can be hardcoded.

	/pluginfile.php/SYSCONTEXTID/~~blog_attachment~~/blogentryid/attachmentname~~.ext~~		/pluginfile.php/SYSCONTEXTID/blog/attachment/blogentryid/attachmentname.ext

	~~Internally stored in <code>array('contextid'=>SYSCONTEXTID, 'filearea'=>'blog_attachment', 'itemid'=>$blogentryid)</code>~~

	~~/pluginfile.php/SYSCONTEXTID/blog_post/blogentryid/embeddedimage~~.ext

	Internally stored in <code>array('contextid'=>SYSCONTEXTID, 'filearea'=>'~~blog_post~~', 'itemid'=>$blogentryid)</code>		Internally stored in <code>array('contextid'=>SYSCONTEXTID, 'component'=>'blog', 'filearea'=>'attachment', 'itemid'=>$blogentryid)</code>

			/pluginfile.php/SYSCONTEXTID/blog/post/blogentryid/embeddedimage.ext

			Internally stored in <code>array('contextid'=>SYSCONTEXTID, 'component'=>'blog', 'filearea'=>'post', 'itemid'=>$blogentryid)</code>

	===userfile.php===		===userfile.php===

Skodak: /* legacy file.php */

2010-07-03T13:42:16Z

legacy file.php

← Older revision		Revision as of 13:42, 3 July 2010
Line 201:		Line 201:
	/file.php/courseid/dir/dir/filename.ext		/file.php/courseid/dir/dir/filename.ext

	Internally the files are stored in <code php>array('contextid'=>$coursecontextid, 'filearea'=>'~~course_content~~', 'itemid'=>0)</code>		Internally the files are stored in <code php>array('contextid'=>$coursecontextid, 'component;=>'course', 'filearea'=>'legacy', 'itemid'=>0)</code>

	The legacy course files are completely disabled in all new courses created in 2.0. The major problem here is to how to educate our users that they can not make huge piles of files in each course any more.		The legacy course files are completely disabled in all new courses created in 2.0. The major problem here is to how to educate our users that they can not make huge piles of files in each course any more.

Skodak: /* Files table */

2010-07-03T13:41:37Z

Files table

← Older revision		Revision as of 13:41, 3 July 2010
Line 86:		Line 86:
	\| The context id defined in context table - identifies the instance of plugin owning the file.		\| The context id defined in context table - identifies the instance of plugin owning the file.
	\|-		\|-
	\| '''component''		\| '''component'''
	\| varchar(50)		\| varchar(50)
	\|		\|

Skodak: /* Files table */

2010-07-03T13:41:12Z

Files table

← Older revision		Revision as of 13:41, 3 July 2010
Line 79:		Line 79:
	\| varchar(40)		\| varchar(40)
	\|		\|
	\| The sha1 hash of contextid+filearea+itemid+filepath+filename - prevents file duplicates and allows fast lookup. It is necessary because some databases have hard limit on index size.		\| The sha1 hash of "/contextid/component/filearea/itemid/filepath/filename.ext" - prevents file duplicates and allows fast lookup. It is necessary because some databases have hard limit on index size.
	\|-		\|-
	\| '''contextid'''		\| '''contextid'''
Line 85:		Line 85:
	\|		\|
	\| The context id defined in context table - identifies the instance of plugin owning the file.		\| The context id defined in context table - identifies the instance of plugin owning the file.
			\|-
			\| '''component''
			\| varchar(50)
			\|
			\| Like "mod_forum", "course", "mod_assignment", "backup"
	\|-		\|-
	\| '''filearea'''		\| '''filearea'''
Line 153:		Line 158:

	Indexes:		Indexes:
	* non-unique index on (contextid, filearea, itemid)		* non-unique index on (contextid, component, filearea, itemid)
	* non-unique index on (contenthash)		* non-unique index on (contenthash)
	* unique index on (pathnamehash).		* unique index on (pathnamehash).

TimHunt: /* Implementation of basic operations */

2010-06-06T20:47:00Z

Implementation of basic operations

← Older revision		Revision as of 20:47, 6 June 2010
Line 165:		Line 165:
	===Implementation of basic operations===		===Implementation of basic operations===

	Each plugin may directly access only files in own context and areas!		'''Each plugin may directly access only files in own context and areas!'''

	Low level access API is defined in ''file_storage'' class which is obtained from <code>get_file_storage()</code>.		Low level access API is defined in ''file_storage'' class which is obtained from <code>get_file_storage()</code>.

Skodak: /* File management user-interface */

2010-06-05T09:51:17Z

File management user-interface

← Older revision		Revision as of 09:51, 5 June 2010
Line 294:		Line 294:
	=== Class: file_info and subclasses ===		=== Class: file_info and subclasses ===

	== File ~~management~~ user~~-interface~~ ==		== File related user interfaces ==

	~~=== File manager ===~~		All files are obtained through from the file repositories.

	~~All the contexts,~~ file ~~areas and files now form a single huge tree structure, although each user only has access to certain parts of that tree. The~~ file manager (~~files/index.php~~) ~~allow users to brows this tree, and manage files within it, according to the level of permissions they have.~~		=== Formslib fields ===
			* file picker
			* file manager
			* file upload (obsolete, do not use)

	Single pane file manager is hard to implement without drag & drop which is notoriously problematic in web based applications. I propose to implement a two pane commander-style file manager. Two pane manager allows you to easily copy/move files between two different contexts (ex: courses).		=== Integration with the HTML editor ===

	~~File manager must not interact directly with filesystem API, instead each module should return traversable tree~~ of files ~~and directories with both real and localised names (localised names are needed for dirs like backupdata)~~.		Each instance of the HTML editor can be told to store related files in a particular file area.

	~~This code will be~~ in file/.		During editing, files are stored in a draft files area. Then when the form is submitted they are moved into the real file area.

	~~=== Formslib field types ===~~		Files are selected using the repository file picker.

	~~This code will be in lib/form/~~		=== Legacy file manager ===

	* Upload single files.		Available only for legacy reasons. It is not supposed to be used.
	* Upload multiple files to ~~a files area~~.
	* HTML editor (see next)

	~~=== Integration with~~ the ~~HTML editor ===~~		All the contexts, file areas and files now form a single huge tree structure, although each user only has access to certain parts of that tree. The file manager (files/index.php) allow users to browse this tree, and manage files within it, according to the level of permissions they have.

	~~Each instance of the HTML editor will be told~~ to ~~store related files~~ in a ~~particular~~ file ~~area~~.		Single pane file manager is hard to implement without drag & drop which is notoriously problematic in web based applications. I propose to implement a two pane commander-style file manager. Two pane manager allows you to easily copy/move files between two different contexts (ex: courses).

	~~During editing~~, files ~~will be stored in a draft files area. Then when the form is submitted they will be~~ (~~automatically~~) ~~moved into the real file area.~~		File manager must not interact directly with filesystem API, instead each module should return traversable tree of files and directories with both real and localised names (localised names are needed for dirs like backupdata).

	~~Files will be selected using the repository file picker.~~

	~~=== Local files repository plugin ===~~

	~~Allows users to see an browse files they already have access to within this Moodle, for inclusion in the page currently being edited~~.

	~~This code will be in repository/local/~~

	== Backwards compatibility ==		== Backwards compatibility ==