sync/user.js

/*
The MIT License (MIT)
Copyright (c) 2013 Calvin Montgomery

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.
*/

var Rank = require("./rank.js");
var Channel = require("./channel.js").Channel;
var formatTime = require("./media.js").formatTime;
var Logger = require("./logger.js");

// Represents a client connected via socket.io
var User = function(socket, Server) {
    this.ip = socket._ip;
    this.server = Server;
    this.socket = socket;
    this.loggedIn = false;
    this.rank = Rank.Anonymous;
    this.global_rank = Rank.Anonymous;
    this.channel = null;
    this.name = "";
    this.meta = {
        afk: false,
        icon: false
    };
    this.muted = false;
    this.throttle = {};
    this.flooded = {};
    this.profile = {
        image: "",
        text: ""
    };
    this.awaytimer = false;
    this.autoAFK();

    this.initCallbacks();
    if(Server.announcement != null) {
        this.socket.emit("announcement", Server.announcement);
    }
};

// Throttling/cooldown
User.prototype.noflood = function(name, hz) {
    var time = new Date().getTime();
    if(!(name in this.throttle)) {
        this.throttle[name] = [time];
        return false;
    }
    else if(name in this.flooded && time < this.flooded[name]) {
        this.socket.emit("noflood", {
            action: name,
            msg: "You're still on cooldown!"
        });
        return true;
    }
    else {
        this.throttle[name].push(time);
        var diff = (time - this.throttle[name][0]) / 1000.0;
        // Twice might be an accident, more than that is probably spam
        if(this.throttle[name].length > 2) {
            var rate = this.throttle[name].length / diff;
            this.throttle[name] = [time];
            if(rate > hz) {
                this.flooded[name] = time + 5000;
                this.socket.emit("noflood", {
                    action: name,
                    msg: "Stop doing that so fast!  Cooldown: 5s"
                });
                return true;
            }
            return false;
        }
    }
}

User.prototype.setAFK = function (afk) {
    if(this.channel === null)
        return;
    if(this.meta.afk === afk)
        return;
    var chan = this.channel;
    this.meta.afk = afk;
    if(afk) {
        if(chan.afkers.indexOf(this.name.toLowerCase()) == -1)
            chan.afkers.push(this.name.toLowerCase());
        if(chan.voteskip)
            chan.voteskip.unvote(this.ip);
    }
    else {
        if(chan.afkers.indexOf(this.name.toLowerCase()) != -1)
            chan.afkers.splice(chan.afkers.indexOf(this.name.toLowerCase()), 1);
        this.autoAFK();
    }
    chan.checkVoteskipPass();
    chan.sendAll("setAFK", {
        name: this.name,
        afk: afk
    });
}

User.prototype.autoAFK = function () {
    if(this.awaytimer)
        clearTimeout(this.awaytimer);

    if(this.channel === null || this.channel.opts.afk_timeout == 0)
        return;

    this.awaytimer = setTimeout(function () {
        this.setAFK(true);
    }.bind(this), this.channel.opts.afk_timeout * 1000);
}

