Parental control

Allows to control user login time and calculate consumed time in Windows and Linux. Basically this app is advantaged version of this script

#!/bin/bash

# Add this script to Crone
# */1 0-7,10-17,19-23 * * * parental-control

USER=vasyaod
IS_USER_LOGINED=$(who | grep $USER)

if [ ! -z "$IS_USER_LOGINED" ]
then
  # echo "vasyaod is here"
  skill -KILL -u $USER
fi

but with more features

flexible schedule
supporting multiple users
time counter
daily limits
web UI (installation of the UI is not obligatory) which allows to see
- state of consumed time for current date
- statistics of consumed time

Installation

Windows Pro

Be sure that your Windows version is Pro
Download parental-control-setup.exe
Run parental-control-setup.exe

Windows Home (beta)

Be sure that your Windows version is Home
Download parental-control-setup.exe
Run parental-control-setup.exe

Debian/Ubuntu

Download parental-control-all-1.0.0.deb
Install the package by dpkg -i parental-control-all-1.0.0.deb
Also there is a way set up only the schedule daemon without a web interface by dpkg -i parental-control-1.0.0.deb

CentOS/Redhat/Fedora

The OS was not tested

Download parental-control-all-1.0-1.x86_64.rpm
Install the package by rpm –i parental-control-all-1.0-1.x86_64.rpm
Also there is a way set up only the schedule daemon without a web interface by rpm –i parental-control-1.0-1.x86_64.rpm

Configs

There are two type for configs

permanent config which is loaded during of application start, the config file can be found in /etc/parental-control/config.yml (or C:\Program Files\parental-control\config.yml for Windows) and has primary setting of the service
dynamic config for schedule of users. It's dynamic because the file periodically (5 mins) loads from given source and by default it can be found /etc/parental-control/users-config.yml

Examples of the config files with parameter description is available in the repo config.yml and user-sconfig.yml

HTTP interface

By default HTTP interface is available on http://localhost:8090 where following things can be find

consumed time per each user

Screenshot

HTTP API

http://localhost:8090/state returns state of the app as JSON in the next format

{
    "userStates": {
        "sunny": {
            "messageSent": false,
            "minuteCount": 0,
            "lastChanges": "2020-09-14T04:32:47.391878169"
        },
        "yasha": {
            "messageSent": false,
            "minuteCount": 0,
            "lastChanges": "2020-09-14T04:32:47.391878169"
        }
    }
}

http://localhost:8090/stats returns aggregated logs for one year and all users

[
    { "user": "yasha", "date": "2020-09-14", "minutes": 60 },
    { "user": "sunny", "date": "2020-09-14", "minutes": 87 },
    { "user": "yasha", "date": "2020-09-15", "minutes": 10 }
    ...
]

Maintenance

Build of schedule and web daemons

cd schedule-daemon
stack build --test --copy-bins

Output files:

windows:
- $HOME\AppData\Roaming\local\bin\parental-control.exe
- $HOME\AppData\Roaming\local\bin\parental-control-web.exe
linux:
- $HOME/.local/bin/parental-control
- $HOME/.local/bin/parental-control-web

Build of web UI

cd web-ui
npm install
npm rub build

Linux

Run as daemon

start-stop-daemon -S -b -u root --exec /root/parental-control -- -c /etc/parental-control/config.yml

Stop daemon

start-stop-daemon -K --exec /root/parental-control

Windows

Windows Service Wrapper https://github.com/winsw/winsw

License

MIT License

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.

vasyaod / parental-control

readme