refactor(commands): commands now store all info about themselves

Makes it easier to modify a command

Each command exports an object:
{
  directive: string or array of commands that call this handler
  handler: function to process the command
  syntax: string of how to call the command
  description: human readable explaination of command
  flags: optional object of flags
}

README.md

@@ -60,10 +60,10 @@ __whitelist__ : `[]`
 
 __file_format__ : `ls`
 > Format to use for [file stat](https://nodejs.org/api/fs.html#fs_class_fs_stats) responses (such as with the `LIST` command).  
-Possible values:
-- `ls` : [bin/ls format](https://cr.yp.to/ftp/list/binls.html)
-- `ep` : [Easily Parsed LIST format](https://cr.yp.to/ftp/list/eplf.html)
-- `function` : pass in your own format function, returning a string:  
+Possible values:  
+ `ls` : [bin/ls format](https://cr.yp.to/ftp/list/binls.html)  
+ `ep` : [Easily Parsed LIST format](https://cr.yp.to/ftp/list/eplf.html)  
+ `function` : pass in your own format function, returning a string:  
 `function (fileStats) { ... }`
 
 __log__ : `bunyan`

package.json

@@ -6,6 +6,7 @@
     "ftp",
     "ftp-server",
     "ftp-srv",
+    "ftp-svr",
     "ftpd",
     "server"
   ],

src/commands/index.js

@@ -1,10 +1,12 @@
 const _ = require('lodash');
 const when = require('when');
 
+const REGISTRY = require('./registry');
+
 class FtpCommands {
   constructor(connection) {
+    console.log(REGISTRY)
     this.connection = connection;
-    this.registry = require('./registry');
     this.previousCommand = {};
     this.blacklist = _.get(this.connection, 'server.options.blacklist', []).map(cmd => _.upperCase(cmd));
     this.whitelist = _.get(this.connection, 'server.options.whitelist', []).map(cmd => _.upperCase(cmd));
@@ -14,7 +16,7 @@ class FtpCommands {
     const log = this.connection.log.child({command});
     log.trace('Handle command');
 
-    if (!this.registry.hasOwnProperty(command.directive)) {
+    if (!REGISTRY.hasOwnProperty(command.directive)) {
       return this.connection.reply(402, 'Command not allowed');
     }
 
@@ -26,8 +28,9 @@ class FtpCommands {
       return this.connection.reply(502, 'Command not whitelisted');
     }
 
-    const commandRegister = this.registry[command.directive];
-    if (!commandRegister.no_auth && !this.connection.authenticated) {
+    const commandRegister = REGISTRY[command.directive];
+    const commandFlags = _.get(commandRegister, 'flags', {});
+    if (!commandFlags.no_auth && !this.connection.authenticated) {
       return this.connection.reply(530);
     }
 

src/commands/registration/allo.js

@@ -0,0 +1,11 @@
+module.exports = {
+  directive: 'ALLO',
+  handler: function () {
+    return this.reply(202);
+  },
+  syntax: '{{cmd}}',
+  description: 'Allocate sufficient disk space to receive a file',
+  flags: {
+    obsolete: true
+  }
+};

src/commands/registration/appe.js

@@ -0,0 +1,10 @@
+const stor = require('./stor').handler;
+
+module.exports = {
+  directive: 'APPE',
+  handler: function (args) {
+    return stor.call(this, args);
+  },
+  syntax: '{{cmd}} [path]',
+  description: 'Append to a file'
+}

src/commands/registration/auth.js

@@ -0,0 +1,27 @@
+const _ = require('lodash');
+
+module.exports = {
+  directive: 'AUTH',
+  handler: function ({command} = {}) {
+    const method = _.upperCase(command._[1]);
+
+    switch (method) {
+      case 'TLS': return handleTLS.call(this);
+      case 'SSL': return handleSSL.call(this);
+      default: return this.reply(504);
+    }
+  },
+  syntax: '{{cmd}} [type]',
+  description: 'Set authentication mechanism',
+  flags: {
+    no_auth: true
+  }
+}
+
+function handleTLS() {
+  return this.reply(504);
+}
+
+function handleSSL() {
+  return this.reply(504);
+}

src/commands/registration/cdup.js

@@ -0,0 +1,11 @@
+const cwd = require('./cwd').handler;
+
+module.exports = {
+  directive: ['CDUP', 'XCUP'],
+  handler: function(args) {
+    args.command._ = [args.command._[0], '..'];
+    return cwd.call(this, args);
+  },
+  syntax: '{{cmd}}',
+  description: 'Change to Parent Directory'
+}