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