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

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

Better separation of the model for searching and the web app controller/representation layer

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