summaryrefslogtreecommitdiff
path: root/platform/www/lib/plugins/meta/syntax.php
blob: 733e5b5d899c580315f7bc509f6eb0166f8c0a7d (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
<?php
/**
 * Meta Plugin: Sets metadata for the current page
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Esther Brunner <wikidesign@gmail.com>
 */
if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once(DOKU_PLUGIN.'syntax.php');

/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_meta extends DokuWiki_Syntax_Plugin
{
    function getType()
    {
        return 'substition';
    }

    function getSort()
    {
        return 99;
    }

    function connectTo($mode)
    {
        $this->Lexer->addSpecialPattern('~~META:.*?~~',$mode,'plugin_meta');
    }

    /**
     * Handle the match
     */
    public function handle($match, $state, $pos, Doku_Handler $handler)
    {
        // strip ~~META: from start and ~~ from end
        $match = substr($match,7,-2);

        $data = array();
        $pairs = explode('&', $match);
        foreach ($pairs as $pair) {
            list($key, $value) = explode('=', $pair, 2);
            list($key, $subkey) = explode(' ', $key, 2);
            if (trim($subkey)) {
                $data[trim($key)][trim($subkey)] = trim($value);
            } else {
                $data[trim($key)] = trim($value);
            }
        }
        $data = array_change_key_case($data, CASE_LOWER);

        return $data;
    }

    /**
     * Create output
     */
    public function render($mode, Doku_Renderer $renderer, $data)
    {
        if ($mode == 'xthml') {
            // don't output anything
            return true;
        } elseif ($mode == 'metadata') {
            /** @var Doku_Renderer_metadata $renderer */

            // do some validation / conversion for date metadata
            if (isset($data['date'])) {
                if (is_array($data['date'])) {
                    foreach ($data['date'] as $key => $date) {
                        $date = $this->convertDate(trim($date));
                        if (!$date) {
                            unset($data['date'][$key]);
                        } else {
                            $data['date'][$key] = $date;
                        }
                    }
                } else {
                    unset($data['date']);
                }
            }

            // now merge the arrays
            $protected = array('description', 'date', 'contributor');
            foreach ($data as $key => $value) {

                // be careful with sub-arrays of $meta['relation']
                if ($key == 'relation') {
                    foreach ($value as $subkey => $subvalue) {
                        if ($subkey == 'media') {
                            $renderer->meta[$key][$subkey][cleanID($subvalue)] = @file_exists(mediaFN($subvalue));
                        } elseif ($subkey == 'firstimage') {
                            /* The metadata renderer overrides the first image value with its internal value at the end.
                            Therefore the only thing we can do is setting this internal value by calling _firstimage.
                            This fails if there has already been a first image saved. */
                            $renderer->_firstimage($subvalue);
                        } else {
                            // for everything else assume that we have a page id
                            $renderer->meta[$key][$subkey][cleanID($subvalue)] = page_exists($subvalue);
                        }
                    }
                } elseif (in_array($key, $protected)) {
                    // be careful with some sensitive arrays of $meta
                    if (is_array($renderer->meta) && is_array($value) && array_key_exists($key, $renderer->meta)) {
                       $renderer->meta[$key] = array_merge($renderer->meta[$key], (array)$value);
                    } else {
                        $renderer->meta[$key] = $value;
                    }
                } else {
                    // no special treatment for the rest
                    $renderer->meta[$key] = $value;
                }
            }
        }
    }

    /**
     * converts YYYY-MM-DD[ hh:mm:ss][ -> [YYYY-MM-DD ]hh:mm:ss] to PHP timestamps
     */
    private function convertDate($date)
    {
        list($start, $end) = explode('->', $date, 2);

        if (!$end) {
            // single date
            list($date, $time) = explode(' ', trim($start), 2);
            if (!preg_match('/\d{4}\-\d{2}\-\d{2}/', $date)) {
                return false;
            }
            $time = $this->autocompleteTime($time);
            return strtotime($date.' '.$time);
        } else {
            // duration

            // start
            list($startdate, $starttime) = explode(' ', trim($start), 2);
            $startdate = $this->autocompleteDate($startdate);
            if (!$startdate) {
                return false;
            }
            $starttime = $this->autocompleteTime($starttime);

            // end
            list($enddate, $endtime) = explode(' ', trim($end), 2);
            if (!trim($endtime)) {
                // only time given
                $end_date = $this->autocompleteDate($enddate, true);
                if (!$end_date) {
                    $endtime = $this->autocompleteTime($enddate, true);
                    $enddate = $startdate;
                } else {
                    // only date given
                    $enddate = $end_date;
                    $endtime = '23:59:59';
                }
            } else {
                $enddate = $this->autocompleteDate($enddate, true);
                if (!$enddate) {
                    $enddate = $startdate;
                }
                $endtime = $this->autocompleteTime($endtime, true);
            }

            $start = strtotime($startdate.' '.$starttime);
            $end   = strtotime($enddate.' '.$endtime);
            if (!$start || !$end) {
                return false;
            }
            return array('start' => $start, 'end' => $end);
        }
    }

    private function autocompleteDate($date, $end=false)
    {
        if (!preg_match('/^\d{4}\-\d{2}\-\d{2}$/', $date)) {
            if (preg_match('/^\d{4}\-\d{2}$/', $date)) {
                // we don't know which month
                return ($end) ? $date.'-28' : $date.'-01';
            } elseif (preg_match('/^\d{4}$/', $date)) {
                return ($end) ? $date.'-12-31' : $date.'-01-01';
            } else {
                return false;
            }
        } else {
            return $date;
        }
    }

    private function autocompleteTime($time, $end=false)
    {
        if (!preg_match('/^\d{2}:\d{2}:\d{2}$/', $time)) {
            if (preg_match('/^\d{2}:\d{2}$/', $time)) {
                return ($end) ? $time.':59' : $time.':00';
            } elseif (preg_match('/^\d{2}$/', $time)) {
                return ($end) ? $time.':59:59': $time.':00:00';
            } else {
                return ($end) ? '23:59:59' : '00:00:00';
            }
        } else {
            return $time;
        }
    }
}
// vim:ts=4:sw=4:et:enc=utf-8: