]> git.datanom.net - qtadmin.git/blame - lib/utils.inc.php
More functions for wblist page
[qtadmin.git] / lib / utils.inc.php
CommitLineData
6df4b805 1<?php
6b3d5ba9 2/* vim: set ts=4 tw=0 sw=4 noet: */
6df4b805 3require_once $CFG->root .'config.php';
6ead258e 4require_once $CFG->root . 'lib/session_handler.inc.php';
6df4b805 5
3056d117
MR
6class Utils {
7
2b6294e9 8 private $timeout = false;
3056d117 9 private $settings;
01cc21cf
MR
10 private $log_level;
11 private $log_method;
b95d1cdb 12 private $header = '<!DOCTYPE html>
6df4b805
MR
13<html>
14<head>
b95d1cdb
MR
15 <meta charset="utf-8">
16 <link rel="stylesheet" href="css/styles.css">
17 <script>
18 var timeout = __TIMEOUT__;
19 </script>
20 <script src="__ROOT__js/timer.js"></script>
5c7b972e 21 <script src="__ROOT__js/checkbox.js"></script>
7ef22e21 22 <script src="__ROOT__js/forms.js"></script>
b95d1cdb 23 <title>__TITLE__</title>
6df4b805 24</head>
b70a3d74 25<body>
65ff42ae 26<!--
b70a3d74 27<nav>
ba9876ed
MR
28 <ul>
29 <li><a href="index.php">Home</a></li>
30 <li>
31 <a href="#">Sections <span class="caret"></span></a>
32 <div>
33 <ul>
34 <li><a href="qtadmin.php">Quarantine admin</a></li>
35 <li><a href="wblist.php">WB list admin</a></li>
36 </ul>
37 </div>
38 </li>
39 <li><a href="about.html">About</a></li>
40 <li><a href="auth.php?op=logout">Logout</a></li>
41 </ul>
65ff42ae
MR
42</nav>
43-->
44<nav>
ba9876ed
MR
45 <ul>
46 <li><a href="index.php">Home</a></li>
47 <li>
48 <a href="#">Sections <span class="caret"></span></a>
49 <div>
50 <ul>
51 <li>
52 <a href="qtadmin.php">Quarantine admin</span></a>
53 </li>
54 <li><a href="#">WB list admin <span class="caret"></a>
55 <div>
56 <ul>
57 <li><a href="wblist.php?p=show&amp;s=all">Show All</a></li>
58 <li><a href="wblist.php?p=show&amp;s=blacklist">Show Blacklist</a></li>
59 <li><a href="wblist.php?p=show&amp;s=whitelist">Show Whitelist</a></li>
60 <li><a href="wblist.php?p=add">Add Rule</a></li>
61 <li><a href="wblist.php?p=del">Delete Rule</a></li>
62 </ul>
63 </div>
64 </li>
65 </ul>
66 </div>
67 </li>
68 <li><a href="about.html">About</a></li>
69 <li><a href="auth.php?op=logout">Logout</a></li>
70 </ul>
b70a3d74 71</nav>
ba9876ed 72 <div id="container">';
60aad80e
MR
73 private $footer = '</div><div id="footer"><p>Powered by <a href="https://qtadmin.datanom.net"
74 title="Goto QtAdmin homepage">QtAdmin</a>. &copy; 2015 by Michael Rasmussen</p>
3039de29 75 </div></body></html>';
b95d1cdb
MR
76 private $heading = '<p id="time" class="time">Session timeout:
77 <span id="timer"></span></p><h1 class="h1">__TITLE__</h1>';
78
3056d117 79 public function __construct() {
b95d1cdb
MR
80 global $CFG;
81
01cc21cf
MR
82 if (isset($CFG->log_level)) {
83 $this->log_level = $CFG->log_level;
84 } else {
85 $this->log_level = 1;
86 }
87
88 if (isset($CFG->log_method)) {
89 $this->log_method = $CFG->log_method;
90 } else {
91 $this->log_level = 'syslog';
92 }
93
519a15b5
MR
94 $this->log("Init Utils", 4);
95
9da61a01 96 $this->log("__construct[1]: user ".var_export($this->settings['user'], true), 3);
a675b383 97 $this->startSession();
9da61a01 98 $this->log("__construct[2]: user ".var_export($this->settings['user'], true), 3);
a675b383 99
3056d117
MR
100 if (! isset($_SESSION['settings'])) {
101 $this->initSettings();
102 }
9da61a01 103 $this->log("__construct[3]: user ".var_export($this->settings['user'], true), 3);
3056d117 104 $this->settings = $_SESSION['settings'];
9da61a01 105 $this->log("__construct[4]: user ".var_export($this->settings['user'], true), 3);
3056d117
MR
106
107 if ($CFG->auth_method == 'HTTP_AUTH') {
86fb546e
MR
108 if (isset($_SERVER['PHP_AUTH_USER'])) {
109 $this->settings['user'] = $_SERVER['PHP_AUTH_USER'];
3056d117
MR
110 $this->settings['loginStatus'] = 'OK';
111 if ($CFG->admin_user == $this->settings['user'])
112 $this->settings['admin'] = true;
b95d1cdb
MR
113 }
114 }
b95d1cdb
MR
115 }
116
01cc21cf
MR
117 private function log($message, $level = 1) {
118 global $CFG;
119
120 if ($level > $this->log_level)
121 return;
122
123 $time = date('c');
01cc21cf
MR
124
125 $priority = LOG_INFO;
126 switch ($level) {
127 case 1: $priority = LOG_ERR; break;
128 case 2: $priority = LOG_WARNING; break;
129 case 3: $priority = LOG_INFO; break;
130 case 4: $priority = LOG_DEBUG; break;
131 }
132
133 switch ($this->log_method) {
134 case 'file':
7b561609
MR
135 if (isset($CFG->log_file)) {
136 if ($CFG->log_file[0] == '/') {
137 $file = $CFG->log_file;
138 } else {
139 $file = $CFG->root.$CFG->log_file;
140 }
141 } else {
142 $file = $CFG->root.'qtadmin.log';
143 }
815fed0c 144 file_put_contents($file, "[$time]: $message\n", FILE_APPEND | LOCK_EX);
ecc5e773 145 chmod($file, 0600);
7b561609 146 break;
01cc21cf 147 case 'stderr':
815fed0c 148 file_put_contents('php://stderr', "[$time]: $message\n");
7b561609 149 break;
01cc21cf 150 case 'syslog':
2dd58fe8 151 syslog($priority, $message);
01cc21cf 152 break;
d6be2d1a 153 }
01cc21cf
MR
154 }
155
3056d117 156 private function initSettings() {
2dd58fe8
MR
157 $this->log("InitSettings", 4);
158
3056d117
MR
159 if ('' == session_id()) {
160 $this->startSession();
161 }
b95d1cdb 162
2b6294e9
MR
163 if (false !== $this->timeout) {
164 $timeout = $this->timeout;
165 } else {
166 $timeout = 0;
167 }
168
3056d117 169 $this->settings = array(
3056d117
MR
170 'user' => null,
171 'admin' => false,
172 'loginStatus' => 'Not logged in',
2b6294e9 173 'timeout' => $timeout
3056d117 174 );
6072c905 175
3056d117 176 $_SESSION['settings'] = $this->settings;
6072c905
MR
177 }
178
a675b383 179 private function startSession() {
b95d1cdb
MR
180 global $CFG;
181
2dd58fe8
MR
182 $this->log("startSession", 4);
183
b95d1cdb 184 if (isset($CFG->session_timeout)) {
2b6294e9 185 $this->timeout = $CFG->session_timeout * 60;
b95d1cdb 186 } else {
2b6294e9 187 $this->timeout = 20 * 60;
b95d1cdb
MR
188 }
189
2b6294e9
MR
190 if (ini_get('session.gc_maxlifetime') != $this->timeout)
191 ini_set('session.gc_maxlifetime', $this->timeout);
7b561609
MR
192 //if (ini_get('session.cookie_lifetime') != $this->timeout)
193 // ini_set('session.cookie_lifetime', $this->timeout);
194 ini_set('session.cookie_lifetime', 0);
a675b383
MR
195
196 session_start();
7d9c7fe2
MR
197 }
198
3056d117 199 private function checkSession() {
7d9c7fe2
MR
200 global $CFG;
201
2dd58fe8
MR
202 $this->log("checkSession", 4);
203
39023189
MR
204 if ('' == session_id()) {
205 $this->startSession();
206 }
207
b95d1cdb 208 $time = $_SERVER['REQUEST_TIME'];
7d9c7fe2 209 if (isset($_SESSION['LAST_ACTIVITY']) &&
3056d117 210 ($time - $_SESSION['LAST_ACTIVITY']) >= $this->settings['timeout']) {
07124c37
MR
211 $this->log('R_TIME: '.date('c', $time).' L_ACT: '.date('c', $_SESSION['LAST_ACTIVITY'].
212 'Test: '.($time - $_SESSION['LAST_ACTIVITY'])).' >= '.$this->settings['timeout'], 3);
3056d117 213 $this->logout();
a675b383
MR
214 } else {
215 $_SESSION['LAST_ACTIVITY'] = $time;
216 }
b95d1cdb
MR
217 }
218
0da9e6e7
MR
219 private function getCSRFPreventionToken($ticket) {
220 return array('CSRFPreventionToken: ' . $ticket->CSRFPreventionToken);
221 }
222
223 private function getRestTicket($username, $password) {
6ba8e4d3
MR
224 global $CFG;
225
0da9e6e7
MR
226 $result = false;
227 $url = $CFG->wblistadm_url . '/ticket';
228
229 $data = "username=$username&password=$password";
230 $response = $this->RESTCall($url, $data, $cookiesIn = '');
231 if ($response['http_code'] >= 200 && $response['http_code'] <= 204) {
232 $data = json_decode($response['content']);
233 $_SESSION['ticket'] = $data->data;
234 $_SESSION['cookies'] = $response['cookies'];
235 $result = true;
236 }
237
238 return $result;
239 }
240
241 public function makeRestCall($method, $data = null) {
6ba8e4d3
MR
242 global $CFG;
243
0da9e6e7
MR
244 $result;
245
f1c0988b 246 $url = $CFG->wblistadm_url . "$method";
0da9e6e7
MR
247 $token = $this->getCSRFPreventionToken($_SESSION['ticket']);
248 $response = $this->RESTCall($url, $data, $_SESSION['cookies'], $token);
249
250 if ($response['http_code'] >= 200 && $response['http_code'] <= 204) {
251 if ($data) {
252 // HTTP POST
253 $result = true;
254 } else {
255 // HTTP GET
256 $data = json_decode($response['content']);
840f130b
MR
257 if (is_object($data)) {
258 $result = $data->data;
259 } else {
260 $result = array('No result');
261 }
0da9e6e7
MR
262 }
263 } else {
264 $result = ($data) ? false : array();
265 }
266
267 return $result;
268 }
269
270 private function RESTCall($url, $data = null, $cookiesIn = '', $headers = null) {
271 $options = array(
272 CURLOPT_RETURNTRANSFER => true, // return web page
273 CURLOPT_HEADER => true, //return headers in addition to content
274 CURLOPT_FOLLOWLOCATION => true, // follow redirects
275 CURLOPT_ENCODING => "", // handle all encodings
276 CURLOPT_AUTOREFERER => true, // set referer on redirect
277 CURLOPT_CONNECTTIMEOUT => 120, // timeout on connect
278 CURLOPT_TIMEOUT => 120, // timeout on response
279 CURLOPT_MAXREDIRS => 10, // stop after 10 redirects
280 CURLINFO_HEADER_OUT => true,
281 CURLOPT_SSL_VERIFYPEER => false, // Disabled SSL Cert checks
282 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
283 CURLOPT_COOKIE => $cookiesIn
284 );
285
286 if ($data) {
287 $options[CURLOPT_POST] = 1;
288 $options[CURLOPT_POSTFIELDS] = $data;
289 }
290
291 if ($headers) {
292 $options[CURLOPT_HTTPHEADER] = $headers;
293 }
294
295 $ch = curl_init($url);
296 curl_setopt_array($ch, $options);
297 $rough_content = curl_exec($ch);
298 $err = curl_errno($ch);
299 $errmsg = curl_error($ch);
300 $header = curl_getinfo($ch);
301 curl_close($ch);
302
303 $header_content = substr($rough_content, 0, $header['header_size']);
304 $body_content = trim(str_replace($header_content, '', $rough_content));
305 $pattern = "#Set-Cookie:\\s+(?<cookie>[^=]+=[^;]+)#m";
306 preg_match_all($pattern, $header_content, $matches);
307 $cookiesOut = implode("; ", $matches['cookie']);
308
309 $header['errno'] = $err;
310 $header['errmsg'] = $errmsg;
311 $header['headers'] = $header_content;
312 $header['content'] = $body_content;
313 $header['cookies'] = $cookiesOut;
314
315 return $header;
316 }
317
b95d1cdb 318 public function logout() {
2dd58fe8
MR
319 $this->log("logout", 4);
320
b95d1cdb
MR
321 if (ini_get('session.use_cookies')) {
322 $params = session_get_cookie_params();
323 setcookie(session_name(), '', time() - 42000,
324 $params['path'], $params['domain'],
325 $params['secure'], $params['httponly']);
326 }
39023189
MR
327
328 if ('' != session_id()) {
329 $_SESSION = array();
330 session_unset();
331 session_destroy();
332 }
3056d117 333 $this->settings = array();
b95d1cdb
MR
334 }
335
336 public function isAdmin() {
3056d117
MR
337 $admin = false;
338
2dd58fe8
MR
339 $this->log("isAdmin", 4);
340
3056d117
MR
341 if (isset($this->settings['admin'])) {
342 $admin = $this->settings['admin'];
343 }
344
345 return $admin;
b95d1cdb
MR
346 }
347
348 public function login($user, $pw) {
349 global $CFG;
350 $result = false;
351
2dd58fe8
MR
352 $this->log("login", 4);
353
3056d117
MR
354 if ('' == session_id()) {
355 $this->startSession();
356 }
357
358 $this->settings['user'] = null;
359 $this->settings['admin'] = false;
b95d1cdb
MR
360
361 $p = explode('@', $user);
362 if (count($p) != 2) {
3056d117
MR
363 $this->settings['loginStatus'] = 'Bad username';
364 } else {
365 $domain = $p[1];
366 $dn = "mail=$user,ou=Users,domainName=$domain,$CFG->ldap_base_dn";
367 $filter = "(&(objectclass=mailUser)(accountStatus=active)(mail=$user))";
368 $ds = @ldap_connect($CFG->ldap_dsn);
369 if ($ds) {
370 @ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
371 $r = @ldap_bind($ds, $dn, $pw);
372 if ($r) {
373 $sr = @ldap_search($ds, $CFG->ldap_base_dn, $filter, array('mail','domainglobaladmin'));
374 $info = @ldap_get_entries($ds, $sr); // array
375 if ($info['count'] > 0) {
5ec97892 376 // Log in to wblistadm server and get CSRFPreventionToken
0da9e6e7
MR
377 if ($this->getRestTicket($user, $pw)) {
378 $this->settings['user'] = $user;
379 $result = true;
380 $this->settings['loginStatus'] = 'OK';
381 $admin = 'NO';
382 if (isset($info[0]['domainglobaladmin'])) {
383 $admin = $info[0]['domainglobaladmin'][0];
384 $admin = strtoupper($admin);
385 }
386 $this->settings['admin'] = ($admin == 'YES') ? true : false;
387 } else {
388 $this->settings['loginStatus'] = 'Login failed';
389 }
3056d117
MR
390 } else {
391 $this->settings['loginStatus'] = 'Login failed';
b95d1cdb 392 }
6df4b805 393 } else {
3056d117 394 $this->settings['loginStatus'] = ldap_error($ds);
6df4b805 395 }
3056d117 396 @ldap_close($ds);
6df4b805 397 } else {
3056d117 398 $this->settings['loginStatus'] = 'Connect to LDAP server failed';
6df4b805 399 }
6df4b805
MR
400 }
401
3056d117 402 $_SESSION['settings'] = $this->settings;
6e081c5f 403
b95d1cdb
MR
404 return $result;
405 }
406
407 public function getLoginStatus() {
3056d117
MR
408 $status = 'Not logged in';
409
2dd58fe8
MR
410 $this->log("getLoginStatus", 4);
411
3056d117
MR
412 if (isset($this->settings['loginStatus'])) {
413 $status = $this->settings['loginStatus'];
414 }
415
416 return $status;
b95d1cdb
MR
417 }
418
419 public function isLoggedIn() {
420 global $CFG;
421 $loggedIn = false;
422
65f27692 423 $this->log("isLoggedIn[1]: user ".var_export($this->settings['user'], true), 3);
2dd58fe8 424
3056d117
MR
425 if ('' == session_id()) {
426 $this->startSession();
427 }
428
65f27692 429 $this->log("isLoggedIn[2]: user ".var_export($this->settings['user'], true), 3);
39023189 430 $this->checkSession();
65f27692 431 $this->log("isLoggedIn[3]: user ".var_export($this->settings['user'], true), 3);
39023189 432
3056d117
MR
433 if (isset($this->settings['user'])) {
434 if ($this->settings['user'] != null) {
435 $loggedIn = true;
436 } else {
437 if ($CFG->auth_method == 'HTTP_AUTH') {
86fb546e
MR
438 if (isset($_SERVER['PHP_AUTH_USER'])) {
439 $this->settings['user'] = $_SERVER['PHP_AUTH_USER'];
3056d117
MR
440 $loggedIn = true;
441 }
b95d1cdb
MR
442 }
443 }
444 }
445
85ec6a84 446 if ($loggedIn == false) {
7b561609
MR
447 $this->log('$this->settings: '.var_export($this->settings, true), 3);
448 $this->log('R_TIME: '.date('c', $_SERVER['REQUEST_TIME']).' L_ACT: '.date('c', $_SESSION['LAST_ACTIVITY']), 3);
18d80742 449 }
6e081c5f 450
3056d117 451 $_SESSION['settings'] = $this->settings;
6e081c5f 452
b95d1cdb
MR
453 return $loggedIn;
454 }
455
456 public function getUser() {
3056d117
MR
457 $user = null;
458
2dd58fe8
MR
459 $this->log("getUser", 4);
460
3056d117
MR
461 if ($this->isLoggedIn()) {
462 $user = $this->settings['user'];
463 }
464
465 return $user;
b95d1cdb
MR
466 }
467
3039de29
MR
468 public function authorized($recipient) {
469 $authorized = false;
470
cdd7c88a
MR
471 $this->log("authorized '$recipient'", 3);
472
3039de29
MR
473 if ($this->isAdmin() || $this->getUser() == $recipient) {
474 $authorized = true;
475 }
181e3b1f
MR
476 $msg = ($authorized) ? 'authorize' : 'not authorize';
477 $this->log("$msg '".$this->getUser()."' rcpt '$recipient'", 3);
3039de29
MR
478
479 return $authorized;
480 }
481
b95d1cdb 482 public function getHeader() {
2dd58fe8
MR
483 $this->log("getHeader", 4);
484
b95d1cdb
MR
485 return $this->header;
486 }
487
488 public function getFooter() {
2dd58fe8
MR
489 $this->log("getFooter", 4);
490
b95d1cdb
MR
491 return $this->footer;
492 }
493
494 public function getHeading() {
2dd58fe8
MR
495 $this->log("getHeading", 4);
496
b95d1cdb
MR
497 return $this->heading;
498 }
499
500 public function setHeading($heading) {
501 global $CFG;
502
2dd58fe8
MR
503 $this->log("setHeading", 4);
504
b95d1cdb
MR
505 $timeout = $CFG->session_timeout * 60 * 1000;
506 $this->heading = str_replace('__TITLE__', $heading, $this->heading);
507 $this->header = str_replace('__TITLE__', $heading, $this->header);
508 $this->header = str_replace('__ROOT__', $CFG->wwwroot, $this->header);
509 $this->header = str_replace('__TIMEOUT__', $timeout, $this->header);
510 }
511
512 public function convertContent($code) {
2dd58fe8
MR
513 $this->log("convertContent", 4);
514
b95d1cdb
MR
515 $table = array(
516 'V' => 'Virus',
517 'B' => 'Banned',
518 'U' => 'Unchecked',
519 'S' => 'Spam',
520 'Y' => 'Spammy',
521 'M' => 'Bad Mime',
522 'H' => 'Bad Header',
523 'O' => 'Over sized',
524 'T' => 'MTA err',
525 'C' => 'Clean'
526 );
527
528 $string = $table[$code];
529 if (empty($string))
530 $string = 'Unknown';
531
532 return $string;
533 }
6df4b805 534
6df4b805 535}
This page took 0.158063 seconds and 5 git commands to generate.