Summary

Redirect some views in read-only mode, hide links to these views

Review Request #8811 — Created March 11, 2017 and submitted Jan. 10, 2018, 2:25 p.m.

Information

Owner

khp

Repository

Review Board

Branch

master

Bugs

Depends On

~~8648~~, ~~8657~~, ~~8810~~

Blocks

8861, 8824, 8847, 8812

Reviewers

Groups

reviewboard, students

People

Description

Read-only mode is a setting an admin can enable to prevent writes to
the database. This can be used when the site is under maintenence or
being upgraded. This commit adds a decorator that wraps
login_required. If no arguments are passed into the new
login_required it will behave the same as django's login_required.
If a boolean value for redirect_read_only is set to true, a decorator
that checks whether the user is in read-only mode and should redirect
will be returned.

"New Review Request" and "My Accounts" now redirect to a Read-Only page
and "Register" redirects to "Log-in". Buttons to these pages are
removed for users affected in read-only mode.

Testing Done


Check that accessing New Review Request and My Accounts redirects to

503 page logged in as non-admin in read-only mode
Check that accessing Register when logged in or not redirects to the

log-in page
Check that links to New Review/My Accounts/Register are removed for

non-admins/unauthenticated users
Check that submitting Register form when in read-only mode does not

do any writes

Issues

Description	From	Last Updated
Mind wrapping your description & testing done at 72 characters?	brennie	April 6, 2017, 11:32 a.m.
Col: 80 E501 line too long (82 > 79 characters)	reviewbot	March 11, 2017, 8:46 p.m.
'django_login_required' imported but unused	reviewbot	March 11, 2017, 8:40 p.m.
Col: 80 E501 line too long (82 > 79 characters)	reviewbot	March 11, 2017, 8:40 p.m.
Col: 5 E128 continuation line under-indented for visual indent	reviewbot	March 11, 2017, 8:41 p.m.
Col: 5 E128 continuation line under-indented for visual indent	reviewbot	March 11, 2017, 8:41 p.m.
Needs Args and Returns. The return type here is callable.	brennie	March 14, 2017, 4:16 a.m.
No blank line here.	brennie	March 14, 2017, 4:16 a.m.
No blank line here.	brennie	April 6, 2017, 11:33 a.m.
No blank line here.	brennie	April 6, 2017, 11:33 a.m.
We prefer to use a hanging indent here. Reformat as: if (auth_backends[0].supports_registration and siteconfig.get('auth_enable_registration') and not siteconfig.get('site_read_only')): Also, mind changing …	brennie	April 6, 2017, 11:33 a.m.
The request arg is not used, so I don't think we need to have it here. It can live in …	brennie	April 6, 2017, 7:13 p.m.
Comments should end with a period.	brennie	April 6, 2017, 7:13 p.m.
redefinition of unused 'login_required' from line 3	reviewbot	April 6, 2017, 8:28 p.m.

Tool: Pyflakes
Processed Files:
    reviewboard/reviews/views.py
    reviewboard/accounts/decorators.py
    reviewboard/accounts/views.py
    reviewboard/urls.py

Ignored Files:
    reviewboard/templates/503.html
    reviewboard/templates/accounts/login.html
    reviewboard/templates/base/_nav_support_menu.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/reviews/views.py
    reviewboard/accounts/decorators.py
    reviewboard/accounts/views.py
    reviewboard/urls.py

Ignored Files:
    reviewboard/templates/503.html
    reviewboard/templates/accounts/login.html
    reviewboard/templates/base/_nav_support_menu.html

reviewboard/accounts/decorators.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (82 > 79 characters)
```
reviewboard/accounts/views.py (Diff revision 1)
The issue has been dropped. Show all issues
```
 'django_login_required' imported but unused
```
reviewboard/accounts/views.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 80
 E501 line too long (82 > 79 characters)
```
reviewboard/urls.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 5
 E128 continuation line under-indented for visual indent
```
reviewboard/urls.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 5
 E128 continuation line under-indented for visual indent
```

Diff:

Revision 2 (+85 -10)

Show changes

	reviewboard/urls.py
	reviewboard/accounts/decorators.py
	reviewboard/accounts/views.py
	reviewboard/reviews/views.py
	reviewboard/templates/503.html
	reviewboard/templates/accounts/login.html
	reviewboard/templates/base/_nav_support_menu.html

Tool: Pyflakes
Processed Files:
    reviewboard/reviews/views.py
    reviewboard/accounts/decorators.py
    reviewboard/accounts/views.py
    reviewboard/urls.py

Ignored Files:
    reviewboard/templates/503.html
    reviewboard/templates/accounts/login.html
    reviewboard/templates/base/_nav_support_menu.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/reviews/views.py
    reviewboard/accounts/decorators.py
    reviewboard/accounts/views.py
    reviewboard/urls.py

Ignored Files:
    reviewboard/templates/503.html
    reviewboard/templates/accounts/login.html
    reviewboard/templates/base/_nav_support_menu.html

