diff --git a/.gitignore b/.gitignore index 8e30f6c..75eba39 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,10 @@ pip-log.txt # paste config files development.ini production.ini + +# Default wiki directory +wiki.git/ +wiki/ + +# Default assets directory +assets/ diff --git a/README.rst b/README.rst index 6fa9757..536ce84 100644 --- a/README.rst +++ b/README.rst @@ -152,3 +152,26 @@ Here is an example config for Apache with ``mod_wsgi``: # Make sure to setup anything else you are using, such as SSL certs +Static Assets +~~~~~~~~~~~~~ + +The location of site-specific assets for development can be configured in your development config: + +.. code:: ini + + # Custom Assets Configuration + custom_assets.dir = /path/to/assets/dir + custom_assets.css = relative/path/to/css.file + custom_assets.logo = relative/path/to/logo.file + +Wiki +~~~~ + +Mozzarella includes a wiki that can be enabled by uncommenting the `wiki.repo` option in your configuration. +When visiting the wiki for the first time after enabling it, Mozzarella will generate a bare git repository with a sample +page in it. + +.. code:: ini + + # Wiki repository location + wiki.repo = /path/to/wiki/dir diff --git a/acmwebsite/config/app_cfg.py b/acmwebsite/config/app_cfg.py index fcc261a..56f041b 100644 --- a/acmwebsite/config/app_cfg.py +++ b/acmwebsite/config/app_cfg.py @@ -75,6 +75,9 @@ # what is the class you want to use to search for users in the database base_config.sa_auth.user_class = model.User +#Configure site name +base_config['site.name'] = 'Mozzarella' + from tg.configuration.auth import TGAuthMetadata diff --git a/acmwebsite/config/middleware.py b/acmwebsite/config/middleware.py index 6e85585..a0cc834 100644 --- a/acmwebsite/config/middleware.py +++ b/acmwebsite/config/middleware.py @@ -2,10 +2,10 @@ """WSGI middleware initialization for the acm-website application.""" from acmwebsite.config.app_cfg import base_config from acmwebsite.config.environment import load_environment - # Depot from depot.manager import DepotManager +from tg.support.statics import StaticsMiddleware __all__ = ['make_app'] @@ -34,6 +34,10 @@ def make_app(global_conf, full_stack=True, **app_conf): """ app = make_base_app(global_conf, full_stack=True, **app_conf) app = DepotManager.make_middleware(app) + try: + app = StaticsMiddleware(app, app_conf['site.custom_assets']) + except KeyError: + pass # Wrap your base TurboGears 2 application with custom middleware here diff --git a/acmwebsite/controllers/root.py b/acmwebsite/controllers/root.py index ca49bc9..5ee7ce3 100644 --- a/acmwebsite/controllers/root.py +++ b/acmwebsite/controllers/root.py @@ -23,6 +23,7 @@ from acmwebsite.controllers.schedule import ScheduleController from acmwebsite.controllers.survey import SurveysController from acmwebsite.controllers.project import ProjectsController +from acmwebsite.controllers.wiki import WikiPagesController from sqlalchemy.sql import functions @@ -53,6 +54,7 @@ class RootController(BaseController): error = ErrorController() contact = ContactController() projects = ProjectsController() + wiki = WikiPagesController() def _before(self, *args, **kw): tmpl_context.project_name = "acmwebsite" diff --git a/acmwebsite/controllers/wiki.py b/acmwebsite/controllers/wiki.py new file mode 100644 index 0000000..2fd5097 --- /dev/null +++ b/acmwebsite/controllers/wiki.py @@ -0,0 +1,86 @@ +"""Wiki controller module""" +import os +import tg +import pygit2 as pg + +from tg import expose + +from acmwebsite.lib.base import BaseController + +from pygit2 import Repository,init_repository +from pygit2 import Tree +from pygit2 import Signature + +from docutils.core import publish_parts + + +__all__ = ['WikiController'] + +class WikiController(BaseController): + """Controls the wiki""" + + def __init__(self, repo, entry): + self.repo = repo + self.entry = entry + + @expose('acmwebsite.templates.wiki_view') + def _default(self): + """Display a specific page""" + settings = {'initial_header_level': 2, + 'file_insertion_enabled': 0, + 'raw_enabled': 0, + 'disable_config': 1, + } + + blob = self.repo.get(self.entry.id) + document = publish_parts(blob.data, writer_name='html5', settings_overrides=settings) + return dict(pagename=self.entry.name.strip('.rst'), parts=document) + + @expose('acmwebsite.templates.wiki_history') + def history(self): + revision_list = [] + last_id = None + + #Get a list of commits that include the queried file + for commit in self.repo.walk(self.repo.head.target, pg.GIT_SORT_TIME): + if filename in commit.tree: + entry = commit.tree[filename] + if entry.id != last_id: #Only add to history if it file chnaged. + revision_list.append({"author": commit.author, + "time": commit.commit_time, + "message": commit.message}) + last_id = entry.id + + if not revision_list: #No commits include file - possibly faulty? + tg.abort(404, "Page not found") + return dict(page=pagename, revisions=revision_list) + +class WikiPagesController(BaseController): + def __new__(cls, repo_path=None): + if not repo_path: + repo_path = tg.config.get('wiki.repo') + if not repo_path: + return None + + obj = super().__new__(cls) + obj.repo = Repository(repo_path) + return obj + + @expose() + def _lookup(self, pagename=None, *args): + entry = None + if pagename: + tb = self.repo.TreeBuilder(self.repo.head.peel(Tree)) + entry = tb.get(pagename + '.rst') + if not entry: + tg.abort(404, "Page not found") + return WikiController(self.repo, entry), args + + @expose() + def index(self): + tg.redirect('/wiki/FrontPage') + + @expose('acmwebsite.templates.wiki_pagelist') + def pagelist(self): + pages = [entry.name[:-4] for entry in self.repo.head.peel(Tree)] + return dict(pages=pages) \ No newline at end of file diff --git a/acmwebsite/public/css/site.css b/acmwebsite/public/css/site.css new file mode 100644 index 0000000..e69de29 diff --git a/acmwebsite/public/css/style.css b/acmwebsite/public/css/style.css index 2aba695..7ac1c36 100644 --- a/acmwebsite/public/css/style.css +++ b/acmwebsite/public/css/style.css @@ -80,7 +80,7 @@ } /* Logo */ -.acm-logo { +.logo { margin: 20px 0; max-width: 400px; width: 100%; diff --git a/acmwebsite/templates/archives.xhtml b/acmwebsite/templates/archives.xhtml index f4f91e0..4ddc3c8 100644 --- a/acmwebsite/templates/archives.xhtml +++ b/acmwebsite/templates/archives.xhtml @@ -5,7 +5,7 @@ - Mines ACM - Mailing List Archives + ${tg.config.get('site.name')} - Mailing List Archives diff --git a/acmwebsite/templates/contact.xhtml b/acmwebsite/templates/contact.xhtml index ec58835..340fb67 100644 --- a/acmwebsite/templates/contact.xhtml +++ b/acmwebsite/templates/contact.xhtml @@ -1,6 +1,6 @@ - Mines ACM - Contact + ${tg.config.get('site.name')} - Contact
diff --git a/acmwebsite/templates/error.xhtml b/acmwebsite/templates/error.xhtml index 19b902f..799c563 100644 --- a/acmwebsite/templates/error.xhtml +++ b/acmwebsite/templates/error.xhtml @@ -1,6 +1,6 @@ - Mines ACM - Error + ${tg.config.get('site.name')} - Error

