aboutsummaryrefslogtreecommitdiffhomepage
path: root/inc/poche/Template.class.php
blob: b686f2ec783037553db3af677606b46a6256c215 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<?php
/**
 * wallabag, self hostable application allowing you to not miss any content anymore
 *
 * @category   wallabag
 * @author     Nicolas Lœuillet <nicolas@loeuillet.org>
 * @copyright  2013
 * @license    http://opensource.org/licenses/MIT see COPYING file
 */

class Template extends Twig_Environment
{
    protected $wallabag;

    private $canRenderTemplates = TRUE;
    private $currentTheme = '';

    public function __construct(Poche $wallabag)
    {
        $this->wallabag = $wallabag;

        // Set up theme
        $pocheUser = Session::getParam('poche_user');

        $themeDirectory = (is_null($pocheUser) ? DEFAULT_THEME : $pocheUser->getConfigValue('theme'));

        if ($themeDirectory === false) {
            $themeDirectory = DEFAULT_THEME;
        }

        $this->currentTheme = $themeDirectory;

        if ($this->_themeIsInstalled() === array()) {
            $this->_init();
        }
    }

    /**
     * Returns true if selected theme is installed
     *
     * @return bool
     */
    private function _themeIsInstalled()
    {
        $errors = array();

        // Twig is an absolute requirement for wallabag to function.
        // Abort immediately if the Composer installer hasn't been run yet
        if (!$this->canRenderTemplates) {
            $errors[]   = 'Twig does not seem to be installed. Please initialize the Composer installation to automatically fetch dependencies. You can also download <a href="http://wllbg.org/vendor">vendor.zip</a> and extract it in your wallabag folder.';
        }

        // Check if the selected theme and its requirements are present
        $theme = $this->getTheme();
        if ($theme != '' && !is_dir(THEME . '/' . $theme)) {
            $errors[]                   = 'The currently selected theme (' . $theme . ') does not seem to be properly installed (Missing directory: ' . THEME . '/' . $theme . ')';
            $this->canRenderTemplates   = FALSE;
        }

        $themeInfo = $this->getThemeInfo($theme);
        if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
            foreach ($themeInfo['requirements'] as $requiredTheme) {
                if (! is_dir(THEME . '/' . $requiredTheme)) {
                    $errors[]                   = 'The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')';
                    $this->canRenderTemplates   = FALSE;
                }
            }
        }

        $currentErrors = (is_null(Session::getParam('errors'))? array() : Session::getParam('errors'));
        Session::setParam('errors', array_merge($errors, $currentErrors));

        return $errors;
    }

    /**
     * Initialization for templates
     */
    private function _init()
    {
        $loaderChain    = new Twig_Loader_Chain();
        $theme          = $this->getTheme();

        // add the current theme as first to the loader chain
        // so Twig will look there first for overridden template files
        try {
            $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $theme));
        } catch (Twig_Error_Loader $e) {
            # @todo isInstalled() should catch this, inject Twig later
            die('The currently selected theme (' . $theme . ') does not seem to be properly installed (' . THEME . '/' . $theme .' is missing)');
        }

        // add all required themes to the loader chain
        $themeInfo = $this->getThemeInfo($theme);
        if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
            foreach ($themeInfo['requirements'] as $requiredTheme) {
                try {
                    $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $requiredTheme));
                } catch (Twig_Error_Loader $e) {
                    # @todo isInstalled() should catch this, inject Twig later
                    die('The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')');
                }
            }
        }

        if (DEBUG_POCHE) {
            $twigParams = array();
        } else {
            $twigParams = array('cache' => CACHE);
        }

        parent::__construct($loaderChain, $twigParams);

        //$tpl = new Twig_Environment($loaderChain, $twigParams);
        $this->addExtension(new Twig_Extensions_Extension_I18n());

        # filter to display domain name of an url
        $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
        $this->addFilter($filter);

        # filter for reading time
        $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
        $this->addFilter($filter);
    }

    /**
     * Returns current theme
     *
     * @return string
     */
    public function getTheme()
    {
        return $this->currentTheme;
    }

    /**
     * Provides theme information by parsing theme.ini file if present in the theme's root directory.
     * In all cases, the following data will be returned:
     * - name: theme's name, or key if the theme is unnamed,
     * - current: boolean informing if the theme is the current user theme.
     *
     * @param string $theme Theme key (directory name)
     * @return array|boolean Theme information, or false if the theme doesn't exist.
     */
    public function getThemeInfo($theme)
    {
        if (!is_dir(THEME . '/' . $theme)) {
            return false;
        }

        $themeIniFile   = THEME . '/' . $theme . '/theme.ini';
        $themeInfo      = array();

        if (is_file($themeIniFile) && is_readable($themeIniFile)) {
            $themeInfo = parse_ini_file($themeIniFile);
        }

        if ($themeInfo === false) {
            $themeInfo = array();
        }

        if (!isset($themeInfo['name'])) {
            $themeInfo['name'] = $theme;
        }

        $themeInfo['current'] = ($theme === $this->getTheme());

        return $themeInfo;
    }

    /**
     * Returns an array with installed themes
     *
     * @return array
     */
    public function getInstalledThemes()
    {
        $handle = opendir(THEME);
        $themes = array();

        while (($theme = readdir($handle)) !== false) {
            # Themes are stored in a directory, so all directory names are themes
            # @todo move theme installation data to database
            if (!is_dir(THEME . '/' . $theme) || in_array($theme, array('.', '..'))) {
                continue;
            }

            $themes[$theme] = $this->getThemeInfo($theme);
        }

        ksort($themes);

        return $themes;
    }

    /**
     * Update theme for the current user
     *
     * @param $newTheme
     */
    public function updateTheme($newTheme)
    {
        # we are not going to change it to the current theme...
        if ($newTheme == $this->getTheme()) {
            $this->wallabag->messages->add('w', _('still using the "' . $this->getTheme() . '" theme!'));
            Tools::redirect('?view=config');
        }

        $themes = $this->getInstalledThemes();
        $actualTheme = false;

        foreach (array_keys($themes) as $theme) {
            if ($theme == $newTheme) {
                $actualTheme = true;
                break;
            }
        }

        if (!$actualTheme) {
            $this->wallabag->messages->add('e', _('that theme does not seem to be installed'));
            Tools::redirect('?view=config');
        }

        $this->wallabag->store->updateUserConfig($this->wallabag->user->getId(), 'theme', $newTheme);
        $this->wallabag->messages->add('s', _('you have changed your theme preferences'));

        $currentConfig = $_SESSION['poche_user']->config;
        $currentConfig['theme'] = $newTheme;

        $_SESSION['poche_user']->setConfig($currentConfig);

        Tools::emptyCache();
        Tools::redirect('?view=config');
    }
}