owncloud/core

<?php
/**
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Robin Appelman <icewind@owncloud.com>
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 *
 * @copyright Copyright (c) 2022, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\BackgroundJob;

use OCP\BackgroundJob\IJob;
use OCP\ILogger;

abstract class Job implements IJob {
    /**
     * @var int $id
     */
    protected $id;

    /**
     * @var int $lastRun
     */
    protected $lastRun;

    /**
     * @var mixed $argument
     */
    protected $argument;

    /**
     * @var int $lastChecked
     */
    protected $lastChecked;

    /**
     * @var int $reservedAt
     */
    protected $reservedAt;

    /**
     * @var int $executionDuration
     */
    protected $executionDuration;

    /**
     * @param JobList $jobList
     * @param ILogger $logger
     */
    public function execute($jobList, ILogger $logger = null) {
        $jobList->setLastRun($this);
        try {
            //storing job start time
            $jobStartTime = \time();

            if ($logger) {
                $logger->debug(
                    'Started background job of class : {class} with arguments : {arguments}',
                    [
                        'app' => 'cron',
                        'class' => \get_class($this),
                        'arguments' => \print_r($this->argument, true)
                    ]
                );
            }

            $this->run($this->argument);

            //storing job end time
            $jobEndTime = \time();
            $timeTaken = $jobEndTime - $jobStartTime;

            if ($logger) {
                $logger->debug(
                    'Finished background job, the job took : {timeTaken} seconds, this job is an instance of class : {class} with arguments : {arguments}',
                    [
                        'app' => 'cron',
                        'timeTaken' => $timeTaken,
                        'class' => \get_class($this),
                        'arguments' => \print_r($this->argument, true)
                    ]
                );
            }

            $jobList->setExecutionTime($this, $timeTaken);
        } catch (\Exception $e) {
            if ($logger) {
                $logger->logException($e, [
                    'app' => 'core',
                    'message' => 'Error while running background job (class: ' . \get_class($this) . ', arguments: ' . \print_r($this->argument, true) . ')'
                ]);
            }
        }
    }

    abstract protected function run($argument);

    public function setId($id) {
        $this->id = $id;
    }

    public function setLastRun($lastRun) {
        $this->lastRun = $lastRun;
    }

    public function setArgument($argument) {
        $this->argument = $argument;
    }
    
    public function setLastChecked(int $lastChecked): void {
        $this->lastChecked = $lastChecked;
    }
    
    public function setReservedAt(int $reservedAt): void {
        $this->reservedAt = $reservedAt;
    }

    public function setExecutionDuration(int $executionDuration): void {
        $this->executionDuration = $executionDuration;
    }

    public function getId() {
        return $this->id;
    }

    public function getLastRun() {
        return $this->lastRun;
    }

    public function getArgument() {
        return $this->argument;
    }

    public function getLastChecked(): int {
        return $this->lastChecked;
    }

    public function getReservedAt(): int {
        return $this->reservedAt;
    }

    public function getExecutionDuration(): int {
        return $this->executionDuration;
    }
}