Submitter:	Christian Hammond	Reviewers
Branch:	trunk	Groups:	reviewboard
Bugs:		People:
Change Number:	None	Repository:	Review Board SVN

Description:

There are unfortunately times when upgrading Review Board is not as simple as running "svn up." We've so far been unhelpful with this. Now that we're going to require some changes for the media locations and users aren't necessarily going to see the message on the listserv, I felt we should have a nice way of communicating to the user.

This change introduces the ability to add checks on startup. These may include schema changes in the future, but right now they check if the media setup is what we expect. If not, an error page is displayed with helpful information. Once the user fixes the problem and restarts Review Board, the normal URLs will be activated.

This can also be useful for first-time users who currently have very little aid.

Testing Done:

Tried this change with a branch using the old media setup and saw that it told me how to fix the problem instead of taking me to any URLs.

Tried it on a branch with the new media setup and Review Board operated as normal.

Diff revision 1 (Latest)

Files Changed:

/trunk/reviewboard/settings.py: 2 changes [ 1 2 ]
/trunk/reviewboard/urls.py: 6 changes [ 1 2 3 4 5 6 ]
/trunk/reviewboard/admin/checks.py: 1 change [ new content ]
/trunk/reviewboard/admin/views.py: 1 change [ new content ]
/trunk/reviewboard/templates/admin/manual_updates_required.html: 1 change [ new content ]
/trunk/reviewboard/templates/admin/manual-updates/media-upload-dir.html: 1 change [ new content ]

Expand changes

 # Django settings for reviewboard project.
 import os
 import sys
 DEBUG = True
 ADMINS = (
     ('Example Joe', 'admin@example.com')
+)
     'django.contrib.sessions',
     'djblets.datagrid',
     'djblets.util',
     'djblets.webapi',
     'reviewboard.accounts',
     'reviewboard.admin',
     'reviewboard.diffviewer',
     'reviewboard.iphone',
     'reviewboard.reports',
     'reviewboard.reviews',
     'reviewboard.scmtools',

 import os.path
 from django.conf import settings
 from django.conf.urls.defaults import patterns, include, handler404, handler500
 from reviewboard.admin.checks import check_updates_required
 from reviewboard.reviews.feeds import RssReviewsFeed, AtomReviewsFeed, \
                                       RssSubmitterReviewsFeed, \
                                       AtomSubmitterReviewsFeed, \
                                       RssGroupReviewsFeed, \
                                       AtomGroupReviewsFeed
 # URLs global to all modes
 urlpatterns = patterns('',
     (r'^admin/', include('django.contrib.admin.urls')),
+)
 # Add static media if running in DEBUG mode
 if settings.DEBUG:
     def htdocs_path(leaf):
         return os.path.join(settings.HTDOCS_ROOT, leaf)
     urlpatterns += patterns('django.views.static',
         (r'^css/(?P<path>.*)$', 'serve', {
             'show_indexes': True,
             'document_root': htdocs_path('css'),
             }),
         (r'^images/(?P<path>.*)$', 'serve', {
             'show_indexes': True,
             'document_root': htdocs_path('images'),
             }),
         (r'^scripts/(?P<path>.*)$', 'serve', {
             'show_indexes': True,
             'document_root': htdocs_path('scripts')
             }),
+    )
 # Check that we're actually able to run. There may have been changes that
 # require the user to manually update things on the server and restart.
 if check_updates_required():
     # There's updates required. Disable the main URLs for now, since it might
     # be useless.
     urlpatterns += patterns('',
         (r'^.*', 'reviewboard.admin.views.manual_updates_required'),
+    )
 else:
