sxurl 1.1.0

Fixed-length, sliceable URL identifier system for efficient database storage and querying
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

//! Bit packing functionality for SXURL 256-bit format.
//!
//! This module handles packing URL components into the fixed 256-bit SXURL format
//! according to the specification layout.

use crate::error::SxurlError;
use crate::types::UrlComponents;
use crate::core::hasher::ComponentHasher;

/// Pack URL components into a 256-bit SXURL identifier.
///
/// The SXURL format layout (256 bits total = 64 hex chars) according to SXURL.md specification:
/// - header: [0..3) (3 hex chars = 12 bits) - Version(4) + Scheme(3) + Flags(5)
/// - tld_h: [3..7) (4 hex chars = 16 bits)
/// - domain_h: [7..22) (15 hex chars = 60 bits)
/// - sub_h: [22..30) (8 hex chars = 32 bits)
/// - port: [30..34) (4 hex chars = 16 bits)
/// - path_h: [34..49) (15 hex chars = 60 bits)
/// - params_h: [49..58) (9 hex chars = 36 bits)
/// - frag_h: [58..64) (6 hex chars = 24 bits)
pub fn pack_sxurl(components: &UrlComponents) -> Result<[u8; 32], SxurlError> {
    // Hash all components
    let tld_hash = ComponentHasher::hash_tld(&components.tld)?;
    let domain_hash = ComponentHasher::hash_domain(&components.domain)?;
    let subdomain_hash = if components.subdomain.is_empty() {
        0
    } else {
        ComponentHasher::hash_subdomain(&components.subdomain)?
    };
    let path_hash = ComponentHasher::hash_path(&components.path)?;
    let params_hash = if components.query.is_empty() {
        0
    } else {
        ComponentHasher::hash_params(&components.query)?
    };
    let fragment_hash = if components.fragment.is_empty() {
        0
    } else {
        ComponentHasher::hash_fragment(&components.fragment)?
    };

    // Create scheme code according to v2 specification
    let scheme_code = match components.scheme.as_str() {
        "https" => 0u8,
        "http" => 1u8,
        "ftp" => 2u8,
        _ => return Err(SxurlError::InvalidScheme),
    };

    // Build flags (8 bits): sub(7), port(6), path(5), params(4), frag(3), reserved(2:0)
    let path_present = !components.path.is_empty() && components.path != "/";
    let port_present = components.port != get_default_port(&components.scheme);

    let flags =
        (if !components.subdomain.is_empty() { 1u8 } else { 0u8 }) << 7 |
        (if port_present { 1u8 } else { 0u8 }) << 6 |
        (if path_present { 1u8 } else { 0u8 }) << 5 |
        (if !components.query.is_empty() { 1u8 } else { 0u8 }) << 4 |
        (if !components.fragment.is_empty() { 1u8 } else { 0u8 }) << 3;
        // bits 2, 1, 0 are reserved and always 0

    // Build hex string by concatenating each component in v2 format
    let mut hex_string = String::with_capacity(64);

    // v2 format: scheme(1) + reserved(1) + tld(7) + domain(15) + sub(8) + flags(2) + port(4) + path(13) + query(8) + frag(5)

    // Scheme: 1 hex char (4 bits)
    hex_string.push_str(&format!("{:01x}", scheme_code));

    // Reserved: 1 hex char (4 bits) - always 0
    hex_string.push_str("0");

    // TLD hash: 7 hex chars (28 bits)
    hex_string.push_str(&format!("{:07x}", tld_hash));

    // Domain hash: 15 hex chars (60 bits)
    hex_string.push_str(&format!("{:015x}", domain_hash));

    // Subdomain hash: 8 hex chars (32 bits)
    hex_string.push_str(&format!("{:08x}", subdomain_hash));

    // Flags: 2 hex chars (8 bits)
    hex_string.push_str(&format!("{:02x}", flags));

    // Port: 4 hex chars (16 bits)
    hex_string.push_str(&format!("{:04x}", components.port));

    // Path hash: 13 hex chars (52 bits)
    hex_string.push_str(&format!("{:013x}", path_hash));

    // Query hash: 8 hex chars (32 bits)
    hex_string.push_str(&format!("{:08x}", params_hash));

    // Fragment hash: 5 hex chars (20 bits)
    hex_string.push_str(&format!("{:05x}", fragment_hash));

    // Verify we have exactly 64 hex characters
    if hex_string.len() != 64 {
        return Err(SxurlError::InternalError);
    }

    // Convert hex string to bytes
    hex_to_sxurl(&hex_string)
}

