summaryrefslogtreecommitdiff
path: root/src/Compiler/Configfile.php
blob: 84c14f9e7dfb958db16deadd6dccd03a82da32cd (plain)
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
<?php
/**
 * Smarty Internal Plugin Config File Compiler
 * This is the config file compiler class. It calls the lexer and parser to
 * perform the compiling.
 *


 * @author     Uwe Tews
 */

namespace Smarty\Compiler;
use Smarty\Lexer\ConfigfileLexer;
use Smarty\Parser\ConfigfileParser;
use Smarty\Smarty;
use Smarty\Template;
use Smarty\CompilerException;

/**
 * Main config file compiler class
 *


 */
class Configfile extends BaseCompiler {

	/**
	 * Lexer object
	 *
	 * @var ConfigfileLexer
	 */
	public $lex;

	/**
	 * Parser object
	 *
	 * @var ConfigfileParser
	 */
	public $parser;

	/**
	 * Smarty object
	 *
	 * @var Smarty object
	 */
	public $smarty;

	/**
	 * Smarty object
	 *
	 * @var Template object
	 */
	public $template;

	/**
	 * Compiled config data sections and variables
	 *
	 * @var array
	 */
	public $config_data = [];

	/**
	 * Initialize compiler
	 *
	 * @param Smarty $smarty global instance
	 */
	public function __construct(Smarty $smarty) {
		$this->smarty = $smarty;
		$this->config_data['sections'] = [];
		$this->config_data['vars'] = [];
	}

	/**
	 * Method to compile Smarty config source.
	 *
	 * @param Template $template
	 *
	 * @return bool true if compiling succeeded, false if it failed
	 * @throws \Smarty\Exception
	 */
	public function compileTemplate(Template $template) {
		$this->template = $template;
		$this->template->getCompiled()->file_dependency[$this->template->getSource()->uid] =
			[
				$this->template->getSource()->getResourceName(),
				$this->template->getSource()->getTimeStamp(),
				$this->template->getSource()->type,
			];
		if ($this->smarty->debugging) {
			$this->smarty->getDebug()->start_compile($this->template);
		}
		// init the lexer/parser to compile the config file
		/* @var ConfigfileLexer $this->lex */
		$this->lex = new ConfigfileLexer(
			str_replace(
				[
					"\r\n",
					"\r",
				],
				"\n",
				$template->getSource()->getContent()
			) . "\n",
			$this
		);

		$this->parser = new ConfigfileParser($this->lex, $this);
		if ($this->smarty->_parserdebug) {
			$this->parser->PrintTrace();
		}
		// get tokens from lexer and parse them
		while ($this->lex->yylex()) {
			if ($this->smarty->_parserdebug) {
				echo "Parsing  {$this->parser->yyTokenName[$this->lex->token]} Token {$this->lex->value} Line {$this->lex->line} \n";
			}
			$this->parser->doParse($this->lex->token, $this->lex->value);
		}
		// finish parsing process
		$this->parser->doParse(0, 0);
		if ($this->smarty->debugging) {
			$this->smarty->getDebug()->end_compile($this->template);
		}
		// template header code
		$template_header = sprintf(
			"<?php /* Smarty version %s, created on %s\n         compiled from '%s' */ ?>\n",
			\Smarty\Smarty::SMARTY_VERSION,
			date("Y-m-d H:i:s"),
			str_replace('*/', '* /', $this->template->getSource()->getFullResourceName())
		);
		$code = '<?php $_smarty_tpl->parent->assignConfigVars(' .
			var_export($this->config_data, true) . ', $_smarty_tpl->getValue("sections")); ?>';
		return $template_header . $this->template->createCodeFrame($code);
	}

	/**
	 * display compiler error messages without dying
	 * If parameter $args is empty it is a parser detected syntax error.
	 * In this case the parser is called to obtain information about expected tokens.
	 * If parameter $args contains a string this is used as error message
	 *
	 * @param string $args individual error message or null
	 *
	 * @throws CompilerException
	 */
	public function trigger_config_file_error($args = null) {
		// get config source line which has error
		$line = $this->lex->line;
		if (isset($args)) {
			// $line--;
		}
		$match = preg_split("/\n/", $this->lex->data);
		$error_text =
			"Syntax error in config file '{$this->template->getSource()->getFullResourceName()}' on line {$line} '{$match[$line - 1]}' ";
		if (isset($args)) {
			// individual error message
			$error_text .= $args;
		} else {
			// expected token from parser
			foreach ($this->parser->yy_get_expected_tokens($this->parser->yymajor) as $token) {
				$exp_token = $this->parser->yyTokenName[$token];
				if (isset($this->lex->smarty_token_names[$exp_token])) {
					// token type from lexer
					$expect[] = '"' . $this->lex->smarty_token_names[$exp_token] . '"';
				} else {
					// otherwise internal token name
					$expect[] = $this->parser->yyTokenName[$token];
				}
			}
			// output parser error message
			$error_text .= ' - Unexpected "' . $this->lex->value . '", expected one of: ' . implode(' , ', $expect);
		}
		throw new CompilerException($error_text);
	}
}