ilExternalFeed Class Reference

Handles external Feeds via Magpie library. More...

Collaboration diagram for ilExternalFeed:

Public Member Functions
	__construct ()
	Constructor. More...
	setUrl ($a_url)
	Set Url. More...
	getUrl ()
	Get Url. More...
	setError ($a_error)
	Set Error. More...
	getError ()
	Get Error. More...
	fetch ()
	Fetch the feed. More...
	checkCacheHit ()
	Check cache hit. More...
	getChannelTitle ()
	Get Channel. More...
	getChannelDescription ()
	Get Description. More...
	getItems ()
	Get Items. More...

Static Public Member Functions
static	_createCacheDirectory ()
	Create magpie cache directorry (if not existing) More...
static	_checkUrl ($a_url)
	Check Url. More...
static	_determineFeedUrl ($a_url)
	Determine Feed Url. More...
static	_getRSSLocation ($html, $location)
	This one is by Keith Devens , see http://keithdevens.com/weblog/archive/2002/Jun/03/RSSAuto-DiscoveryPHP. More...

Protected Attributes
	$items = array()

Detailed Description

Handles external Feeds via Magpie library.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 27 of file class.ilExternalFeed.php.

Constructor & Destructor Documentation

__construct()

ilExternalFeed::__construct

(

)

Constructor.

Definition at line 34 of file class.ilExternalFeed.php.

References _createCacheDirectory(), and ilProxySettings\_getInstance().

    {
        // IF YOU ADD THINGS HERE, THEY MAY ALSO BE ADDED TO
        // SOME OF THE STATIC METHODS
        $this->_createCacheDirectory();

        if (ilProxySettings::_getInstance()->isActive()) {
            define('IL_FEED_PROXY_HOST', ilProxySettings::_getInstance()->getHost());
            define('IL_FEED_PROXY_PORT', ilProxySettings::_getInstance()->getPort());
        } else {
            define('IL_FEED_PROXY_HOST', "");
            define('IL_FEED_PROXY_PORT', "");
        }
    }

Here is the call graph for this function:

Member Function Documentation

_checkUrl()

static ilExternalFeed::_checkUrl (   $a_url )

static

Check Url.

Parameters

string

URL

Returns

mixed true, if everything is fine, error string otherwise

Definition at line 105 of file class.ilExternalFeed.php.

References _createCacheDirectory(), and ilProxySettings\_getInstance().

