Method handleAllDocs

rest/bulk_api.go:51–276

HTTP handler for _all_docs

()

// HTTP handler for _all_docs
func (h *handler) handleAllDocs() error {

	var numDocsPreFilter, numDocsPostFilter uint64
	if h.privs != adminPrivs {
		defer func() {
			// public _all_docs stats
			h.db.DbStats.DatabaseStats.NumPublicAllDocsRequests.Add(1)
			if numDocsPreFilter > 0 {
				h.db.DbStats.DatabaseStats.NumDocsPreFilterPublicAllDocs.Add(int64(numDocsPreFilter))
			}
			if numDocsPostFilter > 0 {
				h.db.DbStats.DatabaseStats.NumDocsPostFilterPublicAllDocs.Add(int64(numDocsPostFilter))
			}
		}()
	}

	if h.privs != adminPrivs && h.db.DatabaseContext.Options.DisablePublicAllDocs {
		return base.HTTPErrorf(http.StatusForbidden, "public access to _all_docs is disabled for this database")
	}

	// http://wiki.apache.org/couchdb/HTTP_Bulk_Document_API
	includeDocs := h.getBoolQuery("include_docs")
	includeChannels := h.getBoolQuery("channels")
	includeAccess := h.getBoolQuery("access") && h.user == nil
	includeRevs := h.getBoolQuery("revs")
	includeSeqs := h.getBoolQuery("update_seq")

	// Get the doc IDs if this is a POST request:
	var explicitDocIDs []string
	if h.rq.Method == "POST" {
		input, err := h.readJSON()
		if err == nil {
			if explicitDocIDs, _ = db.GetStringArrayProperty(input, "keys"); explicitDocIDs == nil {
				err = base.HTTPErrorf(http.StatusBadRequest, "Bad/missing keys")
			}
		}
		if err != nil {
			return err
		}
	} else if h.rq.Method == "GET" {
		var err error
		if explicitDocIDs, err = h.getJSONStringArrayQuery("keys"); err != nil {
			return base.HTTPErrorf(http.StatusBadRequest, "Bad keys")
		}
	}

	// Get the set of channels the user has access to; nil if user is admin or has access to user "*"
	var availableChannels ch.TimedSet
	if h.user != nil {
		var err error
		availableChannels, err = h.user.InheritedCollectionChannels(h.collection.ScopeName, h.collection.Name)
		if err != nil {
			return err
		}
		if availableChannels == nil {
			base.AssertfCtx(h.ctx(), "User %q has no channels in handleAllDocs", base.UD(h.user.Name()))
			return base.HTTPErrorf(http.StatusInternalServerError, "user has no channels")
		}