README.md 18.6 KB
Newer Older
Barnaby Walters's avatar
Barnaby Walters committed
1 2 3
php-mf2
=======

Barnaby Walters's avatar
Barnaby Walters committed
4 5 6
php-mf2 is a pure, generic [microformats-2](http://microformats.org/wiki/microformats-2) parser. It makes HTML as easy to consume as JSON.

Instead of having a hard-coded list of all the different microformats, it follows a set of procedures to handle different property types (e.g. `p-` for plaintext, `u-` for URL, etc). This allows for a very small and maintainable parser.
7 8 9

## Installation

Barnaby Walters's avatar
Barnaby Walters committed
10
There are two ways of installing php-mf2. I **highly recommend** installing php-mf2 using [Composer](http://getcomposer.org). The rest of the documentation assumes that you have done so.
Barnaby Walters's avatar
Barnaby Walters committed
11

Barnaby Walters's avatar
Barnaby Walters committed
12 13
To install using Composer, run `./composer.phar require mf2/mf2:~0.2`

14 15 16 17 18 19 20 21 22 23
If you can’t or don’t want to use Composer, then php-mf2 can be installed the old way by downloading [`/Mf2/Parser.php`](https://raw.githubusercontent.com/indieweb/php-mf2/master/Mf2/Parser.php), adding it to your project and requiring it from files you want to call its functions from, like this:

```php
<?php

require_once 'Mf2/Parser.php';

// Now all the functions documented below are available, for example:
$mf = Mf2\fetch('https://waterpigs.co.uk');
```
Barnaby Walters's avatar
Barnaby Walters committed
24 25 26 27

### Signed Code Verification

From v0.2.9, php-mf2’s version tags are signed using GPG by barnaby@waterpigs.co.uk. This allows you to cryptographically verify that you’re using the right code. To do so you will need my key — you don’t have it, get it like this:
28 29 30 31 32 33 34 35 36 37 38 39 40

```bash
gpg --recv-keys 7D49834B0416CFA3
```

Then verify the installed files like this:

```bash
# in your project root
cd vendor/mf2/mf2
git tag -v v0.2.9
```

Barnaby Walters's avatar
Barnaby Walters committed
41
If nothing went wrong, you should see the tag commit message, ending something like this:
42 43 44 45 46 47 48

```
gpg: Signature made Wed  6 Aug 10:04:20 2014 GMT using RSA key ID 2B2BBB65
gpg: Good signature from "Barnaby Walters <barnaby@waterpigs.co.uk>"
gpg:                 aka "[jpeg image of size 12805]"
```

49 50 51
Possible issues:

* **Git complains that there’s no such tag**: check for a .git file in the source folder; odds are you have the prefer-dist setting enabled and composer is just extracting a zip rather than checking out from git.
52
* **Git complains the gpg command doesn’t exist**: If you successfully imported my key then you obviously do have gpg installed, but you might have gpg2, whereas git looks for gpg. Solution: tell git which binary to use: `git config --global gpg.program 'gpg2'`
53

54 55
## Usage

56
php-mf2 is PSR-0 autoloadable, so simply include Composer’s auto-generated autoload file (`/vendor/autoload.php`) and you can start using it. These two functions cover most situations:
57

Barnaby Walters's avatar
Barnaby Walters committed
58 59
* To fetch microformats from a URL, call `Mf2\fetch($url)`
* To parse microformats from HTML, call `Mf2\parse($html, $url)`, where `$url` is the URL from which `$html` was loaded, if any. This parameter is required for correct relative URL parsing and must not be left out unless parsing HTML which is not loaded from the web.
60

Barnaby Walters's avatar
Barnaby Walters committed
61 62
## Examples

Barnaby Walters's avatar
Barnaby Walters committed
63
### Fetching microformats from a page
64

65
```php
66 67
<?php

Barnaby Walters's avatar
Barnaby Walters committed
68
namespace YourApp;
69

Barnaby Walters's avatar
Barnaby Walters committed
70
require '/vendor/autoload.php';
71

Barnaby Walters's avatar
Barnaby Walters committed
72
use Mf2;
73

Barnaby Walters's avatar
Barnaby Walters committed
74 75 76 77 78 79 80 81 82 83
// (Above code (or equivalent) assumed in future examples)

$mf = Mf2\fetch('http://microformats.org');

foreach ($mf['items'] as $microformat) {
	echo "A {$microformat['type'][0]} called {$microformat['properties']['name'][0]}\n";
}

```

Barnaby Walters's avatar
Barnaby Walters committed
84 85 86
### Parsing microformats from a HTML string

Here we demonstrate parsing of microformats2 implied property parsing, where an entire h-card with name and URL properties is created using a single `h-card` class.
Barnaby Walters's avatar
Barnaby Walters committed
87 88 89 90

```php
<?php

Barnaby Walters's avatar
Barnaby Walters committed
91
$output = Mf2\parse('<a class="h-card" href="https://waterpigs.co.uk/">Barnaby Walters</a>');
92 93
```

94
`$output` is a canonical microformats2 array structure like:
Barnaby Walters's avatar
Barnaby Walters committed
95 96 97 98 99 100

```json
{
	"items": [{
		"type": ["h-card"],
		"properties": {
101
			"name": ["Barnaby Walters"],
Barnaby Walters's avatar
Barnaby Walters committed
102
			"url": ["https://waterpigs.co.uk/"]
Barnaby Walters's avatar
Barnaby Walters committed
103 104 105 106
		}
	}],
	"rels": {}
}
107 108
```

Barnaby Walters's avatar
Barnaby Walters committed
109
If no microformats are found, `items` will be an empty array.
110

Barnaby Walters's avatar
Barnaby Walters committed
111
Note that, whilst the property prefixes are stripped, the prefix of the `h-*` classname(s) in the "type" array are retained.
112

Barnaby Walters's avatar
Barnaby Walters committed
113
### Parsing a document with relative URLs
114

Barnaby Walters's avatar
Barnaby Walters committed
115
Most of the time you’ll be getting your input HTML from a URL. You should pass that URL as the second parameter to `Mf2\parse()` so that any relative URLs in the document can be resolved. For example, say you got the following HTML from `http://example.org`:
116

Barnaby Walters's avatar
Barnaby Walters committed
117 118 119 120 121 122
```html
<div class="h-card">
	<h1 class="p-name">Mr. Example</h1>
	<img class="u-photo" alt="" src="photo.png" />
</div>
```
123

Barnaby Walters's avatar
Barnaby Walters committed
124
Parsing like this:
125 126

```php
Barnaby Walters's avatar
Barnaby Walters committed
127 128
$output = Mf2\parse($html, 'http://example.org');
```
129

Barnaby Walters's avatar
Barnaby Walters committed
130 131 132 133 134 135 136 137 138 139 140 141 142
will result in the following output, with relative URLs made absolute:

```json
{
	"items": [{
		"type": ["h-card"],
		"properties": {
			"photo": ["http://example.org/photo.png"]
		}
	}],
	"rels": {}
}
```
143

Barnaby Walters's avatar
Barnaby Walters committed
144
php-mf2 correctly handles relative URL resolution according to the URI and HTML specs, including correct use of the `<base>` element.
145

Barnaby Walters's avatar
Barnaby Walters committed
146
### Parsing `rel` and `rel=alternate` values
147

Barnaby Walters's avatar
Barnaby Walters committed
148
php-mf2 also parses any link relations in the document, placing them into two top-level arrays — one for `rel=alternate` and another for all other rel values, e.g. when parsing:
149

Barnaby Walters's avatar
Barnaby Walters committed
150 151 152
```html
<a rel="me" href="https://twitter.com/barnabywalters">Me on twitter</a>
<link rel="alternate etc" href="http://example.com/notes.atom" />
153 154
```

Barnaby Walters's avatar
Barnaby Walters committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168
parsing will result in the following keys:

```json
{
	"items": [],
	"rels": {
		"me": ["https://twitter.com/barnabywalters"]
	},
	"alternates": [{
		"url": "http://example.com/notes.atom",
		"rel": "etc"
	}]
}
```
169

Barnaby Walters's avatar
Barnaby Walters committed
170
Protip: if you’re not bothered about the microformats2 data and just want rels and alternates, you can improve performance by creating a `Mf2\Parser` object (see below) and calling `->parseRelsAndAlternates()` instead of `->parse()`, e.g.
171 172

```php
Barnaby Walters's avatar
Barnaby Walters committed
173 174 175 176
<?php

$parser = new Mf2\Parser('<link rel="…');
$relsAndAlternates = $parser->parseRelsAndAlternates();
177 178
```

Barnaby Walters's avatar
Barnaby Walters committed
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
### Debugging Mf2\fetch

`Mf2\fetch()` will attempt to parse any response served with “HTML” in the content-type, regardless of what the status code is. If it receives a non-HTML response it will return null.

To learn what the HTTP status code for any request was, or learn more about the request, pass a variable name as the third parameter to `Mf2\fetch()` — this will be filled with the contents of `curl_getinfo()`, e.g:

```php

<?php

$mf = Mf2\fetch('http://waterpigs.co.uk/this-page-doesnt-exist', true, $curlInfo);
if ($curlInfo['http_code'] == '404') {
	// This page doesn’t exist.
}

```

If it was HTML then it is still parsed, as there are cases where error pages contain microformats — for example a deleted h-entry resulting in a 410 Gone response containing a stub h-entry with amn explanation for the deletion.

Barnaby Walters's avatar
Barnaby Walters committed
198
### Getting more control by creating a Parser object
199

Barnaby Walters's avatar
Barnaby Walters committed
200
The `Mf2\parse()` function covers the most common usage patterns by internally creating an instance of `Mf2\Parser` and returning the output all in one step. For some advanced usage you can also create an instance of `Mf2\Parser` yourself.
201

Barnaby Walters's avatar
Barnaby Walters committed
202
The constructor takes two arguments, the input HTML (or a DOMDocument) and the URL to use as a base URL. Once you have a parser, there are a few other things you can do:
203

Barnaby Walters's avatar
Barnaby Walters committed
204
### Selectively parsing a document
Barnaby Walters's avatar
Barnaby Walters committed
205

Barnaby Walters's avatar
Barnaby Walters committed
206
There are several ways to selectively parse microformats from a document. If you wish to only parse microformats from an element with a particular ID, `Parser::parseFromId($id) ` is the easiest way.
207

Barnaby Walters's avatar
Barnaby Walters committed
208 209 210 211 212
If your needs are more complex, `Parser::parse` accepts an optional context DOMNode as its second parameter. Typically you’d use `Parser::query` to run XPath queries on the document to get the element you want to parse from under, then pass it to `Parser::parse`. Example usage:

```php
$doc = 'More microformats, more microformats <div id="parse-from-here"><span class="h-card">This shows up</span></div> yet more ignored content';
$parser = new Mf2\Parser($doc);
213

Barnaby Walters's avatar
Barnaby Walters committed
214
$parser->parseFromId('parse-from-here'); // returns a document with only the h-card descended from div#parse-from-here
215

Barnaby Walters's avatar
Barnaby Walters committed
216
$elementIWant = $parser->query('an xpath query')[0];
217

Barnaby Walters's avatar
Barnaby Walters committed
218
$parser->parse(true, $elementIWant); // returns a document with only mfs under the selected element
219

Barnaby Walters's avatar
Barnaby Walters committed
220
```
221

222 223 224 225 226 227 228 229 230 231 232
### Generating output for JSON serialization with JSON-mode

Due to a quirk with the way PHP arrays work, there is an edge case ([reported](https://github.com/indieweb/php-mf2/issues/29) by Tom Morris) in which a document with no rel values, when serialised as JSON, results in an empty object as the rels value rather than an empty array. Replacing this in code with a stdClass breaks PHP iteration over the values.

As of version 0.2.6, the default behaviour is back to being PHP-friendly, so if you want to produce results specifically for serialisation as JSON (for example if you run a HTML -> JSON service, or want to run tests against JSON fixtures), enable JSON mode:

```php
// …by passing true as the third constructor:
$jsonParser = new Mf2\Parser($html, $url, true);
```

Barnaby Walters's avatar
Barnaby Walters committed
233
### Classic Microformats Markup
234

Barnaby Walters's avatar
Barnaby Walters committed
235
php-mf2 has some support for parsing classic microformats markup. It’s enabled by default, but can be turned off by calling `Mf2\parse($html, $url, false);` or `$parser->parse(false);` if you’re instanciating a parser yourself.
236

Barnaby Walters's avatar
Barnaby Walters committed
237
In previous versions of php-mf2 you could also add your own class mappings — officially this is no longer supported.
238

Barnaby Walters's avatar
Barnaby Walters committed
239 240 241
* If the built in mappings don’t successfully parse some classic microformats markup then raise an issue and we’ll fix it.
* If you want to screen-scrape websites which don’t use mf2 into mf2 data structures, consider contributing to [php-mf2-shim](https://github.com/indieweb/php-mf2-shim)
* If you *really* need to make one-off changes to the default mappings… It is possible. But you have to figure it out for yourself ;)
242

Barnaby Walters's avatar
Barnaby Walters committed
243
## Security
244

Barnaby Walters's avatar
Barnaby Walters committed
245 246 247 248 249 250 251 252
**No filtering of content takes place in mf2\Parser, so treat its output as you would any untrusted data from the source of the parsed document.**

Some tips:

* All content apart from the 'html' key in dictionaries produced by parsing an `e-*` property is not HTML-escaped. For example, `<span class="p-name">&lt;code&gt;</span>` will result in `"name": ["<code>"]`. At the very least, HTML-escape all properties before echoing them out in HTML
* If you’re using the raw HTML content under the 'html' key of dictionaries produced by parsing `e-*` properties, you SHOULD purify the HTML before displaying it to prevent injection of arbitrary code. For PHP I recommend using [HTML Purifier](http://htmlpurifier.org)

TODO: move this section to a security/consumption best practises page on the wiki
Barnaby Walters's avatar
Barnaby Walters committed
253

254 255
## Contributing

256
Issues and bug reports are very welcome. If you know how to write tests then please do so as code always expresses problems and intent much better than English, and gives me a way of measuring whether or not fixes have actually solved your problem. If you don’t know how to write tests, don’t worry :) Just include as much useful information in the issue as you can.
257

258
Pull requests very welcome, please try to maintain stylistic, structural and naming consistency with the existing codebase, and don’t be too upset if I make naming changes :)
259

260
### How to make a Pull Request
261

262 263 264 265 266 267
1. Fork the repo to your github account
2. Clone a copy to your computer (simply installing php-mf2 using composer only works for using it, not developing it)
3. Install the dev dependencies with `./composer.phar install`
4. Run PHPUnit with `./vendor/bin/phpunit`
5. Make your changes
6. Add PHPUnit tests for your changes, either in an existing test file if suitable, or a new one
268
7. Make sure your tests pass (`./vendor/bin/phpunit`), preferably using both PHP 5.3 and 5.4
269 270
8. Go to your fork of the repo on github.com and make a pull request, preferably with a short summary, detailed description and references to issues/parsing specs as appropriate
9. Bask in the warm feeling of having contributed to a piece of free software
271

272
### Testing
Barnaby Walters's avatar
Barnaby Walters committed
273

274
There are currently two separate test suites: one, in `tests/Mf2`, is written in phpunit, containing many microformats parsing examples as well as internal parser tests and regression tests for specific issues over php-mf2’s history. Run it with `./vendor/bin/phpunit`.
Barnaby Walters's avatar
Barnaby Walters committed
275

276
The other, in `tests/test-suite`, is a custom test harness which hooks up php-mf2 to the cross-platform microformats test suite. Each test consists of a HTML file and a corresponding JSON file, and the suite can be run with `php ./tests/test-suite/test-suite.php`.
Barnaby Walters's avatar
Barnaby Walters committed
277

278
Currently php-mf2 passes the majority of it’s own test case, and a good percentage of the cross-platform tests. Contributors should ALWAYS test against the PHPUnit suite to ensure any changes don’t negatively impact php-mf2, and SHOULD run the cross-platform suite, especially if you’re changing parsing behaviour.
279 280 281

### Changelog

282 283 284 285
#### v0.2.12

2015-07-12

Aaron Parecki's avatar
Aaron Parecki committed
286 287
* Merges pull requests [#65](https://github.com/indieweb/php-mf2/pull/65), [#66](https://github.com/indieweb/php-mf2/pull/66) and [#67](https://github.com/indieweb/php-mf2/pull/67).
* Fixes issue [#64](https://github.com/indieweb/php-mf2/issues/64).
288 289 290 291 292 293 294

Many thanks to @aaronpk, @gRegorLove and @kylewm for contributions, @aaronpk and @kevinmarks for PR management and @tantek for issue reporting!

#### v0.2.11

2015-07-10

295 296 297 298
#### v0.2.10

2015-04-29

Aaron Parecki's avatar
Aaron Parecki committed
299
* Merged [#58](https://github.com/indieweb/php-mf2/pull/58), fixing some parsing bugs and adding support for area element parsing. Thanks so much for your hard work and patience, <a class="h-card" href="http://ben.thatmustbe.me/">Ben</a>!
300

301 302 303 304 305 306 307
#### v0.2.9

2014-08-06

* Added backcompat classmap for hProduct, associated tests
* Started GPG signing version tags as barnaby@waterpigs.co.uk, fingerprint CBC7 7876 BF7C 9637 B6AE 77BA 7D49 834B 0416 CFA3

Barnaby Walters's avatar
Barnaby Walters committed
308 309 310 311 312 313 314 315
#### v0.2.8

2014-07-17

* Fixed issue #51 causing php-mf2 to not work with PHP 5.3
* Fixed issue #52 correctly handling the `<template>` element by ignoring it
* Fixed issue #53 improving the plaintext parsing of `<img>` elements

316 317 318 319 320
#### v0.2.7

2014-06-18

* Added `Mf2\fetch()` which fetches content from a URL and returns parsed microformats
321
* Added implied `dt-end` discovery (thanks for all your hard work, @gRegorLove!)
322 323 324
* Fixed issue causing classnames like `blah e- blah` to produce properties with numeric keys (thanks @aaronpk and @gRegorLove)
* Fixed issue causing resolved URLs to not include port numbers (thanks @aaronpk)

325 326 327 328 329
#### v0.2.6

* Added JSON mode as long-term fix for #29
* Fixed bug causing microformats nested under multiple property names to be parsed only once

Barnaby Walters's avatar
Barnaby Walters committed
330 331 332 333 334 335
#### v0.2.5

* Removed conditional replacing empty rel list with stdclass. Original purpose was to make JSON-encoding the output from the parser correct but it also caused Fatal Errors due to trying to treat stdclass as array.

#### v0.2.4

336 337 338 339 340 341 342 343 344 345 346
#### v0.2.3

* Made p-* parsing consistent with implied name parsing
* Stopped collapsing whitespace in p-* properties
* Implemented unicodeTrim which removes &nbsp; characters as well as regex \s
* Added support for implied name via abbr[title]
* Prevented excessively nested value-class elements from being parsed incorrectly, removed incorrect separator which was getting added in some cases
* Updated u-* parsing to be spec-compliant, matching [href] before value-class and only attempting URL resolution for URL attributes
* Added support for input[value] parsing
* Tests for all the above

Barnaby Walters's avatar
Barnaby Walters committed
347 348 349
#### v0.2.2

* Made resolveUrl method public, allowing advanced parsers and subclasses to make use of it
350
* Fixed bug causing multiple duplicate property values to appear
Barnaby Walters's avatar
Barnaby Walters committed
351

Barnaby Walters's avatar
Barnaby Walters committed
352 353 354 355
#### v0.2.1

* Fixed bug causing classic microformats property classnames to not be parsed correctly

Barnaby Walters's avatar
Barnaby Walters committed
356 357 358 359
#### v0.2.0 (BREAKING CHANGES)

* Namespace change from mf2 to Mf2, for PSR-0 compatibility
* `Mf2\parse()` function added to simplify the most common case of just parsing some HTML
Barnaby Walters's avatar
Barnaby Walters committed
360
* Updated e-* property parsing rules to match mf2 parsing spec — instead of producing inconsistent HTML content, it now produces dictionaries like <pre><code>
Barnaby Walters's avatar
Barnaby Walters committed
361 362 363 364
{
	"html": "<b>The Content</b>",
	"value: "The Content"
}
Barnaby Walters's avatar
Barnaby Walters committed
365
</code></pre>
Barnaby Walters's avatar
Barnaby Walters committed
366 367 368 369
* Removed `htmlSafe` options as new e-* parsing rules make them redundant
* Moved a whole load of static functions out of the class and into standalone functions
* Changed autoloading to always include Parser.php instead of using classmap

Barnaby Walters's avatar
Barnaby Walters committed
370 371 372 373 374
#### v0.1.23

* Made some changes to the way back-compatibility with classic microformats are handled, ignoring classic property classnames inside mf2 roots and outside classic roots
* Deprecated ability to add new classmaps, removed twitter classmap. Use [php-mf2-shim](http://github.com/indieweb/php-mf2-shim) instead, it’s better

Barnaby Walters's avatar
Barnaby Walters committed
375 376 377 378
#### v0.1.22

* Converts classic microformats by default

Barnaby Walters's avatar
Barnaby Walters committed
379 380 381 382 383 384 385 386 387
#### v0.1.21

* Removed webignition dependency, also removing ext-intl dependency. php-mf2 is now a standalone, single file library again
* Replaced webignition URL resolving with custom code passing almost all tests, courtesy of <a class="h-card" href="http://aaronparecki.com">Aaron Parecki</a>

#### v0.1.20

* Added in almost-perfect custom URL resolving code

Barnaby Walters's avatar
Barnaby Walters committed
388 389 390 391
#### v0.1.19 (2013-06-11)

* Required stable version of webigniton/absolute-url-resolver, hopefully resolving versioning problems

Barnaby Walters's avatar
Barnaby Walters committed
392 393 394 395 396
#### v0.1.18 (2013-06-05)

* Fixed problems with isElementParsed, causing elements to be incorrectly parsed
* Cleaned up some test files

Barnaby Walters's avatar
Barnaby Walters committed
397 398 399 400
#### v0.1.17

* Rewrote some PHP 5.4 array syntax which crept into 0.1.16 so php-mf2 still works on PHP 5.3
* Fixed a bug causing weird partial microformats to be added to parent microformats if they had doubly property-nested children
Barnaby Walters's avatar
Barnaby Walters committed
401 402
* Finally actually licensed this project under a real license (MIT, in composer.json)
* Suggested barnabywalters/mf-cleaner in composer.json
Barnaby Walters's avatar
Barnaby Walters committed
403

404 405 406 407 408 409 410 411 412 413
#### v0.1.16

* Ability to parse from only an ID
* Context DOMElement can be passed to $parse
* Parser::query runs XPath queries on the current document
* When parsing e-* properties, elements with @src, @data or @href have relative URLs resolved in the output

#### v0.1.15

* Added html-safe options
414
* Added rel+rel-alternate parsing
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440


## License

Copyright (c) 2013 G5

MIT License

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.