. * * @author Daniil Gentili * @copyright 2016-2020 Daniil Gentili * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 * * @link https://docs.madelineproto.xyz MadelineProto documentation */ namespace danog\MadelineProto; use danog\MadelineProto\Settings\TLSchema; use danog\MadelineProto\TL\TL; // This code was written a few years ago: it is garbage, and has to be rewritten class DocsBuilder { const DEFAULT_TEMPLATES = [ 'User' => ['User', 'InputUser', 'Chat', 'InputChannel', 'Peer', 'InputDialogPeer', 'DialogPeer', 'InputPeer', 'NotifyPeer', 'InputNotifyPeer'], 'InputFile' => ['InputFile', 'InputEncryptedFile'], 'InputEncryptedChat' => ['InputEncryptedChat'], 'PhoneCall' => ['PhoneCall'], 'InputPhoto' => ['InputPhoto'], 'InputDocument' => ['InputDocument'], 'InputMedia' => ['InputMedia'], 'InputMessage' => ['InputMessage'], 'KeyboardButton' => ['KeyboardButton'], ]; use \danog\MadelineProto\DocsBuilder\Methods; use \danog\MadelineProto\DocsBuilder\Constructors; public $td = false; public function __construct($logger, $settings) { $this->logger = $logger; \set_error_handler(['\\danog\\MadelineProto\\Exception', 'ExceptionErrorHandler']); $this->TL = new TL(new class($logger) { public function __construct($logger) { $this->logger = $logger; } }); $new = new TLSchema; $new->mergeArray($settings); $this->TL->init($new); if (isset($settings['tl_schema']['td']) && !isset($settings['tl_schema']['telegram'])) { $this->td = true; } $this->settings = $settings; if (!\file_exists($this->settings['output_dir'])) { \mkdir($this->settings['output_dir']); } \chdir($this->settings['output_dir']); $this->index = $settings['readme'] ? 'README.md' : 'index.md'; foreach (\glob($this->settings['template']."/*") as $template) { $this->templates[\basename($template, '.md')] = \file_get_contents($template); } } /** * Documentation templates. * * @var array */ protected $templates = []; public $types = []; public $any = '*'; public function mkDocs(): void { \danog\MadelineProto\Logger::log('Generating documentation index...', \danog\MadelineProto\Logger::NOTICE); \file_put_contents($this->index, $this->template('index', $this->settings['title'], $this->settings['description'])); $this->mkMethods(); $this->mkConstructors(); foreach (\glob('types/*') as $unlink) { \unlink($unlink); } if (\file_exists('types')) { \rmdir('types'); } \mkdir('types'); \ksort($this->types); $index = ''; \danog\MadelineProto\Logger::log('Generating types documentation...', \danog\MadelineProto\Logger::NOTICE); foreach ($this->types as $otype => $keys) { $type = StrTools::typeEscape($otype); $index .= '['.StrTools::markdownEscape($type).']('.$type.'.md) '; $constructors = ''; foreach ($keys['constructors'] as $data) { $predicate = $data['predicate'].(isset($data['layer']) && $data['layer'] !== '' ? '_'.$data['layer'] : ''); $md_predicate = StrTools::markdownEscape($predicate); $constructors .= "[$md_predicate](../constructors/$predicate.md) \n\n"; } $methods = ''; foreach ($keys['methods'] as $data) { $name = $data['method']; $md_name = \str_replace(['.', '_'], ['->', '\\_'], $name); $methods .= "[\$MadelineProto->$md_name](../methods/$name.md) \n\n"; } $symFile = \str_replace('.', '_', $type); $redir = $symFile !== $type ? "\nredirect_from: /API_docs/types/{$symFile}.html" : ''; $header = ''; if (!isset($this->settings['td'])) { foreach (self::DEFAULT_TEMPLATES as $template => $types) { if (\in_array($type, $types)) { $header .= $this->template($template, $type); } } } if (isset($this->td_descriptions['types'][$otype])) { $header = "{$this->td_descriptions['types'][$otype]}\n\n$header"; } $header = \sprintf( $this->templates['Type'], $type, $redir, StrTools::markdownEscape($type), $header, $constructors, $methods ); \file_put_contents('types/'.$type.'.md', $header.$constructors.$methods); } \danog\MadelineProto\Logger::log('Generating types index...', \danog\MadelineProto\Logger::NOTICE); \file_put_contents('types/'.$this->index, $this->templates['types-index'].$index); \danog\MadelineProto\Logger::log('Generating additional types...', \danog\MadelineProto\Logger::NOTICE); foreach (['string', 'bytes', 'int', 'int53', 'long', 'int128', 'int256', 'int512', 'double', 'Bool', 'DataJSON'] as $type) { \file_put_contents("types/$type.md", $this->templates[$type]); } foreach (['boolFalse', 'boolTrue', 'null', 'photoStrippedSize'] as $constructor) { \file_put_contents("constructors/$constructor.md", $this->templates[$constructor]); } \danog\MadelineProto\Logger::log('Done!', \danog\MadelineProto\Logger::NOTICE); } public static function addToLang(string $key, string $value = '', bool $force = false): void { if (!isset(\danog\MadelineProto\Lang::$lang['en'][$key]) || $force) { \danog\MadelineProto\Lang::$lang['en'][$key] = $value; } } /** * Get formatted template string. * * @param string $name Template name * @param string[] ...$params Params * * @return string */ protected function template(string $name, ...$params): string { return \sprintf($this->templates[$name], ...$params); } }