repo stringlengths 7 63 | file_url stringlengths 81 284 | file_path stringlengths 5 200 | content stringlengths 0 32.8k | language stringclasses 1
value | license stringclasses 7
values | commit_sha stringlengths 40 40 | retrieved_at stringdate 2026-01-04 15:02:33 2026-01-05 05:24:06 | truncated bool 2
classes |
|---|---|---|---|---|---|---|---|---|
mariano/disque-php | https://github.com/mariano/disque-php/blob/56cf00d97e739fec861717484657dbef2888df60/tests/Command/Response/IntResponseTest.php | tests/Command/Response/IntResponseTest.php | <?php
namespace Disque\Test\Command\Response;
use PHPUnit_Framework_TestCase;
use Disque\Command\Hello;
use Disque\Command\Response\ResponseInterface;
use Disque\Command\Response\IntResponse;
use Disque\Command\Response\InvalidResponseException;
class IntResponseTest extends PHPUnit_Framework_TestCase
{
public function testInstance()
{
$r = new IntResponse();
$this->assertInstanceOf(ResponseInterface::class, $r);
}
public function testInvalidBodyNotNumericString()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: "test"');
$r = new IntResponse();
$r->setCommand(new Hello());
$r->setBody('test');
}
public function testInvalidBodyNotNumericArray()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["test"]');
$r = new IntResponse();
$r->setCommand(new Hello());
$r->setBody(['test']);
}
public function testParse()
{
$r = new IntResponse();
$r->setCommand(new Hello());
$r->setBody(128);
$result = $r->parse();
$this->assertSame(128, $result);
}
} | php | MIT | 56cf00d97e739fec861717484657dbef2888df60 | 2026-01-05T05:12:23.969054Z | false |
mariano/disque-php | https://github.com/mariano/disque-php/blob/56cf00d97e739fec861717484657dbef2888df60/tests/Command/Response/JobsWithCountersResponseTest.php | tests/Command/Response/JobsWithCountersResponseTest.php | <?php
namespace Disque\Test\Command\Response;
use PHPUnit_Framework_TestCase;
use Disque\Command\Hello;
use Disque\Command\Response\ResponseInterface;
use Disque\Command\Response\JobsWithCountersResponse;
use Disque\Command\Response\InvalidResponseException;
use Disque\Command\Response\JobsResponse AS Response;
use Disque\Command\Response\JobsWithQueueResponse AS Queue;
use Disque\Command\Response\JobsWithCountersResponse AS Counters;
class JobsWithCountersResponseTest extends PHPUnit_Framework_TestCase
{
public function testInstance()
{
$r = new JobsWithCountersResponse();
$this->assertInstanceOf(ResponseInterface::class, $r);
}
public function testInvalidBodyNotArrayString()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: "test"');
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$r->setBody('test');
}
public function testInvalidBodyNotArrayNumeric()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: 128');
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$r->setBody(128);
}
public function testInvalidBodyNotEnoughElementsInJob()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [["id","body"]]');
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$r->setBody([['id','body']]);
}
public function testInvalidBodyTooManyElementsInJob()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [["queue","id","body","test"]]');
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$r->setBody([['queue', 'id', 'body', 'test']]);
}
public function testParseInvalidArrayElementsNon0()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [{"1":"test","2":"stuff","3":"more"}]');
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$r->setBody([[1=>'test', 2=>'stuff', 3=>'more']]);
}
public function testParseInvalidArrayElementsNon1()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [{"0":"test","2":"stuff","3":"more"}]');
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$r->setBody([[0=>'test', 2=>'stuff', 3=>'more']]);
}
public function testParseInvalidArrayElementsNon2()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [{"0":"test","1":"stuff","3":"more"}]');
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$r->setBody([[0=>'test', 1=>'stuff', 3=>'more']]);
}
public function testInvalidBodyInvalidJobIDPrefix()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [["queue","XX01234567890","body"]]');
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$r->setBody([['queue', 'XX01234567890', 'body']]);
}
public function testInvalidBodyInvalidJobIDLength()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [["queue","D-012345","body"]]');
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$r->setBody([['queue', 'D-012345', 'body']]);
}
public function testParseNoJob()
{
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$r->setBody(null);
$result = $r->parse();
$this->assertSame([], $result);
}
public function testParseOneJob()
{
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$queue = 'q';
$id = 'D-0f0c644fd3ccb51c2cedbd47fcb6f312646c993c05a0SQ';
$body = 'lorem ipsum';
$nacks = 1;
$ad = 2;
$response = [$queue, $id, $body, 'nacks', $nacks, 'additional-deliveries', $ad];
$r->setBody([$response]);
$parsedResponse = $r->parse();
$this->assertSame([
[
Queue::KEY_QUEUE => $queue,
Response::KEY_ID => $id,
Response::KEY_BODY => $body,
Counters::KEY_NACKS => $nacks,
Counters::KEY_ADDITIONAL_DELIVERIES => $ad
]
], $parsedResponse);
}
public function testParseTwoJobs()
{
$r = new JobsWithCountersResponse();
$r->setCommand(new Hello());
$queue1 = 'q1';
$id1 = 'D-0f0c644fd3ccb51c2cedbd47fcb6f312646c993c05a0SQ';
$body1 = 'lorem ipsum';
$nacks1 = 1;
$ad1 = 2;
$queue2 = 'q2';
$id2 = 'D-0f0c644fd3ccb51c2cedbd47fcb6f312646c993c05a0SQ';
$body2 = 'dolor sit amet';
$nacks2 = 3;
$ad2 = 4;
$response = [
[$queue1, $id1, $body1, 'nacks', $nacks1, 'additional-deliveries', $ad1],
[$queue2, $id2, $body2, 'nacks', $nacks2, 'additional-deliveries', $ad2],
];
$r->setBody($response);
$parsedResponse = $r->parse();
$this->assertSame([
[
Queue::KEY_QUEUE => $queue1,
Response::KEY_ID => $id1,
Response::KEY_BODY => $body1,
Counters::KEY_NACKS => $nacks1,
Counters::KEY_ADDITIONAL_DELIVERIES => $ad1
],
[
Queue::KEY_QUEUE => $queue2,
Response::KEY_ID => $id2,
Response::KEY_BODY => $body2,
Counters::KEY_NACKS => $nacks2,
Counters::KEY_ADDITIONAL_DELIVERIES => $ad2
]
], $parsedResponse);
}
} | php | MIT | 56cf00d97e739fec861717484657dbef2888df60 | 2026-01-05T05:12:23.969054Z | false |
mariano/disque-php | https://github.com/mariano/disque-php/blob/56cf00d97e739fec861717484657dbef2888df60/tests/Command/Response/KeyValueResponseTest.php | tests/Command/Response/KeyValueResponseTest.php | <?php
namespace Disque\Test\Command\Response;
use PHPUnit_Framework_TestCase;
use Disque\Command\Hello;
use Disque\Command\Response\ResponseInterface;
use Disque\Command\Response\KeyValueResponse;
use Disque\Command\Response\InvalidResponseException;
class KeyValueResponseTest extends PHPUnit_Framework_TestCase
{
public function testInstance()
{
$r = new KeyValueResponse();
$this->assertInstanceOf(ResponseInterface::class, $r);
}
public function testInvalidBodyNotArrayString()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: "test"');
$r = new KeyValueResponse();
$r->setCommand(new Hello());
$r->setBody('test');
}
public function testInvalidBodyNotArrayNumeric()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: 128');
$r = new KeyValueResponse();
$r->setCommand(new Hello());
$r->setBody(128);
}
public function testInvalidBodyNotEnoughElements()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: []');
$r = new KeyValueResponse();
$r->setCommand(new Hello());
$r->setBody([]);
}
public function testInvalidBodyOddElements()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["test"]');
$r = new KeyValueResponse();
$r->setCommand(new Hello());
$r->setBody(['test']);
}
public function testInvalidBodyOddMoreElements()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["test","stuff","element"]');
$r = new KeyValueResponse();
$r->setCommand(new Hello());
$r->setBody(['test', 'stuff', 'element']);
}
public function testParseFalse()
{
$r = new KeyValueResponse();
$r->setCommand(new Hello());
$r->setBody(false);
$result = $r->parse();
$this->assertNull($result);
}
public function testParse()
{
$r = new KeyValueResponse();
$r->setCommand(new Hello());
$r->setBody(['k1', 'v1', 'k2', 'v2']);
$result = $r->parse();
$this->assertSame([
'k1' => 'v1',
'k2' => 'v2'
], $result);
}
} | php | MIT | 56cf00d97e739fec861717484657dbef2888df60 | 2026-01-05T05:12:23.969054Z | false |
mariano/disque-php | https://github.com/mariano/disque-php/blob/56cf00d97e739fec861717484657dbef2888df60/tests/Command/Response/StringResponseTest.php | tests/Command/Response/StringResponseTest.php | <?php
namespace Disque\Test\Command\Response;
use PHPUnit_Framework_TestCase;
use Disque\Command\Hello;
use Disque\Command\Response\ResponseInterface;
use Disque\Command\Response\StringResponse;
use Disque\Command\Response\InvalidResponseException;
class StringResponseTest extends PHPUnit_Framework_TestCase
{
public function testInstance()
{
$r = new StringResponse();
$this->assertInstanceOf(ResponseInterface::class, $r);
}
public function testInvalidBodyNotStringArray()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["test"]');
$r = new StringResponse();
$r->setCommand(new Hello());
$r->setBody(['test']);
}
public function testInvalidBodyNotStringNumeric()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: 128');
$r = new StringResponse();
$r->setCommand(new Hello());
$r->setBody(128);
}
public function testParse()
{
$r = new StringResponse();
$r->setCommand(new Hello());
$r->setBody('test');
$result = $r->parse();
$this->assertSame('test', $result);
}
} | php | MIT | 56cf00d97e739fec861717484657dbef2888df60 | 2026-01-05T05:12:23.969054Z | false |
mariano/disque-php | https://github.com/mariano/disque-php/blob/56cf00d97e739fec861717484657dbef2888df60/tests/Command/Response/HelloResponseTest.php | tests/Command/Response/HelloResponseTest.php | <?php
namespace Disque\Test\Command\Response;
use PHPUnit_Framework_TestCase;
use Disque\Command\Hello;
use Disque\Command\Response\ResponseInterface;
use Disque\Command\Response\HelloResponse;
use Disque\Command\Response\InvalidResponseException;
class HelloResponseTest extends PHPUnit_Framework_TestCase
{
public function testInstance()
{
$r = new HelloResponse();
$this->assertInstanceOf(ResponseInterface::class, $r);
}
public function testInvalidBodyNotArrayString()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: "test"');
$r = new HelloResponse();
$r->setCommand(new Hello());
$r->setBody('test');
}
public function testInvalidBodyNotArrayNumeric()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: 128');
$r = new HelloResponse();
$r->setCommand(new Hello());
$r->setBody(128);
}
public function testInvalidBodyNotEnoughElements()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["test","stuff"]');
$r = new HelloResponse();
$r->setCommand(new Hello());
$r->setBody(['test','stuff']);
}
public function testInvalidBodyNotEnoughElementsInNode()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["version","id",["id","host","port"]]');
$r = new HelloResponse();
$r->setCommand(new Hello());
$r->setBody(['version', 'id', ['id', 'host', 'port']]);
}
public function testInvalidBodyTooManyElementsInNode()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["version","id",["id","host","port","version","stuff"]]');
$r = new HelloResponse();
$r->setCommand(new Hello());
$r->setBody(['version', 'id', ['id', 'host', 'port', 'version', 'stuff']]);
}
public function testParseOneNode()
{
$r = new HelloResponse();
$r->setCommand(new Hello());
$r->setBody(['version', 'id', ['id', 'host', 'port', 'priority']]);
$result = $r->parse();
$this->assertSame([
'version' => 'version',
'id' => 'id',
'nodes' => [
[
'id' => 'id',
'host' => 'host',
'port' => 'port',
'priority' => 'priority'
]
]
], $result);
}
public function testParseTwoNodes()
{
$r = new HelloResponse();
$r->setCommand(new Hello());
$r->setBody([
'version',
'id',
['id', 'host', 'port', '1'],
['id2', 'host2', 'port2', '2'],
]);
$result = $r->parse();
$this->assertSame([
'version' => 'version',
'id' => 'id',
'nodes' => [
[
'id' => 'id',
'host' => 'host',
'port' => 'port',
'priority' => '1'
],
[
'id' => 'id2',
'host' => 'host2',
'port' => 'port2',
'priority' => '2'
]
]
], $result);
}
} | php | MIT | 56cf00d97e739fec861717484657dbef2888df60 | 2026-01-05T05:12:23.969054Z | false |
mariano/disque-php | https://github.com/mariano/disque-php/blob/56cf00d97e739fec861717484657dbef2888df60/tests/Command/Response/QscanResponseTest.php | tests/Command/Response/QscanResponseTest.php | <?php
namespace Disque\Test\Command\Response;
use PHPUnit_Framework_TestCase;
use Disque\Command\Hello;
use Disque\Command\Response\ResponseInterface;
use Disque\Command\Response\QscanResponse;
use Disque\Command\Response\InvalidResponseException;
class QscanResponseTest extends PHPUnit_Framework_TestCase
{
public function testInstance()
{
$r = new QscanResponse();
$this->assertInstanceOf(ResponseInterface::class, $r);
}
public function testInvalidBodyNotArrayString()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: "test"');
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody('test');
}
public function testInvalidBodyNotArrayNumeric()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: 128');
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody(128);
}
public function testInvalidBodyElementsNotEnough()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["10"]');
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody(['10']);
}
public function testInvalidBodyElementsTooMany()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["10",["queue1"],"test"]');
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody(['10', ['queue1'], 'test']);
}
public function testInvalidBodyElements0NotSet()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: {"9":"10","1":["queue1"]}');
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody([9=>'10', 1=>['queue1']]);
}
public function testInvalidBodyElements1NotSet()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: {"0":"10","2":["queue1"]}');
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody([0=>'10', 2=>['queue1']]);
}
public function testInvalidBodyElement1NotNumeric()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["test",["queue1"]]');
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody(['test', ['queue1']]);
}
public function testInvalidBodyElement2NotArray()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["test","queue1"]');
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody(['test', 'queue1']);
}
public function testParseNoValues()
{
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody(['0', []]);
$result = $r->parse();
$this->assertSame([
'finished' => true,
'nextCursor' => 0,
'queues' => [
]
], $result);
}
public function testParseOneValue()
{
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody(['0', ['queue1']]);
$result = $r->parse();
$this->assertSame([
'finished' => true,
'nextCursor' => 0,
'queues' => [
'queue1'
]
], $result);
}
public function testParseSeveralValues()
{
$r = new QscanResponse();
$r->setCommand(new Hello());
$r->setBody(['1', ['queue1', 'queue2']]);
$result = $r->parse();
$this->assertSame([
'finished' => false,
'nextCursor' => 1,
'queues' => [
'queue1',
'queue2'
]
], $result);
}
} | php | MIT | 56cf00d97e739fec861717484657dbef2888df60 | 2026-01-05T05:12:23.969054Z | false |
mariano/disque-php | https://github.com/mariano/disque-php/blob/56cf00d97e739fec861717484657dbef2888df60/tests/Command/Response/JobsResponseTest.php | tests/Command/Response/JobsResponseTest.php | <?php
namespace Disque\Test\Command\Response;
use PHPUnit_Framework_TestCase;
use Disque\Command\Hello;
use Disque\Command\Response\ResponseInterface;
use Disque\Command\Response\JobsResponse;
use Disque\Command\Response\InvalidResponseException;
class JobsResponseTest extends PHPUnit_Framework_TestCase
{
public function testInstance()
{
$r = new JobsResponse();
$this->assertInstanceOf(ResponseInterface::class, $r);
}
public function testInvalidBodyNotArrayString()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: "test"');
$r = new JobsResponse();
$r->setCommand(new Hello());
$r->setBody('test');
}
public function testInvalidBodyNotArrayNumeric()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: 128');
$r = new JobsResponse();
$r->setCommand(new Hello());
$r->setBody(128);
}
public function testInvalidBodyElementsNotArray()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: ["test"]');
$r = new JobsResponse();
$r->setCommand(new Hello());
$r->setBody(['test']);
}
public function testInvalidBodyNotEnoughElementsInJob()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [["test"]]');
$r = new JobsResponse();
$r->setCommand(new Hello());
$r->setBody([['test']]);
}
public function testInvalidBodyTooManyElementsInJob()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [["id","body","test"]]');
$r = new JobsResponse();
$r->setCommand(new Hello());
$r->setBody([['id', 'body', 'test']]);
}
public function testInvalidBodyInvalidJobIDPrefix()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [["XX01234567890","body"]]');
$r = new JobsResponse();
$r->setCommand(new Hello());
$r->setBody([['XX01234567890', 'body']]);
}
public function testInvalidBodyInvalidJobIDLength()
{
$this->setExpectedException(InvalidResponseException::class, 'Invalid command response. Command Disque\\Command\\Hello got: [["D-012345","body"]]');
$r = new JobsResponse();
$r->setCommand(new Hello());
$r->setBody([['D-012345', 'body']]);
}
public function testParseNoJob()
{
$r = new JobsResponse();
$r->setCommand(new Hello());
$r->setBody(null);
$result = $r->parse();
$this->assertSame([], $result);
}
public function testParseOneJob()
{
$r = new JobsResponse();
$r->setCommand(new Hello());
$r->setBody([['D-0f0c644fd3ccb51c2cedbd47fcb6f312646c993c05a0SQ', 'body']]);
$result = $r->parse();
$this->assertSame([
[
'id' => 'D-0f0c644fd3ccb51c2cedbd47fcb6f312646c993c05a0SQ',
'body' => 'body'
]
], $result);
}
public function testParseTwoJobs()
{
$r = new JobsResponse();
$r->setCommand(new Hello());
$r->setBody([
['D-0f0c644fd3ccb51c2cedbd47fcb6f312646c993c05a0SQ', 'body'],
['D-0f0c644fd3ccb51c2cedbd47fcb6f312646c993c05a1SQ', 'body2']
]);
$result = $r->parse();
$this->assertSame([
[
'id' => 'D-0f0c644fd3ccb51c2cedbd47fcb6f312646c993c05a0SQ',
'body' => 'body'
],
[
'id' => 'D-0f0c644fd3ccb51c2cedbd47fcb6f312646c993c05a1SQ',
'body' => 'body2'
],
], $result);
}
} | php | MIT | 56cf00d97e739fec861717484657dbef2888df60 | 2026-01-05T05:12:23.969054Z | false |
sschiau/Particle | https://github.com/sschiau/Particle/blob/f1641eba26dfef60c8566a582325a3680d5ea3ba/Sources/Particle.php | Sources/Particle.php | <?php
/**
* @author Silviu Schiau <pr@silviu.co>
* @package Schiau
* @version 3.0
* @license Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Copyright 2014-2025 Silviu Schiau.
*
* This copyright notice
* shall be included in all copies or substantial portions of the software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
*/
declare(strict_types=1);
namespace Schiau\Utilities;
final class Particle
{
// Same constants as your original code
private const EPOCH = 1763632028001;
private const MAX_12BIT = 4095;
private const MAX_41BIT = 1099511627775;
private static ?int $machineId = null;
/**
* Configure machine id in range 0..1023
*/
public static function machineId(int $machineId): void
{
if (PHP_INT_SIZE < 8) {
throw new \RuntimeException('Particle requires 64 bit PHP');
}
if ($machineId < 0 || $machineId > 1023) {
throw new \InvalidArgumentException('machineId must be between 0 and 1023');
}
self::$machineId = $machineId;
}
/**
* Generate id
*/
public static function generateParticle(): int
{
if (self::$machineId === null) {
throw new \LogicException('machineId must be set before use');
}
// Time in milliseconds
$time = (int) floor(microtime(true) * 1000);
// Subtract custom epoch
$time -= self::EPOCH;
if ($time < 0) {
throw new \RuntimeException('Current time is before custom epoch');
}
// Create a base
$base = decbin(self::MAX_41BIT + $time);
// Create machineId - 10 bits - up to 1024 machines
$machineBits = str_pad(
decbin(self::$machineId),
10,
'0',
STR_PAD_LEFT
);
// Sequence number - 12 bits - up to 4096 random numbers per machine
$sequenceBits = str_pad(
decbin(random_int(0, self::MAX_12BIT)),
12,
'0',
STR_PAD_LEFT
);
// Pack
$binary = $base . $machineBits . $sequenceBits;
// Return time
return bindec($binary);
}
/**
* Extract time in milliseconds from id
*/
public static function timeFromParticle(int $particle): int
{
$binary = decbin($particle);
$timeBits = substr($binary, 0, 41);
if ($timeBits === '' || strlen($timeBits) !== 41) {
throw new \InvalidArgumentException('Invalid particle id');
}
$value = bindec($timeBits);
return $value - self::MAX_41BIT + self::EPOCH;
}
}
?>
| php | MIT | f1641eba26dfef60c8566a582325a3680d5ea3ba | 2026-01-05T05:12:44.671861Z | false |
sschiau/Particle | https://github.com/sschiau/Particle/blob/f1641eba26dfef60c8566a582325a3680d5ea3ba/Demo/index.php | Demo/index.php | <?php
/**
* @author Silviu Schiau <pr@silviu.co>
* @package Schiau
* @version 2.2.2
* @license Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Copyright 2014-2017 Silviu Schiau.
*
* This copyright notice
* shall be included in all copies or substantial portions of the software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
*/
require __DIR__ . '/../vendor/autoload.php';
use Schiau\Utilities\Particle;
Particle::machineId(0);
$id = Particle::generateParticle();
var_dump('Particle ID: ' . $id);
var_dump('Time UNIX: ' . Particle::timeFromParticle($id));
?>
| php | MIT | f1641eba26dfef60c8566a582325a3680d5ea3ba | 2026-01-05T05:12:44.671861Z | false |
sschiau/Particle | https://github.com/sschiau/Particle/blob/f1641eba26dfef60c8566a582325a3680d5ea3ba/Tests/ParticleTest.php | Tests/ParticleTest.php | <?php
/**
* @author Silviu Schiau <pr@silviu.co>
* @package Schiau
* @version 2.3.0
* @license Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Copyright 2014-2017 Silviu Schiau.
*
* This copyright notice
* shall be included in all copies or substantial portions of the software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
*/
use PHPUnit\Framework\TestCase;
use Schiau\Utilities\Particle;
class ParticleTest extends TestCase
{
protected function setUp(): void
{
Particle::machineId(0);
}
public function testParticleLength(): void
{
$id = Particle::generateParticle();
$this->assertSame(19, strlen((string) $id));
}
public function testTimeLengthFromParticle(): void
{
$id = Particle::generateParticle();
$time = Particle::timeFromParticle($id);
$this->assertSame(13, strlen((string) $time));
}
}
?>
| php | MIT | f1641eba26dfef60c8566a582325a3680d5ea3ba | 2026-01-05T05:12:44.671861Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/src/GelfLoggerFactory.php | src/GelfLoggerFactory.php | <?php
namespace Hedii\LaravelGelfLogger;
use Gelf\Publisher;
use Gelf\Transport\AbstractTransport;
use Gelf\Transport\HttpTransport;
use Gelf\Transport\IgnoreErrorTransportWrapper;
use Gelf\Transport\SslOptions;
use Gelf\Transport\TcpTransport;
use Gelf\Transport\UdpTransport;
use Illuminate\Contracts\Container\Container;
use Illuminate\Log\ParsesLogConfiguration;
use Monolog\Formatter\GelfMessageFormatter;
use Monolog\Handler\GelfHandler;
use Monolog\Logger;
class GelfLoggerFactory
{
use ParsesLogConfiguration;
public function __construct(protected Container $app)
{
}
public function __invoke(array $config): Logger
{
$config = $this->parseConfig($config);
$transport = $this->getTransport(
$config['transport'],
$config['host'],
$config['port'],
$config['chunk_size'],
$config['path'],
$this->enableSsl($config) ? $this->sslOptions($config['ssl_options']) : null
);
if ($this->enableBasicAuthentication($transport, $config)) {
/** @var HttpTransport $transport */
$transport->setAuthentication(
$config['http_basic_auth']['username'],
$config['http_basic_auth']['password'],
);
}
if ($config['ignore_error']) {
$transport = new IgnoreErrorTransportWrapper($transport);
}
$handler = new GelfHandler(new Publisher($transport), $this->level($config));
$handler->setFormatter(
new GelfMessageFormatter(
$config['system_name'],
$config['extra_prefix'],
$config['context_prefix'],
$config['max_length']
)
);
foreach ($this->parseProcessors($config) as $processor) {
$handler->pushProcessor(new $processor);
}
return new Logger($this->parseChannel($config), [$handler]);
}
protected function parseConfig(array $config): array
{
$config['transport'] ??= 'udp';
$config['host'] ??= '127.0.0.1';
$config['port'] ??= 12201;
$config['chunk_size'] ??= UdpTransport::CHUNK_SIZE_WAN;
$config['path'] ??= null;
$config['system_name'] ??= null;
$config['extra_prefix'] ??= null;
$config['context_prefix'] ??= '';
$config['max_length'] ??= null;
$config['ignore_error'] ??= true;
$config['ssl'] ??= false;
$config['ssl_options'] ??= null;
$config['http_basic_auth'] ??= null;
if ($config['ssl_options']) {
$config['ssl_options']['verify_peer'] ??= true;
$config['ssl_options']['ca_file'] ??= null;
$config['ssl_options']['ciphers'] ??= null;
$config['ssl_options']['allow_self_signed'] ??= false;
}
if ($config['http_basic_auth']) {
$config['http_basic_auth']['username'] ??= null;
$config['http_basic_auth']['password'] ??= null;
}
return $config;
}
protected function getTransport(
string $transport,
string $host,
int $port,
int $chunkSize,
?string $path = null,
?SslOptions $sslOptions = null
): AbstractTransport {
return match (strtolower($transport)) {
'tcp' => new TcpTransport($host, $port, $sslOptions),
'http' => $path
? new HttpTransport($host, $port, $path, $sslOptions)
: new HttpTransport($host, $port, sslOptions: $sslOptions),
default => new UdpTransport($host, $port, $chunkSize),
};
}
protected function enableSsl(array $config): bool
{
if (! isset($config['transport']) || $config['transport'] === 'udp') {
return false;
}
return $config['ssl'];
}
protected function sslOptions(?array $sslConfig = null): SslOptions
{
$sslOptions = new SslOptions();
if (! $sslConfig) {
return $sslOptions;
}
$sslOptions->setVerifyPeer($sslConfig['verify_peer']);
$sslOptions->setCaFile($sslConfig['ca_file']);
$sslOptions->setCiphers($sslConfig['ciphers']);
$sslOptions->setAllowSelfSigned($sslConfig['allow_self_signed']);
return $sslOptions;
}
protected function enableBasicAuthentication(AbstractTransport $transport, array $config): bool
{
return $transport instanceof HttpTransport
&& $config['http_basic_auth']
&& $config['http_basic_auth']['username']
&& $config['http_basic_auth']['password'];
}
protected function parseProcessors(array $config): array
{
$processors = [];
if (isset($config['processors']) && is_array($config['processors'])) {
foreach ($config['processors'] as $processor) {
$processors[] = $processor;
}
}
return $processors;
}
protected function getFallbackChannelName(): string
{
return $this->app->bound('env') ? $this->app->environment() : 'production';
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/src/Processors/RenameIdFieldProcessor.php | src/Processors/RenameIdFieldProcessor.php | <?php
namespace Hedii\LaravelGelfLogger\Processors;
use Monolog\LogRecord;
use Monolog\Processor\ProcessorInterface;
class RenameIdFieldProcessor implements ProcessorInterface
{
/**
* Rename "id" field to "_id" (additional field 'id' is not allowed).
*
* @see https://github.com/hedii/laravel-gelf-logger/issues/33
*/
public function __invoke(LogRecord $record): LogRecord
{
$context = $record->context;
if (array_key_exists('id', $context)) {
$context['_id'] = $context['id'];
unset($context['id']);
}
return $record->with(context: $context);
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/src/Processors/NullStringProcessor.php | src/Processors/NullStringProcessor.php | <?php
namespace Hedii\LaravelGelfLogger\Processors;
use Monolog\LogRecord;
use Monolog\Processor\ProcessorInterface;
class NullStringProcessor implements ProcessorInterface
{
/**
* Transform a "NULL" string record into a null value.
*/
public function __invoke(LogRecord $record): LogRecord
{
$context = $record->context;
foreach ($context as $key => $value) {
if (is_string($value) && strtoupper($value) === 'NULL') {
$context[$key] = null;
}
}
return $record->with(context: $context);
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/tests/ProcessorTest.php | tests/ProcessorTest.php | <?php
namespace Hedii\LaravelGelfLogger\Tests;
use Hedii\LaravelGelfLogger\Tests\Fake\AnotherTestProcessor;
use Hedii\LaravelGelfLogger\Tests\Fake\TestProcessor;
use Illuminate\Support\Facades\Log;
use PHPUnit\Framework\Attributes\Test;
class ProcessorTest extends TestCase
{
#[Test]
public function it_should_have_the_configured_processors(): void
{
$this->mergeConfig('logging.channels.gelf', [
'processors' => [TestProcessor::class, AnotherTestProcessor::class],
]);
$logger = Log::channel('gelf');
$handler = $logger->getHandlers()[0];
$this->assertInstanceOf(AnotherTestProcessor::class, $handler->popProcessor());
$this->assertInstanceOf(TestProcessor::class, $handler->popProcessor());
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/tests/TestCase.php | tests/TestCase.php | <?php
namespace Hedii\LaravelGelfLogger\Tests;
use Exception;
use Hedii\LaravelGelfLogger\GelfLoggerFactory;
use Orchestra\Testbench\TestCase as Orchestra;
use ReflectionClass;
class TestCase extends Orchestra
{
/**
* Define environment setup.
*
* @param \Illuminate\Foundation\Application $app
*/
protected function getEnvironmentSetUp($app): void
{
$app['config']->set('logging.default', 'gelf');
$app['config']->set('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'level' => 'notice',
'name' => 'my-custom-name',
'host' => '127.0.0.2',
'port' => 12202,
'ignore_error' => false,
]);
}
/**
* Get protected or private attribute from an object.
*
* @throws \Exception
*/
protected function getAttribute(object $object, string $property): mixed
{
try {
$reflector = new ReflectionClass($object);
$attribute = $reflector->getProperty($property);
$attribute->setAccessible(true);
return $attribute->getValue($object);
} catch (Exception) {
throw new Exception('Cannot get attribute from the provided object');
}
}
/**
* Get protected or private constant from a class.
*
* @throws \Exception
*/
protected function getConstant(string $class, string $constant): mixed
{
try {
$reflector = new ReflectionClass($class);
return $reflector->getConstant($constant);
} catch (Exception) {
throw new Exception('Cannot get attribute from the provided class');
}
}
/**
* Merge a given config to the global config.
*/
protected function mergeConfig(string $key, array $values): void
{
$config = $this->app['config'];
$config->set($key, array_merge($config->get($key), $values));
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/tests/GelfMessageTest.php | tests/GelfMessageTest.php | <?php
namespace Hedii\LaravelGelfLogger\Tests;
use DateTimeImmutable;
use Hedii\LaravelGelfLogger\GelfLoggerFactory;
use Illuminate\Support\Facades\Log;
use Monolog\Level;
use Monolog\LogRecord;
use PHPUnit\Framework\Attributes\Test;
class GelfMessageTest extends TestCase
{
#[Test]
public function it_should_append_prefixes(): void
{
$this->mergeConfig('logging.channels.gelf', [
'system_name' => 'my-system-namex',
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'context_prefix' => 'ctxt_',
'extra_prefix' => 'extra_',
]);
$formattedMessage = Log::channel('gelf')->getHandlers()[0]->getFormatter()->format(new LogRecord(
datetime: new DateTimeImmutable(),
channel: 'gelf',
level: Level::Debug,
message: 'test',
context: ['id' => '777', 'message' => 'custom'],
extra: ['ip' => '127.0.0.1', 'source' => 'tests'],
));
$this->assertArrayHasKey('extra_ip', $formattedMessage->getAllAdditionals());
$this->assertArrayHasKey('extra_source', $formattedMessage->getAllAdditionals());
$this->assertArrayHasKey('ctxt_id', $formattedMessage->getAllAdditionals());
$this->assertArrayHasKey('ctxt_message', $formattedMessage->getAllAdditionals());
}
#[Test]
public function it_should_not_append_prefixes(): void
{
$this->mergeConfig('logging.channels.gelf', [
'system_name' => 'my-system-namex',
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
]);
$formattedMessage = Log::channel('gelf')->getHandlers()[0]->getFormatter()->format(new LogRecord(
datetime: new DateTimeImmutable(),
channel: 'gelf',
level: Level::Debug,
message: 'test',
context: ['id' => '777'],
extra: ['ip' => '127.0.0.1'],
));
$this->assertArrayHasKey('ip', $formattedMessage->getAllAdditionals());
$this->assertArrayHasKey('id', $formattedMessage->getAllAdditionals());
}
#[Test]
public function null_config_variables_should_not_add_prefixes(): void
{
$this->mergeConfig('logging.channels.gelf', [
'system_name' => 'my-system-namex',
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'context_prefix' => null,
'extra_prefix' => null,
]);
$formattedMessage = Log::channel('gelf')->getHandlers()[0]->getFormatter()->format(new LogRecord(
datetime: new DateTimeImmutable(),
channel: 'test_channel',
level: Level::Debug,
message: 'test',
context: ['id' => '777'],
extra: ['ip' => '127.0.0.1'],
));
$this->assertArrayHasKey('ip', $formattedMessage->getAllAdditionals());
$this->assertArrayHasKey('id', $formattedMessage->getAllAdditionals());
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/tests/GelfLoggerTest.php | tests/GelfLoggerTest.php | <?php
namespace Hedii\LaravelGelfLogger\Tests;
use Gelf\Publisher;
use Gelf\Transport\HttpTransport;
use Gelf\Transport\IgnoreErrorTransportWrapper;
use Gelf\Transport\SslOptions;
use Gelf\Transport\TcpTransport;
use Gelf\Transport\UdpTransport;
use Hedii\LaravelGelfLogger\GelfLoggerFactory;
use Illuminate\Support\Facades\Log;
use LogicException;
use Monolog\Formatter\GelfMessageFormatter;
use Monolog\Handler\GelfHandler;
use Monolog\Level;
use Monolog\Logger;
use PHPUnit\Framework\Attributes\Test;
class GelfLoggerTest extends TestCase
{
#[Test]
public function it_should_have_a_gelf_log_channel(): void
{
$logger = Log::channel('gelf');
$this->assertInstanceOf(Logger::class, $logger->getLogger());
$this->assertSame('my-custom-name', $logger->getName());
$this->assertCount(1, $logger->getHandlers());
$handler = $logger->getHandlers()[0];
$this->assertInstanceOf(GelfHandler::class, $handler);
$this->assertSame(Level::Notice, $handler->getLevel());
$this->assertInstanceOf(GelfMessageFormatter::class, $handler->getFormatter());
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertInstanceOf(Publisher::class, $publisher);
$this->assertInstanceOf(UdpTransport::class, $transport);
}
#[Test]
public function it_should_not_have_any_processor_if_the_config_does_not_have_processors(): void
{
$this->expectException(LogicException::class);
$this->expectExceptionMessage('You tried to pop from an empty processor stack.');
$logger = Log::channel('gelf');
$handler = $logger->getHandlers()[0];
$handler->popProcessor();
}
#[Test]
public function it_should_set_system_name_to_current_hostname_if_system_name_is_null(): void
{
$this->mergeConfig('logging.channels.gelf', [
'system_name' => null,
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
]);
$logger = Log::channel('gelf');
$this->assertSame(
gethostname(),
$this->getAttribute($logger->getHandlers()[0]->getFormatter(), 'systemName')
);
}
#[Test]
public function it_should_set_system_name_to_custom_value_if_system_name_config_is_provided(): void
{
$this->mergeConfig('logging.channels.gelf', [
'system_name' => 'my-system-name',
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
]);
$logger = Log::channel('gelf');
$this->assertSame(
'my-system-name',
$this->getAttribute($logger->getHandlers()[0]->getFormatter(), 'systemName')
);
}
#[Test]
public function it_should_call_the_tcp_transport_method_when_provided(): void
{
$this->mergeConfig('logging.channels.gelf', [
'transport' => 'tcp',
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertInstanceOf(TcpTransport::class, $transport);
}
#[Test]
public function it_should_call_the_udp_transport_method_when_nothing_is_provided(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertInstanceOf(UdpTransport::class, $transport);
}
#[Test]
public function it_should_set_max_length_if_max_length_is_provided(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'max_length' => 9999,
]);
$logger = Log::channel('gelf');
$this->assertSame(
9999,
$this->getAttribute($logger->getHandlers()[0]->getFormatter(), 'maxLength')
);
}
#[Test]
public function it_should_use_default_max_length_when_max_length_is_not_provided(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
]);
$logger = Log::channel('gelf');
$this->assertSame(
$this->getConstant(GelfMessageFormatter::class, 'DEFAULT_MAX_LENGTH'),
$this->getAttribute($logger->getHandlers()[0]->getFormatter(), 'maxLength')
);
}
#[Test]
public function it_should_use_default_max_length_when_max_length_is_null(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'max_length' => null,
]);
$logger = Log::channel('gelf');
$this->assertSame(
$this->getConstant(GelfMessageFormatter::class, 'DEFAULT_MAX_LENGTH'),
$this->getAttribute($logger->getHandlers()[0]->getFormatter(), 'maxLength')
);
}
#[Test]
public function it_should_call_the_http_transport_method_when_provided(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertInstanceOf(HttpTransport::class, $transport);
}
#[Test]
public function it_should_set_path_if_path_is_provided(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'path' => '/custom-path',
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertSame('/custom-path', $this->getAttribute($transport, 'path'));
}
#[Test]
public function it_should_set_path_to_default_path_if_path_is_null(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'path' => null,
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertSame(
$this->getConstant(HttpTransport::class, 'DEFAULT_PATH'),
$this->getAttribute($transport, 'path')
);
}
#[Test]
public function it_should_set_path_to_default_path_if_path_is_not_provided(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertSame(
$this->getConstant(HttpTransport::class, 'DEFAULT_PATH'),
$this->getAttribute($transport, 'path')
);
}
#[Test]
public function it_should_set_the_ssl_options_for_tcp_transport(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'tcp',
'port' => 12202,
'ssl' => true,
'ssl_options' => [
'verify_peer' => false,
'ca_file' => '/path/to/ca.pem',
'ciphers' => 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256',
'allow_self_signed' => true,
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
/** @var SslOptions $sslOptions */
$sslOptions = $this->getAttribute($transport, 'sslOptions');
$this->assertFalse($sslOptions->getVerifyPeer());
$this->assertTrue($sslOptions->getAllowSelfSigned());
$this->assertEquals('/path/to/ca.pem', $sslOptions->getCaFile());
$this->assertEquals('TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256', $sslOptions->getCiphers());
}
#[Test]
public function it_should_set_the_ssl_options_for_http_transport(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'port' => 443,
'ssl' => true,
'ssl_options' => [
'verify_peer' => false,
'ca_file' => '/path/to/ca.pem',
'ciphers' => 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256',
'allow_self_signed' => true,
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
/** @var SslOptions $sslOptions */
$sslOptions = $this->getAttribute($transport, 'sslOptions');
$this->assertFalse($sslOptions->getVerifyPeer());
$this->assertTrue($sslOptions->getAllowSelfSigned());
$this->assertSame('/path/to/ca.pem', $sslOptions->getCaFile());
$this->assertSame('TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256', $sslOptions->getCiphers());
}
#[Test]
public function it_should_not_add_ssl_on_tcp_transport_when_the_ssl_config_is_missing_or_set_to_false(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'tcp',
'port' => 1234,
'ssl_options' => [
'verify_peer' => false,
'ca_file' => '/path/to/ca.pem',
'ciphers' => 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256',
'allow_self_signed' => true,
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertNull($this->getAttribute($transport, 'sslOptions'));
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'tcp',
'port' => 1234,
'ssl' => false,
'ssl_options' => [
'verify_peer' => false,
'ca_file' => '/path/to/ca.pem',
'ciphers' => 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256',
'allow_self_signed' => true,
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertNull($this->getAttribute($transport, 'sslOptions'));
}
#[Test]
public function it_should_not_add_ssl_on_http_transport_when_the_ssl_config_is_missing_or_set_to_false(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'ssl_options' => [
'verify_peer' => false,
'ca_file' => '/path/to/ca.pem',
'ciphers' => 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256',
'allow_self_signed' => true,
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertNull($this->getAttribute($transport, 'sslOptions'));
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'ssl' => false,
'ssl_options' => [
'verify_peer' => false,
'ca_file' => '/path/to/ca.pem',
'ciphers' => 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256',
'allow_self_signed' => true,
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertNull($this->getAttribute($transport, 'sslOptions'));
}
#[Test]
public function it_should_use_the_default_ssl_options_when_ssl_options_is_missing(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'tcp',
'port' => 12202,
'ssl' => true,
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
/** @var SslOptions $sslOptions */
$sslOptions = $this->getAttribute($transport, 'sslOptions');
$this->assertTrue($sslOptions->getVerifyPeer());
$this->assertFalse($sslOptions->getAllowSelfSigned());
$this->assertNull($sslOptions->getCaFile());
$this->assertNull($sslOptions->getCiphers());
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'port' => 443,
'ssl' => true,
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
/** @var SslOptions $sslOptions */
$sslOptions = $this->getAttribute($transport, 'sslOptions');
$this->assertTrue($sslOptions->getVerifyPeer());
$this->assertFalse($sslOptions->getAllowSelfSigned());
$this->assertNull($sslOptions->getCaFile());
$this->assertNull($sslOptions->getCiphers());
}
#[Test]
public function it_should_ignore_errors_when_the_ignore_error_config_is_missing_or_set_to_false(): void
{
$this->app['config']->set('logging.default', 'gelf');
$this->app['config']->set('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'level' => 'notice',
'name' => 'my-custom-name',
'host' => '127.0.0.2',
'port' => 12202,
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertInstanceOf(IgnoreErrorTransportWrapper::class, $transport);
$this->app['config']->set('logging.default', 'gelf');
$this->app['config']->set('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'level' => 'notice',
'name' => 'my-custom-name',
'host' => '127.0.0.2',
'port' => 12202,
'ignore_error' => true,
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertInstanceOf(IgnoreErrorTransportWrapper::class, $transport);
}
public function it_should_not_ignore_error_if_ignore_error_config_is_set_to_false(): void
{
$this->app['config']->set('logging.default', 'gelf');
$this->mergeConfig('logging.channels.gelf', ['ignore_error' => false]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertInstanceOf(TcpTransport::class, $transport);
}
#[Test]
public function it_should_not_set_authentication_on_http_transport_if_http_basic_auth_is_not_fully_provided(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertNull($this->getAttribute($transport, 'authentication'));
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'http_basic_auth' => 'foo',
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertNull($this->getAttribute($transport, 'authentication'));
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'http_basic_auth' => [
'username' => '',
'password' => 'my_password',
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertNull($this->getAttribute($transport, 'authentication'));
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'http_basic_auth' => [
'username' => 'my_username',
'password' => '',
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertNull($this->getAttribute($transport, 'authentication'));
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'http_basic_auth' => [
'username' => 'my_username',
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertNull($this->getAttribute($transport, 'authentication'));
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'http_basic_auth' => [
'password' => 'my_password',
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertNull($this->getAttribute($transport, 'authentication'));
}
#[Test]
public function it_should_set_authentication_on_http_transport_if_http_basic_auth_is_provided(): void
{
$this->mergeConfig('logging.channels.gelf', [
'driver' => 'custom',
'via' => GelfLoggerFactory::class,
'transport' => 'http',
'http_basic_auth' => [
'username' => 'my_username',
'password' => 'my_password',
],
]);
$logger = Log::channel('gelf');
$publisher = $this->getAttribute($logger->getHandlers()[0], 'publisher');
$transport = $publisher->getTransports()[0];
$this->assertSame('my_username:my_password', $this->getAttribute($transport, 'authentication'));
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/tests/Processors/RenameIdFieldProcessorTest.php | tests/Processors/RenameIdFieldProcessorTest.php | <?php
namespace Hedii\LaravelGelfLogger\Tests\Processors;
use DateTimeImmutable;
use Hedii\LaravelGelfLogger\Processors\RenameIdFieldProcessor;
use Monolog\Level;
use Monolog\LogRecord;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
class RenameIdFieldProcessorTest extends TestCase
{
#[Test]
#[DataProvider('dataProvider')]
public function it_should_rename_id_field(array $payloadContext, array $expected): void
{
$payload = new LogRecord(
datetime: new DateTimeImmutable(),
channel: 'gelf',
level: Level::Debug,
message: 'message',
context: $payloadContext
);
$processor = new RenameIdFieldProcessor();
$this->assertSame($expected, $processor($payload)->context);
}
public static function dataProvider(): array
{
return [
'having neither underscore id nor id' => [
['someotherfield' => 'someothervalue'],
['someotherfield' => 'someothervalue'],
],
'having id and underscore id' => [
['id' => 'bar', '_id' => 'bar2'],
['_id' => 'bar'],
],
'having id and not underscore id' => [
['id' => 'bar'],
['_id' => 'bar'],
],
'having no id and underscore id' => [
['_id' => 'bar', 'field1' => 'value1'],
['_id' => 'bar', 'field1' => 'value1'],
],
];
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/tests/Processors/NullStringProcessorTest.php | tests/Processors/NullStringProcessorTest.php | <?php
namespace Hedii\LaravelGelfLogger\Tests\Processors;
use DateTimeImmutable;
use Hedii\LaravelGelfLogger\Processors\NullStringProcessor;
use Monolog\Level;
use Monolog\LogRecord;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
class NullStringProcessorTest extends TestCase
{
#[Test]
public function it_should_transform_null_string_to_null(): void
{
$payload = new LogRecord(
datetime: new DateTimeImmutable(),
channel: 'gelf',
level: Level::Debug,
message: 'message',
context: [
'key1' => 'bar',
'key2' => 'NULL',
'key3' => 'null',
'key4' => null,
]
);
$processor = new NullStringProcessor();
$this->assertSame([
'key1' => 'bar',
'key2' => null,
'key3' => null,
'key4' => null,
], $processor($payload)->context);
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/tests/Fake/AnotherTestProcessor.php | tests/Fake/AnotherTestProcessor.php | <?php
namespace Hedii\LaravelGelfLogger\Tests\Fake;
use Monolog\LogRecord;
class AnotherTestProcessor
{
public function __invoke(LogRecord $record): LogRecord
{
return $record;
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
hedii/laravel-gelf-logger | https://github.com/hedii/laravel-gelf-logger/blob/1eff11cbeb1e00563503de482c11df554f8c9e06/tests/Fake/TestProcessor.php | tests/Fake/TestProcessor.php | <?php
namespace Hedii\LaravelGelfLogger\Tests\Fake;
use Monolog\LogRecord;
class TestProcessor
{
public function __invoke(LogRecord $record): LogRecord
{
return $record;
}
}
| php | MIT | 1eff11cbeb1e00563503de482c11df554f8c9e06 | 2026-01-05T05:12:54.127152Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/server.php | Campaign/server.php | <?php
/**
* Laravel - A PHP Framework For Web Artisans
*
* @package Laravel
* @author Taylor Otwell <taylor@laravel.com>
*/
$uri = urldecode(
parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH)
);
// This file allows us to emulate Apache's "mod_rewrite" functionality from the
// built-in PHP web server. This provides a convenient way to test a Laravel
// application without having installed a "real" web server software here.
if ($uri !== '/' && file_exists(__DIR__.'/public'.$uri)) {
return false;
}
require_once __DIR__.'/public/index.php';
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/LocalValetDriver.php | Campaign/LocalValetDriver.php | <?php
use Valet\Drivers\LaravelValetDriver;
/**
* Default Laravel Valet driver doesn't know how to redirect traffic to other scripts than index.php
*/
class LocalValetDriver extends LaravelValetDriver
{
/**
* Get the fully resolved path to the application's front controller.
*/
public function frontControllerPath(string $sitePath, string $siteName, string $uri): ?string
{
$filePath = implode(DIRECTORY_SEPARATOR, [$sitePath, 'public', $uri]);
if (file_exists($filePath) && is_file($filePath)) {
return $filePath;
}
return parent::frontControllerPath($sitePath, $siteName, $uri);
}
} | php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/app/Console/MigrateMakeCommand.php | Campaign/app/Console/MigrateMakeCommand.php | <?php
namespace App\Console;
use Illuminate\Database\Console\Migrations\BaseCommand;
use Illuminate\Database\Console\Migrations\TableGuesser;
use Illuminate\Database\Migrations\MigrationCreator;
use Illuminate\Support\Composer;
use Illuminate\Support\Str;
class MigrateMakeCommand extends BaseCommand
{
private const DEFAULT_MIGRATION_PATH = 'extensions/campaign-module/database/migrations';
protected $signature = 'make:migration {name : The name of the migration}
{--create= : The table to be created}
{--table= : The table to migrate}
{--path= : The location where the migration file should be created (default path is extension/be)}
{--realpath : Indicate any provided migration file paths are pre-resolved absolute paths}
{--fullpath : Output the full path of the migration}';
protected $description = 'Create a new migration file';
public function __construct(
protected MigrationCreator $creator,
protected Composer $composer
) {
parent::__construct();
}
public function handle(): void
{
if (!$this->input->getOption('path')) {
$this->input->setOption('path', self::DEFAULT_MIGRATION_PATH);
}
// It's possible for the developer to specify the tables to modify in this
// schema operation. The developer may also specify if this table needs
// to be freshly created so we can create the appropriate migrations.
$name = Str::snake(trim($this->input->getArgument('name')));
$table = $this->input->getOption('table');
$create = $this->input->getOption('create') ?: false;
// If no table was given as an option but a create option is given then we
// will use the "create" option as the table name. This allows the devs
// to pass a table name into this option as a short-cut for creating.
if (! $table && is_string($create)) {
$table = $create;
$create = true;
}
// Next, we will attempt to guess the table name if this the migration has
// "create" in the name. This will allow us to provide a convenient way
// of creating migrations that create new tables for the application.
if (! $table) {
[$table, $create] = TableGuesser::guess($name);
}
// Now we are ready to write the migration out to disk. Once we've written
// the migration out, we will dump-autoload for the entire framework to
// make sure that the migrations are registered by the class loaders.
$this->writeMigration($name, $table, $create);
$this->composer->dumpAutoloads();
}
protected function writeMigration($name, $table, $create)
{
$file = $this->creator->create(
$name,
$this->getMigrationPath(),
$table,
$create
);
if (! $this->option('fullpath')) {
$file = pathinfo($file, PATHINFO_FILENAME);
}
$this->line("<info>Created Migration:</info> {$file}");
}
protected function getMigrationPath()
{
if (! is_null($targetPath = $this->input->getOption('path'))) {
return ! $this->usingRealPath()
? $this->laravel->basePath().'/'.$targetPath
: $targetPath;
}
return parent::getMigrationPath();
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/app/Console/Kernel.php | Campaign/app/Console/Kernel.php | <?php
namespace App\Console;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
class Kernel extends ConsoleKernel
{
/**
* The Artisan commands provided by your application.
*
* @var array
*/
protected $commands = [
];
/**
* Define the application's command schedule.
*
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @return void
*/
protected function schedule(Schedule $schedule)
{
}
/**
* Register the Closure based commands for the application.
*
* @return void
*/
protected function commands()
{
require base_path('routes/console.php');
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/app/Providers/AppServiceProvider.php | Campaign/app/Providers/AppServiceProvider.php | <?php
namespace App\Providers;
use App\Console\MigrateMakeCommand;
use Illuminate\Support\Composer;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*
* @return void
*/
public function register()
{
$this->app->extend('command.migrate.make', function ($app) {
return new MigrateMakeCommand(
$this->app->get('migration.creator'),
$this->app->get(Composer::class)
);
});
}
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Snippet.php | Campaign/extensions/campaign-module/src/Snippet.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Redis;
use Spatie\Searchable\Searchable;
use Spatie\Searchable\SearchResult;
class Snippet extends Model implements Searchable
{
const REDIS_CACHE_KEY = 'snippets';
protected $fillable = [
'name',
'value',
];
public static function refreshSnippetsCache()
{
$snippets = Snippet::query()->pluck('value', 'name');
Redis::set(self::REDIS_CACHE_KEY, json_encode($snippets));
}
public function getSearchResult(): SearchResult
{
return new SearchResult($this, $this->name);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Campaign.php | Campaign/extensions/campaign-module/src/Campaign.php | <?php
namespace Remp\CampaignModule;
use Database\Factories\CampaignFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Fico7489\Laravel\Pivot\Traits\PivotEventTrait;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Facades\Redis;
use Remp\CampaignModule\Concerns\HasCacheableRelation;
use Spatie\Searchable\Searchable;
use Spatie\Searchable\SearchResult;
class Campaign extends Model implements Searchable
{
/** @use HasFactory<CampaignFactory> */
use HasFactory;
use HasCacheableRelation;
use PivotEventTrait;
use IdentificationTrait;
const ACTIVE_CAMPAIGN_IDS = 'active_campaign_ids';
const CAMPAIGN_TAG = 'campaign';
const CAMPAIGN_JSON_TAG = 'campaign_json';
const CAMPAIGN_SNIPPET_CODES_JSON_TAG = 'campaign_snippet_codes_json';
const PAGEVIEW_RULE_EVERY = 'every';
const PAGEVIEW_RULE_SINCE = 'since';
const PAGEVIEW_RULE_BEFORE = 'before';
const DEVICE_MOBILE = 'mobile';
const DEVICE_DESKTOP = 'desktop';
const OPERATING_SYSTEM_ANDROID = 'android';
const OPERATING_SYSTEM_IOS = 'ios';
const OPERATING_SYSTEM_LINUX = 'linux';
const OPERATING_SYSTEM_WINDOWS = 'windows';
const OPERATING_SYSTEM_MAC = 'mac';
const OPERATING_SYSTEM_UNKNOWN = 'unknown';
const URL_FILTER_EVERYWHERE = 'everywhere';
const URL_FILTER_ONLY_AT = 'only_at';
const URL_FILTER_EXCEPT_AT = 'except_at';
const SOURCE_FILTER_ALL = 'everywhere';
const SOURCE_FILTER_SESSION_ONLY_AT = 'session_only_at';
const SOURCE_FILTER_SESSION_EXCEPT_AT = 'session_except_at';
const SOURCE_FILTER_REFERER_ONLY_AT = 'only_at';
const SOURCE_FILTER_REFERER_EXCEPT_AT = 'except_at';
private static $activeCache;
protected static function newFactory(): CampaignFactory
{
return CampaignFactory::new();
}
protected $fillable = [
'name',
'signed_in',
'once_per_session',
'pageview_rules',
'pageview_attributes',
'devices',
'operating_systems',
'languages',
'using_adblock',
'url_filter',
'url_patterns',
'source_filter',
'source_patterns',
];
protected $casts = [
'active' => 'boolean',
'signed_in' => 'boolean',
'once_per_session' => 'boolean',
'pageview_rules' => 'json',
'pageview_attributes' => 'json',
'devices' => 'json',
'operating_systems' => 'json',
'languages' => 'json',
'using_adblock' => 'boolean',
'url_patterns' => 'json',
'source_patterns' => 'json',
];
protected $attributes = [
'once_per_session' => false,
'using_adblock' => null,
'pageview_rules' => '[]',
'pageview_attributes' => '[]',
'devices' => "[\"desktop\", \"mobile\"]",
'operating_systems' => '[]',
'url_filter' => self::URL_FILTER_EVERYWHERE,
'source_filter' => self::SOURCE_FILTER_ALL,
];
protected $appends = ['active'];
protected $dateFormat = 'Y-m-d H:i:s';
protected $cacheableRelations = [
'segments' => CampaignSegment::class,
'countries' => Country::class,
'countriesWhitelist' => Country::class,
'countriesBlacklist' => Country::class,
'schedules' => Schedule::class,
'campaignBanners' => CampaignBanner::class,
'campaignBanners.banner' => Banner::class,
];
public function getSearchResult(): SearchResult
{
return new SearchResult($this, $this->name);
}
protected static function boot()
{
parent::boot();
static::creating(function (Campaign $campaign) {
$campaign->uuid = self::generateUuid();
$campaign->public_id = self::generatePublicId();
});
}
/**
* Get virtual field `active` which indicates if campaign has active schedules.
*
* @return bool
*/
public function getActiveAttribute()
{
if (!self::$activeCache) {
self::$activeCache = Schedule::runningOrPlanned()
->groupBy('campaign_id')
->selectRaw('COUNT(*) as count, campaign_id')
->get()
->mapWithKeys(function ($row) {
return [$row->campaign_id => $row['count']];
});
}
return self::$activeCache->get($this->id, 0) > 0;
}
/**
* Get campaign variants UUIDs
*
* @return array
*/
public function getVariantsUuidsAttribute()
{
return $this->campaignBanners()->withTrashed()->pluck('uuid')->toArray();
}
public function banners(): BelongsToMany
{
return $this->belongsToMany(Banner::class, 'campaign_banners')
->withPivot('proportion', 'control_group', 'weight');
}
/**
* @return HasMany<CampaignBanner, $this>
*/
public function campaignBanners(): HasMany
{
return $this->hasMany(CampaignBanner::class)->orderBy('weight');
}
public function getPrimaryBanner()
{
return optional(
$this->campaignBanners()->with('banner')->first()
)->banner;
}
public function removeVariants(array $variantIds)
{
return CampaignBanner::whereIn('id', $variantIds)->delete();
}
public function storeOrUpdateVariants(array $variants)
{
foreach ($variants as $variant) {
$data = [
'id' => $variant['id'],
'campaign_id' => $this->id,
'weight' => $variant['weight'],
'proportion' => $variant['proportion'],
'control_group' => $variant['control_group'],
'banner_id' => $variant['banner_id'] ?? null,
];
$campaignBanner = CampaignBanner::findOrNew($variant['id']);
$campaignBanner->fill($data);
$campaignBanner->save();
}
}
/**
* @return BelongsToMany<Country, $this>
*/
public function countries(): BelongsToMany
{
return $this->belongsToMany(
Country::class,
null,
null,
'country_iso_code',
null,
'iso_code'
)->withPivot('blacklisted');
}
/**
* @return BelongsToMany<Country, $this>
*/
public function countriesWhitelist(): BelongsToMany
{
return $this->countries()->wherePivot('blacklisted', '=', false);
}
/**
* @return BelongsToMany<Country, $this>
*/
public function countriesBlacklist(): BelongsToMany
{
return $this->countries()->wherePivot('blacklisted', '=', true);
}
/**
* @return HasMany<CampaignSegment, $this>
*/
public function segments(): HasMany
{
return $this->hasMany(CampaignSegment::class);
}
/**
* @return HasMany<Schedule, $this>
*/
public function schedules(): HasMany
{
return $this->hasMany(Schedule::class);
}
/**
* @return BelongsToMany<CampaignCollection, $this>
*/
public function collections(): BelongsToMany
{
return $this->belongsToMany(
CampaignCollection::class,
'campaign_collections',
'campaign_id',
'collection_id',
);
}
public function getAllDevices()
{
return [self::DEVICE_DESKTOP, self::DEVICE_MOBILE];
}
public function getAvailableOperatingSystems(): array
{
return [
[
'label' => 'Android',
'value' => self::OPERATING_SYSTEM_ANDROID,
],
[
'label' => 'iOS',
'value' => self::OPERATING_SYSTEM_IOS,
],
[
'label' => 'Linux',
'value' => self::OPERATING_SYSTEM_LINUX,
],
[
'label' => 'Windows',
'value' => self::OPERATING_SYSTEM_WINDOWS,
],
[
'label' => 'Mac',
'value' => self::OPERATING_SYSTEM_MAC,
],
];
}
public function getOperatingSystemsMapping(): array
{
return [
self::OPERATING_SYSTEM_ANDROID => ['AND'],
self::OPERATING_SYSTEM_IOS => ['IOS'],
self::OPERATING_SYSTEM_LINUX => ['LIN'],
self::OPERATING_SYSTEM_WINDOWS => ['WIN'],
self::OPERATING_SYSTEM_MAC => ['MAC'],
];
}
public function supportsDevice($device)
{
if (in_array($device, $this->devices)) {
return true;
}
return false;
}
public function getVariantsProportionMapping()
{
$mapping = [];
$campaignBanners = $this->campaignBanners;
foreach ($campaignBanners as $campaignBanner) {
$mapping[$campaignBanner->uuid] = $campaignBanner->proportion;
}
return $mapping;
}
public function getAllUrlFilterTypes()
{
return [
self::URL_FILTER_EVERYWHERE => 'Everywhere',
self::URL_FILTER_ONLY_AT => 'Only at',
self::URL_FILTER_EXCEPT_AT => 'Except at',
];
}
public function getAllSourceFilterTypes(): array
{
return [
self::SOURCE_FILTER_ALL => 'Everywhere',
self::SOURCE_FILTER_REFERER_ONLY_AT => 'Only referers',
self::SOURCE_FILTER_REFERER_EXCEPT_AT => 'Except referers',
self::SOURCE_FILTER_SESSION_ONLY_AT => 'Only session sources',
self::SOURCE_FILTER_SESSION_EXCEPT_AT => 'Except session sources',
];
}
public function getUsedSnippetCodes(): array
{
$usedSnippetCodes = [];
/** @var CampaignBanner $campaignBanner */
foreach ($this->campaignBanners as $campaignBanner) {
$usedSnippetCodes[$campaignBanner->public_id] = $campaignBanner->banner?->getUsedSnippetCodes() ?? [];
}
return $usedSnippetCodes;
}
/**
* This method overrides Laravel's default replicate method
* it loads CampaignBanner (variant) replicas to relation
*
* @param array|null $except
* @return Model
*/
public function replicate(array $except = null)
{
$replica = parent::replicate($except);
$variants = [];
foreach ($this->campaignBanners as $variant) {
$variants[] = $variant->replicate();
}
$replica->setRelation('campaignBanners', collect($variants));
return $replica;
}
public function cache()
{
// dump active cache when something important changed
self::$activeCache = null;
self::refreshActiveCampaignsCache();
/** @var Campaign $campaign */
$campaign = $this->where(['id' => $this->id])
->with(array_keys($this->cacheableRelations))
->first();
foreach ($campaign->campaignBanners as $variant) {
optional($variant->banner)->loadTemplate();
}
Redis::set(self::CAMPAIGN_JSON_TAG . ":{$this->id}", $campaign->toJson());
Redis::set(self::CAMPAIGN_SNIPPET_CODES_JSON_TAG . ":{$this->id}", json_encode($campaign->getUsedSnippetCodes()));
}
public static function refreshActiveCampaignsCache()
{
$activeCampaignIds = Schedule::applyScopes()
->runningOrPlanned()
->orderBy('start_time')
->pluck('campaign_id')
->unique()
->toArray();
Redis::set(self::ACTIVE_CAMPAIGN_IDS, json_encode(array_values($activeCampaignIds)));
return collect($activeCampaignIds);
}
public function signedInOptions()
{
return [
null => 'Everyone',
true => 'Only signed in',
false => 'Only anonymous ',
];
}
public function signedInLabel()
{
return $this->signedInOptions()[$this->signed_in];
}
public static function getAvailableLanguages()
{
$locales = \ResourceBundle::getLocales(null);
$availableLanguages = [];
foreach ($locales as $locale) {
$primaryLanguage = \Locale::getPrimaryLanguage($locale);
if (!isset($availableLanguages[$primaryLanguage])) {
$availableLanguages[$primaryLanguage] = [
'value' => $primaryLanguage,
'label' => \Locale::getDisplayLanguage($locale),
];
}
}
return array_values($availableLanguages);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/CampaignServiceProvider.php | Campaign/extensions/campaign-module/src/CampaignServiceProvider.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Support\Facades\Process;
use Illuminate\Support\Facades\URL;
use Remp\CampaignModule\Console\Commands\AggregateCampaignStats;
use Remp\CampaignModule\Console\Commands\CampaignsRefreshCache;
use Remp\CampaignModule\Console\Commands\PostInstallCommand;
use Remp\CampaignModule\Console\Commands\CampaignEventsPopulatorCommand;
use Remp\CampaignModule\Contracts\SegmentAggregator;
use Remp\CampaignModule\Http\Resources\SearchResource;
use Remp\CampaignModule\Http\Showtime\LazyDeviceDetector;
use Remp\CampaignModule\Http\Showtime\LazyGeoReader;
use Remp\CampaignModule\Http\Showtime\ShowtimeConfig;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Database\Connection;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Foundation\Application;
use Illuminate\Pagination\Paginator;
use Illuminate\Support\Facades\Redis;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\ServiceProvider;
use Predis\ClientInterface;
use Remp\LaravelHelpers\Database\MySqlConnection;
class CampaignServiceProvider extends ServiceProvider
{
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot(Filesystem $filesystem)
{
$this->bindObservers();
Paginator::useBootstrapThree();
SearchResource::withoutWrapping();
$this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
Route::group([
'prefix' => 'api',
'middleware' => 'api',
'as' => 'api.',
], function () {
$this->loadRoutesFrom(__DIR__ . '/../routes/api.php');
});
Route::group([
'middleware' => 'web'
], function () {
$this->loadRoutesFrom(__DIR__ . '/../routes/web.php');
});
$this->loadViewsFrom(__DIR__ . '/../resources/views', 'campaign');
$this->loadTranslationsFrom(__DIR__ . '/../resources/lang', 'campaign');
$this->registerCommands();
if ($this->app->runningInConsole()) {
$publishPaths = [
__DIR__ . '/../public/' => public_path('vendor/campaign'),
__DIR__ . '/../config/banners.php' => config_path('banners.php'),
__DIR__ . '/../config/services.php' => config_path('services.remp.php'),
__DIR__ . '/../config/newsletter_banners.php' => config_path('newsletter_banners.php'),
__DIR__ . '/../config/search.php' => config_path('search.php'),
__DIR__ . '/../config/system.php' => config_path('system.php'),
];
// MySqlSchemaState::load uses hard-coded "mysql" command as well, this might change in the future because
// of the mariadb executable moving away.
$checkCommand = (PHP_OS_FAMILY === 'Windows') ? 'where' : 'which';
$mysqlClientCheck = Process::run("$checkCommand mysql");
if ($mysqlClientCheck->successful()) {
$publishPaths[__DIR__ .'/../database/schema/mysql-schema.sql'] = database_path('schema/mysql-schema.sql');
}
$this->publishes($publishPaths, ['campaign-assets', 'laravel-assets']);
$this->app->booted(function () {
$schedule = $this->app->make(Schedule::class);
(new Scheduler())->schedule($schedule);
});
}
}
/**
* Register any application services.
*
* @return void
*/
public function register()
{
Connection::resolverFor('mysql', function ($connection, $database, $prefix, $config) {
// Use local resolver to control DateTimeInterface bindings.
return new MySqlConnection($connection, $database, $prefix, $config);
});
if (config('app.force_https')) {
URL::forceScheme('https');
}
$dimensionMap = new \Remp\CampaignModule\Models\Dimension\Map(config('banners.dimensions', []));
$positionsMap = new \Remp\CampaignModule\Models\Position\Map(config('banners.positions', []));
$alignmentsMap = new \Remp\CampaignModule\Models\Alignment\Map(config('banners.alignments', []));
$colorSchemesMap = new \Remp\CampaignModule\Models\ColorScheme\Map(config('banners.color_schemes', []));
$this->app->bind(\Remp\CampaignModule\Models\Dimension\Map::class, function () use ($dimensionMap) {
return $dimensionMap;
});
$this->app->bind(\Remp\CampaignModule\Models\Position\Map::class, function () use ($positionsMap) {
return $positionsMap;
});
$this->app->bind(\Remp\CampaignModule\Models\Alignment\Map::class, function () use ($alignmentsMap) {
return $alignmentsMap;
});
$this->app->bind(\Remp\CampaignModule\Models\ColorScheme\Map::class, function () use ($colorSchemesMap) {
return $colorSchemesMap;
});
$this->app->bind(ClientInterface::class, function () {
return Redis::connection()->client();
});
$this->app->bind(LazyGeoReader::class, function () {
return new LazyGeoReader(config("services.remp.maxmind.database"));
});
$this->app->bind(ShowtimeConfig::class, function () {
return (new ShowtimeConfig(
debugKey: config('banners.campaign_debug_key'),
prioritizeBannerOnSamePosition: config('banners.prioritize_banners_on_same_position'),
oneTimeBannerEnabled: config("banners.one_time_banner_enabled"),
));
});
$this->app->bind(SegmentAggregator::class, function (Application $app) {
return new SegmentAggregator($app->tagged(SegmentAggregator::TAG));
});
$this->app->bind(LazyDeviceDetector::class, function () {
if (extension_loaded('apcu')) {
$cache = new \MatthiasMullie\Scrapbook\Psr16\SimpleCache(
new \MatthiasMullie\Scrapbook\Adapters\Apc(),
);
} elseif (config("database.redis.client") === 'phpredis') {
$cache = new \MatthiasMullie\Scrapbook\Psr16\SimpleCache(
new \MatthiasMullie\Scrapbook\Adapters\Redis(Redis::connection()->client()),
);
} else {
$cache = new \Kodus\PredisSimpleCache\PredisSimpleCache(Redis::connection()->client(), 60*60*24);
}
return new LazyDeviceDetector($cache);
});
}
protected function registerCommands(): void
{
$this->commands([
AggregateCampaignStats::class,
CampaignsRefreshCache::class,
PostInstallCommand::class,
CampaignEventsPopulatorCommand::class,
]);
}
public function bindObservers()
{
\Remp\CampaignModule\Banner::observe(\Remp\CampaignModule\Observers\Banner::class);
\Remp\CampaignModule\Campaign::observe(\Remp\CampaignModule\Observers\Campaign::class);
\Remp\CampaignModule\CampaignBanner::observe(\Remp\CampaignModule\Observers\CampaignBanner::class);
\Remp\CampaignModule\CampaignSegment::observe(\Remp\CampaignModule\Observers\CampaignSegment::class);
\Remp\CampaignModule\Schedule::observe(\Remp\CampaignModule\Observers\Schedule::class);
\Remp\CampaignModule\Snippet::observe(\Remp\CampaignModule\Observers\Snippet::class);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/CampaignCollection.php | Campaign/extensions/campaign-module/src/CampaignCollection.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
class CampaignCollection extends Model
{
use HasFactory;
public $timestamps = false;
public $table = 'collections';
protected $fillable = [
'name',
];
protected $casts = [
'name' => 'string',
];
/**
* @return BelongsToMany<Campaign, $this>
*/
public function campaigns(): BelongsToMany
{
return $this->belongsToMany(
Campaign::class,
'campaign_collections',
'collection_id',
'campaign_id',
);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/OverlayRectangleTemplate.php | Campaign/extensions/campaign-module/src/OverlayRectangleTemplate.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class OverlayRectangleTemplate extends AbstractTemplate
{
protected $fillable = [
'header_text',
'main_text',
'button_text',
'width',
'height',
'image_link',
'color_scheme',
];
protected $attributes = [
'color_scheme' => 'grey',
];
protected $snippetFields = [
'header_text',
'main_text',
'button_text',
];
public function text()
{
return strip_tags("{$this->main_text}");
}
/**
* @return BelongsTo<Banner, $this>
*/
public function banner(): BelongsTo
{
return $this->belongsTo(Banner::class);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/OverlayTwoButtonsSignatureTemplate.php | Campaign/extensions/campaign-module/src/OverlayTwoButtonsSignatureTemplate.php | <?php
namespace Remp\CampaignModule;
class OverlayTwoButtonsSignatureTemplate extends AbstractTemplate
{
protected $fillable = [
'text_before',
'text_after',
'text_btn_primary',
'text_btn_primary_minor',
'text_btn_secondary',
'text_btn_secondary_minor',
'target_url_secondary',
'signature_image_url',
'text_signature'
];
protected $snippetFields = [
'text_before',
'text_after',
'text_btn_primary',
'text_btn_primary_minor',
'text_btn_secondary',
'text_btn_secondary_minor',
'text_signature'
];
public function text()
{
return strip_tags($this->text_before);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/HtmlTemplate.php | Campaign/extensions/campaign-module/src/HtmlTemplate.php | <?php
namespace Remp\CampaignModule;
class HtmlTemplate extends AbstractTemplate
{
protected $fillable = [
'dimensions',
'text',
'css',
'text_align',
'font_size',
'text_color',
'background_color',
];
protected $snippetFields = [
'text',
'css',
];
/**
* Text should return textual representation of the banner's main text in the cleanest possible form.
* @return mixed
*/
public function text()
{
return strip_tags($this->text);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/CampaignBannerPurchaseStats.php | Campaign/extensions/campaign-module/src/CampaignBannerPurchaseStats.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class CampaignBannerPurchaseStats extends Model
{
public $timestamps = false;
protected $table = 'campaign_banner_purchase_stats';
protected $fillable = [
'campaign_banner_id',
'time_from',
'time_to',
'sum',
'currency',
];
protected $dates = [
'time_from',
'time_to',
];
/**
* @return BelongsTo<CampaignBanner, $this>
*/
public function campaignBanner(): BelongsTo
{
return $this->belongsTo(CampaignBanner::class);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Schedule.php | Campaign/extensions/campaign-module/src/Schedule.php | <?php
namespace Remp\CampaignModule;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Spatie\Searchable\Searchable;
use Spatie\Searchable\SearchResult;
class Schedule extends Model
{
const STATUS_READY = 'ready';
const STATUS_EXECUTED = 'executed';
const STATUS_PAUSED = 'paused';
const STATUS_STOPPED = 'stopped';
public $fillable = [
'campaign_id',
'start_time',
'end_time',
];
public $attributes = [
'status' => self::STATUS_READY,
];
public $casts = [
'start_time' => 'datetime',
'end_time' => 'datetime',
];
public $dates = [
'start_time',
'end_time',
];
protected $dateFormat = 'Y-m-d H:i:s';
/**
* @return BelongsTo<Campaign, $this>
*/
public function campaign(): BelongsTo
{
return $this->belongsTo(Campaign::class);
}
public function setStartTimeAttribute($value)
{
if (!$value) {
return;
}
$this->attributes['start_time'] = new Carbon($value);
}
public function setEndTimeAttribute($value)
{
if (!$value) {
$this->attributes['end_time'] = null;
return;
}
$this->attributes['end_time'] = new Carbon($value);
}
public function isRunning()
{
if ($this->status === self::STATUS_EXECUTED && $this->endsInFuture()) {
return true;
}
if ($this->start_time < Carbon::now() &&
$this->endsInFuture() &&
$this->status === self::STATUS_READY
) {
return true;
}
return false;
}
public function isRunnable()
{
if (!$this->endsInFuture()) {
return false;
}
if ($this->status === self::STATUS_READY && $this->start_time > Carbon::now()) {
return true;
}
if ($this->status === self::STATUS_PAUSED) {
return true;
}
return false;
}
public function isEditable()
{
if ($this->start_time > Carbon::now() && $this->status === self::STATUS_READY) {
return true;
}
return false;
}
public function isStopped()
{
return $this->status === self::STATUS_STOPPED || ($this->end_time !== null && $this->end_time < Carbon::now());
}
public function isPaused()
{
return $this->status === self::STATUS_PAUSED;
}
public function endsInFuture()
{
return !$this->end_time || $this->end_time > Carbon::now();
}
/** Scopes */
public function scopeRunning(Builder $query): Builder
{
return $query
->whereIn('status', [self::STATUS_READY, self::STATUS_EXECUTED])
->where('start_time', '<=', Carbon::now())
->where(
function (Builder $endTimeQuery) {
$endTimeQuery
->whereNull('end_time')
->orWhere('end_time', '>=', Carbon::now());
}
);
}
public function scopeRunningOrPlanned(Builder $query): Builder
{
return $query
->whereIn('status', [self::STATUS_READY, self::STATUS_EXECUTED])
->where(
function (Builder $endTimeQuery) {
$endTimeQuery
->whereNull('end_time')
->orWhere('end_time', '>=', Carbon::now());
}
);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/ShortMessageTemplate.php | Campaign/extensions/campaign-module/src/ShortMessageTemplate.php | <?php
namespace Remp\CampaignModule;
use Database\Factories\ShortMessageTemplateFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class ShortMessageTemplate extends AbstractTemplate
{
/** @use HasFactory<ShortMessageTemplateFactory> */
use HasFactory;
protected $fillable = [
'text',
'color_scheme',
];
protected $attributes = [
'color_scheme' => 'grey',
];
protected $snippetFields = [
'text',
];
protected static function newFactory(): ShortMessageTemplateFactory
{
return ShortMessageTemplateFactory::new();
}
/**
* Text should return textual representation of the banner's main text in the cleanest possible form.
* @return mixed
*/
public function text()
{
return strip_tags($this->text);
}
/**
* @return BelongsTo<Banner, $this>
*/
public function banner(): BelongsTo
{
return $this->belongsTo(Banner::class);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/CampaignSegment.php | Campaign/extensions/campaign-module/src/CampaignSegment.php | <?php
namespace Remp\CampaignModule;
use Database\Factories\CampaignSegmentFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class CampaignSegment extends Model
{
/** @use HasFactory<CampaignSegmentFactory> */
use HasFactory;
protected $appends = ['name', 'group'];
protected $fillable = [
'id',
'code',
'provider',
'inclusive',
'campaign_id'
];
public $name;
public $group;
protected static function newFactory(): CampaignSegmentFactory
{
return CampaignSegmentFactory::new();
}
/**
* @return BelongsTo<Campaign, $this>
*/
public function campaign(): BelongsTo
{
return $this->belongsTo(Campaign::class);
}
public function getNameAttribute()
{
return $this->name;
}
public function getGroupAttribute()
{
return $this->group;
}
public function getOverrides()
{
return [
'rtm_campaign' => $this->campaign->uuid,
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/CampaignBannerStats.php | Campaign/extensions/campaign-module/src/CampaignBannerStats.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class CampaignBannerStats extends Model
{
public $timestamps = false;
protected $table = 'campaign_banner_stats';
protected $fillable = [
'campaign_banner_id',
'time_from',
'time_to',
'click_count',
'show_count',
'payment_count',
'purchase_count',
];
protected $dates = [
'time_from',
'time_to',
];
/**
* @return BelongsTo<CampaignBanner, $this>
*/
public function campaignBanner(): BelongsTo
{
return $this->belongsTo(CampaignBanner::class);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Banner.php | Campaign/extensions/campaign-module/src/Banner.php | <?php
namespace Remp\CampaignModule;
use Database\Factories\BannerFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Notifications\Notifiable;
use Illuminate\Support\Facades\Redis;
use Illuminate\Support\Str;
use Predis\ClientInterface;
use Ramsey\Uuid\Uuid;
use Remp\CampaignModule\Concerns\HasCacheableRelation;
use Spatie\Searchable\Searchable;
use Spatie\Searchable\SearchResult;
class Banner extends Model implements Searchable
{
/** @use HasFactory<BannerFactory> */
use HasFactory;
use HasCacheableRelation;
use Notifiable;
use IdentificationTrait;
private const BANNER_TAG = 'banner';
private const BANNER_JSON_TAG = 'banner_json';
public const POSITION_TOP_LEFT = 'top_left';
public const POSITION_TOP_RIGHT = 'top_right';
public const POSITION_BOTTOM_LEFT = 'bottom_left';
public const POSITION_BOTTOM_RIGHT = 'bottom_right';
public const DISPLAY_TYPE_INLINE = 'inline';
public const DISPLAY_TYPE_OVERLAY = 'overlay';
public const TEMPLATE_HTML = 'html';
public const TEMPLATE_MEDIUM_RECTANGLE = 'medium_rectangle';
public const TEMPLATE_OVERLAY_RECTANGLE = 'overlay_rectangle';
public const TEMPLATE_HTML_OVERLAY = 'html_overlay';
public const TEMPLATE_BAR = 'bar';
public const TEMPLATE_COLLAPSIBLE_BAR = 'collapsible_bar';
public const TEMPLATE_SHORT_MESSAGE = 'short_message';
public const TEMPLATE_OVERLAY_TWO_BUTTONS_SIGNATURE = 'overlay_two_buttons_signature';
public const TEMPLATE_NEWSLETTER_RECTANGLE = 'newsletter_rectangle';
protected $fillable = [
'name',
'target_url',
'position',
'offset_vertical',
'offset_horizontal',
'transition',
'closeable',
'close_text',
'display_delay',
'close_timeout',
'display_type',
'target_selector',
'template',
'js',
'js_includes',
'css_includes',
'manual_events_tracking',
];
protected $casts = [
'closeable' => 'boolean',
'manual_events_tracking' => 'boolean',
'js_includes' => 'array',
'css_includes' => 'array',
];
protected $dateFormat = 'Y-m-d H:i:s';
protected $cacheableRelations = [
'htmlTemplate' => HtmlTemplate::class,
'mediumRectangleTemplate' => MediumRectangleTemplate::class,
'barTemplate' => BarTemplate::class,
'collapsibleBarTemplate' => CollapsibleBarTemplate::class,
'shortMessageTemplate' => ShortMessageTemplate::class,
'overlayRectangleTemplate' => OverlayRectangleTemplate::class,
'htmlOverlayTemplate' => HtmlOverlayTemplate::class,
'overlayTwoButtonsSignatureTemplate' => OverlayTwoButtonsSignatureTemplate::class,
'newsletterRectangleTemplate' => NewsletterRectangleTemplate::class,
];
protected static function newFactory(): BannerFactory
{
return BannerFactory::new();
}
public function getSearchResult(): SearchResult
{
return new SearchResult($this, $this->name);
}
protected static function boot()
{
parent::boot();
static::creating(function (Banner $banner) {
$banner->uuid = self::generateUuid();
$banner->public_id = self::generatePublicId();
});
}
public function fill(array $attributes)
{
parent::fill($attributes);
return $this->template ? $this->fillTemplate($attributes) : $this;
}
/**
* Fill banner's template relation
*
* If template relation doesn't exists it's using:
* string $this->getTemplateRelationName()
* to initialize relation.
*
* @param array $attributes
* @return $this
* @throws \Exception
*/
public function fillTemplate(array $attributes)
{
$relationName = $this->getTemplateRelationName();
// fill existing related model
if (!is_null($this->id)) {
$this->getRelationValue($relationName)->fill($attributes);
// create and fill relation
} else {
$this->setRelation(
$relationName,
$this->getTemplateRelation($relationName)->make($attributes)
);
}
return $this;
}
/**
* load template
*
* @return $this
* @throws \Exception
*/
public function loadTemplate()
{
return $this->load($this->getTemplateRelationName());
}
/**
* @return BelongsToMany<Campaign, $this>
*/
public function campaigns(): BelongsToMany
{
return $this->belongsToMany(Campaign::class, 'campaign_banners')->whereNull('deleted_at');
}
/**
* @return HasOne<HtmlTemplate, $this>
*/
public function htmlTemplate(): HasOne
{
return $this->hasOne(HtmlTemplate::class);
}
/**
* @return HasOne<MediumRectangleTemplate, $this>
*/
public function mediumRectangleTemplate(): HasOne
{
return $this->hasOne(MediumRectangleTemplate::class);
}
/**
* @return HasOne<OverlayRectangleTemplate, $this>
*/
public function overlayRectangleTemplate(): HasOne
{
return $this->hasOne(OverlayRectangleTemplate::class);
}
/**
* @return HasOne<HtmlOverlayTemplate, $this>
*/
public function htmlOverlayTemplate(): HasOne
{
return $this->hasOne(HtmlOverlayTemplate::class);
}
/**
* @return HasOne<OverlayTwoButtonsSignatureTemplate, $this>
*/
public function overlayTwoButtonsSignatureTemplate(): HasOne
{
return $this->hasOne(OverlayTwoButtonsSignatureTemplate::class);
}
/**
* @return HasOne<BarTemplate, $this>
*/
public function barTemplate(): HasOne
{
return $this->hasOne(BarTemplate::class);
}
/**
* @return HasOne<CollapsibleBarTemplate, $this>
*/
public function collapsibleBarTemplate(): HasOne
{
return $this->hasOne(CollapsibleBarTemplate::class);
}
/**
* @return HasOne<ShortMessageTemplate, $this>
*/
public function shortMessageTemplate(): HasOne
{
return $this->hasOne(ShortMessageTemplate::class);
}
/**
* @return HasOne<NewsletterRectangleTemplate, $this>
*/
public function newsletterRectangleTemplate(): HasOne
{
return $this->hasOne(NewsletterRectangleTemplate::class);
}
public function getTemplateRelationName()
{
switch ($this->template) {
case self::TEMPLATE_HTML:
return 'htmlTemplate';
case self::TEMPLATE_MEDIUM_RECTANGLE:
return 'mediumRectangleTemplate';
case self::TEMPLATE_BAR:
return 'barTemplate';
case self::TEMPLATE_COLLAPSIBLE_BAR:
return 'collapsibleBarTemplate';
case self::TEMPLATE_SHORT_MESSAGE:
return 'shortMessageTemplate';
case self::TEMPLATE_OVERLAY_RECTANGLE:
return 'overlayRectangleTemplate';
case self::TEMPLATE_HTML_OVERLAY:
return 'htmlOverlayTemplate';
case self::TEMPLATE_OVERLAY_TWO_BUTTONS_SIGNATURE:
return 'overlayTwoButtonsSignatureTemplate';
case self::TEMPLATE_NEWSLETTER_RECTANGLE:
return 'newsletterRectangleTemplate';
default:
throw new \Exception('Unhandled banner template access: ' . $this->template);
}
}
/**
* Returns banner template relation
*
* Using $this->getTemplateRelationName()
* to return template relation.
*
* @param string $relationName
* @return HasOne
* @throws \Exception
*/
public function getTemplateRelation($relationName = null): HasOne
{
if ($relationName === null) {
$relationName = $this->getTemplateRelationName();
}
return $this->$relationName();
}
public function getTemplate(): AbstractTemplate
{
return $this->getRelationValue($this->getTemplateRelationName());
}
public function cache()
{
$bannerTemplate = $this->loadTemplate();
Redis::set(self::BANNER_JSON_TAG . ":{$this->id}", $bannerTemplate->toJson());
}
public static function loadCachedBanner(ClientInterface $redis, string $bannerId): ?Banner
{
$serializedBanner = $redis->get(Banner::BANNER_TAG . ":$bannerId");
if ($serializedBanner) {
return unserialize($serializedBanner, [__CLASS__]);
}
return null;
}
public function getUsedSnippetCodes(): array
{
$allSnippets = [];
$processedSnippets = [];
$snippetsToProcess = [];
// Extract snippets from banner's JS
if ($this->js) {
$snippetsToProcess = array_merge($snippetsToProcess, $this->extractSnippetCodes($this->js));
}
$jsIncludes = array_filter($this->js_includes ?? []);
foreach ($jsIncludes as $jsInclude) {
$snippetsToProcess = array_merge($snippetsToProcess, $this->extractSnippetCodes($jsInclude));
}
$cssIncludes = array_filter($this->css_includes ?? []);
foreach ($cssIncludes as $cssInclude) {
$snippetsToProcess = array_merge($snippetsToProcess, $this->extractSnippetCodes($cssInclude));
}
// Extract snippets from template text and CSS fields
$snippetsToProcess = array_merge($snippetsToProcess, $this->extractSnippetsFromTemplate());
// Check if snippets use another snippets
while (!empty($snippetsToProcess)) {
$currentSnippet = array_shift($snippetsToProcess);
if (in_array($currentSnippet, $processedSnippets, true)) {
continue;
}
$processedSnippets[] = $currentSnippet;
$allSnippets[] = $currentSnippet;
$snippet = Snippet::where('name', $currentSnippet)->first();
if ($snippet && $snippet->value) {
// Extract nested snippets from this snippet's value
$nestedSnippets = $this->extractSnippetCodes($snippet->value);
// Add new nested snippets to processing queue
foreach ($nestedSnippets as $nestedSnippet) {
if (!in_array($nestedSnippet, $processedSnippets, true)) {
$snippetsToProcess[] = $nestedSnippet;
}
}
}
}
return $allSnippets;
}
private function extractSnippetCodes(string $content): array
{
$matches = [];
$matched = preg_match_all('/{{\s?(.*?)\s?}}/', $content, $matches, PREG_PATTERN_ORDER);
if (is_int($matched) && $matched > 0) {
return $matches[1];
}
return [];
}
private function extractSnippetsFromTemplate(): array
{
$snippets = [];
$template = $this->getTemplate();
foreach ($template->getSnippetFields() as $field) {
if (isset($template->$field)) {
$snippets = array_merge($snippets, $this->extractSnippetCodes($template->$field));
}
}
return $snippets;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/NewsletterRectangleTemplate.php | Campaign/extensions/campaign-module/src/NewsletterRectangleTemplate.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class NewsletterRectangleTemplate extends AbstractTemplate
{
protected $fillable = [
'newsletter_id',
'btn_submit',
'title',
'text',
'success',
'failure',
'terms',
'width',
'height',
'color_scheme',
];
protected $attributes = [
'color_scheme' => 'grey',
];
protected $snippetFields = [
'title',
'text',
];
public $banner_config = [];
protected $appends = [
'endpoint',
'use_xhr',
'request_body',
'request_headers',
'params_transposition',
'params_extra',
'remp_mailer_addr'
];
public function getEndpointAttribute()
{
return $this->attributes['endpoint'] ?? $this->getConfig('endpoint');
}
public function getUseXhrAttribute()
{
return $this->attributes['use_xhr'] ?? $this->getConfig('use_xhr');
}
public function getRequestBodyAttribute()
{
return $this->attributes['request_body'] ?? $this->getConfig('request_body');
}
public function getRequestHeadersAttribute()
{
return $this->attributes['request_headers'] ?? $this->getConfig('request_headers');
}
public function getParamsTranspositionAttribute()
{
return $this->attributes['params_transposition'] ?? $this->getConfig('params_transposition');
}
public function getParamsExtraAttribute()
{
return $this->attributes['params_extra'] ?? $this->getConfig('params_extra');
}
public function getRempMailerAddrAttribute()
{
return $this->attributes['remp_mailer_addr'] ?? $this->getConfig('remp_mailer_addr');
}
/**
* @return BelongsTo<Banner, $this>
*/
public function banner(): BelongsTo
{
return $this->belongsTo(Banner::class);
}
/**
* Text should return textual representation of the banner's main text in the cleanest possible form.
* @return mixed
*/
public function text()
{
return strip_tags("({$this->newsletter_id}) {$this->title} -- {$this->text}");
}
private function getConfig($key)
{
if (empty($this->banner_config)) {
$this->banner_config = [
'endpoint' => config('newsletter_banners.endpoint'),
'use_xhr' => config('newsletter_banners.use_xhr'),
'request_body' => config('newsletter_banners.request_body'),
'request_headers' => config('newsletter_banners.request_headers'),
'params_transposition' => config('newsletter_banners.params_transposition'),
'params_extra' => config('newsletter_banners.params_extra'),
'remp_mailer_addr' => config('services.remp.mailer.web_addr')
];
}
return $this->banner_config[$key] ?? null;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/MediumRectangleTemplate.php | Campaign/extensions/campaign-module/src/MediumRectangleTemplate.php | <?php
namespace Remp\CampaignModule;
use Database\Factories\MediumRectangleTemplateFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class MediumRectangleTemplate extends AbstractTemplate
{
/** @use HasFactory<MediumRectangleTemplateFactory> */
use HasFactory;
protected $fillable = [
'header_text',
'main_text',
'button_text',
'width',
'height',
'color_scheme',
];
protected $attributes = [
'color_scheme' => 'grey',
];
protected $snippetFields = [
'header_text',
'main_text',
'button_text',
];
protected static function newFactory(): MediumRectangleTemplateFactory
{
return MediumRectangleTemplateFactory::new();
}
/**
* @return BelongsTo<Banner, $this>
*/
public function banner(): BelongsTo
{
return $this->belongsTo(Banner::class);
}
/**
* Text should return textual representation of the banner's main text in the cleanest possible form.
* @return mixed
*/
public function text()
{
return strip_tags("{$this->main_text} -- {$this->button_text}");
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Country.php | Campaign/extensions/campaign-module/src/Country.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Database\Eloquent\Model;
class Country extends Model
{
protected $primaryKey = 'iso_code';
protected $keyType = 'string';
public $incrementing = false;
public $timestamps = false;
protected $fillable = [
'iso_code',
'name',
];
protected $casts = [
'iso_code' => 'string',
'name' => 'string',
];
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/CollapsibleBarTemplate.php | Campaign/extensions/campaign-module/src/CollapsibleBarTemplate.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class CollapsibleBarTemplate extends AbstractTemplate
{
protected $fillable = [
'main_text',
'header_text',
'collapse_text',
'expand_text',
'button_text',
'initial_state',
'force_initial_state',
'color_scheme',
];
protected $attributes = [
'color_scheme' => 'grey',
];
protected $snippetFields = [
'main_text',
'button_text',
];
/**
* Text should return textual representation of the banner's main text in the cleanest possible form.
* @return mixed
*/
public function text()
{
return strip_tags("{$this->main_text} -- {$this->button_text}");
}
/**
* @return BelongsTo<Banner, $this>
*/
public function banner(): BelongsTo
{
return $this->belongsTo(Banner::class);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/BarTemplate.php | Campaign/extensions/campaign-module/src/BarTemplate.php | <?php
namespace Remp\CampaignModule;
use Database\Factories\BarTemplateFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class BarTemplate extends AbstractTemplate
{
/** @use HasFactory<BarTemplateFactory> */
use HasFactory;
protected $fillable = [
'main_text',
'button_text',
'color_scheme',
];
protected $attributes = [
'color_scheme' => 'grey',
];
protected $snippetFields = [
'main_text',
'button_text',
];
protected static function newFactory(): BarTemplateFactory
{
return BarTemplateFactory::new();
}
/**
* @return BelongsTo<Banner, $this>
*/
public function banner(): BelongsTo
{
return $this->belongsTo(Banner::class);
}
/**
* Text should return textual representation of the banner's main text in the cleanest possible form.
* @return mixed
*/
public function text()
{
return strip_tags("{$this->main_text} -- {$this->button_text}");
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Scheduler.php | Campaign/extensions/campaign-module/src/Scheduler.php | <?php
namespace Remp\CampaignModule;
use Remp\CampaignModule\Console\Commands\AggregateCampaignStats;
use Remp\CampaignModule\Jobs\CacheSegmentJob;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Support\Carbon;
class Scheduler
{
public function schedule(Schedule $schedule)
{
// Collect campaign stats if Beam Journal is configured
$beamJournalConfigured = !empty(config('services.remp.beam.segments_addr'));
if ($beamJournalConfigured) {
$schedule->command(AggregateCampaignStats::COMMAND)
->everyMinute()
->withoutOverlapping(config('system.commands_overlapping_expires_at'))
->appendOutputTo(storage_path('logs/aggregate_campaign_stats.log'));
}
// invalidate segments cache
try {
$campaigns = \Remp\CampaignModule\Campaign::selectRaw('campaigns.*')
->join('schedules', 'campaigns.id', '=', 'campaign_id')
->where(function (\Illuminate\Database\Eloquent\Builder $query) {
$query
->whereNull('end_time')
->orWhere('end_time', '>=', Carbon::now());
})
->whereIn('status', [\Remp\CampaignModule\Schedule::STATUS_READY, \Remp\CampaignModule\Schedule::STATUS_EXECUTED, \Remp\CampaignModule\Schedule::STATUS_PAUSED])->cursor();
/** @var \Remp\CampaignModule\Campaign $campaign */
foreach ($campaigns as $campaign) {
foreach ($campaign->segments as $campaignSegment) {
$schedule->job(new CacheSegmentJob($campaignSegment, true))
->hourly()
->withoutOverlapping(config('system.commands_overlapping_expires_at'))
->appendOutputTo(storage_path('logs/cache_segments.log'));
$schedule->job(new CacheSegmentJob($campaignSegment, false))
->everyMinute()
->withoutOverlapping(config('system.commands_overlapping_expires_at'))
->appendOutputTo(storage_path('logs/cache_segments.log'));
}
}
} catch (\PDOException $e) {
// no action, the tables are not ready yet
}
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/AbstractTemplate.php | Campaign/extensions/campaign-module/src/AbstractTemplate.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
abstract class AbstractTemplate extends Model
{
protected $touches = [
'banner',
];
protected $dateFormat = 'Y-m-d H:i:s';
/**
* @var array<string>
*/
protected $snippetFields = [];
public function getSnippetFields(): array
{
return $this->snippetFields;
}
/**
* @return BelongsTo<Banner, $this>
*/
public function banner(): BelongsTo
{
return $this->belongsTo(Banner::class);
}
/**
* Text should return textual representation of the banner's main text in the cleanest possible form.
* @return mixed
*/
abstract public function text();
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/IdentificationTrait.php | Campaign/extensions/campaign-module/src/IdentificationTrait.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Support\Str;
use Ramsey\Uuid\Uuid;
trait IdentificationTrait
{
public static function generateUuid(): string
{
return Uuid::uuid4()->toString();
}
public static function generatePublicId(): string
{
return Str::random(6);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/CampaignBanner.php | Campaign/extensions/campaign-module/src/CampaignBanner.php | <?php
namespace Remp\CampaignModule;
use Database\Factories\CampaignBannerFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\SoftDeletes;
use Remp\CampaignModule\Concerns\HasCacheableRelation;
class CampaignBanner extends Model
{
/** @use HasFactory<CampaignBannerFactory> */
use HasFactory;
use HasCacheableRelation;
use SoftDeletes;
use IdentificationTrait;
protected $table = 'campaign_banners';
public $timestamps = false;
protected $fillable = [
'id',
'campaign_id',
'banner_id',
'control_group',
'proportion',
'weight',
];
protected $cacheableRelations = [
'banner' => Banner::class,
];
protected static function newFactory(): CampaignBannerFactory
{
return CampaignBannerFactory::new();
}
protected static function boot()
{
parent::boot();
static::creating(function (CampaignBanner $variant) {
$variant->uuid = self::generateUuid();
$variant->public_id = self::generatePublicId();
});
}
/**
* @return BelongsTo<Banner, $this>
*/
public function banner(): BelongsTo
{
return $this->belongsTo(Banner::class);
}
/**
* @return BelongsTo<Campaign, $this>
*/
public function campaign(): BelongsTo
{
return $this->belongsTo(Campaign::class);
}
/**
* This method overrides Laravel's default replicate method
* it's removing unique & constraint attributes (uuid, campaign_id)
*
* @param array|null $except
* @return CampaignBanner
*/
public function replicate(array $except = null)
{
$replica = parent::replicate($except);
unset($replica['uuid']);
unset($replica['campaign_id']);
return $replica;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/HtmlOverlayTemplate.php | Campaign/extensions/campaign-module/src/HtmlOverlayTemplate.php | <?php
namespace Remp\CampaignModule;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class HtmlOverlayTemplate extends AbstractTemplate
{
protected $fillable = [
'text',
'css',
'text_align',
'font_size',
'text_color',
'background_color',
];
protected $snippetFields = [
'text',
'css',
];
public function text()
{
return strip_tags($this->text);
}
/**
* @return BelongsTo<Banner, $this>
*/
public function banner(): BelongsTo
{
return $this->belongsTo(Banner::class);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Jobs/CacheSegmentJob.php | Campaign/extensions/campaign-module/src/Jobs/CacheSegmentJob.php | <?php
namespace Remp\CampaignModule\Jobs;
use Remp\CampaignModule\CampaignSegment;
use Remp\CampaignModule\Contracts\SegmentAggregator;
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Support\Facades\Redis;
use Log;
class CacheSegmentJob implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
private $campaignSegment;
private $force;
/**
* Create a new job instance.
*
* @param CampaignSegment $campaignSegment
* @param bool $force
*/
public function __construct(CampaignSegment $campaignSegment, $force = false)
{
$this->campaignSegment = $campaignSegment;
$this->force = $force;
}
/**
* Execute the job.
*
* @param SegmentAggregator $segmentAggregator
*/
public function handle(SegmentAggregator $segmentAggregator)
{
$cacheKey = $segmentAggregator::cacheKey($this->campaignSegment);
$cacheTimestampKey = "{$cacheKey}|timestamp";
if (!$this->force && Redis::connection()->get($cacheTimestampKey)) {
return;
}
if (!$segmentAggregator->cacheEnabled($this->campaignSegment)) {
return;
}
try {
$users = $segmentAggregator->users($this->campaignSegment);
} catch (\Exception $e) {
Log::error($e->getMessage(), [
'provider' => $this->campaignSegment->provider,
'code' => $this->campaignSegment->code,
]);
throw $e;
}
$redis = Redis::connection()->client();
$redis->setex($cacheTimestampKey, 60*60*24, date('U'));
$redis->del([$cacheKey]);
if ($users->isNotEmpty()) {
$userChunks = array_chunk($users->toArray(), config('redis.redis_parameter_limit'));
foreach ($userChunks as $users) {
if ($redis instanceof \Redis) {
$redis->sAdd($cacheKey, ...$users);
} else {
$redis->sadd($cacheKey, $users);
}
}
$redis->expire($cacheKey, 60*60*24);
}
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Requests/CollectionRequest.php | Campaign/extensions/campaign-module/src/Http/Requests/CollectionRequest.php | <?php
namespace Remp\CampaignModule\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class CollectionRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'name' => 'required|max:255',
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Requests/ScheduleRequest.php | Campaign/extensions/campaign-module/src/Http/Requests/ScheduleRequest.php | <?php
namespace Remp\CampaignModule\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class ScheduleRequest extends FormRequest
{
public function authorize()
{
return true;
}
public function rules()
{
return [
'campaign_id' => 'required|integer',
'start_time' => 'required|date',
'end_time' => 'nullable|date|after:start_time'
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Requests/SearchRequest.php | Campaign/extensions/campaign-module/src/Http/Requests/SearchRequest.php | <?php
namespace Remp\CampaignModule\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class SearchRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'term' => 'required|string'
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Requests/CampaignRequest.php | Campaign/extensions/campaign-module/src/Http/Requests/CampaignRequest.php | <?php
namespace Remp\CampaignModule\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
use Remp\CampaignModule\Rules\VariantsProportionSum;
class CampaignRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'name' => 'required|max:255',
'active' => 'boolean|required',
'banner_id' => 'required|integer',
'signed_in' => 'boolean|nullable',
'using_adblock' => 'boolean|nullable',
'once_per_session' => 'boolean|required',
'segments.*.provider' => 'required|string',
'segments.*.code' => 'required|string',
'segments.*.inclusive' => 'required|boolean',
'pageview_rules.display_banner' => 'required|string',
'pageview_rules.display_banner_every' => 'required|integer',
'pageview_rules.display_times' => 'required',
'pageview_rules.display_n_times' => 'required|integer',
'pageview_rules.after_banner_closed_display' => 'required|string',
'pageview_rules.after_closed_hours' => 'required|integer',
'pageview_rules.after_banner_clicked_display' => 'required|string',
'pageview_rules.after_clicked_hours' => 'required|integer',
'pageview_attributes.*.name' => 'required|string',
'pageview_attributes.*.operator' => 'required|string',
'pageview_attributes.*.value' => 'required|string',
'url_patterns.*' => 'string',
'source_patterns.*' => 'string',
'devices.0' => 'required',
'variants.*.proportion' => 'integer|required|min:0|max:100',
'variants.*.control_group' => 'integer|required',
'variants.*.weight' => 'integer|required',
'variants.*.banner_id' => 'required_unless:variants.*.control_group,1',
'variants.0.proportion' => ['integer', 'required', new VariantsProportionSum]
];
}
/**
* Prepare inputs for validation.
*
* @return void
*/
protected function prepareForValidation()
{
$this->merge([
'signed_in' => $this->input('signed_in') !== null ? $this->boolean('signed_in') : null,
'using_adblock' => $this->input('using_adblock') !== null ? $this->boolean('using_adblock') : null,
]);
$segments = $this->input('segments');
if (is_array($segments)) {
$processedSegments = [];
foreach ($segments as $key => $segment) {
if (isset($segment['inclusive'])) {
$segment['inclusive'] = $this->boolean("segments.{$key}.inclusive");
}
$processedSegments[$key] = $segment;
}
$this->merge([
'segments' => $processedSegments,
]);
}
}
public function all($keys = null)
{
$data = parent::all($keys);
if (!isset($data['signed_in'])) {
$data['signed_in'] = null;
}
if (!isset($data['using_adblock'])) {
$data['using_adblock'] = null;
}
if (!isset($data['pageview_rules']['display_times'])) {
$data['pageview_rules']['display_times'] = false;
}
if (!isset($data['languages'])) {
$data['languages'] = null;
}
if (is_array($data['url_patterns'])) {
$data['url_patterns'] = array_values(array_filter($data['url_patterns']));
}
if (is_array($data['source_patterns'])) {
$data['source_patterns'] = array_values(array_filter($data['source_patterns']));
}
$data['pageview_rules']['display_times'] = filter_var(
$data['pageview_rules']['display_times'],
FILTER_VALIDATE_BOOLEAN,
['options' => ['default' => false]]
);
$data['pageview_rules']['display_banner_every'] = filter_var(
$data['pageview_rules']['display_banner_every'],
FILTER_VALIDATE_INT,
['options' => ['default' => 2]]
);
$data['pageview_rules']['display_n_times'] = filter_var(
$data['pageview_rules']['display_n_times'],
FILTER_VALIDATE_INT,
['options' => ['default' => 2]]
);
$data['pageview_rules']['after_closed_hours'] = filter_var(
$data['pageview_rules']['after_closed_hours'],
FILTER_VALIDATE_INT,
['options' => ['default' => 2]]
);
$data['pageview_rules']['after_clicked_hours'] = filter_var(
$data['pageview_rules']['after_clicked_hours'],
FILTER_VALIDATE_INT,
['options' => ['default' => 2]]
);
$data['active'] = $this->getInputSource()->getBoolean('active', false);
$data['once_per_session'] = $this->getInputSource()->getBoolean('once_per_session', false);
return $data;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Requests/SnippetRequest.php | Campaign/extensions/campaign-module/src/Http/Requests/SnippetRequest.php | <?php
namespace Remp\CampaignModule\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rule;
class SnippetRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
public function rules()
{
return [
'name' => [
"required",
Rule::unique("snippets", "name")->ignore($this->snippet->id ?? null)
],
'value' => 'required',
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Requests/DataTable.php | Campaign/extensions/campaign-module/src/Http/Requests/DataTable.php | <?php
namespace Remp\CampaignModule\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class DataTable extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'order.0.column',
'order.0.dir',
'start',
'length',
'search.value',
'start',
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Requests/SegmentCacheRequest.php | Campaign/extensions/campaign-module/src/Http/Requests/SegmentCacheRequest.php | <?php
namespace Remp\CampaignModule\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class SegmentCacheRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'segment_provider' => 'required|string',
'segment_code' => 'required|string',
'user_id' => 'required|integer',
];
}
/**
* Prepare the data for validation.
*
* @return void
*/
public function prepareForValidation()
{
// add route parameters into form request for validation
$this->merge([
'segment_provider' => $this->route('segment_provider'),
'segment_code' => $this->route('segment_code'),
]);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Requests/BannerOneTimeDisplayRequest.php | Campaign/extensions/campaign-module/src/Http/Requests/BannerOneTimeDisplayRequest.php | <?php
namespace Remp\CampaignModule\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class BannerOneTimeDisplayRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'user_id' => 'required_without:browser_id',
'browser_id' => 'required_without:user_id',
'expires_at' => 'required|date|after:now'
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Requests/BannerRequest.php | Campaign/extensions/campaign-module/src/Http/Requests/BannerRequest.php | <?php
namespace Remp\CampaignModule\Http\Requests;
use Remp\CampaignModule\Banner;
use Remp\CampaignModule\Rules\ContainsHtmlLink;
use Illuminate\Foundation\Http\FormRequest;
use Validator;
class BannerRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize()
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules()
{
return [
'name' => 'required|max:255',
'target_url' => 'nullable|url',
'position' => 'nullable|in:top_left,top_right,bottom_left,bottom_right',
'transition' => 'required|string',
'display_type' => 'string|required|in:overlay,inline',
'display_delay' => 'nullable|integer|required|required_if:display_type,overlay',
'close_timeout' => 'nullable|integer',
'closeable' => 'boolean',
'target_selector' => 'nullable|string|required_if:display_type,inline',
'template' => 'required|string',
'offset_vertical' => 'required|integer',
'offset_horizontal' => 'required|integer',
'js_includes' => 'array',
'css_includes' => 'array',
'manual_events_tracking' => 'boolean',
];
}
public function withValidator(\Illuminate\Validation\Validator $validator)
{
$validator->after(function (\Illuminate\Validation\Validator $validator) {
$templateType = $this->get('template');
switch ($templateType) {
case Banner::TEMPLATE_HTML:
$templateValidator = Validator::make($this->all(), [
'text' => 'required',
'text_align' => 'required',
'text_color' => 'required',
'background_color' => 'required',
'font_size' => 'required',
'dimensions' => 'required',
]);
break;
case Banner::TEMPLATE_MEDIUM_RECTANGLE:
$templateValidator = Validator::make($this->all(), [
'color_scheme' => 'string|required',
'header_text' => 'string|nullable',
'main_text' => 'string|nullable',
'button_text' => 'string|nullable',
'width' => 'string|nullable',
'height' => 'string|nullable',
]);
break;
case Banner::TEMPLATE_OVERLAY_RECTANGLE:
$templateValidator = Validator::make($this->all(), [
'color_scheme' => 'string|required',
'header_text' => 'string|nullable',
'main_text' => 'string|nullable',
'button_text' => 'string|nullable',
'width' => 'string|nullable',
'height' => 'string|nullable',
'image_link' => 'string|nullable',
]);
break;
case Banner::TEMPLATE_OVERLAY_TWO_BUTTONS_SIGNATURE:
$templateValidator = Validator::make($this->all(), [
'text_before' => 'string|nullable',
'text_after' => 'string|nullable',
'text_btn_primary' => 'string|required',
'text_btn_primary_minor' => 'string|nullable',
'text_btn_secondary' => 'string|nullable',
'text_btn_secondary_minor' => 'string|nullable',
'target_url_secondary' => 'string|nullable',
'signature_image_url' => 'string|nullable',
'text_signature' => 'string|nullable'
]);
break;
case Banner::TEMPLATE_BAR:
$templateValidator = Validator::make($this->all(), [
'color_scheme' => 'string|required',
'main_text' => 'string|nullable',
'button_text' => 'string|nullable',
]);
break;
case Banner::TEMPLATE_COLLAPSIBLE_BAR:
$templateValidator = Validator::make($this->all(), [
'color_scheme' => 'string|required',
'header_text' => 'string|nullable',
'collapse_text' => 'string|nullable',
'expand_text' => 'string|nullable',
'main_text' => 'string|nullable',
'button_text' => 'string|nullable',
'initial_state' => 'string|required',
'force_initial_state' => 'boolean',
]);
break;
case Banner::TEMPLATE_SHORT_MESSAGE:
$templateValidator = Validator::make($this->all(), [
'color_scheme' => 'string|required',
'text' => 'string|required',
]);
break;
case Banner::TEMPLATE_HTML_OVERLAY:
$templateValidator = Validator::make($this->all(), [
'text' => 'required',
'text_color' => 'required',
'background_color' => 'required',
]);
break;
case Banner::TEMPLATE_NEWSLETTER_RECTANGLE:
$templateValidator = Validator::make($this->all(), [
'color_scheme' => 'string|required',
'newsletter_id' => 'string|required',
'btn_submit' => 'string|required',
'title' => 'string|nullable',
'text' => 'string|nullable',
'success' => 'string|nullable',
'failure' => 'string|nullable',
'terms' => ['required', 'string', new ContainsHtmlLink()],
]);
break;
default:
throw new \Exception('unhandled template type: ' . $templateType);
}
$templateValidator->validate();
});
}
public function all($keys = null)
{
$result = parent::all($keys);
if (!isset($result['manual_events_tracking'])) {
$result['manual_events_tracking'] = false;
}
if (!isset($result['closeable'])) {
$result['closeable'] = false;
}
if (!isset($result['force_initial_state'])) {
$result['force_initial_state'] = false;
}
return $result;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/SnippetController.php | Campaign/extensions/campaign-module/src/Http/Controllers/SnippetController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Remp\CampaignModule\Http\Requests\SnippetRequest;
use Remp\CampaignModule\Http\Resources\SnippetResource;
use Remp\CampaignModule\Snippet;
use Illuminate\Database\Eloquent\Builder;
use Yajra\DataTables\DataTables;
use Yajra\DataTables\QueryDataTable;
class SnippetController extends Controller
{
public function index()
{
return response()->format([
'html' => view('campaign::snippets.index'),
'json' => SnippetResource::collection(Snippet::paginate()),
]);
}
public function json(DataTables $dataTables)
{
$snippets = Snippet::select();
/** @var QueryDataTable $datatable */
$datatable = $dataTables->of($snippets);
return $datatable
->addColumn('actions', function (Snippet $snippet) {
return [
'edit' => route('snippets.edit', $snippet),
];
})
->addColumn('name', function (Snippet $snippet) {
return [
'url' => route('snippets.edit', ['snippet' => $snippet]),
'text' => $snippet->name,
];
})
->filterColumn('name', function (Builder $query, $value) {
$query->where('snippets.name', 'like', "%{$value}%");
})
->setRowId('id')
->make(true);
}
public function create()
{
return view('campaign::snippets.create', [
'snippet' => new Snippet(),
]);
}
public function edit(Snippet $snippet)
{
return view('campaign::snippets.edit', [
'snippet' => $snippet,
]);
}
public function validateForm(SnippetRequest $request, Snippet $snippet = null)
{
return response()->json(false);
}
public function store(SnippetRequest $request)
{
$snippet = new Snippet();
$snippet->fill($request->all());
$snippet->save();
$message = ['success' => sprintf('Snippet [%s] was created.', $snippet->name)];
return response()->format([
'html' => $this->getRouteBasedOnAction(
$request->get('action'),
[
self::FORM_ACTION_SAVE_CLOSE => 'snippets.index',
self::FORM_ACTION_SAVE => 'snippets.edit',
],
$snippet
)->with($message),
'json' => new SnippetResource($snippet),
]);
}
public function update(SnippetRequest $request, Snippet $snippet)
{
$snippet->fill($request->all());
$snippet->save();
$message = ['success' => sprintf('Snippet [%s] was updated.', $snippet->name)];
return response()->format([
'html' => $this->getRouteBasedOnAction(
$request->get('action'),
[
self::FORM_ACTION_SAVE_CLOSE => 'snippets.index',
self::FORM_ACTION_SAVE => 'snippets.edit',
],
$snippet
)->with($message),
'json' => new SnippetResource($snippet),
]);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/ScheduleController.php | Campaign/extensions/campaign-module/src/Http/Controllers/ScheduleController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Remp\CampaignModule\Campaign;
use Remp\CampaignModule\CampaignBanner;
use Remp\CampaignModule\CampaignCollection;
use Remp\CampaignModule\Http\Requests\ScheduleRequest;
use Remp\CampaignModule\Http\Resources\ScheduleResource;
use Remp\CampaignModule\Schedule;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Remp\LaravelHelpers\Resources\JsonResource;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Yajra\DataTables\DataTables;
use Yajra\DataTables\QueryDataTable;
class ScheduleController extends Controller
{
public function index(CampaignCollection $collection = null)
{
$variants = CampaignBanner::with('banner')
->whereNotNull('banner_id')
->get()
->pluck('banner.name', 'banner.id');
return response()->format([
'html' => view('campaign::schedule.index', [
'variants' => $variants,
'collection' => $collection,
]),
'json' => ScheduleResource::collection(Schedule::paginate()),
]);
}
/**
* Return data for Schedule Datatable.
*
* If `$campaign` is provided, only schedules for that one Campaign are returned.
*
* Request parameters can be used:
*
* * `active` - (bool) display only active (running or planned) schedules.
* * `limit` - (int) count of results will be limited to that number.
*
* @param Datatables $dataTables
* @param Campaign|null $campaign
* @return mixed
* @throws \Exception
*/
public function json(Request $request, Datatables $dataTables, Campaign $campaign = null, CampaignCollection $collection = null)
{
$scheduleSelect = Schedule::select('schedules.*')
->join('campaigns', 'schedules.campaign_id', '=', 'campaigns.id')
->leftJoin('campaign_collections', 'campaigns.id', '=', 'campaign_collections.campaign_id')
->groupBy('schedules.id');
if (!is_null($campaign)) {
$scheduleSelect->where('schedules.campaign_id', '=', $campaign->id);
}
if ($collection) {
$scheduleSelect->where('campaign_collections.collection_id', '=', $collection->id);
}
if ($request->active) {
$scheduleSelect->where(function (\Illuminate\Database\Eloquent\Builder $query) {
$query
->whereNull('end_time')
->orWhere('end_time', '>=', Carbon::now());
})
->whereIn('status', [Schedule::STATUS_READY, Schedule::STATUS_EXECUTED, Schedule::STATUS_PAUSED]);
}
if (is_numeric($request->limit)) {
$scheduleSelect->limit($request->limit);
}
/** @var QueryDataTable $datatable */
$datatable = $dataTables->of($scheduleSelect);
return $datatable
->addColumn('actions', function (Schedule $s) use ($collection) {
return [
'edit' => !$s->isStopped() ? route('schedule.edit', ['schedule' => $s, 'collection' => $collection]) : null,
'start' => $s->isRunnable() ? route('schedule.start', $s) : null,
'pause' => $s->isRunning() ? route('schedule.pause', $s) : null,
'stop' => $s->isRunning() || $s->isPaused() ? route('schedule.stop', $s) : null,
'destroy' => $s->isEditable() ? route('schedule.destroy', $s) : null,
];
})
->addColumn('campaign', function (Schedule $schedule) use ($collection) {
return [
'url' => route('campaigns.edit', ['campaign' => $schedule->campaign, 'collection' => $collection]),
'text' => $schedule->campaign->name,
];
})
->filterColumn('campaign', function (Builder $query, $value) {
$query->whereHas('campaign', function (Builder $query) use ($value) {
$query->where('campaigns.name', 'like', "%{$value}%");
});
})
->addColumn('campaign_public_id', function ($schedule) {
return $schedule->campaign->public_id;
})
->filterColumn('campaign_public_id', function (Builder $query, $value) {
$query->whereHas('campaign', function (Builder $query) use ($value) {
$query->where('campaigns.public_id', $value);
});
})
->orderColumn('campaign', function (Builder $query, $order) {
$query->orderBy('campaigns.name', $order);
})
->addColumn('variants', function (Schedule $schedule) {
$data = $schedule->campaign->campaignBanners->all();
$variants = [];
foreach ($data as $variant) {
$proportion = $variant['proportion'];
if ($proportion === 0) {
continue;
}
if ($variant['control_group'] === 1) {
// handle control group
$variants[] = "Control Group ({$proportion}%)";
continue;
}
// handle variants with banner
$link = html()->a(
href: route('banners.edit', $variant['banner_id']),
contents: $variant->banner->name
);
$variants[] = "{$link} ({$proportion}%)";
}
return $variants;
})
->filterColumn('variants', function (Builder $query, $value) {
$values = explode(',', $value);
$filterQuery = \DB::table('schedules')
->select(['schedules.id'])
->join('campaign_banners', 'campaign_banners.campaign_id', '=', 'schedules.campaign_id')
->whereIn('campaign_banners.banner_id', $values)
->where('campaign_banners.proportion', '>', 0);
$query->whereIn('schedules.id', $filterQuery);
})
->addColumn('action_methods', function (Schedule $schedule) {
return [
'start' => 'POST',
'pause' => 'POST',
'stop' => 'POST',
'destroy' => 'DELETE',
];
})
->addColumn('status', function (Schedule $schedule) {
if ($schedule->isRunning()) {
return [['class' => 'badge-success', 'text' => 'Running']];
}
if ($schedule->status === Schedule::STATUS_PAUSED) {
return [['class' => 'badge-primary', 'text' => 'Paused']];
}
if ($schedule->status === Schedule::STATUS_STOPPED) {
return [['class' => 'badge-default', 'text' => 'Stopped']];
}
if ($schedule->start_time > Carbon::now()) {
return [['class' => 'badge-primary', 'text' => 'Waiting for start']];
}
if (!$schedule->isRunnable()) {
return [['class' => 'badge-default', 'text' => 'Finished']];
}
throw new \Exception('unhandled schedule status');
})
->orderColumn('created_at', function (Builder $query, $order) {
$query->orderBy('schedules.created_at', $order);
})
->orderColumn('updated_at', function (Builder $query, $order) {
$query->orderBy('schedules.updated_at', $order);
})
->orderColumn('status', function (Builder $query, $order) {
$query->orderBy('status', $order);
})
->rawColumns(['campaign.text', 'actions', 'action_methods', 'status', 'campaign'])
->setRowId('id')
->make(true);
}
public function store(ScheduleRequest $request)
{
$schedule = new Schedule();
$schedule->fill($request->all());
$schedule->save();
return response()->format([
'html' => redirect(route('campaigns.index'))->with('success', sprintf(
"Campaign %s scheduled from %s to %s",
$schedule->campaign->name,
Carbon::parse($schedule->start_time)->toDayDateTimeString(),
Carbon::parse($schedule->end_time)->toDayDateTimeString()
)),
'json' => new ScheduleResource($schedule),
]);
}
public function edit(Schedule $schedule, CampaignCollection $collection = null)
{
$schedule->fill(old());
return view('campaign::schedule.edit', [
'schedule' => $schedule,
'collection' => $collection,
]);
}
public function update(ScheduleRequest $request, Schedule $schedule, CampaignCollection $collection = null)
{
$schedule->fill($request->all());
$schedule->save();
return response()->format([
'html' => redirect(route('campaigns.index', ['collection' => $collection]))->with('success', sprintf(
"Campaign %s rescheduled starting on %s and ending on %s",
$schedule->campaign->name,
Carbon::parse($schedule->start_time)->toDayDateTimeString(),
Carbon::parse($schedule->end_time)->toDayDateTimeString()
)),
'json' => new ScheduleResource($schedule),
]);
}
public function destroy(Schedule $schedule, CampaignCollection $collection = null)
{
$schedule->delete();
return response()->format([
'html' => redirect(route('campaigns.index', ['collection' => $collection]))->with('success', sprintf(
"Schedule for campaign %s from %s to %s was removed",
$schedule->campaign->name,
Carbon::parse($schedule->start_time)->toDayDateTimeString(),
Carbon::parse($schedule->end_time)->toDayDateTimeString()
)),
'json' => new ScheduleResource([]),
]);
}
/**
* @param Schedule $schedule
* @return \Illuminate\Http\Response
*/
public function pause(Schedule $schedule)
{
if (!$schedule->isRunning()) {
return response()->format([
'html' => redirect(url()->previous())->with('success', sprintf(
"Schedule for campaign %s was not running, pause request ignored",
$schedule->campaign->name
)),
'json' => new JsonResource(new BadRequestHttpException('cannot pause schedule: not running')),
]);
}
$schedule->status = Schedule::STATUS_PAUSED;
$schedule->save();
return response()->format([
'html' => redirect(url()->previous())->with('success', sprintf(
"Schedule for campaign %s is now paused",
$schedule->campaign->name
)),
'json' => new ScheduleResource([]),
]);
}
/**
* @param Schedule $schedule
* @return \Illuminate\Http\Response
*/
public function start(Schedule $schedule)
{
if (!$schedule->isRunnable()) {
return response()->format([
'html' => redirect(url()->previous())->with('success', sprintf(
"Schedule for campaign %s was not runnable, start request ignored",
$schedule->campaign->name
)),
'json' => new JsonResource(new BadRequestHttpException('cannot start schedule: not runnable')),
]);
}
$schedule->status = Schedule::STATUS_EXECUTED;
if ($schedule->start_time > Carbon::now()) {
$schedule->start_time = Carbon::now();
}
$schedule->save();
return response()->format([
'html' => redirect(url()->previous())->with('success', sprintf(
"Schedule for campaign %s was started manually",
$schedule->campaign->name
)),
'json' => new ScheduleResource([]),
]);
}
/**
* @param Schedule $schedule
* @return \Illuminate\Http\Response
*/
public function stop(Schedule $schedule)
{
if (!$schedule->isRunning() && !$schedule->isPaused()) {
return response()->format([
'html' => redirect(url()->previous())->with('success', sprintf(
"Schedule for campaign %s was not running, stop request ignored",
$schedule->campaign->name
)),
'json' => new JsonResource(new BadRequestHttpException('cannot stop schedule: not running')),
]);
}
$schedule->status = Schedule::STATUS_STOPPED;
$schedule->save();
return response()->format([
'html' => redirect(url()->previous())->with('success', sprintf(
"Schedule for campaign %s was stopped",
$schedule->campaign->name
)),
'json' => new ScheduleResource([]),
]);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/Controller.php | Campaign/extensions/campaign-module/src/Http/Controllers/Controller.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Routing\Controller as BaseController;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
class Controller extends BaseController
{
use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
const FORM_ACTION_SAVE_CLOSE = 'save_close';
const FORM_ACTION_SAVE = 'save';
/**
* Decide where to redirect based on form action.
*
* Array $formActionRoutes should contain at least route for FORM_ACTION_SAVE action. Format:
*
* [
* self::FORM_ACTION_SAVE_CLOSE => 'resource.index',
* self::FORM_ACTION_SAVE => 'resource.edit',
* ]
*
* @param string $action
* @param array $formActionRoutes
* @return \Illuminate\Routing\Redirector|\Illuminate\Http\RedirectResponse
*/
protected function getRouteBasedOnAction(string $action, array $formActionRoutes, $resource)
{
// FORM_ACTION_SAVE must be set, it's default action
// if it's not, redirect back to previous view
if (!isset($formActionRoutes[self::FORM_ACTION_SAVE])) {
return redirect()->back();
}
// if action wasn't provided with actions routes, use default action (FORM_ACTION_SAVE)
if (!isset($formActionRoutes[$action])) {
$action = self::FORM_ACTION_SAVE;
}
return redirect()->route($formActionRoutes[$action], $resource);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/SegmentCacheController.php | Campaign/extensions/campaign-module/src/Http/Controllers/SegmentCacheController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Remp\CampaignModule\CampaignSegment;
use Remp\CampaignModule\Contracts\SegmentAggregator;
use Remp\CampaignModule\Contracts\SegmentCacheException;
use Remp\CampaignModule\Http\Requests\SegmentCacheRequest;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Response;
use Illuminate\Support\Facades\Log;
class SegmentCacheController extends Controller
{
private $segmentAggregator;
public function __construct(
SegmentAggregator $segmentAggregator
) {
$this->segmentAggregator = $segmentAggregator;
}
public function addUserToCache(SegmentCacheRequest $request): JsonResponse
{
$segmentCode = $request->segment_code;
$segmentProvider = $request->segment_provider;
$userId = $request->get('user_id');
try {
$campaignSegment = CampaignSegment::select()
->join('schedules', 'campaign_segments.campaign_id', '=', 'schedules.campaign_id')
->where(function (\Illuminate\Database\Eloquent\Builder $query) {
$query
->whereNull('schedules.end_time')
->orWhere('schedules.end_time', '>=', Carbon::now());
})
->whereIn('schedules.status', [\Remp\CampaignModule\Schedule::STATUS_READY, \Remp\CampaignModule\Schedule::STATUS_EXECUTED, \Remp\CampaignModule\Schedule::STATUS_PAUSED])
->whereCode($segmentCode)
->whereProvider($segmentProvider)
->firstOrFail();
$this->segmentAggregator->addUserToCache($campaignSegment, $userId);
} catch (ModelNotFoundException $e) {
return response()->json([
'status' => 'error',
'message' => "Segment with code [{$segmentCode}] from provider [$segmentProvider] is not actively used in the campaign.",
], Response::HTTP_NOT_FOUND);
} catch (SegmentCacheException $e) {
return response()->json([
'status' => 'error',
'message' => "Cache is not enabled for segment provider [$segmentProvider].",
], Response::HTTP_BAD_REQUEST);
} catch (\Exception $e) {
Log::error($e->getMessage(), $e->getTrace());
return response()->json([
'status' => 'error',
'message' => "Internal server error",
], Response::HTTP_INTERNAL_SERVER_ERROR);
}
return response()->json([
'status' => 'ok',
], Response::HTTP_ACCEPTED);
}
public function removeUserFromCache(SegmentCacheRequest $request): JsonResponse
{
$segmentCode = $request->segment_code;
$segmentProvider = $request->segment_provider;
$userId = $request->get('user_id');
try {
$campaignSegment = CampaignSegment::select()
->join('schedules', 'campaign_segments.campaign_id', '=', 'schedules.campaign_id')
->where(function (\Illuminate\Database\Eloquent\Builder $query) {
$query
->whereNull('schedules.end_time')
->orWhere('schedules.end_time', '>=', Carbon::now());
})
->whereIn('schedules.status', [\Remp\CampaignModule\Schedule::STATUS_READY, \Remp\CampaignModule\Schedule::STATUS_EXECUTED, \Remp\CampaignModule\Schedule::STATUS_PAUSED])
->whereCode($segmentCode)
->whereProvider($segmentProvider)
->firstOrFail();
$this->segmentAggregator->removeUserFromCache($campaignSegment, $userId);
} catch (ModelNotFoundException $e) {
return response()->json([
'status' => 'error',
'message' => "Segment with code [{$segmentCode}] from provider [$segmentProvider] is not actively used in the campaign.",
], Response::HTTP_NOT_FOUND);
} catch (SegmentCacheException $e) {
return response()->json([
'status' => 'error',
'message' => "Cache is not enabled for segment provider [$segmentProvider].",
], Response::HTTP_BAD_REQUEST);
} catch (\Exception $e) {
Log::error($e->getMessage(), $e->getTrace());
return response()->json([
'status' => 'error',
'message' => "Internal server error",
], Response::HTTP_INTERNAL_SERVER_ERROR);
}
return response()->json([
'status' => 'ok',
], Response::HTTP_ACCEPTED);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/SearchController.php | Campaign/extensions/campaign-module/src/Http/Controllers/SearchController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Remp\CampaignModule\Http\Requests\SearchRequest;
use Remp\CampaignModule\Http\Resources\SearchResource;
use Remp\CampaignModule\Models\SearchAspects\BannerSearchAspect;
use Remp\CampaignModule\Models\SearchAspects\CampaignSearchAspect;
use Remp\CampaignModule\Models\SearchAspects\SnippetSearchAspect;
use Spatie\Searchable\Search;
class SearchController extends Controller
{
public function search(SearchRequest $request)
{
$searchTerm = $request->query('term');
$searchResults['banners'] = (new Search())->registerAspect(BannerSearchAspect::class)->search($searchTerm)->pluck('searchable');
$searchResults['campaigns'] = (new Search())->registerAspect(CampaignSearchAspect::class)->search($searchTerm)->pluck('searchable');
$searchResults['snippets'] = (new Search())->registerAspect(SnippetSearchAspect::class)->search($searchTerm)->pluck('searchable');
$searchCollection = collect($searchResults);
return new SearchResource($searchCollection);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/AuthController.php | Campaign/extensions/campaign-module/src/Http/Controllers/AuthController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Auth;
use Illuminate\Http\Request;
class AuthController extends Controller
{
public function logout()
{
Auth::logout();
return redirect()->back();
}
public function error(Request $request)
{
$message = $request->get('error');
return response()->format([
'html' => view('campaign::auth.error', [
'message' => $message,
]),
'json' => [
'message' => $message,
],
]);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/StatsController.php | Campaign/extensions/campaign-module/src/Http/Controllers/StatsController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Remp\CampaignModule\Campaign;
use Remp\CampaignModule\Contracts\StatsContract;
use Remp\CampaignModule\Contracts\StatsHelper;
use Remp\CampaignModule\Models\Interval\IntervalModeEnum;
use Remp\CampaignModule\Rules\ValidCarbonDate;
use Illuminate\Http\Request;
use Illuminate\Support\Carbon;
use Illuminate\Validation\Rule;
use Remp\MultiArmedBandit\Lever;
use Remp\MultiArmedBandit\Machine;
class StatsController extends Controller
{
private $statTypes = [
"show" => [
"label" => "Shows",
"backgroundColor" => "#E63952",
],
"click" => [
"label" => "Clicks",
"backgroundColor" => "#00C7DF",
],
"commerce" => [
"label" => "Conversions",
"backgroundColor" => "#FFC34A",
],
];
private $statsHelper;
private $stats;
public function __construct(StatsHelper $statsHelper, StatsContract $stats)
{
$this->statsHelper = $statsHelper;
$this->stats = $stats;
}
public function getStats(Campaign $campaign, Request $request)
{
$request->validate([
'from' => ['sometimes', new ValidCarbonDate],
'to' => ['sometimes', new ValidCarbonDate],
'interval_mode' => ['sometimes', Rule::enum(IntervalModeEnum::class)],
]);
$tz = $request->input('tz');
$intervalMode = IntervalModeEnum::from($request->input('interval_mode', 'auto'));
$from = Carbon::parse($request->get('from'), $tz);
$to = Carbon::parse($request->get('to'), $tz);
// round values if interval is bigger than 1 hour
if ($from->diffInMinutes($to) >= 3600) {
$from->minute(0)->second(0);
$nextTo = (clone $to)->minute(0)->second(0);
if ($nextTo->ne($to)) {
$to = $nextTo->addHour();
}
}
[$campaignData, $variantsData] = $this->statsHelper->cachedCampaignAndVariantsStats($campaign, $from, $to);
$campaignData['histogram'] = $this->getHistogramData($campaign->variants_uuids, $from, $to, $tz, $intervalMode);
foreach ($variantsData as $uuid => $variantData) {
$variantsData[$uuid]['histogram'] = $this->getHistogramData([$uuid], $from, $to, $tz, $intervalMode);
}
// a/b test evaluation data
foreach ($this->getVariantProbabilities($variantsData, 'click_count') as $variantId => $probability) {
$variantsData[$variantId]['click_probability'] = $probability;
}
foreach ($this->getVariantProbabilities($variantsData, 'purchase_count') as $variantId => $probability) {
$variantsData[$variantId]['purchase_probability'] = $probability;
}
return [
'campaign' => $campaignData,
'variants' => $variantsData,
];
}
private function getHistogramData(array $variantUuids, Carbon $from, Carbon $to, string $tz, IntervalModeEnum $intervalMode = IntervalModeEnum::Auto)
{
$parsedData = [];
$labels = [];
$intervalConfig = $this->statsHelper->calcInterval($from, $to, $intervalMode);
foreach ($this->statTypes as $type => $typeData) {
$parsedData[$type] = [];
$data = $this->stats->count()
->forVariants($variantUuids)
->timeHistogram($intervalConfig->interval, $tz)
->from($from)
->to($to);
if ($type === 'commerce') {
$data = $data->commerce('purchase');
} else {
$data = $data->events('banner', $type);
}
$result = $data->get();
$histogramData = $result[0];
foreach ($histogramData->time_histogram as $histogramRow) {
$date = Carbon::parse($histogramRow->time)->setTimezone('UTC');
$parsedData[$type][$date->toRfc3339String()] = $histogramRow->value;
$labels[] = $date->toRfc3339String();
}
}
$labels = array_unique($labels);
usort($labels, function ($a, $b) {
return $a > $b;
});
[$dataSets, $formattedLabels] = $this->formatDataForChart($parsedData, $labels);
return [
'dataSets' => $dataSets,
'labels' => $formattedLabels,
'timeUnit' => $intervalConfig->timeUnit,
'stepSize' => $intervalConfig->stepSize
];
}
private function getVariantProbabilities($variantsData, $conversionField)
{
$machine = new Machine(1000);
$zeroStat = [];
foreach ($variantsData as $variantId => $data) {
if ($data['show_count'] === 0 || !$data[$conversionField]) {
$zeroStat[$variantId] = 0;
continue;
}
$machine->addLever(new Lever($variantId, $data[$conversionField], $data['show_count']));
}
return $machine->run() + $zeroStat;
}
private function formatDataForChart($typesData, $labels)
{
$dataSets = [];
foreach ($typesData as $type => $data) {
$dataSet = [
'label' => $this->statTypes[$type]['label'],
'data' => [],
'backgroundColor' => $this->statTypes[$type]['backgroundColor']
];
foreach ($labels as $i => $label) {
$labelStr = is_string($label) ? $label : $label->toRfc3339String();
if (array_key_exists($labelStr, $data)) {
$dataSet['data'][] = $data[$labelStr];
} else {
$dataSet['data'][] = 0;
}
$labels[$i] = $labelStr;
}
$dataSets[] = $dataSet;
}
return [
$dataSets,
$labels,
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/BannerController.php | Campaign/extensions/campaign-module/src/Http/Controllers/BannerController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Remp\CampaignModule\Banner;
use Remp\CampaignModule\Http\Requests\BannerOneTimeDisplayRequest;
use Remp\CampaignModule\Http\Requests\BannerRequest;
use Remp\CampaignModule\Http\Resources\BannerResource;
use Remp\CampaignModule\Http\Showtime\Showtime;
use Remp\CampaignModule\Models\ColorScheme\Map as ColorSchemeMap;
use Remp\CampaignModule\Models\Dimension\Map as DimensionMap;
use Remp\CampaignModule\Models\Position\Map as PositionMap;
use Remp\CampaignModule\Models\Alignment\Map as AlignmentMap;
use Remp\CampaignModule\Snippet;
use Carbon\Carbon;
use HTML;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
use Yajra\DataTables\DataTables;
use Yajra\DataTables\QueryDataTable;
class BannerController extends Controller
{
public function __construct(
protected DimensionMap $dimensionMap,
protected PositionMap $positionMap,
protected AlignmentMap $alignmentMap,
protected ColorSchemeMap $colorSchemeMap,
private readonly Showtime $showtime
) {
}
public function index(Request $request)
{
$perPage = $request->get('perPage', 15);
return response()->format([
'html' => view('campaign::banners.index'),
'json' => BannerResource::collection(Banner::paginate($perPage)),
]);
}
public function json(Datatables $dataTables)
{
$banners = Banner::select()
->with('campaigns');
/** @var QueryDataTable $datatable */
$datatable = $dataTables->of($banners);
return $datatable
->addColumn('actions', function (Banner $banner) {
return [
'show' => route('banners.show', $banner),
'edit' => route('banners.edit', $banner),
'copy' => route('banners.copy', $banner),
];
})
->addColumn('name', function (Banner $banner) {
return [
'url' => route('banners.edit', ['banner' => $banner]),
'text' => $banner->name,
];
})
->filterColumn('name', function (Builder $query, $value) {
$query->where('banners.name', 'like', "%{$value}%");
})
->filterColumn('public_id', function (Builder $query, $value) {
$query->where('banners.public_id', $value);
})
->addColumn('active', function (Banner $banner) {
foreach ($banner->campaigns as $campaign) {
if ($campaign->active) {
return true;
}
}
return false;
})
->rawColumns(['actions', 'name', 'active'])
->setRowId('id')
->make(true);
}
public function create(Request $request)
{
$banner = new Banner;
$banner->template = $request->get('template');
$banner->fill(old());
$defaultPositions = $this->positionMap->positions()->first()->style;
if (is_null($banner->offset_vertical)) {
$banner->offset_vertical = isset($defaultPositions['top']) ? $defaultPositions['top'] : $defaultPositions['bottom'];
}
if (is_null($banner->offset_horizontal)) {
$banner->offset_horizontal = isset($defaultPositions['left']) ? $defaultPositions['left'] : $defaultPositions['right'];
}
return view('campaign::banners.create', [
'banner' => $banner,
'positions' => $this->positionMap->positions(),
'dimensions' => $this->dimensionMap->dimensions(),
'alignments' => $this->alignmentMap->alignments(),
'colorSchemes' => $this->colorSchemeMap->colorSchemes(),
'snippets' => Snippet::query()->pluck('value', 'name'),
]);
}
public function copy(Banner $sourceBanner)
{
$sourceBanner->load(
'htmlTemplate',
'mediumRectangleTemplate',
'overlayRectangleTemplate',
'htmlOverlayTemplate',
'overlayTwoButtonsSignatureTemplate',
'barTemplate',
'collapsibleBarTemplate',
'shortMessageTemplate',
'newsletterRectangleTemplate'
);
$banner = $sourceBanner->replicate();
flash(sprintf('Form has been pre-filled with data from banner "%s"', $sourceBanner->name))->info();
return view('campaign::banners.create', [
'banner' => $banner,
'positions' => $this->positionMap->positions(),
'dimensions' => $this->dimensionMap->dimensions(),
'alignments' => $this->alignmentMap->alignments(),
'colorSchemes' => $this->colorSchemeMap->colorSchemes(),
'snippets' => Snippet::query()->pluck('value', 'name'),
]);
}
public function validateForm(BannerRequest $request)
{
return response()->json(false);
}
public function store(BannerRequest $request)
{
$banner = new Banner();
$banner->fill($request->all());
$banner->save();
$templateRelation = $banner->getTemplateRelation();
$templateRelation->create($request->all());
return response()->format([
'html' => $this->getRouteBasedOnAction(
$request->get('action'),
[
self::FORM_ACTION_SAVE_CLOSE => 'banners.index',
self::FORM_ACTION_SAVE => 'banners.edit',
],
$banner
)->with('success', sprintf('Banner [%s] was created', $banner->name)),
'json' => new BannerResource($banner),
]);
}
public function show(Banner $banner)
{
return response()->format([
'html' => view('campaign::banners.show', [
'banner' => $banner->loadTemplate(),
'positions' => $this->positionMap->positions(),
'dimensions' => $this->dimensionMap->dimensions(),
'alignments' => $this->alignmentMap->alignments(),
'colorSchemes' => $this->colorSchemeMap->colorSchemes(),
'snippets' => Snippet::query()->pluck('value', 'name'),
]),
'json' => new BannerResource($banner),
]);
}
public function edit(Banner $banner)
{
$banner->loadTemplate();
$banner->fill(old());
return view('campaign::banners.edit', [
'banner' => $banner,
'positions' => $this->positionMap->positions(),
'dimensions' => $this->dimensionMap->dimensions(),
'alignments' => $this->alignmentMap->alignments(),
'colorSchemes' => $this->colorSchemeMap->colorSchemes(),
'snippets' => Snippet::query()->pluck('value', 'name'),
]);
}
public function update(BannerRequest $request, Banner $banner)
{
$banner->update($request->all());
$template = $banner->getTemplate();
$template->update($request->all());
return response()->format([
'html' => $this->getRouteBasedOnAction(
$request->get('action'),
[
self::FORM_ACTION_SAVE_CLOSE => 'banners.index',
self::FORM_ACTION_SAVE => 'banners.edit',
],
$banner
)->with('success', sprintf('Banner [%s] was updated', $banner->name)),
'json' => new BannerResource($banner),
]);
}
public function destroy(Banner $banner)
{
$banner->delete();
return response()->format([
'html' => redirect(route('banners.index'))->with('success', 'Banner removed'),
'json' => new BannerResource([]),
]);
}
public function oneTimeDisplay(BannerOneTimeDisplayRequest $request, Banner $banner)
{
$userId = $request->get('user_id');
$browserId = $request->get('browser_id');
$expiresInSeconds = Carbon::now()->diffInSeconds(Carbon::parse($request->get('expires_at')));
$banner->cache();
if ($userId) {
$this->showtime->displayForUser($banner, $userId, $expiresInSeconds);
}
if ($browserId) {
$this->showtime->displayForBrowser($banner, $browserId, $expiresInSeconds);
}
return response()->json([
'status' => 'ok'
], 202);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/CampaignsComparisonController.php | Campaign/extensions/campaign-module/src/Http/Controllers/CampaignsComparisonController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Remp\CampaignModule\Campaign;
use Remp\CampaignModule\Contracts\StatsHelper;
class CampaignsComparisonController extends Controller
{
private const SESSION_KEY_COMPARED_CAMPAIGNS = 'compared_campaigns';
private $statsHelper;
public function __construct(StatsHelper $statsHelper)
{
$this->statsHelper = $statsHelper;
}
public function index()
{
return view('campaign::comparison.index');
}
public function json()
{
$campaignIds = session(self::SESSION_KEY_COMPARED_CAMPAIGNS, []);
$campaigns = collect();
$campaignsNotCompared = collect();
foreach (Campaign::all() as $campaign) {
if (in_array($campaign->id, $campaignIds)) {
[$campaignData, $variantsData] = $this->statsHelper->cachedCampaignAndVariantsStats($campaign);
$record = $campaign->toArray();
$record['stats'] = $campaignData;
$campaigns->push($record);
} else {
$campaignsNotCompared->push($campaign->toArray());
}
}
return response()->json(compact('campaigns', 'campaignsNotCompared'));
}
public function add(Campaign $campaign)
{
$campaignIds = session(self::SESSION_KEY_COMPARED_CAMPAIGNS, []);
if (!in_array($campaign->id, $campaignIds, true)) {
$campaignIds[] = $campaign->id;
}
session([
self::SESSION_KEY_COMPARED_CAMPAIGNS => $campaignIds
]);
return response()->json();
}
public function remove(Campaign $campaign)
{
$campaignIds = session(self::SESSION_KEY_COMPARED_CAMPAIGNS, []);
if (($key = array_search($campaign->id, $campaignIds)) !== false) {
unset($campaignIds[$key]);
}
session([
self::SESSION_KEY_COMPARED_CAMPAIGNS => $campaignIds
]);
return response()->json();
}
public function removeAll()
{
session([
self::SESSION_KEY_COMPARED_CAMPAIGNS => []
]);
return response()->json();
}
public function addAll()
{
session([
self::SESSION_KEY_COMPARED_CAMPAIGNS => Campaign::query()->pluck('id')->toArray()
]);
return response()->json();
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/CollectionController.php | Campaign/extensions/campaign-module/src/Http/Controllers/CollectionController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Remp\CampaignModule\Campaign;
use Remp\CampaignModule\CampaignCollection;
use Remp\CampaignModule\Http\Requests\CollectionRequest;
use Remp\CampaignModule\Http\Resources\CollectionResource;
use Illuminate\Database\Eloquent\Builder;
use Yajra\DataTables\DataTables;
use Yajra\DataTables\QueryDataTable;
class CollectionController extends Controller
{
public function index()
{
return response()->format([
'html' => view('campaign::collections.index'),
'json' => CollectionResource::collection(CampaignCollection::paginate()),
]);
}
public function create()
{
$collection = new CampaignCollection();
return view('campaign::collections.create', [
'collection' => $collection,
'selectedCampaigns' => [],
'campaigns' => Campaign::all(),
]);
}
public function edit(CampaignCollection $collection)
{
$collection->fill(old());
return view('campaign::collections.edit', [
'collection' => $collection->load('campaigns'),
'selectedCampaigns' => $collection->campaigns()->pluck('campaigns.id'),
'campaigns' => Campaign::orderBy('created_at', 'DESC')->get(),
]);
}
public function store(CollectionRequest $request)
{
$collection = new CampaignCollection();
$collection->fill($request->all());
$collection->save();
$collection->campaigns()->attach($request->get('campaigns', []));
return response()->format([
'html' => $this->getRouteBasedOnAction(
$request->get('action'),
[
self::FORM_ACTION_SAVE_CLOSE => 'collections.index',
self::FORM_ACTION_SAVE => 'collections.edit',
],
$collection
)->with('success', sprintf(
"Collection [%s] was created",
$collection->name,
))
]);
}
public function update(CollectionRequest $request, CampaignCollection $collection)
{
$collection->fill($request->all());
$collection->save();
$collection->campaigns()->detach();
$collection->campaigns()->attach($request->get('campaigns', []));
return response()->format([
'html' => $this->getRouteBasedOnAction(
$request->get('action'),
[
self::FORM_ACTION_SAVE_CLOSE => 'collections.index',
self::FORM_ACTION_SAVE => 'collections.edit',
],
$collection
)->with('success', sprintf(
"Collection [%s] was updated",
$collection->name,
))
]);
}
public function destroy(CampaignCollection $collection)
{
$collection->campaigns()->detach();
$collection->delete();
return response()->format([
'html' => redirect()->route('collections.index'),
'json' => new CollectionResource([]),
]);
}
public function json(Datatables $dataTables)
{
$collections = CampaignCollection::select('collections.*')
->leftJoin('campaign_collections', 'campaign_collections.collection_id', '=', 'collections.id')
->leftJoin('campaigns', 'campaigns.id', '=', 'campaign_collections.campaign_id')
->groupBy('collections.id');
/** @var QueryDataTable $datatable */
$datatable = $dataTables->of($collections);
return $datatable
->addColumn('actions', function (CampaignCollection $collection) {
return [
'show' => route('campaigns.index', ['collection' => $collection]),
'edit' => route('collections.edit', $collection),
'destroy' => route('collections.destroy', $collection),
];
})
->addColumn('name', function (CampaignCollection $collection) {
return [
'url' => route('campaigns.index', ['collection' => $collection]),
'text' => $collection->name,
];
})
->filterColumn('name', function (Builder $query, $value) {
$query->where('collections.name', 'like', "%{$value}%");
})
->addColumn('campaigns', function (CampaignCollection $collection) {
$campaigns = [];
foreach ($collection->campaigns as $campaign) {
$campaigns[] = html()->a(
href: route('campaigns.edit', $campaign),
contents: $campaign->name,
)->attribute('target', '_blank');
}
return $campaigns;
})
->filterColumn('campaigns', function (Builder $query, $value) {
$query->where('campaigns.name', 'like', "%{$value}%");
})
->rawColumns(['name.text'])
->setRowId('id')
->make(true);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/CampaignController.php | Campaign/extensions/campaign-module/src/Http/Controllers/CampaignController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
use Remp\CampaignModule\Banner;
use Remp\CampaignModule\Campaign;
use Remp\CampaignModule\CampaignBanner;
use Remp\CampaignModule\CampaignSegment;
use Remp\CampaignModule\CampaignCollection;
use Remp\CampaignModule\Contracts\SegmentAggregator;
use Remp\CampaignModule\Contracts\SegmentException;
use Remp\CampaignModule\Country;
use Remp\CampaignModule\Http\Requests\CampaignRequest;
use Remp\CampaignModule\Http\Resources\CampaignResource;
use Remp\CampaignModule\Http\Showtime\ControllerShowtimeResponse;
use Remp\CampaignModule\Http\Showtime\Showtime;
use Remp\CampaignModule\Schedule;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use Yajra\DataTables\DataTables;
use Yajra\DataTables\QueryDataTable;
class CampaignController extends Controller
{
private $beamJournalConfigured;
private $showtime;
public function __construct(Showtime $showtime)
{
$this->beamJournalConfigured = !empty(config('services.remp.beam.segments_addr'));
$this->showtime = $showtime;
}
public function index(SegmentAggregator $segmentAggregator, CampaignCollection $collection = null)
{
$availableSegments = $this->getAllSegments($segmentAggregator)->pluck('name', 'code');
$segments = CampaignSegment::get()->mapWithKeys(function ($item) use ($availableSegments) {
return [$item->code => $availableSegments->get($item->code) ?? $item->code];
});
$variants = CampaignBanner::with('banner')
->whereNotNull('banner_id')
->get()
->pluck('banner.name', 'banner.id');
return response()->format([
'html' => view('campaign::campaigns.index', [
'beamJournalConfigured' => $this->beamJournalConfigured,
'segments' => $segments,
'variants' => $variants,
'collection' => $collection,
]),
'json' => CampaignResource::collection(Campaign::paginate()),
]);
}
public function json(Datatables $dataTables, SegmentAggregator $segmentAggregator, CampaignCollection $collection = null)
{
$campaigns = Campaign::select('campaigns.*')
->with(['segments', 'countries', 'collections', 'campaignBanners', 'campaignBanners.banner', 'schedules']);
if ($collection) {
$campaigns->whereHas('collections', function ($query) use ($collection) {
$query->where('collection_id', $collection->id);
});
}
$segments = $this->getAllSegments($segmentAggregator)->pluck('name', 'code');
/** @var QueryDataTable $datatable */
$datatable = $dataTables->of($campaigns);
return $datatable
->addColumn('actions', function (Campaign $campaign) use ($collection) {
return [
'edit' => route('campaigns.edit', ['campaign' => $campaign, 'collection' => $collection]),
'copy' => route('campaigns.copy', ['sourceCampaign' => $campaign, 'collection' => $collection]),
'stats' => route('campaigns.stats', ['campaign' => $campaign, 'collection' => $collection]),
'compare' => route('comparison.add', ['campaign' => $campaign, 'collection' => $collection]),
];
})
->addColumn('name', function (Campaign $campaign) use ($collection) {
return [
'url' => route('campaigns.edit', ['campaign' => $campaign, 'collection' => $collection]),
'text' => $campaign->name,
];
})
->filterColumn('name', function (Builder $query, $value) {
$query->where('campaigns.name', 'like', "%{$value}%");
})
->filterColumn('public_id', function (Builder $query, $value) {
$query->where('campaigns.public_id', $value);
})
->addColumn('variants', function (Campaign $campaign) {
$data = $campaign->campaignBanners->all();
$variants = [];
/** @var CampaignBanner $variant */
foreach ($data as $variant) {
$proportion = $variant->proportion;
if ($proportion === 0) {
continue;
}
// handle control group
if ($variant->control_group === 1) {
$variants[] = "Control Group ({$proportion}%)";
continue;
}
// handle variants with banner
$link = html()->a(
href: route('banners.edit', $variant->banner_id),
contents: $variant->banner->name
);
$variants[] = "{$link} ({$proportion}%)";
}
return $variants;
})
->filterColumn('variants', function (Builder $query, $value) {
$values = explode(',', $value);
$filterQuery = \DB::table('campaign_banners')
->select(['campaign_banners.campaign_id'])
->whereIn('campaign_banners.banner_id', $values)
->where('campaign_banners.proportion', '>', 0);
$query->whereIn('campaigns.id', $filterQuery);
})
->addColumn('segments', function (Campaign $campaign) use ($segments) {
$segmentNames = [];
$exclusiveIcon = '<i class="zmdi zmdi-eye-off" title="User must not be member of segment to see the campaign."></i>';
$inclusiveIcon = '<i class="zmdi zmdi-eye primary-color" title="User needs to be member of segment to see the campaign."></i>';
foreach ($campaign->segments as $segment) {
$icon = $segment->inclusive ? $inclusiveIcon : $exclusiveIcon;
if ($segments->get($segment->code)) {
$segmentNames[] = "{$icon} <span title='{$segment->code}'>{$segments->get($segment->code)}</span></em>";
} else {
$segmentNames[] = "{$icon} <span title='{$segment->code}'>{$segment->code}</span></em>";
}
}
return $segmentNames;
})
->addColumn('collections', function (Campaign $campaign) {
$collections = [];
foreach ($campaign->collections as $collection) {
$collections[] = html()->a(
href: route('campaigns.index', ['collection' => $collection->id]),
contents: $collection->name,
)->attribute('target', '_blank');
}
return $collections;
})
->filterColumn('segments', function (Builder $query, $value) {
$values = explode(',', $value);
$filterQuery = \DB::table('campaign_segments')
->select(['campaign_segments.campaign_id'])
->whereIn('campaign_segments.code', $values);
$query->whereIn('campaigns.id', $filterQuery);
})
->addColumn('countries', function (Campaign $campaign) {
return implode(' ', $campaign->countries->pluck('name')->toArray());
})
->addColumn('active', function (Campaign $campaign) {
$active = $campaign->active;
return view('campaign::campaigns.partials.activeToggle', [
'id' => $campaign->id,
'active' => $active,
'title' => $active ? 'Deactivate campaign' : 'Activate campaign'
])->render();
})
->orderColumn('active', function (Builder $query, $order) {
$query
->withAggregate(['schedules' => function ($scheduleQuery) {
$scheduleQuery->running();
}], 'id')
->orderBy(DB::raw('ISNULL(schedules_id)'), $order);
})
->addColumn('is_running', function (Campaign $campaign) {
foreach ($campaign->schedules as $schedule) {
if ($schedule->isRunning()) {
return true;
}
}
return false;
})
->addColumn('signed_in', function (Campaign $campaign) {
return $campaign->signedInLabel();
})
->addColumn('devices', function (Campaign $campaign) {
return count($campaign->devices) == count($campaign->getAllDevices()) ? 'all' : implode(' ', $campaign->devices);
})
->rawColumns(['name.text', 'actions', 'active', 'signed_in', 'once_per_session', 'variants', 'is_running', 'segments'])
->setRowId('id')
->make(true);
}
public function create(SegmentAggregator $segmentAggregator, CampaignCollection $collection = null)
{
$campaign = new Campaign();
[
$campaign,
$bannerId,
$variants,
$selectedCountries,
$selectedLanguages,
$countriesBlacklist
] = $this->processOldCampaign($campaign, old());
return view('campaign::campaigns.create', [
'campaign' => $campaign,
'bannerId' => $bannerId,
'variants' => $variants,
'selectedCountries' => $selectedCountries,
'selectedLanguages' => $selectedLanguages,
'countriesBlacklist' => $countriesBlacklist,
'banners' => Banner::all(),
'availableCountries' => Country::all(),
'availableLanguages' => Campaign::getAvailableLanguages(),
'segments' => $this->getAllSegments($segmentAggregator),
'collection' => $collection,
]);
}
public function copy(Campaign $sourceCampaign, SegmentAggregator $segmentAggregator, CampaignCollection $collection = null)
{
$sourceCampaign->load('banners', 'campaignBanners', 'segments', 'countries');
/** @var Campaign $campaign */
$campaign = $sourceCampaign->replicate();
flash(sprintf('Form has been pre-filled with data from campaign "%s"', $sourceCampaign->name))->info();
[
$campaign,
$bannerId,
$variants,
$selectedCountries,
$selectedLanguages,
$countriesBlacklist
] = $this->processOldCampaign($campaign, old());
return view('campaign::campaigns.create', [
'campaign' => $campaign,
'bannerId' => $bannerId,
'variants' => $variants,
'selectedCountries' => $selectedCountries,
'selectedLanguages' => $selectedLanguages,
'countriesBlacklist' => $countriesBlacklist,
'banners' => Banner::all(),
'availableCountries' => Country::all()->keyBy("iso_code"),
'availableLanguages' => Campaign::getAvailableLanguages(),
'segments' => $this->getAllSegments($segmentAggregator),
'collection' => $collection,
]);
}
public function validateForm(CampaignRequest $request)
{
return response()->json(false);
}
public function store(CampaignRequest $request, CampaignCollection $collection = null)
{
$campaign = new Campaign();
$requestData = $request->all();
// if copying data from existing campaign, ignore 'removed_segments',
// since they are CampaignSegments referenced from the old campaign
unset($requestData['removed_segments']);
$this->saveCampaign($campaign, $requestData, $collection);
$message = ['success' => sprintf('Campaign [%s] was created', $campaign->name)];
// (de)activate campaign (based on flag or new schedule)
$message['warning'] = $this->processCampaignActivation(
$campaign,
$request->get('activation_mode'),
$request->get('active', false),
$request->get('new_schedule_start_time'),
$request->get('new_schedule_end_time')
);
return response()->format([
'html' => $this->getRouteBasedOnAction(
$request->get('action'),
[
self::FORM_ACTION_SAVE_CLOSE => 'campaigns.index',
self::FORM_ACTION_SAVE => 'campaigns.edit',
],
['campaign' => $campaign, 'collection' => $collection]
)->with($message),
'json' => new CampaignResource($campaign),
]);
}
public function show(Campaign $campaign)
{
return response()->format([
'html' => view('campaign::campaigns.show', [
'campaign' => $campaign,
]),
'json' => new CampaignResource($campaign),
]);
}
public function edit(Campaign $campaign, SegmentAggregator $segmentAggregator, CampaignCollection $collection = null)
{
[
$campaign,
$bannerId,
$variants,
$selectedCountries,
$selectedLanguages,
$countriesBlacklist
] = $this->processOldCampaign($campaign, old());
return view('campaign::campaigns.edit', [
'campaign' => $campaign,
'bannerId' => $bannerId,
'variants' => $variants,
'selectedCountries' => $selectedCountries,
'selectedLanguages' => $selectedLanguages,
'countriesBlacklist' => $countriesBlacklist,
'banners' => Banner::all(),
'availableCountries' => Country::all()->keyBy("iso_code"),
'availableLanguages' => Campaign::getAvailableLanguages(),
'segments' => $this->getAllSegments($segmentAggregator),
'collection' => $collection,
]);
}
public function update(CampaignRequest $request, Campaign $campaign, CampaignCollection $collection = null)
{
$this->saveCampaign($campaign, $request->all(), $collection);
$message = ['success' => sprintf('Campaign [%s] was updated.', $campaign->name)];
// (de)activate campaign (based on flag or new schedule)
$message['warning'] = $this->processCampaignActivation(
$campaign,
$request->get('activation_mode'),
$request->get('active', false),
$request->get('new_schedule_start_time'),
$request->get('new_schedule_end_time')
);
return response()->format([
'html' => $this->getRouteBasedOnAction(
$request->get('action'),
[
self::FORM_ACTION_SAVE_CLOSE => 'campaigns.index',
self::FORM_ACTION_SAVE => 'campaigns.edit',
],
['campaign' => $campaign, 'collection' => $collection]
)->with($message),
'json' => new CampaignResource($campaign),
]);
}
/**
* (De)Activate campaign (based on flag or new schedule).
*
* If `$activationMode` is 'activate-schedule' and new schedule has start time, create new schedule.
* Otherwise activate / deactivate schedules - action based on provided `$activate` flag.
*
* @param $campaign
* @param $activationMode
* @param null $activate
* @param null $newScheduleStartTime
* @param null $newScheduleEndTime
* @return null|string
*/
private function processCampaignActivation(
$campaign,
$activationMode,
$activate = null,
$newScheduleStartTime = null,
$newScheduleEndTime = null
): ?string {
if ($activationMode === 'activate-schedule'
&& !is_null($newScheduleStartTime)) {
$schedule = new Schedule();
$schedule->campaign_id = $campaign->id;
$schedule->start_time = $newScheduleStartTime;
$schedule->end_time = $newScheduleEndTime;
$schedule->save();
return sprintf("Schedule with start time '%s' added", Carbon::parse($schedule->start_time)->toDayDateTimeString());
} else {
return $this->toggleSchedules($campaign, $activate);
}
}
/**
* Toggle campaign status - create or stop schedules.
*
* If campaign is not active, activate it:
* - create new schedule with status executed (it wasn't planned).
*
* If campaign is active, deactivate it:
* - stop all running or planned schedules.
*
* @param Campaign $campaign
* @return JsonResponse
*/
public function toggleActive(Campaign $campaign): JsonResponse
{
$activate = false;
if (!$campaign->active) {
$activate = true;
}
$this->toggleSchedules($campaign, $activate);
// TODO: maybe add message from toggleSchedules to response?
return response()->json([
'active' => $campaign->active
]);
}
/**
* Toggle schedules of campaign.
*
* When `activate` argument is not passed, no change is triggered.
*
* @param Campaign $campaign
* @param null|boolean $activate
* @return null|string Returns message about schedules state change.
*/
private function toggleSchedules(Campaign $campaign, $activate = null): ?string
{
// do not change schedules when there is no `activate` order
if (is_null($activate)) {
return null;
}
$schedulesChangeMsg = null;
if ($activate) {
$activated = $this->startCampaignSchedule($campaign);
if ($activated) {
$schedulesChangeMsg = "Campaign was activated and is running.";
}
} else {
$stopped = $this->stopCampaignSchedule($campaign);
if ($stopped) {
$schedulesChangeMsg = "Campaign was deactivated, all schedules were stopped.";
}
}
return $schedulesChangeMsg;
}
/**
* If no campaign's schedule is running, start new one.
*
* @param Campaign $campaign
* @return bool Returns true if new schedule was added.
*/
private function startCampaignSchedule(Campaign $campaign)
{
$activated = false;
if (!$campaign->schedules()->running()->count()) {
$schedule = new Schedule();
$schedule->campaign_id = $campaign->id;
$schedule->start_time = Carbon::now();
$schedule->status = Schedule::STATUS_EXECUTED;
$schedule->save();
$activated = true;
}
return $activated;
}
/**
* Stop all campaign schedules.
*
* @param Campaign $campaign
* @return bool Returns true if any schedule was running and was stopped.
*/
private function stopCampaignSchedule(Campaign $campaign): bool
{
$stopped = false;
/** @var Schedule $schedule */
foreach ($campaign->schedules()->runningOrPlanned()->get() as $schedule) {
$schedule->status = Schedule::STATUS_STOPPED;
$schedule->end_time = Carbon::now();
$schedule->save();
$stopped = true;
}
return $stopped;
}
/**
* Returns countries array ready to sync with campaign_country pivot table
*
* @param array $countries
* @param bool $blacklist
* @return array
*/
private function processCountries(array $countries, bool $blacklist): array
{
$processed = [];
foreach ($countries as $cid) {
$processed[$cid] = ['blacklisted' => $blacklist];
}
return $processed;
}
/**
* @param Request $request
* @param Showtime $showtime
* @param ControllerShowtimeResponse $controllerShowtimeResponse
*
* @return JsonResponse
*/
public function showtime(
Request $request,
Showtime $showtime,
ControllerShowtimeResponse $controllerShowtimeResponse
) {
$showtime->setRequest($request);
$data = $request->get('data');
$callback = $request->get('callback');
if ($data === null || $callback === null) {
return response()->json(['errors' => ['invalid request, data or callback params missing']], 400);
}
if (!empty($request->getPreferredLanguage())) {
$showtime->getShowtimeConfig()->setAcceptLanguage($request->getPreferredLanguage());
}
return $showtime->showtime($data, $callback, $controllerShowtimeResponse);
}
public function saveCampaign(Campaign $campaign, array $data, CampaignCollection $collection = null)
{
if (empty($data['operating_systems'])) {
$data['operating_systems'] = null;
}
$campaign->fill($data);
$campaign->save();
if (!empty($data['variants_to_remove'])) {
$campaign->removeVariants($data['variants_to_remove']);
}
$campaign->storeOrUpdateVariants($data['variants']);
$campaign->countries()->sync(
$this->processCountries(
$data['countries'] ?? [],
(bool)$data['countries_blacklist']
)
);
$segments = $data['segments'] ?? [];
foreach ($segments as $segment) {
CampaignSegment::firstOrCreate([
'campaign_id' => $campaign->id,
'code' => $segment['code'],
'provider' => $segment['provider'],
'inclusive' => $segment['inclusive']
]);
}
if (isset($data['removed_segments'])) {
CampaignSegment::destroy($data['removed_segments']);
}
if ($collection !== null && !$campaign->collections->contains($collection)) {
$campaign->collections()->attach($collection);
}
}
public function processOldCampaign(Campaign $campaign, array $data)
{
$campaign->fill($data);
// parse old segments data
$segments = [];
$segmentsData = isset($data['segments']) ? $data['segments'] : $campaign->segments->toArray();
$removedSegments = isset($data['removedSegments']) ? $data['removedSegments'] : [];
foreach ($segmentsData as $segment) {
if (is_null($segment['id']) || !array_search($segment['id'], $removedSegments)) {
$segments[] = $campaign->segments()->make($segment);
}
}
$campaign->setRelation('segments', collect($segments));
// parse selected countries
$countries = $campaign->countries->toArray();
$selectedCountries = $data['countries'] ?? array_map(function ($country) {
return $country['iso_code'];
}, $countries);
// countries blacklist?
$blacklisted = 0;
foreach ($countries as $country) {
$blacklisted = (int)$country['pivot']['blacklisted'];
}
// main banner
if (array_key_exists('banner_id', $data)) {
$bannerId = $data['banner_id'];
} elseif (!$campaign->campaignBanners->isEmpty()) {
$bannerId = optional($campaign->campaignBanners[0])->banner_id;
} else {
$bannerId = optional($campaign->campaignBanners()->first())->banner_id;
}
// variants
if (array_key_exists('variants', $data)) {
$variants = $data['variants'];
} elseif (!$campaign->campaignBanners->isEmpty()) {
$variants = $campaign->campaignBanners;
} else {
$variants = $campaign->campaignBanners()
->with('banner')
->get();
}
return [
$campaign,
$bannerId,
$variants,
$selectedCountries,
$campaign->languages,
$data['countries_blacklist'] ?? $blacklisted
];
}
public function getAllSegments(SegmentAggregator $segmentAggregator): Collection
{
try {
$segments = $segmentAggregator->list();
} catch (SegmentException $e) {
$segments = new CampaignCollection();
flash('Unable to fetch list of segments, please check the application configuration.')->error();
Log::error($e->getMessage());
}
foreach ($segmentAggregator->getErrors() as $error) {
flash(nl2br($error))->error();
Log::error($error);
}
return $segments;
}
public function stats(
Campaign $campaign,
Request $request
) {
/** @var CampaignBanner[] $variants */
$variants = $campaign->campaignBanners()->withTrashed()->with("banner")->get();
$from = $request->input('from', 'today - 30 days');
$to = $request->input('to', 'now');
$variantBannerLinks = [];
$variantBannerTexts = [];
foreach ($variants as $variant) {
if (!$variant->banner) {
continue;
}
$variantBannerLinks[$variant->uuid] = route('banners.show', ['banner' => $variant->banner]);
$variantBannerTexts[$variant->uuid] = $variant->banner->getTemplate()->text();
}
return view('campaign::campaigns.stats', [
'beamJournalConfigured' => $this->beamJournalConfigured,
'campaign' => $campaign,
'variants' => $variants,
'variantBannerLinks' => $variantBannerLinks,
'variantBannerTexts' => $variantBannerTexts,
'from' => $from,
'to' => $to,
]);
}
public function destroy(Campaign $campaign)
{
//
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Controllers/DashboardController.php | Campaign/extensions/campaign-module/src/Http/Controllers/DashboardController.php | <?php
namespace Remp\CampaignModule\Http\Controllers;
class DashboardController extends Controller
{
public function index()
{
return redirect()->route('campaigns.index');
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Showtime/ControllerShowtimeResponse.php | Campaign/extensions/campaign-module/src/Http/Showtime/ControllerShowtimeResponse.php | <?php
namespace Remp\CampaignModule\Http\Showtime;
use Remp\CampaignModule\Banner;
use Remp\CampaignModule\Campaign;
use Remp\CampaignModule\CampaignBanner;
use View;
class ControllerShowtimeResponse implements ShowtimeResponse
{
public function error($callback, int $statusCode, array $errors)
{
return response()
->jsonp($callback, [
'success' => false,
'errors' => $errors,
]);
}
public function success(string $callback, $data, $activeCampaigns, $providerData, $suppressedBanners, array $evaluationMessages = [])
{
$responseData = [
'success' => true,
'errors' => [],
'data' => empty($data) ? [] : $data,
'activeCampaignIds' => array_column($activeCampaigns, 'uuid'),
'activeCampaigns' => $activeCampaigns,
'providerData' => $providerData,
'suppressedBanners' => $suppressedBanners
];
if ($evaluationMessages) {
$responseData['evaluationMessages'] = $evaluationMessages;
}
return response()->jsonp($callback, $responseData);
}
public function renderBanner(
Banner $banner,
array $alignments,
array $dimensions,
array $positions,
array $colorSchemes,
array $snippets
): string {
return View::make('banners.preview', [
'banner' => $banner,
'variantUuid' => '',
'campaignUuid' => '',
'positions' => $positions,
'dimensions' => $dimensions,
'alignments' => $alignments,
'colorSchemes' => $colorSchemes,
'snippets' => $snippets,
'controlGroup' => 0
])->render();
}
public function renderCampaign(
CampaignBanner $variant,
Campaign $campaign,
array $alignments,
array $dimensions,
array $positions,
array $colorSchemes,
array $snippets,
mixed $userData,
): string {
return View::make('banners.preview', [
'banner' => $variant->banner,
'variantUuid' => $variant->uuid,
'variantPublicId' => $variant->public_id,
'campaignUuid' => $campaign->uuid,
'campaignPublicId' => $campaign->public_id,
'positions' => $positions,
'dimensions' => $dimensions,
'alignments' => $alignments,
'colorSchemes' => $colorSchemes,
'snippets' => $snippets,
'controlGroup' => $variant->control_group,
'userData' => $userData,
])->render();
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Showtime/LazyDeviceDetector.php | Campaign/extensions/campaign-module/src/Http/Showtime/LazyDeviceDetector.php | <?php
namespace Remp\CampaignModule\Http\Showtime;
use DeviceDetector\Cache\PSR16Bridge;
use Psr\SimpleCache\CacheInterface;
class LazyDeviceDetector
{
private $detector;
public function __construct(
private CacheInterface $cache,
) {
}
public function get($userAgent)
{
if (!$this->detector) {
$this->detector = new \DeviceDetector\DeviceDetector();
$this->detector->setCache(new Psr16Bridge($this->cache));
}
$this->detector->setUserAgent($userAgent);
$this->detector->parse();
return $this->detector;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Showtime/ShowtimeConfig.php | Campaign/extensions/campaign-module/src/Http/Showtime/ShowtimeConfig.php | <?php
namespace Remp\CampaignModule\Http\Showtime;
class ShowtimeConfig
{
public function __construct(
private ?string $debugKey = null,
private ?string $acceptLanguage = null,
private bool $prioritizeBannerOnSamePosition = false,
private bool $oneTimeBannerEnabled = true,
) {
}
public function setAcceptLanguage(string $language): self
{
$this->acceptLanguage = $language;
return $this;
}
public function getAcceptLanguage(): ?string
{
return $this->acceptLanguage;
}
public function isPrioritizeBannerOnSamePosition(): bool
{
return $this->prioritizeBannerOnSamePosition;
}
public function setPrioritizeBannerOnSamePosition(bool $prioritizeBannerOnSamePosition): self
{
$this->prioritizeBannerOnSamePosition = $prioritizeBannerOnSamePosition;
return $this;
}
public function isOneTimeBannerEnabled(): bool
{
return $this->oneTimeBannerEnabled;
}
public function setOneTimeBannerEnabled(bool $oneTimeBannerEnabled): self
{
$this->oneTimeBannerEnabled = $oneTimeBannerEnabled;
return $this;
}
public function getDebugKey(): ?string
{
return $this->debugKey;
}
public function setDebugKey(?string $debugKey): self
{
$this->debugKey = $debugKey;
return $this;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Showtime/ShowtimeResponse.php | Campaign/extensions/campaign-module/src/Http/Showtime/ShowtimeResponse.php | <?php
namespace Remp\CampaignModule\Http\Showtime;
use Remp\CampaignModule\Banner;
use Remp\CampaignModule\Campaign;
use Remp\CampaignModule\CampaignBanner;
interface ShowtimeResponse
{
public function error($callback, int $statusCode, array $errors);
public function success(string $callback, $data, $activeCampaigns, $providerData, $suppressedBanners, array $evaluationMessages = []);
public function renderBanner(Banner $banner, array $alignments, array $dimensions, array $positions, array $colorSchemes, array $snippets): string;
/**
* render is responsible for rendering JS to be executed on client.
*
* @param CampaignBanner $variant
* @param Campaign $campaign
* @param array $alignments
* @param array $dimensions
* @param array $positions
* @param array $colorSchemes
* @param array $snippets
* @param $userData
* @return string
*/
public function renderCampaign(CampaignBanner $variant, Campaign $campaign, array $alignments, array $dimensions, array $positions, array $colorSchemes, array $snippets, mixed $userData): string;
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Showtime/ShowtimeTestable.php | Campaign/extensions/campaign-module/src/Http/Showtime/ShowtimeTestable.php | <?php
namespace Remp\CampaignModule\Http\Showtime;
use Remp\CampaignModule\Campaign;
use Remp\CampaignModule\CampaignBanner;
class ShowtimeTestable extends Showtime
{
public function shouldDisplay(Campaign $campaign, $userData, array &$activeCampaigns,): ?CampaignBanner
{
$result = parent::campaignBannerToDisplay($campaign, $userData, $activeCampaigns);
// return banner or null
return is_string($result) ? null : $result;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Showtime/LazyGeoReader.php | Campaign/extensions/campaign-module/src/Http/Showtime/LazyGeoReader.php | <?php
namespace Remp\CampaignModule\Http\Showtime;
use GeoIp2\Database\Reader;
class LazyGeoReader
{
private $reader;
private $maxmindDatabasePath;
public function __construct($maxmindDatabasePath)
{
$this->maxmindDatabasePath = $maxmindDatabasePath;
}
private function get()
{
if (!$this->reader) {
$this->reader = new Reader(realpath($this->maxmindDatabasePath));
}
return $this->reader;
}
/**
* @param $ip
*
* @return string|null
* @throws \GeoIp2\Exception\AddressNotFoundException
* @throws \MaxMind\Db\Reader\InvalidDatabaseException
*/
public function countryCode($ip): ?string
{
$record = $this->get()->country($ip);
return $record->country->isoCode;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Showtime/DeviceRulesEvaluator.php | Campaign/extensions/campaign-module/src/Http/Showtime/DeviceRulesEvaluator.php | <?php
namespace Remp\CampaignModule\Http\Showtime;
use DeviceDetector\DeviceDetector;
use Predis\ClientInterface;
use Remp\CampaignModule\Campaign;
class DeviceRulesEvaluator
{
private const DEVICE_DETECTION_KEY = 'device_detection';
private const OPERATING_SYSTEM_DETECTION_KEY = 'operating_system_detection';
private const DEVICE_DETECTION_TTL = 86400;
private array $localCache = [];
/** @var DeviceDetector[] */
private array $deviceDetectorResults = [];
public function __construct(
private readonly ClientInterface|\Redis $redis,
private readonly LazyDeviceDetector $deviceDetector,
) {
}
public function isAcceptedByDeviceRules(string $userAgent, Campaign $campaign): bool
{
if (!in_array(Campaign::DEVICE_MOBILE, $campaign->devices, true)
&& !in_array(Campaign::DEVICE_DESKTOP, $campaign->devices, true)
) {
return true;
}
// check result of device detection in redis
$deviceKey = self::DEVICE_DETECTION_KEY.':'.md5($userAgent);
$deviceDetection = $this->resolveCachedValue($deviceKey);
if ($deviceDetection) {
if ($deviceDetection === Campaign::DEVICE_MOBILE && !in_array(Campaign::DEVICE_MOBILE, $campaign->devices, true)) {
return false;
}
if ($deviceDetection === Campaign::DEVICE_DESKTOP && !in_array(Campaign::DEVICE_DESKTOP, $campaign->devices, true)) {
return false;
}
return true;
}
// resolve device
$deviceDetectorResult = $this->resolveDevice($userAgent);
$isMobile = $deviceDetectorResult->isMobile();
$isDesktop = $deviceDetectorResult->isDesktop();
if ($isMobile) {
$deviceDetectionValue = Campaign::DEVICE_MOBILE;
} else if ($isDesktop) {
$deviceDetectionValue = Campaign::DEVICE_DESKTOP;
} else {
$deviceDetectionValue = 'other';
}
// store result to redis to faster resolution on the next attempt
$this->localCache[$deviceKey] = $deviceDetectionValue;
$this->redis->setex($deviceKey, self::DEVICE_DETECTION_TTL, $deviceDetectionValue);
if ($isMobile && !in_array(Campaign::DEVICE_MOBILE, $campaign->devices, true)) {
return false;
}
if ($isDesktop && !in_array(Campaign::DEVICE_DESKTOP, $campaign->devices, true)) {
return false;
}
return true;
}
public function isAcceptedByOperatingSystemRules(string $userAgent, Campaign $campaign): bool
{
$allowedOperatingSystems = $campaign->operating_systems;
if (empty($allowedOperatingSystems)) {
return true;
}
// check result of operating system detection in redis
$osKey = self::OPERATING_SYSTEM_DETECTION_KEY.':'.md5($userAgent);
$osDetection = $this->resolveCachedValue($osKey);
if ($osDetection) {
if ($osDetection === Campaign::OPERATING_SYSTEM_UNKNOWN
|| !in_array($osDetection, $allowedOperatingSystems, true)
) {
return false;
}
return true;
}
// resolve operating system
$deviceDetectorResult = $this->resolveDevice($userAgent);
$detectedOs = $deviceDetectorResult->getOs('short_name');
$osMapping = $campaign->getOperatingSystemsMapping();
foreach ($osMapping as $osValue => $osShortCodes) {
if (in_array($detectedOs, $osShortCodes, true)) {
$osDetection = $osValue;
}
}
if (empty($osDetection)) {
$osDetection = Campaign::OPERATING_SYSTEM_UNKNOWN;
}
// store result to redis to faster resolution on the next attempt
$this->localCache[$osKey] = $osDetection;
$this->redis->setex($osKey, self::DEVICE_DETECTION_TTL, $osDetection);
if ($osDetection === Campaign::OPERATING_SYSTEM_UNKNOWN
|| !in_array($osDetection, $allowedOperatingSystems, true)
) {
return false;
}
return true;
}
private function resolveCachedValue(string $cacheKey): ?string
{
if (isset($this->localCache[$cacheKey])) {
$cacheValue = $this->localCache[$cacheKey];
} else {
$cacheValue = $this->redis->get($cacheKey);
if ($cacheValue) {
$this->localCache[$cacheKey] = $cacheValue;
}
}
return $cacheValue;
}
private function resolveDevice(string $userAgent): DeviceDetector
{
if (!isset($this->deviceDetectorResults[$userAgent])) {
$this->deviceDetectorResults[$userAgent] = $this->deviceDetector->get($userAgent);
}
return $this->deviceDetectorResults[$userAgent];
}
public function flushLocalCache(): self
{
$this->localCache = [];
$this->deviceDetectorResults = [];
return $this;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Showtime/Showtime.php | Campaign/extensions/campaign-module/src/Http/Showtime/Showtime.php | <?php
namespace Remp\CampaignModule\Http\Showtime;
use Remp\CampaignModule\Banner;
use Remp\CampaignModule\Campaign;
use Remp\CampaignModule\CampaignBanner;
use Remp\CampaignModule\CampaignSegment;
use Remp\CampaignModule\Contracts\SegmentAggregator;
use Carbon\Carbon;
use Illuminate\Http\Request;
use Illuminate\Support\Collection;
use Predis\ClientInterface;
use Psr\Log\LoggerInterface;
class Showtime
{
private const BANNER_ONETIME_USER_KEY = 'banner_onetime_user';
private const BANNER_ONETIME_BROWSER_KEY = 'banner_onetime_browser';
private const PAGEVIEW_ATTRIBUTE_OPERATOR_IS = '=';
private const PAGEVIEW_ATTRIBUTE_OPERATOR_IS_NOT = '!=';
private $request;
private $positionMap;
private $dimensionMap;
private $alignmentsMap;
private $colorSchemesMap;
private array $snippets = [];
private array $localCache = [];
public function __construct(
private ClientInterface|\Redis $redis,
private SegmentAggregator $segmentAggregator,
private LazyGeoReader $geoReader,
private ShowtimeConfig $showtimeConfig,
private DeviceRulesEvaluator $deviceRulesEvaluator,
private LoggerInterface $logger
) {
}
public function setRequest(Request $request): void
{
$this->request = $request;
}
private function getRequest()
{
if (!$this->request) {
$this->request = Request::createFromGlobals();
}
return $this->request;
}
public function setPositionMap(\Remp\CampaignModule\Models\Position\Map $positions)
{
$this->positionMap = $positions->positions();
}
public function getShowtimeConfig(): ShowtimeConfig
{
return $this->showtimeConfig;
}
public function setDimensionMap(\Remp\CampaignModule\Models\Dimension\Map $dimensions)
{
$this->dimensionMap = $dimensions->dimensions();
}
public function setAlignmentsMap(\Remp\CampaignModule\Models\Alignment\Map $alignments)
{
$this->alignmentsMap = $alignments->alignments();
}
public function setColorSchemesMap(\Remp\CampaignModule\Models\ColorScheme\Map $colorSchemes)
{
$this->colorSchemesMap = $colorSchemes->colorSchemes();
}
public function flushLocalCache(): self
{
$this->localCache = [];
$this->deviceRulesEvaluator->flushLocalCache();
return $this;
}
public function showtime(string $userData, string $callback, ShowtimeResponse $showtimeResponse)
{
try {
$data = json_decode($userData);
} catch (\InvalidArgumentException $e) {
$this->logger->warning('could not decode JSON in Showtime: ' . $userData);
return $showtimeResponse->error($callback, 400, ['invalid data json provided']);
}
$url = $data->url ?? null;
if (!$url) {
return $showtimeResponse->error($callback, 400, ['url is required and missing']);
}
$userId = null;
if (isset($data->userId) || !empty($data->userId)) {
$userId = $data->userId;
}
$browserId = null;
if (isset($data->browserId) || !empty($data->browserId)) {
$browserId = $data->browserId;
}
if (!$browserId) {
return $showtimeResponse->error($callback, 400, ['browserId is required and missing']);
}
if (!property_exists($data, 'referer')) {
// see https://github.com/remp2020/remp/blob/ae5196826988a7df2d9a0b5ca64d1823c9f236d7/Campaign/extensions/campaign-module/resources/assets/js/remplib.js#L46
return $showtimeResponse->error($callback, 400, ['referer is required and missing (null is acceptable)']);
}
// language
if ($this->showtimeConfig->getAcceptLanguage()) {
$data->language = $this->showtimeConfig->getAcceptLanguage();
}
// debugger
$evaluationMessages = [];
$debugCampaignPublicId = null;
$debug = false;
if (isset($data->debug->key)) {
if ($data->debug->key === $this->showtimeConfig->getDebugKey()) {
$debug = true;
$debugCampaignPublicId = $data->debug->campaignPublicId ?? null;
if (isset($data->debug->userId)) {
$data->userId = $data->debug->userId;
$userId = $data->debug->userId;
}
if (isset($data->debug->referer)) {
$data->referer = $data->debug->referer;
}
} else {
$evaluationMessages[] = 'Invalid debug key';
}
}
$segmentAggregator = $this->segmentAggregator;
if (isset($data->cache)) {
$segmentAggregator->setProviderData($data->cache);
}
$this->loadMaps();
$positions = $this->positionMap;
$dimensions = $this->dimensionMap;
$alignments = $this->alignmentsMap;
$colorSchemes = $this->colorSchemesMap;
$snippets = $this->snippets;
$displayData = [];
if ($this->showtimeConfig->isOneTimeBannerEnabled()) {
// Try to load one-time banners (having precedence over campaigns)
$banner = null;
if ($userId) {
$banner = $this->loadOneTimeUserBanner($userId);
}
if (!$banner) {
$banner = $this->loadOneTimeBrowserBanner($browserId);
}
if ($banner) {
$displayData[] = $showtimeResponse->renderBanner(
banner: $banner,
alignments: $alignments,
dimensions: $dimensions,
positions: $positions,
colorSchemes: $colorSchemes,
snippets: $snippets,
);
return $showtimeResponse->success(
callback: $callback,
data: $displayData,
activeCampaigns: [],
providerData: $segmentAggregator->getProviderData(),
suppressedBanners: [],
evaluationMessages: $evaluationMessages,
);
}
}
$campaignIds = json_decode($this->redis->get(Campaign::ACTIVE_CAMPAIGN_IDS) ?? '[]') ?? [];
if (count($campaignIds) === 0) {
return $showtimeResponse->success(
callback: $callback,
data: [],
activeCampaigns: [],
providerData: $segmentAggregator->getProviderData(),
suppressedBanners: [],
evaluationMessages: $evaluationMessages,
);
}
// prepare campaign IDs to fetch
$cachedCampaignKeys = [];
$cachedCampaignSnippetCodesKeys = [];
foreach ($campaignIds as $campaignId) {
$cachedCampaignKeys[] = Campaign::CAMPAIGN_JSON_TAG . ":{$campaignId}";
$cachedCampaignSnippetCodesKeys[] = Campaign::CAMPAIGN_SNIPPET_CODES_JSON_TAG . ":{$campaignId}";
}
// fetch all running campaigns at once
$fetchedCampaigns = $this->redis->mget($cachedCampaignKeys);
// fetch all possibly active snippets
$fetchedCampaignSnippets = $this->redis->mget($cachedCampaignSnippetCodesKeys);
$campaignBannerSnippets = [];
foreach ($fetchedCampaignSnippets as $fetchedCampaignSnippet) {
$campaignBannerSnippets = array_merge(
$campaignBannerSnippets,
json_decode($fetchedCampaignSnippet, associative: true),
);
}
$activeCampaigns = [];
$campaigns = [];
$campaignBanners = [];
$debugCampaignId = null;
$suppressedBanners = [];
$this->flushLocalCache();
foreach ($fetchedCampaigns as $fetchedCampaign) {
/** @var Campaign $campaign */
$campaign = new Campaign();
$campaign->hydrateFromCache(json_decode($fetchedCampaign, true));
$campaigns[$campaign->id] = $campaign;
if ($campaign->public_id === $debugCampaignPublicId) {
$debugCampaignId = $campaign->id;
}
$result = $this->campaignBannerToDisplay(
campaign: $campaign,
userData: $data,
activeCampaigns: $activeCampaigns,
);
if ($result instanceof CampaignBanner) {
$campaignBanners[] = $result;
} else if ($debug && $campaign->id === $debugCampaignId) {
$evaluationMessages[] = $result;
}
}
$campaignBanners = array_filter($campaignBanners);
if ($this->showtimeConfig->isPrioritizeBannerOnSamePosition()) {
$campaignBanners = $this->prioritizeCampaignBannerOnPosition($campaigns, $campaignBanners, $activeCampaigns, $suppressedBanners);
}
foreach ($campaignBanners as $campaignBanner) {
if ($debugCampaignPublicId && $campaignBanner->campaign_id !== $debugCampaignId) {
// when debugging specific campaign, do not render other campaigns
continue;
}
$c = $campaigns[$campaignBanner->campaign_id];
if ($debug) {
$evaluationMessages[] = "Displaying campaign [{$c->public_id}] (variant [$campaignBanner->public_id], banner [{$campaignBanner->banner->public_id}])";
}
$matchedSnippets = array_intersect_key(
$this->snippets,
array_flip($campaignBannerSnippets[$campaignBanner->public_id]),
);
$displayData[] = $showtimeResponse->renderCampaign(
variant: $campaignBanner,
campaign: $campaigns[$campaignBanner->campaign_id],
alignments: $alignments,
dimensions: $dimensions,
positions: $positions,
colorSchemes: $colorSchemes,
snippets: $matchedSnippets,
userData: $data,
);
}
return $showtimeResponse->success(
$callback,
$displayData,
array_values($activeCampaigns), // make sure $activeCampaigns is always encoded as array in JSON
$segmentAggregator->getProviderData(),
$suppressedBanners,
$evaluationMessages
);
}
public function prioritizeCampaignBannerOnPosition(array $campaigns, array $campaignBanners, array &$activeCampaigns, array &$suppressedBanners): array
{
$bannersOnPosition = [];
foreach ($campaignBanners as $campaignBanner) {
$position = "{$campaignBanner->banner->display_type}_{$campaignBanner->banner->position}_{$campaignBanner->banner->target_selector}";
// add unique suffix to banner position, so it doesn't suppress other visible and hidden banners remp/remp#1346
if ($campaignBanner->banner->template === 'html' && $campaignBanner->banner->htmlTemplate->dimensions === 'hidden') {
$position .= "_hidden_{$campaignBanner->id}";
}
if (isset($bannersOnPosition[$position])) {
/** @var CampaignBanner $bannerOnPosition */
$bannerOnPosition = $bannersOnPosition[$position];
/** @var Campaign $currentCampaign */
$currentCampaign = $campaigns[$bannerOnPosition->campaign_id];
/** @var Campaign $newCampaign */
$newCampaign = $campaigns[$campaignBanner->campaign_id];
if ($this->isNewCampaignPriorityHigher($newCampaign, $currentCampaign)) {
$suppressedBanners[] = [
'campaign_banner_public_id' => $bannerOnPosition->public_id,
'banner_public_id' => $bannerOnPosition->banner->public_id,
'campaign_public_id' => $currentCampaign->public_id,
'position' => $position,
];
$bannersOnPosition[$position] = $campaignBanner;
$this->removeCampaignByUuid($activeCampaigns, $currentCampaign->uuid);
} else {
$suppressedBanners[] = [
'campaign_banner_public_id' => $campaignBanner->public_id,
'banner_public_id' => $campaignBanner->banner->public_id,
'campaign_public_id' => $newCampaign->public_id,
'position' => $position,
];
$this->removeCampaignByUuid($activeCampaigns, $newCampaign->uuid);
}
} else {
$bannersOnPosition[$position] = $campaignBanner;
}
}
// set winning campaigns
foreach ($suppressedBanners as $i => $suppressedBanner) {
$winningBanner = $bannersOnPosition[$suppressedBanner['position']];
$winningCampaign = $campaigns[$winningBanner->campaign_id];
$suppressedBanners[$i]['suppressed_by_campaign_public_id'] = $winningCampaign->public_id;
unset($suppressedBanners[$i]['position']);
}
return array_values($bannersOnPosition);
}
private function isNewCampaignPriorityHigher(Campaign $newCampaign, Campaign $currentCampaign): bool
{
// campaign with more banners has higher priority
if ($newCampaign->campaignBanners->count() > $currentCampaign->campaignBanners->count()) {
return true;
}
if ($currentCampaign->campaignBanners->count() === $newCampaign->campaignBanners->count()) {
// campaign with more recent updates has higher priority
if ($newCampaign->updated_at > $currentCampaign->updated_at) {
return true;
}
}
return false;
}
private function removeCampaignByUuid(array &$campaigns, string $uuid): void
{
foreach ($campaigns as $key => $campaign) {
if ($campaign['uuid'] === $uuid) {
unset($campaigns[$key]);
return;
}
}
}
/**
* Determines what campaign banner should be displayed for user/browser
* Returns either campaign banner or string message saying why no campaign banner will be display.
*
* @param Campaign $campaign
* @param $userData
* @param array $activeCampaigns
*
* @return CampaignBanner|string
*/
protected function campaignBannerToDisplay(
Campaign $campaign,
$userData,
array &$activeCampaigns,
): CampaignBanner|string {
$userId = $userData->userId ?? null;
$browserId = $userData->browserId;
$running = false;
foreach ($campaign->schedules as $schedule) {
if ($schedule->isRunning()) {
$running = true;
break;
}
}
if (!$running) {
return "Campaign is not running";
}
/** @var Collection $campaignBanners */
$campaignBanners = $campaign->campaignBanners->keyBy('uuid');
// banner
if ($campaignBanners->count() == 0) {
$this->logger->error("Active campaign [{$campaign->uuid}] has no banner set");
return "Campaign not shown because it has no banner set";
}
$bannerUuid = null;
$variantUuid = null;
// find variant previously displayed to user
$seenCampaigns = $userData->campaigns ?? false;
if ($seenCampaigns) {
if (isset($seenCampaigns->{$campaign->uuid})) {
$bannerUuid = $seenCampaigns->{$campaign->uuid}->bannerId ?? null;
$variantUuid = $seenCampaigns->{$campaign->uuid}->variantId ?? null;
}
if (isset($seenCampaigns->{$campaign->public_id}->variantId)) {
foreach ($campaign->campaignBanners as $campaignBanner) {
if ($campaignBanner->public_id === $seenCampaigns->{$campaign->public_id}->variantId) {
$bannerUuid = $campaignBanner->banner->uuid ?? null;
$variantUuid = $campaignBanner->uuid ?? null;
break;
}
}
}
}
// fallback for older version of campaigns local storage data
// where decision was based on bannerUuid and not variantUuid (which was not present at all)
if ($bannerUuid && !$variantUuid) {
foreach ($campaignBanners as $campaignBanner) {
if (optional($campaignBanner->banner)->uuid === $bannerUuid) {
$variantUuid = $campaignBanner->uuid;
break;
}
}
}
// unset seen variant if it was deleted
/** @var CampaignBanner $seenVariant */
$seenVariant = $campaignBanners->get($variantUuid);
if (!$seenVariant) {
$variantUuid = null;
}
// unset seen variant if its proportion is 0%
if ($seenVariant && $seenVariant->proportion === 0) {
$variantUuid = null;
}
// variant still not set, choose random variant
if ($variantUuid === null) {
$variantsMapping = $campaign->getVariantsProportionMapping();
$randVal = mt_rand(0, 100);
$currPercent = 0;
foreach ($variantsMapping as $uuid => $proportion) {
$currPercent = $currPercent + $proportion;
if ($currPercent >= $randVal) {
$variantUuid = $uuid;
break;
}
}
}
/** @var CampaignBanner $variant */
$variant = $campaignBanners->get($variantUuid);
if (!$variant) {
$this->logger->error("Unable to get CampaignBanner [{$variantUuid}] for campaign [{$campaign->uuid}]");
return "Campaign not shown because there is no CampaignBanner with UUID [{$variantUuid}]";
}
// check if campaign is set to be seen only once per session
$campaignsSeenInSession = $userData->campaignsSession ?? [];
if ($campaign->once_per_session && $campaignsSeenInSession) {
$seen = isset($campaignsSeenInSession->{$campaign->uuid});
if ($seen) {
return "Campaign not shown because it can be displayed only once per session";
}
}
// signed in state
if (isset($campaign->signed_in) && $campaign->signed_in !== (bool) $userId) {
$requireSignedUser = (bool)$campaign->signed_in;
return "Campaign not shown because it requires " . ($requireSignedUser ? "signed user" : "anonymous user");
}
// using adblock?
if ($campaign->using_adblock !== null) {
if (!isset($userData->usingAdblock)) {
$this->logger->error("Unable to load if user with ID [{$userId}] & browserId [{$browserId}] is using AdBlock");
return "Campaign not shown because system was unable to check if user with ID [{$userId}] & browserId [{$browserId}] is using AdBlock";
}
if (($campaign->using_adblock && !$userData->usingAdblock)) {
return "Campaign not shown because user with ID [{$userId}] is not using AdBlock";
}
if ($campaign->using_adblock === false && $userData->usingAdblock) {
return "Campaign not shown because user with ID [{$userId}] is using AdBlock";
}
}
// url filters
if ($campaign->url_filter === Campaign::URL_FILTER_EXCEPT_AT) {
foreach ($campaign->url_patterns as $urlPattern) {
if (strpos($userData->url, $urlPattern) !== false) {
return "Campaign not shown because of the URL filter [{$urlPattern}] (matched URL [{$userData->url}])";
}
}
}
if ($campaign->url_filter === Campaign::URL_FILTER_ONLY_AT) {
$matched = false;
foreach ($campaign->url_patterns as $urlPattern) {
if (strpos($userData->url, $urlPattern) !== false) {
$matched = true;
}
}
if (!$matched) {
return "Campaign not shown because it does not match any of given URL filter(s)";
}
}
// source referer filters
if ($campaign->source_filter === Campaign::SOURCE_FILTER_REFERER_EXCEPT_AT && $userData->referer) {
foreach ($campaign->source_patterns as $sourcePattern) {
if (strpos($userData->referer, $sourcePattern) !== false) {
return "Campaign not shown because of the referer source filter [{$sourcePattern}] (provided referer [{$userData->referer}])";
}
}
}
if ($campaign->source_filter === Campaign::SOURCE_FILTER_REFERER_ONLY_AT) {
if (!isset($userData->referer) || $userData->referer === '') {
return "Campaign not shown because user didn't provide a referer and campaign has filter on it";
}
$matched = false;
foreach ($campaign->source_patterns as $sourcePattern) {
if (strpos($userData->referer, $sourcePattern) !== false) {
$matched = true;
break;
}
}
if (!$matched) {
return "Campaign not shown because it does not match referer source filter (provided referer [{$userData->referer}])";
}
}
// session referer filters
if ($campaign->source_filter === Campaign::SOURCE_FILTER_SESSION_EXCEPT_AT && $userData->sessionReferer) {
foreach ($campaign->source_patterns as $sourcePattern) {
if (strpos($userData->sessionReferer, $sourcePattern) !== false) {
return "Campaign not shown because of the session source filter [{$sourcePattern}] (provided session source [{$userData->sessionReferer}])";
}
}
}
if ($campaign->source_filter === Campaign::SOURCE_FILTER_SESSION_ONLY_AT) {
if (!isset($userData->sessionReferer) || $userData->sessionReferer === '') {
return "Campaign not shown because user didn't provide a session source and campaign has filter on it";
}
$matched = false;
foreach ($campaign->source_patterns as $sourcePattern) {
if (strpos($userData->sessionReferer, $sourcePattern) !== false) {
$matched = true;
break;
}
}
if (!$matched) {
return "Campaign not shown because it does not match session source filter (provided session referer [{$userData->sessionReferer}])";
}
}
// user agent specific rules
if (isset($userData->userAgent)) {
// device rules
if ($this->deviceRulesEvaluator->isAcceptedByDeviceRules($userData->userAgent, $campaign) === false) {
return "Campaign not shown because it's not accepted according to device rules";
}
// operating system rules
if ($this->deviceRulesEvaluator->isAcceptedByOperatingSystemRules($userData->userAgent, $campaign) === false) {
return "Campaign not shown because it's not accepted according to operating system rules";
}
} else {
$this->logger->error("Unable to load user agent for userId [{$userId}]");
}
// country rules
if (!$campaign->countries->isEmpty()) {
// load country ISO code based on IP
try {
$countryCode = $this->geoReader->countryCode($this->getRequest()->ip());
if ($countryCode === null) {
$this->logger->debug("Unable to identify country for campaign '{$campaign->id}'.");
return "Campaign not shown because we were unable to identify country";
}
} catch (\MaxMind\Db\Reader\InvalidDatabaseException $e) {
$this->logger->error("Unable to identify country for campaign '{$campaign->id}': " . $e->getMessage());
return "Campaign not shown because we were unable to identify country (InvalidDatabaseException)";
} catch (\GeoIp2\Exception\AddressNotFoundException $e) {
// This may happen, do not throw exception here
// see https://github.com/maxmind/GeoIP2-php/issues/105
return "Campaign not shown because we were unable to identify location from IP address [{$this->getRequest()->ip()}]";
}
// check against white / black listed countries
if (!$campaign->countriesBlacklist->isEmpty() && $campaign->countriesBlacklist->contains('iso_code', $countryCode)) {
return "Campaign not shown because country [{$countryCode}] is blacklisted";
}
if (!$campaign->countriesWhitelist->isEmpty() && !$campaign->countriesWhitelist->contains('iso_code', $countryCode)) {
return "Campaign not shown because country [{$countryCode}] is not whitelisted";
}
}
// languages rules
if (!empty($userData->language)) {
$userData->primaryLanguage = \Locale::getPrimaryLanguage($userData->language);
}
if (!empty($campaign->languages)) {
if (empty($userData->primaryLanguage) || !in_array($userData->primaryLanguage, $campaign->languages, true)) {
return "Campaign not shown because of the language rules";
}
}
// segment
$segmentRulesOk = $this->evaluateSegmentRules($campaign, $browserId, $userId);
if (!$segmentRulesOk) {
return "Campaign not shown because it does not pass the segment rules (userId: [$userId], browserId: [$browserId])";
}
// pageview attributes - check if sent pageview attributes match conditions
if (!empty($campaign->pageview_attributes)) {
if (empty($userData->pageviewAttributes)) {
return "Campaign not shown because user sent no pageview attributes";
}
foreach ($campaign->pageview_attributes as $attribute) {
$attrName = $attribute['name'];
$attrValue = $attribute['value'];
$attrOperator = $attribute['operator'];
if ($attrOperator === self::PAGEVIEW_ATTRIBUTE_OPERATOR_IS) {
if (!property_exists($userData->pageviewAttributes, $attrName)) {
return "Campaign not shown because user has no [$attrName] attribute";
}
if (is_array($userData->pageviewAttributes->{$attrName})) {
if (!in_array($attrValue, $userData->pageviewAttributes->{$attrName})) {
return "Campaign not shown because user attribute [$attrName] (array) does not contain '$attrValue'";
}
} elseif ($userData->pageviewAttributes->{$attrName} !== $attrValue) {
return "Campaign not shown because user attribute [$attrName] value is not '$attrValue'";
}
}
if ($attrOperator === self::PAGEVIEW_ATTRIBUTE_OPERATOR_IS_NOT) {
if (property_exists($userData->pageviewAttributes, $attrName)) {
if (is_array($userData->pageviewAttributes->{$attrName})) {
if (in_array($attrValue, $userData->pageviewAttributes->{$attrName})) {
return "Campaign not shown because user attribute [$attrName] (array) contains '$attrValue'";
}
} else {
if ($userData->pageviewAttributes->{$attrName} === $attrValue) {
return "Campaign not shown because user attribute [$attrName] equals '$attrValue'";
}
}
}
}
}
}
// Active campaign is campaign that targets selected user (previous rules were passed),
// but whether it displays or not depends on pageview counting rules (every n-th page, up to N pageviews).
// We need to track such campaigns on the client-side too.
$activeCampaigns[] = ['uuid' => $campaign->uuid, 'public_id' => $campaign->public_id];
$seenCampaign = $seenCampaigns->{$campaign->uuid} ?? $seenCampaigns->{$campaign->public_id} ?? null;
// pageview rules - check display banner every n-th request
if ($seenCampaign !== null && $campaign->pageview_rules !== null) {
$pageviewCount = $seenCampaign->count ?? null;
if ($pageviewCount === null) {
// if campaign is recorder as seen but has no pageview count,
// it means there is a probably old version or remplib cached on the client
// do not show campaign (browser should reload the library)
return "Campaign not shown because user has no pageview count (probably old version of remplib)";
}
$displayBanner = $campaign->pageview_rules['display_banner'] ?? null;
$displayBannerEvery = $campaign->pageview_rules['display_banner_every'] ?? 1;
if ($displayBanner === 'every' && $pageviewCount % $displayBannerEvery !== 0) {
return "Campaign not shown because of 'display-banner-every' pageview rule (pageview count [$pageviewCount])";
}
$sessionCampaign = $campaignsSeenInSession->{$campaign->uuid} ?? $campaignsSeenInSession->{$campaign->public_id} ?? null;
if (property_exists($seenCampaign, 'closedAt')) {
$afterClosedRule = $campaign->pageview_rules['after_banner_closed_display'] ?? null;
$afterClosedHours = $campaign->pageview_rules['after_closed_hours'] ?? 0;
if ($afterClosedRule === 'never') {
return "Campaign not shown because of 'after-close-rule=never' pageview rule";
}
if ($afterClosedRule === 'never_in_session' && isset($sessionCampaign->closedAt)) {
return "Campaign not shown because of 'after-close-rule=never_in_session' pageview rule";
}
if ($afterClosedRule === 'close_for_hours' && $afterClosedHours) {
$threshold = time() - $afterClosedHours * 60 * 60;
if ($seenCampaign->closedAt > $threshold) {
return "Campaign not shown because of 'after-close-rule=close_for_hours' pageview rule";
}
}
}
if (property_exists($seenCampaign, 'clickedAt')) {
$afterClickedRule = $campaign->pageview_rules['after_banner_clicked_display'] ?? null;
$afterClickedHours = $campaign->pageview_rules['after_clicked_hours'] ?? 0;
if ($afterClickedRule === 'never') {
return "Campaign not shown because of 'after-click-rule=never' pageview rule";
}
if ($afterClickedRule === 'never_in_session' && isset($sessionCampaign->clickedAt)) {
return "Campaign not shown because of 'after-click-rule=never_in_session' pageview rule";
}
if ($afterClickedRule === 'close_for_hours' && $afterClickedHours) {
$threshold = time() - $afterClickedHours * 60 * 60;
if ($seenCampaign->clickedAt > $threshold) {
return "Campaign not shown because of 'after-click-rule=close_for_hours' pageview rule";
}
}
}
}
// seen count rules
if ($seenCampaign !== null && $campaign->pageview_rules !== null) {
$seenCount = $seenCampaign->seen ?? null;
if ($seenCount === null) {
// if campaign is recorder as seen but has no pageview count,
// it means there is a probably old version or remplib cached on the client
// do not show campaign (browser should reload the library)
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | true |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Middleware/ConvertStringBooleans.php | Campaign/extensions/campaign-module/src/Http/Middleware/ConvertStringBooleans.php | <?php
namespace Remp\CampaignModule\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\TransformsRequest;
class ConvertStringBooleans extends TransformsRequest
{
protected function transform($key, $value)
{
if ($value === 'true' || $value === 'TRUE') {
return true;
}
if ($value === 'false' || $value === 'FALSE') {
return false;
}
return $value;
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Middleware/CollectionQueryString.php | Campaign/extensions/campaign-module/src/Http/Middleware/CollectionQueryString.php | <?php
namespace Remp\CampaignModule\Http\Middleware;
use Remp\CampaignModule\CampaignCollection;
use Closure;
use Illuminate\Http\Request;
class CollectionQueryString
{
/**
* @param Request $request
* @param Closure $next
* @return mixed
*/
public function handle(Request $request, Closure $next)
{
if ($request->filled('collection')) {
$collection = CampaignCollection::where('id', $request->collection)->firstOrFail();
$request->route()?->setParameter('collection', $collection);
}
return $next($request);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Middleware/SerializeSegmentAggregator.php | Campaign/extensions/campaign-module/src/Http/Middleware/SerializeSegmentAggregator.php | <?php
namespace Remp\CampaignModule\Http\Middleware;
use Remp\CampaignModule\Contracts\SegmentAggregator;
use Closure;
class SerializeSegmentAggregator
{
private $segmentAggregator;
public function __construct(SegmentAggregator $segmentAggregator)
{
$this->segmentAggregator = $segmentAggregator;
}
/**
* Handle an incoming request.
*
* @param \Illuminate\Http\Request $request
* @param \Closure $next
* @return mixed
*/
public function handle($request, Closure $next)
{
if (strpos($request->path(), 'showtime') === false) {
// serialize segment aggregator (required in showtime.php)
$this->segmentAggregator->serializeToRedis();
}
return $next($request);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Resources/SnippetSearchResource.php | Campaign/extensions/campaign-module/src/Http/Resources/SnippetSearchResource.php | <?php
namespace Remp\CampaignModule\Http\Resources;
use Illuminate\Http\Request;
use Remp\CampaignModule\Snippet;
use Remp\LaravelHelpers\Resources\JsonResource;
/**
* @mixin Snippet
*/
class SnippetSearchResource extends JsonResource
{
public function toArray(Request $request)
{
return [
'type' => 'snippet',
'name' => $this->name,
'search_result_url' => route('snippets.edit', $this)
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Resources/BannerSearchResource.php | Campaign/extensions/campaign-module/src/Http/Resources/BannerSearchResource.php | <?php
namespace Remp\CampaignModule\Http\Resources;
use Illuminate\Http\Request;
use Remp\CampaignModule\Banner;
use Remp\LaravelHelpers\Resources\JsonResource;
/**
* @mixin Banner
*/
class BannerSearchResource extends JsonResource
{
public function toArray(Request $request)
{
return [
'type' => 'banner',
'name' => $this->name,
'search_result_url' => route('banners.edit', $this)
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Resources/BannerResource.php | Campaign/extensions/campaign-module/src/Http/Resources/BannerResource.php | <?php
namespace Remp\CampaignModule\Http\Resources;
use Remp\LaravelHelpers\Resources\JsonResource;
class BannerResource extends JsonResource
{
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Resources/CampaignSearchResource.php | Campaign/extensions/campaign-module/src/Http/Resources/CampaignSearchResource.php | <?php
namespace Remp\CampaignModule\Http\Resources;
use Remp\CampaignModule\Campaign;
use Remp\LaravelHelpers\Resources\JsonResource;
/**
* Class CampaignSearchResource
*
* @mixin Campaign
* @package App\Http\Resources
*/
class CampaignSearchResource extends JsonResource
{
/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request $request
* @return array
*/
public function toArray($request)
{
return [
'type' => 'campaign',
'name' => $this->name,
'banners' => $this->when($this->banners->isNotEmpty(), $this->banners->pluck('name')),
'search_result_url' => route('campaigns.edit', $this)
];
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Resources/CollectionResource.php | Campaign/extensions/campaign-module/src/Http/Resources/CollectionResource.php | <?php
namespace Remp\CampaignModule\Http\Resources;
use Illuminate\Http\Resources\Json\JsonResource;
class CollectionResource extends JsonResource
{
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Resources/ScheduleResource.php | Campaign/extensions/campaign-module/src/Http/Resources/ScheduleResource.php | <?php
namespace Remp\CampaignModule\Http\Resources;
use Remp\LaravelHelpers\Resources\JsonResource;
class ScheduleResource extends JsonResource
{
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Resources/SearchResource.php | Campaign/extensions/campaign-module/src/Http/Resources/SearchResource.php | <?php
namespace Remp\CampaignModule\Http\Resources;
use Illuminate\Http\Request;
use Illuminate\Support\Arr;
use Remp\LaravelHelpers\Resources\JsonResource;
class SearchResource extends JsonResource
{
public function toArray(Request $request)
{
$banners = $this->resource['banners'];
$campaigns = $this->resource['campaigns'];
$snippets = $this->resource['snippets'];
return Arr::collapse([
$this->when($banners->isNotEmpty(), BannerSearchResource::collection($banners)->toArray(app('request'))),
$this->when($campaigns->isNotEmpty(), CampaignSearchResource::collection($campaigns)->toArray(app('request'))),
$this->when($snippets->isNotEmpty(), SnippetSearchResource::collection($snippets)->toArray(app('request'))),
]);
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Resources/CampaignResource.php | Campaign/extensions/campaign-module/src/Http/Resources/CampaignResource.php | <?php
namespace Remp\CampaignModule\Http\Resources;
use Remp\LaravelHelpers\Resources\JsonResource;
class CampaignResource extends JsonResource
{
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Http/Resources/SnippetResource.php | Campaign/extensions/campaign-module/src/Http/Resources/SnippetResource.php | <?php
namespace Remp\CampaignModule\Http\Resources;
use Remp\LaravelHelpers\Resources\JsonResource;
class SnippetResource extends JsonResource
{
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Observers/Snippet.php | Campaign/extensions/campaign-module/src/Observers/Snippet.php | <?php
namespace Remp\CampaignModule\Observers;
class Snippet
{
public function saved()
{
\Remp\CampaignModule\Snippet::refreshSnippetsCache();
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Observers/Campaign.php | Campaign/extensions/campaign-module/src/Observers/Campaign.php | <?php
namespace Remp\CampaignModule\Observers;
class Campaign
{
public function saved(\Remp\CampaignModule\Campaign $campaign)
{
$campaign->cache();
}
public function pivotAttached(\Remp\CampaignModule\Campaign $campaign)
{
$campaign->cache();
}
public function pivotDetached(\Remp\CampaignModule\Campaign $campaign)
{
$campaign->cache();
}
public function pivotUpdated(\Remp\CampaignModule\Campaign $campaign)
{
$campaign->cache();
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Observers/Schedule.php | Campaign/extensions/campaign-module/src/Observers/Schedule.php | <?php
namespace Remp\CampaignModule\Observers;
class Schedule
{
public function saved(\Remp\CampaignModule\Schedule $schedule)
{
$schedule->campaign->cache();
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Observers/CampaignSegment.php | Campaign/extensions/campaign-module/src/Observers/CampaignSegment.php | <?php
namespace Remp\CampaignModule\Observers;
class CampaignSegment
{
public function saved(\Remp\CampaignModule\CampaignSegment $campaignSegment)
{
$campaignSegment->campaign->cache();
}
public function deleted(\Remp\CampaignModule\CampaignSegment $campaignSegment)
{
$campaignSegment->campaign->cache();
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Observers/Banner.php | Campaign/extensions/campaign-module/src/Observers/Banner.php | <?php
namespace Remp\CampaignModule\Observers;
class Banner
{
public function saved(\Remp\CampaignModule\Banner $banner)
{
$banner->cache();
/** @var \Remp\CampaignModule\Campaign $campaign */
foreach ($banner->campaigns as $campaign) {
$campaign->cache();
}
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Observers/CampaignBanner.php | Campaign/extensions/campaign-module/src/Observers/CampaignBanner.php | <?php
namespace Remp\CampaignModule\Observers;
class CampaignBanner
{
public function saved(\Remp\CampaignModule\CampaignBanner $campaignBanner)
{
$campaignBanner->campaign->cache();
}
public function deleted(\Remp\CampaignModule\CampaignBanner $campaignBanner)
{
$campaignBanner->campaign->cache();
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Rules/VariantsProportionSum.php | Campaign/extensions/campaign-module/src/Rules/VariantsProportionSum.php | <?php
namespace Remp\CampaignModule\Rules;
use Illuminate\Contracts\Validation\Rule;
use Request;
class VariantsProportionSum implements Rule
{
/**
* Determine if the validation rule passes.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
public function passes($attribute, $value)
{
$sum = 0;
$variants = Request::get('variants');
foreach ($variants as $variant) {
$sum += $variant['proportion'];
}
if ($sum !== 100) {
return false;
}
return true;
}
/**
* Get the validation error message.
*
* @return string
*/
public function message()
{
return 'Sum of variant proportions must be 100.';
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Rules/ContainsHtmlLink.php | Campaign/extensions/campaign-module/src/Rules/ContainsHtmlLink.php | <?php
namespace Remp\CampaignModule\Rules;
use Closure;
use Illuminate\Contracts\Validation\ValidationRule;
class ContainsHtmlLink implements ValidationRule
{
public function validate(string $attribute, mixed $value, Closure $fail): void
{
if (empty($value)) {
$fail('The :attribute field must contain at least one HTML link.');
return;
}
if (preg_match('/<\s*a[^>]*>(.*?)<\s*\/\s*a>/', $value) !== 1) {
$fail('The :attribute field must contain at least one HTML link.');
}
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
remp2020/remp | https://github.com/remp2020/remp/blob/c616d27734c65eb87b470751928ff1119c535549/Campaign/extensions/campaign-module/src/Rules/ValidCarbonDate.php | Campaign/extensions/campaign-module/src/Rules/ValidCarbonDate.php | <?php
namespace Remp\CampaignModule\Rules;
use Carbon\Carbon;
use Exception;
use Illuminate\Contracts\Validation\Rule;
class ValidCarbonDate implements Rule
{
/**
* @inheritDoc
*/
public function passes($attribute, $value)
{
try {
Carbon::parse($value);
return true;
} catch (Exception $e) {
return false;
}
}
/**
* @inheritDoc
*/
public function message()
{
return 'The :attribute is not a valid date.';
}
}
| php | MIT | c616d27734c65eb87b470751928ff1119c535549 | 2026-01-05T05:12:01.604239Z | false |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.