User.prototype.initCallbacks = function() {
    this.socket.on("disconnect", function() {
        this.awaytimer && clearTimeout(this.awaytimer);
        if(this.channel != null)
            this.channel.userLeave(this);
    }.bind(this));

    this.socket.on("joinChannel", function(data) {
        if(this.channel != null)
            return;
        if(typeof data.name != "string")
            return;
        if(!data.name.match(/^[\w-_]{1,30}$/)) {
            this.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 _"
            });
            this.socket.emit("kick", {
                reason: "Bad channel name"
            });

            return;
        }
        data.name = data.name.toLowerCase();
        this.channel = this.server.getChannel(data.name);
        if(this.loggedIn) {
            var chanrank = this.channel.getRank(this.name);
            if(chanrank > this.rank) {
                this.rank = chanrank;
            }
        }
        this.channel.userJoin(this);
    }.bind(this));

    this.socket.on("login", function(data) {
        var name = data.name || "";
        var pw = data.pw || "";
        var session = data.session || "";
        if(pw.length > 100)
            pw = pw.substring(0, 100);
        if(this.name == "")
            this.login(name, pw, session);
    }.bind(this));

    this.socket.on("assignLeader", function(data) {
        if(this.channel != null) {
            this.channel.tryChangeLeader(this, data);
        }
    }.bind(this));

    this.socket.on("promote", function(data) {
        if(this.channel != null) {
            this.channel.tryPromoteUser(this, data);
        }
    }.bind(this));

    this.socket.on("demote", function(data) {
        if(this.channel != null) {
            this.channel.tryDemoteUser(this, data);
        }
    }.bind(this));

    this.socket.on("setChannelRank", function(data) {
        if(this.channel != null) {
            this.channel.trySetRank(this, data);
        }
    }.bind(this));

    this.socket.on("banName", function(data) {
        if(this.channel != null) {
            this.channel.banName(this, data.name || "");
        }
    }.bind(this));

    this.socket.on("banIP", function(data) {
        if(this.channel != null) {
            this.channel.tryIPBan(this, data);
        }
    }.bind(this));

    this.socket.on("unban", function(data) {
        if(this.channel != null) {
            this.channel.tryUnban(this, data);
        }
    }.bind(this));

    this.socket.on("chatMsg", function(data) {
        if(this.channel != null) {
            if(data.msg.indexOf("/afk") != 0) {
                this.setAFK(false);
                this.autoAFK();
            }
            this.channel.tryChat(this, data);
        }
    }.bind(this));

    this.socket.on("newPoll", function(data) {
        if(this.channel != null) {
            this.channel.tryOpenPoll(this, data);
        }
    }.bind(this));

    this.socket.on("playerReady", function() {
        if(this.channel != null) {
            this.channel.sendMediaUpdate(this);
        }
    }.bind(this));

    this.socket.on("requestPlaylist", function() {
        if(this.channel != null) {
            this.channel.sendPlaylist(this);
        }
    }.bind(this));

    this.socket.on("queue", function(data) {
        if(this.channel != null) {
            this.channel.tryQueue(this, data);
        }
    }.bind(this));

    this.socket.on("setTemp", function(data) {
        if(this.channel != null) {
            this.channel.trySetTemp(this, data);
        }
    }.bind(this));

    this.socket.on("delete", function(data) {
        if(this.channel != null) {
            this.channel.tryDequeue(this, data);
        }
    }.bind(this));

    this.socket.on("uncache", function(data) {
        if(this.channel != null) {
            this.channel.tryUncache(this, data);
        }
    }.bind(this));

    this.socket.on("moveMedia", function(data) {
        if(this.channel != null) {
            this.channel.tryMove(this, data);
        }
    }.bind(this));

    this.socket.on("jumpTo", function(data) {
        if(this.channel != null) {
            this.channel.tryJumpTo(this, data);
        }
    }.bind(this));

    this.socket.on("playNext", function() {
        if(this.channel != null) {
            this.channel.tryPlayNext(this);
        }
    }.bind(this));

    this.socket.on("clearPlaylist", function() {
        if(this.channel != null) {
            this.channel.tryClearqueue(this);
        }
    }.bind(this));

    this.socket.on("shufflePlaylist", function() {
        if(this.channel != null) {
            this.channel.tryShufflequeue(this);
        }
    }.bind(this));

    this.socket.on("togglePlaylistLock", function() {
        if(this.channel != null) {
            this.channel.tryToggleLock(this);
        }
    }.bind(this));

    this.socket.on("mediaUpdate", function(data) {
        if(this.channel != null) {
            this.channel.tryUpdate(this, data);
        }
    }.bind(this));

    this.socket.on("searchMedia", function(data) {
        var self = this;
        if(this.channel != null) {
            if(data.source == "yt") {
                var searchfn = self.server.infogetter.Getters["ytSearch"];
                searchfn(data.query.split(" "), function (e, vids) {
                    if(!e) {
                        self.socket.emit("searchResults", {
                            results: vids
                        });
                    }
                });
            } else {
                self.channel.search(data.query, function (vids) {
                    self.socket.emit("searchResults", {
                        results: vids
                    });
                });
            }
        }
    }.bind(this));

    this.socket.on("closePoll", function() {
        if(this.channel != null) {
            this.channel.tryClosePoll(this);
        }
    }.bind(this));

    this.socket.on("vote", function(data) {
        if(this.channel != null) {
            this.channel.tryVote(this, data);
        }
    }.bind(this));

    this.socket.on("registerChannel", function(data) {
        if(this.channel == null) {
            this.socket.emit("channelRegistration", {
                success: false,
                error: "You're not in any channel!"
            });
        }
        else {
            this.channel.tryRegister(this);
        }
    }.bind(this));

    this.socket.on("unregisterChannel", function() {
        if(this.channel == null) {
            return;
        }
        this.channel.unregister(this);
    }.bind(this));

    this.socket.on("setOptions", function(data) {
        if(this.channel != null) {
            this.channel.tryUpdateOptions(this, data);
        }
    }.bind(this));

    this.socket.on("setPermissions", function(data) {
        if(this.channel != null) {
            this.channel.tryUpdatePermissions(this, data);
        }
    }.bind(this));

    this.socket.on("setChannelCSS", function(data) {
        if(this.channel != null) {
            this.channel.trySetCSS(this, data);
        }
    }.bind(this));

    this.socket.on("setChannelJS", function(data) {
        if(this.channel != null) {
            this.channel.trySetJS(this, data);
        }
    }.bind(this));

    this.socket.on("updateFilter", function(data) {
        if(this.channel != null) {
            this.channel.tryUpdateFilter(this, data);
        }
    }.bind(this));

    this.socket.on("removeFilter", function(data) {
        if(this.channel != null) {
            this.channel.tryRemoveFilter(this, data);
        }
    }.bind(this));

    this.socket.on("moveFilter", function(data) {
        if(this.channel != null) {
            this.channel.tryMoveFilter(this, data);
        }
    }.bind(this));

    this.socket.on("setMotd", function(data) {
        if(this.channel != null) {
            this.channel.tryUpdateMotd(this, data);
        }
    }.bind(this));

    this.socket.on("requestLoginHistory", function() {
        if(this.channel != null) {
            this.channel.sendLoginHistory(this);
        }
    }.bind(this));

    this.socket.on("requestBanlist", function() {
        if(this.channel != null) {
            this.channel.sendBanlist(this);
        }
    }.bind(this));

    this.socket.on("requestChatFilters", function() {
        if(this.channel != null) {
            this.channel.sendChatFilters(this);
        }
    }.bind(this));

    this.socket.on("requestChannelRanks", function() {
        if(this.channel != null) {
            if(this.noflood("requestChannelRanks", 0.25))
                return;
            this.channel.sendChannelRanks(this);
        }
    }.bind(this));

    this.socket.on("voteskip", function(data) {
        if(this.channel != null) {
            this.channel.tryVoteskip(this);
        }
    }.bind(this));

    this.socket.on("listPlaylists", function(data) {
        if(this.name == "" || this.rank < 1) {
            this.socket.emit("listPlaylists", {
                pllist: [],
                error: "You must be logged in to manage playlists"
            });
            return;
        }

        var list = this.server.db.getUserPlaylists(this.name);
        for(var i = 0; i < list.length; i++) {
            list[i].time = formatTime(list[i].time);
        }
        this.socket.emit("listPlaylists", {
            pllist: list,
        });
    }.bind(this));

    this.socket.on("savePlaylist", function(data) {
        if(this.rank < 1) {
            this.socket.emit("savePlaylist", {
                success: false,
                error: "You must be logged in to manage playlists"
            });
            return;
        }

        if(this.channel == null) {
            this.socket.emit("savePlaylist", {
                success: false,
                error: "Not in a channel"
            });
            return;
        }

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

        var pl = this.channel.playlist.items.toArray();
        var result = this.server.db.saveUserPlaylist(pl, this.name, data.name);
        this.socket.emit("savePlaylist", {
            success: result,
            error: result ? false : "Unknown"
        });
        var list = this.server.db.getUserPlaylists(this.name);
        for(var i = 0; i < list.length; i++) {
            list[i].time = formatTime(list[i].time);
        }
        this.socket.emit("listPlaylists", {
            pllist: list,
        });
    }.bind(this));

    this.socket.on("queuePlaylist", function(data) {
        if(this.channel != null) {
            this.channel.tryQueuePlaylist(this, data);
        }
    }.bind(this));

    this.socket.on("deletePlaylist", function(data) {
        if(typeof data.name != "string") {
            return;
        }

        this.server.db.deleteUserPlaylist(this.name, data.name);
        var list = this.server.db.getUserPlaylists(this.name);
        for(var i = 0; i < list.length; i++) {
            list[i].time = formatTime(list[i].time);
        }
        this.socket.emit("listPlaylists", {
            pllist: list,
        });
    }.bind(this));

    this.socket.on("readChanLog", function () {
        if(this.channel !== null) {
            this.channel.tryReadLog(this);
        }
    }.bind(this));

    this.socket.on("acp-init", function() {
        if(this.global_rank >= Rank.Siteadmin)
            this.server.acp.init(this);
    }.bind(this));

    this.socket.on("borrow-rank", function(rank) {
        if(this.global_rank < 255)
            return;
        if(rank > this.global_rank)
            return;

        this.rank = rank;
        this.socket.emit("rank", rank);
        if(this.channel != null)
            this.channel.broadcastUserUpdate(this);

    }.bind(this));
}

