oxseoencoderarticle.php

Go to the documentation of this file.

<?php

class oxSeoEncoderArticle extends oxSeoEncoder
{
    protected static $_instance = null;

    protected static $_aTitleCache = array();

    public static function getInstance()
    {
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            self::$_instance = modInstances::getMod( __CLASS__ );
        }

        if (!self::$_instance) {
            self::$_instance = oxNew("oxSeoEncoderArticle");
            if ( defined( 'OXID_PHP_UNIT' ) ) {
                modInstances::addMod( __CLASS__, self::$_instance);
            }
        }

        if ( defined( 'OXID_PHP_UNIT' ) ) {
            // resetting cache
            self::$_instance->_aSeoCache = array();
        }

        return self::$_instance;
    }

    protected function _getUrlExtension()
    {
        return '.html';
    }

    protected function _getProductForLang( $oArticle, $iLang )
    {
        if ( isset( $iLang ) && $iLang != $oArticle->getLanguage() ) {
            $sId = $oArticle->getId();
            $oArticle = oxNew( 'oxarticle' );
            $oArticle->setSkipAssign( true );
            $oArticle->loadInLang( $iLang, $sId );
        }

        return $oArticle;
    }

    protected function _getArticleRecommUri( $oArticle, $iLang )
    {
        return $this->getArticleRecommUri( $oArticle, $iLang );
    }

    public function getArticleRecommUri( $oArticle, $iLang )
    {
        $sSeoUri = null;
        if ( $oRecomm = $this->_getRecomm( $oArticle, $iLang ) ) {
            //load details link from DB
            if ( !( $sSeoUri = $this->_loadFromDb( 'oxarticle', $oArticle->getId(), $iLang, null, $oRecomm->getId(), true ) ) ) {

                $oArticle = $this->_getProductForLang( $oArticle, $iLang );

                // create title part for uri
                $sTitle = $this->_prepareArticleTitle( $oArticle );

                // create uri for all categories
                $sSeoUri = oxSeoEncoderRecomm::getInstance()->getRecommUri( $oRecomm, $iLang );
                $sSeoUri = $this->_processSeoUrl( $sSeoUri . $sTitle, $oArticle->getId(), $iLang );

                $aStdParams = array( 'recommid' => $oRecomm->getId(), 'listtype' => $this->_getListType() );
                $this->_saveToDb(
                            'oxarticle',
                            $oArticle->getId(),
                            oxUtilsUrl::getInstance()->appendUrl(
                                    $oArticle->getBaseStdLink( $iLang ),
                                    $aStdParams
                            ),
                            $sSeoUri,
                            $iLang,
                            null,
                            0,
                            $oRecomm->getId()
                        );
            }
        }
        return $sSeoUri;
    }

    protected function _getRecomm( $oArticle, $iLang )
    {
        $oList = null;
        $oView = $this->getConfig()->getActiveView();
        if ( $oView instanceof oxView ) {
            $oList = $oView->getActiveRecommList();
        }
        return $oList;
    }

    protected function _getListType()
    {
        return $this->getConfig()->getActiveView()->getListType();
    }

    protected function _getArticleTagUri( $oArticle, $iLang, $blRegenerate = false )
    {
        return $this->getArticleTagUri( $oArticle, $iLang, $blRegenerate );
    }
    public function getArticleTagUri( $oArticle, $iLang, $blRegenerate = false )
    {
        $sSeoUri = null;
        if ( $sTag = $this->_getTag( $oArticle, $iLang ) ) {
            $iShopId = $this->getConfig()->getShopId();
            $sStdUrl = $oArticle->getStdTagLink( $sTag );
            if ( $blRegenerate || !( $sSeoUri = $this->_loadFromDb( 'dynamic', $this->getDynamicObjectId( $iShopId, $sStdUrl ), $iLang ) ) ) {
                // generating new if not found
                if ( $sSeoUri = oxSeoEncoderTag::getInstance()->getTagUri( $sTag, $iLang, $oArticle->getId() ) ) {
                    $sSeoUri .= $this->_prepareArticleTitle( $oArticle );
                    $sSeoUri  = $this->_processSeoUrl( $sSeoUri, $this->_getStaticObjectId( $iShopId, $sStdUrl ), $iLang );
                    $sSeoUri  = $this->_getDynamicUri( $sStdUrl, $sSeoUri, $iLang );
                }
            }
        }
        return $sSeoUri;
    }

    protected function _getTag( $oArticle, $iLang )
    {
        $sTag = null;
        $oView = $this->getConfig()->getActiveView();
        if ( $oView instanceof oxView ) {
            $sTag = $oView->getTag();
        }
        return $sTag;
    }

    protected function _createArticleCategoryUri( $oArticle, $oCategory, $iLang )
    {
        startProfile(__FUNCTION__);
        $oArticle = $this->_getProductForLang( $oArticle, $iLang );

        // create title part for uri
        $sTitle = $this->_prepareArticleTitle( $oArticle );

        // writing category path
        $sSeoUri = $this->_processSeoUrl(
                            oxSeoEncoderCategory::getInstance()->getCategoryUri( $oCategory, $iLang ).$sTitle,
                            $oArticle->getId(), $iLang
                        );
        $sCatId = $oCategory->getId();
        $this->_saveToDb(
                    'oxarticle',
                    $oArticle->getId(),
                    oxUtilsUrl::getInstance()->appendUrl(
                            $oArticle->getBaseStdLink( $iLang ),
                            array( 'cnid' => $sCatId )
                    ),
                    $sSeoUri,
                    $iLang,
                    null,
                    0,
                    $sCatId
                );

        stopProfile(__FUNCTION__);

        return $sSeoUri;
    }

    protected function _getArticleUri( $oArticle, $iLang, $blRegenerate = false )
    {
        return $this->getArticleUri( $oArticle, $iLang, $blRegenerate );
    }

    public function getArticleUri( $oArticle, $iLang, $blRegenerate = false )
    {
        startProfile(__FUNCTION__);

        $sActCatId = '';
        if ( $oActCat = $this->_getCategory( $oArticle, $iLang ) ) {
            $sActCatId = $oActCat->getId();
        } elseif ( $oActCat = $this->_getMainCategory( $oArticle ) ) {
            $sActCatId = $oActCat->getId();
        }

        //load details link from DB
        if ( $blRegenerate || !( $sSeoUri = $this->_loadFromDb( 'oxarticle', $oArticle->getId(), $iLang, null, $sActCatId, true ) ) ) {
            if ( $oActCat ) {
                $blInCat = false;
                if ( $oActCat->isPriceCategory() ) {
                    $blInCat = $oArticle->inPriceCategory( $sActCatId );
                } else {
                    $blInCat = $oArticle->inCategory( $sActCatId );
                }
                if ( $blInCat ) {
                    $sSeoUri = $this->_createArticleCategoryUri( $oArticle, $oActCat, $iLang );
                }
            }
        }

        stopProfile(__FUNCTION__);

        return $sSeoUri;
    }

    protected function _getCategory( $oArticle, $iLang )
    {
        $oCat = null;
        $oView = $this->getConfig()->getActiveView();
        if ( $oView instanceof oxview ) {
            $oCat = $oView->getActCategory();
        }
        return $oCat;
    }

    protected function _getMainCategory( $oArticle )
    {
        $oMainCat = null;

        // if variant parent id must be used
        $sArtId = $oArticle->getId();
        if ( isset( $oArticle->oxarticles__oxparentid->value ) && $oArticle->oxarticles__oxparentid->value ) {
            $sArtId = $oArticle->oxarticles__oxparentid->value;
        }

        $oDb = oxDb::getDb();
        // add manin category chaching;
        $sQ = "select oxcatnid from ".getViewName( "oxobject2category" )." where oxobjectid = ".$oDb->quote( $sArtId )." order by oxtime";
        $sIdent = md5( $sQ );

        if ( ( $sMainCatId = $this->_loadFromCache( $sIdent, "oxarticle" ) ) === false ) {
            $sMainCatId = $oDb->getOne( $sQ );
            // storing in cache
            $this->_saveInCache( $sIdent, $sMainCatId, "oxarticle" );
        }

        if ( $sMainCatId ) {
            $oMainCat = oxNew( "oxcategory" );
            if ( ! $oMainCat->load( $sMainCatId )) {
                $oMainCat = null;
            }
        }

        return $oMainCat;
    }

    protected function _getArticleMainUri( $oArticle, $iLang )
    {
        return $this->getArticleMainUri( $oArticle, $iLang );
    }

    public function getArticleMainUri( $oArticle, $iLang )
    {
        startProfile(__FUNCTION__);

        $oMainCat   = $this->_getMainCategory( $oArticle );
        $sMainCatId = $oMainCat ? $oMainCat->getId() : '';

        //load default article url from DB
        if ( !( $sSeoUri = $this->_loadFromDb( 'oxarticle', $oArticle->getId(), $iLang, null, $sMainCatId, true ) ) ) {
            // save for main category
            if ( $oMainCat ) {
                $sSeoUri = $this->_createArticleCategoryUri( $oArticle, $oMainCat, $iLang );
            } else {
                // get default article url
                $oArticle = $this->_getProductForLang( $oArticle, $iLang );
                $sSeoUri = $this->_processSeoUrl( $this->_prepareArticleTitle( $oArticle ), $oArticle->getId(), $iLang );

                // save default article url
                $this->_saveToDb(
                        'oxarticle',
                        $oArticle->getId(),
                        $oArticle->getBaseStdLink( $iLang ),
                        $sSeoUri,
                        $iLang,
                        null,
                        0,
                        ''
                    );
            }
        }

        stopProfile(__FUNCTION__);
        return $sSeoUri;
    }

    protected function _prepareArticleTitle( $oArticle )
    {
        $sTitle = '';

        // create title part for uri
        if ( !( $sTitle = $oArticle->oxarticles__oxtitle->value ) ) {
            // taking parent article title
            if ( ( $sParentId = $oArticle->oxarticles__oxparentid->value ) ) {

                // looking in cache ..
                if ( !isset( self::$_aTitleCache[$sParentId] ) ) {
                    $oDb = oxDb::getDb();
                    $sQ = "select oxtitle from ".$oArticle->getViewName()." where oxid = ".$oDb->quote( $sParentId );
                    self::$_aTitleCache[$sParentId] = $oDb->getOne( $sQ );
                }
                $sTitle = self::$_aTitleCache[$sParentId];
            }
        }

        // variant has varselect value
        if ( $oArticle->oxarticles__oxvarselect->value ) {
            $sTitle .= ( $sTitle ? ' ' : '' ) . $oArticle->oxarticles__oxvarselect->value . ' ';
        } elseif ( !$sTitle || ( $oArticle->oxarticles__oxparentid->value ) ) {
            // in case nothing was found - looking for number
            $sTitle .= ( $sTitle ? ' ' : '' ) . $oArticle->oxarticles__oxartnum->value;
        }

        return $this->_prepareTitle( $sTitle ) . '.html';
    }

    protected function _getArticleVendorUri( $oArticle, $iLang, $blRegenerate = false )
    {
        return $this->getArticleVendorUri( $oArticle, $iLang, $blRegenerate );
    }

    public function getArticleVendorUri( $oArticle, $iLang, $blRegenerate = false )
    {
        startProfile(__FUNCTION__);

        $sSeoUri = null;
        if ( $oVendor = $this->_getVendor( $oArticle, $iLang ) ) {
            //load details link from DB
            if ( $blRegenerate || !( $sSeoUri = $this->_loadFromDb( 'oxarticle', $oArticle->getId(), $iLang, null, $oVendor->getId(), true ) ) ) {

                $oArticle = $this->_getProductForLang( $oArticle, $iLang );

                // create title part for uri
                $sTitle = $this->_prepareArticleTitle( $oArticle );

                // create uri for all categories
                $sSeoUri = oxSeoEncoderVendor::getInstance()->getVendorUri( $oVendor, $iLang );
                $sSeoUri = $this->_processSeoUrl( $sSeoUri . $sTitle, $oArticle->getId(), $iLang );

                $aStdParams = array( 'cnid' => "v_".$oVendor->getId(), 'listtype' => $this->_getListType() );
                $this->_saveToDb(
                        'oxarticle',
                        $oArticle->getId(),
                        oxUtilsUrl::getInstance()->appendUrl(
                                $oArticle->getBaseStdLink( $iLang ),
                                $aStdParams
                        ),
                        $sSeoUri,
                        $iLang,
                        null,
                        0,
                        $oVendor->getId()
                    );
            }

            stopProfile(__FUNCTION__);
        }
        return $sSeoUri;
    }

    protected function _getVendor( $oArticle, $iLang )
    {
        $oView = $this->getConfig()->getActiveView();

        $oVendor = null;
        if ( $sActVendorId = $oArticle->oxarticles__oxvendorid->value ) {
            if ( $oView instanceof oxView && ( $oActVendor = $oView->getActVendor() ) ) {
                $oVendor = $oActVendor;
            } else {
                $oVendor = oxNew( "oxVendor" );
            }
            if ( $oVendor->getId() !== $sActVendorId ) {
                $oVendor = oxNew( "oxVendor" );
                if ( !$oVendor->loadInLang( $iLang, $sActVendorId ) ) {
                    $oVendor = null;
                }
            }
        }

        return $oVendor;
    }

    protected function _getArticleManufacturerUri( $oArticle, $iLang, $blRegenerate = false )
    {
        return $this->getArticleManufacturerUri( $oArticle, $iLang, $blRegenerate );
    }

    public function getArticleManufacturerUri( $oArticle, $iLang, $blRegenerate = false )
    {
        $sSeoUri = null;
        startProfile(__FUNCTION__);
        if ( $oManufacturer = $this->_getManufacturer( $oArticle, $iLang ) ) {
            //load details link from DB
            if ( $blRegenerate || !( $sSeoUri = $this->_loadFromDb( 'oxarticle', $oArticle->getId(), $iLang, null, $oManufacturer->getId(), true ) ) ) {

                $oArticle = $this->_getProductForLang( $oArticle, $iLang );

                // create title part for uri
                $sTitle = $this->_prepareArticleTitle( $oArticle );

                // create uri for all categories
                $sSeoUri = oxSeoEncoderManufacturer::getInstance()->getManufacturerUri( $oManufacturer, $iLang );
                $sSeoUri = $this->_processSeoUrl( $sSeoUri . $sTitle, $oArticle->getId(), $iLang );

                $aStdParams = array( 'mnid' => $oManufacturer->getId(), 'listtype' => $this->_getListType() );
                $this->_saveToDb(
                        'oxarticle',
                        $oArticle->getId(),
                        oxUtilsUrl::getInstance()->appendUrl(
                                $oArticle->getBaseStdLink( $iLang ),
                                $aStdParams
                        ),
                        $sSeoUri,
                        $iLang,
                        null,
                        0,
                        $oManufacturer->getId()
                    );
            }

            stopProfile(__FUNCTION__);
        }
        return $sSeoUri;
    }

    protected function _getManufacturer( $oArticle, $iLang )
    {
        $oManufacturer = null;
        if ( $sActManufacturerId = $oArticle->oxarticles__oxmanufacturerid->value ) {
            $oView = $this->getConfig()->getActiveView();

            if ( $oView instanceof oxView && ( $oActManufacturer = $oView->getActManufacturer() ) ) {
                $oManufacturer = $oActManufacturer;
            } else {
                $oManufacturer = oxNew( "oxManufacturer" );
            }

            if ( $oManufacturer->getId() !== $sActManufacturerId || $oManufacturer->getLanguage() != $iLang ) {
                $oManufacturer = oxNew( "oxManufacturer" );
                if ( !$oManufacturer->loadInLang( $iLang, $sActManufacturerId ) ) {
                    $oManufacturer = null;
                }
            }
        }

        return $oManufacturer;
    }

    public function getArticleMainUrl( $oArticle, $iLang = null )
    {
        if ( !isset( $iLang ) ) {
            $iLang = $oArticle->getLanguage();
        }

        return $this->_getFullUrl( $this->_getArticleMainUri( $oArticle, $iLang ), $iLang );
    }

    public function getArticleUrl( $oArticle, $iLang = null, $iType = 0 )
    {
        if ( !isset( $iLang ) ) {
            $iLang = $oArticle->getLanguage();
        }

        $sUri = null;
        switch ( $iType ) {
            case OXARTICLE_LINKTYPE_VENDOR :
                $sUri = $this->_getArticleVendorUri( $oArticle, $iLang );
                break;
            case OXARTICLE_LINKTYPE_MANUFACTURER :
                $sUri = $this->_getArticleManufacturerUri( $oArticle, $iLang );
                break;
            case OXARTICLE_LINKTYPE_TAG :
                $sUri = $this->_getArticleTagUri( $oArticle, $iLang );
                break;
            case OXARTICLE_LINKTYPE_RECOMM :
                $sUri = $this->_getArticleRecommUri( $oArticle, $iLang );
                break;
            case OXARTICLE_LINKTYPE_PRICECATEGORY : // goes price category urls to default (category urls)
            default:
                $sUri = $this->_getArticleUri( $oArticle, $iLang );
                break;
        }

        // if was unable to fetch type uri - returning main
        if ( !$sUri ) {
            $sUri = $this->_getArticleMainUri( $oArticle, $iLang );
        }

        return $this->_getFullUrl( $sUri, $iLang );
    }

    public function onDeleteArticle( $oArticle )
    {
        $oDb = oxDb::getDb();
        $sIdQuoted = $oDb->quote( $oArticle->getId() );
        $oDb->execute("delete from oxseo where oxobjectid = $sIdQuoted and oxtype = 'oxarticle'");
        $oDb->execute("delete from oxobject2seodata where oxobjectid = $sIdQuoted");
    }

    protected function _getAltUri( $sObjectId, $iLang )
    {
        $sSeoUrl = null;
        $oArticle = oxNew( "oxarticle" );
        $oArticle->setSkipAssign( true );
        if ( $oArticle->loadInLang( $iLang, $sObjectId ) ) {
            // choosing URI type to generate
            switch( $this->_getListType() ) {
                case 'vendor':
                    $sSeoUrl = $this->_getArticleVendorUri( $oArticle, $iLang, true );
                    break;
                case 'manufacturer':
                    $sSeoUrl = $this->_getArticleManufacturerUri( $oArticle, $iLang, true );
                    break;
                case 'tag':
                    $sSeoUrl = $this->_getArticleTagUri( $oArticle, $iLang, true );
                    break;
                default:
                    $sSeoUrl = $this->_getArticleUri( $oArticle, $iLang, true );
                    break;
            }
        }
        return $sSeoUrl;
    }
}