├── .gitignore ├── Block ├── Adminhtml │ └── Form │ │ └── Field │ │ ├── CrossOriginSupport.php │ │ ├── PreloadType.php │ │ └── ResourceHintType.php └── System │ └── Config │ └── Form │ └── Field │ └── FieldArray.php ├── CODE_OF_CONDUCT.md ├── LICENSE ├── Model ├── Configuration.php ├── ConfigurationInterface.php └── PrepareResources.php ├── Observer └── Framework │ └── View │ └── Layout │ └── Builder.php ├── README.md ├── composer.json ├── etc ├── adminhtml │ └── system.xml ├── di.xml ├── frontend │ └── events.xml └── module.xml ├── package.json └── registration.php /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea 2 | .DS_Store -------------------------------------------------------------------------------- /Block/Adminhtml/Form/Field/CrossOriginSupport.php: -------------------------------------------------------------------------------- 1 | 'No', 43 | '1' => 'Yes' 44 | ]; 45 | 46 | /** 47 | * PreloadType constructor. 48 | * 49 | * @param Context $context 50 | * @param array $data 51 | */ 52 | public function __construct( 53 | Context $context, 54 | array $data = [] 55 | ) { 56 | parent::__construct($context, $data); 57 | } 58 | 59 | /** 60 | * @return string 61 | */ 62 | public function _toHtml() 63 | { 64 | if (!$this->getOptions()) { 65 | foreach ($this->_options as $value => $label) { 66 | $this->addOption($value, $label); 67 | } 68 | } 69 | 70 | $this->setClass('input-select'); 71 | 72 | return parent::_toHtml(); 73 | } 74 | 75 | /** 76 | * @param $value 77 | * 78 | * @return mixed 79 | */ 80 | public function setInputName($value) 81 | { 82 | return $this->setName($value); 83 | } 84 | } 85 | -------------------------------------------------------------------------------- /Block/Adminhtml/Form/Field/PreloadType.php: -------------------------------------------------------------------------------- 1 | 'Script', 43 | 'style' => 'Style', 44 | 'font' => 'Font', 45 | 'image' => 'Image', 46 | 'fetch' => 'Fetch/XHR', 47 | 'document' => 'Document' 48 | ]; 49 | 50 | /** 51 | * PreloadType constructor. 52 | * 53 | * @param Context $context 54 | * @param array $data 55 | */ 56 | public function __construct( 57 | Context $context, 58 | array $data = [] 59 | ) { 60 | parent::__construct($context, $data); 61 | } 62 | 63 | /** 64 | * @return string 65 | */ 66 | public function _toHtml() 67 | { 68 | if (!$this->getOptions()) { 69 | foreach ($this->_options as $value => $label) { 70 | $this->addOption($value, $label); 71 | } 72 | } 73 | 74 | $this->setClass('input-select required-entry'); 75 | $this->setExtraParams('style="width: 100px;"'); 76 | 77 | return parent::_toHtml(); 78 | } 79 | 80 | /** 81 | * @param $value 82 | * 83 | * @return mixed 84 | */ 85 | public function setInputName($value) 86 | { 87 | return $this->setName($value); 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /Block/Adminhtml/Form/Field/ResourceHintType.php: -------------------------------------------------------------------------------- 1 | 'Preload', 19 | 'preconnect' => 'Preconnect', 20 | 'prefetch' => 'Prefetch', 21 | 'dns-prefetch' => 'DNS Prefetch', 22 | ]; 23 | 24 | /** 25 | * ResourceHintType constructor. 26 | * 27 | * @param Context $context 28 | * @param array $data 29 | */ 30 | public function __construct( 31 | Context $context, 32 | array $data = [] 33 | ) { 34 | parent::__construct($context, $data); 35 | } 36 | 37 | /** 38 | * @return string 39 | */ 40 | public function _toHtml() 41 | { 42 | if (!$this->getOptions()) { 43 | foreach ($this->_options as $value => $label) { 44 | $this->addOption($value, $label); 45 | } 46 | } 47 | 48 | $this->setClass('input-select required-entry'); 49 | $this->setExtraParams('style="width: 125px;"'); 50 | 51 | return parent::_toHtml(); 52 | } 53 | 54 | /** 55 | * @param $value 56 | * 57 | * @return mixed 58 | */ 59 | public function setInputName($value) 60 | { 61 | return $this->setName($value); 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /Block/System/Config/Form/Field/FieldArray.php: -------------------------------------------------------------------------------- 1 | _addButtonLabel = __('Add Resource Hint'); 40 | } 41 | 42 | /** 43 | * @return \Magento\Framework\View\Element\BlockInterface 44 | * @throws \Magento\Framework\Exception\LocalizedException 45 | */ 46 | private function listResourceHintTypes() 47 | { 48 | if (!$this->resourceTypeRenderer) { 49 | $this->resourceTypeRenderer = $this->getLayout()->createBlock( 50 | '\Dan0sz\ResourceHints\Block\Adminhtml\Form\Field\ResourceHintType', 51 | '', 52 | ['data' => ['is_render_to_js_template' => true]] 53 | ); 54 | } 55 | 56 | return $this->resourceTypeRenderer; 57 | } 58 | 59 | /** 60 | * @return \Magento\Framework\View\Element\BlockInterface 61 | * @throws \Magento\Framework\Exception\LocalizedException 62 | */ 63 | private function listPreloadTypes() 64 | { 65 | if (!$this->preloadTypeRenderer) { 66 | $this->preloadTypeRenderer = $this->getLayout()->createBlock( 67 | '\Dan0sz\ResourceHints\Block\Adminhtml\Form\Field\PreloadType', 68 | '', 69 | ['data' => ['is_render_to_js_template' => true]] 70 | ); 71 | } 72 | 73 | return $this->preloadTypeRenderer; 74 | } 75 | 76 | /** 77 | * @return string 78 | */ 79 | private function renderCrossOriginSupport() 80 | { 81 | if (!$this->crossOriginSupportRenderer) { 82 | $this->crossOriginSupportRenderer = $this->getLayout()->createBlock( 83 | '\Dan0sz\ResourceHints\Block\Adminhtml\Form\Field\CrossOriginSupport', 84 | '', 85 | ['data' => ['is_render_to_js_template' => true]] 86 | ); 87 | } 88 | 89 | return $this->crossOriginSupportRenderer; 90 | } 91 | 92 | /** 93 | * @throws \Magento\Framework\Exception\LocalizedException 94 | */ 95 | protected function _prepareToRender() 96 | { 97 | $this->addColumn( 98 | 'type', 99 | [ 100 | 'label' => __('Type'), 101 | 'renderer' => $this->listResourceHintTypes(), 102 | ] 103 | ); 104 | $this->addColumn( 105 | 'resource', 106 | [ 107 | 'label' => __('Resource') 108 | ] 109 | ); 110 | $this->addColumn( 111 | 'sort_order', 112 | [ 113 | 'label' => __('Sort Order') 114 | ] 115 | ); 116 | $this->addColumn( 117 | 'preload_as', 118 | [ 119 | 'label' => __('Preload as'), 120 | 'renderer' => $this->listPreloadTypes() 121 | ] 122 | ); 123 | $this->addColumn( 124 | 'cross_origin', 125 | [ 126 | 'label' => __('Enable CORS Support'), 127 | 'renderer' => $this->renderCrossOriginSupport() 128 | ] 129 | ); 130 | $this->_addAfter = false; 131 | } 132 | 133 | /** 134 | * @param \Magento\Framework\DataObject $row 135 | * 136 | * @throws \Magento\Framework\Exception\LocalizedException 137 | */ 138 | protected function _prepareArrayRow(\Magento\Framework\DataObject $row) 139 | { 140 | $type = $row->getType(); 141 | $options = []; 142 | 143 | if ($type) { 144 | $options['option_' . $this->listResourceHintTypes()->calcOptionHash($type)] = 'selected="selected"'; 145 | } 146 | 147 | $preloadAs = $row->getPreloadAs(); 148 | 149 | if ($preloadAs) { 150 | $options['option_' . $this->listPreloadTypes()->calcOptionHash($preloadAs)] = 'selected="selected"'; 151 | } 152 | 153 | $crossOriginSupport = $row->getCrossOrigin(); 154 | 155 | if ($crossOriginSupport) { 156 | $options['option_' . $this->renderCrossOriginSupport()->calcOptionHash($crossOriginSupport)] = 'selected="selected"'; 157 | } 158 | 159 | $row->setData('option_extra_attrs', $options); 160 | } 161 | 162 | /** 163 | * @param string $columnName 164 | * 165 | * @return string 166 | * @throws \Exception 167 | */ 168 | public function renderCellTemplate($columnName) 169 | { 170 | if ($columnName == "type") { 171 | $this->_columns[$columnName]['class'] = 'input-select required-entry'; 172 | } 173 | 174 | if ($columnName == 'resource') { 175 | $this->_columns[$columnName]['class'] = 'input-text required-entry'; 176 | $this->_columns[$columnName]['style'] = 'width: 200px'; 177 | } 178 | 179 | if ($columnName == 'sort_order') { 180 | $this->_columns[$columnName]['class'] = 'input-text required-entry validate-number'; 181 | $this->_columns[$columnName]['style'] = 'width: 50px'; 182 | } 183 | 184 | if ($columnName == "preload_as") { 185 | $this->_columns[$columnName]['class'] = 'input-select'; 186 | } 187 | 188 | if ($columnName == 'cross_origin') { 189 | $this->_columns[$columnName]['class'] = 'input-select'; 190 | } 191 | 192 | return parent::renderCellTemplate($columnName); 193 | } 194 | } 195 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at info@daan.dev. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Attribution 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More_considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution 4.0 International Public License 58 | 59 | By exercising the Licensed Rights (defined below), You accept and agree 60 | to be bound by the terms and conditions of this Creative Commons 61 | Attribution 4.0 International Public License ("Public License"). To the 62 | extent this Public License may be interpreted as a contract, You are 63 | granted the Licensed Rights in consideration of Your acceptance of 64 | these terms and conditions, and the Licensor grants You such rights in 65 | consideration of benefits the Licensor receives from making the 66 | Licensed Material available under these terms and conditions. 67 | 68 | 69 | Section 1 -- Definitions. 70 | 71 | a. Adapted Material means material subject to Copyright and Similar 72 | Rights that is derived from or based upon the Licensed Material 73 | and in which the Licensed Material is translated, altered, 74 | arranged, transformed, or otherwise modified in a manner requiring 75 | permission under the Copyright and Similar Rights held by the 76 | Licensor. For purposes of this Public License, where the Licensed 77 | Material is a musical work, performance, or sound recording, 78 | Adapted Material is always produced where the Licensed Material is 79 | synched in timed relation with a moving image. 80 | 81 | b. Adapter's License means the license You apply to Your Copyright 82 | and Similar Rights in Your contributions to Adapted Material in 83 | accordance with the terms and conditions of this Public License. 84 | 85 | c. Copyright and Similar Rights means copyright and/or similar rights 86 | closely related to copyright including, without limitation, 87 | performance, broadcast, sound recording, and Sui Generis Database 88 | Rights, without regard to how the rights are labeled or 89 | categorized. For purposes of this Public License, the rights 90 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 91 | Rights. 92 | 93 | d. Effective Technological Measures means those measures that, in the 94 | absence of proper authority, may not be circumvented under laws 95 | fulfilling obligations under Article 11 of the WIPO Copyright 96 | Treaty adopted on December 20, 1996, and/or similar international 97 | agreements. 98 | 99 | e. Exceptions and Limitations means fair use, fair dealing, and/or 100 | any other exception or limitation to Copyright and Similar Rights 101 | that applies to Your use of the Licensed Material. 102 | 103 | f. Licensed Material means the artistic or literary work, database, 104 | or other material to which the Licensor applied this Public 105 | License. 106 | 107 | g. Licensed Rights means the rights granted to You subject to the 108 | terms and conditions of this Public License, which are limited to 109 | all Copyright and Similar Rights that apply to Your use of the 110 | Licensed Material and that the Licensor has authority to license. 111 | 112 | h. Licensor means the individual(s) or entity(ies) granting rights 113 | under this Public License. 114 | 115 | i. Share means to provide material to the public by any means or 116 | process that requires permission under the Licensed Rights, such 117 | as reproduction, public display, public performance, distribution, 118 | dissemination, communication, or importation, and to make material 119 | available to the public including in ways that members of the 120 | public may access the material from a place and at a time 121 | individually chosen by them. 122 | 123 | j. Sui Generis Database Rights means rights other than copyright 124 | resulting from Directive 96/9/EC of the European Parliament and of 125 | the Council of 11 March 1996 on the legal protection of databases, 126 | as amended and/or succeeded, as well as other essentially 127 | equivalent rights anywhere in the world. 128 | 129 | k. You means the individual or entity exercising the Licensed Rights 130 | under this Public License. Your has a corresponding meaning. 131 | 132 | 133 | Section 2 -- Scope. 134 | 135 | a. License grant. 136 | 137 | 1. Subject to the terms and conditions of this Public License, 138 | the Licensor hereby grants You a worldwide, royalty-free, 139 | non-sublicensable, non-exclusive, irrevocable license to 140 | exercise the Licensed Rights in the Licensed Material to: 141 | 142 | a. reproduce and Share the Licensed Material, in whole or 143 | in part; and 144 | 145 | b. produce, reproduce, and Share Adapted Material. 146 | 147 | 2. Exceptions and Limitations. For the avoidance of doubt, where 148 | Exceptions and Limitations apply to Your use, this Public 149 | License does not apply, and You do not need to comply with 150 | its terms and conditions. 151 | 152 | 3. Term. The term of this Public License is specified in Section 153 | 6(a). 154 | 155 | 4. Media and formats; technical modifications allowed. The 156 | Licensor authorizes You to exercise the Licensed Rights in 157 | all media and formats whether now known or hereafter created, 158 | and to make technical modifications necessary to do so. The 159 | Licensor waives and/or agrees not to assert any right or 160 | authority to forbid You from making technical modifications 161 | necessary to exercise the Licensed Rights, including 162 | technical modifications necessary to circumvent Effective 163 | Technological Measures. For purposes of this Public License, 164 | simply making modifications authorized by this Section 2(a) 165 | (4) never produces Adapted Material. 166 | 167 | 5. Downstream recipients. 168 | 169 | a. Offer from the Licensor -- Licensed Material. Every 170 | recipient of the Licensed Material automatically 171 | receives an offer from the Licensor to exercise the 172 | Licensed Rights under the terms and conditions of this 173 | Public License. 174 | 175 | b. No downstream restrictions. You may not offer or impose 176 | any additional or different terms or conditions on, or 177 | apply any Effective Technological Measures to, the 178 | Licensed Material if doing so restricts exercise of the 179 | Licensed Rights by any recipient of the Licensed 180 | Material. 181 | 182 | 6. No endorsement. Nothing in this Public License constitutes or 183 | may be construed as permission to assert or imply that You 184 | are, or that Your use of the Licensed Material is, connected 185 | with, or sponsored, endorsed, or granted official status by, 186 | the Licensor or others designated to receive attribution as 187 | provided in Section 3(a)(1)(A)(i). 188 | 189 | b. Other rights. 190 | 191 | 1. Moral rights, such as the right of integrity, are not 192 | licensed under this Public License, nor are publicity, 193 | privacy, and/or other similar personality rights; however, to 194 | the extent possible, the Licensor waives and/or agrees not to 195 | assert any such rights held by the Licensor to the limited 196 | extent necessary to allow You to exercise the Licensed 197 | Rights, but not otherwise. 198 | 199 | 2. Patent and trademark rights are not licensed under this 200 | Public License. 201 | 202 | 3. To the extent possible, the Licensor waives any right to 203 | collect royalties from You for the exercise of the Licensed 204 | Rights, whether directly or through a collecting society 205 | under any voluntary or waivable statutory or compulsory 206 | licensing scheme. In all other cases the Licensor expressly 207 | reserves any right to collect such royalties. 208 | 209 | 210 | Section 3 -- License Conditions. 211 | 212 | Your exercise of the Licensed Rights is expressly made subject to the 213 | following conditions. 214 | 215 | a. Attribution. 216 | 217 | 1. If You Share the Licensed Material (including in modified 218 | form), You must: 219 | 220 | a. retain the following if it is supplied by the Licensor 221 | with the Licensed Material: 222 | 223 | i. identification of the creator(s) of the Licensed 224 | Material and any others designated to receive 225 | attribution, in any reasonable manner requested by 226 | the Licensor (including by pseudonym if 227 | designated); 228 | 229 | ii. a copyright notice; 230 | 231 | iii. a notice that refers to this Public License; 232 | 233 | iv. a notice that refers to the disclaimer of 234 | warranties; 235 | 236 | v. a URI or hyperlink to the Licensed Material to the 237 | extent reasonably practicable; 238 | 239 | b. indicate if You modified the Licensed Material and 240 | retain an indication of any previous modifications; and 241 | 242 | c. indicate the Licensed Material is licensed under this 243 | Public License, and include the text of, or the URI or 244 | hyperlink to, this Public License. 245 | 246 | 2. You may satisfy the conditions in Section 3(a)(1) in any 247 | reasonable manner based on the medium, means, and context in 248 | which You Share the Licensed Material. For example, it may be 249 | reasonable to satisfy the conditions by providing a URI or 250 | hyperlink to a resource that includes the required 251 | information. 252 | 253 | 3. If requested by the Licensor, You must remove any of the 254 | information required by Section 3(a)(1)(A) to the extent 255 | reasonably practicable. 256 | 257 | 4. If You Share Adapted Material You produce, the Adapter's 258 | License You apply must not prevent recipients of the Adapted 259 | Material from complying with this Public License. 260 | 261 | 262 | Section 4 -- Sui Generis Database Rights. 263 | 264 | Where the Licensed Rights include Sui Generis Database Rights that 265 | apply to Your use of the Licensed Material: 266 | 267 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 268 | to extract, reuse, reproduce, and Share all or a substantial 269 | portion of the contents of the database; 270 | 271 | b. if You include all or a substantial portion of the database 272 | contents in a database in which You have Sui Generis Database 273 | Rights, then the database in which You have Sui Generis Database 274 | Rights (but not its individual contents) is Adapted Material; and 275 | 276 | c. You must comply with the conditions in Section 3(a) if You Share 277 | all or a substantial portion of the contents of the database. 278 | 279 | For the avoidance of doubt, this Section 4 supplements and does not 280 | replace Your obligations under this Public License where the Licensed 281 | Rights include other Copyright and Similar Rights. 282 | 283 | 284 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 285 | 286 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 287 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 288 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 289 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 290 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 291 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 292 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 293 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 294 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 295 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 296 | 297 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 298 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 299 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 300 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 301 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 302 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 303 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 304 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 305 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 306 | 307 | c. The disclaimer of warranties and limitation of liability provided 308 | above shall be interpreted in a manner that, to the extent 309 | possible, most closely approximates an absolute disclaimer and 310 | waiver of all liability. 311 | 312 | 313 | Section 6 -- Term and Termination. 314 | 315 | a. This Public License applies for the term of the Copyright and 316 | Similar Rights licensed here. However, if You fail to comply with 317 | this Public License, then Your rights under this Public License 318 | terminate automatically. 319 | 320 | b. Where Your right to use the Licensed Material has terminated under 321 | Section 6(a), it reinstates: 322 | 323 | 1. automatically as of the date the violation is cured, provided 324 | it is cured within 30 days of Your discovery of the 325 | violation; or 326 | 327 | 2. upon express reinstatement by the Licensor. 328 | 329 | For the avoidance of doubt, this Section 6(b) does not affect any 330 | right the Licensor may have to seek remedies for Your violations 331 | of this Public License. 332 | 333 | c. For the avoidance of doubt, the Licensor may also offer the 334 | Licensed Material under separate terms or conditions or stop 335 | distributing the Licensed Material at any time; however, doing so 336 | will not terminate this Public License. 337 | 338 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 339 | License. 340 | 341 | 342 | Section 7 -- Other Terms and Conditions. 343 | 344 | a. The Licensor shall not be bound by any additional or different 345 | terms or conditions communicated by You unless expressly agreed. 346 | 347 | b. Any arrangements, understandings, or agreements regarding the 348 | Licensed Material not stated herein are separate from and 349 | independent of the terms and conditions of this Public License. 350 | 351 | 352 | Section 8 -- Interpretation. 353 | 354 | a. For the avoidance of doubt, this Public License does not, and 355 | shall not be interpreted to, reduce, limit, restrict, or impose 356 | conditions on any use of the Licensed Material that could lawfully 357 | be made without permission under this Public License. 358 | 359 | b. To the extent possible, if any provision of this Public License is 360 | deemed unenforceable, it shall be automatically reformed to the 361 | minimum extent necessary to make it enforceable. If the provision 362 | cannot be reformed, it shall be severed from this Public License 363 | without affecting the enforceability of the remaining terms and 364 | conditions. 365 | 366 | c. No term or condition of this Public License will be waived and no 367 | failure to comply consented to unless expressly agreed to by the 368 | Licensor. 369 | 370 | d. Nothing in this Public License constitutes or may be interpreted 371 | as a limitation upon, or waiver of, any privileges and immunities 372 | that apply to the Licensor or You, including from the legal 373 | processes of any jurisdiction or authority. 374 | 375 | 376 | ======================================================================= 377 | 378 | Creative Commons is not a party to its public 379 | licenses. Notwithstanding, Creative Commons may elect to apply one of 380 | its public licenses to material it publishes and in those instances 381 | will be considered the “Licensor.” The text of the Creative Commons 382 | public licenses is dedicated to the public domain under the CC0 Public 383 | Domain Dedication. Except for the limited purpose of indicating that 384 | material is shared under a Creative Commons public license or as 385 | otherwise permitted by the Creative Commons policies published at 386 | creativecommons.org/policies, Creative Commons does not authorize the 387 | use of the trademark "Creative Commons" or any other trademark or logo 388 | of Creative Commons without its prior written consent including, 389 | without limitation, in connection with any unauthorized modifications 390 | to any of its public licenses or any other arrangements, 391 | understandings, or agreements concerning use of licensed material. For 392 | the avoidance of doubt, this paragraph does not form part of the 393 | public licenses. 394 | 395 | Creative Commons may be contacted at creativecommons.org. 396 | 397 | -------------------------------------------------------------------------------- /Model/Configuration.php: -------------------------------------------------------------------------------- 1 | scopeConfig = $scopeConfig; 25 | } 26 | 27 | /** 28 | * @inheritDoc 29 | */ 30 | public function getResourceHints($store = null) 31 | { 32 | if (null !== $this->resourceHints) { 33 | return $this->resourceHints; 34 | } 35 | return $this->scopeConfig->getValue( 36 | self::WEB_CONFIG_RESOURCE_HINTS, 37 | ScopeInterface::SCOPE_STORE, 38 | $store 39 | ); 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /Model/ConfigurationInterface.php: -------------------------------------------------------------------------------- 1 | configuration = $configuration; 44 | $this->collectionFactory = $collectionFactory; 45 | $this->dataObjectFactory = $dataObjectFactory; 46 | $this->json = $json; 47 | $this->jsonValidator = $jsonValidator; 48 | $this->assetRepository = $assetRepository; 49 | } 50 | 51 | /** 52 | * Get collection 53 | * 54 | * @return mixed 55 | */ 56 | public function getCollection() 57 | { 58 | $resources = $this->getResourceHintsFromConfig(); 59 | return $this->getResourceHintsCollection($resources); 60 | } 61 | 62 | /** 63 | * Get config 64 | * 65 | * @return null|string|bool|int 66 | */ 67 | private function getResourceHintsFromConfig() 68 | { 69 | return $this->configuration->getResourceHints(); 70 | } 71 | 72 | /** 73 | * Get collection 74 | * 75 | * @param null|string|bool|int $resourcesJson 76 | * @return Collection 77 | */ 78 | private function getResourceHintsCollection($resourcesJson) 79 | { 80 | // Create empty collection 81 | $collection = $this->collectionFactory->create(); 82 | // Guard against no resources 83 | $isValid = $this->jsonValidator->isValid($resourcesJson); 84 | if (!$isValid) return $collection; 85 | // Parse resource hints json 86 | $resourceHintsConfig = $this->json->unserialize($resourcesJson); 87 | // Loop over resource hints 88 | foreach ($resourceHintsConfig as $resource) { 89 | // Parse resource config 90 | $parsedResource = $this->parseResource($resource); 91 | // Add resource to collection 92 | $collection->addItem($parsedResource); 93 | } 94 | // Return collection 95 | return $collection; 96 | } 97 | 98 | /** 99 | * Parse resource 100 | * 101 | * @param array $resource 102 | * @return DataObject 103 | */ 104 | private function parseResource($resource) 105 | { 106 | $resourceHint = $this->dataObjectFactory->create(); 107 | // Parse resource config 108 | $href = $this->parseHref($resource['resource']); 109 | $properties = $this->parseResourceProperties($resource); 110 | // Set parsed config 111 | $resourceHint->setData('href', $href); 112 | $resourceHint->setData('properties', $properties); 113 | // Return parsed config 114 | return $resourceHint; 115 | } 116 | 117 | /** 118 | * Parse resource attributes 119 | * 120 | * @param array $resource 121 | * @return DataObject 122 | */ 123 | private function parseResourceAttributes($resource) 124 | { 125 | $attributes = $this->dataObjectFactory->create(); 126 | // Set rel to type 127 | $attributes->setData('rel', $resource['type']); 128 | // For preload 129 | if ($resource['type'] === 'preload') { 130 | // Set asset type 131 | $attributes->setData('as', $resource['preload_as']); 132 | } 133 | // For crossorigin 134 | if ($resource['cross_origin'] == '1') { 135 | // Set anonymous 136 | $attributes->setData('crossorigin', 'anonymous'); 137 | } 138 | return $attributes; 139 | } 140 | 141 | /** 142 | * Parse resource properties 143 | * 144 | * @param array $resource 145 | * @return array 146 | */ 147 | private function parseResourceProperties($resource) 148 | { 149 | $attributes = $this->parseResourceAttributes($resource); 150 | return ['attributes' => $attributes->toArray()]; 151 | } 152 | 153 | /** 154 | * Parse resource href 155 | * 156 | * @param array $resource 157 | * @return string 158 | */ 159 | private function parseHref($href) 160 | { 161 | // Check not remote 162 | return !$this->isRemoteAsset($href) 163 | // Resolve local url 164 | ? $this->assetRepository->getUrl($href) 165 | // No need to resolve, use as is 166 | : $href; 167 | } 168 | 169 | /** 170 | * Check is local asset 171 | * 172 | * @param string $asset 173 | * @return int 174 | */ 175 | private function isRemoteAsset($asset) 176 | { 177 | // Regex for 'http://' or 'https://'or '//' 178 | $re = '/^https?:\/\/.+|^\/\/.+/'; 179 | // Return number of matches 180 | return preg_match($re, $asset); 181 | } 182 | } 183 | -------------------------------------------------------------------------------- /Observer/Framework/View/Layout/Builder.php: -------------------------------------------------------------------------------- 1 | resources = $prepareResources; 35 | $this->pageConfig = $pageConfig; 36 | } 37 | 38 | /** 39 | * Execute 40 | * 41 | * @param Observer $observer 42 | * @return $this 43 | */ 44 | public function execute(Observer $observer) 45 | { 46 | // Get resource hints 47 | $resourceHints = $this->resources->getCollection(); 48 | // Sort resource hints 49 | $resourceHints->setOrder('sort'); 50 | // Loop over resource hints 51 | foreach ($resourceHints as $resource) { 52 | $href = $resource->getHref(); 53 | $properties = $resource->getProperties(); 54 | // Add resource hint to page 55 | $this->pageConfig->addRemotePageAsset($href, 'link_rel', $properties); 56 | } 57 | return $this; 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # THIS EXTENSION IS NO LONGER ACTIVELY MAINTAINED 2 | 3 | If it doesn't work on your Magento 2 instance, please fork this repo and fix it -- and feel free to submit a PR to add your changes to this repo. 4 | 5 | Update January 31st, 2022: I've removed the Magento version requirements from composer.json so that you can try it on any instance. I'm not guaranteeing it'll work. 6 | 7 | # Resource Hints for Magento 2 8 | 9 | ## Overview 10 | 11 | Add ``, ``, ``, or `` resource hints to Magento 2's head. 12 | 13 | ## Features 14 | 15 | - Tweak your Magento 2 store's performance by adding custom `preconnect`, `dns-prefetch`, `prefetch`, and `preload` headers. 16 | - Enable/disable `crossorigin` attribute. 17 | - Easily configurable at default, website and store view level (incl. sort order). 18 | 19 | ## Installation 20 | 21 | ### Using Composer 22 | 23 | Installation using Composer is easy and recommended. From a terminal, just run: 24 | 25 | `composer require dan0sz/resource-hints-magento2` 26 | 27 | ### Manually 28 | 29 | If you can't or dont want to use Composer, you can download the `master`-branch of this repository and copy the contents to `app/code/Dan0sz/ResourceHints`. 30 | 31 | ### After installation 32 | 33 | #### Developer Mode 34 | 35 | - Run `bin/magento setup:upgrade` 36 | - Done! 37 | 38 | #### Production Mode 39 | 40 | - Run `bin/magento setup:upgrade` 41 | - Run `bin/magento setup:di:compile` 42 | - Run `bin/magento setup:static-content:deploy [locales e.g. en_US nl_NL]` 43 | - Done! 44 | 45 | ## Configuration 46 | 47 | After installation a new tab is added to *Stores > Configuration > General > Web* called *Resource Hints*. 48 | 49 | ### How does it work? 50 | 51 | While most settings of this extension speak for themselves. The Resource column contains a few nifty tricks (thanks to @chedaroo), which will come in handy when e.g. Static content signing is enabled. 52 | 53 | Values in the Resource column are assumed to be relative (local) assets. When a relative path is entered and **Static Content Signing** is **enabled**, e.g. 54 | 55 | (*In these examples it is assumed that the default theme, Magento Luma is used.*) 56 | 57 | - `YourName_ModuleName::path/to/file.ext` will resolve to `https://yourdomain.tld/static/<>/frontend/Magento/luma/en_US/YourName_ModuleName/path/to/file.ext`, and 58 | - `path/to/file.ext` will resolve to `https://yourdomain.tld/static/<>/frontend/Magento/luma/en_US/path/to/file.ext`. 59 | 60 | When **Static Content Signing** is **disabled**, the above mentioned values will resolve to: 61 | 62 | - `https://yourdomain.tld/static/frontend/Magento/luma/en_US/YourName_ModuleName/path/to/file.ext`, and 63 | - `https://yourdomain.tld/static/frontend/Magento/luma/en_US/path/to/file.ext` respectively. 64 | 65 | When absolute URLs (prefixed by a protocol, i.e. `http://`, `https://` or `//`) are entered in the Resource column, no prior resolving will take place. E.g. 66 | 67 | - `http://yourdomain.tld/path/to/file.ext`, 68 | - `https://yourdomain.tld/path/to/file.ext`, and 69 | - `//SomeVolume/path/to/file.ext`. 70 | 71 | The examples above will all resolve to the same exact URL. 72 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "dan0sz/resource-hints-magento2", 3 | "description": "Add ``, ``, ``, or `` resource hints to Magento 2's head.", 4 | "require": { 5 | "ext-openssl": "*", 6 | "ext-json": "*", 7 | "magento/framework": "*" 8 | }, 9 | "type": "magento2-module", 10 | "license": "CC-BY-4.0", 11 | "authors": [ 12 | { 13 | "name": "Daan van den Bergh", 14 | "email": "info@daan.dev", 15 | "homepage": "https://daan.dev" 16 | } 17 | ], 18 | "support": { 19 | "issues": "https://github.com/Dan0sz/ResourceHints-magento2/issues/" 20 | }, 21 | "homepage": "https://daan.dev", 22 | "autoload": { 23 | "files": [ 24 | "registration.php" 25 | ], 26 | "psr-4": { 27 | "Dan0sz\\ResourceHints\\": "" 28 | } 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /etc/adminhtml/system.xml: -------------------------------------------------------------------------------- 1 | 2 | 10 | 11 | 12 |
13 | 14 | 15 | 16 | 17 | 18 | read more. The 'preload as'-attribute only affects the Preload Resource Hint Type.]]> 19 | Dan0sz\ResourceHints\Block\System\Config\Form\Field\FieldArray 20 | Magento\Config\Model\Config\Backend\Serialized\ArraySerialized 21 | 22 | 23 |
24 | 25 | -------------------------------------------------------------------------------- /etc/di.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 7 | 8 | -------------------------------------------------------------------------------- /etc/frontend/events.xml: -------------------------------------------------------------------------------- 1 | 2 | 10 | 11 | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /etc/module.xml: -------------------------------------------------------------------------------- 1 | 2 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Dan0sz_ResourceHints", 3 | "version": "1.2.1", 4 | "description": "Add ``, ``, ``, or `` resource hints to Magento 2's head.", 5 | "author": "Dan0sz", 6 | "license": "CC-BY-4.0", 7 | "homepage": "https://daan.dev/" 8 | } 9 | -------------------------------------------------------------------------------- /registration.php: -------------------------------------------------------------------------------- 1 |