-
Notifications
You must be signed in to change notification settings - Fork 0
/
web_ui.py
835 lines (701 loc) · 32 KB
/
web_ui.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
# -*- coding: utf-8 -*-
#
# Copyright (C) 2006 Alec Thomas <alec@swapoff.org>
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution.
#
import re
import random
from string import Template
from trac.core import *
from trac.config import IntOption, Option
from trac.perm import IPermissionRequestor, PermissionCache, PermissionSystem
from trac.resource import Resource, ResourceNotFound, render_resource_link
from trac.wiki.formatter import wiki_to_oneliner, wiki_to_html
from trac.wiki.model import WikiPage
from trac.wiki.macros import WikiMacroBase
from trac.ticket.model import Component as TicketComponent
from trac.util.compat import sorted
from trac.web.api import IRequestHandler, ITemplateStreamFilter, \
IRequestFilter, RequestDone
from trac.web.chrome import Chrome, ITemplateProvider, INavigationContributor, \
add_stylesheet, add_script, add_ctxtnav, \
add_warning, add_notice
from acct_mgr.htfile import HtPasswdStore
from acct_mgr.api import IPasswordStore, IAccountChangeListener
from tractags.api import TagSystem
from tractags.macros import render_cloud
from tractags.query import Query
from tracvote import VoteSystem
from svnauthz.io import AuthzFileReader, AuthzFileWriter
from genshi.builder import tag as builder
from genshi.filters.transform import Transformer
from trachacks.validate import *
def pluralise(n, word):
"""Return a (naively) pluralised phrase from a count and a singular
word."""
if n == 0:
return 'No %ss' % word
elif n == 1:
return '%i %s' % (n, word)
else:
return '%i %ss' % (n, word)
def natural_sort(l):
"""Sort the given list in the way that humans expect."""
convert = lambda text: int(text) if text.isdigit() else text
alphanum_key = lambda key: [convert(c) for c in re.split('([0-9]+)', key)]
return sorted(l, key=alphanum_key)
def get_page_name(hack_name, hack_type):
"""Compute wiki page name from hack name and type"""
page_name = hack_name
if not page_name.lower().endswith(hack_type):
page_name += hack_type.title()
return page_name
class FakeRequest(object):
def __init__(self, env, authname = 'anonymous'):
self.perm = PermissionCache(env, authname)
class HackDoesntExist(Aspect):
"""Validate that the hack does not exist."""
def __init__(self, env):
self.env = env
def __call__(self, context, hack_name):
hack_type = context.data.get('type', 'plugin')
page_name = get_page_name(hack_name, hack_type)
if WikiPage(self.env, page_name).exists:
raise ValidationError('Page already exists.')
repos = self.env.get_repository()
path = '/%s' % page_name.lower()
if repos.has_node(path):
raise ValidationError(
'Resulting path "%s" already exists in repository.' % path
)
try:
TicketComponent(self.env, page_name)
except ResourceNotFound, e:
pass
else:
raise ValidationError(
'Resulting component "%s" already exists.' % page_name
)
authz_file = self.env.config.get('trac', 'authz_file')
authz = AuthzFileReader().read(authz_file)
authz_paths = [ p.get_path() for p in authz.get_paths() ]
for ap in authz_paths:
if ap.startswith(path):
raise ValidationError(
'Resulting path "%s" already exists in authz file.' % path
)
return hack_name
class ReleasesExist(Aspect):
"""Validate that any of the selected releases exist."""
def __init__(self, env):
self.env = env
def __call__(self, context, selected):
if selected:
tags = TagSystem(self.env)
req = FakeRequest(self.env)
releases = [r.id for r, _ in tags.query(req, 'realm:wiki release')]
if isinstance(selected, (basestring, unicode)):
selected = [ selected ]
for s in selected:
if s not in releases:
hack = context.data.get('name', '') + \
context.data.get('type', '').title()
self.env.log.error(
"Invalid release %s selected for new hack %s" % (s, hack)
)
raise ValidationError('Selected release "%s" invalid?!' % str(s))
return selected
class ValidTypeSelected(Aspect):
"""Validate that a valid type is selected."""
def __init__(self, env):
self.env = env
def __call__(self, context, type_):
if not (type_ and isinstance(type_, basestring) and len(type_)):
raise ValidationError('No type selected?!')
tags = TagSystem(self.env)
req = FakeRequest(self.env)
types = [r.id for r, _ in tags.query(req, 'realm:wiki type')]
if type_ not in types:
raise ValidationError('Selected type "%s" invalid?!' % str(type_))
return type_
class TracHacksHandler(Component):
"""Trac-Hacks request handler."""
implements(INavigationContributor, IRequestHandler, IRequestFilter,
ITemplateProvider, IPermissionRequestor, ITemplateStreamFilter)
limit = IntOption('trachacks', 'limit', 25,
'Default maximum number of hacks to display.')
template = Option('trachacks', 'template', 'NewHackTemplate',
'Name of wiki page that serves as template for new hacks.')
svnbase = Option('trachacks', 'subversion_base_url',
'http://trac-hacks.org/svn',
'Base URL of the Subversion repository.')
lockfile = Option('trachacks', 'lock_file', '/var/tmp/newhack.lock',
'Path and name of lockfile to secure new hack creation')
path_match = re.compile(r'/(?:hacks/?(cloud|list)?|newhack)')
title_extract = re.compile(r'=\s+([^=]*)=', re.MULTILINE | re.UNICODE)
def __init__(self):
# Validate form
form = Form('content')
form.add('name', Chain(
Pattern(r'[A-Z][A-Za-z0-9]+(?:[A-Z][A-Za-z0-9]+)*'),
HackDoesntExist(self.env),
),
'Name must be in CamelCase.')
form.add('title', MinLength(8),
'Please write a few words for the description.')
form.add('description', MinLength(16),
'Please write at least a sentence or two for the description.')
form.add('release', Chain(MinLength(1), ReleasesExist(self.env)),
'At least one release must be checked.',
path='//dd[@id="release"]', where='append')
form.add('type', ValidTypeSelected(self.env),
'No type selected?!',
path='//dd[@id="type"]', where='append')
self.form = form
# ITemplateStreamFilter methods
def filter_stream(self, req, method, filename, stream, data):
context = data.get('form_context')
if context and context.errors and req.path_info == '/newhack':
stream |= context.inject_errors()
return stream
# IRequestHandler methods
def match_request(self, req):
#return self.path_match.match(req.path_info)
return req.path_info == '/newhack'
def process_request(self, req):
data = {}
tag_system = TagSystem(self.env)
#match = self.path_match.match(req.path_info)
#view = 'cloud'
#if match.group(1):
# view = match.group(1)
# Hack types and their description
types = []
for category in sorted([r.id for r, _ in
tag_system.query(req, 'realm:wiki type')]):
page = WikiPage(self.env, category)
match = self.title_extract.search(page.text)
if match:
title = '%s' % match.group(1).strip()
else:
title = '%s' % category
types.append((category, title))
# Trac releases
releases = natural_sort([r.id for r, _ in
tag_system.query(req, 'realm:wiki release')])
data['types'] = types
data['releases'] = releases
selected_releases = req.args.get('release', set(['0.10', '0.11', 'anyrelease']))
data['selected_releases'] = selected_releases
hacks = self.fetch_hacks(req, data, [ t[0] for t in types ], selected_releases)
add_stylesheet(req, 'tags/css/tractags.css')
add_stylesheet(req, 'hacks/css/trachacks.css')
add_script(req, 'hacks/js/trachacks.js')
if req.path_info == '/newhack':
return self.render_new(req, data, hacks)
#else:
# views = ['cloud', 'list']
# for v in views:
# if v != view:
# args = req.args
# add_ctxtnav(req, builder.a(v.title(),
# href=req.href.hacks(v, **args)))
# else:
# add_ctxtnav(req, v.title())
# if view == 'list':
# return self.render_list(req, data, hacks)
# else:
# return self.render_cloud(req, data, hacks)
# IRequestHandler methods
def pre_process_request(self, req, handler):
from trac.wiki.web_ui import WikiModule
if isinstance(handler, WikiModule):
path = req.path_info
args = req.args
if not (req.method == 'GET'):
self.env.log.debug('Hacks: no notice: no GET request')
elif not (path.startswith('/wiki/') or path == '/wiki'):
self.env.log.debug('Hacks: no notice: not a wiki path')
elif not args.has_key('hack'):
self.env.log.debug('Hacks: no notice: hack= missing')
elif args['hack'] != 'created':
self.env.log.debug('Hacks: no notice: hack=%s' % args['hack'])
else:
self.env.log.debug('Hacks: notice added')
add_notice(req, 'Your hack has been created successfully.')
return handler
def post_process_request(self, req, template, data, content_type):
return (template, data, content_type)
# INavigationContributor methods
def get_active_navigation_item(self, req):
#if req.path_info == '/newhack':
return 'newhack'
#else:
# return 'hacks'
def get_navigation_items(self, req):
#yield ('mainnav', 'hacks',
# builder.a('View Hacks', href=req.href.hacks(), accesskey='H'))
if 'HACK_CREATE' in req.perm:
yield ('mainnav', 'newhack',
builder.a('New Hack', href=req.href.newhack()))
# ITemplateProvider methods
def get_templates_dirs(self):
"""
Return the absolute path of the directory containing the provided
ClearSilver templates.
"""
from pkg_resources import resource_filename
return [resource_filename(__name__, 'templates')]
def get_htdocs_dirs(self):
"""Return the absolute path of a directory containing additional
static resources (such as images, style sheets, etc).
"""
from pkg_resources import resource_filename
htdocs = resource_filename(__name__, 'htdocs')
return [('hacks', htdocs), ('newhack', htdocs)]
# IPermissionRequestor methods
def get_permission_actions(self):
return ['HACK_CREATE']
# Internal methods
def render_new(self, req, data, hacks):
req.perm.require('HACK_CREATE')
tag_system = TagSystem(self.env)
hacks = list(hacks)
hack_names = set(r[2].id for r in hacks)
users = set(u.id for u, _ in tag_system.query(req, 'realm:wiki user'))
exclude = hack_names.union(users).union(data['types']).union(data['releases'])
cloud = {}
for votes, rank, resource, tags, title in hacks:
for tag in tags:
if tag in exclude:
continue
try:
cloud[tag] += 1
except KeyError:
cloud[tag] = 1
# Pick the top 25 tags + a random sample of 10 from the rest.
cloud = sorted(cloud.items(), key=lambda i: -i[1])
remainder = cloud[25:]
cloud = dict(cloud[:25] +
random.sample(remainder, min(10, len(remainder))))
# Render the cloud
min_px = 8
max_px = 20
def cloud_renderer(tag, count, percent):
self.env.log.debug(percent)
return builder.a(tag, href='#', style='font-size: %ipx' %
int(min_px + percent * (max_px - min_px)))
data['cloud'] = render_cloud(self.env, req, cloud, cloud_renderer)
add_script(req, 'common/js/wikitoolbar.js')
add_script(req, 'common/js/folding.js')
data['focus'] = 'name'
# Populate data with form submission
if req.method == 'POST' and 'create' in req.args or 'preview' in req.args:
data.update(req.args)
context = self.form.validate(data)
data['form_context'] = context
vars = {}
vars['OWNER'] = req.authname
vars['WIKINAME'] = get_page_name(data['name'], data['type'])
vars['TYPE'] = data.setdefault('type', 'plugin')
vars['TITLE'] = data.setdefault('title', 'No title available')
vars['LCNAME'] = vars['WIKINAME'].lower()
vars['SOURCEURL'] = '%s/%s' % (self.svnbase, vars['LCNAME'])
vars['DESCRIPTION'] = data.setdefault('description',
'No description available')
vars['EXAMPLE'] = data.setdefault('example',
'No example available')
if 'create' in req.args and not context.errors:
success, message = self.create_hack(req, data, vars)
if success:
target = '%s?%s' % \
(req.href.wiki(vars['WIKINAME']), 'hack=created')
req.redirect(target)
raise RequestDone
else:
add_warning(req, message)
elif 'preview' in req.args and not context.errors:
page = WikiPage(self.env, self.template)
if not page.exists:
raise TracError('New hack template %s does not exist.' % \
self.template)
template = Template(page.text).substitute(vars)
template = re.sub(r'\[\[ChangeLog[^\]]*\]\]',
'No changes yet', template)
data['page_preview'] = wiki_to_html(template, self.env, req)
else:
data['form_context'] = None
data['type'] = 'plugin'
data['release'] = ['0.11']
self.env.log.debug('MUPPETS AHOY')
return 'hacks_new.html', data, None
def create_hack(self, req, data, vars):
import fcntl
messages = []
created = False
have_lock = False
lockfile = open(self.lockfile, "w")
try:
rv = fcntl.flock(lockfile, fcntl.LOCK_EX | fcntl.LOCK_NB)
if rv:
raise TracError('Failed to acquire lock, error: %i' % rv)
have_lock = True
except IOError:
messages.append(
'A hack is currently being created by another user. '
'Please wait a few seconds, then click the "Create hack" '
'button again.'
)
if have_lock:
steps_done = []
try:
# Step 1: create repository paths
from os import popen
svn_path = 'file://%s' % \
self.env.config.get('trac', 'repository_dir')
svn_path = svn_path.rstrip('/')
page_name = vars['WIKINAME']
hack_path = vars['LCNAME']
paths = [ '%s/%s' % (svn_path, hack_path) ]
selected_releases = data['selected_releases']
if isinstance(selected_releases, (basestring, unicode)):
selected_releases = [ selected_releases, ]
for release in selected_releases:
if release == 'anyrelease': continue
paths.append("%s/%s/%s" % \
(svn_path, hack_path, release))
cmd = '/usr/bin/op create-hack %s ' % req.authname
cmd += '"New hack %s, created by %s" ' % \
(page_name, req.authname)
cmd += '%s 2>&1' % ' '.join(paths)
output = popen(cmd).readlines()
if output:
raise Exception(
"Failed to create Subversion paths:\n%s" % \
'\n'.join(output)
)
steps_done.append('repository')
# Step 2: Add permissions
from svnauthz.model import User, Path, PathAcl
authz_file = self.env.config.get('trac', 'authz_file')
authz = AuthzFileReader().read(authz_file)
svn_path_acl = PathAcl(User(req.authname), r=True, w=True)
authz.add_path(Path("/%s" % hack_path, acls = [svn_path_acl,]))
AuthzFileWriter().write(authz_file, authz)
steps_done.append('permissions')
# Step 3: Add component
component = TicketComponent(self.env)
component.name = page_name
component.owner = req.authname
component.insert()
steps_done.append('component')
# Step 4: Create wiki page
template_page = WikiPage(self.env, self.template)
page = WikiPage(self.env, page_name)
page.text = Template(template_page.text).substitute(vars)
page.save(req.authname, 'New hack %s, created by %s' % \
(page_name, req.authname), '0.0.0.0')
steps_done.append('wiki')
# Step 5: Tag the new wiki page
res = Resource('wiki', page_name)
tags = data['tags'].split() + selected_releases
TagSystem(self.env).set_tags(req, res, tags)
steps_done.append('tags')
rv = fcntl.flock(lockfile, fcntl.LOCK_UN)
created = True
except Exception, e:
try:
if 'tags' in steps_done:
res = Resource('wiki', page_name)
tags = data['tags'].split() + selected_releases
TagSystem(self.env).delete_tags(req, res, tags)
if 'wiki' in steps_done:
WikiPage(self.env, page_name).delete()
if 'component' in steps_done:
TicketComponent(self.env, page_name).delete()
if 'permissions' in steps_done:
authz_file = self.env.config.get('trac', 'authz_file')
authz = AuthzFileReader().read(authz_file)
authz.del_path(Path("/%s" % hack_path))
AuthzFileWriter().write(authz_file, authz)
# TODO: rollback subversion path creation
rv = fcntl.flock(lockfile, fcntl.LOCK_UN)
except:
self.env.log.error("Rollback failed")
rv = fcntl.flock(lockfile, fcntl.LOCK_UN)
self.env.log.error(e, exc_info=True)
raise TracError(str(e))
return (created, messages)
def render_list(self, req, data, hacks):
ul = builder.ul()
for votes, rank, resource, tags, title in sorted(hacks, key=lambda h: h[2].id):
li = builder.li(builder.a(resource.id,
href=req.href.wiki(resource.id)),
' - ', title)
ul(li)
data['body'] = ul
# TODO Top-n + sample
return 'hacks_view.html', data, None
def render_cloud(self, req, data, hacks):
by_name = dict([(r[2].id, r) for r in hacks])
def link_renderer(tag, count, percent):
votes, rank, resource, tags, title = by_name[tag]
href = req.href.wiki(resource.id)
font_size = 10.0 + (percent * 20.0)
colour = 128.0 - (percent * 128.0)
colour = '#%02x%02x%02x' % ((colour,) * 3)
a = builder.a(tag, rel='tag', title=title, href=href, class_='tag',
style='font-size: %ipx; color: %s' % (font_size, colour))
return a
# TODO Top-n + sample
cloud_hacks = dict([(hack[2].id, hack[0]) for hack in hacks])
data['body'] = render_cloud(self.env, req, cloud_hacks, link_renderer)
return 'hacks_view.html', data, None
def fetch_hacks(self, req, data, types, releases):
"""Return a list of hacks in the form
[votes, rank, resource, tags, title]
"""
tag_system = TagSystem(self.env)
vote_system = VoteSystem(self.env)
query = 'realm:wiki (%s) (%s)' % \
(' or '.join(releases), ' or '.join(types))
self.env.log.debug(query)
tagged = tag_system.query(req, query)
# Limit
try:
limit = int(req.args.get('limit', self.limit))
data['limit_message'] = 'top %s' % limit
except ValueError:
data['limit_message'] = 'all'
limit = 9999
data['limit'] = limit
# Query
q = req.args.get('q', '')
data['query'] = q
query = Query(q.lower())
# Build hacks list
hacks = []
for resource, tags in tagged:
page = WikiPage(self.env, resource.id)
if q:
text = page.name.lower() + page.text.lower() + ' '.join(tags)
if not query(text):
continue
_, count, _ = vote_system.get_vote_counts(resource)
match = self.title_extract.search(page.text)
count_string = pluralise(count, 'vote')
if match:
title = '%s (%s)' % (match.group(1).strip(), count_string)
else:
title = '%s' % count_string
hacks.append([count, None, resource, tags, title])
# Rank
total_hack_count = len(hacks)
hacks = sorted(hacks, key=lambda i: -i[0])
remainder = hacks[limit:]
hacks = hacks[:limit] + random.sample(remainder,
min(limit, len(remainder)))
# Navigation
#if len(hacks) >= limit:
# add_ctxtnav(req, builder.a('More', href='?action=more'))
# limit = len(hacks)
# data['limit'] = data['limit_message'] = limit
#else:
# add_ctxtnav(req, 'More')
#if q or limit != self.limit:
# add_ctxtnav(req, builder.a('Default', href='?action=default'))
#else:
# add_ctxtnav(req, 'Default')
#if total_hack_count > limit:
# add_ctxtnav(req, builder.a('All', href='?action=all'))
#else:
# add_ctxtnav(req, 'All')
#if limit > 10:
# limit = min(limit, len(hacks))
# add_ctxtnav(req, builder.a('Less', href='?action=less'))
#else:
# add_ctxtnav(req, 'Less')
#for i, hack in enumerate(hacks):
# hack[1] = i
return hacks
class TracHacksHtPasswdStore(HtPasswdStore):
"""Do some basic validation on new users and create a new user page."""
implements(IPasswordStore, IAccountChangeListener)
# IPasswordStore
def set_password(self, user, password):
perm = PermissionSystem(self.env)
all_perms = [ p[0] for p in perm.get_all_permissions() ]
if user in all_perms:
raise TracError('%s is a reserved name that can not be registered.' % user)
needles = [ ':', '[', ']' ]
for needle in needles:
if needle in user:
raise TracError('Character "%s" may not be used in user names.' % needle)
if len(user) < 3:
raise TracError('User name must be at least 3 characters long.')
if not re.match(r'^\w+$', user):
raise TracError('User name must consist only of alpha-numeric characters.')
if user.isupper():
raise TracError('User name must not consist of upper-case characters only.')
if WikiPage(self.env, user).exists:
raise TracError('wiki page "%s" already exists' % user)
return HtPasswdStore.set_password(self, user, password)
def delete_user(self, user):
HtPasswdStore.delete_user(self, user)
# IAccountChangeListener
def user_created(self, user, password):
req = FakeRequest(self.env, user)
resource = Resource('wiki', user)
tag_system = TagSystem(self.env)
tag_system.add_tags(req, resource, ['user',])
page = WikiPage(self.env, user)
page.text = '''= %(user)s =\n\n[[ListTagged(%(user)s)]]\n''' % {'user' : user}
page.save(user, 'New user %s registered' % user, None)
self.env.log.debug("New user %s registered" % user)
def user_password_changed(self, user, password):
pass
def user_deleted(self, user):
pass
class ListHacksMacro(WikiMacroBase):
""" Provide a list of registered hacks.
If no arguments are specified, the list will be grouped by hack type
(category). The user may choose from a list of known Trac releases to filter
which hacks are displayed; the default is to list hacks that work with Trac
`0.11`.
Hack types and Trac releases may be specified as parameter to the macro to
limit which types and/or releases are specified. Please note:
* If one or more releases are specified, the "version picker" is not displayed.
* Specified releases are 'OR'-based, i.e. `0.11 0.12` will show hacks which are tagged for `0.11` OR `0.12`.
* If exactly one category is specified, the fieldset legend is not displayed.
See [wiki:type] for a list of hack types, [wiki:release] for a list of
supported Trac releases.
Other tags may be passed as well. They will be used as additional filter
for displayed hacks, but - other than types and releases - have no
side-effects otherwise.
For example, the following shows hacks of type `integration` and
`plugin` for Trac `0.12`:
{{{
[[ListHacks(integration plugin 0.12)]]
}}}
"""
title_extract = re.compile(r'=\s+([^=]*)=', re.MULTILINE | re.UNICODE)
self_extract = re.compile(r'\[\[ListHacks[^\]]*\]\]\s?\n?', re.MULTILINE | re.UNICODE)
def expand_macro(self, formatter, name, args):
req = formatter.req
tag_system = TagSystem(self.env)
all_releases = natural_sort([r.id for r, _ in
tag_system.query(req, 'realm:wiki release')])
all_categories = sorted([r.id for r, _ in
tag_system.query(req, 'realm:wiki type')])
hide_release_picker = False
hide_fieldset_legend = False
hide_fieldset_description = False
other = []
if args:
categories = []
releases = []
for arg in args.split():
if arg in all_releases:
hide_release_picker = True
releases.append(arg)
elif arg in all_categories:
categories.append(arg)
else:
other.append(arg)
if len(categories) or len(releases):
hide_fieldset_description = True
if not len(categories):
categories = all_categories
elif len(categories) == 1:
hide_fieldset_legend = True
if not len(releases):
releases = all_releases
else:
categories = all_categories
releases = all_releases
if 'update_th_filter' in req.args:
show_releases = req.args.get('release', ['0.11'])
if isinstance(show_releases, basestring):
show_releases = [show_releases]
req.session['th_release_filter'] = ','.join(show_releases)
else:
show_releases = req.session.get('th_release_filter', '0.11').split(',')
output = ""
if not hide_release_picker:
style = "text-align:right; padding-top:1em; margin-right:5em;"
form = builder.form('\n', style=style, method="get")
style = "font-size:xx-small;"
span = builder.span("Show hacks for releases:", style=style)
for version in releases:
inp = builder.input(version, type_="checkbox", name="release",
value=version)
if version in show_releases:
inp(checked="checked")
span(inp, '\n')
style = "font-size:xx-small; padding:0; border:solid 1px black;"
span(builder.input(name="update_th_filter", type_="submit",
style=style, value="Update"), '\n')
form('\n', span, '\n')
output = "%s%s\n" % (output, form)
def link(resource):
return render_resource_link(self.env, formatter.context,
resource, 'compact')
for category in categories:
page = WikiPage(self.env, category)
match = self.title_extract.search(page.text)
if match:
cat_title = '%s' % match.group(1).strip()
cat_body = self.title_extract.sub('', page.text, 1)
else:
cat_title = '%s' % category
cat_body = page.text
cat_body = self.self_extract.sub('', cat_body).strip()
style = "padding:1em; margin:0em 5em 2em 5em; border:1px solid #999;"
fieldset = builder.fieldset('\n', style=style)
if not hide_fieldset_legend:
legend = builder.legend(style="color: #999;")
legend(builder.a(cat_title, href=self.env.href.wiki(category)))
fieldset(legend, '\n')
if not hide_fieldset_description:
fieldset(builder.p(wiki_to_html(cat_body, self.env, req)))
ul = builder.ul('\n', class_="listtagged")
query = 'realm:wiki (%s) %s %s' % \
(' or '.join(show_releases), category, ' '.join(other))
lines = 0
for resource, tags in tag_system.query(req, query):
# filter out the page used to make important tags
# persistent
if resource.id == "tags/persistent":
continue
lines += 1
li = builder.li(link(resource), ': ')
page = WikiPage(self.env, resource)
match = self.title_extract.search(page.text)
description = "''no description available''"
if match:
if match.group(1):
description = match.group(1).strip()
li(wiki_to_oneliner(description, self.env, req=req))
if tags:
if hide_fieldset_legend == False and category in tags:
tags.remove(category)
self.log.debug("hide %s: no legend" % category)
for o in other:
if o in tags: tags.remove(o)
rendered_tags = [ link(resource('tag', tag))
for tag in natural_sort(tags) ]
span = builder.span(style="font-size:xx-small;")
span(' (tags: ', rendered_tags[0],
[(', ', tag) for tag in rendered_tags[1:]], ')')
li(span)
ul(li, '\n')
if lines:
fieldset(ul, '\n')
else:
message = "No results for %s." % \
(hide_release_picker and "this version" or "your selection")
fieldset(builder.p(builder.em(message)), '\n')
output = "%s%s\n" % (output, fieldset)
return output