FS/FS/Mason.pm

   1 package FS::Mason;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK $addl_handler_use );
   5 use Exporter;
   6 use Carp;
   7 use File::Slurp qw( slurp );
   8 use HTML::Mason 1.27; #http://www.masonhq.com/?ApacheModPerl2Redirect
   9 use HTML::Mason::Interp;
  10 use HTML::Mason::Compiler::ToObject;
  11
  12 @ISA = qw( Exporter );
  13 @EXPORT_OK = qw( mason_interps );
  14
  15 =head1 NAME
  16
  17 FS::Mason - Initialize the Mason environment
  18
  19 =head1 SYNOPSIS
  20
  21   use FS::Mason qw( mason_interps );
  22
  23   my( $fs_interp, $rt_interp ) = mason_interps('apache');
  24
  25   #OR
  26
  27   my( $fs_interp, $rt_interp ) = mason_interps('standalone'); #XXX name?
  28
  29 =head1 DESCRIPTION
  30
  31 Initializes the Mason environment, loads all Freeside and RT libraries, etc.
  32
  33 =cut
  34
  35 $addl_handler_use = '';
  36 my $addl_handler_use_file = '%%%FREESIDE_CONF%%%/addl_handler_use.pl';
  37 if ( -e $addl_handler_use_file ) {
  38   $addl_handler_use = slurp( $addl_handler_use_file );
  39 }
  40
  41 # List of modules that you want to use from components (see Admin
  42 # manual for details)
  43 {
  44   package HTML::Mason::Commands;
  45
  46   use strict;
  47   use vars qw( %session );
  48   use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
  49
  50   #breaks quick payment entry
  51   #http://rt.cpan.org/Public/Bug/Display.html?id=37365
  52   die "CGI.pm v3.38 is broken, use any other version >= 3.29".
  53       " (Debian 5.0?  aptitude remove libcgi-pm-perl)"
  54     if $CGI::VERSION == 3.38;
  55
  56   #use CGI::Carp qw(fatalsToBrowser);
  57   use CGI::Cookie;
  58   use List::Util qw( max min sum );
  59   use List::MoreUtils qw( first_index uniq );
  60   use Scalar::Util qw( blessed );
  61   use Data::Dumper;
  62   use Date::Format;
  63   use Time::Local;
  64   use Time::HiRes;
  65   use Time::Duration;
  66   use DateTime;
  67   use DateTime::Format::Strptime;
  68   use FS::Misc::DateTime qw( parse_datetime );
  69   use FS::Misc::Geo qw( get_censustract get_district );
  70   use Lingua::EN::Inflect qw(PL);
  71   Lingua::EN::Inflect::classical names=>0; #Categorys
  72   use Tie::IxHash;
  73   use URI;
  74   use URI::Escape 3.31;
  75   use HTML::Entities;
  76   use HTML::TreeBuilder;
  77   use HTML::TableExtract qw(tree);
  78   use HTML::FormatText;
  79   use HTML::Defang;
  80   use JSON;
  81 #  use XMLRPC::Transport::HTTP;
  82 #  use XMLRPC::Lite; # for XMLRPC::Serializer
  83   use MIME::Base64;
  84   use IO::Handle;
  85   use IO::File;
  86   use IO::Scalar;
  87   use IO::String;
  88   #not actually using this yet anyway...# use IPC::Run3 0.036;
  89   use Net::Whois::Raw qw(whois);
  90   if ( $] < 5.006 ) {
  91     eval "use Net::Whois::Raw 0.32 qw(whois)";
  92     die $@ if $@;
  93   }
  94   use Text::CSV_XS;
  95   use Spreadsheet::WriteExcel;
  96   use Spreadsheet::WriteExcel::Utility;
  97   use OLE::Storage_Lite;
  98   use Excel::Writer::XLSX;
  99   #use Excel::Writer::XLSX::Utility; #redundant with above
 100
 101   use Business::CreditCard 0.30; #for mask-aware cardtype()
 102   use NetAddr::IP;
 103   use Net::Ping;
 104   use Net::Ping::External;
 105   #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
 106   {
 107     no warnings 'redefine';
 108     eval 'sub Net::Ping::External::_ping_linux {
 109             my %args = @_;
 110             my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
 111             return Net::Ping::External::_ping_system($command, 0);
 112           }
 113          ';
 114     die $@ if $@;
 115   }
 116   use String::Approx qw(amatch);
 117   use Chart::LinesPoints;
 118   use Chart::Mountain;
 119   use Chart::Bars;
 120   use Color::Scheme;
 121   use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
 122                                         #selectlayers.html
 123   use Locale::Country;
 124   use Business::US::USPS::WebTools::AddressStandardization;
 125   use Geo::GoogleEarth::Pluggable;
 126   use LWP::UserAgent;
 127   use Storable qw( nfreeze thaw );
 128   use FS;
 129   use FS::UID qw( getotaker dbh datasrc driver_name );
 130   use FS::Record qw( qsearch qsearchs fields dbdef
 131                     str2time_sql str2time_sql_closing
 132                     midnight_sql
 133                    );
 134   use FS::Conf;
 135   use FS::CGI qw(header menubar table itable ntable idiot
 136                  eidiot myexit http_header);
 137   use FS::UI::Web qw(svc_url);
 138   use FS::UI::Web::small_custview qw(small_custview);
 139   use FS::UI::bytecount;
 140   use FS::Msgcat qw(gettext geterror);
 141   use FS::Misc qw( send_email send_fax ocr_image
 142                    states_hash counties cities state_label
 143                  );
 144   use FS::Misc::eps2png qw( eps2png );
 145   use FS::Report::FCC_477;
 146   use FS::Report::Table;
 147   use FS::Report::Table::Monthly;
 148   use FS::Report::Table::Daily;
 149   use FS::TicketSystem;
 150   use FS::NetworkMonitoringSystem;
 151   use FS::Tron qw( tron_lint );
 152   use FS::Locales;
 153   use FS::Maketext qw( mt emt js_mt );
 154
 155   use FS::agent;
 156   use FS::agent_type;
 157   use FS::domain_record;
 158   use FS::cust_bill;
 159   use FS::cust_bill_pay;
 160   use FS::cust_credit;
 161   use FS::cust_credit_bill;
 162   use FS::cust_main;
 163   use FS::h_cust_main;
 164   use FS::cust_main::Search qw(smart_search);
 165   use FS::cust_main::Import;
 166   use FS::cust_main_county;
 167   use FS::cust_location;
 168   use FS::cust_pay;
 169   use FS::cust_pkg;
 170   use FS::cust_pkg::Import;
 171   use FS::part_pkg_taxclass;
 172   use FS::cust_pkg_reason;
 173   use FS::cust_refund;
 174   use FS::cust_credit_refund;
 175   use FS::cust_pay_refund;
 176   use FS::cust_svc;
 177   use FS::nas;
 178   use FS::part_bill_event;
 179   use FS::part_event;
 180   use FS::part_event_condition;
 181   use FS::part_pkg;
 182   use FS::part_referral;
 183   use FS::part_svc;
 184   use FS::part_svc_router;
 185   use FS::part_virtual_field;
 186   use FS::pay_batch;
 187   use FS::pkg_svc;
 188   use FS::port;
 189   use FS::queue qw(joblisting);
 190   use FS::raddb;
 191   use FS::session;
 192   use FS::svc_acct;
 193   use FS::svc_acct_pop qw(popselector);
 194   use FS::acct_rt_transaction;
 195   use FS::svc_domain;
 196   use FS::svc_forward;
 197   use FS::svc_www;
 198   use FS::router;
 199   use FS::addr_block;
 200   use FS::svc_broadband;
 201   use FS::svc_external;
 202   use FS::type_pkgs;
 203   use FS::part_export;
 204   use FS::part_export_option;
 205   use FS::export_svc;
 206   use FS::export_device;
 207   use FS::msgcat;
 208   use FS::rate;
 209   use FS::rate_region;
 210   use FS::rate_prefix;
 211   use FS::rate_detail;
 212   use FS::usage_class;
 213   use FS::payment_gateway;
 214   use FS::agent_payment_gateway;
 215   use FS::XMLRPC;
 216   use FS::payby;
 217   use FS::cdr;
 218   use FS::cdr_batch;
 219   use FS::inventory_class;
 220   use FS::inventory_item;
 221   use FS::pkg_category;
 222   use FS::pkg_class;
 223   use FS::access_user;
 224   use FS::access_user_pref;
 225   use FS::access_group;
 226   use FS::access_usergroup;
 227   use FS::access_groupagent;
 228   use FS::access_right;
 229   use FS::AccessRight;
 230   use FS::svc_phone;
 231   use FS::phone_device;
 232   use FS::part_device;
 233   use FS::reason_type;
 234   use FS::reason;
 235   use FS::cust_main_note;
 236   use FS::tax_class;
 237   use FS::cust_tax_location;
 238   use FS::part_pkg_taxproduct;
 239   use FS::part_pkg_taxoverride;
 240   use FS::part_pkg_taxrate;
 241   use FS::tax_rate;
 242   use FS::part_pkg_report_option;
 243   use FS::cust_attachment;
 244   use FS::h_cust_pkg;
 245   use FS::h_inventory_item;
 246   use FS::h_svc_acct;
 247   use FS::h_svc_broadband;
 248   use FS::h_svc_domain;
 249   #use FS::h_domain_record;
 250   use FS::h_svc_external;
 251   use FS::h_svc_forward;
 252   use FS::h_svc_phone;
 253   #use FS::h_phone_device;
 254   use FS::h_svc_www;
 255   use FS::cust_statement;
 256   use FS::cust_class;
 257   use FS::cust_category;
 258   use FS::prospect_main;
 259   use FS::contact;
 260   use FS::phone_type;
 261   use FS::svc_pbx;
 262   use FS::discount;
 263   use FS::cust_pkg_discount;
 264   use FS::cust_bill_pkg_discount;
 265   use FS::svc_mailinglist;
 266   use FS::cgp_rule;
 267   use FS::cgp_rule_condition;
 268   use FS::cgp_rule_action;
 269   use FS::bill_batch;
 270   use FS::cust_bill_batch;
 271   use FS::rate_time;
 272   use FS::rate_time_interval;
 273   use FS::msg_template;
 274   use FS::part_tag;
 275   use FS::acct_snarf;
 276   use FS::part_pkg_discount;
 277   use FS::svc_cert;
 278   use FS::svc_dsl;
 279   use FS::qual;
 280   use FS::qual_option;
 281   use FS::dsl_note;
 282   use FS::part_pkg_vendor;
 283   use FS::cust_note_class;
 284   use FS::svc_port;
 285   use FS::lata;
 286   use FS::did_vendor;
 287   use FS::did_order;
 288   use FS::torrus_srvderive;
 289   use FS::torrus_srvderive_component;
 290   use FS::areacode;
 291   use FS::svc_dish;
 292   use FS::h_svc_dish;
 293   use FS::svc_hardware;
 294   use FS::h_svc_hardware;
 295   use FS::hardware_class;
 296   use FS::hardware_type;
 297   use FS::hardware_status;
 298   use FS::did_order_item;
 299   use FS::msa;
 300   use FS::rate_center;
 301   use FS::cust_msg;
 302   use FS::radius_group;
 303   use FS::template_content;
 304   use FS::dsl_device;
 305   use FS::nas;
 306   use FS::nas;
 307   use FS::export_nas;
 308   use FS::legacy_cust_bill;
 309   use FS::rate_tier;
 310   use FS::rate_tier_detail;
 311   use FS::radius_attr;
 312   use FS::discount_plan;
 313   use FS::tower;
 314   use FS::tower_sector;
 315   use FS::agent_pkg_class;
 316   use FS::log;
 317   use FS::log_context;
 318   use FS::svc_cable;
 319   use FS::cable_model;
 320   # Sammath Naur
 321
 322   if ( $FS::Mason::addl_handler_use ) {
 323     eval $FS::Mason::addl_handler_use;
 324     die $@ if $@;
 325   }
 326
 327   if ( %%%RT_ENABLED%%% ) {
 328     eval '
 329       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 330       use vars qw($Nobody $SystemUser);
 331       use RT;
 332       use RT::Util;
 333       use RT::Tickets;
 334       use RT::Transactions;
 335       use RT::Users;
 336       use RT::CurrentUser;
 337       use RT::Templates;
 338       use RT::Queues;
 339       use RT::ScripActions;
 340       use RT::ScripConditions;
 341       use RT::Scrips;
 342       use RT::Groups;
 343       use RT::GroupMembers;
 344       use RT::CustomFields;
 345       use RT::CustomFieldValues;
 346       use RT::ObjectCustomFieldValues;
 347
 348       #blah.  manually updated from RT::Interface::Web::Handler
 349       use RT::Interface::Web;
 350       use MIME::Entity;
 351       use Text::Wrapper;
 352       use Time::ParseDate;
 353       use Time::HiRes;
 354       use HTML::Scrubber;
 355
 356       #blah.  not even in RT::Interface::Web::Handler, just in
 357       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 358       #to throw a real error instead of just a mysterious unstyled RT
 359       use CSS::Squish 0.06;
 360
 361       use RT::Interface::Web::Request;
 362
 363       #another undeclared web UI dep (for ticket links graph)
 364       use IPC::Run::SafeHandles;
 365
 366       #slow, unreliable, segfaults and is optional
 367       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 368       #use Text::Quoted;
 369
 370       #?#use File::Path qw( rmtree );
 371       #?#use File::Glob qw( bsd_glob );
 372       #?#use File::Spec::Unix;
 373
 374     ';
 375     die $@ if $@;
 376   }
 377
 378   *CGI::redirect = sub {
 379     my $self = shift;
 380     my $cookie = '';
 381     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 382       (my $x, $cookie) = (shift, shift);
 383       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 384     }
 385     my $location = shift;
 386
 387     use vars qw($m);
 388
 389     # false laziness w/below
 390     if ( defined(@DBIx::Profile::ISA) ) {
 391
 392       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 393
 394         #profiling redirect
 395
 396         my $page =
 397           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 398           '<BR><BR><PRE>'.
 399             ( UNIVERSAL::can(dbh, 'sprintProfile')
 400                 ? encode_entities(dbh->sprintProfile())
 401                 : 'DBIx::Profile missing sprintProfile method;'.
 402                   'unpatched or too old?'                        ).
 403           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 404           "\n\n".                         '</PRE>'.
 405           '</BODY></HTML>';
 406
 407
 408         dbh->{'private_profile'} = {};
 409         return $page;
 410
 411       } else {
 412
 413         #clear db profile, but normal redirect
 414         dbh->{'private_profile'} = {};
 415         $m->redirect($location);
 416         '';
 417
 418       }
 419
 420     } else { #normal redirect
 421
 422       $m->redirect($location);
 423       '';
 424
 425     }
 426
 427   };
 428
 429   sub include {
 430     use vars qw($m);
 431     #carp #should just switch to <& &> syntax
 432     $m->scomp(@_);
 433   }
 434
 435   sub errorpage {
 436     use vars qw($m);
 437     $m->comp('/elements/errorpage.html', @_);
 438   }
 439
 440   sub errorpage_popup {
 441     use vars qw($m);
 442     $m->comp('/elements/errorpage-popup.html', @_);
 443   }
 444
 445   sub redirect {
 446     my( $location ) = @_;
 447     use vars qw($m);
 448     $m->clear_buffer;
 449     #false laziness w/above
 450     if ( defined(@DBIx::Profile::ISA) ) {
 451
 452       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 453
 454         #profiling redirect
 455
 456         $m->print(
 457           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 458           '<BR><BR><PRE>'.
 459             ( UNIVERSAL::can(dbh, 'sprintProfile')
 460                 ? encode_entities(dbh->sprintProfile())
 461                 : 'DBIx::Profile missing sprintProfile method;'.
 462                   'unpatched or too old?'                        ).
 463           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 464           "\n\n".                         '</PRE>'.
 465           '</BODY></HTML>'
 466         );
 467
 468         dbh->{'private_profile'} = {};
 469
 470       } else {
 471
 472         #clear db profile, but normal redirect
 473         dbh->{'private_profile'} = {};
 474         $m->redirect($location);
 475
 476       }
 477
 478     } else { #normal redirect
 479
 480       $m->redirect($location);
 481
 482     }
 483
 484   }
 485
 486 } # end package HTML::Mason::Commands;
 487
 488 =head1 SUBROUTINE
 489
 490 =over 4
 491
 492 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
 493
 494 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 495 Freeside pages, and the second for RT pages.
 496
 497 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 498
 499 Options and values can be passed following mode.  Currently available options
 500 are:
 501
 502 I<outbuf> should be set to a scalar reference in standalone mode.
 503
 504 =cut
 505
 506 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
 507
 508 sub mason_interps {
 509   my $mode = shift || 'apache';
 510   my %opt = @_;
 511
 512   #my $request_class = 'HTML::Mason::Request'.
 513                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 514   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
 515                                             : 'FS::Mason::Request';
 516
 517   #not entirely sure it belongs here, but what the hey
 518   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
 519     RT::LoadConfig();
 520   }
 521
 522   # A hook supporting strange legacy ways people (well, SG) have added stuff on
 523
 524   my @addl_comp_root = ();
 525   my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
 526   if ( -e $addl_comp_root_file ) {
 527     warn "reading $addl_comp_root_file\n";
 528     my $text = slurp( $addl_comp_root_file );
 529     my @addl = eval $text;
 530     if ( @addl && ! $@ ) {
 531       @addl_comp_root = @addl;
 532     } elsif ($@) {
 533       warn "error parsing $addl_comp_root_file: $@\n";
 534     }
 535   }
 536
 537   my $fs_comp_root =
 538     scalar(@addl_comp_root)
 539       ? [
 540           [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
 541           @addl_comp_root,
 542         ]
 543       : '%%%FREESIDE_DOCUMENT_ROOT%%%';
 544
 545   my %interp = (
 546     request_class        => $request_class,
 547     data_dir             => '%%%MASONDATA%%%',
 548     error_mode           => 'output',
 549     error_format         => 'html',
 550     ignore_warnings_expr => '.',
 551   );
 552
 553   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 554
 555   my $html_defang = new HTML::Defang (%defang_opts);
 556
 557   #false laziness w/ FS::Maketext js_mt
 558   my $js_string_sub = sub {
 559     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 560     ${$_[0]} =~ s/(['\\])/\\$1/g;
 561     ${$_[0]} =~ s/\r/\\r/g;
 562     ${$_[0]} =~ s/\n/\\n/g;
 563     # prevent premature termination of the script
 564     ${$_[0]} =~ s[</script>][<\\/script>]ig;
 565     ${$_[0]} = "'". ${$_[0]}. "'";
 566   };
 567
 568   my $defang_sub = sub {
 569     ${$_[0]} = $html_defang->defang(${$_[0]});
 570   };
 571
 572   my $fs_interp = new HTML::Mason::Interp (
 573     %interp,
 574     comp_root    => $fs_comp_root,
 575     escape_flags => { 'js_string'   => $js_string_sub,
 576                       'defang'      => $defang_sub,
 577                     },
 578     compiler     => HTML::Mason::Compiler::ToObject->new(
 579                       allow_globals        => [qw(%session)],
 580                     ),
 581   );
 582
 583   my $rt_interp = new HTML::Mason::Interp (
 584     %interp,
 585     comp_root    => [
 586                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 587                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 588                     ],
 589     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
 590                       'u'         => \&RT::Interface::Web::EscapeURI,
 591                       'j'         => \&RT::Interface::Web::EscapeJS,
 592                       'js_string' => $js_string_sub,
 593                     },
 594     compiler     => HTML::Mason::Compiler::ToObject->new(
 595                       default_escape_flags => 'h',
 596                       allow_globals        => [qw(%session)],
 597                     ),
 598   );
 599
 600   ( $fs_interp, $rt_interp );
 601
 602 }
 603
 604 =back
 605
 606 =head1 BUGS
 607
 608 Lurking in the darkness...
 609
 610 =head1 SEE ALSO
 611
 612 L<HTML::Mason>, L<FS>, L<RT>
 613
 614 =cut
 615
 616 1;