Wiki::cloneWithDomain() - Code Metrics - Inspection of "Rename Controller -> Wiki" - Daimona/BotRiconferme - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 390609...8584e7 )

by Daimona

created 2019-11-11 14:43 UTC

Wiki::cloneWithDomain() A

↳ Parent: Wiki

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php declare( strict_types=1 );

namespace BotRiconferme\Wiki;

use BotRiconferme\Config;
use BotRiconferme\Exception\EditException;
use BotRiconferme\Exception\LoginException;
use BotRiconferme\Exception\APIRequestException;
use BotRiconferme\Exception\MissingPageException;
use BotRiconferme\Exception\MissingSectionException;
use BotRiconferme\Logger;
use BotRiconferme\Request\RequestBase;

/**
 * Class for wiki interaction, contains some requests shorthands
 */
class Wiki {
	/** @var bool */
	private static $loggedIn = false;
	/** @var Logger */
	private $logger;
	/** @var string */
	private $domain;
	/** @var string[] */
	private $tokens;

	/**
	 * @param Logger $logger
	 * @param string $domain The URL of the wiki, if different from default
	 */
	public function __construct( Logger $logger, string $domain = DEFAULT_URL ) {
		$this->logger = $logger;
		$this->setDomain( $domain );
	}

	/**
	 * @param string $domain
	 * @return Wiki
	 */
	public function cloneWithDomain( string $domain ) {
		$ret = clone $this;
		$ret->setDomain( $domain );
		return $ret;
	}

	/**
	 * @param string $domain
	 */
	public function setDomain( string $domain ) {
		$this->domain = $domain;
	}

	/**
	 * Gets the content of a wiki page
	 *
	 * @param string $title
	 * @param int|null $section
	 * @return string
	 * @throws MissingPageException
	 * @throws MissingSectionException
	 */
	public function getPageContent( string $title, int $section = null ) : string {
		$msg = "Retrieving content of $title" . ( $section !== null ? ", section $section" : '' );
		$this->logger->debug( $msg );
		$params = [
			'action' => 'query',
			'titles' => $title,
			'prop' => 'revisions',
			'rvslots' => 'main',
			'rvprop' => 'content'
		];

		if ( $section !== null ) {
			$params['rvsection'] = $section;
		}

		$req = RequestBase::newFromParams( $params )->setUrl( $this->domain );
		$data = $req->execute();
		$page = reset( $data->query->pages );
		if ( isset( $page->missing ) ) {
			throw new MissingPageException( $title );
		}

		$mainSlot = $page->revisions[0]->slots->main;

		// @phan-suppress-next-line PhanImpossibleTypeComparison $section can be null
		if ( $section !== null && isset( $mainSlot->nosuchsection ) ) {
			throw new MissingSectionException( $title, $section );
		}
		return $mainSlot->{ '*' };
	}

	/**
	 * Basically a wrapper for action=edit
	 *
	 * @param array $params
	 * @throws EditException
	 */
	public function editPage( array $params ) {
		$this->login();

		$params = [
			'action' => 'edit',
			'token' => $this->getToken( 'csrf' ),
		] + $params;

		if ( Config::getInstance()->get( 'bot-edits' ) ) {
			$params['bot'] = 1;
		}

		$res = RequestBase::newFromParams( $params )
			->setUrl( $this->domain )
			->setPost()
			->execute();

		$editData = $res->edit;
		if ( $editData->result !== 'Success' ) {
			if ( isset( $editData->captcha ) ) {
				throw new EditException( 'Got captcha!' );
			}
			throw new EditException( $editData->info ?? reset( $editData ) );
		}
	}

	/**
	 * Login wrapper. Checks if we're already logged in and clears tokens cache
	 * @throws LoginException
	 */
	public function login() {
		if ( self::$loggedIn ) {
			return;
		}

		// Yes, this is an easter egg.
		$this->logger->info( 'Logging in. Username: BotRiconferme, password: correctHorseBatteryStaple' );

		$params = [
			'action' => 'login',
			'lgname' => Config::getInstance()->get( 'username' ),
			'lgpassword' => Config::getInstance()->get( 'password' ),
			'lgtoken' => $this->getToken( 'login' )
		];

		try {
			$res = RequestBase::newFromParams( $params )->setUrl( $this->domain )->setPost()->execute();
		} catch ( APIRequestException $e ) {
			throw new LoginException( $e->getMessage() );
		}

		if ( !isset( $res->login->result ) || $res->login->result !== 'Success' ) {
			throw new LoginException( 'Unknown error' );
		}

		self::$loggedIn = true;
		// Clear tokens cache
		$this->tokens = [];
		$this->logger->info( 'Login succeeded' );
	}

