TSN Ranksystem

Features

Installation on Linux

1) Requirements

Before we can start to install the TSN Ranksystem, we need to check the requirements for the environment are met.

2) Download & Unzip

Download and unzip the file ranksystem_latest.zip.

3) Upload to webspace

Upload the whole unzipped folder to a directory on your webspace and grant permissions to the user of your webserver.

4) Run install process

Open the "install.php" on your browser and follow the instructions https://your.url/ranksystem-folder/install.php.

5) Configure webinterface

Configure the TSN Ranksystem about the webinterface https://your.url/ranksystem-folder/webinterface/.
For each parameter you'll find a documentation by mouse click on it.

6) Start Bot

Start the TSN Ranksystem Bot via the webinterface.

7) Add cronjob (optional)

Optional: Create a cronjob to be sure, the Bot is running 24/7. This will restart the Bot automatically, e.g. on a database restart.

Open a SSH session to the host machine of your webserver.

Enter the command crontab -e, go to editing mode (in VIM you need to press i).

Paste the following in a new line:

*/10 * * * * sudo -u www-data php /path_to_your_webspace/path_to_the_ranksystem/worker.php check >/dev/null 2>&1

Configure the path, where your TSN Ranksystem is located and replace www-data with the user of your webserver.

Save and quit the crontab (in VIM :wq).

Installation on Windows

1) Requirements

Before we can start to install the TSN Ranksystem, we need to check the requirements for the environment are met.

2) Download & Unzip

Download and unzip the file ranksystem_latest.zip.

3) Upload to webspace

Upload the whole unzipped folder to a directory on your webspace and grant permissions to the user of your webserver.

4) Run install process

Open the "install.php" on your browser and follow the instructions https://your.url/ranksystem-folder/install.php.

5) Set PHP Path

Set the path to the php.exe (PHP installation) inside the other\phpcommand.php. Examples you'll find inside this file.

6) Configure webinterface

Configure the TSN Ranksystem about the webinterface https://your.url/ranksystem-folder/webinterface/.
For each parameter you'll find a documentation by mouse click on it.

7) Start Bot

Start the TSN Ranksystem Bot via the webinterface.

8) Add new Task (optional)

Optional: Create a task inside the task scheduler to be sure, the Bot is running 24/7. This will restart the Bot automatically, e.g. on a database restart.

Windows help how to create a new task.

Add the following options:

C:\path\to\php.exe -f C:\path\to\Ranksystem\worker.php check

Configure the path, where you find your PHP installation and also the path where your TSN Ranksystem is located.

Changelog

Explanation

!   Note          (bigger) change you should notice of; in some cases there are things to do
*   Information   for your information, but there is nothing you need to do; changed something works in background
+   Feature       added a new feature or enhanced a feature
-   Bugfix        fixed a bug or corrected something

1.3.3 (2019-XX-XX) - NOT YET RELEASED

pre-4 * optimized SQL statement of building user_snapshots
pre-2 + added hungarian language; thx to ExXeL
pre-1 - fixed handling user nicknames with multibyte characters and a length longer 30
pre-3 - fixed PHP warning on stats/top sites, when servergroup exception is empty

1.3.2 (2019-07-01)

- fixed looping systems, when user nicknames are longer than 28 characters

1.3.1 (2019-06-30)

! new TS3 permission 'b_virtualserver_servergroup_client_list' needed for reset function
! new TS3 permission 'b_virtualserver_client_dbsearch' needed for special case cldbid has changed
* performance optimization with optimizing the SQL handling; a few statistic values will be cached inside PHP and only saved to DB, when changes have taken place
* updated jQuery library to version 3.4.1
* updated Bootstrap library to version 3.4.1
* changed Ranksystem log; added few more things to log during startup (loglevel, query-slowmode, update-channel); changed some things to be forced to log during startup, also when bot level is very low
* optimized downloading of servergrous & icons on TS3 errors (e.g. connection lost)
* minor code optimizations
* changed core rankup assigning; now check wrong server groups and remove them; if the current level is missed, correct it and add the server group
* changed navbar inside the webinterface to be more clearly and structured
+ added automatically language support; when you add a file inside the languages folder and it fullfill the name conventions, it will be added automatically; more information you will find inside the /languages/add_new_language.php
+ added check for changed client-database-ID (e.g. happens on restoring a server snapshot) for offline user; This check was still here, but only for online user; cldbid will be updated or the time of the user reset depending on specification of 'Client-database-ID reset'
+ added new function to reset the Ranksystem
+ added bot command !memory
+ added an average looptime to the !runtime command
- fixed "DateTime::__construct()" error on /stats/my_stats.php when boost function is defined with decimal numbers
- fixed "TS3 Error: 0: only available in non-blocking mode" on secured (SSH) TS Query connection
- fixed XSS vulnerability on /stats/ top users via client_nickname
- fixed online status of users; when the last user left the TS server, it stayed online on 'List Rankup' page
- fixed rarely constellation on update servergroups in bot core, when none of this groups have an icon and also no servericon is set
- fixed rarely constellation in bot core, when only user(s) without any country flag (pre-4: or without any platform or without any version) are online
- fixed wrong response on command !clean, that you wouldn't be allowed to use the command despite admin privileges

