From aff22be3468d594de35b2208bed1299aa9ba5074 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 1 Jun 2009 07:02:03 +0000 Subject: Add authorization chapter to bfgwiki2 tutorial. --- docs/tutorials/bfgwiki/authorization.rst | 2 +- .../src/authorization/tutorial/configure.zcml | 2 +- docs/tutorials/bfgwiki2/authorization.rst | 234 ++++++++++++- .../bfgwiki2/src/authorization/CHANGES.txt | 3 + .../bfgwiki2/src/authorization/README.txt | 4 + .../bfgwiki2/src/authorization/ez_setup.py | 276 +++++++++++++++ .../tutorials/bfgwiki2/src/authorization/setup.cfg | 6 + docs/tutorials/bfgwiki2/src/authorization/setup.py | 52 +++ .../bfgwiki2/src/authorization/tutorial.ini | 20 ++ .../src/authorization/tutorial/__init__.py | 2 + .../src/authorization/tutorial/configure.zcml | 58 ++++ .../bfgwiki2/src/authorization/tutorial/login.py | 44 +++ .../bfgwiki2/src/authorization/tutorial/models.py | 43 +++ .../bfgwiki2/src/authorization/tutorial/run.py | 40 +++ .../src/authorization/tutorial/templates/edit.pt | 31 ++ .../src/authorization/tutorial/templates/login.pt | 32 ++ .../authorization/tutorial/templates/mytemplate.pt | 99 ++++++ .../tutorial/templates/mytemplate.pt.py | 110 ++++++ .../tutorial/templates/static/default.css | 380 +++++++++++++++++++++ .../tutorial/templates/static/images/img01.gif | Bin 0 -> 3840 bytes .../tutorial/templates/static/images/img02.gif | Bin 0 -> 4689 bytes .../tutorial/templates/static/images/img03.gif | Bin 0 -> 229 bytes .../tutorial/templates/static/images/img04.gif | Bin 0 -> 92 bytes .../tutorial/templates/static/images/spacer.gif | Bin 0 -> 43 bytes .../tutorial/templates/static/style.css | 109 ++++++ .../tutorial/templates/static/templatelicense.txt | 243 +++++++++++++ .../src/authorization/tutorial/templates/view.pt | 28 ++ .../bfgwiki2/src/authorization/tutorial/tests.py | 28 ++ .../src/authorization/tutorial/utilities.py | 10 + .../bfgwiki2/src/authorization/tutorial/views.py | 83 +++++ 30 files changed, 1936 insertions(+), 3 deletions(-) create mode 100644 docs/tutorials/bfgwiki2/src/authorization/CHANGES.txt create mode 100644 docs/tutorials/bfgwiki2/src/authorization/README.txt create mode 100644 docs/tutorials/bfgwiki2/src/authorization/ez_setup.py create mode 100644 docs/tutorials/bfgwiki2/src/authorization/setup.cfg create mode 100644 docs/tutorials/bfgwiki2/src/authorization/setup.py create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial.ini create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/__init__.py create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/configure.zcml create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/login.py create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/models.py create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/run.py create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/edit.pt create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/login.pt create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/mytemplate.pt create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/mytemplate.pt.py create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/static/default.css create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/static/images/img01.gif create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/static/images/img02.gif create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/static/images/img03.gif create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/static/images/img04.gif create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/static/images/spacer.gif create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/static/style.css create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/static/templatelicense.txt create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/view.pt create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/tests.py create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/utilities.py create mode 100644 docs/tutorials/bfgwiki2/src/authorization/tutorial/views.py (limited to 'docs/tutorials') diff --git a/docs/tutorials/bfgwiki/authorization.rst b/docs/tutorials/bfgwiki/authorization.rst index 437cb9c74..ea2366a72 100644 --- a/docs/tutorials/bfgwiki/authorization.rst +++ b/docs/tutorials/bfgwiki/authorization.rst @@ -71,7 +71,7 @@ into its template. We'll add something like this to each view body: .. code-block:: python :linenos: - logged_in = authenticated_user(request) + logged_in = authenticated_userid(request) We'll then change the return value of ``render_template_to_response`` to pass the `resulting `logged_in`` value to the template, e.g.: diff --git a/docs/tutorials/bfgwiki/src/authorization/tutorial/configure.zcml b/docs/tutorials/bfgwiki/src/authorization/tutorial/configure.zcml index df11c18b1..c8c0aa77e 100644 --- a/docs/tutorials/bfgwiki/src/authorization/tutorial/configure.zcml +++ b/docs/tutorials/bfgwiki/src/authorization/tutorial/configure.zcml @@ -5,7 +5,7 @@ - diff --git a/docs/tutorials/bfgwiki2/authorization.rst b/docs/tutorials/bfgwiki2/authorization.rst index 4a51acc93..c8ead9995 100644 --- a/docs/tutorials/bfgwiki2/authorization.rst +++ b/docs/tutorials/bfgwiki2/authorization.rst @@ -11,5 +11,237 @@ allowing anyone with access to the server to view pages. *authentication*. We'll make use of both features to provide security to our application. -XXX not finished +Adding A Context Factory +------------------------ + +We're going to start to use a custom *context factory* within our +``configure.zcml`` file in order to be able to attach security +declarations to our :term:`context` object. When we do this, we can +begin to make use of the declarative security features of +:mod:`repoze.bfg`. + +Let's modify our ``configure.zcml``, following the instructions in the +BFG documentation section named +:ref:`changing_routes_context_factory`. We'll point it at a function +in a new module we create named ``utilities.py``. + +Add the following section to your application's +``configure.zcml``file: + +.. code-block:: xml + :linenos: + + + +As a result, our ``configure.zcml`` file will now look like so: + +.. literalinclude:: src/authorization/tutorial/configure.zcml + :linenos: + :language: xml + +Once ``configure.zcml`` has been modified, create a file named +``utilities.py`` and give it the following contents: + +.. literalinclude:: src/authorization/tutorial/utilities.py + :linenos: + :language: python + +The result of our changing of the default routes context factory in +``configure.zcml`` and our addition of a new ``RoutesContextFactory`` +class to ``utilities.py`` allows us to use declarative security +features of :mod:`repoze.bfg`. The ``RoutesContextFactory`` class we +added will be used to construct each of the ``context`` objects passed +to our views. All of our ``context`` objects will possess an +``__acl__`` attribute that allows "Everyone" (a special principal) to +view all request, while allowing only a user named ``editor`` to edit +and add pages. The ``__acl__`` attribute attached to a context is +interpreted specially by :mod:`repoze.bfg` as an access control list +during view execution. See :ref:`assigning_acls` for more information +about what an :term:`ACL` represents. + +.. note: Although we don't use the functionality here, the ``factory`` + used to create route contexts may differ per-route instead of + globally via a ZCML directive. See the ``factory`` attribute in + :ref:`route_zcml_directive` for more info. + +Configuring a ``repoze.bfg`` Authentication Policy +-------------------------------------------------- + +For any :mod:`repoze.bfg` application to perform authorization, we +need to change our ``run.py`` module to add an :term:`authentication +policy`. Adding an authentication policy actually causes the system +to begin to use :term:`authorization`. + +Changing ``run.py`` +~~~~~~~~~~~~~~~~~~~ + +Change your ``run.py`` module to import the +``AuthTktAuthenticationPolicy`` from ``repoze.bfg.authentication``. +Within the body of the ``make_app`` function, construct an instance of +the policy, and pass it as the ``authentication_policy`` argument to +the ``make_app`` function. The first positional argument of an +``AuthTktAuthenticationPolicy`` is a secret used to encrypt cookie +data. Its second argument ("callback") should be a callable that +accepts a userid. If the userid exists in the system, the callback +should return a sequence of group identifiers (or an empty sequence if +the user isn't a member of any groups). If the userid *does not* +exist in the system, the callback should return ``None``. We'll use +"dummy" data to represent user and groups sources. When we're done, +your application's ``run.py`` will look like this. + +.. literalinclude:: src/authorization/tutorial/run.py + :linenos: + :language: python + +BFG's ``make_app`` callable also can accept an authorization policy +parameter. We don't need to specify one, we'll use the default. + +Adding Login and Logout Views +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We'll add a ``login`` view which renders a login form and processes +the post from the login form, checking credentials. + +We'll also add a ``logout`` view to our application and provide a link +to it. This view will clear the credentials of the logged in user and +redirect back to the front page. + +We'll add a different file (for presentation convenience) to add login +and logout views. Add a file named ``login.py`` to your application +(in the same directory as ``views.py``) with the following content: + +.. literalinclude:: src/authorization/tutorial/login.py + :linenos: + :language: python + +Changing Existing Views +~~~~~~~~~~~~~~~~~~~~~~~ + +Then we need to change each opf our ``view_page``, ``edit_page`` and +``add_page`` views in ``views.py`` to pass a "logged in" parameter +into its template. We'll add something like this to each view body: + +.. code-block:: python + :linenos: + + logged_in = authenticated_userid(request) + +We'll then change the return value of ``render_template_to_response`` +to pass the `resulting `logged_in`` value to the template, e.g.: + +.. code-block:: python + :linenos: + + return render_template_to_response('templates/view.pt', + request = request, + page = context, + content = content, + logged_in = logged_in, + edit_url = edit_url) + +Adding the ``login.pt`` Template +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Add a ``login.pt`` template to your templates directory. It's +referred to within the login view we just added to ``login.py``. + +.. literalinclude:: src/authorization/tutorial/templates/login.pt + :linenos: + :language: xml + +Change ``view.pt`` and ``edit.pt`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We'll also need to change our ``edit.pt`` and ``view.pt`` templates to +display a "Logout" link if someone is logged in. This link will +invoke the logout view. + +To do so we'll add this to both templates within the ``
`` div: + +.. code-block:: xml + :linenos: + + Logout + +Changing ``configure.zcml`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Change your application's ``configure.zcml`` to add a slightly +inscrutable ``utility`` stanza which "provides" ``IForbiddenView``. +This configures our login view to show up when BFG detects that a view +invocation can not be authorized. Also, add ``permission`` attributes +with the value ``edit`` to the ``edit_page`` and ``add_page`` routes. +This indicates that the views which these routes reference cannot be +invoked without the authenticated user possessing the ``edit`` +permission. When you're done, your ``configure.zcml`` will look like +so: + +.. literalinclude:: src/authorization/tutorial/configure.zcml + :linenos: + :language: xml + +Viewing the Application in a Browser +------------------------------------ + +Once we've set up the WSGI pipeline properly, we can finally examine +our application in a browser. The views we'll try are as follows: + +- Visiting `http://localhost:6543/ `_ in a + browser invokes the ``view_wiki`` view. This always redirects to + the ``view_page`` view of the FrontPage page object. It is + executable by any user. + +- Visiting `http://localhost:6543/FrontPage/ + `_ in a browser invokes the + ``view_page`` view of the front page page object. + +- Visiting `http://localhost:6543/FrontPage/edit_page + `_ in a browser invokes + the edit view for the front page object. It is executable by only + the ``editor`` user. If a different user (or the anonymous user) + invokes it, a login form will be displayed. Supplying the + credentials with the username ``editor``, password ``editor`` will + show the edit page form being displayed. + +- Visiting `http://localhost:6543/add_page/SomePageName + `_ in a browser invokes + the add view for a page. It is executable by only the ``editor`` + user. If a different user (or the anonymous user) invokes it, a + login form will be displayed. Supplying the credentials with the + username ``editor``, password ``editor`` will show the edit page + form being displayed. + +Seeing Our Changes To ``views.py`` and our Templates +---------------------------------------------------- + +Our ``views.py`` module will look something like this when we're done: + +.. literalinclude:: src/authorization/tutorial/views.py + :linenos: + :language: python + +Our ``edit.pt`` template will look something like this when we're done: + +.. literalinclude:: src/authorization/tutorial/templates/edit.pt + :linenos: + :language: xml + +Our ``view.pt`` template will look something like this when we're done: + +.. literalinclude:: src/authorization/tutorial/templates/view.pt + :linenos: + :language: xml + +Revisiting the Application +--------------------------- + +When we revisit the application in a browser, and log in (as a result +of hitting an edit or add page and submitting the login form with the +``editor`` credentials), we'll see a Logout link in the upper right +hand corner. When we click it, we're logged out, and redirected back +to the front page. + + diff --git a/docs/tutorials/bfgwiki2/src/authorization/CHANGES.txt b/docs/tutorials/bfgwiki2/src/authorization/CHANGES.txt new file mode 100644 index 000000000..1544cf53b --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/CHANGES.txt @@ -0,0 +1,3 @@ +0.1 + + Initial version diff --git a/docs/tutorials/bfgwiki2/src/authorization/README.txt b/docs/tutorials/bfgwiki2/src/authorization/README.txt new file mode 100644 index 000000000..d41f7f90f --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/README.txt @@ -0,0 +1,4 @@ +tutorial README + + + diff --git a/docs/tutorials/bfgwiki2/src/authorization/ez_setup.py b/docs/tutorials/bfgwiki2/src/authorization/ez_setup.py new file mode 100644 index 000000000..d24e845e5 --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/ez_setup.py @@ -0,0 +1,276 @@ +#!python +"""Bootstrap setuptools installation + +If you want to use setuptools in your package's setup.py, just include this +file in the same directory with it, and add this to the top of your setup.py:: + + from ez_setup import use_setuptools + use_setuptools() + +If you want to require a specific version of setuptools, set a download +mirror, or use an alternate download directory, you can do so by supplying +the appropriate options to ``use_setuptools()``. + +This file can also be run as a script to install or upgrade setuptools. +""" +import sys +DEFAULT_VERSION = "0.6c9" +DEFAULT_URL = "http://pypi.python.org/packages/%s/s/setuptools/" % sys.version[:3] + +md5_data = { + 'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca', + 'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb', + 'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b', + 'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a', + 'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618', + 'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac', + 'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5', + 'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4', + 'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c', + 'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b', + 'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27', + 'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277', + 'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa', + 'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e', + 'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e', + 'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f', + 'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2', + 'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc', + 'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167', + 'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64', + 'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d', + 'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20', + 'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab', + 'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53', + 'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2', + 'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e', + 'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372', + 'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902', + 'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de', + 'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b', + 'setuptools-0.6c9-py2.3.egg': 'a83c4020414807b496e4cfbe08507c03', + 'setuptools-0.6c9-py2.4.egg': '260a2be2e5388d66bdaee06abec6342a', + 'setuptools-0.6c9-py2.5.egg': 'fe67c3e5a17b12c0e7c541b7ea43a8e6', + 'setuptools-0.6c9-py2.6.egg': 'ca37b1ff16fa2ede6e19383e7b59245a', +} + +import sys, os +try: from hashlib import md5 +except ImportError: from md5 import md5 + +def _validate_md5(egg_name, data): + if egg_name in md5_data: + digest = md5(data).hexdigest() + if digest != md5_data[egg_name]: + print >>sys.stderr, ( + "md5 validation of %s failed! (Possible download problem?)" + % egg_name + ) + sys.exit(2) + return data + +def use_setuptools( + version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir, + download_delay=15 +): + """Automatically find/download setuptools and make it available on sys.path + + `version` should be a valid setuptools version number that is available + as an egg for download under the `download_base` URL (which should end with + a '/'). `to_dir` is the directory where setuptools will be downloaded, if + it is not already available. If `download_delay` is specified, it should + be the number of seconds that will be paused before initiating a download, + should one be required. If an older version of setuptools is installed, + this routine will print a message to ``sys.stderr`` and raise SystemExit in + an attempt to abort the calling script. + """ + was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules + def do_download(): + egg = download_setuptools(version, download_base, to_dir, download_delay) + sys.path.insert(0, egg) + import setuptools; setuptools.bootstrap_install_from = egg + try: + import pkg_resources + except ImportError: + return do_download() + try: + pkg_resources.require("setuptools>="+version); return + except pkg_resources.VersionConflict, e: + if was_imported: + print >>sys.stderr, ( + "The required version of setuptools (>=%s) is not available, and\n" + "can't be installed while this script is running. Please install\n" + " a more recent version first, using 'easy_install -U setuptools'." + "\n\n(Currently using %r)" + ) % (version, e.args[0]) + sys.exit(2) + else: + del pkg_resources, sys.modules['pkg_resources'] # reload ok + return do_download() + except pkg_resources.DistributionNotFound: + return do_download() + +def download_setuptools( + version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir, + delay = 15 +): + """Download setuptools from a specified location and return its filename + + `version` should be a valid setuptools version number that is available + as an egg for download under the `download_base` URL (which should end + with a '/'). `to_dir` is the directory where the egg will be downloaded. + `delay` is the number of seconds to pause before an actual download attempt. + """ + import urllib2, shutil + egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3]) + url = download_base + egg_name + saveto = os.path.join(to_dir, egg_name) + src = dst = None + if not os.path.exists(saveto): # Avoid repeated downloads + try: + from distutils import log + if delay: + log.warn(""" +--------------------------------------------------------------------------- +This script requires setuptools version %s to run (even to display +help). I will attempt to download it for you (from +%s), but +you may need to enable firewall access for this script first. +I will start the download in %d seconds. + +(Note: if this machine does not have network access, please obtain the file + + %s + +and place it in this directory before rerunning this script.) +---------------------------------------------------------------------------""", + version, download_base, delay, url + ); from time import sleep; sleep(delay) + log.warn("Downloading %s", url) + src = urllib2.urlopen(url) + # Read/write all in one block, so we don't create a corrupt file + # if the download is interrupted. + data = _validate_md5(egg_name, src.read()) + dst = open(saveto,"wb"); dst.write(data) + finally: + if src: src.close() + if dst: dst.close() + return os.path.realpath(saveto) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +def main(argv, version=DEFAULT_VERSION): + """Install or upgrade setuptools and EasyInstall""" + try: + import setuptools + except ImportError: + egg = None + try: + egg = download_setuptools(version, delay=0) + sys.path.insert(0,egg) + from setuptools.command.easy_install import main + return main(list(argv)+[egg]) # we're done here + finally: + if egg and os.path.exists(egg): + os.unlink(egg) + else: + if setuptools.__version__ == '0.0.1': + print >>sys.stderr, ( + "You have an obsolete version of setuptools installed. Please\n" + "remove it from your system entirely before rerunning this script." + ) + sys.exit(2) + + req = "setuptools>="+version + import pkg_resources + try: + pkg_resources.require(req) + except pkg_resources.VersionConflict: + try: + from setuptools.command.easy_install import main + except ImportError: + from easy_install import main + main(list(argv)+[download_setuptools(delay=0)]) + sys.exit(0) # try to force an exit + else: + if argv: + from setuptools.command.easy_install import main + main(argv) + else: + print "Setuptools version",version,"or greater has been installed." + print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)' + +def update_md5(filenames): + """Update our built-in md5 registry""" + + import re + + for name in filenames: + base = os.path.basename(name) + f = open(name,'rb') + md5_data[base] = md5(f.read()).hexdigest() + f.close() + + data = [" %r: %r,\n" % it for it in md5_data.items()] + data.sort() + repl = "".join(data) + + import inspect + srcfile = inspect.getsourcefile(sys.modules[__name__]) + f = open(srcfile, 'rb'); src = f.read(); f.close() + + match = re.search("\nmd5_data = {\n([^}]+)}", src) + if not match: + print >>sys.stderr, "Internal error!" + sys.exit(2) + + src = src[:match.start(1)] + repl + src[match.end(1):] + f = open(srcfile,'w') + f.write(src) + f.close() + + +if __name__=='__main__': + if len(sys.argv)>2 and sys.argv[1]=='--md5update': + update_md5(sys.argv[2:]) + else: + main(sys.argv[1:]) + + + + + + diff --git a/docs/tutorials/bfgwiki2/src/authorization/setup.cfg b/docs/tutorials/bfgwiki2/src/authorization/setup.cfg new file mode 100644 index 000000000..807ea6b0e --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/setup.cfg @@ -0,0 +1,6 @@ +[nosetests] +match=^test +nocapture=1 +cover-package=tutorial +with-coverage=1 +cover-erase=1 diff --git a/docs/tutorials/bfgwiki2/src/authorization/setup.py b/docs/tutorials/bfgwiki2/src/authorization/setup.py new file mode 100644 index 000000000..86be6c960 --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/setup.py @@ -0,0 +1,52 @@ +import os +import sys + +from ez_setup import use_setuptools +use_setuptools() + +from setuptools import setup, find_packages + +here = os.path.abspath(os.path.dirname(__file__)) +README = open(os.path.join(here, 'README.txt')).read() +CHANGES = open(os.path.join(here, 'CHANGES.txt')).read() + +requires = [ + 'repoze.bfg', + 'SQLAlchemy', + 'transaction', + 'repoze.tm2', + 'zope.sqlalchemy', + 'docutils' + ] + +if sys.version_info[:3] < (2,5,0): + requires.append('pysqlite') + +setup(name='tutorial', + version='0.1', + description='tutorial', + long_description=README + '\n\n' + CHANGES, + classifiers=[ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Programming Language :: Python", + "Topic :: Internet :: WWW/HTTP", + "Topic :: Internet :: WWW/HTTP :: Dynamic Content", + "Topic :: Internet :: WWW/HTTP :: WSGI", + "Topic :: Internet :: WWW/HTTP :: WSGI :: Application", + ], + author='', + author_email='', + url='', + keywords='web wsgi bfg zope', + packages=find_packages(), + include_package_data=True, + zip_safe=False, + test_suite='tutorial', + install_requires = requires, + entry_points = """\ + [paste.app_factory] + app = tutorial.run:app + """ + ) + diff --git a/docs/tutorials/bfgwiki2/src/authorization/tutorial.ini b/docs/tutorials/bfgwiki2/src/authorization/tutorial.ini new file mode 100644 index 000000000..d89616316 --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/tutorial.ini @@ -0,0 +1,20 @@ +[DEFAULT] +debug = true + +[app:sql] +use = egg:tutorial#app +reload_templates = true +debug_authorization = false +debug_notfound = false +db_string = sqlite:///%(here)s/tutorial.db + +[pipeline:main] +pipeline = + egg:Paste#evalerror + egg:repoze.tm2#tm + sql + +[server:main] +use = egg:Paste#http +host = 0.0.0.0 +port = 6543 diff --git a/docs/tutorials/bfgwiki2/src/authorization/tutorial/__init__.py b/docs/tutorials/bfgwiki2/src/authorization/tutorial/__init__.py new file mode 100644 index 000000000..cbdfd3ac6 --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/tutorial/__init__.py @@ -0,0 +1,2 @@ +# A package + diff --git a/docs/tutorials/bfgwiki2/src/authorization/tutorial/configure.zcml b/docs/tutorials/bfgwiki2/src/authorization/tutorial/configure.zcml new file mode 100644 index 000000000..8fd6140ab --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/tutorial/configure.zcml @@ -0,0 +1,58 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/tutorials/bfgwiki2/src/authorization/tutorial/login.py b/docs/tutorials/bfgwiki2/src/authorization/tutorial/login.py new file mode 100644 index 000000000..28c3e05b4 --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/tutorial/login.py @@ -0,0 +1,44 @@ +from webob.exc import HTTPFound + +from routes import url_for + +from repoze.bfg.chameleon_zpt import render_template_to_response + +from repoze.bfg.security import remember +from repoze.bfg.security import forget + +from tutorial.run import USERS + +def login(context, request): + login_url = url_for('login') + referrer = request.environ.get('HTTP_REFERER', '/') + if referrer == login_url: + referrer = '/' # never use the login form itself as came_from + came_from = request.params.get('came_from', referrer) + message = '' + login = '' + password = '' + if 'form.submitted' in request.params: + login = request.params['login'] + password = request.params['password'] + if USERS.get(login) == password: + headers = remember(request, login) + return HTTPFound(location = came_from, + headers = headers) + message = 'Failed login' + + return render_template_to_response( + 'templates/login.pt', + message = message, + url = request.application_url + '/login', + came_from = came_from, + login = login, + password = password, + request =request, + ) + +def logout(context, request): + headers = forget(request) + return HTTPFound(location = url_for('view_wiki'), + headers = headers) + diff --git a/docs/tutorials/bfgwiki2/src/authorization/tutorial/models.py b/docs/tutorials/bfgwiki2/src/authorization/tutorial/models.py new file mode 100644 index 000000000..3e63c3734 --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/tutorial/models.py @@ -0,0 +1,43 @@ +import transaction + +from sqlalchemy import create_engine +from sqlalchemy import Column +from sqlalchemy import Integer +from sqlalchemy import Text + +from sqlalchemy.exc import IntegrityError + +from sqlalchemy.orm import scoped_session +from sqlalchemy.orm import sessionmaker + +from sqlalchemy.ext.declarative import declarative_base + +from zope.sqlalchemy import ZopeTransactionExtension + +DBSession = scoped_session(sessionmaker(extension=ZopeTransactionExtension())) +Base = declarative_base() + +class Page(Base): + """ The SQLAlchemy declarative model class for a Page object. """ + __tablename__ = 'pages' + id = Column(Integer, primary_key=True) + name = Column(Text, unique=True) + data = Column(Text) + + def __init__(self, name, data): + self.name = name + self.data = data + +def initialize_sql(db, echo=False): + engine = create_engine(db, echo=echo) + DBSession.configure(bind=engine) + Base.metadata.bind = engine + Base.metadata.create_all(engine) + try: + session = DBSession() + page = Page('FrontPage', 'initial data') + session.add(page) + transaction.commit() + except IntegrityError: + # already created + pass diff --git a/docs/tutorials/bfgwiki2/src/authorization/tutorial/run.py b/docs/tutorials/bfgwiki2/src/authorization/tutorial/run.py new file mode 100644 index 000000000..0f2068bba --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/tutorial/run.py @@ -0,0 +1,40 @@ +from repoze.bfg.router import make_app +from repoze.bfg.authentication import AuthTktAuthenticationPolicy + +import tutorial +from tutorial.models import DBSession +from tutorial.models import initialize_sql + +class Cleanup: + def __init__(self, cleaner): + self.cleaner = cleaner + def __del__(self): + self.cleaner() + +def handle_teardown(event): + environ = event.request.environ + environ['tutorial.sasession'] = Cleanup(DBSession.remove) + +def app(global_config, **kw): + """ This function returns a repoze.bfg.router.Router object. + + It is usually called by the PasteDeploy framework during ``paster serve``. + """ + db_string = kw.get('db_string') + if db_string is None: + raise ValueError("No 'db_string' value in application configuration.") + initialize_sql(db_string) + + authpolicy = AuthTktAuthenticationPolicy('seekr!t', callback=groupfinder) + + return make_app(None, tutorial, authentication_policy=authpolicy, + options=kw) + +USERS = {'editor':'editor', + 'viewer':'viewer'} +GROUPS = {'editor':['group.editors']} + +def groupfinder(userid): + if userid in USERS: + return GROUPS.get(userid, []) + diff --git a/docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/edit.pt b/docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/edit.pt new file mode 100644 index 000000000..5e56f1fd6 --- /dev/null +++ b/docs/tutorials/bfgwiki2/src/authorization/tutorial/templates/edit.pt @@ -0,0 +1,31 @@ + + + + + + bfg tutorial wiki (based on TurboGears 20-Minute Wiki) Editing: ${page.name} + + + + + +
+
Viewing + Page Name Goes Here
+ You can return to the FrontPage. + Logout +
+ +
+
+