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