oxrssfeed.php

Go to the documentation of this file.

<?php

class oxRssFeed extends oxSuperCfg
{
    const CACHE_TTL = 10800;

    const RSS_TOPSHOP    = 'RSS_TopShop';
    const RSS_NEWARTS    = 'RSS_NewArts';
    const RSS_CATARTS    = 'RSS_CatArts';
    const RSS_ARTRECOMMLISTS = 'RSS_ARTRECOMMLISTS';
    const RSS_RECOMMLISTARTS = 'RSS_RECOMMLISTARTS';
    const RSS_BARGAIN    = 'RSS_Bargain';

    protected $_aChannel = array();

    public function getChannel()
    {
        return $this->_aChannel;
    }

    protected function _loadBaseChannel()
    {
        $myUtils = oxUtils::getInstance();
        $oShop = $this->getConfig()->getActiveShop();
        $this->_aChannel['title'] = $oShop->oxshops__oxname->value;
        $this->_aChannel['link']  = $myUtils->prepareUrlForNoSession($this->getConfig()->getShopHomeURL());
        $this->_aChannel['description'] = '';
        $oLang = oxLang::getInstance();
        $aLangIds = $oLang->getLanguageIds();
        $this->_aChannel['language']  = $aLangIds[$oLang->getBaseLanguage()];
        $this->_aChannel['copyright'] = $oShop->oxshops__oxname->value;
        $this->_aChannel['selflink'] = '';
        if ( $myUtils->isValidEmail( $oShop->oxshops__oxinfoemail->value )) {
            $this->_aChannel['managingEditor'] = $oShop->oxshops__oxinfoemail->value;
        }
        //$this->_aChannel['webMaster']      = '';

        $this->_aChannel['generator']      = 'OXID eShop '.$oShop->oxshops__oxversion->value;
        $this->_aChannel['image']['url']   = $this->getConfig()->getImageUrl().'logo.png';


        $this->_aChannel['image']['title'] = $this->_aChannel['title'];
        $this->_aChannel['image']['link']  = $this->_aChannel['link'];
    }

    protected function _getCacheId($name)
    {
        return $name.'_'.$this->getConfig()->getShopId().'_'.oxLang::getInstance()->getBaseLanguage().'_'.(int) oxConfig::getParameter('currency');
    }

    protected function _loadFromCache($name)
    {
        if ($aRes = oxUtils::getInstance()->fromFileCache($this->_getCacheId($name))) {
            if ($aRes['timestamp'] > time() - self::CACHE_TTL) {
                return $aRes['content'];
            }
        }
        return false;
    }


    protected function _getLastBuildDate($name, $aData)
    {
        if ($aData2 = oxUtils::getInstance()->fromFileCache($this->_getCacheId($name))) {
            $sLastBuildDate = $aData2['content']['lastBuildDate'];
            $aData2['content']['lastBuildDate'] = '';
            $aData['lastBuildDate'] = '';
            if (!strcmp(serialize($aData), serialize($aData2['content']))) {
                return $sLastBuildDate;
            }
        }
        return date('D, d M Y H:i:s O');
    }

    protected function _saveToCache($name, $aContent)
    {
        $aData = array( 'timestamp' => time(), 'content'   => $aContent );
        return oxUtils::getInstance()->toFileCache($this->_getCacheId($name), $aData);
    }


    protected function _getArticleItems(oxArticleList $oList)
    {
        $myUtils = oxUtils::getInstance();
        $aItems = array();
        $oLang = oxLang::getInstance();
        $oStr  = getStr();

        foreach ($oList as $oArticle) {
            $oItem = new oxStdClass();
            $oActCur = $this->getConfig()->getActShopCurrencyObject();
            $sPrice = '';
            if ( $oPrice = $oArticle->getPrice() ) {
                $sPrice =  " " . $oArticle->getPriceFromPrefix().$oLang->formatCurrency( $oPrice->getBruttoPrice(), $oActCur ) . " ". $oActCur->sign;
            }
            $oItem->title                   = strip_tags($oArticle->oxarticles__oxtitle->value . $sPrice);
            $oItem->guid     = $oItem->link = $myUtils->prepareUrlForNoSession($oArticle->getLink());
            $oItem->isGuidPermalink         = true;
            $oItem->description             = $oArticle->getArticleLongDesc()->value; //oxarticles__oxshortdesc->value;
            if (trim(str_replace('&nbsp;', '', (strip_tags($oItem->description)))) == '') {
                $oItem->description             = $oArticle->oxarticles__oxshortdesc->value;
            }

            $oItem->description = trim($oItem->description);
            if ($sIcon = $oArticle->getIconUrl()) {
                $oItem->description = "<img src='$sIcon' border=0 align='left' hspace=5>".$oItem->description;
            }
            $oItem->description = $oStr->htmlspecialchars( $oItem->description );

            $aItems[] = $oItem;
        }
        return $aItems;
    }

