Add kill-switch for built-in snippets

Author: abias

classes/snippets.php

@@ -70,6 +70,13 @@ class snippets {
         'gif',
     ];
 
+    /**
+     * Constant for identifying builtin snippets.
+     *
+     * @var string
+     */
+    const SOURCE_BUILTIN = 'theme_boost_union';
+
     /**
      * Gets the snippet file based on the meta information.
      *
@@ -83,7 +90,7 @@ public static function get_snippet_file($path, $source): string|null {
 
         // Get the snippet file based on the different sources.
         // Builtin CSS Snippets.
-        if ($source === 'theme_boost_union') {
+        if ($source === self::SOURCE_BUILTIN) {
             // Compose the file path.
             $file = $CFG->dirroot . self::BUILTIN_SNIPPETS_BASE_PATH . $path;
 
@@ -151,7 +158,7 @@ public static function get_snippet_preview_url($path, $source): string|null {
 
         // Get the snippet file based on the different sources.
         // Builtin CSS Snippets.
-        if ($source === 'theme_boost_union') {
+        if ($source === self::SOURCE_BUILTIN) {
             $url = self::get_builtin_snippet_preview_url($path, $source);
             // Other snippet sources (which are currently not supported).
         } else {
@@ -264,14 +271,24 @@ public static function compose_snippets_data($snippetrecordset): array {
     public static function get_enabled_snippet_scss(): string {
         global $DB;
 
+        // Prepare WHERE clause based on the enabled sources.
+        $whereparts = self::get_enabled_sources();
+        if (count($whereparts) == 0) {
+            // If no sources are enabled, we do not want to use any snippets.
+            // We do this by restricting the query to an impossible source.
+            $whereparts[] = 'impossible';
+        }
+        list($insql, $inparams) = $DB->get_in_or_equal($whereparts, SQL_PARAMS_NAMED);
+
         // Compose SQL base query.
         $sql = "SELECT *
                 FROM {theme_boost_union_snippets} s
-                WHERE enabled = '1'
-                ORDER BY sortorder";
+                WHERE enabled = '1' AND source ".$insql.
+                " ORDER BY sortorder";
+        $sqlparams = $inparams;
 
         // Get records.
-        $data = $DB->get_recordset_sql($sql);
+        $data = $DB->get_recordset_sql($sql, $sqlparams);
 
         // Initialize SCSS code.
         $scss = '';
@@ -368,6 +385,24 @@ private static function get_builtin_snippet_paths(): array {
         }
     }
 
+    /**
+     * Get the enabled snippet sources.
+     *
+     * @return array
+     */
+    public static function get_enabled_sources(): array {
+        // Initialize sources array.
+        $sources = [];
+
+        // If builtin snippets are enabled.
+        if (get_config('theme_boost_union', 'enablebuiltinsnippets') == THEME_BOOST_UNION_SETTING_SELECT_YES) {
+            $sources[] = self::SOURCE_BUILTIN;
+        }
+
+        // Return.
+        return $sources;
+    }
+
     /**
      * Make sure that the builtin snippets are in the database.
      *
@@ -382,7 +417,7 @@ public static function add_builtin_snippets(): void {
         // Get builtin snippets which are known in the database.
         $snippets = $DB->get_records(
                 'theme_boost_union_snippets',
-                ['source' => 'theme_boost_union'],
+                ['source' => self::SOURCE_BUILTIN],
                 'sortorder DESC',
                 'id,path,sortorder'
         );
@@ -406,7 +441,7 @@ public static function add_builtin_snippets(): void {
                     'theme_boost_union_snippets',
                     [
                         'path' => $path,
-                        'source' => 'theme_boost_union',
+                        'source' => self::SOURCE_BUILTIN,
                         'sortorder' => $sortorder + 1,
                     ]
                 );

classes/table/snippets_overview.php

@@ -272,13 +272,24 @@ public function col_actions($data) {
     public function query_db($pagesize, $useinitialsbar = true) {
         global $DB;
 
+        // Prepare WHERE clause based on the enabled sources.
+        $whereparts = snippets::get_enabled_sources();
+        if (count($whereparts) == 0) {
+            // If no sources are enabled, we do not want to show any snippets.
+            // We do this by restricting the query to an impossible source.
+            $whereparts[] = 'impossible';
+        }
+        list($insql, $inparams) = $DB->get_in_or_equal($whereparts, SQL_PARAMS_NAMED);
+
         // Compose SQL base query.
         $sql = 'SELECT *
                 FROM {theme_boost_union_snippets} s
-                ORDER BY sortorder';
+                WHERE source '.$insql.
+                ' ORDER BY sortorder';
+        $sqlparams = $inparams;
 
         // Get the raw records.
-        $data = $DB->get_recordset_sql($sql);
+        $data = $DB->get_recordset_sql($sql, $sqlparams);
 
         // Compose the complete snippets data and add set it as raw table data.
         $this->rawdata = snippets::compose_snippets_data($data);

lang/en/theme_boost_union.php

@@ -1106,6 +1106,8 @@
 
 // Settings: CSS snippets page.
 $string['configtitlesnippets'] = 'CSS snippets';
+
+// Settings: Overview tab.
 $string['snippetscreator'] = 'Creator';
 $string['snippetsdescription'] = 'Description';
 $string['snippetsdetails'] = 'Details';
@@ -1125,14 +1127,21 @@
 $string['snippetsscopecourse'] = 'Course';
 $string['snippetsscopedashboard'] = 'Dashboard';
 $string['snippetsscopeglobal'] = 'Global';
-$string['snippetssettings'] = 'Settings';
 $string['snippetsshowdetails'] = 'Show details';
 $string['snippetssnippets'] = 'CSS snippets';
 $string['snippetssource'] = 'Source';
 $string['snippetssourcetheme_boost_union'] = 'Boost Union built-in';
 $string['snippetstitle'] = 'Title';
 $string['snippetsusagenote'] = 'Usage note';
 
+// Settings: Settings tab.
+$string['snippetssettings'] = 'Settings';
+// ... Section: Built-in snippets.
+$string['snippetsbuiltinsnippetsheading'] = 'Built-in snippets';
+// ... ... Setting: Enable built-in snippets.
+$string['enablebuiltinsnippets'] = 'Enable built-in snippets';
+$string['enablebuiltinsnippets_desc'] = 'With this setting, you can enable or disable the built-in CSS snippets which are shipped with Boost Union. If you disable this setting, all built-in CSS snippets are ignored and never added to the SCSS stack.';
+
 // Settings: Smart menus page.
 $string['smartmenus'] = 'Smart menus';
 $string['error:smartmenusmenuitemnotfound'] = 'Smart menu item not found';

settings.php

@@ -2840,10 +2840,24 @@
         $page->add($tab);
 
 
-        // Create general settings tab.
+        // Create CSS snippets settings tab.
         $tab = new admin_settingpage('theme_boost_union_snippets_settings',
                 get_string('snippetssettings', 'theme_boost_union', null, true));
 
+        // Create built-in snippets heading.
+        $name = 'theme_boost_union/builtinsnippetsheading';
+        $title = get_string('snippetsbuiltinsnippetsheading', 'theme_boost_union', null, true);
+        $setting = new admin_setting_heading($name, $title, null);
+        $tab->add($setting);
+
+        // Setting: Enable built-in snippets.
+        $name = 'theme_boost_union/enablebuiltinsnippets';
+        $title = get_string('enablebuiltinsnippets', 'theme_boost_union', null, true);
+        $description = get_string('enablebuiltinsnippets_desc', 'theme_boost_union', null, true);
+        $setting = new admin_setting_configselect($name, $title, $description, THEME_BOOST_UNION_SETTING_SELECT_NO, $yesnooption);
+        $setting->set_updatedcallback('theme_reset_all_caches');
+        $tab->add($setting);
+
         // Add tab to settings page.
         $page->add($tab);