blob: be405188a73d95c16e070676340a5f01b9c3847f [file] [log] [blame] [raw]
// Copyright (c) 2019, Compiler Explorer Authors
// 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.
const
_ = require('underscore'),
utils = require('../utils'),
logger = require('../logger').logger,
ApiHandler = require('./api').Handler,
clientState = require('../clientstate'),
clientStateGoldenifier = require('../clientstate-normalizer').ClientStateGoldenifier,
clientStateNormalizer = require('../clientstate-normalizer').ClientStateNormalizer;
class RouteAPI {
constructor(router, compileHandler, ceProps, storageHandler, renderGoldenLayout) {
this.router = router;
this.renderGoldenLayout = renderGoldenLayout;
this.storageHandler = storageHandler;
this.apiHandler = new ApiHandler(compileHandler, ceProps, storageHandler);
}
InitializeRoutes() {
this.router
.use('/api', this.apiHandler.handle)
.get('/z/:id', _.bind(this.storedStateHandler, this))
.get('/z/:id/code/:session', _.bind(this.storedCodeHandler, this))
.get('/resetlayout/:id', _.bind(this.storedStateHandlerResetLayout, this))
.get('/clientstate/:clientstatebase64', _.bind(this.unstoredStateHandler, this));
}
storedCodeHandler(req, res, next) {
const id = req.params.id;
const sessionid = parseInt(req.params.session);
this.storageHandler.expandId(id)
.then(result => {
const config = JSON.parse(result.config);
let clientstate = false;
if (config.content) {
const normalizer = new clientStateNormalizer();
normalizer.fromGoldenLayout(config);
clientstate = normalizer.normalized;
} else {
clientstate = new clientState.ClientState(config);
}
const session = clientstate.findSessionById(sessionid);
if (!session) throw {msg: `Session ${sessionid} doesn't exist in this shortlink`};
res.set('Content-Type', 'text/plain');
res.end(session.source);
})
.catch(err => {
logger.debug(`Exception thrown when expanding ${id}: `, err);
next({
statusCode: 404,
message: `ID "${id}/${sessionid}" could not be found`
});
});
}
storedStateHandler(req, res, next) {
const id = req.params.id;
this.storageHandler.expandId(id)
.then(result => {
let config = JSON.parse(result.config);
if (config.sessions) {
config = this.getGoldenLayoutFromClientState(new clientState.State(config));
}
const metadata = this.getMetaDataFromLink(req, result, config);
this.renderGoldenLayout(config, metadata, req, res);
// And finally, increment the view count
// If any errors pop up, they are just logged, but the response should still be valid
// It's really unlikely that it happens as a result of the id not being there though,
// but can be triggered with a missing implementation for a derived storage (s3/local...)
this.storageHandler.incrementViewCount(id).catch(err => {
logger.error(`Error incrementing view counts for ${id} - ${err}`);
});
})
.catch(err => {
logger.warn(`Could not expand ${id}: ${err}`);
next({
statusCode: 404,
message: `ID "${id}" could not be found`
});
});
}
getGoldenLayoutFromClientState(state) {
const goldenifier = new clientStateGoldenifier();
goldenifier.fromClientState(state);
return goldenifier.golden;
}
unstoredStateHandler(req, res) {
const state = JSON.parse(Buffer.from(req.params.clientstatebase64, 'base64').toString());
const config = this.getGoldenLayoutFromClientState(new clientState.State(state));
const metadata = this.getMetaDataFromLink(req, null, config);
this.renderGoldenLayout(config, metadata, req, res);
}
renderClientState(clientstate, metadata, req, res) {
const config = this.getGoldenLayoutFromClientState(clientstate);
this.renderGoldenLayout(config, metadata, req, res);
}
storedStateHandlerResetLayout(req, res, next) {
const id = req.params.id;
this.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);
}
const metadata = this.getMetaDataFromLink(req, result, config);
this.renderClientState(config, metadata, req, res);
})
.catch(err => {
logger.warn(`Exception thrown when expanding ${id}`);
logger.debug('Exception value:', err);
next({
statusCode: 404,
message: `ID "${id}" could not be found`
});
});
}
escapeLine(req, line) {
const userAgent = req.get('User-Agent');
if (userAgent.includes('Discordbot/2.0')) {
return line.replace(/&/g, '&')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;');
} else if (userAgent === 'Twitterbot/1.0') {
// TODO: Escape to something Twitter likes
return line;
} else if (userAgent.includes('Slackbot-LinkExpanding 1.0')) {
// TODO: Escape to something Slack likes
return line;
}
return line;
}
filterCode(req, code, lang) {
if (lang.previewFilter) {
return _.chain(code.split('\n'))
.filter(line => !line.match(lang.previewFilter))
.map(line => this.escapeLine(req, line))
.value()
.join('\n');
}
return code;
}
getMetaDataFromLink(req, link, config) {
const metadata = {
ogDescription: null,
ogAuthor: null,
ogTitle: "Compiler Explorer"
};
if (link) {
metadata.ogDescription = link.specialMetadata ? link.specialMetadata.description.S : null;
metadata.ogAuthor = link.specialMetadata ? link.specialMetadata.author.S : null;
metadata.ogTitle = link.specialMetadata ? link.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 = this.apiHandler.languages[editor.language];
if (lang) {
metadata.ogDescription = this.filterCode(req, editor.source, lang);
metadata.ogTitle += ` - ${lang.name}`;
if (sources.compilers.length === 1) {
const compilerId = sources.compilers[0].compiler;
const compiler = this.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}`;
}
return metadata;
}
}
module.exports = RouteAPI;