Posting messages to matrix
All checks were successful
Create Docker Image / Build Docker Image (x86_64) (push) Successful in 42s
Create Docker Image / Build Docker Image (arm64) (push) Successful in 1m55s
Create Docker Image / Final Docker Image Manifest (push) Successful in 11s

This commit is contained in:
Deon George 2024-06-11 14:17:03 +10:00
parent 86995b03a8
commit a46ce7ff9e
14 changed files with 329 additions and 60 deletions

21
app/Events/Echomail.php Normal file
View File

@ -0,0 +1,21 @@
<?php
namespace App\Events;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;
use App\Models\Echomail as EchomailModel;
class Echomail
{
use Dispatchable, SerializesModels;
/**
* Create a new event instance.
*/
public function __construct(public EchomailModel $eo)
{
//
}
}

View File

@ -42,16 +42,20 @@ abstract class Base
case 'room': case 'room':
$room_alias = Http::withToken(config('matrix.as_token')) $room_alias = Http::withToken(config('matrix.as_token'))
->get(sprintf('%s/_matrix/client/v3/rooms/%s/state/m.room.canonical_alias',config('matrix.server'),$this->room_id)); ->get(sprintf('https://%s/_matrix/client/v3/rooms/%s/state/m.room.canonical_alias',config('matrix.server'),$this->room_id));
return $room_alias->json('alias',$this->room_id); return $room_alias->json('alias',$this->room_id);
case 'topic': case 'topic':
$subject = Http::withToken(config('matrix.as_token')) $subject = Http::withToken(config('matrix.as_token'))
->get(sprintf('%s/_matrix/client/v3/rooms/%s/state/m.room.topic',config('matrix.server'),$this->room_id)); ->get(sprintf('https://%s/_matrix/client/v3/rooms/%s/state/m.room.topic',config('matrix.server'),$this->room_id));
return $subject->json('topic','Message from Matrix'); return $subject->json('topic','Message from Matrix');
case 'ts':
return object_get($this->_data,'origin_server_ts');
case 'event_id':
case 'room_id': case 'room_id':
default: default:
return object_get($this->_data,$key); return object_get($this->_data,$key);

View File

@ -36,15 +36,6 @@ class Factory {
public static function make(array $request): Base public static function make(array $request): Base
{ {
// During the life of the event, this method is called twice - once during Middleware processing, and finally by the Controller. return self::create(Arr::get($request,'type','unknown'),$request);
static $o = NULL;
static $or = NULL;
if (! $o OR ($or != $request)) {
$or = $request;
$o = self::create(Arr::get($request,'type','unknown'),$request);
}
return $o;
} }
} }

View File

@ -42,9 +42,6 @@ class Message extends Base
case 'sender': case 'sender':
return object_get($this->_data,$key); return object_get($this->_data,$key);
case 'ts':
return object_get($this->_data,'origin_server_ts');
default: default:
return parent::__get($key); return parent::__get($key);
} }

View File

