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