diff options
Diffstat (limited to 'ratatoeskr/frontend.php')
| -rw-r--r-- | ratatoeskr/frontend.php | 748 |
1 files changed, 748 insertions, 0 deletions
diff --git a/ratatoeskr/frontend.php b/ratatoeskr/frontend.php new file mode 100644 index 0000000..eff7511 --- /dev/null +++ b/ratatoeskr/frontend.php @@ -0,0 +1,748 @@ +<?php +/* + * File: ratatoeskr/frontend.php + * All the stuff for the frontend (i.e. what the visitor of the website sees). + * + * License: + * This file is part of Ratatöskr. + * Ratatöskr is licensed unter the MIT / X11 License. + * See "ratatoeskr/licenses/ratatoeskr" for more information. + */ + +require_once(dirname(__FILE__) . "/sys/utils.php"); +require_once(dirname(__FILE__) . "/languages.php"); +require_once(dirname(__FILE__) . "/sys/models.php"); +require_once(dirname(__FILE__) . "/sys/textprocessors.php"); + +/* + * Function: section_transform_ste + * Transforms an <Section> object to an array, so it can be accessed via a STE template. + * + * Parameters: + * $section - <Section> object. + * $lang - The current language. + * + * Returns: + * Array with these fields: + * * id + * * name + * * title + */ +function section_transform_ste($section, $lang) +{ + return array( + "id" => $section->get_id(), + "name" => $section->name, + "title" => $section->title[$lang]->text + ); +} + +/* + * Function: tag_transform_ste + * Transforms an <Tag> object to an array, so it can be accessed via a STE template. + * + * Parameters: + * $section - <Tag> object. + * $lang - The current language. + * + * Returns: + * Array with these fields: + * * id + * * name + * * title + */ +function tag_transform_ste($tag, $lang) +{ + return array( + "id" => $tag->get_id(), + "name" => $tag->name, + "title" => $tag->title[$lang]->text + ); +} + +/* + * Function: article_transform_ste + * Transforms an <Article> object to an array, so it can be accessed via a STE template. + * + * Parameters: + * $article - <Article> object. + * $lang - The current language. + * + * Returns: + * Array with these fields: + * * id + * * urltitle + * * fullurl + * * title + * * text + * * excerpt + * * custom (array: name=>value) + * * status (numeric) + * * section (sub-fields: <section_transform_ste>) + * * timestamp, tags (array(sub-fields: <tag_transform_ste>)) + * * languages (array: language name=>url) + * * comments_allowed + */ +function article_transform_ste($article, $lang) +{ + global $rel_path_to_root; + + $languages = array(); + foreach($article->title as $language => $_) + $languages[$language] = "$rel_path_to_root/$language/{$article->section->name}/{$article->urltitle}"; + + return array( + "id" => $article->get_id(), + "urltitle" => $article->urltitle, + "fullurl" => htmlesc("$rel_path_to_root/$lang/{$article->section->name}/{$article->urltitle}"), + "title" => htmlesc($article->title[$lang]->text), + "text" => textprocessor_apply_translation($article->text[$lang]), + "excerpt" => textprocessor_apply_translation($article->excerpt[$lang]), + "custom" => $article->custom, + "status" => $article->status, + "section" => section_transform_ste($article->section, $lang), + "timestamp" => $article->timestamp, + "tags" => array_map(function($tag) use ($lang) { return tag_transform_ste($tag, $lang); }, $article->tags), + "languages" => $languages, + "comments_allowed" => $article->comments_allowed + ); +} + +/* + * Function: comment_transform_ste + * Transforms an <Comment> object to an array, so it can be accessed via a STE template. + * + * Parameters: + * $comment - <Comment> object. + * + * Returns: + * Array with these fields: + * * id + * * text + * * author + * * timestamp + */ +function comment_transform_ste($comment) +{ + global $rel_path_to_root, $ratatoeskr_settings; + + return array( + "id" => $comment->get_id(), + "text" => textprocessor_apply($comment->text, $ratatoeskr_settings["comment_textprocessor"]), + "author" => htmlesc($comment->author_name), + "timestamp" => $comment->get_timestamp() + ); +} + +/* Register some tags for the template engine */ +/* + * STETag: articles_get + * Get articles by custom criterias. Will only get articles, that are available in the current language ($language). + * The fields of an article can be looked up at <article_transform_ste>. + * + * Parameters: + * var - (mandatory) The name of the variable, where the current article should be stored at. + * id - (optional) Filter by ID. + * urltitle - (optional) Filter by urltitle. + * section - (optional) Filter by section (section name). + * status - (optional) Filter by status (numeric, <ARTICLE_STATUS_>). + * tag - (optional) Filter by tag (tag name). + * sort - (optional) How to sort. Format: "fieldname direction" where fieldname is one of [id, urltitle, title, timestamp] and direction is one of [asc, desc]. + * perpage - (optional) How many articles should be shown per page (default unlimited). + * page - (optional) On which page are we (starting with 1). Useful in combination with $current[page], <page_prev> and <page_next>. (Default: 1) + * maxpage - (optional) (variable name) If given, the number of pages are stored in this variable. + * skip - (optional) How many articles should be skipped? (Default: none) + * count - (optional) How many articles to output. (Default unlimited) + * + * Tag Content: + * The tag's content will be executed for every article. The current article will be written to the variable specified by the var parameter before. + * + * Returns: + * All results from the tag content. + */ +$ste->register_tag("articles_get", function($ste, $params, $sub) +{ + $lang = $ste->vars["language"]; + + if(!isset($params["var"])) + throw new Exception("Parameter var is needed in article_get!"); + + $result = Article::by_multi($params); + + if(isset($params["tag"])) + { + if(!isset($result)) + $result = Article::all(); + $result = array_filter($result, function($article) use ($params) { return isset($article->tags[$params["tag"]]); }); + } + + /* Now filter out the articles, where the current language does not exist */ + $result = array_filter($result, function($article) use ($lang) { return isset($article->title[$lang]); }); + + /* Also filter the hidden ones out */ + $result = array_filter($result, function($article) { return $article->status != ARTICLE_STATUS_HIDDEN; }); + + /* Convert articles to arrays */ + $result = array_map(function($article) use ($lang) { return article_transform_ste($article, $lang); }, $result); + + function sort_fx_factory($cmpfx, $field, $direction) + { + return function($a, $b) use ($sorter, $field, $direction) { return $cmpfx($a[$field], $b[$field]) * $direction; }; + } + + if(isset($params["sort"])) + { + list($field, $direction) = explode(" ", $params["sort"]); + if((@$direction != "asc") and (@$direction != "desc")) + $direction = "asc"; + $direction = ($direction == "asc") ? 1 : -1; + $sort_fx = NULL; + + switch($field) + { + case "id": $sort_fx = sort_fx_factory("intcmp", "id", $direction); break; + case "urltitle": $sort_fx = sort_fx_factory("strcmp", "urltitle", $direction); break; + case "title": $sort_fx = sort_fx_factory("strcmp", "title", $direction); break; + case "timestamp": $sort_fx = sort_fx_factory("intcmp", "timestamp", $direction); break; + } + + if($sort_fx !== NULL) + usort($result, $sort_fx); + } + if(isset($params["perpage"])) + { + if(isset($params["maxpage"])) + $ste->set_var_by_name($params["maxpage"], ceil(count($result) / $params["perpage"])); + $page = isset($params["page"]) ? $params["page"] : 1; + $result = array_slice($result, ($page - 1) * $params["perpage"], $params["perpage"]); + } + else if(isset($params["skip"]) and isset($params["count"])) + $result = array_slice($result, $params["skip"], $params["count"]); + else if(isset($params["skip"])) + $result = array_slice($result, $params["skip"]); + else if(isset($params["count"])) + $result = array_slice($result, 0, $params["count"]); + + $output = ""; + foreach($result as $article) + { + $ste->set_var_by_name($params["var"], $article); + $output .= $sub($ste); + } + return $output; +}); + +/* + * STETag: section_list + * Iterate over all sections. + * The fields of a section can be looked up at <section_transform_ste>. + * + * Parameters: + * var - (mandatory) The name of the variable, where the current section should be stored at. + * exclude - (optional) Sections to exclude + * include_default - (optional) Should the default section be included (default: No). + * + * Tag Content: + * The tag's content will be executed for every section. The current section will be written to the variable specified by the var parameter before. + * + * Returns: + * All results from the tag content. + */ +$ste->register_tag("section_list", function($ste, $params, $sub) +{ + global $ratatoeskr_settings; + $lang = $ste->vars["language"]; + + if(!isset($params["var"])) + throw new Exception("Parameter var is needed in article_get!"); + + $result = Section::all(); + + if(isset($params["exclude"])) + { + $exclude = explode(",", $params["exclude"]); + $result = array_filter($result, function($section) use ($exclude) { return !in_array($section->name, $exclude); }); + } + + $result = array_filter($result, function($section) use ($default_section) { return $section->get_id() != $default_section; }); + + $result = array_map(function($section) use ($lang) { return section_transform_ste($section, $lang); }, $result); + + if($ste->evalbool($params["include_default"])) + { + $default = section_transform_ste(Section::by_id($ratatoeskr_settings["default_section"])); + array_unshift($result, $default); + } + + $output = ""; + foreach($result as $section) + { + $ste->set_var_by_name($params["var"], $section); + $output .= $sub($ste); + } + return $output; +}); + +/* + * STETag: article_comments_count + * Get the number of comments for an article. + * + * Parameters: + * article - (mandatory) The name of the variable, where the article is stored at. + * + * Returns: + * The number of comments. + */ +$ste->register_tag("article_comments_count", function($ste, $params, $sub) +{ + if(!isset($params["article"])) + throw new Exception("Need parameter 'article' in ste:article_comments_count."); + $tpl_article = $ste->get_var_by_name($params["article"]); + $lang = $ste->vars["language"]; + + try + { + $article = Article::by_id(@$tpl_article["id"]); + return count($article->get_comments($lang, True)); + } + catch(DoesNotExistError $e) + { + return 0; + } +}); + +/* + * STETag: article_comments + * List all comments for an article. + * The fields of a comment can be looked up at <comment_transform_ste>. + * + * Parameters: + * var - (mandatory) The name of the variable, where the current comment should be stored at. + * article - (mandatory) The name of the variable, where the article is stored at. + * + * Tag Content: + * The tag's content will be executed for every comment. The current comment will be written to the variable specified by the var parameter before. + * + * Returns: + * All results from the tag content. + */ +$ste->register_tag("article_comments", function($ste, $params, $sub) +{ + if(!isset($params["var"])) + throw new Exception("Need parameter 'var' in ste:article_comments."); + if(!isset($params["article"])) + throw new Exception("Need parameter 'article' in ste:article_comments."); + $tpl_article = $ste->get_var_by_name($params["article"]); + $lang = $ste->vars["language"]; + + try + { + $article = Article::by_id(@$tpl_article["id"]); + } + catch(DoesNotExistError $e) + { + return ""; + } + + $comments = $article->get_comments($lang, True); + usort($comments, function($a,$b) { intcmp($a->get_timestamp(), $b->get_timestamp()); }); + + $comments = array_map("comment_transform_ste", $comments); + + $output = ""; + foreach($comments as $comment) + { + $ste->set_var_by_name($params["var"], $comment); + $output .= $sub($ste); + } + return $output; +}); + +/* + * STETag: comment_form + * Generates a HTML form tag that allows the visitor to write a comment. + * + * Parameters: + * article - (mandatory) The name of the variable, where the article is stored at. + * default - (optional) If not empty, a default formular with the mandatory fields will be generated. + * + * Tag Content: + * The tag's content will be written into the HTML form tag. + * You have at least to define these fields: + * + * * <input type="text" name="author_name" /> - The Name of the author. + * * <input type="text" name="author_mail" /> - The E-Mailaddress of the author. + * * <textarea name="comment_text"></textarea> - The Text of the comment. + * * <input type="submit" name="post_comment" /> - Submit button. + * + * You might also want to define this: + * + * * <input type="submit" name="preview_comment" /> - For a preview of the comment. + * + * If the parameter default is not empty, the tag's content will be thrown away. + * + * Returns: + * The finished HTML form. + */ +$ste->register_tag("comment_form", function($ste, $params, $sub) +{ + global $translation; + if(!isset($params["article"])) + throw new Exception("Need parameter 'article' in ste:comment_form."); + $tpl_article = $ste->get_var_by_name($params["article"]); + + try + { + $article = Article::by_id($tpl_article["id"]); + } + catch (DoesNotExistError $e) + { + return ""; + } + + if(!$article->allow_comments) + return ""; + + $form_header = "<form action=\"{$tpl_article["fullurl"]}?comment\" method=\"POST\" accept-charset=\"UTF-8\">"; + + if($ste->evalbool(@$params["default"])) + $form_body = "<p>{$translation["comment_form_name"]}: <input type=\"text\" name=\"author_name\" /></p> +<p>{$translation["comment_form_mail"]}: <input type=\"text\" name=\"author_mail\" /></p> +<p>{$translation["comment_form_text"]}:<br /><textarea name=\"comment_text\" cols=\"50\" rows=\"10\"></textarea></p> +<p><input type=\"submit\" name=\"post_comment\" /></p>"; + else + $form_body = $sub($ste); + + return "$form_header\n$form_body\n</form>"; +}); + +/* + * STETags: Page control + * These tags can create links to the previous/next page. + * + * page_prev - Link to the previous page (if available). + * page_next - Link to the next page (if available). + * + * Parameters: + * current - (mandatory) The current page number. + * maxpage - (mandatory) How many pages in total? + * default - (optional) If not empty, a default localized link text will be used. + * + * Tag Content: + * The tag's content will be used as the link text. + * + * Returns: + * A Link to the previous / next page. + */ + +$ste->register_tag("page_prev", function($ste, $params, $sub) +{ + if(!isset($params["current"])) + throw new Exception("Need parameter 'current' in ste:page_prev."); + if(!isset($params["maxpage"])) + throw new Exception("Need parameter 'maxpage' in ste:page_prev."); + + if($params["page"] == 1) + return ""; + + parse_str(parse_url($_SERVER["REQUEST_URI"], PHP_URL_QUERY), $query); + $query["page"] = $params["page"] - 1; + $url = $_SERVER["REDIRECT_URL"] . "?" . http_build_query($query); + return "<a href=\"" . htmlesc($url) . "\">" . (($ste->evalbool(@$params["default"])) ? $translation["page_prev"] : $sub($ste)) . "</a>"; +}); + +$ste->register_tag("page_next", function($ste, $params, $sub) +{ + if(!isset($params["current"])) + throw new Exception("Need parameter 'current' in ste:page_next."); + if(!isset($params["maxpage"])) + throw new Exception("Need parameter 'maxpage' in ste:page_next."); + + if($params["page"] == $params["maxpage"]) + return ""; + + parse_str(parse_url($_SERVER["REQUEST_URI"], PHP_URL_QUERY), $query); + $query["page"] = $params["page"] + 1; + $url = $_SERVER["REDIRECT_URL"] . "?" . http_build_query($query); + return "<a href=\"" . htmlesc($url) . "\">" . (($ste->evalbool(@$params["default"])) ? $translation["page_next"] : $sub($ste)) . "</a>"; +}); + +/* + * STETag: languages + * List all languages available in the current context. + * + * Parameters: + * var - (mandatory) The name of the variable, where the current language information should be stored at. + * + * Sub-fields of var: + * short - 2 letter code of language + * fullname - The full name of the language + * url - URL to the current page in this language + * + * Tag Content: + * The tag's content will be executed for every language. The current language will be written to the variable specified by the var parameter before. + * + * Returns: + * All results from the tag content. + */ +$ste->register_tag("languages", function($ste, $params, $sub) +{ + global $languages, $ratatoeskr_settings, $rel_path_to_root; + + if(!isset($params["var"])) + throw new Exception("Need parameter 'var' in ste:languages."); + + $langs = array(); + if(isset($ste->vars["current"]["article"])) + { + try + { + $article = Article::by_id($ste->vars["current"]["article"]["id"]); + foreach($article->title as $lang => $_) + $langs[] = $lang; + } + catch(DoesNotExistError $e) {} + } + else + { + + foreach($ratatoeskr_settings["languages"] as $lang) + $langs[] = $lang; + } + + $output = ""; + foreach($langs as $lang) + { + $ste->set_var_by_name($params["var"], array( + "short" => $lang, + "fullname" => urlesc($languages[$lang]["language"]), + "url" => urlesc("$rel_path_to_root/$lang/" . implode("/", array_slice($ste->vars["current"]["url_fragments"], 1))) + )); + $output .= $sub($ste); + } + return $output; +}); + +/* + * STETag: styles_load + * Load all current styles. + * + * Parameters: + * mode - (optional) Either "embed" or "link". Default: link + * + * Returns: + * The current styles (either linked or embedded) + */ +$ste->register_tag("styles_load", function($ste, $params, $sub) +{ + global $rel_path_to_root; + if(isset($params["mode"]) and (($params["mode"] == "embed") or ($params["mode"] == "link"))) + $mode = $params["mode"]; + else + $mode = "link"; + + if($mode == "embed") + { + $output = ""; + foreach($ste->vars["current"]["styles"] as $stylename) + { + try + { + $style = Style::by_name($stylename); + $output .= "/* Style: $stylename */\n" . $style->code . "\n"; + } + catch(DoesNotExistError $e) + { + $output .= "/* Warning: Failed to load style: $stylename */\n"; + } + } + $output = "<style type=\"text/css\">\n" . htmlesc($output) . "</style>"; + } + else + { + $output = ""; + foreach($ste->vars["current"]["styles"] as $stylename) + { + try + { + $style = Style::by_name($stylename); + $output .= "<link rel=\"stylesheet\" type=\"text/css\" href=\"" . htmlesc($rel_path_to_root . "css.php?name=" . urlencode($style->name)) . "\" />\n"; + } + catch(DoesNotExistError $e) + { + $output .= "<!-- Warning: Failed to load style: $stylename */ -->\n"; + } + } + } + return $output; +}); + +/* + * STEVar: $current + * Holds information about the current page in the frontend (the part of the webpage, the visitor sees). + * + * $current has these fields: + * * article - Only set if a single article is shown. Holds information about an article. (sub-fields are described at <article_transform_ste>). + * * section - Only set if a whole section is shown. Holds information about an section. (sub-fields are described at <section_transform_ste>). + * * tag - Only set if all articles with the same tag should be shown. Holds information about a tag. (sub-fields are described at <tag_transform_ste>). + * * page - Which subpage is shown? Useful with <page_prev>, <page_next> and the page parameter of <articles_get>. Default: 1 + * * commented - True, if the visitor has successfully written a comment. + * * comment_fail - If the user tried to comment, but the system rejected the comment, this will be set and will contain the error message. + * * comment_prev - If the user wanted to preview the article, this will be set and contain the HTML code of the comment. + * * styles - The styles, that should be loaded. You can also just use <styles_load>. + * * url_fragments - Array of URL parts. Mainly used internally, so you *really* should not modify this one... + * + * Plugins might insert their own $current fields. + */ + +/* + * STEVar: $language + * The short form (e.g. "en" for English, "de" for German, ...) of the current language. + */ + +$comment_validators = array( + function() + { + global $translation; + if(empty($_POST["author_name"])) + throw new CommentRejected($translation["author_name_missing"]); + if(empty($_POST["author_email"])) + throw new CommentRejected($translation["author_email_missing"]); + if(empty($_POST["comment_text"])) + throw new CommentRejected($translation["comment_text_missing"]); + } +); + +/* + * Function: register_comment_validator + * Register a comment validator. + * + * A comment validator is a function, that checks the $_POST fields and decides whether a comment should be stored or not (throws an <CommentRejected> exception with the rejection reason as the message). + * + * Parameters: + * $fx - The validator function (function()). + */ +function register_comment_validator($fx) +{ + global $comment_validators; + $comment_validators[] = $fx; +} + +/* + * Function: frontend_url_handler + */ +function frontend_url_handler(&$data, $url_now, &$url_next) +{ + global $ste, $ratatoeskr_settings, $languages, $metasections, $comment_validators; + $path = array_merge(array($url_now), $url_next); + $url_next = array(); + + $default_section = Section::by_id($ratatoeskr_settings["default_section"]); + + /* If no language or an invalid language was given, fix it. */ + if((count($path) == 0) or (!isset($languages[$path[0]]))) + { + if(count($path > 0)) + array_shift($path); + array_unshift($path, $ratatoeskr_settings["default_language"]); + } + + $ste->vars["current"]["url_fragments"] = $path; + + $lang = array_shift($path); + $ste->vars["language"] = $lang; + load_language($languages[$lang]["translation_exist"] ? $lang : "en"); /* English is always available */ + + if(count($path) == 0) + array_unshift($path, $ratatoeskr_settings["default_section"]->name); + + $section_name = array_shift($path); + + if($section_name == "_tags") + { + try + { + $tag = Tag::by_name(array_shift($path)); + } + catch(DoesNotExistError $e) + { + throw new NotFoundError(); + } + $ste->vars["current"]["tag"] = tag_transform_ste($tag); + } + else + { + try + { + $section = Section::by_name($section_name); + } + catch(DoesNotExistError $e) + { + throw new NotFoundError(); + } + + if(count($path == 0)) + $ste->vars["current"]["section"] = section_transform_ste($section); + else + { + try + { + $article = Article::by_urlname(array_shift($path)); + } + catch(DoesNotExistError $e) + { + throw new NotFoundError(); + } + $ste->vars["current"]["article"] = article_transform_ste($article); + + if(isset($_GET["comment"])) + { + if(isset($_POST["comment_prev"])) + $ste->vars["current"]["comment_prev"] = textprocessor_apply($_POST["comment_text"], $ratatoeskr_settings["comment_textprocessor"]); + else if(isset($_POST["post_comment"])) + { + $rejected = False; + try + { + foreach($comment_validators as $validator) + call_user_func($validator); + } + catch(CommentRejected $e) + { + $ste->vars["current"]["comment_fail"] = htmlesc($e->getMessage()); + $rejected = True; + } + if(!$rejected) + { + $comment = Comment::create($article, $lang); + $comment->author_name = $_POST["author_name"]; + $comment->author_mail = $_POST["author_email"]; + $comment->text = $_POST["comment_text"]; + $comment->save(); + $ste->vars["current"]["commented"] = "Yes"; + } + } + } + } + } + + $ste->vars["current"]["page"] = (isset($_GET["page"]) and is_numeric($_GET["page"])) ? $_GET["page"] : 1; + + if(!isset($section)) + $section = $default_section; + + foreach($section->styles as $style) + $ste->vars["current"]["styles"][] = $style->name; + echo $ste->exectemplate("/usertemplates/" . $section->template); +} + +/* + * Class: CommentRejected + * An Exeption a comment validator can throw, if the validation failed. + * + * See Also: + * <register_comment_validator> + */ +class CommentValidationFailed extends Exception {} + +?> |