Class ilObjFileImplementationLegacy. More...

Inheritance diagram for ilObjFileImplementationLegacy:

Collaboration diagram for ilObjFileImplementationLegacy:

Public Member Functions
	__construct (int $obj_id, int $version, string $file_name)
	ilObjFileImplementationAbstract constructor. More...

	getDirectory ($a_version=0)
	@inheritDoc More...

	handleChangedObjectTitle (string $new_title)

	createDirectory ()
	@inheritDoc More...

	clearDataDirectory ()
	@inheritDoc More...

	deleteVersions ($a_hist_entry_ids=null)
	@inheritDoc More...

	getFileExtension ()
	@inheritDoc More...

	export (string $target_dir)
	@depracated More...

	getVersions ($version_ids=null)
	@inheritDoc array ( 0 => array ( 'date' => '2020-11-05 09:49:18', 'user_id' => '6', 'obj_id' => '297', 'obj_type' => 'file', 'action' => 'create', 'info_params' => 'Version 1.docx,1,1', 'user_comment' => '', 'hist_entry_id' => '1', 'title' => NULL, 'filename' => 'Version 1.docx', 'version' => '1', 'max_version' => '1', 'rollback_version' => '', 'rollback_user_id' => '', ), ) More...

	getSpecificVersion ($version_id)
	@inheritDoc More...

	getFile ($a_hist_entry_id=null)
	@inheritDoc More...

	getVersion ()

	getFileType ()
	@inheritDoc More...

	getStorageID ()

Public Member Functions inherited from ilObjFileImplementationAbstract
	createDirectory ()
	@inheritDoc More...

	replaceFile ($a_upload_file, $a_filename)
	@inheritDoc More...

	addFileVersion ($a_upload_file, $a_filename)
	@inheritDoc More...

	clearDataDirectory ()
	@inheritDoc More...

	setFileType ($a_type)
	@inheritDoc More...

	setFileSize ($a_size)
	@inheritDoc More...

	getFileSize ()

	setVersion ($a_version)
	@inheritDoc More...

	getVersion ()

	setMaxVersion ($a_max_version)
	@inheritDoc More...

	getMaxVersion ()

	storeUnzipedFile ($a_upload_file, $a_filename)
	@inheritDoc More...

	getSpecificVersion ($version_id)
	@inheritDoc More...

Public Member Functions inherited from ilObjFileImplementationInterface
	getDirectory ($a_version=0)

	createDirectory ()

	replaceFile ($a_upload_file, $a_filename)

	clearDataDirectory ()

	deleteVersions ($a_hist_entry_ids=null)
	Deletes the specified history entries or all entries if no ids are specified. More...

	setFileType ($a_type)

	getFileType ()

	getStorageID ()

	setFileSize ($a_size)

	handleChangedObjectTitle (string $new_title)

	getFileSize ()

	getFile ($a_hist_entry_id=null)

	setVersion ($a_version)

	getVersion ()

	setMaxVersion ($a_max_version)

	getMaxVersion ()

	sendFile ($a_hist_entry_id=null)

	getFileExtension ()
	Returns the extension of the file name converted to lower-case. More...

	storeUnzipedFile ($a_upload_file, $a_filename)

	getVersions ($version_ids=null)
	Gets the file versions for this object. More...

	export (string $target_dir)
	@depracated More...

Static Public Member Functions
static	parseInfoParams ($entry)
	Parses the info parameters ("info_params") of the specified history entry. More...

Protected Member Functions
	compareVersions ($v1, $v2)
	Compares two file versions. More...

Protected Attributes
	$obj_id

	$version

	$file_name

Private Member Functions
	getFileName ()

	isInline ()

Private Attributes
	$file_storage

Detailed Description

Class ilObjFileImplementationLegacy.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 10 of file class.ilObjFileImplementationLegacy.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjFileImplementationLegacy::__construct	(	int	$obj_id,
		int	$version,
		string	$file_name
	)

ilObjFileImplementationAbstract constructor.

Parameters

int	$obj_id
int	$version
string	$file_name

Definition at line 33 of file class.ilObjFileImplementationLegacy.php.

    {
        $this->obj_id = $obj_id;
        $this->version = $version;
        $this->file_name = $file_name;
        $this->file_storage = new ilFSStorageFile($obj_id);
        $this->file_storage->create();
    }

