summaryrefslogtreecommitdiff
path: root/tests/test_tools/simpletest/socket.php
blob: cfeed48a16dae470416e2df9dfac859e34e787cb (plain)
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
<?php
    /**
     *	base include file for SimpleTest
     *	@package	SimpleTest
     *	@subpackage	MockObjects
     *	@version	$Id: socket.php 1398 2006-09-08 19:31:03Z xue $
     */

    /**#@+
     * include SimpleTest files
     */
    require_once(dirname(__FILE__) . '/compatibility.php');
    /**#@-*/

    /**
     *    Stashes an error for later. Useful for constructors
     *    until PHP gets exceptions.
	 *    @package SimpleTest
	 *    @subpackage WebTester
     */
    class SimpleStickyError {
        protected $_error = 'Constructor not chained';

        /**
         *    Sets the error to empty.
         *    @access public
         */
        function SimpleStickyError() {
            $this->_clearError();
        }

        /**
         *    Test for an outstanding error.
         *    @return boolean           True if there is an error.
         *    @access public
         */
        function isError() {
            return ($this->_error != '');
        }

        /**
         *    Accessor for an outstanding error.
         *    @return string     Empty string if no error otherwise
         *                       the error message.
         *    @access public
         */
        function getError() {
            return $this->_error;
        }

        /**
         *    Sets the internal error.
         *    @param string       Error message to stash.
         *    @access protected
         */
        function _setError($error) {
            $this->_error = $error;
        }

        /**
         *    Resets the error state to no error.
         *    @access protected
         */
        function _clearError() {
            $this->_setError('');
        }
    }

    /**
     *    Wrapper for TCP/IP socket.
     *    @package SimpleTest
     *    @subpackage WebTester
     */
    class SimpleSocket extends SimpleStickyError {
        protected $_handle;
        protected $_is_open = false;
        protected $_sent = '';
        public $lock_size;

        /**
         *    Opens a socket for reading and writing.
         *    @param string $host          Hostname to send request to.
         *    @param integer $port         Port on remote machine to open.
         *    @param integer $timeout      Connection timeout in seconds.
         *    @param integer $block_size   Size of chunk to read.
         *    @access public
         */
        function SimpleSocket($host, $port, $timeout, $block_size = 255) {
            $this->SimpleStickyError();
            if (! ($this->_handle = $this->_openSocket($host, $port, $error_number, $error, $timeout))) {
                $this->_setError("Cannot open [$host:$port] with [$error] within [$timeout] seconds");
                return;
            }
            $this->_is_open = true;
            $this->_block_size = $block_size;
            SimpleTestCompatibility::setTimeout($this->_handle, $timeout);
        }

        /**
         *    Writes some data to the socket and saves alocal copy.
         *    @param string $message       String to send to socket.
         *    @return boolean              True if successful.
         *    @access public
         */
        function write($message) {
            if ($this->isError() || ! $this->isOpen()) {
                return false;
            }
            $count = fwrite($this->_handle, $message);
            if (! $count) {
                if ($count === false) {
                    $this->_setError('Cannot write to socket');
                    $this->close();
                }
                return false;
            }
            fflush($this->_handle);
            $this->_sent .= $message;
            return true;
        }

        /**
         *    Reads data from the socket. The error suppresion
         *    is a workaround for PHP4 always throwing a warning
         *    with a secure socket.
         *    @return integer/boolean           Incoming bytes. False
         *                                     on error.
         *    @access public
         */
        function read() {
            if ($this->isError() || ! $this->isOpen()) {
                return false;
            }
            $raw = @fread($this->_handle, $this->_block_size);
            if ($raw === false) {
                $this->_setError('Cannot read from socket');
                $this->close();
            }
            return $raw;
        }

        /**
         *    Accessor for socket open state.
         *    @return boolean           True if open.
         *    @access public
         */
        function isOpen() {
            return $this->_is_open;
        }

        /**
         *    Closes the socket preventing further reads.
         *    Cannot be reopened once closed.
         *    @return boolean           True if successful.
         *    @access public
         */
        function close() {
            $this->_is_open = false;
            return fclose($this->_handle);
        }

        /**
         *    Accessor for content so far.
         *    @return string        Bytes sent only.
         *    @access public
         */
        function getSent() {
            return $this->_sent;
        }

        /**
         *    Actually opens the low level socket.
         *    @param string $host          Host to connect to.
         *    @param integer $port         Port on host.
         *    @param integer $error_number Recipient of error code.
         *    @param string $error         Recipoent of error message.
         *    @param integer $timeout      Maximum time to wait for connection.
         *    @access protected
         */
        function _openSocket($host, $port, $error_number, $error, $timeout) {
            return @fsockopen($host, $port, $error_number, $error, $timeout);
        }
    }

    /**
     *    Wrapper for TCP/IP socket over TLS.
	 *    @package SimpleTest
	 *    @subpackage WebTester
     */
    class SimpleSecureSocket extends SimpleSocket {

        /**
         *    Opens a secure socket for reading and writing.
         *    @param string $host      Hostname to send request to.
         *    @param integer $port     Port on remote machine to open.
         *    @param integer $timeout  Connection timeout in seconds.
         *    @access public
         */
        function SimpleSecureSocket($host, $port, $timeout) {
            $this->SimpleSocket($host, $port, $timeout);
        }

        /**
         *    Actually opens the low level socket.
         *    @param string $host          Host to connect to.
         *    @param integer $port         Port on host.
         *    @param integer $error_number Recipient of error code.
         *    @param string $error         Recipient of error message.
         *    @param integer $timeout      Maximum time to wait for connection.
         *    @access protected
         */
        function _openSocket($host, $port, $error_number, $error, $timeout) {
            return parent::_openSocket("tls://$host", $port, $error_number, $error, $timeout);
        }
    }