ZoneMinder
/
zoneminder
mirror of https://github.com/ZoneMinder/zoneminder.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add the ability to send a single summary email instead of individual emails per event

pull/3698/head
Isaac Connor 2023-04-24 17:53:16 -04:00
parent 49014ac7fa
commit d2fb365fa9
8 changed files with 223 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
db/zm_create.sql.in
View File

@ -309,6 +309,7 @@ CREATE TABLE `Filters` (
`EmailTo` TEXT,
`EmailSubject` TEXT,
`EmailBody` TEXT,
`EmailFormat` enum('Individual','Summary') NOT NULL default 'Individual',
`AutoMessage` tinyint(3) unsigned NOT NULL default '0',
`AutoExecute` tinyint(3) unsigned NOT NULL default '0',
`AutoExecuteCmd` tinytext,

11
db/zm_update-1.37.40.sql Normal file
View File

@ -0,0 +1,11 @@
SET @s = (SELECT IF(
(SELECT COUNT(*) FROM INFORMATION_SCHEMA.COLUMNS WHERE table_schema = DATABASE()
AND table_name = 'Filters'
AND column_name = 'EmailFormat'
) > 0,
"SELECT 'Column EmailFormat already exists in Filters'",
"ALTER TABLE `Filters` ADD `EmailFormat` enum('Individual','Summary') NOT NULL default 'Individual' AFTER `EmailBody`"
));
PREPARE stmt FROM @s;
EXECUTE stmt;

2
distros/redhat/zoneminder.spec
View File

@ -24,7 +24,7 @@
%endif
Name: zoneminder
Version: 1.37.39
Version: 1.37.40
Release: 1%{?dist}
Summary: A camera monitoring and analysis tool
Group: System Environment/Daemons

1
scripts/ZoneMinder/lib/ZoneMinder/Filter.pm
View File

@ -56,6 +56,7 @@ AutoEmail
EmailTo
EmailSubject
EmailBody
EmailFormat
AutoMessage
AutoExecute
AutoExecuteCmd

345
scripts/zmfilter.pl.in
View File

@ -317,7 +317,7 @@ sub checkFilter {
$delete_ok = undef if !generateVideo($filter, $Event);
}
}
if ( $Config{ZM_OPT_EMAIL} && $filter->{AutoEmail} ) {
if ( $Config{ZM_OPT_EMAIL} && $filter->{AutoEmail} and $filter->{EmailFormat} eq 'Individual') {
if ( !$Event->{Emailed} ) {
$delete_ok = undef if !sendEmail($filter, $Event);
}
@ -346,6 +346,7 @@ sub checkFilter {
}
} # end if AutoDelete
if ( $filter->{AutoMove} ) {
my $NewStorage = new ZoneMinder::Storage($filter->{AutoMoveTo});
Info("Moving event $Event->{Id} from ".$Event->Storage()->Path().' to '.$NewStorage->Path());
@ -384,6 +385,10 @@ sub checkFilter {
}
} # end if UpdateDiskSpace
} # end foreach event
if ($Config{ZM_OPT_EMAIL} and $filter->{AutoEmail} and ($filter->{EmailFormat} eq 'Summary')) {
sendSummaryEmail($filter, @Events);
}
ZoneMinder::Database::end_transaction($dbh, $in_transaction) if $$filter{LockRows};
} # end sub checkFilter
@ -655,8 +660,8 @@ sub is_in_attachments {
sub substituteTags {
my $text = shift;
my $filter = shift;
my $Event = shift;
my $attachments_ref = shift;
my $Event = @_ ? shift : undef;
my $attachments_ref = shift if @_;
# First we'd better check what we need to get
# We have a filter and an event, do we need any more
@ -664,8 +669,8 @@ sub substituteTags {
my $need_monitor = $text =~ /%(?:MN|MET|MEH|MED|MEW|MEN|MEA)%/;
my $need_summary = $text =~ /%(?:MET|MEH|MED|MEW|MEN|MEA)%/;
my $Monitor = $Event->Monitor() if $need_monitor;
my $Summary = $Monitor->Event_Summary() if $need_summary;
my $Monitor = $Event->Monitor() if $Event and $need_monitor;
my $Summary = $Monitor->Event_Summary() if $Monitor and $need_summary;
# Do we need the image information too?
my $need_images = $text =~ /%(?:EPI1|EPIM|EI1|EIM|EI1A|EIMA|EIMOD|EIMODG)%/;
@ -695,156 +700,202 @@ sub substituteTags {
my $url = $Config{ZM_URL};
$text =~ s/%ZP%/$url/g;
$text =~ s/%MN%/$Monitor->{Name}/g;
$text =~ s/%MET%/$Summary->{TotalEvents}/g;
$text =~ s/%MEH%/$Summary->{HourEvents}/g;
$text =~ s/%MED%/$Summary->{DayEvents}/g;
$text =~ s/%MEW%/$Summary->{WeekEvents}/g;
$text =~ s/%MEM%/$Summary->{MonthEvents}/g;
$text =~ s/%MEA%/$Summary->{ArchivedEvents}/g;
$text =~ s/%MP%/$url?view=watch&mid=$Event->{MonitorId}/g;
$text =~ s/%MPS%/$url?view=watch&mid=$Event->{MonitorId}&mode=stream/g;
$text =~ s/%MPI%/$url?view=watch&mid=$Event->{MonitorId}&mode=still/g;
$text =~ s/%EP%/$url?view=event&mid=$Event->{MonitorId}&eid=$Event->{Id}/g;
$text =~ s/%EPS%/$url?view=event&mode=stream&mid=$Event->{MonitorId}&eid=$Event->{Id}/g;
$text =~ s/%EPI%/$url?view=event&mode=still&mid=$Event->{MonitorId}&eid=$Event->{Id}/g;
$text =~ s/%EPATH%/$Event->Path()/g;
$text =~ s/%EI%/$Event->{Id}/g;
$text =~ s/%EN%/$Event->{Name}/g;
$text =~ s/%EC%/$Event->{Cause}/g;
$text =~ s/%ED%/$Event->{Notes}/g;
$text =~ s/%ET%/$Event->{StartDateTime}/g;
$text =~ s/%EVF%/$$Event{DefaultVideo}/g; # Event video filename
$text =~ s/%EL%/$Event->{Length}/g;
$text =~ s/%EF%/$Event->{Frames}/g;
$text =~ s/%EFA%/$Event->{AlarmFrames}/g;
$text =~ s/%EST%/$Event->{TotScore}/g;
$text =~ s/%ESA%/$Event->{AvgScore}/g;
$text =~ s/%ESM%/$Event->{MaxScore}/g;
$text =~ s/%MN%/$Monitor->{Name}/g if $Monitor;
if ($Summary) {
$text =~ s/%MET%/$Summary->{TotalEvents}/g;
$text =~ s/%MEH%/$Summary->{HourEvents}/g;
$text =~ s/%MED%/$Summary->{DayEvents}/g;
$text =~ s/%MEW%/$Summary->{WeekEvents}/g;
$text =~ s/%MEM%/$Summary->{MonthEvents}/g;
$text =~ s/%MEA%/$Summary->{ArchivedEvents}/g;
}
if ($Event) {
$text =~ s/%MP%/$url?view=watch&mid=$Event->{MonitorId}/g;
$text =~ s/%MPS%/$url?view=watch&mid=$Event->{MonitorId}&mode=stream/g;
$text =~ s/%MPI%/$url?view=watch&mid=$Event->{MonitorId}&mode=still/g;
$text =~ s/%EP%/$url?view=event&mid=$Event->{MonitorId}&eid=$Event->{Id}/g;
$text =~ s/%EPS%/$url?view=event&mode=stream&mid=$Event->{MonitorId}&eid=$Event->{Id}/g;
$text =~ s/%EPI%/$url?view=event&mode=still&mid=$Event->{MonitorId}&eid=$Event->{Id}/g;
$text =~ s/%EPATH%/$Event->Path()/g;
$text =~ s/%EI%/$Event->{Id}/g;
$text =~ s/%EN%/$Event->{Name}/g;
$text =~ s/%EC%/$Event->{Cause}/g;
$text =~ s/%ED%/$Event->{Notes}/g;
$text =~ s/%ET%/$Event->{StartDateTime}/g;
$text =~ s/%EVF%/$$Event{DefaultVideo}/g; # Event video filename
$text =~ s/%EL%/$Event->{Length}/g;
$text =~ s/%EF%/$Event->{Frames}/g;
$text =~ s/%EFA%/$Event->{AlarmFrames}/g;
$text =~ s/%EST%/$Event->{TotScore}/g;
$text =~ s/%ESA%/$Event->{AvgScore}/g;
$text =~ s/%ESM%/$Event->{MaxScore}/g;
if ( $first_alarm_frame ) {
$text =~ s/%EPF1%/$url?view=frame&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=$first_alarm_frame->{FrameId}/g;
$text =~ s/%EPFM%/$url?view=frame&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=$max_alarm_frame->{FrameId}/g;
$text =~ s/%EPI1%/$url?view=image&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=$first_alarm_frame->{FrameId}/g;
$text =~ s/%EPIM%/$url?view=image&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=$max_alarm_frame->{FrameId}/g;
$text =~ s/%EPFMOD%/$url?view=frame&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=objdetect/g;
$text =~ s/%EPIMOD%/$url?view=image&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=objdetect/g;
$text =~ s/%EPFMODG%/$url?view=frame&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=objdetect_gif/g;
$text =~ s/%EPIMODG%/$url?view=image&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=objdetect_gif/g;
if ( $first_alarm_frame ) {
$text =~ s/%EPF1%/$url?view=frame&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=$first_alarm_frame->{FrameId}/g;
$text =~ s/%EPFM%/$url?view=frame&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=$max_alarm_frame->{FrameId}/g;
$text =~ s/%EPI1%/$url?view=image&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=$first_alarm_frame->{FrameId}/g;
$text =~ s/%EPIM%/$url?view=image&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=$max_alarm_frame->{FrameId}/g;
$text =~ s/%EPFMOD%/$url?view=frame&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=objdetect/g;
$text =~ s/%EPIMOD%/$url?view=image&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=objdetect/g;
$text =~ s/%EPFMODG%/$url?view=frame&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=objdetect_gif/g;
$text =~ s/%EPIMODG%/$url?view=image&mid=$Event->{MonitorId}&eid=$Event->{Id}&fid=objdetect_gif/g;
if ($attachments_ref) {
if ($text =~ /%EI1%/g) {
my $path = generateImage($Event, $first_alarm_frame);
if (-e $path) {
my $filename = fileparse($path);
my $attachment = { type=>'image/jpeg', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EI1%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Warning("Path to first image does not exist at $path for image $first_alarm_frame");
$text =~ s/%EI1%/No image found for EI1/g;
if ($attachments_ref) {
if ($text =~ /%EI1%/g) {
my $path = generateImage($Event, $first_alarm_frame);
if (-e $path) {
my $filename = fileparse($path);
my $attachment = { type=>'image/jpeg', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EI1%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Warning("Path to first image does not exist at $path for image $first_alarm_frame");
$text =~ s/%EI1%/No image found for EI1/g;
}
}
if ($text =~ /%EIM%/g) {
my $path = generateImage($Event, $max_alarm_frame);
if (-e $path) {
my $filename = fileparse($path);
my $attachment = { type=>'image/jpeg', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EIM%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Warning("No image for EIM at $path");
$text =~ s/%EIM%/No image found for EIM/g;
}
}
if ($text =~ /%EI1A%/g) {
my $path = generateImage($Event, $first_alarm_frame, 'analyse');
if (-e $path) {
my $filename = fileparse($path);
my $attachment = { type=>'image/jpeg', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EI1A%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Warning("No image for EI1A at $path");
$text =~ s/%EI1A%/No image found for EI1A/g;
}
}
if ( $text =~ /%EIMA%/g ) {
# Don't attach the same image twice
my $path = generateImage($Event, $max_alarm_frame, 'analyse');
if (-e $path) {
my $filename = fileparse($path);
my $attachment = { type=>'image/jpeg', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EIMA%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Warning("No image for EIMA at $path");
$text =~ s/%EIMA%/No image found for EIMA/g;
}
}
if ($text =~ /%EIMOD%/g ) {
my $path = $Event->Path().'/objdetect.jpg';
if (-e $path) {
my $filename = fileparse($path);
my $attachment = { type=>'image/jpeg', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EIMOD%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Warning('No image for MOD at '.$path);
$text =~ s/%EIMOD%/No image found for EIMOD/g;
}
}
if ( $text =~ s/%EIMODG%//g ) {
my $path = $Event->Path().'/objdetect.gif';
if ( -e $path ) {
my $filename = fileparse($path);
my $attachment = { type=>'image/gif', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EIMODG%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Debug(1, 'No image for MODG at '.$path);
$text =~ s/%EIMODG%/No image found for EIMODG/g;
}
}
} # end if attachments_ref
} # end if $first_alarm_frame
if ( $attachments_ref ) {
if ( $text =~ s/%EV%//g ) {
if ( $$Event{DefaultVideo} ) {
push @$attachments_ref, { type=>'video/mp4', path=>join('/', $Event->Path(), $Event->DefaultVideo()) };
} elsif ( $Config{ZM_OPT_FFMPEG} ) {
my ( $format, $path ) = generateVideo($filter, $Event);
if ( !$format ) {
return undef;
}
push @$attachments_ref, { type=>"video/$format", path=>$path };
}
}
if ($text =~ /%EIM%/g) {
my $path = generateImage($Event, $max_alarm_frame);
if (-e $path) {
my $filename = fileparse($path);
my $attachment = { type=>'image/jpeg', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EIM%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Warning("No image for EIM at $path");
$text =~ s/%EIM%/No image found for EIM/g;
}
}
if ($text =~ /%EI1A%/g) {
my $path = generateImage($Event, $first_alarm_frame, 'analyse');
if (-e $path) {
my $filename = fileparse($path);
my $attachment = { type=>'image/jpeg', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EI1A%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Warning("No image for EI1A at $path");
$text =~ s/%EI1A%/No image found for EI1A/g;
}
}
if ( $text =~ /%EIMA%/g ) {
# Don't attach the same image twice
my $path = generateImage($Event, $max_alarm_frame, 'analyse');
if (-e $path) {
my $filename = fileparse($path);
my $attachment = { type=>'image/jpeg', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EIMA%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Warning("No image for EIMA at $path");
$text =~ s/%EIMA%/No image found for EIMA/g;
}
}
if ($text =~ /%EIMOD%/g ) {
my $path = $Event->Path().'/objdetect.jpg';
if (-e $path) {
my $filename = fileparse($path);
my $attachment = { type=>'image/jpeg', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EIMOD%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Warning('No image for MOD at '.$path);
$text =~ s/%EIMOD%/No image found for EIMOD/g;
}
}
if ( $text =~ s/%EIMODG%//g ) {
my $path = $Event->Path().'/objdetect.gif';
if ( -e $path ) {
my $filename = fileparse($path);
my $attachment = { type=>'image/gif', path=>$path, content_id=>uri_encode($filename) };
push @$attachments_ref, $attachment if !is_in_attachments($path, $attachments_ref);
$text =~ s/%EIMODG%/<img src="cid:$$attachment{content_id}"\/>/g;
} else {
Debug(1, 'No image for MODG at '.$path);
$text =~ s/%EIMODG%/No image found for EIMODG/g;
}
}
} # end if attachments_ref
} # end if $first_alarm_frame
if ( $attachments_ref ) {
if ( $text =~ s/%EV%//g ) {
if ( $$Event{DefaultVideo} ) {
push @$attachments_ref, { type=>'video/mp4', path=>join('/', $Event->Path(), $Event->DefaultVideo()) };
} elsif ( $Config{ZM_OPT_FFMPEG} ) {
my ( $format, $path ) = generateVideo($filter, $Event);
if ( $text =~ s/%EVM%//g ) {
my ( $format, $path ) = generateVideo($filter, $Event, 1);
if ( !$format ) {
return undef;
}
push @$attachments_ref, { type=>"video/$format", path=>$path };
}
}
if ( $text =~ s/%EVM%//g ) {
my ( $format, $path ) = generateVideo($filter, $Event, 1);
if ( !$format ) {
return undef;
}
push @$attachments_ref, { type=>"video/$format", path=>$path };
}
}
} # end if Event
$text =~ s/%FN%/$filter->{Name}/g;
( my $filter_name = $filter->{Name} ) =~ s/ /+/g;
$text =~ s/%FP%/$url?view=filter&mid=$Event->{MonitorId}&filter_name=$filter_name/g;
$text =~ s/%FP%/$url?view=filter&filter_name=$filter_name/g;
return $text;
} # end subsitituteTags
sub sendSummaryEmail {
my $filter = shift;
my @events = map { new ZoneMinder::Event($$_{Id}, $_) } @_;
if (!$Config{ZM_FROM_EMAIL}) {
Error('No from email address defined, not sending email');
return 0;
}
if (!$$filter{EmailTo}) {
Error('No email address defined, not sending email');
return 0;
}
my $subject = substituteTags($$filter{EmailSubject}, $filter);
print "Got $subject";
return 0 if !$subject;
my ($body_head, $summary_part, $body_tail) = split(/%SUMMARY%/m, $$filter{EmailBody});
print "Head: $body_head\n";
print "Summary: $summary_part\n";
print "Tail: $body_tail\n";
if (!$summary_part) {
Error('Failed finding summary part of email body');
return 0;
}
my @attachments;
my $body = $body_head;
foreach my $event (@events) {
$body .= substituteTags($summary_part, $filter, $event, \@attachments);
}
return 0 if !$body;
$body .= $body_tail;
Debug("Sending notification email '$subject'");
if (sendTheEmail($filter, $subject, $body, @attachments)) {
foreach my $event (@events) {
$event->save({Emailed=>1});
}
return 1;
}
return 0;
}
sub sendEmail {
my $filter = shift;
my $Event = shift;
my $event = shift;
if (!$Config{ZM_FROM_EMAIL}) {
Error('No from email address defined, not sending email');
@ -855,15 +906,22 @@ sub sendEmail {
return 0;
}
Debug('Creating notification email');
my $subject = substituteTags($$filter{EmailSubject}, $filter, $Event);
my $subject = substituteTags($$filter{EmailSubject}, $filter, $event);
return 0 if !$subject;
my @attachments;
my $body = substituteTags($$filter{EmailBody}, $filter, $Event, \@attachments);
my $body = substituteTags($$filter{EmailBody}, $filter, $event, \@attachments);
return 0 if !$body;
Debug("Sending notification email '$subject'");
if (sendTheEmail($filter, $subject, $body, @attachments)) {
$event->save({Emailed=>1});
return 1;
}
return 0;
}
sub sendTheEmail {
my ($filter, $subject, $body, @attachments) = @_;
eval {
if ($Config{ZM_NEW_MAIL_MODULES}) {
@ -1012,11 +1070,6 @@ sub sendEmail {
} else {
Info("Notification email sent to $$filter{EmailTo}");
}
my $sql = 'UPDATE `Events` SET `Emailed` = 1 WHERE `Id` = ?';
my $sth = $dbh->prepare_cached($sql)
or Fatal("Unable to prepare '$sql': ".$dbh->errstr());
my $res = $sth->execute($Event->{Id})
or Fatal("Unable to execute '$sql': ".$dbh->errstr());
return 1;
} # end sub sendEmail

2
version
View File

@ -1 +1 @@
1.37.39
1.37.40

1
web/includes/Filter.php
View File

@ -23,6 +23,7 @@ class Filter extends ZM_Object {
'EmailTo' => '',
'EmailSubject' => '',
'EmailBody' => '',
'EmailFormat' => 'Individual',
'AutoDelete' => 0,
'AutoArchive' => 0,
'AutoUnarchive' => 0,

8
web/skins/classic/views/filter.php
View File

@ -335,6 +335,14 @@ if ( ZM_OPT_EMAIL ) {
<label><?php echo translate('FilterEmailBody') ?></label>
<textarea name="filter[EmailBody]" rows="<?php echo count(explode("\n", $filter->EmailBody())) ?>"><?php echo validHtmlStr($filter->EmailBody()) ?></textarea>
</p>
<p>
<label><?php echo translate('Email Format') ?></label>
<?php echo html_radio(
'filter[EmailFormat]',
['Individual'=>translate('Individual'), 'Summary'=>translate('Summary')],
$filter->EmailFormat()); ?>
</p>
</div>
<?php
}