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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
//! `StructureController` data description.
use crate::{
    data::{RoomName, RoomSign},
    decoders::optional_timespec_seconds,
};

implement_update_for! {
    RoomSign;

    /// Update for room signs
    #[derive(serde_derive::Deserialize, Clone, Debug)]
    (no_extra_meta)
    pub struct RoomSignUpdate {
        /// The game time when the sign was set.
        #[serde(rename = "time")]
        priv game_time_set: Option<u32>,
        /// The real date/time when the sign was set.
        #[serde(default, rename = "datetime", with = "optional_timespec_seconds")]
        priv time_set: Option<time::Timespec>,
        /// The user ID of the user who set the sign.
        #[serde(rename = "user")]
        priv user_id: Option<String>,
        /// The text of the sign.
        priv text: Option<String>,
    }
}

with_update_struct! {
    /// A struct describing a room's reservation.
    #[derive(serde_derive::Deserialize, Clone, Debug, PartialEq)]
    #[serde(rename_all = "camelCase")]
    pub struct ControllerReservation {
        /// The user ID of the user reserving this controller.
        pub user: String,
        /// The game time when this reservation will end if not extended.
        pub end_time: u32,
    }

    /// The update structure for a controller reservation.
    #[derive(serde_derive::Deserialize, Clone, Debug)]
    #[serde(rename_all = "camelCase")]
    pub struct ControllerReservationUpdate { ... }
}

with_structure_fields_and_update_struct! {
    /// A controller, an object creeps can upgrade in order to increase room level.
    #[derive(Clone, Debug, PartialEq)]
    #[serde(rename_all = "camelCase")]
    pub struct StructureController {
        /// The number of upgrade points the controller has.
        #[serde(default)]
        pub progress: u64,
        /// The number of upgrade points needed before the next level is reached.
        #[serde(default)]
        pub progress_total: u64,
        /// The current controller level (1-8 inclusive).
        pub level: u16,
        /// Controller reservation.
        pub reservation: Option<ControllerReservation>,
        /// Game time at which the current safemode will end, if any.
        pub safe_mode: Option<u32>,
        /// How many more safemodes are available.
        #[serde(default)]
        pub safe_mode_available: u32,
        /// The game time that must be reached before safe mode can be used on the controller.
        ///
        /// May be in the past, in which safe mode may be used immediately.
        #[serde(default, with = "crate::decoders::null_as_default")]
        pub safe_mode_cooldown: u32,
        /// The number of game ticks without an upgrade needed before the controller downgrades.
        ///
        /// None if unowned.
        pub downgrade_time: Option<u64>,
        /// The room sign.
        pub sign: Option<RoomSign>,
        /// The number of ticks until upgrading is no longer blocked.
        pub upgrade_blocked: Option<u32>,
        /// ID of the user who owns the controller, and thus the room.
        pub user: Option<String>,
    }

    /// The update structure for a controller object.
    #[derive(Clone, Debug)]
    #[serde(rename_all = "camelCase")]
    pub struct StructureControllerUpdate {
        (null_is_default)
        - progress: u64,
        (null_is_default)
        - progress_total: u64,
        - level: u16,
        - reservation: Option<ControllerReservation>,
        - safe_mode: Option<u32>,
        (null_is_default)
        - safe_mode_available: u32,
        (null_is_default)
        - safe_mode_cooldown: u32,
        - downgrade_time: Option<u64>,
        - sign: Option<RoomSign>,
        - upgrade_blocked: Option<u32>,
        - user: Option<String>,
    }
}

impl StructureController {
    /// The progress required for this controller's level (100% dependent on `level`).
    ///
    /// Returns `None` if level is outside of 1..=7.
    ///
    /// See also [`StructureController::progress_required_at_level`].
    pub fn progress_required(&self) -> Option<u32> {
        Self::progress_required_at_level(self.level)
    }

    /// Progress required for a level.
    pub fn progress_required_at_level(level: u16) -> Option<u32> {
        match level {
            1 => Some(200),
            2 => Some(45000),
            3 => Some(135000),
            4 => Some(405000),
            5 => Some(1215000),
            6 => Some(3645000),
            7 => Some(10935000),
            _ => None,
        }
    }

