Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmstr/yii2-filefly-module
https://github.com/dmstr/yii2-filefly-module
api filefly rbac yii2
Last synced: about 4 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/dmstr/yii2-filefly-module
- Owner: dmstr
- Created: 2017-02-17T18:44:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-16T09:11:06.000Z (about 1 month ago)
- Last Synced: 2024-09-17T11:30:29.670Z (8 days ago)
- Topics: api, filefly, rbac, yii2
- Language: PHP
- Size: 239 KB
- Stars: 8
- Watchers: 9
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Yii2 FileFly Module
=======
[](https://packagist.org/packages/dmstr/yii2-filefly-module)
[](https://packagist.org/packages/dmstr/yii2-filefly-module)
[](https://packagist.org/packages/dmstr/yii2-filefly-module)
FlySystem API for [dmstr/yii2-filemanager-widgets](https://github.com/dmstr/yii2-filemanager-widgets)
Installation
------------
#### ENV variables
Variable | Value | Required
------------- | ------------- | -------------
AFM_FILESYSTEM | yii component name | yes
AFM_REPAIR | default: true | no
AFM_SLUG_NAMES | default: true | no
AFM_DELETE_RECURSIVE | default: false | no
i.e. `AFM_FILESYSTEM=fsLocal`
:question: How to configure a filesystem component [Filesystem docs](https://github.com/creocoder/yii2-flysystem/blob/master/README.md)
#### Yii config
```php
'filefly' => [
'class' => 'hrzg\filefly\Module',
'layout' => '@backend/views/layouts/main',
'filesystem' => getenv('AFM_FILESYSTEM'),
'slugNames' => (getenv('AFM_SLUG_NAMES')) ? getenv('AFM_SLUG_NAMES') : true,
'repair' => (getenv('AFM_REPAIR')) ? getenv('AFM_REPAIR') : true,
'deleteRecursive' => (getenv('AFM_DELETE_RECURSIVE')) ? getenv('AFM_DELETE_RECURSIVE') : false,
'streamExpireOffset' => 604800 # Offset (in seconds) for Expires Header in stream action
'defaultPermissions' => [
\hrzg\filefly\Module::ACCESS_OWNER => 1,
\hrzg\filefly\Module::ACCESS_READ => \hrzg\filefly\models\FileflyHashmap::$_all,
\hrzg\filefly\Module::ACCESS_UPDATE => \hrzg\filefly\models\FileflyHashmap::$_all,
\hrzg\filefly\Module::ACCESS_DELETE => \hrzg\filefly\models\FileflyHashmap::$_all,
],
# the urlCallbck property can be used to provide customized urls for each file item which (if defined) will overwrite
# the default handler URLs
'urlCallback' => function($item) {
$urls = [];
$isImageFileExtList = ['jpg', 'jpeg', 'gif', 'tiff', 'tif', 'svg', 'png', 'bmp'] ;
if ($item['type'] === 'file') {
if (in_array(strtolower($item['extension']), $isImageFileExtList)) {
$urls['image url'] = \dmstr\willnorrisImageproxy\Url::image($item['path']);
}
else {
$urls['download url'] = implode('/', ['/img/download', ltrim($item['path'], '/')]) . ',p1';
}
}
return $urls;
},
// previewCallback can be used to overwrite the default downloadUrl for preview URLs within filemanagerApp
'previewCallback' => function($item) {
$isImageFileExtList = ['jpg', 'jpeg', 'gif', 'tiff', 'tif', 'png', 'bmp'] ;
if ($item['type'] === 'file') {
if (in_array(strtolower($item['extension']), $isImageFileExtList)) {
return \dmstr\willnorrisImageproxy\Url::image($item['path'], '500x');
}
}
return '';
}
],
```
## RBAC
**Prosa**
- `FileflyAdmin` full module access including debug information
- `FileflyDefault` management access (eg. POST request for upload, change, delete)
- `FileflyPermissions` assigned users can set or unset roles or permissions which the user himself has assigned
- `access_owner` permission before `access_read`, `access_update`, `access_delete`
- If no permission is set, it will check if any inherited permission can be granted
So if inherited `access_*` permissions should be used, set defaultPermissions to `null` NOT to `'*'`.
```
'defaultPermissions' => [
\hrzg\filefly\Module::ACCESS_OWNER => 1,
\hrzg\filefly\Module::ACCESS_READ => null,
\hrzg\filefly\Module::ACCESS_UPDATE => null,
\hrzg\filefly\Module::ACCESS_DELETE => null,
],
```
**ActiveRecord: FileflyHashmap**
- uses `dmstr\activeRecordPermissions\ActiveRecordAccessTrait` with `$activeAccessTrait = false`
- access checks will be done for each permission type explicitly, `hasPermission($action)`
- uses a `pathValidator` rule to ensure the `path` syntax on active record operations
#### Roles
- FileflyAdmin
- filefly
- FileflyDefault
- filefly_default_index
- FileflyApi
- filefly_api_index
- FileflyPermissions
#### Permissions
- filefly
- filefly_default_index
- filefly_api_index
## RBAC Plugins
Permission checks will ever come after file or folder operation
**GrantPermission**
```
Granted or deny permission
1. access field empty (is owner, true or continue)
2. access field set (permission granted, true)
access field set (is access owner, true, permission denied, false)
```
**SetPermission**
```
Create or update permission
1. Add new hash records
2. Update hash records (recursive option)
- Multi create and update option
```
**RemovePermission**
```
Remove permission
1. Deletes file or folder records
- Multi delete option
```
## CLI
Configure
'controllerMap' => [
'fs' => [
'class' => '\hrzg\filefly\commands\FsController',
'filesystemComponents' => [
'local' => 'fs',
's3' => 'fsS3',
'storage' => 'fsFtp',
],
],
]
## Widget
see https://github.com/dmstr/yii2-filemanager-widgets
```
{{ use ('hrzg/filemanager/widgets') }}
{{ file_manager_widget_widget(
{
"handlerUrl": "/#{app.language}/filefly/api"
}
) }}
```
Options for the yii2-filemanager-widgets Widget can be injected via the Module property `fileManagerWidgetOptions`
example:
```php
'filefly' => [
'filesystemComponents' => [
'ftp' => 'fsFtp',
'ftpcrud' => 'fsFtpCrud',
],
// ...
// other configs
// ...
// Options for the angular fileManagerWidget
'fileManagerWidgetOptions' => [
'searchForm' => false,
'allowedActions' => [
'move' => false,
'upload' => false,
'createFolder' => false,
],
],
],
```
### Controller action in iFrame
Modal button
Load event listener
```
window.addEventListener('load', function () {
var fileflyIframeToggle = document.querySelector('#filefly-iframe-toggle');
var iframe = document.querySelector('#filefly-iframe');
fileflyIframeToggle.addEventListener('click', function () {
iframe.src = "/filefly/default/filemanager-full-screen";
});
});
```
Iframe
```
{{ use ('yii/bootstrap') }}
{{ modal_begin(
{
'id': 'modal-filemanager',
'size': 'modal-lg'
}) }}
{{ modal_end() }}'
```
## Helper
Description | Method call | Example output
--- | --- | ---
Total size for all filesystems | `FileflyHashmap::getTotalSize()` | 202.82 MiB
Total size for all filesystems (raw bytes) | `FileflyHashmap::getTotalSize(true)` | 212670464
Total size for `local` filesystems | `FileflyHashmap::getTotalSize(false, 'local')` | 48.32 MiB
Total size for `s3` filesystems (raw bytes) | `FileflyHashmap::getTotalSize(true, 's3')` | 166546843