From 3d5d0a4c355eaf9fc812d402b2910f97c28520ba Mon Sep 17 00:00:00 2001 From: zyberspace Date: Wed, 18 Feb 2015 05:23:13 +0100 Subject: [PATCH] Initial commit --- .gitignore | 3 + LICENSE | 373 ++++++++++++++++++ README.md | 64 +++ composer.json | 21 + example.php | 15 + .../Telegram/Cli/AbstractClientCommands.php | 216 ++++++++++ lib/Zyberspace/Telegram/Cli/Client.php | 104 +++++ .../Telegram/Cli/ClientException.php | 16 + phpdoc.dist.xml | 16 + 9 files changed, 828 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 composer.json create mode 100644 example.php create mode 100644 lib/Zyberspace/Telegram/Cli/AbstractClientCommands.php create mode 100644 lib/Zyberspace/Telegram/Cli/Client.php create mode 100644 lib/Zyberspace/Telegram/Cli/ClientException.php create mode 100644 phpdoc.dist.xml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f6c3940 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/vendor/ +/doc/ +/.project diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b4e6278 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +zyberspace/telegram-cli-client +============================== +php-client for [telegram-cli](https://github.com/vysheng/tg/) + +Requirements +------------ + - a running [telegram-cli](https://github.com/vysheng/tg/) listening on a unix-socket (`-S`) or a port (`-P`). Needs to be configured already (phone-number, etc.). + - php >= 5.4.0 + +Usage +----- + +###Setup telegram-cli +[telegram-cli](https://github.com/vysheng/tg/) needs to run on a unix-socket (`-S`) or a port (`-P`), so *telegram-cli-client* can connect to it. +You should also start it with `-W` so the contact-list gets loaded on startup. +For this example we will take the following command (execute it from the dir, where you installed telegram-cli, not the php-client), `-d` lets it run as daemon.: + +```shell +./bin/telegram-cli -dWS /tmp/tg.sck & +``` + +If you never started telegram-cli before, you need to start it first in normal mode, so you can type in your telegram-phone-number and register it, if needed (`./bin/telegram-cli`). + +To stop the daemon use `killall telegram-cli` or `kill -TERM [telegram-pid]`. + +###Install telegram-cli-client with composer +In your project-root: + +```shell +composer require zyberspace/telegram-cli-client +``` + +Composer will then automatically add the package to your project requirements and install it (also creates the `composer.json` if you don't have one already). + +###Use it + +```php +require('vendor/autoload.php'); +$telegram = new \Zyberspace\Telegram\Cli\Client('unix:///tmp/tg.sck'); + +$contactList = $telegram->getContactList(); +$telegram->msg($contactList[0], 'Hey man, what\'s up? :D'); +``` + +Documentation +------------- +To create the docs, just run `phpdoc` in the the project-root. +An online-version is available at [phpdoc.zyberware.org/zyberspace/telegram-cli-client](http://phpdoc.zyberware.org/zyberspace/telegram-cli-client/). + +Supported Commands +------------------ +You can execute every command with the `exec()`-method, but there are also several command-wrappers available in the `AbstractClientCommands`-Class ([doc-link](http://phpdoc.zyberware.org/zyberspace/telegram-cli-client/classes/Zyberspace.Telegram.Cli.AbstractClientCommands.html)), which the main class extends (see the `example.php`). + +If you use `exec()` directly, please don't forget to escape the peer (contacts, chat-names, etc.) with `escapePeer()` and all string-arguments with `escapeStringArgument()` to avoid errors. + +API-Stability +------------- +The api of the commands wrappers will definitely change in the future, for example `getHistory()` only returns the raw answer of the telegram-cli right now and is not really useful. Therefore you should not use this in production yet. + +**If you still want to use this in your project, make sure you stay at the same [minor](http://semver.org/spec/v2.0.0.html)-version (`~0.1.0` or `0.1.*` for example)**. + +License +------- +This software is licensed under the [Mozilla Public License v. 2.0](http://mozilla.org/MPL/2.0/). For more information, read the file `LICENSE`. diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..118d771 --- /dev/null +++ b/composer.json @@ -0,0 +1,21 @@ +{ + "name": "zyberspace/telegram-cli-client", + "description": "php-client for telegram-cli", + "type": "library", + "homepage": "https://github.com/zyberspace/php-telegram-cli-client", + "license": "MPL-2.0", + "authors": [ + { + "name": "zyberspace", + "email": "zyberspace@zyberware.org" + } + ], + "require": { + "php": ">=5.4.0,<6.0.0" + }, + "autoload": { + "psr-0": { + "Zyberspace\\Telegram\\Cli\\": "lib/" + } + } +} diff --git a/example.php b/example.php new file mode 100644 index 0000000..1639907 --- /dev/null +++ b/example.php @@ -0,0 +1,15 @@ + + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ +require('vendor/autoload.php'); +$telegram = new \Zyberspace\Telegram\Cli\Client('unix:///tmp/tg.sck'); + +$contactList = $telegram->getContactList(); +var_dump($contactList); + +var_dump($telegram->msg($contactList[0], '"Te\'st"' . "\n" . time())); diff --git a/lib/Zyberspace/Telegram/Cli/AbstractClientCommands.php b/lib/Zyberspace/Telegram/Cli/AbstractClientCommands.php new file mode 100644 index 0000000..f3454fd --- /dev/null +++ b/lib/Zyberspace/Telegram/Cli/AbstractClientCommands.php @@ -0,0 +1,216 @@ + + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ +namespace Zyberspace\Telegram\Cli; + +//This class should actually be a trait and not abstract, but this way we can support PHP 5.3 and +//don't rely on PHP 5.4 + +/** + * Defines some command-wrappers, that get extended by the Client. + */ +abstract class AbstractClientCommands +{ + /** + * Sets status as online. + * + * @return boolean true on success, false otherwise + * + * @uses exec() + */ + public function setStatusOnline() + { + return $this->exec('status_online'); + } + + /** + * Sets status as offline. + * + * @return boolean true on success, false otherwise + * + * @uses exec() + */ + public function setStatusOffline() + { + return $this->exec('status_offline'); + } + + /** + * Sends a text message to $peer. + * + * @param string $peer The peer, gets escaped with escapePeer(), + * so you can directly use the values from getContactList() + * @param string $msg The message to send, gets escaped with escapeStringArgument() + * + * @return boolean true on success, false otherwise + * + * @uses exec() + * @uses escapePeer() + * @uses escapeStringArgument() + */ + public function msg($peer, $msg) + { + $peer = $this->escapePeer($peer); + $msg = $this->escapeStringArgument($msg); + return $this->exec('msg ' . $peer . ' ' . $msg); + } + + /** + * Adds a user to the contact list + * + * @param int|string $phoneNumber The phone-number of the new contact, needs to be a telegram-user. + * Can start with or without '+'. + * @param string $firstName The first name of the new contact + * @param string $lastName The last name of the new contact + * + * @return string|boolean The new contact "$firstName $lastName"; false if somethings goes wrong + * + * @uses exec() + * @uses escapeStringArgument() + */ + public function addContact($phoneNumber, $firstName, $lastName) + { + if (is_string($phoneNumber) && $phoneNumber[0] === '+') { + $phoneNumber = substr($phoneNumber, 1); + } + $phoneNumber = (int) $phoneNumber; + + return $this->exec('add_contact ' . $phoneNumber . ' ' . $this->escapeStringArgument($firstName) + . ' ' . $this->escapeStringArgument($lastName)); + } + + /** + * Renames a user in the contact list + * + * @param string $contact The contact, gets escaped with escapePeer(), + * so you can directly use the values from getContactList() + * @param string $firstName The new first name for the contact + * @param string $lastName The new last name for the contact + * + * @return string|boolean The renamed contact "$firstName $lastName"; false if somethings goes wrong + * + * @uses exec() + * @uses escapeStringArgument() + */ + public function renameContact($contact, $firstName, $lastName) + { + return $this->exec('rename_contact ' . $this->escapePeer($contact) + . ' ' . $this->escapeStringArgument($firstName) . ' ' . $this->escapeStringArgument($lastName)); + } + + /** + * Deletes a contact. + * + * @param string $contact The contact, gets escaped with escapePeer(), + * so you can directly use the values from getContactList() + * + * @return boolean true on success, false otherwise + * + * @uses exec() + * @uses escapePeer() + */ + public function deleteContact($contact) + { + return $this->exec('del_contact ' . $this->escapePeer($contact)); + } + + /** + * Marks all messages with $peer as read. + * + * @param string $peer The peer, gets escaped with escapePeer(), + * so you can directly use the values from getContactList() + * + * @return boolean true on success, false otherwise + * + * @uses exec() + * @uses escapePeer() + */ + public function markRead($peer) + { + return $this->exec('mark_read ' . $this->escapePeer($peer)); + } + + /** + * Returns an array of all contacts in form of "[firstName] [lastName]". + * + * @return array|boolean An array with your contacts; false if somethings goes wrong + * + * @uses exec() + */ + public function getContactList() + { + return explode(PHP_EOL, $this->exec('contact_list')); + } + + /** + * Executes the user_info-command and returns it answer (the answer is unformated right now). + * Will get better formated in the future. + * + * @param string $user The user, gets escaped with escapePeer(), + * so you can directly use the values from getContactList() + * + * @return string|boolean The answer of the user_info-command; false if somethings goes wrong + * + * @uses exec() + * @uses escapePeer() + */ + public function getUserInfo($user) + { + return $this->exec('user_info ' . $this->escapePeer($user)); + } + + /** + * Returns an array of all your dialogs in form of + * "User [firstName] [lastName]: [number of unread messages] unread". Will get better formated in the future. + * + * @return array|boolean An array with your dialogs; false if somethings goes wrong + * + * @uses exec() + */ + public function getDialogList() + { + return explode(PHP_EOL, $this->exec('dialog_list')); + } + + /** + * Executes the history-command and returns it answer (the answer is unformated right now). + * Will get better formated in the future. + * + * @param string $peer The peer, gets escaped with escapePeer(), + * so you can directly use the values from getContactList() + * @param int $limit (optional) Limit answer to $limit messages. If not set, there is no limit. + * @param int $offset (optional) Use this with the $limit parameter to go through older messages. + * Can also be negative. + * + * @return string|boolean The answer of the history-command; false if somethings goes wrong + * + * @uses exec() + * @uses escapePeer() + * + * @see https://core.telegram.org/method/messages.getHistory + */ + public function getHistory($peer, $limit = null, $offset = null) + { + if ($limit !== null) { + $limit = (int) $limit; + if ($limit < 1) { //if limit is lesser than 1, telegram-cli crashes + $limit = 1; + } + $limit = ' ' . $limit; + } else { + $limit = ''; + } + if ($offset !== null) { + $offset = ' ' . (int) $offset; + } else { + $offset = ''; + } + + return $this->exec('history ' . $this->escapePeer($peer) . $limit . $offset); + } +} diff --git a/lib/Zyberspace/Telegram/Cli/Client.php b/lib/Zyberspace/Telegram/Cli/Client.php new file mode 100644 index 0000000..1502647 --- /dev/null +++ b/lib/Zyberspace/Telegram/Cli/Client.php @@ -0,0 +1,104 @@ + + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ +namespace Zyberspace\Telegram\Cli; + +/** + * php-client for telegram-cli + */ +class Client extends AbstractClientCommands +{ + /** + * The file handler for the socket-connection + * + * @var ressource + */ + protected $_fp; + + /** + * Connects to the telegram-cli. + * + * @param string $remoteSocket Address of the socket to connect to. See stream_socket_client() for more info. + * Can be 'unix://' or 'tcp://'. + * + * @throws ClientException Throws an exception if no connection can be established. + */ + public function __construct($remoteSocket) + { + $this->_fp = stream_socket_client($remoteSocket); + if ($this->_fp === false) { + throw new ClientException('Could not connect to socket "' . $remoteSocket . '"'); + } + stream_set_timeout($this->_fp, 1); //This way fgets() returns false if telegram-cli gives us no response. + } + + /** + * Closes the connection to the telegram-cli. + */ + public function __destruct() + { + fclose($this->_fp); + } + + /** + * Executes a command on the telegram-cli. Line-breaks will be escaped, as telgram-cli does not support them. + * + * @param string $command The command, including all arguments + * + * @return boolean|string Returns the answer as string or true on success, false if there was an error. + */ + public function exec($command) + { + fwrite($this->_fp, str_replace("\n", '\n', $command) . PHP_EOL); + + $answer = fgets($this->_fp); //"ANSWER $bytes" if there is a return value or \n if not + if (is_string($answer)) { + if (substr($answer, 0, 7) === 'ANSWER ') { + $bytes = (int) substr($answer, 7); + if ($bytes > 0) { + $string = trim(fread($this->_fp, $bytes + 1)); + + if ($string === 'SUCCESS') { //For "status_online" and "status_offline" + return true; + } + + return $string; + } + } else if ($answer === PHP_EOL) { //For commands like "msg" + return true; + } + } + + return false; + } + + /** + * Escapes strings for usage as command-argument. + * T"es't -> "T\"es\'t" + * + * @param string $argument The argument to escape + * + * @return string The escaped command enclosed by double-quotes + */ + public function escapeStringArgument($argument) + { + return '"' . addslashes($argument) . '"'; + } + + /** + * Replaces all spaces with underscores. + * + * @param string $peer The peer to escape + * + * @return string The escaped peer + */ + public function escapePeer($peer) + { + return str_replace(' ', '_', $peer); + } +} diff --git a/lib/Zyberspace/Telegram/Cli/ClientException.php b/lib/Zyberspace/Telegram/Cli/ClientException.php new file mode 100644 index 0000000..59a3f93 --- /dev/null +++ b/lib/Zyberspace/Telegram/Cli/ClientException.php @@ -0,0 +1,16 @@ + + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ +namespace Zyberspace\Telegram\Cli; + +/** + * Nothing special here, just an Exception used by the Client. + */ +class ClientException extends \Exception +{ +} diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml new file mode 100644 index 0000000..34d2c59 --- /dev/null +++ b/phpdoc.dist.xml @@ -0,0 +1,16 @@ + + + zyberspace/telegram-cli-client + + doc + + + doc + + + quiet + + + lib + +