    /// The total downgrade time for this controller's level (100% dependent on `level`)
    ///
    /// Returns `None` if level is outside of 1..=8.
    ///
    /// See also [`StructureController::total_downgrade_time_at_level`]
    pub fn total_downgrade_time(&self) -> Option<u32> {
        Self::total_downgrade_time_at_level(self.level)
    }

    /// Total downgrade time for a level (game ticks since the last upgrade that this controller will loose a level).
    pub fn total_downgrade_time_at_level(level: u16) -> Option<u32> {
        match level {
            1 => Some(20000),
            2 => Some(5000),
            3 => Some(10000),
            4 => Some(20000),
            5 => Some(40000),
            6 => Some(60000),
            7 => Some(100000),
            8 => Some(150000),
            _ => None,
        }
    }
}

#[cfg(test)]
mod test {
    use serde::Deserialize;
    use {serde_json, time};

    use crate::data::{RoomName, RoomSign};

    use super::{ControllerReservation, StructureController};

    #[test]
    fn parse_controller_and_update() {
        let json = json!({
            "_id": "57ef9dba86f108ae6e60e2fd",
            "downgradeTime": 20020430,
            "hits": 0,
            "hitsMax": 0,
            "level": 8,
            "progress": 0,
            "progressTotal": 0,
            "reservation": null,
            "room": "E4S61",
            "safeMode": null,
            "safeModeAvailable": 7,
            "safeModeCooldown": 17083195,
            "sign": {
                "datetime": 1498254694977i64,
                "text": "◯",
                "time": 19869070,
                "user": "57874d42d0ae911e3bd15bbc"
            },
            "type": "controller",
            "upgradeBlocked": null,
            "user": "57874d42d0ae911e3bd15bbc",
            "x": 16,
            "y": 39
        });

        let mut obj = StructureController::deserialize(&json).unwrap();

        assert_eq!(
            obj,
            StructureController {
                id: "57ef9dba86f108ae6e60e2fd".to_owned(),
                room: RoomName::new("E4S61").unwrap(),
                x: 16,
                y: 39,
                hits: 0,
                hits_max: 0,
                level: 8,
                progress: 0,
                progress_total: 0,
                reservation: None,
                safe_mode: None,
                safe_mode_available: 7,
                safe_mode_cooldown: 17083195,
                downgrade_time: Some(20020430),
                sign: Some(RoomSign {
                    text: "◯".to_owned(),
                    game_time_set: 19869070,
                    time_set: time::Timespec::new(1498254694977, 0),
                    user_id: "57874d42d0ae911e3bd15bbc".to_owned(),
                }),
                upgrade_blocked: None,
                user: Some("57874d42d0ae911e3bd15bbc".to_owned()),
            }
        );

        obj.update(
            serde_json::from_value(json!({
                "safeModeAvailable": 8,
            }))
            .unwrap(),
        );

        assert_eq!(
            obj,
            StructureController {
                id: "57ef9dba86f108ae6e60e2fd".to_owned(),
                room: RoomName::new("E4S61").unwrap(),
                x: 16,
                y: 39,
                hits: 0,
                hits_max: 0,
                level: 8,
                progress: 0,
                progress_total: 0,
                reservation: None,
                safe_mode: None,
                safe_mode_available: 8,
                safe_mode_cooldown: 17083195,
                downgrade_time: Some(20020430),
                sign: Some(RoomSign {
                    text: "◯".to_owned(),
                    game_time_set: 19869070,
                    time_set: time::Timespec::new(1498254694977, 0),
                    user_id: "57874d42d0ae911e3bd15bbc".to_owned(),
                }),
                upgrade_blocked: None,
                user: Some("57874d42d0ae911e3bd15bbc".to_owned()),
            }
        );
    }

