# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""Main Controller"""
import logging
from string import Template
from tg import expose, request, config, session, redirect, flash
from tg.decorators import with_trailing_slash
from tg import tmpl_context as c
from tg import response
from tg import TGController
from webob import exc
from allura.app import SitemapEntry
from allura.lib import plugin
from allura.controllers.error import ErrorController
from allura.controllers.project import NeighborhoodController
from allura import model as M
from allura.lib.widgets import project_list as plw
from allura.ext.personal_dashboard.dashboard_main import DashboardController
from .auth import AuthController
from .trovecategories import TroveCategoryController
from .search import SearchController, ProjectBrowseController
from .newforge import NewForgeController
from .site_admin import SiteAdminController
from .rest import RestController
__all__ = ['RootController']
log = logging.getLogger(__name__)
flash.static_template = Template("$$('#messages').notify('$message', {status: '$status'});")
class W:
project_summary = plw.ProjectSummary()
class RootController(TGController):
"""
The root controller for the allura application.
All the other controllers and WSGI applications should be mounted on this
controller. For example::
panel = ControlPanelController()
another_app = AnotherWSGIApplication()
Keep in mind that WSGI applications shouldn't be mounted directly: They
must be wrapped around with :class:`tg.controllers.WSGIAppController`.
When testing the root, BasetestProjectRootController should be considered as the root controller
"""
auth = AuthController()
error = ErrorController()
nf = NewForgeController()
search = SearchController()
rest = RestController()
categories = TroveCategoryController()
dashboard = DashboardController()
browse = ProjectBrowseController()
def __init__(self):
super().__init__()
self.nf.admin = SiteAdminController()
@expose()
def _lookup(self, nbhd_mount, *remainder):
n_url_prefix = '/%s/' % nbhd_mount
n = self._lookup_neighborhood(n_url_prefix)
if n and not n.url_prefix.startswith('//'):
return NeighborhoodController(n), remainder
else:
raise exc.HTTPNotFound
def _lookup_neighborhood(self, url_prefix):
n = M.Neighborhood.query.get(url_prefix=url_prefix)
return n
def _check_security(self):
c.project = c.app = None
c.user = plugin.AuthenticationProvider.get(request).authenticate_request()
assert c.user is not None, ('c.user should always be at least User.anonymous(). '
'Did you run `paster setup-app` to create the database?')
if not c.user.is_anonymous():
c.user.track_active(request)
# Make sure the page really isn't cached (not accessible by back button, etc)
# pylons.configuration defaults to "no-cache" only.
# See also http://blog.55minutes.com/2011/10/how-to-defeat-the-browser-back-button-cache/ and
# https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching?hl=en#defining_optimal_cache-control_policy
response.headers['Cache-Control'] = 'no-cache, no-store, must-revalidate'
@expose()
@with_trailing_slash
def index(self, **kw):
"""Handle the front-page."""
if not c.user.is_anonymous():
redirect('/dashboard')
else:
redirect('/neighborhood')
@expose('jinja:allura:templates/neighborhood_list.html')
def neighborhood(self, **kw):
neighborhoods = M.Neighborhood.query.find().sort('name')
categories = M.ProjectCategory.query.find(
{'parent_id': None}).sort('name').all()
c.custom_sidebar_menu = [
SitemapEntry(cat.label, '/browse/' + cat.name) for cat in categories
]
return dict(neighborhoods=neighborhoods, title="All Neighborhoods")