PageRenderTime 45ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/README.md

https://github.com/16mhz/rss-bridge
Markdown | 119 lines | 87 code | 32 blank | 0 comment | 0 complexity | 2a6baea2db3f733bc073749d548d9676 MD5 | raw file
Possible License(s): Unlicense 
    

  1. rss-bridge
    2. 

  2. ===
    3. 

  3. 

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

    6. 

  6. Supported sites/pages (main)
    7. 

  7. ===
    8. 

  8. 

  9.  * `FlickrExplore` : [Latest interesting images](http://www.flickr.com/explore) from Flickr
    10. 

  10.  * `GoogleSearch` : Most recent results from Google Search
    11. 

  11.  * `GooglePlus` : Most recent posts of user timeline
    12. 

  12.  * `Twitter` : Return keyword/hashtag search or user timeline
    13. 

  13.  * `Identi.ca` : Identica user timeline (Should be compatible with other Pump.io instances)
    14. 

  14.  * `YouTube` : YouTube user channel, playlist or search
    15. 

  15.  * `Cryptome` : Returns the most recent documents from [Cryptome.org](http://cryptome.org/)
    16. 

  16.  * `DansTonChat`: Most recent quotes from [danstonchat.com](http://danstonchat.com/)
    17. 

  17.  * `DuckDuckGo`: Most recent results from [DuckDuckGo.com](https://duckduckgo.com/)
    18. 

  18.  * `Instagram`: Most recent photos from an Instagram user
    19. 

  19.  * `OpenClassrooms`: Lastest tutorials from [fr.openclassrooms.com](http://fr.openclassrooms.com/)
    20. 

  20.  * `Pinterest`: Most recent photos from user or search
    21. 

  21.  * `ScmbBridge`: Newest stories from [secouchermoinsbete.fr](http://secouchermoinsbete.fr/)
    22. 

  22.  * `WikipediaENLatest`: highlighted articles from Wikipedia in English
    23. 

  23.  * `WikipediaFRLatest`: highlighted articles from Wikipedia in French
    24. 

  24.  * `WikipediaEOLatest`: highlighted articles from Wikipedia in Esperanto
    25. 

  25.  * `Bandcamp` : Returns last release from [bandcamp](https://bandcamp.com/) for a tag
    26. 

  26. 

  27. Plus [many other bridges](bridges/) to enable, thanks to the community
    28. 

  28. 

  29. Output format
    30. 

  30. ===
    31. 

  31. Output format can take several forms:
    32. 

  32. 

  33.  * `Atom` : ATOM Feed, for use in RSS/Feed readers
    34. 

  34.  * `Json` : Json, for consumption by other applications.
    35. 

  35.  * `Html` : Simple html page.
    36. 

  36.  * `Plaintext` : raw text (php object, as returned by print_r)
    37. 

  37.    
    38. 

  38. Screenshot
    39. 

  39. ===
    40. 

  40. 

  41. Welcome screen:
    42. 

  42. 

  43. ![Screenshot](http://sebsauvage.net/galerie/photos/Bordel/rss-bridge-screenshot-3.png)
    44. 

  44.    
    45. 

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

  46. 

  47. ![Screenshot](http://sebsauvage.net/galerie/photos/Bordel/rss-bridge-screenshot-2-twitter-hashtag.png)
    48. 

  48.    
    49. 

  49. Requirements
    50. 

  50. ===
    51. 

  51. 

  52.  * PHP 5.3
    53. 

  53.  * `openssl` extension enabled in PHP config (`php.ini`)
    54. 

  54. 

  55. Enabling/Disabling bridges
    56. 

  56. ===
    57. 

  57. 

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

  59.  * to enable extra bridges (one bridge per line)
    60. 

  60.  * to disable main bridges (remove the line)
    61. 

  61. 

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

  63.  
    64. 

  64. Author
    65. 

  65. ===
    66. 

  66. I'm sebsauvage, webmaster of [sebsauvage.net](http://sebsauvage.net), author of [Shaarli](http://sebsauvage.net/wiki/doku.php?id=php:shaarli) and [ZeroBin](http://sebsauvage.net/wiki/doku.php?id=php:zerobin).
    67. 

    68. 

  68. Patch/contributors :
    69. 

  69. 

  70.  * Yves ASTIER ([Draeli](https://github.com/Draeli)) : PHP optimizations, fixes, dynamic brigde/format list with all stuff behind and extend cache system. Mail : contact@yves-astier.com
    71. 

  71.  * [Mitsukarenai](https://github.com/Mitsukarenai) : Initial inspiration, collaborator
    72. 

  72.  * [ArthurHoaro](https://github.com/ArthurHoaro)
    73. 

  73.  * [BoboTiG](https://github.com/BoboTiG)
    74. 

  74.  * [Astalaseven](https://github.com/Astalaseven)
    75. 

  75.  * [qwertygc](https://github.com/qwertygc)
    76. 

  76.  * [Djuuu](https://github.com/Djuuu)
    77. 

  77.  * [Anadrark](https://github.com/Anadrark])
    78. 

  78.  * [Grummfy](https://github.com/Grummfy)
    79. 

  79.  * [Polopollo](https://github.com/Polopollo)
    80. 

  80.  * [16mhz](https://github.com/16mhz)
    81. 

  81.  * [kranack](https://github.com/kranack)
    82. 

  82. 

  83. License
    84. 

  84. ===
    85. 

  85. Code is [Public Domain](UNLICENSE).
    86. 

  86. 

  87. Including `PHP Simple HTML DOM Parser` under the [MIT License](http://opensource.org/licenses/MIT)
    88. 

  88. 

  89. 

  90. Technical notes
    91. 

  91. ===
    92. 

  92.   * 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.
    93. 

  93.   * 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).
    94. 

  94. 

  95. ### Bridge guidelines
    96. 

  96. 

  97.   * metatags: `@name` {Name of service}, `@homepage` {URL to homepage}, `@description`, `@update` {YYYY-MM-DD}, `@maintainer` {Github username or nickname}
    98. 

  98.   * scripts (eg. Javascript) must be stripped out. Make good use of `strip_tags()` and `preg_replace()`
    99. 

  99.   * bridge must present data within 8 seconds (adjust iterators accordingly)
    100. 

  100.   * cache timeout must be fine-tuned so that each refresh can provide 1 or 2 new elements on busy periods
    101. 

  101.   * `<audio>` and `<video>` must not autoplay. Seriously.
    102. 

  102.   * do everything you can to extract valid timestamps. Translate formats, use API, exploit sitemap, whatever. Free the data!
    103. 

  103.   * don't create duplicates. If the website runs on WordPress, use the generic WordPress bridge if possible.
    104. 

  104.   * maintain efficient and well-commented code :wink:
    105. 

  105. 

  106. Rant
    107. 

  107. ===
    108. 

  108. 

  109. *Dear so-called "social" websites.*
    110. 

  110. 

  111. 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.**
    112. 

    113. 

  113. 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.
    114. 

    115. 

  115. 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.
    116. 

  116. 

  117. We are rebuilding bridges you have wilfully destroyed.
    118. 

  118. 

  119. Get your shit together: Put RSS back in.
    120. 

  120.