1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 | 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 77 77 22 55 73 73 1 9683 178 9505 6467 3038 1 16736 16402 334 782 782 336 336 1 2722 2722 2722 2722 2722 2722 2722 2722 2722 2722 2722 2722 2722 1 24048 1 25164 25164 25164 1 2722 2722 2722 2722 2722 2722 2722 2722 1 24936 24936 24936 1 10458 10458 10458 2950 7508 2722 1511 1511 1511 1511 2722 2719 2719 1524 1511 1511 13 1195 2722 4272 2722 1116 1116 1116 1116 2722 557 557 557 2722 582 581 581 582 582 1 1383 1383 582 801 582 582 2722 1734 1734 1734 1734 2722 5433 4765 4765 5433 5433 5433 371 5433 10 5433 289 227 289 5433 178 5433 138 5433 5433 5433 5433 5433 5433 1 891 891 891 759 132 568 568 568 568 279 289 568 568 568 1 293 222 820 820 71 5433 2604 2604 293 2604 2722 110 110 20 20 18 18 90 90 87 87 3 3 110 110 1 735 2722 32 24 24 32 32 32 2722 3 3 2722 132 4 4 4 4 132 132 132 132 123 132 16 16 16 1 15 131 131 131 2722 3417 3417 3417 3416 3416 2 3414 3414 3414 3419 3419 3419 27 27 3392 5 3387 604 3419 3414 3414 3414 3405 3405 3405 123 3405 3405 123 3405 3405 3405 292 3405 68 67 67 67 1 3404 3286 3286 2722 453 453 453 453 453 1 452 419 452 452 3 449 449 2722 1720 1720 1720 1720 1720 5 1715 9972 1715 2722 1053 70 70 1053 1053 1053 1053 1053 1 1053 6 1053 894 1053 33 1053 17 1053 42 1053 21 1053 9 1053 46 1053 24 1053 1053 964 1053 856 856 856 1053 1050 9 1050 2722 1354 1354 1354 1354 1354 1354 1354 1354 1157 197 1354 1354 1195 1354 111 1354 16 1354 178 1354 14 1354 21 1354 52 52 10 1354 23 23 23 1354 1354 1354 37 37 37 35 2 2 1354 1354 1354 1354 1757 64 1693 1693 1693 21 8 1672 1693 7403 1693 1693 1693 1693 1354 1354 1354 1354 1589 18 1571 1571 1564 1564 1564 1564 1564 2300 2300 2300 2287 47 2287 2277 2287 2300 7 7 7 7 1564 1548 1564 1564 403 403 403 403 403 403 403 1161 1354 1354 342 342 342 2722 1 1 2722 2722 1075 1075 1075 1075 2722 7 2722 1495 1495 1495 1495 1495 1 5446 1 | "use strict"; var CHANGES_BATCH_SIZE = 25; // according to http://stackoverflow.com/a/417184/680742, // the de facto URL length limit is 2000 characters. // but since most of our measurements don't take the full // URL into account, we fudge it a bit. // TODO: we could measure the full URL to enforce exactly 2000 chars var MAX_URL_LENGTH = 1800; var binStringToBluffer = require('../../deps/binary/binaryStringToBlobOrBuffer'); var b64StringToBluffer = require('../../deps/binary/base64StringToBlobOrBuffer'); var utils = require('../../utils'); var Promise = utils.Promise; var clone = utils.clone; var base64 = require('../../deps/binary/base64'); var btoa = base64.btoa; var atob = base64.atob; var errors = require('../../deps/errors'); var log = require('debug')('pouchdb:http'); var createMultipart = require('../../deps/ajax/multipart'); var blufferToBase64 = require('../../deps/binary/blobOrBufferToBase64'); function readAttachmentsAsBlobOrBuffer(row) { var atts = row.doc && row.doc._attachments; if (!atts) { return; } Object.keys(atts).forEach(function (filename) { var att = atts[filename]; att.data = b64StringToBluffer(att.data, att.content_type); }); } function encodeDocId(id) { if (/^_design/.test(id)) { return '_design/' + encodeURIComponent(id.slice(8)); } if (/^_local/.test(id)) { return '_local/' + encodeURIComponent(id.slice(7)); } return encodeURIComponent(id); } function preprocessAttachments(doc) { if (!doc._attachments || !Object.keys(doc._attachments)) { return Promise.resolve(); } return Promise.all(Object.keys(doc._attachments).map(function (key) { var attachment = doc._attachments[key]; if (attachment.data && typeof attachment.data !== 'string') { return blufferToBase64(attachment.data).then(function (b64) { attachment.data = b64; }); } })); } // Get all the information you possibly can about the URI given by name and // return it as a suitable object. function getHost(name, opts) { // If the given name contains "http:" Eif (/http(s?):/.test(name)) { // Prase the URI into all its little bits var uri = utils.parseUri(name); // Store the fact that it is a remote URI uri.remote = true; // Store the user and password as a separate auth object Iif (uri.user || uri.password) { uri.auth = {username: uri.user, password: uri.password}; } // Split the path part of the URI into parts using '/' as the delimiter // after removing any leading '/' and any trailing '/' var parts = uri.path.replace(/(^\/|\/$)/g, '').split('/'); // Store the first part as the database name and remove it from the parts // array uri.db = parts.pop(); // Restore the path by joining all the remaining parts (all the parts // except for the database name) with '/'s uri.path = parts.join('/'); opts = opts || {}; opts = clone(opts); uri.headers = opts.headers || (opts.ajax && opts.ajax.headers) || {}; Iif (opts.auth || uri.auth) { var nAuth = opts.auth || uri.auth; var token = btoa(nAuth.username + ':' + nAuth.password); uri.headers.Authorization = 'Basic ' + token; } Iif (opts.headers) { uri.headers = opts.headers; } return uri; } // If the given name does not contain 'http:' then return a very basic object // with no host, the current path, the given name as the database name and no // username/password return {host: '', path: '/', db: name, auth: false}; } // Generate a URL with the host data given by opts and the given path function genDBUrl(opts, path) { return genUrl(opts, opts.db + '/' + path); } // Generate a URL with the host data given by opts and the given path function genUrl(opts, path) { Eif (opts.remote) { // If the host already has a path, then we need to have a path delimiter // Otherwise, the path delimiter is the empty string var pathDel = !opts.path ? '' : '/'; // If the host already has a path, then we need to have a path delimiter // Otherwise, the path delimiter is the empty string return opts.protocol + '://' + opts.host + ':' + opts.port + '/' + opts.path + pathDel + path; } return '/' + path; } // Implements the PouchDB API for dealing with CouchDB instances over HTTP function HttpPouch(opts, callback) { // The functions that will be publicly available for HttpPouch var api = this; api.getHost = opts.getHost ? opts.getHost : getHost; // Parse the URI given by opts.name into an easy-to-use object var host = api.getHost(opts.name, opts); // Generate the database URL based on the host var dbUrl = genDBUrl(host, ''); api.getUrl = function () {return dbUrl; }; api.getHeaders = function () {return clone(host.headers); }; var ajaxOpts = opts.ajax || {}; opts = clone(opts); function ajax(options, callback) { var reqOpts = utils.extend(true, clone(ajaxOpts), options); log(reqOpts.method + ' ' + reqOpts.url); return utils.ajax(reqOpts, callback); } function ajaxPromise(opts) { return new Promise(function (resolve, reject) { ajax(opts, function (err, res) { if (err) { return reject(err); } resolve(res); }); }); } // Create a new CouchDB database based on the given opts var createDB = function () { ajax({ headers: clone(host.headers), method: 'PUT', url: dbUrl }, function (err) { // If we get an "Unauthorized" error Iif (err && err.status === 401) { // Test if the database already exists ajax({headers: clone(host.headers), method: 'HEAD', url: dbUrl}, function (err) { // If there is still an error if (err) { // Give the error to the callback to deal with callback(err); } else { // Continue as if there had been no errors callback(null, api); } }); // If there were no errros or if the only error is "Precondition Failed" // (note: "Precondition Failed" occurs when we try to create a database // that already exists) } else Eif (!err || err.status === 412) { // Continue as if there had been no errors callback(null, api); } else { callback(err); } }); }; if (!opts.skipSetup) { ajax({ headers: clone(host.headers), method: 'GET', url: dbUrl }, function (err) { //check if the db exists if (err) { if (err.status === 404) { utils.explain404( 'PouchDB is just detecting if the remote DB exists.'); //if it doesn't, create it createDB(); } else { callback(err); } } else { //go do stuff with the db callback(null, api); } }); } api.type = function () { return 'http'; }; api.id = utils.adapterFun('id', function (callback) { ajax({ headers: clone(host.headers), method: 'GET', url: genUrl(host, '') }, function (err, result) { Iif (err) { return callback(err); } var uuid = (result && result.uuid) ? result.uuid + host.db : genDBUrl(host, ''); callback(null, uuid); }); }); api.request = utils.adapterFun('request', function (options, callback) { options.headers = host.headers; options.url = genDBUrl(host, options.url); ajax(options, callback); }); // Sends a POST request to the host calling the couchdb _compact function // version: The version of CouchDB it is running api.compact = utils.adapterFun('compact', function (opts, callback) { if (typeof opts === 'function') { callback = opts; opts = {}; } opts = clone(opts); ajax({ headers: clone(host.headers), url: genDBUrl(host, '_compact'), method: 'POST' }, function () { function ping() { api.info(function (err, res) { if (!res.compact_running) { callback(null, {ok: true}); } else { setTimeout(ping, opts.interval || 200); } }); } // Ping the http if it's finished compaction Eif (typeof callback === "function") { ping(); } }); }); // Calls GET on the host, which gets back a JSON string containing // couchdb: A welcome string // version: The version of CouchDB it is running api._info = function (callback) { ajax({ headers: clone(host.headers), method: 'GET', url: genDBUrl(host, '') }, function (err, res) { Iif (err) { callback(err); } else { res.host = genDBUrl(host, ''); callback(null, res); } }); }; // Get the document with the given id from the database given by host. // The id could be solely the _id in the database, or it may be a // _design/ID or _local/ID path api.get = utils.adapterFun('get', function (id, opts, callback) { // If no options were given, set the callback to the second parameter if (typeof opts === 'function') { callback = opts; opts = {}; } opts = clone(opts); // List of parameters to add to the GET request var params = []; // If it exists, add the opts.revs value to the list of parameters. // If revs=true then the resulting JSON will include a field // _revisions containing an array of the revision IDs. if (opts.revs) { params.push('revs=true'); } // If it exists, add the opts.revs_info value to the list of parameters. // If revs_info=true then the resulting JSON will include the field // _revs_info containing an array of objects in which each object // representing an available revision. if (opts.revs_info) { params.push('revs_info=true'); } // If it exists, add the opts.open_revs value to the list of parameters. // If open_revs=all then the resulting JSON will include all the leaf // revisions. If open_revs=["rev1", "rev2",...] then the resulting JSON // will contain an array of objects containing data of all revisions if (opts.open_revs) { if (opts.open_revs !== "all") { opts.open_revs = JSON.stringify(opts.open_revs); } params.push('open_revs=' + opts.open_revs); } // If it exists, add the opts.rev value to the list of parameters. // If rev is given a revision number then get the specified revision. if (opts.rev) { params.push('rev=' + opts.rev); } // If it exists, add the opts.conflicts value to the list of parameters. // If conflicts=true then the resulting JSON will include the field // _conflicts containing all the conflicting revisions. if (opts.conflicts) { params.push('conflicts=' + opts.conflicts); } // Format the list of parameters into a valid URI query string params = params.join('&'); params = params === '' ? '' : '?' + params; id = encodeDocId(id); // Set the options for the ajax call var options = { headers: clone(host.headers), method: 'GET', url: genDBUrl(host, id + params) }; var getRequestAjaxOpts = opts.ajax || {}; utils.extend(true, options, getRequestAjaxOpts); function fetchAttachments(doc) { var atts = doc._attachments; var filenames = atts && Object.keys(atts); if (!atts || !filenames.length) { return; } // we fetch these manually in separate XHRs, because // Sync Gateway would normally send it back as multipart/mixed, // which we cannot parse. Also, this is more efficient than // receiving attachments as base64-encoded strings. return Promise.all(filenames.map(function (filename) { var att = atts[filename]; var path = encodeDocId(doc._id) + '/' + encodeAttachmentId(filename) + '?rev=' + doc._rev; return ajaxPromise({ headers: clone(host.headers), method: 'GET', url: genDBUrl(host, path), binary: true }).then(function (blob) { if (opts.binary) { return blob; } return blufferToBase64(blob); }).then(function (data) { delete att.stub; delete att.length; att.data = data; }); })); } function fetchAllAttachments(docOrDocs) { if (Array.isArray(docOrDocs)) { return Promise.all(docOrDocs.map(function (doc) { Eif (doc.ok) { return fetchAttachments(doc.ok); } })); } return fetchAttachments(docOrDocs); } ajaxPromise(options).then(function (res) { return Promise.resolve().then(function () { if (opts.attachments) { return fetchAllAttachments(res); } }).then(function () { callback(null, res); }); }).catch(callback); }); // Delete the document given by doc from the database given by host. api.remove = utils.adapterFun('remove', function (docOrId, optsOrRev, opts, callback) { var doc; if (typeof optsOrRev === 'string') { // id, rev, opts, callback style doc = { _id: docOrId, _rev: optsOrRev }; if (typeof opts === 'function') { callback = opts; opts = {}; } } else { // doc, opts, callback style doc = docOrId; if (typeof optsOrRev === 'function') { callback = optsOrRev; opts = {}; } else { callback = opts; opts = optsOrRev; } } var rev = (doc._rev || opts.rev); // Delete the document ajax({ headers: clone(host.headers), method: 'DELETE', url: genDBUrl(host, encodeDocId(doc._id)) + '?rev=' + rev }, callback); }); function encodeAttachmentId(attachmentId) { return attachmentId.split("/").map(encodeURIComponent).join("/"); } // Get the attachment api.getAttachment = utils.adapterFun('getAttachment', function (docId, attachmentId, opts, callback) { if (typeof opts === 'function') { callback = opts; opts = {}; } var params = opts.rev ? ('?rev=' + opts.rev) : ''; var url = genDBUrl(host, encodeDocId(docId)) + '/' + encodeAttachmentId(attachmentId) + params; ajax({ headers: clone(host.headers), method: 'GET', url: url, binary: true }, callback); }); // Remove the attachment given by the id and rev api.removeAttachment = utils.adapterFun('removeAttachment', function (docId, attachmentId, rev, callback) { var url = genDBUrl(host, encodeDocId(docId) + '/' + encodeAttachmentId(attachmentId)) + '?rev=' + rev; ajax({ headers: clone(host.headers), method: 'DELETE', url: url }, callback); }); // Add the attachment given by blob and its contentType property // to the document with the given id, the revision given by rev, and // add it to the database given by host. api.putAttachment = utils.adapterFun('putAttachment', function (docId, attachmentId, rev, blob, type, callback) { if (typeof type === 'function') { callback = type; type = blob; blob = rev; rev = null; } Iif (typeof type === 'undefined') { type = blob; blob = rev; rev = null; } var id = encodeDocId(docId) + '/' + encodeAttachmentId(attachmentId); var url = genDBUrl(host, id); if (rev) { url += '?rev=' + rev; } if (typeof blob === 'string') { var binary; try { binary = atob(blob); } catch (err) { // it's not base64-encoded, so throw error return callback(errors.error(errors.BAD_ARG, 'Attachments need to be base64 encoded')); } blob = binary ? binStringToBluffer(binary, type) : ''; } var opts = { headers: clone(host.headers), method: 'PUT', url: url, processData: false, body: blob, timeout: ajaxOpts.timeout || 60000 }; opts.headers['Content-Type'] = type; // Add the attachment ajax(opts, callback); }); // Add the document given by doc (in JSON string format) to the database // given by host. This fails if the doc has no _id field. api.put = utils.adapterFun('put', utils.getArguments(function (args) { var temp, temptype, opts; var doc = args.shift(); var id = '_id' in doc; var callback = args.pop(); if (typeof doc !== 'object' || Array.isArray(doc)) { return callback(errors.error(errors.NOT_AN_OBJECT)); } doc = clone(doc); preprocessAttachments(doc).then(function () { while (true) { temp = args.shift(); temptype = typeof temp; if (temptype === "string" && !id) { doc._id = temp; id = true; } else if (temptype === "string" && id && !('_rev' in doc)) { doc._rev = temp; } else if (temptype === "object") { opts = clone(temp); } if (!args.length) { break; } } opts = opts || {}; var error = utils.invalidIdError(doc._id); Iif (error) { throw error; } // List of parameter to add to the PUT request var params = []; // If it exists, add the opts.new_edits value to the list of parameters. // If new_edits = false then the database will NOT assign this document a // new revision number if (opts && typeof opts.new_edits !== 'undefined') { params.push('new_edits=' + opts.new_edits); } // Format the list of parameters into a valid URI query string params = params.join('&'); if (params !== '') { params = '?' + params; } var ajaxOpts = { headers: clone(host.headers), method: 'PUT', url: genDBUrl(host, encodeDocId(doc._id)) + params, body: doc }; return Promise.resolve().then(function () { var hasNonStubAttachments = doc._attachments && Object.keys(doc._attachments).filter(function (att) { return !doc._attachments[att].stub; }).length; if (hasNonStubAttachments) { // use multipart/related for more efficient attachment uploading var multipart = createMultipart(doc); ajaxOpts.body = multipart.body; ajaxOpts.processData = false; ajaxOpts.headers = utils.extend(ajaxOpts.headers, multipart.headers); } }).catch(function () { throw new Error('Did you forget to base64-encode an attachment?'); }).then(function () { return ajaxPromise(ajaxOpts); }).then(function (res) { res.ok = true; // smooths out cloudant not doing this callback(null, res); }); }).catch(callback); })); // Add the document given by doc (in JSON string format) to the database // given by host. This does not assume that doc is a new document // (i.e. does not have a _id or a _rev field.) api.post = utils.adapterFun('post', function (doc, opts, callback) { // If no options were given, set the callback to be the second parameter Eif (typeof opts === 'function') { callback = opts; opts = {}; } opts = clone(opts); if (typeof doc !== 'object') { return callback(errors.error(errors.NOT_AN_OBJECT)); } if (! ("_id" in doc)) { doc._id = utils.uuid(); } api.put(doc, opts, function (err, res) { if (err) { return callback(err); } res.ok = true; callback(null, res); }); }); // Update/create multiple documents given by req in the database // given by host. api._bulkDocs = function (req, opts, callback) { // If opts.new_edits exists add it to the document data to be // send to the database. // If new_edits=false then it prevents the database from creating // new revision numbers for the documents. Instead it just uses // the old ones. This is used in database replication. Eif (typeof opts.new_edits !== 'undefined') { req.new_edits = opts.new_edits; } Promise.all(req.docs.map(preprocessAttachments)).then(function () { // Update/create the documents ajax({ headers: clone(host.headers), method: 'POST', url: genDBUrl(host, '_bulk_docs'), body: req }, function (err, results) { if (err) { return callback(err); } results.forEach(function (result) { result.ok = true; // smooths out cloudant not adding this }); callback(null, results); }); }).catch(callback); }; // Get a listing of the documents in the database given // by host and ordered by increasing id. api.allDocs = utils.adapterFun('allDocs', function (opts, callback) { if (typeof opts === 'function') { callback = opts; opts = {}; } opts = clone(opts); // List of parameters to add to the GET request var params = []; var body; var method = 'GET'; if (opts.conflicts) { params.push('conflicts=true'); } // If opts.descending is truthy add it to params if (opts.descending) { params.push('descending=true'); } // If opts.include_docs exists, add the include_docs value to the // list of parameters. // If include_docs=true then include the associated document with each // result. if (opts.include_docs) { params.push('include_docs=true'); } if (opts.attachments) { // added in CouchDB 1.6.0 params.push('attachments=true'); } if (opts.key) { params.push('key=' + encodeURIComponent(JSON.stringify(opts.key))); } // If opts.startkey exists, add the startkey value to the list of // parameters. // If startkey is given then the returned list of documents will // start with the document whose id is startkey. if (opts.startkey) { params.push('startkey=' + encodeURIComponent(JSON.stringify(opts.startkey))); } // If opts.endkey exists, add the endkey value to the list of parameters. // If endkey is given then the returned list of docuemnts will // end with the document whose id is endkey. if (opts.endkey) { params.push('endkey=' + encodeURIComponent(JSON.stringify(opts.endkey))); } if (typeof opts.inclusive_end !== 'undefined') { params.push('inclusive_end=' + !!opts.inclusive_end); } // If opts.limit exists, add the limit value to the parameter list. if (typeof opts.limit !== 'undefined') { params.push('limit=' + opts.limit); } if (typeof opts.skip !== 'undefined') { params.push('skip=' + opts.skip); } // Format the list of parameters into a valid URI query string params = params.join('&'); if (params !== '') { params = '?' + params; } if (typeof opts.keys !== 'undefined') { var keysAsString = 'keys=' + encodeURIComponent(JSON.stringify(opts.keys)); Eif (keysAsString.length + params.length + 1 <= MAX_URL_LENGTH) { // If the keys are short enough, do a GET. we do this to work around // Safari not understanding 304s on POSTs (see issue #1239) params += (params.indexOf('?') !== -1 ? '&' : '?') + keysAsString; } else { // If keys are too long, issue a POST request to circumvent GET // query string limits // see http://wiki.apache.org/couchdb/HTTP_view_API#Querying_Options method = 'POST'; body = JSON.stringify({keys: opts.keys}); } } // Get the document listing ajaxPromise({ headers: clone(host.headers), method: method, url: genDBUrl(host, '_all_docs' + params), body: body }).then(function (res) { if (opts.include_docs && opts.attachments && opts.binary) { res.rows.forEach(readAttachmentsAsBlobOrBuffer); } callback(null, res); }).catch(callback); }); // Get a list of changes made to documents in the database given by host. // TODO According to the README, there should be two other methods here, // api.changes.addListener and api.changes.removeListener. api._changes = function (opts) { // We internally page the results of a changes request, this means // if there is a large set of changes to be returned we can start // processing them quicker instead of waiting on the entire // set of changes to return and attempting to process them at once var batchSize = 'batch_size' in opts ? opts.batch_size : CHANGES_BATCH_SIZE; opts = clone(opts); opts.timeout = opts.timeout || ajaxOpts.timeout || 30 * 1000; // We give a 5 second buffer for CouchDB changes to respond with // an ok timeout var params = { timeout: opts.timeout - (5 * 1000) }; var limit = (typeof opts.limit !== 'undefined') ? opts.limit : false; Iif (limit === 0) { limit = 1; } var returnDocs; if ('returnDocs' in opts) { returnDocs = opts.returnDocs; } else { returnDocs = true; } // var leftToFetch = limit; if (opts.style) { params.style = opts.style; } if (opts.include_docs || opts.filter && typeof opts.filter === 'function') { params.include_docs = true; } if (opts.attachments) { params.attachments = true; } if (opts.continuous) { params.feed = 'longpoll'; } if (opts.conflicts) { params.conflicts = true; } if (opts.descending) { params.descending = true; } if (opts.filter && typeof opts.filter === 'string') { params.filter = opts.filter; if (opts.filter === '_view' && opts.view && typeof opts.view === 'string') { params.view = opts.view; } } // If opts.query_params exists, pass it through to the changes request. // These parameters may be used by the filter on the source database. if (opts.query_params && typeof opts.query_params === 'object') { for (var param_name in opts.query_params) { Eif (opts.query_params.hasOwnProperty(param_name)) { params[param_name] = opts.query_params[param_name]; } } } var method = 'GET'; var body; if (opts.doc_ids) { // set this automagically for the user; it's annoying that couchdb // requires both a "filter" and a "doc_ids" param. params.filter = '_doc_ids'; var docIdsJson = JSON.stringify(opts.doc_ids); if (docIdsJson.length < MAX_URL_LENGTH) { params.doc_ids = docIdsJson; } else { // anything greater than ~2000 is unsafe for gets, so // use POST instead method = 'POST'; body = {doc_ids: opts.doc_ids }; } } Iif (opts.continuous && api._useSSE) { return api.sse(opts, params, returnDocs); } var xhr; var lastFetchedSeq; // Get all the changes starting wtih the one immediately after the // sequence number given by since. var fetch = function (since, callback) { if (opts.aborted) { return; } params.since = since; Iif (typeof params.since === "object") { params.since = JSON.stringify(params.since); } if (opts.descending) { if (limit) { params.limit = leftToFetch; } } else { params.limit = (!limit || leftToFetch > batchSize) ? batchSize : leftToFetch; } var paramStr = '?' + Object.keys(params).map(function (k) { return k + '=' + encodeURIComponent(params[k]); }).join('&'); // Set the options for the ajax call var xhrOpts = { headers: clone(host.headers), method: method, url: genDBUrl(host, '_changes' + paramStr), // _changes can take a long time to generate, especially when filtered timeout: opts.timeout, body: body }; lastFetchedSeq = since; Iif (opts.aborted) { return; } // Get the changes xhr = ajax(xhrOpts, callback); }; // If opts.since exists, get all the changes from the sequence // number given by opts.since. Otherwise, get all the changes // from the sequence number 0. var fetchTimeout = 10; var fetchRetryCount = 0; var results = {results: []}; var fetched = function (err, res) { if (opts.aborted) { return; } var raw_results_length = 0; // If the result of the ajax call (res) contains changes (res.results) if (res && res.results) { raw_results_length = res.results.length; results.last_seq = res.last_seq; // For each change var req = {}; req.query = opts.query_params; res.results = res.results.filter(function (c) { leftToFetch--; var ret = utils.filterChange(opts)(c); if (ret) { if (opts.include_docs && opts.attachments && opts.binary) { readAttachmentsAsBlobOrBuffer(c); } if (returnDocs) { results.results.push(c); } opts.onChange(c); } return ret; }); } else Eif (err) { // In case of an error, stop listening for changes and call // opts.complete opts.aborted = true; utils.call(opts.complete, err); return; } // The changes feed may have timed out with no results // if so reuse last update sequence if (res && res.last_seq) { lastFetchedSeq = res.last_seq; } var finished = (limit && leftToFetch <= 0) || (res && raw_results_length < batchSize) || (opts.descending); if ((opts.continuous && !(limit && leftToFetch <= 0)) || !finished) { // Increase retry delay exponentially as long as errors persist Iif (err) { fetchRetryCount += 1; } else { fetchRetryCount = 0; } var timeoutMultiplier = 1 << fetchRetryCount; var retryWait = fetchTimeout * timeoutMultiplier; var maximumWait = opts.maximumWait || 30000; Iif (retryWait > maximumWait) { utils.call(opts.complete, err || errors.error(errors.UNKNOWN_ERROR)); return; } // Queue a call to fetch again with the newest sequence number setTimeout(function () { fetch(lastFetchedSeq, fetched); }, retryWait); } else { // We're done, call the callback utils.call(opts.complete, null, results); } }; fetch(opts.since || 0, fetched); // Return a method to cancel this method from processing any more return { cancel: function () { opts.aborted = true; Eif (xhr) { xhr.abort(); } } }; }; api.sse = function (opts, params, returnDocs) { params.feed = 'eventsource'; params.since = opts.since || 0; params.limit = opts.limit; delete params.timeout; var paramStr = '?' + Object.keys(params).map(function (k) { return k + '=' + params[k]; }).join('&'); var url = genDBUrl(host, '_changes' + paramStr); var source = new EventSource(url); var results = { results: [], last_seq: false }; var dispatched = false; var open = false; source.addEventListener('message', msgHandler, false); source.onopen = function () { open = true; }; source.onerror = errHandler; return { cancel: function () { if (dispatched) { return dispatched.cancel(); } source.removeEventListener('message', msgHandler, false); source.close(); } }; function msgHandler(e) { var data = JSON.parse(e.data); if (returnDocs) { results.results.push(data); } results.last_seq = data.seq; utils.call(opts.onChange, data); } function errHandler(err) { source.removeEventListener('message', msgHandler, false); if (open === false) { // errored before it opened // likely doesn't support EventSource api._useSSE = false; dispatched = api._changes(opts); return; } source.close(); utils.call(opts.complete, err); } }; api._useSSE = false; // Currently disabled due to failing chrome tests in saucelabs // api._useSSE = typeof global.EventSource === 'function'; // Given a set of document/revision IDs (given by req), tets the subset of // those that do NOT correspond to revisions stored in the database. // See http://wiki.apache.org/couchdb/HttpPostRevsDiff api.revsDiff = utils.adapterFun('revsDiff', function (req, opts, callback) { // If no options were given, set the callback to be the second parameter Eif (typeof opts === 'function') { callback = opts; opts = {}; } // Get the missing document/revision IDs ajax({ headers: clone(host.headers), method: 'POST', url: genDBUrl(host, '_revs_diff'), body: JSON.stringify(req) }, callback); }); api._close = function (callback) { callback(); }; api._destroy = function (callback) { ajax({ url: genDBUrl(host, ''), method: 'DELETE', headers: clone(host.headers) }, function (err, resp) { Iif (err) { api.emit('error', err); callback(err); } else { api.emit('destroyed'); api.constructor.emit('destroyed', opts.name); callback(null, resp); } }); }; } // HttpPouch is a valid adapter. HttpPouch.valid = function () { return true; }; module.exports = HttpPouch; |