whois-cli 0.3.2

A simple WHOIS query tool
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
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
use std::io::{Read, Write};
use std::net::TcpStream;
use std::time::Duration;
use anyhow::{Context, Result};

/// WHOIS-COLOR Protocol v1.1
/// A backward-compatible extension protocol for server-side colorization,
/// Markdown rendering, and image display support
pub struct WhoisColorProtocol;

/// Server capability information
#[derive(Debug, Clone, PartialEq)]
pub struct ServerCapabilities {
    pub supports_color: bool,
    pub color_schemes: Vec<String>,
    pub protocol_version: String,
    pub supports_markdown: bool,
    pub supports_images: bool,
    pub image_formats: Vec<String>,
}

impl Default for ServerCapabilities {
    fn default() -> Self {
        Self {
            supports_color: false,
            color_schemes: vec![],
            protocol_version: "none".to_string(),
            supports_markdown: false,
            supports_images: false,
            image_formats: vec![],
        }
    }
}

/// Protocol constants
pub const PROTOCOL_VERSION: &str = "1.1";
pub const LEGACY_VERSION: &str = "1.0";
pub const CAPABILITY_PROBE: &str = "X-WHOIS-COLOR-PROBE: v1.1\r\n";
pub const COLOR_REQUEST_PREFIX: &str = "X-WHOIS-COLOR: ";
pub const MARKDOWN_REQUEST_PREFIX: &str = "X-WHOIS-MARKDOWN: ";
pub const IMAGE_REQUEST_PREFIX: &str = "X-WHOIS-IMAGES: ";
pub const CAPABILITY_RESPONSE_PREFIX: &str = "X-WHOIS-COLOR-SUPPORT: ";
pub const CAPABILITY_TIMEOUT_MS: u64 = 2000; // 2 seconds for capability probe

impl WhoisColorProtocol {
    /// Probe server for color protocol support
    /// This method sends a capability probe and waits for a response
    /// If no response or timeout, assumes standard WHOIS server
    pub fn probe_capabilities(
        &self, 
        server_address: &str,
        verbose: bool
    ) -> Result<ServerCapabilities> {
        if verbose {
            println!("Probing color capabilities for: {}", server_address);
        }

        let mut stream = TcpStream::connect(server_address)
            .with_context(|| format!("Cannot connect to server for capability probe: {}", server_address))?;
        
        // Set shorter timeout for capability probe
        stream.set_read_timeout(Some(Duration::from_millis(CAPABILITY_TIMEOUT_MS)))
            .context("Failed to set read timeout for capability probe")?;
        
        stream.set_write_timeout(Some(Duration::from_millis(CAPABILITY_TIMEOUT_MS)))
            .context("Failed to set write timeout for capability probe")?;

        // Send capability probe
        // Format: "X-WHOIS-COLOR-PROBE: v1.0\r\n\r\n"
        let probe_query = format!("{}\r\n", CAPABILITY_PROBE);
        
        if let Err(_) = stream.write_all(probe_query.as_bytes()) {
            // If write fails, assume standard WHOIS server
            if verbose {
                println!("Capability probe write failed, assuming standard WHOIS");
            }
            return Ok(ServerCapabilities::default());
        }

        // Try to read response
        let mut response = String::new();
        match stream.read_to_string(&mut response) {
            Ok(_) => {
                let capabilities = self.parse_capability_response(&response);
                if verbose {
                    println!("Server capabilities: {:?}", capabilities);
                }
                Ok(capabilities)
            }
            Err(_) => {
                // Timeout or read error - assume standard WHOIS server
                if verbose {
                    println!("No capability response, assuming standard WHOIS");
                }
                Ok(ServerCapabilities::default())
            }
        }
    }

    /// Parse capability response from server
    /// Expected format: "X-WHOIS-COLOR-SUPPORT: v1.1 schemes=ripe,bgptools,mtf markdown=true images=png,jpg\r\n"
    /// Legacy format: "X-WHOIS-COLOR-SUPPORT: v1.0 schemes=ripe,bgptools,mtf\r\n"
    fn parse_capability_response(&self, response: &str) -> ServerCapabilities {
        for line in response.lines() {
            let line = line.trim();
            if line.starts_with(CAPABILITY_RESPONSE_PREFIX) {
                return self.parse_capability_line(&line[CAPABILITY_RESPONSE_PREFIX.len()..]);
            }
        }
        ServerCapabilities::default()
    }

    /// Parse a single capability line
    /// Format v1.1: "v1.1 schemes=ripe,bgptools,mtf markdown=true images=png,jpg"
    /// Format v1.0: "v1.0 schemes=ripe,bgptools,mtf"
    fn parse_capability_line(&self, capability_data: &str) -> ServerCapabilities {
        let parts: Vec<&str> = capability_data.split_whitespace().collect();
        if parts.is_empty() {
            return ServerCapabilities::default();
        }

        let protocol_version = parts[0].to_string();
        let mut capabilities = ServerCapabilities {
            supports_color: true,
            protocol_version: protocol_version.clone(),
            color_schemes: vec![],
            supports_markdown: false,
            supports_images: false,
            image_formats: vec![],
        };

        // Parse additional parameters
        for part in &parts[1..] {
            if let Some(schemes_part) = part.strip_prefix("schemes=") {
                capabilities.color_schemes = schemes_part
                    .split(',')
                    .map(|s| s.trim().to_string())
                    .filter(|s| !s.is_empty())
                    .collect();
            } else if let Some(markdown_part) = part.strip_prefix("markdown=") {
                capabilities.supports_markdown = markdown_part == "true";
            } else if let Some(images_part) = part.strip_prefix("images=") {
                capabilities.supports_images = !images_part.is_empty();
                capabilities.image_formats = images_part
                    .split(',')
                    .map(|s| s.trim().to_string())
                    .filter(|s| !s.is_empty())
                    .collect();
            }
        }

        capabilities
    }

    /// Perform query with enhanced protocol support (color, markdown, images)
    /// Falls back gracefully for older servers
    pub fn query_with_enhanced_protocol(
        &self,
        server_address: &str,
        query: &str,
        capabilities: &ServerCapabilities,
        preferred_scheme: Option<&str>,
        enable_markdown: bool,
        enable_images: bool,
        verbose: bool
    ) -> Result<String> {
        let mut stream = TcpStream::connect(server_address)
            .with_context(|| format!("Cannot connect to WHOIS server: {}", server_address))?;
        
        stream.set_read_timeout(Some(Duration::from_secs(10)))
            .context("Failed to set read timeout")?;
        
        stream.set_write_timeout(Some(Duration::from_secs(10)))
            .context("Failed to set write timeout")?;

        let query_string = if capabilities.supports_color || capabilities.supports_markdown || capabilities.supports_images {
            self.build_enhanced_query(query, capabilities, preferred_scheme, enable_markdown, enable_images, verbose)
        } else {
            // Standard WHOIS query
            format!("{}\r\n", query)
        };

        if verbose {
            if capabilities.supports_color {
                println!("Sending color-enabled query");
            }
            if capabilities.supports_markdown && enable_markdown {
                println!("Requesting Markdown format");
            }
            if capabilities.supports_images && enable_images {
                println!("Requesting image support");
            }
        }

        stream.write_all(query_string.as_bytes())
            .context("Failed to write query to WHOIS server")?;
        
        let mut response = String::new();
        stream.read_to_string(&mut response)
            .context("Failed to read response from WHOIS server")?;
        
        Ok(response)
    }

    /// Build query string with enhanced protocol headers
    /// Format v1.1: "X-WHOIS-COLOR: scheme=ripe\r\nX-WHOIS-MARKDOWN: true\r\nX-WHOIS-IMAGES: png,jpg\r\nquery\r\n"
    /// Format v1.0: "X-WHOIS-COLOR: scheme=ripe\r\nquery\r\n"
    fn build_enhanced_query(
        &self,
        query: &str,
        capabilities: &ServerCapabilities,
        preferred_scheme: Option<&str>,
        enable_markdown: bool,
        enable_images: bool,
        verbose: bool
    ) -> String {
        let mut headers = String::new();
        
        // Add color header if supported
        if capabilities.supports_color {
            if let Some(scheme) = self.select_color_scheme(capabilities, preferred_scheme) {
                if verbose {
                    println!("Requesting server-side coloring with scheme: {}", scheme);
                }
                headers.push_str(&format!("{}scheme={}\r\n", COLOR_REQUEST_PREFIX, scheme));
            }
        }
        
        // Add markdown header if supported and requested
        if capabilities.supports_markdown && enable_markdown {
            headers.push_str(&format!("{}true\r\n", MARKDOWN_REQUEST_PREFIX));
        }
        
        // Add images header if supported and requested
        if capabilities.supports_images && enable_images && !capabilities.image_formats.is_empty() {
            let formats = capabilities.image_formats.join(",");
            headers.push_str(&format!("{}{}\r\n", IMAGE_REQUEST_PREFIX, formats));
        }
        
        if headers.is_empty() {
            // No protocol features, use standard query
            format!("{}\r\n", query)
        } else {
            // Enhanced protocol query
            format!("{}{}\r\n", headers, query)
        }
    }

    /// Legacy method for backward compatibility
    /// Build query string with color protocol headers
    /// Format: "X-WHOIS-COLOR: scheme=ripe\r\nquery\r\n"
    #[allow(dead_code)]
    fn build_color_query(
        &self,
        query: &str,
        capabilities: &ServerCapabilities,
        preferred_scheme: Option<&str>,
        verbose: bool
    ) -> String {
        let scheme = self.select_color_scheme(capabilities, preferred_scheme);
        
        if let Some(scheme) = scheme {
            if verbose {
                println!("Requesting server-side coloring with scheme: {}", scheme);
            }
            format!("{}scheme={}\r\n{}\r\n", COLOR_REQUEST_PREFIX, scheme, query)
        } else {
            // No suitable scheme, use standard query
            if verbose {
                println!("No suitable color scheme, falling back to standard query");
            }
            format!("{}\r\n", query)
        }
    }

    /// Select appropriate color scheme based on server capabilities and preference
    fn select_color_scheme(
        &self,
        capabilities: &ServerCapabilities,
        preferred_scheme: Option<&str>
    ) -> Option<String> {
        if !capabilities.supports_color {
            return None;
        }

        // If preferred scheme is supported, use it
        if let Some(preferred) = preferred_scheme {
            if capabilities.color_schemes.contains(&preferred.to_string()) {
                return Some(preferred.to_string());
            }
        }

        // Otherwise, use first available scheme
        capabilities.color_schemes.first().cloned()
    }

    /// Check if response contains server-generated colors
    /// Server-colored responses should contain color control sequences
    pub fn is_server_colored(&self, response: &str) -> bool {
        // Check for ANSI color escape sequences
        response.contains("\x1b[") || 
        // Check for color protocol markers (optional)
        response.contains("X-WHOIS-COLOR-APPLIED:")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parse_capability_response_v10() {
        let protocol = WhoisColorProtocol;
        
        let response = "X-WHOIS-COLOR-SUPPORT: v1.0 schemes=ripe,bgptools,mtf\r\n";
        let capabilities = protocol.parse_capability_response(response);
        
        assert!(capabilities.supports_color);
        assert_eq!(capabilities.protocol_version, "v1.0");
        assert_eq!(capabilities.color_schemes, vec!["ripe", "bgptools", "mtf"]);
        assert!(!capabilities.supports_markdown); // v1.0 doesn't support markdown
        assert!(!capabilities.supports_images); // v1.0 doesn't support images
    }

    #[test]
    fn test_parse_capability_response_v11() {
        let protocol = WhoisColorProtocol;
        
        let response = "X-WHOIS-COLOR-SUPPORT: v1.1 schemes=ripe,bgptools,mtf markdown=true images=png,jpg\r\n";
        let capabilities = protocol.parse_capability_response(response);
        
        assert!(capabilities.supports_color);
        assert_eq!(capabilities.protocol_version, "v1.1");
        assert_eq!(capabilities.color_schemes, vec!["ripe", "bgptools", "mtf"]);
        assert!(capabilities.supports_markdown);
        assert!(capabilities.supports_images);
        assert_eq!(capabilities.image_formats, vec!["png", "jpg"]);
    }

    #[test]
    fn test_parse_capability_response_minimal() {
        let protocol = WhoisColorProtocol;
        
        let response = "X-WHOIS-COLOR-SUPPORT: v1.0\r\n";
        let capabilities = protocol.parse_capability_response(response);
        
        assert!(capabilities.supports_color);
        assert_eq!(capabilities.protocol_version, "v1.0");
        assert!(capabilities.color_schemes.is_empty());
    }

    #[test]
    fn test_parse_capability_response_no_support() {
        let protocol = WhoisColorProtocol;
        
        let response = "Some other response\r\n";
        let capabilities = protocol.parse_capability_response(response);
        
        assert!(!capabilities.supports_color);
        assert_eq!(capabilities.protocol_version, "none");
        assert!(capabilities.color_schemes.is_empty());
    }

    #[test]
    fn test_select_color_scheme_preferred() {
        let protocol = WhoisColorProtocol;
        let capabilities = ServerCapabilities {
            supports_color: true,
            color_schemes: vec!["ripe".to_string(), "bgptools".to_string()],
            protocol_version: "v1.0".to_string(),
            supports_markdown: false,
            supports_images: false,
            image_formats: vec![],
        };
        
        let scheme = protocol.select_color_scheme(&capabilities, Some("bgptools"));
        assert_eq!(scheme, Some("bgptools".to_string()));
    }

    #[test]
    fn test_select_color_scheme_fallback() {
        let protocol = WhoisColorProtocol;
        let capabilities = ServerCapabilities {
            supports_color: true,
            color_schemes: vec!["ripe".to_string(), "bgptools".to_string()],
            protocol_version: "v1.0".to_string(),
            supports_markdown: false,
            supports_images: false,
            image_formats: vec![],
        };
        
        let scheme = protocol.select_color_scheme(&capabilities, Some("invalid"));
        assert_eq!(scheme, Some("ripe".to_string()));
    }

    #[test]
    fn test_select_color_scheme_no_support() {
        let protocol = WhoisColorProtocol;
        let capabilities = ServerCapabilities::default();
        
        let scheme = protocol.select_color_scheme(&capabilities, Some("ripe"));
        assert_eq!(scheme, None);
    }

    #[test]
    fn test_build_enhanced_query_v10_compat() {
        let protocol = WhoisColorProtocol;
        let capabilities = ServerCapabilities {
            supports_color: true,
            color_schemes: vec!["ripe".to_string()],
            protocol_version: "v1.0".to_string(),
            supports_markdown: false,
            supports_images: false,
            image_formats: vec![],
        };
        
        let query = protocol.build_enhanced_query("example.com", &capabilities, Some("ripe"), false, false, false);
        assert_eq!(query, "X-WHOIS-COLOR: scheme=ripe\r\nexample.com\r\n");
    }

    #[test]
    fn test_build_enhanced_query_v11_full() {
        let protocol = WhoisColorProtocol;
        let capabilities = ServerCapabilities {
            supports_color: true,
            color_schemes: vec!["ripe".to_string()],
            protocol_version: "v1.1".to_string(),
            supports_markdown: true,
            supports_images: true,
            image_formats: vec!["png".to_string(), "jpg".to_string()],
        };
        
        let query = protocol.build_enhanced_query("example.com", &capabilities, Some("ripe"), true, true, false);
        let expected = "X-WHOIS-COLOR: scheme=ripe\r\nX-WHOIS-MARKDOWN: true\r\nX-WHOIS-IMAGES: png,jpg\r\nexample.com\r\n";
        assert_eq!(query, expected);
    }

    #[test]
    fn test_build_color_query_legacy() {
        let protocol = WhoisColorProtocol;
        let capabilities = ServerCapabilities {
            supports_color: true,
            color_schemes: vec!["ripe".to_string()],
            protocol_version: "v1.0".to_string(),
            supports_markdown: false,
            supports_images: false,
            image_formats: vec![],
        };
        
        let query = protocol.build_color_query("example.com", &capabilities, Some("ripe"), false);
        assert_eq!(query, "X-WHOIS-COLOR: scheme=ripe\r\nexample.com\r\n");
    }

    #[test]
    fn test_build_color_query_no_scheme() {
        let protocol = WhoisColorProtocol;
        let capabilities = ServerCapabilities::default();
        
        let query = protocol.build_color_query("example.com", &capabilities, Some("ripe"), false);
        assert_eq!(query, "example.com\r\n");
    }

    #[test]
    fn test_is_server_colored() {
        let protocol = WhoisColorProtocol;
        
        assert!(protocol.is_server_colored("text with \x1b[31mcolor\x1b[0m"));
        assert!(protocol.is_server_colored("X-WHOIS-COLOR-APPLIED: ripe\ntext"));
        assert!(!protocol.is_server_colored("plain text"));
    }
}