sunnysideup / silverstripe-flush-front-end

src/Control/FlushReceiver.php

<?php

namespace Sunnysideup\FlushFrontEnd\Control;

use Exception;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\Control\Middleware\HTTPCacheControlMiddleware;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Convert;
use SilverStripe\Core\Flushable;
use SilverStripe\Core\Manifest\ClassLoader;
use SilverStripe\Core\Resettable;
use SilverStripe\Security\Permission;
use Sunnysideup\FlushFrontEnd\Model\FlushRecord;

/**
 * Class \Sunnysideup\FlushFrontEnd\Control\FlushReceiver
 *
 */
class FlushReceiver extends Controller
{
    private static $allowed_actions = [
        'index' => 'ADMIN',
        'do' => true,
        'completed' => true,
        'available' => true,
    ];

    public static function my_url_segment(): string
    {
        return 'flush-front-end';
    }

    public function Link($action = '')
    {
        return '/' . self::join_links(self::my_url_segment(), $action);
    }

    public function completed()
    {
        if (Director::is_cli() || Permission::check('ADMIN')) {
            $objects = FlushRecord::get()->filter(['Done' => false]);
            foreach ($objects as $obj) {
                echo $obj->dbObject('LastEdited')->ago() . ' - ' . $obj->Code;
                if (! Director::is_cli()) {
                    echo PHP_EOL;
                } else {
                    echo '<br />';
                }
            }
        } else {
            die('This needs to be run from the command line or you need to be logged in as ADMIN.');

Using exit here is not recommended.

        }
    }

    public function available()
    {
        if (Director::is_cli() || Permission::check('ADMIN')) {
            $objects = FlushRecord::get()->filter(['Done' => false]);
            foreach ($objects as $obj) {
                if (Director::is_cli()) {
                    echo $this->Link('do/' . $obj->Code) . PHP_EOL;
                } else {
                    echo '<a href="' . $this->Link('do/' . $obj->Code) . '">' . $obj->Code . '</a><br />';
                }
            }
        } else {
            die('This needs to be run from the command line or you need to be logged in as ADMIN.');

Using exit here is not recommended.

        }
    }

    public function do($request)
    {
        if (Director::is_cli()) {
            die(

Using exit here is not recommended.

                '
This needs to be run from the front-end.

'
            );
        }
        $code = Convert::raw2sql($request->param('ID'));
        if ($code) {
            $obj = $this->getFlushRecord($code);

It seems like $code can also be of type array and array; however, parameter $code of Sunnysideup\FlushFrontEnd\Control\FlushReceiver::getFlushRecord() does only seem to accept string, maybe add an additional type check?

            if ($obj instanceof \Sunnysideup\FlushFrontEnd\Model\FlushRecord) {

$obj is always a sub-type of Sunnysideup\FlushFrontEnd\Model\FlushRecord.

                // mark as done first
                $obj->Done = true;
                $obj->write();

                $this->doFlush();
                $olds = FlushRecord::get()->filter(['Created:LessThan' => date('Y-m-d h:i:s', strtotime('-3 months'))]);
                foreach ($olds as $old) {
                    $old->delete();
                }

                return '
-----------------------------------------
SUCCESS: FRONT-END FLUSHED
-----------------------------------------

';
            }
        }
        return '
-----------------------------------------
ERROR: FRONT-END NOT FLUSHED
-----------------------------------------

        ';
    }

    protected function doFlush()
    {
        if (file_exists(TEMP_PATH)) {
            $this->deleteFolderContents(TEMP_PATH);
        }

        HTTPCacheControlMiddleware::singleton()->disableCache(true);
        ClassLoader::inst()->getManifest()->regenerate(false);
        // Reset all resettables
        /** @var Resettable $resettable */
        foreach (ClassInfo::implementorsOf(Resettable::class) as $resettable) {
            $resettable::reset();
        }

        /** @var Flushable $class */
        foreach (ClassInfo::implementorsOf(Flushable::class) as $class) {
            $class::flush();
        }
    }

    protected function getFlushRecord(string $code): ?FlushRecord
    {
        /** @var FlushRecord $obj */
        $obj = FlushRecord::get()->filter(['Done' => false, 'Code' => $code])->first();
        if ($obj) {

$obj is of type Sunnysideup\FlushFrontEnd\Model\FlushRecord, thus it always evaluated to true.

            return $obj;
        }

        echo 'object not found';

        return null;
    }

    // Function to delete files and folders recursively
    private function deleteFolderContents(string $folderPath)
    {
        if (! is_dir($folderPath)) {
            return;
        }

        $files = array_diff(scandir($folderPath), ['.', '..']);

        foreach ($files as $file) {
            $filePath = $folderPath . '/' . $file;

            if (is_dir($filePath)) {
                $this->deleteFolderContents($filePath); // Recursively delete sub-folders
            } else {
                try {
                    unlink($filePath); // Delete files
                } catch (Exception $e) {

Consider adding a comment why this CATCH block is empty.

                }
            }
        }
    }
}