NotificationWorker::process() - Code Metrics - Inspection of "Refactor NotificationWorker" - Dispositif/Wikibot - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 26e53d...a73e13 )

by Dispositif

created 2020-09-02 16:44 UTC

NotificationWorker::process() B

↳ Parent: NotificationWorker

Complexity

Conditions	7
Paths	7

Size

Total Lines	51
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	7
eloc	29
c	3
b	0
f	0
nc	7
nop	0
dl	0
loc	51
rs	8.5226

How to fix Long Method

<?php
/**
 * This file is part of dispositif/wikibot application (@github)
 * 2019/2020 © Philippe M. <[email protected]>
 * For the full copyright and MIT license information, please view the license file.
 */

declare(strict_types=1);

namespace App\Application;

use App\Infrastructure\ServiceFactory;
use Mediawiki\Api\MediawikiApi;
use Mediawiki\Api\SimpleRequest;
use Mediawiki\Api\UsageException;
use Mediawiki\DataModel\EditInfo;

/**
 * todo internationalize (enwiki, etc)
 * Parsing last notifications to the bot (and set them read).
 * Doc API : https://www.mediawiki.org/wiki/Notifications/API
 * TYPES :
 * edit-user-talk
 * mention-summary (alerte)
 * mention (Discussion utilisateur:Codaxbot)
 * flowusertalk-post-reply (alerte,   "title": {
 * "full": "Discussion utilisateur:Ir\u00f8nie",
 * "namespace": "Discussion_utilisateur")
 * Class NotificationWorker
 */
class NotificationWorker
{
    const DEFAULT_WIKIS             = 'frwiki';
    const DIFF_URL                  = 'https://fr.wikipedia.org/w/index.php?diff=';
    const ARTICLE_ANALYZED_FILENAME = __DIR__.'/resources/article_externRef_edited.txt';
    const SUMMARY                   = '⚙ mise à jour notifications (ping [[User:Irønie]])';
    const PAGENAME_NOTIFICATION_LOG = 'Utilisateur:CodexBot/Notifications';
    const SKIP_BOTPAGES
                                    = [
            'Utilisateur:CodexBot',
            'Discussion utilisateur:CodexBot',
            'Utilisateur:ZiziBot',
            'Discussion utilisateur:ZiziBot',
        ];

    /**
     * @var MediawikiApi
     */
    private $api;
    /**
     * @var array
     */
    private $option;

    /**
     * NotificationWorker constructor.
     *
     * @throws UsageException
     */
    public function __construct(?array $option = null)
    {
        $this->api = ServiceFactory::getMediawikiApi();
        $this->option = ($option) ?? [];

        $this->process();
    }

    private function process()
    {
        $notifications = $this->requestNotifications();
        if (empty($notifications)) {
            return;
        }

        krsort($notifications);

        $wikilog = [];
        foreach ($notifications as $notif) {
            $title = $notif['title']['full'];

            // Skip bot pages
            if (in_array(
                $title,
                self::SKIP_BOTPAGES
            )
            ) {
                continue;
            }

            $date = new \DateTime($notif['timestamp']['utciso8601']);

            if (isset($notif['title']) && in_array($notif['title']['namespace'], ['', 'Discussion'])) {
                $icon = '🌼 '; // Article + Discussion
            }

            $wikilog[] = sprintf(
                '* %s %s[[%s]] ([%s%s diff]) par %s',
                $date->format('d-m-Y H\hi'),
                $icon ?? '',
                $title,
                self::DIFF_URL,
                $notif['revid'] ?? '',
                $notif['agent']['name'] ?? '???'
            );
            //            dump($notif);

            if (!isset($notif['read'])) {
                $this->postNotifAsRead($notif['id']);
            }

            $this->processSpecialActions($notif);
        }

        dump($wikilog);

        echo "sleep 20";
        sleep(20);
        $this->editWikilog($wikilog);
    }

    private function requestNotifications(): ?array
    {
        $result = $this->api->getRequest(
            new SimpleRequest(
                'query', [
                    'meta' => 'notifications',
                    'notwikis' => self::DEFAULT_WIKIS,
                    'notfilter' => '!read', // default: read|!read
                    'notlimit' => '30', // max 50
                    //                   'notunreadfirst' => '1', // comment for false
                    //                   'notgroupbysection' => '1',
                    'notsections' => 'alert', // alert|message
                    'format' => 'php',
                ]
            )
        );

        if (empty($result)) {
            return [];
        }

        return $result['query']['notifications']['list'];
    }

    private function postNotifAsRead(int $id): bool
    {
        sleep(2);
        try {
            $this->api->postRequest(
                new SimpleRequest(
                    'echomarkread', [
                        'list' => $id,
                        'token' => $this->api->getToken(),
                    ]
                )
            );
        } catch (\Throwable $e) {
            return false;
        }

        return true;
    }

    /**
     * Write wikilog of notifications on a dedicated page.
     *
     * @param array $wikilog
     *
     * @return bool
     * @throws UsageException
     */
    private function editWikilog(array $wikilog): bool
    {
        if (empty($wikilog)) {
            return false;
        }
        $text = implode("\n", $wikilog)."\n";

        $wiki = ServiceFactory::wikiApi();
        $pageAction = new WikiPageAction($wiki, self::PAGENAME_NOTIFICATION_LOG);

        $success = $pageAction->addToTopOfThePage(
            $text,
            new EditInfo(self::SUMMARY, false, false)
        );

        //        dump($success);

        return $success;
    }

    /**
     * Put there the special action to execute with each notification.
     *
     * @param $notif
     */
    protected function processSpecialActions($notif)
    protected function processSpecialActions(/** @scrutinizer ignore-unused */ $notif)
    {
        // optional for children
    }

}


Dispositif / Wikibot

Push — master ( 26e53d...a73e13 )

NotificationWorker::process() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like