class NormaliseAccessMigrationHelper (View source)

Service to help identify and migrate Files that have been saved to the wrong asset store and restore them to the appropriate physical location.

This is meant to correct files that got save to the wrong location following the CVE-2019-12245 vulnerability.

Traits

A class that can be instantiated or replaced via DI

Provides extensions to this object to integrate it with standard config API methods.

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

__construct(string $base = '')

No description

$this
setLogger(LoggerInterface $logger)

No description

int[]
run()

Perform migration

array
findBadFiles()

Loop through all the files and find the ones that aren't stored in the correct store.

bool
fix(File $file)

Make sure all versions of the povided file are stored in the correct asset store.

int
needToMove(File $draftFile)

Determine if the versions of the provided file are stored in the correct asset store.

Details

static Injectable create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct(string $base = '')

Parameters

string $base

Prefix for URLs. Only used for unit tests.

$this setLogger(LoggerInterface $logger)

Parameters

LoggerInterface $logger

Return Value

$this

int[] run()

Perform migration

Return Value

int[]

Number of files successfully migrated

array findBadFiles()

Loop through all the files and find the ones that aren't stored in the correct store.

Returns an array of bit masks with the ID of the file has the key.

Return Value

array

bool fix(File $file)

Make sure all versions of the povided file are stored in the correct asset store.

Parameters

File $file

Return Value

bool

Whether the fix was completed succesfully

int needToMove(File $draftFile)

Determine if the versions of the provided file are stored in the correct asset store.

Parameters

File $draftFile

Return Value

int

Bitmask for the operations to perform on the file

Exceptions

InvalidArgumentException

When the provided $draftFile is invalid

LogicException

When there's some unexpected condition with the file