class.ilExternalMediaAnalyzer.php

Go to the documentation of this file.

<?php

class ilExternalMediaAnalyzer
{
    public static function isYouTube(
        string $a_location
    ): bool {
        if (strpos($a_location, "youtube.com") > 0 ||
                strpos($a_location, "youtu.be") > 0) {
            return true;
        }
        return false;
    }

    public static function extractYouTubeParameters(
        string $a_location
    ): array {
        $par = array();
        $pos1 = strpos($a_location, "v=");
        $pos2 = strpos($a_location, "&", $pos1);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["v"] = substr($a_location, $pos1 + 2, $len - ($pos1 + 2));
        } elseif (strpos($a_location, "youtu.be") > 0) {
            $par["v"] = substr($a_location, strrpos($a_location, "/") + 1);
        }
        $qpos = strpos($par["v"] ?? "", "?");
        if (is_int($qpos)) {
            $par["v"] = substr($par["v"], 0, $qpos);
        }
        return $par;
    }

    public static function isFlickr(
        string $a_location
    ): bool {
        if (strpos($a_location, "flickr.com") > 0) {
            return true;
        }
        return false;
    }

    public static function extractFlickrParameters(
        string $a_location
    ): array {
        $par = array();
        $pos1 = strpos($a_location, "flickr.com/photos/");
        $pos2 = strpos($a_location, "/", $pos1 + 18);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : $a_location;
            $par["user_id"] = substr($a_location, $pos1 + 18, $len - ($pos1 + 18));
        }

        // tags
        $pos1 = strpos($a_location, "/tags/");
        $pos2 = strpos($a_location, "/", $pos1 + 6);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["tags"] = substr($a_location, $pos1 + 6, $len - ($pos1 + 6));
        }

        // sets
        $pos1 = strpos($a_location, "/sets/");
        $pos2 = strpos($a_location, "/", $pos1 + 6);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : $a_location;
            $par["sets"] = substr($a_location, $pos1 + 6, $len - ($pos1 + 6));
        }

        return $par;
    }

    public static function isGoogleVideo(
        string $a_location
    ): bool {
        if (strpos($a_location, "video.google") > 0) {
            return true;
        }
        return false;
    }

    public static function extractGoogleVideoParameters(
        string $a_location
    ): array {
        $par = array();
        $pos1 = strpos($a_location, "docid=");
        $pos2 = strpos($a_location, "&", $pos1 + 6);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["docid"] = substr($a_location, $pos1 + 6, $len - ($pos1 + 6));
        }

        return $par;
    }

    public static function isVimeo(
        string $a_location
    ): bool {
        if (strpos($a_location, "vimeo.com") > 0) {
            return true;
        }
        return false;
    }

    public static function extractVimeoParameters(
        string $a_location
    ): array {
        $par = array();
        $pos1 = strpos($a_location, "vimeo.com/");
        $pos2 = strpos($a_location, "&", $pos1 + 10);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["id"] = substr($a_location, $pos1 + 10, $len - ($pos1 + 10));
        }

        return $par;
    }

    public static function getVimeoMetadata(string $vid): array
    {
        $json_url = 'https://vimeo.com/api/oembed.json?url=https%3A//vimeo.com/' . $vid;

        $curl = curl_init($json_url);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($curl, CURLOPT_TIMEOUT, 10);
        curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1);
        curl_setopt($curl, CURLOPT_REFERER, ILIAS_HTTP_PATH);

        $return = curl_exec($curl);
        curl_close($curl);

        $r = json_decode($return, true);

        if ($return === false || is_null($r)) {
            throw new ilExternalMediaApiException("Could not connect to vimeo API at $json_url.");
        }
        return $r;
    }

    public static function getYoutubeMetadata(string $vid): array
    {
        $json_url = 'https://www.youtube.com/oembed?url=http%3A//youtube.com/watch%3Fv%3D' . $vid . '&format=json';
        $curl = curl_init($json_url);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($curl, CURLOPT_TIMEOUT, 10);
        curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1);
        curl_setopt($curl, CURLOPT_REFERER, ILIAS_HTTP_PATH);

        $return = curl_exec($curl);
        curl_close($curl);

        $r = json_decode($return, true);

        if ($return === false || is_null($r)) {
            throw new ilExternalMediaApiException("Could not connect to youtube API at $json_url.");
        }
        return $r;
    }

    public static function isGoogleDocument(
        string $a_location
    ): bool {
        if (strpos($a_location, "docs.google") > 0) {
            return true;
        }
        return false;
    }

    public static function extractGoogleDocumentParameters(
        string $a_location
    ): array {
        $par = array();
        $pos1 = strpos($a_location, "id=");
        $pos2 = strpos($a_location, "&", $pos1 + 3);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["docid"] = substr($a_location, $pos1 + 3, $len - ($pos1 + 3));
        }
        $pos1 = strpos($a_location, "docID=");
        $pos2 = strpos($a_location, "&", $pos1 + 6);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["docid"] = substr($a_location, $pos1 + 6, $len - ($pos1 + 6));
        }
        if (strpos($a_location, "Presentation?") > 0) {
            $par["type"] = "Presentation";
        }
        if (strpos($a_location, "View?") > 0) {
            $par["type"] = "Document";
        }

        return $par;
    }

    public static function extractUrlParameters(
        string $a_location,
        array $a_parameter
    ): array {
        $ext_par = array();

        // YouTube
        if (ilExternalMediaAnalyzer::isYouTube($a_location)) {
            $ext_par = ilExternalMediaAnalyzer::extractYouTubeParameters($a_location);
            $a_parameter = array();
        }

        // Flickr
        if (ilExternalMediaAnalyzer::isFlickr($a_location)) {
            $ext_par = ilExternalMediaAnalyzer::extractFlickrParameters($a_location);
            $a_parameter = array();
        }

        // GoogleVideo
        if (ilExternalMediaAnalyzer::isGoogleVideo($a_location)) {
            $ext_par = ilExternalMediaAnalyzer::extractGoogleVideoParameters($a_location);
            $a_parameter = array();
        }

        // GoogleDocs
        if (ilExternalMediaAnalyzer::isGoogleDocument($a_location)) {
            $ext_par = ilExternalMediaAnalyzer::extractGoogleDocumentParameters($a_location);
            $a_parameter = array();
        }

        foreach ($ext_par as $name => $value) {
            $a_parameter[$name] = $value;
        }

        return $a_parameter;
    }
}