* logger: add optional HTML output

* feed debugger: add checkbox to dump feed XML
This commit is contained in:
Andrew Dolgov 2023-08-02 09:04:41 +03:00
parent 3d255d861c
commit 1d788eddf8
No known key found for this signature in database
GPG Key ID: 1A56B4FA25D4AF2A
3 changed files with 101 additions and 41 deletions

View File

@ -5,6 +5,8 @@ class Debug {
const LOG_VERBOSE = 1; const LOG_VERBOSE = 1;
const LOG_EXTENDED = 2; const LOG_EXTENDED = 2;
const SEPARATOR = "<-{log-separator}->";
const ALL_LOG_LEVELS = [ const ALL_LOG_LEVELS = [
Debug::LOG_DISABLED, Debug::LOG_DISABLED,
Debug::LOG_NORMAL, Debug::LOG_NORMAL,
@ -35,6 +37,7 @@ class Debug {
private static bool $enabled = false; private static bool $enabled = false;
private static bool $quiet = false; private static bool $quiet = false;
private static ?string $logfile = null; private static ?string $logfile = null;
private static bool $enable_html = false;
private static int $loglevel = self::LOG_NORMAL; private static int $loglevel = self::LOG_NORMAL;
@ -82,6 +85,10 @@ class Debug {
} }
} }
public static function enable_html(bool $enable) : void {
self::$enable_html = $enable;
}
/** /**
* @param Debug::LOG_* $level log level * @param Debug::LOG_* $level log level
*/ */
@ -94,6 +101,13 @@ class Debug {
$ts = "$ts/" . posix_getpid(); $ts = "$ts/" . posix_getpid();
} }
$orig_message = $message;
if ($message === self::SEPARATOR) {
$message = self::$enable_html ? "<hr/>" :
"=================================================================================================================================";
}
if (self::$logfile) { if (self::$logfile) {
$fp = fopen(self::$logfile, 'a+'); $fp = fopen(self::$logfile, 'a+');
@ -132,7 +146,15 @@ class Debug {
} }
} }
if (self::$enable_html) {
if ($orig_message === self::SEPARATOR) {
print "$message\n";
} else {
print "<span class='log-timestamp'>$ts</span> <span class='log-message'>$message</span>\n";
}
} else {
print "[$ts] $message\n"; print "[$ts] $message\n";
}
return true; return true;
} }

View File

@ -708,6 +708,23 @@ class Feeds extends Handler_Protected {
body.css_loading * { body.css_loading * {
display : none; display : none;
} }
.feed-xml {
color : green;
}
.log-timestamp {
color : gray;
}
.log-timestamp::before {
content: "["
}
.log-timestamp::after {
content: "]"
}
</style> </style>
<script> <script>
dojoConfig = { dojoConfig = {
@ -759,6 +776,10 @@ class Feeds extends Handler_Protected {
<label class="checkbox"><?= \Controls\checkbox_tag("force_rehash", isset($_REQUEST["force_rehash"])) ?> Force rehash</label> <label class="checkbox"><?= \Controls\checkbox_tag("force_rehash", isset($_REQUEST["force_rehash"])) ?> Force rehash</label>
</fieldset> </fieldset>
<fieldset class="narrow">
<label class="checkbox"><?= \Controls\checkbox_tag("dump_feed_xml", isset($_REQUEST["dump_feed_xml"])) ?> Dump feed XML</label>
</fieldset>
<?= \Controls\submit_tag("Continue") ?> <?= \Controls\submit_tag("Continue") ?>
</form> </form>
@ -767,7 +788,7 @@ class Feeds extends Handler_Protected {
<pre><?php <pre><?php
if ($do_update) { if ($do_update) {
RSSUtils::update_rss_feed($feed_id, true); RSSUtils::update_rss_feed($feed_id, true, true);
} }
?></pre> ?></pre>

View File

@ -1,5 +1,6 @@
<?php <?php
class RSSUtils { class RSSUtils {
/** /**
* @param array<string, mixed> $article * @param array<string, mixed> $article
*/ */
@ -351,9 +352,10 @@ class RSSUtils {
} }
} }
static function update_rss_feed(int $feed, bool $no_cache = false) : bool { static function update_rss_feed(int $feed, bool $no_cache = false, bool $html_output = false) : bool {
$scope = Tracer::start(__METHOD__, [], func_get_args()); $scope = Tracer::start(__METHOD__, [], func_get_args());
Debug::enable_html($html_output);
Debug::log("start", Debug::LOG_VERBOSE); Debug::log("start", Debug::LOG_VERBOSE);
$pdo = Db::pdo(); $pdo = Db::pdo();
@ -424,6 +426,7 @@ class RSSUtils {
$rss_hash = false; $rss_hash = false;
$force_refetch = isset($_REQUEST["force_refetch"]); $force_refetch = isset($_REQUEST["force_refetch"]);
$dump_feed_xml = isset($_REQUEST["dump_feed_xml"]);
$feed_data = ""; $feed_data = "";
Debug::log("running HOOK_FETCH_FEED handlers...", Debug::LOG_VERBOSE); Debug::log("running HOOK_FETCH_FEED handlers...", Debug::LOG_VERBOSE);
@ -569,6 +572,14 @@ class RSSUtils {
$pff_owner_uid = $feed_obj->owner_uid; $pff_owner_uid = $feed_obj->owner_uid;
$pff_feed_url = $feed_obj->feed_url; $pff_feed_url = $feed_obj->feed_url;
if ($dump_feed_xml) {
Debug::log("feed data before hooks:", Debug::LOG_VERBOSE);
Debug::log(Debug::SEPARATOR, Debug::LOG_VERBOSE);
print("<code class='feed-xml'>" . htmlspecialchars($feed_data). "</code>\n");
Debug::log(Debug::SEPARATOR, Debug::LOG_VERBOSE);
}
$start_ts = microtime(true); $start_ts = microtime(true);
$pluginhost->chain_hooks_callback(PluginHost::HOOK_FEED_FETCHED, $pluginhost->chain_hooks_callback(PluginHost::HOOK_FEED_FETCHED,
function ($result, $plugin) use (&$feed_data, $start_ts) { function ($result, $plugin) use (&$feed_data, $start_ts) {
@ -583,6 +594,14 @@ class RSSUtils {
Debug::log("feed data has not been modified by a plugin.", Debug::LOG_VERBOSE); Debug::log("feed data has not been modified by a plugin.", Debug::LOG_VERBOSE);
} }
if ($dump_feed_xml) {
Debug::log("feed data after hooks:", Debug::LOG_VERBOSE);
Debug::log(Debug::SEPARATOR, Debug::LOG_VERBOSE);
print("<code class='feed-xml'>" . htmlspecialchars($feed_data). "</code>\n");
Debug::log(Debug::SEPARATOR, Debug::LOG_VERBOSE);
}
$rss = new FeedParser($feed_data); $rss = new FeedParser($feed_data);
$rss->init(); $rss->init();
@ -697,8 +716,7 @@ class RSSUtils {
$pdo->beginTransaction(); $pdo->beginTransaction();
Debug::log("=================================================================================================================================", Debug::log(Debug::SEPARATOR, Debug::LOG_VERBOSE);
Debug::LOG_VERBOSE);
if (Debug::get_loglevel() >= 3) { if (Debug::get_loglevel() >= 3) {
print_r($item); print_r($item);
@ -1290,8 +1308,7 @@ class RSSUtils {
$a_scope->close(); $a_scope->close();
} }
Debug::log("=================================================================================================================================", Debug::log(Debug::SEPARATOR, Debug::LOG_VERBOSE);
Debug::LOG_VERBOSE);
Debug::log("purging feed...", Debug::LOG_VERBOSE); Debug::log("purging feed...", Debug::LOG_VERBOSE);