Re: [xwiki-devs] [Brainstorming] What XAR file type for Mail Template pages?

On 8 May 2018, at 12:38, Eduard Moraru <enygma2002(a)gmail.com> wrote: Hi, IMO, it's just like any other page: it depends on the application it is part of and we can't treat them all the same. XWiki.ResetPasswordMailContent should be "default". I see no particular reason to customize the reset password email, as it is a standard feature and it must be synchronized with the code that is calling the template (i.e. any variable bindings define a sort of API that the caller uses. Changing the content also risks breaking that contract, since the caller could be updated while a customized version of this template will not.). The only case I could imagine where the reset password email might be customized would be when there exists no translation for a particular language and an admin might want to translate it on the fly, however, we could treat this as a limitation of the current version and improve it in future versions, just like any other code feature.

Share by email probably also has an email template which should be "default" as well, since the only customization it is designed to support is the actual message included by the user and that is already separate from the template. Other examples? (Notifications probably has its own mechanism for displaying certain notifications or what notifications to send by email)

Thanks, Eduard On Mon, May 7, 2018 at 7:26 PM, Vincent Massol <vincent(a)massol.net> wrote: > > >> On 7 May 2018, at 18:18, Thomas Mortagne <thomas.mortagne(a)xwiki.com> > wrote: >> >> On Mon, May 7, 2018 at 5:02 PM, Vincent Massol <vincent(a)massol.net> > wrote: >>> >>> >>>> On 7 May 2018, at 16:48, Thomas Mortagne <thomas.mortagne(a)xwiki.com> > wrote: >>>> >>>> On Mon, May 7, 2018 at 4:33 PM, Vincent Massol <vincent(a)massol.net> > wrote: >>>>> Hi, >>>>> >>>>> It seems we forgot to handle mail template pages. For example > XWiki.ResetPasswordMailContent >>>>> >>>>> We need to decide the type: demo, default, etc. >>>>> >>>>> WDYT about demo (i.e. as soon as the user starts modifying it, we > don’t upgrade it anymore)? >>>>> >>>>> Thanks >>>>> -Vincent >>>>> >>>> >>>> All types with allowed edit prevent upgrade. >>> >>> I’m not sure we need more than 1 such type. See other mail thread. >>> >>>> I think a more important question is: is it OK to delete it ? >>> >>> We could. See below >>> >>>> >>>> Seems to me delete is not OK in this context. Unless it's possible to >>>> change the mail template used for password reset ? >>> >>> Re delete, I think there’s another thread discussing it, no? I don’t > remember the discussion too well and don’t master all the details but AFAIR > my preference was to not prevent deletion in general (I’m worried about > unplanned use cases requiring a delete, like renaming the page to another > place to save it, and then import some XAR containing the new mail > template). >>> >>> IMO all pages should be deletable without endangering the system. In > this case we could imagine: >>> * if the template is missing then the password reset page would mention > it with the ability to create a default mail template >>> * and/or report a mail error in the admin UI when sending the email > (since the template doesn’t exist). This means that the template factory > for emails should check the existence of the page. This should be handled > here: https://github.com/xwiki/xwiki-platform/blob/ > 6e281a093d3751666fdcd3fb3a69cb638cca9b59/xwiki-platform- > core/xwiki-platform-mail/xwiki-platform-mail-send/ > xwiki-platform-mail-send-default/src/main/java/org/ > xwiki/mail/internal/factory/template/DefaultMailTemplateManager.java#L143 > AFAICS it will currently report a NPE…. >> >> As you said, deleting that page would break reset password feature and >> since I don't plan to rewrite it right now it means delete should be >> protected IMO. If someone improve this feature later then the type can >> be changed to "demo". >> >>> >>> Have we decided what we do about deletes in general? >> >> There hasn't been such discussion. > > I’m referring to http://markmail.org/message/kjtyzvjp5zzh4gyf (and I’m > sure I saw another discussion about that but cannot find it ATM). > > I still don’t understand why we’re mixing upgradability with deletability > (and trying to find names that represent both). Aren’t they 2 different > topics? > > Thanks > -Vincent > >> I don't even understand what this >> mean, it's obvious to me that deleting some pages don't break anything >> while for others you are going to create a huge mess. >> >>> >>> Thanks >>> -Vincent >>> >>>> -- >>>> Thomas Mortagne >>> >> >> >> >> -- >> Thomas Mortagne > >