95 lines
2.2 KiB
Python
95 lines
2.2 KiB
Python
|
"""
|
||
|
|
This module defines task stubs for the tasks implemented in the gvafile Celery
|
||
|
|
worker.
|
||
|
|
|
||
|
|
"""
|
||
|
|
from __future__ import absolute_import
|
||
|
|
|
||
|
|
from celery import shared_task
|
||
|
|
|
||
|
|
|
||
|
|
@shared_task
|
||
|
|
def setup_file_sftp_userdir(username):
|
||
|
|
"""
|
||
|
|
This task creates the home directory for an SFTP user if it does not exist
|
||
|
|
yet.
|
||
|
|
|
||
|
|
:param str username: the user name
|
||
|
|
:raises Exception: if the SFTP directory of the user cannot be created
|
||
|
|
:return: the created directory name
|
||
|
|
:rtype: str
|
||
|
|
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
@shared_task
|
||
|
|
def delete_file_sftp_userdir(username):
|
||
|
|
"""
|
||
|
|
This task recursively deletes the home directory of an SFTP user if it
|
||
|
|
does not exist yet.
|
||
|
|
|
||
|
|
:param str username: the user name
|
||
|
|
:raises Exception: if the SFTP directory of the user cannot be removed
|
||
|
|
:return: the removed directory name
|
||
|
|
:rtype: str
|
||
|
|
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
@shared_task
|
||
|
|
def setup_file_mail_userdir(username):
|
||
|
|
"""
|
||
|
|
This task creates the mail base directory for a user if it does not exist
|
||
|
|
yet.
|
||
|
|
|
||
|
|
:param str username: the user name
|
||
|
|
:raises Exception: if the mail base directory for the user cannot be
|
||
|
|
created
|
||
|
|
:return: the created directory name
|
||
|
|
:rtype: str
|
||
|
|
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
@shared_task
|
||
|
|
def delete_file_mail_userdir(username):
|
||
|
|
"""
|
||
|
|
This task recursively deletes the mail base directory for a user if it
|
||
|
|
does not exist yet.
|
||
|
|
|
||
|
|
:param str username: the user name
|
||
|
|
:raises Exception: if the mail base directory of the user cannot be removed
|
||
|
|
:return: the removed directory name
|
||
|
|
:rtype: str
|
||
|
|
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
@shared_task
|
||
|
|
def create_file_mailbox(username, mailboxname):
|
||
|
|
"""
|
||
|
|
This task creates a new mailbox directory for the given user and mailbox
|
||
|
|
name.
|
||
|
|
|
||
|
|
:param str username: the user name
|
||
|
|
:param str mailboxname: the mailbox name
|
||
|
|
:raises GVAFileException: if the mailbox directory cannot be created
|
||
|
|
:return: the created mailbox directory name
|
||
|
|
:rtype: str
|
||
|
|
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
@shared_task
|
||
|
|
def delete_file_mailbox(username, mailboxname):
|
||
|
|
"""
|
||
|
|
This task deletes the given mailbox of the given user.
|
||
|
|
|
||
|
|
:param str username: the user name
|
||
|
|
:param str mailboxname: the mailbox name
|
||
|
|
:raises GVAFileException: if the mailbox directory cannot be deleted
|
||
|
|
:return: the deleted mailbox directory name
|
||
|
|
:rtype: str
|
||
|
|
|
||
|
|
"""
|