ProleWiki:Tasks/Technical - Revision history

Forte: Remove Discord extension since the ConfirmAccount notification has already been implemented

2025-07-15T06:37:21Z

Remove Discord extension since the ConfirmAccount notification has already been implemented

Forte: Added changes done to current extensions

2024-04-30T00:26:28Z

Added changes done to current extensions

← Older revision		Revision as of 00:26, 30 April 2024
Line 246:		Line 246:
	</syntaxhighlight>This is the equivalent of<syntaxhighlight lang="php">		</syntaxhighlight>This is the equivalent of<syntaxhighlight lang="php">
	MediaWikiServices::getInstance()->getHookContainer()->run( 'RenameUserComplete', [ $uid, $old, $new ], [ 'abortable' => false ] );		MediaWikiServices::getInstance()->getHookContainer()->run( 'RenameUserComplete', [ $uid, $old, $new ], [ 'abortable' => false ] );
			</syntaxhighlight>

			=== Current changes to ConfirmAccount and Discord extension ===

			==== ConfirmAccount ====
			<syntaxhighlight lang="php">
			MediaWikiServices::getInstance()->getHookContainer()->run( 'ConfirmAccountRequestComplete', [ $userName=$this->name, $acr_id=$this->id ] );
	</syntaxhighlight>		</syntaxhighlight>

Forte: Detailing hook calls from other extensions

2024-04-29T23:46:38Z

Detailing hook calls from other extensions

@@ Line 163: / Line 163: @@
 </syntaxhighlight>
-=== ApprovedRevs extension as reference for custom hook registry ===
+=== Extension hooks used by Discord extension ===
-Hooks are registered when described in the extension's <code>extension.json</code> file. Both built-in and custom extension hooks are defined there, but custom hooks don't need to be described there necessarily, as far as I've looked.
+The Discord extension uses two hooks declared by extensions, ApprovedRevs and Renameuser extension. Here are examples of the hooks used in the Discord extension, and their registry in each respective extension.
-The ApprovedRevs extension register custom hooks this way (lines 513,514):<syntaxhighlight lang="php" start="488" line="1" highlight="26,27">
+==== ApprovedRevs ====
-public static function saveApprovedRevIDInDB( $title, $rev_id, User $user, $isAutoApprove = true ) {
+<syntaxhighlight lang="php">
-	$timestamp = date( 'Y-m-d H:i:s' );
+/**
-	$approvalInfo = [
+ * Called when a revision is approved (Approved Revs extension)
-		'rev_id' => $rev_id,
+ * @see https://github.com/wikimedia/mediawiki-extensions-ApprovedRevs/blob/REL1_34/includes/ApprovedRevs_body.php
-		'approval_date' => $timestamp
+ */
-	];
+public static function onApprovedRevsRevisionApproved ( $output, $title, $rev_id, $content ) {
-	if ( !$isAutoApprove ) {
+	$user = RequestContext::getMain()->getUser();
-		$approvalInfo['approver_id'] = $user->getID();
+	}
-	$dbw = wfGetDB( DB_MASTER );
+	if ( $wgDiscordNoBots && $user->isBot() ) {
-	$page_id = $title->getArticleID();
+		// Don't continue, this is a bot
-	$old_rev_id = $dbw->selectField( 'approved_revs', 'rev_id', [ 'page_id' => $page_id ] );
+		return true;
+	}
-	$content = self::getContent( $title, $rev_id );
+	// Get the revision being approved here
-	MediaWikiServices::getInstance()->getHookContainer()
+	$rev = MediaWikiServices::getInstance()->getRevisionLookup()->getRevisionByTitle( $title, $rev_id );
-		->run( 'ApprovedRevsRevisionApproved', [ $output = null, $title, $rev_id, $content ] );
+	$revLink = $title->getFullURL( '', false, PROTO_CANONICAL );
+}
 </syntaxhighlight>

Forte: Added highlight to ApprovedRevs function detailing hook registry, plus divided details by sections

2024-04-29T23:02:33Z

Added highlight to ApprovedRevs function detailing hook registry, plus divided details by sections

