Exposed verbose debugging mode in UI

catalyst · Feb 4, 2025 · 42e61ce · 42e61ce
1 parent caf01c9
commit 42e61ce
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 3 deletions.
diff --git a/classes/robot/crawler.php b/classes/robot/crawler.php
@@ -861,8 +861,9 @@ public function parse_html($node, $external, $verbose = false) {
             } while ($walk);
 
             $text = self::clean_html_node_content($e);
+            $text = trim($text);
             if ($verbose > 1) {
-                printf (" - Found link to: %-20s / %-50s => %-50s\n", $text, $e->href, $href);
+                printf (" - Found link to: %-30s -> %s\n", "'$text'", $href);
             }
             $this->link_from_node_to_url($node, $href, $text, $idattr);
         }

diff --git a/lang/en/tool_crawler.php b/lang/en/tool_crawler.php
@@ -75,6 +75,11 @@
 $string['crawlend'] = 'Crawl end';
 $string['crawlstart'] = 'Crawl start';
 $string['cronticks'] = 'Cron ticks';
+$string['debugging'] = 'Verbose debugging';
+$string['debugoff'] = 'Debugging off';
+$string['debugnormal'] = 'Normal debugging';
+$string['debugverbose'] = 'Verbose debugging';
+$string['debuggingdesc'] = 'This turns on debugging in the task output';
 $string['disablebot'] = 'Disable the link crawler robot';
 $string['disablebotdesc'] = 'Make the crawler do nothing when a scheduled task is executed. This effectively prevents crawling of links and running of bot cleanup functions. Intended to deactivate or temporarily pause the crawler without having to disable all its scheduled tasks.';
 $string['duration'] = 'Duration';

diff --git a/lib.php b/lib.php
@@ -45,6 +45,11 @@ function tool_crawler_crawl($verbose = false) {
     $robot = new crawler();
     $url = new url();
     $config = $robot::get_config();
+
+    if ($config->debugging) {
+        $verbose = $config->debugging;
+    }
+
     $crawlstart = $config->crawlstart;
     $crawlend   = $config->crawlend;
 

diff --git a/settings.php b/settings.php
@@ -209,5 +209,16 @@
                                                         new lang_string('disablebot',         'tool_crawler'),
                                                         new lang_string('disablebotdesc',     'tool_crawler'),
                                                         '0' ));
+
+        $options = [
+            0 => new lang_string('debugoff', 'tool_crawler'),
+            1 => new lang_string('debugnormal', 'tool_crawler'),
+            2 => new lang_string('debugverbose', 'tool_crawler'),
+        ];
+        $settings->add(new admin_setting_configselect('tool_crawler/debyugging',
+                                                    new lang_string('debugging',              'tool_crawler'),
+                                                    new lang_string('debuggingdesc',          'tool_crawler'),
+                                                    0,
+                                                    $options));
     }
 }
diff --git a/version.php b/version.php
@@ -27,8 +27,8 @@
 defined('MOODLE_INTERNAL') || die();
 
 
-$plugin->version   = 2024031401;        // The current plugin version (Date: YYYYMMDDXX)
-$plugin->release   = 2024031401;        // The current plugin version (Date: YYYYMMDDXX)
+$plugin->version   = 2025020401;        // The current plugin version (Date: YYYYMMDDXX)
+$plugin->release   = 2025020401;        // The current plugin version (Date: YYYYMMDDXX)
 $plugin->requires  = 2016021800;        // Requires this Moodle version.
 $plugin->supported = [34, 405];
 $plugin->component = 'tool_crawler'; // To check on upgrade, that module sits in correct place.