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.

380 lines
13 KiB

6 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
  1. XRay
  2. ====
  3. XRay parses structured content from a URL.
  4. ## Discovering Content
  5. The contents of the URL is checked in the following order:
  6. * A silo URL from one of the following websites:
  7. * Instagram
  8. * Twitter
  9. * GitHub
  10. * XKCD
  11. * (more coming soon)
  12. * Microformats
  13. * h-card
  14. * h-entry
  15. * h-event
  16. * h-review
  17. * h-recipe
  18. * h-product
  19. * h-item
  20. ## Library
  21. XRay can be used as a library in your PHP project. The easiest way to install it and its dependencies is via composer.
  22. ```
  23. composer require p3k/xray
  24. ```
  25. ### Parsing
  26. ```php
  27. $xray = new p3k\XRay();
  28. $parsed = $xray->parse('https://aaronparecki.com/2017/04/28/9/');
  29. ```
  30. If you already have an HTML or JSON document you want to parse, you can pass it as a string in the second parameter.
  31. ```php
  32. $xray = new p3k\XRay();
  33. $html = '<html>....</html>';
  34. $parsed = $xray->parse('https://aaronparecki.com/2017/04/28/9/', $html);
  35. ```
  36. In both cases, you can add an additional parameter to configure various options of how XRay will behave. Below is a list of the options.
  37. * `timeout` - The timeout in seconds to wait for any HTTP requests
  38. * `max_redirects` - The maximum number of redirects to follow
  39. * `include_original` - Will also return the full document fetched
  40. * `target` - Specify a target URL, and XRay will first check if that URL is on the page, and only if it is, will continue to parse the page. This is useful when you're using XRay to verify an incoming webmention.
  41. * `expect=feed` - If you know the thing you are parsing is a feed, include this parameter which will avoid running the autodetection rules and will provide better results for some feeds.
  42. Additionally, the following parameters are supported when making requests that use the Twitter or GitHub API. See the authentication section below for details.
  43. ```php
  44. $xray = new p3k\XRay();
  45. $parsed = $xray->parse('https://aaronparecki.com/2017/04/28/9/', [
  46. 'timeout' => 30
  47. ]);
  48. $parsed = $xray->parse('https://aaronparecki.com/2017/04/28/9/', $html, [
  49. 'target' => 'http://example.com/'
  50. ]);
  51. ```
  52. The `$parsed` return value will look like the below. See "Primary Data" below for an explanation of the vocabularies returned.
  53. ```
  54. $parsed = Array
  55. (
  56. [data] => Array
  57. (
  58. [type] => card
  59. [name] => Aaron Parecki
  60. [url] => https://aaronparecki.com/
  61. [photo] => https://aaronparecki.com/images/profile.jpg
  62. )
  63. [url] => https://aaronparecki.com/
  64. [code] => 200
  65. )
  66. ```
  67. ### Rels
  68. You can also use XRay to fetch all the rel values on a page, merging the list of HTTP `Link` headers with rel values with the HTML rel values on the page.
  69. ```php
  70. $xray = new p3k\XRay();
  71. $xray->http = $this->http;
  72. $rels = $xray->rels('https://aaronparecki.com/');
  73. ```
  74. This will return a similar response to the parser, but instead of a `data` key containing the parsed page, there will be `rels`, an associative array. Each key will contain an array of all the values that match that rel value.
  75. ```
  76. $rels = Array
  77. (
  78. [url] => https://aaronparecki.com/
  79. [code] => 200
  80. [rels] => Array
  81. (
  82. [hub] => Array
  83. (
  84. [0] => https://switchboard.p3k.io/
  85. )
  86. [authorization_endpoint] => Array
  87. (
  88. [0] => https://aaronparecki.com/auth
  89. )
  90. ...
  91. ```
  92. ### Customizing the User Agent
  93. To set a unique user agent, (some websites will require a user agent be set), you can set the `http` property of the object to a `p3k\HTTP` object.
  94. ```php
  95. $xray = new p3k\XRay();
  96. $xray->http = new p3k\HTTP('MyProject/1.0.0 (http://example.com/)');
  97. $xray->parse('http://example.com/');
  98. ```
  99. ## API
  100. XRay can also be used as an API to provide its parsing capabilities over an HTTP service.
  101. To parse a page and return structured data for the contents of the page, simply pass a url to the parse route.
  102. ```
  103. GET /parse?url=https://aaronparecki.com/2016/01/16/11/
  104. ```
  105. To conditionally parse the page after first checking if it contains a link to a target URL, also include the target URL as a parameter. This is useful when using XRay to verify an incoming webmention.
  106. ```
  107. GET /parse?url=https://aaronparecki.com/2016/01/16/11/&target=http://example.com
  108. ```
  109. In both cases, the response will be a JSON object containing a key of "type". If there was an error, "type" will be set to the string "error", otherwise it will refer to the kind of content that was found at the URL, most often "entry".
  110. You can also make a POST request with the same parameter names.
  111. If you already have an HTML or JSON document you want to parse, you can include that in the parameter `body`. This POST request would look like the below:
  112. ```
  113. POST /parse
  114. Content-type: application/x-www-form-urlencoded
  115. url=https://aaronparecki.com/2016/01/16/11/
  116. &body=<html>....</html>
  117. ```
  118. or for Twitter/GitHub where you might have JSON,
  119. ```
  120. POST /parse
  121. Content-type: application/x-www-form-urlencoded
  122. url=https://github.com/aaronpk/XRay
  123. &body={"repo":......}
  124. ```
  125. ### Authentication
  126. If the URL you are fetching requires authentication, include the access token in the parameter "token", and it will be included in an "Authorization" header when fetching the URL. (It is recommended to use a POST request in this case, to avoid the access token potentially being logged as part of the query string.) This is useful for [Private Webmention](https://indieweb.org/Private-Webmention) verification.
  127. ```
  128. POST /parse
  129. url=https://aaronparecki.com/2016/01/16/11/
  130. &target=http://example.com
  131. &token=12341234123412341234
  132. ```
  133. ### Twitter Authentication
  134. XRay uses the Twitter API to fetch posts, and the Twitter API requires authentication. In order to keep XRay stateless, it is required that you pass in Twitter credentials to the parse call. You can register an application on the Twitter developer website, and generate an access token for your account without writing any code, and then use those credentials when making an API request to XRay.
  135. You should only send Twitter credentials when the URL you are trying to parse is a Twitter URL, so you'll want to check for whether the hostname is `twitter.com` before you include credentials in this call.
  136. * twitter_api_key - Your application's API key
  137. * twitter_api_secret - Your application's API secret
  138. * twitter_access_token - Your Twitter access token
  139. * twitter_access_token_secret - Your Twitter secret access token
  140. ### GitHub Authentication
  141. XRay uses the GitHub API to fetch GitHub URLs, which provides higher rate limits when used with authentication. You can pass a GitHub access token along with the request and XRay will use it when making requests to the API.
  142. * github_access_token - A GitHub access token
  143. ### Error Response
  144. ```json
  145. {
  146. "error": "not_found",
  147. "error_description": "The URL provided was not found"
  148. }
  149. ```
  150. Possible errors are listed below:
  151. * `not_found`: The URL provided was not found. (Returned 404 when fetching)
  152. * `ssl_cert_error`: There was an error validating the SSL certificate. This may happen if the SSL certificate has expired.
  153. * `ssl_unsupported_cipher`: The web server does not support any of the SSL ciphers known by the service.
  154. * `timeout`: The service timed out trying to connect to the URL.
  155. * `invalid_content`: The content at the URL was not valid. For example, providing a URL to an image will return this error.
  156. * `no_link_found`: The target link was not found on the page. When a target parameter is provided, this is the error that will be returned if the target could not be found on the page.
  157. * `no_content`: No usable content could be found at the given URL.
  158. * `unauthorized`: The URL returned HTTP 401 Unauthorized.
  159. * `forbidden`: The URL returned HTTP 403 Forbidden.
  160. ### Response Format
  161. ```json
  162. {
  163. "data":{
  164. "type":"entry",
  165. "published":"2017-03-01T19:00:33-08:00",
  166. "url":"https://aaronparecki.com/2017/03/01/14/hwc",
  167. "category":[
  168. "indieweb",
  169. "hwc"
  170. ],
  171. "photo":[
  172. "https://aaronparecki.com/2017/03/01/14/photo.jpg"
  173. ],
  174. "syndication":[
  175. "https://twitter.com/aaronpk/status/837135519427395584"
  176. ],
  177. "content":{
  178. "text":"Hello from Homebrew Website Club PDX! Thanks to @DreamHost for hosting us! 🍕🎉 #indieweb",
  179. "html":"Hello from Homebrew Website Club PDX! Thanks to <a href=\"https://twitter.com/DreamHost\">@DreamHost</a> for hosting us! <a href=\"https://aaronparecki.com/emoji/%F0%9F%8D%95\">🍕</a><a href=\"https://aaronparecki.com/emoji/%F0%9F%8E%89\">🎉</a> <a href=\"https://aaronparecki.com/tag/indieweb\">#indieweb</a>"
  180. },
  181. "author":{
  182. "type":"card",
  183. "name":"Aaron Parecki",
  184. "url":"https://aaronparecki.com/",
  185. "photo":"https://aaronparecki.com/images/profile.jpg"
  186. }
  187. },
  188. "url":"https://aaronparecki.com/2017/03/01/14/hwc",
  189. "code":200
  190. }
  191. ```
  192. #### Primary Data
  193. The primary object on the page is returned in the `data` property. This will indicate the type of object (e.g. `entry`), and will contain the vocabulary's properties that it was able to parse from the page.
  194. If a property supports multiple values, it will always be returned as an array. The following properties support multiple values:
  195. * in-reply-to
  196. * like-of
  197. * repost-of
  198. * bookmark-of
  199. * syndication
  200. * photo (of entry, not of a card)
  201. * video
  202. * audio
  203. * category
  204. The content will be an object that always contains a "text" property and may contain an "html" property if the source documented published HTML content. The "text" property must always be HTML escaped before displaying it as HTML, as it may include unescaped characters such as `<` and `>`.
  205. The author will always be set in the entry if available. The service follows the [authorship discovery](https://indieweb.org/authorship) algorithm to try to find the author information elsewhere on the page if it is not inside the entry in the source document.
  206. All URLs provided in the output are absolute URLs. If the source document contains a relative URL, it will be resolved first.
  207. #### Other Properties
  208. Other properties are returned in the response at the same level as the `data` property.
  209. * `url` - The effective URL that the document was retrieved from. This will be the final URL after following any redirects.
  210. * `code` - The HTTP response code returned by the URL. Typically this will be 200, but if the URL returned an alternate HTTP code that also included an h-entry (such as a 410 deleted notice with a stub h-entry), you can use this to find out that the original URL was actually deleted.
  211. #### Feeds
  212. XRay can return information for several kinds of feeds. The URL (or body) passed to XRay will be checked for the following formats:
  213. * XML (Atom and RSS)
  214. * JSONFeed (https://jsonfeed.org)
  215. * Microformats [h-feed](https://indieweb.org/h-feed)
  216. If the page being parsed represents a feed, then the response will look like the following:
  217. ```json
  218. {
  219. "data": {
  220. "type": "feed",
  221. "items": [
  222. ]
  223. }
  224. }
  225. ```
  226. Each object in the `items` array will contain a parsed version of the item, in the same format that XRay normally returns. When parsing Microformats feeds, the [authorship discovery](https://indieweb.org/authorship) will be run for each item to build out the author info.
  227. Atom, RSS and JSONFeed will all be normalized to XRay's vocabulary, and only recognized properties will be returned.
  228. ## Rels
  229. There is also an API method to parse and return all rel values on the page, including HTTP `Link` headers and HTML rel values.
  230. ```
  231. GET /rels?url=https://aaronparecki.com/
  232. ```
  233. ## Token API
  234. When verifying [Private Webmentions](https://indieweb.org/Private-Webmention#How_to_Receive_Private_Webmentions), you will need to exchange a code for an access token at the token endpoint specified by the source URL.
  235. XRay provides an API that will do this in one step. You can provide the source URL and code you got from the webmention, and XRay will discover the token endpoint, and then return you an access token.
  236. ```
  237. POST /token
  238. source=http://example.com/private-post
  239. &code=1234567812345678
  240. ```
  241. The response will be the response from the token endpoint, which will include an `access_token` property, and possibly an `expires_in` property.
  242. ```
  243. {
  244. "access_token": "eyJ0eXAXBlIjoI6Imh0dHB8idGFyZ2V0IjoraW0uZGV2bb-ZO6MV-DIqbUn_3LZs",
  245. "token_type": "bearer",
  246. "expires_in": 3600
  247. }
  248. ```
  249. If there was a problem fetching the access token, you will get one of the errors below in addition to the HTTP related errors returned by the parse API:
  250. * `no_token_endpoint` - Unable to find an HTTP header specifying the token endpoint.
  251. ## Installation
  252. ### From Source
  253. ```
  254. # Clone this repository
  255. git clone git@github.com:aaronpk/XRay.git
  256. cd XRay
  257. # Install dependencies
  258. composer install
  259. ```
  260. ### From Zip Archive
  261. * Download the latest release from https://github.com/aaronpk/XRay/releases
  262. * Extract to a folder on your web server
  263. ### Web Server Configuration
  264. Configure your web server to point to the `public` folder.
  265. Make sure all requests are routed to `index.php`. XRay ships with `.htaccess` files for Apache. For nginx, you'll need a rule like the following in your server config block.
  266. ```
  267. try_files $uri /index.php?$args;
  268. ```