sync/lib/user.js

var Logger = require("./logger");
var Server = require("./server");
var util = require("./utilities");
var MakeEmitter = require("./emitter");
var db = require("./database");
var InfoGetter = require("./get-info");
var Config = require("./config");
var ACP = require("./acp");

function User(socket) {
    var self = this;
    MakeEmitter(self);
    self.socket = socket;
    self.ip = socket._ip;
    self.loggedIn = false;
    self.loggingIn = false;
    self.rank = -1;
    self.global_rank = -1;
    self.hasChannelRank = false;
    self.channel = null;
    self.name = "";
    self.canonicalName = "";
    self.profile = {
        image: "",
        text: ""
    };
    self.meta = {
        afk: false,
        muted: false,
        smuted: false,
        aliases: []
    };
    self.queueLimiter = util.newRateLimiter();
    self.chatLimiter = util.newRateLimiter();
    self.awaytimer = false;

    self.socket.once("initChannelCallbacks", function () {
        self.initChannelCallbacks();
    });

    self.socket.once("initUserPLCallbacks", function () {
        self.initUserPLCallbacks();
    });

    self.socket.once("initACP", function () {
        self.whenLoggedIn(function () {
            if (self.global_rank >= 255) {
                ACP.init(self);
            } else {
                self.kick("Attempted initACP from non privileged user.  This incident " +
                          "will be reported.");
                Logger.eventlog.log("[acp] Attempted initACP from socket client " +
                                    self.name + "@" + self.ip);
            }
        });
    });

    self.socket.on("login", function (data) {
        data = (typeof data === "object") ? data : {};

        var name = data.name;
        if (typeof name !== "string") {
            return;
        }

        var pw = data.pw || "";
        if (typeof pw !== "string") {
            pw = "";
        }

        if (!pw && !self.loggingIn && !self.loggedIn) {
            self.guestLogin(name);
        } else if (pw && !self.loggingIn && !self.loggedIn) {
            self.login(name, pw);
        }
    });

    var announcement = Server.getServer().announcement;
    if (announcement != null) {
        self.socket.emit("announcement", announcement);
    }

    self.on("login", function () {
        db.recordVisit(self.ip, self.name);
        db.users.getProfile(self.name, function (err, profile) {
            if (!err) {
                self.profile = profile;
                if (self.inChannel()) {
                    self.channel.sendUserProfile(self.channel.users, self);
                }
            }
        });

        if (self.global_rank >= 255) {
            self.initAdminCallbacks();
        }
    });
}

/**
 * Checks whether the user is in a valid channel
 */
User.prototype.inChannel = function () {
    return this.channel != null && !this.channel.dead;
};

/**
 * Changes a user's AFK status, updating the channel voteskip if necessary
 */
User.prototype.setAFK = function (afk) {
    if (!this.inChannel()) {
        return;
    }

    if (this.meta.afk === afk) {
        return;
    }

    this.meta.afk = afk;

    var chan = this.channel;
    if (afk) {
        if (chan.voteskip) {
            chan.voteskip.unvote(this.ip);
        }
    } else {
        this.autoAFK();
    }

    chan.checkVoteskipPass();
    chan.sendAll("setAFK", {
        name: this.name,
        afk: afk
    });
};

/**
 * Sets a timer to automatically mark the user as AFK after
 * a period of inactivity
 */
User.prototype.autoAFK = function () {
    var self = this;
    if (self.awaytimer) {
        clearTimeout(self.awaytimer);
    }

    if (!self.inChannel()) {
        return;
    }

    var timeout = parseFloat(self.channel.opts.afk_timeout);
    if (isNaN(timeout) || timeout <= 0) {
        return;
    }

    self.awaytimer = setTimeout(function () {
        self.setAFK(true);
    }, timeout * 1000);
};

/**
 * Sends a kick message and disconnects the user
 */
User.prototype.kick = function (reason) {
    this.socket.emit("kick", { reason: reason });
    this.socket.disconnect(true);
};

/**
 * Initializes socket message callbacks for a channel user
 */
