/
Cloudflare.php
251 lines (216 loc) · 6.41 KB
/
Cloudflare.php
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<?php
/**
* Cloudflare plugin for Craft CMS 3.x
*
* Purge Cloudflare caches from Craft.
*
* @link https://workingconcept.com
* @copyright Copyright (c) 2017 Working Concept
*/
namespace workingconcept\cloudflare;
use workingconcept\cloudflare\services\CloudflareService;
use workingconcept\cloudflare\services\RulesService;
use workingconcept\cloudflare\variables\CloudflareVariable;
use workingconcept\cloudflare\models\Settings;
use workingconcept\cloudflare\widgets\QuickPurge as QuickPurgeWidget;
use Craft;
use craft\console\Application as ConsoleApplication;
use craft\base\Plugin;
use craft\web\UrlManager;
use craft\web\twig\variables\CraftVariable;
use craft\services\Dashboard;
use craft\events\RegisterComponentTypesEvent;
use craft\events\RegisterUrlRulesEvent;
use craft\events\ElementEvent;
use craft\services\Elements;
use craft\helpers\UrlHelper;
use yii\base\Event;
/**
* Class Cloudflare
*
* @author Working Concept
* @package Cloudflare
* @since 1.0.0
*
* @property CloudflareService $cloudflare
* @property RulesService $rules
*/
class Cloudflare extends Plugin
{
// Static Properties
// =========================================================================
/**
* @var Cloudflare
*/
public static $plugin;
/**
* @var bool
*/
public $hasCpSettings = true;
/**
* @var string
*/
public $t9nCategory = 'cloudflare';
// Public Methods
// =========================================================================
/**
* @inheritdoc
*/
public function init()
{
parent::init();
self::$plugin = $this;
$this->setComponents([
'cloudflare' => CloudflareService::class,
'rules' => RulesService::class
]);
// register the widget
Event::on(
Dashboard::class,
Dashboard::EVENT_REGISTER_WIDGET_TYPES,
function (RegisterComponentTypesEvent $event) {
$event->types[] = QuickPurgeWidget::class;
}
);
// register the variable
Event::on(
CraftVariable::class,
CraftVariable::EVENT_INIT,
function (Event $event) {
/** @var CraftVariable $variable */
$variable = $event->sender;
$variable->set('cloudflare', CloudflareVariable::class);
}
);
if (Craft::$app->getRequest()->getIsCpRequest())
{
// register the actions
Event::on(
UrlManager::class,
UrlManager::EVENT_REGISTER_CP_URL_RULES,
function(RegisterUrlRulesEvent $event) {
$event->rules['cloudflare/rules'] = [
'template' => 'cloudflare/rules'
];
}
);
}
if (
$this->cloudflare->isConfigured() &&
($this->getSettings()->purgeEntryUrls || $this->getSettings()->purgeAssetUrls)
)
{
Event::on(
Elements::class,
Elements::EVENT_AFTER_SAVE_ELEMENT,
function(ElementEvent $event) {
$this->_handleElementChange(
$event->isNew,
$event->element
);
}
);
Event::on(
Elements::class,
Elements::EVENT_AFTER_DELETE_ELEMENT,
function(ElementEvent $event) {
$this->_handleElementChange(
$event->isNew,
$event->element
);
}
);
}
if (Craft::$app instanceof ConsoleApplication)
{
$this->controllerNamespace = 'workingconcept\cloudflare\console\controllers';
}
Craft::info(
Craft::t(
'cloudflare',
'{name} plugin loaded',
['name' => $this->name]
),
'cloudflare'
);
}
/**
* Store the selected Cloudflare Zone's base URL for later comparison.
*
* @return bool
*/
public function beforeSaveSettings(): bool
{
$settings = $this->getSettings();
if ($zoneInfo = $this->cloudflare->getZoneById($settings->zone))
{
$settings->zoneName = $zoneInfo->name;
}
return true;
}
// Protected Methods
// =========================================================================
/**
* @inheritdoc
*/
protected function createSettingsModel()
{
return new Settings();
}
/**
* @inheritdoc
*/
protected function settingsHtml(): string
{
return Craft::$app->view->renderTemplate(
'cloudflare/settings',
[
'settings' => $this->getSettings(),
'isCraft31' => version_compare(Craft::$app->getVersion(), '3.1', '>='),
]
);
}
// Private Methods
// =========================================================================
/**
* @param bool $isNew
* @param \craft\base\Element|null $element
*
* @throws \yii\base\Exception
*/
private function _handleElementChange(bool $isNew, $element)
{
/**
* Bail if we don't have an Element or an Element URL to work with.
*/
if ($element === null || $element->getUrl() === null)
{
return;
}
$isClearableEntry = $this->getSettings()->purgeEntryUrls &&
is_a($element, \craft\elements\Entry::class);
$isClearableAsset = $this->getSettings()->purgeAssetUrls &&
is_a($element, \craft\elements\Asset::class);
if (! $isNew && ($isClearableEntry || $isClearableAsset))
{
$elementUrl = $element->getUrl();
/**
* Try making relative URLs absolute.
*/
if (strpos($elementUrl, '//') === false)
{
$elementUrl = UrlHelper::siteUrl($elementUrl);
}
$this->cloudflare->purgeUrls([
$elementUrl
]);
}
/**
* Honor any explicit rules that match this URL, regardless
* of whatever Element it is.
*/
$this->rules->purgeCachesForUrl(
$element->getUrl()
);
}
}