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   use FS::cable_provider;
 321   # Sammath Naur
 322
 323   if ( $FS::Mason::addl_handler_use ) {
 324     eval $FS::Mason::addl_handler_use;
 325     die $@ if $@;
 326   }
 327
 328   if ( %%%RT_ENABLED%%% ) {
 329     eval '
 330       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 331       use vars qw($Nobody $SystemUser);
 332       use RT;
 333       use RT::Util;
 334       use RT::Tickets;
 335       use RT::Transactions;
 336       use RT::Users;
 337       use RT::CurrentUser;
 338       use RT::Templates;
 339       use RT::Queues;
 340       use RT::ScripActions;
 341       use RT::ScripConditions;
 342       use RT::Scrips;
 343       use RT::Groups;
 344       use RT::GroupMembers;
 345       use RT::CustomFields;
 346       use RT::CustomFieldValues;
 347       use RT::ObjectCustomFieldValues;
 348
 349       #blah.  manually updated from RT::Interface::Web::Handler
 350       use RT::Interface::Web;
 351       use MIME::Entity;
 352       use Text::Wrapper;
 353       use Time::ParseDate;
 354       use Time::HiRes;
 355       use HTML::Scrubber;
 356
 357       #blah.  not even in RT::Interface::Web::Handler, just in
 358       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 359       #to throw a real error instead of just a mysterious unstyled RT
 360       use CSS::Squish 0.06;
 361
 362       use RT::Interface::Web::Request;
 363
 364       #another undeclared web UI dep (for ticket links graph)
 365       use IPC::Run::SafeHandles;
 366
 367       #slow, unreliable, segfaults and is optional
 368       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 369       #use Text::Quoted;
 370
 371       #?#use File::Path qw( rmtree );
 372       #?#use File::Glob qw( bsd_glob );
 373       #?#use File::Spec::Unix;
 374
 375     ';
 376     die $@ if $@;
 377   }
 378
 379   *CGI::redirect = sub {
 380     my $self = shift;
 381     my $cookie = '';
 382     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 383       (my $x, $cookie) = (shift, shift);
 384       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 385     }
 386     my $location = shift;
 387
 388     use vars qw($m);
 389
 390     # false laziness w/below
 391     if ( defined(@DBIx::Profile::ISA) ) {
 392
 393       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 394
 395         #profiling redirect
 396
 397         my $page =
 398           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 399           '<BR><BR><PRE>'.
 400             ( UNIVERSAL::can(dbh, 'sprintProfile')
 401                 ? encode_entities(dbh->sprintProfile())
 402                 : 'DBIx::Profile missing sprintProfile method;'.
 403                   'unpatched or too old?'                        ).
 404           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 405           "\n\n".                         '</PRE>'.
 406           '</BODY></HTML>';
 407
 408
 409         dbh->{'private_profile'} = {};
 410         return $page;
 411
 412       } else {
 413
 414         #clear db profile, but normal redirect
 415         dbh->{'private_profile'} = {};
 416         $m->redirect($location);
 417         '';
 418
 419       }
 420
 421     } else { #normal redirect
 422
 423       $m->redirect($location);
 424       '';
 425
 426     }
 427
 428   };
 429
 430   sub include {
 431     use vars qw($m);
 432     #carp #should just switch to <& &> syntax
 433     $m->scomp(@_);
 434   }
 435
 436   sub errorpage {
 437     use vars qw($m);
 438     $m->comp('/elements/errorpage.html', @_);
 439   }
 440
 441   sub errorpage_popup {
 442     use vars qw($m);
 443     $m->comp('/elements/errorpage-popup.html', @_);
 444   }
 445
 446   sub redirect {
 447     my( $location ) = @_;
 448     use vars qw($m);
 449     $m->clear_buffer;
 450     #false laziness w/above
 451     if ( defined(@DBIx::Profile::ISA) ) {
 452
 453       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 454
 455         #profiling redirect
 456
 457         $m->print(
 458           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 459           '<BR><BR><PRE>'.
 460             ( UNIVERSAL::can(dbh, 'sprintProfile')
 461                 ? encode_entities(dbh->sprintProfile())
 462                 : 'DBIx::Profile missing sprintProfile method;'.
 463                   'unpatched or too old?'                        ).
 464           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 465           "\n\n".                         '</PRE>'.
 466           '</BODY></HTML>'
 467         );
 468
 469         dbh->{'private_profile'} = {};
 470
 471       } else {
 472
 473         #clear db profile, but normal redirect
 474         dbh->{'private_profile'} = {};
 475         $m->redirect($location);
 476
 477       }
 478
 479     } else { #normal redirect
 480
 481       $m->redirect($location);
 482
 483     }
 484
 485   }
 486
 487 } # end package HTML::Mason::Commands;
 488
 489 =head1 SUBROUTINE
 490
 491 =over 4
 492
 493 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
 494
 495 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 496 Freeside pages, and the second for RT pages.
 497
 498 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 499
 500 Options and values can be passed following mode.  Currently available options
 501 are:
 502
 503 I<outbuf> should be set to a scalar reference in standalone mode.
 504
 505 =cut
 506
 507 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
 508
 509 sub mason_interps {
 510   my $mode = shift || 'apache';
 511   my %opt = @_;
 512
 513   #my $request_class = 'HTML::Mason::Request'.
 514                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 515   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
 516                                             : 'FS::Mason::Request';
 517
 518   #not entirely sure it belongs here, but what the hey
 519   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
 520     RT::LoadConfig();
 521   }
 522
 523   # A hook supporting strange legacy ways people (well, SG) have added stuff on
 524
 525   my @addl_comp_root = ();
 526   my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
 527   if ( -e $addl_comp_root_file ) {
 528     warn "reading $addl_comp_root_file\n";
 529     my $text = slurp( $addl_comp_root_file );
 530     my @addl = eval $text;
 531     if ( @addl && ! $@ ) {
 532       @addl_comp_root = @addl;
 533     } elsif ($@) {
 534       warn "error parsing $addl_comp_root_file: $@\n";
 535     }
 536   }
 537
 538   my $fs_comp_root =
 539     scalar(@addl_comp_root)
 540       ? [
 541           [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
 542           @addl_comp_root,
 543         ]
 544       : '%%%FREESIDE_DOCUMENT_ROOT%%%';
 545
 546   my %interp = (
 547     request_class        => $request_class,
 548     data_dir             => '%%%MASONDATA%%%',
 549     error_mode           => 'output',
 550     error_format         => 'html',
 551     ignore_warnings_expr => '.',
 552   );
 553
 554   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 555
 556   my $html_defang = new HTML::Defang (%defang_opts);
 557
 558   #false laziness w/ FS::Maketext js_mt
 559   my $js_string_sub = sub {
 560     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 561     ${$_[0]} =~ s/(['\\])/\\$1/g;
 562     ${$_[0]} =~ s/\r/\\r/g;
 563     ${$_[0]} =~ s/\n/\\n/g;
 564     # prevent premature termination of the script
 565     ${$_[0]} =~ s[</script>][<\\/script>]ig;
 566     ${$_[0]} = "'". ${$_[0]}. "'";
 567   };
 568
 569   my $defang_sub = sub {
 570     ${$_[0]} = $html_defang->defang(${$_[0]});
 571   };
 572
 573   my $fs_interp = new HTML::Mason::Interp (
 574     %interp,
 575     comp_root    => $fs_comp_root,
 576     escape_flags => { 'js_string'   => $js_string_sub,
 577                       'defang'      => $defang_sub,
 578                     },
 579     compiler     => HTML::Mason::Compiler::ToObject->new(
 580                       allow_globals        => [qw(%session)],
 581                     ),
 582   );
 583
 584   my $rt_interp = new HTML::Mason::Interp (
 585     %interp,
 586     comp_root    => [
 587                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 588                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 589                     ],
 590     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
 591                       'u'         => \&RT::Interface::Web::EscapeURI,
 592                       'j'         => \&RT::Interface::Web::EscapeJS,
 593                       'js_string' => $js_string_sub,
 594                     },
 595     compiler     => HTML::Mason::Compiler::ToObject->new(
 596                       default_escape_flags => 'h',
 597                       allow_globals        => [qw(%session)],
 598                     ),
 599   );
 600
 601   ( $fs_interp, $rt_interp );
 602
 603 }
 604
 605 =back
 606
 607 =head1 BUGS
 608
 609 Lurking in the darkness...
 610
 611 =head1 SEE ALSO
 612
 613 L<HTML::Mason>, L<FS>, L<RT>
 614
 615 =cut
 616
 617 1;