Edit File by line

<?php

[0] Fix | Delete

require_once(dirname(__FILE__) . "/../Base/MixpanelBase.php");

[1] Fix | Delete

require_once(dirname(__FILE__) . "/../ConsumerStrategies/FileConsumer.php");

[2] Fix | Delete

require_once(dirname(__FILE__) . "/../ConsumerStrategies/CurlConsumer.php");

[3] Fix | Delete

require_once(dirname(__FILE__) . "/../ConsumerStrategies/SocketConsumer.php");

[4] Fix | Delete

[5] Fix | Delete

if (!function_exists('json_encode')) {

[6] Fix | Delete

throw new Exception('The JSON PHP extension is required.');

[7] Fix | Delete

}

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Provides some base methods for use by a message Producer

[11] Fix | Delete

[12] Fix | Delete

abstract class Producers_MixpanelBaseProducer extends Base_MixpanelBase {

[13] Fix | Delete

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* @var string a token associated to a Mixpanel project

[17] Fix | Delete

[18] Fix | Delete

protected $_token;

[19] Fix | Delete

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* @var array a queue to hold messages in memory before flushing in batches

[23] Fix | Delete

[24] Fix | Delete

private $_queue = array();

[25] Fix | Delete

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* @var ConsumerStrategies_AbstractConsumer the consumer to use when flushing messages

[29] Fix | Delete

[30] Fix | Delete

private $_consumer = null;

[31] Fix | Delete

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* @var array The list of available consumers

[35] Fix | Delete

[36] Fix | Delete

private $_consumers = array(

[37] Fix | Delete

"file" => "ConsumerStrategies_FileConsumer",

[38] Fix | Delete

"curl" => "ConsumerStrategies_CurlConsumer",

[39] Fix | Delete

"socket" => "ConsumerStrategies_SocketConsumer"

[40] Fix | Delete

);

[41] Fix | Delete

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* If the queue reaches this size we'll auto-flush to prevent out of memory errors

[45] Fix | Delete

* @var int

[46] Fix | Delete

[47] Fix | Delete

protected $_max_queue_size = 1000;

[48] Fix | Delete

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Creates a new MixpanelBaseProducer, assings Mixpanel project token, registers custom Consumers, and instantiates

[52] Fix | Delete

* the desired consumer

[53] Fix | Delete

* @param $token

[54] Fix | Delete

* @param array $options

[55] Fix | Delete

[56] Fix | Delete

public function __construct($token, $options = array()) {

[57] Fix | Delete

[58] Fix | Delete

parent::__construct($options);

[59] Fix | Delete

[60] Fix | Delete

// register any customer consumers

[61] Fix | Delete

if (isset($options["consumers"])) {

[62] Fix | Delete

$this->_consumers = array_merge($this->_consumers, $options['consumers']);

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

// set max queue size

[66] Fix | Delete

if (isset($options["max_queue_size"])) {

[67] Fix | Delete

$this->_max_queue_size = $options['max_queue_size'];

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

// associate token

[71] Fix | Delete

$this->_token = $token;

[72] Fix | Delete

[73] Fix | Delete

if ($this->_debug()) {

[74] Fix | Delete

$this->_log("Using token: ".$this->_token);

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

// instantiate the chosen consumer

[78] Fix | Delete

$this->_consumer = $this->_getConsumer();

[79] Fix | Delete

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

[83] Fix | Delete

/**

[84] Fix | Delete

* Flush the queue when we destruct the client with retries

[85] Fix | Delete

[86] Fix | Delete

public function __destruct() {

[87] Fix | Delete

$attempts = 0;

[88] Fix | Delete

$max_attempts = 10;

[89] Fix | Delete

$success = false;

[90] Fix | Delete

while (!$success && $attempts < $max_attempts) {

[91] Fix | Delete

if ($this->_debug()) {

[92] Fix | Delete

$this->_log("destruct flush attempt #".($attempts+1));

[93] Fix | Delete

}

[94] Fix | Delete

$success = $this->flush();

[95] Fix | Delete

$attempts++;

[96] Fix | Delete

}

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Iterate the queue and write in batches using the instantiated Consumer Strategy

[102] Fix | Delete

* @param int $desired_batch_size

[103] Fix | Delete

* @return bool whether or not the flush was successful

[104] Fix | Delete

[105] Fix | Delete

public function flush($desired_batch_size = 50) {

[106] Fix | Delete

$queue_size = count($this->_queue);

[107] Fix | Delete

$succeeded = true;

[108] Fix | Delete

$num_threads = $this->_consumer->getNumThreads();

[109] Fix | Delete

[110] Fix | Delete

if ($this->_debug()) {

[111] Fix | Delete

$this->_log("Flush called - queue size: ".$queue_size);

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

while($queue_size > 0 && $succeeded) {

[115] Fix | Delete

$batch_size = min(array($queue_size, $desired_batch_size*$num_threads, $this->_options['max_batch_size']*$num_threads));

[116] Fix | Delete

$batch = array_splice($this->_queue, 0, $batch_size);

[117] Fix | Delete

$succeeded = $this->_persist($batch);

[118] Fix | Delete

[119] Fix | Delete

if (!$succeeded) {

[120] Fix | Delete

if ($this->_debug()) {

[121] Fix | Delete

$this->_log("Batch consumption failed!");

[122] Fix | Delete

}

[123] Fix | Delete

$this->_queue = array_merge($batch, $this->_queue);

[124] Fix | Delete

[125] Fix | Delete

if ($this->_debug()) {

[126] Fix | Delete

$this->_log("added batch back to queue, queue size is now $queue_size");

[127] Fix | Delete

}

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

$queue_size = count($this->_queue);

[131] Fix | Delete

[132] Fix | Delete

if ($this->_debug()) {

[133] Fix | Delete

$this->_log("Batch of $batch_size consumed, queue size is now $queue_size");

[134] Fix | Delete

}

[135] Fix | Delete

}

[136] Fix | Delete

return $succeeded;

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Empties the queue without persisting any of the messages

[142] Fix | Delete

[143] Fix | Delete

public function reset() {

[144] Fix | Delete

$this->_queue = array();

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Returns the in-memory queue

[150] Fix | Delete

* @return array

[151] Fix | Delete

[152] Fix | Delete

public function getQueue() {

[153] Fix | Delete

return $this->_queue;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

/**

[157] Fix | Delete

* Returns the current Mixpanel project token

[158] Fix | Delete

* @return string

[159] Fix | Delete

[160] Fix | Delete

public function getToken() {

[161] Fix | Delete

return $this->_token;

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Given a strategy type, return a new PersistenceStrategy object

[167] Fix | Delete

* @return ConsumerStrategies_AbstractConsumer

[168] Fix | Delete

[169] Fix | Delete

protected function _getConsumer() {

[170] Fix | Delete

$key = $this->_options['consumer'];

[171] Fix | Delete

$Strategy = $this->_consumers[$key];

[172] Fix | Delete

if ($this->_debug()) {

[173] Fix | Delete

$this->_log("Using consumer: " . $key . " -> " . $Strategy);

[174] Fix | Delete

}

[175] Fix | Delete

$this->_options['endpoint'] = $this->_getEndpoint();

[176] Fix | Delete

[177] Fix | Delete

return new $Strategy($this->_options);

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

[181] Fix | Delete

/**

[182] Fix | Delete

* Add an array representing a message to be sent to Mixpanel to a queue.

[183] Fix | Delete

* @param array $message

[184] Fix | Delete

[185] Fix | Delete

public function enqueue($message = array()) {

[186] Fix | Delete

array_push($this->_queue, $message);

[187] Fix | Delete

[188] Fix | Delete

// force a flush if we've reached our threshold

[189] Fix | Delete

if (count($this->_queue) > $this->_max_queue_size) {

[190] Fix | Delete

$this->flush();

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

if ($this->_debug()) {

[194] Fix | Delete

$this->_log("Queued message: ".json_encode($message));

[195] Fix | Delete

}

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Add an array representing a list of messages to be sent to Mixpanel to a queue.

[201] Fix | Delete

* @param array $messages

[202] Fix | Delete

[203] Fix | Delete

public function enqueueAll($messages = array()) {

[204] Fix | Delete

foreach($messages as $message) {

[205] Fix | Delete

$this->enqueue($message);

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

[211] Fix | Delete

/**

[212] Fix | Delete

* Given an array of messages, persist it with the instantiated Persistence Strategy

[213] Fix | Delete

* @param $message

[214] Fix | Delete

* @return mixed

[215] Fix | Delete

[216] Fix | Delete

protected function _persist($message) {

[217] Fix | Delete

return $this->_consumer->persist($message);

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

[221] Fix | Delete

[222] Fix | Delete

[223] Fix | Delete

/**

[224] Fix | Delete

* Return the endpoint that should be used by a consumer that consumes messages produced by this producer.

[225] Fix | Delete

* @return string

[226] Fix | Delete

[227] Fix | Delete

abstract function _getEndpoint();

[228] Fix | Delete

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete