sitemapiblock.php

<?php
namespace Bitrix\Seo;
 
use Bitrix\Main\Entity;
use Bitrix\Main\SiteTable;
 
class SitemapIblockTable extends Entity\DataManager
{
    const ACTIVE = 'Y';
    const INACTIVE = 'N';
 
    const TYPE_ELEMENT = 'E';
    const TYPE_SECTION = 'S';
 
    protected static $iblockCache = array();
 
    public static function getTableName()
    {
        return 'b_seo_sitemap_iblock';
    }
 
    public static function getMap()
    {
        $fieldsMap = array(
            'ID' => array(
                'data_type' => 'integer',
                'primary' => true,
                'autocomplete' => true,
            ),
            'SITEMAP_ID' => array(
                'data_type' => 'integer',
                'required' => true,
            ),
            'IBLOCK_ID' => array(
                'data_type' => 'integer',
                'required' => true,
            ),
            'SITEMAP' => array(
                'data_type' => 'Bitrix\Seo\SitemapTable',
                'reference' => array('=this.SITEMAP_ID' => 'ref.ID'),
            ),
            'IBLOCK' => array(
                'data_type' => 'Bitrix\Iblock\IblockTable',
                'reference' => array('=this.IBLOCK_ID' => 'ref.ID'),
            ),
        );
 
        return $fieldsMap;
    }
 
    public static function clearBySitemap($sitemapId)
    {
        $connection = \Bitrix\Main\Application::getConnection();
        $query = $connection->query("
DELETE
FROM ".self::getTableName()."
WHERE SITEMAP_ID='".intval($sitemapId)."'
");
    }
 
    public static function getByIblock($fields, $itemType)
    {
        $sitemaps = array();
 
        if(!isset(self::$iblockCache[$fields['IBLOCK_ID']]))
        {
            self::$iblockCache[$fields['IBLOCK_ID']] = array();
 
            $dbRes = self::getList(array(
                'filter' => array(
                    'IBLOCK_ID' => $fields['IBLOCK_ID']
                ),
                'select' => array('SITEMAP_ID',
                    'SITE_ID' => 'SITEMAP.SITE_ID', 'SITEMAP_SETTINGS' => 'SITEMAP.SETTINGS',
                    'IBLOCK_CODE' => 'IBLOCK.CODE', 'IBLOCK_XML_ID' => 'IBLOCK.XML_ID',
                    'DETAIL_PAGE_URL' => 'IBLOCK.DETAIL_PAGE_URL',
                    'SECTION_PAGE_URL' => 'IBLOCK.SECTION_PAGE_URL',
                ),
            ));
 
            while($res = $dbRes->fetch())
            {
                self::$iblockCache[$fields['IBLOCK_ID']][] = $res;
            }
        }
 
        foreach(self::$iblockCache[$fields['IBLOCK_ID']] as $res)
        {
            $sitemapSettings = unserialize($res['SITEMAP_SETTINGS'], ['allowed_classes' => false]);
 
            $add = false;
 
            if($itemType == self::TYPE_SECTION)
            {
                $add = self::checkSection(
                    $fields['ID'],
                    $sitemapSettings['IBLOCK_SECTION_SECTION'][$fields['IBLOCK_ID']],
                    $sitemapSettings['IBLOCK_SECTION'][$fields['IBLOCK_ID']]
                );
            }
            else
            {
                if(is_array($fields['IBLOCK_SECTION']) && count($fields['IBLOCK_SECTION']) > 0)
                {
                    foreach($fields['IBLOCK_SECTION'] as $sectionId)
                    {
                        $add = self::checkSection(
                            $sectionId,
                            $sitemapSettings['IBLOCK_SECTION_ELEMENT'][$fields['IBLOCK_ID']],
                            $sitemapSettings['IBLOCK_ELEMENT'][$fields['IBLOCK_ID']]
                        );
 
                        if($add)
                        {
                            break;
                        }
                    }
                }
                else
                {
                    $add = $sitemapSettings['IBLOCK_ELEMENT'][$fields['IBLOCK_ID']] == 'Y';
                }
            }
 
            if($add)
            {
                $sitemaps[] = array(
                    'IBLOCK_CODE' => $res['IBLOCK_CODE'],
                    'IBLOCK_XML_ID' => $res['IBLOCK_XML_ID'],
                    'DETAIL_PAGE_URL' => $res['DETAIL_PAGE_URL'],
                    'SECTION_PAGE_URL' => $res['SECTION_PAGE_URL'],
                    'SITE_ID' => $res['SITE_ID'],
                    'PROTOCOL' => $sitemapSettings['PROTO'] == 1 ? 'https' : 'http',
                    'DOMAIN' => $sitemapSettings['DOMAIN'],
                    'ROBOTS' => $sitemapSettings['ROBOTS'],
                    'SITEMAP_DIR' => $sitemapSettings['DIR'],
                    'SITEMAP_FILE' => $sitemapSettings['FILENAME_INDEX'],
                    'SITEMAP_FILE_IBLOCK' => $sitemapSettings['FILENAME_IBLOCK'],
                );
            }
        }
 
        return $sitemaps;
    }
 
    public static function checkSection($sectionId, $sectionSettings, $defaultValue)
    {
        $value = $defaultValue;
 
        if(is_array($sectionSettings) && count($sectionSettings) > 0)
        {
            while ($sectionId > 0)
            {
                if(isset($sectionSettings[$sectionId]))
                {
                    $value = $sectionSettings[$sectionId];
                    break;
                }
 
                $dbRes = \CIBlockSection::getList(array(), array('ID' => $sectionId), false, array('ID', 'IBLOCK_SECTION_ID'));
                $section = $dbRes->fetch();
 
                $sectionId = $section["IBLOCK_SECTION_ID"];
            }
        }
 
        return $value === 'Y';
    }
}
 
class SitemapIblock
{
    private static $beforeActions = array(
        'BEFOREDELETEELEMENT' => array(array(),array()),
        'BEFOREDELETESECTION' => array(array(),array()),
        'BEFOREUPDATEELEMENT' => array(array(),array()),
        'BEFOREUPDATESECTION' => array(array(),array()),
    );
 