	/**
	 * Get a token, cached.
	 *
	 * @param string $type
	 * @return string
	 */
	public function getToken( string $type ) : string {
		if ( !isset( $this->tokens[ $type ] ) ) {
			$params = [
				'action' => 'query',
				'meta'   => 'tokens',
				'type'   => $type
			];

			$req = RequestBase::newFromParams( $params )->setUrl( $this->domain );
			$res = $req->execute();

			$this->tokens[ $type ] = $res->query->tokens->{ "{$type}token" };
		}

		return $this->tokens[ $type ];
	}

	/**
	 * Get the timestamp of the creation of the given page
	 *
	 * @param string $title
	 * @return int
	 */
	public function getPageCreationTS( string $title ) : int {
		$params = [
			'action' => 'query',
			'prop' => 'revisions',
			'titles' => $title,
			'rvprop' => 'timestamp',
			'rvslots' => 'main',
			'rvlimit' => 1,
			'rvdir' => 'newer'
		];

		$res = RequestBase::newFromParams( $params )->setUrl( $this->domain )->execute();
		$data = $res->query->pages;
		return strtotime( reset( $data )->revisions[0]->timestamp );
	}

	/**
	 * Sysop-level inifinite protection for a given page
	 *
	 * @param string $title
	 * @param string $reason
	 */
	public function protectPage( string $title, string $reason ) {
		$this->logger->info( "Protecting page $title" );
		$this->login();

		$params = [
			'action' => 'protect',
			'title' => $title,
			'protections' => 'edit=sysop|move=sysop',
			'expiry' => 'infinite',
			'reason' => $reason,
			'token' => $this->getToken( 'csrf' )
		];

		RequestBase::newFromParams( $params )->setUrl( $this->domain )->setPost()->execute();
	}
}


