Alert template clean up "\r\n\n"

[bestlong]

DO NOT DELETE THIS TEXT

Please note

Please read this information carefully. You can run ./scripts/pre-commit.php to check your code before submitting.

• Have you followed our code guidelines?

Testers

If you would like to test this pull request then please run: ./scripts/github-apply <pr_id>, i.e ./scripts/github-apply 5926
After you are done testing, you can remove the changes with ./scripts/github-remove. If there are schema changes, you can ask on discord how to revert.

[murrant]

These sql files aren't used anymore.

[bestlong]

Ref #10495

[garysteers]

This will fix any new installation, can a database/migration script be written to update the Template (but only IF it has the original content changed by these commits)

[murrant]

Can we remove the \r? It used to be needed for windows email clients I am pretty sure.

[bestlong]

@murrant use web ui create new alert template input two line:

A
B

then use mysqldump get sql:

INSERT INTO `alert_templates` VALUES (50,'Default Alert Template','{{ $alert->title }}\nSeverity: {{ $alert->severity }}\n@if ($alert->state == 0) Time elapsed: {{ $alert->elapsed }} @endif\nTimestamp: {{ $alert->timestamp }}\nUnique-ID: {{ $alert->uid }}\nRule: @if ($alert->name) {{ $alert->name }} @else {{ $alert->rule }} @endif\n@if ($alert->faults) Faults:\n@foreach ($alert->faults as $key => $value)\n  #{{ $key }}: {{ $value[\'string\'] }}\n@endforeach\n@endif\nAlert sent to:\n@foreach ($alert->contacts as $key => $value)\n  {{ $value }} <{{ $key }}>\n@endforeach',NULL,NULL),(51,'Test CRLF','A\nB\n','','');

only see \n in (51,'Test CRLF','A\nB\n','',''), so i cleanup "\r".

[bestlong]

Hi @garysteers database/migration script will affect all user, and difficult to identify data status.

Only four pieces of data can be solved by copying:

Default Alert Template

{{ $alert->title }}
Severity: {{ $alert->severity }}
@if ($alert->state == 0) Time elapsed: {{ $alert->elapsed }} @endif
Timestamp: {{ $alert->timestamp }}
Unique-ID: {{ $alert->uid }}
Rule: @if ($alert->name) {{ $alert->name }} @else {{ $alert->rule }} @endif
@if ($alert->faults) Faults:
@foreach ($alert->faults as $key => $value)
  #{{ $key }}: {{ $value['string'] }}
@endforeach
@endif
Alert sent to:
@foreach ($alert->contacts as $key => $value)
  {{ $value }} <{{ $key }}>
@endforeach

BGP Sessions.

{{ $alert->title }}
Severity: {{ $alert->severity }}
@if ($alert->state == 0) Time elapsed: {{ $alert->elapsed }} @endif
Timestamp: {{ $alert->timestamp }}
Unique-ID: {{ $alert->uid }}
Rule: @if ($alert->name) {{ $alert->name }} @else {{ $alert->rule }} @endif
@if ($alert->faults) Faults:
@foreach ($alert->faults as $key => $value)
  #{{ $key }}: {{ $value['string'] }}
  Peer: {{ $value['astext'] }}
  Peer IP: {{ $value['bgpPeerIdentifier'] }}
  Peer AS: {{ $value['bgpPeerRemoteAs'] }}
  Peer EstTime: {{ $value['bgpPeerFsmEstablishedTime'] }}
  Peer State: {{ $value['bgpPeerState'] }}
@endforeach
@endif

Ports

{{ $alert->title }}
Severity: {{ $alert->severity }}
@if ($alert->state == 0) Time elapsed: {{ $alert->elapsed }} @endif
Timestamp: {{ $alert->timestamp }}
Unique-ID: {{ $alert->uid }}
Rule: @if ($alert->name) {{ $alert->name }} @else {{ $alert->rule }} @endif
@if ($alert->faults) Faults:
@foreach ($alert->faults as $key => $value)
  #{{ $key }}: {{ $value['string'] }}
  Port: {{ $value['ifName'] }}
  Port Name: {{ $value['ifAlias'] }}
  Port Status: {{ $value['message'] }}
@endforeach
@endif

Temperature

{{ $alert->title }}
Severity: {{ $alert->severity }}
@if ($alert->state == 0) Time elapsed: {{ $alert->elapsed }} @endif
Timestamp: {{ $alert->timestamp }}
Unique-ID: {{ $alert->uid }}
Rule: @if ($alert->name) {{ $alert->name }} @else {{ $alert->rule }} @endif
@if ($alert->faults) Faults:
@foreach ($alert->faults as $key => $value)
  #{{ $key }}: {{ $value['string'] }}
  Temperature: {{ $value['sensor_current'] }}
  Previous Measurement: {{ $value['sensor_prev'] }}
@endforeach
@endif

or U can clean all alert template then run seed

root@ubuntu-bionic:~# cd /opt/librenms/
root@ubuntu-bionic:/opt/librenms# php artisan db:seed --class=DefaultAlertTemplateSeeder
**************************************
*     Application In Production!     *
**************************************

 Do you really wish to run this command? (yes/no) [no]:
 > yes

Database seeding completed successfully.
root@ubuntu-bionic:/opt/librenms#

[bestlong]

Hi @murrant

Do i need to fix codeclimate issues ?

[murrant]

Treat code climate errors as warnings.

I think you need something like this to go with this:

Index: LibreNMS/Alert/Transport/Mail.php
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- LibreNMS/Alert/Transport/Mail.php	(date 1566502950000)
+++ LibreNMS/Alert/Transport/Mail.php	(date 1566916478486)
@@ -35,12 +35,10 @@
 
     public function contactMail($obj)
     {
-        if (empty($this->config['email'])) {
-            $email = $obj['contacts'];
-        } else {
-            $email = $this->config['email'];
-        }
-        return send_mail($email, $obj['title'], $obj['msg'], (Config::get('email_html') == 'true') ? true : false);
+        $email = empty($this->config['email']) ? $obj['contacts'] : $this->config['email'];
+        $msg = preg_replace("/(?<!\r)\n/", "\r\n", $obj['msg']); // fix line returns for windows mail clients
+
+        return send_mail($email, $obj['title'], $msg, (Config::get('email_html') == 'true') ? true : false);
     }
 
     public static function configTemplate()

[murrant]

@garysteers you can delete all existing templates (not just included ones) with TRUNCATE TABLE alert_templates; and then run ./lnms db:seed

[murrant]

I think this was a mistake when it was converted to the seeder only where where it wasn't inserting the line returns properly.

[murrant]

This pull request has been mentioned on LibreNMS Community. There might be relevant details there:

https://community.librenms.org/t/message-alert-mail/9550/3

[Akimace]

hello

@garysteers you can delete all existing templates (not just included ones) with TRUNCATE TABLE alert_templates; and then run ./lnms db:seed

I did TRUNCATE TABLE but when I do this comand: ./lnms db:seed
I have this error:

There are no commands defined in the "db" namespace.

Do you have an idea ?
My mail alert doesn't work since I did the TRUNCATE TABLE alert_templates;

Thank you

[murrant]

php artisan db:seed

[murrant]

This pull request has been mentioned on LibreNMS Community. There might be relevant details there:

https://community.librenms.org/t/v1-56-release-changelog-september-2019/9671/1