landrok/activitypub

<?php

/*
 * This file is part of the ActivityPhp package.
 *
 * Copyright (c) landrok at github.com/landrok
 *
 * For the full copyright and license information, please see
 * <https://github.com/landrok/activitypub/blob/master/LICENSE>.
 */

namespace ActivityPhp\Server\Http;

use Exception;

/**
 * A simple WebFinger container of data.
 */ 
class WebFinger
{
    /**
     * @var string
     */
    protected $subject;

    /**
     * @var string[]
     */
    protected $aliases = [];

    /**
     * @var array
     */
    protected $links = [];

    /**
     * Construct WebFinger instance
     * 
     * @param array $data A WebFinger response
     */
    public function __construct(array $data)
    {
        foreach (['subject', 'aliases', 'links'] as $key) {
            $value = $data[$key] ?? $this->$key;
            $method = 'set' . ucfirst($key);
            $this->$method($value);
        }
    }

    /**
     * Set subject property
     * 
     * @param string $subject
     */
    protected function setSubject($subject)
    {
        if (!is_string($subject)) {
            throw new Exception(
                "WebFinger subject must be a string"
            );
        }

        $this->subject = $subject;
    }

    /**
     * Set aliases property
     * 
     * @param array $aliases
     */
    protected function setAliases(array $aliases)
    {
        foreach ($aliases as $alias) {
            if (!is_string($alias)) {
                throw new Exception(
                    "WebFinger aliases must be an array of strings"
                );
            }

            $this->aliases[] = $alias;
        }
    }

    /**
     * Set links property
     * 
     * @param array $links
     */
    protected function setLinks(array $links)
    {
        foreach ($links as $link) {
            if (!is_array($link)) {
                throw new Exception(
                    "WebFinger links must be an array of objects"
                );
            }

            if (!isset($link['rel'])) {
                throw new Exception(
                    "WebFinger links object must contain 'rel' property"
                );
            }
            
            $tmp = [];
            $tmp['rel'] = $link['rel'];
            
            foreach (['type', 'href', 'template'] as $key) {
                if (isset($link[$key]) && is_string($link[$key])) {
                    $tmp[$key] = $link[$key];
                }
            }

            $this->links[] = $tmp;
        }
    }

    /**
     * Get ActivityPhp profile id URL
     * 
     * @return string
     */
    public function getProfileId()
    {
        foreach ($this->links as $link) {
            if (isset($link['rel'], $link['type'], $link['href'])) {
                if ($link['rel'] == 'self' 
                    && $link['type'] == 'application/activity+json'
                ) {
                    return $link['href'];
                }
            }
        }
    }

    /**
     * Get WebFinger response as an array
     * 
     * @return array
     */
    public function toArray()
    {
        return [
            'subject' => $this->subject,
            'aliases' => $this->aliases,
            'links'   => $this->links
        ];
    }

    /**
     * Get aliases
     * 
     * @return array
     */
    public function getAliases()
    {
        return $this->aliases;
    }

    /**
     * Get links
     * 
     * @return array
     */
    public function getLinks()
    {
        return $this->links;
    }

    /**
     * Get subject fetched from profile
     * 
     * @return null|string Subject
     */
    public function getSubject()
    {
        return $this->subject;
    }

    /**
     * Get subject handle fetched from profile
     * 
     * @return null|string
     */
    public function getHandle()
    {
        return substr($this->subject, 5);
    }
}