Error ${code}

diff --git a/acmwebsite/templates/index.xhtml b/acmwebsite/templates/index.xhtml index 6b78cee..515e6e7 100644 --- a/acmwebsite/templates/index.xhtml +++ b/acmwebsite/templates/index.xhtml @@ -4,19 +4,19 @@ - Mines ACM + ${tg.config.get('site.name')}
-
-
+
+
-

Mines ACM Student Chapter

+

${tg.config.get('site.name')}

The Mines ACM Student Chapter is the local chapter of the Association for Computing Machinery at the Colorado School of Mines. As a Mozilla Open Source @@ -32,7 +32,7 @@

-

Join our ACM Chapter!

+

Join our ${tg.config.get('site.name')}!

To join our ACM chapter, simply show up to our meetings. Newcomers are welcome to all meetings.

@@ -57,6 +57,17 @@
+
+
+
+

${tg.config.get('site.name')} Wiki

+
+
+

Did you know our website has a wiki? You can go to the wiki homepage here + or by clicking on the "wiki" button on the toolbar.

+
+
+
diff --git a/acmwebsite/templates/login.xhtml b/acmwebsite/templates/login.xhtml index 4aef8b4..d65092f 100644 --- a/acmwebsite/templates/login.xhtml +++ b/acmwebsite/templates/login.xhtml @@ -1,6 +1,6 @@ - Mines ACM - Login + ${tg.config.get('site.name')} - Login

