/
IcculusFinger_daemon.pl
executable file
·1775 lines (1463 loc) · 58.8 KB
/
IcculusFinger_daemon.pl
OlderNewer
1
#!/usr/bin/perl -w -T
2
3
#-----------------------------------------------------------------------------
#
4
# Copyright (C) 2002 Ryan C. Gordon (icculus@icculus.org)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Revision history:
# (1.0 series comments removed. Check the download archives if you need them.)
# 2.0.0 : Rewrite into an actual finger daemon. MILLIONS of changes.
26
27
# 2.0.1 : Fixed > and < conversion.
# MUCH better Lynx support (thanks, Chunky_Ks)
28
# Added an "embed" arg.
29
30
# changed \r and \n in protocol chatter to \015 and \012.
# Made syslogging optional.
31
# Added "root" as a fakeuser.
32
# 2.0.2 : Added "time" and "ipaddr" fakeusers.
33
# 2.0.3 : Added "linkdigest" arg, and made it the default for text output.
34
35
# 2.0.4 : Added "noarchive" tagblocks and optional "plan written on"
# date/time output.
36
# 2.0.5 : Can now run as a full daemon, without inetd. Bunch of secutity
37
38
# cleanups, and enables taint mode (-T). Input can now timeout, so
# connections can't be hogged indefinitely anymore.
39
# 2.0.6 : Some syslogging added, minor fix in input reading.
40
# Zombie processes are cleaned up reliably, even under heavy load.
41
# 2.1.0 : Added .planfile digest generation. Not hooked up to daemon yet,
42
43
# just works from the command line. (Thanks to Gary "Chunky Kibbles"
# Briggs for the suggestion and patches!)
44
# 2.1.1 : Disabled the email URLizer for now. Added an "uptime" fakeuser.
45
46
47
48
# 2.1.2 : Centering, based on 80 columns, in text output, digest is now
# sorted correctly. (Thanks, Gary!) Daemon now select()s on the
# listen socket so it can timeout and do the .planfile digest. Other
# cleanups and fixes in the daemon code.
49
50
51
52
# 2.1.3 : Make sure .plan digest doesn't skips users with identical update
# times.
# 2.1.4 : Moved plan digest hashing to separate function (hashplans()),
# added RSS digest (thanks, zakk!), and unified them in do_digests().
53
# Digests can have a maximum user output now.
54
55
# 2.1.5 : Fixes from Gary Briggs: Fixed a regexp, made line before ending
# text format better, fixed centering on Lynx.
56
# 2.1.6 : Fix from Gary Briggs: undef'd variable reference.
57
58
# 2.1.7 : Fix from Gary Briggs: do some text output for [i], [b], and [u]
# markup tags when not in HTML mode.
59
60
# 2.1.8 : Fix from Gary Briggs: IcculusFinger_planmove.pl now handles
# moves across filesystems.
61
62
# 2.1.9 : Security fixes in request parsing and syslog output by Chunky and
# Primer.
63
# 2.1.10: Changes by Gary Briggs: Added local file parsing for specific
64
65
# situations, made image text more useful. Added support for
# stylesheets, and [entry][/entry] tags
66
67
# 2.1.11: Changes by Gary Briggs: Fixed div tag placement in $embed
# and plaintext
68
# 2.1.12: Minor RDF fixes.
69
70
71
# 2.1.13: RDF output now works with Thunderbird.
# 2.1.14: Compliments of zakk, finger pages now list a "live bookmark" for
# RSS finger digest.
72
73
74
# 2.1.15: Plain text output fixes: listarchives now right, and removed
# extra newlines from footer.
# Added info on how to access this user's .plan archives.
75
# 2.1.16: [img] tags in plain text output use the link digest, too.
76
# 2.1.17: Added <pubDate> tags to RSS feed.
77
# 2.1.18: HTML img tag puts alt text in "title" attribute, too, for mouseovers.
78
# 2.1.19: Allow per-user RSS feeds.
79
# 2.1.20: RSS fixes.
80
# 2.1.21: Fixed "finger @hostname" uninitialized variable (thanks, Thomas!).
81
# 2.1.22: Fixed non-html listsections output.
82
# 2.1.23: URL detection tweak.
83
# 2.1.24: double-fork when daemonizing, to totally lose controlling terminal.
84
# 2.1.25: IPv6 support, use https:// URLs where appropriate.
85
86
# 2.1.26: Added Markdown support, removed <pre> tags and workarounds for it.
# A few other output fixes.
87
# 2.1.27: Added metadata support for Twitter Cards and summaries.
88
89
#-----------------------------------------------------------------------------
90
# !!! TODO: If an [img] isn't in a link tag, make it link to the image.
91
92
93
94
95
96
use strict; # don't touch this line, nootch.
use warnings; # don't touch this line, either.
use DBI; # or this. I guess. Maybe.
use File::Basename; # blow.
97
use IO::Select; # bleh.
98
use POSIX; # bloop.
99
100
use Text::Markdown 'markdown';
101
102
# Version of IcculusFinger. Change this if you are forking the code.
103
my $version = 'v2.1.27';
104
105
106
107
108
109
110
#-----------------------------------------------------------------------------#
# CONFIGURATION VARIABLES: Change to suit your needs... #
#-----------------------------------------------------------------------------#
# This is a the hostname you want to claim to be...
111
112
113
# This reports "Finger info for $user\@$host ..." in the web interface,
# and is used for listing finger requests to finger clients:
# "Finger $user?section=sectionname\@$host", etc.
114
115
my $host = 'icculus.org';
116
117
# This is the URL for fingering accounts, for when we need to generate
# URLs. "$url?user=$user§ion=sectionname".
118
119
120
121
my $base_url = 'https://icculus.org/finger';
# If 0, URLs will be $base_url?user=bob, if 1: $base_url/bob
my $new_url_style = 1;
122
123
124
125
126
127
128
# The processes path is replaced with this string, for security reasons, and
# to satisfy the requirements of Taint mode. Make this as simple as possible.
# Currently, the only thing that uses the PATH environment var is the
# "fortune" fakeuser, which can be safely removed.
my $safe_path = '/usr/bin:/usr/local/bin';
129
130
# Turn the process into a daemon. This will handle creating/answering socket
# connections, and forking off children to handle them. This flag can be
131
132
# toggled via command line options (--daemonize, --no-daemonize, -d), but
# this sets the default. Daemonizing tends to speed up processing (since the
133
# script stays loaded/compiled), but may cause problems on systems that
134
# don't have a functional fork() or IO::Socket::IP package. If you don't
135
136
137
138
139
140
141
142
143
144
# daemonize, this program reads requests from stdin and writes results to
# stdout, which makes it suitable for command line use or execution from
# inetd and equivalents.
my $daemonize = 0;
# This is only used when daemonized. Specify the port on which to listen for
# incoming connections. The RFC standard finger port is 79.
my $server_port = 79;
# Set this to immediately drop priveledges by setting uid and gid to these
145
146
# values. Set to undef to not attempt to drop privs. You will probably need
# to leave these as undef and run as root (risky!) if you plan to enable
147
148
149
150
151
152
153
154
155
156
157
158
# $the use_homedir variable, below.
#my $wanted_uid = undef;
#my $wanted_gid = undef;
my $wanted_uid = 1056; # (This is the uid of "finger" ON _MY_ SYSTEM.)
my $wanted_gid = 971; # (This is the gid of "iccfinger" ON _MY_ SYSTEM.)
# This is only used when daemonized. Specify the maximum number of finger
# requests to service at once. A separate child process is fork()ed off for
# each request, and if there are more requests then this value, the extra
# clients will be made to wait until some of the current requests are
# serviced. 5 to 10 is usually a good number. Set it higher if you get a
# massive amount of finger requests simultaneously.
159
160
161
162
163
164
165
166
167
my $max_connects = 10;
# This is how long, in seconds, before an idle connection will be summarily
# dropped. This prevents abuse from people hogging a connection without
# actually sending a request, without this, enough connections like this
# will block legitimate ones. At worst, they can only block for this long
# before being booted and thus freeing their connection slot for the next
# guy in line. Setting this to undef lets people sit forever, but removes
# reliance on the IO::Select package. Note that this timeout is how long
168
# the user has to complete the read_request() function, so don't set it so
169
170
# low that legitimate lag can kill them. The default is usually safe.
my $read_timeout = 15;
171
172
173
174
175
# Set this to non-zero to log all finger requests via the standard Unix
# syslog facility (requires Sys::Syslog qw(:DEFAULT setlogsock) ...)
my $use_syslog = 1;
176
177
178
179
180
181
182
183
184
185
186
187
# Set $use_homedir to something nonzero if want to read planfiles from the
# standard Unix location ("/home/$user/.plan"). Note that this is a security
# hole, as it means that either IcculusFinger must run as root to insure
# access to a user's homedir, or user's have to surrender a little more
# privacy to give a non-root user access to their homedirs. You should
# consider setting this to zero and reading the comments for $fingerspace,
# below. Note that IcculusFinger comes with a perl script for automating the
# moving of a system's planfiles from the the insecure method to the more
# secure $fingerspace method, including creating the symlinks so your users
# won't really notice a difference.
my $use_homedir = 0;
188
189
190
191
192
193
194
195
# Set $files_allowed to allow someone to use a filename instead of a
# username. If you then ask for something of the form "./filename"
# it'll open the file instead of the user's .plan.
# Without good reason the correct setting for this option is 0, and
# anything other than a specific file in the current dir will fail to
# work properly
my $files_allowed = 0;
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# If you set $use_homedir to 0, this is the directory that contains the
# planfiles in the format "$fingerdir$username" Note that THIS MUST HAVE
# THE TRAILING DIR SEPARATOR! This is ignored if $use_homedir is NOT zero.
my $fingerspace = '/fingerspace/';
# This is the maximum amount of data that IcculusFinger will read from a
# planfile. If this cuts off in the middle of an opened formatting tag,
# tough luck. IcculusFinger reads the entire planfile (up to the max you
# specify here) into memory before processing tags. Theoretically, this could
# be changed to handle tags on the fly, in which case users that would
# otherwise be over the limit might not be after processing sections, etc,
# but this is not the case here and now.
# Note that images specified inside [img] tags, etc are not counted towards
# this limit (since the web browser would be requesting those images
# separately), and only applies to the max bytes to be read directly from the
# planfile. This is merely here to prevent someone from symlinking their
# planfile to /dev/zero or something that could fill all available memory.
# This value is specified in bytes.
my $max_plan_size = (100 * 1024);
# This is the maximum size, in bytes, that a finger request can be. This is
# to prevent malicious finger clients from trying to fill all of system
# memory.
219
my $max_request_size = 512;
220
221
222
223
224
225
226
227
228
# This is what is reported to the finger client if the desired user's planfile
# is missing or empty, or the user is unknown (we make NO distinction, for
# the sake of security and privacy). This string can use IcculusFinger
# markup tags (we'll convert as appropriate), but must NOT use HTML directly,
# since it will confuse the regular finger client users. You should not
# leave this blank or undef it, since that's confusing for everyone.
my $no_report_string = "[center][i]Nothing to report.[/i][/center]";
229
230
231
232
# List at the bottom of the finger output (above wittyremark) when the .plan
# was last updated?
my $show_revision_date = 1;
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# This is the default title for the webpage. The user can override it with
# the [title] tag in their .plan file. Do not use HTML. You can specify an
# empty string (""), but not undef; however, you should REALLY have a
# default here...
my $title = "IcculusFinger $version";
# Alternately, you can populate this array with strings, and IcculusFinger
# will randomly pick one at runtime. Note that the user's [title] tags also
# land in here, so you are interfering with their ability to override the
# title if you add to this array. The $title variable above is used only if
# this array is empty, and thus gives you a comfortable default in case the
# user doesn't supply her own title. Do as you will.
my @title_array;
# If you are a content-Nazi, you can prevent the user's [title] tags from
# being included in the parsing.
my $permit_user_titles = 1;
251
252
253
254
255
256
257
258
259
260
261
# If this array is empty, then no stylesheet is used unless a user
# specifies one and you're not a content Nazi. You can populate this
# if you wish.
my @style_array;
# Don't populate this.
my $style = "";
# If you are a content-Nazi, you can prevent the user's [style] tags from
# being included in the parsing.
my $permit_user_styles = 1;
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
# This is printed after the credits at the bottom. Change it to whatever you
# like. Do not use HTML. You can specify an empty string (""), but undef
# doesn't fly here. The user can change this with [wittyremark] tags.
my $wittyremark = "Stick it in the camel and go.";
# Alternately, you can populate this array with strings, and IcculusFinger
# will randomly pick one at runtime. Note that the user's [wittyremark] tags
# also land in here, so you are interfering with their ability to override
# if you add to this array. The $wittyremark variable above is used only if
# this array is empty, and thus gives you a comfortable default in case the
# user doesn't supply her own content. Do as you will.
my @wittyremark_array;
# If you are a content-Nazi, you can prevent the user's [wittyremark] tags
# from being included in the parsing.
my $permit_user_wittyremarks = 1;
# You can screw up your output with this, if you like.
# You can append "?debug=1" to your finger request to enable this without
# changing the source.
my $debug = 0;
# This is the URL to where the script can be obtained. Feel free to change
# it if you you are forking the code, but unless you've got a good reason,
# I'd appreciate it if you'd leave my (ahem) official IcculusFinger webpage
# in this variable. Set it to undef to not supply a link at all in the
# final HTML output.
#my $scripturl = undef;
#my $scripturl = "/misc/finger.pl";
291
my $scripturl = "https://icculus.org/IcculusFinger/";
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
# This is only used in the HTML-formatted output.
# I'd prefer you leave this be, but change it if you must.
my $html_credits = (defined $scripturl) ?
"Powered by <a href=\"$scripturl\">IcculusFinger $version</a>" :
"Powered by IcculusFinger $version" ;
# This is only used in the plaintext-formatted output.
# I'd prefer you leave this be, but change it if you must.
my $text_credits = "Powered by IcculusFinger $version" .
((defined $scripturl) ? " ($scripturl)" : "");
# Set this to zero to disable planfile archive lookups.
my $use_database = 1;
# This is the host to connect to for database access.
my $dbhost = 'localhost';
# This is the username for the database connection.
my $dbuser = 'fingermgr';
# The database password can be entered in three ways: Either hardcode it into
# $dbpass, (which is a security risk, but is faster if you have a completely
# closed system), or leave $dbpass set to undef, in which case this script
# will try to read the password from the file specified in $dbpassfile (which
# means that this script and the database can be touched by anyone with read
# access to that file), or leave both undef to have DBI get the password from
# the DBI_PASS environment variable, which is the most secure, but least
# convenient.
my $dbpass = undef;
my $dbpassfile = '/etc/IcculusFinger_dbpass.txt';
# The name of the database to use once connected to the database server.
my $dbname = 'IcculusFinger';
# The name of the table inside the database we're using.
my $dbtable_archive = 'finger_archive';
331
332
333
334
335
336
337
338
339
# This is the time, in minutes, to generate a digest webpage of all available
# finger accounts. The digest includes last updated time and a link to the
# web version of the .plan files. Set this to undef to disable this feature.
# Also, this only runs if we're daemonized (--daemonize commandline option).
# If you aren't daemonized, you can force a digest update by running
# this program from the command line with the --digest option...probably from
# a cronjob.
my $digest_frequency = 10;
340
341
342
343
344
345
# Digests (html and rss) will show at most $digest_max_users plans, newest
# listed first. Five to ten is probably a good idea. undef to list all
# non-empty .planfiles.
#my $digest_max_users = undef;
my $digest_max_users = 10;
346
347
348
349
350
# Default count of items in a specific user's RSS feed.
my $oneuser_rss_items = 5;
# Most RSS items to list for specific users' feeds. This is a clamp, in case
# there are more specified in the URL.
351
my $max_oneuser_rss_items = 20;
352
353
354
355
356
357
358
# Filename to write finger digest to. "undef" will universally disable digest
# generation, from the daemon or command line. Note that this file is opened
# for writing _AFTER_ the program drops privileges, whether you run this from
# the command line or as a daemon.
my $digest_filename = '/webspace/icculus.org/fingerdigest.html';
359
360
361
# Filename to write finger digest RSS to, "undef" will universally
# disable RSS digest generation, from the daemon or the command line. See
# other notes above.
362
363
# This is for RSS feeds for all users. Individual users still get their
# own personal feeds (with the &rss=1 arg on the URL.)
364
my $digest_rss_filename = '/webspace/icculus.org/fingerdigest.rdf';
365
366
367
368
369
370
371
372
# Set this to a string you want to prepend to the finger digest. If you
# aren't planning to include the digest in another webpage via PHP or
# whatnot, you should put <html> and <title> tags, etc here. "undef" is
# safe, too.
#my $digest_prepend = undef;
my $digest_prepend = "<html><head><title>.plan digest</title></head><body>\n";
373
374
# Set this to a url you want to set the about to
# for the finger digest RSS about field. Et cetera.
375
my $digest_rss_about = "https://icculus.org/fingerdigest.rdf";
376
377
378
379
380
381
382
# Set this to a title you want for the RSS
my $digest_rss_title = "icculus.org finger digest";
# Set this to the link you want for the finger digest (note that this
# relates to the RSS file linking to the actual piece of html, not
# itself)
383
my $digest_rss_url = "https://icculus.org/fingerdigest.html";
384
385
386
387
388
# Set this to the description for the RSS
my $digest_rss_desc = "finger updates from icculus.org users";
# Set this to the url for the RSS image
389
my $digest_rss_image = "https://icculus.org/icculus-org-now.png";
390
391
392
393
394
395
396
# Set this to a string you want to append to the finger digest. If you
# aren't planning to include the digest in another webpage via PHP or
# whatnot, you should put <html> and <title> tags, etc here. "undef" is
# safe, too.
#my $digest_append = undef;
my $digest_append = "</body></html>\n";
397
398
399
400
401
402
403
404
405
406
407
# These are special finger accounts; when a user queries for this fake
# user, we hand back the string returned from the attached function as if
# it was the contents of a planfile. Be careful with this, as it opens up
# potential security holes.
# These subs do NOT have a maximum size limit imposed by the
# $max_plan_size setting, above.
# This hash is checked before actual planfiles, so you can override an
# existing user through this mechanism.
my %fakeusers; # the hash has to exist; don't comment this line.
408
409
# The elements of the hash, however, can be added and removed at your whim.
410
411
412
413
$fakeusers{'fortune'} = sub {
return(`/usr/games/fortune`);
};
414
415
416
417
418
419
$fakeusers{'uptime'} = sub {
my $uptime = `/usr/bin/uptime`;
$uptime =~ s/\A.*?(up \d+ days, \d+:\d+),.*\Z/$1/;
return('[center]' . $uptime . '[/center]');
};
420
421
422
423
$fakeusers{'root'} = sub {
return("ph34r me, for i am root. I'm l33t as kittens.");
};
424
425
$fakeusers{'time'} = sub {
return("At the sound of the beep, it will be: " . scalar localtime() .
426
"\012\012\012\012 ...[u][b][i]BEEP.[/i][/b][/u]");
427
428
};
429
#$fakeusers{'admin-forcedigest'} = sub {
430
# do_digests();
431
432
# return('Digest dumped, nootch.');
#};
433
434
435
# This works if run from qmail's tcp-env, and not tcpd.
436
# also note that this is pretty useless for hits through the web
437
438
# interface, since the webserver's IP will be reported, not the
# browser's IP.
439
440
$fakeusers{'ipaddr'} = sub {
if (defined $ENV{'TCPREMOTEIP'}) {
441
return("Your IP address appears to be $ENV{'TCPREMOTEIP'}");
442
443
444
445
} else {
return(undef);
}
};
446
447
448
449
450
451
#-----------------------------------------------------------------------------#
# The rest is probably okay without you laying yer dirty mits on it. #
#-----------------------------------------------------------------------------#
my $is_web_interface = 0;
452
my $do_html_formatting = undef;
453
454
455
456
457
my $browser = "";
my $wanted_section = undef;
my $output_text = "";
my $archive_date = undef;
my $archive_time = undef;
458
459
my $list_sections = 0;
my $list_archives = 0;
460
my $embed = 0;
461
my $do_link_digest = undef;
462
my $do_oneuser_rss = 0;
463
my $next_plan_digest = 0;
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
sub get_sqldate {
my $mtime = shift;
my @t = localtime($mtime);
$t[5] = "0000" . ($t[5] + 1900);
$t[5] =~ s/.*?(\d\d\d\d)\Z/$1/;
$t[4] = "00" . ($t[4] + 1);
$t[4] =~ s/.*?(\d\d)\Z/$1/;
$t[3] = "00" . $t[3];
$t[3] =~ s/.*?(\d\d)\Z/$1/;
$t[2] = "00" . $t[2];
$t[2] =~ s/.*?(\d\d)\Z/$1/;
$t[1] = "00" . $t[1];
$t[1] =~ s/.*?(\d\d)\Z/$1/;
$t[0] = "00" . $t[0];
$t[0] =~ s/.*?(\d\d)\Z/$1/;
return('' . ($t[5]) . '-' . ($t[4]) . '-' . ($t[3]) . ' ' .
($t[2]) . ':' . ($t[1]) . ':' . ($t[0]));
}
487
488
489
490
491
492
493
494
495
496
497
498
sub get_minimal_sqldate {
my $mtime = shift;
my @t = localtime($mtime);
$t[4] = "00" . ($t[4] + 1);
$t[4] =~ s/.*?(\d\d)\Z/$1/;
$t[3] = "00" . $t[3];
$t[3] =~ s/.*?(\d\d)\Z/$1/;
return('' . ($t[4]) . '/' . ($t[3]) );
}
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
sub enumerate_planfiles {
my $dirname = (($use_homedir) ? '/home' : $fingerspace);
opendir(DIRH, $dirname) or return(undef);
my @dirents = readdir(DIRH);
closedir(DIRH);
my @retval;
if ($use_homedir) {
foreach (@dirents) {
next if (($_ eq '.') or ($_ eq '..'));
push @retval, "/home/$_/.plan";
}
} else {
foreach (@dirents) {
next if (($_ eq '.') or ($_ eq '..'));
push @retval, "$fingerspace/$_";
}
}
return(@retval);
}
523
524
sub hashplans {
my %retval;
525
526
527
528
my @plans = enumerate_planfiles();
if (not @plans) {
syslog("info", "Failed to enumerate planfiles: $!\n") if ($use_syslog);
529
return(undef);
530
531
532
533
534
535
536
537
538
539
540
541
542
543
}
foreach (@plans) {
my $user = $_;
if ($use_homedir) {
$user =~ s#\A/home/(.*?)/\.plan\Z#$1#;
} else {
$user = basename($_);
}
my @statbuf = stat($_);
my $filesize = $statbuf[7];
next if ($filesize <= 0); # Skip empty .plans
544
545
# construct the hash backward for easy
# sorting-by-time in the next loop
546
547
548
my $t = $statbuf[9];
$t++ while defined $retval{$t};
$retval{$t} = $user;
549
550
}
551
552
553
return(%retval);
}
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
sub userurl {
my $user = shift;
my $args = shift;
my $url;
if ($new_url_style) {
$url = "$base_url/$user";
if (defined($args)) {
$url .= "?$args";
}
} else {
$url = "$base_url?user=$user";
if (defined($args)) {
$url .= "&$args";
}
}
}
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
sub do_digest {
return if not defined $digest_filename;
my %plansdates = hashplans();
return if (not %plansdates);
if (not open DIGESTH, '>', $digest_filename) {
if ($use_syslog) {
syslog("info", "digest: failed to open $digest_filename: $!\n");
}
return;
}
print DIGESTH $digest_prepend if defined $digest_prepend;
print DIGESTH "\n<p>\n ";
print DIGESTH "<table border=0>\n";
589
my $x = 0;
590
foreach (reverse sort keys %plansdates) {
591
592
my $user = $plansdates{$_};
my $modtime = get_minimal_sqldate($_);
593
my $href = userurl($user);
594
print DIGESTH " <tr>\n";
595
print DIGESTH " <td align=\"right\"><a href='$href'>$user</a></td>\n";
596
597
print DIGESTH " <td>$modtime</td>\n";
print DIGESTH " </tr>\n";
598
599
last if ((defined $digest_max_users) and (++$x >= $digest_max_users));
600
601
}
602
print DIGESTH " </table>\n</p>\n";
603
604
605
print DIGESTH $digest_append if defined $digest_append;
close(DIGESTH);
}
606
607
608
609
610
611
612
613
614
sub pubdate {
my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst) = @_;
return POSIX::strftime("%a, %e %b %Y %H:%M:%S %z", $sec, $min, $hour,
$mday, $mon, $year, $wday, $yday, $isdst);
}
615
616
617
618
619
620
621
622
623
624
625
626
627
sub do_rss_digest {
return if not defined $digest_rss_filename;
my %plansdates = hashplans();
return if (not %plansdates);
if (not open RSS_DIGESTH, '>', $digest_rss_filename) {
if ($use_syslog) {
syslog("info", "digest: failed to open $digest_rss_filename: $!\n");
}
return;
}
628
my $pubdate = pubdate(localtime(time()));
629
630
631
632
633
634
my $rdfitems = "\n";
my $digestitems = '';
my $x = 0;
foreach (reverse sort keys %plansdates) {
my $user = $plansdates{$_};
my $modtime = get_minimal_sqldate($_);
635
my $itempubdate = pubdate(localtime($_));
636
my $href = userurl($user);
637
638
639
640
$rdfitems .= " <rdf:li rdf:resource=\"$href\" />\n";
$digestitems .= " <item rdf:about=\"$href\">\n";
$digestitems .= " <title>$user - $modtime</title>\n";
$digestitems .= " <link>$href</link>\n";
641
$digestitems .= " <pubDate>$itempubdate</pubDate>\n";
642
643
644
645
646
647
$digestitems .= " <description>.plan update from $user</description>\n";
$digestitems .= " </item>\n\n";
last if ((defined $digest_max_users) and (++$x >= $digest_max_users));
}
648
649
print RSS_DIGESTH <<__EOF__;
<?xml version="1.0" encoding="utf-8"?>
650
651
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
652
653
654
xmlns="http://purl.org/rss/1.0/"
>
655
656
657
658
659
<channel rdf:about="$digest_rss_about">
<title>$digest_rss_title</title>
<link>$digest_rss_url</link>
<description>$digest_rss_desc</description>
660
<image rdf:resource="$digest_rss_image" />
661
<pubDate>$pubdate</pubDate>
662
663
664
<items>
<rdf:Seq>$rdfitems </rdf:Seq>
</items>
665
666
667
668
669
670
671
672
</channel>
<image>
<title>$digest_rss_title</title>
<url>$digest_rss_image</url>
<link>$digest_rss_url</link>
</image>
673
674
$digestitems
</rdf:RDF>
675
676
677
__EOF__
678
679
680
681
close(RSS_DIGESTH);
}
682
683
684
my $linkcount = 0;
my @link_digest;
my %metadata;
685
686
687
688
689
my $did_output_start = 0;
sub output_start {
my ($user, $host) = @_;
return if ((not $is_web_interface) and (not $do_html_formatting));
690
return if $do_oneuser_rss;
691
692
693
694
return if $did_output_start;
$did_output_start = 1;
695
696
my $rssdigest = '';
if ((defined $digest_rss_title) and (defined $digest_rss_about)) {
697
698
my $rssurl = userurl($user, 'rss=1');
$rssdigest = "<link rel=\"alternate\" title=\"Finger updates from $user\@$host\" href=\"$rssurl\" type=\"application/rss+xml\" />\n " .
699
"<link rel=\"alternate\" title=\"$digest_rss_title\" href=\"$digest_rss_about\" type=\"application/rss+xml\" />\n";
700
701
}
702
703
704
705
my $twitter = '';
if (defined $metadata{'twitter'}) {
my $uname = $metadata{'twitter'};
my $summary = $metadata{'summary'};
706
707
my $titlestr = $title;
# !!! FIXME: we need a proper HTML encoder.
708
709
710
$uname =~ s/'/&\#39/g;
$titlestr =~ s/'/&\#39/g;
$summary =~ s/'/&\#39/g;
711
712
$twitter .= "<meta name='twitter:card' content='summary' />\n";
$twitter .= "<meta name='twitter:site' content='\@$uname' />\n";
713
$twitter .= "<meta name='twitter:title' content='$titlestr' />\n";
714
715
716
$twitter .= "<meta name='twitter:description' content='$summary' />\n";
}
717
print <<__EOF__ if not $embed;
718
719
720
721
<html>
<head>
<title> $title </title>
722
$rssdigest
723
$twitter
724
725
726
__EOF__
print "<link rel=\"stylesheet\" href=\"$style\"
727
type=\"text/css\" />" if(defined $style && length($style) > 0);
728
729
print <<__EOF__ if not $embed;
730
731
732
</head>
<body>
733
<div class="top">
734
735
<center><h1>Finger info for $user\@$host...</h1></center>
</div>
736
<hr>
737
738
__EOF__
739
740
print "<div class=\"content\">";
741
742
743
744
}
sub output_ending {
745
746
return if $do_oneuser_rss;
747
my ($user, $host) = @_;
748
749
750
if (($is_web_interface) or ($do_html_formatting)) {
print(" </div>\n");
}
751
752
753
return if $embed;
754
755
756
757
758
my $revision = undef;
if (($show_revision_date) and (defined $archive_date)) {
$revision = "When this .plan was written: $archive_date";
}
759
if ($do_html_formatting) {
760
$revision = ((defined $revision) ? "$revision<br/>\n" : '');
761
762
763
my $archivestext = '';
if (defined $user) {
764
765
766
my $archivesurl = userurl($user, 'listarchives=1');
my $rssurl = userurl($user, 'rss=1');
$archivestext = ".plan archives for this user are <a href='$archivesurl'>here</a> (RSS <a href='$rssurl'>here</a>).<br/>";
767
768
}
769
print <<__EOF__;
770
<div class="bottom">
771
772
773
<hr>
<center>
<font size="-3">
774
$revision
775
$archivestext
776
$html_credits<br/>
777
778
779
<i>$wittyremark</i>
</font>
</center>
780
</div>
781
782
783
__EOF__
} else {
784
# Perl has no builtin max
785
my $maxlength = (defined $revision) ? length($revision) : 0;
786
787
$maxlength = length($text_credits) if(length($text_credits)>$maxlength);
$maxlength = length($wittyremark) if(length($wittyremark)>$maxlength);
788
print "\n";
789
print "-" x $maxlength . "\n";
790
print "$revision\n" if (defined $revision);
791
print ".plan archives for this user: finger $user?listarchives=1\@$host\n" if (defined $user);
792
793
794
795
796
797
798
799
800
801
802
803
804
print "$text_credits\n";
print "$wittyremark\n\n";
}
if (($is_web_interface) or ($do_html_formatting)) {
print(" </body>\n");
print("</html>\n");
print("\n");
}
}
sub parse_args {
my $args = shift;
805
806
if ((defined $args) and ($args ne '')) {
$args =~ s/\A\?//;
807
808
809
810
if ($args =~ s/(\A|&)web=(.*?)(&|\Z)/$1/) {
$is_web_interface = $2;
}
811
812
813
814
if ($args =~ s/(\A|&)html=(.*?)(&|\Z)/$1/) {
$do_html_formatting = $2;
}
815
816
817
818
819
820
821
822
823
824
825
826
if ($args =~ s/(\A|&)rss=(.*?)(&|\Z)/$1/) {
$do_oneuser_rss = $2;
}
if ($args =~ s/(\A|&)rssitems=(.*?)(&|\Z)/$1/) {
$oneuser_rss_items = $2;
if ($oneuser_rss_items > $max_oneuser_rss_items) {
$oneuser_rss_items = $max_oneuser_rss_items;
}
}
827
828
829
if ($args =~ s/(\A|&)browser=(.*?)(&|\Z)/$1/) {
$browser = $2;
}
830
831
832
833
if ($args =~ s/(\A|&)debug=(.*?)(&|\Z)/$1/) {
$debug = $2;
}
834
835
836
837
838
if ($args =~ s/(\A|&)section=(.*?)(&|\Z)/$1/) {
$wanted_section = $2;
$wanted_section =~ tr/A-Z/a-z/;
}
839
840
841
842
if ($args =~ s/(\A|&)date=(.*?)(&|\Z)/$1/) {
$archive_date = $2;
}
843
844
845
846
if ($args =~ s/(\A|&)time=(.*?)(&|\Z)/$1/) {
$archive_time = $2;
}
847
848
849
850
if ($args =~ s/(\A|&)listsections=(.*?)(&|\Z)/$1/) {
$list_sections = $2;
}
851
852
853
854
if ($args =~ s/(\A|&)listarchives=(.*?)(&|\Z)/$1/) {
$list_archives = $2;
}
855
856
857
858
859
860
861
862
if ($args =~ s/(\A|&)embed=(.*?)(&|\Z)/$1/) {
$embed = $2;
}
if ($args =~ s/(\A|&)linkdigest=(.*?)(&|\Z)/$1/) {
$do_link_digest = $2;
}
863
864
}
865
# default behaviours that depend on output target...
866
$do_html_formatting = $do_oneuser_rss if (not defined $do_html_formatting);
867
868
$do_link_digest = !$do_html_formatting if (not defined $do_link_digest);
869
870
871
872
return($args);
}
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
sub get_database_link {
if (not defined $dbpass) {
if (defined $dbpassfile) {
open(FH, $dbpassfile) or return("failed to open $dbpassfile: $!\n");
$dbpass = <FH>;
chomp($dbpass);
$dbpass =~ s/\A\s*//;
$dbpass =~ s/\s*\Z//;
close(FH);
}
}
my $dsn = "DBI:mysql:database=$dbname;host=$dbhost";
$_[0] = DBI->connect($dsn, $dbuser, $dbpass) or
return(DBI::errstr);
return(undef);
}
sub load_archive_list {
893
my $user = shift;
894
895
896
my $link;
my $err = get_database_link($link);
return($err) if defined $err;
897
898
my $u = $link->quote($user);
899
my $sql = "select postdate, summary from $dbtable_archive where username=$u" .
900
901
902
903
904
905
906
" order by postdate desc";
my $sth = $link->prepare($sql);
if (not $sth->execute()) {
$link->disconnect();
return "can't execute the query: $sth->errstr";
}
907
908
$output_text = "Available archives:\n";
my $had_archives = 0;
909
while (my @row = $sth->fetchrow_array()) {
910
911
912
913
my ($dt, $summary) = @row;
my ($d, $t) = $dt =~ /(\d\d\d\d-\d\d-\d\d) (\d\d:\d\d:\d\d)/;
$t =~ s/(..):(..):(..)/$1-$2-$3/;
if ($do_html_formatting) {
914
my $archivelink = userurl($user, "date=$d&time=$t");
915
$summary = " -- $summary" if ($summary ne '');
916
$output_text .= " \[link=\"$archivelink\"\]$dt\[/link\]$summary\n";
917
918
919
} else {
$summary = " # $summary" if ($summary ne '');
$output_text .= " finger '$user?date=$d&time=$t\@$host'$summary\n";
920
}
921
$had_archives = 1;
922
923
924
925
}
$sth->finish();
$link->disconnect();
926
927
928
929
930
if (not $had_archives) {
$output_text = ''; # will use $no_report_string.
}
931
932
933
934
return(undef);
}
935
936
937
938
939
940
941
sub output_oneuser_rss {
my $user = shift;
my $link;
my $err = get_database_link($link);
return($err) if defined $err;
my $u = $link->quote($user);
942
my $sql = "select postdate, text, summary from $dbtable_archive where username=$u" .
943
944
945
946
947
948
949
" order by postdate desc limit $oneuser_rss_items";
my $sth = $link->prepare($sql);
if (not $sth->execute()) {
$link->disconnect();
return "can't execute the query: $sth->errstr";
}
950
951
952
my $oneuser_rss_url = userurl($user, 'rss=1');
$oneuser_rss_url =~ s/\&/&/g;
953
954
955
956
957
958
959
960
961
962
963
964
965
966
my $oneuser_rss_title = "Finger updates from $user\@$host";
my $pubDate = pubdate(localtime(time()));
my $rdfitems = "\n";
my $digestitems = '';
my $x = 0;
while (my @row = $sth->fetchrow_array()) {
my $dateandtime = $row[0];
my ($d, $t) = ($dateandtime =~ /(\d\d\d\d-\d\d-\d\d) (\d\d:\d\d:\d\d)/);
my ($hour, $min, $sec) = ($t =~ /(..):(..):(..)/);
my ($year, $mon, $day) = ($d =~ /(\d\d\d\d)-(\d\d)-(\d\d)/);
my $unixtime = POSIX::mktime($sec, $min, $hour, $day, $mon-1, $year-1900, 0, 0);
$wanted_section = undef; # global that gets set in do_fingering() and elsewhere...
$output_text = $row[1];
967
968
969
970
971
972
my $summary = $row[2];
if ($summary eq '') {
$summary = ".plan update from $user, $dateandtime";
}
973
974
975
976
977
# Might need to add this back in someday...
#if (length($output_text) >= 5*1024) {
# $output_text = substr($row[1],0,5*1024) . " ...\n";
#}
978
979
980
981
982
do_fingering('[unavailable for RSS feed generation]', $user, 1);
# $output_text now holds HTML-formatted .planfile, for embedding in
# the RSS feed. Now you need to encode it further, so HTML tags, etc
# don't screw with the container tags.
983
$output_text = "\n$output_text\n";
984
985
986
987
988
989
990
1 while ($output_text =~ s/(?<!">)\&(?!amp)/&/s);
1 while ($output_text =~ s/</</s);
1 while ($output_text =~ s/>/>/s);
my @pubtime = localtime($unixtime);
$pubtime[2] = $hour; # workaround to make times match. Probably not the right way.
my $itempubdate = pubdate(@pubtime);
991
992
my $href = userurl($user, "date=$d&time=$hour-$min-$sec");
$href =~ s/\&/&/g;
993
994
$rdfitems .= " <rdf:li rdf:resource=\"$href\" />\n";
$digestitems .= " <item rdf:about=\"$href\">\n";
995
$digestitems .= " <title>$summary</title>\n";
996
997
998
999
1000
$digestitems .= " <link>$href</link>\n";
$digestitems .= " <pubDate>$itempubdate</pubDate>\n";
$digestitems .= " <description>$output_text</description>\n";
$digestitems .= " </item>\n\n";
}