added recv_nick and P10_User
[PHP-P10.git] / Uplink / P10_Server.class.php
1 <?php
2 /********************************* PHP-P10 ******************************
3  *    P10 uplink class by pk910   (c)2011 pk910                         *
4  ************************************************************************
5  *                          Version 2 (OOP)                             *
6  *                                                                      *
7  * PHP-P10 is free software; you can redistribute it and/or modify      *
8  * it under the terms of the GNU General Public License as published by *
9  * the Free Software Foundation; either version 2 of the License, or    *
10  * (at your option) any later version.                                  *
11  *                                                                      *
12  * This program is distributed in the hope that it will be useful,      *
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
15  * GNU General Public License for more details.                         *
16  *                                                                      *
17  * You should have received a copy of the GNU General Public License    *
18  * along with PHP-P10; if not, write to the Free Software Foundation,   *
19  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.       *
20  *                                                                      *
21  ************************************************************************
22  * 
23  *  Uplink/P10_Server.class.php
24  *
25  * This class represents a IRC Server
26  *
27  ************************************************************************
28  * accessable methods:
29  *
30  * static P10_Server getServerByNum(String $numeric) 
31  *     searches and returns the Server with the provided Numeric
32  *
33  * __construct(String $name, String $numeric, P10_Server $parent_server, int $start_time, $link_time, $description)
34  *     *** nothing to say here ***
35  *
36  * void disconnectServer(bool $linked_only = false)
37  *     DISCONNECT EVENT (if $linked_only is true, only the Servers connected to the actual Server get disconnected.)
38  *
39  * String getNumeric()
40  *     returns the Numeric of the Server
41  *
42  * String getName()
43  *     returns the Name of the Server
44  *
45  * String getStartTime()
46  *     returns the startup time of the Server
47  *
48  * String getLinkTime()
49  *     returns the link time of the Server
50  *
51  * String getDescription()
52  *     returns the Description of the Server
53  *
54  * void addServer(P10_Server $server)
55  *     adds a Server to the server's "slave" list
56  *
57  * void delServer(P10_Server $server)
58  *     removes a Server to the server's "slave" list
59  */
60
61 class P10_Server {
62         private static $static_servers = array();
63         
64         public static getServerByNum($numeric) {
65                 if(array_key_exists($numeric, self::$static_servers)) {
66                         return self::$static_servers[$numeric];
67                 }
68                 return NULL;
69         }
70         
71         
72         private $name;
73         private $numeric;
74         private $parent_server;
75         private $start_time;
76         private $link_time;
77         private $description;
78         private $servers = array(); //all Servers connected to this Server
79         private $users = array(); //all Users connected to this Server
80         
81         public function __construct($name, $numeric, $parent_server, $start_time, $link_time, $description) {
82                 $this->name = $name;
83                 $this->numeric = $numeric;
84                 $this->parent_server = $parent_server;
85                 $this->start_time = $start_time;
86                 $this->link_time = $link_time;
87                 $this->description = $description;
88                 
89                 self::$static_servers[$numeric] = $this;
90         }
91         
92         public function disconnectServer($linked_only = false) {
93                 if(!$linked_only) {
94                         if($this->parent_server) {
95                                 $this->parent_server->delServer($this);
96                         }
97                         $this->disconnectUsers();
98                         unset(self::$static_servers[$this->numeric]);
99                 }
100                 foreach($this->servers as $server) {
101                         $server->disconnectServer();
102                 }
103         }
104         
105         public function disconnectUsers() {
106                 //disconnect all Users connected to the actual Server
107                 foreach($this->users as $user) {
108                         $user->quit("*.net *.split");
109                 }
110         }
111         
112         public function getNumeric() {
113                 return $this->numeric;
114         }
115         
116         public function getName() {
117                 return $this->name;
118         }
119         
120         public function getStartTime() {
121                 return $this->start_time;
122         }
123         
124         public function getLinkTime() {
125                 return $this->link_time;
126         }
127         
128         public function getDescription() {
129                 return $this->description;
130         }
131         
132         public function addServer($server) {
133                 $this->servers[$server->getNumeric()] = $server;
134         }
135         
136         public function delServer($server) {
137                 if(array_key_exists($server->getNumeric(), $this->servers)) {
138                         unset($this->servers[$server->getNumeric()]);
139                 } else {
140                         trigger_error("Tried to remove a Server, that does NOT exist.", E_USER_WARNING);
141                 }
142         }
143         
144         public function addUser($user) {
145                 $this->users[$user->getNumeric()] = $user;
146         }
147         
148         public function delUser($user) {
149                 if(array_key_exists($user->getNumeric(), $this->users)) {
150                         unset($this->users[$user->getNumeric()]);
151                 } else {
152                         trigger_error("Tried to remove a User, that does NOT exist.", E_USER_WARNING);
153                 }
154         }
155 }
156
157 ?>