evennia/src/commands/privileged.py

"""
This file contains commands that require special permissions to use. These
are generally @-prefixed commands, but there are exceptions.
"""
from django.conf import settings
from src.objects.models import Object
from src import defines_global
from src import ansi
from src import session_mgr
from src.scripthandler import rebuild_cache
from src.util import functions_general
from src.cmdtable import GLOBAL_CMD_TABLE

def cmd_reload(command):
    """
    Reloads all modules.
    """
    if "all" in command.command_switches:
        reload_all = True
    else:
        reload_all = False
        
    # Set this to True if a switch match is found.
    switch_match_found = False
           
    if reload_all or "aliases" in command.command_switches or "alias" in command.command_switches:
        command.session.server.reload_aliases(source_object=command.source_object)
        command.source_object.emit_to("Aliases reloaded.")
        switch_match_found = True
    
    if reload_all or "scripts" in command.command_switches:
        rebuild_cache()
        command.source_object.emit_to("Script parents reloaded.")
        switch_match_found = True
        
    if reload_all or "commands" in command.command_switches:
        # By default, just reload command objects.
        command.source_object.emit_to("Reloading command modules...")
        command.session.server.reload(source_object=command.source_object)
        command.source_object.emit_to("Modules reloaded.")
        switch_match_found = True
        
    if not switch_match_found:
        command.source_object.emit_to("@reload must be accompanied by one or more of the following switches: aliases, scripts, commands, all")
GLOBAL_CMD_TABLE.add_command("@reload", cmd_reload,
                             priv_tuple=("genperms.process_control")),
GLOBAL_CMD_TABLE.add_command("@restart", cmd_reload,
                             priv_tuple=("genperms.process_control")),

def cmd_boot(command):
    """
    Boot a player object from the server.
    """
    source_object = command.source_object
    switch_quiet = False
    switch_port = False

    if "quiet" in command.command_switches:
        # Don't tell the player they've been disconnected, silently boot them.
        switch_quiet = True

    if "port" in command.command_switches:
        # Boot by port number instead of name or dbref.
        switch_port = True

    if not command.command_argument:
        source_object.emit_to("Who would you like to boot?")
        return
    else:
        boot_list = []
        if switch_port:
            # Boot a particular port.
            sessions = session_mgr.get_session_list(True)
            for sess in sessions:
                # Find the session with the matching port number.
                if sess.getClientAddress()[1] == int(command.command_argument):
                    boot_list.append(sess)
                    # Match found, kill the loop and continue with booting.
                    break
        else:
            # Grab the objects that match
            objs = Object.objects.local_and_global_search(source_object, 
                                                    command.command_argument)
            
            if not objs:
                source_object.emit_to("No name or dbref match found for booting.")
                return

            if not objs[0].is_player():
                source_object.emit_to("You can only boot players.")
                return

            if not source_object.controls_other(objs[0]):
                if objs[0].is_superuser():
                    source_object.emit_to("You cannot boot a Wizard.")
                    return
                else:
                    source_object.emit_to("You do not have permission to boot that player.")
                    return

            if objs[0].is_connected_plr():
                matches = session_mgr.sessions_from_object(objs[0])
                for match in matches:
                    boot_list.append(match)
            else:
                source_object.emit_to("That player is not connected.")
                return

        if not boot_list:
            source_object.emit_to("No matches found.")
            return
        
        # Carry out the booting of the sessions in the boot list.
        for boot in boot_list:
            if not switch_quiet:
                boot.msg("You have been disconnected by %s." % (source_object.name))
            boot.disconnectClient()
            session_mgr.remove_session(boot)
            return
GLOBAL_CMD_TABLE.add_command("@boot", cmd_boot,        
                             priv_tuple=("genperms.manage_players"))

