Completed
Push — master ( dce9c2...90c6b3 )
by Branko
10s
created

LockTask::execute()   A

Complexity

Conditions 4
Paths 2

Size

Total Lines 14

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 20

Importance

Changes 0
Metric Value
dl 0
loc 14
ccs 0
cts 12
cp 0
rs 9.7998
c 0
b 0
f 0
cc 4
nc 2
nop 1
crap 20
1
<?php
2
/**
3
 * @copyright Copyright (c) 2017, Matias De lellis <[email protected]>
4
 * @copyright Copyright (c) 2018, Branko Kokanovic <[email protected]>
5
 *
6
 * @author Branko Kokanovic <[email protected]>
7
 *
8
 * @license GNU AGPL version 3 or any later version
9
 *
10
 * This program is free software: you can redistribute it and/or modify
11
 * it under the terms of the GNU Affero General Public License as
12
 * published by the Free Software Foundation, either version 3 of the
13
 * License, or (at your option) any later version.
14
 *
15
 * This program is distributed in the hope that it will be useful,
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 * GNU Affero General Public License for more details.
19
 *
20
 * You should have received a copy of the GNU Affero General Public License
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
 *
23
 */
24
namespace OCA\FaceRecognition\BackgroundJob\Tasks;
25
26
use OCA\FaceRecognition\BackgroundJob\FaceRecognitionBackgroundTask;
27
use OCA\FaceRecognition\BackgroundJob\FaceRecognitionContext;
28
29
/**
30
 * Tasks that do flock over file and acts as a global mutex,
31
 * so we don't run more than one background task in parallel.
32
 */
33
class LockTask extends FaceRecognitionBackgroundTask {
34
	const LOCK_FILENAME = 'nextcloud_face_recognition_lock.pid';
35
36
	/**
37
	 * @inheritdoc
38
	 */
39
	public function description() {
40
		return "Acquire lock so that only one background task can run";
41
	}
42
43
	/**
44
	 * @inheritdoc
45
	 */
46
	public function execute(FaceRecognitionContext $context) {
47
		$lock_file = sys_get_temp_dir() . '/' . LOCK_FILENAME;
48
		$fp = fopen($lock_file, 'w');
49
50
		if (!$fp || !flock($fp, LOCK_EX | LOCK_NB, $eWouldBlock) || $eWouldBlock) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $eWouldBlock of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
51
			$message = "Background job is already running. Quitting";
52
			$this->logInfo($message);
53
			return false;
54
		}
55
56
		$context->propertyBag['lock'] = $fp;
57
		$context->propertyBag['lock_filename'] = $lock_file;
58
		return true;
59
	}
60
}