2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Moodle implementation of SCSS.
21 * @copyright 2016 Frédéric Massart
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 defined('MOODLE_INTERNAL') ||
die();
28 * Moodle SCSS compiler class.
31 * @copyright 2016 Frédéric Massart
32 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34 class core_scss
extends \ScssPhp\ScssPhp\Compiler
{
36 /** @var string The path to the SCSS file. */
38 /** @var array Bits of SCSS content to prepend. */
39 protected $scssprepend = array();
40 /** @var array Bits of SCSS content. */
41 protected $scsscontent = array();
46 * @param array $scss Associative array of variables and their values.
49 public function add_variables(array $variables) {
50 $this->setVariables($variables);
54 * Append raw SCSS to what's to compile.
56 * @param string $scss SCSS code.
59 public function append_raw_scss($scss) {
60 $this->scsscontent
[] = $scss;
64 * Prepend raw SCSS to what's to compile.
66 * @param string $scss SCSS code.
69 public function prepend_raw_scss($scss) {
70 $this->scssprepend
[] = $scss;
74 * Set the file to compile from.
76 * The purpose of this method is to provide a way to import the
77 * content of a file without messing with the import directories.
79 * @param string $filepath The path to the file.
82 public function set_file($filepath) {
83 $this->scssfile
= $filepath;
84 $this->setImportPaths([dirname($filepath)]);
92 public function to_css() {
93 $content = implode(';', $this->scssprepend
);
94 if (!empty($this->scssfile
)) {
95 $content .= file_get_contents($this->scssfile
);
97 $content .= implode(';', $this->scsscontent
);
98 return $this->compile($content);
104 * Overrides ScssPHP's implementation, using the SassC compiler if it is available.
106 * @param string $code SCSS to compile.
107 * @param string $path Path to SCSS to compile.
109 * @return string The compiled CSS.
111 public function compile($code, $path = null) {
114 $pathtosassc = trim($CFG->pathtosassc ??
'');
116 if (!empty($pathtosassc) && is_executable($pathtosassc) && !is_dir($pathtosassc)) {
117 $process = proc_open(
118 $pathtosassc . ' -I' . implode(':', $this->importPaths
) . ' -s',
120 ['pipe', 'r'], // Set the process stdin pipe to read mode.
121 ['pipe', 'w'], // Set the process stdout pipe to write mode.
122 ['pipe', 'w'] // Set the process stderr pipe to write mode.
124 $pipes // Pipes become available in $pipes (pass by reference).
126 if (is_resource($process)) {
127 fwrite($pipes[0], $code); // Write the raw scss to the sassc process stdin.
130 $stdout = stream_get_contents($pipes[1]);
131 $stderr = stream_get_contents($pipes[2]);
136 // The proc_close function returns the process exit status. Anything other than 0 is bad.
137 if (proc_close($process) !== 0) {
138 throw new coding_exception($stderr);
141 // Compiled CSS code will be available from stdout.
146 return $this->compileString($code, $path)->getCss();
150 * Compile child; returns a value to halt execution
152 * @param array $child
153 * @param \ScssPhp\ScssPhp\Formatter\OutputBlock $out
157 protected function compileChild($child, \ScssPhp\ScssPhp\Formatter\OutputBlock
$out) {
159 case \ScssPhp\ScssPhp\Type
::T_SCSSPHP_IMPORT_ONCE
:
160 case \ScssPhp\ScssPhp\Type
::T_IMPORT
:
161 list(, $rawpath) = $child;
162 $rawpath = $this->reduce($rawpath);
163 $path = $this->compileStringContent($rawpath);
165 // We need to find the import path relative to the directory of the currently processed file.
166 $currentdirectory = new ReflectionProperty(\ScssPhp\ScssPhp\Compiler
::class, 'currentDirectory');
168 if ($path = $this->findImport($path, $currentdirectory->getValue($this))) {
169 if ($this->is_valid_file($path)) {
170 return parent
::compileChild($child, $out);
172 // Sneaky stuff, don't let non scss file in.
173 debugging("Can't import scss file - " . $path, DEBUG_DEVELOPER
);
178 return parent
::compileChild($child, $out);
183 * Is the given file valid for import ?
188 protected function is_valid_file($path) {
191 $realpath = realpath($path);
193 // Additional theme directory.
194 $addthemedirectory = core_component
::get_plugin_types()['theme'];
195 $addrealroot = realpath($addthemedirectory);
197 // Original theme directory.
198 $themedirectory = $CFG->dirroot
. "/theme";
199 $realroot = realpath($themedirectory);
201 // File should end in .scss and must be in sites theme directory, else ignore it.
202 $pathvalid = $realpath !== false;
203 $pathvalid = $pathvalid && (substr($path, -5) === '.scss');
204 $pathvalid = $pathvalid && (strpos($realpath, $realroot) === 0 ||
strpos($realpath, $addrealroot) === 0);