From aa373f798ff22844692341c60c605bf627744cd7 Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Thu, 2 Jun 2016 22:01:49 +0200 Subject: [PATCH 01/78] + apidoc.json The apidoc.json file configures the ApiDoc tools. It generates AJAX API documentation out of comments in the source code. --- apidoc.json | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 apidoc.json diff --git a/apidoc.json b/apidoc.json new file mode 100644 index 0000000..760e429 --- /dev/null +++ b/apidoc.json @@ -0,0 +1,6 @@ +{ + "name": "isso", + "description": "a Disqus alternative", + "title": "isso API" +} + From 5ca5d680fa0eb9496bbab22e2331ad59c8658e6b Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Thu, 2 Jun 2016 22:02:06 +0200 Subject: [PATCH 02/78] apidoc for fetch --- isso/views/comments.py | 84 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) diff --git a/isso/views/comments.py b/isso/views/comments.py index 0272fa3..baa720a 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -347,6 +347,90 @@ class API(object): return Response("Yo", 200) + + """ + @api {get} / get comments + @apiGroup Thread + @apiDescription Queries the comments of a thread. + + @apiParam {string} uri + The URI of thread to get the comments from. + @apiParam {number} [parent] + Return only comments that are children of the comment with the provided ID. + @apiParam {number=0,1} [plain] + Iff set to `1`, the plain text entered by the user will be returned in the comments’ `text` attribute (instead of the rendered markdown). + @apiParam {number} [limit] + The maximum number of returned top-level comments. Omit for unlimited results. + @apiParam {number} [nested_limit] + The maximum number of returned nested comments per commint. Omit for unlimited results. + @apiParam {number} [after] + Includes only comments were added after the provided UNIX timestamp. + + @apiSuccess {number} total_replies + The number of replies if the `limit` parameter was not set. If `after` is set to `X`, this is the number of comments that were created after `X`. So setting `after` may change this value! + @apiSuccess {Object[]} replies + The list of comments. Each comment also has the `total_replies`, `replies`, `id` and `hidden_replies` properties to represent nested comments. + @apiSuccess {number} id + Id of the comment `replies` is the list of replies of. `null` for the list of toplevel comments. + @apiSuccess {number} hidden_replies + The number of comments that were ommited from the results because of the `limit` request parameter. Usually, this will be `total_replies` - `limit`. + + @apiExample {curl} Get 2 comments with 5 responses: + curl 'https://comments.example.com/?uri=/thread/&limit=2&nested_limit=5' + @apiSuccessExample Example reponse: + { + "total_replies": 14, + "replies": [ + { + "website": null, + "author": null, + "parent": null, + "created": 1464818460.732863, + "text": "<p>Hello, World!</p>", + "total_replies": 1, + "hidden_replies": 0, + "dislikes": 2, + "modified": null, + "mode": 1, + "replies": [ + { + "website": null, + "author": null, + "parent": 1, + "created": 1464818460.769638, + "text": "<p>Hi, now some Markdown: <em>Italic</em>, <strong>bold</strong>, <code>monospace</code>.</p>", + "dislikes": 0, + "modified": null, + "mode": 1, + "hash": "2af4e1a6c96a", + "id": 2, + "likes": 2 + } + ], + "hash": "1cb6cc0309a2", + "id": 1, + "likes": 2 + }, + { + "website": null, + "author": null, + "parent": null, + "created": 1464818460.80574, + "text": "<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Accusantium at commodi cum deserunt dolore, error fugiat harum incidunt, ipsa ipsum mollitia nam provident rerum sapiente suscipit tempora vitae? Est, qui?</p>", + "total_replies": 0, + "hidden_replies": 0, + "dislikes": 0, + "modified": null, + "mode": 1, + "replies": [], + "hash": "1cb6cc0309a2", + "id": 3, + "likes": 0 + }, + "id": null, + "hidden_replies": 12 + } + """ @requires(str, 'uri') def fetch(self, environ, request, uri): From b2d9c80b5f17fb86b797ff86da6acb9dd2805bd0 Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Fri, 3 Jun 2016 10:13:13 +0200 Subject: [PATCH 03/78] apidoc for "new comment" --- isso/views/comments.py | 64 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/isso/views/comments.py b/isso/views/comments.py index baa720a..8cf0cab 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -60,6 +60,12 @@ def xhr(func): not forged (XHR is restricted by CORS separately). """ + + """ + @apiDefine csrf + @apiHeader {string="application/json"} Content-Type + The content type must be set to `application/json` to prevent CSRF attacks. + """ def dec(self, env, req, *args, **kwargs): if req.content_type and not req.content_type.startswith("application/json"): @@ -140,6 +146,64 @@ class API(object): return True, "" + """ + @api {post} /new create new + @apiGroup Comment + @apiUse csrf + + @apiParam {string} uri + The uri of the thread to create the comment on. + @apiParam {string} text + The comment’s raw text. + @apiParam {string} [author] + The comment’s author’s name. + @apiParam {string} [email] + The comment’s author’s email address. + @apiParam {string} [website] + The comment’s author’s website’s url. + @apiParam {number} [parent] + The parent comment’s id iff the new comment is a response to an existing comment. + + @apiExample {curl} Create a reply to comment with id 15: + curl 'https://comments.example.com/new?uri=/thread/' -d '{"text": "Stop saying that! *isso*!", "author": "Max Rant", "email": "rant@example.com", "parent": 15}' -H 'Content-Type: application/json' + + @apiSuccess {number} id + The comment’s id (assigned by the server). + @apiSuccess {number} parent + Id of the comment this comment is a reply to. `null` if this is a top-level-comment. + @apiSuccess {number=1,2,4} mode + The comment’s mode: + value | explanation + --- | --- + `1` | accepted: The comment was accepted by the server and is published. + `2` | in moderation queue: The comment was accepted by the server but awaits moderation. + `4` | deleted, but referenced: The comment was deleted on the server but is still referenced by replies. + @apiSuccess {string} author + The comments’s author’s name or `null`. + @apiSuccess {string} website + The comment’s author’s website or `null`. + @apiSuccess {string} hash + A hash uniquely identifying the comment’s author. + @apiSuccess {number} created + UNIX timestamp of the time the comment was created (on the server). + @apiSuccess {number} modified + UNIX timestamp of the time the comment was last modified (on the server). `null` if the comment was not yet modified. + + @apiSuccessExample Success after the above request: + { + "website": null, + "author": "Max Rant", + "parent": 15, + "created": 1464940838.254393, + "text": "<p>Stop saying that! <em>isso</em>!</p>", + "dislikes": 0, + "modified": null, + "mode": 1, + "hash": "e644f6ee43c0", + "id": 10, + "likes": 0 + } + """ @xhr @requires(str, 'uri') def new(self, environ, request, uri): From 1f804bcf8e2fb40cfc2f7b79e2837d3abee7296e Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Fri, 3 Jun 2016 10:28:51 +0200 Subject: [PATCH 04/78] apidoc for "view comment" --- isso/views/comments.py | 84 ++++++++++++++++++++++++++++++------------ 1 file changed, 61 insertions(+), 23 deletions(-) diff --git a/isso/views/comments.py b/isso/views/comments.py index 8cf0cab..68ed6df 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -146,26 +146,14 @@ class API(object): return True, "" - """ - @api {post} /new create new - @apiGroup Comment - @apiUse csrf - - @apiParam {string} uri - The uri of the thread to create the comment on. - @apiParam {string} text - The comment’s raw text. - @apiParam {string} [author] - The comment’s author’s name. - @apiParam {string} [email] - The comment’s author’s email address. - @apiParam {string} [website] - The comment’s author’s website’s url. - @apiParam {number} [parent] - The parent comment’s id iff the new comment is a response to an existing comment. - - @apiExample {curl} Create a reply to comment with id 15: - curl 'https://comments.example.com/new?uri=/thread/' -d '{"text": "Stop saying that! *isso*!", "author": "Max Rant", "email": "rant@example.com", "parent": 15}' -H 'Content-Type: application/json' + # Common definitions for apidoc follow: + """ + @apiDefine plainParam + @apiParam {number=0,1} [plain] + Iff set to `1`, the plain text entered by the user will be returned in the comments’ `text` attribute (instead of the rendered markdown). + """ + """ + @apiDefine commentResponse @apiSuccess {number} id The comment’s id (assigned by the server). @@ -188,6 +176,30 @@ class API(object): UNIX timestamp of the time the comment was created (on the server). @apiSuccess {number} modified UNIX timestamp of the time the comment was last modified (on the server). `null` if the comment was not yet modified. + """ + + """ + @api {post} /new create new + @apiGroup Comment + @apiUse csrf + + @apiParam {string} uri + The uri of the thread to create the comment on. + @apiParam {string} text + The comment’s raw text. + @apiParam {string} [author] + The comment’s author’s name. + @apiParam {string} [email] + The comment’s author’s email address. + @apiParam {string} [website] + The comment’s author’s website’s url. + @apiParam {number} [parent] + The parent comment’s id iff the new comment is a response to an existing comment. + + @apiExample {curl} Create a reply to comment with id 15: + curl 'https://comments.example.com/new?uri=/thread/' -d '{"text": "Stop saying that! *isso*!", "author": "Max Rant", "email": "rant@example.com", "parent": 15}' -H 'Content-Type: application/json' + + @apiUse commentResponse @apiSuccessExample Success after the above request: { @@ -200,7 +212,7 @@ class API(object): "modified": null, "mode": 1, "hash": "e644f6ee43c0", - "id": 10, + "id": 23, "likes": 0 } """ @@ -277,6 +289,33 @@ class API(object): resp.headers.add("X-Set-Cookie", cookie("isso-%i" % rv["id"])) return resp + """ + @api {get} /id/:id view + @apiGroup Comment + + @apiParam {number} id + The id of the comment to view. + @apiUse plainParam + + @apiExample {curl} View the comment with id 4: + curl 'https://comments.example.com/id/4' + + @apiUse commentResponse + + @apiSuccessExample Example result: + { + "website": null, + "author": null, + "parent": null, + "created": 1464914341.312426, + "text": " <p>I want to use MySQL</p>", + "dislikes": 0, + "modified": null, + "mode": 1, + "id": 4, + "likes": 1 + } + """ def view(self, environ, request, id): rv = self.comments.get(id) @@ -421,8 +460,7 @@ class API(object): The URI of thread to get the comments from. @apiParam {number} [parent] Return only comments that are children of the comment with the provided ID. - @apiParam {number=0,1} [plain] - Iff set to `1`, the plain text entered by the user will be returned in the comments’ `text` attribute (instead of the rendered markdown). + @apiUse plainParam @apiParam {number} [limit] The maximum number of returned top-level comments. Omit for unlimited results. @apiParam {number} [nested_limit] From 9b79a98851939355faa58bd2594a698a9b45bc05 Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Fri, 3 Jun 2016 10:50:57 +0200 Subject: [PATCH 05/78] apidoc for "edit comment" --- isso/views/comments.py | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/isso/views/comments.py b/isso/views/comments.py index 68ed6df..24e01fe 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -181,6 +181,8 @@ class API(object): """ @api {post} /new create new @apiGroup Comment + @apiDescription + Creates a new comment. The response will set a cookie on the requestor to enable them to later edit the comment. @apiUse csrf @apiParam {string} uri @@ -197,7 +199,7 @@ class API(object): The parent comment’s id iff the new comment is a response to an existing comment. @apiExample {curl} Create a reply to comment with id 15: - curl 'https://comments.example.com/new?uri=/thread/' -d '{"text": "Stop saying that! *isso*!", "author": "Max Rant", "email": "rant@example.com", "parent": 15}' -H 'Content-Type: application/json' + curl 'https://comments.example.com/new?uri=/thread/' -d '{"text": "Stop saying that! *isso*!", "author": "Max Rant", "email": "rant@example.com", "parent": 15}' -H 'Content-Type: application/json' -c cookie.txt @apiUse commentResponse @@ -330,6 +332,41 @@ class API(object): return JSON(rv, 200) + """ + @api {put} /id/:id edit + @apiGroup Comment + @apiDescription + Edit an existing comment. Editing a comment is only possible for a short period of time after it was created and only if the requestor has a valid cookie for it. See the [isso server documentation](https://posativ.org/isso/docs/configuration/server) for details. Editing a comment will set a new edit cookie in the response. + @apiUse csrf + + @apiParam {number} id + The id of the comment to edit. + @apiParam {string} text + A new (raw) text for the comment. + @apiParam {string} [author] + The modified comment’s author’s name. + @apiParam {string} [webiste] + The modified comment’s author’s website. + + @apiExample {curl} Edit comment with id 23: + curl -X PUT 'https://comments.example.com/id/23' -d {"text": "I see your point. However, I still disagree.", "website": "maxrant.important.com"} -H 'Content-Type: application/json' -b cookie.txt + + @apiUse commentResponse + + @apiSuccessExample Example response: + { + "website": "maxrant.important.com", + "author": "Max Rant", + "parent": 15, + "created": 1464940838.254393, + "text": "<p>I see your point. However, I still disagree.</p>", + "dislikes": 0, + "modified": 1464943439.073961, + "mode": 1, + "id": 23, + "likes": 0 + } + """ @xhr def edit(self, environ, request, id): From c3439e5c79081f7c450db0fcc99cea59b4945f5b Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Fri, 3 Jun 2016 11:06:46 +0200 Subject: [PATCH 06/78] apidoc for "delete comment" --- isso/views/comments.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/isso/views/comments.py b/isso/views/comments.py index 24e01fe..5f2bac7 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -411,6 +411,21 @@ class API(object): resp.headers.add("X-Set-Cookie", cookie("isso-%i" % rv["id"])) return resp + """ + @api {delete} '/id/:id' delete + @apiGroup Comment + @apiDescription + Delte an existing comment. Deleting a comment is only possible for a short period of time after it was created and only if the requestor has a valid cookie for it. See the [isso server documentation](https://posativ.org/isso/docs/configuration/server) for details. + + @apiParam {number} id + Id of the comment to delete. + + @apiExample {curl} Delete comment with id 14: + curl -X DELETE 'https://comments.example.com/id/14' -b cookie.txt + + @apiSuccessExample Successful deletion returns null: + null + """ @xhr def delete(self, environ, request, id, key=None): From ded4927ae40ceb49ef9b994737d796da43487fcd Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Fri, 3 Jun 2016 14:08:57 +0200 Subject: [PATCH 07/78] apidoc for moderate --- isso/views/comments.py | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/isso/views/comments.py b/isso/views/comments.py index 5f2bac7..2ad90e2 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -463,6 +463,40 @@ class API(object): resp.headers.add("X-Set-Cookie", cookie("isso-%i" % id)) return resp + """ + @api {post} /id/:id/:action/key moderate + @apiGroup Comment + @apiDescription + Publish or delete a comment that is in the moderation queue (mode `2`). In order to use this endpoint, the requestor needs a `key` that is usually obtained from an email sent out by isso. + + This endpoint can also be used with a `GET` request. In that case, a html page is returned that asks the user whether they are sure to perform the selected action. If they select “yes”, the query is repeated using `POST`. + + @apiParam {number} id + The id of the comment to moderate. + @apiParam {string=activate,delete} action + `activate` to publish the comment (change its mode to `1`). + `delete` to delete the comment + @apiParam {string} key + The moderation key to authenticate the moderation. + + @apiExample {curl} delete comment with id 13: + curl -X POST 'https://comments.example.com/id/13/delete/MTM.CjL6Fg.REIdVXa-whJS_x8ojQL4RrXnuF4' + + @apiSuccessExample {html} Using GET: + <!DOCTYPE html> + <html> + <head> + <script> + if (confirm('Delete: Are you sure?')) { + xhr = new XMLHttpRequest; + xhr.open('POST', window.location.href); + xhr.send(null); + } + </script> + + @apiSuccessExample Using POST: + Yo + """ def moderate(self, environ, request, id, action, key): try: From afd4107ac32637d0050e1505c5f616aed9ae9d18 Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Fri, 3 Jun 2016 14:09:16 +0200 Subject: [PATCH 08/78] apidoc for like & dislike --- isso/views/comments.py | 48 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/isso/views/comments.py b/isso/views/comments.py index 2ad90e2..3096ab8 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -716,12 +716,60 @@ class API(object): return fetched_list + """ + @apiDefine likeResponse + @apiSuccess {number} likes + The (new) number of likes on the comment. + @apiSuccess {number} dislikes + The (new) number of dislikes on the comment. + """ + + """ + @api {post} /id/:id/like like + @apiGroup Comment + @apiDescription + Puts a “like” on a comment. The author of a comment cannot like its own comment. + + @apiParam {number} id + The id of the comment to like. + + @apiExample {curl} Like comment with id 23: + curl -X POST 'https://comments.example.com/id/23/like' + + @apiUse likeResponse + + @apiSuccessExample Example response + { + "likes": 5, + "dislikes": 2 + } + """ @xhr def like(self, environ, request, id): nv = self.comments.vote(True, id, utils.anonymize(str(request.remote_addr))) return JSON(nv, 200) + """ + @api {post} /id/:id/dislike dislike + @apiGroup Comment + @apiDescription + Puts a “dislike” on a comment. The author of a comment cannot dislike its own comment. + + @apiParam {number} id + The id of the comment to dislike. + + @apiExample {curl} Dislike comment with id 23: + curl -X POST 'https://comments.example.com/id/23/dislike' + + @apiUse likeResponse + + @apiSuccessExample Example response + { + "likes": 4, + "dislikes": 3 + } + """ @xhr def dislike(self, environ, request, id): From 8a9fe29bce19957b5c94ce4ce6c2ebfc45fc1896 Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Fri, 3 Jun 2016 14:20:36 +0200 Subject: [PATCH 09/78] apidoc for count --- isso/views/comments.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/isso/views/comments.py b/isso/views/comments.py index 3096ab8..868dbfe 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -787,6 +787,18 @@ class API(object): return JSON(rv, 200) + """ + @api {post} /count count comments + @apiGroup Thread + @apiDescription + Counts the number of comments on multiple threads. The requestor provides a list of thread uris. The number of comments on each thread is returned as a list, in the same order as the threads were requested. The counts include comments that are reponses to comments. + + @apiExample {curl} get the count of 5 threads: + curl 'https://comments.example.com/count' -d '["/blog/firstPost.html", "/blog/controversalPost.html", "/blog/howToCode.html", "/blog/boringPost.html", "/blog/isso.html"] + + @apiSuccessExample Counts of 5 threads: + [2, 18, 4, 0, 3] + """ def counts(self, environ, request): data = request.get_json() From 084f6e5cf050222c35ace7c4f8c95556d0d19c1e Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Fri, 3 Jun 2016 14:39:22 +0200 Subject: [PATCH 10/78] apidoc settings --- apidoc.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/apidoc.json b/apidoc.json index 760e429..a960a32 100644 --- a/apidoc.json +++ b/apidoc.json @@ -1,6 +1,11 @@ { "name": "isso", "description": "a Disqus alternative", - "title": "isso API" + "title": "isso API", + "order": ["Thread", "Comment"], + "template": { + "withCompare": false + } + } From 2a11c000d49d1749c1091cc55102909b78ebedcb Mon Sep 17 00:00:00 2001 From: Joshua Gleitze Date: Fri, 3 Jun 2016 20:04:58 +0200 Subject: [PATCH 11/78] convert bad tabs to spaces --- isso/views/comments.py | 404 ++++++++++++++++++++--------------------- 1 file changed, 202 insertions(+), 202 deletions(-) diff --git a/isso/views/comments.py b/isso/views/comments.py index 868dbfe..6a7aef1 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -61,11 +61,11 @@ def xhr(func): """ - """ - @apiDefine csrf - @apiHeader {string="application/json"} Content-Type - The content type must be set to `application/json` to prevent CSRF attacks. - """ + """ + @apiDefine csrf + @apiHeader {string="application/json"} Content-Type + The content type must be set to `application/json` to prevent CSRF attacks. + """ def dec(self, env, req, *args, **kwargs): if req.content_type and not req.content_type.startswith("application/json"): @@ -146,44 +146,44 @@ class API(object): return True, "" - # Common definitions for apidoc follow: - """ - @apiDefine plainParam - @apiParam {number=0,1} [plain] - Iff set to `1`, the plain text entered by the user will be returned in the comments’ `text` attribute (instead of the rendered markdown). - """ - """ - @apiDefine commentResponse + # Common definitions for apidoc follow: + """ + @apiDefine plainParam + @apiParam {number=0,1} [plain] + Iff set to `1`, the plain text entered by the user will be returned in the comments’ `text` attribute (instead of the rendered markdown). + """ + """ + @apiDefine commentResponse - @apiSuccess {number} id - The comment’s id (assigned by the server). - @apiSuccess {number} parent - Id of the comment this comment is a reply to. `null` if this is a top-level-comment. - @apiSuccess {number=1,2,4} mode - The comment’s mode: - value | explanation - --- | --- - `1` | accepted: The comment was accepted by the server and is published. - `2` | in moderation queue: The comment was accepted by the server but awaits moderation. - `4` | deleted, but referenced: The comment was deleted on the server but is still referenced by replies. - @apiSuccess {string} author - The comments’s author’s name or `null`. - @apiSuccess {string} website - The comment’s author’s website or `null`. - @apiSuccess {string} hash - A hash uniquely identifying the comment’s author. - @apiSuccess {number} created - UNIX timestamp of the time the comment was created (on the server). - @apiSuccess {number} modified - UNIX timestamp of the time the comment was last modified (on the server). `null` if the comment was not yet modified. - """ + @apiSuccess {number} id + The comment’s id (assigned by the server). + @apiSuccess {number} parent + Id of the comment this comment is a reply to. `null` if this is a top-level-comment. + @apiSuccess {number=1,2,4} mode + The comment’s mode: + value | explanation + --- | --- + `1` | accepted: The comment was accepted by the server and is published. + `2` | in moderation queue: The comment was accepted by the server but awaits moderation. + `4` | deleted, but referenced: The comment was deleted on the server but is still referenced by replies. + @apiSuccess {string} author + The comments’s author’s name or `null`. + @apiSuccess {string} website + The comment’s author’s website or `null`. + @apiSuccess {string} hash + A hash uniquely identifying the comment’s author. + @apiSuccess {number} created + UNIX timestamp of the time the comment was created (on the server). + @apiSuccess {number} modified + UNIX timestamp of the time the comment was last modified (on the server). `null` if the comment was not yet modified. + """ """ @api {post} /new create new @apiGroup Comment - @apiDescription - Creates a new comment. The response will set a cookie on the requestor to enable them to later edit the comment. - @apiUse csrf + @apiDescription + Creates a new comment. The response will set a cookie on the requestor to enable them to later edit the comment. + @apiUse csrf @apiParam {string} uri The uri of the thread to create the comment on. @@ -198,25 +198,25 @@ class API(object): @apiParam {number} [parent] The parent comment’s id iff the new comment is a response to an existing comment. - @apiExample {curl} Create a reply to comment with id 15: - curl 'https://comments.example.com/new?uri=/thread/' -d '{"text": "Stop saying that! *isso*!", "author": "Max Rant", "email": "rant@example.com", "parent": 15}' -H 'Content-Type: application/json' -c cookie.txt + @apiExample {curl} Create a reply to comment with id 15: + curl 'https://comments.example.com/new?uri=/thread/' -d '{"text": "Stop saying that! *isso*!", "author": "Max Rant", "email": "rant@example.com", "parent": 15}' -H 'Content-Type: application/json' -c cookie.txt - @apiUse commentResponse + @apiUse commentResponse - @apiSuccessExample Success after the above request: - { - "website": null, - "author": "Max Rant", - "parent": 15, - "created": 1464940838.254393, - "text": "<p>Stop saying that! <em>isso</em>!</p>", - "dislikes": 0, - "modified": null, - "mode": 1, - "hash": "e644f6ee43c0", - "id": 23, - "likes": 0 - } + @apiSuccessExample Success after the above request: + { + "website": null, + "author": "Max Rant", + "parent": 15, + "created": 1464940838.254393, + "text": "<p>Stop saying that! <em>isso</em>!</p>", + "dislikes": 0, + "modified": null, + "mode": 1, + "hash": "e644f6ee43c0", + "id": 23, + "likes": 0 + } """ @xhr @requires(str, 'uri') @@ -292,32 +292,32 @@ class API(object): return resp """ - @api {get} /id/:id view - @apiGroup Comment + @api {get} /id/:id view + @apiGroup Comment - @apiParam {number} id - The id of the comment to view. - @apiUse plainParam + @apiParam {number} id + The id of the comment to view. + @apiUse plainParam - @apiExample {curl} View the comment with id 4: - curl 'https://comments.example.com/id/4' + @apiExample {curl} View the comment with id 4: + curl 'https://comments.example.com/id/4' - @apiUse commentResponse + @apiUse commentResponse - @apiSuccessExample Example result: - { - "website": null, - "author": null, - "parent": null, - "created": 1464914341.312426, - "text": " <p>I want to use MySQL</p>", - "dislikes": 0, - "modified": null, - "mode": 1, - "id": 4, - "likes": 1 - } - """ + @apiSuccessExample Example result: + { + "website": null, + "author": null, + "parent": null, + "created": 1464914341.312426, + "text": " <p>I want to use MySQL</p>", + "dislikes": 0, + "modified": null, + "mode": 1, + "id": 4, + "likes": 1 + } + """ def view(self, environ, request, id): rv = self.comments.get(id) @@ -332,41 +332,41 @@ class API(object): return JSON(rv, 200) - """ - @api {put} /id/:id edit - @apiGroup Comment + """ + @api {put} /id/:id edit + @apiGroup Comment @apiDescription - Edit an existing comment. Editing a comment is only possible for a short period of time after it was created and only if the requestor has a valid cookie for it. See the [isso server documentation](https://posativ.org/isso/docs/configuration/server) for details. Editing a comment will set a new edit cookie in the response. - @apiUse csrf + Edit an existing comment. Editing a comment is only possible for a short period of time after it was created and only if the requestor has a valid cookie for it. See the [isso server documentation](https://posativ.org/isso/docs/configuration/server) for details. Editing a comment will set a new edit cookie in the response. + @apiUse csrf - @apiParam {number} id - The id of the comment to edit. - @apiParam {string} text - A new (raw) text for the comment. - @apiParam {string} [author] - The modified comment’s author’s name. - @apiParam {string} [webiste] - The modified comment’s author’s website. + @apiParam {number} id + The id of the comment to edit. + @apiParam {string} text + A new (raw) text for the comment. + @apiParam {string} [author] + The modified comment’s author’s name. + @apiParam {string} [webiste] + The modified comment’s author’s website. - @apiExample {curl} Edit comment with id 23: - curl -X PUT 'https://comments.example.com/id/23' -d {"text": "I see your point. However, I still disagree.", "website": "maxrant.important.com"} -H 'Content-Type: application/json' -b cookie.txt + @apiExample {curl} Edit comment with id 23: + curl -X PUT 'https://comments.example.com/id/23' -d {"text": "I see your point. However, I still disagree.", "website": "maxrant.important.com"} -H 'Content-Type: application/json' -b cookie.txt - @apiUse commentResponse + @apiUse commentResponse - @apiSuccessExample Example response: - { - "website": "maxrant.important.com", - "author": "Max Rant", - "parent": 15, - "created": 1464940838.254393, - "text": "<p>I see your point. However, I still disagree.</p>", - "dislikes": 0, - "modified": 1464943439.073961, - "mode": 1, - "id": 23, - "likes": 0 - } - """ + @apiSuccessExample Example response: + { + "website": "maxrant.important.com", + "author": "Max Rant", + "parent": 15, + "created": 1464940838.254393, + "text": "<p>I see your point. However, I still disagree.</p>", + "dislikes": 0, + "modified": 1464943439.073961, + "mode": 1, + "id": 23, + "likes": 0 + } + """ @xhr def edit(self, environ, request, id): @@ -411,21 +411,21 @@ class API(object): resp.headers.add("X-Set-Cookie", cookie("isso-%i" % rv["id"])) return resp - """ - @api {delete} '/id/:id' delete - @apiGroup Comment - @apiDescription - Delte an existing comment. Deleting a comment is only possible for a short period of time after it was created and only if the requestor has a valid cookie for it. See the [isso server documentation](https://posativ.org/isso/docs/configuration/server) for details. + """ + @api {delete} '/id/:id' delete + @apiGroup Comment + @apiDescription + Delte an existing comment. Deleting a comment is only possible for a short period of time after it was created and only if the requestor has a valid cookie for it. See the [isso server documentation](https://posativ.org/isso/docs/configuration/server) for details. - @apiParam {number} id - Id of the comment to delete. + @apiParam {number} id + Id of the comment to delete. - @apiExample {curl} Delete comment with id 14: - curl -X DELETE 'https://comments.example.com/id/14' -b cookie.txt + @apiExample {curl} Delete comment with id 14: + curl -X DELETE 'https://comments.example.com/id/14' -b cookie.txt - @apiSuccessExample Successful deletion returns null: - null - """ + @apiSuccessExample Successful deletion returns null: + null + """ @xhr def delete(self, environ, request, id, key=None): @@ -463,40 +463,40 @@ class API(object): resp.headers.add("X-Set-Cookie", cookie("isso-%i" % id)) return resp - """ - @api {post} /id/:id/:action/key moderate - @apiGroup Comment - @apiDescription - Publish or delete a comment that is in the moderation queue (mode `2`). In order to use this endpoint, the requestor needs a `key` that is usually obtained from an email sent out by isso. + """ + @api {post} /id/:id/:action/key moderate + @apiGroup Comment + @apiDescription + Publish or delete a comment that is in the moderation queue (mode `2`). In order to use this endpoint, the requestor needs a `key` that is usually obtained from an email sent out by isso. - This endpoint can also be used with a `GET` request. In that case, a html page is returned that asks the user whether they are sure to perform the selected action. If they select “yes”, the query is repeated using `POST`. + This endpoint can also be used with a `GET` request. In that case, a html page is returned that asks the user whether they are sure to perform the selected action. If they select “yes”, the query is repeated using `POST`. - @apiParam {number} id - The id of the comment to moderate. - @apiParam {string=activate,delete} action - `activate` to publish the comment (change its mode to `1`). - `delete` to delete the comment - @apiParam {string} key - The moderation key to authenticate the moderation. + @apiParam {number} id + The id of the comment to moderate. + @apiParam {string=activate,delete} action + `activate` to publish the comment (change its mode to `1`). + `delete` to delete the comment + @apiParam {string} key + The moderation key to authenticate the moderation. - @apiExample {curl} delete comment with id 13: - curl -X POST 'https://comments.example.com/id/13/delete/MTM.CjL6Fg.REIdVXa-whJS_x8ojQL4RrXnuF4' + @apiExample {curl} delete comment with id 13: + curl -X POST 'https://comments.example.com/id/13/delete/MTM.CjL6Fg.REIdVXa-whJS_x8ojQL4RrXnuF4' - @apiSuccessExample {html} Using GET: - <!DOCTYPE html> - <html> - <head> - <script> - if (confirm('Delete: Are you sure?')) { - xhr = new XMLHttpRequest; - xhr.open('POST', window.location.href); - xhr.send(null); - } - </script> + @apiSuccessExample {html} Using GET: + <!DOCTYPE html> + <html> + <head> + <script> + if (confirm('Delete: Are you sure?')) { + xhr = new XMLHttpRequest; + xhr.open('POST', window.location.href); + xhr.send(null); + } + </script> - @apiSuccessExample Using POST: - Yo - """ + @apiSuccessExample Using POST: + Yo + """ def moderate(self, environ, request, id, action, key): try: @@ -546,7 +546,7 @@ class API(object): The URI of thread to get the comments from. @apiParam {number} [parent] Return only comments that are children of the comment with the provided ID. - @apiUse plainParam + @apiUse plainParam @apiParam {number} [limit] The maximum number of returned top-level comments. Omit for unlimited results. @apiParam {number} [nested_limit] @@ -555,13 +555,13 @@ class API(object): Includes only comments were added after the provided UNIX timestamp. @apiSuccess {number} total_replies - The number of replies if the `limit` parameter was not set. If `after` is set to `X`, this is the number of comments that were created after `X`. So setting `after` may change this value! + The number of replies if the `limit` parameter was not set. If `after` is set to `X`, this is the number of comments that were created after `X`. So setting `after` may change this value! @apiSuccess {Object[]} replies - The list of comments. Each comment also has the `total_replies`, `replies`, `id` and `hidden_replies` properties to represent nested comments. + The list of comments. Each comment also has the `total_replies`, `replies`, `id` and `hidden_replies` properties to represent nested comments. @apiSuccess {number} id - Id of the comment `replies` is the list of replies of. `null` for the list of toplevel comments. + Id of the comment `replies` is the list of replies of. `null` for the list of toplevel comments. @apiSuccess {number} hidden_replies - The number of comments that were ommited from the results because of the `limit` request parameter. Usually, this will be `total_replies` - `limit`. + The number of comments that were ommited from the results because of the `limit` request parameter. Usually, this will be `total_replies` - `limit`. @apiExample {curl} Get 2 comments with 5 responses: curl 'https://comments.example.com/?uri=/thread/&limit=2&nested_limit=5' @@ -716,60 +716,60 @@ class API(object): return fetched_list - """ - @apiDefine likeResponse - @apiSuccess {number} likes - The (new) number of likes on the comment. - @apiSuccess {number} dislikes - The (new) number of dislikes on the comment. - """ + """ + @apiDefine likeResponse + @apiSuccess {number} likes + The (new) number of likes on the comment. + @apiSuccess {number} dislikes + The (new) number of dislikes on the comment. + """ - """ - @api {post} /id/:id/like like - @apiGroup Comment - @apiDescription - Puts a “like” on a comment. The author of a comment cannot like its own comment. + """ + @api {post} /id/:id/like like + @apiGroup Comment + @apiDescription + Puts a “like” on a comment. The author of a comment cannot like its own comment. - @apiParam {number} id - The id of the comment to like. + @apiParam {number} id + The id of the comment to like. - @apiExample {curl} Like comment with id 23: - curl -X POST 'https://comments.example.com/id/23/like' + @apiExample {curl} Like comment with id 23: + curl -X POST 'https://comments.example.com/id/23/like' - @apiUse likeResponse + @apiUse likeResponse - @apiSuccessExample Example response - { - "likes": 5, - "dislikes": 2 - } - """ + @apiSuccessExample Example response + { + "likes": 5, + "dislikes": 2 + } + """ @xhr def like(self, environ, request, id): nv = self.comments.vote(True, id, utils.anonymize(str(request.remote_addr))) return JSON(nv, 200) - """ - @api {post} /id/:id/dislike dislike - @apiGroup Comment - @apiDescription - Puts a “dislike” on a comment. The author of a comment cannot dislike its own comment. + """ + @api {post} /id/:id/dislike dislike + @apiGroup Comment + @apiDescription + Puts a “dislike” on a comment. The author of a comment cannot dislike its own comment. - @apiParam {number} id - The id of the comment to dislike. + @apiParam {number} id + The id of the comment to dislike. - @apiExample {curl} Dislike comment with id 23: - curl -X POST 'https://comments.example.com/id/23/dislike' + @apiExample {curl} Dislike comment with id 23: + curl -X POST 'https://comments.example.com/id/23/dislike' - @apiUse likeResponse + @apiUse likeResponse - @apiSuccessExample Example response - { - "likes": 4, - "dislikes": 3 - } - """ + @apiSuccessExample Example response + { + "likes": 4, + "dislikes": 3 + } + """ @xhr def dislike(self, environ, request, id): @@ -787,18 +787,18 @@ class API(object): return JSON(rv, 200) - """ - @api {post} /count count comments - @apiGroup Thread - @apiDescription - Counts the number of comments on multiple threads. The requestor provides a list of thread uris. The number of comments on each thread is returned as a list, in the same order as the threads were requested. The counts include comments that are reponses to comments. + """ + @api {post} /count count comments + @apiGroup Thread + @apiDescription + Counts the number of comments on multiple threads. The requestor provides a list of thread uris. The number of comments on each thread is returned as a list, in the same order as the threads were requested. The counts include comments that are reponses to comments. - @apiExample {curl} get the count of 5 threads: - curl 'https://comments.example.com/count' -d '["/blog/firstPost.html", "/blog/controversalPost.html", "/blog/howToCode.html", "/blog/boringPost.html", "/blog/isso.html"] + @apiExample {curl} get the count of 5 threads: + curl 'https://comments.example.com/count' -d '["/blog/firstPost.html", "/blog/controversalPost.html", "/blog/howToCode.html", "/blog/boringPost.html", "/blog/isso.html"] - @apiSuccessExample Counts of 5 threads: - [2, 18, 4, 0, 3] - """ + @apiSuccessExample Counts of 5 threads: + [2, 18, 4, 0, 3] + """ def counts(self, environ, request): data = request.get_json() From 09b69feae91a89f9e56f63ee77812174f7a4c495 Mon Sep 17 00:00:00 2001 From: ivegotasthma Date: Sat, 17 Dec 2016 22:42:07 +0100 Subject: [PATCH 12/78] fix: add missing i18n entry Fixes an indexing error a user gets when he tries to make the language of isso to `bg` --- isso/js/app/i18n.js | 1 + 1 file changed, 1 insertion(+) diff --git a/isso/js/app/i18n.js b/isso/js/app/i18n.js index 98141f6..43a5f52 100644 --- a/isso/js/app/i18n.js +++ b/isso/js/app/i18n.js @@ -55,6 +55,7 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/de", } var catalogue = { + bg: bg, cs: cs, de: de, el: el, From 03b0de2d81f7fec9da98cda8881736fdac244339 Mon Sep 17 00:00:00 2001 From: Alexandre Perrin Date: Fri, 6 Jan 2017 15:01:58 +0100 Subject: [PATCH 13/78] api.rst: JSON and english typos --- docs/docs/extras/api.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/extras/api.rst b/docs/docs/extras/api.rst index 4c9f1d7..348a256 100644 --- a/docs/docs/extras/api.rst +++ b/docs/docs/extras/api.rst @@ -23,11 +23,11 @@ Isso: "mode": 1, "hash": "4505c1eeda98", "author": null, - "website": null + "website": null, "created": 1387321261.572392, "modified": null, "likes": 3, - "dislikes": 0, + "dislikes": 0 } id : @@ -70,7 +70,7 @@ modified : List comments ------------- -List all publicely visible comments for thread `uri`: +List all publicly visible comments for thread `uri`: .. code-block:: text From cd460ef152d63ffe0dbc008b6c3cadb52977a255 Mon Sep 17 00:00:00 2001 From: "Mads R. Havmand" Date: Sat, 7 Jan 2017 19:02:00 +0100 Subject: [PATCH 14/78] Danish translation --- isso/js/app/i18n/da.js | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 isso/js/app/i18n/da.js diff --git a/isso/js/app/i18n/da.js b/isso/js/app/i18n/da.js new file mode 100644 index 0000000..eb64fc4 --- /dev/null +++ b/isso/js/app/i18n/da.js @@ -0,0 +1,30 @@ +define({ + "postbox-text": "Type Comment Here (at least 3 chars)", + "postbox-author": "Name (optional)", + "postbox-email": "E-mail (optional)", + "postbox-website": "Website (optional)", + "postbox-submit": "Submit", + + "num-comments": "One Comment\n{{ n }} Comments", + "no-comments": "Ingen kommentarer endnu", + + "comment-reply": "Svar", + "comment-edit": "Rediger", + "comment-save": "Gem", + "comment-delete": "Fjern", + "comment-confirm": "Bekræft", + "comment-close": "Luk", + "comment-cancel": "Annuller", + "comment-deleted": "Kommentar slettet.", + "comment-queued": "Kommentar i kø for moderation.", + "comment-anonymous": "Anonym", + "comment-hidden": "{{ n }} Skjult", + + "date-now": "lige nu", + "date-minute": "et minut siden\n{{ n }} minutter siden", + "date-hour": "en time siden\n{{ n }} timer siden", + "date-day": "Igår\n{{ n }} dage siden", + "date-week": "sidste uge\n{{ n }} uger siden", + "date-month": "sidste måned\n{{ n }} måneder siden", + "date-year": "sidste år\n{{ n }} år siden" +}); From 45a481daeb6226b3cd2e9fd2cb1a636c6601ee41 Mon Sep 17 00:00:00 2001 From: Pelle Nilsson Date: Sun, 19 Mar 2017 18:42:03 +0100 Subject: [PATCH 15/78] Fix require-email setting, #308 --- isso/js/app/isso.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/isso/js/app/isso.js b/isso/js/app/isso.js index a46f43a..1875351 100644 --- a/isso/js/app/isso.js +++ b/isso/js/app/isso.js @@ -35,8 +35,8 @@ define(["app/dom", "app/utils", "app/config", "app/api", "app/jade", "app/i18n", // email is not optional if this config parameter is set if (config["require-email"]) { - $("[name='email']", el).placeholder = - $("[name='email']", el).placeholder.replace(/ \(.*\)/, ""); + $("[name='email']", el).setAttribute("placeholder", + $("[name='email']", el).getAttribute("placeholder").replace(/ \(.*\)/, "")); } // submit form, initialize optional fields with `null` and reset form. From 88aafa60e5f067317e26e1a99e87088fbfdbf27a Mon Sep 17 00:00:00 2001 From: Graham Inggs Date: Mon, 27 Mar 2017 17:44:02 +0200 Subject: [PATCH 16/78] add SOURCELINK_SUFFIX for compatibility with Sphinx 1.5 With Sphinx 1.5, this is needed by searchtools.js to display the source snippets (see sphinx-doc/sphinx#2454). With earlier Sphinx versions, this is a no-op because the undefined variable will evaluate to an empty string. --- docs/_isso/layout.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/_isso/layout.html b/docs/_isso/layout.html index 2462c30..c0f9476 100644 --- a/docs/_isso/layout.html +++ b/docs/_isso/layout.html @@ -10,7 +10,8 @@ VERSION: '{{ release|e }}', COLLAPSE_INDEX: false, FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}', - HAS_SOURCE: {{ has_source|lower }} + HAS_SOURCE: {{ has_source|lower }}, + SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}' }; {%- for scriptfile in script_files %} From 4b7a32afaceb3a835f04c463611d1fa572fb6ea3 Mon Sep 17 00:00:00 2001 From: Shengbin Meng Date: Tue, 28 Mar 2017 21:35:51 +0800 Subject: [PATCH 17/78] Make the Chinese translations actually work Before this change, the user must configure `lang="zh"` to use the CN version (neither `lang="zh_CN"` nor `lang="zh_TW"` works). --- isso/js/app/i18n.js | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/isso/js/app/i18n.js b/isso/js/app/i18n.js index 98141f6..1ec5ca2 100644 --- a/isso/js/app/i18n.js +++ b/isso/js/app/i18n.js @@ -2,8 +2,8 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/de", "app/i18n/en", "app/i18n/fa", "app/i18n/fi", "app/i18n/fr", "app/i18n/hr", "app/i18n/ru", "app/i18n/it", "app/i18n/eo", "app/i18n/sv", "app/i18n/nl", "app/i18n/el_GR", "app/i18n/es", - "app/i18n/vi", "app/i18n/zh_CN"], - function(config, bg, cs, de, en, fa, fi, fr, hr, ru, it, eo, sv, nl, el, es, vi, zh) { + "app/i18n/vi", "app/i18n/zh_CN", "app/i18n/zh_TW"], + function(config, bg, cs, de, en, fa, fi, fr, hr, ru, it, eo, sv, nl, el, es, vi, zh_CN, zh_TW) { "use strict"; @@ -23,7 +23,8 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/de", case "sv": case "nl": case "vi": - case "zh": + case "zh_CN": + case "zh_TW": return function(msgs, n) { return msgs[n === 1 ? 0 : 1]; }; @@ -70,7 +71,8 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/de", sv: sv, nl: nl, vi: vi, - zh: zh + zh_CN: zh_CN, + zh_TW: zh_TW }; var plural = pluralforms(lang); From a9500e29dd5cd9c7bcb0459267e6b92e9f0ec602 Mon Sep 17 00:00:00 2001 From: Shengbin Meng Date: Tue, 28 Mar 2017 21:55:54 +0800 Subject: [PATCH 18/78] Add language "zh" as alias of "zh_CN" --- isso/js/app/i18n.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/isso/js/app/i18n.js b/isso/js/app/i18n.js index 1ec5ca2..461cbdb 100644 --- a/isso/js/app/i18n.js +++ b/isso/js/app/i18n.js @@ -2,8 +2,8 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/de", "app/i18n/en", "app/i18n/fa", "app/i18n/fi", "app/i18n/fr", "app/i18n/hr", "app/i18n/ru", "app/i18n/it", "app/i18n/eo", "app/i18n/sv", "app/i18n/nl", "app/i18n/el_GR", "app/i18n/es", - "app/i18n/vi", "app/i18n/zh_CN", "app/i18n/zh_TW"], - function(config, bg, cs, de, en, fa, fi, fr, hr, ru, it, eo, sv, nl, el, es, vi, zh_CN, zh_TW) { + "app/i18n/vi", "app/i18n/zh_CN", "app/i18n/zh_CN", "app/i18n/zh_TW"], + function(config, bg, cs, de, en, fa, fi, fr, hr, ru, it, eo, sv, nl, el, es, vi, zh, zh_CN, zh_TW) { "use strict"; @@ -23,6 +23,7 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/de", case "sv": case "nl": case "vi": + case "zh": case "zh_CN": case "zh_TW": return function(msgs, n) { @@ -71,6 +72,7 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/de", sv: sv, nl: nl, vi: vi, + zh: zh_CN, zh_CN: zh_CN, zh_TW: zh_TW }; From 0a93c866ff7baa42de72f03cd827e0607b888b9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Sun, 5 Jun 2016 01:10:08 +0200 Subject: [PATCH 19/78] Add a basic admin interface (Fix issue #10) Add a basic admin interface (Fix issue #10) wip again still wip fix login page --- isso/__init__.py | 1 + isso/css/admin.css | 115 ++++++++++++++++++++++++++++ isso/db/comments.py | 59 ++++++++++++++- isso/img/isso.svg | 2 + isso/templates/admin.html | 154 ++++++++++++++++++++++++++++++++++++++ isso/templates/login.html | 30 ++++++++ isso/utils/__init__.py | 18 ++++- isso/views/comments.py | 47 +++++++++++- setup.py | 2 +- share/isso-dev.conf | 1 + share/isso.conf | 5 +- 11 files changed, 427 insertions(+), 7 deletions(-) create mode 100644 isso/css/admin.css create mode 100644 isso/img/isso.svg create mode 100644 isso/templates/admin.html create mode 100644 isso/templates/login.html diff --git a/isso/__init__.py b/isso/__init__.py index 7795c4f..f842882 100644 --- a/isso/__init__.py +++ b/isso/__init__.py @@ -186,6 +186,7 @@ def make_app(conf=None, threading=True, multiprocessing=False, uwsgi=False): wrapper.append(partial(SharedDataMiddleware, exports={ '/js': join(dirname(__file__), 'js/'), '/css': join(dirname(__file__), 'css/'), + '/img': join(dirname(__file__), 'img/'), '/demo': join(dirname(__file__), 'demo/') })) diff --git a/isso/css/admin.css b/isso/css/admin.css new file mode 100644 index 0000000..6f747b9 --- /dev/null +++ b/isso/css/admin.css @@ -0,0 +1,115 @@ +* { + box-sizing: border-box; + margin: 0; + padding: 0; +} +h1, h2, h3, h4, h5, h6 { + font-style: normal; + font-weight: normal; +} +input { + text-align: center; +} +.header::before, .header::after { + content: " "; + display: table; +} +.header::after { + clear: both; +} +.header::before, .header::after { + content: " "; + display: table; +} +.header { + margin-left: auto; + margin-right: auto; + max-width: 68em; + padding-bottom: 1em; + padding-top: 1em; +} +.header header { + display: block; + float: left; + font-weight: normal; + margin-right: 16.0363%; + width: 41.9818%; +} +.header header .logo { + float: left; + max-height: 60px; + padding-right: 12px; +} +.header header h1 { + font-size: 1.55em; + margin-bottom: 0.3em; +} +.header header h2 { + font-size: 1.05em; +} +.header a, .header a:visited { + color: #4d4c4c; + text-decoration: none; +} +.outer { + background-color: #eeeeee; + box-shadow: 0 0 0.5em #c0c0c0 inset; +} +.outer .filters::before, .outer .filters::after { + content: " "; + display: table; +} +.outer .filters::after { + clear: both; +} +.outer .filters::before, .outer .filters::after { + content: " "; + display: table; +} +.outer .filters { + margin-left: auto; + margin-right: auto; + max-width: 68em; + padding: 1em; +} + +a { + text-decoration: none; + color: #4d4c4c; +} +.label { + background-color: #ddd; + border: 1px solid #ccc; + border-radius: 2px; + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.1); + cursor: pointer; + line-height: 1.4em; + outline: 0 none; + padding: calc(0.6em - 1px); +} +.active { + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.6) inset; +} +.label-valid { + background-color: #cfc; + border-color: #cfc; +} +.label-pending { + background-color: #ffc; + border-color: #ffc; +} +.mode { + float: left; +} +.pagination { + float: right; +} +.note .label { + margin: 9px; + padding: 3px; +} +#login { + margin-top: 40px; + text-align: center; + width: 100%; +} diff --git a/isso/db/comments.py b/isso/db/comments.py index 496a4e5..69790ac 100644 --- a/isso/db/comments.py +++ b/isso/db/comments.py @@ -19,8 +19,11 @@ class Comments: The tuple (tid, id) is unique and thus primary key. """ - fields = ['tid', 'id', 'parent', 'created', 'modified', 'mode', 'remote_addr', - 'text', 'author', 'email', 'website', 'likes', 'dislikes', 'voters'] + fields = ['tid', 'id', 'parent', 'created', 'modified', + 'mode', # status of the comment 1 = valid, 2 = pending, + # 4 = soft-deleted (cannot hard delete because of replies) + 'remote_addr', 'text', 'author', 'email', 'website', + 'likes', 'dislikes', 'voters'] def __init__(self, db): @@ -97,6 +100,58 @@ class Comments: return None + def count_modes(self): + """ + Return comment mode counts for admin + """ + comment_count = self.db.execute( + 'SELECT mode, COUNT(comments.id) FROM comments ' + 'GROUP BY comments.mode').fetchall() + return dict(comment_count) + + def fetchall(self, mode=5, after=0, parent='any', order_by='id', + limit=100, page=0): + """ + Return comments for admin with :param:`mode`. + """ + fields_comments = ['tid', 'id', 'parent', 'created', 'modified', + 'mode', 'remote_addr', 'text', 'author', + 'email', 'website', 'likes', 'dislikes'] + fields_threads = ['uri', 'title'] + sql_comments_fields = ', '.join(['comments.' + f + for f in fields_comments]) + sql_threads_fields = ', '.join(['threads.' + f + for f in fields_threads]) + sql = ['SELECT ' + sql_comments_fields + ', ' + \ + sql_threads_fields + ' ' + 'FROM comments INNER JOIN threads ' + 'ON comments.tid=threads.id ' + 'WHERE comments.mode = ? '] + sql_args = [mode] + + if parent != 'any': + if parent is None: + sql.append('AND comments.parent IS NULL') + else: + sql.append('AND comments.parent=?') + sql_args.append(parent) + + # custom sanitization + if order_by not in ['id', 'created', 'modified', 'likes', 'dislikes']: + order_by = 'id' + sql.append('ORDER BY ') + sql.append('comments.' + order_by) + sql.append(' DESC') + + if limit: + sql.append('LIMIT ?,?') + sql_args.append(page * limit) + sql_args.append(limit) + + rv = self.db.execute(sql, sql_args).fetchall() + for item in rv: + yield dict(zip(fields_comments + fields_threads, item)) + def fetch(self, uri, mode=5, after=0, parent='any', order_by='id', limit=None): """ Return comments for :param:`uri` with :param:`mode`. diff --git a/isso/img/isso.svg b/isso/img/isso.svg new file mode 100644 index 0000000..1aba2dd --- /dev/null +++ b/isso/img/isso.svg @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/isso/templates/admin.html b/isso/templates/admin.html new file mode 100644 index 0000000..f3d9a53 --- /dev/null +++ b/isso/templates/admin.html @@ -0,0 +1,154 @@ + + + Isso admin + + + + + +
+
+
+ +
+ +

