MDL-59700 filestorage: Rework repositories to avoid add_file_to_pool
[moodle.git] / repository / upgrade.txt
1 This files describes API changes in /repository/ repository system,
2 information provided here is intended especially for developers. Full
3 details of the repository API are available on Moodle docs:
6 === 3.4 ===
7 Repositories should no longer directly call file_system#add_file_to_pool or file_system#add_string_to_pool
8 instead they should call the stored_file method, set_synchronised_content_from_file or set_synchronised_content_from_string
10 === 3.3 ===
11 The skydrive repository is deprecated - please migrate to the newer onedrive repository.
13 === 3.2 ===
15 * The method repository::uses_post_requests() has been deprecated and must not be used anymore.
16 * The alfresco repository has been moved to the plugins database. It was
17   using an older version of the Alfresco SDK which is not compatible with recent versions of Alfresco.
19 === 3.1 ===
21 * The following functions, previously used (exclusively) by upgrade steps are not available
22   anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
23     - repository_picasa_admin_upgrade_notification()
24     - repository_googledocs_admin_upgrade_notification()
25     - repository_boxnet_admin_upgrade_notification()
26     - repository_alfresco_admin_security_key_notice()
27 * The prepare_file() function will now return a file in a per-request directory which will
28   be automatically cleaned at the end of the request.
29   No modifications should be required as a result of this change.
31 === 2.8 ===
33 * Repositories working with Moodle files must replace serialize() with json_encode() in the
34   attribute 'source' returned by get_listing(). If repository overrides file_is_accessible(),
35   get_file_reference() or get_file_source_info() they need to be changed too. See MDL-45616.
37 === 2.6 ===
39 * get_option() now always return null when the first parameter ($config) is not empty, and
40   no value was found for this $config. Previously this could sometimes return an empty array().
42 * The function repository_attach_id() was removed, it was never used and was not useful.
44 * New functions send_relative_file() and supports_relative_file() to allow sending relative linked
45   files - see filesystem repository for example.
47 * DB fields files.referencelifetime, files.referencelastsync and files_reference.lifetime
48   are deleted. The last synchronization time is stored only in files_reference.lastsync
49   and lifetime is not stored in DB any more, each repository must decide for itself
50   when to synchronize the file in function repository::sync_reference().
52 * The following methods in class repository are deprecated: sync_external_file(),
53   get_file_by_reference(), get_reference_file_lifetime(), sync_individual_file() and
54   reset_caches(). Instead there is one method repository::sync_reference() - this simplifies
55   the repositories API and reduces the number of DB queries.
57 * Deprecated const GETFILE_TIMEOUT, SYNCFILE_TIMEOUT and SYNCIMAGE_TIMEOUT and replaced them with
58   config variables repositorygetfiletimeout, repositorysyncfiletimeout and repositorysyncimagetimeout.
60 === 2.5 ===
62 * repository::append_suffix() has been deprecated, use repository::get_unused_filename() if you need
63   to get a file name which has not yet been used in the draft area.
65 * contains_private_data() is a new method to determine if a user 'logged in as' another user
66   can access the content of the repository. The default is to return True (no access).
68 * get_typename() returns the type of repository: dropbox, googledocs, etc...
70 * can_be_edited_by_user() encapsulates all the tests to make sure that the current user
71   has the rights to edit the instance of this repository.
73 * repository::get_instances() (used by filepicker and texteditor to populate the
74   list of available repositories) now calls repository constructor specifying the
75   context where repository will be used.
76   When checking permissions inside repository class use:
77   $this->instance->contextid - to find the context where repository was created;
78   $this->context - to find the current context where repository is used.
79   This also means that the same repository instance may now have different names when
80   called from different contexts.
81   Avoid calling repository::get_instance(), use repository::get_repository_by_id() instead.
83 === 2.4 ===
85 * copy_to_area() can receive a new parameter called $areamaxbytes which controls the maximum
86   size of the area the files will be stored in.
88 * the repositories using the upload() method should implement a check for $areamaxbytes,
89   see repository/upload/lib.php upload() and process_upload() for an example on how handling it.
91 === 2.3 ===
93 * instance_config_form() must now be declared static for php5.4 compatibility.
95 * get_listing() and search() file metadata details are now now more prominently
96   displayed in the interface. Dates and timestamos are now able to be sorted on in
97   the filepicker interface so plugin authors are asked to ensure:
98     - Dates are defined as UNIX timestamps
99     - Filesize is an integer in bytes
101 * It is recomended to define function get_file_source_info() to provide more rich
102   infromation about the source of a file.
104 * The API was extended to allow repositories can now support external references, please
105   see for further details.