Files
core/Zotlabs/Module/Xrd.php
Harald Eilertsen ca3d7da246 Add API docs for xrd module
Include documentation for the `personal_xrd` hook.
2026-06-22 15:02:18 +02:00

107 lines
3.0 KiB
PHP

<?php
namespace Zotlabs\Module;
use Zotlabs\Lib\Keyutils;
use Zotlabs\Web\Controller;
require_once('include/crypto.php');
/**
* Handler for the `/xrd` URI endpoint.
*
* Generates an XRD document for a channel.
* See: https://docs.oasis-open.org/xri/xrd/v1.0/xrd-1.0.html
*
* **Query params:**
*
* - `uri` (required): The URI for the resource to describe in one of these
* forms:
* - `https://myhub.example/mychannel`
* - `https://myhub.example/~mychannel`
* - `acct:mychannel@`
* - `acct://mychannel@`
* - `mychannel@`
* - `//mychannel@`
*/
class Xrd extends Controller {
/**
* Handle the xrd request.
*
* Renders an XRD document in XML format for the channel requested in the
* `url` query parameter. If the requested channel does not exist on this
* server, or an error occurs, a blank HTML page is returned to the client.
*/
function init(): void {
$uri = urldecode(notags(trim($_GET['uri'])));
$subject = $uri;
logger('xrd: ' . $uri,LOGGER_DEBUG);
$resource = $uri;
if(substr($uri,0,4) === 'http') {
$uri = str_replace('~','',$uri);
$name = basename($uri);
}
else {
$local = str_replace('acct:', '', $uri);
if(substr($local,0,2) == '//')
$local = substr($local,2);
$name = substr($local,0,strpos($local,'@'));
}
$r = channelx_by_nick($name);
if(! $r)
killme();
$salmon_key = Keyutils::salmonKey($r['channel_pubkey']);
header('Access-Control-Allow-Origin: *');
header("Content-type: application/xrd+xml");
$aliases = array('acct:' . channel_reddress($r), z_root() . '/channel/' . $r['channel_address'], z_root() . '/~' . $r['channel_address']);
for($x = 0; $x < count($aliases); $x ++) {
if($aliases[$x] === $resource)
unset($aliases[$x]);
}
$o = replace_macros(get_markup_template('xrd_person.tpl'), array(
'$nick' => $r['channel_address'],
'$accturi' => $resource,
'$subject' => $subject,
'$aliases' => $aliases,
'$channel_url' => z_root() . '/channel/' . $r['channel_address'],
'$profile_url' => z_root() . '/channel/' . $r['channel_address'],
'$hcard_url' => z_root() . '/hcard/' . $r['channel_address'],
'$atom' => z_root() . '/ofeed/' . $r['channel_address'],
'$zot_post' => z_root() . '/post/' . $r['channel_address'],
'$poco_url' => z_root() . '/poco/' . $r['channel_address'],
'$photo' => z_root() . '/photo/profile/l/' . $r['channel_id'],
'$modexp' => 'data:application/magic-public-key,' . $salmon_key,
'$subscribe' => z_root() . '/follow?f=&amp;url={uri}',
));
$arr = array('user' => $r, 'xml' => $o);
/**
* @hooks personal_xrd
* Called with the rendered XML document for a channel.
* * \e array \b user - the combined fields of the `channel` and `xchan` of
* the requested channel.
* * \e string \b xml - The rendered XML to be returned to the client.
*/
call_hooks('personal_xrd', $arr);
echo $arr['xml'];
killme();
}
}