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