+ {% for file in review_request_details.files.all %}
+
+
+
+
+ {% if draft %}{{file.draft_caption}}{% else %}{{file.caption}}{% endif %}
+
+
+
+ {% endfor %}
+
+
+
+
+
+{% include "reviews/comments_dlg.html" %}
+
diff --git a/reviewboard/templates/reviews/review_request_dlgs.html b/reviewboard/templates/reviews/review_request_dlgs.html
index 29325b3a4116958527ba90c544181411ee9bbd66..28b0b6426c79c79e2e9cb5c7ca87054c8f8ee78d 100644
--- a/reviewboard/templates/reviews/review_request_dlgs.html
+++ b/reviewboard/templates/reviews/review_request_dlgs.html
@@ -40,6 +40,27 @@
return false;
});
+
+ $("#upload-file-link").click(function() {
+ $("").formDlg({
+ title: "{% trans "Upload File" %}",
+ confirmLabel: "{% trans "Upload" %}",
+ dataStoreObject: gReviewRequest.createUploadedFile(),
+ width: "50em",
+ upload: true,
+ fields: {% form_dialog_fields upload_file_form %},
+ success: function(rsp) {
+ if (!$("#file-list").length == 0) {
+ $.fileDisplay(rsp.uploaded_file);
+ }
+
+ gDraftBanner.show();
+ }
+ });
+
+ return false;
+ });
+
});
{% endifuserorperm %}
diff --git a/reviewboard/webapi/resources.py b/reviewboard/webapi/resources.py
index d0d2a137362767c8b4ada072ebf552c7a6882e45..7c82e5dcb50d47b34a3bf72a3a1850f98906aeb0 100644
--- a/reviewboard/webapi/resources.py
+++ b/reviewboard/webapi/resources.py
@@ -1,6 +1,7 @@
import logging
import re
import urllib
+import pdb
import dateutil.parser
from django.conf import settings
@@ -35,12 +36,15 @@ from reviewboard import get_version_string, get_package_version, is_release
from reviewboard.accounts.models import Profile
from reviewboard.diffviewer.diffutils import get_diff_files
from reviewboard.diffviewer.forms import EmptyDiffError
+from reviewboard.filemanager.forms import UploadFileForm
+from reviewboard.filemanager.models import UploadedFile
from reviewboard.reviews.errors import PermissionError
from reviewboard.reviews.forms import UploadDiffForm, UploadScreenshotForm
from reviewboard.reviews.models import Comment, DiffSet, FileDiff, Group, \
Repository, ReviewRequest, \
ReviewRequestDraft, Review, \
- ScreenshotComment, Screenshot
+ ScreenshotComment, Screenshot, \
+ UploadedFileComment
from reviewboard.scmtools import sshutils
from reviewboard.scmtools.errors import AuthenticationError, \
BadHostKeyError, \
@@ -1321,6 +1325,7 @@ class BaseWatchedObjectResource(WebAPIResource):
except User.DoesNotExist:
return DOES_NOT_EXIST
+ @webapi_check_local_site
@webapi_login_required
@webapi_response_errors(DOES_NOT_EXIST, NOT_LOGGED_IN, PERMISSION_DENIED)
@webapi_request_fields(required={
@@ -1351,6 +1356,7 @@ class BaseWatchedObjectResource(WebAPIResource):
self.item_result_key: obj,
}
+ @webapi_check_local_site
@webapi_login_required
def delete(self, request, watched_obj_id, *args, **kwargs):
try:
@@ -2348,6 +2354,7 @@ class BaseScreenshotResource(WebAPIResource):
def serialize_thumbnail_url_field(self, obj):
return obj.get_thumbnail_url()
+ @webapi_check_local_site
@webapi_login_required
@webapi_response_errors(DOES_NOT_EXIST, NOT_LOGGED_IN, PERMISSION_DENIED,
INVALID_FORM_DATA)
@@ -2411,6 +2418,7 @@ class BaseScreenshotResource(WebAPIResource):
self.item_result_key: screenshot,
}
+ @webapi_check_local_site
@webapi_login_required
@webapi_request_fields(
optional={
@@ -2451,6 +2459,7 @@ class BaseScreenshotResource(WebAPIResource):
self.item_result_key: screenshot,
}
+ @webapi_check_local_site
@webapi_login_required
@webapi_response_errors(DOES_NOT_EXIST, NOT_LOGGED_IN, PERMISSION_DENIED)
def delete(self, request, *args, **kwargs):
@@ -2572,6 +2581,248 @@ class DraftScreenshotResource(BaseScreenshotResource):
draft_screenshot_resource = DraftScreenshotResource()
+class BaseUploadedFileResource(WebAPIResource):
+ """A base resource representing uploaded files."""
+ model = UploadedFile
+ name = 'uploaded_file'
+ fields = {
+ 'id': {
+ 'type': int,
+ 'description': 'The numeric ID of the file.',
+ },
+ 'caption': {
+ 'type': str,
+ 'description': "The file's descriptive caption.",
+ },
+ 'title': {
+ 'type': str,
+ 'description': "The path of the file, relative to the media "
+ "directory configured on the Review Board server.",
+ },
+ 'url': {
+ 'type': str,
+ 'description': "The URL of the file, for downloading purposes."
+ "an absolute URL (for example, if it is just a "
+ "path), then it's relative to the Review Board "
+ "server's URL.",
+ },
+ 'file_url': {
+ 'type': str,
+ 'description': "The URL of the file object.",
+ },
+ }
+
+ uri_object_key = 'file_id'
+
+ def get_queryset(self, request, review_request_id, *args, **kwargs):
+ return self.model.objects.filter(review_request=review_request_id)
+
+ def serialize_title_field(self, obj):
+ return obj.get_title()
+
+ def serialize_url_field(self, obj):
+ return obj.get_path()
+
+ def serialize_file_url_field(self, obj):
+ return obj.get_absolute_url()
+
+ @webapi_check_local_site
+ @webapi_login_required
+ @webapi_response_errors(DOES_NOT_EXIST, PERMISSION_DENIED,
+ INVALID_FORM_DATA, NOT_LOGGED_IN)
+ @webapi_request_fields(
+ required={
+ 'path': {
+ 'type': file,
+ 'description': 'The file to upload.',
+ },
+ },
+ optional={
+ 'caption': {
+ 'type': str,
+ 'description': 'The optional caption describing the '
+ 'file.',
+ },
+ },
+ )
+ def create(self, request, *args, **kwargs):
+ """Creates a new file from an uploaded file.
+
+ This accepts any standard file format (including images) and associates
+ it with a draft of a review request.
+
+ It is expected that the client will send the data as part of a
+ :mimetype:`multipart/form-data` mimetype. The file's name
+ and content should be stored in the ``path`` field. A typical request
+ may look like::
+
+ -- SoMe BoUnDaRy
+ Content-Disposition: form-data; name=path; filename="foo.txt"
+
+
+ -- SoMe BoUnDaRy --
+ """
+ try:
+ review_request = \
+ review_request_resource.get_object(request, *args, **kwargs)
+ except ObjectDoesNotExist:
+ return DOES_NOT_EXIST
+
+ if not review_request.is_mutable_by(request.user):
+ return _no_access_error(request.user)
+
+ form_data = request.POST.copy()
+ form = UploadFileForm(form_data, request.FILES)
+
+ if not form.is_valid():
+ return WebAPIResponseFormError(request, form)
+
+ try:
+ file = form.create(request.FILES['path'], review_request)
+ except ValueError, e:
+ return INVALID_FORM_DATA, {
+ 'fields': {
+ 'path': [str(e)],
+ },
+ }
+
+ return 201, {
+ self.item_result_key: file,
+ }
+
+ @webapi_check_local_site
+ @webapi_login_required
+ @webapi_response_errors(DOES_NOT_EXIST, NOT_LOGGED_IN, PERMISSION_DENIED)
+ @webapi_request_fields(
+ optional={
+ 'caption': {
+ 'type': str,
+ 'description': 'The new caption for the file.',
+ },
+ }
+ )
+ def update(self, request, caption=None, *args, **kwargs):
+ """Updates the file's data.
+
+ This allows updating the file in a draft. The caption, currently,
+ is the only thing that can be updated.
+ """
+ try:
+ review_request = \
+ review_request_resource.get_object(request, *args, **kwargs)
+ file = uploaded_file_resource.get_object(request, *args,
+ **kwargs)
+ except ObjectDoesNotExist:
+ return DOES_NOT_EXIST
+
+ if not review_request.is_mutable_by(request.user):
+ return PERMISSION_DENIED
+
+ try:
+ review_request_draft_resource.prepare_draft(request,
+ review_request)
+ except PermissionDenied:
+ return _no_access_error(request.user)
+
+ file.draft_caption = caption
+ file.save()
+
+ return 200, {
+ self.item_result_key: screenshot,
+ }
+
+
+class DraftUploadedFileResource(BaseUploadedFileResource):
+ """Provides information on new uploaded files being added to a draft of
+ a review request.
+
+ These are files that will be shown once the pending review request
+ draft is published.
+ """
+ name = 'draft_files'
+ uri_name = 'files'
+ model_parent_key = 'drafts'
+ allowed_methods = ('GET', 'DELETE', 'POST', 'PUT',)
+
+ def get_queryset(self, request, review_request_id, *args, **kwargs):
+ try:
+ draft = review_request_draft_resource.get_object(
+ request, review_request_id, *args, **kwargs)
+
+ inactive_ids = \
+ draft.inactive_files.values_list('pk', flat=True)
+
+ q = Q(review_request=review_request_id) | Q(drafts=draft)
+ query = self.model.objects.filter(q)
+ query = query.exclude(pk__in=inactive_ids)
+ return query
+ except ObjectDoesNotExist:
+ return self.model.objects.none()
+
+ def serialize_caption_field(self, obj):
+ return obj.draft_caption or obj.caption
+
+ @webapi_check_local_site
+ @webapi_login_required
+ @augment_method_from(WebAPIResource)
+ def get(self, *args, **kwargs):
+ pass
+
+ @webapi_check_local_site
+ @webapi_login_required
+ @augment_method_from(WebAPIResource)
+ def delete(self, *args, **kwargs):
+ """Deletes the file from the draft.
+
+ This will remove the screenshot from the draft review request.
+ This cannot be undone.
+
+ This can be used to remove old files that were previously
+ shown, as well as newly added files that were part of the
+ draft.
+
+ Instead of a payload response on success, this will return :http:`204`.
+ """
+ pass
+
+ @webapi_check_local_site
+ @webapi_login_required
+ @augment_method_from(WebAPIResource)
+ def get_list(self, *args, **kwargs):
+ """Returns a list of draft files.
+
+ Each screenshot in this list is an uploaded screenshot that will
+ be shown in the final review request. These may include newly
+ uploaded files or files that were already part of the
+ existing review request. In the latter case, existing files
+ are shown so that their captions can be added.
+ """
+ pass
+
+ def _get_list_impl(self, request, *args, **kwargs):
+ """Returns the list of files on this draft.
+
+ This is a specialized version of the standard get_list function
+ that uses this resource to serialize the children, in order to
+ guarantee that we'll be able to identify them as files that are
+ part of the draft.
+ """
+ return WebAPIResponsePaginated(
+ request,
+ queryset=self.get_queryset(request, is_list=True,
+ *args, **kwargs),
+ results_key=self.list_result_key,
+ serialize_object_func=
+ lambda obj: self.serialize_object(obj, request=request,
+ *args, **kwargs),
+ extra_data={
+ 'links': self.get_links(self.list_child_resources,
+ request=request, *args, **kwargs),
+ })
+
+draft_uploaded_file_resource = DraftUploadedFileResource()
+
+
class ReviewRequestDraftResource(WebAPIResource):
"""An editable draft of a review request.
@@ -2659,6 +2910,7 @@ class ReviewRequestDraftResource(WebAPIResource):
item_child_resources = [
draft_screenshot_resource,
+ draft_uploaded_file_resource
]
@classmethod
@@ -3315,6 +3567,7 @@ class ReviewReplyScreenshotCommentResource(BaseScreenshotCommentResource):
q = q.filter(review=reply_id, review__base_reply_to=review_id)
return q
+ @webapi_check_local_site
@webapi_login_required
@webapi_response_errors(DOES_NOT_EXIST, INVALID_FORM_DATA,
NOT_LOGGED_IN, PERMISSION_DENIED)
@@ -3375,6 +3628,7 @@ class ReviewReplyScreenshotCommentResource(BaseScreenshotCommentResource):
self.item_result_key: new_comment,
}
+ @webapi_check_local_site
@webapi_login_required
@webapi_response_errors(DOES_NOT_EXIST, NOT_LOGGED_IN, PERMISSION_DENIED)
@webapi_request_fields(
@@ -3415,7 +3669,7 @@ class ReviewReplyScreenshotCommentResource(BaseScreenshotCommentResource):
@augment_method_from(BaseScreenshotCommentResource)
def delete(self, *args, **kwargs):
- """Deletes a screnshot comment from a draft reply.
+ """Deletes a screenshot comment from a draft reply.
This will remove the comment from the reply. This cannot be undone.
@@ -3449,6 +3703,399 @@ review_reply_screenshot_comment_resource = \
ReviewReplyScreenshotCommentResource()
+class BaseFileCommentResource(WebAPIResource):
+ """A base resource for file comments."""
+ model = UploadedFileComment
+ name = 'file_comment'
+ fields = {
+ 'id': {
+ 'type': int,
+ 'description': 'The numeric ID of the comment.',
+ },
+ 'file': {
+ 'type': 'reviewboard.webapi.resources.UploadedFileResource',
+ 'description': 'The file the comment was made on.',
+ },
+ 'text': {
+ 'type': str,
+ 'description': 'The comment text.',
+ },
+ 'timestamp': {
+ 'type': str,
+ 'description': 'The date and time that the comment was made '
+ '(in YYYY-MM-DD HH:MM:SS format).',
+ },
+ 'public': {
+ 'type': bool,
+ 'description': 'Whether or not the comment is part of a public '
+ 'review.',
+ },
+ 'user': {
+ 'type': 'reviewboard.webapi.resources.UserResource',
+ 'description': 'The user who made the comment.',
+ },
+ }
+
+ uri_object_key = 'comment_id'
+ allowed_methods = ('GET',)
+
+ def get_queryset(self, request, *args, **kwargs):
+ review_request = \
+ review_request_resource.get_object(request, *args, **kwargs)
+ return self.model.objects.filter(
+ file__review_request=review_request_id,
+ review__isnull=False)
+
+ def serialize_public_field(self, obj):
+ return obj.review.get().public
+
+ def serialize_timesince_field(self, obj):
+ return timesince(obj.timestamp)
+
+ def serialize_user_field(self, obj):
+ return obj.review.get().user
+
+ @webapi_check_local_site
+ @augment_method_from(WebAPIResource)
+ def get(self, *args, **kwargs):
+ """Returns information on the comment.
+
+ This contains the comment text, time the comment was made,
+ and the location of the comment region on the screenshot, amongst
+ other information. It can be used to reconstruct the exact
+ position of the comment for use as an overlay on the screenshot.
+ """
+ pass
+
+ def get_href(self, obj, request, *args, **kwargs):
+ """Returns the URL for this object"""
+ base = review_resource.get_href(
+ obj.review.all()[0], request, *args, **kwargs)
+ return '%s%s/%s/' % (base, self.uri_name, obj.id)
+
+
+class FileCommentResource(BaseFileCommentResource):
+ """Provides information on filess comments made on a review request.
+
+ The list of comments cannot be modified from this resource. It's meant
+ purely as a way to see existing comments that were made on a diff. These
+ comments will span all public reviews.
+ """
+ model_parent_key = 'uploaded_file'
+ uri_object_key = None
+
+ def get_queryset(self, request, review_request_id, file_id,
+ *args, **kwargs):
+ q = super(FileCommentResource, self).get_queryset(
+ request, review_request_id, *args, **kwargs)
+ q = q.filter(file=file_id)
+ return q
+
+ @webapi_check_local_site
+ @augment_method_from(BaseFileCommentResource)
+ def get_list(self, *args, **kwargs):
+ """Returns the list of screenshot comments on a file.
+
+ This list of comments will cover all comments made on this
+ file from all reviews.
+ """
+ pass
+
+file_comment_resource = FileCommentResource()
+
+
+class ReviewFileCommentResource(BaseFileCommentResource):
+ """Provides information on file comments made on a review.
+
+ If the review is a draft, then comments can be added, deleted, or
+ changed on this list. However, if the review is already published,
+ then no changes can be made.
+ """
+ allowed_methods = ('GET', 'POST', 'PUT', 'DELETE')
+ model_parent_key = 'review'
+
+ def get_queryset(self, request, review_request_id, review_id,
+ *args, **kwargs):
+ q = super(ReviewFileCommentResource, self).get_queryset(
+ request, review_request_id, *args, **kwargs)
+ return q.filter(review=review_id)
+
+ def has_delete_permissions(self, request, comment, *args, **kwargs):
+ review = comment.review.get()
+ return not review.public and review.user == request.user
+
+ @webapi_check_local_site
+ @webapi_login_required
+ @webapi_response_errors(DOES_NOT_EXIST, INVALID_FORM_DATA,
+ PERMISSION_DENIED, NOT_LOGGED_IN)
+ @webapi_request_fields(
+ required = {
+ 'file_id': {
+ 'type': int,
+ 'description': 'The ID of the file being commented on.',
+ },
+ 'text': {
+ 'type': str,
+ 'description': 'The comment text.',
+ },
+ },
+ )
+ def create(self, request, file_id=None, text=None, *args, **kwargs):
+ """Creates a file comment on a review.
+
+ This will create a new comment on a file as part of a review.
+ The comment contains text and dimensions for the area being commented
+ on.
+ """
+ try:
+ review_request = \
+ review_request_resource.get_object(request, *args, **kwargs)
+ review = review_resource.get_object(request, *args, **kwargs)
+ except ObjectDoesNotExist:
+ return DOES_NOT_EXIST
+
+ #pdb.set_trace()
+
+ if not review_resource.has_modify_permissions(request, review):
+ return _no_access_error(request.user)
+
+ try:
+ file = UploadedFile.objects.get(pk=file_id,
+ review_request=review_request)
+ except ObjectDoesNotExist:
+ return INVALID_FORM_DATA, {
+ 'fields': {
+ 'file_id': ['This is not a valid file ID'],
+ }
+ }
+
+ print "text=%s" % text
+
+ new_comment = self.model(file=file, text=text)
+ new_comment.save()
+ print "comment=%s" % new_comment
+
+ print type(new_comment)
+
+ review.file_comments.add(new_comment)
+ review.save()
+
+ return 201, {
+ self.item_result_key: new_comment,
+ }
+
+ @webapi_check_local_site
+ @webapi_login_required
+ @webapi_response_errors(DOES_NOT_EXIST, NOT_LOGGED_IN, PERMISSION_DENIED)
+ @webapi_request_fields(
+ optional = {
+ 'text': {
+ 'type': str,
+ 'description': 'The comment text.',
+ },
+ },
+ )
+ def update(self, request, *args, **kwargs):
+ """Updates a file comment.
+
+ This can update the text or region of an existing comment. It
+ can only be done for comments that are part of a draft review.
+ """
+ try:
+ review_request_resource.get_object(request, *args, **kwargs)
+ review = review_resource.get_object(request, *args, **kwargs)
+ file_comment = self.get_object(request, *args, **kwargs)
+ except ObjectDoesNotExist:
+ return DOES_NOT_EXIST
+
+ if not review_resource.has_modify_permissions(request, review):
+ return _no_access_error(request.user)
+
+ for field in ('text'):
+ value = kwargs.get(field, None)
+
+ if value is not None:
+ setattr(file_comment, field, value)
+
+ file_comment.save()
+
+ return 200, {
+ self.item_result_key: file_comment,
+ }
+
+ @augment_method_from(BaseFileCommentResource)
+ def delete(self, *args, **kwargs):
+ """Deletes the comment.
+
+ This will remove the comment from the review. This cannot be undone.
+
+ Only comments on draft reviews can be deleted. Attempting to delete
+ a published comment will return a Permission Denied error.
+
+ Instead of a payload response on success, this will return :http:`204`.
+ """
+ pass
+
+ @augment_method_from(BaseFileCommentResource)
+ def get_list(self, *args, **kwargs):
+ """Returns the list of file comments made on a review."""
+ pass
+
+review_file_comment_resource = ReviewFileCommentResource()
+
+
+class ReviewReplyFileCommentResource(BaseFileCommentResource):
+ """Provides information on replies to file comments made on a
+ review reply.
+
+ If the reply is a draft, then comments can be added, deleted, or
+ changed on this list. However, if the reply is already published,
+ then no changed can be made.
+ """
+ allowed_methods = ('GET', 'POST', 'PUT', 'DELETE')
+ model_parent_key = 'review'
+ fields = dict({
+ 'reply_to': {
+ 'type': ReviewFileCommentResource,
+ 'description': 'The comment being replied to.',
+ },
+ }, **BaseFileCommentResource.fields)
+
+ def get_queryset(self, request, review_request_id, review_id, reply_id,
+ *args, **kwargs):
+ q = super(ReviewReplyFileCommentResource, self).get_queryset(
+ request, review_request_id, *args, **kwargs)
+ q = q.filter(review=reply_id, review__base_reply_to=review_id)
+ return q
+
+ @webapi_check_local_site
+ @webapi_login_required
+ @webapi_response_errors(DOES_NOT_EXIST, INVALID_FORM_DATA,
+ NOT_LOGGED_IN, PERMISSION_DENIED)
+ @webapi_request_fields(
+ required = {
+ 'reply_to_id': {
+ 'type': int,
+ 'description': 'The ID of the comment being replied to.',
+ },
+ 'text': {
+ 'type': str,
+ 'description': 'The comment text.',
+ },
+ },
+ )
+ def create(self, request, reply_to_id, text, *args, **kwargs):
+ """Creates a reply to a file comment on a review.
+
+ This will create a reply to a file comment on a review.
+ The new comment will contain the same dimensions of the comment
+ being replied to, but may contain new text.
+ """
+ try:
+ review_request_resource.get_object(request, *args, **kwargs)
+ reply = review_reply_resource.get_object(request, *args, **kwargs)
+ except ObjectDoesNotExist:
+ return DOES_NOT_EXIST
+
+ if not review_reply_resource.has_modify_permissions(request, reply):
+ return _no_access_error(request.user)
+
+ try:
+ comment = review_file_comment_resource.get_object(
+ request,
+ comment_id=reply_to_id,
+ *args, **kwargs)
+ except ObjectDoesNotExist:
+ return INVALID_FORM_DATA, {
+ 'fields': {
+ 'reply_to_id': ['This is not a valid file '
+ 'comment ID'],
+ }
+ }
+
+ new_comment = self.model(file=comment.file,
+ text=text)
+ new_comment.save()
+
+ reply.file_comments.add(new_comment)
+ reply.save()
+
+ return 201, {
+ self.item_result_key: new_comment,
+ }
+
+ @webapi_check_local_site
+ @webapi_login_required
+ @webapi_response_errors(DOES_NOT_EXIST, NOT_LOGGED_IN, PERMISSION_DENIED)
+ @webapi_request_fields(
+ required = {
+ 'text': {
+ 'type': str,
+ 'description': 'The new comment text.',
+ },
+ },
+ )
+ def update(self, request, *args, **kwargs):
+ """Updates a reply to a file comment.
+
+ This can only update the text in the comment. The comment being
+ replied to cannot change.
+ """
+ try:
+ review_request_resource.get_object(request, *args, **kwargs)
+ reply = review_reply_resource.get_object(request, *args, **kwargs)
+ file_comment = self.get_object(request, *args, **kwargs)
+ except ObjectDoesNotExist:
+ return DOES_NOT_EXIST
+
+ if not review_reply_resource.has_modify_permissions(request, reply):
+ return _no_access_error(request.user)
+
+ for field in ('text',):
+ value = kwargs.get(field, None)
+
+ if value is not None:
+ setattr(file_comment, field, value)
+
+ file_comment.save()
+
+ return 200, {
+ self.item_result_key: file_comment,
+ }
+
+ @augment_method_from(BaseFileCommentResource)
+ def delete(self, *args, **kwargs):
+ """Deletes a file comment from a draft reply.
+
+ This will remove the comment from the reply. This cannot be undone.
+
+ Only comments on draft replies can be deleted. Attempting to delete
+ a published comment will return a Permission Denied error.
+
+ Instead of a payload response, this will return :http:`204`.
+ """
+ pass
+
+ @augment_method_from(BaseFileCommentResource)
+ def get(self, *args, **kwargs):
+ """Returns information on a reply to a file comment.
+
+ Much of the information will be identical to that of the comment
+ being replied to.
+ """
+ pass
+
+ @augment_method_from(BaseFileCommentResource)
+ def get_list(self, *args, **kwargs):
+ """Returns the list of replies to file comments made on a
+ review reply.
+ """
+ pass
+
+review_reply_file_comment_resource = \
+ ReviewReplyFileCommentResource()
+
+
class BaseReviewResource(WebAPIResource):
"""Base class for review resources.
@@ -3697,6 +4344,7 @@ class ReviewReplyDraftResource(WebAPIResource):
singleton = True
uri_name = 'draft'
+ @webapi_check_local_site
@webapi_login_required
def get(self, request, *args, **kwargs):
"""Returns the location of the current draft reply.
@@ -3769,6 +4417,7 @@ class ReviewReplyResource(BaseReviewResource):
item_child_resources = [
review_reply_diff_comment_resource,
review_reply_screenshot_comment_resource,
+ review_reply_file_comment_resource,
]
list_child_resources = [
@@ -3853,6 +4502,7 @@ class ReviewReplyResource(BaseReviewResource):
'Location': self.get_href(reply, request, *args, **kwargs),
}
+ @webapi_check_local_site
@webapi_login_required
@webapi_response_errors(DOES_NOT_EXIST, NOT_LOGGED_IN, PERMISSION_DENIED)
@webapi_request_fields(
@@ -3958,6 +4608,7 @@ class ReviewDraftResource(WebAPIResource):
singleton = True
uri_name = 'draft'
+ @webapi_check_local_site
@webapi_login_required
def get(self, request, *args, **kwargs):
try:
@@ -3987,6 +4638,7 @@ class ReviewResource(BaseReviewResource):
review_diff_comment_resource,
review_reply_resource,
review_screenshot_comment_resource,
+ review_file_comment_resource,
]
list_child_resources = [
@@ -4086,6 +4738,87 @@ class ScreenshotResource(BaseScreenshotResource):
screenshot_resource = ScreenshotResource()
+class UploadedFileResource(BaseUploadedFileResource):
+ """A resource representing a screenshot on a review request."""
+ model_parent_key = 'review_request'
+
+ item_child_resources = [
+ file_comment_resource,
+ ]
+
+ allowed_methods = ('GET', 'POST', 'PUT', 'DELETE')
+
+ @augment_method_from(BaseUploadedFileResource)
+ def get_list(self, *args, **kwargs):
+ """Returns a list of screenshots on the review request.
+
+ Each screenshot in this list is an uploaded screenshot that is
+ shown on the review request.
+ """
+ pass
+
+ @augment_method_from(BaseUploadedFileResource)
+ def create(self, request, *args, **kwargs):
+ """Creates a new screenshot from an uploaded file.
+
+ This accepts any standard image format (PNG, GIF, JPEG) and associates
+ it with a draft of a review request.
+
+ Creating a new screenshot will automatically create a new review
+ request draft, if one doesn't already exist. This screenshot will
+ be part of that draft, and will be shown on the review request
+ when it's next published.
+
+ It is expected that the client will send the data as part of a
+ :mimetype:`multipart/form-data` mimetype. The screenshot's name
+ and content should be stored in the ``path`` field. A typical request
+ may look like::
+
+ -- SoMe BoUnDaRy
+ Content-Disposition: form-data; name=path; filename="foo.png"
+
+
+ -- SoMe BoUnDaRy --
+ """
+ pass
+
+ @augment_method_from(BaseUploadedFileResource)
+ def update(self, request, caption=None, *args, **kwargs):
+ """Updates the screenshot's data.
+
+ This allows updating the screenshot. The caption, currently,
+ is the only thing that can be updated.
+
+ Updating a screenshot will automatically create a new review request
+ draft, if one doesn't already exist. The updates won't be public
+ until the review request draft is published.
+ """
+ pass
+
+ @webapi_check_local_site
+ @webapi_login_required
+ @augment_method_from(WebAPIResource)
+ def delete(self, *args, **kwargs):
+ """Deletes the screenshot.
+
+ This will remove the screenshot from the draft review request.
+ This cannot be undone.
+
+ Deleting a screenshot will automatically create a new review request
+ draft, if one doesn't already exist. The screenshot won't be actually
+ removed until the review request draft is published.
+
+ This can be used to remove old screenshots that were previously
+ shown, as well as newly added screenshots that were part of the
+ draft.
+
+ Instead of a payload response on success, this will return :http:`204`.
+ """
+ pass
+
+uploaded_file_resource = UploadedFileResource()
+
+
class ReviewRequestLastUpdateResource(WebAPIResource):
"""Provides information on the last update made to a review request.
@@ -4272,6 +5005,7 @@ class ReviewRequestResource(WebAPIResource):
review_request_last_update_resource,
review_resource,
screenshot_resource,
+ uploaded_file_resource
]
allowed_methods = ('GET', 'POST', 'PUT', 'DELETE')
@@ -4955,9 +5689,15 @@ register_resource_for_model(
register_resource_for_model(ReviewRequest, review_request_resource)
register_resource_for_model(ReviewRequestDraft, review_request_draft_resource)
register_resource_for_model(Screenshot, screenshot_resource)
+register_resource_for_model(UploadedFile, uploaded_file_resource)
register_resource_for_model(
ScreenshotComment,
lambda obj: obj.review.get().is_reply() and
review_reply_screenshot_comment_resource or
review_screenshot_comment_resource)
+register_resource_for_model(
+ UploadedFileComment,
+ lambda obj: obj.review.get().is_reply() and
+ review_reply_file_comment_resource or
+ review_file_comment_resource)
register_resource_for_model(User, user_resource)