PEAR2_Services_LinkbackPEAR2_Services_Linkback-0.2.1/src/PEAR2/Services/Linkback/Server.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
<?php
/**
 * This file is part of the PEAR2\Services\Linkback package.
 *
 * PHP version 5
 *
 * @category Services
 * @package  PEAR2\Services\Linkback
 * @author   Christian Weiske <cweiske@php.net>
 * @license  http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link     http://pear2.php.net/package/Services_Linkback
 */
namespace PEAR2\Services\Linkback;
use HTTP_Request2_Response;

/**
 * Linkback (pingback + webmention) server implementation.
 *
 * The important behavior is controlled by callbacks that may be registered
 * with addCallback() or setCallbacks():
 * - verify that the target exists
 * - fetch source
 * - verify that source links to target
 * - store linkback
 *
 * After adding your callbacks, simply call run().
 *
 * @fixme Add source context fetch code for easier integration
 *
 * @category Services
 * @package  PEAR2\Services\Linkback
 * @author   Christian Weiske <cweiske@php.net>
 * @license  http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link     http://pear2.php.net/package/Services_Linkback
 */
class Server
{
    /**
     * The file the POST request date are read from
     *
     * @var string
     */
    protected $inputFile = 'php://input';

    /**
     * Responder used to send out header and XML data
     *
     * @var Server\Responder\Pingback
     */
    protected $pingbackResponder;

    /**
     * Responder used to send out webmention responses
     *
     * @var Server\Responder\Webmention
     */
    protected $webmentionResponder;

    /**
     * Registered callbacks of all types.
     *
     * @var array
     */
    protected $callbacks = array();

    /**
     * URL validation helper
     *
     * @var Url
     */
    protected $urlValidator;

    protected $unknownRequest = <<<XML
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
  <title>Linkback error</title>
 </head>
 <body>
  <h1>Linkback error</h1>
  <p>Cannot understand linkback request.</p>
  <p>Expected input:</p>
  <ul>
   <li>Pingback: XML POST data</li>
   <li>Webmention: <tt>source</tt> and <tt>target</tt> POST parameters</li>
  </ul>
 </body>
</html>

XML;



    /**
     * Registers default callbacks
     */
    public function __construct()
    {
        $this->urlValidator = new Url();
        $this->addCallback(new Server\Callback\FetchSource());
        $this->addCallback(new Server\Callback\LinkExists());
    }

    /**
     * Run the linkback server and respond to the request.
     *
     * @return void
     */
    public function run()
    {
        $post = file_get_contents($this->getInputFile());
        if (substr($post, 0, 5) == '<?xml') {
            //pingback
            $xs = xmlrpc_server_create();
            xmlrpc_server_register_method(
                $xs, 'pingback.ping', array($this, 'handlePingbackPing')
            );
            $out = xmlrpc_server_call_method($xs, $post, null);

            $resp = $this->getPingbackResponder();
            $resp->sendHeader('HTTP/1.0 200 OK');
            $resp->sendXml($out);

        } else if (isset($_POST['source']) && isset($_POST['target'])) {
            //webmention
            $res = $this->handleRequest($_POST['source'], $_POST['target']);
            $resp = $this->getWebmentionResponder();
            $resp->send($res);

        } else {
            //unknown
            $resp = $this->getPingbackResponder();
            $resp->sendHeader('HTTP/1.0 400 Bad Request');
            $resp->sendHeader('Content-Type: text/html');
            $resp->sendOutput($this->unknownRequest);
        }
    }

    /**
     * Handles the pingback.ping method request.
     * We intentionally use the same parameters as required by
     * xmlrpc_server_register_method().
     *
     * @param string $method Name of XML-RPC method (pingback.ping)
     * @param array  $params Array of method parameters
     *
     * @return array Array of return values ('faultCode' and 'faultString'),
     *               or single string if all is fine
     */
    public function handlePingbackPing($method, $params)
    {
        if (count($params) < 2) {
            return array(
                'faultCode'   => States::PARAMETER_MISSING,
                'faultString' => '2 parameters required'
            );
        }
        $sourceUri = $params[0];
        $targetUri = $params[1];

        return $this->handleRequest($sourceUri, $targetUri);
    }

