|
|
| (80 intermediate revisions by 15 users not shown) |
| Line 1: |
Line 1: |
| This page describes the specification for a future feature, currently being worked on for Moodle 2.0. This spec is STILL UNDER CONSTRUCTION.
| | {{Template:Migrated|newDocId=/docs/apis/plugintypes/repository}} |
| | | #REDIRECT [[Repository plugins]] |
| See MDL-13766 to track the status of the implementation.
| |
| | |
| The page is open for everyone so everyone can help correct mistakes and help with the evolution of this document. However, if you have questions to ask, problems to report or major changes to suggest, please add them to the [[Development_talk:Repository_API|page comments]], or start a discussion in the [http://moodle.org/mod/forum/view.php?id=1807 Repositories forum]. We'll endeavour to merge all such suggestions into the main spec before we start development.
| |
| | |
| Note that parts of this document have been now split off into a separate [[File_API]]
| |
| | |
| ==Objectives==
| |
| | |
| # Allow all Moodle users to easily bring content into Moodle from external repositories
| |
| # Provide a consistent interface to any external repository, for any Moodle module
| |
| | |
| ==Use cases==
| |
| | |
| ===Teacher adding an external file as a new resource===
| |
| | |
| # Teacher wants to add a new resource to a course | |
| # Teacher clicks the "Choose a resource" button
| |
| # Teacher is presented with a simple file picker to choose a file (with a menu to switch between multiple configured repositories)
| |
| # Teacher chooses a file in an external repository
| |
| # File is COPIED into Moodle and stored by the resource module
| |
| # File is marked as owned by that user
| |
| # Whenever someone wants to view that file, the resource module controls access (see [[File API]] )
| |
| | |
| ===Student submitting an assignment===
| |
| # Student needs to submit an assignment and presses the "Choose files" button
| |
| # Student sees a "file picker" where they can see files listed on any of several configured repositories
| |
| # Student chooses MySpace from the list
| |
| # Student is prompted to enter MySpace username/password (if admin allows it, a checkbox could be there to "remember this for next time" but remember security)
| |
| # Student sees their files in MySpace and chooses one or more
| |
| # Files are copied from MySpace to Moodle
| |
| # Assignment module controls the permissions so that only the Student and assignment graders can see the file (other students would not have permission).
| |
| | |
| ===Student attaching an image to a forum===
| |
| # Student needs to attach an image and presses the "Choose files" button in the posting screen
| |
| # Student sees a "file picker" where they can see files listed on any of several configured repositories
| |
| # Student chooses Mahara from the list
| |
| # Student is prompted to enter Mahara username/password
| |
| # Student sees their files in Mahara and chooses one image
| |
| # Image is copied to Moodle
| |
| # Image file is attached to forum post by Forum module (by reference)
| |
| # Forum module controls permissions so that anyone who can read that forum can see that file
| |
| | |
| ===Student attaching the same image in another forum===
| |
| | |
| # Student needs to submit an assignment and presses the "Choose files" button
| |
| # Student sees a "file picker" where they can see files listed on any of several configured repositories
| |
| # Student chooses "Local files" from the list and sees all the files they've uploaded before
| |
| # A COPY of the image file is attached to forum post by Forum module
| |
| # Forum module controls access to this file.
| |
| | |
| | |
| | |
| Please add more use cases in this same format
| |
| | |
| ==General architecture==
| |
| | |
| Each repository plugin (a standard Moodle plugin stored under /repository/xxx) will subclass the standard API and override methods specific to that repository.
| |
| | |
| As is usual in Moodle, there will be admin settings to disable/enable certain repository plugins as standard, as well as user settings so that users can add their own personal repositories to the standard list (eg [http://briefcase.yahoo.com Yahoo Briefcase] or [http://docs.google.com Google Docs]) and to select their default repository.
| |
| | |
| Once a repository has been used the file will usually be copied into Moodle there and then. However there will also be options to:
| |
| * only return the URL to the file if it's desired to keep it external (but this does present security and integrity risks), or
| |
| * refresh the local file copy regularly and automatically
| |
| * refresh the file manually if desired
| |
| | |
| Once in Moodle, it is subject to the [[File API]] for access control like any other file.
| |
| | |
| ==Repository requirements==
| |
| | |
| From the Moodle point of view, each repository is just a hierarchy of nodes.
| |
| | |
| The repository MUST provide:
| |
| # A URL to download each node (eg file).
| |
| # A list of the nodes (eg files and directories) under a given node (eg directory). This allows Moodle to construct a standard browse interface (much like a standard OS file picker). However some repository plugins may choose to completely override the repository_browse() method and implement their own interface, that's OK, as long as they end up with a URL for the file.
| |
| | |
| The repository can OPTIONALLY:
| |
| # Require some authentication credentials
| |
| # Provide more metadata about each node (mime type, size, dates, related files, dublin core stuff, etc)
| |
| # Describe a search facility (so that Moodle can construct a search form)
| |
| # Provide copyright and usage rules (or just information about the rules)
| |
| | |
| ==Repository plugins==
| |
| | |
| Some plugins I'd like to see developed for the first version are:
| |
| * local - very similar to the current course-based file manager, except user-based
| |
| * moodle - an interface to another Moodle site, accessed over a secure mnet connection
| |
| * jsr170 - an interface that can talk to anything that supports jsr170 (eg [http://www.alfresco.com/ Alfresco])
| |
| * oki - an OKI emulator allowing us to access things with OKI interfaces,like [http://www.fedora.info/ Fedora]
| |
| * briefcase - an interface to [http://briefcase.yahoo.com/ Yahoo Briefcase]
| |
| * myspace - an interface to MySpace files (perhaps via [http://www.programmableweb.com/api/myspace this MySpace API])
| |
| * googledocs - an interface to [http://docs.google.com Google Docs]
| |
| * skydrive - an interface to Microsoft's [http://skydrive.live.com/ SkyDrive] files
| |
| * facebook - an interface to Facebook files
| |
| * merlot - an interface to the learning materials in [http://www.merlot.org/merlot/materials.htm Merlot.org]
| |
| * flickr - an interface to [http://flickr.com flickr]
| |
| * youtube - an interface to [http://youtube.com YouTube]
| |
| * mahara - an interface to a Mahara installation
| |
| * Dspace - a repository from MIT
| |
| * DOOR - another popular open source repository
| |
| * An interface for windows shares e.g. personal folders on network drives. Would need to link with LDAP as usernames will often be wholly/partially the same as network folder names. This could be done using SAMBA, but would also need to work on windows machines natively. See [http://moodle.org/mod/data/view.php?d=13&rid=991 this block] for a linux implementation.
| |
| | |
| ==Tables==
| |
| | |
| === repository ===
| |
| | |
| This table contains one entry for every configured external repository instance.
| |
| | |
| {| border="1" cellpadding="2" cellspacing="0"
| |
| |'''Field'''
| |
| |'''Type'''
| |
| |'''Default'''
| |
| |'''Info'''
| |
| | |
| |-
| |
| |'''id'''
| |
| |int(10)
| |
| |
| |
| |autoincrementing
| |
| | |
| |-
| |
| |repositoryname
| |
| |varchar
| |
| |
| |
| |A custom name for this repository (non-unique)
| |
| | |
| |-
| |
| |'''repositorytype'''
| |
| |varchar
| |
| |
| |
| |The name of the plugin being used (1 special case: "local" which covers all files uploaded from desktop)
| |
| | |
| |-
| |
| |'''userid'''
| |
| |int(10)
| |
| |
| |
| |The person who created this repository instance
| |
| | |
| |-
| |
| |'''contextid'''
| |
| |int(10)
| |
| |
| |
| |The context that this repository is available to ( = system context for site-wide ones)
| |
| | |
| |-
| |
| |username
| |
| |varchar
| |
| |
| |
| |username to log in with, if required
| |
| | |
| |-
| |
| |password
| |
| |varchar
| |
| |
| |
| |password to log in with, if required
| |
| | |
| |-
| |
| |option1
| |
| |varchar
| |
| |
| |
| |Other information useful to the plugin
| |
| | |
| |-
| |
| |option2
| |
| |varchar
| |
| |
| |
| |Other information useful to the plugin
| |
| | |
| |-
| |
| |option3
| |
| |varchar
| |
| |
| |
| |Other information useful to the plugin
| |
| | |
| |-
| |
| |option4
| |
| |varchar
| |
| |
| |
| |Other information useful to the plugin
| |
| | |
| |-
| |
| |option5
| |
| |varchar
| |
| |
| |
| |Other information useful to the plugin
| |
| | |
| |-
| |
| |timecreated
| |
| |int(10)
| |
| |
| |
| |The time this repository was created
| |
| | |
| |-
| |
| |timemodified
| |
| |int(10)
| |
| |
| |
| |The last time the repository was modified
| |
| |}
| |
| | |
| ==Class methods==
| |
| | |
| ===Repository class===
| |
| | |
| This class implements the interface to a particular repository, for browsing, selecting and updating files.
| |
| | |
| ====get_file($path)====
| |
| | |
| ====get_listing($parent='/', $search='''''''')====
| |
| | |
| ====cron()====
| |
| | |
| ====etc====
| |
| | |
| | |
| ==See also==
| |
| | |
| * [[File API]]
| |
| * [[Portfolio API]]
| |
