summaryrefslogtreecommitdiff
path: root/app/php/web/ClientScriptManager.php
blob: 84b9d6f35fe70350fbea26f253b179a828450937 (plain)
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
<?php

Prado::using('Application.layouts.Layout');

class ClientScriptManager extends TClientScriptManager {

    private $_page;
    public function __construct(TPage $page) {
        $this->_page = $page;
        parent::__construct($page);
    }

    private function _getBasePath() {
        return Prado::getPathOfNamespace('Web') . DIRECTORY_SEPARATOR;
    }

    private function _getBasePaths($urls) {
        $basePath = $this->_getBasePath();
        return array_map(
            function($path) use($basePath) {
                return $basePath . DIRECTORY_SEPARATOR . $path;
            },
            $urls
        );
    }

    private function _getCachePath($subdir = 'assets') {
        $cachePath = $this->Application->RuntimePath
            . DIRECTORY_SEPARATOR
            . $subdir;
        if (!is_dir($cachePath)) {
            if (file_exists($cachePath)) {
                throw new TIOException(
                    'Client script manager cache path "'
                    . $cachePath
                    . ' "exists and is not a directory'
                );
            } else {
                mkdir($cachePath);
            }
        }
        return $cachePath;
    }

    private function _getCacheFilePath($path, $type) {
        return $this->_getCachePath($type)
            . DIRECTORY_SEPARATOR
            . $path;
    }

    private function _getFileCollectionCacheKey($files) {
        sort($files);
        return md5(implode(PHP_EOL, $files));
    }

    private function _getFileCollectionMTime($files) {
        return max(array_map('filemtime', $files));
    }

    private $_renderedScriptsInitialized = FALSE;

    private function _getRenderedScriptsStoreKey() {
        $template = $this->_page->Master;
        if (!$template instanceof Layout) {
            throw new TNotSupportedException(
                'Compiled assets may only be used within Layout master class controls'
            );
        }
        return 'RenderedScripts.' . $template->generateViewID();
    }

    private function _getCache() {
        $cache = $this->Application->Cache;
        if (!$cache) {
            throw new TNotSupportedException(
                'Compiled assets require cache to be configured'
            );
        }
        return $cache;
    }

    private function _getRenderedScripts() {
        $sessionKey = $this->_getRenderedScriptsStoreKey();
        if ($this->_page->IsCallBack || $this->_renderedScriptsInitialized) {
            return $this->_getCache()->get($sessionKey) ?: [];
        } else {
            $this->_getCache()->delete($sessionKey);
            $this->_renderedScriptsInitialized = TRUE;
            return [];
        }
    }

    private function _appendRenderedScripts(array $newScripts, $compiledFileKey) {
        $scripts = $this->_getRenderedScripts();
        if (!isset($scripts[$compiledFileKey])) {
            $scripts[$compiledFileKey] = [];
        }
        $scripts[$compiledFileKey] = array_unique(
            array_merge(
                $scripts[$compiledFileKey],
                $newScripts
            )
        );
        $this->_getCache()->set(
            $this->_getRenderedScriptsStoreKey(),
            $scripts
        );
    }

    private function _compileFiles($files) {
        foreach ($files as $file) {
            $this->markScriptFileAsRendered($file);
        }
        $paths = $this->_getBasePaths($files);
        $cacheKey = $this->_getFileCollectionCacheKey($paths);
        $cacheFile = $this->_getCacheFilePath($cacheKey . '.js', 'scripts');
        $this->_appendRenderedScripts($files, $cacheFile);
        if (!file_exists($cacheFile)
            || (filemtime($cacheFile)
                < $this->_getFileCollectionMTime($paths))) {
            $scriptContent = implode(
                PHP_EOL,
                array_map(
                    function($path) {
                        return trim(
                            TJavaScript::JSMin(
                                file_get_contents($path)
                            )
                        );
                    },
                    $paths
                )
            );
            file_put_contents($cacheFile, $scriptContent);
        }
        return $this->Application->AssetManager->publishFilePath($cacheFile);
    }

    private function _determineLocalScriptFiles($files) {
        $basePath = $this->_getBasePath();
        return array_filter(
            $files,
            function($file) use($basePath) {
                return file_exists($basePath . DIRECTORY_SEPARATOR . $file);
            }
        );
    }

    private function _renderLocalScriptFiles($writer, $localFiles) {
        if ($localFiles) {
            $assetPath = $this->_compileFiles($localFiles);
            $writer->write(TJavascript::renderScriptFile($assetPath));
        }
    }

    private function _renderExternalScriptFiles($writer, $externalFiles) {
        if ($externalFiles) {
            foreach ($externalFiles as $file) {
                $this->markScriptFileAsRendered($file);
                $this->_appendRenderedScripts([$file], $file);
            }
            parent::renderScriptFiles($writer, $externalFiles);
        }
    }

    public function renderScriptFiles($writer, Array $files) {
        if ($this->getApplication()->getMode() !== TApplicationMode::Debug) {
            if ($files) {
                $localFiles = $this->_determineLocalScriptFiles($files);
                $this->_renderLocalScriptFiles($writer, $localFiles);
                $externalFiles = array_diff($files, $localFiles);
                $this->_renderExternalScriptFiles($writer, $externalFiles);
            }
        } else {
            parent::renderScriptFiles($writer, $files);
        }
    }

    private function _getRenderedScriptUrl($registeredScript) {
        $renderedScripts = $this->_getRenderedScripts();
        foreach ($renderedScripts as $compiledFile => $scripts) {
            if (in_array($registeredScript, $scripts)) {
                if (file_exists($compiledFile)) {
                    return $this->Application->AssetManager->getPublishedUrl(
                        $compiledFile
                    );
                } else {
                    return $registeredScript;
                }
            }
        }
        return FALSE;
    }

    public function getScriptUrls() {
        if ($this->getApplication()->getMode() !== TApplicationMode::Debug) {
            $registeredScripts = array_unique(
                array_merge(
                    $this->_scripts, $this->_headScripts
                )
            );
            $scriptUrls = [];
            $newScripts = [];
            foreach ($registeredScripts as $registeredScript) {
                $renderedScriptUrl = $this->_getRenderedScriptUrl(
                    $registeredScript
                );
                if ($renderedScriptUrl) {
                    $scriptUrls[] = $renderedScriptUrl;
                } else {
                    $newScripts[] = $registeredScript;
                }
            }
            $newLocalScripts = $this->_determineLocalScriptFiles($newScripts);
            $newRemoteScripts = array_diff($newScripts, $newLocalScripts);
            if ($newLocalScripts) {
                $scriptUrls[] = $this->_compileFiles($newLocalScripts);
            }
            $scriptUrls = array_values(
                array_unique(array_merge($scriptUrls, $newRemoteScripts))
            );
            return $scriptUrls;
        } else {
            return parent::getScriptUrls();
        }
    }

    private $_scripts = [];
    private $_headScripts = [];

    public function registerScriptFile($key, $file) {
        $this->_scripts[$key] = $file;
        return parent::registerScriptFile($key, $file);
    }

    public function registerHeadScriptFile($key, $file) {
        $this->_headScripts[$key] = $file;
        return parent::registerHeadScriptFile($key, $file);
    }

}

?>