Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the Hooks Documentation in the Wiki #86

Merged
merged 2 commits into from
Mar 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
239 changes: 239 additions & 0 deletions bin/extract-hooks.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,239 @@
<?php
/**
* Extract hooks from the codebase.
*
* @package Enable_Mastodon_Apps
*/

$ignore_filters = array();

$base = dirname( __DIR__ );
$files = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator( $base ),
RecursiveIteratorIterator::LEAVES_ONLY
);
$b = strlen( $base ) + 1;
$filters = array();
foreach ( $files as $file ) {
if ( $file->getExtension() !== 'php' ) {
continue;
}
$dir = substr( $file->getPath(), $b );
$main_dir = strtok( $dir, '/' );
if ( in_array(
$main_dir,
array(
'tests',
)
) ) {
continue;
}
$tokens = token_get_all( file_get_contents( $file ) );
foreach ( $tokens as $i => $token ) {
if ( ! is_array( $token ) || ! isset( $token[1] ) ) {
continue;
}
if ( ! in_array( ltrim( $token[1], '\\' ), array( 'apply_filters', 'do_action' ) ) ) {
continue;
}

$comment = false;
$hook = false;

for ( $j = $i; $j > max( 0, $i - 10 ); $j-- ) {
if ( ! is_array( $tokens[ $j ] ) ) {
continue;
}

if ( T_DOC_COMMENT === $tokens[ $j ][0] ) {
$comment = $tokens[ $j ][1];
break;
}

if ( T_COMMENT === $tokens[ $j ][0] ) {
$comment = $tokens[ $j ][1];
break;
}
}

for ( $j = $i + 1; $j < $i + 10; $j++ ) {
if ( ! is_array( $tokens[ $j ] ) ) {
continue;
}

if ( T_CONSTANT_ENCAPSED_STRING === $tokens[ $j ][0] ) {
$hook = trim( $tokens[ $j ][1], '"\'' );
break;
}
}

if (
$hook
&& ! in_array( $hook, $ignore_filters )
&& ! preg_match( '/^(friends_)/', $hook )

) {
if ( ! isset( $filters[ $hook ] ) ) {
$filters[ $hook ] = array(
'files' => array(),
'section' => $file->getFilename(),
'type' => $token[1],
);
}

$filters[ $hook ]['files'][] = $dir . '/' . $file->getFilename() . ':' . $token[2];
$filters[ $hook ]['base_dirs'][ $main_dir ] = true;

if ( $comment ) {
$docblock = parse_docblock( $comment );
if ( ! empty( $docblock['comment'] ) && ! preg_match( '#^Documented in#i', $docblock['comment'] ) ) {
$filters[ $hook ] = array_merge( $docblock, $filters[ $hook ] );
}
}
}
}
}
uksort(
$filters,
function ( $a, $b ) use ( $filters ) {
if ( $filters[ $a ]['section'] === $filters[ $b ]['section'] ) {
return $a < $b ? -1 : 1;
}
return $filters[ $a ]['section'] < $filters[ $b ]['section'] ? -1 : 1;
}
);

function parse_docblock( $raw_comment ) {
// Adapted from https://github.com/kamermans/docblock-reflection.
$tags = array();
$lines = explode( PHP_EOL, trim( $raw_comment ) );
$matches = null;
$comment = '';

switch ( count( $lines ) ) {
case 1:
// Handle single-line docblock.
if ( ! preg_match( '#\\/\\*\\*([^*]*)\\*\\/#', $lines[0], $matches ) ) {
return array(
'comment' => trim( ltrim( $lines[0], "/ \t" ) ),
);
}
$lines[0] = \substr( $lines[0], 3, -2 );
break;

case 2:
// Probably malformed.
return array();

default:
// Handle multi-line docblock.
array_shift( $lines );
array_pop( $lines );
break;
}

foreach ( $lines as $line ) {
$line = preg_replace( '#^[ \t]*\* ?#', '', $line );

if ( preg_match( '#@([^ ]+)(.*)#', $line, $matches ) ) {
$tag_name = $matches[1];
$tag_value = \trim( $matches[2] );

// If this tag was already parsed, make its value an array.
if ( isset( $tags[ $tag_name ] ) ) {
if ( ! \is_array( $tags[ $tag_name ] ) ) {
$tags[ $tag_name ] = array( $tags[ $tag_name ] );
}

$tags[ $tag_name ][] = $tag_value;
} else {
$tags[ $tag_name ] = $tag_value;
}
continue;
}

$comment .= "$line\n";
}
$ret = array_filter(
array_merge(
$tags,
array(
'comment' => trim( $comment ),
)
)
);
if ( empty( $ret ) ) {
return array();
}

return $ret;
}

