Major version update

Deprecated old fashion, use a more reasonable approach instead

Author: nbdd0121

Avatar_body.php

@@ -3,9 +3,14 @@
 
 class Avatars {
 
-	public static function getLinkFor($username) {
+	public static function getLinkFor($username, $res = false) {
 		global $wgScriptPath;
-		return "$wgScriptPath/extensions/Avatar/avatar.php?$username";
+		$path = "$wgScriptPath/extensions/Avatar/avatar.php?user=$username";
+		if ($res !== false) {
+			return $path . '&res=' . $res;
+		} else {
+			return $path;
+		}
 	}
 
 	public static function normalizeResolution($res) {

README.md

@@ -1,27 +1,42 @@
-# Avatar
+# Avatar 1.0.0
 Yet another avatar architecture for MediaWiki
 
+**Note.** There are API changes when upgrading 0.9.2 to 1.0.0. The change is very likely to break your site. See section below for details.
+
 ## Install
 * Install php-gd, which is a dependency of this extension
 * Clone the respository, rename it to Avatar and copy to extensions folder
-* Add wfLoadExtension('Avatar'); to your LocalSettings.php
+* Add `wfLoadExtension('Avatar')`; to your LocalSettings.php
 * You are done!
 
 ## Configuration
-* $wgDefaultAvatar (string), should be set to the URL of the default avatar.
-* $wgAllowedAvatarRes (array), default value is array(64, 128). Thumbnails will be created upon request when their size is in this list.
-* $wgMaxAvatarResolution (integer), default value is 256. This limits maximum resolution of image to be uploaded.
-* $wgDefaultAvatarRes (integer), default value is 128. This is the fallback option if resolution is not specified.
+* `$wgDefaultAvatar` (string), should be set to the URL of the default avatar.
+* `$wgAllowedAvatarRes` (array), default value is array(64, 128). Thumbnails will be created upon request when their size is in this list.
+* `$wgMaxAvatarResolution` (integer), default value is 256. This limits maximum resolution of image to be uploaded.
+* `$wgDefaultAvatarRes` (integer), default value is 128. This is the fallback option if resolution is not specified.
 * You can set user rights: 
-	* avatarupload: User need this right to upload ones' own avatar.
-	* avataradmin: User need this right to delete others' avatars.
+	* `avatarupload`: User need this right to upload ones' own avatar.
+	* `avataradmin`: User need this right to delete others' avatars.
 
 ## How to use
-* Set avatar in user preference, and then $wgScriptPath/extensions/Avatar/avatar.php?username will be redirected to your avatar.
+* Set avatar in user preference, and then `$wgScriptPath/extensions/Avatar/avatar.php?user=username` will be redirected to your avatar.
 * You can set alias for this php to make it shorter.
+ 
+## Detailed API
+* Uploading Avatar: No API provided yet, but one can post to `Special:UploadAvatar` (or its localized equivalent). The only form data required is `avatar`, which should be set to the data uri of the image.
+* Displaying Avatar: This extension provides an entry point for MediaWiki `avatar.php`. This entry point produces result via a 302 redirect. This approach is used to maximize performance while still utilizing MediaWiki core. There are currently 4 available arguments.
+    * `user` set to the user of who you want to enquery the avatar
+    * `res` the preferred resolution of the avatar. Note that this is only a hint and the actual result might not be of the resolution. This parameter is valid only if `user` is set.
+    * `ver` a version number which will be appended to the location field of redirection. Can be used to circumvent browser/CDN cache.
+    * `nocache` if this parameter is set, then no `cache-control` header will be emitted.
 
 ## Extra resources
 * If you are using Gadgets
     * If you want to display the avatar on the top-right navigation bar, you may find Gadget-ShowAvatar in example folder useful.
     * If you want to display avatars before user link, you may find Gadget-UserLinkAvatar in example folder useful.
 
+## Upgrading from <1.0.0 to 1.0.0
+* `wgScriptPath/extensions/Avatar/avatar.php?username` was changed to `wgScriptPath/extensions/Avatar/avatar.php?user=username`
+* `wgScriptPath/extensions/Avatar/avatar.php?username/resolution` was changed to `wgScriptPath/extensions/Avatar/avatar.php?user=username&res=resolution`
+* The change affects all Gadgets and depending extensions.
+* Upgrading is easy: changing all occurrence of above url to the new fashion.

SpecialView.php

@@ -58,7 +58,7 @@ public function execute($par) {
 
 			if ($haveAvatar) {
 				$html = \Xml::tags('img', array(
-					'src' => Avatars::getLinkFor($user) . '/original',
+					'src' => Avatars::getLinkFor($user, 'original'),
 					'height' => 400,
 				), '');
 				$html = \Xml::tags('p', array(), $html);

assets/upload.js

@@ -17,7 +17,7 @@ var startY;
 
 // Objects
 var submitButton = $('[type=submit]');
-var currentAvatar = $('<div>').append($('<img class="current-avatar">').attr('src', mw.config.get('wgScriptPath') + '/extensions/Avatar/avatar.php?' + mw.user.id() + '/original'));
+var currentAvatar = $('<div>').append($('<img class="current-avatar">').attr('src', mw.config.get('wgScriptPath') + '/extensions/Avatar/avatar.php?user=' + mw.user.id() + '&res=original&nocache&ver=' + Math.floor(Date.now()/1000).toString(16)));
 var container = $('<div class="cropper-container" disabled=""/>');
 var imageObj = $('<img src=""></img>');
 var selector = $('<div class="cropper"><div class="tl-resizer"/><div class="tr-resizer"/><div class="bl-resizer"/><div class="br-resizer"/><div class="round-preview"/></div>');

avatar.php

@@ -14,34 +14,49 @@
 	return;
 }
 
-// Parse request
-$par = urldecode($wgRequest->getRawQueryString());
+$query = $wgRequest->getQueryValues();
 
-global $wgDefaultAvatar, $wgDefaultAvatarRes;
+global $wgDefaultAvatar;
 $path = $wgDefaultAvatar;
 
-if ($par) {
-	// Parse parts
-	$parts = explode('/', $par, 2);
-	$username = $parts[0];
-	$res = count($parts) === 2 ? \Avatar\Avatars::normalizeResolution($parts[1]) : $wgDefaultAvatarRes;
+if (isset($query['user'])) {
+	$username = $query['user'];
+
+	if (isset($query['res'])) {
+		$res = \Avatar\Avatars::normalizeResolution($query['res']);
+	} else {
+		global $wgDefaultAvatarRes;
+		$res = $wgDefaultAvatarRes;
+	}
+
 	$user = User::newFromName($username);
 	if ($user) {
 		$path = \Avatar\Avatars::getAvatar($user, $res);
 	}
 }
 
+// ver will be propagated to the relocated image
+if (isset($query['ver'])) {
+	if (strpos($path, '?') !== false) {
+		$path .= '&ver=' . $query['ver'];
+	} else {
+		$path .= '?ver=' . $query['ver'];
+	}
+}
+
 $response = $wgRequest->response();
 
 // We use send custom header, in order to control cache
 $response->statusHeader('302');
 
-// Cache longer time if it is not the default avatar
-// As it is unlikely to be deleted
-if ($path === $wgDefaultAvatar) {
-	$response->header('Cache-Control: public, max-age=3600');
-} else {
-	$response->header('Cache-Control: public, max-age=86400');
+if (!isset($query['nocache'])) {
+	// Cache longer time if it is not the default avatar
+	// As it is unlikely to be deleted
+	if ($path === $wgDefaultAvatar) {
+		$response->header('Cache-Control: public, max-age=3600');
+	} else {
+		$response->header('Cache-Control: public, max-age=86400');
+	}
 }
 
 $response->header('Location: ' . $path);

example/Gadget-ShowAvatar.js

@@ -1,3 +1,3 @@
-var img = $('<img>').attr('src', mw.config.get('wgScriptPath') + '/extensions/Avatar/avatar.php?' + mw.user.id());
+var img = $('<img>').attr('src', mw.config.get('wgScriptPath') + '/extensions/Avatar/avatar.php?user=' + mw.user.id());
 var link = $('<a>').attr('href', mw.util.getUrl('Special:UploadAvatar')).append(img);
 $('#pt-userpage').before($('<li id="pt-avatar"></li>').append(link));

example/Gadget-UserLinkAvatar.js

@@ -1,4 +1,4 @@
 $('.mw-userlink').each(function(_, item) {
 	item = $(item);
-	item.prepend($('<img/>').addClass('userlink-avatar').attr('src', mw.config.get('wgScriptPath') + '/extensions/Avatar/avatar.php?' + item.text()));
+	item.prepend($('<img/>').addClass('userlink-avatar').attr('src', mw.config.get('wgScriptPath') + '/extensions/Avatar/avatar.php?user=' + item.text()));
 });

extension.json

@@ -3,7 +3,7 @@
 	"author": "Gary Guo",
 	"url": "https://github.com/nbdd0121/MW-Avatar",
 	"descriptionmsg": "avatar_desc",
-	"version": "0.9.2",
+	"version": "1.0.0",
 	"license-name": "BSD-2-Clause",
 	"type": "specialpage",
 	"ExtensionMessagesFiles": {