References $file_name, $obj_id, and $version.

Member Function Documentation

◆ clearDataDirectory()

ilObjFileImplementationLegacy::clearDataDirectory ( )

@inheritDoc

Reimplemented from ilObjFileImplementationAbstract.

Definition at line 72 of file class.ilObjFileImplementationLegacy.php.

    {
        ilUtil::delDir($this->getDirectory());
        $this->createDirectory();
    }

References createDirectory(), ilUtil\delDir(), and getDirectory().

Referenced by deleteVersions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ compareVersions()

ilObjFileImplementationLegacy::compareVersions	(	$v1,
		$v2
	)

protected

Compares two file versions.

Parameters

array	$v1	First file version to compare.
array	$v2	Second file version to compare.

Returns: int Returns an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.

Definition at line 195 of file class.ilObjFileImplementationLegacy.php.

    {
        // v2 - v1 because version should be descending
        return (int) $v2["version"] - (int) $v1["version"];
    }

◆ createDirectory()

ilObjFileImplementationLegacy::createDirectory ( )

@inheritDoc

Reimplemented from ilObjFileImplementationAbstract.

Definition at line 64 of file class.ilObjFileImplementationLegacy.php.

    {
        ilUtil::makeDirParents($this->getDirectory());
    }

References getDirectory(), and ilUtil\makeDirParents().

Referenced by clearDataDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteVersions()

ilObjFileImplementationLegacy::deleteVersions ( $a_hist_entry_ids = null )

@inheritDoc

Implements ilObjFileImplementationInterface.

Definition at line 81 of file class.ilObjFileImplementationLegacy.php.

    {
        if ($a_hist_entry_ids == null || count($a_hist_entry_ids) < 1) {
            $this->clearDataDirectory();
 
            ilHistory::_removeEntriesForObject($this->obj_id);
        } else {
            $actualVersionDeleted = false;
 
            // get all versions
            $versions = $this->getVersions();
 
            // delete each version
            foreach ($a_hist_entry_ids as $hist_id) {
                $entry = null;
 
                // get version
                foreach ($versions as $index => $version) {
                    if ($version["hist_entry_id"] == $hist_id) {
                        // remove each history entry
                        ilHistory::_removeEntryByHistoryID($hist_id);
 
                        // delete directory
                        $version_dir = $this->getDirectory($version["version"]);
                        ilUtil::delDir($version_dir);
 
                        // is actual version?
                        if ($version["version"] == $this->getVersion()) {
                            $actualVersionDeleted = true;
                        }
 
                        // remove from array
                        unset($versions[$index]);
                        break;
                    }
                }
            }
 
            // update actual version if it was deleted before
            if ($actualVersionDeleted) {
                // get newest version (already sorted by getVersions)
                $version = reset($versions);
                $version['max_version'] = $this->getMaxVersion();
                $this->updateWithVersion($version);
            }
        }
    }

References $index, $version, ilHistory\_removeEntriesForObject(), ilHistory\_removeEntryByHistoryID(), clearDataDirectory(), ilUtil\delDir(), getDirectory(), ilObjFileImplementationAbstract\getMaxVersion(), getVersion(), and getVersions().

Here is the call graph for this function:

◆ export()

ilObjFileImplementationLegacy::export ( string $target_dir )

@depracated

Implements ilObjFileImplementationInterface.

Definition at line 201 of file class.ilObjFileImplementationLegacy.php.

                                               : void
    {
        $subdir = "il_" . IL_INST_ID . "_file_" . $this->getId();
        ilUtil::makeDir($target_dir . "/objects/" . $subdir);
 
        $filedir = $this->getDirectory($this->getVersion()); // FSX
 
        if (@!is_dir($filedir)) {
            $filedir = $this->getDirectory();
        }
 
        ilUtil::rCopy($filedir, $target_dir . "/objects/" . $subdir);
    }

References getDirectory(), getVersion(), IL_INST_ID, ilUtil\makeDir(), and ilUtil\rCopy().

Here is the call graph for this function:

◆ getDirectory()

ilObjFileImplementationLegacy::getDirectory ( $a_version = 0 )

@inheritDoc

Implements ilObjFileImplementationInterface.

