Minor fixes for v1.0 release, mostly comments, add openrc init script

.perlcriticrc

@@ -93,3 +93,4 @@ lib_sections    = NAME | VERSION | DESCRIPTION | AUTHOR | LICENSE AND COPYRIGHT
 [-ControlStructures::ProhibitDeepNests]
 # Have to use it, so fuckoff
 
+[-Variables::ProhibitPackageVars]

Phrases.txt

@@ -11,13 +11,13 @@
 	* с префиксом в виде любого количества пробельных символов + имени бота + любое количество пробельных символов +
 	  опциональньная запятая + любое количество пробельных символов. После команды опциональная точка и любое
 	  количество пробельных символов.
-	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретны чат-
+	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретный чат-
 	  протокол) + команда + опциональная точка и любое количество пробельных символов.
   - Для публичных чатов допустимой являются нотации:
 	* с префиксом в виде любого количества пробельных символов + имени бота + любое количество пробельных символов +
 	  опциональньная запятая + любое количество пробельных символов. После команды опциональная точка и любое
 	  количество пробельных символов.
-	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретны чат-
+	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретный чат-
 	  протокол) + команда + опциональная точка и любое количество пробельных символов.
   Ответ на эту фразу - слово "Pong." если фраза была на английском языке или "Понг.", если фраза была на русском языке.
 
@@ -28,15 +28,20 @@
 	* с префиксом в виде любого количества пробельных символов + имени бота + любое количество пробельных символов +
 	  опциональньная запятая + любое количество пробельных символов. После команды опциональная точка и любое
 	  количество пробельных символов.
-	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретны чат-
+	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретный чат-
 	  протокол) + ping + опциональная точка и любое количество пробельных символов.
   - Для публичных чатов допустимой являются нотации:
 	* с префиксом в виде любого количества пробельных символов + имени бота + любое количество пробельных символов +
 	  опциональньная запятая + любое количество пробельных символов. После команды опциональная точка и любое
 	  количество пробельных символов.
-	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретны чат-
+	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретный чат-
 	  протокол) + команда + опциональная точка и любое количество пробельных символов.
   Ответ на эту фразу - слово "Wat?" если фраза была на английском языке или "Шта?", если фраза была на русском языке.
+* lat или лат
+  - Для приватных и публичных чатов допустимой является нотация:
+    * символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретный чат-
+	  протокол) + команда + опциональная точка и любое количество пробельных символов.
+  Ответ на эту фразу - одно произвольное предложение из предсгенерённого "мозга" с цепями Маркова.
 
 * halp или хэлп
   - Для приватных чатов допустимой являются нотации:
@@ -45,34 +50,34 @@
 	* с префиксом в виде любого количества пробельных символов + имени бота + любое количество пробельных символов +
 	  опциональньная запятая + любое количество пробельных символов. После команды опциональная точка и любое
 	  количество пробельных символов.
-	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретны чат-
+	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретный чат-
 	  протокол) + команда + опциональная точка и любое количество пробельных символов.
   - Для публичных чатов допустимой являются нотации:
 	* с префиксом в виде любого количества пробельных символов + имени бота + любое количество пробельных символов +
 	  опциональньная запятая + любое количество пробельных символов. После команды опциональная точка и любое
 	  количество пробельных символов.
-	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретны чат-
+	* символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретный чат-
 	  протокол) + команда + опциональная точка и любое количество пробельных символов.
   Ответ на эту фразу - слово "HALP!!!11".
 
 * kde или кде
   - Для приватных и публичных чатов допустимой является нотация:
-    * символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретны чат-
+    * символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретный чат-
 	  протокол) + команда + опциональная точка и любое количество пробельных символов.
   Ответ на эту фразу - одно произвольное предложение из массива ответов на эту фразу.
 
 * roll или dice или кости
   - Для приватных и публичных чатов допустимой является нотация:
-    * символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретны чат-
+    * символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретный чат-
 	  протокол) + команда + опциональная точка и любое количество пробельных символов.
   Ответ на эту фразу - "На первой кости выпало M, а на второй — N.", где M и N произвольные целые числа от 1 до 6
   включительно.
 
 * ver или version или версия
   - Для приватных и публичных чатов допустимой является нотация:
-    * символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретны чат-
+    * символ команды (по-умолчанию - восклицательный знак, задаётся в настройках модуля, отвечающего за конкретный чат-
 	  протокол) + команда + опциональная точка и любое количество пробельных символов.
