source: t29-www/lib/template.php @ 930

Last change on this file since 930 was 930, checked in by heribert, 4 years ago

Zweiter Teil der Homepagelayoutänderungen.

  • Property svn:keywords set to Id
File size: 20.8 KB
Line 
1<?php
2/**
3 * technikum29v6 Page Template.
4 * Initially written 08.01.2012, Sven Koeppel
5 *
6 * This file contains the t29v6 HTML5 template (header, footer, structure, ...).
7 *
8 * Global vars:
9 *  $lang = de | en
10 *  $seiten_id = kurzkennung der aktuellen seite
11 *  $root = Seiten-Root fuer URLs ($root/de, $root/shared, etc.)
12 *  $titel = Seitentitel
13 *  $header_cache_file, $footer_cache_file.
14 **/
15
16class t29Template {
17        public $conf, $menu, $msg;
18        public $body_classes = array();
19        public $javascript_config = array();
20        public $page_relations, $interlang_links;
21        public $log; // lightweight logging system
22
23        /**
24         * The t29Template constructor.
25         *
26         * The template class is embedded into the t29v6 class framework. It
27         * uses t29Log for logging, t29Messages for any localisation strings,
28         * t29RessourceLoader for resolving URLs for CSS and JavaScript ressources.
29         * t29Menu is a helper class considered for parsing and extracting
30         * any relations between pages and the menu from navigation.xml.
31         *
32         * From the t29v6 entrypoint, technikum29.php, this class is instanced
33         * at the end, if no caching has worked. That call looks like
34         *
35         *   $template = new t29Template($GLOBALS);
36         *
37         * which means that our configuration $this->conf will be set up from the
38         * former global namespace. For correct working, at least some global vars
39         * like
40         *   $lib
41         *   $lang
42         *   $host
43         *   ...
44         * are considered as present (see above for a list).
45         *
46         **/
47        function __construct($conf_array) {
48                $this->conf = $conf_array;
49               
50                // fetch the lightweight logging object:
51                require_once $this->conf['lib'].'/logging.php';
52                $this->log = t29Log::get();
53               
54                // create a menu, if not given:
55                require_once $this->conf['lib'].'/menu.php';
56                $this->menu = isset($this->conf['menu']) ? $this->conf['menu'] : new t29Menu($this->conf);
57
58                // create localisation class:
59                require_once $this->conf['lib'].'/messages.php';
60                $this->msg = new t29Messages($this->conf['lang']);
61               
62                // create the ressourceloaders:
63                require_once $this->conf['lib'].'/ressourceloader.php';
64                $this->rl = array();
65                foreach(array('js','css') as $type)
66                        $this->rl[$type] = t29RessourceLoader::create_from_type($type, $this->conf);
67
68                // fill up configuration
69               
70                // optional html headers which can be filled by hooks or parts
71                if(!isset($this->conf['header_prepend']))
72                        $this->conf['header_prepend'] = array(); // list
73                elseif(is_string($this->conf['header_prepend']))
74                        $this->conf['header_prepend'] = array($this->conf['header_prepend']); // string to list
75
76                // ask t29Host for configuration fillup
77                $this->conf['host']->fillup_template_conf($this->conf);
78               
79                // Path names in messages
80                foreach(array('footer-legal-file', 'topnav-search-page') as $msg_id)
81                        $this->msg->set($msg_id, $this->conf['lang_path'].$this->msg->_($msg_id));
82
83                // store informations about the current page
84                $this->conf['seiten_link'] = $this->menu->get_link();
85                $this->conf['seite_in_nav'] = $this->menu->get_link_navigation_class($this->conf['seiten_link']);
86                $this->conf['seite_in_ul'] = $this->menu->get_link_ul_classes($this->conf['seiten_link']);
87
88                // setup body classes:
89                $body_classprefixes = array(
90                        // css prefix => configuration array value
91                        'lang-' => 'lang',
92                        'page-' => 'seiten_id',
93                        'in-nav-' => 'seite_in_nav',
94                        'in-' => 'seite_in_ul',
95                );
96                foreach($body_classprefixes as $prefix => $key) {
97                        if(is_array($this->conf[$key]))
98                                // append each element of array conf values
99                                foreach($this->conf[$key] as $x)
100                                        $this->body_classes[] = $prefix . $x;
101                        elseif($this->conf[$key]) // skip null/false/empty conf values
102                                $this->body_classes[] = $prefix . $this->conf[$key];
103                }
104               
105                // setup javascript configuration
106                $javascript_transfer = array('lang', 'seiten_id', 'seite_in_nav', 'seite_in_ul');
107                foreach($javascript_transfer as $key)
108                        $this->javascript_config[$key] = $this->conf[$key];
109                // also collect data from other classes, e.g. t29Host:
110                $this->javascript_config['web_prefix'] = $this->conf['host']->web_prefix;
111               
112                // get all kind of relations. Pages can afterwards be overwritten with t29Template
113                // methods (see below).
114                $this->page_relations = $this->menu->get_page_relations();
115                $this->interlang_links = $this->menu->get_interlanguage_link();
116                $this->current_link_classes = $this->menu->get_link_classes();
117               
118                // check and load additional css.
119                // #51: This is now checked by the site caching in technikum29.php.
120                $this->conf['pagecss'] = $this->conf['host']->ressources_get_pagestyle($this->conf['seiten_id']);
121                $this->conf['has_pagecss'] = file_exists($this->conf['webroot'].$this->conf['pagecss']);
122               
123                // setup html title
124                $this->conf['html_title'] = '';
125                if(isset($this->conf['titel']) && !empty($this->conf['titel']))
126                        $this->conf['html_title'] = $this->conf['titel'] . ' - ';
127                // Startseite macht ihren Titel jetzt selbst (SEO):
128                //elseif($this->conf['seiten_id'] == $this->msg->_('homepage-pagename'))
129                //      {} // nop: Startseitentitel soll nur sein "technikum29"
130                elseif($this->conf['seiten_link'])
131                        // Titel vom Menu nehmen
132                        $this->conf['html_title'] = $this->conf['seiten_link'] . ' - ';
133                $this->conf['html_title'] .= $this->msg->_('html-title');
134               
135                // Unfortunately mostly a t29Template instance won't be visible to a page
136                // handled by technikum29.php. Therefore there is this small "future" trick:
137                if(isset($this->conf['template_callback']))
138                        $this->conf['template_callback']($this);
139                // Now you can use code like
140                // $template_callback = function($template) {
141                //    $template->set_page_relation("next", "/de/example", "foo");
142                //    $template->menu->... read and modify anything ... etc
143                // }
144                // so the callback function is called at the end of the template constructor.
145                // This can be considered whenever giving a static configuration variables
146                // is not enough.
147        }
148       
149        /**
150         * Overwrite the page relations given by the t29Menu.
151         * By setting $relation to "prev" or "next", you can overwrite the
152         * relations which has been set up by construction by $this->menu->get_page_relations().
153         * Thus any page can state any relations. For sure they are only one-directional,
154         * the other pages don't know anything about such relations because no vice-versa
155         * introspection can be done.
156         **/
157        function set_page_relation($relation, $href, $label) {
158                // good values for $relation are: "prev", "next".
159                // Link is composed as <a href="$href">$label</a>.
160                $this->page_relations[$relation] = t29Menu::dom_new_link($href, $label);
161                //print_r($this->page_relations);
162        }
163
164        /**
165         * Overwrite the interlanguage link list given by the t29Menu.
166         * This does the same as set_page_relation() only for interlanguage links.
167         **/
168        function set_interlang_link($lang, $href, $label) {
169                // good values for $lang are: "de", "en".
170                // Link is composed as <a href="$href">$label</a>.
171                $this->interlang_links[$lang] = t29Menu::dom_new_link($href, $label);
172        }
173       
174        /**
175         * Main caching and output system.
176         * Parameters (global configuration):
177         *    skip_cache  -  if true, skips writing output to cache file
178         *    purge_cache -  if true, forces creation of new cache file
179         *                   (does not change behaviour of this file's code)
180         **/
181        function create_cache($cache_object) {
182                $cache_object->start_cache(array(
183                        'shutdown_func' => array($this, 'print_footer'), // print the footer with it
184                        'filter_func'   => $this->conf['host']->has_web_prefix ? 
185                                array($this, 'rewrite_page_prefix_links') : null, // Entrypoint for URL and content rewriting!
186                ));
187                // directly start header printing
188                $this->print_header();
189        }
190       
191        /**
192         * Write header and footer in separate cache files.
193         **/
194        function create_separate_caches($header_cache, $footer_cache) {
195                $header_cache->start_cache(array(
196                         // start with no shutdown, filter, nor writing
197                        'filter_func' => $this->conf['host']->has_web_prefix ? array($this, 'rewrite_page_prefix_links') : null,
198                        'write_cache' => false,
199                ));
200                $this->print_header();
201                $header_cache->write_cache(); // will also print out header immediately.
202               
203                $footer_cache->start_cache(array(
204                         // start with no shutdown, filter, nor writing
205                        'filter_func' => $this->conf['host']->has_web_prefix ? array($this, 'rewrite_page_prefix_links') : null,
206                        'write_cache' => false,
207                ));
208                $this->print_footer();
209                $footer_content = $footer_cache->write_cache(null, true); // don't print footer immediately.
210               
211                // print footer on exit.
212                register_shutdown_function(function() use ($footer_content) {
213                        print $footer_content;
214                });
215        }
216
217        function print_header() {
218                $p = $this->msg->get_shorthand_printer(); // t29Messages gettext printer
219                $_ = $this->msg->get_shorthand_returner(); // t29Messages gettext
220                $href = $this->conf['host']->get_shorthand_link_returner(); // t29Host link rewriter
221?>
222<!doctype html>
223<html class="no-js" lang="<?php echo $this->conf['lang']; ?>">
224<head>
225  <meta charset="utf-8">
226  <title><?php echo $this->conf['html_title']; ?></title>
227  <meta name="author" content="technikum29-Team">
228  <meta name="generator" content="<?php print $this->conf['host']; ?>">
229  <meta name="t29.cachedate" content="<?php print date('r'); ?>">
230  <?php
231        foreach($this->conf['header_prepend'] as $h) print $h."\n  ";
232       
233        $indicators = array('ajax', 'external');
234        foreach($indicators as $key)
235                if($this->conf[$key]) print "\n  <meta name='t29.$key' content='true'>";
236 
237        if(isset($this->conf['version'])) printf('<meta name="t29.version" content="%s">', $this->conf['version']);
238        if(isset($_GET['debug']))
239                foreach(explode(' ','debug rl_debug skip_cache purge_cache verbose_cache') as $x)
240                        printf("\n  <meta name='t29.template.data-%s' content='%s'>", $x, isset($_GET[$x])?'true':'false');
241  ?>
242 
243  <?php
244        foreach(array_merge(
245                array("first" => t29Menu::dom_new_link($this->conf['lang_path'], $_('head-rel-first'))),
246                $this->page_relations
247        ) as $rel => $a) {
248                if($rel == 'start') continue; // not in standard
249                printf("\n  <link rel='%s' href='%s' title='%s' />",
250                        $rel, $href($a['href']), sprintf($_('head-rel-'.$rel), $this->relational_link_to_string($a))
251                );
252        }
253  ?>
254 
255  <link rel="copyright" href="<?php print $href($_('footer-legal-file')); ?>" title="<?php $p('footer-legal-link'); ?>">
256  <link rel="search" type="application/opensearchdescription+xml" href="<?php print $href($_('topnav-search-page')); print '?action=opensearch-desc&amp;lang='.$this->conf['lang']; ?>" title="<?php $p('opensearch-desc'); ?>">
257  <link rel="alternate" type="application/rss+xml" href="/<?php print $this->conf['lang']; ?>/news.php?format=rss" title="<?php $p('rss-title'); ?>" />
258  <?php
259        // print interlanguage links for all languages except the active one
260        foreach($this->interlang_links as $lang => $a) {
261                if($lang != $this->conf['lang'] && !is_null($a)) {
262                        printf('<link rel="alternate" href="%s" hreflang="%s" title="%s">',
263                                $href($a['href']), $lang, $this->relational_link_to_string($a)
264                        );
265                }
266        }
267  ?>
268 
269  <meta name="viewport" content="width=device-width,initial-scale=1">
270 
271  <!-- fancy neue Ersatzschrift fuer Futura, Maerz 2016 -->
272  <link href='https://fonts.googleapis.com/css?family=Nunito' rel='stylesheet' type='text/css'>
273  <?php
274        $this->print_ressourceloader_links('css', PHP_EOL . '  <link rel="stylesheet" href="%s">');
275  ?>
276
277  <script src="/shared/js-v6/libs/modernizr-2.0.6.min.js"></script>
278</head>
279
280<body class="<?php echo implode(' ', $this->body_classes) ?>">
281  <div id="container">
282        <h1 role="banner"><a href="/" title="<?php $p('head-h1-title'); ?>"><?php $p('head-h1'); ?></a></h1>
283        <div id="background-color-container"><!-- helper -->
284        <section class="main content" role="main" id="content">
285                <ul class="messages panel <?php if($this->log->is_empty()) echo 'empty'; ?> nolist">
286                <?php
287                        // This prints out error messages collected by the log only until this point
288                        $this->log->print_all();
289                        // All log entries generated until final processing will be flushed out at the
290                        // end; a userspace javascript helper will then move them here.
291                ?>
292                </ul>   
293                <!--<header class="teaser">
294                        <h2 id="pdp8L">Wissenschaftliche Rechner und Minicomputer</h2>
295                        <img width=880 src="http://www.technikum29.de/shared/photos/rechnertechnik/univac/panorama-rechts.jpg">
296                </header>-->
297        <!-- start content -->
298<?php 
299} // function print_header().
300
301        function print_footer() {
302                $p = $this->msg->get_shorthand_printer(); // t29Messages gettext printer
303                $_ = $this->msg->get_shorthand_returner(); // t29Messages gettext
304                $href = $this->conf['host']->get_shorthand_link_returner(); // t29Host link rewriter
305               
306        ?>
307        <!-- end content -->
308        </section>
309        <hr>
310        <section class="sidebar top">
311                        <?php /* Platz fuer eigentlich per "Extension" eingepflegtem Inhalt */ ?>
312                        <!-- Box (nur DE), die irgendwie sonst keinen Platz findet: -->
313                        <!--
314                        <?php if(isset($this->conf['lang']) && $this->conf['lang'] == 'de') { ?>
315                        <a class="button alertbox termine" href="/de/#termine">
316                                <strong>Aktuelle Termine</strong>
317                               
318                        </a>
319                        <?php }/* end of lang==de */ ?>
320                        -->
321                       
322                        <h2 class="visuallyhidden" id="tour-navigation"><?php $p("sidebar-h2-tour"); ?></h2>
323                        <?php
324                                $sidebar_contains_menu  = !isset($this->conf['sidebar_content']);
325                        ?>
326                        <nav class="side <?php print $sidebar_contains_menu ? 'contains-menu' : 'contains-custom'; ?>">
327                                <?php
328                                        if(!$sidebar_contains_menu)
329                                                // used in external page calls
330                                                print $this->conf['sidebar_content'];
331                                        else
332                                                $this->menu->print_menu(t29Menu::sidebar_menu, $this->conf['host']);
333                                ?>
334                        </nav>
335                        <!-- menu changing buttons are made with javascript, but  -->
336        </section>
337        <section class="sidebar bottom">
338                <!-- inhalte die unten ueber dem header sind -->
339        </section>
340        </div><!-- div id="background-color-container" helper end -->
341        <hr>
342        <header class="banner">
343                <h2 class="visuallyhidden"><?php $p("sidebar-h2-mainnav"); ?></h2>
344                <nav class="horizontal">
345                        <?php
346                                if(isset($this->conf['mainnav_content']))
347                                        // used in external page calls
348                                        print $this->conf['mainnav_content'];
349                                else
350                                        $this->menu->print_menu(t29Menu::horizontal_menu, $this->conf['host']);
351                        ?>
352                </nav>
353                <nav class="top">
354                        <h3 class="visuallyhidden"><?php $p("sidebar-h2-lang"); ?></h3>
355                        <ul>
356                                <?php
357                                        foreach($this->interlang_links as $lang => $a) {
358                                                $is_current_lang = $lang == $this->conf['lang'];
359                                                if(is_null($a)) {
360                                                        // when interlanguage link not present (null) = no translation exists
361                                                        $backtitle = isset($this->conf['titel']) ? $this->conf['titel'] : null;
362                                                       
363                                                        $a = t29Menu::dom_new_link(
364                                                                $_('topnav-interlang-nonexistent-page') . '?'
365                                                                   . htmlentities(http_build_query(array(
366                                                                        'backurl' => $_SERVER['REQUEST_URI'],
367                                                                        'backtitle' => $backtitle ? $backtitle : null,
368                                                                     ))),
369                                                                'not present'
370                                                        );
371                                                        $title = sprintf($_('topnav-interlang-nonexistent', $lang));
372                                                        $class = 'nonexistent';
373                                                } elseif($is_current_lang) {
374                                                        $title = sprintf($_('topnav-interlang-active'), $a);
375                                                        $class = 'active';
376                                                } else {
377                                                        // ordinary interlang link
378                                                        $title = sprintf($_('topnav-interlang-title', $lang), $a);
379                                                        $class = '';
380                                                }
381                                                printf("\t\t\t\t<li%s><a href='%s' title='%s'>%s</a></li>\n",
382                                                        (empty($class) ? '' : " class='$class'"),
383                                                        $href($a['href']), htmlspecialchars($title),
384                                                        $this->conf['languages'][$lang][0] // verbose language name
385                                                );
386                                        }
387                                ?>
388                        </ul>
389                        <form method="get" action="<?php $href($p('topnav-search-page')); ?>">
390                                <span class="no-js"><?php $p('topnav-search-label'); ?>:</span>
391                                <input type="text" value="" data-defaultvalue="<?php $p('topnav-search-label'); ?>" name="q" class="text">
392                                <input type="submit" value="<?php $p('topnav-search-label'); ?>" class="button">
393                        </form>
394                </nav>
395    </header>
396        <hr>
397        <?php
398                // only print menu when in sidebar where it applies.
399                // it can also be forced with a global setting $force_footer_menu = 1
400                $print_footer_menu = count($this->page_relations) || isset($this->conf['force_footer_menu']);
401                // old test: ($this->conf['seite_in_nav'] == 'side') || isset($this->conf['force_footer_menu']);
402               
403                // print next or prev entry when the current page has a
404                // "show-rel-next" or "show-rel-prev" class entry
405                $show_rel_next = in_array('show-rel-next', $this->current_link_classes);
406                $show_rel_prev = in_array('show-rel-prev', $this->current_link_classes);
407               
408        ?>
409    <footer class="in-sheet <?php if(!$print_footer_menu) print "empty-footer"; ?>">
410                <nav class="guide">
411                        <!-- hier wird nav.side die Liste per JS reinkopiert -->
412                </nav>
413                <nav class="rel clearfix <?php if(!$print_footer_menu) print "empty"; ?>">
414                <ul>
415                        <?php
416                          //if($print_footer_menu)
417                                foreach($this->page_relations as $rel => $a) {
418                                        // only show the links wanted to be shown. Only relevant if
419                                        // the "show-rel-*"-magic is working.
420                                        if( $print_footer_menu ||
421                                            (!$print_footer_menu && $rel == "prev" && $show_rel_prev) ||
422                                            (!$print_footer_menu && $rel == "next" && $show_rel_next)) {
423                                       
424                                                printf("\t<li class='%s'><a href='%s' title='%s'>%s <strong>%s</strong></a>\n",
425                                                        $rel, $href($a['href']), sprintf($_('head-rel-'.$rel), $this->relational_link_to_string($a)),
426                                                        $_('nav-rel-'.$rel), $this->relational_link_to_string($a)
427                                                );
428                                        } // endif
429                                } // endfor
430                        ?>
431                </ul>
432                </nav>
433                <?php
434                        // packe Bigfooter bei leerem Footer-Menue in footer.in-sheet
435                        if(!$print_footer_menu)
436                                $this->print_footer_text();
437                ?>
438                <div class="right">
439                        <!-- text der rechts unten steht -->
440                </div>
441    </footer>
442  </div> <!--! end of #container -->
443  <footer class="attached">
444    <!--<div class="legacy"><?php $p('footer-legacy-text'); ?></div>-->
445        <?php
446                // packe Bigfooter bei gefuelltem footer.in-sheet nach footer.attached.
447                if($print_footer_menu)
448                        $this->print_footer_text();
449       
450                // pending log messages
451                if(!$this->log->is_empty()) {
452                        echo '<ul class="messages footer nolist">';
453                        $this->log->print_all();
454                        echo '</ul>';
455                }
456        ?>
457  </footer>
458<?php /*</div><!-- end of div id="footer-background-container" helper -->*/ // seems misplaced ?>
459
460  <?php /* JavaScript at the bottom for fast page loading */ ?>
461  <script src="/shared/js-v6/libs/jquery-1.7.2.min.js"></script>
462  <script>window.t29={'conf': <?php print json_encode($this->javascript_config); ?>};</script>
463  <?php
464        $this->print_ressourceloader_links('js', '  <script src="%s"></script>'.PHP_EOL);
465  ?>
466  <?php /* Piwik Noscript, Script selbst wird asynchron im JS-Bereich aufgerufen */ ?>
467  <noscript><img src="<?php $p("js-piwik-noscript-imgsrc"); ?>" alt="" /></noscript>
468  <?php
469        if(isset($this->conf['body_append']))
470                print $this->conf['body_append'];
471  ?>
472</body>
473</html>
474<?php
475        } // function print_footer()
476       
477        /**
478         * Den "Bigfooter"-Text ausgeben.
479         * Hilfsfunktion fuer print_footer().
480         * (Grund: Implementierung als langer String in print_footer() ist unbequem)
481         **/
482        private function print_footer_text() {
483                $p = $this->msg->get_shorthand_printer(); // t29Messages gettext printer
484                $_ = $this->msg->get_shorthand_returner(); // t29Messages gettext
485                $href = $this->conf['host']->get_shorthand_link_returner(); // t29Host link rewriter
486               
487                ?><div class="bigfooter">
488                    <ul class="clearfix">
489                        <li class="haus"><a class="block" href="<?php print $href($_('footer-haus-link')); ?>">
490                                <img src="/shared/img-v6/logo-haus.footer.png" alt="Museum Haus" title="The Museum building">
491                                <span class="p"><?php $p('footer-haus-text'); ?></span>
492                        </a></li>
493                        <li class="copy"><a class="block" href="<?php print $href($_('footer-legal-file')); ?>#image-copyright" class="clearfix">
494                                <i>CC</i>
495                                <span class="p"><?php $p('footer-image-copyright-text'); ?></span>
496                        </a></li>
497                        <li class="logo"><span class="block clearfix"><!-- FIXME: clearfix should be semantically performed -->
498                                <i title="technikum29 Logo">Logo</i>
499                                <span class="p"><?php $p('footer-copyright-tag'); ?>
500                                <br><a class="u" href="<?php print $href($_('footer-legal-file')); ?>"><?php $p('footer-legal-link'); ?></a>
501                                <br><a class="u" href="<?php print $href($_('footer-sitemap-link')); ?>"><?php $p('footer-sitemap-text'); ?></a>
502                                </span>
503                        </span></li>
504
505                    </ul>
506                </div><?php
507        }
508       
509        // Hilfsfunktionen
510        private function relational_link_to_string($a) {
511                // wenn es bei einem relationalen Link einen Titel gibt, diesen ausgeben, ansonsten die
512                // Linkbeschreibung. Die Links sind XML-Elemente in der Navigation.
513                return isset($a['title']) ? $a['title'] : $a;
514        }
515
516        function print_ressourceloader_links($type, $template='<!-- RL: %s -->') {
517                $rl = $this->rl[$type];
518                $rl_links = $rl->get_urls( isset($_GET['rl_debug']) );
519                $rl_pagespecific_links = $rl->get_page_specific_urls($this->conf['seiten_id']);
520
521                foreach(array($rl_links, $rl_pagespecific_links) as $rls) {
522                        foreach($rls as $link) {
523                                // do the host link renaming conversion. This is more important if
524                                // there is a web_prefix than for the suffix rewriting.
525                                $link = $this->conf['host']->rewrite_link($link, true);
526                                printf($template, $link);
527                        }
528                }
529        }
530       
531        function rewrite_page_prefix_links($content) {
532                // called by cache: rewrite the page contents
533                return preg_replace('#(href|src|action)=("|\')/#i', '\\1=\\2'.$this->conf['host']->web_prefix.'/', $content);
534        }
535
536
537} // class t29Template
Note: See TracBrowser for help on using the repository browser.
© 2008 - 2013 technikum29 • Sven Köppel • Some rights reserved
Powered by Trac
Expect where otherwise noted, content on this site is licensed under a Creative Commons 3.0 License