Fixing issue #1

.gitignore

@@ -35,3 +35,4 @@
 ehthumbs.db
 Thumbs.db
 *~
+netbeans/

plugin.php

@@ -5,8 +5,8 @@
 if (!defined("IN_ESOTALK")) exit;
 
 ET::$pluginInfo["Gravatar"] = array(
-	"name" => "Gravatar",
-	"description" => "Allows users to choose to use their Gravatar.",
+	"name" => T("Gravatar"),
+	"description" => T("Allows users to choose to use their Gravatar."),
 	"version" => ESOTALK_VERSION,
 	"author" => "Toby Zerner",
 	"authorEmail" => "[email protected]",
@@ -33,24 +33,106 @@ function init()
 		function avatar($member = array(), $className = "")
 		{
 			$default = C("plugin.Gravatar.default") ? C("plugin.Gravatar.default") : "mm";
-
+			$forceGravatar = C("plugin.Gravatar.forceGravatar") ? C("plugin.Gravatar.forceGravatar") : 0;
+			$useGravatar = isset($member["preferences"]["gravatar.useGravatar"]) ? $member["preferences"]["gravatar.useGravatar"] : 0;
 			$protocol = C("esoTalk.https") ? "https" : "http";
-			$url = "$protocol://www.gravatar.com/avatar/".md5(strtolower(trim($member["email"])))."?d=".urlencode($default)."&s=64";
-
-			return "<img src='$url' alt='' class='avatar $className'/>";
+
+			if ($useGravatar || $forceGravatar || empty($member["avatarFormat"])) {
+				$url = "$protocol://www.gravatar.com/avatar/".md5(strtolower(trim($member["email"])))."?d=".urlencode($default)."&s=64";
+				return "<img src='$url' alt='' class='avatar $className'/>";
+			} else {
+				// Construct the avatar path from the provided information.
+				if (!empty($member["memberId"]) and !empty($member["avatarFormat"])) {
+					$url = ETPlugin_Gravatar::getUploadedAvatarSrc($member["memberId"], $member["avatarFormat"]);
+					return "<img src='$url' alt='' class='avatar $className'/>";
+				}
+				// Default to an avatar with the first letter of the member's name.
+				return "<span class='avatar $className'>".(!empty($member["username"]) ? mb_strtoupper(mb_substr($member["username"], 0, 1, "UTF-8"), "UTF-8") : "&nbsp;")."</span>";
+			}
 		}
 	}
+
+	/**
+	 * Initializes the settings controller
+	 * 
+	 * @param type $controller
+	 */
+	public function handler_settingsController_init($controller) {
+		$controller->addJSFile( $this->resource("gravatar.js") );
+	}
 
-	// Change the avatar field on the settings page.
-	function handler_settingsController_initGeneral($sender, $form)
+	/**
+	 * Adds Gravatar option to preferences page, possibly removes the avatar
+	 * upload field.
+	 * 
+	 * @param type $sender
+	 * @param ETForm $form The form object.
+	 */
+	public function handler_settingsController_initGeneral($sender, $form)
 	{
-		$form->removeField("avatar", "avatar");
-		$form->addField("avatar", "avatar", array($this, "fieldAvatar"));
+		$forceGravatar = C("plugin.Gravatar.forceGravatar") ? C("plugin.Gravatar.forceGravatar") : 0;
+
+		if ($forceGravatar == 1 ) {
+			// Don't confuse members with the default avatar when they can't
+			// do anything with it anyway.
+			$form->removeField("avatar", "avatar");
+		} else {
+			$form->setValue("useGravatar", ET::$session->preference("gravatar.useGravatar"));
+			$form->addField("avatar", "useGravatar", array($this, "fieldUseGravatar"), array($this, "saveGravatarPreference"));						
+		}
+
+		$form->addField("avatar", "gravatarLink", array($this, "fieldGravatar"));
 	}
 
