Skip to content

Commit

Permalink
Completed initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
hertsch committed May 23, 2012
0 parents commit 1fb192a
Show file tree
Hide file tree
Showing 17 changed files with 16,937 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
@@ -0,0 +1,4 @@

/.buildpath
/.project
/.settings/org.eclipse.php.core.prefs
5 changes: 5 additions & 0 deletions CHANGELOG
@@ -0,0 +1,5 @@
### libSimplePie

0.10 - 2012-05-23

* Created initial release 0.10
37 changes: 37 additions & 0 deletions Droplets/rss_feed.php
@@ -0,0 +1,37 @@
<?php

//:show the specified RSS feed
//:[[rss_feed?url=https://groups.google.com/group/phpmanufaktur-support/feed/rss_v2_0_msgs.xml]]

if (!file_exists(WB_PATH.'/modules/lib_simplepie/SimplePie/SimplePie.compiled.php')) {
return "The library SimplePie is not installed!";
}
require_once WB_PATH.'/modules/lib_simplepie/SimplePie/SimplePie.compiled.php';

if (!isset($url)) {
return "Please use the parameter 'url' to specify the RSS feed to read.";
}

$feed = new SimplePie();
$feed->set_feed_url($url);
$feed->set_cache_location(WB_PATH.'/temp');
$feed->init();
$feed->handle_content_type();

$result = '';
if ($feed->data) {
$items = $feed->get_items();
foreach ($items as $item) {
$result .= '<div class="feed_item">';
$result .= sprintf('<h4><a href="%s" target="_blank">%s</a></h4>', $item->get_permalink(), $item->get_title());
$result .= sprintf('<div class="feed_item_date">%s</div>', $item->get_date('d.m.Y - H:i'));
$result .= sprintf('<div class="feed_item_content">%s</div>', $item->get_content());
$result .= '</div>';
}
if (!empty($result)) $result = "This feed is empty!";
$result = sprintf('<div class="feed">%s</div>', $result);
}
else {
$result = 'No items in the feed!';
}
return $result;
19 changes: 19 additions & 0 deletions LICENSE
@@ -0,0 +1,19 @@
Copyright (c) 2012 Ralf Hertsch

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.
82 changes: 82 additions & 0 deletions README.md
@@ -0,0 +1,82 @@
### libSimplePie

A library for the Content Management Systems [WebsiteBaker] [1] and [LEPTON CMS] [2] for access to RSS/ATOM feeds using the library [SimplePie] [3]

#### Requirements

* minimum PHP 5.2.x
* using [WebsiteBaker] [1]
* /or/ using [LEPTON CMS] [2]

#### Installation

* download the actual [libSimplePie_x.xx.zip] [4] installation archive
* in CMS backend select the file from "Add-ons" -> "Modules" -> "Install module"

#### First Steps

You can access *libSimplePie* from your own addons:

require_once WB_PATH.'/modules/lib_simplepie/SimplePie/SimplePie.compiled.php';

$feed = new SimplePie();
$feed->set_feed_url('any_rss_or_atom_url');
$feed->set_cache_location(WB_PATH.'/temp');
$feed->init();
$feed->handle_content_type();
A very easy way to access the libSimplePie and to get the contents of a RSS or ATOM feed to your website is using a /Droplet/.

You will find some sample Droplet Code in `/modules/lib_simplepie/droplets/`.

* in the CMS backend select "Admin-Tools" -> "Droplets" -> "Add Droplet"
* name the Droplet "rss_feed"
* insert the following code:

if (!file_exists(WB_PATH.'/modules/lib_simplepie//SimplePie/SimplePie.compiled.php')) {
return "The library SimplePie is not installed!";
}
require_once WB_PATH.'/modules/rss/SimplePie.compiled.php';

if (!isset($url)) {
return "Please use the parameter 'url' to specify the RSS feed to read.";
}

$feed = new SimplePie();
$feed->set_feed_url($url);
$feed->set_cache_location(WB_PATH.'/temp');
$feed->init();
$feed->handle_content_type();

$result = '';
if ($feed->data) {
$items = $feed->get_items();
foreach ($items as $item) {
$result .= '<div class="feed_item">';
$result .= sprintf('<h4><a href="%s" target="_blank">%s</a></h4>', $item->get_permalink(), $item->get_title());
$result .= sprintf('<div class="feed_item_date">%s</div>', $item->get_date('d.m.Y - H:i'));
$result .= sprintf('<div class="feed_item_content">%s</div>', $item->get_content());
$result .= '</div>';
}
if (empty($result)) $result = "This feed is empty!";
$result = sprintf('<div class="feed">%s</div>', $result);
}
else {
$result = 'No items in the feed!';
}
return $result;

and save the Droplet.

Now you can use this Droplet in any WYSIWYG section. Place it where you want and use the parameter `url` to specify the RSS/ATOM feed you want to read from:

[[rss_feed?url=https://groups.google.com/group/phpmanufaktur-support/feed/rss_v2_0_msgs.xml]]

The Droplet will prompt the last 15 entries from the [phpManufaktur - General Addons Support] [5] Google Group.


[1]: http://websitebaker2.org "WebsiteBaker Content Management System"
[2]: http://lepton-cms.org "LEPTON CMS"
[3]: https://github.com/simplepie/simplepie "GitHub: SimplePie"
[4]: https://github.com/phpManufaktur/libSimplePie/downloads
[5]: https://groups.google.com/group/phpmanufaktur-support?hl=de
26 changes: 26 additions & 0 deletions SimplePie/LICENSE.txt
@@ -0,0 +1,26 @@
Copyright (c) 2004-2007, Ryan Parman and Geoffrey Sneddon.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list
of conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.

* Neither the name of the SimplePie Team nor the names of its contributors may be used
to endorse or promote products derived from this software without specific prior
written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS
AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
95 changes: 95 additions & 0 deletions SimplePie/README.markdown
@@ -0,0 +1,95 @@
# SimplePie

## Authors and contributors
### Current
* [Ryan McCue](http://ryanmccue.info) (Maintainer, support)

### Alumni
* [Ryan Parman](http://ryanparman.com) (Creator, developer, evangelism, support)
* [Geoffrey Sneddon](http://gsnedders.com) (Lead developer)
* [Michael Shipley](http://michaelpshipley.com) (Submitter of patches, support)
* [Steve Minutillo](http://minutillo.com/steve/) (Submitter of patches)

### Contributors
For a complete list of contributors:

1. Pull down the latest SimplePie code
2. In the `simplepie` directory, run `git shortlog -ns`


## Requirements
* PHP 5.1.4 or newer
* libxml2 (certain 2.7.x releases are too buggy for words, and will crash)
* Either the iconv or mbstring extension
* cURL or fsockopen()
* PCRE support

If you're looking for PHP 4.x support, pull the "one-dot-two" branch, as that's the last version to support PHP 4.x.


## License
[New BSD license](http://www.opensource.org/licenses/BSD-3-Clause)


## Project status
SimplePie is currently maintained by Ryan McCue.

SimplePie is currently in "low-power mode." If the community decides that SimplePie is a valuable tool, then the community will come together to maintain it into the future.

If you're interested in getting involved with SimplePie, please get in touch with Ryan McCue.


## Roadmap
SimplePie 1.3 should be a thoughtful reduction of features. Remove some bloat, slim it down, and break it into smaller, more manageable chunks.

Removing PHP 4.x support will certainly help with the slimming. It will also help avoid certain issues that frequently crop up with PHP 4.x. The PHP5-only migration is underway, but there is still quite a bit of work before it's "clean."


## What comes in the package?
1. `SimplePie.compiled.php` - The SimplePie library in one file. This is all that's required for your pages.
Either run `php build/compile.php` to generate this, or grab a copy from [dev.simplepie.org](http://dev.simplepie.org/SimplePie.compiled.php)
2. `SimplePieAutoloader.php` - The SimplePie Autoloader if you want to use the separate file version.
3. `SimplePie/` - SimplePie classes for use with the autoloader
4. `README.markdown` - This document.
5. `LICENSE.txt` - A copy of the BSD license.
6. `compatibility_test/` - The SimplePie compatibility test that checks your server for required settings.
7. `demo/` - A basic feed reader demo that shows off some of SimplePie's more noticeable features.
8. `idn/` - A third-party library that SimplePie can optionally use to understand Internationalized Domain Names (IDNs).
9. `test/` - SimplePie's unit test suite.

## To start the demo
1. Upload this package to your webserver.
2. Make sure that the cache folder inside of the demo folder is server-writable.
3. Navigate your browser to the demo folder.


## Need support?
For further setup and install documentation, function references, etc., visit:
[http://simplepie.org/wiki/](http://simplepie.org/wiki/)

For bug reports and feature requests, visit:
[http://github.com/simplepie/simplepie/issues](http://github.com/simplepie/simplepie/issues)

Support mailing list -- powered by users, for users.
[http://tech.groups.yahoo.com/group/simplepie-support/](http://tech.groups.yahoo.com/group/simplepie-support/)


## API changes since 1.2
### Recently removed
The following have recently been removed:

* Parameters for SimplePie::__construct()
* `add_to_*`
* `display_cached_file`
* `enable_xml_dump`
* `get_favicon`
* `set_favicon_handler`
* `subscribe_*` (except `subscribe_url`)
* `utf8_bad_replace`
* `set_javascript` (See `SimplePie_Misc::output_javascript()`)
* Support for Odeo

### Deprecated
The following have recently been deprecated:

* `SimplePie_Enclosure::native_embed` (use `SimplePie_Enclosure::embed(..., true)` instead)

0 comments on commit 1fb192a

Please sign in to comment.