You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

870 lines
30 KiB

4 years ago
4 years ago
6 years ago
  1. <?php
  2. namespace p3k\XRay\Formats;
  3. use HTMLPurifier, HTMLPurifier_Config;
  4. class Mf2 extends Format {
  5. use Mf2Feed;
  6. public static function matches_host($url) {
  7. return true;
  8. }
  9. public static function matches($url) {
  10. return true;
  11. }
  12. public static function parse($mf2, $url, $http, $opts=[]) {
  13. if(count($mf2['items']) == 0)
  14. return false;
  15. // If they are expecting a feed, always return a feed or an error
  16. if(isset($opts['expect']) && $opts['expect'] == 'feed') {
  17. return self::parseAsHFeed($mf2, $http, $url);
  18. }
  19. // If there is only one item on the page, just use that
  20. if(count($mf2['items']) == 1) {
  21. $item = $mf2['items'][0];
  22. if(in_array('h-entry', $item['type']) || in_array('h-cite', $item['type'])) {
  23. #Parse::debug("mf2:0: Recognized $url as an h-entry it is the only item on the page");
  24. return self::parseAsHEntry($mf2, $item, $http, $url);
  25. }
  26. if(in_array('h-event', $item['type'])) {
  27. #Parse::debug("mf2:0: Recognized $url as an h-event it is the only item on the page");
  28. return self::parseAsHEvent($mf2, $item, $http, $url);
  29. }
  30. if(in_array('h-review', $item['type'])) {
  31. #Parse::debug("mf2:0: Recognized $url as an h-review it is the only item on the page");
  32. return self::parseAsHReview($mf2, $item, $http, $url);
  33. }
  34. if(in_array('h-recipe', $item['type'])) {
  35. #Parse::debug("mf2:0: Recognized $url as an h-recipe it is the only item on the page");
  36. return self::parseAsHRecipe($mf2, $item, $http, $url);
  37. }
  38. if(in_array('h-product', $item['type'])) {
  39. #Parse::debug("mf2:0: Recognized $url as an h-product it is the only item on the page");
  40. return self::parseAsHProduct($mf2, $item, $http, $url);
  41. }
  42. if(in_array('h-item', $item['type'])) {
  43. #Parse::debug("mf2:0: Recognized $url as an h-product it is the only item on the page");
  44. return self::parseAsHItem($mf2, $item, $http, $url);
  45. }
  46. if(in_array('h-card', $item['type'])) {
  47. #Parse::debug("mf2:0: Recognized $url as an h-card it is the only item on the page");
  48. return self::parseAsHCard($item, $http, $url, $url);
  49. }
  50. if(in_array('h-app', $item['type']) || in_array('h-x-app', $item['type'])) {
  51. #Parse::debug("mf2:0: Recognized $url as an h-feed because it is the only item on the page");
  52. return self::parseAsHApp($mf2, $item, $http, $url);
  53. }
  54. if(in_array('h-feed', $item['type'])) {
  55. #Parse::debug("mf2:0: Recognized $url as an h-feed because it is the only item on the page");
  56. return self::parseAsHFeed($mf2, $http, $url);
  57. }
  58. }
  59. // Check the list of items on the page to see if one matches the URL of the page,
  60. // and treat as a permalink for that object if so.
  61. foreach($mf2['items'] as $item) {
  62. if(array_key_exists('url', $item['properties'])) {
  63. $urls = $item['properties']['url'];
  64. $urls = array_map('\p3k\XRay\normalize_url', $urls);
  65. if(in_array($url, $urls)) {
  66. #Parse::debug("mf2:1: Recognized $url as a permalink because an object on the page matched the URL of the request");
  67. if(in_array('h-card', $item['type'])) {
  68. return self::parseAsHCard($item, $http, $url, $url);
  69. } elseif(in_array('h-entry', $item['type']) || in_array('h-cite', $item['type'])) {
  70. return self::parseAsHEntry($mf2, $item, $http, $url);
  71. } elseif(in_array('h-event', $item['type'])) {
  72. return self::parseAsHEvent($mf2, $item, $http, $url);
  73. } elseif(in_array('h-review', $item['type'])) {
  74. return self::parseAsHReview($mf2, $item, $http, $url);
  75. } elseif(in_array('h-recipe', $item['type'])) {
  76. return self::parseAsHRecipe($mf2, $item, $http, $url);
  77. } elseif(in_array('h-product', $item['type'])) {
  78. return self::parseAsHProduct($mf2, $item, $http, $url);
  79. } elseif(in_array('h-item', $item['type'])) {
  80. return self::parseAsHItem($mf2, $item, $http, $url);
  81. } elseif(in_array('h-app', $item['type']) || in_array('h-x-app', $item['type'])) {
  82. return self::parseAsHApp($mf2, $item, $http, $url);
  83. } elseif(in_array('h-feed', $item['type'])) {
  84. return self::parseAsHFeed($mf2, $http, $url);
  85. } else {
  86. #Parse::debug('This object was not a recognized type.');
  87. return false;
  88. }
  89. }
  90. }
  91. }
  92. // Check for an h-card matching rel=author or the author URL of any h-* on the page,
  93. // and return the h-* object if so
  94. if(isset($mf2['rels']['author'])) {
  95. foreach($mf2['items'] as $card) {
  96. if(in_array('h-card', $card['type']) && array_key_exists('url', $card['properties'])) {
  97. $urls = \p3k\XRay\normalize_urls($card['properties']['url']);
  98. if(count(array_intersect($urls, \p3k\XRay\normalize_urls($mf2['rels']['author']))) > 0) {
  99. // There is an author h-card on this page
  100. // Now look for the first h-* object other than an h-card and use that as the object
  101. foreach($mf2['items'] as $item) {
  102. if(!in_array('h-card', $item['type'])) {
  103. if(in_array('h-entry', $item['type']) || in_array('h-cite', $item['type'])) {
  104. return self::parseAsHEntry($mf2, $item, $http, $url);
  105. } elseif(in_array('h-event', $item['type'])) {
  106. return self::parseAsHEvent($mf2, $item, $http, $url);
  107. } elseif(in_array('h-review', $item['type'])) {
  108. return self::parseAsHReview($mf2, $item, $http, $url);
  109. } elseif(in_array('h-recipe', $item['type'])) {
  110. return self::parseAsHRecipe($mf2, $item, $http, $url);
  111. } elseif(in_array('h-product', $item['type'])) {
  112. return self::parseAsHProduct($mf2, $item, $http, $url);
  113. } elseif(in_array('h-item', $item['type'])) {
  114. return self::parseAsHItem($mf2, $item, $http, $url);
  115. } elseif(in_array('h-app', $item['type']) || in_array('h-x-app', $item['type'])) {
  116. return self::parseAsHApp($mf2, $item, $http, $url);
  117. }
  118. }
  119. }
  120. }
  121. }
  122. }
  123. }
  124. // If there was more than one h-entry on the page, treat the whole page as a feed
  125. if(count($mf2['items']) > 1) {
  126. if(count(array_filter($mf2['items'], function($item){
  127. return in_array('h-entry', $item['type']);
  128. })) > 1) {
  129. #Parse::debug("mf2:2: Recognized $url as an h-feed because there are more than one object on the page");
  130. return self::parseAsHFeed($mf2, $http, $url);
  131. }
  132. }
  133. // If the first item is an h-feed, parse as a feed
  134. $first = $mf2['items'][0];
  135. if(in_array('h-feed', $first['type'])) {
  136. #Parse::debug("mf2:3: Recognized $url as an h-feed because the first item is an h-feed");
  137. return self::parseAsHFeed($mf2, $http, $url);
  138. }
  139. // Fallback case, but hopefully we have found something before this point
  140. foreach($mf2['items'] as $item) {
  141. // Otherwise check for a recognized h-* object
  142. if(in_array('h-entry', $item['type']) || in_array('h-cite', $item['type'])) {
  143. #Parse::debug("mf2:6: $url is falling back to the first h-entry on the page");
  144. return self::parseAsHEntry($mf2, $item, $http, $url);
  145. } elseif(in_array('h-event', $item['type'])) {
  146. #Parse::debug("mf2:6: $url is falling back to the first h-event on the page");
  147. return self::parseAsHEvent($mf2, $item, $http, $url);
  148. } elseif(in_array('h-review', $item['type'])) {
  149. #Parse::debug("mf2:6: $url is falling back to the first h-review on the page");
  150. return self::parseAsHReview($mf2, $item, $http, $url);
  151. } elseif(in_array('h-recipe', $item['type'])) {
  152. #Parse::debug("mf2:6: $url is falling back to the first h-recipe on the page");
  153. return self::parseAsHRecipe($mf2, $item, $http, $url);
  154. } elseif(in_array('h-product', $item['type'])) {
  155. #Parse::debug("mf2:6: $url is falling back to the first h-product on the page");
  156. return self::parseAsHProduct($mf2, $item, $http, $url);
  157. } elseif(in_array('h-item', $item['type'])) {
  158. #Parse::debug("mf2:6: $url is falling back to the first h-item on the page");
  159. return self::parseAsHItem($mf2, $item, $http, $url);
  160. } elseif(in_array('h-app', $item['type']) || in_array('h-x-app', $item['type'])) {
  161. #Parse::debug("mf2:6: $url is falling back to the first h-item on the page");
  162. return self::parseAsHApp($mf2, $item, $http, $url);
  163. }
  164. }
  165. #Parse::debug("mf2:E: No object at $url was recognized");
  166. return false;
  167. }
  168. private static function collectSingleValues($properties, $urlProperties, $item, $url, &$data) {
  169. foreach($properties as $p) {
  170. if(($v = self::getPlaintext($item, $p)) !== null) {
  171. $data[$p] = $v;
  172. }
  173. }
  174. foreach($urlProperties as $p) {
  175. if($p == 'url') {
  176. // Special handling for the 'url' property to prioritize finding the URL on the same domain
  177. if($values = self::getPlaintextValues($item, 'url')) {
  178. if(count($values) == 1) {
  179. if(self::isURL($values[0]))
  180. $data['url'] = $values[0];
  181. }
  182. else {
  183. $set = false;
  184. foreach($values as $v) {
  185. if(self::isURL($v) && parse_url($v, PHP_URL_HOST) == parse_url($url, PHP_URL_HOST)) {
  186. $set = true;
  187. $data['url'] = $v;
  188. }
  189. }
  190. if(!$set) {
  191. // Fall back to the first URL if there isn't one on the domain
  192. if(self::isURL($values[0]))
  193. $data['url'] = $values[0];
  194. }
  195. }
  196. }
  197. } else {
  198. if(($v = self::getPlaintext($item, $p)) !== null) {
  199. if(self::isURL($v))
  200. $data[$p] = $v;
  201. }
  202. }
  203. }
  204. }
  205. private static function parseHTMLValue($property, $item) {
  206. if(!array_key_exists($property, $item['properties']))
  207. return null;
  208. $textContent = false;
  209. $htmlContent = false;
  210. $content = $item['properties'][$property][0];
  211. if(is_string($content)) {
  212. $textContent = $content;
  213. } elseif(!is_string($content) && is_array($content) && array_key_exists('html', $content)) {
  214. if(array_key_exists('html', $content)) {
  215. // Only allow images in the content if there is no photo property set
  216. if(isset($item['properties']['photo']))
  217. $allowImg = false;
  218. else
  219. $allowImg = true;
  220. $htmlContent = trim(self::sanitizeHTML($content['html'], $allowImg));
  221. #$textContent = trim(str_replace("&#xD;","\r",$content['value']));
  222. $textContent = trim(self::stripHTML($htmlContent));
  223. } else {
  224. if(isset($content['value']))
  225. $textContent = trim($content['value']);
  226. }
  227. }
  228. if($textContent || $htmlContent) {
  229. $data = [
  230. 'text' => $textContent
  231. ];
  232. // Only add HTML content if there is actual content.
  233. // If the text content ends up empty, then the HTML should be too
  234. // e.g. <div class="e-content"><a href=""><img src="" class="u-photo"></a></div>
  235. // should not return content of <a href=""></a>
  236. // TODO: still need to remove empty <a> tags when there is other text in the content
  237. if($htmlContent && $textContent && $textContent != $htmlContent) {
  238. $data['html'] = $htmlContent;
  239. }
  240. if(!$data['text'])
  241. return null;
  242. return $data;
  243. } else {
  244. return null;
  245. }
  246. }
  247. // Always return arrays, and may contain plaintext content
  248. // Nested objects are added to refs and the URL is used as the value if present
  249. private static function collectArrayValues($properties, $item, &$data, &$refs, &$http) {
  250. foreach($properties as $p) {
  251. if(array_key_exists($p, $item['properties'])) {
  252. foreach($item['properties'][$p] as $v) {
  253. if(is_string($v)) {
  254. if(!array_key_exists($p, $data)) $data[$p] = [];
  255. if(!in_array($v, $data[$p]))
  256. $data[$p][] = $v;
  257. } elseif(self::isMicroformat($v)) {
  258. if(($u=self::getPlaintext($v, 'url')) && self::isURL($u)) {
  259. if(!array_key_exists($p, $data)) $data[$p] = [];
  260. if(!in_array($u, $data[$p]))
  261. $data[$p][] = $u;
  262. $ref = self::parse(['items'=>[$v]], $u, $http);
  263. if($ref) {
  264. $refs[$u] = $ref['data'];
  265. }
  266. } else {
  267. if(!array_key_exists($p, $data)) $data[$p] = [];
  268. if(!in_array($v['value'], $data[$p]))
  269. $data[$p][] = $v['value'];
  270. }
  271. }
  272. }
  273. }
  274. }
  275. }
  276. private static function parseEmbeddedHCard($property, $item, &$http) {
  277. if(array_key_exists($property, $item['properties'])) {
  278. $mf2 = $item['properties'][$property][0];
  279. if(is_string($mf2) && self::isURL($mf2)) {
  280. $hcard = [
  281. 'type' => 'card',
  282. 'url' => $mf2
  283. ];
  284. return $hcard;
  285. } if(self::isMicroformat($mf2) && in_array('h-card', $mf2['type'])) {
  286. $hcard = [
  287. 'type' => 'card',
  288. ];
  289. $properties = ['name','latitude','longitude','locality','region','country','url'];
  290. foreach($properties as $p) {
  291. if($v=self::getPlaintext($mf2, $p)) {
  292. $hcard[$p] = $v;
  293. }
  294. }
  295. return $hcard;
  296. }
  297. }
  298. return false;
  299. }
  300. private static function collectArrayURLValues($properties, $item, &$data, &$refs, &$http) {
  301. $keys = [];
  302. foreach($properties as $p) {
  303. if(array_key_exists($p, $item['properties'])) {
  304. foreach($item['properties'][$p] as $v) {
  305. if(is_string($v) && self::isURL($v)) {
  306. if(!array_key_exists($p, $data)) $data[$p] = [];
  307. $data[$p][] = $v;
  308. $keys[] = $p;
  309. }
  310. elseif(self::isMicroformat($v) && ($u=self::getPlaintext($v, 'url')) && self::isURL($u)) {
  311. if(!array_key_exists($p, $data)) $data[$p] = [];
  312. $data[$p][] = $u;
  313. $keys[] = $p;
  314. // parse the object and put the result in the "refs" object
  315. $ref = self::parse(['items'=>[$v]], $u, $http);
  316. if($ref) {
  317. $refs[$u] = $ref['data'];
  318. }
  319. }
  320. }
  321. }
  322. }
  323. // Remove duplicate values
  324. foreach(array_unique($keys) as $key) {
  325. $data[$key] = array_unique($data[$key]);
  326. }
  327. }
  328. private static function determineNameAndContent($item, &$data) {
  329. // Determine if the name is distinct from the content
  330. $name = self::getPlaintext($item, 'name');
  331. $textContent = null;
  332. $htmlContent = null;
  333. $content = self::getHTMLValue($item, 'content');
  334. if(is_string($content)) {
  335. $textContent = $content;
  336. } elseif($content) {
  337. $htmlContent = array_key_exists('html', $content) ? $content['html'] : null;
  338. $textContent = array_key_exists('value', $content) ? $content['value'] : null;
  339. }
  340. $checkedname = $name;
  341. if($content) {
  342. // Trim ellipses from the name
  343. $name = preg_replace('/ ?(\.\.\.|…)$/', '', $name);
  344. // Remove all whitespace when checking equality
  345. $nameCompare = preg_replace('/\s/','',trim($name));
  346. $contentCompare = preg_replace('/\s/','',trim($textContent));
  347. // Check if the name is a prefix of the content
  348. if($contentCompare && $nameCompare && strpos($contentCompare, $nameCompare) === 0) {
  349. $checkedname = null;
  350. }
  351. }
  352. if($checkedname) {
  353. $data['name'] = $checkedname;
  354. }
  355. // If there is content, always return the plaintext content, and return HTML content if it's different
  356. if($content) {
  357. $content = self::parseHTMLValue('content', $item);
  358. if($content['text']) {
  359. $data['content']['text'] = $content['text'];
  360. if(isset($content['html']))
  361. $data['content']['html'] = $content['html'];
  362. } else {
  363. // If the content text was blank because the img was removed and that was the only content,
  364. // then put the name back as the name if it was previously set.
  365. // See https://github.com/aaronpk/XRay/issues/57
  366. if($name) {
  367. $data['name'] = $name;
  368. }
  369. }
  370. }
  371. }
  372. private static function parseAsHEntry($mf2, $item, $http, $url) {
  373. $data = [
  374. 'type' => 'entry'
  375. ];
  376. $refs = [];
  377. // Single plaintext and URL values
  378. self::collectSingleValues(['published','summary','rsvp','swarm-coins'], ['url','featured'], $item, $url, $data);
  379. if(isset($data['rsvp']))
  380. $data['rsvp'] = strtolower($data['rsvp']);
  381. // These properties are always returned as arrays and may contain plaintext content
  382. // First strip leading hashtags from category values if present
  383. if(array_key_exists('category', $item['properties'])) {
  384. foreach($item['properties']['category'] as $i=>$c) {
  385. if(is_string($c))
  386. $item['properties']['category'][$i] = ltrim($c, '#');
  387. }
  388. }
  389. self::collectArrayValues(['category','invitee'], $item, $data, $refs, $http);
  390. // These properties are always returned as arrays and always URLs
  391. // If the value is an h-* object with a URL, the URL is used and a "ref" is added as well
  392. self::collectArrayURLValues(['photo','video','audio','syndication','in-reply-to','like-of','repost-of','bookmark-of','quotation-of'], $item, $data, $refs, $http);
  393. // Hack to make quotation-of a single value
  394. if(isset($data['quotation-of']))
  395. $data['quotation-of'] = $data['quotation-of'][0];
  396. self::determineNameAndContent($item, $data);
  397. if($author = self::findAuthor($mf2, $item, $http, $url))
  398. $data['author'] = $author;
  399. if($checkin = self::parseEmbeddedHCard('checkin', $item, $http))
  400. $data['checkin'] = $checkin;
  401. $response = [
  402. 'data' => $data
  403. ];
  404. if(count($refs)) {
  405. $response['data']['refs'] = $refs;
  406. }
  407. return $response;
  408. }
  409. private static function parseAsHReview($mf2, $item, $http, $url) {
  410. $data = [
  411. 'type' => 'review'
  412. ];
  413. $refs = [];
  414. self::collectSingleValues(['summary','published','rating','best','worst'], ['url'], $item, $url, $data);
  415. // Fallback for Mf1 "description" as content. The PHP parser does not properly map this to "content"
  416. $description = self::parseHTMLValue('description', $item);
  417. if($description) {
  418. $data['content'] = $description;
  419. }
  420. self::collectArrayValues(['category'], $item, $data, $refs, $http);
  421. self::collectArrayURLValues(['item'], $item, $data, $refs, $http);
  422. self::determineNameAndContent($item, $data);
  423. if($author = self::findAuthor($mf2, $item, $http, $url))
  424. $data['author'] = $author;
  425. $response = [
  426. 'data' => $data
  427. ];
  428. if(count($refs)) {
  429. $response['data']['refs'] = $refs;
  430. }
  431. return $response;
  432. }
  433. private static function parseAsHRecipe($mf2, $item, $http, $url) {
  434. $data = [
  435. 'type' => 'recipe'
  436. ];
  437. $refs = [];
  438. self::collectSingleValues(['name','summary','published','duration','yield','nutrition'], ['url'], $item, $url, $data);
  439. $instructions = self::parseHTMLValue('instructions', $item);
  440. if($instructions) {
  441. $data['instructions'] = $instructions;
  442. }
  443. self::collectArrayValues(['category','ingredient'], $item, $data, $refs, $http);
  444. self::collectArrayURLValues(['photo'], $item, $data, $refs, $http);
  445. if($author = self::findAuthor($mf2, $item, $http, $url))
  446. $data['author'] = $author;
  447. $response = [
  448. 'data' => $data
  449. ];
  450. if(count($refs)) {
  451. $response['data']['refs'] = $refs;
  452. }
  453. return $response;
  454. }
  455. private static function parseAsHProduct($mf2, $item, $http, $url) {
  456. $data = [
  457. 'type' => 'product'
  458. ];
  459. $refs = [];
  460. self::collectSingleValues(['name','identifier','price'], ['url'], $item, $url, $data);
  461. $description = self::parseHTMLValue('description', $item);
  462. if($description) {
  463. $data['description'] = $description;
  464. }
  465. self::collectArrayValues(['category','brand'], $item, $data, $refs, $http);
  466. self::collectArrayURLValues(['photo','video','audio'], $item, $data, $refs, $http);
  467. $response = [
  468. 'data' => $data
  469. ];
  470. if(count($refs)) {
  471. $response['data']['refs'] = $refs;
  472. }
  473. return $response;
  474. }
  475. private static function parseAsHItem($mf2, $item, $http, $url) {
  476. $data = [
  477. 'type' => 'item'
  478. ];
  479. $refs = [];
  480. self::collectSingleValues(['name'], ['url'], $item, $url, $data);
  481. self::collectArrayURLValues(['photo','video','audio'], $item, $data, $refs, $http);
  482. $response = [
  483. 'data' => $data
  484. ];
  485. if(count($refs)) {
  486. $response['data']['refs'] = $refs;
  487. }
  488. return $response;
  489. }
  490. private static function parseAsHApp($mf2, $item, $http, $url) {
  491. $data = [
  492. 'type' => 'app'
  493. ];
  494. self::collectSingleValues(['name'], ['url','logo'], $item, $url, $data);
  495. self::collectArrayURLValues(['redirect-uri'], $item, $data, $refs, $http);
  496. if(!isset($data['url']))
  497. $data['url'] = $url;
  498. if(isset($mf2['rels']['redirect_uri'])) {
  499. if(!isset($data['redirect-uri'])) $data['redirect-uri'] = [];
  500. $data['redirect-uri'] = array_merge($data['redirect-uri'], $mf2['rels']['redirect_uri']);
  501. }
  502. if(isset($data['redirect-uri'])) {
  503. $data['redirect-uri'] = array_values(array_unique($data['redirect-uri']));
  504. }
  505. $response = [
  506. 'data' => $data
  507. ];
  508. return $response;
  509. }
  510. private static function parseAsHEvent($mf2, $item, $http, $url) {
  511. $data = [
  512. 'type' => 'event'
  513. ];
  514. $refs = [];
  515. // Single plaintext and URL values
  516. self::collectSingleValues(['name','summary','published','start','end','duration'], ['url'], $item, $url, $data);
  517. // These properties are always returned as arrays and may contain plaintext content
  518. self::collectArrayValues(['category','location','attendee'], $item, $data, $refs, $http);
  519. // These properties are always returned as arrays and always URLs
  520. // If the value is an h-* object with a URL, the URL is used and a "ref" is added as well
  521. self::collectArrayURLValues(['photo','video','audio','syndication'], $item, $data, $refs, $http);
  522. // If there is a description, always return the plaintext description, and return HTML description if it's different
  523. $description = self::parseHTMLValue('description', $item);
  524. if($description) {
  525. $data['description'] = $description;
  526. }
  527. $response = [
  528. 'data' => $data
  529. ];
  530. if(count($refs)) {
  531. $response['data']['refs'] = $refs;
  532. }
  533. return $response;
  534. }
  535. private static function parseAsHCard($item, $http, $url, $authorURL=false) {
  536. $data = [
  537. 'type' => 'card',
  538. 'name' => null,
  539. 'url' => null,
  540. 'photo' => null
  541. ];
  542. $properties = ['url','name','photo'];
  543. foreach($properties as $p) {
  544. if($p == 'url' && $authorURL) {
  545. // If there is a matching author URL, use that one
  546. $found = false;
  547. foreach($item['properties']['url'] as $url) {
  548. if(self::isURL($url)) {
  549. $url = \p3k\XRay\normalize_url($url);
  550. if($url == \p3k\XRay\normalize_url($authorURL)) {
  551. $data['url'] = $url;
  552. $found = true;
  553. }
  554. }
  555. }
  556. if(!$found && self::isURL($item['properties']['url'][0])) {
  557. $data['url'] = $item['properties']['url'][0];
  558. }
  559. } else if(($v = self::getPlaintext($item, $p)) !== null) {
  560. // Make sure the URL property is actually a URL
  561. if($p == 'url' || $p == 'photo') {
  562. if(self::isURL($v))
  563. $data[$p] = $v;
  564. } else {
  565. $data[$p] = $v;
  566. }
  567. }
  568. }
  569. // If no URL property was found, use the $authorURL provided
  570. if(!$data['url'])
  571. $data['url'] = $authorURL;
  572. $response = [
  573. 'data' => $data
  574. ];
  575. return $response;
  576. }
  577. private static function findAuthor($mf2, $item, $http, $url) {
  578. $author = [
  579. 'type' => 'card',
  580. 'name' => null,
  581. 'url' => null,
  582. 'photo' => null
  583. ];
  584. // Author Discovery
  585. // http://indiewebcamp.com/authorship
  586. $authorPage = false;
  587. if(array_key_exists('author', $item['properties'])) {
  588. // Check if any of the values of the author property are an h-card
  589. foreach($item['properties']['author'] as $a) {
  590. if(self::isHCard($a)) {
  591. // 5.1 "if it has an h-card, use it, exit."
  592. return self::parseAsHCard($a, $http, $url)['data'];
  593. } elseif(is_string($a)) {
  594. if(self::isURL($a)) {
  595. // 5.2 "otherwise if author property is an http(s) URL, let the author-page have that URL"
  596. $authorPage = $a;
  597. } else {
  598. // 5.3 "otherwise use the author property as the author name, exit"
  599. // We can only set the name, no h-card or URL was found
  600. $author['name'] = self::getPlaintext($item, 'author');
  601. return $author;
  602. }
  603. } else {
  604. // This case is only hit when the author property is an mf2 object that is not an h-card
  605. $author['name'] = self::getPlaintext($item, 'author');
  606. return $author;
  607. }
  608. }
  609. }
  610. // 6. "if no author page was found" ... check for rel-author link
  611. if(!$authorPage) {
  612. if(isset($mf2['rels']) && isset($mf2['rels']['author']))
  613. $authorPage = $mf2['rels']['author'][0];
  614. }
  615. // 7. "if there is an author-page URL" ...
  616. if($authorPage) {
  617. // 7.1 "get the author-page from that URL and parse it for microformats2"
  618. $authorPageContents = self::getURL($authorPage, $http);
  619. if($authorPageContents) {
  620. foreach($authorPageContents['items'] as $i) {
  621. if(self::isHCard($i)) {
  622. // 7.2 "if author-page has 1+ h-card with url == uid == author-page's URL, then use first such h-card, exit."
  623. if(array_key_exists('url', $i['properties'])
  624. and in_array(\p3k\XRay\normalize_url($authorPage), \p3k\XRay\normalize_urls($i['properties']['url']))
  625. and array_key_exists('uid', $i['properties'])
  626. and in_array(\p3k\XRay\normalize_url($authorPage), \p3k\XRay\normalize_urls($i['properties']['uid']))
  627. ) {
  628. return self::parseAsHCard($i, $http, $url, $authorPage)['data'];
  629. }
  630. // 7.3 "else if author-page has 1+ h-card with url property which matches the href of a rel-me link on the author-page"
  631. $relMeLinks = (isset($authorPageContents['rels']) && isset($authorPageContents['rels']['me'])) ? $authorPageContents['rels']['me'] : [];
  632. if(count($relMeLinks) > 0
  633. and array_key_exists('url', $i['properties'])
  634. and count(array_intersect(\p3k\XRay\normalize_urls($i['properties']['url']), \p3k\XRay\normalize_urls($relMeLinks))) > 0
  635. ) {
  636. return self::parseAsHCard($i, $http, $url, $authorPage)['data'];
  637. }
  638. }
  639. }
  640. }
  641. // 7.4 "if the h-entry's page has 1+ h-card with url == author-page URL, use first such h-card, exit."
  642. foreach($mf2['items'] as $i) {
  643. if(self::isHCard($i)) {
  644. if(array_key_exists('url', $i['properties'])
  645. and in_array(\p3k\XRay\normalize_url($authorPage), \p3k\XRay\normalize_urls($i['properties']['url']))
  646. ) {
  647. return self::parseAsHCard($i, $http, $url)['data'];
  648. }
  649. }
  650. // Also check the "author" property
  651. // (for finding the author of an h-feed's children when the author is the p-author property of the h-feed)
  652. if(isset($i['properties']['author'])) {
  653. foreach($i['properties']['author'] as $ic) {
  654. if(self::isHCard($ic)) {
  655. if(array_key_exists('url', $ic['properties'])
  656. and in_array(\p3k\XRay\normalize_url($authorPage), \p3k\XRay\normalize_urls($ic['properties']['url']))
  657. ) {
  658. return self::parseAsHCard($ic, $http, $url)['data'];
  659. }
  660. }
  661. }
  662. }
  663. }
  664. }
  665. if(!$author['name'] && !$author['photo'] && !$author['url'])
  666. return null;
  667. return $author;
  668. }
  669. private static function hasNumericKeys(array $arr) {
  670. foreach($arr as $key=>$val)
  671. if (is_numeric($key))
  672. return true;
  673. return false;
  674. }
  675. private static function isMicroformat($mf) {
  676. return is_array($mf)
  677. and !self::hasNumericKeys($mf)
  678. and !empty($mf['type'])
  679. and isset($mf['properties']);
  680. }
  681. private static function isHCard($mf) {
  682. return is_array($mf)
  683. and !empty($mf['type'])
  684. and is_array($mf['type'])
  685. and in_array('h-card', $mf['type']);
  686. }
  687. private static function isURL($string) {
  688. return preg_match('/^https?:\/\/.+\..+$/', $string);
  689. }
  690. // Given an array of microformats properties and a key name, return the plaintext value
  691. // at that property
  692. // e.g.
  693. // {"properties":{"published":["foo"]}} results in "foo"
  694. private static function getPlaintext($mf2, $k, $fallback=null) {
  695. if(!empty($mf2['properties'][$k]) and is_array($mf2['properties'][$k])) {
  696. // $mf2['properties'][$v] will always be an array since the input was from the mf2 parser
  697. $value = $mf2['properties'][$k][0];
  698. if(is_string($value)) {
  699. return $value;
  700. } elseif(self::isMicroformat($value) && array_key_exists('value', $value)) {
  701. return $value['value'];
  702. }
  703. }
  704. return $fallback;
  705. }
  706. private static function getHTMLValue($mf2, $k, $fallback=null) {
  707. // Return an array with html and value if the value is html, otherwise return a string
  708. if(!empty($mf2['properties'][$k]) and is_array($mf2['properties'][$k])) {
  709. // $mf2['properties'][$v] will always be an array since the input was from the mf2 parser
  710. $value = $mf2['properties'][$k][0];
  711. if(is_string($value)) {
  712. return $value;
  713. } elseif(isset($value['html'])) {
  714. return $value;
  715. }
  716. }
  717. return $fallback;
  718. }
  719. private static function getPlaintextValues($mf2, $k, $values=[]) {
  720. if(!empty($mf2['properties'][$k]) and is_array($mf2['properties'][$k])) {
  721. foreach($mf2['properties'][$k] as $value) {
  722. if(is_string($value)) {
  723. $values[] = $value;
  724. } elseif(self::isMicroformat($value) && array_key_exists('value', $value)) {
  725. $values[] = $value['value'];
  726. }
  727. }
  728. }
  729. return $values;
  730. }
  731. private static function getURL($url, $http) {
  732. if(!$url || !$http) return null;
  733. // TODO: consider adding caching here
  734. $result = $http->get($url);
  735. if($result['error'] || !$result['body']) {
  736. return null;
  737. }
  738. return \mf2\Parse($result['body'], $url);
  739. }
  740. }