123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322 |
- <?php
-
- namespace Illuminate\Queue;
-
- use Illuminate\Support\Carbon;
- use Illuminate\Database\Connection;
- use Illuminate\Queue\Jobs\DatabaseJob;
- use Illuminate\Queue\Jobs\DatabaseJobRecord;
- use Illuminate\Contracts\Queue\Queue as QueueContract;
-
- class DatabaseQueue extends Queue implements QueueContract
- {
- /**
- * The database connection instance.
- *
- * @var \Illuminate\Database\Connection
- */
- protected $database;
-
- /**
- * The database table that holds the jobs.
- *
- * @var string
- */
- protected $table;
-
- /**
- * The name of the default queue.
- *
- * @var string
- */
- protected $default;
-
- /**
- * The expiration time of a job.
- *
- * @var int|null
- */
- protected $retryAfter = 60;
-
- /**
- * Create a new database queue instance.
- *
- * @param \Illuminate\Database\Connection $database
- * @param string $table
- * @param string $default
- * @param int $retryAfter
- * @return void
- */
- public function __construct(Connection $database, $table, $default = 'default', $retryAfter = 60)
- {
- $this->table = $table;
- $this->default = $default;
- $this->database = $database;
- $this->retryAfter = $retryAfter;
- }
-
- /**
- * Get the size of the queue.
- *
- * @param string $queue
- * @return int
- */
- public function size($queue = null)
- {
- return $this->database->table($this->table)
- ->where('queue', $this->getQueue($queue))
- ->count();
- }
-
- /**
- * Push a new job onto the queue.
- *
- * @param string $job
- * @param mixed $data
- * @param string $queue
- * @return mixed
- */
- public function push($job, $data = '', $queue = null)
- {
- return $this->pushToDatabase($queue, $this->createPayload($job, $data));
- }
-
- /**
- * Push a raw payload onto the queue.
- *
- * @param string $payload
- * @param string $queue
- * @param array $options
- * @return mixed
- */
- public function pushRaw($payload, $queue = null, array $options = [])
- {
- return $this->pushToDatabase($queue, $payload);
- }
-
- /**
- * Push a new job onto the queue after a delay.
- *
- * @param \DateTimeInterface|\DateInterval|int $delay
- * @param string $job
- * @param mixed $data
- * @param string $queue
- * @return void
- */
- public function later($delay, $job, $data = '', $queue = null)
- {
- return $this->pushToDatabase($queue, $this->createPayload($job, $data), $delay);
- }
-
- /**
- * Push an array of jobs onto the queue.
- *
- * @param array $jobs
- * @param mixed $data
- * @param string $queue
- * @return mixed
- */
- public function bulk($jobs, $data = '', $queue = null)
- {
- $queue = $this->getQueue($queue);
-
- $availableAt = $this->availableAt();
-
- return $this->database->table($this->table)->insert(collect((array) $jobs)->map(
- function ($job) use ($queue, $data, $availableAt) {
- return $this->buildDatabaseRecord($queue, $this->createPayload($job, $data), $availableAt);
- }
- )->all());
- }
-
- /**
- * Release a reserved job back onto the queue.
- *
- * @param string $queue
- * @param \Illuminate\Queue\Jobs\DatabaseJobRecord $job
- * @param int $delay
- * @return mixed
- */
- public function release($queue, $job, $delay)
- {
- return $this->pushToDatabase($queue, $job->payload, $delay, $job->attempts);
- }
-
- /**
- * Push a raw payload to the database with a given delay.
- *
- * @param string|null $queue
- * @param string $payload
- * @param \DateTimeInterface|\DateInterval|int $delay
- * @param int $attempts
- * @return mixed
- */
- protected function pushToDatabase($queue, $payload, $delay = 0, $attempts = 0)
- {
- return $this->database->table($this->table)->insertGetId($this->buildDatabaseRecord(
- $this->getQueue($queue), $payload, $this->availableAt($delay), $attempts
- ));
- }
-
- /**
- * Create an array to insert for the given job.
- *
- * @param string|null $queue
- * @param string $payload
- * @param int $availableAt
- * @param int $attempts
- * @return array
- */
- protected function buildDatabaseRecord($queue, $payload, $availableAt, $attempts = 0)
- {
- return [
- 'queue' => $queue,
- 'attempts' => $attempts,
- 'reserved_at' => null,
- 'available_at' => $availableAt,
- 'created_at' => $this->currentTime(),
- 'payload' => $payload,
- ];
- }
-
- /**
- * Pop the next job off of the queue.
- *
- * @param string $queue
- * @return \Illuminate\Contracts\Queue\Job|null
- * @throws \Exception|\Throwable
- */
- public function pop($queue = null)
- {
- $queue = $this->getQueue($queue);
-
- return $this->database->transaction(function () use ($queue) {
- if ($job = $this->getNextAvailableJob($queue)) {
- return $this->marshalJob($queue, $job);
- }
-
- return null;
- });
- }
-
- /**
- * Get the next available job for the queue.
- *
- * @param string|null $queue
- * @return \Illuminate\Queue\Jobs\DatabaseJobRecord|null
- */
- protected function getNextAvailableJob($queue)
- {
- $job = $this->database->table($this->table)
- ->lockForUpdate()
- ->where('queue', $this->getQueue($queue))
- ->where(function ($query) {
- $this->isAvailable($query);
- $this->isReservedButExpired($query);
- })
- ->orderBy('id', 'asc')
- ->first();
-
- return $job ? new DatabaseJobRecord((object) $job) : null;
- }
-
- /**
- * Modify the query to check for available jobs.
- *
- * @param \Illuminate\Database\Query\Builder $query
- * @return void
- */
- protected function isAvailable($query)
- {
- $query->where(function ($query) {
- $query->whereNull('reserved_at')
- ->where('available_at', '<=', $this->currentTime());
- });
- }
-
- /**
- * Modify the query to check for jobs that are reserved but have expired.
- *
- * @param \Illuminate\Database\Query\Builder $query
- * @return void
- */
- protected function isReservedButExpired($query)
- {
- $expiration = Carbon::now()->subSeconds($this->retryAfter)->getTimestamp();
-
- $query->orWhere(function ($query) use ($expiration) {
- $query->where('reserved_at', '<=', $expiration);
- });
- }
-
- /**
- * Marshal the reserved job into a DatabaseJob instance.
- *
- * @param string $queue
- * @param \Illuminate\Queue\Jobs\DatabaseJobRecord $job
- * @return \Illuminate\Queue\Jobs\DatabaseJob
- */
- protected function marshalJob($queue, $job)
- {
- $job = $this->markJobAsReserved($job);
-
- return new DatabaseJob(
- $this->container, $this, $job, $this->connectionName, $queue
- );
- }
-
- /**
- * Mark the given job ID as reserved.
- *
- * @param \Illuminate\Queue\Jobs\DatabaseJobRecord $job
- * @return \Illuminate\Queue\Jobs\DatabaseJobRecord
- */
- protected function markJobAsReserved($job)
- {
- $this->database->table($this->table)->where('id', $job->id)->update([
- 'reserved_at' => $job->touch(),
- 'attempts' => $job->increment(),
- ]);
-
- return $job;
- }
-
- /**
- * Delete a reserved job from the queue.
- *
- * @param string $queue
- * @param string $id
- * @return void
- * @throws \Exception|\Throwable
- */
- public function deleteReserved($queue, $id)
- {
- $this->database->transaction(function () use ($id) {
- if ($this->database->table($this->table)->lockForUpdate()->find($id)) {
- $this->database->table($this->table)->where('id', $id)->delete();
- }
- });
- }
-
- /**
- * Get the queue or return the default.
- *
- * @param string|null $queue
- * @return string
- */
- public function getQueue($queue)
- {
- return $queue ?: $this->default;
- }
-
- /**
- * Get the underlying database instance.
- *
- * @return \Illuminate\Database\Connection
- */
- public function getDatabase()
- {
- return $this->database;
- }
- }
|