$docs = $base . '/../enable-mastodon-apps.wiki/';
if ( ! file_exists( $docs ) ) {
mkdir( $docs, 0777, true );
}

$index = '';
$section = '';
foreach ( $filters as $hook => $data ) {
if ( $section !== $data['section'] ) {
$section = $data['section'];
$index .= PHP_EOL . '## ' . $section . PHP_EOL . PHP_EOL;
}
$doc = '';
$index .= "- [`$hook`]($hook)";

if ( ! empty( $data['comment'] ) ) {
$index .= ' ' . strtok( $data['comment'], PHP_EOL );
$doc .= PHP_EOL . $data['comment'] . PHP_EOL . PHP_EOL;
}

$index .= PHP_EOL;

if ( ! empty( $data['param'] ) ) {
$doc .= "## Parameters\n";
foreach ( (array) $data['param'] as $param ) {
$p = explode( ' ', $param, 3 );
if ( '\\' === substr( $p[0], 0, 1 ) ) {
$p[0] = substr( $p[0], 1 );
} elseif ( ! in_array( $p[0], array( 'int', 'string', 'bool', 'array' ) ) ) {
$p[0] = 'Enable_Mastodon_Apps\\' . $p[0];
}
$doc .= "\n- *`{$p[0]}`* `{$p[1]}` {$p[2]}";
}

$doc .= PHP_EOL . PHP_EOL;
}

if ( ! empty( $data['return'] ) ) {
$doc .= "## Returns\n";
$p = explode( ' ', $data['return'], 2 );
if ( '\\' === substr( $p[0], 0, 1 ) ) {
$p[0] = substr( $p[0], 1 );
} elseif ( ! in_array( $p[0], array( 'int', 'string', 'bool', 'array' ) ) ) {
$p[0] = 'Enable_Mastodon_Apps\\' . $p[0];
}
$doc .= "\n`{$p[0]}` {$p[1]}";

$doc .= PHP_EOL . PHP_EOL;
}

$doc .= "## Files\n\n";
foreach ( $data['files'] as $file ) {
$doc .= "- [$file](https://github.com/akirk/enable-mastodon-apps/blob/main/" . str_replace( ':', '#L', $file ) . ")\n";
}
$doc .= "\n\n[Hooks](Hooks)\n";

file_put_contents(
$docs . "/$hook.md",
$doc
);

}
file_put_contents(
$docs . '/Hooks.md',
$index
);

echo 'Genearated ' . count( $filters ) . ' hooks documentation files in ' . realpath( $docs ) . PHP_EOL; // phpcs:ignore
22 changes: 22 additions & 0 deletions includes/class-mastodon-api.php
Original file line number Diff line number Diff line change
@@ -2326,6 +2326,28 @@ public function api_preferences( $request ) {
public function api_account( $request ) {
$user_id = $this->get_user_id_from_request( $request );

/**
* Modify the account data returned for `/api/account/{user_id}` requests.
*
* @param Entity\Account|null $account The account data.
* @param int $user_id The requested user ID.
* @param \WP_REST_Request $request The request object.
* @return Entity\Account|null The modified account data.
*
* Example:
* ```php
* add_filter( 'mastodon_api_account', function( $user_data, $user_id ) {
* $user = get_user_by( 'ID', $user_id );
*
* $account = new Account_Entity();
* $account->id = strval( $user->ID );
* $account->username = $user->user_login;
* $account->display_name = $user->display_name;
*
* return $account;
* } );
* ```
*/
$account = \apply_filters( 'mastodon_api_account', null, $user_id, $request );

if ( ! $account instanceof Entity\Account ) {
Loading