    /**
     * Handle a request with source and target URI
     *
     * @param string $sourceUri URL linking to $targetUri
     * @param string $targetUri Target URI that got linked to
     *
     * @return mixed Array of return values ('faultCode' and 'faultString'),
     *               or single string if all is fine
     */
    protected function handleRequest($sourceUri, $targetUri)
    {
        if (!$this->urlValidator->validate($sourceUri)) {
            return array(
                'faultCode'   => States::INVALID_URI,
                'faultString' => 'Source URI invalid (not absolute, not http/https)'
            );
        }
        if (!$this->urlValidator->validate($targetUri)) {
            return array(
                'faultCode'   => States::INVALID_URI,
                'faultString' => 'Target URI invalid (not absolute, not http/https)'
            );
        }

        try {
            if (!$this->verifyTargetExists($targetUri)) {
                return array(
                    'faultCode'   => States::TARGET_URI_NOT_FOUND,
                    'faultString' => 'Target URI does not exist'
                );
            }

            $res = $this->fetchSource($sourceUri);
            if (!$res instanceof HTTP_Request2_Response) {
                //programming error: callback did not return response object
                return array(
                    'faultCode'   => States::SOURCE_NOT_LOADED,
                    'faultString' => 'Source document not loaded'
                );
            }
            if (intval($res->getStatus() / 100) != 2) {
                //some error fetching the url
                return array(
                    'faultCode'   => States::SOURCE_URI_NOT_FOUND,
                    'faultString' => 'Source URI does not exist'
                );
            }

            $exists = $this->verifyLinkExists(
                $targetUri, $sourceUri, $res->getBody(), $res
            );
            if (!$exists) {
                return array(
                    'faultCode'   => States::NO_LINK_IN_SOURCE,
                    'faultString' => 'Source URI does not contain a link to the'
                    . ' target URI, and thus cannot be used as a source'
                );
            }

            $this->storeLinkback($targetUri, $sourceUri, $res->getBody(), $res);
        } catch (\Exception $e) {
            return array(
                'faultCode'   => $e->getCode(),
                'faultString' => $e->getMessage()
            );
        }

        return 'Pingback received and processed';
    }

    /**
     * Set a responder object
     *
     * @param object $responder Server XML responder object
     *
     * @return self
     */
    public function setPingbackResponder(Server\Responder\Pingback $responder)
    {
        $this->pingbackResponder = $responder;
        return $this;
    }

    /**
     * Get (and perhaps create) responder object.
     *
     * @return Server\Responder\Pingback Responder object
     */
    public function getPingbackResponder()
    {
        if ($this->pingbackResponder === null) {
            $this->pingbackResponder = new Server\Responder\Pingback();
        }
        return $this->pingbackResponder;
    }

    /**
     * Set a webmention responder object
     *
     * @param object $responder Server webmention responder object
     *
     * @return self
     */
    public function setWebmentionResponder(Server\Responder\Webmention $responder)
    {
        $this->webmentionResponder = $responder;
        return $this;
    }

    /**
     * Get (and perhaps create) responder object.
     *
     * @return Server\Responder\Webmention Responder object
     */
    public function getWebmentionResponder()
    {
        if ($this->webmentionResponder === null) {
            $this->webmentionResponder = new Server\Responder\Webmention();
        }
        return $this->webmentionResponder;
    }

    /**
     * Modify the path of the file the POST data are read from
     *
     * @param string $inputFile Full path to input file
     *
     * @return self
     */
    public function setInputFile($inputFile)
    {
        $this->inputFile = $inputFile;
        return $this;
    }

    /**
     * Return the path of the file the POST data are read from
     *
     * @return string Path of POST input data file
     */
    public function getInputFile()
    {
        return $this->inputFile;
    }