    protected function _prepareUrl($sUri, $sTitle)
    {
        $iLang = oxLang::getInstance()->getBaseLanguage();
        $sUrl  = $this->_getShopUrl();
        $sUrl .= $sUri.'&amp;lang='.$iLang;

        if ( oxUtils::getInstance()->seoIsActive() ) {
            $oEncoder = oxSeoEncoder::getInstance();
            $sUrl = $oEncoder->getDynamicUrl( $sUrl, "rss/{$sTitle}/", $iLang );
        }

        return oxUtils::getInstance()->prepareUrlForNoSession( $sUrl );
    }

    protected function _prepareFeedName($sTitle)
    {
        $oShop = $this->getConfig()->getActiveShop();

        return $oShop->oxshops__oxname->value . "/" . $sTitle;
    }

    protected function _getShopUrl()
    {
        $sUrl = $this->getConfig()->getShopUrl();
        if (strpos($sUrl, '?') !== false ) {
            if (!preg_match('/[?&](amp;)?$/i', $sUrl)) {
                $sUrl .= '&amp;';
            }
        } else {
            $sUrl .= '?';
        }
        return $sUrl;
    }

    protected function _loadData($sTag, $sTitle, $sDesc, $aItems, $sRssUrl, $sTargetUrl = null)
    {
        $this->_loadBaseChannel();

        $this->_aChannel['selflink'] = $sRssUrl;

        if ($sTargetUrl) {
            $this->_aChannel['link'] = $this->_aChannel['image']['link'] = $sTargetUrl;
        }

        $this->_aChannel['image']['title']        = $this->_aChannel['title']       = $sTitle;
        $this->_aChannel['image']['description']  = $this->_aChannel['description'] = $sDesc;

        $this->_aChannel['items'] = $aItems;

        if ($sTag) {
            $this->_aChannel['lastBuildDate'] = $this->_getLastBuildDate($sTag, $this->_aChannel);
            $this->_saveToCache($sTag, $this->_aChannel);
        } else {
            $this->_aChannel['lastBuildDate'] = date( 'D, d M Y H:i:s O', oxUtilsDate::getInstance()->getTime() );
        }
    }

    public function getTopInShopTitle()
    {
        $oLang = oxLang::getInstance();
        $iLang = $oLang->getBaseLanguage();
        return $this->_prepareFeedName( $oLang->translateString( 'RSS_TOPSHOP_TITLE', $iLang ) );
    }

    public function getTopInShopUrl()
    {
        return $this->_prepareUrl("cl=rss&amp;fnc=topshop", $this->getTopInShopTitle());
    }

    public function loadTopInShop()
    {
        if ( ( $this->_aChannel = $this->_loadFromCache( self::RSS_TOPSHOP ) ) ) {
            return;
        }

        $oArtList = oxNew( 'oxarticlelist' );
        $oArtList->loadTop5Articles();

        $oLang = oxLang::getInstance();
        $this->_loadData(
            self::RSS_TOPSHOP,
            $this->getTopInShopTitle(),
            $oLang->translateString( 'RSS_TOPSHOP_DESCRIPTION', $oLang->getBaseLanguage() ),
            $this->_getArticleItems($oArtList),
            $this->getTopInShopUrl()
        );
    }



    public function getNewestArticlesTitle()
    {
        $oLang = oxLang::getInstance();
        $iLang = $oLang->getBaseLanguage();
        return $this->_prepareFeedName( $oLang->translateString( 'RSS_NEWESTARTICLES_TITLE', $iLang ) );
    }

    public function getNewestArticlesUrl()
    {
        return $this->_prepareUrl("cl=rss&amp;fnc=newarts", $this->getNewestArticlesTitle());
    }