var lastguestlogin = {};
// Attempt to login
User.prototype.login = function(name, pw, session) {
    var self = this;
    // No password => try guest login
    if(pw == "" && session == "") {
        if(self.ip in lastguestlogin) {
            var diff = (Date.now() - lastguestlogin[self.ip])/1000;
            if(diff < self.server.cfg["guest-login-delay"]) {
                self.socket.emit("login", {
                    success: false,
                    error: ["Guest logins are restricted to one per ",
                            self.server.cfg["guest-login-delay"]
                            + " seconds per IP.  ",
                            "This restriction does not apply to registered users."
                            ].join("")
                });
                return false;
            }
        }
        if(!$util.isValidUserName(name)) {
            self.socket.emit("login", {
                success: false,
                error: "Invalid username.  Usernames must be 1-20 characters long and consist only of alphanumeric characters and underscores"
            });
            return;
        }

        self.server.db.isUsernameTaken(name, function (err, taken) {
            if(err) {
                self.socket.emit("login", {
                    success: false,
                    error: "Internal error: " + err
                });
                return;
            }

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

            if(self.channel != null) {
                for(var i = 0; i < self.channel.users.length; i++) {
                    if(self.channel.users[i].name == name) {
                        self.socket.emit("login", {
                            success: false,
                            error: "That name is already taken on self channel"
                        });
                        return;
                    }
                }
            }
            lastguestlogin[self.ip] = Date.now();
            self.rank = Rank.Guest;
            Logger.syslog.log(self.ip + " signed in as " + name);
            self.server.db.recordVisit(self.ip, name);
            self.name = name;
            self.loggedIn = false;
            self.socket.emit("login", {
                success: true,
                name: name
            });
            self.socket.emit("rank", self.rank);
            if(self.channel != null) {
                self.channel.logger.log(self.ip + " signed in as " + name);
                self.channel.broadcastNewUser(self);
            }
        });
    } else {
        self.server.db.userLogin(name, pw, session, function (err, row) {
            if(err) {
                self.server.actionlog.record(self.ip, self.name, "login-failure");
                self.socket.emit("login", {
                    success: false,
                    error: err
                });
                return;
            }
            if(self.channel != null) {
                for(var i = 0; i < self.channel.users.length; i++) {
                    if(self.channel.users[i].name == name) {
                        self.channel.kick(self.channel.users[i], "Duplicate login");
                    }
                }
            }
            if(self.global_rank >= 255)
                self.server.actionlog.record(self.ip, name, "login-success");
            self.loggedIn = true;
            self.socket.emit("login", {
                success: true,
                session: row.session_hash,
                name: name
            });
            Logger.syslog.log(self.ip + " logged in as " + name);
            self.server.db.recordVisit(self.ip, name);
            self.profile = {
                image: row.profile_image,
                text: row.profile_text
            };
            var chanrank = (self.channel != null) ? self.channel.getRank(name)
                                                  : Rank.Guest;
            var rank = (chanrank > row.global_rank) ? chanrank
                                                     : row.global_rank;
            self.rank = (self.rank > rank) ? self.rank : rank;
            self.global_rank = row.global_rank;
            self.socket.emit("rank", self.rank);
            self.name = name;
            if(self.channel != null) {
                self.channel.logger.log(self.ip + " logged in as " + name);
                self.channel.broadcastNewUser(self);
            }
        });
    }
}

module.exports = User;