-  Ответ на эту фразу - номер версии ПО.
+  Ответ на эту фразу - приблизительный номер версии ПО.
 
 * кто все эти люди?
   - Для приватных и публичных чатов допустимой является нотация:

README

@@ -7,16 +7,17 @@ aleesa-craniac
 Механика работы
 -----------------------------------------------------------------------------------------------------------------------
 Бредогенератор подписан на redis-канал craniac. В этот канал пишет другой демоночек - aleesa-misc. Причём, особенность
-такова, что если aleesa-misc не распознала фразу как команду для другого модуля, то по-умолчанию такая фраза
+такова, что если aleesa-misc не распознала фразу, как команду для другого модуля, то по-умолчанию такая фраза
 оправляется в канал craniac, то есть сюда, в "мозги".
 
 У бредогенератора есть 2 типа входящих сообщений - ключевые фразы, на которые у него есть готовые (статические) ответы
 и остальные, для которых ему надо решить нужен ли ответ и по-необходимости сгенерировать его, используя данные в цепях
 Маркова.
 
-Ответ направляется в redis-канал, указанный в поле plugin входящего сообщения.
+Ответ направляется в redis-канал, указанный в поле plugin входящего сообщения, если не предполагается некоей особой
+логики, связанной с easter egg поведением.
 
-Формат протокола - см README от aleesa-misc.
+Формат протокола - см. README от aleesa-misc.
 
 
 Как это запустить?
@@ -30,3 +31,9 @@ aleesa-craniac
 
 Если всё хорошо, то после запуска redis-а, создания data/config.json из data/config_sample.json, можно запускать и само
 приложение.
+
+В каталоге contrib находится скрипт для alpine linux, системы инициализации openrc. Этот скрипт достаточно положить В
+/etc/init.d/aleesa-craniac сконфигурить сервис по инструкции выше и после этого сервис запускается командой:
+service aleesa-craniac start
+в автозагрузку его можно прописать через команду
+rc-update add aleesa-craniac default

bin/aleesa-craniac

@@ -31,6 +31,7 @@ use File::Basename qw (basename dirname);
 use File::Path qw (make_path);
 use Mojo::Log;
 use POSIX qw (setgid setuid setsid);
+
 use Conf qw (LoadConf);
 use Craniac qw (RunCraniac);
 

bin/train_lat.pl

