added possibility to skip version detection
[ZNCAdmin.git] / zncadmin.php
1 <?php
2 /* czncadmin.php - main script - ZNCAdmin
3  * Copyright (C) 2011-2012  Philipp Kreil (pk910)
4  * 
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  * 
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  * 
15  * You should have received a copy of the GNU General Public License 
16  * along with this program. If not, see <http://www.gnu.org/licenses/>. 
17  */
18
19 error_reporting(E_ALL & ~E_NOTICE);
20 require_once("zncadmin/HTTPConnector.class.php");
21 require_once("zncadmin/ZNCServer.class.php");
22 require_once("zncadmin/Table.class.php");
23
24 require_once("config.inc.php");
25
26 /*
27 $argv[1]   subcommand
28 */
29
30 function error($msg) {
31     echo"\00304ZNCAdmin error:\003 ".$msg."\n";
32 }
33
34 if(strtolower($argv[1]) == "force") {
35     $argv = array_slice($argv, 1);
36     $force = true;
37 } else
38     $force = false;
39
40 switch(strtolower($argv[1])) {
41     case "add":
42         zncadmin_add();
43         break;
44     case "del":
45         zncadmin_del();
46         break;
47     case "search":
48         zncadmin_search();
49         break;
50         case "seen":
51         zncadmin_seen();
52         break;
53     case "resetpass":
54         zncadmin_resetpass();
55         break;
56     case "simul":
57         zncadmin_simul();
58         break;
59     case "block":
60         zncadmin_block();
61         break;
62     case "unblock":
63         zncadmin_unblock();
64         break;
65     case "stats":
66         zncadmin_stats();
67         break;
68     default:
69         error("invalid subcommand '".$argv[1]."'");
70         break;
71 }
72
73 function preg_prepare($string,$wildcards = true,$pregstart = "#") {
74     $in = array("\\","^",".","$","|","(",")","[","]","+","?","{","}",",",$pregstart);
75     if(!$wildcards) array_push($in,"*");
76     $out = array();
77     foreach($in as $item) {
78         $out[] = "\\".$item;
79     }
80     if($wildcards) { 
81         array_push($in,"*");
82         array_push($out,"(.*)");
83     }
84     $string = str_replace($in,$out,$string);
85     return $string;
86 }
87
88 function generate_password() {
89     $password_chars = "abcdefghijklmnopqrstuvwxyz01234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ";
90     $password_length = 10;
91     $password = 0;
92     srand();
93     for($i = 0; $i < $password_length; $i++) {
94         $password .= $password_chars[rand(0, strlen($password_chars))-1];
95     }
96     return $password;
97 }
98
99 function str2time($duration) {
100     $str="0";
101     $dur=0;
102     $mult=1;
103     for($i=0;$i<strlen($duration);$i++) {
104         if(is_numeric($duration[$i])) {
105             $str.=$duration[$i];
106         } else if($duration[$i] != " ") {
107             switch ($duration[$i]) {
108                 case "y":
109                     $mult=365*24*60*60;
110                     break;
111                 case "M":
112                     $mult=31*24*60*60;
113                     break;
114                 case "w":
115                     $mult=7*24*60*60;
116                     break;
117                 case "d":
118                     $mult=24*60*60;
119                     break;
120                 case "h":
121                     $mult=60*60;
122                     break;
123                 case "m":
124                     $mult=60;
125                     break;
126                 case "s":
127                     $mult=1;
128                     break;
129                 case "*":
130                     $mult=0;
131                     break;
132                 default:
133                     return null;
134                     break;
135             }
136             $dur=$dur+($str*$mult);
137             $str="0";
138         }
139     }
140     $dur=$dur+$str;
141     return $dur;
142 }
143
144 /***********************************************************
145  *                   ZNCAdmin SUBCOMMANDS                  *
146  ***********************************************************/
147
148 //SUBCOMMAND: search
149 function zncadmin_search() {
150     global $argv, $zncservers;
151     $mask = $argv[2];
152     if(!$mask) {
153         error("missing mask parameter");
154         return;
155     }
156     $extraflags = array();
157     if($argv[3]) {
158         $extraflags = explode(" ", $argv[3]);
159     }
160     $mask = preg_prepare($mask);
161     $table = new Table(5);
162     $table->add("Server", "User", "Clients", "Server");
163     $count = 0;
164     foreach($zncservers as $zncserver) {
165         $zncserver['conn'] = new ZNCServer($zncserver['host'], $zncserver['port'], (isset($zncserver['version']) ? $zncserver['version'] : NULL));
166         $zncserver['conn']->login($zncserver['auser'], $zncserver['apass']);
167         foreach($zncserver['conn']->getUserList() as $user) {
168             $skip = false;
169             foreach($extraflags as $flag) {
170                 //some additional flags ;)
171                 if($flag[0] == '-') {
172                     $flag = substr($flag, 1);
173                     $positive = false;
174                 } else if($flag[0] == '+') {
175                     $flag = substr($flag, 1);
176                     $positive = true;
177                 } else
178                     $positive = true;
179                 $flag = explode("=", $flag, 2);
180                 $flagval = $flag[1];
181                 switch (strtolower($flag[0])) {
182                     case "online":
183                         $skip = (($user['clients'] > 0) != $positive);
184                         break;
185                     case "connected":
186                         $skip = (($user['server'] == "-N/A-") == $positive);
187                         break;
188                     case "server":
189                         $skip = (preg_match("#^".preg_prepare($flagval)."$#i", $user['server']) != $positive);
190                         break;
191                     case "server_regex":
192                         $skip = (preg_match("#^".$flagval."$#i", $user['server']) != $positive);
193                         break;
194                     case "nick":
195                         $skip = (preg_match("#^".preg_prepare($flagval)."$#i", $user['nick']) != $positive);
196                         break;
197                     case "nick_regex":
198                         $skip = (preg_match("#^".$flagval."$#i", $user['nick']) != $positive);
199                         break;
200                     case "znc":
201                         $skip = (preg_match("#^".preg_prepare($flagval)."$#i", $zncserver['name']) != $positive);
202                         break;
203                     default:
204                         
205                         break;
206                 }
207                 if($skip)
208                     break;
209             }
210             if($skip) continue;
211             if(preg_match("#^".$mask."$#i", $user['user'])) {
212                 $table->add($zncserver['name'], $user['user'], $user['clients'], $user['server']);
213                 $count++;
214             }
215         }
216     }
217     if($count) {
218         foreach($table->end() as $line) {
219             echo$line."\n";
220         }
221         echo"Found \002".$count."\002 users.\n";
222     } else {
223         echo "no user matching \002".$argv[2]."\002 found.\n";
224     }
225 }
226
227 //SUBCOMMAND: search
228 function zncadmin_seen() {
229     global $argv, $zncservers;
230         $time = $argv[2];
231         $over_time = true;
232         if($time[0] == '>' || $time[0] == '<') {
233                 if($time[0] == '<') $over_time = false;
234                 $time = substr($time, 1);
235         }
236         $time = time() - str2time($time);
237     $mask = $argv[3];
238     if(!$time) {
239         error("missing time parameter");
240         return;
241     }
242     if($mask)
243         $mask = preg_prepare($mask);
244     else
245         $mask = "(.*)";
246     $table = new Table(4);
247     $table->add("Server", "User", "Seen", "Info");
248     $found = false;
249     foreach($zncservers as $zncserver) {
250         $zncserver['conn'] = new ZNCServer($zncserver['host'], $zncserver['port'], (isset($zncserver['version']) ? $zncserver['version'] : NULL));
251         $zncserver['conn']->login($zncserver['auser'], $zncserver['apass']);
252         foreach($zncserver['conn']->getSeenList() as $user) {
253             if(preg_match("#^".$mask."$#i", $user['user']) && (($over_time && $user['seen_unix'] < $time) || (!$over_time && $user['seen_unix'] > $time))) {
254                 $table->add($zncserver['name'], $user['user'], $user['seen'], $user['info']);
255                 $found = true;
256             }
257         }
258     }
259     if($found) {
260         foreach($table->end() as $line) {
261             echo$line."\n";
262         }
263     } else {
264         echo "no user matching \002".$argv[2]."\002 found.\n";
265     }
266 }
267
268 //SUBCOMMAND: del
269 function zncadmin_del() {
270     global $argv, $zncservers, $force;
271     $username = strtolower($argv[2]);
272     if(!$username) {
273         error("missing username");
274         return;
275     }
276     $delusers = array();
277     foreach($zncservers as $zncserver) {
278         if($argv[3] && (strtolower($argv[3]) != strtolower($zncserver['name']))) continue;
279         if($username == strtolower($zncserver['auser'])) continue;
280         $zncserver['conn'] = new ZNCServer($zncserver['host'], $zncserver['port'], (isset($zncserver['version']) ? $zncserver['version'] : NULL));
281         $zncserver['conn']->login($zncserver['auser'], $zncserver['apass']);
282         foreach($zncserver['conn']->getUserList() as $user) {
283             if(strtolower($user['user']) == $username) {
284                 $delusers[] = array("server" => $zncserver, "user" => $user);
285             }
286         }
287     }
288     if(count($delusers) > 1) {
289         error($argv[2]." exists on multiple servers! please add the server name, the user should be removed from.");
290         echo"Found User on following Servers:\n";
291         foreach($delusers as $server) {
292             echo "\002".$server['server']['name']."\002  Server: ".$server['user']['server']."  Nick: ".$server['user']['nick']."  Clients: ".$server['user']['clients']."\n";
293         }
294     } else if(count($delusers) == 0) {
295         error("Couldn't find an user called \002".$argv[2]."\002.");
296     } else if($delusers[0]['server']['protected'] && !$force) {
297         error("Access denied\n");
298     } else {
299         $deluser = $delusers[0];
300         $deluser['server']['conn']->delZNC($deluser['user']['user']);
301         echo "Deleted \002".$deluser['user']['user']."\002 from Server \002".$deluser['server']['name']."\002\n";
302         echo"/log\n";
303     }
304 }
305
306 //SUBCOMMAND: add
307 function zncadmin_add() {
308     global $argv, $zncservers, $add_settings, $force;
309     $username = strtolower($argv[2]);
310     if(!$username) {
311         error("missing username");
312         return;
313     }
314     $addserv = array();
315     $priority = 1;
316     foreach($zncservers as $zncserver) {
317         if($argv[3] && (strtolower($argv[3]) != strtolower($zncserver['name']))) continue;
318         if(!$argv[3] && $zncserver['priority'] < $priority) continue;
319         if($zncserver['protected'] === true && !$force) {
320             error("Access denied\n");
321             return;
322         }
323         $zncserver['conn'] = new ZNCServer($zncserver['host'], $zncserver['port'], (isset($zncserver['version']) ? $zncserver['version'] : NULL));
324         $zncserver['conn']->login($zncserver['auser'], $zncserver['apass']);
325         $zncserver['users'] = $zncserver['conn']->getUserList();
326         $existing = false;
327         foreach($zncserver['users'] as $user) {
328             if(strtolower($user['user']) == $username) $existing = true;
329         }
330         if(!$existing && count($zncserver['users']) < $zncserver['maxznc']) {
331             if($zncserver['priority'] > $priority) {
332                 $priority = $zncserver['priority'];
333                 $addserv = array();
334             }
335             $addserv[] = $zncserver;
336         }
337     }
338     if(count($addserv) > 1) {
339         //select server with lowest user count
340         $usercount = count($addserv[0]['users']);
341         $selected = 0;
342         for($i = 1; $i < count($addserv); $i++) {
343             if(count($addserv[$i]['users']) < $usercount) {
344                 $usercount = count($addserv[$i]['users']);
345                 $selected = $i;
346             }
347         }
348         $addserv = $addserv[$selected];
349     } else if(count($addserv) == 0) {
350         error("Couldn't find a server the user could be added to.");
351         return;
352     } else {
353         $addserv = $addserv[0];
354     }
355     $password = generate_password();
356     $settings = array();
357     $settings['nick'] = $argv[2];
358     $settings['altnick'] = $argv[2]."`";
359     $settings['ident'] = $username;
360     $ret = $addserv['conn']->addZNC($argv[2], $password, $settings, $add_settings['servers'], $add_settings['modules'], $add_settings['other']);
361     if($ret) {
362         echo "Added user ".$argv[2]." to Server ".$addserv['name'].".\n";
363         echo "  Server Host: ".$addserv['public']."  Port: ".$addserv['port']."  SSL Port: ".$addserv['sslport']."\n";
364         echo "  Password: ".$password."\n";
365         echo "[mIRC]\n";
366         echo " /server -a ".$addserv['public']." -p ".$addserv['port']." -g ".$add_settings['mirccmds']['groupname']." -w ".$argv[2].":".$password." -d ".$add_settings['mirccmds']['groupname']."\n";
367         foreach($add_settings['mirccmds']['hosts'] AS $host) {
368             echo " /AS addmask *@*.".$host."\n";
369         }
370         echo " /server -m ".$add_settings['mirccmds']['groupname']."\n";
371         echo"/log\n";
372         foreach($add_settings["channel"] AS $channel) {
373             $addserv['conn']->addChan($argv[2], $channel);
374         }
375     } else
376         error("Error while adding user.");
377 }
378
379 //SUBCOMMAND: resetpass
380 function zncadmin_resetpass() {
381     global $argv, $zncservers, $force;
382     $username = strtolower($argv[2]);
383     if(!$username) {
384         error("missing username");
385         return;
386     }
387     $delusers = array();
388     foreach($zncservers as $zncserver) {
389         if($argv[3] && (strtolower($argv[3]) != strtolower($zncserver['name']))) continue;
390         if($username == strtolower($zncserver['auser'])) continue;
391         $zncserver['conn'] = new ZNCServer($zncserver['host'], $zncserver['port'], (isset($zncserver['version']) ? $zncserver['version'] : NULL));
392         $zncserver['conn']->login($zncserver['auser'], $zncserver['apass']);
393         foreach($zncserver['conn']->getUserList() as $user) {
394             if(strtolower($user['user']) == $username) {
395                 $delusers[] = array("server" => $zncserver, "user" => $user);
396             }
397         }
398     }
399     if(count($delusers) > 1) {
400         error($argv[2]." exists on multiple servers! please add the server name the user, the password should be resetted, is on.");
401         echo"Found User on following Servers:\n";
402         foreach($delusers as $server) {
403             echo "\002".$server['server']['name']."\002  Server: ".$server['user']['server']."  Nick: ".$server['user']['nick']."  Clients: ".$server['user']['clients']."\n";
404         }
405     } else if(count($delusers) == 0) {
406         error("Couldn't find an user called \002".$argv[2]."\002.");
407     } else if($delusers[0]['server']['protected'] && !$force) {
408         error("Access denied\n");
409     } else {
410         $deluser = $delusers[0];
411         $password = generate_password();
412         $deluser['server']['conn']->editZNC($deluser['user']['user'], $password);
413         echo "Changed password of \002".$deluser['user']['user']."\002 on Server ".$deluser['server']['name']." to \002".$password."\002\n";
414         echo"/log\n";
415     }
416 }
417
418 //SUBCOMMAND: simul
419 function zncadmin_simul() {
420     global $argv, $zncservers, $force;
421     $username = strtolower($argv[2]);
422     $server = strtolower($argv[3]);
423     $raw = $argv[4];
424     if(!$username) {
425         error("missing username");
426         return;
427     }
428     if($server) {
429         $found = false;
430         foreach($zncservers as $zncserver) {
431             if(strtolower($server) == strtolower($zncserver['name'])) {
432                 $found = true;
433                 break;
434             }
435         }
436         if(!$found) {
437             $raw = $argv[3]." ".$raw;
438             $server = null;
439         }
440     }
441     if(!$raw) {
442         error("missing raw");
443         return;
444     }
445     $delusers = array();
446     foreach($zncservers as $zncserver) {
447         if($server && (strtolower($server) != strtolower($zncserver['name']))) continue;
448         if($username == strtolower($zncserver['auser'])) continue;
449         $zncserver['conn'] = new ZNCServer($zncserver['host'], $zncserver['port'], (isset($zncserver['version']) ? $zncserver['version'] : NULL));
450         $zncserver['conn']->login($zncserver['auser'], $zncserver['apass']);
451         foreach($zncserver['conn']->getUserList() as $user) {
452             if(strtolower($user['user']) == $username) {
453                 $delusers[] = array("server" => $zncserver, "user" => $user);
454             }
455         }
456     }
457     if(count($delusers) > 1) {
458         error($argv[2]." exists on multiple servers! please add the server name the user should be simuled on.");
459         echo"Found User on following Servers:\n";
460         foreach($delusers as $server) {
461             echo "\002".$server['server']['name']."\002  Server: ".$server['user']['server']."  Nick: ".$server['user']['nick']."  Clients: ".$server['user']['clients']."\n";
462         }
463     } else if(count($delusers) == 0) {
464         error("Couldn't find an user called \002".$argv[2]."\002.");
465     } else if($delusers[0]['server']['protected'] && !$force) {
466         error("Access denied\n");
467     } else {
468         $deluser = $delusers[0];
469         $ret = $deluser['server']['conn']->simulZNC($deluser['user']['user'], $raw);
470         if($ret == ERR_MODULE_NOT_FOUND) {
471             error("send_raw module is not installed or not activated for user ".$deluser['server']['auser']." on ".$deluser['server']['name']);
472         } else {
473             echo "Simuled \002".$deluser['user']['user']."\002 on Server ".$deluser['server']['name'].": ".$raw."\n";
474             echo"/log\n";
475         }
476     }
477 }
478
479 //SUBCOMMAND: block
480 function zncadmin_block() {
481     global $argv, $zncservers, $force;
482     $username = strtolower($argv[2]);
483     $server = strtolower($argv[3]);
484     if(!$username) {
485         error("missing username");
486         return;
487     }
488     $delusers = array();
489     foreach($zncservers as $zncserver) {
490         if($server && (strtolower($server) != strtolower($zncserver['name']))) continue;
491         if($username == strtolower($zncserver['auser'])) continue;
492         $zncserver['conn'] = new ZNCServer($zncserver['host'], $zncserver['port'], (isset($zncserver['version']) ? $zncserver['version'] : NULL));
493         $zncserver['conn']->login($zncserver['auser'], $zncserver['apass']);
494         foreach($zncserver['conn']->getUserList() as $user) {
495             if(strtolower($user['user']) == $username) {
496                 $delusers[] = array("server" => $zncserver, "user" => $user);
497             }
498         }
499     }
500     if(count($delusers) > 1) {
501         error($argv[2]." exists on multiple servers! please add the server name the user should be blocked on.");
502         echo"Found User on following Servers:\n";
503         foreach($delusers as $server) {
504             echo "\002".$server['server']['name']."\002  Server: ".$server['user']['server']."  Nick: ".$server['user']['nick']."  Clients: ".$server['user']['clients']."\n";
505         }
506     } else if(count($delusers) == 0) {
507         error("Couldn't find an user called \002".$argv[2]."\002.");
508     } else if($delusers[0]['server']['protected'] && !$force) {
509         error("Access denied\n");
510     } else {
511         $deluser = $delusers[0];
512         $ret = $deluser['server']['conn']->blockZNC($deluser['user']['user'], true);
513         if($ret == ERR_MODULE_NOT_FOUND) {
514             error("blockuser module is not installed or not activated on ".$deluser['server']['name']);
515         } else {
516             echo "Blocked \002".$deluser['user']['user']."\002 on Server ".$deluser['server']['name'].".\n";
517             echo"/log\n";
518         }
519     }
520 }
521
522 //SUBCOMMAND: unblock
523 function zncadmin_unblock() {
524     global $argv, $zncservers, $force;
525     $username = strtolower($argv[2]);
526     $server = strtolower($argv[3]);
527     if(!$username) {
528         error("missing username");
529         return;
530     }
531     $delusers = array();
532     foreach($zncservers as $zncserver) {
533         if($server && (strtolower($server) != strtolower($zncserver['name']))) continue;
534         if($username == strtolower($zncserver['auser'])) continue;
535         $zncserver['conn'] = new ZNCServer($zncserver['host'], $zncserver['port'], (isset($zncserver['version']) ? $zncserver['version'] : NULL));
536         $zncserver['conn']->login($zncserver['auser'], $zncserver['apass']);
537         foreach($zncserver['conn']->getUserList() as $user) {
538             if(strtolower($user['user']) == $username) {
539                 $delusers[] = array("server" => $zncserver, "user" => $user);
540             }
541         }
542     }
543     if(count($delusers) > 1) {
544         error($argv[2]." exists on multiple servers! please add the server name the user should be unblocked on.");
545         echo"Found User on following Servers:\n";
546         foreach($delusers as $server) {
547             echo "\002".$server['server']['name']."\002  Server: ".$server['user']['server']."  Nick: ".$server['user']['nick']."  Clients: ".$server['user']['clients']."\n";
548         }
549     } else if(count($delusers) == 0) {
550         error("Couldn't find an user called \002".$argv[2]."\002.");
551     } else if($delusers[0]['server']['protected'] && !$force) {
552         error("Access denied\n");
553     } else {
554         $deluser = $delusers[0];
555         $ret = $deluser['server']['conn']->blockZNC($deluser['user']['user'], false);
556         if($ret == ERR_MODULE_NOT_FOUND) {
557             error("blockuser module is not installed or not activated on ".$deluser['server']['name']);
558         } else {
559             echo "Unblocked \002".$deluser['user']['user']."\002 on Server ".$deluser['server']['name'].".\n";
560             echo"/log\n";
561         }
562     }
563 }
564
565 //SUBCOMMAND: stats
566 function zncadmin_stats() {
567     global $argv, $zncservers;
568     $table = new Table(6);
569     $table->add("Server", "Port / SSL Port", "Total ZNC's", "Connected (IRC)", "Online (User)", "Protected?");
570     $count = 0;
571     foreach($zncservers as $zncserver) {
572         $total = 0;
573         $connected = 0;
574         $online = 0;
575         $zncserver['conn'] = new ZNCServer($zncserver['host'], $zncserver['port'], (isset($zncserver['version']) ? $zncserver['version'] : NULL));
576         $zncserver['conn']->login($zncserver['auser'], $zncserver['apass']);
577         foreach($zncserver['conn']->getUserList() as $user) {
578             if($user['server'] != "-N/A-") $connected++;
579             if($user['clients'] > 0) $online++;
580             $total++;
581         }
582         $table->add($zncserver['name'], $zncserver['port'].($zncserver['sslport'] ? "/".$zncserver['sslport'] : ""), $total.($zncserver['maxznc'] ? "/".$zncserver['maxznc'] : ""), $connected, $online, ($zncserver['protected'] === true ? "X" : ""));
583         $count++;
584     }
585     if($count) {
586         foreach($table->end() as $line) {
587             echo$line."\n";
588         }
589     } else {
590         echo "No Servers configured...\n";
591     }
592 }
593
594 ?>