ampapi 0.1.6

An API that allows you to communicate with AMP installations from within Rust
Documentation
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
use crate::{AMPAPI, types::LoginResult};

mod ads_module;
use ads_module::ADSModule;
use serde_json::Value;

mod core;
use core::Core;
use std::{collections::HashMap, io::Error};

mod email_sender_plugin;
use email_sender_plugin::EmailSenderPlugin;

mod file_manager_plugin;
use file_manager_plugin::FileManagerPlugin;

mod local_file_backup_plugin;
use local_file_backup_plugin::LocalFileBackupPlugin;

mod minecraft_module;
use minecraft_module::MinecraftModule;

mod generic_module;

mod rcon_plugin;
use rcon_plugin::RCONPlugin;

mod steamcmd_plugin;
use steamcmd_plugin::steamcmdplugin;


/// struct CommonAPI
/// Author: p0t4t0sandwich
#[derive(Debug, Clone)]
#[allow(non_snake_case, dead_code)]
pub struct CommonAPI {
    ampapi: AMPAPI,
    pub Core: Core,
    pub EmailSenderPlugin: EmailSenderPlugin,
    pub FileManagerPlugin: FileManagerPlugin,
    pub LocalFileBackupPlugin: LocalFileBackupPlugin,
}

/// impl From<Module> for CommonAPI
/// Author: p0t4t0sandwich
impl From<Module> for CommonAPI {
    fn from(module: Module) -> Self {
        match module {
            Module::CommonAPI(common_api) => common_api,
            _ => panic!("Cannot convert from {:?} to CommonAPI", module)
        }
    }
}

/// impl CommonAPI
/// Author: p0t4t0sandwich
#[allow(non_snake_case, dead_code)]
impl CommonAPI {
    //noinspection DuplicatedCode
    //noinspection DuplicatedCode
    /// CommonAPI.new - Create a new CommonAPI struct
    /// Author: p0t4t0sandwich
    /// * `base_uri` - The base URI of the AMP instance
    /// * `username` - The username to use for authentication
    /// * `password` - The password to use for authentication
    ///   * Optional if using a remember me token
    /// * `remember_me_token` - The remember me token to use for authentication
    ///   * Optional
    /// * `session_id` - The session ID to use for authentication
    ///   * Optional, will be instantiated on login
    /// Returns CommonAPI
    pub fn new(base_uri: String, username: String, password: String, remember_me_token: String, session_id: String) -> CommonAPI {
        let ampapi = AMPAPI::new(base_uri, username, password, remember_me_token, session_id);

        let mut commonAPI = CommonAPI {
            ampapi: ampapi.clone(),
            Core: Core::new(ampapi.clone()),
            EmailSenderPlugin: EmailSenderPlugin::new(ampapi.clone()),
            FileManagerPlugin: FileManagerPlugin::new(ampapi.clone()),
            LocalFileBackupPlugin: LocalFileBackupPlugin::new(ampapi.clone()),
        };

        if !commonAPI.ampapi.username.is_empty()
            && (!commonAPI.ampapi.password.is_empty() || !commonAPI.ampapi.remember_me_token.is_empty())
        {
            let _ = commonAPI.login();
        }

        commonAPI
    }

    /// CommonAPI.login - Simplified login function
    /// Author: p0t4t0sandwich
    /// Returns Result<LoginResult, reqwest::Error>
    pub fn login(&mut self) -> Result<LoginResult, reqwest::Error> {
        let login_result = self.ampapi.login().unwrap();

        if login_result.success {
            self.ampapi.session_id = login_result.sessionID.clone();
            self.ampapi.remember_me_token = login_result.rememberMeToken.clone();

            // Update the session ID and remember me token of submodules
            self.Core.ampapi.session_id = login_result.sessionID.clone();
            self.Core.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.EmailSenderPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.EmailSenderPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.FileManagerPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.FileManagerPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.LocalFileBackupPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.LocalFileBackupPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
        }

        Ok(login_result)
    }    
}

/// struct GenericModule
/// Author: p0t4t0sandwich
#[derive(Debug, Clone)]
#[allow(non_snake_case, dead_code)]
pub struct GenericModule {
    ampapi: AMPAPI,
    pub Core: Core,
    pub EmailSenderPlugin: EmailSenderPlugin,
    pub FileManagerPlugin: FileManagerPlugin,
    pub LocalFileBackupPlugin: LocalFileBackupPlugin,
    pub GenericModule: generic_module::GenericModule,
    pub RCONPlugin: RCONPlugin,
    pub steamcmdplugin: steamcmdplugin,
}

/// impl From<Module> for GenericModule
/// Author: p0t4t0sandwich
impl From<Module> for GenericModule {
    fn from(module: Module) -> Self {
        match module {
            Module::GenericModule(generic_module) => generic_module,
            _ => panic!("Cannot convert from {:?} to GenericModule", module)
        }
    }
}

/// impl GenericModule
/// Author: p0t4t0sandwich
#[allow(non_snake_case, dead_code)]
impl GenericModule {
    //noinspection DuplicatedCode
    /// GenericModule.new - Create a new GenericModule struct
    /// Author: p0t4t0sandwich
    /// * `base_uri` - The base URI of the AMP instance
    /// * `username` - The username to use for authentication
    /// * `password` - The password to use for authentication
    ///   * Optional if using a remember me token
    /// * `remember_me_token` - The remember me token to use for authentication
    ///   * Optional
    /// * `session_id` - The session ID to use for authentication
    ///   * Optional, will be instantiated on login
    /// Returns GenericModule
    pub fn new(base_uri: String, username: String, password: String, remember_me_token: String, session_id: String) -> GenericModule {
        let ampapi = AMPAPI::new(base_uri, username, password, remember_me_token, session_id);

        let mut genericModule = GenericModule {
            ampapi: ampapi.clone(),
            Core: Core::new(ampapi.clone()),
            EmailSenderPlugin: EmailSenderPlugin::new(ampapi.clone()),
            FileManagerPlugin: FileManagerPlugin::new(ampapi.clone()),
            LocalFileBackupPlugin: LocalFileBackupPlugin::new(ampapi.clone()),
            GenericModule: generic_module::GenericModule::new(ampapi.clone()),
            RCONPlugin: RCONPlugin::new(ampapi.clone()),
            steamcmdplugin: steamcmdplugin::new(ampapi.clone()),
        };

        if !genericModule.ampapi.username.is_empty()
            && (!genericModule.ampapi.password.is_empty() || !genericModule.ampapi.remember_me_token.is_empty())
        {
            let _ = genericModule.login();
        }

        genericModule
    }

    /// GenericModule.login - Simplified login function
    /// Author: p0t4t0sandwich
    /// Returns Result<LoginResult, reqwest::Error>
    pub fn login(&mut self) -> Result<LoginResult, reqwest::Error> {
        let login_result = self.ampapi.login().unwrap();

        if login_result.success {
            self.ampapi.session_id = login_result.sessionID.clone();
            self.ampapi.remember_me_token = login_result.rememberMeToken.clone();

            // Update the session ID and remember me token of submodules
            self.Core.ampapi.session_id = login_result.sessionID.clone();
            self.Core.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.EmailSenderPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.EmailSenderPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.FileManagerPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.FileManagerPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.LocalFileBackupPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.LocalFileBackupPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.GenericModule.ampapi.session_id = login_result.sessionID.clone();
            self.GenericModule.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.RCONPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.RCONPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.steamcmdplugin.ampapi.session_id = login_result.sessionID.clone();
            self.steamcmdplugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
        }

        Ok(login_result)
    }
}

/// struct Minecraft
/// Author: p0t4t0sandwich
#[derive(Debug, Clone)]
#[allow(non_snake_case, dead_code)]
pub struct Minecraft {
    ampapi: AMPAPI,
    pub Core: Core,
    pub EmailSenderPlugin: EmailSenderPlugin,
    pub FileManagerPlugin: FileManagerPlugin,
    pub LocalFileBackupPlugin: LocalFileBackupPlugin,
    pub MinecraftModule: MinecraftModule,
}

/// impl From<Module> for Minecraft
/// Author: p0t4t0sandwich
impl From<Module> for Minecraft {
    fn from(module: Module) -> Self {
        match module {
            Module::Minecraft(minecraft) => minecraft,
            _ => panic!("Cannot convert from {:?} to Minecraft", module)
        }
    }
}

