Added Background and BackgroundVerticalOffset to Mod. Added more XML comments. Added LICENSE and README files.
[KerbalStuffWrapper.git] / KerbalStuffReadOnly / KerbalStuffReadOnly.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
// KerbalStuffWrapper
//
// Author:
//      toadicus
//
// Copyright © 2014, toadicus
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
//      * Redistributions of source code must retain the above copyright notice, this list of conditions and the
//        following disclaimer.
//      * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
//        following disclaimer in the documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// This software uses the CLAP .NET Command-Line Parser, Copyright © 2011 Adrian Aisemberg, SharpRegion.
// Used under license.
//
// This software uses the MiniJSON .NET JSON Parser, Copyright © 2013 Calvin Rien.  Used under license.
//
// This software uses the FormUpload multipart/form-data library,
// http://www.briangrinstead.com/blog/multipart-form-post-in-c.
//
 
using MiniJSON;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Text;
 
namespace KerbalStuff
{
        public class KerbalStuffReadOnly
        {
                /// <summary>
                /// The root URI of the KerbalStuff website, including protocol.
                /// </summary>
                public const string RootUri = "https://kerbalstuff.com";
 
                /// <summary>
                /// The URI of the KerbalStuff API, relative to the KerbalStuff root.
                /// </summary>
                /// <seealso cref="KerbalStuffReadOnly.RootUri"/>
                public const string APIUri = RootUri + "/api";
 
                private const string UserAgent = "KerbalStuffWrapper by toadicus";
 
                /// <summary>
                /// The response received from KerbalStuff after the current request.  Reset to null at the beginning of each
                /// new request.
                /// </summary>
                public static HttpWebResponse currentResponse
                {
                        get;
                        protected set;
                }
 
                /// <summary>
                /// The List or Dictionary of deserialized JSON objects received from KerbalStuff after the current request.
                /// Reset to null at the beginning of each new request.
                /// </summary>
                /// <value>The current json.</value>
                public static object currentJson
                {
                        get;
                        protected set;
                }
 
                /// <summary>
                /// Queries KerbalStuff for the mod with the given Id, returning a <see cref="KerbalStuff.Mod"/> object,
                /// or null if an error occured.
                /// </summary>
                /// <param name="modId">The Id of Mod to be queried on KerbalStuff.</param>
                public static Mod ModInfo(long modId)
                {
                        string uri = string.Format(KerbalStuffAction.ModInfo.UriFormat, modId);
 
                        ExecuteGetRequest(uri, KerbalStuffAction.ModInfo.RequestMethod);
 
                        Mod mod = null;
 
                        if (currentJson != null && currentJson is Dictionary<string, object>)
                        {
                                mod = new Mod(currentJson as Dictionary<string, object>);
                        }
 
                        return mod;
                }
 
                /// <summary>
                /// Queries KerbalStuff for the latest version of the mod with then given Id, returning a
                /// <see cref="KerbalStuff.ModVersion"/> object, or null if an error occured.
                /// </summary>
                /// <param name="modId">The Id of the Mod to be queried on KerbalStuff.</param>
                public static ModVersion ModLatest(long modId)
                {
                        string uri = string.Format(KerbalStuffAction.ModLatest.UriFormat, modId);
 
                        ExecuteGetRequest(uri, KerbalStuffAction.ModLatest.RequestMethod);
 
                        ModVersion ver = null;
 
                        if (currentJson != null && currentJson is Dictionary<string, object>)
                        {
                                ver = new ModVersion(currentJson as Dictionary<string, object>);
                        }
 
                        return ver;
                }
 
                /// <summary>
                /// Searches KerbalStuff for a mod containing the given query string, returning a List of
                /// <see cref="KerbalStuff.Mod"/> objects, or an empty List if none are found or an error occurs.
                /// </summary>
                /// <param name="query">The search query</param>
                public static List<Mod> ModSearch(string query)
                {
                        string uri = string.Format(KerbalStuffAction.ModSearch.UriFormat, query);
 
                        ExecuteGetRequest(uri, KerbalStuffAction.ModSearch.RequestMethod);
 
                        List<Mod> rList = new List<Mod>();
 
                        if (currentJson != null && currentJson is List<object>)
                        {
                                foreach (var modObj in (currentJson as List<object>))
                                {
                                        if (modObj is Dictionary<string, object>)
                                        {
                                                rList.Add(new Mod(modObj as Dictionary<string, object>));
                                        }
                                }
                        }
 
                        return rList;
                }
 
