From: Maxim Mamontov <faust.madf@gmail.com>
Date: Mon, 14 Jan 2013 19:14:21 +0000 (+0200)
Subject: Patch from SpiderX <spiderx@spiderx.dp.ua> - scripts.
X-Git-Tag: 2.409~382
X-Git-Url: https://git.stg.codes/stg.git/commitdiff_plain/4b7c404f1c3340d5e0ce0d1763176d04f9774d98?hp=611e9aeab755acbfbccd42006c2b769d5843cbe5

Patch from SpiderX <spiderx@spiderx.dp.ua> - scripts.
---

diff --git a/projects/stargazer/inst/linux/etc/stargazer/OnChange b/projects/stargazer/inst/linux/etc/stargazer/OnChange
index 8cb10961..c1ad6a64 100755
--- a/projects/stargazer/inst/linux/etc/stargazer/OnChange
+++ b/projects/stargazer/inst/linux/etc/stargazer/OnChange
@@ -1,8 +1,20 @@
 #! /bin/sh
 
-login=$1
-param=$2
-oldValue=$3
-newValue=$4
+# About: This script is called when user account is changed.
+# Common Task: Notify about various events.
+# Priority: optional
 
-#echo "User: '$login'. Parameter $param changed from '$oldValue' to '$newValue'" >> /var/stargazer/users.chg.log
\ No newline at end of file
+# User login
+LOGIN=$1
+
+# User parameter
+PARAMETER=$2
+
+# User parameter old value
+OLDVALUE=$3
+
+# User parameter new value
+NEWVALUE=$4
+
+# Usage examples:
+#echo "User: '$LOGIN'. Parameter $PARAMETER changed from '$OLDVALUE' to '$NEWVALUE'" >> /var/stargazer/user.change.log
\ No newline at end of file
diff --git a/projects/stargazer/inst/linux/etc/stargazer/OnConnect b/projects/stargazer/inst/linux/etc/stargazer/OnConnect
index 912ed7d9..cb1f64f4 100755
--- a/projects/stargazer/inst/linux/etc/stargazer/OnConnect
+++ b/projects/stargazer/inst/linux/etc/stargazer/OnConnect
@@ -1,24 +1,23 @@
 #! /bin/sh
 
-#Этот скрипт вызывается в момент, когда пользователь
-#успешно прошел авторизацию на сервере. Задача скрипта - перестроить 
-#файрвол так, что бы пользователь получил доступ в интернет
+# About: This script is called when the user successfully authenticated on the server.
+# Common Task: Rebuild firewall to allow user to access the Internet.
+# Priority: required
 
-# Login
+# User login
 LOGIN=$1
 
-#user IP
+# User IP
 IP=$2
 
-#cash
+# User cash
 CASH=$3
 
-#user ID
+# User ID
 ID=$4
 
-#Selected dirs to connect
+# Selected DIRs (from rules file) to connect
 DIRS=$5
 
-
-#echo "C `date +%Y.%m.%d-%H.%M.%S` $IP $CASH" >> /var/stargazer/users/$LOGIN/connect.log
-
+# Usage examples:
+#echo "Connected `date +%Y.%m.%d-%H.%M.%S` $IP $CASH" >> /var/stargazer/users/$LOGIN/connect.log
\ No newline at end of file
diff --git a/projects/stargazer/inst/linux/etc/stargazer/OnDisconnect b/projects/stargazer/inst/linux/etc/stargazer/OnDisconnect
index 6169ddc8..64a6c519 100755
--- a/projects/stargazer/inst/linux/etc/stargazer/OnDisconnect
+++ b/projects/stargazer/inst/linux/etc/stargazer/OnDisconnect
@@ -1,24 +1,23 @@
 #! /bin/sh
 
-# Этот скрипт вызывается в момент, когда пользователь
-# желает отключится от интернета или вышел таймаут у пользователя
-# и сервер сам отключает пользователя
-# Задача скрипта подобна задаче скрипта OnConnect - перестроить 
-# файрвол так, что бы пользователю закрыть доступ в интернет
+# About: This script is called when the user wants to disconnect or authorization timeout has passed.
+# Common task: Rebuild firewall to disallow user to access the Internet.
+# Priority: required
 
-# Login
+# User login
 LOGIN=$1
 
-#user IP
+# User IP
 IP=$2
 
-#cash
+# User cash
 CASH=$3
 
-#user ID
+# User ID
 ID=$4
 
-#Selected dirs to disconnect
+# Selected DIRs (from rules file) to disconnect
 DIRS=$5
 
-#echo "D `date +%Y.%m.%d-%H.%M.%S` $IP $CASH" >> /var/stargazer/users/$LOGIN/connect.log
+# Usage examples:
+#echo "Disconnected `date +%Y.%m.%d-%H.%M.%S` $IP $CASH" >> /var/stargazer/users/$LOGIN/connect.log
diff --git a/projects/stargazer/inst/linux/etc/stargazer/OnUserAdd b/projects/stargazer/inst/linux/etc/stargazer/OnUserAdd
index 22d321cc..2dcc0562 100755
--- a/projects/stargazer/inst/linux/etc/stargazer/OnUserAdd
+++ b/projects/stargazer/inst/linux/etc/stargazer/OnUserAdd
@@ -1,14 +1,12 @@
 #! /bin/sh
 
-# Использование (неиспользование) этого скрипта дело вкуса.
-# Он не выполняет критических функций. Его задача автматизировать
-# действия характерные при добавлении пользователя сети, например добавлекние 
-# пользователю почты
-
-# Login
-login=$1
-
-#echo "added user $login" >> /var/stargazer/add_del.log
-
+# About: This script is called when the user is added to the Stargazer.
+# Common task: Automate typical actions on adding user to the network,
+#              such as creating email or IM account.
+# Priority: optional
 
+# User login
+LOGIN=$1
 
+# Usage examples:
+#echo "Added user $login" >> /var/stargazer/add_del.log
\ No newline at end of file
diff --git a/projects/stargazer/inst/linux/etc/stargazer/OnUserDel b/projects/stargazer/inst/linux/etc/stargazer/OnUserDel
index 248e5b36..a72da15b 100755
--- a/projects/stargazer/inst/linux/etc/stargazer/OnUserDel
+++ b/projects/stargazer/inst/linux/etc/stargazer/OnUserDel
@@ -1,7 +1,13 @@
 #! /bin/sh
 
-# Login
-login=$1
+# About: This script is called when the user is removed from the Stargazer.
+# Common task: Automate typical actions on removing user from the network,
+#              such as removing email or IM account.
+# Priority: optional
 
-#echo "deleted user $login" >> /var/stargazer/add_del.log
+# User login
+LOGIN=$1
+
+# Usage examples:
+#echo "Deleted user $LOGIN" >> /var/stargazer/add_del.log