silverstripe-framework/docs/en/04_Changelogs/4.9.0.md

218 lines
12 KiB
Markdown
Raw Normal View History

# 4.9.0 (Unreleased)
2021-07-31 04:45:24 +02:00
## Overview
2021-09-09 13:06:55 +02:00
A full list of module versions included in CMS Recipe {{ version }} is provided below. We recommend referencing recipes in your dependencies, rather than individual modules, to simplify version tracking. See [Recipes](/getting_started/).
<details>
<summary>Core module versions</summary>
| Module | Version |
| ------ | ------- |
| silverstripe/admin | 1.9.0 |
| silverstripe/asset-admin | 1.9.0 |
| silverstripe/assets | 1.9.0 |
| silverstripe/campaign-admin | 1.9.0 |
| silverstripe/cms | 4.9.0 |
2021-09-09 13:06:55 +02:00
| silverstripe/config | 1.2.0 |
| silverstripe/errorpage | 1.9.0 |
| silverstripe/framework | 4.9.0 |
| silverstripe/graphql | 3.6.0 |
| silverstripe/login-forms | 4.5.0 |
| silverstripe/mimevalidator | 2.2.0 |
| silverstripe/reports | 4.9.0 |
| silverstripe/session-manager | 1.1.0 |
| silverstripe/siteconfig | 4.9.0 |
| silverstripe/versioned | 1.9.0 |
| silverstripe/versioned-admin | 1.9.0 |
</details>
<details>
<summary>Supported module versions</summary>
| Module | Version |
| ------ | ------- |
| bringyourownideas/silverstripe-composer-update-checker | 2.0.3 |
| bringyourownideas/silverstripe-maintenance | 2.3.1 |
| cwp/agency-extensions | 2.5.0 |
| cwp/cwp | 2.8.0 |
| cwp/cwp-core | 2.8.0 |
| cwp/cwp-pdfexport | 1.2.0 |
| cwp/cwp-search | 1.5.0 |
| cwp/starter-theme | 3.2.0 |
| cwp/watea-theme | 3.1.0 |
| dnadesign/silverstripe-elemental | 4.7.0 |
| dnadesign/silverstripe-elemental-userforms | 3.0.0 |
| silverstripe/akismet | 4.1.0 |
| silverstripe/auditor | 2.3.0 |
| silverstripe/blog | 3.8.0 |
| silverstripe/ckan-registry | 1.3.0 |
| silverstripe/comment-notifications | 2.1.0 |
| silverstripe/comments | 3.6.0 |
| silverstripe/content-widget | 2.2.0 |
| silverstripe/contentreview | 4.3.0 |
| silverstripe/controllerpolicy | 2.2.0 |
| silverstripe/crontask | 2.3.0 |
| silverstripe/documentconverter | 2.1.1 |
| silverstripe/elemental-bannerblock | 2.3.0 |
| silverstripe/elemental-fileblock | 2.2.0 |
| silverstripe/environmentcheck | 2.3.0 |
| silverstripe/externallinks | 2.1.1 |
| silverstripe/fulltextsearch | 3.8.0 |
| silverstripe/gridfieldqueuedexport | 2.5.0 |
| silverstripe/html5 | 2.1.0 |
| silverstripe/hybridsessions | 2.3.0 |
| silverstripe/iframe | 2.1.0 |
| silverstripe/ldap | 1.2.1 |
| silverstripe/mfa | 4.4.0 |
| silverstripe/realme | 4.1.1 |
| silverstripe/registry | 2.3.0 |
| silverstripe/restfulserver | 2.3.0 |
| silverstripe/security-extensions | 4.1.0 |
| silverstripe/securityreport | 2.3.0 |
| silverstripe/segment-field | 2.4.0 |
| silverstripe/sharedraftcontent | 2.5.0 |
| silverstripe/sitewidecontent-report | 3.1.0 |
| silverstripe/spamprotection | 3.1.0 |
| silverstripe/spellcheck | 2.2.1 |
| silverstripe/subsites | 2.4.0 |
| silverstripe/tagfield | 2.7.0 |
| silverstripe/taxonomy | 2.2.0 |
| silverstripe/textextraction | 3.2.0 |
| silverstripe/totp-authenticator | 4.2.0 |
| silverstripe/userforms | 5.10.0 |
| silverstripe/versionfeed | 2.1.0 |
| silverstripe/webauthn-authenticator | 4.3.0 |
| silverstripe/widgets | 2.1.1 |
| symbiote/silverstripe-advancedworkflow | 5.5.0 |
| symbiote/silverstripe-multivaluefield | 5.1.0 |
| symbiote/silverstripe-queuedjobs | 4.8.0 |
| tractorcow/silverstripe-fluent | 4.5.1 |
</details>
Upgrading to Recipe {{ version }} is recommended for all sites. This upgrade can be carried out by any development team familiar with Silverstripe.
- [Security audit and regression test](#audit)
- [For development teams of Common Web Platform projects](#cwp-end)
- [Dropping support for Internet Explorer 11](#ie11eol)
2021-07-31 04:45:24 +02:00
- [Features and enhancements](#features-and-enhancements)
- [Image lazy loading](#image-lazy-loading)
2021-08-16 00:39:41 +02:00
- [Manage your CMS sessions across devices](#session-manager)
- [Upgrade to Swiftmailer version 6](#swiftmailer)
2021-07-31 04:45:24 +02:00
- [Other new features](#other-features)
- [Bugfixes](#bugfixes)
## Regression test and Security audit{#audit}
This release has been comprehensively regression tested and passed to a third party for a security-focused audit.
While it is still advised that you perform your own due diligence when upgrading your project, this work is performed to ensure a safe and secure upgrade with each recipe release.
## For development teams of Common Web Platform projects{#cwp-end}
This release marks the first release for Common Web Platform projects to eject out of managing projects in the CWP 2.x version line and to begin following the standard CMS 4.x version line, by adopting the CMS Recipe.
More information and guidance on how to manage your project composer.json file will be published as part of the CMS 4.9.0 stable release and supporting documentation.
2021-07-31 04:45:24 +02:00
## Dropping support for Internet Explorer 11{#ie11eol}
Silverstripe CMS 4.9.0 is the last release of Silverstripe CMS that supports Internet Explorer 11. Silverstripe CMS 4.10.0 will not support Internet Explorer 11.
[Microsoft has announced the end-of-life for Internet Explorer 11](https://blogs.windows.com/windowsexperience/2021/05/19/the-future-of-internet-explorer-on-windows-10-is-in-microsoft-edge/) on June 15, 2022. It has already dropped Internet Explorer support in many other products including Microsoft Teams and Microsoft 365. In this context, any development time dedicated to maintianing Internet Explorer support could be better use improving other areas of Silverstripe CMS.
While the Silverstripe CMS UI might not allow content authors to manage content in Internet Explorer, this does not preclude Silverstripe CMS project from outputting an a frontend site that is compatible with Internet Explorer.
2021-07-31 04:45:24 +02:00
## Features and enhancements {#features-and-enhancements}
### Image lazy loading {#image-lazy-loading}
Most modern browsers support the ability to "lazy load" images. When an image is configured to be
lazy loaded, browsers only request the image once it's about to be visible to the users. This
reduces the initial rendering time for pages.
2021-07-31 04:45:24 +02:00
From v4.9, Silverstripe CMS lazy loads most images by default. You have the options to opt-out of this
behaviour globally or on specific image instances.
2021-07-31 04:45:24 +02:00
This feature was implemented in partnership with Google.
Read [Browser-level image lazy-loading for the web](https://web.dev/browser-level-image-lazy-loading/)
on _web.dev_ more information.
2021-07-31 04:45:24 +02:00
#### How developers can interact with image lazy loading
Most images get the `loading="lazy"` attribute added to them. This includes:
- images added via the HTML Editor's ***insert media*** button
- image DataObjects added to templates.
2021-07-31 04:45:24 +02:00
To disable lazy loading for an individual image in a template, use `$MyImage.LazyLoad(false)`.
Image HTML tags (`<img>`) added in templates are not lazy loaded by default. Developers
can manually lazy load these images by adding a `loading="lazy"` attribute.
Read the [Image Lazy Loading](/Developer_Guides/Files/Images#lazy-loading) Silverstripe CMS developer
documentation for more details and code examples.
#### Opting out of image lazy loading globally
There's some scenarios where you might not want to use the native Silverstripe CMS lazy loading.
For example, you might already have a custom lazy loading implementation.
2021-07-31 04:45:24 +02:00
To opt out of lazy loading globally, use the following yml config:
```yml
SilverStripe\Assets\Image:
lazy_loading_enabled: false
```
#### How content authors can interact with image lazy loading
Content authors can disable lazy loading on images added via the HTML editor field in the
***Insert media*** dialog by setting the ***Loading*** field to ***Eager***.
2021-07-31 04:45:24 +02:00
Consult the [Insert images](https://userhelp.silverstripe.org/en/4/creating_pages_and_content/creating_and_editing_content/inserting_images/#lazy-loading)
article in the Silverstripe CMS user help for detailed instructions.
2021-07-31 04:45:24 +02:00
2021-08-16 00:39:41 +02:00
### Manage your CMS sessions across devices {#session-manager}
The [session manager module](https://github.com/silverstripe/silverstripe-session-manager) is a new security focused feature which allows a CMS user to view and manage their active sessions in the CMS within the "My profile" section of the CMS (/admin/myprofile). They can see the device details behind each session and have the ability to revoke these sessions. This new module has been added to `silverstripe/recipe-cms` which is the recommended method of managing Silverstripe CMS dependencies in a project.
Projects that have `silverstripe/recipe-cms` as a requirement in their `composer.json` will automatically get `silverstripe/session-manager` when you run `composer update`. If your project does not use `silverstripe/recipe-cms`, it's recommended that you require `silverstripe/session-manager` in your composer file as a security enhancement. The session manager module requires no configuration and works out-of-the-box.
If your site has the [symbiote/silverstripe-queuedjobs](https://github.com/symbiote/silverstripe-queuedjobs) module installed, then a job will automatically be created that will periodically remove old database records created by the session manager module.
CMS users can review the [Session Manager user help](https://userhelp.silverstripe.org/en/4/managing_your_website/session_manager/) for more information on managing their sessions.
#### FuntionalTest's should not use `Security::setCurrentUser($member)` when mocking an HTTP request
When writing an automated test using `FuntionalTest` the methods `$this->get()` and `$this->post()` are available to mock HTTP requests. Previously, developers could use the method `Security::setCurrentUser($member)` to define which member those mocked requests would run against.
Because `Security::setCurrentUser()` is *stateless*, its effect only last for the current request. When mocking an HTTP request, session-manager logs out the mocked user if it was defined with `Security::setCurrentUser()`.
Functional tests should use `$this->logInAs($member)` and `$this->logOut()` when mocking HTTP requests. It is still appropriate to use `Security::setCurrentUser()` when testing stateless logic. e.g.: Testing that a `DataObject`'s `canView()` method returns the correct value for the current user.
Review the [Functional Testing developer documentation](/developer_guides/testing/functional_testing/#loginas) for more details on `logInAs()` and `logOut()`.
### Upgrade to Swiftmailer version 6 {#swiftmailer}
2021-08-27 00:19:32 +02:00
Silverstripe CMS provides an API over the top of the [SwiftMailer](http://swiftmailer.org/) PHP library which comes with an extensive list of "transports" for sending mail via different services. Silverstripe CMS 4.9.0 upgrades to Swiftmailer version 6 from version 5.
2021-08-27 00:19:32 +02:00
#### Moving away from _Swift_MailTransport_
Prior to 4.9.0, Silverstripe CMS 4 defaulted to using the built-in PHP `mail()` command via a deprecated class `Swift_MailTransport`. However, the Swiftmailer maintainers have decided to remove this class because of some inherent security flaw in the way the PHP mail function handles the `from` header.
2021-08-27 00:19:32 +02:00
Read this [GitHub comment by a SwiftMailer maintainer](https://github.com/swiftmailer/swiftmailer/issues/866#issuecomment-289291228) for a detailed explanation of the weakness of the PHP mail function.
2021-08-27 00:19:32 +02:00
We have included the deprecated `Swift_MailTransport` class in the `silverstripe/framework` codebase to ensure backward compatibility for project upgrading to Silverstripe Recipe CMS 4.9.0. However, using this layer is less secure and is strongly discouraged.
2021-08-27 00:19:32 +02:00
New Silverstripe CMS project created from `silverstripe/installer` 4.9.0 or greater will default to using the more secure class `Swift_SendmailTransport` which uses a `sendmail` binary.
It's highly recommended that existing Silverstripe CMS installation using `Swift_MailTransport` upgrade to `Swift_SendmailTransport` or another available transport, such as `Swift_SmtpTransport`. Details on how to use these classes are available in the [email section](https://docs.silverstripe.org/en/4/developer_guides/email/) of the developer docs.
2021-07-31 04:45:24 +02:00
### Other new features
* [Dot notation support in form fields](https://github.com/silverstripe/silverstripe-framework/pull/9192): Save directly into nested has_one relationships (see [docs](/developer_guides/forms/how_tos/handle_nested_data)).
2021-07-31 04:45:24 +02:00
## Bugfixes {#bugfixes}
This release includes a number of bug fixes to improve a broad range of areas. Check the change logs for full details of these fixes split by module. Thank you to the community members that helped contribute these fixes as part of the release!