srv-users.h

Go to the documentation of this file.

/*
 * srv-users.h
 *
 * Copyright (C) 2008,2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Server-side user management. 
 */

#ifndef AESOP_SRV_USERS_H__
#define AESOP_SRV_USERS_H__

// includes --------------------------------------------------------------------
#include "aesop-proto/protocol.h"


// forward declarations
class Datahash;


namespace aesop {
















































































class UserManager {
public:
        // virtual destructor --------------------------------------------------
        virtual ~UserManager(void) throw();

        // aesop::UserManager class interface methods -------------------------
        virtual bool canCreateNewUsersTS(void) const throw() = 0;
        virtual bool passwordRequiredTS(void) const throw() = 0;
        virtual void getUsernamesTS(OUT SetString& names) = 0;
        virtual bool logInAsUserTS(IN const char * username,
                                IN const char * password,
                                OUT std::string& playerGuid,
                                OUT std::string& diagnostic) = 0;
        virtual bool createUserTS(IN const char * username,
                                OUT std::string& diagnostic) = 0;
        virtual bool isAdminTS(IN const char * username) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<UserManager> create(IN const Datahash * params);
};


bool isValidUsername(IN const char * username);


std::string getUsernameRestrictions(void);


};      // aesop namespace

#endif  // AESOP_SRV_USERS_H__