actionhero/initializers/routes.js

actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks

module.exports = {
  loadPriority:  500,
  initialize: function(api, next){

    api.routes = {};
    api.routes.routes = {};

    api.routes.verbs = ['get', 'post', 'put', 'patch', 'delete'];

    ////////////////////////////////////////////////////////////////////////////
    // route processing for web clients
    api.routes.processRoute = function(connection, pathParts){
      if(connection.params.action === undefined || api.actions.actions[connection.params.action] === undefined){
        var method = connection.rawConnection.method.toLowerCase();
        if(method === 'head'){ method = 'get'; }
        for(var i in api.routes.routes[method]){
          var route = api.routes.routes[method][i];
          var match = api.routes.matchURL(pathParts, route.path);
          if(match.match === true){
            if(route.apiVersion){
              connection.params.apiVersion = connection.params.apiVersion || route.apiVersion;
            }
            
            for(var param in match.params){
              try{
                var decodedName = decodeURIComponent(param.replace(/\+/g, ' '));
                var decodedValue = decodeURIComponent(match.params[param].replace(/\+/g, ' '));
                connection.params[decodedName] = decodedValue;
              }catch(e){
                // malformed URL
              }
            }
            connection.params.action = route.action;
            break;
          }
        }
      }
    }

    api.routes.matchURL = function(pathParts, match){
      var response = {match: false, params: {} }
      var matchParts = match.split('/');
      var regexp = '';
      var variable = '';

      if(matchParts[0] === ''){ matchParts.splice(0, 1) }
      if(matchParts[(matchParts.length - 1)] === ''){ matchParts.pop() }

      if(matchParts.length !== pathParts.length){
        return response;
      }

      for(var i in matchParts){
        var part = matchParts[i];
        if(!pathParts[i]){
          return response;
        } else if(part[0] === ':' && part.indexOf('(') < 0){
          variable = part.replace(':', '');
          response.params[variable] = pathParts[i];
        } else if(part[0] === ':' && part.indexOf('(') >= 0){
          variable = part.replace(':', '').split('(')[0];
          regexp = part.substring(part.indexOf('(') + 1, part.length - 1);
          var matches = pathParts[i].match(new RegExp(regexp, 'g'));
          if(matches){
            response.params[variable] = pathParts[i];
          } else {
            return response;
          }
        } else {
          if(pathParts[i] === null || pathParts[i] === undefined || pathParts[i].toLowerCase() !== matchParts[i].toLowerCase()){
            return response;
          }
        }
      }

      response.match = true;
      return response;
    }


    api.routes.registerRoute = function(method, path, action, apiVersion) {
      api.routes.routes[method].push({ path: path, action: action, apiVersion:apiVersion});
    }

    // load in the routes file
    api.routes.loadRoutes = function(rawRoutes){
      var counter = 0;

      api.routes.routes = { 'get': [], 'post': [], 'put': [], 'patch' : [], 'delete': [] };

      if(!rawRoutes){
        if(api.config.routes){
          rawRoutes = api.config.routes;
        }
      }

      var v, verb;
      for(var i in rawRoutes){
        var method = i.toLowerCase();
        for(var j in rawRoutes[i]){
          var route = rawRoutes[i][j];
          if(method === 'all'){
            for(v in api.routes.verbs){
              verb = api.routes.verbs[v];
              api.routes.registerRoute(verb, route.path, route.action, route.apiVersion);
            }
          } else {
            api.routes.registerRoute(method, route.path, route.action, route.apiVersion);
          }
          counter++;
        }
      }

      api.params.postVariables = api.utils.arrayUniqueify(api.params.postVariables)
      api.log(counter + ' routes loaded from ' + api.routes.routesFile, 'trace');

      if(api.config.servers.web && api.config.servers.web.simpleRouting === true){
        var simplePaths = [];
        for(var action in api.actions.actions){
          simplePaths.push('/' + action);
          // api.routes.verbs.forEach(function(verb){
          for(v in api.routes.verbs){
            verb = api.routes.verbs[v];
            api.routes.registerRoute(verb, '/' + action, action);
          }
        }
        api.log(simplePaths.length + ' simple routes loaded from action names', 'trace');

        api.log('routes:', 'debug', api.routes.routes);
      }
    };

    api.routes.loadRoutes();
    next();
  }
}