posting.php

См. документацию.

<?php
namespace Bitrix\Sender;
 
use Bitrix\Main\Entity;
use Bitrix\Main\Localization\Loc;
use Bitrix\Main\ORM\Query\Query;
use Bitrix\Main\Type as MainType;
use Bitrix\Sender\Internals\Model;
use Bitrix\Sender\Posting\Builder as PostingBuilder;
 
Loc::loadMessages(__FILE__);
 
class PostingTable extends Entity\DataManager
{
    const STATUS_NEW = 'N';
    const STATUS_PART = 'P';
    const STATUS_SENT = 'S';
    const STATUS_SENT_WITH_ERRORS = 'E';
    const STATUS_ABORT = 'A';
    const STATUS_WAIT = 'W';

    public static function getTableName()
    {
        return 'b_sender_posting';
    }

    public static function getMap()
    {
        return array(
            'ID' => array(
                'data_type' => 'integer',
                'primary' => true,
                'autocomplete' => true,
            ),
            'MAILING_ID' => array(
                'data_type' => 'integer',
                'primary' => true,
                'required' => true,
            ),
            'MAILING_CHAIN_ID' => array(
                'data_type' => 'integer',
                'primary' => true,
                'required' => true,
            ),
            'DATE_CREATE' => array(
                'data_type' => 'datetime',
                'required' => true,
                'default_value' => new MainType\DateTime(),
            ),
            'DATE_UPDATE' => array(
                'data_type' => 'datetime',
                'required' => true,
                'default_value' => new MainType\DateTime(),
            ),
            'STATUS' => array(
                'data_type' => 'string',
                'required' => true,
                'default_value' => static::STATUS_NEW,
            ),
            'DATE_SEND' => array(
                'data_type' => 'datetime',
            ),
            'DATE_PAUSE' => array(
                'data_type' => 'datetime',
            ),
            'DATE_SENT' => array(
                'data_type' => 'datetime',
            ),
            'COUNT_READ' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'COUNT_CLICK' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'COUNT_UNSUB' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'COUNT_SEND_ALL' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'COUNT_SEND_NONE' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'COUNT_SEND_ERROR' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'COUNT_SEND_SUCCESS' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'COUNT_SEND_DENY' => array(
                'data_type' => 'integer',
                'default_value' => 0
            ),
            'CONSENT_SUPPORT' => array(
                'data_type' => 'boolean',
                'values' => array('N', 'Y'),
                'default_value' => 'N',
                'required' => true,
            ),
            'LETTER' => array(
                'data_type' => 'Bitrix\Sender\Internals\Model\LetterTable',
                'reference' => array('=this.MAILING_CHAIN_ID' => 'ref.ID'),
            ),
            'MAILING' => array(
                'data_type' => 'Bitrix\Sender\MailingTable',
                'reference' => array('=this.MAILING_ID' => 'ref.ID'),
            ),
            'MAILING_CHAIN' => array(
                'data_type' => 'Bitrix\Sender\MailingChainTable',
                'reference' => array('=this.MAILING_CHAIN_ID' => 'ref.ID'),
            ),
            'POSTING_RECIPIENT' => array(
                'data_type' => 'Bitrix\Sender\PostingRecipientTable',
                'reference' => array('=this.ID' => 'ref.POSTING_ID'),
            ),
            'POSTING_READ' => array(
                'data_type' => 'Bitrix\Sender\PostingReadTable',
                'reference' => array('=this.ID' => 'ref.POSTING_ID'),
            ),
            'POSTING_CLICK' => array(
                'data_type' => 'Bitrix\Sender\PostingClickTable',
                'reference' => array('=this.ID' => 'ref.POSTING_ID'),
            ),
            'POSTING_UNSUB' => array(
                'data_type' => 'Bitrix\Sender\PostingUnsubTable',
                'reference' => array('=this.ID' => 'ref.POSTING_ID'),
            ),
        );
    }

