chiark / gitweb /
prettyprint_age moved to commodsweb
[ypp-sc-tools.db-live.git] / yarrg / CommodsWeb.pm
1 # This is part of the YARRG website.  YARRG is a tool and website
2 # for assisting players of Yohoho Puzzle Pirates.
3 #
4 # Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
5 # Copyright (C) 2009 Clare Boothby
6 #
7 #  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
8 #  The YARRG website is covered by the GNU Affero GPL v3 or later, which
9 #   basically means that every installation of the website will let you
10 #   download the source.
11 #
12 # This program is free software: you can redistribute it and/or modify
13 # it under the terms of the GNU Affero General Public License as
14 # published by the Free Software Foundation, either version 3 of the
15 # License, or (at your option) any later version.
16 #
17 # This program is distributed in the hope that it will be useful,
18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 # GNU Affero General Public License for more details.
21 #
22 # You should have received a copy of the GNU Affero General Public License
23 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
24 #
25 # Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
26 # are used without permission.  This program is not endorsed or
27 # sponsored by Three Rings.
28
29
30 # This Perl module is used by the Mason scripts in yarrg/web/.
31 # We look for a symlink DATA to the actual data to use, so that
32 # the data uploader and website displayer can use different code.
33
34 package CommodsWeb;
35
36 use strict;
37 use warnings;
38
39 use DBI;
40 use POSIX;
41 use JSON;
42
43 use Commods;
44 use CommodsDatabase;
45
46 our $self_url;
47 our $base_url;
48
49 BEGIN {
50     use Exporter ();
51     our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
52     $VERSION     = 1.00;
53     @ISA         = qw(Exporter);
54     @EXPORT      = qw(&dbw_connect &ocean_list $sourcebasedir
55                       &to_json_shim &to_json_protecttags
56                       &set_ctype_utf8
57                       &prettyprint_age &meta_prettyprint_age);
58     %EXPORT_TAGS = ( );
59
60     @EXPORT_OK   = qw();
61 }
62
63 our $datadir='.';
64 our $sourcebasedir;
65
66 for my $dir (@INC) {
67     if ($dir =~ m/\.perl-lib$/) {
68         $sourcebasedir= "$dir/..";
69         if (stat "$dir/DATA") {
70             $datadir= "$dir/DATA";
71         } elsif ($!==&ENOENT) {
72             $datadir= "$dir";
73         } else {
74             die "stat $dir/DATA $!";
75         }
76         last;
77     }
78 }
79 defined $sourcebasedir or
80     die "no source base dir in @INC";
81
82 my @ocean_list;
83
84 sub ocean_list () {
85     if (!@ocean_list) {
86         my $fn= "$datadir/master-info.txt";
87         my $f= new IO::File $fn or die $!;
88         my @r;
89         while (<$f>) {
90             next unless m/^ocean\s+(\S.*\S)\s*$/;
91             push @r, $1;
92         }
93         $f->error and die $!;
94         close $fn;
95         @ocean_list= @r;
96     }
97     return @ocean_list;
98 }
99
100 sub dbw_connect ($) {
101     my ($ocean) = @_;
102     die "unknown ocean $ocean ?"
103         unless grep { $_ eq $ocean } ocean_list();
104     return dbr_connect($datadir, $ocean);
105 }
106
107 sub to_json_shim ($) {
108     my ($obj) = @_;
109     # In JSON.pm 2.x, jsonToObj prints a warning to stderr which
110     # our callers don't like at all.
111     if ($JSON::VERSION >= 2.0) {
112         return to_json($obj);
113     } else {
114         return objToJson($obj);
115     }
116 }
117
118 sub to_json_protecttags ($) {
119     my ($v) = @_;
120     my $j= to_json_shim($v);
121     $j =~ s,/,\\/,g;
122     return $j;
123 }
124
125 sub meta_prettyprint_age ($$$) {
126     my ($age,$floor,$plus) = @_;
127     return <<END;
128         $age < 60 ?             'less than a minute'                    :
129         $age < 60*2 ?           '1 minute'                              :
130         $age < 3600*2 ?         $floor ($age/60) $plus' minutes'        :
131         $age < 86400*2 ?        $floor ($age/3600) $plus ' hours'       :
132                                 $floor ($age/86400) $plus ' days';
133 END
134 };
135
136 BEGIN { eval '
137   sub prettyprint_age (\$) {
138                 my ($age) = @_;
139                 '.meta_prettyprint_age('$age','floor','.').'
140   };
141   1;
142 ' or die "$@";
143 }
144
145
146 1;