2017-05-16 15:12:04 +02:00
|
|
|
<?php
|
2018-02-24 17:54:13 +01:00
|
|
|
|
Merge alpha into master (async, huge bugfixes and more) (#546)
* Implement async and lots of bugfixes
* Implement more async
* Implement async, implement bugfixes for the connection module, for the datacenter module, huge bugfixes, huge perfomance improvements, media DCs for https, advanced selecting, custom var_dump, totally rewritten IOLoop and response mechanism, promises, improvements to the TL parser, custom mb_substr
* Apply fixes from StyleCI
* Bugfixes
* Apply fixes from StyleCI
* Bugfixes, implement combined promises
* Apply fixes from StyleCI
* Support passing method arguments as callable
* Starting to write async upload logic
* Apply fixes from StyleCI
* Start implementing async file upload
* Apply fixes from StyleCI
* bugfix
* Apply fixes from StyleCI
* Start rewriting connection module
* Add PHP file docblocks for all classes
* Start working on new async stream API
* Finish writing stream API
* More stream API fixes
* Apply fixes from StyleCI
* Rewrite DataCenter and Connection modules
* Clean up stream API documentation
* Fixes
* Apply fixes from StyleCI
* Add referenced parameter to get length of buffer to read in getReadBuffer API
* Moved all MessageHandler code in the Connection module, added a PHP version warning in the phar
* Start fixing reads
* Fix all protocol stream wrappers
* Apply fixes from StyleCI
* Implement disconnection, and remove end function
* Working async RPC
* Implement async file upload
* Bugfix
* Method recall bugfixes
* Bugfixes
* Trait bugfixes
* Fix FIFO buffer
* Bugfixes and speedtests
* Async logging
* Implement websocket streams
* Implement loop API, signal API, clean closing and start changing layer
* Small magna, websocket and HTTP fixes
* Clean up loop API
* Improved stack traces, 2FA and async
* Login fixes
* Added instructions for manual verification
* Small fixes
* More app info improvements
* More app info improvements
* TL and 2FA fixes
* Update to layer 89
* More bugfixes
* Implement broken media reporting
* Remove debug comments
* PHP 7.2 backwards compatibility
* Bugfixes
* Async key generation
* Some simplifications
* Transport fixes
* Cleanup
* async API
* Performance fixes
* Fixes to async API
* Bugfixes
* Implement one-time async loop
* Authorization and logging fixes
* Update to layer 91
* 7to5 fix
* Null coalesce conversion
* Implement socks5 proxy
* Implement HTTP proxy
* Fixes to HTTP proxy
* MTProxy and socks5 fixes
* Disable PHP 5 conversion
* Proxies have higher priority
* Avoid error handling in vendor
* Override composer dependencies
* Fix travis build
* Final composer fixes
* Proxy logic fixes
* Fix get_updates update handling
* Do not use parallel file driver if not supported
* Refactor loader and implement HTTP fixes
* Suppress errors in loader
* HTTP and authorization fixes
* HTTP fixes
* Improved peer management
* Use HTTP protocol on altervista
* Small bugfixes
* Minor fixes
* Docufix
* Docufix
* Legacy fixes
* Fix message queue
* Avoid updating if using MTProxy
* Improve logs and examples
* Trim final newlines while converting parse mode
* Reimplement noResponse flag
* Async combined event handler and APIFactory fixes
* Actually return config
* Case-insensitive methods
* Bugfix
* Apply fixes from StyleCI (#545)
* MTProxy fixes
* PHP 5 warning
* Improved PHP 5 warning
* Use <br> along with newlines in web logs
* Update docs
2018-12-26 20:51:14 +01:00
|
|
|
/**
|
|
|
|
* Button module.
|
|
|
|
*
|
|
|
|
* This file is part of MadelineProto.
|
|
|
|
* MadelineProto is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
|
|
|
* MadelineProto is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
|
|
* See the GNU Affero General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License along with MadelineProto.
|
|
|
|
* If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
* @author Daniil Gentili <daniil@daniil.it>
|
2020-02-17 14:13:46 +01:00
|
|
|
* @copyright 2016-2020 Daniil Gentili <daniil@daniil.it>
|
Merge alpha into master (async, huge bugfixes and more) (#546)
* Implement async and lots of bugfixes
* Implement more async
* Implement async, implement bugfixes for the connection module, for the datacenter module, huge bugfixes, huge perfomance improvements, media DCs for https, advanced selecting, custom var_dump, totally rewritten IOLoop and response mechanism, promises, improvements to the TL parser, custom mb_substr
* Apply fixes from StyleCI
* Bugfixes
* Apply fixes from StyleCI
* Bugfixes, implement combined promises
* Apply fixes from StyleCI
* Support passing method arguments as callable
* Starting to write async upload logic
* Apply fixes from StyleCI
* Start implementing async file upload
* Apply fixes from StyleCI
* bugfix
* Apply fixes from StyleCI
* Start rewriting connection module
* Add PHP file docblocks for all classes
* Start working on new async stream API
* Finish writing stream API
* More stream API fixes
* Apply fixes from StyleCI
* Rewrite DataCenter and Connection modules
* Clean up stream API documentation
* Fixes
* Apply fixes from StyleCI
* Add referenced parameter to get length of buffer to read in getReadBuffer API
* Moved all MessageHandler code in the Connection module, added a PHP version warning in the phar
* Start fixing reads
* Fix all protocol stream wrappers
* Apply fixes from StyleCI
* Implement disconnection, and remove end function
* Working async RPC
* Implement async file upload
* Bugfix
* Method recall bugfixes
* Bugfixes
* Trait bugfixes
* Fix FIFO buffer
* Bugfixes and speedtests
* Async logging
* Implement websocket streams
* Implement loop API, signal API, clean closing and start changing layer
* Small magna, websocket and HTTP fixes
* Clean up loop API
* Improved stack traces, 2FA and async
* Login fixes
* Added instructions for manual verification
* Small fixes
* More app info improvements
* More app info improvements
* TL and 2FA fixes
* Update to layer 89
* More bugfixes
* Implement broken media reporting
* Remove debug comments
* PHP 7.2 backwards compatibility
* Bugfixes
* Async key generation
* Some simplifications
* Transport fixes
* Cleanup
* async API
* Performance fixes
* Fixes to async API
* Bugfixes
* Implement one-time async loop
* Authorization and logging fixes
* Update to layer 91
* 7to5 fix
* Null coalesce conversion
* Implement socks5 proxy
* Implement HTTP proxy
* Fixes to HTTP proxy
* MTProxy and socks5 fixes
* Disable PHP 5 conversion
* Proxies have higher priority
* Avoid error handling in vendor
* Override composer dependencies
* Fix travis build
* Final composer fixes
* Proxy logic fixes
* Fix get_updates update handling
* Do not use parallel file driver if not supported
* Refactor loader and implement HTTP fixes
* Suppress errors in loader
* HTTP and authorization fixes
* HTTP fixes
* Improved peer management
* Use HTTP protocol on altervista
* Small bugfixes
* Minor fixes
* Docufix
* Docufix
* Legacy fixes
* Fix message queue
* Avoid updating if using MTProxy
* Improve logs and examples
* Trim final newlines while converting parse mode
* Reimplement noResponse flag
* Async combined event handler and APIFactory fixes
* Actually return config
* Case-insensitive methods
* Bugfix
* Apply fixes from StyleCI (#545)
* MTProxy fixes
* PHP 5 warning
* Improved PHP 5 warning
* Use <br> along with newlines in web logs
* Update docs
2018-12-26 20:51:14 +01:00
|
|
|
* @license https://opensource.org/licenses/AGPL-3.0 AGPLv3
|
|
|
|
*
|
2019-10-31 15:07:35 +01:00
|
|
|
* @link https://docs.madelineproto.xyz MadelineProto documentation
|
Merge alpha into master (async, huge bugfixes and more) (#546)
* Implement async and lots of bugfixes
* Implement more async
* Implement async, implement bugfixes for the connection module, for the datacenter module, huge bugfixes, huge perfomance improvements, media DCs for https, advanced selecting, custom var_dump, totally rewritten IOLoop and response mechanism, promises, improvements to the TL parser, custom mb_substr
* Apply fixes from StyleCI
* Bugfixes
* Apply fixes from StyleCI
* Bugfixes, implement combined promises
* Apply fixes from StyleCI
* Support passing method arguments as callable
* Starting to write async upload logic
* Apply fixes from StyleCI
* Start implementing async file upload
* Apply fixes from StyleCI
* bugfix
* Apply fixes from StyleCI
* Start rewriting connection module
* Add PHP file docblocks for all classes
* Start working on new async stream API
* Finish writing stream API
* More stream API fixes
* Apply fixes from StyleCI
* Rewrite DataCenter and Connection modules
* Clean up stream API documentation
* Fixes
* Apply fixes from StyleCI
* Add referenced parameter to get length of buffer to read in getReadBuffer API
* Moved all MessageHandler code in the Connection module, added a PHP version warning in the phar
* Start fixing reads
* Fix all protocol stream wrappers
* Apply fixes from StyleCI
* Implement disconnection, and remove end function
* Working async RPC
* Implement async file upload
* Bugfix
* Method recall bugfixes
* Bugfixes
* Trait bugfixes
* Fix FIFO buffer
* Bugfixes and speedtests
* Async logging
* Implement websocket streams
* Implement loop API, signal API, clean closing and start changing layer
* Small magna, websocket and HTTP fixes
* Clean up loop API
* Improved stack traces, 2FA and async
* Login fixes
* Added instructions for manual verification
* Small fixes
* More app info improvements
* More app info improvements
* TL and 2FA fixes
* Update to layer 89
* More bugfixes
* Implement broken media reporting
* Remove debug comments
* PHP 7.2 backwards compatibility
* Bugfixes
* Async key generation
* Some simplifications
* Transport fixes
* Cleanup
* async API
* Performance fixes
* Fixes to async API
* Bugfixes
* Implement one-time async loop
* Authorization and logging fixes
* Update to layer 91
* 7to5 fix
* Null coalesce conversion
* Implement socks5 proxy
* Implement HTTP proxy
* Fixes to HTTP proxy
* MTProxy and socks5 fixes
* Disable PHP 5 conversion
* Proxies have higher priority
* Avoid error handling in vendor
* Override composer dependencies
* Fix travis build
* Final composer fixes
* Proxy logic fixes
* Fix get_updates update handling
* Do not use parallel file driver if not supported
* Refactor loader and implement HTTP fixes
* Suppress errors in loader
* HTTP and authorization fixes
* HTTP fixes
* Improved peer management
* Use HTTP protocol on altervista
* Small bugfixes
* Minor fixes
* Docufix
* Docufix
* Legacy fixes
* Fix message queue
* Avoid updating if using MTProxy
* Improve logs and examples
* Trim final newlines while converting parse mode
* Reimplement noResponse flag
* Async combined event handler and APIFactory fixes
* Actually return config
* Case-insensitive methods
* Bugfix
* Apply fixes from StyleCI (#545)
* MTProxy fixes
* PHP 5 warning
* Improved PHP 5 warning
* Use <br> along with newlines in web logs
* Update docs
2018-12-26 20:51:14 +01:00
|
|
|
*/
|
2018-02-24 17:54:39 +01:00
|
|
|
|
2017-05-18 12:12:33 +02:00
|
|
|
namespace danog\MadelineProto\TL\Types;
|
2017-05-16 15:12:04 +02:00
|
|
|
|
2020-10-07 19:31:52 +02:00
|
|
|
use danog\MadelineProto\API;
|
2020-02-26 18:12:00 +01:00
|
|
|
use danog\MadelineProto\MTProto;
|
|
|
|
use danog\MadelineProto\Tools;
|
|
|
|
|
2020-10-07 19:31:52 +02:00
|
|
|
/**
|
|
|
|
* Clickable button.
|
|
|
|
*/
|
2018-02-25 10:52:55 +01:00
|
|
|
class Button implements \JsonSerializable, \ArrayAccess
|
2017-05-16 15:12:04 +02:00
|
|
|
{
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* Button data.
|
2020-10-04 16:27:22 +02:00
|
|
|
*
|
|
|
|
* @psalm-var non-empty-array<array-key, mixed>
|
2020-02-26 18:12:00 +01:00
|
|
|
*/
|
|
|
|
private array $button;
|
2020-10-07 19:31:52 +02:00
|
|
|
/**
|
|
|
|
* Session name.
|
|
|
|
*/
|
|
|
|
private string $session;
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* MTProto instance.
|
2020-10-07 19:31:52 +02:00
|
|
|
*
|
|
|
|
* @var MTProto|API
|
2020-02-26 18:12:00 +01:00
|
|
|
*/
|
2020-10-07 19:31:52 +02:00
|
|
|
private $API;
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* Message ID.
|
|
|
|
*/
|
|
|
|
private int $id;
|
|
|
|
/**
|
|
|
|
* Peer ID.
|
|
|
|
*
|
|
|
|
* @var array|int
|
|
|
|
*/
|
|
|
|
private $peer;
|
|
|
|
/**
|
|
|
|
* Constructor function.
|
|
|
|
*
|
|
|
|
* @param MTProto $API API instance
|
|
|
|
* @param array $message Message
|
|
|
|
* @param array $button Button info
|
|
|
|
*/
|
|
|
|
public function __construct(MTProto $API, array $message, array $button)
|
2017-05-16 15:12:04 +02:00
|
|
|
{
|
2020-02-26 18:12:00 +01:00
|
|
|
$this->button = $button;
|
2020-10-01 18:02:54 +02:00
|
|
|
$this->peer = $message['peer_id'] === [
|
|
|
|
'_' => 'peerUser',
|
|
|
|
'user_id' => $API->authorization['user']['id']
|
|
|
|
]
|
|
|
|
? $message['from_id']
|
|
|
|
: $message['peer_id'];
|
2020-02-26 18:12:00 +01:00
|
|
|
$this->id = $message['id'];
|
|
|
|
$this->API = $API;
|
2020-10-07 19:31:52 +02:00
|
|
|
$this->session = $API->getWrapper()->getSession()->getLegacySessionPath();
|
2017-05-16 15:12:04 +02:00
|
|
|
}
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* Sleep function.
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function __sleep(): array
|
2017-05-18 12:13:05 +02:00
|
|
|
{
|
2020-10-07 19:31:52 +02:00
|
|
|
return ['button', 'peer', 'id', 'session'];
|
2017-05-18 12:13:05 +02:00
|
|
|
}
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* Click on button.
|
|
|
|
*
|
|
|
|
* @param boolean $donotwait Whether to wait for the result of the method
|
|
|
|
*
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function click(bool $donotwait = true)
|
2017-05-16 15:12:04 +02:00
|
|
|
{
|
2020-10-07 19:31:52 +02:00
|
|
|
if (!isset($this->API)) {
|
|
|
|
$this->API = new API($this->session);
|
|
|
|
} else {
|
|
|
|
$async = isset($this->API->wrapper) ? $this->API->wrapper->isAsync() : true;
|
|
|
|
}
|
2019-10-29 22:41:31 +01:00
|
|
|
$method = $donotwait ? 'methodCallAsyncWrite' : 'methodCallAsyncRead';
|
2020-02-26 18:12:00 +01:00
|
|
|
switch ($this->button['_']) {
|
2018-02-24 17:54:13 +01:00
|
|
|
default:
|
|
|
|
return false;
|
|
|
|
case 'keyboardButtonUrl':
|
2020-02-26 18:12:00 +01:00
|
|
|
return $this->button['url'];
|
2018-02-24 17:54:13 +01:00
|
|
|
case 'keyboardButton':
|
2020-02-26 18:12:00 +01:00
|
|
|
$res = $this->API->methodCallAsyncRead('messages.sendMessage', ['peer' => $this->peer, 'message' => $this->button['text'], 'reply_to_msg_id' => $this->id], ['datacenter' => $this->API->datacenter->curdc]);
|
2019-05-11 21:04:01 +02:00
|
|
|
break;
|
2018-02-24 17:54:13 +01:00
|
|
|
case 'keyboardButtonCallback':
|
2020-02-26 18:12:00 +01:00
|
|
|
$res = $this->API->{$method}('messages.getBotCallbackAnswer', ['peer' => $this->peer, 'msg_id' => $this->id, 'data' => $this->button['data']], ['datacenter' => $this->API->datacenter->curdc]);
|
2019-05-11 21:04:01 +02:00
|
|
|
break;
|
2018-02-24 17:54:13 +01:00
|
|
|
case 'keyboardButtonGame':
|
2020-02-26 18:12:00 +01:00
|
|
|
$res = $this->API->{$method}('messages.getBotCallbackAnswer', ['peer' => $this->peer, 'msg_id' => $this->id, 'game' => true], ['datacenter' => $this->API->datacenter->curdc]);
|
2019-05-11 21:04:01 +02:00
|
|
|
break;
|
2017-05-16 15:12:04 +02:00
|
|
|
}
|
2020-02-26 18:12:00 +01:00
|
|
|
return $async ? $res : Tools::wait($res);
|
2017-05-16 15:12:04 +02:00
|
|
|
}
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* Get debug info.
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function __debugInfo(): array
|
2017-08-14 20:43:46 +02:00
|
|
|
{
|
2020-02-26 18:12:00 +01:00
|
|
|
$res = \get_object_vars($this);
|
|
|
|
unset($res['API']);
|
|
|
|
return $res;
|
2017-08-14 20:42:58 +02:00
|
|
|
}
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* Serialize button.
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function jsonSerialize(): array
|
2017-05-16 15:12:04 +02:00
|
|
|
{
|
2020-02-26 18:12:00 +01:00
|
|
|
return $this->button;
|
2017-05-16 15:12:04 +02:00
|
|
|
}
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* Set button info.
|
|
|
|
*
|
|
|
|
* @param $name Offset
|
|
|
|
* @param mixed $value Value
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function offsetSet($name, $value): void
|
2018-02-25 10:53:22 +01:00
|
|
|
{
|
2018-02-25 10:52:55 +01:00
|
|
|
if ($name === null) {
|
2020-02-26 18:12:00 +01:00
|
|
|
$this->button[] = $value;
|
2018-02-25 10:52:55 +01:00
|
|
|
} else {
|
2020-02-26 18:12:00 +01:00
|
|
|
$this->button[$name] = $value;
|
2018-02-25 10:52:55 +01:00
|
|
|
}
|
|
|
|
}
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* Get button info.
|
|
|
|
*
|
|
|
|
* @param $name Field name
|
|
|
|
*
|
2020-10-04 16:27:22 +02:00
|
|
|
* @return mixed
|
2020-02-26 18:12:00 +01:00
|
|
|
*/
|
2018-02-25 10:53:22 +01:00
|
|
|
public function offsetGet($name)
|
|
|
|
{
|
2020-02-26 18:12:00 +01:00
|
|
|
return $this->button[$name];
|
2018-02-25 10:52:55 +01:00
|
|
|
}
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* Unset button info.
|
|
|
|
*
|
|
|
|
* @param $name Offset
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function offsetUnset($name): void
|
2018-02-25 10:53:22 +01:00
|
|
|
{
|
2020-02-26 18:12:00 +01:00
|
|
|
unset($this->button[$name]);
|
2018-02-25 10:52:55 +01:00
|
|
|
}
|
2020-02-26 18:12:00 +01:00
|
|
|
/**
|
|
|
|
* Check if button field exists.
|
|
|
|
*
|
|
|
|
* @param $name Offset
|
|
|
|
*
|
|
|
|
* @return boolean
|
|
|
|
*/
|
|
|
|
public function offsetExists($name): bool
|
2018-02-25 10:53:22 +01:00
|
|
|
{
|
2020-02-26 18:12:00 +01:00
|
|
|
return isset($this->button[$name]);
|
2018-02-25 10:52:55 +01:00
|
|
|
}
|
2018-02-24 17:54:39 +01:00
|
|
|
}
|