Moved some code around, for better re-usage. Also added some debug information, and wrote some comments. [skip ci]

GreenshotImgurPlugin/ImgurUtils.cs

@@ -31,14 +31,14 @@ namespace GreenshotImgurPlugin {
 	/// <summary>
 	/// Description of ImgurUtils.
 	/// </summary>
-	public class ImgurUtils {
+	public static class ImgurUtils {
 		private static readonly log4net.ILog LOG = log4net.LogManager.GetLogger(typeof(ImgurUtils));
 		private const string IMGUR_ANONYMOUS_API_KEY = "8116a978913f3cf5dfc8e1117a055056";
 		private static ImgurConfiguration config = IniConfig.GetIniSection<ImgurConfiguration>();
 
-		private ImgurUtils() {
+		/// <summary>
-		}
+		/// Load the complete history of the imgur uploads, with the corresponding information
-
+		/// </summary>
 		public static void LoadHistory() {
 			if (config.runtimeImgurHistory.Count == config.ImgurUploadHistory.Count) {
 				return;
@@ -90,6 +90,14 @@ namespace GreenshotImgurPlugin {
 			}
 		}
 
+		/// <summary>
+		/// Use this to make sure Imgur knows from where the upload comes.
+		/// </summary>
+		/// <param name="webRequest"></param>
+		private static void SetClientId(HttpWebRequest webRequest) {
+			webRequest.Headers.Add("Authorization", "Client-ID " + ImgurCredentials.CONSUMER_KEY);
+		}
+
 		/// <summary>
 		/// Do the actual upload to Imgur
 		/// For more details on the available parameters, see: http://api.imgur.com/resources_anon
@@ -118,6 +126,8 @@ namespace GreenshotImgurPlugin {
 				webRequest.Method = "POST";
 				webRequest.ContentType = "image/" + outputSettings.Format.ToString();
 				webRequest.ServicePoint.Expect100Continue = false;
+
+				SetClientId(webRequest);
 				try {
 					using (var requestStream = webRequest.GetRequestStream()) {
 						ImageOutput.SaveToStream(surfaceToUpload, requestStream, outputSettings);
@@ -127,7 +137,7 @@ namespace GreenshotImgurPlugin {
 						using (StreamReader reader = new StreamReader(response.GetResponseStream(), true)) {
 							responseString = reader.ReadToEnd();
 						}
-						LogCredits(response);
+						LogRateLimitInfo(response);
 					}
 				} catch (Exception ex) {
 					LOG.Error("Upload to imgur gave an exeption: ", ex);
@@ -174,6 +184,10 @@ namespace GreenshotImgurPlugin {
 			return ImgurInfo.ParseResponse(responseString);
 		}
 
+		/// <summary>
+		/// Retrieve the thumbnail of an imgur image
+		/// </summary>
+		/// <param name="imgurInfo"></param>
 		public static void RetrieveImgurThumbnail(ImgurInfo imgurInfo) {
 			if (imgurInfo.SmallSquare == null) {
 				LOG.Warn("Imgur URL was null, not retrieving thumbnail.");
@@ -183,25 +197,32 @@ namespace GreenshotImgurPlugin {
 			HttpWebRequest webRequest = (HttpWebRequest)NetworkHelper.CreateWebRequest(imgurInfo.SmallSquare);
 			webRequest.Method = "GET";
 			webRequest.ServicePoint.Expect100Continue = false;
-
+			SetClientId(webRequest);
 			using (WebResponse response = webRequest.GetResponse()) {
-				LogCredits(response);
+				LogRateLimitInfo(response);
 				Stream responseStream = response.GetResponseStream();
 				imgurInfo.Image = Image.FromStream(responseStream);
 			}
 			return;
 		}
 
+		/// <summary>
+		/// Retrieve information on an imgur image
+		/// </summary>
+		/// <param name="hash"></param>
+		/// <param name="deleteHash"></param>
+		/// <returns>ImgurInfo</returns>
 		public static ImgurInfo RetrieveImgurInfo(string hash, string deleteHash) {
 			string url = config.ImgurApiUrl + "/image/" + hash;
 			LOG.InfoFormat("Retrieving Imgur info for {0} with url {1}", hash, url);
 			HttpWebRequest webRequest = (HttpWebRequest)NetworkHelper.CreateWebRequest(url);
 			webRequest.Method = "GET";
 			webRequest.ServicePoint.Expect100Continue = false;
+			SetClientId(webRequest);
 			string responseString;
 			try {
 				using (WebResponse response = webRequest.GetResponse()) {
-					LogCredits(response);
+					LogRateLimitInfo(response);
 					using (StreamReader reader = new StreamReader(response.GetResponseStream(), true)) {
 						responseString = reader.ReadToEnd();
 					}
@@ -220,6 +241,10 @@ namespace GreenshotImgurPlugin {
 			return imgurInfo;
 		}
 
+		/// <summary>
+		/// Delete an imgur image, this is done by specifying the delete hash
+		/// </summary>
+		/// <param name="imgurInfo"></param>
 		public static void DeleteImgurImage(ImgurInfo imgurInfo) {
 			LOG.InfoFormat("Deleting Imgur image for {0}", imgurInfo.DeleteHash);
 			
@@ -230,10 +255,10 @@ namespace GreenshotImgurPlugin {
 				//webRequest.Method = "DELETE";
 				webRequest.Method = "GET";
 				webRequest.ServicePoint.Expect100Continue = false;
-	
+				SetClientId(webRequest);
 				string responseString;
 				using (WebResponse response = webRequest.GetResponse()) {
-					LogCredits(response);
+					LogRateLimitInfo(response);
 					using (StreamReader reader = new StreamReader(response.GetResponseStream(), true)) {
 						responseString = reader.ReadToEnd();
 					}
@@ -253,16 +278,41 @@ namespace GreenshotImgurPlugin {
 			imgurInfo.Image = null;
 		}
 
-		private static void LogCredits(WebResponse response) {
+		/// <summary>
-			try {
+		/// Helper for logging
-				int credits = 0;
+		/// </summary>
-				if (int.TryParse(response.Headers["X-RateLimit-Remaining"], out credits)) {
+		/// <param name="nameValues"></param>
-					config.Credits = credits;
+		/// <param name="key"></param>
-				}
+		private static void LogHeader(IDictionary<string, string> nameValues, string key) {
-				LOG.InfoFormat("X-RateLimit-Limit={0}", response.Headers["X-RateLimit-Limit"]);
+			if (nameValues.ContainsKey(key)) {
-				LOG.InfoFormat("X-RateLimit-Remaining={0}", response.Headers["X-RateLimit-Remaining"]);
+				LOG.InfoFormat("key={0}", nameValues[key]);
+			}
+		}
 
-			} catch {}
+		/// <summary>
+		/// Log the current rate-limit information
+		/// </summary>
+		/// <param name="response"></param>
+		private static void LogRateLimitInfo(WebResponse response) {
+			IDictionary<string, string> nameValues = new Dictionary<string, string>();
+			foreach (string key in response.Headers.AllKeys) {
+				if (!nameValues.ContainsKey(key)) {
+					nameValues.Add(key, response.Headers[key]);
+				}
+			}
+			LogHeader(nameValues, "X-RateLimit-Limit");
+			LogHeader(nameValues, "X-RateLimit-Remaining");
+			LogHeader(nameValues, "X-RateLimit-UserLimit");
+			LogHeader(nameValues, "X-RateLimit-UserRemaining");
+			LogHeader(nameValues, "X-RateLimit-UserReset");
+			LogHeader(nameValues, "X-RateLimit-ClientLimit");
+			LogHeader(nameValues, "X-RateLimit-ClientRemaining");
+
+			// Update the credits in the config, this is shown in a form
+			int credits = 0;
+			if (int.TryParse(nameValues["X-RateLimit-Remaining"], out credits)) {
+				config.Credits = credits;
+			}
 		}
 	}
 }

GreenshotPicasaPlugin/PicasaUtils.cs

@@ -17,14 +17,13 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-using System;
+
-using System.Collections.Generic;
-using System.Drawing;
-using System.Xml;
 using Greenshot.IniFile;
 using Greenshot.Plugin;
 using GreenshotPlugin.Core;
+using System;
 using System.Net;
+using System.Xml;
 
 namespace GreenshotPicasaPlugin {
 	/// <summary>
@@ -38,98 +37,6 @@ namespace GreenshotPicasaPlugin {
 		private const string TokenUrl = "https://www.googleapis.com/oauth2/v3/token";
 		private const string UploadUrl = "https://picasaweb.google.com/data/feed/api/user/{0}/albumid/{1}";
 
-		/// <summary>
-		/// Authenticate by using the LocalServerCodeReceiver
-		/// If this works, generate a token
-		/// </summary>
-		/// <param name="settings"></param>
-		private static void Authenticate(OAuth2Settings settings) {
-			var codeReceiver = new LocalServerCodeReceiver();
-			IDictionary<string, string> result = codeReceiver.ReceiveCode(settings);
-
-			string code;
-			if (result.TryGetValue("code", out code)) {
-				GenerateToken(code, settings);
-			}
-			string error;
-			if (result.TryGetValue("error", out error)) {
-				if ("access_denied" == error) {
-					throw new UnauthorizedAccessException("Access denied");
-				} else {
-					throw new Exception(error);
-				}
-			}
-		}
-
-		/// <summary>
-		/// Upload parameters by post
-		/// </summary>
-		/// <param name="url"></param>
-		/// <param name="parameters"></param>
-		/// <returns>response</returns>
-		public static string HttpPost(string url, IDictionary<string, object> parameters, OAuth2Settings settings) {
-			var webRequest = (HttpWebRequest)NetworkHelper.CreateWebRequest(url);
-			webRequest.Method = "POST";
-			webRequest.KeepAlive = true;
-			webRequest.Credentials = CredentialCache.DefaultCredentials;
-
-			if (!string.IsNullOrEmpty(settings.AccessToken)) {
-				webRequest.Headers.Add("Authorization", "Bearer " + settings.AccessToken);
-			}
-			return NetworkHelper.UploadFormUrlEncoded(webRequest, parameters);
-		}
-
-		private static void GenerateToken(string code, OAuth2Settings settings) {
-			// Use the returned code to get a refresh code
-			IDictionary<string, object> data = new Dictionary<string, object>();
-			data.Add("code", code);
-			data.Add("client_id", settings.ClientId);
-			data.Add("redirect_uri", settings.RedirectUrl);
-			data.Add("client_secret", settings.ClientSecret);
-			data.Add("grant_type", "authorization_code");
-
-			var accessTokenJsonResult = HttpPost(settings.FormattedTokenUrl, data, settings);
-			IDictionary<string, object> refreshTokenResult = JSONHelper.JsonDecode(accessTokenJsonResult);
-			// gives as described here: https://developers.google.com/identity/protocols/OAuth2InstalledApp
-			//  "access_token":"1/fFAGRNJru1FTz70BzhT3Zg",
-			//	"expires_in":3920,
-			//	"token_type":"Bearer",
-			//	"refresh_token":"1/xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
-			settings.AccessToken = (string)refreshTokenResult["access_token"] as string;
-			settings.RefreshToken = (string)refreshTokenResult["refresh_token"] as string;
-
-			object seconds = refreshTokenResult["expires_in"];
-			if (seconds != null) {
-				settings.AccessTokenExpires = DateTimeOffset.Now.AddSeconds((double)seconds);
-			}
-		}
-
-		/// <summary>
-		/// Go out and retrieve a new access token via refresh-token with the TokenUrl in the settings
-		/// Will upate the access token, refresh token, expire date
-		/// </summary>
-		/// <param name="settings"></param>
-		private static void GenerateAccessToken(OAuth2Settings settings) {
-			IDictionary<string, object> data = new Dictionary<string, object>();
-			data.Add("refresh_token", settings.RefreshToken);
-			data.Add("client_id", settings.ClientId);
-			data.Add("client_secret", settings.ClientSecret);
-			data.Add("grant_type", "refresh_token");
-
-			var accessTokenJsonResult = HttpPost(settings.FormattedTokenUrl, data, settings);
-			// gives as described here: https://developers.google.com/identity/protocols/OAuth2InstalledApp
-			//  "access_token":"1/fFAGRNJru1FTz70BzhT3Zg",
-			//	"expires_in":3920,
-			//	"token_type":"Bearer",
-
-			IDictionary<string, object> accessTokenResult = JSONHelper.JsonDecode(accessTokenJsonResult);
-			settings.AccessToken = (string)accessTokenResult["access_token"] as string;
-			object seconds = accessTokenResult["expires_in"];
-			if (seconds != null) {
-				settings.AccessTokenExpires = DateTimeOffset.Now.AddSeconds((double)seconds);
-			}
-		}
-
 		/// <summary>
 		/// Do the actual upload to Picasa
 		/// </summary>
@@ -148,7 +55,7 @@ namespace GreenshotPicasaPlugin {
 			settings.ClientId = PicasaCredentials.ClientId;
 			settings.ClientSecret = PicasaCredentials.ClientSecret;
 
-			// Copy the settings from the config, which is kept in memory
+			// Copy the settings from the config, which is kept in memory and on the disk
 			settings.RefreshToken = Config.RefreshToken;
 			settings.AccessToken = Config.AccessToken;
 			settings.AccessTokenExpires = Config.AccessTokenExpires;
@@ -156,18 +63,18 @@ namespace GreenshotPicasaPlugin {
 			try {
 				// Get Refresh / Access token
 				if (string.IsNullOrEmpty(settings.RefreshToken)) {
-					Authenticate(settings);
+					OAuth2Helper.AuthenticateViaLocalServer(settings);
 				} 
 
 				if (settings.IsAccessTokenExpired) {
-					GenerateAccessToken(settings);
+					OAuth2Helper.GenerateAccessToken(settings);
 				}
 
 				var webRequest = (HttpWebRequest)NetworkHelper.CreateWebRequest(string.Format(UploadUrl, Config.UploadUser, Config.UploadAlbum));
 				webRequest.Method = "POST";
 				webRequest.KeepAlive = true;
 				webRequest.Credentials = CredentialCache.DefaultCredentials;
-				webRequest.Headers.Add("Authorization", "Bearer " + settings.AccessToken);
+				OAuth2Helper.AddOAuth2Credentials(webRequest, settings);
 				if (Config.AddFilename) {
 					webRequest.Headers.Add("Slug", NetworkHelper.EscapeDataString(filename));
 				}
@@ -178,7 +85,7 @@ namespace GreenshotPicasaPlugin {
 
 				return ParseResponse(response);
 			} finally {
-				// Copy the settings back to the config
+				// Copy the settings back to the config, so they are stored.
 				Config.RefreshToken = settings.RefreshToken;
 				Config.AccessToken = settings.AccessToken;
 				Config.AccessTokenExpires = settings.AccessTokenExpires;

GreenshotPlugin/Core/NetworkHelper.cs

@@ -336,6 +336,20 @@ namespace GreenshotPlugin.Core {
 			return GetResponse(webRequest);
 		}
 
+		/// <summary>
+		/// Log the headers of the WebResponse, if IsDebugEnabled
+		/// </summary>
+		/// <param name="response">WebResponse</param>
+		private static void DebugHeaders(WebResponse response) {
+			if (!LOG.IsDebugEnabled) {
+				return;
+			}
+			LOG.DebugFormat("Debug information on the response from {0} :", response.ResponseUri);
+			foreach (string key in response.Headers.AllKeys) {
+				LOG.DebugFormat("Reponse-header: {0}={1}", key, response.Headers[key]);
+			}
+		}
+
 		/// <summary>
 		/// Process the web response.
 		/// </summary>
@@ -348,6 +362,7 @@ namespace GreenshotPlugin.Core {
 				HttpWebResponse response = (HttpWebResponse) webRequest.GetResponse();
 				LOG.InfoFormat("Response status: {0}", response.StatusCode);
 				bool isHttpError = (int) response.StatusCode >= 300;
+				DebugHeaders(response);
 				Stream responseStream = response.GetResponseStream();
 				if (responseStream != null) {
 					using (StreamReader reader = new StreamReader(responseStream, true)) {

GreenshotPlugin/Core/OAuthHelper.cs

@@ -999,50 +999,114 @@ Greenshot received verification code. You can close this browser / tab if it is
 	}
 
 	/// <summary>
-	/// Class to hold all the Properties for the OAuth 2 Token request
+	/// Code to simplify OAuth 2
 	/// </summary>
-	public class OAuth2TokenRequest {
+	public static class OAuth2Helper {
-		public string Code {
+		/// <summary>
-			get;
+		/// Upload parameters by post
-			set;
+		/// </summary>
-		}
+		/// <param name="url"></param>
-		public string ClientId {
+		/// <param name="parameters">Form-Url-Parameters</param>
-			get;
+		/// <param name="settings">OAuth2Settings</param>
-			set;
+		/// <returns>response</returns>
-		}
+		public static string HttpPost(string url, IDictionary<string, object> parameters, OAuth2Settings settings) {
-		public string ClientSecret {
+			HttpWebRequest webRequest = (HttpWebRequest)NetworkHelper.CreateWebRequest(url);
-			get;
+			webRequest.Method = "POST";
-			set;
+			webRequest.KeepAlive = true;
-		}
+			webRequest.Credentials = CredentialCache.DefaultCredentials;
-		public string RedirectUri {
-			get;
-			set;
-		}
-		public string GrantType {
-			get;
-			set;
-		}
-	}
 
-	/// <summary>
+			AddOAuth2Credentials(webRequest, settings);
-	/// Class to hold all the Properties for the OAuth 2 Token response
+			return NetworkHelper.UploadFormUrlEncoded(webRequest, parameters);
-	/// </summary>
-	public class OAuth2TokenResponse {
-		public string AccessToken {
-			get;
-			set;
 		}
-		public string ExpiresIn {
+
-			get;
+		/// <summary>
-			set;
+		/// Generate an OAuth 2 Token by using the supplied code
+		/// </summary>
+		/// <param name="code">Code to get the RefreshToken</param>
+		/// <param name="settings">OAuth2Settings to update with the information that was retrieved</param>
+		public static void GenerateRefreshToken(string code, OAuth2Settings settings) {
+			// Use the returned code to get a refresh code
+			IDictionary<string, object> data = new Dictionary<string, object>();
+			data.Add("code", code);
+			data.Add("client_id", settings.ClientId);
+			data.Add("redirect_uri", settings.RedirectUrl);
+			data.Add("client_secret", settings.ClientSecret);
+			data.Add("grant_type", "authorization_code");
+
+			string accessTokenJsonResult = HttpPost(settings.FormattedTokenUrl, data, settings);
+			IDictionary<string, object> refreshTokenResult = JSONHelper.JsonDecode(accessTokenJsonResult);
+			// gives as described here: https://developers.google.com/identity/protocols/OAuth2InstalledApp
+			//  "access_token":"1/fFAGRNJru1FTz70BzhT3Zg",
+			//	"expires_in":3920,
+			//	"token_type":"Bearer",
+			//	"refresh_token":"1/xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
+			settings.AccessToken = (string)refreshTokenResult["access_token"] as string;
+			settings.RefreshToken = (string)refreshTokenResult["refresh_token"] as string;
+
+			object seconds = refreshTokenResult["expires_in"];
+			if (seconds != null) {
+				settings.AccessTokenExpires = DateTimeOffset.Now.AddSeconds((double)seconds);
+			}
 		}
-		public string TokenType {
+
-			get;
+		/// <summary>
-			set;
+		/// Go out and retrieve a new access token via refresh-token with the TokenUrl in the settings
+		/// Will upate the access token, refresh token, expire date
+		/// </summary>
+		/// <param name="settings"></param>
+		public static void GenerateAccessToken(OAuth2Settings settings) {
+			IDictionary<string, object> data = new Dictionary<string, object>();
+			data.Add("refresh_token", settings.RefreshToken);
+			data.Add("client_id", settings.ClientId);
+			data.Add("client_secret", settings.ClientSecret);
+			data.Add("grant_type", "refresh_token");
+
+			string accessTokenJsonResult = HttpPost(settings.FormattedTokenUrl, data, settings);
+			// gives as described here: https://developers.google.com/identity/protocols/OAuth2InstalledApp
+			//  "access_token":"1/fFAGRNJru1FTz70BzhT3Zg",
+			//	"expires_in":3920,
+			//	"token_type":"Bearer",
+
+			IDictionary<string, object> accessTokenResult = JSONHelper.JsonDecode(accessTokenJsonResult);
+			settings.AccessToken = (string)accessTokenResult["access_token"] as string;
+			object seconds = accessTokenResult["expires_in"];
+			if (seconds != null) {
+				settings.AccessTokenExpires = DateTimeOffset.Now.AddSeconds((double)seconds);
+			}
 		}
-		public string RefreshToken {
+
-			get;
+		/// <summary>
-			set;
+		/// Authenticate via a local server by using the LocalServerCodeReceiver
+		/// If this works, immediately generate a refresh token afterwards, otherwise this throws an exception
+		/// </summary>
+		/// <param name="settings">OAuth2Settings with the Auth / Token url etc</param>
+		public static void AuthenticateViaLocalServer(OAuth2Settings settings) {
+			var codeReceiver = new LocalServerCodeReceiver();
+			IDictionary<string, string> result = codeReceiver.ReceiveCode(settings);
+
+			string code;
+			if (result.TryGetValue("code", out code)) {
+				GenerateRefreshToken(code, settings);
+			}
+			string error;
+			if (result.TryGetValue("error", out error)) {
+				if ("access_denied" == error) {
+					throw new UnauthorizedAccessException("Access denied");
+				} else {
+					throw new Exception(error);
+				}
+			}
+		}
+
+		/// <summary>
+		/// Simple helper to add the Authorization Bearer header
+		/// </summary>
+		/// <param name="webRequest">WebRequest</param>
+		/// <param name="settings">OAuth2Settings</param>
+		public static void AddOAuth2Credentials(HttpWebRequest webRequest, OAuth2Settings settings) {
+			if (!string.IsNullOrEmpty(settings.AccessToken)) {
+				webRequest.Headers.Add("Authorization", "Bearer " + settings.AccessToken);
+			}
 		}
 	}
 }