/// Pack URL components into SXURL format using pre-computed hash values.
///
/// This function is optimized for cases where hash values have already been computed,
/// avoiding duplicate hashing operations. Used internally for efficient encoding
/// of both domain and full SXURLs.
///
/// # Arguments
///
/// * `components` - The URL components (for metadata like scheme, port)
/// * `tld_hash` - Pre-computed TLD hash
/// * `domain_hash` - Pre-computed domain hash
/// * `subdomain_hash` - Pre-computed subdomain hash
/// * `path_hash` - Pre-computed path hash
/// * `params_hash` - Pre-computed params hash
/// * `fragment_hash` - Pre-computed fragment hash
///
/// # Returns
///
/// Returns the SXURL as a 32-byte array.
pub fn pack_sxurl_with_hashes(
    components: &UrlComponents,
    tld_hash: u64,
    domain_hash: u64,
    subdomain_hash: u64,
    path_hash: u64,
    params_hash: u64,
    fragment_hash: u64,
) -> Result<[u8; 32], SxurlError> {
    // Create scheme code according to v2 specification
    let scheme_code = match components.scheme.as_str() {
        "https" => 0u8,
        "http" => 1u8,
        "ftp" => 2u8,
        _ => return Err(SxurlError::InvalidScheme),
    };

    // Build flags (8 bits): sub(7), port(6), path(5), params(4), frag(3), reserved(2:0)
    let path_present = !components.path.is_empty() && components.path != "/";
    let port_present = components.port != get_default_port(&components.scheme);

    let flags =
        (if !components.subdomain.is_empty() { 1u8 } else { 0u8 }) << 7 |
        (if port_present { 1u8 } else { 0u8 }) << 6 |
        (if path_present { 1u8 } else { 0u8 }) << 5 |
        (if !components.query.is_empty() { 1u8 } else { 0u8 }) << 4 |
        (if !components.fragment.is_empty() { 1u8 } else { 0u8 }) << 3;
        // bits 2, 1, 0 are reserved and always 0

    // Build hex string by concatenating each component in v2 format
    let mut hex_string = String::with_capacity(64);

    // v2 format: scheme(1) + reserved(1) + tld(7) + domain(15) + sub(8) + flags(2) + port(4) + path(13) + query(8) + frag(5)

    // Scheme: 1 hex char (4 bits)
    hex_string.push_str(&format!("{:01x}", scheme_code));

    // Reserved: 1 hex char (4 bits) - always 0
    hex_string.push_str("0");

    // TLD hash: 7 hex chars (28 bits)
    hex_string.push_str(&format!("{:07x}", tld_hash));

    // Domain hash: 15 hex chars (60 bits)
    hex_string.push_str(&format!("{:015x}", domain_hash));

    // Subdomain hash: 8 hex chars (32 bits)
    hex_string.push_str(&format!("{:08x}", subdomain_hash));

    // Flags: 2 hex chars (8 bits)
    hex_string.push_str(&format!("{:02x}", flags));

    // Port: 4 hex chars (16 bits)
    hex_string.push_str(&format!("{:04x}", components.port));

    // Path hash: 13 hex chars (52 bits)
    hex_string.push_str(&format!("{:013x}", path_hash));

    // Query hash: 8 hex chars (32 bits)
    hex_string.push_str(&format!("{:08x}", params_hash));

    // Fragment hash: 5 hex chars (20 bits)
    hex_string.push_str(&format!("{:05x}", fragment_hash));

    // Verify we have exactly 64 hex characters
    if hex_string.len() != 64 {
        return Err(SxurlError::InternalError);
    }

    // Convert hex string to bytes
    hex_to_sxurl(&hex_string)
}

/// Get the default port for a scheme.
fn get_default_port(scheme: &str) -> u16 {
    match scheme {
        "http" => 80,
        "https" => 443,
        "ftp" => 21,
        _ => 0,
    }
}

/// Convert a 256-bit SXURL to a hex string.
pub fn sxurl_to_hex(sxurl: &[u8; 32]) -> String {
    hex::encode(sxurl)
}