                /// <summary>
                /// Queries KerbalStuff for a user with the given username, returning a <see cref="KerbalStuff.User"/> object,
                /// or null if an error occurs.
                /// </summary>
                /// <param name="username">The exact, case-sensitive username to query.</param>
                public static User UserInfo(string username)
                {
                        ExecuteGetRequest(KerbalStuffAction.UserInfo, false, username);
 
 
                        User user = null;
 
                        if (currentJson != null && currentJson is Dictionary<string, object>)
                        {
                                user = new User(currentJson);
                        }
 
                        return user;
                }
 
                /// <summary>
                /// Searches KerbalStuff for a user containing the query string, returning a List of
                /// <see cref="KerbalStuff.User"/> objects, or an empty List if none are found or an error occurs.
                /// </summary>
                /// <returns>The search.</returns>
                /// <param name="query">Query.</param>
                public static List<User> UserSearch(string query)
                {
                        ExecuteGetRequest(KerbalStuffAction.UserSearch, false, query);
 
                        List<User> users = new List<User>();
 
                        if (currentJson != null && currentJson is List<object>)
                        {
                                foreach (object userObj in (currentJson as List<object>))
                                {
                                        users.Add(new User(userObj));
                                }
                        }
 
                        return users;
                }
 
                protected static HttpWebRequest currentRequest;
 
                protected static void ExecuteGetRequest(KerbalStuffAction action, bool assignCookies, params object[] formatArgs)
                {
                        string uri = string.Format(action.UriFormat, formatArgs);
 
                        ExecuteGetRequest(uri, action.RequestMethod);
                }
 
                protected static void ExecuteGetRequest(string uri, string method)
                {
                        currentJson = null;
                        currentRequest = null;
                        currentResponse = null;
 
                        if (uri == string.Empty)
                        {
                                throw new ArgumentOutOfRangeException("KerbalStuffWrapper.ExecuteRequest: uri must not be empty.");
                        }
 
                        uri = Uri.EscapeUriString(uri);
 
                        method = method.ToUpper();
 
                        if (method != "POST" && method != "GET")
                        {
                                throw new ArgumentOutOfRangeException("KerbalStuffWrapper.ExecuteRequest: method must be POST or GET.");
                        }
 
                        currentRequest = (HttpWebRequest)WebRequest.Create(uri);
                        currentRequest.Method = method;
 
                        try
                        {
                                currentResponse = currentRequest.GetResponse() as HttpWebResponse;
                        }
                        catch (WebException ex)
                        {
                                currentResponse = ex.Response as HttpWebResponse;
                        }
 
                        if (currentResponse.ContentType == "application/json")
                        {
                                var responseReader = new StreamReader(currentResponse.GetResponseStream());
 
                                string json = responseReader.ReadToEnd();
 
                                currentJson = Json.Deserialize(json);
                        }
                }
 
                protected KerbalStuffReadOnly() {}
        }
 
        public struct KerbalStuffAction
        {
                public static readonly KerbalStuffAction Create = new KerbalStuffAction("create", "/mod/create", "POST");
                public static readonly KerbalStuffAction Login = new KerbalStuffAction("login", "/login", "POST");
                public static readonly KerbalStuffAction ModInfo = new KerbalStuffAction("modinfo", "/mod/{0:d}", "GET");
                public static readonly KerbalStuffAction ModLatest = new KerbalStuffAction(
                        "modlatest",
                        "/mod/{0:d}/latest",
                        "GET"
                );
                public static readonly KerbalStuffAction ModSearch = new KerbalStuffAction(
                        "modsearch",
                        "/search/mod?query={0}",
                        "GET"
                );
                public static readonly KerbalStuffAction Update = new KerbalStuffAction("update", "/mod/{0:d}/update", "POST");
                public static readonly KerbalStuffAction UserInfo = new KerbalStuffAction("userinfo", "/user/{0}", "GET");
                public static readonly KerbalStuffAction UserSearch = new KerbalStuffAction(
                        "usersearch",
                        "/search/user?query={0}",
                        "GET"
                );
 
                public string Action;
 
                public string UriPathFormat;
 
                public string RequestMethod;
 
                public string UriFormat
                {
                        get
                        {
                                return string.Format("{0}{1}", KerbalStuffReadOnly.APIUri, this.UriPathFormat);
                        }
                }
 
                public KerbalStuffAction(string action, string uriFormat, string requestMethod) : this()
                {
                        this.Action = action;
                        this.UriPathFormat = uriFormat;
                        this.RequestMethod = requestMethod;
                }
        }
}