fix dep on HTML::GoogleMaps, RT#15539
[freeside.git] / FS / FS / Mason.pm
index 5e77b98..fc45b99 100644 (file)
@@ -1,8 +1,10 @@
 package FS::Mason;
 
 use strict;
-use vars qw( @ISA @EXPORT_OK );
+use vars qw( @ISA @EXPORT_OK $addl_handler_use );
 use Exporter;
+use Carp;
+use File::Slurp qw( slurp );
 use HTML::Mason 1.27; #http://www.masonhq.com/?ApacheModPerl2Redirect
 use HTML::Mason::Interp;
 use HTML::Mason::Compiler::ToObject;
@@ -30,6 +32,12 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
 
 =cut
 
+$addl_handler_use = '';
+my $addl_handler_use_file = '%%%FREESIDE_CONF%%%/addl_handler_use.pl';
+if ( -e $addl_handler_use_file ) {
+  $addl_handler_use = slurp( $addl_handler_use_file );
+}
+
 # List of modules that you want to use from components (see Admin
 # manual for details)
 {
@@ -50,19 +58,25 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   use List::Util qw( max min );
   use Data::Dumper;
   use Date::Format;
-  use Date::Parse;
   use Time::Local;
+  use Time::HiRes;
   use Time::Duration;
   use DateTime;
   use DateTime::Format::Strptime;
+  use FS::Misc::DateTime qw( parse_datetime );
   use Lingua::EN::Inflect qw(PL);
+  Lingua::EN::Inflect::classical names=>0; #Categorys
   use Tie::IxHash;
   use URI;
   use URI::Escape;
   use HTML::Entities;
   use HTML::TreeBuilder;
+  use HTML::TableExtract qw(tree);
   use HTML::FormatText;
+  use HTML::Defang;
   use JSON;
+#  use XMLRPC::Transport::HTTP;
+#  use XMLRPC::Lite; # for XMLRPC::Serializer
   use MIME::Base64;
   use IO::Handle;
   use IO::File;
@@ -75,16 +89,34 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   }
   use Text::CSV_XS;
   use Spreadsheet::WriteExcel;
+  use Spreadsheet::WriteExcel::Utility;
   use Business::CreditCard 0.30; #for mask-aware cardtype()
   use NetAddr::IP;
+  use Net::Ping;
+  use Net::Ping::External;
+  #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
+  {
+    no warnings 'redefine';
+    eval 'sub Net::Ping::External::_ping_linux { 
+            my %args = @_;
+            my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
+            return Net::Ping::External::_ping_system($command, 0);
+          }
+         ';
+    die $@ if $@;
+  }
   use String::Approx qw(amatch);
   use Chart::LinesPoints;
   use Chart::Mountain;
+  use Chart::Bars;
   use Color::Scheme;
   use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
                                         #selectlayers.html
   use Locale::Country;
   use Business::US::USPS::WebTools::AddressStandardization;
