| #!/usr/bin/env node |
| |
| // Copyright (c) 2012, Matt Godbolt |
| // All rights reserved. |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions are met: |
| // |
| // * Redistributions of source code must retain the above copyright notice, |
| // this list of conditions and the following disclaimer. |
| // * Redistributions in binary form must reproduce the above copyright |
| // notice, this list of conditions and the following disclaimer in the |
| // documentation and/or other materials provided with the distribution. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| // POSSIBILITY OF SUCH DAMAGE. |
| |
| // Initialise options and properties. Don't load any handlers here; they |
| // may need an initialised properties library. |
| const nopt = require('nopt'), |
| os = require('os'), |
| props = require('./lib/properties'), |
| child_process = require('child_process'), |
| path = require('path'), |
| fs = require('fs-extra'), |
| systemdSocket = require('systemd-socket'), |
| url = require('url'), |
| _ = require('underscore'), |
| express = require('express'), |
| Raven = require('raven'), |
| logger = require('./lib/logger').logger, |
| webpackDevMiddleware = require("webpack-dev-middleware"), |
| utils = require('./lib/utils'), |
| clientState = require('./lib/clientstate'), |
| clientStateGoldenifier = require('./lib/clientstate-normalizer').ClientStateGoldenifier, |
| clientStateNormalizer = require('./lib/clientstate-normalizer').ClientStateNormalizer; |
| |
| |
| // Parse arguments from command line 'node ./app.js args...' |
| const opts = nopt({ |
| env: [String, Array], |
| rootDir: [String], |
| host: [String], |
| port: [Number], |
| propDebug: [Boolean], |
| debug: [Boolean], |
| static: [String], |
| archivedVersions: [String], |
| noRemoteFetch: [Boolean], |
| tmpDir: [String], |
| wsl: [Boolean], |
| language: [String], |
| noCache: [Boolean] |
| }); |
| |
| if (opts.debug) logger.level = 'debug'; |
| |
| // AP: Detect if we're running under Windows Subsystem for Linux. Temporary modification |
| // of process.env is allowed: https://nodejs.org/api/process.html#process_process_env |
| if (process.platform === "linux" && child_process.execSync('uname -a').toString().indexOf('Microsoft') > -1) { |
| process.env.wsl = true; |
| } |
| |
| // AP: Allow setting of tmpDir (used in lib/base-compiler.js & lib/exec.js) through opts. |
| // WSL requires a directory on a Windows volume. Set that to Windows %TEMP% if no tmpDir supplied. |
| // If a tempDir is supplied then assume that it will work for WSL processes as well. |
| if (opts.tmpDir) { |
| process.env.tmpDir = opts.tmpDir; |
| process.env.winTmp = opts.tmpDir; |
| } else if (process.env.wsl) { |
| // Dec 2017 preview builds of WSL include /bin/wslpath; do the parsing work for now. |
| // Parsing example %TEMP% is C:\Users\apardoe\AppData\Local\Temp |
| const windowsTemp = child_process.execSync('cmd.exe /c echo %TEMP%').toString().replace(/\\/g, "/"); |
| const driveLetter = windowsTemp.substring(0, 1).toLowerCase(); |
| const directoryPath = windowsTemp.substring(2).trim(); |
| process.env.winTmp = path.join("/mnt", driveLetter, directoryPath); |
| } |
| |
| // Use the canned git_hash if provided |
| let gitReleaseName = ''; |
| if (opts.static && fs.existsSync(opts.static + "/git_hash")) { |
| gitReleaseName = fs.readFileSync(opts.static + "/git_hash").toString().trim(); |
| } else if (fs.existsSync('.git/')) { // Just if we have been cloned and not downloaded (Thanks David!) |
| gitReleaseName = child_process.execSync('git rev-parse HEAD').toString().trim(); |
| } |
| |
| // Set default values for omitted arguments |
| const defArgs = { |
| rootDir: opts.rootDir || './etc', |
| env: opts.env || ['dev'], |
| hostname: opts.host, |
| port: opts.port || 10240, |
| staticDir: opts.static || 'static', |
| gitReleaseName: gitReleaseName, |
| wantedLanguage: opts.language || null, |
| doCache: !opts.noCache, |
| fetchCompilersFromRemote: !opts.noRemoteFetch |
| }; |
| |
| const webpackConfig = require('./webpack.config.js')[1], |
| webpackCompiler = require('webpack')(webpackConfig), |
| manifestName = 'manifest.json', |
| staticManifestPath = path.join(__dirname, defArgs.staticDir, webpackConfig.output.publicPath), |
| assetManifestPath = path.join(staticManifestPath, 'assets'), |
| staticManifest = require(path.join(staticManifestPath, manifestName)), |
| assetManifest = require(path.join(assetManifestPath, manifestName)); |
| |
| const isDevMode = () => process.env.NODE_ENV === "DEV"; |
| |
| const propHierarchy = _.flatten([ |
| 'defaults', |
| defArgs.env, |
| _.map(defArgs.env, e => e + '.' + process.platform), |
| process.platform, |
| os.hostname(), |
| 'local']); |
| logger.info("properties hierarchy: " + propHierarchy.join(', ')); |
| |
| // Propagate debug mode if need be |
| if (opts.propDebug) props.setDebug(true); |
| |
| // *All* files in config dir are parsed |
| props.initialize(defArgs.rootDir + '/config', propHierarchy); |
| |
| // Now load up our libraries. |
| const aws = require('./lib/aws'), |
| google = require('./lib/google'); |
| |
| // Instantiate a function to access records concerning "compiler-explorer" |
| // in hidden object props.properties |
| const ceProps = props.propsFor("compiler-explorer"); |
| |
| let languages = require('./lib/languages').list; |
| |
| if (defArgs.wantedLanguage) { |
| const filteredLangs = {}; |
| _.each(languages, lang => { |
| if (lang.id === defArgs.wantedLanguage || |
| lang.name === defArgs.wantedLanguage || |
| (lang.alias && lang.alias.indexOf(defArgs.wantedLanguage) >= 0)) { |
| filteredLangs[lang.id] = lang; |
| } |
| }); |
| languages = filteredLangs; |
| } |
| |
| if (languages.length === 0) { |
| logger.error("Trying to start Compiler Explorer without a language"); |
| } |
| |
| const compilerProps = new props.CompilerProps(languages, ceProps); |
| |
| const staticMaxAgeSecs = ceProps('staticMaxAgeSecs', 0); |
| const maxUploadSize = ceProps('maxUploadSize', '1mb'); |
| const extraBodyClass = ceProps('extraBodyClass', ''); |
| const httpRoot = ceProps('httpRoot', '/'); |
| |
| function staticHeaders(res) { |
| if (staticMaxAgeSecs) { |
| res.setHeader('Cache-Control', 'public, max-age=' + staticMaxAgeSecs + ', must-revalidate'); |
| } |
| } |
| |
| const csp = require('./lib/csp').policy; |
| |
| function contentPolicyHeader(res) { |
| if (csp) { |
| res.setHeader('Content-Security-Policy', csp); |
| } |
| } |
| |
| function getGoldenLayoutFromClientState(state) { |
| const goldenifier = new clientStateGoldenifier(); |
| goldenifier.fromClientState(state); |
| return goldenifier.golden; |
| } |
| |
| const awsProps = props.propsFor("aws"); |
| |
| aws.initConfig(awsProps) |
| .then(() => { |
| // function to load internal binaries (i.e. lib/source/*.js) |
| function loadSources() { |
| const sourcesDir = "lib/sources"; |
| return fs.readdirSync(sourcesDir) |
| .filter(file => file.match(/.*\.js$/)) |
| .map(file => require("./" + path.join(sourcesDir, file))); |
| } |
| |
| const fileSources = loadSources(); |
| const ClientOptionsHandler = require('./lib/options-handler'); |
| const clientOptionsHandler = new ClientOptionsHandler(fileSources, compilerProps, defArgs); |
| const CompilationEnvironment = require('./lib/compilation-env'); |
| const compilationEnvironment = new CompilationEnvironment(compilerProps, defArgs.doCache); |
| const CompileHandler = require('./lib/handlers/compile').Handler; |
| const compileHandler = new CompileHandler(compilationEnvironment); |
| const StorageHandler = require('./lib/storage/storage'); |
| const storageHandler = StorageHandler.storageFactory(compilerProps, awsProps); |
| const ApiHandler = require('./lib/handlers/api').Handler; |
| const apiHandler = new ApiHandler(compileHandler, ceProps, storageHandler); |
| const SourceHandler = require('./lib/handlers/source').Handler; |
| const sourceHandler = new SourceHandler(fileSources, staticHeaders); |
| const CompilerFinder = require('./lib/compiler-finder'); |
| const compilerFinder = new CompilerFinder(compileHandler, compilerProps, awsProps, defArgs); |
| |
| function oldGoogleUrlHandler(req, res, next) { |
| const resolver = new google.ShortLinkResolver(aws.getConfig('googleApiKey')); |
| const bits = req.url.split("/"); |
| if (bits.length !== 2 || req.method !== "GET") return next(); |
| const googleUrl = `http://goo.gl/${encodeURIComponent(bits[1])}`; |
| resolver.resolve(googleUrl) |
| .then(resultObj => { |
| const parsed = url.parse(resultObj.longUrl); |
| const allowedRe = new RegExp(ceProps('allowedShortUrlHostRe')); |
| if (parsed.host.match(allowedRe) === null) { |
| logger.warn(`Denied access to short URL ${bits[1]} - linked to ${resultObj.longUrl}`); |
| return next(); |
| } |
| res.writeHead(301, { |
| Location: resultObj.id, |
| 'Cache-Control': 'public' |
| }); |
| res.end(); |
| }) |
| .catch(e => { |
| logger.error(`Failed to expand ${googleUrl} - ${e}`); |
| next(); |
| }); |
| } |
| |
| function startListening(server) { |
| const ss = systemdSocket(); |
| let _port; |
| if (ss) { |
| // ms (5 min default) |
| const idleTimeout = process.env.IDLE_TIMEOUT; |
| const timeout = (typeof idleTimeout !== 'undefined' ? idleTimeout : 300) * 1000; |
| if (idleTimeout) { |
| let exit = () => { |
| logger.info("Inactivity timeout reached, exiting."); |
| process.exit(0); |
| }; |
| let idleTimer = setTimeout(exit, timeout); |
| let reset = () => { |
| clearTimeout(idleTimer); |
| idleTimer = setTimeout(exit, timeout); |
| }; |
| server.all('*', reset); |
| logger.info(` IDLE_TIMEOUT: ${idleTimeout}`); |
| } |
| _port = ss; |
| } else { |
| _port = defArgs.port; |
| } |
| logger.info(` Listening on http://${defArgs.hostname || 'localhost'}:${_port}/`); |
| logger.info("======================================="); |
| server.listen(_port, defArgs.hostname); |
| } |
| |
| compilerFinder.find() |
| .then(compilers => { |
| let prevCompilers; |
| |
| const ravenPrivateEndpoint = aws.getConfig('ravenPrivateEndpoint'); |
| if (ravenPrivateEndpoint) { |
| Raven.config(ravenPrivateEndpoint, { |
| release: gitReleaseName, |
| environment: defArgs.env |
| }).install(); |
| logger.info("Configured with raven endpoint", ravenPrivateEndpoint); |
| } else { |
| Raven.config(false).install(); |
| } |
| |
| function onCompilerChange(compilers) { |
| if (JSON.stringify(prevCompilers) === JSON.stringify(compilers)) { |
| return; |
| } |
| logger.debug("Compilers:", compilers); |
| if (compilers.length === 0) { |
| logger.error("#### No compilers found: no compilation will be done!"); |
| } |
| prevCompilers = compilers; |
| clientOptionsHandler.setCompilers(compilers); |
| apiHandler.setCompilers(compilers); |
| apiHandler.setLanguages(languages); |
| apiHandler.setOptions(clientOptionsHandler); |
| } |
| |
| onCompilerChange(compilers); |
| |
| const rescanCompilerSecs = ceProps('rescanCompilerSecs', 0); |
| if (rescanCompilerSecs) { |
| logger.info(`Rescanning compilers every ${rescanCompilerSecs} secs`); |
| setInterval(() => compilerFinder.find().then(onCompilerChange), |
| rescanCompilerSecs * 1000); |
| } |
| |
| const webServer = express(), |
| sFavicon = require('serve-favicon'), |
| bodyParser = require('body-parser'), |
| morgan = require('morgan'), |
| compression = require('compression'), |
| restreamer = require('./lib/restreamer'); |
| |
| logger.info("======================================="); |
| if (gitReleaseName) logger.info(` git release ${gitReleaseName}`); |
| const httpRootDir = httpRoot.endsWith('/') ? httpRoot : (httpRoot + '/'); |
| function renderConfig(extra) { |
| const options = _.extend(extra, clientOptionsHandler.get()); |
| options.compilerExplorerOptions = JSON.stringify(options); |
| options.extraBodyClass = extraBodyClass; |
| options.httpRoot = httpRoot; |
| options.require = function (path) { |
| if (isDevMode()) { |
| if (fs.existsSync('static/assets/' + path)) { |
| return '/assets/' + path; |
| } else { |
| //this will break assets in dev mode for now |
| return '/dist/' + path; |
| } |
| } |
| if (staticManifest.hasOwnProperty(path)) { |
| return `${httpRootDir}dist/${staticManifest[path]}`; |
| } |
| if (assetManifest.hasOwnProperty(path)) { |
| return `${httpRootDir}dist/assets/${assetManifest[path]}`; |
| } |
| logger.warn("Requested an asset I don't know about"); |
| }; |
| return options; |
| } |
| |
| function escapeLine(req, line) { |
| const userAgent = req.get('User-Agent'); |
| if (userAgent.includes('Discordbot/2.0')) { |
| return line.replace(/&/g, '&') |
| .replace(/</g, '<') |
| .replace(/>/g, '>'); |
| } else if (userAgent === 'Twitterbot/1.0') { |
| // TODO: Escape to something Twitter likes |
| return line; |
| } else if (userAgent === 'Slackbot-LinkExpanding 1.0') { |
| // TODO: Escape to something Slack likes |
| return line; |
| } |
| return line; |
| } |
| |
| function filterCode(req, code, lang) { |
| if (lang.previewFilter) { |
| return _.chain(code.split('\n')) |
| .filter(line => !line.match(lang.previewFilter)) |
| .map(line => escapeLine(req, line)) |
| .value() |
| .join('\n'); |
| } |
| return code; |
| } |
| |
| function storedStateHandlerResetLayout(req, res, next) { |
| const id = req.params.id; |
| storageHandler.expandId(id) |
| .then(result => { |
| let config = JSON.parse(result.config); |
| |
| if (config.content) { |
| const normalizer = new clientStateNormalizer(); |
| normalizer.fromGoldenLayout(config); |
| config = normalizer.normalized; |
| } else { |
| config = new clientState.State(config); |
| } |
| |
| config = getGoldenLayoutFromClientState(config); |
| |
| const metadata = { |
| ogDescription: result.specialMetadata ? result.specialMetadata.description.S : null, |
| ogAuthor: result.specialMetadata ? result.specialMetadata.author.S : null, |
| ogTitle: result.specialMetadata ? result.specialMetadata.title.S : "Compiler Explorer" |
| }; |
| if (!metadata.ogDescription) { |
| const sources = utils.glGetMainContents(config.content); |
| if (sources.editors.length === 1) { |
| const editor = sources.editors[0]; |
| const lang = languages[editor.language]; |
| if (lang) { |
| metadata.ogDescription = filterCode(req, editor.source, lang); |
| metadata.ogTitle += ` - ${lang.name}`; |
| if (sources.compilers.length === 1) { |
| const compilerId = sources.compilers[0].compiler; |
| const compiler = apiHandler.compilers.find(c => c.id === compilerId); |
| if (compiler) { |
| metadata.ogTitle += ` (${compiler.name})`; |
| } |
| } |
| } else { |
| metadata.ogDescription = editor.source; |
| } |
| } |
| } else if (metadata.ogAuthor && metadata.ogAuthor !== '.') { |
| metadata.ogDescription += `\nAuthor(s): ${metadata.ogAuthor}`; |
| } |
| staticHeaders(res); |
| contentPolicyHeader(res); |
| res.render('index', renderConfig({ |
| embedded: false, |
| config: config, |
| metadata: metadata |
| })); |
| }) |
| .catch(err => { |
| logger.warn(`Exception thrown when expanding ${id}: `, err); |
| next({ |
| statusCode: 404, |
| message: `ID "${id}" could not be found` |
| }); |
| }); |
| } |
| |
| function storedStateHandler(req, res, next) { |
| const id = req.params.id; |
| storageHandler.expandId(id) |
| .then(result => { |
| let config = JSON.parse(result.config); |
| if (config.sessions) { |
| config = getGoldenLayoutFromClientState(new clientState.State(config)); |
| } |
| const metadata = { |
| ogDescription: result.specialMetadata ? result.specialMetadata.description.S : null, |
| ogAuthor: result.specialMetadata ? result.specialMetadata.author.S : null, |
| ogTitle: result.specialMetadata ? result.specialMetadata.title.S : "Compiler Explorer" |
| }; |
| if (!metadata.ogDescription) { |
| const sources = utils.glGetMainContents(config.content); |
| if (sources.editors.length === 1) { |
| const editor = sources.editors[0]; |
| const lang = languages[editor.language]; |
| if (lang) { |
| metadata.ogDescription = filterCode(req, editor.source, lang); |
| metadata.ogTitle += ` - ${lang.name}`; |
| if (sources.compilers.length === 1) { |
| const compilerId = sources.compilers[0].compiler; |
| const compiler = apiHandler.compilers.find(c => c.id === compilerId); |
| if (compiler) { |
| metadata.ogTitle += ` (${compiler.name})`; |
| } |
| } |
| } else { |
| metadata.ogDescription = editor.source; |
| } |
| } |
| } else if (metadata.ogAuthor && metadata.ogAuthor !== '.') { |
| metadata.ogDescription += `\nAuthor(s): ${metadata.ogAuthor}`; |
| } |
| staticHeaders(res); |
| contentPolicyHeader(res); |
| res.render('index', renderConfig({ |
| embedded: false, |
| config: config, |
| metadata: metadata |
| })); |
| }) |
| .catch(err => { |
| logger.warn(`Exception thrown when expanding ${id}: `, err); |
| next({ |
| statusCode: 404, |
| message: `ID "${id}" could not be found` |
| }); |
| }); |
| } |
| |
| const embeddedHandler = function (req, res) { |
| staticHeaders(res); |
| contentPolicyHeader(res); |
| res.render('embed', renderConfig({embedded: true})); |
| }; |
| const healthCheck = require('./lib/handlers/health-check'); |
| if (isDevMode()) { |
| webServer.use(webpackDevMiddleware(webpackCompiler, { |
| publicPath: webpackConfig.output.publicPath, |
| logger: logger |
| })); |
| webServer.use(express.static(defArgs.staticDir)); |
| logger.info(" using webpack dev middleware"); |
| } else { |
| /* Assume that anything not dev is just production. |
| * This gives sane defaults for anyone who isn't messing with this */ |
| logger.info(" serving static files from '" + defArgs.staticDir + "'"); |
| webServer.use(express.static(defArgs.staticDir, {maxAge: staticMaxAgeSecs * 1000})); |
| } |
| |
| morgan.token('gdpr_ip', req => utils.anonymizeIp(req.ip)); |
| |
| // Based on combined format, but: GDPR compliant IP, no timestamp & no unused fields for our usecase |
| const morganFormat = isDevMode() ? 'dev' : ':gdpr_ip ":method :url" :status'; |
| |
| webServer |
| .use(Raven.requestHandler()) |
| .set('trust proxy', true) |
| .set('view engine', 'pug') |
| // before morgan so healthchecks aren't logged |
| .use('/healthcheck', new healthCheck.HealthCheckHandler().handle) |
| .use(morgan(morganFormat, { |
| stream: logger.stream, |
| // Skip for non errors (2xx, 3xx) |
| skip: (req, res) => res.statusCode >= 400 |
| })) |
| .use(morgan(morganFormat, { |
| stream: logger.warnStream, |
| // Skip for non user errors (4xx) |
| skip: (req, res) => res.statusCode < 400 || res.statusCode >= 500 |
| })) |
| .use(morgan(morganFormat, { |
| stream: logger.errStream, |
| // Skip for non server errors (5xx) |
| skip: (req, res) => res.statusCode < 500 |
| })) |
| .use(compression()) |
| .get('/', (req, res) => { |
| staticHeaders(res); |
| contentPolicyHeader(res); |
| res.render('index', renderConfig({embedded: false})); |
| }) |
| .get('/e', embeddedHandler) |
| // legacy. not a 301 to prevent any redirect loops between old e links and embed.html |
| .get('/embed.html', embeddedHandler) |
| .get('/embed-ro', (req, res) => { |
| staticHeaders(res); |
| contentPolicyHeader(res); |
| res.render('embed', renderConfig({embedded: true, readOnly: true})); |
| }) |
| .get('/robots.txt', (req, res) => { |
| staticHeaders(res); |
| res.end('User-agent: *\nSitemap: https://godbolt.org/sitemap.xml\nDisallow:'); |
| }) |
| .get('/sitemap.xml', (req, res) => { |
| staticHeaders(res); |
| res.set('Content-Type', 'application/xml'); |
| res.render('sitemap'); |
| }) |
| .use(sFavicon(path.join(defArgs.staticDir, webpackConfig.output.publicPath, 'favicon.ico'))) |
| .use(bodyParser.json({limit: ceProps('bodyParserLimit', maxUploadSize)})) |
| .use(bodyParser.text({limit: ceProps('bodyParserLimit', maxUploadSize), type: () => true})) |
| .use(restreamer()) |
| .use('/source', sourceHandler.handle.bind(sourceHandler)) |
| .use('/api', apiHandler.handle) |
| .use('/g', oldGoogleUrlHandler) |
| .get('/z/:id', storedStateHandler) |
| .get('/resetlayout/:id', storedStateHandlerResetLayout) |
| .post('/shortener', storageHandler.handler.bind(storageHandler)) |
| .use((req, res, next) => { |
| next({status: 404, message: `page "${req.path}" could not be found`}); |
| }) |
| .use((err, req, res, next) => { |
| Raven.errorHandler()(err, req, res, next); |
| }) |
| // eslint-disable-next-line no-unused-vars |
| .use((err, req, res, next) => { |
| const status = |
| err.status || |
| err.statusCode || |
| err.status_code || |
| (err.output && err.output.statusCode) || |
| 500; |
| const message = err.message || 'Internal Server Error'; |
| res.status(status); |
| res.render('error', renderConfig({ error: {code: status, message: message} })); |
| }) |
| .on('error', err => logger.error('Caught error:', err, "(in web handler; continuing)")); |
| if (!defArgs.doCache) { |
| logger.info(" with disabled caching"); |
| } |
| startListening(webServer); |
| }) |
| .catch(err => { |
| logger.error("Promise error:", err, "(shutting down)"); |
| process.exit(1); |
| }); |
| }) |
| .catch(err => { |
| logger.error("AWS Init Promise error", err, "(shutting down)"); |
| process.exit(1); |
| }); |