SftpPoller.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  SftpPoller.qm Copyright (C) 2014 - 2020 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.
*/
 
// make sure we have the required qore version
 
// assume local vars and do not allow $ chars
 
 
}
 
namespace SftpPoller {
class SftpPoller {
 
public:
        const OrderAsc = 0;
        const OrderDesc = 1;
 
        const SortNone = 0;
        const SortName = 1;
        //const SortDate = 2;
 
        const RequiredKeys = (
            "sleep",
            "start_thread",
        );
 
        const RequiredKeysWithHost = RequiredKeys + "host";
 
        const Defaults = {
            "port": 22,
            "mask": "*",
            "poll_interval": 10,
            "reopts": 0,
            "timeout": 30s,
            "binary": False,
            "writable": False,
            "check_file": "qore-sftp-check-file",
        };
 
        const OptionalKeys = (
            "path", "user", "pass", "keyfile", "regex_mask", "minage",
            "encoding", "log_info", "log_detail", "log_debug", "binary",
            "sleep",
            "start_thread",
            "skip_file_content_retrieval",
        );
 
        const AllKeys = RequiredKeysWithHost + Defaults.keys() + OptionalKeys;
 
        const ErrorDelay = 1m;
 
protected:
        string host;
 
        int port;
 
        string user;
 
        string url;
 
        *string pass;
 
        *string keyfile;
 
        softlist<string> path = ".";
 
        string rootSftpPath;
 
        *string mask;
 
        int poll_interval;
 
        bool runflag = False;
 
        bool get_files;
 
        bool fatal = False;
 
        int pollcnt = 0;
 
        Mutex m();
 
        int tid;
 
        timeout timeout;
 
        Counter sc();
 
        Qore::SSH2::SFTPClient sftp;
 
        int reopts = 0;
 
        *softint minage;
 
        *string encoding;
 
        *code log_info;
 
        *code log_detail;
 
        *code log_debug;
 
        *code start_thread;
 
        *code sleep;
 
        bool binary;
 
        bool writable;
 
        string check_file;
 
        *bool skip_file_content_retrieval;
 
public:
 
 
    constructor(Qore::SSH2::SFTPClient n_sftp, hash<auto> nconf);
 
 
 
    constructor(hash<auto> nconf);
 
 
    destructor();
 
 
    int getPollCount();
 
 
protected:
     logInfo(string fmt);
public:
 
 
protected:
     logDetail(string fmt);
public:
 
 
protected:
     logDebug(string fmt);
public:
 
 
protected:
     setMask();
public:
 
 
 
    int getStoreFile(string remote_path, string local_path, *timeout n_timeout);
 
 
    string getTextFile(string path, *timeout n_timeout, *string n_encoding);
 
 
    binary getFile(string path, *timeout n_timeout);
 
 
    rename(string old, string nnew, *timeout n_timeout);
 
 
    removeFile(string fn, *timeout n_timeout);
 
 
    *hash<Qore::SSH2::Ssh2StatInfo> stat(string path, *timeout n_timeout);
 
 
 
    checkRemotePath(string path, bool write = False, *timeout n_timeout);
 
 
 
    list<hash<SftpPollerFileEventInfo>> getFiles(int sort = SftpPoller::SortNone, int order = SftpPoller::OrderAsc);
 
 
 
    int start();
 
 
 
    stopNoWait();
 
 
 
    stop();
 
 
 
    waitStop();
 
 
 
    startInline();
 
 
    bool runOnce();
 
 
protected:
     sftpSleep(softint secs);
public:
 
 
protected:
     run();
public:
 
 
    *bool fileEvent(list<hash<SftpPollerFileEventInfo>> l);
 
 
 
    abstract singleFileEvent(hash<SftpPollerFileEventInfo> fih);
 
 
    abstract postSingleFileEvent(hash<SftpPollerFileEventInfo> fih);
 
 
      static checkPath(string path, string type, bool write = False);
};
};