Isso

+

Administration

+ +
+
+
+
+
+
+ + + Valid ({{counts.get(1, 0)}}) + + + + + Pending ({{counts.get(2, 0)}}) + + + + + Staled ({{counts.get(4, 0)}}) + + +
+ +
+
+
+ {% for comment in comments %} +
+ {% if conf.avatar %} +
+ svg(data-hash='#{{comment.hash}}') +
+ {% endif %} +
+
+ {% if comment.author %} + {{comment.author}} + {% else %} + Anonymous + {% endif %} + {% if comment.website %} + ({{comment.website}}) + {% endif %} + • + + + {% if comment.mode == 1 %} + Valid + {% elif comment.mode == 2 %} + Pending + {% elif comment.mode == 4 %} + Staled + {% endif %} + +
+
+ {% if comment.mode == 4 %} + HIDDEN. Original text:
+ {% endif %} + {{comment.text}} +
+
+ {% if conf.votes and comment.likes - comment.dislikes != 0 %} + {{comment.likes - comment.dislikes}} + {% endif %} + + {% if comment.mode != 4 %} + + Delete + + {% endif %} + {% if comment.mode == 2 %} + Validate + {% endif %} +
+
+
+ {% endfor %} +
+
+ + diff --git a/isso/templates/login.html b/isso/templates/login.html new file mode 100644 index 0000000..a9aa888 --- /dev/null +++ b/isso/templates/login.html @@ -0,0 +1,30 @@ + + + Isso admin + + + + +
+
+
+ +
+ +

Isso

+

Administration

+ +
+
+
+
+
+ Administration secured by password: +
+ +
+
+
+
+ + diff --git a/isso/utils/__init__.py b/isso/utils/__init__.py index a7cafd5..7536041 100644 --- a/isso/utils/__init__.py +++ b/isso/utils/__init__.py @@ -5,9 +5,12 @@ from __future__ import division, unicode_literals import pkg_resources werkzeug = pkg_resources.get_distribution("werkzeug") -import json import hashlib +import json +import os +from datetime import datetime +from jinja2 import Environment, FileSystemLoader from werkzeug.wrappers import Response from werkzeug.exceptions import BadRequest @@ -109,6 +112,19 @@ class JSONRequest(Request): raise BadRequest('Unable to read JSON request') +def render_template(template_name, **context): + template_path = os.path.join(os.path.dirname(__file__), + '..', 'templates') + jinja_env = Environment(loader=FileSystemLoader(template_path), + autoescape=True) + def datetimeformat(value): + return datetime.fromtimestamp(value).strftime('%H:%M / %d-%m-%Y') + + jinja_env.filters['datetimeformat'] = datetimeformat + t = jinja_env.get_template(template_name) + return Response(t.render(context), mimetype='text/html') + + class JSONResponse(Response): def __init__(self, obj, *args, **kwargs): diff --git a/isso/views/comments.py b/isso/views/comments.py index d328305..68c228f 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -7,6 +7,7 @@ import cgi import time import functools +from datetime import datetime, timedelta from itsdangerous import SignatureExpired, BadSignature from werkzeug.http import dump_cookie @@ -15,11 +16,13 @@ from werkzeug.utils import redirect from werkzeug.routing import Rule from werkzeug.wrappers import Response from werkzeug.exceptions import BadRequest, Forbidden, NotFound +from werkzeug.contrib.securecookie import SecureCookie from isso.compat import text_type as str from isso import utils, local -from isso.utils import http, parse, JSONResponse as JSON +from isso.utils import (http, parse, JSONResponse as JSON, + render_template) from isso.views import requires from isso.utils.hash import sha1 @@ -90,7 +93,9 @@ class API(object): ('like', ('POST', '/id//like')), ('dislike', ('POST', '/id//dislike')), ('demo', ('GET', '/demo')), - ('preview', ('POST', '/preview')) + ('preview', ('POST', '/preview')), + ('login', ('POST', '/login')), + ('admin', ('GET', '/admin')) ] def __init__(self, isso, hasher): @@ -490,3 +495,41 @@ class API(object): def demo(self, env, req): return redirect(get_current_url(env) + '/index.html') + + def login(self, env, req): + data = req.form + password = self.isso.conf.get("general", "admin_password") + if data['password'] and data['password'] == password: + response = redirect(get_current_url(env, host_only=True) + '/admin') + cookie = functools.partial(dump_cookie, + value=self.isso.sign({"logged": True}), + expires=datetime.now() + timedelta(1)) + response.headers.add("Set-Cookie", cookie("admin-session")) + response.headers.add("X-Set-Cookie", cookie("isso-admin-session")) + return response + else: + return render_template('login.html') + + def admin(self, env, req): + try: + data = self.isso.unsign(req.cookies.get('admin-session', ''), + max_age=60 * 60 * 24) + except BadSignature: + return render_template('login.html') + if not data or not data['logged']: + return render_template('login.html') + page_size = 100 + page = req.args.get('page', 0) + mode = req.args.get('mode', 2) + comments = self.comments.fetchall(mode=mode, page=page, + limit=page_size) + comments_enriched = [] + for comment in list(comments): + comment['hash'] = self.isso.sign(comment['id']) + comments_enriched.append(comment) + comment_mode_count = self.comments.count_modes() + max_page = int(sum(comment_mode_count.values()) / 100) + return render_template('admin.html', comments=comments_enriched, + page=int(page), mode=int(mode), + conf=self.conf, max_page=max_page, + counts=comment_mode_count) diff --git a/setup.py b/setup.py index e54c110..b2c7482 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ import sys from setuptools import setup, find_packages -requires = ['itsdangerous', 'misaka>=1.0,<2.0', 'html5lib==0.9999999'] +requires = ['itsdangerous', 'misaka>=1.0,<2.0', 'html5lib==0.9999999', 'Jinja2'] if (3, 0) <= sys.version_info < (3, 3): raise SystemExit("Python 3.0, 3.1 and 3.2 are not supported") diff --git a/share/isso-dev.conf b/share/isso-dev.conf index ce87ab3..970c1b0 100644 --- a/share/isso-dev.conf +++ b/share/isso-dev.conf @@ -10,6 +10,7 @@ host = http://isso-dev.local/ max-age = 15m notify = stdout log-file = /var/log/isso.log +admin_password = strong_default_password_for_isso_admin [moderation] enabled = false diff --git a/share/isso.conf b/share/isso.conf index 7c275ac..5dcf987 100644 --- a/share/isso.conf +++ b/share/isso.conf @@ -43,9 +43,12 @@ max-age = 15m # moderated) and deletion links. notify = stdout -# Log console messages to file instead of standard out. +# Log console messages to file instead of standard output. log-file = +# Admin access password +admin_password = please_choose_a_strong_password + [moderation] # enable comment moderation queue. This option only affects new comments. From 7a79746f73ee928ea80e28a4657e8c5a6762920d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Sat, 16 Jul 2016 00:05:33 +0200 Subject: [PATCH 20/78] add: show author email --- isso/templates/admin.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/isso/templates/admin.html b/isso/templates/admin.html index f3d9a53..c32ff1e 100644 --- a/isso/templates/admin.html +++ b/isso/templates/admin.html @@ -108,6 +108,9 @@ function delete_com(com_id, hash) { {% else %} Anonymous {% endif %} + {% if comment.email %} + + {% endif %} {% if comment.website %} ({{comment.website}}) {% endif %} From 1516f56cbda9616cba2f6b8116c990574247d688 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Sat, 16 Jul 2016 00:09:23 +0200 Subject: [PATCH 21/78] fix: cursor pointer on links delete/validate --- isso/css/admin.css | 3 +++ 1 file changed, 3 insertions(+) diff --git a/isso/css/admin.css b/isso/css/admin.css index 6f747b9..d6a8f74 100644 --- a/isso/css/admin.css +++ b/isso/css/admin.css @@ -113,3 +113,6 @@ a { text-align: center; width: 100%; } +.isso-comment-footer a { + cursor: pointer; +} From 0b6a0e4d5fc17be9280c80eef5f38c68c809ea5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Sat, 16 Jul 2016 00:53:52 +0200 Subject: [PATCH 22/78] add: group by thread --- isso/css/admin.css | 7 +++++++ isso/db/comments.py | 4 ++-- isso/templates/admin.html | 13 +++++++++++++ isso/views/comments.py | 7 +++++-- 4 files changed, 27 insertions(+), 4 deletions(-) diff --git a/isso/css/admin.css b/isso/css/admin.css index d6a8f74..5a434fc 100644 --- a/isso/css/admin.css +++ b/isso/css/admin.css @@ -116,3 +116,10 @@ a { .isso-comment-footer a { cursor: pointer; } +.thread-title { + margin-left: 3em; +} +.group { + float: left; + margin-left: 2em; +} diff --git a/isso/db/comments.py b/isso/db/comments.py index 69790ac..62cfad2 100644 --- a/isso/db/comments.py +++ b/isso/db/comments.py @@ -137,10 +137,10 @@ class Comments: sql_args.append(parent) # custom sanitization - if order_by not in ['id', 'created', 'modified', 'likes', 'dislikes']: + if order_by not in ['id', 'created', 'modified', 'likes', 'dislikes', 'tid']: order_by = 'id' sql.append('ORDER BY ') - sql.append('comments.' + order_by) + sql.append('comments.' + order_by + ", comments.created") sql.append(' DESC') if limit: diff --git a/isso/templates/admin.html b/isso/templates/admin.html index c32ff1e..9d10816 100644 --- a/isso/templates/admin.html +++ b/isso/templates/admin.html @@ -77,6 +77,9 @@ function delete_com(com_id, hash) { +
+ Group by thread: +
+ {% set thread_id = "no_id" %} {% for comment in comments %} + {% if order_by == "tid" %} + {% if thread_id != comment.tid %} + {% set thread_id = comment.tid %} +

