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