Enhance javadoc.
[Sone.git] / src / main / java / net / pterodactylus / sone / web / ajax / GetPostLikesAjaxPage.java
1 /*
2  * Sone - GetPostLikesAjaxPage.java - Copyright © 2010 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.sone.web.ajax;
19
20 import net.pterodactylus.sone.data.Post;
21 import net.pterodactylus.sone.web.WebInterface;
22 import net.pterodactylus.util.json.JsonObject;
23
24 /**
25  * AJAX page that retrieves the number of “likes” a {@link Post} has.
26  *
27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
28  */
29 public class GetPostLikesAjaxPage extends JsonPage {
30
31         /**
32          * Creates a new “get post likes” AJAX page.
33          *
34          * @param webInterface
35          *            The Sone web interface
36          */
37         public GetPostLikesAjaxPage(WebInterface webInterface) {
38                 super("ajax/getPostLikes.ajax", webInterface);
39         }
40
41         //
42         // JSONPAGE METHODS
43         //
44
45         /**
46          * {@inheritDoc}
47          */
48         @Override
49         protected JsonObject createJsonObject(Request request) {
50                 String postId = request.getHttpRequest().getParam("post", null);
51                 if ((postId == null) || (postId.length() == 0)) {
52                         return new JsonObject().put("success", false).put("error", "invalid-post-id");
53                 }
54                 Post post = webInterface.core().getPost(postId);
55                 return new JsonObject().put("success", true).put("likes", webInterface.core().getLikes(post).size());
56         }
57
58         /**
59          * {@inheritDoc}
60          */
61         @Override
62         protected boolean needsFormPassword() {
63                 return false;
64         }
65
66 }