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