First draft

Stephane Bisson · Stephane Bisson · commit a4baec53680a · 2019-01-07T11:27:57.000-05:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,12 @@
+{
+	"root": true,
+	"extends": [
+		"wikimedia/client",
+		"wikimedia/jquery"
+	],
+	"globals": {
+		"mw": false,
+		"OO": false,
+		"module": false
+	}
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+/node_modules
+/vendor
+/composer.lock
diff --git a/.phpcs.xml b/.phpcs.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<ruleset>
+	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki" />
+	<file>.</file>
+	<arg name="bootstrap" value="./vendor/mediawiki/mediawiki-codesniffer/utils/bootstrap-ci.php"/>
+	<arg name="extensions" value="php,php5,inc"/>
+	<arg name="encoding" value="UTF-8"/>
+</ruleset>
diff --git a/.stylelintrc.json b/.stylelintrc.json
@@ -0,0 +1,3 @@
+{
+	"extends": "stylelint-config-wikimedia"
+}
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1 @@
+The development of this software is covered by a [Code of Conduct](https://www.mediawiki.org/wiki/Special:MyLanguage/Code_of_Conduct).
diff --git a/COPYING b/COPYING
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -0,0 +1,34 @@
+module.exports = function ( grunt ) {
+	var conf = grunt.file.readJSON( 'extension.json' );
+
+	grunt.loadNpmTasks( 'grunt-eslint' );
+	grunt.loadNpmTasks( 'grunt-jsonlint' );
+	grunt.loadNpmTasks( 'grunt-banana-checker' );
+	grunt.loadNpmTasks( 'grunt-stylelint' );
+
+	grunt.initConfig( {
+		eslint: {
+			all: [
+				'**/*.js',
+				'!node_modules/**',
+				'!vendor/**'
+			]
+		},
+		stylelint: {
+			all: [
+				'modules/**/*.less'
+			]
+		},
+		banana: conf.MessagesDirs,
+		jsonlint: {
+			all: [
+				'**/*.json',
+				'!node_modules/**',
+				'!vendor/**'
+			]
+		}
+	} );
+
+	grunt.registerTask( 'test', [ 'eslint', 'jsonlint', 'banana', 'stylelint' ] );
+	grunt.registerTask( 'default', 'test' );
+};
diff --git a/Inbox.alias.php b/Inbox.alias.php
@@ -0,0 +1,14 @@
+<?php
+/**
+ * Aliases for Special:Inbox
+ *
+ * @file
+ * @ingroup Extensions
+ */
+
+$specialPageAliases = [];
+
+/** English (English) */
+$specialPageAliases['en'] = [
+	'Inbox' => [ 'Inbox' ],
+];
diff --git a/README b/README
@@ -0,0 +1,3 @@
+This is a MediaWiki extension that provides a way to test emails locally.
+
+See the wiki page for more information: <https://www.mediawiki.org/wiki/Extension:Inbox>.
diff --git a/README.md b/README.md
diff --git a/composer.json b/composer.json
@@ -0,0 +1,22 @@
+{
+	"require-dev": {
+		"jakub-onderka/php-parallel-lint": "1.0.0",
+		"mediawiki/mediawiki-codesniffer": "23.0.0",
+		"jakub-onderka/php-console-highlighter": "0.3.2",
+		"mediawiki/minus-x": "0.3.1"
+	},
+	"scripts": {
+		"fix": [
+			"phpcbf",
+			"minus-x fix ."
+		],
+		"test": [
+			"parallel-lint . --exclude vendor --exclude node_modules",
+			"phpcs -s -p",
+			"minus-x check ."
+		]
+	},
+	"extra": {
+		"phan-taint-check-plugin": "1.5.0"
+	}
+}
diff --git a/extension.json b/extension.json
@@ -0,0 +1,38 @@
+{
+	"name": "Inbox",
+	"descriptionmsg": "inbox-desc",
+	"license-name": "GPL-3.0-or-later",
+	"author": [
+		"Stephane Bisson"
+	],
+	"url": "https://www.mediawiki.org/wiki/Extension:Inbox",
+	"requires": {
+		"MediaWiki": ">= 1.32.0"
+	},
+	"AutoloadNamespaces": {
+		"Inbox\\": "includes/"
+	},
+	"MessagesDirs": {
+		"Inbox": [
+			"i18n"
+		]
+	},
+	"ExtensionMessagesFiles": {
+		"InboxAlias": "Inbox.alias.php"
+	},
+	"SpecialPages": {
+		"Inbox": "Inbox\\Specials\\SpecialInbox"
+	},
+	"Hooks": {
+		"LoadExtensionSchemaUpdates": "Inbox\\Hooks::onLoadExtensionSchemaUpdates",
+		"AlternateUserMailer": "Inbox\\Hooks::onAlternateUserMailer",
+		"PersonalUrls": "Inbox\\Hooks::onPersonalUrls"
+	},
+	"config": {
+		"InboxEnabled": {
+			"description": "Global ON/OFF switch for the Inbox features.",
+			"value": false
+		}
+	},
+	"manifest_version": 2
+}
diff --git a/i18n/en.json b/i18n/en.json
@@ -0,0 +1,6 @@
+{
+	"@metadata": {
+		"authors": []
+	},
+	"growthexperiments-desc": "This extension provides a way to test emails locally."
+}
diff --git a/i18n/qqq.json b/i18n/qqq.json
@@ -0,0 +1,4 @@
+{
+	"@metadata": [],
+	"inbox-desc": "{{desc|name=Inbox|url=https://www.mediawiki.org/wiki/Extension:Inbox}}"
+}
diff --git a/includes/Hooks.php b/includes/Hooks.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Inbox;
+
+use DatabaseUpdater;
+use Inbox\Models\Email;
+use SkinTemplate;
+use SpecialPage;
+use Title;
+
+class Hooks {
+
+	/**
+	 * @param DatabaseUpdater $updater
+	 */
+	public static function onLoadExtensionSchemaUpdates( DatabaseUpdater $updater ) {
+		$updater->addExtensionTable( 'inbox_email', dirname( __DIR__ ) . "/sql/inbox.sql" );
+	}
+
+	public static function onAlternateUserMailer( $headers, $to, $from, $subject, $body ) {
+		$email = new Email( $headers, $to, $from, $subject, $body );
+		$email->save();
+	}
+
+	/**
+	 * Handler for PersonalUrls hook.
+	 * Add a "Notifications" item to the user toolbar ('personal URLs').
+	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/PersonalUrls
+	 * @param array &$personal_urls Array of URLs to append to.
+	 * @param Title &$title Title of page being visited.
+	 * @param SkinTemplate $sk
+	 * @return bool true in all cases
+	 */
+	public static function onPersonalUrls( &$personal_urls, &$title, $sk ) {
+		$user = $sk->getUser();
+		if ( $user->isAnon() || !$user->getEmail() ) {
+			return true;
+		}
+
+		$unreadCount = Email::getUnreadCount( $user->getEmail() );
+		$text = 'Inbox';
+		if ( $unreadCount ) {
+			$text .= " ($unreadCount)";
+		}
+		$inboxLink = [
+			'href' => SpecialPage::getTitleFor( 'Inbox' )->getLinkURL(),
+			'text' => $text,
+			'class' => 'tbd',
+		];
+
+		$personal_urls = wfArrayInsertAfter( $personal_urls, [ 'inbox' => $inboxLink ], 'userpage' );
+	}
+}
diff --git a/includes/Models/Email.php b/includes/Models/Email.php
@@ -0,0 +1,80 @@
+<?php
+
+namespace Inbox\Models;
+
+use FormatJson;
+use MediaWiki\MediaWikiServices;
+
+class Email {
+
+	private $headers;
+	private $from;
+	private $subject;
+	private $body;
+	private $timestamp;
+
+	public function __construct( $headers, $to, $from, $subject, $body, $timestamp = null ) {
+		$this->headers = $headers;
+		$this->to = $to[ 0 ]->address;
+		$this->from = $from->address;
+		$this->subject = $subject;
+		$this->body = $body;
+		$this->timestamp = $timestamp ?: wfTimestampNow();
+	}
+
+	public function save() {
+		$dbw = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_MASTER );
+		$dbw->insert(
+			'inbox_email',
+			[
+				'email_headers' => FormatJson::encode( $this->headers ),
+				'email_to' => $this->to,
+				'email_from' => $this->from,
+				'email_subject' => $this->subject,
+				'email_body' => $this->body,
+				'email_timestamp' => $this->timestamp,
+			],
+			__METHOD__
+		);
+	}
+
+	/**
+	 * @param string $emailAddress
+	 * @return int|bool
+	 */
+	public static function getUnreadCount( $emailAddress ) {
+		$dbr = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_REPLICA );
+		return $dbr->selectField(
+			'inbox_email',
+			'COUNT(*)',
+			[
+				'email_to' => $emailAddress,
+				'email_read' => 0,
+			],
+			__METHOD__,
+			[ 'GROUP BY' => 'email_to' ]
+		);
+	}
+
+	public static function getAll( $emailAddress ) {
+		$dbr = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_REPLICA );
+		return $dbr->select(
+			'inbox_email',
+			[ 'email_id', 'email_from', 'email_subject', 'email_timestamp', 'email_read' ],
+			[ 'email_to' => $emailAddress ]
+		);
+	}
+
+	public static function get( $emailAddress, $id ) {
+		$dbr = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_REPLICA );
+		return $dbr->selectRow(
+			'inbox_email',
+			[ 'email_from', 'email_headers', 'email_subject', 'email_body', 'email_timestamp' ],
+			[ 'email_id' => $id, 'email_to' => $emailAddress ]
+		);
+	}
+
+	public static function markRead( $id ) {
+
+	}
+}
diff --git a/includes/Specials/SpecialInbox.php b/includes/Specials/SpecialInbox.php
@@ -0,0 +1,78 @@
+<?php
+
+namespace Inbox\Specials;
+
+use FormatJson;
+use Html;
+use Inbox\Models\Email;
+use Sanitizer;
+use SpecialPage;
+
+class SpecialInbox extends SpecialPage {
+
+	public function __construct() {
+		parent::__construct( 'Inbox' );
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function execute( $par ) {
+		$this->requireLogin();
+		$out = $this->getOutput();
+
+		if ( is_numeric( $par ) ) {
+			$email = Email::get( $this->getUser()->getEmail(), $par );
+			if ( $email ) {
+				$out->setArticleBodyOnly( true );
+				// todo: mark as read
+				$out->addHTML( $email->email_subject );
+				$out->addHTML( '<hr />' );
+				$headers = array_change_key_case( FormatJson::decode( $email->email_headers, true ) );
+				if ( strpos( $headers[ 'content-type' ], 'multipart' ) !== false ) {
+					preg_match( '/boundary=\"(.*?)\"/', $headers[ 'content-type' ], $m );
+					$boundary = $m[1];
+					$parts = explode( '--' . $boundary, $email->email_body );
+					$out->addHTML( '<pre>' . quoted_printable_decode( $parts[1] ) . '</pre>' );
+					$out->addHTML( '<hr />' );
+					$out->addHTML( quoted_printable_decode( $parts[2] ) );
+				} elseif ( strpos( $headers[ 'content-type' ], 'text/plain' ) >= 0 ) {
+					$out->addHTML( '<pre>' . quoted_printable_decode( $email->email_body ) . '</pre>' );
+				} else {
+					$out->addHTML( quoted_printable_decode( $email->email_body ) );
+				}
+			} else {
+				parent::execute( $par );
+				$out->addHTML( 'email not found' );
+			}
+		} else {
+			parent::execute( $par );
+			$emails = Email::getAll( $this->getUser()->getEmail() );
+			if ( $emails ) {
+				$out->addHTML( Html::openElement( 'table' ) );
+
+				foreach ( $emails as $email ) {
+					$out->addHTML( '<tr>' );
+					$out->addHTML( '<td>' . $email->email_timestamp . '</td>' );
+					$out->addHTML( '<td>' . $email->email_from . '</td>' );
+					$out->addHTML(
+						'<td>' .
+						Html::element(
+							'a',
+							[
+								'href' => SpecialPage::getTitleFor( 'Inbox', $email->email_id )->getLinkURL(),
+								'target' => '_blank',
+							],
+							$email->email_subject
+						) .
+						'</td>'
+					);
+					$out->addHTML( '</tr>' );
+				}
+				$out->addHTML( Html::closeElement( 'table' ) );
+			}
+		}
+
+	}
+
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,16 @@
+{
+	"private": true,
+	"scripts": {
+		"test": "grunt test"
+	},
+	"devDependencies": {
+		"eslint-config-wikimedia": "0.9.0",
+		"grunt": "1.0.3",
+		"grunt-eslint": "21.0.0",
+		"grunt-banana-checker": "0.6.0",
+		"grunt-jsonlint": "1.1.0",
+		"grunt-stylelint": "0.10.1",
+		"stylelint": "9.2.0",
+		"stylelint-config-wikimedia": "0.4.3"
+	}
+}
diff --git a/sql/inbox.sql b/sql/inbox.sql

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+/node_modules`
	`2`	`+/vendor`
	`3`	`+/composer.lock`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "extends": "stylelint-config-wikimedia"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+The development of this software is covered by a [Code of Conduct](https://www.mediawiki.org/wiki/Special:MyLanguage/Code_of_Conduct).`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+This is a MediaWiki extension that provides a way to test emails locally.`
	`2`	`+`
	`3`	`+See the wiki page for more information: <https://www.mediawiki.org/wiki/Extension:Inbox>.`