Pass logger object to the mainsettings hash for a usage
[people/stevee/guardian.git] / guardian
CommitLineData
88d9af2c
SS
1#!/usr/bin/perl
2###############################################################################
3# #
4# IPFire.org - A linux based firewall #
5# Copyright (C) 2015 IPFire Development Team #
6# #
7# This program is free software: you can redistribute it and/or modify #
8# it under the terms of the GNU General Public License as published by #
9# the Free Software Foundation, either version 3 of the License, or #
10# (at your option) any later version. #
11# #
12# This program is distributed in the hope that it will be useful, #
13# but WITHOUT ANY WARRANTY; without even the implied warranty of #
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15# GNU General Public License for more details. #
16# #
17# You should have received a copy of the GNU General Public License #
18# along with this program. If not, see <http://www.gnu.org/licenses/>. #
19# #
20###############################################################################
21
22use strict;
23use threads;
24use threads::shared;
45bf2a03 25use Getopt::Long;
88d9af2c
SS
26use Thread::Queue;
27use Linux::Inotify2;
01147a7e 28use Time::HiRes qw[ time sleep ];
88d9af2c 29
3111df62 30require Guardian::Base;
45bf2a03 31require Guardian::Config;
c95dfa5b 32require Guardian::Logger;
88d9af2c 33require Guardian::Parser;
6abac3d4 34require Guardian::Socket;
88d9af2c 35
5c694317
SS
36use warnings;
37
e02ed027
SS
38# Disable warnings of unjoinded threads when stopping guardian.
39no warnings 'threads';
40
45bf2a03
SS
41# Define version.
42my $version ="2.0";
43
45bf2a03
SS
44# Get and store the given command line arguments in a hash.
45my %cmdargs = ();
46
47&GetOptions (\%cmdargs,
48 'foreground|f',
49 'config|c=s',
50 'help|h',
51 'version|v',
52);
53
54# Show help / version information.
55if (defined($cmdargs{"help"})) {
56 print "Guardian $version \n";
57 print "Usage: guardian <optional arguments>\n";
58 print " -c, --config\t\tspecifiy a configuration file other than the default (/etc/guardian/guardian.conf)\n";
59 print " -f, --foreground\trun in the foreground (doesn't fork, any output goes to STDOUT)\n";
60 print " -h, --help\t\tshows this help\n";
61 print " -v, --version\t\tdisplay programm version and exit.\n";
62 exit;
63} elsif (defined($cmdargs{"version"})) {
64 print "Guardian $version \n";
65 exit;
66}
67
68# Read-in the configuration file and store the settings.
69# Push the may be given config file argument.
70my %mainsettings = &Guardian::Config::UseConfig($cmdargs{"config"});
71
c95dfa5b
SS
72# Initialize Logger.
73my $logger = Guardian::Logger->New(%mainsettings);
74$logger->Log("debug", "Logger successfully initialized...");
75
fc555263
SS
76# Add the logger object to the mainsettings for passing
77# it to the modules.
78$mainsettings{Logger} = $logger;
79
0815025a
SS
80# Redirect perls "die" messages to the logger before exiting.
81$SIG{__DIE__} = sub { $logger->Log("err", "@_"); };
82
3111df62
SS
83# Shared hash between the main process and all threads. It will store all
84# monitored files and their current file position.
85my %monitored_files :shared = ();
86
88d9af2c
SS
87# Create the main queue. It is used to store and process all events which are
88# reported and enqueued by the worker threads.
c0a59a63 89my $queue :shared = new Thread::Queue or die "Could not create new, empty queue. $!";;
88d9af2c 90
9c74e9bb
SS
91# Array to store all currently running worker objects.
92# (Does not include the socket thread)
93my @running_workers;
94
88d9af2c
SS
95# Call Init function to initzialize guardian.
96&Init();
97
98# Infinite main loop, which processes all queued events.
99while(1) {
100 # Get the amount of elements in our queue.
101 # "undef" will be returned if it is empty.
102 my $current_events = $queue->pending();
103
104 # If there is at least one element enqued
105 if($current_events > 0) {
106 # Grab the data of the top enqueued event.
107 my $event = $queue->peek();
108
c95dfa5b
SS
109 # Log processed event.
110 $logger->Log("debug", "QUEUE - Processed event: $event");
88d9af2c
SS
111
112 # Drop processed event from queue.
113 $queue->dequeue();
114 }
115
01147a7e
SS
116 # Sleep 10ms to reduce the load of the main process.
117 sleep(0.01);
88d9af2c
SS
118}
119
120#
121## Init function.
122#
123## This function contains code which has to be executed while guardian
124## is starting.
125#
126sub Init () {
915d9f45
SS
127 # Setup signal handler.
128 &SignalHandler();
129
6abac3d4
SS
130 # Setup IPC mechanism via Socket in an own thread.
131 threads->create(\&Socket);
132
3111df62
SS
133 # Generate hash of monitored files.
134 %monitored_files = &Guardian::Base::GenerateMonitoredFiles(\%mainsettings, \%monitored_files);
135
9c74e9bb
SS
136 # Start worker threads.
137 &StartWorkers();
88d9af2c
SS
138}
139
140#
141## Worker function.
142#
143## This function is responsible for monitoring modifications of the given logfile,
144## read them and pass them to the message parser.
145#
146## To get file modifications the inotify subsystem of the linux kernel is used.
147#
148## In order to prevent from permanently read and keep files opened, or dealing
149## with huge logfiles, at initialization time of the worker process, the file will
150## be opened once and the cursor position of the end of file (EOF) get stored. When
151## reading any newly added lines from the file, we directly can jump to the last
152## known position and get these lines. Afterwards, we store the current curser position
153## again, so we can do it in this way over and over again.
154#
155## All read lines get stored in an array, which will be passed to the Parser.
156#
157## If any response (action) from the parser get recieved, it will be put into the
158## shared event queue.
159#
160sub Worker ($) {
9c74e9bb
SS
161 my $file = $_[0];
162
163 # Signal handler to kill worker.
164 $SIG{'KILL'} = sub { threads->exit(); };
88d9af2c 165
88d9af2c 166 # Create inotify watcher.
c0a59a63 167 my $watcher = new Linux::Inotify2 or die "Could not use inotify. $!";
88d9af2c
SS
168
169 # Monitor the specified file.
c0a59a63 170 $watcher->watch("$file", IN_MODIFY) or die "Could not monitor $file. $!";
88d9af2c 171
9c74e9bb
SS
172 # Switch watcher into non-blocking mode.
173 $watcher->blocking(0);
88d9af2c 174
c95dfa5b
SS
175 # Log successfully spawned worker.
176 $logger->Log("debug", "Spawned worker thread for: $file");
177
9c74e9bb
SS
178 # Infinite loop.
179 while(1) {
180 # Check for any events and perform them, if there
181 # is a least one.
182 if ($watcher->read) {
183 my @message = ();
88d9af2c 184
3111df62
SS
185 # Obtain fileposition from hash.
186 my $fileposition = $monitored_files{$file};
187
9c74e9bb 188 # Open the file.
c0a59a63 189 open (FILE, $file) or die "Could not open $file. $!";
88d9af2c 190
9c74e9bb
SS
191 # Seek to the last known position.
192 seek (FILE, $fileposition, 0);
88d9af2c 193
9c74e9bb
SS
194 # Get the log message.
195 while (my $line = <FILE>) {
196 # Remove any newlines.
197 chomp $line;
88d9af2c 198
9c74e9bb
SS
199 # Add all lines to the message array.
200 push (@message, $line);
201 }
88d9af2c 202
3111df62
SS
203 {
204 # Lock shared hash.
205 lock(%monitored_files);
206
207 # Update fileposition.
208 $monitored_files{$file} = tell(FILE);
209 }
88d9af2c 210
9c74e9bb
SS
211 # Close file.
212 close(FILE);
88d9af2c 213
9c74e9bb
SS
214 # Send filename and message to the parser,
215 # which will return if an action has to be performed.
216 my @action = &Guardian::Parser::Parser("$file", @message);
88d9af2c 217
9c74e9bb
SS
218 # Send the action to the main process and put it into
219 # the queue.
220 if (@action) {
221 # Lock the queue.
222 lock($queue);
223
224 # Put the required action into the queue.
225 $queue->enqueue(@action);
226 }
227 } else {
228 # Sleep for 10ms until the next round of the loop will start.
229 sleep(0.01);
88d9af2c
SS
230 }
231 }
232}
233
6abac3d4
SS
234#
235## Socket function.
236#
237## This function uses the Socket module to create and listen to an UNIX socket.
238## It automatically accepts all incomming connections and pass the recieved
239## data messages to the the Message_Parser function which is also part of the
240## socket module.
241#
242## If a valid command has been sent through the socket, the corresponding event
243## will be enqueued into the shared event queue.
244#
245sub Socket () {
246 # Create the Server socket by calling the responsible function.
247 my $server = &Guardian::Socket::Server();
248
c95dfa5b
SS
249 # Log successfull creation of socket.
250 $logger->Log("debug", "Listening to Socket...");
251
6abac3d4
SS
252 # Accept incomming connections from the socket.
253 while (my $connection = $server->accept()) {
254 # Autoflush the socket after the data
255 # has been recieved.
256 $connection->autoflush(1);
257
258 # Gather all data from the connection.
259 while (my $message = <$connection>) {
260 # Remove any newlines.
261 chomp($message);
262
c95dfa5b
SS
263 # Log recieved socket command.
264 $logger->Log("debug", "Socket - Recieved message: $message");
265
6abac3d4
SS
266 # Send the recieved data message to the
267 # socket parser.
268 my $action = &Guardian::Socket::Message_Parser($message);
269
270 # If the parser returns to perform an action,
271 # add it to the main event queue.
272 if ($action) {
273 # Lock the queue.
274 lock($queue);
275
276 # Enqueue the returned action.
277 $queue->enqueue($action);
278 }
279 }
280 }
281}
282
915d9f45
SS
283#
284## Function for capturing process signals.
285#
286## This function captures any sent process signals and will call various
287## actions, basend on the captured signal.
288#
289sub SignalHandler {
290 $SIG{INT} = \&Shutdown;
291 $SIG{TERM} = \&Shutdown;
292 $SIG{QUIT} = \&Shutdown;
ba734c53 293 $SIG{HUP} = \&Reload;
915d9f45
SS
294}
295
9c74e9bb
SS
296#
297## Function to start the workers (threads) for all monitored files.
298#
3111df62 299## This function will loop through the hash of monitored files and will
9c74e9bb
SS
300## spawn an own thread based worker for each file. Every created worker will
301## be added to the array of running workers.
302#
303sub StartWorkers () {
3111df62
SS
304 # Loop through the hash which contains the monitored files and start
305 # a worker thread for each single one.
306 foreach my $file (keys %monitored_files) {
c95dfa5b 307 $logger->Log("debug", "Starting worker thread for $file");
3111df62
SS
308 # Create worker thread for the file.
309 push @running_workers, threads->create(\&Worker,$file);
9c74e9bb
SS
310 }
311}
312
313#
314## Function to stop all running workers.
315#
316## This function is used to stop all currently running workers and will be
317## called when reloading or shutting down guardian.
318#
319sub StopWorkers () {
320 # Loop through all running workers.
321 foreach my $worker (@running_workers) {
322 # Send the worker the "KILL" signal and detach the
323 # thread so perl can do an automatically clean-up.
4d19939e 324 $worker->kill('KILL');
9c74e9bb 325 }
c95dfa5b 326 $logger->Log("debug", "All workers are stopped now...");
9c74e9bb
SS
327}
328
ba734c53
SS
329#
330## Reload function.
331#
332## This function will get called if the signal handler recieves a "SIGHUP" signal,
333## or the reload command will be sent via socket connection. It is responsible for
334## reloading all configure options and stopping/starting the worker threads.
335#
336sub Reload () {
c95dfa5b
SS
337 # Log reload.
338 $logger->Log("info", "Reload configuration...");
339
ba734c53
SS
340 # Stop all running workers.
341 &StopWorkers();
342
343 # Re-read configuration file.
344 %mainsettings = &Guardian::Config::UseConfig($cmdargs{"config"});
345
fc555263
SS
346 # Update Logger settings.
347 $logger = Guardian::Logger->Update(%mainsettings);
348
349 # Update logger object in mainsettings hash.
350 $mainsettings{Logger} = $logger;
351
ba734c53
SS
352 # Re-generate hash of monitored files.
353 %monitored_files = &Guardian::Base::GenerateMonitoredFiles(\%mainsettings, \%monitored_files);
354
355 # Restart the worker threads.
356 &StartWorkers();
357}
358
915d9f45
SS
359#
360## Shutdown function.
361#
362## This function is used to do a clean shutdown of guardian. It will be called
363## by the signal handler when recieving INT (2), QUIT (3) and TERM (15) signals.
364#
365sub Shutdown () {
c95dfa5b
SS
366 # Log shutdown.
367 $logger->Log("info", "Shutting down...");
368
9c74e9bb
SS
369 # Stop all workers.
370 &StopWorkers();
371
915d9f45
SS
372 # Remove socket file on exit.
373 &Guardian::Socket::RemoveSocketFile();
374
a9ef502c
SS
375 # Sleep for one second to give perl some
376 # time to proper clean up everything before
377 # exiting.
378 sleep(1);
379
c95dfa5b
SS
380 # Log good bye message.
381 $logger->Log("debug", "Good Bye!");
382
915d9f45
SS
383 # Exit guardian.
384 exit;
385}