Referenced by ilFeedUrlInputGUI\checkInput().

    {
        if (!defined('IL_FEED_PROXY_HOST')) {
            ilExternalFeed::_createCacheDirectory();

            if (ilProxySettings::_getInstance()->isActive()) {
                define('IL_FEED_PROXY_HOST', ilProxySettings::_getInstance()->getHost());
                define('IL_FEED_PROXY_PORT', ilProxySettings::_getInstance()->getPort());
            } else {
                define('IL_FEED_PROXY_HOST', "");
                define('IL_FEED_PROXY_PORT', "");
            }
        }
        
        $feed = @fetch_rss($a_url);
        if (!$feed) {
            $error = magpie_error();
            
            if ($error != "") {
                return $error;
            } else {
                return "Unknown Error.";
            }
        }
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_createCacheDirectory()

static ilExternalFeed::_createCacheDirectory ( )

static

Create magpie cache directorry (if not existing)

Definition at line 92 of file class.ilExternalFeed.php.

References ilUtil\getDataDir(), and ilUtil\makeDir().

Referenced by __construct(), _checkUrl(), and checkCacheHit().

    {
        if (!is_dir(ilUtil::getDataDir() . "/magpie_cache")) {
            ilUtil::makeDir(ilUtil::getDataDir() . "/magpie_cache");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_determineFeedUrl()

static ilExternalFeed::_determineFeedUrl (   $a_url )

static

Determine Feed Url.

Parameters

$a_url

URL that

Definition at line 219 of file class.ilExternalFeed.php.

References $res, ilProxySettings\_getInstance(), and _getRSSLocation().

Referenced by ilFeedUrlInputGUI\checkInput().

    {
        if (!defined('IL_FEED_PROXY_HOST')) {
            if (ilProxySettings::_getInstance()->isActive()) {
                define('IL_FEED_PROXY_HOST', ilProxySettings::_getInstance()->getHost());
                define('IL_FEED_PROXY_PORT', ilProxySettings::_getInstance()->getPort());
            } else {
                define('IL_FEED_PROXY_HOST', "");
                define('IL_FEED_PROXY_PORT', "");
            }
        }

        $res = @fopen($a_url, "r");
        
        if (!$res) {
            return "";
        }
        
        $contents = '';
        while (!feof($res)) {
            $contents .= fread($res, 8192);
        }
        fclose($res);
        
        return ilExternalFeed::_getRSSLocation($contents, $a_url);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getRSSLocation()

static ilExternalFeed::_getRSSLocation (   $html,   $location  )

static

This one is by Keith Devens , see http://keithdevens.com/weblog/archive/2002/Jun/03/RSSAuto-DiscoveryPHP.

Definition at line 250 of file class.ilExternalFeed.php.

References $attributes, $location, and $n.

Referenced by _determineFeedUrl().

    {
        if (!$html or !$location) {
            return false;
        } else {
            #search through the HTML, save all <link> tags
            # and store each link's attributes in an associative array
            preg_match_all('/<link\s+(.*?)\s*\/?>/si', $html, $matches);
            $links = $matches[1];
            $final_links = array();
            $link_count = count($links);
            for ($n = 0; $n < $link_count; $n++) {
                $attributes = preg_split('/\s+/s', $links[$n]);
                foreach ($attributes as $attribute) {
                    $att = preg_split('/\s*=\s*/s', $attribute, 2);
                    if (isset($att[1])) {
                        $att[1] = preg_replace('/([\'"]?)(.*)\1/', '$2', $att[1]);
                        $final_link[strtolower($att[0])] = $att[1];
                    }
                }
                $final_links[$n] = $final_link;
            }
            #now figure out which one points to the RSS file
            for ($n = 0; $n < $link_count; $n++) {
                if (strtolower($final_links[$n]['rel']) == 'alternate') {
                    if (strtolower($final_links[$n]['type']) == 'application/rss+xml') {
                        $href = $final_links[$n]['href'];
                    }
                    if (!$href and strtolower($final_links[$n]['type']) == 'text/xml') {
                        #kludge to make the first version of this still work
                        $href = $final_links[$n]['href'];
                    }
                    if ($href) {
                        if (strstr($href, "http://") !== false) { #if it's absolute
                            $full_url = $href;
                        } else { #otherwise, 'absolutize' it
                            $url_parts = parse_url($location);
                            #only made it work for http:// links. Any problem with this?
                            $full_url = "http://$url_parts[host]";
                            if (isset($url_parts['port'])) {
                                $full_url .= ":$url_parts[port]";
                            }
                            if ($href[0] != '/') { #it's a relative link on the domain
                                $full_url .= dirname($url_parts['path']);
                                if (substr($full_url, -1) != '/') {
                                    #if the last character isn't a '/', add it
                                    $full_url .= '/';
                                }
                            }
                            $full_url .= $href;
                        }
                        return $full_url;
                    }
                }
            }
            return false;
        }
    }

Here is the caller graph for this function:

checkCacheHit()

ilExternalFeed::checkCacheHit

(

)

Check cache hit.

Definition at line 164 of file class.ilExternalFeed.php.

References _createCacheDirectory(), getUrl(), MAGPIE_CACHE_AGE, and MAGPIE_OUTPUT_ENCODING.

    {
        ilExternalFeed::_createCacheDirectory();
        
        $cache = new RSSCache(MAGPIE_CACHE_DIR, MAGPIE_CACHE_AGE);
        
        $cache_status = 0;       // response of check_cache
        $request_headers = array(); // HTTP headers to send with fetch
        $rss = 0;       // parsed RSS object
        $errormsg = 0;       // errors, if any
        
        $cache_key = $this->getUrl() . MAGPIE_OUTPUT_ENCODING;
        
        if (!$cache->ERROR) {
            // return cache HIT, MISS, or STALE
            $cache_status = $cache->check_cache($cache_key);
        }
                
        // if object cached, and cache is fresh, return cached obj
        if ($cache_status == 'HIT') {
            return true;
        }
        
        return false;
    }

Here is the call graph for this function:

fetch()

ilExternalFeed::fetch

(

)

Fetch the feed.

Definition at line 136 of file class.ilExternalFeed.php.

References getUrl(), and setError().

    {
        if ($this->getUrl() != "") {
            $this->feed = @fetch_rss($this->getUrl());
        }
        
        if (!$this->feed) {
            $error = magpie_error();
            if ($error == "") {
                $this->setError("Unknown Error.");
            } else {
                $this->setError(magpie_error());
            }
            return false;
        }
        
        if (is_array($this->feed->items)) {
            foreach ($this->feed->items as $item) {
                $item_obj = new ilExternalFeedItem();
                $item_obj->setMagpieItem($item);
                $this->items[] = $item_obj;
            }
        }
    }

Here is the call graph for this function:

getChannelDescription()

ilExternalFeed::getChannelDescription

(

)

Get Description.

Definition at line 201 of file class.ilExternalFeed.php.

    {
        return $this->feed->channel["description"];
    }

getChannelTitle()

ilExternalFeed::getChannelTitle

(

)

Get Channel.

Definition at line 193 of file class.ilExternalFeed.php.

    {
        return $this->feed->channel["title"];
    }

getError()

ilExternalFeed::getError

(

)

Get Error.

Returns

string Error

Definition at line 84 of file class.ilExternalFeed.php.

    {
        return $this->error;
    }

getItems()

ilExternalFeed::getItems

(

)

Get Items.

Definition at line 209 of file class.ilExternalFeed.php.

References $items.

    {
        return $this->items;
    }

getUrl()

ilExternalFeed::getUrl

(

)

Get Url.

Returns

string Url

Definition at line 64 of file class.ilExternalFeed.php.

References $url.

Referenced by checkCacheHit(), and fetch().

    {
        return $this->url;
    }

Here is the caller graph for this function:

setError()

ilExternalFeed::setError

(

$a_error

)

Set Error.

Parameters

string

$a_error

Error

Definition at line 74 of file class.ilExternalFeed.php.

Referenced by fetch().

    {
        $this->error = $a_error;
    }

Here is the caller graph for this function:

setUrl()

ilExternalFeed::setUrl

(

$a_url

)

Set Url.

Parameters

string

$a_url

Url

Definition at line 54 of file class.ilExternalFeed.php.

    {
        $this->url = $a_url;
    }

Field Documentation

$items

ilExternalFeed::$items = array()

protected

Definition at line 29 of file class.ilExternalFeed.php.

Referenced by getItems().

---

The documentation for this class was generated from the following file:

• Services/Feeds/classes/class.ilExternalFeed.php