friendica/include/Probe.php

<?php
/**
 * @brief This class contain functions for probing URL
 *
 */

use \Friendica\Core\Config;
use \Friendica\Core\PConfig;

require_once("include/feed.php");

class Probe {

	private function rearrange_data($data) {
		$fields = array("name", "nick", "guid", "url", "addr", "batch",
				"notify", "poll", "request", "confirm", "poco",
				"photo", "priority", "network", "alias", "pubkey", "baseurl");

		$newdata = array();
		foreach ($fields AS $field)
			if (isset($data[$field]))
				$newdata[$field] = $data[$field];
			else
				$newdata[$field] = "";

		// We don't use the "priority" field anymore and replace it with a dummy.
		$newdata["priority"] = 0;

		return $newdata;
	}

	/**
	 * @brief Probes for XRD data
	 *
	 * @return array
	 *      'lrdd' => Link to LRDD endpoint
	 *      'lrdd-xml' => Link to LRDD endpoint in XML format
	 *      'lrdd-json' => Link to LRDD endpoint in JSON format
	 */
	private function xrd($host) {

		$ssl_url = "https://".$host."/.well-known/host-meta";
		$url = "http://".$host."/.well-known/host-meta";

		$xrd_timeout = Config::get('system','xrd_timeout', 20);
		$redirects = 0;

		$xml = fetch_url($ssl_url, false, $redirects, $xrd_timeout, "application/xrd+xml");
		$xrd = parse_xml_string($xml, false);

		if (!is_object($xrd)) {
			$xml = fetch_url($url, false, $redirects, $xrd_timeout, "application/xrd+xml");
			$xrd = parse_xml_string($xml, false);
		}
		if (!is_object($xrd))
			return false;

		$links = xml::element_to_array($xrd);
		if (!isset($links["xrd"]["link"]))
			return false;

		$xrd_data = array();
		foreach ($links["xrd"]["link"] AS $value => $link) {
			if (isset($link["@attributes"]))
				$attributes = $link["@attributes"];
			elseif ($value == "@attributes")
				$attributes = $link;
			else
				continue;

			if (($attributes["rel"] == "lrdd") AND
				($attributes["type"] == "application/xrd+xml"))
				$xrd_data["lrdd-xml"] = $attributes["template"];
			elseif (($attributes["rel"] == "lrdd") AND
				($attributes["type"] == "application/json"))
				$xrd_data["lrdd-json"] = $attributes["template"];
			elseif ($attributes["rel"] == "lrdd")
				$xrd_data["lrdd"] = $attributes["template"];
		}
		return $xrd_data;
	}

	public static function uri($uri) {
		$data = self::detect($uri);

		//if (!data)
		//	return false;

		if (!isset($data["url"]))
			$data["url"] = $uri;

		if ($data["photo"] != "")
			$data["baseurl"] = matching_url(normalise_link($data["baseurl"]), normalise_link($data["photo"]));
		else
			$data["photo"] = App::get_baseurl().'/images/person-175.jpg';

		if (!isset($data["name"]))
			$data["name"] = $data["url"];

		if (!isset($data["nick"]))
			$data["nick"] = strtolower($data["name"]);

		if (!isset($data["network"]))
			$data["network"] = NETWORK_PHANTOM;

		$data = self::rearrange_data($data);

		return $data;
	}

