mirror of
https://github.com/nextcloud/desktop.git
synced 2024-11-22 13:05:51 +03:00
368 lines
12 KiB
Objective-C
368 lines
12 KiB
Objective-C
/*
|
||
* Copyright (C) 2022 by Claudio Cambra <claudio.cambra@nextcloud.com>
|
||
*
|
||
* This program is free software; you can redistribute it and/or modify
|
||
* it under the terms of the GNU General Public License as published by
|
||
* the Free Software Foundation; either version 2 of the License, or
|
||
* (at your option) any later version.
|
||
*
|
||
* This program is distributed in the hope that it will be useful, but
|
||
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||
* for more details.
|
||
*/
|
||
|
||
#import <Foundation/Foundation.h>
|
||
|
||
#include <sys/socket.h>
|
||
#include <sys/un.h>
|
||
#include <stdio.h>
|
||
#include <string.h>
|
||
|
||
#import "LocalSocketClient.h"
|
||
|
||
@interface LocalSocketClient()
|
||
{
|
||
NSString* _socketPath;
|
||
id<LineProcessor> _lineProcessor;
|
||
|
||
int _sock;
|
||
dispatch_queue_t _localSocketQueue;
|
||
dispatch_source_t _readSource;
|
||
dispatch_source_t _writeSource;
|
||
NSMutableData* _inBuffer;
|
||
NSMutableData* _outBuffer;
|
||
}
|
||
@end
|
||
|
||
@implementation LocalSocketClient
|
||
|
||
- (instancetype)initWithSocketPath:(NSString*)socketPath
|
||
lineProcessor:(id<LineProcessor>)lineProcessor
|
||
{
|
||
NSLog(@"Initiating local socket client pointing to %@", socketPath);
|
||
self = [super init];
|
||
|
||
if(self) {
|
||
_socketPath = socketPath;
|
||
_lineProcessor = lineProcessor;
|
||
|
||
_sock = -1;
|
||
_localSocketQueue = dispatch_queue_create("localSocketQueue", DISPATCH_QUEUE_SERIAL);
|
||
|
||
_inBuffer = [NSMutableData data];
|
||
_outBuffer = [NSMutableData data];
|
||
}
|
||
|
||
return self;
|
||
}
|
||
|
||
- (BOOL)isConnected
|
||
{
|
||
NSLog(@"Checking is connected: %@", _sock != -1 ? @"YES" : @"NO");
|
||
return _sock != -1;
|
||
}
|
||
|
||
- (void)start
|
||
{
|
||
if([self isConnected]) {
|
||
NSLog(@"Socket client already connected. Not starting.");
|
||
return;
|
||
}
|
||
|
||
struct sockaddr_un localSocketAddr;
|
||
unsigned long socketPathByteCount = [_socketPath lengthOfBytesUsingEncoding:NSUTF8StringEncoding]; // add 1 for the NUL terminator char
|
||
int maxByteCount = sizeof(localSocketAddr.sun_path);
|
||
|
||
if(socketPathByteCount > maxByteCount) {
|
||
// LOG THAT THE SOCKET PATH IS TOO LONG HERE
|
||
NSLog(@"Socket path '%@' is too long: maximum socket path length is %i, this path is of length %lu", _socketPath, maxByteCount, socketPathByteCount);
|
||
return;
|
||
}
|
||
|
||
NSLog(@"Opening local socket...");
|
||
|
||
// LOG THAT THE SOCKET IS BEING OPENED HERE
|
||
_sock = socket(AF_LOCAL, SOCK_STREAM, 0);
|
||
|
||
if(_sock == -1) {
|
||
NSLog(@"Cannot open socket: '%@'", [self strErr]);
|
||
[self restart];
|
||
return;
|
||
}
|
||
|
||
NSLog(@"Local socket opened. Connecting to '%@' ...", _socketPath);
|
||
|
||
localSocketAddr.sun_family = AF_LOCAL & 0xff;
|
||
|
||
const char* pathBytes = [_socketPath UTF8String];
|
||
strcpy(localSocketAddr.sun_path, pathBytes);
|
||
|
||
int connectionStatus = connect(_sock, (struct sockaddr*)&localSocketAddr, sizeof(localSocketAddr));
|
||
|
||
if(connectionStatus == -1) {
|
||
NSLog(@"Could not connect to '%@': '%@'", _socketPath, [self strErr]);
|
||
[self restart];
|
||
return;
|
||
}
|
||
|
||
int flags = fcntl(_sock, F_GETFL, 0);
|
||
|
||
if(fcntl(_sock, F_SETFL, flags | O_NONBLOCK) == -1) {
|
||
NSLog(@"Could not set socket to non-blocking mode: '%@'", [self strErr]);
|
||
[self restart];
|
||
return;
|
||
}
|
||
|
||
NSLog(@"Connected to socket. Setting up dispatch sources...");
|
||
|
||
_readSource = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, _sock, 0, _localSocketQueue);
|
||
dispatch_source_set_event_handler(_readSource, ^(void){ [self readFromSocket]; });
|
||
dispatch_source_set_cancel_handler(_readSource, ^(void){
|
||
self->_readSource = nil;
|
||
[self closeConnection];
|
||
});
|
||
|
||
_writeSource = dispatch_source_create(DISPATCH_SOURCE_TYPE_WRITE, _sock, 0, _localSocketQueue);
|
||
dispatch_source_set_event_handler(_writeSource, ^(void){ [self writeToSocket]; });
|
||
dispatch_source_set_cancel_handler(_writeSource, ^(void){
|
||
self->_writeSource = nil;
|
||
[self closeConnection];
|
||
});
|
||
|
||
// These dispatch sources are suspended upon creation.
|
||
// We resume the writeSource when we actually have something to write, suspending it again once our outBuffer is empty.
|
||
// We start the readSource now.
|
||
|
||
NSLog(@"Starting to read from socket");
|
||
|
||
dispatch_resume(_readSource);
|
||
}
|
||
|
||
- (void)restart
|
||
{
|
||
NSLog(@"Restarting connection to socket.");
|
||
[self closeConnection];
|
||
dispatch_async(dispatch_get_main_queue(), ^(void){
|
||
[NSTimer scheduledTimerWithTimeInterval:5 repeats:NO block:^(NSTimer* timer) {
|
||
[self start];
|
||
}];
|
||
});
|
||
}
|
||
|
||
- (void)closeConnection
|
||
{
|
||
NSLog(@"Closing connection.");
|
||
|
||
if(_readSource) {
|
||
// Since dispatch_source_cancel works asynchronously, if we deallocate the dispatch source here then we can
|
||
// cause a crash. So instead we strongly hold a reference to the read source and deallocate it asynchronously
|
||
// with the handler.
|
||
__block dispatch_source_t previousReadSource = _readSource;
|
||
dispatch_source_set_cancel_handler(_readSource, ^{
|
||
previousReadSource = nil;
|
||
});
|
||
dispatch_source_cancel(_readSource);
|
||
// The readSource is still alive due to the other reference and will be deallocated by the cancel handler
|
||
_readSource = nil;
|
||
}
|
||
|
||
if(_writeSource) {
|
||
// Same deal with the write source
|
||
__block dispatch_source_t previousWriteSource = _writeSource;
|
||
dispatch_source_set_cancel_handler(_writeSource, ^{
|
||
previousWriteSource = nil;
|
||
});
|
||
dispatch_source_cancel(_writeSource);
|
||
_writeSource = nil;
|
||
}
|
||
|
||
[_inBuffer setLength:0];
|
||
[_outBuffer setLength: 0];
|
||
|
||
if(_sock != -1) {
|
||
close(_sock);
|
||
_sock = -1;
|
||
}
|
||
}
|
||
|
||
- (NSString*)strErr
|
||
{
|
||
int err = errno;
|
||
const char *errStr = strerror(err);
|
||
NSString *errorStr = [NSString stringWithUTF8String:errStr];
|
||
|
||
if([errorStr length] == 0) {
|
||
return errorStr;
|
||
} else {
|
||
return [NSString stringWithFormat:@"Unknown error code: %i", err];
|
||
}
|
||
}
|
||
|
||
- (void)sendMessage:(NSString *)message
|
||
{
|
||
dispatch_async(_localSocketQueue, ^(void) {
|
||
if(![self isConnected]) {
|
||
return;
|
||
}
|
||
|
||
BOOL writeSourceIsSuspended = [self->_outBuffer length] == 0;
|
||
|
||
[self->_outBuffer appendData:[message dataUsingEncoding:NSUTF8StringEncoding]];
|
||
|
||
NSLog(@"Writing to out buffer: '%@'", message);
|
||
NSLog(@"Out buffer now %li bytes", [self->_outBuffer length]);
|
||
|
||
if(writeSourceIsSuspended) {
|
||
NSLog(@"Resuming write dispatch source.");
|
||
dispatch_resume(self->_writeSource);
|
||
}
|
||
});
|
||
}
|
||
|
||
- (void)askOnSocket:(NSString *)path query:(NSString *)verb
|
||
{
|
||
NSString *line = [NSString stringWithFormat:@"%@:%@\n", verb, path];
|
||
[self sendMessage:line];
|
||
}
|
||
|
||
- (void)writeToSocket
|
||
{
|
||
if(![self isConnected]) {
|
||
return;
|
||
}
|
||
|
||
if([_outBuffer length] == 0) {
|
||
NSLog(@"Empty out buffer, suspending write dispatch source.");
|
||
dispatch_suspend(_writeSource);
|
||
return;
|
||
}
|
||
|
||
NSLog(@"About to write %li bytes from outbuffer to socket.", [_outBuffer length]);
|
||
|
||
long bytesWritten = write(_sock, [_outBuffer bytes], [_outBuffer length]);
|
||
char lineWritten[[_outBuffer length]];
|
||
memcpy(lineWritten, [_outBuffer bytes], [_outBuffer length]);
|
||
NSLog(@"Wrote %li bytes to socket. Line written was: '%@'", bytesWritten, [NSString stringWithUTF8String:lineWritten]);
|
||
|
||
if(bytesWritten == 0) {
|
||
// 0 means we reached "end of file" and thus the socket was closed. So let's restart it
|
||
NSLog(@"Socket was closed. Restarting...");
|
||
[self restart];
|
||
} else if(bytesWritten == -1) {
|
||
int err = errno; // Make copy before it gets nuked by something else
|
||
|
||
if(err == EAGAIN || err == EWOULDBLOCK) {
|
||
// No free space in the OS' buffer, nothing to do here
|
||
NSLog(@"No free space in OS buffer. Ending write.");
|
||
return;
|
||
} else {
|
||
NSLog(@"Error writing to local socket: '%@'", [self strErr]);
|
||
[self restart];
|
||
}
|
||
} else if(bytesWritten > 0) {
|
||
[_outBuffer replaceBytesInRange:NSMakeRange(0, bytesWritten) withBytes:NULL length:0];
|
||
|
||
NSLog(@"Out buffer cleared. Now count is %li bytes.", [_outBuffer length]);
|
||
|
||
if([_outBuffer length] == 0) {
|
||
NSLog(@"Out buffer has been emptied, suspending write dispatch source.");
|
||
dispatch_suspend(_writeSource);
|
||
}
|
||
}
|
||
}
|
||
|
||
- (void)askForIcon:(NSString*)path isDirectory:(BOOL)isDirectory;
|
||
{
|
||
NSLog(@"Asking for icon.");
|
||
|
||
NSString *verb;
|
||
if(isDirectory) {
|
||
verb = @"RETRIEVE_FOLDER_STATUS";
|
||
} else {
|
||
verb = @"RETRIEVE_FILE_STATUS";
|
||
}
|
||
|
||
[self askOnSocket:path query:verb];
|
||
}
|
||
|
||
- (void)readFromSocket
|
||
{
|
||
if(![self isConnected]) {
|
||
return;
|
||
}
|
||
|
||
NSLog(@"Reading from socket.");
|
||
|
||
int bufferLength = BUF_SIZE / 2;
|
||
char buffer[bufferLength];
|
||
|
||
while(true) {
|
||
long bytesRead = read(_sock, buffer, bufferLength);
|
||
|
||
NSLog(@"Read %li bytes from socket.", bytesRead);
|
||
|
||
if(bytesRead == 0) {
|
||
// 0 means we reached "end of file" and thus the socket was closed. So let's restart it
|
||
NSLog(@"Socket was closed. Restarting...");
|
||
[self restart];
|
||
return;
|
||
} else if(bytesRead == -1) {
|
||
int err = errno;
|
||
if(err == EAGAIN) {
|
||
NSLog(@"No error and no data. Stopping.");
|
||
return; // No error, no data, so let's stop
|
||
} else {
|
||
NSLog(@"Error reading from local socket: '%@'", [self strErr]);
|
||
[self closeConnection];
|
||
return;
|
||
}
|
||
} else {
|
||
[_inBuffer appendBytes:buffer length:bytesRead];
|
||
[self processInBuffer];
|
||
}
|
||
}
|
||
}
|
||
|
||
- (void)processInBuffer
|
||
{
|
||
NSLog(@"Processing in buffer. In buffer length %li", _inBuffer.length);
|
||
|
||
UInt8 separator[] = {0xa}; // Byte value for "\n"
|
||
NSData * const separatorData = [NSData dataWithBytes:separator length:1];
|
||
|
||
while(_inBuffer.length > 0) {
|
||
const NSUInteger inBufferLength = _inBuffer.length;
|
||
const NSRange inBufferLengthRange = NSMakeRange(0, inBufferLength);
|
||
const NSRange firstSeparatorIndex = [_inBuffer rangeOfData:separatorData
|
||
options:0
|
||
range:inBufferLengthRange];
|
||
|
||
unsigned char *buffer = _inBuffer.mutableBytes;
|
||
NSUInteger nullTerminatorIndex = NSUIntegerMax;
|
||
|
||
if (firstSeparatorIndex.location == NSNotFound) {
|
||
NSLog(@"No separator found. Creating new buffer qith space for null terminator.");
|
||
unsigned char newBuffer[inBufferLength + 1];
|
||
memcpy(&newBuffer, buffer, inBufferLength);
|
||
buffer = &newBuffer[0];
|
||
nullTerminatorIndex = inBufferLength;
|
||
} else {
|
||
nullTerminatorIndex = firstSeparatorIndex.location;
|
||
}
|
||
|
||
NSAssert(nullTerminatorIndex != NSUIntegerMax, @"Null terminator index should be valid.");
|
||
|
||
buffer[nullTerminatorIndex] = 0; // Add NULL terminator, so we can use C string methods
|
||
|
||
NSString * const newLine = [NSString stringWithUTF8String:_inBuffer.bytes];
|
||
const NSRange nullTerminatorRange = NSMakeRange(0, nullTerminatorIndex + 1);
|
||
|
||
[_inBuffer replaceBytesInRange:nullTerminatorRange withBytes:NULL length:0];
|
||
[_lineProcessor process:newLine];
|
||
}
|
||
|
||
NSLog(@"Finished processing inBuffer");
|
||
}
|
||
|
||
@end
|