    #[test]
    fn parse_controller_and_update_reserved() {
        let json = json!({
            "_id": "579fa94c0700be0674d2f15a",
            "downgradeTime": null,
            "hits": 0,
            "hitsMax": 0,
            "level": 0,
            "progress": 0,
            "progressTotal": 0,
            "reservation": {
                "endTime": 20158024,
                "user": "57874d42d0ae911e3bd15bbc"
            },
            "room": "W12S55",
            "safeMode": null,
            "safeModeAvailable": 0,
            "safeModeCooldown": 16611615,
            "type": "controller",
            "upgradeBlocked": null,
            "user": null,
            "x": 22,
            "y": 37,
        });

        let mut obj = StructureController::deserialize(&json).unwrap();

        assert_eq!(
            obj,
            StructureController {
                id: "579fa94c0700be0674d2f15a".to_owned(),
                room: RoomName::new("W12S55").unwrap(),
                x: 22,
                y: 37,
                downgrade_time: None,
                hits: 0,
                hits_max: 0,
                level: 0,
                progress: 0,
                progress_total: 0,
                reservation: Some(ControllerReservation {
                    user: "57874d42d0ae911e3bd15bbc".to_owned(),
                    end_time: 20158024,
                }),
                safe_mode: None,
                safe_mode_available: 0,
                safe_mode_cooldown: 16611615,
                upgrade_blocked: None,
                user: None,
                sign: None,
            }
        );

        obj.update(
            serde_json::from_value(json!({
                "reservation": {
                    "endTime": 20158029,
                },
            }))
            .unwrap(),
        );

        assert_eq!(
            obj,
            StructureController {
                id: "579fa94c0700be0674d2f15a".to_owned(),
                room: RoomName::new("W12S55").unwrap(),
                x: 22,
                y: 37,
                downgrade_time: None,
                hits: 0,
                hits_max: 0,
                level: 0,
                progress: 0,
                progress_total: 0,
                reservation: Some(ControllerReservation {
                    user: "57874d42d0ae911e3bd15bbc".to_owned(),
                    end_time: 20158029,
                }),
                safe_mode: None,
                safe_mode_available: 0,
                safe_mode_cooldown: 16611615,
                upgrade_blocked: None,
                user: None,
                sign: None,
            }
        );
    }

    #[test]
    fn parse_controller_updates_can_remove_optional_properties() {
        let mut obj = StructureController {
            id: "57ef9dba86f108ae6e60e2fd".to_owned(),
            room: RoomName::new("E4S61").unwrap(),
            x: 16,
            y: 39,
            hits: 0,
            hits_max: 0,
            level: 8,
            progress: 0,
            progress_total: 0,
            reservation: None,
            safe_mode: None,
            safe_mode_available: 7,
            safe_mode_cooldown: 17083195,
            downgrade_time: Some(20020430),
            sign: Some(RoomSign {
                text: "◯".to_owned(),
                game_time_set: 19869070,
                time_set: time::Timespec::new(1498254694977, 0),
                user_id: "57874d42d0ae911e3bd15bbc".to_owned(),
            }),
            upgrade_blocked: None,
            user: Some("57874d42d0ae911e3bd15bbc".to_owned()),
        };

        obj.update(
            serde_json::from_value(json!({
                "sign": null,
            }))
            .unwrap(),
        );

        assert_eq!(
            obj,
            StructureController {
                id: "57ef9dba86f108ae6e60e2fd".to_owned(),
                room: RoomName::new("E4S61").unwrap(),
                x: 16,
                y: 39,
                hits: 0,
                hits_max: 0,
                level: 8,
                progress: 0,
                progress_total: 0,
                reservation: None,
                safe_mode: None,
                safe_mode_available: 7,
                safe_mode_cooldown: 17083195,
                downgrade_time: Some(20020430),
                sign: None,
                upgrade_blocked: None,
                user: Some("57874d42d0ae911e3bd15bbc".to_owned()),
            },
            "signal failure text"
        );
    }

