application/PageBuilder.php

   1 <?php
   2
   3 use Shaarli\Config\ConfigManager;
   4
   5 /**
   6  * This class is in charge of building the final page.
   7  * (This is basically a wrapper around RainTPL which pre-fills some fields.)
   8  * $p = new PageBuilder();
   9  * $p->assign('myfield','myvalue');
  10  * $p->renderPage('mytemplate');
  11  */
  12 class PageBuilder
  13 {
  14     /**
  15      * @var RainTPL RainTPL instance.
  16      */
  17     private $tpl;
  18
  19     /**
  20      * @var ConfigManager $conf Configuration Manager instance.
  21      */
  22     protected $conf;
  23
  24     /**
  25      * @var LinkDB $linkDB instance.
  26      */
  27     protected $linkDB;
  28
  29     /** @var bool $isLoggedIn Whether the user is logged in **/
  30     protected $isLoggedIn = false;
  31
  32     /**
  33      * PageBuilder constructor.
  34      * $tpl is initialized at false for lazy loading.
  35      *
  36      * @param ConfigManager $conf   Configuration Manager instance (reference).
  37      * @param LinkDB        $linkDB instance.
  38      * @param string        $token  Session token
  39      */
  40     public function __construct(&$conf, $linkDB = null, $token = null, $isLoggedIn = false)
  41     {
  42         $this->tpl = false;
  43         $this->conf = $conf;
  44         $this->linkDB = $linkDB;
  45         $this->token = $token;
  46         $this->isLoggedIn = $isLoggedIn;
  47     }
  48
  49     /**
  50      * Initialize all default tpl tags.
  51      */
  52     private function initialize()
  53     {
  54         $this->tpl = new RainTPL();
  55
  56         try {
  57             $version = ApplicationUtils::checkUpdate(
  58                 SHAARLI_VERSION,
  59                 $this->conf->get('resource.update_check'),
  60                 $this->conf->get('updates.check_updates_interval'),
  61                 $this->conf->get('updates.check_updates'),
  62                 $this->isLoggedIn,
  63                 $this->conf->get('updates.check_updates_branch')
  64             );
  65             $this->tpl->assign('newVersion', escape($version));
  66             $this->tpl->assign('versionError', '');
  67
  68         } catch (Exception $exc) {
  69             logm($this->conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], $exc->getMessage());
  70             $this->tpl->assign('newVersion', '');
  71             $this->tpl->assign('versionError', escape($exc->getMessage()));
  72         }
  73
  74         $this->tpl->assign('is_logged_in', $this->isLoggedIn);
  75         $this->tpl->assign('feedurl', escape(index_url($_SERVER)));
  76         $searchcrits = ''; // Search criteria
  77         if (!empty($_GET['searchtags'])) {
  78             $searchcrits .= '&searchtags=' . urlencode($_GET['searchtags']);
  79         }
  80         if (!empty($_GET['searchterm'])) {
  81             $searchcrits .= '&searchterm=' . urlencode($_GET['searchterm']);
  82         }
  83         $this->tpl->assign('searchcrits', $searchcrits);
  84         $this->tpl->assign('source', index_url($_SERVER));
  85         $this->tpl->assign('version', SHAARLI_VERSION);
  86         $this->tpl->assign(
  87             'version_hash',
  88             ApplicationUtils::getVersionHash(SHAARLI_VERSION, $this->conf->get('credentials.salt'))
  89         );
  90         $this->tpl->assign('scripturl', index_url($_SERVER));
  91         $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
  92         $this->tpl->assign('visibility', $visibility);
  93         $this->tpl->assign('untaggedonly', !empty($_SESSION['untaggedonly']));
  94         $this->tpl->assign('pagetitle', $this->conf->get('general.title', 'Shaarli'));
  95         if ($this->conf->exists('general.header_link')) {
  96             $this->tpl->assign('titleLink', $this->conf->get('general.header_link'));
  97         }
  98         $this->tpl->assign('shaarlititle', $this->conf->get('general.title', 'Shaarli'));
  99         $this->tpl->assign('openshaarli', $this->conf->get('security.open_shaarli', false));
 100         $this->tpl->assign('showatom', $this->conf->get('feed.show_atom', true));
 101         $this->tpl->assign('feed_type', $this->conf->get('feed.show_atom', true) !== false ? 'atom' : 'rss');
 102         $this->tpl->assign('hide_timestamps', $this->conf->get('privacy.hide_timestamps', false));
 103         $this->tpl->assign('token', $this->token);
 104
 105         if ($this->linkDB !== null) {
 106             $this->tpl->assign('tags', $this->linkDB->linksCountPerTag());
 107         }
 108
 109         $this->tpl->assign('thumbnails_enabled', $this->conf->get('thumbnails.enabled'));
 110         $this->tpl->assign('thumbnails_width', $this->conf->get('thumbnails.width'));
 111         $this->tpl->assign('thumbnails_height', $this->conf->get('thumbnails.height'));
 112
 113         // To be removed with a proper theme configuration.
 114         $this->tpl->assign('conf', $this->conf);
 115     }
 116
 117     /**
 118      * The following assign() method is basically the same as RainTPL (except lazy loading)
 119      *
 120      * @param string $placeholder Template placeholder.
 121      * @param mixed  $value       Value to assign.
 122      */
 123     public function assign($placeholder, $value)
 124     {
 125         if ($this->tpl === false) {
 126             $this->initialize();
 127         }
 128         $this->tpl->assign($placeholder, $value);
 129     }
 130
 131     /**
 132      * Assign an array of data to the template builder.
 133      *
 134      * @param array $data Data to assign.
 135      *
 136      * @return false if invalid data.
 137      */
 138     public function assignAll($data)
 139     {
 140         if ($this->tpl === false) {
 141             $this->initialize();
 142         }
 143
 144         if (empty($data) || !is_array($data)){
 145             return false;
 146         }
 147
 148         foreach ($data as $key => $value) {
 149             $this->assign($key, $value);
 150         }
 151         return true;
 152     }
 153
 154     /**
 155      * Render a specific page (using a template file).
 156      * e.g. $pb->renderPage('picwall');
 157      *
 158      * @param string $page Template filename (without extension).
 159      */
 160     public function renderPage($page)
 161     {
 162         if ($this->tpl === false) {
 163             $this->initialize();
 164         }
 165
 166         $this->tpl->draw($page);
 167     }
 168
 169     /**
 170      * Render a 404 page (uses the template : tpl/404.tpl)
 171      * usage : $PAGE->render404('The link was deleted')
 172      *
 173      * @param string $message A messate to display what is not found
 174      */
 175     public function render404($message = '')
 176     {
 177         if (empty($message)) {
 178             $message = t('The page you are trying to reach does not exist or has been deleted.');
 179         }
 180         header($_SERVER['SERVER_PROTOCOL'] .' '. t('404 Not Found'));
 181         $this->tpl->assign('error_message', $message);
 182         $this->renderPage('404');
 183     }
 184 }