Merge branch 'master' of github.com:h3rald/litestore
h3rald h3rald@h3rald.com
Sat, 11 Dec 2021 22:54:40 +0000
5 files changed,
3070 insertions(+),
3068 deletions(-)
M
README.md
→
README.md
@@ -1,14 +1,13 @@
-[](https://github.com/h3rald/litestore) - -[]() -[](https://raw.githubusercontent.com/h3rald/litestore/master/LICENSE) -[](https://travis-ci.org/h3rald/litestore) - -LiteStore is a lightweight, self-contained, RESTful, multi-format NoSQL document store server written in [Nim](http://www.nim-lang.org) and powered by a [SQLite](http://www.sqlite.org) backend for storage. It aims to be a very simple and lightweight backend ideal for prototyping and testing REST APIs and single-page applications. - -For more information, see: - -* [Getting Started](src/admin/md/getting-started.md) -* [Usage](src/admin/md/usage.md) - -Or read the full [LiteStore User Guide](https://h3rald.com/litestore/LiteStore_UserGuide.htm). +[](https://nimble.directory/pkg/litestore) + +[](https://github.com/h3rald/litestore/releases/latest) +[](https://raw.githubusercontent.com/h3rald/litestore/master/LICENSE) + +LiteStore is a lightweight, self-contained, RESTful, multi-format NoSQL document store server written in [Nim](http://www.nim-lang.org) and powered by a [SQLite](http://www.sqlite.org) backend for storage. It aims to be a very simple and lightweight backend ideal for prototyping and testing REST APIs and single-page applications. + +For more information, see: + +* [Getting Started](src/admin/md/getting-started.md) +* [Usage](src/admin/md/usage.md) + +Or read the full [LiteStore User Guide](https://h3rald.com/litestore/LiteStore_UserGuide.htm).
M
src/litestore.nim.cfg
→
src/litestore.nim.cfg
@@ -1,16 +1,19 @@
-define:release -threads:on - -@if nimHasWarningObservableStores: - warning[ObservableStores]: off -@end - -# https://blog.filippo.io/easy-windows-and-linux-cross-compilers-for-macos/ - -amd64.windows.gcc.path = "/usr/local/bin" -amd64.windows.gcc.exe = "x86_64-w64-mingw32-gcc" -amd64.windows.gcc.linkerexe = "x86_64-w64-mingw32-gcc" - -amd64.linux.gcc.path = "/usr/local/bin" -amd64.linux.gcc.exe = "x86_64-linux-musl-gcc" -amd64.linux.gcc.linkerexe = "x86_64-linux-musl-gcc" +define:release +threads:on + +@if nimHasWarningObservableStores: + warning[ObservableStores]: off +@end + +# https://blog.filippo.io/easy-windows-and-linux-cross-compilers-for-macos/ + +amd64.windows.gcc.path = "/usr/local/bin" +amd64.windows.gcc.exe = "x86_64-w64-mingw32-gcc" +amd64.windows.gcc.linkerexe = "x86_64-w64-mingw32-gcc" + +amd64.linux.gcc.path = "/usr/local/bin" +amd64.linux.gcc.exe = "x86_64-linux-musl-gcc" +amd64.linux.gcc.linkerexe = "x86_64-linux-musl-gcc" + +--gc = "orc" +--opt = "size"
M
src/litestorepkg/lib/api_v6.nim
→
src/litestorepkg/lib/api_v6.nim
@@ -1,1131 +1,1131 @@
-import - asynchttpserver, - strutils, - sequtils, - cgi, - strtabs, - pegs, - json, - os, - uri, - times -import - types, - contenttypes, - core, - utils, - logger, - duktape - -# Helper procs - -proc sqlOp(op: string): string = - let table = newStringTable() - table["not eq"] = "<>" - table["eq"] = "==" - table["gt"] = ">" - table["gte"] = ">=" - table["lt"] = "<" - table["lte"] = "<=" - table["contains"] = "contains" - table["like"] = "like" - return table[op] - -proc orderByClauses*(str: string): string = - var clauses = newSeq[string]() - var fragments = str.split(",") - let clause = peg""" - clause <- {[-+]} {field} - field <- ('id' / 'created' / 'modified' / path) - path <- '$' (objField)+ - ident <- [a-zA-Z0-9_]+ - objField <- '.' ident - """ - for f in fragments: - var matches = @["", ""] - if f.find(clause, matches) != -1: - var field = matches[1] - if field[0] == '$': - field = "json_extract(documents.data, '$1')" % matches[1] - if matches[0] == "-": - clauses.add("$1 COLLATE NOCASE DESC" % field) - else: - clauses.add("$1 COLLATE NOCASE ASC" % field) - return clauses.join(", ") - -proc selectClause*(str: string, options: var QueryOptions) = - let tokens = """ - path <- '$' (objItem / objField)+ - ident <- [a-zA-Z0-9_]+ - objIndex <- '[' \d+ ']' - objField <- '.' ident - objItem <- objField objIndex - """ - let fields = peg(""" - fields <- ^{field} (\s* ',' \s* {field})*$ - field <- path \s+ ('as' / 'AS') \s+ ident - """ & tokens) - let field = peg(""" - field <- ^{path} \s+ ('as' / 'AS') \s+ {ident}$ - """ & tokens) - var fieldMatches = newSeq[string](10) - if str.strip.match(fields, fieldMatches): - for m in fieldMatches: - if m.len > 0: - var rawTuple = newSeq[string](2) - if m.match(field, rawTuple): - options.jsonSelect.add((path: rawTuple[0], alias: rawTuple[1])) - -proc filterClauses*(str: string, options: var QueryOptions) = - let tokens = """ - operator <- 'not eq' / 'eq' / 'gte' / 'gt' / 'lte' / 'lt' / 'contains' / 'like' - value <- string / number / 'null' / 'true' / 'false' - string <- '"' ('\\"' . / [^"])* '"' - number <- '-'? '0' / [1-9] [0-9]* ('.' [0-9]+)? (( 'e' / 'E' ) ( '+' / '-' )? [0-9]+)? - path <- '$' (objItem / objField)+ - ident <- [a-zA-Z0-9_]+ - objIndex <- '[' \d+ ']' - objField <- '.' ident - objItem <- objField objIndex - """ - let clause = peg(""" - clause <- {path} \s+ {operator} \s+ {value} - """ & tokens) - let andClauses = peg(""" - andClauses <- ^{clause} (\s+ 'and' \s+ {clause})*$ - clause <- path \s+ operator \s+ value - """ & tokens) - let orClauses = peg(""" - orClauses <- ^{andClauses} (\s+ 'or' \s+ {andClauses})*$ - andClauses <- clause (\s+ 'and' \s+ clause)* - clause <- path \s+ operator \s+ value - """ & tokens) - var orClausesMatches = newSeq[string](10) - discard str.strip.match(orClauses, orClausesMatches) - var parsedClauses = newSeq[seq[seq[string]]]() - for orClause in orClausesMatches: - if orClause.len > 0: - var andClausesMatches = newSeq[string](10) - discard orClause.strip.match(andClauses, andClausesMatches) - var parsedAndClauses = newSeq[seq[string]]() - for andClause in andClausesMatches: - if andClause.len > 0: - var clauses = newSeq[string](3) - discard andClause.strip.match(clause, clauses) - clauses[1] = sqlOp(clauses[1]) - if clauses[2] == "true": - clauses[2] = "1" - elif clauses[2] == "false": - clauses[2] = "0" - parsedAndClauses.add clauses - if parsedAndClauses.len > 0: - parsedClauses.add parsedAndClauses - if parsedClauses.len == 0: - return - var currentArr = 0 - var tables = newSeq[string]() - let resOrClauses = parsedClauses.map do (it: seq[seq[string]]) -> string: - let resAndClauses = it.map do (x: seq[string]) -> string: - if x[1] == "contains": - currentArr = currentArr + 1 - tables.add "json_each(documents.data, '$1') AS arr$2" % [x[0], $currentArr] - return "arr$1.value == $2" % [$currentArr, x[2]] - else: - var arr = @[x[0], x[1], x[2]] - if x[1] == "like": - arr[2] = x[2].replace('*', '%') - return "json_extract(documents.data, '$1') $2 $3 " % arr - return resAndClauses.join(" AND ") - options.tables = options.tables & tables - options.jsonFilter = resOrClauses.join(" OR ") - -proc parseQueryOption*(fragment: string, options: var QueryOptions) = - if fragment == "": - return - var pair = fragment.split('=') - if pair.len < 2 or pair[1] == "": - raise newException(EInvalidRequest, "Invalid query string fragment '$1'" % fragment) - try: - pair[1] = pair[1].replace("+", "%2B").decodeURL - except: - raise newException(EInvalidRequest, "Unable to decode query string fragment '$1'" % fragment) - case pair[0]: - of "filter": - filterClauses(pair[1], options) - if options.jsonFilter == "": - raise newException(EInvalidRequest, "Invalid filter clause: $1" % pair[1].replace("\"", "\\\"")) - of "select": - selectClause(pair[1], options) - if options.jsonSelect.len == 0: - raise newException(EInvalidRequest, "Invalid select clause: $1" % pair[1].replace("\"", "\\\"")) - of "like": - options.like = pair[1] - of "search": - options.search = pair[1] - of "tags": - options.tags = pair[1] - of "created-after": - try: - options.createdAfter = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") - except: - raise newException(EInvalidRequest, "Invalid created-after value: $1" % getCurrentExceptionMsg()) - of "created-before": - try: - options.createdBefore = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") - except: - raise newException(EInvalidRequest, "Invalid created-before value: $1" % getCurrentExceptionMsg()) - of "modified-after": - try: - options.modifiedAfter = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") - except: - raise newException(EInvalidRequest, "Invalid modified.after value: $1" % getCurrentExceptionMsg()) - of "modified-before": - try: - options.modifiedBefore = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") - except: - raise newException(EInvalidRequest, "Invalid modified-before value: $1" % getCurrentExceptionMsg()) - of "limit": - try: - options.limit = pair[1].parseInt - except: - raise newException(EInvalidRequest, "Invalid limit value: $1" % getCurrentExceptionMsg()) - of "offset": - try: - options.offset = pair[1].parseInt - except: - raise newException(EInvalidRequest, "Invalid offset value: $1" % getCurrentExceptionMsg()) - of "sort": - let orderby = pair[1].orderByClauses() - if orderby != "": - options.orderby = orderby - else: - raise newException(EInvalidRequest, "Invalid sort value: $1" % pair[1]) - of "contents", "raw": - discard - else: - discard - -proc parseQueryOptions*(querystring: string, options: var QueryOptions) = - var fragments = querystring.split('&') - for f in fragments: - f.parseQueryOption(options) - -proc validate*(req: LSRequest, LS: LiteStore, resource: string, id: string, cb: proc(req: LSRequest, LS: LiteStore, resource: string, id: string):LSResponse): LSResponse = - if req.reqMethod == HttpPost or req.reqMethod == HttpPut or req.reqMethod == HttpPatch: - var ct = "" - let body = req.body.strip - if body == "": - return resError(Http400, "Bad request: No content specified for document.") - if req.headers.hasKey("Content-Type"): - ct = req.headers["Content-Type"] - case ct: - of "application/json": - try: - discard body.parseJson() - except: - return resError(Http400, "Invalid JSON content - $1" % getCurrentExceptionMsg()) - else: - discard - return cb(req, LS, resource, id) - -proc patchTag(tags: var seq[string], index: int, op, path, value: string): bool = - LOG.debug("- PATCH -> $1 tag['$2'] = \"$3\" - Total tags: $4." % [op, $index, $value, $tags.len]) - case op: - of "remove": - let tag = tags[index] - if not tag.startsWith("$"): - tags[index] = "" # Not removing element, otherwise subsequent indexes won't work! - else: - raise newException(EInvalidRequest, "cannot remove system tag: $1" % tag) - of "add": - if value.match(PEG_USER_TAG): - tags.insert(value, index) - else: - if value.strip == "": - raise newException(EInvalidRequest, "tag not specified." % value) - else: - raise newException(EInvalidRequest, "invalid tag: $1" % value) - of "replace": - if value.match(PEG_USER_TAG): - if tags[index].startsWith("$"): - raise newException(EInvalidRequest, "cannot replace system tag: $1" % tags[index]) - else: - tags[index] = value - else: - if value.strip == "": - raise newException(EInvalidRequest, "tag not specified." % value) - else: - raise newException(EInvalidRequest, "invalid tag: $1" % value) - of "test": - if tags[index] != value: - return false - else: - raise newException(EInvalidRequest, "invalid patch operation: $1" % op) - return true - -proc patchData*(data: var JsonNode, origData: JsonNode, op: string, path: string, value: JsonNode): bool = - LOG.debug("- PATCH -> $1 path $2 with $3" % [op, path, $value]) - var keys = path.replace(peg"^\/data\/", "").split("/") - if keys.len == 0: - raise newException(EInvalidRequest, "no valid path specified: $1" % path) - var d = data - var dorig = origData - var c = 1 - for key in keys: - if d.kind == JArray: - try: - var index = key.parseInt - if c >= keys.len: - d.elems[index] = value - case op: - of "remove": - d.elems.del(index) - of "add": - d.elems.insert(value, index) - of "replace": - d.elems[index] = value - of "test": - if d.elems[index] != value: - return false - else: - raise newException(EInvalidRequest, "invalid patch operation: $1" % op) - else: - d = d[index] - dorig = dorig[index] - except: - raise newException(EInvalidRequest, "invalid index key '$1' in path '$2'" % [key, path]) - else: - if c >= keys.len: - case op: - of "remove": - if d.hasKey(key): - d.delete(key) - else: - raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) - of "add": - d[key] = value - of "replace": - if d.hasKey(key): - d[key] = value - else: - raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) - of "test": - if dorig.hasKey(key): - if dorig[key] != value: - return false - else: - raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) - else: - raise newException(EInvalidRequest, "invalid patch operation: $1" % op) - else: - d = d[key] - dorig = dorig[key] - c += 1 - return true - - -proc applyPatchOperation*(data: var JsonNode, origData: JsonNode, tags: var seq[string], op: string, path: string, value: JsonNode): bool = - var matches = @[""] - let p = peg""" - path <- ^tagPath / fieldPath$ - tagPath <- '\/tags\/' {\d+} - fieldPath <- '\/data\/' ident ('\/' ident)* - ident <- [a-zA-Z0-9_]+ / '-' - """ - if path.find(p, matches) == -1: - raise newException(EInvalidRequest, "cannot patch path '$1'" % path) - if path.match(peg"^\/tags\/"): - let index = matches[0].parseInt - if value.kind != JString: - raise newException(EInvalidRequest, "tag '$1' is not a string." % $value) - let tag = value.getStr - return patchTag(tags, index, op, path, tag) - elif tags.contains("$subtype:json"): - return patchData(data, origData, op, path, value) - else: - raise newException(EInvalidRequest, "cannot patch data of a non-JSON document.") - -# Low level procs - -proc getTag*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = - let doc = LS.store.retrieveTag(id, options) - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - if doc == newJNull(): - result = resTagNotFound(id) - else: - result.content = $doc - result.code = Http200 - -proc getIndex*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = - let doc = LS.store.retrieveIndex(id, options) - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - if doc == newJNull(): - result = resIndexNotFound(id) - else: - result.content = $doc - result.code = Http200 - -proc getRawDocument*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = - let doc = LS.store.retrieveRawDocument(id, options) - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - if doc == "": - result = resDocumentNotFound(id) - else: - result.content = doc - result.code = Http200 - -proc getDocument*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = - let doc = LS.store.retrieveDocument(id, options) - if doc.data == "": - result = resDocumentNotFound(id) - else: - result.headers = doc.contenttype.ctHeader - setOrigin(LS, req, result.headers) - result.content = doc.data - result.code = Http200 - -proc deleteDocument*(LS: LiteStore, id: string, req: LSRequest): LSResponse = - let doc = LS.store.retrieveDocument(id) - if doc.data == "": - result = resDocumentNotFound(id) - else: - try: - let res = LS.store.destroyDocument(id) - if res == 0: - result = resError(Http500, "Unable to delete document '$1'" % id) - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Content-Length"] = "0" - result.content = "" - result.code = Http204 - except: - result = resError(Http500, "Unable to delete document '$1'" % id) - -proc getTags*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = - var options = options - let t0 = cpuTime() - let docs = LS.store.retrieveTags(options) - let orig_limit = options.limit - let orig_offset = options.offset - options.limit = 0 - options.offset = 0 - options.select = @["COUNT(tag_id)"] - let total = LS.store.countTags(prepareSelectTagsQuery(options), options.like.replace("*", "%")) - var content = newJObject() - if options.like != "": - content["like"] = %(options.like.decodeURL) - if orig_limit > 0: - content["limit"] = %orig_limit - if orig_offset > 0: - content["offset"] = %orig_offset - content["total"] = %total - content["execution_time"] = %(cputime()-t0) - content["results"] = docs - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = content.pretty - result.code = Http200 - -proc getIndexes*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = - var options = options - let t0 = cpuTime() - let docs = LS.store.retrieveIndexes(options) - let orig_limit = options.limit - let orig_offset = options.offset - options.limit = 0 - options.offset = 0 - options.select = @["COUNT(name)"] - let total = LS.store.countIndexes(prepareSelectIndexesQuery(options), options.like.replace("*", "%")) - var content = newJObject() - if options.like != "": - content["like"] = %(options.like.decodeURL) - if orig_limit > 0: - content["limit"] = %orig_limit - if orig_offset > 0: - content["offset"] = %orig_offset - content["total"] = %total - content["execution_time"] = %(cputime()-t0) - content["results"] = docs - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = content.pretty - result.code = Http200 - -proc getRawDocuments*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = - var options = options - let t0 = cpuTime() - let docs = LS.store.retrieveRawDocuments(options) - let orig_limit = options.limit - let orig_offset = options.offset - options.limit = 0 - options.offset = 0 - options.select = @["COUNT(docid)"] - let total = LS.store.retrieveRawDocuments(options)[0].num - var content = newJObject() - if options.folder != "": - content["folder"] = %(options.folder) - if options.search != "": - content["search"] = %(options.search.decodeURL) - if options.tags != "": - content["tags"] = newJArray() - for tag in options.tags.replace("+", "%2B").decodeURL.split(","): - content["tags"].add(%tag) - if orig_limit > 0: - content["limit"] = %orig_limit - if orig_offset > 0: - content["offset"] = %orig_offset - if options.orderby != "": - content["sort"] = %options.orderby - content["total"] = %total - content["execution_time"] = %(cputime()-t0) - content["results"] = docs - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = content.pretty - result.code = Http200 - -proc getInfo*(LS: LiteStore, req: LSRequest): LSResponse = - let info = LS.store.retrieveInfo() - let version = info[0] - let total_documents = info[1] - let total_tags = LS.store.countTags() - let tags = LS.store.retrieveTagsWithTotals() - var content = newJObject() - content["version"] = %(LS.appname & " v" & LS.appversion) - content["datastore_version"] = %version - content["size"] = %($((LS.file.getFileSize().float/(1024*1024)).formatFloat(ffDecimal, 2)) & " MB") - content["read_only"] = %LS.readonly - content["log_level"] = %LS.loglevel - if LS.directory.len == 0: - content["directory"] = newJNull() - else: - content["directory"] = %LS.directory - content["mount"] = %LS.mount - content["total_documents"] = %total_documents - content["total_tags"] = %total_tags - content["tags"] = tags - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = content.pretty - result.code = Http200 - -proc putIndex*(LS: LiteStore, id, field: string, req: LSRequest): LSResponse = - try: - if (not id.match(PEG_INDEX)): - return resError(Http400, "invalid index ID: $1" % id) - if (not field.match(PEG_JSON_FIELD)): - return resError(Http400, "invalid field path: $1" % field) - if (LS.store.retrieveIndex(id) != newJNull()): - return resError(Http409, "Index already exists: $1" % id) - LS.store.createIndex(id, field) - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = "{\"id\": \"$1\", \"field\": \"$2\"}" % [id, field] - result.code = Http200 - except: - eWarn() - result = resError(Http500, "Unable to create index.") - -proc deleteIndex*(LS: LiteStore, id: string, req: LSRequest): LSResponse = - if (not id.match(PEG_INDEX)): - return resError(Http400, "invalid index ID: $1" % id) - if (LS.store.retrieveIndex(id) == newJNull()): - return resError(Http404, "Index not found: $1" % id) - try: - LS.store.dropIndex(id) - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Content-Length"] = "0" - result.content = "" - result.code = Http204 - except: - eWarn() - result = resError(Http500, "Unable to delete index.") - -proc postDocument*(LS: LiteStore, body: string, ct: string, folder="", req: LSRequest): LSResponse = - if not folder.isFolder: - return resError(Http400, "Invalid folder specified when creating document: $1" % folder) - try: - var doc = LS.store.createDocument(folder, body, ct) - if doc != "": - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = doc - result.code = Http201 - else: - result = resError(Http500, "Unable to create document.") - except: - eWarn() - result = resError(Http500, "Unable to create document.") - -proc putDocument*(LS: LiteStore, id: string, body: string, ct: string, req: LSRequest): LSResponse = - if id.isFolder: - return resError(Http400, "Invalid ID '$1' (Document IDs cannot end with '/')." % id) - let doc = LS.store.retrieveDocument(id) - if doc.data == "": - # Create a new document - var doc = LS.store.createDocument(id, body, ct) - if doc != "": - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = doc - result.code = Http201 - else: - result = resError(Http500, "Unable to create document.") - else: - # Update existing document - try: - var doc = LS.store.updateDocument(id, body, ct) - if doc != "": - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = doc - result.code = Http200 - else: - result = resError(Http500, "Unable to update document '$1'." % id) - except: - result = resError(Http500, "Unable to update document '$1'." % id) - -proc patchDocument*(LS: LiteStore, id: string, body: string, req: LSRequest): LSResponse = - var apply = true - let jbody = body.parseJson - if jbody.kind != JArray: - return resError(Http400, "Bad request: PATCH request body is not an array.") - var options = newQueryOptions() - options.select = @["documents.id AS id", "created", "modified", "data"] - let doc = LS.store.retrieveRawDocument(id, options) - if doc == "": - return resDocumentNotFound(id) - let jdoc = doc.parseJson - var tags = newSeq[string]() - var origTags = newSeq[string]() - for tag in jdoc["tags"].items: - tags.add(tag.str) - origTags.add(tag.str) - var data: JsonNode - var origData: JsonNode - if tags.contains("$subtype:json"): - try: - origData = jdoc["data"].getStr.parseJson - data = origData.copy - except: - discard - var c = 1 - for item in jbody.items: - if item.hasKey("op") and item.hasKey("path"): - if not item.hasKey("value"): - item["value"] = %"" - try: - apply = applyPatchOperation(data, origData, tags, item["op"].str, item["path"].str, item["value"]) - if not apply: - break - except: - return resError(Http400, "Bad request - $1" % getCurrentExceptionMsg()) - else: - return resError(Http400, "Bad request: patch operation #$1 is malformed." % $c) - c.inc - if apply: - if origData.len > 0 and origData != data: - try: - var doc = LS.store.updateDocument(id, data.pretty, "application/json") - if doc == "": - return resError(Http500, "Unable to patch document '$1'." % id) - except: - return resError(Http500, "Unable to patch document '$1' - $2" % id, getCurrentExceptionMsg()) - if origTags != tags: - try: - for t1 in jdoc["tags"].items: - discard LS.store.destroyTag(t1.str, id, true) - for t2 in tags: - if t2 != "": - LS.store.createTag(t2, id, true) - except: - return resError(Http500, "Unable to patch document '$1' - $2" % [id, getCurrentExceptionMsg()]) - return LS.getRawDocument(id, newQueryOptions(), req) - -# Main routing - -proc options*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - case resource: - of "info": - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - if id != "": - return resError(Http404, "Info '$1' not found." % id) - else: - result.code = Http204 - result.content = "" - of "dir": - result.code = Http204 - result.content = "" - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - of "tags": - result.code = Http204 - result.content = "" - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - of "indexes": - result.code = Http204 - result.content = "" - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - if id != "": - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - else: - result.headers["Allow"] = "GET, OPTIONS, PUT, DELETE" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS, PUT, DELETE" - else: - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - of "docs": - var folder: string - if id.isFolder: - folder = id - if folder.len > 0: - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS, POST, PUT" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, POST, PUT" - elif id != "": - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS, PUT, PATCH, DELETE" - result.headers["Allow-Patch"] = "application/json-patch+json" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, PUT, PATCH, DELETE" - else: - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS, POST" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, POST" - else: - discard # never happens really. - -proc head*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - var options = newQueryOptions() - options.select = @["documents.id AS id", "created", "modified"] - if id.isFolder: - options.folder = id - try: - parseQueryOptions(req.url.query, options); - if id != "" and options.folder == "": - result = LS.getRawDocument(id, options, req) - result.content = "" - else: - result = LS.getRawDocuments(options, req) - result.content = "" - except: - return resError(Http400, "Bad request - $1" % getCurrentExceptionMsg()) - -proc get*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - case resource: - of "docs": - var options = newQueryOptions() - if id.isFolder: - options.folder = id - if req.url.query.contains("contents=false"): - options.select = @["documents.id AS id", "created", "modified"] - try: - parseQueryOptions(req.url.query, options); - if id != "" and options.folder == "": - if req.url.query.contains("raw=true") or req.headers.hasKey("Accept") and req.headers["Accept"] == "application/json": - return LS.getRawDocument(id, options, req) - else: - return LS.getDocument(id, options, req) - else: - return LS.getRawDocuments(options, req) - except: - let e = getCurrentException() - let trace = e.getStackTrace() - echo trace - return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) - of "tags": - var options = newQueryOptions() - try: - parseQueryOptions(req.url.query, options); - if id != "": - return LS.getTag(id, options, req) - else: - return LS.getTags(options, req) - except: - return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) - of "indexes": - var options = newQueryOptions() - try: - parseQueryOptions(req.url.query, options); - if id != "": - return LS.getIndex(id, options, req) - else: - return LS.getIndexes(options, req) - except: - return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) - of "info": - if id != "": - return resError(Http404, "Info '$1' not found." % id) - return LS.getInfo(req) - else: - discard # never happens really. - -proc post*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - var ct = "text/plain" - if req.headers.hasKey("Content-Type"): - ct = req.headers["Content-Type"] - return LS.postDocument(req.body.strip, ct, id, req) - -proc put*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - if id != "": - if resource == "indexes": - var field = "" - try: - field = parseJson(req.body.strip)["field"].getStr - except: - return resError(Http400, "Bad Request - Invalid JSON body - $1" % getCurrentExceptionMsg()) - return LS.putIndex(id, field, req) - else: # Assume docs - var ct = "text/plain" - if req.headers.hasKey("Content-Type"): - ct = req.headers["Content-Type"] - return LS.putDocument(id, req.body.strip, ct, req) - else: - return resError(Http400, "Bad request: document ID must be specified in PUT requests.") - -proc delete*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - if id != "": - if resource == "indexes": - return LS.deleteIndex(id, req) - else: # Assume docs - return LS.deleteDocument(id, req) - else: - return resError(Http400, "Bad request: document ID must be specified in DELETE requests.") - -proc patch*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - if id != "": - return LS.patchDocument(id, req.body, req) - else: - return resError(Http400, "Bad request: document ID must be specified in PATCH requests.") - -proc serveFile*(req: LSRequest, LS: LiteStore, id: string): LSResponse = - let path = LS.directory / id - var reqMethod = $req.reqMethod - if req.headers.hasKey("X-HTTP-Method-Override"): - reqMethod = req.headers["X-HTTP-Method-Override"] - case reqMethod.toUpperAscii: - of "OPTIONS": - return validate(req, LS, "dir", id, options) - of "GET": - if path.fileExists: - try: - let contents = path.readFile - let parts = path.splitFile - if CONTENT_TYPES.hasKey(parts.ext): - result.headers = CONTENT_TYPES[parts.ext].ctHeader - else: - result.headers = ctHeader("text/plain") - setOrigin(LS, req, result.headers) - result.content = contents - result.code = Http200 - except: - return resError(Http500, "Unable to read file '$1'." % path) - else: - return resError(Http404, "File '$1' not found." % path) - else: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - -proc route*(req: LSRequest, LS: LiteStore, resource = "docs", id = ""): LSResponse = - var reqMethod = $req.reqMethod - if req.headers.hasKey("X-HTTP-Method-Override"): - reqMethod = req.headers["X-HTTP-Method-Override"] - case reqMethod.toUpperAscii: - of "POST": - if LS.readonly: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - return validate(req, LS, resource, id, post) - of "PUT": - if LS.readonly: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - return validate(req, LS, resource, id, put) - of "DELETE": - if LS.readonly: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - return validate(req, LS, resource, id, delete) - of "HEAD": - return validate(req, LS, resource, id, head) - of "OPTIONS": - return validate(req, LS, resource, id, options) - of "GET": - return validate(req, LS, resource, id, get) - of "PATCH": - if LS.readonly: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - return validate(req, LS, resource, id, patch) - else: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - -proc newSimpleLSRequest(meth: HttpMethod, resource, id, body = "", params = "", headers = newHttpHeaders()): LSRequest = - result.reqMethod = meth - result.body = body - result.headers = headers - result.url = parseUri("$1://$2:$3/$4/$5?$6" % @["http", "localhost", "9500", resource, id, params]) - -proc get(resource, id: string, params = ""): LSResponse = - return newSimpleLSRequest(HttpGet, resource, id, "", params).get(LS, resource, id) - -proc post(resource, folder, body: string, ct = ""): LSResponse = - var headers = newHttpHeaders() - if ct != "": - headers["Content-Type"] = ct - return newSimpleLSRequest(HttpPost, resource, "", body, "", headers).post(LS, resource, folder & "/") - -proc put(resource, id, body: string, ct = ""): LSResponse = - var headers = newHttpHeaders() - if ct != "": - headers["Content-Type"] = ct - return newSimpleLSRequest(HttpPut, resource, id, body, "", headers).put(LS, resource, id) - -proc patch(resource, id, body: string): LSResponse = - var headers = newHttpHeaders() - headers["Content-Type"] = "application/json" - return newSimpleLSRequest(HttpPatch, resource, id, body, "", headers).patch(LS, resource, id) - -proc delete(resource, id: string): LSResponse = - return newSimpleLSRequest(HttpPatch, resource, id).delete(LS, resource, id) - -proc head(resource, id: string): LSResponse = - return newSimpleLSRequest(HttpHead, resource, id).head(LS, resource, id) - -proc registerStoreApi(LS: LiteStore, ctx: DTContext, origResource, origId: string) = - var api_idx = ctx.duk_push_object() - # GET - var get: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let id = duk_get_string(ctx, 1) - let params = duk_get_string(ctx, 2) - let resp = get($resource, $id, $params) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, get, 3) - discard ctx.duk_put_prop_string(api_idx, "get") - # POST - var post: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let folder = duk_get_string(ctx, 1) - let body = duk_get_string(ctx, 2) - let ct = duk_get_string(ctx, 3) - let resp = post($resource, $folder, $body, $ct) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, post, 4) - discard ctx.duk_put_prop_string(api_idx, "post") - # PUT - var put: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let id = duk_get_string(ctx, 1) - let body = duk_get_string(ctx, 2) - let ct = duk_get_string(ctx, 3) - let resp = put($resource, $id, $body, $ct) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, put, 4) - discard ctx.duk_put_prop_string(api_idx, "put") - # PATCH - var patch: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let id = duk_get_string(ctx, 1) - let body = duk_get_string(ctx, 2) - let resp = patch($resource, $id, $body) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, patch, 3) - discard ctx.duk_put_prop_string(api_idx, "patch") - # DELETE - var delete: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let id = duk_get_string(ctx, 1) - let resp = delete($resource, $id) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, delete, 2) - discard ctx.duk_put_prop_string(api_idx, "delete") - # HEAD - var head: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let id = duk_get_string(ctx, 1) - let resp = head($resource, $id) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, head, 2) - discard ctx.duk_put_prop_string(api_idx, "head") - discard ctx.duk_put_global_string("$store") - -proc jError(ctx: DTContext): LSResponse = - return resError(Http500, "Middleware Error: " & $ctx.duk_safe_to_string(-1)) - -proc getMiddleware*(LS: LiteStore, id: string): string = - if not LS.middleware.hasKey(id): - # Attempt to retrieve resource from system documents - let options = newQueryOptions(true) - let doc = LS.store.retrieveDocument("middleware/" & id & ".js", options) - result = doc.data - if result == "": - LOG.warn("Middleware '$1' not found" % id) - else: - result = LS.middleware[id] - -proc getMiddlewareSeq(resource, id, meth: string): seq[string] = - result = newSeq[string]() - if LS.config.kind != JObject or not LS.config.hasKey("resources"): - return - var reqUri = "/" & resource & "/" & id - if reqUri[^1] == '/': - reqUri.removeSuffix({'/'}) - let parts = reqUri.split("/") - let ancestors = parts[1..parts.len-2] - var currentPath = "" - var currentPaths = "" - for p in ancestors: - currentPath &= "/" & p - currentPaths = currentPath & "/*" - if LS.config["resources"].hasKey(currentPaths) and LS.config["resources"][currentPaths].hasKey(meth) and LS.config["resources"][currentPaths][meth].hasKey("middleware"): - let mw = LS.config["resources"][currentPaths][meth]["middleware"] - if (mw.kind == JArray): - for m in mw: - result.add m.getStr - if LS.config["resources"].hasKey(reqUri) and LS.config["resources"][reqUri].hasKey(meth) and LS.config["resources"][reqUri][meth].hasKey("middleware"): - let mw = LS.config["resources"][reqUri][meth]["middleware"] - if (mw.kind == JArray): - for m in mw: - result.add m.getStr - -proc execute*(req: var LSRequest, LS: LiteStore, resource, id: string): LSResponse = - let middleware = getMiddlewareSeq(resource, id, $req.reqMethod) - LOG.debug("Middleware: " & middleware.join(" -> ")); - if middleware.len == 0: - return route(req, LS, resource, id) - var jReq = $(%* req) - LOG.debug("Request: " & jReq) - var jRes = """{ - "code": 200, - "content": {}, - "final": false, - "headers": { - "Access-Control-Allow-Origin": "*", - "Access-Control-Allow-Headers": "Authorization, Content-Type", - "Server": "$1", - "Content-Type": "application/json" - } - }""" % [LS.appname & "/" & LS.appversion] - var context = "{}" - # Create execution context - var ctx = duk_create_heap_default() - duk_console_init(ctx) - duk_print_alert_init(ctx) - LS.registerStoreApi(ctx, resource, id) - if ctx.duk_peval_string("($1)" % $jReq) != 0: - return jError(ctx) - discard ctx.duk_put_global_string("$req") - if ctx.duk_peval_string("($1)" % $jRes) != 0: - return jError(ctx) - discard ctx.duk_put_global_string("$res") - if ctx.duk_peval_string("($1)" % $context) != 0: - return jError(ctx) - discard ctx.duk_put_global_string("$ctx") - # Middleware-specific functions - var i = 0 - var abort = 0 - while abort != 1 and i < middleware.len: - let code = LS.getMiddleware(middleware[i]) - LOG.debug("Evaluating middleware '$1'" % middleware[i]) - if ctx.duk_peval_string(code) != 0: - return jError(ctx) - abort = ctx.duk_get_boolean(-1) - i.inc - # Retrieve response, and request - if ctx.duk_peval_string("JSON.stringify($res);") != 0: - return jError(ctx) - let fRes = parseJson($(ctx.duk_get_string(-1))).newLSResponse - if ctx.duk_peval_string("JSON.stringify($req);") != 0: - return jError(ctx) - let fReq = parseJson($(ctx.duk_get_string(-1))).newLSRequest() - ctx.duk_destroy_heap(); - LOG.debug("abort: $1", [$abort]) - if abort == 1: - return fRes - return route(fReq, LS, resource, id) +import + asynchttpserver, + strutils, + sequtils, + cgi, + strtabs, + pegs, + json, + os, + uri, + times +import + types, + contenttypes, + core, + utils, + logger, + duktape + +# Helper procs + +proc sqlOp(op: string): string = + let table = newStringTable() + table["not eq"] = "<>" + table["eq"] = "==" + table["gt"] = ">" + table["gte"] = ">=" + table["lt"] = "<" + table["lte"] = "<=" + table["contains"] = "contains" + table["like"] = "like" + return table[op] + +proc orderByClauses*(str: string): string = + var clauses = newSeq[string]() + var fragments = str.split(",") + let clause = peg""" + clause <- {[-+]} {field} + field <- ('id' / 'created' / 'modified' / path) + path <- '$' (objField)+ + ident <- [a-zA-Z0-9_]+ + objField <- '.' ident + """ + for f in fragments: + var matches = @["", ""] + if f.find(clause, matches) != -1: + var field = matches[1] + if field[0] == '$': + field = "json_extract(documents.data, '$1')" % matches[1] + if matches[0] == "-": + clauses.add("$1 COLLATE NOCASE DESC" % field) + else: + clauses.add("$1 COLLATE NOCASE ASC" % field) + return clauses.join(", ") + +proc selectClause*(str: string, options: var QueryOptions) = + let tokens = """ + path <- '$' (objItem / objField)+ + ident <- [a-zA-Z0-9_]+ + objIndex <- '[' \d+ ']' + objField <- '.' ident + objItem <- objField objIndex + """ + let fields = peg(""" + fields <- ^{field} (\s* ',' \s* {field})*$ + field <- path \s+ ('as' / 'AS') \s+ ident + """ & tokens) + let field = peg(""" + field <- ^{path} \s+ ('as' / 'AS') \s+ {ident}$ + """ & tokens) + var fieldMatches = newSeq[string](10) + if str.strip.match(fields, fieldMatches): + for m in fieldMatches: + if m.len > 0: + var rawTuple = newSeq[string](2) + if m.match(field, rawTuple): + options.jsonSelect.add((path: rawTuple[0], alias: rawTuple[1])) + +proc filterClauses*(str: string, options: var QueryOptions) = + let tokens = """ + operator <- 'not eq' / 'eq' / 'gte' / 'gt' / 'lte' / 'lt' / 'contains' / 'like' + value <- string / number / 'null' / 'true' / 'false' + string <- '"' ('\\"' . / [^"])* '"' + number <- '-'? '0' / [1-9] [0-9]* ('.' [0-9]+)? (( 'e' / 'E' ) ( '+' / '-' )? [0-9]+)? + path <- '$' (objItem / objField)+ + ident <- [a-zA-Z0-9_]+ + objIndex <- '[' \d+ ']' + objField <- '.' ident + objItem <- objField objIndex + """ + let clause = peg(""" + clause <- {path} \s+ {operator} \s+ {value} + """ & tokens) + let andClauses = peg(""" + andClauses <- ^{clause} (\s+ 'and' \s+ {clause})*$ + clause <- path \s+ operator \s+ value + """ & tokens) + let orClauses = peg(""" + orClauses <- ^{andClauses} (\s+ 'or' \s+ {andClauses})*$ + andClauses <- clause (\s+ 'and' \s+ clause)* + clause <- path \s+ operator \s+ value + """ & tokens) + var orClausesMatches = newSeq[string](10) + discard str.strip.match(orClauses, orClausesMatches) + var parsedClauses = newSeq[seq[seq[string]]]() + for orClause in orClausesMatches: + if orClause.len > 0: + var andClausesMatches = newSeq[string](10) + discard orClause.strip.match(andClauses, andClausesMatches) + var parsedAndClauses = newSeq[seq[string]]() + for andClause in andClausesMatches: + if andClause.len > 0: + var clauses = newSeq[string](3) + discard andClause.strip.match(clause, clauses) + clauses[1] = sqlOp(clauses[1]) + if clauses[2] == "true": + clauses[2] = "1" + elif clauses[2] == "false": + clauses[2] = "0" + parsedAndClauses.add clauses + if parsedAndClauses.len > 0: + parsedClauses.add parsedAndClauses + if parsedClauses.len == 0: + return + var currentArr = 0 + var tables = newSeq[string]() + let resOrClauses = parsedClauses.map do (it: seq[seq[string]]) -> string: + let resAndClauses = it.map do (x: seq[string]) -> string: + if x[1] == "contains": + currentArr = currentArr + 1 + tables.add "json_each(documents.data, '$1') AS arr$2" % [x[0], $currentArr] + return "arr$1.value == $2" % [$currentArr, x[2]] + else: + var arr = @[x[0], x[1], x[2]] + if x[1] == "like": + arr[2] = x[2].replace('*', '%') + return "json_extract(documents.data, '$1') $2 $3 " % arr + return resAndClauses.join(" AND ") + options.tables = options.tables & tables + options.jsonFilter = resOrClauses.join(" OR ") + +proc parseQueryOption*(fragment: string, options: var QueryOptions) = + if fragment == "": + return + var pair = fragment.split('=') + if pair.len < 2 or pair[1] == "": + raise newException(EInvalidRequest, "Invalid query string fragment '$1'" % fragment) + try: + pair[1] = pair[1].replace("+", "%2B").decodeURL + except: + raise newException(EInvalidRequest, "Unable to decode query string fragment '$1'" % fragment) + case pair[0]: + of "filter": + filterClauses(pair[1], options) + if options.jsonFilter == "": + raise newException(EInvalidRequest, "Invalid filter clause: $1" % pair[1].replace("\"", "\\\"")) + of "select": + selectClause(pair[1], options) + if options.jsonSelect.len == 0: + raise newException(EInvalidRequest, "Invalid select clause: $1" % pair[1].replace("\"", "\\\"")) + of "like": + options.like = pair[1] + of "search": + options.search = pair[1] + of "tags": + options.tags = pair[1] + of "created-after": + try: + options.createdAfter = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") + except: + raise newException(EInvalidRequest, "Invalid created-after value: $1" % getCurrentExceptionMsg()) + of "created-before": + try: + options.createdBefore = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") + except: + raise newException(EInvalidRequest, "Invalid created-before value: $1" % getCurrentExceptionMsg()) + of "modified-after": + try: + options.modifiedAfter = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") + except: + raise newException(EInvalidRequest, "Invalid modified.after value: $1" % getCurrentExceptionMsg()) + of "modified-before": + try: + options.modifiedBefore = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") + except: + raise newException(EInvalidRequest, "Invalid modified-before value: $1" % getCurrentExceptionMsg()) + of "limit": + try: + options.limit = pair[1].parseInt + except: + raise newException(EInvalidRequest, "Invalid limit value: $1" % getCurrentExceptionMsg()) + of "offset": + try: + options.offset = pair[1].parseInt + except: + raise newException(EInvalidRequest, "Invalid offset value: $1" % getCurrentExceptionMsg()) + of "sort": + let orderby = pair[1].orderByClauses() + if orderby != "": + options.orderby = orderby + else: + raise newException(EInvalidRequest, "Invalid sort value: $1" % pair[1]) + of "contents", "raw": + discard + else: + discard + +proc parseQueryOptions*(querystring: string, options: var QueryOptions) = + var fragments = querystring.split('&') + for f in fragments: + f.parseQueryOption(options) + +proc validate*(req: LSRequest, LS: LiteStore, resource: string, id: string, cb: proc(req: LSRequest, LS: LiteStore, resource: string, id: string):LSResponse): LSResponse = + if req.reqMethod == HttpPost or req.reqMethod == HttpPut or req.reqMethod == HttpPatch: + var ct = "" + let body = req.body.strip + if body == "": + return resError(Http400, "Bad request: No content specified for document.") + if req.headers.hasKey("Content-Type"): + ct = req.headers["Content-Type"] + case ct: + of "application/json": + try: + discard body.parseJson() + except: + return resError(Http400, "Invalid JSON content - $1" % getCurrentExceptionMsg()) + else: + discard + return cb(req, LS, resource, id) + +proc patchTag(tags: var seq[string], index: int, op, path, value: string): bool = + LOG.debug("- PATCH -> $1 tag['$2'] = \"$3\" - Total tags: $4." % [op, $index, $value, $tags.len]) + case op: + of "remove": + let tag = tags[index] + if not tag.startsWith("$"): + tags[index] = "" # Not removing element, otherwise subsequent indexes won't work! + else: + raise newException(EInvalidRequest, "cannot remove system tag: $1" % tag) + of "add": + if value.match(PEG_USER_TAG): + tags.insert(value, index) + else: + if value.strip == "": + raise newException(EInvalidRequest, "tag not specified." % value) + else: + raise newException(EInvalidRequest, "invalid tag: $1" % value) + of "replace": + if value.match(PEG_USER_TAG): + if tags[index].startsWith("$"): + raise newException(EInvalidRequest, "cannot replace system tag: $1" % tags[index]) + else: + tags[index] = value + else: + if value.strip == "": + raise newException(EInvalidRequest, "tag not specified." % value) + else: + raise newException(EInvalidRequest, "invalid tag: $1" % value) + of "test": + if tags[index] != value: + return false + else: + raise newException(EInvalidRequest, "invalid patch operation: $1" % op) + return true + +proc patchData*(data: var JsonNode, origData: JsonNode, op: string, path: string, value: JsonNode): bool = + LOG.debug("- PATCH -> $1 path $2 with $3" % [op, path, $value]) + var keys = path.replace(peg"^\/data\/", "").split("/") + if keys.len == 0: + raise newException(EInvalidRequest, "no valid path specified: $1" % path) + var d = data + var dorig = origData + var c = 1 + for key in keys: + if d.kind == JArray: + try: + var index = key.parseInt + if c >= keys.len: + d.elems[index] = value + case op: + of "remove": + d.elems.del(index) + of "add": + d.elems.insert(value, index) + of "replace": + d.elems[index] = value + of "test": + if d.elems[index] != value: + return false + else: + raise newException(EInvalidRequest, "invalid patch operation: $1" % op) + else: + d = d[index] + dorig = dorig[index] + except: + raise newException(EInvalidRequest, "invalid index key '$1' in path '$2'" % [key, path]) + else: + if c >= keys.len: + case op: + of "remove": + if d.hasKey(key): + d.delete(key) + else: + raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) + of "add": + d[key] = value + of "replace": + if d.hasKey(key): + d[key] = value + else: + raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) + of "test": + if dorig.hasKey(key): + if dorig[key] != value: + return false + else: + raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) + else: + raise newException(EInvalidRequest, "invalid patch operation: $1" % op) + else: + d = d[key] + dorig = dorig[key] + c += 1 + return true + + +proc applyPatchOperation*(data: var JsonNode, origData: JsonNode, tags: var seq[string], op: string, path: string, value: JsonNode): bool = + var matches = @[""] + let p = peg""" + path <- ^tagPath / fieldPath$ + tagPath <- '\/tags\/' {\d+} + fieldPath <- '\/data\/' ident ('\/' ident)* + ident <- [a-zA-Z0-9_]+ / '-' + """ + if path.find(p, matches) == -1: + raise newException(EInvalidRequest, "cannot patch path '$1'" % path) + if path.match(peg"^\/tags\/"): + let index = matches[0].parseInt + if value.kind != JString: + raise newException(EInvalidRequest, "tag '$1' is not a string." % $value) + let tag = value.getStr + return patchTag(tags, index, op, path, tag) + elif tags.contains("$subtype:json"): + return patchData(data, origData, op, path, value) + else: + raise newException(EInvalidRequest, "cannot patch data of a non-JSON document.") + +# Low level procs + +proc getTag*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = + let doc = LS.store.retrieveTag(id, options) + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + if doc == newJNull(): + result = resTagNotFound(id) + else: + result.content = $doc + result.code = Http200 + +proc getIndex*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = + let doc = LS.store.retrieveIndex(id, options) + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + if doc == newJNull(): + result = resIndexNotFound(id) + else: + result.content = $doc + result.code = Http200 + +proc getRawDocument*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = + let doc = LS.store.retrieveRawDocument(id, options) + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + if doc == "": + result = resDocumentNotFound(id) + else: + result.content = doc + result.code = Http200 + +proc getDocument*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = + let doc = LS.store.retrieveDocument(id, options) + if doc.data == "": + result = resDocumentNotFound(id) + else: + result.headers = doc.contenttype.ctHeader + setOrigin(LS, req, result.headers) + result.content = doc.data + result.code = Http200 + +proc deleteDocument*(LS: LiteStore, id: string, req: LSRequest): LSResponse = + let doc = LS.store.retrieveDocument(id) + if doc.data == "": + result = resDocumentNotFound(id) + else: + try: + let res = LS.store.destroyDocument(id) + if res == 0: + result = resError(Http500, "Unable to delete document '$1'" % id) + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Content-Length"] = "0" + result.content = "" + result.code = Http204 + except: + result = resError(Http500, "Unable to delete document '$1'" % id) + +proc getTags*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = + var options = options + let t0 = cpuTime() + let docs = LS.store.retrieveTags(options) + let orig_limit = options.limit + let orig_offset = options.offset + options.limit = 0 + options.offset = 0 + options.select = @["COUNT(tag_id)"] + let total = LS.store.countTags(prepareSelectTagsQuery(options), options.like.replace("*", "%")) + var content = newJObject() + if options.like != "": + content["like"] = %(options.like.decodeURL) + if orig_limit > 0: + content["limit"] = %orig_limit + if orig_offset > 0: + content["offset"] = %orig_offset + content["total"] = %total + content["execution_time"] = %(cputime()-t0) + content["results"] = docs + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = content.pretty + result.code = Http200 + +proc getIndexes*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = + var options = options + let t0 = cpuTime() + let docs = LS.store.retrieveIndexes(options) + let orig_limit = options.limit + let orig_offset = options.offset + options.limit = 0 + options.offset = 0 + options.select = @["COUNT(name)"] + let total = LS.store.countIndexes(prepareSelectIndexesQuery(options), options.like.replace("*", "%")) + var content = newJObject() + if options.like != "": + content["like"] = %(options.like.decodeURL) + if orig_limit > 0: + content["limit"] = %orig_limit + if orig_offset > 0: + content["offset"] = %orig_offset + content["total"] = %total + content["execution_time"] = %(cputime()-t0) + content["results"] = docs + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = content.pretty + result.code = Http200 + +proc getRawDocuments*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = + var options = options + let t0 = cpuTime() + let docs = LS.store.retrieveRawDocuments(options) + let orig_limit = options.limit + let orig_offset = options.offset + options.limit = 0 + options.offset = 0 + options.select = @["COUNT(docid)"] + let total = LS.store.retrieveRawDocuments(options)[0].num + var content = newJObject() + if options.folder != "": + content["folder"] = %(options.folder) + if options.search != "": + content["search"] = %(options.search.decodeURL) + if options.tags != "": + content["tags"] = newJArray() + for tag in options.tags.replace("+", "%2B").decodeURL.split(","): + content["tags"].add(%tag) + if orig_limit > 0: + content["limit"] = %orig_limit + if orig_offset > 0: + content["offset"] = %orig_offset + if options.orderby != "": + content["sort"] = %options.orderby + content["total"] = %total + content["execution_time"] = %(cputime()-t0) + content["results"] = docs + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = content.pretty + result.code = Http200 + +proc getInfo*(LS: LiteStore, req: LSRequest): LSResponse = + let info = LS.store.retrieveInfo() + let version = info[0] + let total_documents = info[1] + let total_tags = LS.store.countTags() + let tags = LS.store.retrieveTagsWithTotals() + var content = newJObject() + content["version"] = %(LS.appname & " v" & LS.appversion) + content["datastore_version"] = %version + content["size"] = %($((LS.file.getFileSize().float/(1024*1024)).formatFloat(ffDecimal, 2)) & " MB") + content["read_only"] = %LS.readonly + content["log_level"] = %LS.loglevel + if LS.directory.len == 0: + content["directory"] = newJNull() + else: + content["directory"] = %LS.directory + content["mount"] = %LS.mount + content["total_documents"] = %total_documents + content["total_tags"] = %total_tags + content["tags"] = tags + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = content.pretty + result.code = Http200 + +proc putIndex*(LS: LiteStore, id, field: string, req: LSRequest): LSResponse = + try: + if (not id.match(PEG_INDEX)): + return resError(Http400, "invalid index ID: $1" % id) + if (not field.match(PEG_JSON_FIELD)): + return resError(Http400, "invalid field path: $1" % field) + if (LS.store.retrieveIndex(id) != newJNull()): + return resError(Http409, "Index already exists: $1" % id) + LS.store.createIndex(id, field) + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = "{\"id\": \"$1\", \"field\": \"$2\"}" % [id, field] + result.code = Http200 + except: + eWarn() + result = resError(Http500, "Unable to create index.") + +proc deleteIndex*(LS: LiteStore, id: string, req: LSRequest): LSResponse = + if (not id.match(PEG_INDEX)): + return resError(Http400, "invalid index ID: $1" % id) + if (LS.store.retrieveIndex(id) == newJNull()): + return resError(Http404, "Index not found: $1" % id) + try: + LS.store.dropIndex(id) + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Content-Length"] = "0" + result.content = "" + result.code = Http204 + except: + eWarn() + result = resError(Http500, "Unable to delete index.") + +proc postDocument*(LS: LiteStore, body: string, ct: string, folder="", req: LSRequest): LSResponse = + if not folder.isFolder: + return resError(Http400, "Invalid folder specified when creating document: $1" % folder) + try: + var doc = LS.store.createDocument(folder, body, ct) + if doc != "": + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = doc + result.code = Http201 + else: + result = resError(Http500, "Unable to create document.") + except: + eWarn() + result = resError(Http500, "Unable to create document.") + +proc putDocument*(LS: LiteStore, id: string, body: string, ct: string, req: LSRequest): LSResponse = + if id.isFolder: + return resError(Http400, "Invalid ID '$1' (Document IDs cannot end with '/')." % id) + let doc = LS.store.retrieveDocument(id) + if doc.data == "": + # Create a new document + var doc = LS.store.createDocument(id, body, ct) + if doc != "": + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = doc + result.code = Http201 + else: + result = resError(Http500, "Unable to create document.") + else: + # Update existing document + try: + var doc = LS.store.updateDocument(id, body, ct) + if doc != "": + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = doc + result.code = Http200 + else: + result = resError(Http500, "Unable to update document '$1'." % id) + except: + result = resError(Http500, "Unable to update document '$1'." % id) + +proc patchDocument*(LS: LiteStore, id: string, body: string, req: LSRequest): LSResponse = + var apply = true + let jbody = body.parseJson + if jbody.kind != JArray: + return resError(Http400, "Bad request: PATCH request body is not an array.") + var options = newQueryOptions() + options.select = @["documents.id AS id", "created", "modified", "data"] + let doc = LS.store.retrieveRawDocument(id, options) + if doc == "": + return resDocumentNotFound(id) + let jdoc = doc.parseJson + var tags = newSeq[string]() + var origTags = newSeq[string]() + for tag in jdoc["tags"].items: + tags.add(tag.str) + origTags.add(tag.str) + var data: JsonNode + var origData: JsonNode + if tags.contains("$subtype:json"): + try: + origData = jdoc["data"].getStr.parseJson + data = origData.copy + except: + discard + var c = 1 + for item in jbody.items: + if item.hasKey("op") and item.hasKey("path"): + if not item.hasKey("value"): + item["value"] = %"" + try: + apply = applyPatchOperation(data, origData, tags, item["op"].str, item["path"].str, item["value"]) + if not apply: + break + except: + return resError(Http400, "Bad request - $1" % getCurrentExceptionMsg()) + else: + return resError(Http400, "Bad request: patch operation #$1 is malformed." % $c) + c.inc + if apply: + if origData.len > 0 and origData != data: + try: + var doc = LS.store.updateDocument(id, data.pretty, "application/json") + if doc == "": + return resError(Http500, "Unable to patch document '$1'." % id) + except: + return resError(Http500, "Unable to patch document '$1' - $2" % id, getCurrentExceptionMsg()) + if origTags != tags: + try: + for t1 in jdoc["tags"].items: + discard LS.store.destroyTag(t1.str, id, true) + for t2 in tags: + if t2 != "": + LS.store.createTag(t2, id, true) + except: + return resError(Http500, "Unable to patch document '$1' - $2" % [id, getCurrentExceptionMsg()]) + return LS.getRawDocument(id, newQueryOptions(), req) + +# Main routing + +proc options*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + case resource: + of "info": + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + if id != "": + return resError(Http404, "Info '$1' not found." % id) + else: + result.code = Http204 + result.content = "" + of "dir": + result.code = Http204 + result.content = "" + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + of "tags": + result.code = Http204 + result.content = "" + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + of "indexes": + result.code = Http204 + result.content = "" + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + if id != "": + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + else: + result.headers["Allow"] = "GET, OPTIONS, PUT, DELETE" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS, PUT, DELETE" + else: + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + of "docs": + var folder: string + if id.isFolder: + folder = id + if folder.len > 0: + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS, POST, PUT" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, POST, PUT" + elif id != "": + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS, PUT, PATCH, DELETE" + result.headers["Allow-Patch"] = "application/json-patch+json" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, PUT, PATCH, DELETE" + else: + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS, POST" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, POST" + else: + discard # never happens really. + +proc head*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + var options = newQueryOptions() + options.select = @["documents.id AS id", "created", "modified"] + if id.isFolder: + options.folder = id + try: + parseQueryOptions(req.url.query, options); + if id != "" and options.folder == "": + result = LS.getRawDocument(id, options, req) + result.content = "" + else: + result = LS.getRawDocuments(options, req) + result.content = "" + except: + return resError(Http400, "Bad request - $1" % getCurrentExceptionMsg()) + +proc get*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + case resource: + of "docs": + var options = newQueryOptions() + if id.isFolder: + options.folder = id + if req.url.query.contains("contents=false"): + options.select = @["documents.id AS id", "created", "modified"] + try: + parseQueryOptions(req.url.query, options); + if id != "" and options.folder == "": + if req.url.query.contains("raw=true") or req.headers.hasKey("Accept") and req.headers["Accept"] == "application/json": + return LS.getRawDocument(id, options, req) + else: + return LS.getDocument(id, options, req) + else: + return LS.getRawDocuments(options, req) + except: + let e = getCurrentException() + let trace = e.getStackTrace() + echo trace + return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) + of "tags": + var options = newQueryOptions() + try: + parseQueryOptions(req.url.query, options); + if id != "": + return LS.getTag(id, options, req) + else: + return LS.getTags(options, req) + except: + return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) + of "indexes": + var options = newQueryOptions() + try: + parseQueryOptions(req.url.query, options); + if id != "": + return LS.getIndex(id, options, req) + else: + return LS.getIndexes(options, req) + except: + return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) + of "info": + if id != "": + return resError(Http404, "Info '$1' not found." % id) + return LS.getInfo(req) + else: + discard # never happens really. + +proc post*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + var ct = "text/plain" + if req.headers.hasKey("Content-Type"): + ct = req.headers["Content-Type"] + return LS.postDocument(req.body.strip, ct, id, req) + +proc put*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + if id != "": + if resource == "indexes": + var field = "" + try: + field = parseJson(req.body.strip)["field"].getStr + except: + return resError(Http400, "Bad Request - Invalid JSON body - $1" % getCurrentExceptionMsg()) + return LS.putIndex(id, field, req) + else: # Assume docs + var ct = "text/plain" + if req.headers.hasKey("Content-Type"): + ct = req.headers["Content-Type"] + return LS.putDocument(id, req.body.strip, ct, req) + else: + return resError(Http400, "Bad request: document ID must be specified in PUT requests.") + +proc delete*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + if id != "": + if resource == "indexes": + return LS.deleteIndex(id, req) + else: # Assume docs + return LS.deleteDocument(id, req) + else: + return resError(Http400, "Bad request: document ID must be specified in DELETE requests.") + +proc patch*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + if id != "": + return LS.patchDocument(id, req.body, req) + else: + return resError(Http400, "Bad request: document ID must be specified in PATCH requests.") + +proc serveFile*(req: LSRequest, LS: LiteStore, id: string): LSResponse = + let path = LS.directory / id + var reqMethod = $req.reqMethod + if req.headers.hasKey("X-HTTP-Method-Override"): + reqMethod = req.headers["X-HTTP-Method-Override"] + case reqMethod.toUpperAscii: + of "OPTIONS": + return validate(req, LS, "dir", id, options) + of "GET": + if path.fileExists: + try: + let contents = path.readFile + let parts = path.splitFile + if CONTENT_TYPES.hasKey(parts.ext): + result.headers = CONTENT_TYPES[parts.ext].ctHeader + else: + result.headers = ctHeader("text/plain") + setOrigin(LS, req, result.headers) + result.content = contents + result.code = Http200 + except: + return resError(Http500, "Unable to read file '$1'." % path) + else: + return resError(Http404, "File '$1' not found." % path) + else: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + +proc route*(req: LSRequest, LS: LiteStore, resource = "docs", id = ""): LSResponse = + var reqMethod = $req.reqMethod + if req.headers.hasKey("X-HTTP-Method-Override"): + reqMethod = req.headers["X-HTTP-Method-Override"] + case reqMethod.toUpperAscii: + of "POST": + if LS.readonly: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + return validate(req, LS, resource, id, post) + of "PUT": + if LS.readonly: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + return validate(req, LS, resource, id, put) + of "DELETE": + if LS.readonly: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + return validate(req, LS, resource, id, delete) + of "HEAD": + return validate(req, LS, resource, id, head) + of "OPTIONS": + return validate(req, LS, resource, id, options) + of "GET": + return validate(req, LS, resource, id, get) + of "PATCH": + if LS.readonly: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + return validate(req, LS, resource, id, patch) + else: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + +proc newSimpleLSRequest(meth: HttpMethod, resource, id, body = "", params = "", headers = newHttpHeaders()): LSRequest = + result.reqMethod = meth + result.body = body + result.headers = headers + result.url = parseUri("$1://$2:$3/$4/$5?$6" % @["http", "localhost", "9500", resource, id, params]) + +proc get(resource, id: string, params = ""): LSResponse = + return newSimpleLSRequest(HttpGet, resource, id, "", params).get(LS, resource, id) + +proc post(resource, folder, body: string, ct = ""): LSResponse = + var headers = newHttpHeaders() + if ct != "": + headers["Content-Type"] = ct + return newSimpleLSRequest(HttpPost, resource, "", body, "", headers).post(LS, resource, folder & "/") + +proc put(resource, id, body: string, ct = ""): LSResponse = + var headers = newHttpHeaders() + if ct != "": + headers["Content-Type"] = ct + return newSimpleLSRequest(HttpPut, resource, id, body, "", headers).put(LS, resource, id) + +proc patch(resource, id, body: string): LSResponse = + var headers = newHttpHeaders() + headers["Content-Type"] = "application/json" + return newSimpleLSRequest(HttpPatch, resource, id, body, "", headers).patch(LS, resource, id) + +proc delete(resource, id: string): LSResponse = + return newSimpleLSRequest(HttpPatch, resource, id).delete(LS, resource, id) + +proc head(resource, id: string): LSResponse = + return newSimpleLSRequest(HttpHead, resource, id).head(LS, resource, id) + +proc registerStoreApi(LS: LiteStore, ctx: DTContext, origResource, origId: string) = + var api_idx = ctx.duk_push_object() + # GET + var get: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let id = duk_get_string(ctx, 1) + let params = duk_get_string(ctx, 2) + let resp = get($resource, $id, $params) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, get, 3) + discard ctx.duk_put_prop_string(api_idx, "get") + # POST + var post: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let folder = duk_get_string(ctx, 1) + let body = duk_get_string(ctx, 2) + let ct = duk_get_string(ctx, 3) + let resp = post($resource, $folder, $body, $ct) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, post, 4) + discard ctx.duk_put_prop_string(api_idx, "post") + # PUT + var put: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let id = duk_get_string(ctx, 1) + let body = duk_get_string(ctx, 2) + let ct = duk_get_string(ctx, 3) + let resp = put($resource, $id, $body, $ct) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, put, 4) + discard ctx.duk_put_prop_string(api_idx, "put") + # PATCH + var patch: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let id = duk_get_string(ctx, 1) + let body = duk_get_string(ctx, 2) + let resp = patch($resource, $id, $body) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, patch, 3) + discard ctx.duk_put_prop_string(api_idx, "patch") + # DELETE + var delete: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let id = duk_get_string(ctx, 1) + let resp = delete($resource, $id) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, delete, 2) + discard ctx.duk_put_prop_string(api_idx, "delete") + # HEAD + var head: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let id = duk_get_string(ctx, 1) + let resp = head($resource, $id) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, head, 2) + discard ctx.duk_put_prop_string(api_idx, "head") + discard ctx.duk_put_global_string("$store") + +proc jError(ctx: DTContext): LSResponse = + return resError(Http500, "Middleware Error: " & $ctx.duk_safe_to_string(-1)) + +proc getMiddleware*(LS: LiteStore, id: string): string = + if not LS.middleware.hasKey(id): + # Attempt to retrieve resource from system documents + let options = newQueryOptions(true) + let doc = LS.store.retrieveDocument("middleware/" & id & ".js", options) + result = doc.data + if result == "": + LOG.warn("Middleware '$1' not found" % id) + else: + result = LS.middleware[id] + +proc getMiddlewareSeq(resource, id, meth: string): seq[string] = + result = newSeq[string]() + if LS.config.kind != JObject or not LS.config.hasKey("resources"): + return + var reqUri = "/" & resource & "/" & id + if reqUri[^1] == '/': + reqUri.removeSuffix({'/'}) + let parts = reqUri.split("/") + let ancestors = parts[1..parts.len-2] + var currentPath = "" + var currentPaths = "" + for p in ancestors: + currentPath &= "/" & p + currentPaths = currentPath & "/*" + if LS.config["resources"].hasKey(currentPaths) and LS.config["resources"][currentPaths].hasKey(meth) and LS.config["resources"][currentPaths][meth].hasKey("middleware"): + let mw = LS.config["resources"][currentPaths][meth]["middleware"] + if (mw.kind == JArray): + for m in mw: + result.add m.getStr + if LS.config["resources"].hasKey(reqUri) and LS.config["resources"][reqUri].hasKey(meth) and LS.config["resources"][reqUri][meth].hasKey("middleware"): + let mw = LS.config["resources"][reqUri][meth]["middleware"] + if (mw.kind == JArray): + for m in mw: + result.add m.getStr + +proc execute*(req: var LSRequest, LS: LiteStore, resource, id: string): LSResponse = + let middleware = getMiddlewareSeq(resource, id, $req.reqMethod) + LOG.debug("Middleware: " & middleware.join(" -> ")); + if middleware.len == 0: + return route(req, LS, resource, id) + var jReq = $(%* req) + LOG.debug("Request: " & jReq) + var jRes = """{ + "code": 200, + "content": {}, + "final": false, + "headers": { + "Access-Control-Allow-Origin": "*", + "Access-Control-Allow-Headers": "Authorization, Content-Type", + "Server": "$1", + "Content-Type": "application/json" + } + }""" % [LS.appname & "/" & LS.appversion] + var context = "{}" + # Create execution context + var ctx = duk_create_heap_default() + duk_console_init(ctx) + duk_print_alert_init(ctx) + LS.registerStoreApi(ctx, resource, id) + if ctx.duk_peval_string(cstring("($1)" % $jReq)) != 0: + return jError(ctx) + discard ctx.duk_put_global_string("$req") + if ctx.duk_peval_string(cstring("($1)" % $jRes)) != 0: + return jError(ctx) + discard ctx.duk_put_global_string("$res") + if ctx.duk_peval_string(cstring("($1)" % $context)) != 0: + return jError(ctx) + discard ctx.duk_put_global_string("$ctx") + # Middleware-specific functions + var i = 0 + var abort = 0 + while abort != 1 and i < middleware.len: + let code = LS.getMiddleware(middleware[i]) + LOG.debug("Evaluating middleware '$1'" % middleware[i]) + if ctx.duk_peval_string(code.cstring) != 0: + return jError(ctx) + abort = ctx.duk_get_boolean(-1) + i.inc + # Retrieve response, and request + if ctx.duk_peval_string("JSON.stringify($res);") != 0: + return jError(ctx) + let fRes = parseJson($(ctx.duk_get_string(-1))).newLSResponse + if ctx.duk_peval_string("JSON.stringify($req);") != 0: + return jError(ctx) + let fReq = parseJson($(ctx.duk_get_string(-1))).newLSRequest() + ctx.duk_destroy_heap(); + LOG.debug("abort: $1", [$abort]) + if abort == 1: + return fRes + return route(fReq, LS, resource, id)
M
src/litestorepkg/lib/api_v7.nim
→
src/litestorepkg/lib/api_v7.nim
@@ -1,1269 +1,1269 @@
-import - asynchttpserver, - strutils, - sequtils, - cgi, - strtabs, - pegs, - json, - os, - uri, - tables, - times -import - types, - contenttypes, - core, - utils, - logger, - duktape - -# Helper procs - -proc sqlOp(op: string): string = - let table = newStringTable() - table["not eq"] = "<>" - table["eq"] = "==" - table["gt"] = ">" - table["gte"] = ">=" - table["lt"] = "<" - table["lte"] = "<=" - table["contains"] = "contains" - table["like"] = "like" - return table[op] - -proc orderByClauses*(str: string): string = - var clauses = newSeq[string]() - var fragments = str.split(",") - let clause = peg""" - clause <- {[-+]} {field} - field <- ('id' / 'created' / 'modified' / path) - path <- '$' (objField)+ - ident <- [a-zA-Z0-9_]+ - objField <- '.' ident - """ - for f in fragments: - var matches = @["", ""] - if f.find(clause, matches) != -1: - var field = matches[1] - if field[0] == '$': - field = "json_extract(documents.data, '$1')" % matches[1] - if matches[0] == "-": - clauses.add("$1 COLLATE NOCASE DESC" % field) - else: - clauses.add("$1 COLLATE NOCASE ASC" % field) - return clauses.join(", ") - -proc selectClause*(str: string, options: var QueryOptions) = - let tokens = """ - path <- '$' (objItem / objField)+ - ident <- [a-zA-Z0-9_]+ - objIndex <- '[' \d+ ']' - objField <- '.' ident - objItem <- objField objIndex - """ - let fields = peg(""" - fields <- ^{field} (\s* ',' \s* {field})*$ - field <- path \s+ ('as' / 'AS') \s+ ident - """ & tokens) - let field = peg(""" - field <- ^{path} \s+ ('as' / 'AS') \s+ {ident}$ - """ & tokens) - var fieldMatches = newSeq[string](10) - if str.strip.match(fields, fieldMatches): - for m in fieldMatches: - if m.len > 0: - var rawTuple = newSeq[string](2) - if m.match(field, rawTuple): - options.jsonSelect.add((path: rawTuple[0], alias: rawTuple[1])) - -proc filterClauses*(str: string, options: var QueryOptions) = - let tokens = """ - operator <- 'not eq' / 'eq' / 'gte' / 'gt' / 'lte' / 'lt' / 'contains' / 'like' - value <- string / number / 'null' / 'true' / 'false' - string <- '"' ('\\"' . / [^"])* '"' - number <- '-'? '0' / [1-9] [0-9]* ('.' [0-9]+)? (( 'e' / 'E' ) ( '+' / '-' )? [0-9]+)? - path <- '$' (objItem / objField)+ - ident <- [a-zA-Z0-9_]+ - objIndex <- '[' \d+ ']' - objField <- '.' ident - objItem <- objField objIndex - """ - let clause = peg(""" - clause <- {path} \s+ {operator} \s+ {value} - """ & tokens) - let andClauses = peg(""" - andClauses <- ^{clause} (\s+ 'and' \s+ {clause})*$ - clause <- path \s+ operator \s+ value - """ & tokens) - let orClauses = peg(""" - orClauses <- ^{andClauses} (\s+ 'or' \s+ {andClauses})*$ - andClauses <- clause (\s+ 'and' \s+ clause)* - clause <- path \s+ operator \s+ value - """ & tokens) - var orClausesMatches = newSeq[string](10) - discard str.strip.match(orClauses, orClausesMatches) - var parsedClauses = newSeq[seq[seq[string]]]() - for orClause in orClausesMatches: - if orClause.len > 0: - var andClausesMatches = newSeq[string](10) - discard orClause.strip.match(andClauses, andClausesMatches) - var parsedAndClauses = newSeq[seq[string]]() - for andClause in andClausesMatches: - if andClause.len > 0: - var clauses = newSeq[string](3) - discard andClause.strip.match(clause, clauses) - clauses[1] = sqlOp(clauses[1]) - if clauses[2] == "true": - clauses[2] = "1" - elif clauses[2] == "false": - clauses[2] = "0" - parsedAndClauses.add clauses - if parsedAndClauses.len > 0: - parsedClauses.add parsedAndClauses - if parsedClauses.len == 0: - return - var currentArr = 0 - var tables = newSeq[string]() - let resOrClauses = parsedClauses.map do (it: seq[seq[string]]) -> string: - let resAndClauses = it.map do (x: seq[string]) -> string: - if x[1] == "contains": - currentArr = currentArr + 1 - tables.add "json_each(documents.data, '$1') AS arr$2" % [x[0], $currentArr] - return "arr$1.value == $2" % [$currentArr, x[2]] - else: - var arr = @[x[0], x[1], x[2]] - if x[1] == "like": - arr[2] = x[2].replace('*', '%') - return "json_extract(documents.data, '$1') $2 $3 " % arr - return resAndClauses.join(" AND ") - options.tables = options.tables & tables - options.jsonFilter = resOrClauses.join(" OR ") - -proc parseQueryOption*(fragment: string, options: var QueryOptions) = - if fragment == "": - return - var pair = fragment.split('=') - if pair.len < 2 or pair[1] == "": - raise newException(EInvalidRequest, "Invalid query string fragment '$1'" % fragment) - try: - pair[1] = pair[1].replace("+", "%2B").decodeURL - except: - raise newException(EInvalidRequest, "Unable to decode query string fragment '$1'" % fragment) - case pair[0]: - of "filter": - filterClauses(pair[1], options) - if options.jsonFilter == "": - raise newException(EInvalidRequest, "Invalid filter clause: $1" % pair[1].replace("\"", "\\\"")) - of "select": - selectClause(pair[1], options) - if options.jsonSelect.len == 0: - raise newException(EInvalidRequest, "Invalid select clause: $1" % pair[1].replace("\"", "\\\"")) - of "like": - options.like = pair[1] - of "search": - options.search = pair[1] - of "tags": - options.tags = pair[1] - of "created-after": - try: - options.createdAfter = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") - except: - raise newException(EInvalidRequest, "Invalid created-after value: $1" % getCurrentExceptionMsg()) - of "created-before": - try: - options.createdBefore = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") - except: - raise newException(EInvalidRequest, "Invalid created-before value: $1" % getCurrentExceptionMsg()) - of "modified-after": - try: - options.modifiedAfter = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") - except: - raise newException(EInvalidRequest, "Invalid modified.after value: $1" % getCurrentExceptionMsg()) - of "modified-before": - try: - options.modifiedBefore = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") - except: - raise newException(EInvalidRequest, "Invalid modified-before value: $1" % getCurrentExceptionMsg()) - of "limit": - try: - options.limit = pair[1].parseInt - except: - raise newException(EInvalidRequest, "Invalid limit value: $1" % getCurrentExceptionMsg()) - of "offset": - try: - options.offset = pair[1].parseInt - except: - raise newException(EInvalidRequest, "Invalid offset value: $1" % getCurrentExceptionMsg()) - of "sort": - let orderby = pair[1].orderByClauses() - if orderby != "": - options.orderby = orderby - else: - raise newException(EInvalidRequest, "Invalid sort value: $1" % pair[1]) - of "contents", "raw": - discard - else: - discard - -proc parseQueryOptions*(querystring: string, options: var QueryOptions) = - var q = querystring - if q.startsWith("?"): - q = q[1 .. q.len - 1] - var fragments = q.split('&') - for f in fragments: - f.parseQueryOption(options) - -proc validate*(req: LSRequest, LS: LiteStore, resource: string, id: string, cb: proc(req: LSRequest, LS: LiteStore, resource: string, id: string):LSResponse): LSResponse = - if req.reqMethod == HttpPost or req.reqMethod == HttpPut or req.reqMethod == HttpPatch: - var ct = "" - let body = req.body.strip - if body == "": - return resError(Http400, "Bad request: No content specified for document.") - if req.headers.hasKey("Content-Type"): - ct = req.headers["Content-Type"] - case ct: - of "application/json": - try: - discard body.parseJson() - except: - return resError(Http400, "Invalid JSON content - $1" % getCurrentExceptionMsg()) - else: - discard - return cb(req, LS, resource, id) - -proc patchTag(tags: var seq[string], index: int, op, path, value: string): bool = - LOG.debug("- PATCH -> $1 tag['$2'] = \"$3\" - Total tags: $4." % [op, $index, $value, $tags.len]) - case op: - of "remove": - let tag = tags[index] - if not tag.startsWith("$"): - tags[index] = "" # Not removing element, otherwise subsequent indexes won't work! - else: - raise newException(EInvalidRequest, "cannot remove system tag: $1" % tag) - of "add": - if value.match(PEG_USER_TAG): - tags.insert(value, index) - else: - if value.strip == "": - raise newException(EInvalidRequest, "tag not specified." % value) - else: - raise newException(EInvalidRequest, "invalid tag: $1" % value) - of "replace": - if value.match(PEG_USER_TAG): - if tags[index].startsWith("$"): - raise newException(EInvalidRequest, "cannot replace system tag: $1" % tags[index]) - else: - tags[index] = value - else: - if value.strip == "": - raise newException(EInvalidRequest, "tag not specified." % value) - else: - raise newException(EInvalidRequest, "invalid tag: $1" % value) - of "test": - if tags[index] != value: - return false - else: - raise newException(EInvalidRequest, "invalid patch operation: $1" % op) - return true - -proc patchData*(data: var JsonNode, origData: JsonNode, op: string, path: string, value: JsonNode): bool = - LOG.debug("- PATCH -> $1 path $2 with $3" % [op, path, $value]) - var keys = path.replace(peg"^\/data\/", "").split("/") - if keys.len == 0: - raise newException(EInvalidRequest, "no valid path specified: $1" % path) - var d = data - var dorig = origData - var c = 1 - for key in keys: - if d.kind == JArray: - try: - var index = key.parseInt - if c >= keys.len: - d.elems[index] = value - case op: - of "remove": - d.elems.del(index) - of "add": - d.elems.insert(value, index) - of "replace": - d.elems[index] = value - of "test": - if d.elems[index] != value: - return false - else: - raise newException(EInvalidRequest, "invalid patch operation: $1" % op) - else: - d = d[index] - dorig = dorig[index] - except: - raise newException(EInvalidRequest, "invalid index key '$1' in path '$2'" % [key, path]) - else: - if c >= keys.len: - case op: - of "remove": - if d.hasKey(key): - d.delete(key) - else: - raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) - of "add": - d[key] = value - of "replace": - if d.hasKey(key): - d[key] = value - else: - raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) - of "test": - if dorig.hasKey(key): - if dorig[key] != value: - return false - else: - raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) - else: - raise newException(EInvalidRequest, "invalid patch operation: $1" % op) - else: - d = d[key] - dorig = dorig[key] - c += 1 - return true - - -proc applyPatchOperation*(data: var JsonNode, origData: JsonNode, tags: var seq[string], op: string, path: string, value: JsonNode): bool = - var matches = @[""] - let p = peg""" - path <- ^tagPath / fieldPath$ - tagPath <- '\/tags\/' {\d+} - fieldPath <- '\/data\/' ident ('\/' ident)* - ident <- [a-zA-Z0-9_]+ / '-' - """ - if path.find(p, matches) == -1: - raise newException(EInvalidRequest, "cannot patch path '$1'" % path) - if path.match(peg"^\/tags\/"): - let index = matches[0].parseInt - if value.kind != JString: - raise newException(EInvalidRequest, "tag '$1' is not a string." % $value) - let tag = value.getStr - return patchTag(tags, index, op, path, tag) - elif tags.contains("$subtype:json"): - return patchData(data, origData, op, path, value) - else: - raise newException(EInvalidRequest, "cannot patch data of a non-JSON document.") - -# Low level procs - -proc getTag*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = - let doc = LS.store.retrieveTag(id, options) - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - if doc == newJNull(): - result = resTagNotFound(id) - else: - result.content = $doc - result.code = Http200 - -proc getStore*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = - if (not LSDICT.hasKey(id)): - return resStoreNotFound(id) - let store = LSDICT[id] - var doc = newJObject() - doc["id"] = %id - doc["file"] = %store.file - doc["config"] = store.config - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = $doc - result.code = Http200 - -proc getIndex*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = - let doc = LS.store.retrieveIndex(id, options) - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - if doc == newJNull(): - result = resIndexNotFound(id) - else: - result.content = $doc - result.code = Http200 - -proc getRawDocument*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = - let doc = LS.store.retrieveRawDocument(id, options) - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - if doc == "": - result = resDocumentNotFound(id) - else: - result.content = doc - result.code = Http200 - -proc getDocument*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = - let doc = LS.store.retrieveDocument(id, options) - if doc.data == "": - result = resDocumentNotFound(id) - else: - result.headers = doc.contenttype.ctHeader - setOrigin(LS, req, result.headers) - result.content = doc.data - result.code = Http200 - -proc deleteDocument*(LS: LiteStore, id: string, req: LSRequest): LSResponse = - let doc = LS.store.retrieveDocument(id) - if doc.data == "": - result = resDocumentNotFound(id) - else: - try: - let res = LS.store.destroyDocument(id) - if res == 0: - result = resError(Http500, "Unable to delete document '$1'" % id) - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Content-Length"] = "0" - result.content = "" - result.code = Http204 - except: - result = resError(Http500, "Unable to delete document '$1'" % id) - -proc getTags*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = - var options = options - let t0 = cpuTime() - let docs = LS.store.retrieveTags(options) - let orig_limit = options.limit - let orig_offset = options.offset - options.limit = 0 - options.offset = 0 - options.select = @["COUNT(tag_id)"] - let total = LS.store.countTags(prepareSelectTagsQuery(options), options.like.replace("*", "%")) - var content = newJObject() - if options.like != "": - content["like"] = %(options.like.decodeURL) - if orig_limit > 0: - content["limit"] = %orig_limit - if orig_offset > 0: - content["offset"] = %orig_offset - content["total"] = %total - content["execution_time"] = %(cputime()-t0) - content["results"] = docs - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = content.pretty - result.code = Http200 - -proc getStores(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = - let t0 = cpuTime() - var docs = newJArray() - for k, v in LSDICT.pairs: - var store = newJObject() - store["id"] = %k - store["file"] = %v.file - store["config"] = v.config - docs.add(store) - var content = newJObject() - content["total"] = %LSDICT.len - content["execution_time"] = %(cputime()-t0) - content["results"] = docs - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = content.pretty - result.code = Http200 - -proc getIndexes*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = - var options = options - let t0 = cpuTime() - let docs = LS.store.retrieveIndexes(options) - let orig_limit = options.limit - let orig_offset = options.offset - options.limit = 0 - options.offset = 0 - options.select = @["COUNT(name)"] - let total = LS.store.countIndexes(prepareSelectIndexesQuery(options), options.like.replace("*", "%")) - var content = newJObject() - if options.like != "": - content["like"] = %(options.like.decodeURL) - if orig_limit > 0: - content["limit"] = %orig_limit - if orig_offset > 0: - content["offset"] = %orig_offset - content["total"] = %total - content["execution_time"] = %(cputime()-t0) - content["results"] = docs - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = content.pretty - result.code = Http200 - -proc getRawDocuments*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = - var options = options - let t0 = cpuTime() - let docs = LS.store.retrieveRawDocuments(options) - let orig_limit = options.limit - let orig_offset = options.offset - options.limit = 0 - options.offset = 0 - options.select = @["COUNT(docid)"] - let total = LS.store.retrieveRawDocuments(options)[0].num - var content = newJObject() - if options.folder != "": - content["folder"] = %(options.folder) - if options.search != "": - content["search"] = %(options.search.decodeURL) - if options.tags != "": - content["tags"] = newJArray() - for tag in options.tags.replace("+", "%2B").decodeURL.split(","): - content["tags"].add(%tag) - if orig_limit > 0: - content["limit"] = %orig_limit - if orig_offset > 0: - content["offset"] = %orig_offset - if options.orderby != "": - content["sort"] = %options.orderby - content["total"] = %total - content["execution_time"] = %(cputime()-t0) - content["results"] = docs - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = content.pretty - result.code = Http200 - -proc getInfo*(LS: LiteStore, req: LSRequest): LSResponse = - let info = LS.store.retrieveInfo() - let version = info[0] - let total_documents = info[1] - let total_tags = LS.store.countTags() - let tags = LS.store.retrieveTagsWithTotals() - var content = newJObject() - content["version"] = %(LS.appname & " v" & LS.appversion) - content["datastore_version"] = %version - content["api_version"] = %7 - content["size"] = %($((LS.file.getFileSize().float/(1024*1024)).formatFloat(ffDecimal, 2)) & " MB") - content["read_only"] = %LS.readonly - content["log_level"] = %LS.loglevel - if LS.directory.len == 0: - content["directory"] = newJNull() - else: - content["directory"] = %LS.directory - content["mount"] = %LS.mount - if LS.config != newJNull() and LS.config.hasKey("stores") and LS.config["stores"].len > 0: - content["additional_stores"] = %toSeq(LS.config["stores"].keys) - else: - content["additional_stores"] = newJArray() - if LS.auth != newJNull(): - content["auth"] = %true - else: - content["auth"] = %false - content["total_documents"] = %total_documents - content["total_tags"] = %total_tags - content["tags"] = tags - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = content.pretty - result.code = Http200 - -proc putIndex*(LS: LiteStore, id, field: string, req: LSRequest): LSResponse = - try: - if (not id.match(PEG_INDEX)): - return resError(Http400, "invalid index ID: $1" % id) - if (not field.match(PEG_JSON_FIELD)): - return resError(Http400, "invalid field path: $1" % field) - if (LS.store.retrieveIndex(id) != newJNull()): - return resError(Http409, "Index already exists: $1" % id) - LS.store.createIndex(id, field) - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = "{\"id\": \"$1\", \"field\": \"$2\"}" % [id, field] - result.code = Http201 - except: - eWarn() - result = resError(Http500, "Unable to create index.") - -proc putStore*(LS: LiteStore, id: string, config: JsonNode, req: LSRequest): LSResponse = - try: - if (not id.match(PEG_STORE) or id == "master"): - return resError(Http400, "invalid store ID: $1" % id) - if (LSDICT.hasKey(id)): - return resError(Http409, "Store already exists: $1" % id) - let store = LS.addStore(id, id & ".db", config) - LS.updateConfig() - LSDICT[id] = store - result = getStore(LS, id, newQueryOptions(), req) - result.code = Http201 - except: - eWarn() - result = resError(Http500, "Unable to create store.") - -proc deleteIndex*(LS: LiteStore, id: string, req: LSRequest): LSResponse = - if (not id.match(PEG_INDEX)): - return resError(Http400, "invalid index ID: $1" % id) - if (LS.store.retrieveIndex(id) == newJNull()): - return resError(Http404, "Index not found: $1" % id) - try: - LS.store.dropIndex(id) - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Content-Length"] = "0" - result.content = "" - result.code = Http204 - except: - eWarn() - result = resError(Http500, "Unable to delete index.") - -proc deleteStore*(LS: LiteStore, id: string, req: LSRequest): LSResponse = - if (not id.match(PEG_STORE)): - return resError(Http400, "invalid store ID: $1" % id) - if (not LSDICT.hasKey(id)): - return resError(Http404, "Store not found: $1" % id) - try: - LSDICT.del(id) - if LS.config.hasKey("stores") and LS.config["stores"].hasKey(id): - LS.config["stores"].delete(id) - LS.updateConfig() - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Content-Length"] = "0" - result.content = "" - result.code = Http204 - except: - eWarn() - result = resError(Http500, "Unable to delete index.") - -proc postDocument*(LS: LiteStore, body: string, ct: string, folder="", req: LSRequest): LSResponse = - if not folder.isFolder: - return resError(Http400, "Invalid folder specified when creating document: $1" % folder) - try: - var doc = LS.store.createDocument(folder, body, ct) - if doc != "": - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = doc - result.code = Http201 - else: - result = resError(Http500, "Unable to create document.") - except: - eWarn() - result = resError(Http500, "Unable to create document.") - -proc putDocument*(LS: LiteStore, id: string, body: string, ct: string, req: LSRequest): LSResponse = - if id.isFolder: - return resError(Http400, "Invalid ID '$1' (Document IDs cannot end with '/')." % id) - let doc = LS.store.retrieveDocument(id) - if doc.data == "": - # Create a new document - var doc = LS.store.createDocument(id, body, ct) - if doc != "": - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = doc - result.code = Http201 - else: - result = resError(Http500, "Unable to create document.") - else: - # Update existing document - try: - var doc = LS.store.updateDocument(id, body, ct) - if doc != "": - result.headers = ctJsonHeader() - setOrigin(LS, req, result.headers) - result.content = doc - result.code = Http200 - else: - result = resError(Http500, "Unable to update document '$1'." % id) - except: - result = resError(Http500, "Unable to update document '$1'." % id) - -proc patchDocument*(LS: LiteStore, id: string, body: string, req: LSRequest): LSResponse = - var apply = true - let jbody = body.parseJson - if jbody.kind != JArray: - return resError(Http400, "Bad request: PATCH request body is not an array.") - var options = newQueryOptions() - options.select = @["documents.id AS id", "created", "modified", "data"] - let doc = LS.store.retrieveRawDocument(id, options) - if doc == "": - return resDocumentNotFound(id) - let jdoc = doc.parseJson - var tags = newSeq[string]() - var origTags = newSeq[string]() - for tag in jdoc["tags"].items: - tags.add(tag.str) - origTags.add(tag.str) - var data: JsonNode - var origData: JsonNode - if tags.contains("$subtype:json"): - try: - origData = jdoc["data"].getStr.parseJson - data = origData.copy - except: - discard - var c = 1 - for item in jbody.items: - if item.hasKey("op") and item.hasKey("path"): - if not item.hasKey("value"): - item["value"] = %"" - try: - apply = applyPatchOperation(data, origData, tags, item["op"].str, item["path"].str, item["value"]) - if not apply: - break - except: - return resError(Http400, "Bad request - $1" % getCurrentExceptionMsg()) - else: - return resError(Http400, "Bad request: patch operation #$1 is malformed." % $c) - c.inc - if apply: - # when document is not JSON the origData is not defined - # the extra check allows editing tags for non-JSON documents - if origData != nil and origData.len > 0 and origData != data: - try: - var doc = LS.store.updateDocument(id, data.pretty, "application/json") - if doc == "": - return resError(Http500, "Unable to patch document '$1'." % id) - except: - return resError(Http500, "Unable to patch document '$1' - $2" % id, getCurrentExceptionMsg()) - if origTags != tags: - try: - for t1 in jdoc["tags"].items: - discard LS.store.destroyTag(t1.str, id, true) - for t2 in tags: - if t2 != "": - LS.store.createTag(t2, id, true) - except: - return resError(Http500, "Unable to patch document '$1' - $2" % [id, getCurrentExceptionMsg()]) - return LS.getRawDocument(id, newQueryOptions(), req) - -# Main routing - -proc options*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - case resource: - of "info": - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - if id != "": - return resError(Http404, "Info '$1' not found." % id) - else: - result.code = Http204 - result.content = "" - of "dir": - result.code = Http204 - result.content = "" - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - of "tags": - result.code = Http204 - result.content = "" - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - of "indexes": - result.code = Http204 - result.content = "" - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - if id != "": - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - else: - result.headers["Allow"] = "GET, OPTIONS, PUT, DELETE" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS, PUT, DELETE" - else: - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - of "docs": - var folder: string - if id.isFolder: - folder = id - if folder.len > 0: - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS, POST, PUT" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, POST, PUT" - elif id != "": - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS, PUT, PATCH, DELETE" - result.headers["Allow-Patch"] = "application/json-patch+json" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, PUT, PATCH, DELETE" - else: - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "HEAD, GET, OPTIONS, POST" - result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, POST" - of "stores": - result.code = Http204 - result.content = "" - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - if id != "": - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - else: - result.headers["Allow"] = "GET, OPTIONS, PUT, DELETE" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS, PUT, DELETE" - else: - result.code = Http204 - result.content = "" - if LS.readonly: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - else: - result.headers = newHttpHeaders(TAB_HEADERS) - setOrigin(LS, req, result.headers) - result.headers["Allow"] = "GET, OPTIONS" - result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" - else: - discard # never happens really. - -proc head*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - var options = newQueryOptions() - options.select = @["documents.id AS id", "created", "modified"] - if id.isFolder: - options.folder = id - try: - parseQueryOptions(req.url.query, options); - if id != "" and options.folder == "": - result = LS.getRawDocument(id, options, req) - result.content = "" - else: - result = LS.getRawDocuments(options, req) - result.content = "" - except: - return resError(Http400, "Bad request - $1" % getCurrentExceptionMsg()) - -proc get*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - case resource: - of "docs": - var options = newQueryOptions() - if id.isFolder: - options.folder = id - if req.url.query.contains("contents=false"): - options.select = @["documents.id AS id", "created", "modified"] - try: - parseQueryOptions(req.url.query, options); - if id != "" and options.folder == "": - if req.url.query.contains("raw=true") or req.headers.hasKey("Accept") and req.headers["Accept"] == "application/json": - return LS.getRawDocument(id, options, req) - else: - return LS.getDocument(id, options, req) - else: - return LS.getRawDocuments(options, req) - except: - let e = getCurrentException() - let trace = e.getStackTrace() - echo trace - return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) - of "tags": - var options = newQueryOptions() - try: - parseQueryOptions(req.url.query, options); - if id != "": - return LS.getTag(id, options, req) - else: - return LS.getTags(options, req) - except: - return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) - of "indexes": - var options = newQueryOptions() - try: - parseQueryOptions(req.url.query, options); - if id != "": - return LS.getIndex(id, options, req) - else: - return LS.getIndexes(options, req) - except: - return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) - of "stores": - var options = newQueryOptions() - try: - parseQueryOptions(req.url.query, options); - if id != "": - return LS.getStore(id, options, req) - else: - return LS.getStores(options, req) - except: - return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) - of "info": - if id != "": - return resError(Http404, "Info '$1' not found." % id) - return LS.getInfo(req) - else: - discard # never happens really. - -proc post*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - var ct = "text/plain" - if req.headers.hasKey("Content-Type"): - ct = req.headers["Content-Type"] - return LS.postDocument(req.body.strip, ct, id, req) - -proc put*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - if id != "": - if resource == "indexes": - var field = "" - try: - field = parseJson(req.body.strip)["field"].getStr - except: - return resError(Http400, "Bad Request - Invalid JSON body - $1" % getCurrentExceptionMsg()) - return LS.putIndex(id, field, req) - elif resource == "stores": - var config = newJNull() - try: - config = parseJson(req.body) - except: - return resError(Http400, "Bad Request - Invalid JSON body - $1" % getCurrentExceptionMsg()) - return LS.putStore(id, config, req) - else: # Assume docs - var ct = "text/plain" - if req.headers.hasKey("Content-Type"): - ct = req.headers["Content-Type"] - return LS.putDocument(id, req.body.strip, ct, req) - else: - return resError(Http400, "Bad request: document ID must be specified in PUT requests.") - -proc delete*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - if id != "": - if resource == "indexes": - return LS.deleteIndex(id, req) - elif resource == "stores": - return LS.deleteStore(id, req) - else: # Assume docs - return LS.deleteDocument(id, req) - else: - return resError(Http400, "Bad request: document ID must be specified in DELETE requests.") - -proc patch*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = - if id != "": - return LS.patchDocument(id, req.body, req) - else: - return resError(Http400, "Bad request: document ID must be specified in PATCH requests.") - -proc serveFile*(req: LSRequest, LS: LiteStore, id: string): LSResponse = - let path = LS.directory / id - var reqMethod = $req.reqMethod - if req.headers.hasKey("X-HTTP-Method-Override"): - reqMethod = req.headers["X-HTTP-Method-Override"] - case reqMethod.toUpperAscii: - of "OPTIONS": - return validate(req, LS, "dir", id, options) - of "GET": - if path.fileExists: - try: - let contents = path.readFile - let parts = path.splitFile - if CONTENT_TYPES.hasKey(parts.ext): - result.headers = CONTENT_TYPES[parts.ext].ctHeader - else: - result.headers = ctHeader("text/plain") - setOrigin(LS, req, result.headers) - result.content = contents - result.code = Http200 - except: - return resError(Http500, "Unable to read file '$1'." % path) - else: - return resError(Http404, "File '$1' not found." % path) - else: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - -proc route*(req: LSRequest, LS: LiteStore, resource = "docs", id = ""): LSResponse = - var reqMethod = $req.reqMethod - if req.headers.hasKey("X-HTTP-Method-Override"): - reqMethod = req.headers["X-HTTP-Method-Override"] - LOG.debug("ROUTE - resource: " & resource & " id: " & id) - case reqMethod.toUpperAscii: - of "POST": - if LS.readonly: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - return validate(req, LS, resource, id, post) - of "PUT": - if LS.readonly: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - return validate(req, LS, resource, id, put) - of "DELETE": - if LS.readonly: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - return validate(req, LS, resource, id, delete) - of "HEAD": - return validate(req, LS, resource, id, head) - of "OPTIONS": - return validate(req, LS, resource, id, options) - of "GET": - return validate(req, LS, resource, id, get) - of "PATCH": - if LS.readonly: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - return validate(req, LS, resource, id, patch) - else: - return resError(Http405, "Method not allowed: $1" % $req.reqMethod) - -proc multiRoute(req: LSRequest, resource, id: string): LSResponse = - var matches = @["", "", ""] - if req.url.path.find(PEG_STORE_URL, matches) != -1: - let id = matches[0] - let path = "/v7/" & matches[1] - matches = @["", "", ""] - discard path.find(PEG_URL, matches) - return req.route(LSDICT[id], matches[1], matches[2]) - return req.route(LS, resource, id) - -proc newSimpleLSRequest(meth: HttpMethod, resource, id, body = "", params = "", headers = newHttpHeaders()): LSRequest = - result.reqMethod = meth - result.body = body - result.headers = headers - result.url = parseUri("$1://$2:$3/$4/$5?$6" % @["http", "localhost", "9500", resource, id, params]) - -proc get(resource, id: string, params = ""): LSResponse = - return newSimpleLSRequest(HttpGet, resource, id, "", params).multiRoute(resource, id) - -proc post(resource, folder, body: string, ct = ""): LSResponse = - var headers = newHttpHeaders() - if ct != "": - headers["Content-Type"] = ct - return newSimpleLSRequest(HttpPost, resource, folder, body, "", headers).multiRoute(resource, folder & "/") - -proc put(resource, id, body: string, ct = ""): LSResponse = - var headers = newHttpHeaders() - if ct != "": - headers["Content-Type"] = ct - return newSimpleLSRequest(HttpPut, resource, id, body, "", headers).multiRoute(resource, id) - -proc patch(resource, id, body: string): LSResponse = - var headers = newHttpHeaders() - headers["Content-Type"] = "application/json" - return newSimpleLSRequest(HttpPatch, resource, id, body, "", headers).multiRoute(resource, id) - -proc delete(resource, id: string): LSResponse = - return newSimpleLSRequest(HttpDelete, resource, id).multiRoute(resource, id) - -proc head(resource, id: string): LSResponse = - return newSimpleLSRequest(HttpHead, resource, id).multiRoute(resource, id) - -proc registerStoreApi(LS: LiteStore, ctx: DTContext, origResource, origId: string) = - var api_idx = ctx.duk_push_object() - # GET - var get: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let id = duk_get_string(ctx, 1) - let params = duk_get_string(ctx, 2) - let resp = get($resource, $id, $params) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, get, 3) - discard ctx.duk_put_prop_string(api_idx, "get") - # POST - var post: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let folder = duk_get_string(ctx, 1) - let body = duk_get_string(ctx, 2) - let ct = duk_get_string(ctx, 3) - let resp = post($resource, $folder, $body, $ct) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, post, 4) - discard ctx.duk_put_prop_string(api_idx, "post") - # PUT - var put: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let id = duk_get_string(ctx, 1) - let body = duk_get_string(ctx, 2) - let ct = duk_get_string(ctx, 3) - let resp = put($resource, $id, $body, $ct) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, put, 4) - discard ctx.duk_put_prop_string(api_idx, "put") - # PATCH - var patch: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let id = duk_get_string(ctx, 1) - let body = duk_get_string(ctx, 2) - let resp = patch($resource, $id, $body) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, patch, 3) - discard ctx.duk_put_prop_string(api_idx, "patch") - # DELETE - var delete: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let id = duk_get_string(ctx, 1) - let resp = delete($resource, $id) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, delete, 2) - discard ctx.duk_put_prop_string(api_idx, "delete") - # HEAD - var head: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = - let resource = duk_get_string(ctx, 0) - let id = duk_get_string(ctx, 1) - let resp = head($resource, $id) - var res_idx = ctx.duk_push_object() - ctx.duk_push_int(cast[cint](resp.code)) - discard ctx.duk_put_prop_string(res_idx, "code") - discard ctx.duk_push_string(resp.content) - discard ctx.duk_put_prop_string(res_idx, "content") - return 1 - ) - discard duk_push_c_function(ctx, head, 2) - discard ctx.duk_put_prop_string(api_idx, "head") - discard ctx.duk_put_global_string("$store") - -proc jError(ctx: DTContext): LSResponse = - return resError(Http500, "Middleware Error: " & $ctx.duk_safe_to_string(-1)) - -proc getMiddleware*(LS: LiteStore, id: string): string = - if not LS.middleware.hasKey(id): - # Attempt to retrieve resource from system documents - let options = newQueryOptions(true) - let doc = LS.store.retrieveDocument("middleware/" & id & ".js", options) - result = doc.data - if result == "": - LOG.warn("Middleware '$1' not found" % id) - else: - result = LS.middleware[id] - -proc getMiddlewareSeq(LS: LiteStore, resource, id, meth: string): seq[string] = - result = newSeq[string]() - if LS.config.kind != JObject or not LS.config.hasKey("resources"): - return - var reqUri = "/" & resource & "/" & id - if reqUri[^1] == '/': - reqUri.removeSuffix({'/'}) - let parts = reqUri.split("/") - let ancestors = parts[1..parts.len-2] - var currentPath = "" - var currentPaths = "" - for p in ancestors: - currentPath &= "/" & p - currentPaths = currentPath & "/*" - if LS.config["resources"].hasKey(currentPaths) and LS.config["resources"][currentPaths].hasKey(meth) and LS.config["resources"][currentPaths][meth].hasKey("middleware"): - let mw = LS.config["resources"][currentPaths][meth]["middleware"] - if (mw.kind == JArray): - for m in mw: - result.add m.getStr - if LS.config["resources"].hasKey(reqUri) and LS.config["resources"][reqUri].hasKey(meth) and LS.config["resources"][reqUri][meth].hasKey("middleware"): - let mw = LS.config["resources"][reqUri][meth]["middleware"] - if (mw.kind == JArray): - for m in mw: - result.add m.getStr - -proc execute*(req: var LSRequest, LS: LiteStore, resource, id: string): LSResponse = - let middleware = getMiddlewareSeq(LS, resource, id, $req.reqMethod) - if middleware.len > 0: - LOG.debug("Middleware: " & middleware.join(" -> ")); - if middleware.len == 0: - return route(req, LS, resource, id) - var jReq = $(%* req) - LOG.debug("Request: " & jReq) - var jRes = """{ - "code": 200, - "content": {}, - "final": false, - "headers": { - "Access-Control-Allow-Origin": "*", - "Access-Control-Allow-Headers": "Authorization, Content-Type", - "Server": "$1", - "Content-Type": "application/json" - } - }""" % [LS.appname & "/" & LS.appversion] - var context = "{}" - # Create execution context - var ctx = duk_create_heap_default() - duk_console_init(ctx) - duk_print_alert_init(ctx) - LS.registerStoreApi(ctx, resource, id) - if ctx.duk_peval_string("($1)" % $jReq) != 0: - return jError(ctx) - discard ctx.duk_put_global_string("$req") - if ctx.duk_peval_string("($1)" % $jRes) != 0: - return jError(ctx) - discard ctx.duk_put_global_string("$res") - if ctx.duk_peval_string("($1)" % $context) != 0: - return jError(ctx) - discard ctx.duk_put_global_string("$ctx") - # Middleware-specific functions - var i = 0 - var abort = 0 - while abort != 1 and i < middleware.len: - let code = LS.getMiddleware(middleware[i]) - LOG.debug("Evaluating middleware '$1'" % middleware[i]) - if ctx.duk_peval_string(code) != 0: - return jError(ctx) - abort = ctx.duk_get_boolean(-1) - i.inc - # Retrieve response, and request - if ctx.duk_peval_string("JSON.stringify($res);") != 0: - return jError(ctx) - let fRes = parseJson($(ctx.duk_get_string(-1))).newLSResponse - if ctx.duk_peval_string("JSON.stringify($req);") != 0: - return jError(ctx) - let fReq = parseJson($(ctx.duk_get_string(-1))).newLSRequest() - ctx.duk_destroy_heap(); - LOG.debug("abort: $1", [$abort]) - if abort == 1: - return fRes - return route(fReq, LS, resource, id) +import + asynchttpserver, + strutils, + sequtils, + cgi, + strtabs, + pegs, + json, + os, + uri, + tables, + times +import + types, + contenttypes, + core, + utils, + logger, + duktape + +# Helper procs + +proc sqlOp(op: string): string = + let table = newStringTable() + table["not eq"] = "<>" + table["eq"] = "==" + table["gt"] = ">" + table["gte"] = ">=" + table["lt"] = "<" + table["lte"] = "<=" + table["contains"] = "contains" + table["like"] = "like" + return table[op] + +proc orderByClauses*(str: string): string = + var clauses = newSeq[string]() + var fragments = str.split(",") + let clause = peg""" + clause <- {[-+]} {field} + field <- ('id' / 'created' / 'modified' / path) + path <- '$' (objField)+ + ident <- [a-zA-Z0-9_]+ + objField <- '.' ident + """ + for f in fragments: + var matches = @["", ""] + if f.find(clause, matches) != -1: + var field = matches[1] + if field[0] == '$': + field = "json_extract(documents.data, '$1')" % matches[1] + if matches[0] == "-": + clauses.add("$1 COLLATE NOCASE DESC" % field) + else: + clauses.add("$1 COLLATE NOCASE ASC" % field) + return clauses.join(", ") + +proc selectClause*(str: string, options: var QueryOptions) = + let tokens = """ + path <- '$' (objItem / objField)+ + ident <- [a-zA-Z0-9_]+ + objIndex <- '[' \d+ ']' + objField <- '.' ident + objItem <- objField objIndex + """ + let fields = peg(""" + fields <- ^{field} (\s* ',' \s* {field})*$ + field <- path \s+ ('as' / 'AS') \s+ ident + """ & tokens) + let field = peg(""" + field <- ^{path} \s+ ('as' / 'AS') \s+ {ident}$ + """ & tokens) + var fieldMatches = newSeq[string](10) + if str.strip.match(fields, fieldMatches): + for m in fieldMatches: + if m.len > 0: + var rawTuple = newSeq[string](2) + if m.match(field, rawTuple): + options.jsonSelect.add((path: rawTuple[0], alias: rawTuple[1])) + +proc filterClauses*(str: string, options: var QueryOptions) = + let tokens = """ + operator <- 'not eq' / 'eq' / 'gte' / 'gt' / 'lte' / 'lt' / 'contains' / 'like' + value <- string / number / 'null' / 'true' / 'false' + string <- '"' ('\\"' . / [^"])* '"' + number <- '-'? '0' / [1-9] [0-9]* ('.' [0-9]+)? (( 'e' / 'E' ) ( '+' / '-' )? [0-9]+)? + path <- '$' (objItem / objField)+ + ident <- [a-zA-Z0-9_]+ + objIndex <- '[' \d+ ']' + objField <- '.' ident + objItem <- objField objIndex + """ + let clause = peg(""" + clause <- {path} \s+ {operator} \s+ {value} + """ & tokens) + let andClauses = peg(""" + andClauses <- ^{clause} (\s+ 'and' \s+ {clause})*$ + clause <- path \s+ operator \s+ value + """ & tokens) + let orClauses = peg(""" + orClauses <- ^{andClauses} (\s+ 'or' \s+ {andClauses})*$ + andClauses <- clause (\s+ 'and' \s+ clause)* + clause <- path \s+ operator \s+ value + """ & tokens) + var orClausesMatches = newSeq[string](10) + discard str.strip.match(orClauses, orClausesMatches) + var parsedClauses = newSeq[seq[seq[string]]]() + for orClause in orClausesMatches: + if orClause.len > 0: + var andClausesMatches = newSeq[string](10) + discard orClause.strip.match(andClauses, andClausesMatches) + var parsedAndClauses = newSeq[seq[string]]() + for andClause in andClausesMatches: + if andClause.len > 0: + var clauses = newSeq[string](3) + discard andClause.strip.match(clause, clauses) + clauses[1] = sqlOp(clauses[1]) + if clauses[2] == "true": + clauses[2] = "1" + elif clauses[2] == "false": + clauses[2] = "0" + parsedAndClauses.add clauses + if parsedAndClauses.len > 0: + parsedClauses.add parsedAndClauses + if parsedClauses.len == 0: + return + var currentArr = 0 + var tables = newSeq[string]() + let resOrClauses = parsedClauses.map do (it: seq[seq[string]]) -> string: + let resAndClauses = it.map do (x: seq[string]) -> string: + if x[1] == "contains": + currentArr = currentArr + 1 + tables.add "json_each(documents.data, '$1') AS arr$2" % [x[0], $currentArr] + return "arr$1.value == $2" % [$currentArr, x[2]] + else: + var arr = @[x[0], x[1], x[2]] + if x[1] == "like": + arr[2] = x[2].replace('*', '%') + return "json_extract(documents.data, '$1') $2 $3 " % arr + return resAndClauses.join(" AND ") + options.tables = options.tables & tables + options.jsonFilter = resOrClauses.join(" OR ") + +proc parseQueryOption*(fragment: string, options: var QueryOptions) = + if fragment == "": + return + var pair = fragment.split('=') + if pair.len < 2 or pair[1] == "": + raise newException(EInvalidRequest, "Invalid query string fragment '$1'" % fragment) + try: + pair[1] = pair[1].replace("+", "%2B").decodeURL + except: + raise newException(EInvalidRequest, "Unable to decode query string fragment '$1'" % fragment) + case pair[0]: + of "filter": + filterClauses(pair[1], options) + if options.jsonFilter == "": + raise newException(EInvalidRequest, "Invalid filter clause: $1" % pair[1].replace("\"", "\\\"")) + of "select": + selectClause(pair[1], options) + if options.jsonSelect.len == 0: + raise newException(EInvalidRequest, "Invalid select clause: $1" % pair[1].replace("\"", "\\\"")) + of "like": + options.like = pair[1] + of "search": + options.search = pair[1] + of "tags": + options.tags = pair[1] + of "created-after": + try: + options.createdAfter = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") + except: + raise newException(EInvalidRequest, "Invalid created-after value: $1" % getCurrentExceptionMsg()) + of "created-before": + try: + options.createdBefore = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") + except: + raise newException(EInvalidRequest, "Invalid created-before value: $1" % getCurrentExceptionMsg()) + of "modified-after": + try: + options.modifiedAfter = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") + except: + raise newException(EInvalidRequest, "Invalid modified.after value: $1" % getCurrentExceptionMsg()) + of "modified-before": + try: + options.modifiedBefore = pair[1].parseInt.fromUnix.utc.format("yyyy-MM-dd'T'HH:mm:ss'Z'") + except: + raise newException(EInvalidRequest, "Invalid modified-before value: $1" % getCurrentExceptionMsg()) + of "limit": + try: + options.limit = pair[1].parseInt + except: + raise newException(EInvalidRequest, "Invalid limit value: $1" % getCurrentExceptionMsg()) + of "offset": + try: + options.offset = pair[1].parseInt + except: + raise newException(EInvalidRequest, "Invalid offset value: $1" % getCurrentExceptionMsg()) + of "sort": + let orderby = pair[1].orderByClauses() + if orderby != "": + options.orderby = orderby + else: + raise newException(EInvalidRequest, "Invalid sort value: $1" % pair[1]) + of "contents", "raw": + discard + else: + discard + +proc parseQueryOptions*(querystring: string, options: var QueryOptions) = + var q = querystring + if q.startsWith("?"): + q = q[1 .. q.len - 1] + var fragments = q.split('&') + for f in fragments: + f.parseQueryOption(options) + +proc validate*(req: LSRequest, LS: LiteStore, resource: string, id: string, cb: proc(req: LSRequest, LS: LiteStore, resource: string, id: string):LSResponse): LSResponse = + if req.reqMethod == HttpPost or req.reqMethod == HttpPut or req.reqMethod == HttpPatch: + var ct = "" + let body = req.body.strip + if body == "": + return resError(Http400, "Bad request: No content specified for document.") + if req.headers.hasKey("Content-Type"): + ct = req.headers["Content-Type"] + case ct: + of "application/json": + try: + discard body.parseJson() + except: + return resError(Http400, "Invalid JSON content - $1" % getCurrentExceptionMsg()) + else: + discard + return cb(req, LS, resource, id) + +proc patchTag(tags: var seq[string], index: int, op, path, value: string): bool = + LOG.debug("- PATCH -> $1 tag['$2'] = \"$3\" - Total tags: $4." % [op, $index, $value, $tags.len]) + case op: + of "remove": + let tag = tags[index] + if not tag.startsWith("$"): + tags[index] = "" # Not removing element, otherwise subsequent indexes won't work! + else: + raise newException(EInvalidRequest, "cannot remove system tag: $1" % tag) + of "add": + if value.match(PEG_USER_TAG): + tags.insert(value, index) + else: + if value.strip == "": + raise newException(EInvalidRequest, "tag not specified." % value) + else: + raise newException(EInvalidRequest, "invalid tag: $1" % value) + of "replace": + if value.match(PEG_USER_TAG): + if tags[index].startsWith("$"): + raise newException(EInvalidRequest, "cannot replace system tag: $1" % tags[index]) + else: + tags[index] = value + else: + if value.strip == "": + raise newException(EInvalidRequest, "tag not specified." % value) + else: + raise newException(EInvalidRequest, "invalid tag: $1" % value) + of "test": + if tags[index] != value: + return false + else: + raise newException(EInvalidRequest, "invalid patch operation: $1" % op) + return true + +proc patchData*(data: var JsonNode, origData: JsonNode, op: string, path: string, value: JsonNode): bool = + LOG.debug("- PATCH -> $1 path $2 with $3" % [op, path, $value]) + var keys = path.replace(peg"^\/data\/", "").split("/") + if keys.len == 0: + raise newException(EInvalidRequest, "no valid path specified: $1" % path) + var d = data + var dorig = origData + var c = 1 + for key in keys: + if d.kind == JArray: + try: + var index = key.parseInt + if c >= keys.len: + d.elems[index] = value + case op: + of "remove": + d.elems.del(index) + of "add": + d.elems.insert(value, index) + of "replace": + d.elems[index] = value + of "test": + if d.elems[index] != value: + return false + else: + raise newException(EInvalidRequest, "invalid patch operation: $1" % op) + else: + d = d[index] + dorig = dorig[index] + except: + raise newException(EInvalidRequest, "invalid index key '$1' in path '$2'" % [key, path]) + else: + if c >= keys.len: + case op: + of "remove": + if d.hasKey(key): + d.delete(key) + else: + raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) + of "add": + d[key] = value + of "replace": + if d.hasKey(key): + d[key] = value + else: + raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) + of "test": + if dorig.hasKey(key): + if dorig[key] != value: + return false + else: + raise newException(EInvalidRequest, "key '$1' not found in path '$2'" % [key, path]) + else: + raise newException(EInvalidRequest, "invalid patch operation: $1" % op) + else: + d = d[key] + dorig = dorig[key] + c += 1 + return true + + +proc applyPatchOperation*(data: var JsonNode, origData: JsonNode, tags: var seq[string], op: string, path: string, value: JsonNode): bool = + var matches = @[""] + let p = peg""" + path <- ^tagPath / fieldPath$ + tagPath <- '\/tags\/' {\d+} + fieldPath <- '\/data\/' ident ('\/' ident)* + ident <- [a-zA-Z0-9_]+ / '-' + """ + if path.find(p, matches) == -1: + raise newException(EInvalidRequest, "cannot patch path '$1'" % path) + if path.match(peg"^\/tags\/"): + let index = matches[0].parseInt + if value.kind != JString: + raise newException(EInvalidRequest, "tag '$1' is not a string." % $value) + let tag = value.getStr + return patchTag(tags, index, op, path, tag) + elif tags.contains("$subtype:json"): + return patchData(data, origData, op, path, value) + else: + raise newException(EInvalidRequest, "cannot patch data of a non-JSON document.") + +# Low level procs + +proc getTag*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = + let doc = LS.store.retrieveTag(id, options) + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + if doc == newJNull(): + result = resTagNotFound(id) + else: + result.content = $doc + result.code = Http200 + +proc getStore*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = + if (not LSDICT.hasKey(id)): + return resStoreNotFound(id) + let store = LSDICT[id] + var doc = newJObject() + doc["id"] = %id + doc["file"] = %store.file + doc["config"] = store.config + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = $doc + result.code = Http200 + +proc getIndex*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = + let doc = LS.store.retrieveIndex(id, options) + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + if doc == newJNull(): + result = resIndexNotFound(id) + else: + result.content = $doc + result.code = Http200 + +proc getRawDocument*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = + let doc = LS.store.retrieveRawDocument(id, options) + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + if doc == "": + result = resDocumentNotFound(id) + else: + result.content = doc + result.code = Http200 + +proc getDocument*(LS: LiteStore, id: string, options = newQueryOptions(), req: LSRequest): LSResponse = + let doc = LS.store.retrieveDocument(id, options) + if doc.data == "": + result = resDocumentNotFound(id) + else: + result.headers = doc.contenttype.ctHeader + setOrigin(LS, req, result.headers) + result.content = doc.data + result.code = Http200 + +proc deleteDocument*(LS: LiteStore, id: string, req: LSRequest): LSResponse = + let doc = LS.store.retrieveDocument(id) + if doc.data == "": + result = resDocumentNotFound(id) + else: + try: + let res = LS.store.destroyDocument(id) + if res == 0: + result = resError(Http500, "Unable to delete document '$1'" % id) + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Content-Length"] = "0" + result.content = "" + result.code = Http204 + except: + result = resError(Http500, "Unable to delete document '$1'" % id) + +proc getTags*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = + var options = options + let t0 = cpuTime() + let docs = LS.store.retrieveTags(options) + let orig_limit = options.limit + let orig_offset = options.offset + options.limit = 0 + options.offset = 0 + options.select = @["COUNT(tag_id)"] + let total = LS.store.countTags(prepareSelectTagsQuery(options), options.like.replace("*", "%")) + var content = newJObject() + if options.like != "": + content["like"] = %(options.like.decodeURL) + if orig_limit > 0: + content["limit"] = %orig_limit + if orig_offset > 0: + content["offset"] = %orig_offset + content["total"] = %total + content["execution_time"] = %(cputime()-t0) + content["results"] = docs + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = content.pretty + result.code = Http200 + +proc getStores(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = + let t0 = cpuTime() + var docs = newJArray() + for k, v in LSDICT.pairs: + var store = newJObject() + store["id"] = %k + store["file"] = %v.file + store["config"] = v.config + docs.add(store) + var content = newJObject() + content["total"] = %LSDICT.len + content["execution_time"] = %(cputime()-t0) + content["results"] = docs + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = content.pretty + result.code = Http200 + +proc getIndexes*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = + var options = options + let t0 = cpuTime() + let docs = LS.store.retrieveIndexes(options) + let orig_limit = options.limit + let orig_offset = options.offset + options.limit = 0 + options.offset = 0 + options.select = @["COUNT(name)"] + let total = LS.store.countIndexes(prepareSelectIndexesQuery(options), options.like.replace("*", "%")) + var content = newJObject() + if options.like != "": + content["like"] = %(options.like.decodeURL) + if orig_limit > 0: + content["limit"] = %orig_limit + if orig_offset > 0: + content["offset"] = %orig_offset + content["total"] = %total + content["execution_time"] = %(cputime()-t0) + content["results"] = docs + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = content.pretty + result.code = Http200 + +proc getRawDocuments*(LS: LiteStore, options: QueryOptions = newQueryOptions(), req: LSRequest): LSResponse = + var options = options + let t0 = cpuTime() + let docs = LS.store.retrieveRawDocuments(options) + let orig_limit = options.limit + let orig_offset = options.offset + options.limit = 0 + options.offset = 0 + options.select = @["COUNT(docid)"] + let total = LS.store.retrieveRawDocuments(options)[0].num + var content = newJObject() + if options.folder != "": + content["folder"] = %(options.folder) + if options.search != "": + content["search"] = %(options.search.decodeURL) + if options.tags != "": + content["tags"] = newJArray() + for tag in options.tags.replace("+", "%2B").decodeURL.split(","): + content["tags"].add(%tag) + if orig_limit > 0: + content["limit"] = %orig_limit + if orig_offset > 0: + content["offset"] = %orig_offset + if options.orderby != "": + content["sort"] = %options.orderby + content["total"] = %total + content["execution_time"] = %(cputime()-t0) + content["results"] = docs + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = content.pretty + result.code = Http200 + +proc getInfo*(LS: LiteStore, req: LSRequest): LSResponse = + let info = LS.store.retrieveInfo() + let version = info[0] + let total_documents = info[1] + let total_tags = LS.store.countTags() + let tags = LS.store.retrieveTagsWithTotals() + var content = newJObject() + content["version"] = %(LS.appname & " v" & LS.appversion) + content["datastore_version"] = %version + content["api_version"] = %7 + content["size"] = %($((LS.file.getFileSize().float/(1024*1024)).formatFloat(ffDecimal, 2)) & " MB") + content["read_only"] = %LS.readonly + content["log_level"] = %LS.loglevel + if LS.directory.len == 0: + content["directory"] = newJNull() + else: + content["directory"] = %LS.directory + content["mount"] = %LS.mount + if LS.config != newJNull() and LS.config.hasKey("stores") and LS.config["stores"].len > 0: + content["additional_stores"] = %toSeq(LS.config["stores"].keys) + else: + content["additional_stores"] = newJArray() + if LS.auth != newJNull(): + content["auth"] = %true + else: + content["auth"] = %false + content["total_documents"] = %total_documents + content["total_tags"] = %total_tags + content["tags"] = tags + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = content.pretty + result.code = Http200 + +proc putIndex*(LS: LiteStore, id, field: string, req: LSRequest): LSResponse = + try: + if (not id.match(PEG_INDEX)): + return resError(Http400, "invalid index ID: $1" % id) + if (not field.match(PEG_JSON_FIELD)): + return resError(Http400, "invalid field path: $1" % field) + if (LS.store.retrieveIndex(id) != newJNull()): + return resError(Http409, "Index already exists: $1" % id) + LS.store.createIndex(id, field) + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = "{\"id\": \"$1\", \"field\": \"$2\"}" % [id, field] + result.code = Http201 + except: + eWarn() + result = resError(Http500, "Unable to create index.") + +proc putStore*(LS: LiteStore, id: string, config: JsonNode, req: LSRequest): LSResponse = + try: + if (not id.match(PEG_STORE) or id == "master"): + return resError(Http400, "invalid store ID: $1" % id) + if (LSDICT.hasKey(id)): + return resError(Http409, "Store already exists: $1" % id) + let store = LS.addStore(id, id & ".db", config) + LS.updateConfig() + LSDICT[id] = store + result = getStore(LS, id, newQueryOptions(), req) + result.code = Http201 + except: + eWarn() + result = resError(Http500, "Unable to create store.") + +proc deleteIndex*(LS: LiteStore, id: string, req: LSRequest): LSResponse = + if (not id.match(PEG_INDEX)): + return resError(Http400, "invalid index ID: $1" % id) + if (LS.store.retrieveIndex(id) == newJNull()): + return resError(Http404, "Index not found: $1" % id) + try: + LS.store.dropIndex(id) + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Content-Length"] = "0" + result.content = "" + result.code = Http204 + except: + eWarn() + result = resError(Http500, "Unable to delete index.") + +proc deleteStore*(LS: LiteStore, id: string, req: LSRequest): LSResponse = + if (not id.match(PEG_STORE)): + return resError(Http400, "invalid store ID: $1" % id) + if (not LSDICT.hasKey(id)): + return resError(Http404, "Store not found: $1" % id) + try: + LSDICT.del(id) + if LS.config.hasKey("stores") and LS.config["stores"].hasKey(id): + LS.config["stores"].delete(id) + LS.updateConfig() + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Content-Length"] = "0" + result.content = "" + result.code = Http204 + except: + eWarn() + result = resError(Http500, "Unable to delete index.") + +proc postDocument*(LS: LiteStore, body: string, ct: string, folder="", req: LSRequest): LSResponse = + if not folder.isFolder: + return resError(Http400, "Invalid folder specified when creating document: $1" % folder) + try: + var doc = LS.store.createDocument(folder, body, ct) + if doc != "": + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = doc + result.code = Http201 + else: + result = resError(Http500, "Unable to create document.") + except: + eWarn() + result = resError(Http500, "Unable to create document.") + +proc putDocument*(LS: LiteStore, id: string, body: string, ct: string, req: LSRequest): LSResponse = + if id.isFolder: + return resError(Http400, "Invalid ID '$1' (Document IDs cannot end with '/')." % id) + let doc = LS.store.retrieveDocument(id) + if doc.data == "": + # Create a new document + var doc = LS.store.createDocument(id, body, ct) + if doc != "": + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = doc + result.code = Http201 + else: + result = resError(Http500, "Unable to create document.") + else: + # Update existing document + try: + var doc = LS.store.updateDocument(id, body, ct) + if doc != "": + result.headers = ctJsonHeader() + setOrigin(LS, req, result.headers) + result.content = doc + result.code = Http200 + else: + result = resError(Http500, "Unable to update document '$1'." % id) + except: + result = resError(Http500, "Unable to update document '$1'." % id) + +proc patchDocument*(LS: LiteStore, id: string, body: string, req: LSRequest): LSResponse = + var apply = true + let jbody = body.parseJson + if jbody.kind != JArray: + return resError(Http400, "Bad request: PATCH request body is not an array.") + var options = newQueryOptions() + options.select = @["documents.id AS id", "created", "modified", "data"] + let doc = LS.store.retrieveRawDocument(id, options) + if doc == "": + return resDocumentNotFound(id) + let jdoc = doc.parseJson + var tags = newSeq[string]() + var origTags = newSeq[string]() + for tag in jdoc["tags"].items: + tags.add(tag.str) + origTags.add(tag.str) + var data: JsonNode + var origData: JsonNode + if tags.contains("$subtype:json"): + try: + origData = jdoc["data"].getStr.parseJson + data = origData.copy + except: + discard + var c = 1 + for item in jbody.items: + if item.hasKey("op") and item.hasKey("path"): + if not item.hasKey("value"): + item["value"] = %"" + try: + apply = applyPatchOperation(data, origData, tags, item["op"].str, item["path"].str, item["value"]) + if not apply: + break + except: + return resError(Http400, "Bad request - $1" % getCurrentExceptionMsg()) + else: + return resError(Http400, "Bad request: patch operation #$1 is malformed." % $c) + c.inc + if apply: + # when document is not JSON the origData is not defined + # the extra check allows editing tags for non-JSON documents + if origData != nil and origData.len > 0 and origData != data: + try: + var doc = LS.store.updateDocument(id, data.pretty, "application/json") + if doc == "": + return resError(Http500, "Unable to patch document '$1'." % id) + except: + return resError(Http500, "Unable to patch document '$1' - $2" % id, getCurrentExceptionMsg()) + if origTags != tags: + try: + for t1 in jdoc["tags"].items: + discard LS.store.destroyTag(t1.str, id, true) + for t2 in tags: + if t2 != "": + LS.store.createTag(t2, id, true) + except: + return resError(Http500, "Unable to patch document '$1' - $2" % [id, getCurrentExceptionMsg()]) + return LS.getRawDocument(id, newQueryOptions(), req) + +# Main routing + +proc options*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + case resource: + of "info": + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + if id != "": + return resError(Http404, "Info '$1' not found." % id) + else: + result.code = Http204 + result.content = "" + of "dir": + result.code = Http204 + result.content = "" + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + of "tags": + result.code = Http204 + result.content = "" + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + of "indexes": + result.code = Http204 + result.content = "" + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + if id != "": + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + else: + result.headers["Allow"] = "GET, OPTIONS, PUT, DELETE" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS, PUT, DELETE" + else: + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + of "docs": + var folder: string + if id.isFolder: + folder = id + if folder.len > 0: + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS, POST, PUT" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, POST, PUT" + elif id != "": + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS, PUT, PATCH, DELETE" + result.headers["Allow-Patch"] = "application/json-patch+json" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, PUT, PATCH, DELETE" + else: + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS" + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "HEAD, GET, OPTIONS, POST" + result.headers["Access-Control-Allow-Methods"] = "HEAD, GET, OPTIONS, POST" + of "stores": + result.code = Http204 + result.content = "" + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + if id != "": + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + else: + result.headers["Allow"] = "GET, OPTIONS, PUT, DELETE" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS, PUT, DELETE" + else: + result.code = Http204 + result.content = "" + if LS.readonly: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + else: + result.headers = newHttpHeaders(TAB_HEADERS) + setOrigin(LS, req, result.headers) + result.headers["Allow"] = "GET, OPTIONS" + result.headers["Access-Control-Allow-Methods"] = "GET, OPTIONS" + else: + discard # never happens really. + +proc head*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + var options = newQueryOptions() + options.select = @["documents.id AS id", "created", "modified"] + if id.isFolder: + options.folder = id + try: + parseQueryOptions(req.url.query, options); + if id != "" and options.folder == "": + result = LS.getRawDocument(id, options, req) + result.content = "" + else: + result = LS.getRawDocuments(options, req) + result.content = "" + except: + return resError(Http400, "Bad request - $1" % getCurrentExceptionMsg()) + +proc get*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + case resource: + of "docs": + var options = newQueryOptions() + if id.isFolder: + options.folder = id + if req.url.query.contains("contents=false"): + options.select = @["documents.id AS id", "created", "modified"] + try: + parseQueryOptions(req.url.query, options); + if id != "" and options.folder == "": + if req.url.query.contains("raw=true") or req.headers.hasKey("Accept") and req.headers["Accept"] == "application/json": + return LS.getRawDocument(id, options, req) + else: + return LS.getDocument(id, options, req) + else: + return LS.getRawDocuments(options, req) + except: + let e = getCurrentException() + let trace = e.getStackTrace() + echo trace + return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) + of "tags": + var options = newQueryOptions() + try: + parseQueryOptions(req.url.query, options); + if id != "": + return LS.getTag(id, options, req) + else: + return LS.getTags(options, req) + except: + return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) + of "indexes": + var options = newQueryOptions() + try: + parseQueryOptions(req.url.query, options); + if id != "": + return LS.getIndex(id, options, req) + else: + return LS.getIndexes(options, req) + except: + return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) + of "stores": + var options = newQueryOptions() + try: + parseQueryOptions(req.url.query, options); + if id != "": + return LS.getStore(id, options, req) + else: + return LS.getStores(options, req) + except: + return resError(Http400, "Bad Request - $1" % getCurrentExceptionMsg()) + of "info": + if id != "": + return resError(Http404, "Info '$1' not found." % id) + return LS.getInfo(req) + else: + discard # never happens really. + +proc post*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + var ct = "text/plain" + if req.headers.hasKey("Content-Type"): + ct = req.headers["Content-Type"] + return LS.postDocument(req.body.strip, ct, id, req) + +proc put*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + if id != "": + if resource == "indexes": + var field = "" + try: + field = parseJson(req.body.strip)["field"].getStr + except: + return resError(Http400, "Bad Request - Invalid JSON body - $1" % getCurrentExceptionMsg()) + return LS.putIndex(id, field, req) + elif resource == "stores": + var config = newJNull() + try: + config = parseJson(req.body) + except: + return resError(Http400, "Bad Request - Invalid JSON body - $1" % getCurrentExceptionMsg()) + return LS.putStore(id, config, req) + else: # Assume docs + var ct = "text/plain" + if req.headers.hasKey("Content-Type"): + ct = req.headers["Content-Type"] + return LS.putDocument(id, req.body.strip, ct, req) + else: + return resError(Http400, "Bad request: document ID must be specified in PUT requests.") + +proc delete*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + if id != "": + if resource == "indexes": + return LS.deleteIndex(id, req) + elif resource == "stores": + return LS.deleteStore(id, req) + else: # Assume docs + return LS.deleteDocument(id, req) + else: + return resError(Http400, "Bad request: document ID must be specified in DELETE requests.") + +proc patch*(req: LSRequest, LS: LiteStore, resource: string, id = ""): LSResponse = + if id != "": + return LS.patchDocument(id, req.body, req) + else: + return resError(Http400, "Bad request: document ID must be specified in PATCH requests.") + +proc serveFile*(req: LSRequest, LS: LiteStore, id: string): LSResponse = + let path = LS.directory / id + var reqMethod = $req.reqMethod + if req.headers.hasKey("X-HTTP-Method-Override"): + reqMethod = req.headers["X-HTTP-Method-Override"] + case reqMethod.toUpperAscii: + of "OPTIONS": + return validate(req, LS, "dir", id, options) + of "GET": + if path.fileExists: + try: + let contents = path.readFile + let parts = path.splitFile + if CONTENT_TYPES.hasKey(parts.ext): + result.headers = CONTENT_TYPES[parts.ext].ctHeader + else: + result.headers = ctHeader("text/plain") + setOrigin(LS, req, result.headers) + result.content = contents + result.code = Http200 + except: + return resError(Http500, "Unable to read file '$1'." % path) + else: + return resError(Http404, "File '$1' not found." % path) + else: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + +proc route*(req: LSRequest, LS: LiteStore, resource = "docs", id = ""): LSResponse = + var reqMethod = $req.reqMethod + if req.headers.hasKey("X-HTTP-Method-Override"): + reqMethod = req.headers["X-HTTP-Method-Override"] + LOG.debug("ROUTE - resource: " & resource & " id: " & id) + case reqMethod.toUpperAscii: + of "POST": + if LS.readonly: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + return validate(req, LS, resource, id, post) + of "PUT": + if LS.readonly: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + return validate(req, LS, resource, id, put) + of "DELETE": + if LS.readonly: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + return validate(req, LS, resource, id, delete) + of "HEAD": + return validate(req, LS, resource, id, head) + of "OPTIONS": + return validate(req, LS, resource, id, options) + of "GET": + return validate(req, LS, resource, id, get) + of "PATCH": + if LS.readonly: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + return validate(req, LS, resource, id, patch) + else: + return resError(Http405, "Method not allowed: $1" % $req.reqMethod) + +proc multiRoute(req: LSRequest, resource, id: string): LSResponse = + var matches = @["", "", ""] + if req.url.path.find(PEG_STORE_URL, matches) != -1: + let id = matches[0] + let path = "/v7/" & matches[1] + matches = @["", "", ""] + discard path.find(PEG_URL, matches) + return req.route(LSDICT[id], matches[1], matches[2]) + return req.route(LS, resource, id) + +proc newSimpleLSRequest(meth: HttpMethod, resource, id, body = "", params = "", headers = newHttpHeaders()): LSRequest = + result.reqMethod = meth + result.body = body + result.headers = headers + result.url = parseUri("$1://$2:$3/$4/$5?$6" % @["http", "localhost", "9500", resource, id, params]) + +proc get(resource, id: string, params = ""): LSResponse = + return newSimpleLSRequest(HttpGet, resource, id, "", params).multiRoute(resource, id) + +proc post(resource, folder, body: string, ct = ""): LSResponse = + var headers = newHttpHeaders() + if ct != "": + headers["Content-Type"] = ct + return newSimpleLSRequest(HttpPost, resource, folder, body, "", headers).multiRoute(resource, folder & "/") + +proc put(resource, id, body: string, ct = ""): LSResponse = + var headers = newHttpHeaders() + if ct != "": + headers["Content-Type"] = ct + return newSimpleLSRequest(HttpPut, resource, id, body, "", headers).multiRoute(resource, id) + +proc patch(resource, id, body: string): LSResponse = + var headers = newHttpHeaders() + headers["Content-Type"] = "application/json" + return newSimpleLSRequest(HttpPatch, resource, id, body, "", headers).multiRoute(resource, id) + +proc delete(resource, id: string): LSResponse = + return newSimpleLSRequest(HttpDelete, resource, id).multiRoute(resource, id) + +proc head(resource, id: string): LSResponse = + return newSimpleLSRequest(HttpHead, resource, id).multiRoute(resource, id) + +proc registerStoreApi(LS: LiteStore, ctx: DTContext, origResource, origId: string) = + var api_idx = ctx.duk_push_object() + # GET + var get: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let id = duk_get_string(ctx, 1) + let params = duk_get_string(ctx, 2) + let resp = get($resource, $id, $params) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, get, 3) + discard ctx.duk_put_prop_string(api_idx, "get") + # POST + var post: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let folder = duk_get_string(ctx, 1) + let body = duk_get_string(ctx, 2) + let ct = duk_get_string(ctx, 3) + let resp = post($resource, $folder, $body, $ct) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, post, 4) + discard ctx.duk_put_prop_string(api_idx, "post") + # PUT + var put: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let id = duk_get_string(ctx, 1) + let body = duk_get_string(ctx, 2) + let ct = duk_get_string(ctx, 3) + let resp = put($resource, $id, $body, $ct) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, put, 4) + discard ctx.duk_put_prop_string(api_idx, "put") + # PATCH + var patch: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let id = duk_get_string(ctx, 1) + let body = duk_get_string(ctx, 2) + let resp = patch($resource, $id, $body) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, patch, 3) + discard ctx.duk_put_prop_string(api_idx, "patch") + # DELETE + var delete: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let id = duk_get_string(ctx, 1) + let resp = delete($resource, $id) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, delete, 2) + discard ctx.duk_put_prop_string(api_idx, "delete") + # HEAD + var head: DTCFunction = (proc (ctx: DTContext): cint{.stdcall.} = + let resource = duk_get_string(ctx, 0) + let id = duk_get_string(ctx, 1) + let resp = head($resource, $id) + var res_idx = ctx.duk_push_object() + ctx.duk_push_int(cast[cint](resp.code)) + discard ctx.duk_put_prop_string(res_idx, "code") + discard ctx.duk_push_string(resp.content.cstring) + discard ctx.duk_put_prop_string(res_idx, "content") + return 1 + ) + discard duk_push_c_function(ctx, head, 2) + discard ctx.duk_put_prop_string(api_idx, "head") + discard ctx.duk_put_global_string("$store") + +proc jError(ctx: DTContext): LSResponse = + return resError(Http500, "Middleware Error: " & $ctx.duk_safe_to_string(-1)) + +proc getMiddleware*(LS: LiteStore, id: string): string = + if not LS.middleware.hasKey(id): + # Attempt to retrieve resource from system documents + let options = newQueryOptions(true) + let doc = LS.store.retrieveDocument("middleware/" & id & ".js", options) + result = doc.data + if result == "": + LOG.warn("Middleware '$1' not found" % id) + else: + result = LS.middleware[id] + +proc getMiddlewareSeq(LS: LiteStore, resource, id, meth: string): seq[string] = + result = newSeq[string]() + if LS.config.kind != JObject or not LS.config.hasKey("resources"): + return + var reqUri = "/" & resource & "/" & id + if reqUri[^1] == '/': + reqUri.removeSuffix({'/'}) + let parts = reqUri.split("/") + let ancestors = parts[1..parts.len-2] + var currentPath = "" + var currentPaths = "" + for p in ancestors: + currentPath &= "/" & p + currentPaths = currentPath & "/*" + if LS.config["resources"].hasKey(currentPaths) and LS.config["resources"][currentPaths].hasKey(meth) and LS.config["resources"][currentPaths][meth].hasKey("middleware"): + let mw = LS.config["resources"][currentPaths][meth]["middleware"] + if (mw.kind == JArray): + for m in mw: + result.add m.getStr + if LS.config["resources"].hasKey(reqUri) and LS.config["resources"][reqUri].hasKey(meth) and LS.config["resources"][reqUri][meth].hasKey("middleware"): + let mw = LS.config["resources"][reqUri][meth]["middleware"] + if (mw.kind == JArray): + for m in mw: + result.add m.getStr + +proc execute*(req: var LSRequest, LS: LiteStore, resource, id: string): LSResponse = + let middleware = getMiddlewareSeq(LS, resource, id, $req.reqMethod) + if middleware.len > 0: + LOG.debug("Middleware: " & middleware.join(" -> ")); + if middleware.len == 0: + return route(req, LS, resource, id) + var jReq = $(%* req) + LOG.debug("Request: " & jReq) + var jRes = """{ + "code": 200, + "content": {}, + "final": false, + "headers": { + "Access-Control-Allow-Origin": "*", + "Access-Control-Allow-Headers": "Authorization, Content-Type", + "Server": "$1", + "Content-Type": "application/json" + } + }""" % [LS.appname & "/" & LS.appversion] + var context = "{}" + # Create execution context + var ctx = duk_create_heap_default() + duk_console_init(ctx) + duk_print_alert_init(ctx) + LS.registerStoreApi(ctx, resource, id) + if ctx.duk_peval_string(cstring("($1)" % $jReq)) != 0: + return jError(ctx) + discard ctx.duk_put_global_string("$req") + if ctx.duk_peval_string(cstring("($1)" % $jRes)) != 0: + return jError(ctx) + discard ctx.duk_put_global_string("$res") + if ctx.duk_peval_string(cstring("($1)" % $context)) != 0: + return jError(ctx) + discard ctx.duk_put_global_string("$ctx") + # Middleware-specific functions + var i = 0 + var abort = 0 + while abort != 1 and i < middleware.len: + let code = LS.getMiddleware(middleware[i]) + LOG.debug("Evaluating middleware '$1'" % middleware[i]) + if ctx.duk_peval_string(code.cstring) != 0: + return jError(ctx) + abort = ctx.duk_get_boolean(-1) + i.inc + # Retrieve response, and request + if ctx.duk_peval_string("JSON.stringify($res);") != 0: + return jError(ctx) + let fRes = parseJson($(ctx.duk_get_string(-1))).newLSResponse + if ctx.duk_peval_string("JSON.stringify($req);") != 0: + return jError(ctx) + let fReq = parseJson($(ctx.duk_get_string(-1))).newLSRequest() + ctx.duk_destroy_heap(); + LOG.debug("abort: $1", [$abort]) + if abort == 1: + return fRes + return route(fReq, LS, resource, id)
M
src/litestorepkg/lib/x_db_sqlite.nim
→
src/litestorepkg/lib/x_db_sqlite.nim
@@ -1,638 +1,638 @@
-# -# -# Nim's Runtime Library -# (c) Copyright 2015 Andreas Rumpf -# -# See the file "copying.txt", included in this -# distribution, for details about the copyright. -# - -## A higher level `SQLite`:idx: database wrapper. This interface -## is implemented for other databases too. -## -## Basic usage -## =========== -## -## The basic flow of using this module is: -## -## 1. Open database connection -## 2. Execute SQL query -## 3. Close database connection -## -## Parameter substitution -## ---------------------- -## -## All ``db_*`` modules support the same form of parameter substitution. -## That is, using the ``?`` (question mark) to signify the place where a -## value should be placed. For example: -## -## .. code-block:: Nim -## -## sql"INSERT INTO my_table (colA, colB, colC) VALUES (?, ?, ?)" -## -## Opening a connection to a database -## ---------------------------------- -## -## .. code-block:: Nim -## -## import db_sqlite -## -## # user, password, database name can be empty. -## # These params are not used on db_sqlite module. -## let db = open("mytest.db", "", "", "") -## db.close() -## -## Creating a table -## ---------------- -## -## .. code-block:: Nim -## -## db.exec(sql"DROP TABLE IF EXISTS my_table") -## db.exec(sql"""CREATE TABLE my_table ( -## id INTEGER, -## name VARCHAR(50) NOT NULL -## )""") -## -## Inserting data -## -------------- -## -## .. code-block:: Nim -## -## db.exec(sql"INSERT INTO my_table (id, name) VALUES (0, ?)", -## "Jack") -## -## Larger example -## -------------- -## -## .. code-block:: nim -## -## import db_sqlite, math -## -## let db = open("mytest.db", "", "", "") -## -## db.exec(sql"DROP TABLE IF EXISTS my_table") -## db.exec(sql"""CREATE TABLE my_table ( -## id INTEGER PRIMARY KEY, -## name VARCHAR(50) NOT NULL, -## i INT(11), -## f DECIMAL(18, 10) -## )""") -## -## db.exec(sql"BEGIN") -## for i in 1..1000: -## db.exec(sql"INSERT INTO my_table (name, i, f) VALUES (?, ?, ?)", -## "Item#" & $i, i, sqrt(i.float)) -## db.exec(sql"COMMIT") -## -## for x in db.fastRows(sql"SELECT * FROM my_table"): -## echo x -## -## let id = db.tryInsertId(sql"""INSERT INTO my_table (name, i, f) -## VALUES (?, ?, ?)""", -## "Item#1001", 1001, sqrt(1001.0)) -## echo "Inserted item: ", db.getValue(sql"SELECT name FROM my_table WHERE id=?", id) -## -## db.close() -## -## See also -## ======== -## -## * `db_odbc module <db_odbc.html>`_ for ODBC database wrapper -## * `db_mysql module <db_mysql.html>`_ for MySQL database wrapper -## * `db_postgres module <db_postgres.html>`_ for PostgreSQL database wrapper - -{.deadCodeElim: on.} # dce option deprecated - -import x_sqlite3 as sqlite3 # h3rald - -import db_common -export db_common - -type - DbConn* = PSqlite3 ## Encapsulates a database connection. - Row* = seq[string] ## A row of a dataset. `NULL` database values will be - ## converted to an empty string. - InstantRow* = PStmt ## A handle that can be used to get a row's column - ## text on demand. - -proc dbError*(db: DbConn) {.noreturn.} = - ## Raises a `DbError` exception. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## if not db.tryExec(sql"SELECT * FROM not_exist_table"): - ## dbError(db) - ## db.close() - var e: ref DbError - new(e) - e.msg = $sqlite3.errmsg(db) - raise e - -proc dbQuote*(s: string): string = - ## Escapes the `'` (single quote) char to `''`. - ## Because single quote is used for defining `VARCHAR` in SQL. - runnableExamples: - doAssert dbQuote("'") == "''''" - doAssert dbQuote("A Foobar's pen.") == "'A Foobar''s pen.'" - - result = "'" - for c in items(s): - if c == '\'': add(result, "''") - else: add(result, c) - add(result, '\'') - -proc dbFormat(formatstr: SqlQuery, args: varargs[string]): string = - result = "" - var a = 0 - for c in items(string(formatstr)): - if c == '?': - add(result, dbQuote(args[a])) - inc(a) - else: - add(result, c) - -proc tryExec*(db: DbConn, query: SqlQuery, - args: varargs[string, `$`]): bool {. - tags: [ReadDbEffect, WriteDbEffect].} = - ## Tries to execute the query and returns `true` if successful, `false` otherwise. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## if not db.tryExec(sql"SELECT * FROM my_table"): - ## dbError(db) - ## db.close() - assert(not db.isNil, "Database not connected.") - var q = dbFormat(query, args) - var stmt: sqlite3.PStmt - if prepare_v2(db, q, q.len.cint, stmt, nil) == SQLITE_OK: - let x = step(stmt) - if x in {SQLITE_DONE, SQLITE_ROW}: - result = finalize(stmt) == SQLITE_OK - -proc exec*(db: DbConn, query: SqlQuery, args: varargs[string, `$`]) {. - tags: [ReadDbEffect, WriteDbEffect].} = - ## Executes the query and raises a `DbError` exception if not successful. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## try: - ## db.exec(sql"INSERT INTO my_table (id, name) VALUES (?, ?)", - ## 1, "item#1") - ## except: - ## stderr.writeLine(getCurrentExceptionMsg()) - ## finally: - ## db.close() - if not tryExec(db, query, args): dbError(db) - -proc newRow(L: int): Row = - newSeq(result, L) - for i in 0..L-1: result[i] = "" - -proc setupQuery(db: DbConn, query: SqlQuery, - args: varargs[string]): PStmt = - assert(not db.isNil, "Database not connected.") - var q = dbFormat(query, args) - if prepare_v2(db, q, q.len.cint, result, nil) != SQLITE_OK: dbError(db) - -proc setRow(stmt: PStmt, r: var Row, cols: cint) = - for col in 0'i32..cols-1: - setLen(r[col], column_bytes(stmt, col)) # set capacity - setLen(r[col], 0) - let x = column_text(stmt, col) - if not isNil(x): add(r[col], x) - -iterator fastRows*(db: DbConn, query: SqlQuery, - args: varargs[string, `$`]): Row {.tags: [ReadDbEffect].} = - ## Executes the query and iterates over the result dataset. - ## - ## This is very fast, but potentially dangerous. Use this iterator only - ## if you require **ALL** the rows. - ## - ## **Note:** Breaking the `fastRows()` iterator during a loop will cause the - ## next database query to raise a `DbError` exception ``unable to close due - ## to ...``. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## - ## # Records of my_table: - ## # | id | name | - ## # |----|----------| - ## # | 1 | item#1 | - ## # | 2 | item#2 | - ## - ## for row in db.fastRows(sql"SELECT id, name FROM my_table"): - ## echo row - ## - ## # Output: - ## # @["1", "item#1"] - ## # @["2", "item#2"] - ## - ## db.close() - var stmt = setupQuery(db, query, args) - var L = (column_count(stmt)) - var result = newRow(L) - try: - while step(stmt) == SQLITE_ROW: - setRow(stmt, result, L) - yield result - finally: - if finalize(stmt) != SQLITE_OK: dbError(db) - -iterator instantRows*(db: DbConn, query: SqlQuery, - args: varargs[string, `$`]): InstantRow - {.tags: [ReadDbEffect].} = - ## Similar to `fastRows iterator <#fastRows.i,DbConn,SqlQuery,varargs[string,]>`_ - ## but returns a handle that can be used to get column text - ## on demand using `[]`. Returned handle is valid only within the iterator body. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## - ## # Records of my_table: - ## # | id | name | - ## # |----|----------| - ## # | 1 | item#1 | - ## # | 2 | item#2 | - ## - ## for row in db.instantRows(sql"SELECT * FROM my_table"): - ## echo "id:" & row[0] - ## echo "name:" & row[1] - ## echo "length:" & $len(row) - ## - ## # Output: - ## # id:1 - ## # name:item#1 - ## # length:2 - ## # id:2 - ## # name:item#2 - ## # length:2 - ## - ## db.close() - var stmt = setupQuery(db, query, args) - try: - while step(stmt) == SQLITE_ROW: - yield stmt - finally: - if finalize(stmt) != SQLITE_OK: dbError(db) - -proc toTypeKind(t: var DbType; x: int32) = - case x - of SQLITE_INTEGER: - t.kind = dbInt - t.size = 8 - of SQLITE_FLOAT: - t.kind = dbFloat - t.size = 8 - of SQLITE_BLOB: t.kind = dbBlob - of SQLITE_NULL: t.kind = dbNull - of SQLITE_TEXT: t.kind = dbVarchar - else: t.kind = dbUnknown - -proc setColumns(columns: var DbColumns; x: PStmt) = - let L = column_count(x) - setLen(columns, L) - for i in 0'i32 ..< L: - columns[i].name = $column_name(x, i) - columns[i].typ.name = $column_decltype(x, i) - toTypeKind(columns[i].typ, column_type(x, i)) - columns[i].tableName = $column_table_name(x, i) - -iterator instantRows*(db: DbConn; columns: var DbColumns; query: SqlQuery, - args: varargs[string, `$`]): InstantRow - {.tags: [ReadDbEffect].} = - ## Similar to `instantRows iterator <#instantRows.i,DbConn,SqlQuery,varargs[string,]>`_, - ## but sets information about columns to `columns`. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## - ## # Records of my_table: - ## # | id | name | - ## # |----|----------| - ## # | 1 | item#1 | - ## # | 2 | item#2 | - ## - ## var columns: DbColumns - ## for row in db.instantRows(columns, sql"SELECT * FROM my_table"): - ## discard - ## echo columns[0] - ## - ## # Output: - ## # (name: "id", tableName: "my_table", typ: (kind: dbNull, - ## # notNull: false, name: "INTEGER", size: 0, maxReprLen: 0, precision: 0, - ## # scale: 0, min: 0, max: 0, validValues: @[]), primaryKey: false, - ## # foreignKey: false) - ## - ## db.close() - var stmt = setupQuery(db, query, args) - setColumns(columns, stmt) - try: - while step(stmt) == SQLITE_ROW: - yield stmt - finally: - if finalize(stmt) != SQLITE_OK: dbError(db) - -proc `[]`*(row: InstantRow, col: int32): string {.inline.} = - ## Returns text for given column of the row. - ## - ## See also: - ## * `instantRows iterator <#instantRows.i,DbConn,SqlQuery,varargs[string,]>`_ - ## example code - $column_text(row, col) - -proc unsafeColumnAt*(row: InstantRow, index: int32): cstring {.inline.} = - ## Returns cstring for given column of the row. - ## - ## See also: - ## * `instantRows iterator <#instantRows.i,DbConn,SqlQuery,varargs[string,]>`_ - ## example code - column_text(row, index) - -proc len*(row: InstantRow): int32 {.inline.} = - ## Returns number of columns in a row. - ## - ## See also: - ## * `instantRows iterator <#instantRows.i,DbConn,SqlQuery,varargs[string,]>`_ - ## example code - column_count(row) - -proc getRow*(db: DbConn, query: SqlQuery, - args: varargs[string, `$`]): Row {.tags: [ReadDbEffect].} = - ## Retrieves a single row. If the query doesn't return any rows, this proc - ## will return a `Row` with empty strings for each column. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## - ## # Records of my_table: - ## # | id | name | - ## # |----|----------| - ## # | 1 | item#1 | - ## # | 2 | item#2 | - ## - ## doAssert db.getRow(sql"SELECT id, name FROM my_table" - ## ) == Row(@["1", "item#1"]) - ## doAssert db.getRow(sql"SELECT id, name FROM my_table WHERE id = ?", - ## 2) == Row(@["2", "item#2"]) - ## - ## # Returns empty. - ## doAssert db.getRow(sql"INSERT INTO my_table (id, name) VALUES (?, ?)", - ## 3, "item#3") == @[] - ## doAssert db.getRow(sql"DELETE FROM my_table WHERE id = ?", 3) == @[] - ## doAssert db.getRow(sql"UPDATE my_table SET name = 'ITEM#1' WHERE id = ?", - ## 1) == @[] - ## db.close() - var stmt = setupQuery(db, query, args) - var L = (column_count(stmt)) - result = newRow(L) - if step(stmt) == SQLITE_ROW: - setRow(stmt, result, L) - if finalize(stmt) != SQLITE_OK: dbError(db) - -proc getAllRows*(db: DbConn, query: SqlQuery, - args: varargs[string, `$`]): seq[Row] {.tags: [ReadDbEffect].} = - ## Executes the query and returns the whole result dataset. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## - ## # Records of my_table: - ## # | id | name | - ## # |----|----------| - ## # | 1 | item#1 | - ## # | 2 | item#2 | - ## - ## doAssert db.getAllRows(sql"SELECT id, name FROM my_table") == @[Row(@["1", "item#1"]), Row(@["2", "item#2"])] - ## db.close() - result = @[] - for r in fastRows(db, query, args): - result.add(r) - -iterator rows*(db: DbConn, query: SqlQuery, - args: varargs[string, `$`]): Row {.tags: [ReadDbEffect].} = - ## Similar to `fastRows iterator <#fastRows.i,DbConn,SqlQuery,varargs[string,]>`_, - ## but slower and safe. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## - ## # Records of my_table: - ## # | id | name | - ## # |----|----------| - ## # | 1 | item#1 | - ## # | 2 | item#2 | - ## - ## for row in db.rows(sql"SELECT id, name FROM my_table"): - ## echo row - ## - ## ## Output: - ## ## @["1", "item#1"] - ## ## @["2", "item#2"] - ## - ## db.close() - for r in fastRows(db, query, args): yield r - -proc getValue*(db: DbConn, query: SqlQuery, - args: varargs[string, `$`]): string {.tags: [ReadDbEffect].} = - ## Executes the query and returns the first column of the first row of the - ## result dataset. Returns `""` if the dataset contains no rows or the database - ## value is `NULL`. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## - ## # Records of my_table: - ## # | id | name | - ## # |----|----------| - ## # | 1 | item#1 | - ## # | 2 | item#2 | - ## - ## doAssert db.getValue(sql"SELECT name FROM my_table WHERE id = ?", - ## 2) == "item#2" - ## doAssert db.getValue(sql"SELECT id, name FROM my_table") == "1" - ## doAssert db.getValue(sql"SELECT name, id FROM my_table") == "item#1" - ## - ## db.close() - var stmt = setupQuery(db, query, args) - if step(stmt) == SQLITE_ROW: - let cb = column_bytes(stmt, 0) - if cb == 0: - result = "" - else: - result = newStringOfCap(cb) - add(result, column_text(stmt, 0)) - else: - result = "" - if finalize(stmt) != SQLITE_OK: dbError(db) - -proc tryInsertID*(db: DbConn, query: SqlQuery, - args: varargs[string, `$`]): int64 - {.tags: [WriteDbEffect], raises: [].} = - ## Executes the query (typically "INSERT") and returns the - ## generated ID for the row or -1 in case of an error. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## db.exec(sql"CREATE TABLE my_table (id INTEGER, name VARCHAR(50) NOT NULL)") - ## - ## doAssert db.tryInsertID(sql"INSERT INTO not_exist_table (id, name) VALUES (?, ?)", - ## 1, "item#1") == -1 - ## db.close() - assert(not db.isNil, "Database not connected.") - var q = dbFormat(query, args) - var stmt: sqlite3.PStmt - result = -1 - if prepare_v2(db, q, q.len.cint, stmt, nil) == SQLITE_OK: - if step(stmt) == SQLITE_DONE: - result = last_insert_rowid(db) - if finalize(stmt) != SQLITE_OK: - result = -1 - -proc insertID*(db: DbConn, query: SqlQuery, - args: varargs[string, `$`]): int64 {.tags: [WriteDbEffect].} = - ## Executes the query (typically "INSERT") and returns the - ## generated ID for the row. - ## - ## Raises a `DbError` exception when failed to insert row. - ## For Postgre this adds ``RETURNING id`` to the query, so it only works - ## if your primary key is named ``id``. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## db.exec(sql"CREATE TABLE my_table (id INTEGER, name VARCHAR(50) NOT NULL)") - ## - ## for i in 0..2: - ## let id = db.insertID(sql"INSERT INTO my_table (id, name) VALUES (?, ?)", i, "item#" & $i) - ## echo "LoopIndex = ", i, ", InsertID = ", id - ## - ## # Output: - ## # LoopIndex = 0, InsertID = 1 - ## # LoopIndex = 1, InsertID = 2 - ## # LoopIndex = 2, InsertID = 3 - ## - ## db.close() - result = tryInsertID(db, query, args) - if result < 0: dbError(db) - -proc execAffectedRows*(db: DbConn, query: SqlQuery, - args: varargs[string, `$`]): int64 {. - tags: [ReadDbEffect, WriteDbEffect].} = - ## Executes the query (typically "UPDATE") and returns the - ## number of affected rows. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## - ## # Records of my_table: - ## # | id | name | - ## # |----|----------| - ## # | 1 | item#1 | - ## # | 2 | item#2 | - ## - ## doAssert db.execAffectedRows(sql"UPDATE my_table SET name = 'TEST'") == 2 - ## - ## db.close() - exec(db, query, args) - result = changes(db) - -proc close*(db: DbConn) {.tags: [DbEffect].} = - ## Closes the database connection. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## let db = open("mytest.db", "", "", "") - ## db.close() - if sqlite3.close(db) != SQLITE_OK: dbError(db) - -proc open*(connection, user, password, database: string): DbConn {. - tags: [DbEffect].} = - ## Opens a database connection. Raises a `DbError` exception if the connection - ## could not be established. - ## - ## **Note:** Only the ``connection`` parameter is used for ``sqlite``. - ## - ## **Examples:** - ## - ## .. code-block:: Nim - ## - ## try: - ## let db = open("mytest.db", "", "", "") - ## ## do something... - ## ## db.getAllRows(sql"SELECT * FROM my_table") - ## db.close() - ## except: - ## stderr.writeLine(getCurrentExceptionMsg()) - var db: DbConn - if sqlite3.open(connection, db) == SQLITE_OK: - result = db - else: - dbError(db) - -proc setEncoding*(connection: DbConn, encoding: string): bool {. - tags: [DbEffect].} = - ## Sets the encoding of a database connection, returns `true` for - ## success, `false` for failure. - ## - ## **Note:** The encoding cannot be changed once it's been set. - ## According to SQLite3 documentation, any attempt to change - ## the encoding after the database is created will be silently - ## ignored. - exec(connection, sql"PRAGMA encoding = ?", [encoding]) - result = connection.getValue(sql"PRAGMA encoding") == encoding - -when not defined(testing) and isMainModule: - var db = open("db.sql", "", "", "") - exec(db, sql"create table tbl1(one varchar(10), two smallint)", []) - exec(db, sql"insert into tbl1 values('hello!',10)", []) - exec(db, sql"insert into tbl1 values('goodbye', 20)", []) - #db.query("create table tbl1(one varchar(10), two smallint)") - #db.query("insert into tbl1 values('hello!',10)") - #db.query("insert into tbl1 values('goodbye', 20)") - for r in db.rows(sql"select * from tbl1", []): - echo(r[0], r[1]) - for r in db.instantRows(sql"select * from tbl1", []): - echo(r[0], r[1]) - - x_db_sqlite.close(db) # h3rald +# +# +# Nim's Runtime Library +# (c) Copyright 2015 Andreas Rumpf +# +# See the file "copying.txt", included in this +# distribution, for details about the copyright. +# + +## A higher level `SQLite`:idx: database wrapper. This interface +## is implemented for other databases too. +## +## Basic usage +## =========== +## +## The basic flow of using this module is: +## +## 1. Open database connection +## 2. Execute SQL query +## 3. Close database connection +## +## Parameter substitution +## ---------------------- +## +## All ``db_*`` modules support the same form of parameter substitution. +## That is, using the ``?`` (question mark) to signify the place where a +## value should be placed. For example: +## +## .. code-block:: Nim +## +## sql"INSERT INTO my_table (colA, colB, colC) VALUES (?, ?, ?)" +## +## Opening a connection to a database +## ---------------------------------- +## +## .. code-block:: Nim +## +## import db_sqlite +## +## # user, password, database name can be empty. +## # These params are not used on db_sqlite module. +## let db = open("mytest.db", "", "", "") +## db.close() +## +## Creating a table +## ---------------- +## +## .. code-block:: Nim +## +## db.exec(sql"DROP TABLE IF EXISTS my_table") +## db.exec(sql"""CREATE TABLE my_table ( +## id INTEGER, +## name VARCHAR(50) NOT NULL +## )""") +## +## Inserting data +## -------------- +## +## .. code-block:: Nim +## +## db.exec(sql"INSERT INTO my_table (id, name) VALUES (0, ?)", +## "Jack") +## +## Larger example +## -------------- +## +## .. code-block:: nim +## +## import db_sqlite, math +## +## let db = open("mytest.db", "", "", "") +## +## db.exec(sql"DROP TABLE IF EXISTS my_table") +## db.exec(sql"""CREATE TABLE my_table ( +## id INTEGER PRIMARY KEY, +## name VARCHAR(50) NOT NULL, +## i INT(11), +## f DECIMAL(18, 10) +## )""") +## +## db.exec(sql"BEGIN") +## for i in 1..1000: +## db.exec(sql"INSERT INTO my_table (name, i, f) VALUES (?, ?, ?)", +## "Item#" & $i, i, sqrt(i.float)) +## db.exec(sql"COMMIT") +## +## for x in db.fastRows(sql"SELECT * FROM my_table"): +## echo x +## +## let id = db.tryInsertId(sql"""INSERT INTO my_table (name, i, f) +## VALUES (?, ?, ?)""", +## "Item#1001", 1001, sqrt(1001.0)) +## echo "Inserted item: ", db.getValue(sql"SELECT name FROM my_table WHERE id=?", id) +## +## db.close() +## +## See also +## ======== +## +## * `db_odbc module <db_odbc.html>`_ for ODBC database wrapper +## * `db_mysql module <db_mysql.html>`_ for MySQL database wrapper +## * `db_postgres module <db_postgres.html>`_ for PostgreSQL database wrapper + +{.deadCodeElim: on.} # dce option deprecated + +import x_sqlite3 as sqlite3 # h3rald + +import db_common +export db_common + +type + DbConn* = PSqlite3 ## Encapsulates a database connection. + Row* = seq[string] ## A row of a dataset. `NULL` database values will be + ## converted to an empty string. + InstantRow* = PStmt ## A handle that can be used to get a row's column + ## text on demand. + +proc dbError*(db: DbConn) {.noreturn.} = + ## Raises a `DbError` exception. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## if not db.tryExec(sql"SELECT * FROM not_exist_table"): + ## dbError(db) + ## db.close() + var e: ref DbError + new(e) + e.msg = $sqlite3.errmsg(db) + raise e + +proc dbQuote*(s: string): string = + ## Escapes the `'` (single quote) char to `''`. + ## Because single quote is used for defining `VARCHAR` in SQL. + runnableExamples: + doAssert dbQuote("'") == "''''" + doAssert dbQuote("A Foobar's pen.") == "'A Foobar''s pen.'" + + result = "'" + for c in items(s): + if c == '\'': add(result, "''") + else: add(result, c) + add(result, '\'') + +proc dbFormat(formatstr: SqlQuery, args: varargs[string]): string = + result = "" + var a = 0 + for c in items(string(formatstr)): + if c == '?': + add(result, dbQuote(args[a])) + inc(a) + else: + add(result, c) + +proc tryExec*(db: DbConn, query: SqlQuery, + args: varargs[string, `$`]): bool {. + tags: [ReadDbEffect, WriteDbEffect].} = + ## Tries to execute the query and returns `true` if successful, `false` otherwise. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## if not db.tryExec(sql"SELECT * FROM my_table"): + ## dbError(db) + ## db.close() + assert(not db.isNil, "Database not connected.") + var q = dbFormat(query, args) + var stmt: sqlite3.PStmt + if prepare_v2(db, q.cstring, q.cstring.len.cint, stmt, nil) == SQLITE_OK: + let x = step(stmt) + if x in {SQLITE_DONE, SQLITE_ROW}: + result = finalize(stmt) == SQLITE_OK + +proc exec*(db: DbConn, query: SqlQuery, args: varargs[string, `$`]) {. + tags: [ReadDbEffect, WriteDbEffect].} = + ## Executes the query and raises a `DbError` exception if not successful. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## try: + ## db.exec(sql"INSERT INTO my_table (id, name) VALUES (?, ?)", + ## 1, "item#1") + ## except: + ## stderr.writeLine(getCurrentExceptionMsg()) + ## finally: + ## db.close() + if not tryExec(db, query, args): dbError(db) + +proc newRow(L: int): Row = + newSeq(result, L) + for i in 0..L-1: result[i] = "" + +proc setupQuery(db: DbConn, query: SqlQuery, + args: varargs[string]): PStmt = + assert(not db.isNil, "Database not connected.") + var q = dbFormat(query, args) + if prepare_v2(db, q.cstring, q.len.cint, result, nil) != SQLITE_OK: dbError(db) + +proc setRow(stmt: PStmt, r: var Row, cols: cint) = + for col in 0'i32..cols-1: + setLen(r[col], column_bytes(stmt, col)) # set capacity + setLen(r[col], 0) + let x = column_text(stmt, col) + if not isNil(x): add(r[col], x) + +iterator fastRows*(db: DbConn, query: SqlQuery, + args: varargs[string, `$`]): Row {.tags: [ReadDbEffect].} = + ## Executes the query and iterates over the result dataset. + ## + ## This is very fast, but potentially dangerous. Use this iterator only + ## if you require **ALL** the rows. + ## + ## **Note:** Breaking the `fastRows()` iterator during a loop will cause the + ## next database query to raise a `DbError` exception ``unable to close due + ## to ...``. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## + ## # Records of my_table: + ## # | id | name | + ## # |----|----------| + ## # | 1 | item#1 | + ## # | 2 | item#2 | + ## + ## for row in db.fastRows(sql"SELECT id, name FROM my_table"): + ## echo row + ## + ## # Output: + ## # @["1", "item#1"] + ## # @["2", "item#2"] + ## + ## db.close() + var stmt = setupQuery(db, query, args) + var L = (column_count(stmt)) + var result = newRow(L) + try: + while step(stmt) == SQLITE_ROW: + setRow(stmt, result, L) + yield result + finally: + if finalize(stmt) != SQLITE_OK: dbError(db) + +iterator instantRows*(db: DbConn, query: SqlQuery, + args: varargs[string, `$`]): InstantRow + {.tags: [ReadDbEffect].} = + ## Similar to `fastRows iterator <#fastRows.i,DbConn,SqlQuery,varargs[string,]>`_ + ## but returns a handle that can be used to get column text + ## on demand using `[]`. Returned handle is valid only within the iterator body. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## + ## # Records of my_table: + ## # | id | name | + ## # |----|----------| + ## # | 1 | item#1 | + ## # | 2 | item#2 | + ## + ## for row in db.instantRows(sql"SELECT * FROM my_table"): + ## echo "id:" & row[0] + ## echo "name:" & row[1] + ## echo "length:" & $len(row) + ## + ## # Output: + ## # id:1 + ## # name:item#1 + ## # length:2 + ## # id:2 + ## # name:item#2 + ## # length:2 + ## + ## db.close() + var stmt = setupQuery(db, query, args) + try: + while step(stmt) == SQLITE_ROW: + yield stmt + finally: + if finalize(stmt) != SQLITE_OK: dbError(db) + +proc toTypeKind(t: var DbType; x: int32) = + case x + of SQLITE_INTEGER: + t.kind = dbInt + t.size = 8 + of SQLITE_FLOAT: + t.kind = dbFloat + t.size = 8 + of SQLITE_BLOB: t.kind = dbBlob + of SQLITE_NULL: t.kind = dbNull + of SQLITE_TEXT: t.kind = dbVarchar + else: t.kind = dbUnknown + +proc setColumns(columns: var DbColumns; x: PStmt) = + let L = column_count(x) + setLen(columns, L) + for i in 0'i32 ..< L: + columns[i].name = $column_name(x, i) + columns[i].typ.name = $column_decltype(x, i) + toTypeKind(columns[i].typ, column_type(x, i)) + columns[i].tableName = $column_table_name(x, i) + +iterator instantRows*(db: DbConn; columns: var DbColumns; query: SqlQuery, + args: varargs[string, `$`]): InstantRow + {.tags: [ReadDbEffect].} = + ## Similar to `instantRows iterator <#instantRows.i,DbConn,SqlQuery,varargs[string,]>`_, + ## but sets information about columns to `columns`. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## + ## # Records of my_table: + ## # | id | name | + ## # |----|----------| + ## # | 1 | item#1 | + ## # | 2 | item#2 | + ## + ## var columns: DbColumns + ## for row in db.instantRows(columns, sql"SELECT * FROM my_table"): + ## discard + ## echo columns[0] + ## + ## # Output: + ## # (name: "id", tableName: "my_table", typ: (kind: dbNull, + ## # notNull: false, name: "INTEGER", size: 0, maxReprLen: 0, precision: 0, + ## # scale: 0, min: 0, max: 0, validValues: @[]), primaryKey: false, + ## # foreignKey: false) + ## + ## db.close() + var stmt = setupQuery(db, query, args) + setColumns(columns, stmt) + try: + while step(stmt) == SQLITE_ROW: + yield stmt + finally: + if finalize(stmt) != SQLITE_OK: dbError(db) + +proc `[]`*(row: InstantRow, col: int32): string {.inline.} = + ## Returns text for given column of the row. + ## + ## See also: + ## * `instantRows iterator <#instantRows.i,DbConn,SqlQuery,varargs[string,]>`_ + ## example code + $column_text(row, col) + +proc unsafeColumnAt*(row: InstantRow, index: int32): cstring {.inline.} = + ## Returns cstring for given column of the row. + ## + ## See also: + ## * `instantRows iterator <#instantRows.i,DbConn,SqlQuery,varargs[string,]>`_ + ## example code + column_text(row, index) + +proc len*(row: InstantRow): int32 {.inline.} = + ## Returns number of columns in a row. + ## + ## See also: + ## * `instantRows iterator <#instantRows.i,DbConn,SqlQuery,varargs[string,]>`_ + ## example code + column_count(row) + +proc getRow*(db: DbConn, query: SqlQuery, + args: varargs[string, `$`]): Row {.tags: [ReadDbEffect].} = + ## Retrieves a single row. If the query doesn't return any rows, this proc + ## will return a `Row` with empty strings for each column. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## + ## # Records of my_table: + ## # | id | name | + ## # |----|----------| + ## # | 1 | item#1 | + ## # | 2 | item#2 | + ## + ## doAssert db.getRow(sql"SELECT id, name FROM my_table" + ## ) == Row(@["1", "item#1"]) + ## doAssert db.getRow(sql"SELECT id, name FROM my_table WHERE id = ?", + ## 2) == Row(@["2", "item#2"]) + ## + ## # Returns empty. + ## doAssert db.getRow(sql"INSERT INTO my_table (id, name) VALUES (?, ?)", + ## 3, "item#3") == @[] + ## doAssert db.getRow(sql"DELETE FROM my_table WHERE id = ?", 3) == @[] + ## doAssert db.getRow(sql"UPDATE my_table SET name = 'ITEM#1' WHERE id = ?", + ## 1) == @[] + ## db.close() + var stmt = setupQuery(db, query, args) + var L = (column_count(stmt)) + result = newRow(L) + if step(stmt) == SQLITE_ROW: + setRow(stmt, result, L) + if finalize(stmt) != SQLITE_OK: dbError(db) + +proc getAllRows*(db: DbConn, query: SqlQuery, + args: varargs[string, `$`]): seq[Row] {.tags: [ReadDbEffect].} = + ## Executes the query and returns the whole result dataset. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## + ## # Records of my_table: + ## # | id | name | + ## # |----|----------| + ## # | 1 | item#1 | + ## # | 2 | item#2 | + ## + ## doAssert db.getAllRows(sql"SELECT id, name FROM my_table") == @[Row(@["1", "item#1"]), Row(@["2", "item#2"])] + ## db.close() + result = @[] + for r in fastRows(db, query, args): + result.add(r) + +iterator rows*(db: DbConn, query: SqlQuery, + args: varargs[string, `$`]): Row {.tags: [ReadDbEffect].} = + ## Similar to `fastRows iterator <#fastRows.i,DbConn,SqlQuery,varargs[string,]>`_, + ## but slower and safe. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## + ## # Records of my_table: + ## # | id | name | + ## # |----|----------| + ## # | 1 | item#1 | + ## # | 2 | item#2 | + ## + ## for row in db.rows(sql"SELECT id, name FROM my_table"): + ## echo row + ## + ## ## Output: + ## ## @["1", "item#1"] + ## ## @["2", "item#2"] + ## + ## db.close() + for r in fastRows(db, query, args): yield r + +proc getValue*(db: DbConn, query: SqlQuery, + args: varargs[string, `$`]): string {.tags: [ReadDbEffect].} = + ## Executes the query and returns the first column of the first row of the + ## result dataset. Returns `""` if the dataset contains no rows or the database + ## value is `NULL`. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## + ## # Records of my_table: + ## # | id | name | + ## # |----|----------| + ## # | 1 | item#1 | + ## # | 2 | item#2 | + ## + ## doAssert db.getValue(sql"SELECT name FROM my_table WHERE id = ?", + ## 2) == "item#2" + ## doAssert db.getValue(sql"SELECT id, name FROM my_table") == "1" + ## doAssert db.getValue(sql"SELECT name, id FROM my_table") == "item#1" + ## + ## db.close() + var stmt = setupQuery(db, query, args) + if step(stmt) == SQLITE_ROW: + let cb = column_bytes(stmt, 0) + if cb == 0: + result = "" + else: + result = newStringOfCap(cb) + add(result, column_text(stmt, 0)) + else: + result = "" + if finalize(stmt) != SQLITE_OK: dbError(db) + +proc tryInsertID*(db: DbConn, query: SqlQuery, + args: varargs[string, `$`]): int64 + {.tags: [WriteDbEffect], raises: [].} = + ## Executes the query (typically "INSERT") and returns the + ## generated ID for the row or -1 in case of an error. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## db.exec(sql"CREATE TABLE my_table (id INTEGER, name VARCHAR(50) NOT NULL)") + ## + ## doAssert db.tryInsertID(sql"INSERT INTO not_exist_table (id, name) VALUES (?, ?)", + ## 1, "item#1") == -1 + ## db.close() + assert(not db.isNil, "Database not connected.") + var q = dbFormat(query, args) + var stmt: sqlite3.PStmt + result = -1 + if prepare_v2(db, q.cstring, q.cstring.len.cint, stmt, nil) == SQLITE_OK: + if step(stmt) == SQLITE_DONE: + result = last_insert_rowid(db) + if finalize(stmt) != SQLITE_OK: + result = -1 + +proc insertID*(db: DbConn, query: SqlQuery, + args: varargs[string, `$`]): int64 {.tags: [WriteDbEffect].} = + ## Executes the query (typically "INSERT") and returns the + ## generated ID for the row. + ## + ## Raises a `DbError` exception when failed to insert row. + ## For Postgre this adds ``RETURNING id`` to the query, so it only works + ## if your primary key is named ``id``. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## db.exec(sql"CREATE TABLE my_table (id INTEGER, name VARCHAR(50) NOT NULL)") + ## + ## for i in 0..2: + ## let id = db.insertID(sql"INSERT INTO my_table (id, name) VALUES (?, ?)", i, "item#" & $i) + ## echo "LoopIndex = ", i, ", InsertID = ", id + ## + ## # Output: + ## # LoopIndex = 0, InsertID = 1 + ## # LoopIndex = 1, InsertID = 2 + ## # LoopIndex = 2, InsertID = 3 + ## + ## db.close() + result = tryInsertID(db, query, args) + if result < 0: dbError(db) + +proc execAffectedRows*(db: DbConn, query: SqlQuery, + args: varargs[string, `$`]): int64 {. + tags: [ReadDbEffect, WriteDbEffect].} = + ## Executes the query (typically "UPDATE") and returns the + ## number of affected rows. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## + ## # Records of my_table: + ## # | id | name | + ## # |----|----------| + ## # | 1 | item#1 | + ## # | 2 | item#2 | + ## + ## doAssert db.execAffectedRows(sql"UPDATE my_table SET name = 'TEST'") == 2 + ## + ## db.close() + exec(db, query, args) + result = changes(db) + +proc close*(db: DbConn) {.tags: [DbEffect].} = + ## Closes the database connection. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## let db = open("mytest.db", "", "", "") + ## db.close() + if sqlite3.close(db) != SQLITE_OK: dbError(db) + +proc open*(connection, user, password, database: string): DbConn {. + tags: [DbEffect].} = + ## Opens a database connection. Raises a `DbError` exception if the connection + ## could not be established. + ## + ## **Note:** Only the ``connection`` parameter is used for ``sqlite``. + ## + ## **Examples:** + ## + ## .. code-block:: Nim + ## + ## try: + ## let db = open("mytest.db", "", "", "") + ## ## do something... + ## ## db.getAllRows(sql"SELECT * FROM my_table") + ## db.close() + ## except: + ## stderr.writeLine(getCurrentExceptionMsg()) + var db: DbConn + if sqlite3.open(connection, db) == SQLITE_OK: + result = db + else: + dbError(db) + +proc setEncoding*(connection: DbConn, encoding: string): bool {. + tags: [DbEffect].} = + ## Sets the encoding of a database connection, returns `true` for + ## success, `false` for failure. + ## + ## **Note:** The encoding cannot be changed once it's been set. + ## According to SQLite3 documentation, any attempt to change + ## the encoding after the database is created will be silently + ## ignored. + exec(connection, sql"PRAGMA encoding = ?", [encoding]) + result = connection.getValue(sql"PRAGMA encoding") == encoding + +when not defined(testing) and isMainModule: + var db = open("db.sql", "", "", "") + exec(db, sql"create table tbl1(one varchar(10), two smallint)", []) + exec(db, sql"insert into tbl1 values('hello!',10)", []) + exec(db, sql"insert into tbl1 values('goodbye', 20)", []) + #db.query("create table tbl1(one varchar(10), two smallint)") + #db.query("insert into tbl1 values('hello!',10)") + #db.query("insert into tbl1 values('goodbye', 20)") + for r in db.rows(sql"select * from tbl1", []): + echo(r[0], r[1]) + for r in db.instantRows(sql"select * from tbl1", []): + echo(r[0], r[1]) + + x_db_sqlite.close(db) # h3rald