Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #974 from nextcloud/enh/frontend-api
- Loading branch information
Showing
16 changed files
with
726 additions
and
294 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| ## Frontend integration API | ||
|
|
||
| ### Configuration | ||
|
|
||
| The Collabora configuration for creating new files with their mietype and extension per file type is exposed to `OCA.RichDocuments.config.create`. | ||
|
|
||
| ```json | ||
| { | ||
| "create": { | ||
| "document": { | ||
| "extension": "odt", | ||
| "mime": "application/vnd.oasis.opendocument.text" | ||
| }, | ||
| "spreadsheet": { | ||
| "extension": "ods", | ||
| "mime": "application/vnd.oasis.opendocument.spreadsheet" | ||
| }, | ||
| "presentation": { | ||
| "extension": "odp", | ||
| "mime": "application/vnd.oasis.opendocument.presentation" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Open viewer | ||
|
|
||
|
|
||
| The following two methods are exposed in order to manually trigger the Collabora viewer opening a file: | ||
|
|
||
| #### Open an existing file | ||
|
|
||
| `OCA.RichDocuments.open(params)` will open the Collabora view for an existing file. | ||
|
|
||
| Params requires the following properties: | ||
| - fileId: (string) internal file id | ||
| - path: (string) full path to the file | ||
| - fileModel: (OCA.Files.FileInfoModel) model of the file that will be opened | ||
| - fileList: (object) optional file list object | ||
|
|
||
|
|
||
| ```javascript | ||
| OCA.RichDocuments.open({ | ||
| fileId: 1234, | ||
| path: '/path/to/file.odt', | ||
| fileModel: new OCA.Files.FileInfoModel({...}) | ||
| fileList: FileList | ||
| }) | ||
| ``` | ||
|
|
||
| #### Create a new file from a template | ||
|
|
||
| `OCA.RichDocuments.openWithTemplate(params)` provides a method to open a Collabora view for a file that should be created from a template. Calling this method requires the file to be already present on the filesytem and shown in the file list. | ||
|
|
||
| Params requires the following properties: | ||
| - fileId: (string) internal file id | ||
| - path: (string) full path to the file | ||
| - templateId: (string) file id of the template | ||
| - fileModel: (OCA.Files.FileInfoModel) model of the file that will be opened | ||
| - fileList: (object) optional file list object | ||
|
|
||
| ```javascript | ||
| OCA.RichDocuments.openWithTemplate({ | ||
| fileId: -1, | ||
| path: '/path/to/file.odt, | ||
| templateId: templateId, | ||
| fileModel: new OCA.Files.FileInfoModel({...}) | ||
| }) | ||
| ``` | ||
| Changes to the fileModel should be propagated by triggering a backbone `change` event: | ||
| ```javascript | ||
| window.OCA.RichDocuments.FilesAppIntegration.registerHandler('actionFavorite', (filesAppIntegration) => { | ||
| // custom logic here | ||
| // make sure to trigger a change on the file info model object like this: | ||
| filesAppIntegration.getFileModel().trigger('change', newFileModel) | ||
| return true | ||
| }) | ||
| ``` | ||
| ### Handlers | ||
| Handlers provide a way to hook into the files app integration in order to inject custom behaviour during certain actions. | ||
| The return value indicates if the default behavour should be blocked (true) or still be executed (false). | ||
| The following handlers are currently supported: | ||
| - initAfterReady: will be called once the Collabora frame has been loaded | ||
| - close: will be called after the Collabora view has been closed | ||
| - saveAs: will be called on a save_as response by collabora | ||
| - share: will be called before the default share action is triggered | ||
| - rename: will be called before the default rename action is triggered (the new filename is available as a property of the filesAppIntegration parameter) | ||
| - showRevHistory: will be called before the default show revision history action is triggered | ||
| - insertGraphic: will be called when an image from the Nextcloud storage should be inserted | ||
| - Arguments | ||
| - insertFileFromPath(path): Callback to trigger the actual inserting of the graphic from an absolute file path | ||
| In addition, the following handlers can be used to overwrite the handling of file actions that are rendered in the Nextcloud header bar: | ||
| - actionDetails | ||
| - actionDownload | ||
| - actionFavorite | ||
| The filesAppIntegration parameter can be used to extract the current context of the edited file. The following properties are available for that: | ||
| - fileName | ||
| - fileId | ||
| The callback function of each handler will be called with the following parameters: | ||
| - filesAppIntegration: current instance of the filesAppIntegration object | ||
| - arguments (optional): see list of supported handlers for details | ||
| The following code shows an example on how to register the different handlers: | ||
| ```javascript | ||
| (function() { | ||
| OCA.RichDocuments.FilesAppIntegration.registerHandler('initAfterReady', (filesAppIntegration) => { | ||
| console.debug('called initAfterReady', filesAppIntegration) | ||
| return false | ||
| }) | ||
| OCA.RichDocuments.FilesAppIntegration.registerHandler('close', (filesAppIntegration) => { | ||
| console.debug('called close', filesAppIntegration) | ||
| return false | ||
| }) | ||
| OCA.RichDocuments.FilesAppIntegration.registerHandler('share', (filesAppIntegration) => { | ||
| console.debug('called share', filesAppIntegration) | ||
| return false | ||
| }) | ||
| OCA.RichDocuments.FilesAppIntegration.registerHandler('rename', (filesAppIntegration) => { | ||
| console.debug('called rename', filesAppIntegration) | ||
| return false | ||
| }) | ||
| OCA.RichDocuments.FilesAppIntegration.registerHandler('showRevHistory', (filesAppIntegration) => { | ||
| console.debug('called showRevHistory', filesAppIntegration) | ||
| return false | ||
| }) | ||
| OCA.RichDocuments.FilesAppIntegration.registerHandler('insertGraphic', (filesAppIntegration, { insertFileFromPath }) => { | ||
| const path = prompt('Enter a file path', '') | ||
| insertFileFromPath(path) | ||
| return true | ||
| }) | ||
| })() | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| <?php | ||
|
|
||
| namespace OCA\Richdocuments\Events; | ||
|
|
||
|
|
||
| use OCP\Files\Node; | ||
| use Symfony\Component\EventDispatcher\Event; | ||
|
|
||
| class BeforeFederationRedirectEvent extends Event { | ||
|
|
||
| /** @var Node */ | ||
| private $node; | ||
| /** @var string */ | ||
| private $relativePath; | ||
| /** @var string|null */ | ||
| private $redirectUrl = null; | ||
| /** @var string */ | ||
| private $remote; | ||
|
|
||
| public function __construct($node, $relativePath, $remote) { | ||
| $this->node = $node; | ||
| $this->relativePath = $relativePath; | ||
| $this->remote = $remote; | ||
| } | ||
|
|
||
| public function getRelativePath() { | ||
| return $this->relativePath; | ||
| } | ||
|
|
||
| public function getNode() { | ||
| return $this->node; | ||
| } | ||
|
|
||
| public function getRemote() { | ||
| return $this->remote; | ||
| } | ||
|
|
||
| public function setRedirectUrl($redirectUrl) { | ||
| $this->redirectUrl = $redirectUrl; | ||
| } | ||
|
|
||
| public function getRedirectUrl() { | ||
| return $this->redirectUrl; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.