    public static function __callStatic($name, $arguments)
    {
        $name = ToUpper($name);
 
        switch($name)
        {
            case 'ADDELEMENT':
            case 'ADDSECTION':
                if(
                    $arguments[0]["ID"] > 0
                    && $arguments[0]['IBLOCK_ID'] > 0
                    && (
                        !isset($arguments[0]['ACTIVE'])
                        || $arguments[0]['ACTIVE'] == 'Y'
                    )
                )
                {
                    // we recieve array reference here
                    $fields = array();
                    foreach($arguments[0] as $key => $value)
                    {
                        $fields[$key] = $value;
                    }
 
                    if(!isset($fields['EXTERNAL_ID']) && isset($fields['XML_ID']))
                    {
                        $fields['EXTERNAL_ID'] = $fields['XML_ID'];
                    }
 
                    self::actionAdd($name, $fields);
                }
            break;
 
            case 'BEFOREDELETEELEMENT':
            case 'BEFOREDELETESECTION':
            case 'BEFOREUPDATEELEMENT':
            case 'BEFOREUPDATESECTION':
                $ID = $arguments[0];
                if(is_array($ID))
                    $ID = $ID['ID'];
 
                if($ID > 0)
                {
                    $element = $name == 'BEFOREDELETEELEMENT' || $name == 'BEFOREUPDATEELEMENT';
 
                    $dbFields = $element
                        ? \CIBlockElement::getByID($ID)
                        : \CIBlockSection::getByID($ID);
 
                    $fields = $dbFields->getNext();
                    if($fields)
                    {
                        if($element && !self::checkElement($fields))
                        {
                            return;
                        }
 
                        $sitemaps = SitemapIblockTable::getByIblock(
                            $fields,
                            $element ? SitemapIblockTable::TYPE_ELEMENT : SitemapIblockTable::TYPE_SECTION
                        );
                        
                        if (count($sitemaps) > 0)
                        {
//                          URL from $fields may be incorrect, if using #SERVER_NAME# template in iblock URL-template
//                          And we must generate true URL
                            $dbIblock = \CIBlock::GetByID($fields['IBLOCK_ID']);
                            $iblock = $dbIblock->GetNext();
                            $url = $element
                                ? $iblock['~DETAIL_PAGE_URL']
                                : $iblock['~SECTION_PAGE_URL'];
                            $url = self::prepareUrlToReplace($url);
                            $url = \CIBlock::replaceDetailUrl($url, $fields, false, $element ? 'E' : 'S');
                            
                            self::$beforeActions[$name][intval($element)][$ID] = array(
                                'URL' => $url,
                                'FIELDS' => $fields,
                                'SITEMAPS' => $sitemaps,
                            );
                        }
                    }
                }
            break;
 
            case 'DELETEELEMENT':
            case 'DELETESECTION':
            case 'UPDATEELEMENT':
            case 'UPDATESECTION':
 
                $fields = $arguments[0];
                $element = $name == 'DELETEELEMENT' || $name == 'UPDATEELEMENT';
 
                if(
                    is_array($fields)
                    && $fields['ID'] > 0
                    && isset(self::$beforeActions['BEFORE'.$name][intval($element)][$fields['ID']])
                )
                {
                    if($fields['RESULT'] !== false)
                    {
                        if($name == 'DELETEELEMENT' || $name == 'DELETESECTION')
                        {
                            self::actionDelete(self::$beforeActions['BEFORE'.$name][intval($element)][$fields['ID']]);
                        }
                        else
                        {
                            self::actionUpdate(self::$beforeActions['BEFORE'.$name][intval($element)][$fields['ID']], $element);
                        }
                    }
 
                    unset(self::$beforeActions['BEFORE'.$name][intval($element)][$fields['ID']]);
                }
 
            break;
 
        }
    }
 