	private function detect($uri) {
		if (strstr($uri, '@')) {
			// If the URI starts with "mailto:" then jum directly to the mail detection
			if (strpos($url,'mailto:') !== false) {
				$uri = str_replace('mailto:', '', $url);
				return self::mail($uri);
			}

			// Remove "acct:" from the URI
			$uri = str_replace('acct:', '', $uri);

			$host = substr($uri,strpos($uri, '@') + 1);
			$nick = substr($uri,0, strpos($uri, '@'));

			$lrdd = self::xrd($host);
			if (!$lrdd)
				return self::mail($uri);

			$addr = $uri;
		} else {
			$parts = parse_url($uri);
			if (!isset($parts["scheme"]) OR
				!isset($parts["host"]) OR
				!isset($parts["path"]))
				return false;

			// todo: Ports?
			$host = $parts["host"];
			$lrdd = self::xrd($host);

			$path_parts = explode("/", trim($parts["path"], "/"));

			while (!$lrdd AND (sizeof($path_parts) > 1)) {
				$host .= "/".array_shift($path_parts);
				$lrdd = self::xrd($host);
			}
			if (!$lrdd)
				return self::feed($uri);

			$nick = array_pop($path_parts);
			$addr = $nick."@".$host;
		}

		$webfinger = false;

		/// @todo Do we need the prefix "acct:" or "acct://"?

		foreach ($lrdd AS $key => $link) {
			if ($webfinger)
				continue;

			if (!in_array($key, array("lrdd", "lrdd-xml", "lrdd-json")))
				continue;

			$path = str_replace('{uri}', urlencode($addr), $link);

			$webfinger = self::webfinger($path);
		}
		if (!$webfinger)
			return self::feed($uri);

		$result = false;

		if (!$result)
			$result = self::dfrn($webfinger);
		if (!$result)
			$result = self::diaspora($webfinger);
		if (!$result)
			$result = self::ostatus($webfinger);
		if (!$result)
			$result = self::pumpio($webfinger);
		if (!$result)
			$result = self::feed($uri);
		else {
			// We overwrite the detected nick with our try if the previois routines hadn't detected it.
			// Additionally it is overwritten when the nickname doesn't make sense (contains spaces).
			if (!isset($result["nick"]) OR ($result["nick"] == "") OR (strstr($result["nick"], " ")))
				$result["nick"] = $nick;

			if (!isset($result["addr"]) OR ($result["addr"] == ""))
				$result["addr"] = $addr;
		}

		if (!isset($result["baseurl"]) OR ($result["baseurl"] == "")) {
			$pos = strpos($result["url"], $host);
			if ($pos)
				$result["baseurl"] = substr($result["url"], 0, $pos).$host;
		}

		return $result;
	}

	private function webfinger($url) {

		$xrd_timeout = Config::get('system','xrd_timeout', 20);
		$redirects = 0;

		$data = fetch_url($url, false, $redirects, $xrd_timeout, "application/xrd+xml");
		$xrd = parse_xml_string($data, false);

		if (!is_object($xrd)) {
			// If it is not XML, maybe it is JSON
			$webfinger = json_decode($data, true);

			if (!isset($webfinger["links"]))
				return false;

			return $webfinger;
		}

		$xrd_arr = xml::element_to_array($xrd);
		if (!isset($xrd_arr["xrd"]["link"]))
			return false;

		$webfinger = array();

		if (isset($xrd_arr["xrd"]["subject"]))
			$webfinger["subject"] = $xrd_arr["xrd"]["subject"];

		if (isset($xrd_arr["xrd"]["alias"]))
			$webfinger["aliases"] = $xrd_arr["xrd"]["alias"];

		$webfinger["links"] = array();

		foreach ($xrd_arr["xrd"]["link"] AS $value => $data) {
			if (isset($data["@attributes"]))
				$attributes = $data["@attributes"];
			elseif ($value == "@attributes")
				$attributes = $data;
			else
				continue;

			$webfinger["links"][] = $attributes;
		}
		return $webfinger;
	}

	private function dfrn($webfinger) {

		$hcard = "";
		$data = array();
		foreach ($webfinger["links"] AS $link) {
			if (($link["rel"] == NAMESPACE_DFRN) AND ($link["href"] != ""))
				$data["network"] = NETWORK_DFRN;
			elseif (($link["rel"] == NAMESPACE_FEED) AND ($link["href"] != ""))
				$data["poll"] = $link["href"];
			elseif (($link["rel"] == "http://webfinger.net/rel/profile-page") AND
				($link["type"] == "text/html") AND ($link["href"] != ""))
				$data["url"] = $link["href"];
			elseif (($link["rel"] == "http://microformats.org/profile/hcard") AND ($link["href"] != ""))
				$hcard = $link["href"];
			elseif (($link["rel"] == NAMESPACE_POCO) AND ($link["href"] != ""))
				$data["poco"] = $link["href"];
			elseif (($link["rel"] == "http://webfinger.net/rel/avatar") AND ($link["href"] != ""))
				$data["photo"] = $link["href"];

			elseif (($link["rel"] == "http://joindiaspora.com/seed_location") AND ($link["href"] != ""))
				$data["baseurl"] = trim($link["href"], '/');
			elseif (($link["rel"] == "http://joindiaspora.com/guid") AND ($link["href"] != ""))
				$data["guid"] = $link["href"];
			elseif (($link["rel"] == "diaspora-public-key") AND ($link["href"] != "")) {
				$data["pubkey"] = base64_decode($link["href"]);

				if (strstr($data["pubkey"], 'RSA ') OR ($link["type"] == "RSA"))
					$data["pubkey"] = rsatopem($data["pubkey"]);
			}
		}

		if (!isset($data["network"]) OR ($hcard == ""))
			return false;

		$data = self::poll_hcard($hcard, $data, true);

		return $data;
	}

	private function poll_hcard($hcard, $data, $dfrn = false) {

		$doc = new DOMDocument();
		if (!@$doc->loadHTMLFile($hcard))
			return false;

		$xpath = new DomXPath($doc);

		$vcards = $xpath->query("//div[contains(concat(' ', @class, ' '), ' vcard ')]");
		if (!is_object($vcards))
			return false;

		if ($vcards->length == 0)
			return false;

		$vcard = $vcards->item(0);

		// We have to discard the guid from the hcard in favour of the guid from lrdd
		// Reason: Hubzilla doesn't use the value "uid" in the hcard like Diaspora does.
		$search = $xpath->query("//*[contains(concat(' ', @class, ' '), ' uid ')]", $vcard); // */
		if (($search->length > 0) AND ($data["guid"] == ""))
			$data["guid"] = $search->item(0)->nodeValue;

		$search = $xpath->query("//*[contains(concat(' ', @class, ' '), ' nickname ')]", $vcard); // */
		if ($search->length > 0)
			$data["nick"] = $search->item(0)->nodeValue;

		$search = $xpath->query("//*[contains(concat(' ', @class, ' '), ' fn ')]", $vcard); // */
		if ($search->length > 0)
			$data["name"] = $search->item(0)->nodeValue;

		$search = $xpath->query("//*[contains(concat(' ', @class, ' '), ' searchable ')]", $vcard); // */
		if ($search->length > 0)
			$data["searchable"] = $search->item(0)->nodeValue;

		$search = $xpath->query("//*[contains(concat(' ', @class, ' '), ' key ')]", $vcard); // */
		if ($search->length > 0) {
			$data["pubkey"] = $search->item(0)->nodeValue;
			if (strstr($data["pubkey"], 'RSA '))
				$data["pubkey"] = rsatopem($data["pubkey"]);
		}

		$search = $xpath->query("//*[@id='pod_location']", $vcard); // */
		if ($search->length > 0)
			$data["baseurl"] = trim($search->item(0)->nodeValue, "/");

		$avatar = array();
		$photos = $xpath->query("//*[contains(concat(' ', @class, ' '), ' photo ') or contains(concat(' ', @class, ' '), ' avatar ')]", $vcard); // */
		foreach ($photos AS $photo) {
			$attr = array();
			foreach ($photo->attributes as $attribute)
				$attr[$attribute->name] = trim($attribute->value);

			if (isset($attr["src"]) AND isset($attr["width"]))
				$avatar[$attr["width"]] = $attr["src"];
		}

		if (sizeof($avatar)) {
			ksort($avatar);
			$data["photo"] = array_pop($avatar);
		}

		if ($dfrn) {
			// Poll DFRN specific data
			$search = $xpath->query("//link[contains(concat(' ', @rel), ' dfrn-')]");
			if ($search->length > 0) {
				foreach ($search AS $link) {
					//$data["request"] = $search->item(0)->nodeValue;
					$attr = array();
					foreach ($link->attributes as $attribute)
						$attr[$attribute->name] = trim($attribute->value);

					$data[substr($attr["rel"], 5)] = $attr["href"];
				}
			}

			// Older Friendica versions had used the "uid" field differently than newer versions
			if ($data["nick"] == $data["guid"])
				unset($data["guid"]);
		}


		return $data;
	}

	private function diaspora($webfinger) {

		$hcard = "";
		$data = array();
		foreach ($webfinger["links"] AS $link) {
			if (($link["rel"] == "http://microformats.org/profile/hcard") AND ($link["href"] != ""))
				$hcard = $link["href"];
			elseif (($link["rel"] == "http://joindiaspora.com/seed_location") AND ($link["href"] != ""))
				$data["baseurl"] = trim($link["href"], '/');
			elseif (($link["rel"] == "http://joindiaspora.com/guid") AND ($link["href"] != ""))
				$data["guid"] = $link["href"];
			elseif (($link["rel"] == "http://webfinger.net/rel/profile-page") AND
				($link["type"] == "text/html") AND ($link["href"] != ""))
				$data["url"] = $link["href"];
			elseif (($link["rel"] == NAMESPACE_FEED) AND ($link["href"] != ""))
				$data["poll"] = $link["href"];
			elseif (($link["rel"] == NAMESPACE_POCO) AND ($link["href"] != ""))
				$data["poco"] = $link["href"];
			elseif (($link["rel"] == "salmon") AND ($link["href"] != ""))
				$data["notify"] = $link["href"];
			elseif (($link["rel"] == "diaspora-public-key") AND ($link["href"] != "")) {
				$data["pubkey"] = base64_decode($link["href"]);

				if (strstr($data["pubkey"], 'RSA ') OR ($link["type"] == "RSA"))
					$data["pubkey"] = rsatopem($data["pubkey"]);
			}
		}

		if (!isset($data["url"]) OR ($hcard == ""))
			return false;

		if (isset($webfinger["aliases"]))
			foreach ($webfinger["aliases"] AS $alias)
				if (normalise_link($alias) != normalise_link($data["url"]) AND !strstr($alias, "@"))
					$data["alias"] = $alias;

		// Fetch further information from the hcard
		$data = self::poll_hcard($hcard, $data);

		if (!$data)
			return false;

		if (isset($data["url"]) AND isset($data["guid"]) AND isset($data["baseurl"]) AND
			isset($data["pubkey"]) AND ($hcard != "")) {
			$data["network"] = NETWORK_DIASPORA;

			// We have to overwrite the detected value for "notify" since Hubzilla doesn't send it
			$data["notify"] = $data["baseurl"]."/receive/users/".$data["guid"];
			$data["batch"] = $data["baseurl"]."/receive/public";
		} else
			return false;

		return $data;
	}

