Completed
Push — master ( a9076d...92dee0 )
by Andreas
13:58
created

midcom_services_cache_module_content::_check_hit()   B

Complexity

Conditions 10
Paths 17

Size

Total Lines 60
Code Lines 35

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 24
CRAP Score 13.7025

Importance

Changes 2
Bugs 0 Features 0
Metric Value
cc 10
eloc 35
c 2
b 0
f 0
nc 17
nop 1
dl 0
loc 60
ccs 24
cts 36
cp 0.6667
crap 13.7025
rs 7.6666

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * @package midcom.services
4
 * @author The Midgard Project, http://www.midgard-project.org
5
 * @copyright The Midgard Project, http://www.midgard-project.org
6
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
7
 */
8
9
use Symfony\Component\HttpFoundation\Response;
10
use Symfony\Component\HttpFoundation\Request;
11
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
12
use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
13
use Symfony\Component\HttpFoundation\BinaryFileResponse;
14
15
/**
16
 * This is the Output Caching Engine of MidCOM. It will intercept page output,
17
 * map it using the currently used URL and use the cached output on subsequent
18
 * requests.
19
 *
20
 * <b>Important note for application developers</b>
21
 *
22
 * Please read the documentation of the following functions thoroughly:
23
 *
24
 * - midcom_services_cache_module_content::no_cache();
25
 * - midcom_services_cache_module_content::uncached();
26
 * - midcom_services_cache_module_content::expires();
27
 * - midcom_services_cache_module_content::invalidate_all();
28
 * - midcom_services_cache_module_content::content_type();
29
 * - midcom_services_cache_module_content::enable_live_mode();
30
 *
31
 * You have to use these functions everywhere where it is applicable or the cache
32
 * will not work reliably.
33
 *
34
 * <b>Caching strategy</b>
35
 *
36
 * The cache takes three parameters into account when storing in or retrieving from
37
 * the cache: The current User ID, the current language and the request's URL.
38
 *
39
 * Only on a complete match a cached page is displayed, which should take care of any
40
 * permission checks done on the page. When you change the permissions of users, you
41
 * need to manually invalidate the cache though, as MidCOM currently cannot detect
42
 * changes like this (of course, this is true if and only if you are not using a
43
 * MidCOM to change permissions).
44
 *
45
 * When the HTTP request is not cacheable, the caching engine will automatically and
46
 * transparently go into no_cache mode for that request only. This feature
47
 * does neither invalidate the cache or drop the page that would have been delivered
48
 * normally from the cache. If you change the content, you need to do that yourself.
49
 *
50
 * HTTP 304 Not Modified support is built into this module, and will send a 304 reply if applicable.
51
 *
52
 * <b>Module configuration (see also midcom_config)</b>
53
 *
54
 * - <i>string cache_module_content_name</i>: The name of the cache database to use. This should usually be tied to the actual
55
 *   MidCOM site to have exactly one cache per site. This is mandatory (and populated by a sensible default
56
 *   by midcom_config, see there for details).
57
 * - <i>boolean cache_module_content_uncached</i>: Set this to true to prevent the saving of cached pages. This is useful
58
 *   for development work, as all other headers (like E-Tag or Last-Modified) are generated
59
 *   normally. See the uncached() and _uncached members.
60
 *
61
 * @package midcom.services
62
 */
