communigate (phase 2): rules. RT#7514
[freeside.git] / FS / FS / Mason.pm
index 0a608dd..41c472d 100644 (file)
@@ -1,8 +1,9 @@
 package FS::Mason;
 
 use strict;
-use vars qw( @ISA @EXPORT_OK );
+use vars qw( @ISA @EXPORT_OK $addl_handler_use );
 use Exporter;
+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 +31,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)
 {
@@ -38,23 +45,32 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   use strict;
   use vars qw( %session );
   use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
+
+  #breaks quick payment entry
+  #http://rt.cpan.org/Public/Bug/Display.html?id=37365
+  die "CGI.pm v3.38 is broken, use any other version >= 3.29".
+      " (Debian 5.0?  aptitude remove libcgi-pm-perl)"
+    if $CGI::VERSION == 3.38;
+
   #use CGI::Carp qw(fatalsToBrowser);
   use CGI::Cookie;
   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);
   use Tie::IxHash;
-  use URI::URL;
+  use URI;
   use URI::Escape;
   use HTML::Entities;
   use HTML::TreeBuilder;
   use HTML::FormatText;
+  use HTML::Defang;
   use JSON;
   use MIME::Base64;
   use IO::Handle;
@@ -70,9 +86,23 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   use Spreadsheet::WriteExcel;
   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
@@ -90,7 +120,10 @@ 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
+                   states_hash counties cities state_label
+                 );
+  use FS::Misc::eps2png qw( eps2png );
   use FS::Report::Table::Monthly;
   use FS::TicketSystem;
   use FS::Tron qw( tron_lint );
@@ -105,6 +138,7 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   use FS::cust_main 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::part_pkg_taxclass;
@@ -142,6 +176,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;
@@ -153,6 +188,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;
@@ -165,6 +201,8 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
   use FS::access_right;
   use FS::AccessRight;
   use FS::svc_phone;
+  use FS::phone_device;
+  use FS::part_device;
   use FS::reason_type;
   use FS::reason;
   use FS::cust_main_note;
@@ -174,6 +212,35 @@ 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_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::svc_pbx;
+  use FS::discount;
+  use FS::cust_pkg_discount;
+  use FS::cust_bill_pkg_discount;
+  use FS::svc_mailinglist;
+  use FS::cgp_rule;
+  # Sammath Naur
+
+  if ( $FS::Mason::addl_handler_use ) {
+    eval $FS::Mason::addl_handler_use;
+    die $@ if $@;
+  }
 
   if ( %%%RT_ENABLED%%% ) {
     eval '
@@ -208,6 +275,8 @@ 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;
+
       #slow, unreliable, segfaults and is optional
       #see rt/html/Ticket/Elements/ShowTransactionAttachments
       #use Text::Quoted;
@@ -232,20 +301,35 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
     use vars qw($m);
 
     # false laziness w/below
-    if ( defined(@DBIx::Profile::ISA) ) { #profiling redirect
-
-      my $page =
-        qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
-        '<BR><BR><PRE>'.
-          ( UNIVERSAL::can(dbh, 'sprintProfile')
-              ? encode_entities(dbh->sprintProfile())
-              : 'DBIx::Profile missing sprintProfile method;'.
-                'unpatched or too old?'                        ).
-        #"\n\n". &sprintAutoProfile().  '</PRE>'.
-        "\n\n".                         '</PRE>'.
-        '</BODY></HTML>';
-      dbh->{'private_profile'} = {};
-      return $page;
+    if ( defined(@DBIx::Profile::ISA) ) {
+
+      if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
+
+        #profiling redirect
+
+        my $page =
+          qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
+          '<BR><BR><PRE>'.
+            ( UNIVERSAL::can(dbh, 'sprintProfile')
+                ? encode_entities(dbh->sprintProfile())
+                : 'DBIx::Profile missing sprintProfile method;'.
+                  'unpatched or too old?'                        ).
+          #"\n\n". &sprintAutoProfile().  '</PRE>'.
+          "\n\n".                         '</PRE>'.
+          '</BODY></HTML>';
+
+
+        dbh->{'private_profile'} = {};
+        return $page;
+
+      } else {
+
+        #clear db profile, but normal redirect
+        dbh->{'private_profile'} = {};
+        $m->redirect($location);
+        '';
+
+      }
 
     } else { #normal redirect
 
@@ -271,20 +355,33 @@ Initializes the Mason environment, loads all Freeside and RT libraries, etc.
     use vars qw($m);
     $m->clear_buffer;
     #false laziness w/above
-    if ( defined(@DBIx::Profile::ISA) ) { #profiling redirect
-
-      $m->print(
-        qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
-        '<BR><BR><PRE>'.
-          ( UNIVERSAL::can(dbh, 'sprintProfile')
-              ? encode_entities(dbh->sprintProfile())
-              : 'DBIx::Profile missing sprintProfile method;'.
-                'unpatched or too old?'                        ).
-        #"\n\n". &sprintAutoProfile().  '</PRE>'.
-        "\n\n".                         '</PRE>'.
-        '</BODY></HTML>'
-      );
-      dbh->{'private_profile'} = {};
+    if ( defined(@DBIx::Profile::ISA) ) {
+
+      if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
+
+        #profiling redirect
+
+        $m->print(
+          qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
+          '<BR><BR><PRE>'.
+            ( UNIVERSAL::can(dbh, 'sprintProfile')
+                ? encode_entities(dbh->sprintProfile())
+                : 'DBIx::Profile missing sprintProfile method;'.
+                  'unpatched or too old?'                        ).
+          #"\n\n". &sprintAutoProfile().  '</PRE>'.
+          "\n\n".                         '</PRE>'.
+          '</BODY></HTML>'
+        );
+
+        dbh->{'private_profile'} = {};
+
+      } else {
+
+        #clear db profile, but normal redirect
+        dbh->{'private_profile'} = {};
+        $m->redirect($location);
+
+      }
 
     } else { #normal redirect
 
@@ -300,15 +397,22 @@ 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 = @_;
@@ -318,10 +422,25 @@ sub mason_interps {
   my $request_class = '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 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 %interp = (
     request_class        => $request_class,
     data_dir             => '%%%MASONDATA%%%',
@@ -331,11 +450,14 @@ sub mason_interps {
     comp_root            => [
                               [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
                               [ 'rt'      =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
+                              @addl_comp_root,
                             ],
   );
 
   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 
+  my $html_defang = new HTML::Defang (%defang_opts);
+
   my $fs_interp = new HTML::Mason::Interp (
     %interp,
     escape_flags => { 'js_string' => sub {
@@ -343,8 +465,14 @@ sub mason_interps {
                         ${$_[0]} =~ s/(['\\])/\\$1/g;
                         ${$_[0]} =~ s/\n/\\n/g;
                         ${$_[0]} = "'". ${$_[0]}. "'";
-                      }
+                      },
+                      'defang'    => sub {
+                        ${$_[0]} = $html_defang->defang(${$_[0]});
+                      },
                     },
+    compiler     => HTML::Mason::Compiler::ToObject->new(
+                      allow_globals        => [qw(%session)],
+                    ),
   );
 
   my $rt_interp = new HTML::Mason::Interp (