WikiBotConfig::talkWithBot() - Code Metrics - Inspection of "add option to convert raw wikiwix url to {lien web..." - Dispositif/Wikibot - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 9f46c8...2432f8 )

by Dispositif

created 2023-10-08 09:37 UTC

WikiBotConfig::talkWithBot() A

↳ Parent: WikiBotConfig

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
eloc	5
c	0
b	0
f	0
dl	0
loc	11
rs	10
ccs	0
cts	3
cp	0
cc	3
nc	3
nop	0
crap	12

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

declare(strict_types=1);

namespace App\Application;

use App\Application\InfrastructurePorts\SMSInterface;
use App\Domain\Exceptions\ConfigException;
use App\Domain\Exceptions\StopActionException;
use App\Domain\Utils\WikiTextUtil;
use DateInterval;
use DateTime;
use DateTimeImmutable;
use DomainException;
use Mediawiki\Api\MediawikiFactory;
use Mediawiki\Api\UsageException;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Throwable;

/**
 * Define wiki configuration of the bot.
 * See also .env file for parameters.
 * Page/Edit/Summary status are defined in Application/.../PageWorkStatus or Domain/OptiStatus
 */
class WikiBotConfig
{
    public const VERSION = '2.1';
    public const WATCHPAGE_FILENAME = __DIR__ . '/resources/watch_pages.json';
    public const EXIT_ON_CHECK_WATCHPAGE = false;
    // do not stop if they play with {stop} on bot talk page
    public const BLACKLIST_EDITOR = ['OrlodrimBot'];
    // Use that timers config instead of worker config ?
    public const BOT_FLAG = false;
    public const MODE_AUTO = false;
    public const EXIT_ON_WIKIMESSAGE = true;
    public const EDIT_LAPS = 20;
    public const EDIT_LAPS_MANUAL = 20;
    public const EDIT_LAPS_AUTOBOT = 60;
    public const EDIT_LAPS_FLAGBOT = 8;
    public const TALK_STOP_CHECK_INTERVAL = 'PT2M';
    public const TALK_PAGE_PREFIX = 'Discussion_utilisateur:';
    public const SLEEP_BEFORE_STOP_TALKPAGE = 30;

    public $taskName = 'Amélioration indéfinie';
    /**
     * @var LoggerInterface
     */
    protected $log;
    /**
     * @var DateTimeImmutable
     */
    protected $lastCheckStopDate;
    /**
     * @var SMSInterface|null
     */
    protected $SMSClient;
    protected $mediawikiFactory;

    public function __construct(MediawikiFactory $mediawikiFactory, ?LoggerInterface $logger = null, ?SMSInterface $SMSClient = null)
    {
        $this->log = $logger ?? new NullLogger();
        ini_set('user_agent', getenv('USER_AGENT'));
        $this->SMSClient = $SMSClient;
        $this->mediawikiFactory = $mediawikiFactory;
    }

    public function getLogger(): LoggerInterface
    {
        return $this->log;
    }

    /**
     * Detect wiki-templates restricting the edition on a frwiki page.
     */
    public static function isEditionTemporaryRestrictedOnWiki(?string $text, ?string $botName = null): bool
    {
        return empty($text)
            || preg_match('#{{Formation#i', $text) > 0
            || preg_match('#{{En travaux#i', $text) > 0
            || preg_match('#{{En cours#i', $text) > 0
            || preg_match('#{{Protection#i', $text) > 0
            || preg_match('#\{\{(R3R|Règle des 3 révocations|travaux|en travaux|en cours|formation)#i', $text) > 0
            || self::isNoBotTag($text, $botName);
    }

    /**
     * Detect {{nobots}}, {{bots|deny=all}}, {{bots|deny=MyBot,BobBot}}.
     * Relevant out of the "main" wiki-namespace (talk pages, etc).
     */
    protected static function isNoBotTag(string $text, ?string $botName = null): bool
    {
        $text = WikiTextUtil::removeHTMLcomments($text);
        $botName = $botName ?: self::getBotName();
        $denyReg = (empty($botName)) ? '' :
            '|\{\{bots ?\| ?(optout|deny)\=[^\}]*' . preg_quote($botName, '#') . '[^\}]*\}\}';
        return preg_match('#({{nobots}}|{{bots ?\| ?(optout|deny) ?= ?all ?}}' . $denyReg . ')#i', $text) > 0;
    }

    protected static function getBotOwner()
    {
        return getenv('BOT_OWNER');
    }

