Skip to content

Commit ec506b0

Browse files
creecroscreecros
authored
Merge pull request #75 from creecros/cache-toggle-feature
Cache toggle feature
2 parents 5900403 + f0346e2 commit ec506b0

File tree

4 files changed

+90
-11
lines changed

4 files changed

+90
-11
lines changed

‎Controller/CustomizerConfigController.php

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ public function save()
3232
$values = $this->request->getValues();
3333

3434
if (array_key_exists('use_custom_login', $values) === false) { $this->configModel->save(['use_custom_login' => '']); }
35+
if (array_key_exists('enable_cache', $values) === false) { $this->configModel->save(['enable_cache' => '']); }
3536

3637
if ($this->configModel->save($values)) {
3738
$this->languageModel->loadCurrentLanguage();

‎Controller/CustomizerFileController.php

+68-5
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,36 @@ protected function renderFileWithCache(array $file, $mimetype)
4747
{
4848
$etag = md5($file['path']);
4949

50+
if ($this->request->getHeader('If-None-Match') === '"'.$etag.'"') {
51+
$this->response->status(304);
52+
} else {
53+
try {
54+
$this->response->withContentType($mimetype);
55+
$this->response->withCache(5 * 86400, $etag);
56+
$this->response->send();
57+
$this->objectStorage->output($file['path']);
58+
} catch (ObjectStorageException $e) {
59+
$this->logger->error($e->getMessage());
60+
}
61+
}
62+
}
63+
64+
/**
65+
* Output file without cache
66+
*
67+
* @param array $file
68+
* @param $mimetype
69+
*/
70+
protected function renderFileWithoutCache(array $file, $mimetype)
71+
{
72+
$etag = md5($file['path']);
73+
5074
if ($this->request->getHeader('If-None-Match') === '"'.$etag.'"') {
5175
$this->response->status(304);
5276
} else {
5377
try {
5478
$this->response->withContentType($mimetype);
5579
$this->response->withOutCache();
56-
// $this->response->withCache(5 * 86400, $etag);
5780
$this->response->send();
5881
$this->objectStorage->output($file['path']);
5982
} catch (ObjectStorageException $e) {
@@ -84,23 +107,59 @@ public function logo()
84107
{
85108
if ($this->logoexists()) {
86109
$file = $this->customizerFileModel->getByType(1);
87-
$this->renderFileWithCache($file, $this->helper->file->getImageMimeType($file['name']));
110+
if ($this->configModel->get('enable_cache', '') == 'checked') {
111+
$this->renderFileWithCache($file, $this->helper->file->getImageMimeType($file['name']));
112+
} else {
113+
$this->renderFileWithoutCache($file, $this->helper->file->getImageMimeType($file['name']));
114+
}
115+
}
116+
}
117+
118+
public function logo_setting()
119+
{
120+
if ($this->logoexists()) {
121+
$file = $this->customizerFileModel->getByType(1);
122+
$this->renderFileWithoutCache($file, $this->helper->file->getImageMimeType($file['name']));
88123
}
89124
}
90125

91126
public function loginlogo()
92127
{
93128
if ($this->loginlogoexists()) {
94129
$file = $this->customizerFileModel->getByType(3);
95-
$this->renderFileWithCache($file, $this->helper->file->getImageMimeType($file['name']));
130+
if ($this->configModel->get('enable_cache', '') == 'checked') {
131+
$this->renderFileWithCache($file, $this->helper->file->getImageMimeType($file['name']));
132+
} else {
133+
$this->renderFileWithoutCache($file, $this->helper->file->getImageMimeType($file['name']));
134+
}
135+
}
136+
}
137+
138+
public function loginlogo_setting()
139+
{
140+
if ($this->loginlogoexists()) {
141+
$file = $this->customizerFileModel->getByType(3);
142+
$this->renderFileWithoutCache($file, $this->helper->file->getImageMimeType($file['name']));
96143
}
97144
}
98145

99146
public function icon()
100147
{
101148
if ($this->iconexists()) {
102149
$file = $this->customizerFileModel->getByType(2);
103-
$this->renderFileWithCache($file, $this->helper->file->getImageMimeType($file['name']));
150+
if ($this->configModel->get('enable_cache', '') == 'checked') {
151+
$this->renderFileWithCache($file, $this->helper->file->getImageMimeType($file['name']));
152+
} else {
153+
$this->renderFileWithoutCache($file, $this->helper->file->getImageMimeType($file['name']));
154+
}
155+
}
156+
}
157+
158+
public function icon_setting()
159+
{
160+
if ($this->iconexists()) {
161+
$file = $this->customizerFileModel->getByType(2);
162+
$this->renderFileWithoutCache($file, $this->helper->file->getImageMimeType($file['name']));
104163
}
105164
}
106165

@@ -142,7 +201,11 @@ public function iconexists()
142201
public function image()
143202
{
144203
$file = $this->customizerFileModel->getById($this->request->getIntegerParam('file_id'));
145-
$this->renderFileWithCache($file, $this->helper->file->getImageMimeType($file['name']));
204+
if ($this->configModel->get('enable_cache', '') == 'checked') {
205+
$this->renderFileWithCache($file, $this->helper->file->getImageMimeType($file['name']));
206+
} else {
207+
$this->renderFileWithoutCache($file, $this->helper->file->getImageMimeType($file['name']));
208+
}
146209
}
147210

148211
/**

‎Plugin.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ public function getPluginAuthor()
133133

134134
public function getPluginVersion()
135135
{
136-
return '1.8.4';
136+
return '1.9.0';
137137
}
138138

139139
public function getPluginHomepage()

‎Template/file/show.php

+20-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<div class="panel-heading">
1616
<h3 class="panel-title"><?= t('Header Image') ?></h3>
1717
</div>
18-
<img id="hl1" src="<?= $this->url->href('CustomizerFileController', 'logo', array('plugin' => 'customizer', 'file_id' => $logo['id'])) ?>" alt="<?= $this->text->e($logo['name']) ?>" height="<?= $this->task->configModel->get('headerlogo_size', '30') ?>">
18+
<img id="hl1" src="<?= $this->url->href('CustomizerFileController', 'logo_setting', array('plugin' => 'customizer', 'file_id' => $logo['id'])) ?>" alt="<?= $this->text->e($logo['name']) ?>" height="<?= $this->task->configModel->get('headerlogo_size', '30') ?>">
1919
<br>
2020
<br>
2121
<ul class="upload-link">
@@ -55,7 +55,7 @@
5555
<h3 class="panel-title"><?= t('Login Image') ?></h3>
5656
</div>
5757

58-
<img id="ll1" src="<?= $this->url->href('CustomizerFileController', 'loginlogo', array('plugin' => 'customizer', 'file_id' => $loginlogo['id'])) ?>" alt="<?= $this->text->e($loginlogo['name']) ?>" height="<?= $this->task->configModel->get('loginlogo_size', '50') ?>">
58+
<img id="ll1" src="<?= $this->url->href('CustomizerFileController', 'loginlogo_setting', array('plugin' => 'customizer', 'file_id' => $loginlogo['id'])) ?>" alt="<?= $this->text->e($loginlogo['name']) ?>" height="<?= $this->task->configModel->get('loginlogo_size', '50') ?>">
5959
<br>
6060
<br>
6161
<ul class="upload-link">
@@ -95,7 +95,7 @@
9595
<h3 class="panel-title"><?= t('Favicon Image') ?></h3>
9696
</div>
9797

98-
<img src="<?= $this->url->href('CustomizerFileController', 'icon', array('plugin' => 'customizer', 'file_id' => $flavicon['id'])) ?>" alt="<?= $this->text->e($flavicon['name']) ?>" height="16">
98+
<img src="<?= $this->url->href('CustomizerFileController', 'icon_setting', array('plugin' => 'customizer', 'file_id' => $flavicon['id'])) ?>" alt="<?= $this->text->e($flavicon['name']) ?>" height="16">
9999
<br>
100100
<br>
101101
<ul class="upload-link">
@@ -119,7 +119,22 @@
119119
</ul>
120120
<?php endif ?>
121121
</div>
122-
<div class="form-actions mb-20 ml-15">
122+
123+
<table>
124+
<tr>
125+
<th width="25%"><strong><?= t('Enable Cache') ?></strong>
126+
<p class="form-help enable-cache-desc"><?= e('Once enabled, site assets will begin to be cached for 5 days, increasing speed of site. However, you will need to clear your cache to see any new images uploaded. The settings page, will be unaffected by this setting.') ?></p>
127+
</th>
128+
<th>
129+
<label class="switch">
130+
<input id="toggle" name="enable_cache" type="checkbox" value="checked" <?= $this->task->configModel->get('enable_cache','') ?>>
131+
<span class="slider round"></span>
132+
</label>
133+
</th>
134+
</tr>
135+
</table>
136+
137+
<div class="form-actions mb-20 ml-15">
123138
<button type="submit" name="save" value="save" class="btn btn-blue"><?= t('Save') ?></button>
124139
</div>
125140
</div>
@@ -271,7 +286,7 @@
271286
</div>
272287
<div id="preview-form-login" class="preview-form-login">
273288
<?php if ($customizer['loginCheck']): ?>
274-
<?= $this->url->link('<img src="' . $this->url->href('CustomizerFileController', 'loginlogo', array('plugin' => 'customizer')) . '" height="' . $customizer['logoSize'] . '">', 'CustomizerFileController', 'link', array('plugin' => 'customizer')) ?>
289+
<?= $this->url->link('<img src="' . $this->url->href('CustomizerFileController', 'loginlogo_setting', array('plugin' => 'customizer')) . '" height="' . $customizer['logoSize'] . '">', 'CustomizerFileController', 'link', array('plugin' => 'customizer')) ?>
275290
<?php else: ?>
276291
<?= $this->url->link('K<span>B</span>', 'DashboardController', 'show', array(), false, '', t('Dashboard')) ?>
277292
<?php endif ?>

0 commit comments

Comments
 (0)