FilePoller.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  FilePoller.qm Copyright (C) 2014 - 2023 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
 
 
 
 
namespace FilePoller {
 
const EVENT_FILE = "file-event";
 
public hashdecl FilePollerFileEventInfo {
    int dev;
 
    int inode;
 
 
    int mode;
 
    int nlink;
 
    int uid;
 
    int gid;
 
    int rdev;
 
    int size;
 
    date atime;
 
    date mtime;
 
    date ctime;
 
 
    int blksize;
 
 
    int blocks;
 
 
    string type;
 
    string perm;
 
    string name;
 
    string filepath;
 
    *string link;
};
 
class FilePoller {
 
public:
        const OrderAsc = 0;
        const OrderDesc = 1;
 
        const SortNone = 0;
        const SortName = 1;
        const SortDate = 2;
 
        const Options = ...;
 
 
        const RequiredKeys = ...;
 
 
protected:
        string path;
 
        string mask;
 
        int poll_interval = 10;
 
        bool runflag = False;
 
        bool fatal = False;
 
        int pollcnt = 0;
 
        int sort_type = SortName;
 
        int sort_order = OrderAsc;
 
        Qore::Thread::Mutex m();
 
        int tid;
 
        Qore::Thread::Counter sc();
 
        int reopt;
 
        *softint minage;
 
        *code log_info;
 
        *code log_detail;
 
        *code log_debug;
 
        *code start_thread;
 
        *code sleep;
 
public:
 
 
    constructor(string n_path, string n_mask, *hash<auto> n_opts);
 
 
    destructor();
 
 
 
    list<hash<FilePollerFileEventInfo>> getFiles(int sort = FilePoller::SortNone, int order = FilePoller::OrderAsc);
 
 
 
    int start();
 
 
 
    stop();
 
 
 
    stopNoWait();
 
 
 
    waitStop();
 
 
 
    startInline();
 
 
    bool runOnce();
 
 
protected:
     fileSleep(softint secs);
public:
 
 
protected:
     run();
public:
 
 
 
    fileEvent(list<hash<FilePollerFileEventInfo>> files);
 
 
 
    abstract singleFileEvent(hash<FilePollerFileEventInfo> event);
 
 
      static checkPath(string path, string type, bool write = False);
 
    int getPollCount();
 
 
protected:
     logInfo(string fmt);
public:
 
 
protected:
     logDetail(string fmt);
public:
 
 
protected:
     logDebug(string fmt);
public:
 
};
 
 
class FilePollerDataProviderBase : public DataProvider::AbstractDataProvider {
 
public:
        const ConstructorOptions = {
            "path": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "A path giving the location of the directory to poll",
                "required": True,
            },
 
            "mask": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "The glob mask to use; will be treated as a regex if `regex` is `true`",
                "default_value": "*",
            },
 
            "poll_interval": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(IntType),
                "desc": "The interval in seconds between polling for files",
                "default_value": 10,
            },
 
            "regex": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(BoolType),
                "desc": "If `true` then `mask` is treated as a regular expression instead of a glob pattern",
            },
 
            "reopt": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(IntType),
                "desc": "A bitfield of regular expression options (`1` = ignore case, `2` = treat EOL as a regular "
                    "character); ignored if `regex` is not `true`",
            },
 
            "minage": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(IntType),
                "desc": "An integer giving the minimum file age in seconds before the file will be polled; this is "
                    "meant to work around non-atomic file transfer operations",
            },
 
            "sort_desc": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(BoolType),
                "desc": "Sort descending; if not given then an ascending sort is assumed if a `sort_type` is given",
            },
 
            "sort_type": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "Either `name` or `date` for the data to use for sorting",
            },
        };
 
protected:
        EmbeddedFilePoller poller;
 
public:
 
    constructor(*hash<auto> options);
 
 
    destructor();
 
 
    string getName();
 
 
    *string getDesc();
 
 
 
protected:
     hash<string, hash<DataProviderMessageInfo>> getEventTypesImpl();
public:
 
};
 
 
class FilePollerDataProvider : public FilePollerDataProviderBase, public DataProvider::Observable {
 
public:
        const ProviderInfo = <DataProviderInfo>{
            "type": "FilePollerDataProvider",
            "supports_observable": True,
            "constructor_options": ConstructorOptions,
        };
 
    constructor(*hash<auto> options) ;
 
 
protected:
     hash<DataProviderInfo> getStaticInfoImpl();
public:
 
};
 
 
class FileDelayedPollerDataProvider : public FilePollerDataProviderBase, public DataProvider::DelayedObservable {
 
public:
        const ProviderInfo = <DataProviderInfo>{
            "type": "FileDelayedPollerDataProvider",
            "supports_observable": True,
            "constructor_options": ConstructorOptions,
        };
 
    constructor(*hash<auto> options) ;
 
 
 
    observersReady();
 
 
protected:
     hash<DataProviderInfo> getStaticInfoImpl();
public:
 
};
 
class FilePollerFileEventInfoDataType : public HashDataType {
 
public:
        const FieldDescriptions = {
            "dev": "The device inode number the file is on",
            "inode": "The inode of the file",
            "mode": "The file protection mode; a bitfield of file permissions",
            "nlink": "The number of hard links to this file",
            "uid": "The UID of the owner of the file",
            "gid": "The GID of the owner of the file",
            "rdev": "The device type number",
            "size": "the size of the file in bytes",
            "atime": "the last accessed date/time of the file",
            "mtime": "the last modified date/time of the file",
            "ctime": "the created date/time of the file",
            "blksize": "Block size; is zero if the file is zero length or if the platform's internal `stat()` (2) "
                "function does not provide this info",
            "blocks": "Blocks allocated for the file; is zero if the file is zero length or if the platform's "
                "internal `stat()` (2) function does not provide this info",
            "type": "the type of file; one of:\n- `REGULAR`\n- `DIRECTORY`\n- `SYMBOLIC-LINK`\n"
                "- `BLOCK-DEVICE`\n- `CHARACTER-DEVICE`\n- `FIFO`\n- `SYMBOLIC-LINK`\n- `SOCKET`\n"
                "- `UNKNOWN`",
            "perm": "a string giving UNIX-style permissions for the file (ex: `-rwxr-xr-x`)",
            "name": "the name of the file, link, or directory",
            "filepath": "the remote filepath relative to SFILE root directory",
            "link": "symbolic link target (if present)",
        };
 
    constructor();
 
};
 
class FilePollerDataProviderFactory : public AbstractDataProviderFactory {
 
public:
protected:
        static Class cls = new Class("FileDelayedPollerDataProvider");
 
        const FactoryInfo = <DataProviderFactoryInfo>{
            "name": "filepoller",
            "desc": "File poller data provider factory",
            "children_can_support_observers": True,
        };
 
public:
 
 
protected:
     hash<DataProviderFactoryInfo> getInfoImpl();
public:
 
 
 
protected:
     hash<DataProviderInfo> getProviderInfoImpl();
public:
 
 
protected:
     Class getClassImpl();
public:
 
};
};
 
// private namespace; not exported
namespace Priv {
class EmbeddedFilePoller : public FilePoller {
 
public:
protected:
        Observable observable;
 
public:
 
    constructor(FilePollerDataProviderBase provider, string path, string mask, *hash<auto> options) ;
 
 
    singleFileEvent(hash<auto> event);
 
};
}