+  use Geo::GoogleEarth::Pluggable;
+  use LWP::UserAgent;
+  use Storable qw( nfreeze thaw );
   use FS;
   use FS::UID qw( getotaker dbh datasrc driver_name );
   use FS::Record qw( qsearch qsearchs fields dbdef
@@ -97,11 +129,19 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   use FS::UI::Web::small_custview qw(small_custview);
   use FS::UI::bytecount;
   use FS::Msgcat qw(gettext geterror);
-  use FS::Misc qw( send_email send_fax states_hash counties state_label );
+  use FS::Misc qw( send_email send_fax ocr_image
+                   states_hash counties cities state_label
+                 );
   use FS::Misc::eps2png qw( eps2png );
+  use FS::Report::FCC_477;
+  use FS::Report::Table;
   use FS::Report::Table::Monthly;
+  use FS::Report::Table::Daily;
   use FS::TicketSystem;
+  use FS::NetworkMonitoringSystem;
   use FS::Tron qw( tron_lint );
+  use FS::Locales;
+  use FS::Maketext qw( mt emt js_mt );
 
   use FS::agent;
   use FS::agent_type;
@@ -110,12 +150,14 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   use FS::cust_bill_pay;
   use FS::cust_credit;
   use FS::cust_credit_bill;
-  use FS::cust_main qw(smart_search);
+  use FS::cust_main;
+  use FS::cust_main::Search qw(smart_search);
   use FS::cust_main::Import;
   use FS::cust_main_county;
   use FS::cust_location;
   use FS::cust_pay;
   use FS::cust_pkg;
+  use FS::cust_pkg::Import;
   use FS::part_pkg_taxclass;
   use FS::cust_pkg_reason;
   use FS::cust_refund;
@@ -151,6 +193,7 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   use FS::part_export;
   use FS::part_export_option;
   use FS::export_svc;
+  use FS::export_device;
   use FS::msgcat;
   use FS::rate;
   use FS::rate_region;
@@ -162,6 +205,7 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   use FS::XMLRPC;
   use FS::payby;
   use FS::cdr;
+  use FS::cdr_batch;
   use FS::inventory_class;
   use FS::inventory_item;
   use FS::pkg_category;
@@ -185,12 +229,92 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   use FS::part_pkg_taxoverride;
   use FS::part_pkg_taxrate;
   use FS::tax_rate;
+  use FS::part_pkg_report_option;
+  use FS::cust_attachment;
+  use FS::h_cust_pkg;
+  use FS::h_inventory_item;
+  use FS::h_svc_acct;
+  use FS::h_svc_broadband;
+  use FS::h_svc_domain;
+  #use FS::h_domain_record;
+  use FS::h_svc_external;
+  use FS::h_svc_forward;
+  use FS::h_svc_phone;
+  #use FS::h_phone_device;
+  use FS::h_svc_www;
+  use FS::cust_statement;
+  use FS::cust_class;
+  use FS::cust_category;
+  use FS::prospect_main;
+  use FS::contact;
+  use FS::phone_type;
+  use FS::svc_pbx;
+  use FS::discount;
+  use FS::cust_pkg_discount;
+  use FS::cust_bill_pkg_discount;
+  use FS::svc_mailinglist;
+  use FS::cgp_rule;
+  use FS::cgp_rule_condition;
+  use FS::cgp_rule_action;
+  use FS::bill_batch;
+  use FS::cust_bill_batch;
+  use FS::rate_time;
+  use FS::rate_time_interval;
+  use FS::msg_template;
+  use FS::part_tag;
+  use FS::acct_snarf;
+  use FS::part_pkg_discount;
+  use FS::svc_cert;
+  use FS::svc_dsl;
+  use FS::qual;
+  use FS::qual_option;
+  use FS::dsl_note;
+  use FS::part_pkg_vendor;
+  use FS::cust_note_class;
+  use FS::svc_port;
+  use FS::lata;
+  use FS::did_vendor;
+  use FS::did_order;
+  use FS::torrus_srvderive;
+  use FS::torrus_srvderive_component;
+  use FS::areacode;
+  use FS::svc_dish;
+  use FS::h_svc_dish;
+  use FS::svc_hardware;
+  use FS::h_svc_hardware;
+  use FS::hardware_class;
+  use FS::hardware_type;
+  use FS::hardware_status;
+  use FS::did_order_item;
+  use FS::msa;
+  use FS::rate_center;
+  use FS::cust_msg;
+  use FS::radius_group;
+  use FS::template_content;
+  use FS::dsl_device;
+  use FS::nas;
+  use FS::nas;
+  use FS::export_nas;
+  use FS::legacy_cust_bill;
+  use FS::rate_tier;
+  use FS::rate_tier_detail;
+  use FS::radius_attr;
+  use FS::discount_plan;
+  use FS::tower;
+  use FS::tower_sector;
+  # Sammath Naur
+
+  if ( $FS::Mason::addl_handler_use ) {
+    eval $FS::Mason::addl_handler_use;
+    die $@ if $@;
+  }
 
   if ( %%%RT_ENABLED%%% ) {
     eval '
       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
       use vars qw($Nobody $SystemUser);
       use RT;
+      use RT::Util;
       use RT::Tickets;
       use RT::Transactions;
       use RT::Users;
@@ -219,6 +343,11 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
       #to throw a real error instead of just a mysterious unstyled RT
       use CSS::Squish 0.06;
 
+      use RT::Interface::Web::Request;
+
+      #nother undeclared web UI dep (for ticket links graph)
+      use IPC::Run::SafeHandles;
+
       #slow, unreliable, segfaults and is optional
       #see rt/html/Ticket/Elements/ShowTransactionAttachments
       #use Text::Quoted;
@@ -284,6 +413,7 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   
   sub include {
     use vars qw($m);
+    #carp #should just switch to <& &> syntax
     $m->scomp(@_);
   }
 
@@ -292,6 +422,11 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
     $m->comp('/elements/errorpage.html', @_);
   }
 
+  sub errorpage_popup {
+    use vars qw($m);
+    $m->comp('/elements/errorpage-popup.html', @_);
+  }
+
   sub redirect {
     my( $location ) = @_;
     use vars qw($m);
@@ -339,50 +474,89 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
 
 =over 4
 
-=item mason_interps [ MODE ]
+=item mason_interps [ MODE [ OPTION => VALUE ... ] ]
 
 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 Freeside pages, and the second for RT pages.
 
-#MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
+MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
+
+Options and values can be passed following mode.  Currently available options
+are:
+
+I<outbuf> should be set to a scalar reference in standalone mode.
 
 =cut
 
+my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
+
 sub mason_interps {
   my $mode = shift || 'apache';
   my %opt = @_;
 
   #my $request_class = 'HTML::Mason::Request'.
                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
-  my $request_class = 'FS::Mason::Request';
+  my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
+                                            : 'FS::Mason::Request';
 
   #not entirely sure it belongs here, but what the hey
-  if ( %%%RT_ENABLED%%% ) {
+  if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
     RT::LoadConfig();
   }
 
+  # A hook supporting strange legacy ways people (well, SG) have added stuff on
+
+  my @addl_comp_root = ();
+  my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
+  if ( -e $addl_comp_root_file ) {
+    warn "reading $addl_comp_root_file\n";
+    my $text = slurp( $addl_comp_root_file );
+    my @addl = eval $text;
+    if ( @addl && ! $@ ) {
+      @addl_comp_root = @addl;
+    } elsif ($@) {
+      warn "error parsing $addl_comp_root_file: $@\n";
+    }
+  }
+
+  my $fs_comp_root =
+    scalar(@addl_comp_root)
+      ? [
+          [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
+          @addl_comp_root,
+        ]
+      : '%%%FREESIDE_DOCUMENT_ROOT%%%';
+
   my %interp = (
     request_class        => $request_class,
     data_dir             => '%%%MASONDATA%%%',
     error_mode           => 'output',
     error_format         => 'html',
     ignore_warnings_expr => '.',
-    comp_root            => [
-                              [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
-                              [ 'rt'      =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
-                            ],
   );
 
   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 
+  my $html_defang = new HTML::Defang (%defang_opts);
+
+  #false laziness w/ FS::Maketext js_mt
+  my $js_string_sub = sub {
+    #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
+    ${$_[0]} =~ s/(['\\])/\\$1/g;
+    ${$_[0]} =~ s/\r/\\r/g;
+    ${$_[0]} =~ s/\n/\\n/g;
+    ${$_[0]} = "'". ${$_[0]}. "'";
+  };
+
+  my $defang_sub = sub {
+    ${$_[0]} = $html_defang->defang(${$_[0]});
+  };
+
   my $fs_interp = new HTML::Mason::Interp (
     %interp,
-    escape_flags => { 'js_string' => sub {
-                        #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
-                        ${$_[0]} =~ s/(['\\])/\\$1/g;
-                        ${$_[0]} =~ s/\n/\\n/g;
-                        ${$_[0]} = "'". ${$_[0]}. "'";
-                      }
+    comp_root    => $fs_comp_root,
+    escape_flags => { 'js_string'   => $js_string_sub,
+                      'defang'      => $defang_sub,
                     },
     compiler     => HTML::Mason::Compiler::ToObject->new(
                       allow_globals        => [qw(%session)],
@@ -391,7 +565,13 @@ sub mason_interps {
 
   my $rt_interp = new HTML::Mason::Interp (
     %interp,
-    escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
+    comp_root    => [
+                      [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
+                      [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
+                    ],
+    escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
+                      'js_string' => $js_string_sub,
+                    },
     compiler     => HTML::Mason::Compiler::ToObject->new(
                       default_escape_flags => 'h',
                       allow_globals        => [qw(%session)],