    protected static function checkElement(&$fields)
    {
        if($fields['WF'] === 'Y')
        {
            if(
                $fields['WF_PARENT_ELEMENT_ID'] > 0
                && $fields['WF_PARENT_ELEMENT_ID'] != $fields['ID']
                && $fields['WF_STATUS_ID'] == 1
            )
            {
                $fields['ID'] = $fields['WF_PARENT_ELEMENT_ID'];
            }
            else
            {
                return false;
            }
        }
 
        return true;
    }
 
    protected static function actionUpdate($data, $element)
    {
        $fields = $data['FIELDS'];
        $siteDirs = self::createSiteDirs();
        
        foreach ($data['SITEMAPS'] as $sitemap)
        {
            $fileName = str_replace(
                array('#IBLOCK_ID#', '#IBLOCK_CODE#', '#IBLOCK_XML_ID#'),
                array($fields['IBLOCK_ID'], $sitemap['IBLOCK_CODE'], $sitemap['IBLOCK_XML_ID']),
                $sitemap['SITEMAP_FILE_IBLOCK']
            );
 
            if($element)
                $dbRes = \CIBlockElement::getByID($fields["ID"]);
            else
                $dbRes = \CIBlockSection::getByID($fields["ID"]);
            
            $newFields = $dbRes->fetch();
            
            $sitemapFile = new SitemapFile($fileName, $sitemap);
//          try remove entry from original file, to not create temp files to all parts
//          name may was changed in removeEntry
            $fileName = $sitemapFile->removeEntry($data['URL']);
 
//          write changes to temp file to preserve collisions
            $sitemapRuntimeId = $sitemap['SITE_ID'] . '-' . uniqid();
            $sitemapRuntimeId .= isset($fields['ID']) ? '-' . $fields['ID'] . '-' : '';
            $sitemapRuntimeFile = new SitemapRuntime($sitemapRuntimeId, $fileName, $sitemap);
            
//          check ACTIVITY by active, date or etc, add entry only for active
            if(self::checkActivity($element, $newFields))
            {
                $newFields['LANG_DIR'] = $siteDirs[$sitemap['SITE_ID']];
 
//              use just date(). it is not true, but because we use BEFORE event, we cant use real lastmod date, only previous value
                $date = date('d.m.Y H:i:s');
                
                $url = $element ? $sitemap['DETAIL_PAGE_URL'] : $sitemap['SECTION_PAGE_URL'];
                $urlType = $element ? 'E' : 'S';
//              remove or replace SERVER_NAME
                $url = self::prepareUrlToReplace($url, $sitemap['SITE_ID']);
                $rule = array(
                    'url' => \CIBlock::replaceDetailUrl($url, $newFields, false, $urlType),
                    'lastmod' => MakeTimeStamp($date),
                );
                
                $sitemapRuntimeFile->setOriginalFile($sitemapFile);
                $sitemapRuntimeFile->appendIblockEntry($rule['url'], $rule['lastmod']);
            }
            
//          rename RUNTIME file to original SITEMAPFILE name, or just remove TMP file
//          after this in original file will be added always changes
            if ($sitemapRuntimeFile->isNotEmpty() && $sitemapRuntimeFile->isCurrentPartNotEmpty())
                $sitemapRuntimeFile->finish();
            else
                $sitemapRuntimeFile->delete();
            
            $sitemapIndex = new SitemapIndex($sitemap['SITEMAP_FILE'], $sitemap);
            $sitemapIndex->appendIndexEntry($sitemapFile);
            
            if ($sitemap['ROBOTS'] == 'Y')
            {
                $robotsFile = new RobotsFile($sitemap['SITE_ID']);
                $robotsFile->addRule(
                    array(RobotsFile::SITEMAP_RULE, $sitemapIndex->getUrl())
                );
            }
        }
    }
 
