chiark / gitweb /
Merge branch 'master' of ijackson@chiark:things/Yarrgweb/ypp-sc-tools
[ypp-sc-tools.main.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 BEGIN {
47     use Exporter ();
48     our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
49     $VERSION     = 1.00;
50     @ISA         = qw(Exporter);
51     @EXPORT      = qw(&dbw_connect &ocean_list &sourcebasedir
52                       &to_json_shim &to_json_protecttags
53                       &set_ctype_utf8
54                       &prettyprint_age &meta_prettyprint_age);
55     %EXPORT_TAGS = ( );
56
57     @EXPORT_OK   = qw();
58 }
59
60 sub sourcebasedir () {
61     my $dir;
62     
63     for my $dir (@INC) {
64         if ($dir =~ m/\.perl-lib$/) {
65             $dir= "$dir/..";
66             last;
67         }
68     }
69     defined $dir or
70         die "no source base dir in @INC";
71     return $dir;
72 }
73
74 my datadir () {
75     my $dir= sourcebasedir();
76     if (stat "$dir/DATA") {
77         return "$dir/DATA";
78     } elsif ($!==&ENOENT) {
79         return "$dir";
80     } else {
81         die "stat $dir/DATA $!";
82     }
83     return '.';
84 }
85
86 my @ocean_list;
87
88 sub ocean_list () {
89     if (!@ocean_list) {
90         my $fn= "$datadir/master-info.txt";
91         my $f= new IO::File $fn or die $!;
92         my @r;
93         while (<$f>) {
94             next unless m/^ocean\s+(\S.*\S)\s*$/;
95             push @r, $1;
96         }
97         $f->error and die $!;
98         close $fn;
99         @ocean_list= @r;
100     }
101     return @ocean_list;
102 }
103
104 sub dbw_connect ($) {
105     my ($ocean) = @_;
106     die "unknown ocean $ocean ?"
107         unless grep { $_ eq $ocean } ocean_list();
108     return dbr_connect(datadir(), $ocean);
109 }
110
111 sub to_json_shim ($) {
112     my ($obj) = @_;
113     # In JSON.pm 2.x, jsonToObj prints a warning to stderr which
114     # our callers don't like at all.
115     if ($JSON::VERSION >= 2.0) {
116         return to_json($obj);
117     } else {
118         return objToJson($obj);
119     }
120 }
121
122 sub to_json_protecttags ($) {
123     my ($v) = @_;
124     my $j= to_json_shim($v);
125     $j =~ s,/,\\/,g;
126     return $j;
127 }
128
129 sub meta_prettyprint_age ($$$) {
130     my ($age,$floor,$plus) = @_;
131     return <<END;
132         $age < 60 ?             'less than a minute'                    :
133         $age < 60*2 ?           '1 minute'                              :
134         $age < 3600*2 ?         $floor ($age/60) $plus' minutes'        :
135         $age < 86400*2 ?        $floor ($age/3600) $plus ' hours'       :
136                                 $floor ($age/86400) $plus ' days';
137 END
138 };
139
140 BEGIN { eval '
141   sub prettyprint_age ($) {
142                 my ($age) = @_;
143                 '.meta_prettyprint_age('$age','floor','.').'
144   };
145   1;
146 ' or die "$@";
147 }
148
149
150 1;