Add functionality to read and parse Moderator Toolbox Usernotes from the wiki page.

Author: CrustyJew

RedditSharp/RedditSharp.csproj

@@ -96,6 +96,9 @@
     <Compile Include="Things\WikiPageRevision.cs" />
     <Compile Include="WikiPageSettings.cs" />
     <Compile Include="Domain.cs" />
+	<Compile Include="tbUserNote.cs" />
+	<Compile Include="ToolBoxUserNotes.cs" />
+    <Compile Include="ToolBoxUserNotesException.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 

RedditSharp/Things/Subreddit.cs

@@ -264,6 +264,14 @@ public IEnumerable<ModeratorUser> Moderators
             }
         }
 
+        public IEnumerable<tbUserNote> UserNotes
+        {
+            get
+            {
+                return ToolBoxUserNotes.GetUserNotes(WebAgent, Name);
+            }
+        }
+
         public Subreddit Init(Reddit reddit, JToken json, IWebAgent webAgent)
         {
             CommonInit(reddit, json, webAgent);

RedditSharp/ToolBoxUserNotes.cs

@@ -0,0 +1,101 @@
+using System;
+using System.Collections.Generic;
+using Newtonsoft.Json.Linq;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using System.IO.Compression;
+
+namespace RedditSharp
+{
+    public static class ToolBoxUserNotes
+    {
+        private const string ToolBoxUserNotesWiki = "/r/{0}/wiki/usernotes";
+        public static IEnumerable<tbUserNote> GetUserNotes( IWebAgent webAgent, string subName)
+        {
+            var request = webAgent.CreateGet(String.Format(ToolBoxUserNotesWiki, subName));
+            var reqResponse = webAgent.ExecuteRequest(request);
+            var response = JObject.Parse(reqResponse["data"]["content_md"].Value<string>());
+
+            int version = response["ver"].Value<int>();
+            string[] mods = response["constants"]["users"].Values<string>().ToArray();
+
+            string[] warnings = response["constants"]["warnings"].Values<string>().ToArray();
+
+            if (version < 6)
+            {
+                throw new ToolBoxUserNotesException("Unsupported ToolBox version");
+            }
+            try {
+                var data = Convert.FromBase64String(response["blob"].Value<string>());
+
+                string uncompressed;
+                using (System.IO.MemoryStream compressedStream = new System.IO.MemoryStream(data))
+                {
+                    compressedStream.ReadByte();
+                    compressedStream.ReadByte(); //skips first to bytes to fix zlib block size
+                    using (DeflateStream blobStream = new DeflateStream(compressedStream, CompressionMode.Decompress))
+                    {
+                        using (var decompressedReader = new System.IO.StreamReader(blobStream))
+                        {
+                            uncompressed = decompressedReader.ReadToEnd();
+                        }
+
+                    }
+                }
+
+                JObject users = JObject.Parse(uncompressed);
+
+                List<tbUserNote> toReturn = new List<tbUserNote>();
+                foreach (KeyValuePair<string, JToken> user in users)
+                {
+                    var x = user.Value;
+                    foreach (JToken note in x["ns"].Children())
+                    {
+
+                        tbUserNote uNote = new tbUserNote();
+                        uNote.AppliesToUsername = user.Key;
+                        uNote.SubName = subName;
+                        uNote.SubmitterIndex = note["m"].Value<int>();
+                        uNote.Submitter = mods[uNote.SubmitterIndex];
+                        uNote.NoteTypeIndex = note["w"].Value<int>();
+                        uNote.NoteType = warnings[uNote.NoteTypeIndex];
+                        uNote.Message = note["n"].Value<string>();
+                        uNote.Timestamp = UnixTimeStamp.UnixTimeStampToDateTime(note["t"].Value<long>());
+                        uNote.Url = UnsquashLink(subName, note["l"].ValueOrDefault<string>());
+
+                        toReturn.Add(uNote);
+                    }
+                }
+                return toReturn;
+            }
+            catch(Exception e)
+            {
+                throw new ToolBoxUserNotesException("An error occured while processing Usernotes wiki. See inner exception for details", e);
+            }
+            
+        }
+        public static string UnsquashLink(string subreddit,string permalink)
+        {
+
+            var link = "https://reddit.com/r/" + subreddit + "/";
+            if (string.IsNullOrEmpty(permalink)) {
+                return link;
+            }
+            var linkParams = permalink.Split(',');
+
+            if (linkParams[0] == "l")
+            {
+                link += "comments/" + linkParams[1] + "/";
+                if (linkParams.Length > 2)
+                    link += "-/" + linkParams[2] + "/";
+            }
+            else if (linkParams[0] == "m")
+            {
+                link += "message/messages/" + linkParams[1];
+            }
+
+            return link;
+        }
+    }
+}

RedditSharp/ToolBoxUserNotesException.cs

@@ -0,0 +1,25 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace RedditSharp
+{
+    class ToolBoxUserNotesException : Exception
+    {
+        public ToolBoxUserNotesException()
+        {
+        }
+
+        public ToolBoxUserNotesException(string message)
+            : base(message)
+        {
+        }
+
+        public ToolBoxUserNotesException(string message, Exception inner)
+            : base(message, inner)
+        {
+        }
+    }
+}

RedditSharp/tbUserNote.cs

@@ -0,0 +1,29 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace RedditSharp
+{
+    public class tbUserNote
+    {
+        public int NoteTypeIndex { get; set; }
+        public string NoteType { get; set; }
+        public string SubName { get; set; }
+        public string Submitter { get; set; }
+        public int SubmitterIndex { get; set; }
+        public string Message { get; set; }
+        public string AppliesToUsername { get; set; }
+        public string Url { get; set; }
+        private DateTime _timestamp;
+        public DateTime Timestamp
+        {
+            get { return _timestamp; }
+            set
+            {
+                _timestamp = DateTime.SpecifyKind(value, DateTimeKind.Utc);
+            }
+        }
+    }
+}