1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
|
#!/usr/bin/env python3
# encoding: utf-8
# Nagstamon - Nagios status monitor for your desktop
# Copyright (C) 2008-2022 Henri Wahl <henri@nagstamon.de> et al.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
import os
import platform
import sys
import argparse
import configparser
import base64
import zlib
import datetime
from urllib.parse import quote
from collections import OrderedDict
from pathlib import Path
# older Kubuntu has trouble with keyring
# see https://github.com/HenriWahl/Nagstamon/issues/447
# necessary to avoid any import because might result in a segmentation fault
KEYRING = True
if platform.system() == 'Linux':
if 'ubuntu' in platform.platform().lower():
if 'XDG_SESSION_DESKTOP' in os.environ:
if os.environ['XDG_SESSION_DESKTOP'].lower() == 'kde':
KEYRING = False
if KEYRING:
import keyring
# instead of calling platform.system() every now and then just do it once here
OS = platform.system()
# needed when OS-specific decisions have to be made, mostly Linux/non-Linux
OS_DARWIN = 'Darwin'
OS_WINDOWS = 'Windows'
OS_NON_LINUX = (OS_DARWIN, OS_WINDOWS)
# simple Wayland detection
if 'WAYLAND_DISPLAY' in os.environ or\
'XDG_SESSION_TYPE' in os.environ and os.environ['XDG_SESSION_TYPE'] == 'wayland':
DESKTOP_WAYLAND = True
else:
DESKTOP_WAYLAND = False
# Cinnamon detection
# CINNAMON_VERSION 4.2.4
# DESKTOP_SESSION cinnamon
# GDMSESSION cinnamon
# XDG_CURRENT_DESKTOP X-Cinnamon
# XDG_SESSION_DESKTOP cinnamon
if 'CINNAMON_VERSION' in os.environ or\
'DESKTOP_SESSION' in os.environ and os.environ['DESKTOP_SESSION'] == 'cinnamon' or \
'XDG_SESSION_DESKTOP' in os.environ and os.environ['XDG_SESSION_DESKTOP'] == 'cinnamon':
DESKTOP_CINNAMON = True
else:
DESKTOP_CINNAMON = False
# queue.Queue() needs threading module which might be not such a good idea to be used
# because QThread is already in use
# maybe not the most logical place here to be defined but at least all
# modules access Config.py so it can be distributed from here
debug_queue = list()
# temporary dict for string-to-bool-conversion
# the bool:bool relations are thought to make things easier in Dialog_Settings.ok()
BOOLPOOL = {'False': False,
'True': True,
False: False,
True: True}
# config settings which should always be strings, never converted to integer or bool
CONFIG_STRINGS = ['custom_browser',
'debug_file',
'notification_custom_sound_warning',
'notification_custom_sound_critical',
'notification_custom_sound_down',
'notification_action_warning_string',
'notification_action_critical_string',
'notification_action_down_string',
'notification_action_ok_string',
'notification_custom_action_string',
'notification_custom_action_separator',
're_host_pattern',
're_service_pattern',
're_status_information_pattern',
're_duration_pattern',
're_attempt_pattern',
're_groups_pattern',
're_criticality_pattern',
'font',
'defaults_acknowledge_comment',
'defaults_submit_check_result_comment',
'defaults_downtime_comment',
'name',
'monitor_url',
'monitor_cgi_url',
'username',
'password',
'proxy_address',
'proxy_username',
'proxy_password',
'autologin_key',
'custom_cert_ca_file',
'idp_ecp_endpoint',
'monitor_site'
]
class AppInfo(object):
"""
contains app information previously located in GUI.py
"""
NAME = 'Nagstamon'
VERSION = '3.10.1'
WEBSITE = 'https://nagstamon.de'
COPYRIGHT = '©2008-2022 Henri Wahl et al.'
COMMENTS = 'Nagios status monitor for your desktop'
# dict of servers to offer for downloads if an update is available
DOWNLOAD_SERVERS = {'nagstamon.de': 'https://github.com/HenriWahl/Nagstamon/releases'}
# version URL depends on version string
if 'alpha' in VERSION.lower() or \
'beta' in VERSION.lower() or \
'rc' in VERSION.lower() or \
'-' in VERSION.lower():
VERSION_URL = WEBSITE + '/version/unstable'
VERSION_PATH = '/version/unstable'
else:
VERSION_URL = WEBSITE + '/version/stable'
VERSION_PATH = '/version/stable'
class Config(object):
"""
The place for central configuration.
"""
def __init__(self):
"""
read config file and set the appropriate attributes
supposed to be sensible defaults
"""
# move from minute interval to seconds
self.update_interval_seconds = 60
self.short_display = False
self.long_display = True
self.show_tooltips = True
self.show_grid = True
self.grid_use_custom_intensity = False
self.grid_alternation_intensity = 10
self.highlight_new_events = True
self.default_sort_field = 'status'
self.default_sort_order = 'descending'
self.filter_all_down_hosts = False
self.filter_all_unreachable_hosts = False
self.filter_all_unreachable_services = False
self.filter_all_flapping_hosts = False
self.filter_all_unknown_services = False
self.filter_all_information_services = False
self.filter_all_warning_services = False
self.filter_all_average_services = False
self.filter_all_high_services = False
self.filter_all_critical_services = False
self.filter_all_disaster_services = False
self.filter_all_flapping_services = False
self.filter_acknowledged_hosts_services = False
self.filter_hosts_services_disabled_notifications = False
self.filter_hosts_services_disabled_checks = False
self.filter_hosts_services_maintenance = False
self.filter_services_on_acknowledged_hosts = False
self.filter_services_on_down_hosts = False
self.filter_services_on_hosts_in_maintenance = False
self.filter_services_on_unreachable_hosts = False
self.filter_hosts_in_soft_state = False
self.filter_services_in_soft_state = False
self.position_x = 30
self.position_y = 30
self.position_width = 640
self.position_height = 480
self.popup_details_hover = True
self.popup_details_clicking = False
self.close_details_hover = True
self.close_details_clicking = False
self.close_details_clicking_somewhere = False
self.connect_by_host = True
self.connect_by_dns = False
self.connect_by_ip = False
self.use_default_browser = True
self.use_custom_browser = False
self.custom_browser = ''
self.debug_mode = False
self.debug_to_file = False
self.debug_file = os.path.expanduser('~') + os.sep + "nagstamon.log"
self.check_for_new_version = False
self.notification = True
self.notification_flashing = True
self.notification_desktop = False
self.notification_actions = False
self.notification_sound = True
self.notification_sound_repeat = False
self.notification_default_sound = True
self.notification_custom_sound = False
self.notification_custom_sound_warning = ''
self.notification_custom_sound_critical = ''
self.notification_custom_sound_down = ''
self.notification_action_warning = False
self.notification_action_warning_string = ''
self.notification_action_critical = False
self.notification_action_critical_string = ''
self.notification_action_down = False
self.notification_action_down_string = ''
self.notification_action_ok = False
self.notification_action_ok_string = ''
self.notification_custom_action = False
self.notification_custom_action_string = ''
self.notification_custom_action_separator = '|'
self.notification_custom_action_single = True
self.notify_if_up = False
self.notify_if_information = True
self.notify_if_warning = True
self.notify_if_average = True
self.notify_if_high = True
self.notify_if_critical = True
self.notify_if_disaster = True
self.notify_if_unknown = True
self.notify_if_unreachable = True
self.notify_if_down = True
# Regular expression filters
self.re_host_enabled = False
self.re_host_pattern = ''
self.re_host_reverse = False
self.re_service_enabled = False
self.re_service_pattern = ''
self.re_service_reverse = False
self.re_status_information_enabled = False
self.re_status_information_pattern = ''
self.re_status_information_reverse = False
self.re_duration_enabled = False
self.re_duration_pattern = ''
self.re_duration_reverse = False
self.re_attempt_enabled = False
self.re_attempt_pattern = ''
self.re_attempt_reverse = False
self.re_groups_enabled = False
self.re_groups_pattern = ''
self.re_groups_reverse = False
self.color_ok_text = self.default_color_ok_text = '#FFFFFF'
self.color_ok_background = self.default_color_ok_background = '#006400'
self.color_information_text = self.default_color_information_text = "#000000"
self.color_information_background = self.default_color_information_background = "#7499FF"
self.color_warning_text = self.default_color_warning_text = "#000000"
self.color_warning_background = self.default_color_warning_background = '#FFFF00'
self.color_average_text = self.default_color_average_text = "#000000"
self.color_average_background = self.default_color_average_background = "#FFA059"
self.color_high_text = self.default_color_high_text = "#000000"
self.color_high_background = self.default_color_high_background = "#E97659"
self.color_unknown_text = self.default_color_unknown_text = '#000000'
self.color_unknown_background = self.default_color_unknown_background = '#FFA500'
self.color_critical_text = self.default_color_critical_text = '#FFFFFF'
self.color_critical_background = self.default_color_critical_background = '#FF0000'
self.color_disaster_text = self.default_color_disaster_text = "#FFFFFF"
self.color_disaster_background = self.default_color_disaster_background = "#660000"
self.color_unreachable_text = self.default_color_unreachable_text = '#FFFFFF'
self.color_unreachable_background = self.default_color_unreachable_background = '#8B0000'
self.color_down_text = self.default_color_down_text = '#FFFFFF'
self.color_down_background = self.default_color_down_background = '#000000'
self.color_error_text = self.default_color_error_text = '#000000'
self.color_error_background = self.default_color_error_background = '#D3D3D3'
self.statusbar_floating = True
self.icon_in_systray = False
self.windowed = False
self.fullscreen = False
self.fullscreen_display = 0
self.systray_offset_use = False
self.systray_offset = 10
self.font = ''
self.defaults_acknowledge_sticky = False
self.defaults_acknowledge_send_notification = False
self.defaults_acknowledge_persistent_comment = False
self.defaults_acknowledge_all_services = False
self.defaults_acknowledge_expire = False
self.defaults_acknowledge_expire_duration_hours = 2
self.defaults_acknowledge_expire_duration_minutes = 0
self.defaults_acknowledge_comment = 'acknowledged'
self.defaults_submit_check_result_comment = 'check result submitted'
self.defaults_downtime_duration_hours = 2
self.defaults_downtime_duration_minutes = 0
self.defaults_downtime_comment = 'scheduled downtime'
self.defaults_downtime_type_fixed = True
self.defaults_downtime_type_flexible = False
# internal flag to determine if keyring is available at all - defaults to False
# use_system_keyring is checked and defined some lines later after config file was read
self.keyring_available = False
# setting for keyring usage - might cause trouble on Linux so disable it there as default to avoid crash at start
if OS in OS_NON_LINUX:
self.use_system_keyring = True
else:
self.use_system_keyring = False
# Special FX
# Centreon
self.re_criticality_enabled = False
self.re_criticality_pattern = ''
self.re_criticality_reverse = False
# the app is unconfigured by default and will stay so if it
# would not find a config file
self.unconfigured = True
# when more tha a config directory was given something is wrong
if len(sys.argv) > 2:
print('Currently Nagstamon supports only 1 config directory.')
self.configdir = sys.argv[1]
# try to use a given config file - there must be one given
elif len(sys.argv) == 2:
self.configdir = sys.argv[1]
# otherwise if there exits a configdir in current working directory it should be used
elif os.path.exists(os.getcwd() + os.sep + 'nagstamon.config'):
self.configdir = os.getcwd() + os.sep + 'nagstamon.config'
else:
# ~/.nagstamon/nagstamon.conf is the user conf file
# os.path.expanduser('~') finds out the user HOME dir where
# nagstamon expects its conf file to be
self.configdir = os.path.expanduser('~') + os.sep + '.nagstamon'
self.configfile = self.configdir + os.sep + 'nagstamon.conf'
# make path fit for actual os, normcase for letters and normpath for path
self.configfile = os.path.normpath(os.path.normcase(self.configfile))
# because the name of the configdir is also stored in the configfile
# there may be situations where the name gets overwritten by a
# wrong name so it will be stored here temporarily
configdir_temp = self.configdir
# default settings dicts
self.servers = dict()
self.actions = dict()
if os.path.exists(self.configfile):
# instantiate a configparser to parse the conf file
# SF.net bug #3304423 could be fixed with allow_no_value argument which
# is only available since Python 2.7
# since Python 3 '%' will be interpolated by default which crashes
# with some URLs
config = configparser.ConfigParser(allow_no_value=True, interpolation=None)
config.read(self.configfile)
# go through all sections of the conf file
for section in config.sections():
# go through all items of each sections (in fact there is only on
# section which has to be there to comply to the .INI file standard
for i in config.items(section):
# omit config file info as it makes no sense to store its path
if not i[0] in ('configfile', 'configdir'):
# create a key of every config item with its appropriate value
# check first if it is a bool value and convert string if it is
if i[1] in BOOLPOOL:
object.__setattr__(self, i[0], BOOLPOOL[i[1]])
# in case there are numbers intify them to avoid later conversions
# treat negative value specially as .isdecimal() will not detect it
elif i[1].isdecimal() or \
(i[1].startswith('-') and i[1].split('-')[1].isdecimal()):
object.__setattr__(self, i[0], int(i[1]))
else:
object.__setattr__(self, i[0], i[1])
# because the switch from Nagstamon 1.0 to 1.0.1 brings the use_system_keyring property
# and all the thousands 1.0 installations do not know it yet it will be more comfortable
# for most of the Windows users if it is only defined as False after it was checked
# from config file
if 'use_system_keyring' not in self.__dict__.keys():
if self.unconfigured is True:
# an unconfigured system should start with no keyring to prevent crashes
self.use_system_keyring = False
else:
# a configured system seemed to be able to run and thus use system keyring
if OS in OS_NON_LINUX:
self.use_system_keyring = True
else:
self.use_system_keyring = self.KeyringAvailable()
# reset self.configdir to temporarily saved value in case it differs from
# the one read from configfile and so it would fail to save next time
self.configdir = configdir_temp
# Servers configuration...
self.servers = self._LoadServersMultipleConfig()
# ... and actions
self.actions = self.LoadMultipleConfig("actions", "action", "Action")
# seems like there is a config file so the app is not unconfigured anymore
self.unconfigured = False
# Load actions if Nagstamon is not unconfigured, otherwise load defaults
if self.unconfigured is True:
self.actions = self._DefaultActions()
# do some conversion stuff needed because of config changes and code cleanup
self._LegacyAdjustments()
def _LoadServersMultipleConfig(self):
"""
load servers config - special treatment because of obfuscated passwords
"""
self.keyring_available = self.KeyringAvailable()
servers = self.LoadMultipleConfig('servers', 'server', 'Server')
# deobfuscate username + password inside a try-except loop
# if entries have not been obfuscated yet this action should raise an error
# and old values (from nagstamon < 0.9.0) stay and will be converted when next
# time saving config
try:
for server in servers:
# usernames for monitor server and proxy
servers[server].username = self.DeObfuscate(servers[server].username)
servers[server].proxy_username = self.DeObfuscate(servers[server].proxy_username)
# passwords for monitor server and proxy
if servers[server].save_password == 'False':
servers[server].password = ""
elif self.keyring_available and self.use_system_keyring:
password = keyring.get_password('Nagstamon', '@'.join((servers[server].username,
servers[server].monitor_url))) or ""
if password == "":
if servers[server].password != "":
servers[server].password = self.DeObfuscate(servers[server].password)
else:
servers[server].password = password
elif servers[server].password != "":
servers[server].password = self.DeObfuscate(servers[server].password)
# proxy password
if self.keyring_available and self.use_system_keyring:
proxy_password = keyring.get_password('Nagstamon', '@'.join(('proxy',
servers[server].proxy_username,
servers[server].proxy_address))) or ""
if proxy_password == "":
if servers[server].proxy_password != "":
servers[server].proxy_password = self.DeObfuscate(servers[server].proxy_password)
else:
servers[server].proxy_password = proxy_password
elif servers[server].proxy_password != "":
servers[server].proxy_password = self.DeObfuscate(servers[server].proxy_password)
# do only deobfuscating if any autologin_key is set - will be only Centreon/Thruk
if 'autologin_key' in servers[server].__dict__.keys():
if len(servers[server].__dict__['autologin_key']) > 0:
servers[server].autologin_key = self.DeObfuscate(servers[server].autologin_key)
# only needed for those who used Icinga2 before it became IcingaWeb2
if servers[server].type == 'Icinga2':
servers[server].type = 'IcingaWeb2'
# Check_MK is now Checkmk - same renaming as with IcingaWeb2
if servers[server].type == 'Check_MK Multisite':
servers[server].type = 'Checkmk Multisite'
if 'check_mk_view_hosts' in servers[server].__dict__.keys():
servers[server].checkmk_view_hosts = servers[server].check_mk_view_hosts
servers[server].__dict__.pop('check_mk_view_hosts')
if 'check_mk_view_services' in servers[server].__dict__.keys():
servers[server].checkmk_view_services = servers[server].check_mk_view_services
servers[server].__dict__.pop('check_mk_view_services')
except Exception:
import traceback
traceback.print_exc(file=sys.stdout)
return servers
def LoadMultipleConfig(self, settingsdir, setting, configobj):
"""
load generic config into settings dict and return to central config
"""
# defaults as empty dict in case settings dir/files could not be found
settings = OrderedDict()
try:
if os.path.exists(self.configdir + os.sep + settingsdir):
for settingsfile in sorted(os.listdir(self.configdir + os.sep + settingsdir)):
if settingsfile.startswith(setting + '_') and settingsfile.endswith('.conf'):
config = configparser.ConfigParser(allow_no_value=True, interpolation=None)
config.read(self.configdir + os.sep + settingsdir + os.sep + settingsfile)
# create object for every setting
name = config.get(config.sections()[0], 'name')
settings[name] = globals()[configobj]()
# go through all items of the server
for i in config.items(config.sections()[0]):
# create a key of every config item with its appropriate value
if i[1] in BOOLPOOL:
value = BOOLPOOL[i[1]]
# in case there are numbers intify them to avoid later conversions
# treat negative value specially as .isdecimal() will not detect it
elif i[1].isdecimal() or \
(i[1].startswith('-') and i[1].split('-')[1].isdecimal()):
value = int(i[1])
else:
value = i[1]
settings[name].__setattr__(i[0], value)
# if filename is still one of the non-URL-ones delete duplicate file
if settingsfile != '{0}_{1}.conf'.format(setting, quote(name, safe='')):
self.delete_file(settingsdir, settingsfile)
# set flag to store the settings via legacy adjustments
self.save_config_after_urlencode = True
except Exception:
import traceback
traceback.print_exc(file=sys.stdout)
return settings
def SaveConfig(self):
"""
save config file
"""
try:
# Make sure .nagstamon is created
if not os.path.exists(self.configdir):
os.makedirs(self.configdir)
# save config file with configparser
config = configparser.ConfigParser(allow_no_value=True, interpolation=None)
# general section for Nagstamon
config.add_section('Nagstamon')
for option in self.__dict__:
if option not in ['servers', 'actions', 'configfile', 'configdir', 'cli_args']:
config.set('Nagstamon', option, str(self.__dict__[option]))
# because the switch from Nagstamon 1.0 to 1.0.1 brings the use_system_keyring property
# and all the thousands 1.0 installations do not know it yet it will be more comfortable
# for most of the Windows users if it is only defined as False after it was checked
# from config file
if 'use_system_keyring' not in self.__dict__.keys():
if self.unconfigured is True:
# an unconfigured system should start with no keyring to prevent crashes
self.use_system_keyring = False
else:
# a configured system seemed to be able to run and thus use system keyring
if OS in OS_NON_LINUX:
self.use_system_keyring = True
else:
self.use_system_keyring = self.KeyringAvailable()
# save servers dict
self.SaveMultipleConfig('servers', 'server')
# save actions dict
self.SaveMultipleConfig('actions', 'action')
# open, save and close config file
with open(os.path.normpath(self.configfile), 'w') as file:
config.write(file)
# debug
if self.debug_mode:
debug_queue.append('DEBUG: {0} Saving configuration to file {1}'.format(str(datetime.datetime.now()),
self.configfile))
except Exception as err:
import traceback
traceback.print_exc(file=sys.stdout)
# debug
if self.debug_mode:
debug_queue.append(
'ERROR: {0} {1} while saving configuration to file {2}'.format(str(datetime.datetime.now()),
err,
self.configfile))
def SaveMultipleConfig(self, settingsdir, setting):
"""
saves conf files for settings like actions in extra directories
"multiple" means that multiple confs for actions or servers are loaded,
not just one like for e.g. sound file
"""
# only import keyring lib if configured to do so - to avoid Windows crashes
# like https://github.com/HenriWahl/Nagstamon/issues/97
if self.use_system_keyring is True:
self.keyring_available = self.KeyringAvailable()
# one section for each setting
for s in self.__dict__[settingsdir]:
config = configparser.ConfigParser(allow_no_value=True, interpolation=None)
config.add_section(setting + '_' + s)
for option in self.__dict__[settingsdir][s].__dict__:
# obfuscate certain entries in config file - special arrangement for servers
if settingsdir == 'servers':
if option in ['username', 'password', 'proxy_username', 'proxy_password', 'autologin_key']:
value = self.Obfuscate(self.__dict__[settingsdir][s].__dict__[option])
if option == 'password':
if self.__dict__[settingsdir][s].save_password is False:
value = ''
elif self.keyring_available and self.use_system_keyring:
if self.__dict__[settingsdir][s].password != '':
# provoke crash if password saving does not work - this is the case
# on newer Ubuntu releases
try:
keyring.set_password('Nagstamon',
'@'.join((self.__dict__[settingsdir][s].username,
self.__dict__[settingsdir][s].monitor_url)),
self.__dict__[settingsdir][s].password)
except Exception:
import traceback
traceback.print_exc(file=sys.stdout)
sys.exit(1)
value = ''
if option == 'proxy_password':
if self.keyring_available and self.use_system_keyring:
if self.__dict__[settingsdir][s].proxy_password != '':
# provoke crash if password saving does not work - this is the case
# on newer Ubuntu releases
try:
keyring.set_password('Nagstamon', '@'.join(('proxy',
self.__dict__[settingsdir][
s].proxy_username,
self.__dict__[settingsdir][
s].proxy_address)),
self.__dict__[settingsdir][s].proxy_password)
except Exception:
import traceback
traceback.print_exc(file=sys.stdout)
sys.exit(1)
value = ''
config.set(setting + '_' + s, option, str(value))
else:
config.set(setting + '_' + s, option, str(self.__dict__[settingsdir][s].__dict__[option]))
else:
config.set(setting + '_' + s, option, str(self.__dict__[settingsdir][s].__dict__[option]))
# open, save and close config_server file
if not os.path.exists(self.configdir + os.sep + settingsdir):
os.makedirs(self.configdir + os.sep + settingsdir)
# quote strings and thus avoid invalid characters
with open(
os.path.normpath('{0}{1}{2}{1}{3}_{4}.conf'.format(self.configdir,
os.sep,
settingsdir,
setting,
quote(s, safe=''))),
'w') as file:
config.write(file)
# ### clean up old deleted/renamed config files
# ##if os.path.exists(self.configdir + os.sep + settingsdir):
# ## for f in os.listdir(self.configdir + os.sep + settingsdir):
# ## if not f.split(setting + "_")[1].split(".conf")[0] in self.__dict__[settingsdir]:
# ## os.unlink(self.configdir + os.sep + settingsdir + os.sep + f)
def KeyringAvailable(self):
"""
determine if keyring module and an implementation is available for secure password storage
"""
try:
# Linux systems should use keyring only if it comes with the distro, otherwise chances are small
# that keyring works at all
if OS in OS_NON_LINUX:
# safety first - if not yet available disable it
if 'use_system_keyring' not in self.__dict__.keys():
self.use_system_keyring = False
# only import keyring lib if configured to do so
# necessary to avoid Windows crashes like https://github.com/HenriWahl/Nagstamon/issues/97
if self.use_system_keyring is True:
# hint for packaging: nagstamon.spec always have to match module path
# keyring has to be bound to object to be used later
import keyring
return not (keyring.get_keyring() is None)
else:
return False
elif KEYRING:
# keyring and secretstorage have to be importable
import keyring
# import secretstorage module as dependency of keyring -
# if not available keyring won't work
import secretstorage
if keyring.get_keyring():
return True
else:
return False
else:
# apparently an Ubuntu KDE session which has problems with keyring
return False
except Exception:
import traceback
traceback.print_exc(file=sys.stdout)
return False
def Obfuscate(self, string, count=5):
"""
Obfuscate a given string to store passwords etc.
"""
string = string.encode()
for i in range(count):
string = base64.b64encode(string).decode()
string = list(string)
string.reverse()
string = "".join(string)
string = string.encode()
string = zlib.compress(string)
# make unicode of bytes string
string = base64.b64encode(string).decode()
return string
def DeObfuscate(self, string, count=5):
"""
Deobfucate previously obfuscated string
"""
string = base64.b64decode(string)
for i in range(count):
string = zlib.decompress(string)
string = string.decode()
string = list(string)
string.reverse()
string = "".join(string)
string = base64.b64decode(string)
# make unicode of bytes coming from base64 operations
string = string.decode()
return string
def _DefaultActions(self):
"""
create some default actions like SSH and so on
"""
if OS == OS_WINDOWS:
defaultactions = {"RDP": Action(name="RDP", description="Connect via RDP.",
type="command", string="C:\windows\system32\mstsc.exe /v:$ADDRESS$"),
"VNC": Action(name="VNC", description="Connect via VNC.",
type="command", string="C:\Program Files\TightVNC\vncviewer.exe $ADDRESS$"),
"Telnet": Action(name="Telnet", description="Connect via Telnet.",
type="command", string="C:\Windows\System32\Telnet.exe root@$ADDRESS$"),
"SSH": Action(name="SSH", description="Connect via SSH.",
type="command",
string="C:\Program Files\PuTTY\putty.exe -l root $ADDRESS$")}
elif OS == OS_DARWIN:
defaultactions = {"RDP": Action(name="RDP", description="Connect via RDP.",
type="command", string="open rdp://$ADDRESS$"),
"VNC": Action(name="VNC", description="Connect via VNC.",
type="command", string="open vnc://$ADDRESS$"),
"SSH": Action(name="SSH", description="Connect via SSH.",
type="command", string="open ssh://root@$ADDRESS$"),
"Telnet": Action(name="Telnet", description="Connect via Telnet.",
type="command", string="open telnet://root@$ADDRESS$")}
else:
# the Linux settings
defaultactions = {"RDP": Action(name="RDP", description="Connect via RDP.",
type="command", string="/usr/bin/rdesktop -g 1024x768 $ADDRESS$"),
"VNC": Action(name="VNC", description="Connect via VNC.",
type="command", string="/usr/bin/vncviewer $ADDRESS$"),
"SSH": Action(name="SSH", description="Connect via SSH.",
type="command", string="/usr/bin/gnome-terminal -x ssh root@$ADDRESS$"),
"Telnet": Action(name="Telnet", description="Connect via Telnet.",
type="command",
string="/usr/bin/gnome-terminal -x telnet root@$ADDRESS$"),
"Update-Linux": Action(name="Update-Linux", description="Run remote update script.",
type="command",
string="/usr/bin/terminator -x ssh root@$HOST$ update.sh",
enabled=False)}
# OS agnostic actions as examples
defaultactions["Nagios-1-Click-Acknowledge-Host"] = Action(name="Nagios-1-Click-Acknowledge-Host", type="url",
description="Acknowledges a host with one click.",
filter_target_service=False, enabled=False,
string="$MONITOR-CGI$/cmd.cgi?cmd_typ=33&cmd_mod=2&host=$HOST$\
&com_author=$USERNAME$&com_data=acknowledged&btnSubmit=Commit")
defaultactions["Nagios-1-Click-Acknowledge-Service"] = Action(name="Nagios-1-Click-Acknowledge-Service",
type="url",
description="Acknowledges a service with one click.",
filter_target_host=False, enabled=False,
string="$MONITOR-CGI$/cmd.cgi?cmd_typ=34&cmd_mod=2&host=$HOST$\
&service=$SERVICE$&com_author=$USERNAME$&com_data=acknowledged&btnSubmit=Commit")
defaultactions["Opsview-Graph-Service"] = Action(name="Opsview-Graph-Service", type="browser",
description="Show graph in browser.", filter_target_host=False,
string="$MONITOR$/graph?service=$SERVICE$&host=$HOST$",
enabled=False)
defaultactions["Opsview-History-Host"] = Action(name="Opsview-Host-Service", type="browser",
description="Show host in browser.", filter_target_host=True,
string="$MONITOR$/event?host=$HOST$", enabled=False)
defaultactions["Opsview-History-Service"] = Action(name="Opsview-History-Service", type="browser",
description="Show history in browser.",
filter_target_host=True,
string="$MONITOR$/event?host=$HOST$&service=$SERVICE$",
enabled=False)
defaultactions["Checkmk-1-Click-Acknowledge-Host"] = Action(name="Checkmk-1-Click-Acknowledge-Host",
type="url",
description="Acknowledges a host with one click.",
filter_target_service=False, enabled=False,
string="$MONITOR$/view.py?_transid=$TRANSID$&_do_actions=yes&_do_confirm=Yes!&output_format=python&view_name=hoststatus&host=$HOST$&_ack_comment=$COMMENT-ACK$&_acknowledge=Acknowledge")
defaultactions["Checkmk-1-Click-Acknowledge-Service"] = Action(name="Checkmk-1-Click-Acknowledge-Service",
type="url",
description="Acknowledges a host with one click.",
filter_target_host=False, enabled=False,
string="$MONITOR$/view.py?_transid=$TRANSID$&_do_actions=yes&_do_confirm=Yes!&output_format=python&view_name=service&host=$HOST$&_ack_comment=$COMMENT-ACK$&_acknowledge=Acknowledge&service=$SERVICE$")
defaultactions["Checkmk Edit host in WATO"] = Action(name="Checkmk Edit host in WATO", enabled=False,
monitor_type="Checkmk Multisite",
description="Edit host in WATO.",
string="$MONITOR$/wato.py?host=$HOST$&mode=edit_host")
defaultactions["Email"] = Action(name="Email", enabled=False, description="Send email to someone.",
type="browser",
string="mailto:servicedesk@my.org?subject=Monitor alert: $HOST$ - $SERVICE$ - $STATUS-INFO$&body=Please help!.%0d%0aBest regards from Nagstamon")
return defaultactions
def _LegacyAdjustments(self):
# mere cosmetics but might be more clear for future additions - changing any "nagios"-setting to "monitor"
for server in self.servers.values():
if 'nagios_url' in server.__dict__.keys():
server.monitor_url = server.nagios_url
if 'nagios_cgi_url' in server.__dict__.keys():
server.monitor_cgi_url = server.nagios_cgi_url
# to reduce complexity in Centreon there is also only one URL necessary
if server.type == "Centreon":
server.monitor_url = server.monitor_cgi_url
# switch to update interval in seconds not minutes
if 'update_interval' in self.__dict__.keys():
self.update_interval_seconds = int(self.update_interval) * 60
self.__dict__.pop('update_interval')
# remove support for GNOME2-trayicon-egg-stuff
if 'statusbar_systray' in self.__dict__.keys():
if self.statusbar_systray is True:
self.icon_in_systray = True
self.__dict__.pop('statusbar_systray')
# some legacy action settings might need a little fix
for action in self.actions.values():
if not action.type.lower() in ('browser', 'command', 'url'):
# set browser as default to make user notice something is wrong
action.type = 'browser'
# might be there only once after starting Nagstamon 3.4 the first time
if 'save_config_after_urlencode' in self.__dict__.keys():
self.SaveConfig()
def GetNumberOfEnabledMonitors(self):
"""
returns the number of enabled monitors - in case all are disabled there is no need to display the popwin
"""
# to be returned
number = 0
for server in self.servers.values():
# ##if str(server.enabled) == "True":
if server.enabled is True:
number += 1
return number
def delete_file(self, settings_dir, settings_file):
"""
delete specified .conf file if setting is deleted in GUI
"""
# clean up old deleted/renamed config file
file = os.path.abspath('{1}{0}{2}{0}{3}'.format(os.sep, self.configdir, settings_dir, settings_file))
if os.path.exists(file) and (os.path.isfile(file) or os.path.islink(file)):
try:
os.unlink(file)
except Exception:
import traceback
traceback.print_exc(file=sys.stdout)
class Server(object):
"""
one Server realized as object for config info
"""
def __init__(self):
self.enabled = True
self.type = 'Nagios'
self.name = 'Monitor server'
self.monitor_url = 'https://monitor-server'
self.monitor_cgi_url = 'https://monitor-server/monitor/cgi-bin'
self.username = 'username'
self.password = 'password'
self.save_password = False
self.use_proxy = False
self.use_proxy_from_os = False
self.proxy_address = 'http://proxyserver:port/'
self.proxy_username = 'proxyusername'
self.proxy_password = 'proxypassword'
# defaults to 'basic', other possible values are 'digest' and 'kerberos'
self.authentication = 'basic'
self.timeout = 10
# just GUI-wise deciding if more options are shown in server dialog
self.show_options = False
# SSL/TLS certificate verification
self.ignore_cert = False
self.custom_cert_use = False
self.custom_cert_ca_file = ''
self.idp_ecp_endpoint = 'https://idp/idp/profile/SAML2/SOAP/ECP'
# special FX
# Centreon autologin
self.use_autologin = False
self.autologin_key = ''
# Icinga "host_display_name" instead of "host"
self.use_display_name_host = False
self.use_display_name_service = False
# IcingaWeb2 might authenticate without cookies too - default is WITH cookies
self.no_cookie_auth = False
# Checkmk Multisite
# Force Checkmk livestatus code to set AuthUser header for users who
# are permitted to see all objects.
self.force_authuser = False
self.checkmk_view_hosts = 'nagstamon_hosts'
self.checkmk_view_services = 'nagstamon_svc'
# OP5 api filters
self.host_filter = 'state !=0'
self.service_filter = 'state !=0 or host.state != 0'
# Sensu/Uchiwa/??? Datacenter/Site config
self.monitor_site = 'Site 1'
# Zabbix "Item Description" as "Service Name"
self.use_description_name_service = False
# Prometheus/Alertmanager mappings
self.map_to_hostname = "pod_name,namespace,instance"
self.map_to_servicename = "alertname"
self.map_to_status_information = "message,summary,description"
# Alertmanager mappings
self.alertmanager_filter = ''
self.map_to_critical = 'critical,error'
self.map_to_warning = 'warning,warn'
self.map_to_unknown = 'unknown'
self.map_to_ok = 'ok'
class Action(object):
"""
class for custom actions, which whill be thrown into one config dictionary like the servers
"""
def __init__(self, **kwds):
# to be or not to be enabled...
self.enabled = True
# monitor type
self.monitor_type = ""
# one of those: browser, url or command
self.type = "browser"
# thy name is...
self.name = "Custom action"
# OS of host where Nagstamon runs - especially commands are mostly not platform agnostic
self.os = ""
# description
self.description = "Starts a custom action."
# might be URL in case of type browser/url and a commandline for commands
self.string = ""
# version - maybe in future this might be more sophisticated
self.version = "1"
# kind of Nagios item this action is targeted to - maybe also usable for states
self.filter_target_host = True
self.filter_target_service = True
# action applies only to certain hosts or services
self.re_host_enabled = False
self.re_host_pattern = ""
self.re_host_reverse = False
self.re_service_enabled = False
self.re_service_pattern = ""
self.re_service_reverse = False
self.re_status_information_enabled = False
self.re_status_information_pattern = ""
self.re_status_information_reverse = False
self.re_duration_enabled = False
self.re_duration_pattern = ""
self.re_duration_reverse = False
self.re_attempt_enabled = False
self.re_attempt_pattern = ""
self.re_attempt_reverse = False
self.re_groups_enabled = False
self.re_groups_pattern = ""
self.re_groups_reverse = False
# close powin or not, depends on personal preference
self.close_popwin = True
self.leave_popwin_open = False
# do an immediate recheck after action was applied
self.recheck = False
# special FX
# Centreon criticality and autologin
self.re_criticality_enabled = False
self.re_criticality_pattern = ""
self.re_criticality_reverse = False
# add and/or all keywords to object
for k in kwds:
self.__dict__[k] = kwds[k]
# Initialize configuration to be accessed globally
conf = Config()
# try to get resources path if nagstamon got be installed by setup.py
RESOURCES = ""
try:
# first try to find local resources directory in case Nagstamon was frozen with cx-Freeze for OSX or Windows
executable_dir = os.path.join(os.sep.join(sys.executable.split(os.sep)[:-1]))
if os.path.exists(os.path.normcase(os.sep.join((executable_dir, "resources")))):
RESOURCES = os.path.normcase(os.sep.join((executable_dir, "resources")))
else:
import pkg_resources
RESOURCES = pkg_resources.resource_filename("Nagstamon", "resources")
except Exception as err:
# get resources directory from current directory - only if not being set before by pkg_resources
# try-excepts necessary for platforms like Windows .EXE
paths_to_check = [os.path.normcase(os.path.join(os.getcwd(), "Nagstamon", "resources")),
os.path.normcase(os.path.join(os.getcwd(), "resources"))]
try:
# if resources dir is not available in CWD, try the
# libs dir (site-packages) for the current Python
from distutils.sysconfig import get_python_lib
paths_to_check.append(os.path.normcase(os.path.join(get_python_lib(), "Nagstamon", "resources")))
except Exception:
pass
# if we're still out of luck, maybe this was a user scheme install
try:
import site
site.getusersitepackages() # make sure USER_SITE is set
paths_to_check.append(os.path.normcase(os.path.join(site.USER_SITE, "Nagstamon", "resources")))
except Exception:
pass
# add directory nagstamon.py where nagstamon.py resides for cases like 0install without installed pkg-resources
paths_to_check.append(os.sep.join(sys.argv[0].split(os.sep)[:-1] + ["Nagstamon", "resources"]))
for path in paths_to_check:
if os.path.exists(path):
RESOURCES = path
break
else:
RESOURCES = str(Path(__file__).parent.absolute().joinpath('resources'))
|
