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
|
% 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_doc).
-export([to_doc_info/1,to_doc_info_path/1]).
-export([bin_foldl/3,bin_size/1,bin_to_binary/1,get_validate_doc_fun/1]).
-export([from_json_obj/1,to_json_obj/2,has_stubs/1, merge_stubs/2]).
-include("couch_db.hrl").
% helpers used by to_json_obj
to_json_rev([]) ->
[];
to_json_rev(Revs) ->
[{<<"_rev">>, lists:nth(1, Revs)}].
to_json_body(true, _Body) ->
[{<<"_deleted">>, true}];
to_json_body(false, {Body}) ->
Body.
to_json_revs(Options, Revs) ->
case lists:member(revs, Options) of
false -> [];
true ->
[{<<"_revs">>, Revs}]
end.
to_json_revs_info(Meta) ->
lists:map(
fun({revs_info, RevsInfo}) ->
JsonRevsInfo =
[{[{rev, Rev}, {status, list_to_binary(atom_to_list(Status))}]} ||
{Rev, Status} <- RevsInfo],
{<<"_revs_info">>, JsonRevsInfo};
({conflicts, Conflicts}) ->
{<<"_conflicts">>, Conflicts};
({deleted_conflicts, Conflicts}) ->
{<<"_deleted_conflicts">>, Conflicts}
end, Meta).
to_json_attachment_stubs(Attachments) ->
BinProps = lists:map(
fun({Name, {Type, BinValue}}) ->
{Name, {[
{<<"stub">>, true},
{<<"content_type">>, Type},
{<<"length">>, bin_size(BinValue)}
]}}
end,
Attachments),
case BinProps of
[] -> [];
_ -> [{<<"_attachments">>, {BinProps}}]
end.
to_json_attachments(Attachments) ->
BinProps = lists:map(
fun({Name, {Type, BinValue}}) ->
{Name, {[
{<<"content_type">>, Type},
{<<"data">>, couch_util:encodeBase64(bin_to_binary(BinValue))}
]}}
end,
Attachments),
case BinProps of
[] -> [];
_ -> [{<<"_attachments">>, {BinProps}}]
end.
to_json_attachments(Attachments, Options) ->
case lists:member(attachments, Options) of
true -> % return the full rev list and the binaries as strings.
to_json_attachments(Attachments);
false ->
to_json_attachment_stubs(Attachments)
end.
to_json_obj(#doc{id=Id,deleted=Del,body=Body,revs=Revs,meta=Meta}=Doc,Options)->
{[{<<"_id">>, Id}]
++ to_json_rev(Revs)
++ to_json_body(Del, Body)
++ to_json_revs(Options, Revs)
++ to_json_revs_info(Meta)
++ to_json_attachments(Doc#doc.attachments, Options)
}.
from_json_obj({Props}) ->
{JsonBins} = proplists:get_value(<<"_attachments">>, Props, {[]}),
Bins = lists:flatmap(fun({Name, {BinProps}}) ->
case proplists:get_value(<<"stub">>, BinProps) of
true ->
[{Name, stub}];
_ ->
Value = proplists:get_value(<<"data">>, BinProps),
Type = proplists:get_value(<<"content_type">>, BinProps,
?DEFAULT_ATTACHMENT_CONTENT_TYPE),
[{Name, {Type, couch_util:decodeBase64(Value)}}]
end
end, JsonBins),
AllowedSpecialMembers = [<<"id">>, <<"revs">>, <<"rev">>, <<"attachments">>, <<"revs_info">>,
<<"conflicts">>, <<"deleted_conflicts">>, <<"deleted">>],
% collect all the doc-members that start with "_"
% if any aren't in the AllowedSpecialMembers list
% then throw a doc_validation error
[case lists:member(Name, AllowedSpecialMembers) of
true ->
ok;
false ->
throw({doc_validation, io_lib:format("Bad special document member: _~s", [Name])})
end
|| {<<$_,Name/binary>>, _Value} <- Props],
Revs =
case proplists:get_value(<<"_revs">>, Props, []) of
[] ->
case proplists:get_value(<<"_rev">>, Props) of
undefined -> [];
Rev -> [Rev]
end;
Revs0 ->
Revs0
end,
case proplists:get_value(<<"_id">>, Props, <<>>) of
Id when is_binary(Id) -> ok;
Id ->
?LOG_DEBUG("Document id is not a string: ~p", [Id]),
throw({invalid_document_id, "Document id is not a string"})
end,
% strip out the all props beginning with _
NewBody = {[{K, V} || {<<First,_/binary>>=K, V} <- Props, First /= $_]},
#doc{
id = Id,
revs = Revs,
deleted = proplists:get_value(<<"_deleted">>, Props, false),
body = NewBody,
attachments = Bins
};
from_json_obj(Other) ->
throw({invalid_json_object, "Document must be a JSON object"}).
to_doc_info(FullDocInfo) ->
{DocInfo, _Path} = to_doc_info_path(FullDocInfo),
DocInfo.
to_doc_info_path(#full_doc_info{id=Id,update_seq=Seq,rev_tree=Tree}) ->
LeafRevs = couch_key_tree:get_all_leafs(Tree),
SortedLeafRevs =
lists:sort(fun({RevIdA, {IsDeletedA, _}, PathA}, {RevIdB, {IsDeletedB, _}, PathB}) ->
% sort descending by {not deleted, then Depth, then RevisionId}
A = {not IsDeletedA, length(PathA), RevIdA},
B = {not IsDeletedB, length(PathB), RevIdB},
A > B
end,
LeafRevs),
[{RevId, {IsDeleted, SummaryPointer}, Path} | Rest] = SortedLeafRevs,
{ConflictRevTuples, DeletedConflictRevTuples} =
lists:splitwith(fun({_ConflictRevId, {IsDeleted1, _Sp}, _}) ->
not IsDeleted1
end, Rest),
ConflictRevs = [RevId1 || {RevId1, _, _} <- ConflictRevTuples],
DeletedConflictRevs = [RevId2 || {RevId2, _, _} <- DeletedConflictRevTuples],
DocInfo = #doc_info{
id=Id,
update_seq=Seq,
rev = RevId,
summary_pointer = SummaryPointer,
conflict_revs = ConflictRevs,
deleted_conflict_revs = DeletedConflictRevs,
deleted = IsDeleted},
{DocInfo, Path}.
bin_foldl(Bin, Fun, Acc) when is_binary(Bin) ->
case Fun(Bin, Acc) of
{ok, Acc2} -> {ok, Acc2};
{done, Acc2} -> {ok, Acc2}
end;
bin_foldl({Fd, Sp, Len}, Fun, Acc) ->
{ok, Acc2, _Sp2} = couch_stream:foldl(Fd, Sp, Len, Fun, Acc),
{ok, Acc2}.
bin_size(Bin) when is_binary(Bin) ->
size(Bin);
bin_size({_Fd, _Sp, Len}) ->
Len.
bin_to_binary(Bin) when is_binary(Bin) ->
Bin;
bin_to_binary({Fd, Sp, Len}) ->
{ok, Bin, _Sp2} = couch_stream:read(Fd, Sp, Len),
Bin.
get_validate_doc_fun(#doc{body={Props}}) ->
Lang = proplists:get_value(<<"language">>, Props, <<"javascript">>),
case proplists:get_value(<<"validate_doc_update">>, Props) of
undefined ->
nil;
FunSrc ->
fun(EditDoc, DiskDoc, Ctx) ->
couch_query_servers:validate_doc_update(
Lang, FunSrc, EditDoc, DiskDoc, Ctx)
end
end.
has_stubs(#doc{attachments=Bins}) ->
has_stubs(Bins);
has_stubs([]) ->
false;
has_stubs([{_Name, stub}|_]) ->
true;
has_stubs([_Bin|Rest]) ->
has_stubs(Rest).
merge_stubs(#doc{attachments=MemBins}=StubsDoc, #doc{attachments=DiskBins}) ->
BinDict = dict:from_list(DiskBins),
MergedBins = lists:map(
fun({Name, stub}) ->
{Name, dict:fetch(Name, BinDict)};
({Name, Value}) ->
{Name, Value}
end, MemBins),
StubsDoc#doc{attachments= MergedBins}.
|
