PEAR2_Services_LinkbackPEAR2_Services_Linkback-0.2.1/src/PEAR2/Services/Linkback/Response/Ping.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
<?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\Response;
use PEAR2\Services\Linkback\States as States;
use HTTP_Request2_Response;

/**
 * Response to a client ping() request.
 *
 * @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 Ping
{
    /**
     * (debug) message that we get on a successful linkback request,
     * or error message in case of an error.
     *
     * @var string
     */
    protected $message;

    /**
     * Fault code that gets set when linkback fails.
     * If the response is not an error, the code is null.
     *
     * @var integer
     */
    protected $code;

    /**
     * HTTP response object, if debugging is enabled in the client
     *
     * @var HTTP_Request2_Response
     */
    protected $response;


    /**
     * Create new instance and set class variables.
     *
     * @param string  $message Response message
     * @param integer $code    Error/status code. NULL for no error.
     */
    public function __construct($message = null, $code = null)
    {
        $this->message = $message;
        $this->code    = $code;
    }

    /**
     * Set a pingback HTTP response object and sets the internal variables.
     *
     * @param object  $res   Pingback HTTP response object
     * @param boolean $debug If debugging is enabled. If true, the response is
     *                       kept in this object
     *
     * @return void
     */
    public function loadFromPingbackResponse(
        HTTP_Request2_Response $res, $debug = false
    ) {
        if ($debug) {
            $this->setResponse($res);
        }

        if (intval($res->getStatus() / 100) != 2) {
            $this->code    = States::HTTP_STATUS;
            $this->message = 'Pingback answer HTTP status code is not 2xx';
            return;
        }

        $types = explode(';', $res->getHeader('content-type'));
        if (count($types) < 1 || trim($types[0]) != 'text/xml') {
            $this->code    = States::CONTENT_TYPE;
            $this->message = 'Pingback answer HTTP content type is not text/xml';
            return;
        }
        $params = xmlrpc_decode($res->getBody());
        if ($params === null) {
            $this->code    = States::MESSAGE_INVALID;
            $this->message = 'Pingback answer is invalid';
            return;
        } else if (is_array($params) && xmlrpc_is_fault($params)) {
            $this->code    = $params['faultCode'];
            $this->message = $params['faultString'];
            return;
        }

        $this->code = null;
        if (is_array($params)) {
            $this->message = $params[0];
        } else {
            //single string
            $this->message = $params;
        }
    }

    /**
     * Uses a webmention HTTP response object to set the internal variables.
     *
     * @param object  $res   Webmention HTTP response object
     * @param boolean $debug If debugging is enabled. If true, the response is
     *                       kept in this object
     *
     * @return void
     */
    public function loadFromWebmentionResponse(
        HTTP_Request2_Response $res, $debug = false
    ) {
        if ($debug) {
            $this->setResponse($res);
        }

        if (intval($res->getStatus() / 100) != 2) {
            $this->code    = States::HTTP_STATUS;
            $this->message = 'Webmention answer HTTP status code is not 2xx but '
                . $res->getStatus();
        } else {
            //no error, all fine
            $this->code = null;
            $this->message = null;
        }
        if (!$res->getHeader('content-type') == 'application/json') {
            return;
        }

        $json = json_decode($res->getBody());
        if ($json === false && $json === null) {
            //broken json
            return;
        }

        if (isset($json->error)) {
            switch ($json->error) {
            case 'source_not_found':
                $this->code = States::SOURCE_URI_NOT_FOUND;
                break;
            case 'target_not_found':
                $this->code = States::TARGET_URI_NOT_FOUND;
                break;
            case 'target_not_supported':
                $this->code = States::PINGBACK_UNSUPPORTED;
                break;
            case 'no_link_found':
                $this->code = States::NO_LINK_IN_SOURCE;
                break;
            case 'already_registered':
                $this->code = States::ALREADY_REGISTERED;
                break;
            }

            if (isset($json->error_description)) {
                $this->message = (string) $json->error_description;
            }
        } else {
            //no error
            if (isset($json->result)) {
                $this->message = (string) $json->result;
            }
        }
    }

    /**
     * Tells you if a response is an error or not
     *
     * @return boolean True if the request failed
     */
    public function isError()
    {
        return $this->code !== null;
    }

    /**
     * Returns the XML-RPC fault code
     *
     * @return integer Error code. NULL when the response is not an error.
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * Returns the XML-RPC debug or error message.
     *
     * @return string Message
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Returns the HTTP response if set
     *
     * @return HTTP_Request2_Response Response object
     */
    public function getResponse()
    {
        return $this->response;
    }

    /**
     * Sets the HTTP response object without any parsing.
     * Useful for debugging errors of non-pingback responses.
     *
     * @param HTTP_Request2_Response $res Response object
     *
     * @return void
     *
     * @see setPingbackResponse()
     */
    public function setResponse(HTTP_Request2_Response $res)
    {
        $this->response = $res;
    }
}

?>
EOF