    public static function onDelete(Entity\Event $event)
    {
        $result = new Entity\EventResult;
        $data = $event->getParameters();
 
 
        $listId = array();
        if(array_key_exists('ID', $data['primary']))
        {
            $listId[] = $data['primary']['ID'];
        }
        else
        {
            $filter = array();
            foreach($data['primary'] as $primKey => $primVal)
                $filter[$primKey] = $primVal;
 
            $tableDataList = static::getList(array(
                'select' => array('ID'),
                'filter' => $filter
            ));
            while($tableData = $tableDataList->fetch())
            {
                $listId[] = $tableData['ID'];
            }
 
        }
 
        foreach($listId as $primaryId)
        {
            $primary = array('POSTING_ID' => $primaryId);
            PostingReadTable::deleteList($primary);
            PostingClickTable::deleteList($primary);
            PostingUnsubTable::deleteList($primary);
            PostingRecipientTable::deleteList($primary);
        }
 
 
        return $result;
    }

    public static function addRecipient($ar, $checkDuplicate = false)
    {
        if(!$checkDuplicate)
        {
            $needAdd = true;
        }
        else
        {
            $row = PostingRecipientTable::getRow(array(
                'select' => array('ID'),
                'filter' => array(
                    '=CONTACT_ID' => $ar['CONTACT_ID'],
                    '=POSTING_ID' => $ar['POSTING_ID']
                )
            ));
            if(!$row)
            {
                $needAdd = true;
            }
            else
            {
                $needAdd = false;
            }
        }
 
        if($needAdd)
        {
            PostingRecipientTable::add($ar);
        }
    }

    public static function initGroupRecipients($postingId, $checkDuplicate = true)
    {
        return PostingBuilder::create()->run($postingId, $checkDuplicate);
    }

    public static function getRecipientCountByStatus($id, ?array $customFilter = null)
    {
        $statusList = [];
        $select = ['CNT', 'STATUS'];
        $filter = !$customFilter?['POSTING_ID' => $id] : ['LOGIC' => 'AND',['POSTING_ID' => $id],$customFilter];
        $postingContactDb = PostingRecipientTable::getList([
            'select' => $select,
            'filter' => $filter,
            'runtime' => [new Entity\ExpressionField('CNT', 'COUNT(*)')],
        ]);
        while($postingContact = $postingContactDb->fetch())
            $statusList[$postingContact['STATUS']] = intval($postingContact['CNT']);
 
        return $statusList;
    }

    public static function getRecipientCount($id, $status = '')
    {
        $count = 0;
 
        $ar = static::getRecipientCountByStatus($id);
        if ($status != '')
            $count = (array_key_exists($status, $ar) ? $ar[$status] : 0);
        else
            foreach ($ar as $k => $v) $count += $v;
 
        return $count;
    }

    public static function getSendPercent($id)
    {
        $ar = static::getRecipientCountByStatus($id);
        $count = 0;
        foreach ($ar as $k => $v)
        {
            $count += $v;
        }
 
        $countNew = 0;
        if(isset($ar[PostingRecipientTable::SEND_RESULT_NONE]))
        {
            $countNew = $ar[PostingRecipientTable::SEND_RESULT_NONE];
        }
 
        if($count > 0 && $countNew > 0)
        {
            return round(($count - $countNew) / $count, 2) * 100;
        }
        else
        {
            return 100;
        }
    }

    public static function getRecipientStatusToPostingFieldMap()
    {
        return array(
            PostingRecipientTable::SEND_RESULT_NONE => 'COUNT_SEND_NONE',
            PostingRecipientTable::SEND_RESULT_ERROR => 'COUNT_SEND_ERROR',
            PostingRecipientTable::SEND_RESULT_SUCCESS => 'COUNT_SEND_SUCCESS',
            PostingRecipientTable::SEND_RESULT_DENY => 'COUNT_SEND_DENY',
        );
    }

    public static function deleteList(array $filter)
    {
        $entity = static::getEntity();
        $connection = $entity->getConnection();
 
        \CTimeZone::disable();
        $sql = sprintf(
            'DELETE FROM %s WHERE %s',
            $connection->getSqlHelper()->quote($entity->getDbTableName()),
            Query::buildFilterSql($entity, $filter)
        );
        $res = $connection->query($sql);
        \CTimeZone::enable();
 
        return $res;
    }
}
 
 
 
class PostingReadTable extends Entity\DataManager
{
    public static function getTableName()
    {
        return 'b_sender_posting_read';
    }

