mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2025-12-15 18:35:34 -05:00
280 lines
11 KiB
PHP
280 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2023. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://www.elastic.co/licensing/elastic-license
|
|
*/
|
|
|
|
namespace App\Services\InboundMail;
|
|
|
|
use App\Events\Expense\ExpenseWasCreated;
|
|
use App\Factory\ExpenseFactory;
|
|
use App\Jobs\Util\SystemLogger;
|
|
use App\Libraries\MultiDB;
|
|
use App\Models\ClientContact;
|
|
use App\Models\Company;
|
|
use App\Models\SystemLog;
|
|
use App\Models\Vendor;
|
|
use App\Models\VendorContact;
|
|
use App\Services\InboundMail\InboundMail;
|
|
use App\Utils\Ninja;
|
|
use App\Utils\TempFile;
|
|
use App\Utils\Traits\GeneratesCounter;
|
|
use App\Utils\Traits\SavesDocuments;
|
|
use App\Utils\Traits\MakesHash;
|
|
use Cache;
|
|
use Illuminate\Queue\SerializesModels;
|
|
use Log;
|
|
|
|
class InboundMailEngine
|
|
{
|
|
use SerializesModels, MakesHash;
|
|
use GeneratesCounter, SavesDocuments;
|
|
|
|
private ?Company $company;
|
|
private ?bool $isUnknownRecipent = null;
|
|
private array $globalBlacklistDomains = [];
|
|
private array $globalBlacklistSenders = [];
|
|
public function __construct()
|
|
{
|
|
}
|
|
/**
|
|
* if there is not a company with an matching mailbox, we only do monitoring
|
|
* reuse this method to add more mail-parsing behaviors
|
|
*/
|
|
public function handle(InboundMail $email)
|
|
{
|
|
if ($this->isInvalidOrBlocked($email))
|
|
return;
|
|
|
|
$isUnknownRecipent = true;
|
|
|
|
// Expense Mailbox => will create an expense
|
|
$company = MultiDB::findAndSetDbByInboundMailbox($email->to);
|
|
if ($company) {
|
|
$isUnknownRecipent = false;
|
|
$this->createExpense($company, $email);
|
|
}
|
|
|
|
$this->saveMeta($email->from, $email->to, $isUnknownRecipent);
|
|
}
|
|
|
|
// SPAM Protection
|
|
private function isInvalidOrBlocked(InboundMail $email)
|
|
{
|
|
// invalid email
|
|
if (!filter_var($email->from, FILTER_VALIDATE_EMAIL)) {
|
|
Log::info('E-Mail blocked, because from e-mail has the wrong format: ' . $email->from);
|
|
return true;
|
|
}
|
|
|
|
$parts = explode('@', $email->from);
|
|
$domain = array_pop($parts);
|
|
|
|
// global blacklist
|
|
if (in_array($domain, $this->globalBlacklistDomains)) {
|
|
Log::info('E-Mail blocked, because the domain was found on globalBlocklistDomains: ' . $email->from);
|
|
return true;
|
|
}
|
|
if (in_array($email->from, $this->globalBlacklistSenders)) {
|
|
Log::info('E-Mail blocked, because the email was found on globalBlocklistEmails: ' . $email->from);
|
|
return true;
|
|
}
|
|
|
|
if (Cache::has('inboundMailBlockedSender:' . $email->from)) { // was marked as blocked before, so we block without any console output
|
|
return true;
|
|
}
|
|
|
|
// sender occured in more than 500 emails in the last 12 hours
|
|
$senderMailCountTotal = Cache::get('inboundMailSender:' . $email->from, 0);
|
|
if ($senderMailCountTotal >= 5000) {
|
|
Log::info('E-Mail blocked permanent, because the sender sended more than ' . $senderMailCountTotal . ' emails in the last 12 hours: ' . $email->from);
|
|
$this->blockSender($email->from);
|
|
$this->saveMeta($email->from, $email->to);
|
|
return true;
|
|
}
|
|
if ($senderMailCountTotal >= 1000) {
|
|
Log::info('E-Mail blocked, because the sender sended more than ' . $senderMailCountTotal . ' emails in the last 12 hours: ' . $email->from);
|
|
$this->saveMeta($email->from, $email->to);
|
|
return true;
|
|
}
|
|
|
|
// sender sended more than 50 emails to the wrong mailbox in the last 6 hours
|
|
$senderMailCountUnknownRecipent = Cache::get('inboundMailSenderUnknownRecipent:' . $email->from, 0);
|
|
if ($senderMailCountUnknownRecipent >= 50) {
|
|
Log::info('E-Mail blocked, because the sender sended more than ' . $senderMailCountUnknownRecipent . ' emails to the wrong mailbox in the last 6 hours: ' . $email->from);
|
|
$this->saveMeta($email->from, $email->to);
|
|
return true;
|
|
}
|
|
|
|
// wrong recipent occurs in more than 100 emails in the last 12 hours, so the processing is blocked
|
|
$mailCountUnknownRecipent = Cache::get('inboundMailUnknownRecipent:' . $email->to, 0); // @turbo124 maybe use many to save resources in case of spam with multiple to addresses each time
|
|
if ($mailCountUnknownRecipent >= 100) {
|
|
Log::info('E-Mail blocked, because anyone sended more than ' . $mailCountUnknownRecipent . ' emails to the wrong mailbox in the last 12 hours. Current sender was blocked as well: ' . $email->from);
|
|
$this->blockSender($email->from);
|
|
$this->saveMeta($email->from, $email->to);
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
public function blockSender(string $from)
|
|
{
|
|
Cache::add('inboundMailBlockedSender:' . $from, true, now()->addHours(12));
|
|
|
|
// TODO: ignore, when known sender (for heavy email-usage mostly on isHosted())
|
|
// TODO: handle external blocking
|
|
}
|
|
public function saveMeta(string $from, string $to, bool $isUnknownRecipent = false)
|
|
{
|
|
// save cache
|
|
Cache::add('inboundMailSender:' . $from, 0, now()->addHours(12));
|
|
Cache::increment('inboundMailSender:' . $from);
|
|
|
|
if ($isUnknownRecipent) {
|
|
Cache::add('inboundMailSenderUnknownRecipent:' . $from, 0, now()->addHours(6));
|
|
Cache::increment('inboundMailSenderUnknownRecipent:' . $from); // we save the sender, to may block him
|
|
|
|
Cache::add('inboundMailUnknownRecipent:' . $to, 0, now()->addHours(12));
|
|
Cache::increment('inboundMailUnknownRecipent:' . $to); // we save the sender, to may block him
|
|
}
|
|
}
|
|
|
|
// MAIN-PROCESSORS
|
|
protected function createExpense(Company $company, InboundMail $email)
|
|
{
|
|
// Skipping executions: will not result in not saving Metadata to prevent usage of these conditions, to spam
|
|
if (!($company?->inbound_mailbox_active ?: false)) {
|
|
$this->logBlocked($company, 'mailbox not active for this company. from: ' . $email->from);
|
|
return;
|
|
}
|
|
if (!$this->validateExpenseSender($company, $email)) {
|
|
$this->logBlocked($company, 'invalid sender of an ingest email for this company. from: ' . $email->from);
|
|
return;
|
|
}
|
|
if (sizeOf($email->documents) == 0) {
|
|
$this->logBlocked($company, 'email does not contain any attachments and is likly not an expense. from: ' . $email->from);
|
|
return;
|
|
}
|
|
|
|
// create expense
|
|
$expense = ExpenseFactory::create($company->id, $company->owner()->id);
|
|
|
|
$expense->public_notes = $email->subject;
|
|
$expense->private_notes = $email->text_body;
|
|
$expense->date = $email->date;
|
|
|
|
// handle vendor assignment
|
|
$expense_vendor = $this->getVendor($company, $email);
|
|
if ($expense_vendor)
|
|
$expense->vendor_id = $expense_vendor->id;
|
|
|
|
// handle documents
|
|
$this->processHtmlBodyToDocument($email);
|
|
$documents = [];
|
|
array_push($documents, ...$email->documents);
|
|
if ($email->body_document !== null)
|
|
array_push($documents, $email->body_document);
|
|
|
|
$expense->saveQuietly();
|
|
|
|
$this->saveDocuments($documents, $expense);
|
|
|
|
event(new ExpenseWasCreated($expense, $expense->company, Ninja::eventVars(null))); // @turbo124 please check, I copied from API-Controller
|
|
event('eloquent.created: App\Models\Expense', $expense); // @turbo124 please check, I copied from API-Controller
|
|
}
|
|
|
|
// HELPERS
|
|
private function processHtmlBodyToDocument(InboundMail $email)
|
|
{
|
|
|
|
if ($email->body !== null)
|
|
$email->body_document = TempFile::UploadedFileFromRaw($email->body, "E-Mail.html", "text/html");
|
|
|
|
}
|
|
private function validateExpenseSender(Company $company, InboundMail $email)
|
|
{
|
|
$parts = explode('@', $email->from);
|
|
$domain = array_pop($parts);
|
|
|
|
// whitelists
|
|
$email_whitelist = explode(",", $company->inbound_mailbox_whitelist_senders);
|
|
if (in_array($email->from, $email_whitelist))
|
|
return true;
|
|
$domain_whitelist = explode(",", $company->inbound_mailbox_whitelist_domains);
|
|
if (in_array($domain, $domain_whitelist))
|
|
return true;
|
|
$email_blacklist = explode(",", $company->inbound_mailbox_blacklist_senders);
|
|
if (in_array($email->from, $email_blacklist))
|
|
return false;
|
|
$domain_blacklist = explode(",", $company->inbound_mailbox_blacklist_domains);
|
|
if (in_array($domain, $domain_blacklist))
|
|
return false;
|
|
|
|
// allow unknown
|
|
if ($company->inbound_mailbox_allow_unknown)
|
|
return true;
|
|
|
|
// own users
|
|
if ($company->inbound_mailbox_allow_company_users && $company->users()->where("email", $email->from)->exists())
|
|
return true;
|
|
|
|
// from vendors
|
|
if ($company->inbound_mailbox_allow_vendors && $company->vendors()->where("invoicing_email", $email->from)->orWhere("invoicing_domain", $domain)->exists())
|
|
return true;
|
|
if ($company->inbound_mailbox_allow_vendors && $company->vendors()->contacts()->where("email", $email->from)->exists())
|
|
return true;
|
|
|
|
// from clients
|
|
if ($company->inbound_mailbox_allow_clients && $company->clients()->contacts()->where("email", $email->from)->exists())
|
|
return true;
|
|
|
|
// denie
|
|
return false;
|
|
}
|
|
private function getClient(Company $company, InboundMail $email)
|
|
{
|
|
// $parts = explode('@', $email->from);
|
|
// $domain = array_pop($parts);
|
|
|
|
$clientContact = ClientContact::where("company_id", $company->id)->where("email", $email->from)->first();
|
|
$client = $clientContact->client();
|
|
|
|
return $client;
|
|
}
|
|
private function getVendor(Company $company, InboundMail $email)
|
|
{
|
|
$parts = explode('@', $email->from);
|
|
$domain = array_pop($parts);
|
|
|
|
$vendor = Vendor::where("company_id", $company->id)->where('invoicing_email', $email->from)->first();
|
|
if ($vendor == null)
|
|
$vendor = Vendor::where("company_id", $company->id)->where("invoicing_domain", $domain)->first();
|
|
if ($vendor == null) {
|
|
$vendorContact = VendorContact::where("company_id", $company->id)->where("email", $email->from)->first();
|
|
$vendor = $vendorContact->vendor();
|
|
}
|
|
|
|
return $vendor;
|
|
}
|
|
private function logBlocked(Company $company, string $data)
|
|
{
|
|
Log::info("[InboundMailEngine][company:" . $company->id . "] " . $data);
|
|
|
|
(
|
|
new SystemLogger(
|
|
$data,
|
|
SystemLog::CATEGORY_MAIL,
|
|
SystemLog::EVENT_INBOUND_MAIL_BLOCKED,
|
|
SystemLog::TYPE_CUSTOM,
|
|
null,
|
|
$company
|
|
)
|
|
)->handle();
|
|
}
|
|
}
|