/* * Greenshot - a free and open source screenshot tool * Copyright (C) 2007-2012 Thomas Braun, Jens Klingen, Robin Krom * * For more information see: http://getgreenshot.org/ * The Greenshot project is hosted on Sourceforge: http://sourceforge.net/projects/greenshot/ * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ using System; using System.Collections.Generic; using System.Drawing; using System.IO; using System.Net; using System.Net.Security; using System.Security.Cryptography.X509Certificates; using System.Text; using System.Text.RegularExpressions; using Greenshot.IniFile; using Greenshot.Plugin; namespace GreenshotPlugin.Core { /// /// Description of NetworkHelper. /// public static class NetworkHelper { private static readonly log4net.ILog LOG = log4net.LogManager.GetLogger(typeof(NetworkHelper)); private static CoreConfiguration config = IniConfig.GetIniSection(); static NetworkHelper() { // Disable certificate checking System.Net.ServicePointManager.ServerCertificateValidationCallback += delegate(object sender, X509Certificate cert, X509Chain chain, SslPolicyErrors sslError) { bool validationResult = true; return validationResult; }; } /// /// Download a url response as string /// /// An Uri to specify the download location /// string with the file content public static string GetAsString(Uri url) { HttpWebRequest webRequest = (HttpWebRequest)NetworkHelper.CreateWebRequest(url); webRequest.Method = "GET"; webRequest.KeepAlive = true; webRequest.Credentials = System.Net.CredentialCache.DefaultCredentials; return GetResponse(webRequest); } /// /// Download the FavIcon as a Bitmap /// /// /// Bitmap with the FavIcon public static Bitmap DownloadFavIcon(Uri baseUri) { Uri url = new Uri(baseUri, new Uri("favicon.ico")); try { HttpWebRequest request = (HttpWebRequest)NetworkHelper.CreateWebRequest(url); HttpWebResponse response = (HttpWebResponse)request.GetResponse(); if (request.HaveResponse) { using (Image image = Image.FromStream(response.GetResponseStream())) { return (image.Height > 16 && image.Width > 16) ? new Bitmap(image, 16, 16) : new Bitmap(image); } } } catch (Exception e) { LOG.Error("Problem downloading the FavIcon from: " + baseUri.ToString(), e); } return null; } /// /// Helper method to create a web request, eventually with proxy /// /// string with uri to connect to /// WebRequest public static WebRequest CreateWebRequest(string uri) { return CreateWebRequest(new Uri(uri)); } /// /// Helper method to create a web request, eventually with proxy /// /// Uri with uri to connect to /// WebRequest public static WebRequest CreateWebRequest(Uri uri) { WebRequest webRequest = WebRequest.Create(uri); if (config.UseProxy) { webRequest.Proxy = GreenshotPlugin.Core.NetworkHelper.CreateProxy(uri); //webRequest.Proxy.Credentials = CredentialCache.DefaultCredentials; } return webRequest; } /// /// Create a IWebProxy Object which can be used to access the Internet /// This method will check the configuration if the proxy is allowed to be used. /// Usages can be found in the DownloadFavIcon or Jira and Confluence plugins /// /// /// IWebProxy filled with all the proxy details or null if none is set/wanted public static IWebProxy CreateProxy(Uri uri) { IWebProxy proxyToUse = null; if (config.UseProxy) { proxyToUse = WebRequest.DefaultWebProxy; if (proxyToUse != null) { proxyToUse.Credentials = CredentialCache.DefaultCredentials; if (LOG.IsDebugEnabled) { // check the proxy for the Uri if (!proxyToUse.IsBypassed(uri)) { Uri proxyUri = proxyToUse.GetProxy(uri); if (proxyUri != null) { LOG.Debug("Using proxy: " + proxyUri.ToString() + " for " + uri.ToString()); } else { LOG.Debug("No proxy found!"); } } else { LOG.Debug("Proxy bypass for: " + uri.ToString()); } } } else { LOG.Debug("No proxy found!"); } } return proxyToUse; } /// /// UrlEncodes a string without the requirement for System.Web /// /// /// // [Obsolete("Use System.Uri.EscapeDataString instead")] public static string UrlEncode(string text) { if (!string.IsNullOrEmpty(text)) { // Sytem.Uri provides reliable parsing, but doesn't encode spaces. return System.Uri.EscapeDataString(text).Replace("%20", "+"); } return null; } /// /// A wrapper around the EscapeDataString, as the limit is 32766 characters /// See: http://msdn.microsoft.com/en-us/library/system.uri.escapedatastring%28v=vs.110%29.aspx /// /// /// escaped data string public static string EscapeDataString(string text) { if (!string.IsNullOrEmpty(text)) { StringBuilder result = new StringBuilder(); int currentLocation = 0; while (currentLocation < text.Length) { string process = text.Substring(currentLocation, Math.Min(16384, text.Length - currentLocation)); result.Append(Uri.EscapeDataString(process)); currentLocation = currentLocation + 16384; } return result.ToString(); } return null; } /// /// UrlDecodes a string without requiring System.Web /// /// String to decode. /// decoded string public static string UrlDecode(string text) { // pre-process for + sign space formatting since System.Uri doesn't handle it // plus literals are encoded as %2b normally so this should be safe text = text.Replace("+", " "); return System.Uri.UnescapeDataString(text); } /// /// ParseQueryString without the requirement for System.Web /// /// /// Dictionary public static IDictionary ParseQueryString(string s) { IDictionary parameters = new SortedDictionary(); // remove anything other than query string from url if (s.Contains("?")) { s = s.Substring(s.IndexOf('?') + 1); } foreach (string vp in Regex.Split(s, "&")) { if (string.IsNullOrEmpty(vp)) { continue; } string[] singlePair = Regex.Split(vp, "="); if (parameters.ContainsKey(singlePair[0])) { parameters.Remove(singlePair[0]); } if (singlePair.Length == 2) { parameters.Add(singlePair[0], singlePair[1]); } else { // only one key with no value specified in query string parameters.Add(singlePair[0], string.Empty); } } return parameters; } /// /// Generate the query paramters /// /// the list of query parameters /// a string with the query parameters public static string GenerateQueryParameters(IDictionary queryParameters) { if (queryParameters == null || queryParameters.Count == 0) { return string.Empty; } queryParameters = new SortedDictionary(queryParameters); StringBuilder sb = new StringBuilder(); foreach(string key in queryParameters.Keys) { sb.AppendFormat(System.Globalization.CultureInfo.InvariantCulture, "{0}={1}&", key, UrlEncode(string.Format("{0}",queryParameters[key]))); } sb.Remove(sb.Length-1,1); return sb.ToString(); } /// /// Write Multipart Form Data directly to the HttpWebRequest response stream /// /// HttpWebRequest to write the multipart form data to /// Parameters to include in the multipart form data public static void WriteMultipartFormData(HttpWebRequest webRequest, IDictionary postParameters) { string boundary = String.Format("----------{0:N}", Guid.NewGuid()); webRequest.ContentType = "multipart/form-data; boundary=" + boundary; bool needsCLRF = false; using (Stream formDataStream = webRequest.GetRequestStream()) { foreach (var param in postParameters) { // Thanks to feedback from commenters, add a CRLF to allow multiple parameters to be added. // Skip it on the first parameter, add it to subsequent parameters. if (needsCLRF) { formDataStream.Write(Encoding.UTF8.GetBytes("\r\n"), 0, Encoding.UTF8.GetByteCount("\r\n")); } needsCLRF = true; if (param.Value is IBinaryContainer) { IBinaryContainer binaryParameter = (IBinaryContainer)param.Value; binaryParameter.WriteFormDataToStream(boundary, param.Key, formDataStream); } else { string postData = string.Format("--{0}\r\nContent-Disposition: form-data; name=\"{1}\"\r\n\r\n{2}", boundary, param.Key, param.Value); formDataStream.Write(Encoding.UTF8.GetBytes(postData), 0, Encoding.UTF8.GetByteCount(postData)); } } // Add the end of the request. Start with a newline string footer = "\r\n--" + boundary + "--\r\n"; formDataStream.Write(Encoding.UTF8.GetBytes(footer), 0, Encoding.UTF8.GetByteCount(footer)); } } /// /// Process the web response. /// /// The request object. /// The response data. public static string GetResponse(HttpWebRequest webRequest) { string responseData; try { HttpWebResponse response = (HttpWebResponse)webRequest.GetResponse(); using (StreamReader reader = new StreamReader(response.GetResponseStream(), true)) { responseData = reader.ReadToEnd(); } LOG.DebugFormat("Response status: {0}", response.StatusCode); } catch (WebException e) { HttpWebResponse response = (HttpWebResponse)e.Response; using (Stream responseStream = response.GetResponseStream()) { LOG.ErrorFormat("HTTP error {0} with content: {1}", response.StatusCode, new StreamReader(responseStream, true).ReadToEnd()); } throw e; } return responseData; } } /// /// This interface can be used to pass binary information around, like byte[] or Image /// public interface IBinaryContainer { void WriteFormDataToStream(string boundary, string key, Stream formDataStream); void WriteToStream(Stream formDataStream); string ToBase64String(Base64FormattingOptions formattingOptions); byte[] ToByteArray(); void Upload(HttpWebRequest webRequest); } /// /// A container to supply files to a Multi-part form data upload /// public class FileContainer : IBinaryContainer { private byte[] file; private string fileName; private string contentType; private int fileSize; public FileContainer(byte[] file) : this(file, null) { } public FileContainer(byte[] file, string filename) : this(file, filename, null) { } public FileContainer(byte[] file, string filename, string contenttype) : this(file, filename, contenttype, 0) { } public FileContainer(byte[] file, string filename, string contenttype, int filesize) { this.file = file; this.fileName = filename; this.contentType = contenttype; if (filesize == 0) { this.fileSize = file.Length; } else { this.fileSize = filesize; } } /// /// Create a Base64String from the byte[] /// /// string public string ToBase64String(Base64FormattingOptions formattingOptions) { return System.Convert.ToBase64String(file, 0, fileSize, formattingOptions); } /// /// Returns the initial byte-array which was supplied when creating the FileParameter /// /// byte[] public byte[] ToByteArray() { return file; } /// /// Write Multipart Form Data directly to the HttpWebRequest response stream /// /// HttpWebRequest to write the multipart form data to /// Parameters to include in the multipart form data public void WriteFormDataToStream(string boundary, string key, Stream formDataStream) { // Add just the first part of this param, since we will write the file data directly to the Stream string header = string.Format("--{0}\r\nContent-Disposition: form-data; name=\"{1}\"; filename=\"{2}\";\r\nContent-Type: {3}\r\n\r\n", boundary, key, fileName ?? key, contentType ?? "application/octet-stream"); formDataStream.Write(Encoding.UTF8.GetBytes(header), 0, Encoding.UTF8.GetByteCount(header)); // Write the file data directly to the Stream, rather than serializing it to a string. formDataStream.Write(file, 0, fileSize); } /// /// A plain "write data to stream" /// /// public void WriteToStream(Stream dataStream) { // Write the file data directly to the Stream, rather than serializing it to a string. dataStream.Write(file, 0, fileSize); } /// /// Upload the file to the webrequest /// /// public void Upload(HttpWebRequest webRequest) { webRequest.ContentType = contentType; webRequest.ContentLength = fileSize; using (var requestStream = webRequest.GetRequestStream()) { WriteToStream(requestStream); } } } /// /// A container to supply images to a Multi-part form data upload /// public class ImageContainer : IBinaryContainer { private Image image; private OutputSettings outputSettings; private string fileName; public ImageContainer(Image image, OutputSettings outputSettings, string filename) { this.image = image; this.outputSettings = outputSettings; this.fileName = filename; } /// /// Create a Base64String from the image by saving it to a memory stream and converting it. /// Should be avoided if possible, as this uses a lot of memory. /// /// string public string ToBase64String(Base64FormattingOptions formattingOptions) { using (MemoryStream stream = new MemoryStream()) { ImageOutput.SaveToStream(image, stream, outputSettings); return System.Convert.ToBase64String(stream.GetBuffer(), 0, (int)stream.Length, formattingOptions); } } /// /// Create a byte[] from the image by saving it to a memory stream. /// Should be avoided if possible, as this uses a lot of memory. /// /// byte[] public byte[] ToByteArray() { using (MemoryStream stream = new MemoryStream()) { ImageOutput.SaveToStream(image, stream, outputSettings); return stream.ToArray(); } } /// /// Write Multipart Form Data directly to the HttpWebRequest response stream /// /// HttpWebRequest to write the multipart form data to /// Parameters to include in the multipart form data public void WriteFormDataToStream(string boundary, string key, Stream formDataStream) { // Add just the first part of this param, since we will write the file data directly to the Stream string header = string.Format("--{0}\r\nContent-Disposition: form-data; name=\"{1}\"; filename=\"{2}\";\r\nContent-Type: {3}\r\n\r\n", boundary, key, fileName ?? key, "image/" + outputSettings.Format.ToString()); formDataStream.Write(Encoding.UTF8.GetBytes(header), 0, Encoding.UTF8.GetByteCount(header)); ImageOutput.SaveToStream(image, formDataStream, outputSettings); } /// /// A plain "write data to stream" /// /// public void WriteToStream(Stream dataStream) { // Write the file data directly to the Stream, rather than serializing it to a string. ImageOutput.SaveToStream(image, dataStream, outputSettings); } /// /// Upload the image to the webrequest /// /// public void Upload(HttpWebRequest webRequest) { webRequest.ContentType = "image/" + outputSettings.Format.ToString(); using (var requestStream = webRequest.GetRequestStream()) { WriteToStream(requestStream); } } } }