Force refetching source if our cached copy will expire (#44)

* Force refetching source if our cached copy will expire

If we set the `expiresAfter` option in metarefresh's config, we
effectively alter the inbound metadata. Thus when we're conditionally
GETting, we need to be aware that we've introduced a validUntil
attribute that the remote server may not know about. That means we
might need to force a refresh of the source even if the remote server
does not think it has been modified.

* Use only DateTime objects

Author: ghalse

src/MetaLoader.php

@@ -4,6 +4,8 @@
 
 namespace SimpleSAML\Module\metarefresh;
 
+use DateInterval;
+use DateTimeImmutable;
 use Exception;
 use SimpleSAML\Configuration;
 use SimpleSAML\Logger;
@@ -393,6 +395,26 @@ private function createContext(array $source): array
             if (array_key_exists($source['src'], $this->state)) {
                 $sourceState = $this->state[$source['src']];
 
+                /*
+                 * If an expireAfter value exists, we effectively altered the metadata's validUntil ourselves
+                 * so we may need to refresh the metadata even if the source indicates it has not changed.
+                 */
+                if (isset($source['expireAfter']) && isset($sourceState['requested_at'])) {
+                    $requestedAt = new DateTimeImmutable($sourceState['requested_at']);
+                    $expiresAt = $requestedAt->add(new DateInterval('PT' . $source['expireAfter'] . 'S'));
+                    $refreshThreshold = $expiresAt->sub(new DateInterval('PT1H')); // 1 hour based on default cron tags
+                    $now = new DateTimeImmutable();
+                    if ($now >= $refreshThreshold) {
+                        Logger::info(sprintf(
+                            'Cached metadata for %s expires soon - forcing refresh even if not changed',
+                            $source['src'],
+                        ));
+                        unset($sourceState['last-modified']);
+                        unset($sourceState['etag']);
+                        $rawheader .= 'Cache-Control: max-age=0' . "\r\n";
+                    }
+                }
+
                 if (isset($sourceState['last-modified'])) {
                     $headers['If-Modified-Since'] = $sourceState['last-modified'];
                 }

src/MetaRefresh.php

@@ -113,7 +113,7 @@ public function runRefresh(?string $crontag = null): void
                     $source['whitelist'] = $whitelist;
                 }
 
-                # Merge global and src specific attributewhitelists: cannot use array_unique for multi-dim.
+                // Merge global and src specific attributewhitelists: cannot use array_unique for multi-dim.
                 if (isset($source['attributewhitelist'])) {
                     $source['attributewhitelist'] = array_merge($source['attributewhitelist'], $attributewhitelist);
                 } else {
@@ -125,6 +125,11 @@ public function runRefresh(?string $crontag = null): void
                     $source['conditionalGET'] = $conditionalGET;
                 }
 
+                // make our cache expiry available to the loader if we're conditionally GETting
+                if ($source['conditionalGET'] && isset($expireAfter)) {
+                    $source['expireAfter'] = $expireAfter;
+                }
+
                 Logger::debug('[metarefresh]: In set [' . $setkey . '] loading source [' . $source['src'] . ']');
                 $metaloader->loadSource($source);
             }