    /**
     * Set an array of callback objects
     *
     * @param array $callbacks Array of objects that implement at least one
     *                         of the interfaces
     *
     * @return self
     *
     * @throws Exception When one of the callback objects is invalid.
     */
    public function setCallbacks(array $callbacks)
    {
        $this->verifyCallbacks($callbacks);
        $this->callbacks = $callbacks;
        return $this;
    }

    /**
     * Add a single callback object
     *
     * @param object $callback Object that implements at least one
     *                         of the interfaces
     *
     * @return self
     *
     * @throws Exception When one of the callback objects is invalid.
     */
    public function addCallback($callback)
    {
        $this->verifyCallbacks(array($callback));
        $this->callbacks[] = $callback;
        return $this;
    }

    /**
     * Validate callback objects.
     * Checks that the callbacks implement at least one of the server callback
     * interfaces.
     *
     * @param array $callbacks Array of callback objects
     *
     * @return void
     *
     * @throws Exception When one of the callback objects is invalid.
     */
    public function verifyCallbacks(array $callbacks)
    {
        foreach ($callbacks as $callback) {
            if (!$callback instanceof Server\Callback\ILink
                && !$callback instanceof Server\Callback\ISource
                && !$callback instanceof Server\Callback\IStorage
                && !$callback instanceof Server\Callback\ITarget
            ) {
                throw new Exception(
                    'Callback object needs to implement one of the'
                    . ' linkback server callback interfaces',
                    States::CALLBACK_INVALID
                );
            }
        }
    }

    /**
     * Fetch the source URL and return it.
     * The response object of the first callback providing one will be returned.
     *
     * @param string $url URL to fetch
     *
     * @return HTTP_Request2_Response Response object
     *
     * @throws Exception When something fatally fails
     */
    protected function fetchSource($url)
    {
        $finalres = null;
        foreach ($this->callbacks as $callback) {
            if (!$callback instanceof Server\Callback\ISource) {
                continue;
            }

            $res = $callback->fetchSource($url);
            if ($res instanceof HTTP_Request2_Response) {
                $finalres = $res;;
            }
        }
        return $finalres;
    }

    /**
     * Verifies that the given target URI exists in our system.
     *
     * @param string $target Target URI that got linked to
     *
     * @return boolean True if the target URI exists, false if not
     *
     * @throws Exception When something fatally fails
     */
    public function verifyTargetExists($target)
    {
        $exists = true;
        foreach ($this->callbacks as $callback) {
            if (!$callback instanceof Server\Callback\ITarget) {
                continue;
            }

            $exists &= $callback->verifyTargetExists($target);
        }

        return $exists;
    }

    /**
     * Verifies that a link from $source to $target exists.
     *
     * @param string $target     Target URI that should be linked in $source
     * @param string $source     Linkback source URI that should link to target
     * @param string $sourceBody Content of $source URI
     * @param object $res        HTTP response from fetching $source
     *
     * @return boolean True if $source links to $target
     *
     * @throws Exception When something fatally fails
     */
    public function verifyLinkExists(
        $target, $source, $sourceBody, HTTP_Request2_Response $res
    ) {
        $exists = false;
        foreach ($this->callbacks as $callback) {
            if (!$callback instanceof Server\Callback\ILink) {
                continue;
            }

            $exists |= $callback->verifyLinkExists(
                $target, $source, $sourceBody, $res
            );
        }

        return $exists;
    }

    /**
     * Stores the linkback somewhere
     *
     * @param string $target     Target URI that should be linked in $source
     * @param string $source     Linkback source URI that should link to target
     * @param string $sourceBody Content of $source URI
     * @param object $res        HTTP response from fetching $source
     *
     * @return void
     *
     * @throws Exception When storing the linkback fatally failed
     */
    protected function storeLinkback(
        $target, $source, $sourceBody, HTTP_Request2_Response $res
    ) {
        foreach ($this->callbacks as $callback) {
            if (!$callback instanceof Server\Callback\IStorage) {
                continue;
            }
            $callback->storeLinkback(
                $target, $source, $sourceBody, $res
            );
        }
    }
}

?>
EOF