/// impl MinecraftModule
/// Author: p0t4t0sandwich
#[allow(non_snake_case, dead_code)]
impl Minecraft {
    //noinspection DuplicatedCode
    /// Minecraft.new - Create a new Minecraft struct
    /// Author: p0t4t0sandwich
    /// * `base_uri` - The base URI of the AMP instance
    /// * `username` - The username to use for authentication
    /// * `password` - The password to use for authentication
    ///   * Optional if using a remember me token
    /// * `remember_me_token` - The remember me token to use for authentication
    ///   * Optional
    /// * `session_id` - The session ID to use for authentication
    ///   * Optional, will be instantiated on login
    /// Returns Minecraft
    pub fn new(base_uri: String, username: String, password: String, remember_me_token: String, session_id: String) -> Minecraft {
        let ampapi = AMPAPI::new(base_uri, username, password, remember_me_token, session_id);

        let mut minecraft = Minecraft {
            ampapi: ampapi.clone(),
            Core: Core::new(ampapi.clone()),
            EmailSenderPlugin: EmailSenderPlugin::new(ampapi.clone()),
            FileManagerPlugin: FileManagerPlugin::new(ampapi.clone()),
            LocalFileBackupPlugin: LocalFileBackupPlugin::new(ampapi.clone()),
            MinecraftModule: MinecraftModule::new(ampapi.clone()),
        };

        if !minecraft.ampapi.username.is_empty()
            && (!minecraft.ampapi.password.is_empty() || !minecraft.ampapi.remember_me_token.is_empty())
        {
            let _ = minecraft.login();
        }

        minecraft
    }

    /// Minecraft.login - Simplified login function
    /// Author: p0t4t0sandwich
    /// Returns Result<LoginResult, reqwest::Error>
    pub fn login(&mut self) -> Result<LoginResult, reqwest::Error> {
        let login_result = self.ampapi.login().unwrap();

        if login_result.success {
            self.ampapi.session_id = login_result.sessionID.clone();
            self.ampapi.remember_me_token = login_result.rememberMeToken.clone();

            // Update the session ID and remember me token of submodules
            self.Core.ampapi.session_id = login_result.sessionID.clone();
            self.Core.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.EmailSenderPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.EmailSenderPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.FileManagerPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.FileManagerPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.LocalFileBackupPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.LocalFileBackupPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.MinecraftModule.ampapi.session_id = login_result.sessionID.clone();
            self.MinecraftModule.ampapi.remember_me_token = login_result.rememberMeToken.clone();
        }

        Ok(login_result)
    }
}

/// struct ADS
/// Author: p0t4t0sandwich
#[derive(Debug, Clone)]
#[allow(non_snake_case, dead_code)]
pub struct ADS {
    ampapi: AMPAPI,
    pub Core: Core,
    pub EmailSenderPlugin: EmailSenderPlugin,
    pub FileManagerPlugin: FileManagerPlugin,
    pub LocalFileBackupPlugin: LocalFileBackupPlugin,
    pub ADSModule: ADSModule,
}

/// impl From<Module> for ADS
/// Author: p0t4t0sandwich
impl From<Module> for ADS {
    fn from(module: Module) -> Self {
        match module {
            Module::ADS(ads) => ads,
            _ => panic!("Cannot convert from {:?} to ADS", module)
        }
    }
}

/// enum Module
/// Author: p0t4t0sandwich
#[derive(Debug, Clone)]
pub enum Module {
    ADS(ADS),
    GenericModule(GenericModule),
    Minecraft(Minecraft),
    CommonAPI(CommonAPI),
}