{{comment.title}}

+ {% endif %} + {% endif %}
{% if conf.avatar %}
@@ -103,6 +113,9 @@ function delete_com(com_id, hash) { {% endif %}
+ {% if order_by != "tid" %} + Thread: {{comment.title}}
+ {% endif %} {% if comment.author %} {{comment.author}} {% else %} diff --git a/isso/views/comments.py b/isso/views/comments.py index 68c228f..df1eebe 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -520,9 +520,11 @@ class API(object): return render_template('login.html') page_size = 100 page = req.args.get('page', 0) + order_by = req.args.get('order_by', "id") mode = req.args.get('mode', 2) comments = self.comments.fetchall(mode=mode, page=page, - limit=page_size) + limit=page_size, + order_by=order_by) comments_enriched = [] for comment in list(comments): comment['hash'] = self.isso.sign(comment['id']) @@ -532,4 +534,5 @@ class API(object): return render_template('admin.html', comments=comments_enriched, page=int(page), mode=int(mode), conf=self.conf, max_page=max_page, - counts=comment_mode_count) + counts=comment_mode_count, + order_by=order_by) From 3212bf762fc8fa152fd3323b0afaed103f68d728 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Thu, 27 Oct 2016 23:18:37 +0200 Subject: [PATCH 23/78] fix 500 error on pagination --- isso/views/comments.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/isso/views/comments.py b/isso/views/comments.py index df1eebe..7dfd423 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -519,9 +519,9 @@ class API(object): if not data or not data['logged']: return render_template('login.html') page_size = 100 - page = req.args.get('page', 0) + page = int(req.args.get('page', 0)) order_by = req.args.get('order_by', "id") - mode = req.args.get('mode', 2) + mode = int(req.args.get('mode', 2)) comments = self.comments.fetchall(mode=mode, page=page, limit=page_size, order_by=order_by) From e3fddf4ae8e7de83323f4b535c7cd586b430efed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Sun, 13 Nov 2016 23:20:47 +0100 Subject: [PATCH 24/78] add: orders in administration --- isso/db/comments.py | 16 +++++++++++----- isso/templates/admin.html | 22 +++++++++++++++++++--- isso/views/comments.py | 8 +++++--- 3 files changed, 35 insertions(+), 11 deletions(-) diff --git a/isso/db/comments.py b/isso/db/comments.py index 62cfad2..a66c248 100644 --- a/isso/db/comments.py +++ b/isso/db/comments.py @@ -110,7 +110,7 @@ class Comments: return dict(comment_count) def fetchall(self, mode=5, after=0, parent='any', order_by='id', - limit=100, page=0): + limit=100, page=0, asc=1): """ Return comments for admin with :param:`mode`. """ @@ -138,10 +138,16 @@ class Comments: # custom sanitization if order_by not in ['id', 'created', 'modified', 'likes', 'dislikes', 'tid']: - order_by = 'id' - sql.append('ORDER BY ') - sql.append('comments.' + order_by + ", comments.created") - sql.append(' DESC') + sql.append('ORDER BY ') + sql.append("comments.created") + if not asc: + sql.append(' DESC') + else: + sql.append('ORDER BY ') + sql.append('comments.' + order_by) + if not asc: + sql.append(' DESC') + sql.append(", comments.created") if limit: sql.append('LIMIT ?,?') diff --git a/isso/templates/admin.html b/isso/templates/admin.html index 9d10816..376aa59 100644 --- a/isso/templates/admin.html +++ b/isso/templates/admin.html @@ -61,17 +61,17 @@ function delete_com(com_id, hash) {
- + Valid ({{counts.get(1, 0)}}) - + Pending ({{counts.get(2, 0)}}) - + Staled ({{counts.get(4, 0)}}) @@ -93,8 +93,24 @@ function delete_com(com_id, hash) { » {% endif %} + / {{ max_page }}
+
+ Order: + {% for order in ['id', 'created', 'modified', 'likes', 'dislikes'] %} + + + {{ order }} + {% if order == order_by %} + {% if asc %} ↑ {% else %} ↓ {% endif %} + {% else %} + ↓ + {% endif %} + + + {% endfor %} +
{% set thread_id = "no_id" %} diff --git a/isso/views/comments.py b/isso/views/comments.py index 7dfd423..9621d7d 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -520,11 +520,13 @@ class API(object): return render_template('login.html') page_size = 100 page = int(req.args.get('page', 0)) - order_by = req.args.get('order_by', "id") + order_by = req.args.get('order_by', None) + asc = int(req.args.get('asc', 1)) mode = int(req.args.get('mode', 2)) comments = self.comments.fetchall(mode=mode, page=page, limit=page_size, - order_by=order_by) + order_by=order_by, + asc=asc) comments_enriched = [] for comment in list(comments): comment['hash'] = self.isso.sign(comment['id']) @@ -535,4 +537,4 @@ class API(object): page=int(page), mode=int(mode), conf=self.conf, max_page=max_page, counts=comment_mode_count, - order_by=order_by) + order_by=order_by, asc=asc) From 2adb779fefa8f0aae10abc7e0da9ecb761088eab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Tue, 6 Dec 2016 23:03:27 +0100 Subject: [PATCH 25/78] add: edit author/email/website/message --- isso/css/admin.css | 9 +++++ isso/templates/admin.html | 79 ++++++++++++++++++++++++++++++++++++--- isso/views/comments.py | 17 ++++++--- 3 files changed, 94 insertions(+), 11 deletions(-) diff --git a/isso/css/admin.css b/isso/css/admin.css index 5a434fc..c440528 100644 --- a/isso/css/admin.css +++ b/isso/css/admin.css @@ -123,3 +123,12 @@ a { float: left; margin-left: 2em; } +.editable { + border: 1px solid #aaa; + border-radius: 5px; + margin: 10px; + padding: 5px; +} +.hidden { + display: none; +} diff --git a/isso/templates/admin.html b/isso/templates/admin.html index 376aa59..12ac60c 100644 --- a/isso/templates/admin.html +++ b/isso/templates/admin.html @@ -39,12 +39,72 @@ function moderate(com_id, hash, action) { fade(document.getElementById("isso-" + com_id)); }}); } +function edit(com_id, hash, author, email, website, comment) { + ajax({method: "POST", + url: "/id/" + com_id + "/edit/" + hash, + data: JSON.stringify({text: comment, + author: author, + email: email, + website: website}), + success: function(ret){ + console.log("edit successed: ", ret);// TODO display some pretty stuff & update msg + }, + error: function(ret){ + console.log("Error: ", ret); // TODO flash msg/notif + }}); +} function validate_com(com_id, hash) { moderate(com_id, hash, "validate"); } function delete_com(com_id, hash) { moderate(com_id, hash, "delete"); } +function unset_editable(elt_id) { + var elt = document.getElementById(elt_id); + if (elt) { + elt.contentEditable = false; + elt.classList.remove("editable"); + } +} +function set_editable(elt_id) { + var elt = document.getElementById(elt_id); + if (elt) { + elt.contentEditable = true; + elt.classList.add("editable"); + } +} +function start_edit(com_id) { + var editable_elements = ['isso-author-' + com_id, + 'isso-email-' + com_id, + 'isso-website-' + com_id, + 'isso-text-' + com_id]; + for (var idx=0; idx <= editable_elements.length; idx++) { + set_editable(editable_elements[idx]); + } + document.getElementById('edit-btn-' + com_id).classList.toggle('hidden'); + document.getElementById('stop-edit-btn-' + com_id).classList.toggle('hidden'); + document.getElementById('send-edit-btn-' + com_id).classList.toggle('hidden'); +} +function stop_edit(com_id) { + var editable_elements = ['isso-author-' + com_id, + 'isso-email-' + com_id, + 'isso-website-' + com_id, + 'isso-text-' + com_id]; + for (var idx=0; idx <= editable_elements.length; idx++) { + unset_editable(editable_elements[idx]); + } + document.getElementById('edit-btn-' + com_id).classList.toggle('hidden'); + document.getElementById('stop-edit-btn-' + com_id).classList.toggle('hidden'); + document.getElementById('send-edit-btn-' + com_id).classList.toggle('hidden'); +} +function send_edit(com_id, hash) { + var author = document.getElementById('isso-author-' + com_id).textContent; + var email = document.getElementById('isso-email-' + com_id).textContent; + var website = document.getElementById('isso-website-' + com_id).textContent; + var comment = document.getElementById('isso-text-' + com_id).textContent; + edit(com_id, hash, author, email, website, comment); + stop_edit(com_id); +}
@@ -130,18 +190,22 @@ function delete_com(com_id, hash) {
{% if order_by != "tid" %} - Thread: {{comment.title}}
+
Thread: {{comment.title}}

{% endif %} {% if comment.author %} - {{comment.author}} + {{comment.author}} {% else %} - Anonymous + Anonymous {% endif %} {% if comment.email %} - + ({{comment.email}} ) + {% else %} + {% endif %} {% if comment.website %} - ({{comment.website}}) + ({{comment.website}} open) + {% else %} + {% endif %} • @@ -159,13 +223,16 @@ function delete_com(com_id, hash) { {% if comment.mode == 4 %} HIDDEN. Original text:
{% endif %} - {{comment.text}} +
{{comment.text}}
{% if conf.votes and comment.likes - comment.dislikes != 0 %} {{comment.likes - comment.dislikes}} {% endif %} + Edit + + {% if comment.mode != 4 %} diff --git a/isso/views/comments.py b/isso/views/comments.py index 9621d7d..f927044 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -88,8 +88,8 @@ class API(object): ('view', ('GET', '/id/')), ('edit', ('PUT', '/id/')), ('delete', ('DELETE', '/id/')), - ('moderate',('GET', '/id///')), - ('moderate',('POST', '/id///')), + ('moderate',('GET', '/id///')), + ('moderate',('POST', '/id///')), ('like', ('POST', '/id//like')), ('dislike', ('POST', '/id//dislike')), ('demo', ('GET', '/demo')), @@ -318,7 +318,6 @@ class API(object): return resp def moderate(self, environ, request, id, action, key): - try: id = self.isso.unsign(key, max_age=2**32) except (BadSignature, SignatureExpired): @@ -348,13 +347,21 @@ class API(object): with self.isso.lock: self.comments.activate(id) self.signal("comments.activate", id) + return Response("Yo", 200) + elif action == "edit": + data = request.get_json() + with self.isso.lock: + rv = self.comments.update(id, data) + for key in set(rv.keys()) - API.FIELDS: + rv.pop(key) + self.signal("comments.edit", rv) + return JSON(rv, 200) else: with self.isso.lock: self.comments.delete(id) self.cache.delete('hash', (item['email'] or item['remote_addr']).encode('utf-8')) self.signal("comments.delete", id) - - return Response("Yo", 200) + return Response("Yo", 200) @requires(str, 'uri') def fetch(self, environ, request, uri): From 84381f4f482155052cc838fb57681fe7798897d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Wed, 7 Dec 2016 00:22:34 +0100 Subject: [PATCH 26/78] add: link to the thread --- isso/templates/admin.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/isso/templates/admin.html b/isso/templates/admin.html index 12ac60c..d11ac84 100644 --- a/isso/templates/admin.html +++ b/isso/templates/admin.html @@ -178,7 +178,7 @@ function send_edit(com_id, hash) { {% if order_by == "tid" %} {% if thread_id != comment.tid %} {% set thread_id = comment.tid %} -

{{comment.title}}

+

{{comment.title}} ({{comment.uri}})

{% endif %} {% endif %}
@@ -190,7 +190,7 @@ function send_edit(com_id, hash) {
{% if order_by != "tid" %} -
Thread: {{comment.title}}

+
Thread: {{comment.title}} ({{comment.uri}})

{% endif %} {% if comment.author %} {{comment.author}} From cc8e61533f509ff9ab419e7a37287edbf0bad9d9 Mon Sep 17 00:00:00 2001 From: Jeremy Tan Date: Wed, 28 Dec 2016 13:31:35 +0800 Subject: [PATCH 27/78] Add templates to MANIFEST.in --- MANIFEST.in | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/MANIFEST.in b/MANIFEST.in index c4edbe1..4c63d8e 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -9,3 +9,9 @@ include isso/js/count.min.js include isso/js/count.dev.js include isso/defaults.ini + +include isso/templates/admin.html +include isso/templates/login.html +include isso/css/admin.css +include isso/css/isso.css +include isso/img/isso.svg From b14b1b51a9e46628f94bf4cba3a06ea4d449b994 Mon Sep 17 00:00:00 2001 From: Jeremy Tan Date: Wed, 28 Dec 2016 13:48:47 +0800 Subject: [PATCH 28/78] validate->activate --- isso/templates/admin.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/isso/templates/admin.html b/isso/templates/admin.html index d11ac84..484a949 100644 --- a/isso/templates/admin.html +++ b/isso/templates/admin.html @@ -54,7 +54,7 @@ function edit(com_id, hash, author, email, website, comment) { }}); } function validate_com(com_id, hash) { - moderate(com_id, hash, "validate"); + moderate(com_id, hash, "activate"); } function delete_com(com_id, hash) { moderate(com_id, hash, "delete"); From fd0147e8abedb889055675b83e0a832e673a51fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=B0=B7=E6=9C=88=E8=BD=A9?= Date: Sun, 11 Jun 2017 00:05:34 +0800 Subject: [PATCH 29/78] Fixed typo in isso.conf --- share/isso.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/share/isso.conf b/share/isso.conf index 7c275ac..9154cd5 100644 --- a/share/isso.conf +++ b/share/isso.conf @@ -10,7 +10,7 @@ dbpath = /tmp/comments.db # required to dispatch multiple websites, not used otherwise. name = -# Your website(s). If Isso is unable to connect to at least on site, you'll +# Your website(s). If Isso is unable to connect to at least one site, you'll # get a warning during startup and comments are most likely non-functional. # # You'll need at least one host/website to run Isso. This is due to security From 7bfe36bfdfa1362b779341dcdfe015ceaf608a2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sat, 15 Jul 2017 12:34:05 +0000 Subject: [PATCH 30/78] Specify Python versions to use in travis. This should address python2.6 being missing in the default environment. Fixes #332 --- .travis.yml | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/.travis.yml b/.travis.yml index c27f79f..8d00e01 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,15 +1,20 @@ language: python -python: 2.7 -env: - - TOX_ENV=py26 - - TOX_ENV=py27 - - TOX_ENV=py33 - - TOX_ENV=py34 - - TOX_ENV=squeeze - - TOX_ENV=wheezy matrix: allow_failures: - env: TOX_ENV=squeeze + include: + - python: 2.6 + env: TOX_ENV=py26 + - python: 2.7 + env: TOX_ENV=py27 + - python: 3.3 + env: TOX_ENV=py33 + - python: 3.4 + env: TOX_ENV=py34 + - python: 2.6 + env: TOX_ENV=squeeze + - python: 2.7 + env: TOX_ENV=wheezy install: - pip install -U pip - pip install tox From 384673ebdbacd8a4df2cd6dd39da26c7ab9753f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sat, 15 Jul 2017 14:04:16 +0000 Subject: [PATCH 31/78] Run travis tests with python 3.5 & python 3.6. --- .travis.yml | 4 ++++ tox.ini | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 8d00e01..887f235 100644 --- a/.travis.yml +++ b/.travis.yml @@ -11,6 +11,10 @@ matrix: env: TOX_ENV=py33 - python: 3.4 env: TOX_ENV=py34 + - python: 3.5 + env: TOX_ENV=py35 + - python: 3.6 + env: TOX_ENV=py36 - python: 2.6 env: TOX_ENV=squeeze - python: 2.7 diff --git a/tox.ini b/tox.ini index 06d29de..5b8b90a 100755 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py27,py33,py34,py35 +envlist = py27,py33,py34,py35,py36 [testenv] deps = From 26f0e06e786701b6fc61d387c8ab0c4d14401dc2 Mon Sep 17 00:00:00 2001 From: Philip Monk Date: Sat, 15 Jul 2017 18:20:02 -0700 Subject: [PATCH 32/78] display only complete units of time fixes #283 --- isso/js/app/utils.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/isso/js/app/utils.js b/isso/js/app/utils.js index f971770..d8f3970 100644 --- a/isso/js/app/utils.js +++ b/isso/js/app/utils.js @@ -20,8 +20,8 @@ define(["app/i18n"], function(i18n) { secs = 0; } - var mins = Math.ceil(secs / 60), hours = Math.ceil(mins / 60), - days = Math.ceil(hours / 24); + var mins = Math.floor(secs / 60), hours = Math.floor(mins / 60), + days = Math.floor(hours / 24); return secs <= 45 && i18n.translate("date-now") || secs <= 90 && i18n.pluralize("date-minute", 1) || @@ -31,11 +31,11 @@ define(["app/i18n"], function(i18n) { hours <= 36 && i18n.pluralize("date-day", 1) || days <= 5 && i18n.pluralize("date-day", days) || days <= 8 && i18n.pluralize("date-week", 1) || - days <= 21 && i18n.pluralize("date-week", Math.ceil(days / 7)) || + days <= 21 && i18n.pluralize("date-week", Math.floor(days / 7)) || days <= 45 && i18n.pluralize("date-month", 1) || - days <= 345 && i18n.pluralize("date-month", Math.ceil(days / 30)) || + days <= 345 && i18n.pluralize("date-month", Math.floor(days / 30)) || days <= 547 && i18n.pluralize("date-year", 1) || - i18n.pluralize("date-year", Math.ceil(days / 365.25)); + i18n.pluralize("date-year", Math.floor(days / 365.25)); }; var HTMLEntity = { From afbcb6413e916cdbdf8f80986ce404005590369f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Mon, 17 Jul 2017 20:49:56 +0000 Subject: [PATCH 33/78] Add da entry to i18n.js. --- isso/js/app/i18n.js | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/isso/js/app/i18n.js b/isso/js/app/i18n.js index 43a5f52..90923ac 100644 --- a/isso/js/app/i18n.js +++ b/isso/js/app/i18n.js @@ -1,9 +1,9 @@ -define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/de", - "app/i18n/en", "app/i18n/fa", "app/i18n/fi", "app/i18n/fr", - "app/i18n/hr", "app/i18n/ru", "app/i18n/it", "app/i18n/eo", - "app/i18n/sv", "app/i18n/nl", "app/i18n/el_GR", "app/i18n/es", - "app/i18n/vi", "app/i18n/zh_CN"], - function(config, bg, cs, de, en, fa, fi, fr, hr, ru, it, eo, sv, nl, el, es, vi, zh) { +define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/da", + "app/i18n/de", "app/i18n/en", "app/i18n/fa", "app/i18n/fi", + "app/i18n/fr", "app/i18n/hr", "app/i18n/ru", "app/i18n/it", + "app/i18n/eo", "app/i18n/sv", "app/i18n/nl", "app/i18n/el_GR", + "app/i18n/es", "app/i18n/vi", "app/i18n/zh_CN"], + function(config, bg, cs, da, de, en, fa, fi, fr, hr, ru, it, eo, sv, nl, el, es, vi, zh) { "use strict"; @@ -11,6 +11,7 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/de", switch (lang) { case "bg": case "cs": + case "da": case "de": case "el": case "en": @@ -57,6 +58,7 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/de", var catalogue = { bg: bg, cs: cs, + da: da, de: de, el: el, en: en, From 59b345b648f79de74aab261dc1946e5b4a41d7a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sun, 16 Jul 2017 18:35:02 +0000 Subject: [PATCH 34/78] Run pyflakes on travis. --- .travis.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.travis.yml b/.travis.yml index 8d00e01..6d7a9cb 100644 --- a/.travis.yml +++ b/.travis.yml @@ -18,9 +18,11 @@ matrix: install: - pip install -U pip - pip install tox + - pip install pyflakes - sudo rm -rf /dev/shm && sudo ln -s /run/shm /dev/shm script: - tox -e $TOX_ENV + - python -m pyflakes.__main__ $(git ls-files | grep -E "^isso/.+.py$") notifications: irc: channels: From 39debdb0110fd87c15a3acc59b21035cbc791497 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sat, 29 Jul 2017 13:06:40 +0000 Subject: [PATCH 35/78] Fix flakes errors. --- isso/__init__.py | 2 -- isso/utils/http.py | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/isso/__init__.py b/isso/__init__.py index 7795c4f..0a62290 100644 --- a/isso/__init__.py +++ b/isso/__init__.py @@ -220,8 +220,6 @@ def main(): imprt.add_argument("--empty-id", dest="empty_id", action="store_true", help="workaround for weird Disqus XML exports, #135") - serve = subparser.add_parser("run", help="run server") - args = parser.parse_args() conf = config.load(join(dist.location, dist.project_name, "defaults.ini"), args.conf) diff --git a/isso/utils/http.py b/isso/utils/http.py index 48b968b..4bbf443 100644 --- a/isso/utils/http.py +++ b/isso/utils/http.py @@ -44,7 +44,7 @@ class curl(object): self.con = http(host, port, timeout=self.timeout) try: self.con.request(self.method, self.path, headers=self.headers) - except (httplib.HTTPException, socket.error) as e: + except (httplib.HTTPException, socket.error): return None try: From 280b0d925a34e83f6c9fcd75ad9c6213085d75f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sat, 29 Jul 2017 13:09:48 +0000 Subject: [PATCH 36/78] Skip compat module when running flakes checks. Python2-specific code fails on Python3 flakes and vice versa. --- .travis.yml | 2 +- Makefile | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 6d7a9cb..c857936 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,7 +22,7 @@ install: - sudo rm -rf /dev/shm && sudo ln -s /run/shm /dev/shm script: - tox -e $TOX_ENV - - python -m pyflakes.__main__ $(git ls-files | grep -E "^isso/.+.py$") + - python -m pyflakes.__main__ $(git ls-files | grep -E "^isso/.+.py$" | grep -v "^isso/compat.py") notifications: irc: channels: diff --git a/Makefile b/Makefile index ff2a55e..2a44cb3 100644 --- a/Makefile +++ b/Makefile @@ -34,9 +34,9 @@ init: check: @echo "Python 2.x" - -@python2 -m pyflakes $(ISSO_PY_SRC) + @python2 -m pyflakes $(filter-out isso/compat.py,$(ISSO_PY_SRC)) @echo "Python 3.x" - -@python3 -m pyflakes $(ISSO_PY_SRC) + @python3 -m pyflakes $(filter-out isso/compat.py,$(ISSO_PY_SRC)) isso/js/%.min.js: $(ISSO_JS_SRC) $(ISSO_CSS) $(RJS) -o isso/js/build.$*.js out=$@ From dc883e672a3fd62c1402898d26540a2f3683c8e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sat, 29 Jul 2017 15:21:33 +0000 Subject: [PATCH 37/78] Fix short title underline. --- docs/docs/extras/deployment.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/extras/deployment.rst b/docs/docs/extras/deployment.rst index 0fe190d..2aa53c6 100644 --- a/docs/docs/extras/deployment.rst +++ b/docs/docs/extras/deployment.rst @@ -213,7 +213,7 @@ Next, copy'n'paste to `/var/www/isso.fcgi` (or whatever location you prefer): WSGIServer(application).run() `Openshift `__ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ With `Isso Openshift Deployment Kit`_, Isso can be installed on Open Shift with just one click. Make sure you already have installed ``rhc`` (`instructions`_) and completed the setup. From e3a8d0b93d71c42873a078d6691fb10c22118c95 Mon Sep 17 00:00:00 2001 From: Martin Zimmermann Date: Sun, 30 Jul 2017 22:22:52 +0200 Subject: [PATCH 38/78] fix db test with incorrect SQL id, that happened work with pre-3.6 dicts before --- isso/tests/test_db.py | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/isso/tests/test_db.py b/isso/tests/test_db.py index 3bfd498..54b9122 100644 --- a/isso/tests/test_db.py +++ b/isso/tests/test_db.py @@ -65,6 +65,7 @@ class TestDBMigration(unittest.TestCase): "supersecretkey") def test_limit_nested_comments(self): + """Transform previously A -> B -> C comment nesting to A -> B, A -> C""" tree = { 1: None, @@ -97,7 +98,7 @@ class TestDBMigration(unittest.TestCase): con.execute("INSERT INTO threads (uri, title) VALUES (?, ?)", ("/", "Test")) for (id, parent) in iteritems(tree): con.execute("INSERT INTO comments (" - " tid, parent, created)" + " id, parent, created)" "VALUEs (?, ?, ?)", (id, parent, id)) conf = config.new({ @@ -108,15 +109,15 @@ class TestDBMigration(unittest.TestCase): }) SQLite3(self.path, conf) - flattened = [ - (1, None), - (2, None), - (3, 2), - (4, 2), - (5, 2), - (6, None), - (7, 2) - ] + flattened = list(iteritems({ + 1: None, + 2: None, + 3: 2, + 4: 2, + 5: 2, + 6: None, + 7: 2 + })) with sqlite3.connect(self.path) as con: rv = con.execute("SELECT id, parent FROM comments ORDER BY created").fetchall() From 4c03a43c28e6edb051f95e93e3c8976754e69cf3 Mon Sep 17 00:00:00 2001 From: Martin Zimmermann Date: Sun, 30 Jul 2017 22:34:38 +0200 Subject: [PATCH 39/78] remove data-isso-id from documentation, it usually doesn't work as expected --- docs/docs/configuration/client.rst | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/docs/docs/configuration/client.rst b/docs/docs/configuration/client.rst index ea7487a..14f0c86 100644 --- a/docs/docs/configuration/client.rst +++ b/docs/docs/configuration/client.rst @@ -124,14 +124,3 @@ For example, the value `"-5,5"` will cause each `isso-comment` to be given one o - `isso-vote-level-2` for scores of `5` and greater These classes can then be used to customize the appearance of comments (eg. put a star on popular comments) - -data-isso-id ------------- - -Set a custom thread id, defaults to current URI. This attribute needs -to be used with the data-title attribute in order to work. -If you use a comment counter, add this attribute to the link tag, too. - -.. code-block:: html - -
From c3933bd9fdd87d3d6de628797759ad253bc199f8 Mon Sep 17 00:00:00 2001 From: Martin Zimmermann Date: Sun, 30 Jul 2017 23:09:23 +0200 Subject: [PATCH 40/78] fix sphinx build --- docs/conf.py | 2 +- docs/docs/install.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1db8715..0b85a07 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -171,7 +171,7 @@ html_static_path = ['_static'] # Additional templates that should be rendered to pages, maps page names to # template names. -html_additional_pages = {"index": "docs/index.html"} +html_additional_pages = {"index": "index.html"} # If false, no module index is generated. html_domain_indices = False diff --git a/docs/docs/install.rst b/docs/docs/install.rst index 6f537fe..688b050 100644 --- a/docs/docs/install.rst +++ b/docs/docs/install.rst @@ -10,7 +10,7 @@ Debian/Ubuntu, Gentoo, Archlinux or Fedora, you can use :local: :depth: 1 - .. _install-interludium: +.. _install-interludium: Interludium: Python is not PHP ------------------------------ From 43623f349bde3df92ecad8eebcd3dadae3739236 Mon Sep 17 00:00:00 2001 From: Matthias Adler Date: Sun, 6 Aug 2017 17:06:20 +0200 Subject: [PATCH 41/78] Fix: Truncate key-length when generating identicons Hex-digits with character count above 17 cannot be safely converted to an Integer, see [MAX_SAFE_INTEGER](https://medium.com/the-node-js-collection/javascripts-number-type-8d59199db1b6#53cd). Therefore, when long keys (e.g. 32 characters) are passed into `generateIdenticon()`, and the modulus of 2^18 is performed, the result is 0 all the time. This means, the identicon will render as an empty svg image. Here is a proof-of-concept (run in any modern browser): ```js const key = '841b625dcf75413ff3ed5137a81ff1c3'; const int = parseInt(key, 16); const hash = int % Math.pow(2, 18); // throws, due to floating point conversion / integer overflow console.assert(258499 === hash, "Modulus for 'hash' should be != 0"); const int2 = parseInt(key.substr(-16), 16); const hash2 = int2 % Math.pow(2, 18); // works as expected console.assert(258048 === hash2, "Modulus 'hash2' should be != 0"); ``` Truncating the passed in argument to a maximum of 16 characters solves the issue. As a sidenote, the same code in Python will work correctly: ```python key = '841b625dcf75413ff3ed5137a81ff1c3' int = int(key, 16) hash = int % pow(2, 18) assert 258499 == hash ``` --- isso/js/app/lib/identicons.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/isso/js/app/lib/identicons.js b/isso/js/app/lib/identicons.js index 1dcb567..f865c92 100644 --- a/isso/js/app/lib/identicons.js +++ b/isso/js/app/lib/identicons.js @@ -47,7 +47,7 @@ define(["app/lib/promise", "app/config"], function(Q, config) { } Q.when(key, function(key) { - var hash = pad((parseInt(key, 16) % Math.pow(2, 18)).toString(2), 18), + var hash = pad((parseInt(key.substr(-16), 16) % Math.pow(2, 18)).toString(2), 18), index = 0; svg.setAttribute("data-hash", key); From 9b0e3d29fef3d1fe720de634d906c94a46098e9c Mon Sep 17 00:00:00 2001 From: Martin Zimmermann Date: Thu, 17 Aug 2017 10:36:58 +0200 Subject: [PATCH 42/78] revert incorrect removal of the internal server startup CLI --- isso/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/isso/__init__.py b/isso/__init__.py index 0a62290..b2e5688 100644 --- a/isso/__init__.py +++ b/isso/__init__.py @@ -220,6 +220,9 @@ def main(): imprt.add_argument("--empty-id", dest="empty_id", action="store_true", help="workaround for weird Disqus XML exports, #135") + # run Isso as stand-alone server + serve = subparser.add_parser("run", help="run server") + args = parser.parse_args() conf = config.load(join(dist.location, dist.project_name, "defaults.ini"), args.conf) From 6a60f831b04fb6a45a4edf5b5519b714fe95f5b5 Mon Sep 17 00:00:00 2001 From: Martin Zimmermann Date: Thu, 17 Aug 2017 10:42:36 +0200 Subject: [PATCH 43/78] remove unused variable --- isso/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/isso/__init__.py b/isso/__init__.py index b2e5688..6d42c53 100644 --- a/isso/__init__.py +++ b/isso/__init__.py @@ -221,7 +221,7 @@ def main(): help="workaround for weird Disqus XML exports, #135") # run Isso as stand-alone server - serve = subparser.add_parser("run", help="run server") + subparser.add_parser("run", help="run server") args = parser.parse_args() conf = config.load(join(dist.location, dist.project_name, "defaults.ini"), args.conf) From 02eaffea21e4a0ccd04be88aedb86c9f4439e2fd Mon Sep 17 00:00:00 2001 From: Peter Guthy Date: Tue, 31 Oct 2017 13:47:49 +0100 Subject: [PATCH 44/78] Added hungarian translation --- isso/js/app/i18n.js | 4 +++- isso/js/app/i18n/hu.js | 27 +++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 isso/js/app/i18n/hu.js diff --git a/isso/js/app/i18n.js b/isso/js/app/i18n.js index 6cc2a88..ce6cbde 100644 --- a/isso/js/app/i18n.js +++ b/isso/js/app/i18n.js @@ -2,7 +2,7 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/da", "app/i18n/de", "app/i18n/en", "app/i18n/fa", "app/i18n/fi", "app/i18n/fr", "app/i18n/hr", "app/i18n/ru", "app/i18n/it", "app/i18n/eo", "app/i18n/sv", "app/i18n/nl", "app/i18n/el_GR", - "app/i18n/es", "app/i18n/vi", "app/i18n/zh_CN", "app/i18n/zh_CN", "app/i18n/zh_TW"], + "app/i18n/es", "app/i18n/vi", "app/i18n/zh_CN", "app/i18n/zh_CN", "app/i18n/zh_TW", "app/i18n/hu"], function(config, bg, cs, da, de, en, fa, fi, fr, hr, ru, it, eo, sv, nl, el, es, vi, zh, zh_CN, zh_TW) { "use strict"; @@ -20,6 +20,7 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/da", case "fa": case "fi": case "hr": + case "hu": case "it": case "sv": case "nl": @@ -71,6 +72,7 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/da", fr: fr, it: it, hr: hr, + hu: hu, ru: ru, sv: sv, nl: nl, diff --git a/isso/js/app/i18n/hu.js b/isso/js/app/i18n/hu.js new file mode 100644 index 0000000..e0bf7d6 --- /dev/null +++ b/isso/js/app/i18n/hu.js @@ -0,0 +1,27 @@ +define({ + "postbox-text": "Hozzászólást ide írd be (legalább 3 betűt)", + "postbox-author": "Név (nem kötelező)", + "postbox-email": "Email (nem kötelező)", + "postbox-website": "Website (nem kötelező)", + "postbox-submit": "Elküld", + "num-comments": "Egy hozzászólás\n{{ n }} hozzászólás", + "no-comments": "Eddig nincs hozzászólás", + "comment-reply": "Válasz", + "comment-edit": "Szerekesztés", + "comment-save": "Mentés", + "comment-delete": "Törlés", + "comment-confirm": "Megerősít", + "comment-close": "Bezár", + "comment-cancel": "Törlés", + "comment-deleted": "Hozzászólás törölve.", + "comment-queued": "A hozzászólást előbb ellenőrizzük.", + "comment-anonymous": "Névtelen", + "comment-hidden": "{{ n }} rejtve", + "date-now": "pillanatokkal ezelőtt", + "date-minute": "egy perce\n{{ n }} perce", + "date-hour": "egy órája\n{{ n }} órája", + "date-day": "tegnap\n{{ n }} napja", + "date-week": "múlt héten\n{{ n }} hete", + "date-month": "múlt hónapban\n{{ n }} hónapja", + "date-year": "tavaly\n{{ n }} éve" +}); From 21983a61b6a87ff8fcb17f2e1248e8c6019960da Mon Sep 17 00:00:00 2001 From: Max Chadwick Date: Mon, 20 Nov 2017 22:15:09 -0500 Subject: [PATCH 45/78] Darken placeholder text Previously color contrast was insufficient per WCAG AA --- isso/css/isso.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/isso/css/isso.css b/isso/css/isso.css index 456740c..47cf675 100644 --- a/isso/css/isso.css +++ b/isso/css/isso.css @@ -20,7 +20,7 @@ outline: 0; } #isso-thread .textarea.placeholder { - color: #AAA; + color: #757575; } .isso-comment { From 9ab23c09080daf8aaf5df7be51445b8420ed5fcc Mon Sep 17 00:00:00 2001 From: Max Chadwick Date: Tue, 21 Nov 2017 20:50:14 -0500 Subject: [PATCH 46/78] Fix hungarian translation --- isso/js/app/i18n.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/isso/js/app/i18n.js b/isso/js/app/i18n.js index ce6cbde..e9c3dfe 100644 --- a/isso/js/app/i18n.js +++ b/isso/js/app/i18n.js @@ -3,7 +3,7 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/da", "app/i18n/fr", "app/i18n/hr", "app/i18n/ru", "app/i18n/it", "app/i18n/eo", "app/i18n/sv", "app/i18n/nl", "app/i18n/el_GR", "app/i18n/es", "app/i18n/vi", "app/i18n/zh_CN", "app/i18n/zh_CN", "app/i18n/zh_TW", "app/i18n/hu"], - function(config, bg, cs, da, de, en, fa, fi, fr, hr, ru, it, eo, sv, nl, el, es, vi, zh, zh_CN, zh_TW) { + function(config, bg, cs, da, de, en, fa, fi, fr, hr, hu, ru, it, eo, sv, nl, el, es, vi, zh, zh_CN, zh_TW) { "use strict"; From 3efe0c86d9c00d6d8765ebc00334559eb274d912 Mon Sep 17 00:00:00 2001 From: Max Chadwick Date: Tue, 21 Nov 2017 21:34:06 -0500 Subject: [PATCH 47/78] Put hu into correct alphabetical order --- isso/js/app/i18n.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/isso/js/app/i18n.js b/isso/js/app/i18n.js index e9c3dfe..9f44b5b 100644 --- a/isso/js/app/i18n.js +++ b/isso/js/app/i18n.js @@ -1,8 +1,8 @@ define(["app/config", "app/i18n/bg", "app/i18n/cs", "app/i18n/da", "app/i18n/de", "app/i18n/en", "app/i18n/fa", "app/i18n/fi", - "app/i18n/fr", "app/i18n/hr", "app/i18n/ru", "app/i18n/it", + "app/i18n/fr", "app/i18n/hr", "app/i18n/hu", "app/i18n/ru", "app/i18n/it", "app/i18n/eo", "app/i18n/sv", "app/i18n/nl", "app/i18n/el_GR", - "app/i18n/es", "app/i18n/vi", "app/i18n/zh_CN", "app/i18n/zh_CN", "app/i18n/zh_TW", "app/i18n/hu"], + "app/i18n/es", "app/i18n/vi", "app/i18n/zh_CN", "app/i18n/zh_CN", "app/i18n/zh_TW"], function(config, bg, cs, da, de, en, fa, fi, fr, hr, hu, ru, it, eo, sv, nl, el, es, vi, zh, zh_CN, zh_TW) { "use strict"; From 2b56963f318ade1750367a03c69d1bc304aa3db9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Sat, 20 Jan 2018 22:56:18 +0100 Subject: [PATCH 48/78] fix pyflakes error, make travis happy --- isso/views/comments.py | 1 - 1 file changed, 1 deletion(-) diff --git a/isso/views/comments.py b/isso/views/comments.py index 226cbcd..c87595b 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -16,7 +16,6 @@ from werkzeug.utils import redirect from werkzeug.routing import Rule from werkzeug.wrappers import Response from werkzeug.exceptions import BadRequest, Forbidden, NotFound -from werkzeug.contrib.securecookie import SecureCookie from isso.compat import text_type as str From b569b19a7f5216e6e948ff6b840985911900c4c0 Mon Sep 17 00:00:00 2001 From: cclauss Date: Wed, 24 Jan 2018 20:26:44 +0100 Subject: [PATCH 49/78] compat.py passes pyflakes test Drop support for Python 2.6 and 3.3 --- .travis.yml | 16 +++++----------- docs/docs/install.rst | 4 ++-- isso/compat.py | 34 ++++++++++++++-------------------- isso/config.py | 7 +------ isso/tests/test_comments.py | 6 +----- isso/tests/test_config.py | 6 +----- isso/tests/test_cors.py | 5 +---- isso/tests/test_db.py | 6 +----- isso/tests/test_guard.py | 6 +----- isso/tests/test_html.py | 6 +----- isso/tests/test_migration.py | 6 +----- isso/tests/test_utils.py | 6 +----- isso/tests/test_utils_hash.py | 7 ++----- isso/tests/test_vote.py | 6 +----- isso/tests/test_wsgi.py | 6 +----- setup.py | 19 ++++++++++--------- tox.ini | 16 +--------------- 17 files changed, 45 insertions(+), 117 deletions(-) diff --git a/.travis.yml b/.travis.yml index f4246bb..0302d5b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,32 +1,26 @@ language: python matrix: - allow_failures: - - env: TOX_ENV=squeeze include: - - python: 2.6 - env: TOX_ENV=py26 - python: 2.7 env: TOX_ENV=py27 - - python: 3.3 - env: TOX_ENV=py33 - python: 3.4 env: TOX_ENV=py34 - python: 3.5 env: TOX_ENV=py35 - python: 3.6 env: TOX_ENV=py36 - - python: 2.6 - env: TOX_ENV=squeeze - python: 2.7 env: TOX_ENV=wheezy install: - pip install -U pip - - pip install tox - - pip install pyflakes + - pip install flake8 tox - sudo rm -rf /dev/shm && sudo ln -s /run/shm /dev/shm script: - tox -e $TOX_ENV - - python -m pyflakes.__main__ $(git ls-files | grep -E "^isso/.+.py$" | grep -v "^isso/compat.py") + # stop the build if there are Python syntax errors or undefined names + - flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics notifications: irc: channels: diff --git a/docs/docs/install.rst b/docs/docs/install.rst index 688b050..8ce4f8c 100644 --- a/docs/docs/install.rst +++ b/docs/docs/install.rst @@ -79,7 +79,7 @@ Install from PyPi Requirements ^^^^^^^^^^^^ -- Python 2.6, 2.7 or 3.3+ (+ devel headers) +- Python 2.7 or 3.4+ (+ devel headers) - SQLite 3.3.8 or later - a working C compiler @@ -157,7 +157,7 @@ Install from Source If you want to hack on Isso or track down issues, there's an alternate way to set up Isso. It requires a lot more dependencies and effort: -- Python 2.6, 2.7 or 3.3+ (+ devel headers) +- Python 2.7 or 3.4+ (+ devel headers) - Virtualenv - SQLite 3.3.8 or later - a working C compiler diff --git a/isso/compat.py b/isso/compat.py index e12f268..e38ecc5 100644 --- a/isso/compat.py +++ b/isso/compat.py @@ -1,28 +1,22 @@ # -*- encoding: utf-8 -*- -import sys -PY2K = sys.version_info[0] == 2 - -if not PY2K: - - map, zip, filter = map, zip, filter - from functools import reduce - - iteritems = lambda dikt: iter(dikt.items()) - +try: + text_type = unicode # Python 2 + string_types = (str, unicode) + PY2K = True +except NameError: # Python 3 + PY2K = False text_type = str string_types = (str, ) +if not PY2K: buffer = memoryview + filter, map, zip = filter, map, zip + iteritems = lambda dikt: iter(dikt.items()) # noqa: E731 + from functools import reduce else: - - from itertools import imap, izip, ifilter - map, zip, filter = imap, izip, ifilter - reduce = reduce - - iteritems = lambda dikt: dikt.iteritems() - - text_type = unicode - string_types = (str, unicode) - buffer = buffer + from itertools import ifilter, imap, izip + filter, map, zip = ifilter, imap, izip + iteritems = lambda dikt: dikt.iteritems() # noqa: E731 + reduce = reduce diff --git a/isso/config.py b/isso/config.py index 234a0fe..c2a05ce 100644 --- a/isso/config.py +++ b/isso/config.py @@ -17,11 +17,6 @@ from isso.compat import text_type as str logger = logging.getLogger("isso") -# Python 2.6 compatibility -def total_seconds(td): - return (td.microseconds + (td.seconds + td.days * 24 * 3600) * 10**6) / 10**6 - - def timedelta(string): """ Parse :param string: into :class:`datetime.timedelta`, you can use any @@ -101,7 +96,7 @@ class IssoParser(ConfigParser): try: return int(delta.total_seconds()) except AttributeError: - return int(total_seconds(delta)) + return int(delta.total_seconds()) def getlist(self, section, key): return list(map(str.strip, self.get(section, key).split(','))) diff --git a/isso/tests/test_comments.py b/isso/tests/test_comments.py index 1e2bdf1..e7bc011 100644 --- a/isso/tests/test_comments.py +++ b/isso/tests/test_comments.py @@ -5,11 +5,7 @@ from __future__ import unicode_literals import os import json import tempfile - -try: - import unittest2 as unittest -except ImportError: - import unittest +import unittest try: from urllib.parse import urlencode diff --git a/isso/tests/test_config.py b/isso/tests/test_config.py index dc40e65..2fd1b4d 100644 --- a/isso/tests/test_config.py +++ b/isso/tests/test_config.py @@ -1,10 +1,6 @@ # -*- encoding: utf-8 -*- -try: - import unittest2 as unittest -except ImportError: - import unittest - +import unittest import io from isso import config diff --git a/isso/tests/test_cors.py b/isso/tests/test_cors.py index 4cfc20d..415ea51 100644 --- a/isso/tests/test_cors.py +++ b/isso/tests/test_cors.py @@ -1,10 +1,7 @@ from __future__ import unicode_literals -try: - import unittest2 as unittest -except ImportError: - import unittest +import unittest from werkzeug.test import Client from werkzeug.wrappers import Response diff --git a/isso/tests/test_db.py b/isso/tests/test_db.py index 54b9122..74e0831 100644 --- a/isso/tests/test_db.py +++ b/isso/tests/test_db.py @@ -1,10 +1,6 @@ # -*- encoding: utf-8 -*- -try: - import unittest2 as unittest -except ImportError: - import unittest - +import unittest import os import sqlite3 import tempfile diff --git a/isso/tests/test_guard.py b/isso/tests/test_guard.py index fca932c..a9ae365 100644 --- a/isso/tests/test_guard.py +++ b/isso/tests/test_guard.py @@ -2,11 +2,7 @@ from __future__ import unicode_literals -try: - import unittest2 as unittest -except ImportError: - import unittest - +import unittest import os import json import tempfile diff --git a/isso/tests/test_html.py b/isso/tests/test_html.py index b1be6dc..362e239 100644 --- a/isso/tests/test_html.py +++ b/isso/tests/test_html.py @@ -1,10 +1,6 @@ # -*- encoding: utf-8 -*- -try: - import unittest2 as unittest -except ImportError: - import unittest - +import unittest import textwrap from isso import config diff --git a/isso/tests/test_migration.py b/isso/tests/test_migration.py index 7b73d75..8a876ee 100644 --- a/isso/tests/test_migration.py +++ b/isso/tests/test_migration.py @@ -2,11 +2,7 @@ from __future__ import unicode_literals -try: - import unittest2 as unittest -except ImportError: - import unittest - +import unittest import tempfile from os.path import join, dirname diff --git a/isso/tests/test_utils.py b/isso/tests/test_utils.py index 88668f4..0504c15 100644 --- a/isso/tests/test_utils.py +++ b/isso/tests/test_utils.py @@ -1,10 +1,6 @@ # -*- encoding: utf-8 -*- -try: - import unittest2 as unittest -except ImportError: - import unittest - +import unittest from isso import utils from isso.utils import parse diff --git a/isso/tests/test_utils_hash.py b/isso/tests/test_utils_hash.py index 626d75e..18a790e 100644 --- a/isso/tests/test_utils_hash.py +++ b/isso/tests/test_utils_hash.py @@ -2,10 +2,7 @@ from __future__ import unicode_literals -try: - import unittest2 as unittest -except ImportError: - import unittest +import unittest from isso import config @@ -70,4 +67,4 @@ class TestCreate(unittest.TestCase): pbkdf2 = _new("pbkdf2:16:2:md5") self.assertIsInstance(pbkdf2, PBKDF2) self.assertEqual(pbkdf2.dklen, 2) - self.assertEqual(pbkdf2.func, "md5") \ No newline at end of file + self.assertEqual(pbkdf2.func, "md5") diff --git a/isso/tests/test_vote.py b/isso/tests/test_vote.py index f6817a0..4045ccb 100644 --- a/isso/tests/test_vote.py +++ b/isso/tests/test_vote.py @@ -4,11 +4,7 @@ from __future__ import unicode_literals import os import json import tempfile - -try: - import unittest2 as unittest -except ImportError: - import unittest +import unittest from werkzeug.wrappers import Response diff --git a/isso/tests/test_wsgi.py b/isso/tests/test_wsgi.py index 17e0b12..254b51e 100644 --- a/isso/tests/test_wsgi.py +++ b/isso/tests/test_wsgi.py @@ -1,10 +1,6 @@ # -*- encoding: utf-8 -*- -try: - import unittest2 as unittest -except ImportError: - import unittest - +import unittest from isso import wsgi diff --git a/setup.py b/setup.py index b2c7482..ef866fe 100644 --- a/setup.py +++ b/setup.py @@ -5,10 +5,13 @@ import sys from setuptools import setup, find_packages -requires = ['itsdangerous', 'misaka>=1.0,<2.0', 'html5lib==0.9999999', 'Jinja2'] +requires = ['html5lib==0.9999999', 'itsdangerous', 'Jinja2', + 'misaka>=1.0,<2.0', 'werkzeug>=0.9'] -if (3, 0) <= sys.version_info < (3, 3): - raise SystemExit("Python 3.0, 3.1 and 3.2 are not supported") +if sys.version_info < (2, 7): + raise SystemExit("Python 2 versions < 2.7 are not supported.") +elif (3, 0) <= sys.version_info < (3, 4): + raise SystemExit("Python 3 versions < 3.4 are not supported.") setup( name='isso', @@ -27,16 +30,14 @@ setup( "Topic :: Internet :: WWW/HTTP :: HTTP Servers", "Topic :: Internet :: WWW/HTTP :: WSGI :: Application", "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", - "Programming Language :: Python :: 3.3", - "Programming Language :: Python :: 3.4" + "Programming Language :: Python :: 3.4", + "Programming Language :: Python :: 3.5", + "Programming Language :: Python :: 3.6" ], install_requires=requires, extras_require={ - ':python_version=="2.6"': ['argparse', 'ordereddict'], - ':python_version=="2.6" or python_version=="2.7"': ['ipaddr>=2.1', 'configparser', 'werkzeug>=0.8'], - ':python_version!="2.6" and python_version!="2.7"': ['werkzeug>=0.9'] + ':python_version=="2.7"': ['ipaddr>=2.1', 'configparser'] }, entry_points={ 'console_scripts': diff --git a/tox.ini b/tox.ini index 5b8b90a..bb55662 100755 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py27,py33,py34,py35,py36 +envlist = py27,py34,py35,py36 [testenv] deps = @@ -8,14 +8,6 @@ deps = commands = python setup.py nosetests -[testenv:py26] -deps = - argparse - unittest2 - ordereddict - configparser - {[testenv]deps} - [testenv:py27] deps = configparser @@ -30,12 +22,6 @@ deps= passlib==1.5.3 werkzeug==0.8.3 -[testenv:squeeze] -basepython=python2.6 -deps= - {[testenv:py26]deps} - {[testenv:debian]deps} - [testenv:wheezy] basepython=python2.7 deps = From 6ccebce04150d378b298a27ed2ec58f7dde96f0f Mon Sep 17 00:00:00 2001 From: Martin Schenck Date: Wed, 11 Oct 2017 13:25:17 +0200 Subject: [PATCH 50/78] Improved German translation --- isso/js/app/i18n/de.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/isso/js/app/i18n/de.js b/isso/js/app/i18n/de.js index 5ac0610..f7def26 100644 --- a/isso/js/app/i18n/de.js +++ b/isso/js/app/i18n/de.js @@ -1,11 +1,11 @@ define({ - "postbox-text": "Kommentar hier eintippen (mindestens 3 Zeichen)", + "postbox-text": "Kommentar hier eingeben (mindestens 3 Zeichen)", "postbox-author": "Name (optional)", "postbox-email": "Email (optional)", "postbox-website": "Website (optional)", "postbox-submit": "Abschicken", "num-comments": "1 Kommentar\n{{ n }} Kommentare", - "no-comments": "Keine Kommentare bis jetzt", + "no-comments": "Bisher keine Kommentare", "comment-reply": "Antworten", "comment-edit": "Bearbeiten", "comment-save": "Speichern", @@ -17,7 +17,7 @@ define({ "comment-queued": "Kommentar muss noch freigeschaltet werden.", "comment-anonymous": "Anonym", "comment-hidden": "{{ n }} versteckt", - "date-now": "eben jetzt", + "date-now": "eben gerade", "date-minute": "vor einer Minute\nvor {{ n }} Minuten", "date-hour": "vor einer Stunde\nvor {{ n }} Stunden", "date-day": "Gestern\nvor {{ n }} Tagen", From 343f24377fd356ed38f0f7b92818a0af7c06bf20 Mon Sep 17 00:00:00 2001 From: cclauss Date: Wed, 31 Jan 2018 07:23:54 +0100 Subject: [PATCH 51/78] Return to pyflakes --- .travis.yml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index 0302d5b..a6fe14d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,14 +13,11 @@ matrix: env: TOX_ENV=wheezy install: - pip install -U pip - - pip install flake8 tox + - pip install pyflakes tox - sudo rm -rf /dev/shm && sudo ln -s /run/shm /dev/shm script: - tox -e $TOX_ENV - # stop the build if there are Python syntax errors or undefined names - - flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics - # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide - - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - python -m pyflakes.__main__ $(git ls-files | grep -E "^isso/.+.py$" | grep -v "^isso/compat.py") notifications: irc: channels: From a68d392f9cb4b34bfe20d5bf14d2ebc2764b2817 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Thu, 8 Feb 2018 22:35:27 +0100 Subject: [PATCH 52/78] add changes in CHANGES file to prepare release --- CHANGES.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 0d1c7da..2b290a6 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,7 +4,15 @@ Changelog for Isso 0.10.7 (unreleased) ------------------- -- Nothing changed yet. +- Fix Chinese translation +- Add Danish translation +- Add Hungarian translation +- Add Persian translation +- Add admin interface +- Add links highlighting in comments +- Add apidoc +- Add rc.d script for FreeBSD +- Some tests/travis/documentation improvements and fixes 0.10.6 (2016-09-22) From 7f55c81e0875e1564eeab8ec6dd605c5699c9137 Mon Sep 17 00:00:00 2001 From: cclauss Date: Wed, 31 Jan 2018 23:32:13 +0100 Subject: [PATCH 53/78] autopep8 the code and then flake8 --- .travis.yml | 5 ++- docs/_isso/remove_heading.py | 1 - docs/conf.py | 22 ++++----- isso/__init__.py | 30 ++++++++----- isso/compat.py | 6 ++- isso/config.py | 4 +- isso/core.py | 3 +- isso/db/__init__.py | 11 +++-- isso/db/comments.py | 19 ++++---- isso/db/preferences.py | 2 +- isso/db/spam.py | 2 +- isso/db/threads.py | 3 +- isso/dispatch.py | 6 ++- isso/ext/notifications.py | 9 ++-- isso/migrate.py | 43 ++++++++++-------- isso/tests/fixtures.py | 6 ++- isso/tests/test_comments.py | 85 ++++++++++++++++++++++------------- isso/tests/test_cors.py | 38 +++++++++------- isso/tests/test_db.py | 20 +++++---- isso/tests/test_guard.py | 64 +++++++++++++++++--------- isso/tests/test_html.py | 3 +- isso/tests/test_migration.py | 9 ++-- isso/tests/test_utils.py | 5 ++- isso/tests/test_utils_hash.py | 3 +- isso/tests/test_vote.py | 15 ++++--- isso/utils/__init__.py | 5 ++- isso/utils/hash.py | 4 +- isso/utils/html.py | 3 +- isso/utils/parse.py | 6 +-- isso/views/__init__.py | 3 +- isso/views/comments.py | 56 ++++++++++++++--------- isso/wsgi.py | 9 ++-- 32 files changed, 306 insertions(+), 194 deletions(-) diff --git a/.travis.yml b/.travis.yml index a6fe14d..8ff53a2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,11 +13,12 @@ matrix: env: TOX_ENV=wheezy install: - pip install -U pip - - pip install pyflakes tox + - pip install flake8 tox - sudo rm -rf /dev/shm && sudo ln -s /run/shm /dev/shm script: - tox -e $TOX_ENV - - python -m pyflakes.__main__ $(git ls-files | grep -E "^isso/.+.py$" | grep -v "^isso/compat.py") + - IGNORE=E226,E241,E265,E402,E501,E704 + - flake8 . --count --ignore=${IGNORE} --max-line-length=127 --show-source --statistics notifications: irc: channels: diff --git a/docs/_isso/remove_heading.py b/docs/_isso/remove_heading.py index 48d7708..f15f5d5 100644 --- a/docs/_isso/remove_heading.py +++ b/docs/_isso/remove_heading.py @@ -9,4 +9,3 @@ class IssoTranslator(HTMLTranslator): if self.section_level == 1: raise nodes.SkipNode HTMLTranslator.visit_title(self, node) - diff --git a/docs/conf.py b/docs/conf.py index 0b85a07..0d0c005 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -200,22 +200,22 @@ htmlhelp_basename = 'Issodoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'Isso.tex', u'Isso Documentation', - u'Martin Zimmermann', 'manual'), + ('index', 'Isso.tex', u'Isso Documentation', + u'Martin Zimmermann', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -260,9 +260,9 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'Isso', u'Isso Documentation', - u'Martin Zimmermann', 'Isso', 'a commenting server similar to Disqus', - 'Miscellaneous'), + ('index', 'Isso', u'Isso Documentation', + u'Martin Zimmermann', 'Isso', 'a commenting server similar to Disqus', + 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. diff --git a/isso/__init__.py b/isso/__init__.py index 035cafd..0af5b43 100644 --- a/isso/__init__.py +++ b/isso/__init__.py @@ -35,7 +35,8 @@ import sys if sys.argv[0].startswith("isso"): try: - import gevent.monkey; gevent.monkey.patch_all() + import gevent.monkey + gevent.monkey.patch_all() except ImportError: pass @@ -87,7 +88,8 @@ class Isso(object): self.conf = conf self.db = db.SQLite3(conf.get('general', 'dbpath'), conf) - self.signer = URLSafeTimedSerializer(self.db.preferences.get("session-key")) + self.signer = URLSafeTimedSerializer( + self.db.preferences.get("session-key")) self.markup = html.Markup(conf.section('markup')) self.hasher = hash.new(conf.section("hash")) @@ -122,7 +124,8 @@ class Isso(object): local.request = request local.host = wsgi.host(request.environ) - local.origin = origin(self.conf.getiter("general", "host"))(request.environ) + local.origin = origin(self.conf.getiter( + "general", "host"))(request.environ) adapter = self.urls.bind_to_environ(request.environ) @@ -136,7 +139,8 @@ class Isso(object): except HTTPException as e: return e except Exception: - logger.exception("%s %s", request.method, request.environ["PATH_INFO"]) + logger.exception("%s %s", request.method, + request.environ["PATH_INFO"]) return InternalServerError() else: return response @@ -181,19 +185,19 @@ def make_app(conf=None, threading=True, multiprocessing=False, uwsgi=False): if isso.conf.getboolean("server", "profile"): wrapper.append(partial(ProfilerMiddleware, - sort_by=("cumulative", ), restrictions=("isso/(?!lib)", 10))) + sort_by=("cumulative", ), restrictions=("isso/(?!lib)", 10))) wrapper.append(partial(SharedDataMiddleware, exports={ '/js': join(dirname(__file__), 'js/'), '/css': join(dirname(__file__), 'css/'), '/img': join(dirname(__file__), 'img/'), '/demo': join(dirname(__file__), 'demo/') - })) + })) wrapper.append(partial(wsgi.CORSMiddleware, - origin=origin(isso.conf.getiter("general", "host")), - allowed=("Origin", "Referer", "Content-Type"), - exposed=("X-Set-Cookie", "Date"))) + origin=origin(isso.conf.getiter("general", "host")), + allowed=("Origin", "Referer", "Content-Type"), + exposed=("X-Set-Cookie", "Date"))) wrapper.extend([wsgi.SubURI, ProxyFix]) @@ -208,9 +212,10 @@ def main(): parser = ArgumentParser(description="a blog comment hosting service") subparser = parser.add_subparsers(help="commands", dest="command") - parser.add_argument('--version', action='version', version='%(prog)s ' + dist.version) + parser.add_argument('--version', action='version', + version='%(prog)s ' + dist.version) parser.add_argument("-c", dest="conf", default="/etc/isso.conf", - metavar="/etc/isso.conf", help="set configuration file") + metavar="/etc/isso.conf", help="set configuration file") imprt = subparser.add_parser('import', help="import Disqus XML export") imprt.add_argument("dump", metavar="FILE") @@ -225,7 +230,8 @@ def main(): subparser.add_parser("run", help="run server") args = parser.parse_args() - conf = config.load(join(dist.location, dist.project_name, "defaults.ini"), args.conf) + conf = config.load( + join(dist.location, dist.project_name, "defaults.ini"), args.conf) if args.command == "import": conf.set("guard", "enabled", "off") diff --git a/isso/compat.py b/isso/compat.py index e38ecc5..c93270d 100644 --- a/isso/compat.py +++ b/isso/compat.py @@ -12,11 +12,13 @@ except NameError: # Python 3 if not PY2K: buffer = memoryview filter, map, zip = filter, map, zip - iteritems = lambda dikt: iter(dikt.items()) # noqa: E731 + + def iteritems(dikt): return iter(dikt.items()) # noqa: E731 from functools import reduce else: buffer = buffer from itertools import ifilter, imap, izip filter, map, zip = ifilter, imap, izip - iteritems = lambda dikt: dikt.iteritems() # noqa: E731 + + def iteritems(dikt): return dikt.iteritems() # noqa: E731 reduce = reduce diff --git a/isso/config.py b/isso/config.py index c2a05ce..488224b 100644 --- a/isso/config.py +++ b/isso/config.py @@ -123,8 +123,8 @@ def new(options=None): def load(default, user=None): # return set of (section, option) - setify = lambda cp: set((section, option) for section in cp.sections() - for option in cp.options(section)) + def setify(cp): return set((section, option) for section in cp.sections() + for option in cp.options(section)) parser = new() parser.read(default) diff --git a/isso/core.py b/isso/core.py index 368c8e3..9992df9 100644 --- a/isso/core.py +++ b/isso/core.py @@ -122,7 +122,8 @@ class uWSGIMixin(Mixin): self.cache = uWSGICache timedelta = conf.getint("moderation", "purge-after") - purge = lambda signum: self.db.comments.purge(timedelta) + + def purge(signum): return self.db.comments.purge(timedelta) uwsgi.register_signal(1, "", purge) uwsgi.add_timer(1, timedelta) diff --git a/isso/db/__init__.py b/isso/db/__init__.py index 919137c..ecc7a44 100644 --- a/isso/db/__init__.py +++ b/isso/db/__init__.py @@ -98,10 +98,11 @@ class SQLite3: # limit max. nesting level to 1 if self.version == 2: - first = lambda rv: list(map(operator.itemgetter(0), rv)) + def first(rv): return list(map(operator.itemgetter(0), rv)) with sqlite3.connect(self.path) as con: - top = first(con.execute("SELECT id FROM comments WHERE parent IS NULL").fetchall()) + top = first(con.execute( + "SELECT id FROM comments WHERE parent IS NULL").fetchall()) flattened = defaultdict(set) for id in top: @@ -109,13 +110,15 @@ class SQLite3: ids = [id, ] while ids: - rv = first(con.execute("SELECT id FROM comments WHERE parent=?", (ids.pop(), ))) + rv = first(con.execute( + "SELECT id FROM comments WHERE parent=?", (ids.pop(), ))) ids.extend(rv) flattened[id].update(set(rv)) for id in flattened.keys(): for n in flattened[id]: - con.execute("UPDATE comments SET parent=? WHERE id=?", (id, n)) + con.execute( + "UPDATE comments SET parent=? WHERE id=?", (id, n)) con.execute('PRAGMA user_version = 3') logger.info("%i rows changed", con.total_changes) diff --git a/isso/db/comments.py b/isso/db/comments.py index a66c248..0f359a3 100644 --- a/isso/db/comments.py +++ b/isso/db/comments.py @@ -83,7 +83,7 @@ class Comments: """ self.db.execute([ 'UPDATE comments SET', - ','.join(key + '=' + '?' for key in data), + ','.join(key + '=' + '?' for key in data), 'WHERE id=?;'], list(data.values()) + [id]) @@ -94,7 +94,8 @@ class Comments: Search for comment :param:`id` and return a mapping of :attr:`fields` and values. """ - rv = self.db.execute('SELECT * FROM comments WHERE id=?', (id, )).fetchone() + rv = self.db.execute( + 'SELECT * FROM comments WHERE id=?', (id, )).fetchone() if rv: return dict(zip(Comments.fields, rv)) @@ -122,7 +123,7 @@ class Comments: for f in fields_comments]) sql_threads_fields = ', '.join(['threads.' + f for f in fields_threads]) - sql = ['SELECT ' + sql_comments_fields + ', ' + \ + sql = ['SELECT ' + sql_comments_fields + ', ' + sql_threads_fields + ' ' 'FROM comments INNER JOIN threads ' 'ON comments.tid=threads.id ' @@ -162,9 +163,9 @@ class Comments: """ Return comments for :param:`uri` with :param:`mode`. """ - sql = [ 'SELECT comments.* FROM comments INNER JOIN threads ON', - ' threads.uri=? AND comments.tid=threads.id AND (? | comments.mode) = ?', - ' AND comments.created>?'] + sql = ['SELECT comments.* FROM comments INNER JOIN threads ON', + ' threads.uri=? AND comments.tid=threads.id AND (? | comments.mode) = ?', + ' AND comments.created>?'] sql_args = [uri, mode, mode, after] @@ -216,7 +217,8 @@ class Comments: In the second case this comment can be safely removed without any side effects.""" - refs = self.db.execute('SELECT * FROM comments WHERE parent=?', (id, )).fetchone() + refs = self.db.execute( + 'SELECT * FROM comments WHERE parent=?', (id, )).fetchone() if refs is None: self.db.execute('DELETE FROM comments WHERE id=?', (id, )) @@ -226,7 +228,8 @@ class Comments: self.db.execute('UPDATE comments SET text=? WHERE id=?', ('', id)) self.db.execute('UPDATE comments SET mode=? WHERE id=?', (4, id)) for field in ('author', 'website'): - self.db.execute('UPDATE comments SET %s=? WHERE id=?' % field, (None, id)) + self.db.execute('UPDATE comments SET %s=? WHERE id=?' % + field, (None, id)) self._remove_stale() return self.get(id) diff --git a/isso/db/preferences.py b/isso/db/preferences.py index 28936e4..3eb12a3 100644 --- a/isso/db/preferences.py +++ b/isso/db/preferences.py @@ -24,7 +24,7 @@ class Preferences: def get(self, key, default=None): rv = self.db.execute( - 'SELECT value FROM preferences WHERE key=?', (key, )).fetchone() + 'SELECT value FROM preferences WHERE key=?', (key, )).fetchone() if rv is None: return default diff --git a/isso/db/spam.py b/isso/db/spam.py index d198f6a..5069229 100644 --- a/isso/db/spam.py +++ b/isso/db/spam.py @@ -50,7 +50,7 @@ class Guard: return False, "%i direct responses to %s" % (len(rv), uri) # block replies to self unless :param:`reply-to-self` is enabled - elif self.conf.getboolean("reply-to-self") == False: + elif self.conf.getboolean("reply-to-self") is False: rv = self.db.execute([ 'SELECT id FROM comments WHERE' ' remote_addr = ?', diff --git a/isso/db/threads.py b/isso/db/threads.py index bb7067b..4f0b476 100644 --- a/isso/db/threads.py +++ b/isso/db/threads.py @@ -26,5 +26,6 @@ class Threads(object): return Thread(*self.db.execute("SELECT * FROM threads WHERE uri=?", (uri, )).fetchone()) def new(self, uri, title): - self.db.execute("INSERT INTO threads (uri, title) VALUES (?, ?)", (uri, title)) + self.db.execute( + "INSERT INTO threads (uri, title) VALUES (?, ?)", (uri, title)) return self[uri] diff --git a/isso/dispatch.py b/isso/dispatch.py index bf3a163..7c8bb14 100644 --- a/isso/dispatch.py +++ b/isso/dispatch.py @@ -25,7 +25,8 @@ class Dispatcher(DispatcherMiddleware): def __init__(self, *confs): self.isso = {} - default = os.path.join(dist.location, dist.project_name, "defaults.ini") + default = os.path.join( + dist.location, dist.project_name, "defaults.ini") for i, path in enumerate(confs): conf = config.load(default, path) @@ -45,7 +46,8 @@ class Dispatcher(DispatcherMiddleware): return super(Dispatcher, self).__call__(environ, start_response) def default(self, environ, start_response): - resp = Response("\n".join(self.isso.keys()), 404, content_type="text/plain") + resp = Response("\n".join(self.isso.keys()), + 404, content_type="text/plain") return resp(environ, start_response) diff --git a/isso/ext/notifications.py b/isso/ext/notifications.py index 3ba708b..80e1504 100644 --- a/isso/ext/notifications.py +++ b/isso/ext/notifications.py @@ -58,7 +58,8 @@ class SMTP(object): uwsgi.spooler = spooler def __enter__(self): - klass = (smtplib.SMTP_SSL if self.conf.get('security') == 'ssl' else smtplib.SMTP) + klass = (smtplib.SMTP_SSL if self.conf.get( + 'security') == 'ssl' else smtplib.SMTP) self.client = klass(host=self.conf.get('host'), port=self.conf.getint('port'), timeout=self.conf.getint('timeout')) @@ -104,7 +105,8 @@ class SMTP(object): rv.write("User's URL: %s\n" % comment["website"]) rv.write("IP address: %s\n" % comment["remote_addr"]) - rv.write("Link to comment: %s\n" % (local("origin") + thread["uri"] + "#isso-%i" % comment["id"])) + rv.write("Link to comment: %s\n" % + (local("origin") + thread["uri"] + "#isso-%i" % comment["id"])) rv.write("\n") uri = local("host") + "/id/%i" % comment["id"] @@ -173,7 +175,8 @@ class Stdout(object): logger.info("comment created: %s", json.dumps(comment)) def _edit_comment(self, comment): - logger.info('comment %i edited: %s', comment["id"], json.dumps(comment)) + logger.info('comment %i edited: %s', + comment["id"], json.dumps(comment)) def _delete_comment(self, id): logger.info('comment %i deleted', id) diff --git a/isso/migrate.py b/isso/migrate.py index f53341a..f6297b7 100644 --- a/isso/migrate.py +++ b/isso/migrate.py @@ -30,6 +30,7 @@ from xml.etree import ElementTree logger = logging.getLogger("isso") + def strip(val): if isinstance(val, string_types): return val.strip() @@ -82,7 +83,8 @@ class Disqus(object): remap = dict() if path not in self.db.threads: - self.db.threads.new(path, thread.find(Disqus.ns + 'title').text.strip()) + self.db.threads.new(path, thread.find( + Disqus.ns + 'title').text.strip()) for item in sorted(posts, key=lambda k: k['created']): @@ -112,9 +114,11 @@ class Disqus(object): } if post.find(Disqus.ns + 'parent') is not None: - item['dsq:parent'] = post.find(Disqus.ns + 'parent').attrib.get(Disqus.internals + 'id') + item['dsq:parent'] = post.find( + Disqus.ns + 'parent').attrib.get(Disqus.internals + 'id') - res[post.find('%sthread' % Disqus.ns).attrib.get(Disqus.internals + 'id')].append(item) + res[post.find('%sthread' % Disqus.ns).attrib.get( + Disqus.internals + 'id')].append(item) progress = Progress(len(tree.findall(Disqus.ns + 'thread'))) for i, thread in enumerate(tree.findall(Disqus.ns + 'thread')): @@ -135,7 +139,8 @@ class Disqus(object): progress.finish("{0} threads, {1} comments".format( len(self.threads), len(self.comments))) - orphans = set(map(lambda e: e.attrib.get(Disqus.internals + "id"), tree.findall(Disqus.ns + "post"))) - self.comments + orphans = set(map(lambda e: e.attrib.get(Disqus.internals + "id"), + tree.findall(Disqus.ns + "post"))) - self.comments if orphans and not self.threads: print("Isso couldn't import any thread, try again with --empty-id") elif orphans: @@ -258,22 +263,22 @@ def autodetect(peek): def dispatch(type, db, dump, empty_id=False): - if db.execute("SELECT * FROM comments").fetchone(): - if input("Isso DB is not empty! Continue? [y/N]: ") not in ("y", "Y"): - raise SystemExit("Abort.") + if db.execute("SELECT * FROM comments").fetchone(): + if input("Isso DB is not empty! Continue? [y/N]: ") not in ("y", "Y"): + raise SystemExit("Abort.") - if type == "disqus": - cls = Disqus - elif type == "wordpress": - cls = WordPress - else: - with io.open(dump, encoding="utf-8") as fp: - cls = autodetect(fp.read(io.DEFAULT_BUFFER_SIZE)) + if type == "disqus": + cls = Disqus + elif type == "wordpress": + cls = WordPress + else: + with io.open(dump, encoding="utf-8") as fp: + cls = autodetect(fp.read(io.DEFAULT_BUFFER_SIZE)) - if cls is None: - raise SystemExit("Unknown format, abort.") + if cls is None: + raise SystemExit("Unknown format, abort.") - if cls is Disqus: - cls = functools.partial(cls, empty_id=empty_id) + if cls is Disqus: + cls = functools.partial(cls, empty_id=empty_id) - cls(db, dump).migrate() + cls(db, dump).migrate() diff --git a/isso/tests/fixtures.py b/isso/tests/fixtures.py index 710d0d2..303e8bb 100644 --- a/isso/tests/fixtures.py +++ b/isso/tests/fixtures.py @@ -37,5 +37,7 @@ class Dummy: pass -curl = lambda method, host, path: Dummy() -loads = lambda data: json.loads(data.decode('utf-8')) +def curl(method, host, path): return Dummy() + + +def loads(data): return json.loads(data.decode('utf-8')) diff --git a/isso/tests/test_comments.py b/isso/tests/test_comments.py index e7bc011..cc27ae8 100644 --- a/isso/tests/test_comments.py +++ b/isso/tests/test_comments.py @@ -50,7 +50,8 @@ class TestComments(unittest.TestCase): def testGet(self): - self.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'Lorem ipsum ...'})) + self.post('/new?uri=%2Fpath%2F', + data=json.dumps({'text': 'Lorem ipsum ...'})) r = self.get('/id/1') self.assertEqual(r.status_code, 200) @@ -61,7 +62,8 @@ class TestComments(unittest.TestCase): def testCreate(self): - rv = self.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'Lorem ipsum ...'})) + rv = self.post('/new?uri=%2Fpath%2F', + data=json.dumps({'text': 'Lorem ipsum ...'})) self.assertEqual(rv.status_code, 201) self.assertIn("Set-Cookie", rv.headers) @@ -73,7 +75,8 @@ class TestComments(unittest.TestCase): def textCreateWithNonAsciiText(self): - rv = self.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'Здравствуй, мир!'})) + rv = self.post('/new?uri=%2Fpath%2F', + data=json.dumps({'text': 'Здравствуй, мир!'})) self.assertEqual(rv.status_code, 201) rv = loads(rv.data) @@ -105,14 +108,16 @@ class TestComments(unittest.TestCase): def testCreateInvalidParent(self): self.post('/new?uri=test', data=json.dumps({'text': '...'})) - self.post('/new?uri=test', data=json.dumps({'text': '...', 'parent': 1})) - invalid = self.post('/new?uri=test', data=json.dumps({'text': '...', 'parent': 2})) + self.post('/new?uri=test', + data=json.dumps({'text': '...', 'parent': 1})) + invalid = self.post( + '/new?uri=test', data=json.dumps({'text': '...', 'parent': 2})) self.assertEqual(loads(invalid.data)["parent"], 1) def testVerifyFields(self): - verify = lambda comment: comments.API.verify(comment)[0] + def verify(comment): return comments.API.verify(comment)[0] # text is missing self.assertFalse(verify({})) @@ -128,10 +133,12 @@ class TestComments(unittest.TestCase): # email/website length self.assertTrue(verify({"text": "...", "email": "*"*254})) - self.assertTrue(verify({"text": "...", "website": "google.de/" + "a"*128})) + self.assertTrue( + verify({"text": "...", "website": "google.de/" + "a"*128})) self.assertFalse(verify({"text": "...", "email": "*"*1024})) - self.assertFalse(verify({"text": "...", "website": "google.de/" + "*"*1024})) + self.assertFalse( + verify({"text": "...", "website": "google.de/" + "*"*1024})) # valid website url self.assertTrue(comments.isurl("example.tld")) @@ -139,7 +146,8 @@ class TestComments(unittest.TestCase): self.assertTrue(comments.isurl("https://example.tld")) self.assertTrue(comments.isurl("https://example.tld:1337/")) self.assertTrue(comments.isurl("https://example.tld:1337/foobar")) - self.assertTrue(comments.isurl("https://example.tld:1337/foobar?p=1#isso-thread")) + self.assertTrue(comments.isurl( + "https://example.tld:1337/foobar?p=1#isso-thread")) self.assertFalse(comments.isurl("ftp://example.tld/")) self.assertFalse(comments.isurl("tel:+1234567890")) @@ -149,7 +157,8 @@ class TestComments(unittest.TestCase): def testGetInvalid(self): self.assertEqual(self.get('/?uri=%2Fpath%2F&id=123').status_code, 404) - self.assertEqual(self.get('/?uri=%2Fpath%2Fspam%2F&id=123').status_code, 404) + self.assertEqual( + self.get('/?uri=%2Fpath%2Fspam%2F&id=123').status_code, 404) self.assertEqual(self.get('/?uri=?uri=%foo%2F').status_code, 404) def testGetLimited(self): @@ -166,7 +175,8 @@ class TestComments(unittest.TestCase): def testGetNested(self): self.post('/new?uri=test', data=json.dumps({'text': '...'})) - self.post('/new?uri=test', data=json.dumps({'text': '...', 'parent': 1})) + self.post('/new?uri=test', + data=json.dumps({'text': '...', 'parent': 1})) r = self.get('/?uri=test&parent=1') self.assertEqual(r.status_code, 200) @@ -178,7 +188,8 @@ class TestComments(unittest.TestCase): self.post('/new?uri=test', data=json.dumps({'text': '...'})) for i in range(20): - self.post('/new?uri=test', data=json.dumps({'text': '...', 'parent': 1})) + self.post('/new?uri=test', + data=json.dumps({'text': '...', 'parent': 1})) r = self.get('/?uri=test&parent=1&limit=10') self.assertEqual(r.status_code, 200) @@ -188,7 +199,8 @@ class TestComments(unittest.TestCase): def testUpdate(self): - self.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'Lorem ipsum ...'})) + self.post('/new?uri=%2Fpath%2F', + data=json.dumps({'text': 'Lorem ipsum ...'})) self.put('/id/1', data=json.dumps({ 'text': 'Hello World', 'author': 'me', 'website': 'http://example.com/'})) @@ -203,7 +215,8 @@ class TestComments(unittest.TestCase): def testDelete(self): - self.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'Lorem ipsum ...'})) + self.post('/new?uri=%2Fpath%2F', + data=json.dumps({'text': 'Lorem ipsum ...'})) r = self.delete('/id/1') self.assertEqual(r.status_code, 200) self.assertEqual(loads(r.data), None) @@ -213,7 +226,8 @@ class TestComments(unittest.TestCase): client = JSONClient(self.app, Response) client.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'First'})) - client.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'First', 'parent': 1})) + client.post('/new?uri=%2Fpath%2F', + data=json.dumps({'text': 'First', 'parent': 1})) r = client.delete('/id/1') self.assertEqual(r.status_code, 200) @@ -242,8 +256,10 @@ class TestComments(unittest.TestCase): client = JSONClient(self.app, Response) client.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'First'})) - client.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'Second', 'parent': 1})) - client.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'Third', 'parent': 1})) + client.post('/new?uri=%2Fpath%2F', + data=json.dumps({'text': 'Second', 'parent': 1})) + client.post('/new?uri=%2Fpath%2F', + data=json.dumps({'text': 'Third', 'parent': 1})) client.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'Last'})) client.delete('/id/1') @@ -261,10 +277,11 @@ class TestComments(unittest.TestCase): for path in paths: self.assertEqual(self.post('/new?' + urlencode({'uri': path}), - data=json.dumps({'text': '...'})).status_code, 201) + data=json.dumps({'text': '...'})).status_code, 201) for i, path in enumerate(paths): - self.assertEqual(self.get('/?' + urlencode({'uri': path})).status_code, 200) + self.assertEqual( + self.get('/?' + urlencode({'uri': path})).status_code, 200) self.assertEqual(self.get('/id/%i' % (i + 1)).status_code, 200) def testDeleteAndCreateByDifferentUsersButSamePostId(self): @@ -283,7 +300,8 @@ class TestComments(unittest.TestCase): a = self.post('/new?uri=%2Fpath%2F', data=json.dumps({"text": "Aaa"})) b = self.post('/new?uri=%2Fpath%2F', data=json.dumps({"text": "Bbb"})) - c = self.post('/new?uri=%2Fpath%2F', data=json.dumps({"text": "Ccc", "email": "..."})) + c = self.post('/new?uri=%2Fpath%2F', + data=json.dumps({"text": "Ccc", "email": "..."})) a = loads(a.data) b = loads(b.data) @@ -295,7 +313,8 @@ class TestComments(unittest.TestCase): def testVisibleFields(self): - rv = self.post('/new?uri=%2Fpath%2F', data=json.dumps({"text": "...", "invalid": "field"})) + rv = self.post('/new?uri=%2Fpath%2F', + data=json.dumps({"text": "...", "invalid": "field"})) self.assertEqual(rv.status_code, 201) rv = loads(rv.data) @@ -333,7 +352,8 @@ class TestComments(unittest.TestCase): for uri, count in iteritems(expected): for _ in range(count): - self.post('/new?uri=%s' % uri, data=json.dumps({"text": "..."})) + self.post('/new?uri=%s' % + uri, data=json.dumps({"text": "..."})) rv = self.post('/count', data=json.dumps(list(expected.keys()))) self.assertEqual(loads(rv.data), list(expected.values())) @@ -362,22 +382,26 @@ class TestComments(unittest.TestCase): self.post('/new?uri=%2F', data=json.dumps({"text": "..."})) # no header is fine (default for XHR) - self.assertEqual(self.post('/id/1/dislike', content_type="").status_code, 200) + self.assertEqual( + self.post('/id/1/dislike', content_type="").status_code, 200) # x-www-form-urlencoded is definitely not RESTful - self.assertEqual(self.post('/id/1/dislike', content_type=form).status_code, 403) + self.assertEqual( + self.post('/id/1/dislike', content_type=form).status_code, 403) self.assertEqual(self.post('/new?uri=%2F', data=json.dumps({"text": "..."}), - content_type=form).status_code, 403) + content_type=form).status_code, 403) # just for the record - self.assertEqual(self.post('/id/1/dislike', content_type=js).status_code, 200) + self.assertEqual( + self.post('/id/1/dislike', content_type=js).status_code, 200) def testPreview(self): - response = self.post('/preview', data=json.dumps({'text': 'This is **mark***down*'})) + response = self.post( + '/preview', data=json.dumps({'text': 'This is **mark***down*'})) self.assertEqual(response.status_code, 200) rv = loads(response.data) - self.assertEqual(rv["text"], '

This is markdown

') - + self.assertEqual( + rv["text"], '

This is markdown

') class TestModeratedComments(unittest.TestCase): @@ -402,7 +426,8 @@ class TestModeratedComments(unittest.TestCase): def testAddComment(self): - rv = self.client.post('/new?uri=test', data=json.dumps({"text": "..."})) + rv = self.client.post( + '/new?uri=test', data=json.dumps({"text": "..."})) self.assertEqual(rv.status_code, 202) self.assertEqual(self.client.get('/id/1').status_code, 200) diff --git a/isso/tests/test_cors.py b/isso/tests/test_cors.py index 415ea51..c1d22a0 100644 --- a/isso/tests/test_cors.py +++ b/isso/tests/test_cors.py @@ -19,31 +19,37 @@ class CORSTest(unittest.TestCase): def test_simple(self): app = CORSMiddleware(hello_world, - origin=origin([ - "https://example.tld/", - "http://example.tld/", - ]), - allowed=("Foo", "Bar"), exposed=("Spam", )) + origin=origin([ + "https://example.tld/", + "http://example.tld/", + ]), + allowed=("Foo", "Bar"), exposed=("Spam", )) client = Client(app, Response) rv = client.get("/", headers={"Origin": "https://example.tld"}) - self.assertEqual(rv.headers["Access-Control-Allow-Origin"], "https://example.tld") - self.assertEqual(rv.headers["Access-Control-Allow-Credentials"], "true") - self.assertEqual(rv.headers["Access-Control-Allow-Methods"], "HEAD, GET, POST, PUT, DELETE") - self.assertEqual(rv.headers["Access-Control-Allow-Headers"], "Foo, Bar") + self.assertEqual( + rv.headers["Access-Control-Allow-Origin"], "https://example.tld") + self.assertEqual( + rv.headers["Access-Control-Allow-Credentials"], "true") + self.assertEqual( + rv.headers["Access-Control-Allow-Methods"], "HEAD, GET, POST, PUT, DELETE") + self.assertEqual( + rv.headers["Access-Control-Allow-Headers"], "Foo, Bar") self.assertEqual(rv.headers["Access-Control-Expose-Headers"], "Spam") a = client.get("/", headers={"Origin": "http://example.tld"}) - self.assertEqual(a.headers["Access-Control-Allow-Origin"], "http://example.tld") + self.assertEqual( + a.headers["Access-Control-Allow-Origin"], "http://example.tld") b = client.get("/", headers={"Origin": "http://example.tld"}) - self.assertEqual(b.headers["Access-Control-Allow-Origin"], "http://example.tld") + self.assertEqual( + b.headers["Access-Control-Allow-Origin"], "http://example.tld") c = client.get("/", headers={"Origin": "http://foo.other"}) - self.assertEqual(c.headers["Access-Control-Allow-Origin"], "https://example.tld") - + self.assertEqual( + c.headers["Access-Control-Allow-Origin"], "https://example.tld") def test_preflight(self): @@ -51,10 +57,12 @@ class CORSTest(unittest.TestCase): allowed=("Foo", ), exposed=("Bar", )) client = Client(app, Response) - rv = client.open(method="OPTIONS", path="/", headers={"Origin": "http://example.tld"}) + rv = client.open(method="OPTIONS", path="/", + headers={"Origin": "http://example.tld"}) self.assertEqual(rv.status_code, 200) for hdr in ("Origin", "Headers", "Credentials", "Methods"): self.assertIn("Access-Control-Allow-%s" % hdr, rv.headers) - self.assertEqual(rv.headers["Access-Control-Allow-Origin"], "http://example.tld") + self.assertEqual( + rv.headers["Access-Control-Allow-Origin"], "http://example.tld") diff --git a/isso/tests/test_db.py b/isso/tests/test_db.py index 74e0831..e3e7926 100644 --- a/isso/tests/test_db.py +++ b/isso/tests/test_db.py @@ -66,10 +66,10 @@ class TestDBMigration(unittest.TestCase): tree = { 1: None, 2: None, - 3: 2, - 4: 3, - 7: 3, - 5: 2, + 3: 2, + 4: 3, + 7: 3, + 5: 2, 6: None } @@ -91,7 +91,8 @@ class TestDBMigration(unittest.TestCase): " dislikes INTEGER DEFAULT 0," " voters BLOB)") - con.execute("INSERT INTO threads (uri, title) VALUES (?, ?)", ("/", "Test")) + con.execute( + "INSERT INTO threads (uri, title) VALUES (?, ?)", ("/", "Test")) for (id, parent) in iteritems(tree): con.execute("INSERT INTO comments (" " id, parent, created)" @@ -108,13 +109,14 @@ class TestDBMigration(unittest.TestCase): flattened = list(iteritems({ 1: None, 2: None, - 3: 2, - 4: 2, - 5: 2, + 3: 2, + 4: 2, + 5: 2, 6: None, 7: 2 })) with sqlite3.connect(self.path) as con: - rv = con.execute("SELECT id, parent FROM comments ORDER BY created").fetchall() + rv = con.execute( + "SELECT id, parent FROM comments ORDER BY created").fetchall() self.assertEqual(flattened, rv) diff --git a/isso/tests/test_guard.py b/isso/tests/test_guard.py index a9ae365..4bbb50e 100644 --- a/isso/tests/test_guard.py +++ b/isso/tests/test_guard.py @@ -68,7 +68,8 @@ class TestGuard(unittest.TestCase): alice = self.makeClient("1.2.3.4", 2) for i in range(2): - self.assertEqual(alice.post("/new?uri=test", data=self.data).status_code, 201) + self.assertEqual(alice.post( + "/new?uri=test", data=self.data).status_code, 201) bob.application.db.execute([ "UPDATE comments SET", @@ -76,7 +77,8 @@ class TestGuard(unittest.TestCase): "WHERE remote_addr = '127.0.0.0'" ]) - self.assertEqual(bob.post("/new?uri=test", data=self.data).status_code, 201) + self.assertEqual( + bob.post("/new?uri=test", data=self.data).status_code, 201) def testDirectReply(self): @@ -95,11 +97,13 @@ class TestGuard(unittest.TestCase): def testSelfReply(self): - payload = lambda id: json.dumps({"text": "...", "parent": id}) + def payload(id): return json.dumps({"text": "...", "parent": id}) client = self.makeClient("127.0.0.1", self_reply=False) - self.assertEqual(client.post("/new?uri=test", data=self.data).status_code, 201) - self.assertEqual(client.post("/new?uri=test", data=payload(1)).status_code, 403) + self.assertEqual(client.post( + "/new?uri=test", data=self.data).status_code, 201) + self.assertEqual(client.post( + "/new?uri=test", data=payload(1)).status_code, 403) client.application.db.execute([ "UPDATE comments SET", @@ -107,39 +111,55 @@ class TestGuard(unittest.TestCase): "WHERE id = 1" ], (client.application.conf.getint("general", "max-age"), )) - self.assertEqual(client.post("/new?uri=test", data=payload(1)).status_code, 201) + self.assertEqual(client.post( + "/new?uri=test", data=payload(1)).status_code, 201) client = self.makeClient("128.0.0.1", ratelimit=3, self_reply=False) - self.assertEqual(client.post("/new?uri=test", data=self.data).status_code, 201) - self.assertEqual(client.post("/new?uri=test", data=payload(1)).status_code, 201) - self.assertEqual(client.post("/new?uri=test", data=payload(2)).status_code, 201) + self.assertEqual(client.post( + "/new?uri=test", data=self.data).status_code, 201) + self.assertEqual(client.post( + "/new?uri=test", data=payload(1)).status_code, 201) + self.assertEqual(client.post( + "/new?uri=test", data=payload(2)).status_code, 201) def testRequireEmail(self): - payload = lambda email: json.dumps({"text": "...", "email": email}) + def payload(email): return json.dumps({"text": "...", "email": email}) client = self.makeClient("127.0.0.1", ratelimit=4, require_email=False) - client_strict = self.makeClient("127.0.0.2", ratelimit=4, require_email=True) + client_strict = self.makeClient( + "127.0.0.2", ratelimit=4, require_email=True) # if we don't require email - self.assertEqual(client.post("/new?uri=test", data=payload("")).status_code, 201) - self.assertEqual(client.post("/new?uri=test", data=payload("test@me.more")).status_code, 201) + self.assertEqual(client.post( + "/new?uri=test", data=payload("")).status_code, 201) + self.assertEqual(client.post( + "/new?uri=test", data=payload("test@me.more")).status_code, 201) # if we do require email - self.assertEqual(client_strict.post("/new?uri=test", data=payload("")).status_code, 403) - self.assertEqual(client_strict.post("/new?uri=test", data=payload("test@me.more")).status_code, 201) + self.assertEqual(client_strict.post( + "/new?uri=test", data=payload("")).status_code, 403) + self.assertEqual(client_strict.post( + "/new?uri=test", data=payload("test@me.more")).status_code, 201) def testRequireAuthor(self): - payload = lambda author: json.dumps({"text": "...", "author": author}) + def payload(author): return json.dumps( + {"text": "...", "author": author}) - client = self.makeClient("127.0.0.1", ratelimit=4, require_author=False) - client_strict = self.makeClient("127.0.0.2", ratelimit=4, require_author=True) + client = self.makeClient( + "127.0.0.1", ratelimit=4, require_author=False) + client_strict = self.makeClient( + "127.0.0.2", ratelimit=4, require_author=True) # if we don't require author - self.assertEqual(client.post("/new?uri=test", data=payload("")).status_code, 201) - self.assertEqual(client.post("/new?uri=test", data=payload("pipo author")).status_code, 201) + self.assertEqual(client.post( + "/new?uri=test", data=payload("")).status_code, 201) + self.assertEqual(client.post( + "/new?uri=test", data=payload("pipo author")).status_code, 201) # if we do require author - self.assertEqual(client_strict.post("/new?uri=test", data=payload("")).status_code, 403) - self.assertEqual(client_strict.post("/new?uri=test", data=payload("pipo author")).status_code, 201) + self.assertEqual(client_strict.post( + "/new?uri=test", data=payload("")).status_code, 403) + self.assertEqual(client_strict.post( + "/new?uri=test", data=payload("pipo author")).status_code, 201) diff --git a/isso/tests/test_html.py b/isso/tests/test_html.py index 362e239..316fbf8 100644 --- a/isso/tests/test_html.py +++ b/isso/tests/test_html.py @@ -64,7 +64,8 @@ class TestHTML(unittest.TestCase): sanitizer = html.Sanitizer(elements=[], attributes=[]) examples = [ ('Look: ', 'Look: '), - ('Ha', 'Ha'), + ('Ha', + 'Ha'), ('Ha', 'Ha'), ('

Test

', '

Test

'), ('', 'alert("Onoe")')] diff --git a/isso/tests/test_migration.py b/isso/tests/test_migration.py index 8a876ee..151f27b 100644 --- a/isso/tests/test_migration.py +++ b/isso/tests/test_migration.py @@ -29,7 +29,8 @@ class TestMigration(unittest.TestCase): db = SQLite3(xxx.name, conf) Disqus(db, xml).migrate() - self.assertEqual(len(db.execute("SELECT id FROM comments").fetchall()), 2) + self.assertEqual( + len(db.execute("SELECT id FROM comments").fetchall()), 2) self.assertEqual(db.threads["/"]["title"], "Hello, World!") self.assertEqual(db.threads["/"]["id"], 1) @@ -57,8 +58,10 @@ class TestMigration(unittest.TestCase): self.assertEqual(db.threads["/?p=4"]["title"], "...") self.assertEqual(db.threads["/?p=4"]["id"], 2) - self.assertEqual(len(db.execute("SELECT id FROM threads").fetchall()), 2) - self.assertEqual(len(db.execute("SELECT id FROM comments").fetchall()), 7) + self.assertEqual( + len(db.execute("SELECT id FROM threads").fetchall()), 2) + self.assertEqual( + len(db.execute("SELECT id FROM comments").fetchall()), 7) first = db.comments.get(1) self.assertEqual(first["author"], "Ohai") diff --git a/isso/tests/test_utils.py b/isso/tests/test_utils.py index 0504c15..253328c 100644 --- a/isso/tests/test_utils.py +++ b/isso/tests/test_utils.py @@ -12,7 +12,8 @@ class TestUtils(unittest.TestCase): examples = [ (u'12.34.56.78', u'12.34.56.0'), - (u'1234:5678:90ab:cdef:fedc:ba09:8765:4321', u'1234:5678:90ab:0000:0000:0000:0000:0000'), + (u'1234:5678:90ab:cdef:fedc:ba09:8765:4321', + u'1234:5678:90ab:0000:0000:0000:0000:0000'), (u'::ffff:127.0.0.1', u'127.0.0.0')] for (addr, anonymized) in examples: @@ -56,4 +57,4 @@ class TestParse(unittest.TestCase): """), ('test', 'Test')) self.assertEqual(parse.thread('
'), - ('Fuu.', 'Untitled.')) + ('Fuu.', 'Untitled.')) diff --git a/isso/tests/test_utils_hash.py b/isso/tests/test_utils_hash.py index 18a790e..5d5160d 100644 --- a/isso/tests/test_utils_hash.py +++ b/isso/tests/test_utils_hash.py @@ -33,7 +33,8 @@ class TestHasher(unittest.TestCase): class TestPBKDF2(unittest.TestCase): def test_default(self): - pbkdf2 = PBKDF2(iterations=1000) # original setting (and still default) + # original setting (and still default) + pbkdf2 = PBKDF2(iterations=1000) self.assertEqual(pbkdf2.uhash(""), "42476aafe2e4") def test_different_salt(self): diff --git a/isso/tests/test_vote.py b/isso/tests/test_vote.py index 4045ccb..3e3b1b8 100644 --- a/isso/tests/test_vote.py +++ b/isso/tests/test_vote.py @@ -37,13 +37,15 @@ class TestVote(unittest.TestCase): def testZeroLikes(self): - rv = self.makeClient("127.0.0.1").post("/new?uri=test", data=json.dumps({"text": "..."})) + rv = self.makeClient("127.0.0.1").post( + "/new?uri=test", data=json.dumps({"text": "..."})) self.assertEqual(loads(rv.data)['likes'], 0) self.assertEqual(loads(rv.data)['dislikes'], 0) def testSingleLike(self): - self.makeClient("127.0.0.1").post("/new?uri=test", data=json.dumps({"text": "..."})) + self.makeClient("127.0.0.1").post( + "/new?uri=test", data=json.dumps({"text": "..."})) rv = self.makeClient("0.0.0.0").post("/id/1/like") self.assertEqual(rv.status_code, 200) @@ -60,7 +62,8 @@ class TestVote(unittest.TestCase): def testMultipleLikes(self): - self.makeClient("127.0.0.1").post("/new?uri=test", data=json.dumps({"text": "..."})) + self.makeClient("127.0.0.1").post( + "/new?uri=test", data=json.dumps({"text": "..."})) for num in range(15): rv = self.makeClient("1.2.%i.0" % num).post('/id/1/like') self.assertEqual(rv.status_code, 200) @@ -73,7 +76,8 @@ class TestVote(unittest.TestCase): def testTooManyLikes(self): - self.makeClient("127.0.0.1").post("/new?uri=test", data=json.dumps({"text": "..."})) + self.makeClient("127.0.0.1").post( + "/new?uri=test", data=json.dumps({"text": "..."})) for num in range(256): rv = self.makeClient("1.2.%i.0" % num).post('/id/1/like') self.assertEqual(rv.status_code, 200) @@ -84,7 +88,8 @@ class TestVote(unittest.TestCase): self.assertEqual(loads(rv.data)["likes"], num + 1) def testDislike(self): - self.makeClient("127.0.0.1").post("/new?uri=test", data=json.dumps({"text": "..."})) + self.makeClient("127.0.0.1").post( + "/new?uri=test", data=json.dumps({"text": "..."})) rv = self.makeClient("1.2.3.4").post('/id/1/dislike') self.assertEqual(rv.status_code, 200) diff --git a/isso/utils/__init__.py b/isso/utils/__init__.py index 7536041..a0a07bc 100644 --- a/isso/utils/__init__.py +++ b/isso/utils/__init__.py @@ -89,11 +89,11 @@ class Bloomfilter: def add(self, key): for i in self.get_probes(key): - self.array[i//8] |= 2 ** (i%8) + self.array[i//8] |= 2 ** (i % 8) self.elements += 1 def __contains__(self, key): - return all(self.array[i//8] & (2 ** (i%8)) for i in self.get_probes(key)) + return all(self.array[i//8] & (2 ** (i % 8)) for i in self.get_probes(key)) def __len__(self): return self.elements @@ -117,6 +117,7 @@ def render_template(template_name, **context): '..', 'templates') jinja_env = Environment(loader=FileSystemLoader(template_path), autoescape=True) + def datetimeformat(value): return datetime.fromtimestamp(value).strftime('%H:%M / %d-%m-%Y') diff --git a/isso/utils/hash.py b/isso/utils/hash.py index 0e93a1a..0638c1b 100644 --- a/isso/utils/hash.py +++ b/isso/utils/hash.py @@ -73,7 +73,7 @@ class Hash(object): class PBKDF2(Hash): - + def __init__(self, salt=None, iterations=1000, dklen=6, func="sha1"): super(PBKDF2, self).__init__(salt) @@ -109,4 +109,4 @@ def new(conf): return Hash(salt, algorithm) -sha1 = Hash(func="sha1").uhash \ No newline at end of file +sha1 = Hash(func="sha1").uhash diff --git a/isso/utils/html.py b/isso/utils/html.py index 294b8d4..fca3c7e 100644 --- a/isso/utils/html.py +++ b/isso/utils/html.py @@ -54,7 +54,8 @@ def sanitize(tokenizer, document): builder = "simpletree" stream = html5lib.treewalkers.getTreeWalker(builder)(domtree) - serializer = HTMLSerializer(quote_attr_values=True, omit_optional_tags=False) + serializer = HTMLSerializer( + quote_attr_values=True, omit_optional_tags=False) return serializer.render(stream) diff --git a/isso/utils/parse.py b/isso/utils/parse.py index 85c931b..d15b15f 100644 --- a/isso/utils/parse.py +++ b/isso/utils/parse.py @@ -15,7 +15,7 @@ from isso.compat import map, filter, PY2K if PY2K: # http://bugs.python.org/issue12984 from xml.dom.minidom import NamedNodeMap - NamedNodeMap.__contains__ = lambda self, key: self.has_key(key) + NamedNodeMap.__contains__ = lambda self, key: self.has_key(key) # noqa def thread(data, default=u"Untitled.", id=None): @@ -31,8 +31,8 @@ def thread(data, default=u"Untitled.", id=None): # aka getElementById, but limited to div and section tags el = list(filter(lambda i: i.attributes["id"].value == "isso-thread", - filter(lambda i: "id" in i.attributes, - chain(*map(html.getElementsByTagName, ("div", "section")))))) + filter(lambda i: "id" in i.attributes, + chain(*map(html.getElementsByTagName, ("div", "section")))))) if not el: return id, default diff --git a/isso/views/__init__.py b/isso/views/__init__.py index 0b995cd..54e1619 100644 --- a/isso/views/__init__.py +++ b/isso/views/__init__.py @@ -40,7 +40,8 @@ class requires: try: kwargs[self.param] = self.type(req.args[self.param]) except TypeError: - raise BadRequest("invalid type for %s, expected %s" % (self.param, self.type)) + raise BadRequest("invalid type for %s, expected %s" % + (self.param, self.type)) return func(cls, env, req, *args, **kwargs) diff --git a/isso/views/comments.py b/isso/views/comments.py index c87595b..d3b80c3 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -29,7 +29,8 @@ from isso.utils.hash import sha1 __url_re = re.compile( r'^' r'(https?://)?' - r'(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}\.?)|' # domain... + # domain... + r'(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}\.?)|' r'localhost|' # localhost... r'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})' # ...or ip r'(?::\d+)?' # optional port @@ -62,12 +63,12 @@ def xhr(func): not forged (XHR is restricted by CORS separately). """ - """ @apiDefine csrf @apiHeader {string="application/json"} Content-Type The content type must be set to `application/json` to prevent CSRF attacks. """ + def dec(self, env, req, *args, **kwargs): if req.content_type and not req.content_type.startswith("application/json"): @@ -93,8 +94,8 @@ class API(object): ('view', ('GET', '/id/')), ('edit', ('PUT', '/id/')), ('delete', ('DELETE', '/id/')), - ('moderate',('GET', '/id///')), - ('moderate',('POST', '/id///')), + ('moderate', ('GET', '/id///')), + ('moderate', ('POST', '/id///')), ('like', ('POST', '/id//like')), ('dislike', ('POST', '/id//dislike')), ('demo', ('GET', '/demo')), @@ -280,13 +281,15 @@ class API(object): self.signal("comments.new:after-save", thread, rv) cookie = functools.partial(dump_cookie, - value=self.isso.sign([rv["id"], sha1(rv["text"])]), - max_age=self.conf.getint('max-age')) + value=self.isso.sign( + [rv["id"], sha1(rv["text"])]), + max_age=self.conf.getint('max-age')) rv["text"] = self.isso.render(rv["text"]) rv["hash"] = self.hash(rv['email'] or rv['remote_addr']) - self.cache.set('hash', (rv['email'] or rv['remote_addr']).encode('utf-8'), rv['hash']) + self.cache.set( + 'hash', (rv['email'] or rv['remote_addr']).encode('utf-8'), rv['hash']) for key in set(rv.keys()) - API.FIELDS: rv.pop(key) @@ -326,6 +329,7 @@ class API(object): "likes": 1 } """ + def view(self, environ, request, id): rv = self.comments.get(id) @@ -409,8 +413,9 @@ class API(object): self.signal("comments.edit", rv) cookie = functools.partial(dump_cookie, - value=self.isso.sign([rv["id"], sha1(rv["text"])]), - max_age=self.conf.getint('max-age')) + value=self.isso.sign( + [rv["id"], sha1(rv["text"])]), + max_age=self.conf.getint('max-age')) rv["text"] = self.isso.render(rv["text"]) @@ -454,7 +459,8 @@ class API(object): if item is None: raise NotFound - self.cache.delete('hash', (item['email'] or item['remote_addr']).encode('utf-8')) + self.cache.delete( + 'hash', (item['email'] or item['remote_addr']).encode('utf-8')) with self.isso.lock: rv = self.comments.delete(id) @@ -505,6 +511,7 @@ class API(object): @apiSuccessExample Using POST: Yo """ + def moderate(self, environ, request, id, action, key): try: id = self.isso.unsign(key, max_age=2**32) @@ -547,11 +554,11 @@ class API(object): else: with self.isso.lock: self.comments.delete(id) - self.cache.delete('hash', (item['email'] or item['remote_addr']).encode('utf-8')) + self.cache.delete( + 'hash', (item['email'] or item['remote_addr']).encode('utf-8')) self.signal("comments.delete", id) return Response("Yo", 200) - """ @api {get} / get comments @apiGroup Thread @@ -681,10 +688,10 @@ class API(object): return BadRequest("nested_limit should be integer") rv = { - 'id' : root_id, - 'total_replies' : reply_counts[root_id], - 'hidden_replies' : reply_counts[root_id] - len(root_list), - 'replies' : self._process_fetched_list(root_list, plain) + 'id': root_id, + 'total_replies': reply_counts[root_id], + 'hidden_replies': reply_counts[root_id] - len(root_list), + 'replies': self._process_fetched_list(root_list, plain) } # We are only checking for one level deep comments if root_id is None: @@ -705,7 +712,8 @@ class API(object): comment['total_replies'] = 0 replies = [] - comment['hidden_replies'] = comment['total_replies'] - len(replies) + comment['hidden_replies'] = comment['total_replies'] - \ + len(replies) comment['replies'] = self._process_fetched_list(replies, plain) return JSON(rv, 200) @@ -762,7 +770,8 @@ class API(object): @xhr def like(self, environ, request, id): - nv = self.comments.vote(True, id, utils.anonymize(str(request.remote_addr))) + nv = self.comments.vote( + True, id, utils.anonymize(str(request.remote_addr))) return JSON(nv, 200) """ @@ -788,7 +797,8 @@ class API(object): @xhr def dislike(self, environ, request, id): - nv = self.comments.vote(False, id, utils.anonymize(str(request.remote_addr))) + nv = self.comments.vote( + False, id, utils.anonymize(str(request.remote_addr))) return JSON(nv, 200) # TODO: remove someday (replaced by :func:`counts`) @@ -814,6 +824,7 @@ class API(object): @apiSuccessExample Counts of 5 threads: [2, 18, 4, 0, 3] """ + def counts(self, environ, request): data = request.get_json() @@ -838,10 +849,11 @@ class API(object): data = req.form password = self.isso.conf.get("general", "admin_password") if data['password'] and data['password'] == password: - response = redirect(get_current_url(env, host_only=True) + '/admin') + response = redirect(get_current_url( + env, host_only=True) + '/admin') cookie = functools.partial(dump_cookie, - value=self.isso.sign({"logged": True}), - expires=datetime.now() + timedelta(1)) + value=self.isso.sign({"logged": True}), + expires=datetime.now() + timedelta(1)) response.headers.add("Set-Cookie", cookie("admin-session")) response.headers.add("X-Set-Cookie", cookie("isso-admin-session")) return response diff --git a/isso/wsgi.py b/isso/wsgi.py index 1bad0f2..1788d47 100644 --- a/isso/wsgi.py +++ b/isso/wsgi.py @@ -136,11 +136,14 @@ class CORSMiddleware(object): headers = Headers(headers) headers.add("Access-Control-Allow-Origin", self.origin(environ)) headers.add("Access-Control-Allow-Credentials", "true") - headers.add("Access-Control-Allow-Methods", ", ".join(self.methods)) + headers.add("Access-Control-Allow-Methods", + ", ".join(self.methods)) if self.allowed: - headers.add("Access-Control-Allow-Headers", ", ".join(self.allowed)) + headers.add("Access-Control-Allow-Headers", + ", ".join(self.allowed)) if self.exposed: - headers.add("Access-Control-Expose-Headers", ", ".join(self.exposed)) + headers.add("Access-Control-Expose-Headers", + ", ".join(self.exposed)) return start_response(status, headers.to_list(), exc_info) if environ.get("REQUEST_METHOD") == "OPTIONS": From 0ff39017c6fab706a5e616f2a9a8645603ee4698 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Thu, 8 Feb 2018 22:54:02 +0100 Subject: [PATCH 54/78] drop wheezy testing which is EndOfLife (closes #385) --- .travis.yml | 2 -- tox.ini | 6 ------ 2 files changed, 8 deletions(-) diff --git a/.travis.yml b/.travis.yml index 8ff53a2..4cb97a4 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,8 +9,6 @@ matrix: env: TOX_ENV=py35 - python: 3.6 env: TOX_ENV=py36 - - python: 2.7 - env: TOX_ENV=wheezy install: - pip install -U pip - pip install flake8 tox diff --git a/tox.ini b/tox.ini index bb55662..4cc7c2c 100755 --- a/tox.ini +++ b/tox.ini @@ -21,9 +21,3 @@ deps= misaka==1.0.2 passlib==1.5.3 werkzeug==0.8.3 - -[testenv:wheezy] -basepython=python2.7 -deps = - {[testenv:py27]deps} - {[testenv:debian]deps} From 450291440fab0b9bdea222b09af17b69ab56a130 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Sat, 17 Feb 2018 00:00:15 +0100 Subject: [PATCH 55/78] update doc --- docs/docs/install.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/install.rst b/docs/docs/install.rst index 8ce4f8c..44d829f 100644 --- a/docs/docs/install.rst +++ b/docs/docs/install.rst @@ -39,10 +39,10 @@ package manager. .. code-block:: sh # for Debian/Ubuntu - ~> sudo apt-get install python-setuptools python-virtualenv + ~> sudo apt-get install python-setuptools python-virtualenv python-dev # Fedora/Red Hat - ~> sudo yum install python-setuptools python-virtualenv + ~> sudo yum install python-setuptools python-virtualenv python-devel The next steps should be done as regular user, not as root (although possible but not recommended): From 28e154acfcce72f21662140d8b421ad3b9e4d178 Mon Sep 17 00:00:00 2001 From: Facundo Batista Date: Wed, 21 Mar 2018 19:39:02 -0300 Subject: [PATCH 56/78] Small typo --- docs/docs/configuration/server.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.rst b/docs/docs/configuration/server.rst index cb39ccd..1a443f8 100644 --- a/docs/docs/configuration/server.rst +++ b/docs/docs/configuration/server.rst @@ -108,7 +108,7 @@ Enable moderation queue and handling of comments still in moderation queue enabled enable comment moderation queue. This option only affects new comments. - Comments in modertion queue are not visible to other users until you + Comments in moderation queue are not visible to other users until you activate them. purge-after From 361c596bf2d7f3b725d4ca3bd069dc683f3ac2c1 Mon Sep 17 00:00:00 2001 From: "Cimon Lucas (LCM)" Date: Wed, 21 Feb 2018 18:54:48 +0100 Subject: [PATCH 57/78] Adding support for ISSO_CORS_ORIGIN env variable to allow defining wildcard CORS origins --- isso/wsgi.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/isso/wsgi.py b/isso/wsgi.py index 1788d47..60c1a58 100644 --- a/isso/wsgi.py +++ b/isso/wsgi.py @@ -84,6 +84,8 @@ def origin(hosts): hosts = [urlsplit(h) for h in hosts] def func(environ): + if 'ISSO_CORS_ORIGIN' in environ: + return environ['ISSO_CORS_ORIGIN'] if not hosts: return "http://invalid.local" From 73c7933548fa9ea4d64a6a159d39af001cfdde2d Mon Sep 17 00:00:00 2001 From: Yuchen Pei Date: Mon, 2 Apr 2018 23:02:45 +0200 Subject: [PATCH 58/78] A quick dirty fix of #401 (#406) Fix URL in moderation mails if isso runs in a sub-URL (closes #401 ) --- isso/ext/notifications.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/isso/ext/notifications.py b/isso/ext/notifications.py index 80e1504..2b4a81c 100644 --- a/isso/ext/notifications.py +++ b/isso/ext/notifications.py @@ -37,6 +37,12 @@ class SMTP(object): self.isso = isso self.conf = isso.conf.section("smtp") + gh = isso.conf.get("general", "host") + if type(gh) == str: + self.general_host = gh + #if gh is not a string then gh is a list + else: + self.general_host = gh[0] # test SMTP connectivity try: @@ -109,7 +115,7 @@ class SMTP(object): (local("origin") + thread["uri"] + "#isso-%i" % comment["id"])) rv.write("\n") - uri = local("host") + "/id/%i" % comment["id"] + uri = self.general_host + "/id/%i" % comment["id"] key = self.isso.sign(comment["id"]) rv.write("---\n") From 4e2d2dfb204d1c70bfdf4000cdaf2546d9adad32 Mon Sep 17 00:00:00 2001 From: Rocka Date: Thu, 5 Apr 2018 22:46:17 +0800 Subject: [PATCH 59/78] i18n: add space between number and CJK character --- isso/js/app/i18n/zh_CN.js | 16 ++++++++-------- isso/js/app/i18n/zh_TW.js | 18 +++++++++--------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/isso/js/app/i18n/zh_CN.js b/isso/js/app/i18n/zh_CN.js index b9d4582..9c33957 100644 --- a/isso/js/app/i18n/zh_CN.js +++ b/isso/js/app/i18n/zh_CN.js @@ -1,11 +1,11 @@ define({ - "postbox-text": "在此输入评论 (最少3个字符)", + "postbox-text": "在此输入评论 (最少 3 个字符)", "postbox-author": "名字 (可选)", "postbox-email": "E-mail (可选)", "postbox-website": "网站 (可选)", "postbox-submit": "提交", - "num-comments": "1条评论\n{{ n }}条评论", + "num-comments": "1 条评论\n{{ n }} 条评论", "no-comments": "还没有评论", "comment-reply": "回复", @@ -21,10 +21,10 @@ define({ "comment-hidden": "{{ n }} 条评论已隐藏", "date-now": "刚刚", - "date-minute": "1分钟前\n{{ n }}分钟前", - "date-hour": "1小时前\n{{ n }}小时前", - "date-day": "昨天\n{{ n }}天前", - "date-week": "上周\n{{ n }}周前", - "date-month": "上个月\n{{ n }}个月前", - "date-year": "去年\n{{ n }}年前" + "date-minute": "1 分钟前\n{{ n }} 分钟前", + "date-hour": "1 小时前\n{{ n }} 小时前", + "date-day": "昨天\n{{ n }} 天前", + "date-week": "上周\n{{ n }} 周前", + "date-month": "上个月\n{{ n }} 个月前", + "date-year": "去年\n{{ n }} 年前" }); diff --git a/isso/js/app/i18n/zh_TW.js b/isso/js/app/i18n/zh_TW.js index 9bb59fa..68ad370 100644 --- a/isso/js/app/i18n/zh_TW.js +++ b/isso/js/app/i18n/zh_TW.js @@ -1,11 +1,11 @@ define({ - "postbox-text": "在此輸入留言（至少3個字元）", + "postbox-text": "在此輸入留言（至少 3 個字元）", "postbox-author": "名稱 (非必填)", "postbox-email": "電子信箱 (非必填)", "postbox-website": "個人網站 (非必填)", "postbox-submit": "送出", - "num-comments": "1則留言\n{{ n }}則留言", + "num-comments": "1 則留言\n{{ n }} 則留言", "no-comments": "尚無留言", "comment-reply": "回覆", @@ -18,13 +18,13 @@ define({ "comment-deleted": "留言已刪", "comment-queued": "留言待審", "comment-anonymous": "匿名", - "comment-hidden": "{{ n }}則隱藏留言", + "comment-hidden": "{{ n }} 則隱藏留言", "date-now": "剛剛", - "date-minute": "1分鐘前\n{{ n }}分鐘前", - "date-hour": "1小時前\n{{ n }}小時前", - "date-day": "昨天\n{{ n }}天前", - "date-week": "上週\n{{ n }}週前", - "date-month": "上個月\n{{ n }}個月前", - "date-year": "去年\n{{ n }}年前" + "date-minute": "1 分鐘前\n{{ n }} 分鐘前", + "date-hour": "1 小時前\n{{ n }} 小時前", + "date-day": "昨天\n{{ n }} 天前", + "date-week": "上週\n{{ n }} 週前", + "date-month": "上個月\n{{ n }} 個月前", + "date-year": "去年\n{{ n }} 年前" }); From 30fef390f55fd8c23ade69c54a0357a46945ac18 Mon Sep 17 00:00:00 2001 From: Rocka Date: Thu, 5 Apr 2018 23:10:46 +0800 Subject: [PATCH 60/78] fix: admin and demo view redirect issue --- isso/views/comments.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/isso/views/comments.py b/isso/views/comments.py index d3b80c3..bfebb3f 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -843,14 +843,19 @@ class API(object): return JSON({'text': self.isso.render(data["text"])}, 200) def demo(self, env, req): - return redirect(get_current_url(env) + '/index.html') + return redirect( + get_current_url(env, strip_querystring=True) + '/index.html' + ) def login(self, env, req): data = req.form password = self.isso.conf.get("general", "admin_password") if data['password'] and data['password'] == password: - response = redirect(get_current_url( - env, host_only=True) + '/admin') + response = redirect(re.sub( + r'/login$', + '/admin', + get_current_url(env, strip_querystring=True) + )) cookie = functools.partial(dump_cookie, value=self.isso.sign({"logged": True}), expires=datetime.now() + timedelta(1)) From 2b7c17a361492853fe86b0ce2f66515f100efec3 Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Mon, 16 Apr 2018 20:43:54 +0200 Subject: [PATCH 61/78] Provide a multi-staged Dockerfile Many of the Docker images on hub.docker.com are outdated. The one specified in the documentation doesn't exist anymore. We provide a decent Dockerfile to build our own Docker image. This uses a multi-stage build to avoid polluting the final image with the intermediate artifacts. The final image is 155 MB. It should be possible to squeeze it even more by using Alpine Linux for the last two parts instead of Stretch. The service is using gunicorn. The user is expected to complete the installation with a reverse proxy configuration. --- Dockerfile | 33 +++++++++++++++++++++++++++++++++ docs/docs/install.rst | 13 ++++++++++++- 2 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 Dockerfile diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..3a8203c --- /dev/null +++ b/Dockerfile @@ -0,0 +1,33 @@ +# First, compile JS stuff +FROM node +WORKDIR /src/ +COPY . . +RUN npm install -g requirejs uglify-js jade bower +RUN make init js + +# Second, create virtualenv +FROM python:3-stretch +WORKDIR /src/ +COPY --from=0 /src . +RUN apt-get -qqy update && apt-get -qqy install python3-dev sqlite3 +RUN python3 -m venv /isso \ + && . /isso/bin/activate \ + && python setup.py install \ + && pip install gunicorn + +# Third, create final repository +FROM python:3-slim-stretch +WORKDIR /isso/ +COPY --from=1 /isso . + +# Configuration +VOLUME /db /config +EXPOSE 8080 +ENV ISSO_SETTINGS /config/isso.cfg +CMD ["/isso/bin/gunicorn", "-b", "0.0.0.0:8080", "-w", "4", "--preload", "isso.run"] + +# Example of use: +# +# docker build -t isso . +# docker run -it --rm -v /opt/isso:/config -v /opt/isso:/db -v $PWD:$PWD isso /isso/bin/isso -c \$ISSO_SETTINGS import disqus.xml +# docker run -d --rm --name isso -p 8080:8080 -v /opt/isso:/config -v /opt/isso:/db isso diff --git a/docs/docs/install.rst b/docs/docs/install.rst index 44d829f..eb2ef35 100644 --- a/docs/docs/install.rst +++ b/docs/docs/install.rst @@ -149,7 +149,18 @@ Prebuilt Packages * Fedora: https://copr.fedoraproject.org/coprs/jujens/isso/ — copr repository. Built from Pypi, includes a systemctl unit script. -* Docker Image: https://registry.hub.docker.com/u/bl4n/isso/ +Build a Docker image +-------------------- + +You can get a Docker image by running ``docker build . -t +isso``. Assuming you have your configuration in ``/opt/isso``, you can +use the following command to spawn the Docker container: + +.. code-block:: sh + + ~> docker run -d --rm --name isso -p 127.0.0.1:8080:8080 -v /opt/isso:/config -v /opt/isso:/db isso + +Then, you can use a reverse proxy to expose port 8080. Install from Source ------------------- From 30f0c7eeb895163339d3515fc15f6d408137fee6 Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Tue, 17 Apr 2018 07:03:54 +0200 Subject: [PATCH 62/78] docs: document data-isso-id --- docs/docs/configuration/client.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/docs/configuration/client.rst b/docs/docs/configuration/client.rst index 14f0c86..9328357 100644 --- a/docs/docs/configuration/client.rst +++ b/docs/docs/configuration/client.rst @@ -7,6 +7,7 @@ preferably in the script tag which embeds the JS: .. code-block:: html Furthermore you can override the automatic title detection inside -the embed tag, e.g.: +the embed tag, as well as the thread ID, e.g.: .. code-block:: html -
+
data-isso --------- From 9618c0f3a3a8fb2f29096e88ac904a3a31ad5916 Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Tue, 17 Apr 2018 22:32:16 +0200 Subject: [PATCH 63/78] jade: avoid using eval once compiled Use of eval is handy when we need to automatically reload a template. However, in production, this is slow and unsafe. Moreover, when using CSP, we have to use 'unsafe-eval' which brings shame to most of us. It appears use of eval() is not needed because the template has already been translated to Javascript. We just need to bind "jade" to its local scope. So, we add an additional wrapper function binding "jade" to the local scope. Moreover, when compiling the template, we add a flag to the function to know it has already been compiled. In this case, we execute it with "jade" in its scope. Otherwise, we keep using eval. Quickly tested in both situations. Seem to work. Fix #274. --- isso/js/app/jade.js | 3 +++ isso/js/lib/requirejs-jade/jade.js | 8 ++++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/isso/js/app/jade.js b/isso/js/app/jade.js index 46d6269..0064d60 100644 --- a/isso/js/app/jade.js +++ b/isso/js/app/jade.js @@ -7,6 +7,9 @@ define(["libjs-jade-runtime", "app/utils", "jade!app/text/postbox", "jade!app/te var load = function(name, js) { templates[name] = (function(jade) { var fn; + if (js.compiled) { + return js(jade); + } eval("fn = " + js); return fn; })(runtime); diff --git a/isso/js/lib/requirejs-jade/jade.js b/isso/js/lib/requirejs-jade/jade.js index 59189a4..383d3f5 100644 --- a/isso/js/lib/requirejs-jade/jade.js +++ b/isso/js/lib/requirejs-jade/jade.js @@ -49,8 +49,12 @@ define(function() { write: function(plugin, name, write) { if (builds.hasOwnProperty(name)) { write("define('" + plugin + "!" + name +"', function () {" + - " var fn = " + builds[name] + ";" + - " return fn;" + + " var wfn = function (jade) {" + + " var fn = " + builds[name] + ";" + + " return fn;" + + " };" + + "wfn.compiled = true;" + + "return wfn;" + "});\n"); } } From 93ea72299241c594d9cd17ebb4ed6c775bb5a90d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Tue, 17 Apr 2018 23:47:06 +0200 Subject: [PATCH 64/78] add contributors --- CHANGES.rst | 7 +++++-- CONTRIBUTORS.txt | 23 ++++++++++++++++++++++- docs/contribute.rst | 2 -- 3 files changed, 27 insertions(+), 5 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 2b290a6..5365c2e 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,7 +4,8 @@ Changelog for Isso 0.10.7 (unreleased) ------------------- -- Fix Chinese translation +- Fix Chinese translation & typo in CJK +- Fix link in moderation mails if isso is setup on a sub-url (e.g. domain.tld/comments/) - Add Danish translation - Add Hungarian translation - Add Persian translation @@ -12,7 +13,9 @@ Changelog for Isso - Add links highlighting in comments - Add apidoc - Add rc.d script for FreeBSD -- Some tests/travis/documentation improvements and fixes +- Add the possibility to set CORS Origin through ISSO_CORS_ORIGIN environ variable +- Some tests/travis/documentation improvements and fixes + pep8 +- Improvement on german translation 0.10.6 (2016-09-22) diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 0b5e649..db7dd27 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -51,12 +51,33 @@ In chronological order: * Added configuration to require email addresses (no validation) * Fix Vagrantfile -* Benoît Latinier +* Benoît Latinier @blatinier * Fix thread discovery * Added mandatory author + * Added admin interface * Ivan Pantic * Added vote levels +* Martin Schenck @schemar + * Improvement in the german translation + +* @cclauss + * Pep8 and drop of legacy supports (old python & debian version tested in travis) + * Make travis use pyflakes + +* Lucas Cimon @Lucas-C + * Added the possibility to define CORS origins through ISSO_CORS_ORIGIN environment variable + +* Yuchen Pei @ycpei + * Fix link in moderation emails when isso is installed in a sub URL + +* @Rocket1184 + * Fix typo in CJK translations + +* @vincentbernat + * Added documentation about data-isso-id attribute (overriding the standard isso-thread-id) + * Added multi-staged Dockerfile + * [Your name or handle] <[email or website]> * [Brief summary of your changes] diff --git a/docs/contribute.rst b/docs/contribute.rst index 8a3886d..c349a47 100644 --- a/docs/contribute.rst +++ b/docs/contribute.rst @@ -59,5 +59,3 @@ definitely need help: - delete or activate comments matching a filter (e.g. name, email, ip address) - close threads and remove threads completely - - - edit comments From 07ce742b7798a1140abcb292aebecd31ff242ac5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Wed, 18 Apr 2018 10:51:17 +0200 Subject: [PATCH 65/78] add documentation for uberspaces users (closes #409) --- CONTRIBUTORS.txt | 3 +++ docs/docs/troubleshooting.rst | 6 ++++++ 2 files changed, 9 insertions(+) diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index db7dd27..ad1fc1e 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -79,5 +79,8 @@ In chronological order: * Added documentation about data-isso-id attribute (overriding the standard isso-thread-id) * Added multi-staged Dockerfile +* @p-vitt & @M4a1x + * Documentation on troubleshooting for uberspace users + * [Your name or handle] <[email or website]> * [Brief summary of your changes] diff --git a/docs/docs/troubleshooting.rst b/docs/docs/troubleshooting.rst index 20ee8dd..a395a0a 100644 --- a/docs/docs/troubleshooting.rst +++ b/docs/docs/troubleshooting.rst @@ -1,6 +1,12 @@ Troubleshooting =============== +For uberspace users +------------------- +Some uberspace users experienced problems with isso and they solved their +issue by adding `DirectoryIndex disabled` as the first line in the `.htaccess` +file for the domain the isso server is running on. + pkg_ressources.DistributionNotFound ----------------------------------- From fcf576dd084f38f3c5fcb78f6fd8bd8565cb08bc Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Fri, 20 Apr 2018 20:11:32 +0200 Subject: [PATCH 66/78] css: remove CSS code for avatar in postbox It has been removed in 0211322915be. --- isso/css/isso.css | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/isso/css/isso.css b/isso/css/isso.css index 47cf675..abfc805 100644 --- a/isso/css/isso.css +++ b/isso/css/isso.css @@ -32,22 +32,13 @@ .isso-follow-up .isso-comment { border-top: 1px solid rgba(0, 0, 0, 0.1); } -.isso-comment > div.avatar, -.isso-postbox > .avatar { +.isso-comment > div.avatar { display: block; float: left; width: 7%; margin: 3px 15px 0 0; } -.isso-postbox > .avatar { - float: left; - margin: 5px 10px 0 5px; - width: 48px; - height: 48px; - overflow: hidden; -} -.isso-comment > div.avatar > svg, -.isso-postbox > .avatar > svg { +.isso-comment > div.avatar > svg { max-width: 48px; max-height: 48px; border: 1px solid rgba(0, 0, 0, 0.2); From 8d8f9c8c59ad2960c25bb895e73b8dcbcb5020ed Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Sat, 21 Apr 2018 10:25:12 +0200 Subject: [PATCH 67/78] html: add nofollow/noopener to links "nofollow" is a deterrent for spammers: they cannot put links and hope to increase their SEO when all these links have the nofollow relationship. "noopener" is a security for links opening a new window. They ensure the target cannot control us. Fix #373 --- isso/tests/test_html.py | 4 ++-- isso/utils/html.py | 5 +++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/isso/tests/test_html.py b/isso/tests/test_html.py index 316fbf8..327357c 100644 --- a/isso/tests/test_html.py +++ b/isso/tests/test_html.py @@ -65,7 +65,7 @@ class TestHTML(unittest.TestCase): examples = [ ('Look: ', 'Look: '), ('Ha', - 'Ha'), + 'Ha'), ('Ha', 'Ha'), ('

Test

', '

Test

'), ('', 'alert("Onoe")')] @@ -93,4 +93,4 @@ class TestHTML(unittest.TestCase): }) renderer = html.Markup(conf.section("markup")).render self.assertEqual(renderer("http://example.org/ and sms:+1234567890"), - '

http://example.org/ and sms:+1234567890

') + '

http://example.org/ and sms:+1234567890

') diff --git a/isso/utils/html.py b/isso/utils/html.py index fca3c7e..1f5f8cd 100644 --- a/isso/utils/html.py +++ b/isso/utils/html.py @@ -50,6 +50,11 @@ def sanitize(tokenizer, document): if HTML5LIB_VERSION > HTML5LIB_SIMPLETREE: builder = "etree" + + for link in domtree.findall(".//{http://www.w3.org/1999/xhtml}a"): + if link.get('href', None): + link.set("rel", "nofollow noopener") + else: builder = "simpletree" From ebca06059aef40c09485ecbabc6f012cea9d3634 Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Sat, 21 Apr 2018 14:46:32 +0200 Subject: [PATCH 68/78] api: add /feed API to get an Atom feed for an URI We need absolute URL at some places. We assume the first host configured is the base of the URI we have. Fix #81 --- docs/docs/extras/api.rst | 13 +++++ isso/db/comments.py | 6 +- isso/utils/__init__.py | 7 +++ isso/views/comments.py | 120 ++++++++++++++++++++++++++++++++++++++- 4 files changed, 143 insertions(+), 3 deletions(-) diff --git a/docs/docs/extras/api.rst b/docs/docs/extras/api.rst index 348a256..bcb374b 100644 --- a/docs/docs/extras/api.rst +++ b/docs/docs/extras/api.rst @@ -185,3 +185,16 @@ uri : returns an integer +Get Atom feed +------------- + +Get an Atom feed of comments for thread `uri`: + +.. code-block:: text + + GET /feed?uri=%2Fhello-world%2F + +uri : + URI to get comments for, required. + +Returns an XML document as the Atom feed. diff --git a/isso/db/comments.py b/isso/db/comments.py index 0f359a3..71a4aa5 100644 --- a/isso/db/comments.py +++ b/isso/db/comments.py @@ -159,7 +159,8 @@ class Comments: for item in rv: yield dict(zip(fields_comments + fields_threads, item)) - def fetch(self, uri, mode=5, after=0, parent='any', order_by='id', limit=None): + def fetch(self, uri, mode=5, after=0, parent='any', + order_by='id', asc=1, limit=None): """ Return comments for :param:`uri` with :param:`mode`. """ @@ -181,7 +182,8 @@ class Comments: order_by = 'id' sql.append('ORDER BY ') sql.append(order_by) - sql.append(' ASC') + if not asc: + sql.append(' DESC') if limit: sql.append('LIMIT ?') diff --git a/isso/utils/__init__.py b/isso/utils/__init__.py index a0a07bc..254aab1 100644 --- a/isso/utils/__init__.py +++ b/isso/utils/__init__.py @@ -132,3 +132,10 @@ class JSONResponse(Response): kwargs["content_type"] = "application/json" super(JSONResponse, self).__init__( json.dumps(obj).encode("utf-8"), *args, **kwargs) + + +class XMLResponse(Response): + def __init__(self, obj, *args, **kwargs): + kwargs["content_type"] = "text/xml" + super(XMLResponse, self).__init__( + obj, *args, **kwargs) diff --git a/isso/views/comments.py b/isso/views/comments.py index d3b80c3..ddc2b09 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -9,6 +9,7 @@ import functools from datetime import datetime, timedelta from itsdangerous import SignatureExpired, BadSignature +from xml.etree import ElementTree as ET from werkzeug.http import dump_cookie from werkzeug.wsgi import get_current_url @@ -20,11 +21,21 @@ from werkzeug.exceptions import BadRequest, Forbidden, NotFound from isso.compat import text_type as str from isso import utils, local -from isso.utils import (http, parse, JSONResponse as JSON, +from isso.utils import (http, parse, + JSONResponse as JSON, XMLResponse as XML, render_template) from isso.views import requires from isso.utils.hash import sha1 +try: + from urlparse import urlparse +except ImportError: + from urllib.parse import urlparse +try: + from StringIO import StringIO +except ImportError: + from io import BytesIO as StringIO + # from Django appearently, looks good to me *duck* __url_re = re.compile( r'^' @@ -91,6 +102,7 @@ class API(object): ('new', ('POST', '/new')), ('count', ('GET', '/count')), ('counts', ('POST', '/count')), + ('feed', ('GET', '/feed')), ('view', ('GET', '/id/')), ('edit', ('PUT', '/id/')), ('delete', ('DELETE', '/id/')), @@ -834,6 +846,112 @@ class API(object): return JSON(self.comments.count(*data), 200) + """ + @api {get} /feed Atom feed for comments + @apiGroup Thread + @apiDescription + Provide an Atom feed for the given thread. + """ + @requires(str, 'uri') + def feed(self, environ, request, uri): + args = { + 'uri': uri, + 'order_by': 'id', + 'asc': 0, + 'limit': 100 + } + try: + args['limit'] = max(int(request.args.get('limit')), args['limit']) + except TypeError: + pass + except ValueError: + return BadRequest("limit should be integer") + comments = self.comments.fetch(**args) + base = self.conf.get('host').split()[0] + hostname = urlparse(base).netloc + + # Let's build an Atom feed. + # RFC 4287: https://tools.ietf.org/html/rfc4287 + # RFC 4685: https://tools.ietf.org/html/rfc4685 (threading extensions) + # For IDs: http://web.archive.org/web/20110514113830/http://diveintomark.org/archives/2004/05/28/howto-atom-id + feed = ET.Element('feed', { + 'xmlns': 'http://www.w3.org/2005/Atom', + 'xmlns:thr': 'http://purl.org/syndication/thread/1.0' + }) + + # For feed ID, we would use thread ID, but we may not have + # one. Therefore, we use the URI. We don't have a year + # either... + id = ET.SubElement(feed, 'id') + id.text = 'tag:{hostname},2018:/isso/thread{uri}'.format( + hostname=hostname, uri=uri) + + # For title, we don't have much either. Be pretty generic. + title = ET.SubElement(feed, 'title') + title.text = 'Comments for {hostname}{uri}'.format( + hostname=hostname, uri=uri) + + comment0 = None + + for comment in comments: + if comment0 is None: + comment0 = comment + + entry = ET.SubElement(feed, 'entry') + # We don't use a real date in ID either to help with + # threading. + id = ET.SubElement(entry, 'id') + id.text = 'tag:{hostname},2018:/isso/{tid}/{id}'.format( + hostname=hostname, + tid=comment['tid'], + id=comment['id']) + title = ET.SubElement(entry, 'title') + title.text = 'Comment #{}'.format(comment['id']) + updated = ET.SubElement(entry, 'updated') + updated.text = '{}Z'.format(datetime.fromtimestamp( + comment['modified'] or comment['created']).isoformat()) + author = ET.SubElement(entry, 'author') + name = ET.SubElement(author, 'name') + name.text = comment['author'] + ET.SubElement(entry, 'link', { + 'href': '{base}{uri}#isso-{id}'.format( + base=base, + uri=uri, id=comment['id']) + }) + content = ET.SubElement(entry, 'content', { + 'type': 'html', + }) + content.text = comment['text'] + + if comment['parent']: + ET.SubElement(entry, 'thr:in-reply-to', { + 'ref': 'tag:{hostname},2018:/isso/{tid}/{id}'.format( + hostname=hostname, + tid=comment['tid'], + id=comment['parent']), + 'href': '{base}{uri}#isso-{id}'.format( + base=base, + uri=uri, id=comment['parent']) + }) + + # Updated is mandatory. If we have comments, we use the date + # of last modification of the first one (which is the last + # one). Otherwise, we use a fixed date. + updated = ET.Element('updated') + if comment0 is None: + updated.text = '1970-01-01T01:00:00Z' + else: + updated.text = datetime.fromtimestamp( + comment0['modified'] or comment0['created']).isoformat() + updated.text += 'Z' + feed.insert(0, updated) + + output = StringIO() + ET.ElementTree(feed).write(output, + encoding='utf-8', + xml_declaration=True) + return XML(output.getvalue(), 200) + def preview(self, environment, request): data = request.get_json() From 5c6e78b9c14a41a3fff9c77b1d952ced962c1622 Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Sun, 22 Apr 2018 12:17:31 +0200 Subject: [PATCH 69/78] api: ensure /feed is easily cacheable by issuing etag/last-modified headers --- isso/views/comments.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/isso/views/comments.py b/isso/views/comments.py index ddc2b09..120fef3 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -950,7 +950,16 @@ class API(object): ET.ElementTree(feed).write(output, encoding='utf-8', xml_declaration=True) - return XML(output.getvalue(), 200) + response = XML(output.getvalue(), 200) + + # Add an etag/last-modified value for caching purpose + if comment0 is None: + response.set_etag('empty') + response.last_modified = 0 + else: + response.set_etag('{tid}-{id}'.format(**comment0)) + response.last_modified = comment0['modified'] or comment0['created'] + return response.make_conditional(request) def preview(self, environment, request): data = request.get_json() From a89debbc9cb136339585db59829907eed99db68f Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Sun, 22 Apr 2018 12:38:51 +0200 Subject: [PATCH 70/78] api: add a simple test for /feed endpoint --- isso/tests/test_comments.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/isso/tests/test_comments.py b/isso/tests/test_comments.py index cc27ae8..a58ae62 100644 --- a/isso/tests/test_comments.py +++ b/isso/tests/test_comments.py @@ -4,6 +4,7 @@ from __future__ import unicode_literals import os import json +import re import tempfile import unittest @@ -30,6 +31,7 @@ class TestComments(unittest.TestCase): fd, self.path = tempfile.mkstemp() conf = config.load(os.path.join(dist.location, "share", "isso.conf")) conf.set("general", "dbpath", self.path) + conf.set("general", "host", "https://example.org") conf.set("guard", "enabled", "off") conf.set("hash", "algorithm", "none") @@ -324,6 +326,28 @@ class TestComments(unittest.TestCase): self.assertListEqual(list(rv.keys()), []) + def testFeedEmpty(self): + rv = self.get('/feed?uri=%2Fpath%2Fnothing') + self.assertEqual(rv.status_code, 200) + self.assertEqual(rv.headers['ETag'], '"empty"') + data = rv.data.decode('utf-8') + self.assertEqual(data, """ +1970-01-01T01:00:00Ztag:example.org,2018:/isso/thread/path/nothingComments for example.org/path/nothing""") + + def testFeed(self): + self.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'First'})) + self.post('/new?uri=%2Fpath%2F', + data=json.dumps({'text': 'First', 'parent': 1})) + + rv = self.get('/feed?uri=%2Fpath%2F') + self.assertEqual(rv.status_code, 200) + self.assertEqual(rv.headers['ETag'], '"1-2"') + data = rv.data.decode('utf-8') + data = re.sub('[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]+Z', + '2018-04-01T10:00:00Z', data) + self.assertEqual(data, """ +2018-04-01T10:00:00Ztag:example.org,2018:/isso/thread/path/Comments for example.org/path/tag:example.org,2018:/isso/1/2Comment #22018-04-01T10:00:00ZFirsttag:example.org,2018:/isso/1/1Comment #12018-04-01T10:00:00ZFirst""") + def testCounts(self): self.assertEqual(self.get('/count?uri=%2Fpath%2F').status_code, 404) From bceb69518b587a51e0a268fda770df35e46a6960 Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Sun, 22 Apr 2018 13:00:22 +0200 Subject: [PATCH 71/78] js: put a link to Atom feed on top of the main postbox --- isso/css/isso.css | 11 +++++++++++ isso/js/app/api.js | 7 ++++++- isso/js/app/i18n/en.js | 1 + isso/js/app/i18n/fr.js | 1 + isso/js/embed.js | 5 +++++ 5 files changed, 24 insertions(+), 1 deletion(-) diff --git a/isso/css/isso.css b/isso/css/isso.css index 47cf675..2a55658 100644 --- a/isso/css/isso.css +++ b/isso/css/isso.css @@ -15,6 +15,14 @@ color: #555; font-weight: bold; } +#isso-thread > .isso-feedlink { + float: right; + padding-left: 1em; +} +#isso-thread > .isso-feedlink > a { + font-size: 0.8em; + vertical-align: bottom; +} #isso-thread .textarea { min-height: 58px; outline: 0; @@ -119,10 +127,12 @@ color: gray !important; clear: left; } +.isso-feedlink, .isso-comment > div.text-wrapper > .isso-comment-footer a { font-weight: bold; text-decoration: none; } +.isso-feedlink:hover, .isso-comment > div.text-wrapper > .isso-comment-footer a:hover { color: #111111 !important; text-shadow: #aaaaaa 0 0 1px !important; @@ -152,6 +162,7 @@ .isso-postbox { max-width: 68em; margin: 0 auto 2em; + clear: right; } .isso-postbox > .form-wrapper { display: block; diff --git a/isso/js/app/api.js b/isso/js/app/api.js index d0fbf2f..30cca9c 100644 --- a/isso/js/app/api.js +++ b/isso/js/app/api.js @@ -191,6 +191,10 @@ define(["app/lib/promise", "app/globals"], function(Q, globals) { return deferred.promise; }; + var feed = function(tid) { + return endpoint + "/feed?" + qs({uri: tid || location}); + } + return { endpoint: endpoint, salt: salt, @@ -202,6 +206,7 @@ define(["app/lib/promise", "app/globals"], function(Q, globals) { fetch: fetch, count: count, like: like, - dislike: dislike + dislike: dislike, + feed: feed }; }); diff --git a/isso/js/app/i18n/en.js b/isso/js/app/i18n/en.js index ec4b4d0..d3968b8 100644 --- a/isso/js/app/i18n/en.js +++ b/isso/js/app/i18n/en.js @@ -7,6 +7,7 @@ define({ "num-comments": "One Comment\n{{ n }} Comments", "no-comments": "No Comments Yet", + "atom-feed": "Atom feed", "comment-reply": "Reply", "comment-edit": "Edit", diff --git a/isso/js/app/i18n/fr.js b/isso/js/app/i18n/fr.js index e29d024..f65cc6a 100644 --- a/isso/js/app/i18n/fr.js +++ b/isso/js/app/i18n/fr.js @@ -6,6 +6,7 @@ define({ "postbox-submit": "Soumettre", "num-comments": "{{ n }} commentaire\n{{ n }} commentaires", "no-comments": "Aucun commentaire pour l'instant", + "atom-feed": "Flux Atom", "comment-reply": "Répondre", "comment-edit": "Éditer", "comment-save": "Enregistrer", diff --git a/isso/js/embed.js b/isso/js/embed.js index 680880b..715413c 100644 --- a/isso/js/embed.js +++ b/isso/js/embed.js @@ -27,6 +27,11 @@ require(["app/lib/ready", "app/config", "app/i18n", "app/api", "app/isso", "app/ return console.log("abort, #isso-thread is missing"); } + var feedLink = $.new('a', i18n.translate('atom-feed')); + var feedLinkWrapper = $.new('span.isso-feedlink'); + feedLink.href = api.feed($("#isso-thread").getAttribute("data-isso-id")); + feedLinkWrapper.append(feedLink); + $("#isso-thread").append(feedLinkWrapper); $("#isso-thread").append($.new('h4')); $("#isso-thread").append(new isso.Postbox(null)); $("#isso-thread").append('
'); From 45f6b1eda382f431d75a27e6bccf6b0fc9b9d240 Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Sun, 22 Apr 2018 16:55:06 +0200 Subject: [PATCH 72/78] feed: make /feed API call configurable server and client-side On server-side, this can be enabled by providing a base URL to use to build the full URL. Limit also becomes configurable. On client-side, we need to add a switch to know whatever or not the additional link can be displayed. --- docs/docs/configuration/client.rst | 10 +++++++++- docs/docs/configuration/server.rst | 21 +++++++++++++++++++++ isso/js/app/config.js | 3 ++- isso/js/embed.js | 12 +++++++----- isso/tests/test_comments.py | 10 +++++++++- isso/views/comments.py | 8 ++++++-- share/isso.conf | 12 ++++++++++++ 7 files changed, 66 insertions(+), 10 deletions(-) diff --git a/docs/docs/configuration/client.rst b/docs/docs/configuration/client.rst index 9328357..779f47e 100644 --- a/docs/docs/configuration/client.rst +++ b/docs/docs/configuration/client.rst @@ -20,7 +20,8 @@ preferably in the script tag which embeds the JS: data-isso-avatar-bg="#f0f0f0" data-isso-avatar-fg="#9abf88 #5698c4 #e279a3 #9163b6 ..." data-isso-vote="true" - data-vote-levels="" + data-isso-vote-levels="" + data-isso-feed="false" src="/prefix/js/embed.js"> Furthermore you can override the automatic title detection inside @@ -125,3 +126,10 @@ For example, the value `"-5,5"` will cause each `isso-comment` to be given one o - `isso-vote-level-2` for scores of `5` and greater These classes can then be used to customize the appearance of comments (eg. put a star on popular comments) + +data-isso-feed +-------------- + +Enable or disable the addition of a link to the feed for the comment +thread. The link will only be valid if the appropriate setting, in +``[rss]`` section, is also enabled server-side. diff --git a/docs/docs/configuration/server.rst b/docs/docs/configuration/server.rst index 1a443f8..5327c96 100644 --- a/docs/docs/configuration/server.rst +++ b/docs/docs/configuration/server.rst @@ -308,6 +308,27 @@ algorithm Arguments have to be in that order, but can be reduced to `pbkdf2:4096` for example to override the iterations only. +.. _configure-rss: + +RSS +--- + +Isso can provide an Atom feed for each comment thread. Users can use +them to subscribe to comments and be notified of changes. Atom feeds +are enabled as soon as there is a base URL defined in this section. + +.. code-block:: ini + + [rss] + base = + limit = 100 + +base + base URL to use to build complete URI to pages (by appending the URI from Isso) + +limit + number of most recent comments to return for a thread + Appendum -------- diff --git a/isso/js/app/config.js b/isso/js/app/config.js index 952d588..258da6d 100644 --- a/isso/js/app/config.js +++ b/isso/js/app/config.js @@ -15,7 +15,8 @@ define(function() { "avatar-fg": ["#9abf88", "#5698c4", "#e279a3", "#9163b6", "#be5168", "#f19670", "#e4bf80", "#447c69"].join(" "), "vote": true, - "vote-levels": null + "vote-levels": null, + "feed": false }; var js = document.getElementsByTagName("script"); diff --git a/isso/js/embed.js b/isso/js/embed.js index 715413c..a0a53da 100644 --- a/isso/js/embed.js +++ b/isso/js/embed.js @@ -27,11 +27,13 @@ require(["app/lib/ready", "app/config", "app/i18n", "app/api", "app/isso", "app/ return console.log("abort, #isso-thread is missing"); } - var feedLink = $.new('a', i18n.translate('atom-feed')); - var feedLinkWrapper = $.new('span.isso-feedlink'); - feedLink.href = api.feed($("#isso-thread").getAttribute("data-isso-id")); - feedLinkWrapper.append(feedLink); - $("#isso-thread").append(feedLinkWrapper); + if (config["feed"]) { + var feedLink = $.new('a', i18n.translate('atom-feed')); + var feedLinkWrapper = $.new('span.isso-feedlink'); + feedLink.href = api.feed($("#isso-thread").getAttribute("data-isso-id")); + feedLinkWrapper.append(feedLink); + $("#isso-thread").append(feedLinkWrapper); + } $("#isso-thread").append($.new('h4')); $("#isso-thread").append(new isso.Postbox(null)); $("#isso-thread").append('
'); diff --git a/isso/tests/test_comments.py b/isso/tests/test_comments.py index a58ae62..4ba67c8 100644 --- a/isso/tests/test_comments.py +++ b/isso/tests/test_comments.py @@ -31,9 +31,9 @@ class TestComments(unittest.TestCase): fd, self.path = tempfile.mkstemp() conf = config.load(os.path.join(dist.location, "share", "isso.conf")) conf.set("general", "dbpath", self.path) - conf.set("general", "host", "https://example.org") conf.set("guard", "enabled", "off") conf.set("hash", "algorithm", "none") + self.conf = conf class App(Isso, core.Mixin): pass @@ -326,7 +326,13 @@ class TestComments(unittest.TestCase): self.assertListEqual(list(rv.keys()), []) + def testNoFeed(self): + rv = self.get('/feed?uri=%2Fpath%2Fnothing') + self.assertEqual(rv.status_code, 404) + def testFeedEmpty(self): + self.conf.set("rss", "base", "https://example.org") + rv = self.get('/feed?uri=%2Fpath%2Fnothing') self.assertEqual(rv.status_code, 200) self.assertEqual(rv.headers['ETag'], '"empty"') @@ -335,6 +341,8 @@ class TestComments(unittest.TestCase): 1970-01-01T01:00:00Ztag:example.org,2018:/isso/thread/path/nothingComments for example.org/path/nothing""") def testFeed(self): + self.conf.set("rss", "base", "https://example.org") + self.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'First'})) self.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'First', 'parent': 1})) diff --git a/isso/views/comments.py b/isso/views/comments.py index 120fef3..87cf48d 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -854,11 +854,15 @@ class API(object): """ @requires(str, 'uri') def feed(self, environ, request, uri): + conf = self.isso.conf.section("rss") + if not conf.get('base'): + raise NotFound + args = { 'uri': uri, 'order_by': 'id', 'asc': 0, - 'limit': 100 + 'limit': conf.getint('limit') } try: args['limit'] = max(int(request.args.get('limit')), args['limit']) @@ -867,7 +871,7 @@ class API(object): except ValueError: return BadRequest("limit should be integer") comments = self.comments.fetch(**args) - base = self.conf.get('host').split()[0] + base = conf.get('base') hostname = urlparse(base).netloc # Let's build an Atom feed. diff --git a/share/isso.conf b/share/isso.conf index 883e2b1..d429215 100644 --- a/share/isso.conf +++ b/share/isso.conf @@ -180,3 +180,15 @@ salt = Eech7co8Ohloopo9Ol6baimi # strengthening. Arguments have to be in that order, but can be reduced to # pbkdf2:4096 for example to override the iterations only. algorithm = pbkdf2 + + +[rss] +# Provide an Atom feed for each comment thread for users to subscribe to. + +# The base URL of pages is needed to build the Atom feed. By appending +# the URI, we should get the complete URL to use to access the page +# with the comments. When empty, Atom feeds are disabled. +base = + +# Limit the number of elements to return for each thread. +limit = 100 From 01cf96eeb7e28218c0145071f027f7d0957f79fc Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Mon, 23 Apr 2018 11:33:47 +0200 Subject: [PATCH 73/78] feed: ensure Markdown rendering is applied to feeds --- isso/tests/test_comments.py | 4 ++-- isso/views/comments.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/isso/tests/test_comments.py b/isso/tests/test_comments.py index 4ba67c8..2ffe2ad 100644 --- a/isso/tests/test_comments.py +++ b/isso/tests/test_comments.py @@ -345,7 +345,7 @@ class TestComments(unittest.TestCase): self.post('/new?uri=%2Fpath%2F', data=json.dumps({'text': 'First'})) self.post('/new?uri=%2Fpath%2F', - data=json.dumps({'text': 'First', 'parent': 1})) + data=json.dumps({'text': '*Second*', 'parent': 1})) rv = self.get('/feed?uri=%2Fpath%2F') self.assertEqual(rv.status_code, 200) @@ -354,7 +354,7 @@ class TestComments(unittest.TestCase): data = re.sub('[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]+Z', '2018-04-01T10:00:00Z', data) self.assertEqual(data, """ -2018-04-01T10:00:00Ztag:example.org,2018:/isso/thread/path/Comments for example.org/path/tag:example.org,2018:/isso/1/2Comment #22018-04-01T10:00:00ZFirsttag:example.org,2018:/isso/1/1Comment #12018-04-01T10:00:00ZFirst""") +2018-04-01T10:00:00Ztag:example.org,2018:/isso/thread/path/Comments for example.org/path/tag:example.org,2018:/isso/1/2Comment #22018-04-01T10:00:00Z<p><em>Second</em></p>tag:example.org,2018:/isso/1/1Comment #12018-04-01T10:00:00Z<p>First</p>""") def testCounts(self): diff --git a/isso/views/comments.py b/isso/views/comments.py index 87cf48d..2e8b4f3 100644 --- a/isso/views/comments.py +++ b/isso/views/comments.py @@ -925,7 +925,7 @@ class API(object): content = ET.SubElement(entry, 'content', { 'type': 'html', }) - content.text = comment['text'] + content.text = self.isso.render(comment['text']) if comment['parent']: ET.SubElement(entry, 'thr:in-reply-to', { From b0264bc807454765a1d7df96b4dfe9e8f9ab74cb Mon Sep 17 00:00:00 2001 From: Vincent Bernat Date: Fri, 20 Apr 2018 21:27:50 +0200 Subject: [PATCH 74/78] js: add a preview button to see a rendered preview When the button is clicked, the /preview endpoint is used to render a preview text. The preview is inserted and the preview button is replaced by an edit button to go back to edit mode. Alternatively, the use can click on the preview to edit. Some small CSS modifications are done to accomodate the modification. Also, the preview is wrapped into `.isso-common .text-wrapper .text` to not make the CSS more complex. When in preview mode, the background is stripped/greyish in case it's not easy to make a difference between preview and not preview (due to unformatted text). We avoid to modify borders/shadow boxes because it would make the design "jumpy". --- isso/css/isso.css | 46 ++++++++++++++++++++++++++--------- isso/js/app/api.js | 19 +++++++++++++-- isso/js/app/i18n/bg.js | 2 ++ isso/js/app/i18n/cs.js | 2 ++ isso/js/app/i18n/da.js | 2 ++ isso/js/app/i18n/de.js | 2 ++ isso/js/app/i18n/el_GR.js | 2 ++ isso/js/app/i18n/en.js | 2 ++ isso/js/app/i18n/eo.js | 2 ++ isso/js/app/i18n/es.js | 2 ++ isso/js/app/i18n/fa.js | 2 ++ isso/js/app/i18n/fi.js | 2 ++ isso/js/app/i18n/fr.js | 2 ++ isso/js/app/i18n/hr.js | 2 ++ isso/js/app/i18n/hu.js | 2 ++ isso/js/app/i18n/it.js | 2 ++ isso/js/app/i18n/nl.js | 2 ++ isso/js/app/i18n/pl.js | 2 ++ isso/js/app/i18n/ru.js | 2 ++ isso/js/app/i18n/sv.js | 2 ++ isso/js/app/i18n/vi.js | 2 ++ isso/js/app/i18n/zh_CN.js | 2 ++ isso/js/app/i18n/zh_TW.js | 2 ++ isso/js/app/isso.js | 21 +++++++++++++++- isso/js/app/text/postbox.jade | 10 ++++++++ 25 files changed, 124 insertions(+), 14 deletions(-) diff --git a/isso/css/isso.css b/isso/css/isso.css index 02f2a93..c0716f8 100644 --- a/isso/css/isso.css +++ b/isso/css/isso.css @@ -31,12 +31,16 @@ color: #757575; } -.isso-comment { +#isso-root .isso-comment { max-width: 68em; padding-top: 0.95em; margin: 0.95em auto; } -.isso-comment:not(:first-of-type), +#isso-root .preview .isso-comment { + padding-top: 0; + margin: 0; +} +#isso-root .isso-comment:not(:first-of-type), .isso-follow-up .isso-comment { border-top: 1px solid rgba(0, 0, 0, 0.1); } @@ -89,7 +93,8 @@ font-weight: bold; color: #555; } -.isso-comment > div.text-wrapper > .textarea-wrapper .textarea { +.isso-comment > div.text-wrapper > .textarea-wrapper .textarea, +.isso-comment > div.text-wrapper > .textarea-wrapper .preview { margin-top: 0.2em; } .isso-comment > div.text-wrapper > div.text p { @@ -107,7 +112,8 @@ font-size: 130%; font-weight: bold; } -.isso-comment > div.text-wrapper > div.textarea-wrapper .textarea { +.isso-comment > div.text-wrapper > div.textarea-wrapper .textarea, +.isso-comment > div.text-wrapper > div.textarea-wrapper .preview { width: 100%; border: 1px solid #f0f0f0; border-radius: 2px; @@ -163,7 +169,8 @@ .isso-postbox > .form-wrapper > .auth-section .post-action { display: block; } -.isso-postbox > .form-wrapper .textarea { +.isso-postbox > .form-wrapper .textarea, +.isso-postbox > .form-wrapper .preview { margin: 0 0 .3em; padding: .4em .8em; border-radius: 3px; @@ -193,7 +200,7 @@ .isso-postbox > .form-wrapper > .auth-section .post-action { display: inline-block; float: right; - margin: 0; + margin: 0 0 0 5px; } .isso-postbox > .form-wrapper > .auth-section .post-action > input { padding: calc(.3em - 1px); @@ -211,6 +218,28 @@ .isso-postbox > .form-wrapper > .auth-section .post-action > input:active { background-color: #BBB; } +.isso-postbox > .form-wrapper .preview, +.isso-postbox > .form-wrapper input[name="edit"], +.isso-postbox.preview-mode > .form-wrapper input[name="preview"], +.isso-postbox.preview-mode > .form-wrapper .textarea { + display: none; +} +.isso-postbox.preview-mode > .form-wrapper .preview { + display: block; +} +.isso-postbox.preview-mode > .form-wrapper input[name="edit"] { + display: inline; +} +.isso-postbox > .form-wrapper .preview { + background-color: #f8f8f8; + background: repeating-linear-gradient( + -45deg, + #f8f8f8, + #f8f8f8 10px, + #fff 10px, + #fff 20px + ); +} @media screen and (max-width:600px) { .isso-postbox > .form-wrapper > .auth-section .input-wrapper { display: block; @@ -220,9 +249,4 @@ .isso-postbox > .form-wrapper > .auth-section .input-wrapper input { width: 100%; } - .isso-postbox > .form-wrapper > .auth-section .post-action { - display: block; - float: none; - text-align: right; - } } diff --git a/isso/js/app/api.js b/isso/js/app/api.js index 30cca9c..1496892 100644 --- a/isso/js/app/api.js +++ b/isso/js/app/api.js @@ -191,9 +191,23 @@ define(["app/lib/promise", "app/globals"], function(Q, globals) { return deferred.promise; }; + var feed = function(tid) { return endpoint + "/feed?" + qs({uri: tid || location}); - } + }; + + var preview = function(text) { + var deferred = Q.defer(); + curl("POST", endpoint + "/preview", JSON.stringify({text: text}), + function(rv) { + if (rv.status === 200) { + deferred.resolve(JSON.parse(rv.body).text); + } else { + deferred.reject(rv.body); + } + }); + return deferred.promise; + }; return { endpoint: endpoint, @@ -207,6 +221,7 @@ define(["app/lib/promise", "app/globals"], function(Q, globals) { count: count, like: like, dislike: dislike, - feed: feed + feed: feed, + preview: preview }; }); diff --git a/isso/js/app/i18n/bg.js b/isso/js/app/i18n/bg.js index 45ac24b..a13ff09 100644 --- a/isso/js/app/i18n/bg.js +++ b/isso/js/app/i18n/bg.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Име/псевдоним (незадължително)", "postbox-email": "Ел. поща (незадължително)", "postbox-website": "Уебсайт (незадължително)", + "postbox-preview": "преглед", + "postbox-edit": "Редактиране", "postbox-submit": "Публикуване", "num-comments": "1 коментар\n{{ n }} коментара", "no-comments": "Все още няма коментари", diff --git a/isso/js/app/i18n/cs.js b/isso/js/app/i18n/cs.js index 77e6401..11dfcbb 100644 --- a/isso/js/app/i18n/cs.js +++ b/isso/js/app/i18n/cs.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Jméno (nepovinné)", "postbox-email": "E-mail (nepovinný)", "postbox-website": "Web (nepovinný)", + "postbox-preview": "Náhled", + "postbox-edit": "Upravit", "postbox-submit": "Publikovat", "num-comments": "Jeden komentář\n{{ n }} Komentářů", "no-comments": "Zatím bez komentářů", diff --git a/isso/js/app/i18n/da.js b/isso/js/app/i18n/da.js index eb64fc4..d97cd4c 100644 --- a/isso/js/app/i18n/da.js +++ b/isso/js/app/i18n/da.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Name (optional)", "postbox-email": "E-mail (optional)", "postbox-website": "Website (optional)", + "postbox-preview": "Eksempel", + "postbox-edit": "Rediger", "postbox-submit": "Submit", "num-comments": "One Comment\n{{ n }} Comments", diff --git a/isso/js/app/i18n/de.js b/isso/js/app/i18n/de.js index f7def26..04e1739 100644 --- a/isso/js/app/i18n/de.js +++ b/isso/js/app/i18n/de.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Name (optional)", "postbox-email": "Email (optional)", "postbox-website": "Website (optional)", + "postbox-preview": "Vorschau", + "postbox-edit": "Bearbeiten", "postbox-submit": "Abschicken", "num-comments": "1 Kommentar\n{{ n }} Kommentare", "no-comments": "Bisher keine Kommentare", diff --git a/isso/js/app/i18n/el_GR.js b/isso/js/app/i18n/el_GR.js index 5155a2d..db181cc 100644 --- a/isso/js/app/i18n/el_GR.js +++ b/isso/js/app/i18n/el_GR.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Όνομα (προαιρετικό)", "postbox-email": "E-mail (προαιρετικό)", "postbox-website": "Ιστοσελίδα (προαιρετικό)", + "postbox-preview": "Πρεμιέρα", + "postbox-edit": "Επεξεργασία", "postbox-submit": "Υποβολή", "num-comments": "Ένα σχόλιο\n{{ n }} σχόλια", "no-comments": "Δεν υπάρχουν σχόλια", diff --git a/isso/js/app/i18n/en.js b/isso/js/app/i18n/en.js index d3968b8..fd110fe 100644 --- a/isso/js/app/i18n/en.js +++ b/isso/js/app/i18n/en.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Name (optional)", "postbox-email": "E-mail (optional)", "postbox-website": "Website (optional)", + "postbox-preview": "Preview", + "postbox-edit": "Edit", "postbox-submit": "Submit", "num-comments": "One Comment\n{{ n }} Comments", diff --git a/isso/js/app/i18n/eo.js b/isso/js/app/i18n/eo.js index 76150f3..e9ee6c6 100644 --- a/isso/js/app/i18n/eo.js +++ b/isso/js/app/i18n/eo.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Nomo (malnepra)", "postbox-email": "Retadreso (malnepra)", "postbox-website": "Retejo (malnepra)", + "postbox-preview": "Antaŭrigardo", + "postbox-edit": "Redaktu", "postbox-submit": "Sendu", "num-comments": "{{ n }} komento\n{{ n }} komentoj", "no-comments": "Neniu komento ankoraŭ", diff --git a/isso/js/app/i18n/es.js b/isso/js/app/i18n/es.js index c25d6cd..565ef14 100644 --- a/isso/js/app/i18n/es.js +++ b/isso/js/app/i18n/es.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Nombre (opcional)", "postbox-email": "E-mail (opcional)", "postbox-website": "Sitio web (opcional)", + "postbox-preview": "Avance", + "postbox-edit": "Editar", "postbox-submit": "Enviar", "num-comments": "Un Comentario\n{{ n }} Comentarios", "no-comments": "Sin Comentarios Todavía", diff --git a/isso/js/app/i18n/fa.js b/isso/js/app/i18n/fa.js index c323778..9b6da58 100644 --- a/isso/js/app/i18n/fa.js +++ b/isso/js/app/i18n/fa.js @@ -3,6 +3,8 @@ define({ "postbox-author": "اسم (اختیاری)", "postbox-email": "ایمیل (اختیاری)", "postbox-website": "سایت (اختیاری)", + "postbox-preview": "پیشنمایش", + "postbox-edit": "ویرایش", "postbox-submit": "ارسال", "num-comments": "یک نظر\n{{ n }} نظر", diff --git a/isso/js/app/i18n/fi.js b/isso/js/app/i18n/fi.js index 80b6316..4def698 100644 --- a/isso/js/app/i18n/fi.js +++ b/isso/js/app/i18n/fi.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Nimi (valinnainen)", "postbox-email": "Sähköposti (valinnainen)", "postbox-website": "Web-sivu (valinnainen)", + "postbox-preview": "Esikatselu", + "postbox-edit": "Muokkaa", "postbox-submit": "Lähetä", "num-comments": "Yksi kommentti\n{{ n }} kommenttia", diff --git a/isso/js/app/i18n/fr.js b/isso/js/app/i18n/fr.js index f65cc6a..32e0ed6 100644 --- a/isso/js/app/i18n/fr.js +++ b/isso/js/app/i18n/fr.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Nom (optionnel)", "postbox-email": "Courriel (optionnel)", "postbox-website": "Site web (optionnel)", + "postbox-preview": "Aperçu", + "postbox-edit": "Éditer", "postbox-submit": "Soumettre", "num-comments": "{{ n }} commentaire\n{{ n }} commentaires", "no-comments": "Aucun commentaire pour l'instant", diff --git a/isso/js/app/i18n/hr.js b/isso/js/app/i18n/hr.js index 1ae6452..84c31f9 100644 --- a/isso/js/app/i18n/hr.js +++ b/isso/js/app/i18n/hr.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Ime (neobavezno)", "postbox-email": "E-mail (neobavezno)", "postbox-website": "Web stranica (neobavezno)", + "postbox-preview": "Pregled", + "postbox-edit": "Uredi", "postbox-submit": "Pošalji", "num-comments": "Jedan komentar\n{{ n }} komentara", "no-comments": "Još nema komentara", diff --git a/isso/js/app/i18n/hu.js b/isso/js/app/i18n/hu.js index e0bf7d6..e06c513 100644 --- a/isso/js/app/i18n/hu.js +++ b/isso/js/app/i18n/hu.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Név (nem kötelező)", "postbox-email": "Email (nem kötelező)", "postbox-website": "Website (nem kötelező)", + "postbox-preview": "Előnézet", + "postbox-edit": "Szerekesztés", "postbox-submit": "Elküld", "num-comments": "Egy hozzászólás\n{{ n }} hozzászólás", "no-comments": "Eddig nincs hozzászólás", diff --git a/isso/js/app/i18n/it.js b/isso/js/app/i18n/it.js index 31eeb2c..f193f95 100644 --- a/isso/js/app/i18n/it.js +++ b/isso/js/app/i18n/it.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Nome (opzionale)", "postbox-email": "E-mail (opzionale)", "postbox-website": "Sito web (opzionale)", + "postbox-preview": "Anteprima", + "postbox-edit": "Modifica", "postbox-submit": "Invia", "num-comments": "Un Commento\n{{ n }} Commenti", "no-comments": "Ancora Nessun Commento", diff --git a/isso/js/app/i18n/nl.js b/isso/js/app/i18n/nl.js index 04164b6..107a882 100644 --- a/isso/js/app/i18n/nl.js +++ b/isso/js/app/i18n/nl.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Naam (optioneel)", "postbox-email": "E-mail (optioneel)", "postbox-website": "Website (optioneel)", + "postbox-preview": "Voorbeeld", + "postbox-edit": "Bewerken", "postbox-submit": "Versturen", "num-comments": "Één reactie\n{{ n }} reacties", "no-comments": "Nog geen reacties", diff --git a/isso/js/app/i18n/pl.js b/isso/js/app/i18n/pl.js index d9afe7d..bba7bac 100644 --- a/isso/js/app/i18n/pl.js +++ b/isso/js/app/i18n/pl.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Imię/nick (opcjonalnie)", "postbox-email": "E-mail (opcjonalnie)", "postbox-website": "Strona (opcjonalnie)", + "postbox-preview": "Visualizar", + "postbox-edit": "Edytuj", "postbox-submit": "Wyślij", "num-comments": "Jeden komentarz\n{{ n }} komentarzy", "no-comments": "Jeszcze nie ma komentarzy", diff --git a/isso/js/app/i18n/ru.js b/isso/js/app/i18n/ru.js index a5af03e..662e825 100644 --- a/isso/js/app/i18n/ru.js +++ b/isso/js/app/i18n/ru.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Имя (необязательно)", "postbox-email": "Email (необязательно)", "postbox-website": "Сайт (необязательно)", + "postbox-preview": "анонс", + "postbox-edit": "Правка", "postbox-submit": "Отправить", "num-comments": "{{ n }} комментарий\n{{ n }} комментария\n{{ n }} комментариев", "no-comments": "Пока нет комментариев", diff --git a/isso/js/app/i18n/sv.js b/isso/js/app/i18n/sv.js index cafbdda..a1b50a3 100644 --- a/isso/js/app/i18n/sv.js +++ b/isso/js/app/i18n/sv.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Namn (frivilligt)", "postbox-email": "E-mail (frivilligt)", "postbox-website": "Hemsida (frivilligt)", + "postbox-preview": "Förhandsvisning", + "postbox-edit": "Redigera", "postbox-submit": "Skicka", "num-comments": "En kommentar\n{{ n }} kommentarer", "no-comments": "Inga kommentarer än", diff --git a/isso/js/app/i18n/vi.js b/isso/js/app/i18n/vi.js index 72a3092..6b54d23 100644 --- a/isso/js/app/i18n/vi.js +++ b/isso/js/app/i18n/vi.js @@ -3,6 +3,8 @@ define({ "postbox-author": "Tên (tùy chọn)", "postbox-email": "E-mail (tùy chọn)", "postbox-website": "Website (tùy chọn)", + "postbox-preview": "Xem trước", + "postbox-edit": "Sửa", "postbox-submit": "Gửi", "num-comments": "Một bình luận\n{{ n }} bình luận", diff --git a/isso/js/app/i18n/zh_CN.js b/isso/js/app/i18n/zh_CN.js index 9c33957..1bd1801 100644 --- a/isso/js/app/i18n/zh_CN.js +++ b/isso/js/app/i18n/zh_CN.js @@ -3,6 +3,8 @@ define({ "postbox-author": "名字 (可选)", "postbox-email": "E-mail (可选)", "postbox-website": "网站 (可选)", + "postbox-preview": "预习", + "postbox-edit": "编辑", "postbox-submit": "提交", "num-comments": "1 条评论\n{{ n }} 条评论", diff --git a/isso/js/app/i18n/zh_TW.js b/isso/js/app/i18n/zh_TW.js index 68ad370..7bdf7e5 100644 --- a/isso/js/app/i18n/zh_TW.js +++ b/isso/js/app/i18n/zh_TW.js @@ -3,6 +3,8 @@ define({ "postbox-author": "名稱 (非必填)", "postbox-email": "電子信箱 (非必填)", "postbox-website": "個人網站 (非必填)", + "postbox-preview": "預習", + "postbox-edit": "編輯", "postbox-submit": "送出", "num-comments": "1 則留言\n{{ n }} 則留言", diff --git a/isso/js/app/isso.js b/isso/js/app/isso.js index e779a76..1d3fc5d 100644 --- a/isso/js/app/isso.js +++ b/isso/js/app/isso.js @@ -11,7 +11,8 @@ define(["app/dom", "app/utils", "app/config", "app/api", "app/jade", "app/i18n", el = $.htmlify(jade.render("postbox", { "author": JSON.parse(localStorage.getItem("author")), "email": JSON.parse(localStorage.getItem("email")), - "website": JSON.parse(localStorage.getItem("website")) + "website": JSON.parse(localStorage.getItem("website")), + "preview": '' })); // callback on success (e.g. to toggle the reply button) @@ -51,9 +52,27 @@ define(["app/dom", "app/utils", "app/config", "app/api", "app/jade", "app/i18n", $("[name='author']", el).placeholder.replace(/ \(.*\)/, ""); } + // preview function + $("[name='preview']", el).on("click", function() { + api.preview(utils.text($(".textarea", el).innerHTML)).then( + function(html) { + $(".preview .text", el).innerHTML = html; + el.classList.add('preview-mode'); + }); + }); + + // edit function + var edit = function() { + $(".preview .text", el).innerHTML = ''; + el.classList.remove('preview-mode'); + }; + $("[name='edit']", el).on("click", edit); + $(".preview", el).on("click", edit); + // submit form, initialize optional fields with `null` and reset form. // If replied to a comment, remove form completely. $("[type=submit]", el).on("click", function() { + edit(); if (! el.validate()) { return; } diff --git a/isso/js/app/text/postbox.jade b/isso/js/app/text/postbox.jade index 0a85ae1..908326b 100644 --- a/isso/js/app/text/postbox.jade +++ b/isso/js/app/text/postbox.jade @@ -3,6 +3,10 @@ div(class='isso-postbox') div(class='textarea-wrapper') div(class='textarea placeholder' contenteditable='true') = i18n('postbox-text') + div(class='preview') + div(class='isso-comment') + div(class='text-wrapper') + div(class='text') section(class='auth-section') p(class='input-wrapper') input(type='text' name='author' placeholder=i18n('postbox-author') @@ -15,3 +19,9 @@ div(class='isso-postbox') value=website != null ? '#{website}' : '') p(class='post-action') input(type='submit' value=i18n('postbox-submit')) + p(class='post-action') + input(type='button' name='preview' + value=i18n('postbox-preview')) + p(class='post-action') + input(type='button' name='edit' + value=i18n('postbox-edit')) From 501bdc59bf5643a3a273e1468cca092e2603d9c2 Mon Sep 17 00:00:00 2001 From: Lucas Cimon Date: Wed, 25 Apr 2018 10:55:37 +0200 Subject: [PATCH 75/78] Bugfix to support elements in SVG diagrams - close #421 --- isso/js/app/count.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/isso/js/app/count.js b/isso/js/app/count.js index a1fff4b..58eb230 100644 --- a/isso/js/app/count.js +++ b/isso/js/app/count.js @@ -4,7 +4,7 @@ define(["app/api", "app/dom", "app/i18n"], function(api, $, i18n) { var objs = {}; $.each("a", function(el) { - if (! el.href.match(/#isso-thread$/)) { + if (! el.href.match || ! el.href.match(/#isso-thread$/)) { return; } From 3d648c2d290941f75ab730ab1990e9df311889b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Wed, 25 Apr 2018 21:20:42 +0200 Subject: [PATCH 76/78] fix tests due to non predictive html rendering --- isso/tests/test_html.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/isso/tests/test_html.py b/isso/tests/test_html.py index 327357c..42baa82 100644 --- a/isso/tests/test_html.py +++ b/isso/tests/test_html.py @@ -65,13 +65,17 @@ class TestHTML(unittest.TestCase): examples = [ ('Look: ', 'Look: '), ('Ha', - 'Ha'), + ['Ha', + 'Ha']), ('Ha', 'Ha'), ('

Test

', '

Test

'), ('', 'alert("Onoe")')] for (input, expected) in examples: - self.assertEqual(html.sanitize(sanitizer, input), expected) + if isinstance(expected, list): + self.assertIn(html.sanitize(sanitizer, input), expected) + else: + self.assertEqual(html.sanitize(sanitizer, input), expected) @unittest.skipIf(html.HTML5LIB_VERSION <= html.HTML5LIB_SIMPLETREE, "backport") def test_sanitizer_extensions(self): @@ -92,5 +96,6 @@ class TestHTML(unittest.TestCase): } }) renderer = html.Markup(conf.section("markup")).render - self.assertEqual(renderer("http://example.org/ and sms:+1234567890"), - '

http://example.org/ and sms:+1234567890

') + self.assertIn(renderer("http://example.org/ and sms:+1234567890"), + ['

http://example.org/ and sms:+1234567890

', + '

http://example.org/ and sms:+1234567890

']) From c14f639e755c88d498cf51736badd5dbd4f10f24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Wed, 25 Apr 2018 22:24:05 +0200 Subject: [PATCH 77/78] add: CONTRIBUTORS update --- CONTRIBUTORS.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index ad1fc1e..4ed0265 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -78,6 +78,9 @@ In chronological order: * @vincentbernat * Added documentation about data-isso-id attribute (overriding the standard isso-thread-id) * Added multi-staged Dockerfile + * Added atom feed + * Added a nofollow/noopener on links inside comments to protect against bots + * Added a preview using the existing preview endpoint * @p-vitt & @M4a1x * Documentation on troubleshooting for uberspace users From 466654b50d3d97bf1046cddc56a290507c5251b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Latinier?= Date: Wed, 25 Apr 2018 22:31:01 +0200 Subject: [PATCH 78/78] update CONTRIBUTORS --- CONTRIBUTORS.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 4ed0265..576f9cb 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -68,6 +68,7 @@ In chronological order: * Lucas Cimon @Lucas-C * Added the possibility to define CORS origins through ISSO_CORS_ORIGIN environment variable + * Fix a bug with in * Yuchen Pei @ycpei * Fix link in moderation emails when isso is installed in a sub URL