Skip to content

Commit d3c8533

Browse files
ms217ms217
committed
backported GoAccess code
1 parent aab989f commit d3c8533

File tree

4 files changed

+353
-1
lines changed

4 files changed

+353
-1
lines changed

‎interface/web/sites/form/web_vhost_domain.tform.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -629,7 +629,7 @@
629629
'datatype' => 'VARCHAR',
630630
'formtype' => 'SELECT',
631631
'default' => 'awstats',
632-
'value' => array('webalizer' => 'Webalizer', 'awstats' => 'AWStats', '' => 'None')
632+
'value' => array('awstats' => 'AWStats', 'goaccess' => 'GoAccess', 'webalizer' => 'Webalizer','' => 'None')
633633
),
634634
//#################################
635635
// END Datatable fields

‎server/conf/goaccess_index.php.master‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<?php
2+
$yearmonth_text = "Jump to previous stats: ";
3+
$script = "<script>function load_content(url){var iframe = document.getElementById(\"content\");iframe.src = url;}</script>\n";
4+
5+
if ($handle = opendir('.'))
6+
{
7+
while(false !== ($file = readdir($handle)))
8+
{
9+
if (substr($file,0,1) != "." && is_dir($file))
10+
{
11+
$orderkey = substr($file,0,4).substr($file,5,2);
12+
if (substr($file,5,2) < 10 )
13+
{
14+
$orderkey = substr($file,0,4)."0".substr($file,5,2);
15+
}
16+
$goaprev[$orderkey] = $file;
17+
}
18+
}
19+
20+
$month = date("n");
21+
$year = date("Y");
22+
23+
if (date("d") == 1)
24+
{
25+
$month = date("m")-1;
26+
if (date("m") == 1)
27+
{
28+
$year = date("Y")-1;
29+
$month = "12";
30+
}
31+
}
32+
33+
$current = $year.$month;
34+
if ( $month < 10 ) {
35+
$current = $year."0".$month;
36+
}
37+
$goaprev[$current] = $year."-".$month;
38+
39+
closedir($handle);
40+
}
41+
42+
arsort($goaprev);
43+
44+
$options = "";
45+
foreach ($goaprev as $key => $value)
46+
{
47+
48+
if(file_exists($value.'/awsindex.html') && file_exists($value.'/goaindex.html')) {
49+
$goaccessindex = 'goaindex.html';
50+
} elseif(file_exists($value.'/awsindex.html') && !file_exists($value.'/goaindex.html')) {
51+
$goaccessindex = 'awsindex.html';
52+
} else {
53+
$goaccessindex = 'goaindex.html';
54+
}
55+
56+
if($key == $current) $options .= "<option selected=\"selected\" value=\"{$goaccessindex}\">{$value}</option>\n";
57+
else $options .= "<option value=\"{$value}/{$goaccessindex}\">{$value}</option>\n";
58+
59+
}
60+
$goaccessindex = 'goaindex.html';
61+
62+
$html = "<!DOCTYPE html>\n<html>\n<head>\n<title>Stats</title>\n";
63+
$html .= "<style>\nhtml,body {margin:0px;padding:0px;width:100%;height:100%;background-color: #ccc;}\n";
64+
$html .= "#header\n{\nwidth:100%;margin:0px auto;\nheight:20px;\nposition:fixed;\npadding:4px;\ntext-align:center;\n}\n";
65+
$html .= "iframe {width:100%;height:95%;margin:0px;margin-top:40px;border:0px;padding:0px;}\n</style>\n</head>\n<body>\n";
66+
$html .= $script;
67+
$html .= "<div id=\"header\">{$yearmonth_text}\n";
68+
$html .= "<select name=\"goadate\" onchange=\"load_content(this.value)\">\n";
69+
$html .= $options;
70+
$html .= "</select>\n</div>\n<iframe src=\"{$goaccessindex}\" id=\"content\"></iframe>\n";
71+
$html .= "</body></html>";
72+
echo $html;
73+
?>