    public function loadNewestArticles()
    {
        if ( ( $this->_aChannel = $this->_loadFromCache(self::RSS_NEWARTS ) ) ) {
            return;
        }
        $oArtList = oxNew( 'oxarticlelist' );
        $oArtList->loadNewestArticles( $this->getConfig()->getConfigParam( 'iRssItemsCount' ) );

        $oLang = oxLang::getInstance();
        $this->_loadData(
            self::RSS_NEWARTS,
            $this->getNewestArticlesTitle( ),
            $oLang->translateString( 'RSS_NEWESTARTICLES_DESCRIPTION', $oLang->getBaseLanguage() ),
            $this->_getArticleItems($oArtList),
            $this->getNewestArticlesUrl()
        );
    }


    public function getCategoryArticlesTitle(oxCategory $oCat)
    {
        $oLang  = oxLang::getInstance();
        $iLang  = $oLang->getBaseLanguage();
        $sTitle = $this->_getCatPath($oCat);
        return $this->_prepareFeedName( $sTitle . $oLang->translateString( 'RSS_CATEGORYARTICLES_TITLE', $iLang ) );
    }

    protected function _getCatPath( $oCat )
    {
        $sCatPathString = '';
        $sSep = '';
        while ( $oCat ) {
            // prepare oCat title part
            $sCatPathString = $oCat->oxcategories__oxtitle->value.$sSep.$sCatPathString ;
            $sSep = '/';
            // load parent
            $oCat = $oCat->getParentCategory();
        }
        return $sCatPathString;
    }

    public function getCategoryArticlesUrl(oxCategory $oCat)
    {
        $oLang = oxLang::getInstance();
        return $this->_prepareUrl("cl=rss&amp;fnc=catarts&amp;cat=".urlencode($oCat->getId()),
                sprintf($oLang->translateString( 'RSS_CATEGORYARTICLES_URL', $oLang->getBaseLanguage() ), $oCat->oxcategories__oxtitle->value));
    }

    public function loadCategoryArticles( oxCategory $oCat )
    {
        $sId = $oCat->getId();
        if ( ( $this->_aChannel = $this->_loadFromCache( self::RSS_CATARTS.$sId ) ) ) {
            return;
        }

        $oArtList = oxNew( 'oxarticlelist' );
        $oArtList->setCustomSorting('oc.oxtime desc');
        $oArtList->loadCategoryArticles($oCat->getId(), null, $this->getConfig()->getConfigParam( 'iRssItemsCount' ));

        $oLang = oxLang::getInstance();
        $this->_loadData(
            self::RSS_CATARTS.$sId,
            $this->getCategoryArticlesTitle($oCat),
            sprintf($oLang->translateString( 'RSS_CATEGORYARTICLES_DESCRIPTION', $oLang->getBaseLanguage() ), $oCat->oxcategories__oxtitle->value),
            $this->_getArticleItems($oArtList),
            $this->getCategoryArticlesUrl($oCat),
            $oCat->getLink()
        );
    }


    public function getSearchArticlesTitle($sSearch, $sCatId, $sVendorId, $sManufacturerId)
    {
        return $this->_prepareFeedName( getStr()->htmlspecialchars($this->_getSearchParamsTranslation('RSS_SEARCHARTICLES_TITLE', $sSearch, $sCatId, $sVendorId, $sManufacturerId)) );
    }

    protected function _getSearchParamsUrl($sSearch, $sCatId, $sVendorId, $sManufacturerId)
    {
        $sParams = "searchparam=".urlencode($sSearch);
        if ($sCatId) {
            $sParams .= "&amp;searchcnid=".urlencode($sCatId);
        }

        if ($sVendorId) {
            $sParams .= "&amp;searchvendor=".urlencode($sVendorId);
        }

        if ($sManufacturerId) {
            $sParams .= "&amp;searchmanufacturer=".urlencode($sManufacturerId);
        }

        return $sParams;
    }

    protected function _getObjectField($sId, $sObject, $sField)
    {
        if (!$sId) {
            return '';
        }
        $oObj = oxNew($sObject);
        if ($oObj->load($sId)) {
            return $oObj->$sField->value;
        }
        return '';
    }

