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     %EXPORT_TAGS = ( );
  58
  59     @EXPORT_OK   = qw();
  60 }
  61
  62 our $datadir='.';
  63 our $sourcebasedir;
  64
  65 for my $dir (@INC) {
  66     if ($dir =~ m/\.perl-lib$/) {
  67         $sourcebasedir= "$dir/..";
  68         if (stat "$dir/DATA") {
  69             $datadir= "$dir/DATA";
  70         } elsif ($!==&ENOENT) {
  71             $datadir= "$dir";
  72         } else {
  73             die "stat $dir/DATA $!";
  74         }
  75         last;
  76     }
  77 }
  78 defined $sourcebasedir or
  79     die "no source base dir in @INC";
  80
  81 my @ocean_list;
  82
  83 sub ocean_list () {
  84     if (!@ocean_list) {
  85         my $fn= "$datadir/master-info.txt";
  86         my $f= new IO::File $fn or die $!;
  87         my @r;
  88         while (<$f>) {
  89             next unless m/^ocean\s+(\S.*\S)\s*$/;
  90             push @r, $1;
  91         }
  92         $f->error and die $!;
  93         close $fn;
  94         @ocean_list= @r;
  95     }
  96     return @ocean_list;
  97 }
  98
  99 sub dbw_connect ($) {
 100     my ($ocean) = @_;
 101     die "unknown ocean $ocean ?"
 102         unless grep { $_ eq $ocean } ocean_list();
 103     return dbr_connect($datadir, $ocean);
 104 }
 105
 106 sub to_json_shim ($) {
 107     my ($obj) = @_;
 108     # In JSON.pm 2.x, jsonToObj prints a warning to stderr which
 109     # our callers don't like at all.
 110     if ($JSON::VERSION >= 2.0) {
 111         return to_json($obj);
 112     } else {
 113         return objToJson($obj);
 114     }
 115 }
 116
 117 sub to_json_protecttags ($) {
 118     my ($v) = @_;
 119     my $j= to_json_shim($v);
 120     $j =~ s,/,\\/,g;
 121     return $j;
 122 }
 123
 124 1;