    public static function getMap()
    {
        return array(
            'ID' => array(
                'data_type' => 'integer',
                'primary' => true,
                'autocomplete' => true,
            ),
            'POSTING_ID' => array(
                'primary' => true,
                'data_type' => 'integer',
            ),
            'RECIPIENT_ID' => array(
                'primary' => true,
                'data_type' => 'integer',
            ),
            'DATE_INSERT' => array(
                'data_type' => 'datetime',
                'default_value' => new MainType\DateTime(),
            ),
        );
    }

    public static function onAfterAdd(Entity\Event $event)
    {
        $result = new Entity\EventResult;
        $data = $event->getParameters();
        $data = $data['fields'];
 
        $isRead = Model\Posting\RecipientTable::getList([
            'filter' => [
                '=ID' => $data['RECIPIENT_ID'],
                '=IS_READ' => 'Y',
            ],
        ])->fetch();
 
        if (!$isRead)
        {
            Model\Posting\RecipientTable::update($data['RECIPIENT_ID'], ['IS_READ' => 'Y']);
 
            // update read counter of posting
            Model\PostingTable::update($data['POSTING_ID'], array(
                'COUNT_READ' => new \Bitrix\Main\DB\SqlExpression('?# + 1', 'COUNT_READ')
            ));
        }
 
        return $result;
    }

    public static function deleteList(array $filter)
    {
        $entity = static::getEntity();
        $connection = $entity->getConnection();
 
        \CTimeZone::disable();
        $sql = sprintf(
            'DELETE FROM %s WHERE %s',
            $connection->getSqlHelper()->quote($entity->getDbTableName()),
            Query::buildFilterSql($entity, $filter)
        );
        $res = $connection->query($sql);
        \CTimeZone::enable();
 
        return $res;
    }
}
 
 
class PostingClickTable extends Entity\DataManager
{
    public static function getTableName()
    {
        return 'b_sender_posting_click';
    }

    public static function getMap()
    {
        return array(
            'ID' => array(
                'data_type' => 'integer',
                'primary' => true,
                'autocomplete' => true,
            ),
            'POSTING_ID' => array(
                'primary' => true,
                'data_type' => 'integer',
            ),
            'RECIPIENT_ID' => array(
                'primary' => true,
                'data_type' => 'integer',
            ),
            'DATE_INSERT' => array(
                'data_type' => 'datetime',
                'default_value' => new MainType\DateTime(),
            ),
            'URL' => array(
                'data_type' => 'string',
            ),
            'POSTING' => array(
                'data_type' => 'Bitrix\Sender\PostingTable',
                'reference' => array('=this.POSTING_ID' => 'ref.ID'),
            ),
        );
    }

    public static function onAfterAdd(Entity\Event $event)
    {
        $result = new Entity\EventResult;
        $data = $event->getParameters();
        $data = $data['fields'];
 
        $isClicked = Model\Posting\RecipientTable::getList([
            'filter' => [
                '=ID' => $data['RECIPIENT_ID'],
                '=IS_CLICK' => 'Y',
            ],
        ])->fetch();
 
        if (!$isClicked)
        {
            Model\Posting\RecipientTable::update($data['RECIPIENT_ID'], ['IS_CLICK' => 'Y']);
 
            // update click counter of posting
            Model\PostingTable::update($data['POSTING_ID'], array(
                'COUNT_CLICK' => new \Bitrix\Main\DB\SqlExpression('?# + 1', 'COUNT_CLICK')
            ));
        }
 
        return $result;
    }
 

    public static function deleteList(array $filter)
    {
        $entity = static::getEntity();
        $connection = $entity->getConnection();
 
        \CTimeZone::disable();
        $sql = sprintf(
            'DELETE FROM %s WHERE %s',
            $connection->getSqlHelper()->quote($entity->getDbTableName()),
            Query::buildFilterSql($entity, $filter)
        );
        $res = $connection->query($sql);
        \CTimeZone::enable();
 
        return $res;
    }
}
 
class PostingUnsubTable extends Entity\DataManager
{
    public static function getTableName()
    {
        return 'b_sender_posting_unsub';
    }

