Do not use STDOUT and STDERR constants
[phinde.git] / src / phinde / HubUrlExtractor.php
index 81a612cf31d0ef6499e15b48e47293720e46f0b5..da29650cf0b4363927f48778a5ca372db2754d1d 100644 (file)
@@ -1,6 +1,11 @@
 <?php
 namespace phinde;
 
+/**
+ * Perform WebSub discovery for "hub" and "self" URLs
+ *
+ * @link https://www.w3.org/TR/websub/#discovery
+ */
 class HubUrlExtractor
 {
     /**
@@ -14,22 +19,28 @@ class HubUrlExtractor
      * Get the hub and self/canonical URL of a given topic URL.
      * Uses link headers and parses HTML link rels.
      *
-     * @param string $url Topic URL
+     * @param string $url       Topic URL
+     * @param int    $redirects Number of redirects that were followed
      *
-     * @return array Array of URLs with keys: hub, self
+     * @return array Array of URLs with keys: hub, self.
+     *               - "self" value is the URL
+     *               - "hub"  value is an array of URLs
+     *               Keys may be there but most not if the URL
+     *               does not advertise them.
      */
-    public function getUrls($url)
+    public function getUrls($url, $redirects = 0)
     {
         //at first, try a HEAD request that does not transfer so much data
         $req = $this->getRequest();
         $req->setUrl($url);
         $req->setMethod(\HTTP_Request2::METHOD_HEAD);
+        $req->setConfig('follow_redirects', false);
         $res = $req->send();
 
         if (intval($res->getStatus() / 100) >= 4
             && $res->getStatus() != 405 //method not supported/allowed
         ) {
-            return null;
+            return [];
         }
 
         $url  = $res->getEffectiveUrl();
@@ -40,6 +51,15 @@ class HubUrlExtractor
             return $this->absolutifyUrls($urls, $base);
         }
 
+        if ($res->isRedirect()) {
+            //we tried header links and that failed, now follow the redirect
+            if ($redirects > 5) {
+                return [];
+            }
+            $redirectUrl = (string) $base->resolve($res->getHeader('location'));
+            return $this->getUrls($redirectUrl, $redirects + 1);
+        }
+
         list($type) = explode(';', $res->getHeader('Content-type'));
         if ($type != 'text/html' && $type != 'text/xml'
             && $type != 'application/xhtml+xml'
@@ -66,6 +86,8 @@ class HubUrlExtractor
             return $this->absolutifyUrls($urls, $base);
         }
 
+        $urls = [];//do not mix header and content links
+
         $body = $res->getBody();
         $doc = $this->loadHtml($body, $res);
 
@@ -111,15 +133,16 @@ class HubUrlExtractor
                 if ($type == 'canonical') {
                     $type = 'self';
                 }
-                if ($type == 'hub' || $type == 'self'
-                    && !isset($urls[$type])
-                ) {
-                    $urls[$type] = $uri;
+                if ($type == 'self' && !isset($urls['self'])) {
+                    $urls['self'] = $uri;
+                } else if ($type == 'hub') {
+                    $urls['hub'][] = $uri;
                 }
             }
         }
 
-        //FIXME: base href
+        //<base href=".."> extraction is not necessary; RFC 5988 says:
+        // Note that any base IRI from the message's content is not applied.
         return $this->absolutifyUrls($urls, $base);
     }
 
@@ -138,10 +161,8 @@ class HubUrlExtractor
         $links = $http->parseLinks($res->getHeader('Link'));
         foreach ($links as $link) {
             if (isset($link['_uri']) && isset($link['rel'])) {
-                if (!isset($urls['hub'])
-                    && array_search('hub', $link['rel']) !== false
-                ) {
-                    $urls['hub'] = $link['_uri'];
+                if (array_search('hub', $link['rel']) !== false) {
+                    $urls['hub'][] = $link['_uri'];
                 }
                 if (!isset($urls['self'])
                     && array_search('self', $link['rel']) !== false
@@ -221,7 +242,7 @@ class HubUrlExtractor
     /**
      * Make the list of urls absolute
      *
-     * @param array  $urls Array of maybe relative URLs
+     * @param array  $urls Array of maybe relative URLs, or array of URLs
      * @param object $base Base URL to resolve the relatives against
      *
      * @return array List of absolute URLs
@@ -229,7 +250,13 @@ class HubUrlExtractor
     protected function absolutifyUrls($urls, \Net_URL2 $base)
     {
         foreach ($urls as $key => $url) {
-            $urls[$key] = (string) $base->resolve($url);
+            if (is_array($url)) {
+                foreach ($url as $singleKey => $singleUrl) {
+                    $urls[$key][$singleKey] = (string) $base->resolve($singleUrl);
+                }
+            } else {
+                $urls[$key] = (string) $base->resolve($url);
+            }
         }
         return $urls;
     }