Login with MultiPass

diff --git a/acmwebsite/templates/mailinglist.xhtml b/acmwebsite/templates/mailinglist.xhtml index 82718e1..896c623 100644 --- a/acmwebsite/templates/mailinglist.xhtml +++ b/acmwebsite/templates/mailinglist.xhtml @@ -5,7 +5,7 @@ - Mines ACM - Mailing List + ${tg.config.get('site.name')} - Mailing List diff --git a/acmwebsite/templates/master.xhtml b/acmwebsite/templates/master.xhtml index 0db00ca..1017bce 100644 --- a/acmwebsite/templates/master.xhtml +++ b/acmwebsite/templates/master.xhtml @@ -9,6 +9,7 @@ + @@ -16,7 +17,7 @@
@@ -38,6 +39,7 @@
  • Projects
  • Mailing List
  • Contact
    • +
  • Wiki
      • diff --git a/acmwebsite/templates/message.xhtml b/acmwebsite/templates/message.xhtml index 8a08c99..a4400d0 100644 --- a/acmwebsite/templates/message.xhtml +++ b/acmwebsite/templates/message.xhtml @@ -5,7 +5,7 @@ - Mines ACM - Post: ${message.subject} + ${tg.config.get('site.name')} - Post: ${message.subject} diff --git a/acmwebsite/templates/profile.xhtml b/acmwebsite/templates/profile.xhtml index 1d4e4dc..fe5a523 100644 --- a/acmwebsite/templates/profile.xhtml +++ b/acmwebsite/templates/profile.xhtml @@ -5,7 +5,7 @@ - Mines ACM - ${u} + ${tg.config.get('site.name')} - ${u} diff --git a/acmwebsite/templates/projects.xhtml b/acmwebsite/templates/projects.xhtml index 74f67a4..b038c7b 100644 --- a/acmwebsite/templates/projects.xhtml +++ b/acmwebsite/templates/projects.xhtml @@ -5,7 +5,7 @@ - Mines ACM - Projects + ${tg.config.get('site.name')} - Projects diff --git a/acmwebsite/templates/schedule.xhtml b/acmwebsite/templates/schedule.xhtml index 4e544ea..6feb0ab 100644 --- a/acmwebsite/templates/schedule.xhtml +++ b/acmwebsite/templates/schedule.xhtml @@ -5,7 +5,7 @@ - Mines ACM - Schedule + ${tg.config.get('site.name')} - Schedule diff --git a/acmwebsite/templates/survey.xhtml b/acmwebsite/templates/survey.xhtml index e80e79b..ff06b54 100644 --- a/acmwebsite/templates/survey.xhtml +++ b/acmwebsite/templates/survey.xhtml @@ -4,7 +4,7 @@ py:extends="master.xhtml"> - Mines ACM - Survey + ${tg.config.get('site.name')} - Survey
      diff --git a/acmwebsite/templates/survey_results.xhtml b/acmwebsite/templates/survey_results.xhtml index 0bbd496..64e6d3c 100644 --- a/acmwebsite/templates/survey_results.xhtml +++ b/acmwebsite/templates/survey_results.xhtml @@ -4,7 +4,7 @@ py:extends="master.xhtml"> - Mines ACM - Survey ${survey_id} Responses + ${tg.config.get('site.name')} - Survey ${survey_id} Responses diff --git a/acmwebsite/templates/wiki_history.xhtml b/acmwebsite/templates/wiki_history.xhtml new file mode 100644 index 0000000..1167a45 --- /dev/null +++ b/acmwebsite/templates/wiki_history.xhtml @@ -0,0 +1,40 @@ + + + + + + ${tg.config.get('site.name')} Wiki - $page History + + + + + + ${item["message"]} + + + ${item["author"].name} + + + ${item["time"]} + + + + +

      History: $page

      + + + + + + + + + + + ${revision(entry)} + +
      Commit MessageAuthorCommit time
      + + diff --git a/acmwebsite/templates/wiki_pagelist.xhtml b/acmwebsite/templates/wiki_pagelist.xhtml new file mode 100644 index 0000000..61a9e7a --- /dev/null +++ b/acmwebsite/templates/wiki_pagelist.xhtml @@ -0,0 +1,21 @@ + + + + + + ${tg.config.get('site.name')} Wiki - Page List + + + +

      Page List

      +
      +
      +
      + $page +
      +
      +
      + + diff --git a/acmwebsite/templates/wiki_view.xhtml b/acmwebsite/templates/wiki_view.xhtml new file mode 100644 index 0000000..f9c1591 --- /dev/null +++ b/acmwebsite/templates/wiki_view.xhtml @@ -0,0 +1,31 @@ + + + + + + ${tg.config.get('site.name')} Wiki - ${parts['title']} + + + +
      +
      +

      ${parts['title']}

      +
      Page content will go here
      +
      +
      +
      + +
      + + diff --git a/acmwebsite/wiki-assets/FrontPage.rst b/acmwebsite/wiki-assets/FrontPage.rst new file mode 100644 index 0000000..4288892 --- /dev/null +++ b/acmwebsite/wiki-assets/FrontPage.rst @@ -0,0 +1,25 @@ +Welcome to the wiki! +==================== + +It looks like this wiki has just been created. A git repository has been created +at the location specified in ``wiki.repo`` in your ``config.ini``. + +Contributing +------------ + +To edit or add pages to the wiki, clone the wiki repository, edit or create your +pages, then commit and push them the remote repository on the website. Pages +must be in `reStructuredText format`_ and have the file extension ``.rst`` + +.. _reStructuredText format: http://docutils.sourceforge.net/rst.html + +The wiki page titles depend on your ReST documents having titles - don't include +any text before the page title. + +.. code:: rest + + This is a title + =============== + +This page is in your wiki repository as ``FrontPage.rst``. To replace it (i.e. +set a new index page for your wiki), replace this file with the new front page. diff --git a/development.ini.sample b/development.ini.sample index 66db108..e1343cf 100644 --- a/development.ini.sample +++ b/development.ini.sample @@ -13,6 +13,16 @@ # execute malicious code after an exception is raised. debug = true +# Site name configuration +#site.name = Mozzarella + +# Custom Assets Configuration +#site.custom_assets = %(here)s/assets + +# Wiki repository location +#wiki.repo = %(here)s/wiki.git + + # ERROR REPORTING BY EMAIL # Uncomment to enable email error reporting, you probably want this # on production to receive application crashes by email diff --git a/setup.py b/setup.py index 94f3908..d164a7d 100644 --- a/setup.py +++ b/setup.py @@ -40,6 +40,7 @@ "icalendar", "Kajiki >= 0.6.3", "docutils", + "pygit2", "pytz", "repoze.who", "requests",