//OpenSCADA module Special.FLibSYS file: sysfnc.h
/***************************************************************************
 *   Copyright (C) 2005-2023 by Roman Savochenko, <roman@oscada.org>       *
 *                                                                         *
 *   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; version 2 of the License.               *
 *                                                                         *
 *   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.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef SYSFNC_H
#define SYSFNC_H

#include <time.h>
#include <stdint.h>

#include <tfunction.h>

#include "statfunc.h"

#if HAVE_OPENSSL_SSL_H
# include "openssl/ssl.h"
# if OPENSSL_VERSION_NUMBER < 0x10100000L
#  include <openssl/md5.h>
# endif
#endif

namespace FLibSYS
{

//*************************************************
//* System access functions                       *

//*************************************************
//* System's commands call                        *
//*************************************************
class sysCall : public TFunction
{
    public:
	sysCall( ) : TFunction("sysCall",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return|IO::FullText));
	    ioAdd(new IO("com",trS("Command"),IO::String,IO::Default));
	}

	string name( )	{ return _("SYS: Call"); }
	string descr( )	{ return _("Calling the console commands of the OS. "
	    "The function offers great opportunities to the OpenSCADA user by calling any system software, utilities and scripts, "
	    "as well as getting the access to the huge volume of system data by means of them."); }

	void calc( TValFunc *val ) {
	    FILE *fp = popen(val->getS(1).c_str(), "r");
	    if(!fp) return;

	    char buf[prmStrBuf_SZ];
	    string rez;
	    for(int r_cnt = 0; (r_cnt=fread(buf,1,sizeof(buf),fp)); )
		rez.append(buf,r_cnt);

	    pclose(fp);
	    val->setS(0, rez);
	}
};

//*************************************************
//* SQL request to DB                             *
//*************************************************
class dbReqSQL : public TFunction
{
    public:
	dbReqSQL( ) : TFunction("dbReqSQL",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::Object,IO::Return));
	    ioAdd(new IO("addr",trS("DB address, \"{TypeDB}.{DB}\""),IO::String,IO::Default));
	    ioAdd(new IO("req",trS("SQL request"),IO::String,IO::Default));
	    ioAdd(new IO("trans",trS("Transaction"),IO::Boolean,IO::Default,i2s(EVAL_BOOL).c_str()));
	}

	string name( )	{ return _("DB: SQL request"); }
	string descr( )	{ return _("Formation of the SQL-request <req> to the DB <addr>, "
	    "inside (<trans>=true), outside (<trans>=false) or no matter (<trans>=EVAL) to the transaction. "
	    "At an error the result's property \"err\" sets to the error value."); }

	void calc( TValFunc *val ) {
	    string sdb = TBDS::realDBName(val->getS(1));
	    TArrayObj *rez = new TArrayObj();
	    try {
		vector< vector<string> > rtbl;
		AutoHD<TBD> db = SYS->db().at().nodeAt(sdb,0,'.');
		db.at().sqlReq(val->getS(2), &rtbl, val->getB(3));
		for(unsigned iR = 0; iR < rtbl.size(); iR++) {
		    TArrayObj *row = new TArrayObj();
		    for(unsigned iC = 0; iC < rtbl[iR].size(); iC++) {
			row->arSet(iC, rtbl[iR][iC]);
			if(iR) row->TVarObj::propSet(rtbl[0][iC], rtbl[iR][iC]);
		    }
		    rez->arSet(iR, row);
		}
	    } catch(TError &err)	{ rez->propSet("err", err.cat+":"+err.mess); }

	    val->setO(0, rez);
	}
};

//*************************************************
//* Messages function.                            *

//*************************************************
//* Get message                                   *
//*************************************************
class messGet : public TFunction
{
    public:
	messGet( ) : TFunction("messGet", SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::Object,IO::Return));
	    ioAdd(new IO("btm",trS("Begin time, seconds"),IO::Integer,IO::Default));
	    ioAdd(new IO("etm",trS("End time, seconds"),IO::Integer,IO::Default));
	    ioAdd(new IO("cat",trS("Category"),IO::String,IO::Default));
	    ioAdd(new IO("lev",trS("Level"),IO::Integer,IO::Default));
	    ioAdd(new IO("arch",trS("Archiver"),IO::String,IO::Default));
	}

	string name( )	{ return _("Mess: Get"); }
	string descr( )	{ return _("Get messages of the program."); }

	void calc( TValFunc *val ) {
	    vector<TMess::SRec> recs;
	    SYS->archive().at().messGet(val->getI(1), val->getI(2), recs, val->getS(3), val->getI(4), val->getS(5));
	    TArrayObj *rez = new TArrayObj();
	    for(unsigned i_m = 0; i_m < recs.size(); i_m++) {
		TVarObj *am = new TVarObj();
		am->propSet("tm", (int)recs[i_m].time);
		am->propSet("utm", recs[i_m].utime);
		am->propSet("categ", recs[i_m].categ);
		am->propSet("level", recs[i_m].level);
		am->propSet("mess", recs[i_m].mess);
		rez->arSet(i_m, AutoHD<TVarObj>(am));
	    }
	    val->setO(0,rez);
	}
};

//*************************************************
//* Put message                                   *
//*************************************************
class messPut : public TFunction
{
    public:
	messPut( ) : TFunction("messPut", SSPC_ID) {
	    ioAdd(new IO("cat",trS("Category"),IO::String,IO::Default));
	    ioAdd(new IO("lev",trS("Level"),IO::Integer,IO::Default));
	    ioAdd(new IO("mess",trS("Message"),IO::String,IO::Default));
	}

	string name( )	{ return _("Mess: Put"); }
	string descr( )	{ return _("Put a message to the program."); }

	void calc( TValFunc *val ) {
	    message(val->getS(0).c_str(), (TMess::Type)val->getI(1), "%s", val->getS(2).c_str());
	}
};

//*************************************************
//* String manipulation functions                 *

//*************************************************
//* String size                                   *
//*************************************************
class strSize : public TFunction
{
    public:
	strSize( ) : TFunction("strSize",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::Integer,IO::Return));
	    ioAdd(new IO("str",trS("String"),IO::String,IO::Default));
	}

	string name( )	{ return _("String: Get size"); }
	string descr( )	{ return _("Getting size of the string."); }

	void calc( TValFunc *val ) { val->setI(0, val->getS(1).size()); }
};

//*************************************************
//* String substring                              *
//*************************************************
class strSubstr : public TFunction
{
    public:
	strSubstr( ) : TFunction("strSubstr",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return));
	    ioAdd(new IO("str",trS("String"),IO::String,IO::Default));
	    ioAdd(new IO("pos",trS("Position"),IO::Integer,IO::Default,"0"));
	    ioAdd(new IO("n"  ,trS("Number"),IO::Integer,IO::Default,"-1"));
	}

	string name( )	{ return _("String: Get substring"); }
	string descr( )	{ return _("Getting of the substring."); }

	void calc( TValFunc *val ) {
	    string vl  = val->getS(1);
	    int    pos = val->getI(2);
	    if(pos < 0 || pos >= (int)vl.size()) return;
	    int	   n   = val->getI(3);
	    if(n < 0)	n = vl.size();
	    n = vmin((int)vl.size()-pos,n);
	    val->setS(0,vl.substr(pos,n));
	}
};

//*************************************************
//* String insertion                              *
//*************************************************
class strInsert : public TFunction
{
    public:
	strInsert( ) : TFunction("strInsert",SSPC_ID) {
	    ioAdd(new IO("str",trS("String"),IO::String,IO::Output));
	    ioAdd(new IO("pos",trS("Position"),IO::Integer,IO::Default,"0"));
	    ioAdd(new IO("ins",trS("String to insert"),IO::String,IO::Default));
	}

	string name( )	{ return _("String: Insert a string to other string"); }
	string descr( )	{ return _("Inserting a string to another string."); }

	void calc( TValFunc *val ) {
	    string vl = val->getS(0);
	    int   pos = val->getI(1);
	    pos = vmax(0,vmin((int)vl.size(),pos));
	    val->setS(0,vl.insert(pos,val->getS(2)));
	}
};

//*************************************************
//* String replace                                *
//*************************************************
class strReplace : public TFunction
{
    public:
	strReplace( ) : TFunction("strReplace",SSPC_ID) {
	    ioAdd(new IO("str",trS("String"),IO::String,IO::Output));
	    ioAdd(new IO("pos",trS("Position"),IO::Integer,IO::Default,"0"));
	    ioAdd(new IO("n"  ,trS("Number"),IO::Integer,IO::Default,"-1"));
	    ioAdd(new IO("repl",trS("String to replace"),IO::String,IO::Default));
	}

	string name( )	{ return _("String: Replace a part of the string by another string"); }
	string descr( )	{ return _("Replacing a part of the string by another string."); }

	void calc( TValFunc *val ) {
	    string vl  = val->getS(0);
	    int    pos = val->getI(1);
	    if(pos < 0 || pos >= (int)vl.size()) return;
	    int	   n   = val->getI(2);
	    if(n < 0)	n = vl.size();
	    n = vmin((int)vl.size()-pos,n);
	    val->setS(0,vl.replace(pos,n,val->getS(3)));
	}
};

//*************************************************
//* String parsing on separator                   *
//*************************************************
class strParse : public TFunction
{
    public:
	strParse( ) : TFunction("strParse",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return));
	    ioAdd(new IO("str",trS("String"),IO::String,IO::Default));
	    ioAdd(new IO("lev",trS("Level"),IO::Integer,IO::Default));
	    ioAdd(new IO("sep",trS("Separator"),IO::String,IO::Default,"."));
	    ioAdd(new IO("off",trS("Offset"),IO::Integer,IO::Output));
	}

	string name( )	{ return _("String: Parse with a separator"); }
	string descr( )	{ return _("Parsing the string with a separator."); }

	void calc( TValFunc *val ) {
	    int off = val->getI(4);
	    val->setS(0, TSYS::strParse(val->getS(1),val->getI(2),val->getS(3),&off));
	    val->setI(4, off);
	}
};

//*************************************************
//* Path parsing                                  *
//*************************************************
class strParsePath : public TFunction
{
    public:
	strParsePath( ) : TFunction("strParsePath",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return));
	    ioAdd(new IO("path",trS("Path"),IO::String,IO::Default));
	    ioAdd(new IO("lev",trS("Level"),IO::Integer,IO::Default));
	    ioAdd(new IO("off",trS("Offset"),IO::Integer,IO::Output));
	}

	string name( )	{ return _("String: Parse of the path"); }
	string descr( )	{ return _("Parsing of the path for items."); }

	void calc( TValFunc *val ) {
	    int off = val->getI(3);
	    val->setS(0,TSYS::pathLev(val->getS(1),val->getI(2),true,&off));
	    val->setI(3,off);
	}
};

//*************************************************
//* Path string convert to separated string       *
//*************************************************
class strPath2Sep : public TFunction
{
    public:
	strPath2Sep( ) : TFunction("strPath2Sep",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return));
	    ioAdd(new IO("src",trS("Source"),IO::String,IO::Default));
	    ioAdd(new IO("sep",trS("Separator"),IO::String,IO::Default,"."));
	}

	string name( )	{ return _("String: Path to separated string"); }
	string descr( )	{ return _("Converting the path to the separated string."); }

	void calc( TValFunc *val ) {
	    val->setS(0,TSYS::path2sepstr(val->getS(1),val->getS(2).size()?val->getS(2)[0]:'.'));
	}
};

//*************************************************
//* String encode to HTML                         *
//*************************************************
class strEnc2HTML : public TFunction
{
    public:
	strEnc2HTML( ) : TFunction("strEnc2HTML",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return));
	    ioAdd(new IO("src",trS("Source"),IO::String,IO::Default));
	}

	string name( )	{ return _("String: Encode string to HTML"); }
	string descr( )	{ return _("Encoding the string to use into the HTML source."); }

	void calc( TValFunc *val ) { val->setS(0,TSYS::strEncode(val->getS(1),TSYS::Html)); }
};

//*************************************************
//* String encode to Bin                          *
//*************************************************
class strEnc2Bin : public TFunction
{
    public:
	strEnc2Bin( ) : TFunction("strEnc2Bin",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return));
	    ioAdd(new IO("src",trS("Source"),IO::String,IO::Default));
	}

	string name( )	{ return _("String: Encode text to binary"); }
	string descr( )	{ return _("Encoding the text to the binary, for the text format <00 A0 FA DE>."); }

	void calc( TValFunc *val ) { val->setS(0, TSYS::strEncode(val->getS(1),TSYS::Bin)); }
};

//*************************************************
//* String decode from Bin                        *
//*************************************************
class strDec4Bin : public TFunction
{
    public:
	strDec4Bin( ) : TFunction("strDec4Bin",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return));
	    ioAdd(new IO("src",trS("Source"),IO::String,IO::Default));
	    ioAdd(new IO("sep",trS("Separator"),IO::String,IO::Default," "));
	}

	string name( )	{ return _("String: Decode text from binary"); }
	string descr( )	{ return _("Decoding the text from the binary, for the text format <00 A0 FA DE>."); }

	void calc( TValFunc *val ) { val->setS(0, TSYS::strDecode(val->getS(1),TSYS::Bin,val->getS(2))); }
};

//*************************************************
//* Convert real to string                        *
//*************************************************
class real2str : public TFunction
{
    public:
	real2str( ) : TFunction("real2str",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return));
	    ioAdd(new IO("val",trS("Value"),IO::Real,IO::Default));
	    ioAdd(new IO("prc",trS("Precision"),IO::Integer,IO::Default,"4"));
	    ioAdd(new IO("tp",trS("Type"),IO::String,IO::Default,"f"));
	}

	string name( )	{ return _("String: Real to string"); }
	string descr( )	{ return _("Converting the real value to the string format."); }

	void calc( TValFunc *val ) {
	    val->setS(0, r2s(val->getR(1),val->getI(2),val->getS(3).size()?val->getS(3)[0]:'f'));
	}
};

//*************************************************
//* Convert integer to string                     *
//*************************************************
class int2str : public TFunction
{
    public:
	int2str( ) : TFunction("int2str",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return));
	    ioAdd(new IO("val",trS("Value"),IO::Integer,IO::Default));
	    ioAdd(new IO("base",trS("Base (8, 10, 16)"),IO::Integer,IO::Default,"10"));
	}

	string name( )	{ return _("String: Integer to string"); }
	string descr( )	{ return _("Converting the integer value to the string format."); }

	void calc( TValFunc *val ) {
	    switch(val->getI(2))
	    {
		case 8:	val->setS(0, ll2s(val->getI(1),TSYS::Oct));	break;
		case 10:val->setS(0, ll2s(val->getI(1),TSYS::Dec));	break;
		case 16:val->setS(0, ll2s(val->getI(1),TSYS::Hex));	break;
		default: val->setS(0,"");
	    }
	}
};

//*************************************************
//* Convert string to real                        *
//*************************************************
class str2real : public TFunction
{
    public:
	str2real( ) : TFunction("str2real",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::Real,IO::Return));
	    ioAdd(new IO("val",trS("Value"),IO::String,IO::Default));
	}

	string name( )	{ return _("String: String to real"); }
	string descr( )	{ return _("Converting the string value to the real format."); }

	void calc( TValFunc *val )	{ val->setR(0,s2r(val->getS(1))); }
};

//*************************************************
//* Convert string to integer                     *
//*************************************************
class str2int : public TFunction
{
    public:
	str2int( ) : TFunction("str2int",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::Integer,IO::Return));
	    ioAdd(new IO("val",trS("Value"),IO::String,IO::Default));
	    ioAdd(new IO("base",trS("Base (2...36)"),IO::Integer,IO::Default,"0"));
	}

	string name( )	{ return _("String: String to integer"); }
	string descr( )	{ return _("Converting the string value to the integer format."); }

	void calc( TValFunc *val )	{ val->setI(0, strtoll(val->getS(1).c_str(),NULL,val->getI(2))); }
};

//*************************************************
//* Split float to words                          *
//*************************************************
class floatSplitWord : public TFunction
{
    public:
	floatSplitWord( ) : TFunction("floatSplitWord",SSPC_ID) {
	    ioAdd(new IO("val",trS("Value"),IO::Real,IO::Default));
	    ioAdd(new IO("w1",trS("Word 1"),IO::Integer,IO::Output));
	    ioAdd(new IO("w2",trS("Word 2"),IO::Integer,IO::Output));
	}

	string name( )	{ return _("Float: Split to the words"); }
	string descr( )	{ return _("Splitting the float value (4 bytes) to the two words (2 bytes)."); }

	void calc( TValFunc *val ) {
	    union { uint32_t i; float f; } wl;
	    wl.f = val->getR(0);
	    val->setI(1,wl.i&0xFFFF);
	    val->setI(2,(wl.i>>16)&0xFFFF);
	}
};

//*************************************************
//* Merge float from words                        *
//*************************************************
class floatMergeWord : public TFunction
{
    public:
	floatMergeWord( ) : TFunction("floatMergeWord",SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::Real,IO::Return));
	    ioAdd(new IO("w1",trS("Word 1"),IO::Integer,IO::Default));
	    ioAdd(new IO("w2",trS("Word 2"),IO::Integer,IO::Default));
	}

	string name( )	{ return _("Float: Merge from the words"); }
	string descr( )	{ return _("Forming the float value (4 bytes) from the two words (2 bytes)."); }

	void calc( TValFunc *val ) {
	    union { uint32_t i; float f; } wl;
	    wl.i = ((val->getI(2)&0xffff)<<16) | (val->getI(1)&0xffff);
	    val->setR(0,wl.f);
	}
};

//*******************************************************
//* Extract mantissa and exponent from the float value. *
//*******************************************************
class floatExtract : public TFunction
{
    public:
	floatExtract( ) : TFunction("floatExtract", SSPC_ID) {
	    ioAdd(new IO("magn",trS("Magnitude"),IO::Real,IO::Return));
	    ioAdd(new IO("val",trS("Value"),IO::Real,IO::Default));
	    ioAdd(new IO("exp",trS("Exponent"),IO::Integer,IO::Output));
	}

	string name( )	{ return _("Float: Extract"); }
	string descr( )	{ return _("Extracting for mantissa and exponent from the float value."); }

	void calc( TValFunc *val ) {
	    int exp = 0;
	    val->setR(0, frexp(val->getR(1),&exp));
	    val->setI(2, exp);
	}
};

//*************************************************
//* Cyclic redundancy check                       *
//*************************************************
class CRC : public TFunction
{
    public:
	CRC( ) : TFunction("CRC", SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::Integer,IO::Return));
	    ioAdd(new IO("data",trS("Data"),IO::String,IO::Default));
	    ioAdd(new IO("width",trS("Width"),IO::Integer,IO::Default,"16"));
	    ioAdd(new IO("poly",trS("Polynomial"),IO::Integer,IO::Default,"32773"));	//0x8005
	    ioAdd(new IO("init",trS("Initial"),IO::Integer,IO::Default,"-1"));	//0xFFFFFFFFFFFFFFFF
	    ioAdd(new IO("RefIn",trS("Reference input"),IO::Boolean,IO::Default,"1"));
	    ioAdd(new IO("RefOut",trS("Reference output"),IO::Boolean,IO::Default,"1"));
	    ioAdd(new IO("XorOut",trS("XOR for output"),IO::Integer,IO::Default,"0"));
	}

	string name( )	{ return _("Cyclic Redundancy Code (CRC)"); }
	string descr( )	{ return _("Unified and completed implementing of the Cyclic Redundancy Code "
	    "for the width in 1-64 bits with normal polynomial, the initial CRC, "
	    "the input and output reference, and the XOR for output.\n"
	    "The previous notation of the function is supported also, where the reversed polynomial is placed in the <width> place!"); }

	uint64_t reflect( uint64_t crc, int wdth ) {
	    uint64_t rez = 0;
	    for(int i = 0; i < wdth; i++)
		rez |= ((crc>>i)&1) << (wdth-i-1);
	    return rez;
	}

	void calc( TValFunc *val ) {
	    //Input parameters
	    uint64_t wdth = val->getI(2);
	    uint64_t pat = val->getI(3);
	    // Old fashion prototype compability with using reversed pattern
	    if((wdth < 1 || wdth > 64) && pat >= 1 && pat <= 64) { char wdth_ = pat; pat = wdth; wdth = wdth_; }
	    else if(wdth < 1 || wdth > 64) { val->setI(0, 0); return; }
	    else pat = reflect(pat, wdth);
	    uint64_t mask = 0xFFFFFFFFFFFFFFFFull >> (64-wdth);
	    pat = pat & mask;
	    uint64_t CRC = val->getI(4) & mask;
	    bool RefIn = val->getB(5);
	    bool RefOut = val->getB(6);
	    uint64_t XorOut = val->getI(7) & mask;
	    string data = val->getS(1);
	    //Same calculation
	    for(unsigned i = 0; i < data.size(); i++) {
		CRC ^= RefIn ? (uint8_t)data[i] : reflect((uint8_t)data[i],8);
		for(char j = 0; j < 8; ++j) CRC = (CRC&1) ? (CRC>>1)^pat : (CRC>>1);
	    }
	    if(!RefOut)	CRC = reflect(CRC, wdth);
	    val->setI(0, (int64_t)((CRC&mask)^XorOut));
	}
};

#if HAVE_OPENSSL_SSL_H
//*************************************************
//* Message Digest 5                              *
//*************************************************
class MD5 : public TFunction
{
    public:
	MD5( ) : TFunction("MD5", SSPC_ID) {
	    ioAdd(new IO("rez",trS("Result"),IO::String,IO::Return));
	    ioAdd(new IO("data",trS("Data"),IO::String,IO::Default));
	}

	string name( )	{ return _("Message Digest 5 (MD5)"); }
	string descr( )	{ return _("Calculating for the message Digest 5 of the <data>."); }

	void calc( TValFunc *val ) {
	    string data = val->getS(1);

# if OPENSSL_VERSION_NUMBER >= 0x10100000L
	    EVP_MD_CTX *mdctx = EVP_MD_CTX_new();
	    EVP_DigestInit_ex(mdctx, EVP_md5(), NULL);
	    EVP_DigestUpdate(mdctx, (unsigned char*)data.data(), data.size());
	    unsigned int result_len = EVP_MD_size(EVP_md5());
	    unsigned char *result = (unsigned char *)OPENSSL_malloc(result_len);
	    EVP_DigestFinal_ex(mdctx, result, &result_len);
	    EVP_MD_CTX_free(mdctx);
# else
	    unsigned int result_len = MD5_DIGEST_LENGTH;
	    unsigned char result[result_len];
	    ::MD5((unsigned char*)data.data(), data.size(), result);
# endif
	    val->setS(0, string((char*)result, result_len));
	}
};
#endif

}

#endif //SYSFNC_H