‎server/lib/classes/cron.d/150-goaccess.inc.php‎

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
<?php
2+
3+
/*
4+
Copyright (c) 2013, Marius Cramer, pixcept KG
5+
All rights reserved.
6+
7+
Redistribution and use in source and binary forms, with or without modification,
8+
are permitted provided that the following conditions are met:
9+
10+
* Redistributions of source code must retain the above copyright notice,
11+
this list of conditions and the following disclaimer.
12+
* Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
* Neither the name of ISPConfig nor the names of its contributors
16+
may be used to endorse or promote products derived from this software without
17+
specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22+
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
23+
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24+
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
26+
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27+
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28+
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
*/
30+
31+
class cronjob_goaccess extends cronjob {
32+
33+
// job schedule
34+
protected $_schedule = '0 0 * * *';
35+
36+
/* this function is optional if it contains no custom code */
37+
public function onPrepare() {
38+
global $app;
39+
40+
parent::onPrepare();
41+
}
42+
43+
/* this function is optional if it contains no custom code */
44+
public function onBeforeRun() {
45+
global $app;
46+
47+
return parent::onBeforeRun();
48+
}
49+
50+
public function onRunJob() {
51+
global $app, $conf;
52+
53+
//######################################################################################################
54+
// Create goaccess statistics
55+
//######################################################################################################
56+
57+
$sql = "SELECT domain_id, domain, document_root, web_folder, type, system_user, system_group, parent_domain_id FROM web_domain WHERE (type = 'vhost' or type = 'vhostsubdomain' or type = 'vhostalias') and stats_type = 'goaccess' AND server_id = ?";
58+
$records = $app->db->queryAllRecords($sql, $conf['server_id']);
59+
60+
$web_config = $app->getconf->get_server_config($conf['server_id'], 'web');
61+
62+
$goaccess_conf_dir = '/etc/';
63+
$goaccess_conf_main = $goaccess_conf_dir . 'goaccess.conf';
64+
65+
if(!file_exists($goaccess_conf_main) || !isset($goaccess_conf_main))
66+
{
67+
$app->log("No GoAccess base config found. Make sure that GoAccess is installed and that the goaccess.conf does exist in ".$goaccess_conf_dir.".", LOGLEVEL_WARN);
68+
}
69+
70+
/* Check wether the goaccess binary is in path */
71+
system('type goaccess', $retval);
72+
if ($retval === 0) {
73+
74+
foreach($records as $rec) {
75+
$yesterday = date('Ymd', strtotime("-1 day", time()));
76+
77+
$log_folder = 'log';
78+
79+
if($rec['type'] == 'vhostsubdomain' || $rec['type'] == 'vhostalias') {
80+
$tmp = $app->db->queryOneRecord('SELECT `domain` FROM web_domain WHERE domain_id = ?', $rec['parent_domain_id']);
81+
$subdomain_host = preg_replace('/^(.*)\.' . preg_quote($tmp['domain'], '/') . '$/', '$1', $rec['domain']);
82+
if($subdomain_host == '') $subdomain_host = 'web'.$rec['domain_id'];
83+
$log_folder .= '/' . $subdomain_host;
84+
unset($tmp);
85+
}
86+
87+
$logfile = escapeshellcmd($rec['document_root'].'/' . $log_folder . '/'.$yesterday.'-access.log');
88+
89+
if(!@is_file($logfile)) {
90+
$logfile = escapeshellcmd($rec['document_root'].'/' . $log_folder . '/'.$yesterday.'-access.log.gz');
91+
if(!@is_file($logfile)) {
92+
continue;
93+
}
94+
}
95+
96+
$web_folder = (($rec['type'] == 'vhostsubdomain' || $rec['type'] == 'vhostalias') ? $rec['web_folder'] : 'web');
97+
$domain = escapeshellcmd($rec['domain']);
98+
$statsdir = escapeshellcmd($rec['document_root'].'/'.$web_folder.'/stats');
99+
$goaccess_conf = escapeshellcmd($rec['document_root'].'/log/goaccess.conf');
100+
101+
/*
102+
In case that you use a different log format, you should use a custom goaccess.conf which you'll have to put into /usr/local/ispconfig/server/conf-custom/.
103+
By default the originally, with GoAccess shipped goaccess.conf from /etc/ will be used along with the log-format value COMBINED.
104+
*/
105+
106+
if(file_exists("/usr/local/ispconfig/server/conf-custom/goaccess.conf.master") && (!file_exists($goaccess_conf))) {
107+
copy("/usr/local/ispconfig/server/conf-custom/goaccess.conf.master", $goaccess_conf);
108+
} elseif(!file_exists($goaccess_conf)) {
109+
/*
110+
By default the goaccess.conf should get copied by the webserver plugin but in case it wasn't, or it got deleted by accident we gonna copy it again to the destination dir.
111+
Also there was no /usr/local/ispconfig/server/conf-custom/goaccess.conf.master, so we gonna use /etc/goaccess.conf as the base conf.
112+
*/
113+
copy($goaccess_conf_main, $goaccess_conf);
114+
file_put_contents($goaccess_conf, preg_replace('/^(#)?log-format COMBINED/m', "log-format COMBINED", file_get_contents($goaccess_conf)));
115+
}
116+
117+
/* Update the primary domain name in the title, it could occasionally change */
118+
if(is_file($goaccess_conf) && (filesize($goaccess_conf) > 0)) {
119+
$goaccess_content = file_get_contents($goaccess_conf);
120+
file_put_contents($goaccess_conf, preg_replace('/^(#)?html-report-title(.*)?/m', "html-report-title $domain", file_get_contents($goaccess_conf)));
121+
}
122+
123+
124+
125+
if(!@is_dir($statsdir)) mkdir($statsdir);
126+
$username = escapeshellcmd($rec['system_user']);
127+
$groupname = escapeshellcmd($rec['system_group']);
128+
$docroot = $rec['document_root'];
129+
130+
$goa_db_dir = $docroot.'/'.$web_folder.'/stats/.db/';
131+
$output_html = $docroot.'/'.$web_folder.'/stats/goaindex.html';
132+
if(!@is_dir($goa_db_dir)) mkdir($goa_db_dir);
133+
134+
if(is_link('/var/log/ispconfig/httpd/'.$domain.'/yesterday-access.log')) unlink('/var/log/ispconfig/httpd/'.$domain.'/yesterday-access.log');
135+
symlink($logfile, '/var/log/ispconfig/httpd/'.$domain.'/yesterday-access.log');
136+
137+
138+
chown($statsdir, $username);
139+
chgrp($statsdir, $groupname);
140+
141+
$goamonth = date("n");
142+
$goayear = date("Y");
143+
144+
if (date("d") == 1) {
145+
$goamonth = date("m")-1;
146+
if (date("m") == 1) {
147+
$goayear = date("Y")-1;
148+
$goamonth = "12";
149+
}
150+
}
151+
152+
153+
if (date("d") == 2) {
154+
$goamonth = date("m")-1;
155+
if (date("m") == 1) {
156+
$goayear = date("Y")-1;
157+
$goamonth = "12";
158+
}
159+
160+
$statsdirold = $statsdir."/".$goayear."-".$goamonth."/";
161+
162+
if(!is_dir($statsdirold)) {
163+
mkdir($statsdirold);
164+
}
165+
166+
rename($goa_db_dir, $statsdirold.'db');
167+
mkdir($goa_db_dir);
168+
169+
$files = scandir($statsdir);
170+
foreach ($files as $file) {
171+
if (substr($file, 0, 1) != "." && !is_dir("$statsdir"."/"."$file") && substr($file, 0, 1) != "w" && substr($file, 0, 1) != "i") copy("$statsdir"."/"."$file", "$statsdirold"."$file");
172+
}
173+
}
174+
175+
$app->system->exec_safe("goaccess -f ? --config-file ? --load-from-disk --keep-db-files --db-path=? --output=?", $logfile, $goaccess_conf, $goa_db_dir, $output_html);
176+
177+
if(!is_file($rec['document_root']."/".$web_folder."/stats/index.php")) {
178+
if(file_exists("/usr/local/ispconfig/server/conf-custom/goaccess_index.php.master")) {
179+
copy("/usr/local/ispconfig/server/conf-custom/goaccess_index.php.master", $rec['document_root']."/".$web_folder."/stats/index.php");
180+
} else {
181+
copy("/usr/local/ispconfig/server/conf/goaccess_index.php.master", $rec['document_root']."/".$web_folder."/stats/index.php");
182+
}
183+
}
184+
185+
$app->log('Created GoAccess statistics for ' . $domain, LOGLEVEL_DEBUG);
186+
187+
188+
if(is_file($rec['document_root']."/".$web_folder."/stats/index.php")) {
189+
chown($rec['document_root']."/".$web_folder."/stats/index.php", $rec['system_user']);
190+
chgrp($rec['document_root']."/".$web_folder."/stats/index.php", $rec['system_group']);
191+
}
192+
193+
$app->system->exec_safe('chown -R ?:? ?', $username, $groupname, $statsdir);
194+
195+
}
196+
} else {
197+
$app->log("Stats not generated. The GoAccess binary couldn't be found. Make sure that GoAccess is installed and that it is in \$PATH", LOGLEVEL_WARN);
198+
}
199+
200+
parent::onRunJob();
201+
}
202+
203+
/* this function is optional if it contains no custom code */
204+
public function onAfterRun() {
205+
global $app;
206+
207+
parent::onAfterRun();
208+
}
209+
210+
}
211+
212+
?>