1			<?php declare( strict_types=1 );
2
3			namespace BotRiconferme\Wiki;
4
5			use BotRiconferme\Config;
6			use BotRiconferme\Exception\EditException;
7			use BotRiconferme\Exception\LoginException;
8			use BotRiconferme\Exception\APIRequestException;
9			use BotRiconferme\Exception\MissingPageException;
10			use BotRiconferme\Exception\MissingSectionException;
11			use BotRiconferme\Logger;
12			use BotRiconferme\Request\RequestBase;
13
14			/**
15			* Class for wiki interaction, contains some requests shorthands
16			*/
17			class Wiki {
18			/** @var bool */
19			private static $loggedIn = false;
20			/** @var Logger */
21			private $logger;
22			/** @var string */
23			private $domain;
24			/** @var string[] */
25			private $tokens;
26
27			/**
28			* @param Logger $logger
29			* @param string $domain The URL of the wiki, if different from default
30			*/
31			public function __construct( Logger $logger, string $domain = DEFAULT_URL ) {
32			$this->logger = $logger;
33			$this->setDomain( $domain );
34			}
35
36			/**
37			* @param string $domain
38			* @return Wiki
39			*/
40			public function cloneWithDomain( string $domain ) {
41			$ret = clone $this;
42			$ret->setDomain( $domain );
43			return $ret;
44			}
45
46			/**
47			* @param string $domain
48			*/
49			public function setDomain( string $domain ) {
50			$this->domain = $domain;
51			}
52
53			/**
54			* Gets the content of a wiki page
55			*
56			* @param string $title
57			* @param int\|null $section
58			* @return string
59			* @throws MissingPageException
60			* @throws MissingSectionException
61			*/
62			public function getPageContent( string $title, int $section = null ) : string {
63			$msg = "Retrieving content of $title" . ( $section !== null ? ", section $section" : '' );
64			$this->logger->debug( $msg );
65			$params = [
66			'action' => 'query',
67			'titles' => $title,
68			'prop' => 'revisions',
69			'rvslots' => 'main',
70			'rvprop' => 'content'
71			];
72
73			if ( $section !== null ) {
74			$params['rvsection'] = $section;
75			}
76
77			$req = RequestBase::newFromParams( $params )->setUrl( $this->domain );
78			$data = $req->execute();
79			$page = reset( $data->query->pages );
80			if ( isset( $page->missing ) ) {
81			throw new MissingPageException( $title );
82			}
83
84			$mainSlot = $page->revisions[0]->slots->main;
85
86			// @phan-suppress-next-line PhanImpossibleTypeComparison $section can be null
87			if ( $section !== null && isset( $mainSlot->nosuchsection ) ) {
88			throw new MissingSectionException( $title, $section );
89			}
90			return $mainSlot->{ '*' };
91			}
92
93			/**
94			* Basically a wrapper for action=edit
95			*
96			* @param array $params
97			* @throws EditException
98			*/
99			public function editPage( array $params ) {
100			$this->login();
101
102			$params = [
103			'action' => 'edit',
104			'token' => $this->getToken( 'csrf' ),
105			] + $params;
106
107			if ( Config::getInstance()->get( 'bot-edits' ) ) {
108			$params['bot'] = 1;
109			}
110
111			$res = RequestBase::newFromParams( $params )
112			->setUrl( $this->domain )
113			->setPost()
114			->execute();
115
116			$editData = $res->edit;
117			if ( $editData->result !== 'Success' ) {
118			if ( isset( $editData->captcha ) ) {
119			throw new EditException( 'Got captcha!' );
120			}
121			throw new EditException( $editData->info ?? reset( $editData ) );
122			}
123			}
124
125			/**
126			* Login wrapper. Checks if we're already logged in and clears tokens cache
127			* @throws LoginException
128			*/
129			public function login() {
130			if ( self::$loggedIn ) {
131			return;
132			}
133
134			// Yes, this is an easter egg.
135			$this->logger->info( 'Logging in. Username: BotRiconferme, password: correctHorseBatteryStaple' );
136
137			$params = [
138			'action' => 'login',
139			'lgname' => Config::getInstance()->get( 'username' ),
140			'lgpassword' => Config::getInstance()->get( 'password' ),
141			'lgtoken' => $this->getToken( 'login' )
142			];
143
144			try {
145			$res = RequestBase::newFromParams( $params )->setUrl( $this->domain )->setPost()->execute();
146			} catch ( APIRequestException $e ) {
147			throw new LoginException( $e->getMessage() );
148			}
149
150			if ( !isset( $res->login->result ) \|\| $res->login->result !== 'Success' ) {
151			throw new LoginException( 'Unknown error' );
152			}
153
154			self::$loggedIn = true;
155			// Clear tokens cache
156			$this->tokens = [];
157			$this->logger->info( 'Login succeeded' );
158			}
159
160			/**
161			* Get a token, cached.
162			*
163			* @param string $type
164			* @return string
165			*/
166			public function getToken( string $type ) : string {
167			if ( !isset( $this->tokens[ $type ] ) ) {
168			$params = [
169			'action' => 'query',
170			'meta' => 'tokens',
171			'type' => $type
172			];
173
174			$req = RequestBase::newFromParams( $params )->setUrl( $this->domain );
175			$res = $req->execute();
176
177			$this->tokens[ $type ] = $res->query->tokens->{ "{$type}token" };
178			}
179
180			return $this->tokens[ $type ];
181			}
182
183			/**
184			* Get the timestamp of the creation of the given page
185			*
186			* @param string $title
187			* @return int
188			*/
189			public function getPageCreationTS( string $title ) : int {
190			$params = [
191			'action' => 'query',
192			'prop' => 'revisions',
193			'titles' => $title,
194			'rvprop' => 'timestamp',
195			'rvslots' => 'main',
196			'rvlimit' => 1,
197			'rvdir' => 'newer'
198			];
199
200			$res = RequestBase::newFromParams( $params )->setUrl( $this->domain )->execute();
201			$data = $res->query->pages;
202			return strtotime( reset( $data )->revisions[0]->timestamp );
203			}
204
205			/**
206			* Sysop-level inifinite protection for a given page
207			*
208			* @param string $title
209			* @param string $reason
210			*/
211			public function protectPage( string $title, string $reason ) {
212			$this->logger->info( "Protecting page $title" );
213			$this->login();
214
215			$params = [
216			'action' => 'protect',
217			'title' => $title,
218			'protections' => 'edit=sysop\|move=sysop',
219			'expiry' => 'infinite',
220			'reason' => $reason,
221			'token' => $this->getToken( 'csrf' )
222			];
223
224			RequestBase::newFromParams( $params )->setUrl( $this->domain )->setPost()->execute();
225			}
226			}
227

Daimona / BotRiconferme

Push — master ( 390609...8584e7 )

Wiki::cloneWithDomain() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like