    protected function _getSearchParamsTranslation($sId, $sSearch, $sCatId, $sVendorId, $sManufacturerId)
    {
        $oLang = oxLang::getInstance();
        $sCatTitle = '';
        if ($sTitle = $this->_getObjectField($sCatId, 'oxcategory', 'oxcategories__oxtitle')) {
            $sCatTitle = sprintf($oLang->translateString( 'RSS_SEARCHARTICLES_TAG_CATEGORY', $oLang->getBaseLanguage() ), $sTitle);
        }
        $sVendorTitle = '';
        if ($sTitle = $this->_getObjectField($sVendorId, 'oxvendor', 'oxvendor__oxtitle')) {
            $sVendorTitle = sprintf($oLang->translateString( 'RSS_SEARCHARTICLES_TAG_VENDOR', $oLang->getBaseLanguage() ), $sTitle);
        }
        $sManufacturerTitle = '';
        if ($sTitle = $this->_getObjectField($sManufacturerId, 'oxmanufacturer', 'oxmanufacturers__oxtitle')) {
            $sManufacturerTitle = sprintf($oLang->translateString( 'RSS_SEARCHARTICLES_TAG_MANUFACTURER', $oLang->getBaseLanguage() ), $sTitle);
        }

        $sRet = sprintf($oLang->translateString( $sId, $oLang->getBaseLanguage() ), $sSearch);

        $sRet = str_replace('<TAG_CATEGORY>', $sCatTitle, $sRet);
        $sRet = str_replace('<TAG_VENDOR>', $sVendorTitle, $sRet);
        $sRet = str_replace('<TAG_MANUFACTURER>', $sManufacturerTitle, $sRet);

        return $sRet;
    }

    public function getSearchArticlesUrl( $sSearch, $sCatId, $sVendorId, $sManufacturerId )
    {
        $oLang = oxLang::getInstance();
        $sUrl = $this->_prepareUrl("cl=rss&amp;fnc=searcharts", $oLang->translateString( 'RSS_SEARCHARTICLES_URL', $oLang->getBaseLanguage()));

        $sJoin = '?';
        if (strpos($sUrl, '?') !== false) {
            $sJoin = '&amp;';
        }
        return $sUrl.$sJoin.$this->_getSearchParamsUrl($sSearch, $sCatId, $sVendorId, $sManufacturerId);
    }

    public function loadSearchArticles( $sSearch, $sCatId, $sVendorId, $sManufacturerId )
    {
        // dont use cache for search
        //if ($this->_aChannel = $this->_loadFromCache(self::RSS_SEARCHARTS.md5($sSearch.$sCatId.$sVendorId))) {
        //    return;
        //}

        $oConfig = $this->getConfig();
        $oConfig->setConfigParam('iNrofCatArticles', $oConfig->getConfigParam( 'iRssItemsCount' ));

        $oArtList = oxNew( 'oxsearch' )->getSearchArticles($sSearch, $sCatId, $sVendorId, $sManufacturerId, oxNew('oxarticle')->getViewName().'.oxtimestamp desc');

        $this->_loadData(
            // dont use cache for search
            null,
            //self::RSS_SEARCHARTS.md5($sSearch.$sCatId.$sVendorId),
            $this->getSearchArticlesTitle($sSearch, $sCatId, $sVendorId, $sManufacturerId),
            $this->_getSearchParamsTranslation('RSS_SEARCHARTICLES_DESCRIPTION', getStr()->htmlspecialchars( $sSearch ), $sCatId, $sVendorId, $sManufacturerId),
            $this->_getArticleItems($oArtList),
            $this->getSearchArticlesUrl($sSearch, $sCatId, $sVendorId, $sManufacturerId),
            $this->_getShopUrl()."cl=search&amp;".$this->_getSearchParamsUrl($sSearch, $sCatId, $sVendorId, $sManufacturerId)
        );
    }

    public function getRecommListsTitle(oxArticle $oArticle)
    {
        $oLang = oxLang::getInstance();
        $iLang = $oLang->getBaseLanguage();
        return $this->_prepareFeedName( sprintf($oLang->translateString( 'RSS_ARTRECOMMLISTS_TITLE', $iLang ), $oArticle->oxarticles__oxtitle->value) );
    }

    public function getRecommListsUrl(oxArticle $oArticle)
    {
        $oLang = oxLang::getInstance();
        $iLang = $oLang->getBaseLanguage();
        return $this->_prepareUrl("cl=rss&amp;fnc=recommlists&amp;anid=".$oArticle->getId(),
                sprintf($oLang->translateString( 'RSS_ARTRECOMMLISTS_URL', $iLang ), $oArticle->oxarticles__oxtitle->value));
    }

    protected function _getRecommListItems($oList)
    {
        $myUtils = oxUtils::getInstance();
        $aItems = array();
        foreach ($oList as $oRecommList) {
            $oItem = new oxStdClass();
            $oItem->title                   = $oRecommList->oxrecommlists__oxtitle->value;
            $oItem->guid     = $oItem->link = $myUtils->prepareUrlForNoSession($oRecommList->getLink());
            $oItem->isGuidPermalink         = true;
            $oItem->description             = $oRecommList->oxrecommlists__oxdesc->value;

            $aItems[] = $oItem;
        }
        return $aItems;
    }