‎server/plugins-available/apache2_plugin.inc.php‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1863,6 +1863,12 @@ function update($event_name, $data) {
18631863
$this->awstats_update($data, $web_config);
18641864
}
18651865

1866+
//* Create GoAccess configuration
1867+
if($data['new']['stats_type'] == 'goaccess' && ($data['new']['type'] == 'vhost' || $data['new']['type'] == 'vhostsubdomain' || $data['new']['type'] == 'vhostalias')) {
1868+
$this->goaccess_update($data, $web_config);
1869+
}
1870+
1871+
18661872
//* Remove Stats-Folder when Statistics set to none
18671873
if($data['new']['stats_type'] == '' && ($data['new']['type'] == 'vhost' || $data['new']['type'] == 'vhostsubdomain' || $data['new']['type'] == 'vhostalias')) {
18681874
$app->file->removeDirectory($data['new']['document_root'].'/web/stats');
@@ -2973,6 +2979,67 @@ private function awstats_update ($data, $web_config) {
29732979
}
29742980
}
29752981

2982+
//* Update the GoAccess configuration file
2983+
private function goaccess_update ($data, $web_config) {
2984+
global $app;
2985+
2986+
$web_folder = $data['new']['web_folder'];
2987+
if($data['new']['type'] == 'vhost') $web_folder = 'web';
2988+
2989+
$goaccess_conf_dir = '/etc/';
2990+
$goaccess_conf_main = $goaccess_conf_dir.'goaccess.conf';
2991+
2992+
if(!is_dir($data['new']['document_root']."/" . $web_folder . "/stats/")) mkdir($data['new']['document_root']."/" . $web_folder . "/stats/.db");
2993+
$goaccess_conf = escapeshellcmd($data['new']['document_root'].'/log/goaccess.conf');
2994+
2995+
2996+
/*
2997+
In case that you use a different log format, you should use a custom goaccess.conf which you'll have to put into /usr/local/ispconfig/server/conf-custom/.
2998+
By default the originaly with GoAccess shipped goaccess.conf from /etc/ will be used along with the log-format value COMBINED.
2999+
*/
3000+
if(file_exists("/usr/local/ispconfig/server/conf-custom/goaccess.conf.master") && (!file_exists($goaccess_conf))) {
3001+
copy("/usr/local/ispconfig/server/conf-custom/goaccess.conf.master", $goaccess_conf);
3002+
} elseif(!file_exists($goaccess_conf)) {
3003+
/*
3004+
By default the goaccess.conf should get copied by the webserver plugin but in case it wasn't, or it got deleted by accident we gonna copy it again to the destination dir.
3005+
Also there was no /usr/local/ispconfig/server/conf-custom/goaccess.conf.master, so we gonna use /etc/goaccess.conf as the base conf.
3006+
*/
3007+
copy($goaccess_conf_main, $goaccess_conf);
3008+
file_put_contents($goaccess_conf, preg_replace('/^(#)?log-format COMBINED/m', "log-format COMBINED", file_get_contents($goaccess_conf)));
3009+
}
3010+
3011+
if(file_exists($goaccess_conf)) {
3012+
$domain = escapeshellcmd($data['new']['domain']);
3013+
file_put_contents($goaccess_conf, preg_replace('/^(#)?html-report-title(.*)/m', "html-report-title $domain", file_get_contents($goaccess_conf)));
3014+
}
3015+
3016+
if(is_file($goaccess_conf) && (filesize($goaccess_conf) > 0)) {
3017+
$app->log('Created GoAccess config file: '.$goaccess_conf, LOGLEVEL_DEBUG);
3018+
} else {
3019+
$app->log("No GoAccess base config found. Make sure that GoAccess is installed and that the goaccess.conf does exist in ".$goaccess_conf_dir.".", LOGLEVEL_WARN);
3020+
}
3021+
3022+
if(is_file($data['new']['document_root']."/" . $web_folder . "/stats/index.html")) $app->system->unlink($data['new']['document_root']."/" . $web_folder . "/stats/index.html");
3023+
if(file_exists("/usr/local/ispconfig/server/conf-custom/goaccess_index.php.master")) {
3024+
$app->system->copy("/usr/local/ispconfig/server/conf-custom/goaccess_index.php.master", $data['new']['document_root']."/" . $web_folder . "/stats/index.php");
3025+
} else {
3026+
$app->system->copy("/usr/local/ispconfig/server/conf/goaccess_index.php.master", $data['new']['document_root']."/" . $web_folder . "/stats/index.php");
3027+
}
3028+
}
3029+
3030+
//* Delete the GoAccess configuration file
3031+
private function goaccess_delete ($data, $web_config) {
3032+
global $app;
3033+
3034+
$goaccess_conf = escapeshellcmd($data['new']['document_root'].'/log/goaccess.conf');
3035+
3036+
if ( @is_file($goaccess_conf) ) {
3037+
$app->system->unlink($goaccess_conf);
3038+
$app->log('Removed GoAccess config file: '.$goaccess_conf, LOGLEVEL_DEBUG);
3039+
}
3040+
}
3041+
3042+
29763043
//* Delete the awstats configuration file
29773044
private function awstats_delete ($data, $web_config) {
29783045
global $app;

0 commit comments

Comments
 (0)