src/config/Config.js
var Crypto = require("../util/Crypto");
var PDOX = require("../util/PDOX");
var Q = require("q");
/**
* This is a sample of the configuration file. Copy this to
* Config.js in the top directory and edit all the values to
* set your Tsugi configuration.
*
* Calling sequence in a NodeJS app:
*
* var config = require('tsugi-node/src/core/Config'),
* CFG = new Config ();
* var Tsugi = require('tsugi-node/src/core/Tsugi');
*
* launch = Tsugi.requireData(CFG, req, res, session, Tsugi.ALL);
* if ( launch.complete ) return;
*/
class Config {
/**
* @param {Object} [configuration] Object to initialize the public properties with alternative values.
* Look at public properties to see which properties can be overrided.
* @example
*
* var config = new Config ({
* 'dbport': '3306',
* 'dbhost': 'mydomain.com'
* });
*
*/
constructor(jsonOptions) {
/**
* This is the URL where the software is hosted
* Do not add a trailing slash to this string
*/
this.wwwroot = 'http://localhost/tsugi'; /// For normal
//this.wwwroot = 'http://localhost:8888/tsugi'; // For MAMP
/*
* Database connection information.
*/
/**
* The host name, it could be an IP address or a name. By default: '127.0.0.1'
* @type {string}
*/
this.dbhost = '127.0.0.1';
/**
* The database name. By default: 'tsugi'
*/
this.dbname = 'tsugi';
/**
* The database port. By default: '8889'
*/
this.dbport = 3306;
/**
* The database user (encrypted).
* By default: 'ltiuser'
* @type {string}
*/
this._dbuser = Crypto.encryptShortTerm('ltiuser');
/**
* The database password (encrypted).
* By default: 'ltipassword'
* @type {string}
*/
this._dbpass = Crypto.encryptShortTerm('ltipassword');
/**
* The dbprefix allows you to give all the tables a prefix
* in case your hosting only gives you one database. This
* can be short like "t_" and can even be an empty string if you
* can make a separate database for each instance of TSUGI.
* This allows you to host multiple instances of TSUGI in a
* single database if your hosting choices are limited.
* By default: '' empty.
*/
this.dbprefix = '';
/**
* You can use the CDN copy of the static content in testing or
* light production.
* If you check out a copy of the static content locally and do not
* want to use the CDN copy (perhaps you are on a plane or are otherwise
* not connected) change this configuration.
* By default: /tsugi-static
*/
//this.staticroot = 'https://www.dr-chuck.net/tsugi-static';
this.staticroot = "/tsugi-static";
/**
* Where the bulk mail comes from - should be a real address with
* a wildcard box you check.
* By default: false
*/
this.maildomain = false; // 'mail.example.com';
/**
* The mail secret (encrypted)
* By default: warning:please-change-mailsecret-92ds29
* @type {string}
*/
this._mailsecret = Crypto.encryptShortTerm('warning:please-change-mailsecret-xxxxxx');
/**
* Mail end of line - Depends on your mailer - may need to be \r\n
* By default: '\n'
*/
this.maileol = "\n"; // Depends on your mailer
/**
* Set the nonce clearing check proability
* By default: 100
*/
this.noncecheck = 100;
/**
* Set the nonce expiry time
* By default: 1800
*/
this.noncetime = 1800;
/**
* This is used to make sure that our constructed session ids
* based on resource_link_id, oauth_consumer_key, etc are not
* predictable or guessable.
* By default: warning:please-change-sessionsalt-xxxx'
*/
this.sessionsalt = "warning:please-change-sessionsalt-xxxxxx";
/**
* The desired timezone.
* By default: Pacific/Honolulu
*/
this.timezone = 'Pacific/Honolulu'; // Nice for due dates
// Universal Analytics
this.universal_analytics = false; // "UA-57880800-1";
// TODO: Make this work in Node - lots of fun
// Only define this if you are using Tsugi in single standalone app that
// will never be in iframes - because most browsers will *not* set cookies in
// cross-domain iframes. If you use this, you cannot be a different
// user in a different tab or be in a different course in a different
// tab.
// if ( !defined('COOKIE_SESSION') ) define('COOKIE_SESSION', true);
/**
* Effectively an "airplane mode" for the appliction.
* Setting this to true makes it so that when you are completely
* disconnected, various tools will not access network resources
* like Google's map library and hang. Also the Google login will
* be faked. Don't run this in production.
* By default: false.
*/
this.OFFLINE = false;
/**
* Unit testing flag
* By default: false
*/
this.unitTesting = false;
this.LTI = require('tsugi-node-lti/lib/ims-lti');
//Update the properties with the custom paramenters
Object.assign (this, jsonOptions);
this.pdox = new PDOX(this);
// Check the tables (async - will fail later)
let sql = this.pdox.setPrefix('SELECT * FROM {p}lti_key WHERE key_key = :key_key');
this.pdox.allRows(sql,{ key_key: '12345' }).then(
function(rows) {
console.log("Table test success.");
},
function (err) {
console.log('Could not load data query', sql);
console.log('You need to install the Tsugi application console (a PHP app)');
console.log('and use the Admin functionality to create the Tsugi tables');
console.log('to initialize this application.');
throw err;
}
);
}
/**
* The database user (encrypted)
* @type {string}
*/
get dbuser() { return Crypto.decryptShortTerm(this._dbuser); }
/**
* The database password (encrypted)
* @type {string}
*/
get dbpass() { return Crypto.decryptShortTerm(this._dbpass); }
/**
* The mail secret (encrypted)
* @type {string}
*/
get mailsecret() { return Crypto.decryptShortTerm(this._mailsecret); }
/**
* Returns the local directory where client libraries are. Only if the
* staticroot is not an CDN address
* @type string
*/
get staticrootDir () {
if (this.staticroot.startsWith ('http') || this.staticroot.startsWith ('//')){
return null;
} else if (this.staticroot.startsWith('/')){
return __dirname + '/../../bower_components'
}
return null;
}
}
module.exports = Config;
