danog/MadelineProto
1
0
Fork 0
mirror of https://github.com/danog/MadelineProto.git synced 2024-11-27 08:14:39 +01:00
Code Issues Projects Releases Wiki Activity
0295968f96
MadelineProto/tools/DocsBuilder/Constructors.php
Daniil Gentili 6b5ba25354 Move around files
2023-12-24 15:15:09 +01:00

256 lines
14 KiB
PHP
Raw Blame History

<?php
declare(strict_types=1);
/**
* Constructors 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-2023 Daniil Gentili <daniil@daniil.it>
* @license https://opensource.org/licenses/AGPL-3.0 AGPLv3
* @link https://docs.madelineproto.xyz MadelineProto documentation
*/
namespace danog\MadelineProto\DocsBuilder;
use danog\MadelineProto\Lang;
use danog\MadelineProto\Logger;
use danog\MadelineProto\Tools;
use const PHP_EOL;
/**
* @internal This garbage code needs to be thrown away completely and rewritten from scratch.
*/
trait Constructors
{
private array $docs_constructors;
public function mkConstructors(): void
{
foreach (glob('constructors/'.$this->any) as $unlink) {
unlink($unlink);
}
if (file_exists('constructors')) {
rmdir('constructors');
}
mkdir('constructors');
$this->docs_constructors = [];
$this->logger->logger('Generating constructors documentation...', Logger::NOTICE);
$got = [];
foreach ($this->TL->getConstructors()->by_predicate_and_layer as $predicate => $id) {
$data = $this->TL->getConstructors()->by_id[$id];
if (isset($got[$id])) {
$data['layer'] = '';
}
$got[$id] = '';
$layer = isset($data['layer']) && $data['layer'] !== '' ? '_'.$data['layer'] : '';
$type = $data['type'];
$constructor = $data['predicate'];
$php_type = Tools::typeEscape($type);
$php_constructor = Tools::typeEscape($constructor);
if (!isset($this->types[$php_type])) {
$this->types[$php_type] = ['constructors' => [], 'methods' => []];
}
if (!\in_array($data, $this->types[$php_type]['constructors'], true)) {
$this->types[$php_type]['constructors'][] = $data;
}
$params = '';
foreach ($data['params'] as $param) {
if ($param['type'] === 'strlong') {
$param['type'] = 'long';
}
if (\in_array($param['name'], ['flags', 'flags2', 'random_id', 'random_bytes'], true)) {
continue;
}
if ($param['name'] === 'peer' && $param['type'] === 'Peer') {
$param['type'] = 'long';
}
if ($type === 'EncryptedMessage' && $param['name'] === 'bytes' && !isset($this->settings['td'])) {
$param['name'] = 'decrypted_message';
$param['type'] = 'DecryptedMessage';
}
$type_or_subtype = isset($param['subtype']) ? 'subtype' : 'type';
$type_or_bare_type = ctype_upper(Tools::end(explode('.', $param[$type_or_subtype]))[0]) || \in_array($param[$type_or_subtype], ['!X', 'X', 'bytes', 'true', 'false', 'double', 'string', 'Bool', 'int53', 'int', 'long', 'int128', 'int256', 'int512'], true) ? 'types' : 'constructors';
$param[$type_or_subtype] = str_replace(['true', 'false'], ['Bool', 'Bool'], $param[$type_or_subtype]);
if (preg_match('/%/', $param[$type_or_subtype])) {
$param[$type_or_subtype] = $this->TL->getConstructors()->findByType(str_replace('%', '', $param[$type_or_subtype]))['predicate'];
}
if (substr($param[$type_or_subtype], -1) === '>') {
$param[$type_or_subtype] = substr($param[$type_or_subtype], 0, -1);
}
$params .= "'".$param['name']."' => ";
$param[$type_or_subtype] = '['.self::markdownEscape($param[$type_or_subtype]).'](/API_docs/'.$type_or_bare_type.'/'.$param[$type_or_subtype].'.md)';
$params .= (isset($param['subtype']) ? '\\['.$param[$type_or_subtype].'\\]' : $param[$type_or_subtype]).', ';
}
$md_constructor = self::markdownEscape($constructor.$layer);
$this->docs_constructors[$constructor] = '[$'.$md_constructor.'](/API_docs/constructors/'.$php_constructor.$layer.'.md) = \\['.$params.'\\];<a name="'.$constructor.$layer.'"></a>
';
$table = empty($data['params']) ? '' : '### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
';
if (!isset($this->TL->getDescriptionsRef()['constructors'][$constructor])) {
$this->addToLang('object_'.$constructor);
if (Lang::$lang['en']['object_'.$constructor] !== '') {
/** @psalm-suppress InvalidArrayAssignment */
$this->TL->getDescriptionsRef()['constructors'][$constructor]['description'] = Lang::$lang['en']['object_'.$constructor];
}
}
if (isset($this->TL->getDescriptionsRef()['constructors'][$constructor]) && !empty($data['params'])) {
$table = '### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
';
}
$params = '';
$lua_params = '';
$pwr_params = '';
$hasreplymarkup = false;
$hasentities = false;
foreach ($data['params'] as $param) {
if ($param['type'] === 'strlong') {
$param['type'] = 'long';
}
if (\in_array($param['name'], ['flags', 'flags2', 'random_id', 'random_bytes'], true)) {
continue;
}
if ($type === 'EncryptedMessage' && $param['name'] === 'bytes' && !isset($this->settings['td'])) {
$param['name'] = 'decrypted_message';
$param['type'] = 'DecryptedMessage';
}
if ($param['name'] === 'peer' && $param['type'] === 'Peer') {
$param['type'] = 'long';
}
if ($type === 'DecryptedMessageMedia' && \in_array($param['name'], ['key', 'iv'], true)) {
unset(Lang::$lang['en']['object_'.$constructor.'_param_'.$param['name'].'_type_'.$param['type']]);
continue;
}
$ptype = $param[isset($param['subtype']) ? 'subtype' : 'type'];
if (preg_match('/%/', $ptype)) {
$ptype = $this->TL->getConstructors()->findByType(str_replace('%', '', $ptype))['predicate'];
}
$type_or_bare_type = (ctype_upper(Tools::end(explode('_', $ptype))[0]) || \in_array($ptype, ['!X', 'X', 'bytes', 'true', 'false', 'double', 'string', 'Bool', 'int53', 'int', 'long', 'int128', 'int256', 'int512'], true)) && $ptype !== 'MTmessage' ? 'types' : 'constructors';
if (substr($ptype, -1) === '>') {
$ptype = substr($ptype, 0, -1);
}
switch ($ptype) {
case 'true':
case 'false':
$ptype = 'Bool';
}
$human_ptype = $ptype;
if (str_starts_with($type, 'Input') && \in_array($ptype, ['User', 'InputUser', 'Chat', 'InputChannel', 'Peer', 'InputPeer'], true) && !isset($this->settings['td'])) {
$human_ptype = 'Username, chat ID, Update, Message or '.$ptype;
}
if (str_starts_with($type, 'Input') && \in_array($ptype, ['InputMedia', 'InputDocument', 'InputPhoto'], true) && !isset($this->settings['td'])) {
$human_ptype = 'MessageMedia, Message, Update or '.$ptype;
}
if (\in_array($ptype, ['InputMessage'], true) && !isset($this->settings['td'])) {
$human_ptype = 'Message ID or '.$ptype;
}
if (\in_array($ptype, ['InputEncryptedChat'], true) && !isset($this->settings['td'])) {
$human_ptype = 'Secret chat ID, Update, EncryptedMessage or '.$ptype;
}
if (\in_array($ptype, ['InputFile'], true) && !isset($this->settings['td'])) {
$human_ptype = 'File path or '.$ptype;
}
if (\in_array($ptype, ['InputEncryptedFile'], true) && !isset($this->settings['td'])) {
$human_ptype = 'File path or '.$ptype;
}
$table .= '|'.self::markdownEscape($param['name']).'|'.(isset($param['subtype']) ? 'Array of ' : '').'['.self::markdownEscape($human_ptype).'](/API_docs/'.$type_or_bare_type.'/'.$ptype.'.md) | '.(isset($param['pow']) || $this->TL->getConstructors()->findByPredicate(lcfirst($param['type']).'Empty') || $data['type'] === 'InputMedia' && $param['name'] === 'mime_type' || $data['type'] === 'DocumentAttribute' && \in_array($param['name'], ['w', 'h', 'duration'], true) ? 'Optional' : 'Yes').'|';
if (!isset($this->TL->getDescriptionsRef()['constructors'][$constructor]['params'][$param['name']])) {
$this->addToLang('object_'.$constructor.'_param_'.$param['name'].'_type_'.$param['type']);
if (isset($this->TL->getDescriptionsRef()['constructors'][$constructor]['description'])) {
/** @psalm-suppress InvalidArrayAssignment */
$this->TL->getDescriptionsRef()['constructors'][$constructor]['params'][$param['name']] = Lang::$lang['en']['object_'.$constructor.'_param_'.$param['name'].'_type_'.$param['type']];
}
}
if (isset($this->TL->getDescriptionsRef()['constructors'][$constructor]['params'][$param['name']]) && $this->TL->getDescriptionsRef()['constructors'][$constructor]['params'][$param['name']]) {
$table .= $this->TL->getDescriptionsRef()['constructors'][$constructor]['params'][$param['name']].'|';
}
$table .= PHP_EOL;
$pptype = \in_array($ptype, ['string', 'bytes'], true) ? "'".$ptype."'" : $ptype;
$ppptype = \in_array($ptype, ['string'], true) ? '"'.$ptype.'"' : $ptype;
$ppptype = \in_array($ptype, ['bytes'], true) ? '{"_": "bytes", "bytes":"base64 encoded '.$ptype.'"}' : $ppptype;
$params .= ", '".$param['name']."' => ";
$params .= isset($param['subtype']) ? '['.$pptype.', '.$pptype.']' : $pptype;
$lua_params .= ', '.$param['name'].'=';
$lua_params .= isset($param['subtype']) ? '{'.$pptype.'}' : $pptype;
$pwr_params .= ', "'.$param['name'].'": '.(isset($param['subtype']) ? '['.$ppptype.']' : $ppptype);
if ($param['name'] === 'reply_markup') {
$hasreplymarkup = true;
}
if ($param['name'] === 'entities') {
$hasentities = true;
$table .= '|parse\\_mode| [string](/API_docs/types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional |
';
$params .= "parse_mode: 'string', ";
$lua_params .= "parseMode='string', ";
$pwr_params = "parseMode - string\n";
}
}
$params = "['_' => '".$constructor."'".$params.']';
$lua_params = "{_='".$constructor."'".$lua_params.'}';
$pwr_params = '{"_": "'.$constructor.'"'.$pwr_params.'}';
$description = isset($this->TL->getDescriptionsRef()['constructors'][$constructor]) ? $this->TL->getDescriptionsRef()['constructors'][$constructor]['description'] : $constructor.' attributes, type and example';
$symFile = str_replace('.', '_', $constructor.$layer);
$redir = $symFile !== $constructor.$layer ? "\nredirect_from: /API_docs/constructors/{$symFile}.html" : '';
$description = str_replace('"', "'", Tools::toString(rtrim(explode("\n", $description)[0], ':')));
$header = '---
title: "'.$constructor.'"
description: "'.$description.'"
nav_exclude: true
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png'.$redir.'
---
# Constructor: '.self::markdownEscape($constructor.$layer).'
[Back to constructors index](/API_docs/constructors/index.md)
';
$table .= '
';
if (isset($this->TL->getDescriptionsRef()['constructors'][$constructor])) {
$header .= $this->TL->getDescriptionsRef()['constructors'][$constructor]['description'].PHP_EOL.PHP_EOL;
}
$type = '### Type: ['.self::markdownEscape($php_type).'](/API_docs/types/'.$php_type.'.md)
';
$example = '';
if (!isset($this->settings['td'])) {
if ($hasreplymarkup) {
$example = $this->template('reply_markup');
}
if ($hasentities) {
$example = $this->template('parse_mode');
}
$example .= $this->template('constructor-example', str_replace('.', '_', $constructor.$layer), $params, $lua_params);
}
file_put_contents('constructors/'.$constructor.$layer.'.md', $header.$table.$type.$example);
}
$this->logger->logger('Generating constructors index...', Logger::NOTICE);
ksort($this->docs_constructors);
$last_namespace = '';
foreach ($this->docs_constructors as $constructor => &$value) {
$new_namespace = preg_replace('/_.*/', '', $constructor);
$br = $new_namespace != $last_namespace ? "***\n<br><br>" : '';
$value = $br.$value;
$last_namespace = $new_namespace;
}
file_put_contents('constructors/'.$this->index, $this->template('constructors-index', implode('', $this->docs_constructors)));
}
}
Reference in New Issue View Git Blame Copy Permalink