| % Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| % use this file except in compliance with the License. You may obtain a copy of |
| % the License at |
| % |
| % http://www.apache.org/licenses/LICENSE-2.0 |
| % |
| % Unless required by applicable law or agreed to in writing, software |
| % distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| % WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| % License for the specific language governing permissions and limitations under |
| % the License. |
| |
| -module(couch_db). |
| -behaviour(gen_server). |
| |
| -export([open/2,close/1,create/2,start_compact/1,get_db_info/1,get_design_docs/1]). |
| -export([open_ref_counted/2,is_idle/1,monitor/1,count_changes_since/2]). |
| -export([update_doc/3,update_docs/4,update_docs/2,update_docs/3,delete_doc/3]). |
| -export([get_doc_info/2,open_doc/2,open_doc/3,open_doc_revs/4]). |
| -export([set_revs_limit/2,get_revs_limit/1,register_update_notifier/3]). |
| -export([get_missing_revs/2,name/1,doc_to_tree/1,get_update_seq/1,get_committed_update_seq/1]). |
| -export([enum_docs/4,enum_docs/5,enum_docs_since/4,enum_docs_since/5]). |
| -export([enum_docs_since_reduce_to_count/1,enum_docs_reduce_to_count/1]). |
| -export([increment_update_seq/1,get_purge_seq/1,purge_docs/2,get_last_purged/1]). |
| -export([start_link/3,open_doc_int/3,set_admins/2,get_admins/1,ensure_full_commit/1]). |
| -export([init/1,terminate/2,handle_call/3,handle_cast/2,code_change/3,handle_info/2]). |
| -export([changes_since/5,read_doc/2,new_revid/1]). |
| |
| -include("couch_db.hrl"). |
| |
| |
| start_link(DbName, Filepath, Options) -> |
| case open_db_file(Filepath, Options) of |
| {ok, Fd} -> |
| StartResult = gen_server:start_link(couch_db, {DbName, Filepath, Fd, Options}, []), |
| unlink(Fd), |
| StartResult; |
| Else -> |
| Else |
| end. |
| |
| open_db_file(Filepath, Options) -> |
| case couch_file:open(Filepath, Options) of |
| {ok, Fd} -> |
| {ok, Fd}; |
| {error, enoent} -> |
| % couldn't find file. is there a compact version? This can happen if |
| % crashed during the file switch. |
| case couch_file:open(Filepath ++ ".compact") of |
| {ok, Fd} -> |
| ?LOG_INFO("Found ~s~s compaction file, using as primary storage.", [Filepath, ".compact"]), |
| ok = file:rename(Filepath ++ ".compact", Filepath), |
| ok = couch_file:sync(Fd), |
| {ok, Fd}; |
| {error, enoent} -> |
| {not_found, no_db_file} |
| end; |
| Error -> |
| Error |
| end. |
| |
| |
| create(DbName, Options) -> |
| couch_server:create(DbName, Options). |
| |
| open(DbName, Options) -> |
| couch_server:open(DbName, Options). |
| |
| ensure_full_commit(#db{update_pid=UpdatePid,instance_start_time=StartTime}) -> |
| ok = gen_server:call(UpdatePid, full_commit, infinity), |
| {ok, StartTime}. |
| |
| close(#db{fd_ref_counter=RefCntr}) -> |
| couch_ref_counter:drop(RefCntr). |
| |
| open_ref_counted(MainPid, UserCtx) -> |
| {ok, Db} = gen_server:call(MainPid, {open_ref_count, self()}), |
| {ok, Db#db{user_ctx=UserCtx}}. |
| |
| is_idle(MainPid) -> |
| gen_server:call(MainPid, is_idle). |
| |
| monitor(#db{main_pid=MainPid}) -> |
| erlang:monitor(process, MainPid). |
| |
| register_update_notifier(#db{main_pid=Pid}, Seq, Fun) -> |
| gen_server:call(Pid, {register_update_notifier, Seq, Fun}). |
| |
| start_compact(#db{update_pid=Pid}) -> |
| gen_server:cast(Pid, start_compact). |
| |
| delete_doc(Db, Id, Revisions) -> |
| DeletedDocs = [#doc{id=Id, revs=[Rev], deleted=true} || Rev <- Revisions], |
| {ok, [Result]} = update_docs(Db, DeletedDocs, []), |
| {ok, Result}. |
| |
| open_doc(Db, IdOrDocInfo) -> |
| open_doc(Db, IdOrDocInfo, []). |
| |
| open_doc(Db, Id, Options) -> |
| couch_stats_collector:increment({couchdb, database_reads}), |
| case open_doc_int(Db, Id, Options) of |
| {ok, #doc{deleted=true}=Doc} -> |
| case lists:member(deleted, Options) of |
| true -> |
| {ok, Doc}; |
| false -> |
| {not_found, deleted} |
| end; |
| Else -> |
| Else |
| end. |
| |
| open_doc_revs(Db, Id, Revs, Options) -> |
| couch_stats_collector:increment({couchdb, database_reads}), |
| [Result] = open_doc_revs_int(Db, [{Id, Revs}], Options), |
| Result. |
| |
| get_missing_revs(Db, IdRevsList) -> |
| Ids = [Id1 || {Id1, _Revs} <- IdRevsList], |
| FullDocInfoResults = get_full_doc_infos(Db, Ids), |
| Results = lists:zipwith( |
| fun({Id, Revs}, FullDocInfoResult) -> |
| case FullDocInfoResult of |
| {ok, #full_doc_info{rev_tree=RevisionTree}} -> |
| {Id, couch_key_tree:find_missing(RevisionTree, Revs)}; |
| not_found -> |
| {Id, Revs} |
| end |
| end, |
| IdRevsList, FullDocInfoResults), |
| % strip out the non-missing ids |
| Missing = [{Id, Revs} || {Id, Revs} <- Results, Revs /= []], |
| {ok, Missing}. |
| |
| get_doc_info(Db, Id) -> |
| case get_full_doc_info(Db, Id) of |
| {ok, DocInfo} -> |
| {ok, couch_doc:to_doc_info(DocInfo)}; |
| Else -> |
| Else |
| end. |
| |
| % returns {ok, DocInfo} or not_found |
| get_full_doc_info(Db, Id) -> |
| [Result] = get_full_doc_infos(Db, [Id]), |
| Result. |
| |
| get_full_doc_infos(Db, Ids) -> |
| couch_btree:lookup(Db#db.fulldocinfo_by_id_btree, Ids). |
| |
| increment_update_seq(#db{update_pid=UpdatePid}) -> |
| gen_server:call(UpdatePid, increment_update_seq). |
| |
| purge_docs(#db{update_pid=UpdatePid}, IdsRevs) -> |
| gen_server:call(UpdatePid, {purge_docs, IdsRevs}). |
| |
| get_committed_update_seq(#db{committed_update_seq=Seq}) -> |
| Seq. |
| |
| get_update_seq(#db{update_seq=Seq})-> |
| Seq. |
| |
| get_purge_seq(#db{header=#db_header{purge_seq=PurgeSeq}})-> |
| PurgeSeq. |
| |
| get_last_purged(#db{header=#db_header{purged_docs=nil}}) -> |
| {ok, []}; |
| get_last_purged(#db{fd=Fd, header=#db_header{purged_docs=PurgedPointer}}) -> |
| couch_file:pread_term(Fd, PurgedPointer). |
| |
| get_db_info(Db) -> |
| #db{fd=Fd, |
| header=#db_header{disk_version=DiskVersion}, |
| compactor_pid=Compactor, |
| update_seq=SeqNum, |
| name=Name, |
| fulldocinfo_by_id_btree=FullDocBtree, |
| instance_start_time=StartTime} = Db, |
| {ok, Size} = couch_file:bytes(Fd), |
| {ok, {Count, DelCount}} = couch_btree:full_reduce(FullDocBtree), |
| InfoList = [ |
| {db_name, Name}, |
| {doc_count, Count}, |
| {doc_del_count, DelCount}, |
| {update_seq, SeqNum}, |
| {purge_seq, couch_db:get_purge_seq(Db)}, |
| {compact_running, Compactor/=nil}, |
| {disk_size, Size}, |
| {instance_start_time, StartTime}, |
| {disk_format_version, DiskVersion} |
| ], |
| {ok, InfoList}. |
| |
| get_design_docs(#db{fulldocinfo_by_id_btree=Btree}=Db) -> |
| couch_btree:foldl(Btree, <<"_design/">>, |
| fun(#full_doc_info{id= <<"_design/",_/binary>>}=FullDocInfo, _Reds, AccDocs) -> |
| {ok, Doc} = couch_db:open_doc_int(Db, FullDocInfo, []), |
| {ok, [Doc | AccDocs]}; |
| (_, _Reds, AccDocs) -> |
| {stop, AccDocs} |
| end, |
| []). |
| |
| check_is_admin(#db{admins=Admins, user_ctx=#user_ctx{name=Name,roles=Roles}}) -> |
| DbAdmins = [<<"_admin">> | Admins], |
| case DbAdmins -- [Name | Roles] of |
| DbAdmins -> % same list, not an admin |
| throw({unauthorized, <<"You are not a db or server admin.">>}); |
| _ -> |
| ok |
| end. |
| |
| get_admins(#db{admins=Admins}) -> |
| Admins. |
| |
| set_admins(#db{update_pid=Pid}=Db, Admins) when is_list(Admins) -> |
| check_is_admin(Db), |
| gen_server:call(Pid, {set_admins, Admins}, infinity). |
| |
| |
| get_revs_limit(#db{revs_limit=Limit}) -> |
| Limit. |
| |
| set_revs_limit(#db{update_pid=Pid}=Db, Limit) when Limit > 0 -> |
| check_is_admin(Db), |
| gen_server:call(Pid, {set_revs_limit, Limit}, infinity); |
| set_revs_limit(_Db, _Limit) -> |
| throw(invalid_revs_limit). |
| |
| name(#db{name=Name}) -> |
| Name. |
| |
| update_doc(Db, Doc, Options) -> |
| case update_docs(Db, [Doc], Options) of |
| {ok, [{ok, NewRev}]} -> |
| {ok, NewRev}; |
| {ok, [Error]} -> |
| throw(Error) |
| end. |
| |
| update_docs(Db, Docs) -> |
| update_docs(Db, Docs, []). |
| |
| % group_alike_docs groups the sorted documents into sublist buckets, by id. |
| % ([DocA, DocA, DocB, DocC], []) -> [[DocA, DocA], [DocB], [DocC]] |
| group_alike_docs(Docs) -> |
| Sorted = lists:sort(fun(#doc{id=A},#doc{id=B})-> A < B end, Docs), |
| group_alike_docs(Sorted, []). |
| |
| group_alike_docs([], Buckets) -> |
| lists:reverse(Buckets); |
| group_alike_docs([Doc|Rest], []) -> |
| group_alike_docs(Rest, [[Doc]]); |
| group_alike_docs([Doc|Rest], [Bucket|RestBuckets]) -> |
| [#doc{id=BucketId}|_] = Bucket, |
| case Doc#doc.id == BucketId of |
| true -> |
| % add to existing bucket |
| group_alike_docs(Rest, [[Doc|Bucket]|RestBuckets]); |
| false -> |
| % add to new bucket |
| group_alike_docs(Rest, [[Doc]|[Bucket|RestBuckets]]) |
| end. |
| |
| |
| validate_doc_update(#db{user_ctx=UserCtx, admins=Admins}, |
| #doc{id= <<"_design/",_/binary>>}, _GetDiskDocFun) -> |
| UserNames = [UserCtx#user_ctx.name | UserCtx#user_ctx.roles], |
| % if the user is a server admin or db admin, allow the save |
| case length(UserNames -- [<<"_admin">> | Admins]) == length(UserNames) of |
| true -> |
| % not an admin |
| {unauthorized, <<"You are not a server or database admin.">>}; |
| false -> |
| ok |
| end; |
| validate_doc_update(#db{validate_doc_funs=[]}, _Doc, _GetDiskDocFun) -> |
| ok; |
| validate_doc_update(_Db, #doc{id= <<"_local/",_/binary>>}, _GetDiskDocFun) -> |
| ok; |
| validate_doc_update(Db, Doc, GetDiskDocFun) -> |
| DiskDoc = GetDiskDocFun(), |
| JsonCtx = couch_util:json_user_ctx(Db), |
| try [case Fun(Doc, DiskDoc, JsonCtx) of |
| ok -> ok; |
| Error -> throw(Error) |
| end || Fun <- Db#db.validate_doc_funs], |
| ok |
| catch |
| throw:Error -> |
| Error |
| end. |
| |
| |
| prep_and_validate_update(Db, #doc{id=Id,revs={RevStart, Revs}}=Doc, |
| OldFullDocInfo, LeafRevsDict, AllowConflict) -> |
| case Revs of |
| [PrevRev|_] -> |
| case dict:find({RevStart, PrevRev}, LeafRevsDict) of |
| {ok, {Deleted, DiskSp, DiskRevs}} -> |
| case couch_doc:has_stubs(Doc) of |
| true -> |
| DiskDoc = make_doc(Db, Id, Deleted, DiskSp, DiskRevs), |
| Doc2 = couch_doc:merge_stubs(Doc, DiskDoc), |
| {validate_doc_update(Db, Doc2, fun() -> DiskDoc end), Doc2}; |
| false -> |
| LoadDiskDoc = fun() -> make_doc(Db,Id,Deleted,DiskSp,DiskRevs) end, |
| {validate_doc_update(Db, Doc, LoadDiskDoc), Doc} |
| end; |
| error when AllowConflict -> |
| {validate_doc_update(Db, Doc, fun() -> nil end), Doc}; |
| error -> |
| {conflict, Doc} |
| end; |
| [] -> |
| % new doc, and we have existing revs. |
| % reuse existing deleted doc |
| if OldFullDocInfo#full_doc_info.deleted orelse AllowConflict -> |
| {validate_doc_update(Db, Doc, fun() -> nil end), Doc}; |
| true -> |
| {conflict, Doc} |
| end |
| end. |
| |
| |
| |
| prep_and_validate_updates(_Db, [], [], _AllowConflict, AccPrepped, |
| AccFatalErrors) -> |
| {AccPrepped, AccFatalErrors}; |
| prep_and_validate_updates(Db, [DocBucket|RestBuckets], [not_found|RestLookups], |
| AllowConflict, AccPrepped, AccErrors) -> |
| [#doc{id=Id}|_]=DocBucket, |
| % no existing revs are known, |
| {PreppedBucket, AccErrors3} = lists:foldl( |
| fun(#doc{revs=Revs}=Doc, {AccBucket, AccErrors2}) -> |
| case Revs of |
| {0, []} -> |
| case validate_doc_update(Db, Doc, fun() -> nil end) of |
| ok -> |
| {[Doc | AccBucket], AccErrors2}; |
| Error -> |
| {AccBucket, [{{Id, {0, []}}, Error} | AccErrors2]} |
| end; |
| _ -> |
| % old revs specified but none exist, a conflict |
| {AccBucket, [{{Id, Revs}, conflict} | AccErrors2]} |
| end |
| end, |
| {[], AccErrors}, DocBucket), |
| |
| prep_and_validate_updates(Db, RestBuckets, RestLookups, AllowConflict, |
| [PreppedBucket | AccPrepped], AccErrors3); |
| prep_and_validate_updates(Db, [DocBucket|RestBuckets], |
| [{ok, #full_doc_info{rev_tree=OldRevTree}=OldFullDocInfo}|RestLookups], |
| AllowConflict, AccPrepped, AccErrors) -> |
| Leafs = couch_key_tree:get_all_leafs(OldRevTree), |
| LeafRevsDict = dict:from_list([{{Start, RevId}, {Deleted, Sp, Revs}} || |
| {{Deleted, Sp, _Seq}, {Start, [RevId|_]}=Revs} <- Leafs]), |
| {PreppedBucket, AccErrors3} = lists:foldl( |
| fun(Doc, {Docs2Acc, AccErrors2}) -> |
| case prep_and_validate_update(Db, Doc, OldFullDocInfo, |
| LeafRevsDict, AllowConflict) of |
| {ok, Doc2} -> |
| {[Doc2 | Docs2Acc], AccErrors2}; |
| {Error, #doc{id=Id,revs=Revs}} -> |
| % Record the error |
| {Docs2Acc, [{{Id, Revs}, Error} |AccErrors2]} |
| end |
| end, |
| {[], AccErrors}, DocBucket), |
| prep_and_validate_updates(Db, RestBuckets, RestLookups, AllowConflict, [PreppedBucket | AccPrepped], AccErrors3). |
| |
| |
| update_docs(#db{update_pid=UpdatePid}=Db, Docs, Options) -> |
| update_docs(#db{update_pid=UpdatePid}=Db, Docs, Options, interactive_edit). |
| |
| |
| prep_and_validate_replicated_updates(_Db, [], [], AccPrepped, AccErrors) -> |
| Errors2 = [{{Id, {Pos, Rev}}, Error} || |
| {#doc{id=Id,revs={Pos,[Rev|_]}}, Error} <- AccErrors], |
| {lists:reverse(AccPrepped), lists:reverse(Errors2)}; |
| prep_and_validate_replicated_updates(Db, [Bucket|RestBuckets], [OldInfo|RestOldInfo], AccPrepped, AccErrors) -> |
| case OldInfo of |
| not_found -> |
| {ValidatedBucket, AccErrors3} = lists:foldl( |
| fun(Doc, {AccPrepped2, AccErrors2}) -> |
| case validate_doc_update(Db, Doc, fun() -> nil end) of |
| ok -> |
| {[Doc | AccPrepped2], AccErrors2}; |
| Error -> |
| {AccPrepped2, [{Doc, Error} | AccErrors2]} |
| end |
| end, |
| {[], AccErrors}, Bucket), |
| prep_and_validate_replicated_updates(Db, RestBuckets, RestOldInfo, [ValidatedBucket | AccPrepped], AccErrors3); |
| {ok, #full_doc_info{rev_tree=OldTree}} -> |
| NewRevTree = lists:foldl( |
| fun(NewDoc, AccTree) -> |
| {NewTree, _} = couch_key_tree:merge(AccTree, [couch_db:doc_to_tree(NewDoc)]), |
| NewTree |
| end, |
| OldTree, Bucket), |
| Leafs = couch_key_tree:get_all_leafs_full(NewRevTree), |
| LeafRevsFullDict = dict:from_list( [{{Start, RevId}, FullPath} || {Start, [{RevId, _}|_]}=FullPath <- Leafs]), |
| {ValidatedBucket, AccErrors3} = |
| lists:foldl( |
| fun(#doc{id=Id,revs={Pos, [RevId|_]}}=Doc, {AccValidated, AccErrors2}) -> |
| case dict:find({Pos, RevId}, LeafRevsFullDict) of |
| {ok, {Start, Path}} -> |
| % our unflushed doc is a leaf node. Go back on the path |
| % to find the previous rev that's on disk. |
| LoadPrevRevFun = fun() -> |
| make_first_doc_on_disk(Db,Id,Start-1, tl(Path)) |
| end, |
| case validate_doc_update(Db, Doc, LoadPrevRevFun) of |
| ok -> |
| {[Doc | AccValidated], AccErrors2}; |
| Error -> |
| {AccValidated, [{Doc, Error} | AccErrors2]} |
| end; |
| _ -> |
| % this doc isn't a leaf or already exists in the tree. |
| % ignore but consider it a success. |
| {AccValidated, AccErrors2} |
| end |
| end, |
| {[], AccErrors}, Bucket), |
| prep_and_validate_replicated_updates(Db, RestBuckets, RestOldInfo, |
| [ValidatedBucket | AccPrepped], AccErrors3) |
| end. |
| |
| |
| |
| new_revid(#doc{body=Body,revs={OldStart,OldRevs}, |
| atts=Atts,deleted=Deleted}) -> |
| case [{N, T, M} || #att{name=N,type=T,md5=M} <- Atts, M /= <<>>] of |
| Atts2 when length(Atts) /= length(Atts2) -> |
| % We must have old style non-md5 attachments |
| ?l2b(integer_to_list(couch_util:rand32())); |
| Atts2 -> |
| OldRev = case OldRevs of [] -> 0; [OldRev0|_] -> OldRev0 end, |
| erlang:md5(term_to_binary([Deleted, OldStart, OldRev, Body, Atts2])) |
| end. |
| |
| new_revs([], OutBuckets, IdRevsAcc) -> |
| {lists:reverse(OutBuckets), IdRevsAcc}; |
| new_revs([Bucket|RestBuckets], OutBuckets, IdRevsAcc) -> |
| {NewBucket, IdRevsAcc3} = lists:mapfoldl( |
| fun(#doc{id=Id,revs={Start, RevIds}}=Doc, IdRevsAcc2)-> |
| NewRevId = new_revid(Doc), |
| {Doc#doc{revs={Start+1, [NewRevId | RevIds]}}, |
| [{{Id, {Start, RevIds}}, {ok, {Start+1, NewRevId}}} | IdRevsAcc2]} |
| end, IdRevsAcc, Bucket), |
| new_revs(RestBuckets, [NewBucket|OutBuckets], IdRevsAcc3). |
| |
| check_dup_atts([#att{name=N1}, #att{name=N2} | _]) when N1 == N2 -> |
| throw({bad_request, <<"Duplicate attachments">>}); |
| check_dup_atts([_, _ | Rest]) -> |
| check_dup_atts(Rest); |
| check_dup_atts(_) -> |
| ok. |
| |
| sort_and_check_atts(#doc{atts=Atts}=Doc) -> |
| Atts2 = lists:sort(fun(#att{name=N1}, #att{name=N2}) -> N1 < N2 end, Atts), |
| check_dup_atts(Atts2), |
| Doc#doc{atts=Atts2}. |
| |
| |
| update_docs(Db, Docs, Options, replicated_changes) -> |
| couch_stats_collector:increment({couchdb, database_writes}), |
| DocBuckets = group_alike_docs(Docs), |
| |
| case (Db#db.validate_doc_funs /= []) orelse |
| lists:any( |
| fun(#doc{id= <<?DESIGN_DOC_PREFIX, _/binary>>}) -> true; |
| (_) -> false |
| end, Docs) of |
| true -> |
| Ids = [Id || [#doc{id=Id}|_] <- DocBuckets], |
| ExistingDocs = get_full_doc_infos(Db, Ids), |
| |
| {DocBuckets2, DocErrors} = |
| prep_and_validate_replicated_updates(Db, DocBuckets, ExistingDocs, [], []), |
| DocBuckets3 = [Bucket || [_|_]=Bucket <- DocBuckets2]; % remove empty buckets |
| false -> |
| DocErrors = [], |
| DocBuckets3 = DocBuckets |
| end, |
| DocBuckets4 = [[doc_flush_atts(sort_and_check_atts(Doc), Db#db.fd) |
| || Doc <- Bucket] || Bucket <- DocBuckets3], |
| {ok, []} = write_and_commit(Db, DocBuckets4, [], [merge_conflicts | Options]), |
| {ok, DocErrors}; |
| |
| update_docs(Db, Docs, Options, interactive_edit) -> |
| couch_stats_collector:increment({couchdb, database_writes}), |
| AllOrNothing = lists:member(all_or_nothing, Options), |
| % go ahead and generate the new revision ids for the documents. |
| % separate out the NonRep documents from the rest of the documents |
| {Docs2, NonRepDocs} = lists:foldl( |
| fun(#doc{id=Id}=Doc, {DocsAcc, NonRepDocsAcc}) -> |
| case Id of |
| <<?LOCAL_DOC_PREFIX, _/binary>> -> |
| {DocsAcc, [Doc | NonRepDocsAcc]}; |
| Id-> |
| {[Doc | DocsAcc], NonRepDocsAcc} |
| end |
| end, {[], []}, Docs), |
| |
| DocBuckets = group_alike_docs(Docs2), |
| |
| case (Db#db.validate_doc_funs /= []) orelse |
| lists:any( |
| fun(#doc{id= <<?DESIGN_DOC_PREFIX, _/binary>>}) -> |
| true; |
| (#doc{atts=Atts}) -> |
| Atts /= [] |
| end, Docs2) of |
| true -> |
| % lookup the doc by id and get the most recent |
| Ids = [Id || [#doc{id=Id}|_] <- DocBuckets], |
| ExistingDocInfos = get_full_doc_infos(Db, Ids), |
| |
| {DocBucketsPrepped, PreCommitFailures} = prep_and_validate_updates(Db, |
| DocBuckets, ExistingDocInfos, AllOrNothing, [], []), |
| |
| % strip out any empty buckets |
| DocBuckets2 = [Bucket || [_|_] = Bucket <- DocBucketsPrepped]; |
| false -> |
| PreCommitFailures = [], |
| DocBuckets2 = DocBuckets |
| end, |
| |
| if (AllOrNothing) and (PreCommitFailures /= []) -> |
| {aborted, lists:map( |
| fun({{Id,{Pos, [RevId|_]}}, Error}) -> |
| {{Id, {Pos, RevId}}, Error}; |
| ({{Id,{0, []}}, Error}) -> |
| {{Id, {0, <<>>}}, Error} |
| end, PreCommitFailures)}; |
| true -> |
| Options2 = if AllOrNothing -> [merge_conflicts]; |
| true -> [] end ++ Options, |
| DocBuckets3 = [[ |
| doc_flush_atts(set_new_att_revpos( |
| sort_and_check_atts(Doc)), Db#db.fd) |
| || Doc <- B] || B <- DocBuckets2], |
| {DocBuckets4, IdRevs} = new_revs(DocBuckets3, [], []), |
| |
| {ok, CommitResults} = write_and_commit(Db, DocBuckets4, NonRepDocs, Options2), |
| |
| ResultsDict = dict:from_list(IdRevs ++ CommitResults ++ PreCommitFailures), |
| {ok, lists:map( |
| fun(#doc{id=Id,revs={Pos, RevIds}}) -> |
| {ok, Result} = dict:find({Id, {Pos, RevIds}}, ResultsDict), |
| Result |
| end, Docs)} |
| end. |
| |
| % Returns the first available document on disk. Input list is a full rev path |
| % for the doc. |
| make_first_doc_on_disk(_Db, _Id, _Pos, []) -> |
| nil; |
| make_first_doc_on_disk(Db, Id, Pos, [{_Rev, ?REV_MISSING}|RestPath]) -> |
| make_first_doc_on_disk(Db, Id, Pos - 1, RestPath); |
| make_first_doc_on_disk(Db, Id, Pos, [{_Rev, {IsDel, Sp, _Seq}} |_]=DocPath) -> |
| Revs = [Rev || {Rev, _} <- DocPath], |
| make_doc(Db, Id, IsDel, Sp, {Pos, Revs}). |
| |
| set_commit_option(Options) -> |
| CommitSettings = { |
| [true || O <- Options, O==full_commit orelse O==delay_commit], |
| couch_config:get("couchdb", "delayed_commits", "false") |
| }, |
| case CommitSettings of |
| {[true], _} -> |
| Options; % user requested explicit commit setting, do not change it |
| {_, "true"} -> |
| Options; % delayed commits are enabled, do nothing |
| {_, "false"} -> |
| [full_commit|Options]; |
| {_, Else} -> |
| ?LOG_ERROR("[couchdb] delayed_commits setting must be true/false, not ~p", |
| [Else]), |
| [full_commit|Options] |
| end. |
| |
| write_and_commit(#db{update_pid=UpdatePid, user_ctx=Ctx}=Db, DocBuckets, |
| NonRepDocs, Options0) -> |
| Options = set_commit_option(Options0), |
| case gen_server:call(UpdatePid, |
| {update_docs, DocBuckets, NonRepDocs, Options}, infinity) of |
| {ok, Results} -> {ok, Results}; |
| retry -> |
| % This can happen if the db file we wrote to was swapped out by |
| % compaction. Retry by reopening the db and writing to the current file |
| {ok, Db2} = open_ref_counted(Db#db.main_pid, Ctx), |
| DocBuckets2 = [[doc_flush_atts(Doc, Db2#db.fd) || Doc <- Bucket] || Bucket <- DocBuckets], |
| % We only retry once |
| close(Db2), |
| case gen_server:call(UpdatePid, {update_docs, DocBuckets2, NonRepDocs, Options}, infinity) of |
| {ok, Results} -> {ok, Results}; |
| retry -> throw({update_error, compaction_retry}) |
| end |
| end. |
| |
| set_new_att_revpos(#doc{revs={RevPos,_Revs},atts=Atts}=Doc) -> |
| Doc#doc{atts= lists:map(fun(#att{data={_Fd,_Sp}}=Att) -> |
| % already commited to disk, do not set new rev |
| Att; |
| (Att) -> |
| Att#att{revpos=RevPos+1} |
| end, Atts)}. |
| |
| |
| doc_flush_atts(Doc, Fd) -> |
| Doc#doc{atts=[flush_att(Fd, Att) || Att <- Doc#doc.atts]}. |
| |
| check_md5(_NewSig, <<>>) -> ok; |
| check_md5(Sig1, Sig2) when Sig1 == Sig2 -> ok; |
| check_md5(_, _) -> throw(data_corruption). |
| |
| flush_att(Fd, #att{data={Fd0, _}}=Att) when Fd0 == Fd -> |
| % already written to our file, nothing to write |
| Att; |
| |
| flush_att(Fd, #att{data={OtherFd,StreamPointer}, md5=InMd5}=Att) -> |
| {NewStreamData, Len, Md5} = |
| couch_stream:copy_to_new_stream(OtherFd, StreamPointer, Fd), |
| check_md5(Md5, InMd5), |
| Att#att{data={Fd, NewStreamData}, md5=Md5, len=Len}; |
| |
| flush_att(Fd, #att{data=Data}=Att) when is_binary(Data) -> |
| with_stream(Fd, Att, fun(OutputStream) -> |
| couch_stream:write(OutputStream, Data) |
| end); |
| |
| flush_att(Fd, #att{data=Fun,len=undefined}=Att) when is_function(Fun) -> |
| with_stream(Fd, Att, fun(OutputStream) -> |
| % Fun(MaxChunkSize, WriterFun) must call WriterFun |
| % once for each chunk of the attachment, |
| Fun(4096, |
| % WriterFun({Length, Binary}, State) |
| % WriterFun({0, _Footers}, State) |
| % Called with Length == 0 on the last time. |
| % WriterFun returns NewState. |
| fun({0, _Footers}, _) -> |
| ok; |
| ({_Length, Chunk}, _) -> |
| couch_stream:write(OutputStream, Chunk) |
| end, ok) |
| end); |
| |
| flush_att(Fd, #att{data=Fun,len=Len}=Att) when is_function(Fun) -> |
| with_stream(Fd, Att, fun(OutputStream) -> |
| write_streamed_attachment(OutputStream, Fun, Len) |
| end). |
| |
| with_stream(Fd, #att{md5=InMd5}=Att, Fun) -> |
| {ok, OutputStream} = couch_stream:open(Fd), |
| Fun(OutputStream), |
| {StreamInfo, Len, Md5} = couch_stream:close(OutputStream), |
| check_md5(Md5, InMd5), |
| Att#att{data={Fd,StreamInfo},len=Len,md5=Md5}. |
| |
| |
| write_streamed_attachment(_Stream, _F, 0) -> |
| ok; |
| write_streamed_attachment(Stream, F, LenLeft) -> |
| Bin = F(), |
| TruncatedBin = check_bin_length(LenLeft, Bin), |
| ok = couch_stream:write(Stream, TruncatedBin), |
| write_streamed_attachment(Stream, F, LenLeft - size(TruncatedBin)). |
| |
| %% There was a bug in ibrowse 1.4.1 that would cause it to append a CR to a |
| %% chunked response when the CR and LF terminating the last data chunk were |
| %% split across packets. The bug was fixed in version 1.5.0, but we still |
| %% check for it just in case. |
| check_bin_length(LenLeft, Bin) when size(Bin) > LenLeft -> |
| <<_ValidData:LenLeft/binary, Crap/binary>> = Bin, |
| ?LOG_ERROR("write_streamed_attachment has written too much expected: ~p" ++ |
| " got: ~p tail: ~p", [LenLeft, size(Bin), Crap]), |
| exit(replicated_attachment_too_large); |
| check_bin_length(_, Bin) -> Bin. |
| |
| enum_docs_since_reduce_to_count(Reds) -> |
| couch_btree:final_reduce( |
| fun couch_db_updater:btree_by_seq_reduce/2, Reds). |
| |
| enum_docs_reduce_to_count(Reds) -> |
| {Count, _DelCount} = couch_btree:final_reduce( |
| fun couch_db_updater:btree_by_id_reduce/2, Reds), |
| Count. |
| |
| changes_since(Db, Style, StartSeq, Fun, Acc) -> |
| enum_docs_since(Db, StartSeq, fwd, |
| fun(DocInfo, _Offset, Acc2) -> |
| #doc_info{revs=Revs} = DocInfo, |
| case Style of |
| main_only -> |
| Infos = [DocInfo]; |
| all_docs -> |
| % make each rev it's own doc info |
| Infos = [DocInfo#doc_info{revs=[RevInfo]} || |
| #rev_info{seq=RevSeq}=RevInfo <- Revs, StartSeq < RevSeq] |
| end, |
| Fun(Infos, Acc2) |
| end, Acc). |
| |
| count_changes_since(Db, SinceSeq) -> |
| {ok, Changes} = |
| couch_btree:fold_reduce(Db#db.docinfo_by_seq_btree, |
| SinceSeq + 1, % startkey |
| ok, % endkey |
| fun(_,_) -> true end, % groupkeys |
| fun(_SeqStart, PartialReds, 0) -> |
| {ok, couch_btree:final_reduce(Db#db.docinfo_by_seq_btree, PartialReds)} |
| end, |
| 0), |
| Changes. |
| |
| enum_docs_since(Db, SinceSeq, Direction, InFun, Acc) -> |
| couch_btree:fold(Db#db.docinfo_by_seq_btree, SinceSeq + 1, Direction, InFun, Acc). |
| |
| enum_docs_since(Db, SinceSeq, InFun, Acc) -> |
| enum_docs_since(Db, SinceSeq, fwd, InFun, Acc). |
| |
| enum_docs(Db, StartId, Direction, InFun, InAcc) -> |
| couch_btree:fold(Db#db.fulldocinfo_by_id_btree, StartId, Direction, InFun, InAcc). |
| |
| enum_docs(Db, StartId, InFun, Ctx) -> |
| enum_docs(Db, StartId, fwd, InFun, Ctx). |
| |
| % server functions |
| |
| init({DbName, Filepath, Fd, Options}) -> |
| {ok, UpdaterPid} = gen_server:start_link(couch_db_updater, {self(), DbName, Filepath, Fd, Options}, []), |
| {ok, #db{fd_ref_counter=RefCntr}=Db} = gen_server:call(UpdaterPid, get_db), |
| couch_ref_counter:add(RefCntr), |
| couch_stats_collector:track_process_count({couchdb, open_databases}), |
| {ok, Db}. |
| |
| terminate(Reason, _Db) -> |
| couch_util:terminate_linked(Reason), |
| ok. |
| |
| handle_call({open_ref_count, OpenerPid}, _, #db{fd_ref_counter=RefCntr}=Db) -> |
| ok = couch_ref_counter:add(RefCntr, OpenerPid), |
| {reply, {ok, Db}, Db}; |
| handle_call(is_idle, _From, #db{fd_ref_counter=RefCntr, compactor_pid=Compact, |
| waiting_delayed_commit=Delay}=Db) -> |
| % Idle means no referrers. Unless in the middle of a compaction file switch, |
| % there are always at least 2 referrers, couch_db_updater and us. |
| {reply, (Delay == nil) and (Compact == nil) and (couch_ref_counter:count(RefCntr) == 2), Db}; |
| handle_call({db_updated, NewDb}, _From, #db{fd_ref_counter=OldRefCntr}) -> |
| #db{fd_ref_counter=NewRefCntr}=NewDb, |
| case NewRefCntr == OldRefCntr of |
| true -> ok; |
| false -> |
| couch_ref_counter:add(NewRefCntr), |
| couch_ref_counter:drop(OldRefCntr) |
| end, |
| {reply, ok, NewDb}. |
| |
| |
| handle_cast(Msg, Db) -> |
| ?LOG_ERROR("Bad cast message received for db ~s: ~p", [Db#db.name, Msg]), |
| exit({error, Msg}). |
| |
| code_change(_OldVsn, State, _Extra) -> |
| {ok, State}. |
| |
| handle_info(Msg, Db) -> |
| ?LOG_ERROR("Bad message received for db ~s: ~p", [Db#db.name, Msg]), |
| exit({error, Msg}). |
| |
| |
| %%% Internal function %%% |
| open_doc_revs_int(Db, IdRevs, Options) -> |
| Ids = [Id || {Id, _Revs} <- IdRevs], |
| LookupResults = get_full_doc_infos(Db, Ids), |
| lists:zipwith( |
| fun({Id, Revs}, Lookup) -> |
| case Lookup of |
| {ok, #full_doc_info{rev_tree=RevTree}} -> |
| {FoundRevs, MissingRevs} = |
| case Revs of |
| all -> |
| {couch_key_tree:get_all_leafs(RevTree), []}; |
| _ -> |
| case lists:member(latest, Options) of |
| true -> |
| couch_key_tree:get_key_leafs(RevTree, Revs); |
| false -> |
| couch_key_tree:get(RevTree, Revs) |
| end |
| end, |
| FoundResults = |
| lists:map(fun({Value, {Pos, [Rev|_]}=FoundRevPath}) -> |
| case Value of |
| ?REV_MISSING -> |
| % we have the rev in our list but know nothing about it |
| {{not_found, missing}, {Pos, Rev}}; |
| {IsDeleted, SummaryPtr, _UpdateSeq} -> |
| {ok, make_doc(Db, Id, IsDeleted, SummaryPtr, FoundRevPath)} |
| end |
| end, FoundRevs), |
| Results = FoundResults ++ [{{not_found, missing}, MissingRev} || MissingRev <- MissingRevs], |
| {ok, Results}; |
| not_found when Revs == all -> |
| {ok, []}; |
| not_found -> |
| {ok, [{{not_found, missing}, Rev} || Rev <- Revs]} |
| end |
| end, |
| IdRevs, LookupResults). |
| |
| open_doc_int(Db, <<?LOCAL_DOC_PREFIX, _/binary>> = Id, _Options) -> |
| case couch_btree:lookup(Db#db.local_docs_btree, [Id]) of |
| [{ok, {_, {Rev, BodyData}}}] -> |
| {ok, #doc{id=Id, revs={0, [list_to_binary(integer_to_list(Rev))]}, body=BodyData}}; |
| [not_found] -> |
| {not_found, missing} |
| end; |
| open_doc_int(Db, #doc_info{id=Id,revs=[RevInfo|_]}=DocInfo, Options) -> |
| #rev_info{deleted=IsDeleted,rev={Pos,RevId},body_sp=Bp} = RevInfo, |
| Doc = make_doc(Db, Id, IsDeleted, Bp, {Pos,[RevId]}), |
| {ok, Doc#doc{meta=doc_meta_info(DocInfo, [], Options)}}; |
| open_doc_int(Db, #full_doc_info{id=Id,rev_tree=RevTree}=FullDocInfo, Options) -> |
| #doc_info{revs=[#rev_info{deleted=IsDeleted,rev=Rev,body_sp=Bp}|_]} = |
| DocInfo = couch_doc:to_doc_info(FullDocInfo), |
| {[{_, RevPath}], []} = couch_key_tree:get(RevTree, [Rev]), |
| Doc = make_doc(Db, Id, IsDeleted, Bp, RevPath), |
| {ok, Doc#doc{meta=doc_meta_info(DocInfo, RevTree, Options)}}; |
| open_doc_int(Db, Id, Options) -> |
| case get_full_doc_info(Db, Id) of |
| {ok, FullDocInfo} -> |
| open_doc_int(Db, FullDocInfo, Options); |
| not_found -> |
| {not_found, missing} |
| end. |
| |
| doc_meta_info(#doc_info{high_seq=Seq,revs=[#rev_info{rev=Rev}|RestInfo]}, RevTree, Options) -> |
| case lists:member(revs_info, Options) of |
| false -> []; |
| true -> |
| {[{Pos, RevPath}],[]} = |
| couch_key_tree:get_full_key_paths(RevTree, [Rev]), |
| |
| [{revs_info, Pos, lists:map( |
| fun({Rev1, {true, _Sp, _UpdateSeq}}) -> |
| {Rev1, deleted}; |
| ({Rev1, {false, _Sp, _UpdateSeq}}) -> |
| {Rev1, available}; |
| ({Rev1, ?REV_MISSING}) -> |
| {Rev1, missing} |
| end, RevPath)}] |
| end ++ |
| case lists:member(conflicts, Options) of |
| false -> []; |
| true -> |
| case [Rev1 || #rev_info{rev=Rev1,deleted=false} <- RestInfo] of |
| [] -> []; |
| ConflictRevs -> [{conflicts, ConflictRevs}] |
| end |
| end ++ |
| case lists:member(deleted_conflicts, Options) of |
| false -> []; |
| true -> |
| case [Rev1 || #rev_info{rev=Rev1,deleted=true} <- RestInfo] of |
| [] -> []; |
| DelConflictRevs -> [{deleted_conflicts, DelConflictRevs}] |
| end |
| end ++ |
| case lists:member(local_seq, Options) of |
| false -> []; |
| true -> [{local_seq, Seq}] |
| end. |
| |
| read_doc(#db{fd=Fd}, OldStreamPointer) when is_tuple(OldStreamPointer) -> |
| % 09 UPGRADE CODE |
| couch_stream:old_read_term(Fd, OldStreamPointer); |
| read_doc(#db{fd=Fd}, Pos) -> |
| couch_file:pread_term(Fd, Pos). |
| |
| |
| doc_to_tree(#doc{revs={Start, RevIds}}=Doc) -> |
| [Tree] = doc_to_tree_simple(Doc, lists:reverse(RevIds)), |
| {Start - length(RevIds) + 1, Tree}. |
| |
| |
| doc_to_tree_simple(Doc, [RevId]) -> |
| [{RevId, Doc, []}]; |
| doc_to_tree_simple(Doc, [RevId | Rest]) -> |
| [{RevId, ?REV_MISSING, doc_to_tree_simple(Doc, Rest)}]. |
| |
| |
| make_doc(#db{fd=Fd}=Db, Id, Deleted, Bp, RevisionPath) -> |
| {BodyData, Atts} = |
| case Bp of |
| nil -> |
| {[], []}; |
| _ -> |
| {ok, {BodyData0, Atts0}} = read_doc(Db, Bp), |
| {BodyData0, |
| lists:map( |
| fun({Name,Type,Sp,Len,RevPos,Md5}) -> |
| #att{name=Name, |
| type=Type, |
| len=Len, |
| md5=Md5, |
| revpos=RevPos, |
| data={Fd,Sp}}; |
| ({Name,{Type,Sp,Len}}) -> |
| #att{name=Name, |
| type=Type, |
| len=Len, |
| md5= <<>>, |
| revpos=0, |
| data={Fd,Sp}} |
| end, Atts0)} |
| end, |
| #doc{ |
| id = Id, |
| revs = RevisionPath, |
| body = BodyData, |
| atts = Atts, |
| deleted = Deleted |
| }. |
| |
| |
| |