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