-	function fieldAvatar($form)
+	/**
+	 * Generates a link (and accompanying text) pointing to gravatar.com
+	 * 
+	 * @param ETForm $form The form object.
+	 * @return string
+	 */
+	public function fieldGravatar($form)
 	{
-		return sprintf(T("Change your avatar on %s."), "<a href='http://gravatar.com' target='_blank'>Gravatar.com</a>");
+		return "<div class='gravatarLink' id='gravatarLink'>".
+			sprintf(T("Change your avatar on %s."), "<a href='http://gravatar.com' target='_blank'>Gravatar.com</a>") .
+		"</div>";
+	}
+
+	/**
+	 * Generates a checkbox for Gravatar preference.
+	 * 
+	 * @param ETForm $form The form object.
+	 * @return string
+	 */
+	public function fieldUseGravatar($form)
+	{
+		// We fetch the URL of the user-defined avatar here. This is then used
+		// in gravatar.js to display the original image when a member unchecks
+		// the "Use Gravatar..." option. Because it was damn confusing when it
+		// showed the Gravatar. "Wait, do I need to re-upload my picture?"
+		$user = ET::$session->user;
+		$avatarFormat = isset($user["avatarFormat"]) ? $user["avatarFormat"] : "";
+		$memberId = isset($user["memberId"]) ? $user["memberId"] : "";
+		$dataAttr = ($avatarFormat && $memberId) ? self::getUploadedAvatarSrc($memberId, $avatarFormat) : "" ;
+
+		return "<label class='checkbox'>" .
+		        $form->checkbox("useGravatar", array("id" => "gravatarToggle", "data-gravatar-orig" => $dataAttr))." ".
+		        T("Use Gravatar instead of your own image")."</label> " .
+			      "<div class='gravatarNotice'><small>(" .
+			      T("Note: This setting has no effect if you haven't uploaded your own image.") .
+		        ")</small></div>";
+	}
+
+	/**
+	 * Saves the user's preference of using Gravatar or an image of their own.
+	 * Couldn't get the saveBoolPreference() method to work so added this.
+	 * 
+	 * @param ETForm $form The form object.
+	 * @param string $key The name of the field that was submitted.
+	 * @param array $preferences An array of preferences to write to the database.
+	 * @return void
+	 */
+	public function saveGravatarPreference($form, $key, &$preferences) {
+		$preferences['gravatar.useGravatar'] = (bool)$form->getValue($key);
 	}
 
 	/**
@@ -66,13 +148,15 @@ public function settings($sender)
 		$form = ETFactory::make("form");
 		$form->action = URL("admin/plugins/settings/Gravatar");
 		$form->setValue("default", C("plugin.Gravatar.default", "mm"));
+		$form->setValue("forceGravatar", C("plugin.Gravatar.forceGravatar", 0));
 
 		// If the form was submitted...
 		if ($form->validPostBack("save")) {
 
 			// Construct an array of config options to write.
 			$config = array();
 			$config["plugin.Gravatar.default"] = $form->getValue("default");
+			$config["plugin.Gravatar.forceGravatar"] = $form->getValue("forceGravatar");
 
 			if (!$form->errorCount()) {
 
@@ -88,5 +172,18 @@ public function settings($sender)
 		$sender->data("gravatarSettingsForm", $form);
 		return $this->view("settings");
 	}
-
+
+	/**
+	 * Generates the URL of an avatar image for given member ID and avatar
+	 * format.
+	 * 
+	 * @param integer $memberId    The ID of current member
+	 * @param string $avatarFormat The avatar image format of current member
+	 * @return string              URL to the avatar image of current member
+	 */
+	public static function getUploadedAvatarSrc($memberId, $avatarFormat) {
+		return getWebPath("uploads/avatars/$memberId.$avatarFormat");
+	}
+
+
 }

resources/gravatar.js

@@ -0,0 +1,24 @@
+;(function( $, window, document, undefined ) {
+	"use strict";
+	$(function(){
+		var $cbox = $("#gravatarToggle");
+		var toggleAvatar = function(el){
+			if ($(el).prop("checked")) {
+				$(".avatarChooser").hide();
+				$("#gravatarLink").show();
+			} else {
+				if ($(el).data("gravatar-orig")) {
+					$(".avatarChooser img.avatar").attr("src", $(el).data("gravatar-orig"));
+				}
+				$(".avatarChooser").show();
+				$("#gravatarLink").hide();
+			}
+		};
+		if ($cbox.length > 0) {
+			$cbox.on("click", function(){
+				toggleAvatar(this);
+			});
+			toggleAvatar($cbox);
+		}
+	});
+}( jQuery, window, document, undefined ));

views/settings.php

@@ -21,6 +21,10 @@
 #gravatarDefaults img {
 	display:block;
 }
+
+#gravatarForce label {
+	width: auto;
+}
 </style>
 
 <?php echo $form->open(); ?>
@@ -39,7 +43,9 @@
 	<label class='radio'><?php echo $form->radio("default", "retro"); ?> <img src='http://www.gravatar.com/avatar/0?d=retro' class='avatar'> Retro</label>
 </div>
 </li>
-
+<li id="gravatarForce">
+	<label class="checkbox"><?php echo $form->checkbox("forceGravatar"); ?> <?php echo T("Force all members to use Gravatar"); ?></label>
+</li>
 </ul>
 
 </div>