diff options
| -rw-r--r-- | CHANGELOG | 1 | ||||
| -rwxr-xr-x | bin/deluser.sh | 97 |
2 files changed, 98 insertions, 0 deletions
@@ -1,6 +1,7 @@ CHANGELOG Roundcube Webmail =========================== +- Utility script to remove user records from the local database - Plugin API: Added message_saved hook (#1489752) - Support messages import from zip archives - Zipdownload: Added mbox format support (#1486069) diff --git a/bin/deluser.sh b/bin/deluser.sh new file mode 100755 index 000000000..84c8446ec --- /dev/null +++ b/bin/deluser.sh @@ -0,0 +1,97 @@ +#!/usr/bin/env php +<?php + +/* + +-----------------------------------------------------------------------+ + | bin/deluser.sh | + | | + | This file is part of the Roundcube Webmail client | + | Copyright (C) 2014, The Roundcube Dev Team | + | | + | Licensed under the GNU General Public License version 3 or | + | any later version with exceptions for skins & plugins. | + | See the README file for a full license statement. | + | | + | PURPOSE: | + | Utility script to remove all data related to a certain user | + | from the local database. | + +-----------------------------------------------------------------------+ + | Author: Thomas Bruederli <thomas@roundcube.net> | + +-----------------------------------------------------------------------+ +*/ + +define('INSTALL_PATH', realpath(dirname(__FILE__) . '/..') . '/' ); + +require_once INSTALL_PATH . 'program/include/clisetup.php'; + +function print_usage() +{ + print "Usage: deluser.sh [--host=mail_host] username\n"; + print "--host=HOST The IMAP hostname or IP the given user is related to\n"; +} + +function _die($msg, $usage=false) +{ + fputs(STDERR, $msg . "\n"); + if ($usage) print_usage(); + exit(1); +} + +$rcmail = rcmail::get_instance(); + +// get arguments +$args = rcube_utils::get_opt(array('h' => 'host')); +$username = trim($args[0]); + +if (empty($username)) { + _die("Missing required parameters", true); +} + +if (empty($args['host'])) { + $hosts = $rcmail->config->get('default_host', ''); + if (is_string($hosts)) { + $args['host'] = $hosts; + } + else if (is_array($hosts) && count($hosts) == 1) { + $args['host'] = reset($hosts); + } + else { + _die("Specify a host name", true); + } +} + +// connect to DB +$db = $rcmail->get_dbh(); +$db->db_connect('w'); + +if (!$db->is_connected() || $db->is_error()) { + _die("No DB connection\n" . $db->is_error()); +} + +// find user in loca database +$user = rcube_user::query($username, $args['host']); + +if (!$user) { + die("User not found.\n"); +} + +// let plugins cleanup their own user-related data +$plugin = $rcmail->plugins->exec_hook('user_delete', array('user' => $user, 'username' => $username, 'host' => $args['host'])); + +if ($plugin['abort']) { + _die("User deletion aborted by plugin"); +} + +// deleting the user record should be sufficient due to ON DELETE CASCADE foreign key references +// but not all database backends actually support this so let's do it by hand +foreach (array('identities','contacts','contactgroups','dictionaries','cache','cache_index','cache_messages','cache_thread','searches','users') as $table) { + $db->query('DELETE FROM ' . $db->table_name($table) . ' WHERE user_id=?', $user->ID); +} + +if ($db->is_error()) { + _die("DB error occurred: " . $db->is_error()); +} +else { + echo "Successfully deleted user $user->ID\n"; +} + |