aboutsummaryrefslogtreecommitdiffhomepage
path: root/application/render/PageBuilder.php
diff options
context:
space:
mode:
authorArthurHoaro <arthur@hoa.ro>2020-10-13 12:05:08 +0200
committerArthurHoaro <arthur@hoa.ro>2020-10-13 12:05:08 +0200
commitb6f678a5a1d15acf284ebcec16c905e976671ce1 (patch)
tree33c7da831482ed79c44896ef19c73c72ada84f2e /application/render/PageBuilder.php
parentb14687036b9b800681197f51fdc47e62f0c88e2e (diff)
parent1c1520b6b98ab20201bfe15577782a52320339df (diff)
downloadShaarli-b6f678a5a1d15acf284ebcec16c905e976671ce1.tar.gz
Shaarli-b6f678a5a1d15acf284ebcec16c905e976671ce1.tar.zst
Shaarli-b6f678a5a1d15acf284ebcec16c905e976671ce1.zip
Merge branch 'v0.12' into latest
Diffstat (limited to 'application/render/PageBuilder.php')
-rw-r--r--application/render/PageBuilder.php94
1 files changed, 60 insertions, 34 deletions
diff --git a/application/render/PageBuilder.php b/application/render/PageBuilder.php
index 3f86fc26..41b357dd 100644
--- a/application/render/PageBuilder.php
+++ b/application/render/PageBuilder.php
@@ -3,10 +3,12 @@
3namespace Shaarli\Render; 3namespace Shaarli\Render;
4 4
5use Exception; 5use Exception;
6use exceptions\MissingBasePathException;
6use RainTPL; 7use RainTPL;
7use Shaarli\ApplicationUtils; 8use Shaarli\ApplicationUtils;
8use Shaarli\Bookmark\LinkDB; 9use Shaarli\Bookmark\BookmarkServiceInterface;
9use Shaarli\Config\ConfigManager; 10use Shaarli\Config\ConfigManager;
11use Shaarli\Security\SessionManager;
10use Shaarli\Thumbnailer; 12use Shaarli\Thumbnailer;
11 13
12/** 14/**
@@ -34,9 +36,9 @@ class PageBuilder
34 protected $session; 36 protected $session;
35 37
36 /** 38 /**
37 * @var LinkDB $linkDB instance. 39 * @var BookmarkServiceInterface $bookmarkService instance.
38 */ 40 */
39 protected $linkDB; 41 protected $bookmarkService;
40 42
41 /** 43 /**
42 * @var null|string XSRF token 44 * @var null|string XSRF token
@@ -52,23 +54,32 @@ class PageBuilder
52 * PageBuilder constructor. 54 * PageBuilder constructor.
53 * $tpl is initialized at false for lazy loading. 55 * $tpl is initialized at false for lazy loading.
54 * 56 *
55 * @param ConfigManager $conf Configuration Manager instance (reference). 57 * @param ConfigManager $conf Configuration Manager instance (reference).
56 * @param array $session $_SESSION array 58 * @param array $session $_SESSION array
57 * @param LinkDB $linkDB instance. 59 * @param BookmarkServiceInterface $linkDB instance.
58 * @param string $token Session token 60 * @param string $token Session token
59 * @param bool $isLoggedIn 61 * @param bool $isLoggedIn
60 */ 62 */
61 public function __construct(&$conf, $session, $linkDB = null, $token = null, $isLoggedIn = false) 63 public function __construct(&$conf, $session, $linkDB = null, $token = null, $isLoggedIn = false)
62 { 64 {
63 $this->tpl = false; 65 $this->tpl = false;
64 $this->conf = $conf; 66 $this->conf = $conf;
65 $this->session = $session; 67 $this->session = $session;
66 $this->linkDB = $linkDB; 68 $this->bookmarkService = $linkDB;
67 $this->token = $token; 69 $this->token = $token;
68 $this->isLoggedIn = $isLoggedIn; 70 $this->isLoggedIn = $isLoggedIn;
69 } 71 }
70 72
71 /** 73 /**
74 * Reset current state of template rendering.
75 * Mostly useful for error handling. We remove everything, and display the error template.
76 */
77 public function reset(): void
78 {
79 $this->tpl = false;
80 }
81
82 /**
72 * Initialize all default tpl tags. 83 * Initialize all default tpl tags.
73 */ 84 */
74 private function initialize() 85 private function initialize()
@@ -125,8 +136,8 @@ class PageBuilder
125 136
126 $this->tpl->assign('language', $this->conf->get('translation.language')); 137 $this->tpl->assign('language', $this->conf->get('translation.language'));
127 138
128 if ($this->linkDB !== null) { 139 if ($this->bookmarkService !== null) {
129 $this->tpl->assign('tags', $this->linkDB->linksCountPerTag()); 140 $this->tpl->assign('tags', escape($this->bookmarkService->bookmarksCountPerTag()));
130 } 141 }
131 142
132 $this->tpl->assign( 143 $this->tpl->assign(
@@ -136,16 +147,43 @@ class PageBuilder
136 $this->tpl->assign('thumbnails_width', $this->conf->get('thumbnails.width')); 147 $this->tpl->assign('thumbnails_width', $this->conf->get('thumbnails.width'));
137 $this->tpl->assign('thumbnails_height', $this->conf->get('thumbnails.height')); 148 $this->tpl->assign('thumbnails_height', $this->conf->get('thumbnails.height'));
138 149
139 if (!empty($_SESSION['warnings'])) { 150 $this->tpl->assign('formatter', $this->conf->get('formatter', 'default'));
140 $this->tpl->assign('global_warnings', $_SESSION['warnings']); 151
141 unset($_SESSION['warnings']); 152 $this->tpl->assign('links_per_page', $this->session['LINKS_PER_PAGE']);
142 }
143 153
144 // To be removed with a proper theme configuration. 154 // To be removed with a proper theme configuration.
145 $this->tpl->assign('conf', $this->conf); 155 $this->tpl->assign('conf', $this->conf);
146 } 156 }
147 157
148 /** 158 /**
159 * Affect variable after controller processing.
160 * Used for alert messages.
161 */
162 protected function finalize(string $basePath): void
163 {
164 // TODO: use the SessionManager
165 $messageKeys = [
166 SessionManager::KEY_SUCCESS_MESSAGES,
167 SessionManager::KEY_WARNING_MESSAGES,
168 SessionManager::KEY_ERROR_MESSAGES
169 ];
170 foreach ($messageKeys as $messageKey) {
171 if (!empty($_SESSION[$messageKey])) {
172 $this->tpl->assign('global_' . $messageKey, $_SESSION[$messageKey]);
173 unset($_SESSION[$messageKey]);
174 }
175 }
176
177 $this->assign('base_path', $basePath);
178 $this->assign(
179 'asset_path',
180 $basePath . '/' .
181 rtrim($this->conf->get('resource.raintpl_tpl', 'tpl'), '/') . '/' .
182 $this->conf->get('resource.theme', 'default')
183 );
184 }
185
186 /**
149 * The following assign() method is basically the same as RainTPL (except lazy loading) 187 * The following assign() method is basically the same as RainTPL (except lazy loading)
150 * 188 *
151 * @param string $placeholder Template placeholder. 189 * @param string $placeholder Template placeholder.
@@ -183,33 +221,21 @@ class PageBuilder
183 } 221 }
184 222
185 /** 223 /**
186 * Render a specific page (using a template file). 224 * Render a specific page as string (using a template file).
187 * e.g. $pb->renderPage('picwall'); 225 * e.g. $pb->render('picwall');
188 * 226 *
189 * @param string $page Template filename (without extension). 227 * @param string $page Template filename (without extension).
228 *
229 * @return string Processed template content
190 */ 230 */
191 public function renderPage($page) 231 public function render(string $page, string $basePath): string
192 { 232 {
193 if ($this->tpl === false) { 233 if ($this->tpl === false) {
194 $this->initialize(); 234 $this->initialize();
195 } 235 }
196 236
197 $this->tpl->draw($page); 237 $this->finalize($basePath);
198 }
199 238
200 /** 239 return $this->tpl->draw($page, true);
201 * Render a 404 page (uses the template : tpl/404.tpl)
202 * usage: $PAGE->render404('The link was deleted')
203 *
204 * @param string $message A message to display what is not found
205 */
206 public function render404($message = '')
207 {
208 if (empty($message)) {
209 $message = t('The page you are trying to reach does not exist or has been deleted.');
210 }
211 header($_SERVER['SERVER_PROTOCOL'] . ' ' . t('404 Not Found'));
212 $this->tpl->assign('error_message', $message);
213 $this->renderPage('404');
214 } 240 }
215} 241}