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
/*-
 * cdns-rs - a simple sync/async DNS query library
 * Copyright (C) 2020  Aleksandr Morozov
 * 
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

use std::collections::LinkedList;
use std::convert::{TryFrom, TryInto};
use std::net::SocketAddr;
use std::fmt;
use std::time::Duration;
use std::time::Instant;


use crate::error::*;
use crate::internal_error;

use super::common::*;


/// A query override
#[derive(Debug, Clone)]
pub struct QuerySetup
{
    /// Sets the realtime counter to measure delay
    pub(crate) measure_time: bool, 

    /// Forces to ignore hosts file
    pub(crate) ign_hosts: bool, 

    /// Overrides the timeout duration for reply awaiting.
    pub(crate) timeout: Option<u32>,
}

impl Default for QuerySetup
{
    fn default() -> Self 
    {
        return Self { measure_time: false, ign_hosts: false, timeout: None };
    }
}

impl QuerySetup
{
    /// Turns on/off the time measurment whcih measure how many time went
    /// since query started for each response.
    pub 
    fn set_measure_time(&mut self, flag: bool) -> &mut Self
    {
        self.measure_time = flag;
        
        return self;
    }

    /// Turns on/off the option which when set is force to ignore lookup in
    /// /etc/hosts
    pub 
    fn set_ign_hosts(&mut self, flag: bool) -> &mut Self
    {
        self.ign_hosts = flag;

        return self;
    }

    /// Overrides the timeout. Can not be 0.
    pub 
    fn set_override_timeout(&mut self, timeout: u32) -> &mut Self
    {
        if timeout == 0
        {
            return self;
        }

        self.timeout = Some(timeout);

        return self;
    }

    /// Resets the override timeout.
    pub 
    fn reset_override_timeout(&mut self) -> &mut Self
    {
        self.timeout = None;

        return self;
    }

}

/// A [StatusBits] decoded response status.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum QDnsQueryRec
{
    /// Response is Ok and
    Ok,
    /// Server side error
    ServFail,
    /// Query does not exist, but meaningfull when `aa` is true
    NxDomain,
    /// A name server refuses to perform the specified operation
    Refused,
    /// A name server does not support the requested kind of query
    NotImpl,
    /// A fromat error
    FormError,
}

impl QDnsQueryRec
{
    /// Returns true if [QueryMode] is set to continue query other nameservers.  
    /// Returns false if there is no need to query other nameservers i.e 
    ///  [QueryMode::DefaultMode] or the response was from authotherative server.
    pub(crate)
    fn try_next_nameserver(&self, aa: bool) -> bool
    {
        match *self
        {
            Self::NxDomain =>
            {
                if aa == true
                {
                    // the response is from authotherative server
                    return false;
                }

                return true;
            },
            Self::Ok | Self::Refused | Self::ServFail | Self::NotImpl | Self::FormError =>
            {
                return true;
            }
        }
    }
}

impl TryFrom<StatusBits> for QDnsQueryRec
{
    type Error = CDnsError;

    fn try_from(value: StatusBits) -> Result<Self, Self::Error> 
    {
        if value.contains(StatusBits::RESP_NOERROR) == true
        {
            /*let resps: Vec<QueryRec> = 
                ans.response.into_iter().map(|a| a.into()).collect();
            */
            return Ok(QDnsQueryRec::Ok);
        }
        else if value.contains(StatusBits::RESP_FORMERR) == true
        {
            return Ok(QDnsQueryRec::FormError);
        }
        else if value.contains(StatusBits::RESP_NOT_IMPL) == true
        {
            return Ok(QDnsQueryRec::NotImpl);
        }
        else if value.contains(StatusBits::RESP_NXDOMAIN) == true
        {
            return Ok(QDnsQueryRec::NxDomain);
        }
        else if value.contains(StatusBits::RESP_REFUSED) == true
        {
            return Ok(QDnsQueryRec::Refused);
        }
        else if value.contains(StatusBits::RESP_SERVFAIL) == true
        {
            return Ok(QDnsQueryRec::ServFail);
        }
        else
        {
            internal_error!(CDnsErrorType::DnsResponse, "response status bits unknwon result: '{}'", value.bits());
        };
    }
}


impl fmt::Display for QDnsQueryRec
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result 
    {
        match *self
        {
            Self::Ok => 
            {
                writeln!(f, "OK")?;
            },
            Self::ServFail =>
            {
                writeln!(f, "SERVFAIL")?;
            },
            Self::NxDomain =>
            {
                writeln!(f, "NXDOMAIN")?;
            },
            Self::Refused => 
            {   
                writeln!(f, "REFUSED")?;
            },
            Self::NotImpl => 
            {
                writeln!(f, "NOT IMPLEMENTED")?;
            },
            Self::FormError =>
            {
                writeln!(f, "FORMAT ERROR")?;
            }
        }

        return Ok(());
    }
}

/// A structure which describes the query properties and contains the
/// results.
#[derive(Clone, Debug)]
pub struct QDnsQuery
{
    /// A realtime time elapsed for query
    pub elapsed: Option<Duration>,
    /// Server which performed the response and port number
    pub server: String,
    /// Authoritative Answer
    pub aa: bool,
    /// Authoratives section
    pub authoratives: Vec<DnsResponsePayload>,
    /// Responses
    pub resp: Vec<DnsResponsePayload>,
    /// Status
    pub status: QDnsQueryRec,
}

