Imported already done development to source control.
authorphilipp <philipp@7aebc617-e5e2-0310-91dc-80fb5f6d2477>
Fri, 24 Oct 2008 15:52:16 +0000 (15:52 +0000)
committerphilipp <philipp@7aebc617-e5e2-0310-91dc-80fb5f6d2477>
Fri, 24 Oct 2008 15:52:16 +0000 (15:52 +0000)
git-svn-id: http://www.winterrodeln.org/svn/servermediawiki/trunk/extensions/wrreport@272 7aebc617-e5e2-0310-91dc-80fb5f6d2477

wrreport.body.php [new file with mode: 0644]
wrreport.i18n.php [new file with mode: 0644]
wrreport.php [new file with mode: 0644]

diff --git a/wrreport.body.php b/wrreport.body.php
new file mode 100644 (file)
index 0000000..9bc63a5
--- /dev/null
@@ -0,0 +1,252 @@
+<?php
+
+
+$wrReportMarkerList = array();
+
+
+function wrReportParserInit() {
+       global $wgParser;
+       $wgParser->setHook('bahnberichtformular', 'wrReportFormRender');
+       $wgParser->setHook('bahnberichte', 'wrReportTableRender');
+       return true;
+}
+
+
+/// \todo: Remove this function: The table function could output wikitext directly.
+function wrReportSandboxParse($wikiText) {
+        global $wgTitle, $wgUser;
+        $myParser = new Parser();
+        $myParserOptions = new ParserOptions();
+        $myParserOptions->initialiseFromUser($wgUser);
+        $result = $myParser->parse($wikiText, $wgTitle, $myParserOptions);
+        return $result->getText();
+}
+
+
+/// \brief Returns a form to enter a report (string containing HTML).
+///
+/// All parameters have to be UTF-8 encoded.
+/// \param $page_title Name of the sledding run.
+/// \return UTF-8 encoded HTML form
+function wrRenderReportForm($hide_save_button = TRUE, $page_id = NULL, $page_title = NULL, $date_report = NULL, $condition = NULL, $description = NULL, $author_name = NULL, $page_title_list = NULL) {
+       if ($page_id) $page_id = (int) $page_id;
+       if ($page_title) $page_title = htmlspecialchars($page_title);
+       // Date options
+       $tagnamen = array('Heute', 'Gestern', 'Vorgestern', 'Vor 3 Tagen', 'Vor 4 Tagen');
+       $date_options = '';
+       $date_selected = FALSE;
+       for ($tag=0; $tag!=5; ++$tag) {
+               $datum = time() - $tag*24*60*60;
+               $datum_f = strftime("%Y-%m-%d", $datum);
+               $date_options .= '<option value="' . $datum_f . '"';
+               // var_dump($date_report);
+               // var_dump($datum_f);
+               if ((is_null($date_report) && $tag == 0) || (!is_null($date_report) && $date_report == $datum_f)) {
+                       $date_options .= ' selected="selected"';
+                       $date_selected = TRUE;
+               }
+               $date_options .= '>' . htmlspecialchars($tagnamen[$tag]) . ' (' . strftime('%d.%m.', $datum) . ')</option>' . "\n";
+       }
+       if (!$date_selected) {
+               $date_options = '<option value="' . $date_report . '" selected="selected">' . htmlspecialchars($date_report) . "</option>\n" . $date_options;
+       }
+       
+       // Condition options
+       $condition_options = '';
+       $condition_array = array(1 => 'Sehr gut', 2 => 'Gut', 3 => 'Mittelmäßig', 4 => 'Schlecht', 5 => 'Geht nicht');
+       $condition_options .= '<option value="">(keine Beurteilung)</option>' . "\n";
+       foreach ($condition_array as $condition_num => $condition_text) {
+               $condition_options .= "<option value=\"$condition_num\"";
+               if ($condition == $condition_num) $condition_options .= ' selected="selected"';
+               $condition_options .= '>' . htmlspecialchars(utf8_encode($condition_text)) . "</option>\n";
+       }
+       $description = htmlspecialchars($description);
+
+       // Buttons
+       $buttons = '<button name="action" type="submit" value="preview">Vorschau';
+       if ($hide_save_button) $buttons .= ' &amp; Speichern';
+       $buttons .= '</button>';
+       if (!$hide_save_button) $buttons .= '<button name="action" type="submit" value="store">Speichern</button>';
+
+       $form = <<<EOT
+<form action="/wiki/Spezial:Bahnberichte" method="post">
+<table class="wrreportform" summary="Formular zum Eintragen eines Rodelbahnberichtes">
+       <tr class="oddrow"><th>Rodelbahn</th><td>$page_title<input type="hidden" name="page_id" value="$page_id"/><input type="hidden" name="page_title" value="$page_title"/></td></tr>
+       <tr class="evenrow"><th>Datum des Rodelns</th>
+       <td>
+       <select name="date_report">
+       $date_options
+       </select>
+       </td>
+       </tr>
+       <tr class="oddrow"><th>Bahnzustand*</th><td><select name="condition">
+       $condition_options
+       </select></td></tr>
+       <tr class="evenrow"><th>Meinung</th><td><textarea name="description" cols="50" rows="7">$description</textarea></td></tr>
+       <tr class="oddrow"><th>Autor/in</th><td><input name="author_name" maxlength="30" size="30" value="$author_name" /></td></tr>
+       <tr class="evenrow"><th>Bericht abschicken</th><td>$buttons</td></tr>
+</table>
+</form>
+EOT;
+       $marker = 'wrReportFormMarker' . mt_rand(1e5, 1e7);
+       global $wrReportMarkerList;
+       $wrReportMarkerList[$marker] = $form;
+       return $marker;
+}
+
+
+
+/// \brief sub-function of wrRenderReportTable
+/// \return UTF-8 encoded titles of HTML table
+function wrRenderReportTableTitle($page_id, $page_title, $date_report, $date_entry, $date_invalid, $condition, $description, $author_name) {
+       $out = '<tr>';
+       if ($page_id) $out .= '<th>ID</th>';
+       if ($page_title) $out .= '<th>Bahn</th>';
+       if ($date_report) $out .= '<th>Datum</th>';
+       if ($date_entry) $out .= '<th>Datum Eintrag</th>';
+       if ($date_invalid) $out .= '<th>Datum Ungültig</th>';
+       if ($condition) $out .= '<th>Zustand</th>';
+       if ($description) $out .= '<th>Beschreibung</th>';
+       if ($author_name) $out .= '<th>Autor</th>';
+       return utf8_encode($out . "</tr>\n");
+}
+
+
+/// sub-function of wrRenderReportTable
+function wrRenderReportTableRow($page_id, $page_title, $date_report, $date_entry, $date_invalid, $condition, $description, $author_name) {
+       $out = "<tr>";
+       if (!is_null($page_id)) $out .= '<td>' . $page_id . '</td>';
+       if (!is_null($page_title)) $out .= '<td>' . wrReportSandboxParse('[[' . $page_title . ']]') . '</td>';
+       $out .= '<td>' . $date_report . '</td>';
+       if (!is_null($date_entry)) $out .= '<td>' . date('Y-m-d, H:i', strtotime($date_entry)) . '</td>';
+       if (!is_null($date_invalid)) $out .= '<td>' . date('Y-m-d, H:i', strtotime($date_invalid)) . '</td>';
+       $out .= '<td>' . $condition . '</td>';
+       $out .= '<td>' . $description . '</td>';
+       $out .= '<td>' . $author_name . '</td>';
+       $out .= "</tr>\n";
+       return $out;
+}
+
+
+/// \brief It returns a table (string containing HTML) showing the results.
+///
+/// Is called when the tag <bahnberichte/> is encounted and renders a table /
+/// \param $page_title If the name is specified (UTF-8 encoded), only reports of this "page" (e.g. 'Birgitzer Alm') is shown. Default: NULL
+/// \return UTF-8 encoded HTML result table
+function wrRenderReportTable($page_title = NULL) {
+       $out = '';
+       $dbr = wfGetDB(DB_SLAVE);
+       $conditions = array();
+       if ($page_title) $conditions['page_title'] = $page_title;
+       $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'));
+       $admin = is_null($page_title);
+       if ($res->numRows() > 0) {
+               $out .= "<table class=\"wrreporttable\">\n";
+               $out .= wrRenderReportTableTitle($admin, $admin, TRUE, $admin, $admin, TRUE, TRUE, TRUE);
+               while ($row = $dbr->fetchObject($res)) {
+                       $author = $row->author_name;
+                       if ($row->author_username) $author .= ' (' . $row->author_username . ')';
+                       $out .= wrRenderReportTableRow($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);
+               }
+               $out .= "</table>\n";
+       } else {
+               $out .= "<p>Es wurden keine Bahnberichte in der Datenbank gefunden.</p>\n";
+       }
+       $dbr->freeResult($res);
+       return $out;
+}
+
+
+/// Is called when the tag <bahnberichte/> is encounted.
+function wrReportFormRender($input, $args, $parser) {
+       return wrRenderReportForm(TRUE, $parser->getTitle()->getArticleID(), $parser->getTitle()->getText());
+}
+
+
+
+function wrReportTableRender($input, $args, &$parser) {
+       return wrRenderReportTable($parser->getTitle());
+}
+
+
+
+/// Specal Page to show reports
+class WrReport extends SpecialPage {
+       function WrReport() {
+               SpecialPage::SpecialPage('WrReport');
+               wfLoadExtensionMessages('WrReport');
+       }
+
+
+       /// Possibilities for $par:
+       /// - action == 'view' (default)
+       /// - action == 'preview': Preview new report
+       /// - action == 'store': Store new report
+       /// - action == 'success': Show a success message
+       function execute($par) {
+               global $wgRequest, $wgOut;
+
+               $this->setHeaders();
+
+               # Get request data from, e.g.
+               $action = $wgRequest->getText('action');
+               if ($action === '')  $action = 'view';
+
+               if ($action == 'view') {                
+                       $wgOut->addHTML(wrRenderReportTable());
+               }
+
+               elseif ($action == 'preview' || $action == 'store') {
+                       $page_id = $wgRequest->getText('page_id');
+                       $page_title = $wgRequest->getText('page_title');
+                       $date_report = $wgRequest->getText('date_report');
+                       $condition = $wgRequest->getText('condition');
+                       $description = $wgRequest->getText('description');
+                       $author_name = $wgRequest->getText('author_name');
+                       if ($action == 'store') {
+                               // TODO: check conditions/permissions
+                               $dbr = wfGetDB(DB_MASTER);
+                               $dbr->insert(
+                                       'wrreport', 
+                                       array(
+                                               'page_id' => (int) $page_id, 
+                                               'page_title' => $page_title, 
+                                               'date_report' => $date_report, 
+                                               // 'date_entry' => '',  // use database default
+                                               // 'date_invalid' => '', // use database default
+                                               'condition' => $condition,
+                                               'description' => $description,
+                                               'author_name' => $author_name,
+                                               'author_username' => '',
+                                               'author_ip' => $_SERVER['REMOTE_ADDR']
+                                       )
+                               );
+                               $wgOut->addHTML('<p>Bahnbericht gespeichert! :-)</p>');
+                       }
+                       if ($action == 'preview') {
+                               $wgOut->addHTML("<h3>Vorschau (noch nicht gespeichert)</h3>\n");
+                               $wgOut->addHTML("<table>\n");
+                               $wgOut->addHTML(wrRenderReportTableTitle(FALSE, TRUE, TRUE, FALSE, FALSE, TRUE, TRUE, TRUE));
+                               $wgOut->addHTML(wrRenderReportTableRow($page_id, $page_title, $date_report, NULL, NULL, $condition, $description, $author_name));
+                               $wgOut->addHTML("</table>\n");
+                               $wgOut->addHTML(utf8_encode("<h3>Speichern oder Ändern</h3>\n"));
+                               $wgOut->addHTML(wrRenderReportForm(FALSE, $page_id, $page_title, $date_report, $condition, $description, $author_name));
+                       } 
+                       
+               }
+
+               else die('Wrong action');
+       }
+}
+
+
+function wrReportAfterTidy(&$parser, &$text) {
+        // find markers in $text
+        // replace markers with actual output
+        global $wrReportMarkerList;
+        foreach ($wrReportMarkerList as $marker => $html) $text = str_replace($marker, $html, $text);
+        return true;
+}
+
+
+?>
diff --git a/wrreport.i18n.php b/wrreport.i18n.php
new file mode 100644 (file)
index 0000000..1f377e9
--- /dev/null
@@ -0,0 +1,12 @@
+<?php
+$messages = array();
+$messages['en'] = array( 
+       'wrreport' => 'Reports'
+);
+$messages['de'] = array(
+       'wrreport' => 'Bahnberichte'
+);
+$messages['de-formal'] = array(
+       'wrreport' => 'Bahnberichte'
+);
+?>
diff --git a/wrreport.php b/wrreport.php
new file mode 100644 (file)
index 0000000..91d5d96
--- /dev/null
@@ -0,0 +1,43 @@
+<?php
+# Alert the user that this is not a valid entry point to MediaWiki if they try to access the special pages file directly.
+if (!defined('MEDIAWIKI')) {
+       echo "To install the wrreport extension, put the following line in LocalSettings.php:\n";
+       echo 'require_once("\$IP/extensions/MyExtension/MyExtension.php");';
+       exit(1);
+}
+
+
+$dir = dirname(__FILE__) . '/';
+$wgAutoloadClasses['WrReport'] = $dir . 'wrreport.body.php';
+$wgExtensionMessagesFiles['WrReport'] = $dir . 'wrreport.i18n.php';
+$wgSpecialPages['WrReport'] = 'WrReport';
+$wgHooks['LanguageGetSpecialPageAliases'][] = 'wrReportLocalizedPageName';
+$wgHooks['ParserAfterTidy'][] = 'wrReportAfterTidy';
+$wgHooks['ParserFirstCallInit'][] = 'wrReportParserInit';
+
+function wrReportLocalizedPageName(&$specialPageArray, $code) {
+       # The localized title of the special page is among the messages of the extension:
+       wfLoadExtensionMessages('WrReport');
+       $text = wfMsg('wrreport');
+
+       # Convert from title in text form to DBKey and put it into the alias array:
+       $title = Title::newFromText($text);
+       $specialPageArray['WrReport'][] = $title->getDBKey();
+       return true;
+}
+
+
+
+$wgExtensionCredits['parserhook'][] = array(
+       'name' => 'Winterrodeln Report',
+       'version' => '0.1 alpha',
+       'author' =>'Philipp Spitzer', 
+       'url' => 'http://www.winterrodeln.org', 
+       'description' => 'This extension interprets the <report/> tag in sledding pages and creates report summaries'
+);
+
+
+require_once dirname(__FILE__) . '/wrreport.body.php';
+
+?>