2012-04-27 15:14:24 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Immutable class to represent an event.
|
|
|
|
* In Echo nomenclature, an event is a single occurrence.
|
|
|
|
* A user's subscriptions determine what Notifications they receive.
|
|
|
|
*/
|
|
|
|
class EchoEvent {
|
|
|
|
protected $id = null;
|
|
|
|
protected $type = null;
|
|
|
|
protected $variant = null;
|
|
|
|
protected $agent = null;
|
2012-05-17 00:29:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var Title
|
|
|
|
*/
|
2012-04-27 15:14:24 +00:00
|
|
|
protected $title = null;
|
|
|
|
protected $extra = null;
|
|
|
|
protected $timestamp = null;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* You should not call the constructor.
|
|
|
|
* Instead use one of the factory functions:
|
2012-08-31 21:50:46 +00:00
|
|
|
* EchoEvent::create To create a new event
|
|
|
|
* EchoEvent::newFromRow To create an event object from a row object
|
|
|
|
* EchoEvent::newFromID To create an event object from the database given its ID
|
2012-04-27 15:14:24 +00:00
|
|
|
*/
|
|
|
|
protected function __construct() {
|
|
|
|
}
|
|
|
|
|
2012-06-06 07:04:28 +00:00
|
|
|
## Save just as the ID
|
|
|
|
function __sleep() {
|
2012-08-31 21:50:46 +00:00
|
|
|
if ( !$this->id ) {
|
2012-08-30 16:04:39 +00:00
|
|
|
throw new MWException( "Unable to serialize an uninitialized EchoEvent" );
|
2012-06-06 07:04:28 +00:00
|
|
|
}
|
2012-08-30 16:04:39 +00:00
|
|
|
return array( 'id' );
|
2012-06-06 07:04:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
function __wakeup() {
|
|
|
|
$this->loadFromID( $this->id );
|
|
|
|
}
|
|
|
|
|
|
|
|
function __toString() {
|
|
|
|
return "EchoEvent(id={$this->id}; type={$this->type})";
|
|
|
|
}
|
|
|
|
|
2012-04-27 15:14:24 +00:00
|
|
|
/**
|
|
|
|
* Creates an EchoEvent object
|
|
|
|
* @param $info Named arguments:
|
|
|
|
* type (required): The event type;
|
|
|
|
* variant: A variant of the type;
|
|
|
|
* agent: The user who caused the event;
|
|
|
|
* title: The page on which the event was triggered;
|
|
|
|
* extra: Event-specific extra information (e.g. post content)
|
|
|
|
*
|
|
|
|
* @return The created EchoEvent.
|
|
|
|
*/
|
|
|
|
public static function create( $info = array() ) {
|
|
|
|
$obj = new EchoEvent;
|
|
|
|
static $validFields = array( 'type', 'variant', 'agent', 'title', 'extra' );
|
|
|
|
|
2012-08-01 19:53:05 +00:00
|
|
|
if ( empty( $info['type'] ) ) {
|
2012-04-27 15:14:24 +00:00
|
|
|
throw new MWException( "'type' parameter is mandatory" );
|
|
|
|
}
|
|
|
|
|
2012-08-01 18:20:21 +00:00
|
|
|
global $wgEchoEnabledEvents;
|
|
|
|
|
|
|
|
if (
|
|
|
|
$wgEchoEnabledEvents !== false &&
|
2012-08-31 21:50:46 +00:00
|
|
|
!in_array( $info['type'], $wgEchoEnabledEvents )
|
2012-08-01 18:20:21 +00:00
|
|
|
) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2012-04-27 15:14:24 +00:00
|
|
|
$obj->id = false;
|
|
|
|
$obj->timestamp = wfTimestampNow();
|
|
|
|
|
2012-08-31 21:50:46 +00:00
|
|
|
foreach ( $validFields as $field ) {
|
2012-08-30 16:04:39 +00:00
|
|
|
if ( isset( $info[$field] ) ) {
|
2012-04-27 15:14:24 +00:00
|
|
|
$obj->$field = $info[$field];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-08-31 21:50:46 +00:00
|
|
|
if ( $obj->title && !$obj->title instanceof Title ) {
|
2012-04-27 15:14:24 +00:00
|
|
|
throw new MWException( "Invalid title parameter" );
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( $obj->agent && !
|
2012-08-31 21:50:46 +00:00
|
|
|
( $obj->agent instanceof User ||
|
2012-08-30 16:04:39 +00:00
|
|
|
$obj->agent instanceof StubObject )
|
2012-04-27 15:14:24 +00:00
|
|
|
) {
|
|
|
|
throw new MWException( "Invalid user parameter" );
|
|
|
|
}
|
|
|
|
|
|
|
|
$obj->insert();
|
|
|
|
EchoNotificationController::notify( $obj );
|
|
|
|
|
|
|
|
return $obj;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Inserts the object into the database.
|
|
|
|
*/
|
|
|
|
protected function insert() {
|
|
|
|
$dbw = wfGetDB( DB_MASTER );
|
|
|
|
|
|
|
|
if ( $this->id ) {
|
|
|
|
throw new MWException( "Attempt to insert() an existing event" );
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->id = $dbw->nextSequenceValue( 'echo_event_id' );
|
|
|
|
|
|
|
|
$row = array(
|
|
|
|
'event_id' => $this->id,
|
|
|
|
'event_timestamp' => $dbw->timestamp( $this->timestamp ),
|
|
|
|
'event_type' => $this->type,
|
|
|
|
'event_variant' => $this->variant,
|
|
|
|
);
|
|
|
|
|
2012-08-30 16:04:39 +00:00
|
|
|
if ( is_array( $this->extra ) || is_object( $this->extra ) ) {
|
|
|
|
$row['event_extra'] = serialize( $this->extra );
|
|
|
|
} elseif ( is_null( $this->extra ) ) {
|
2012-04-27 15:14:24 +00:00
|
|
|
$row['event_extra'] = null;
|
|
|
|
} else {
|
2012-08-30 16:04:39 +00:00
|
|
|
$row['event_extra'] = serialize( array( $this->extra ) );
|
2012-04-27 15:14:24 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if ( $this->agent ) {
|
|
|
|
if ( $this->agent->isAnon() ) {
|
|
|
|
$row['event_agent_ip'] = $this->agent->getName();
|
|
|
|
} else {
|
|
|
|
$row['event_agent_id'] = $this->agent->getId();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( $this->title ) {
|
|
|
|
$row['event_page_namespace'] = $this->title->getNamespace();
|
|
|
|
$row['event_page_title'] = $this->title->getDBkey();
|
|
|
|
}
|
|
|
|
|
|
|
|
$dbw->insert( 'echo_event', $row, __METHOD__ );
|
|
|
|
|
2012-08-31 21:50:46 +00:00
|
|
|
if ( !$this->id ) {
|
2012-04-27 15:14:24 +00:00
|
|
|
$this->id = $dbw->insertId();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-06-06 07:04:28 +00:00
|
|
|
* Loads data from the provided $row into this object.
|
2012-04-27 15:14:24 +00:00
|
|
|
*
|
|
|
|
* @param $row Database row object from echo_event
|
|
|
|
*/
|
2012-08-30 16:04:39 +00:00
|
|
|
public function loadFromRow( $row ) {
|
2012-06-06 07:04:28 +00:00
|
|
|
$this->id = $row->event_id;
|
|
|
|
$this->timestamp = $row->event_timestamp;
|
|
|
|
$this->type = $row->event_type;
|
|
|
|
$this->variant = $row->event_variant;
|
2012-08-30 16:04:39 +00:00
|
|
|
$this->extra = $row->event_extra ? unserialize( $row->event_extra ) : null;
|
2012-04-27 15:14:24 +00:00
|
|
|
|
|
|
|
if ( $row->event_agent_id ) {
|
2012-06-06 07:04:28 +00:00
|
|
|
$this->agent = User::newFromID( $row->event_agent_id );
|
2012-04-27 15:14:24 +00:00
|
|
|
} elseif ( $row->event_agent_ip ) {
|
2012-06-06 07:04:28 +00:00
|
|
|
$this->agent = User::newFromName( $row->event_agent_ip, false );
|
2012-04-27 15:14:24 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if ( $row->event_page_title !== null ) {
|
2012-06-06 07:04:28 +00:00
|
|
|
$this->title = Title::makeTitleSafe(
|
2012-04-27 15:14:24 +00:00
|
|
|
$row->event_page_namespace,
|
|
|
|
$row->event_page_title
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-06-06 07:04:28 +00:00
|
|
|
* Loads data from the database into this object, given the event ID.
|
|
|
|
* @param $id Event ID
|
2012-04-27 15:14:24 +00:00
|
|
|
*/
|
2012-08-02 19:50:46 +00:00
|
|
|
public function loadFromID( $id, $fromMaster = false ) {
|
|
|
|
$db = wfGetDB( $fromMaster ? DB_MASTER : DB_SLAVE );
|
2012-04-27 15:14:24 +00:00
|
|
|
|
2012-08-30 16:04:39 +00:00
|
|
|
$row = $db->selectRow( 'echo_event', '*', array( 'event_id' => $id ), __METHOD__ );
|
2012-04-27 15:14:24 +00:00
|
|
|
|
2012-08-31 21:50:46 +00:00
|
|
|
if ( !$row && !$fromMaster ) {
|
2012-08-02 19:50:46 +00:00
|
|
|
$this->loadFromID( $id, true );
|
2012-08-31 21:50:46 +00:00
|
|
|
} elseif ( !$row ) {
|
|
|
|
throw new MWException( "No EchoEvent found with ID: $id" );
|
2012-04-27 15:14:24 +00:00
|
|
|
}
|
|
|
|
|
2012-06-06 07:04:28 +00:00
|
|
|
$this->loadFromRow( $row );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates an EchoEvent from a row object
|
|
|
|
*
|
|
|
|
* @param $row Database row object from echo_event
|
|
|
|
* @return EchoEvent object.
|
|
|
|
*/
|
2012-08-30 16:04:39 +00:00
|
|
|
public static function newFromRow( $row ) {
|
2012-06-06 07:04:28 +00:00
|
|
|
$obj = new EchoEvent();
|
|
|
|
$obj->loadFromRow( $row );
|
|
|
|
return $obj;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates an EchoEvent from the database by ID
|
|
|
|
*
|
|
|
|
* @param $id Event ID
|
|
|
|
* @return EchoEvent object
|
|
|
|
*/
|
|
|
|
public static function newFromID( $id ) {
|
|
|
|
$obj = new EchoEvent();
|
|
|
|
$obj->loadFromID( $id );
|
|
|
|
return $obj;
|
2012-04-27 15:14:24 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
## Accessors
|
|
|
|
public function getId() {
|
|
|
|
return $this->id;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getTimestamp() {
|
|
|
|
return $this->timestamp;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getType() {
|
|
|
|
return $this->type;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getVariant() {
|
|
|
|
return $this->variant;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getExtra() {
|
|
|
|
return $this->extra;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getAgent() {
|
|
|
|
return $this->agent;
|
|
|
|
}
|
|
|
|
|
2012-05-17 00:29:37 +00:00
|
|
|
/**
|
|
|
|
* @return Title
|
|
|
|
*/
|
2012-04-27 15:14:24 +00:00
|
|
|
public function getTitle() {
|
|
|
|
return $this->title;
|
|
|
|
}
|
2012-08-30 16:04:39 +00:00
|
|
|
}
|