Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/j0k3r/graby
Graby helps you extract article content from web pages
https://github.com/j0k3r/graby
composer content extract-website hacktoberfest php readability text-rss
Last synced: 21 days ago
JSON representation
Graby helps you extract article content from web pages
- Host: GitHub
- URL: https://github.com/j0k3r/graby
- Owner: j0k3r
- License: mit
- Created: 2015-05-03T09:21:49.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-30T08:44:11.000Z (about 1 month ago)
- Last Synced: 2024-09-30T22:41:01.383Z (about 1 month ago)
- Topics: composer, content, extract-website, hacktoberfest, php, readability, text-rss
- Language: PHP
- Homepage:
- Size: 2.71 MB
- Stars: 365
- Watchers: 17
- Forks: 74
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
[](https://gitter.im/j0k3r/graby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://coveralls.io/github/j0k3r/graby?branch=master)
[](https://packagist.org/packages/j0k3r/graby)
[](https://packagist.org/packages/j0k3r/graby)
Graby helps you extract article content from web pages
- it's based on [php-readability](https://github.com/j0k3r/php-readability)
- it uses [site_config](http://help.fivefilters.org/customer/portal/articles/223153-site-patterns) to extract content from websites
- it's a fork of Full-Text RSS v3.3 from [@fivefilters](http://fivefilters.org/)
## Why this fork ?
Full-Text RSS works great as a standalone application. But when you need to encapsulate it in your own library it's a mess. You need this kind of ugly thing:
```php
$article = 'http://www.bbc.com/news/entertainment-arts-32547474';
$request = 'http://example.org/full-text-rss/makefulltextfeed.php?format=json&url='.urlencode($article);
$result = @file_get_contents($request);
```
Also, if you want to understand how things work internally, it's really hard to read and understand. And finally, there are **no tests** at all.
That's why I made this fork:
1. Easiest way to integrate it (using composer)
2. Fully tested
3. (hopefully) better to understand
4. A bit more decoupled
## How to use it
> **Note**
> These instructions are for development version of Graby, which has an API incompatible with the stable version. Please check out the [README in the `2.x` branch](https://github.com/j0k3r/graby/blob/2.x/README.md#how-to-use-it) for usage instructions for the stable version.
### Requirements
- PHP >= 7.4
- [Tidy](https://github.com/htacg/tidy-html5) & cURL extensions enabled
### Installation
Add the lib using [Composer](https://getcomposer.org/):
composer require 'j0k3r/graby dev-master' php-http/guzzle7-adapter
Why `php-http/guzzle7-adapter`? Because Graby is decoupled from any HTTP client implementation, thanks to [HTTPlug](http://httplug.io/) (see [that list of client implementation](https://packagist.org/providers/php-http/client-implementation)).
Graby is tested & should work great with:
- Guzzle 7 (using `php-http/guzzle7-adapter`)
- cURL (using `php-http/curl-client`)
Note: if you want to use Guzzle 5 or 6, use Graby 2 (support has dropped in v3 because of dependencies conflicts)
### Retrieve content from an url
Use the class to retrieve content:
```php
use Graby\Graby;
$article = 'http://www.bbc.com/news/entertainment-arts-32547474';
$graby = new Graby();
$result = $graby->fetchContent($article);
var_dump($result->getResponse()->getStatus()); // 200
var_dump($result->getHtml()); // "[Fetched and readable content…]"
var_dump($result->getTitle()); // "Ben E King: R&B legend dies at 76"
var_dump($result->getLanguage()); // "en-GB"
var_dump($result->getDate()); // "2015-05-01T16:24:37+01:00"
var_dump($result->getAuthors()); // ["BBC News"]
var_dump((string) $result->getResponse()->getEffectiveUri()); // "http://www.bbc.com/news/entertainment-arts-32547474"
var_dump($result->getImage()); // "https://ichef-1.bbci.co.uk/news/720/media/images/82709000/jpg/_82709878_146366806.jpg"
var_dump($result->getSummary()); // "Ben E King received an award from the Songwriters Hall of Fame in …"
var_dump($result->getIsNativeAd()); // false
var_dump($result->getResponse()->getHeaders()); /*
[
'server' => ['Apache'],
'content-type' => ['text/html; charset=utf-8'],
'x-news-data-centre' => ['cwwtf'],
'content-language' => ['en'],
'x-pal-host' => ['pal074.back.live.cwwtf.local:80'],
'x-news-cache-id' => ['13648'],
'content-length' => ['157341'],
'date' => ['Sat, 29 Apr 2017 07:35:39 GMT'],
'connection' => ['keep-alive'],
'cache-control' => ['private, max-age=60, stale-while-revalidate'],
'x-cache-action' => ['MISS'],
'x-cache-age' => ['0'],
'x-lb-nocache' => ['true'],
'vary' => ['X-CDN,X-BBC-Edge-Cache,Accept-Encoding'],
]
*/
```
In case of error when fetching the url, graby won't throw an exception but will return information about the error (at least the status code):
```php
var_dump($result->getResponse()->getStatus()); // 200
var_dump($result->getHtml()); // "[unable to retrieve full-text content]"
var_dump($result->getTitle()); // "BBC - 404: Not Found"
var_dump($result->getLanguage()); // "en-GB"
var_dump($result->getDate()); // null
var_dump($result->getAuthors()); // []
var_dump((string) $result->getResponse()->getEffectiveUri()); // "http://www.bbc.co.uk/404"
var_dump($result->getImage()); // null
var_dump($result->getSummary()); // "[unable to retrieve full-text content]"
var_dump($result->getIsNativeAd()); // false
var_dump($result->getResponse()->getHeaders()); // […]
```
The `date` result is the same as displayed in the content. If `date` is not `null` in the result, we recommend you to parse it using [`date_parse`](http://php.net/date_parse) (this is what we are using to validate that the date is correct).
### Retrieve content from a prefetched page
If you want to extract content from a page you fetched outside of Graby, you can call `setContentAsPrefetched()` before calling `fetchContent()`, e.g.:
``` php
use Graby\Graby;
$article = 'http://www.bbc.com/news/entertainment-arts-32547474';
$input = '[...]';
$graby = new Graby();
$graby->setContentAsPrefetched($input);
$result = $graby->fetchContent($article);
```
### Cleanup content
Since the 1.9.0 version, you can also send html content to be cleanup in the same way graby clean content retrieved from an url. The url is still needed to convert links to absolute, etc.
```php
use Graby\Graby;
$article = 'http://www.bbc.com/news/entertainment-arts-32547474';
// use your own way to retrieve html or to provide html
$html = ...
$graby = new Graby();
$result = $graby->cleanupHtml($html, $article);
```
### Use custom handler & formatter to see output log
You can use them to display graby output log to the end user.
It's aim to be used in a Symfony project using Monolog.
Define the graby handler service (somewhere in a `service.yml`):
```yaml
services:
# ...
graby.log_handler:
class: Graby\Monolog\Handler\GrabyHandler
```
Then define the Monolog handler in your `app/config/config.yml`:
```yaml
monolog:
handlers:
graby:
type: service
id: graby.log_handler
# use "debug" to got a lot of data (like HTML at each step) otherwise "info" is fine
level: debug
channels: ['graby']
```
You can then retrieve logs from graby in your controller using:
```php
$logs = $this->get('monolog.handler.graby')->getRecords();
```
### Timeout configuration
If you need to define a timeout, you must create the `Http\Client\HttpClient` manually,
configure it and inject it to `Graby\Graby`.
- For Guzzle 7:
```php
use Graby\Graby;
use GuzzleHttp\Client as GuzzleClient;
use Http\Adapter\Guzzle7\Client as GuzzleAdapter;
$guzzle = new GuzzleClient([
'timeout' => 2,
]);
$graby = new Graby([], new GuzzleAdapter($guzzle));
```
## Full configuration
This is the full documented configuration and also the default one.
```php
$graby = new Graby([
// Enable or disable debugging.
// This will only generate log information in a file (log/graby.log)
'debug' => false,
// use 'debug' value if you want more data (HTML at each step for example) to be dumped in a different file (log/html.log)
'log_level' => 'info',
// If enabled relative URLs found in the extracted content are automatically rewritten as absolute URLs.
'rewrite_relative_urls' => true,
// If enabled, we will try to follow single page links (e.g. print view) on multi-page articles.
// Currently this only happens for sites where single_page_link has been defined
// in a site config file.
'singlepage' => true,
// If enabled, we will try to follow next page links on multi-page articles.
// Currently this only happens for sites where next_page_link has been defined
// in a site config file.
'multipage' => true,
// Error message when content extraction fails
'error_message' => '[unable to retrieve full-text content]',
// Default title when we won't be able to extract a title
'error_message_title' => 'No title found',
// List of URLs (or parts of a URL) which will be accept.
// If the list is empty, all URLs (except those specified in the blocked list below)
// will be permitted.
// Example: array('example.com', 'anothersite.org');
'allowed_urls' => [],
// List of URLs (or parts of a URL) which will be not accept.
// Note: this list is ignored if allowed_urls is not empty
'blocked_urls' => [],
// If enabled, we'll pass retrieved HTML content through htmLawed with
// safe flag on and style attributes denied, see
// http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed/htmLawed_README.htm#s3.6
// Note: if enabled this will also remove certain elements you may want to preserve, such as iframes.
'xss_filter' => true,
// Here you can define different actions based on the Content-Type header returned by server.
// MIME type as key, action as value.
// Valid actions:
// * 'exclude' - exclude this item from the result
// * 'link' - create HTML link to the item
'content_type_exc' => [
'application/zip' => ['action' => 'link', 'name' => 'ZIP'],
'application/pdf' => ['action' => 'link', 'name' => 'PDF'],
'image' => ['action' => 'link', 'name' => 'Image'],
'audio' => ['action' => 'link', 'name' => 'Audio'],
'video' => ['action' => 'link', 'name' => 'Video'],
'text/plain' => ['action' => 'link', 'name' => 'Plain text'],
],
// How we handle link in content
// Valid values :
// * preserve: nothing is done
// * footnotes: convert links as footnotes
// * remove: remove all links
'content_links' => 'preserve',
'http_client' => [
// User-Agent used to fetch content
'ua_browser' => 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.2 (KHTML, like Gecko) Chrome/15.0.874.92 Safari/535.2',
// default referer when fetching content
'default_referer' => 'http://www.google.co.uk/url?sa=t&source=web&cd=1',
// Currently allows simple string replace of URLs.
// Useful for rewriting certain URLs to point to a single page or HTML view.
// Although using the single_page_link site config instruction is the preferred way to do this, sometimes, as
// with Google Docs URLs, it's not possible.
'rewrite_url' => [
'docs.google.com' => ['/Doc?' => '/View?'],
'tnr.com' => ['tnr.com/article/' => 'tnr.com/print/article/'],
'.m.wikipedia.org' => ['.m.wikipedia.org' => '.wikipedia.org'],
'm.vanityfair.com' => ['m.vanityfair.com' => 'www.vanityfair.com'],
],
// Prevent certain file/mime types
// HTTP responses which match these content types will
// be returned without body.
'header_only_types' => [
'image',
'audio',
'video',
],
// URLs ending with one of these extensions will
// prompt Humble HTTP Agent to send a HEAD request first
// to see if returned content type matches $headerOnlyTypes.
'header_only_clues' => ['mp3', 'zip', 'exe', 'gif', 'gzip', 'gz', 'jpeg', 'jpg', 'mpg', 'mpeg', 'png', 'ppt', 'mov'],
// User Agent strings - mapping domain names
'user_agents' => [],
// AJAX triggers to search for.
// for AJAX sites, e.g. Blogger with its dynamic views templates.
'ajax_triggers' => [
" 10,
],
'extractor' => [
'default_parser' => 'libxml',
// key is fingerprint (fragment to find in HTML)
// value is host name to use for site config lookup if fingerprint matches
// \s* match anything INCLUDING new lines
'fingerprints' => [
'/\ 'fingerprint.blogspot.com',
'/\ 'fingerprint.blogspot.com',
'/\ 'fingerprint.wordpress.com',
],
'config_builder' => [
// Directory path to the site config folder WITHOUT trailing slash
'site_config' => [],
'hostname_regex' => '/^(([a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9-]*[A-Za-z0-9])$/',
],
'readability' => [
// filters might be like array('regex' => 'replace with')
// for example, to remove script content: array('!]*>(.*?)!is' => '')
'pre_filters' => [],
'post_filters' => [],
],
'src_lazy_load_attributes' => [
'data-src',
'data-lazy-src',
'data-original',
'data-sources',
'data-hi-res-src',
],
// these JSON-LD types will be ignored
'json_ld_ignore_types' => ['Organization', 'WebSite', 'Person', 'VideoGame'],
],
]);
```
## Credits
- [FiveFilters](https://github.com/fivefilters) for [Full-Text-RSS](https://fivefilters.org/content-only/)
- [Caneco](https://twitter.com/caneco) for the awesome logo ✨