1.3.0 (2019-06-10)

! dropped table "config" as announced with version 1.2.12
! The Ranksystem got his own website -> https://ts-ranksystem.com ; We will relocate the version check with one of the next releases; be sure, you whitelist the network traffic (TCP on port 443) to the new domain
* increased column size for config parameters up to 21588 signs (before 5000); with this you can increase the rankup definition and/or choose longer messages; within this we wrap chat messages, which are bigger than 1024 characters
* due the repaired query command dbclientlist with TS3 server version 3.7.0 we removed our dummy database-select to hold the connection; on problems, please update your TS3 server
* minor changes on the install.php
* optimized response speed for bot commands
* updated library FontAwesome to version 5.7.2
* updated library jQuery to version 3.4.0
* optimized file permissions check during bot startup and on install process; the error message during installation now shows more information
* updated library morris chart to version 0.5.1; within added a red line with current max slots
* added requirement-check also on the login screen of the webinterface; this should prevent error reports in changed environments
* updated czech translation; thx to Nicer
+ added auto reconnect for the bot when conection to TS3 server dropped; the attempt of the re-connection takes place with gradually increased times
+ added new parameter update channel, selectable about the webinterface
+ added new parameter for default sorting on List Rankup page, selectable about the webinterface
+ added new bot commands !uptime, !logs, !runtimes and !reloadgroups
+ added new parameters for log-level and log-size for the ranksystem.log, selectable about the webinterface
+ boost factor can now handles decimal numbers; you can enable a factor e.g. 1.25
+ added new parameters (%7$s - current user rank, %8$s - name of the current servergroup, %9$s - current servergroup since) to command !nextup
+ added values for the achievements (My statistics) to the webinterface; they are now configurable
+ added output of the worker.php to the message when starting/stopping/restarting the bot about the webinterface
+ added status of the bot to the webinterface
- fixed some spelling errors in german language file
- fixed SQL command to clean the table user_iphash; no longer existing users (on TS server deleted user) got stuck
- fixed problem on webinterface when changing the password

1.2.12 (2019-02-24)

! changed configuration table of the Ranksystem-Bot and how config-values are handled inside the code. There is nothing you need to change on the webinterface or anywhere else. Only, when you have written third-party-applications and are using the table "config", you need to know the new table is "cfg_params" (Attention: this table has a new database-structure!); old table "config" still exists with 1.2.12 as a clone, but will be deleted with the next version!
* removed link on stats site (report to serverlist) to planetteamspeak since ScP has closed his services; RIP!
+ added new option 'fast hashing' to the IP hash function; these do not decreases the performance of the statistics page as much as it does the already existing 'secure hashing'
+ added spanish translation; thx to JavierlechuXD
- fixed wrongly named group in log when removing an expired boost group
- fixed platforms donut chart on stats page; values of Android and Linux were inverted
- fixed admin mode on "list rankup"; when joining the list rankup in admin-mode and changing sorting of the site, the admin mode was lost

1.2.11 (2018-09-27)

* optimized version check for command !version and on some other places
* optimized some help texts on the webinterface (leading english and german); also cleaned up the language files
* updated russian translation; thx to bykidi
* removed 2nd TS3 queryname; is no more needed with server version 3.4.0 or above
+ added support for new connect parameter 'client_nickname' which comes with version 3.4.0; this allows setting the nickname of query clients before they become visible on the virtual server
+ added cleaning tables admin_addtime and addon_assign_groups due Ranksystem update process
+ added database table for CSRF token; with that multiple siteswitches are possible without getting an CSRF error
+ added message to Ranksystem admin user, when a servergroup gets deleted, which is configured to the Ranksystem
+ added new check the HSTS header is already sent; on some webservers got a problem, which already sent this information
+ added sticking display size of group- and servericons on the stats page to 16x16 pixel