    /**
     * Throws Exception if "{{stop}}" or "STOP" on talk page.
     *
     * @throws StopActionException
     */
    public function checkStopOnTalkpageOrException(?bool $botTalk = false): void
    {
        if ($this->isLastCheckStopDateRecent()) {
            return;
        }

        // don't catch Exception (stop process if error)
        $pageAction = $this->getWikiBotPageAction();
        $text = $pageAction->getText() ?? '';
        $lastEditor = $pageAction->getLastEditor() ?? 'unknown';

        if (preg_match('#({{stop}}|{{Stop}}|STOP)#', $text) > 0) {
            echo date('Y-m-d H:i');
            echo sprintf("\n*** STOP ON TALK PAGE BY %s ***\n\n", $lastEditor);
            sleep(self::SLEEP_BEFORE_STOP_TALKPAGE);

            $this->sendSMSandFunnyTalk($lastEditor, $botTalk);

            throw new StopActionException();
        }

        $this->lastCheckStopDate = new DateTimeImmutable();
    }

    protected function isLastCheckStopDateRecent(): bool
    {
        $now = new DateTimeImmutable();
        $stopInterval = new DateInterval(self::TALK_STOP_CHECK_INTERVAL);

        return $this->lastCheckStopDate instanceof DateTimeImmutable
            && $now < DateTime::createFromImmutable($this->lastCheckStopDate)->add($stopInterval);
    }

    /**
     * @throws UsageException
     */
    protected function getWikiBotPageAction(): WikiPageAction
    {
        return new WikiPageAction($this->mediawikiFactory, $this->getBotTalkPageTitle());
    }

    protected function getBotTalkPageTitle(): string
    {
        return self::TALK_PAGE_PREFIX . $this::getBotName();
    }

    /**
     * @throws ConfigException
     */
    protected static function getBotName(): string
    {
        if (empty(getenv('BOT_NAME'))) {
            throw new ConfigException('BOT_NAME is not defined.');
        }
        return getenv('BOT_NAME') ?? '';
    }

    protected function sendSMSandFunnyTalk(string $lastEditor, ?bool $botTalk): void
    {
        $this->sendSMS($lastEditor);

        if ($botTalk) {
            $this->talkWithBot();
        }
    }

    protected function sendSMS(string $lastEditor): bool
    {
        if ($this->SMSClient instanceof SMSInterface) {
            try {
                return $this->SMSClient->send(sprintf('%s {stop} by %s', $this::getBotName(), $lastEditor));
            } catch (Throwable) {
                return false;
            }
        }

        return false;
    }

    protected function talkWithBot(): bool
    {
        if ($this instanceof TalkBotConfig) {
            try {
                return $this->botTalk();
            } catch (Throwable) {
                // do nothing
            }
        }

        return false;
    }

    /**
     * Is there a new message on the discussion page of the bot (or owner) ?
     * @throws ConfigException
     */
    public function checkWatchPages()
    {
        foreach ($this->getWatchPages() as $title => $lastTime) {
            $pageTime = $this->getTimestamp($title);

            // the page has been edited since last check ?
            if (!$pageTime || $pageTime !== $lastTime) {
                echo sprintf("WATCHPAGE '%s' has been edited since %s.\n", $title, $lastTime);

                // Ask? Mettre à jour $watchPages ?
                echo "Replace with $title => '$pageTime'";

                $this->checkExitOnWatchPage();
            }
        }
    }

    /**
     * @throws ConfigException
     */
    protected function getWatchPages(): array
    {
        if (!file_exists(static::WATCHPAGE_FILENAME)) {
            throw new ConfigException('No watchpage file found.');
        }

        try {
            $json = file_get_contents(static::WATCHPAGE_FILENAME);
            $array = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
        } catch (Throwable) {
            throw new ConfigException('Watchpage file malformed.');
        }

        return $array;
    }

    protected function getTimestamp(string $title): ?string
    {
        $page = new WikiPageAction($this->mediawikiFactory, $title);

        return $page->page->getRevisions()->getLatest()->getTimestamp();
    }

    protected function checkExitOnWatchPage(): void
    {
        if (static::EXIT_ON_CHECK_WATCHPAGE) {
            echo "EXIT_ON_CHECK_WATCHPAGE\n";

            throw new DomainException('exit from check watchpages');
        }
    }

    /**
     * How many minutes since last edit ? Do not to disturb human editors !
     * @return int minutes
     */
    public function minutesSinceLastEdit(string $title): int
    {
        $time = $this->getTimestamp($title);  // 2011-09-02T16:31:13Z

        return (int)round((time() - strtotime($time)) / 60);
    }
}