    public function loadRecommLists(oxArticle $oArticle)
    {
        if ( ( $this->_aChannel = $this->_loadFromCache( self::RSS_ARTRECOMMLISTS.$oArticle->getId() ) ) ) {
            return;
        }

        $oConfig = $this->getConfig();
        $oConfig->setConfigParam('iNrofCrossellArticles', $oConfig->getConfigParam( 'iRssItemsCount' ));

        $oList = oxNew( 'oxrecommlist' )->getRecommListsByIds(array($oArticle->getId()));
        if ($oList == null) {
            $oList = oxNew('oxlist');
        }

        $oLang = oxLang::getInstance();
        $this->_loadData(
            self::RSS_ARTRECOMMLISTS.$oArticle->getId(),
            $this->getRecommListsTitle($oArticle),
            sprintf($oLang->translateString( 'RSS_ARTRECOMMLISTS_DESCRIPTION', $oLang->getBaseLanguage() ), $oArticle->oxarticles__oxtitle->value),
            $this->_getRecommListItems($oList),
            $this->getRecommListsUrl($oArticle),
            $oArticle->getLink()
        );
    }

    public function getRecommListArticlesTitle(oxRecommList $oRecommList)
    {
        $oLang = oxLang::getInstance();
        $iLang = $oLang->getBaseLanguage();
        return $this->_prepareFeedName( sprintf($oLang->translateString( 'RSS_RECOMMLISTARTICLES_TITLE', $iLang ), $oRecommList->oxrecommlists__oxtitle->value) );
    }

    public function getRecommListArticlesUrl(oxRecommList $oRecommList)
    {
        $oLang = oxLang::getInstance();
        $iLang = $oLang->getBaseLanguage();
        return $this->_prepareUrl("cl=rss&amp;fnc=recommlistarts&amp;recommid=".$oRecommList->getId(),
                sprintf($oLang->translateString( 'RSS_RECOMMLISTARTICLES_URL', $iLang ), $oRecommList->oxrecommlists__oxtitle->value));
    }

    public function loadRecommListArticles(oxRecommList $oRecommList)
    {
        if ( ( $this->_aChannel = $this->_loadFromCache( self::RSS_RECOMMLISTARTS.$oRecommList->getId() ) ) ) {
            return;
        }

        $oList = oxNew( 'oxarticlelist' );
        $oList->loadRecommArticles( $oRecommList->getId(), ' order by oxobject2list.oxtimestamp desc limit '. $this->getConfig()->getConfigParam( 'iRssItemsCount' ) );

        $oLang = oxLang::getInstance();
        $this->_loadData(
            self::RSS_RECOMMLISTARTS.$oRecommList->getId(),
            $this->getRecommListArticlesTitle($oRecommList),
            sprintf($oLang->translateString( 'RSS_RECOMMLISTARTICLES_DESCRIPTION', $oLang->getBaseLanguage() ), $oRecommList->oxrecommlists__oxtitle->value),
            $this->_getArticleItems($oList),
            $this->getRecommListArticlesUrl($oRecommList),
            $oRecommList->getLink()
        );
    }

    public function getBargainTitle()
    {
        $oLang = oxLang::getInstance();
        $iLang = $oLang->getBaseLanguage();
        return $this->_prepareFeedName( $oLang->translateString( 'RSS_BARGAIN_TITLE', $iLang ) );
    }

    public function getBargainUrl()
    {
        return $this->_prepareUrl("cl=rss&amp;fnc=bargain", $this->getBargainTitle());
    }

    public function loadBargain()
    {
        if ( ( $this->_aChannel = $this->_loadFromCache( self::RSS_BARGAIN ) ) ) {
            return;
        }

        $oArtList = oxNew( 'oxarticlelist' );
        $oArtList->loadAktionArticles( 'OXBARGAIN' );

        $oLang = oxLang::getInstance();
        $this->_loadData(
            self::RSS_BARGAIN,
            $this->getBargainTitle(),
            $oLang->translateString( 'RSS_BARGAIN_DESCRIPTION', $oLang->getBaseLanguage() ),
            $this->_getArticleItems($oArtList),
            $this->getBargainUrl()
        );
    }

}