kftray-helper 0.27.11

Privileged helper binary for KFTray
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
use std::io;
#[cfg(unix)]
use std::os::unix::net::UnixStream;
use std::path::Path;
use std::time::{
    Duration,
    Instant,
};

use log::debug;
#[cfg(windows)]
use tokio::io::AsyncWriteExt;
#[cfg(windows)]
use tokio::net::windows::named_pipe::ClientOptions;

use crate::error::HelperError;
use crate::messages::{
    HelperRequest,
    HelperResponse,
    RequestCommand,
};

pub fn is_socket_available(socket_path: &Path) -> bool {
    #[cfg(unix)]
    {
        if !socket_path.exists() {
            debug!("Helper socket doesn't exist at: {socket_path:?}");
            return false;
        }

        try_connect_socket(socket_path)
    }

    #[cfg(windows)]
    {
        let pipe_name = socket_path.to_string_lossy();
        debug!("Checking if Windows pipe is available: {}", pipe_name);
        match ClientOptions::new().open(pipe_name.as_ref()) {
            Ok(_) => {
                debug!("Successfully connected to Windows pipe");
                true
            }
            Err(e) => {
                debug!("Failed to connect to Windows pipe: {}", e);
                false
            }
        }
    }
}

#[cfg(unix)]
fn try_connect_socket(socket_path: &Path) -> bool {
    debug!("Socket exists at: {}", socket_path.display());

    match UnixStream::connect(socket_path) {
        Ok(_) => {
            debug!("Successfully connected to helper socket at {socket_path:?}");
            true
        }
        Err(e) => {
            debug!("Socket exists at {socket_path:?} but connection failed: {e}");

            if e.kind() == std::io::ErrorKind::PermissionDenied
                || e.kind() == std::io::ErrorKind::ConnectionRefused
            {
                debug!("Detected stale or inaccessible socket");

                if let Some(parent) = socket_path.parent() {
                    if is_directory_writable(parent) {
                        debug!("Removing stale socket from writable directory");
                        if let Err(rm_err) = std::fs::remove_file(socket_path) {
                            debug!("Failed to remove stale socket: {rm_err}");
                        } else {
                            debug!("Removed stale socket file");
                        }
                    } else {
                        debug!("Cannot remove stale socket - parent directory not writable");
                    }
                }
            }

            false
        }
    }
}

#[cfg(unix)]
fn is_directory_writable(path: &Path) -> bool {
    let test_file_path = path.join(".kftray_write_test");
    let write_result = std::fs::File::create(&test_file_path);

    if test_file_path.exists() {
        let _ = std::fs::remove_file(&test_file_path);
    }

    write_result.is_ok()
}

pub fn send_request(
    socket_path: &Path, app_id: &str, command: RequestCommand,
) -> Result<HelperResponse, HelperError> {
    let request = HelperRequest::new(app_id.to_string(), command);

    debug!("Using socket path: {}", socket_path.display());

    let request_bytes = serde_json::to_vec(&request)
        .map_err(|e| HelperError::Communication(format!("Failed to serialize request: {e}")))?;

    #[cfg(unix)]
    {
        debug!("Connecting to Unix socket at {}", socket_path.display());
        let mut stream = UnixStream::connect(socket_path).map_err(|e| {
            HelperError::Communication(format!("Failed to connect to Unix socket: {e}"))
        })?;

        if let Err(e) = stream.set_nonblocking(false) {
            debug!("Failed to set blocking mode: {e}");
        }

        if let Err(e) = stream.set_read_timeout(Some(Duration::from_secs(5))) {
            debug!("Failed to set read timeout: {e}");
        }

        if let Err(e) = stream.set_write_timeout(Some(Duration::from_secs(5))) {
            debug!("Failed to set write timeout: {e}");
        }

        debug!("Sending request ({} bytes)", request_bytes.len());
        match io::Write::write_all(&mut stream, &request_bytes) {
            Ok(_) => debug!("Request sent successfully"),
            Err(e) => {
                return Err(HelperError::Communication(format!(
                    "Failed to write request: {e}"
                )));
            }
        }

        match io::Write::flush(&mut stream) {
            Ok(_) => debug!("Socket flushed successfully"),
            Err(e) => {
                return Err(HelperError::Communication(format!(
                    "Failed to flush socket: {e}"
                )));
            }
        }

        std::thread::sleep(Duration::from_millis(200));

        read_unix_response(stream)
    }

    #[cfg(windows)]
    {
        debug!("Connecting to Windows pipe at {}", socket_path.display());
        let pipe_name = socket_path.to_string_lossy();

        let rt = tokio::runtime::Builder::new_current_thread()
            .enable_all()
            .build()
            .map_err(|e| {
                HelperError::Communication(format!("Failed to create tokio runtime: {}", e))
            })?;

        rt.block_on(async {
            let mut pipe = ClientOptions::new().open(pipe_name.as_ref()).map_err(|e| {
                HelperError::Communication(format!("Failed to connect to Windows pipe: {}", e))
            })?;

            debug!("Sending request ({} bytes)", request_bytes.len());
            match pipe.write_all(&request_bytes).await {
                Ok(_) => debug!("Request sent successfully"),
                Err(e) => {
                    return Err(HelperError::Communication(format!(
                        "Failed to write request: {}",
                        e
                    )));
                }
            }

            match pipe.flush().await {
                Ok(_) => debug!("Pipe flushed successfully"),
                Err(e) => {
                    return Err(HelperError::Communication(format!(
                        "Failed to flush pipe: {}",
                        e
                    )));
                }
            }

            tokio::time::sleep(Duration::from_millis(200)).await;

            read_windows_response(&mut pipe).await
        })
    }
}

