3 use Shaarli\Config\ConfigManager
;
4 use Shaarli\Thumbnailer
;
7 * This class is in charge of building the final page.
8 * (This is basically a wrapper around RainTPL which pre-fills some fields.)
9 * $p = new PageBuilder();
10 * $p->assign('myfield','myvalue');
11 * $p->renderPage('mytemplate');
16 * @var RainTPL RainTPL instance.
21 * @var ConfigManager $conf Configuration Manager instance.
26 * @var array $_SESSION
31 * @var LinkDB $linkDB instance.
36 * @var null|string XSRF token
40 /** @var bool $isLoggedIn Whether the user is logged in **/
41 protected $isLoggedIn = false;
44 * PageBuilder constructor.
45 * $tpl is initialized at false for lazy loading.
47 * @param ConfigManager $conf Configuration Manager instance (reference).
48 * @param array $session $_SESSION array
49 * @param LinkDB $linkDB instance.
50 * @param string $token Session token
51 * @param bool $isLoggedIn
53 public function __construct(&$conf, $session, $linkDB = null, $token = null, $isLoggedIn = false)
57 $this->session
= $session;
58 $this->linkDB
= $linkDB;
59 $this->token
= $token;
60 $this->isLoggedIn
= $isLoggedIn;
64 * Initialize all default tpl tags.
66 private function initialize()
68 $this->tpl
= new RainTPL();
71 $version = ApplicationUtils
::checkUpdate(
73 $this->conf
->get('resource.update_check'),
74 $this->conf
->get('updates.check_updates_interval'),
75 $this->conf
->get('updates.check_updates'),
77 $this->conf
->get('updates.check_updates_branch')
79 $this->tpl
->assign('newVersion', escape($version));
80 $this->tpl
->assign('versionError', '');
81 } catch (Exception
$exc) {
82 logm($this->conf
->get('resource.log'), $_SERVER['REMOTE_ADDR'], $exc->getMessage());
83 $this->tpl
->assign('newVersion', '');
84 $this->tpl
->assign('versionError', escape($exc->getMessage()));
87 $this->tpl
->assign('is_logged_in', $this->isLoggedIn
);
88 $this->tpl
->assign('feedurl', escape(index_url($_SERVER)));
89 $searchcrits = ''; // Search criteria
90 if (!empty($_GET['searchtags'])) {
91 $searchcrits .= '&searchtags=' . urlencode($_GET['searchtags']);
93 if (!empty($_GET['searchterm'])) {
94 $searchcrits .= '&searchterm=' . urlencode($_GET['searchterm']);
96 $this->tpl
->assign('searchcrits', $searchcrits);
97 $this->tpl
->assign('source', index_url($_SERVER));
98 $this->tpl
->assign('version', SHAARLI_VERSION
);
101 ApplicationUtils
::getVersionHash(SHAARLI_VERSION
, $this->conf
->get('credentials.salt'))
103 $this->tpl
->assign('index_url', index_url($_SERVER));
104 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
105 $this->tpl
->assign('visibility', $visibility);
106 $this->tpl
->assign('untaggedonly', !empty($_SESSION['untaggedonly']));
107 $this->tpl
->assign('pagetitle', $this->conf
->get('general.title', 'Shaarli'));
108 if ($this->conf
->exists('general.header_link')) {
109 $this->tpl
->assign('titleLink', $this->conf
->get('general.header_link'));
111 $this->tpl
->assign('shaarlititle', $this->conf
->get('general.title', 'Shaarli'));
112 $this->tpl
->assign('openshaarli', $this->conf
->get('security.open_shaarli', false));
113 $this->tpl
->assign('showatom', $this->conf
->get('feed.show_atom', true));
114 $this->tpl
->assign('feed_type', $this->conf
->get('feed.show_atom', true) !== false ? 'atom' : 'rss');
115 $this->tpl
->assign('hide_timestamps', $this->conf
->get('privacy.hide_timestamps', false));
116 $this->tpl
->assign('token', $this->token
);
118 if ($this->linkDB
!== null) {
119 $this->tpl
->assign('tags', $this->linkDB
->linksCountPerTag());
123 'thumbnails_enabled',
124 $this->conf
->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
126 $this->tpl
->assign('thumbnails_width', $this->conf
->get('thumbnails.width'));
127 $this->tpl
->assign('thumbnails_height', $this->conf
->get('thumbnails.height'));
129 if (! empty($_SESSION['warnings'])) {
130 $this->tpl
->assign('global_warnings', $_SESSION['warnings']);
131 unset($_SESSION['warnings']);
134 // To be removed with a proper theme configuration.
135 $this->tpl
->assign('conf', $this->conf
);
139 * The following assign() method is basically the same as RainTPL (except lazy loading)
141 * @param string $placeholder Template placeholder.
142 * @param mixed $value Value to assign.
144 public function assign($placeholder, $value)
146 if ($this->tpl
=== false) {
149 $this->tpl
->assign($placeholder, $value);
153 * Assign an array of data to the template builder.
155 * @param array $data Data to assign.
157 * @return false if invalid data.
159 public function assignAll($data)
161 if ($this->tpl
=== false) {
165 if (empty($data) || !is_array($data)) {
169 foreach ($data as $key => $value) {
170 $this->assign($key, $value);
176 * Render a specific page (using a template file).
177 * e.g. $pb->renderPage('picwall');
179 * @param string $page Template filename (without extension).
181 public function renderPage($page)
183 if ($this->tpl
=== false) {
187 $this->tpl
->draw($page);
191 * Render a 404 page (uses the template : tpl/404.tpl)
192 * usage : $PAGE->render404('The link was deleted')
194 * @param string $message A messate to display what is not found
196 public function render404($message = '')
198 if (empty($message)) {
199 $message = t('The page you are trying to reach does not exist or has been deleted.');
201 header($_SERVER['SERVER_PROTOCOL'] .' '. t('404 Not Found'));
202 $this->tpl
->assign('error_message', $message);
203 $this->renderPage('404');