<?php
/**
 * SeekQuarry/Yioop --
 * Open Source Pure PHP Search Engine, Crawler, and Indexer
 *
 * Copyright (C) 2009 - 2026  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
 * @license https://www.gnu.org/licenses/ GPL3
 * @link https://www.seekquarry.com/
 * @copyright 2009 - 2026
 * @filesource
 */
namespace seekquarry\yioop\models;

use seekquarry\yioop\configs as C;
use seekquarry\yioop\library\FetchUrl;

/**
 * Used to remember the last time the web app ran periodic activities
 *
 * @author Chris Pollett
 */
class CronModel extends Model
{
    /**
     * File name used to store the cron table associative array
     * @var string
     */
    public $cron_file;
    /**
     * An associative array of key_name => timestamps use to indicate
     * when various cron activities were last performed
     * @var array
     */
    public $cron_table;
    /**
     * {@inheritDoc}
     *
     * @param string $db_name the name of the database for the search engine
     * @param bool $connect whether to connect to the database by default
     *     after making the datasource class
     */
    public function __construct($db_name = C\DB_NAME, $connect = true)
    {
        parent::__construct($db_name, $connect);
        $this->cron_table === null;
        $this->cron_file = C\DATA_DIR . "/CronTime.txt";
    }
    /**
     * Returns the timestamp of last time the $key field was updated in
     * the CronTime.txt file associate array. Not using db as sqlite
     * seemed to have locking issues if the transaction takes a while
     *
     * @param $key field to find last update of
     * @return int a Unix timestamp
     */
    public function getCronTime($key)
    {
        if ($this->cron_table === null) {
            $this->loadCronTable();
        }
        if (!isset($this->cron_table[$key])) {
            $time = time();
        } else {
            $time = $this->cron_table[$key];
        }
        return $time;
    }
    /**
     * Loads into $this->cron_table the associative array of key =>timestamps
     * that is a cron table
     */
    public function loadCronTable()
    {
        if (file_exists($this->cron_file)) {
            $this->cron_table = unserialize(file_get_contents(
                $this->cron_file));
        } else {
            $this->cron_table = [];
        }
    }
    /**
     * Updates the Cron timestamp to the current time.
     *
     * @param string $key field to update time for
     * @param int $time unix time to set the time associated to key to,
     *      defaults to current time
     * @param bool $transaction if you are doing a sequence of cron updates
     *     you can set this value to true so data is not immediately
     *     written to disk. Then you can write to disk using saveCronTable
     *     so only do one write.
     */
    public function updateCronTime($key, $time = false, $transaction = false)
    {
        if ($this->cron_table === null) {
            $this->loadCronTable();
        }
        if (!is_array($this->cron_table)) {
            $this->cron_table = [];
        }
        $this->cron_table[$key] = ($time === false) ? time() : $time;
        if (!$transaction) {
            file_put_contents($this->cron_file, serialize($this->cron_table));
            set_error_handler(null);
            @chmod($this->cron_file, 0777);
            restore_error_handler();
        }
    }
}