1		<?php
2		/*
3		* This file is part of dispositif/wikibot application (@github)
4		* 2019-2023 © Philippe M./Irønie <[email protected]>
5		* For the full copyright and MIT license information, view the license file.
6		*/
7
8		declare(strict_types=1);
9
10		namespace App\Application;
11
12		use App\Application\InfrastructurePorts\SMSInterface;
13		use App\Domain\Exceptions\ConfigException;
14		use App\Domain\Exceptions\StopActionException;
15		use App\Domain\Utils\WikiTextUtil;
16		use DateInterval;
17		use DateTime;
18		use DateTimeImmutable;
19		use DomainException;
20		use Mediawiki\Api\MediawikiFactory;
21		use Mediawiki\Api\UsageException;
22		use Psr\Log\LoggerInterface;
23		use Psr\Log\NullLogger;
24		use Throwable;
25
26		/**
27		* Define wiki configuration of the bot.
28		* See also .env file for parameters.
29		* Page/Edit/Summary status are defined in Application/.../PageWorkStatus or Domain/OptiStatus
30		*/
31		class WikiBotConfig
32		{
33		public const VERSION = '2.1';
34		public const WATCHPAGE_FILENAME = __DIR__ . '/resources/watch_pages.json';
35		public const EXIT_ON_CHECK_WATCHPAGE = false;
36		// do not stop if they play with {stop} on bot talk page
37		public const BLACKLIST_EDITOR = ['OrlodrimBot'];
38		// Use that timers config instead of worker config ?
39		public const BOT_FLAG = false;
40		public const MODE_AUTO = false;
41		public const EXIT_ON_WIKIMESSAGE = true;
42		public const EDIT_LAPS = 20;
43		public const EDIT_LAPS_MANUAL = 20;
44		public const EDIT_LAPS_AUTOBOT = 60;
45		public const EDIT_LAPS_FLAGBOT = 8;
46		public const TALK_STOP_CHECK_INTERVAL = 'PT2M';
47		public const TALK_PAGE_PREFIX = 'Discussion_utilisateur:';
48		public const SLEEP_BEFORE_STOP_TALKPAGE = 30;
49
50		public $taskName = 'Amélioration indéfinie';
51		/**
52		* @var LoggerInterface
53		*/
54		protected $log;
55		/**
56		* @var DateTimeImmutable
57		*/
58		protected $lastCheckStopDate;
59		/**
60		* @var SMSInterface\|null
61		*/
62		protected $SMSClient;
63		protected $mediawikiFactory;
64
65		public function __construct(MediawikiFactory $mediawikiFactory, ?LoggerInterface $logger = null, ?SMSInterface $SMSClient = null)
66		{
67		$this->log = $logger ?? new NullLogger();
68		ini_set('user_agent', getenv('USER_AGENT'));
69		$this->SMSClient = $SMSClient;
70		$this->mediawikiFactory = $mediawikiFactory;
71		}
72
73		public function getLogger(): LoggerInterface
74		{
75		return $this->log;
76		}
77
78		/**
79		* Detect wiki-templates restricting the edition on a frwiki page.
80		*/
81		public static function isEditionTemporaryRestrictedOnWiki(?string $text, ?string $botName = null): bool
82		{
83		return empty($text)
84		\|\| preg_match('#{{Formation#i', $text) > 0
85		\|\| preg_match('#{{En travaux#i', $text) > 0
86		\|\| preg_match('#{{En cours#i', $text) > 0
87		\|\| preg_match('#{{Protection#i', $text) > 0
88		\|\| preg_match('#\{\{(R3R\|Règle des 3 révocations\|travaux\|en travaux\|en cours\|formation)#i', $text) > 0
89		\|\| self::isNoBotTag($text, $botName);
90		}
91
92	1	/**
93		* Detect {{nobots}}, {{bots\|deny=all}}, {{bots\|deny=MyBot,BobBot}}.
94	1	* Relevant out of the "main" wiki-namespace (talk pages, etc).
95		*/
96		protected static function isNoBotTag(string $text, ?string $botName = null): bool
97	1	{
98	1	$text = WikiTextUtil::removeHTMLcomments($text);
99	1	$botName = $botName ?: self::getBotName();
100		$denyReg = (empty($botName)) ? '' :
101		'\|\{\{bots ?\\| ?(optout\|deny)\=[^\}]' . preg_quote($botName, '#') . '[^\}]\}\}';
102		return preg_match('#({{nobots}}\|{{bots ?\\| ?(optout\|deny) ?= ?all ?}}' . $denyReg . ')#i', $text) > 0;
103		}
104
105	1	protected static function getBotOwner()
106		{
107		return getenv('BOT_OWNER');
108		}
109
110		/**
111		* Throws Exception if "{{stop}}" or "STOP" on talk page.
112		*
113		* @throws StopActionException
114		*/
115		public function checkStopOnTalkpageOrException(?bool $botTalk = false): void
116		{
117		if ($this->isLastCheckStopDateRecent()) {
118		return;
119		}
120
121		// don't catch Exception (stop process if error)
122		$pageAction = $this->getWikiBotPageAction();
123		$text = $pageAction->getText() ?? '';
124		$lastEditor = $pageAction->getLastEditor() ?? 'unknown';
125
126		if (preg_match('#({{stop}}\|{{Stop}}\|STOP)#', $text) > 0) {
127		echo date('Y-m-d H:i');
128		echo sprintf("\n* STOP ON TALK PAGE BY %s *\n\n", $lastEditor);
129		sleep(self::SLEEP_BEFORE_STOP_TALKPAGE);
130
131		$this->sendSMSandFunnyTalk($lastEditor, $botTalk);
132
133		throw new StopActionException();
134		}
135
136		$this->lastCheckStopDate = new DateTimeImmutable();
137		}
138
139		protected function isLastCheckStopDateRecent(): bool
140		{
141		$now = new DateTimeImmutable();
142		$stopInterval = new DateInterval(self::TALK_STOP_CHECK_INTERVAL);
143
144		return $this->lastCheckStopDate instanceof DateTimeImmutable
145		&& $now < DateTime::createFromImmutable($this->lastCheckStopDate)->add($stopInterval);
146		}
147
148		/**
149		* @throws UsageException
150		*/
151		protected function getWikiBotPageAction(): WikiPageAction
152		{
153		return new WikiPageAction($this->mediawikiFactory, $this->getBotTalkPageTitle());
154		}
155
156		protected function getBotTalkPageTitle(): string
157		{
158		return self::TALK_PAGE_PREFIX . $this::getBotName();
159		}
160
161		/**
162		* @throws ConfigException
163		*/
164		protected static function getBotName(): string
165		{
166		if (empty(getenv('BOT_NAME'))) {
167		throw new ConfigException('BOT_NAME is not defined.');
168		}
169		return getenv('BOT_NAME') ?? '';
170		}
171
172		protected function sendSMSandFunnyTalk(string $lastEditor, ?bool $botTalk): void
173		{
174		$this->sendSMS($lastEditor);
175
176		if ($botTalk) {
177		$this->talkWithBot();
178		}
179		}
180
181		protected function sendSMS(string $lastEditor): bool
182		{
183		if ($this->SMSClient instanceof SMSInterface) {
184		try {
185		return $this->SMSClient->send(sprintf('%s {stop} by %s', $this::getBotName(), $lastEditor));
186		} catch (Throwable) {
187		return false;
188		}
189		}
190
191		return false;
192		}
193
194		protected function talkWithBot(): bool
195		{
196		if ($this instanceof TalkBotConfig) {
197		try {
198		return $this->botTalk();
199		} catch (Throwable) {
200		// do nothing
201		}
202		}
203
204		return false;
205		}
206
207		/**
208		* Is there a new message on the discussion page of the bot (or owner) ?
209		* @throws ConfigException
210		*/
211		public function checkWatchPages()
212		{
213		foreach ($this->getWatchPages() as $title => $lastTime) {
214		$pageTime = $this->getTimestamp($title);
215
216		// the page has been edited since last check ?
217		if (!$pageTime \|\| $pageTime !== $lastTime) {
218		echo sprintf("WATCHPAGE '%s' has been edited since %s.\n", $title, $lastTime);
219
220		// Ask? Mettre à jour $watchPages ?
221		echo "Replace with $title => '$pageTime'";
222
223		$this->checkExitOnWatchPage();
224		}
225		}
226		}
227
228		/**
229		* @throws ConfigException
230		*/
231		protected function getWatchPages(): array
232		{
233		if (!file_exists(static::WATCHPAGE_FILENAME)) {
234		throw new ConfigException('No watchpage file found.');
235		}
236
237		try {
238		$json = file_get_contents(static::WATCHPAGE_FILENAME);
239		$array = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
240		} catch (Throwable) {
241		throw new ConfigException('Watchpage file malformed.');
242		}
243
244		return $array;
245		}
246	4
247		protected function getTimestamp(string $title): ?string
248	4	{
249	4	$page = new WikiPageAction($this->mediawikiFactory, $title);
250
251	4	return $page->page->getRevisions()->getLatest()->getTimestamp();
252	2	}
253
254		protected function checkExitOnWatchPage(): void
255	2	{
256		if (static::EXIT_ON_CHECK_WATCHPAGE) {
257		echo "EXIT_ON_CHECK_WATCHPAGE\n";
258
259		throw new DomainException('exit from check watchpages');
260		}
261		}
262
263		/**
264		* How many minutes since last edit ? Do not to disturb human editors !
265	6	* @return int minutes
266		*/
267	6	public function minutesSinceLastEdit(string $title): int
268	5	{
269	6	$time = $this->getTimestamp($title); // 2011-09-02T16:31:13Z
270
271	4	return (int)round((time() - strtotime($time)) / 60);
272		}
273		}
274

Dispositif / Wikibot

Push — master ( 9f46c8...2432f8 )

WikiBotConfig::talkWithBot() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like