@ -7,14 +7,22 @@ use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Log; use Illuminate\Support\Facades\Log;
use App\Events\Matrix\Factory as MatrixEventFactory; use App\Events\Matrix\Factory as MatrixEventFactory;
use App\Events\Matrix\Message;
final class MatrixController extends Controller final class MatrixController extends Controller
{ {
private const LOGKEY = 'CMC'; private const LOGKEY = 'CMC';
public function webhook(Request $request) public function webhook(Request $request): mixed
{ {
$event = MatrixEventFactory::make(Arr::get($request->events,0,[])); $event = MatrixEventFactory::make(Arr::get($request->events,0,[]));
// Catch our messages that we've posted
if (($event instanceof Message) && preg_match('#^.*\^[0-9]+_[0-9]+/[0-9]+(\.[0-9]+)?:#',$event->sender)) {
Log::info(sprintf('%s:- Ignoring Matrix Message event, probably from us [%s]',static::LOGKEY,$event->sender));
return response(['result'=>'OK']);
}
Log::info(sprintf('%s:- Dispatching Matrix Event [%s]',static::LOGKEY,get_class($event))); Log::info(sprintf('%s:- Dispatching Matrix Event [%s]',static::LOGKEY,get_class($event)));
event($event); event($event);

View File

@ -0,0 +1,43 @@
<?php
namespace App\Listeners;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Notification;
use App\Notifications\Matrix\Echomail;
class EchomailListener implements ShouldQueue
{
protected const LOGKEY = 'LEL';
public string $queue = 'matrix';
/**
* Create the event listener.
*/
public function __construct()
{
}
/**
* Handle the event.
*/
public function handle(object $event): void
{
$ea = $event->eo->echoarea;
// Catch our messages that we've posted, so they dont go back
if (str_ends_with($event->eo->from,':'.config('matrix.server')))
return;
if ($ea && collect(config('matrix.rooms'))->contains($ea->name)) {
Log::debug(sprintf('%s:- Sending echomail to matrix for [%s]',self::LOGKEY,$event->eo->msgid));
Notification::route('matrix',collect(config('matrix.rooms'))->search($ea->name))->notify(new Echomail($event->eo->withoutRelations()));
} else {
Log::debug(sprintf('%s:- Not sending echomail to matrix for [%s]',self::LOGKEY,$event->eo->msgid));
}
}
}

View File

@ -11,6 +11,7 @@ use Illuminate\Support\Facades\Log;
use App\Casts\{CollectionOrNull,CompressedStringOrNull,UTF8StringOrNull}; use App\Casts\{CollectionOrNull,CompressedStringOrNull,UTF8StringOrNull};
use App\Classes\FTN\Message; use App\Classes\FTN\Message;
use App\Events\Echomail as EchomailEvent;
use App\Interfaces\Packet; use App\Interfaces\Packet;
use App\Traits\{MessageAttributes,MsgID,ParseAddresses,QueryCacheableConfig}; use App\Traits\{MessageAttributes,MsgID,ParseAddresses,QueryCacheableConfig};
@ -270,6 +271,8 @@ final class Echomail extends Model implements Packet
$model->seenby()->syncWithPivotValues($exportto,['export_at'=>Carbon::now()],FALSE); $model->seenby()->syncWithPivotValues($exportto,['export_at'=>Carbon::now()],FALSE);
} }
} }
event(new EchomailEvent($model->withoutRelations()));
}); });
} }

View File

@ -0,0 +1,47 @@
<?php
namespace App\Notifications\Channels;
use Illuminate\Notifications\Notification;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Support\Facades\Log;
class MatrixChannel
{
use interactsWithQueue;
private const LOGKEY = 'CNM';
/**
* Create a new Matrix channel instance.
*/
public function __construct()
{
}
/**
* Send the given notification.
*
* @param mixed $notifiable
* @param \Illuminate\Notifications\Notification $notification
* @return \Psr\Http\Message\ResponseInterface|void
*/
public function send($notifiable,Notification $notification)
{
if (! $room = $notifiable->routeNotificationFor('matrix',$notification))
return;
try {
$o = $notification->toMatrix($notifiable);
// @todo Check this exception works as expected (putting the job back on the queue when the user doesnt exist), else it might need to go in Matrix/Echomail
} catch (\Exception $e) {
Log::info(sprintf('%s:= Exception [%s] posting to Matrix, putting job back on queue for [%s]',self::LOGKEY,$e->getMessage(),$room));
$this->release();
return;
}
// @todo Be nice to get the message ID for debugging
Log::info(sprintf('%s:= Posted echomail to Matrix [%s]',self::LOGKEY,$room),['o'=>$o]);
}
}

View File

@ -38,7 +38,7 @@ class MatrixMessage extends Echomails
$echoarea = $notifiable->routeNotificationFor(static::via); $echoarea = $notifiable->routeNotificationFor(static::via);
$o = $this->setupEchomail($echoarea); $o = $this->setupEchomail($echoarea);
Log::info(sprintf('%s:+ Sending Matrix Message to [%s]',self::LOGKEY,$echoarea->name)); Log::info(sprintf('%s:+ Sending Matrix Message to [%s]',self::LOGKEY,$echoarea->name),['mo'=>$this->mo]);
$our = our_address($echoarea->domain)->last(); $our = our_address($echoarea->domain)->last();
$o->to = 'All'; $o->to = 'All';
@ -47,9 +47,10 @@ class MatrixMessage extends Echomails
$o->subject = $this->mo->topic; $o->subject = $this->mo->topic;
$o->fftn_id = $our->id; $o->fftn_id = $our->id;
$o->kludges->put('CHRS:','UTF8 2'); $o->kludges->put('CHRS:','UTF8 2');
$o->kludges->put('EVENT:',$this->mo->event_id);
// Message // Message
$o->msg = $this->mo->message; $o->msg = str_replace("\n","\r",$this->mo->message);
$o->set_origin = sprintf('Matrix %s (%s)',$this->mo->room,$our->ftn4d); $o->set_origin = sprintf('Matrix %s (%s)',$this->mo->room,$our->ftn4d);
$o->save(); $o->save();

