File templates #25090

juliusknorr · 2021-01-12T10:36:54Z

Fixes #22426

Separate pull requests

Add templates directory to example files @jancborchardt Add templates example-files#12

Possible follow up enhancements

Check if we can just expose templates through the direct editing API for mobile clients enh/file-templates...enh/file-templates-direct-editing

Editor app integrations

Text Implement support for creating files from templates text#1352
Collabora Nextcloud 21 compatibility richdocuments#1317
- Introduced the ability to let apps provide additional templates and an event so that Collabora can hook into the creation process to keep track of the template for the wopi handling
ONLYOFFICE
... others?

API endpoints

GET /ocs/v2.php/apps/files/api/v1/templates

Example response:

{
  "ocs": {
    "meta": {
      "status": "ok",
      "statuscode": 200,
      "message": "OK"
    },
    "data": [
      {
        "app": "text",
        "label": "New text file",
        "extension": ".md",
        "mimetypes": [
          "text\/markdown"
        ],
        "templates": [
          {
            "basename": "Meeting minutes.md",
            "etag": "896c403843057e7f26cb1750cf033d3f",
            "fileid": 9577,
            "filename": "\/Templates\/Meeting minutes.md",
            "lastmod": 1610444284,
            "mime": "text\/markdown",
            "size": 78,
            "type": "file",
            "hasPreview": true
          },
          {
            "basename": "Project planning.md",
            "etag": "1ac7b187795872409738f3fd2cfc348a",
            "fileid": 9590,
            "filename": "\/Templates\/Project planning.md",
            "lastmod": 1610377506,
            "mime": "text\/markdown",
            "size": 1,
            "type": "file",
            "hasPreview": true
          }
        ]
      },
      {
        "app": "text",
        "label": "New plain text file",
        "extension": ".txt",
        "mimetypes": [
          "text\/plain"
        ],
        "templates": []
      }
    ]
  }
}

POST /ocs/v2.php/apps/files/api/v1/templates/create

Parameters:

Parameter	Description
filePath	(string) Absolute path to the target file that shall be created in the user home
templatePath	(string) OPTIONAL Absolute path to the template file that will be used as a source, leave empty to create an empty file

200 Success

{
  "ocs": {
    "meta": {
      "status": "ok",
      "statuscode": 200,
      "message": "OK"
    },
    "data": {
      "basename": "newfa1ile.md",
      "etag": "46b90bf0b0c353819b2aed817cd2aae9",
      "fileid": 9644,
      "filename": "\/newfa1ile.md",
      "lastmod": 1610448262,
      "mime": "text\/markdown",
      "size": 78,
      "type": "file",
      "hasPreview": true
    }
  }
}

403

{
  "ocs": {
    "meta": {
      "status": "failure",
      "statuscode": 403,
      "message": "File already exists"
    },
    "data": []
  }
}

POST /ocs/v2.php/apps/files/api/v1/templates/path

Parameters:

Parameter	Description
templatePath	(string) Absolute path to the users template directory in the user home
copySystemTemplates	(bool) OPTIONAL Set to true to copy over system templates to the newly set template path

200 Success

{
  "ocs": {
    "meta": {
      "status": "ok",
      "statuscode": 200,
      "message": "OK"
    },
    "data": []
  }
}

skjnldsv · 2021-01-14T13:29:09Z

skjnldsv · 2021-01-14T13:30:49Z

API endpoint for configuring the user template directory

I think that is fine as is, no? Do we need a custom setting to allow users to change the folder name?

juliusknorr · 2021-01-14T13:48:24Z

I think that is fine as is, no? Do we need a custom setting to allow users to change the folder name?

I think we should still offer changing the path in case you have your templates somewhere else, but I'd leave that to @jancborchardt to decide.

jancborchardt · 2021-01-14T17:09:17Z

Yoooo super nice work @juliushaertl! Already looks very good. 2 small pieces of feedback before I look more into the design and templates:

Can you move the file name input into the "Pick a template" modal, on the top? Then it would be main heading "New text document" and an input field with "File name …" placeholder and below that "Pick a template".
"Empty file" should go first in the list of templates

I think we should still offer changing the path in case you have your templates somewhere else, but I'd leave that to @jancborchardt to decide.

Yes, probably makes sense to have that in the bottom left settings as "Templates folder". Especially if people just sync their normal folders and on different operating systems they have different naming conventions.

juliusknorr · 2021-01-15T07:03:45Z

Forwarding all the praise for the nice looking UI to @skjnldsv 👏

skjnldsv · 2021-01-15T07:11:18Z

Can you move the file name input into the "Pick a template" modal, on the top? Then it would be main heading "New text document" and an input field with "File name …" placeholder and below that "Pick a template".

No, that's not how the new file menu was designed.

"Empty file" should go first in the list of templates

👍

juliusknorr · 2021-01-26T16:35:33Z

