1 |
dpavlin |
1046 |
package Frey::CouchAPI; |
2 |
|
|
|
3 |
dpavlin |
1051 |
=head1 DESCRIPTION |
4 |
|
|
|
5 |
dpavlin |
1052 |
This is REST wrapper using following L<Mojo> implement Apache's CouchDB API |
6 |
dpavlin |
1051 |
|
7 |
dpavlin |
1052 |
|
8 |
|
|
L<Mojo::URL> |
9 |
|
|
|
10 |
|
|
L<Mojo::Transaction> |
11 |
|
|
|
12 |
|
|
|
13 |
dpavlin |
1051 |
=head1 Supported HTTP API |
14 |
|
|
|
15 |
|
|
=cut |
16 |
|
|
|
17 |
dpavlin |
1049 |
use warnings; |
18 |
|
|
use strict; |
19 |
|
|
|
20 |
dpavlin |
1046 |
use JSON; |
21 |
|
|
use Data::Dump qw/dump/; |
22 |
|
|
use URI::Escape; |
23 |
dpavlin |
1047 |
use File::Path qw(make_path remove_tree); |
24 |
|
|
use Storable; |
25 |
dpavlin |
1046 |
|
26 |
dpavlin |
1061 |
our $VERSION = '0.3'; |
27 |
dpavlin |
1053 |
$VERSION .= " (Frey $Frey::VERSION)" if $Frey::VERSION; |
28 |
dpavlin |
1049 |
|
29 |
|
|
our $debug = $Frey::debug || 0; |
30 |
|
|
|
31 |
dpavlin |
1046 |
sub rewrite_urls { |
32 |
|
|
my ( $self, $tx ) = @_; |
33 |
|
|
if ( $tx->req->url->path =~ m{/_utils/} ) { |
34 |
|
|
my $path = $tx->req->url->path; |
35 |
|
|
$path =~ s{(/_utils)/?$}{$1/index.html}; # poor man's DirectoryIndex |
36 |
|
|
$path =~ s{/_utils}{/static/futon}; |
37 |
|
|
$tx->req->url->path( $path ); |
38 |
|
|
my $url = $tx->req->url->to_string; |
39 |
|
|
my $old = $url; |
40 |
|
|
$url = $tx->req->url->to_string; |
41 |
|
|
warn "# rewrite $old -> $url\n"; |
42 |
|
|
} |
43 |
|
|
} |
44 |
|
|
|
45 |
dpavlin |
1050 |
our $config = { |
46 |
dpavlin |
1061 |
database => { |
47 |
|
|
path => '/data/webpac2/var/row', |
48 |
|
|
name_glob => '/*/*', |
49 |
|
|
} |
50 |
dpavlin |
1050 |
}; |
51 |
|
|
|
52 |
dpavlin |
1047 |
my $regex_dbs = '[a-z][a-z0-9_\$\(\)\+\-/]+'; |
53 |
dpavlin |
1046 |
|
54 |
dpavlin |
1047 |
our $json = {}; |
55 |
dpavlin |
1052 |
our $status; |
56 |
dpavlin |
1047 |
|
57 |
|
|
sub ok { |
58 |
|
|
$json = { ok => JSON::true }; |
59 |
|
|
$status = 200; |
60 |
dpavlin |
1054 |
warn "ok from ",join(' ',caller),$/; |
61 |
dpavlin |
1047 |
} |
62 |
|
|
|
63 |
dpavlin |
1054 |
sub file_rev { (stat($_[0]))[9] } # mtime |
64 |
dpavlin |
1050 |
|
65 |
dpavlin |
1060 |
sub data_from_tx { |
66 |
|
|
my $tx = shift; |
67 |
|
|
my $data = $tx->req->content->file->slurp; |
68 |
|
|
$data = JSON->new->allow_nonref->decode( $data ); |
69 |
|
|
warn "## data ",dump( $data ); |
70 |
|
|
return $data; |
71 |
|
|
} |
72 |
|
|
|
73 |
dpavlin |
1046 |
sub dispatch { |
74 |
|
|
my ($self,$tx) = @_; |
75 |
|
|
|
76 |
dpavlin |
1052 |
$status = 500; # Internal Error |
77 |
|
|
|
78 |
dpavlin |
1046 |
my $url = $tx->req->url->to_string; |
79 |
|
|
$url = uri_unescape( $url ); |
80 |
dpavlin |
1047 |
my $method = $tx->req->method; |
81 |
dpavlin |
1061 |
my $path = $config->{database}->{path}; |
82 |
dpavlin |
1050 |
|
83 |
dpavlin |
1046 |
if ( $url eq '/' ) { |
84 |
|
|
$json = { |
85 |
dpavlin |
1047 |
couchdb => "Welcome", |
86 |
dpavlin |
1050 |
version => "CouchAPI $VERSION", |
87 |
dpavlin |
1052 |
}; |
88 |
|
|
$status = 200; |
89 |
dpavlin |
1046 |
} elsif ( $url eq '/_all_dbs' ) { |
90 |
dpavlin |
1061 |
$json = [ |
91 |
|
|
map { |
92 |
|
|
s{^\Q$path\E/*}{}; |
93 |
|
|
$_; |
94 |
|
|
} glob $path . $config->{database}->{name_glob} |
95 |
|
|
]; |
96 |
dpavlin |
1047 |
$status = 200; |
97 |
dpavlin |
1050 |
} elsif ( $url =~ m{^/_config/?(.+)} ) { |
98 |
|
|
|
99 |
dpavlin |
1061 |
$json = $config; |
100 |
dpavlin |
1050 |
|
101 |
|
|
if ( $method eq 'PUT' ) { |
102 |
|
|
|
103 |
|
|
my $part = $1; |
104 |
dpavlin |
1061 |
my $data = data_from_tx( $tx ); |
105 |
|
|
warn "## part $part = $data\n"; |
106 |
dpavlin |
1050 |
|
107 |
|
|
$part =~ s!/!'}->{'!; |
108 |
|
|
|
109 |
|
|
# poor man's transaction :-) |
110 |
dpavlin |
1061 |
my $code = "\$config->{'$part'} = \$data;"; |
111 |
dpavlin |
1050 |
eval $code; |
112 |
|
|
if ( $@ ) { |
113 |
|
|
warn "ERROR: $code -> $@"; |
114 |
|
|
$status = 500; |
115 |
|
|
} else { |
116 |
|
|
$status = 200; |
117 |
dpavlin |
1049 |
} |
118 |
dpavlin |
1050 |
|
119 |
dpavlin |
1061 |
warn "# config after $code is ",dump( $config ),$/; |
120 |
dpavlin |
1050 |
|
121 |
|
|
} elsif ( $method eq 'GET' ) { |
122 |
|
|
$status = 200; |
123 |
|
|
} else { |
124 |
|
|
$status = 501; |
125 |
|
|
} |
126 |
|
|
|
127 |
dpavlin |
1051 |
=head2 Database |
128 |
|
|
|
129 |
|
|
L<http://wiki.apache.org/couchdb/HTTP_database_API> except compaction |
130 |
|
|
|
131 |
|
|
=cut |
132 |
|
|
|
133 |
dpavlin |
1059 |
} elsif ( |
134 |
|
|
$url =~ m{($regex_dbs)/$} |
135 |
|
|
# DELETE doesn't have trailing slash |
136 |
|
|
|| $method eq 'DELETE' && $url =~ m{($regex_dbs)$} |
137 |
|
|
) { |
138 |
|
|
|
139 |
dpavlin |
1047 |
my $database = $1; |
140 |
|
|
|
141 |
dpavlin |
1054 |
my $dir = "$path/$database"; |
142 |
|
|
|
143 |
dpavlin |
1047 |
if ( $method eq 'GET' ) { |
144 |
|
|
$json = database_get( $database ); |
145 |
|
|
} elsif ( $method eq 'DELETE' ) { |
146 |
|
|
if ( ! -e $dir ) { |
147 |
|
|
$status = 404; |
148 |
|
|
} else { |
149 |
dpavlin |
1054 |
remove_tree($dir); |
150 |
|
|
if ( ! -d $dir ) { |
151 |
|
|
ok; |
152 |
|
|
} else { |
153 |
|
|
$status = 500; |
154 |
|
|
} |
155 |
dpavlin |
1047 |
} |
156 |
|
|
} elsif ( $method eq 'PUT' ) { |
157 |
dpavlin |
1054 |
if ( -e $dir ) { |
158 |
|
|
$status = 412; |
159 |
dpavlin |
1047 |
} else { |
160 |
dpavlin |
1054 |
make_path($dir); |
161 |
|
|
if ( -e $path ) { |
162 |
|
|
ok; |
163 |
|
|
$status = 201; |
164 |
|
|
} else { |
165 |
|
|
$status = 500; |
166 |
|
|
} |
167 |
dpavlin |
1047 |
} |
168 |
|
|
} |
169 |
|
|
|
170 |
dpavlin |
1059 |
warn "## database $database $status ",dump( $json ); |
171 |
|
|
|
172 |
dpavlin |
1049 |
} elsif ( $url =~ m{($regex_dbs)/([^?]+)\??(.+)?$} ) { |
173 |
|
|
my ($database,$id,$args) = ($1,$2,$3); |
174 |
|
|
|
175 |
dpavlin |
1051 |
=head2 Document |
176 |
|
|
|
177 |
|
|
L<http://wiki.apache.org/couchdb/HTTP_Document_API> |
178 |
|
|
|
179 |
|
|
=cut |
180 |
|
|
|
181 |
dpavlin |
1049 |
my $arg; |
182 |
|
|
if ( $args ) { |
183 |
|
|
foreach my $a ( split(/[&;]/,$args) ) { |
184 |
|
|
my ($n,$v) = split(/=/,$a); |
185 |
|
|
$v =~ s{(["'])(.+)\1}{$2}; |
186 |
|
|
$arg->{$n} = $v; |
187 |
|
|
} |
188 |
|
|
} |
189 |
dpavlin |
1050 |
|
190 |
|
|
warn "ERROR: path $path doesn't exist\n" unless -e $path; |
191 |
|
|
|
192 |
dpavlin |
1047 |
my $p = "$path/$database/$id"; |
193 |
dpavlin |
1051 |
warn "## database: $database id: $id -> $p ", dump( $arg ),"\n"; |
194 |
dpavlin |
1047 |
|
195 |
|
|
|
196 |
dpavlin |
1057 |
if ( $id =~ m{_all_docs(\w*)$} ) { |
197 |
dpavlin |
1049 |
|
198 |
|
|
my $by = $1; |
199 |
|
|
my $offset = 0; |
200 |
|
|
my $startkey = delete $arg->{startkey}; |
201 |
dpavlin |
1062 |
$startkey ||= delete $arg->{startkey_docid}; # XXX key == id |
202 |
dpavlin |
1051 |
my $endkey = delete $arg->{endkey}; |
203 |
|
|
my $limit = delete $arg->{limit}; |
204 |
dpavlin |
1060 |
my $skip = delete $arg->{skip}; |
205 |
dpavlin |
1049 |
my $total_rows = 0; |
206 |
dpavlin |
1062 |
my $collected_rows = 0; |
207 |
dpavlin |
1049 |
|
208 |
|
|
my @docs = grep { length $_ } map { |
209 |
dpavlin |
1057 |
|
210 |
dpavlin |
1062 |
$total_rows++; |
211 |
|
|
|
212 |
|
|
if ( $limit > 0 && $collected_rows == $limit ) { |
213 |
dpavlin |
1057 |
''; |
214 |
|
|
} else { |
215 |
dpavlin |
1051 |
|
216 |
dpavlin |
1057 |
s{^$path/$database/}{}; |
217 |
dpavlin |
1051 |
|
218 |
dpavlin |
1057 |
if ( defined $endkey && $_ gt $endkey ) { |
219 |
|
|
''; |
220 |
|
|
} elsif ( $startkey ) { |
221 |
|
|
if ( $_ ge $startkey ) { |
222 |
dpavlin |
1062 |
$collected_rows++; |
223 |
dpavlin |
1057 |
$_; |
224 |
|
|
} else { |
225 |
|
|
$offset++; |
226 |
|
|
''; |
227 |
|
|
} |
228 |
|
|
} else { |
229 |
dpavlin |
1062 |
$collected_rows++; |
230 |
dpavlin |
1049 |
$_; |
231 |
|
|
} |
232 |
|
|
} |
233 |
dpavlin |
1051 |
|
234 |
dpavlin |
1047 |
} glob( "$path/$database/*" ); |
235 |
|
|
|
236 |
dpavlin |
1060 |
$offset += $skip if $skip; |
237 |
dpavlin |
1057 |
|
238 |
dpavlin |
1051 |
warn "## docs $startkey -> $endkey limit $limit ", dump( @docs ); # if $debug; |
239 |
dpavlin |
1047 |
|
240 |
|
|
$json = { |
241 |
dpavlin |
1049 |
total_rows => $total_rows, |
242 |
|
|
offset => $offset, |
243 |
dpavlin |
1047 |
rows => [], |
244 |
|
|
}; |
245 |
|
|
|
246 |
dpavlin |
1049 |
my $rows; |
247 |
|
|
my @ids; |
248 |
|
|
|
249 |
dpavlin |
1047 |
foreach my $id ( @docs ) { |
250 |
dpavlin |
1049 |
warn "++ $id\n" if $debug; |
251 |
dpavlin |
1047 |
my $p = "$path/$database/$id"; |
252 |
dpavlin |
1049 |
my $data = eval { Storable::retrieve( $p ) }; |
253 |
|
|
if ( $@ ) { |
254 |
|
|
warn "ERROR: $p | $@\n"; |
255 |
|
|
next; |
256 |
|
|
} |
257 |
|
|
push @ids, $id; |
258 |
|
|
$rows->{$id} = { |
259 |
dpavlin |
1047 |
id => $id, |
260 |
|
|
key => $id, |
261 |
|
|
value => { |
262 |
dpavlin |
1054 |
rev => file_rev $p, |
263 |
dpavlin |
1047 |
} |
264 |
|
|
}; |
265 |
|
|
} |
266 |
|
|
|
267 |
dpavlin |
1049 |
my $descending = delete $arg->{descending}; |
268 |
|
|
my @sorted = sort @ids; |
269 |
|
|
|
270 |
dpavlin |
1050 |
warn "creating rows in ", $descending ? "descending" : "", " order\n"; |
271 |
|
|
|
272 |
dpavlin |
1049 |
foreach my $id ( $descending ? reverse @sorted : @sorted ) { |
273 |
dpavlin |
1050 |
warn ">> $id ", $descending ? 'desc' : 'asc', "\n" if $debug; |
274 |
dpavlin |
1049 |
push @{ $json->{rows} }, $rows->{$id}; |
275 |
|
|
} |
276 |
|
|
|
277 |
dpavlin |
1057 |
$status = 200; |
278 |
|
|
|
279 |
dpavlin |
1047 |
} elsif ( $method eq 'PUT' ) { |
280 |
|
|
|
281 |
dpavlin |
1059 |
warn "## ",dump( $tx->req ) if $debug; |
282 |
dpavlin |
1047 |
|
283 |
|
|
my $data = $tx->req->content->file->slurp; |
284 |
|
|
|
285 |
dpavlin |
1059 |
my $db_path = "$path/$database"; |
286 |
|
|
make_path $db_path unless -e $db_path; |
287 |
|
|
|
288 |
dpavlin |
1047 |
Storable::store( from_json($data), $p ); |
289 |
dpavlin |
1054 |
my $rev = file_rev $p; |
290 |
|
|
warn "store $p $rev size ", -s $p, " bytes | $data\n"; |
291 |
|
|
|
292 |
dpavlin |
1052 |
$status = 201; # Created |
293 |
dpavlin |
1054 |
$json = { |
294 |
|
|
id => $id, |
295 |
|
|
ok => JSON::true, |
296 |
|
|
rev => $rev, |
297 |
|
|
}; |
298 |
|
|
|
299 |
dpavlin |
1047 |
} elsif ( $method eq 'GET' ) { |
300 |
dpavlin |
1049 |
if ( ! -e $p ) { |
301 |
|
|
$status = 404; |
302 |
|
|
} else { |
303 |
|
|
warn "retrive $p ", -s $p, " bytes\n"; |
304 |
|
|
$json = Storable::retrieve( $p ); |
305 |
dpavlin |
1055 |
if ( delete $arg->{revs_info} ) { |
306 |
|
|
my $rev = file_rev $p; |
307 |
|
|
$json->{_rev} = $rev; |
308 |
|
|
$json->{_revs_info} = [ |
309 |
|
|
{ rev => $rev, status => 'available' } |
310 |
|
|
]; |
311 |
|
|
} |
312 |
|
|
$status = 200; |
313 |
|
|
|
314 |
dpavlin |
1049 |
} |
315 |
|
|
} elsif ( $method eq 'DELETE' ) { |
316 |
|
|
if ( -e $p ) { |
317 |
dpavlin |
1054 |
unlink $p && ok || { $status = 500 }; |
318 |
dpavlin |
1049 |
} else { |
319 |
|
|
$status = 404; |
320 |
|
|
} |
321 |
dpavlin |
1056 |
} elsif ( $method eq 'POST' ) { |
322 |
dpavlin |
1060 |
my $data = data_from_tx( $tx ); |
323 |
|
|
|
324 |
|
|
# FIXME implement real view server and return 200 |
325 |
dpavlin |
1056 |
$json = { total_rows => 0, offset => 0 }; |
326 |
dpavlin |
1060 |
$status = 202; |
327 |
|
|
|
328 |
dpavlin |
1047 |
} else { |
329 |
|
|
$status = 501; |
330 |
|
|
} |
331 |
|
|
|
332 |
dpavlin |
1059 |
if ( keys %$arg ) { |
333 |
|
|
warn "WARNING: arg left from $url = ",dump( $arg ),$/; |
334 |
|
|
$status = 501; |
335 |
|
|
} |
336 |
dpavlin |
1049 |
|
337 |
dpavlin |
1046 |
} |
338 |
|
|
|
339 |
dpavlin |
1052 |
$json = { error => 'not_found', reason => 'Missing' } if $status == 404; |
340 |
|
|
|
341 |
|
|
if ( $method =~ m{(DELETE|PUT)} ) { |
342 |
|
|
$tx->res->headers->add_line( 'Location' => $tx->req->url->to_abs ); |
343 |
dpavlin |
1047 |
} |
344 |
|
|
|
345 |
|
|
$tx->res->code( $status ); |
346 |
dpavlin |
1053 |
$tx->res->headers->content_type( 'text/plain;charset=utf-8' ); |
347 |
dpavlin |
1047 |
my $body = to_json $json; |
348 |
|
|
$tx->res->body( $body ); |
349 |
dpavlin |
1053 |
$tx->res->headers->add_line( 'Cache-Control' => 'must-revalidate' ); |
350 |
|
|
$tx->res->headers->add_line( 'Server' => "Frey::CouchAPI/$VERSION" ); |
351 |
dpavlin |
1052 |
|
352 |
dpavlin |
1054 |
print "$method $url $status\n$body\n"; |
353 |
dpavlin |
1053 |
|
354 |
dpavlin |
1052 |
warn "## headers ", $tx->res->headers->to_string; |
355 |
|
|
|
356 |
dpavlin |
1046 |
return $tx; |
357 |
|
|
|
358 |
|
|
} |
359 |
|
|
|
360 |
dpavlin |
1047 |
sub database_get { |
361 |
|
|
my ($db_name) = @_; |
362 |
dpavlin |
1061 |
my $path = $config->{database}->{path} || die; |
363 |
dpavlin |
1047 |
warn "# collecting docs from $path/$db_name/*\n"; |
364 |
|
|
my @docs = glob "$path/$db_name/*"; |
365 |
|
|
my $json = { |
366 |
|
|
db_name => $db_name, |
367 |
|
|
doc_count => $#docs + 1, |
368 |
|
|
doc_del_count => 0, |
369 |
|
|
update_seq => 0, |
370 |
|
|
purge_seq => 0, |
371 |
|
|
capacity_running => JSON::false, |
372 |
|
|
disk_size => 0, |
373 |
|
|
instance_start_time => time(), |
374 |
|
|
}; |
375 |
|
|
|
376 |
|
|
warn "## calculating disk_size\n"; |
377 |
dpavlin |
1049 |
$json->{disk_size} += -s $_ foreach @docs; |
378 |
dpavlin |
1047 |
$status = 200; |
379 |
|
|
return $json; |
380 |
|
|
} |
381 |
|
|
|
382 |
dpavlin |
1046 |
1; |
383 |
dpavlin |
1051 |
__END__ |
384 |
|
|
|
385 |
|
|
=head1 SEE ALSO |
386 |
|
|
|
387 |
|
|
L<http://wiki.apache.org/couchdb/Reference> |
388 |
|
|
|