Added Background and BackgroundVerticalOffset to Mod. Added more XML comments. Added LICENSE and README files.
[KerbalStuffWrapper.git] / KerbalStuff / KerbalStuff.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
// 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 KerbalStuff : KerbalStuffReadOnly
        {
 
                /// <summary>
                /// The cookies returned by KerbalStuff after a Login request, and assigned to successive Create and Update
                /// requests.
                /// </summary>
                public static CookieCollection Cookies
                {
                        get;
                        protected set;
                }
 
                /// <summary>
                /// <para>Performs a Login request to KerbalStuff with the given username and password, returning a Dictionary of
                /// deserialized JSON objects received from KerbalStuff after the request, or null if an error occurs.</para>
                /// <para>Sets <see cref="KerbalStuff.KerbalStuff.Cookies"/> on success.</para>
                /// </summary>
                /// <param name="username">A valid KerbalStuff username, exact and case-sensitive.</param>
                /// <param name="password">A valid KerbalStuff password associated with the username, exact and case-sensitive.</param>
                public static Dictionary<string, object> Login(string username, string password)
                {
                        string uri = KerbalStuffAction.Login.UriFormat;
 
                        Dictionary<string, object> postParams = new Dictionary<string, object>();
                        postParams.Add("username", username);
                        postParams.Add("password", password);
 
                        ExecutePostRequest(uri, postParams, null);
 
                        if (currentResponse.Cookies.Count > 0)
                        {
                                Cookies = currentResponse.Cookies;
                        }
 
                        if (currentJson != null && currentJson is Dictionary<string, object>)
                        {
                                return currentJson as Dictionary<string, object>;
                        }
 
                        return null;
                }
 
                /// <summary>
                /// <para>Performs a creation request to KerbalStuff, creating a new mod described by the given
                /// <see cref="KerbalStuff.Mod"/> object and uploading the file with the given name and path.</para>
                /// <para>Returns a Dictionary of deserialized JSON objects received from KerbalStuff after the request, or null
                /// if an error occurs.</para>
                /// </summary>
                /// <param name="mod">The Mod to be created on KerbalStuff</param>
                /// <param name="fileName">The name of the file to be uploaded</param>
                /// <param name="filePath">The program-relative path of the file to be uploaded</param>
                public static Dictionary<string, object> Create(Mod mod, string fileName, string filePath)
                {
                        if (mod == null)
                        {
                                throw new ArgumentNullException("KerbalStuffWrapper.Create: mod argument cannot be null.");
                        }
                        else
                        {
                                if (mod.Name == string.Empty)
                                        throw new ArgumentException("mod.name cannot be empty.");
                                if (mod.License == string.Empty)
                                        throw new ArgumentException("mod.license cannot be empty.");
                                if (mod.ShortDescription == string.Empty)
                                        throw new ArgumentException("mod.short_description cannot be empty.");
                                if (mod.Versions.Count < 1)
                                        throw new ArgumentException("mod must have a single version to create.");
                                else if (mod.Versions[0] == null)
                                {
                                        throw new ArgumentNullException("mod.versions[0] cannot be null.");
                                }
                                else
                                {
                                        if (mod.Versions[0].FriendlyVersion == string.Empty)
                                                throw new ArgumentException("mod.versions[0].friendly_version cannot be empty.");
                                        if (mod.Versions[0].KspVersion == string.Empty)
                                                throw new ArgumentException("mod.versions[0].ksp_version cannot be empty.");
                                }
                        }
 
                        if (Cookies == null)
                        {
                                throw new Exception("KerbalStuffWrapper.Create: Must log in first.");
                        }
 
                        if (!File.Exists(filePath))
                        {
                                throw new IOException(string.Format("KerbalStuffWrapper.Create: File '{0}' does not exist.", filePath));
                        }
 
                        Dictionary<string, object> postParams = new Dictionary<string, object>();
                        postParams.Add("name", mod.Name);
                        postParams.Add("short-description", mod.ShortDescription);
                        postParams.Add("license", mod.License);
                        postParams.Add("version", mod.Versions[0].FriendlyVersion);
                        postParams.Add("ksp-version", mod.Versions[0].KspVersion);
                        postParams.Add("zipball", ReadZipballParameter(fileName, filePath));
 
                        ExecutePostRequest(KerbalStuffAction.Create.UriFormat, postParams, Cookies);
 
                        if (currentJson != null && currentJson is Dictionary<string, object>)
                        {
                                var rval = currentJson as Dictionary<string, object>;
 
                                if (rval.ContainsKey("reason"))
                                {
                                        rval["message"] = rval["reason"];
                                }
 
                                return rval;
                        }
 
                        return null;
                }
 
                /// <summary>
                /// <para>Performs and Update request to KerbalStuff, uploading a new version described in the given
                /// <see cref="KerbalStuff.ModVersion"/> of the mod with the given Id, uploading the file with the given name
                /// and path.  KerbalStuff will notify followers of the mod if requested.</para>
                /// <para>Returns a Dictionary of deserialized JSON objects received from KerbalStuff after the request, or null
                /// if an error occurs.</para>
                /// </summary>
                /// <param name="modId">The Id of Mod to be updated on KerbalStuff.</param>
                /// <param name="version">The ModVersion to be added to the Mod.</param>
                /// <param name="notifyFollowers">If set to <c>true</c> KerbalStuff will notify followers of the mod.</param>
                /// <param name="fileName">The name of the file to be uploaded</param>
                /// <param name="filePath">The program-relative path of the file to be uploaded</param>
                public static Dictionary<string, object> Update(long modId, ModVersion version, bool notifyFollowers, string fileName, string filePath)
                {
                        if (version == null)
                        {
                                throw new ArgumentNullException("KerbalStuffWrapper.Update: version cannot be null");
                        }
                        if (version.FriendlyVersion == string.Empty)
                                throw new ArgumentException("KerbalStuffWrapper.Update: version.friendly_version cannot be empty");
                        if (version.KspVersion == string.Empty)
                                throw new ArgumentException("KerbalStuffWrapper.Update: version.ksp_version cannot be empty");
 
                        if (Cookies == null)
                        {
                                throw new Exception("KerbalStuffWrapper.Update: Must log in first.");
                        }
 
                        if (!File.Exists(filePath))
                        {
                                throw new IOException(string.Format("KerbalStuffWrapper.Update: File '{0}' does not exist.", filePath));
                        }
 
                        string uri = string.Format(KerbalStuffAction.Update.UriFormat, modId);
 
                        Dictionary<string, object> postParams = new Dictionary<string, object>();
                        postParams.Add("version", version.FriendlyVersion);
                        postParams.Add("ksp-version", version.KspVersion);
 
                        if (version.ChangeLog != null && version.ChangeLog != string.Empty)
                        {
                                postParams.Add("changelog", version.ChangeLog);
                        }
 
                        postParams.Add("notify-followers", notifyFollowers ? "yes" : "no");
 
                        postParams.Add("zipball", ReadZipballParameter(fileName, filePath));
 
                        ExecutePostRequest(uri, postParams, Cookies);
 
                        if (currentJson != null && currentJson is Dictionary<string, object>)
                        {
                                return currentJson as Dictionary<string, object>;
                        }
 
                        return null;
                }
 
                protected static void ExecutePostRequest(string uri, Dictionary<string, object> postParams, CookieCollection cookieCollection = null)
                {
                        currentJson = null;
                        currentRequest = null;
                        currentResponse = null;
 
                        CookieContainer jar = new CookieContainer();
 
                        if (cookieCollection != null)
                        {
                                jar.Add(cookieCollection);
                        }
 
                        try
                        {
                                currentResponse = FormUpload.MultipartFormDataPost(
                                        uri,
                                        "KerbalStuffWrapper by toadicus",
                                        postParams,
                                        jar
                                );
                        }
                        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 static FormUpload.FileParameter ReadZipballParameter(string fileName, string filePath)
                {
                        using (FileStream file = File.OpenRead(filePath))
                        {
                                byte[] buffer = new byte[1 << 16];
                                int bytesRead;
 
                                MemoryStream stream = new MemoryStream();
 
                                while ((bytesRead = file.Read(buffer, 0, buffer.Length)) > 0)
                                {
                                        stream.Write(buffer, 0, bytesRead);
                                }
 
                                stream.Seek(0, SeekOrigin.Begin);
 
                                byte[] fileBytes = new byte[stream.Length];
 
                                bytesRead = stream.Read(fileBytes, 0, (int)stream.Length);
 
                                return new FormUpload.FileParameter(fileBytes, fileName, "application/zip");
                        }
                }
 
                protected KerbalStuff() {}
        }
}