impl fmt::Display for QDnsQuery
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result 
    {
        write!(f, "Source: {} ", self.server)?;
        if let Some(ref el) = self.elapsed
        {
            write!(f, "{:.2?} ", el)?;
        }

        if self.aa == true
        {
            writeln!(f, "Authoritative answer")?;
        }
        else
        {
            writeln!(f, "Non-Authoritative answer")?;
        }

        writeln!(f, "Authoritatives: {}", self.authoratives.len())?;

        if self.authoratives.len() > 0
        {
            for a in self.authoratives.iter()
            {
                writeln!(f, "{}", a)?;
            }

            writeln!(f, "")?;
        }

        writeln!(f, "Status: {}", self.status)?;

        writeln!(f, "Answers: {}", self.resp.len())?;

        if self.resp.len() > 0
        {
            for r in self.resp.iter()
            {
                writeln!(f, "{}", r)?;
            }

            writeln!(f, "")?;
        }

        return Ok(());
    }
}

impl QDnsQuery
{
    /// Returns true if the response is OK
    pub 
    fn is_ok(&self) -> bool
    {
        return self.status == QDnsQueryRec::Ok;
    }

    pub 
    fn is_authorative(&self) -> bool
    {
        return self.aa;
    }

    pub 
    fn get_elapsed_time(&self) -> Option<&Duration>
    {
        return self.elapsed.as_ref();
    }

    pub 
    fn get_server(&self) -> &String
    {
        return &self.server;
    }

    /// Returns the authorative server data if any
    pub 
    fn get_authoratives(&self) -> &[DnsResponsePayload]
    {
        return self.authoratives.as_slice();
    }

    /// Returns the responses if any
    pub 
    fn get_responses(&self) -> &[DnsResponsePayload]
    {
        return self.resp.as_slice();
    }

    /// Moves the responses from structure
    pub 
    fn move_responses(self) -> Vec<DnsResponsePayload>
    {
        return self.resp;
    }
}

impl QDnsQuery
{
    /// Constructs instance like it is from 'local' source but not from DNS server.
    pub 
    fn from_local(req_pl: Vec<DnsResponsePayload>, now: Option<&Instant>) -> QDnsQuery
    {
        let elapsed = 
            match now
            {
                Some(n) => Some(n.elapsed()),
                None => None
            };

        return 
            Self
            {
                elapsed:        elapsed,
                server:         HOST_CFG_PATH.to_string(),
                aa:             true,
                authoratives:   Vec::new(),
                status:         QDnsQueryRec::Ok,
                resp:           req_pl
            };
    }

    /// Constructs an instance from the remote response.
    pub 
    fn from_response(server: &SocketAddr, ans: DnsRequestAnswer, now: Option<&Instant>) -> CDnsResult<Self>
    {
        return Ok(
            Self
            {
                elapsed:        now.map_or(None, |n| Some(n.elapsed())),
                server:         server.to_string(),
                aa:             ans.header.status.contains(StatusBits::AUTH_ANSWER),
                authoratives:   ans.authoratives,
                status:         ans.header.status.try_into()?,
                resp:           ans.response,
            }
        );
    }
}

/// The result enum. 
#[derive(Debug)]
pub enum QDnsQueriesRes
{
    /// Received results
    DnsOk
    {
        res: Vec<QDnsQuery>,
    },
    /// All nameservers did not respond 
    DnsNotAvailable,
}

impl QDnsQueriesRes
{ 
    pub(crate)
    fn extend(&mut self, other: Self)
    {
        if other.is_results() == false
        {
            return;
        }

        match *self
        {
            Self::DnsOk{ ref mut res } =>
            {
                res.extend(other.into_inner().unwrap());
            },
            Self::DnsNotAvailable =>
            {
                *self = Self::DnsOk{ res: other.into_inner().unwrap() };
            }
        }
    }

    /// Unwraps the results without panics.
    pub 
    fn into_inner(self) -> Option<Vec<QDnsQuery>>
    {
        match self
        {
            Self::DnsNotAvailable => None,
            Self::DnsOk{ res } => return Some(res),
        }
    }

    /// Checks if the received result contains any results.
    /// It does not check if results were successfull. It just
    /// answers on question if any DNS server responded or record 
    /// in local databases was found.
    pub 
    fn is_results(&self) -> bool
    {
        match *self
        {
            Self::DnsNotAvailable => return false,
            _ => return true,
        }
    }

    /// This function tells how many responses it contains.
    /// If Self is [QDnsQueriesRes::DnsNotAvailable] then 0 will be returned.
    pub 
    fn len(&self) -> usize
    {
        if let Self::DnsOk{res} = self
        {
            return res.len();
        }
        else
        {
            return 0;
        }
    }

    /// This function returns the results if any.
    pub 
    fn list_results(&self) -> Option<std::slice::Iter<'_, QDnsQuery>>
    {
        if let Self::DnsOk{res} = self
        {
            return Some(res.iter());
        }
        else
        {
            return None;
        }
    }
}

impl From<QDnsQuery> for QDnsQueriesRes
{
    fn from(query: QDnsQuery) -> Self 
    {
        return QDnsQueriesRes::DnsOk{ res: vec![query] };
    }
}

impl From<LinkedList<QDnsQuery>> for QDnsQueriesRes
{
    fn from(responses: LinkedList<QDnsQuery>) -> Self 
    {
        if responses.len() > 0
        {
            return QDnsQueriesRes::DnsOk{ res: responses.into_iter().map(|h| h).collect() };
        }
        else
        {
            return QDnsQueriesRes::DnsNotAvailable;
        }
    }
}

impl fmt::Display for QDnsQueriesRes
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result 
    {
        match *self
        {
            Self::DnsOk{ ref res } =>
            {
                for r in res.iter()
                {
                    write!(f, "{}", r)?;
                }
            },
            Self::DnsNotAvailable => write!(f, "No DNS server available")?
        }

        return Ok(());
    }
}