|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Spatie\Backup\Notifications; |
|
4
|
|
|
|
|
5
|
|
|
use Illuminate\Contracts\Logging\Log as LogContract; |
|
6
|
|
|
use Spatie\Backup\BackupDestination\BackupDestination; |
|
7
|
|
|
use Spatie\Backup\Tasks\Monitor\BackupDestinationStatus; |
|
8
|
|
|
use Exception; |
|
9
|
|
|
|
|
10
|
|
|
class Notifier |
|
11
|
|
|
{ |
|
12
|
|
|
/** @var array */ |
|
13
|
|
|
protected $config; |
|
14
|
|
|
|
|
15
|
|
|
/** @var \Illuminate\Contracts\Logging\Log */ |
|
16
|
|
|
protected $log; |
|
17
|
|
|
|
|
18
|
|
|
/** |
|
19
|
|
|
* @param \Illuminate\Contracts\Logging\Log $log |
|
20
|
|
|
*/ |
|
21
|
|
|
public function __construct(LogContract $log) |
|
22
|
|
|
{ |
|
23
|
|
|
$this->log = $log; |
|
24
|
|
|
|
|
25
|
|
|
$this->subject = config('laravel-backup.backup.name').' backups'; |
|
|
|
|
|
|
26
|
|
|
} |
|
27
|
|
|
|
|
28
|
|
|
public function backupWasSuccessful() |
|
29
|
|
|
{ |
|
30
|
|
|
$this->sendNotification( |
|
31
|
|
|
'whenBackupWasSuccessful', |
|
32
|
|
|
$this->subject, |
|
33
|
|
|
'Successfully took a new backup', |
|
34
|
|
|
BaseSender::TYPE_SUCCESS |
|
35
|
|
|
); |
|
36
|
|
|
} |
|
37
|
|
|
|
|
38
|
|
|
public function backupHasFailed(Exception $exception, BackupDestination $backupDestination = null) |
|
39
|
|
|
{ |
|
40
|
|
|
$extraMessage = $backupDestination ? "to {$backupDestination->getFilesystemType()}-filesystem" : ''; |
|
41
|
|
|
|
|
42
|
|
|
$this->sendNotification( |
|
43
|
|
|
'whenBackupHasFailed', |
|
44
|
|
|
"{$this->subject} : error", |
|
45
|
|
|
"Failed to backup {$extraMessage} because: {$exception->getMessage()}", |
|
46
|
|
|
BaseSender::TYPE_ERROR |
|
47
|
|
|
); |
|
48
|
|
|
} |
|
49
|
|
|
|
|
50
|
|
|
public function cleanupWasSuccessFul(BackupDestination $backupDestination) |
|
51
|
|
|
{ |
|
52
|
|
|
$this->sendNotification( |
|
53
|
|
|
'whenCleanupWasSuccessful', |
|
54
|
|
|
$this->subject, |
|
55
|
|
|
"Successfully cleaned up the backups on {$backupDestination->getFilesystemType()}-filesystem", |
|
56
|
|
|
BaseSender::TYPE_SUCCESS |
|
57
|
|
|
); |
|
58
|
|
|
} |
|
59
|
|
|
|
|
60
|
|
|
public function cleanupHasFailed(Exception $exception) |
|
61
|
|
|
{ |
|
62
|
|
|
$this->sendNotification( |
|
63
|
|
|
'whenCleanupHasFailed', |
|
64
|
|
|
"{$this->subject} : error", |
|
65
|
|
|
"Failed to cleanup the backup because: {$exception->getMessage()}", |
|
66
|
|
|
BaseSender::TYPE_ERROR |
|
67
|
|
|
); |
|
68
|
|
|
} |
|
69
|
|
|
|
|
70
|
|
|
public function healthyBackupWasFound(BackupDestinationStatus $backupDestinationStatus) |
|
71
|
|
|
{ |
|
72
|
|
|
$this->sendNotification( |
|
73
|
|
|
'whenHealthyBackupWasFound', |
|
74
|
|
|
"Healthy backup found for {$backupDestinationStatus->getBackupName()} on {$backupDestinationStatus->getFilesystemName()}-filesystem", |
|
|
|
|
|
|
75
|
|
|
"Backups on filesystem {$backupDestinationStatus->getFilesystemName()} are ok", |
|
|
|
|
|
|
76
|
|
|
BaseSender::TYPE_SUCCESS |
|
77
|
|
|
); |
|
78
|
|
|
} |
|
79
|
|
|
|
|
80
|
|
|
/** |
|
81
|
|
|
* @param \Spatie\Backup\Tasks\Monitor\BackupDestinationStatus $backupDestinationStatus |
|
82
|
|
|
*/ |
|
83
|
|
|
public function unhealthyBackupWasFound(BackupDestinationStatus $backupDestinationStatus) |
|
84
|
|
|
{ |
|
85
|
|
|
$this->sendNotification( |
|
86
|
|
|
'whenUnhealthyBackupWasFound', |
|
87
|
|
|
"Unhealthy backup found for {$backupDestinationStatus->getBackupName()} on {$backupDestinationStatus->getFilesystemName()}-filesystem", |
|
|
|
|
|
|
88
|
|
|
UnhealthyBackupMessage::createForBackupDestinationStatus($backupDestinationStatus), |
|
89
|
|
|
BaseSender::TYPE_ERROR |
|
90
|
|
|
); |
|
91
|
|
|
} |
|
92
|
|
|
|
|
93
|
|
|
/** |
|
94
|
|
|
* @param string $eventName |
|
95
|
|
|
* @param string $subject |
|
96
|
|
|
* @param string $message |
|
97
|
|
|
* @param string $type |
|
98
|
|
|
*/ |
|
99
|
|
|
protected function sendNotification($eventName, $subject, $message, $type) |
|
100
|
|
|
{ |
|
101
|
|
|
$senderNames = config("laravel-backup.notifications.events.{$eventName}"); |
|
102
|
|
|
|
|
103
|
|
|
collect($senderNames) |
|
104
|
|
|
->map(function ($senderName) { |
|
105
|
|
|
$className = $senderName; |
|
106
|
|
|
|
|
107
|
|
|
if (file_exists(__DIR__.'/Senders/'.ucfirst($senderName).'.php')) { |
|
108
|
|
|
$className = '\\Spatie\\Backup\\Notifications\\Senders\\'.ucfirst($senderName); |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
return app($className); |
|
112
|
|
|
}) |
|
113
|
|
|
->each(function (SendsNotifications $sender) use ($subject, $message, $type) { |
|
114
|
|
|
try { |
|
115
|
|
|
$sender |
|
116
|
|
|
->setSubject($subject) |
|
117
|
|
|
->setMessage($message) |
|
118
|
|
|
->setType($type) |
|
119
|
|
|
->send(); |
|
120
|
|
|
} catch (Exception $e) { |
|
121
|
|
|
$this->log->error("Laravel-backup notifier failed. Message: {$e->getMessage()}.".PHP_EOL.$e->getTraceAsString()); |
|
122
|
|
|
} |
|
123
|
|
|
}); |
|
124
|
|
|
} |
|
125
|
|
|
} |
|
126
|
|
|
|
spatie /
laravel-backup
Loading history...
In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:
Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: