root/trunk/gregarius/util.php

<?php

###############################################################################
# Gregarius - A PHP based RSS aggregator.
# Copyright (C) 2003 - 2006 Marco Bonetti
#
###############################################################################
# This program is free software and open source software; you can redistribute
# it and/or modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of the License,
# or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA  or visit
# http://www.gnu.org/licenses/gpl.html
#
###############################################################################
# E-mail:      mbonetti at gmail dot com
# Web page:    http://gregarius.net/
#
###############################################################################



function getLastModif() {
    return getProperty('__meta__','meta.lastupdate');
}

function getETag() {
    return md5(getLastModif().$_SERVER['PHP_SELF']);
}


function rss_error($message, $severity = RSS_ERROR_ERROR, $render = false) {
    if ($render) {
        echo "<p class=\"error\">$message</p>\n";
        return;
    }

    if (!isset($GLOBALS['rss'])) {
        rss_require('cls/rss.php');
    }

    $GLOBALS['rss'] -> error($message, $severity);
}

/** this functions checks whether a URI exists */
function getHttpResponseCode($forUri) {
    return getUrl($forUri, 255);
}

function getContentType($link, & $contentType) {
    $url_parts = @ parse_url($link);
    if (empty ($url_parts["host"])) {
        return (false);
    }
    if (!empty ($url_parts["path"])) {
        $documentpath = $url_parts["path"];
    } else {
        $documentpath = "/";
    }
    if (!empty ($url_parts["query"])) {
        $documentpath .= "?".$url_parts["query"];
    }
    $host = $url_parts["host"];
    $port = (array_key_exists('port', $url_parts) ? $url_parts["port"] : "80");

    $socket = @ fsockopen($host, $port, $errno, $errstr, 30);
    if (!$socket) {
        return (false);
    }

    $ret = false;
    fwrite($socket, "GET ".$documentpath." HTTP/1.0\r\nHost: $host\r\n\r\n");
    while (!feof($socket)) {
        $line = fgets($socket, 100);
        if (preg_match("/Content-Type: (.*)/i", $line, $matches)) {
            $contentType = $matches[1];
            $ret = true;
            break;
        }
    }

    return $ret;
}

// basically strips folder resources from URIs.
// http://pear.php.net/package/HTTP_Client/ --> http://pear.php.net/
function get_host($url, & $host) {
    $ret = preg_match("/^(http:\/\/)?([^\/]+)/i", $url, $matches);
    $host = $matches[2];

    //ensure we have a slash
    if (substr($host, -1) != "/") {
        $host .= "/";
    }

    return $ret;
}

/**
 * Builds a title out of an already encoded string.
 */
function makeTitle($title) {
    // Let us find out if the user has set a title.
    $userTitle = _TITLE_;
    if (getConfig('rss.output.title')) {
        $userTitle = getConfig('rss.output.title');
    }
    $ret = "". $userTitle ."";
    if ($title) {
        if (is_array($title)) {
            foreach($title as $token) {
                $ret .= " ".TITLE_SEP." ".$token;
            }
        } else {
            $ret .= " ".TITLE_SEP." ".$title;
        }
    }
    return $ret;
}