#[cfg(unix)]
fn read_unix_response(mut stream: UnixStream) -> Result<HelperResponse, HelperError> {
    let start_time = Instant::now();
    let timeout = Duration::from_secs(30);
    let mut buffer = Vec::new();
    let mut tmp_buf = [0u8; 4096];

    debug!(
        "Starting response read with timeout of {} seconds",
        timeout.as_secs()
    );

    loop {
        if start_time.elapsed() > timeout {
            debug!("Request timed out after {} seconds", timeout.as_secs());
            return Err(HelperError::Communication(format!(
                "Timed out waiting for response after {} seconds",
                timeout.as_secs()
            )));
        }

        match io::Read::read(&mut stream, &mut tmp_buf) {
            Ok(0) => {
                debug!("End of stream reached (0 bytes read)");
                if buffer.is_empty() {
                    debug!("Socket closed without sending any data");
                    std::thread::sleep(Duration::from_millis(500));
                    continue;
                } else {
                    debug!("Socket closed after receiving data, breaking read loop");
                    break;
                }
            }
            Ok(n) => {
                debug!("Read {n} bytes from response");
                buffer.extend_from_slice(&tmp_buf[..n]);

                if n < tmp_buf.len() {
                    debug!("Message appears complete (got less than buffer size)");
                    break;
                }
            }
            Err(e)
                if e.kind() == std::io::ErrorKind::WouldBlock
                    || e.kind() == std::io::ErrorKind::TimedOut =>
            {
                if buffer.is_empty() {
                    debug!("No data received yet, waiting...");
                } else {
                    debug!(
                        "Partial data received ({} bytes), waiting for more...",
                        buffer.len()
                    );
                }

                debug!("Time elapsed: {:?}", start_time.elapsed());

                if !buffer.is_empty() && start_time.elapsed() > Duration::from_secs(3) {
                    debug!("We have some data and waited 3 seconds, assuming response is complete");
                    break;
                }

                std::thread::sleep(Duration::from_millis(200));
                continue;
            }
            Err(e) if e.kind() == std::io::ErrorKind::Interrupted => {
                debug!("Read interrupted, retrying...");
                continue;
            }
            Err(e) => {
                debug!("Error reading from socket: {e}");

                if !buffer.is_empty() {
                    debug!(
                        "Got error but have some data ({} bytes), attempting to parse",
                        buffer.len()
                    );
                    break;
                }

                return Err(HelperError::Communication(format!(
                    "Failed to read response: {e}"
                )));
            }
        }
    }

    debug!("Finished reading response, total {} bytes", buffer.len());

    if buffer.is_empty() {
        debug!("Empty response buffer after read loop");
        return Err(HelperError::Communication("Empty response received".into()));
    }

    match serde_json::from_slice::<HelperResponse>(&buffer) {
        Ok(response) => {
            debug!("Successfully parsed response: {:?}", response.result);
            Ok(response)
        }
        Err(e) => {
            debug!("Failed to parse response JSON: {e}");
            debug!(
                "Response content (first 100 bytes): {:?}",
                String::from_utf8_lossy(&buffer[..std::cmp::min(buffer.len(), 100)])
            );
            Err(HelperError::Communication(format!(
                "Failed to parse response: {e}"
            )))
        }
    }
}

