-
Notifications
You must be signed in to change notification settings - Fork 0
/
folksonomy.py
596 lines (444 loc) · 19.1 KB
/
folksonomy.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
"""
folksonomy.py
Reference: https://en.wikipedia.org/wiki/Folksonomy Quick Guide to Installing
Folksonomy: https://www.timfanelli.com/item/folksonomy_update
Folksonomy infers relationships between your tags and entries by locating
entries with the same tags, providing navigation links through your site based
on how your entries are tagged.
Tagging your entries is simple, you just have to add a "tags" element to your
entry's metadata section. A typical entry will then looks like this:
My Entry Title
#tags apples,oranges,orangatangues
This is my post about apples oranges and orangatangues.
Your entry is then tagged with those three things, apples, oranges, and
orangatangues.
Folksonomy populates three template variables, $tags, $relatedtags and
$relatedstores, for use in your story template.
Adding $tags to your story template will create links to your tags. The links
are somewhat customizable, using the following config entries:
py['tag_url']
py['pretext']
py['posttext']
py['tagsep']
The default tag_url should be set to https://yoursite/tags/, but you can also
set it to something like https://technorati.com/tags/. Please make sure to have
the trailing slash.
The pretext and posttext will appear on your webpage surrounding your tags and
tagsep will note what to seperate the tags by.
So, for example, if I have
py['pretext'] = '<span class="tags">Tags: '
py['posttext'] = '</span>'
py['tagsep'] = ', '
Then it would appear like:
<span class="tags">Tags: biking, pennsylvania</span>
$relatedtags and $relatedstories will only be populated when there's a single
entry in the page contents (e.g., you're viewing a story through it's
permalink).
$relatedtags and $relatedstories contain links to search that tag or view that
story respectively.
Tags are considered to be related if there is a story that is shared between
those tags. Relationships are weighted based on how many stories are shared
between them. The related tags is a set of the top two related tags to each tag
in your story.
Related stories are the two most recent stories from each related tag.
Folksonomy also creates tag clouds, stored in $tagcloud and $populartagcloud,
which provide visual representations of your blog's subject matter, and
navigational links into the tags. $populartagcloud is a rebalanced subset of
$tagcloud, containing only those tags which are ranked at least a "medium" in
the full tagcloud.
To use related stories or tags, simply add $relatedstories or $relatedtags to
your flavour's story template. You can customize it's appearance by defining
#relatedstores { }
in your CSS.
To use the tagcloud, simply add either $tagcloud or $popular tagcloud to your
flavour in a location of your choice, and then define the following in your
CSS:
.smallestTag { font-size=10px; }
.smallTag { font-size=11px; }
.mediumTag { font-size=12px; }
.bigTag { font-size=13px; }
.biggestTag { font-size=14px; }
.hugeTag { font-size=15px; }
.hugestTag { font-size=16px; }
.mostHugeTag { font-size=17px; }
#tagcloud { }
Customized for your site, of course.
NOTE: As of 1.1.0, Folksonomy swallowed up my tag cloud plugin. Tag cloud will
be maintained independantly, however it is no longer necessary to install it if
you are using Folksonomy. Folksonomy and TagCloud will be kept in sync, and
interchangeable as far as TagCloud functionality is concerned.
Folksonomy 1.1.0 contains all the functionality of Tag Cloud 1.3.1
NOTE: As of 1.2.0, Folksonomy no longer depends on Joe Topjian's Tags plugin.
Folksonomy is now interchangable with Tags as far as basic tagging
functionality is concerned. If you install this version of Folksonomy, you may
safely remove Joe's Tags plugin. This was done because I was making frequent
changes to Joe's plugin to support Folksonomy, and I didn't want to have to
keep bombarding him with change requests for Folksonomy to work.
NOTE: Starting with 1.5.0 the plugin now supports caching. Like the stock tags
plugin it is able to save a pre-calculated folksonmy table to a cache file and
re-use it later on. To enable this two steps are needed.
* Add a **py['folksonmy_cache']** entry to your config specifying where
you want to save the cache
* Run **pyblosxom-cmd buildfolksonomy** to create the cache file.
* Either run this every time you create a new entry or have it run as a
cron-job.
If the file does not exist or is not a valid cache file the plugin falls back
to re-calculating the table as part of the cb_head callback.
Folksonomy 1.2.0 contains all the functionality of Tags version "200510242045
TCF"
Folksonomy 1.3.0 fixes has a complete rewrite of the algorithm to choose
related stories. Related stories are now ordered by how many
tags they share with the story being viewed.
Folksonomy 1.4 Introduces forced relationships for entries. This is extremely
useful is you're writing a series of a posts that share tags
with other not-as-strongly-related entries, of if you always
want a story to show certain relationships that do not change
over time. To force a relationship to another entry, add a
related tag to your story's metadata section with a
comma-separated list of entries, like so:
#related category/filename
So if I have a post that I want to be related to
"myotherpost.txt" in the "general" category, I would add:
#related general/myotherpost.txt
Folksonomy 1.4.1 This is just a bugfix release that fixes the
create_folksonomy_table function to actually produce a proper
folksonomy table no other functionality got added.
Folksonomy 1.5.0 Added caching functionality so the folksonomy table does not
have to be recalculated for every access
"""
__author__ = 'Timothy C. Fanelli <[email protected]>'
__version__ = '1.5.0'
__url__ = 'https://www.timfanelli.com'
# Variables
import os
import re
import sys
import cPickle
from Pyblosxom import entries
def cb_start(args):
"""
Initializes the entrymap and folksonomy tables.
"""
request = args['request']
config = request.getConfiguration()
data = request.getData()
if 'tag_url' not in config:
config['tag_url'] = "%s/%s/" % (config['base_url'], 'tags')
if 'tag_url_display' not in config:
config['tag_url_display'] = config['tag_url']
if os.path.exists(config.get("folksonomy_cache", "")):
try:
with open(config["folksonomy_cache"]) as fp:
folksonomy = cPickle.load(fp)
data.update(folksonomy)
except:
data.update(create_folksonomy(config))
else:
data.update(create_folksonomy(config))
def cb_story(args):
entry = args['entry']
request = args['request']
data = request.getData()
config = request.getConfiguration()
if 'tags' not in entry:
return
# If we're showing more than one story, then do not populate relatedtags
# and relatedstories.
renderer = args['renderer']
if (len(renderer.getContent()) == 1):
relatedtags = get_related_tags(entry, data, config)
if relatedtags:
entry['relatedtags'] = relatedtags
relatedstories = get_related_stories(
entry, request, data, config)
if relatedstories:
entry['relatedstories'] = relatedstories
# Set the story tags and rss categories
entry['rawtags'] = entry['tags']
storytags = "%s%s%s" % (config['pretext'],
config['tagsep'].join(
["<a href='%s%s' rel='tag'>%s</a>" %
(config['tag_url'], tag, tag) for tag in
entry['tags'].split(',')]), config['posttext'])
entry['rsscategories'] = "".join(
['<category>%s</category>' % tag for tag in entry['tags'].split(',')])
entry['tags'] = storytags
return args
def get_entry_title(entry):
entry.getData()
return entry['title']
def get_related_stories(entry, request, data, config):
"""
returns the set of stories that share tags with one or more tags in entry,
sorted by decreasing order of number of shared tags.
"""
ignoretags = config['ignore_tags']
related = {}
tags = entry['tags'].split(',')
for tag in tags:
if tag in ignoretags:
continue
tmp = _get_related_stories(tag, data)
if tmp:
for relationship in tmp:
# Filter entries that do not share a tag with the existing
# entry otherwise they will be wrongly ranked higher.
if relationship[0] not in tags:
continue
stories = relationship[1]
for story in stories:
if story in related:
related[story] = (related[story][0] + 1, story)
else:
related[story] = (1, story)
# Read force-related from meta.
myentries = []
if 'related' in entry:
forcerelated = entry['related'].split(',')
myentries = [os.path.join(
config['datadir'], location) for location in forcerelated]
if related:
related = related.values()
related.sort(reverse=True)
myentries.extend([r[1] for r in related])
myentries = myentries[: min(len(myentries), 6)]
if myentries:
relatedstories = ""
for entry_location in myentries:
tmpentry = entries.fileentry.FileEntry(
request, entry_location, data['root_datadir'])
tmpentry.getData()
if tmpentry._filename == entry['filename']:
continue
relatedstories = "%s\n%s<br/>" % (relatedstories,
"<a href='%s/%s/%s'>%s</a>" %
(config['base_url'],
tmpentry['absolute_path'], tmpentry['fn'],
get_entry_title(tmpentry)))
if relatedstories:
return "<div id='relatedstories'>%s<p>%s</p></div>" % (
config['relatedstories_header'], relatedstories)
def _get_related_stories(tag, data):
"""
Returns the set of tuples (tag,sharedstories) that share stories with the
specified tag sorted in decreasing order of number of shared stories.
"""
sortedtags = data['sortedtags']
folksonomy = data['folksonomy']
if (not tag in sortedtags):
return []
tagindex = sortedtags.index(tag)
relationship = []
for t in sortedtags:
entries = []
position = sortedtags.index(t)
if (tagindex <= position):
entries = folksonomy[position][tagindex]
elif (tagindex > position):
entries = folksonomy[tagindex][position]
if entries:
relationship.append((len(entries), entries, t))
relationship.sort(reverse=True)
return [(r[2], r[1]) for r in relationship]
def get_related_tags(entry, data, config):
"""
returns the set of tags that share at least 2 stories with one or more tags
in entry.
"""
ignoretags = config['ignore_tags']
related = []
tags = entry['tags'].split(',')
for tag in tags:
if tag in ignoretags:
continue
tmp = _get_related_tags(tag, data)
if (tmp):
related.extend(tmp)
related.sort(reverse=True)
related = [x[1] for x in related if x[0] > 1]
return related
def _get_related_tags(tag, data):
"""
Returns the set of tuples (sharedentries,tag) that share stories with the
specified tag, sorted in decreasing order of number of entries shared.
"""
sortedtags = data['sortedtags']
folksonomy = data['folksonomy']
if (not tag in sortedtags):
print >>sys.stderr, 'ERROR: ' + tag + ' not in sortedtags.'
return []
tagindex = sortedtags.index(tag)
relationship = []
for t in sortedtags:
entries = []
position = sortedtags.index(t)
if (tagindex <= position):
entries = folksonomy[position][tagindex]
elif (tagindex > position):
entries = folksonomy[tagindex][position]
if entries:
relationship.append((len(entries), t))
relationship.sort(reverse=True)
return relationship
"""
Given tags [ A, B, C, D, E ] with entries T(A), T(B), T(C), T(D), and T(E)
respectively, build table folksonomy:
| A B C D E
--+------------------------------------------
A | T(A) T(AB) T(AC) T(AD) T(AE)
|
B | - T(B) T(BC) T(BD) T(BE)
|
C | - - T(C) T(CD) T(CE)
|
D | - - - T(D) T(DE)
|
E | - - - - T(E)
Such that for any tag x and any tag y, folksonomy[x,y] = set of entries in x
and in y.
"""
def create_folksonomy_table(entrymap):
taglist = entrymap.keys()
taglist.sort()
# Create the initial table
folksonomytable = [[] for x in xrange(len(taglist))]
for y in range(0, len(taglist)):
for x in range(y, len(taglist)):
if x == y:
folksonomytable[x].append(entrymap[taglist[x]])
else:
xentries = set(entrymap[taglist[x]])
yentries = set(entrymap[taglist[y]])
xyentries = list(xentries.intersection(yentries))
folksonomytable[x].append(xyentries)
return folksonomytable
def create_popular_tagcloud(config, tagcount, mincount, maxcount):
distribution = (maxcount - mincount) / 6
popcount = {}
popmin = maxcount
for tag in tagcount.keys():
count = len(tagcount[tag])
if (count > (mincount + distribution)):
popcount[tag] = tagcount[tag]
popmin = min(popmin, count)
return create_tagcloud(config, popcount, popmin, maxcount)
def create_tagcloud(config, tagcount, mincount, maxcount):
if tagcount:
tagurl = config['tag_url']
if 'tag_url_display' in config:
tagurl = config['tag_url_display']
tagcloud = []
tagcloud.append("<div id='tagcloud'>")
distribution = (maxcount - mincount) / 6
for tag in tagcount.keys():
size = "mediumTag"
if tag != "untagged":
if (len(tagcount[tag]) == maxcount):
size = "mostHugeTag"
elif (len(tagcount[tag]) > (mincount + (distribution * 5))):
size = "hugestTag"
elif (len(tagcount[tag]) > (mincount + (distribution * 4))):
size = "hugeTag"
elif (len(tagcount[tag]) > (mincount + (distribution * 3))):
size = "biggestTag"
elif (len(tagcount[tag]) > (mincount + (distribution * 2))):
size = "bigTag"
elif (len(tagcount[tag]) > (mincount + distribution)):
size = "mediumTag"
elif (len(tagcount[tag]) > mincount):
size = "smallTag"
elif (len(tagcount[tag]) == mincount):
size = "smallestTag"
tagcloud.append("""<a href='%s' class='%s' title='There are %s
entries tagged %s'>%s</a>\n""" % ('%s%s' % (tagurl, tag),
size, str(len(tagcount[tag])), tag, tag))
tagcloud.append("</div>")
result = "".join(tagcloud)
return result
def cb_filelist(args):
request = args['request']
config = request.getConfiguration()
data = request.getData()
m = re.compile(r'^%s' % config['tag_url']).match(data['url'])
if m:
# tag = re.sub("%s" % config['tag_url'],'',data['url'])
(tag,) = re.findall(
"%s/(\w*)" % (config['tag_url'].rstrip('/'),), data['url'])
if tag in data['entrytagmap']:
return get_entries_for_tag(tag, args)
def get_entries_for_tag(tag, args):
request = args['request']
data = request.getData()
new_files = []
entrymap = data['entrytagmap']
for entry_location in entrymap[tag]:
tmpentry = entries.fileentry.FileEntry(
request, entry_location, data['root_datadir'])
new_files.append((tmpentry._mtime, tmpentry))
if new_files:
new_files.sort(reverse=True)
return [myentry[1] for myentry in new_files]
def build_folksonomy(command, argv):
"""Command for building the folksonomy tables."""
from config import py as config
cachefile = config.get("folksonomy_cache")
if not cachefile:
raise ValueError("config.py has no folksonomy cache file property.")
if 'tag_url' not in config:
config['tag_url'] = "%s/%s/" % (config['base_url'], 'tags')
folksonomy = create_folksonomy(config)
with open(cachefile, "w") as cache:
cPickle.dump(folksonomy, cache)
return 0
def cb_commandline(args):
args["buildfolksonomy"] = (
build_folksonomy, "builds the folksonomy tables")
return args
def create_folksonomy(config):
""" Initialize the folksonmy table
and some other basic information """
folksonomy = {}
entrymap = {}
maxcount = 0
ignoretags = []
if 'ignore_tags' in config:
ignoretags = config['ignore_tags']
ignoredirectories = config['ignore_directories']
tagfileswithext = ["txt"]
if 'taggable_files' in config:
tagfileswithext = config['taggable_files']
for root, dirs, files in os.walk(config['datadir']):
for file in files:
if not os.path.splitext(file)[1].strip('.') in tagfileswithext:
continue
entry_location = root + "/" + file
directory = os.path.dirname(entry_location)
if (os.path.split(directory)[1] in ignoredirectories):
continue
contents = open(entry_location, 'r').read()
m = re.compile('\n#tags\s*(.*)\n').search(contents)
if m:
tagstring = m.group(1)
tags = tagstring.split(',')
for tag in tags:
if (tag in ignoretags):
continue
if not tag in entrymap.keys():
entrymap[tag] = []
entrymap[tag].append(entry_location)
maxcount = max(maxcount, len(entrymap[tag]))
else:
if not "untagged" in entrymap.keys():
entrymap["untagged"] = []
entrymap["untagged"].append(entry_location)
mincount = min(map(len, entrymap.values()))
sortedtags = entrymap.keys()
sortedtags.sort()
folksonomy['entrytagmap'] = entrymap
folksonomy['sortedtags'] = sortedtags
folksonomy['folksonomy'] = create_folksonomy_table(entrymap)
folksonomy["tagcloud"] = create_tagcloud(
config, entrymap, mincount, maxcount)
folksonomy["populartagcloud"] = create_popular_tagcloud(
config, entrymap, mincount, maxcount)
return folksonomy