Time to get this in 🏓 for reviews

rullzer · 2021-01-27T14:23:46Z

Found some things (maybe they can be done now or in a followup)

For me (so on upgrade) when I set a template folder that options remains. Only upon refresh it goes away.
I can't set an existing folder as template folder with the + menu
I can't seem to change my template folder
With the corresponding text branch I get 2 entries to create text documents?

rullzer

See my comment. I guess some can be moved to follow up tickets some should be fixed here.
But the general concept with text works! Whoohoo

ChristophWurst

some feedback on the OCP changes :)

lib/public/Files/Template/CreatedFromTemplateEvent.php

lib/public/Files/Template/ITemplateManager.php

lib/public/Files/Template/Template.php

juliusknorr · 2021-01-27T17:22:16Z

some feedback on the OCP changes :)

Thanks a lot, makes all sense. I'll adjust that tomorrow morning.

Signed-off-by: Julius Härtl <jus@bitgrid.net>

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>

Signed-off-by: Julius Härtl <jus@bitgrid.net>

…mplates by default Signed-off-by: Julius Härtl <jus@bitgrid.net>

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>

Signed-off-by: Julius Härtl <jus@bitgrid.net>

…isting directories Signed-off-by: Julius Härtl <jus@bitgrid.net>

…type registration lazy Signed-off-by: Julius Härtl <jus@bitgrid.net>

Signed-off-by: Julius Härtl <jus@bitgrid.net>

juliusknorr · 2021-01-28T12:06:45Z

/compile amend /

ChristophWurst · 2021-01-28T12:08:42Z

lib/public/Files/Template/ITemplateManager.php

