Last commit for src/library/media_jobs/BulkEmailJob.php: 2addb500315b7393a90fe66431d7832b1e7386c7

Adjust copyrights years

Chris Pollett [2024-01-03 21:Jan:rd]
Adjust copyrights years
<?php
/**
 * SeekQuarry/Yioop --
 * Open Source Pure PHP Search Engine, Crawler, and Indexer
 *
 * Copyright (C) 2009 - 2023  Chris Pollett chris@pollett.org
 *
 * LICENSE:
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * END LICENSE
 *
 * @author Chris Pollett chris@pollett.org (initial MediaJob class
 *      and subclasses based on work of Pooja Mishra for her master's)
 * @license https://www.gnu.org/licenses/ GPL3
 * @link https://www.seekquarry.com/
 * @copyright 2009 - 2023
 * @filesource
 */
namespace seekquarry\yioop\library\media_jobs;

use seekquarry\yioop\configs as C;
use seekquarry\yioop\library as L;
use seekquarry\yioop\library\MailServer;

/**
 * MediaJob class for sending out emails from a Yioop instance (either in
 * response to account registrations or in response to group posts and similar
 * activities)
 */
class BulkEmailJob extends MediaJob
{
    /**
     * Mail Server object used to send mails from media updater
     * @var object
     */
    public $mail_server;
    /**
     * Set up the MailServer object used to actually send mail
     */
    public function init()
    {
        $this->mail_server = new MailServer(C\MAIL_SENDER, C\MAIL_SERVER,
            C\MAIL_SERVERPORT, C\MAIL_USERNAME, C\MAIL_PASSWORD,
            C\MAIL_SECURITY);
    }
    /**
     * Bulk mail runs if the media updater is in distributed mode or if
     * Yioop configured to send mail from media updater
     *
     * @return true if bulk mail task should be run.
     */
    public function checkPrerequisites()
    {
        $parent = $this->media_updater;
        return ($parent->media_mode == 'distributed' ||
            $parent->mail_mode);
    }
    /**
     * Function to send emails to mailer batches created by
     * mail_server. This function would periodically be invoked and
     * send emails reading data from the text files.
     */
    public function nondistributedTasks()
    {
        $mail_directory = C\WORK_DIRECTORY . self::MAIL_FOLDER;
        if (!file_exists($mail_directory)) {
            return;
        }
        $files = glob($mail_directory."/*.txt");
        if (!isset($files[0])) {
            return;
        }
        $sendable_file = false;
        foreach ($files as $email_file) {
            if (time() - filemtime($email_file) >
                C\MAIL_AGGREGATION_TIME) {
                $sendable_file = $email_file;
                break;
            }
        }
        if (!$sendable_file) {
            return;
        }
        L\crawlLog("Using Mail Directory:" . $mail_directory);
        $emails_string = file_get_contents($sendable_file);
        unlink($sendable_file);
        $emails = explode(self::MESSAGE_SEPARATOR, $emails_string);
        foreach ($emails as $serialized_email) {
            $email = unserialize($serialized_email);
            if (is_array($email) && count($email) == 4) {
                L\crawlLog(
                    "Sending email to {$email[2]} about {$email[0]}");
                $this->mail_server->sendImmediate(
                    $email[0], $email[1], $email[2], $email[3]);
            }
        }
    }
    /**
     * Emails a list of emails provided by the name server to the media updater
     * client
     *
     * @param array $tasks contains emails which should be sent out
     * @return mixed data to send back to name server (in this case the name
     *      of the email file that was completely sent)
     */
    public function doTasks($tasks)
    {
        if (!isset($tasks["name"]) || !isset($tasks["data"])) {
            L\crawlLog("...Email Task received incomplete !");
            return false;
        }
        L\crawlLog("----Email file name: {$tasks['name']}");
        $emails = explode(self::MESSAGE_SEPARATOR, $tasks["data"]);
        foreach ($emails as $serialized_email) {
            $email = unserialize($serialized_email);
            if (count($email) == 4) {
                L\crawlLog("Sending email to {$email[2]} about {$email[0]}");
                $this->mail_server->sendImmediate(
                    $email[0], $email[1], $email[2], $email[3]);
            }
        }
        return false;
    }
    /**
     * Handles the request to get the mailer list file for
     * sending emails. This selection is based upon if the file was taken
     * previously or not. If it was then it is skipped.
     * Otherwise new file is sent for sending emails and new text file
     * with taken prepended to the file name is generated.
     *
     * @param int $machine_id id of client requesting data (not used)
     * @param array $data not used
     */
    public function getTasks($machine_id, $data = null)
    {
        $mail_directory = C\WORK_DIRECTORY . self::MAIL_FOLDER;
        if (!file_exists($mail_directory)) {
            return false;
        }
        $files = glob($mail_directory . "/*.txt");
        $sendable_file = false;
        foreach ($files as $email_file) {
            if (time() - filemtime($email_file) >
                C\MAIL_AGGREGATION_TIME) {
                $sendable_file = $email_file;
                break;
            }
        }
        if (!$sendable_file) {
            return false;
        }
        $file_name = str_replace($mail_directory . "/","", $sendable_file);
        $task = [];
        $task["name"] = $file_name;
        $task["data"] = file_get_contents($sendable_file);
        unlink($file);
        return $task;
    }
}
ViewGit