Definition at line 45 of file class.ilObjFileImplementationLegacy.php.

    {
        $version_subdir = "";
 
        if ($a_version) {
            $version_subdir = sprintf("%03d", $a_version);
        }
 
        return $this->file_storage->getAbsolutePath() . '/' . $version_subdir;
    }

Referenced by clearDataDirectory(), createDirectory(), deleteVersions(), export(), getFile(), and getVersions().

Here is the caller graph for this function:

◆ getFile()

ilObjFileImplementationLegacy::getFile ( $a_hist_entry_id = null )

@inheritDoc

Implements ilObjFileImplementationInterface.

Definition at line 361 of file class.ilObjFileImplementationLegacy.php.

    {
        if (is_null($a_hist_entry_id)) {
            $file = $this->getDirectory($this->getVersion()) . "/" . $this->getFileName(); // FSX
        } else {
            require_once("./Services/History/classes/class.ilHistory.php");
            $entry = ilHistory::_getEntryByHistoryID($a_hist_entry_id);
 
            if ($entry === false) {
                return false;
            }
 
            $data = ilObjFileImplementationLegacy::parseInfoParams($entry);
            $file = $this->getDirectory($data["version"]) . "/" . $data["filename"];
        }
 
        return $file;
    }

References $data, ilHistory\_getEntryByHistoryID(), getDirectory(), getFileName(), getVersion(), and parseInfoParams().

Here is the call graph for this function:

◆ getFileExtension()

ilObjFileImplementationLegacy::getFileExtension ( )

@inheritDoc

Implements ilObjFileImplementationInterface.

Definition at line 182 of file class.ilObjFileImplementationLegacy.php.

    {
        return ilObjFileAccess::_getFileExtension($this->getTitle());
    }

References ilObjFileAccess\_getFileExtension().

Here is the call graph for this function:

◆ getFileName()

ilObjFileImplementationLegacy::getFileName ( )

private

Definition at line 385 of file class.ilObjFileImplementationLegacy.php.

    {
        return $this->file_name;
    }

References $file_name.

Referenced by getFile(), and isInline().

Here is the caller graph for this function:

◆ getFileType()

ilObjFileImplementationLegacy::getFileType ( )

@inheritDoc

Implements ilObjFileImplementationInterface.

Definition at line 402 of file class.ilObjFileImplementationLegacy.php.

    {
        return '';
    }

◆ getSpecificVersion()

ilObjFileImplementationLegacy::getSpecificVersion ( $version_id )

@inheritDoc

Reimplemented from ilObjFileImplementationAbstract.

Definition at line 337 of file class.ilObjFileImplementationLegacy.php.

    {
        include_once("./Services/History/classes/class.ilHistory.php");
        $version = ilHistory::_getEntryByHistoryID($version_id);
        if ($version === false) {
            return false;
        }
 
        // ilHistory returns different keys in _getEntryByHistoryID and _getEntriesForObject
        // so this makes it the same
        $version["hist_entry_id"] = $version["id"];
        $version["user_id"] = $version["usr_id"];
        $version["date"] = $version["hdate"];
        unset($version["id"], $version["usr_id"], $version["hdate"]);
 
        // parse params
        $params = ilObjFileImplementationLegacy::parseInfoParams($version);
 
        return array_merge($version, $params);
    }

References $version, ilHistory\_getEntryByHistoryID(), and parseInfoParams().

Here is the call graph for this function:

◆ getStorageID()

ilObjFileImplementationLegacy::getStorageID ( )

Implements ilObjFileImplementationInterface.

Definition at line 407 of file class.ilObjFileImplementationLegacy.php.

                                   : ?string
    {
        return '-';
    }

◆ getVersion()

ilObjFileImplementationLegacy::getVersion ( )

Reimplemented from ilObjFileImplementationAbstract.

Definition at line 380 of file class.ilObjFileImplementationLegacy.php.

    {
        return $this->version;
    }

References $version.

Referenced by deleteVersions(), export(), and getFile().

Here is the caller graph for this function:

◆ getVersions()

ilObjFileImplementationLegacy::getVersions ( $version_ids = null )

