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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Captcha\Helper;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Filesystem;
use Magento\Framework\Filesystem\DriverInterface;
/**
* Captcha image model
*
* @api
* @since 100.0.2
*/
class Data extends \Magento\Framework\App\Helper\AbstractHelper
{
/**
* Used for "name" attribute of captcha's input field
*/
const INPUT_NAME_FIELD_VALUE = 'captcha';
/**
* Always show captcha
*/
const MODE_ALWAYS = 'always';
/**
* Show captcha only after certain number of unsuccessful attempts
*/
const MODE_AFTER_FAIL = 'after_fail';
/**
* Captcha fonts path
*/
const XML_PATH_CAPTCHA_FONTS = 'captcha/fonts';
/**
* Default captcha type
*/
const DEFAULT_CAPTCHA_TYPE = 'Zend';
/**
* List uses Models of Captcha
* @var array
*/
protected $_captcha = [];
/**
* @var Filesystem
*/
protected $_filesystem;
/**
* @var \Magento\Store\Model\StoreManagerInterface
*/
protected $_storeManager;
/**
* @var \Magento\Captcha\Model\CaptchaFactory
*/
protected $_factory;
/**
* @param \Magento\Framework\App\Helper\Context $context
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param Filesystem $filesystem
* @param \Magento\Captcha\Model\CaptchaFactory $factory
*/
public function __construct(
\Magento\Framework\App\Helper\Context $context,
\Magento\Store\Model\StoreManagerInterface $storeManager,
Filesystem $filesystem,
\Magento\Captcha\Model\CaptchaFactory $factory
) {
$this->_storeManager = $storeManager;
$this->_filesystem = $filesystem;
$this->_factory = $factory;
parent::__construct($context);
}
/**
* Get Captcha
*
* @param string $formId
* @return \Magento\Captcha\Model\CaptchaInterface
*/
public function getCaptcha($formId)
{
if (!array_key_exists($formId, $this->_captcha)) {
$captchaType = ucfirst($this->getConfig('type'));
if (!$captchaType) {
$captchaType = self::DEFAULT_CAPTCHA_TYPE;
} elseif ($captchaType == 'Default') {
$captchaType = $captchaType . 'Model';
}
$this->_captcha[$formId] = $this->_factory->create($captchaType, $formId);
}
return $this->_captcha[$formId];
}
/**
* Returns config value
*
* @param string $key The last part of XML_PATH_$area_CAPTCHA_ constant (case insensitive)
* @param \Magento\Store\Model\Store $store
* @return \Magento\Framework\App\Config\Element
*/
public function getConfig($key, $store = null)
{
return $this->scopeConfig->getValue(
'customer/captcha/' . $key,
\Magento\Store\Model\ScopeInterface::SCOPE_STORE,
$store
);
}
/**
* Get list of available fonts.
*
* Return format:
* [['arial'] => ['label' => 'Arial', 'path' => '/www/magento/fonts/arial.ttf']]
*
* @return array
*/
public function getFonts()
{
$fontsConfig = $this->scopeConfig->getValue(\Magento\Captcha\Helper\Data::XML_PATH_CAPTCHA_FONTS, 'default');
$fonts = [];
if ($fontsConfig) {
$libDir = $this->_filesystem->getDirectoryRead(DirectoryList::LIB_INTERNAL);
foreach ($fontsConfig as $fontName => $fontConfig) {
$fonts[$fontName] = [
'label' => $fontConfig['label'],
'path' => $libDir->getAbsolutePath($fontConfig['path']),
];
}
}
return $fonts;
}
/**
* Get captcha image directory
*
* @param mixed $website
* @return string
*/
public function getImgDir($website = null)
{
$mediaDir = $this->_filesystem->getDirectoryWrite(DirectoryList::MEDIA);
$captchaDir = '/captcha/' . $this->_getWebsiteCode($website);
$mediaDir->create($captchaDir);
return $mediaDir->getAbsolutePath($captchaDir) . '/';
}
/**
* Get website code
*
* @param mixed $website
* @return string
*/
protected function _getWebsiteCode($website = null)
{
return $this->_storeManager->getWebsite($website)->getCode();
}
/**
* Get captcha image base URL
*
* @param mixed $website
* @return string
*/
public function getImgUrl($website = null)
{
return $this->_storeManager->getStore()->getBaseUrl(
DirectoryList::MEDIA
) . 'captcha' . '/' . $this->_getWebsiteCode(
$website
) . '/';
}
}