From 0eaf109d9d2c5bbda4a33d7c106c3a9f06f52d2a Mon Sep 17 00:00:00 2001 From: John Christopher Anderson Date: Mon, 29 Dec 2008 23:43:10 +0000 Subject: merge form branch to trunk git-svn-id: https://svn.apache.org/repos/asf/couchdb/trunk@730016 13f79535-47bb-0310-9956-ffa450edef68 --- share/server/main.js | 182 +++++++++++++++++++++++++++++ share/www/script/couch_tests.js | 253 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 435 insertions(+) (limited to 'share') diff --git a/share/server/main.js b/share/server/main.js index 73fefe19..17387299 100644 --- a/share/server/main.js +++ b/share/server/main.js @@ -32,12 +32,181 @@ log = function(message) { print(toJSON({log: toJSON(message)})); } +// mimeparse.js +// http://code.google.com/p/mimeparse/ +// Code with comments: http://mimeparse.googlecode.com/svn/trunk/mimeparse.js +// Tests: http://mimeparse.googlecode.com/svn/trunk/mimeparse-js-test.html +// Ported from version 0.1.2 + +var Mimeparse = (function() { + function strip(string) { + return string.replace(/^\s+/, '').replace(/\s+$/, '') + }; + function parseRanges(ranges) { + var parsedRanges = [], rangeParts = ranges.split(","); + for (var i=0; i < rangeParts.length; i++) { + parsedRanges.push(publicMethods.parseMediaRange(rangeParts[i])) + }; + return parsedRanges; + }; + var publicMethods = { + parseMimeType : function(mimeType) { + var fullType, typeParts, params = {}, parts = mimeType.split(';'); + for (var i=0; i < parts.length; i++) { + var p = parts[i].split('='); + if (p.length == 2) { + params[strip(p[0])] = strip(p[1]); + } + }; + fullType = parts[0].replace(/^\s+/, '').replace(/\s+$/, ''); + if (fullType == '*') fullType = '*/*'; + typeParts = fullType.split('/'); + return [typeParts[0], typeParts[1], params]; + }, + parseMediaRange : function(range) { + var q, parsedType = this.parseMimeType(range); + if (!parsedType[2]['q']) { + parsedType[2]['q'] = '1'; + } else { + q = parseFloat(parsedType[2]['q']); + if (isNaN(q)) { + parsedType[2]['q'] = '1'; + } else if (q > 1 || q < 0) { + parsedType[2]['q'] = '1'; + } + } + return parsedType; + }, + fitnessAndQualityParsed : function(mimeType, parsedRanges) { + var bestFitness = -1, bestFitQ = 0, target = this.parseMediaRange(mimeType); + var targetType = target[0], targetSubtype = target[1], targetParams = target[2]; + + for (var i=0; i < parsedRanges.length; i++) { + var parsed = parsedRanges[i]; + var type = parsed[0], subtype = parsed[1], params = parsed[2]; + if ((type == targetType || type == "*" || targetType == "*") && + (subtype == targetSubtype || subtype == "*" || targetSubtype == "*")) { + var matchCount = 0; + for (param in targetParams) { + if (param != 'q' && params[param] && params[param] == targetParams[param]) { + matchCount += 1; + } + } + + var fitness = (type == targetType) ? 100 : 0; + fitness += (subtype == targetSubtype) ? 10 : 0; + fitness += matchCount; + + if (fitness > bestFitness) { + bestFitness = fitness; + bestFitQ = params["q"]; + } + } + }; + return [bestFitness, parseFloat(bestFitQ)]; + }, + qualityParsed : function(mimeType, parsedRanges) { + return this.fitnessAndQualityParsed(mimeType, parsedRanges)[1]; + }, + quality : function(mimeType, ranges) { + return this.qualityParsed(mimeType, parseRanges(ranges)); + }, + + // Takes a list of supported mime-types and finds the best + // match for all the media-ranges listed in header. The value of + // header must be a string that conforms to the format of the + // HTTP Accept: header. The value of 'supported' is a list of + // mime-types. + // + // >>> bestMatch(['application/xbel+xml', 'text/xml'], 'text/*;q=0.5,*/*; q=0.1') + // 'text/xml' + bestMatch : function(supported, header) { + var parsedHeader = parseRanges(header); + var weighted = []; + for (var i=0; i < supported.length; i++) { + weighted.push([publicMethods.fitnessAndQualityParsed(supported[i], parsedHeader), supported[i]]) + }; + weighted.sort(); + return weighted[weighted.length-1][0][1] ? weighted[weighted.length-1][1] : ''; + } + } + return publicMethods; +})(); + + +// this function provides a shortcut for managing responses by Accept header +respondWith = function(req, responders) { + var accept = req.headers["Accept"]; + if (accept) { + var provides = []; + for (key in responders) { + if (mimesByKey[key]) { + provides = provides.concat(mimesByKey[key]); + } + } + var bestMime = Mimeparse.bestMatch(provides, accept); + var bestKey = keysByMime[bestMime]; + var rFunc = responders[bestKey]; + if (rFunc) { + var resp = rFunc(); + resp["headers"] = resp["headers"] || {}; + resp["headers"]["Content-Type"] = bestMime; + return resp; + } + } + if (responders.default) { + return responders[responders.default](); + } + throw({code:406, body:"Not Acceptable: "+accept}); +} + +// whoever registers last wins. +mimesByKey = {}; +keysByMime = {}; +registerType = function() { + var mimes = [], key = arguments[0]; + for (var i=1; i < arguments.length; i++) { + mimes.push(arguments[i]); + }; + mimesByKey[key] = mimes; + for (var i=0; i < mimes.length; i++) { + keysByMime[mimes[i]] = key; + }; +}; + +// Some default types +// Ported from Ruby on Rails +// Build list of Mime types for HTTP responses +// http://www.iana.org/assignments/media-types/ +// http://dev.rubyonrails.org/svn/rails/trunk/actionpack/lib/action_controller/mime_types.rb + +registerType("all", "*/*"); +registerType("text", "text/plain", "txt"); +registerType("html", "text/html", "application/xhtml+xml", "xhtml"); +registerType("xml", "application/xml", "text/xml", "application/x-xml"); +// http://www.ietf.org/rfc/rfc4627.txt +registerType("json", "application/json", "text/x-json"); +registerType("js", "text/javascript", "application/javascript", "application/x-javascript"); +registerType("css", "text/css"); +registerType("ics", "text/calendar"); +registerType("csv", "text/csv"); +registerType("rss", "application/rss+xml"); +registerType("atom", "application/atom+xml"); +registerType("yaml", "application/x-yaml", "text/yaml"); +// just like Rails +registerType("multipart_form", "multipart/form-data"); +registerType("url_encoded_form", "application/x-www-form-urlencoded"); + +// ok back to business. + try { // if possible, use evalcx (not always available) sandbox = evalcx(''); sandbox.emit = emit; sandbox.sum = sum; sandbox.log = log; + sandbox.respondWith = respondWith; + sandbox.registerType = registerType; } catch (e) {} // Commands are in the form of json arrays: @@ -167,6 +336,19 @@ while (cmd = eval(readline())) { print(toJSON(error)); } break; + case "form": + var funSrc = cmd[1]; + var doc = cmd[2]; + var req = cmd[3]; + try { + var formFun = compileFunction(funSrc); + var rendered = formFun(doc, req); + print(toJSON(rendered)); + } catch (error) { + log({error:(error||"undefined error")}); + print(toJSON(error)); + } + break; default: print(toJSON({error: "query_server_error", reason: "unknown command '" + cmd[0] + "'"})); diff --git a/share/www/script/couch_tests.js b/share/www/script/couch_tests.js index 1eb1836e..5a642f33 100644 --- a/share/www/script/couch_tests.js +++ b/share/www/script/couch_tests.js @@ -2029,6 +2029,259 @@ var tests = { T(xhr.status == 200) }, + forms: function(debug) { + var db = new CouchDB("test_suite_db"); + db.deleteDb(); + db.createDb(); + if (debug) debugger; + + var designDoc = { + _id:"_design/template", + language: "javascript", + forms: { + "hello" : (function() { + return { + body : "Hello World" + }; + }).toString(), + "just-name" : (function(doc, req) { + return { + body : "Just " + doc.name + }; + }).toString(), + "req-info" : (function(doc, req) { + return { + json : req + } + }).toString(), + "xml-type" : (function(doc, req) { + return { + headers : { + "Content-Type" : "application/xml" + }, + "body" : + } + }).toString(), + "no-set-etag" : (function(doc, req) { + return { + headers : { + "Etag" : "skipped" + }, + "body" : "something" + } + }).toString(), + "accept-switch" : (function(doc, req) { + if (req.headers["Accept"].match(/image/)) { + return { + // a 16x16 px version of the CouchDB logo + "base64" : ["iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAsV", + "BMVEUAAAD////////////////////////5ur3rEBn////////////////wDBL/", + "AADuBAe9EB3IEBz/7+//X1/qBQn2AgP/f3/ilpzsDxfpChDtDhXeCA76AQH/v7", + "/84eLyWV/uc3bJPEf/Dw/uw8bRWmP1h4zxSlD6YGHuQ0f6g4XyQkXvCA36MDH6", + "wMH/z8/yAwX64ODeh47BHiv/Ly/20dLQLTj98PDXWmP/Pz//39/wGyJ7Iy9JAA", + "AADHRSTlMAbw8vf08/bz+Pv19jK/W3AAAAg0lEQVR4Xp3LRQ4DQRBD0QqTm4Y5", + "zMxw/4OleiJlHeUtv2X6RbNO1Uqj9g0RMCuQO0vBIg4vMFeOpCWIWmDOw82fZx", + "vaND1c8OG4vrdOqD8YwgpDYDxRgkSm5rwu0nQVBJuMg++pLXZyr5jnc1BaH4GT", + "LvEliY253nA3pVhQqdPt0f/erJkMGMB8xucAAAAASUVORK5CYII="].join(''), + headers : { + "Content-Type" : "image/png", + "Vary" : "Accept" // we set this for proxy caches + } + }; + } else { + return { + "body" : "accepting text requests", + headers : { + "Content-Type" : "text/html", + "Vary" : "Accept" + } + }; + } + }).toString(), + "respondWith" : (function(doc, req) { + registerType("foo", "application/foo","application/x-foo"); + return respondWith(req, { + html : function() { + return { + body:"Ha ha, you said \"" + doc.word + "\"." + }; + }, + xml : function() { + return { + body: + }; + }, + foo : function() { + return { + body: "foofoo" + }; + }, + default : "html" + }); + }).toString() + } + }; + T(db.save(designDoc).ok); + + var doc = {"word":"plankton", "name":"Rusty"} + var resp = db.save(doc); + T(resp.ok); + var docid = resp.id; + + // form error + var xhr = CouchDB.request("GET", "/test_suite_db/_form/"); + T(xhr.status == 404); + T(JSON.parse(xhr.responseText).reason == "Invalid path."); + + // hello template world + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/hello/"+docid); + T(xhr.responseText == "Hello World"); + + // form with doc + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/just-name/"+docid); + T(xhr.responseText == "Just Rusty"); + + // form with missing doc + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/just-name/missingdoc"); + T(xhr.status == 404); + var resp = JSON.parse(xhr.responseText); + T(resp.error == "not_found"); + T(resp.reason == "missing"); + + // missing design doc + xhr = CouchDB.request("GET", "/test_suite_db/_form/missingdoc/just-name/"+docid); + T(xhr.status == 404); + var resp = JSON.parse(xhr.responseText); + T(resp.error == "not_found"); + T(resp.reason == "missing_design_doc"); + + // query parameters + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/req-info/"+docid+"?foo=bar", { + headers: { + "Accept": "text/html;text/plain;*/*", + "X-Foo" : "bar" + } + }); + var resp = JSON.parse(xhr.responseText); + T(equals(resp.headers["X-Foo"], "bar")); + T(equals(resp.query, {foo:"bar"})); + T(equals(resp.verb, "GET")); + T(equals(resp.path[4], docid)); + T(equals(resp.info.db_name, "test_suite_db")); + + // returning a content-type + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/xml-type/"+docid); + T("application/xml" == xhr.getResponseHeader("Content-Type")); + T("Accept" == xhr.getResponseHeader("Vary")); + + // accept header switching + // different mime has different etag + + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/accept-switch/"+docid, { + headers: {"Accept": "text/html;text/plain;*/*"} + }); + T("text/html" == xhr.getResponseHeader("Content-Type")); + T("Accept" == xhr.getResponseHeader("Vary")); + var etag = xhr.getResponseHeader("etag"); + + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/accept-switch/"+docid, { + headers: {"Accept": "image/png;*/*"} + }); + T(xhr.responseText.match(/PNG/)) + T("image/png" == xhr.getResponseHeader("Content-Type")); + var etag2 = xhr.getResponseHeader("etag"); + T(etag2 != etag); + + // proper etags + // form with doc + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/just-name/"+docid); + // extract the ETag header values + etag = xhr.getResponseHeader("etag"); + // get again with etag in request + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/just-name/"+docid, { + headers: {"if-none-match": etag} + }); + // should be 304 + T(xhr.status == 304); + + // update the doc + doc.name = "Crusty"; + resp = db.save(doc); + T(resp.ok); + // req with same etag + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/just-name/"+docid, { + headers: {"if-none-match": etag} + }); + // status is 200 + T(xhr.status == 200); + + // get new etag and request again + etag = xhr.getResponseHeader("etag"); + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/just-name/"+docid, { + headers: {"if-none-match": etag} + }); + // should be 304 + T(xhr.status == 304); + + // update design doc (but not function) + designDoc.isChanged = true; + T(db.save(designDoc).ok); + + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/just-name/"+docid, { + headers: {"if-none-match": etag} + }); + // should be 304 + T(xhr.status == 304); + + // update design doc function + designDoc.forms["just-name"] = (function(doc, req) { + return { + body : "Just old " + doc.name + }; + }).toString(); + T(db.save(designDoc).ok); + + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/just-name/"+docid, { + headers: {"if-none-match": etag} + }); + // status is 200 + T(xhr.status == 200); + + + // JS can't set etag + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/no-set-etag/"+docid); + // extract the ETag header values + etag = xhr.getResponseHeader("etag"); + T(etag != "skipped") + + // test the respondWith mime matcher + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/respondWith/"+docid, { + headers: { + "Accept": 'text/html,application/atom+xml; q=0.9' + } + }); + T(xhr.getResponseHeader("Content-Type") == "text/html"); + T(xhr.responseText == "Ha ha, you said \"plankton\"."); + + // now with xml + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/respondWith/"+docid, { + headers: { + "Accept": 'application/xml' + } + }); + T(xhr.getResponseHeader("Content-Type") == "application/xml"); + T(xhr.responseText.match(/plankton/)); + + // registering types works + xhr = CouchDB.request("GET", "/test_suite_db/_form/template/respondWith/"+docid, { + headers: { + "Accept": "application/x-foo" + } + }); + T(xhr.getResponseHeader("Content-Type") == "application/x-foo"); + T(xhr.responseText.match(/foofoo/)); + }, + compact: function(debug) { var db = new CouchDB("test_suite_db"); db.deleteDb(); -- cgit v1.2.3