|
| 1 | +# FreeSWITCH Event Socket Layer library for PHP |
| 2 | + |
| 3 | +[](https://travis-ci.com/rtckit/php-esl) |
| 4 | +[](https://packagist.org/packages/rtckit/esl) |
| 5 | +[](https://codeclimate.com/github/rtckit/php-esl/test_coverage) |
| 6 | +[](https://codeclimate.com/github/rtckit/php-esl/maintainability) |
| 7 | +[](LICENSE) |
| 8 | + |
| 9 | +## Quickstart |
| 10 | + |
| 11 | +[FreeSWITCH](https://github.com/signalwire/freeswitch)'s Event Socket Layer is a TCP control interface enabling the development of complex dynamic dialplans/workflows. You can learn more about its [inbound mode](https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket) as well as its [outbound mode](https://freeswitch.org/confluence/display/FREESWITCH/Event+Socket+Outbound) on the FreeSWITCH website. |
| 12 | + |
| 13 | +This library provides an I/O agnostic implementation of the ESL protocol. |
| 14 | + |
| 15 | +#### ESL Message Parsing |
| 16 | + |
| 17 | +The authentication stage of an ESL connection can be summarized as follows: |
| 18 | + |
| 19 | +```php |
| 20 | +/* This is a typical FreeSWITCH ESL server greeting */ |
| 21 | +$response = \RTCKit\ESL\Response::Parse("Content-Type: auth/request\n\n"); |
| 22 | + |
| 23 | +echo 'A server sends: ' . get_class($response) . PHP_EOL; |
| 24 | + |
| 25 | +/* Since we've been told to authenticate, let's prepare our auth request */ |
| 26 | +$request = \RTCKit\ESL\Request::parse("auth ClueCon\n\n"); |
| 27 | + |
| 28 | +echo 'A client responds with: ' . get_class($request) . '; '; |
| 29 | +echo 'password: ' . $request->getParameters() . PHP_EOL; |
| 30 | + |
| 31 | +/* If our secret is correct, the ESL server should confirm that */ |
| 32 | +$followup = \RTCKit\ESL\Response::parse("Content-Type: command/reply\nReply-Text: +OK accepted\n\n"); |
| 33 | + |
| 34 | +echo 'Then the server replies with: ' . get_class($followup) . '; '; |
| 35 | +echo ($followup->isSuccessful() ? 'Success!' : 'Yikes!') . PHP_EOL; |
| 36 | +``` |
| 37 | + |
| 38 | +#### ESL Message Rendering |
| 39 | + |
| 40 | +The reverse procedure, rendering to string, is straightforward: |
| 41 | + |
| 42 | +```php |
| 43 | +$response = new \RTCKit\ESL\Response\AuthRequest; |
| 44 | + |
| 45 | +echo 'A server sends: "' . $response->render() . '"' . PHP_EOL; |
| 46 | + |
| 47 | +$request = new \RTCKit\ESL\Request\Auth; |
| 48 | +$request->setParameters('ClueCon'); |
| 49 | + |
| 50 | +echo 'A client responds with: "' . $request->render() . '"' . PHP_EOL; |
| 51 | + |
| 52 | +$followup = new \RTCKit\ESL\Response\CommandReply; |
| 53 | +$followup->setHeader('reply-text', '+OK accepted'); |
| 54 | + |
| 55 | +echo 'Then the server replies with: "' . $followup->render() . '"' . PHP_EOL; |
| 56 | +``` |
| 57 | + |
| 58 | +#### ESL Connection |
| 59 | + |
| 60 | +Although this library is I/O independent, a Connection [interface](src/ConnectionInterface.php) and [base class](src/Connection.php) are being provided; since ESL runs over TCP, a stream oriented transport, it behooves to handle the message framing in a higher level library. An implementing project would simply invoke the `ConnectionInterface::consume()` method when input is available and would implement a `ConnectionInterface::emitBytes()` method which performs the corresponding I/O-specific write operations. |
| 61 | + |
| 62 | +The Connection constructor requires a `$role` argument, which must be one of the following: |
| 63 | + |
| 64 | +* `ConnectionInterface::INBOUND_CLIENT` to be used by ESL clients connecting to FreeSWITCH ESL servers; |
| 65 | +* `ConnectionInterface::OUTBOUND_SERVER` to be used by ESL servers FreeSWITCH connects to in outbound mode; |
| 66 | + |
| 67 | +The other two options are less common: |
| 68 | + |
| 69 | +* `ConnectionInterface::INBOUND_SERVER` to impersonate a FreeSWITCH ESL server; |
| 70 | +* `ConnectionInterface::OUTBOUND_CLIENT` to impersonate FreeSWITCH connecting to a remote ESL endpoint in outbound mode; |
| 71 | + |
| 72 | +The latter two roles can be useful in test suites, implementing message relays, security research etc. Please note the inbound and outbound terms are relative to the FreeSWITCH endpoint (matching the [mod_event_socket mode](https://freeswitch.org/confluence/display/FREESWITCH/mod_event_socket) nomenclature). |
| 73 | + |
| 74 | +## Requirements |
| 75 | + |
| 76 | +**RTCKit\ESL** is compatible with PHP 7.4+ and has no external library and extension dependencies. |
| 77 | + |
| 78 | +## Installation |
| 79 | + |
| 80 | +You can add the library as project dependency using [Composer](https://getcomposer.org/): |
| 81 | + |
| 82 | +```sh |
| 83 | +composer require rtckit/esl |
| 84 | +``` |
| 85 | + |
| 86 | +If you only need the library during development, for instance when used in your test suite, then you should add it as a development-only dependency: |
| 87 | + |
| 88 | +```sh |
| 89 | +composer require --dev rtckit/esl |
| 90 | +``` |
| 91 | + |
| 92 | +## Tests |
| 93 | + |
| 94 | +To run the test suite, clone this repository and then install dependencies via Composer: |
| 95 | + |
| 96 | +```sh |
| 97 | +composer install |
| 98 | +``` |
| 99 | + |
| 100 | +Then, go to the project root and run: |
| 101 | + |
| 102 | +```bash |
| 103 | +composer phpunit |
| 104 | +``` |
| 105 | + |
| 106 | +### Static Analysis |
| 107 | + |
| 108 | +In order to ensure high code quality, **RTCKit\ESL** uses [PHPStan](https://github.com/phpstan/phpstan) and [Psalm](https://github.com/vimeo/psalm): |
| 109 | + |
| 110 | +```sh |
| 111 | +composer phpstan |
| 112 | +composer psalm |
| 113 | +``` |
| 114 | + |
| 115 | +## License |
| 116 | + |
| 117 | +MIT, see [LICENSE file](LICENSE). |
| 118 | + |
| 119 | +### Acknowledgments |
| 120 | + |
| 121 | +* [FreeSWITCH](https://github.com/signalwire/freeswitch), FreeSWITCH is a registered trademark of Anthony Minessale II |
| 122 | + |
| 123 | +### Contributing |
| 124 | + |
| 125 | +Bug reports (and small patches) can be submitted via the [issue tracker](https://github.com/rtckit/php-esl/issues). Forking the repository and submitting a Pull Request is preferred for substantial patches. |
0 commit comments