kakserpom /
phpdaemon
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Connection often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Connection, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | class Connection extends ClientConnection |
||
| 15 | { |
||
| 16 | |||
| 17 | /** |
||
| 18 | * @var boolean |
||
| 19 | */ |
||
| 20 | public $use_encryption = false; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * @var boolean |
||
| 24 | */ |
||
| 25 | public $authorized; |
||
| 26 | |||
| 27 | /** |
||
| 28 | * @var integer |
||
| 29 | */ |
||
| 30 | public $lastId = 0; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * @var XMPPRoster |
||
| 34 | */ |
||
| 35 | public $roster; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * @var XMLStream |
||
| 39 | */ |
||
| 40 | public $xml; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * @var string |
||
| 44 | */ |
||
| 45 | public $fulljid; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * @var integer|string Timer ID |
||
| 49 | */ |
||
| 50 | public $keepaliveTimer; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Get next ID |
||
| 54 | * @return string |
||
| 55 | */ |
||
| 56 | public function getId() |
||
| 57 | { |
||
| 58 | $id = ++$this->lastId; |
||
| 59 | return dechex($id); |
||
| 60 | } |
||
| 61 | |||
| 62 | /** |
||
| 63 | * Called when the connection is handshaked (at low-level), and peer is ready to recv. data |
||
| 64 | * @return void |
||
| 65 | */ |
||
| 66 | public function onReady() |
||
| 67 | { |
||
| 68 | $this->createXMLStream(); |
||
| 69 | $this->startXMLStream(); |
||
| 70 | $this->keepaliveTimer = setTimeout(function ($timer) { |
||
|
|
|||
| 71 | $this->ping(); |
||
| 72 | }, 1e6 * 30); |
||
| 73 | } |
||
| 74 | |||
| 75 | /** |
||
| 76 | * Called when session finishes |
||
| 77 | * @return void |
||
| 78 | */ |
||
| 79 | public function onFinish() |
||
| 80 | { |
||
| 81 | parent::onFinish(); |
||
| 82 | $this->event('disconnect'); |
||
| 83 | if (isset($this->xml)) { |
||
| 84 | $this->xml->finish(); |
||
| 85 | } |
||
| 86 | unset($this->roster); |
||
| 87 | if ($this->keepaliveTimer) { |
||
| 88 | Timer::remove($this->keepaliveTimer); |
||
| 89 | } |
||
| 90 | } |
||
| 91 | |||
| 92 | /** |
||
| 93 | * @TODO DESCR |
||
| 94 | * @param string $s |
||
| 95 | */ |
||
| 96 | public function sendXML($s) |
||
| 97 | { |
||
| 98 | //Daemon::log(Debug::dump(['send', $s])); |
||
| 99 | $this->write($s); |
||
| 100 | } |
||
| 101 | |||
| 102 | /** |
||
| 103 | * @TODO DESCR |
||
| 104 | */ |
||
| 105 | public function startXMLStream() |
||
| 106 | { |
||
| 107 | $this->sendXML( |
||
| 108 | '<?xml version="1.0"?>' . |
||
| 109 | '<stream:stream xmlns:stream="http://etherx.jabber.org/streams" version="1.0" xmlns="jabber:client" to="' . $this->host . '" xml:lang="en" xmlns:xml="http://www.w3.org/XML/1998/namespace">' |
||
| 110 | ); |
||
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * @TODO DESCR |
||
| 115 | * @param string $xml |
||
| 116 | * @param callable $cb |
||
| 117 | * @callback $cb ( ) |
||
| 118 | * @return boolean |
||
| 119 | */ |
||
| 120 | View Code Duplication | public function iqSet($xml, $cb) |
|
| 121 | { |
||
| 122 | if (!isset($this->xml)) { |
||
| 123 | return false; |
||
| 124 | } |
||
| 125 | $id = $this->getId(); |
||
| 126 | $this->xml->addIdHandler($id, $cb); |
||
| 127 | $this->sendXML('<iq xmlns="jabber:client" type="set" id="' . $id . '">' . $xml . '</iq>'); |
||
| 128 | return true; |
||
| 129 | } |
||
| 130 | |||
| 131 | /** |
||
| 132 | * @TODO DESCR |
||
| 133 | * @param string $to |
||
| 134 | * @param string $xml |
||
| 135 | * @param callable $cb |
||
| 136 | * @callback $cb ( ) |
||
| 137 | * @return boolean |
||
| 138 | */ |
||
| 139 | View Code Duplication | public function iqSetTo($to, $xml, $cb) |
|
| 140 | { |
||
| 141 | if (!isset($this->xml)) { |
||
| 142 | return false; |
||
| 143 | } |
||
| 144 | $id = $this->getId(); |
||
| 145 | $this->xml->addIdHandler($id, $cb); |
||
| 146 | $this->sendXML('<iq xmlns="jabber:client" type="set" id="' . $id . '" to="' . htmlspecialchars($to) . '">' . $xml . '</iq>'); |
||
| 147 | return true; |
||
| 148 | } |
||
| 149 | |||
| 150 | /** |
||
| 151 | * @TODO DESCR |
||
| 152 | * @param string $xml |
||
| 153 | * @param callable $cb |
||
| 154 | * @callback $cb ( ) |
||
| 155 | * @return boolean |
||
| 156 | */ |
||
| 157 | View Code Duplication | public function iqGet($xml, $cb) |
|
| 158 | { |
||
| 159 | if (!isset($this->xml)) { |
||
| 160 | return false; |
||
| 161 | } |
||
| 162 | $id = $this->getId(); |
||
| 163 | $this->xml->addIdHandler($id, $cb); |
||
| 164 | $this->sendXML('<iq xmlns="jabber:client" type="get" id="' . $id . '">' . $xml . '</iq>'); |
||
| 165 | return true; |
||
| 166 | } |
||
| 167 | |||
| 168 | /** |
||
| 169 | * @TODO DESCR |
||
| 170 | * @param string $to |
||
| 171 | * @param string $xml |
||
| 172 | * @param callable $cb |
||
| 173 | * @callback $cb ( ) |
||
| 174 | * @return boolean |
||
| 175 | */ |
||
| 176 | View Code Duplication | public function iqGetTo($to, $xml, $cb) |
|
| 177 | { |
||
| 178 | if (!isset($this->xml)) { |
||
| 179 | return false; |
||
| 180 | } |
||
| 181 | $id = $this->getId(); |
||
| 182 | $this->xml->addIdHandler($id, $cb); |
||
| 183 | $this->sendXML('<iq xmlns="jabber:client" type="get" id="' . $id . '" to="' . htmlspecialchars($to) . '">' . $xml . '</iq>'); |
||
| 184 | return true; |
||
| 185 | } |
||
| 186 | |||
| 187 | /** |
||
| 188 | * @TODO DESCR |
||
| 189 | * @param string $to |
||
| 190 | * @param callable $cb |
||
| 191 | * @callback $cb ( ) |
||
| 192 | * @return boolean |
||
| 193 | */ |
||
| 194 | public function ping($to = null, $cb = null) |
||
| 195 | { |
||
| 196 | if (!isset($this->xml)) { |
||
| 197 | return false; |
||
| 198 | } |
||
| 199 | if ($to === null) { |
||
| 200 | $to = $this->host; |
||
| 201 | } |
||
| 202 | //Daemon::log('Sending ping to '.$to); |
||
| 203 | return $this->iqGetTo($to, '<ping xmlns="urn:xmpp:ping"/>', $cb); |
||
| 204 | } |
||
| 205 | |||
| 206 | /** |
||
| 207 | * @TODO DESCR |
||
| 208 | * @param string $ns |
||
| 209 | * @param callable $cb |
||
| 210 | * @callback $cb ( ) |
||
| 211 | * @return boolean |
||
| 212 | */ |
||
| 213 | public function queryGet($ns, $cb) |
||
| 214 | { |
||
| 215 | return $this->iqGet('<query xmlns="' . $ns . '" />', $cb); |
||
| 216 | } |
||
| 217 | |||
| 218 | /** |
||
| 219 | * @TODO DESCR |
||
| 220 | * @param string $ns |
||
| 221 | * @param string $xml |
||
| 222 | * @param callable $cb |
||
| 223 | * @callback $cb ( ) |
||
| 224 | * @return boolean |
||
| 225 | */ |
||
| 226 | public function querySet($ns, $xml, $cb) |
||
| 227 | { |
||
| 228 | return $this->iqSet('<query xmlns="' . $ns . '">' . $xml . '</query>', $cb); |
||
| 229 | } |
||
| 230 | |||
| 231 | /** |
||
| 232 | * @TODO DESCR |
||
| 233 | * @param string $to |
||
| 234 | * @param string $ns |
||
| 235 | * @param string $xml |
||
| 236 | * @param callable $cb |
||
| 237 | * @callback $cb ( ) |
||
| 238 | * @return boolean |
||
| 239 | */ |
||
| 240 | public function querySetTo($to, $ns, $xml, $cb) |
||
| 241 | { |
||
| 242 | return $this->iqSetTo($to, '<query xmlns="' . $ns . '">' . $xml . '</query>', $cb); |
||
| 243 | } |
||
| 244 | |||
| 245 | /** |
||
| 246 | * @TODO DESCR |
||
| 247 | */ |
||
| 248 | public function createXMLStream() |
||
| 249 | { |
||
| 250 | $this->xml = new XMLStream; |
||
| 251 | $this->xml->setDefaultNS('jabber:client'); |
||
| 252 | $this->xml->addXPathHandler('{http://etherx.jabber.org/streams}features', function ($xml) { |
||
| 253 | /** @var XMLStream $xml */ |
||
| 254 | if ($xml->hasSub('starttls') and $this->use_encryption) { |
||
| 255 | $this->sendXML("<starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'><required /></starttls>"); |
||
| 256 | } elseif ($xml->hasSub('bind') and $this->authorized) { |
||
| 257 | $id = $this->getId(); |
||
| 258 | $this->iqSet('<bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"><resource>' . $this->path . '</resource></bind>', |
||
| 259 | function ($xml) { |
||
| 260 | if ($xml->attrs['type'] === 'result') { |
||
| 261 | $this->fulljid = $xml->sub('bind')->sub('jid')->data; |
||
| 262 | $jidarray = explode('/', $this->fulljid); |
||
| 263 | $this->jid = $jidarray[0]; |
||
| 264 | } |
||
| 265 | $this->iqSet('<session xmlns="urn:ietf:params:xml:ns:xmpp-session" />', function ($xml) { |
||
| 266 | $this->roster = new XMPPRoster($this); |
||
| 267 | if ($this->onConnected) { |
||
| 268 | $this->connected = true; |
||
| 269 | $this->onConnected->executeAll($this); |
||
| 270 | $this->onConnected = null; |
||
| 271 | } |
||
| 272 | $this->event('connected'); |
||
| 273 | }); |
||
| 274 | }); |
||
| 275 | } else { |
||
| 276 | if (mb_orig_strlen($this->password)) { |
||
| 277 | $this->sendXML("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='PLAIN'>" . base64_encode("\x00" . $this->user . "\x00" . $this->password) . "</auth>"); |
||
| 278 | } else { |
||
| 279 | $this->sendXML("<auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='ANONYMOUS'/>"); |
||
| 280 | } |
||
| 281 | } |
||
| 282 | }); |
||
| 283 | $this->xml->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-sasl}success', function ($xml) { |
||
| 284 | $this->authorized = true; |
||
| 285 | $this->xml->finish(); |
||
| 286 | $this->createXMLStream(); |
||
| 287 | $this->startXMLStream(); |
||
| 288 | }); |
||
| 289 | $this->xml->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-sasl}failure', function ($xml) { |
||
| 290 | if ($this->onConnected) { |
||
| 291 | $this->connected = false; |
||
| 292 | $func = $this->onConnected; |
||
| 293 | $func($this); |
||
| 294 | $this->onConnected = null; |
||
| 295 | } |
||
| 296 | $this->finish(); |
||
| 297 | }); |
||
| 298 | $this->xml->addXPathHandler('{urn:ietf:params:xml:ns:xmpp-tls}proceed', function ($xml) { |
||
| 299 | Daemon::log("XMPPClient: TLS not supported."); |
||
| 300 | }); |
||
| 301 | $this->xml->addXPathHandler('{jabber:client}message', function ($xml) { |
||
| 302 | if (isset($xml->attrs['type'])) { |
||
| 303 | $payload['type'] = $xml->attrs['type']; |
||
| 304 | } else { |
||
| 305 | $payload['type'] = 'chat'; |
||
| 306 | } |
||
| 307 | $payload['xml'] = $xml; |
||
| 308 | $payload['from'] = $xml->attrs['from']; |
||
| 309 | if ($xml->hasSub('body')) { |
||
| 310 | $payload['body'] = $xml->sub('body')->data; |
||
| 311 | $this->event('message', $payload); |
||
| 312 | } |
||
| 313 | }); |
||
| 314 | } |
||
| 315 | |||
| 316 | /** |
||
| 317 | * Send XMPP Message |
||
| 318 | * @param string $to |
||
| 319 | * @param string $body |
||
| 320 | * @param string $type |
||
| 321 | * @param string $subject |
||
| 322 | */ |
||
| 323 | public function message($to, $body, $type = 'chat', $subject = null, $payload = null) |
||
| 324 | { |
||
| 325 | if ($type === null) { |
||
| 326 | $type = 'chat'; |
||
| 327 | } |
||
| 328 | |||
| 329 | $to = htmlspecialchars($to); |
||
| 330 | $body = htmlspecialchars($body); |
||
| 331 | $subject = htmlspecialchars($subject); |
||
| 332 | |||
| 333 | $out = '<message from="' . $this->fulljid . '" to="' . $to . '" type="' . $type . '">'; |
||
| 334 | if ($subject) { |
||
| 335 | $out .= '<subject>' . $subject . '</subject>'; |
||
| 336 | } |
||
| 337 | $out .= '<body>' . $body . '</body>'; |
||
| 338 | if ($payload) { |
||
| 339 | $out .= $payload; |
||
| 340 | } |
||
| 341 | $out .= "</message>"; |
||
| 342 | |||
| 343 | $this->sendXML($out); |
||
| 344 | } |
||
| 345 | |||
| 346 | /** |
||
| 347 | * Set Presence |
||
| 348 | * @param string $status |
||
| 349 | * @param string $show |
||
| 350 | * @param string $to |
||
| 351 | * @param string $type |
||
| 352 | * @param integer $priority |
||
| 353 | */ |
||
| 354 | public function presence($status = null, $show = 'available', $to = null, $type = 'available', $priority = 0) |
||
| 394 | |||
| 395 | /** |
||
| 396 | * @TODO DESCR |
||
| 397 | * @param string $jid |
||
| 398 | * @param callable $cb |
||
| 399 | * @callback $cb ( ) |
||
| 400 | */ |
||
| 401 | public function getVCard($jid, $cb) |
||
| 402 | { |
||
| 403 | $id = $this->getId(); |
||
| 404 | $this->xml->addIdHandler($id, function ($xml) use ($cb) { |
||
| 405 | $vcard = []; |
||
| 406 | $vcardXML = $xml->sub('vcard'); |
||
| 407 | foreach ($vcardXML->subs as $sub) { |
||
| 408 | if ($sub->subs) { |
||
| 409 | $vcard[$sub->name] = []; |
||
| 429 | |||
| 430 | /** |
||
| 431 | * Called when new data received |
||
| 432 | * @return void |
||
| 433 | */ |
||
| 434 | public function onRead() |
||
| 441 | } |
||
| 442 |
Loading history...
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.