View File

@ -0,0 +1,48 @@
<?php
namespace App\Notifications;
use Carbon\Carbon;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;
use App\Classes\FTN\Message;
use App\Models\{Echoarea,Echomail,Setup};
abstract class Matrix extends Notification implements ShouldQueue
{
use Queueable;
protected const via = 'matrix';
private const LOGKEY = 'NM-';
/**
* Create a new notification instance.
*/
public function __construct()
{
$this->queue = 'matrix';
}
/**
* Get the notification's delivery channels.
*
* @param mixed $notifiable
* @return array
*/
public function via($notifiable)
{
return [ self::via ];
}
/**
* Get the mail representation of the notification.
*
* @param mixed $notifiable
* @return Echomail
* @throws \Exception
*/
abstract public function toMatrix(object $notifiable): mixed;
}

View File

@ -0,0 +1,128 @@
<?php
namespace App\Notifications\Matrix;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use App\Models\Echomail as EchomailModel;
use App\Notifications\Matrix;
class Echomail extends Matrix
{
private const LOGKEY = 'NME';
/**
* Post a message from Matrix.
*
* @param EchomailModel $o
*/
public function __construct(private EchomailModel $o)
{
parent::__construct();
}
/**
* Get the mail representation of the notification.
*
* @param mixed $notifiable
* @return mixed
* @throws \Exception
*/
public function toMatrix(object $notifiable): mixed
{
$room = $notifiable->routeNotificationFor(static::via);
Log::info(sprintf('%s:+ Sending Echo Message to Matrix [%s]',self::LOGKEY,$room));
$username = sprintf('%s^%d_%d/%d.%d',
$this->o->from,
$this->o->fftn->zone->zone_id,
$this->o->fftn->host_id,
$this->o->fftn->node_id,
$this->o->fftn->point_id,
);
$user = sprintf('@%s:%s',$username,config('matrix.server'));
// Set topic if it is different:
$subject = Http::withToken(config('matrix.as_token'))
->get(sprintf('https://%s/_matrix/client/v3/rooms/%s/state/m.room.topic',config('matrix.server'),$room));
if (($x=preg_replace('/^RE:\s*/i','',$this->o->subject)) !== $subject->json('topic','Message from Matrix')) {
$topic = Http::withToken(config('matrix.as_token'))
->put(sprintf('https://%s/_matrix/client/v3/rooms/%s/state/m.room.topic',config('matrix.server'),$room),[
'topic'=>$x,
]);
if ($topic->status() !== 200)
Log::error(sprintf('%s:! Failed to set matrix room topic to [%s] in room [%s]',self::LOGKEY,$x,$room),['msg'=>$topic->body()]);
}
$msg = Http::withToken(config('matrix.as_token'))
->withQueryParameters(['user_id'=>$user])
->post(sprintf('https://%s/_matrix/client/v3/rooms/%s/send/m.room.message',config('matrix.server'),$room),[
'msgtype'=>'m.text',
'body'=>mb_convert_encoding(str_replace("\r","\n",$this->o->msg),'UTF-8','IBM850'),
]);
switch ($msg->status()) {
case 200:
break;
case 403:
Log::alert(sprintf('%s:! Got 403 with errcode [%s] reason [%s]',self::LOGKEY,$msg->json('errcode'),$msg->json('error')));
// @todo Test that the user doesnt exist
// If the user doesnt exist in matrix yet
if (str_starts_with($msg->json('error'),'Application service has not registered this user')) {
// Register user
$msg = Http::withToken(config('matrix.as_token'))
->post(sprintf('https://%s/_matrix/client/v3/register',config('matrix.server')),[
'type'=>'m.login.application_service',
'username'=>$username,
]);
if ($msg->status() !== 200) {
Log::error(sprintf('%s:! Failed to register user [%s] to matrix',self::LOGKEY,$username),['msg'=>$msg->body()]);
throw new \Exception(sprintf('Failed to invite user [%s] to matrix',$username));
}
// @todo Test that the user has been invited
// Invite user
$msg = Http::withToken(config('matrix.as_token'))
//->withQueryParameters(['user_id'=>$user])
->post(sprintf('https://%s/_matrix/client/v3/rooms/%s/invite',config('matrix.server'),$room),[
'user_id'=>$user,
]);
if ($msg->status() !== 200) {
Log::error(sprintf('%s:! Failed to invite user [%s] to matrix room [%s]',self::LOGKEY,$user,$room),['msg'=>$msg->body()]);
throw new \Exception(sprintf('Failed to invite user [%s] to matrix room [%s]',$user,$room));
}
// Join as user
$msg = Http::withToken(config('matrix.as_token'))
->withQueryParameters(['user_id'=>$user])
->post(sprintf('https://%s/_matrix/client/v3/rooms/%s/join',config('matrix.server'),$room),[
'user_id'=>$user,
]);
if ($msg->status() !== 200) {
Log::error(sprintf('%s:! Failed to join user [%s] to matrix room [%s]',self::LOGKEY,$user,$room),['msg'=>$msg->body()]);
throw new \Exception(sprintf('Failed to join user [%s] to matrix room [%s]',$user,$room));
}
// retry this message
throw new \Exception('Need to create user on matrix first');
}
break;
default:
Log::error(sprintf('%s:! Unknown status [%d] with errcode [%s] reason [%s] when posting message [%d] to matrix',self::LOGKEY,$msg->status(),$msg->json('errcode'),$msg->json('error'),$this->o->id),['msg'=>$msg->body()]);
}
return $msg->body();
}
}

