]> git.immae.eu Git - github/shaarli/Shaarli.git/blob - application/PageBuilder.php
Merge pull request #976 from ArthurHoaro/hotfix/url-parentheses
[github/shaarli/Shaarli.git] / 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 /**
30 * PageBuilder constructor.
31 * $tpl is initialized at false for lazy loading.
32 *
33 * @param ConfigManager $conf Configuration Manager instance (reference).
34 * @param LinkDB $linkDB instance.
35 */
36 public function __construct(&$conf, $linkDB = null)
37 {
38 $this->tpl = false;
39 $this->conf = $conf;
40 $this->linkDB = $linkDB;
41 }
42
43 /**
44 * Initialize all default tpl tags.
45 */
46 private function initialize()
47 {
48 $this->tpl = new RainTPL();
49
50 try {
51 $version = ApplicationUtils::checkUpdate(
52 shaarli_version,
53 $this->conf->get('resource.update_check'),
54 $this->conf->get('updates.check_updates_interval'),
55 $this->conf->get('updates.check_updates'),
56 isLoggedIn(),
57 $this->conf->get('updates.check_updates_branch')
58 );
59 $this->tpl->assign('newVersion', escape($version));
60 $this->tpl->assign('versionError', '');
61
62 } catch (Exception $exc) {
63 logm($this->conf->get('resource.log'), $_SERVER['REMOTE_ADDR'], $exc->getMessage());
64 $this->tpl->assign('newVersion', '');
65 $this->tpl->assign('versionError', escape($exc->getMessage()));
66 }
67
68 $this->tpl->assign('feedurl', escape(index_url($_SERVER)));
69 $searchcrits = ''; // Search criteria
70 if (!empty($_GET['searchtags'])) {
71 $searchcrits .= '&searchtags=' . urlencode($_GET['searchtags']);
72 }
73 if (!empty($_GET['searchterm'])) {
74 $searchcrits .= '&searchterm=' . urlencode($_GET['searchterm']);
75 }
76 $this->tpl->assign('searchcrits', $searchcrits);
77 $this->tpl->assign('source', index_url($_SERVER));
78 $this->tpl->assign('version', shaarli_version);
79 $this->tpl->assign('scripturl', index_url($_SERVER));
80 $this->tpl->assign('privateonly', !empty($_SESSION['privateonly'])); // Show only private links?
81 $this->tpl->assign('untaggedonly', !empty($_SESSION['untaggedonly']));
82 $this->tpl->assign('pagetitle', $this->conf->get('general.title', 'Shaarli'));
83 if ($this->conf->exists('general.header_link')) {
84 $this->tpl->assign('titleLink', $this->conf->get('general.header_link'));
85 }
86 $this->tpl->assign('shaarlititle', $this->conf->get('general.title', 'Shaarli'));
87 $this->tpl->assign('openshaarli', $this->conf->get('security.open_shaarli', false));
88 $this->tpl->assign('showatom', $this->conf->get('feed.show_atom', true));
89 $this->tpl->assign('feed_type', $this->conf->get('feed.show_atom', true) !== false ? 'atom' : 'rss');
90 $this->tpl->assign('hide_timestamps', $this->conf->get('privacy.hide_timestamps', false));
91 $this->tpl->assign('token', getToken($this->conf));
92 if ($this->linkDB !== null) {
93 $this->tpl->assign('tags', $this->linkDB->linksCountPerTag());
94 }
95 // To be removed with a proper theme configuration.
96 $this->tpl->assign('conf', $this->conf);
97 }
98
99 /**
100 * The following assign() method is basically the same as RainTPL (except lazy loading)
101 *
102 * @param string $placeholder Template placeholder.
103 * @param mixed $value Value to assign.
104 */
105 public function assign($placeholder, $value)
106 {
107 if ($this->tpl === false) {
108 $this->initialize();
109 }
110 $this->tpl->assign($placeholder, $value);
111 }
112
113 /**
114 * Assign an array of data to the template builder.
115 *
116 * @param array $data Data to assign.
117 *
118 * @return false if invalid data.
119 */
120 public function assignAll($data)
121 {
122 if ($this->tpl === false) {
123 $this->initialize();
124 }
125
126 if (empty($data) || !is_array($data)){
127 return false;
128 }
129
130 foreach ($data as $key => $value) {
131 $this->assign($key, $value);
132 }
133 return true;
134 }
135
136 /**
137 * Render a specific page (using a template file).
138 * e.g. $pb->renderPage('picwall');
139 *
140 * @param string $page Template filename (without extension).
141 */
142 public function renderPage($page)
143 {
144 if ($this->tpl === false) {
145 $this->initialize();
146 }
147
148 $this->tpl->draw($page);
149 }
150
151 /**
152 * Render a 404 page (uses the template : tpl/404.tpl)
153 * usage : $PAGE->render404('The link was deleted')
154 *
155 * @param string $message A messate to display what is not found
156 */
157 public function render404($message = 'The page you are trying to reach does not exist or has been deleted.')
158 {
159 header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
160 $this->tpl->assign('error_message', $message);
161 $this->renderPage('404');
162 }
163 }