MadelineProto/src/danog/MadelineProto/MTProtoTools/Files.php

1084 lines
50 KiB
PHP

<?php
/**
* Files 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>
* @copyright 2016-2020 Daniil Gentili <daniil@daniil.it>
* @license https://opensource.org/licenses/AGPL-3.0 AGPLv3
*
* @link https://docs.madelineproto.xyz MadelineProto documentation
*/
namespace danog\MadelineProto\MTProtoTools;
use Amp\Deferred;
use Amp\File\BlockingFile;
use Amp\File\StatCache as StatCacheAsync;
use Amp\Http\Client\Request;
use Amp\Http\Status;
use Amp\Promise;
use Amp\Success;
use danog\MadelineProto\Exception;
use danog\MadelineProto\FileCallbackInterface;
use danog\MadelineProto\Settings;
use danog\MadelineProto\Tools;
use tgseclib\Crypt\AES;
use const danog\Decoder\TYPES;
use function Amp\File\exists;
use function Amp\File\open;
use function Amp\File\stat as statAsync;
use function Amp\Promise\all;
/**
* Manages upload and download of files.
*
* @property Settings $settings Settings
*/
trait Files
{
use FilesLogic;
/**
* Upload file from URL.
*
* @param string|FileCallbackInterface $url URL of file
* @param integer $size Size of file
* @param string $fileName File name
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
* @param boolean $encrypted Whether to encrypt file for secret chats
*
* @return array
*/
public function uploadFromUrl($url, int $size = 0, string $fileName = '', $cb = null, bool $encrypted = false): \Generator
{
if (\is_object($url) && $url instanceof FileCallbackInterface) {
$cb = $url;
$url = $url->getFile();
}
/** @var $response \Amp\Http\Client\Response */
$request = new Request($url);
$request->setTransferTimeout(10 * 1000 * 3600);
$request->setBodySizeLimit(512 * 1024 * 4000);
$response = yield $this->datacenter->getHTTPClient()->request($request);
if (200 !== ($status = $response->getStatus())) {
throw new Exception("Wrong status code: {$status} ".$response->getReason());
}
$mime = \trim(\explode(';', $response->getHeader('content-type') ?? 'application/octet-stream')[0]);
$size = $response->getHeader('content-length') ?? $size;
$stream = $response->getBody();
if (!$size) {
$this->logger->logger("No content length for {$url}, caching first");
$body = $stream;
$stream = new BlockingFile(\fopen('php://temp', 'r+b'), 'php://temp', 'r+b');
while (null !== ($chunk = yield $body->read())) {
yield $stream->write($chunk);
}
$size = $stream->tell();
if (!$size) {
throw new Exception('Wrong size!');
}
yield $stream->seek(0);
}
return yield from $this->uploadFromStream($stream, $size, $mime, $fileName, $cb, $encrypted);
}
/**
* Upload file from callable.
*
* The callable must accept two parameters: int $offset, int $size
* The callable must return a string with the contest of the file at the specified offset and size.
*
* @param mixed $callable Callable
* @param integer $size File size
* @param string $mime Mime type
* @param string $fileName File name
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
* @param boolean $seekable Whether chunks can be fetched out of order
* @param boolean $encrypted Whether to encrypt file for secret chats
*
* @return \Generator<array>
*/
public function uploadFromCallable(callable $callable, int $size, string $mime, string $fileName = '', $cb = null, bool $seekable = true, bool $encrypted = false): \Generator
{
if (\is_object($callable) && $callable instanceof FileCallbackInterface) {
$cb = $callable;
$callable = $callable->getFile();
}
if (!\is_callable($callable)) {
throw new Exception('Invalid callable provided');
}
if ($cb === null) {
$cb = function ($percent) {
$this->logger->logger('Upload status: '.$percent.'%', \danog\MadelineProto\Logger::NOTICE);
};
}
$datacenter = $this->settings->getDefaultDc();
if ($this->datacenter->has($datacenter.'_media')) {
$datacenter .= '_media';
}
$part_size = 512 * 1024;
$parallel_chunks = $this->settings->getFiles()->getUploadParallelChunks();
$part_total_num = (int) \ceil($size / $part_size);
$part_num = 0;
$method = $size > 10 * 1024 * 1024 ? 'upload.saveBigFilePart' : 'upload.saveFilePart';
$constructor = 'input'.($encrypted === true ? 'Encrypted' : '').($size > 10 * 1024 * 1024 ? 'FileBig' : 'File').($encrypted === true ? 'Uploaded' : '');
$file_id = Tools::random(8);
$ige = null;
if ($encrypted === true) {
$key = Tools::random(32);
$iv = Tools::random(32);
$digest = \hash('md5', $key.$iv, true);
$fingerprint = Tools::unpackSignedInt(\substr($digest, 0, 4) ^ \substr($digest, 4, 4));
$ige = new \tgseclib\Crypt\AES('ige');
$ige->setIV($iv);
$ige->setKey($key);
$ige->enableContinuousBuffer();
$seekable = false;
}
//$ctx = \hash_init('md5');
$promises = [];
$speed = 0;
$time = 0;
$cb = function () use ($cb, $part_total_num, &$speed, &$time) {
static $cur = 0;
$cur++;
Tools::callFork($cb($cur * 100 / $part_total_num, $speed, $time));
};
$callable = static function (int $part_num) use ($file_id, $part_total_num, $part_size, $callable, $ige): \Generator {
$bytes = yield $callable($part_num * $part_size, $part_size);
if ($ige) {
$bytes = $ige->encrypt(\str_pad($bytes, $part_size, \chr(0)));
}
//\hash_update($ctx, $bytes);
return ['file_id' => $file_id, 'file_part' => $part_num, 'file_total_parts' => $part_total_num, 'bytes' => $bytes];
};
$resPromises = [];
$exception = null;
$start = \microtime(true);
while ($part_num < $part_total_num) {
$writePromise = Tools::call($this->methodCallAsyncWrite($method, $callable($part_num), ['heavy' => true, 'file' => true, 'datacenter' => &$datacenter]));
if (!$seekable) {
yield $writePromise;
}
$writePromise->onResolve(function ($e, $readDeferred) use ($cb, $part_num, &$resPromises, &$exception): \Generator {
if ($e) {
$this->logger("Got exception while uploading: {$e}");
$exception = $e;
return;
}
$resPromises[] = $readDeferred->promise();
try {
// Wrote chunk!
if (!yield Tools::call($readDeferred->promise())) {
throw new \danog\MadelineProto\Exception('Upload of part '.$part_num.' failed');
}
// Got OK from server for chunk!
$cb();
} catch (\Throwable $e) {
$this->logger("Got exception while uploading: {$e}");
$exception = $e;
}
});
$promises[] = $writePromise;
++$part_num;
if (!($part_num % $parallel_chunks)) {
// By default, 10 mb at a time, for a typical bandwidth of 1gbps (run the code in this every second)
yield Tools::all($promises);
$promises = [];
if ($exception) {
throw $exception;
}
$time = \microtime(true) - $start;
$speed = (int) ($size * 8 / $time) / 1000000;
$this->logger->logger("Partial upload time: {$time}");
$this->logger->logger("Partial upload speed: {$speed} mbps");
}
}
yield all($promises);
yield all($resPromises);
$time = \microtime(true) - $start;
$speed = (int) ($size * 8 / $time) / 1000000;
$this->logger->logger("Total upload time: {$time}");
$this->logger->logger("Total upload speed: {$speed} mbps");
$constructor = ['_' => $constructor, 'id' => $file_id, 'parts' => $part_total_num, 'name' => $fileName, 'mime_type' => $mime];
if ($encrypted === true) {
$constructor['key_fingerprint'] = $fingerprint;
$constructor['key'] = $key;
$constructor['iv'] = $iv;
}
$constructor['md5_checksum'] = '';
//\hash_final($ctx);
return $constructor;
}
/**
* Reupload telegram file.
*
* @param mixed $media Telegram file
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
* @param boolean $encrypted Whether to encrypt file for secret chats
*
* @return \Generator<array>
*/
public function uploadFromTgfile($media, $cb = null, bool $encrypted = false): \Generator
{
if (\is_object($media) && $media instanceof FileCallbackInterface) {
$cb = $media;
$media = $media->getFile();
}
$media = (yield from $this->getDownloadInfo($media));
if (!isset($media['size'], $media['mime'])) {
throw new Exception('Wrong file provided!');
}
$size = $media['size'];
$mime = $media['mime'];
$chunk_size = 512 * 1024;
$bridge = new class($size, $chunk_size, $cb) {
/**
* Read promises.
*
* @var Deferred[]
*/
private $read = [];
/**
* Read promises (write lenth).
*
* @var int[]
*/
private $wrote = [];
/**
* Write promises.
*
* @var Deferred[]
*/
private $write = [];
/**
* Part size.
*
* @var int
*/
private $partSize;
/**
* Offset for callback.
*
* @var int
*/
private $offset = 0;
/**
* Callback.
*
* @var ?callable
*/
private $cb;
/**
* Constructor.
*
* @param integer $size Total file size
* @param integer $partSize Part size
* @param ?callable $cb Callback
*/
public function __construct(int $size, int $partSize, ?callable $cb)
{
for ($x = 0; $x < $size; $x += $partSize) {
$this->read[] = new Deferred();
$this->write[] = new Deferred();
$this->wrote[] = $size - $x < $partSize ? $size - $x : $partSize;
}
$this->partSize = $partSize;
$this->cb = $cb;
}
/**
* Read chunk.
*
* @param integer $offset Offset
* @param integer $size Chunk size
*
* @return Promise
*/
public function read(int $offset, int $size): Promise
{
$offset /= $this->partSize;
return $this->write[$offset]->promise();
}
/**
* Write chunk.
*
* @param string $data Data
* @param integer $offset Offset
*
* @return Promise
*/
public function write(string $data, int $offset): Promise
{
$offset /= $this->partSize;
$this->write[$offset]->resolve($data);
return $this->read[$offset]->promise();
}
/**
* Read callback, called when the chunk is read and fully resent.
*
* @param mixed ...$params Params to be passed to cb
*
* @return void
*/
public function callback(...$params): void
{
$offset = $this->offset++;
$this->read[$offset]->resolve($this->wrote[$offset]);
if ($this->cb) {
Tools::callFork(($this->cb)(...$params));
}
}
};
$reader = [$bridge, 'read'];
$writer = [$bridge, 'write'];
$cb = [$bridge, 'callback'];
$read = $this->uploadFromCallable($reader, $size, $mime, '', $cb, true, $encrypted);
$write = $this->downloadToCallable($media, $writer, null, true, 0, -1, $chunk_size);
[$res] = yield Tools::all([$read, $write]);
return $res;
}
private function genAllFile($media): \Generator
{
$res = [$this->TL->getConstructors()->findByPredicate($media['_'])['type'] => $media];
switch ($media['_']) {
case 'messageMediaPoll':
$res['Poll'] = $media['poll'];
$res['InputMedia'] = ['_' => 'inputMediaPoll', 'poll' => $res['Poll']];
if (isset($res['Poll']['quiz']) && $res['Poll']['quiz']) {
if (empty($media['results']['results'])) {
//quizzes need a correct answer
throw new \danog\MadelineProto\Exception('No poll results');
}
foreach ($media['results']['results'] as $answer) {
if ($answer['correct']) {
$res['InputMedia']['correct_answers'][] = $answer['option'];
}
}
}
if (isset($media['results']['solution'])) {
$res['InputMedia']['solution'] = $media['results']['solution'];
}
if (isset($media['results']['solution_entities'])) {
$res['InputMedia']['solution_entities'] = $media['results']['solution_entities'];
}
break;
case 'updateMessagePoll':
$res['Poll'] = $media['poll'];
$res['InputMedia'] = ['_' => 'inputMediaPoll', 'poll' => $res['Poll']];
$res['MessageMedia'] = ['_' => 'messageMediaPoll', 'poll' => $res['Poll'], 'results' => $media['results']];
if (isset($res['Poll']['quiz']) && $res['Poll']['quiz']) {
if (empty($media['results']['results'])) {
//quizzes need a correct answer
throw new \danog\MadelineProto\Exception('No poll results');
}
foreach ($media['results']['results'] as $answer) {
if ($answer['correct']) {
$res['InputMedia']['correct_answers'][] = $answer['option'];
}
}
}
if (isset($media['results']['solution'])) {
$res['InputMedia']['solution'] = $media['results']['solution'];
}
if (isset($media['results']['solution_entities'])) {
$res['InputMedia']['solution_entities'] = $media['results']['solution_entities'];
}
break;
case 'messageMediaPhoto':
if (!isset($media['photo']['access_hash'])) {
throw new \danog\MadelineProto\Exception('No access hash');
}
$res['Photo'] = $media['photo'];
$res['InputPhoto'] = ['_' => 'inputPhoto', 'id' => $media['photo']['id'], 'access_hash' => $media['photo']['access_hash'], 'file_reference' => yield from $this->referenceDatabase->getReference(ReferenceDatabase::PHOTO_LOCATION, $media['photo'])];
$res['InputMedia'] = ['_' => 'inputMediaPhoto', 'id' => $res['InputPhoto']];
if (isset($media['ttl_seconds'])) {
$res['InputMedia']['ttl_seconds'] = $media['ttl_seconds'];
}
break;
case 'messageMediaDocument':
if (!isset($media['document']['access_hash'])) {
throw new \danog\MadelineProto\Exception('No access hash');
}
$res['Document'] = $media['document'];
$res['InputDocument'] = ['_' => 'inputDocument', 'id' => $media['document']['id'], 'access_hash' => $media['document']['access_hash'], 'file_reference' => yield from $this->referenceDatabase->getReference(ReferenceDatabase::DOCUMENT_LOCATION, $media['document'])];
$res['InputMedia'] = ['_' => 'inputMediaDocument', 'id' => $res['InputDocument']];
if (isset($media['ttl_seconds'])) {
$res['InputMedia']['ttl_seconds'] = $media['ttl_seconds'];
}
break;
case 'messageMediaDice':
$res['InputMedia'] = ['_' => 'inputMediaDice', 'emoticon' => $media['emoticon']];
break;
case 'poll':
$res['InputMedia'] = ['_' => 'inputMediaPoll', 'poll' => $res['Poll']];
break;
case 'document':
if (!isset($media['access_hash'])) {
throw new \danog\MadelineProto\Exception('No access hash');
}
$res['InputDocument'] = ['_' => 'inputDocument', 'id' => $media['id'], 'access_hash' => $media['access_hash'], 'file_reference' => yield from $this->referenceDatabase->getReference(ReferenceDatabase::DOCUMENT_LOCATION, $media)];
$res['InputMedia'] = ['_' => 'inputMediaDocument', 'id' => $res['InputDocument']];
$res['MessageMedia'] = ['_' => 'messageMediaDocument', 'document' => $media];
break;
case 'photo':
if (!isset($media['access_hash'])) {
throw new \danog\MadelineProto\Exception('No access hash');
}
$res['InputPhoto'] = ['_' => 'inputPhoto', 'id' => $media['id'], 'access_hash' => $media['access_hash'], 'file_reference' => yield from $this->referenceDatabase->getReference(ReferenceDatabase::PHOTO_LOCATION, $media)];
$res['InputMedia'] = ['_' => 'inputMediaPhoto', 'id' => $res['InputPhoto']];
$res['MessageMedia'] = ['_' => 'messageMediaPhoto', 'photo' => $media];
break;
default:
throw new \danog\MadelineProto\Exception("Could not convert media object of type {$media['_']}");
}
return $res;
}
/**
* Get info about file.
*
* @param mixed $constructor File ID
*
* @return \Generator<array>
*/
public function getFileInfo($constructor): \Generator
{
if (\is_string($constructor)) {
$constructor = $this->unpackFileId($constructor);
if (isset($constructor['MessageMedia'])) {
$constructor = $constructor['MessageMedia'];
} elseif (isset($constructor['InputMedia'])) {
return $constructor;
} elseif (isset($constructor['Chat']) || isset($constructor['User'])) {
throw new Exception("Chat photo file IDs can't be reused to resend chat photos, please use getPwrChat()['photo'], instead");
}
}
switch ($constructor['_']) {
case 'updateNewMessage':
case 'updateNewChannelMessage':
case 'updateEditMessage':
case 'updateEditChannelMessage':
$constructor = $constructor['message'];
// no break
case 'message':
$constructor = $constructor['media'];
}
return yield from $this->genAllFile($constructor);
}
/**
* Get download info of the propic of a user
* Returns an array with the following structure:.
*
* `$info['ext']` - The file extension
* `$info['name']` - The file name, without the extension
* `$info['mime']` - The file mime type
* `$info['size']` - The file size
*
* @param mixed $messageMedia File ID
*
* @return \Generator<array>
*/
public function getPropicInfo($data): \Generator
{
return yield from $this->getDownloadInfo(yield $this->chats[(yield from $this->getInfo($data))['bot_api_id']]);
}
/**
* Extract file info from bot API message.
*
* @param array $info Bot API message object
*
* @return ?array
*/
public static function extractBotAPIFile(array $info): ?array
{
foreach (TYPES as $type) {
if (isset($info[$type]) && \is_array($info[$type])) {
$method = $type;
break;
}
}
if (!isset($method)) {
return null;
}
$info = $info[$method];
if ($method === 'photo') {
$info = $info[0];
}
$info['file_type'] = $method;
return $info;
}
/**
* Get download info of file
* Returns an array with the following structure:.
*
* `$info['ext']` - The file extension
* `$info['name']` - The file name, without the extension
* `$info['mime']` - The file mime type
* `$info['size']` - The file size
*
* @param mixed $messageMedia File ID
*
* @return \Generator<array>
*/
public function getDownloadInfo($messageMedia): \Generator
{
if (\is_string($messageMedia)) {
$messageMedia = $this->unpackFileId($messageMedia);
if (isset($messageMedia['InputFileLocation'])) {
return $messageMedia;
}
$messageMedia = $messageMedia['MessageMedia'] ?? $messageMedia['User'] ?? $messageMedia['Chat'];
}
if (!isset($messageMedia['_'])) {
if (!isset($messageMedia['InputFileLocation']) && !isset($messageMedia['file_id'])) {
$messageMedia = self::extractBotAPIFile($messageMedia) ?? $messageMedia;
}
if (isset($messageMedia['file_id'])) {
$res = yield from $this->getDownloadInfo($messageMedia['file_id']);
$res['size'] = $messageMedia['file_size'] ?? 0;
$res['mime'] = $messageMedia['mime_type'] ?? 'application/octet-stream';
$pathinfo = \pathinfo($messageMedia['file_name']);
if (isset($pathinfo['extension'])) {
$res['ext'] = '.'.$pathinfo['extension'];
}
$res['name'] = $pathinfo['filename'];
return $res;
}
return $messageMedia;
}
$res = [];
switch ($messageMedia['_']) {
// Updates
case 'updateNewMessage':
case 'updateNewChannelMessage':
$messageMedia = $messageMedia['message'];
// no break
case 'message':
return yield from $this->getDownloadInfo($messageMedia['media']);
case 'updateNewEncryptedMessage':
$messageMedia = $messageMedia['message'];
// Secret media
// no break
case 'encryptedMessage':
if ($messageMedia['decrypted_message']['media']['_'] === 'decryptedMessageMediaExternalDocument') {
return yield from $this->getDownloadInfo($messageMedia['decrypted_message']['media']);
}
$res['InputFileLocation'] = ['_' => 'inputEncryptedFileLocation', 'id' => $messageMedia['file']['id'], 'access_hash' => $messageMedia['file']['access_hash'], 'dc_id' => $messageMedia['file']['dc_id']];
$res['size'] = $messageMedia['decrypted_message']['media']['size'];
$res['key_fingerprint'] = $messageMedia['file']['key_fingerprint'];
$res['key'] = $messageMedia['decrypted_message']['media']['key'];
$res['iv'] = $messageMedia['decrypted_message']['media']['iv'];
if (isset($messageMedia['decrypted_message']['media']['file_name'])) {
$pathinfo = \pathinfo($messageMedia['decrypted_message']['media']['file_name']);
if (isset($pathinfo['extension'])) {
$res['ext'] = '.'.$pathinfo['extension'];
}
$res['name'] = $pathinfo['filename'];
}
if (isset($messageMedia['decrypted_message']['media']['mime_type'])) {
$res['mime'] = $messageMedia['decrypted_message']['media']['mime_type'];
} elseif ($messageMedia['decrypted_message']['media']['_'] === 'decryptedMessageMediaPhoto') {
$res['mime'] = 'image/jpeg';
}
if (isset($messageMedia['decrypted_message']['media']['attributes'])) {
foreach ($messageMedia['decrypted_message']['media']['attributes'] as $attribute) {
switch ($attribute['_']) {
case 'documentAttributeFilename':
$pathinfo = \pathinfo($attribute['file_name']);
if (isset($pathinfo['extension'])) {
$res['ext'] = '.'.$pathinfo['extension'];
}
$res['name'] = $pathinfo['filename'];
break;
case 'documentAttributeAudio':
$audio = $attribute;
break;
}
}
}
if (isset($audio) && isset($audio['title']) && !isset($res['name'])) {
$res['name'] = $audio['title'];
if (isset($audio['performer'])) {
$res['name'] .= ' - '.$audio['performer'];
}
}
if (!isset($res['ext']) || $res['ext'] === '') {
$res['ext'] = $this->getExtensionFromLocation($res['InputFileLocation'], $this->getExtensionFromMime($res['mime'] ?? 'image/jpeg'));
}
if (!isset($res['mime']) || $res['mime'] === '') {
$res['mime'] = $this->getMimeFromExtension($res['ext'], 'image/jpeg');
}
if (!isset($res['name']) || $res['name'] === '') {
$res['name'] = Tools::unpackSignedLongString($messageMedia['file']['access_hash']);
}
return $res;
// Wallpapers
case 'wallPaper':
return $this->getDownloadInfo($messageMedia['document']);
// Photos
case 'photo':
case 'messageMediaPhoto':
if ($messageMedia['_'] == 'photo') {
$messageMedia = ['_' => 'messageMediaPhoto', 'photo' => $messageMedia, 'ttl_seconds' => 0];
}
$res['MessageMedia'] = $messageMedia;
$messageMedia = $messageMedia['photo'];
$size = Tools::maxSize($messageMedia['sizes']);
$res = \array_merge($res, yield from $this->getDownloadInfo($size));
$res['InputFileLocation'] = ['_' => 'inputPhotoFileLocation', 'thumb_size' => $res['thumb_size'] ?? 'x', 'dc_id' => $messageMedia['dc_id'], 'access_hash' => $messageMedia['access_hash'], 'id' => $messageMedia['id'], 'file_reference' => yield from $this->referenceDatabase->getReference(ReferenceDatabase::PHOTO_LOCATION, $messageMedia)];
return $res;
case 'user':
case 'folder':
case 'channel':
case 'chat':
case 'updateUserPhoto':
$res = (yield from $this->getDownloadInfo($messageMedia['photo']));
if (\is_array($messageMedia) && ($messageMedia['min'] ?? false) && isset($messageMedia['access_hash'])) {
// bot API file ID
$messageMedia['min'] = false;
$peer = $this->genAll($messageMedia)['InputPeer'];
} else {
$peer = (yield from $this->getInfo($messageMedia))['InputPeer'];
}
$res['InputFileLocation'] = ['_' => 'inputPeerPhotoFileLocation', 'big' => $res['big'], 'dc_id' => $res['InputFileLocation']['dc_id'], 'peer' => $peer, 'volume_id' => $res['InputFileLocation']['volume_id'], 'local_id' => $res['InputFileLocation']['local_id']];
return $res;
case 'userProfilePhoto':
case 'chatPhoto':
$size = $messageMedia['photo_big'] ?? $messageMedia['photo_small'];
$res = (yield from $this->getDownloadInfo($size));
$res['big'] = isset($messageMedia['photo_big']);
$res['InputFileLocation']['dc_id'] = $messageMedia['dc_id'];
return $res;
case 'photoStrippedSize':
$res['size'] = \strlen($messageMedia['bytes']['bytes'] ?? $messageMedia['bytes']);
$res['data'] = $messageMedia['bytes'];
$res['thumb_size'] = 'JPG';
return $res;
case 'photoCachedSize':
$res['size'] = \strlen($messageMedia['bytes']);
$res['data'] = $messageMedia['bytes'];
//$res['thumb_size'] = $res['data'];
$res['thumb_size'] = $messageMedia['type'];
if ($messageMedia['location']['_'] === 'fileLocationUnavailable') {
$res['name'] = Tools::unpackSignedLongString($messageMedia['volume_id']).'_'.$messageMedia['local_id'];
$res['mime'] = $this->getMimeFromBuffer($res['data']);
$res['ext'] = $this->getExtensionFromMime($res['mime']);
} else {
$res = \array_merge($res, yield from $this->getDownloadInfo($messageMedia['location']));
}
return $res;
case 'photoSize':
$res = (yield from $this->getDownloadInfo($messageMedia['location']));
$res['thumb_size'] = $messageMedia['type'];
//$res['thumb_size'] = $size;
if (isset($messageMedia['size'])) {
$res['size'] = $messageMedia['size'];
}
return $res;
case 'fileLocationUnavailable':
throw new \danog\MadelineProto\Exception('File location unavailable');
case 'fileLocation':
$res['name'] = Tools::unpackSignedLongString($messageMedia['volume_id']).'_'.$messageMedia['local_id'];
$res['InputFileLocation'] = ['_' => 'inputFileLocation', 'volume_id' => $messageMedia['volume_id'], 'local_id' => $messageMedia['local_id'], 'secret' => $messageMedia['secret'], 'dc_id' => $messageMedia['dc_id'], 'file_reference' => yield from $this->referenceDatabase->getReference(ReferenceDatabase::PHOTO_LOCATION_LOCATION, $messageMedia)];
$res['ext'] = $this->getExtensionFromLocation($res['InputFileLocation'], '.jpg');
$res['mime'] = $this->getMimeFromExtension($res['ext'], 'image/jpeg');
return $res;
case 'fileLocationToBeDeprecated':
$res['name'] = Tools::unpackSignedLongString($messageMedia['volume_id']).'_'.$messageMedia['local_id'];
$res['ext'] = '.jpg';
$res['mime'] = $this->getMimeFromExtension($res['ext'], 'image/jpeg');
$res['InputFileLocation'] = [
'_' => 'inputFileLocationTemp',
// Will be overwritten
'volume_id' => $messageMedia['volume_id'],
'local_id' => $messageMedia['local_id'],
];
return $res;
// Documents
case 'decryptedMessageMediaExternalDocument':
case 'document':
$messageMedia = ['_' => 'messageMediaDocument', 'ttl_seconds' => 0, 'document' => $messageMedia];
// no break
case 'messageMediaDocument':
$res['MessageMedia'] = $messageMedia;
foreach ($messageMedia['document']['attributes'] as $attribute) {
switch ($attribute['_']) {
case 'documentAttributeFilename':
$pathinfo = \pathinfo($attribute['file_name']);
if (isset($pathinfo['extension'])) {
$res['ext'] = '.'.$pathinfo['extension'];
}
$res['name'] = $pathinfo['filename'];
break;
case 'documentAttributeAudio':
$audio = $attribute;
break;
}
}
if (isset($audio) && isset($audio['title']) && !isset($res['name'])) {
$res['name'] = $audio['title'];
if (isset($audio['performer'])) {
$res['name'] .= ' - '.$audio['performer'];
}
}
$res['InputFileLocation'] = ['_' => 'inputDocumentFileLocation', 'id' => $messageMedia['document']['id'], 'access_hash' => $messageMedia['document']['access_hash'], 'version' => isset($messageMedia['document']['version']) ? $messageMedia['document']['version'] : 0, 'dc_id' => $messageMedia['document']['dc_id'], 'file_reference' => yield from $this->referenceDatabase->getReference(ReferenceDatabase::DOCUMENT_LOCATION, $messageMedia['document'])];
if (!isset($res['ext']) || $res['ext'] === '') {
$res['ext'] = $this->getExtensionFromLocation($res['InputFileLocation'], $this->getExtensionFromMime($messageMedia['document']['mime_type']));
}
if (!isset($res['name']) || $res['name'] === '') {
$res['name'] = Tools::unpackSignedLongString($messageMedia['document']['access_hash']);
}
if (isset($messageMedia['document']['size'])) {
$res['size'] = $messageMedia['document']['size'];
}
$res['name'] .= '_'.Tools::unpackSignedLongString($messageMedia['document']['id']);
$res['mime'] = $messageMedia['document']['mime_type'];
return $res;
default:
throw new \danog\MadelineProto\Exception('Invalid constructor provided: '.$messageMedia['_']);
}
}
/**
* Download file to directory.
*
* @param mixed $messageMedia File to download
* @param string|FileCallbackInterface $dir Directory where to download the file
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
*
* @return \Generator<string> Downloaded file path
*/
public function downloadToDir($messageMedia, $dir, $cb = null): \Generator
{
if (\is_object($dir) && $dir instanceof FileCallbackInterface) {
$cb = $dir;
$dir = $dir->getFile();
}
$messageMedia = (yield from $this->getDownloadInfo($messageMedia));
return yield from $this->downloadToFile($messageMedia, $dir.'/'.$messageMedia['name'].$messageMedia['ext'], $cb);
}
/**
* Download file.
*
* @param mixed $messageMedia File to download
* @param string|FileCallbackInterface $file Downloaded file path
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
*
* @return \Generator<string> Downloaded file path
*/
public function downloadToFile($messageMedia, $file, $cb = null): \Generator
{
if (\is_object($file) && $file instanceof FileCallbackInterface) {
$cb = $file;
$file = $file->getFile();
}
$file = Tools::absolute(\preg_replace('|/+|', '/', $file));
if (!yield exists($file)) {
yield \touch($file);
}
$file = \realpath($file);
$messageMedia = (yield from $this->getDownloadInfo($messageMedia));
StatCacheAsync::clear($file);
$size = (yield statAsync($file))['size'];
$stream = yield open($file, 'cb');
$this->logger->logger('Waiting for lock of file to download...');
$unlock = yield Tools::flock($file, LOCK_EX);
$this->logger->logger('Got lock of file to download');
try {
yield from $this->downloadToStream($messageMedia, $stream, $cb, $size, -1);
} finally {
$unlock();
yield $stream->close();
StatCacheAsync::clear($file);
}
return $file;
}
/**
* Download file to callable.
* The callable must accept two parameters: string $payload, int $offset
* The callable will be called (possibly out of order, depending on the value of $seekable).
* The callable should return the number of written bytes.
*
* @param mixed $messageMedia File to download
* @param callable|FileCallbackInterface $callable Chunk callback
* @param callable $cb Status callback (DEPRECATED, use FileCallbackInterface)
* @param bool $seekable Whether the callable can be called out of order
* @param int $offset Offset where to start downloading
* @param int $end Offset where to stop downloading (inclusive)
* @param int $part_size Size of each chunk
*
* @return \Generator<bool>
*/
public function downloadToCallable($messageMedia, callable $callable, $cb = null, bool $seekable = true, int $offset = 0, int $end = -1, int $part_size = null): \Generator
{
$messageMedia = (yield from $this->getDownloadInfo($messageMedia));
if (\is_object($callable) && $callable instanceof FileCallbackInterface) {
$cb = $callable;
$callable = $callable->getFile();
}
if (!\is_callable($callable)) {
throw new Exception('Wrong callable provided');
}
if ($cb === null) {
$cb = function ($percent) {
$this->logger->logger('Download status: '.$percent.'%', \danog\MadelineProto\Logger::NOTICE);
};
}
if ($end === -1 && isset($messageMedia['size'])) {
$end = $messageMedia['size'];
}
$part_size = $part_size ?? 1024 * 1024;
$parallel_chunks = $this->settings->getFiles()->getDownloadParallelChunks();
$datacenter = $messageMedia['InputFileLocation']['dc_id'] ?? $this->settings->getDefaultDc();
if ($this->datacenter->has($datacenter.'_media')) {
$datacenter .= '_media';
}
if (isset($messageMedia['key'])) {
$digest = \hash('md5', $messageMedia['key'].$messageMedia['iv'], true);
$fingerprint = Tools::unpackSignedInt(\substr($digest, 0, 4) ^ \substr($digest, 4, 4));
if ($fingerprint !== $messageMedia['key_fingerprint']) {
throw new \danog\MadelineProto\Exception('Fingerprint mismatch!');
}
$ige = new AES('ige');
$ige->setIV($messageMedia['iv']);
$ige->setKey($messageMedia['key']);
$ige->enableContinuousBuffer();
$seekable = false;
}
if ($offset === $end) {
$cb(100, 0, 0);
return true;
}
$params = [];
$start_at = $offset % $part_size;
$probable_end = $end !== -1 ? $end : 512 * 1024 * 4000;
$breakOut = false;
for ($x = $offset - $start_at; $x < $probable_end; $x += $part_size) {
$end_at = $part_size;
if ($end !== -1 && $x + $part_size > $end) {
$end_at = $end % $part_size;
$breakOut = true;
}
$params[] = ['offset' => $x, 'limit' => $part_size, 'part_start_at' => $start_at, 'part_end_at' => $end_at];
$start_at = 0;
if ($breakOut) {
break;
}
}
if (!$params) {
$cb(100, 0, 0);
return true;
}
$count = \count($params);
$time = 0;
$speed = 0;
$origCb = $cb;
$cb = static function () use ($cb, $count, &$time, &$speed) {
static $cur = 0;
$cur++;
Tools::callFork($cb($cur * 100 / $count, $time, $speed));
};
$cdn = false;
$params[0]['previous_promise'] = new Success(true);
$start = \microtime(true);
$old_dc = null;
$size = yield from $this->downloadPart($messageMedia, $cdn, $datacenter, $old_dc, $ige, $cb, $initParam = \array_shift($params), $callable, $seekable);
if ($initParam['part_end_at'] - $initParam['part_start_at'] !== $size) {
// Premature end for undefined length files
$origCb(100, 0, 0);
return true;
}
$parallel_chunks = $seekable ? $parallel_chunks : 1;
if ($params) {
$previous_promise = new Success(true);
$promises = [];
foreach ($params as $key => $param) {
$param['previous_promise'] = $previous_promise;
$previous_promise = Tools::call($this->downloadPart($messageMedia, $cdn, $datacenter, $old_dc, $ige, $cb, $param, $callable, $seekable));
$previous_promise->onResolve(static function ($e, $res) use (&$size) {
if ($res) {
$size += $res;
}
});
$promises[] = $previous_promise;
if (!($key % $parallel_chunks)) {
// 20 mb at a time, for a typical bandwidth of 1gbps
$res = yield Tools::all($promises);
$promises = [];
foreach ($res as $r) {
if (!$r) {
break 2;
}
}
$time = \microtime(true) - $start;
$speed = (int) ($size * 8 / $time) / 1000000;
$this->logger->logger("Partial download time: {$time}");
$this->logger->logger("Partial download speed: {$speed} mbps");
}
}
if ($promises) {
yield Tools::all($promises);
}
}
$time = \microtime(true) - $start;
$speed = (int) ($size * 8 / $time) / 1000000;
$this->logger->logger("Total download time: {$time}");
$this->logger->logger("Total download speed: {$speed} mbps");
if ($cdn) {
$this->clearCdnHashes($messageMedia['file_token']);
}
if (!isset($messageMedia['size'])) {
$origCb(100, $time, $speed);
}
return true;
}
/**
* Download file part.
*
* @param array $messageMedia File object
* @param bool $cdn Whether this is a CDN file
* @param string $datacenter DC ID
* @param string $old_dc Previous DC ID
* @param AES $ige IGE decryptor instance
* @param callable $cb Status callback
* @param array $offset Offset
* @param callable $callable Chunk callback
* @param boolean $seekable Whether the download file is seekable
* @param boolean $postpone Whether to postpone method call
*
* @return \Generator
*/
private function downloadPart(&$messageMedia, bool &$cdn, &$datacenter, &$old_dc, &$ige, $cb, array $offset, $callable, bool $seekable, bool $postpone = false): \Generator
{
static $method = [
false => 'upload.getFile',
// non-cdn
true => 'upload.getCdnFile',
];
do {
if (!$cdn) {
$basic_param = ['location' => $messageMedia['InputFileLocation']];
} else {
$basic_param = ['file_token' => $messageMedia['file_token']];
}
//$x = 0;
while (true) {
try {
$res = yield from $this->methodCallAsyncRead($method[$cdn], $basic_param + $offset, ['heavy' => true, 'file' => true, 'FloodWaitLimit' => 0, 'datacenter' => &$datacenter, 'postpone' => $postpone]);
break;
} catch (\danog\MadelineProto\RPCErrorException $e) {
if (\strpos($e->rpc, 'FLOOD_WAIT_') === 0) {
yield Tools::sleep(1);
continue;
}
switch ($e->rpc) {
case 'FILE_TOKEN_INVALID':
$cdn = false;
continue 3;
default:
throw $e;
}
}
}
if ($res['_'] === 'upload.fileCdnRedirect') {
$cdn = true;
$messageMedia['file_token'] = $res['file_token'];
$messageMedia['cdn_key'] = $res['encryption_key'];
$messageMedia['cdn_iv'] = $res['encryption_iv'];
$old_dc = $datacenter;
$datacenter = $res['dc_id'].'_cdn';
if (!$this->datacenter->has($datacenter)) {
$this->config['expires'] = -1;
yield from $this->getConfig([], ['datacenter' => $this->datacenter->curdc]);
}
$this->logger->logger(\danog\MadelineProto\Lang::$current_lang['stored_on_cdn'], \danog\MadelineProto\Logger::NOTICE);
} elseif ($res['_'] === 'upload.cdnFileReuploadNeeded') {
$this->logger->logger(\danog\MadelineProto\Lang::$current_lang['cdn_reupload'], \danog\MadelineProto\Logger::NOTICE);
yield from $this->getConfig([], ['datacenter' => $this->datacenter->curdc]);
try {
$this->addCdnHashes($messageMedia['file_token'], yield from $this->methodCallAsyncRead('upload.reuploadCdnFile', ['file_token' => $messageMedia['file_token'], 'request_token' => $res['request_token']], ['heavy' => true, 'datacenter' => $old_dc]));
} catch (\danog\MadelineProto\RPCErrorException $e) {
switch ($e->rpc) {
case 'FILE_TOKEN_INVALID':
case 'REQUEST_TOKEN_INVALID':
$cdn = false;
continue 2;
default:
throw $e;
}
}
continue;
}
$res['bytes'] = (string) $res['bytes'];
if ($cdn === false && $res['type']['_'] === 'storage.fileUnknown' && $res['bytes'] === '') {
$datacenter = 0;
}
while ($cdn === false && $res['type']['_'] === 'storage.fileUnknown' && $res['bytes'] === '' && $this->datacenter->has(++$datacenter)) {
$res = yield from $this->methodCallAsyncRead('upload.getFile', $basic_param + $offset, ['heavy' => true, 'file' => true, 'FloodWaitLimit' => 0, 'datacenter' => $datacenter]);
}
if ($res['bytes'] === '') {
return 0;
}
if (isset($messageMedia['cdn_key'])) {
$ivec = \substr($messageMedia['cdn_iv'], 0, 12).\pack('N', $offset['offset'] >> 4);
$res['bytes'] = Crypt::ctrEncrypt($res['bytes'], $messageMedia['cdn_key'], $ivec);
$this->checkCdnHash($messageMedia['file_token'], $offset['offset'], $res['bytes'], $old_dc);
}
if (isset($messageMedia['key'])) {
$res['bytes'] = $ige->decrypt($res['bytes']);
}
if ($offset['part_start_at'] || $offset['part_end_at'] !== $offset['limit']) {
$res['bytes'] = \substr($res['bytes'], $offset['part_start_at'], $offset['part_end_at'] - $offset['part_start_at']);
}
if (!$seekable) {
yield $offset['previous_promise'];
}
$res = yield $callable($res['bytes'], $offset['offset'] + $offset['part_start_at']);
$cb();
return $res;
} while (true);
}
private $cdn_hashes = [];
private function addCdnHashes($file, $hashes)
{
if (!isset($this->cdn_hashes[$file])) {
$this->cdn_hashes = [];
}
foreach ($hashes as $hash) {
$this->cdn_hashes[$file][$hash['offset']] = ['limit' => $hash['limit'], 'hash' => (string) $hash['hash']];
}
}
private function checkCdnHash($file, $offset, $data, &$datacenter): \Generator
{
while (\strlen($data)) {
if (!isset($this->cdn_hashes[$file][$offset])) {
$this->addCdnHashes($file, yield from $this->methodCallAsyncRead('upload.getCdnFileHashes', ['file_token' => $file, 'offset' => $offset], ['datacenter' => $datacenter]));
}
if (!isset($this->cdn_hashes[$file][$offset])) {
throw new \danog\MadelineProto\Exception('Could not fetch CDN hashes for offset '.$offset);
}
if (\hash('sha256', \substr($data, 0, $this->cdn_hashes[$file][$offset]['limit']), true) !== $this->cdn_hashes[$file][$offset]['hash']) {
throw new \danog\MadelineProto\SecurityException('CDN hash mismatch for offset '.$offset);
}
$data = \substr($data, $this->cdn_hashes[$file][$offset]['limit']);
$offset += $this->cdn_hashes[$file][$offset]['limit'];
}
return true;
}
private function clearCdnHashes($file)
{
unset($this->cdn_hashes[$file]);
return true;
}
}