User.prototype.initChannelCallbacks = function () {
    var self = this;

    // Verifies datatype before calling a function
    // Passes a default value if the typecheck fails
    var typecheck = function (type, def, fn) {
        return function (data) {
            if (typeof data !== type) {
                fn(def);
            } else {
                fn(data);
            }
        };
    };

    // Verify that the user is in a channel, and that the passed data is an Object
    var wrapTypecheck = function (msg, fn) {
        self.socket.on(msg, typecheck("object", {}, function (data) {
            if (self.inChannel()) {
                fn(data);
            }
        }));
    };

    // Verify that the user is in a channel, but don't typecheck the data
    var wrap = function (msg, fn) {
        self.socket.on(msg, function (data) {
            if (self.inChannel()) {
                fn(data);
            }
        });
    };

    self.socket.on("disconnect", function () {
        if (self.awaytimer) {
            clearTimeout(self.awaytimer);
        }

        if (self.inChannel()) {
            self.channel.part(self);
        }
    });

    self.socket.once("joinChannel", typecheck("object", {}, function (data) {
        if (self.inChannel()) {
            return;
        }

        if (typeof data.name !== "string") {
            return;
        }

        if (!util.isValidChannelName(data.name)) {
            self.socket.emit("errorMsg", {
                msg: "Invalid channel name.  Channel names may consist of 1-30 " +
                     "characters in the set a-z, A-Z, 0-9, -, and _"
            });
            self.kick("Invalid channel name");
            return;
        }

        data.name = data.name.toLowerCase();
        var chan = Server.getServer().getChannel(data.name);
        chan.preJoin(self, data.pw);
    }));

    wrapTypecheck("assignLeader", function (data) {
        self.channel.handleChangeLeader(self, data);
    });

    wrapTypecheck("setChannelRank", function (data) {
        self.channel.handleSetRank(self, data);
    });

    wrapTypecheck("unban", function (data) {
        self.channel.handleUnban(self, data);
    });

    wrapTypecheck("chatMsg", function (data) {
        if (typeof data.msg !== "string") {
            return;
        }

        if (data.msg.indexOf("/afk") !== 0) {
            self.setAFK(false);
            self.autoAFK();
        }

        self.channel.handleChat(self, data);
    });
    
    wrapTypecheck("pm", function (data) {
        if (typeof data.msg !== "string" || typeof data.to !== "string") {
            return;
        }

        self.channel.handlePm(self, data);
    });

    wrapTypecheck("newPoll", function (data) {
        self.channel.handleOpenPoll(self, data);
    });

    wrapTypecheck("vote", function (data) {
        self.channel.handlePollVote(self, data);
    });

    wrap("closePoll", function () {
        self.channel.handleClosePoll(self);
    });

    wrap("playerReady", function () {
        self.channel.sendMediaUpdate([self]);
    });

    wrap("requestPlaylist", function () {
        self.channel.sendPlaylist([self]);
    });

    wrapTypecheck("queue", function (data) {
        self.channel.handleQueue(self, data);
    });

    wrapTypecheck("queuePlaylist", function (data) {
        self.channel.handleQueuePlaylist(self, data);
    });

    wrapTypecheck("setTemp", function (data) {
        self.channel.handleSetTemp(self, data);
    });

    wrapTypecheck("moveMedia", function (data) {
        self.channel.handleMove(self, data);
    });

    wrap("delete", function (data) {
        self.channel.handleDelete(self, data);
    });

    wrapTypecheck("uncache", function (data) {
        self.channel.handleUncache(self, data);
    });

    wrap("jumpTo", function (data) {
        self.channel.handleJumpTo(self, data);
    });

    wrap("playNext", function () {
        self.channel.handlePlayNext(self);
    });

    wrap("clearPlaylist", function () {
        self.channel.handleClear(self);
    });

    wrap("shufflePlaylist", function () {
        self.channel.handleShuffle(self);
    });

    wrap("togglePlaylistLock", function () {
        self.channel.handleToggleLock(self);
    });

    wrapTypecheck("mediaUpdate", function (data) {
        self.channel.handleUpdate(self, data);
    });

    wrapTypecheck("searchMedia", function (data) {
        if (typeof data.query !== "string") {
            return;
        }
        data.query = data.query.substring(0, 255);

        var searchYT = function () {
            InfoGetter.Getters.ytSearch(data.query.split(" "), function (e, vids) {
                if (!e) {
                    self.socket.emit("searchResults", {
                        source: "yt",
                        results: vids
                    });
                }
            });
        };

        if (data.source === "yt") {
            searchYT();
        } else {
            self.channel.search(data.query, function (vids) {
                if (vids.length === 0) {
                    searchYT();
                } else {
                    self.socket.emit("searchResults", {
                        source: "library",
                        results: vids
                    });
                }
            });
        }

    });

    wrapTypecheck("setOptions", function (data) {
        self.channel.handleUpdateOptions(self, data);
    });

    wrapTypecheck("setPermissions", function (data) {
        self.channel.handleSetPermissions(self, data);
    });

    wrapTypecheck("setChannelCSS", function (data) {
        self.channel.handleSetCSS(self, data);
    });

    wrapTypecheck("setChannelJS", function (data) {
        self.channel.handleSetJS(self, data);
    });

    wrapTypecheck("setMotd", function (data) {
        self.channel.handleSetMotd(self, data);
    });

    wrapTypecheck("updateFilter", function (data) {
        self.channel.handleUpdateFilter(self, data);
    });

    wrap("importFilters", function (data) {
        self.channel.handleImportFilters(self, data);
    });

    // REMOVE FILTER
    // https://www.youtube.com/watch?v=SxUU3zncVmI
    wrapTypecheck("removeFilter", function (data) {
        self.channel.handleRemoveFilter(self, data);
    });

    wrapTypecheck("moveFilter", function (data) {
        self.channel.handleMoveFilter(self, data);
    });

    wrapTypecheck("updateEmote", function (data) {
        self.channel.handleUpdateEmote(self, data);
    });

    wrap("importEmotes", function (data) {
        self.channel.handleImportEmotes(self, data);
    });

    wrapTypecheck("removeEmote", function (data) {
        self.channel.handleRemoveEmote(self, data);
    });

    wrap("requestBanlist", function () {
        self.channel.sendBanlist([self]);
    });

    wrap("requestChannelRanks", function () {
        self.channel.sendChannelRanks([self]);
    });

    wrap("requestChatFilters", function () {
        self.channel.sendChatFilters([self]);
    });

    wrap("voteskip", function () {
        self.channel.handleVoteskip(self);
    });

    wrap("readChanLog", function () {
        self.channel.handleReadLog(self);
    });
};