+	/**
+	 * Register a template type support
+	 *
+	 * @param callable(): TemplateFileCreator $callback A callback which returns the TemplateFileCreator instance to register


nit: @psalm-param callable():TemplateFileCreator $callback

ChristophWurst

Code looks good

ChristophWurst

Tested with Text and works flawless (once I figured out how it actually works, I expected new entries in the + menu somehow)

👍 💯

rullzer

Whoohoo let's go

Signed-off-by: Julius Härtl <jus@bitgrid.net>

juliusknorr · 2021-01-28T13:02:28Z

Ok, bundles happy after i removed the stupid random files i committed 🙈

juliusknorr · 2021-01-28T13:07:52Z

Follow up polishing tasks are in #25358

skjnldsv · 2022-06-09T08:10:01Z

apps/files/js/newfilemenu.js

@@ -198,7 +203,21 @@
 				iconClass: actionSpec.iconClass,
 				fileType: actionSpec.fileType,
 				actionHandler: actionSpec.actionHandler,
-		        });
+				checkFilename: actionSpec.checkFilename


@juliushaertl do you recall why/where we're actually using this?

No I cannot remember anything in that regard 🙈

Also no other occurrence in my local checkouts, so I'd say this can be dropped.

Good! I'll see with the new implementation :)

juliusknorr added 2. developing Work in progress enhancement labels Jan 12, 2021

This comment has been minimized.

Sign in to view

skjnldsv force-pushed the enh/file-templates branch from 37862d2 to 0d50147 Compare January 19, 2021 10:20

juliusknorr force-pushed the enh/file-templates branch 2 times, most recently from 1c9c031 to a899278 Compare January 20, 2021 14:58

juliusknorr mentioned this pull request Jan 22, 2021

Additional templates for Collabora Online nextcloud/richdocuments#1306

Closed

kleener mentioned this pull request Jan 22, 2021

Feature Request: Own templates/assets ONLYOFFICE/onlyoffice-nextcloud#311

Closed

skjnldsv force-pushed the enh/file-templates branch from ba56348 to a474041 Compare January 22, 2021 14:10

juliusknorr force-pushed the enh/file-templates branch from a474041 to e2cd842 Compare January 22, 2021 15:57

juliusknorr marked this pull request as ready for review January 22, 2021 16:10

juliusknorr force-pushed the enh/file-templates branch from e2cd842 to a94db75 Compare January 22, 2021 16:10

juliusknorr added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Jan 22, 2021

juliusknorr requested review from MorrisJobke, ChristophWurst, rullzer, julien-nc and jancborchardt January 22, 2021 16:12

juliusknorr added this to the Nextcloud 21 milestone Jan 22, 2021

juliusknorr force-pushed the enh/file-templates branch from a94db75 to 4fc3d42 Compare January 26, 2021 16:29

rullzer requested changes Jan 27, 2021

View reviewed changes

ChristophWurst reviewed Jan 27, 2021

View reviewed changes

juliusknorr and others added 10 commits January 28, 2021 11:59

files: Create files from template API

4974404

Signed-off-by: Julius Härtl <jus@bitgrid.net>

Add template picker

78e114e

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>

Add ratio to template creators

66fa3fc

Signed-off-by: Julius Härtl <jus@bitgrid.net>

Add templatedirectory config value to let admins have their custom te…

7e6d69d

…mplates by default Signed-off-by: Julius Härtl <jus@bitgrid.net>

Skip template picker if none available

4f90766

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>

Only create template directory if it is present in the default skeleton

0111381

Signed-off-by: Julius Härtl <jus@bitgrid.net>

Hide new template directory entry after creating and allow setting ex…

2d46971

…isting directories Signed-off-by: Julius Härtl <jus@bitgrid.net>

Move TemplateProvider registration to boot context and make template …

6c1b357

…type registration lazy Signed-off-by: Julius Härtl <jus@bitgrid.net>

Make whole Template class final

a71bb8a

Signed-off-by: Julius Härtl <jus@bitgrid.net>

Fix button size

0771194

Signed-off-by: Julius Härtl <jus@bitgrid.net>

juliusknorr force-pushed the enh/file-templates branch from bb6fdd4 to c1a25ea Compare January 28, 2021 11:02

juliusknorr requested a review from ChristophWurst January 28, 2021 11:03

ChristophWurst reviewed Jan 28, 2021

View reviewed changes

ChristophWurst approved these changes Jan 28, 2021

View reviewed changes

juliusknorr force-pushed the enh/file-templates branch from c1a25ea to 5197006 Compare January 28, 2021 12:25

rullzer approved these changes Jan 28, 2021

View reviewed changes

Bump bundles

63a2ea8

Signed-off-by: Julius Härtl <jus@bitgrid.net>

juliusknorr force-pushed the enh/file-templates branch from af18372 to 63a2ea8 Compare January 28, 2021 12:53

juliusknorr mentioned this pull request Jan 28, 2021

Templates polishing #25358

Open

5 tasks

rullzer merged commit 62fa85c into master Jan 28, 2021

rullzer deleted the enh/file-templates branch January 28, 2021 15:17

ChristophWurst added the pending documentation This pull request needs an associated documentation update label Jan 28, 2021

biva mentioned this pull request May 6, 2022

Error while creating the new file from template ONLYOFFICE/onlyoffice-nextcloud#524

Open

skjnldsv reviewed Jun 9, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

File templates #25090

File templates #25090

juliusknorr commented Jan 12, 2021 •

edited by skjnldsv

Loading

This comment has been minimized.

skjnldsv commented Jan 14, 2021

skjnldsv commented Jan 14, 2021

juliusknorr commented Jan 14, 2021

jancborchardt commented Jan 14, 2021

juliusknorr commented Jan 15, 2021

skjnldsv commented Jan 15, 2021

juliusknorr commented Jan 26, 2021

rullzer commented Jan 27, 2021 •

edited by juliusknorr

Loading

rullzer left a comment

ChristophWurst left a comment

juliusknorr commented Jan 27, 2021

juliusknorr commented Jan 28, 2021

ChristophWurst Jan 28, 2021

ChristophWurst left a comment

ChristophWurst left a comment

rullzer left a comment

juliusknorr commented Jan 28, 2021

juliusknorr commented Jan 28, 2021

skjnldsv Jun 9, 2022 •

edited

Loading

juliusknorr Jun 9, 2022

skjnldsv Jun 9, 2022

File templates #25090

File templates #25090

Conversation

juliusknorr commented Jan 12, 2021 • edited by skjnldsv Loading

Separate pull requests

Possible follow up enhancements

Editor app integrations

API endpoints

200 Success

403

200 Success

This comment has been minimized.

skjnldsv commented Jan 14, 2021

skjnldsv commented Jan 14, 2021

juliusknorr commented Jan 14, 2021

jancborchardt commented Jan 14, 2021

juliusknorr commented Jan 15, 2021

skjnldsv commented Jan 15, 2021

juliusknorr commented Jan 26, 2021

rullzer commented Jan 27, 2021 • edited by juliusknorr Loading

rullzer left a comment

Choose a reason for hiding this comment

ChristophWurst left a comment

Choose a reason for hiding this comment

juliusknorr commented Jan 27, 2021

juliusknorr commented Jan 28, 2021

ChristophWurst Jan 28, 2021

Choose a reason for hiding this comment

ChristophWurst left a comment

Choose a reason for hiding this comment

ChristophWurst left a comment

Choose a reason for hiding this comment

rullzer left a comment

Choose a reason for hiding this comment

juliusknorr commented Jan 28, 2021

juliusknorr commented Jan 28, 2021

skjnldsv Jun 9, 2022 • edited Loading

Choose a reason for hiding this comment

juliusknorr Jun 9, 2022

Choose a reason for hiding this comment

skjnldsv Jun 9, 2022

Choose a reason for hiding this comment

juliusknorr commented Jan 12, 2021 •

edited by skjnldsv

Loading

rullzer commented Jan 27, 2021 •

edited by juliusknorr

Loading

skjnldsv Jun 9, 2022 •

edited

Loading