	private function ostatus($webfinger) {

		$pubkey = "";
		$data = array();
		foreach ($webfinger["links"] AS $link) {
			if (($link["rel"] == "http://webfinger.net/rel/profile-page") AND
				($link["type"] == "text/html") AND ($link["href"] != ""))
				$data["url"] = $link["href"];
			elseif (($link["rel"] == "salmon") AND ($link["href"] != ""))
				$data["notify"] = $link["href"];
			elseif (($link["rel"] == NAMESPACE_FEED) AND ($link["href"] != ""))
				$data["poll"] = $link["href"];
			elseif (($link["rel"] == "magic-public-key") AND ($link["href"] != "")) {
				$pubkey = $link["href"];

				if (substr($pubkey, 0, 5) === 'data:') {
					if (strstr($pubkey, ','))
						$pubkey = substr($pubkey, strpos($pubkey, ',') + 1);
					else
						$pubkey = substr($pubkey, 5);
				} else
					$pubkey = fetch_url($pubkey);

				$key = explode(".", $pubkey);

				if (sizeof($key) >= 3) {
					$m = base64url_decode($key[1]);
					$e = base64url_decode($key[2]);
					$data["pubkey"] = metopem($m,$e);
				}

			}
		}

		if (isset($data["notify"]) AND isset($data["pubkey"]) AND
			isset($data["poll"]) AND isset($data["url"])) {
			$data["network"] = NETWORK_OSTATUS;
		} else
			return false;

		// Fetch all additional data from the feed
		$feed = fetch_url($data["poll"]);
		$feed_data = feed_import($feed,$dummy1,$dummy2, $dummy3, true);
		if (!$feed_data)
			return false;

		if ($feed_data["header"]["author-name"] != "")
			$data["name"] = $feed_data["header"]["author-name"];

		if ($feed_data["header"]["author-nick"] != "")
			$data["nick"] = $feed_data["header"]["author-nick"];

		if ($feed_data["header"]["author-avatar"] != "")
			$data["photo"] = $feed_data["header"]["author-avatar"];

		if ($feed_data["header"]["author-id"] != "")
			$data["alias"] = $feed_data["header"]["author-id"];

		// OStatus has serious issues when the the url doesn't fit (ssl vs. non ssl)
		// So we take the value that we just fetched, although the other one worked as well
		if ($feed_data["header"]["author-link"] != "")
			$data["url"] = $feed_data["header"]["author-link"];

		/// @todo Fetch location and "about" from the feed as well
		return $data;
	}

	private function pumpio_profile_data($profile) {

		$doc = new DOMDocument();
		if (!@$doc->loadHTMLFile($profile))
			return false;

		$xpath = new DomXPath($doc);

		$data = array();

		// This is ugly - but pump.io doesn't seem to know a better way for it
		$data["name"] = trim($xpath->query("//h1[@class='media-header']")->item(0)->nodeValue);
		$pos = strpos($data["name"], chr(10));
		if ($pos)
			$data["name"] = trim(substr($data["name"], 0, $pos));

		$avatar = $xpath->query("//img[@class='img-rounded media-object']")->item(0);
		if ($avatar)
			foreach ($avatar->attributes as $attribute)
				if ($attribute->name == "src")
					$data["photo"] = trim($attribute->value);

		$data["location"] = $xpath->query("//p[@class='location']")->item(0)->nodeValue;
		$data["about"] = $xpath->query("//p[@class='summary']")->item(0)->nodeValue;

		return $data;
	}

