SocPuppetUser.java

/*
 * The MIT License
 *
 * Copyright 2014 Jason Unger <entityreborn@gmail.com>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.entityreborn.socpuppet.users;

import com.entityreborn.socbot.SocBot;
import com.entityreborn.socbot.User;
import com.entityreborn.socbot.UserFactory;
import com.entityreborn.socpuppet.SocPuppet;
import com.entityreborn.socpuppet.users.UserException.IncorrectPassword;
import com.entityreborn.socpuppet.users.UserException.UnknownUser;
import com.entityreborn.socpuppet.util.Password;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * An IRC user that might interact with the bot.
 * @author Jason Unger <entityreborn@gmail.com>
 */
public class SocPuppetUser extends User {
    public static class Factory implements UserFactory {
        @Override
        public User createUser(String nick, SocBot owningBot) {
            return new SocPuppetUser(nick, owningBot);
        }
    }
    
    private String loginName = "";
    
    public SocPuppetUser(String userline, SocBot b) {
        super(userline, b);
    }
    
    /**
     * Attempt to login using the given name and password.
     * @param name
     * @param password
     * @return
     * @throws com.entityreborn.socpuppet.users.UserException.IncorrectPassword
     * @throws com.entityreborn.socpuppet.users.UserException.UnknownUser
     * @throws Exception 
     */
    public boolean attemptLogin(String name, String password) throws IncorrectPassword, UnknownUser, Exception {
        UserManager manager = UserManager.get((SocPuppet) getBot());
        RegisteredUser user = manager.getUser(name);
        
        if (Password.check(password, user.getPasswordHash())) {
            loginName = name;
            return true;
        } else {
            return false;
        }
    }
    
    public boolean attemptHostmaskLogin() {
        UserManager manager = UserManager.get((SocPuppet) getBot());
        RegisteredUser user;
        
        try {
            user = manager.getUser(getName());
        } catch (UnknownUser ex) {
            return false;
        }
        
        if (user.getAuthMasks().contains(getHostmask())) {
            loginName = user.getUsername();
            return true;
        } else {
            return false;
        }
    }
    
    /**
     * Return the registration instance for this user.
     * @return instance of RegisteredUser, or null if the user isn't logged in.
     */
    public RegisteredUser getRegistration() {
        if ("".equals(loginName)) {
            return null;
        }
        
        UserManager manager = UserManager.get((SocPuppet) getBot());
        RegisteredUser user;
        
        try {
            user = manager.getUser(loginName);
        } catch (UnknownUser ex) {
            Logger.getLogger(SocPuppetUser.class.getName()).log(Level.SEVERE, null, ex);
            return null;
        }
        
        return user;
    }
}