def cmd_newpassword(command):
    """
    Set a player's password.
    """
    source_object = command.source_object
    eq_args = command.command_argument.split('=', 1)
    searchstring = eq_args[0]
    newpass = eq_args[1]
    
    if not command.command_argument or len(searchstring) == 0:    
        source_object.emit_to("What player's password do you want to change")
        return
    if len(newpass) == 0:
        source_object.emit_to("You must supply a new password.")
        return

    target_obj = source_object.search_for_object(searchstring)
    # Use search_for_object to handle duplicate/nonexistant results.
    if not target_obj:
        return

    if not target_obj.is_player():
        source_object.emit_to("You can only change passwords on players.")
    elif not source_object.controls_other(target_obj):
        source_object.emit_to("You do not control %s." % (target_obj.get_name(),))
    else:
        uaccount = target_obj.get_user_account()
        if len(newpass) == 0:
            uaccount.set_password()
        else:
            uaccount.set_password(newpass)
        uaccount.save()
        source_object.emit_to("%s - PASSWORD set." % (target_obj.get_name(),))
        target_obj.emit_to("%s has changed your password." % 
                           (source_object.get_name(show_dbref=False),))
GLOBAL_CMD_TABLE.add_command("@newpassword", cmd_newpassword, 
                             priv_tuple=("genperms.manage_players"))

def cmd_home(command):
    """
    Teleport the player to their home.
    """
    pobject = command.source_object
    if pobject.home == None:
        pobject.emit_to("You have no home set, @link yourself to somewhere.")
    else:
        pobject.emit_to("There's no place like home...")
        pobject.move_to(pobject.get_home())
GLOBAL_CMD_TABLE.add_command("home", cmd_home,
                             priv_tuple=("genperms.tel_anywhere"))

def cmd_service(command):
    """
    Service management system. Allows for the listing, starting, and stopping
    of services.
    """
    pobject = command.source_object
    if "list" in command.command_switches:
        """
        Just display the list of installed services and their status and die.
        """
        pobject.emit_to('-' * 40)
        pobject.emit_to('Service Listing')
        for service in command.session.server.service_collection.services:
            # running is either 1 or 0, 1 meaning the service is running.
            if service.running == 1:
                status = 'Running'
            else:
                status = 'Inactive'
            pobject.emit_to(' * %s (%s)' % (service.name, status))
        pobject.emit_to('-' * 40)
        return
    
    # This stuff is common to both start and stop switches.
    if "stop" in command.command_switches or "start" in command.command_switches:
        collection = command.session.server.service_collection
        try:
            service = collection.getServiceNamed(command.command_argument)
        except:
            pobject.emit_to('Invalid service name. This command is case-sensitive. See @service/list.')
            return
        
    if "stop" in command.command_switches:
        """
        Stopping a service gracefully closes it and disconnects any connections
        (if applicable).
        """
        if service.running == 0:
            pobject.emit_to('That service is not currently running.')
            return
        # We don't want them killing main Evennia TCPServer services here. If
        # they'd like to nix a listening port, they need to do it through
        # settings.py and a restart.
        if service.name[:7] == 'Evennia':
            pobject.emit_to('You can not Evennia TCPServer services this way.')
            return
        pobject.emit_to('Stopping the %s service.' % service.name)
        service.stopService()
        return
    
    if "start" in command.command_switches:
        """
        Starts a service.
        """
        if service.running == 1:
            pobject.emit_to('That service is already running.')
            return
        pobject.emit_to('Starting the %s service.' % service.name)
        service.startService()
        return
    
    # If they don't provide any switches, let them know to do so.
    pobject.emit_to("You must specify a switch with @service. May be one of: list, start, stop")
GLOBAL_CMD_TABLE.add_command("@service", cmd_service,
                             priv_tuple=("genperms.process_control"))

def cmd_shutdown(command):
    """
    Shut the server down gracefully.
    """    
    command.source_object.emit_to('Shutting down...')
    print 'Server shutdown by %s' % (command.source_object.get_name(show_dbref=False),)
    command.session.server.shutdown()
GLOBAL_CMD_TABLE.add_command("@shutdown", cmd_shutdown,
                             priv_tuple=("genperms.process_control"))