/// impl ADS
/// Author: p0t4t0sandwich
#[allow(non_snake_case, dead_code)]
impl ADS {
    //noinspection ALL
    //noinspection DuplicatedCode
    /// ADS.new - Create a new ADS struct
    /// Author: p0t4t0sandwich
    /// * `base_uri` - The base URI of the AMP instance
    /// * `username` - The username to use for authentication
    /// * `password` - The password to use for authentication
    ///   * Optional if using a remember me token
    /// * `remember_me_token` - The remember me token to use for authentication
    ///   * Optional
    /// * `session_id` - The session ID to use for authentication
    ///   * Optional, will be instantiated on login
    /// Returns ADS
    pub fn new(base_uri: String, username: String, password: String, remember_me_token: String, session_id: String) -> ADS {
        let ampapi = AMPAPI::new(base_uri, username, password, remember_me_token, session_id);

        let mut ads = ADS {
            ampapi: ampapi.clone(),
            Core: Core::new(ampapi.clone()),
            EmailSenderPlugin: EmailSenderPlugin::new(ampapi.clone()),
            FileManagerPlugin: FileManagerPlugin::new(ampapi.clone()),
            LocalFileBackupPlugin: LocalFileBackupPlugin::new(ampapi.clone()),
            ADSModule: ADSModule::new(ampapi.clone()),
        };

        if !ads.ampapi.username.is_empty()
            && (!ads.ampapi.password.is_empty() || !ads.ampapi.remember_me_token.is_empty())
        {
            let _ = ads.login();
        }

        ads
    }

    /// ADS.login - Simplified login function
    /// Author: p0t4t0sandwich
    /// Returns Result<LoginResult, reqwest::Error>
    pub fn login(&mut self) -> Result<LoginResult, reqwest::Error> {
        let login_result = self.ampapi.login().unwrap();

        if login_result.success {
            self.ampapi.session_id = login_result.sessionID.clone();
            self.ampapi.remember_me_token = login_result.rememberMeToken.clone();

            // Update the session ID and remember me token of submodules
            self.Core.ampapi.session_id = login_result.sessionID.clone();
            self.Core.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.EmailSenderPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.EmailSenderPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.FileManagerPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.FileManagerPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.LocalFileBackupPlugin.ampapi.session_id = login_result.sessionID.clone();
            self.LocalFileBackupPlugin.ampapi.remember_me_token = login_result.rememberMeToken.clone();
            self.ADSModule.ampapi.session_id = login_result.sessionID.clone();
            self.ADSModule.ampapi.remember_me_token = login_result.rememberMeToken.clone();
        }

        Ok(login_result)
    }

    /// ADS.instance_login - Function to proxy a login to an instance
    /// Author: p0t4t0sandwich
    /// * `instance_id` - The instance ID to login to
    /// * `module` - The type of module you're logging into
    /// Returns Result<T, reqwest::Error>
    pub fn instance_login(&mut self, instance_id: String, module: String) -> Result<Module, Error> {
        let mut args = HashMap::new();
        args.insert("username".to_string(), Value::String(self.ampapi.username.clone()));
        args.insert("password".to_string(), Value::String(self.ampapi.password.clone()));
        args.insert("token".to_string(), Value::String("".to_string()));
        args.insert("rememberMe".to_string(), Value::Bool(true));

        let loginResult: LoginResult = self.ampapi.api_call::<LoginResult>(format!("ADSModule/Servers/{}/API/Core/Login", instance_id), args).unwrap();

        if loginResult.success {
            // Prepare the parameters for the instance
            let new_base_uri = format!("{}API/ADSModule/Servers/{}", self.ampapi.base_uri, instance_id);
            let remember_me_token = loginResult.rememberMeToken.clone();
            let session_id = loginResult.sessionID.clone();

            // Return the correct module
            match module.as_str() {
                "ADS" => {
                    let mut ads = ADS::new(new_base_uri, self.ampapi.username.clone(), "".to_string(), remember_me_token, session_id);
                    ads.login().unwrap();
                    Ok(Module::ADS(ads))
                },
                "GenericModule" => {
                    let mut generic_module = GenericModule::new(new_base_uri, self.ampapi.username.clone(), "".to_string(), remember_me_token, session_id);
                    generic_module.login().unwrap();
                    Ok(Module::GenericModule(generic_module))
                },
                "Minecraft" => {
                    let mut minecraft = Minecraft::new(new_base_uri, self.ampapi.username.clone(), "".to_string(), remember_me_token, session_id);
                    minecraft.login().unwrap();
                    Ok(Module::Minecraft(minecraft))
                },
                _ => {
                    let mut common_api = CommonAPI::new(new_base_uri, self.ampapi.username.clone(), "".to_string(), remember_me_token, session_id);
                    common_api.login().unwrap();
                    Ok(Module::CommonAPI(common_api))
                }
            }
        } else {
            Err(Error::new(std::io::ErrorKind::Other, "Login failed"))
        }
    }
}