-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathsetup.php
1305 lines (1132 loc) · 43.6 KB
/
setup.php
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
<?php
/*
+-------------------------------------------------------------------------+
| Copyright (C) 2004-2024 The Cacti Group |
| |
| 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. |
+-------------------------------------------------------------------------+
| Cacti: The Complete RRDTool-based Graphing Solution |
+-------------------------------------------------------------------------+
| This code is designed, written, and maintained by the Cacti Group. See |
| about.php and/or the AUTHORS file for specific developer information. |
+-------------------------------------------------------------------------+
| http://www.cacti.net/ |
+-------------------------------------------------------------------------+
*/
function plugin_flowview_install() {
// Setup core hooks for just about every plugin
api_plugin_register_hook('flowview', 'config_arrays', 'flowview_config_arrays', 'setup.php');
api_plugin_register_hook('flowview', 'draw_navigation_text', 'flowview_draw_navigation_text', 'setup.php');
api_plugin_register_hook('flowview', 'config_settings', 'flowview_config_settings', 'setup.php');
api_plugin_register_hook('flowview', 'poller_bottom', 'flowview_poller_bottom', 'setup.php');
api_plugin_register_hook('flowview', 'top_header_tabs', 'flowview_show_tab', 'setup.php');
api_plugin_register_hook('flowview', 'top_graph_header_tabs', 'flowview_show_tab', 'setup.php');
// Allow the injection of CSS and other components
api_plugin_register_hook('flowview', 'page_head', 'flowview_page_head', 'setup.php');
// Allow the flow-capture service to be restart after a key change in settings
api_plugin_register_hook('flowview', 'global_settings_update', 'flowview_global_settings_update', 'setup.php');
// Setup buttons on Graph Pages
api_plugin_register_hook('flowview', 'graph_buttons', 'flowview_graph_button', 'setup.php');
api_plugin_register_hook('flowview', 'graph_buttons_thumbnails', 'flowview_graph_button', 'setup.php');
// Setup permissions to Flowview Components
api_plugin_register_realm('flowview', 'flowview.php', __('NetFlow User', 'flowview'), 1);
api_plugin_register_realm('flowview', 'flowview_devices.php,flowview_schedules.php,flowview_filters.php,flowview_databases.php', __('NetFlow Admin', 'flowview'), 1);
flowview_determine_config();
if (defined('FLOWVIEW_CONFIG')) {
include(FLOWVIEW_CONFIG);
} else {
raise_message('flowview_info', __('Please rename either your config.php.dist or config_local.php.dist files in the flowview directory, and change setup your database before installing.', 'flowview'), MESSAGE_LEVEL_ERROR);
return false;
}
flowview_setup_table();
}
function plugin_flowview_uninstall() {
flowview_connect();
$tables = array_rekey(
flowview_db_fetch_assoc('SELECT TABLE_NAME
FROM information_schema.TABLES
WHERE TABLE_NAME LIKE "plugin_flowview%"
OR TABLE_NAME LIKE "parallel_database%"'),
'TABLE_NAME', 'TABLE_NAME'
);
flowview_drop_table($tables);
}
function plugin_flowview_check_config() {
// Here we will check to ensure everything is configured
if (!file_exists(dirname(__FILE__) . '/config_local.php') && !file_exists(dirname(__FILE__) . '/config.php')) {
raise_message('flowview_info', __('Please rename either your config.php.dist or config_local.php.dist files in the flowview directory, and change setup your database before installing.', 'flowview'), MESSAGE_LEVEL_ERROR);
return false;
}
if (api_plugin_installed('flowview')) {
plugin_flowview_check_upgrade();
}
return true;
}
function plugin_flowview_upgrade() {
// Here we will upgrade to the newest version
plugin_flowview_check_upgrade();
return false;
}
function plugin_flowview_check_upgrade($force = false) {
global $config;
$files = array('plugins.php', 'flowview.php', 'index.php');
if (isset($_SERVER['PHP_SELF']) && !in_array(basename($_SERVER['PHP_SELF']), $files)) {
return;
}
include_once($config['base_path'] . '/lib/poller.php');
flowview_connect();
$info = plugin_flowview_version();
$current = $info['version'];
$old = db_fetch_cell('SELECT version
FROM plugin_config
WHERE directory="flowview"');
if ($current != $old || $force) {
$php_binary = read_config_option('path_php_binary');
exec_background($php_binary, $config['base_path'] . '/plugins/flowview/flowview_upgrade.php');
raise_message('flowview_upgrade', __('Please be advised the Flowview plugins Tables are being upgraded in the background. This may take some time. Check the Cacti log for more information'), MESSAGE_LEVEL_INFO);
}
}
function plugin_flowview_version() {
global $config;
$info = parse_ini_file($config['base_path'] . '/plugins/flowview/INFO', true);
return $info['info'];
}
function flowview_config_arrays() {
global $menu, $menu_glyphs, $messages, $flowview_sighup_settings;
$messages['flow_deleted'] = array('message' => __('The Filter has been Deleted', 'flowview'), 'type' => 'info');
$messages['flow_updated'] = array('message' => __('The Filter has been Updated', 'flowview'), 'type' => 'info');
$menu2 = array ();
foreach ($menu as $temp => $temp2 ) {
$menu2[$temp] = $temp2;
if ($temp == __('Import/Export')) {
$menu2[__('FlowView', 'flowview')]['plugins/flowview/flowview_devices.php'] = __('Listeners', 'flowview');
$menu2[__('FlowView', 'flowview')]['plugins/flowview/flowview_filters.php'] = __('Filters', 'flowview');
$menu2[__('FlowView', 'flowview')]['plugins/flowview/flowview_schedules.php'] = __('Schedules', 'flowview');
$menu2[__('FlowView', 'flowview')]['plugins/flowview/flowview_databases.php'] = __('Databases', 'flowview');
}
}
$menu = $menu2;
$menu_glyphs[__('FlowView', 'flowview')] = 'fas fa-crosshairs';
if (function_exists('auth_augment_roles')) {
auth_augment_roles(__('Normal User'), array('flowview.php'));
auth_augment_roles(__('System Administration'), array('flowview_devices.php','flowview_schedules.php','flowview_filters.php'));
}
$flowview_sighup_settings = array(
'flowview_partition',
'settings_from_email',
'settings_from_name',
'flowview_use_arin',
'flowview_dns_method',
'settings_dns_primary',
'settings_dns_secondary',
'settings_dns_timeout',
'flowview_local_domain',
'flowview_local_iprange'
);
plugin_flowview_check_upgrade();
}
function flowview_draw_navigation_text($nav) {
$nav['flowview.php:'] = array(
'title' => __('Flow Viewer', 'flowview'),
'mapping' => '',
'url' => 'flowview.php',
'level' => '0'
);
$nav['flowview.php:view'] = array(
'title' => __('Dashboard', 'flowview'),
'mapping' => 'flowview.php:',
'url' => 'flowview.php',
'level' => '1'
);
$nav['flowview.php:save'] = array(
'title' => __('(save)', 'flowview'),
'mapping' => 'flowview.php:',
'url' => 'flowview.php',
'level' => '1'
);
$nav['flowview.php:loadquery'] = array(
'title' => __('Flow Viewer', 'flowview'),
'mapping' => 'flowview.php:',
'url' => 'flowview.php',
'level' => '1'
);
$nav['flowview_devices.php:'] = array(
'title' => __('Listeners', 'flowview'),
'mapping' => 'index.php:',
'url' => 'flowview_devices.php',
'level' => '1'
);
$nav['flowview_devices.php:edit'] = array(
'title' => __('(edit)', 'flowview'),
'mapping' => 'index.php:,flowview_devices.php:',
'url' => 'flowview_devices.php',
'level' => '2'
);
$nav['flowview_devices.php:save'] = array(
'title' => __('(save)', 'flowview'),
'mapping' => 'index.php:',
'url' => 'flowview_devices.php',
'level' => '2'
);
$nav['flowview_devices.php:actions'] = array(
'title' => __('(actions)', 'flowview'),
'mapping' => 'index.php:',
'url' => 'flowview_devices.php',
'level' => '2'
);
$nav['flowview_schedules.php:'] = array(
'title' => __('Schedules', 'flowview'),
'mapping' => 'index.php:',
'url' => 'flowview_schedules.php',
'level' => '1'
);
$nav['flowview_schedules.php:edit'] = array(
'title' => __('(edit)', 'flowview'),
'mapping' => 'index.php:,flowview_schedules.php:',
'url' => 'flowview_schedules.php',
'level' => '2'
);
$nav['flowview_schedules.php:save'] = array(
'title' => __('(save)', 'flowview'),
'mapping' => 'index.php:',
'url' => 'flowview_schedules.php',
'level' => '2'
);
$nav['flowview_schedules.php:actions'] = array(
'title' => __('(actions)', 'flowview'),
'mapping' => 'index.php:',
'url' => 'flowview_schedules.php',
'level' => '2'
);
$nav['flowview_filters.php:'] = array(
'title' => __('Filters', 'flowview'),
'mapping' => 'index.php:',
'url' => 'flowview_filters.php',
'level' => '1'
);
$nav['flowview_filters.php:edit'] = array(
'title' => __('(edit)', 'flowview'),
'mapping' => 'index.php:,flowview_filters.php:',
'url' => 'flowview_filters.php',
'level' => '2'
);
$nav['flowview_filters.php:save'] = array(
'title' => __('(save)', 'flowview'),
'mapping' => 'index.php:',
'url' => 'flowview_filters.php',
'level' => '2'
);
$nav['flowview_filters.php:actions'] = array(
'title' => __('(actions)', 'flowview'),
'mapping' => 'index.php:',
'url' => 'flowview_filters.php',
'level' => '2'
);
return $nav;
}
function flowview_show_tab() {
global $config;
if (api_user_realm_auth('flowview.php')) {
if (substr_count($_SERVER['REQUEST_URI'], 'flowview')) {
print '<a href="' . htmlspecialchars($config['url_path'] . 'plugins/flowview/flowview.php') . '"><img src="' . $config['url_path'] . 'plugins/flowview/images/tab_flows_down.gif" alt="' . __('FlowView', 'flowview') . '"></a>';
} else {
print '<a href="' . htmlspecialchars($config['url_path'] . 'plugins/flowview/flowview.php') . '"><img src="' . $config['url_path'] . 'plugins/flowview/images/tab_flows.gif" alt="' . __('FlowView', 'flowview') . '"></a>';
}
}
}
function flowview_page_head() {
global $config, $colors;
$theme = get_selected_theme();
if (file_exists($config['base_path'] . '/plugins/flowview/themes/' . $theme . '.css')) {
print '<link href="' . $config['url_path'] . 'plugins/flowview/themes/' . $theme . '.css" type="text/css" rel="stylesheet">' . PHP_EOL;
} else {
print '<link href="' . $config['url_path'] . 'plugins/flowview/themes/default.css" type="text/css" rel="stylesheet">' . PHP_EOL;
}
}
function flowview_global_settings_update() {
global $config, $flowview_sighup_settings;
$hup_process = false;
foreach($flowview_sighup_settings as $setting) {
$$setting = read_config_option($setting, true);
if ($$setting != $_SESSION['sess_flowview_settings'][$setting]) {
$hup_process = true;
}
}
if ($hup_process) {
$pid = db_fetch_cell('SELECT pid FROM processes WHERE tasktype="flowview" AND taskname="master"');
if ($pid > 0) {
if (!defined('SIGHUP')) {
define('SIGHUP', 1);
}
posix_kill($pid, SIGHUP);
}
}
}
function flowview_config_settings() {
global $config, $settings, $tabs, $flowview_sighup_settings;
include_once($config['base_path'] . '/lib/reports.php');
flowview_connect();
if (cacti_sizeof($flowview_sighup_settings)) {
foreach($flowview_sighup_settings as $setting) {
$$setting = read_config_option($setting, true);
$_SESSION['sess_flowview_settings'][$setting] = $$setting;
}
}
$formats = reports_get_format_files();
if (!isset($settings['poller']['reports_concurrent'])) {
$nsettings = array();
foreach($settings['poller'] as $setting => $data) {
if ($setting != 'reports_timeout' && $setting != 'scheduler_timeout') {
$nsettings[$setting] = $data;
} else {
$processes = array();
for($i = 1; $i <= 10; $i++) {
if ($i == 1) {
$processes[$i] = __('%d Process', $i);
} else {
$processes[$i] = __('%d Processes', $i);
}
}
$nsettings[$setting] = $data;
$nsettings['reports_concurrent'] = array(
'friendly_name' => __('Report Concurrent Processes (FlowView Only)', 'flowview'),
'description' => __('Select the maximum concurrent reports processes that can be running at any one time.', 'flowview'),
'default' => 1,
'method' => 'drop_array',
'array' => $processes
);
}
}
$settings['poller'] = $nsettings;
}
$settings['mail'] += array(
'settings_proxy_header' => array(
'friendly_name' => __('Internet Proxy Settings'),
'collapsible' => 'true',
'method' => 'spacer',
),
'settings_proxy_server' => array(
'friendly_name' => __('Internet Proxy Address'),
'description' => __('For either core Cacti Services or Plugins that require internet access, enter the proxy server and port here in the following format IP:PORT. For example 192.168.1.1:8080.'),
'method' => 'textbox',
'default' => '',
'max_length' => '30',
'size' => '30'
),
'settings_proxy_user' => array(
'friendly_name' => __('Internet Proxy User'),
'description' => __('If your Internet Proxy requires a username, enter it here.'),
'method' => 'textbox',
'default' => '',
'max_length' => '30',
'size' => '10'
),
'settings_proxy_password' => array(
'friendly_name' => __('Internet Proxy Password'),
'description' => __('If your Internet Proxy requires a password, enter it here.'),
'method' => 'textbox_password',
'default' => '',
'max_length' => '30',
'size' => '10'
),
);
$engines = array(
'MyISAM' => __('MyISAM (Fast, Non-Crash Safe)', 'flowview'),
'Aria' => __('Aria (Fast, Crash Safe)', 'flowview'),
'InnoDB' => __('InnoDB (Slow, High Concurrency)', 'flowview'),
);
$supported_engines = array_rekey(
flowview_db_fetch_assoc("SELECT ENGINE
FROM information_schema.ENGINES
WHERE ENGINE IN ('MyISAM', 'Aria', 'InnoDB')
AND SUPPORT IN ('YES','DEFAULT')"),
'ENGINE', 'ENGINE'
);
if (!isset($supported_engines['Aria'])) {
unset($engines['Aria']);
$default_engine = 'MyISAM';
} else {
unset($engines['MyISAM']);
$default_engine = 'Aria';
}
if (flowview_db_table_exists('plugin_flowview_queries')) {
$queries = array_rekey(
flowview_db_fetch_assoc('SELECT id, name
FROM plugin_flowview_queries
ORDER BY name'),
'id', 'name'
);
} else {
$queries = array();
}
$temp = array(
'flowview_header' => array(
'friendly_name' => __('Name Resolution', 'flowview'),
'method' => 'spacer',
'collapsible' => 'true'
),
'flowview_dns_method' => array(
'friendly_name' => __('Hostname Resolution', 'flowview'),
'description' => __('The method by which you wish to resolve hostnames.', 'flowview'),
'method' => 'drop_array',
'array' => array(
0 => __('Use Local Server', 'flowview'),
1 => __('Use DNS Servers under Mail/Reporting/DNS', 'flowview'),
2 => __('Don\'t Resolve DNS', 'flowview')
),
'default' => 0
),
'flowview_local_domain' => array(
'friendly_name' => __('Local Domain Name', 'monitor'),
'method' => 'textbox',
'default' => 'mydomain.net',
'description' => __('For IPv4 addresses on the local network that do not resolve locally, append this suffix to the resultant ip address.', 'monitor'),
'max_length' => 30,
'size' => 30
),
'flowview_local_iprange' => array(
'friendly_name' => __('Local IP Range', 'monitor'),
'method' => 'textbox',
'default' => '192.168.1.0/24',
'description' => __('Provide the IPv4 ip address range for your local network for hosts that may not be registered in DNS. These hosts will be mapped to the Local Domain Name above. This more for home users. You can use either CIDR or non-CIDR formats. For example: 192.168.11.0 or 192.168.11.0/24', 'monitor'),
'placeholder' => __('Use CIDR or Non-CIDR', 'flowview'),
'max_length' => 30,
'size' => 30
),
'flowview_use_arin' => array(
'friendly_name' => __('Use Arin to find Domains and AS Numbers', 'syslog'),
'description' => __('Many Big Tech data collection services like to mask their ownership of domains to obfuscate the fact that they are collecting your personal information. If you are concerned with this and your Cacti install has access to the Internet, you can use Arin to remove the mask from those Big Tech companies.', 'flowview'),
'method' => 'checkbox',
'default' => 'on'
),
'flowview_whois_provider' => array(
'friendly_name' => __('Whois Provider Host', 'monitor'),
'method' => 'textbox',
'default' => 'whois.radb.net',
'description' => __('Please provide the hostname for resolving whois calls. If not null, you must have the whois binary in your system path.', 'monitor'),
'placeholder' => __('whois.radb.net', 'flowview'),
'max_length' => 30,
'size' => 30
),
'flowview_path_whois' => array(
'friendly_name' => __('Whois Binary Path', 'monitor'),
'method' => 'filepath',
'default' => '/usr/bin/whois',
'description' => __('Please provide the pathname for the \'whois\' binary. The \'whois\' binary will be used to find AS information supplementing Arin.', 'monitor'),
'placeholder' => __('Enter binary path', 'flowview'),
'max_length' => 30,
'size' => 30
),
'flowview_dd_header' => array(
'friendly_name' => __('Graph Drilldown Settings', 'flowview'),
'method' => 'spacer',
'collapsible' => 'true'
),
'flowview_default_filter' => array(
'friendly_name' => __('Default Search Filter for Graph Drilldowns', 'monitor'),
'method' => 'drop_array',
'default' => '',
'description' => __('Choose an existing Flowview Search Filter to use for Graph Drilldowns.', 'monitor'),
'array' => $queries
),
'flowview_data_header' => array(
'friendly_name' => __('Data Retention and Report Generation', 'flowview'),
'method' => 'spacer',
'collapsible' => 'true'
),
'flowview_format_file' => array(
'friendly_name' => __('Format File to Use', 'monitor'),
'method' => 'drop_array',
'default' => 'default.format',
'description' => __('Choose the custom html wrapper and CSS file to use. This file contains both html and CSS to wrap around your report. If it contains more than simply CSS, you need to place a special <REPORT> tag inside of the file. This format tag will be replaced by the report content. These files are located in the \'formats\' directory.', 'monitor'),
'array' => $formats
),
'flowview_retention' => array(
'friendly_name' => __('Data Retention Policy', 'flowview'),
'description' => __('The amount of time Cacti will maintain the partitioned Flow tables.', 'flowview'),
'method' => 'drop_array',
'array' => array(
7 => __('%d Week', 1, 'flowview'),
14 => __('%d Weeks', 2, 'flowview'),
21 => __('%d Weeks', 3, 'flowview'),
30 => __('%d Month', 1, 'flowview'),
60 => __('%d Months', 2, 'flowview'),
90 => __('%d Months', 3, 'flowview'),
120 => __('%d Months', 4, 'flowview'),
183 => __('%d Months', 6, 'flowview'),
365 => __('%d Year', 1, 'flowview')
),
'default' => 30
),
'flowview_partition' => array(
'friendly_name' => __('Database Partitioning Scheme', 'flowview'),
'description' => __('Depending on the number of flows per minute, you may require more tables per day.', 'flowview'),
'method' => 'drop_array',
'array' => array(
0 => __('Daily', 'flowview'),
1 => __('Hourly', 'flowview')
),
'default' => 1
),
'flowview_engine' => array(
'friendly_name' => __('Storage Engine for Raw Tables', 'flowview'),
'description' => __('The Aria Engine is perfect for all but the Live raw table. The Live raw table will always be InnoDB. Take your pick.', 'flowview'),
'method' => 'drop_array',
'array' => $engines,
'default' => $default_engine
),
'flowview_parallel_header' => array(
'friendly_name' => __('Parallel Queries', 'flowview'),
'method' => 'spacer',
'collapsible' => 'true'
),
'flowview_parallel_threads' => array(
'friendly_name' => __('Max Concurrent Threads', 'flowview'),
'description' => __('The maximum number of threads that will be dispatched to run the FlowView queries. Note that you can have at most 1 thread per database partition, and you should be careful not to overload your database server with having too many concurrent threads running.', 'flowview'),
'method' => 'drop_array',
'array' => array(
1 => __('Disabled', 'flowview'),
2 => __('%d Threads', 2, 'flowview'),
3 => __('%d Threads', 3, 'flowview'),
4 => __('%d Threads', 4, 'flowview'),
5 => __('%d Threads', 5, 'flowview'),
6 => __('%d Threads', 6, 'flowview'),
7 => __('%d Threads', 7, 'flowview'),
8 => __('%d Threads', 8, 'flowview'),
9 => __('%d Threads', 9, 'flowview'),
10 => __('%d Threads', 10, 'flowview'),
11 => __('%d Threads', 11, 'flowview'),
12 => __('%d Threads', 12, 'flowview'),
13 => __('%d Threads', 13, 'flowview'),
14 => __('%d Threads', 14, 'flowview'),
15 => __('%d Threads', 15, 'flowview'),
16 => __('%d Threads', 16, 'flowview'),
17 => __('%d Threads', 17, 'flowview'),
18 => __('%d Threads', 18, 'flowview'),
19 => __('%d Threads', 19, 'flowview'),
20 => __('%d Threads', 20, 'flowview'),
),
'default' => 4
),
'flowview_parallel_runlimit' => array(
'friendly_name' => __('Maximum Run Time', 'flowview'),
'description' => __('If the Parallel Query does not finish in this time, exit.', 'flowview'),
'method' => 'drop_array',
'array' => array(
60 => __('%d Minute', 1, 'flowview'),
120 => __('%d Minutes', 2, 'flowview'),
180 => __('%d Minutes', 3, 'flowview'),
240 => __('%d Minutes', 4, 'flowview'),
300 => __('%d Minutes', 5, 'flowview'),
600 => __('%d Minutes', 10, 'flowview'),
900 => __('%d Minutes', 15, 'flowview'),
),
'default' => 300
),
'flowview_parallel_time_to_live' => array(
'friendly_name' => __('Cached Data Time to Live', 'flowview'),
'description' => __('How long should FlowView hold onto Cached Query results before purging them?', 'flowview'),
'method' => 'drop_array',
'array' => array(
21600 => __('%d Hours', 6, 'flowview'),
43200 => __('%d Hours', 12, 'flowview'),
86400 => __('%d Day', 1, 'flowview'),
172800 => __('%d Days', 2, 'flowview'),
),
'default' => 21600
),
'flowview_maxscale_header' => array(
'friendly_name' => __('MaxScale Sharding', 'flowview'),
'description' => __('This is only required if your Cacti System\'s Flowview Database connection is not already using a MaxScale enabled Read-Write Split port.', 'flowview'),
'method' => 'spacer',
'collapsible' => 'true'
),
'flowview_use_maxscale' => array(
'friendly_name' => __('Leverage MaxScale to Distribute Query Shards', 'syslog'),
'description' => __('If you have multiple service acting as slaves for MaxScale, you can increase the speed of querying by distributing the parallel queries to multiple MariaDB backend servers.', 'flowview'),
'method' => 'checkbox',
'default' => ''
),
'flowview_maxscale_port' => array(
'friendly_name' => __('MaxScale Read-Write Split Port', 'monitor'),
'method' => 'textbox',
'default' => '3307',
'description' => __('This should be the port of the Read-Write-Split-Service (readwrite) service and router.', 'monitor'),
'max_length' => 30,
'size' => 30
),
);
$tabs['flowview'] = __('Flowview', 'flowview');
if (isset($settings['flowview'])) {
$settings['flowview'] = array_merge($settings['flowview'], $temp);
} else {
$settings['flowview'] = $temp;
}
}
function flowview_poller_bottom() {
global $config;
include_once($config['base_path'] . '/lib/poller.php');
flowview_connect();
$retention_days = read_config_option('flowview_retention');
if (empty($retention_days)) {
$retention_days = 30;
set_config_option('flowview_retention', $retention_days);
}
$time = time() - ($retention_days * 86400);
flowview_db_execute("DELETE FROM plugin_flowview_dnscache
WHERE time > 0
AND time < $time");
$t = time();
$php = trim(read_config_option('path_php_binary'));
if ($php == '') {
$php = 'php';
}
exec_background($php, $config['base_path'] . '/plugins/flowview/flowview_process.php');
}
function flowview_determine_config() {
global $config, $flowview_use_cacti_db;
// Setup the flowview database settings path
if (!defined('FLOWVIEW_CONFIG')) {
if (file_exists(dirname(__FILE__) . '/config_local.php')) {
define('FLOWVIEW_CONFIG', dirname(__FILE__) . '/config_local.php');
$config['flowview_remote_db'] = true;
} elseif (file_exists(dirname(__FILE__) . '/config.php')) {
define('FLOWVIEW_CONFIG', dirname(__FILE__) . '/config.php');
$config['flowview_remote_db'] = false;
}
}
}
function flowview_connect($maxscale = false) {
global $config, $flowview_cnn, $flowviewdb_default, $local_db_cnn_id, $remote_db_cnn_id, $database_hostname;
// Assume that you are connecting locally first
$flowview_use_cacti_db = true;
$cnn_id = false;
flowview_determine_config();
// Handle remote flowview processing
if (defined('FLOWVIEW_CONFIG')) {
include(FLOWVIEW_CONFIG);
}
include_once(dirname(__FILE__) . '/functions.php');
include_once(dirname(__FILE__) . '/database.php');
/**
* If connecting to MaxScale, set the port properly
*/
if ($maxscale) {
$maxscale_port = read_config_option('flowview_maxscale_port');
if ($maxscale_port > 0) {
$flowviewdb_port = $maxscale_port;
}
}
/**
* Boolean that denotes connecting to a database other
* than the Cacti database.
*/
$connect_remote = false;
/* Connect to the Flowview Database */
if (!$maxscale) {
if ($config['poller_id'] == 1) {
if ($flowview_use_cacti_db === true) {
$flowview_cnn = $local_db_cnn_id;
} else {
$connect_remote = true;
}
} elseif ($flowview_use_cacti_db === true) {
$flowview_cnn = $remote_db_cnn_id;
} else {
$connect_remote = true;
}
} else {
if ($flowview_use_cacti_db === true) {
/**
* We assume, maybe falsely that MaxScale is watching
* on the hostname as opposed to 'localhost'.
* so we make this change here.
*
*/
if ($database_hostname == 'localhost' || $database_hostname == '127.0.0.1') {
$flowviewdb_hostname = gethostbyname(gethostname());
}
}
$connect_remote = true;
}
if ($maxscale || ($connect_remote && !is_object($flowview_cnn))) {
if (!isset($flowviewdb_port)) {
$flowviewdb_port = '3306';
}
if (!isset($flowviewdb_retries)) {
$flowviewdb_retries = '5';
}
if (!isset($flowviewdb_ssl)) {
$flowviewdb_ssl = false;
}
if (!isset($flowviewdb_ssl_key)) {
$flowviewdb_ssl_key = '';
}
if (!isset($flowviewdb_ssl_cert)) {
$flowviewdb_ssl_cert = '';
}
if (!isset($flowviewdb_ssl_ca)) {
$flowviewdb_ssl_ca = '';
}
$flowview_cnn = flowview_db_connect_real(
$flowviewdb_hostname,
$flowviewdb_username,
$flowviewdb_password,
$flowviewdb_default,
$flowviewdb_type,
$flowviewdb_port,
$flowviewdb_retries,
$flowviewdb_ssl,
$flowviewdb_ssl_key,
$flowviewdb_ssl_cert,
$flowviewdb_ssl_ca
);
$cnn_id = $flowview_cnn;
if ($flowview_cnn === false) {
cacti_log("FATAL Can not connect to the flowview database", false, 'FLOWVIEW');
exit;
}
} else {
$cnn_id = $flowview_cnn;
}
return $cnn_id;
}
function flowview_setup_table() {
global $config, $settings, $flowviewdb_default;
flowview_connect();
flowview_db_execute("CREATE TABLE IF NOT EXISTS `plugin_flowview_dnscache` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`ip` varchar(45) NOT NULL DEFAULT '',
`host` varchar(255) NOT NULL DEFAULT '',
`source` varchar(40) NOT NULL DEFAULT '',
`arin_verified` tinyint(3) unsigned NOT NULL DEFAULT 0,
`arin_id` int(10) unsigned NOT NULL DEFAULT 0,
`time` bigint(20) unsigned NOT NULL DEFAULT 0,
PRIMARY KEY (`id`),
KEY `arin_id` (`arin_id`),
UNIQUE KEY `ip` (`ip`))
ENGINE=InnoDB,
COMMENT='Plugin Flowview - DNS Cache to help speed things up'");
flowview_db_execute("CREATE TABLE IF NOT EXISTS `plugin_flowview_arin_information` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`cidr` varchar(20) NOT NULL DEFAULT '',
`net_range` varchar(64) NOT NULL DEFAULT '',
`name` varchar(64) NOT NULL DEFAULT '',
`parent` varchar(64) NOT NULL DEFAULT '',
`net_type` varchar(64) NOT NULL DEFAULT '',
`origin` varchar(20) NOT NULL DEFAULT '',
`registration` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
`last_changed` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
`comments` varchar(128) NOT NULL DEFAULT '',
`self` varchar(128) NOT NULL DEFAULT '',
`alternate` varchar(128) NOT NULL DEFAULT '',
`json_data` blob NOT NULL DEFAULT '',
PRIMARY KEY (`id`),
UNIQUE KEY `cidr` (`cidr`))
ENGINE=InnoDB
ROW_FORMAT=DYNAMIC
COMMENT='Holds ARIN Records Downloaded for Caching'");
include_once($config['base_path'] . '/plugins/flowview/irr_tables.php');
flowview_db_execute("CREATE TABLE IF NOT EXISTS `plugin_flowview_devices` (
id int(11) unsigned NOT NULL AUTO_INCREMENT,
name varchar(64) NOT NULL,
enabled char(2) NOT NULL default 'on',
cmethod int(11) unsigned NOT NULL default '0',
allowfrom varchar(32) NOT NULL default '0',
port int(11) unsigned NOT NULL,
protocol char(3) NOT NULL default 'UDP',
last_updated timestamp NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp(),
PRIMARY KEY (id))
ENGINE=InnoDB,
ROW_FORMAT=DYNAMIC,
COMMENT='Plugin Flowview - List of Devices to collect flows from'");
flowview_db_execute("CREATE TABLE IF NOT EXISTS `plugin_flowview_device_streams` (
device_id int(11) unsigned NOT NULL default '0',
ex_addr varchar(46) NOT NULL default '',
name varchar(64) NOT NULL default '',
version varchar(5) NOT NULL default '',
last_updated timestamp NOT NULL default CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (device_id, ex_addr))
ENGINE=InnoDB,
ROW_FORMAT=DYNAMIC,
COMMENT='Plugin Flowview - List of Streams coming into each of the listeners'");
flowview_db_execute("CREATE TABLE IF NOT EXISTS `plugin_flowview_device_templates` (
device_id int(11) unsigned NOT NULL default '0',
ex_addr varchar(46) NOT NULL default '',
template_id int(11) NOT NULL default '0',
supported tinyint unsigned NOT NULL default '0',
column_spec blob default '',
last_updated timestamp NOT NULL default CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (device_id, ex_addr, template_id))
ENGINE=InnoDB,
ROW_FORMAT=DYNAMIC,
COMMENT='Plugin Flowview - List of Stream Templates coming into each of the listeners'");
flowview_db_execute("CREATE TABLE IF NOT EXISTS `plugin_flowview_queries` (
id int(11) unsigned NOT NULL AUTO_INCREMENT,
name varchar(255) NOT NULL,
device_id int(11) unsigned NOT NULL,
template_id int(11) NOT NULL DEFAULT '0',
ex_addr varchar(46) NOT NULL DEFAULT '',
timespan int(11) unsigned NOT NULL DEFAULT '0',
startdate varchar(32) NOT NULL,
enddate varchar(32) NOT NULL,
tosfields varchar(32) NOT NULL,
tcpflags varchar(32) NOT NULL,
protocols varchar(32) DEFAULT NULL,
sourceip varchar(255) NOT NULL,
sourceport varchar(255) NOT NULL,
sourceinterface varchar(64) NOT NULL,
sourceas varchar(64) NOT NULL,
destip varchar(255) NOT NULL,
destport varchar(255) NOT NULL,
destinterface varchar(64) NOT NULL,
destas varchar(64) NOT NULL,
statistics int(3) unsigned NOT NULL,
printed int(3) unsigned NOT NULL,
includeif int(2) unsigned NOT NULL,
sortfield varchar(15) NOT NULL DEFAULT 'bytes',
cutofflines varchar(8) NOT NULL,
cutoffoctets varchar(8) NOT NULL,
resolve varchar(2) NOT NULL,
graph_type varchar(10) NOT NULL default 'bar',
graph_height int unsigned NOT NULL default '400',
panel_table char(2) NOT NULL default 'on',
panel_bytes char(2) NOT NULL default 'on',
panel_packets char(2) NOT NULL default 'on',
panel_flows char(2) NOT NULL default 'on',
PRIMARY KEY (`id`))
ENGINE=InnoDB,
ROW_FORMAT=DYNAMIC,
COMMENT='Plugin Flowview - List of Saved Flow Queries'");
flowview_db_execute("CREATE TABLE IF NOT EXISTS `plugin_flowview_schedules` (
id int(11) unsigned NOT NULL AUTO_INCREMENT,
title varchar(128) NOT NULL default '',
enabled varchar(3) NOT NULL default 'on',
sendinterval bigint(20) unsigned NOT NULL,
timeout int(10) unsigned not null default 60,
lastsent bigint(20) unsigned NOT NULL default 0,
start timestamp NOT NULL default '0000-00-00',
notification_list int(10) unsigned not null default 0,
email text NOT NULL,
format_file varchar(128) default '',
query_id int(11) unsigned NOT NULL,
PRIMARY KEY (`id`),
INDEX query_id (query_id))
ENGINE=InnoDB,
ROW_FORMAT=DYNAMIC,
COMMENT='Plugin Flowview - Scheduling for running and emails of saved queries'");
flowview_db_execute("CREATE TABLE IF NOT EXISTS `plugin_flowview_ports` (
id int(11) unsigned NOT NULL AUTO_INCREMENT,
service varchar(20) NOT NULL default '',
port int(11) unsigned NOT NULL,
proto char(4) NOT NULL,
description varchar(255) NOT NULL default '',
PRIMARY KEY (`id`))
ENGINE=InnoDB,
ROW_FORMAT=DYNAMIC,
COMMENT='Plugin Flowview - Database of well known Ports'");
flowview_db_execute("CREATE TABLE IF NOT EXISTS `parallel_database_query` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`md5sum` varchar(32) NOT NULL DEFAULT '',
`md5sum_tables` varchar(32) NOT NULL DEFAULT '',
`status` varchar(10) NOT NULL DEFAULT 'pending',
`user_id` int(10) unsigned NOT NULL DEFAULT 0,
`total_shards` int(10) unsigned NOT NULL DEFAULT 0,
`cached_shards` int(10) unsigned NOT NULL DEFAULT 0,
`finished_shards` int(10) unsigned NOT NULL DEFAULT 0,
`map_table` varchar(40) NOT NULL DEFAULT '',
`map_create` blob NOT NULL DEFAULT '',
`map_query` blob NOT NULL DEFAULT '',
`map_range` varchar(128) NOT NULL DEFAULT '',
`map_range_params` varchar(128) NOT NULL DEFAULT '',
`reduce_query` blob NOT NULL DEFAULT '',
`results` longblob NOT NULL DEFAULT '',
`created` timestamp NOT NULL DEFAULT current_timestamp(),
`time_to_live` int(10) unsigned NOT NULL DEFAULT 300,
PRIMARY KEY (`id`),
KEY `user_id` (`user_id`),
KEY `md5sum` (`md5sum`))
ENGINE=InnoDB
ROW_FORMAT=DYNAMIC
COMMENT='Holds Parallel Query Requests'");
flowview_db_execute("CREATE TABLE IF NOT EXISTS `parallel_database_query_shard` (
`query_id` bigint(20) unsigned NOT NULL DEFAULT 0,
`shard_id` int(10) unsigned NOT NULL DEFAULT 0,
`full_scan` tinyint(3) unsigned DEFAULT 1,
`status` varchar(10) NOT NULL DEFAULT 'pending',
`map_table` varchar(64) NOT NULL DEFAULT '',
`map_partition` varchar(20) NOT NULL DEFAULT '',
`map_query` blob NOT NULL DEFAULT '',
`map_params` blob NOT NULL DEFAULT '',
`created` timestamp NULL DEFAULT current_timestamp(),
`completed` timestamp NULL DEFAULT NULL,
PRIMARY KEY (`query_id`,`shard_id`))
ENGINE=InnoDB