/// Parse a hex string to a 256-bit SXURL.
pub fn hex_to_sxurl(hex_str: &str) -> Result<[u8; 32], SxurlError> {
    if hex_str.len() != 64 {
        return Err(SxurlError::InvalidLength);
    }

    let bytes = hex::decode(hex_str)
        .map_err(|_| SxurlError::InvalidHexCharacter)?;

    if bytes.len() != 32 {
        return Err(SxurlError::InvalidLength);
    }

    let mut result = [0u8; 32];
    result.copy_from_slice(&bytes);
    Ok(result)
}

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


    #[test]
    fn test_sxurl_hex_conversion() {
        let sxurl = [0u8; 32];
        let hex = sxurl_to_hex(&sxurl);
        assert_eq!(hex.len(), 64);
        assert_eq!(hex, "0".repeat(64));

        let parsed = hex_to_sxurl(&hex).unwrap();
        assert_eq!(parsed, sxurl);
    }

    #[test]
    fn test_pack_sxurl_basic() {
        let components = UrlComponents::new(
            "https".to_string(),
            "com".to_string(),
            "example".to_string(),
            "".to_string(),
            443,
            "/".to_string(),
            "".to_string(),
            "".to_string(),
        );

        let result = pack_sxurl(&components);
        assert!(result.is_ok());

        let sxurl = result.unwrap();
        assert_eq!(sxurl.len(), 32);

        // Convert to hex and verify format
        let hex = sxurl_to_hex(&sxurl);
        assert_eq!(hex.len(), 64);

        // For HTTPS (scheme=0) + reserved(0) should start with "00"
        assert!(hex.starts_with("00"), "HTTPS v2 should start with '00', got: {}", &hex[0..2]);

        println!("SXURL for https://example.com/: {}", hex);
    }

    #[test]
    fn test_pack_sxurl_with_params() {
        let components = UrlComponents::new(
            "https".to_string(),
            "com".to_string(),
            "google".to_string(),
            "".to_string(),
            443,
            "/search".to_string(),
            "q=test".to_string(),
            "".to_string(),
        );

        let result = pack_sxurl(&components);
        assert!(result.is_ok());

        let sxurl = result.unwrap();
        let hex = sxurl_to_hex(&sxurl);

        // For HTTPS with params present: scheme=0, reserved=0, then TLD hash starts
        // Flags will be at position 32 hex chars in with params flag (bit 4) set
        assert!(hex.starts_with("00"), "HTTPS v2 should start with '00', got: {}", &hex[0..2]);

        println!("SXURL for https://google.com/search?q=test: {}", hex);
    }

    #[test]
    fn test_v2_format_positions() {
        let components = UrlComponents::new(
            "http".to_string(),    // scheme = 1
            "com".to_string(),     // TLD
            "example".to_string(),  // domain
            "api".to_string(),     // subdomain (present)
            8080,                  // port (non-default)
            "/v1/users".to_string(), // path (present)
            "limit=10".to_string(), // query (present)
            "section1".to_string(), // fragment (present)
        );

        let result = pack_sxurl(&components);
        assert!(result.is_ok());

        let hex = sxurl_to_hex(&result.unwrap());
        assert_eq!(hex.len(), 64);

        println!("✓ v2 format test:");
        println!("  Full SXURL: {}", hex);
        println!("  Positions breakdown:");
        println!("    [0:1]   Scheme:    {} (http=1)", &hex[0..1]);
        println!("    [1:2]   Reserved:  {} (always 0)", &hex[1..2]);
        println!("    [2:9]   TLD:       {} (28-bit)", &hex[2..9]);
        println!("    [9:24]  Domain:    {} (60-bit)", &hex[9..24]);
        println!("    [24:32] Subdomain: {} (32-bit)", &hex[24..32]);
        println!("    [32:34] Flags:     {} (8-bit)", &hex[32..34]);
        println!("    [34:38] Port:      {} (16-bit)", &hex[34..38]);
        println!("    [38:51] Path:      {} (52-bit)", &hex[38..51]);
        println!("    [51:59] Query:     {} (32-bit)", &hex[51..59]);
        println!("    [59:64] Fragment:  {} (20-bit)", &hex[59..64]);

        // Verify scheme
        assert_eq!(&hex[0..1], "1", "HTTP scheme should be 1");

        // Verify reserved
        assert_eq!(&hex[1..2], "0", "Reserved should be 0");

        // Verify port encoding (8080 = 0x1F90)
        assert_eq!(&hex[34..38], "1f90", "Port 8080 should encode as 1f90");

        // Parse flags manually: sub(7)=1, port(6)=1, path(5)=1, params(4)=1, frag(3)=1 = 0xF8
        let flags_hex = &hex[32..34];
        let flags = u8::from_str_radix(flags_hex, 16).unwrap();
        assert_eq!(flags & 0x80, 0x80, "Subdomain flag should be set");
        assert_eq!(flags & 0x40, 0x40, "Port flag should be set");
        assert_eq!(flags & 0x20, 0x20, "Path flag should be set");
        assert_eq!(flags & 0x10, 0x10, "Params flag should be set");
        assert_eq!(flags & 0x08, 0x08, "Fragment flag should be set");
    }
}