require 'common/davical_plugin'
require 'rm/rm_plugin'
+# Handle the removal of DAViCal users from its database. DAViCal has
+# no concept of domains.
+#
class DavicalRm
- #
- # DAViCal only supports Postgres, so even if we ever are
- # database-agnostic, this plugin can't be.
- #
+
include DavicalPlugin
include RmPlugin
- def delete_user(user)
- # Delete the given username. DAViCal uses foreign keys properly
- # and only supports postgres, so we let the ON DELETE CASCADE
- # trigger handle most of the work.
+ # Remove *user* from the DAViCal database. This should remove him
+ # from _every_ table in which he is referenced. Fortunately, DAViCal
+ # uses foreign keys properly (and only supports postgres, where they
+ # work!), so we can let the ON DELETE CASCADE trigger handle most of
+ # the work.
+ #
+ # @param user [User] the user to remove.
+ #
+ def remove_user(user)
raise NonexistentUserError.new(user.to_s()) if not user_exists(user)
sql_queries = ['DELETE FROM usr WHERE username = $1']