#[cfg(windows)]
async fn read_windows_response<T: tokio::io::AsyncRead + Unpin>(
    pipe: &mut T,
) -> Result<HelperResponse, HelperError> {
    use tokio::io::AsyncReadExt;

    let start_time = Instant::now();
    let timeout = Duration::from_secs(30);
    let mut buffer = Vec::new();
    let mut tmp_buf = [0u8; 4096];

    debug!(
        "Starting Windows pipe response read with timeout of {} seconds",
        timeout.as_secs()
    );

    loop {
        if start_time.elapsed() > timeout {
            debug!("Request timed out after {} seconds", timeout.as_secs());
            return Err(HelperError::Communication(format!(
                "Timed out waiting for response after {} seconds",
                timeout.as_secs()
            )));
        }

        let read_future = pipe.read(&mut tmp_buf);
        let read_result = match tokio::time::timeout(Duration::from_secs(5), read_future).await {
            Ok(result) => result,
            Err(_) => {
                debug!("Read operation timed out, checking buffer state");
                if !buffer.is_empty() && start_time.elapsed() > Duration::from_secs(3) {
                    debug!("We have some data and waited 3 seconds, assuming response is complete");
                    break;
                }
                tokio::time::sleep(Duration::from_millis(200)).await;
                continue;
            }
        };

        match read_result {
            Ok(0) => {
                debug!("End of pipe reached (0 bytes read)");
                if buffer.is_empty() {
                    debug!("Pipe closed without sending any data");
                    tokio::time::sleep(Duration::from_millis(500)).await;
                    continue;
                } else {
                    debug!("Pipe closed after receiving data, breaking read loop");
                    break;
                }
            }
            Ok(n) => {
                debug!("Read {} bytes from pipe response", n);
                buffer.extend_from_slice(&tmp_buf[..n]);

                if n < tmp_buf.len() {
                    debug!("Message appears complete (got less than buffer size)");
                    break;
                }
            }
            Err(e) if e.kind() == std::io::ErrorKind::WouldBlock => {
                if buffer.is_empty() {
                    debug!("No data received yet, waiting...");
                } else {
                    debug!(
                        "Partial data received ({} bytes), waiting for more...",
                        buffer.len()
                    );
                }

                debug!("Time elapsed: {:?}", start_time.elapsed());

                if !buffer.is_empty() && start_time.elapsed() > Duration::from_secs(3) {
                    debug!("We have some data and waited 3 seconds, assuming response is complete");
                    break;
                }

                tokio::time::sleep(Duration::from_millis(200)).await;
                continue;
            }
            Err(e) if e.kind() == std::io::ErrorKind::Interrupted => {
                debug!("Read interrupted, retrying...");
                continue;
            }
            Err(e) => {
                debug!("Error reading from pipe: {}", e);

                if !buffer.is_empty() {
                    debug!(
                        "Got error but have some data ({} bytes), attempting to parse",
                        buffer.len()
                    );
                    break;
                }

                return Err(HelperError::Communication(format!(
                    "Failed to read response: {}",
                    e
                )));
            }
        }
    }

    debug!("Finished reading response, total {} bytes", buffer.len());

    if buffer.is_empty() {
        debug!("Empty response buffer after read loop");
        return Err(HelperError::Communication("Empty response received".into()));
    }

    match serde_json::from_slice::<HelperResponse>(&buffer) {
        Ok(response) => {
            debug!("Successfully parsed response: {:?}", response.result);
            Ok(response)
        }
        Err(e) => {
            debug!("Failed to parse response JSON: {}", e);
            debug!(
                "Response content (first 100 bytes): {:?}",
                String::from_utf8_lossy(&buffer[..std::cmp::min(buffer.len(), 100)])
            );
            Err(HelperError::Communication(format!(
                "Failed to parse response: {}",
                e
            )))
        }
    }
}