Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-48012

Integrate the 'local_recyclebin' plugin into core

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 2.8.1, 3.1
    • Fix Version/s: 3.1
    • Component/s: Backup
    • Labels:
    • Testing Instructions:
      Hide
      Test 1
      1. Run the Behat tests @tool_recyclebin and confirm all is well on the CI servers in behat land.
      2. Run all the PHPUnit tests in admin/tool/recyclebin/tests.
      Test 2
      1. Download the attached 'testhooks.zip' and extract this into the Moodle 'local' folder.
      2. Visit your site administration page and install the plugin.
      3. Delete a block in a course.
      4. Confirm the block_instance table row is shown on the screen with the words 'It works!'.
      5. Delete a course category.
      6. Confirm the course category row is shown on the screen with the words 'It works!'.
      7. Delete a user.
      8. Confirm the user row is shown on the screen with the words 'It works!'.
      9. Quietly weep as you delete this beautiful plugin from your site.
      Show
      Test 1 Run the Behat tests @tool_recyclebin and confirm all is well on the CI servers in behat land. Run all the PHPUnit tests in admin/tool/recyclebin/tests. Test 2 Download the attached 'testhooks.zip' and extract this into the Moodle 'local' folder. Visit your site administration page and install the plugin. Delete a block in a course. Confirm the block_instance table row is shown on the screen with the words 'It works!'. Delete a course category. Confirm the course category row is shown on the screen with the words 'It works!'. Delete a user. Confirm the user row is shown on the screen with the words 'It works!'. Quietly weep as you delete this beautiful plugin from your site.
    • Workaround:
      Hide

      Plugin performing backup of deleted module: https://moodle.org/plugins/view/local_recyclebin

      Show
      Plugin performing backup of deleted module: https://moodle.org/plugins/view/local_recyclebin
    • Affected Branches:
      MOODLE_28_STABLE, MOODLE_31_STABLE
    • Fixed Branches:
      MOODLE_31_STABLE
    • Pull from Repository:
    • Pull Master Branch:
      MDL-48012_master

      Description

      If you delete an activity or resource in error there is no way for a course editor to undo / recover the item.

      Currently the only way to recover items is from either course or database backups. Even then restoring grades back into a live course from a restored (outdated) copy is not always possible.

      The addition of a “recycle bin” would remedy this. This could be achieved by:

      • Adding a deleted field to the course_modules table (course_modules.deleted) with a default value of 0 (not deleted and visible on the course)
      • When an item is deleted this field is set with the current timestamp indicating it has been “deleted”
      • Extend the course_delete_module function. When the function is first called, it checks if the deleted flag in course_modules is 0, if so then set course_modules.deleted = timenow. When the function is called again, if the flag is > 0 then the rest of the function will continue as normal, without interfering with the existing the processes
      • Modify get_course_mods (lib\datalib.php) to exclude deleted items from rendering in the page (and test \ find other areas where the course modules are queried directly)
      • Add a link to “recycle bin” in the course administration block
      • Add a site admin setting “recycle_bin_retention (or similar) which would accept a value in days
      • Add a routine to cron to call delete functions for all items where (timenow – timestamp) > retention period
      • Other processes still to be investigated:
        • Gradebook
        • Access Restrictions
        • Activity Completion
        • Course Completion

      User Interface:

      • Users could delete activities / resources from a course as they do now
      • Users could click a link in the course administration block to go to “recycle bin”
      • The recycle bin would state “items recoverable for x days” at the top of the page (taken from admin setting)
      • Recycle bin would list all recoverable items with:
        • activity / resource title (name)
        • date deleted from course (course_modules.deleted timestamp)
        • date to clear down (timestamp + retention period)
        • button to permanently delete
        • button to restore to course

      Once items reached their expiry date they would automatically be cleared down by a cron process and removed from the list of recoverable items.

      We do not believe there would be any impact on course backup / restore beyond capturing the new course_modules.timestap database field as this code would not be checking the field. Thus any courses backed up / restored should do so with files in the recycle bin / “deleted” status.

      We do not believe we need additional capabilities beyond course:manageactivites particularly as there are no existing capabilities relating specifically to deletion of activites / resources.
      However it may make sense to add a capability for course:recycledelete (or similar) which would control the ability to permanently delete from the recycle bin interface leaving that part of the process to cron.

      Navigation:

      Hide all navigation links from all roles in:

      • Course Page
      • Navigation Block (which expands to show individual links to activities / resources)
      • My Home
      • Course Completion Block
      • Activities Block
      • Gradebook (see below)

      Activity Completion

      There should be no issue with completion tracking as defined in the given resource as these settings are encapsulated within the specific activity / resource

      Restrict Access Rules

      Currently if you delete an activity on which another activity has an access rule set, the other activity shows "(missing)" in the text of the course page.
      If instead of deleting files we set a status for "recycle" then instead of showing "missing" they will show the activity which will still be in the database.

      Resolution of that issue is not only one of concern for any "recycle bin" feature but a wider issue with managing access restrictions. For example if you hide an activity on which another access rule depends there is no warning to indicate students will never be able to access that resource (as the one on which the access rule depends is hidden).

      Thus, for the purpose of this specific feature request It maybe better to ignore / accept this issue until such time as it is addressed in the wider process for managing resources. For example, if there were routines to update the (json?) in course_modules.availability fired on the existing delete method we could call those same routines when sending files to "recycle bin".

      Course Completion

      Course Completion builds a dependency on Activity Completion which could cause issues. Currently it seems if you hide a resource students are still required to complete the activity and can still access the hidden resource via the Course Completion Block?

      If hiding the resource were sufficient to remove it from Course Completion tracking then any "recycle" process could simply hide the resource at the same time it is flagged as being "deleted".

      Again I would suggest these issues are not addressed as part of a "recycle" feature but looked at in a separate tracker if required.

      Gradebook

      • When activities are "deleted" / restored corresponding entries must be made visible / invisible in gradebook (to all roles)
      • We must be able to restore all grades / feedback intact
      • Items in recycle bin must not continue to influence grade aggregation / category weighting

      We may need to accept that category weightings can not be recovered. One reason for this is that we do not know what other changes have been made to category weightings between delete and restore, i.e. the course may have changed between those two points and the original category weightings are no longer valid.

      Considering User Behavior

      Currently a lot of users choose to "hide" resources for a while before deleting them. The presence of a "recycle bin" may encourage users to delete more and hide less which could present a problem if there are limitations on the restore process, losing grade aggregation for example. At a minimum we would need to make any limitations known during the restore process. We could also consider altering messages on delete / recycle.

      Related forum discussion: https://moodle.org/mod/forum/discuss.php?d=274203

        Gliffy Diagrams

          Attachments

            Issue Links

              Activity

                People

                • Votes:
                  34 Vote for this issue
                  Watchers:
                  39 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:
                    Fix Release Date:
                    23/May/16