b5992fcfc15dedf1b5296836d596579f6880c26e
[cookbook.git] / cookbook / server.py
1 # Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
2 #
3 # This file is part of Cookbook.
4 #
5 # Cookbook is free software: you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by the
7 # Free Software Foundation, either version 3 of the License, or (at your
8 # option) any later version.
9 #
10 # Cookbook is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with Cookbook.  If not, see <http://www.gnu.org/licenses/>.
17
18 """Serve cookbooks over HTTP.
19 """
20
21 from __future__ import with_statement
22
23 import os
24 import random
25 import re
26 import types
27 from xml.sax import saxutils
28
29 import cherrypy
30 from jinja2 import Environment, FileSystemLoader
31
32
33 class Server (object):
34     """Cookbook web interface."""
35
36     def __init__(self, cookbook, template_root):
37         self.cookbook = cookbook
38         self.cookbook.make_index()
39         self.env = Environment(loader=FileSystemLoader(template_root))
40         self.tag_regexp = re.compile('[a-zA-Z./ ].*')  # allowed characters
41
42     def cleanup(self):
43         #self.cookbook.save('new-recipe')
44         pass
45
46     @cherrypy.expose
47     def index(self, tag=None):
48         """Recipe index page.
49
50         Recipes can be filtered by tag.
51         """
52         if isinstance(tag, types.StringTypes):
53             tag = [tag]
54         template = self.env.get_template('recipes.html')
55         return template.render(cookbook=self.cookbook,
56                                recipes=list(self.cookbook.tagged(tag)),
57                                selected_tags=tag)
58
59     @cherrypy.expose
60     def recipe(self, name=None):
61         """Single recipe page.
62         """
63         if name == None:
64             recipe = random.choice(self.cookbook)
65         else:
66             recipe = self.cookbook.index[name]
67         template = self.env.get_template('recipe.html')
68         return template.render(cookbook=self.cookbook, recipe=recipe)
69
70     @cherrypy.expose
71     def add_tag(self, name, tag):
72         """Add a tag to a single recipe."""
73         recipe = self.cookbook.index[name]
74         if recipe.tags == None:
75             recipe.tags = []
76         tag = self._clean_tag(tag)
77         if tag != None and tag not in recipe.tags:
78             recipe.tags.append(tag)
79             with open(recipe.path, 'w') as f:
80                 recipe.save(f)
81         raise cherrypy.HTTPRedirect(
82             u'recipe?name=%s' % recipe.clean_name(ascii=True), status=302)
83
84     @cherrypy.expose
85     def remove_tag(self, name, tag):
86         """Remove a tag from a single recipe."""
87         recipe = self.cookbook.index[name]
88         if recipe.tags == None:
89             return
90         tag = self._clean_tag(tag)
91         if tag != None and tag in recipe.tags:
92             recipe.tags.remove(tag)
93             with open(recipe.path, 'w') as f:
94                 recipe.save(f)
95         raise cherrypy.HTTPRedirect(
96             u'recipe?name=%s' % recipe.clean_name(ascii=True), status=302)
97
98     def _clean_tag(self, tag):
99         """Sanitize tag."""
100         if not isinstance(tag, types.StringTypes):
101             if len(tag) == 2 and '' in tag:
102                 # User used either dropdown or textbox
103                 tag.remove('')
104                 tag = tag[0]
105             else:
106                 # User used both dropdown and textbox
107                 return None
108         m = self.tag_regexp.match(tag)
109         if m != None:
110             return m.group()
111         return None
112
113
114 def test():
115     import doctest
116     doctest.testmod()