source: trunk/plugins/oforgeplugin/oforge/wikinewpage.py @ 719

# -*- coding: utf-8 -*-
#
# Copyright (C) 2007 Optaros, Inc.
# All rights reserved.
#
import re
from trac.core import Component, implements
from trac.config import ListOption
from trac.web.main import IRequestHandler, IRequestFilter
from trac.web.chrome import ITemplateProvider, add_ctxtnav
from trac.wiki import WikiSystem
from trac.wiki.web_ui import WikiModule
from trac.util.compat import set

class WikiNewPageModule(Component):
    """Overrides the new and missing page mechanism for the wiki.  
    Provides a sub-nav link for New Page.  Allows for "template" pages.
    """
    implements(ITemplateProvider, IRequestFilter, IRequestHandler)

    template_pages = ListOption('wiki', 'template_pages', '', 
            doc="Wiki page(s) that can be cloned.  Defaults to none.")

    template_prefix = ListOption('wiki', 'template_prefixes', 
            [WikiModule.PAGE_TEMPLATES_PREFIX], 
            doc="""Wiki page name prefixes of pages that can be cloned.
                   Defaults to %s."""%(WikiModule.PAGE_TEMPLATES_PREFIX))

    template_tags = ListOption('wiki', 'template_tags', '', 
            doc="""Tag(s) that are used to designate pages that can be cloned.
                 Defaults to none.""")

    # ITemplateProvider methods
    def get_templates_dirs(self):
        from pkg_resources import resource_filename
        return [resource_filename(__name__, 'templates')]
    def get_htdocs_dirs(self):
        return []

    # IRequestFilter methods
    def pre_process_request(self, req, handler):
        return handler

    def post_process_request(self, req, template, data, content_type):
        if ((len(req.path_info) <= 1 or req.path_info == '/'
               or req.path_info.startswith('/wiki')) 
               and req.perm.has_permission('WIKI_CREATE')):
               add_ctxtnav(req, 'New Page', req.href.newwikipage())
        # hijack wiki requests 
        if template in [ 'wiki_view.html' , 'wiki_edit.html', 
                         'tagswiki_view.html', 'tagswiki_edit.html']:
            if ''==data.get('action') and 0 == data['latest_version']:
                # show custom newpage for missing pages 
                req.redirect(req.href.newwikipage(req.args['page']))
            elif 'edit'==data.get('action') and None == data.get('latest_version'):
                # copy the clone page source for new pages with 'clone' parameter
                wiki_template_page = req.args.get('wikitemplate', '')
                if wiki_template_page:
                    from trac.wiki.model import WikiPage
                    templatePage = WikiPage(self.env, wiki_template_page)
                    data.get('page').text = templatePage.text
                    data['comment'] = 'based on template %s' % wiki_template_page                    
            
        return (template, data, content_type)

    # IRequestHandler methods
    def match_request(self, req):
        match = re.match(r'^/newwikipage(?:/(.*))?', req.path_info)
        if match:
            if match.group(1):
                req.args['page'] = match.group(1)
            return 1

    def process_request(self, req):
        req.perm.assert_permission('WIKI_CREATE')
        data = self._get_templates_data(req)
        
        return 'wiki_newpage.html', data, None

    def _get_templates_data(self, req):
        data = {'wikitemplate' : req.args.get('wikitemplate', ''), 
                'tags' : req.args.get('tags', ''), 
                'page_name' : req.args.get('page', ''), 
                }

        template_page_list = set(self.template_pages)
        if self.template_tags:
            # only invoke TagEngine if template_tags is set
            from tractags.api import TagEngine
            template_page_list |= TagEngine(self.env).get_tagged_names(
                                    self.template_tags, ['wiki'], 'union')['wiki']
        if self.template_prefix:
            for wiki_prefix in self.template_prefix:
                for wiki_page in WikiSystem(self.env).get_pages(wiki_prefix):
                    template_page_list.add(wiki_page)
        template_page_list.add(req.args.get('wikitemplate', ''))
        template_page_list.discard('')        
        data['template_page_list'] = sorted(template_page_list)
        return data