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