← Older revision		Revision as of 23:02, 29 April 2024
Line 161:		Line 161:
	return true;		return true;
	}		}
	</syntaxhighlight>Hooks are registered when described in the extension's <code>extension.json</code> file. Both built-in and custom extension hooks are defined there, but custom hooks don't need to be described there necessarily, as far as I've looked.		</syntaxhighlight>

	The ApprovedRevs extension register custom hooks this way (lines 513,514):<syntaxhighlight lang="php" start="488" line="1">		=== ApprovedRevs extension as reference for custom hook registry ===
			Hooks are registered when described in the extension's <code>extension.json</code> file. Both built-in and custom extension hooks are defined there, but custom hooks don't need to be described there necessarily, as far as I've looked.

			The ApprovedRevs extension register custom hooks this way (lines 513,514):<syntaxhighlight lang="php" start="488" line="1" highlight="26,27">
	public static function saveApprovedRevIDInDB( $title, $rev_id, User $user, $isAutoApprove = true ) {		public static function saveApprovedRevIDInDB( $title, $rev_id, User $user, $isAutoApprove = true ) {
	$timestamp = date( 'Y-m-d H:i:s' );		$timestamp = date( 'Y-m-d H:i:s' );

Forte: Added highlight to first function

2024-04-29T21:23:00Z

Added highlight to first function

← Older revision		Revision as of 21:23, 29 April 2024
Line 6:		Line 6:

	==== Discord.php ====		==== Discord.php ====
	This example function uses a MediaWiki hook when a page is saved to trigger the Discord event. We probably need to create a hook for the ConfirmAccount extension for it to communicate with the Discord extension.<syntaxhighlight lang="php" start="16" line="1">		This example function uses a MediaWiki hook when a page is saved to trigger the Discord event. We probably need to create a hook for the ConfirmAccount extension for it to communicate with the Discord extension.<syntaxhighlight lang="php" start="16" line="1" highlight="5,44">
	/**		/**
	* Called when a page is created or edited		* Called when a page is created or edited

Forte: Added further information

2024-04-29T21:20:15Z

Added further information

@@ Line 2: / Line 2: @@
 The following is to detail how the Discord extension works, in hopes to implement that on the ConfirmAccount extension.
-=== Discord.php ===
+=== Discord extension as reference for Discord notification ===
-Uses a MediaWiki hook to trigger the Discord event. So we'd need to check for ConfirmAccount hooks, or worse, create one.<syntaxhighlight lang="php" start="16" line="1">
+There are two main files (Discord.php and DiscordUtils.php) that serve the Discord extension, and together they compose the logic of the notification system.
 /**
   * Called when a page is created or edited
@@ Line 52: / Line 55: @@
 </syntaxhighlight>
-=== Utils.php ===
+==== Utils.php ====
-Further detailing of the "handleDiscord" method, which contains the logic for communication with Discord<syntaxhighlight lang="php" line="1" start="47">
+Further detailing of the "handleDiscord" (called on line 59 of Discord.php) method, which contains the logic for communication with Discord<syntaxhighlight lang="php" line="1" start="47">
 /**
   * Handles sending a webhook to Discord using cURL
@@ Line 157: / Line 160: @@
 	return true;
+}
 </syntaxhighlight>

Forte: Detailed the functioning of the Discord extension, so that we can study it and implement for ConfirmAccount

2024-04-29T03:00:38Z

Detailed the functioning of the Discord extension, so that we can study it and implement for ConfirmAccount

Show changes

Forte: Added further context for mText variable

2024-04-05T02:01:57Z

Added further context for mText variable

@@ Line 39: / Line 39: @@
 		return $this->mText;
+}
 </syntaxhighlight>
   #0 /var/www/prolewiki/extensions/Scribunto/includes/ScribuntoContentHandler.php(224): ParserOutput->getRawText()

Forte: Next function in the backtrace

2024-04-04T23:33:50Z

Next function in the backtrace

@@ Line 38: / Line 38: @@
 		return $this->mText;
+}
 </syntaxhighlight>

Forte: Added line into context

2024-04-04T19:54:24Z

Added line into context

← Older revision		Revision as of 19:54, 4 April 2024
Line 30:		Line 30:
	#22 /var/www/prolewiki/index.php(46): wfIndexMain()		#22 /var/www/prolewiki/index.php(46): wfIndexMain()
	#23 {main}</pre>		#23 {main}</pre>
			from /var/www/prolewiki/includes/parser/ParserOutput.php (382)
			<syntaxhighlight lang="php" line="1" start="380">
			public function getRawText() {
			if ( $this->mText === null ) {
			throw new LogicException( 'This ParserOutput contains no text!' );
			}

			return $this->mText;
			}
			</syntaxhighlight>