theme/debwiki.py

   1 # -*- coding: iso-8859-1 -*-
   2 """
   3     MoinMoin - modern theme
   4
   5     @copyright: 2003-2005 Nir Soffer, Thomas Waldmann
   6     @license: GNU GPL, see COPYING for details.
   7 """
   8
   9 from MoinMoin.theme import ThemeBase
  10 from MoinMoin import wikiutil
  11 from MoinMoin.Page import Page
  12
  13 class Theme(ThemeBase):
  14
  15     name = "debwiki"
  16
  17     _ = lambda x: x     # We don't have gettext at this moment, so we fake it
  18     icons = {
  19         # key         alt                        icon filename      w   h
  20         # FileAttach
  21         'attach':     ("%(attach_count)s",       "moin-attach.png",   16, 16),
  22         'info':       ("[INFO]",                 "moin-info.png",     16, 16),
  23         'attachimg':  (_("[ATTACH]"),            "attach.png",        32, 32),
  24         # RecentChanges
  25         'rss':        (_("[RSS]"),               "moin-rss.png",      16, 16),
  26         'deleted':    (_("[DELETED]"),           "moin-deleted.png",  16, 16),
  27         'updated':    (_("[UPDATED]"),           "moin-updated.png",  16, 16),
  28         'renamed':    (_("[RENAMED]"),           "moin-renamed.png",  16, 16),
  29         'conflict':   (_("[CONFLICT]"),          "moin-conflict.png", 16, 16),
  30         'new':        (_("[NEW]"),               "moin-new.png",      16, 16),
  31         'diffrc':     (_("[DIFF]"),              "moin-diff.png",     16, 16),
  32         # General
  33         'bottom':     (_("[BOTTOM]"),            "moin-bottom.png",   16, 16),
  34         'top':        (_("[TOP]"),               "moin-top.png",      16, 16),
  35         'www':        ("[WWW]",                  "moin-www.png",      16, 16),
  36         'mailto':     ("[MAILTO]",               "moin-email.png",    16, 16),
  37         'news':       ("[NEWS]",                 "moin-news.png",     16, 16),
  38         'telnet':     ("[TELNET]",               "moin-telnet.png",   16, 16),
  39         'ftp':        ("[FTP]",                  "moin-ftp.png",      16, 16),
  40         'file':       ("[FILE]",                 "moin-ftp.png",      16, 16),
  41         # search forms
  42         'searchbutton': ("[?]",                  "moin-search.png",   16, 16),
  43         'interwiki':  ("[%(wikitag)s]",          "moin-inter.png",    16, 16),
  44
  45         # smileys (this is CONTENT, but good looking smileys depend on looking
  46         # adapted to the theme background color and theme style in general)
  47         #vvv    ==      vvv  this must be the same for GUI editor converter
  48         'X-(':        ("X-(",                    'angry.png',         16, 16),
  49         ':D':         (":D",                     'biggrin.png',       16, 16),
  50         '<:(':        ("<:(",                    'frown.png',         16, 16),
  51         ':o':         (":o",                     'redface.png',       16, 16),
  52         ':(':         (":(",                     'sad.png',           16, 16),
  53         ':)':         (":)",                     'smile.png',         16, 16),
  54         'B)':         ("B)",                     'smile2.png',        16, 16),
  55         ':))':        (":))",                    'smile3.png',        16, 16),
  56         ';)':         (";)",                     'smile4.png',        16, 16),
  57         '/!\\':       ("/!\\",                   'alert.png',         16, 16),
  58         '<!>':        ("<!>",                    'attention.png',     16, 16),
  59         '(!)':        ("(!)",                    'idea.png',          16, 16),
  60         ':-?':        (":-?",                    'tongue.png',        16, 16),
  61         ':\\':        (":\\",                    'ohwell.png',        16, 16),
  62         '>:>':        (">:>",                    'devil.png',         16, 16),
  63         '|)':         ("|)",                     'tired.png',         16, 16),
  64         ':-(':        (":-(",                    'sad.png',           16, 16),
  65         ':-)':        (":-)",                    'smile.png',         16, 16),
  66         'B-)':        ("B-)",                    'smile2.png',        16, 16),
  67         ':-))':       (":-))",                   'smile3.png',        16, 16),
  68         ';-)':        (";-)",                    'smile4.png',        16, 16),
  69         '|-)':        ("|-)",                    'tired.png',         16, 16),
  70         '(./)':       ("(./)",                   'checkmark.png',     16, 16),
  71         '{OK}':       ("{OK}",                   'thumbs-up.png',     16, 16),
  72         '{X}':        ("{X}",                    'icon-error.png',    16, 16),
  73         '{i}':        ("{i}",                    'icon-info.png',     16, 16),
  74         '{1}':        ("{1}",                    'prio1.png',         15, 13),
  75         '{2}':        ("{2}",                    'prio2.png',         15, 13),
  76         '{3}':        ("{3}",                    'prio3.png',         15, 13),
  77         '{*}':        ("{*}",                    'star_on.png',       16, 16),
  78         '{o}':        ("{o}",                    'star_off.png',      16, 16),
  79     }
  80     del _
  81     def header(self, d, **kw):
  82         """ Assemble wiki header
  83
  84         @param d: parameter dictionary
  85         @rtype: unicode
  86         @return: page header html
  87         """
  88         html = [
  89             # Pre header custom html
  90             self.emit_custom_html(self.cfg.page_header1),
  91
  92             # Header
  93             u'<div id="header">',
  94                         u'<div id="wikisection">',
  95                         u'<p class="section"><a href="/" title="Debian Wiki Homepage">Wiki</a></p>',
  96             self.username(d),
  97                         u'</div>',
  98                         u'<div id="navbar">',
  99             self.navibar(d),
 100                         u'</div>',
 101             self.searchform(d),
 102             self.logo(),
 103             self.interwiki(d),
 104                         #u'<a href="/" title="wiki home">Wiki</a> / ',
 105                         u'<div id="breadcrumbs"><a href="/" title="Debian Wiki Homepage">Wiki</a><span class="sep">/</span>',self.trail(d),
 106                         u'</div>',
 107             #u'<hr id="pageline">',
 108             #u'<div id="pageline"><hr style="display:none;"></div>',
 109             self.msg(d),
 110             self.editbar(d),
 111             u'<h1 id="locationline">',
 112                 self.interwiki(d),
 113                         self.title_with_separators(d),
 114             u'</h1>',
 115             u'</div>',
 116
 117             # Post header custom html (not recommended)
 118             self.emit_custom_html(self.cfg.page_header2),
 119
 120             # Start of page
 121             self.startPage(),
 122         ]
 123         return u'\n'.join(html)
 124
 125     def editorheader(self, d, **kw):
 126         """ Assemble wiki header for editor
 127
 128         @param d: parameter dictionary
 129         @rtype: unicode
 130         @return: page header html
 131         """
 132         html = [
 133             # Pre header custom html
 134             self.emit_custom_html(self.cfg.page_header1),
 135
 136             # Header
 137             u'<div id="header">',
 138             u'<h1 id="locationline">',
 139             self.title_with_separators(d),
 140             u'</h1>',
 141             self.msg(d),
 142             u'</div>',
 143
 144             # Post header custom html (not recommended)
 145             self.emit_custom_html(self.cfg.page_header2),
 146
 147             # Start of page
 148             self.startPage(),
 149         ]
 150         return u'\n'.join(html)
 151
 152     def footer(self, d, **keywords):
 153         """ Assemble wiki footer
 154
 155         @param d: parameter dictionary
 156         @keyword ...:...
 157         @rtype: unicode
 158         @return: page footer html
 159         """
 160         page = d['page']
 161         html = [
 162             # End of page
 163             self.endPage(),
 164
 165             # Pre footer custom html (not recommended!)
 166             self.emit_custom_html(self.cfg.page_footer1),
 167
 168             # Footer
 169             u'<div id="footer">',
 170         #    self.editbar(d),
 171             self.pageinfo(page),
 172             self.credits(d),
 173             self.showversion(d, **keywords),
 174             u'</div>',
 175
 176             # Post footer custom html
 177             self.emit_custom_html(self.cfg.page_footer2),
 178             ]
 179         return u'\n'.join(html)
 180
 181     def username(self, d):
 182         """ Assemble the username / userprefs link
 183
 184         @param d: parameter dictionary
 185         @rtype: unicode
 186         @return: username html
 187         """
 188         request = self.request
 189         _ = request.getText
 190
 191         userlinks = []
 192         # Add username/homepage link for registered users. We don't care
 193         # if it exists, the user can create it.
 194         if request.user.valid and request.user.name:
 195             interwiki = wikiutil.getInterwikiHomePage(request)
 196             name = request.user.name
 197             aliasname = request.user.aliasname
 198             if not aliasname:
 199                 aliasname = name
 200             title = "%s @ %s" % (aliasname, interwiki[0])
 201             # link to (interwiki) user homepage
 202             homelink = (request.formatter.interwikilink(1, title=title, id="userhome", generated=True, *interwiki) +
 203                         request.formatter.text(name) +
 204                         request.formatter.interwikilink(0, title=title, id="userhome", *interwiki))
 205             userlinks.append(homelink)
 206             # link to userprefs action
 207             if 'userprefs' not in self.request.cfg.actions_excluded:
 208                 userlinks.append(d['page'].link_to(request, text=_('Settings'),
 209                                                querystr={'action': 'userprefs'}, id='userprefs', rel='nofollow'))
 210
 211         if request.user.valid:
 212             if request.user.auth_method in request.cfg.auth_can_logout:
 213                 userlinks.append(d['page'].link_to(request, text=_('Logout'),
 214                                                    querystr={'action': 'logout', 'logout': 'logout'}, id='logout', rel='nofollow'))
 215         else:
 216             query = {'action': 'login'}
 217             # special direct-login link if the auth methods want no input
 218             if request.cfg.auth_login_inputs == ['special_no_input']:
 219                 query['login'] = '1'
 220             if request.cfg.auth_have_login:
 221                 userlinks.append(d['page'].link_to(request, text=_("Login"),
 222                                                    querystr=query, id='login', rel='nofollow'))
 223
 224         userlinks_html = u'<span class="sep"> | </span>'.join(userlinks)
 225         html = u'<div id="username">%s</div>' % userlinks_html
 226         return html
 227
 228     def trail(self, d):
 229         """ Assemble page trail
 230
 231         @param d: parameter dictionary
 232         @rtype: unicode
 233         @return: trail html
 234         """
 235         request = self.request
 236         user = request.user
 237         html = ''
 238         if not user.valid or user.show_page_trail:
 239             trail = user.getTrail()
 240             if trail:
 241                 items = []
 242                 for pagename in trail:
 243                     try:
 244                         interwiki, page = wikiutil.split_interwiki(pagename)
 245                         if interwiki != request.cfg.interwikiname and interwiki != 'Self':
 246                             link = (self.request.formatter.interwikilink(True, interwiki, page) +
 247                                     self.shortenPagename(page) +
 248                                     self.request.formatter.interwikilink(False, interwiki, page))
 249                             items.append(link)
 250                             continue
 251                         else:
 252                             pagename = page
 253
 254                     except ValueError:
 255                         pass
 256                     page = Page(request, pagename)
 257                     title = page.split_title()
 258                     title = self.shortenPagename(title)
 259                     link = page.link_to(request, title)
 260                     items.append(link)
 261                 html = u'<div id="pagetrail">%s</div>'% u'<span class="sep">/</span>'.join(items)
 262         return html
 263
 264     def interwiki(self, d):
 265         """ Assemble the interwiki name display, linking to page_front_page
 266
 267         @param d: parameter dictionary
 268         @rtype: string
 269         @return: interwiki html
 270         """
 271         if self.request.cfg.show_interwiki:
 272             page = wikiutil.getFrontPage(self.request)
 273             text = self.request.cfg.interwikiname or 'Self'
 274             link = page.link_to(self.request, text=text, rel='nofollow')
 275             html = u'<span id="interwiki">%s<span class="sep">: </span></span>' % link
 276         else:
 277             html = u''
 278         return html
 279
 280 def execute(request):
 281     """
 282     Generate and return a theme object
 283
 284     @param request: the request object
 285     @rtype: MoinTheme
 286     @return: Theme object
 287     """
 288     return Theme(request)
 289