File: hook_cron.php

package info (click to toggle)
simplesamlphp 1.19.7-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 42,920 kB
  • sloc: php: 202,044; javascript: 14,867; xml: 2,700; sh: 225; perl: 82; makefile: 70; python: 5
file content (133 lines) | stat: -rw-r--r-- 5,162 bytes parent folder | download | duplicates (3)
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
<?php

use SimpleSAML\Logger;

/**
 * Hook to run a cron job.
 *
 * @param array &$croninfo  Output
 * @return void
 */
function metarefresh_hook_cron(&$croninfo)
{
    assert(is_array($croninfo));
    assert(array_key_exists('summary', $croninfo));
    assert(array_key_exists('tag', $croninfo));

    Logger::info('cron [metarefresh]: Running cron in cron tag ['.$croninfo['tag'].'] ');

    try {
        $config = \SimpleSAML\Configuration::getInstance();
        $mconfig = \SimpleSAML\Configuration::getOptionalConfig('config-metarefresh.php');

        $sets = $mconfig->getConfigList('sets', []);
        /** @var string $datadir */
        $datadir = $config->getPathValue('datadir', 'data/');
        $stateFile = $datadir.'metarefresh-state.php';

        foreach ($sets as $setkey => $set) {
            // Only process sets where cron matches the current cron tag
            $cronTags = $set->getArray('cron');
            if (!in_array($croninfo['tag'], $cronTags, true)) {
                continue;
            }

            Logger::info('cron [metarefresh]: Executing set ['.$setkey.']');

            $expireAfter = $set->getInteger('expireAfter', null);
            if ($expireAfter !== null) {
                $expire = time() + $expireAfter;
            } else {
                $expire = null;
            }

            $outputDir = $set->getString('outputDir');
            $outputDir = $config->resolvePath($outputDir);
            if ($outputDir === null) {
                throw new \Exception("Invalid outputDir specified.");
            }

            $outputFormat = $set->getValueValidate('outputFormat', ['flatfile', 'serialize'], 'flatfile');

            $oldMetadataSrc = \SimpleSAML\Metadata\MetaDataStorageSource::getSource([
                'type' => $outputFormat,
                'directory' => $outputDir,
            ]);

            $metaloader = new \SimpleSAML\Module\metarefresh\MetaLoader($expire, $stateFile, $oldMetadataSrc);

            // Get global blacklist, whitelist, attributewhitelist and caching info
            $blacklist = $mconfig->getArray('blacklist', []);
            $whitelist = $mconfig->getArray('whitelist', []);
            $attributewhitelist = $mconfig->getArray('attributewhitelist', []);
            $conditionalGET = $mconfig->getBoolean('conditionalGET', false);

            // get global type filters
            $available_types = [
                'saml20-idp-remote',
                'saml20-sp-remote',
                'shib13-idp-remote',
                'shib13-sp-remote',
                'attributeauthority-remote'
            ];
            $set_types = $set->getArrayize('types', $available_types);

            foreach ($set->getArray('sources') as $source) {
                // filter metadata by type of entity
                if (isset($source['types'])) {
                    $metaloader->setTypes($source['types']);
                } else {
                    $metaloader->setTypes($set_types);
                }

                // Merge global and src specific blacklists
                if (isset($source['blacklist'])) {
                    $source['blacklist'] = array_unique(array_merge($source['blacklist'], $blacklist));
                } else {
                    $source['blacklist'] = $blacklist;
                }

                // Merge global and src specific whitelists
                if (isset($source['whitelist'])) {
                    $source['whitelist'] = array_unique(array_merge($source['whitelist'], $whitelist));
                } else {
                    $source['whitelist'] = $whitelist;
                }

                # 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 {
                    $source['attributewhitelist'] = $attributewhitelist;
                }

                // Let src specific conditionalGET override global one
                if (!isset($source['conditionalGET'])) {
                    $source['conditionalGET'] = $conditionalGET;
                }

                Logger::debug('cron [metarefresh]: In set ['.$setkey.'] loading source ['.$source['src'].']');
                $metaloader->loadSource($source);
            }

            // Write state information back to disk
            $metaloader->writeState();

            switch ($outputFormat) {
                case 'flatfile':
                    $metaloader->writeMetadataFiles($outputDir);
                    break;
                case 'serialize':
                    $metaloader->writeMetadataSerialize($outputDir);
                    break;
            }

            if ($set->hasValue('arp')) {
                $arpconfig = \SimpleSAML\Configuration::loadFromArray($set->getValue('arp'));
                $metaloader->writeARPfile($arpconfig);
            }
        }
    } catch (\Exception $e) {
        $croninfo['summary'][] = 'Error during metarefresh: '.$e->getMessage();
    }
}