Windshaft-cartodb/lib/cartodb/server_options.js

var _ = require('underscore');
var Step = require('step');
var QueryTablesApi = require('./api/query_tables_api');
var PgConnection = require('./backends/pg_connection');
var crypto = require('crypto');
var LZMA = require('lzma').LZMA;
var TemplateMaps = require('./template_maps.js');
var MapConfigNamedLayersAdapter = require('./models/mapconfig_named_layers_adapter');

// This is for backward compatibility with 1.3.3
if ( _.isUndefined(global.environment.sqlapi.domain) ) {
  // Only use "host" as "domain" if it contains alphanumeric characters
  var host = global.environment.sqlapi.host;
  if ( host && host.match(/[a-zA-Z]/) ) {
    global.environment.sqlapi.domain = host;
  }
}

// Whitelist query parameters and attach format
var REQUEST_QUERY_PARAMS_WHITELIST = [
    'sql',
    'geom_type',
    'cache_buster',
    'cache_policy',
    'callback',
    'interactivity',
    'map_key',
    'api_key',
    'auth_token',
    'style',
    'style_version',
    'style_convert',
    'config',
    'scale_factor'
];

module.exports = function(redisPool) {
    redisPool = redisPool ||
        require('redis-mpool')(_.extend(global.environment.redis, {name: 'windshaft:server_options'}));

    var cartoData = require('cartodb-redis')({ pool: redisPool }),
        lzmaWorker = new LZMA(),
        pgConnection = new PgConnection(cartoData),
        queryTablesApi = new QueryTablesApi(pgConnection, cartoData);

    var rendererConfig = _.defaults(global.environment.renderer || {}, {
        cache_ttl: 60000, // milliseconds
        metatile: 4,
        bufferSize: 64,
        statsInterval: 60000
    });

    var me = {
        // This is for inline maps and table maps
        base_url: global.environment.base_url_legacy || '/tiles/:table',

        /// @deprecated with Windshaft-0.17.0
        ///base_url_notable: '/tiles',

        // This is for Detached maps
        //
        // "maps" is the official, while
        // "tiles/layergroup" is for backward compatibility up to 1.6.x
        //
        base_url_mapconfig: global.environment.base_url_detached || '(?:/maps|/tiles/layergroup)',

        grainstore: {
          map: {
            // TODO: allow to specify in configuration
            srid: 3857
          },
          datasource: global.environment.postgres,
          cachedir: global.environment.millstone.cache_basedir,
          mapnik_version: global.environment.mapnik_version,
          mapnik_tile_format: global.environment.mapnik_tile_format || 'png',
          default_layergroup_ttl: global.environment.mapConfigTTL || 7200, 
          gc_prob: 0.01 // @deprecated since Windshaft-1.8.0
        },
        mapnik: {
          poolSize: rendererConfig.poolSize,
          metatile: rendererConfig.metatile,
          bufferSize: rendererConfig.bufferSize
        },
        statsd: global.environment.statsd,
        renderCache: {
            ttl: rendererConfig.cache_ttl,
            statsInterval: rendererConfig.statsInterval
        },
        renderer: {
            http: rendererConfig.http
        },
        redis: global.environment.redis,
        enable_cors: global.environment.enable_cors,
        varnish_host: global.environment.varnish.host,
        varnish_port: global.environment.varnish.port,
        varnish_http_port: global.environment.varnish.http_port,
        varnish_secret: global.environment.varnish.secret,
        varnish_purge_enabled: global.environment.varnish.purge_enabled,
        cache_enabled: global.environment.cache_enabled,
        log_format: global.environment.log_format,
        useProfiler: global.environment.useProfiler
    };
    
    // Do not send unwatch on release
    // See http://github.com/CartoDB/Windshaft-cartodb/issues/161
    me.redis.unwatchOnRelease = false;

    // Re-use redisPool
    me.redis.pool = redisPool;

    // Re-use pgConnection
    me.pgConnection = pgConnection;

    var templateMaps = new TemplateMaps(redisPool, {
        max_user_templates: global.environment.maxUserTemplates
    });
    me.templateMaps = templateMaps;

    var mapConfigNamedLayersAdapter = new MapConfigNamedLayersAdapter(templateMaps);

/* This whole block is about generating X-Cache-Channel { */

    // TODO: review lifetime of elements of this cache
    // NOTE: by-token indices should only be dropped when
    //       the corresponding layegroup is dropped, because
    //       we have no SQL after layer creation.
    me.channelCache = {};

    me.buildCacheChannel = function (dbName, tableNames){
      return dbName + ':' + tableNames.join(',');
    };

    me.generateMD5 = function(data){
        var hash = crypto.createHash('md5');
        hash.update(data);
        return hash.digest('hex');
    };

    me.generateCacheChannel = function(app, req, callback){

      // Build channelCache key
      var dbName = req.params.dbname;
      var cacheKey = [ dbName ];
      if ( req.params.token ) cacheKey.push(req.params.token);
      else if ( req.params.sql ) cacheKey.push( me.generateMD5(req.params.sql) );
      cacheKey = cacheKey.join(':');

      var that = this;

      Step (
        function checkCached() {
          if ( me.channelCache.hasOwnProperty(cacheKey) ) {
            callback(null, me.channelCache[cacheKey]);
            return;
          }
          return null;
        },
        function extractSQL(err) {
          if ( err ) throw err;

          if ( req.params.token ) {
            // TODO: cached cache channel for token-based access should
            //       be constructed at renderer cache creation time
            // See http://github.com/CartoDB/Windshaft-cartodb/issues/152
            if ( ! app.mapStore ) {
              throw new Error('missing channel cache for token ' + req.params.token);
            }
            var next = this;
            var mapStore = app.mapStore;
            Step(
              function loadFromStore() {
                mapStore.load(req.params.token, this);
              },
              function getSQL(err, mapConfig) {
                if (req.profiler) req.profiler.done('mapStore_load');
                if ( err ) throw err;
                var sql = [];
                _.each(mapConfig.obj().layers, function(lyr) {
                  sql.push(lyr.options.sql);
                });
                sql = sql.join(';');
                return sql;
              },
              function finish(err, sql) {
                next(err, sql);
              }
            );
            return;
          }

          if ( ! req.params.sql ) {
            return null; // no sql
          }

          // We have sql, and no token...

          // strip out windshaft/mapnik inserted sql if present
          var sql = req.params.sql.match(/^\((.*)\)\sas\scdbq$/);
          sql = (sql !== null) ? sql[1] : req.params.sql;

          return sql;
        },
        function findAffectedTables(err, sql) {
          if ( err ) throw err;
          if ( ! sql ) {
            if ( ! req.params.table ) {
              throw new Error("this request doesn't need an X-Cache-Channel generated");
            }
            return [req.params.table];
          }

          queryTablesApi.getAffectedTablesInQuery(that.userByReq(req), sql, this); // in addCacheChannel
        },
        function buildCacheChannel(err, tableNames) {
          if ( err ) throw err;
          if (req.profiler && ! req.params.table ) {
            req.profiler.done('affectedTables');
          }

          var dbName     = req.params.dbname;
          var cacheChannel = me.buildCacheChannel(dbName,tableNames);
          // store for caching from me.generateCacheChannel
          // (not worth when table was specified in params)
          if ( ! req.params.table ) {
            me.channelCache[cacheKey] = cacheChannel;
          }
          return cacheChannel;
        },
        function finish(err, cacheChannel) {
          callback(err, cacheChannel);
        }
      );
    };

    // Set the cache chanel info to invalidate the cache on the frontend server
    //
    // @param req The request object.
    //            The function will have no effect unless req.res exists.
    //            It is expected that req.params contains 'table' and 'dbname'
    //
    // @param cb function(err, channel) will be called when ready.
    //           the channel parameter will be null if nothing was added
    //
    me.addCacheChannel = function(app, req, cb) {
        // skip non-GET requests, or requests for which there's no response
        if ( req.method != 'GET' || ! req.res ) { cb(null, null); return; }
        if (req.profiler) req.profiler.start('addCacheChannel');
        var res = req.res;
        var cache_policy = req.query.cache_policy;
        if ( req.params.token ) cache_policy = 'persist';
        if ( cache_policy == 'persist' ) {
          res.header('Cache-Control', 'public,max-age=31536000'); // 1 year
        } else {
          var ttl = global.environment.varnish.ttl || 86400;
          res.header('Cache-Control', 'no-cache,max-age='+ttl+',must-revalidate, public');
        }

        // Set Last-Modified header
        var lastUpdated;
        if ( req.params.cache_buster ) {
          // Assuming cache_buster is a timestamp
          // FIXME: store lastModified in the cache channel instead
          lastUpdated = new Date(parseInt(req.params.cache_buster));
        } else {
          lastUpdated = new Date();
        }
        res.header('Last-Modified', lastUpdated.toUTCString());

        me.generateCacheChannel(app, req, function(err, channel){
            if (req.profiler) req.profiler.done('generateCacheChannel');
            if (req.profiler) req.profiler.end();
            if ( ! err ) {
              res.header('X-Cache-Channel', channel);
              cb(null, channel);
            } else {
              console.log('ERROR generating cache channel: ' + ( err.message ? err.message : err ));
              // TODO: evaluate if we should bubble up the error instead
              cb(null, 'ERROR');
            }
        });
    };

    me.beforeLayergroupCreate = function(req, requestMapConfig, callback) {
        mapConfigNamedLayersAdapter.getLayers(this.userByReq(req), requestMapConfig.layers, pgConnection, function(err, layers, datasource) {
            if (err) {
                return callback(err);
            }

            requestMapConfig.layers = layers;
            return callback(null, requestMapConfig, datasource);
        });
    };

    me.afterLayergroupCreate = function(req, mapconfig, response, callback) {
        var token = response.layergroupid;

        var username = this.userByReq(req);

        var tasksleft = 2; // redis key and affectedTables
        var errors = [];

        var done = function(err) {
          if ( err ) {
            errors.push('' + err);
          }
          if ( ! --tasksleft ) {
            err = errors.length ? new Error(errors.join('\n')) : null;
            callback(err);
          }
        };

        // include in layergroup response the variables in serverMedata
        // those variables are useful to send to the client information
        // about how to reach this server or information about it
        var serverMetadata = global.environment.serverMetadata;
        if (serverMetadata) {
          _.extend(response, serverMetadata);
        }

        // Don't wait for the mapview count increment to
        // take place before proceeding. Error will be logged
        // asyncronously
        cartoData.incMapviewCount(username, mapconfig.stat_tag, function(err) {
          if (req.profiler) req.profiler.done('incMapviewCount');
          if ( err ) console.log("ERROR: failed to increment mapview count for user '" + username + "': " + err);
          done();
        });

        var sql = mapconfig.layers.map(function(layer) {
            return layer.options.sql;
        }).join(';');

        var dbName = req.params.dbname;
        var cacheKey = dbName + ':' + token;

        Step(
            function getAffectedTablesAndLastUpdatedTime() {
                queryTablesApi.getAffectedTablesAndLastUpdatedTime(username, sql, this);
            },
            function handleAffectedTablesAndLastUpdatedTime(err, result) {
                if (req.profiler) req.profiler.done('queryTablesAndLastUpdated');
                if ( err ) throw err;
                var cacheChannel = me.buildCacheChannel(dbName, result.affectedTables);
                me.channelCache[cacheKey] = cacheChannel;

                if (req.res && req.method == 'GET') {
                    var res = req.res;
                    if ( req.query && req.query.cache_policy == 'persist' ) {
                        res.header('Cache-Control', 'public,max-age=31536000'); // 1 year
                    } else {
                        var ttl = global.environment.varnish.layergroupTtl || 86400;
                        res.header('Cache-Control', 'public,max-age='+ttl+',must-revalidate');
                    }
                    res.header('Last-Modified', (new Date()).toUTCString());
                    res.header('X-Cache-Channel', cacheChannel);
                }

                // last update for layergroup cache buster
                response.layergroupid = response.layergroupid + ':' + result.lastUpdatedTime;
                response.last_updated = new Date(result.lastUpdatedTime).toISOString();
                return null;
            },
            function finish(err) {
                done(err);
            }
        );
    };

/* X-Cache-Channel generation } */

    me.re_userFromHost = new RegExp(
      global.environment.user_from_host ||
      '^([^\\.]+)\\.' // would extract "strk" from "strk.cartodb.com"
    );

    me.userByReq = function(req) {
      var host = req.headers.host;
      var mat = host.match(this.re_userFromHost);
      if ( ! mat ) {
        console.error("ERROR: user pattern '" + this.re_userFromHost + "' does not match hostname '" + host + "'");
        return;
      }
      // console.log("Matches: "); console.dir(mat);
      if ( mat.length !== 2 ) {
        console.error("ERROR: pattern '" + this.re_userFromHost + "' gave unexpected matches against '" + host + "': " +
            mat);
        return;
      }
      return mat[1];
    };

    // Check if a request is authorized by a signer
    //
    // @param req express request object
    // @param callback function(err, signed_by) signed_by will be
    //                 null if the request is not signed by anyone
    //                 or will be a string cartodb username otherwise.
    //                 
    me.authorizedBySigner = function(req, callback)
    {
      if ( ! req.params.token || ! req.params.signer ) {
        //console.log("No signature provided"); // debugging
        callback(null, null); // no signer requested
        return;
      }

      var signer = req.params.signer;
      var layergroup_id = req.params.token;
      var auth_token = req.params.auth_token;

      //console.log("Checking authorization from signer " + signer + " for resource " + layergroup_id + " with auth_token " + auth_token);
      var mapStore = req.app.mapStore;
      if (!mapStore) {
          throw new Error('Unable to retrieve map configuration token');
      }

      mapStore.load(layergroup_id, function(err, mapConfig) {
        if (err) {
          throw err;
        }

        var authorized = me.templateMaps.isAuthorized(mapConfig.obj().template, auth_token);
        callback(null, authorized ? signer : null);
      });

    };

    // Check if a request is authorized by api_key
    //
    // @param req express request object
    // @param callback function(err, authorized) 
    //        NOTE: authorized is expected to be 0 or 1 (integer)
    //                 
    me.authorizedByAPIKey = function(req, callback)
    {
        var givenKey = req.query.api_key || req.query.map_key;
        if ( ! givenKey && req.body ) {
          // check also in request body
          givenKey = req.body.api_key || req.body.map_key;
        }
        if ( ! givenKey ) {
          callback(null, 0); // no api key, no authorization...
          return;
        }
        //console.log("given ApiKey: " + givenKey);
        var user = me.userByReq(req);
        Step(
          function (){
              cartoData.getUserMapKey(user, this);
          },
          function checkApiKey(err, val){
              if (err) throw err;
              return ( val && givenKey == val ) ? 1 : 0;
          },
          function finish(err, authorized) {
              callback(err, authorized);
          }
        );
    };

    /**
     * Check access authorization
     *
     * @param req - standard req object. Importantly contains table and host information
     * @param callback function(err, allowed) is access allowed not?
     */
    me.authorize = function(req, callback) {
        var that = this;
        var user = me.userByReq(req);

        Step(
            function (){
                that.authorizedByAPIKey(req, this);
            },
            function checkApiKey(err, authorized){
                if (req.profiler) req.profiler.done('authorizedByAPIKey');
                if (err) throw err;

                // if not authorized by api_key, continue 
                if (authorized !== 1)  {
                  // not authorized by api_key, 
                  // check if authorized by signer
                  that.authorizedBySigner(req, this);
                  return;
                }

                _.extend(req.params, { _authorizedByApiKey: true });

                // authorized by api key, login as the given username and stop
                pgConnection.setDBAuth(user, req.params, function(err) {
                  callback(err, true); // authorized (or error)
                });
            },
            function checkSignAuthorized(err, signed_by){
                if (err) throw err;
                if (req.profiler) {
                  if ( req.params._authorizedByApiKey ) {
                    req.profiler.done('setDBAuth');
                  } else {
                    req.profiler.done('authorizedBySigner');
                  }
                }

                if ( ! signed_by ) {
                  // request not authorized by signer.
  
                  // if table was given, continue to check table privacy
                  if ( req.params.table ) return null;

                  // if no signer name was given, let dbparams and
                  // PostgreSQL do the rest.
                  // 
                  if ( ! req.params.signer ) {
                    callback(null, true); // authorized so far
                    return;
                  }

                  // if signer name was given, return no authorization
                  callback(null, false); 
                  return;
                }

                // Authorized by "signed_by" !
                _.extend(req.params, { _authorizedBySigner: signed_by });
                pgConnection.setDBAuth(signed_by, req.params, function(err) {
                  if (req.profiler) req.profiler.done('setDBAuth');
                  callback(err, true); // authorized (or error)
                });
            },
            function getDatabase(err){
                if (err) throw err;
                // NOTE: only used to get to table privacy
                cartoData.getUserDBName(user, this);
            },
            function getPrivacy(err, dbname){
                if (err) throw err;
                if (req.profiler) req.profiler.done('tablePrivacy_getUserDBName');
                cartoData.getTablePrivacy(dbname, req.params.table, this);
            },
            function(err, privacy){
                if (req.profiler) req.profiler.done('getTablePrivacy');
                callback(err, privacy !== "0");
            }
        );
    };

    /**
     * Whitelist input and get database name & default geometry type from
     * subdomain/user metadata held in CartoDB Redis
     * @param req - standard express request obj. Should have host & table
     * @param callback
     */
    me.req2params = function(req, callback){

        if ( req.query.lzma ) {

          // TODO: check ?
          //console.log("type of req.query.lzma is " + typeof(req.query.lzma));

          // Decode (from base64)
          var lzma = (new Buffer(req.query.lzma, 'base64').toString('binary')).split('').map(function(c) { return c.charCodeAt(0) - 128; });

          // Decompress
          lzmaWorker.decompress(
            lzma,
            function(result) {
              if (req.profiler) req.profiler.done('LZMA decompress');
              try {
                delete req.query.lzma;
                _.extend(req.query, JSON.parse(result));
                me.req2params(req, callback);
              } catch (err) {
                callback(new Error('Error parsing lzma as JSON: ' + err));
              }
            },
            function(/*percent*/) { // progress
              //console.log("LZMA decompression " + percent + "%");
            }
          );
          return;
        }

        var bad_query  = _.difference(_.keys(req.query), REQUEST_QUERY_PARAMS_WHITELIST);

        _.each(bad_query, function(key){ delete req.query[key]; });
        req.params =  _.extend({}, req.params); // shuffle things as request is a strange array/object

        var user = me.userByReq(req);

        if ( req.params.token ) {
          //console.log("Request parameters include token " + req.params.token);
          var tksplit = req.params.token.split(':');
          req.params.token = tksplit[0];
          if ( tksplit.length > 1 ) req.params.cache_buster= tksplit[1];
          tksplit = req.params.token.split('@');
          if ( tksplit.length > 1 ) {
            req.params.signer = tksplit.shift();
            if ( ! req.params.signer ) req.params.signer = user;
            else if ( req.params.signer !== user ) {
              var err = new Error('Cannot use map signature of user "' + req.params.signer + '" on database of user "' + user + '"');
              err.http_status = 403;
              callback(err);
              return;
            }
            if ( tksplit.length > 1 ) {
              /*var template_hash = */tksplit.shift(); // unused
            }
            req.params.token = tksplit.shift(); 
            //console.log("Request for token " + req.params.token + " with signature from " + req.params.signer);
          }
        }

        // bring all query values onto req.params object
        _.extend(req.params, req.query);

        // for cartodb, ensure interactivity is cartodb_id or user specified
        req.params.interactivity = req.params.interactivity || 'cartodb_id';

        if (req.profiler) req.profiler.done('req2params.setup');

        Step(
            function getPrivacy(){
                me.authorize(req, this);
            },
            function gatekeep(err, authorized){
                if (req.profiler) req.profiler.done('authorize');
                if(err) throw err;
                if(!authorized) {
                  err = new Error("Sorry, you are unauthorized (permission denied)");
                  err.http_status = 403;
                  throw err;
                }
                return null;
            },
            function getDatabase(err){
                if(err) throw err;
                pgConnection.setDBConn(user, req.params, this);
            },
            function getGeometryType(err){
                if (req.profiler) req.profiler.done('setDBConn');
                if (err) throw err;
                if ( ! req.params.table ) return null;
                cartoData.getTableGeometryType(req.params.dbname, req.params.table, this);
            },
            function finishSetup(err, data){
                if ( err ) { callback(err, req); return; }

                if (!_.isNull(data))
                    _.extend(req.params, {geom_type: data});

                // Add default database connection parameters
                // if none given
                _.defaults(req.params, {
                  dbuser: global.environment.postgres.user,
                  dbpassword: global.environment.postgres.password,
                  dbhost: global.environment.postgres.host,
                  dbport: global.environment.postgres.port
                });

                callback(null, req);
            }
        );
    };

    /**
     * Little helper method to get the current list of infowindow variables and return to client
     * @param req
     * @param callback
     */
    me.getInfowindow = function(req, callback){
        var that = this;
        var user = me.userByReq(req);

        Step(
            function(){
                // TODO: if this step really needed ?
                that.req2params(req, this);
            },
            function getDatabase(err){
                if (err) throw err;
                cartoData.getUserDBName(user, this);
            },
            function getInfowindow(err, dbname){
                if (err) throw err;
                cartoData.getTableInfowindow(dbname, req.params.table, this);
            },
            function(err, data){
                callback(err, data);
            }
        );
    };

    /**
     * Little helper method to get map metadata and return to client
     * @param req
     * @param callback
     */
    me.getMapMetadata = function(req, callback){
        var that = this;
        var user = me.userByReq(req);

        Step(
            function(){
                // TODO: if this step really needed ?
                that.req2params(req, this);
            },
            function getDatabase(err){
                if (err) throw err;
                cartoData.getUserDBName(user, this);
            },
            function getMapMetadata(err, dbname){
                if (err) throw err;
                cartoData.getTableMapMetadata(dbname, req.params.table, this);
            },
            function(err, data){
                callback(err, data);
            }
        );
    };

    return me;
};