Merge branch 'master' of github.com:seejohnrun/haste-server

Conflicts:
	static/function-icons.png

README.md

@@ -1,6 +1,9 @@
 # Haste
 
-Haste is an open-source pastebin software written in node.js, which is easily installable in any network.  It can be backed by either redis or filesystem, and has a very easy adapter interface for other stores.  A publicly available version can be found at [hastebin.com](http://hastebin.com)
+Haste is an open-source pastebin software written in node.js, which is easily
+installable in any network.  It can be backed by either redis or filesystem,
+and has a very easy adapter interface for other stores.  A publicly available
+version can be found at [hastebin.com](http://hastebin.com)
 
 Major design objectives:
 
@@ -8,11 +11,13 @@ Major design objectives:
 * Be really simple
 * Be easy to set up and use
 
-Haste works really well with a little utility called haste-client, allowing you to do things like:
+Haste works really well with a little utility called haste-client, allowing you
+to do things like:
 
 `cat something | haste`
 
-which will output a URL to share containing the contents of `cat something`'s STDOUT
+which will output a URL to share containing the contents of `cat something`'s
+STDOUT
 
 ## Tested Browsers
 
@@ -35,7 +40,8 @@ which will output a URL to share containing the contents of `cat something`'s ST
 * `maxLength` - maximum length of a paste (default none)
 * `staticMaxAge` - max age for static assets (86400)
 * `recompressStatisAssets` - whether or not to compile static js assets (true)
-* `documents` - static documents to serve (ex: http://hastebin.com/about.com) in addition to static assets.  These will never expire.
+* `documents` - static documents to serve (ex: http://hastebin.com/about.com)
+  in addition to static assets.  These will never expire.
 * `storage` - storage options (see below)
 * `logging` - logging preferences
 * `keyGenerator` - key generator options (see below)
@@ -63,13 +69,15 @@ Generates a random key
 }
 ```
 
-The _optional_ keySpace argument is a string of acceptable characters for the key.
+The _optional_ keySpace argument is a string of acceptable characters
+for the key.
 
 ## Storage
 
 ### File
 
-To use file storage (the default) change the storage section in `config.js` to something like:
+To use file storage (the default) change the storage section in `config.js` to
+something like:
 
 ``` json
 {
@@ -82,9 +90,9 @@ Where `path` represents where you want the files stored
 
 ### Redis
 
-To use redis storage you must install the redis package in npm globall using
+To use redis storage you must install the redis package in npm
 
-`npm install redis --global`
+`npm install redis`
 
 Once you've done that, your config section should look like:
 
@@ -97,10 +105,35 @@ Once you've done that, your config section should look like:
 }
 ```
 
-You can also set an `expire` option to the number of seconds to expire keys in.  This is off by default, but will constantly kick back expirations on each view or post.
+You can also set an `expire` option to the number of seconds to expire keys in.
+This is off by default, but will constantly kick back expirations on each view
+or post.
 
 All of which are optional except `type` with very logical default values.
 
+### Memcached
+
+To use memcached storage you must install the `memcache` package via npm
+
+`npm install memcache`
+
+Once you've done that, your config section should look like:
+
+``` json
+{
+	"type": "memcached",
+	"host": "127.0.0.1",
+	"port": 11211
+}
+```
+
+You can also set an `expire` option to the number of seconds to expire keys in.
+This behaves just like the redis expirations, but does not push expirations
+forward on GETs.
+
+All of which are optional except `type` with very logical default values.
+
+
 ## Author
 
 John Crepezzi <john.crepezzi@gmail.com>
@@ -111,11 +144,23 @@ John Crepezzi <john.crepezzi@gmail.com>
 
 Copyright © 2011 John Crepezzi
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the ‘Software’), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE
 
 ### Other components:
 

TODO.md

@@ -1 +0,0 @@
-* add feedback for errors to UI - esp. too long

about.md

@@ -1,33 +1,37 @@
 # Haste
 
 Sharing code is a good thing, and it should be _really_ easy to do it.
-A lot of times, I want to show you something I'm seeing - and that's where we use pastebins.
+A lot of times, I want to show you something I'm seeing - and that's where we
+use pastebins.
 
 Haste is the prettiest, easist to use pastebin ever made.
 
 ## Basic Usage
 
-Type what you want me to see, click "Save", and then copy the URL.  Send that URL
+Type what you want me to see, click "Save", and then copy the URL.  Send that
-to someone and they'll see what you see.
+URL to someone and they'll see what you see.
 
 To make a new entry, click "New" (or type 'control + n')
 
 ## From the Console
 
-Most of the time I want to show you some text, its coming from my current console session.
+Most of the time I want to show you some text, its coming from my current
-We should make it really easy to take code from the console and send it to people.
+console session.  We should make it really easy to take code from the console
+and send it to people.
 
 `cat something | haste` # http://hastebin.com/1238193
 
-You can even take this a step further, and cut out the last step of copying the URL with:
+You can even take this a step further, and cut out the last step of copying the
+URL with:
 
 * osx: `cat something | haste | pbcopy`
 * linux: `cat something | haste | xsel`
 
-After running that, the STDOUT output of `cat something` will show up at a URL which has
+After running that, the STDOUT output of `cat something` will show up at a URL
-been conveniently copied to your clipboard.
+which has been conveniently copied to your clipboard.
 
-That's all there is to that, and you can install it with `gem install haste` right now.
+That's all there is to that, and you can install it with `gem install haste`
+right now.
   * osx: you will need to have an up to date version of Xcode
   * linux: you will need to have rubygems and ruby-devel installed
 
@@ -37,9 +41,10 @@ Pastes will stay for 30 days from their last view.
 
 ## Privacy
 
-While the contents of hastebin.com are not directly crawled by any search robot that
+While the contents of hastebin.com are not directly crawled by any search robot
-obeys "robots.txt", there should be no great expectation of privacy.  Post things at your
+that obeys "robots.txt", there should be no great expectation of privacy.  Post
-own risk. Not responsible for any loss of data or removed pastes.
+things at your own risk. Not responsible for any loss of data or removed
+pastes.
 
 ## Open Source
 

lib/document_handler.js

@@ -60,7 +60,9 @@ DocumentHandler.prototype.handlePost = function(request, response) {
       cancelled = true;
       winston.warn('document >maxLength', { maxLength: _this.maxLength });
       response.writeHead(400, { 'content-type': 'application/json' });
-      response.end(JSON.stringify({ message: 'Document exceeds maximum length.' }));
+      response.end(
+        JSON.stringify({ message: 'Document exceeds maximum length.' })
+      );
     }
   });
   request.on('end', function(end) {
@@ -86,9 +88,9 @@ DocumentHandler.prototype.handlePost = function(request, response) {
   });
 };
 
-// Get a random key that hasn't been already used
+// Keep choosing keys until one isn't taken
 DocumentHandler.prototype.chooseKey = function(callback) {
-  var key = this.keyGenerator.createKey(this.keyLength);
+  var key = this.acceptableKey();
   var _this = this;
   this.store.get(key, function(ret) {
     if (ret) {
@@ -99,4 +101,8 @@ DocumentHandler.prototype.chooseKey = function(callback) {
   });
 };
 
+DocumentHandler.prototype.acceptableKey = function() {
+  return this.keyGenerator.createKey(this.keyLength);
+};
+
 module.exports = DocumentHandler;

lib/document_stores/file.js

@@ -1,7 +1,7 @@
 var fs = require('fs');
+var crypto = require('crypto');
 
 var winston = require('winston');
-var hashlib = require('hashlib');
 
 // For storing in files
 // options[type] = file
@@ -12,12 +12,21 @@ var FileDocumentStore = function(options) {
   this.expire = options.expire;
 };
 
-// Save data in a file, key as md5 - since we don't know what we could be passed here
+// Generate md5 of a string
+FileDocumentStore.md5 = function(str) {
+  var md5sum = crypto.createHash('md5');
+  md5sum.update(str);
+  return md5sum.digest('hex');
+};
+
+// Save data in a file, key as md5 - since we don't know what we could
+// be passed here
 FileDocumentStore.prototype.set = function(key, data, callback, skipExpire) {
   try {
     var _this = this;
     fs.mkdir(this.basePath, '700', function() {
-      fs.writeFile(_this.basePath + '/' + hashlib.md5(key), data, 'utf8', function(err) {
+      var fn = _this.basePath + '/' + _this.md5(key);
+      fs.writeFile(fn, data, 'utf8', function(err) {
         if (err) {
           callback(false);
         }
@@ -37,7 +46,8 @@ FileDocumentStore.prototype.set = function(key, data, callback, skipExpire) {
 // Get data from a file from key
 FileDocumentStore.prototype.get = function(key, callback, skipExpire) {
   var _this = this;
-  fs.readFile(this.basePath + '/' + hashlib.md5(key), 'utf8', function(err, data) {
+  var fn = this.basePath + '/' + this.md5(key);
+  fs.readFile(fn, 'utf8', function(err, data) {
     if (err) {
       callback(false);
     }

lib/document_stores/memcached.js

@@ -0,0 +1,45 @@
+var memcached = require('memcache');
+var winston = require('winston');
+
+// Create a new store with options
+var MemcachedDocumentStore = function(options) {
+  this.expire = options.expire;
+  if (!MemcachedDocumentStore.client) {
+    MemcachedDocumentStore.connect(options);
+  }
+};
+
+// Create a connection
+MemcachedDocumentStore.connect = function(options) {
+  var host = options.host || '127.0.0.1';
+  var port = options.port || 11211;
+  this.client = new memcached.Client(port, host);
+  this.client.connect();
+  this.client.on('connect', function() {
+    winston.info('connected to memcached on ' + host + ':' + port);
+  });
+  this.client.on('error', function(e) {
+    winston.info('error connecting to memcached', { error: e });
+  });
+};
+
+// Save file in a key
+MemcachedDocumentStore.prototype.set =
+function(key, data, callback, skipExpire) {
+  MemcachedDocumentStore.client.set(key, data, function(err, reply) {
+    err ? callback(false) : callback(true);
+  }, skipExpire ? 0 : this.expire);
+};
+
+// Get a file from a key
+MemcachedDocumentStore.prototype.get = function(key, callback, skipExpire) {
+  var _this = this;
+  MemcachedDocumentStore.client.get(key, function(err, reply) {
+    callback(err ? false : reply);
+    if (_this.expire && !skipExpire) {
+      winston.warn('store does not currently push forward expirations on GET');
+    }
+  });
+};
+
+module.exports = MemcachedDocumentStore;

lib/document_stores/redis.js

@@ -1,6 +1,5 @@
 var redis = require('redis');
 var winston = require('winston');
-var hashlib = require('hashlib');
 
 // For storing in redis
 // options[type] = redis
@@ -24,7 +23,10 @@ RedisDocumentStore.connect = function(options) {
   RedisDocumentStore.client = redis.createClient(port, host);
   RedisDocumentStore.client.select(index, function(err, reply) {
     if (err) {
-      winston.error('error connecting to redis index ' + index, { error: err.message });
+      winston.error(
+        'error connecting to redis index ' + index,
+        { error: err.message }
+      );
       process.exit(1);
     }
     else {

lib/key_generators/random.js

@@ -1,12 +1,17 @@
 var RandomKeyGenerator = function(options) {
+  if (!options) {
+    options = {};
+  }
   this.keyspace = options.keyspace || 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
 };
 
 // Generate a random key
 RandomKeyGenerator.prototype.createKey = function(keyLength) {
   var text = '';
+  var index;
   for (var i = 0; i < keyLength; i++) {
-    text += this.keyspace.charAt(Math.floor(Math.random() * this.keyspace.length));
+    index = Math.floor(Math.random() * this.keyspace.length);
+    text += this.keyspace.charAt(index);
   }
   return text;
 };

package.json

@@ -19,13 +19,13 @@
 
 	"dependencies": {
 		"winston": "*",
-    "hashlib": "*",
     "connect": "*",
     "uglify-js": "*"
 	},
 
 	"devDependencies": {
-    "jasmine-node": "*"
+    "mocha": "*",
+    "should": "*"
   },
 
 	"bundledDependencies": [],
@@ -46,7 +46,7 @@
 
 	"scripts": {
 		"start": "node server.js",
-    "test": "jasmine-node spec"
+    "test": "mocha -r should spec/*"
 	}
 
 }

server.js

@@ -34,7 +34,7 @@ if (!config.storage) {
 if (!config.storage.type) {
   config.storage.type = 'file';
 }
-var Store = require('./lib/' + config.storage.type + '_document_store');
+var Store = require('./lib/document_stores/' + config.storage.type);
 var preferredStore = new Store(config.storage);
 
 // Compress the static javascript assets
@@ -45,8 +45,10 @@ if (config.recompressStaticAssets) {
   for (var i = 0; i < list.length; i++) {
     var item = list[i];
     var orig_code, ast;
-    if ((item.indexOf('.js') === item.length - 3) && (item.indexOf('.min.js') === -1)) {
+    if ((item.indexOf('.js') === item.length - 3) &&
-      dest = item.substring(0, item.length - 3) + '.min' + item.substring(item.length - 3);
+        (item.indexOf('.min.js') === -1)) {
+      dest = item.substring(0, item.length - 3) + '.min' +
+        item.substring(item.length - 3);
       orig_code = fs.readFileSync('./static/' + item, 'utf8');
       ast = jsp.parse(orig_code);
       ast = pro.ast_mangle(ast);
@@ -67,7 +69,10 @@ for (var name in config.documents) {
       }, true);
     }
     else {
-      winston.warn('failed to load static document', { name: name, path: path });
+      winston.warn(
+        'failed to load static document',
+        { name: name, path: path }
+      );
     }
   });
 }
@@ -103,7 +108,11 @@ connect.createServer(
     // get documents
     app.get('/documents/:id', function(request, response, next) {
       var skipExpire = !!config.documents[request.params.id];
-      return documentHandler.handleGet(request.params.id, response, skipExpire);
+      return documentHandler.handleGet(
+        request.params.id,
+        response,
+        skipExpire
+      );
     });
   }),
   // Otherwise, static

spec/document_handler_spec.js

@@ -1,17 +1,20 @@
 var DocumentHandler = require('../lib/document_handler');
+var Generator = require('../lib/key_generators/random');
 
 describe('document_handler', function() {
 
   describe('randomKey', function() {
 
     it('should choose a key of the proper length', function() {
-      var dh = new DocumentHandler({ keyLength: 6 });
+      var gen = new Generator();
-      expect(dh.randomKey().length).toBe(6);
+      var dh = new DocumentHandler({ keyLength: 6, keyGenerator: gen });
+      dh.acceptableKey().length.should.equal(6);
     });
 
     it('should choose a default key length', function() {
-      var dh = new DocumentHandler();
+      var gen = new Generator();
-      expect(dh.keyLength).toBe(DocumentHandler.defaultKeyLength);
+      var dh = new DocumentHandler({ keyGenerator: gen });
+      dh.keyLength.should.equal(DocumentHandler.defaultKeyLength);
     });
 
   });

spec/redis_document_store_spec.js

@@ -1,4 +1,4 @@
-var RedisDocumentStore = require('../lib/redis_document_store');
+var RedisDocumentStore = require('../lib/document_stores/redis');
 
 var winston = require('winston');
 winston.remove(winston.transports.Console);
@@ -15,73 +15,34 @@ describe('redis_document_store', function() {
   
   describe('set', function() {
 
-    it('should be able to set a key and have an expiration set', function() {
+    it('should be able to set a key and have an expiration set', function(done) {
       var store = new RedisDocumentStore({ expire: 10 });
-      runs(function() {
+      store.set('hello1', 'world', function() {
-        var _this = this;
-        store.set('hello1', 'world', function(worked) {
-          _this.result = worked; 
-        });
-      });
-      waitsFor(function() {
-        return typeof(this.result) === 'boolean';
-      });
-      runs(function() {
-        var _this = this;
         RedisDocumentStore.client.ttl('hello1', function(err, res) {
-          expect(res).toBeGreaterThan(1);
+          res.should.be.above(1);
-          _this.done = true;
+          done();
         });
       });
-      waitsFor(function() {
-        return this.done;
-      });
     });
 
-    it('should not set an expiration when told not to', function() {
+    it('should not set an expiration when told not to', function(done) {
       var store = new RedisDocumentStore({ expire: 10 });
-      runs(function() {
+      store.set('hello2', 'world', function() {
-        var _this = this;
+        RedisDocumentStore.client.ttl('hello2', function(err, res) {
-        store.set('hello2', 'world', function(worked) {
+          res.should.equal(-1);
-          _this.result = worked; 
+          done();
+        });
       }, true);
     });
-      waitsFor(function() {
-        return typeof(this.result) === 'boolean';
-      });
-      runs(function() {
-        var _this = this;
-        RedisDocumentStore.client.ttl('hello2', function(err, res) {
-          expect(res).toBe(-1);
-          _this.done = true;
-        });
-      });
-      waitsFor(function() {
-        return this.done;
-      });
-    });
 
-    it('should not set an expiration when expiration is off', function() {
+    it('should not set an expiration when expiration is off', function(done) {
       var store = new RedisDocumentStore({ expire: false });
-      runs(function() {
-        var _this = this;
       store.set('hello3', 'world', function(worked) {
-          _this.result = worked; 
-        });
-      });
-      waitsFor(function() {
-        return typeof(this.result) === 'boolean';
-      });
-      runs(function() {
-        var _this = this;
         RedisDocumentStore.client.ttl('hello3', function(err, res) {
-          expect(res).toBe(-1);
+          res.should.equal(-1);
-          _this.done = true;
+          done();
         });
       });
-      waitsFor(function() {
-        return this.done;
-      });
     });
 
   });

static/application.js

@@ -4,6 +4,15 @@ var haste_document = function() {
   this.locked = false;
 };
 
+// Escapes HTML tag characters
+haste_document.prototype.htmlEscape = function(s) {
+  return s
+    .replace(/&/g, '&')
+    .replace(/>/g, '>')
+    .replace(/</g, '&lt;')
+    .replace(/"/g, '&quot;');
+};
+
 // Get this document from the server and lock it here
 haste_document.prototype.load = function(key, callback, lang) {
   var _this = this;
@@ -17,7 +26,7 @@ haste_document.prototype.load = function(key, callback, lang) {
       try {
         var high;
         if (lang === 'txt') {
-          high = { value: res.data };
+          high = { value: _this.htmlEscape(res.data) };
         }
         else if (lang) {
           high = hljs.highlight(lang, res.data);