TeaSpeak
/
TeaSpeakLibrary
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
TeaSpeakLibrary/src/Properties.h

842 lines
42 KiB
C++
Raw Blame History

#include <utility>
#pragma once
#include "misc/memtracker.h"
#include <ThreadPool/Mutex.h>
#include "Variable.h"
#include <map>
#include <deque>
#include <vector>
#include <memory>
#include <utility>
#include <vector>
#include <cstdint>
#include <any>
#include "misc/spin_lock.h"
#include "converters/converter.h"
#define PROPS_DEFINED
namespace ts {
namespace property {
enum PropertyType {
PROP_TYPE_SERVER = 0,
PROP_TYPE_CHANNEL = 1,
PROP_TYPE_GROUP = 2,
PROP_TYPE_CLIENT = 3,
PROP_TYPE_INSTANCE = 4,
PROP_TYPE_CONNECTION = 5,
PROP_TYPE_PLAYLIST = 6,
PROP_TYPE_UNKNOWN = 7
};
static constexpr const char *PropertyType_Names[7] = {
"SERVER",
"CHANNEL",
"GROUP",
"CLIENT",
"INSTANCE",
"CONNECTION",
"UNKNOWN"
};
enum ValueType {
TYPE_UNKNOWN,
TYPE_STRING,
TYPE_BOOL,
TYPE_SIGNED_NUMBER,
TYPE_UNSIGNED_NUMBER,
TYPE_FLOAT
};
typedef uint32_t flag_type;
enum flag : flag_type {
FLAG_BEGIN = 0b1,
FLAG_INTERNAL = FLAG_BEGIN << 1, //Just for internal usage
FLAG_GLOBAL = FLAG_INTERNAL << 1, //Not server bound
FLAG_SNAPSHOT = FLAG_GLOBAL << 1, //Saved within snapshots
FLAG_SAVE = FLAG_SNAPSHOT << 1, //Saved to database
FLAG_SAVE_MUSIC = FLAG_SAVE << 1, //Saved to database
FLAG_NEW = FLAG_SAVE_MUSIC << 1, //Its a non TeamSpeak property
FLAG_SERVER_VARIABLE = FLAG_NEW << 1,
FLAG_SERVER_VIEW = FLAG_SERVER_VARIABLE << 1,
FLAG_CLIENT_VARIABLE = FLAG_SERVER_VIEW << 1,
FLAG_CLIENT_VIEW = FLAG_CLIENT_VARIABLE << 1,
FLAG_CLIENT_INFO = FLAG_CLIENT_VIEW << 1,
FLAG_CHANNEL_VARIABLE = FLAG_CLIENT_INFO << 1,
FLAG_CHANNEL_VIEW = FLAG_CHANNEL_VARIABLE << 1,
FLAG_GROUP_VIEW = FLAG_CHANNEL_VIEW << 1,
FLAG_INSTANCE_VARIABLE = FLAG_GROUP_VIEW << 1,
FLAG_USER_EDITABLE = FLAG_INSTANCE_VARIABLE << 1,
FLAG_PLAYLIST_VARIABLE = FLAG_USER_EDITABLE << 1,
};
static constexpr const char *flag_names[sizeof(flag) * 8] =
{"UNDEFINED", "FLAG_INTERNAL", "FLAG_GLOBAL", "FLAG_SNAPSHOT", "FLAG_SAVE", "FLAG_SAVE_MUSIC", "FLAG_NEW",
"FLAG_SERVER_VARIABLE", "FLAG_SERVER_VIEW", "FLAG_CLIENT_VARIABLE", "FLAG_CLIENT_VIEW", "FLAG_CLIENT_INFO",
"FLAG_CHANNEL_VARIABLE", "FLAG_CHANNEL_VIEW", "FLAG_GROUP_VIEW", "FLAG_INSTANCE_VARIABLE", "FLAG_USER_EDITABLE","FLAG_PLAYLIST_VARIABLE"};
enum UnknownProperties {
UNKNOWN_UNDEFINED,
UNKNOWN_BEGINMARKER,
UNKNOWN_ENDMARKER = UNKNOWN_BEGINMARKER
};
enum InstanceProperties {
SERVERINSTANCE_UNDEFINED,
SERVERINSTANCE_BEGINMARKER,
SERVERINSTANCE_DATABASE_VERSION = SERVERINSTANCE_BEGINMARKER,
SERVERINSTANCE_FILETRANSFER_HOST,
SERVERINSTANCE_FILETRANSFER_PORT,
SERVERINSTANCE_QUERY_HOST,
SERVERINSTANCE_QUERY_PORT,
SERVERINSTANCE_MONTHLY_TIMESTAMP,
SERVERINSTANCE_MAX_DOWNLOAD_TOTAL_BANDWIDTH,
SERVERINSTANCE_MAX_UPLOAD_TOTAL_BANDWIDTH,
SERVERINSTANCE_SERVERQUERY_FLOOD_COMMANDS, //how many commands we can issue while in the SERVERINSTANCE_SERVERQUERY_FLOOD_TIME window
SERVERINSTANCE_SERVERQUERY_FLOOD_TIME, //time window in seconds for max command execution check
SERVERINSTANCE_SERVERQUERY_BAN_TIME, //how many seconds someone get banned if he floods
SERVERINSTANCE_TEMPLATE_SERVERADMIN_GROUP,
SERVERINSTANCE_TEMPLATE_SERVERDEFAULT_GROUP,
SERVERINSTANCE_TEMPLATE_CHANNELADMIN_GROUP,
SERVERINSTANCE_TEMPLATE_CHANNELDEFAULT_GROUP,
SERVERINSTANCE_TEMPLATE_MUSICDEFAULT_GROUP,
SERVERINSTANCE_GUEST_SERVERQUERY_GROUP,
SERVERINSTANCE_ADMIN_SERVERQUERY_GROUP,
SERVERINSTANCE_PERMISSIONS_VERSION,
SERVERINSTANCE_PENDING_CONNECTIONS_PER_IP,
SERVERINSTANCE_SPOKEN_TIME_TOTAL,
SERVERINSTANCE_SPOKEN_TIME_DELETED,
SERVERINSTANCE_SPOKEN_TIME_ALIVE,
SERVERINSTANCE_SPOKEN_TIME_VARIANZ,
SERVERINSTANCE_UNIQUE_ID,
SERVERINSTANCE_ENDMARKER,
};
enum VirtualServerProperties {
VIRTUALSERVER_UNDEFINED = 0,
VIRTUALSERVER_BEGINMARKER,
VIRTUALSERVER_UNIQUE_IDENTIFIER = VIRTUALSERVER_BEGINMARKER, //available when connected, can be used to identify this particular server installation
VIRTUALSERVER_NAME, //available and always up-to-date when connected
VIRTUALSERVER_WELCOMEMESSAGE, //available when connected, (=> requestServerVariables)
VIRTUALSERVER_PLATFORM, //available when connected
VIRTUALSERVER_VERSION, //available when connected
VIRTUALSERVER_MAXCLIENTS, //only available on request (=> requestServerVariables), stores the maximum number of clients that may currently join the server
VIRTUALSERVER_PASSWORD, //not available to clients, the server password
VIRTUALSERVER_CLIENTS_ONLINE, //only available on request (=> requestServerVariables),
VIRTUALSERVER_CHANNELS_ONLINE, //only available on request (=> requestServerVariables),
VIRTUALSERVER_CREATED, //available when connected, stores the time when the server was created
VIRTUALSERVER_UPTIME, //only available on request (=> requestServerVariables), the time since the server was started
VIRTUALSERVER_CODEC_ENCRYPTION_MODE, //available and always up-to-date when connected
//Rare properties
VIRTUALSERVER_KEYPAIR, //internal use
VIRTUALSERVER_HOSTMESSAGE, //available when connected, not updated while connected
VIRTUALSERVER_HOSTMESSAGE_MODE, //available when connected, not updated while connected
VIRTUALSERVER_FILEBASE, //not available to clients, stores the folder used for file transfers
VIRTUALSERVER_DEFAULT_SERVER_GROUP, //the manager permissions server group that a new manager gets assigned
VIRTUALSERVER_DEFAULT_MUSIC_GROUP, //the manager permissions server group that a new manager gets assigned
VIRTUALSERVER_DEFAULT_CHANNEL_GROUP, //the channel permissions group that a new manager gets assigned when joining a channel
VIRTUALSERVER_FLAG_PASSWORD, //only available on request (=> requestServerVariables)
VIRTUALSERVER_DEFAULT_CHANNEL_ADMIN_GROUP, //the channel permissions group that a manager gets assigned when creating a channel
VIRTUALSERVER_MAX_DOWNLOAD_TOTAL_BANDWIDTH, //only available on request (=> requestServerVariables)
VIRTUALSERVER_MAX_UPLOAD_TOTAL_BANDWIDTH, //only available on request (=> requestServerVariables)
VIRTUALSERVER_HOSTBANNER_URL, //available when connected, always up-to-date
VIRTUALSERVER_HOSTBANNER_GFX_URL, //available when connected, always up-to-date
VIRTUALSERVER_HOSTBANNER_GFX_INTERVAL, //available when connected, always up-to-date
VIRTUALSERVER_COMPLAIN_AUTOBAN_COUNT, //only available on request (=> requestServerVariables)
VIRTUALSERVER_COMPLAIN_AUTOBAN_TIME, //only available on request (=> requestServerVariables)
VIRTUALSERVER_COMPLAIN_REMOVE_TIME, //only available on request (=> requestServerVariables)
VIRTUALSERVER_MIN_CLIENTS_IN_CHANNEL_BEFORE_FORCED_SILENCE,//only available on request (=> requestServerVariables)
VIRTUALSERVER_PRIORITY_SPEAKER_DIMM_MODIFICATOR, //available when connected, always up-to-date
VIRTUALSERVER_ID, //available when connected
VIRTUALSERVER_ANTIFLOOD_POINTS_TICK_REDUCE, //only available on request (=> requestServerVariables)
VIRTUALSERVER_ANTIFLOOD_POINTS_NEEDED_COMMAND_BLOCK, //only available on request (=> requestServerVariables)
VIRTUALSERVER_ANTIFLOOD_POINTS_NEEDED_IP_BLOCK, //only available on request (=> requestServerVariables)
VIRTUALSERVER_CLIENT_CONNECTIONS, //only available on request (=> requestServerVariables)
VIRTUALSERVER_QUERY_CLIENT_CONNECTIONS, //only available on request (=> requestServerVariables)
VIRTUALSERVER_HOSTBUTTON_TOOLTIP, //available when connected, always up-to-date
VIRTUALSERVER_HOSTBUTTON_URL, //available when connected, always up-to-date
VIRTUALSERVER_HOSTBUTTON_GFX_URL, //available when connected, always up-to-date
VIRTUALSERVER_QUERYCLIENTS_ONLINE, //only available on request (=> requestServerVariables)
VIRTUALSERVER_DOWNLOAD_QUOTA, //only available on request (=> requestServerVariables)
VIRTUALSERVER_UPLOAD_QUOTA, //only available on request (=> requestServerVariables)
VIRTUALSERVER_MONTH_BYTES_DOWNLOADED, //only available on request (=> requestServerVariables)
VIRTUALSERVER_MONTH_BYTES_UPLOADED, //only available on request (=> requestServerVariables)
VIRTUALSERVER_TOTAL_BYTES_DOWNLOADED, //only available on request (=> requestServerVariables)
VIRTUALSERVER_TOTAL_BYTES_UPLOADED, //only available on request (=> requestServerVariables)
VIRTUALSERVER_PORT, //only available on request (=> requestServerVariables)
VIRTUALSERVER_AUTOSTART, //only available on request (=> requestServerVariables)
VIRTUALSERVER_MACHINE_ID, //only available on request (=> requestServerVariables)
VIRTUALSERVER_NEEDED_IDENTITY_SECURITY_LEVEL, //only available on request (=> requestServerVariables)
VIRTUALSERVER_LOG_CLIENT, //only available on request (=> requestServerVariables)
VIRTUALSERVER_LOG_QUERY, //only available on request (=> requestServerVariables)
VIRTUALSERVER_LOG_CHANNEL, //only available on request (=> requestServerVariables)
VIRTUALSERVER_LOG_PERMISSIONS, //only available on request (=> requestServerVariables)
VIRTUALSERVER_LOG_SERVER, //only available on request (=> requestServerVariables)
VIRTUALSERVER_LOG_FILETRANSFER, //only available on request (=> requestServerVariables)
VIRTUALSERVER_MIN_CLIENT_VERSION, //only available on request (=> requestServerVariables)
VIRTUALSERVER_NAME_PHONETIC, //available when connected, always up-to-date
VIRTUALSERVER_ICON_ID, //available when connected, always up-to-date
VIRTUALSERVER_RESERVED_SLOTS, //available when connected, always up-to-date
VIRTUALSERVER_TOTAL_PACKETLOSS_SPEECH, //only available on request (=> requestServerVariables)
VIRTUALSERVER_TOTAL_PACKETLOSS_KEEPALIVE, //only available on request (=> requestServerVariables)
VIRTUALSERVER_TOTAL_PACKETLOSS_CONTROL, //only available on request (=> requestServerVariables)
VIRTUALSERVER_TOTAL_PACKETLOSS_TOTAL, //only available on request (=> requestServerVariables)
VIRTUALSERVER_TOTAL_PING, //only available on request (=> requestServerVariables)
VIRTUALSERVER_HOST, //internal use | contains comma separated ip list
VIRTUALSERVER_WEBLIST_ENABLED, //only available on request (=> requestServerVariables)
VIRTUALSERVER_AUTOGENERATED_PRIVILEGEKEY, //internal use
VIRTUALSERVER_ASK_FOR_PRIVILEGEKEY, //available when connected
VIRTUALSERVER_HOSTBANNER_MODE, //available when connected, always up-to-date
VIRTUALSERVER_CHANNEL_TEMP_DELETE_DELAY_DEFAULT, //available when connected, always up-to-date
VIRTUALSERVER_MIN_ANDROID_VERSION, //only available on request (=> requestServerVariables)
VIRTUALSERVER_MIN_IOS_VERSION, //only available on request (=> requestServerVariables)
VIRTUALSERVER_MIN_WINPHONE_VERSION, //only available on request (=> requestServerVariables)
VIRTUALSERVER_LAST_CLIENT_CONNECT,
VIRTUALSERVER_LAST_QUERY_CONNECT,
VIRTUALSERVER_LAST_CLIENT_DISCONNECT,
VIRTUALSERVER_LAST_QUERY_DISCONNECT,
VIRTUALSERVER_WEB_HOST,
VIRTUALSERVER_WEB_PORT,
VIRTUALSERVER_DEFAULT_CLIENT_DESCRIPTION,
VIRTUALSERVER_DEFAULT_CHANNEL_DESCRIPTION,
VIRTUALSERVER_DEFAULT_CHANNEL_TOPIC,
VIRTUALSERVER_MUSIC_BOT_LIMIT,
VIRTUALSERVER_SPOKEN_TIME,
VIRTUALSERVER_DISABLE_IP_SAVING,
VIRTUALSERVER_ENDMARKER
};
enum ChannelProperties {
CHANNEL_UNDEFINED,
CHANNEL_BEGINMARKER,
CHANNEL_ID = CHANNEL_BEGINMARKER,
CHANNEL_PID,
CHANNEL_NAME, //Available for all channels that are "in view", always up-to-date
CHANNEL_TOPIC, //Available for all channels that are "in view", always up-to-date
CHANNEL_DESCRIPTION, //Must be requested (=> requestChannelDescription)
CHANNEL_PASSWORD, //not available manager side
CHANNEL_CODEC, //Available for all channels that are "in view", always up-to-date
CHANNEL_CODEC_QUALITY, //Available for all channels that are "in view", always up-to-date
CHANNEL_MAXCLIENTS, //Available for all channels that are "in view", always up-to-date
CHANNEL_MAXFAMILYCLIENTS, //Available for all channels that are "in view", always up-to-date
CHANNEL_ORDER, //Available for all channels that are "in view", always up-to-date
CHANNEL_FLAG_PERMANENT, //Available for all channels that are "in view", always up-to-date
CHANNEL_FLAG_SEMI_PERMANENT, //Available for all channels that are "in view", always up-to-date
CHANNEL_FLAG_DEFAULT, //Available for all channels that are "in view", always up-to-date
CHANNEL_FLAG_PASSWORD, //Available for all channels that are "in view", always up-to-date
CHANNEL_CODEC_LATENCY_FACTOR, //Available for all channels that are "in view", always up-to-date
CHANNEL_CODEC_IS_UNENCRYPTED, //Available for all channels that are "in view", always up-to-date
CHANNEL_SECURITY_SALT, //Not available manager side, not used in teamspeak, only SDK. Sets the options+salt for security hash.
CHANNEL_DELETE_DELAY, //How many seconds to wait before deleting this channel
CHANNEL_FLAG_MAXCLIENTS_UNLIMITED, //Available for all channels that are "in view", always up-to-date
CHANNEL_FLAG_MAXFAMILYCLIENTS_UNLIMITED,//Available for all channels that are "in view", always up-to-date
CHANNEL_FLAG_MAXFAMILYCLIENTS_INHERITED,//Available for all channels that are "in view", always up-to-date
CHANNEL_FLAG_ARE_SUBSCRIBED, //Only available manager side, stores whether we are subscribed to this channel
CHANNEL_FILEPATH, //not available manager side, the folder used for file-transfers for this channel
CHANNEL_NEEDED_TALK_POWER, //Available for all channels that are "in view", always up-to-date
CHANNEL_FORCED_SILENCE, //Available for all channels that are "in view", always up-to-date
CHANNEL_NAME_PHONETIC, //Available for all channels that are "in view", always up-to-date
CHANNEL_ICON_ID, //Available for all channels that are "in view", always up-to-date
CHANNEL_FLAG_PRIVATE, //Available for all channels that are "in view", always up-to-date
CHANNEL_LAST_LEFT,
CHANNEL_CREATED_AT,
CHANNEL_CREATED_BY,
CHANNEL_ENDMARKER
};
enum GroupProperties {
GROUP_UNDEFINED,
GROUP_BEGINMARKER,
GROUP_ID = GROUP_BEGINMARKER,
GROUP_TYPE,
GROUP_NAME,
GROUP_SORTID,
GROUP_SAVEDB,
GROUP_NAMEMODE,
GROUP_ICONID,
GROUP_ENDMARKER
};
enum ClientProperties {
CLIENT_UNDEFINED,
CLIENT_BEGINMARKER,
CLIENT_UNIQUE_IDENTIFIER = CLIENT_BEGINMARKER, //automatically up-to-date for any manager "in view", can be used to identify this particular manager installation
CLIENT_NICKNAME, //automatically up-to-date for any manager "in view"
CLIENT_VERSION, //for other clients than ourself, this needs to be requested (=> requestClientVariables)
CLIENT_PLATFORM, //for other clients than ourself, this needs to be requested (=> requestClientVariables)
CLIENT_FLAG_TALKING, //automatically up-to-date for any manager that can be heard (in room / whisper)
CLIENT_INPUT_MUTED, //automatically up-to-date for any manager "in view", this clients microphone mute status
CLIENT_OUTPUT_MUTED, //automatically up-to-date for any manager "in view", this clients headphones/speakers/mic combined mute status
CLIENT_OUTPUTONLY_MUTED, //automatically up-to-date for any manager "in view", this clients headphones/speakers only mute status
CLIENT_INPUT_HARDWARE, //automatically up-to-date for any manager "in view", this clients microphone hardware status (is the capture device opened?)
CLIENT_OUTPUT_HARDWARE, //automatically up-to-date for any manager "in view", this clients headphone/speakers hardware status (is the playback device opened?)
CLIENT_DEFAULT_CHANNEL, //only usable for ourself, the default channel we used to connect on our last connection attempt
CLIENT_DEFAULT_CHANNEL_PASSWORD, //internal use
CLIENT_SERVER_PASSWORD, //internal use
CLIENT_META_DATA, //automatically up-to-date for any manager "in view", not used by TeamSpeak, free storage for sdk users
CLIENT_IS_RECORDING, //automatically up-to-date for any manager "in view"
CLIENT_VERSION_SIGN, //sign
CLIENT_SECURITY_HASH, //SDK use, not used by teamspeak. Hash is provided by an outside source. A channel will use the security salt + other manager data to calculate a hash, which must be the same as the one provided here.
//Rare properties
CLIENT_KEY_OFFSET, //internal use
CLIENT_LOGIN_NAME, //used for serverquery clients, makes no sense on normal clients currently
CLIENT_LOGIN_PASSWORD, //used for serverquery clients, makes no sense on normal clients currently
CLIENT_DATABASE_ID, //automatically up-to-date for any manager "in view", only valid with PERMISSION feature, holds database manager id
CLIENT_ID, //clid!
CLIENT_HARDWARE_ID, //hwid!
CLIENT_CHANNEL_GROUP_ID, //automatically up-to-date for any manager "in view", only valid with PERMISSION feature, holds database manager id
CLIENT_SERVERGROUPS, //automatically up-to-date for any manager "in view", only valid with PERMISSION feature, holds all servergroups manager belongs too
CLIENT_CREATED, //this needs to be requested (=> requestClientVariables), first time this manager connected to this server
CLIENT_LASTCONNECTED, //this needs to be requested (=> requestClientVariables), last time this manager connected to this server
CLIENT_TOTALCONNECTIONS, //this needs to be requested (=> requestClientVariables), how many times this manager connected to this server
CLIENT_AWAY, //automatically up-to-date for any manager "in view", this clients away status
CLIENT_AWAY_MESSAGE, //automatically up-to-date for any manager "in view", this clients away message
CLIENT_TYPE, //automatically up-to-date for any manager "in view", determines if this is a real manager or a server-query connection
CLIENT_TYPE_EXACT, //automatically up-to-date for any manager "in view", determines if this is a real manager or a server-query connection
CLIENT_FLAG_AVATAR, //automatically up-to-date for any manager "in view", this manager got an avatar
CLIENT_TALK_POWER, //automatically up-to-date for any manager "in view", only valid with PERMISSION feature, holds database manager id
CLIENT_TALK_REQUEST, //automatically up-to-date for any manager "in view", only valid with PERMISSION feature, holds timestamp where manager requested to talk
CLIENT_TALK_REQUEST_MSG, //automatically up-to-date for any manager "in view", only valid with PERMISSION feature, holds matter for the request
CLIENT_DESCRIPTION, //automatically up-to-date for any manager "in view"
CLIENT_IS_TALKER, //automatically up-to-date for any manager "in view"
CLIENT_MONTH_BYTES_UPLOADED, //this needs to be requested (=> requestClientVariables)
CLIENT_MONTH_BYTES_DOWNLOADED, //this needs to be requested (=> requestClientVariables)
CLIENT_TOTAL_BYTES_UPLOADED, //this needs to be requested (=> requestClientVariables)
CLIENT_TOTAL_BYTES_DOWNLOADED, //this needs to be requested (=> requestClientVariables)
CLIENT_TOTAL_ONLINE_TIME,
CLIENT_MONTH_ONLINE_TIME,
CLIENT_IS_PRIORITY_SPEAKER, //automatically up-to-date for any manager "in view"
CLIENT_UNREAD_MESSAGES, //automatically up-to-date for any manager "in view"
CLIENT_NICKNAME_PHONETIC, //automatically up-to-date for any manager "in view"
CLIENT_NEEDED_SERVERQUERY_VIEW_POWER, //automatically up-to-date for any manager "in view"
CLIENT_DEFAULT_TOKEN, //only usable for ourself, the default token we used to connect on our last connection attempt
CLIENT_ICON_ID, //automatically up-to-date for any manager "in view"
CLIENT_IS_CHANNEL_COMMANDER, //automatically up-to-date for any manager "in view"
CLIENT_COUNTRY, //automatically up-to-date for any manager "in view"
CLIENT_CHANNEL_GROUP_INHERITED_CHANNEL_ID, //automatically up-to-date for any manager "in view", only valid with PERMISSION feature, contains channel_id where the channel_group_id is set from
CLIENT_BADGES, //automatically up-to-date for any manager "in view", stores icons for partner badges
CLIENT_MYTEAMSPEAK_ID,
CLIENT_INTEGRATIONS,
CLIENT_ACTIVE_INTEGRATIONS_INFO,
//Music bot stuff
CLIENT_BOT_TYPE,
CLIENT_OWNER,
CLIENT_PLAYER_VOLUME,
CLIENT_LAST_CHANNEL,
CLIENT_PLAYER_STATE,
CLIENT_PLAYLIST_ID,
CLIENT_DISABLED,
CLIENT_UPTIME_MODE,
CLIENT_FLAG_NOTIFY_SONG_CHANGE,
CLIENT_TEAFORO_ID,
CLIENT_TEAFORO_NAME,
CLIENT_ENDMARKER
};
enum ConnectionProperties {
CONNECTION_UNDEFINED,
CONNECTION_BEGINMARKER,
CONNECTION_PING = CONNECTION_BEGINMARKER, //average latency for a round trip through and back this connection
CONNECTION_PING_DEVIATION, //standard deviation of the above average latency
CONNECTION_CONNECTED_TIME, //how long the connection exists already
CONNECTION_IDLE_TIME, //how long since the last action of this manager
CONNECTION_CLIENT_IP, //NEED DB SAVE! //IP of this manager (as seen from the server side)
CONNECTION_CLIENT_PORT, //Port of this manager (as seen from the server side)
CONNECTION_SERVER_IP, //IP of the server (seen from the manager side) - only available on yourself, not for remote clients, not available server side
CONNECTION_SERVER_PORT, //Port of the server (seen from the manager side) - only available on yourself, not for remote clients, not available server side
CONNECTION_PACKETS_SENT_SPEECH, //how many Speech packets were sent through this connection
CONNECTION_PACKETS_SENT_KEEPALIVE,
CONNECTION_PACKETS_SENT_CONTROL,
CONNECTION_PACKETS_SENT_TOTAL, //how many packets were sent totally (this is PACKETS_SENT_SPEECH + PACKETS_SENT_KEEPALIVE + PACKETS_SENT_CONTROL)
CONNECTION_BYTES_SENT_SPEECH,
CONNECTION_BYTES_SENT_KEEPALIVE,
CONNECTION_BYTES_SENT_CONTROL,
CONNECTION_BYTES_SENT_TOTAL,
CONNECTION_PACKETS_RECEIVED_SPEECH,
CONNECTION_PACKETS_RECEIVED_KEEPALIVE,
CONNECTION_PACKETS_RECEIVED_CONTROL,
CONNECTION_PACKETS_RECEIVED_TOTAL,
CONNECTION_BYTES_RECEIVED_SPEECH,
CONNECTION_BYTES_RECEIVED_KEEPALIVE,
CONNECTION_BYTES_RECEIVED_CONTROL,
CONNECTION_BYTES_RECEIVED_TOTAL,
CONNECTION_PACKETLOSS_SPEECH,
CONNECTION_PACKETLOSS_KEEPALIVE,
CONNECTION_PACKETLOSS_CONTROL,
CONNECTION_PACKETLOSS_TOTAL, //the probability with which a packet round trip failed because a packet was lost
CONNECTION_SERVER2CLIENT_PACKETLOSS_SPEECH, //the probability with which a speech packet failed from the server to the manager
CONNECTION_SERVER2CLIENT_PACKETLOSS_KEEPALIVE,
CONNECTION_SERVER2CLIENT_PACKETLOSS_CONTROL,
CONNECTION_SERVER2CLIENT_PACKETLOSS_TOTAL,
CONNECTION_CLIENT2SERVER_PACKETLOSS_SPEECH,
CONNECTION_CLIENT2SERVER_PACKETLOSS_KEEPALIVE,
CONNECTION_CLIENT2SERVER_PACKETLOSS_CONTROL,
CONNECTION_CLIENT2SERVER_PACKETLOSS_TOTAL,
CONNECTION_BANDWIDTH_SENT_LAST_SECOND_SPEECH, //howmany bytes of speech packets we sent during the last second
CONNECTION_BANDWIDTH_SENT_LAST_SECOND_KEEPALIVE,
CONNECTION_BANDWIDTH_SENT_LAST_SECOND_CONTROL,
CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL,
CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_SPEECH, //howmany bytes/s of speech packets we sent in average during the last minute
CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_KEEPALIVE,
CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_CONTROL,
CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL,
CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_SPEECH,
CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_KEEPALIVE,
CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_CONTROL,
CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL,
CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_SPEECH,
CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_KEEPALIVE,
CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_CONTROL,
CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL,
//Rare properties
CONNECTION_FILETRANSFER_BANDWIDTH_SENT, //how many bytes per second are currently being sent by file transfers
CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED, //how many bytes per second are currently being received by file transfers
CONNECTION_FILETRANSFER_BYTES_RECEIVED_TOTAL, //how many bytes we received in total through file transfers
CONNECTION_FILETRANSFER_BYTES_SENT_TOTAL, //how many bytes we sent in total through file transfers
CONNECTION_ENDMARKER
};
enum PlaylistProperties {
PLAYLIST_UNDEFINED,
PLAYLIST_BEGINMARKER,
PLAYLIST_ID = PLAYLIST_BEGINMARKER,
PLAYLIST_TITLE,
PLAYLIST_DESCRIPTION,
PLAYLIST_TYPE,
PLAYLIST_OWNER_DBID,
PLAYLIST_OWNER_NAME,
PLAYLIST_MAX_SONGS,
PLAYLIST_FLAG_DELETE_PLAYED,
PLAYLIST_FLAG_FINISHED,
PLAYLIST_REPLAY_MODE, /* 0 = normal | 1 = loop list | 2 = loop entry | 3 = shuffle */
PLAYLIST_CURRENT_SONG_ID,
PLAYLIST_ENDMARKER
};
/*
enum PlayList {
PLAYLIST_OWNER,
PLAYLIST_NAME,
PLAYLIST_REPEAT_MODE,
PLAYLIST_DELETE_PLAYED_SONGS
};
*/
class PropertyDescription;
namespace impl {
template<typename T>
extern std::deque<std::shared_ptr<property::PropertyDescription>> list();
extern std::deque<std::shared_ptr<property::PropertyDescription>> list_all();
template<typename T>
extern const std::shared_ptr<property::PropertyDescription> &info(T /* property */);
template<typename T>
extern const std::shared_ptr<property::PropertyDescription> &info(const std::string& /* key */);
extern const std::shared_ptr<property::PropertyDescription> &info_key(const std::string &);
extern const std::shared_ptr<property::PropertyDescription> &info_key(PropertyType, const std::string &);
extern const std::shared_ptr<property::PropertyDescription> &info(PropertyType, int);
template<typename V>
inline PropertyType type() {
std::cerr << "[CRITICAL] Invalid property type!" << std::endl;
return PropertyType::PROP_TYPE_UNKNOWN;
}
template<>
constexpr inline PropertyType type<VirtualServerProperties>() { return PropertyType::PROP_TYPE_SERVER; }
template<>
constexpr inline PropertyType type<ChannelProperties>() { return PropertyType::PROP_TYPE_CHANNEL; }
template<>
constexpr inline PropertyType type<ClientProperties>() { return PropertyType::PROP_TYPE_CLIENT; }
template<>
constexpr inline PropertyType type<ConnectionProperties>() { return PropertyType::PROP_TYPE_CONNECTION; }
template<>
constexpr inline PropertyType type<GroupProperties>() { return PropertyType::PROP_TYPE_GROUP; }
template<>
constexpr inline PropertyType type<InstanceProperties>() { return PropertyType::PROP_TYPE_INSTANCE; }
template<>
constexpr inline PropertyType type<PlaylistProperties>() { return PropertyType::PROP_TYPE_PLAYLIST; }
template<>
constexpr inline PropertyType type<UnknownProperties>() { return PropertyType::PROP_TYPE_UNKNOWN; }
inline size_t length(PropertyType type) {
switch (type) {
case PROP_TYPE_SERVER:
return VIRTUALSERVER_ENDMARKER - VIRTUALSERVER_BEGINMARKER;
case PROP_TYPE_CHANNEL:
return CHANNEL_ENDMARKER - CHANNEL_BEGINMARKER;
case PROP_TYPE_CLIENT:
return CLIENT_ENDMARKER - CLIENT_BEGINMARKER;
case PROP_TYPE_CONNECTION:
return CONNECTION_ENDMARKER - CONNECTION_BEGINMARKER;
case PROP_TYPE_GROUP:
return GROUP_ENDMARKER - GROUP_BEGINMARKER;
case PROP_TYPE_INSTANCE:
return SERVERINSTANCE_ENDMARKER - SERVERINSTANCE_BEGINMARKER;
case PROP_TYPE_PLAYLIST:
return PLAYLIST_ENDMARKER - PLAYLIST_BEGINMARKER;
case PROP_TYPE_UNKNOWN:
return UNKNOWN_ENDMARKER - UNKNOWN_BEGINMARKER;
default:
return 0;
}
}
inline size_t offset(PropertyType type) {
switch (type) {
case PROP_TYPE_SERVER:
return VIRTUALSERVER_BEGINMARKER;
case PROP_TYPE_CHANNEL:
return CHANNEL_BEGINMARKER;
case PROP_TYPE_CLIENT:
return CLIENT_BEGINMARKER;
case PROP_TYPE_CONNECTION:
return CONNECTION_BEGINMARKER;
case PROP_TYPE_GROUP:
return GROUP_BEGINMARKER;
case PROP_TYPE_INSTANCE:
return SERVERINSTANCE_BEGINMARKER;
case PROP_TYPE_PLAYLIST:
return PLAYLIST_BEGINMARKER;
case PROP_TYPE_UNKNOWN:
return UNKNOWN_BEGINMARKER;
default:
return 0;
}
}
extern bool validateUnique();
extern bool validateInput(const std::string &, ValueType);
}
template<typename T>
inline const std::shared_ptr<property::PropertyDescription> &info(T property) { return impl::info<T>(property); }
template<typename T>
inline const std::shared_ptr<property::PropertyDescription> &info(const std::string& key) { return impl::info<T>(key); }
class PropertyDescription {
public:
static std::shared_ptr<PropertyDescription> unknown;
std::string name;
std::string default_value;
ValueType type_value = property::ValueType::TYPE_UNKNOWN;
PropertyType type_property = PropertyType::PROP_TYPE_UNKNOWN;
int property_index = 0;
flag_type flags = 0;
PropertyDescription(int property_id, PropertyType property_type, const std::string &name, const std::string &default_value, property::ValueType type, flag_type flags) noexcept;
template<typename T>
PropertyDescription(T property, const std::string &name, const std::string &default_value, property::ValueType type, flag_type flags) noexcept : PropertyDescription((int) property, impl::type<T>(), name, default_value, type, flags) {}
inline bool operator==(const PropertyDescription& other) const {
return other.property_index == this->property_index && other.type_property == this->type_property;
}
inline bool operator==(const std::shared_ptr<PropertyDescription>& other) const {
return this->operator==(*other);
}
template <typename T, typename std::enable_if<std::is_enum<T>::value, int>::type = 0>
inline bool operator==(const T& type) const {
return this->property_index == type && impl::type<T>() == this->type_property;
}
inline bool validate_input(const std::string& input) {
return impl::validateInput(input, this->type_value);
}
};
}
class Properties;
struct PropertyData {
spin_lock value_lock;
std::any casted_value;
std::string value;
std::shared_ptr<property::PropertyDescription> description;
bool flag_db_reference;
bool flag_modified;
};
struct PropertyBundle {
property::PropertyType type;
size_t length;
size_t offset;
PropertyData properties[0];
};
template <typename T>
struct PropertyAccess {
inline static T get(PropertyData* data_ptr) {
std::lock_guard lock(data_ptr->value_lock);
if(data_ptr->casted_value.type() == typeid(T))
return std::any_cast<T>(data_ptr->casted_value);
data_ptr->casted_value = ts::converter<T>::from_string(data_ptr->value);
return std::any_cast<T>(data_ptr->casted_value);
}
};
template <>
struct PropertyAccess<std::string> {
inline static std::string get(PropertyData* data_ptr) { return data_ptr->value; }
};
struct PropertyWrapper {
friend class Properties;
public:
bool operator==(const PropertyWrapper& other) {
if(this->data_ptr == other.data_ptr)
return true;
return this->data_ptr->value == other.data_ptr->value;
}
template <typename T>
bool operator==(const T& other){
return this->as<T>() == other;
}
template <typename T>
bool operator!=(const T& other){
return !operator==(other);
}
//Math operators
PropertyWrapper&operator++(){ return operator=(as<int64_t>() + 1); }
PropertyWrapper&operator++(int){ return operator=(as<int64_t>() + 1); }
PropertyWrapper&operator+=(uint16_t val){ return operator=(as<uint16_t>() + val); }
PropertyWrapper&operator+=(int64_t val){ return operator=(as<int64_t>() + val); }
PropertyWrapper&operator+=(uint64_t val){ return operator=(as<uint64_t>() + val); }
bool hasDbReference() const { return this->data_ptr->flag_db_reference; }
void setDbReference(bool flag){ this->data_ptr->flag_db_reference = flag; }
bool isModified() const { return this->data_ptr->flag_modified; }
void setModified(bool flag){ this->data_ptr->flag_modified = flag; }
template <typename T>
T as() const {
static_assert(ts::converter<T>::supported, "as<T> isn't supported for type");
return PropertyAccess<T>::get(this->data_ptr);
}
template <typename T>
operator T(){ return this->as<T>(); }
template <typename T>
T as_save() const {
try {
std::lock_guard lock(this->data_ptr->value_lock);
if(this->data_ptr->casted_value.type() == typeid(T))
return std::any_cast<T>(this->data_ptr->casted_value);
this->data_ptr->casted_value = ts::converter<T>::from_string(this->data_ptr->value);
return std::any_cast<T>(this->data_ptr->casted_value);
} catch(std::exception&) {
return 0;
}
}
const property::PropertyDescription& type() const { return *this->data_ptr->description; }
std::string value() const {
std::lock_guard lock(this->data_ptr->value_lock);
return this->data_ptr->value;
}
void value(const std::string &value, bool trigger_update = true){
{
std::lock_guard lock(this->data_ptr->value_lock);
if(this->data_ptr->value == value)
return;
this->data_ptr->casted_value.reset();
this->data_ptr->value = value;
}
if(trigger_update)
this->trigger_update();
}
std::string default_value() const {
return this->type().default_value;
}
template <typename T>
PropertyWrapper& operator=(const T& value) {
static_assert(ts::converter<T>::supported, "type isn't supported for type");
{
std::any any_value{value};
auto value_string = ts::converter<T>::to_string(any_value);
std::lock_guard lock(this->data_ptr->value_lock);
if(value_string == this->data_ptr->value)
return *this;
this->data_ptr->casted_value = any_value;
this->data_ptr->value = value_string;
}
this->trigger_update();
return *this;
}
PropertyWrapper& operator=(const std::string& value) {
this->value(value);
return *this;
}
PropertyWrapper& operator=(const char* value) {
this->value(value);
return *this;
}
template <int N>
PropertyWrapper& operator=(char(value)[N]) {
this->value(value);
return *this;
}
void trigger_update();
PropertyWrapper(Properties* /* handle */, PropertyData* /* ptr */, const std::shared_ptr<PropertyBundle>& /* bundle */);
inline Properties* get_handle() { return this->handle; }
private:
Properties* handle = nullptr;
PropertyData* data_ptr = nullptr;
std::shared_ptr<PropertyBundle> bundle_lock;
};
typedef PropertyWrapper Property;
typedef std::function<void(PropertyWrapper&)> PropertyNotifyFn;
class Properties {
friend struct PropertyWrapper;
public:
Properties();
~Properties();
Properties(const Properties&) = delete;
Properties(Properties&&) = delete;
std::vector<PropertyWrapper> list_properties(property::flag_type flagMask = ~0, property::flag_type negatedFlagMask = 0);
std::vector<PropertyWrapper> all_properties();
/*
std::deque<std::shared_ptr<Property>> listProperties(property::flag_type flagMask = ~0, property::flag_type negatedFlagMask = 0);
std::deque<std::shared_ptr<Property>> allProperties();
*/
template <typename Type>
bool register_property_type() {
constexpr auto type = property::impl::type<Type>();
return this->register_property_type(type, property::impl::length(type), property::impl::offset(type));
}
/*
template <typename PT>
std::shared_ptr<Property> registerProperty(PT property){
auto info = property::impl::info<PT>(property);
{
threads::MutexLock lock(this->propsLock);
for(const auto& elm : this->properties) {
if(*info == elm->type()){
std::cerr << "Double registration of " << elm->type().name << "\n";
return this->find(property::impl::type<PT>(), property);
}
}
properties.push_back(std::make_shared<Property>(this, info));
}
return this->find(property::impl::type<PT>(), property);
}
*/
template <typename T>
bool hasProperty(T type) { return this->has(property::impl::type<T>(), type); }
template <typename T, typename std::enable_if<std::is_enum<T>::value, int>::type = 0>
PropertyWrapper operator[](T type) {
return this->find(property::impl::type<T>(), type);
}
PropertyWrapper operator[](const property::PropertyDescription& type) {
return this->find(type.type_property, type.property_index);
}
PropertyWrapper operator[](const std::shared_ptr<property::PropertyDescription>& type) {
return this->find(type->type_property, type->property_index);
}
void registerNotifyHandler(const PropertyNotifyFn &fn){
this->notifyFunctions.push_back(fn);
}
void triggerAllModified(){
for(auto& prop : this->all_properties())
if(prop.isModified())
for(auto& elm : notifyFunctions)
elm(prop);
}
void toggleSave(bool flag) { this->save = flag; }
bool isSaveEnabled(){ return this->save; }
PropertyWrapper find(property::PropertyType type, int index);
bool has(property::PropertyType type, int index);
template <typename T, typename std::enable_if<std::is_enum<T>::value, int>::type = 0>
bool has(T type) { return this->has(property::impl::type<T>(), type); }
private:
bool register_property_type(property::PropertyType /* type */, size_t /* length */, size_t /* offset */);
bool save = true;
std::vector<std::function<void(PropertyWrapper&)>> notifyFunctions{};
std::recursive_mutex propsLock{};
//std::deque<std::shared_ptr<Property>> properties{};
size_t properties_count = 0;
std::deque<std::shared_ptr<PropertyBundle>> properties;
};
};
//DEFINE_TRANSFORMS(ts::property::PropertyType, uint8_t);
DEFINE_CONVERTER_ENUM(ts::property::PropertyType, uint8_t);
DEFINE_VARIABLE_TRANSFORM_ENUM(ts::property::PropertyType, uint8_t);
Reference in New Issue View Git Blame Copy Permalink