File indexing completed on 2023-09-24 04:04:40

 /*  -*- C++ -*-
  *  Copyright (C) 2003-2005 Thiago Macieira <thiago@kde.org>
  *
  *
  *  Permission is hereby granted, free of charge, to any person obtaining
  *  a copy of this software and associated documentation files (the
  *  "Software"), to deal in the Software without restriction, including
  *  without limitation the rights to use, copy, modify, merge, publish,
  *  distribute, sublicense, and/or sell copies of the Software, and to
  *  permit persons to whom the Software is furnished to do so, subject to
  *  the following conditions:
  *
  *  The above copyright notice and this permission notice shall be included
  *  in all copies or substantial portions of the Software.
  *
  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
 #include "k3socketbase.h"
 
 #include <config-network.h>
 #include <QMutex>
 #include <klocalizedstring.h>
 
 #include "k3socketdevice.h"
 
 #ifdef Q_OS_WIN
 #include <winsock2.h>
 
 void KNetwork_initSocket()
 {
     static bool hasStarted = false;
     if (!hasStarted) {
         WSADATA wsaData;
         WORD wVersionRequested = MAKEWORD(2, 2);
         WSAStartup(wVersionRequested, &wsaData);
         hasStarted = true;
     }
 }
 #endif
 
 using namespace KNetwork;
 
 class KNetwork::KSocketBasePrivate
 {
 public:
     int socketOptions;
     int socketError;
     int capabilities;
 
     mutable KSocketDevice *device;
 
     QMutex mutex;
 
     KSocketBasePrivate()
         : mutex(QMutex::Recursive)      // create recursive
     { }
 };
 
 KSocketBase::KSocketBase()
     : d(new KSocketBasePrivate)
 {
     d->socketOptions = Blocking;
     d->socketError = 0;
     d->device = nullptr;
     d->capabilities = 0;
 #ifdef Q_OS_WIN
     KNetwork_initSocket();
 #endif
 }
 
 KSocketBase::~KSocketBase()
 {
     delete d->device;
     delete d;
 }
 
 bool KSocketBase::setSocketOptions(int opts)
 {
     d->socketOptions = opts;
     return true;
 }
 
 int KSocketBase::socketOptions() const
 {
     return d->socketOptions;
 }
 
 bool KSocketBase::setBlocking(bool enable)
 {
     return setSocketOptions((socketOptions() & ~Blocking) | (enable ? Blocking : 0));
 }
 
 bool KSocketBase::blocking() const
 {
     return socketOptions() & Blocking;
 }
 
 bool KSocketBase::setAddressReuseable(bool enable)
 {
     return setSocketOptions((socketOptions() & ~AddressReuseable) | (enable ? AddressReuseable : 0));
 }
 
 bool KSocketBase::addressReuseable() const
 {
     return socketOptions() & AddressReuseable;
 }
 
 bool KSocketBase::setIPv6Only(bool enable)
 {
     return setSocketOptions((socketOptions() & ~IPv6Only) | (enable ? IPv6Only : 0));
 }
 
 bool KSocketBase::isIPv6Only() const
 {
     return socketOptions() & IPv6Only;
 }
 
 bool KSocketBase::setBroadcast(bool enable)
 {
     return setSocketOptions((socketOptions() & ~Broadcast) | (enable ? Broadcast : 0));
 }
 
 bool KSocketBase::broadcast() const
 {
     return socketOptions() & Broadcast;
 }
 
 bool KSocketBase::setNoDelay(bool enable)
 {
     return setSocketOptions((socketOptions() & ~NoDelay) | (enable ? NoDelay : 0));
 }
 
 bool KSocketBase::noDelay() const
 {
     return socketOptions() & NoDelay;
 }
 
 KSocketDevice *KSocketBase::socketDevice() const
 {
     if (d->device) {
         return d->device;
     }
 
     // it doesn't exist, so create it
     QMutexLocker locker(mutex());
     if (d->device) {
         return d->device;
     }
 
     KSocketBase *that = const_cast<KSocketBase *>(this);
     KSocketDevice *dev = nullptr;
     if (d->capabilities) {
         dev = KSocketDevice::createDefault(that, d->capabilities);
     }
     if (!dev) {
         dev = KSocketDevice::createDefault(that);
     }
     that->setSocketDevice(dev);
     return d->device;
 }
 
 void KSocketBase::setSocketDevice(KSocketDevice *device)
 {
     QMutexLocker locker(mutex());
     if (d->device == nullptr) {
         d->device = device;
     }
 }
 
 int KSocketBase::setRequestedCapabilities(int add, int remove)
 {
     d->capabilities |= add;
     d->capabilities &= ~remove;
     return d->capabilities;
 }
 
 bool KSocketBase::hasDevice() const
 {
     return d->device != nullptr;
 }
 
 void KSocketBase::setError(SocketError error)
 {
     d->socketError = error;
 }
 
 void KSocketBase::resetError()
 {
     d->socketError = NoError;
 }
 
 KSocketBase::SocketError KSocketBase::error() const
 {
     return static_cast<KSocketBase::SocketError>(d->socketError);
 }
 
 QString KSocketBase::errorString() const
 {
     return errorString(error());
 }
 
 // static
 QString KSocketBase::errorString(KSocketBase::SocketError code)
 {
     QString reason;
     switch (code) {
     case NoError:
         reason = i18nc("Socket error code NoError", "no error");
         break;
 
     case LookupFailure:
         reason = i18nc("Socket error code LookupFailure",
                        "name lookup has failed");
         break;
 
     case AddressInUse:
         reason = i18nc("Socket error code AddressInUse",
                        "address already in use");
         break;
 
     case AlreadyBound:
         reason = i18nc("Socket error code AlreadyBound",
                        "socket is already bound");
         break;
 
     case AlreadyCreated:
         reason = i18nc("Socket error code AlreadyCreated",
                        "socket is already created");
         break;
 
     case NotBound:
         reason = i18nc("Socket error code NotBound",
                        "socket is not bound");
         break;
 
     case NotCreated:
         reason = i18nc("Socket error code NotCreated",
                        "socket has not been created");
         break;
 
     case WouldBlock:
         reason = i18nc("Socket error code WouldBlock",
                        "operation would block");
         break;
 
     case ConnectionRefused:
         reason = i18nc("Socket error code ConnectionRefused",
                        "connection actively refused");
         break;
 
     case ConnectionTimedOut:
         reason = i18nc("Socket error code ConnectionTimedOut",
                        "connection timed out");
         break;
 
     case InProgress:
         reason = i18nc("Socket error code InProgress",
                        "operation is already in progress");
         break;
 
     case NetFailure:
         reason = i18nc("Socket error code NetFailure",
                        "network failure occurred");
         break;
 
     case NotSupported:
         reason = i18nc("Socket error code NotSupported",
                        "operation is not supported");
         break;
 
     case Timeout:
         reason = i18nc("Socket error code Timeout",
                        "timed operation timed out");
         break;
 
     case UnknownError:
         reason = i18nc("Socket error code UnknownError",
                        "an unknown/unexpected error has happened");
         break;
 
     case RemotelyDisconnected:
         reason = i18nc("Socket error code RemotelyDisconnected",
                        "remote host closed connection");
         break;
 
     default:
         reason.clear();
         break;
     }
 
     return reason;
 }
 
 // static
 bool KSocketBase::isFatalError(int code)
 {
     switch (code) {
     case WouldBlock:
     case InProgress:
     case NoError:
     case RemotelyDisconnected:
         return false;
     }
 
     return true;
 }
 
 void KSocketBase::unsetSocketDevice()
 {
     d->device = nullptr;
 }
 
 QMutex *KSocketBase::mutex() const
 {
     return &d->mutex;
 }
 
 KActiveSocketBase::KActiveSocketBase(QObject *parent)
     : QIODevice(parent)
 {
 }
 
 KActiveSocketBase::~KActiveSocketBase()
 {
 }
 
 QString KActiveSocketBase::errorString() const
 {
     return QIODevice::errorString();
 }
 
 bool KActiveSocketBase::open(OpenMode mode)
 {
     QIODevice::open(mode);
     if (mode != QIODevice::NotOpen) {
         QIODevice::seek(0);    // clear unget buffers
     }
     return true;
 }
 
 void KActiveSocketBase::setSocketDevice(KSocketDevice *dev)
 {
     KSocketBase::setSocketDevice(dev);
     KActiveSocketBase::open(dev->openMode());
 }
 
 bool KActiveSocketBase::isSequential() const
 {
     return true;
 }
 
 qint64 KActiveSocketBase::size() const
 {
     return 0;
 }
 
 qint64 KActiveSocketBase::pos() const
 {
     return 0;
 }
 
 bool KActiveSocketBase::seek(qint64)
 {
     return false;
 }
 
 bool KActiveSocketBase::atEnd() const
 {
     return true;
 }
 
 qint64 KActiveSocketBase::read(char *data, qint64 maxlen)
 {
     return QIODevice::read(data, maxlen);
 }
 
 QByteArray KActiveSocketBase::read(qint64 len)
 {
     return QIODevice::read(len);
 }
 
 qint64 KActiveSocketBase::read(char *data, qint64 len, KSocketAddress &from)
 {
     // FIXME TODO: implement unget buffers
     return readData(data, len, &from);
 }
 
 qint64 KActiveSocketBase::peek(char *data, qint64 len)
 {
     return peekData(data, len, nullptr);
 }
 
 qint64 KActiveSocketBase::peek(char *data, qint64 len, KSocketAddress &from)
 {
     return peekData(data, len, &from);
 }
 
 qint64 KActiveSocketBase::write(const char *data, qint64 len)
 {
     return QIODevice::write(data, len);
 }
 
 qint64 KActiveSocketBase::write(const QByteArray &data)
 {
     return QIODevice::write(data);
 }
 
 qint64 KActiveSocketBase::write(const char *data, qint64 len,
                                 const KSocketAddress &to)
 {
     return writeData(data, len, &to);
 }
 
 void KActiveSocketBase::ungetChar(char)
 {
     return;
 }
 
 qint64 KActiveSocketBase::readData(char *data, qint64 len)
 {
     return readData(data, len, nullptr);
 }
 
 qint64 KActiveSocketBase::writeData(const char *data, qint64 len)
 {
     return writeData(data, len, nullptr);
 }
 
 void KActiveSocketBase::setError(SocketError error)
 {
     KSocketBase::setError(error);
     setErrorString(KSocketBase::errorString());
 }
 
 void KActiveSocketBase::resetError()
 {
     KSocketBase::setError(NoError);
     setErrorString(QString());
 }
 
 KPassiveSocketBase::KPassiveSocketBase()
 {
 }
 
 KPassiveSocketBase::~KPassiveSocketBase()
 {
 }
 
 #include "moc_k3socketbase.cpp"