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