reviewboard/accounts/decorators.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Needs Args and Returns. The return type here is callable.
```
reviewboard/accounts/decorators.py (Diff revision 2)
The issue has been resolved. Show all issues
```
No blank line here.
```

Diff:

Revision 3 (+96 -10)

Show changes

	reviewboard/urls.py
	reviewboard/accounts/decorators.py
	reviewboard/accounts/views.py
	reviewboard/reviews/views.py
	reviewboard/templates/503.html
	reviewboard/templates/accounts/login.html
	reviewboard/templates/base/_nav_support_menu.html

Tool: Pyflakes
Processed Files:
    reviewboard/reviews/views.py
    reviewboard/accounts/decorators.py
    reviewboard/accounts/views.py
    reviewboard/urls.py

Ignored Files:
    reviewboard/templates/503.html
    reviewboard/templates/accounts/login.html
    reviewboard/templates/base/_nav_support_menu.html



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/reviews/views.py
    reviewboard/accounts/decorators.py
    reviewboard/accounts/views.py
    reviewboard/urls.py

Ignored Files:
    reviewboard/templates/503.html
    reviewboard/templates/accounts/login.html
    reviewboard/templates/base/_nav_support_menu.html

Ship it!

```
Just a few nits.
```

The issue has been resolved. Show all issues

Mind wrapping your description & testing done at 72 characters?

reviewboard/accounts/decorators.py (Diff revision 3)
The issue has been resolved. Show all issues
```
No blank line here.
```
reviewboard/accounts/decorators.py (Diff revision 3)
The issue has been resolved. Show all issues
```
No blank line here.
```

reviewboard/accounts/views.py (Diff revision 3)

The issue has been resolved. Show all issues

We prefer to use a hanging indent here. Reformat as:

if (auth_backends[0].supports_registration and
    siteconfig.get('auth_enable_registration') and
    not siteconfig.get('site_read_only')):


Also, mind changing that other string to single quotes?

reviewboard/accounts/views.py (Diff revision 3)

The issue has been resolved. Show all issues

The request arg is not used, so I don't think we need to have it here. It can live in *args.

reviewboard/urls.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Comments should end with a period.
```

Description:

~		Read-only mode is a setting an admin can enable to prevent writes to the database. This can be used when the site is under maintenence or being upgraded. This commit adds a decorator that wraps login_required. If no arguments are passed into the new login_required it will behave the same as django's login_required. If a boolean value for redirect_read_only is set to true, a decorator that checks whether the user is in read-only mode and redirect apprpriately will be returned.
	~	Read-only mode is a setting an admin can enable to prevent writes to
	+	the database. This can be used when the site is under maintenence or
	+	being upgraded. This commit adds a decorator that wraps
	+	`login_required`. If no arguments are passed into the new
	+	`login_required` it will behave the same as django's `login_required`.
	+	If a boolean value for `redirect_read_only` is set to true, a decorator
	+	that checks whether the user is in read-only mode and should redirect
	+	will be returned.

~		"New Review Request" and "My Accounts" now redirect to a Read-Only page and "Register" redirects to "Log-in". Buttons to these pages are removed for users affected in read-only mode.
	~	"New Review Request" and "My Accounts" now redirect to a Read-Only page
	+	and "Register" redirects to "Log-in". Buttons to these pages are
	+	removed for users affected in read-only mode.

Testing Done:

~		Check that accessing New Review Request and My Accounts redirects to 503 page logged in as non-admin in read-only mode
~		Check that accessing Register when logged in or not redirects to the log-in page
~		Check that links to New Review/My Accounts/Register are removed for non-admins/unauthenticated users
~		Check that submitting Register form when in read-only mode does not do any writes
	~	Check that accessing New Review Request and My Accounts redirects to 503 page logged in as non-admin in read-only mode
	~	Check that accessing Register when logged in or not redirects to the log-in page
	~	Check that links to New Review/My Accounts/Register are removed for non-admins/unauthenticated users
	~	Check that submitting Register form when in read-only mode does not do any writes

Diff:

Revision 4 (+92 -8)

Show changes

	reviewboard/urls.py
	reviewboard/accounts/decorators.py
	reviewboard/accounts/views.py
	reviewboard/reviews/views.py
	reviewboard/templates/503.html
	reviewboard/templates/accounts/login.html
	reviewboard/templates/base/_nav_support_menu.html

Checks run (1 failed, 1 succeeded, 1 failed with error)

JSHint passed.

PEP8 Style Checker internal error.

Pyflakes failed.

Pyflakes

reviewboard/accounts/views.py (Diff revision 4)
The issue has been resolved. Show all issues
```
 redefinition of unused 'login_required' from line 3
```

Change Summary:

Fix import problem

Diff:

Revision 5 (+92 -9)

Show changes

	reviewboard/urls.py
	reviewboard/accounts/decorators.py
	reviewboard/accounts/views.py
	reviewboard/reviews/views.py
	reviewboard/templates/503.html
	reviewboard/templates/accounts/login.html
	reviewboard/templates/base/_nav_support_menu.html

Checks run (2 succeeded, 1 failed with error)

JSHint passed.

PEP8 Style Checker internal error.

Pyflakes passed.

Status:: Completed
Change Summary:: Pushed to release-4.0.x (e0e7431)