Source: app-service-registration.js

"use strict";
var crypto = require("crypto");
var yaml = require("js-yaml");
var fs = require("fs");

/**
 * Construct a new application service registration.
 * @constructor
 * @param {string} appServiceUrl The base URL the AS can be reached via.
 */
function AppServiceRegistration(appServiceUrl) {
    if (!appServiceUrl) {
        throw new Error("appServiceUrl must be supplied.");
    }
    this.url = appServiceUrl;
    this.hs_token = null;
    this.as_token = null;
    this.sender_localpart = null;
    this.namespaces = {
        users: [],
        aliases: [],
        rooms: []
    };
}

/**
 * Generate a random token.
 * @return {string} A randomly generated token.
 */
AppServiceRegistration.generateToken = function() {
    return crypto.randomBytes(32).toString('hex');
};

/**
 * Set the token the homeserver will use to communicate with the app service.
 * @param {string} token The token
 */
AppServiceRegistration.prototype.setHomeserverToken = function(token) {
    this.hs_token = token;
};

/**
 * Get the token the homeserver will use to communicate with the app service.
 * @return {?string} The token
 */
AppServiceRegistration.prototype.getHomeserverToken = function() {
    return this.hs_token;
};

/**
 * Set the token the app service will use to communicate with the homeserver.
 * @param {string} token The token
 */
AppServiceRegistration.prototype.setAppServiceToken = function(token) {
    this.as_token = token;
};

/**
 * Get the token the app service will use to communicate with the homeserver.
 * @return {?string} The token
 */
AppServiceRegistration.prototype.getAppServiceToken = function() {
    return this.as_token;
};

/**
 * Set the desired user_id localpart for the app service itself.
 * @param {string} localpart The user_id localpart ("alice" in "@alice:domain")
 */
AppServiceRegistration.prototype.setSenderLocalpart = function(localpart) {
    this.sender_localpart = localpart;
};

/**
 * Get the desired user_id localpart for the app service itself.
 * @return {?string} The user_id localpart ("alice" in "@alice:domain")
 */
AppServiceRegistration.prototype.getSenderLocalpart = function() {
    return this.sender_localpart;
};

/**
 * Add a regex pattern to be registered.
 * @param {String} type : The type of regex pattern. Must be 'users', 'rooms', or
 * 'aliases'.
 * @param {String} regex : The regex pattern.
 * @param {Boolean} exclusive : True to reserve the matched namespace.
 * @throws If given an invalid type or regex.
 */
AppServiceRegistration.prototype.addRegexPattern = function(type, regex, exclusive) {
    if (typeof regex != "string") {
        throw new Error("Regex must be a string");
    }
    if (["users", "aliases", "rooms"].indexOf(type) == -1) {
        throw new Error("'type' must be 'users', 'rooms' or 'aliases'");
    }

    var regexObject = {
        exclusive: Boolean(exclusive),
        regex: regex
    };

    this.namespaces[type].push(regexObject);
};

/**
 * Output this registration to the given file name.
 * @param {String} filename The file name to write the yaml to.
 * @throws If required fields hs_token, as_token, url are missing.
 */
AppServiceRegistration.prototype.outputAsYaml = function(filename) {
    if (!this.hs_token || !this.as_token || !this.url || !this.sender_localpart) {
        throw new Error(
            "Missing required field(s): hs_token, as_token, url, sender_localpart"
        );
    }
    var reg = {
        hs_token: this.hs_token,
        as_token: this.as_token,
        namespaces: this.namespaces,
        url: this.url,
        sender_localpart: this.sender_localpart
    };
    fs.writeFileSync(filename, yaml.safeDump(reg));
};

/** The application service registration class. */
module.exports = AppServiceRegistration;