/*** update the given feed(s) **/
function update($id) {
    $kses_allowed = getConfig('rss.input.allowed'); //getAllowedTags();
    $updatedIds = array ();


    $sql = "select id, url, title, mode from ".getTable("channels");
    if ($id != "" && is_numeric($id)) {
        $sql .= " where id=$id";
        $sql .= " and not(mode & ".RSS_MODE_DELETED_STATE.") ";
    } else {
        $sql .= " where not(mode & ".RSS_MODE_DELETED_STATE.") ";
    }

    if (getConfig('rss.config.absoluteordering')) {
        $sql .= " order by parent, position";
    } else {
        $sql .= " order by parent, title";
    }

    $res = rss_query($sql);
    while (list ($cid, $url, $title, $mode) = rss_fetch_row($res)) {

        // suppress warnings because Magpie is rather noisy
        $old_level = error_reporting(E_ERROR);
        $rss = fetch_rss($url);

        //reset
        error_reporting($old_level);

        if (!$rss && $id != "" && is_numeric($id)) {
            return array (magpie_error(), array ());
        }
        elseif (!$rss || !($rss->rss_origin & MAGPIE_FEED_ORIGIN_HTTP_200) ) {
            continue; // no need to do anything if we do not get a 200 OK from the feed
        }

        // base URL for items in this feed.
        if (array_key_exists('link', $rss->channel)) {
            $baseUrl = $rss->channel['link'];
        } else {
            $baseUrl = $url; // The feed is invalid
        }

        // Keep track of guids we've handled, because some feeds (hello,
        // Technorati!) have this insane habit of serving the same item
        // twice in the same feed.
        $guids = array();

        // Allow updates in this feed?
        $allowUpdates = getProperty($cid,'rss.input.allowupdates');
        if ($allowUpdates === null) {
            $allowUpdates = getConfig('rss.input.allowupdates');
        }

        $itemIdsInFeed = array(); // This variable will store the item id's of the elements in the feed
        foreach ($rss->items as $item) {

            $item = rss_plugin_hook('rss.plugins.rssitem', $item);
            // a plugin might delete this item
            if(!isset($item))
                continue;

            // item title: strip out html tags
            $title = array_key_exists('title', $item) ? strip_tags($item['title']) : "";
            //$title = str_replace('& ', '&amp; ', $title);


            $description = "";
            // item content, if any
            if (array_key_exists('content', $item) && is_array($item['content']) && array_key_exists('encoded', $item['content'])) {
                $description = $item['content']['encoded'];
            }
            elseif (array_key_exists('description', $item)) {
                $description = $item['description'];
            }
            elseif (array_key_exists('atom_content', $item)) {
                $description = $item['atom_content'];
            }
            elseif (array_key_exists('summary', $item)) {
                $description = $item['summary'];
            }
            else {
                $description = "";
            }

            $md5sum = "";
            $guid = "";

            if(array_key_exists('guid', $item) && $item['guid'] != "") {
                $guid = $item['guid'];
            }
            elseif(array_key_exists('id', $item) && $item['id'] != "") {
                $guid = $item['id'];
            }
            $guid = trim($guid);
            $guid = rss_real_escape_string($guid);

            // skip this one if it's an  in-feed-dupe
            if ($guid && isset($guids[$guid])) {
                continue;
            }
            elseif($guid) {
                $guids[$guid] = true;
            }

            if ($description != "") {
                $md5sum = md5($description);
                $description = kses($description, $kses_allowed); // strip out tags

                if ($baseUrl != "") {
                    $description = relative_to_absolute($description, $baseUrl);
                }
            }

            // Now let plugins modify the description
            $description = rss_plugin_hook('rss.plugins.import.description', $description);


            // link
            if (array_key_exists('link', $item) && $item['link'] != "") {
                $url = $item['link'];
            }
            elseif (array_key_exists('guid', $item) && $item['guid'] != "") {
                $url = $item['guid'];
            }
            elseif (array_key_exists('link_', $item) && $item['link_'] != "") {
                $url = $item['link_'];
            }
            else {
                // fall back to something basic
                $url = md5($title);
            }

            // make sure the url is properly escaped
            $url = htmlentities($url, ENT_QUOTES );

            $url = rss_real_escape_string($url);

            // author
            if (array_key_exists('dc', $item) && array_key_exists('creator', $item['dc'])) {
                // RSS 1.0
                $author = $item['dc']['creator'];
            } else if (array_key_exists('author_name', $item)) {
                // Atom 0.3
                $author = $item['author_name'];
            } else {
                $author = "";
            }

            $author = trim(strip_tags($author));

            // pubdate
            $cDate = -1;
            if (array_key_exists('dc', $item) && array_key_exists('date', $item['dc'])) {
                // RSS 1.0
                $cDate = parse_w3cdtf($item['dc']['date']);
            }
            elseif (array_key_exists('pubdate', $item)) {
                // RSS 2.0 (?)
                // We use the second param of strtotime here as a workaround
                // of a PHP bug with strtotime. If the pubdate field doesn't
                // contain seconds, the strtotime function will use the current
                // time to fill in seconds in PHP4. This interferes with the
                // update mechanism of gregarius. See ticket #328 for the full
                // gory details. Giving a known date as a second param to
                // strtotime fixes this problem, hence the 0 here.
                $cDate = strtotime($item['pubdate'], 0);
            }
            elseif (array_key_exists('published',$item)) {
                // atom 1.0
                $cDate = parse_iso8601($item['published']);
            }
            elseif (array_key_exists('issued', $item)) {
                //Atom, alternative
                $cDate = parse_iso8601($item['issued']);
            }
            elseif (array_key_exists('updated', $item)) {
                //Atom, alternative
                $cDate = parse_iso8601($item['updated']);
            }
            elseif (array_key_exists('created', $item)) {
                // atom 0.3
                $cDate = parse_iso8601($item['created']);
            }

            // enclosure
            if (array_key_exists('enclosure@url', $item) ) {
                $enclosure = $item['enclosure@url'];
                // If the enclosure is an image, append it to the content
                // but only if it isn't there yet
                if ($enclosure && 
                    array_key_exists('enclosure@type', $item) && 
                    preg_match('#image/(png|gif|jpe?g)#', $item['enclosure@type']) &&
                    (FALSE == strpos($description,$enclosure))) {
                        $description = '<img src="'.$enclosure.'" alt="" />' . $description;
                        $enclosure = '';
                }
            } else {
                $enclosure = "";
            }

            // drop items with an url exceeding our column length: we couldn't provide a
            // valid link back anyway.
            if (strlen($url) >= 255) {
                continue;
            }

            $dbtitle = rss_real_escape_string($title);
            if (strlen($dbtitle) >= 255) {
                $dbtitle=substr($dbtitle,0,254);
            }

            if ($cDate > 0) {
                $sec = "FROM_UNIXTIME($cDate)";
            } else {
                $sec = "null";
            }

            // check whether we already have this item
            if ($guid) {
                $sql = "select id,unread, md5sum, guid, pubdate from ".getTable("item")
                       ." where cid=$cid and guid='$guid'";
            } else {
                $sql = "select id,unread, md5sum, guid, pubdate from ".getTable("item")
                       ." where cid=$cid and url='$url' and title='$dbtitle'"
                       ." and (pubdate is NULL OR pubdate=$sec)";
            }

            $subres = rss_query($sql);
            list ($indb, $state, $dbmd5sum, $dbGuid, $dbPubDate) = rss_fetch_row($subres);

            if ($indb) {
                $itemIdsInFeed[] = $indb;
                if (!($state & RSS_MODE_DELETED_STATE) && $md5sum != $dbmd5sum) {
                    // the md5sums do not match.
                    if($allowUpdates) { // Are we allowed update items in the db?
                        list ($cid, $indb, $description) =
                            rss_plugin_hook('rss.plugins.items.updated', array ($cid, $indb, $description));

                        $sql = "update ".getTable("item")
                               ." set "." description='".rss_real_escape_string($description)."', "
                               ." unread = unread | ".RSS_MODE_UNREAD_STATE
                               .", md5sum='$md5sum'" . " where cid=$cid and id=$indb";

                        rss_query($sql);
                        $updatedIds[] = $indb;
                        continue;
                    }
                }
            } else { // $indb = "" . This must be new item then. In you go.

                list ($cid, $dbtitle, $url, $description) =
                    rss_plugin_hook('rss.plugins.items.new', array ($cid, $dbtitle, $url, $description));

                $sql = "insert into ".getTable("item")
                       ." (cid, added, title, url, enclosure,"
                       ." description, author, unread, pubdate, md5sum, guid) "
                       ." values ("."$cid, now(), '$dbtitle', "
                       ." '$url', '".rss_real_escape_string($enclosure)."', '"
                       .rss_real_escape_string($description)."', '"
                       .rss_real_escape_string($author)."', "
                       ."$mode, $sec, '$md5sum', '$guid')";

                rss_query($sql);

                $newIid = rss_insert_id();
                $itemIdsInFeed[] = $newIid;
                $updatedIds[] = $newIid;
                rss_plugin_hook('rss.plugins.items.newiid',array($newIid,$item,$cid));
            } // end handling of this item

        } // end handling of all the items in this feed
        $sql = "update " .getTable("channels") . " set "." itemsincache = '"
               . serialize($itemIdsInFeed) . "' where id=$cid";
        rss_query($sql);


    } // end handling all the feeds we were asked to handle

    if ($id != "" && is_numeric($id)) {
        if ($rss) {
            // when everything went well, return the error code
            // and numer of new items
            return array ($rss->rss_origin, $updatedIds);
        } else {
            return array (-1, array ());
        }
    } else {
        return array (-1, $updatedIds);
    }
}