@@ -0,0 +1,27 @@
+#!/usr/bin/perl
+# Наполняет отдельный "мозг" с бредом латинскими выражениями
+
+use 5.018;
+use strict;
+use warnings;
+use utf8;
+use open qw (:std :utf8);
+use English qw ( -no_match_vars );
+use version; our $VERSION = qw (1.0);
+
+my $workdir;
+
+# До фактического запуска логики программы, сменим рабочий каталог, чтобы подцепить либы
+BEGIN {
+	use Cwd qw (chdir abs_path);
+	my @CWD = split /\//xms, abs_path ($PROGRAM_NAME);
+	if ($#CWD > 1) { $#CWD = $#CWD - 2; }
+	$workdir = join '/', @CWD;
+	chdir $workdir;
+}
+
+use lib ("$workdir/lib", "$workdir/vendor_perl", "$workdir/vendor_perl/lib/perl5");
+use Craniac::Lat qw (Train);
+
+Train ();
+exit 0;

contrib/aleesa-craniac.openrc

@@ -0,0 +1,11 @@
+#!/sbin/openrc-run
+
+name="$SVCNAME"
+command="/var/lib/$SVCNAME/bin/$SVCNAME"
+pidfile="/var/run/$SVCNAME/$SVCNAME.pid"
+
+depend() {
+	need net redis
+	use dns
+	after redis
+}

cpanfile

@@ -1,3 +1,4 @@
+requires 'Carp',                 '==1.50';
 requires 'Cwd',                  '0';
 requires 'Cwd::utf8',            '==0.011';
 requires 'Digest::SHA',          '==6.02';
@@ -7,15 +8,15 @@ requires 'File::Basename',       '0';
 requires 'File::Path',           '==2.18';
 requires 'Hailo',                '==0.75';
 requires 'JSON::XS',             '==4.03';
-requires 'local::lib',           '==2.000024';
+requires 'local::lib',           '==2.000028';
 requires 'Math::Random::Secure', '==0.080001';
 requires 'Mojolicious',          '==9.22';
 requires 'Mojo::IOLoop',         '0';
 requires 'Mojo::IOLoop::Signal', '==0.003';
 requires 'Mojo::Log',            '0';
-requires 'Mojo::Redis',          '==3.26';
+requires 'Mojo::Redis',          '==3.27';
 requires 'POSIX',                '0';
 requires 'Protocol::Redis::XS',  '0';
 requires 'Text::Fuzzy',          '==0.29';
 requires 'utf8',                 '0';
-requires 'version',              '0';
+requires 'version',              '==0.9929';

data/config_sample.json

@@ -1,26 +1,32 @@
 {
     "server" : "redis",
     "port" : "6379",
-
-# inbound redis channels, where we subscribed
-    "channels": [
-        "craniac",
+    "channels" : [
+        "craniac"
     ],
 
-# should we fork() and become unix daemon?
-    "daemonize": 1,
+    # should we fork() and become unix daemon?
+    "daemonize" : 1,
 
-# caches and other data goes there
+    # caches and other data goes there
     "cachedir" : "data/cache",
     "braindir" : "data/brains",
 
     # unprivileged system user to run bot as
     "user" : "nobody",
 
-# logs goes there
+    # logs goes there
     "log" : "/var/log/aleesa-craniac/aleesa-craniac.log",
-    "loglevel": "info",
+    "loglevel" : "info",
 
-# ditto
-    "pid" : "/var/run/aleesa-craniac/aleesa-craniac.pid"
+    # ditto
+    "pid" : "/var/run/aleesa-craniac/aleesa-craniac.pid",
+
+    # maximal amount of message forwardings, to avoid endless loops
+    "forwards_max" : 5,
+
+    "lat" : {
+        "brain" : "data/lat/brain.sqlite",
+        "src" : "data/lat.txt"
+    }
 }

lib/Craniac.pm

@@ -1,6 +1,6 @@
 package Craniac;
 # Предполагается, что craniac - это "маршрут по-умолчанию". То есть сюда попадают все фразы, которые не были распознаны
-# aleesa-misc как команды.
+# aleesa-misc как команды. В том числе и некоторые команды (но по идее это так и задумано).
 
 # Основная задача мозгов - распознать, требуется ли ответ и обработать фразу.
 # Соответсвенно, мы предполагаем, что фразы делятся на 2 типа:
@@ -29,6 +29,8 @@ use Math::Random::Secure qw (irand);
 use Text::Fuzzy qw (distance_edits);
 
 use Conf qw (LoadConf);
+use Craniac::Lat qw (Lat);
+
 use version; our $VERSION = qw (1.0);
 use Exporter qw (import);
 our @EXPORT_OK = qw (RunCraniac);
@@ -41,6 +43,7 @@ sub RunCraniac ();
 
 my $c = LoadConf ();
 my $loglevel = $c->{'loglevel'} // 'info';
+my $fwd_cnt = $c->{'forward_max'} // 5;
 my $logfile;
 my $log;
 
@@ -58,6 +61,8 @@ if (defined $logfile) {
 
 my $hailo;
 
+# Несколько фраз общего характера, используемые как универсальный ответ, когда ответить нечего (по тем или иным
+# причинам) или ответ не будет достаточно вменяемым (слишком похож на фразу, на которую отвечаем)
 sub RandomCommonPhrase () {
 	my @myphrase = (
 		'Так, блядь...',
@@ -101,21 +106,24 @@ sub fmatch (@) {
 	}
 }
 
+# Ленивая инициализация мозга. Создаём/открываем мозг только если нам надо "подумать" а не на каждую входящую фразу.
 sub brains (@) {
 	my $chatid = shift;
 	my $telegram = shift // 0;
 
 	unless (defined $hailo->{$chatid}) {
 		my $cid = $chatid;
+		my $brainname;
 
-		# Костыль, чтобы не портировать данные из телеграммных мозгов
+		# Костыль, чтобы не портировать данные из телеграммных мозгов и не заниматься переименованием
 		unless ($telegram) {
 			$cid = utf2sha1 ($chatid);
 			$cid =~ s/\//-/xmsg;
+			$brainname = sprintf '%s/%s.sqlite', $c->{braindir}, $cid;
+		} else {
+			$brainname = sprintf '%s/%s.brain.sqlite', $c->{braindir}, $cid;
 		}
 
-		my $brainname = sprintf '%s/%s.sqlite', $c->{braindir}, $cid;
-
 		$hailo->{$chatid} = eval {
 			Hailo->new (
 				brain => $brainname,
@@ -124,9 +132,9 @@ sub brains (@) {
 		};
 
 		if (defined $hailo->{$chatid}) {
-			$log->info (sprintf 'Lazy init brain: %s', $brainname);
+			$log->info (sprintf '[INFO] Lazy init brain: %s', $brainname);
 		} else {
-			$log->warn ($EVAL_ERROR);
+			$log->error ("[ERROR] $EVAL_ERROR");
 			return 0;
 		}
 	}
@@ -147,6 +155,18 @@ my $parse_message = sub {
 	# Если $m->{misc}->{answer} не существует, то проставим его как 1, предполагаем, что по-умолчанию ответ от нас
 	# всё-таки ожидают. Если что - уточним ниже.
 	if (defined $m->{misc}) {
+		unless (defined $m->{misc}->{fwd_cnt}) {
+			$m->{misc}->{fwd_cnt} = 1;
+		} else {
+			if ($m->{misc}->{fwd_cnt} > $fwd_cnt) {
+				$log->error ('[ERROR] Forward loop detected, discarding message.');
+				$log->debug (Dumper $m);
+				return;
+			} else {
+				$m->{misc}->{fwd_cnt}++;
+			}
+		}
+
 		unless (defined $m->{misc}->{answer}) {
 			$m->{misc}->{answer} = 1;
 		}
@@ -232,6 +252,8 @@ my $parse_message = sub {
 			$reply = sprintf 'На первой кости выпало %d, а на второй — %d.', irand (6) + 1, irand (6) + 1;
 		} elsif ($m->{message} =~ /^\Q$m->{misc}->{csign}\E(ver|version|версия)$/ui) {
 			$reply = 'Версия:  Четыре.Технологическое_превью';
+		} elsif ($m->{message} =~ /^\Q$m->{misc}->{csign}\E(lat|лат)\s*$/ui) {
+			$reply = Lat ();
 		}
 	}
 
@@ -251,17 +273,35 @@ my $parse_message = sub {
 		}
 	} else {
 		# Пока что нам нечего ответить, известных фраз не нашлось. Ищем дальше, на сей раз фразы, зависящие от режима
-		# общения - приватного ли публичного.
+		# общения - приватного или публичного.
 		if ($m->{mode} eq 'private') {
-			$phrase =~ s/^\s*(вот\s+)?скажи(\s*мне)?\s*//gui;
-			$phrase =~ s/\s*(,)?\s*а\s*\?$/?/gui;
+			# Если указанной в unless-е строки во фразе нету, то можно поискать другие приватные фразы
+			unless ($phrase =~ s/^\s*(вот\s+)?скажи(\s*мне)?\s*//gui) {
+				if ($phrase =~ /покажи +(сиськи|сиси|титьки)\s*$/ui) {
+					$send_to = 'webapp';
+					$reply = '!boobs';
+				} elsif ($phrase =~ /show +(titts|tities|boobs)\s*$/i) {
+					$send_to = 'webapp';
+					$reply = '!boobs';
+				} elsif ($phrase =~ /покажи +(попку|попу) *$/ui) {
+					$send_to = 'webapp';
+					$reply = '!ass';
+				} elsif ($phrase =~ /show +(ass|butt|butty) *$/i) {
+					$send_to = 'webapp';
+					$reply = '!ass';
+				}
+			}
 
-			if ($phrase =~ /^\s*кто\s+все\s+эти\s+люди\s*\?\s*$/ui) {
-				$reply = 'Какие "люди"? Мы здесь вдвоём, только ты и я.';
-			} elsif ($phrase =~ /^\s*кто\s+я\s*\?\s*$/ui) {
-				$reply = 'Где?';
-			} elsif ($phrase =~ /^\s*кто\s+(здесь|тут)\s*\?\s*$/ui) {
-				$reply = 'Ты да я, да мы с тобой.';
+			unless (defined $reply) {
+				$phrase =~ s/\s*(,)?\s*а\s*\?$/?/gui;
+
+				if ($phrase =~ /^\s*кто\s+все\s+эти\s+люди\s*\?\s*$/ui) {
+					$reply = 'Какие "люди"? Мы здесь вдвоём, только ты и я.';
+				} elsif ($phrase =~ /^\s*кто\s+я\s*\?\s*$/ui) {
+					$reply = 'Где?';
+				} elsif ($phrase =~ /^\s*кто\s+(здесь|тут)\s*\?\s*$/ui) {
+					$reply = 'Ты да я, да мы с тобой.';
+				}
 			}
 
 			# TODO: дописать запрос в webapp, для easter egg-ов, либо делать это на уровне aleesa-misc
@@ -309,8 +349,14 @@ my $parse_message = sub {
 		if ($m->{misc}->{answer}) {
 			# Пытаемся что-то генерировать, если фраза длиннее 3-х букв
 			if (length ($m->{message}) > 3) {
+				my $telegram = 0;
+
+				if ($m->{plugin} eq 'telegram') {
+					$telegram = 1;
+				}
+
 				# Lazy brain init
-				if (brains ($chatid, 1)) {
+				if (brains ($chatid, $telegram)) {
 					$reply = $hailo->{$chatid}->learn_reply ($m->{message});
 
 					# Если из реактора вернулся undef выдаём "общую" фразу из словаря
@@ -342,7 +388,13 @@ my $parse_message = sub {
 		} else {
 			# пытаемся что-то запоминать, если фраза длиннее 3-х букв
 			if (length ($m->{message}) > 3) {
-				if (brains ($chatid, 1)) {
+				my $telegram = 0;
+
+				if ($m->{plugin} eq 'telegram') {
+					$telegram = 1;
+				}
+
+				if (brains ($chatid, $telegram)) {
 					$hailo->{$chatid}->learn ($m->{message});
 				}
 			}

lib/Craniac/Lat.pm

@@ -0,0 +1,90 @@
+package Craniac::Lat;
+# Крылатые латинские выражения спёрты с https://ru.wikipedia.org/wiki/Список_крылатых_латинских_выражений
+
+use 5.018;
+use strict;
+use warnings;
+use utf8;
+use open qw (:std :utf8);
+use English qw ( -no_match_vars );
+use Carp qw (cluck);
+use File::Basename qw (dirname);
+use File::Path qw (make_path);
+use Hailo;
+use Mojo::Log;
+
+use Conf qw (LoadConf);
+
+use version; our $VERSION = qw (1.0);
+use Exporter qw (import);
+our @EXPORT_OK = qw (Train Lat);
+
+# В нашем случае среднее количество слов в фразе равно 3, поэтому ставим 2 :)
+my $brain_order = 2;
+
+my $c = LoadConf ();
+my $brain = $c->{lat}->{brain};
+my $srcfile = $c->{lat}->{src};
+my $loglevel = $c->{'loglevel'} // 'info';
+my $log;
+
+if (defined $c->{'log'}) {
+	$logfile = $c->{'log'};
+} elsif (defined $c->{'debug_log'}) {
+	$logfile = $c->{'debug_log'};
+}
+
+if (defined $logfile) {
+	$log = Mojo::Log->new (path => $logfile, level => $loglevel);
+} else {
+	$log = Mojo::Log->new (path => '/dev/null', level => 'fatal');
+}
+
+sub Train () {
+	my $braindir = dirname $brain;
+
+	unless (-d $braindir) {
+		make_path ($braindir) or do {
+			cluck "Unable to create $braindir: $OS_ERROR";
+			exit 1;
+		};
+	}
+
+	my $lat = Hailo->new (
+		brain => $brain,
+		order => $brain_order
+	);
+
+	$lat->train ($srcfile);
+	my ($tokens, $expressions) = ($lat->stats ())[0,1];
+	printf "Total tokens: %s\nTotal expressions: %s\n", $tokens, $expressions;
+	$lat->save ();
+	return;
+}
+
+# Просто вернём ответ
+sub Lat () {
+	my $braindir = dirname $brain;
+
+	unless (-d $braindir) {
+		$log->error ("[ERROR] No lat module data: $braindir is absent! Train lat first.");
+		return '';
+	}
+
+	unless (-f $brain) {
+		$log->error ("[ERROR] No lat module data: $brain is absent! Train lat first.");
+		return '';
+	}
+
+	my $lat = Hailo->new (
+		brain => $brain,
+		order => $brain_order,
+		save_on_exit => 0
+	);
+
+	return $lat->reply ();
+}
+
+1;
+
+# vim: ft=perl noet ai ts=4 sw=4 sts=4: