lang
$this->setupLocale();
}
public static function createHtmlQualityNote(Page $page): Message
{
if ($page->isSlot()) {
return Message::createErrorMessage("A has no quality metrics");
}
if (!$page->isDynamicQualityMonitored()) {
return Message::createErrorMessage("This page is not quality monitored. Change the configuration if you want to.");
}
if (!$page->exists()) {
return Message::createInfoMessage("The page does not exist");
}
try {
$analyticsArray = $page->getAnalyticsDocument()->getJson()->toArray();
} catch (ExceptionCombo $e) {
return Message::createErrorMessage("Error while trying to read the JSON analytics document. {$e->getMessage()}")
->setStatus(HttpResponse::STATUS_INTERNAL_ERROR);
}
$rules = $analyticsArray[AnalyticsDocument::QUALITY][AnalyticsDocument::RULES];
/**
* We may got null
* array_key_exists() expects parameter 2 to be array,
* null given in /opt/www/datacadamia.com/lib/plugins/combo/action/qualitymessage.php on line 113
*/
if ($rules == null) {
return Message::createInfoMessage("No rules found in the analytics document");
}
/**
* If there is no info, nothing to show
*/
if (!array_key_exists(AnalyticsDocument::INFO, $rules)) {
return Message::createInfoMessage("No quality rules information to show");
}
/**
* The error info
*/
$qualityInfoRules = $rules[AnalyticsDocument::INFO];
/**
* Excluding the excluded rules
*/
global $conf;
$excludedRulesConf = $conf['plugin'][PluginUtility::PLUGIN_BASE_NAME][self::CONF_EXCLUDED_QUALITY_RULES_FROM_DYNAMIC_MONITORING];
$excludedRules = preg_split("/,/", $excludedRulesConf);
foreach ($excludedRules as $excludedRule) {
if (array_key_exists($excludedRule, $qualityInfoRules)) {
unset($qualityInfoRules[$excludedRule]);
}
}
if (sizeof($qualityInfoRules) <= 0) {
return Message::createInfoMessage("No quality rules information to show");
}
$qualityScore = $analyticsArray[AnalyticsDocument::QUALITY][renderer_plugin_combo_analytics::SCORING][renderer_plugin_combo_analytics::SCORE];
$message = "The page has a " . PluginUtility::getDocumentationHyperLink("quality:score", "quality score") . " of {$qualityScore}.
";
$lowQuality = $analyticsArray[AnalyticsDocument::QUALITY][AnalyticsDocument::LOW];
if ($lowQuality) {
$mandatoryFailedRules = $analyticsArray[AnalyticsDocument::QUALITY][AnalyticsDocument::FAILED_MANDATORY_RULES];
$rulesUrl = PluginUtility::getDocumentationHyperLink("quality:rule", "rules");
$lqPageUrl = PluginUtility::getDocumentationHyperLink("low_quality_page", "low quality page");
$message .= "This is a {$lqPageUrl} because it has failed the following mandatory {$rulesUrl}:";
$message .= "
";
/**
* A low quality page should have
* failed mandatory rules
* but due to the asycn nature, sometimes
* we don't have an array
*/
if (is_array($mandatoryFailedRules)) {
foreach ($mandatoryFailedRules as $mandatoryFailedRule) {
$message .= "- " . PluginUtility::getDocumentationHyperLink("quality:rule#list", $mandatoryFailedRule) . "
";
}
}
$message .= "
";
$message .= "
You can still win a couple of points.
";
$message .= "";
foreach ($qualityInfoRules as $qualityRule => $qualityInfo) {
$message .= "- $qualityInfo
";
}
$message .= "
";
return Message::createInfoMessage($message);
}
function register(Doku_Event_Handler $controller)
{
/**
* Add a icon in the page tools menu
* https://www.dokuwiki.org/devel:event:menu_items_assembly
*/
$controller->register_hook('MENU_ITEMS_ASSEMBLY', 'AFTER', $this, 'addMenuItem');
/**
* The ajax api to return data
*/
$controller->register_hook('AJAX_CALL_UNKNOWN', 'BEFORE', $this, 'ajaxCall');
}
function addMenuItem(Doku_Event $event, $param)
{
if (!Identity::isWriter()) {
return;
}
/**
* The `view` property defines the menu that is currently built
* https://www.dokuwiki.org/devel:menus
* If this is not the page menu, return
*/
if ($event->data['view'] != 'page') return;
global $INFO;
if (!$INFO['exists']) {
return;
}
array_splice($event->data['items'], -1, 0, array(new QualityMenuItem()));
}
/**
* Main function; dispatches the visual comment actions
* @param $event Doku_Event
*/
function ajaxCall(&$event, $param): void
{
$call = $event->data;
if ($call != self::META_MANAGER_CALL_ID) {
return;
}
//no other ajax call handlers needed
$event->stopPropagation();
$event->preventDefault();
/**
* Shared check between post and get HTTP method
*/
$id = $_GET["id"];
if ($id === null) {
/**
* With {@link TestRequest}
* for instance
*/
$id = $_REQUEST["id"];
}
if (empty($id)) {
HttpResponse::create(HttpResponse::STATUS_BAD_REQUEST)
->setEvent($event)
->setCanonical(self::CANONICAL)
->send("The page id should not be empty", Mime::HTML);
return;
}
/**
* Quality is just for the writers
*/
if (!Identity::isWriter($id)) {
HttpResponse::create(HttpResponse::STATUS_NOT_AUTHORIZED)
->setEvent($event)
->send("Quality is only for writer", Mime::HTML);
return;
}
$page = Page::createPageFromId($id);
$message = self::createHtmlQualityNote($page);
$status = $message->getStatus();
if ($status === null) {
$status = HttpResponse::STATUS_ALL_GOOD;
}
HttpResponse::create($status)
->setEvent($event)
->setCanonical(self::CANONICAL)
->send($message->getContent(), Mime::HTML);
}
}