welsonjs/lib/chrome.js

//////////////////////////////////////////////////////////////////////////////////
// Google Chrome API
/////////////////////////////////////////////////////////////////////////////////
var SHELL = require("lib/shell");
var SYS = require("lib/system");
var FILE = require("lib/file");
var HTTP = require("lib/http");
var Websocket = require("lib/websocket");
var AutoItX = require("lib/autoitx");

// for remote debugging
var pageEventId = 0;

var ChromeObject = function() {
    this.workingDirectory = SYS.getEnvString("PROGRAMFILES") + "\\Google\\Chrome\\Application";
    this.binPath = SYS.getEnvString("PROGRAMFILES") + "\\Google\\:installedDir\\Application\\chrome.exe";
    //this.processID = 0;
    this.installedDir = "Chrome";
    this.profileName = "Default";
    this.userDataDir = null;
    this.proxy = {
        "protocol": "socks5",
        "host": "127.0.0.1",
        "port": 1080
    };
    this.inPrivate = false;

    // dependencies
    this.oAutoIt = null;

    // for remote debugging
    this.debuggingPort = 0;
    this.pageId = "";
    this.ws = Websocket.create();
    this.isAttached = false;
    this.pageList = [];
    this.title = "";

    this.create = function() {
        this.oAutoIt = AutoItX.create().getInterface();
        return this;
    };

    this.setBinPath = function(path) {
        this.binPath = path;
        return this;
    };

    this.setProfile = function(profileName, installedDir) {
        this.profileName = (profileName == "Default" ? "Chrome" : profileName);
        this.setInstalledDir(installedDir);
        this.workingDirectory = this.workingDirectory.replace(":installedDir", this.installedDir);
        this.binPath = this.binPath.replace(":installedDir", this.installedDir);
        //this.binPath = this.binPath.replace(":installedDir", "Chrome");
        return this;
    };

    this.setUserDataDir = function(dirname) {
        if (dirname != null) {
            this.userDataDir = dirname;
        } else {
            this.userDataDir = SHELL.getPathOfMyDocuments() + "\\UserData_Chrome_" + this.profileName;
        }
        return this;
    };

    this.setInstalledDir = function(dirname) {
        if (dirname != null) {
            this.installedDir = dirname;
        }
        return this;
    };
    
    this.setProxy = function(obj) {
        this.proxy = obj;
        return this;
    };

    this.setProxyProtocol = function(s) {
        this.proxy.protocol = s;
        return this;
    };

    this.setProxyHost = function(s) {
        this.proxy.host = s;
        return this;
    };

    this.setProxyPort = function(port) {
        this.proxy.port = port;
        return this;
    };
    
    this.setDebuggingPort = function(port) {
        this.debuggingPort = port;
        console.log("Enabled debugging port:", port);
        return this;
    };
    
    this.setPageId = function(s) {
        if (s == null) {
            var pageList = this.getPageList();
            if (pageList instanceof Array && pageList.length > 0) {
                this.pageId = pageList[0].id;
            }
        } else {
            this.pageId = s;
        }
    };

    this.createShoutcut = function(url) {
        if (!this.userDataDir) {
            this.userDataDir = SHELL.getPathOfMyDocuments() + "\\UserData_Chrome_" + this.profileName;
        }

        var cmd = [
            "cscript",
            "app.js",
            "shoutcut",
            "chrome",
            this.installedDir,
        ];

        // disable default browser check
        cmd.push("--no-default-browser-check");

        // disable popop blocking
        cmd.push("--disable-popup-blocking");

        // check incognito mode
        if (this.inPrivate) {
            cmd.push("--incognito");
        }

        // check debugging port
        if (this.debuggingPort > 0) {
            cmd.push("--remote-debugging-port=" + this.debuggingPort);
        }

        cmd.push("--profile-directory=\"" + this.profileName + "\"");
        cmd.push("--user-data-dir=\"" + this.userDataDir + "\"");
        cmd.push("\"" + url + "\"");

        SHELL.createDesktopIcon("Chrome Prototype (" + this.installedDir + ")", cmd.join(' '), SYS.getCurrentScriptDirectory());
    };

    this.setInPrivate = function(flag) {
        this.inPrivate = flag;
        return this;
    };

    this.open = function(url) {
        this.setProfile(this.profileName, this.installedDir);

        // if the file does not exists, Check the 32bit installation folder again
        if (!FILE.fileExists(this.binPath)) {
            this.workingDirectory = SYS.getEnvString("PROGRAMFILES(X86)") + "\\Google\\Chrome\\Application";
            this.binPath = SYS.getEnvString("PROGRAMFILES(X86)") + "\\Google\\:installedDir\\Application\\chrome.exe";
            this.setProfile(this.profileName, this.installedDir);
        }

        // find profile
        if (!FILE.fileExists(this.binPath)) {
            console.error("ChromeObject.open() -> '" + this.profileName + "' profile does not exists. You have to create it.");
            return this;
        }

        // create shoutcut to desktop
        if (this.debuggingPort == 0) {
            this.createShoutcut();
        }

        /*
        var process;
        while (this.processID == 0) {
            try {
                if (!this.userDataDir) {
                    this.userDataDir = SHELL.getPathOfMyDocuments() + "\\UserData_Chrome_" + this.profileName;
                }
                var shell = SHELL.create().setWorkingDirectory(this.workingDirectory);
                var process = shell.createProcess([
                    "\"" + this.binPath + "\"",
                    "--profile-directory=\"" + this.profileName + "\"",
                    "--proxy-server=\"socks5://127.0.0.1:" + this.proxyPort + "\"",
                    "--user-data-dir=\"" + this.userDataDir + "\"",
                    "\"" + url + "\""
                ].join(" "));
                sleep(1500);
                this.processID = process.ProcessID;
                sleep(1500);
                shell.release();
            } catch (e) {
                console.error("ChromeObject.open() ->", e.message);
                sleep(1500);
            }
        }
        */

        try {
            // get user data directory
            if (!this.userDataDir) {
                this.userDataDir = SHELL.getPathOfMyDocuments() + "\\UserData_Chrome_" + this.profileName;
            }

            // connect to shell
            var shell = SHELL.create();
            shell.setWorkingDirectory(this.workingDirectory);

            // initialize
            var cmd = [];

            // enable inPrivate (incognito) mode
            if (this.inPrivate) {
                cmd.push("--incognito");
            }

            // enable debugging port
            if (this.debuggingPort > 0) {
                cmd.push("--remote-debugging-port=" + this.debuggingPort);
            }
            
            // disable default browser check
            cmd.push("--no-default-browser-check");

            // disable popop blocking
            cmd.push("--disable-popup-blocking");

            // set profile directory
            cmd.push("--profile-directory=\"" + this.profileName + "\"");
            
            // set proxy configuration
            if (this.proxy != null) {
                console.log("Enabled proxy server:", this.proxy.protocol + "://" + this.proxy.host + ":" + this.proxy.port);
                cmd.push("--proxy-server=\"" + this.proxy.protocol + "://" + this.proxy.host + ":" + this.proxy.port + "\"");
            }

            // set user data directory
            cmd.push("--user-data-dir=\"" + this.userDataDir + "\"");
            
            // set URL
            cmd.push("\"" + url + "\"");
            
            // run
            shell.runAs(this.binPath, cmd);
            sleep(300);

            // release shell
            shell.release();
        } catch (e) {
            console.error("ChromeObject.open() -> ", e.message);
            sleep(300);
        }

        return this;
    };
    
    this.getPageList = function() {
        var pageList = [];

        if (this.debuggingPort > 0) {
            try {
                var responseText = HTTP.get("http://127.0.0.1:" + this.debuggingPort + "/json");
                //console.info(responseText);
                pageList = JSON.parse(responseText);
                this.pageList = pageList;
                return pageList;
            } catch (e) {
                console.error("ChromeObject.getPageList() ->", e.message);
                return this.getPageList();
            }
        } else {
            console.error("Remote debugging unavailable");
            return pageList;
        }
    };

    this.getPageById = function(id) {
        return this.getPageList().find(function(x) {
            return (x.id = id);
        });
    };

    this.getPagesByUrl = function(url) {
        return this.getPageList().filter(function(x) {
            return (x.url.indexOf(url) == 0);
        });
    };

    this.getPagesByTitle = function(title) {
        return this.getPageList().filter(function(x) {
            return (x.title.indexOf(title) == 0);
        });
    };

    this.sendPageRPC = function(method, params) {
        var result = null;

        try {
            if (this.pageId != "") {
                result = this.ws.send("ws://127.0.0.1:" + this.debuggingPort + "/devtools/page/" + this.pageId, JSON.stringify({
                    "id": pageEventId,
                    "method": method,
                    "params": params
                }));
                pageEventId++;
                console.info("ChromeObject().sendPageRPC() -> Sent");
            } else {
                this.setPageId(null);
                if (this.pageId != "") {
                    result = this.sendPageRPC(method, params);
                } else {
                    console.error("Page not found");
                }
            }
        } catch (e) {
            console.log("ChromeObject.sendPageRPC() ->", e.message);
        }

        return result;
    };

    this.navigate = function(url) {
        return this.sendPageRPC("Page.navigate", {
            "url": url
        });
    };
    
    this.navigateEvaluately = function(url) {
        return this.evaluate('location.href = "' + url + '"');
    };

    this.evaluate = function(expression) {
        try {
            return this.sendPageRPC("Runtime.evaluate", {
                "expression": expression
            });
        } catch (e) {
            console.error("ChromeObject.evaluate() ->", e.message);
        }
    };

    this.getEvaluatedValue = function(expression) {
        try {
            var responseText = this.evaluate(expression);
            console.info(responseText);
            return JSON.parse(responseText).result.result.value;
        } catch (e) {
            console.error("ChromeObject.getEvaluatedValue() ->", e.message);
			return "";
        }
    };

    this.close = function() {
        return this.sendPageRPC("Browser.close", {});
    };

    this.terminate = function() {
        try {
            this.oAutoIt.WinKill(this.pageId);
        } catch (e) {
            console.error("ChromeObject.terminate() ->", e.message);
        }
    };

    this.focus = function() {
        if (this.debuggingPort > 0) {
            try {
                // set page id
                if (this.pageId == "") {
                    this.setPageId(null);
                }
                
                // get current title
                this.title = this.getTitle();

                // _focus()
                this._focus();
            } catch (e) {
                console.error("ChromeObject._focus() ->", e.message);
            }
        }
    };

    this.blur = function() {
        this.setTitle(this.title);
    };

    this._focus = function() {
        if (this.debuggingPort > 0) {
            try {
                // change webpage title for focusing window
                this.setTitle(this.title + " " + this.pageId.substring(0, 6));

                // find window by title
                var pageList = this.getPageList();
                if (pageList.length > 0) {
                    this.oAutoIt.WinActivate(this.pageId);
                }
            } catch (e) {
                console.error("ChromeObject.focus() ->", e.message);
            }
        }
    };

    this.getScrollHeight = function(selector) {
        return parseInt(this.getEvaluatedValue('document.querySelector("' + selector + '").scrollHeight'));
    };

    this.focusWithoutActivate = function() {
        if (this.debuggingPort > 0) {
            try {
                // if page ID is empty
                if (this.pageId == "") {
                    var pageList = this.getPageList();
                    if (pageList instanceof Array && pageList.length > 0) {
                        this.pageId = pageList[0].id;
                    }
                }

                // change webpage title for focusing window
                this.setTitle(this.pageId);
            } catch (e) {
                console.error("ChromeObject.focusWithoutActivate() ->", e.message);
            }
        }
    };

    this.autoAdjust = function(sX, sY) {
        // get current title
        var _title = this.getTitle();

        // change webpage title
        this.setTitle(this.pageId);

        // adjust window position and size
        var bX = Math.floor(sX / 6);
        var bY = Math.floor(sY / 3);
        var x = this.getRandomInt(0, bX);
        var y = this.getRandomInt(0, bY);
        var w = this.getRandomInt(bX * 3, sX - bX);
        var h = this.getRandomInt(bY, sY - bY);
        this.oAutoIt.WinMove(this.pageId, "", x, y, w, h);

        // change webpage title to original
        this.setTitle(_title);
    };

    this.blur = function() {
        return this.evaluate("window.blur()");
    };
    
    this.downMouseWheel = function(times) {
        if (this.debuggingPort > 0) {
            try {
                var pos = this.getScreenPosition();
                this.oAutoIt.MouseMove(pos.x + 100, pos.y + 100);
                this.oAutoIt.MouseWheel("down", times);
            } catch (e) {
                console.error("ChromeObject.downMouseWheel() ->", e.message);
            }
        }
    };

    this.upMouseWheel = function(times) {
        if (this.debuggingPort > 0) {
            try {
                var pos = this.getScreenPosition();
                this.oAutoIt.MouseMove(pos.x + 100, pos.y + 100);
                this.oAutoIt.MouseWheel("up", times);
            } catch (e) {
                console.error("ChromeObject.upMouseWheel() ->", e.message);
            }
        }
    };
    
    this.setTitle = function(title) {
        var i = 0, repeat = 2;

        if (this.debuggingPort > 0) {
            while (i < repeat) {
                this.evaluate('document.title = "' + title + '"');
                i++;
            }
        }
    };

    this.getTitle = function() {
        if (this.debuggingPort > 0) {
            return this.getEvaluatedValue('document.title');
        }
    };

    this.getScreenPosition = function() {
        var result = this.getEvaluatedValue('(function() { return [window.screenX, window.screenY].join(","); })();');
        var pos = result.split(',');
        return {
            "x": parseInt(pos[0]),
            "y": parseInt(pos[1])
        };
    };

    this.getElementPosition = function(selector) {
        var result = this.getEvaluatedValue('(function() { var rect = document.querySelector("' + selector + '").getBoundingClientRect(); return [parseInt(rect.left), parseInt(rect.top), parseInt(rect.x), parseInt(rect.y), parseInt(rect.right), parseInt(rect.bottom)].join(","); })();');
        var pos = result.split(',');
        if (pos.length == 6) {
            return {
                "x": parseInt(pos[0]),
                "y": parseInt(pos[1]),
                "a": parseInt(pos[2]),
                "b": parseInt(pos[3]),
                "g": parseInt(pos[4]),
                "d": parseInt(pos[5])
            };
        } else {
            return {
                "x": -1,
                "y": -1,
                "a": -1,
                "b": -1,
                "g": -1,
                "d": -1
            };
		}
    };

    this.getNestedElementPosition = function(selector, subSelector, searchText) {
        var s = '';
		
		if (searchText.indexOf(':p(') != 0) {
			s += '(function() {'
				+ '    var elements = Object.values(document.querySelectorAll("' + selector + '")).filter(function(x) {'
				+ '        return (x.querySelector("' + subSelector + '").innerText.indexOf(decodeURIComponent("' + encodeURIComponent(searchText) + '")) > -1);'
				+ '    });'
				+ '    if (elements.length > 0) {'
				+ '        var rect = elements[0].getBoundingClientRect();'
				+ '        return [parseInt(rect.left), parseInt(rect.top), parseInt(rect.x), parseInt(rect.y), parseInt(rect.right), parseInt(rect.bottom)].join(",");' 
				+ '    } else {'
				+ '        return "";'
				+ '    }'
				+ '})()'
			;
		} else {
			var p = parseFloat(searchText.substring(searchText.indexOf('(') + 1, searchText.indexOf(')')));
			s += '(function() {'
				+ '    var elements = Object.values(document.querySelectorAll("' + selector + '")).filter(function(x) {'
				+ '        return (Math.random() < ' + p + ');'
				+ '    });'
				+ '    if (elements.length > 0) {'
				+ '        var rect = elements[0].getBoundingClientRect();'
				+ '        return [parseInt(rect.left), parseInt(rect.top), parseInt(rect.x), parseInt(rect.y), parseInt(rect.right), parseInt(rect.bottom)].join(",");' 
				+ '    } else {'
				+ '        return "";'
				+ '    }'
				+ '})()'
			;
		}

        var result = this.getEvaluatedValue(s);
        var pos = result.split(',');
        if (pos.length == 6) {
            return {
                "x": parseInt(pos[0]),
                "y": parseInt(pos[1]),
                "a": parseInt(pos[2]),
                "b": parseInt(pos[3]),
                "g": parseInt(pos[4]),
                "d": parseInt(pos[5])
            };
        } else {
            return {
                "x": -1,
                "y": -1,
                "a": -1,
                "b": -1,
                "g": -1,
                "d": -1
            };
		}
    };

    this.getPageHeight = function() {
        var height = 0;

        if (this.debuggingPort > 0) {
            var result = this.getEvaluatedValue('(function(obj) { return Math.max(obj.scrollHeight, obj.clientHeight); })(document.querySelector("html"))');
            height = parseInt(result);
        }

        return height;
    };
    
    this.setIsAttached = function(isAttached) {
        this.isAttached = isAttached;
        return this;
    };
    
    this.getRandomInt = function(min, max) {
        min = Math.ceil(min);
        max = Math.floor(max);
        return Math.floor(Math.random() * (max - min + 1)) + min;
    };
    
    this.checkDebuggingPort = function() {
        var isChecked = false;
        var isDone = false;

        while (!isDone) {
            try {
                if (this.debuggingPort > 0) {
                    var result = SHELL.exec("netstat -ano | findstr :" + this.debuggingPort);
                    if (result.indexOf(":" + this.debuggingPort) > -1) {
                        isChecked = true;
                    }
                }

                isDone = true;
            } catch(e) {
                sleep(1);
                console.error("ChromeObject.checkDebuggingPort() ->", e.message);
            }
        }

        return isChecked;
    };

    this.getCurrentUrl = function() {
        var page = this.getPageById(this.pageId);
        return page.url;
    };

    this.getCurrentDomain = function() {
        return this.getEvaluatedValue('document.domain') || '';
    };

    this.triggerEvent = function(eventName, selector) {
        if (selector.indexOf(':p(') < 0) {
            if (eventName == 'click') {
                return this.evaluate('document.querySelector("' + selector + '").click()');
            } else {
                return this.evaluate('document.querySelector("' + selector + '").dispatchEvent(new Event("' + eventName + '"))');
            }
        } else {
            var probability = parseFloat(selector.substring(selector.indexOf('(') + 1, selector.indexOf(')')));
            return this.evaluate('(function(obj, p) { var a = Array.from(obj).filter(function() { return (Math.random() < p); }); if(a.length > 0) a[0].click(); })(document.querySelectorAll("' + selector.substring(0, selector.indexOf(':')) + '"), ' + probability + ')');
        }
    };

    this.scrollBySelector = function(selector, dx, dy) {
        return this.evaluate('(function(rect, dx, dy) { window.scrollTo(rect.x + dx, rect.y + dy); })(document.querySelector("' + selector + '").getBoundingClientRect(), parseInt("' + (dx || 0) + '"), parseInt("' + (dy || 0) + '"))');
    };

    this.scrollTo = function(x, y) {
        return this.evaluate('window.scrollTo(parseInt(' + x + '), parseInt(' + y + '))');
    };

    this.scrollBy = function(dx, dy) {
        return this.evaluate('window.scrollBy(parseInt(' + dx + '), parseInt(' + dy + '))');
    };

    this.reload = function() {
        return this.sendPageRPC("Page.reload", {});
    };

    this.hasClass = function(seletctor, className) {
        try {
            var result = this.getEvaluatedValue('document.querySelector("' + seletctor + '").getAttribute("class")');
            if (typeof(result) === "string") {
                return (result.split(' ').indexOf(className) > -1);
            } else {
                return false;
            }
        } catch (e) {
            console.error("ChromeObject.hasClass() ->", e.message);
        }
    };

    this.getAttribute = function(selector, attributeName) {
        return this.getEvaluatedValue('document.querySelector("' + selector + '").getAttribute("' + attributeName + '")');
    };

    this.sendSpaceKey = function() {
        this.oAutoIt.Send("{SPACE}");
    };

    this.setValue = function(selector, value, repeat) {
        var s = encodeURIComponent(value), i = 0;
		while (i < repeat) {
			this.evaluate('document.querySelector("' + selector + '").value = decodeURIComponent("' + s + '")');
			i++;
		}
    };
	
	this.getText = function(selector) {
		return this.getEvaluatedValue('document.querySelector("' + selector + '").innerText');
	};

    this.create();
};

exports.create = function() {
    return new ChromeObject();
};

exports.start = function(url, proxyPort, profileName, userDataDir, installedDir) {
    return (new ChromeObject())
        .setProxyPort(proxyPort)
        .setProfile(profileName, installedDir)
        .setUserDataDir(userDataDir)
        .open(url)
    ;
};

exports.startWithDebugging = function(url, proxy, profileName, debuggingPort) {
    return (new ChromeObject())
        .setProxy(proxy)
        .setProfile(profileName, null)
        .setUserDataDir(null)
        .setDebuggingPort(debuggingPort)
        .open(url)
    ;
};

exports.VERSIONINFO = "Chrome Web Browser Debugging Interface (chrome.js) version 0.1";
exports.global = global;
exports.require = global.require;