function getRootFolder() {
    $sql = "select id from ".getTable("folders")."where name = '' order by position asc limit 1";
    list($root) = rss_fetch_row(rss_query($sql));

    if (!$root) {
        $root = 0;
    }

    return $root;
}

function add_channel($url, $folderid = 0, $title_=null,$descr_=null,$tags = null) {
    if (!$url || strlen($url) <= 7) {
        return array (-2, "Invalid URL $url");
    }
    if (!is_numeric($folderid)) {
        return array (-2, "Invalid folderid $folderid");
    }

    $url = sanitize(str_replace('&amp;','&',$url), RSS_SANITIZER_URL);

    $urlDB = rss_real_escape_string($url); //htmlentities($url);

    $res = rss_query("select count(*) as channel_exists from ".getTable("channels")." where url='$urlDB'");
    list ($channel_exists) = rss_fetch_row($res);
    if ($channel_exists > 0) {
        // fatal
        return array (-2, "Looks like you are already subscribed to this channel");
    }

    $res = rss_query("select 1+max(position) as np from ".getTable("channels"));
    list ($np) = rss_fetch_row($res);

    if (!$np) {
        $np = "0";
    }
            
    // Here we go!
    //error_reporting(E_ALL);
    $old_level = error_reporting(E_ERROR);
    $rss = fetch_rss($url);
    error_reporting($old_level);

    if ($rss) {
        if ($title_) {
            $title = rss_real_escape_string($title_);
        }
        elseif (is_object($rss) && array_key_exists('title#', $rss->channel)) {
            if (array_key_exists('title', $rss->channel)) {
                $title = rss_real_escape_string($rss->channel['title']);
            } else {
                $title = " ";
            }
        }
        else {
            $title = "";
        }

        if (is_object($rss) && array_key_exists('link', $rss->channel)) {
            $siteurl = rss_real_escape_string(htmlentities($rss->channel['link']));
        } else {
            $siteurl = "";
        }

                $refreshinterval = 0;
                if(is_object($rss) && array_key_exists('syn', $rss->channel)) {
                        $syn = $rss->channel['syn'];

                        if(array_key_exists('updateperiod', $syn)) {
                     &