1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Deploy\Model\DeploymentConfig;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Flag;
use Magento\Framework\Flag\FlagResource;
use Magento\Framework\FlagFactory;
/**
* Saves and Retrieves deployment configuration hash.
*
* This hash keeps version of last imported data. Hash is used to define whether data was updated
* and import is required.
*
* @see \Magento\Deploy\Model\DeploymentConfig\ChangeDetector::hasChanges()
*/
class Hash
{
/**
* Name of the section where deployment configuration hash is stored.
*/
const CONFIG_KEY = 'config_hash';
/**
* Hash generator.
*
* @var Hash\Generator
*/
private $configHashGenerator;
/**
* Config data collector.
*
* @var DataCollector
*/
private $dataConfigCollector;
/**
* Flag Resource model.
*
* @var FlagResource
*/
private $flagResource;
/**
* Factory class for \Magento\Framework\Flag
*
* @var FlagFactory
*/
private $flagFactory;
/**
* @param Hash\Generator $configHashGenerator the hash generator
* @param DataCollector $dataConfigCollector the config data collector
* @param FlagResource $flagResource
* @param FlagFactory $flagFactory
*/
public function __construct(
Hash\Generator $configHashGenerator,
DataCollector $dataConfigCollector,
FlagResource $flagResource,
FlagFactory $flagFactory
) {
$this->configHashGenerator = $configHashGenerator;
$this->dataConfigCollector = $dataConfigCollector;
$this->flagResource = $flagResource;
$this->flagFactory = $flagFactory;
}
/**
* Updates hash in the storage.
*
* If the specific section name is set, then hash will be updated only for this section,
* in another case hash will be updated for all sections which defined in di.xml
* The hash is generated based on data from configuration files.
*
* @param string $sectionName the specific section name
* @return void
* @throws LocalizedException is thrown when hash was not saved
*/
public function regenerate($sectionName = null)
{
try {
$hashes = $this->get();
$configs = $this->dataConfigCollector->getConfig($sectionName);
foreach ($configs as $section => $config) {
$hashes[$section] = $this->configHashGenerator->generate($config);
}
/** @var Flag $flag */
$flag = $this->getFlagObject();
$flag->setFlagData($hashes);
$this->flagResource->save($flag);
} catch (\Exception $exception) {
throw new LocalizedException(__("The hash isn't saved."), $exception);
}
}
/**
* Retrieves saved hashes from storage.
*
* @return array
*/
public function get()
{
/** @var Flag $flag */
$flag = $this->getFlagObject();
return (array) ($flag->getFlagData() ?: []);
}
/**
* Returns flag object.
*
* We use it for saving hashes of sections in the DB.
*
* @return Flag
*/
private function getFlagObject()
{
/** @var Flag $flag */
$flag = $this->flagFactory
->create(['data' => ['flag_code' => self::CONFIG_KEY]]);
$this->flagResource->load($flag, self::CONFIG_KEY, 'flag_code');
return $flag;
}
}