Merge branch 'master' of ijackson@chiark:things/Yarrgweb/ypp-sc-tools

[ypp-sc-tools.main.git] / yarrg / CommodsWeb.pm

diff --git a/yarrg/CommodsWeb.pm b/yarrg/CommodsWeb.pm
index 5e1520e22f45a3e0d3853f53e6523f1b370e6e5c..84ea71066c186902d95b7108e874323092ff8d0b 100644 (file)
--- a/yarrg/CommodsWeb.pm
+++ b/yarrg/CommodsWeb.pm
@@ -1,26 +1,33 @@
-# This is part of ypp-sc-tools, a set of third-party tools for assisting
-# players of Yohoho Puzzle Pirates.
+# This is part of the YARRG website.  YARRG is a tool and website
+# for assisting players of Yohoho Puzzle Pirates.
 #
 # Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+# Copyright (C) 2009 Clare Boothby
+#
+#  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+#  The YARRG website is covered by the GNU Affero GPL v3 or later, which
+#   basically means that every installation of the website will let you
+#   download the source.
 #
 # 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 3 of the License, or
-# (at your option) any later version.
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 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.
+# GNU Affero General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License
+# You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
 # are used without permission.  This program is not endorsed or
 # sponsored by Three Rings.
 
-# This package is used by the Mason scripts in yarrg/web/.
+
+# This Perl module is used by the Mason scripts in yarrg/web/.
 # We look for a symlink DATA to the actual data to use, so that
 # the data uploader and website displayer can use different code.
 
@@ -31,31 +38,49 @@ use warnings;
 
 use DBI;
 use POSIX;
+use JSON;
 
 use Commods;
 use CommodsDatabase;
 
-our $self_url;
-our $base_url;
-
 BEGIN {
     use Exporter ();
     our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
     $VERSION     = 1.00;
     @ISA         = qw(Exporter);
-    @EXPORT      = qw(&dbw_connect &ocean_list);
+    @EXPORT      = qw(&dbw_connect &ocean_list &sourcebasedir
+                     &to_json_shim &to_json_protecttags
+                     &set_ctype_utf8
+                     &prettyprint_age &meta_prettyprint_age);
     %EXPORT_TAGS = ( );
 
     @EXPORT_OK   = qw();
 }
 
-our $datadir='.';
+sub sourcebasedir () {
+    my $dir;
+    
+    for my $dir (@INC) {
+       if ($dir =~ m/\.perl-lib$/) {
+           $dir= "$dir/..";
+           last;
+       }
+    }
+    defined $dir or
+       die "no source base dir in @INC";
+    return $dir;
+}
 
-for my $dir (@INC) {
-    if ($dir =~ m/\.perl-lib$/) {
-       $datadir= "$dir/DATA";
-       last;
+my datadir () {
+    my $dir= sourcebasedir();
+    if (stat "$dir/DATA") {
+       return "$dir/DATA";
+    } elsif ($!==&ENOENT) {
+       return "$dir";
+    } else {
+       die "stat $dir/DATA $!";
     }
+    return '.';
 }
 
 my @ocean_list;
@@ -80,7 +105,46 @@ sub dbw_connect ($) {
     my ($ocean) = @_;
     die "unknown ocean $ocean ?"
        unless grep { $_ eq $ocean } ocean_list();
-    return dbr_connect($datadir, $ocean);
+    return dbr_connect(datadir(), $ocean);
 }
 
+sub to_json_shim ($) {
+    my ($obj) = @_;
+    # In JSON.pm 2.x, jsonToObj prints a warning to stderr which
+    # our callers don't like at all.
+    if ($JSON::VERSION >= 2.0) {
+       return to_json($obj);
+    } else {
+       return objToJson($obj);
+    }
+}
+
+sub to_json_protecttags ($) {
+    my ($v) = @_;
+    my $j= to_json_shim($v);
+    $j =~ s,/,\\/,g;
+    return $j;
+}
+
+sub meta_prettyprint_age ($$$) {
+    my ($age,$floor,$plus) = @_;
+    return <<END;
+        $age < 60 ?             'less than a minute'                    :
+        $age < 60*2 ?           '1 minute'                              :
+        $age < 3600*2 ?         $floor ($age/60) $plus' minutes'        :
+        $age < 86400*2 ?        $floor ($age/3600) $plus ' hours'       :
+                                $floor ($age/86400) $plus ' days';
+END
+};
+
+BEGIN { eval '
+  sub prettyprint_age ($) {
+               my ($age) = @_;
+               '.meta_prettyprint_age('$age','floor','.').'
+  };
+  1;
+' or die "$@";
+}
+
+
 1;