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