Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistent location of messge footer/header files #507

Closed
ikedas opened this issue Dec 14, 2018 · 0 comments · Fixed by #514
Closed

Inconsistent location of messge footer/header files #507

ikedas opened this issue Dec 14, 2018 · 0 comments · Fixed by #514
Milestone

Comments

@ikedas
Copy link
Member

ikedas commented Dec 14, 2018

Version

6.2.38 and earlier.

Installation method

Any.

Actual and expected behaviors

Currently, message footer/header files of domain/site default are put in mail_tt2 subdirectory while those of list config are not. I suggest consistent location to put them outside of mail_tt2 subdirectory. For example with message header:

Current location Suggested preferred location
list config $EXPLDIR/list path/message.header $EXPLDIR/list path/message_header
domain default (not available) $SYSCONFDIR/domain/message_header
site-wide default $SYSCONFDIR/mail_tt2/message.header $SYSCONFDIR/message_header

Note: There is another consideration in the proposal above: Since $SYSCONFDIR may have domain subdirectories, name of config files in this directory should not consist only of alphanumeric letters and dots (message.header). That's why file names including _ are suggested.

Additional information

Global message footer (introduced by #301) also applies.


2018-12-14 edit: Corrected the table.

@ikedas ikedas added this to the 6.2.40 milestone Dec 23, 2018
ikedas added a commit to ikedas/sympa that referenced this issue Jan 4, 2019
Fixes:

  - Message footer/header files of domain/site default are put in `mail_tt2` subdirectories while those of list config are not.
    Fixed by put all of them in consistent location without intermediate directories (See also Notes below).
  - Entries for header/footer files in `edit_list.conf` were ignored.

Changes:

  - File names themselves of header/footer were changed:
    `message_header`, `message_header.mime` etc.
    This is due to concideration about conflict between files and directories with domain names (See also Notes below).
  - Header/footer files with `.mime` extension:
    Previously, files with this extension were always preferred, then files without extension were used.  This behavior has not been documented.
    Now files with extension will be searched only in case `footer_type` is `mime`.  Files without extension will be searched in both cases.

Notes:

  - Files with older names/paths in list/domain/site config directories will be copied to new location during upgrading process.
  - Template files with old names in families (`message.header.tt2` etc.) will be used as before and will be copied to new location during instantiation. If files with new names (`message_header.tt2` etc.) will be preferred, if they will be added.

Known bug:

  - There are no web UI to edit global footer (`message_global_footer`).
@ikedas ikedas added the ready A PR is waiting to be merged. Close to be solved label Jan 4, 2019
ikedas added a commit that referenced this issue Jan 30, 2019
Inconsistent location of messge footer/header files #507
@ikedas ikedas removed the ready A PR is waiting to be merged. Close to be solved label Jan 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant