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