63
class midcom_services_cache_module_content extends midcom_services_cache_module
64
{
65
    /**
66
     * Flag, indicating whether the current page may be cached. If
67
     * false, the usual no-cache headers will be generated.
68
     *
69
     * @var boolean
70
     */
71
    private $_no_cache = false;
72
73
    /**
74
     * Page expiration in seconds. If null (unset), the page does
75
     * not expire.
76
     *
77
     * @var int
78
     */
79
    private $_expires;
80
81
    /**
82
     * An array storing all HTTP headers registered through register_sent_header().
83
     * They will be sent when a cached page is delivered.
84
     *
85
     * @var array
86
     */
87
    private $_sent_headers = [];
88
89
    /**
90
     * Set this to true if you want to inhibit storage of the generated pages in
91
     * the cache database. All other headers will be created as usual though, so
92
     * 304 processing will kick in for example.
93
     *
94
     * @var boolean
95
     */
96
    private $_uncached = false;
97
98
    /**
99
     * Controls cache headers strategy
100
     * 'no-cache' activates no-cache mode that actively tries to circumvent all caching
101
     * 'revalidate' is the default which sets must-revalidate. Expiry defaults to current time, so this effectively behaves like no-cache if expires() was not called
102
     * 'public' and 'private' enable caching with the cache-control header of the same name, default expiry timestamps are generated using the default_lifetime
103
     *
104
     * @var string
105
     */
106
    private $_headers_strategy = 'revalidate';
107
108
    /**
109
     * Controls cache headers strategy for authenticated users, needed because some proxies store cookies, too,
110
     * making a horrible mess when used by mix of authenticated and non-authenticated users
111
     *
112
     * @see $_headers_strategy
113
     * @var string
114
     */
115
    private $_headers_strategy_authenticated = 'private';
116
117
    /**
118
     * Default lifetime of page for public/private headers strategy
119
     * When generating the default expires header this is added to time().
120
     *
121
     * @var int
122
     */
123
    private $_default_lifetime = 0;
124
125
    /**
126
     * Default lifetime of page for public/private headers strategy for authenticated users
127
     *
128
     * @see $_default_lifetime
129
     * @var int
130
     */
131
    private $_default_lifetime_authenticated = 0;
132
133
    /**
134
     * Cache backend instance.
135
     *
136
     * @var Doctrine\Common\Cache\CacheProvider
137
     */
138
    private $_meta_cache;
139
140
    /**
141
     * A cache backend used to store the actual cached pages.
142
     *
143
     * @var Doctrine\Common\Cache\CacheProvider
144
     */
145
    private $_data_cache;
146
147
    /**
148
     * GUIDs loaded per context in this request
149
     */
150
    private $context_guids = [];
151
152
    /**
153
     * @param GetResponseEvent $event
154
     */
155 338
    public function on_request(GetResponseEvent $event)
156
    {
157 338
        if ($event->isMasterRequest()) {
158 1
            $request = $event->getRequest();
159
            /* Load and start up the cache system, this might already end the request
160
             * on a content cache hit. Note that the cache check hit depends on the i18n and auth code.
161
             */
162 1
            if ($response = $this->_check_hit($request)) {
163 1
                $event->setResponse($response);
164
            }
165
        }
166 338
    }
167
168
    /**
169
     * This function holds the cache hit check mechanism. It searches the requested
170
     * URL in the cache database. If found, it checks, whether the cache page has
171
     * expired. If not, the response is returned. In all other cases this method simply
172
     * returns void.
173
     *
174
     * The midcom-cache URL methods are handled before checking for a cache hit.
175
     *
176
     * Also, any HTTP POST request will automatically circumvent the cache so that
177
     * any component can process the request. It will set no_cache automatically
178
     * to avoid any cache pages being overwritten by, for example, search results.
179
     *
180
     * Note, that HTTP GET is <b>not</b> checked this way, as GET requests can be
181
     * safely distinguished by their URL.
182
     *
183
     * @param Request $request The request object
184
     * @return void|Response
185
     */
186 1
    private function _check_hit(Request $request)
187
    {
188 1
        foreach (midcom_connection::get_url('argv') as $arg) {
189 1
            if (in_array($arg, ["midcom-cache-invalidate", "midcom-cache-nocache"])) {
190
                // Don't cache these.
191
                debug_add("uncached: $arg");
192 1
                return;
193
            }
194
        }
195
196 1
        if (!$request->isMethodCacheable()) {
197
            debug_add('Request method is not cacheable, setting no_cache');
198
            $this->no_cache();
199
            return;
200
        }
201
202
        // Check for uncached operation
203 1
        if ($this->_uncached) {
204
            debug_add("Uncached mode");
205
            return;
206
        }
207
208
        // Check that we have cache for the identifier
209 1
        $request_id = $this->generate_request_identifier($request);
210
        // Load metadata for the content identifier connected to current request
211 1
        $content_id = $this->_meta_cache->fetch($request_id);
212 1
        if ($content_id === false) {
213 1
            debug_add("MISS {$request_id}");
214
            // We have no information about content cached for this request
215 1
            return;
216
        }
217 1
        debug_add("HIT {$request_id}");
218
219 1
        $data = $this->_meta_cache->fetch($content_id);
220 1
        if ($data === false) {
221
            debug_add("MISS meta_cache {$content_id}");
222
            // Content cache data is missing
223
            return;
224
        }
225
226 1
        if (!isset($data['last-modified'])) {
227
            debug_add('Current page is in cache, but has insufficient information', MIDCOM_LOG_INFO);
228
            return;
229
        }
230
231 1
        debug_add("HIT {$content_id}");
232
233 1
        $response = new Response;
234 1
        $this->apply_headers($response, $data);
235 1
        if (!$response->isNotModified($request)) {
236 1
            $content = $this->_data_cache->fetch($content_id);
237 1
            if ($content === false) {
238
                debug_add("Current page is in not in the data cache, possible ghost read.", MIDCOM_LOG_WARN);
239
                return;
240
            }
241 1
            $response->setContent($content);
242
        }
243
        // disable cache writing in on_response
244 1
        $this->_no_cache = true;
245 1
        return $response;
246
    }
247
248
    /**
249
     * This completes the output caching, post-processes it and updates the cache databases accordingly.
250
     *
251
     * The first step is to check against _no_cache pages, which will be delivered immediately
252
     * without any further post processing. Afterwards, the system will complete the sent
253
     * headers by adding all missing headers. Note, that E-Tag will be generated always
254
     * automatically, you must not set this in your component.
255
     *
256
     * If the midcom configuration option cache_uncached is set or the corresponding runtime function
257
     * has been called, the cache file will not be written, but the header stuff will be added like
258
     * usual to allow for browser-side caching.
259
     *
260
     * @param FilterResponseEvent $event The request object
261
     */
262 339
    public function on_response(FilterResponseEvent $event)
263
    {
264 339
        if ($this->_no_cache || !$event->isMasterRequest()) {
265 338
            return;
266
        }
267 1
        $response = $event->getResponse();
268 1
        if ($response instanceof BinaryFileResponse) {
269
            return;
270
        }
271
272 1
        $request = $event->getRequest();
273 1
        $cache_data = $response->getContent();
274
275
        // Register additional Headers around the current output request
276 1
        $this->complete_sent_headers($response);
277 1
        $response->prepare($request);
278
279
        // Generate E-Tag header.
280 1
        if (empty($cache_data)) {
281
            $etag = md5(serialize($response->headers->all()));
282
        } else {
283 1
            $etag = md5($cache_data);
284
        }
285 1
        $response->setEtag($etag);
286
287 1
        if ($this->_uncached) {
288
            debug_add('Not writing cache file, we are in uncached operation mode.');
289
            return;
290
        }
291 1
        $content_id = 'C-' . $etag;
292 1
        $this->write_meta_cache($content_id, $request, $response);
293 1
        $this->_data_cache->save($content_id, $cache_data);
294 1
    }
295
296
    /**
297
     * Generate a valid cache identifier for a context of the current request
298
     */
299 1
    private function generate_request_identifier(Request $request)
300
    {
301 1
        $context = $request->attributes->get('context')->id;
302
        // Cache the request identifier so that it doesn't change between start and end of request
303 1
        static $identifier_cache = [];
304 1
        if (isset($identifier_cache[$context])) {
305 1
            return $identifier_cache[$context];
306
        }
307
308 1
        $module_name = midcom::get()->config->get('cache_module_content_name');
309 1
        if ($module_name == 'auto') {
310 1
            $module_name = midcom_connection::get_unique_host_name();
311
        }
312 1
        $identifier_source = 'CACHE:' . $module_name;
313
314 1
        $cache_strategy = midcom::get()->config->get('cache_module_content_caching_strategy');
315
316
        switch ($cache_strategy) {
317 1
            case 'memberships':
318
                if (!midcom_connection::get_user()) {
319
                    $identifier_source .= ';USER=ANONYMOUS';
320
                    break;
321
                }
322
                $mc = new midgard_collector('midgard_member', 'uid', midcom_connection::get_user());
323
                $mc->set_key_property('gid');
324
                $mc->execute();
325
                $gids = $mc->list_keys();
326
                $identifier_source .= ';GROUPS=' . implode(',', array_keys($gids));
327
                break;
328 1
            case 'public':
329
                $identifier_source .= ';USER=EVERYONE';
330
                break;
331 1
            case 'user':
332
            default:
333 1
                $identifier_source .= ';USER=' . midcom_connection::get_user();
334 1
                break;
335
        }
336
337 1
        $identifier_source .= ';URL=' . $request->getRequestUri();
338 1
        debug_add("Generating context {$context} request-identifier from: {$identifier_source}");
339
340 1
        $identifier_cache[$context] = 'R-' . md5($identifier_source);
341 1
        return $identifier_cache[$context];
342
    }
343
344
    /**
345
     * Initialize the cache.
346
     *
347
     * The first step is to initialize the cache backends. The names of the
348
     * cache backends used for meta and data storage are derived from the name
349
     * defined for this module (see the 'name' configuration parameter above).
350
     * The name is used directly for the meta data cache, while the actual data
351
     * is stored in a backend postfixed with '_data'.
352
     *
353
     * After core initialization, the module checks for a cache hit (which might
354
     * trigger the delivery of the cached page and exit) and start the output buffer
355
     * afterwards.
356
     */
357 1
    public function _on_initialize()
358
    {
359 1
        $backend_config = midcom::get()->config->get('cache_module_content_backend');
360 1
        if (!isset($backend_config['directory'])) {
361 1
            $backend_config['directory'] = 'content/';
362
        }
363 1
        if (!isset($backend_config['driver'])) {
364
            $backend_config['driver'] = 'null';
365
        }
366
367 1
        $this->_meta_cache = $this->_create_backend('content_meta', $backend_config);
368 1
        $this->_data_cache = $this->_create_backend('content_data', $backend_config);
369
370 1
        $this->_uncached = midcom::get()->config->get('cache_module_content_uncached');
371 1
        $this->_headers_strategy = $this->get_strategy('cache_module_content_headers_strategy');
372 1
        $this->_headers_strategy_authenticated = $this->get_strategy('cache_module_content_headers_strategy_authenticated');
373 1
        $this->_default_lifetime = (int)midcom::get()->config->get('cache_module_content_default_lifetime');
374 1
        $this->_default_lifetime_authenticated = (int)midcom::get()->config->get('cache_module_content_default_lifetime_authenticated');
375
376 1
        if ($this->_headers_strategy == 'no-cache') {
377
            $this->no_cache();
378
        }
379 1
    }
380
381 1
    private function get_strategy($name)
382
    {
383 1
        $strategy = strtolower(midcom::get()->config->get($name));
384 1
        $allowed = ['no-cache', 'revalidate', 'public', 'private'];
385 1
        if (!in_array($strategy, $allowed)) {
386
            throw new midcom_error($name . ' is not valid, try ' . implode(', ', $allowed));
387
        }
388 1
        return $strategy;
389
    }
390
391
    /**
392
     * Call this, if the currently processed output must not be cached for any
393
     * reason. Dynamic pages with sensitive content are a candidate for this
394
     * function.
395
     *
396
     * Note, that this will prevent <i>any</i> content invalidation related headers
397
     * like E-Tag to be generated automatically, and that the appropriate
398
     * no-store/no-cache headers from HTTP 1.1 and HTTP 1.0 will be sent automatically.
399
     * This means that there will also be no 304 processing.
400
     *
401
     * You should use this only for sensitive content. For simple dynamic output,
402
     * you are strongly encouraged to use the less strict uncached() function.
403
     *
404
     * @see uncached()
405
     */
406 191
    public function no_cache(Response $response = null)
407
    {
408 191
        $settings = 'no-store, no-cache, must-revalidate';
409
        // PONDER: Send expires header (set to long time in past) as well ??
410
411 191
        if ($response) {
412
            $response->headers->set('Cache-Control', $settings);
413 191
        } else if (!$this->_no_cache) {
414
            if (_midcom_headers_sent()) {
415
                // Whatever is wrong here, we return.
416
                debug_add('Warning, we should move to no_cache but headers have already been sent, skipping header transmission.', MIDCOM_LOG_ERROR);
417
                return;
418
            }
419
420
            _midcom_header('Cache-Control: ' . $settings);
421
        }
422 191
        $this->_no_cache = true;
423 191
    }
424
425
    /**
426
     * Call this, if the currently processed output must not be cached for any
427
     * reason. Dynamic pages or form processing results are the usual candidates
428
     * for this mode.
429
     *
430
     * Note, that this will still keep the caching engine active so that it can
431
     * add the usual headers (ETag, Expires ...) in respect to the no_cache flag.
432
     * As well, at the end of the processing, the usual 304 checks are done, so if
433
     * your page doesn't change in respect of E-Tag and Last-Modified, only a 304
434
     * Not Modified reaches the client.
435
     *
436
     * Essentially, no_cache behaves the same way as if the uncached configuration
437
     * directive is set to true, it is just limited to a single request.
438
     *
439
     * If you need a higher level of client side security, to avoid storage of sensitive
440
     * information on the client side, you should use no_cache instead.
441
     *
442
     * @see no_cache()
443
     */
444 3
    public function uncached($uncached = true)
445
    {
446 3
        $this->_uncached = $uncached;
447 3
    }
448
449
    /**
450
     * Sets the expiration time of the current page (Unix (GMT) Timestamp).
451
     *
452
     * <b>Note:</B> This generate error call will add browser-side cache control
453
     * headers as well to force a browser to revalidate a page after the set
454
     * expiry.
455
     *
456
     * You should call this at all places where you have timed content in your
457
     * output, so that the page will be regenerated once a certain article has
458
     * expired.
459
     *
460
     * Multiple calls to expires will only save the
461
     * "youngest" timestamp, so you can safely call expires where appropriate
462
     * without respect to other values.
463
     *
464
     * The cache's default (null) will disable the expires header. Note, that once
465
     * an expiry time on a page has been set, it is not possible, to reset it again,
466
     * this is for dynamic_load situation, where one component might depend on a
467
     * set expiry.
468
     *
469
     * @param int $timestamp The UNIX timestamp from which the cached page should be invalidated.
470
     */
471
    public function expires($timestamp)
472
    {
473
        if (   $this->_expires === null
474
            || $this->_expires > $timestamp) {
475
            $this->_expires = $timestamp;
476
        }
477
    }
478
479
    /**
480
     * Sets the content type for the current page. The required HTTP Headers for
481
     * are automatically generated, so, to the contrary of expires, you just have
482
     * to set this header accordingly.
483
     *
484
     * This is usually set automatically by MidCOM for all regular HTML output and
485
     * for all attachment deliveries. You have to adapt it only for things like RSS
486
     * output.
487
     *
488
     * @param string $type    The content type to use.
489
     */
490 10
    public function content_type($type)
491
    {
492 10
        midcom::get()->header('Content-Type: ' . $type);
493 10
    }
494
495
    /**
496
     * Put the cache into a "live mode". This will disable the
497
     * cache during runtime, correctly flushing the output buffer (if it's not empty)
498
     * and sending cache control headers.
499
     *
500
     * The midcom-exec URL handler of the core will automatically enable live mode.
501
     *
502
     * @see midcom_application::_exec_file()
503
     */
504
    public function enable_live_mode()
505
    {
506
        $this->no_cache();
507
        Response::closeOutputBuffers(0, ob_get_length() > 0);
508
    }
509
510
    /**
511
     * Store a sent header into the cache database, so that it will
512
     * be resent when the cache page is delivered. midcom_application::header()
513
     * will automatically call this function, you need to do this only if you use
514
     * the PHP header function.
515
     *
516
     * @param string $header The header that was sent.
517
     * @param string $value
518
     */
519 25
    public function register_sent_header($header, $value = null)
520
    {
521 25
        if ($value === null && strpos($header, ': ') !== false) {
522 24
            $parts = explode(': ', $header, 2);
523 24
            $header = $parts[0];
524 24
            $value = $parts[1];
525
        }
526 25
        $this->_sent_headers[$header] = $value;
527 25
    }
528
529
    /**
530
     * Looks for list of content and request identifiers paired with the given guid
531
     * and removes all of those from the caches.
532
     *
533
     * {@inheritDoc}
534
     */
535 298
    public function invalidate($guid, $object = null)
536
    {
537 298
        $guidmap = $this->_meta_cache->fetch($guid);
538 298
        if ($guidmap === false) {
539 298
            debug_add("No entry for {$guid} in meta cache, ignoring invalidation request.");
540 298
            return;
541
        }
542
543
        foreach ($guidmap as $content_id) {
544
            if ($this->_meta_cache->contains($content_id)) {
545
                $this->_meta_cache->delete($content_id);
546
            }
547
548
            if ($this->_data_cache->contains($content_id)) {
549
                $this->_data_cache->delete($content_id);
550
            }
551
        }
552
    }
553
554
    /**
555
     * All objects loaded within a request are stored into a list for cache invalidation purposes
556
     */
557 424
    public function register($guid)
558
    {
559
        // Check for uncached operation
560 424
        if ($this->_uncached) {
561 424
            return;
562
        }
563
564
        $context = midcom_core_context::get()->id;
565
        if ($context != 0) {
566
            // We're in a dynamic_load, register it for that as well
567
            if (!isset($this->context_guids[$context])) {
568
                $this->context_guids[$context] = [];
569
            }
570
            $this->context_guids[$context][] = $guid;
571
        }
572
573
        // Register all GUIDs also to the root context
574
        if (!isset($this->context_guids[0])) {
575
            $this->context_guids[0] = [];
576
        }
577
        $this->context_guids[0][] = $guid;
578
    }
579
580
    /**
581
     * Writes meta-cache entry from context data using given content id
582
     * Used to be part of on_request, but needed by serve-attachment method in midcom_core_urlmethods as well
583
     */
584 1
    public function write_meta_cache($content_id, Request $request, Response $response)
585
    {
586 1
        if (   $this->_uncached
587 1
            || $this->_no_cache) {
588
            return;
589
        }
590
591 1
        if ($this->_expires !== null) {
592
            $lifetime = $this->_expires - time();
593
        } else {
594
            // Use default expiry for cache entry, most components don't bother calling expires() properly
595 1
            $lifetime = $this->_default_lifetime;
596
        }
597
598
        // Construct cache identifier
599 1
        $request_id = $this->generate_request_identifier($request);
600
601
        $entries = [
602 1
            $request_id => $content_id,
603 1
            $content_id => $response->headers->all()
604
        ];
605 1
        $this->_meta_cache->saveMultiple($entries, $lifetime);
606
607
        // Cache where the object have been
608 1
        $context = midcom_core_context::get()->id;
609 1
        $this->store_context_guid_map($context, $content_id, $request_id);
610 1
    }
611
612 1
    private function store_context_guid_map($context, $content_id, $request_id)
613
    {
614
        // non-existent context
615 1
        if (!array_key_exists($context, $this->context_guids)) {
616 1
            return;
617
        }
618
619
        $maps = $this->_meta_cache->fetchMultiple($this->context_guids[$context]);
620
        $to_save = [];
621
        foreach ($this->context_guids[$context] as $guid) {
622
            // Getting old map from cache or create new, empty one
623
            $guidmap = $maps[$guid] ?? [];
624
625
            if (!in_array($content_id, $guidmap)) {
626
                $guidmap[] = $content_id;
627
                $to_save[$guid] = $guidmap;
628
            }
629
630
            if (!in_array($request_id, $guidmap)) {
631
                $guidmap[] = $request_id;
632
                $to_save[$guid] = $guidmap;
633
            }
634
        }
635
636
        $this->_meta_cache->saveMultiple($to_save);
637
    }
638
639 16
    public function check_dl_hit(Request $request)
640
    {
641 16
        if ($this->_no_cache) {
642 16
            return false;
643
        }
644
        $dl_request_id = 'DL' . $this->generate_request_identifier($request);
645
        $dl_content_id = $this->_meta_cache->fetch($dl_request_id);
646
        if ($dl_content_id === false) {
647
            return false;
648
        }
649
650
        return $this->_data_cache->fetch($dl_content_id);
651
    }
652
653 4
    public function store_dl_content($context, $dl_cache_data, Request $request)
654
    {
655 4
        if (   $this->_no_cache
656 4
            || $this->_uncached) {
657 4
            return;
658
        }
659
        $dl_request_id = 'DL' . $this->generate_request_identifier($request);
660
        $dl_content_id = 'DLC-' . md5($dl_cache_data);
661
662
        if ($this->_expires !== null) {
663
            $lifetime = $this->_expires - time();
664
        } else {
665
            // Use default expiry for cache entry, most components don't bother calling expires() properly
666
            $lifetime = $this->_default_lifetime;
667
        }
668
        $this->_meta_cache->save($dl_request_id, $dl_content_id, $lifetime);
669
        $this->_data_cache->save($dl_content_id, $dl_cache_data, $lifetime);
670
        // Cache where the object have been
671
        $this->store_context_guid_map($context, $dl_content_id, $dl_request_id);
672
    }
673
674 1
    private function apply_headers(Response $response, array $headers)
675
    {
676 1
        foreach ($headers as $header => $value) {
677 1
            if ($value === null) {
678
                // compat for old-style midcom status setting
679
                _midcom_header($header);
680
            } else {
681 1
                $response->headers->set($header, $value);
682
            }
683
        }
684 1
    }
685
686
    /**
687
     * This little helper ensures that the headers Content-Length
688
     * and Last-Modified are present. The lastmod timestamp is taken out of the
689
     * component context information if it is populated correctly there; if not, the
690
     * system time is used instead.
691
     *
692
     * To force browsers to revalidate the page on every request (login changes would
693
     * go unnoticed otherwise), the Cache-Control header max-age=0 is added automatically.
694
     */
695 1
    private function complete_sent_headers(Response $response)
696
    {
697 1
        $this->apply_headers($response, $this->_sent_headers);
698
699 1
        if ($date = $response->getLastModified()) {
700
            if ((int) $date->format('U') == -1) {
701
                debug_add("Failed to extract the timecode from the last modified header, defaulting to the current time.", MIDCOM_LOG_WARN);
702
                $response->setLastModified(new DateTime);
703
            }
704
        } else {
705
            /* Determine Last-Modified using MidCOM's component context,
706
             * Fallback to time() if this fails.
707
             */
708 1
            $time = midcom_core_context::get()->get_key(MIDCOM_CONTEXT_LASTMODIFIED) ?: time();
709 1
            $response->setLastModified(DateTime::createFromFormat('U', (string) $time));
0 ignored issues
show
Bug introduced by
It seems like DateTime::createFromFormat('U', (string)$time) can also be of type false; however, parameter $date of Symfony\Component\HttpFo...onse::setLastModified() does only seem to accept DateTime|null, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

709
            $response->setLastModified(/** @scrutinizer ignore-type */ DateTime::createFromFormat('U', (string) $time));
Loading history...
710
        }
711
712 1
        if (!$response->headers->has('Content-Length')) {
713
            /* TODO: Doublecheck the way this is handled, now we just don't send it
714
             * if headers_strategy implies caching */
715 1
            if (!in_array($this->_headers_strategy, ['public', 'private'])) {
716 1
                $response->headers->set("Content-Length", strlen($response->getContent()));
717
            }
718
        }
719
720 1
        $this->cache_control_headers($response);
721 1
    }
722
723
    /**
724
     * @param Response $response
725
     */
726 1
    public function cache_control_headers(Response $response)
727
    {
728
        // Just to be sure not to mess the headers sent by no_cache in case it was called
729 1
        if ($this->_no_cache) {
730
            $this->no_cache($response);
731
        } else {
732
            // Add Expiration and Cache Control headers
733 1
            $strategy = $this->_headers_strategy;
734 1
            $default_lifetime = $this->_default_lifetime;
735 1
            if (   midcom::get()->auth->is_valid_user()
736 1
                || midcom_connection::get_user()) {
737
                $strategy = $this->_headers_strategy_authenticated;
738
                $default_lifetime = $this->_default_lifetime_authenticated;
739
            }
740
741 1
            $now = time();
742 1
            if ($strategy == 'revalidate') {
743
                // If expires is not set, we force the client to revalidate every time.
744
                // The timeout of a content cache entry is not affected by this.
745 1
                $expires = $this->_expires ?? $now;
746
            } else {
747
                $expires = $this->_expires ?? $now + $default_lifetime;
748
                if ($strategy == 'private') {
749
                    $response->setPrivate();
750
                } else {
751
                    $response->setPublic();
752
                }
753
            }
754 1
            $max_age = $expires - $now;
755
756
            $response
757 1
                ->setExpires(DateTime::createFromFormat('U', $expires))
0 ignored issues
show
Bug introduced by
It seems like DateTime::createFromFormat('U', $expires) can also be of type false; however, parameter $date of Symfony\Component\HttpFo...\Response::setExpires() does only seem to accept DateTime|null, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

757
                ->setExpires(/** @scrutinizer ignore-type */ DateTime::createFromFormat('U', $expires))
Loading history...
758 1
                ->setMaxAge($max_age);
759 1
            if ($max_age == 0) {
760 1
                $response->headers->addCacheControlDirective('must-revalidate');
761
            }
762
        }
763 1
    }
764
}
765