Implemented error reporting mechanism.
[philipp/winterrodeln/mediawiki_extensions/wrreport.git] / wrreport.body.php
1 <?php
2
3
4 // Init
5 // ----
6
7 function wrReportParserInit() {
8         global $wgParser;
9         $wgParser->setHook('bahnberichtformular', 'bahnberichtformularParserHook');
10         $wgParser->setHook('bahnberichte', 'bahnberichteParserHook');
11         $wgParser->setHook('bahnbewertung', 'bahnbewertungParserHook');
12         return true;
13 }
14
15
16 // Tool functions
17 // --------------
18
19 /// \brief This function is used to translate WikiText to HTML. Normally it should be avoided to do this
20 /// but I found situations where I did not find an other possibility.
21 function wrReportSandboxParse($wikiText) {
22         global $wgTitle, $wgUser;
23         $myParser = new Parser();
24         $myParserOptions = new ParserOptions();
25         $myParserOptions->initialiseFromUser($wgUser);
26         $result = $myParser->parse($wikiText, $wgTitle, $myParserOptions);
27         return $result->getText();
28 }
29
30
31 /// List of markers - used by the functions replaceByMarker and wrReportAfterTidy
32 $wrReportMarkerList = array();
33
34
35 /// Returns a marker for a text and back-replaces the text in wrReportAfterTidy
36 function replaceByMarker($text, $marker = 'marker') {
37         $marker = $marker . mt_rand(1e5, 1e7);
38         global $wrReportMarkerList;
39         $wrReportMarkerList[$marker] = $text;
40         return $marker;
41 }
42
43
44 /// Replaces the markers by its contents
45 function wrReportAfterTidy(&$parser, &$text) {
46         // find markers in $text
47         // replace markers with actual output
48         global $wrReportMarkerList;
49         foreach ($wrReportMarkerList as $marker => $html) $text = str_replace($marker, $html, $text);
50         return true;
51 }
52
53
54
55 // Render Functions
56 // ----------------
57
58 /// \brief Returns a form to enter a report (string containing HTML).
59 ///
60 /// All parameters have to be UTF-8 encoded.
61 /// \param $page_title Name of the sledding run.
62 /// \return UTF-8 encoded HTML form
63 function wrReportFormRender($hide_save_button = TRUE, $page_title = NULL, $date_report = NULL, $condition = NULL, $description = NULL, $author_name = NULL, $page_title_list = NULL) {
64         if ($page_title) $page_title = htmlspecialchars($page_title);
65         // Date options
66         $tagnamen = array('Heute', 'Gestern', 'Vorgestern', 'Vor 3 Tagen', 'Vor 4 Tagen');
67         $date_options = '';
68         $date_selected = FALSE;
69         for ($tag=0; $tag!=5; ++$tag) {
70                 $datum = time() - $tag*24*60*60;
71                 $datum_f = strftime("%Y-%m-%d", $datum);
72                 $date_options .= '<option value="' . $datum_f . '"';
73                 // var_dump($date_report);
74                 // var_dump($datum_f);
75                 if ((is_null($date_report) && $tag == 0) || (!is_null($date_report) && $date_report == $datum_f)) {
76                         $date_options .= ' selected="selected"';
77                         $date_selected = TRUE;
78                 }
79                 $date_options .= '>' . htmlspecialchars($tagnamen[$tag]) . ' (' . strftime('%d.%m.', $datum) . ')</option>' . "\n";
80         }
81         if (!$date_selected) {
82                 $date_options = '<option value="' . $date_report . '" selected="selected">' . htmlspecialchars($date_report) . "</option>\n" . $date_options;
83         }
84         
85         // Condition options
86         $condition_options = '';
87         $condition_array = array(1 => 'Sehr gut', 2 => 'Gut', 3 => 'Mittelmäßig', 4 => 'Schlecht', 5 => 'Geht nicht');
88         $condition_options .= '<option value="">(keine Beurteilung)</option>' . "\n";
89         foreach ($condition_array as $condition_num => $condition_text) {
90                 $condition_options .= "<option value=\"$condition_num\"";
91                 if ($condition == $condition_num) $condition_options .= ' selected="selected"';
92                 $condition_options .= '>' . htmlspecialchars(utf8_encode($condition_text)) . "</option>\n";
93         }
94         $description = htmlspecialchars($description);
95
96         // Buttons
97         $buttons = '<button name="action" type="submit" value="preview">Vorschau';
98         if ($hide_save_button) $buttons .= ' &amp; Speichern';
99         $buttons .= '</button>';
100         if (!$hide_save_button) $buttons .= '<button name="action" type="submit" value="store">Speichern</button>';
101
102         $form = <<<EOT
103 <form action="/wiki/Spezial:Bahnberichte" method="post">
104 <table class="wrreportform" summary="Formular zum Eintragen eines Rodelbahnberichtes">
105         <tr class="oddrow"><th>Rodelbahn</th><td>$page_title<input type="hidden" name="page_title" value="$page_title"/></td></tr>
106         <tr class="evenrow"><th>Datum des Rodelns</th>
107         <td>
108         <select name="date_report">
109         $date_options
110         </select>
111         </td>
112         </tr>
113         <tr class="oddrow"><th>Bahnzustand*</th><td><select name="condition">
114         $condition_options
115         </select></td></tr>
116         <tr class="evenrow"><th>Meinung</th><td><textarea name="description" cols="50" rows="7">$description</textarea></td></tr>
117         <tr class="oddrow"><th>Autor/in</th><td><input name="author_name" maxlength="30" size="30" value="$author_name" /></td></tr>
118         <tr class="evenrow"><th>Bericht abschicken</th><td>$buttons</td></tr>
119 </table>
120 </form>
121 EOT;
122         return $form;
123 }
124
125
126
127 /// \brief sub-function of wrRenderReportTable
128 /// \return UTF-8 encoded titles of HTML table
129 function wrReportTableTitleRender($page_id, $page_title, $date_report, $date_entry, $date_invalid, $condition, $description, $author_name) {
130         $out = '<tr>';
131         if ($page_id) $out .= '<th>ID</th>';
132         if ($page_title) $out .= '<th>Bahn</th>';
133         if ($date_report) $out .= '<th>Datum</th>';
134         if ($date_entry) $out .= '<th>Datum Eintrag</th>';
135         if ($date_invalid) $out .= '<th>Datum Ungültig</th>';
136         if ($condition) $out .= '<th>Zustand</th>';
137         if ($description) $out .= '<th>Beschreibung</th>';
138         if ($author_name) $out .= '<th>Autor</th>';
139         return utf8_encode($out . "</tr>\n");
140 }
141
142
143 /// sub-function of wrRenderReportTable
144 /// The in- and output parameters are expected to be UTF-8 encoded
145 function wrReportTableRowRender($page_id, $page_title, $date_report, $date_entry, $date_invalid, $condition, $description, $author_name) {
146         $out = "<tr>";
147         if (!is_null($page_id)) $out .= '<td>' . $page_id . '</td>';
148         if (!is_null($page_title)) $out .= '<td>' . wrReportSandboxParse('[[' . $page_title . ']]') . '</td>';
149         $out .= '<td>' . $date_report . '</td>';
150         if (!is_null($date_entry)) $out .= '<td>' . date('Y-m-d, H:i', strtotime($date_entry)) . '</td>';
151         if (!is_null($date_invalid)) $out .= '<td>' . date('Y-m-d, H:i', strtotime($date_invalid)) . '</td>';
152         $out .= '<td>' . $condition . '</td>';
153         $out .= '<td>' . htmlspecialchars($description) . '</td>';
154         $out .= '<td>' . htmlspecialchars($author_name) . '</td>';
155         $out .= "</tr>\n";
156         return $out;
157 }
158
159
160 /// \brief It returns a table (string containing HTML) showing the results.
161 ///
162 /// Is called when the tag <bahnberichte/> is encounted and renders a table /
163 /// \param $page_title If the name is specified (UTF-8 encoded), only reports of this "page" (e.g. 'Birgitzer Alm') is shown. Default: NULL
164 /// \return UTF-8 encoded HTML result table
165 function wrReportTableRender($page_title = NULL) {
166         $out = '';
167         $dbr = wfGetDB(DB_SLAVE);
168         $conditions = array();
169         if ($page_title) $conditions['page_title'] = $page_title;
170         $res = $dbr->select('wrreport', array('id', 'page_title', 'date_report', 'date_entry', 'date_invalid', 'condition', 'description', 'author_name', 'author_username'), $conditions, $fname = 'Database::select', $options = array('ORDER BY' => 'date_report, date_entry'));
171         $admin = is_null($page_title);
172         if ($res->numRows() > 0) {
173                 $out .= "<table class=\"wrreporttable\">\n";
174                 $out .= wrReportTableTitleRender($admin, $admin, TRUE, $admin, $admin, TRUE, TRUE, TRUE);
175                 while ($row = $dbr->fetchObject($res)) {
176                         $author = $row->author_name;
177                         $out .= wrReportTableRowRender($admin ? $row->id : NULL, $admin ? $row->page_title : NULL, $row->date_report, $admin ? $row->date_entry : NULL, $admin ? $row->date_invalid : NULL, $row->condition, $row->description, $author);
178                 }
179                 $out .= "</table>\n";
180         } else {
181                 $out .= "<p>Es wurden keine Bahnberichte in der Datenbank gefunden.</p>\n";
182         }
183         $dbr->freeResult($res);
184         return $out;
185 }
186
187
188 /// \brief It returns an array of the "condition" (as number) and the date of the "most recent" report of the specified page (to decode as list($condition, $date);
189 ///
190 /// If no condition is present, array(NULL, NULL) is returned
191 function wrReportConditionRender($page_title) {
192         $dbr = wfGetDB(DB_SLAVE);
193         $res = $dbr->select('wrreport', array('max(wrreport.id) as max'), array('page_title' => $page_title, 'condition is not null', 'date_invalid > now()'));
194         //  select condition, date_report from wrreport where id = (select max(wrreport.id) as max from wrreport where page_title='Birgitzer Alm (vom Adelshof)' and date_invalid > now() and condition is not null);
195         if ($res->numRows() <= 0) return array(NULL, NULL);
196         $row = $dbr->fetchObject($res);
197         $res = $dbr->select('wrreport', array('condition', 'date_report'), array('id' => $row->max));
198         if ($res->numRows() <= 0) return array(NULL, NULL);
199         $row = $dbr->fetchObject($res);
200         return array($row->condition, $row->date_report);
201 }
202
203
204 // Parser Hook Functions
205 // ---------------------
206
207 /// \brief Is called when the tag <bahnberichtformular/> is encountered.
208 ///
209 /// The current page name is taken.
210 function bahnberichtformularParserHook($input, $args, $parser) {
211         global $wgUser;
212         $author_name = NULL;
213         if ($wgUser->isLoggedIn()) {
214                 $author_name = $wgUser->getRealName();
215                 if (!$author_name) $author_name = $wgUser->getName();
216         }
217         return replaceByMarker(wrReportFormRender(TRUE, $parser->getTitle()->getText(), NULL, NULL, NULL, $author_name));
218 }
219
220
221 /// \brief Is called when the tag <bahnberichte/> is encountered.
222 ///
223 /// The current page name is taken.
224 function bahnberichteParserHook($input, $args, &$parser) {
225         return wrReportTableRender($parser->getTitle()->getText());
226 }
227
228
229 /// \brief Is called when the tag <bahnbewertung/> is encountered.
230 ///
231 /// * <bahnbewertung/>: The current page name is taken.
232 /// * <bahnbewertung>page_name</bahnbewertung>: The given page name is taken.
233 function bahnbewertungParserHook($input, $args, &$parser) {
234         if (!$input) $input = $parser->getTitle()->getText();
235         list($condition, $date) = wrReportConditionRender($input);
236         return "$condition ($date)";
237 }
238
239
240
241 // Special page
242 // ------------
243
244 /// Specal Page to show reports
245 class WrReport extends SpecialPage {
246         function WrReport() {
247                 SpecialPage::SpecialPage('WrReport');
248                 wfLoadExtensionMessages('WrReport');
249         }
250
251
252         /// \param $par Possibilities:
253         /// - action == 'view' (default)
254         /// - action == 'preview': Preview new report
255         /// - action == 'store': Store new report
256         /// \param $override_action If not NULL (defualt), it overrides the action in $par
257         /// \param $errorMsg UFT-8 encoded error message (in WikiText) to show on top of the page or NULL (default):
258         function execute($par, $override_action = NULL, $errorMsg = NULL) {
259                 global $wgRequest, $wgOut;
260
261                 $this->setHeaders();
262
263                 // Get request data
264                 $action = $wgRequest->getText('action');
265                 if ($action === '')  $action = 'view';
266                 if ($override_action) $action = $override_action;
267
268                 // Show error message
269                 if ($errorMsg) {
270                         $wgOut->addWikiText(utf8_encode('<div class="errorbox">') . $errorMsg . utf8_encode("</div>\n\n"));
271                 }
272
273                 // Action view
274                 if ($action == 'view') {                
275                         $wgOut->addHTML(wrRenderReportTable());
276                 }
277
278                 // Action preview or store
279                 elseif ($action == 'preview' || $action == 'store') {
280                         $page_title = $wgRequest->getText('page_title');
281                         $date_report = $wgRequest->getText('date_report');
282                         $condition = $wgRequest->getText('condition');
283                         $description = $wgRequest->getText('description');
284                         $author_name = $wgRequest->getText('author_name');
285                         if ($action == 'store') {
286                                 // page_id
287                                 $title = Title::newFromText($page_title);
288                                 $page_id = $title->getArticleId();
289                                 if ($page_id == 0) $page_id = NULL;
290                                 
291                                 // user_id
292                                 global $wgUser;
293                                 $author_userid = $wgUser->getId();
294                                 if ($author_userid == 0) $author_userid = NULL; // to store a NULL value in the database if no user is logged in instead of 0.
295                                 $author_username = $wgUser->getName();
296
297                                 // condition
298                                 $condition_int = (int) $condition;
299                                 if ($condition_int >= 1 and $condition_int <= 5) $condition = $condition_int;
300                                 else $condition = NULL;
301                                 
302                                 // check conditions/permissions
303                                 $errorMsg = NULL;
304                                 if (!$page_id) $errorMsg = utf8_encode('Die angegebene Seite wurde nicht gefunden.');
305                                 elseif (!$wgUser->isLoggedIn()) {
306                                         if (!(stripos($description, 'http') === FALSE))  $errorMsg = utf8_encode('Der Text "http" ist leider für nicht-angemeldete Benutzer nicht erlaubt, weil wir in der Vergangenheit Fälle hatten, bei denen externe Werbelinks automatisiert eingetragen wurden.');
307                                 }
308                                 if ($errorMsg) {
309                                         $this->execute($par, 'preview', $errorMsg);
310                                         return;
311                                 }
312
313                                 // Save entry
314                                 $dbr = wfGetDB(DB_MASTER);
315                                 $dbr->insert(
316                                         'wrreport', 
317                                         array(
318                                                 'page_id' => $page_id, 
319                                                 'page_title' => $page_title, 
320                                                 'date_report' => $date_report, 
321                                                 // 'date_entry' => '',  // use database default
322                                                 // 'date_invalid' => '', // use database default
323                                                 'condition' => $condition,
324                                                 'description' => $description,
325                                                 'author_name' => $author_name,
326                                                 'author_ip' => $_SERVER['REMOTE_ADDR'],
327                                                 'author_userid' => $author_userid,
328                                                 'author_username' => $author_username
329                                         )
330                                 );
331
332                                 // Purge cache
333                                 $title->invalidateCache();
334                                 // Show success message
335                                 $wgOut->addWikiText(utf8_encode('<div class="successbox">Der Bahnbericht für [[') . $page_title . utf8_encode('#Einträge|') . $page_title . utf8_encode("]] wurde erfolgreich gespeichert.</div>\n\n"));
336                                 // We could redirect to result with the following line but we don't want to.
337                                 // $wgOut->redirect($title->getFullURL() . '#Eintr.C3.A4ge');
338                         }
339                         if ($action == 'preview') {
340                                 $wgOut->addWikiText(utf8_encode("== Vorschau (noch nicht gespeichert) ==\n"));
341                                 $wgOut->addHTML("<table class=\"wrreporttable\">\n");
342                                 $wgOut->addHTML(wrReportTableTitleRender(FALSE, TRUE, TRUE, FALSE, FALSE, TRUE, TRUE, TRUE));
343                                 $wgOut->addHTML(wrReportTableRowRender(NULL, $page_title, $date_report, NULL, NULL, $condition, $description, $author_name));
344                                 $wgOut->addHTML("</table>");
345                                 $wgOut->addWikiText("\n");
346                                 $wgOut->addWikiText(utf8_encode("== Speichern oder Ändern ==\n"));
347                                 $wgOut->addHTML(wrReportFormRender(FALSE, $page_title, $date_report, $condition, $description, $author_name));
348                         } 
349                         
350                 }
351
352                 else die('Wrong action');
353         }
354 }
355
356
357 ?>