test_dead_file_revisions.inc

<?php
class Test_Dead_File_Revisions
{

    static $dirList = Array();

    public static function getName()
    {
        return 'Dead File Revisions';

    }//end getName()


    public static function getDescription()
    {
        return 'A test to check for dead file revisions found in the data/file_repository directory, but the asset has been deleted.';

    }//end getDescription()

    private static function getAssetDirs($dir)
    {
        $dirs = Array();
        if (!$dh = opendir($dir)) {
            return FALSE;
        }

        while (($file = readdir($dh)) !== false) {
            if ($file == '.' || $file == '..') {
                continue;
            }
            $fullpath = $dir . '/' . $file;
            if (is_dir($fullpath)) {
                $dirs[] = $fullpath;
            }
        }
        closedir($dh);

        foreach ($dirs as $dir) {
            $subdirs = self::getAssetDirs($dir);
            if (empty($subdirs)) {
                self::$dirList[] = $dir;
            }
            $dirs = array_merge($dirs, $subdirs);
        }
        return $dirs;
    }

    private static function findAssetsToDelete($assetIdsOnly=TRUE)
    {
        $file_repo_dir = SQ_DATA_PATH . '/file_repository';
        $private_dir = SQ_DATA_PATH . '/private';
        if (empty(self::$dirList)) {
            self::getAssetDirs($file_repo_dir);
        }

        $dirs = self::$dirList;
        sort($dirs);

        $assetsToDelete = Array();

        $fullPaths = Array();

        foreach ($dirs as $dir) {
            $dir = str_replace($file_repo_dir, '', $dir);
            if (!is_dir($private_dir . $dir)) {
                $dir_parts = explode('/', $dir);
                $assetid = array_pop($dir_parts);
                if ($assetid == 'varieties') {
                    $dir = implode('/', $dir_parts);
                    $assetid = array_pop($dir_parts);
                }
                $assetsToDelete[$assetid] = $assetid;
                $fullPaths[$assetid] = $dir;
            }
        }

        if ($assetIdsOnly) {
            return $assetsToDelete;
        }

        return $fullPaths;
    }

    public static function execute(&$messages, &$errors)
    {
        $status = TRUE;
        if (SQ_CONF_ROLLBACK_ENABLED) {
            $messages[] = "Rollback is enabled, so will not check for orphaned file repository entries.\n\tThey may be required when viewing the system in rollback mode.";
            $status = FALSE;
            return $status;
        }

        $assetsToDelete = self::findAssetsToDelete();

        $assetsCleanedUp = Array();

        if (empty($assetsToDelete)) {
            $messages[] = 'There are no orphaned file repository entries.';
            return $status;
        }

        $messages[] = 'There are ' . sizeof($assetsToDelete) . ' orphaned file repository entries to clean up.';
        $errors[] = 'Will clean up these asset ids: ' . implode(',', $assetsToDelete);

        $fullPaths = self::findAssetsToDelete(FALSE);

        foreach ($assetsToDelete as $assetid) {
            try {
                $exists = $GLOBALS['SQ_SYSTEM']->am->assetExists($assetid);
            }
            catch (Exception $e) {
                $exists = true;
            }

            if ($exists) {
                $msg  = "There is a problem with the data directories for asset $assetid\n";
                $msg .= "\tThis asset still exists. Skipping.";
                $messages[] = $msg;
                unset($assetsToDelete[$assetid]);
                unset($fullPaths[$assetid]);
                continue;
            }
            $filedir = $fullPaths[$assetid];
            $path = SQ_DATA_PATH . '/file_repository' . $filedir;
            $file_list = list_files($path, TRUE);
            // see if the 'varieties' exists for this asset
            if (is_dir($path.'/varieties')) {
                $file_list = array_merge($file_list, list_files($path.'/varieties', TRUE));
            }
            $bad_files = Array();
            foreach ($file_list as $file) {
                $ok = unlink($file);
                if (!$ok) {
                    $bad_files[] = $file;
                }
            }
            if (empty($bad_files)) {
                if (is_dir($path.'/varieties')) {
                    rmdir($path.'/varieties');
                }
                rmdir($path);
                $assetsCleanedUp[] = $assetid;
            } else {
                $msg = "Unable to delete the following files:\n";
                $msg .= implode("\n\t\t", $bad_files);
                $messages[] = $msg;
                unset($assetsToDelete[$assetid]);
                unset($fullPaths[$assetid]);
                $status = FALSE;
            }
        }

        if (!empty($fullPaths)) {

            $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
            $db = MatrixDAL::getDb();
            $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

            $fileIds = Array();

            foreach (array_chunk($fullPaths, 999) as $chunk) {
                $query = "SELECT fileid FROM sq_file_vers_file WHERE path IN (";
                foreach ($chunk as $path) {
                    $query .= MatrixDAL::quote(ltrim($path, '/')) . ",";
                }
                $query = rtrim($query, ',') . ')';

                $fileInfo = MatrixDAL::executeSqlAll($query);

                foreach ($fileInfo as $row => $details) {
                    $fileIds[] = MatrixDAL::quote($details['fileid']);
                }
            }

            foreach (array_chunk($fileIds, 999) as $chunk) {
                $query = "DELETE FROM sq_file_vers_file WHERE fileid IN (" . implode(',', $chunk) . ")";
                $result = MatrixDAL::executeSql($query);
                $query = "DELETE FROM sq_file_vers_history WHERE fileid IN (" . implode(',', $chunk) . ")";
                $result = MatrixDAL::executeSql($query);
            }

            $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
        }

        $msg  = "The following assets were cleaned up successfully:\n";
        $msg .= "\t" . implode(',', $assetsCleanedUp);
        $messages[] = $msg;

        return $status;
    }

    public static function test(&$messages, &$errors)
    {
        $status = FALSE;
        if (SQ_CONF_ROLLBACK_ENABLED) {
            $messages[] = "Rollback is enabled, so will not check for orphaned file repository entries.\n\tThey may be required when viewing the system in rollback mode.";
            return $status;
        }

        $assetsToDelete = self::findAssetsToDelete();

        if (empty($assetsToDelete)) {
            $messages[] = 'There are no orphaned file repository entries.';
            $status = TRUE;
        } else {
            $messages[] = 'There are ' . sizeof($assetsToDelete) . ' orphaned file repository entries to clean up.';
            $errors[] = 'Will clean up these asset ids: ' . implode(',', $assetsToDelete);
        }

        return $status;

    }//end test()

}//end class
?>