    #[test]
    fn parse_controller_with_very_few_fields() {
        // real data I found on the live server in shard3
        let json = json!(
            {
                "_id": "5bbcad499099fc012e6370bb",
                "room": "E6S31",
                "type": "controller",
                "x": 35,
                "y": 27,
                "level": 0,
                "reservation": null,
            }
        );
        let obj = StructureController::deserialize(&json).unwrap();

        assert_eq!(
            obj,
            StructureController {
                id: "5bbcad499099fc012e6370bb".to_owned(),
                room: RoomName::new("E6S31").unwrap(),
                x: 35,
                y: 27,
                downgrade_time: None,
                hits: 0,
                hits_max: 0,
                level: 0,
                progress: 0,
                progress_total: 0,
                reservation: None,
                safe_mode: None,
                safe_mode_available: 0,
                safe_mode_cooldown: 0,
                upgrade_blocked: None,
                user: None,
                sign: None,
            }
        );
    }

    #[test]
    fn parse_controller_with_null_safe_mode_cooldown() {
        let json = json!(
            {
                "_id": "5bbcad579099fc012e637271",
                "downgradeTime": 7131716,
                "hits": 0,
                "hitsMax": 0,
                "isPowerEnabled": false,
                "level": 6,
                "progress": 2722264,
                "progressTotal": 0,
                "reservation": null,
                "room": "E7S27",
                "safeMode": 5990844,
                "safeModeAvailable": 4,
                "safeModeCooldown": null,
                "sign": {
                    "datetime": 1540160091380i64,
                    "text": "Territory of Metyrio",
                    "time": 508258,
                    "user": "583e2a4c445866cb4ad3117e",
                },
                "type": "controller",
                "upgradeBlocked": null,
                "user": "5cad043ff77d0b62a38318e7",
                "x": 17,
                "y": 18,
            }
        );
        let obj = StructureController::deserialize(&json).unwrap();
        assert_eq!(
            obj,
            StructureController {
                id: "5bbcad579099fc012e637271".to_owned(),
                room: RoomName::new("E7S27").unwrap(),
                x: 17,
                y: 18,
                downgrade_time: Some(7131716),
                hits: 0,
                hits_max: 0,
                level: 6,
                progress: 2722264,
                progress_total: 0,
                reservation: None,
                safe_mode: Some(5990844),
                safe_mode_available: 4,
                safe_mode_cooldown: 0,
                upgrade_blocked: None,
                user: Some("5cad043ff77d0b62a38318e7".to_owned()),
                sign: Some(RoomSign {
                    text: "Territory of Metyrio".to_owned(),
                    game_time_set: 508258,
                    time_set: time::Timespec::new(1540160091380, 0),
                    user_id: "583e2a4c445866cb4ad3117e".to_owned(),
                }),
            }
        );
    }

    #[test]
    fn handle_functionally_full_update() {
        let mut obj = StructureController {
            id: "5bbcad579099fc012e637271".to_owned(),
            room: RoomName::new("E7S27").unwrap(),
            x: 17,
            y: 18,
            downgrade_time: Some(7131716),
            hits: 0,
            hits_max: 0,
            level: 6,
            progress: 2722264,
            progress_total: 0,
            reservation: None,
            safe_mode: Some(5990844),
            safe_mode_available: 4,
            safe_mode_cooldown: 0,
            upgrade_blocked: None,
            user: Some("5cad043ff77d0b62a38318e7".to_owned()),
            sign: Some(RoomSign {
                text: "Territory of Metyrio".to_owned(),
                game_time_set: 508258,
                time_set: time::Timespec::new(1540160091380, 0),
                user_id: "583e2a4c445866cb4ad3117e".to_owned(),
            }),
        };

        obj.update(
            serde_json::from_value(json!({
                "_id": "5bbcad579099fc012e637271",
                "downgradeTime": null,
                "hits": 0,
                "hitsMax": 0,
                "isPowerEnabled": false,
                "level": 0,
                "progress": 0,
                "progressTotal": 0,
                "room": "E7S27",
                "safeMode": null,
                "safeModeAvailable": 0,
                "safeModeCooldown": null,
                "type": "controller",
                "upgradeBlocked": null,
                "user": null,
                "x": 10,
                "y": 34,
            }))
            .unwrap(),
        );
    }
}