    public static function getMap()
    {
        return array(
            'ID' => array(
                'data_type' => 'integer',
                'primary' => true,
                'autocomplete' => true,
            ),
            'POSTING_ID' => array(
                'primary' => true,
                'data_type' => 'integer',
            ),
            'RECIPIENT_ID' => array(
                'primary' => true,
                'data_type' => 'integer',
            ),
            'DATE_INSERT' => array(
                'data_type' => 'datetime',
                'default_value' => new MainType\DateTime(),
            ),
            'POSTING' => array(
                'data_type' => 'Bitrix\Sender\PostingTable',
                'reference' => array('=this.POSTING_ID' => 'ref.ID'),
            ),
            'POSTING_RECIPIENT' => array(
                'data_type' => 'Bitrix\Sender\PostingRecipientTable',
                'reference' => array('=this.RECIPIENT_ID' => 'ref.ID'),
            ),
        );
    }

    public static function onAfterAdd(Entity\Event $event)
    {
        $result = new Entity\EventResult;
        $data = $event->getParameters();
        $data = $data['fields'];
        $isUnsub = Model\Posting\RecipientTable::getList([
            'filter' => [
                '=ID' => $data['RECIPIENT_ID'],
                '=IS_UNSUB' => 'Y',
            ],
        ])->fetch();
 
        if (!$isUnsub)
        {
            Model\Posting\RecipientTable::update($data['RECIPIENT_ID'], ['IS_UNSUB' => 'Y']);
 
            // update unsub counter of posting
            Model\PostingTable::update($data['POSTING_ID'], array(
                'COUNT_UNSUB' => new \Bitrix\Main\DB\SqlExpression('?# + 1', 'COUNT_UNSUB')
            ));
        }
        return $result;
    }
 

    public static function deleteList(array $filter)
    {
        $entity = static::getEntity();
        $connection = $entity->getConnection();
 
        \CTimeZone::disable();
        $sql = sprintf(
            'DELETE FROM %s WHERE %s',
            $connection->getSqlHelper()->quote($entity->getDbTableName()),
            Query::buildFilterSql($entity, $filter)
        );
        $res = $connection->query($sql);
        \CTimeZone::enable();
 
        return $res;
    }
}

class PostingRecipientTable extends Entity\DataManager
{
    const SEND_RESULT_NONE = 'Y';
    const SEND_RESULT_SUCCESS = 'N';
    const SEND_RESULT_ERROR = 'E';
    const SEND_RESULT_WAIT = 'W';
    const SEND_RESULT_DENY = 'D';
    const SEND_RESULT_WAIT_ACCEPT = 'A';
 
    protected static $personalizeList = null;
    public static function getTableName()
    {
        return 'b_sender_posting_recipient';
    }

    public static function getMap()
    {
        return array(
            'ID' => array(
                'data_type' => 'integer',
                'primary' => true,
                'autocomplete' => true,
            ),
            'POSTING_ID' => array(
                'primary' => true,
                'data_type' => 'integer',
            ),
            'STATUS' => array(
                'data_type' => 'string',
                'primary' => true,
                'required' => true,
                'default_value' => static::SEND_RESULT_NONE,
            ),
            'DATE_SENT' => array(
                'data_type' => 'datetime',
            ),
            'DATE_DENY' => array(
                'data_type' => 'datetime',
            ),
            'DATE_UPDATE' => array(
                'data_type' => 'datetime',
                'required' => true,
                'default_value' => new MainType\DateTime(),
            ),
            'CONTACT_ID' => array(
                'required' => true,
                'data_type' => 'integer',
            ),
            'USER_ID' => array(
                'data_type' => 'integer',
            ),
            'FIELDS' => array(
                'data_type' => 'text',
                'serialized' => true,
            ),
            'ROOT_ID' => array(
                'data_type' => 'integer',
            ),
            'IS_READ' => array(
                'data_type' => 'string',
            ),
            'IS_CLICK' => array(
                'data_type' => 'string',
            ),
            'IS_UNSUB' => array(
                'data_type' => 'string',
            ),
            'CONTACT' => array(
                'data_type' => 'Bitrix\Sender\ContactTable',
                'reference' => array('=this.CONTACT_ID' => 'ref.ID'),
            ),
            'POSTING' => array(
                'data_type' => 'Bitrix\Sender\PostingTable',
                'reference' => array('=this.POSTING_ID' => 'ref.ID'),
            ),
            'POSTING_READ' => array(
                'data_type' => 'Bitrix\Sender\PostingReadTable',
                'reference' => array('=this.ID' => 'ref.RECIPIENT_ID'),
            ),
            'POSTING_CLICK' => array(
                'data_type' => 'Bitrix\Sender\PostingClickTable',
                'reference' => array('=this.ID' => 'ref.RECIPIENT_ID'),
            ),
            'POSTING_UNSUB' => array(
                'data_type' => 'Bitrix\Sender\PostingUnsubTable',
                'reference' => array('=this.ID' => 'ref.RECIPIENT_ID'),
            ),
 
        );
    }
 
