QoreFtpClient.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    QoreFtpClient.h
 
    thread-safe Qore QoreFtpClient object
 
    Qore Programming Language
 
    Copyright (C) 2003 - 2024 Qore Technologies, s.r.o.
 
    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.
 
    Note that the Qore library is released under a choice of three open-source
    licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
    information.
*/
 
#ifndef _QORE_QOREFTPCLIENT_H
 
#define _QORE_QOREFTPCLIENT_H
 
#include <qore/InputStream.h>
#include <qore/OutputStream.h>
 
#define DEFAULT_FTP_CONTROL_PORT  21
#define DEFAULT_FTP_DATA_PORT     20
 
#define DEFAULT_USERNAME "anonymous"
#define DEFAULT_PASSWORD "[email protected]"
 
class FtpResp;
class Queue;
 
 
class QoreFtpClient {
    friend class qore_ftp_private;
public:
 
    DLLEXPORT QoreFtpClient(const QoreString *url, ExceptionSink* xsink);
 
    DLLEXPORT QoreFtpClient();
 
    DLLEXPORT ~QoreFtpClient();
 
 
    DLLEXPORT int connect(ExceptionSink* xsink);
 
 
    DLLEXPORT int disconnect();
 
 
    DLLEXPORT int cwd(const char* dir, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreStringNode* pwd(ExceptionSink* xsink);
 
 
    DLLEXPORT int put(const char* localpath, const char* remotename, ExceptionSink* xsink);
 
 
    DLLEXPORT int put(InputStream* is, const char* remotename, ExceptionSink* xsink);
 
 
    DLLEXPORT int get(const char* remotepath, const char* localname, ExceptionSink* xsink);
 
 
    DLLEXPORT int get(const char* remotepath, OutputStream* os, ExceptionSink* xsink);
 
 
    DLLEXPORT int putData(const void* data, size_t len, const char* remotename, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreStringNode* getAsString(const char* remotepath, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreStringNode* getAsString(ExceptionSink* xsink, const char* remotepath,
            const QoreEncoding* encoding = QCS_DEFAULT);
 
 
    DLLEXPORT BinaryNode* getAsBinary(const char* remotepath, ExceptionSink* xsink);
 
 
    DLLEXPORT int rename(const char* from, const char* to, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreStringNode* list(const char* path, bool long_list, ExceptionSink* xsink);
 
 
    DLLEXPORT int del(const char* file, ExceptionSink* xsink);
 
 
    DLLEXPORT int mkdir(const char* remotepath, ExceptionSink* xsink);
 
 
    DLLEXPORT int rmdir(const char* remotepath, ExceptionSink* xsink);
 
    DLLEXPORT int getPort() const;
 
    DLLEXPORT const char* getUserName() const;
 
    DLLEXPORT const char* getPassword() const;
 
    DLLEXPORT const char* getHostName() const;
 
 
    DLLEXPORT void setURL(const QoreString *url, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreStringNode* getURL() const;
 
    DLLEXPORT void setPort(int p);
 
    DLLEXPORT void setUserName(const char* u);
 
    DLLEXPORT void setPassword(const char* p);
 
    DLLEXPORT void setHostName(const char* h);
 
 
    DLLEXPORT int setSecure();
 
 
    DLLEXPORT int setInsecure();
 
 
    DLLEXPORT int setInsecureData();
 
 
    DLLEXPORT bool isSecure() const;
 
 
    DLLEXPORT bool isDataSecure() const;
 
 
    DLLEXPORT bool isConnected() const;
 
 
    DLLEXPORT const char* getSSLCipherName() const;
 
 
    DLLEXPORT const char* getSSLCipherVersion() const;
 
    DLLEXPORT long verifyPeerCertificate() const;
 
    DLLEXPORT void setModeAuto();
 
    DLLEXPORT void setModeEPSV();
 
    DLLEXPORT void setModePASV();
 
    DLLEXPORT void setModePORT();
 
    DLLEXPORT const char* getMode() const;
 
    DLLEXPORT void clearWarningQueue(ExceptionSink* xsink);
    DLLEXPORT void setWarningQueue(ExceptionSink* xsink, int64 warning_ms, int64 warning_bs, Queue* wq, QoreValue arg, int64 min_ms = 1000);
    DLLEXPORT QoreHashNode* getUsageInfo() const;
    DLLEXPORT void clearStats();
 
 
    DLLEXPORT void setNetworkFamily(int family);
 
 
    DLLEXPORT int getNetworkFamily() const;
 
 
    DLLEXPORT QoreHashNode* getControlPeerInfo(ExceptionSink* xsink, bool host_lookup) const;
 
 
    DLLEXPORT QoreHashNode* getDataPeerInfo(ExceptionSink* xsink, bool host_lookup) const;
 
 
    DLLEXPORT QoreHashNode* getControlSocketInfo(ExceptionSink* xsink, bool host_lookup) const;
 
 
    DLLEXPORT QoreHashNode* getDataSocketInfo(ExceptionSink* xsink, bool host_lookup) const;
 
 
    DLLEXPORT QoreHashNode* sendControlMessage(const char* cmd, const char* arg, ExceptionSink* xsink);
 
 
    DLLLOCAL void setTimeout(int timeout_ms);
 
 
    DLLLOCAL int getTimeout() const;
 
    DLLLOCAL void setEventQueue(ExceptionSink* xsink, Queue* q, QoreValue arg, bool with_data);
 
    DLLLOCAL void setDataEventQueue(ExceptionSink* xsink, Queue* q, QoreValue arg, bool with_data);
 
    DLLLOCAL void setControlEventQueue(ExceptionSink* xsink, Queue* q, QoreValue arg, bool with_data);
 
    DLLLOCAL void cleanup(ExceptionSink* xsink);
 
protected:
    hashdecl qore_ftp_private* priv;
 
    DLLLOCAL QoreFtpClient(const QoreFtpClient&) = delete;
    DLLLOCAL QoreFtpClient& operator=(const QoreFtpClient&) = delete;
};
 
#endif // _QORE_QOREFTPCLIENT_H