Difference between revisions of "ARK2/Files"
From ARK
(→File Management) |
(→File Management) |
||
| Line 1: | Line 1: | ||
= File Management = | = File Management = | ||
| + | |||
| + | File and Media management have seen major changes in ARK2, with a more flexible system implemented. | ||
| + | |||
| + | * Files are now a core Module instead of a dataclass and look-up table, allowing for flexible metadata based on file type, and using files as either data properties or relationships. | ||
| + | * The file system is abstracted using [http://flysystem.thephpleague.com/ FlySystem] allowing files to be transparently saved locally or to cloud providers. | ||
| + | * File versioning is supported. | ||
| + | * Image management uses [https://github.com/avalanche123/Imagine Imagine]. | ||
| + | |||
| + | The file structure for each instance is as follows: | ||
| + | |||
| + | - files | ||
| + | |-download | ||
| + | |-upload | ||
| + | |-tmp | ||
| + | |-data | ||
| + | |- image | ||
| + | |- <tokens> | ||
| + | |- audio | ||
| + | |- <tokens> | ||
| + | |- video | ||
| + | |- <tokens> | ||
| + | |- text | ||
| + | |- <tokens> | ||
| + | |- document | ||
| + | |- <tokens> | ||
| + | |- other | ||
| + | |- <tokens> | ||
| + | |-thumbs | ||
| + | |- image | ||
| + | |- <tokens> | ||
| + | |- audio | ||
| + | |- <tokens> | ||
| + | |- video | ||
| + | |- <tokens> | ||
| + | |- text | ||
| + | |- <tokens> | ||
| + | |- document | ||
| + | |- <tokens> | ||
| + | |- other | ||
| + | |- <tokens> | ||
| + | |||
| + | |||
| + | == Design Work == | ||
File Manage needs to be flexible and fast. | File Manage needs to be flexible and fast. | ||
Revision as of 18:19, 16 November 2016
File Management
File and Media management have seen major changes in ARK2, with a more flexible system implemented.
- Files are now a core Module instead of a dataclass and look-up table, allowing for flexible metadata based on file type, and using files as either data properties or relationships.
- The file system is abstracted using FlySystem allowing files to be transparently saved locally or to cloud providers.
- File versioning is supported.
- Image management uses Imagine.
The file structure for each instance is as follows:
- files |-download |-upload |-tmp |-data |- image |- <tokens> |- audio |- <tokens> |- video |- <tokens> |- text |- <tokens> |- document |- <tokens> |- other |- <tokens> |-thumbs |- image |- <tokens> |- audio |- <tokens> |- video |- <tokens> |- text |- <tokens> |- document |- <tokens> |- other |- <tokens>
Design Work
File Manage needs to be flexible and fast.
- File attachments to data items
- Data downloads / exports
- Documentation
- Temp files
- Mapping files
- Image management, generated thumbnails, etc
- Metadata, mimetypes, etc
- Cloud storage
- Efficiency
- Security
Current Structure:
- data -- downloads -- files -- mapping -- tmp -- uploads
Problems with current structure:
- All files in one directory, can be slow for large volumes
- Thumbnails in same directory, slows performance, harder to maintain
- No versioning
- No expiry
Full document management and versioning workflow is a stretch goal needed for Avalon. Try use CMIS standard as used in LibreOffice.
Need to plan for moving to advanced model while keeping simple for first release.
- Files are a system module, with modtype for core file type and attributes as required
- Required module properties for title and description, all else optional, some core fields replicated on item table to performance
- Use FlySystem for file system abstraction, extend to allow subpaths to be transparently mounted on.
- Use Imagine for image handling
- Split files into subdirs with max number of files per dir
- Thumbnails into separate dir, managed by image code (on-the-fly creation, etc)
- Support versioning
- Support expiry date for tmp files
- Support mimetypes + core types (image, video, audio, document, text)
Very similar to http://documentation.concrete5.org/developers/working-with-files-and-the-file-manager/overview
