Delete Plugin Tables Function Help

[aljawaid]

@alfredbuehler @creecros could you please help?

All the frontend is done, a button will be created to delete all the plugin tables for the plugin pulled from the JSON.

Controller:

ContentCleaner/Controller/PluginCleaningController.php

Lines 48 to 74 in ea9d7e2

	public function deletePluginTables()
	{
	// DELETE PLUGIN TABLES
	$this->checkCSRFParam();
	// PULL VARIABLE FROM BUTTON
	$plugin_job_name = $this->request->getStringParam('plugin_job_name');
	// MATCH VARIABLE TO JSON CONTENT
	foreach ($this->helper->pluginCleaningHelper->getDeletablePlugins() as $plugin) {
	if ($plugin['plugin_title'] == $plugin_job_name) {
	if (isset($plugin['plugin_tables'])) {
	return $table;
	}
	}
	}
	// DELETE PLUGIN TABLES
	if ($this->applicationCleaningModel->delete($table)) {
	$this->flash->success(t('DEEP CLEANING COMPLETE: Plugin tables were deleted successfully'));
	} else {
	$this->flash->failure(t('DEEP CLEANING FAILED: Plugin tables could not be deleted'));
	}
	$this->response->redirect($this->helper->url->to('ContentCleanerController', 'show', array('plugin' => 'ContentCleaner')));
	}

Model is here:

ContentCleaner/Model/ApplicationCleaningModel.php

Lines 254 to 271 in ea9d7e2

	public function delete($table)
	{
	// DELETE TABLE
	switch (DB_DRIVER) {
	case 'sqlite':
	return $this->db->execute('DROP TABLE IF EXISTS `' . $table . '`; SHOW WARNINGS');
	break;
	case 'mysql':
	return $this->db->execute('DROP TABLE IF EXISTS `' . $table . '`; SHOW WARNINGS');
	break;
	case 'postgres':
	return $this->db->execute('DROP TABLE IF EXISTS ' . $table . ' CASCADE;');
	break;
	default:
	return $this->db->execute('DROP TABLE IF EXISTS `' . $table . '`; SHOW WARNINGS');
	}
	}

Button:

ContentCleaner/Template/config/modals/plugin_deep_clean.php

Line 68 in ea9d7e2

<?= $this->modal->confirmButtons('PluginCleaningController', 'deletePluginTables', array('plugin_job_name' => $plugin_job_name, 'plugin' => 'ContentCleaner'), t('Deep Clean')) ?>

Would this work?

[alfredbuehler]

Regarding the Model: Think about adding a dry-run mode, that just logs the SQL statements to execute. I'm not very familiar with all SQL dialects.

[alfredbuehler]

There's something wrong: After installing Wiki:

These tables cannot be associated to Wiki, but they should.
As a consequence, these tables can be deleted, even if Wiki is installed!!!

[aljawaid]

Yes, once the plugin is uninstalled, the tables are not recognised. According to @creecros there is no way to link them, so I put the notice for users here:

Jobs in this section affect leftover tables which were created by plugins. Once a plugin is uninstalled, all leftover tables for the uninstalled plugin are marked as unknown. Deleting plugin related database tables before uninstalling the plugin will prompt the plugin to recreate the tables, not uninstall the plugin.

[creecros]

If wiki is installed they should not show as "unknown". If thats the case, something is wrong.

[aljawaid]

If wiki is installed they should not show as "unknown". If thats the case, something is wrong.

oh hello :)
I understood Alfred's comment as he had uninstalled Wiki... maybe I was mistaken.

Anyhow, none of them features have been changed and it looks okay on my side... the only thing which is messed up/work in progress is the plugin cleaning controller and functions.

[creecros]

Ya, I've been kind of busy, but one day I'll have time again, once I settle in.

[alfredbuehler]

After analyzing things, my suggestion for the delete function looks like this:

public function deletePluginTables()
{
    $this->checkCSRFParam();

    // Pull variable from button
    $plugin_job_name = $this->request->getStringParam('plugin_job_name');
    $plugin_tables = [];

    // Match variable to json content
    foreach ($this->helper->pluginCleaningHelper->getDeletablePlugins() as $plugin) {
        if ($plugin['plugin_title'] === $plugin_job_name && isset($plugin['plugin_tables'])) {
            $plugin_tables = $plugin['plugin_tables'];
            break;
        }
    }

    // Delete the tables
    $success = true;
    foreach ($plugin_tables as $table) {
        if (!$this->applicationCleaningModel->delete($table)) {
            $success = false;
            break;
        }
    }

    if ($success) {
        $this->flash->success(t('DEEP CLEANING COMPLETE: Plugin tables were deleted successfully'));
    } else {
        $this->flash->failure(t('DEEP CLEANING FAILED: Plugin tables could not be deleted'));
    }

    $this->response->redirect($this->helper->url->to('ContentCleanerController', 'show', array('plugin' => 'ContentCleaner')));
}

Unfortunately, I cannot do more. Sorry.

[aljawaid]

that's great! so to understand it...

The button will provide the plugin name, match that to the foreach to get the plugin tables for that particular plugin. Then for each plugin table found, use the applicationCleaningModel to delete each table

[aljawaid]

Commit 76545b0

[aljawaid]

@alfredbuehler This codeblock provides a success message even when the relevant plugin tables do not exist.

I tried to change it like this, but now all I get is a false message. Any insight?

/**
     * Delete Plugin Tables
     *
     * @param   $plugin_job_name                string
     * @param   $plugin_tables                  array
     * @author  alfredbuehler Alfred Bühler
     */
    public function deletePluginTables()
    {
        $this->checkCSRFParam();

        // Pull the variable from the button
        $plugin_job_name = $this->request->getStringParam('plugin_job_name');
        $plugin_tables = [];

        // Match the variable to the JSON content if the plugin name matches
        foreach ($this->helper->pluginCleaningHelper->getDeletablePlugins() as $plugin) {
            if ($plugin['plugin_title'] === $plugin_job_name && isset($plugin['plugin_tables'])) {
                $plugin_tables = $plugin['plugin_tables'];
                break;
            }
        }

        $existing_tables = $this->applicationCleaningModel->getTables();

        // Delete the plugin tables
        $success = true;
        foreach ($plugin_tables as $table) {
            if (!in_array($table, $existing_tables)) {
                $success = false;
                break;
            } elseif (!$this->applicationCleaningModel->delete($table)) {
                $success = false;
                break;
            } elseif ($this->applicationCleaningModel->delete($table)) {
                $success = true;
            }
        }

        if ($success) {
            $this->flash->success(t('DEEP CLEANING COMPLETE: Plugin tables were deleted successfully for ' . $plugin_job_name . ''));
        } else {
            $this->flash->failure(t('DEEP CLEANING FAILED: Plugin tables could not be deleted for ' . $plugin_job_name . ''));
        }

        $this->response->redirect($this->helper->url->to('ContentCleanerController', 'show', array('plugin' => 'ContentCleaner')));
    }

[aljawaid]

#14

[aljawaid]

Fixed through helper ff56637

Button is now disabled if no tables are found