-rss_feeds = {
+    rss_feeds = {
-    'r': RssReviewsFeed,
+        'r': RssReviewsFeed,
-    'users': RssSubmitterReviewsFeed,
+        'users': RssSubmitterReviewsFeed,
-    'groups': RssGroupReviewsFeed,
+        'groups': RssGroupReviewsFeed,
+    }
-    'groups': AtomGroupReviewsFeed,
+        'groups': AtomGroupReviewsFeed,
+    }
-# Main includes
+    # Main includes
-urlpatterns = patterns('',
+    urlpatterns += patterns('',
-    (r'^admin/', include('django.contrib.admin.urls')),
+        (r'^admin/', include('django.contrib.admin.urls')),
-    (r'^api/json/', include('reviewboard.webapi.urls')),
+        (r'^api/json/', include('reviewboard.webapi.urls')),
-    (r'^r/', include('reviewboard.reviews.urls')),
+        (r'^r/', include('reviewboard.reviews.urls')),
-    (r'^reports/', include('reviewboard.reports.urls')),
+        (r'^reports/', include('reviewboard.reports.urls')),
+    )
+    )
-# And the rest ...
+    # And the rest ...
-urlpatterns += patterns('',
+    urlpatterns += patterns('',
-    (r'^$', 'django.views.generic.simple.redirect_to', {'url': 'dashboard/'}),
+        (r'^$', 'django.views.generic.simple.redirect_to',
          {'url': 'dashboard/'}),
-    # Authentication and accounts
+        # Authentication and accounts
-    (r'^account/login/$', 'djblets.auth.views.login',
+        (r'^account/login/$', 'djblets.auth.views.login',
-     {'next_page': settings.SITE_ROOT + 'dashboard/',
+         {'next_page': settings.SITE_ROOT + 'dashboard/',
-      'extra_context': {'BUILTIN_AUTH': settings.BUILTIN_AUTH}}),
+          'extra_context': {'BUILTIN_AUTH': settings.BUILTIN_AUTH}}),
-else:
+    else:
-    urlpatterns += patterns('',
+        urlpatterns += patterns('',
-        (r'^account/register/$',
+            (r'^account/register/$',
-         'django.views.generic.simple.redirect_to',
+             'django.views.generic.simple.redirect_to',
-         {'url': settings.SITE_ROOT + 'account/login/'}))
+             {'url': settings.SITE_ROOT + 'account/login/'}))
-# Add static media if running in DEBUG mode
-if settings.DEBUG:
-    def htdocs_path(leaf):
-        return os.path.join(settings.HTDOCS_ROOT, leaf)
-    urlpatterns += patterns('django.views.static',
-        (r'^css/(?P<path>.*)$', 'serve', {
-            'show_indexes': True,
-            'document_root': htdocs_path('css'),
-            }),
-        (r'^images/(?P<path>.*)$', 'serve', {
-            'show_indexes': True,
-            'document_root': htdocs_path('images'),
-            }),
-        (r'^scripts/(?P<path>.*)$', 'serve', {
-            'show_indexes': True,
-            'document_root': htdocs_path('scripts')
-            }),

 import os
 from django.conf import settings
 _updates_required = []
 _install_fine = False
 def check_updates_required():
     """
     Checks if there are manual updates required before Review Board can be
     used on this server.
     """
     global _updates_required
     global _install_fine
     if not _updates_required and not _install_fine:
         # Check if there's a media/uploaded/images directory. If not, this is
         # either a new install or is using the old-style media setup and needs
         # to be manually upgraded.
         uploaded_dir = os.path.join(settings.MEDIA_ROOT, "uploaded")
         if not os.path.isdir(uploaded_dir) or \
            not os.path.isdir(os.path.join(uploaded_dir, "images")):
             _updates_required.append(
                 ("admin/manual-updates/media-upload-dir.html", {}))
         # TODO: Put checks here for schema changes.
         _install_fine = not _updates_required
     return _updates_required

 from django.shortcuts import render_to_response
 from django.template.context import RequestContext
 from django.template.loader import render_to_string
 from reviewboard.admin.checks import check_updates_required
 def manual_updates_required(request,
                             template_name="admin/manual_updates_required.html"):
     updates = check_updates_required()
     return render_to_response(template_name, RequestContext(request, {
         'updates': [render_to_string(template_name,
                                      RequestContext(request, extra_context))
                     for (template_name, extra_context) in updates],
     }))

 {% extends "base.html" %}
 {% load djblets_deco %}
 {% block title %}Manual server updates required{% endblock %}
 {% block content %}
 {% box "important" %}
  <h1>Manual server updates required</h1>
  <p>
   A recent change requires manual updates to be made on this server. After
   these changes are made, you should restart your server.
  </p>
  <p>
   To keep track of future updates, please visit the
   <a href="http://code.google.com/p/reviewboard/wiki/RequiredServerUpdates">Required
   Server Updates</a> page, or subscribe to the
   <a href="http://groups.google.com/group/reviewboard">mailing list</a>.
  </p>
 {% endbox %}
 {% for update in updates %}
 {% box %}
 {{update}}
 {% endbox %}
 {% endfor %}
 {% endblock %}

 <h1 class="title">Media directory changes</h1>
 <div class="main">
  <p>
   Your Review Board installation does not have a {{settings.MEDIA_ROOT}}/uploaded/images directory.
  </p>
  <h3>If this is a new installation...</h3>
  <p>
   Create both <tt>{{settings.MEDIA_ROOT}}/uploaded</tt> and
   <tt>{{settings.MEDIA_ROOT}}/uploaded/images</tt> on the server and make both directories writable by the web
   server. You can do so with the following commands:
  </p>
  <pre>
   $ cd {{settings.MEDIA_ROOT}}
   $ mkdir -p uploaded/images
   $ sudo chown -R www-data.www-data uploaded
  </pre>
  <h3>If this is an existing installation...</h3>
  <p>
   A recent update has changed the media setup on the server. This may require manual updates to
   the web server configuration. Please see the "Media Changes" section on the
   <a href="http://code.google.com/p/reviewboard/wiki/RequiredServerUpdates">Required Server
   Updates</a> page for instructions on fixing your setup.
  </p>
 </div>

/trunk/reviewboard/settings.py: 2 changes [ 1 2 ]
/trunk/reviewboard/urls.py: 6 changes [ 1 2 3 4 5 6 ]
/trunk/reviewboard/admin/checks.py: 1 change [ new content ]
/trunk/reviewboard/admin/views.py: 1 change [ new content ]
/trunk/reviewboard/templates/admin/manual_updates_required.html: 1 change [ new content ]
/trunk/reviewboard/templates/admin/manual-updates/media-upload-dir.html: 1 change [ new content ]

Review Board

beta

This change has been marked as submitted.

Show an "Updates Required" page when we require manual updates from the administrator

Diff revision 1 (Latest)

Other reviews

Your comment