mirrors/rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2024-11-24 18:36:59 +03:00
Code Issues Projects Releases Packages Wiki Activity
The RSS feed for websites missing it
398 commits 9 branches 34 tags 31 MiB
PHP 99.1%
JavaScript 0.4%
CSS 0.3%
Dockerfile 0.1%
Find a file
Mitsukarenai c13c7a1d25 cache: check if cache folder exists
2015-12-03 22:09:18 +01:00
bridges .pw just changed to .io 2015-11-06 22:49:40 +01:00
caches Refonte du code 2013-08-11 13:30:41 +02:00
css Bridgecount and prepare for catchphrase 2014-05-28 17:34:50 +02:00
formats Core: add author to HTML output format 2015-10-13 18:04:45 +02:00
lib Ajout de la possibilité d'avoir une liste en paramètre, voir exemple d'utilisation dans DauphineLibereBridge. 2015-09-14 13:59:20 +01:00
vendor/simplehtmldom add simple_html_dom 2014-05-21 17:25:59 +02:00
.gitattributes First commit 2013-08-06 23:57:22 +02:00
.gitignore ignore some ide 2014-07-20 01:41:44 +02:00
CHANGELOG.md Corrections 2013-08-12 22:37:19 +02:00
index.php cache: check if cache folder exists 2015-12-03 22:09:18 +01:00
README.md [Facebook] Added to main bridges (#148) 2015-10-08 00:25:36 +02:00
UNLICENSE let's unlicense ! 2014-05-21 20:11:01 +02:00

README.md

rss-bridge

rss-bridge is a PHP project capable of generating ATOM feeds for websites which don't have one.

Supported sites/pages (main)

  • FlickrExplore : Latest interesting images from Flickr
  • GoogleSearch : Most recent results from Google Search
  • GooglePlus : Most recent posts of user timeline
  • Twitter : Return keyword/hashtag search or user timeline
  • Identi.ca : Identica user timeline (Should be compatible with other Pump.io instances)
  • YouTube : YouTube user channel, playlist or search
  • Cryptome : Returns the most recent documents from Cryptome.org
  • DansTonChat: Most recent quotes from danstonchat.com
  • DuckDuckGo: Most recent results from DuckDuckGo.com
  • Instagram: Most recent photos from an Instagram user
  • OpenClassrooms: Lastest tutorials from fr.openclassrooms.com
  • Pinterest: Most recent photos from user or search
  • ScmbBridge: Newest stories from secouchermoinsbete.fr
  • WikipediaENLatest: highlighted articles from Wikipedia in English
  • WikipediaFRLatest: highlighted articles from Wikipedia in French
  • WikipediaEOLatest: highlighted articles from Wikipedia in Esperanto
  • Bandcamp : Returns last release from bandcamp for a tag
  • ThePirateBay : Returns the newest indexed torrents from The Pirate Bay with keywords
  • Facebook : Returns the latest posts on a page or profile on Facebook

Plus many other bridges to enable, thanks to the community

Output format

Output format can take several forms:

  • Atom : ATOM Feed, for use in RSS/Feed readers
  • Json : Json, for consumption by other applications.
  • Html : Simple html page.
  • Plaintext : raw text (php object, as returned by print_r)

Screenshot

Welcome screen:

Screenshot

Minecraft hashtag (#Minecraft) search on Twitter, in ATOM format (as displayed by Firefox):

Screenshot

Requirements

  • PHP 5.4
  • openssl extension enabled in PHP config (php.ini)

Enabling/Disabling bridges

By default, the script creates whitelist.txt and adds the main bridges (see above). whitelist.txt is ignored by git, you can edit it:

  • to enable extra bridges (one bridge per line)
  • to disable main bridges (remove the line)

New bridges are disabled by default, so make sure to check regularly what's new and whitelist what you want !

Author

I'm sebsauvage, webmaster of sebsauvage.net, author of Shaarli and ZeroBin.

Patch/contributors :

License

Code is Public Domain.

Including PHP Simple HTML DOM Parser under the MIT License

Technical notes

  • There is a cache so that source services won't ban you even if you hammer the rss-bridge with requests. Each bridge has a different duration for the cache. The cache subdirectory will be automatically created. You can purge it whenever you want.
  • To implement a new rss-bridge, create a new class in bridges subdirectory. Look at existing bridges for examples and the guidelines below. For items you generate in $this->items, only uri and title are mandatory in each item. timestamp and content are optional but recommended. Any additional key will be ignored by ATOM feed (but outputed to json).

Bridge guidelines

  • metatags: @name {Name of service}, @homepage {URL to homepage}, @description, @update {YYYY-MM-DD}, @maintainer {Github username or nickname}
  • scripts (eg. Javascript) must be stripped out. Make good use of strip_tags() and preg_replace()
  • bridge must present data within 8 seconds (adjust iterators accordingly)
  • cache timeout must be fine-tuned so that each refresh can provide 1 or 2 new elements on busy periods
  • <audio> and <video> must not autoplay. Seriously.
  • do everything you can to extract valid timestamps. Translate formats, use API, exploit sitemap, whatever. Free the data!
  • don't create duplicates. If the website runs on WordPress, use the generic WordPress bridge if possible.
  • maintain efficient and well-commented code 😉

Rant

Dear so-called "social" websites.

Your catchword is "share", but you don't want us to share. You want to keep us within your walled gardens. That's why you've been removing RSS links from webpages, hiding them deep on your website, or removed RSS entirely, replacing it with crippled or demented proprietary API. FUCK YOU.

You're not social when you hamper sharing by removing RSS. You're happy to have customers creating content for your ecosystem, but you don't want this content out - a content you do not even own. Google Takeout is just a gimmick. We want our data to flow, we want RSS.

We want to share with friends, using open protocols: RSS, XMPP, whatever. Because no one wants to have your service with your applications using your API force-feeding them. Friends must be free to choose whatever software and service they want.

We are rebuilding bridges you have wilfully destroyed.

Get your shit together: Put RSS back in.