	private function pumpio($webfinger) {
		$data = array();
		foreach ($webfinger["links"] AS $link) {
			if (($link["rel"] == "http://webfinger.net/rel/profile-page") AND
				($link["type"] == "text/html") AND ($link["href"] != ""))
				$data["url"] = $link["href"];
			elseif (($link["rel"] == "activity-inbox") AND ($link["href"] != ""))
				$data["activity-inbox"] = $link["href"];
			elseif (($link["rel"] == "activity-outbox") AND ($link["href"] != ""))
				$data["activity-outbox"] = $link["href"];
			elseif (($link["rel"] == "dialback") AND ($link["href"] != ""))
				$data["dialback"] = $link["href"];
		}
		if (isset($data["activity-inbox"]) AND isset($data["activity-outbox"]) AND
			isset($data["dialback"]) AND isset($data["url"])) {

			// by now we use these fields only for the network type detection
			// So we unset all data that isn't used at the moment
			unset($data["activity-inbox"]);
			unset($data["activity-outbox"]);
			unset($data["dialback"]);

			$data["network"] = NETWORK_PUMPIO;
		} else
			return false;

		$profile_data = self::pumpio_profile_data($data["url"]);

		if (!$profile_data)
			return false;

		$data = array_merge($data, $profile_data);

		return $data;
	}

	private function feed($url) {
		$feed = fetch_url($url);
		$feed_data = feed_import($feed, $dummy1, $dummy2, $dummy3, true);

		if (!$feed_data)
			return false;

		if ($feed_data["header"]["author-name"] != "")
			$data["name"] = $feed_data["header"]["author-name"];

		if ($feed_data["header"]["author-nick"] != "")
			$data["nick"] = $feed_data["header"]["author-nick"];

		if ($feed_data["header"]["author-avatar"] != "")
			$data["photo"] = $feed_data["header"]["author-avatar"];

		if ($feed_data["header"]["author-id"] != "")
			$data["alias"] = $feed_data["header"]["author-id"];

		$data["url"] = $url;
		$data["poll"] = $url;

		if ($feed_data["header"]["author-link"] != "")
			$data["baseurl"] = $feed_data["header"]["author-link"];
		else
			$data["baseurl"] = $data["url"];

		$data["network"] = NETWORK_FEED;

		return $data;
	}

	private function mail($uri) {

		if (!validate_email($uri))
			return false;

		$uid = local_user();
		$uid = 1;

		$x = q("SELECT `prvkey` FROM `user` WHERE `uid` = %d LIMIT 1", intval($uid));

		$r = q("SELECT * FROM `mailacct` WHERE `uid` = %d AND `server` != '' LIMIT 1", intval($uid));

		if(count($x) && count($r)) {
			$mailbox = construct_mailbox_name($r[0]);
			$password = '';
			openssl_private_decrypt(hex2bin($r[0]['pass']), $password,$x[0]['prvkey']);
			$mbox = email_connect($mailbox,$r[0]['user'], $password);
			if(!mbox)
				return false;
		}

		$msgs = email_poll($mbox, $uri);
		logger('searching '.$uri.', '.count($msgs).' messages found.', LOGGER_DEBUG);

		if (!count($msgs))
			return false;

		$data = array();

		$data["addr"] = $uri;
		$data["network"] = NETWORK_MAIL;
		$data["name"] = substr($uri, 0, strpos($uri,'@'));
		$data["nick"] = $data["name"];
		$data["photo"] = avatar_img($uri);

		$phost = substr($uri, strpos($uri,'@') + 1);
		$data["url"] = 'http://'.$phost."/".$data["nick"];
		$data["notify"] = 'smtp '.random_string();
		$data["poll"] = 'email '.random_string();

		$x = email_msg_meta($mbox, $msgs[0]);
		if(stristr($x[0]->from, $uri))
			$adr = imap_rfc822_parse_adrlist($x[0]->from, '');
		elseif(stristr($x[0]->to, $uri))
			$adr = imap_rfc822_parse_adrlist($x[0]->to, '');
		if(isset($adr)) {
			foreach($adr as $feadr) {
				if((strcasecmp($feadr->mailbox, $data["name"]) == 0)
					&&(strcasecmp($feadr->host, $phost) == 0)
					&& (strlen($feadr->personal))) {

					$personal = imap_mime_header_decode($feadr->personal);
					$data["name"] = "";
					foreach($personal as $perspart)
						if ($perspart->charset != "default")
							$data["name"] .= iconv($perspart->charset, 'UTF-8//IGNORE', $perspart->text);
						else
							$data["name"] .= $perspart->text;

					$data["name"] = notags($data["name"]);
				}
			}
		}
		imap_close($mbox);

		return $data;
	}
}
?>