296 lines
9.4 KiB
PHP
296 lines
9.4 KiB
PHP
<?php
|
|
/**
|
|
* @brief Digest Class
|
|
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
|
|
* @copyright (c) Invision Power Services, Inc.
|
|
* @license https://www.invisioncommunity.com/legal/standards/
|
|
* @package Invision Community
|
|
* @since 08 May 2014
|
|
*/
|
|
|
|
namespace IPS\core\Digest;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Digest Class
|
|
*/
|
|
class _Digest
|
|
{
|
|
/**
|
|
* @brief [IPS\Member] Digest member object
|
|
*/
|
|
public $member = NULL;
|
|
|
|
/**
|
|
* @brief Output to include in digest email template
|
|
*/
|
|
public $output = array( 'html' => '', 'plain' => '' );
|
|
|
|
/**
|
|
* @brief Frequency Daily/Weekly
|
|
*/
|
|
public $frequency = NULL;
|
|
|
|
/**
|
|
* @brief Is there anything to send?
|
|
*/
|
|
public $hasContent = FALSE;
|
|
|
|
/**
|
|
* @brief Mail Object
|
|
*/
|
|
protected $mail;
|
|
|
|
/**
|
|
* Build Digest
|
|
*
|
|
* @param array $data Array of follow records
|
|
* @return void
|
|
*/
|
|
public function build( $data )
|
|
{
|
|
/* Banned members should not be emailed */
|
|
if( $this->member->isBanned() )
|
|
{
|
|
return;
|
|
}
|
|
|
|
/* Don't try on rows where the member may have been removed */
|
|
if ( !$this->member->member_id )
|
|
{
|
|
return;
|
|
}
|
|
|
|
/* We just do it this way because for backwards-compatibility, template parsing expects an \IPS\Email object with a $language property
|
|
This email is never actually sent and a new one is generated in send() */
|
|
$this->mail = \IPS\Email::buildFromTemplate( 'core', 'digest', array( $this->member, $this->frequency ), \IPS\Email::TYPE_LIST );
|
|
$this->mail->language = $this->member->language();
|
|
|
|
$numberOfItems = 0;
|
|
foreach( $data as $app => $area )
|
|
{
|
|
foreach ( $area as $items )
|
|
{
|
|
$numberOfItems += \count( $items );
|
|
}
|
|
}
|
|
$max = ceil( 80 / $numberOfItems );
|
|
|
|
foreach( $data as $app => $area )
|
|
{
|
|
foreach( $area as $key => $follows )
|
|
{
|
|
$count = 0;
|
|
|
|
$areaPlainOutput = NULL;
|
|
$areaHtmlOutput = NULL;
|
|
$added = FALSE;
|
|
|
|
/* Following an item or node */
|
|
$class = 'IPS\\' . $app . '\\' . mb_ucfirst( $key );
|
|
|
|
if ( class_exists( $class ) AND \IPS\Application::appIsEnabled( $app ) )
|
|
{
|
|
$parents = class_parents( $class );
|
|
|
|
if ( \in_array( 'IPS\Node\Model', $parents ) )
|
|
{
|
|
foreach ( $follows as $follow )
|
|
{
|
|
if ( property_exists( $class, 'contentItemClass' ) )
|
|
{
|
|
$itemClass= $class::$contentItemClass;
|
|
|
|
/* Force custom profile fields not to be returned, as they can reference templates */
|
|
if( isset( $itemClass::$commentClass ) )
|
|
{
|
|
$commentClass = $itemClass::$commentClass;
|
|
|
|
$commentClass::$joinProfileFields = FALSE;
|
|
}
|
|
|
|
$where = array(
|
|
array( $itemClass::$databaseTable . '.' . $itemClass::$databasePrefix . $itemClass::$databaseColumnMap['container'] . '=? AND ' . $itemClass::$databaseTable . '.' . $itemClass::$databasePrefix . $itemClass::$databaseColumnMap['date'] . ' > ? AND ' . $itemClass::$databaseTable . '.' .$itemClass::$databasePrefix . $itemClass::$databaseColumnMap['author'] . '!=?',
|
|
$follow['follow_rel_id'],
|
|
$follow['follow_notify_sent'] ?: $follow['follow_added'],
|
|
$follow['follow_member_id']
|
|
)
|
|
);
|
|
|
|
foreach ( $itemClass::getItemsWithPermission( array_merge( $itemClass::digestWhere(), $where ),
|
|
$itemClass::$databaseTable . '.' . $itemClass::$databasePrefix . $itemClass::$databaseColumnMap['date'] . ' ASC',
|
|
$max,
|
|
'read',
|
|
\IPS\Content\Hideable::FILTER_OWN_HIDDEN,
|
|
NULL,
|
|
$this->member,
|
|
TRUE
|
|
) as $item )
|
|
{
|
|
try
|
|
{
|
|
$areaPlainOutput .= \IPS\Email::template( $app, 'digests__item', 'plaintext', array( $item, $this->mail ) );
|
|
$areaHtmlOutput .= \IPS\Email::template( $app, 'digests__item', 'html', array( $item, $this->mail ) );
|
|
|
|
$added = TRUE;
|
|
++$count;
|
|
}
|
|
catch ( \BadMethodCallException $e ) {}
|
|
catch ( \UnderflowException $e ) {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
else if ( \in_array( 'IPS\Content\Item', $parents ) )
|
|
{
|
|
foreach ( $follows as $follow )
|
|
{
|
|
try
|
|
{
|
|
$item = $class::load( $follow['follow_rel_id'] );
|
|
|
|
/* Check the view permission */
|
|
if( !$item->canView( $this->member ) )
|
|
{
|
|
continue;
|
|
}
|
|
|
|
/* Make sure the item is not archived */
|
|
if ( isset( $item::$archiveClass ) and method_exists( $item, 'isArchived' ) )
|
|
{
|
|
if ( $item->isArchived() )
|
|
{
|
|
continue;
|
|
}
|
|
}
|
|
|
|
/* Force custom profile fields not to be returned, as they can reference templates */
|
|
if( isset( $item::$commentClass ) )
|
|
{
|
|
$commentClass = $item::$commentClass;
|
|
|
|
$commentClass::$joinProfileFields = FALSE;
|
|
}
|
|
|
|
foreach( $item->comments( 5, NULL, 'date', 'asc', NULL, FALSE, \IPS\DateTime::ts( $follow['follow_notify_sent'] ?: $follow['follow_added'] ), NULL, FALSE, FALSE, FALSE ) as $comment )
|
|
{
|
|
|
|
try
|
|
{
|
|
$areaPlainOutput .= \IPS\Email::template( $app, 'digests__comment', 'plaintext', array( $comment, $this->mail ) );
|
|
$areaHtmlOutput .= \IPS\Email::template( $app, 'digests__comment', 'html', array( $comment, $this->mail ) );
|
|
}
|
|
catch ( \UnderflowException $e )
|
|
{
|
|
/* If an app forgot digest templates, we don't want the entire task to fail to ever run again */
|
|
\IPS\Log::debug( $e, 'digestBuild' );
|
|
throw new \OutOfRangeException;
|
|
}
|
|
|
|
$added = TRUE;
|
|
++$count;
|
|
}
|
|
}
|
|
catch( \OutOfRangeException $e )
|
|
{
|
|
}
|
|
}
|
|
}
|
|
|
|
/* Wrapper */
|
|
if( $added )
|
|
{
|
|
$this->output['plain'] .= \IPS\Email::template( 'core', 'digests__areaWrapper', 'plaintext', array( $areaPlainOutput, $app, $key, $max, $count, $this->mail ) );
|
|
$this->output['html'] .= \IPS\Email::template( 'core', 'digests__areaWrapper', 'html', array( $areaHtmlOutput, $app, $key, $max, $count, $this->mail ) );
|
|
|
|
$this->hasContent = TRUE;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Send Digest
|
|
*
|
|
* @return void
|
|
*/
|
|
public function send()
|
|
{
|
|
if( $this->hasContent )
|
|
{
|
|
$this->mail->setUnsubscribe( 'core', 'unsubscribeDigest' );
|
|
$subject = $this->mail->compileSubject( $this->member );
|
|
$htmlContent = str_replace( "___digest___", $this->output['html'], $this->mail->compileContent( 'html', $this->member ) );
|
|
$plaintextContent = str_replace( "___digest___", $this->output['plain'], $this->mail->compileContent( 'plaintext', $this->member ) );
|
|
|
|
\IPS\Email::buildFromContent( $subject, $htmlContent, $plaintextContent, \IPS\Email::TYPE_LIST, \IPS\Email::WRAPPER_NONE, $this->frequency . '_digest' )->send( $this->member );
|
|
}
|
|
|
|
/* After sending digest update core_follows to set notify_sent (don't forget where clause for frequency) */
|
|
\IPS\Db::i()->update( 'core_follow', array( 'follow_notify_sent' => time() ), array( 'follow_member_id=? AND follow_notify_freq=?', $this->member->member_id, $this->frequency ) );
|
|
}
|
|
|
|
/**
|
|
* Process a batch of digests
|
|
*
|
|
* @param string $frequency One of either "daily" or "weekly" to denote the kind of digest to send
|
|
* @param int $numberToSend The number of digests to send for this batch
|
|
* @return bool
|
|
*/
|
|
public static function sendDigestBatch( $frequency='daily', $numberToSend=50 )
|
|
{
|
|
/* Grab some members to send digests to. */
|
|
$members = iterator_to_array( \IPS\Db::i()->select( 'follow_member_id, follow_notify_sent', 'core_follow', array( 'follow_notify_do=1 AND follow_notify_freq = ? AND follow_notify_sent < ?', $frequency, ( $frequency == 'daily' ) ? time() - 86400 : time() - 604800 ), 'follow_notify_sent ASC', array( 0, $numberToSend ), NULL, NULL, \IPS\Db::SELECT_DISTINCT ) );
|
|
|
|
if( !\count( $members ) )
|
|
{
|
|
/* Nothing to send */
|
|
return FALSE;
|
|
}
|
|
|
|
$memberIDs = array();
|
|
foreach( $members as $member )
|
|
{
|
|
$memberIDs[] = $member['follow_member_id'];
|
|
}
|
|
|
|
/* Fetch the member's follows so we can build their digest */
|
|
/* @note SELECT_FROM_WRITE_SERVER: Avoid issue where the follow_notify_sent time below is updated on the writer, but not on the readers on the next task run */
|
|
$follows = \IPS\Db::i()->select( '*', 'core_follow', array( 'follow_notify_do=1 AND follow_notify_freq=? AND follow_notify_sent < ? AND ' . \IPS\Db::i()->in( 'follow_member_id', $memberIDs ), $frequency, ( $frequency == 'daily' ) ? time() - 86400 : time() - 604800 ), NULL, NULL, NULL, NULL, \IPS\Db::SELECT_FROM_WRITE_SERVER );
|
|
|
|
$groupedFollows = array();
|
|
foreach( $follows as $follow )
|
|
{
|
|
$groupedFollows[ $follow['follow_member_id'] ][ $follow['follow_app'] ][ $follow['follow_area'] ][] = $follow;
|
|
}
|
|
|
|
foreach( $groupedFollows as $id => $data )
|
|
{
|
|
$member = \IPS\Member::load( $id );
|
|
if( !$member->email )
|
|
{
|
|
/* Update notification sent time, so the batch doesn't get stuck in a loop */
|
|
\IPS\Db::i()->update( 'core_follow', array( 'follow_notify_sent' => time() ), array( 'follow_member_id=? AND follow_notify_freq=?', $id, $frequency ) );
|
|
continue;
|
|
}
|
|
|
|
/* Build it */
|
|
$digest = new static;
|
|
$digest->member = $member;
|
|
$digest->frequency = $frequency;
|
|
$digest->build( $data );
|
|
|
|
/* Send it */
|
|
$digest->send();
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
} |