ILIAS\WOPI\Discovery\Crawler Class Reference

Collaboration diagram for ILIAS\WOPI\Discovery\Crawler:

Public Member Functions
	__construct ()
	validate (URI $discovery_url)
	crawl (URI $discovery_url)

Private Attributes
const	XPATH = '/wopi-discovery/net-zone/app'
array	$crawl_actions = []
string	$content = null
SimpleXMLElement	$discovery = null
array	$xml_app_elements = null

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 28 of file Crawler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\WOPI\Discovery\Crawler::__construct

(

)

Definition at line 42 of file Crawler.php.

    {
        $this->crawl_actions = [
            ActionTarget::VIEW->value,
            ActionTarget::EMBED_VIEW->value,
            ActionTarget::EDIT->value,
            ActionTarget::EMBED_EDIT->value,
            ActionTarget::CONVERT->value,
        ];
    }

Member Function Documentation

crawl()

ILIAS\WOPI\Discovery\Crawler::crawl

(

URI

$discovery_url

)

Definition at line 73 of file Crawler.php.

                                             : ?Apps
    {
        if (!$this->validate($discovery_url)) {
            return null;
        }
 
        // read wopi-discovery XML from $discovery_url and parse Apps with it's Actions
        $apps = [];
        foreach ($this->xml_app_elements as $app) {
            $actions = [];
            foreach ($app->action as $action) {
                $action_name = $action['name'] ?? null;
                $action_ext = $action['ext'] ?? null;
                $action_urlsrc = $action['urlsrc'] ?? null;
                $target_text = isset($action['targetext']) ? (string) $action['targetext'] : null;
                if (!$action_name instanceof \SimpleXMLElement) {
                    continue;
                }
                if (!$action_ext instanceof \SimpleXMLElement) {
                    continue;
                }
                if (!$action_urlsrc instanceof \SimpleXMLElement) {
                    continue;
                }
 
                if (!in_array((string) $action_name, $this->crawl_actions, true)) {
                    continue;
                }
 
                $uri_string = rtrim((string) $action_urlsrc, '?');
                // remove all after ?
                $uri = explode('?', $uri_string);
                $uri_string = $uri[0];
                $actions[] = new Action(
                    0,
                    (string) $action_name,
                    (string) $action_ext,
                    new URI($uri_string),
                    $uri[1] ?? null,
                    $target_text
                );
            }
            if ($actions === []) {
                continue;
            }
 
            $app_name = $app['name'] ?? null;
            if ($app_name === null) {
                continue;
            }
            $app_fav_icon_url = $app['favIconUrl'] ?? null;
            $apps[] = new App(
                0,
                (string) $app_name,
                $actions,
                $app_fav_icon_url === null ? null : new URI((string) $app_fav_icon_url)
            );
        }
        return new Apps($apps);
    }

References ILIAS\WOPI\Discovery\Crawler\validate().

Here is the call graph for this function:

validate()

ILIAS\WOPI\Discovery\Crawler::validate

(

URI

$discovery_url

)

Definition at line 53 of file Crawler.php.

                                                : bool
    {
        try {
            $this->content = file_get_contents((string) $discovery_url) ?: null;
            if ($this->content === null) {
                return false;
            }
 
            $this->discovery = simplexml_load_string($this->content) ?: null;
            if ($this->discovery === null) {
                return false;
            }
            $this->xml_app_elements = $this->discovery->xpath(self::XPATH);
 
            return is_array($this->xml_app_elements);
        } catch (\Throwable) {
            return false;
        }
    }

Referenced by ILIAS\WOPI\Discovery\Crawler\crawl().

Here is the caller graph for this function:

Field Documentation

$content

string ILIAS\WOPI\Discovery\Crawler::$content = null

private

Definition at line 35 of file Crawler.php.

$crawl_actions

array ILIAS\WOPI\Discovery\Crawler::$crawl_actions = []

private

Definition at line 34 of file Crawler.php.

$discovery

SimpleXMLElement ILIAS\WOPI\Discovery\Crawler::$discovery = null

private

Definition at line 36 of file Crawler.php.

$xml_app_elements

array ILIAS\WOPI\Discovery\Crawler::$xml_app_elements = null

private

Definition at line 40 of file Crawler.php.

XPATH

const ILIAS\WOPI\Discovery\Crawler::XPATH = '/wopi-discovery/net-zone/app'

private

Definition at line 33 of file Crawler.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/WOPI/classes/Discovery/Crawler.php