User.prototype.initAdminCallbacks = function () {
    var self = this;
    self.socket.on("borrow-rank", function (rank) {
        if (self.inChannel()) {
            if (typeof rank !== "number") {
                return;
            }

            if (rank > self.global_rank) {
                return;
            }

            if (rank === 255 && self.global_rank > 255) {
                rank = self.global_rank;
            }

            self.rank = rank;
            self.socket.emit("rank", rank);
            self.channel.sendAll("setUserRank", {
                name: self.name,
                rank: rank
            });
        }
    });
};

User.prototype.whenLoggedIn = function (fn) {
    if (this.loggedIn) {
        fn();
    } else {
        this.once("login", fn);
    }
};

User.prototype.whenChannelRank = function (fn) {
    if (this.hasChannelRank) {
        fn();
    } else {
        this.once("channelRank", fn);
    }
};

User.prototype.login = function (name, pw) {
    var self = this;
    self.loggingIn = true;

    db.users.verifyLogin(name, pw, function (err, user) {
        self.loggingIn = false;
        if (err) {
            if (err === "Invalid username/password combination") {
                Logger.eventlog.log("[loginfail] Login failed (bad password): " + name
                                  + "@" + self.ip);
            }

            self.socket.emit("login", {
                success: false,
                error: err
            });
            return;
        }

        self.rank = self.global_rank = user.global_rank;
        self.name = user.name;
        self.loggedIn = true;
        self.socket.emit("login", {
            success: true,
            name: user.name
        });
        self.socket.emit("rank", self.rank);
        Logger.syslog.log(self.ip + " logged in as " + name);
        if (self.inChannel()) {
            self.channel.logger.log(self.ip + " logged in as " + name);
        }
        self.emit("login");
    });
};

var lastguestlogin = {};
User.prototype.guestLogin = function (name) {
    var self = this;

    if (self.ip in lastguestlogin) {
        var diff = (Date.now() - lastguestlogin[self.ip]) / 1000;
        if (diff < Config.get("guest-login-delay")) {
            self.socket.emit("login", {
                success: false,
                error: "Guest logins are restricted to one per IP address per " +
                       Config.get("guest-login-delay") + " seconds."
            });
            return;
        }
    }

    if (!util.isValidUserName(name)) {
        self.socket.emit("login", {
            success: false,
            error: "Invalid username.  Usernames must be 1-20 characters long and " +
                   "consist only of characters a-z, A-Z, 0-9, -, _, and accented " +
                   "letters."
        });
        return;
    }

    // Prevent duplicate logins
    self.loggingIn = true;
    db.users.isUsernameTaken(name, function (err, taken) {
        self.loggingIn = false;
        if (err) {
            self.socket.emit("login", {
                success: false,
                error: err
            });
            return;
        }

        if (taken) {
            self.socket.emit("login", {
                success: false,
                error: "That username is registered."
            });
            return;
        }

        if (self.inChannel()) {
            var nameLower = name.toLowerCase();
            for (var i = 0; i < self.channel.users.length; i++) {
                if (self.channel.users[i].name.toLowerCase() === nameLower) {
                    self.socket.emit("login", {
                        success: false,
                        error: "That name is already in use on this channel."
                    });
                    return;
                }
            }
        }

        // Login succeeded
        lastguestlogin[self.ip] = Date.now();
        self.rank = 0;
        self.global_rank = 0;
        self.socket.emit("rank", 0);
        self.name = name;
        self.loggedIn = true;
        self.socket.emit("login", {
            success: true,
            name: name,
            guest: true
        });

        // TODO you shouldn't be able to guest login without being in a channel
        Logger.syslog.log(self.ip + " signed in as " + name);
        if (self.inChannel()) {
            self.channel.logger.log(self.ip + " signed in as " + name);
        }

        self.emit("login");
    });
};

/* Clean out old login throttlers to save memory */
setInterval(function () {
    var delay = Config.get("guest-login-delay");
    for (var ip in lastguestlogin) {
        var diff = (Date.now() - lastguestlogin[ip]) / 1000;
        if (diff > delay) {
            delete lastguestlogin[ip];
        }
    }

    if (Config.get("aggressive-gc") && global && global.gc) {
        global.gc();
    }
}, 5 * 60 * 1000);

User.prototype.initUserPLCallbacks = function () {
    require("./userplaylists").init(this);
};

module.exports = User;