@inheritDoc array ( 0 => array ( 'date' => '2020-11-05 09:49:18', 'user_id' => '6', 'obj_id' => '297', 'obj_type' => 'file', 'action' => 'create', 'info_params' => 'Version 1.docx,1,1', 'user_comment' => '', 'hist_entry_id' => '1', 'title' => NULL, 'filename' => 'Version 1.docx', 'version' => '1', 'max_version' => '1', 'rollback_version' => '', 'rollback_user_id' => '', ), )

Implements ilObjFileImplementationInterface.

Definition at line 237 of file class.ilObjFileImplementationLegacy.php.

                                                     : array
    {
        $versions = (array) ilHistory::_getEntriesForObject($this->obj_id, 'file');
 
        if ($version_ids != null && count($version_ids) > 0) {
            foreach ($versions as $index => $version) {
                if (!in_array($version["hist_entry_id"], $version_ids, true)) {
                    unset($versions[$index]);
                }
            }
        }
 
        // add custom entries
        foreach ($versions as $index => $version) {
            $params = ilObjFileImplementationLegacy::parseInfoParams($version);
            $versions[$index] = array_merge($version, $params);
        }
 
        // sort by version number (hist_entry_id will do for that)
        usort($versions, array($this, "compareVersions"));
 
        $version_objects = [];
        foreach ($versions as $version) {
            $file = $this->getDirectory($version["version"]) . "/" . $version["filename"];
            $filesize = @filesize($file);
            $version['size'] = $filesize;
            $version_objects[] = new ilObjFileVersion($version);
        }
 
        return $version_objects;
    }

References $index, $version, ilHistory\_getEntriesForObject(), getDirectory(), and parseInfoParams().

Referenced by deleteVersions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleChangedObjectTitle()

ilObjFileImplementationLegacy::handleChangedObjectTitle ( string $new_title )

Implements ilObjFileImplementationInterface.

Definition at line 56 of file class.ilObjFileImplementationLegacy.php.

    {
        // noting to do here
    }

◆ isInline()

ilObjFileImplementationLegacy::isInline ( )

private

Returns: bool

Deprecated:

Definition at line 394 of file class.ilObjFileImplementationLegacy.php.

    {
        return ilObjFileAccess::_isFileInline($this->getFileName());
    }

References ilObjFileAccess\_isFileInline(), and getFileName().

Here is the call graph for this function:

◆ parseInfoParams()

static ilObjFileImplementationLegacy::parseInfoParams ( $entry )

static

Parses the info parameters ("info_params") of the specified history entry.

Parameters

array $entry The history entry.

Returns: array Returns an array containing the "filename" and "version" contained within the "info_params".

Definition at line 275 of file class.ilObjFileImplementationLegacy.php.

                                                   : array
    {
        $data = explode(",", $entry["info_params"]);
 
        // bugfix: first created file had no version number
        // this is a workaround for all files created before the bug was fixed
        if (empty($data[1])) {
            $data[1] = "1";
        }
 
        if (empty($data[2])) {
            $data[2] = "1";
        }
 
        // BEGIN bugfix #31730
        // if more than 2 commas are detected, the need for reassembling the filename is: possible to necessary
        if (sizeof($data) > 2) {
            $last = sizeof($data) - 1;
            for ($n = 1; $n < $last - 1; $n++) {
                $data[0] .= "," . $data[$n];
            }
 
            // trying to distinguish the next-to-last being a 'last part of the filename'
            // or a 'version information',  based on having a dot included or not
            if (strpos($data[$last - 1], ".") !== false) {
                $data[0] .= "," . $data[$last - 1];
                $data[1] = $data[$last];
                $data[2] = $data[$last];
            } else {
                $data[1] = $data[$last - 1];
                $data[2] = $data[$last];
            }
        }
        // END bugfix #31730
        
        $result = array(
            "filename" => $data[0],
            "version" => $data[1],
            "max_version" => $data[2],
            "rollback_version" => "",
            "rollback_user_id" => "",
        );
 
        // if rollback, the version contains the rollback version as well
        if ($entry["action"] == "rollback") {
            $tokens = explode("|", $result["max_version"]);
            if (count($tokens) > 1) {
                $result["max_version"] = $tokens[0];
                $result["rollback_version"] = $tokens[1];
 
                if (count($tokens) > 2) {
                    $result["rollback_user_id"] = $tokens[2];
                }
            }
        }
 
        return $result;
    }