View File

@ -5,10 +5,14 @@ namespace App\Providers;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\Notifications\ChannelManager; use Illuminate\Notifications\ChannelManager;
use Illuminate\Support\Facades\Auth; use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Notification; use Illuminate\Support\Facades\Notification;
use Illuminate\Support\ServiceProvider; use Illuminate\Support\ServiceProvider;
use App\Notifications\Channels\{EchomailChannel,NetmailChannel}; use App\Events\Matrix\Message;
use App\Listeners\EchomailListener;
use App\Listeners\Matrix\MessageListener;
use App\Notifications\Channels\{EchomailChannel,MatrixChannel,NetmailChannel};
use App\Models\{Echomail,Netmail}; use App\Models\{Echomail,Netmail};
use App\Traits\SingleOrFail; use App\Traits\SingleOrFail;
@ -31,6 +35,10 @@ class AppServiceProvider extends ServiceProvider
$service->extend('netmail', function ($app) { $service->extend('netmail', function ($app) {
return new NetmailChannel($app->make(Netmail::class)); return new NetmailChannel($app->make(Netmail::class));
}); });
$service->extend('matrix', function ($app) {
return new MatrixChannel($app->make(Echomail::class));
});
}); });
} }
@ -46,5 +54,16 @@ class AppServiceProvider extends ServiceProvider
Auth::viaRequest('matrix-token',function (Request $request) { Auth::viaRequest('matrix-token',function (Request $request) {
return (config('matrix.hs_token') && ($request->bearerToken() === config('matrix.hs_token'))) ? TRUE : NULL; return (config('matrix.hs_token') && ($request->bearerToken() === config('matrix.hs_token'))) ? TRUE : NULL;
}); });
Event::listen(
Message::class,
MessageListener::class,
);
// @todo This should be detected automatically?
Event::listen(
\App\Events\Echomail::class,
EchomailListener::class,
);
} }
} }

View File

@ -1,40 +0,0 @@
<?php
namespace App\Providers;
use Illuminate\Auth\Events\Registered;
use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Event;
use App\Events\Matrix\Message;
use App\Listeners\Matrix\MessageListener;
class EventServiceProvider extends ServiceProvider
{
/**
* The event listener mappings for the application.
*
* @var array
*/
protected $listen = [
Registered::class => [
SendEmailVerificationNotification::class,
],
];
/**
* Register any events for your application.
*
* @return void
*/
public function boot()
{
parent::boot();
Event::listen(
Message::class,
MessageListener::class,
);
}
}

View File

@ -179,7 +179,6 @@ return [
App\Providers\AppServiceProvider::class, App\Providers\AppServiceProvider::class,
App\Providers\AuthServiceProvider::class, App\Providers\AuthServiceProvider::class,
// App\Providers\BroadcastServiceProvider::class, // App\Providers\BroadcastServiceProvider::class,
App\Providers\EventServiceProvider::class,
App\Providers\RouteServiceProvider::class, App\Providers\RouteServiceProvider::class,
App\Providers\CustomBladeServiceProvider::class, App\Providers\CustomBladeServiceProvider::class,