clickhouse_srv/protocols/
protocol_hello.rs

1use std::io::Read;
2
3use crate::binary::Encoder;
4use crate::binary::ReadEx;
5use crate::error_codes;
6use crate::errors::Error;
7use crate::errors::Result;
8use crate::errors::ServerError;
9use crate::protocols::*;
10
11#[derive(Default, Debug, Clone)]
12pub struct HelloRequest {
13    pub client_name: String,
14    pub client_version_major: u64,
15    pub client_version_minor: u64,
16    pub client_revision: u64,
17    pub default_database: String,
18
19    pub user: String,
20    pub password: String,
21
22    // Not set currently
23    pub client_version_patch: u64
24}
25
26impl HelloRequest {
27    pub fn read_from<R: Read>(reader: &mut R) -> Result<HelloRequest> {
28        let request = HelloRequest {
29            client_name: reader.read_string()?,
30            client_version_major: reader.read_uvarint()?,
31            client_version_minor: reader.read_uvarint()?,
32            client_revision: reader.read_uvarint()?,
33            default_database: reader.read_string()?,
34            user: reader.read_string()?,
35            password: reader.read_string()?,
36
37            client_version_patch: 0
38        };
39
40        if request.user.is_empty() {
41            return Err(Error::Server(ServerError {
42                name: "UNEXPECTED_PACKET_FROM_CLIENT".to_string(),
43                code: error_codes::UNEXPECTED_PACKET_FROM_CLIENT,
44                message: "Unexpected packet from client (no user in Hello package)".to_string(),
45                stack_trace: "".to_string()
46            }));
47        }
48
49        // TODO
50        // if request.user != " INTERSERVER SECRET " {
51        // } else {
52        // }
53        Ok(request)
54    }
55}
56
57pub struct HelloResponse {
58    pub dbms_name: String,
59    pub dbms_version_major: u64,
60    pub dbms_version_minor: u64,
61    pub dbms_tcp_protocol_version: u64,
62    pub timezone: String,
63    pub server_display_name: String,
64    pub dbms_version_patch: u64
65}
66
67impl HelloResponse {
68    pub fn encode(&self, encoder: &mut Encoder, client_revision: u64) -> Result<()> {
69        encoder.uvarint(SERVER_HELLO);
70
71        encoder.string(&self.dbms_name);
72        encoder.uvarint(self.dbms_version_major);
73        encoder.uvarint(self.dbms_version_minor);
74        encoder.uvarint(self.dbms_tcp_protocol_version);
75
76        if client_revision >= DBMS_MIN_REVISION_WITH_SERVER_TIMEZONE {
77            encoder.string(&self.timezone);
78        }
79
80        if client_revision >= DBMS_MIN_REVISION_WITH_SERVER_DISPLAY_NAME {
81            encoder.string(&self.server_display_name);
82        }
83
84        if client_revision >= DBMS_MIN_REVISION_WITH_VERSION_PATCH {
85            encoder.uvarint(self.dbms_version_patch);
86        }
87
88        Ok(())
89    }
90}