AbstractSummitEmailJob.php

<?php namespace App\Jobs\Emails;
/**
 * Copyright 2024 OpenStack Foundation
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

use App\Services\Apis\IMailApi;
use Illuminate\Support\Facades\App;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Log;
use models\summit\ISummitRepository;
use models\summit\Summit;
use models\summit\SummitVenue;
use services\apis\IMarketingAPI;

/**
 * Class AbstractSummitEmailJob
 * @package App\Jobs\Emails
 */
abstract class AbstractSummitEmailJob extends AbstractEmailJob
{
    /**
     * @param Summit $summit
     * @param array $payload
     * @param string|null $template_identifier
     * @param string $to_email
     * @param string|null $subject
     * @param string|null $cc_email
     * @param string|null $bcc_email
     */
    public function __construct
    (
        Summit $summit,
        array $payload,
        ?string $template_identifier,
        string $to_email,
        ?string $subject = null,
        ?string $cc_email = null,
        ?string $bcc_email = null
    )
    {
        Log::debug
        (
            sprintf
            (
                "AbstractSummitEmailJob::construct summit %s payload %s to_email %s",
                $summit->getId(),
                json_encode($payload),
                $to_email
            )
        );

        $repository = App::make(ISummitRepository::class);
        $summit = $repository->getByIdRefreshed($summit->getId());

        // inject summit common data
        $payload[IMailTemplatesConstants::summit_id]   = $summit->getId();
        $payload[IMailTemplatesConstants::summit_name] = $summit->getName();
        $payload[IMailTemplatesConstants::summit_logo] = $summit->getLogoUrl();
        $payload[IMailTemplatesConstants::summit_virtual_site_url] = $summit->getVirtualSiteUrl();
        $payload[IMailTemplatesConstants::summit_marketing_site_url] = $summit->getMarketingSiteUrl();
        $payload[IMailTemplatesConstants::raw_summit_virtual_site_url] = $summit->getVirtualSiteUrl();
        $payload[IMailTemplatesConstants::raw_summit_marketing_site_url] = $summit->getMarketingSiteUrl();

        $summitBeginDate = $summit->getLocalBeginDate();
        $payload[IMailTemplatesConstants::summit_date] = !is_null($summitBeginDate)? $summitBeginDate->format("F d, Y") : "";
        $payload[IMailTemplatesConstants::summit_dates_label] = $summit->getDatesLabel();
        $payload[IMailTemplatesConstants::summit_schedule_url] = $summit->getScheduleDefaultPageUrl();
        $payload[IMailTemplatesConstants::summit_site_url] = $summit->getLink();
        $payload[IMailTemplatesConstants::registration_link] = $summit->getRegistrationLink();
        $payload[IMailTemplatesConstants::virtual_event_site_link] = $summit->getVirtualSiteUrl();

        if (empty($payload[IMailTemplatesConstants::support_email])){
            $payload[IMailTemplatesConstants::support_email] = $summit->getSupportEmail();
        }

        $main_venue_addresses = collect($summit->getMainVenues())
            ->filter(function(SummitVenue $venue) {
                return !empty($venue->getAddress1());
            })->map(function(SummitVenue $venue) {
                return $venue->getAddress1() . ' ' . $venue->getAddress2() . ', ' . $venue->getCity() . ', ' . $venue->getState();
            })->toArray();

        $payload[IMailTemplatesConstants::main_venue_address] = implode(' - ', $main_venue_addresses);
        parent::__construct($payload, $template_identifier, $to_email, $subject, $cc_email, $bcc_email);
    }

    public function handle
    (
        IMailApi $api
    ){
        $summit_id = $this->payload[IMailTemplatesConstants::summit_id];
        Log::debug(sprintf("AbstractSummitEmailJob::handle summit %s", $summit_id));
        $this->payload = array_merge($this->payload, self::getMarketingVariables($summit_id));
        parent::handle($api);
    }

    private static function getMarketingVariables(int $summit_id) {

        Log::debug(sprintf("AbstractSummitEmailJob::getMarketingVariables summit %s", $summit_id));

        $default_email_template_vars = collect(Config::get('marketing.default_email_template_vars'))
            ->mapWithKeys(function ($value, $key) {
                return [strtoupper($key) => $value];
            })->toArray();

        $marketing_api = App::make(IMarketingApi::class);
        if (is_null($marketing_api)) {
            Log::warning
            (
                sprintf
                (
                    "AbstractSummitEmailJob::getMarketingVariables Marketing API is not set returning default variables %s.",
                    json_encode($default_email_template_vars)
                )
            );
            return $default_email_template_vars;
        }

        try {
            $marketing_vars = $marketing_api->getConfigValues($summit_id, 'EMAIL_TEMPLATE_');
        } catch(\Exception $ex){
            Log::error($ex);
            Log::warning
            (
                sprintf
                (
                    "AbstractSummitEmailJob::getMarketingVariables Marketing API ERROR returning default variables %s.",
                    json_encode($default_email_template_vars)
                )
            );
            return $default_email_template_vars;
        }

        foreach ($default_email_template_vars as $key => $value) {
            if (!array_key_exists($key, $marketing_vars) || !is_string($marketing_vars[$key]) || empty($marketing_vars[$key])) {
                Log::debug
                (
                    sprintf
                    (
                        "AbstractSummitEmailJob::getMarketingVariables summit %s marketing var %s not found or empty, using default value (%s).",
                        $summit_id,
                        $key,
                        $value
                    )
                );
                $marketing_vars[$key] = $value;
            }
        }

        if(count($marketing_vars) > 0) {
            Log::debug
            (
                sprintf
                (
                    "AbstractSummitEmailJob::getMarketingVariables summit %s injecting marketing_vars %s",
                    $summit_id,
                    json_encode($marketing_vars)
                )
            );
        }

        return $marketing_vars;
    }

    /**
     * @return array
     */
    public static function getEmailTemplateSchema(): array{
        $payload = [];
        $payload[IMailTemplatesConstants::summit_id]['type'] = 'int';
        $payload[IMailTemplatesConstants::summit_name]['type'] = 'string';
        $payload[IMailTemplatesConstants::summit_logo]['type'] = 'string';
        $payload[IMailTemplatesConstants::summit_virtual_site_url]['type'] = 'string';
        $payload[IMailTemplatesConstants::summit_marketing_site_url]['type'] = 'string';
        $payload[IMailTemplatesConstants::raw_summit_virtual_site_url]['type'] = 'string';
        $payload[IMailTemplatesConstants::raw_summit_marketing_site_url]['type'] = 'string';
        $payload[IMailTemplatesConstants::summit_date]['type'] = 'string';
        $payload[IMailTemplatesConstants::summit_dates_label]['type'] = 'string';
        $payload[IMailTemplatesConstants::summit_schedule_url]['type'] = 'string';
        $payload[IMailTemplatesConstants::summit_site_url]['type'] = 'string';
        $payload[IMailTemplatesConstants::registration_link]['type'] = 'string';
        $payload[IMailTemplatesConstants::virtual_event_site_link]['type'] = 'string';
        $payload[IMailTemplatesConstants::support_email]['type'] = 'string';
        $payload[IMailTemplatesConstants::main_venue_address]['type'] = 'string';

        return $payload;
    }
}