    public static function setPersonalizeList(array $personalizeList = null)
    {
        static::$personalizeList = $personalizeList;
    }

    public static function getPersonalizeList()
    {
        $list = array(
            array(
                'CODE' => 'NAME',
                'NAME' => Loc::getMessage("SENDER_POSTING_PERSONALIZE_FIELD_NAME"),
                'DESC' => Loc::getMessage("SENDER_POSTING_PERSONALIZE_FIELD_NAME_DESC"),
            ),
            array(
                'CODE' => 'EMAIL_TO',
                'NAME' => Loc::getMessage("SENDER_POSTING_PERSONALIZE_FIELD_EMAIL"),
                'DESC' => Loc::getMessage("SENDER_POSTING_PERSONALIZE_FIELD_EMAIL_DESC"),
            ),
        );
        if (!Integration\Bitrix24\Service::isCloud())
        {
            $list[] = array(
                'CODE' => 'USER_ID',
                'NAME' => Loc::getMessage("SENDER_POSTING_PERSONALIZE_FIELD_USER_ID"),
                'DESC' => Loc::getMessage("SENDER_POSTING_PERSONALIZE_FIELD_USER_ID_DESC"),
            );
            $list[] = array(
                'CODE' => 'SITE_NAME',
                'NAME' => Loc::getMessage("SENDER_POSTING_PERSONALIZE_FIELD_SITE_NAME"),
                'DESC' => Loc::getMessage("SENDER_POSTING_PERSONALIZE_FIELD_SITE_NAME_DESC"),
            );
            $list[] = array(
                'CODE' => 'SENDER_CHAIN_CODE',
                'NAME' => Loc::getMessage("SENDER_POSTING_PERSONALIZE_FIELD_SENDER_CHAIN_ID"),
                'DESC' => Loc::getMessage("SENDER_POSTING_PERSONALIZE_FIELD_SENDER_CHAIN_ID_DESC"),
            );
        }
 
        return array_merge(
            $list,
            (static::$personalizeList ? static::$personalizeList : array())
        );
    }

    public static function getStatusList()
    {
        return array(
            self::SEND_RESULT_NONE => Loc::getMessage('SENDER_POSTING_RECIPIENT_STATUS_N'),
            self::SEND_RESULT_SUCCESS => Loc::getMessage('SENDER_POSTING_RECIPIENT_STATUS_S'),
            self::SEND_RESULT_ERROR => Loc::getMessage('SENDER_POSTING_RECIPIENT_STATUS_E'),
            self::SEND_RESULT_DENY => Loc::getMessage('SENDER_POSTING_RECIPIENT_STATUS_D'),
            self::SEND_RESULT_WAIT_ACCEPT => Loc::getMessage('SENDER_POSTING_RECIPIENT_STATUS_A')
        );
    }
 
    public static function hasUnprocessed($postingId, $threadId = null)
    {
        return (static::getCount(['=POSTING_ID' => $postingId, '=STATUS' => self::SEND_RESULT_NONE]) > 0);
    }
 

    public static function deleteList(array $filter)
    {
        $entity = static::getEntity();
        $connection = $entity->getConnection();
 
        \CTimeZone::disable();
        $sql = sprintf(
            'DELETE FROM %s WHERE %s',
            $connection->getSqlHelper()->quote($entity->getDbTableName()),
            Query::buildFilterSql($entity, $filter)
        );
        $res = $connection->query($sql);
        \CTimeZone::enable();
 
        return $res;
    }

    public static function getConflictFields(): array
    {
        return [
            'POSTING_ID',
            'CONTACT_ID',
        ];
    }
}