source: bookmarks/trunk/lib/Bookmarks/Controller.pm @ 107

Last change on this file since 107 was 107, checked in by peter, 9 years ago

Added a /tags resource that provides a drilldown inteface to the tags and bookmarks. URI pattern is /tags/{tag1}/{tag2}/{tag3...}

File size: 7.9 KB
RevLine 
[70]1package Bookmarks::Controller;
2
[59]3use Moose;
[5]4
5use Encode;
[70]6use HTTP::Date qw{time2str str2time};
[5]7use JSON;
8use Bookmarks;
[88]9use Bookmarks::List;
[7]10use URI;
[59]11use Template;
[7]12
[61]13has dbname => (
14    is => 'ro',
15    required => 1,
16);
[59]17has bookmarks => (
[61]18    is => 'ro',
[59]19    handles => [qw{get_bookmark}],
[61]20    builder => '_build_bookmarks',
21    lazy => 1,
[59]22);
23has base_uri => (
24    is => 'ro',
25    builder => '_build_base_uri',
26    lazy => 1,
27);
28has request => (
[98]29    is => 'rw',
[59]30);
31
[61]32sub _build_bookmarks {
33    my $self = shift;
34    return Bookmarks->new({
35        dbname   => $self->dbname,
36        base_uri => $self->base_uri,
37    });
38}
39
[59]40sub _build_base_uri {
[5]41    my $self = shift;
[59]42    my $url = $self->request->base;
[41]43
[53]44    $url .= '/' unless $url =~ m{/$};
[59]45    return URI->new($url);
[5]46}
47
[59]48sub find_or_new {
[5]49    my $self = shift;
50
[59]51    my $bookmark = $self->bookmarks->get_bookmark({ uri => $self->request->param('uri') });
52    if ($bookmark) {
53        # redirect to the view of the existing bookmark
54        return [301, [Location => $bookmark->bookmark_uri], []];
55    } else {
56        # bookmark was not found; show the form to create a new bookmark
[100]57        require File::Basename;
58        my $template = Template->new({ INCLUDE_PATH => File::Basename::dirname($INC{'Bookmarks/Controller.pm'}) });
[59]59        $template->process(
60            'bookmark.tt',
[66]61            { 
62                bookmark => {
63                    uri   => $self->request->param('uri'),
64                    title => $self->request->param('title') || '',
65                },
[59]66            },
67            \my $output,
68        );
69        return [404, ['Content-Type' => 'text/html; charset=UTF-8'], [$output]];
[5]70    }
[59]71}
[5]72
[59]73sub list {
74    my $self = shift;
75
[5]76    # list all the bookmarks
[59]77    my $mtime = $self->bookmarks->get_last_modified_time;
[57]78
[59]79    my $format = $self->request->param('format') || 'html';
[35]80
[59]81    my @tags = grep { $_ ne '' } $self->request->param('tag');
82    my $query = $self->request->param('q');
83    my $limit = $self->request->param('limit');
84    my $offset = $self->request->param('offset');
[106]85    my $page = $self->request->param('page');
[68]86
[88]87    my $list = Bookmarks::List->new({
88        bookmarks => $self->bookmarks,
89        search    => $self->bookmarks->search({
90            query  => $query,
91            tags   => \@tags,
92            limit  => $limit,
93            offset => $offset,
[106]94            page   => $page,
[88]95        }),
[13]96    });
[5]97
[68]98    my $as_format = "as_$format";
99    if (!$list->meta->has_method($as_format)) {
100        return [406, ['Content-Type' => 'text/plain; charset=UTF-8'], [qq{"$format" is not a supported format}]];
[5]101    }
[68]102    return $list->$as_format;
[5]103}
104
[9]105sub feed {
106    my $self = shift;
107
[59]108    my $query = $self->request->param('q');
109    my @tags = grep { $_ ne '' } $self->request->param('tag');
[31]110
[9]111    # construct a feed from the most recent 12 bookmarks
[88]112    my $list = Bookmarks::List->new({
113        bookmarks => $self->bookmarks,
114        search    => $self->bookmarks->search({ query => $query, tags => \@tags, limit => 12 }),
115    });
[68]116    return $list->as_atom;
[9]117}
118
[62]119# returns 1 if there is an If-Modified-Since header and it is newer than the given $mtime
120# returns 0 if there is an If-Modified-Since header but the $mtime is newer
121# returns undef if there is no If-Modified-Since header
[67]122sub _request_is_newer_than {
[62]123    my $self = shift;
124    my $mtime = shift;
125
126    # check If-Modified-Since header to return cache response
127    if ($self->request->env->{HTTP_IF_MODIFIED_SINCE}) {
128        my $cache_time = str2time($self->request->env->{HTTP_IF_MODIFIED_SINCE});
129        return $mtime <= $cache_time ? 1 : 0;
130    } else {
131        return;
132    }
133}
134
[5]135sub view {
[59]136    my ($self, $id) = @_;
[5]137
[59]138    my $format = $self->request->param('format') || 'html';
139
140    my $bookmark = $self->get_bookmark({ id => $id });
[5]141    if ($bookmark) {
[67]142        return [304, [], []] if $self->_request_is_newer_than($bookmark->mtime);
[62]143
[59]144        my $last_modified = time2str($bookmark->mtime);
[57]145       
[30]146        if ($format eq 'json') {
[91]147            my $json = decode_utf8(JSON->new->utf8->convert_blessed->encode($bookmark->to_hashref));
[59]148            return [200, ['Content-Type' => 'application/json; charset=UTF-8', 'Last-Modified' => $last_modified], [$json]];
[5]149        } else {
[30]150            # display the bookmark form for this bookmark
[95]151            require File::Basename;
152            my $template = Template->new({ INCLUDE_PATH => File::Basename::dirname($INC{'Bookmarks/Controller.pm'}) });
[59]153            $template->process(
[30]154                'bookmark.tt',
[66]155                { bookmark => $bookmark },
[59]156                \my $output,
[30]157            );
[59]158            return [200, ['Content-Type' => 'text/html; charset=UTF-8', 'Last-Modified' => $last_modified], [$output]];
[30]159        }
160    } else {
[74]161        return [404, ['Content-Type' => 'text/plain; charset=UTF-8'], ["Bookmark $id not found"]];
[30]162    }
163}
164
165sub view_field {
[59]166    my ($self, $id, $field) = @_;
[30]167
[62]168    my $bookmark = $self->get_bookmark({ id => $id });
[30]169    if ($bookmark) {
[67]170        return [304, [], []] if $self->_request_is_newer_than($bookmark->mtime);
[62]171
[63]172        # check whether the requested field is part of the bookmark
173        if (!$bookmark->meta->has_attribute($field)) {
174            return [404, ['Content-Type' => 'text/plain; charset=UTF-8'], [qq{"$field" is not a valid bookmark data field}]];
[5]175        }
[63]176
177        # respond with just the requested field as plain text
178        my $value = $bookmark->$field;
[62]179        my $last_modified = time2str($bookmark->mtime);
180        return [200, ['Content-Type' => 'text/plain; charset=UTF-8', 'Last-Modified' => $last_modified], [ref $value eq 'ARRAY' ? join(' ', @{ $value }) : $value]];
[5]181    } else {
[74]182        return [404, ['Content-Type' => 'text/plain; charset=UTF-8'], ["Bookmark $id not found"]];
[5]183    }
184}
185
[63]186sub create_and_redirect {
[5]187    my $self = shift;
[59]188
189    my $uri   = $self->request->param('uri');
190    my $title = $self->request->param('title');
191    my @tags  = split ' ', $self->request->param('tags');
192
193    my $bookmark = $self->bookmarks->add({
[5]194        uri   => $uri,
195        title => $title,
196        tags  => \@tags,
197    });
198
[59]199    #TODO: not RESTful; the proper RESTful response would be a 201
200    return [303, ['Location' => $bookmark->bookmark_uri->canonical], []];
[5]201}
202
[63]203sub update_and_redirect {
[45]204    my $self = shift;
[59]205    my $id = shift;
[45]206
[59]207    my $bookmark = $self->bookmarks->get_bookmark({ id => $id });
[45]208    if ($bookmark) {
209        # update the URI, title, and tags
[59]210        $bookmark->uri($self->request->param('uri'));
211        $bookmark->title($self->request->param('title'));
212        $bookmark->tags([ split ' ', $self->request->param('tags') || '' ]);
[45]213
[46]214        # write to the database
[75]215        $bookmark->update;
[46]216
[59]217        #TODO: not RESTful; proper response would be a 200
218        return [303, ['Location' => $bookmark->bookmark_uri->canonical], []];
[45]219    } else {
[74]220        return [404, ['Content-Type' => 'text/plain; charset=UTF-8'], ["Bookmark $id not found"]];
[45]221    }
222}
223
[107]224sub tag_tree {
225    my $self = shift;
226    my $tags = shift || [];
227
228    my $list = Bookmarks::List->new({
229        bookmarks => $self->bookmarks,
230        search    => $self->bookmarks->search({
231            tags   => $tags,
232        }),
233    });
234
235    my @tags = map {
236        {
237            path => join('/', @$tags[0 .. $_ - 1]),
238            tag  => $tags->[$_ - 1],
239        }
240    } 1 .. scalar(@{ $tags });
241
242    require Template;
243    require File::Basename;
244    my @cotags = $self->bookmarks->get_cotags({ search => $list->search });
245
246    #TODO: get the actual request URI and makre sure it ends with a /
247    my $base_url = join '/', ($self->base_uri . 'tags'), @$tags;
248    $base_url .= '/';
249    my $template = Template->new({ INCLUDE_PATH => File::Basename::dirname($INC{'Bookmarks/Controller.pm'}) });
250
251    $template->process(
252        'tagtree.html',
253        {
254            base_url => $self->base_uri,
255            request_url => $base_url,
256            tags      => \@tags,
257            cotags    => \@cotags,
258            bookmarks => $list->results,
259        },
260        \my $output,
261    );
262
263
264    return [200, ['Content-Type' => 'text/html; charset=UTF-8'], [$output]];
265}
266
[5]2671;
Note: See TracBrowser for help on using the repository browser.