    protected static function actionDelete($data)
    {
        $fields = $data['FIELDS'];
        foreach ($data['SITEMAPS'] as $sitemap)
        {
            $fileName = str_replace(
                array('#IBLOCK_ID#', '#IBLOCK_CODE#', '#IBLOCK_XML_ID#'),
                array($fields['IBLOCK_ID'], $sitemap['IBLOCK_CODE'], $sitemap['IBLOCK_XML_ID']),
                $sitemap['SITEMAP_FILE_IBLOCK']
            );
 
            $sitemapFile = new SitemapFile($fileName, $sitemap);
            $sitemapFile->removeEntry($data['URL']);
 
            $sitemapIndex = new SitemapIndex($sitemap['SITEMAP_FILE'], $sitemap);
            $sitemapIndex->appendIndexEntry($sitemapFile);
        }
    }
 
    protected static function actionAdd($name, $fields)
    {
        if($name == 'ADDELEMENT')
        {
            if(!self::checkElement($fields))
            {
                return;
            }
 
            // we don't have the GLOBAL_ACTIVE flag in fields so we should check it manually
            if(is_array($fields['IBLOCK_SECTION']) && count($fields['IBLOCK_SECTION']) > 0)
            {
                $newSections = array();
                $filter = array(
                    'ID' => $fields['IBLOCK_SECTION'],
                    'IBLOCK_ID' => $fields['IBLOCK_ID'],
                    'GLOBAL_ACTIVE' => 'Y'
                );
                
                $dbRes = \CIBlockSection::getList(array(), $filter, false, array('ID', 'IBLOCK_TYPE_ID', 'IBLOCK_CODE'));
                while ($ar = $dbRes->fetch())
                {
                    $newSections[] = $ar['ID'];
                    $iblockTypeId = $ar['IBLOCK_TYPE_ID'] ? $ar['IBLOCK_TYPE_ID'] : null;
                    $iblockCode = $ar['IBLOCK_CODE'] ? $ar['IBLOCK_CODE'] : null;
                }
 
                if(count($newSections) <= 0)
                {
                    // element is added to inactive sections
                    return;
                }
 
                $fields['IBLOCK_SECTION'] = $newSections;
            }
        }
        elseif($name == 'ADDSECTION')
        {
            $dbRes = \CIBlockSection::getList(
                array(),
                array('ID' => $fields['ID'], 'GLOBAL_ACTIVE' => 'Y'),
                false,
                array('ID', 'IBLOCK_TYPE_ID', 'IBLOCK_CODE')
            );
            
            $inactiveBranch = true;
            while ($ar = $dbRes->fetch())
            {
                $iblockTypeId = $ar['IBLOCK_TYPE_ID'] ? $ar['IBLOCK_TYPE_ID'] : null;
                $iblockCode = $ar['IBLOCK_CODE'] ? $ar['IBLOCK_CODE'] : null;
                $inactiveBranch = false;
            }
            
            if ($inactiveBranch)
            {
                // section is added to inactive branch
                return;
            }
        }
        
        $fields['IBLOCK_TYPE_ID'] = $iblockTypeId;
        $fields['IBLOCK_CODE'] = $iblockCode;
        
        $sitemaps = SitemapIblockTable::getByIblock(
            $fields,
            $name == 'ADDSECTION' ? SitemapIblockTable::TYPE_SECTION : SitemapIblockTable::TYPE_ELEMENT
        );
 
        $fields['TIMESTAMP_X'] = ConvertTimeStamp(false, "FULL");
 
        if(isset($fields['IBLOCK_SECTION']) && is_array($fields['IBLOCK_SECTION']) && count($fields['IBLOCK_SECTION']) > 0)
        {
            $fields['IBLOCK_SECTION_ID'] = min($fields['IBLOCK_SECTION']);
        }
 
        if(count($sitemaps) > 0)
        {
            $siteDirs = self::createSiteDirs();
            
            foreach ($sitemaps as $sitemap)
            {
                $fileName = str_replace(
                    array('#IBLOCK_ID#', '#IBLOCK_CODE#', '#IBLOCK_XML_ID#'),
                    array($fields['IBLOCK_ID'], $sitemap['IBLOCK_CODE'], $sitemap['IBLOCK_XML_ID']),
                    $sitemap['SITEMAP_FILE_IBLOCK']
                );
 
                $sitemapFile = new SitemapFile($fileName, $sitemap);
 
//              write changes to temp file to preserve collisions
                $sitemapRuntimeId = $sitemap['SITE_ID'] . '-' . uniqid();
                $sitemapRuntimeId .= isset($fields['ID']) ? '-' . $fields['ID'] . '-' : '';
                $sitemapRuntimeFile = new SitemapRuntime($sitemapRuntimeId, $fileName, $sitemap);
                
                if(self::checkActivity($name == 'ADDELEMENT' ? true : false, $fields))
                {
                    $fields['LANG_DIR'] = $siteDirs[$sitemap['SITE_ID']];
                    
                    $url = $name == 'ADDSECTION' ? $sitemap['SECTION_PAGE_URL'] : $sitemap['DETAIL_PAGE_URL'];
                    $urlType = $name == 'ADDSECTION' ? 'S' : 'E';
//                  remove or replace SERVER_NAME
                    $url = self::prepareUrlToReplace($url, $sitemap['SITE_ID']);
                    $rule = array(
                        'url' => \CIBlock::replaceDetailUrl($url, $fields, false, $urlType),
                        'lastmod' => MakeTimeStamp($fields['TIMESTAMP_X']),
                    );
                    
                    $sitemapRuntimeFile->setOriginalFile($sitemapFile);
                    $sitemapRuntimeFile->appendIblockEntry($rule['url'], $rule['lastmod']);
                }
                
//              after this in original file will be added always changes
                if ($sitemapRuntimeFile->isNotEmpty() && $sitemapRuntimeFile->isCurrentPartNotEmpty())
                    $sitemapRuntimeFile->finish();
                else
                    $sitemapRuntimeFile->delete();
                
                $sitemapIndex = new SitemapIndex($sitemap['SITEMAP_FILE'], $sitemap);
                $sitemapIndex->appendIndexEntry($sitemapFile);
                
                if ($sitemap['ROBOTS'] == 'Y')
                {
                    $robotsFile = new RobotsFile($sitemap['SITE_ID']);
                    $robotsFile->addRule(
                        array(RobotsFile::SITEMAP_RULE, $sitemapIndex->getUrl())
                    );
                }
            }
        }
    }
    
    
    private static function createSiteDirs()
    {
        $siteDirs = array();
        $dbSite = SiteTable::getList(array('select' => array('LID', 'DIR', 'SERVER_NAME')));
        while ($site = $dbSite->fetch())
        {
            $siteDirs[$site['LID']] = $site['DIR'];
        }
        
        return $siteDirs;
    }
    
    
    private static function checkActivity($isElement, $fields)
    {
        if(array_key_exists("ACTIVE", $fields) && $fields["ACTIVE"] == "N")
            return false;
        
//      for iblock element and iblock section we check different fields
        if($isElement)
        {
//          activity may be in field DATE_ACTIVE_ or ACTIVE_, check both
            if(
                array_key_exists("DATE_ACTIVE_FROM", $fields) && $fields["DATE_ACTIVE_FROM"] &&
                new \DateTime($fields["DATE_ACTIVE_FROM"]) > new \DateTime($fields["TIMESTAMP_X"])
            )
                return false;
            if(
                array_key_exists("ACTIVE_FROM", $fields) && $fields["ACTIVE_FROM"] &&
                new \DateTime($fields["ACTIVE_FROM"]) > new \DateTime($fields["TIMESTAMP_X"])
            )
                return false;
            
            if(
                array_key_exists("DATE_ACTIVE_TO", $fields) && $fields["DATE_ACTIVE_TO"] &&
                new \DateTime($fields["DATE_ACTIVE_TO"]) < new \DateTime($fields["TIMESTAMP_X"])
            )
                return false;
            if(
                array_key_exists("ACTIVE_TO", $fields) && $fields["ACTIVE_TO"] &&
                new \DateTime($fields["ACTIVE_TO"]) < new \DateTime($fields["TIMESTAMP_X"])
            )
                return false;
        }
        else
        {
            if(array_key_exists("GLOBAL_ACTIVE", $fields) && $fields["GLOBAL_ACTIVE"] == "N")
                return false;
        }
        
        return true;
    }
    
    
    public static function prepareUrlToReplace($url, $siteId = NULL)
    {
//      REMOVE PROTOCOL - we put them later, based on user settings
        $url = str_replace('http://', '', $url);
        $url = str_replace('https://', '', $url);
 
//      REMOVE SERVER_NAME from start position, because we put server_url later
        if (mb_substr($url, 0, mb_strlen('#SERVER_NAME#')) == '#SERVER_NAME#')
            $url = mb_substr($url, mb_strlen('#SERVER_NAME#'));
 
//      get correct SERVER_URL
        if ($siteId)
        {
            $filter = array('=LID' => $siteId);
            $dbSite = SiteTable::getList(array(
                'filter' => $filter,
                'select' => array('LID', 'DIR', 'SERVER_NAME'),
            ));
            $currentSite = $dbSite->fetch();
            $serverName = $currentSite['SERVER_NAME'];
            $url = str_replace('#SERVER_NAME#', $serverName, $url);
        }
        
        return $url;
    }
}