blob: 371319cca4c15dc4d0b8d138386177fa91ac4524 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Robin Appelman <icewind@owncloud.com>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Command;
use OCP\Command\IBus;
use OCP\Command\ICommand;
use SuperClosure\Serializer;
/**
* Asynchronous command bus that uses the background job system as backend
*/
class AsyncBus implements IBus {
/**
* @var \OCP\BackgroundJob\IJobList
*/
private $jobList;
/**
* List of traits for command which require sync execution
*
* @var string[]
*/
private $syncTraits = [];
/**
* @param \OCP\BackgroundJob\IJobList $jobList
*/
function __construct($jobList) {
$this->jobList = $jobList;
}
/**
* Schedule a command to be fired
*
* @param \OCP\Command\ICommand | callable $command
*/
public function push($command) {
if ($this->canRunAsync($command)) {
$this->jobList->add($this->getJobClass($command), $this->serializeCommand($command));
} else {
$this->runCommand($command);
}
}
/**
* Require all commands using a trait to be run synchronous
*
* @param string $trait
*/
public function requireSync($trait) {
$this->syncTraits[] = trim($trait, '\\');
}
/**
* @param \OCP\Command\ICommand | callable $command
*/
private function runCommand($command) {
if ($command instanceof ICommand) {
$command->handle();
} else {
$command();
}
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return string
*/
private function getJobClass($command) {
if ($command instanceof \Closure) {
return 'OC\Command\ClosureJob';
} else if (is_callable($command)) {
return 'OC\Command\CallableJob';
} else if ($command instanceof ICommand) {
return 'OC\Command\CommandJob';
} else {
throw new \InvalidArgumentException('Invalid command');
}
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return string
*/
private function serializeCommand($command) {
if ($command instanceof \Closure) {
$serializer = new Serializer();
return $serializer->serialize($command);
} else if (is_callable($command) or $command instanceof ICommand) {
return serialize($command);
} else {
throw new \InvalidArgumentException('Invalid command');
}
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return bool
*/
private function canRunAsync($command) {
$traits = $this->getTraits($command);
foreach ($traits as $trait) {
if (array_search($trait, $this->syncTraits) !== false) {
return false;
}
}
return true;
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return string[]
*/
private function getTraits($command) {
if ($command instanceof ICommand) {
return class_uses($command);
} else {
return [];
}
}
}
|
